[CodeWhisperer] Refactor CodeWhispererConstants (#2877)

* restructure CodeWhispererConstants
* remove name space and directly export const

Author: Will-ShaoHua

src/codewhisperer/activation.ts

@@ -7,7 +7,7 @@ import * as vscode from 'vscode'
 import { getTabSizeSetting } from '../shared/utilities/editorUtilities'
 import { KeyStrokeHandler } from './service/keyStrokeHandler'
 import * as EditorContext from './util/editorContext'
-import { CodeWhispererConstants } from './models/constants'
+import * as CodeWhispererConstants from './models/constants'
 import { getCompletionItems } from './service/completionProvider'
 import { vsCodeState, ConfigurationEntry } from './models/model'
 import { InlineCompletion } from './service/inlineCompletion'

src/codewhisperer/client/codewhisperer.ts

@@ -7,7 +7,7 @@ import { AWSError, Service } from 'aws-sdk'
 import apiConfig = require('./service-2.json')
 import globals from '../../shared/extensionGlobals'
 import * as CodeWhispererClient from './codewhispererclient'
-import { CodeWhispererConstants } from '../models/constants'
+import * as CodeWhispererConstants from '../models/constants'
 import { ServiceOptions } from '../../shared/awsClientBuilder'
 import { invalidateAccessToken } from '../util/invalidateToken'
 import { isCloud9 } from '../../shared/extensionUtilities'

src/codewhisperer/commands/basicCommands.ts

@@ -8,7 +8,7 @@ import { telemetry } from '../../shared/telemetry/telemetry'
 import { showView } from '../vue/backend'
 import { ExtContext } from '../../shared/extensions'
 import { Commands } from '../../shared/vscode/commands2'
-import { CodeWhispererConstants } from '../models/constants'
+import * as CodeWhispererConstants from '../models/constants'
 import { getLogger } from '../../shared/logger'
 import { DefaultCodeWhispererClient } from '../client/codewhisperer'
 import { showAccessTokenPrompt } from '../util/showAccessTokenPrompt'
@@ -27,10 +27,10 @@ export const toggleCodeSuggestions = Commands.declare(
         await set(CodeWhispererConstants.autoTriggerEnabledKey, toSet, globalState)
         await vscode.commands.executeCommand('aws.codeWhisperer.refresh')
         telemetry.aws_modifySetting.emit({
-            settingId: CodeWhispererConstants.AutoSuggestion.settingId,
+            settingId: CodeWhispererConstants.autoSuggestionConfig.settingId,
             settingState: toSet
-                ? CodeWhispererConstants.AutoSuggestion.activated
-                : CodeWhispererConstants.AutoSuggestion.deactivated,
+                ? CodeWhispererConstants.autoSuggestionConfig.activated
+                : CodeWhispererConstants.autoSuggestionConfig.deactivated,
         })
     }
 )

src/codewhisperer/commands/onAcceptance.ts

@@ -4,7 +4,7 @@
  */
 
 import * as vscode from 'vscode'
-import { CodeWhispererConstants } from '../models/constants'
+import * as CodeWhispererConstants from '../models/constants'
 import { vsCodeState, OnRecommendationAcceptanceEntry } from '../models/model'
 import { runtimeLanguageContext } from '../util/runtimeLanguageContext'
 import { CodeWhispererTracker } from '../tracker/codewhispererTracker'

src/codewhisperer/commands/startSecurityScan.ts

@@ -9,7 +9,7 @@ import { isCloud9 } from '../../shared/extensionUtilities'
 import { initSecurityScanRender } from '../service/diagnosticsProvider'
 import { SecurityPanelViewProvider } from '../views/securityPanelViewProvider'
 import { getLogger } from '../../shared/logger'
-import { CodeWhispererConstants } from '../models/constants'
+import * as CodeWhispererConstants from '../models/constants'
 import { DependencyGraphFactory } from '../util/dependencyGraph/dependencyGraphFactory'
 import { JavaDependencyGraphError } from '../util/dependencyGraph/javaDependencyGraph'
 import {

src/codewhisperer/explorer/codewhispererNode.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode'
 import globals from '../../shared/extensionGlobals'
-import { CodeWhispererConstants } from '../models/constants'
+import * as CodeWhispererConstants from '../models/constants'
 import {
     createEnableCodeSuggestionsNode,
     createEnterAccessCodeNode,

src/codewhisperer/models/constants.ts

@@ -3,143 +3,191 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-export const CodeWhispererConstants = {
-    /**
-     * SDK Client
-     */
-    endpoint: 'https://codewhisperer.us-east-1.amazonaws.com/',
-    region: 'us-east-1',
-
-    /**
-     * Automated and manual trigger
-     */
-    invocationTimeIntervalThreshold: 2, // seconds
-    promiseTimeoutLimit: 15, // seconds
-    invocationKeyThreshold: 15,
-    specialCharactersList: ['{', '[', '(', ':', '\t', '\n'],
-    normalTextChangeRegex: /[A-Za-z0-9]/g,
-    AutoSuggestion: {
-        settingId: 'codewhisperer_autoSuggestionActivation',
-        activated: 'Activated',
-        deactivated: 'Deactivated',
-    },
-
-    /**
-     * EditorCon context
-     */
-    charactersLimit: 10240,
-    filenameCharsLimit: 1024,
-    naturalLanguage: 'en-US',
-    maxRecommendations: 1,
-    space: ' ',
-    lineBreak: '\n',
-    lineBreakWin: '\r\n',
-
-    /**
-     * Ux of recommendations
-     */
-    labelLength: 20,
-    completionDetail: 'CodeWhisperer',
-
-    /**
-     * CodeWhisperer in configuration
-     */
-    codewhisperer: 'CodeWhisperer',
-    /**
-     * Supported languages
-     */
-    java: 'java',
-    python: 'python',
-    javascript: 'javascript',
-    typescript: 'typescript',
-
-    supportedLanguages: ['java', 'python', 'javascript', 'typescript'],
-
-    /**
-     * Prompt
-     */
-    pendingResponse: 'Waiting for CodeWhisperer...',
-    runningSecurityScan: 'Running security scan...',
-    noSuggestions: 'No suggestions from CodeWhisperer',
-    licenseFilter: 'CodeWhisperer suggestions were filtered due to reference setting',
-
-    /**
-     * Beta landing page file
-     */
-    welcomeCodeWhispererReadmeFileSource: 'resources/markdown/WelcomeToCodeWhisperer.md',
-    welcomeCodeWhispererCloud9ReadmeFileSource: 'resources/markdown/WelcomeToCodeWhispererCloud9.md',
-    welcomeMessageKey: 'CODEWHISPERER_WELCOME_MESSAGE',
-
-    /**
-     * Key bindings JSON file path
-     */
-    keyBindingPathMac: 'Library/Application Support/Code/User/keybindings.json',
-    keyBindingPathLinux: '.config/Code/User/keybindings.json',
-    keyBindingPathWin: 'Code/User/keybindings.json',
-
-    /**
-     * Length of left context preview in output channel
-     */
-    contextPreviewLen: 20,
-
-    /**
-     * Unsupported language cache
-     */
-    unsupportedLanguagesCacheTTL: 10 * 60 * 60 * 1000,
-    unsupportedLanguagesKey: 'CODEWHISPERER_UNSUPPORTED_LANGUAGES_KEY',
-    autoTriggerEnabledKey: 'CODEWHISPERER_AUTO_TRIGGER_ENABLED',
-    termsAcceptedKey: 'CODEWHISPERER_TERMS_ACCEPTED',
-    serviceActiveKey: 'CODEWHISPERER_SERVICE_ACTIVE',
-    accessToken: 'CODEWHISPERER_ACCESS_TOKEN',
-
-    learnMoreUri: 'https://aws.amazon.com/codewhisperer',
-
-    previewSignupPortal: 'https://pages.awscloud.com/codewhisperer-sign-up-form.html',
-
-    identityPoolID: 'us-east-1:70717e99-906f-4add-908c-bd9074a2f5b9',
-    /**
-     * the interval of the background thread invocation, which is triggered by the timer
-     */
-    defaultCheckPeriodMillis: 1000 * 60 * 5,
-
-    // suggestion show delay, in milliseconds
-    suggestionShowDelay: 250,
-
-    referenceLog: 'CodeWhisperer Reference Log',
-
-    suggestionDetailReferenceText: (licenses: string) =>
-        `Reference code under ${licenses}. View full details in CodeWhisperer reference log.`,
-
-    hoverInlayText: (licenseName: string | undefined, repository: string | undefined) =>
-        `Reference code under the ${licenseName} license from repository ${repository}`,
-
-    referenceLogText: (code: string, license: string, repository: string, filePath: string, lineInfo: string) =>
-        `with code ${code} provided with reference under ${license} from repository ${repository}. Added to ${filePath} ${lineInfo}.`,
-
-    referenceLogPromptText: `Don\'t want suggestions that include code with references? Uncheck this option in 
-    <a href="#" onclick="openSettings();return false;">CodeWhisperer Settings</a>`,
-    /**
-     * Security Scan
-     */
-    codeScanJavaPayloadSizeLimitBytes: Math.pow(2, 20), // 1 MB
-    codeScanPythonPayloadSizeLimitBytes: 200 * Math.pow(2, 10), // 200 KB
-    codeScanTruncDirPrefix: 'codewhisperer_scan',
-    codeScanZipExt: '.zip',
-    contextTruncationTimeoutSeconds: 10,
-    codeScanJobTimeoutSeconds: 50,
-    projectSizeCalculateTimeoutSeconds: 10,
-    codeScanJobPollingIntervalSeconds: 5,
-    artifactTypeSource: 'SourceCode',
-    artifactTypeBuild: 'BuiltJars',
-    codeScanFindingsSchema: 'codescan/findings/1.0',
-
-    // telemetry experiment id
-    experimentId: 'codeWhisperer',
-
-    // wait time for editor to update editor.selection.active (in milliseconds)
-    vsCodeCursorUpdateDelay: 3,
-    // cloud9 access state
-    cloud9AccessStateKey: 'cloud9AccessStateKey',
-    cloud9AccessSent: 'Access requested!',
-    cloud9AccessAlreadySent: 'Access has already been requested, we are still processing it.',
+/**
+ * SDK Client
+ */
+export const endpoint = 'https://codewhisperer.us-east-1.amazonaws.com/'
+
+export const region = 'us-east-1'
+
+/**
+ * Automated and manual trigger
+ */
+export const invocationTimeIntervalThreshold = 2 // seconds
+
+export const promiseTimeoutLimit = 15 // seconds
+
+export const invocationKeyThreshold = 15
+
+export const specialCharactersList = ['{', '[', '(', ':', '\t', '\n']
+
+export const normalTextChangeRegex = /[A-Za-z0-9]/g
+
+export const autoSuggestionConfig = {
+    settingId: 'codewhisperer_autoSuggestionActivation',
+    activated: 'Activated',
+    deactivated: 'Deactivated',
 }
+
+/**
+ * EditorCon context
+ */
+export const charactersLimit = 10240
+
+export const filenameCharsLimit = 1024
+
+export const naturalLanguage = 'en-US'
+
+export const maxRecommendations = 1
+
+export const space = ' '
+
+export const lineBreak = '\n'
+
+export const lineBreakWin = '\r\n'
+
+/**
+ * Ux of recommendations
+ */
+export const labelLength = 20
+
+export const completionDetail = 'CodeWhisperer'
+
+/**
+ * CodeWhisperer in configuration
+ */
+export const codewhisperer = 'CodeWhisperer'
+
+/**
+ * Supported languages
+ */
+export const java = 'java'
+
+export const python = 'python'
+
+export const javascript = 'javascript'
+
+export const typescript = 'typescript'
+
+export const supportedLanguages = ['java', 'python', 'javascript', 'typescript']
+
+/**
+ * Prompt
+ */
+export const pendingResponse = 'Waiting for CodeWhisperer...'
+
+export const runningSecurityScan = 'Running security scan...'
+
+export const noSuggestions = 'No suggestions from CodeWhisperer'
+
+export const licenseFilter = 'CodeWhisperer suggestions were filtered due to reference setting'
+
+/**
+ * Beta landing page file
+ */
+export const welcomeCodeWhispererReadmeFileSource = 'resources/markdown/WelcomeToCodeWhisperer.md'
+
+export const welcomeCodeWhispererCloud9ReadmeFileSource = 'resources/markdown/WelcomeToCodeWhispererCloud9.md'
+
+export const welcomeMessageKey = 'CODEWHISPERER_WELCOME_MESSAGE'
+
+/**
+ * Key bindings JSON file path
+ */
+export const keyBindingPathMac = 'Library/Application Support/Code/User/keybindings.json'
+
+export const keyBindingPathLinux = '.config/Code/User/keybindings.json'
+
+export const keyBindingPathWin = 'Code/User/keybindings.json'
+
+/**
+ * Length of left context preview in output channel
+ */
+export const contextPreviewLen = 20
+
+/**
+ * Unsupported language cache
+ */
+export const unsupportedLanguagesCacheTTL = 10 * 60 * 60 * 1000
+
+export const unsupportedLanguagesKey = 'CODEWHISPERER_UNSUPPORTED_LANGUAGES_KEY'
+
+export const autoTriggerEnabledKey = 'CODEWHISPERER_AUTO_TRIGGER_ENABLED'
+
+export const termsAcceptedKey = 'CODEWHISPERER_TERMS_ACCEPTED'
+
+export const serviceActiveKey = 'CODEWHISPERER_SERVICE_ACTIVE'
+
+export const accessToken = 'CODEWHISPERER_ACCESS_TOKEN'
+
+export const learnMoreUri = 'https://aws.amazon.com/codewhisperer'
+
+export const previewSignupPortal = 'https://pages.awscloud.com/codewhisperer-sign-up-form.html'
+
+export const identityPoolID = 'us-east-1:70717e99-906f-4add-908c-bd9074a2f5b9'
+
+/**
+ * the interval of the background thread invocation, which is triggered by the timer
+ */
+export const defaultCheckPeriodMillis = 1000 * 60 * 5
+
+// suggestion show delay, in milliseconds
+export const suggestionShowDelay = 250
+
+export const referenceLog = 'CodeWhisperer Reference Log'
+
+export const suggestionDetailReferenceText = (licenses: string) =>
+    `Reference code under ${licenses}. View full details in CodeWhisperer reference log.`
+
+export const hoverInlayText = (licenseName: string | undefined, repository: string | undefined) =>
+    `Reference code under the ${licenseName} license from repository ${repository}`
+
+export const referenceLogText = (
+    code: string,
+    license: string,
+    repository: string,
+    filePath: string,
+    lineInfo: string
+) =>
+    `with code ${code} provided with reference under ${license} from repository ${repository}. Added to ${filePath} ${lineInfo}.`
+
+export const referenceLogPromptText = `Don\'t want suggestions that include code with references? Uncheck this option in 
+    <a href="#" onclick="openSettings();return false;">CodeWhisperer Settings</a>`
+
+/**
+ * Security Scan
+ */
+export const codeScanJavaPayloadSizeLimitBytes = Math.pow(2, 20) // 1 MB
+
+export const codeScanPythonPayloadSizeLimitBytes = 200 * Math.pow(2, 10) // 200 KB
+
+export const codeScanTruncDirPrefix = 'codewhisperer_scan'
+
+export const codeScanZipExt = '.zip'
+
+export const contextTruncationTimeoutSeconds = 10
+
+export const codeScanJobTimeoutSeconds = 50
+
+export const projectSizeCalculateTimeoutSeconds = 10
+
+export const codeScanJobPollingIntervalSeconds = 5
+
+export const artifactTypeSource = 'SourceCode'
+
+export const artifactTypeBuild = 'BuiltJars'
+
+export const codeScanFindingsSchema = 'codescan/findings/1.0'
+
+// telemetry experiment id
+export const experimentId = 'codeWhisperer'
+
+// wait time for editor to update editor.selection.active (in milliseconds)
+export const vsCodeCursorUpdateDelay = 3
+
+// cloud9 access state
+export const cloud9AccessStateKey = 'cloud9AccessStateKey'
+
+export const cloud9AccessSent = 'Access requested!'
+
+export const cloud9AccessAlreadySent = 'Access has already been requested, we are still processing it.'