Merge master into feature/q-dev-execution

Author: aws-toolkit-automation

packages/core/package.nls.json

@@ -92,6 +92,7 @@
     "AWS.command.appBuilder.deploy": "Deploy SAM Application",
     "AWS.command.appBuilder.build": "Build SAM Template",
     "AWS.command.appBuilder.searchLogs": "Search Logs",
+    "AWS.command.appBuilder.tailLogs": "Tail Logs",
     "AWS.command.refreshappBuilderExplorer": "Refresh Application Builder Explorer",
     "AWS.command.applicationComposer.openDialog": "Open Template with Infrastructure Composer...",
     "AWS.command.auth.addConnection": "Add New Connection",

packages/core/src/awsService/appBuilder/explorer/nodes/deployedNode.ts

@@ -10,7 +10,6 @@ import { createPlaceholderItem } from '../../../../shared/treeview/utils'
 import * as nls from 'vscode-nls'
 
 import { getLogger } from '../../../../shared/logger/logger'
-import { FunctionConfiguration, LambdaClient, GetFunctionCommand } from '@aws-sdk/client-lambda'
 import { DefaultLambdaClient } from '../../../../shared/clients/lambdaClient'
 import globals from '../../../../shared/extensionGlobals'
 import { defaultPartition } from '../../../../shared/regions/regionProvider'
@@ -28,7 +27,6 @@ import {
     s3BucketType,
 } from '../../../../shared/cloudformation/cloudformation'
 import { ToolkitError } from '../../../../shared'
-import { getIAMConnection } from '../../../../auth/utils'
 
 const localize = nls.loadMessageBundle()
 export interface DeployedResource {
@@ -89,8 +87,6 @@ export async function generateDeployedNode(
                 const defaultClient = new DefaultLambdaClient(regionCode)
                 const lambdaNode = new LambdaNode(regionCode, defaultClient)
                 let configuration: Lambda.FunctionConfiguration
-                let v3configuration
-                let logGroupName
                 try {
                     configuration = (await defaultClient.getFunction(deployedResource.PhysicalResourceId))
                         .Configuration as Lambda.FunctionConfiguration
@@ -101,31 +97,6 @@ export async function generateDeployedNode(
                         code: 'lambdaClientError',
                     })
                 }
-                const connection = await getIAMConnection({ prompt: false })
-                if (!connection || connection.type !== 'iam') {
-                    return [
-                        createPlaceholderItem(
-                            localize(
-                                'AWS.appBuilder.explorerNode.unavailableDeployedResource',
-                                '[Failed to retrive deployed resource. Ensure your AWS account is connected.]'
-                            )
-                        ),
-                    ]
-                }
-                const cred = await connection.getCredentials()
-                const v3Client = new LambdaClient({ region: regionCode, credentials: cred })
-
-                const v3command = new GetFunctionCommand({ FunctionName: deployedResource.PhysicalResourceId })
-                try {
-                    v3configuration = (await v3Client.send(v3command)).Configuration as FunctionConfiguration
-                    logGroupName = v3configuration.LoggingConfig?.LogGroup
-                } catch (error: any) {
-                    getLogger().error('Error getting Lambda V3 configuration: %O', error)
-                }
-                newDeployedResource.configuration = {
-                    ...newDeployedResource.configuration,
-                    logGroupName: logGroupName,
-                } as any
                 break
             }
             case s3BucketType: {

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

@@ -28,13 +28,13 @@ import { getLogger } from '../../shared/logger/logger'
 import { ToolkitError } from '../../shared'
 import { LiveTailCodeLensProvider } from './document/liveTailCodeLensProvider'
 
+export const liveTailRegistry = LiveTailSessionRegistry.instance
+export const liveTailCodeLensProvider = new LiveTailCodeLensProvider(liveTailRegistry)
 export async function activate(context: vscode.ExtensionContext, configuration: Settings): Promise<void> {
     const registry = LogDataRegistry.instance
-    const liveTailRegistry = LiveTailSessionRegistry.instance
 
     const documentProvider = new LogDataDocumentProvider(registry)
     const liveTailDocumentProvider = new LiveTailDocumentProvider()
-    const liveTailCodeLensProvider = new LiveTailCodeLensProvider(liveTailRegistry)
     context.subscriptions.push(
         vscode.languages.registerCodeLensProvider(
             {
@@ -150,7 +150,7 @@ export async function activate(context: vscode.ExtensionContext, configuration:
     )
 }
 
-function getFunctionLogGroupName(configuration: any) {
+export function getFunctionLogGroupName(configuration: any) {
     const logGroupPrefix = '/aws/lambda/'
-    return configuration.logGroupName || logGroupPrefix + configuration.FunctionName
+    return configuration.LoggingConfig?.LogGroup || logGroupPrefix + configuration.FunctionName
 }

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

@@ -17,15 +17,17 @@ import {
 import { getLogger, globals, ToolkitError } from '../../../shared'
 import { uriToKey } from '../cloudWatchLogsUtils'
 import { LiveTailCodeLensProvider } from '../document/liveTailCodeLensProvider'
+import { LogStreamFilterResponse } from '../wizard/liveTailLogStreamSubmenu'
 
 export async function tailLogGroup(
     registry: LiveTailSessionRegistry,
     source: string,
     codeLensProvider: LiveTailCodeLensProvider,
-    logData?: { regionName: string; groupName: string }
+    logData?: { regionName: string; groupName: string },
+    logStreamFilterData?: LogStreamFilterResponse
 ): Promise<void> {
     await telemetry.cloudwatchlogs_startLiveTail.run(async (span) => {
-        const wizard = new TailLogGroupWizard(logData)
+        const wizard = new TailLogGroupWizard(logData, logStreamFilterData)
         const wizardResponse = await wizard.run()
         if (!wizardResponse) {
             throw new CancellationError('user')

packages/core/src/awsService/cloudWatchLogs/wizard/tailLogGroupWizard.ts

@@ -24,7 +24,7 @@ export interface TailLogGroupWizardResponse {
 }
 
 export class TailLogGroupWizard extends Wizard<TailLogGroupWizardResponse> {
-    public constructor(logGroupInfo?: CloudWatchLogsGroupInfo) {
+    public constructor(logGroupInfo?: CloudWatchLogsGroupInfo, logStreamInfo?: LogStreamFilterResponse) {
         super({
             initState: {
                 regionLogGroupSubmenuResponse: logGroupInfo
@@ -33,6 +33,7 @@ export class TailLogGroupWizard extends Wizard<TailLogGroupWizardResponse> {
                           region: logGroupInfo.regionName,
                       }
                     : undefined,
+                logStreamFilter: logStreamInfo ?? undefined,
             },
         })
         this.form.regionLogGroupSubmenuResponse.bindPrompter(createRegionLogGroupSubmenu)

packages/core/src/lambda/activation.ts

@@ -4,6 +4,7 @@
  */
 
 import * as vscode from 'vscode'
+import { Lambda } from 'aws-sdk'
 import { deleteLambda } from './commands/deleteLambda'
 import { uploadLambdaCommand } from './commands/uploadLambda'
 import { LambdaFunctionNode } from './explorer/lambdaFunctionNode'
@@ -18,6 +19,11 @@ import { copyLambdaUrl } from './commands/copyLambdaUrl'
 import { ResourceNode } from '../awsService/appBuilder/explorer/nodes/resourceNode'
 import { isTreeNode, TreeNode } from '../shared/treeview/resourceTreeDataProvider'
 import { getSourceNode } from '../shared/utilities/treeNodeUtils'
+import { tailLogGroup } from '../awsService/cloudWatchLogs/commands/tailLogGroup'
+import { liveTailRegistry, liveTailCodeLensProvider } from '../awsService/cloudWatchLogs/activation'
+import { getFunctionLogGroupName } from '../awsService/cloudWatchLogs/activation'
+import { ToolkitError, isError } from '../shared'
+import { LogStreamFilterResponse } from '../awsService/cloudWatchLogs/wizard/liveTailLogStreamSubmenu'
 
 /**
  * Activates Lambda components.
@@ -76,6 +82,40 @@ export async function activate(context: ExtContext): Promise<void> {
 
         Commands.register('aws.launchDebugConfigForm', async (node: ResourceNode) =>
             registerSamDebugInvokeVueCommand(context.extensionContext, { resource: node })
-        )
+        ),
+
+        Commands.register('aws.appBuilder.tailLogs', async (node: LambdaFunctionNode | TreeNode) => {
+            let functionConfiguration: Lambda.FunctionConfiguration
+            try {
+                const sourceNode = getSourceNode<LambdaFunctionNode>(node)
+                functionConfiguration = sourceNode.configuration
+                const logGroupInfo = {
+                    regionName: sourceNode.regionCode,
+                    groupName: getFunctionLogGroupName(functionConfiguration),
+                }
+
+                const source = isTreeNode(node) ? 'AppBuilder' : 'AwsExplorerLambdaNode'
+                // Show all log streams without having to choose
+                const logStreamFilterData: LogStreamFilterResponse = { type: 'all' }
+                await tailLogGroup(
+                    liveTailRegistry,
+                    source,
+                    liveTailCodeLensProvider,
+                    logGroupInfo,
+                    logStreamFilterData
+                )
+            } catch (err) {
+                if (isError(err as Error, 'ResourceNotFoundException', "LogGroup doesn't exist.")) {
+                    // If we caught this error, then we know `functionConfiguration` actually has a value
+                    throw ToolkitError.chain(
+                        err,
+                        `Unable to fetch logs. Log group for function '${functionConfiguration!.FunctionName}' does not exist. ` +
+                            'Invoking your function at least once will create the log group.'
+                    )
+                } else {
+                    throw err
+                }
+            }
+        })
     )
 }

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

@@ -19,6 +19,7 @@ import { getTestWindow } from '../../../shared/vscode/window'
 import { CloudWatchLogsSettings, uriToKey } from '../../../../awsService/cloudWatchLogs/cloudWatchLogsUtils'
 import { DefaultAwsContext, ToolkitError, waitUntil } from '../../../../shared'
 import { LiveTailCodeLensProvider } from '../../../../awsService/cloudWatchLogs/document/liveTailCodeLensProvider'
+import { PrompterTester } from '../../../shared/wizards/prompterTester'
 
 describe('TailLogGroup', function () {
     const testLogGroup = 'test-log-group'
@@ -142,6 +143,48 @@ describe('TailLogGroup', function () {
         assert.strictEqual(stopLiveTailSessionSpy.calledOnce, true)
     })
 
+    it(`doesn't ask for stream filter if passed as parameter`, async function () {
+        sandbox.stub(DefaultAwsContext.prototype, 'getCredentialAccountId').returns(testAwsAccountId)
+        sandbox.stub(DefaultAwsContext.prototype, 'getCredentials').returns(Promise.resolve(testAwsCredentials))
+
+        // Returns one frame
+        async function* generator(): AsyncIterable<StartLiveTailResponseStream> {
+            yield getSessionUpdateFrame(false, `${testMessage}-1`, 1732276800000)
+        }
+
+        startLiveTailSessionSpy = sandbox
+            .stub(LiveTailSession.prototype, 'startLiveTailSession')
+            .returns(Promise.resolve(generator()))
+
+        const prompterTester = PrompterTester.init()
+            .handleInputBox('Provide log event filter pattern', (inputBox) => {
+                inputBox.acceptValue('filter')
+            })
+            .build()
+
+        // Set maxLines to 1.
+        cloudwatchSettingsSpy = sandbox.stub(CloudWatchLogsSettings.prototype, 'get').returns(1)
+
+        // The mock stream doesn't 'close', causing tailLogGroup to not return. If we `await`, it will never resolve.
+        // Run it in the background and use waitUntil to poll its state.
+        void tailLogGroup(
+            registry,
+            testSource,
+            codeLensProvider,
+            {
+                groupName: testLogGroup,
+                regionName: testRegion,
+            },
+            { type: 'all' }
+        )
+        await waitUntil(async () => registry.size !== 0, { interval: 100, timeout: 1000 })
+
+        prompterTester.assertCall('Provide log event filter pattern', 1)
+
+        assert.strictEqual(startLiveTailSessionSpy.calledOnce, true)
+        assert.strictEqual(registry.size, 1)
+    })
+
     it('throws if crendentials are undefined', async function () {
         sandbox.stub(DefaultAwsContext.prototype, 'getCredentials').returns(Promise.resolve(undefined))
         wizardSpy = sandbox.stub(TailLogGroupWizard.prototype, 'run').callsFake(async function () {

packages/core/src/test/awsService/cloudWatchLogs/wizard/tailLogGroupWizard.test.ts

@@ -44,6 +44,21 @@ describe('TailLogGroupWizard', async function () {
         tester.filterPattern.assertShowSecond()
     })
 
+    it('skips logStream filter when logStream info is provided', async function () {
+        sandbox.stub(DefaultAwsContext.prototype, 'getCredentialAccountId').returns(testAwsAccountId)
+        const wizard = new TailLogGroupWizard(
+            {
+                groupName: testLogGroupName,
+                regionName: testRegion,
+            },
+            { type: 'specific', filter: 'log-group-name' }
+        )
+        const tester = await createWizardTester(wizard)
+        tester.regionLogGroupSubmenuResponse.assertDoesNotShow()
+        tester.logStreamFilter.assertDoesNotShow()
+        tester.filterPattern.assertShowFirst()
+    })
+
     it('builds LogGroup Arn properly', async function () {
         sandbox.stub(DefaultAwsContext.prototype, 'getCredentialAccountId').returns(testAwsAccountId)
         const arn = buildLogGroupArn(testLogGroupName, testRegion)

packages/toolkit/.changes/next-release/Feature-48c399ea-d42f-4ea1-8f32-d8bc1486a107.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "From the Lambda treeview in AWS Explorer, you can now right-click on a function name and start a CloudWatch Logs Live Tail sessions for the selected function."
+}

packages/toolkit/package.json

@@ -902,6 +902,10 @@
                     "command": "aws.appBuilderForFileExplorer.refresh",
                     "when": "false"
                 },
+                {
+                    "command": "aws.appBuilder.tailLogs",
+                    "when": "false"
+                },
                 {
                     "command": "aws.appBuilder.viewDocs",
                     "when": "false"
@@ -1641,6 +1645,11 @@
                     "when": "view =~ /^(aws.explorer|aws.appBuilder|aws.appBuilderForFileExplorer)$/ && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode)$/",
                     "group": "0@3"
                 },
+                {
+                    "command": "aws.appBuilder.tailLogs",
+                    "when": "view =~ /^(aws.explorer|aws.appBuilder|aws.appBuilderForFileExplorer)$/ && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode)$/",
+                    "group": "0@4"
+                },
                 {
                     "command": "aws.deleteCloudFormation",
                     "when": "view == aws.explorer && viewItem == awsCloudFormationNode",
@@ -2140,6 +2149,11 @@
                     "command": "aws.appBuilder.searchLogs",
                     "when": "view =~ /^(aws.explorer|aws.appBuilder|aws.appBuilderForFileExplorer)$/ && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode)$/",
                     "group": "inline@2"
+                },
+                {
+                    "command": "aws.appBuilder.tailLogs",
+                    "when": "view =~ /^(aws.explorer|aws.appBuilder|aws.appBuilderForFileExplorer)$/ && viewItem =~ /^(awsRegionFunctionNode|awsRegionFunctionNodeDownloadable|awsCloudFormationFunctionNode)$/",
+                    "group": "inline@3"
                 }
             ],
             "aws.toolkit.auth": [
@@ -3749,6 +3763,13 @@
                 "category": "%AWS.title%",
                 "icon": "$(search-view-icon)"
             },
+            {
+                "command": "aws.appBuilder.tailLogs",
+                "title": "%AWS.command.appBuilder.tailLogs%",
+                "enablement": "isCloud9 || !aws.isWebExtHost",
+                "category": "%AWS.title%",
+                "icon": "$(search-show-context)"
+            },
             {
                 "command": "aws.appBuilder.deploy",
                 "title": "%AWS.command.appBuilder.deploy%",