👷 refactor deployment scripts to remove hardcoded list of DCs and sites

Author: thomas-lebeau

.gitlab/deploy-auto.yml

@@ -17,7 +17,7 @@ stages:
     - VERSION=$(node -p -e "require('./lerna.json').version")
     - yarn
     - yarn build:bundle
-    - node ./scripts/deploy/deploy-prod-dc.ts v${VERSION%%.*} $UPLOAD_PATH --check-monitors
+    - node ./scripts/deploy/deploy-prod-dc.ts v${VERSION%%.*} $DATACENTER --check-monitors
 
 step-1_deploy-prod-minor-dcs:
   when: manual
@@ -26,7 +26,7 @@ step-1_deploy-prod-minor-dcs:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: minor-dcs
+    DATACENTER: minor-dcs
 
 step-2_deploy-prod-eu1:
   needs:
@@ -35,7 +35,7 @@ step-2_deploy-prod-eu1:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: eu1
+    DATACENTER: eu1
 
 step-3_deploy-prod-us1:
   needs:
@@ -44,7 +44,7 @@ step-3_deploy-prod-us1:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: us1
+    DATACENTER: us1
 
 step-4_deploy-prod-gov:
   needs:
@@ -53,7 +53,7 @@ step-4_deploy-prod-gov:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: root
+    DATACENTER: gov
 
 step-5_publish-npm:
   needs:

.gitlab/deploy-manual.yml

@@ -19,35 +19,35 @@ stages:
     - VERSION=$(node -p -e "require('./lerna.json').version")
     - yarn
     - yarn build:bundle
-    - node ./scripts/deploy/deploy-prod-dc.ts v${VERSION%%.*} $UPLOAD_PATH --no-check-monitors
+    - node ./scripts/deploy/deploy-prod-dc.ts v${VERSION%%.*} $DATACENTER --no-check-monitors
 
 step-1_deploy-prod-minor-dcs:
   extends:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: minor-dcs
+    DATACENTER: minor-dcs
 
 step-2_deploy-prod-eu1:
   extends:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: eu1
+    DATACENTER: eu1
 
 step-3_deploy-prod-us1:
   extends:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: us1
+    DATACENTER: us1
 
 step-4_deploy-prod-gov:
   extends:
     - .base-configuration
     - .deploy-prod
   variables:
-    UPLOAD_PATH: root
+    DATACENTER: root
 
 step-5_publish-npm:
   stage: deploy
@@ -80,7 +80,7 @@ step-7_create-github-release:
     - node scripts/release/create-github-release.ts
 
 # This step is used to deploy the SDK to a new datacenter.
-# the `UPLOAD_PATH` variable needs to be provided as an argument when starting the manual job
+# the `DATACENTER` variable needs to be provided as an argument when starting the manual job
 optional_step-deploy-to-new-datacenter:
   extends:
     - .base-configuration

scripts/deploy/check-monitors.ts

@@ -5,14 +5,14 @@
  */
 import { printLog, runMain, fetchHandlingError } from '../lib/executionUtils.ts'
 import { getTelemetryOrgApiKey, getTelemetryOrgApplicationKey } from '../lib/secrets.ts'
-import { siteByDatacenter } from '../lib/datacenter.ts'
+import { getSite } from '../lib/datacenter.ts'
 import { browserSdkVersion } from '../lib/browserSdkVersion.ts'
 
 const datacenters = process.argv[2].split(',')
 
 runMain(async () => {
   for (const datacenter of datacenters) {
-    const site = siteByDatacenter[datacenter]
+    const site = getSite(datacenter)
     const apiKey = getTelemetryOrgApiKey(site)
     const applicationKey = getTelemetryOrgApplicationKey(site)
 

scripts/deploy/deploy-prod-dc.ts

@@ -1,7 +1,7 @@
 import { parseArgs } from 'node:util'
 import { printLog, runMain, timeout } from '../lib/executionUtils.ts'
 import { command } from '../lib/command.ts'
-import { siteByDatacenter } from '../lib/datacenter.ts'
+import { getAllMinorDcs, getAllPrivateDcs } from '../lib/datacenter.ts'
 
 /**
  * Orchestrate the deployments of the artifacts for specific DCs
@@ -12,15 +12,6 @@ const ONE_MINUTE_IN_SECOND = 60
 const GATE_DURATION = 30 * ONE_MINUTE_IN_SECOND
 const GATE_INTERVAL = ONE_MINUTE_IN_SECOND
 
-// Major DCs are the ones that are deployed last.
-// They have their own step jobs in `deploy-manual.yml` and `deploy-auto.yml`.
-const MAJOR_DCS = ['root', 'us1', 'eu1']
-
-// Minor DCs are all the DCs from `siteByDatacenter` that are not in `MAJOR_DCS`.
-function getAllMinorDcs(): string[] {
-  return Object.keys(siteByDatacenter).filter((dc) => !MAJOR_DCS.includes(dc))
-}
-
 if (!process.env.NODE_TEST_CONTEXT) {
   runMain(() => main(...process.argv.slice(2)))
 }
@@ -42,30 +33,56 @@ export async function main(...args: string[]): Promise<void> {
   })
 
   const version = positionals[0]
-  const uploadPath = positionals[1] === 'minor-dcs' ? getAllMinorDcs().join(',') : positionals[1]
+  const datacenters = getDatacenters(positionals[1])
 
-  if (!uploadPath) {
-    throw new Error('UPLOAD_PATH argument is required')
+  if (!datacenters) {
+    throw new Error('DATACENTER argument is required')
   }
 
   if (checkMonitors) {
-    command`node ./scripts/deploy/check-monitors.ts ${uploadPath}`.withLogs().run()
+    command`node ./scripts/deploy/check-monitors.ts ${datacenters.join(',')}`.withLogs().run()
   }
 
-  command`node ./scripts/deploy/deploy.ts prod ${version} ${uploadPath}`.withLogs().run()
-  command`node ./scripts/deploy/upload-source-maps.ts ${version} ${uploadPath}`.withLogs().run()
+  const uploadPathTypes = toDatacenterUploadPathType(datacenters).join(',')
 
-  if (checkMonitors && uploadPath !== 'root') {
-    await gateMonitors(uploadPath)
+  command`node ./scripts/deploy/deploy.ts prod ${version} ${uploadPathTypes}`.withLogs().run()
+  command`node ./scripts/deploy/upload-source-maps.ts ${version} ${uploadPathTypes}`.withLogs().run()
+
+  if (checkMonitors) {
+    await gateMonitors(datacenters)
   }
 }
 
-async function gateMonitors(uploadPath: string): Promise<void> {
-  printLog(`Check monitors for ${uploadPath} during ${GATE_DURATION / ONE_MINUTE_IN_SECOND} minutes`)
+async function gateMonitors(datacenters: string[]): Promise<void> {
+  printLog(`Check monitors for ${datacenters.join(',')} during ${GATE_DURATION / ONE_MINUTE_IN_SECOND} minutes`)
+
   for (let i = 0; i < GATE_DURATION; i += GATE_INTERVAL) {
-    command`node ./scripts/deploy/check-monitors.ts ${uploadPath}`.run()
+    command`node ./scripts/deploy/check-monitors.ts ${datacenters.join(',')}`.run()
     process.stdout.write('.') // progress indicator
     await timeout(GATE_INTERVAL * 1000)
   }
+
   printLog() // new line
 }
+
+function getDatacenters(datacenterGroup: string): string[] {
+  if (datacenterGroup === 'minor-dcs') {
+    return getAllMinorDcs()
+  }
+
+  if (datacenterGroup === 'private-regions') {
+    return getAllPrivateDcs()
+  }
+
+  return datacenterGroup.split(',')
+}
+
+function toDatacenterUploadPathType(datacenters: string[]): string[] {
+  return datacenters.map((datacenter) => {
+    if (datacenter === 'gov') {
+      return 'root'
+    }
+
+    return datacenter
+  })
+}

scripts/deploy/upload-source-maps.spec.ts

@@ -1,9 +1,16 @@
 import assert from 'node:assert/strict'
 import path from 'node:path'
 import { beforeEach, before, describe, it, mock } from 'node:test'
-import { siteByDatacenter } from '../lib/datacenter.ts'
 import { mockModule, mockCommandImplementation, replaceChunkHashes } from './lib/testHelpers.ts'
 
+const MOCK_SITES = [
+  'us1.datadoghq.com',
+  'eu1.datadoghq.eu',
+  'us3.datadoghq.com',
+  'us5.datadoghq.com',
+  'ap1.datadoghq.com',
+  'ap2.datadoghq.com',
+]
 const FAKE_API_KEY = 'FAKE_API_KEY'
 const ENV_STAGING = {
   DATADOG_API_KEY: FAKE_API_KEY,
@@ -50,7 +57,7 @@ describe('upload-source-maps', () => {
   })
 
   function forEachDatacenter(callback: (site: string) => void): void {
-    for (const site of Object.values(siteByDatacenter)) {
+    for (const site of MOCK_SITES) {
       callback(site)
     }
   }

scripts/deploy/upload-source-maps.ts

@@ -3,7 +3,7 @@ import { printLog, runMain } from '../lib/executionUtils.ts'
 import { command } from '../lib/command.ts'
 import { getBuildEnvValue } from '../lib/buildEnv.ts'
 import { getTelemetryOrgApiKey } from '../lib/secrets.ts'
-import { siteByDatacenter } from '../lib/datacenter.ts'
+import { getSite, getAllDatacenters } from '../lib/datacenter.ts'
 import { forEachFile } from '../lib/filesUtils.ts'
 import { buildRootUploadPath, buildDatacenterUploadPath, buildBundleFolder, packages } from './lib/deploymentUtils.ts'
 
@@ -20,7 +20,8 @@ function getSitesByVersion(version: string): string[] {
     case 'canary':
       return ['datadoghq.com']
     default:
-      return Object.values(siteByDatacenter)
+      // TODO: do we upload to root for all DCs?
+      return getAllDatacenters().map(getSite)
   }
 }
 
@@ -56,7 +57,7 @@ async function uploadSourceMaps(
       uploadPath = buildRootUploadPath(packageName, version)
       await renameFilesWithVersionSuffix(bundleFolder, version)
     } else {
-      sites = [siteByDatacenter[uploadPathType]]
+      sites = [getSite(uploadPathType)]
       uploadPath = buildDatacenterUploadPath(uploadPathType, packageName, version)
     }
     const prefix = path.dirname(`/${uploadPath}`)

scripts/lib/datacenter.ts

@@ -1,9 +1,51 @@
-export const siteByDatacenter: Record<string, string> = {
-  us1: 'datadoghq.com',
-  eu1: 'datadoghq.eu',
-  us3: 'us3.datadoghq.com',
-  us5: 'us5.datadoghq.com',
-  ap1: 'ap1.datadoghq.com',
-  ap2: 'ap2.datadoghq.com',
-  prtest00: 'prtest00.datad0g.com',
+import { command } from './command.ts'
+
+// Major DCs are the ones that are deployed last.
+// They have their own step jobs in `deploy-manual.yml` and `deploy-auto.yml`.
+const MAJOR_DCS = ['gov', 'us1', 'eu1']
+
+export function getSite(datacenter: string): string {
+  return getAllDatacentersMetadata()[datacenter].site
+}
+
+export function getAllDatacenters(): string[] {
+  return Object.keys(getAllDatacentersMetadata())
+}
+
+export function getAllMinorDcs(): string[] {
+  return getAllDatacenters().filter((dc) => !MAJOR_DCS.includes(dc) && !dc.startsWith('pr'))
+}
+
+export function getAllPrivateDcs(): string[] {
+  return getAllDatacenters().filter((dc) => dc.startsWith('pr'))
+}
+
+interface Datacenter {
+  name: string
+  site: string
+}
+
+let cachedDatacenters: Record<string, Datacenter> | undefined
+
+function getAllDatacentersMetadata(): Record<string, Datacenter> {
+  if (cachedDatacenters) {
+    return cachedDatacenters
+  }
+
+  const selector = 'datacenter.environment == "prod" && datacenter.flavor == "site"'
+  const rawDatacenters = command`ddtool datacenters list --selector ${selector}`.run().trim()
+  const jsonDatacenters = JSON.parse(rawDatacenters) as Datacenter[]
+
+  cachedDatacenters = {}
+
+  for (const datacenter of jsonDatacenters) {
+    const shortName = datacenter.name.split('.')[0]
+
+    cachedDatacenters[shortName] = {
+      name: datacenter.name,
+      site: datacenter.site,
+    }
+  }
+
+  return cachedDatacenters
 }