« get me outta code hell

track.js « things « data « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/data/things/track.js
blob: fcfd39c7761cd3a7f7f7b27f045eaa97114fd47c (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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
import {inspect} from 'node:util';

import {colors} from '#cli';
import find from '#find';
import {empty} from '#sugar';
import {isColor, isDate, isDuration, isFileExtension} from '#validators';

import {
  compositeFrom,
  exitWithoutDependency,
  exposeConstant,
  exposeDependency,
  exposeDependencyOrContinue,
  exposeUpdateValueOrContinue,
  withResultOfAvailabilityCheck,
} from '#composite';

import Thing, {
  additionalFiles,
  commentary,
  commentatorArtists,
  contribsByRef,
  directory,
  dynamicContribs,
  flag,
  name,
  referenceList,
  resolvedReference,
  resolvedReferenceList,
  reverseReferenceList,
  simpleDate,
  singleReference,
  simpleString,
  urls,
  wikiData,
  withResolvedContribs,
  withResolvedReference,
  withReverseReferenceList,
} from './thing.js';

export class Track extends Thing {
  static [Thing.referenceType] = 'track';

  static [Thing.getPropertyDescriptors] = ({Album, ArtTag, Artist, Flash}) => ({
    // Update & expose

    name: name('Unnamed Track'),
    directory: directory(),

    duration: {
      flags: {update: true, expose: true},
      update: {validate: isDuration},
    },

    urls: urls(),
    dateFirstReleased: simpleDate(),

    artistContribsByRef: contribsByRef(),
    contributorContribsByRef: contribsByRef(),
    coverArtistContribsByRef: contribsByRef(),

    referencedTracksByRef: referenceList(Track),
    sampledTracksByRef: referenceList(Track),
    artTagsByRef: referenceList(ArtTag),

    color: compositeFrom(`Track.color`, [
      exposeUpdateValueOrContinue(),
      withContainingTrackSection(),

      {
        dependencies: ['#trackSection'],
        compute: ({'#trackSection': trackSection}, continuation) =>
          // Album.trackSections guarantees the track section will have a
          // color property (inheriting from the album's own color), but only
          // if it's actually present! Color will be inherited directly from
          // album otherwise.
          (trackSection
            ? trackSection.color
            : continuation()),
      },

      withAlbumProperty({property: 'color'}),

      exposeDependency({
        dependency: '#album.color',
        update: {validate: isColor},
      }),
    ]),

    // Disables presenting the track as though it has its own unique artwork.
    // This flag should only be used in select circumstances, i.e. to override
    // an album's trackCoverArtists. This flag supercedes that property, as well
    // as the track's own coverArtists.
    disableUniqueCoverArt: flag(),

    // File extension for track's corresponding media file. This represents the
    // track's unique cover artwork, if any, and does not inherit the extension
    // of the album's main artwork. It does inherit trackCoverArtFileExtension,
    // if present on the album.
    coverArtFileExtension: compositeFrom(`Track.coverArtFileExtension`, [
      // No cover art file extension if the track doesn't have unique artwork
      // in the first place.
      withHasUniqueCoverArt(),
      exitWithoutDependency({dependency: '#hasUniqueCoverArt', mode: 'falsy'}),

      // Expose custom coverArtFileExtension update value first.
      exposeUpdateValueOrContinue(),

      // Expose album's trackCoverArtFileExtension if no update value set.
      withAlbumProperty({property: 'trackCoverArtFileExtension'}),
      exposeDependencyOrContinue({dependency: '#album.trackCoverArtFileExtension'}),

      // Fallback to 'jpg'.
      exposeConstant({
        value: 'jpg',
        update: {validate: isFileExtension},
      }),
    ]),

    // Date of cover art release. Like coverArtFileExtension, this represents
    // only the track's own unique cover artwork, if any. This exposes only as
    // the track's own coverArtDate or its album's trackArtDate, so if neither
    // is specified, this value is null.
    coverArtDate: compositeFrom(`Track.coverArtDate`, [
      withHasUniqueCoverArt(),
      exitWithoutDependency({dependency: '#hasUniqueCoverArt', mode: 'falsy'}),

      exposeUpdateValueOrContinue(),

      withAlbumProperty({property: 'trackArtDate'}),
      exposeDependency({
        dependency: '#album.trackArtDate',
        update: {validate: isDate},
      }),
    ]),

    originalReleaseTrackByRef: singleReference(Track),

    dataSourceAlbumByRef: singleReference(Album),

    commentary: commentary(),
    lyrics: simpleString(),
    additionalFiles: additionalFiles(),
    sheetMusicFiles: additionalFiles(),
    midiProjectFiles: additionalFiles(),

    // Update only

    albumData: wikiData(Album),
    artistData: wikiData(Artist),
    artTagData: wikiData(ArtTag),
    flashData: wikiData(Flash),
    trackData: wikiData(Track),

    // Expose only

    commentatorArtists: commentatorArtists(),

    album: compositeFrom(`Track.album`, [
      withAlbum(),
      exposeDependency({dependency: '#album'}),
    ]),

    // Note - this is an internal property used only to help identify a track.
    // It should not be assumed in general that the album and dataSourceAlbum match
    // (i.e. a track may dynamically be moved from one album to another, at
    // which point dataSourceAlbum refers to where it was originally from, and is
    // not generally relevant information). It's also not guaranteed that
    // dataSourceAlbum is available (depending on the Track creator to optionally
    // provide dataSourceAlbumByRef).
    dataSourceAlbum: resolvedReference({
      ref: 'dataSourceAlbumByRef',
      data: 'albumData',
      find: find.album,
    }),

    date: compositeFrom(`Track.date`, [
      exposeDependencyOrContinue({dependency: 'dateFirstReleased'}),
      withAlbumProperty({property: 'date'}),
      exposeDependency({dependency: '#album.date'}),
    ]),

    // Whether or not the track has "unique" cover artwork - a cover which is
    // specifically associated with this track in particular, rather than with
    // the track's album as a whole. This is typically used to select between
    // displaying the track artwork and a fallback, such as the album artwork
    // or a placeholder. (This property is named hasUniqueCoverArt instead of
    // the usual hasCoverArt to emphasize that it does not inherit from the
    // album.)
    hasUniqueCoverArt: compositeFrom(`Track.hasUniqueCoverArt`, [
      withHasUniqueCoverArt(),
      exposeDependency({dependency: '#hasUniqueCoverArt'}),
    ]),

    originalReleaseTrack: compositeFrom(`Track.originalReleaseTrack`, [
      withOriginalRelease(),
      exposeDependency({dependency: '#originalRelease'}),
    ]),

    otherReleases: compositeFrom(`Track.otherReleases`, [
      exitWithoutDependency({dependency: 'trackData', mode: 'empty'}),
      withOriginalRelease({selfIfOriginal: true}),

      {
        flags: {expose: true},
        expose: {
          dependencies: ['this', 'trackData', '#originalRelease'],
          compute: ({
            this: thisTrack,
            trackData,
            '#originalRelease': originalRelease,
          }) =>
            (originalRelease === thisTrack
              ? []
              : [originalRelease])
              .concat(trackData.filter(track =>
                track !== originalRelease &&
                track !== thisTrack &&
                track.originalReleaseTrack === originalRelease)),
        },
      },
    ]),

    artistContribs: compositeFrom(`Track.artistContribs`, [
      inheritFromOriginalRelease({property: 'artistContribs'}),

      withResolvedContribs({
        from: 'artistContribsByRef',
        into: '#artistContribs',
      }),

      {
        dependencies: ['#artistContribs'],
        compute: ({'#artistContribs': contribsFromTrack}, continuation) =>
          (empty(contribsFromTrack)
            ? continuation()
            : contribsFromTrack),
      },

      withAlbumProperty({property: 'artistContribs'}),
      exposeDependency({dependency: '#album.artistContribs'}),
    ]),

    contributorContribs: compositeFrom(`Track.contributorContribs`, [
      inheritFromOriginalRelease({property: 'contributorContribs'}),
      dynamicContribs('contributorContribsByRef'),
    ]),

    // Cover artists aren't inherited from the original release, since it
    // typically varies by release and isn't defined by the musical qualities
    // of the track.
    coverArtistContribs: compositeFrom(`Track.coverArtistContribs`, [
      {
        dependencies: ['disableUniqueCoverArt'],
        compute: ({disableUniqueCoverArt}, continuation) =>
          (disableUniqueCoverArt
            ? null
            : continuation()),
      },

      withResolvedContribs({
        from: 'coverArtistContribsByRef',
        into: '#coverArtistContribs',
      }),

      {
        dependencies: ['#coverArtistContribs'],
        compute: ({'#coverArtistContribs': contribsFromTrack}, continuation) =>
          (empty(contribsFromTrack)
            ? continuation()
            : contribsFromTrack),
      },

      withAlbumProperty({property: 'trackCoverArtistContribs'}),
      exposeDependency({dependency: '#album.trackCoverArtistContribs'}),
    ]),

    referencedTracks: compositeFrom(`Track.referencedTracks`, [
      inheritFromOriginalRelease({property: 'referencedTracks'}),
      resolvedReferenceList({
        list: 'referencedTracksByRef',
        data: 'trackData',
        find: find.track,
      }),
    ]),

    sampledTracks: compositeFrom(`Track.sampledTracks`, [
      inheritFromOriginalRelease({property: 'sampledTracks'}),
      resolvedReferenceList({
        list: 'sampledTracksByRef',
        data: 'trackData',
        find: find.track,
      }),
    ]),

    artTags: resolvedReferenceList({
      list: 'artTagsByRef',
      data: 'artTagData',
      find: find.artTag,
    }),

    // Specifically exclude re-releases from this list - while it's useful to
    // get from a re-release to the tracks it references, re-releases aren't
    // generally relevant from the perspective of the tracks being referenced.
    // Filtering them from data here hides them from the corresponding field
    // on the site (obviously), and has the bonus of not counting them when
    // counting the number of times a track has been referenced, for use in
    // the "Tracks - by Times Referenced" listing page (or other data
    // processing).
    referencedByTracks: trackReverseReferenceList({
      property: 'referencedTracks',
    }),

    // For the same reasoning, exclude re-releases from sampled tracks too.
    sampledByTracks: trackReverseReferenceList({
      property: 'sampledTracks',
    }),

    featuredInFlashes: reverseReferenceList({
      data: 'flashData',
      list: 'featuredTracks',
    }),
  });

  [inspect.custom](depth) {
    const parts = [];

    parts.push(Thing.prototype[inspect.custom].apply(this));

    if (this.originalReleaseTrackByRef) {
      parts.unshift(`${colors.yellow('[rerelease]')} `);
    }

    let album;
    if (depth >= 0 && (album = this.album ?? this.dataSourceAlbum)) {
      const albumName = album.name;
      const albumIndex = album.tracks.indexOf(this);
      const trackNum =
        (albumIndex === -1
          ? '#?'
          : `#${albumIndex + 1}`);
      parts.push(` (${colors.yellow(trackNum)} in ${colors.green(albumName)})`);
    }

    return parts.join('');
  }
}

// Early exits with a value inherited from the original release, if
// this track is a rerelease, and otherwise continues with no further
// dependencies provided. If allowOverride is true, then the continuation
// will also be called if the original release exposed the requested
// property as null.
function inheritFromOriginalRelease({
  property: originalProperty,
  allowOverride = false,
}) {
  return compositeFrom(`inheritFromOriginalRelease`, [
    withOriginalRelease(),

    {
      dependencies: ['#originalRelease'],
      compute({'#originalRelease': originalRelease}, continuation) {
        if (!originalRelease) return continuation.raise();

        const value = originalRelease[originalProperty];
        if (allowOverride && value === null) return continuation.raise();

        return continuation.exit(value);
      },
    },
  ]);
}

// Gets the track's album. This will early exit if albumData is missing.
// By default, if there's no album whose list of tracks includes this track,
// the output dependency will be null; set {notFoundMode: 'exit'} to early
// exit instead.
function withAlbum({
  into = '#album',
  notFoundMode = 'null',
} = {}) {
  return compositeFrom(`withAlbum`, [
    withResultOfAvailabilityCheck({
      fromDependency: 'albumData',
      mode: 'empty',
      into: '#albumDataAvailability',
    }),

    {
      dependencies: ['#albumDataAvailability'],
      options: {notFoundMode},
      mapContinuation: {into},

      compute: ({
        '#albumDataAvailability': albumDataAvailability,
        '#options': {notFoundMode},
      }, continuation) =>
        (albumDataAvailability
          ? continuation()
          : (notFoundMode === 'exit'
              ? continuation.exit(null)
              : continuation.raise({into: null}))),
    },

    {
      dependencies: ['this', 'albumData'],
      compute: ({this: track, albumData}, continuation) =>
        continuation({
          '#album': albumData.find(album => album.tracks.includes(track)),
        }),
    },

    withResultOfAvailabilityCheck({
      fromDependency: '#album',
      mode: 'null',
      into: '#albumAvailability',
    }),

    {
      dependencies: ['#albumAvailability'],
      options: {notFoundMode},
      mapContinuation: {into},

      compute: ({
        '#albumAvailability': albumAvailability,
        '#options': {notFoundMode},
      }, continuation) =>
        (albumAvailability
          ? continuation()
          : (notFoundMode === 'exit'
              ? continuation.exit(null)
              : continuation.raise({into: null}))),
    },

    {
      dependencies: ['#album'],
      mapContinuation: {into},
      compute: ({'#album': album}, continuation) =>
        continuation({into: album}),
    },
  ]);
}

// Gets a single property from this track's album, providing it as the same
// property name prefixed with '#album.' (by default). If the track's album
// isn't available, then by default, the property will be provided as null;
// set {notFoundMode: 'exit'} to early exit instead.
function withAlbumProperty({
  property,
  into = '#album.' + property,
  notFoundMode = 'null',
}) {
  return compositeFrom(`withAlbumProperty`, [
    withAlbum({notFoundMode}),

    {
      dependencies: ['#album'],
      options: {property},
      mapContinuation: {into},

      compute: ({
        '#album': album,
        '#options': {property},
      }, continuation) =>
        (album
          ? continuation.raise({into: album[property]})
          : continuation.raise({into: null})),
    },
  ]);
}

// Gets the listed properties from this track's album, providing them as
// dependencies (by default) with '#album.' prefixed before each property
// name. If the track's album isn't available, then by default, the same
// dependency names will be provided as null; set {notFoundMode: 'exit'}
// to early exit instead.
function withAlbumProperties({
  properties,
  prefix = '#album',
  notFoundMode = 'null',
}) {
  return compositeFrom(`withAlbumProperties`, [
    withAlbum({notFoundMode}),

    {
      dependencies: ['#album'],
      options: {properties, prefix},

      compute({
        '#album': album,
        '#options': {properties, prefix},
      }, continuation) {
        const raise = {};

        if (album) {
          for (const property of properties) {
            raise[prefix + '.' + property] = album[property];
          }
        } else {
          for (const property of properties) {
            raise[prefix + '.' + property] = null;
          }
        }

        return continuation.raise(raise);
      },
    },
  ]);
}

// Gets the track section containing this track from its album's track list.
// If notFoundMode is set to 'exit', this will early exit if the album can't be
// found or if none of its trackSections includes the track for some reason.
function withContainingTrackSection({
  into = '#trackSection',
  notFoundMode = 'null',
} = {}) {
  if (!['exit', 'null'].includes(notFoundMode)) {
    throw new TypeError(`Expected notFoundMode to be exit or null`);
  }

  return compositeFrom(`withContainingTrackSection`, [
    withAlbumProperty({property: 'trackSections', notFoundMode}),

    {
      dependencies: ['this', '#album.trackSections'],
      options: {notFoundMode},
      mapContinuation: {into},

      compute({
        this: track,
        '#album.trackSections': trackSections,
        '#options': {notFoundMode},
      }, continuation) {
        if (!trackSections) {
          return continuation.raise({into: null});
        }

        const trackSection =
          trackSections.find(({tracks}) => tracks.includes(track));

        if (trackSection) {
          return continuation.raise({into: trackSection});
        } else if (notFoundMode === 'exit') {
          return continuation.exit(null);
        } else {
          return continuation.raise({into: null});
        }
      },
    },
  ]);
}

// Just includes the original release of this track as a dependency.
// If this track isn't a rerelease, then it'll provide null, unless the
// {selfIfOriginal} option is set, in which case it'll provide this track
// itself. Note that this will early exit if the original release is
// specified by reference and that reference doesn't resolve to anything.
// Outputs to '#originalRelease' by default.
function withOriginalRelease({
  into = '#originalRelease',
  selfIfOriginal = false,
} = {}) {
  return compositeFrom(`withOriginalRelease`, [
    withResolvedReference({
      ref: 'originalReleaseTrackByRef',
      data: 'trackData',
      into: '#originalRelease',
      find: find.track,
      notFoundMode: 'exit',
    }),

    {
      dependencies: ['this', '#originalRelease'],
      options: {selfIfOriginal},
      mapContinuation: {into},
      compute: ({
        this: track,
        '#originalRelease': originalRelease,
        '#options': {selfIfOriginal},
      }, continuation) =>
        continuation.raise({
          into:
            (originalRelease ??
              (selfIfOriginal
                ? track
                : null)),
        }),
    },
  ]);
}

// The algorithm for checking if a track has unique cover art is used in a
// couple places, so it's defined in full as a compositional step.
function withHasUniqueCoverArt({
  into = '#hasUniqueCoverArt',
} = {}) {
  return compositeFrom(`withHasUniqueCoverArt`, [
    {
      dependencies: ['disableUniqueCoverArt'],
      mapContinuation: {into},
      compute: ({disableUniqueCoverArt}, continuation) =>
        (disableUniqueCoverArt
          ? continuation.raise({into: false})
          : continuation()),
    },

    withResolvedContribs({
      from: 'coverArtistContribsByRef',
      into: '#coverArtistContribs',
    }),

    {
      dependencies: ['#coverArtistContribs'],
      mapContinuation: {into},
      compute: ({'#coverArtistContribs': contribsFromTrack}, continuation) =>
        (empty(contribsFromTrack)
          ? continuation()
          : continuation.raise({into: true})),
    },

    withAlbumProperty({property: 'trackCoverArtistContribs'}),

    {
      dependencies: ['#album.trackCoverArtistContribs'],
      mapContinuation: {into},
      compute: ({'#album.trackCoverArtistContribs': contribsFromAlbum}, continuation) =>
        (empty(contribsFromAlbum)
          ? continuation.raise({into: false})
          : continuation.raise({into: true})),
    },
  ]);
}

function trackReverseReferenceList({
  property: refListProperty,
}) {
  return compositeFrom(`trackReverseReferenceList`, [
    withReverseReferenceList({
      data: 'trackData',
      list: refListProperty,
    }),

    {
      flags: {expose: true},
      expose: {
        dependencies: ['#reverseReferenceList'],
        compute: ({'#reverseReferenceList': reverseReferenceList}) =>
          reverseReferenceList.filter(track => !track.originalReleaseTrack),
      },
    },
  ]);
}