[MAJOR] Final review (first official release) (#10)

Co-authored-by: Hugo MARTIN <hugo.martin@epitech.eu>
Co-authored-by: Hugo MARTIN <hugo.martin.69@gmail.com>

Author: Vadorequest

.github/workflows/run-example-deployment.yml

@@ -10,8 +10,6 @@ jobs:
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
-#        with:
-#          path: "github-action-deploy-on-vercel" # Act doesn't work if not specifying the path. See https://github.com/nektos/act/issues/228
       - uses: ./
         with:
           command: "yarn deploy:example --token ${{ secrets.VERCEL_TOKEN }}"

.nvmrc

@@ -0,0 +1 @@
+v14.16.1

README.md

@@ -32,17 +32,38 @@ jobs:
       - run: "echo \"Found deployment url: ${{ env.VERCEL_DEPLOYMENT_URL }}\""
 ```
 
+> [Source](https://github.com/UnlyEd/github-action-deploy-on-vercel/blob/review/.github/workflows/run-example-deployment.yml)
+
 ## What does this GitHub Action do?
 
 You can use this action to deploy a Vercel project online through a GitHub action.
 
 The action will return the url of the Vercel deployment _(and store it as environment variable, too)_, it will also apply domain aliases if there are any configured in the Vercel config file (`vercel.config` by default).
 
-> It works quite differently compared to [`vercel-action`](https://github.com/marketplace/actions/vercel-action).
+## Differences between `github-action-deploy-on-vercel` and `vercel-action`
+
+This action works quite differently compared to [`vercel-action`](https://github.com/marketplace/actions/vercel-action).
+
+> TL;DR: `vercel-action` is great if you don't need a lot of flexibility over the `vercel deploy` command.
+> `github-action-deploy-on-vercel` is great if you need to run a custom command, such as a `npm/yarn` script.
+
+`vercel-action` hides the `vercel deploy` command from you, and acts as a wrapper by providing its own API on top of it.
+
+They simplify the `vercel` command by doing so. Unfortunately, they also reduce the flexibility available to the consumer (you).
+
+In our case, we are dealing with multiple customers (B2B) which are **all sharing the same code base**. 
+The `vercel-action` was too limited and would have complicated our setup, because it requires additional information such as `project_id`/`org_id`.
+
+For most project, we believe using `vercel-action` is enough, and we encourage you to use it, if you don't need to run a special `vercel deploy` command.
 
 ## Why/when should you use it?
 
-You want to run a custom command that (amongst other things) performs a Vercel deployment.
+You want to run a custom command that (amongst other things) performs a Vercel deployment and returns the URL of the Vercel deployment.
+
+The URL of the deployment is often necessary to run follow-up actions, such as:
+- Running End-to-End tests on the deployed site
+- Running LightHouse tests on the deployed site
+- Etc.
 
 ### Action's API
 
@@ -69,6 +90,7 @@ The below variables are available as outputs, but are also **injected as environ
 Here are a few community-powered examples, those are usually advanced use-cases!
 
 - [Next Right Now](https://github.com/UnlyEd/next-right-now) _(Disclosure: We're the author!)_
+  - [PR](https://github.com/UnlyEd/next-right-now/pull/296) - "Using this action helped us reduce a lot of **bash** code which was hardly testable." - _Next Right Now core contributors_
 
 ---
 

__tests__/main.test.ts

@@ -1,7 +1,5 @@
-import * as cp from 'child_process';
-import * as path from 'path';
-import * as process from 'process';
-import { BUILD_DIR, BUILD_MAIN_FILENAME } from '../src/config';
+import { execCommand } from "../src/vercel";
+import { ExecCommandOutput } from "../src/types";
 
 /**
  * Enhance the Node.js environment "global" variable to add our own types
@@ -18,57 +16,19 @@ declare global {
   }
 }
 
-/**
- * Executes the compiled version of the Action's main file. (.js)
- *
- * The goal is to test the file that is actually executed by GitHub Action.
- * Additionally, we could also test the TS files, but we didn't do it to avoid over-complicating things (didn't seem necessary).
- *
- * @param options
- */
-function exec_lib(options: cp.ExecFileSyncOptions): string {
-  /**
-   * Path of the node.js binary being used.
-   *
-   * @example/usr/local/Cellar/node/14.3.0/bin/node
-   */
-  const nodeBinaryPath = process.execPath;
-
-  /**
-   * Path of the compiled version of the Action file entrypoint.
-   *
-   * @example .../github-action-await-vercel/lib/main.js
-   */
-  const mainFilePath = path.join(__dirname, '..', BUILD_DIR, BUILD_MAIN_FILENAME);
-
-  try {
-    // console.debug(`Running command "${nodeBinaryPath} ${mainFilePath}"`);
-    return cp.execFileSync(nodeBinaryPath, [mainFilePath], options).toString();
-  } catch (e) {
-    console.error(e?.output?.toString());
-    console.error(e);
-    throw e;
-  }
-}
-
-describe('Functional test', () => {
-  /*describe('should pass when', () => {
+describe('Unit test', () => {
+  describe('should pass when', () => {
     beforeEach(() => {
       global.console = global.unmuteConsole();
     });
 
-    describe('using special delimiter', () => {
-      const options: cp.ExecFileSyncOptions = {
-        env: {
-          INPUT_VARIABLES: 'VAR=TEST,OTHER_VAR=OTHER_TEST,RETRIEVE',
-          INPUT_DELIMITER: ',',
-        },
-      };
-      const filteredContent = exec_lib(options);
-      test('test', () => {
-        expect(filteredContent.includes(',')).toBe(true);
-        console.log(filteredContent);
+    describe('using our tool', () => {
+      test('with command "vercel --version" to make sure Vercel binary is installed', async () => {
+        const execOutput: ExecCommandOutput = await execCommand("vercel --version");
+        expect(execOutput.stderr.includes('Vercel CLI'), 'Vercel binary might not have been installed, try installing it globally using "yarn global add vercel".').toBe(true);
       });
     });
-  });*/
+  });
 });
+
+export default {};

jest.config.js

@@ -9,6 +9,7 @@ module.exports = {
   },
   verbose: true,
   setupFilesAfterEnv: [
+    'jest-expect-message', // Allows to add additional message when test fails - See https://github.com/mattphillips/jest-expect-message
     './jest.setup.js',
   ],
 };

lib/main.js

@@ -67,7 +67,9 @@ const run = () => __awaiter(void 0, void 0, void 0, function* () {
 });
 runConfigChecks();
 run()
-    .then((actionReturn) => { })
+    .then((actionReturn) => {
+    core.debug(`Execution done successfully.`);
+})
     .catch((error) => {
     core.setFailed(error);
 });

lib/vercel.js

@@ -31,83 +31,83 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.execCommand = void 0;
 const core = __importStar(require("@actions/core"));
 const fs_1 = __importDefault(require("fs"));
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const config_1 = require("./config");
-const exec = require('@actions/exec');
-const glob = require('@actions/glob');
-const generate_alias_promises = (deploymentId, teamId, aliases) => {
-    let aliasCreationPromises = [];
+// Must use "require", not compatible with "import"
+const exec = require('@actions/exec'); // eslint-disable-line @typescript-eslint/no-var-requires
+const glob = require('@actions/glob'); // eslint-disable-line @typescript-eslint/no-var-requires
+const generateAliasPromises = (deploymentId, teamId, aliases) => {
+    const aliasCreationPromises = [];
     for (const alias of aliases) {
-        console.log(`Creating alias ${alias}`);
+        core.debug(`Creating alias ${alias}`);
         aliasCreationPromises.push(node_fetch_1.default(`https://api.vercel.com/v2/now/deployments/${deploymentId}/aliases?teamId=${teamId}`, {
             headers: {
-                Authorization: `Bearer ${process.env.VERCEL_TOKEN}`,
-                "Content-Type": "application/json"
+                'Authorization': `Bearer ${process.env.VERCEL_TOKEN}`,
+                'Content-Type': 'application/json',
             },
             body: JSON.stringify({
-                alias: alias
+                alias: alias,
             }),
-            method: 'POST'
-        }).then(data => data.json()));
+            method: 'POST',
+        })
+            .then((data) => data.json())
+            .catch((e) => core.warning(e)));
     }
     return aliasCreationPromises;
 };
-const exec_command = (command) => __awaiter(void 0, void 0, void 0, function* () {
-    /**
-     * When we execute a program, it writes on two outputs : standard and error.
-     * Initalizing empty variables to receive these outputs
-     */
+exports.execCommand = (command) => __awaiter(void 0, void 0, void 0, function* () {
+    const options = {};
     let stdout = '';
     let stderr = '';
-    const options = {};
     /**
-     * Defining actions for both outputs
+     * Listening to both events to store logs and reuse them later
      */
     options.listeners = {
         stdout: (data) => {
             stdout += data.toString();
         },
         stderr: (data) => {
             stderr += data.toString();
-        }
+        },
     };
     yield exec.exec(command, [], options);
-    return stdout;
+    return { stdout, stderr };
 });
-const create_aliases = (deploymentUrl, customDeploymentFile, failIfAliasNotLinked) => __awaiter(void 0, void 0, void 0, function* () {
+const createAliases = (deploymentUrl, customDeploymentFile, failIfAliasNotLinked) => __awaiter(void 0, void 0, void 0, function* () {
     core.debug(`Starting to link aliases`);
-    /**
-     * Globber is a github action tool https://github.com/actions/toolkit/tree/master/packages/glob
-     * It helps us to find the absolute path for a file. Indeed, because we don't know where the action will be run and we need to find this file, wherever it is.
-     */
+    // Globber is a github action tool https://github.com/actions/toolkit/tree/master/packages/glob
+    // It helps us to find the absolute path for a file. Indeed, because we don't know where the action will be run and we need to find this file, wherever it is.
     const globber = yield glob.create(customDeploymentFile);
     const vercelConfigFile = (yield globber.glob())[0];
     if (vercelConfigFile && fs_1.default.existsSync(vercelConfigFile)) {
         core.debug(`Found custom config file: ${vercelConfigFile}`);
         core.debug(`Found real path: ${vercelConfigFile}`);
         const vercelConfig = JSON.parse(fs_1.default.readFileSync(vercelConfigFile, 'utf8'));
         if (vercelConfig.alias) {
-            const { id, ownerId } = (yield node_fetch_1.default(`https://api.vercel.com/v11/now/deployments/get?url=${deploymentUrl.replace("https://", "")}`, {
+            const { id, ownerId, } = yield node_fetch_1.default(`https://api.vercel.com/v11/now/deployments/get?url=${deploymentUrl.replace('https://', '')}`, {
                 headers: {
-                    Authorization: `Bearer ${process.env.VERCEL_TOKEN}`
+                    Authorization: `Bearer ${process.env.VERCEL_TOKEN}`,
                 },
-                method: 'GET'
-            }).then(data => data.json()));
-            const aliasCreationPromises = generate_alias_promises(id, ownerId, vercelConfig.alias);
+                method: 'GET',
+            })
+                .then((data) => data.json())
+                .catch((error) => core.warning(`Did not receive JSON from Vercel API while creating aliases. Message: ${error === null || error === void 0 ? void 0 : error.message}`));
+            const aliasCreationPromises = generateAliasPromises(id, ownerId, vercelConfig.alias);
             core.debug(`Resolving alias promises`);
             const aliasesResponse = yield Promise.all(aliasCreationPromises);
-            console.log(`Alias creation response: ${JSON.stringify(aliasesResponse)}`);
-            if (aliasesResponse.filter(response => response.error).length > 0) {
+            core.debug(`Alias creation response: ${JSON.stringify(aliasesResponse)}`);
+            if (aliasesResponse.filter((response) => response.error).length > 0) {
                 const failedAliases = aliasesResponse.filter((response) => response.error).map((response) => response.error);
                 const message = `Got following errors: ${JSON.stringify(failedAliases)}`;
                 failIfAliasNotLinked ? core.setFailed(message) : core.warning(message);
-                console.log(`Exporting this error...`);
+                core.debug(`Exporting this error...`);
                 core.setOutput('VERCEL_ALIASES_ERROR', failedAliases);
             }
-            for (const alias of aliasesResponse.filter(response => !response.error)) {
-                console.log(`Created alias ${alias}`);
+            for (const alias of aliasesResponse.filter((response) => !response.error)) {
+                core.debug(`Created alias ${alias}`);
             }
         }
         else {
@@ -125,44 +125,47 @@ const deploy = (command, deployAlias, failIfAliasNotLinked) => __awaiter(void 0,
      *
      * Running "exec_command" displays the output in the console.
      */
-    const stdout = yield exec_command(command);
+    const commandOutput = yield exports.execCommand(command);
+    const stdout = commandOutput.stdout;
     /**
      * Parsing this huge output by using Regex match.
      * match function return strings matching with the pattern.
+     *
      * Pattern "/https?:\/\/[^ ]+.vercel.app/gi"
      *          "/https?\/\/:" start matching when we find http:// or https://
      *          "[^ ]+.vercel.app" will catch everything as a vercel subdomain, so "*.vercel.app"
      *          "/g" allows us to have many matchess
      *          "i" make the regex case insensitive. It will match for "https://subDomainApp.vercel.app" and "https://subdomainapp.vercel.app"
-     * shift returns the first occurence
+     *          "shift" returns the first occurence
      */
     const deploymentUrl = (_a = stdout.match(/https?:\/\/[^ ]+.vercel.app/gi)) === null || _a === void 0 ? void 0 : _a.shift();
     /**
      * Locating any custom config file for Vercel (if you are using one file per customer or deployment for the same app)
      * match function return strings matching with the pattern.
+     *
      * Pattern "/--local-config=.[^$]+?.json/gs"
      *          "/--local-config=" starts matching on finding the argument local-config
      *          "[^$]+?.json" with a json file provided as value
      *          "/g" allows us to have many matchess
      *          "s" reduce match scope on the same line
-     * shift returns the first occurence
-     * split isolates the json file
-     * find automatically finds the matching json file
+     *          "shift" returns the first occurence
+     *          "split" isolates the json file
+     *          "find" automatically finds the matching json file
      */
-    const customDeploymentFile = ((_c = (_b = stdout.match(/--local-config=.[^$]+?.json/gs)) === null || _b === void 0 ? void 0 : _b.shift()) === null || _c === void 0 ? void 0 : _c.split("=").find(el => el.endsWith(".json"))) || config_1.VERCEL_CONFIG_FILE;
+    const customDeploymentFile = ((_c = (_b = stdout.match(/--local-config=.[^$]+?.json/gs)) === null || _b === void 0 ? void 0 : _b.shift()) === null || _c === void 0 ? void 0 : _c.split('=').find((el) => el.endsWith('.json'))) || config_1.VERCEL_CONFIG_FILE;
     core.debug(`Command: ${command}`);
     core.debug(`Custom deploy file: ${customDeploymentFile}`);
     if (deploymentUrl) {
-        const deploymentDomain = deploymentUrl.replace("https://", "");
-        console.log(`Found url deployment. Exporting it...`);
-        console.log(`VERCEL_DEPLOYMENT_URL=${deploymentUrl}`);
-        core.exportVariable("VERCEL_DEPLOYMENT_URL", deploymentUrl);
-        core.setOutput("VERCEL_DEPLOYMENT_URL", deploymentUrl);
-        console.log(`VERCEL_DEPLOYMENT_DOMAIN=${deploymentDomain}`);
-        core.exportVariable("VERCEL_DEPLOYMENT_DOMAIN", deploymentDomain);
-        core.setOutput("VERCEL_DEPLOYMENT_DOMAIN", deploymentDomain);
+        const deploymentDomain = deploymentUrl.replace('https://', '');
+        core.debug(`Found url deployment. Exporting it...`);
+        core.debug(`VERCEL_DEPLOYMENT_URL=${deploymentUrl}`);
+        core.exportVariable('VERCEL_DEPLOYMENT_URL', deploymentUrl);
+        core.setOutput('VERCEL_DEPLOYMENT_URL', deploymentUrl);
+        core.debug(`VERCEL_DEPLOYMENT_DOMAIN=${deploymentDomain}`);
+        core.exportVariable('VERCEL_DEPLOYMENT_DOMAIN', deploymentDomain);
+        core.setOutput('VERCEL_DEPLOYMENT_DOMAIN', deploymentDomain);
         if (deployAlias) {
-            yield create_aliases(deploymentUrl, customDeploymentFile, failIfAliasNotLinked);
+            yield createAliases(deploymentUrl, customDeploymentFile, failIfAliasNotLinked);
         }
     }
     else {