@distilled.cloud/cloudflare-rolldown-plugin 0.2.0 → 0.4.0

package/src/plugins/nodejs-compat.ts

@@ -2,159 +2,231 @@ import { getCloudflarePreset, nonPrefixedNodeModules } from "@cloudflare/unenv-p
 import assert from "node:assert";
 import { createRequire } from "node:module";
 import path from "node:path";
-import type { Plugin } from "rolldown";
 import { esmExternalRequirePlugin } from "rolldown/plugins";
 import { defineEnv } from "unenv";
-import type { CloudflarePluginOptions } from "../plugin.js";
-import { hasNodejsCompat } from "../utils.js";
+import { createPlugin } from "../factory.js";
+import { hasNodejsAls, hasNodejsCompat } from "../utils.js";
 
+const ASYNC_HOOKS_REGEXP = /^(node:)?async_hooks$/;
 const NODE_BUILTIN_MODULES_REGEXP = new RegExp(`^(${nonPrefixedNodeModules.join("|")}|node:.+)$`);
-const VIRTUAL_MODULE_ID_REGEXP = /^virtual:nodejs-global-inject\/.+$/;
 
-export function makeNodejsCompatPlugin(options: CloudflarePluginOptions): Plugin | Array<Plugin> {
-  if (hasNodejsCompat(options.compatibilityFlags)) {
-    return makeUnenvPlugin(options);
-  }
-  return makeNodeJsImportWarningPlugin();
-}
-
-function makeUnenvPlugin(options: CloudflarePluginOptions): Array<Plugin> {
-  const { alias, inject, external, polyfill } = defineEnv({
-    presets: [
-      getCloudflarePreset({
-        compatibilityDate: options.compatibilityDate,
-        compatibilityFlags: options.compatibilityFlags,
-      }),
-    ],
-  }).env;
-
-  const injectVirtualModules = makeInjectVirtualModules(inject);
-  const require = createRequire(import.meta.url);
-
-  return [
-    esmExternalRequirePlugin({
-      external: [...external],
-      skipDuplicateCheck: true,
-    }),
-    {
-      name: "rolldown-plugin-cloudflare:nodejs-compat:injects",
+export const nodejsAlsPlugin = createPlugin("nodejs-als", (options) => {
+  if (!hasNodejsAls(options.compatibilityFlags)) return;
+  return {
+    rolldown: {
       resolveId: {
-        filter: { id: VIRTUAL_MODULE_ID_REGEXP },
+        filter: { id: ASYNC_HOOKS_REGEXP },
         handler(id) {
-          if (injectVirtualModules.has(id)) {
-            return { id };
-          }
+          return { id, external: true };
         },
       },
-      load: {
-        filter: { id: VIRTUAL_MODULE_ID_REGEXP },
-        handler(id) {
-          return injectVirtualModules.get(id);
-        },
+    },
+    vite: {
+      configEnvironment(name) {
+        if (name === "client") return;
+        return {
+          resolve: {
+            builtins: ["async_hooks", "node:async_hooks"],
+          },
+          optimizeDeps: {
+            exclude: ["async_hooks", "node:async_hooks"],
+          },
+        };
       },
     },
-    {
-      name: "rolldown-plugin-cloudflare:nodejs-compat:unenv-preset-imports",
-      resolveId: {
-        filter: { id: /^@cloudflare\/unenv-preset\// },
-        async handler(id, importer, options) {
-          const resolved = await this.resolve(id, importer, options);
-          if (resolved) return resolved;
-          return { id: require.resolve(id) };
+  };
+});
+
+export interface UnenvApi {
+  polyfill: ReadonlyArray<string>;
+  inject: { [injectedName: string]: string };
+}
+
+export const nodejsUnenvPlugin = createPlugin<"nodejs-unenv", UnenvApi>(
+  "nodejs-unenv",
+  (options) => {
+    if (!hasNodejsCompat(options.compatibilityFlags)) return;
+    const { alias, inject, external, polyfill } = defineEnv({
+      presets: [
+        getCloudflarePreset({
+          compatibilityDate: options.compatibilityDate,
+          compatibilityFlags: options.compatibilityFlags,
+        }),
+      ],
+    }).env;
+    const entries = new Set(Object.values(alias));
+    for (const globalInject of Object.values(inject)) {
+      if (typeof globalInject === "string") {
+        entries.add(globalInject);
+      } else {
+        entries.add(globalInject[0]);
+      }
+    }
+    polyfill.forEach((module) => entries.add(module));
+    external.forEach((module) => entries.delete(module));
+    const require = createRequire(import.meta.url);
+    const resolve = (id: string) => {
+      if (alias[id] && !external.includes(alias[id])) {
+        return require.resolve(alias[id]);
+      }
+      if (entries.has(id)) {
+        return require.resolve(id);
+      }
+    };
+    const RESOLVE_ID_FILTER = {
+      id: [NODE_BUILTIN_MODULES_REGEXP, /^unenv\//, /^@cloudflare\/unenv-preset\//],
+    };
+    return {
+      shared: {
+        api: {
+          polyfill,
+          inject: Object.fromEntries(
+            Object.entries(inject).map(([injectedName, moduleSpecifier]) => {
+              assert(
+                typeof moduleSpecifier === "string",
+                `expected moduleSpecifier to be a string`,
+              );
+              return [injectedName, moduleSpecifier];
+            }),
+          ),
         },
       },
-    },
-    {
-      name: "rolldown-plugin-cloudflare:nodejs-compat",
-      resolveId: {
-        filter: { id: NODE_BUILTIN_MODULES_REGEXP },
-        handler(source, importer, options) {
-          const aliased = alias[source];
-          if (!aliased) {
-            return;
-          }
-          if (external.includes(aliased)) {
-            return {
-              id: aliased,
-              external: true,
-            };
-          }
-          return this.resolve(aliased, importer, options);
+      rolldown: {
+        async options(options) {
+          options.plugins = [
+            esmExternalRequirePlugin({
+              external: [...external],
+              skipDuplicateCheck: true,
+            }),
+            options.plugins,
+          ];
+          return options;
+        },
+        resolveId: {
+          filter: RESOLVE_ID_FILTER,
+          handler(source, importer, options) {
+            const resolved = resolve(source);
+            if (!resolved) return;
+            return this.resolve(resolved, importer, options);
+          },
         },
       },
-      transform(code, id) {
-        const info = this.getModuleInfo(id);
-        if (!info?.isEntry) {
-          return;
-        }
-        return [
-          ...polyfill.map((module) => `import "${module}";`),
-          ...Array.from(injectVirtualModules.keys()).map((module) => `import "${module}";`),
-          code,
-        ].join("\n");
+      vite: {
+        enforce: "pre",
+        async configEnvironment(name) {
+          if (name === "client") return;
+          return {
+            resolve: {
+              builtins: [...external],
+            },
+            ...(this.meta.rolldownVersion
+              ? {
+                  build: {
+                    rolldownOptions: {
+                      plugins: [
+                        esmExternalRequirePlugin({
+                          external: [...external],
+                          skipDuplicateCheck: true,
+                        }),
+                      ],
+                    },
+                  },
+                }
+              : {}),
+          };
+        },
+        async configureServer(server) {
+          await Promise.all(
+            Object.values(server.environments).flatMap(async (environment) => {
+              const depsOptimizer = environment.depsOptimizer;
+              if (!depsOptimizer) return;
+              await depsOptimizer.init();
+              return Array.from(entries).map((entry) => {
+                const resolved = resolve(entry);
+                if (!resolved) return;
+                const registration = depsOptimizer.registerMissingImport(entry, resolved);
+                return registration?.processing;
+              });
+            }),
+          );
+        },
+        resolveId: {
+          filter: RESOLVE_ID_FILTER,
+          handler(source, importer, options) {
+            const resolved = resolve(source);
+            if (!resolved) return;
+            if (this.environment.mode === "dev" && this.environment.depsOptimizer) {
+              // We are in dev mode (rather than build).
+              // So let's pre-bundle this polyfill entry-point using the dependency optimizer.
+              const { id } = this.environment.depsOptimizer.registerMissingImport(source, resolved);
+              // We use the unresolved path to the polyfill and let the dependency optimizer's
+              // resolver find the resolved path to the bundled version.
+              return this.resolve(id, importer, options);
+            }
+            return this.resolve(resolved, importer, options);
+          },
+        },
       },
-    } satisfies Plugin,
-  ];
-}
+    };
+  },
+);
 
-function makeNodeJsImportWarningPlugin(): Plugin {
+export const nodejsImportWarningPlugin = createPlugin("nodejs-import-warning", (options) => {
+  if (hasNodejsCompat(options.compatibilityFlags)) return;
   const imports = new Map<string, Set<string>>();
   let root = process.cwd();
   return {
-    name: "rolldown-plugin-cloudflare:nodejs-import-warnings",
-    options(options) {
-      if (options.cwd) {
-        root = options.cwd;
-      }
-    },
-    resolveId: {
-      filter: { id: NODE_BUILTIN_MODULES_REGEXP },
-      async handler(id, importer) {
-        if (importer) {
-          if (!imports.has(id)) {
-            imports.set(id, new Set());
-          }
-          imports.get(id)?.add(importer);
+    rolldown: {
+      options(options) {
+        if (options.cwd) {
+          root = options.cwd;
         }
-        return { id, external: true };
       },
     },
-    buildStart() {
-      imports.clear();
+    vite: {
+      enforce: "pre",
+      configResolved(config) {
+        root = config.root;
+      },
     },
-    buildEnd() {
-      if (imports.size > 0) {
-        let message =
-          `Unexpected Node.js imports. ` +
-          `Do you need to enable the "nodejs_compat" compatibility flag? ` +
-          "Refer to https://developers.cloudflare.com/workers/runtime-apis/nodejs/ for more details.\n";
+    shared: {
+      buildStart() {
+        imports.clear();
+      },
+      resolveId: {
+        filter: { id: NODE_BUILTIN_MODULES_REGEXP },
+        async handler(id, importer) {
+          if (hasNodejsAls(options.compatibilityFlags) && ASYNC_HOOKS_REGEXP.test(id)) return;
+          if (importer) {
+            if (!imports.has(id)) {
+              imports.set(id, new Set());
+            }
+            imports.get(id)?.add(importer);
+          }
+          return { id, external: true };
+        },
+      },
+      buildEnd() {
+        const filteredImports: Array<{ id: string; importer: string }> = [];
         for (const [id, importers] of imports.entries()) {
           for (const importer of importers) {
-            message += ` - "${id}" imported from "${path.relative(root, importer)}"\n`;
+            if (this.getModuleInfo(importer)) {
+              filteredImports.push({ id, importer });
+            }
           }
         }
-        this.warn(message);
-      }
+        if (filteredImports.length > 0) {
+          const message = [
+            "Unexpected Node.js imports. ",
+            'Do you need to enable the "nodejs_compat" compatibility flag? ',
+            "Refer to https://developers.cloudflare.com/workers/runtime-apis/nodejs/ for more details.\n",
+            ...filteredImports.map(
+              ({ id, importer }) => ` - "${id}" imported from "${path.relative(root, importer)}"\n`,
+            ),
+          ].join("");
+          this.warn(message);
+        }
+      },
     },
   };
-}
-
-function makeInjectVirtualModules(
-  inject: Readonly<Record<string, string | ReadonlyArray<string>>>,
-) {
-  const virtualModules = new Map<string, string>();
-  for (const [injectedName, moduleSpecifier] of Object.entries(inject)) {
-    // The type from unenv is string | string[], but the Cloudflare preset only uses string.
-    // This indicates a default export that we set on globalThis.
-    assert(typeof moduleSpecifier === "string", `expected moduleSpecifier to be a string`);
-    virtualModules.set(
-      injectVirtualModuleId(injectedName),
-      `import virtualModule from "${moduleSpecifier}"; globalThis.${injectedName} = virtualModule;`,
-    );
-  }
-  return virtualModules;
-}
-
-function injectVirtualModuleId(module: string) {
-  return `virtual:nodejs-global-inject/${module}` as const;
-}
+});

package/src/plugins/options.ts

@@ -1,8 +1,13 @@
-import type { Plugin } from "rolldown";
-import type { CloudflarePluginOptions } from "../plugin.js";
+import path from "node:path";
+import type * as vite from "vite";
+import { createPlugin } from "../factory.js";
+import type { CloudflarePluginOptions } from "../options.js";
 import { hasNodejsCompat } from "../utils.js";
+import { WORKER_ENTRY_PREFIX } from "./virtual-modules.js";
 
-const DEFAULT_RESOLVE_CONDITION_NAMES = ["workerd", "worker", "module", "browser", "production"];
+const DEFAULT_CONDITIONS = ["workerd", "worker", "module", "browser"];
+
+const DEFAULT_RESOLVE_MAIN_FIELDS = ["browser", "module", "jsnext:main", "jsnext"];
 
 const DEFAULT_RESOLVE_EXTENSIONS = [
   ".mjs",
@@ -17,35 +22,149 @@ const DEFAULT_RESOLVE_EXTENSIONS = [
   ".ctx",
 ];
 
-export function makeOptionsPlugin(pluginOptions: CloudflarePluginOptions) {
-  return {
-    name: "rolldown-plugin-cloudflare:options",
+const TARGET = "es2024";
+
+export const optionsPlugin = createPlugin("options", (pluginOptions) => ({
+  rolldown: {
     options(options) {
+      options.input = wrapEntryInput(options.input ?? {});
+      options.preserveEntrySignatures ??= "strict";
       options.platform ??= "neutral";
       options.resolve ??= {};
-      options.resolve.conditionNames ??= DEFAULT_RESOLVE_CONDITION_NAMES;
+      options.resolve.conditionNames ??= [...DEFAULT_CONDITIONS, "production"];
+      options.resolve.mainFields ??= DEFAULT_RESOLVE_MAIN_FIELDS;
       options.resolve.extensions ??= DEFAULT_RESOLVE_EXTENSIONS;
       options.transform ??= {};
-      options.transform.target ??= "es2024";
+      options.transform.target ??= TARGET;
       options.transform.define ??= {};
-      Object.assign(options.transform.define, {
-        "process.env.NODE_ENV": '"production"',
-        "global.process.env.NODE_ENV": '"production"',
-        "globalThis.process.env.NODE_ENV": '"production"',
-        ...(hasNodejsCompat(pluginOptions.compatibilityFlags)
-          ? {}
-          : {
-              "process.env": "{}",
-              "global.process.env": "{}",
-              "globalThis.process.env": "{}",
-            }),
-        ...(pluginOptions.compatibilityDate && pluginOptions.compatibilityDate >= "2022-03-21"
-          ? {
-              "navigator.userAgent": '"Cloudflare-Workers"',
-            }
-          : {}),
-      });
+      Object.assign(options.transform.define, getDefine(pluginOptions, "production"));
       return options;
     },
-  } satisfies Plugin;
+  },
+  vite: {
+    config(userConfig) {
+      const isRolldown = "rolldownVersion" in this.meta;
+      const rollupOptions: vite.Rollup.RollupOptions = {
+        input: wrapEntryInput(userConfig.environments?.ssr?.build?.rollupOptions?.input ?? {}),
+        preserveEntrySignatures: "strict",
+      };
+      const define = getDefine(
+        pluginOptions,
+        process.env.NODE_ENV || userConfig.mode || "production",
+      );
+      return {
+        ssr: {
+          noExternal: true,
+          resolve: {
+            conditions: [...DEFAULT_CONDITIONS, "development|production"],
+          },
+        },
+        environments: {
+          client: {
+            build: {
+              outDir: getOutputDirectory(userConfig, "client"),
+            },
+          },
+          ssr: {
+            resolve: {
+              noExternal: true,
+              conditions: [...DEFAULT_CONDITIONS, "development|production"],
+            },
+            build: {
+              ssr: true,
+              target: TARGET,
+              emitAssets: true,
+              copyPublicDir: false,
+              outDir: getOutputDirectory(userConfig, "ssr"),
+              ...(isRolldown
+                ? {
+                    rolldownOptions: {
+                      ...rollupOptions,
+                      platform: "neutral",
+                      resolve: {
+                        mainFields: DEFAULT_RESOLVE_MAIN_FIELDS,
+                        extensions: DEFAULT_RESOLVE_EXTENSIONS,
+                      },
+                    },
+                  }
+                : { rollupOptions }),
+            },
+            optimizeDeps: {
+              noDiscovery: false,
+              ignoreOutdatedRequests: true,
+              ...(isRolldown
+                ? {
+                    rolldownOptions: {
+                      platform: "neutral",
+                      resolve: {
+                        conditionNames: [...DEFAULT_CONDITIONS, "development|production"],
+                        mainFields: DEFAULT_RESOLVE_MAIN_FIELDS,
+                        extensions: DEFAULT_RESOLVE_EXTENSIONS,
+                      },
+                      transform: {
+                        target: TARGET,
+                        define,
+                      },
+                    },
+                  }
+                : {
+                    esbuildOptions: {
+                      platform: "neutral",
+                      conditions: [...DEFAULT_CONDITIONS, "development|production"],
+                      resolveExtensions: DEFAULT_RESOLVE_EXTENSIONS,
+                      mainFields: DEFAULT_RESOLVE_MAIN_FIELDS,
+                      target: TARGET,
+                      define,
+                    },
+                  }),
+            },
+            keepProcessEnv: true,
+          },
+        },
+      };
+    },
+  },
+}));
+
+function wrapEntryInput(input: string | Array<string> | Record<string, string>) {
+  const virtualEntryId = (id: string) => `${WORKER_ENTRY_PREFIX}${id}` as const;
+
+  if (typeof input === "string") {
+    return virtualEntryId(input);
+  }
+  if (Array.isArray(input)) {
+    return input.map(virtualEntryId);
+  }
+  return Object.fromEntries(
+    Object.entries(input).map(([key, value]) => [virtualEntryId(key), value]),
+  );
+}
+
+function getDefine(options: CloudflarePluginOptions, nodeEnv: string): Record<string, string> {
+  return {
+    "process.env.NODE_ENV": JSON.stringify(nodeEnv),
+    "global.process.env.NODE_ENV": JSON.stringify(nodeEnv),
+    "globalThis.process.env.NODE_ENV": JSON.stringify(nodeEnv),
+    ...(hasNodejsCompat(options.compatibilityFlags)
+      ? {}
+      : {
+          "process.env": "{}",
+          "global.process.env": "{}",
+          "globalThis.process.env": "{}",
+        }),
+    ...(options.compatibilityDate && options.compatibilityDate >= "2022-03-21"
+      ? {
+          "navigator.userAgent": '"Cloudflare-Workers"',
+        }
+      : {}),
+  };
+}
+
+function getOutputDirectory(userConfig: vite.UserConfig, environmentName: string) {
+  const rootOutputDirectory = userConfig.build?.outDir ?? "dist";
+
+  return (
+    userConfig.environments?.[environmentName]?.build?.outDir ??
+    path.join(rootOutputDirectory, environmentName)
+  );
 }

package/src/plugins/virtual-modules.ts

@@ -0,0 +1,135 @@
+import type { Plugin } from "rolldown";
+import { createPlugin } from "../factory.js";
+import type { UnenvApi } from "./nodejs-compat.js";
+
+// oxlint-disable-next-line no-control-regex
+const VIRTUAL_MODULE_REGEXP = /^\0distilled:.*$/;
+
+export const WORKER_ENTRY_PREFIX = "\0distilled:worker-entry:" as const;
+const USER_ENTRY_PREFIX = "\0distilled:user-entry:" as const;
+const PEAR_ENTRY_PREFIX = "\0distilled:pear-entry:" as const;
+const INJECT_PREFIX = "\0distilled:inject:" as const;
+const EXPORT_TYPES_ID = "\0distilled:export-types" as const;
+
+export const virtualModulesPlugin = createPlugin("virtual-modules", (options) => {
+  let unenvApi: UnenvApi | undefined;
+  const inject = () => {
+    if (!unenvApi) return [];
+    return [
+      ...unenvApi.polyfill.map((module) => `import "${module}";`),
+      ...Object.keys(unenvApi.inject).map(
+        (injectedName) => `import "${INJECT_PREFIX}${injectedName}";`,
+      ),
+    ];
+  };
+  return {
+    shared: {
+      buildStart({ plugins }) {
+        unenvApi = plugins.find(
+          (plugin): plugin is Plugin<UnenvApi> =>
+            "name" in plugin && plugin.name === "distilled-cloudflare:nodejs-unenv",
+        )?.api;
+      },
+      resolveId: {
+        filter: { id: VIRTUAL_MODULE_REGEXP },
+        handler(id) {
+          if (
+            id.startsWith(WORKER_ENTRY_PREFIX) ||
+            id.startsWith(PEAR_ENTRY_PREFIX) ||
+            id.startsWith(INJECT_PREFIX) ||
+            id === EXPORT_TYPES_ID
+          ) {
+            return { id };
+          }
+          if (id.startsWith(USER_ENTRY_PREFIX)) {
+            return this.resolve(id.slice(USER_ENTRY_PREFIX.length), undefined, {
+              isEntry: true,
+              kind: "import-statement",
+            });
+          }
+        },
+      },
+      load: {
+        filter: { id: VIRTUAL_MODULE_REGEXP },
+        handler(id) {
+          if (id.startsWith(WORKER_ENTRY_PREFIX)) {
+            const userEntryId = id.replace(WORKER_ENTRY_PREFIX, USER_ENTRY_PREFIX);
+            return [
+              ...inject(),
+              `import { getExportTypes } from "${EXPORT_TYPES_ID}";`,
+              ...(options.exports
+                ? [`export { ${options.exports.join(", ")} } from "${userEntryId}";`]
+                : [
+                    `import * as userEntry from "${userEntryId}";`,
+                    `export * from "${userEntryId}";`,
+                    `export default userEntry.default ?? {};`,
+                  ]),
+              "if (import.meta.hot) {",
+              "  import.meta.hot.accept((module) => {",
+              "    const exportTypes = getExportTypes(module);",
+              '    import.meta.hot.send("distilled-cloudflare:worker-export-types", exportTypes);',
+              "  });",
+              "}",
+            ].join("\n");
+          }
+          if (id === EXPORT_TYPES_ID) {
+            return `
+import {
+  WorkerEntrypoint,
+  DurableObject,
+  WorkflowEntrypoint,
+} from "cloudflare:workers";
+
+const baseClasses = new Map([
+  ["WorkerEntrypoint", WorkerEntrypoint],
+  ["DurableObject", DurableObject],
+  ["WorkflowEntrypoint", WorkflowEntrypoint],
+]);
+
+export function getExportTypes(module) {
+  const exportTypes = {};
+
+  for (const [key, value] of Object.entries(module)) {
+    if (key === "default") {
+      continue;
+    }
+
+    let exportType;
+
+    if (typeof value === "function") {
+      for (const [type, baseClass] of baseClasses) {
+        if (baseClass.prototype.isPrototypeOf(value.prototype)) {
+          exportType = type;
+          break;
+        }
+      }
+
+      if (!exportType) {
+        exportType = "DurableObject";
+      }
+    } else if (typeof value === "object" && value !== null) {
+      exportType = "WorkerEntrypoint";
+    }
+
+    exportTypes[key] = exportType;
+  }
+
+  return exportTypes;
+}`;
+          }
+          if (id.startsWith(INJECT_PREFIX)) {
+            const injectedName = id.slice(INJECT_PREFIX.length);
+            const moduleSpecifier = unenvApi?.inject[injectedName];
+            if (!moduleSpecifier) {
+              throw new Error(`Expected module specifier for "${injectedName}" to be defined`);
+            }
+            return [
+              `import ${injectedName} from "${moduleSpecifier}";`,
+              `globalThis.${injectedName} = ${injectedName};`,
+            ].join("\n");
+          }
+        },
+      },
+    },
+  };
+});