« get me outta code hell

sugar.js « util « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/util/sugar.js
blob: 219c3eec983a7a8b6a979617f45f583a1e18a79f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
// Syntactic sugar! (Mostly.)
// Generic functions - these are useful just a8out everywhere.
//
// Friendly(!) disclaimer: these utility functions haven't 8een tested all that
// much. Do not assume it will do exactly what you want it to do in all cases.
// It will likely only do exactly what I want it to, and only in the cases I
// decided were relevant enough to 8other handling.

import { color } from './cli.js';

// Apparently JavaScript doesn't come with a function to split an array into
// chunks! Weird. Anyway, this is an awesome place to use a generator, even
// though we don't really make use of the 8enefits of generators any time we
// actually use this. 8ut it's still awesome, 8ecause I say so.
export function* splitArray(array, fn) {
    let lastIndex = 0;
    while (lastIndex < array.length) {
        let nextIndex = array.findIndex((item, index) => index >= lastIndex && fn(item));
        if (nextIndex === -1) {
            nextIndex = array.length;
        }
        yield array.slice(lastIndex, nextIndex);
        // Plus one because we don't want to include the dividing line in the
        // next array we yield.
        lastIndex = nextIndex + 1;
    }
};

export const mapInPlace = (array, fn) => array.splice(0, array.length, ...array.map(fn));

export const filterEmptyLines = string => string.split('\n').filter(line => line.trim()).join('\n');

export const unique = arr => Array.from(new Set(arr));

// Stolen from jq! Which pro8a8ly stole the concept from other places. Nice.
export const withEntries = (obj, fn) => Object.fromEntries(fn(Object.entries(obj)));

export function queue(array, max = 50) {
    if (max === 0) {
        return array.map(fn => fn());
    }

    const begin = [];
    let current = 0;
    const ret = array.map(fn => new Promise((resolve, reject) => {
        begin.push(() => {
            current++;
            Promise.resolve(fn()).then(value => {
                current--;
                if (current < max && begin.length) {
                    begin.shift()();
                }
                resolve(value);
            }, reject);
        });
    }));

    for (let i = 0; i < max && begin.length; i++) {
        begin.shift()();
    }

    return ret;
}

export function delay(ms) {
    return new Promise(res => setTimeout(res, ms));
}

// Stolen from here: https://stackoverflow.com/a/3561711
//
// There's a proposal for a native JS function like this, 8ut it's not even
// past stage 1 yet: https://github.com/tc39/proposal-regex-escaping
export function escapeRegex(string) {
    return string.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
}

export function bindOpts(fn, bind) {
    const bindIndex = bind[bindOpts.bindIndex] ?? 1;

    return (...args) => {
        const opts = args[bindIndex] ?? {};
        return fn(...args.slice(0, bindIndex), {...bind, ...opts});
    };
}

bindOpts.bindIndex = Symbol();

// Utility function for providing useful interfaces to the JS AggregateError
// class.
//
// Generally, this works by returning a set of interfaces which operate on
// functions: wrap() takes a function and returns a new function which passes
// its arguments through and appends any resulting error to the internal error
// list; call() simplifies this process by wrapping the provided function and
// then calling it immediately. Once the process for which errors should be
// aggregated is complete, close() constructs and throws an AggregateError
// object containing all caught errors (or doesn't throw anything if there were
// no errors).
export function openAggregate({
    // Constructor to use, defaulting to the builtin AggregateError class.
    // Anything passed here should probably extend from that! May be used for
    // letting callers programatically distinguish between multiple aggregate
    // errors.
    //
    // This should be provided using the aggregateThrows utility function.
    [openAggregate.errorClassSymbol]: errorClass = AggregateError,

    // Optional human-readable message to describe the aggregate error, if
    // constructed.
    message = '',

    // Value to return when a provided function throws an error. If this is a
    // function, it will be called with the arguments given to the function.
    // (This is primarily useful when wrapping a function and then providing it
    // to another utility, e.g. array.map().)
    returnOnFail = null
} = {}) {
    const errors = [];

    const aggregate = {};

    aggregate.wrap = fn => (...args) => {
        try {
            return fn(...args);
        } catch (error) {
            errors.push(error);
            return (typeof returnOnFail === 'function'
                ? returnOnFail(...args)
                : returnOnFail);
        }
    };

    aggregate.wrapAsync = fn => (...args) => {
        return fn(...args).then(
            value => value,
            error => {
                errors.push(error);
                return (typeof returnOnFail === 'function'
                    ? returnOnFail(...args)
                    : returnOnFail);
            });
    };

    aggregate.call = (fn, ...args) => {
        return aggregate.wrap(fn)(...args);
    };

    aggregate.callAsync = (fn, ...args) => {
        return aggregate.wrapAsync(fn)(...args);
    };

    aggregate.nest = (...args) => {
        return aggregate.call(() => withAggregate(...args));
    };

    aggregate.nestAsync = (...args) => {
        return aggregate.callAsync(() => withAggregateAsync(...args));
    };

    aggregate.map = (...args) => {
        const parent = aggregate;
        const { result, aggregate: child } = mapAggregate(...args);
        parent.call(child.close);
        return result;
    };

    aggregate.mapAsync = async (...args) => {
        const parent = aggregate;
        const { result, aggregate: child } = await mapAggregateAsync(...args);
        parent.call(child.close);
        return result;
    };

    aggregate.filter = (...args) => {
        const parent = aggregate;
        const { result, aggregate: child } = filterAggregate(...args);
        parent.call(child.close);
        return result;
    };

    aggregate.throws = aggregateThrows;

    aggregate.close = () => {
        if (errors.length) {
            throw Reflect.construct(errorClass, [errors, message]);
        }
    };

    return aggregate;
}

openAggregate.errorClassSymbol = Symbol('error class');

// Utility function for providing {errorClass} parameter to aggregate functions.
export function aggregateThrows(errorClass) {
    return {[openAggregate.errorClassSymbol]: errorClass};
}

// Performs an ordinary array map with the given function, collating into a
// results array (with errored inputs filtered out) and an error aggregate.
//
// Optionally, override returnOnFail to disable filtering and map errored inputs
// to a particular output.
//
// Note the aggregate property is the result of openAggregate(), still unclosed;
// use aggregate.close() to throw the error. (This aggregate may be passed to a
// parent aggregate: `parent.call(aggregate.close)`!)
export function mapAggregate(array, fn, aggregateOpts) {
    return _mapAggregate('sync', null, array, fn, aggregateOpts);
}

export function mapAggregateAsync(array, fn, {
    promiseAll = Promise.all,
    ...aggregateOpts
} = {}) {
    return _mapAggregate('async', promiseAll, array, fn, aggregateOpts);
}

// Helper function for mapAggregate which holds code common between sync and
// async versions.
export function _mapAggregate(mode, promiseAll, array, fn, aggregateOpts) {
    const failureSymbol = Symbol();

    const aggregate = openAggregate({
        returnOnFail: failureSymbol,
        ...aggregateOpts
    });

    if (mode === 'sync') {
        const result = array.map(aggregate.wrap(fn))
            .filter(value => value !== failureSymbol);
        return {result, aggregate};
    } else {
        return promiseAll(array.map(aggregate.wrapAsync(fn))).then(values => {
            const result = values.filter(value => value !== failureSymbol);
            return {result, aggregate};
        });
    }
}

// Performs an ordinary array filter with the given function, collating into a
// results array (with errored inputs filtered out) and an error aggregate.
//
// Optionally, override returnOnFail to disable filtering errors and map errored
// inputs to a particular output.
//
// As with mapAggregate, the returned aggregate property is not yet closed.
export function filterAggregate(array, fn, aggregateOpts) {
    return _filterAggregate('sync', null, array, fn, aggregateOpts);
}

export async function filterAggregateAsync(array, fn, {
    promiseAll = Promise.all,
    ...aggregateOpts
} = {}) {
    return _filterAggregate('async', promiseAll, array, fn, aggregateOpts);
}

// Helper function for filterAggregate which holds code common between sync and
// async versions.
function _filterAggregate(mode, promiseAll, array, fn, aggregateOpts) {
    const failureSymbol = Symbol();

    const aggregate = openAggregate({
        returnOnFail: failureSymbol,
        ...aggregateOpts
    });

    function filterFunction(value) {
        // Filter out results which match the failureSymbol, i.e. errored
        // inputs.
        if (value === failureSymbol) return false;

        // Always keep results which match the overridden returnOnFail
        // value, if provided.
        if (value === aggregateOpts.returnOnFail) return true;

        // Otherwise, filter according to the returned value of the wrapped
        // function.
        return value.output;
    }

    function mapFunction(value) {
        // Then turn the results back into their corresponding input, or, if
        // provided, the overridden returnOnFail value.
        return (value === aggregateOpts.returnOnFail
            ? value
            : value.input);
    }

    function wrapperFunction(x, ...rest) {
        return {
            input: x,
            output: fn(x, ...rest)
        };
    }

    if (mode === 'sync') {
        const result = array
            .map(aggregate.wrap((input, index, array) => {
                const output = fn(input, index, array);
                return {input, output};
            }))
            .filter(filterFunction)
            .map(mapFunction);

        return {result, aggregate};
    } else {
        return promiseAll(array.map(aggregate.wrapAsync(async (input, index, array) => {
            const output = await fn(input, index, array);
            return {input, output};
        }))).then(values => {
            const result = values
                .filter(filterFunction)
                .map(mapFunction);

            return {result, aggregate};
        });
    }
}

// Totally sugar function for opening an aggregate, running the provided
// function with it, then closing the function and returning the result (if
// there's no throw).
export function withAggregate(aggregateOpts, fn) {
    return _withAggregate('sync', aggregateOpts, fn);
}

export function withAggregateAsync(aggregateOpts, fn) {
    return _withAggregate('async', aggregateOpts, fn);
}

export function _withAggregate(mode, aggregateOpts, fn) {
    if (typeof aggregateOpts === 'function') {
        fn = aggregateOpts;
        aggregateOpts = {};
    }

    const aggregate = openAggregate(aggregateOpts);

    if (mode === 'sync') {
        const result = fn(aggregate);
        aggregate.close();
        return result;
    } else {
        return fn(aggregate).then(result => {
            aggregate.close();
            return result;
        });
    }
}

export function showAggregate(topError, {pathToFile = p => p} = {}) {
    const recursive = (error, {level}) => {
        const stackLines = error.stack?.split('\n');
        const stackLine = stackLines?.find(line =>
            line.trim().startsWith('at')
            && !line.includes('sugar')
            && !line.includes('node:internal'));
        const tracePart = (stackLine
            ? '- ' + stackLine.trim().replace(/file:\/\/(.*\.js)/, (match, pathname) => pathToFile(pathname))
            : '(no stack trace)');

        const header = `[${error.constructor.name || 'unnamed'}] ${error.message || '(no message)'} ${color.dim(tracePart)}`;
        const bar = (level % 2 === 0
            ? '\u2502'
            : color.dim('\u254e'));
        const head = (level % 2 === 0
            ? '\u257f'
            : color.dim('\u257f'));

        if (error instanceof AggregateError) {
            return header + '\n' + (error.errors
                .map(error => recursive(error, {level: level + 1}))
                .flatMap(str => str.split('\n'))
                .map((line, i, lines) => (i === 0
                    ? ` ${head} ${line}`
                    : ` ${bar} ${line}`))
                .join('\n'));
        } else {
            return header;
        }
    };

    console.error(recursive(topError, {level: 0}));
}