fix: loading of examples (#92)

* fix: loading of examples

* fix: test in GHA

Author: miparnisari

.github/workflows/test.yaml

@@ -13,6 +13,8 @@ jobs:
     runs-on: "depot-ubuntu-24.04-small"
     steps:
       - uses: "actions/checkout@v4"
+        with:
+          submodules: true
       - uses: "authzed/action-spicedb@v1"
         with:
           version: "latest"

examples

@@ -33,7 +33,6 @@
     "clsx": "^2.1.1",
     "d3-scale-chromatic": "^2.0.0",
     "dequal": "^2.0.2",
-    "es-toolkit": "^1.36.0",
     "file-saver": "^2.0.5",
     "file-select-dialog": "^1.5.4",
     "line-column": "^1.0.2",

package.json

@@ -0,0 +1,20 @@
+import { describe, it, expect } from "vitest";
+import { LoadExamples } from "./examples";
+
+describe("LoadExamples", () => {
+  it("should correctly parse and return examples and skip those that are missing files", () => {
+    const examples = LoadExamples();
+
+    expect(examples).toHaveLength(6);
+
+    examples.forEach(function (example) {
+      expect(example.id).not.toBeNull();
+      expect(example.title).not.toBeNull();
+      expect(example.subtitle).not.toBeNull();
+      expect(example.data).not.toBeNull();
+      expect(example.data.schema).not.toBeNull();
+      expect(example.data.relationships).not.toBeNull();
+      expect(example.data.assertions).not.toBeNull();
+    });
+  });
+});

src/spicedb-common/examples.test.ts

@@ -1,62 +1,71 @@
 import yaml from "yaml";
-import { sortBy, zip } from "es-toolkit";
 import { ParsedValidation } from "./validationfileformat";
 export interface Example {
   id: string;
   title: string;
-  documentation: string;
   subtitle: string;
   data: ParsedValidation;
 }
 
 const readmesImports = import.meta.glob("/examples/schemas/*/README.md", {
   // Get just the raw text
   query: "?raw",
+  eager: true,
 });
 const schemasImports = import.meta.glob(
   "/examples/schemas/*/schema-and-data.yaml",
   {
     // Get just the raw text
     query: "?raw",
+    eager: true,
   },
 );
 
 const isTextImport = (input: unknown): input is { default: string } => {
   return typeof input === "object" && input !== null && "default" in input;
 };
 
-const sortAndRealizeImports = async (
-  imports: Record<string, () => Promise<unknown>>,
-) => {
-  const realizedImports = await Promise.all(
-    sortBy(Object.entries(imports), [0]).map(([, importThunk]) =>
-      importThunk(),
-    ),
-  );
-  return realizedImports
-    .filter(isTextImport)
-    .map(({ default: defaultExport }) => defaultExport);
-};
-
 /**
- * LoadExamples loads the examples defined statically and compiled in.
+ * LoadExamples loads the examples defined statically and compiled in the /examples repo.
+ * If one example is lacking the schema file, we don't include it.
  */
-export async function LoadExamples(): Promise<Example[]> {
-  const names = Object.entries(readmesImports).map(([path]) => path);
-  names.sort();
-  const sortedReadmes = await sortAndRealizeImports(readmesImports);
-  const sortedSchemas = await sortAndRealizeImports(schemasImports);
-  const zippedImports = zip(names, sortedReadmes, sortedSchemas);
-  return zippedImports.map(([name, readme, schema]) => {
-    const lines = readme.split("\n");
-    const title = lines[0].trim().substring(1).trim(); // Strip the # for the markdown header
-    const subtitle = lines[2].trim();
-    return {
-      id: name,
-      title,
-      subtitle,
-      documentation: readme,
-      data: yaml.parse(schema),
-    };
-  });
+export function LoadExamples(): Example[] {
+  return Object.keys(readmesImports)
+    .map((path) => {
+      // Grab the id
+      const match = path.match(/\/examples\/schemas\/(.*)\/README\.md/);
+      return match ? match[1] : "";
+    })
+    .filter((name): name is string => {
+      if (name === "") return false;
+      // Skip examples that don't have the schema file
+      const schemaPath = `/examples/schemas/${name}/schema-and-data.yaml`;
+      return schemaPath in schemasImports;
+    })
+    .sort()
+    .map((name) => {
+      const readmeModule =
+        readmesImports[`/examples/schemas/${name}/README.md`];
+      const schemaModule =
+        schemasImports[`/examples/schemas/${name}/schema-and-data.yaml`];
+
+      const readme = isTextImport(readmeModule) ? readmeModule.default : "";
+      const schema = isTextImport(schemaModule) ? schemaModule.default : "";
+
+      const lines = readme.split("\n");
+      const title = lines[0].trim().substring(1).trim(); // Strip the # for the markdown header
+      const subtitle = lines[2].trim();
+      let schemaRes: ParsedValidation;
+      try {
+        schemaRes = yaml.parse(schema);
+      } catch (e) {
+        throw new Error("error parsing schema for example " + name + ": " + e);
+      }
+      return {
+        id: name,
+        title: title,
+        subtitle: subtitle,
+        data: schemaRes,
+      };
+    });
 }

src/spicedb-common/examples.ts

@@ -4833,11 +4833,6 @@ es-to-primitive@^1.3.0:
     is-date-object "^1.0.5"
     is-symbol "^1.0.4"
 
-es-toolkit@^1.36.0:
-  version "1.36.0"
-  resolved "https://registry.yarnpkg.com/es-toolkit/-/es-toolkit-1.36.0.tgz#98a9ddba346cde1aeca099f9bc27c05838c68b9a"
-  integrity sha512-5lpkRpDELuTSeAL//Rcg5urg+K/yOD1BobJSiNeCc89snMqgrhckmj8jdljqraDbpREiXTNW311RN518eVHBng==
-
 [email protected]:
   version "0.14.47"
   resolved "https://registry.yarnpkg.com/esbuild-android-64/-/esbuild-android-64-0.14.47.tgz#ef95b42c67bcf4268c869153fa3ad1466c4cea6b"