edge-functions 2.3.0 → 2.4.0-stage.1

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [2.4.0-stage.1](https://github.com/aziontech/vulcan/compare/v2.3.0...v2.4.0-stage.1) (2024-01-24)
+
+
+### Features
+
+* adding polyfill for Storage API for local server ([444ea38](https://github.com/aziontech/vulcan/commit/444ea388801bf6acd2b201426f8296a8ba18cc3e))
+* storage api local server ([#214](https://github.com/aziontech/vulcan/issues/214)) ([d793c90](https://github.com/aziontech/vulcan/commit/d793c904ccfb6a5f7bb971f85b8a832c5a5f8e0a))
+
+
+### Bug Fixes
+
+* removing the requirement to useNodePolyfill when api external azion ([4b6cc2d](https://github.com/aziontech/vulcan/commit/4b6cc2d8e57297fa577fdb961831d14d4946fdf2))
+
 ## [2.3.0](https://github.com/aziontech/vulcan/compare/v2.2.0...v2.3.0) (2024-01-22)
 
 

package/lib/build/bundlers/{bundler-base.js → base.bunlders.js}

@@ -6,7 +6,7 @@ import merge from 'lodash.merge';
  * Base class for a bundler.
  * @class
  */
-class BundlerBase {
+class BaseBundlers {
   /**
    * Represents a configuration object.
    * @typedef {object} BuilderConfig
@@ -60,7 +60,7 @@ class BundlerBase {
     // This method can be overridden by subclasses
     // as it does not require the use of `this`
     // eslint-disable-next-line class-methods-use-this
-    throw new Error('Running BundlerBase run method');
+    throw new Error('Running BaseBundlers run method');
   }
 
   /**
@@ -98,4 +98,4 @@ class BundlerBase {
   }
 }
 
-export default BundlerBase;
+export default BaseBundlers;

package/lib/build/bundlers/esbuild/esbuild.bundlers.js

@@ -0,0 +1,73 @@
+import * as esbuild from 'esbuild';
+import lodash from 'lodash';
+
+import { Messages } from '#constants';
+import { debug } from '#utils';
+
+import BaseBundlers from '../base.bunlders.js';
+import AzionEsbuildConfig from './esbuild.config.js';
+import ESBuildNodeModulePlugin from './plugins/node-polyfills/index.js';
+import ESBuildAzionModulePlugin from './plugins/azion-polyfills/index.js';
+
+/**
+ * Class representing an ESBuild bundler, extending BaseBundlers.
+ */
+class Esbuild extends BaseBundlers {
+  /**
+   * Asynchronous method to run the ESBuild bundler.
+   */
+  async run() {
+    let config = lodash.cloneDeep(AzionEsbuildConfig);
+    config.entryPoints = [this.builderConfig.entry];
+
+    if (!config.plugins) config.plugins = [];
+
+    // merge config common
+    config = super.mergeConfig(config);
+    config = this.applyConfig(config);
+
+    try {
+      await esbuild.build(config);
+    } catch (error) {
+      debug.error(error);
+      throw Error(Messages.build.error.vulcan_build_failed);
+    }
+  }
+
+  /**
+   * Applies specific configurations to the ESBuild config.
+   * @param {object} config - ESBuild configuration object.
+   * @returns {object} - Updated ESBuild configuration object.
+   */
+  applyConfig(config) {
+    const updatedConfig = { ...config };
+    // use polyfill with useNodePolyfills and preset mode compute
+    const useNodePolyfills =
+      (this.builderConfig?.useNodePolyfills ||
+        this.customConfigPreset?.useNodePolyfills ||
+        this.customConfigLocal?.useNodePolyfills) &&
+      this.presetMode === 'compute';
+
+    if (!updatedConfig.plugins) updatedConfig.plugins = [];
+    if (useNodePolyfills) {
+      updatedConfig.plugins.push(ESBuildNodeModulePlugin(globalThis.buildProd));
+    }
+
+    // plugin resolve azion:
+    updatedConfig.plugins.push(ESBuildAzionModulePlugin(globalThis.buildProd));
+
+    // inject content in worker initial code.
+    if (this.builderConfig.contentToInject) {
+      const workerInitContent = this.builderConfig.contentToInject;
+
+      if (updatedConfig.banner?.js) {
+        updatedConfig.banner.js = `${updatedConfig.banner.js} ${workerInitContent}`;
+      } else {
+        updatedConfig.banner = { js: workerInitContent };
+      }
+    }
+    return updatedConfig;
+  }
+}
+
+export default Esbuild;

package/lib/build/bundlers/esbuild/{index.test.js → esbuild.bundlers.test.js}

@@ -1,6 +1,6 @@
 import fs from 'fs';
 import tmp from 'tmp';
-import Esbuild from './index.js';
+import Esbuild from './esbuild.bundlers.js';
 import AzionEsbuildConfig from './esbuild.config.js';
 
 // IN MILESECONDS

package/lib/build/bundlers/esbuild/index.js

@@ -1,69 +1,3 @@
-import * as esbuild from 'esbuild';
-import lodash from 'lodash';
-
-import { Messages } from '#constants';
-import { debug } from '#utils';
-
-import BundlerBase from '../bundler-base.js';
-import AzionEsbuildConfig from './esbuild.config.js';
-import ESBuildNodeModulePlugin from './plugins/node-polyfills/index.js';
-
-/**
- * Class representing an ESBuild bundler, extending BundlerBase.
- */
-class Esbuild extends BundlerBase {
-  /**
-   * Asynchronous method to run the ESBuild bundler.
-   */
-  async run() {
-    let config = lodash.cloneDeep(AzionEsbuildConfig);
-    config.entryPoints = [this.builderConfig.entry];
-
-    if (!config.plugins) config.plugins = [];
-
-    // merge config common
-    config = super.mergeConfig(config);
-    config = this.applyConfig(config);
-
-    try {
-      await esbuild.build(config);
-    } catch (error) {
-      debug.error(error);
-      throw Error(Messages.build.error.vulcan_build_failed);
-    }
-  }
-
-  /**
-   * Applies specific configurations to the ESBuild config.
-   * @param {object} config - ESBuild configuration object.
-   * @returns {object} - Updated ESBuild configuration object.
-   */
-  applyConfig(config) {
-    const updatedConfig = { ...config };
-    // use polyfill with useNodePolyfills and preset mode compute
-    const useNodePolyfills =
-      (this.builderConfig?.useNodePolyfills ||
-        this.customConfigPreset?.useNodePolyfills ||
-        this.customConfigLocal?.useNodePolyfills) &&
-      this.presetMode === 'compute';
-
-    if (useNodePolyfills) {
-      if (!updatedConfig.plugins) updatedConfig.plugins = [];
-      updatedConfig.plugins.push(ESBuildNodeModulePlugin(globalThis.buildProd));
-    }
-
-    // inject content in worker initial code.
-    if (this.builderConfig.contentToInject) {
-      const workerInitContent = this.builderConfig.contentToInject;
-
-      if (updatedConfig.banner?.js) {
-        updatedConfig.banner.js = `${updatedConfig.banner.js} ${workerInitContent}`;
-      } else {
-        updatedConfig.banner = { js: workerInitContent };
-      }
-    }
-    return updatedConfig;
-  }
-}
+import Esbuild from './esbuild.bundlers.js';
 
 export default Esbuild;

package/lib/build/bundlers/esbuild/plugins/azion-polyfills/azion-polyfills.plugins.js

@@ -0,0 +1,90 @@
+/* eslint-disable consistent-return */
+import fs from 'fs';
+import path from 'path';
+import PolyfillsManager from '../../../polyfills/index.js';
+
+/**
+ * ESBuild Azion Module Plugin for polyfilling node modules.
+ * @param {boolean} buildProd Parameter to identify whether the build is dev or prod
+ * @returns {object} - ESBuild plugin object.
+ */
+const ESBuildAzionModulePlugin = (buildProd) => {
+  const NAME = 'vulcan-azion-modules-polyfills';
+  const NAMESPACE = NAME;
+  const filter = /^azion:/;
+
+  return {
+    /**
+     * Name and setup of the ESBuild plugin.
+     * @param {object} build - ESBuild build object.
+     */
+    name: NAME,
+    setup: (build) => {
+      const polyfillManager = PolyfillsManager.buildPolyfills();
+
+      const options = build.initialOptions;
+
+      // external
+      if (buildProd) {
+        options.external = options.external || [];
+        [...polyfillManager.external].forEach(([key]) => {
+          if (/^[^:]+:/.test(key) && !options.external.includes(key)) {
+            options.external.push(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) => {
+        if (!buildProd && polyfillManager.external.has(args.path)) {
+          return {
+            path: args.path,
+            namespace: NAMESPACE,
+          };
+        }
+        if (!polyfillManager.external.has(args.path)) {
+          return;
+        }
+
+        // external bypass
+        if (
+          options?.external?.length > 0 &&
+          options?.external?.includes(args.path)
+        ) {
+          return;
+        }
+
+        return {
+          path: args.path,
+          namespace: NAMESPACE,
+        };
+      });
+
+      /**
+       * Load callback for node module files.
+       * @param {object} args - Arguments object.
+       * @returns {object} - Object with loader, contents, and resolve directory.
+       */
+      build.onLoad({ filter, namespace: NAMESPACE }, async (args) => {
+        if (!polyfillManager.external.has(args.path)) {
+          return;
+        }
+        const resolved = polyfillManager.external.get(args.path);
+        const contents = await fs.promises.readFile(resolved, 'utf8');
+        const resolveDir = path.dirname(resolved);
+
+        return {
+          loader: 'js',
+          contents,
+          resolveDir,
+        };
+      });
+    },
+  };
+};
+
+export default ESBuildAzionModulePlugin;

package/lib/build/bundlers/esbuild/plugins/azion-polyfills/azion-polyfills.plugins.test.js

@@ -0,0 +1,44 @@
+import * as esbuild from 'esbuild';
+import ESBuildAzionModulePlugin from './azion-polyfills.plugins.js';
+
+describe('Esbuild Azion Plugin', () => {
+  it('should resolve the azion module: as external', async () => {
+    const results = await esbuild.build({
+      write: false,
+      target: 'es2022',
+      format: 'esm',
+      platform: 'browser',
+      mainFields: ['browser', 'main', 'module'],
+      bundle: true,
+      minify: false,
+      stdin: {
+        contents: 'import storage from "azion:storage";',
+      },
+      plugins: [ESBuildAzionModulePlugin(true)],
+    });
+
+    expect(results.outputFiles.at(0)?.text.trim()).toContain(
+      'import storage from "azion:storage";',
+    );
+  });
+
+  it('should resolve the azion module: for local execution', async () => {
+    const results = await esbuild.build({
+      write: false,
+      target: 'es2022',
+      format: 'esm',
+      platform: 'browser',
+      mainFields: ['browser', 'main', 'module'],
+      bundle: true,
+      minify: false,
+      stdin: {
+        contents: 'import storage from "azion:storage";',
+      },
+      plugins: [ESBuildAzionModulePlugin(false)],
+    });
+
+    expect(results.outputFiles.at(0)?.text.trim()).toContain(
+      'vulcan-azion-modules-polyfills',
+    );
+  });
+});

package/lib/build/bundlers/esbuild/plugins/azion-polyfills/index.js

@@ -0,0 +1,3 @@
+import AzionPolyfillPlugin from './azion-polyfills.plugins.js';
+
+export default AzionPolyfillPlugin;

package/lib/build/bundlers/esbuild/plugins/node-polyfills/index.js

@@ -1,138 +1,3 @@
-/* eslint-disable consistent-return */
-import fs from 'fs';
-import path from 'path';
-import PolyfillsManager from '../../../polyfills/polyfills-manager.js';
+import NodePolyfillPlugin from './node-polyfills.plugins.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 = (buildProd) => {
-  const NAME = 'vulcan-node-modules-polyfills';
-  const NAMESPACE = NAME;
-
-  return {
-    /**
-     * Name and setup of the ESBuild plugin.
-     * @param {object} build - ESBuild build object.
-     */
-    name: NAME,
-    setup: (build) => {
-      const polyfillManager = PolyfillsManager.buildPolyfills();
-
-      // build options
-      const options = build.initialOptions;
-      options.define = options.define || {};
-      if (!options.define?.global) {
-        options.define.global = 'globalThis';
-      }
-
-      // define env
-      options.define = {
-        ...options.define,
-        'process.env.NODE_ENV': '"production"',
-        'process.env.NEXT_RUNTIME': JSON.stringify('edge'),
-        'process.env.NEXT_COMPUTE_JS': JSON.stringify(true),
-      };
-
-      // build inject
-      options.inject = options.inject || [];
-      if (polyfillManager.globals) {
-        [...polyfillManager.globals].forEach(([, value]) => {
-          options.inject.push(value);
-        });
-      }
-
-      // 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;
-        }
-
-        // alias bypass
-        options.alias = options.alias || {};
-        if (
-          Object.keys(options.alias)?.length > 0 &&
-          options?.alias[argsPath]
-        ) {
-          return;
-        }
-
-        // external bypass
-        if (
-          options?.external?.length > 0 &&
-          options?.external?.includes(argsPath)
-        ) {
-          return;
-        }
-
-        return {
-          path: args.path,
-          namespace: NAMESPACE,
-        };
-      });
-
-      /**
-       * Load callback for assets.
-       * @param {object} args - Arguments object.
-       * @returns {object} - Object with contents and loader type.
-       */
-      build.onLoad({ filter: /\.(txt|html)/ }, async (args) => {
-        const contents = await fs.promises.readFile(args.path, 'utf8');
-        return {
-          contents,
-          loader: 'text',
-        };
-      });
-
-      /**
-       * Load callback for node module files.
-       * @param {object} args - Arguments object.
-       * @returns {object} - Object with loader, contents, and resolve directory.
-       */
-      build.onLoad({ filter: /.*/, namespace: NAMESPACE }, async (args) => {
-        const argsPath = args.path.replace(/^node:/, '');
-
-        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);
-
-        return {
-          loader: 'js',
-          contents,
-          resolveDir,
-        };
-      });
-    },
-  };
-};
-
-export default ESBuildNodeModulePlugin;
+export default NodePolyfillPlugin;

package/lib/build/bundlers/esbuild/plugins/node-polyfills/node-polyfills.plugins.js

@@ -0,0 +1,148 @@
+/* eslint-disable consistent-return */
+import fs from 'fs';
+import path from 'path';
+import PolyfillsManager from '../../../polyfills/index.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 = (buildProd) => {
+  const NAME = 'vulcan-node-modules-polyfills';
+  const NAMESPACE = NAME;
+
+  return {
+    /**
+     * Name and setup of the ESBuild plugin.
+     * @param {object} build - ESBuild build object.
+     */
+    name: NAME,
+    setup: (build) => {
+      const polyfillManager = PolyfillsManager.buildPolyfills();
+
+      // build options
+      const options = build.initialOptions;
+      options.define = options.define || {};
+      if (!options.define?.global) {
+        options.define.global = 'globalThis';
+      }
+
+      // define env
+      options.define = {
+        ...options.define,
+        'process.env.NODE_ENV': '"production"',
+        'process.env.NEXT_RUNTIME': JSON.stringify('edge'),
+        'process.env.NEXT_COMPUTE_JS': JSON.stringify(true),
+      };
+
+      // build inject
+      options.inject = options.inject || [];
+      if (polyfillManager.globals) {
+        [...polyfillManager.globals].forEach(([, value]) => {
+          options.inject.push(value);
+        });
+      }
+
+      // external
+      if (buildProd) {
+        options.external = options.external || [];
+        [...polyfillManager.external].forEach(([key]) => {
+          if (!/^[^:]+:/.test(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) &&
+          !/^[^:]+:/.test(argsPath)
+        ) {
+          return {
+            path: args.path,
+            namespace: NAMESPACE,
+          };
+        }
+
+        if (!polyfillManager.libs.has(argsPath)) {
+          return;
+        }
+
+        // alias bypass
+        options.alias = options.alias || {};
+        if (
+          Object.keys(options.alias)?.length > 0 &&
+          options?.alias[argsPath]
+        ) {
+          return;
+        }
+
+        // external bypass
+        if (
+          options?.external?.length > 0 &&
+          options?.external?.includes(argsPath)
+        ) {
+          return;
+        }
+
+        return {
+          path: args.path,
+          namespace: NAMESPACE,
+        };
+      });
+
+      /**
+       * Load callback for assets.
+       * @param {object} args - Arguments object.
+       * @returns {object} - Object with contents and loader type.
+       */
+      build.onLoad({ filter: /\.(txt|html)/ }, async (args) => {
+        const contents = await fs.promises.readFile(args.path, 'utf8');
+        return {
+          contents,
+          loader: 'text',
+        };
+      });
+
+      /**
+       * Load callback for node module files.
+       * @param {object} args - Arguments object.
+       * @returns {object} - Object with loader, contents, and resolve directory.
+       */
+      build.onLoad({ filter: /.*/, namespace: NAMESPACE }, async (args) => {
+        const argsPath = args.path.replace(/^node:/, '');
+
+        let resolved = polyfillManager.libs.get(argsPath);
+
+        if (
+          !buildProd &&
+          polyfillManager.external.has(argsPath) &&
+          !/^[^:]+:/.test(argsPath)
+        ) {
+          resolved = polyfillManager.external.get(argsPath);
+        }
+
+        const contents = await fs.promises.readFile(resolved, 'utf8');
+        const resolveDir = path.dirname(resolved);
+
+        return {
+          loader: 'js',
+          contents,
+          resolveDir,
+        };
+      });
+    },
+  };
+};
+
+export default ESBuildNodeModulePlugin;

package/lib/build/bundlers/esbuild/plugins/node-polyfills/{index.test.js → node-polyfills.plugins.test.js}

@@ -1,5 +1,5 @@
 import * as esbuild from 'esbuild';
-import ESBuildNodeModulePlugin from './index.js';
+import ESBuildNodeModulePlugin from './node-polyfills.plugins.js';
 
 describe('Esbuild Node Plugin', () => {
   it('should check the env (NODE_ENV) in define options', async () => {

package/lib/build/bundlers/polyfills/index.js

@@ -0,0 +1,3 @@
+import PolyfillsManager from './polyfills-manager.js';
+
+export default new PolyfillsManager();

package/lib/build/bundlers/polyfills/polyfills-manager.js

@@ -148,7 +148,11 @@ class PolyfillsManager {
 
     this.setExternal(
       'async_hooks',
-      `${externalPolyfillsPath}/async_hooks/index.js`,
+      `${externalPolyfillsPath}/async-hooks/async-hooks.polyfills.js`,
+    );
+    this.setExternal(
+      'azion:storage',
+      `${externalPolyfillsPath}/azion/storage/storage.polyfills.js`,
     );
 
     return {
@@ -160,4 +164,4 @@ class PolyfillsManager {
   }
 }
 
-export default new PolyfillsManager();
+export default PolyfillsManager;

package/lib/build/bundlers/polyfills/polyfills-manager.test.js

@@ -1,5 +1,5 @@
 import { expect, it } from '@jest/globals';
-import PolyfillsManager from './polyfills-manager.js';
+import PolyfillsManager from './index.js';
 
 describe('Polyfills Manager', () => {
   it('Should return map of polyfills', () => {