feat: added building with external api to local runtime

jcbsfilho · jcbsfilho · commit 52bcd13451e3 · 2024-01-10T16:56:50.000-03:00
diff --git a/lib/build/bundlers/esbuild/index.js b/lib/build/bundlers/esbuild/index.js
@@ -52,7 +52,7 @@ class Esbuild extends BundlerBase {
 
     if (useNodePolyfills) {
       if (!updatedConfig.plugins) updatedConfig.plugins = [];
-      updatedConfig.plugins.push(ESBuildNodeModulePlugin());
+      updatedConfig.plugins.push(ESBuildNodeModulePlugin(globalThis.buildProd));
     }
 
     // inject content in worker initial code.
diff --git a/lib/build/bundlers/esbuild/plugins/node-polyfills/index.js b/lib/build/bundlers/esbuild/plugins/node-polyfills/index.js
@@ -4,10 +4,11 @@ import path from 'path';
 import PolyfillsManager from '../../../polyfills/polyfills-manager.js';
 
 /**
+ * @param {boolean} buildProd Parameter to identify whether the build is dev or prod
  * ESBuild Node Module Plugin for polyfilling node modules.
  * @returns {object} - ESBuild plugin object.
  */
-const ESBuildNodeModulePlugin = () => {
+const ESBuildNodeModulePlugin = (buildProd) => {
   const NAME = 'vulcan-node-modules-polyfills';
   const NAMESPACE = NAME;
 
@@ -43,13 +44,30 @@ const ESBuildNodeModulePlugin = () => {
         });
       }
 
+      // external
+      if (buildProd) {
+        options.external = options.external || [];
+        [...polyfillManager.external].forEach(([key]) => {
+          options.external.push(key);
+          options.external.push(`node:${key}`);
+        });
+      }
+
       /**
        * Resolve callback for ESBuild.
        * @param {object} args - Arguments object.
        * @returns {object|undefined} - Object with path and namespace or undefined.
        */
       build.onResolve({ filter: /.*/ }, async (args) => {
         const argsPath = args.path.replace(/^node:/, '');
+
+        if (!buildProd && polyfillManager.external.has(argsPath)) {
+          return {
+            path: args.path,
+            namespace: NAMESPACE,
+          };
+        }
+
         if (!polyfillManager.libs.has(argsPath)) {
           return;
         }
@@ -98,7 +116,12 @@ const ESBuildNodeModulePlugin = () => {
       build.onLoad({ filter: /.*/, namespace: NAMESPACE }, async (args) => {
         const argsPath = args.path.replace(/^node:/, '');
 
-        const resolved = polyfillManager.libs.get(argsPath);
+        let resolved = polyfillManager.libs.get(argsPath);
+
+        if (!buildProd && polyfillManager.external.has(argsPath)) {
+          resolved = polyfillManager.external.get(argsPath);
+        }
+
         const contents = await fs.promises.readFile(resolved, 'utf8');
         const resolveDir = path.dirname(resolved);
 
diff --git a/lib/build/bundlers/polyfills/node/async_hooks.js b/lib/build/bundlers/polyfills/node/async_hooks.js
@@ -0,0 +1,34 @@
+/* eslint-disable */
+export class AsyncLocalStorage {
+  constructor() {
+    this.store = new Map();
+  }
+
+  run(storeData, callback) {
+    const key = Symbol();
+    this.store.set(key, storeData);
+    const restoreData = Object.fromEntries(this.store);
+
+    return callback(restoreData);
+  }
+
+  getStore() {
+    const allEntries = [...this.store.entries()];
+    if (allEntries.length === 0) return undefined;
+
+    const [_, lastValue] = allEntries[allEntries.length - 1];
+    return lastValue;
+  }
+
+  enterWith(storeData) {
+    this.store = new Map(Object.entries(storeData));
+  }
+
+  exit() {
+    this.store = new Map();
+  }
+}
+
+export default {
+  AsyncLocalStorage,
+};
diff --git a/lib/build/bundlers/polyfills/polyfills-manager.js b/lib/build/bundlers/polyfills/polyfills-manager.js
@@ -21,6 +21,8 @@ class PolyfillsManager {
     this.libs = new Map();
     /** @type {Map<string, string|boolean>} */
     this.alias = new Map();
+    /** @type {Map<string, string|boolean>} */
+    this.external = new Map();
   }
 
   /**
@@ -50,9 +52,18 @@ class PolyfillsManager {
     this.alias.set(name, path);
   }
 
+  /**
+   * Sets a external libs.
+   * @param {string} name - Name of the external.
+   * @param {string|boolean} path - Path to the polyfill or a boolean value.
+   */
+  setExternal(name, path) {
+    this.external.set(name, path);
+  }
+
   /**
    * Builds and retrieves the polyfills for Node and globals.
-   * @returns {{ libs: Map<string, string|boolean>, globals: Map<string, string>, alias: Map<string, string> }} - Object containing libs and globals.
+   * @returns {{ libs: Map<string, string|boolean>, globals: Map<string, string>, alias: Map<string, string>, external: Map<string, string> }} - Object containing libs and globals.
    */
   buildPolyfills() {
     this.setGlobal('buffer', `${nodePolyfillsPath}/globals/buffer.js`);
@@ -70,7 +81,6 @@ class PolyfillsManager {
     );
 
     this.setLib('accepts', require.resolve('accepts'));
-    this.setLib('async_hooks', `${nodePolyfillsPath}/_empty.js`);
     this.setLib('buffer', require.resolve('buffer/'));
     this.setLib('child_process', `${nodePolyfillsPath}/_empty.js`);
     this.setLib('cluster', `${nodePolyfillsPath}/_empty.js`);
@@ -131,7 +141,14 @@ class PolyfillsManager {
     this.setAlias('util', require.resolve('util/'));
     this.setAlias('process', `${nodePolyfillsPath}/globals/process.js`);
 
-    return { libs: this.libs, globals: this.globals, alias: this.alias };
+    this.setExternal('async_hooks', `${nodePolyfillsPath}/async_hooks.js`);
+
+    return {
+      libs: this.libs,
+      globals: this.globals,
+      alias: this.alias,
+      external: this.external,
+    };
   }
 }
 
diff --git a/lib/build/bundlers/polyfills/polyfills-manager.test.js b/lib/build/bundlers/polyfills/polyfills-manager.test.js
@@ -5,7 +5,6 @@ describe('Polyfills Manager', () => {
   it('Should return map of polyfills', () => {
     const expectedPolyfills = [
       'accepts',
-      'async_hooks',
       'buffer',
       'child_process',
       'cluster',
diff --git a/lib/build/bundlers/webpack/index.js b/lib/build/bundlers/webpack/index.js
@@ -87,7 +87,7 @@ class Webpack extends BundlerBase {
       this.presetMode === 'compute';
 
     if (useNodePolyfills) {
-      updatedConfig.plugins.push(new NodePolyfillPlugin());
+      updatedConfig.plugins.push(new NodePolyfillPlugin(globalThis.buildProd));
     }
     return updatedConfig;
   }
diff --git a/lib/build/bundlers/webpack/plugins/node-polyfills/index.js b/lib/build/bundlers/webpack/plugins/node-polyfills/index.js
@@ -3,6 +3,10 @@ import { generateWebpackBanner } from '#utils';
 import PolyfillsManager from '../../../polyfills/polyfills-manager.js';
 
 class NodePolyfillPlugin {
+  constructor(buildProd) {
+    this.buildProd = buildProd;
+  }
+
   apply(compiler) {
     const polyfillsManager = PolyfillsManager.buildPolyfills();
 
@@ -46,6 +50,28 @@ class NodePolyfillPlugin {
       }),
     );
 
+    if (this.buildProd) {
+      compiler.options.externals = [
+        // eslint-disable-next-line
+        function ({ _, request }, callback) {
+          [...polyfillsManager.external].map(([key]) => {
+            const pattern = new RegExp(`${key}$`);
+            if (pattern.test(request)) {
+              return callback(null, `module ${request}`);
+            }
+            return callback();
+          });
+        },
+      ];
+    } else {
+      compiler.options.resolve.fallback = {
+        ...Object.fromEntries(
+          [...polyfillsManager.external].map(([key, value]) => [key, value]),
+        ),
+        ...compiler.options.resolve.fallback,
+      };
+    }
+
     compiler.options.resolve.alias = {
       ...Object.fromEntries(
         [...polyfillsManager.alias].map(([key, value]) => [key, value]),
diff --git a/lib/build/dispatcher/dispatcher.js b/lib/build/dispatcher/dispatcher.js
@@ -14,7 +14,7 @@ import {
   injectFilesInMem,
 } from '#utils';
 import { Messages } from '#constants';
-import { vulcan } from '#env';
+import vulcan from '../../env/vulcan.env.js';
 import {
   getAliasPath,
   createDotEnvFile,
@@ -378,6 +378,7 @@ class Dispatcher {
 
     await vulcan.createVulcanEnv(
       {
+        builder: builderSelected,
         entry: originalEntry, // original entry
         preset: buildConfig.preset.name,
         mode: buildConfig.preset.mode,
diff --git a/lib/commands/build.commands.js b/lib/commands/build.commands.js
@@ -1,6 +1,6 @@
 import { Commands } from '#namespaces';
 import { feedback } from '#utils';
-import { vulcan } from '#env';
+import vulcan from '../env/vulcan.env.js';
 
 /**
  * Retrieves a configuration value based on priority.
diff --git a/lib/env/server.env.js b/lib/env/server.env.js
@@ -4,6 +4,7 @@ import { runServer, EdgeRuntime } from 'edge-runtime';
 import chokidar from 'chokidar';
 import runtime from './runtime.env.js';
 import vulcan from './vulcan.env.js';
+import buildCommand from '../commands/build.commands.js';
 
 let currentServer;
 let isChangeHandlerRunning = false;
@@ -37,13 +38,28 @@ async function initializeServer(port, workerCode) {
   return runServer({ port, host: '0.0.0.0', runtime: execution });
 }
 
+/**
+ * Build to Local Server with polyfill external
+ */
+async function buildToLocalServer() {
+  const { entry } = (await vulcan.readVulcanEnv('local')) || {};
+
+  if (!entry) {
+    throw new Error('fail load build file');
+  }
+  globalThis.buildProd = false;
+  await buildCommand({});
+}
+
 /**
  * Handle server operations: start, restart.
  * @param {string} workerPath - Path to the worker file.
  * @param {number} port - The port number.
  */
 async function manageServer(workerPath, port) {
   try {
+    await buildToLocalServer();
+
     const workerCode = await readWorkerCode(workerPath);
 
     if (currentServer) {
@@ -66,6 +82,7 @@ async function manageServer(workerPath, port) {
     }
   } catch (error) {
     debug.error(error);
+    feedback.server.error('Please before run command build');
     process.exit(1);
   }
 }
diff --git a/lib/main.js b/lib/main.js
@@ -88,6 +88,7 @@ function startVulcanProgram() {
     )
     .action(async (options) => {
       const { buildCommand } = await import('#commands');
+      globalThis.buildProd = true;
       await buildCommand(options);
     });
 

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ class Esbuild extends BundlerBase {`
`52`	`52`
`53`	`53`	`if (useNodePolyfills) {`
`54`	`54`	`if (!updatedConfig.plugins) updatedConfig.plugins = [];`
`55`		`- updatedConfig.plugins.push(ESBuildNodeModulePlugin());`
	`55`	`+ updatedConfig.plugins.push(ESBuildNodeModulePlugin(globalThis.buildProd));`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`// inject content in worker initial code.`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ class Webpack extends BundlerBase {`
`87`	`87`	`this.presetMode === 'compute';`
`88`	`88`
`89`	`89`	`if (useNodePolyfills) {`
`90`		`- updatedConfig.plugins.push(new NodePolyfillPlugin());`
	`90`	`+ updatedConfig.plugins.push(new NodePolyfillPlugin(globalThis.buildProd));`
`91`	`91`	`}`
`92`	`92`	`return updatedConfig;`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,7 @@ function startVulcanProgram() {`
`88`	`88`	`)`
`89`	`89`	`.action(async (options) => {`
`90`	`90`	`const { buildCommand } = await import('#commands');`
	`91`	`+ globalThis.buildProd = true;`
`91`	`92`	`await buildCommand(options);`
`92`	`93`	`});`
`93`	`94`