edge-functions 1.1.0 → 1.3.0

package/.eslintrc.json

@@ -36,7 +36,7 @@
           ],
           [
             "#polyfills",
-            "./lib/polyfills/index.js"
+            "./lib/env/polyfills/index.js"
           ],
           [
             "#build",

package/README.md

@@ -1,5 +1,7 @@
 
 # Vulcan - Forging The Edge
+![vulcan](https://github.com/aziontech/vulcan/assets/12740219/a5043e6f-11cb-4498-a300-5bdb617a9989)
+
 
 Vulcan is a powerful tool designed to streamline the development and deployment of JavaScript applications and frameworks. This powerful utility automates polyfills for Edge Computing, significantly simplifying the process of creating Workers, particularly for the Azion platform.
 
@@ -45,6 +47,40 @@ Follow these steps to start using Vulcan:
 
 5. Start developing: Once the project is set up, you can start developing your JavaScript applications or frameworks using the power of Vulcan. Leverage the automated polyfills, Worker creation assistance, and other features provided by Vulcan to enhance your development workflow.
 
+## Using Vulcan
+
+See some examples below:
+
+* Build a JavaScript/Node project (back-end)
+
+   ```shell
+   vulcan build
+   ```
+   
+* Build a TypeScript/Node (back-end)
+
+   ```shell
+   vulcan build --preset typescript
+   ```
+   
+* Build a Static Next.js project
+
+   ```shell
+   vulcan build --preset next --mode deliver
+   ```
+   
+ * Build a Static Astro.js project
+
+   ```shell
+   vulcan build --preset astro --mode deliver
+   ```
+   
+* Test your project locally (after build)
+
+   ```shell
+   vulcan dev
+   ```
+
 
 ## Docs
 * [Overview](docs/overview.md)

package/aliases.js

@@ -2,7 +2,7 @@ export default [
   ['#root/*', './'],
   ['#lib/*', './lib'],
   ['#utils', './lib/utils/index.js'],
-  ['#polyfills', './lib/polyfills/index.js'],
+  ['#polyfills', './lib/env/polyfills/index.js'],
   ['#build', './lib/build/dispatcher/index.js'],
   ['#bundlers', './lib/build/bundlers/index.js'],
   ['#notations/*', './lib/notations'],

package/docs/overview.md

@@ -31,6 +31,7 @@ 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.
 
 ### Artifacts
-Files generated to run in azion structure:
-* js worker(s);
-* Storage assets files;
+The **'.edge'** folder will be generated representing the edge locally. Files generated to run on the infrastructure:
+* JS worker(s) => '.edge/workers.js';
+* Assets => '.edge/storage/*';
+* Environment variables => '.edge/.env'.

package/docs/presets.md

@@ -9,8 +9,9 @@ Vulcan is an extensible platform that allows you to easily create new presets fo
 To add a new preset, you need to create appropriate folders in two directories: `presets/default` or `presets/custom`. The folder representing your framework or library will automatically be included in the preset listings. Each preset has two modes, represented by folders of the same name: `compute` and `deliver`.
 
 
+https://github.com/aziontech/vulcan/assets/12740219/84c7d7a1-4167-4e7e-993f-41a6eb653758
+
 
-https://github.com/aziontech/vulcan/assets/12740219/06edb9a0-26cd-4055-bd2e-d400b6a06f3c
 
 
 
@@ -54,7 +55,18 @@ Each preset is made up of three primary files: `config.js`, `prebuild.js`, and `
 
 Here's a step-by-step guide on how to add a new preset in Vulcan:
 
-1.  ## **Create a folder inside `./lib/presets/custom`:**
+## **Use the command to automatic creation:**
+
+    vulcan presets create
+
+https://github.com/aziontech/vulcan/assets/12740219/9ca7371e-713a-4b29-a99b-c1a18d28bc67
+
+
+
+### Or do it manually:
+
+
+## 1. **Create a folder inside `./lib/presets/custom`:**
    https://github.com/aziontech/vulcan/assets/12740219/abb1b2cc-5f74-473d-b731-c0b7157cb95e
 
   -   The name of this folder should represent the name of your framework or library.
@@ -65,7 +77,7 @@ Here's a step-by-step guide on how to add a new preset in Vulcan:
 
 -   **Deliver**: This mode should be used when you intend to use the worker only for routing requests and delivering static files that will be computed on the client side.
         
-3.  ## **Create the following files in your preset's folder:**
+2.  ## **Create the following files in your preset's folder:**
     
     ##  handler.js
     This file contains the code that is executed within the worker in the edge function. Essentially, it is the code that runs directly on the edge. In the context of the `deliver` mode, this may simply act as a router. However, in cases where computation is needed, it can be designed to perform more complex tasks. Remember, the capabilities of your handler.js are dependent on your use case and the mode of operation you've chosen for your preset.
@@ -112,4 +124,4 @@ For `deliver` mode:
 
     vulcan build --preset <name> --mode deliver
 
-Replace `<name>` with the name of your preset. This will initiate Vulcan's build process for your preset, allowing you to verify its functionality.
+Replace `<name>` with the name of your preset. This will initiate Vulcan's build process for your preset, allowing you to verify its functionality.

package/jsconfig.json

@@ -12,7 +12,7 @@
         "./lib/utils/index.js"
       ],
       "#polyfills": [
-        "./lib/polyfills/index.js"
+        "./lib/env/polyfills/index.js"
       ],
       "#build": [
         "./lib/build/dispatcher/index.js"

package/lib/build/dispatcher/dispatcher.js

@@ -1,10 +1,12 @@
 import { join, resolve } from 'path';
 import {
-  readFileSync, readdirSync, existsSync, mkdirSync, writeFileSync, rmSync,
+  readFileSync, existsSync, mkdirSync, writeFileSync, rmSync,
 } from 'fs';
 import { fileURLToPath } from 'url';
 import { Esbuild, Webpack } from '#bundlers';
-import { feedback, generateTimestamp, getAbsoluteLibDirPath } from '#utils';
+import {
+  feedback, debug, generateTimestamp, getAbsoluteLibDirPath, presets,
+} from '#utils';
 import { Messages } from '#constants';
 
 const vulcanLibPath = getAbsoluteLibDirPath();
@@ -12,26 +14,10 @@ const vulcanRootPath = resolve(vulcanLibPath, '..');
 const isWindows = process.platform === 'win32';
 
 /**
- * Get the valid build presets based on the folders inside the presets/default
- * and presets/custom directories.
- * @returns {string[]} An array of valid build presets.
+ * Get the path corresponding to a specific alias defined in the package.json.
+ * @param {string} alias - The desired alias.
+ * @returns {string} The path corresponding to the alias.
  */
-function getValidPresets() {
-  const types = ['default', 'custom'];
-  const validPresets = [];
-
-  types.forEach((type) => {
-    const presetsPath = join(vulcanLibPath, 'presets', type);
-    const directories = readdirSync(presetsPath, { withFileTypes: true })
-      .filter((dirent) => dirent.isDirectory())
-      .map((dirent) => dirent.name);
-
-    validPresets.push(...directories);
-  });
-
-  return validPresets;
-}
-
 /**
  * Get the path corresponding to a specific alias defined in the package.json.
  * @param {string} alias - The desired alias.
@@ -83,13 +69,13 @@ function fixImportsAndRequestsPlace(entryContent) {
  * @returns {any} The context that will be used in build.
  */
 async function loadBuildContext(preset, entry, mode) {
-  const VALID_BUILD_PRESETS = getValidPresets().concat(',').slice(0, -1);
+  const VALID_BUILD_PRESETS = presets.getKeys();
+
   const validPreset = VALID_BUILD_PRESETS.includes(preset);
 
   if (!validPreset) {
-    throw Error(
-      `Invalid build preset. Available presets: ${VALID_BUILD_PRESETS}.`,
-    );
+    feedback.build.error(Messages.build.error.invalid_preset);
+    process.exit(1);
   }
 
   let configFilePath;
@@ -112,7 +98,7 @@ async function loadBuildContext(preset, entry, mode) {
     prebuildFilePath = join(modePath, 'prebuild.js');
     handlerFilePath = join(modePath, 'handler.js');
   } else {
-    feedback.build.error(`Mode '${mode}' does not exists in preset '${preset}'. Try 'deliver' or 'compute'.`);
+    feedback.build.error(Messages.build.error.invalid_preset_mode(mode, preset));
     process.exit(1);
   }
 
@@ -139,9 +125,15 @@ async function loadBuildContext(preset, entry, mode) {
   newEntryContent = newEntryContent.replace('#edge', edgehooksPath);
 
   if ((preset === 'javascript' || preset === 'typescript') && (mode === 'compute')) {
-    const filePath = join(process.cwd(), entry);
-    const entryContent = readFileSync(filePath, 'utf-8');
-    newEntryContent = newEntryContent.replace('__JS_CODE__', entryContent);
+    try {
+      const filePath = join(process.cwd(), entry);
+      const entryContent = readFileSync(filePath, 'utf-8');
+      newEntryContent = newEntryContent.replace('__JS_CODE__', entryContent);
+    } catch (error) {
+      feedback.build.error(Messages.errors.file_doesnt_exist(entry));
+      debug.error(error);
+      process.exit(1);
+    }
   }
 
   newEntryContent = fixImportsAndRequestsPlace(newEntryContent);
@@ -201,8 +193,6 @@ class Dispatcher {
    */
   run = async () => {
     // Load Context based on preset
-    feedback.prebuild.info(Messages.build.info.prebuild_starting);
-
     const { entryContent, prebuild, config } = await loadBuildContext(
       this.preset,
       this.entry,
@@ -223,42 +213,48 @@ class Dispatcher {
     };
 
     // Run prebuild actions
-    await prebuild(buildContext); // TODO: send context to prebuild
-    feedback.prebuild.success(Messages.build.success.prebuild_succeeded);
-    feedback.prebuild.info(Messages.build.info.vulcan_build_starting);
-
-    // create tmp entrypoint
-    const currentDir = process.cwd();
-    let tempEntryFile = `vulcan-${buildId}.temp.`;
-    tempEntryFile += (this.preset === 'typescript') ? 'ts' : 'js';
-    const tempBuilderEntryPath = join(currentDir, tempEntryFile);
-
-    writeFileSync(tempBuilderEntryPath, entryContent);
-
-    // builder entry
-    config.entry = tempBuilderEntryPath;
-    config.buildId = buildId;
-    config.useNodePolyfills = this.useNodePolyfills;
-
-    let builder;
-    switch (config.builder) {
-      case 'webpack':
-        builder = new Webpack(config);
-        break;
-      case 'esbuild':
-        builder = new Esbuild(config);
-        break;
-      default:
-        builder = new Webpack(config);
-        break;
+    try {
+      feedback.prebuild.info(Messages.build.info.prebuild_starting);
+      await prebuild(buildContext);
+      feedback.prebuild.success(Messages.build.success.prebuild_succeeded);
+
+      feedback.build.info(Messages.build.info.vulcan_build_starting);
+      // create tmp entrypoint
+      const currentDir = process.cwd();
+      let tempEntryFile = `vulcan-${buildId}.temp.`;
+      tempEntryFile += (this.preset === 'typescript') ? 'ts' : 'js';
+      const tempBuilderEntryPath = join(currentDir, tempEntryFile);
+
+      writeFileSync(tempBuilderEntryPath, entryContent);
+
+      // builder entry
+      config.entry = tempBuilderEntryPath;
+      config.buildId = buildId;
+      config.useNodePolyfills = this.useNodePolyfills;
+
+      let builder;
+      switch (config.builder) {
+        case 'webpack':
+          builder = new Webpack(config);
+          break;
+        case 'esbuild':
+          builder = new Esbuild(config);
+          break;
+        default:
+          builder = new Webpack(config);
+          break;
+      }
+
+      // Run common build
+      await builder.run();
+
+      // delete .temp files
+      rmSync(tempBuilderEntryPath);
+      feedback.build.success(Messages.build.success.vulcan_build_succeeded);
+    } catch (error) {
+      debug.error(error);
+      process.exit(1);
     }
-
-    // Run common build
-    await builder.run();
-
-    // delete .temp files
-    rmSync(tempBuilderEntryPath);
-    feedback.build.success(Messages.build.success.vulcan_build_succeeded);
   };
 }
 

package/lib/constants/framework-initializer.constants.js

@@ -0,0 +1,51 @@
+/**
+ * FrameworkInitializer contains various methods to initialize new projects
+ * in different JavaScript frameworks.
+ *
+ * Each method is an asynchronous function that takes a `projectName` as an argument.
+ * This `projectName` is then used to initialize a new project in the respective framework.
+ * @namespace FrameworkInitializer
+ * @typedef {object} FrameworkInitializer
+ * @property {Function} Angular - Initializes a new Angular project.
+ * @property {Function} Astro - Initializes a new Astro project.
+ * @property {Function} Hexo - Initializes a new Hexo project.
+ * @property {Function} Next - Initializes a new Next.js project.
+ * @property {Function} React - Initializes a new React project.
+ * @property {Function} Vue - Initializes a new Vue project.
+ * @property {Function} Vite - Initializes a new Vue project with Vite.
+ * @example
+ * const { Angular, React } = FrameworkInitializer;
+ *
+ * // Initialize a new Angular project called 'myAngularProject'
+ * await Angular('myAngularProject');
+ *
+ * // Initialize a new React project called 'myReactProject'
+ * await React('myReactProject');
+ */
+import { exec } from '#utils';
+
+const FrameworkInitializer = {
+  Angular: async (projectName) => {
+    await exec(`npx ng new ${projectName}`, 'Angular', false, true);
+  },
+  Astro: async (projectName) => {
+    await exec(`npx create-astro ${projectName}`, 'Astro', false, true);
+  },
+  Hexo: async (projectName) => {
+    await exec(`npx hexo init ${projectName}`, 'Hexo', false, true);
+  },
+  Next: async (projectName) => {
+    await exec(`npx create-next-app ${projectName}`, 'Next', false, true);
+  },
+  React: async (projectName) => {
+    await exec(`npx create-react-app ${projectName}`, 'React', false, true);
+  },
+  Vue: async (projectName) => {
+    await exec(`npx vue create ${projectName}`, 'Vue', false, true);
+  },
+  Vite: async (projectName) => {
+    await exec(`npx create-vue ${projectName}`, 'Vue/Vite', false, true);
+  },
+};
+
+export default FrameworkInitializer;

package/lib/constants/index.js

@@ -1,5 +1,8 @@
 import RuntimeApis from './runtime-apis.constants.js';
 import AzionEdges from './azion-edges.constants.js';
 import Messages from './messages/index.js';
+import FrameworkInitializer from './framework-initializer.constants.js';
 
-export { AzionEdges, RuntimeApis, Messages };
+export {
+  AzionEdges, RuntimeApis, Messages, FrameworkInitializer,
+};

package/lib/constants/messages/build.messages.js

@@ -16,6 +16,8 @@ const build = {
   },
   error: {
     vulcan_build_failed: 'Vulcan build failed.',
+    invalid_preset: 'Invalid build preset. Run "vulcan preset ls" to view available presets.',
+    invalid_preset_mode: (mode, preset) => `Mode '${mode}' does not exists in preset '${preset}'. Try 'deliver' or 'compute'.`,
   },
 
 };

package/lib/constants/messages/global.messages.js

@@ -6,9 +6,12 @@ Global messages object.
  */
 const global = {
   success: {},
-  info: {},
+  info: {
+    name_required: 'A name is required.',
+  },
   errors: {
     unknown_error: 'An error occurred.',
+    invalid_choice: 'Invalid choice.',
     folder_creation_failed: (folder) => `An error occurred while creating the ${folder} folder.`,
     write_file_failed: (file) => `An error occurred while writing the ${file} file.`,
     file_doesnt_exist: (file) => `An error occurred while reading the ${file} file.`,

package/lib/env/polyfills/FetchEvent.polyfills.js

@@ -0,0 +1,13 @@
+import primitives from '@edge-runtime/primitives';
+import { feedback } from '#utils';
+
+class FetchEventPolyfill extends primitives.FetchEvent {
+  constructor(request) {
+    super(request);
+    this.console = {
+      log: (log) => feedback.server.log(log),
+    };
+  }
+}
+
+export default FetchEventPolyfill;

package/lib/env/polyfills/fetch.polyfills.js

@@ -0,0 +1,39 @@
+import { join } from 'path';
+import { readFileSync } from 'fs';
+import mime from 'mime-types';
+import { EdgeRuntime } from 'edge-runtime';
+
+/**
+ * A custom fetch implementation that adds an additional path to the URL if it starts with 'file://'.
+ * This function is used to simulate the local edge environment. When a 'file://' request is made,
+ * it behaves as if the request is made from within the edge itself. In this case, an additional
+ * '.edge/storage' folder is appended to the URL to represent the edge environment.
+ * @param {EdgeRuntime} context - VMContext
+ * @param {URL} url - The URL to fetch.
+ * @param {object} [options] - The fetch options.
+ * @returns {Promise<Response>} A Promise that resolves to the Response object.
+ */
+async function fetchPolyfill(context, url, options) {
+  const {
+    URL, Headers, Response,
+  } = context;
+
+  const urlOBJ = new URL(url);
+  if (urlOBJ.href.startsWith('file://')) {
+    // url pathname = /VERSION_ID/filePath
+    const file = url.pathname.slice(15);
+    const filePath = join(process.cwd(), '.edge', 'storage', file);
+    const fileContent = readFileSync(filePath);
+    const contentType = mime.lookup(filePath) || 'application/octet-stream';
+
+    const headers = new Headers();
+    headers.append('Content-Type', contentType);
+
+    const response = new Response(fileContent, { headers, ...options });
+    return response;
+  }
+
+  return fetch(url, options);
+}
+
+export default fetchPolyfill;

package/lib/env/polyfills/index.js

@@ -0,0 +1,4 @@
+import fetchPolyfill from './fetch.polyfills.js';
+import FetchEventPolyfill from './FetchEvent.polyfills.js';
+
+export { fetchPolyfill, FetchEventPolyfill };

package/lib/env/runtime.env.js

@@ -1,6 +1,6 @@
 import { EdgeRuntime } from 'edge-runtime';
 
-import { fetchPolyfill, FetchEventPolyfill } from '#polyfills';
+import { fetchPolyfill, FetchEventPolyfill } from './polyfills/index.js';
 
 /**
  * Executes the specified JavaScript code within a sandbox environment,
@@ -39,6 +39,14 @@ function runtime(code) {
     context.fetch = (url, options) => fetchPolyfill(context, url, options);
     context.FetchEvent = FetchEventPolyfill;
     context.FirewallEvent = {}; // TODO: Firewall Event
+    /*
+     * According to the Vercel documentation at https://vercel.com/docs/concepts/functions/edge-functions/edge-runtime#unsupported-apis,
+     * the default runtime doesn't support `eval`.
+     * However, in our Runtime environment (Cells Runtime/Azion)
+     * we've enabled and support its functionality.
+     */
+    // eslint-disable-next-line no-eval
+    context.eval = eval;
 
     /* ==== Cells Runtime/Azion does not have this interface ==== */
     context.File = undefined;