Fixture redirects (#484)

* move M-Carré to IVL Carré
* allow fixture redirects
  including schema, tests and UI
* add redirect from minuit-une/m-carre to minuit-une/ivl-carre
* improve code readability, reduce complexity in fixture test
  (cherrypicked from #425)

Author: FloEdelmann

cli/make-register.js

@@ -36,11 +36,27 @@ try {
       }
 
       for (const filename of fs.readdirSync(manDir).sort()) {
-        const ext = path.extname(filename);
-        if (ext === `.json`) {
-          const fixKey = path.basename(filename, ext);
-          const fixData = JSON.parse(fs.readFileSync(path.join(fixturePath, manKey, filename), `utf8`));
+        if (path.extname(filename) !== `.json`) {
+          continue;
+        }
+
+        const fixKey = path.basename(filename, `.json`);
+        const fixData = JSON.parse(fs.readFileSync(path.join(fixturePath, manKey, filename), `utf8`));
+        let isRedirect = false;
+        let redirectToData = null;
+
+        if (fixData.$schema.endsWith(`/fixture-redirect.json`)) {
+          isRedirect = true;
+          redirectToData = JSON.parse(fs.readFileSync(path.join(fixturePath, `${fixData.redirectTo}.json`), `utf8`));
 
+          // add to filesystem register
+          register.filesystem[`${manKey}/${fixKey}`] = {
+            name: fixData.name,
+            redirectTo: fixData.redirectTo,
+            reason: fixData.reason
+          };
+        }
+        else {
           let lastAction = `modified`;
           if (fixData.meta.lastModifyDate === fixData.meta.createDate) {
             lastAction = `created`;
@@ -55,30 +71,34 @@ try {
             lastModifyDate: fixData.meta.lastModifyDate,
             lastAction: lastAction
           };
+        }
 
+        if (!isRedirect || fixData.reason === `SameAsDifferentBrand`) {
           // add to manufacturer register
           register.manufacturers[manKey].push(fixKey);
 
           // add to category register
-          for (const cat of fixData.categories) {
+          for (const cat of fixData.categories || redirectToData.categories) {
             if (!(cat in categories)) {
               categories[cat] = [];
             }
             categories[cat].push(`${manKey}/${fixKey}`);
           }
+        }
 
-          // add to contributor register
+        // add to contributor register
+        if (!isRedirect) {
           for (const contributor of fixData.meta.authors) {
             if (!(contributor in contributors)) {
               contributors[contributor] = [];
             }
             contributors[contributor].push(`${manKey}/${fixKey}`);
           }
+        }
 
-          // add to rdm register
-          if (`rdm` in fixData) {
-            rdm[manufacturers[manKey].rdmId].models[fixData.rdm.modelId] = fixKey;
-          }
+        // add to rdm register
+        if (`rdm` in fixData) {
+          rdm[manufacturers[manKey].rdmId].models[fixData.rdm.modelId] = fixKey;
         }
       }
     }
@@ -112,7 +132,9 @@ const lastActionRankMapping = {
 };
 
 // add fixture list sorted by lastModifyDate
-register.lastUpdated = Object.keys(register.filesystem).sort((a, b) => {
+register.lastUpdated = Object.keys(register.filesystem).filter(
+  fixtureKey => `lastModifyDate` in register.filesystem[fixtureKey]
+).sort((a, b) => {
   const fixA = register.filesystem[a];
   const fixB = register.filesystem[b];
   const dateDelta = new Date(fixB.lastModifyDate) - new Date(fixA.lastModifyDate);

docs/fixture-format.md

@@ -19,6 +19,7 @@ This document gives a high-level overview of the concepts used in the JSON forma
     - [Matrix structure](#matrix-structure)
     - [Template channels](#template-channels)
   - [RDM (Remote Device Management) data](#rdm-remote-device-management-data)
+- [Fixture redirects](#fixture-redirects)
 
 
 ## Schema
@@ -214,9 +215,15 @@ Then, either use the resolved channel keys directly in a mode's channel list, or
   - For the above [matrix structure](#matrix-structure) example, this results in `["Inner ring", "Middle ring", "Outer ring"]`.
 
 
-
 ### RDM (Remote Device Management) data
 
 We link to [Open Lighting's RDM database](http://rdm.openlighting.org) if possible. Thus, we need to specify the RDM manufacturer ID per manufacturer and the RDM model ID per fixture. Additionally, each mode is mapped to the respective RDM personality via the `rdmPersonalityIndex` property. To ensure compatibility, we also track, for which RDM fixture software (firmware) version the mode indices are specified.
 
 If RDM manufacturer and model ID are known, we open the respective fixture page when going to `/rdm` (handled in [`main.js`](../main.js) and `views/pages/rdm-*.js`).
+
+
+## Fixture redirects
+
+Fixtures may be renamed by their manufacturers. If we would just update the fixture definition, links to its old fixture page would now lead to a *404 Not found* error. Instead, we add a fixture redirect JSON file (see [its schema](../schemas/fixture-redirect.json)) with the old manufacturer / fixture key, pointing to the updated fixture definition. See [Minuit Une M-Carré](../fixtures/minuit-une/m-carre.json) (and its [fixture page on OFL](https://open-fixture-library.org/minuit-une/m-carre)) as an example.
+
+Another use case for redirects are fixtures that are sold under different brands, but which are technically the same. We add them to the library only once and let redirects with other names point to it.