Fix doc refs to things with definitions

systeminit · Feb 20, 2025 · 2282328 · 2282328
1 parent a3bcdbd
commit 2282328
Show file tree

Hide file tree

Showing 7 changed files with 127 additions and 70 deletions.
diff --git a/bin/clover/src/cfDb.ts b/bin/clover/src/cfDb.ts
@@ -77,6 +77,7 @@ type CfMultiTypeProperty =
   & {
     type?: undefined;
     oneOf?: CfProperty[];
+    allOf?: CfProperty[];
     anyOf?: CfProperty[];
   };
 
@@ -315,37 +316,60 @@ export async function loadCfDatabase(
 ): Promise<CfDb> {
   path ??= DEFAULT_PATH;
   if (Object.keys(DB).length === 0) {
-    for (const data of await readSpecs(path)) {
-      const typeName: string = data.typeName;
+    for (const cfSchema of await readSchemas(path)) {
+      const typeName: string = cfSchema.typeName;
 
       if (services && !services.some((service) => typeName.match(service))) {
         continue;
       }
 
       logger.debug(`Loaded ${typeName}`);
 
-      try {
-        const expandedSchema = await $RefParser.dereference(data, {
-          dereference: {
-            circular: "ignore",
-            onDereference: (path: string, ref: JSONSchema.Object) => {
-              const name = path.split("/").pop();
-              ref.title = ref.title ?? name;
-            },
-          },
-        }) as CfSchema;
-        DB[typeName] = expandedSchema;
-      } catch (e) {
-        logger.error(`failed to expand ${typeName}`, e);
-        DB[typeName] = data;
+      // Mark all definition props with their enclosing name for doc link generation
+      if (cfSchema.definitions) {
+        for (const [defName, defProp] of Object.entries(cfSchema.definitions)) {
+          for (const cfProp of nestedCfProps(defProp)) {
+            (cfProp as { defName?: string }).defName = defName;
+          }
+        }
       }
+
+      // Dereference the schema
+      const dereferencedSchema = await $RefParser.dereference(cfSchema, {
+        dereference: {
+          circular: "ignore",
+          onDereference: (path: string, ref: JSONSchema.Object) => {
+            const name = path.split("/").pop();
+            ref.title = ref.title ?? name;
+          },
+        },
+      }) as CfSchema;
+      DB[typeName] = dereferencedSchema;
     }
   }
 
   return DB;
 }
 
-async function readSpecs(path: string) {
+function* nestedCfProps(prop: CfProperty): Generator<CfProperty> {
+  yield prop;
+  for (const p of prop.anyOf ?? []) yield* nestedCfProps(p as CfProperty);
+  for (const p of prop.oneOf ?? []) yield* nestedCfProps(p as CfProperty);
+  for (const p of prop.allOf ?? []) yield* nestedCfProps(p as CfProperty);
+  if ("properties" in prop) {
+    for (const p of Object.values(prop.properties ?? {})) {
+      yield* nestedCfProps(p as CfProperty);
+    }
+  }
+  if ("patternProperties" in prop) {
+    for (const p of Object.values(prop.patternProperties ?? {})) {
+      yield* nestedCfProps(p as CfProperty);
+    }
+  }
+  if ("items" in prop) yield* nestedCfProps(prop.items as CfProperty);
+}
+
+async function readSchemas(path: string): Promise<CfSchema[]> {
   const fullPath = await Deno.realPath(path);
   logger.debug("Loading database from Cloudformation schema", { fullPath });
   const result = [];

diff --git a/bin/clover/src/commands/generateSiSpecs.ts b/bin/clover/src/commands/generateSiSpecs.ts
@@ -30,6 +30,8 @@ import { PkgSpec } from "../bindings/PkgSpec.ts";
 import { ignoreSpecsWithoutHandlers } from "../pipeline-steps/ignoreSpecsWithoutHandlers.ts";
 import { SchemaVariantSpec } from "../bindings/SchemaVariantSpec.ts";
 import { SchemaSpec } from "../bindings/SchemaSpec.ts";
+import { bfsPropTree, ExpandedPropSpec } from "../spec/props.ts";
+import { PropSpec } from "../bindings/PropSpec.ts";
 
 const logger = _logger.ns("siSpecs").seal();
 const SI_SPEC_DIR = "si-specs";
@@ -135,9 +137,24 @@ function unexpandSchema(
     variants: expanded.variants.map(unexpandVariant),
   };
 }
+
 function unexpandVariant(
   expanded: ExpandedSchemaVariantSpec,
 ): SchemaVariantSpec {
   const { cfSchema: _, ...variant } = expanded;
+  bfsPropTree([
+    variant.domain,
+    variant.resourceValue,
+    variant.secrets,
+    variant.secretDefinition,
+  ], unexpandProperty);
   return variant;
 }
+
+function unexpandProperty(expanded: ExpandedPropSpec): PropSpec {
+  const deleteable = expanded as Partial<ExpandedPropSpec>;
+  delete deleteable.metadata;
+  delete deleteable.joiValidation;
+  delete deleteable.cfProp;
+  return expanded;
+}
diff --git a/bin/clover/src/pipeline-steps/addDefaultPropsAndSockets.ts b/bin/clover/src/pipeline-steps/addDefaultPropsAndSockets.ts
@@ -18,7 +18,11 @@ export function addDefaultPropsAndSockets(
     const { domain } = schemaVariant;
 
     // Extra prop
-    const extraProp = createObjectProp("extra", domain.metadata.propPath);
+    const extraProp = createObjectProp(
+      "extra",
+      domain.metadata.propPath,
+      undefined,
+    );
 
     // Create PropUsageMap
     {

diff --git a/bin/clover/src/pipeline-steps/generateAssetFuncs.ts b/bin/clover/src/pipeline-steps/generateAssetFuncs.ts
@@ -268,9 +268,6 @@ function generatePropBuilderString(
       ) +
       inner +
       `${indent(indent_level)}.build()`;
-    // Now that we've emitted it, we don't need prop.joiValidation anymore. Don't bother
-    // putting it in the spec (we already have validationFormat).
-    delete prop.joiValidation;
     return result;
   }
 }

diff --git a/bin/clover/src/pipeline-steps/generateSubAssets.ts b/bin/clover/src/pipeline-steps/generateSubAssets.ts
@@ -91,9 +91,9 @@ export function generateSubAssets(
           actionFuncs: [],
           leafFunctions: [],
           managementFuncs: [],
-          resourceValue: createDefaultProp("resource_value"),
+          resourceValue: createDefaultProp("resource_value", undefined),
           sockets: [newSpecOutputSocket],
-          secrets: createDefaultProp("secrets"),
+          secrets: createDefaultProp("secrets", undefined),
           uniqueId: variantId,
         };