feat(codecatalyst): replace 'cawsStage' dev setting with granular api override setting (#4010)

* feat(codecatalyst): replace 'cawsStage' dev setting with granular api override setting

* fix(codecatalyst): typo in docs and noisy settings access logging

* refactor(codecatalyst): move dev settings service config logic to DevSettings

Author: hayemaxi

CONTRIBUTING.md

@@ -299,6 +299,19 @@ 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.
+
+Example:
+
+```json
+"aws.dev.codecatalystService": {
+    "region": "us-west-2",
+    "endpoint": "https://public.codecatalyst-gamma.global.api.aws",
+    "hostname": "integ.stage.REMOVE.codes",
+    "gitHostname": "git.gamma.source.caws.REMOVE",
+}
+```
+
 ### SAM/CFN ("goformation") JSON schema
 
 See [docs/cfn-schema-support.md](./docs/cfn-schema-support.md) for how to fix

src/shared/clients/codecatalystClient.ts

@@ -18,7 +18,6 @@ import { showMessageWithCancel } from '../utilities/messages'
 import { assertHasProps, ClassToInterfaceType, isNonNullable, RequiredProps } from '../utilities/tsUtils'
 import { AsyncCollection, toCollection } from '../utilities/asyncCollection'
 import { joinAll, pageableToCollection } from '../utilities/collectionUtils'
-import { DevSettings } from '../settings'
 import { CodeCatalyst } from 'aws-sdk'
 import { ToolkitError } from '../errors'
 import { TokenProvider } from '../../auth/sso/sdkV2Compat'
@@ -30,32 +29,24 @@ import {
 } from 'aws-sdk/clients/codecatalyst'
 import { truncateProps } from '../utilities/textUtilities'
 import { SsoConnection } from '../../auth/connection'
+import { DevSettings } from '../settings'
 
-interface CodeCatalystConfig {
+export interface CodeCatalystConfig {
     readonly region: string
     readonly endpoint: string
     readonly hostname: string
     readonly gitHostname: string
 }
 
+export const defaultServiceConfig: CodeCatalystConfig = {
+    region: 'us-east-1',
+    endpoint: 'https://public.codecatalyst.global.api.aws',
+    hostname: 'codecatalyst.aws',
+    gitHostname: 'codecatalyst.aws',
+}
+
 export function getCodeCatalystConfig(): CodeCatalystConfig {
-    const stage = DevSettings.instance.get('cawsStage', 'prod')
-
-    if (stage === 'gamma') {
-        return {
-            region: 'us-west-2',
-            endpoint: 'https://public.codecatalyst-gamma.global.api.aws',
-            hostname: 'integ.stage.REMOVED.codes',
-            gitHostname: 'git.gamma.source.caws.REMOVED',
-        }
-    } else {
-        return {
-            region: 'us-east-1',
-            endpoint: 'https://public.codecatalyst.global.api.aws',
-            hostname: 'codecatalyst.aws',
-            gitHostname: 'codecatalyst.aws',
-        }
-    }
+    return DevSettings.instance.getCodeCatalystConfig(defaultServiceConfig)
 }
 
 export interface DevEnvironment extends CodeCatalyst.DevEnvironmentSummary {

src/shared/settings.ts

@@ -5,12 +5,13 @@
 
 import * as vscode from 'vscode'
 import * as packageJson from '../../package.json'
+import * as codecatalyst from './clients/codecatalystClient'
 import { getLogger } from './logger'
 import { cast, FromDescriptor, Record, TypeConstructor, TypeDescriptor } from './utilities/typeConstructors'
-import { ClassToInterfaceType, keys } from './utilities/tsUtils'
+import { assertHasProps, ClassToInterfaceType, keys } from './utilities/tsUtils'
 import { toRecord } from './utilities/collectionUtils'
 import { isNameMangled } from './vscode/env'
-import { once } from './utilities/functionUtils'
+import { once, onceChanged } from './utilities/functionUtils'
 import { ToolkitError } from './errors'
 
 type Workspace = Pick<typeof vscode.workspace, 'getConfiguration' | 'onDidChangeConfiguration'>
@@ -648,7 +649,7 @@ const devSettings = {
     telemetryUserPool: String,
     renderDebugDetails: Boolean,
     endpoints: Record(String, String),
-    cawsStage: String,
+    codecatalystService: Record(String, String),
     ssoCacheDirectory: String,
 }
 type ResolvedDevSettings = FromDescriptor<typeof devSettings>
@@ -708,6 +709,28 @@ export class DevSettings extends Settings.define('aws.dev', devSettings) {
         return Object.keys(this.activeSettings).length > 0
     }
 
+    public getCodeCatalystConfig(
+        defaultConfig: codecatalyst.CodeCatalystConfig
+    ): Readonly<codecatalyst.CodeCatalystConfig> {
+        const devSetting = 'codecatalystService'
+        const devConfig = this.get(devSetting, {})
+
+        if (Object.keys(devConfig).length === 0) {
+            this.logCodeCatalystConfigOnce('default')
+            return defaultConfig
+        }
+
+        try {
+            // The configuration in dev settings should explicitly override the entire default configuration.
+            assertHasProps(devConfig, ...Object.keys(defaultConfig))
+        } catch (err) {
+            throw ToolkitError.chain(err, `Dev setting '${devSetting}' has missing or invalid properties.`)
+        }
+
+        this.logCodeCatalystConfigOnce(JSON.stringify(devConfig, undefined, 4))
+        return devConfig as unknown as codecatalyst.CodeCatalystConfig
+    }
+
     public override get<K extends AwsDevSetting>(key: K, defaultValue: ResolvedDevSettings[K]) {
         if (!this.isSet(key)) {
             this.unset(key)
@@ -735,6 +758,10 @@ export class DevSettings extends Settings.define('aws.dev', devSettings) {
         }
     }
 
+    private logCodeCatalystConfigOnce = onceChanged(val => {
+        getLogger().info(`using CodeCatalyst service configuration: ${val}`)
+    })
+
     static #instance: DevSettings
 
     public static get instance() {

src/test/shared/settingsConfiguration.test.ts

@@ -9,6 +9,7 @@ import { DevSettings, Experiments, fromExtensionManifest, PromptSettings, Settin
 import { TestSettings } from '../utilities/testSettingsConfiguration'
 import { ClassToInterfaceType } from '../../shared/utilities/tsUtils'
 import { Optional } from '../../shared/utilities/typeConstructors'
+import { ToolkitError } from '../../shared/errors'
 
 const settingsTarget = vscode.ConfigurationTarget.Workspace
 
@@ -281,6 +282,44 @@ describe('DevSetting', function () {
             assert.strictEqual(sut.isDevMode(), false)
         })
     })
+
+    describe('getCodeCatalystConfig()', function () {
+        const devSettingName = 'aws.dev.codecatalystService'
+        const defaultConfig = {
+            region: 'default',
+            endpoint: 'default',
+            hostname: 'default',
+            gitHostname: 'default',
+        }
+
+        it('throws an error for incomplete dev configuration', async function () {
+            const testSetting = {
+                // missing region
+                endpoint: 'test_endpoint',
+                hostname: 'test_hostname',
+                gitHostname: 'test_githostname',
+            }
+
+            await settings.update(devSettingName, testSetting)
+            assert.throws(() => sut.getCodeCatalystConfig(defaultConfig), ToolkitError)
+        })
+
+        it('returns dev settings configuration when provided', async function () {
+            const testSetting = {
+                region: 'test_region',
+                endpoint: 'test_endpoint',
+                hostname: 'test_hostname',
+                gitHostname: 'test_githostname',
+            }
+
+            await settings.update(devSettingName, testSetting)
+            assert.deepStrictEqual(sut.getCodeCatalystConfig(defaultConfig), testSetting)
+        })
+
+        it('returns default configuration when dev settings are not provided', function () {
+            assert.deepStrictEqual(sut.getCodeCatalystConfig(defaultConfig), defaultConfig)
+        })
+    })
 })
 
 describe('PromptSetting', function () {