« get me outta code hell

index.js « dependencies « content « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/content/dependencies/index.js
blob: 95247e9cdb81e80ae1eed1c55f44f5b27deee692 (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
import EventEmitter from 'node:events';
import {readdir} from 'node:fs/promises';
import * as path from 'node:path';
import {fileURLToPath} from 'node:url';

import chokidar from 'chokidar';
import {ESLint} from 'eslint';

import {colors, logWarn} from '#cli';
import contentFunction, {ContentFunctionSpecError} from '#content-function';

import {
  annotateFunction,
  showAggregate as _showAggregate
} from '#sugar';

function cachebust(filePath) {
  if (filePath in cachebust.cache) {
    cachebust.cache[filePath] += 1;
    return `${filePath}?cachebust${cachebust.cache[filePath]}`;
  } else {
    cachebust.cache[filePath] = 0;
    return filePath;
  }
}

cachebust.cache = Object.create(null);

export function watchContentDependencies({
  mock = null,
  logging = true,
  showAggregate = _showAggregate,
} = {}) {
  const events = new EventEmitter();
  const contentDependencies = {};

  let emittedReady = false;
  let closed = false;

  let _close = () => {};

  Object.assign(events, {
    contentDependencies,
    close,
  });

  const eslint = new ESLint();

  const metaPath = fileURLToPath(import.meta.url);
  const metaDirname = path.dirname(metaPath);
  const watchPath = metaDirname;

  const mockKeys = new Set();
  if (mock) {
    const errors = [];

    for (const [functionName, spec] of Object.entries(mock)) {
      mockKeys.add(functionName);
      try {
        const fn = processFunctionSpec(functionName, spec);
        contentDependencies[functionName] = fn;
      } catch (error) {
        error.message = `(${functionName}) ${error.message}`;
        errors.push(error);
      }
    }

    if (errors.length) {
      throw new AggregateError(errors, `Errors processing mocked content functions`);
    }
  }

  // Chokidar's 'ready' event is supposed to only fire once an 'add' event
  // has been fired for everything in the watched directory, but it's not
  // totally reliable. https://github.com/paulmillr/chokidar/issues/1011
  //
  // Workaround here is to readdir for the names of all dependencies ourselves,
  // and enter null for each into the contentDependencies object. We'll emit
  // 'ready' ourselves only once no nulls remain. And we won't actually start
  // watching until the readdir is done and nulls are entered (so we don't
  // prematurely find out there aren't any nulls - before the nulls have
  // been entered at all!).

  readdir(watchPath).then(files => {
    if (closed) {
      return;
    }

    const filePaths = files.map(file => path.join(watchPath, file));
    for (const filePath of filePaths) {
      if (filePath === metaPath) continue;
      const functionName = getFunctionName(filePath);
      if (!isMocked(functionName)) {
        contentDependencies[functionName] = null;
      }
    }

    const watcher = chokidar.watch(watchPath);

    watcher.on('all', (event, filePath) => {
      if (!['add', 'change'].includes(event)) return;
      if (filePath === metaPath) return;
      handlePathUpdated(filePath);

    });

    watcher.on('unlink', (filePath) => {
      if (filePath === metaPath) {
        console.error(`Yeowzers content dependencies just got nuked.`);
        return;
      }

      handlePathRemoved(filePath);
    });

    _close = () => watcher.close();
  });

  return events;

  async function close() {
    closed = true;
    return _close();
  }

  function checkReadyConditions() {
    if (emittedReady) return;
    if (Object.values(contentDependencies).includes(null)) return;

    events.emit('ready');
    emittedReady = true;
  }

  function getFunctionName(filePath) {
    const shortPath = path.basename(filePath);
    const functionName = shortPath.slice(0, -path.extname(shortPath).length);
    return functionName;
  }

  function isMocked(functionName) {
    return mockKeys.has(functionName);
  }

  async function handlePathRemoved(filePath) {
    const functionName = getFunctionName(filePath);
    if (isMocked(functionName)) return;

    delete contentDependencies[functionName];
  }

  async function handlePathUpdated(filePath) {
    const functionName = getFunctionName(filePath);
    if (isMocked(functionName)) return;

    let error = null;

    main: {
      const eslintResults = await eslint.lintFiles([filePath]);
      const eslintFormatter = await eslint.loadFormatter('stylish');
      const eslintResultText = eslintFormatter.format(eslintResults);
      if (eslintResultText.trim().length) {
        console.log(eslintResultText);
      }

      let spec;
      try {
        const module =
          await import(
            cachebust(
              './' +
              path
                .relative(metaDirname, filePath)
                .split(path.sep)
                .join('/')));
        spec = module.default;
      } catch (caughtError) {
        error = caughtError;
        error.message = `Error importing: ${error.message}`;
        break main;
      }

      // Just skip newly created files. They'll be processed again when
      // written.
      if (spec === undefined) {
        // For practical purposes the file is treated as though it doesn't
        // even exist (undefined), rather than not being ready yet (null).
        // Apart from if existing contents of the file were erased (but not
        // the file itself), this value might already be set (to null!) by
        // the readdir performed at the beginning to evaluate which files
        // should be read and processed at least once before reporting all
        // dependencies as ready.
        delete contentDependencies[functionName];
        return;
      }

      let fn;
      try {
        fn = processFunctionSpec(functionName, spec);
      } catch (caughtError) {
        error = caughtError;
        break main;
      }

      if (logging && emittedReady) {
        const timestamp = new Date().toLocaleString('en-US', {timeStyle: 'medium'});
        console.log(colors.green(`[${timestamp}] Updated ${functionName}`));
      }

      contentDependencies[functionName] = fn;

      events.emit('update', functionName);
      checkReadyConditions();
    }

    if (!error) {
      return true;
    }

    if (!(functionName in contentDependencies)) {
      contentDependencies[functionName] = null;
    }

    events.emit('error', functionName, error);

    if (logging) {
      if (contentDependencies[functionName]) {
        logWarn`Failed to import ${functionName} - using existing version`;
      } else {
        logWarn`Failed to import ${functionName} - no prior version loaded`;
      }

      if (typeof error === 'string') {
        console.error(colors.yellow(error));
      } else if (error instanceof ContentFunctionSpecError) {
        console.error(colors.yellow(error.message));
      } else {
        showAggregate(error);
      }
    }

    return false;
  }

  function processFunctionSpec(functionName, spec) {
    if (typeof spec?.data === 'function') {
      annotateFunction(spec.data, {name: functionName, description: 'data'});
    }

    if (typeof spec?.generate === 'function') {
      annotateFunction(spec.generate, {name: functionName});
    }

    return contentFunction(spec);
  }
}

export function quickLoadContentDependencies(opts) {
  return new Promise((resolve, reject) => {
    const watcher = watchContentDependencies(opts);

    watcher.on('error', (name, error) => {
      watcher.close().then(() => {
        error.message = `Error loading dependency ${name}: ${error}`;
        reject(error);
      });
    });

    watcher.on('ready', () => {
      watcher.close().then(() => {
        resolve(watcher.contentDependencies);
      });
    });
  });
}