Merge staging into feature/featureDev-codegen

Author: aws-toolkit-automation

packages/toolkit/src/extension.ts

@@ -14,7 +14,6 @@ import { SharedCredentialsProviderFactory } from './auth/providers/sharedCredent
 import { activate as activateSchemas } from './eventSchemas/activation'
 import { activate as activateLambda } from './lambda/activation'
 import { activate as activateCloudFormationTemplateRegistry } from './shared/cloudformation/activation'
-import { endpointsFileUrl } from './shared/constants'
 import { AwsContextCommands } from './shared/awsContextCommands'
 import {
     getIdeProperties,
@@ -24,9 +23,6 @@ import {
     showWelcomeMessage,
 } from './shared/extensionUtilities'
 import { getLogger, Logger } from './shared/logger/logger'
-import { getEndpointsFromFetcher, RegionProvider } from './shared/regions/regionProvider'
-import { FileResourceFetcher } from './shared/resourcefetcher/fileResourceFetcher'
-import { HttpResourceFetcher } from './shared/resourcefetcher/httpResourceFetcher'
 import { activate as activateEcr } from './ecr/activation'
 import { activate as activateEc2 } from './ec2/activation'
 import { activate as activateSam } from './shared/sam/activation'
@@ -74,9 +70,7 @@ export async function activate(context: vscode.ExtensionContext) {
 
     try {
         // IMPORTANT: If you are doing setup that should also work in web mode (browser), it should be done in the function below
-        const extContext = await activateShared(context, () =>
-            RegionProvider.fromEndpointsProvider(makeEndpointsProvider())
-        )
+        const extContext = await activateShared(context)
 
         initializeNetworkAgent()
         initializeCredentialsProviderManager()
@@ -236,16 +230,6 @@ function initializeCredentialsProviderManager() {
     manager.addProviders(new Ec2CredentialsProvider(), new EcsCredentialsProvider(), new EnvVarsCredentialsProvider())
 }
 
-function makeEndpointsProvider() {
-    const localManifestFetcher = new FileResourceFetcher(globals.manifestPaths.endpoints)
-    const remoteManifestFetcher = new HttpResourceFetcher(endpointsFileUrl, { showUrl: true })
-
-    return {
-        local: () => getEndpointsFromFetcher(localManifestFetcher),
-        remote: () => getEndpointsFromFetcher(remoteManifestFetcher),
-    }
-}
-
 function recordToolkitInitialization(activationStartedOn: number, settingsValid: boolean, logger?: Logger) {
     try {
         const activationFinishedOn = Date.now()

packages/toolkit/src/extensionShared.ts

@@ -14,7 +14,7 @@ import * as nls from 'vscode-nls'
 import globals, { initialize } from './shared/extensionGlobals'
 import { join } from 'path'
 import { Commands } from './shared/vscode/commands2'
-import { documentationUrl, githubCreateIssueUrl, githubUrl } from './shared/constants'
+import { documentationUrl, endpointsFileUrl, githubCreateIssueUrl, githubUrl } from './shared/constants'
 import { getIdeProperties, aboutToolkit, isCloud9 } from './shared/extensionUtilities'
 import { telemetry } from './shared/telemetry/telemetry'
 import { openUrl } from './shared/utilities/vsCodeUtils'
@@ -31,7 +31,7 @@ import { initialize as initializeAuth } from './auth/activation'
 import { LoginManager } from './auth/deprecated/loginManager'
 import { CredentialsStore } from './auth/credentials/store'
 import { initializeAwsCredentialsStatusBarItem } from './auth/ui/statusBarItem'
-import { RegionProvider } from './shared/regions/regionProvider'
+import { RegionProvider, getEndpointsFromFetcher } from './shared/regions/regionProvider'
 import { ChildProcess } from './shared/utilities/childProcess'
 import { isWeb } from './common/webUtils'
 import { registerErrorHandler as registerCommandErrorHandler } from './shared/vscode/commands2'
@@ -45,6 +45,8 @@ import { ExtContext } from './shared/extensions'
 import { getSamCliContext } from './shared/sam/cli/samCliContext'
 import { UriHandler } from './shared/vscode/uriHandler'
 import { disableAwsSdkWarning } from './shared/awsClientBuilder'
+import { FileResourceFetcher } from './shared/resourcefetcher/fileResourceFetcher'
+import { ResourceFetcher } from './shared/resourcefetcher/resourcefetcher'
 
 disableAwsSdkWarning()
 
@@ -53,14 +55,8 @@ let localize: nls.LocalizeFunc
 /**
  * Activation/setup code that is shared by the regular (nodejs) extension AND web mode extension.
  * Most setup code should live here, unless there is a reason not to.
- *
- * @param getRegionProvider - HACK telemetry requires the region provider but we cannot create it yet in this
- * "shared" function since it breaks in web mode. So for now the caller must provide it.
  */
-export async function activateShared(
-    context: vscode.ExtensionContext,
-    getRegionProvider: () => RegionProvider
-): Promise<ExtContext> {
+export async function activateShared(context: vscode.ExtensionContext): Promise<ExtContext> {
     localize = nls.loadMessageBundle()
 
     // some "initialize" functions
@@ -109,7 +105,7 @@ export async function activateShared(
     globals.manifestPaths.lambdaSampleRequests = context.asAbsolutePath(
         join('resources', 'vs-lambda-sample-request-manifest.xml')
     )
-    globals.regionProvider = getRegionProvider()
+    globals.regionProvider = RegionProvider.fromEndpointsProvider(makeEndpointsProvider())
 
     // telemetry
     await activateTelemetry(context, globals.awsContext, Settings.instance)
@@ -238,6 +234,36 @@ function logAndShowWebviewError(err: unknown, webviewId: string, command: string
     })
 }
 
+/**
+ * Returns an object that provides AWS service endpoints that the toolkit supports.
+ *
+ * https://docs.aws.amazon.com/general/latest/gr/rande.html
+ */
+function makeEndpointsProvider() {
+    let localManifestFetcher: ResourceFetcher
+    let remoteManifestFetcher: ResourceFetcher
+    if (isWeb()) {
+        // In web mode everything must be in a single file, so things like the endpoints file will not be available.
+        // The following imports the endpoints file, which causes webpack to bundle it in the final output file
+        const endpoints = require('../resources/endpoints.json')
+        localManifestFetcher = { get: async () => JSON.stringify(endpoints) }
+        // Cannot use HttpResourceFetcher due to web mode breaking on import
+        remoteManifestFetcher = { get: async () => (await fetch(endpointsFileUrl)).text() }
+    } else {
+        localManifestFetcher = new FileResourceFetcher(globals.manifestPaths.endpoints)
+        // HACK: HttpResourceFetcher breaks web mode when imported, so we use webpack.IgnorePlugin()
+        // to exclude it from the bundle.
+        // TODO: Make HttpResourceFetcher web mode compatible
+        const { HttpResourceFetcher } = require('./shared/resourcefetcher/httpResourceFetcher')
+        remoteManifestFetcher = new HttpResourceFetcher(endpointsFileUrl, { showUrl: true })
+    }
+
+    return {
+        local: () => getEndpointsFromFetcher(localManifestFetcher),
+        remote: () => getEndpointsFromFetcher(remoteManifestFetcher),
+    }
+}
+
 /**
  * Wraps the `vscode.window.withProgress` functionality with functionality that also writes to the output channel.
  *

packages/toolkit/src/extensionWeb.ts

@@ -7,7 +7,6 @@ import * as vscode from 'vscode'
 import { setWeb } from './common/webUtils'
 import { getLogger } from './shared/logger'
 import { activateShared, deactivateShared } from './extensionShared'
-import { RegionProvider, defaultRegion } from './shared/regions/regionProvider'
 import os from 'os'
 
 export async function activate(context: vscode.ExtensionContext) {
@@ -18,11 +17,7 @@ export async function activate(context: vscode.ExtensionContext) {
 
         // IMPORTANT: Any new activation code should be done in the function below unless
         // it is web mode specific activation code.
-        await activateShared(context, () => {
-            return {
-                guessDefaultRegion: () => defaultRegion,
-            } as RegionProvider
-        })
+        await activateShared(context)
     } catch (error) {
         const stacktrace = (error as Error).stack?.split('\n')
         // truncate if the stacktrace is unusually long

packages/toolkit/src/shared/resourcefetcher/fileResourceFetcher.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import * as fs from 'fs-extra'
+import { fsCommon } from '../../srcShared/fs'
 import { getLogger, Logger } from '../logger'
 import { ResourceFetcher } from './resourcefetcher'
 
@@ -18,7 +18,7 @@ export class FileResourceFetcher implements ResourceFetcher {
     public async get(): Promise<string | undefined> {
         try {
             this.logger.verbose('loading file resource: "%s"', this.filepath)
-            return (await fs.readFile(this.filepath)).toString()
+            return await fsCommon.readFileAsString(this.filepath)
         } catch (err) {
             this.logger.verbose('failed to load file resource: "%s": %s', this.filepath, (err as Error).message)
             return undefined

packages/toolkit/src/testWeb/extension.test.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import assert from 'assert'
+import globals from '../shared/extensionGlobals'
+
+describe('activation', async () => {
+    it('defines a region provider that can provide regions when in web mode', async () => {
+        assert(globals.regionProvider.getRegions().length > 0)
+    })
+})

packages/webpack.web.config.js

@@ -18,14 +18,6 @@ const baseConfig = require('./webpack.base.config')
 const webConfig = merge(baseConfig, {
     name: 'web',
     target: 'webworker',
-    /**
-     * We currently inherit the value "source-map" for the key 'devtool' from the base config. But during debugging w/ Chromium this
-     * is known to cause breakpoints to be offset. See this thread: https://github.com/webpack/webpack/issues/1487
-     *
-     * TODO: We do not want to use `eval-source-map` for Production since it is recommended for Development builds. Look for a solution to use something
-     * better when in Production. https://webpack.js.org/configuration/devtool/
-     */
-    devtool: 'eval-source-map',
     /**
      * The keys in the following 'entry' object are the relative paths of the final output files in 'dist'.
      * They are suffixed with '.js' implicitly.
@@ -44,6 +36,22 @@ const webConfig = merge(baseConfig, {
             NODE_DEBUG: 'development',
             READABLE_STREAM: 'disable',
         }),
+        /** 
+         * HACK: the HttpResourceFetcher breaks Web mode if imported, BUT we still dynamically import this module for non web mode
+         * environments. The following allows compilation to pass in Web mode by never bundling the module in the final output.
+         */
+        new webpack.IgnorePlugin({
+            resourceRegExp: /httpResourceFetcher/, // matches the path in the require() statement
+        }),
+        /**
+         * The following solves issues w/ breakpoints being offset when debugging in Chrome. IDK WHY!!!!
+         *
+         * To sanity check, comment out the following, set a breakpoint in the toolkit activation function, then see how the breakpoints
+         * are not working as expected.
+         */
+        new webpack.SourceMapDevToolPlugin({
+            exclude: /\*\*\/node_modules\/\*\*/,
+        }),
     ],
     resolve: {
         extensions: ['.ts', '.js'],
@@ -73,6 +81,7 @@ const webConfig = merge(baseConfig, {
     },
     mode: 'production', // lets see if we can change this to 'development' later
     optimization: {
+        // If `true` then we will get confusing variable names in the debugging menu
         minimize: false,
     },
 })