« get me outta code hell

find.js « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/find.js
blob: 966629e3bff29ad332774f7759834d0a0890add0 (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
import {inspect} from 'node:util';

import {color, logWarn} from '#cli';

function warnOrThrow(mode, message) {
  if (mode === 'error') {
    throw new Error(message);
  }

  if (mode === 'warn') {
    logWarn(message);
  }

  return null;
}

function findHelper(keys, findFns = {}) {
  // Note: This cache explicitly *doesn't* support mutable data arrays. If the
  // data array is modified, make sure it's actually a new array object, not
  // the original, or the cache here will break and act as though the data
  // hasn't changed!
  const cache = new WeakMap();

  const byDirectory = findFns.byDirectory || matchDirectory;
  const byName = findFns.byName || matchName;

  const keyRefRegex = new RegExp(String.raw`^(?:(${keys.join('|')}):(?=\S))?(.*)$`);

  // The mode argument here may be 'warn', 'error', or 'quiet'. 'error' throws
  // errors for null matches (with details about the error), while 'warn' and
  // 'quiet' both return null, with 'warn' logging details directly to the
  // console.
  return (fullRef, data, {mode = 'warn'} = {}) => {
    if (!fullRef) return null;
    if (typeof fullRef !== 'string') {
      throw new Error(`Got a reference that is ${typeof fullRef}, not string: ${fullRef}`);
    }

    if (!data) {
      throw new Error(`Expected data to be present`);
    }

    if (!Array.isArray(data) && data.wikiData) {
      throw new Error(`Old {wikiData: {...}} format provided`);
    }

    let cacheForThisData = cache.get(data);
    const cachedValue = cacheForThisData?.[fullRef];
    if (cachedValue) {
      globalThis.NUM_CACHE = (globalThis.NUM_CACHE || 0) + 1;
      return cachedValue;
    }
    if (!cacheForThisData) {
      cacheForThisData = Object.create(null);
      cache.set(data, cacheForThisData);
    }

    const match = fullRef.match(keyRefRegex);
    if (!match) {
      return warnOrThrow(mode, `Malformed link reference: "${fullRef}"`);
    }

    const key = match[1];
    const ref = match[2];

    const found = key ? byDirectory(ref, data, mode) : byName(ref, data, mode);

    if (!found) {
      warnOrThrow(mode, `Didn't match anything for ${color.bright(fullRef)}`);
    }

    cacheForThisData[fullRef] = found;

    return found;
  };
}

function matchDirectory(ref, data) {
  return data.find(({directory}) => directory === ref);
}

function matchName(ref, data, mode) {
  const matches =
    data
      .filter(({name}) => name.toLowerCase() === ref.toLowerCase())
      .filter(thing =>
        (Object.hasOwn(thing, 'alwaysReferenceByDirectory')
          ? !thing.alwaysReferenceByDirectory
          : true));

  if (matches.length > 1) {
    return warnOrThrow(mode,
      `Multiple matches for reference "${ref}". Please resolve:\n` +
      matches.map(match => `- ${inspect(match)}\n`).join('') +
      `Returning null for this reference.`);
  }

  if (matches.length === 0) {
    return null;
  }

  const thing = matches[0];

  if (ref !== thing.name) {
    warnOrThrow(mode,
      `Bad capitalization: ${color.red(ref)} -> ${color.green(thing.name)}`);
  }

  return thing;
}

function matchTagName(ref, data, quiet) {
  return matchName(ref.startsWith('cw: ') ? ref.slice(4) : ref, data, quiet);
}

const find = {
  album: findHelper(['album', 'album-commentary', 'album-gallery']),
  artist: findHelper(['artist', 'artist-gallery']),
  artTag: findHelper(['tag'], {byName: matchTagName}),
  flash: findHelper(['flash']),
  group: findHelper(['group', 'group-gallery']),
  listing: findHelper(['listing']),
  newsEntry: findHelper(['news-entry']),
  staticPage: findHelper(['static']),
  track: findHelper(['track']),
};

export default find;

// Handy utility function for binding the find.thing() functions to a complete
// wikiData object, optionally taking default options to provide to the find
// function. Note that this caches the arrays read from wikiData right when it's
// called, so if their values change, you'll have to continue with a fresh call
// to bindFind.
export function bindFind(wikiData, opts1) {
  return Object.fromEntries(
    Object.entries({
      album: 'albumData',
      artist: 'artistData',
      artTag: 'artTagData',
      flash: 'flashData',
      group: 'groupData',
      listing: 'listingSpec',
      newsEntry: 'newsData',
      staticPage: 'staticPageData',
      track: 'trackData',
    }).map(([key, value]) => {
      const findFn = find[key];
      const thingData = wikiData[value];
      return [
        key,
        opts1
          ? (ref, opts2) =>
              opts2
                ? findFn(ref, thingData, {...opts1, ...opts2})
                : findFn(ref, thingData, opts1)
          : (ref, opts2) =>
              opts2 ? findFn(ref, thingData, opts2) : findFn(ref, thingData),
      ];
    })
  );
}