contentful-lib-helpers/lib/release/linkAliasToEnvironment.js

Helpers for Contentful's Content Management API

import { validateString } from '../validation/validateString.js'
import { deleteEnvironment } from '../deleteEnvironment.js'
import { orderBy } from 'natural-orderby'

/**
 * @param {import("contentful-management/dist/typings/entities/space").Space} space - The Contentful Space object
 * @param {string} sourceEnvironmentId - The ID of the source Environment that will be linked.
 * @param {string} destinationAliasId - The ID of the Alias to which the Environment will be linked to.
 * @param {string} releaseRegEx - Regular expression to identify release Environments.
 * @param {string} protectedEnvironments - Safety measure when deleting old release to not deleted important Environments.
 * @param {string} deleteOldReleases - If ture, it deletes all release Environments, except the newly linked one and the previous one.
 * @param {number} [verbosityLevel=1] - 0 = NONE, 1 = ERROR, 2 = DEBUG, 3 = INFO
 * @return {Promise<void>}
 */
export async function linkAliasToEnvironment(
  space,
  sourceEnvironmentId = 'environment',
  destinationAliasId = 'master',
  releaseRegEx = 'release-[0-9]+[\\.]*[0-9]*[\\.]*[0-9]*',
  protectedEnvironments = 'dev,staging,master',
  deleteOldReleases = false,
  verbosityLevel = 1
) {
  if (
    !(await validateString(sourceEnvironmentId, 'sourceEnvironmentId')) ||
    !(await validateString(destinationAliasId, 'destinationAliasId'))
  ) {
    verbosityLevel > 0 &&
      console.error(
        '@@/ERROR: Invalid Source Environment or Destination Alias.'
      )
    return
  }

  let isSourceEnvironmentError = false
  let sourceEnvironment = null
  try {
    sourceEnvironment = await space.getEnvironment(sourceEnvironmentId)
  } catch (e) {
    isSourceEnvironmentError = true
  }

  if (
    sourceEnvironmentId === '' ||
    sourceEnvironment === null ||
    sourceEnvironment.sys?.id !== sourceEnvironmentId ||
    isSourceEnvironmentError
  ) {
    verbosityLevel > 0 &&
      console.error(
        `@@/ERROR: Source Environment: '${sourceEnvironmentId}' does not exist.`
      )
    return
  }

  // Add Check destination environment alias exists
  if (!(await space.getEnvironment(destinationAliasId))) {
    console.error(
      `@@ERROR: Destination Environment alias '${destinationAliasId}' already exists!`
    )
    return
  }

  verbosityLevel > 2 &&
    console.log(
      `##/INFO: Linking Environment '${sourceEnvironmentId}' to Alias '${destinationAliasId}'`
    )

  await space
    .getEnvironmentAlias(destinationAliasId)
    .then(alias => {
      alias.environment.sys.id = sourceEnvironmentId
      return alias.update()
    })
    .then(
      alias =>
        verbosityLevel > 2 &&
        console.log(
          "##/INFO: Alias '" +
            destinationAliasId +
            "' updated to '" +
            sourceEnvironmentId +
            "' Environment."
        )
    )
    .catch(e => verbosityLevel > 0 && console.error('@@/ERROR: ' + e))

  if (deleteOldReleases) {
    await pruneOldReleases(
      space,
      sourceEnvironmentId,
      releaseRegEx,
      protectedEnvironments,
      verbosityLevel
    )
  }
}

/**
 *
 * @param space
 * @param newReleaseEnvironment
 * @param releaseRegEx
 * @param protectedEnvironments
 * @param verbosityLevel
 * @return {Promise<void>}
 */
async function pruneOldReleases(
  space,
  newReleaseEnvironment = null,
  releaseRegEx = 'release-[0-9]+[\\.]*[0-9]*[\\.]*[0-9]*',
  protectedEnvironments = 'dev,staging,master',
  verbosityLevel = 1
) {
  verbosityLevel > 2 && console.log('##INFO: Deleting old Release Environments')

  let excludedEnvironments = protectedEnvironments.split(',')
  let regex = new RegExp(releaseRegEx, 'g')
  let environmentList
  let releaseList = []

  // // Get list of all environments
  await space
    .getEnvironments()
    .then(response => (environmentList = response.items))
    .catch(e => console.error('@@/ERROR: ' + e))

  verbosityLevel > 2 &&
    console.log('##/INFO: Processing the list of all environments')

  for (let i = 0; i < environmentList.length; i++) {
    if (
      environmentList[i].name.match(regex) &&
      environmentList[i].sys.aliasedEnvironment === undefined &&
      !excludedEnvironments.includes(environmentList[i].name)
    ) {
      releaseList.push(environmentList[i].name)
    } else {
      let isAliased = ''
      if (environmentList[i].sys.aliasedEnvironment) {
        isAliased = ' aliased by ' + environmentList[i].sys.id
      }
      verbosityLevel > 2 &&
        console.log(
          '##/INFO: This environment will NOT be deleted: ' +
            environmentList[i].name +
            isAliased
        )
    }
  }

  const sortedReleases = orderBy(releaseList, [], ['desc'])

  // Exclude the latest release
  let latestRelease = sortedReleases.shift()
  // That also has to match the parameter we just passed
  if (latestRelease === newReleaseEnvironment) {
    // If so, we exclude the previous release for rollback
    let beforeLastEnvironment = sortedReleases.shift()

    verbosityLevel > 2 &&
      console.log('##/INFO: List of Release environments that will be kept:')
    verbosityLevel > 2 && console.log('- ' + latestRelease)
    verbosityLevel > 2 && console.log('- ' + beforeLastEnvironment)
    verbosityLevel > 2 &&
      console.log('##/INFO: List of Release environments that will be deleted:')

    let environmentsToBeDeleted = []
    // And then we can remove all the older releases (if any)
    for (let j = 0; j < sortedReleases.length; j++) {
      verbosityLevel > 2 && console.log('- ' + sortedReleases[j])
      environmentsToBeDeleted.push(sortedReleases[j])
    }

    if (environmentsToBeDeleted.length > 0) {
      for (let z = 0; z < environmentsToBeDeleted.length; z++) {
        // Actual deletion of the environment
        verbosityLevel > 1 &&
          console.log(
            "%%/DEBUG: Environment '" +
              environmentsToBeDeleted[z] +
              "' is going to be deleted!"
          )
        await deleteEnvironment(
          await space.getEnvironment(environmentsToBeDeleted[z]),
          verbosityLevel
        )
      }
    } else {
      verbosityLevel > 2 && console.log('##/INFO: Nothing to delete')
    }
  } else {
    verbosityLevel > 2 &&
      console.log(
        '##/INFO: The created Release environment is not the latest Release'
      )
    verbosityLevel > 2 &&
      console.log('##/INFO: We are not gonna delete any environment!')
  }
}