address pr feedback

Author: Keegan Irby

packages/core/src/awsService/cloudWatchLogs/activation.ts

@@ -91,13 +91,13 @@ export async function activate(context: vscode.ExtensionContext, configuration:
         Commands.register('aws.cwl.changeFilterPattern', async () => changeLogSearchParams(registry, 'filterPattern')),
 
         Commands.register('aws.cwl.changeTimeFilter', async () => changeLogSearchParams(registry, 'timeFilter')),
-    
+
         Commands.register('aws.cwl.tailLogGroup', async (node: LogGroupNode | CloudWatchLogsNode) => {
             const logGroupInfo =
                 node instanceof LogGroupNode
                     ? { regionName: node.regionCode, groupName: node.logGroup.logGroupName! }
                     : undefined
             await tailLogGroup(logGroupInfo)
-        }),
+        })
     )
 }

packages/core/src/awsService/cloudWatchLogs/commands/tailLogGroup.ts

@@ -13,7 +13,8 @@ import { CloudWatchLogsGroupInfo } from '../registry/logDataRegistry'
 import { RegionSubmenu, RegionSubmenuResponse } from '../../../shared/ui/common/regionSubmenu'
 import { CancellationError } from '../../../shared/utilities/timeoutUtils'
 import { LogStreamFilterResponse, LogStreamFilterSubmenu } from '../liveTailLogStreamSubmenu'
-import { getLogger } from '../../../shared'
+import { getLogger, ToolkitError } from '../../../shared'
+import { cwlFilterPatternHelpUrl } from '../../../shared/constants'
 
 const localize = nls.loadMessageBundle()
 
@@ -49,7 +50,7 @@ export class TailLogGroupWizard extends Wizard<TailLogGroupWizardResponse> {
         this.form.regionLogGroupSubmenuResponse.bindPrompter(createRegionLogGroupSubmenu)
         this.form.logStreamFilter.bindPrompter((state) => {
             if (!state.regionLogGroupSubmenuResponse?.data) {
-                throw Error('LogGroupName is null')
+                throw new ToolkitError('LogGroupName is null')
             }
             return new LogStreamFilterSubmenu(
                 state.regionLogGroupSubmenuResponse.data,
@@ -80,7 +81,7 @@ async function getLogGroupQuickPickOptions(regionCode: string): Promise<DataQuic
 
     for await (const logGroupObject of logGroups) {
         if (!logGroupObject.arn || !logGroupObject.logGroupName) {
-            throw Error('LogGroupObject name or arn undefined')
+            throw new ToolkitError('LogGroupObject name or arn undefined')
         }
 
         logGroupsOptions.push({
@@ -97,7 +98,7 @@ function formatLogGroupArn(logGroupArn: string): string {
 }
 
 export function createFilterPatternPrompter() {
-    const helpUri = 'https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html'
+    const helpUri = cwlFilterPatternHelpUrl
     return createInputBox({
         title: 'Provide log event filter pattern',
         placeholder: 'filter pattern (case sensitive; empty matches all)',

packages/core/src/awsService/cloudWatchLogs/liveTailLogStreamSubmenu.ts

@@ -11,13 +11,13 @@ import { pageableToCollection } from '../../shared/utilities/collectionUtils'
 import { CloudWatchLogs } from 'aws-sdk'
 import { isValidResponse, StepEstimator } from '../../shared/wizards/wizard'
 import { isNonNullable } from '../../shared/utilities/tsUtils'
+import {
+    startLiveTailHelpUrl,
+    startLiveTailLogStreamNamesHelpUrl,
+    startLiveTailLogStreamPrefixHelpUrl,
+} from '../../shared/constants'
 
-export enum LogStreamFilterType {
-    MENU = 'menu',
-    PREFIX = 'prefix',
-    SPECIFIC = 'specific',
-    ALL = 'all',
-}
+export type LogStreamFilterType = 'menu' | 'prefix' | 'specific' | 'all'
 
 export interface LogStreamFilterResponse {
     readonly filter?: string
@@ -26,7 +26,7 @@ export interface LogStreamFilterResponse {
 
 export class LogStreamFilterSubmenu extends Prompter<LogStreamFilterResponse> {
     private logStreamPrefixRegEx = /^[^:*]*$/
-    private currentState: LogStreamFilterType = LogStreamFilterType.MENU
+    private currentState: LogStreamFilterType = 'menu'
     private steps?: [current: number, total: number]
     private region: string
     private logGroupArn: string
@@ -39,7 +39,7 @@ export class LogStreamFilterSubmenu extends Prompter<LogStreamFilterResponse> {
     }
 
     public createMenuPrompter() {
-        const helpUri = 'https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html'
+        const helpUri = startLiveTailHelpUrl
         const prompter = createQuickPick(this.menuOptions, {
             title: 'Select LogStream filter type',
             buttons: createCommonButtons(helpUri),
@@ -52,24 +52,23 @@ export class LogStreamFilterSubmenu extends Prompter<LogStreamFilterResponse> {
         options.push({
             label: 'All',
             detail: 'Include log events from all LogStreams in the selected LogGroup',
-            data: LogStreamFilterType.ALL,
+            data: 'all',
         })
         options.push({
             label: 'Specific',
             detail: 'Include log events from only a specific LogStream',
-            data: LogStreamFilterType.SPECIFIC,
+            data: 'specific',
         })
         options.push({
             label: 'Prefix',
             detail: 'Include log events from LogStreams that begin with a provided prefix',
-            data: LogStreamFilterType.PREFIX,
+            data: 'prefix',
         })
         return options
     }
 
     public createLogStreamPrefixBox(): InputBoxPrompter {
-        const helpUri =
-            'https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html#CWL-StartLiveTail-request-logStreamNamePrefixes'
+        const helpUri = startLiveTailLogStreamPrefixHelpUrl
         return createInputBox({
             title: 'Enter LogStream prefix',
             placeholder: 'logStream prefix (case sensitive; empty matches all)',
@@ -90,8 +89,7 @@ export class LogStreamFilterSubmenu extends Prompter<LogStreamFilterResponse> {
     }
 
     public createLogStreamSelector(): QuickPickPrompter<string> {
-        const helpUri =
-            'https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html#CWL-StartLiveTail-request-logStreamNames'
+        const helpUri = startLiveTailLogStreamNamesHelpUrl
         const client = new DefaultCloudWatchLogsClient(this.region)
         const request: CloudWatchLogs.DescribeLogStreamsRequest = {
             logGroupIdentifier: this.logGroupArn,
@@ -118,37 +116,37 @@ export class LogStreamFilterSubmenu extends Prompter<LogStreamFilterResponse> {
     protected async promptUser(): Promise<PromptResult<LogStreamFilterResponse>> {
         while (true) {
             switch (this.currentState) {
-                case LogStreamFilterType.MENU: {
+                case 'menu': {
                     const prompter = this.createMenuPrompter()
                     this.steps && prompter.setSteps(this.steps[0], this.steps[1])
 
                     const resp = await prompter.prompt()
-                    if (resp === LogStreamFilterType.PREFIX) {
-                        this.switchState(LogStreamFilterType.PREFIX)
-                    } else if (resp === LogStreamFilterType.SPECIFIC) {
-                        this.switchState(LogStreamFilterType.SPECIFIC)
-                    } else if (resp === LogStreamFilterType.ALL) {
+                    if (resp === 'prefix') {
+                        this.switchState('prefix')
+                    } else if (resp === 'specific') {
+                        this.switchState('specific')
+                    } else if (resp === 'all') {
                         return { filter: undefined, type: resp }
                     } else {
                         return undefined
                     }
 
                     break
                 }
-                case LogStreamFilterType.PREFIX: {
+                case 'prefix': {
                     const resp = await this.createLogStreamPrefixBox().prompt()
                     if (isValidResponse(resp)) {
-                        return { filter: resp, type: LogStreamFilterType.PREFIX }
+                        return { filter: resp, type: 'prefix' }
                     }
-                    this.switchState(LogStreamFilterType.MENU)
+                    this.switchState('menu')
                     break
                 }
-                case LogStreamFilterType.SPECIFIC: {
+                case 'specific': {
                     const resp = await this.createLogStreamSelector().prompt()
                     if (isValidResponse(resp)) {
-                        return { filter: resp, type: LogStreamFilterType.SPECIFIC }
+                        return { filter: resp, type: 'specific' }
                     }
-                    this.switchState(LogStreamFilterType.MENU)
+                    this.switchState('menu')
                     break
                 }
             }

packages/core/src/shared/constants.ts

@@ -113,6 +113,14 @@ export const ecsIamPermissionsUrl = vscode.Uri.parse(
 export const CLOUDWATCH_LOGS_SCHEME = 'aws-cwl' // eslint-disable-line @typescript-eslint/naming-convention
 export const AWS_SCHEME = 'aws' // eslint-disable-line @typescript-eslint/naming-convention
 
+export const startLiveTailHelpUrl =
+    'https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html'
+export const startLiveTailLogStreamPrefixHelpUrl = `${startLiveTailHelpUrl}#CWL-StartLiveTail-request-logStreamNamePrefixes`
+export const startLiveTailLogStreamNamesHelpUrl = `${startLiveTailHelpUrl}#CWL-StartLiveTail-request-logStreamNames`
+
+export const cwlFilterPatternHelpUrl =
+    'https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html'
+
 export const lambdaPackageTypeImage = 'Image'
 
 // URLs for App Runner