edge-functions 1.0.0

package/lib/constants/azion-edges.constants.js

@@ -0,0 +1,98 @@
+const AzionEdges = [
+  'Africa, Angola, Luanda (LAD)',
+  'Asia, China, Hong Kong - (HKG)',
+  'Europe, France, Paris (CDG)',
+  'Europe, Germany, Frankfurt (FRA)',
+  'Europe, Italy, Milan (MXP)',
+  'Europe, London, United Kingdom (LYC)',
+  'Europe, Spain, Madrid (MAD)',
+  'Europe, Sweden, Stockholm (ARN)',
+  'Latin America, Argentina, Buenos Aires 1 (AEP)',
+  'Latin America, Argentina, Buenos Aires 2 (AEP)',
+  'Latin America, Brazil, Aracaju 1 (AJU)',
+  'Latin America, Brazil, Aracaju 2 (AJU)',
+  'Latin America, Brazil, Barueri (CGH)',
+  'Latin America, Brazil, Belem (BEL)',
+  'Latin America, Brazil, Belo Horizonte 1 (PLU)',
+  'Latin America, Brazil, Belo Horizonte 2 (PLU)',
+  'Latin America, Brazil, Belo Horizonte 3 (PLU)',
+  'Latin America, Brazil, Brasília (BSB)',
+  'Latin America, Brazil, Campo Grande (CGR)',
+  'Latin America, Brazil, Campinas (VCP)',
+  'Latin America, Brazil, Cotia (CGH)',
+  'Latin America, Brazil, Cuiabá 1 (CGB)',
+  'Latin America, Brazil, Cuiabá 2 (CGB)',
+  'Latin America, Brazil, Curitiba 1 (CWB)',
+  'Latin America, Brazil, Curitiba 2 (CWB)',
+  'Latin America, Brazil, Florianópolis 1 (FLN)',
+  'Latin America, Brazil, Florianópolis 2 (FLN)',
+  'Latin America, Brazil, Fortaleza 1 (FOR)',
+  'Latin America, Brazil, Fortaleza 2 (FOR)',
+  'Latin America, Brazil, Fortaleza 3 (FOR)',
+  'Latin America, Brazil, Franca (FRC)',
+  'Latin America, Brazil, Goiania (GYN)',
+  'Latin America, Brazil, João Pessoa (JPA)',
+  'Latin America, Brazil, Juazeiro do Norte (JDO)',
+  'Latin America, Brazil, Linhares (VIX)',
+  'Latin America, Brazil, Londrina (LDB)',
+  'Latin America, Brazil, Macapá 1 (MCP)',
+  'Latin America, Brazil, Macapá 2 (MCP)',
+  'Latin America, Brazil, Maceió (MCZ)',
+  'Latin America, Brazil, Manaus 1 (MAO)',
+  'Latin America, Brazil, Manaus 2 (MAO)',
+  'Latin America, Brazil, Natal (NAT)',
+  'Latin America, Brazil, Osasco (CGH)',
+  'Latin America, Brazil, Porto Alegre 1 (POA)',
+  'Latin America, Brazil, Porto Alegre 2 (POA)',
+  'Latin America, Brazil, Porto Alegre 3 (POA)',
+  'Latin America, Brazil, Recife 1 (REC)',
+  'Latin America, Brazil, Recife 2 (REC)',
+  'Latin America, Brazil, Recife 3 (REC)',
+  'Latin America, Brazil, Rio Branco (RBR)',
+  'Latin America, Brazil, Rio de Janeiro 1 (SDU)',
+  'Latin America, Brazil, Rio de Janeiro 2 (SDU)',
+  'Latin America, Brazil, Rio de Janeiro 3 (SDU)',
+  'Latin America, Brazil, Rio de Janeiro 4 (GIG)',
+  'Latin America, Brazil, Rio de Janeiro 5 (GIG)',
+  'Latin America, Brazil, Rio de Janeiro 6 (SDU)',
+  'Latin America, Brazil, Salvador 1 (SSA)',
+  'Latin America, Brazil, Salvador 2 (SSA)',
+  'Latin America, Brazil, Salvador 4 (SSA)',
+  'Latin America, Brazil, São Luis (SLZ)',
+  'Latin America, Brazil, São Paulo 1 (CGH)',
+  'Latin America, Brazil, São Paulo 2 (CGH)',
+  'Latin America, Brazil, São Paulo 3 (CGH)',
+  'Latin America, Brazil, São Paulo 4 (CGH)',
+  'Latin America, Brazil, São Paulo 5 (CGH)',
+  'Latin America, Brazil, Sorocaba 1 (SOD)',
+  'Latin America, Brazil, Sorocaba 2 (SOD)',
+  'Latin America, Chile, Santiago (SCL)',
+  'Latin America, Brazil, Santos (SSZ)',
+  'Latin America, Brazil, Vitória (VIX)',
+  'Latin America, Colombia, Bogota (BOG)',
+  'Latin America, Mexico, Queretaro (QRO)',
+  'Latin America, Peru, Lima (LIM)',
+  'Latin America, Brazil, Manaus 3 (MAO)',
+  'North America, USA, Ashburn (IAD)',
+  'North America, USA, Atlanta (ATL)',
+  'North America, USA, Chicago (MDW)',
+  'North America, USA, Dallas (DAL)',
+  'North America, USA, Denver (DEN)',
+  'North America, USA, Los Angeles (LAX)',
+  'North America, USA, McAllen (MFE)',
+  'North America, USA, Miami (MIA)',
+  'North America, USA, New York (EWR)',
+  'North America, USA, Orlando (MCO)',
+  'North America, USA, Phoenix (PHX)',
+  'North America, USA, Santa Clara (SJC)',
+  'North America, USA, Seattle (SEA)',
+  'Oceania, Sydney, Australia - (SYD)',
+];
+
+/**
+ * List of Azion edges located in different regions around the world.
+ * These edges are used to serve content and optimize delivery for improved performance.
+ * Each entry represents a specific edge location, including the region and city.
+ * @type {string[]}
+ */
+export default AzionEdges;

package/lib/constants/index.js

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

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

@@ -0,0 +1,23 @@
+/**
+Build messages object.
+@property {object} success - Success messages.
+@property {object} info - Information messages.
+@property {object} error - Error messages.
+ */
+const build = {
+  success: {
+    prebuild_succeeded: 'Prebuild succeeded!',
+    vulcan_build_succeeded: 'Vulcan Build succeeded!',
+  },
+  info: {
+    prebuild_starting: 'Starting prebuild...',
+    vulcan_build_starting: 'Starting Vulcan build...',
+
+  },
+  error: {
+    vulcan_build_failed: 'Vulcan build failed.',
+  },
+
+};
+
+export default build;

package/lib/constants/messages/env.messages.js

@@ -0,0 +1,38 @@
+/**
+Environment messages object.
+@property {object} success - Success messages.
+@property {object} info - Information messages.
+@property {object} errors - Error messages.
+@property {object} runtime - Runtime messages.
+@property {object} server - Server messages.
+ */
+const env = {
+  success: {},
+  info: {},
+  errors: {
+    invalid_environment: 'Invalid environment. Please set ENV to either production, stage, or local.',
+  },
+  runtime: {
+    success: {},
+    info: {},
+    errors: {
+      unknown_error: 'An error occurred while executing the script',
+      fetch_event_missing: 'No fetch event handler was defined',
+      fetch_event_unknown_error: 'An error occurred while handling the fetch event:',
+      undefined_response: 'No response was defined',
+    },
+  },
+  server: {
+    success: {
+      server_running: (port) => `Server running on port ${port}`,
+    },
+    info: {
+      code_change_detect: 'Code change detected. Restarting server...',
+    },
+    errors: {
+      load_worker_failed: 'Failed to load code:',
+    },
+  },
+};
+
+export default env;

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

@@ -0,0 +1,19 @@
+/**
+Global messages object.
+@property {object} success - Success messages.
+@property {object} info - Information messages.
+@property {object} errors - Error messages.
+ */
+const global = {
+  success: {},
+  info: {},
+  errors: {
+    unknown_error: 'An error occurred.',
+    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.`,
+    invalid_node_version: (minVersion) => `Invalid Node version. Node version must be greater than ${minVersion}.`,
+  },
+};
+
+export default global;

package/lib/constants/messages/index.js

@@ -0,0 +1,10 @@
+import build from './build.messages.js';
+import env from './env.messages.js';
+import platform from './platform.messages.js';
+import global from './global.messages.js'; // generic messages
+
+const Messages = {
+  env, platform, build, ...global,
+};
+
+export default Messages;

package/lib/constants/messages/platform.messages.js

@@ -0,0 +1,84 @@
+/**
+ * Platform messages object.
+ * @property {object} success - Success messages.
+ * @property {object} info - Information messages.
+ * @property {object} errors - Error messages.
+ * @property {object} auth - Authentication messages.
+ * @property {object} deploy - Deployment messages.
+ * @property {object} logs - Log messages.
+ * @property {object} storage - Storage messages.
+ * @property {object} propagation - Propagation messages.
+ */
+const platform = {
+  success: {},
+  info: {},
+  errors: {},
+  auth: {
+    success: {
+      auth_success: 'API authentication token saved successfully!',
+    },
+    info: {},
+    error: {
+      auth_failed: 'Authentication failed. Please check your credentials and try again.',
+    },
+  },
+  deploy: {
+    success: {
+      created_edge_function: 'Worker successfully uploaded to Edge.',
+      created_application: 'Application deployed successfully.',
+      created_rule_engine: 'Rule Engine created.',
+      created_domain: 'Domain created.',
+      activated_edge_function: 'Activated Edge Function.',
+      instantiated_edge_function: 'Edge Function Instantiated.',
+      deploy_finished: 'Application successfully deployed to the edge network.',
+    },
+    info: {
+      creating_edge_function: 'Creating Edge Function (worker)...',
+      creating_edge_application: 'Creating Edge Application...',
+      creating_rule_engine: 'Creating Rule Engine...',
+      creating_domain: 'Creating Domain...',
+      activating_edge_function: 'Enabling Edge Function...',
+      instantiating_edge_function: 'Instantiating Edge Function...',
+
+    },
+    error: {
+      deploy_failed: 'An error occurred during deployment',
+    },
+  },
+  logs: {
+    success: {},
+    info: {
+      watch_true: 'Waiting for the next request event...',
+      unsupported_log_type: 'Logs for applications are not yet supported. Please specify "function" instead.',
+      no_logs: 'There are no logs.',
+    },
+    errors: {
+      invalid_log_type: 'Invalid log type. Please specify either "function" or "application".',
+    },
+  },
+  storage: {
+    success: {
+      file_uploaded_success: (filePath) => `Uploaded file: ${filePath}`,
+      statics_uploaded_finish: (successUploadCount) => `${successUploadCount} static assets successfully uploaded to Azion!`,
+    },
+    info: {},
+    errors: {
+      file_upload_failed: (filePath) => `Error uploading file: ${filePath}`,
+    },
+  },
+
+  propagation: {
+    success: {
+      propagation_complete: 'Application has propagated to the edge networks and is ready to be accessed!',
+    },
+    info: {
+      propagating: (edge) => `Propagating to ${edge}...`,
+    },
+    errors: {
+      watch_propagation_failed: 'Error occurred while watching propagation.',
+    },
+  },
+
+};
+
+export default platform;

package/lib/constants/runtime-apis.constants.js

@@ -0,0 +1,118 @@
+const runtimeApis = [
+  'Object',
+  'Function',
+  'Array',
+  'Number',
+  'parseFloat',
+  'parseInt',
+  'Infinity',
+  'NaN',
+  'undefined',
+  'Boolean',
+  'String',
+  'Symbol',
+  'Date',
+  'Promise',
+  'RegExp',
+  'Error',
+  'AggregateError',
+  'EvalError',
+  'RangeError',
+  'ReferenceError',
+  'SyntaxError',
+  'TypeError',
+  'URIError',
+  'globalThis',
+  'JSON',
+  'Math',
+  'Intl',
+  'ArrayBuffer',
+  'Uint8Array',
+  'Int8Array',
+  'Uint16Array',
+  'Int16Array',
+  'Uint32Array',
+  'Int32Array',
+  'Float32Array',
+  'Float64Array',
+  'Uint8ClampedArray',
+  'BigUint64Array',
+  'BigInt64Array',
+  'DataView',
+  'Map',
+  'BigInt',
+  'Set',
+  'WeakMap',
+  'WeakSet',
+  'Proxy',
+  'Reflect',
+  'decodeURI',
+  'decodeURIComponent',
+  'encodeURI',
+  'encodeURIComponent',
+  'escape',
+  'unescape',
+  'isFinite',
+  'isNaN',
+  'console',
+  'Event',
+  'EventTarget',
+  'CustomEvent',
+  'dispatchEvent',
+  'addEventListener',
+  'removeEventListener',
+  'AbortSignal',
+  'AbortController',
+  'Blob',
+  'CryptoKey',
+  'Crypto',
+  'DOMException',
+  'FormData',
+  'Headers',
+  'ReadableStream',
+  'ReadableStreamBYOBReader',
+  'ReadableStreamDefaultReader',
+  'Request',
+  'Response',
+  'SubtleCrypto',
+  'TextDecoder',
+  'TextEncoder',
+  'TransformStream',
+  'URL',
+  'URLPattern',
+  'URLSearchParams',
+  'WritableStream',
+  'WritableStreamDefaultWriter',
+  'atob',
+  'btoa',
+  'clearTimeout',
+  'crypto',
+  'fetch',
+  'setTimeout',
+  'setInterval',
+  'structuredClone',
+  'self',
+  'EdgeRuntime',
+  'ExtendableEvent',
+  'FetchEvent',
+  'FirewallEvent',
+  'clearInterval',
+  'SharedArrayBuffer',
+  'Atomics',
+  'WebAssembly',
+  'hasOwnProperty',
+  'isPrototypeOf',
+  'propertyIsEnumerable',
+  'toString',
+  'valueOf',
+  'toLocaleString',
+];
+
+/**
+ * List of supported APIs available in the runtime of the edge.
+ * This list includes various built-in objects, functions, and properties.
+ * It serves as a whitelist for the allowed APIs in the edge runtime environment.
+ * @type {string[]}
+ */
+const Whitelist = new Set(runtimeApis);
+export default Whitelist;

package/lib/env/index.js

@@ -0,0 +1,5 @@
+import runtime from './runtime.env.js';
+import server from './server.env.js';
+import vulcan from './vulcan.env.js';
+
+export { runtime, server, vulcan };

package/lib/env/runtime.env.js

@@ -0,0 +1,69 @@
+import { NodeVM } from 'vm2';
+import { RuntimeApis, Messages } from '#constants';
+import { feedback, debug } from '#utils';
+
+/**
+ * Execute the specified code with the provided event object.
+ * @param {string} code - The JavaScript code to be executed.
+ * @param {object} event - The event object containing the request and other properties.
+ * @returns {Promise<object>} A Promise that resolves with the Response object.
+ */
+async function run(code, event) {
+  let fetchEventHandler = null;
+  let respondWithPromise = null;
+
+  const vm = new NodeVM({
+    console: 'inherit',
+    sandbox: {
+      Headers,
+      ...event,
+      Response,
+      addEventListener: (type, handler) => {
+        if (type !== 'fetch') {
+          throw new Error(`Unsupported event type: ${type}`);
+        }
+        fetchEventHandler = handler;
+      },
+    },
+    require: {
+      external: true,
+      builtin: RuntimeApis,
+    },
+  });
+
+  try {
+    vm.run(code);
+  } catch (error) {
+    debug.error(error);
+    feedback.error(Messages.env.runtime.errors.unknown_error);
+    throw error;
+  }
+
+  if (!fetchEventHandler) {
+    throw new Error(Messages.env.runtime.errors.fetch_event_missing);
+  }
+
+  let response;
+  try {
+    const fetchEvent = {
+      request: event.request,
+      respondWith: (responsePromise) => {
+        respondWithPromise = responsePromise;
+      },
+    };
+    fetchEventHandler(fetchEvent);
+    response = respondWithPromise;
+  } catch (error) {
+    debug.error(error);
+    feedback.error(Messages.env.runtime.errors.fetch_event_unknown_error);
+    throw error;
+  }
+
+  if (!response) {
+    throw new Error(Messages.env.runtime.errors.undefined_response);
+  }
+
+  return response;
+}
+
+export default run;

package/lib/env/server.env.js

@@ -0,0 +1,90 @@
+import http from 'http';
+import chokidar from 'chokidar';
+
+import { debug, feedback, readWorkerFile } from '#utils';
+import { Messages } from '#constants';
+import run from './runtime.env.js';
+
+/**
+ * Create a new HTTP server.
+ * @param {string} filePath - The path to the file containing the code.
+ * @returns {http.Server} The created server.
+ */
+function createServer(filePath) {
+  return http.createServer(async (request, response) => {
+    let code;
+
+    try {
+      // Load the code to be executed on the server for each request
+      code = await readWorkerFile(filePath);
+    } catch (error) {
+      debug.error(error);
+      response.statusCode = 500;
+      response.setHeader('Content-Type', 'text/plain');
+      response.end(JSON.stringify({ error: error.message }));
+      return;
+    }
+
+    try {
+      const responseBody = await run(code, { request, response });
+
+      if (responseBody instanceof Response) {
+        responseBody.headers.forEach((value, name) => {
+          response.setHeader(name, value);
+        });
+
+        const body = await responseBody.text();
+        response.statusCode = responseBody.status;
+        response.end(body);
+      } else {
+        response.statusCode = 200;
+        response.setHeader('Content-Type', 'text/plain');
+        response.end(responseBody);
+      }
+    } catch (error) {
+      let errorMessage = error.message;
+      if (error.message.includes('is not defined')) {
+        errorMessage = `${error.message} in Edge runtime.`;
+      }
+
+      error.message = errorMessage;
+      debug.error(error);
+      feedback.error(Messages.env.server.errors.load_worker_failed);
+      response.statusCode = 500;
+      response.setHeader('Content-Type', 'text/plain');
+      response.end(JSON.stringify({ error: { message: errorMessage, status: 500 } }));
+    }
+  });
+}
+
+/**
+ * Start the HTTP server with the specified port and file path to load the code from.
+ * @param {string} filePath - The path to the file containing the code.
+ * @param {number} port - The port to listen on.
+ * @returns {http.Server} The created server.
+ */
+async function startServer(filePath, port) {
+  let server = createServer(filePath);
+
+  // Use chokidar to watch for changes in the file
+  const watcher = chokidar.watch(filePath);
+
+  watcher.on('change', async () => {
+    feedback.info(Messages.env.server.info.code_change_detect);
+    // Close the current server
+    server.close();
+    // And create a new one
+    server = createServer(filePath);
+    server.listen(port, () => {
+      feedback.success(Messages.env.server.success.server_running(port));
+    });
+  });
+
+  server.listen(port, () => {
+    feedback.success(Messages.env.server.success.server_running(port));
+  });
+
+  return server;
+}
+
+export default startServer;

package/lib/env/vulcan.env.js

@@ -0,0 +1,93 @@
+import { feedback, debug } from '#utils';
+import { Messages } from '#constants';
+import fs from 'fs/promises';
+import path from 'path';
+
+/**
+ * Create or update the Vulcan environment file with the specified name and value.
+ * @param {string} name - The name of the variable.
+ * @param {string} value - The value of the variable.
+ */
+async function createVulcanEnv(name, value) {
+  const azionDirPath = path.join(process.env.HOME, '.azion');
+  const vulcanEnvPath = path.join(azionDirPath, 'vulcan.env');
+
+  // Create the .azion folder if it doesn't exist
+  try {
+    await fs.mkdir(azionDirPath, { recursive: true });
+  } catch (error) {
+    debug.error(error);
+    feedback.error(Messages.errors.folder_creation_failed(vulcanEnvPath));
+    throw error;
+  }
+
+  // Read the existing Vulcan environment file if it exists
+  let envData = '';
+  try {
+    envData = await fs.readFile(vulcanEnvPath, 'utf8');
+  } catch (error) {
+    // Ignore error if the file doesn't exist
+    if (error.code !== 'ENOENT') {
+      debug.error(error);
+      feedback.error(Messages.errors.file_doesnt_exist(vulcanEnvPath));
+      throw error;
+    }
+  }
+
+  // Update or add the variable to the environment data
+  const variableLine = `${name}=${value}`;
+  const variableRegex = new RegExp(`${name}=.+`);
+
+  if (envData.match(variableRegex)) {
+    envData = envData.replace(variableRegex, variableLine);
+  } else {
+    envData += `${variableLine}\n`;
+  }
+
+  // Write the updated environment data to the file
+  try {
+    await fs.writeFile(vulcanEnvPath, envData);
+  } catch (error) {
+    debug.error(error);
+    feedback.error(Messages.errors.write_file_failed(vulcanEnvPath));
+    throw error;
+  }
+}
+
+/**
+ * Reads the vulcan.env file and returns an object with the variables and their values.
+ * @returns {object|null} An object with the variables and their values,
+ * or null if the file doesn't exist.
+ */
+async function readVulcanEnv() {
+  const vulcanEnvPath = path.join(process.env.HOME, '.azion', 'vulcan.env');
+
+  try {
+    // Check if the vulcan.env file exists
+    await fs.access(vulcanEnvPath);
+
+    // Read the file contents
+    const fileContents = await fs.readFile(vulcanEnvPath, 'utf8');
+    // Parse the variables from the file contents
+    const variables = {};
+    const variableRegex = /^([^=]+)=(.*)$/gm;
+    let match = variableRegex.exec(fileContents);
+    while (match !== null) {
+      const key = match[1].trim();
+      const value = match[2].trim();
+      variables[key] = value;
+      match = variableRegex.exec(fileContents);
+    }
+
+    return variables;
+  } catch (error) {
+    if (error.code === 'ENOENT') {
+      return null;
+    }
+    debug.error(error);
+    feedback.error(Messages.errors.write_file_failed(vulcanEnvPath));
+    throw error;
+  }
+}
+
+export default { createVulcanEnv, readVulcanEnv };