edge-functions 1.0.0

package/lib/utils/getPackageVersion/getPackageVersion.utils.test.js

@@ -0,0 +1,48 @@
+import { writeFileSync } from 'fs';
+import { tmpdir } from 'os';
+import { join } from 'path';
+
+import getPackageVersion from './index.js';
+
+const FILE_NAME = 'package.json';
+const CURRENT_DIR = process.cwd();
+const TMP_DIR = tmpdir();
+const FILE_PATH = join(TMP_DIR, FILE_NAME);
+
+describe('getPackageVersion utils', () => {
+  beforeAll(() => {
+    writeFileSync(FILE_PATH, `
+    {
+      "dependencies": {
+        "next": "13.3.4"
+      }
+    }
+    `);
+
+    process.chdir(TMP_DIR);
+  });
+
+  afterAll(() => {
+    process.chdir(CURRENT_DIR);
+  });
+
+  test('Should get package version from user project.', async () => {
+    const expectedOutput = '13.3.4';
+
+    const version = getPackageVersion('next');
+
+    expect(version).toBe(expectedOutput);
+  });
+
+  test('Should throw an ERROR when package name is invalid', async () => {
+    const expectedOutput = 'Invalid package name!';
+
+    expect(() => getPackageVersion('')).toThrow(expectedOutput);
+  });
+
+  test('Should throw an ERROR when package is NOT found', async () => {
+    const expectedOutput = '\'other\' not detected in project dependencies!';
+
+    expect(() => getPackageVersion('other')).toThrow(expectedOutput);
+  });
+});

package/lib/utils/getPackageVersion/index.js

@@ -0,0 +1,3 @@
+import getPackageVersion from './getPackageVersion.utils.js';
+
+export default getPackageVersion;

package/lib/utils/getPresetsList/getPresetsList.utils.js

@@ -0,0 +1,50 @@
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * Get the list of presets.
+ * @function
+ * @name getPresetsList
+ * @memberof utils
+ * @param {string[]} [types=['default', 'custom']] - The types of presets to list.
+ * Each type corresponds to a folder in the 'presets' directory.
+ * @returns {string[]} The list of presets with '(Static)' or '(Server)' suffixes when applicable.
+ * @example
+ * const presetsList = getPresetsList(['default', 'custom']);
+ * console.log(presetsList);
+ * // Output: ['Next (Static)', 'Next (Server)', 'Frodo (Nine Fingers)']
+ */
+function getPresetsList(types = ['default', 'custom']) {
+  const currentModuleFullPath = import.meta.url;
+  let baselibPath = currentModuleFullPath.match(/(.*lib)(.*)/)[1];
+  baselibPath = baselibPath.replace('file://', '');
+
+  const presets = [];
+
+  types.forEach((type) => {
+    const presetsDir = path.join(baselibPath, `presets/${type}`);
+    const folders = fs.readdirSync(presetsDir, { withFileTypes: true })
+
+      .filter((dirent) => dirent.isDirectory())
+      .flatMap((dirent) => {
+        const presetName = dirent.name;
+        const subDirs = fs.readdirSync(path.join(presetsDir, presetName), { withFileTypes: true })
+          .filter((subDirent) => subDirent.isDirectory());
+
+        if (subDirs.length === 0) {
+          return [presetName.charAt(0).toUpperCase() + presetName.slice(1)];
+        }
+
+        return subDirs.map((subDir) => {
+          const subDirName = subDir.name.charAt(0).toUpperCase() + subDir.name.slice(1);
+          return `${presetName.charAt(0).toUpperCase() + presetName.slice(1)} (${subDirName})`;
+        });
+      });
+
+    presets.push(...folders);
+  });
+
+  return presets;
+}
+
+export default getPresetsList;

package/lib/utils/getPresetsList/getPresetsList.utils.test.js

@@ -0,0 +1,19 @@
+import getPresetsList from './index.js';
+
+describe('getPresetsList utils', () => {
+  test('Should get the list of presets based on type', async () => {
+    const expectedOutput = [
+      'Javascript (Compute)',
+      'Typescript (Compute)',
+      'Astro (Deliver)',
+      'Hexo (Deliver)',
+      'Next (Deliver)',
+      'React (Deliver)',
+      'Vue (Deliver)',
+    ];
+
+    const result = getPresetsList();
+
+    expect(result).toEqual(expectedOutput);
+  });
+});

package/lib/utils/getPresetsList/index.js

@@ -0,0 +1,3 @@
+import getPresetsList from './getPresetsList.utils.js';
+
+export default getPresetsList;

package/lib/utils/getProjectJsonFile/getProjectJsonFile.utils.js

@@ -0,0 +1,21 @@
+import { join } from 'path';
+import { readFileSync } from 'fs';
+
+/**
+ * Reads json file content
+ * @param {string} filePath - path to json file to be readed.
+ * @returns {object} - JSON object with file content.
+ */
+function getProjectJsonFile(filePath) {
+  try {
+    const packageJsonPath = join(process.cwd(), filePath);
+    const packageJsonContent = readFileSync(packageJsonPath, 'utf8');
+    const packageJson = JSON.parse(packageJsonContent);
+
+    return packageJson;
+  } catch (error) {
+    throw Error(`Error getting '${filePath}' file: ${error}`);
+  }
+}
+
+export default getProjectJsonFile;

package/lib/utils/getProjectJsonFile/getProjectJsonFile.utils.test.js

@@ -0,0 +1,39 @@
+import { writeFileSync } from 'fs';
+import { tmpdir } from 'os';
+import { join } from 'path';
+
+import getProjectJsonFile from './index.js';
+
+const FILE_NAME = 'package.json';
+const CURRENT_DIR = process.cwd();
+const TMP_DIR = tmpdir();
+const FILE_PATH = join(TMP_DIR, FILE_NAME);
+
+describe('getProjectJsonFile utils', () => {
+  beforeAll(() => {
+    writeFileSync(FILE_PATH, `
+    {
+      "name": "next",
+      "version": "0.1.0"
+    }
+    `);
+
+    process.chdir(TMP_DIR);
+  });
+
+  afterAll(() => {
+    process.chdir(CURRENT_DIR);
+  });
+
+  test('Should read a json file content', async () => {
+    const expectedOutput = {
+      name: 'next',
+      version: '0.1.0',
+    };
+
+    const result = getProjectJsonFile(FILE_NAME);
+
+    expect(result.name).toBe(expectedOutput.name);
+    expect(result.version).toBe(expectedOutput.version);
+  });
+});

package/lib/utils/getProjectJsonFile/index.js

@@ -0,0 +1,3 @@
+import getProjectJsonFile from './getProjectJsonFile.utils.js';
+
+export default getProjectJsonFile;

package/lib/utils/getVulcanBuildId/getVulcanBuildId.utils.js

@@ -0,0 +1,49 @@
+import { readFileSync, existsSync } from 'fs';
+import { join } from 'path';
+
+/**
+ * @namespace Utils
+ * @function
+ * @name getVulcanBuildId
+ * @description Fetches the unique build ID for the current project from the
+ * .env file in the .edge directory.
+ * The build ID is a unique identifier for a specific version of the project's
+ * code and is used to fetch the correct assets within the Edge Function.
+ * The .edge directory is assumed to be in the same directory where the Node.js
+ * process was started (process.cwd()).
+ * @returns {string|null} The build ID if found, or null if the .env file doesn'
+ * t exist or doesn't contain the VERSION_ID.
+ * @example
+ * // If the .edge/.env file contains "VERSION_ID=123",
+ * this will log "123"
+ * console.log(getVulcanBuildId());
+ * @example
+ * // If the .edge/.env file does not exist or does not contain "VERSION_ID=...",
+ * // this will log "null"
+ * console.log(getVulcanBuildId());
+ */
+function getVulcanBuildId() {
+  // Define the path to the .env file
+  const envFilePath = join(process.cwd(), '.edge', '.env');
+
+  // Define the regular expression to match the build ID
+  const VERSION_ID_REGEX = /VERSION_ID=(\d+)/;
+
+  // If the .env file exists, read its contents
+  if (existsSync(envFilePath)) {
+    const envFileContent = readFileSync(envFilePath, 'utf8');
+
+    // Try to match the build ID in the file's contents
+    const buildIdMatch = envFileContent.match(VERSION_ID_REGEX);
+
+    // If a match is found, return the build ID (which is the second item in the match array)
+    if (buildIdMatch && buildIdMatch[1]) {
+      return buildIdMatch[1].trim();
+    }
+  }
+
+  // If the .env file doesn't exist or doesn't contain the VERSION_ID, return null
+  return null;
+}
+
+export default getVulcanBuildId;

package/lib/utils/getVulcanBuildId/getVulcanBuildId.utils.test.js

@@ -0,0 +1,36 @@
+import { writeFileSync, mkdirSync, rmSync } from 'fs';
+import { tmpdir } from 'os';
+import { join } from 'path';
+
+import getVulcanBuildId from './index.js';
+
+const FILE_NAME = '.env';
+const FILE_DIR = '.edge';
+const CURRENT_DIR = process.cwd();
+const TMP_DIR = tmpdir();
+const DIR_PATH = join(TMP_DIR, FILE_DIR);
+const FILE_PATH = join(TMP_DIR, FILE_DIR, FILE_NAME);
+
+describe('getVulcanBuildId utils', () => {
+  beforeAll(() => {
+    process.chdir(TMP_DIR);
+
+    mkdirSync(DIR_PATH);
+
+    writeFileSync(FILE_PATH, 'VERSION_ID=20230627142534');
+  });
+
+  afterAll(() => {
+    process.chdir(CURRENT_DIR);
+
+    rmSync(DIR_PATH, { recursive: true, force: true });
+  });
+
+  test('Should fetch the unique build ID for the current project', async () => {
+    const expectedOutput = '20230627142534';
+
+    const result = getVulcanBuildId();
+
+    expect(result).toBe(expectedOutput);
+  });
+});

package/lib/utils/getVulcanBuildId/index.js

@@ -0,0 +1,3 @@
+import getVulcanBuildId from './getVulcanBuildId.utils.js';
+
+export default getVulcanBuildId;

package/lib/utils/index.js

@@ -0,0 +1,29 @@
+import copyDirectory from './copyDirectory/index.js';
+import debug from './debug/index.js';
+import exec from './exec/index.js';
+import feedback from './feedback/index.js';
+import generateTimestamp from './generateTimestamp/index.js';
+import getAbsoluteLibDirPath from './getAbsoluteLibDirPath/index.js';
+import getVulcanBuildId from './getVulcanBuildId/index.js';
+import getPackageManager from './getPackageManager/index.js';
+import getPresetsList from './getPresetsList/index.js';
+import readWorkerFile from './readWorkerFile/index.js';
+import overrideStaticOutputPath from './overrideStaticOutputPath/index.js';
+import getProjectJsonFile from './getProjectJsonFile/index.js';
+import getPackageVersion from './getPackageVersion/index.js';
+
+export {
+  copyDirectory,
+  debug,
+  exec,
+  feedback,
+  generateTimestamp,
+  getAbsoluteLibDirPath,
+  getPackageManager,
+  getPackageVersion,
+  getProjectJsonFile,
+  getVulcanBuildId,
+  getPresetsList,
+  overrideStaticOutputPath,
+  readWorkerFile,
+};

package/lib/utils/overrideStaticOutputPath/index.js

@@ -0,0 +1,3 @@
+import overrideStaticOutputPath from './overrideStaticOutputPath.utils.js';
+
+export default overrideStaticOutputPath;

package/lib/utils/overrideStaticOutputPath/overrideStaticOutputPath.utils.js

@@ -0,0 +1,47 @@
+import { readFileSync, writeFileSync } from 'fs';
+
+/**
+ * Overrides the output path for static files in a provided configuration file.
+ * @
+ * @function
+ * @name overrideStaticOutputPath
+ * @memberof utils
+ * @param {string} configFilePath - The path to the configuration file to be modified.
+ * @param {RegExp} regexPattern - The RegExp object to be used
+ * for matching within the configuration file.
+ * The regex pattern should include a capturing group (i.e., (.*) )
+ * to identify the value to be replaced.
+ * For example, /out:(.*)\n/.
+ * @param {string} [newOutputPath='.edge/statics'] - The default is '.edge/statics'.
+ * @throws Will throw an error if the function fails to override the output path.
+ * @example
+ *
+ * overrideStaticOutputPath('./config.js', /out:(.*)\n/);
+ */
+function overrideStaticOutputPath(configFilePath, regexPattern, newOutputPath = '.edge/statics') {
+  try {
+    const fileContent = readFileSync(configFilePath, 'utf-8');
+
+    const pattern = new RegExp(regexPattern.source, `${regexPattern.flags}g`);
+    const attributeMatch = Array.from(fileContent.matchAll(pattern), (match) => match)[0];
+
+    // find last occurrence to replace
+    let newValue = attributeMatch[0];
+    const contentToReplace = attributeMatch[1].trim();
+    const lastIndex = newValue.lastIndexOf(contentToReplace);
+
+    // generate new value and replace old content with new one
+    if (lastIndex !== -1) {
+      newValue = newValue.substring(0, lastIndex) + newOutputPath
+        + newValue.substring(lastIndex, newValue.length).replace(contentToReplace, '');
+
+      const newContent = fileContent.replace(regexPattern, newValue);
+
+      writeFileSync(configFilePath, newContent);
+    }
+  } catch (error) {
+    throw Error(`Error overriding the output path: ${error}`);
+  }
+}
+
+export default overrideStaticOutputPath;

package/lib/utils/overrideStaticOutputPath/overrideStaticOutputPath.utils.test.js

@@ -0,0 +1,35 @@
+import { writeFileSync, readFileSync } from 'fs';
+import { tmpdir } from 'os';
+import { join } from 'path';
+
+import overrideStaticOutputPath from './index.js';
+
+const CONFIG_FILE_PATH = join(tmpdir(), 'config.json');
+
+describe('overrideStaticOutputPath utils', () => {
+  beforeAll(() => {
+    writeFileSync(CONFIG_FILE_PATH, `
+    {
+      other: true,
+      publicOut: "./public",
+      another: "x"
+    }
+    `);
+  });
+
+  test('Should override the output path for static files in a provided configuration file.', async () => {
+    const expectedOutput = `
+    {
+      other: true,
+      publicOut: "./out",
+      another: "x"
+    }
+    `;
+
+    overrideStaticOutputPath(CONFIG_FILE_PATH, /publicOut:(.*),\n/, '"./out"');
+
+    const result = readFileSync(CONFIG_FILE_PATH, 'utf-8');
+
+    expect(result).toBe(expectedOutput);
+  });
+});

package/lib/utils/readWorkerFile/index.js

@@ -0,0 +1,3 @@
+import readWorkerFile from './readWorkerFile.utils.js';
+
+export default readWorkerFile;

package/lib/utils/readWorkerFile/readWorkerFile.utils.js

@@ -0,0 +1,36 @@
+import fs from 'fs/promises';
+
+/**
+ * Reads the content of a worker file.
+ * @async
+ * @function
+ * @name readWorkerFile
+ * @memberof utils
+ * @param {string} filePath - The path to the worker file.
+ * @returns {Promise<string>} A Promise that resolves to the content of the worker file.
+ * @throws {Error} Will throw an error if the file doesn't exist or there was an error reading it.
+ * @example
+ *
+ * // Example usage:
+ * readWorkerFile('./worker.js')
+ *   .then(content => console.log(content)) // Logs: Content of worker.js
+ *   .catch(err => console.error(err)); // Logs: Error message
+ */
+async function readWorkerFile(filePath) {
+  try {
+    // Check if the file exists
+    await fs.access(filePath);
+
+    // If the file exists, read it and return its contents
+    const workerCode = await fs.readFile(filePath, 'utf8');
+    return workerCode;
+  } catch (error) {
+    // If the file does not exist or there was an error reading it, throw a detailed error
+    const errorMessage = error.code === 'ENOENT'
+      ? 'File does not exist.'
+      : `An error occurred while reading the ${filePath} file.`;
+    throw new Error(errorMessage);
+  }
+}
+
+export default readWorkerFile;

package/lib/utils/readWorkerFile/readWorkerFile.utils.test.js

@@ -0,0 +1,24 @@
+import fs from 'fs/promises';
+import readWorkerFile from './index.js';
+
+describe('readWorkerFile utils', () => {
+  test('Should read the content of a worker file.', async () => {
+    // Create a test file
+    const filePath = './testFile.js';
+    const testContent = 'console.log("Hello, World!");';
+
+    await fs.writeFile(filePath, testContent);
+
+    // Use readWorkerFile function to load code from the test file
+    const workerCode = await readWorkerFile(filePath);
+
+    // Expected content is the same as the content of the file created
+    const expectedContent = testContent;
+
+    // Assert that the workerCode is same as expectedContent
+    expect(workerCode).toBe(expectedContent);
+
+    // Cleanup: remove the test file
+    await fs.unlink(filePath);
+  });
+});

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "edge-functions",
+  "type": "module",
+  "version": "1.0.0",
+  "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": {
+    "vulcan": "lib/main.js",
+    "edge-functions": "lib/main.js",
+    "ef": "lib/main.js"
+  },
+  "release": {
+    "branches": [
+      "main",
+      "dev"
+    ]
+  },
+  "scripts": {
+    "start": "node lib/main.js",
+    "task:aliases": "node tasks/sync-aliases.js",
+    "task:docs": "jsdoc --configure jsdoc.json --verbose",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "author": "aziontech",
+  "contributors": [
+    {
+      "name": "Magnun A V F"
+    },
+    {
+      "name": "João Narciso",
+      "url": "https://jotanarciso.com"
+    }
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^10.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^10.0.4",
+    "@semantic-release/release-notes-generator": "^11.0.4",
+    "bottleneck": "^2.19.5",
+    "chokidar": "^3.5.3",
+    "commander": "^10.0.1",
+    "conventional-changelog-conventionalcommits": "^6.1.0",
+    "form-data": "^4.0.0",
+    "inquirer": "^9.2.7",
+    "install": "^0.13.0",
+    "lodash": "^4.17.21",
+    "log-update": "^5.0.1",
+    "mime-types": "^2.1.35",
+    "node-polyfill-webpack-plugin": "^2.0.1",
+    "npm": "^9.8.0",
+    "open": "^9.1.0",
+    "pkg-dir": "^7.0.0",
+    "semantic-release": "^21.0.7",
+    "semver": "^7.5.2",
+    "signale": "^1.4.0",
+    "vm2": "^3.9.19",
+    "webpack": "^5.84.0",
+    "webpack-merge": "^5.9.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.22.5",
+    "@babel/preset-env": "^7.22.5",
+    "@jest/globals": "^29.5.0",
+    "babel-jest": "^29.5.0",
+    "babel-plugin-transform-import-meta": "^2.2.0",
+    "clean-jsdoc-theme": "^4.2.9",
+    "eslint": "^7.32.0 || ^8.2.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-jest": "^27.2.2",
+    "eslint-plugin-jsdoc": "^44.2.5",
+    "jest": "^29.5.0"
+  },
+  "imports": {
+    "#root/*": "./",
+    "#lib/*": "./lib",
+    "#utils": "./lib/utils/index.js",
+    "#polyfills": "./lib/build/polyfills/index.js",
+    "#build": "./lib/build/dispatcher/index.js",
+    "#bundlers": "./lib/build/bundlers/index.js",
+    "#notations/*": "./lib/notations",
+    "#env": "./lib/env/index.js",
+    "#platform": "./lib/platform/index.js",
+    "#constants": "./lib/constants/index.js",
+    "#edge": "./lib/platform/edgehooks/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aziontech/vulcan.git"
+  },
+  "bugs": {
+    "url": "https://github.com/aziontech/vulcan/issues"
+  },
+  "homepage": "https://github.com/aziontech/vulcan#readme"
+}

package/releaserc.json

@@ -0,0 +1,87 @@
+{
+  "analyzeCommits": {
+    "preset": "conventionalcommits",
+    "parserOpts": {
+      "headerPattern": "^(\\[ISSUE-.*])?\\s?(\\w+):\\s(.*)$",
+      "headerCorrespondence": ["scope", "type", "subject"]
+    }
+  },
+  "generateNotes": {
+    "preset": "conventionalcommits",
+    "parserOpts": {
+      "headerPattern": "^(\\[ISSUE-.*])?\\s?(\\w+):\\s(.*)$",
+      "headerCorrespondence": ["scope", "type", "subject"]
+    },
+    "options": {
+      "preset": {
+        "name": "conventionalchangelog",
+        "issuePrefixes": ["ISSUE-"],
+        "issueUrlFormat": "https://github.com/aziontech/vulcan/issues/{id}"
+      }
+    }
+  },
+  "prepare": [
+    {
+      "path": "@semantic-release/npm",
+      "npmPublish": true
+    }
+  ],
+  "plugins": [
+    [
+      "@semantic-release/commit-analyzer",
+      {
+        "preset": "conventionalcommits",
+        "releaseRules": [
+          { "breaking": true, "release": "major" },
+          { "revert": true, "release": "patch" },
+          { "type": "feat", "release": "minor" },
+          { "type": "fix", "release": "minor" },
+          { "type": "chore", "release": "patch" },
+          { "type": "docs", "release": "patch" },
+          { "type": "style", "release": "patch" },
+          { "type": "refactor", "release": "patch" },
+          { "type": "test", "release": "patch" }
+        ]
+      }
+    ],
+    [
+      "@semantic-release/release-notes-generator",
+      {
+        "preset": "conventionalcommits",
+        "parserOpts": {
+          "headerPattern": "^(\\[ISSUE-.*])?\\s?(\\w+):\\s(.*)$",
+          "headerCorrespondence": ["scope", "type", "subject"]
+        },
+        "writerOpts": {
+          "commitsSort": ["subject", "scope"]
+        }
+      }
+    ],
+    [
+      "@semantic-release/changelog",
+      {
+        "changelogFile": "CHANGELOG.md",
+        "changelogTitle": "# Changelog"
+      }
+    ],
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true,
+        "pkgRoot": "./",
+        "tarballDir": "dist",
+        "tarballFile": "dist/package-${nextRelease.version}.tgz"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["CHANGELOG.md", "package.json", "dist"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ]
+  ],
+  "preset": "conventionalcommits",
+  "increment": "minor",
+  "tagFormat": "${version}"
+}