« get me outta code hell

yaml.js « data « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/data/yaml.js
blob: 072aca67d3506c8e40566a3d946dc74ba7163ebf (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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
// yaml.js - specification for HSMusic YAML data file format and utilities for
// loading and processing YAML files and documents

import * as path from 'path';
import yaml from 'js-yaml';

import { readFile } from 'fs/promises';
import { inspect as nodeInspect } from 'util';

import {
    Album,
    Artist,
    ArtTag,
    Flash,
    FlashAct,
    Group,
    GroupCategory,
    HomepageLayout,
    HomepageLayoutAlbumsRow,
    HomepageLayoutRow,
    NewsEntry,
    StaticPage,
    Thing,
    Track,
    TrackGroup,
    WikiInfo,
} from './things.js';

import {
    color,
    ENABLE_COLOR,
    logInfo,
    logWarn,
} from '../util/cli.js';

import {
    decorateErrorWithIndex,
    mapAggregate,
    openAggregate,
    showAggregate,
    withAggregate,
} from '../util/sugar.js';

import {
    sortByDate,
    sortByName,
} from '../util/wiki-data.js';

import find, { bindFind } from '../util/find.js';
import { findFiles } from '../util/io.js';

// --> General supporting stuff

function inspect(value) {
    return nodeInspect(value, {colors: ENABLE_COLOR});
}

// --> YAML data repository structure constants

export const WIKI_INFO_FILE = 'wiki-info.yaml';
export const BUILD_DIRECTIVE_DATA_FILE = 'build-directives.yaml';
export const HOMEPAGE_LAYOUT_DATA_FILE = 'homepage.yaml';
export const ARTIST_DATA_FILE = 'artists.yaml';
export const FLASH_DATA_FILE = 'flashes.yaml';
export const NEWS_DATA_FILE = 'news.yaml';
export const ART_TAG_DATA_FILE = 'tags.yaml';
export const GROUP_DATA_FILE = 'groups.yaml';
export const STATIC_PAGE_DATA_FILE = 'static-pages.yaml';

export const DATA_ALBUM_DIRECTORY = 'album';

// --> Document processing functions

// General function for inputting a single document (usually loaded from YAML)
// and outputting an instance of a provided Thing subclass.
//
// makeProcessDocument is a factory function: the returned function will take a
// document and apply the configuration passed to makeProcessDocument in order
// to construct a Thing subclass.
function makeProcessDocument(thingClass, {
    // Optional early step for transforming field values before providing them
    // to the Thing's update() method. This is useful when the input format
    // (i.e. values in the document) differ from the format the actual Thing
    // expects.
    //
    // Each key and value are a field name (not an update() property) and a
    // function which takes the value for that field and returns the value which
    // will be passed on to update().
    fieldTransformations = {},

    // Mapping of Thing.update() source properties to field names.
    //
    // Note this is property -> field, not field -> property. This is a
    // shorthand convenience because properties are generally typical
    // camel-cased JS properties, while fields may contain whitespace and be
    // more easily represented as quoted strings.
    propertyFieldMapping,

    // Completely ignored fields. These won't throw an unknown field error if
    // they're present in a document, but they won't be used for Thing property
    // generation, either. Useful for stuff that's present in data files but not
    // yet implemented as part of a Thing's data model!
    ignoredFields = []
}) {
    if (!propertyFieldMapping) {
        throw new Error(`Expected propertyFieldMapping to be provided`);
    }

    const knownFields = Object.values(propertyFieldMapping);

    // Invert the property-field mapping, since it'll come in handy for
    // assigning update() source values later.
    const fieldPropertyMapping = Object.fromEntries(
        (Object.entries(propertyFieldMapping)
            .map(([ property, field ]) => [field, property])));

    const decorateErrorWithName = fn => {
        const nameField = propertyFieldMapping['name'];
        if (!nameField) return fn;

        return document => {
            try {
                return fn(document);
            } catch (error) {
                const name = document[nameField];
                error.message = (name
                    ? `(name: ${inspect(name)}) ${error.message}`
                    : `(${color.dim(`no name found`)}) ${error.message}`);
                throw error;
            }
        };
    };

    return decorateErrorWithName(document => {
        const documentEntries = Object.entries(document)
            .filter(([ field ]) => !ignoredFields.includes(field));

        const unknownFields = documentEntries
            .map(([ field ]) => field)
            .filter(field => !knownFields.includes(field));

        if (unknownFields.length) {
            throw new makeProcessDocument.UnknownFieldsError(unknownFields);
        }

        const fieldValues = {};

        for (const [ field, value ] of documentEntries) {
            if (Object.hasOwn(fieldTransformations, field)) {
                fieldValues[field] = fieldTransformations[field](value);
            } else {
                fieldValues[field] = value;
            }
        }

        const sourceProperties = {};

        for (const [ field, value ] of Object.entries(fieldValues)) {
            const property = fieldPropertyMapping[field];
            sourceProperties[property] = value;
        }

        const thing = Reflect.construct(thingClass, []);

        withAggregate({message: `Errors applying ${color.green(thingClass.name)} properties`}, ({ call }) => {
            for (const [ property, value ] of Object.entries(sourceProperties)) {
                call(() => (thing[property] = value));
            }
        });

        return thing;
    });
}

makeProcessDocument.UnknownFieldsError = class UnknownFieldsError extends Error {
    constructor(fields) {
        super(`Unknown fields present: ${fields.join(', ')}`);
        this.fields = fields;
    }
};

export const processAlbumDocument = makeProcessDocument(Album, {
    fieldTransformations: {
        'Artists': parseContributors,
        'Cover Artists': parseContributors,
        'Default Track Cover Artists': parseContributors,
        'Wallpaper Artists': parseContributors,
        'Banner Artists': parseContributors,

        'Date': value => new Date(value),
        'Date Added': value => new Date(value),
        'Cover Art Date': value => new Date(value),
        'Default Track Cover Art Date': value => new Date(value),

        'Banner Dimensions': parseDimensions,

        'Additional Files': parseAdditionalFiles,
    },

    propertyFieldMapping: {
        name: 'Album',

        color: 'Color',
        directory: 'Directory',
        urls: 'URLs',

        artistContribsByRef: 'Artists',
        coverArtistContribsByRef: 'Cover Artists',
        trackCoverArtistContribsByRef: 'Default Track Cover Artists',

        coverArtFileExtension: 'Cover Art File Extension',
        trackCoverArtFileExtension: 'Track Art File Extension',

        wallpaperArtistContribsByRef: 'Wallpaper Artists',
        wallpaperStyle: 'Wallpaper Style',
        wallpaperFileExtension: 'Wallpaper File Extension',

        bannerArtistContribsByRef: 'Banner Artists',
        bannerStyle: 'Banner Style',
        bannerFileExtension: 'Banner File Extension',
        bannerDimensions: 'Banner Dimensions',

        date: 'Date',
        trackArtDate: 'Default Track Cover Art Date',
        coverArtDate: 'Cover Art Date',
        dateAddedToWiki: 'Date Added',

        hasCoverArt: 'Has Cover Art',
        hasTrackArt: 'Has Track Art',
        hasTrackNumbers: 'Has Track Numbers',
        isMajorRelease: 'Major Release',
        isListedOnHomepage: 'Listed on Homepage',

        groupsByRef: 'Groups',
        artTagsByRef: 'Art Tags',
        commentary: 'Commentary',

        additionalFiles: 'Additional Files',
    }
});

export const processTrackGroupDocument = makeProcessDocument(TrackGroup, {
    fieldTransformations: {
        'Date Originally Released': value => new Date(value),
    },

    propertyFieldMapping: {
        name: 'Group',
        color: 'Color',
        dateOriginallyReleased: 'Date Originally Released',
    }
});

export const processTrackDocument = makeProcessDocument(Track, {
    fieldTransformations: {
        'Duration': getDurationInSeconds,

        'Date First Released': value => new Date(value),
        'Cover Art Date': value => new Date(value),

        'Artists': parseContributors,
        'Contributors': parseContributors,
        'Cover Artists': parseContributors,

        'Additional Files': parseAdditionalFiles,
    },

    propertyFieldMapping: {
        name: 'Track',

        directory: 'Directory',
        duration: 'Duration',
        urls: 'URLs',

        coverArtDate: 'Cover Art Date',
        coverArtFileExtension: 'Cover Art File Extension',
        dateFirstReleased: 'Date First Released',
        hasCoverArt: 'Has Cover Art',
        hasURLs: 'Has URLs',

        referencedTracksByRef: 'Referenced Tracks',
        artistContribsByRef: 'Artists',
        contributorContribsByRef: 'Contributors',
        coverArtistContribsByRef: 'Cover Artists',
        artTagsByRef: 'Art Tags',
        originalReleaseTrackByRef: 'Originally Released As',

        commentary: 'Commentary',
        lyrics: 'Lyrics',

        additionalFiles: 'Additional Files',
    },

    ignoredFields: ['Sampled Tracks']
});

export const processArtistDocument = makeProcessDocument(Artist, {
    propertyFieldMapping: {
        name: 'Artist',

        directory: 'Directory',
        urls: 'URLs',
        hasAvatar: 'Has Avatar',
        avatarFileExtension: 'Avatar File Extension',

        aliasNames: 'Aliases',

        contextNotes: 'Context Notes'
    },

    ignoredFields: ['Dead URLs']
});

export const processFlashDocument = makeProcessDocument(Flash, {
    fieldTransformations: {
        'Date': value => new Date(value),

        'Contributors': parseContributors,
    },

    propertyFieldMapping: {
        name: 'Flash',

        directory: 'Directory',
        page: 'Page',
        date: 'Date',
        coverArtFileExtension: 'Cover Art File Extension',

        featuredTracksByRef: 'Featured Tracks',
        contributorContribsByRef: 'Contributors',
        urls: 'URLs'
    },
});

export const processFlashActDocument = makeProcessDocument(FlashAct, {
    propertyFieldMapping: {
        name: 'Act',
        color: 'Color',
        anchor: 'Anchor',
        jump: 'Jump',
        jumpColor: 'Jump Color'
    }
});

export const processNewsEntryDocument = makeProcessDocument(NewsEntry, {
    fieldTransformations: {
        'Date': value => new Date(value)
    },

    propertyFieldMapping: {
        name: 'Name',
        directory: 'Directory',
        date: 'Date',
        content: 'Content',
    }
});

export const processArtTagDocument = makeProcessDocument(ArtTag, {
    propertyFieldMapping: {
        name: 'Tag',
        directory: 'Directory',
        color: 'Color',
        isContentWarning: 'Is CW'
    }
});

export const processGroupDocument = makeProcessDocument(Group, {
    propertyFieldMapping: {
        name: 'Group',
        directory: 'Directory',
        description: 'Description',
        urls: 'URLs',
    }
});

export const processGroupCategoryDocument = makeProcessDocument(GroupCategory, {
    propertyFieldMapping: {
        name: 'Category',
        color: 'Color',
    }
});

export const processStaticPageDocument = makeProcessDocument(StaticPage, {
    propertyFieldMapping: {
        name: 'Name',
        nameShort: 'Short Name',
        directory: 'Directory',

        content: 'Content',
        stylesheet: 'Style',

        showInNavigationBar: 'Show in Navigation Bar'
    }
});

export const processWikiInfoDocument = makeProcessDocument(WikiInfo, {
    propertyFieldMapping: {
        name: 'Name',
        nameShort: 'Short Name',
        color: 'Color',
        description: 'Description',
        footerContent: 'Footer Content',
        defaultLanguage: 'Default Language',
        canonicalBase: 'Canonical Base',
        enableFlashesAndGames: 'Enable Flashes & Games',
        enableListings: 'Enable Listings',
        enableNews: 'Enable News',
        enableArtTagUI: 'Enable Art Tag UI',
        enableGroupUI: 'Enable Group UI',
    }
});

export const processHomepageLayoutDocument = makeProcessDocument(HomepageLayout, {
    propertyFieldMapping: {
        sidebarContent: 'Sidebar Content'
    },

    ignoredFields: ['Homepage']
});

export function makeProcessHomepageLayoutRowDocument(rowClass, spec) {
    return makeProcessDocument(rowClass, {
        ...spec,

        propertyFieldMapping: {
            name: 'Row',
            color: 'Color',
            type: 'Type',
            ...spec.propertyFieldMapping,
        }
    });
}

export const homepageLayoutRowTypeProcessMapping = {
    albums: makeProcessHomepageLayoutRowDocument(HomepageLayoutAlbumsRow, {
        propertyFieldMapping: {
            sourceGroupByRef: 'Group',
            countAlbumsFromGroup: 'Count',
            sourceAlbumsByRef: 'Albums',
            actionLinks: 'Actions'
        }
    })
};

export function processHomepageLayoutRowDocument(document) {
    const type = document['Type'];

    const match = Object.entries(homepageLayoutRowTypeProcessMapping)
        .find(([ key ]) => key === type);

    if (!match) {
        throw new TypeError(`No processDocument function for row type ${type}!`);
    }

    return match[1](document);
}

// --> Utilities shared across document parsing functions

export function getDurationInSeconds(string) {
    if (typeof string === 'number') {
        return string;
    }

    if (typeof string !== 'string') {
        throw new TypeError(`Expected a string or number, got ${string}`);
    }

    const parts = string.split(':').map(n => parseInt(n))
    if (parts.length === 3) {
        return parts[0] * 3600 + parts[1] * 60 + parts[2]
    } else if (parts.length === 2) {
        return parts[0] * 60 + parts[1]
    } else {
        return 0
    }
}

export function parseAdditionalFiles(array) {
    if (!array) return null;
    if (!Array.isArray(array)) {
        // Error will be caught when validating against whatever this value is
        return array;
    }

    return array.map(item => ({
        title: item['Title'],
        description: item['Description'] ?? null,
        files: item['Files']
    }));
}

export function parseCommentary(text) {
    if (text) {
        const lines = String(text).split('\n');
        if (!lines[0].replace(/<\/b>/g, '').includes(':</i>')) {
            return {error: `An entry is missing commentary citation: "${lines[0].slice(0, 40)}..."`};
        }
        return text;
    } else {
        return null;
    }
}

export function parseContributors(contributors) {
    if (!contributors) {
        return null;
    }

    if (contributors.length === 1 && contributors[0].startsWith('<i>')) {
        const arr = [];
        arr.textContent = contributors[0];
        return arr;
    }

    contributors = contributors.map(contrib => {
        // 8asically, the format is "Who (What)", or just "Who". 8e sure to
        // keep in mind that "what" doesn't necessarily have a value!
        const match = contrib.match(/^(.*?)( \((.*)\))?$/);
        if (!match) {
            return contrib;
        }
        const who = match[1];
        const what = match[3] || null;
        return {who, what};
    });

    const badContributor = contributors.find(val => typeof val === 'string');
    if (badContributor) {
        return {error: `An entry has an incorrectly formatted contributor, "${badContributor}".`};
    }

    if (contributors.length === 1 && contributors[0].who === 'none') {
        return null;
    }

    return contributors;
}

function parseDimensions(string) {
    if (!string) {
        return null;
    }

    const parts = string.split(/[x,* ]+/g);
    if (parts.length !== 2) throw new Error(`Invalid dimensions: ${string} (expected width & height)`);
    const nums = parts.map(part => Number(part.trim()));
    if (nums.includes(NaN)) throw new Error(`Invalid dimensions: ${string} (couldn't parse as numbers)`);
    return nums;
}

// --> Data repository loading functions and descriptors

// documentModes: Symbols indicating sets of behavior for loading and processing
// data files.
export const documentModes = {
    // onePerFile: One document per file. Expects files array (or function) and
    // processDocument function. Obviously, each specified data file should only
    // contain one YAML document (an error will be thrown otherwise). Calls save
    // with an array of processed documents (wiki objects).
    onePerFile: Symbol('Document mode: onePerFile'),

    // headerAndEntries: One or more documents per file; the first document is
    // treated as a "header" and represents data which pertains to all following
    // "entry" documents. Expects files array (or function) and
    // processHeaderDocument and processEntryDocument functions. Calls save with
    // an array of {header, entries} objects.
    //
    // Please note that the final results loaded from each file may be "missing"
    // data objects corresponding to entry documents if the processEntryDocument
    // function throws on any entries, resulting in partial data provided to
    // save() - errors will be caught and thrown in the final buildSteps
    // aggregate. However, if the processHeaderDocument function fails, all
    // following documents in the same file will be ignored as well (i.e. an
    // entire file will be excempt from the save() function's input).
    headerAndEntries: Symbol('Document mode: headerAndEntries'),

    // allInOne: One or more documents, all contained in one file. Expects file
    // string (or function) and processDocument function. Calls save with an
    // array of processed documents (wiki objects).
    allInOne: Symbol('Document mode: allInOne'),

    // oneDocumentTotal: Just a single document, represented in one file.
    // Expects file string (or function) and processDocument function. Calls
    // save with the single processed wiki document (data object).
    //
    // Please note that if the single document fails to process, the save()
    // function won't be called at all, generally resulting in an altogether
    // missing property from the global wikiData object. This should be caught
    // and handled externally.
    oneDocumentTotal: Symbol('Document mode: oneDocumentTotal'),
};

// dataSteps: Top-level array of "steps" for loading YAML document files.
//
// title:
//   Name of the step (displayed in build output)
//
// documentMode:
//   Symbol which indicates by which "mode" documents from data files are
//   loaded and processed. See documentModes export.
//
// file, files:
//   String or array of strings which are paths to YAML data files, or a
//   function which returns the above (may be async). All paths are appended to
//   the global dataPath provided externally (e.g. HSMUSIC_DATA env variable).
//   Which to provide (file or files) depends on documentMode. If this is a
//   function, it will be provided with dataPath (e.g. so that a sub-path may be
//   readdir'd), but don't path.join(dataPath) the returned value(s) yourself -
//   this will be done automatically.
//
// processDocument, processHeaderDocument, processEntryDocument:
//   Functions which take a YAML document and return an actual wiki data object;
//   all actual conversion between YAML and wiki data happens here. Which to
//   provide (one or a combination) depend on documentMode.
//
// save:
//   Function which takes all documents processed (now as wiki data objects) and
//   actually applies them to a global wiki data object, for use in page
//   generation and other behavior. Returns an object to be assigned over the
//   global wiki data object (so specify any new properties here). This is also
//   the place to perform any final post-processing on data objects (linking
//   them to each other, setting additional properties, etc). Input argument
//   format depends on documentMode.
//
export const dataSteps = [
    {
        title: `Process wiki info file`,
        file: WIKI_INFO_FILE,

        documentMode: documentModes.oneDocumentTotal,
        processDocument: processWikiInfoDocument,

        save(wikiInfo) {
            if (!wikiInfo) {
                return;
            }

            return {wikiInfo};
        }
    },

    {
        title: `Process album files`,
        files: async dataPath => (
            (await findFiles(path.join(dataPath, DATA_ALBUM_DIRECTORY), {
                filter: f => path.extname(f) === '.yaml',
                joinParentDirectory: false
            })).map(file => path.join(DATA_ALBUM_DIRECTORY, file))),

        documentMode: documentModes.headerAndEntries,
        processHeaderDocument: processAlbumDocument,
        processEntryDocument(document) {
            return ('Group' in document
                ? processTrackGroupDocument(document)
                : processTrackDocument(document));
        },

        save(results) {
            const albumData = [];
            const trackData = [];

            for (const { header: album, entries } of results) {
                // We can't mutate an array once it's set as a property
                // value, so prepare the tracks and track groups that will
                // show up in a track list all the way before actually
                // applying them.
                const trackGroups = [];
                let currentTracksByRef = null;
                let currentTrackGroup = null;

                const albumRef = Thing.getReference(album);

                function closeCurrentTrackGroup() {
                    if (currentTracksByRef) {
                        let trackGroup;

                        if (currentTrackGroup) {
                            trackGroup = currentTrackGroup;
                        } else {
                            trackGroup = new TrackGroup();
                            trackGroup.name = `Default Track Group`;
                            trackGroup.isDefaultTrackGroup = true;
                        }

                        trackGroup.album = album;
                        trackGroup.tracksByRef = currentTracksByRef;
                        trackGroups.push(trackGroup);
                    }
                }

                for (const entry of entries) {
                    if (entry instanceof TrackGroup) {
                        closeCurrentTrackGroup();
                        currentTracksByRef = [];
                        currentTrackGroup = entry;
                        continue;
                    }

                    trackData.push(entry);

                    entry.dataSourceAlbumByRef = albumRef;

                    const trackRef = Thing.getReference(entry);
                    if (currentTracksByRef) {
                        currentTracksByRef.push(trackRef);
                    } else {
                        currentTracksByRef = [trackRef];
                    }
                }

                closeCurrentTrackGroup();

                album.trackGroups = trackGroups;
                albumData.push(album);
            }

            return {albumData, trackData};
        }
    },

    {
        title: `Process artists file`,
        file: ARTIST_DATA_FILE,

        documentMode: documentModes.allInOne,
        processDocument: processArtistDocument,

        save(results) {
            const artistData = results;

            const artistAliasData = results.flatMap(artist => {
                const origRef = Thing.getReference(artist);
                return (artist.aliasNames?.map(name => {
                    const alias = new Artist();
                    alias.name = name;
                    alias.isAlias = true;
                    alias.aliasedArtistRef = origRef;
                    alias.artistData = artistData;
                    return alias;
                }) ?? []);
            });

            return {artistData, artistAliasData};
        }
    },

    // TODO: WD.wikiInfo.enableFlashesAndGames &&
    {
        title: `Process flashes file`,
        file: FLASH_DATA_FILE,

        documentMode: documentModes.allInOne,
        processDocument(document) {
            return ('Act' in document
                ? processFlashActDocument(document)
                : processFlashDocument(document));
        },

        save(results) {
            let flashAct;
            let flashesByRef = [];

            if (results[0] && !(results[0] instanceof FlashAct)) {
                throw new Error(`Expected an act at top of flash data file`);
            }

            for (const thing of results) {
                if (thing instanceof FlashAct) {
                    if (flashAct) {
                        Object.assign(flashAct, {flashesByRef});
                    }

                    flashAct = thing;
                    flashesByRef = [];
                } else {
                    flashesByRef.push(Thing.getReference(thing));
                }
            }

            if (flashAct) {
                Object.assign(flashAct, {flashesByRef});
            }

            const flashData = results.filter(x => x instanceof Flash);
            const flashActData = results.filter(x => x instanceof FlashAct);

            return {flashData, flashActData};
        }
    },

    {
        title: `Process groups file`,
        file: GROUP_DATA_FILE,

        documentMode: documentModes.allInOne,
        processDocument(document) {
            return ('Category' in document
                ? processGroupCategoryDocument(document)
                : processGroupDocument(document));
        },

        save(results) {
            let groupCategory;
            let groupsByRef = [];

            if (results[0] && !(results[0] instanceof GroupCategory)) {
                throw new Error(`Expected a category at top of group data file`);
            }

            for (const thing of results) {
                if (thing instanceof GroupCategory) {
                    if (groupCategory) {
                        Object.assign(groupCategory, {groupsByRef});
                    }

                    groupCategory = thing;
                    groupsByRef = [];
                } else {
                    groupsByRef.push(Thing.getReference(thing));
                }
            }

            if (groupCategory) {
                Object.assign(groupCategory, {groupsByRef});
            }

            const groupData = results.filter(x => x instanceof Group);
            const groupCategoryData = results.filter(x => x instanceof GroupCategory);

            return {groupData, groupCategoryData};
        }
    },

    {
        title: `Process homepage layout file`,
        files: [HOMEPAGE_LAYOUT_DATA_FILE],

        documentMode: documentModes.headerAndEntries,
        processHeaderDocument: processHomepageLayoutDocument,
        processEntryDocument: processHomepageLayoutRowDocument,

        save(results) {
            if (!results[0]) {
                return;
            }

            const { header: homepageLayout, entries: rows } = results[0];
            Object.assign(homepageLayout, {rows});
            return {homepageLayout};
        }
    },

    // TODO: WD.wikiInfo.enableNews &&
    {
        title: `Process news data file`,
        file: NEWS_DATA_FILE,

        documentMode: documentModes.allInOne,
        processDocument: processNewsEntryDocument,

        save(newsData) {
            sortByDate(newsData);
            newsData.reverse();

            return {newsData};
        }
    },

    {
        title: `Process art tags file`,
        file: ART_TAG_DATA_FILE,

        documentMode: documentModes.allInOne,
        processDocument: processArtTagDocument,

        save(artTagData) {
            artTagData.sort(sortByName);

            return {artTagData};
        }
    },

    {
        title: `Process static pages file`,
        file: STATIC_PAGE_DATA_FILE,

        documentMode: documentModes.allInOne,
        processDocument: processStaticPageDocument,

        save(staticPageData) {
            return {staticPageData};
        }
    },
];

export async function loadAndProcessDataDocuments({
    dataPath,
}) {
    const processDataAggregate = openAggregate({message: `Errors processing data files`});
    const wikiDataResult = {};

    function decorateErrorWithFile(fn) {
        return (x, index, array) => {
            try {
                return fn(x, index, array);
            } catch (error) {
                error.message += (
                    (error.message.includes('\n') ? '\n' : ' ') +
                    `(file: ${color.bright(color.blue(path.relative(dataPath, x.file)))})`
                );
                throw error;
            }
        };
    }

    for (const dataStep of dataSteps) {
        await processDataAggregate.nestAsync(
            {message: `Errors during data step: ${dataStep.title}`},
            async ({call, callAsync, map, mapAsync, nest}) => {
                const { documentMode } = dataStep;

                if (!(Object.values(documentModes).includes(documentMode))) {
                    throw new Error(`Invalid documentMode: ${documentMode.toString()}`);
                }

                if (documentMode === documentModes.allInOne || documentMode === documentModes.oneDocumentTotal) {
                    if (!dataStep.file) {
                        throw new Error(`Expected 'file' property for ${documentMode.toString()}`);
                    }

                    const file = path.join(dataPath,
                        (typeof dataStep.file === 'function'
                            ? await callAsync(dataStep.file, dataPath)
                            : dataStep.file));

                    const readResult = await callAsync(readFile, file, 'utf-8');

                    if (!readResult) {
                        return;
                    }

                    const yamlResult = (documentMode === documentModes.oneDocumentTotal
                        ? call(yaml.load, readResult)
                        : call(yaml.loadAll, readResult));

                    if (!yamlResult) {
                        return;
                    }

                    let processResults;

                    if (documentMode === documentModes.oneDocumentTotal) {
                        nest({message: `Errors processing document`}, ({ call }) => {
                            processResults = call(dataStep.processDocument, yamlResult);
                        });
                    } else {
                        const { result, aggregate } = mapAggregate(
                            yamlResult,
                            decorateErrorWithIndex(dataStep.processDocument),
                            {message: `Errors processing documents`}
                        );
                        processResults = result;
                        call(aggregate.close);
                    }

                    if (!processResults) return;

                    const saveResult = call(dataStep.save, processResults);

                    if (!saveResult) return;

                    Object.assign(wikiDataResult, saveResult);

                    return;
                }

                if (!dataStep.files) {
                    throw new Error(`Expected 'files' property for ${documentMode.toString()}`);
                }

                const files = (
                    (typeof dataStep.files === 'function'
                        ? await callAsync(dataStep.files, dataPath)
                        : dataStep.files)
                    .map(file => path.join(dataPath, file)));

                const readResults = await mapAsync(
                    files,
                    file => (readFile(file, 'utf-8')
                        .then(contents => ({file, contents}))),
                    {message: `Errors reading data files`});

                const yamlResults = map(
                    readResults,
                    decorateErrorWithFile(
                        ({ file, contents }) => ({file, documents: yaml.loadAll(contents)})),
                    {message: `Errors parsing data files as valid YAML`});

                let processResults;

                if (documentMode === documentModes.headerAndEntries) {
                    nest({message: `Errors processing data files as valid documents`}, ({ call, map }) => {
                        processResults = [];

                        yamlResults.forEach(({ file, documents }) => {
                            const [ headerDocument, ...entryDocuments ] = documents;

                            const header = call(
                                decorateErrorWithFile(
                                    ({ document }) => dataStep.processHeaderDocument(document)),
                                {file, document: headerDocument});

                            // Don't continue processing files whose header
                            // document is invalid - the entire file is excempt
                            // from data in this case.
                            if (!header) {
                                return;
                            }

                            const entries = map(
                                entryDocuments.map(document => ({file, document})),
                                decorateErrorWithFile(
                                    decorateErrorWithIndex(
                                        ({ document }) => dataStep.processEntryDocument(document))),
                                {message: `Errors processing entry documents`});

                            // Entries may be incomplete (i.e. any errored
                            // documents won't have a processed output
                            // represented here) - this is intentional! By
                            // principle, partial output is preferred over
                            // erroring an entire file.
                            processResults.push({header, entries});
                        });
                    });
                }

                if (documentMode === documentModes.onePerFile) {
                    nest({message: `Errors processing data files as valid documents`}, ({ call, map }) => {
                        processResults = [];

                        yamlResults.forEach(({ file, documents }) => {
                            if (documents.length > 1) {
                                call(decorateErrorWithFile(() => {
                                    throw new Error(`Only expected one document to be present per file`);
                                }));
                                return;
                            }

                            const result = call(
                                decorateErrorWithFile(
                                    ({ document }) => dataStep.processDocument(document)),
                                {file, document: documents[0]});

                            if (!result) {
                                return;
                            }

                            processResults.push(result);
                        });
                    });
                }

                const saveResult = call(dataStep.save, processResults);

                if (!saveResult) return;

                Object.assign(wikiDataResult, saveResult);
            });
    }

    return {
        aggregate: processDataAggregate,
        result: wikiDataResult
    };
}

// Data linking! Basically, provide (portions of) wikiData to the Things which
// require it - they'll expose dynamically computed properties as a result (many
// of which are required for page HTML generation).
export function linkWikiDataArrays(wikiData) {
    function assignWikiData(things, ...keys) {
        for (let i = 0; i < things.length; i++) {
            for (let j = 0; j < keys.length; j++) {
                const key = keys[j];
                things[i][key] = wikiData[key];
            }
        }
    }

    const WD = wikiData;

    assignWikiData(WD.albumData, 'artistData', 'artTagData', 'groupData', 'trackData');
    WD.albumData.forEach(album => assignWikiData(album.trackGroups, 'trackData'));

    assignWikiData(WD.trackData, 'albumData', 'artistData', 'artTagData', 'flashData', 'trackData');
    assignWikiData(WD.artistData, 'albumData', 'artistData', 'flashData', 'trackData');
    assignWikiData(WD.groupData, 'albumData', 'groupCategoryData');
    assignWikiData(WD.groupCategoryData, 'groupData');
    assignWikiData(WD.flashData, 'artistData', 'flashActData', 'trackData');
    assignWikiData(WD.flashActData, 'flashData');
    assignWikiData(WD.artTagData, 'albumData', 'trackData');
    assignWikiData(WD.homepageLayout.rows, 'albumData', 'groupData');
}

export function sortWikiDataArrays(wikiData) {
    Object.assign(wikiData, {
        albumData: sortByDate(wikiData.albumData.slice()),
        trackData: sortByDate(wikiData.trackData.slice())
    });

    // Re-link data arrays, so that every object has the new, sorted versions.
    // Note that the sorting step deliberately creates new arrays (mutating
    // slices instead of the original arrays) - this is so that the object
    // caching system understands that it's working with a new ordering.
    // We still need to actually provide those updated arrays over again!
    linkWikiDataArrays(wikiData);
}

// Warn about directories which are reused across more than one of the same type
// of Thing. Directories are the unique identifier for most data objects across
// the wiki, so we have to make sure they aren't duplicated!  This also
// altogether filters out instances of things with duplicate directories (so if
// two tracks share the directory "megalovania", they'll both be skipped for the
// build, for example).
export function filterDuplicateDirectories(wikiData) {
    const deduplicateSpec = [
        'albumData',
        'artTagData',
        'flashData',
        'groupData',
        'newsData',
        'trackData',
    ];

    const aggregate = openAggregate({message: `Duplicate directories found`});
    for (const thingDataProp of deduplicateSpec) {
        const thingData = wikiData[thingDataProp];
        aggregate.nest({message: `Duplicate directories found in ${color.green('wikiData.' + thingDataProp)}`}, ({ call }) => {
            const directoryPlaces = Object.create(null);
            const duplicateDirectories = [];
            for (const thing of thingData) {
                const { directory } = thing;
                if (directory in directoryPlaces) {
                    directoryPlaces[directory].push(thing);
                    duplicateDirectories.push(directory);
                } else {
                    directoryPlaces[directory] = [thing];
                }
            }
            if (!duplicateDirectories.length) return;
            duplicateDirectories.sort((a, b) => {
                const aL = a.toLowerCase();
                const bL = b.toLowerCase();
                return aL < bL ? -1 : aL > bL ? 1 : 0;
            });
            for (const directory of duplicateDirectories) {
                const places = directoryPlaces[directory];
                call(() => {
                    throw new Error(`Duplicate directory ${color.green(directory)}:\n` +
                        places.map(thing => ` - ` + inspect(thing)).join('\n'));
                });
            }
            const allDuplicatedThings = Object.values(directoryPlaces).filter(arr => arr.length > 1).flat();
            const filteredThings = thingData.filter(thing => !allDuplicatedThings.includes(thing));
            wikiData[thingDataProp] = filteredThings;
        });
    }

    try {
        aggregate.close();
        return aggregate;
    } catch (error) {
        // Duplicate entries were found and filtered out, resulting in altered
        // wikiData arrays. These must be re-linked so objects receive the new
        // data.
        linkWikiDataArrays(wikiData);
        return error;
    }
}

// Warn about references across data which don't match anything.  This involves
// using the find() functions on all references, setting it to 'error' mode, and
// collecting everything in a structured logged (which gets logged if there are
// any errors). At the same time, we remove errored references from the thing's
// data array.
export function filterReferenceErrors(wikiData) {
    const referenceSpec = [
        ['albumData', {
            artistContribsByRef: '_contrib',
            coverArtistContribsByRef: '_contrib',
            trackCoverArtistContribsByRef: '_contrib',
            wallpaperArtistContribsByRef: '_contrib',
            bannerArtistContribsByRef: '_contrib',
            groupsByRef: 'group',
            artTagsByRef: 'artTag',
        }],

        ['trackData', {
            artistContribsByRef: '_contrib',
            contributorContribsByRef: '_contrib',
            coverArtistContribsByRef: '_contrib',
            referencedTracksByRef: 'track',
            artTagsByRef: 'artTag',
            originalReleaseTrackByRef: 'track',
        }],

        ['groupCategoryData', {
            groupsByRef: 'group',
        }],

        ['homepageLayout.rows', {
            sourceGroupsByRef: 'group',
            sourceAlbumsByRef: 'album',
        }],

        ['flashData', {
            contributorContribsByRef: '_contrib',
            featuredTracksByRef: 'track',
        }],

        ['flashActData', {
            flashesByRef: 'flash',
        }],
    ];

    function getNestedProp(obj, key) {
        const recursive = (o, k) => (k.length === 1
            ? o[k[0]]
            : recursive(o[k[0]], k.slice(1)));
        const keys = key.split(/(?<=(?<!\\)(?:\\\\)*)\./);
        return recursive(obj, keys);
    }

    const aggregate = openAggregate({message: `Errors validating between-thing references in data`});
    const boundFind = bindFind(wikiData, {mode: 'error'});
    for (const [ thingDataProp, propSpec ] of referenceSpec) {
        const thingData = getNestedProp(wikiData, thingDataProp);
        aggregate.nest({message: `Reference errors in ${color.green('wikiData.' + thingDataProp)}`}, ({ nest }) => {
            for (const thing of thingData) {
                nest({message: `Reference errors in ${inspect(thing)}`}, ({ filter }) => {
                    for (const [ property, findFnKey ] of Object.entries(propSpec)) {
                        if (!thing[property]) continue;
                        if (findFnKey === '_contrib') {
                            thing[property] = filter(thing[property],
                                decorateErrorWithIndex(({ who }) => {
                                    const alias = find.artist(who, wikiData.artistAliasData, {mode: 'quiet'});
                                    if (alias) {
                                        const original = find.artist(alias.aliasedArtistRef, wikiData.artistData, {mode: 'quiet'});
                                        throw new Error(`Reference ${color.red(who)} is to an alias, should be ${color.green(original.name)}`);
                                    }
                                    return boundFind.artist(who);
                                }),
                                {message: `Reference errors in contributions ${color.green(property)} (${color.green('find.artist')})`});
                            continue;
                        }
                        const findFn = boundFind[findFnKey];
                        const value = thing[property];
                        if (Array.isArray(value)) {
                            thing[property] = filter(value, decorateErrorWithIndex(findFn),
                                {message: `Reference errors in property ${color.green(property)} (${color.green('find.' + findFnKey)})`});
                        } else {
                            nest({message: `Reference error in property ${color.green(property)} (${color.green('find.' + findFnKey)})`}, ({ call }) => {
                                try {
                                    call(findFn, value);
                                } catch (error) {
                                    thing[property] = null;
                                    throw error;
                                }
                            });
                        }
                    }
                });
            }
        });
    }

    return aggregate;
}

// Utility function for loading all wiki data from the provided YAML data
// directory (e.g. the root of the hsmusic-data repository). This doesn't
// provide much in the way of customization; it's meant to be used more as
// a boilerplate for more specialized output, or as a quick start in utilities
// where reporting info about data loading isn't as relevant as during the
// main wiki build process.
export async function quickLoadAllFromYAML(dataPath, {
    showAggregate: customShowAggregate = showAggregate,
} = {}) {
    const showAggregate = customShowAggregate;

    let wikiData;

    {
        const { aggregate, result } = await loadAndProcessDataDocuments({
            dataPath,
        });

        wikiData = result;

        try {
            aggregate.close();
            logInfo`Loaded data without errors. (complete data)`;
        } catch (error) {
            showAggregate(error);
            logWarn`Loaded data with errors. (partial data)`;
        }
    }

    linkWikiDataArrays(wikiData);

    try {
        filterDuplicateDirectories(wikiData).close();
        logInfo`No duplicate directories found. (complete data)`;
    } catch (error) {
        showAggregate(error);
        logWarn`Duplicate directories found. (partial data)`;
    }

    try {
        filterReferenceErrors(wikiData).close();
        logInfo`No reference errors found. (complete data)`;
    } catch (error) {
        showAggregate(error);
        logWarn`Duplicate directories found. (partial data)`;
    }

    sortWikiDataArrays(wikiData);

    return wikiData;
}