@bleedingdev/modern-js-plugin-bff 3.5.0-ultramodern.9 → 3.5.0-ultramodern.90

package/dist/esm-node/cli/generator.mjs

@@ -0,0 +1,134 @@
+import "node:module";
+import { ApiRouter } from "@modern-js/bff-core";
+import { compile } from "@modern-js/server-utils";
+import { API_DIR, SHARED_DIR, fs, resolveServerTsconfig } from "@modern-js/utils";
+import path from "path";
+import clientGenerator from "../utils/clientGenerator.mjs";
+import { bundleEffectEntryForNode } from "../utils/effectSourceLoader.mjs";
+import pluginGenerator from "../utils/pluginGenerator.mjs";
+import runtimeGenerator from "../utils/runtimeGenerator.mjs";
+import { getPrimaryPrefix } from "./prefix.mjs";
+import { serializeServerGlobalVars, transformServerGlobalVars } from "./serverGlobalVars.mjs";
+const RUNTIME_CREATE_REQUEST = '@modern-js/plugin-bff/client';
+const effectEntryExtensions = [
+    '.js',
+    '.jsx',
+    '.ts',
+    '.tsx',
+    '.mjs',
+    '.mts',
+    '.cjs',
+    '.cts'
+];
+function resolveEffectSourceEntry(appDirectory, apiDirectory, configuredEntry) {
+    const entry = configuredEntry ? path.isAbsolute(configuredEntry) ? configuredEntry : path.resolve(appDirectory, configuredEntry) : path.resolve(apiDirectory, 'index');
+    return path.extname(entry) ? entry : effectEntryExtensions.map((extension)=>`${entry}${extension}`).find((candidate)=>fs.existsSync(candidate));
+}
+function resolveBuiltEffectEntry(appDirectory, distDirectory, sourceEntry) {
+    if (!sourceEntry) return;
+    const relativeEntry = path.relative(appDirectory, sourceEntry);
+    if ('..' === relativeEntry || relativeEntry.startsWith(`..${path.sep}`)) throw new Error(`Effect BFF entry must be inside the application directory: ${sourceEntry}`);
+    const builtEntry = path.resolve(distDirectory, relativeEntry).replace(/\.(?:[cm]?ts|tsx|jsx)$/u, '.js');
+    return fs.existsSync(builtEntry) ? builtEntry : void 0;
+}
+const createBffGenerator = (api)=>{
+    const compileApi = async ()=>{
+        const { appDirectory, distDirectory, apiDirectory, bffRuntimeFramework, sharedDirectory, moduleType } = api.getAppContext();
+        const modernConfig = api.getNormalizedConfig();
+        const distDir = path.resolve(distDirectory);
+        const apiDir = apiDirectory || path.resolve(appDirectory, API_DIR);
+        const sharedDir = sharedDirectory || path.resolve(appDirectory, SHARED_DIR);
+        const tsconfigPath = resolveServerTsconfig(appDirectory, modernConfig?.server?.tsconfigPath);
+        const sourceDirs = [];
+        if (await fs.pathExists(apiDir)) sourceDirs.push(apiDir);
+        if (await fs.pathExists(sharedDir)) sourceDirs.push(sharedDir);
+        const { alias, globalVars } = modernConfig.source;
+        const { alias: resolveAlias } = modernConfig.resolve;
+        if (sourceDirs.length > 0) {
+            const combinedAlias = [].concat(alias ?? []).concat(resolveAlias ?? []);
+            const serializedGlobalVars = serializeServerGlobalVars(globalVars);
+            await compile(appDirectory, {
+                alias: combinedAlias
+            }, {
+                sourceDirs,
+                distDir,
+                tsconfigPath,
+                moduleType,
+                throwErrorInsteadOfExit: true
+            });
+            await transformServerGlobalVars(sourceDirs.map((sourceDir)=>path.resolve(distDir, path.relative(appDirectory, sourceDir))), serializedGlobalVars);
+            if ('effect' === bffRuntimeFramework) {
+                const sourceEntry = resolveEffectSourceEntry(appDirectory, apiDir, modernConfig.bff?.effect?.entry);
+                const builtEntry = resolveBuiltEffectEntry(appDirectory, distDir, sourceEntry);
+                if (!builtEntry) throw new Error(`Effect BFF entry was not emitted into ${distDir}: ${sourceEntry ?? path.resolve(apiDir, 'index')}`);
+                await bundleEffectEntryForNode({
+                    appDir: appDirectory,
+                    entryPath: builtEntry,
+                    format: 'module' === moduleType ? 'esm' : 'cjs'
+                });
+            }
+        }
+    };
+    const generate = async ()=>{
+        const { appDirectory, apiDirectory, lambdaDirectory, port, bffRuntimeFramework } = api.getAppContext();
+        const modernConfig = api.getNormalizedConfig();
+        const relativeDistPath = modernConfig?.output?.distPath?.root || 'dist';
+        const { bff } = modernConfig || {};
+        const prefix = getPrimaryPrefix(bff?.prefix);
+        const httpMethodDecider = bff?.httpMethodDecider;
+        const apiRouter = new ApiRouter({
+            apiDir: apiDirectory,
+            appDir: appDirectory,
+            lambdaDir: lambdaDirectory,
+            prefix,
+            httpMethodDecider,
+            isBuild: true
+        });
+        const lambdaDir = apiRouter.getLambdaDir();
+        const existLambda = apiRouter.isExistLambda();
+        const runtime = bff?.runtimeCreateRequest || RUNTIME_CREATE_REQUEST;
+        const relativeApiPath = path.relative(appDirectory, apiDirectory);
+        const relativeLambdaPath = path.relative(appDirectory, lambdaDir);
+        await pluginGenerator({
+            prefix,
+            appDirectory,
+            relativeDistPath,
+            relativeApiPath,
+            relativeLambdaPath,
+            runtimeFramework: 'hono' === bffRuntimeFramework ? 'hono' : 'effect'
+        });
+        await clientGenerator({
+            prefix,
+            appDir: appDirectory,
+            apiDir: apiDirectory,
+            lambdaDir,
+            existLambda,
+            port,
+            requestCreator: bff?.requestCreator,
+            httpMethodDecider,
+            relativeDistPath,
+            relativeApiPath,
+            bffRuntimeFramework,
+            effectEntry: bff?.effect?.entry,
+            effectDataPlatformBatch: bff?.effect?.dataPlatform?.batch
+        });
+        await runtimeGenerator({
+            runtime,
+            appDirectory,
+            relativeDistPath
+        });
+    };
+    const handleCrossProjectInvocation = async (isBuild = false)=>{
+        const { bff } = api.getNormalizedConfig();
+        if (bff?.crossProject) {
+            if (!isBuild) await compileApi();
+            await generate();
+        }
+    };
+    return {
+        compileApi,
+        generate,
+        handleCrossProjectInvocation
+    };
+};
+export { createBffGenerator };

package/dist/esm-node/cli/prefix.mjs

@@ -0,0 +1,10 @@
+import "node:module";
+import { DEFAULT_API_PREFIX } from "@modern-js/utils";
+const normalizePrefixList = (prefix)=>{
+    if (Array.isArray(prefix)) return prefix.filter(Boolean);
+    return [
+        prefix || DEFAULT_API_PREFIX
+    ];
+};
+const getPrimaryPrefix = (prefix)=>normalizePrefixList(prefix)[0] || DEFAULT_API_PREFIX;
+export { getPrimaryPrefix, normalizePrefixList };

package/dist/esm-node/cli/serverGlobalVars.mjs

@@ -0,0 +1,77 @@
+import "node:module";
+import { applyOptionsChain, fs } from "@modern-js/utils";
+import { transform } from "@swc/core";
+import path from "path";
+const RELEASE_IDENTITY_GLOBAL_NAMES = [
+    'ULTRAMODERN_BUILD_MARKER',
+    'ULTRAMODERN_SOURCE_REVISION',
+    'ULTRAMODERN_RELEASE_VERSION'
+];
+const collectJavaScriptFiles = async (directory)=>{
+    const entries = await fs.readdir(directory, {
+        withFileTypes: true
+    });
+    const nested = await Promise.all(entries.map(async (entry)=>{
+        const absolutePath = path.join(directory, entry.name);
+        if (entry.isDirectory()) return collectJavaScriptFiles(absolutePath);
+        return /\.(?:c|m)?js$/u.test(entry.name) ? [
+            absolutePath
+        ] : [];
+    }));
+    return nested.flat();
+};
+const serializeServerGlobalVars = (options)=>{
+    const globalVars = applyOptionsChain({}, options, {
+        env: 'server',
+        target: 'node'
+    });
+    return Object.fromEntries(Object.entries(globalVars).map(([key, value])=>{
+        let serialized;
+        try {
+            serialized = JSON.stringify(value);
+        } catch (error) {
+            throw new Error(`source.globalVars["${key}"] cannot be serialized exactly for BFF compilation.`, {
+                cause: error
+            });
+        }
+        if (void 0 === serialized) throw new Error(`source.globalVars["${key}"] cannot be serialized exactly for BFF compilation.`);
+        return [
+            key,
+            serialized
+        ];
+    }));
+};
+const transformServerGlobalVars = async (outputDirectories, globalVars)=>{
+    if (0 === Object.keys(globalVars).length) return;
+    const existingDirectories = (await Promise.all(outputDirectories.map(async (directory)=>await fs.pathExists(directory) ? directory : void 0))).filter((directory)=>Boolean(directory));
+    const files = (await Promise.all(existingDirectories.map(collectJavaScriptFiles))).flat();
+    const releaseIdentityBanner = RELEASE_IDENTITY_GLOBAL_NAMES.every((name)=>Object.hasOwn(globalVars, name)) ? `${RELEASE_IDENTITY_GLOBAL_NAMES.map((name)=>`void ${globalVars[name]};`).join('')}\n` : '';
+    await Promise.all(files.map(async (filename)=>{
+        const source = await fs.readFile(filename, 'utf8');
+        const sourceMapFilename = `${filename}.map`;
+        const sourceMapExists = await fs.pathExists(sourceMapFilename);
+        const inputSourceMap = sourceMapExists ? await fs.readFile(sourceMapFilename, 'utf8') : void 0;
+        const result = await transform(`${releaseIdentityBanner}${source}`, {
+            filename,
+            inputSourceMap,
+            sourceMaps: sourceMapExists,
+            jsc: {
+                parser: {
+                    syntax: "ecmascript"
+                },
+                preserveAllComments: true,
+                target: 'es2022',
+                transform: {
+                    optimizer: {
+                        globals: {
+                            vars: globalVars
+                        }
+                    }
+                }
+            }
+        });
+        await fs.writeFile(filename, result.code);
+        if (sourceMapExists && result.map) await fs.writeFile(sourceMapFilename, result.map);
+    }));
+};
+export { serializeServerGlobalVars, transformServerGlobalVars };

package/dist/esm-node/cli/watch.mjs

@@ -0,0 +1,14 @@
+import "node:module";
+const WATCHABLE_EXTENSIONS = [
+    '.ts',
+    '.tsx',
+    '.js',
+    '.jsx',
+    '.mts',
+    '.cts',
+    '.mjs',
+    '.cjs',
+    '.json'
+];
+const isWatchableBffFile = (filename)=>WATCHABLE_EXTENSIONS.some((ext)=>filename.endsWith(ext));
+export { isWatchableBffFile };

package/dist/esm-node/cli.mjs

@@ -1,34 +1,14 @@
 import "node:module";
 import { ApiRouter } from "@modern-js/bff-core";
-import { compile } from "@modern-js/server-utils";
-import { API_DIR, DEFAULT_API_PREFIX, SHARED_DIR, fs, normalizeOutputPath, resolveServerTsconfig } from "@modern-js/utils";
+import { normalizeOutputPath } from "@modern-js/utils";
 import path from "path";
-import clientGenerator from "./utils/clientGenerator.mjs";
-import pluginGenerator from "./utils/pluginGenerator.mjs";
-import runtimeGenerator from "./utils/runtimeGenerator.mjs";
+import { createCompressConfig } from "./cli/compress.mjs";
+import { createBffGenerator } from "./cli/generator.mjs";
+import { getPrimaryPrefix } from "./cli/prefix.mjs";
+import { isWatchableBffFile } from "./cli/watch.mjs";
 import { fileURLToPath as __rspack_fileURLToPath } from "node:url";
 import { dirname as __rspack_dirname } from "node:path";
 var __rspack_import_meta_dirname__ = __rspack_dirname(__rspack_fileURLToPath(import.meta.url));
-const RUNTIME_CREATE_REQUEST = '@modern-js/plugin-bff/client';
-const WATCHABLE_EXTENSIONS = [
-    '.ts',
-    '.tsx',
-    '.js',
-    '.jsx',
-    '.mts',
-    '.cts',
-    '.mjs',
-    '.cjs',
-    '.json'
-];
-const isWatchableBffFile = (filename)=>WATCHABLE_EXTENSIONS.some((ext)=>filename.endsWith(ext));
-const normalizePrefixList = (prefix)=>{
-    if (Array.isArray(prefix)) return prefix.filter(Boolean);
-    return [
-        prefix || DEFAULT_API_PREFIX
-    ];
-};
-const getPrimaryPrefix = (prefix)=>normalizePrefixList(prefix)[0] || DEFAULT_API_PREFIX;
 const bffPlugin = ()=>({
         name: '@modern-js/plugin-bff',
         setup: (api)=>{
@@ -40,106 +20,14 @@ const bffPlugin = ()=>({
                     bffRuntimeFramework: 'hono' === userRuntimeFramework ? 'hono' : 'effect'
                 });
             }
-            const compileApi = async ()=>{
-                const { appDirectory, distDirectory, apiDirectory, sharedDirectory, moduleType } = api.getAppContext();
-                const modernConfig = api.getNormalizedConfig();
-                const distDir = path.resolve(distDirectory);
-                const apiDir = apiDirectory || path.resolve(appDirectory, API_DIR);
-                const sharedDir = sharedDirectory || path.resolve(appDirectory, SHARED_DIR);
-                const tsconfigPath = resolveServerTsconfig(appDirectory, modernConfig?.server?.tsconfigPath);
-                const sourceDirs = [];
-                if (await fs.pathExists(apiDir)) sourceDirs.push(apiDir);
-                if (await fs.pathExists(sharedDir)) sourceDirs.push(sharedDir);
-                const { alias } = modernConfig.source;
-                const { alias: resolveAlias } = modernConfig.resolve;
-                if (sourceDirs.length > 0) {
-                    const combinedAlias = [].concat(alias ?? []).concat(resolveAlias ?? []);
-                    await compile(appDirectory, {
-                        alias: combinedAlias
-                    }, {
-                        sourceDirs,
-                        distDir,
-                        tsconfigPath,
-                        moduleType,
-                        throwErrorInsteadOfExit: true
-                    });
-                }
-            };
-            const generator = async ()=>{
-                const { appDirectory, apiDirectory, lambdaDirectory, port, bffRuntimeFramework } = api.getAppContext();
-                const modernConfig = api.getNormalizedConfig();
-                const relativeDistPath = modernConfig?.output?.distPath?.root || 'dist';
-                const { bff } = modernConfig || {};
-                const prefix = getPrimaryPrefix(bff?.prefix);
-                const httpMethodDecider = bff?.httpMethodDecider;
-                const apiRouter = new ApiRouter({
-                    apiDir: apiDirectory,
-                    appDir: appDirectory,
-                    lambdaDir: lambdaDirectory,
-                    prefix,
-                    httpMethodDecider,
-                    isBuild: true
-                });
-                const lambdaDir = apiRouter.getLambdaDir();
-                const existLambda = apiRouter.isExistLambda();
-                const runtime = bff?.runtimeCreateRequest || RUNTIME_CREATE_REQUEST;
-                const relativeApiPath = path.relative(appDirectory, apiDirectory);
-                const relativeLambdaPath = path.relative(appDirectory, lambdaDir);
-                await pluginGenerator({
-                    prefix,
-                    appDirectory,
-                    relativeDistPath,
-                    relativeApiPath,
-                    relativeLambdaPath,
-                    runtimeFramework: 'hono' === bffRuntimeFramework ? 'hono' : 'effect'
-                });
-                await clientGenerator({
-                    prefix,
-                    appDir: appDirectory,
-                    apiDir: apiDirectory,
-                    lambdaDir,
-                    existLambda,
-                    port,
-                    requestCreator: bff?.requestCreator,
-                    httpMethodDecider,
-                    relativeDistPath,
-                    relativeApiPath,
-                    bffRuntimeFramework,
-                    effectEntry: bff?.effect?.entry,
-                    effectDataPlatformBatch: bff?.effect?.dataPlatform?.batch
-                });
-                await runtimeGenerator({
-                    runtime,
-                    appDirectory,
-                    relativeDistPath
-                });
-            };
-            const handleCrossProjectInvocation = async (isBuild = false)=>{
-                const { bff } = api.getNormalizedConfig();
-                if (bff?.crossProject) {
-                    if (!isBuild) await compileApi();
-                    await generator();
-                }
-            };
+            const { compileApi, handleCrossProjectInvocation } = createBffGenerator(api);
             const isHono = ()=>{
                 const { bffRuntimeFramework } = api.getAppContext();
                 return 'hono' === bffRuntimeFramework;
             };
-            const createCompressConfig = (devServer, prefix)=>{
-                if (!devServer || 'object' != typeof devServer || Array.isArray(devServer)) return;
-                const { compress } = devServer;
-                if (void 0 === compress || true === compress) {
-                    const prefixes = normalizePrefixList(prefix);
-                    return {
-                        filter: (req)=>!prefixes.some((item)=>req.url?.includes(item))
-                    };
-                }
-                if (false === compress) return false;
-                return compress;
-            };
             api.config(async ()=>{
                 const devServer = api.getConfig()?.tools?.devServer;
-                const prefix = api.getConfig()?.bff?.prefix || DEFAULT_API_PREFIX;
+                const prefix = api.getConfig()?.bff?.prefix;
                 const compress = createCompressConfig(devServer, prefix);
                 return {
                     tools: {
@@ -244,6 +132,4 @@ const bffPlugin = ()=>({
             });
         }
     });
-const cli = bffPlugin;
-export default cli;
 export { bffPlugin };

package/dist/esm-node/loader.mjs

@@ -4,6 +4,8 @@ import { generateClient } from "@modern-js/bff-core";
 import { logger } from "@modern-js/utils";
 import path from "path";
 import { generateEffectClientCode, resolveEffectEntryFile } from "./utils/effectClientGenerator.mjs";
+const EFFECT_BFF_WORKER_RUNTIME_QUERY = 'modern-bff-runtime';
+const EFFECT_BFF_WORKER_RUNTIME_SOURCE_QUERY = 'modern-bff-runtime-source';
 async function transformEffectRuntimeSource(source, filename) {
     const swc = await import("@swc/core");
     const result = await swc.transform(source, {
@@ -22,22 +24,36 @@ async function transformEffectRuntimeSource(source, filename) {
     });
     return result.code;
 }
+function createEffectWorkerRuntimeWrapper(resourcePath) {
+    const sourceRequest = `${resourcePath}?${EFFECT_BFF_WORKER_RUNTIME_SOURCE_QUERY}`;
+    return `import * as effectBffModule from ${JSON.stringify(sourceRequest)};
+import { createEffectBffEdgeDispatcher } from '@modern-js/plugin-bff/effect-edge';
+
+export const __modern_create_effect_bff_dispatcher = options =>
+  createEffectBffEdgeDispatcher({
+    ...options,
+    module: effectBffModule,
+  });
+`;
+}
 async function loader(source) {
     this.cacheable();
     const { resourcePath } = this;
     delete require.cache[resourcePath];
     const callback = this.async();
     const draftOptions = this.getOptions();
+    const resourceQueries = new URLSearchParams(this.resourceQuery);
     const effectEntryFile = resolveEffectEntryFile({
         appDir: draftOptions.appDir,
         apiDir: draftOptions.apiDir,
         effectEntry: draftOptions.effectEntry
     });
-    if ('effect' === draftOptions.bffRuntimeFramework && effectEntryFile && path.resolve(effectEntryFile) === path.resolve(resourcePath) && this.resourceQuery.includes('modern-bff-runtime')) {
+    if ('effect' === draftOptions.bffRuntimeFramework && effectEntryFile && path.resolve(effectEntryFile) === path.resolve(resourcePath) && resourceQueries.has(EFFECT_BFF_WORKER_RUNTIME_SOURCE_QUERY)) {
         const code = await transformEffectRuntimeSource(source, resourcePath);
         callback(void 0, code);
         return;
     }
+    if ('effect' === draftOptions.bffRuntimeFramework && effectEntryFile && path.resolve(effectEntryFile) === path.resolve(resourcePath) && resourceQueries.has(EFFECT_BFF_WORKER_RUNTIME_QUERY)) return void callback(void 0, createEffectWorkerRuntimeWrapper(resourcePath));
     if ('effect' === draftOptions.bffRuntimeFramework && effectEntryFile && path.resolve(effectEntryFile) === path.resolve(resourcePath)) {
         const code = await generateEffectClientCode({
             appDir: draftOptions.appDir,
@@ -48,7 +64,8 @@ async function loader(source) {
             target: draftOptions.target,
             requestCreator: draftOptions.requestCreator,
             httpMethodDecider: draftOptions.httpMethodDecider,
-            dataPlatformBatch: draftOptions.effectDataPlatformBatch
+            dataPlatformBatch: draftOptions.effectDataPlatformBatch,
+            onDependency: (dependency)=>this.addDependency(dependency)
         });
         if (code) return void callback(void 0, code);
         callback(void 0, `throw new Error('Failed to generate Effect client for ${resourcePath}')`);