# Do-It-Yourself CI/CD Deployment Script (for PageBuilder Engine Bundle)

Source: https://dev.arcxp.com/pagebuilder-engine/how-to-guides/optimization-and-deployment/do-it-yourself-ci-cd-deployment-script--for-pagebuilder-engine-bundle/

The script below can be used to help automate your deployment process. It is meant to be run locally but can form the basis of a more robust CI/CD solution if your organization has access to GitHub Actions, CircleCI, Jenkins, etcetera.

> **Note:**
> 
> This script will not work on Windows (without some effort) due to the use of `zip`.

```sh
#!/usr/bin/env node
/* eslint-disable no-console */
/**
  * deploy.js - Helper script to deploy current local state to either sandbox or production environments
  * Prerequisites:
  * There must be two separate sets of endpoints & credentials in .env. One for PROD and one for SANDBOX:
  * PROD_DEPLOYER_FUSION_RELEASE=<specific version or "latest">
  * PROD_DEPLOYER_ENDPOINT=api.<org name>.arcpublishing.com
  * PROD_DEPLOYER_ACCESS_TOKEN=<all access token from Developer Center (Prod)>
  * SANDBOX_DEPLOYER_FUSION_RELEASE=<specific version or "latest">
  * SANDBOX_DEPLOYER_ENDPOINT=api.sandbox.<org name>.arcpublishing.com
  * SANDBOX_DEPLOYER_ACCESS_TOKEN=<all access token from Developer Center (Sandbox)>
  * Usage:
  * `node deploy.js [--production]`
  * For safety, this script will deploy to sandbox by default.
  * If the `--production` flag is given, it will deploy to production, but *not* promote
  * Otherwise it will deploy to sandbox *and* promote.
  */
require('dotenv').config()
const axios = require('axios');
const FormData = require('form-data');
const fs = require('fs');
const { promisify } = require('util');
const { execSync } = require('child_process');
const { exit } = require('process');
const sleep = promisify(setTimeout);

const environment = (
  process.argv.indexOf('--production') > -1 ? 'PROD' : 'SANDBOX'
);

const branch_name = execSync('git rev-parse --abbrev-ref HEAD').toString().trim();

console.log(`Current branch: ${branch_name}. Env: ${environment}`)

console.log("zipping")
execSync('zip bundle.zip -r . -x .git/\* node_modules/\* coverage/\* .github/\* .fusion/\* mocks/\* __mocks__/\* data/\* README.md documentation/\* \*.test.jsx .env .npmrc')

const commit_hash = execSync(`git log -n 1 --oneline | cut -d ' ' -f1`, (err, stdout, stderr) => {
  if (err) {
      console.log("Problem getting commit hash")
  }

  if (typeof stdout === 'string') {
    return stdout.trim()
  }
});
console.log(`Commit hash: ${commit_hash}`)

const pbVersion = process.env[`${environment}_DEPLOYER_FUSION_RELEASE`] || 'latest';
const endpoint = process.env[`${environment}_DEPLOYER_ENDPOINT`];
const authToken = process.env[`${environment}_DEPLOYER_ACCESS_TOKEN`];
const delay = process.env.POLLING_DELAY || 10000;
const timeout = process.env.TIMEOUT || 30;
const bundleName = `${new Date().toISOString()}-${commit_hash}${branch_name}`.replaceAll(/[^a-zA-Z0-9-]/ig, '-');
const baseURL = `https://${endpoint}/deployments/fusion/`;

console.log('Logging environment variables:');
console.log('Environment:', environment);
console.log('Delay(s):', delay / 1000);
console.log('Timeout(s):', (timeout * delay) / 1000);
console.log('PageBuilder Version:', pbVersion);

const form = new FormData();
form.append('name', bundleName);
form.append('bundle', fs.createReadStream('bundle.zip'));

const notification = async (logMessage) => {
  if (logMessage) console.log(logMessage);
};

let latestServiceVersion = null;
let services = null;

const setServiceValues = (response) => {
  const { data: { lambdas = [] } = {} } = response;

  services = lambdas;
  latestServiceVersion = lambdas && lambdas.length > 0 ? lambdas[lambdas.length - 1].Version : 0;
  console.log('Latest Service Version: ', latestServiceVersion);
};

const upload = async () => {
  try {
    const response = await axios.get(`${baseURL}services`, {
      headers: {
        Authorization: `Bearer ${authToken}`,
      },
    });
    console.log('Current services..', response.data);
    setServiceValues(response);
    const data = await axios.post(`${baseURL}bundles`, form, {
      headers: {
        ...form.getHeaders(),
        Authorization: `Bearer ${authToken}`,
      },
      maxContentLength: Infinity,
    });
    console.log(`Uploaded to: ${endpoint}/bundles`);
    // console.log(data);
  } catch (e) {
    console.error('Upload failed', e);
    await Promise.reject();
  }
};

const deploy = async () => {
  try {
    await axios.post(
      `${baseURL}services?bundle=${bundleName}&version=${pbVersion}`,
      null,
      {
        headers: {
          Authorization: `Bearer ${authToken}`,
        },
      },
    );
  } catch (e) {
    console.error('Deployment step failed!', e);
    await Promise.reject();
  }
};

const getLatestServiceVersion = (response) => {
  const { data: { lambdas = [] } = {} } = response;

  const currentVersion = lambdas[lambdas.length - 1].Version;
  if (latestServiceVersion < currentVersion) {
    console.log('Bundle successfully deployed.');
    return currentVersion;
  }
  return null;
};

const checkDeployment = async (limit) => {
  console.log('Checking if deployment has completed...');

  /* eslint-disable no-await-in-loop */
  for (let i = 0; i < limit; i += 1) {
    await sleep(delay);
    const response = await axios.get(`${baseURL}services`, {
      headers: {
        Authorization: `Bearer ${authToken}`,
      },
    });
    const newValue = getLatestServiceVersion(response);
    if (newValue) return newValue;
  }
  /* eslint-enable no-await-in-loop */

  throw new Error(
    'Bundle did not deploy within the set time. Further investigation required. One possible solution is to increase the timeout, if the bundle was eventually deployed',
  );
};

const promote = async (version) => {
  console.log('Attempting to promote service version: ', version);
  try {
    if (!version) {
      throw new Error(
        'The version number argument passed to the promote function is falsy',
      );
    }
    await axios.post(`${baseURL}services/${version}/promote`, null, {
      headers: {
        Authorization: `Bearer ${authToken}`,
      },
    });
  } catch (e) {
    console.error('Error in Promotion step!', e);
    await Promise.reject();
  }
};

const terminateOldest = async () => {
  console.log('Checking if there is an old service to delete.');
  const liveResponse = await axios.get(`${baseURL}live`, {
    headers: {
      Authorization: `Bearer ${authToken}`,
    },
  });
  const liveDeploymentId = liveResponse?.data?.live;
  if (!liveDeploymentId) {
    console.log('No live deployment found.');
    throw new Error(
      'There should be no environment without a live-deployment. Verify the deployer endpoint.',
    );
  }
  const nonLiveServices = services && services.filter(service => service.Version !== liveDeploymentId);
  if (nonLiveServices.length) {
    const oldest = nonLiveServices.reduce((currentOldest, currentService) => {
      if (
        currentOldest.LastModified.localeCompare(currentService.LastModified)
        > 0
      ) {
        return currentService;
      }
      return currentOldest;
    });
    console.log('Terminating Oldest running service.');
    try {
      await axios.post(`${baseURL}services/${oldest.Version}/terminate`, null, {
        headers: {
          Authorization: `Bearer ${authToken}`,
        },
      });
    } catch (e) {
      await notification(
        `Error in terminating the oldest running service. ${e}`,
        `There was an error in deleting the oldest running service. \
Check the deployer page on ${environment}!`,
      );
    }
  }
};

const deployDev = async () => {
  await upload();
  await terminateOldest();
  await deploy();
  const version = await checkDeployment(timeout);
  await promote(version);
  await notification(
    'Successful deployment!');
};

(async () => {
  if (environment === 'SANDBOX') {
    await deployDev();
  } else {
    console.log("uploading to prod")
    await upload();
    await notification('Successful upload!');
  }
})().catch(async (err) => {
  console.error('Error in deployment!', err);
  process.exit(1);
});
```