chore(ci): when deploying compass web, deploy to all previous environments to make sure release version is consistent

Author: gribnoysup

.github/workflows/publish-compass-web.yaml

@@ -32,10 +32,53 @@ permissions:
   contents: read
 
 jobs:
+  configure_deployments:
+    name: Configure deployments
+    runs-on: ubuntu-latest
+    outputs:
+      environments: ${{ steps.define_environments.outputs.environments }}
+      commit_hash: ${{ steps.define_commit_hash.outputs.commit_hash }}
+    steps:
+      - id: define_environments
+        name: Define environments configurations
+        run: |
+          # Select all environments up to and including the one selected for the
+          # release
+          environments=""
+          for env in "dev" "qa" "staging" "prod"; do
+            environments+="\"$env\", "
+            if [[ $env == "${{ inputs.publish_environment }}" ]]; then
+              break
+            fi
+          done
+          environments=${environments/%, /} # remove trailing comma
+          echo "Publishing compass-web to $environments"
+          echo "environments=[$environments]" >> "$GITHUB_OUTPUT"
+      - id: define_commit_hash
+        name: Resolve release hash
+        env:
+          COMPASS_WEB_RELEASE_COMMIT: '${{ inputs.dangerously_override_commit_hash }}'
+        run: |
+          # Use latest dev deploy as a default one for the release: this matches
+          # our continuous deployment strategy
+          commit_hash=${COMPASS_WEB_RELEASE_COMMIT:-"$(npm run --silent latest-release -w packages/compass-web dev)"}
+          echo "commit_hash=\"$commit_hash\"" >> "$GITHUB_OUTPUT"
+
   publish:
-    name: Upload compass-web entrypoint file to assets bucket
+    name: Upload compass-web entrypoint file to assets bucket in ${{ matrix.environment }}
     runs-on: ubuntu-latest
+    needs: configure_deployments
+    strategy:
+      # By using matrix with max parallel we run the combinations in sequence
+      # one after another. The fail fast option guarantees that deploy doesn't
+      # proceed when a previous one failed
+      max-parallel: 1
+      fail-fast: true
+      matrix:
+        environment: ${{ fromJSON(needs.configure_deployments.outputs.environments) }}
     environment: compass-web
+    outputs:
+      environments: ${{ steps.check_if_deployed.outputs.already_deployed }}
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -64,28 +107,42 @@ jobs:
         run: |
           npm ci
 
+      - id: check_if_deployed
+        name: Check current release version for ${{ matrix.environment }} env
+        env:
+          COMPASS_WEB_RELEASE_COMMIT: ${{ inputs.dangerously_override_commit_hash }}
+        run: |
+          current_release_commit_hash="$(npm run --silent latest-release -w packages/compass-web ${{ matrix.environment }})"
+          if [[ $current_release_commit_hash == $COMPASS_WEB_RELEASE_COMMIT ]]; then
+            echo "Release $COMPASS_WEB_RELEASE_COMMIT already published on ${{ matrix.environment }}"
+            echo "already_deployed=true" >> "$GITHUB_OUTPUT"
+          fi
+
       - name: Test compass-web with Atlas Cloud
-        if: ${{ !inputs.dangerously_skip_e2e_tests }}
+        # TODO(CLOUDP-388180): can't run automated tests in staging, prod environments at the moment
+        if: ${{ !steps.check_if_deployed.outputs.already_deployed && !inputs.dangerously_skip_e2e_tests && contains(fromJSON('["dev", "qa"]'), matrix.environment) }}
         env:
           EVG_USER: ${{ secrets.EVERGREEN_SERVICE_USER_USERNAME }}
           EVG_API_KEY: ${{ secrets.EVERGREEN_SERVICE_USER_API_KEY }}
-          COMPASS_E2E_ATLAS_CLOUD_ENVIRONMENT: ${{ inputs.publish_environment }}
-          COMPASS_WEB_E2E_TEST_EVERGREEN_PATCH_DESCRIPTION: 'Test compass-web against Atlas ${{ inputs.publish_environment }} env before release (GHA: https://github.com/mongodb-js/compass/actions/runs/${{ github.run_id }})'
-          COMPASS_WEB_RELEASE_COMMIT: ${{ inputs.dangerously_override_commit_hash }}
+          COMPASS_E2E_ATLAS_CLOUD_ENVIRONMENT: ${{ matrix.environment }}
+          COMPASS_WEB_E2E_TEST_EVERGREEN_PATCH_DESCRIPTION: 'Test compass-web against Atlas ${{ matrix.environment }} env before release (GHA: https://github.com/mongodb-js/compass/actions/runs/${{ github.run_id }})'
+          COMPASS_WEB_RELEASE_COMMIT: ${{ steps.define_commit_hash.outputs.commit_hash }}
         run: |
           npm run --workspace @mongodb-js/compass-web test-e2e-atlas
 
       - name: Configure AWS Credentials
+        if: ${{ !steps.check_if_deployed.outputs.already_deployed }}
         uses: aws-actions/configure-aws-credentials@56d6a583f00f6bad6d19d91d53a7bc3b8143d0e9 # v5.1.1
         with:
           role-to-assume: arn:aws:iam::119629040606:role/s3-access.cdn-origin-compass
           aws-region: us-east-1
 
       - name: Upload updated entrypoint
+        if: ${{ !steps.check_if_deployed.outputs.already_deployed }}
         env:
           COMPASS_WEB_PUBLISH_DRY_RUN: ${{ inputs.dry_run }}
-          COMPASS_WEB_PUBLISH_ENVIRONMENT: ${{ inputs.publish_environment }}
-          COMPASS_WEB_RELEASE_COMMIT: ${{ inputs.dangerously_override_commit_hash }}
+          COMPASS_WEB_PUBLISH_ENVIRONMENT: ${{ matrix.environment }}
+          COMPASS_WEB_RELEASE_COMMIT: ${{ steps.define_commit_hash.outputs.commit_hash }}
           # Set by "Configure AWS Credentials" step
           DOWNLOAD_CENTER_NEW_AWS_ACCESS_KEY_ID: '${{ env.AWS_ACCESS_KEY_ID }}'
           DOWNLOAD_CENTER_NEW_AWS_SECRET_ACCESS_KEY: '${{ env.AWS_SECRET_ACCESS_KEY }}'

packages/compass-web/package.json

@@ -65,7 +65,8 @@
     "reformat": "npm run eslint . -- --fix && npm run prettier -- --write .",
     "upload-dist": "node --experimental-strip-types scripts/release/upload-dist.mts",
     "upload-entrypoint": "node --experimental-strip-types scripts/release/upload-entrypoint.mts",
-    "serve-dist": "node --experimental-strip-types scripts/dist-file-server.mts"
+    "serve-dist": "node --experimental-strip-types scripts/dist-file-server.mts",
+    "latest-release": "node --experimental-strip-types scripts/release/get-latest.mts"
   },
   "peerDependencies": {
     "react": "^17.0.2",

packages/compass-web/scripts/release/get-latest.mts

@@ -0,0 +1,29 @@
+import { parseArgs } from 'util';
+import {
+  ALLOWED_PUBLISH_ENVIRONMENTS,
+  DOWNLOADS_BUCKET_PUBLIC_HOST,
+} from './utils.mts';
+
+const { positionals } = parseArgs({ allowPositionals: true });
+
+const env = positionals[0] ?? 'dev';
+
+if (!ALLOWED_PUBLISH_ENVIRONMENTS.includes(env)) {
+  throw new Error(
+    `Trying to resolve latest release for a non-existent environment: "${env}"`
+  );
+}
+
+const res = await fetch(
+  new URL(`/compass/compass-web/${env}/index.mjs`, DOWNLOADS_BUCKET_PUBLIC_HOST)
+);
+const body = await res.text();
+const { groups } = /compass\/tree\/(?<commitHash>.+?)\b/.exec(body) ?? {};
+
+if (!groups?.commitHash) {
+  throw new Error(
+    `Failed to resolve latest compass-web release for "${env}" environment`
+  );
+}
+
+process.stdout.write(groups.commitHash);

packages/compass-web/scripts/release/utils.mts

@@ -1,4 +1,4 @@
-import S3 from 'aws-sdk/clients/s3.js';
+import type S3 from 'aws-sdk/clients/s3.js';
 import child_process from 'child_process';
 import path from 'path';
 import { promisify } from 'util';
@@ -44,7 +44,8 @@ let s3Client;
 
 export const asyncPutObject: (
   params: S3.Types.PutObjectRequest
-) => Promise<S3.Types.PutObjectOutput> = (params) => {
+) => Promise<S3.Types.PutObjectOutput> = async (params) => {
+  const { default: S3 } = await import('aws-sdk/clients/s3.js');
   s3Client ??= new S3({
     credentials: getAWSCredentials(),
   });