@superblocksteam/sdk 2.0.6-next.2 → 2.0.6-next.21

package/src/vite-plugin-generate-build-manifest.mts

@@ -0,0 +1,193 @@
+import path from "node:path";
+import { parse } from "@babel/parser";
+import { getClientApiId } from "@superblocksteam/library-shared";
+import { resolveLanguageSpecificStepContentFromBlocks } from "@superblocksteam/util";
+import { getPageName } from "@superblocksteam/vite-plugin-file-sync";
+import {
+  extractIdentifierPathsFromApi,
+  extractApiDependencies,
+} from "@superblocksteam/vite-plugin-file-sync/binding-extraction";
+import {
+  getScope,
+  extractImportsFromAst,
+} from "@superblocksteam/vite-plugin-file-sync/parsing";
+import { yellow, red } from "colorette";
+import fg from "fast-glob";
+import fs from "fs-extra";
+import { createLogger } from "vite";
+import yaml from "yaml";
+import { getLogger } from "./dev-utils/dev-logger.mjs";
+import type { ParseResult } from "@babel/parser";
+import type { File } from "@babel/types";
+import type {
+  DeleteMeLibraryApi,
+  StaticScope,
+} from "@superblocksteam/library-shared/types";
+import type { Plugin } from "vite";
+
+export const scopeFileBaseName = "scope.ts";
+export const apiFileBaseName = "api.yaml";
+
+type ApiDependency = {
+  apiName: string;
+  params: string[];
+  dependencies: string[];
+};
+
+/**
+ * Vite plugin that generates a build manifest for the application.
+ *
+ * This plugin will:
+ * 1. Read all api.yaml and api.yml files in the application
+ * 2. Read all scope.ts files in the application
+ * 3. Generate a build manifest for the application
+ * 4. Write the build manifest to a file in the build output directory
+ *
+ * The build manifest is a JSON object with the following properties:
+ * - apis: a map of all apis in the application keyed by their file path
+ * - apiDependencies: an array where each item represents an api and its dependencies
+ *
+ * @param root - The root directory of the application
+ * @returns A Vite plugin that generates a build manifest for the application
+ */
+export function generateBuildManifestPlugin(root: string) {
+  const viteLogger = createLogger();
+  const logger = getLogger();
+  viteLogger.info = logger.info;
+  viteLogger.warn = (msg: string) => {
+    logger.warn(yellow(msg));
+  };
+  viteLogger.warnOnce = (msg: string) => {
+    logger.warn(yellow(msg));
+  };
+  viteLogger.error = (msg: string) => {
+    logger.error(red(msg));
+  };
+
+  viteLogger.clearScreen = () => {};
+
+  const scopesByPage: Record<string, StaticScope | null> = {};
+  const apiFiles: Record<string, DeleteMeLibraryApi> = {};
+  let buildManifest: {
+    apis: Record<string, { api: DeleteMeLibraryApi; scopeId: string }>;
+    apiDependencies: ApiDependency[];
+  } = { apis: {}, apiDependencies: [] };
+
+  return {
+    name: "sb-generate-build-manifest",
+    apply: "build",
+    enforce: "pre",
+
+    async buildStart() {
+      const apiDocuments = await fg(["**/api.yaml", "**/api.yml"], {
+        cwd: root,
+      });
+
+      for (const apiFilePath of apiDocuments) {
+        const absoluteApiFilePath = path.join(root, apiFilePath);
+
+        const document = await fs.readFile(absoluteApiFilePath, "utf-8");
+        const apiPb = yaml.parse(document);
+
+        await resolveLanguageSpecificStepContentFromBlocks(
+          path.dirname(absoluteApiFilePath),
+          apiPb.blocks ?? [],
+          {},
+        );
+
+        const pageName = getPageName(apiFilePath);
+        apiPb.metadata.id = getClientApiId(apiPb.metadata.name, pageName);
+        apiFiles[apiFilePath] = { apiPb, pageName };
+      }
+    },
+
+    transform(code: string, id: string) {
+      if (id.endsWith(scopeFileBaseName)) {
+        const ast = parse(code, {
+          sourceType: "module",
+          sourceFilename: id,
+          plugins: [["typescript", {}]],
+        });
+
+        const scopeFileMeta: {
+          code: string;
+          ast: ParseResult<File>;
+          imports: Record<string, boolean>;
+        } = {
+          code,
+          ast,
+          imports: extractImportsFromAst(ast),
+        };
+        const scope = getScope(id, scopeFileMeta);
+
+        scopesByPage[getPageName(id)] = scope;
+      }
+
+      return code;
+    },
+
+    async generateBundle() {
+      const allApiNames = getAllUniqueApiNames(apiFiles);
+
+      const allApis = Object.entries(apiFiles).reduce(
+        (acc, [id, api]) => {
+          acc[id] = {
+            api,
+            scopeId: scopesByPage[api.pageName]?.scopeId ?? "",
+          };
+          return acc;
+        },
+        {} as Record<string, { api: DeleteMeLibraryApi; scopeId: string }>,
+      );
+
+      const deps = await getApiDependencies(allApiNames, apiFiles);
+
+      buildManifest = {
+        apis: allApis,
+        apiDependencies: deps,
+      };
+
+      this.emitFile({
+        type: "prebuilt-chunk",
+        fileName: "assets/build-manifest.js",
+        code: `export default ${JSON.stringify(buildManifest)}`,
+        exports: ["default"],
+      });
+    },
+  } as Plugin;
+}
+
+function getAllUniqueApiNames(
+  apiFiles: Record<string, DeleteMeLibraryApi>,
+): string[] {
+  const allApiNamesSet = new Set<string>(
+    Object.values(apiFiles).map((api) => api.apiPb.metadata.name),
+  );
+  return Array.from(allApiNamesSet);
+}
+
+async function getApiDependencies(
+  apiNames: string[],
+  apiFiles: Record<string, DeleteMeLibraryApi>,
+): Promise<ApiDependency[]> {
+  const deps: ApiDependency[] = [];
+
+  // TODO: This logic is a copy of the extractApiParamsAndDependencies function in the
+  // fileSyncVitePlugin (https://github.com/superblocksteam/superblocks/blob/474c0b11d79a1d6988864fb20d5ec26f92931fde/packages/vite-plugin-file-sync/src/file-sync-vite-plugin.ts#L261-L280).
+  //
+  // This logic should be refactored so that it can be shared between the two plugins.
+  await Promise.all([
+    ...Object.values(apiFiles).map(async (api) => {
+      const bindings = await extractIdentifierPathsFromApi(api);
+      const allIdentifiers = bindings.flatMap((binding) => binding.bindings);
+      const apiDependencies = extractApiDependencies(apiNames, bindings);
+      deps.push({
+        apiName: api.apiPb.metadata.name,
+        params: allIdentifiers,
+        dependencies: apiDependencies,
+      });
+    }),
+  ]);
+
+  return deps;
+}