feat(codecatalyst): add environment variable overrides for service configs (#4359)

* feat(codecatalyst): add environment variable overrides for service configs

Problem: While we have user settings.json overrides for codecatalyst, it is not easy for settings.json to be updated in CI
environments.

Solution: Add ability to override on environment variables as well. Also, add generic functions for other services to do the same.

* add cleanup after getServiceEnvVarConfig test

Author: hayemaxi

CONTRIBUTING.md

@@ -344,7 +344,7 @@ Example:
 }
 ```
 
-Overrides specifically for CodeCatalyst can be set using the `aws.dev.codecatalystService` setting. This is a JSON object consisting of keys/values required to override API calls to CodeCatalyst: `region`, `endpoint`, `hostname`, and `gitHostname`. If this setting is present, then all keys need to be explicitly provided.
+<a name="codecatalyst-settings">Overrides specifically for CodeCatalyst can be set using the `aws.dev.codecatalystService` setting. This is a JSON object consisting of keys/values required to override API calls to CodeCatalyst: `region`, `endpoint`, `hostname`, and `gitHostname`. If this setting is present, then all keys need to be explicitly provided.</a>
 
 Example:
 
@@ -398,6 +398,14 @@ Environment variables can be used to modify the behaviour of VSCode. The followi
 -   `__DEV_ENVIRONMENT_SPACE_NAME`: The space name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
 -   `__DEV_ENVIRONMENT_ORGANIZATION_NAME`: The organization name associated with the running development environment. Automatically set when running the toolkit in Codecatalyst
 
+The following are environment variable versions of the user `settings.json` overrides mentioned [here](#codecatalyst-settings). These will always override the toolkit defaults and those defined in `settings.json`.
+Unlike the user setting overrides, not all of these environment variables have to be set to make use of them.
+
+-   `__CODECATALYST_REGION`: for aws.dev.codecatalystService.region
+-   `__CODECATALYST_ENDPOINT`: for aws.dev.codecatalystService.endpoint
+-   `__CODECATALYST_HOSTNAME`: for aws.dev.codecatalystService.hostname
+-   `__CODECATALYST_GIT_HOSTNAME`: for aws.dev.codecatalystService.gitHostname
+
 #### Lambda
 
 -   `AUTH_UTIL_LAMBDA_ARN`: The Amazon Resource Name (ARN) of the lambda function

src/shared/clients/codecatalystClient.ts

@@ -31,6 +31,7 @@ import { truncateProps } from '../utilities/textUtilities'
 import { SsoConnection } from '../../auth/connection'
 import { DevSettings } from '../settings'
 import { RetryDelayOptions } from 'aws-sdk/lib/config-base'
+import { getServiceEnvVarConfig } from '../vscode/env'
 
 export interface CodeCatalystConfig {
     readonly region: string
@@ -39,6 +40,13 @@ export interface CodeCatalystConfig {
     readonly gitHostname: string
 }
 
+const configToEnvMap: { [K in keyof CodeCatalystConfig]: string } = {
+    region: '__CODECATALYST_REGION',
+    endpoint: '__CODECATALYST_ENDPOINT',
+    hostname: '__CODECATALYST_HOSTNAME',
+    gitHostname: '__CODECATALYST_GIT_HOSTNAME',
+}
+
 export const defaultServiceConfig: CodeCatalystConfig = {
     region: 'us-east-1',
     endpoint: 'https://codecatalyst.global.api.aws',
@@ -47,7 +55,12 @@ export const defaultServiceConfig: CodeCatalystConfig = {
 }
 
 export function getCodeCatalystConfig(): CodeCatalystConfig {
-    return DevSettings.instance.getServiceConfig('codecatalystService', defaultServiceConfig)
+    return {
+        ...DevSettings.instance.getServiceConfig('codecatalystService', defaultServiceConfig),
+
+        // Environment variable overrides
+        ...getServiceEnvVarConfig('codecatalyst', configToEnvMap),
+    }
 }
 
 export interface DevEnvironment extends CodeCatalyst.DevEnvironmentSummary {

src/shared/vscode/env.ts

@@ -6,6 +6,8 @@
 import * as semver from 'semver'
 import * as vscode from 'vscode'
 import * as packageJson from '../../../package.json'
+import { getLogger } from '../logger'
+import { onceChanged } from '../utilities/functionUtils'
 
 /**
  * Returns true if the current build is running on CI (build server).
@@ -89,3 +91,39 @@ export function getCodeCatalystSpaceName(): string | undefined {
     // TODO: remove legacy __DEV_ENVIRONMENT_ORGANIZATION_NAME
     return process.env['__DEV_ENVIRONMENT_SPACE_NAME'] || process.env['__DEV_ENVIRONMENT_ORGANIZATION_NAME']
 }
+
+type ConfigToEnvMap = { [key: string]: string }
+type ServiceConfig = Partial<{ [K in keyof ConfigToEnvMap]: any }>
+const logConfigsOnce: { [key: string]: ReturnType<typeof onceChanged> } = {}
+
+/**
+ * Accepts a service name and a {config key -> expected env var name} map.
+ * For each config key, check if the associated env var exists and return
+ * a config map with the found values. Changes are logged once for each
+ * service/found env var combos.
+ */
+export function getServiceEnvVarConfig(service: string, configToEnvMap: ConfigToEnvMap): ServiceConfig {
+    const config: ServiceConfig = {}
+    const overriden: string[] = []
+
+    // Find env vars for each field in the config
+    for (const [field, envKey] of Object.entries(configToEnvMap)) {
+        if (envKey in process.env) {
+            config[field] = process.env[envKey]
+            overriden.push(envKey)
+        }
+    }
+
+    // Log env var overrides, keeping track of which service we are logging for.
+    // This allows us to log only once when env vars for a service change.
+    if (overriden.length > 0) {
+        if (!(service in logConfigsOnce)) {
+            logConfigsOnce[service] = onceChanged(vars => {
+                getLogger().info(`using env vars for ${service} config: ${vars}`)
+            })
+        }
+        logConfigsOnce[service](overriden)
+    }
+
+    return config
+}

src/test/shared/vscode/env.test.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import assert from 'assert'
+import { getServiceEnvVarConfig } from '../../../shared/vscode/env'
+
+describe('getServiceEnvVarConfig', function () {
+    const envVars: string[] = []
+
+    afterEach(() => {
+        envVars.forEach(v => delete process.env[v])
+        envVars.length = 0
+    })
+
+    function addEnvVar(k: string, v: string) {
+        process.env[k] = v
+        envVars.push(k)
+    }
+
+    it('gets service config', async function () {
+        const service = 'codecatalyst'
+        const configToEnvMap = {
+            region: '__CODECATALYST_REGION',
+            endpoint: '__CODECATALYST_ENDPOINT',
+        }
+        addEnvVar('__CODECATALYST_ENDPOINT', 'test.endpoint')
+
+        const expectedConfig = {
+            endpoint: 'test.endpoint',
+        }
+        assert.deepStrictEqual(getServiceEnvVarConfig(service, configToEnvMap), expectedConfig)
+    })
+})