fix(cloudwatch): "Search Log Group" shows multiple progress popups #3788

Problem:
When entering filter pattern for the "Search Log Group" action, the
validation action does its own mini-search, before the actual search is
done. The user sees multiple popups, which feels clunky.

Solution:
Ignore query parameters when calculating the message "id".

Author: justinmk3

.changes/next-release/Bug Fix-d9e4139d-a80c-4259-8492-605a5bce232a.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "CloudWatch Logs: \"Search Log Group\" shows multiple progress popups"
+}

src/cloudWatchLogs/cloudWatchLogsUtils.ts

@@ -45,6 +45,17 @@ export function uriToKey(uri: vscode.Uri): string {
     return uri.path
 }
 
+/**
+ * Creates a message key from region + loggroup + logstream.
+ *
+ * Intentionally _ignores_ query parameters, so that the validation step can use the same progress
+ * message as the actual log group search. That results in a more fluid UX.
+ */
+export function msgKey(logGroupInfo: CloudWatchLogsGroupInfo): string {
+    const uri = createURIFromArgs(logGroupInfo, {})
+    return uri.toString()
+}
+
 /**
  * Destructures an awsCloudWatchLogs URI into its component pieces.
  * @param uri URI for a Cloudwatch Logs file

src/cloudWatchLogs/commands/searchLogGroup.ts

@@ -16,7 +16,7 @@ import {
 } from '../registry/logDataRegistry'
 import { DataQuickPickItem } from '../../shared/ui/pickerPrompter'
 import { isValidResponse, isWizardControl, Wizard, WIZARD_RETRY } from '../../shared/wizards/wizard'
-import { createURIFromArgs, parseCloudWatchLogsUri, recordTelemetryFilter } from '../cloudWatchLogsUtils'
+import { createURIFromArgs, msgKey, parseCloudWatchLogsUri, recordTelemetryFilter } from '../cloudWatchLogsUtils'
 import { DefaultCloudWatchLogsClient } from '../../shared/clients/cloudWatchLogsClient'
 import { CancellationError } from '../../shared/utilities/timeoutUtils'
 import { getLogger } from '../../shared/logger'
@@ -28,6 +28,7 @@ import { truncate } from '../../shared/utilities/textUtilities'
 import { createBackButton, createExitButton, createHelpButton } from '../../shared/ui/buttons'
 import { PromptResult } from '../../shared/ui/prompter'
 import { ToolkitError } from '../../shared/errors'
+import { Messages } from '../../shared/utilities/messages'
 
 const localize = nls.loadMessageBundle()
 
@@ -192,9 +193,13 @@ export class SearchPatternPrompter extends InputBoxPrompter {
                     limit: 1,
                 },
                 undefined,
-                true
+                false
             )
         } catch (e) {
+            // Validation error. Get the progress message from the global map and cancel it.
+            const msgTimeout = await Messages.putMessage(msgKey(this.logGroup), '')
+            msgTimeout.cancel()
+
             return (e as Error).message
         }
         return undefined

src/cloudWatchLogs/registry/logDataRegistry.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode'
 import { CloudWatchLogs } from 'aws-sdk'
-import { CloudWatchLogsSettings, parseCloudWatchLogsUri, uriToKey, createURIFromArgs } from '../cloudWatchLogsUtils'
+import { CloudWatchLogsSettings, parseCloudWatchLogsUri, uriToKey, msgKey } from '../cloudWatchLogsUtils'
 import { DefaultCloudWatchLogsClient } from '../../shared/clients/cloudWatchLogsClient'
 import { waitTimeout } from '../../shared/utilities/timeoutUtils'
 import { Messages } from '../../shared/utilities/messages'
@@ -78,9 +78,13 @@ export class LogDataRegistry {
         // We are at the earliest data and trying to go back in time, there is nothing to see.
         // If we don't return now, redundant data will be retrieved.
         if (isHead && logData.previous?.token === undefined) {
-            const msgId = uriToKey(uri)
             // show something so the user doesn't think nothing happened.
-            await Messages.putMessage(msgId, `Loading from: '${logData.logGroupInfo.groupName}'`, undefined, 500)
+            await Messages.putMessage(
+                msgKey(logData.logGroupInfo),
+                `Loading from: '${logData.logGroupInfo.groupName}'`,
+                undefined,
+                500
+            )
             return []
         }
 
@@ -108,8 +112,10 @@ export class LogDataRegistry {
             return last
         }
 
-        const msgId = uriToKey(uri)
-        const msgTimeout = await Messages.putMessage(msgId, `Loading from: '${logData.logGroupInfo.groupName}'`)
+        const msgTimeout = await Messages.putMessage(
+            msgKey(logData.logGroupInfo),
+            `Loading from: '${logData.logGroupInfo.groupName}'`
+        )
         const responseData = await firstOrLast(stream, resp => resp.events.length > 0).finally(() => {
             msgTimeout.dispose()
         })
@@ -232,8 +238,7 @@ export async function filterLogEventsFromUri(
         delete cwlParameters.logStreamNames
     }
 
-    const msgId = uriToKey(createURIFromArgs(logGroupInfo, parameters))
-    const msgTimeout = await Messages.putMessage(msgId, `Loading from: '${logGroupInfo.groupName}'`, {
+    const msgTimeout = await Messages.putMessage(msgKey(logGroupInfo), `Loading from: '${logGroupInfo.groupName}'`, {
         message: logGroupInfo.streamName ?? '',
     })