@storm-software/cloudflare-tools 0.58.2 → 0.59.0

package/index.ts

@@ -1,4 +0,0 @@
-export * from "./executors";
-export * from "./generators";
-export * from "./src/plugins";
-export * from "./src/utils";

package/project.json

@@ -1,56 +0,0 @@
-{
-  "name": "cloudflare-tools",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/cloudflare-tools/src",
-  "projectType": "library",
-  "targets": {
-    "build-untyped": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["clean", "^build"],
-      "inputs": [
-        "{projectRoot}/src/**/untyped.ts",
-        "{projectRoot}/src/**/*.untyped.ts"
-      ],
-      "outputs": [
-        "{projectRoot}/src/**/schema.d.ts",
-        "{projectRoot}/src/**/*.schema.d.ts",
-        "{projectRoot}/src/**/schema.md",
-        "{projectRoot}/src/**/*.schema.md",
-        "{projectRoot}/src/**/schema.json",
-        "{projectRoot}/src/**/*.schema.json"
-      ],
-      "options": {
-        "commands": [
-          "node dist/packages/untyped/bin/untyped.cjs generate --entry=\"packages/cloudflare-tools/**/{untyped.ts,*.untyped.ts}\" "
-        ]
-      }
-    },
-    "build-base": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["build-untyped", "clean", "^build"],
-      "options": {
-        "command": "tsup-node --config=tsup.config.ts",
-        "cwd": "{projectRoot}"
-      }
-    },
-    "build": {
-      "executor": "nx:run-commands",
-      "dependsOn": ["build-base", "build-untyped"],
-      "options": {
-        "commands": [
-          "pnpm copyfiles LICENSE dist/packages/cloudflare-tools",
-          "pnpm copyfiles --up=2 ./packages/cloudflare-tools/*.md ./packages/cloudflare-tools/executors.json ./packages/cloudflare-tools/generators.json ./packages/cloudflare-tools/package.json dist/packages/cloudflare-tools",
-          "pnpm copyfiles --up=3 \"./packages/cloudflare-tools/dist/**/*\" dist/packages/cloudflare-tools/dist",
-          "pnpm copyfiles --up=3 \"./packages/cloudflare-tools/src/**/*schema.d.ts\" dist/packages/cloudflare-tools/dist/src",
-          "pnpm copyfiles --up=3 \"./packages/cloudflare-tools/src/**/*schema.json\" dist/packages/cloudflare-tools/dist/src",
-          "pnpm copyfiles --up=3 \"./packages/cloudflare-tools/src/**/*.md\" dist/packages/cloudflare-tools/docs/api",
-          "pnpm copyfiles --up=4 \"./packages/cloudflare-tools/src/generators/*/files/**/*\" dist/packages/cloudflare-tools/dist/src/generators"
-        ]
-      }
-    },
-    "nx-release-publish": {
-      "executor": "@storm-software/workspace-tools:npm-publish"
-    }
-  },
-  "implicitDependencies": ["workspace-tools", "config-tools", "config"]
-}

package/src/executors/cloudflare-publish/executor.ts

@@ -1,100 +0,0 @@
-import { joinPathFragments, type ExecutorContext } from "@nx/devkit";
-import { createCliOptions } from "@storm-software/workspace-tools";
-import { fork } from "node:child_process";
-import type { CloudflarePublishExecutorSchema } from "./schema";
-
-export default async function runExecutor(
-  options: CloudflarePublishExecutorSchema,
-  context: ExecutorContext,
-) {
-  /**
-   * We need to check both the env var and the option because the executor may have been triggered
-   * indirectly via dependsOn, in which case the env var will be set, but the option will not.
-   */
-  const isDryRun = process.env.NX_DRY_RUN === "true" || options.dryRun || false;
-
-  if (!context.projectName) {
-    throw new Error("The executor requires a projectName.");
-  }
-
-  console.info(
-    `🚀  Running Storm Cloudflare Publish executor on the ${context.projectName} worker`,
-  );
-
-  if (
-    !context.projectName ||
-    !context.projectsConfigurations?.projects ||
-    !context.projectsConfigurations.projects[context.projectName] ||
-    !context.projectsConfigurations.projects[context.projectName]?.root
-  ) {
-    throw new Error("The executor requires projectsConfigurations.");
-  }
-
-  const packageRoot = joinPathFragments(
-    context.root,
-    context.projectsConfigurations.projects[context.projectName]
-      ?.root as string,
-  );
-
-  try {
-    const args = createCliOptions({ ...options });
-    if (isDryRun) {
-      args.push("--dry-run");
-    }
-
-    console.log("");
-    console.log(`Running "wrangler deploy ${args.join(" ")}"...`);
-    console.log("");
-
-    let proc;
-    try {
-      fork(require.resolve("wrangler/bin/wrangler"), ["deploy", ...args], {
-        env: {
-          CLOUDFLARE_ACCOUNT_ID: process.env.STORM_BOT_CLOUDFLARE_ACCOUNT,
-          CLOUDFLARE_API_TOKEN: process.env.STORM_BOT_CLOUDFLARE_TOKEN,
-          WRANGLER_LOG: "debug",
-          ...process.env,
-          FORCE_COLOR: "true",
-        },
-        cwd: packageRoot,
-        stdio: ["pipe", "pipe", "pipe", "ipc"],
-      });
-    } catch (e) {
-      console.error(e);
-      throw new Error(
-        "Unable to run Wrangler. Please ensure Wrangler is installed.",
-      );
-    }
-
-    proc?.stdout?.on("data", (message) => {
-      process.stdout.write(message);
-    });
-    proc?.stderr?.on("data", (message) => {
-      process.stderr.write(message);
-    });
-
-    return new Promise<{ success: boolean }>((resolve) => {
-      proc?.on("close", (code) => {
-        console.log("");
-
-        if (isDryRun) {
-          console.log(
-            "Would publish to Cloudflare Workers Registry, but [dry-run] was set",
-          );
-        } else {
-          console.log("Published to Cloudflare Workers Registry");
-        }
-
-        return resolve({ success: code === 0 });
-      });
-    });
-  } catch (error: any) {
-    console.error("Failed to publish to Cloudflare Workers Registry");
-    console.error(error);
-    console.log("");
-
-    return {
-      success: false,
-    };
-  }
-}

package/src/executors/r2-upload-publish/executor.ts

@@ -1,264 +0,0 @@
-import { S3 } from "@aws-sdk/client-s3";
-import {
-  createProjectGraphAsync,
-  joinPathFragments,
-  ProjectGraph,
-  readCachedProjectGraph,
-  type ExecutorContext
-} from "@nx/devkit";
-import {
-  getConfig,
-  writeDebug,
-  writeInfo,
-  writeSuccess,
-  writeWarning
-} from "@storm-software/config-tools";
-import { findWorkspaceRoot } from "@storm-software/config-tools/utilities/find-workspace-root";
-import { createCliOptions } from "@storm-software/workspace-tools/utils/create-cli-options";
-import { getPackageInfo } from "@storm-software/workspace-tools/utils/package-helpers";
-import { glob } from "glob";
-import { execSync } from "node:child_process";
-import { readFile } from "node:fs/promises";
-import {
-  getInternalDependencies,
-  r2UploadFile
-} from "../../utils/r2-bucket-helpers";
-import type { R2UploadPublishExecutorSchema } from "./schema";
-
-export default async function runExecutor(
-  options: R2UploadPublishExecutorSchema,
-  context: ExecutorContext
-) {
-  /**
-   * We need to check both the env var and the option because the executor may have been triggered
-   * indirectly via dependsOn, in which case the env var will be set, but the option will not.
-   */
-  const isDryRun = process.env.NX_DRY_RUN === "true" || options.dryRun || false;
-
-  if (!context.projectName) {
-    throw new Error("The executor requires a projectName.");
-  }
-
-  console.info(
-    `🚀  Running Storm Cloudflare Publish executor on the ${context.projectName} worker`
-  );
-
-  if (
-    !context.projectName ||
-    !context.projectsConfigurations?.projects ||
-    !context.projectsConfigurations.projects[context.projectName] ||
-    !context.projectsConfigurations.projects[context.projectName]?.root
-  ) {
-    throw new Error("The executor requires projectsConfigurations.");
-  }
-
-  try {
-    const workspaceRoot = findWorkspaceRoot();
-    const config = await getConfig(workspaceRoot);
-
-    const sourceRoot =
-      context.projectsConfigurations.projects[context.projectName]
-        ?.sourceRoot ?? workspaceRoot;
-    const projectName =
-      context.projectsConfigurations.projects[context.projectName]?.name ??
-      context.projectName;
-
-    const projectDetails = getPackageInfo(
-      context.projectsConfigurations.projects[context.projectName]!
-    );
-    if (!projectDetails?.content) {
-      throw new Error(
-        `Could not find the project details for ${context.projectName}`
-      );
-    }
-
-    const args = createCliOptions({ ...options });
-    if (isDryRun) {
-      args.push("--dry-run");
-    }
-
-    const cloudflareAccountId = process.env.STORM_BOT_CLOUDFLARE_ACCOUNT;
-    if (!options?.registry && !cloudflareAccountId) {
-      throw new Error(
-        "The Storm Registry URL is not set in the Storm config. Please set either the `extensions.cyclone.registry` or `config.extensions.cyclone.accountId` property in the Storm config."
-      );
-    }
-
-    if (!process.env.AWS_ACCESS_KEY_ID || !process.env.AWS_SECRET_ACCESS_KEY) {
-      throw new Error(
-        "The AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables are not set. Please set these environment variables to upload to the Cyclone Registry."
-      );
-    }
-
-    const endpoint = options?.registry
-      ? options.registry
-      : `https://${cloudflareAccountId}.r2.cloudflarestorage.com`;
-
-    let projectGraph!: ProjectGraph;
-    try {
-      projectGraph = readCachedProjectGraph();
-    } catch {
-      await createProjectGraphAsync();
-      projectGraph = readCachedProjectGraph();
-    }
-
-    if (!projectGraph) {
-      throw new Error(
-        "The executor failed because the project graph is not available. Please run the build command again."
-      );
-    }
-
-    writeInfo(
-      `Publishing ${context.projectName} to the Storm Registry at ${endpoint}`
-    );
-
-    const s3Client = new S3({
-      region: "auto",
-      endpoint,
-      credentials: {
-        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
-        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
-      }
-    });
-
-    const version = projectDetails.content?.version;
-    writeInfo(`Generated component version: ${version}`);
-
-    const files = await glob(joinPathFragments(sourceRoot, "**/*"), {
-      ignore: "**/{*.stories.tsx,*.stories.ts,*.spec.tsx,*.spec.ts}"
-    });
-    const projectPath = `registry/${context.projectName}`;
-
-    const internalDependencies = await getInternalDependencies(
-      context.projectName,
-      projectGraph as ProjectGraph
-    );
-
-    const dependencies = internalDependencies
-      .filter(
-        projectNode =>
-          !projectNode.data.tags ||
-          projectNode.data.tags.every(tag => tag.toLowerCase() !== "component")
-      )
-      .reduce((ret, dep) => {
-        if (!ret[dep.name]) {
-          ret[dep.name] = "latest";
-        }
-
-        return ret;
-      }, projectDetails.content.dependencies ?? {});
-
-    const release =
-      options.tag ?? execSync("npm config get tag").toString().trim();
-
-    writeInfo(`Clearing out existing items in ${projectPath}`);
-
-    if (!isDryRun) {
-      const response = await s3Client.listObjects({
-        Bucket: options.bucketId,
-        Prefix: projectPath
-      });
-
-      if (response?.Contents && response.Contents.length > 0) {
-        writeDebug(
-          `Deleting the following existing items from the component registry: ${response.Contents.map(item => item.Key).join(", ")}`
-        );
-
-        await Promise.all(
-          response.Contents.map(item =>
-            s3Client.deleteObjects({
-              Bucket: options.bucketId,
-              Delete: {
-                Objects: [
-                  {
-                    Key: item.Key
-                  }
-                ],
-                Quiet: false
-              }
-            })
-          )
-        );
-      } else {
-        writeDebug(
-          `No existing items to delete in the component registry path ${projectPath}`
-        );
-      }
-    } else {
-      writeWarning("[Dry run]: skipping upload to the Cyclone Registry.");
-    }
-
-    const meta = {
-      name: context.projectName,
-      version,
-      release,
-      description: projectDetails.content.description,
-      tags: projectDetails.content.keywords,
-      dependencies,
-      devDependencies: null,
-      internalDependencies: internalDependencies
-        .filter(
-          projectNode =>
-            projectNode.data.tags &&
-            projectNode.data.tags.some(tag => tag.toLowerCase() === "component")
-        )
-        .map(dep => dep.name)
-    };
-    if (projectDetails.type === "package.json") {
-      meta.devDependencies = projectDetails.content.devDependencies;
-    }
-
-    const metaJson = JSON.stringify(meta);
-
-    writeInfo(`Generating meta.json file: \n${metaJson}`);
-
-    await r2UploadFile(
-      s3Client,
-      options.bucketId,
-      projectPath,
-      "meta.json",
-      version,
-      metaJson,
-      "application/json",
-      isDryRun
-    );
-
-    await Promise.all(
-      files.map(file => {
-        const fileName = file
-          .replaceAll("\\", "/")
-          .replace(sourceRoot.replaceAll("\\", "/"), "");
-
-        return readFile(file, { encoding: "utf8" }).then(fileContent =>
-          r2UploadFile(
-            s3Client,
-            options.bucketId,
-            projectPath,
-            fileName,
-            version,
-            fileContent,
-            "text/plain",
-            isDryRun
-          )
-        );
-      })
-    );
-
-    writeSuccess(
-      `Successfully uploaded the ${projectName} component to the Cyclone Registry`,
-      config
-    );
-
-    return {
-      success: true
-    };
-  } catch (error: any) {
-    console.error("Failed to publish to Cloudflare Workers Registry");
-    console.error(error);
-    console.log("");
-
-    return {
-      success: false
-    };
-  }
-}

package/src/executors/serve/executor.ts

@@ -1,84 +0,0 @@
-import type { ExecutorContext, PromiseExecutor } from "@nx/devkit";
-import { createAsyncIterable } from "@nx/devkit/src/utils/async-iterable";
-import { waitForPortOpen } from "@nx/web/src/utils/wait-for-port-open";
-import type { StormWorkspaceConfig } from "@storm-software/config";
-import {
-  createCliOptions,
-  withRunExecutor
-} from "@storm-software/workspace-tools";
-import { fork } from "child_process";
-import { ServeExecutorSchema } from "./schema";
-
-export async function* serveExecutor(
-  options: ServeExecutorSchema,
-  context: ExecutorContext,
-  config?: StormWorkspaceConfig
-) {
-  if (
-    !context?.projectName ||
-    !context?.projectsConfigurations?.projects?.[context.projectName]?.root
-  ) {
-    throw new Error("Nx executor context was invalid");
-  }
-
-  const projectRoot =
-    context!.projectsConfigurations!.projects[context.projectName!]!.root;
-
-  const wranglerOptions = createCliOptions({ ...options });
-  const wranglerBin = require.resolve("wrangler/bin/wrangler");
-
-  yield* createAsyncIterable<{ success: boolean; baseUrl: string }>(
-    async ({ done, next, error }) => {
-      process.env.PWD = projectRoot;
-      const server = fork(wranglerBin, ["dev", ...wranglerOptions], {
-        cwd: projectRoot,
-        stdio: "inherit"
-      });
-
-      server.once("exit", code => {
-        if (code === 0) {
-          done();
-        } else {
-          error(new Error(`Cloudflare worker exited with code ${code}`));
-        }
-      });
-
-      const killServer = () => {
-        if (server.connected) {
-          server.kill("SIGTERM");
-        }
-      };
-
-      process.on("exit", () => killServer());
-      process.on("SIGINT", () => killServer());
-      process.on("SIGTERM", () => killServer());
-      process.on("SIGHUP", () => killServer());
-
-      await waitForPortOpen(options.port ?? 4500);
-
-      next({
-        success: true,
-        baseUrl: `http://localhost:${options.port}`
-      });
-    }
-  );
-
-  return {
-    success: true
-  };
-}
-
-export default withRunExecutor<ServeExecutorSchema>(
-  "Cloudflare Serve executor",
-  serveExecutor,
-  {
-    skipReadingConfig: false,
-    hooks: {
-      applyDefaultOptions: (options: ServeExecutorSchema) => {
-        options.port ??= 4500;
-
-        return options as ServeExecutorSchema;
-      }
-    }
-  }
-) as PromiseExecutor<ServeExecutorSchema>;

package/src/generators/init/generator.spec.ts

@@ -1,20 +0,0 @@
-import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
-import { Tree, readProjectConfiguration } from "@nx/devkit";
-
-import { initGenerator } from "./generator";
-import { InitGeneratorSchema } from "./schema";
-
-describe("init generator", () => {
-  let tree: Tree;
-  const options: InitGeneratorSchema = { name: "test" };
-
-  beforeEach(() => {
-    tree = createTreeWithEmptyWorkspace();
-  });
-
-  it("should run successfully", async () => {
-    await initGenerator(tree, options);
-    const config = readProjectConfiguration(tree, "test");
-    expect(config).toBeDefined();
-  });
-});

package/src/generators/init/generator.ts

@@ -1,60 +0,0 @@
-import {
-  addDependenciesToPackageJson,
-  convertNxGenerator,
-  formatFiles,
-  removeDependenciesFromPackageJson,
-  Tree,
-} from "@nx/devkit";
-import { initGenerator as nodeInitGenerator } from "@nx/js";
-import { tslibVersion } from "@nx/node/src/utils/versions";
-import {
-  cloudflareToolsVersion,
-  cloudflareWorkersTypeVersions,
-  honoVersion,
-  wranglerVersion,
-} from "./libs/versions";
-import type { InitGeneratorSchema } from "./schema";
-
-export async function initGenerator(tree: Tree, schema: InitGeneratorSchema) {
-  const initTask = await nodeInitGenerator(tree, {
-    ...schema,
-    skipFormat: true,
-  });
-
-  const installTask = updateDependencies(tree, schema);
-  if (!schema.skipFormat) {
-    await formatFiles(tree);
-  }
-
-  return async () => {
-    await initTask();
-    await installTask();
-  };
-}
-
-function updateDependencies(tree: Tree, schema: InitGeneratorSchema) {
-  removeDependenciesFromPackageJson(
-    tree,
-    ["@storm-software/cloudflare-tools"],
-    [],
-  );
-
-  const honoPackage = (
-    schema.template === "hono" ? { hono: honoVersion } : {}
-  ) as Record<string, string>;
-  return addDependenciesToPackageJson(
-    tree,
-    {
-      tslib: tslibVersion,
-      ...honoPackage,
-    },
-    {
-      wrangler: wranglerVersion,
-      "@cloudflare/workers-types": cloudflareWorkersTypeVersions,
-      "@storm-software/cloudflare-tools": cloudflareToolsVersion,
-    },
-  );
-}
-
-export default initGenerator;
-export const initSchematic = convertNxGenerator(initGenerator);

package/src/generators/init/libs/versions.ts

@@ -1,7 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-export const cloudflareToolsVersion =
-  require("../../../../package.json").version;
-
-export const wranglerVersion = "^3.51.2";
-export const cloudflareWorkersTypeVersions = "^4.20240419.0";
-export const honoVersion = "^4.2.6";

package/src/generators/worker/generator.spec.ts

@@ -1,20 +0,0 @@
-import { createTreeWithEmptyWorkspace } from "@nx/devkit/testing";
-import { Tree, readProjectConfiguration } from "@nx/devkit";
-
-import { workerGenerator } from "./generator";
-import { WorkerGeneratorSchema } from "./schema";
-
-describe("worker generator", () => {
-  let tree: Tree;
-  const options: WorkerGeneratorSchema = { name: "test" };
-
-  beforeEach(() => {
-    tree = createTreeWithEmptyWorkspace();
-  });
-
-  it("should run successfully", async () => {
-    await workerGenerator(tree, options);
-    const config = readProjectConfiguration(tree, "test");
-    expect(config).toBeDefined();
-  });
-});