Add tests for assertValidFeatureReference

Author: ddbeck

assertions.test.ts

@@ -0,0 +1,36 @@
+import assert from "node:assert/strict";
+import { assertValidFeatureReference } from "./assertions";
+
+describe("assertValidReference()", function () {
+  it("throws if target ID is a move", function () {
+    assert.throws(() => {
+      assertValidFeatureReference("a", "some-moving-feature", {
+        "some-moving-feature": { kind: "moved" },
+      });
+    });
+  });
+
+  it("throws if target ID is a split", function () {
+    assert.throws(() => {
+      assertValidFeatureReference("a", "some-split-feature", {
+        "some-split-feature": { kind: "split" },
+      });
+    });
+  });
+
+  it("throws if target ID is not defined", function () {
+    assert.throws(() => {
+      assertValidFeatureReference(
+        "a",
+        "this-is-a-completely-invalid-feature",
+        {},
+      );
+    });
+  });
+
+  it("does not throw if target ID is a feature", function () {
+    assert.doesNotThrow(() => {
+      assertValidFeatureReference("a", "dom", { dom: { kind: "feature" } });
+    });
+  });
+});

assertions.ts

@@ -0,0 +1,29 @@
+import { isOrdinaryFeatureData } from "./type-guards";
+import { WebFeaturesData } from "./types.quicktype";
+
+/**
+ * Assert that a reference from one feature to another is an ordinary feature
+ * reference (i.e., it's defined and not some kind of redirect).
+ *
+ * @export
+ * @param {string} sourceId The feature that is referencing another feature
+ * @param {string} targetId The feature being referenced
+ * @param {WebFeaturesData["features"]} features Feature data
+ */
+export function assertValidFeatureReference(
+  sourceId: string,
+  targetId: string,
+  features: WebFeaturesData["features"],
+) {
+  const target: unknown = features[targetId];
+  if (target === undefined) {
+    throw new Error(`${sourceId} references a non-existent feature`);
+  }
+  if (!isOrdinaryFeatureData(target)) {
+    throw new Error(
+      `${sourceId} references a redirect "${targetId} instead of an ordinary feature ID`,
+    );
+  }
+}
+
+// TODO: assertValidSnapshotReference

index.ts

@@ -9,6 +9,7 @@ import { GroupData, SnapshotData, WebFeaturesData } from './types';
 
 import { BASELINE_LOW_TO_HIGH_DURATION, coreBrowserSet, parseRangedDateString } from 'compute-baseline';
 import { Compat } from 'compute-baseline/browser-compat-data';
+import { assertValidFeatureReference } from './assertions';
 import { isMoved, isSplit } from './type-guards';
 
 // The longest name allowed, to allow for compact display.
@@ -191,32 +192,20 @@ for (const [key, data] of yamlEntries('features')) {
     features[key] = data;
 }
 
-// Assert that feature references are valid
-
-function assertValidReference(sourceID: string, targetID: string): void {
-    if (targetID in features) {
-        if (isMoved(features[targetID]) || isSplit(features[targetID])) {
-            throw new Error(`${sourceID} references a redirect "${targetID}" instead of an ordinary feature ID`);
-        }
-        return;
-    }
-    throw new Error(`${sourceID}'s reference to "${targetID}" is not a valid feature ID`);
-}
-
 for (const [id, feature] of Object.entries(features)) {
     const { kind } = feature;
     switch (kind) {
         case "feature":
             for (const alternative of feature.discouraged?.alternatives ?? []) {
-                assertValidReference(id, alternative);
+                assertValidFeatureReference(id, alternative, features)
             }
             break;
         case "moved":
-            assertValidReference(id, feature.redirect_target);
+            assertValidFeatureReference(id, feature.redirect_target, features);
             break;
         case "split":
             for (const target of feature.redirect_targets) {
-                assertValidReference(id, target);
+                assertValidFeatureReference(id, target, features);
             }
             break;
         default:

package-lock.json

@@ -29,11 +29,12 @@
     "test:coverage": "npm run --workspaces test:coverage",
     "test:dist": "tsx scripts/dist.ts --check",
     "test:format": "prettier --check .",
+    "test:index": "mocha -r tsx './*.test.ts'",
     "test:lint": "npx eslint .",
     "test:schematypes": "tsx scripts/schema.ts",
     "test:specs": "tsx scripts/specs.ts",
     "test:types": "npm run --workspaces test:types && tsc",
-    "test": "npm run test:caniuse -- --quiet && npm run test:schematypes && npm run test:specs && npm run test:types && npm run test:format && npm run test:dist && npm run test --workspaces && npm run test:lint",
+    "test": "npm run test:caniuse -- --quiet && npm run test:schematypes && npm run test:specs && npm run test:types && npm run test:format && npm run test:index && npm run test:dist && npm test --workspaces && npm run test:lint",
     "update-drafts": "tsx scripts/update-drafts.ts",
     "remove-tagged-compat-features": "tsx scripts/remove-tagged-compat-features.ts && npm run format"
   },
@@ -53,6 +54,7 @@
     "fast-json-stable-stringify": "^2.1.0",
     "fdir": "^6.5.0",
     "hast-util-to-string": "^3.0.1",
+    "mocha": "^11.7.2",
     "prettier": "^3.6.2",
     "quicktype": "^23.2.6",
     "rehype-parse": "^9.0.1",

package.json

@@ -28,11 +28,9 @@
   "devDependencies": {
     "@types/chai": "^5.2.2",
     "@types/chai-jest-snapshot": "^1.3.8",
-    "@types/mocha": "^10.0.10",
     "c8": "^10.1.3",
     "chai": "^6.0.1",
-    "chai-jest-snapshot": "^2.0.0",
-    "mocha": "^11.7.2"
+    "chai-jest-snapshot": "^2.0.0"
   },
   "peerDependencies": {
     "@mdn/browser-compat-data": "^7.0.0"