fix(cwl): set LogEventFilter when constructing LiveTailSession #6008

## Problem
LogEventFilter is an optional configuration parameter when building a
LiveTailSession. Currently, the Constructor is not actually setting this
property so it is always undefined. This means that if a user sets a
Filter pattern, it will not be applied.

## Solution
Set the property in LiveTailSession Constructor.
Add missing unit tests to validate that LiveTailSession config values
are set properly. Testing via `buildStartLiveTailCommand` because this
is what actually gets sent to the CWL backend to start a
LiveTailSession.

Author: keeganirby

packages/core/src/awsService/cloudWatchLogs/registry/liveTailSession.ts

@@ -11,9 +11,10 @@ import {
 } from '@aws-sdk/client-cloudwatch-logs'
 import { LogStreamFilterResponse } from '../wizard/liveTailLogStreamSubmenu'
 import { CloudWatchLogsSettings, uriToKey } from '../cloudWatchLogsUtils'
-import { convertToTimeString, getLogger, globals, Settings, ToolkitError } from '../../../shared'
+import { getLogger, globals, Settings, ToolkitError } from '../../../shared'
 import { createLiveTailURIFromArgs } from './liveTailSessionRegistry'
 import { getUserAgent } from '../../../shared/telemetry/util'
+import { convertToTimeString } from '../../../shared/datetime'
 
 export type LiveTailSessionConfiguration = {
     logGroupArn: string
@@ -49,6 +50,7 @@ export class LiveTailSession {
     public constructor(configuration: LiveTailSessionConfiguration) {
         this._logGroupArn = configuration.logGroupArn
         this.logStreamFilter = configuration.logStreamFilter
+        this.logEventFilterPattern = configuration.logEventFilterPattern
         this.liveTailClient = {
             cwlClient: new CloudWatchLogsClient({
                 credentials: configuration.awsCredentials,
@@ -120,7 +122,7 @@ export class LiveTailSession {
         return this.endTime - this.startTime
     }
 
-    private buildStartLiveTailCommand(): StartLiveTailCommand {
+    public buildStartLiveTailCommand(): StartLiveTailCommand {
         let logStreamNamePrefix = undefined
         let logStreamName = undefined
         if (this.logStreamFilter) {

packages/core/src/test/awsService/cloudWatchLogs/registry/liveTailSession.test.ts

@@ -0,0 +1,80 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import assert from 'assert'
+import { LiveTailSession } from '../../../../awsService/cloudWatchLogs/registry/liveTailSession'
+import { StartLiveTailCommand } from '@aws-sdk/client-cloudwatch-logs'
+import { LogStreamFilterResponse } from '../../../../awsService/cloudWatchLogs/wizard/liveTailLogStreamSubmenu'
+
+describe('LiveTailSession', async function () {
+    const testLogGroupArn = 'arn:aws:test-log-group'
+    const testRegion = 'test-region'
+    const testFilter = 'test-filter'
+    const testAwsCredentials = {} as any as AWS.Credentials
+
+    it('builds StartLiveTailCommand: no stream Filter, no event filter.', function () {
+        const session = buildLiveTailSession({ type: 'all' }, undefined)
+        assert.deepStrictEqual(
+            session.buildStartLiveTailCommand().input,
+            new StartLiveTailCommand({
+                logGroupIdentifiers: [testLogGroupArn],
+                logEventFilterPattern: undefined,
+                logStreamNamePrefixes: undefined,
+                logStreamNames: undefined,
+            }).input
+        )
+    })
+
+    it('builds StartLiveTailCommand: with prefix stream Filter', function () {
+        const session = buildLiveTailSession({ type: 'prefix', filter: testFilter }, undefined)
+        assert.deepStrictEqual(
+            session.buildStartLiveTailCommand().input,
+            new StartLiveTailCommand({
+                logGroupIdentifiers: [testLogGroupArn],
+                logEventFilterPattern: undefined,
+                logStreamNamePrefixes: [testFilter],
+                logStreamNames: undefined,
+            }).input
+        )
+    })
+
+    it('builds StartLiveTailCommand: with specific stream Filter', function () {
+        const session = buildLiveTailSession({ type: 'specific', filter: testFilter }, undefined)
+        assert.deepStrictEqual(
+            session.buildStartLiveTailCommand().input,
+            new StartLiveTailCommand({
+                logGroupIdentifiers: [testLogGroupArn],
+                logEventFilterPattern: undefined,
+                logStreamNamePrefixes: undefined,
+                logStreamNames: [testFilter],
+            }).input
+        )
+    })
+
+    it('builds StartLiveTailCommand: with log event Filter', function () {
+        const session = buildLiveTailSession({ type: 'all' }, testFilter)
+        assert.deepStrictEqual(
+            session.buildStartLiveTailCommand().input,
+            new StartLiveTailCommand({
+                logGroupIdentifiers: [testLogGroupArn],
+                logEventFilterPattern: testFilter,
+                logStreamNamePrefixes: undefined,
+                logStreamNames: undefined,
+            }).input
+        )
+    })
+
+    function buildLiveTailSession(
+        logStreamFilter: LogStreamFilterResponse,
+        logEventFilterPattern: string | undefined
+    ): LiveTailSession {
+        return new LiveTailSession({
+            logGroupArn: testLogGroupArn,
+            logStreamFilter: logStreamFilter,
+            logEventFilterPattern: logEventFilterPattern,
+            region: testRegion,
+            awsCredentials: testAwsCredentials,
+        })
+    }
+})