« get me outta code hell

index.js « client « js « static « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/static/js/client/index.js
blob: 52d2afd600179ff14ab742e7b3a2ccded3420406 (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
/* eslint-env browser */

import '../group-contributions-table.js';

import * as additionalNamesBoxModule from './additional-names-box.js';
import * as albumCommentarySidebarModule from './album-commentary-sidebar.js';
import * as artistExternalLinkTooltipModule from './artist-external-link-tooltip.js';
import * as cssCompatibilityAssistantModule from './css-compatibility-assistant.js';
import * as datetimestampTooltipModule from './datetimestamp-tooltip.js';
import * as draggedLinkModule from './dragged-link.js';
import * as hashLinkModule from './hash-link.js';
import * as hoverableTooltipModule from './hoverable-tooltip.js';
import * as imageOverlayModule from './image-overlay.js';
import * as intrapageDotSwitcherModule from './intrapage-dot-switcher.js';
import * as liveMousePositionModule from './live-mouse-position.js';
import * as quickDescriptionModule from './quick-description.js';
import * as scriptedLinkModule from './scripted-link.js';
import * as sidebarSearchModule from './sidebar-search.js';
import * as stickyHeadingModule from './sticky-heading.js';
import * as summaryNestedLinkModule from './summary-nested-link.js';
import * as textWithTooltipModule from './text-with-tooltip.js';
import * as wikiSearchModule from './wiki-search.js';

export const modules = [
  additionalNamesBoxModule,
  albumCommentarySidebarModule,
  artistExternalLinkTooltipModule,
  cssCompatibilityAssistantModule,
  datetimestampTooltipModule,
  draggedLinkModule,
  hashLinkModule,
  hoverableTooltipModule,
  imageOverlayModule,
  intrapageDotSwitcherModule,
  liveMousePositionModule,
  quickDescriptionModule,
  scriptedLinkModule,
  sidebarSearchModule,
  stickyHeadingModule,
  summaryNestedLinkModule,
  textWithTooltipModule,
  wikiSearchModule,
];

const clientInfo = window.hsmusicClientInfo = Object.create(null);

const clientSteps = {
  getPageReferences: [],
  addInternalListeners: [],
  mutatePageContent: [],
  initializeState: [],
  addPageListeners: [],
};

for (const module of modules) {
  const {info} = module;

  if (!info) {
    throw new Error(`Module missing info`);
  }

  const {id: infoKey} = info;

  if (!infoKey) {
    throw new Error(`Module info missing id: ` + JSON.stringify(info));
  }

  clientInfo[infoKey] = info;

  for (const obj of [
    info,
    info.state,
    info.settings,
    info.event,
  ]) {
    if (!obj) continue;

    if (obj !== info) {
      obj[Symbol.for('hsmusic.clientInfo')] = info;
    }

    Object.preventExtensions(obj);
  }

  if (info.session) {
    const sessionSpecs = info.session;

    info.session = {};

    for (const [key, spec] of Object.entries(sessionSpecs)) {
      const hasSpec =
        typeof spec === 'object' && spec !== null;

      const defaultValue =
        (hasSpec
          ? spec.default ?? null
          : spec);

      let formatRead = value => value;
      let formatWrite = value => value;
      if (hasSpec && spec.type) {
        switch (spec.type) {
          case 'number':
            formatRead = parseFloat;
            formatWrite = String;
            break;

          case 'boolean':
            formatRead = Boolean;
            formatWrite = String;
            break;

          case 'string':
            formatRead = String;
            formatWrite = String;
            break;

          case 'json':
            formatRead = JSON.parse;
            formatWrite = JSON.stringify;
            break;

          default:
            throw new Error(`Unknown type for session storage spec "${spec.type}"`);
        }
      }

      let getMaxLength =
        (!hasSpec
          ? () => Infinity
       : typeof spec.maxLength === 'function'
          ? (info.settings
              ? () => spec.maxLength(info.settings)
              : () => spec.maxLength())
          : () => spec.maxLength);

      const storageKey = `hsmusic.${infoKey}.${key}`;

      let fallbackValue = defaultValue;

      Object.defineProperty(info.session, key, {
        get: () => {
          let value;
          try {
            value = sessionStorage.getItem(storageKey) ?? defaultValue;
          } catch (error) {
            if (error instanceof DOMException) {
              value = fallbackValue;
            } else {
              throw error;
            }
          }

          if (value === null) {
            return null;
          }

          return formatRead(value);
        },

        set: (value) => {
          if (value !== null && value !== '') {
            value = formatWrite(value);
          }

          if (value === null) {
            value = '';
          }

          const maxLength = getMaxLength();
          if (value.length > maxLength) {
            console.warn(
              `Requested to set session storage ${storageKey} ` +
              `beyond maximum length ${maxLength}, ` +
              `ignoring this value.`);
            console.trace();
            return;
          }

          let operation;
          if (value === '') {
            fallbackValue = null;
            operation = () => {
              sessionStorage.removeItem(storageKey);
            };
          } else {
            fallbackValue = value;
            operation = () => {
              sessionStorage.setItem(storageKey, value);
            };
          }

          try {
            operation();
          } catch (error) {
            if (!(error instanceof DOMException)) {
              throw error;
            }
          }
        },
      });
    }

    Object.preventExtensions(info.session);
  }

  for (const key of Object.keys(clientSteps)) {
    if (Object.hasOwn(module, key)) {
      const fn = module[key];

      Object.defineProperty(fn, 'name', {
        value: `${infoKey}/${fn.name}`,
      });

      clientSteps[key].push(fn);
    }
  }
}

for (const [key, steps] of Object.entries(clientSteps)) {
  for (const step of steps) {
    try {
      step();
    } catch (error) {
      // TODO: Be smarter about not running later steps for the same module!
      // Or maybe not, since an error is liable to cause explosions anyway.
      console.error(`During ${key}, failed to run ${step.name}`);
      console.error(error);
    }
  }
}