edge-functions 2.5.0 → 2.6.0-stage.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [2.6.0-stage.1](https://github.com/aziontech/vulcan/compare/v2.5.0...v2.6.0-stage.1) (2024-03-05)
+
+
+### Features
+
+* add support to network list api ([#260](https://github.com/aziontech/vulcan/issues/260)) ([79c20be](https://github.com/aziontech/vulcan/commit/79c20be283c32829a9eb2a1db2b0996bb3246d83))
+
 ## [2.5.0](https://github.com/aziontech/vulcan/compare/v2.4.0...v2.5.0) (2024-02-28)
 
 

package/README.md

@@ -91,7 +91,7 @@ Here's a detailed breakdown of the configuration properties available in `vulcan
 
 **Type:** String
 
-**Description:**  
+**Description:**
 This represents the primary entry point for your application, where the building process begins.
 
 **Note:** `Entry` will be ignored for jamstack solutions.
@@ -100,28 +100,28 @@ This represents the primary entry point for your application, where the building
 
 **Type:** String ('esbuild' or 'webpack')
 
-**Description:**  
+**Description:**
 Defines which build tool to use. The available options are `esbuild` and `webpack`.
 
 ### UseNodePolyfills
 
 **Type:** Boolean
 
-**Description:**  
+**Description:**
 Determines whether Node.js polyfills should be applied. This is useful for projects that leverage specific Node.js functionality but target environments without these built-in features. The use of useNodePolyfills is ignored when used in mode `deliver` presets, as Node.js features must be resolved at build time by the framework process itself.
 
 ### UseOwnWorker
 
 **Type:** Boolean
 
-**Description:**  
+**Description:**
 This flag indicates that the constructed code inserts its own worker expression, such as `addEventListener("fetch")` or similar, without the need to inject a provider.
 
 ### Preset
 
 **Type:** Object
 
-**Description:**  
+**Description:**
 Provides preset-specific configurations.
 
 - **Name (Type: String):** Refers to the preset name, e.g., "vue" or "next".
@@ -131,7 +131,7 @@ Provides preset-specific configurations.
 
 **Type:** Object
 
-**Description:**  
+**Description:**
 Configurations related to the in-memory filesystem.
 
 - **InjectionDirs (Type: Array of Strings):** Directories to be injected into memory for runtime access via the fs API.
@@ -142,7 +142,7 @@ Configurations related to the in-memory filesystem.
 
 **Type:** Object
 
-**Description:**  
+**Description:**
 Allows you to extend the capabilities of the chosen bundler (either `webpack` or `esbuild`) with custom plugins or configurations.
 
 - **Plugins (Type: Object):** Add your custom plugins for your chosen bundler here.
@@ -177,8 +177,12 @@ module.exports = {
 
 - [Overview](docs/overview.md)
 - [Presets](docs/presets.md)
+- [Nextjs](docs/nextjs.md)
 - [Rust/Wasm example](examples/rust-wasm-yew-ssr/)
 - [Emscripten/Wasm example](examples/emscripten-wasm/)
+- [Env vars example](examples/simple-js-env-vars)
+- [Storage example](examples/simple-js-esm-storage)
+- [Firewall example](examples/simple-js-firewall-event)
 
 ## Wasm Notes
 

package/docs/nextjs.md

@@ -0,0 +1,66 @@
+# Nextjs Support
+
+Vulcan supports Nextjs in compute and deliver modes.
+
+## Deliver
+
+Static site delivered by edge without a function.
+Check static examples in [Nextjs examples dir](/examples//next/) for more details.
+
+### References
+
+- [Pages Router - Static Export](https://nextjs.org/docs/pages/building-your-application/deploying/static-exports)
+- [App Router - Static Export](https://nextjs.org/docs/app/building-your-application/deploying/static-exports)
+
+## Compute
+
+In compute mode the nextjs handler uses a routing system (based on vercel multiple steps routing) to handle the request.
+
+After a route match in the routing system takes one of these actions:
+
+- deliver a static;
+- make a request override;
+- call a builded edge module;
+- call a node custom server;
+
+This solution was created based on fastly ([next-compute-js v1](https://github.com/fastly/next-compute-js)) and cloudflare ([next-on-pages](https://github.com/cloudflare/next-on-pages)) Nextjs solutions.
+
+Check edge or node examples in [Nextjs examples dir](/examples//next/) for more details.
+
+### Supported Features
+
+| Runtime | Versions                                       | Format/Router | Feature                                                                                                                                          |
+| ------- | ---------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Edge    | 12.2.x, 12.3.x                                 | Pages Router  | Static Pages                                                                                                                                     |
+|         |                                                |               | SSR                                                                                                                                              |
+|         |                                                |               | SSG                                                                                                                                              |
+|         |                                                |               | Edge API Routes                                                                                                                                  |
+|         |                                                |               | Dynamic Routes                                                                                                                                   |
+|         |                                                |               | Middleware (rewrite, redirect, continue to response, set request header, throw error, set response header, set response cookie)                  |
+|         |                                                |               | Next configs (rewrite before files, rewrite after files, rewrite fallback, redirects, header definition)                                         |
+|         |                                                |               | i18n routing                                                                                                                                     |
+| Edge    | 13.0.x, 13.1.x, 13.2.x, 13.3.x, 13.4.x, 13.5.x | Pages Router  | Static Pages                                                                                                                                     |
+|         |                                                |               | SSR                                                                                                                                              |
+|         |                                                |               | SSG                                                                                                                                              |
+|         |                                                |               | Edge API Routes                                                                                                                                  |
+|         |                                                |               | Dynamic Routes                                                                                                                                   |
+|         |                                                |               | Middleware (rewrite, redirect, continue to response, set request header, throw error, return response, set response header, set response cookie) |
+|         |                                                |               | Next configs (rewrite before files, rewrite after files, rewrite fallback, redirects, header definition)                                         |
+|         |                                                |               | i18n routing                                                                                                                                     |
+|         |                                                |               | Custom Errors                                                                                                                                    |
+| Edge    | 13.0.x, 13.1.x, 13.2.x, 13.3.x, 13.4.x, 13.5.x | App Router    | App router (basic structure, routing, layouts)                                                                                                   |
+|         |                                                |               | Server Components                                                                                                                                |
+|         |                                                |               | Route Handlers                                                                                                                                   |
+|         |                                                |               | Dynamic Routes                                                                                                                                   |
+|         |                                                |               | Middleware (rewrite, redirect, continue to response, set request header, throw error, return response, set response header, set response cookie) |
+|         |                                                |               | Next configs (rewrite before files, rewrite after files, redirects, header definition)                                                           |
+|         |                                                |               | Internationalization                                                                                                                             |
+|         |                                                |               | Custom Errors (error.js and not-found.js)                                                                                                        |
+| Node    | 12.3.x                                         | Pages Router  | Static Pages                                                                                                                                     |
+|         |                                                |               | SSR                                                                                                                                              |
+|         |                                                |               | SSG                                                                                                                                              |
+|         |                                                |               | API Routes                                                                                                                                       |
+|         |                                                |               | Dynamic Routes                                                                                                                                   |
+|         |                                                |               | Next configs (rewrite before files, rewrite after files, rewrite fallback, redirects, header definition)                                         |
+|         |                                                |               | i18n routing                                                                                                                                     |
+|         |                                                |               | Custom Errors                                                                                                                                    |

package/docs/overview.md

@@ -8,7 +8,8 @@ flowchart LR
 A[Trigger] -->|args| B(Dispatcher)
 B --> C(Prebuild)
 C -->|args| D(Common Build)
-D --> E[Artifacts]
+D --> E(Postbuild)
+E --> F[Artifacts]
 ```
 
 ### Trigger
@@ -35,6 +36,10 @@ Polyfills can be used to generate the worker(s) file(s).
 
 Some configs can be passed to the builder but if user tries to override `azion worker configs` this passed configs will be ignored.
 
+### Post Build
+
+Optional step to run post build actions after common build (bundlers action).
+
 ### Artifacts
 
 The **'.edge'** folder will be generated representing the edge locally. Files generated to run on the infrastructure:
@@ -42,3 +47,5 @@ The **'.edge'** folder will be generated representing the edge locally. Files ge
 - JS worker(s) => '.edge/workers.js';
 - Assets => '.edge/storage/\*';
 - Environment variables => '.edge/.env'.
+
+The **'.vulcan'** file also will be generated. This file contains build infos that can be used by local env or other tools.

package/docs/presets.md

@@ -37,6 +37,8 @@ Each preset is made up of three primary files: `config.js`, `prebuild.js`, and `
     - mountSSG: This function takes the request and sets up routes according to the SSG structure.
     - ErrorHTML: This edgehook provides a return of an HTML template showing the error and the description passed as a parameter. You can pass the captured error as the third parameter, and it will be displayed on the screen (it's a good way to debug).
 
+4.  `postbuild.js`: this file is optional. Here you can run actions after the common build done by bundlers.
+
 # How to add a new preset
 
 Here's a step-by-step guide on how to add a new preset in Vulcan:

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

@@ -161,9 +161,13 @@ class PolyfillsManager {
 
     // globalThis.Azion
     this.setExternal(
-      'Azion',
+      'Azion.env',
       `${externalPolyfillsPath}/azion/env-vars/env-vars.polyfills.js`,
     );
+    this.setExternal(
+      'Azion.networkList',
+      `${externalPolyfillsPath}/azion/network-list/network-list.polyfills.js`,
+    );
 
     return {
       libs: this.libs,

package/lib/env/polyfills/azion/network-list/context/index.js

@@ -0,0 +1,3 @@
+import NetworkListContext from './network-list.context.js';
+
+export default NetworkListContext;

package/lib/env/polyfills/azion/network-list/context/network-list.context.js

@@ -0,0 +1,232 @@
+import ipLib from 'ip';
+import nodePath from 'node:path';
+import { readFileSync, rmSync, writeFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { fileURLToPath } from 'node:url';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * This class is a VM context (NETWORK_LIST_CONTEXT) to handle with network list
+ * @class NetworkListContext
+ * @description Class to manage the network list
+ */
+class NetworkListContext {
+  /**
+   * Cache Dynamic Import flag - If true, the file will be reloaded every time default: true
+   */
+  #cacheDynamicImport;
+
+  #networkList = [];
+
+  #workDir = '.edge';
+
+  #configFile = 'azion.config.js';
+
+  /**
+   * Creates an instance of NetworkListContext.
+   * @param {boolean} [cacheDynamicImport=true] - Cache Dynamic Import flag - If false, the file will be reloaded every time default: true
+   */
+  constructor(cacheDynamicImport = true) {
+    this.#cacheDynamicImport = cacheDynamicImport;
+    this.#init();
+  }
+
+  /**
+   * Check if the network list contains the value
+   * @param {string} networkListId - The network list id
+   * @param {string} value - The value to check
+   * @returns {boolean} - Return true if the network list contains the value
+   * @memberof NetworkListContext
+   */
+  contains(networkListId, value) {
+    const network = this.#networkList.find(
+      (networkItem) =>
+        parseInt(networkItem.id, 10) === parseInt(networkListId, 10),
+    );
+    return this.#containsType(network, value);
+  }
+
+  #containsType(network, value) {
+    switch (network?.listType) {
+      case 'ip_cidr':
+        return this.#networkCIDR(value, network);
+      case 'asn':
+        return this.#networkAsn(value, network);
+      case 'countries':
+        return this.#networkCountries(value, network);
+      default:
+        return false;
+    }
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  #networkCIDR(ipAddress, network) {
+    const listContent = network?.listContent;
+    if (!listContent || listContent.length === 0) return false;
+    return listContent.some((currentIp) => {
+      if (currentIp.includes('/')) {
+        return ipLib.cidrSubnet(currentIp).contains(ipAddress);
+      }
+      return currentIp === ipAddress;
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  #networkAsn(asn, network) {
+    const listContent = network?.listContent;
+    if (!listContent || listContent.length === 0) return false;
+    return listContent.some((currentAsn) => {
+      return parseInt(currentAsn, 10) === parseInt(asn, 10);
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  #networkCountries(country, network) {
+    const listContent = network?.listContent;
+    if (!listContent || listContent.length === 0) return false;
+    return listContent.some((currentCountry) => {
+      return currentCountry === country;
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async #init() {
+    try {
+      const config = await this.#loadConfigFile();
+      this.#networkList = config.networkList;
+    } catch (error) {
+      this.#networkList = [];
+    }
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async #loadConfigFile() {
+    const { configFilePath, rootPath } = this.#getConfigFilePath();
+
+    const {
+      type: typeImport,
+      changed,
+      currentConfigPath,
+      matchPaths,
+    } = this.#checkFileImportType(configFilePath);
+
+    let config;
+    if (typeImport === 'esm') {
+      config = await this.#importEsmModule(
+        rootPath,
+        currentConfigPath,
+        changed,
+      );
+    } else {
+      config = await this.#importCjsModule(
+        rootPath,
+        currentConfigPath,
+        changed,
+        matchPaths,
+      );
+    }
+
+    return config?.default || config;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  #getConfigFilePath() {
+    const projectRoot = process.cwd();
+    const isWindows = process.platform === 'win32';
+    const rootPath = isWindows
+      ? fileURLToPath(new URL(`file:///${nodePath.resolve(projectRoot, '.')}`))
+      : nodePath.resolve(projectRoot, '.');
+    return {
+      configFilePath: nodePath.resolve(rootPath, this.#configFile),
+      rootPath,
+    };
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async #importEsmModule(rootPath, originalConfigPath, changed) {
+    let pathCache = originalConfigPath;
+    if (!this.#cacheDynamicImport) {
+      pathCache = `${originalConfigPath}?u=${Date.now()}`;
+    }
+    const config = (await import(pathCache)).default;
+    if (changed) {
+      rmSync(originalConfigPath);
+    }
+    return config;
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async #importCjsModule(rootPath, configFilePath, changed, matchPaths) {
+    if (!this.#cacheDynamicImport) {
+      delete require.cache[configFilePath];
+      if (changed && matchPaths?.length > 0) {
+        matchPaths.forEach((match) => {
+          delete require.cache[nodePath.resolve(rootPath, match)];
+        });
+      }
+    }
+    return new Promise((resolve) => {
+      // eslint-disable-next-line import/no-dynamic-require
+      resolve(require(configFilePath));
+    });
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  #checkFileImportType(originalConfigPath) {
+    const file = readFileSync(originalConfigPath, 'utf8');
+    if (file?.includes('export default')) {
+      const { changed, currentConfigPath } = this.#changeEsmImports(
+        originalConfigPath,
+        file,
+      );
+      return { type: 'esm', changed, currentConfigPath };
+    }
+    const { changed, matchPaths } = this.#changeCjsImports(file);
+    return {
+      type: 'cjs',
+      changed,
+      currentConfigPath: originalConfigPath,
+      matchPaths,
+    };
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  #changeEsmImports(originalConfigPath, file) {
+    const regex = /import\s+(.*)\s+from\s+['"]\.(.*)['"]/g;
+    let changed = false;
+    let fileUpdated = file;
+    if (file.match(regex)) {
+      changed = true;
+      fileUpdated = file.replace(
+        regex,
+        `import $1 from "..$2?u=${Date.now()}"`,
+      );
+      const tmpFile = this.#configFile.replace('.js', '.temp.js');
+      const tmpConfigPath = nodePath.join(
+        process.cwd(),
+        this.#workDir,
+        tmpFile,
+      );
+      writeFileSync(tmpConfigPath, fileUpdated, 'utf8');
+      return { changed, currentConfigPath: tmpConfigPath };
+    }
+    return { changed, currentConfigPath: originalConfigPath };
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  #changeCjsImports(file) {
+    let changed = false;
+    const regex = /require\(['"]([^'"]+)['"]\)/g;
+    const matchPaths = [];
+    let match = regex.exec(file);
+    while (match !== null) {
+      changed = true;
+      matchPaths.push(match[1]);
+      match = regex.exec(file);
+    }
+    return { changed, matchPaths };
+  }
+}
+
+export default NetworkListContext;

package/lib/env/polyfills/azion/network-list/context/network-list.context.test.js

@@ -0,0 +1,44 @@
+import { it } from '@jest/globals';
+import mockFs from 'mock-fs';
+import NetworkListContext from './network-list.context.js';
+
+describe('Network List Context', () => {
+  let networkListContext;
+
+  beforeEach(async () => {
+    // eslint-disable-next-line jest/no-standalone-expect
+    const typeImport = expect.getState().currentTestName.includes('commonjs')
+      ? 'module.exports ='
+      : 'export default';
+    const code = `${typeImport} {
+        networkList:  [
+            { id: 1, listType: "ip_cidr", listContent: ["10.0.0.1"] },
+            { id: 2, listType: "asn", listContent: [123, 456, 789]},
+            { id: 3, listType: "countries", listContent: ["United States", "Brazil"]}
+        ]};`;
+    mockFs({
+      'azion.config.js': code,
+    });
+    networkListContext = new NetworkListContext();
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+  });
+
+  it('should contain the valid ip in the network list and list type is ip_cidr', async () => {
+    expect(networkListContext.contains(1, '10.0.0.1')).toBe(true);
+  });
+
+  it('should contain the valid asn in the network list and list type is asn', async () => {
+    expect(networkListContext.contains(2, 123)).toBe(true);
+  });
+
+  it('should contain the valid country in the network list and list type is countries', async () => {
+    expect(networkListContext.contains(3, 'United States')).toBe(true);
+  });
+
+  it('should type import be commonjs and contain the valid ip in the network list and list type is ip_cidr', async () => {
+    expect(networkListContext.contains(1, '10.0.0.1')).toBe(true);
+  });
+});

package/lib/env/polyfills/azion/network-list/index.js

@@ -0,0 +1,3 @@
+import NetworkListContext from './context/index.js';
+
+export default NetworkListContext;

package/lib/env/polyfills/azion/network-list/network-list.polyfills.js

@@ -0,0 +1,16 @@
+/* eslint-disable */
+globalThis.Azion = globalThis.Azion || {};
+
+globalThis.Azion.networkList = {};
+// unique context for each instance
+const instanceNetworkList = new NETWORK_LIST_CONTEXT(false);
+
+/**
+ *
+ * @param {string} network_list_id - The network list id
+ * @param {string} value - The value to check
+ * @returns
+ */
+globalThis.Azion.networkList.contains = (network_list_id, value) => {
+  return instanceNetworkList.contains(network_list_id, value);
+};

package/lib/env/polyfills/index.js

@@ -3,6 +3,7 @@ import FetchEventContext from './azion/fetch-event/index.js';
 import { AsyncHooksContext } from './async-hooks/index.js';
 import { StorageContext } from './azion/storage/index.js';
 import EnvVarsContext from './azion/env-vars/index.js';
+import NetworkListContext from './azion/network-list/index.js';
 
 export {
   fetchContext,
@@ -10,4 +11,5 @@ export {
   AsyncHooksContext,
   StorageContext,
   EnvVarsContext,
+  NetworkListContext,
 };

package/lib/env/runtime.env.js

@@ -6,6 +6,7 @@ import {
   AsyncHooksContext,
   StorageContext,
   EnvVarsContext,
+  NetworkListContext,
 } from './polyfills/index.js';
 import FirewallEventContext from './polyfills/azion/firewall-event/index.js';
 
@@ -77,6 +78,9 @@ function runtime(code, isFirewallEvent = false) {
     // EnvVars Context
     context.ENV_VARS_CONTEXT = EnvVarsContext;
 
+    // Network List Context
+    context.NETWORK_LIST_CONTEXT = NetworkListContext;
+
     return context;
   };
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "edge-functions",
   "type": "module",
-  "version": "2.5.0",
+  "version": "2.6.0-stage.1",
   "description": "Tool to launch and build JavaScript/Frameworks. This tool automates polyfills for Edge Computing and assists in creating Workers, notably for the Azion platform.",
   "main": "lib/main.js",
   "bin": {
@@ -68,6 +68,7 @@
     "https-browserify": "^1.0.0",
     "inquirer": "^9.2.7",
     "install": "^0.13.0",
+    "ip": "^2.0.1",
     "lodash": "^4.17.21",
     "lodash.merge": "^4.6.2",
     "log-update": "^5.0.1",