feat(amazonq): skip registering run command log file

Author: karanA-aws

packages/amazonq/.changes/next-release/Feature-86f056f5-4ac4-47be-8167-09c19a529a1e.json

@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "The logs emitted by the Agent during user command execution will be accepted and written to .amazonq/dev/run_command.log file in the user's local repository."
+}

packages/core/src/amazonq/session/sessionState.ts

@@ -29,6 +29,7 @@ import { prepareRepoData, getDeletedFileInfos, registerNewFiles, PrepareRepoData
 import { uploadCode } from '../util/upload'
 
 export const EmptyCodeGenID = 'EMPTY_CURRENT_CODE_GENERATION_ID'
+export const RunCommandLogFileName = '.amazonq/dev/run_command.log'
 
 export interface BaseMessenger {
     sendAnswer(params: any): void
@@ -103,6 +104,16 @@ export abstract class CodeGenBase {
                 case CodeGenerationStatus.COMPLETE: {
                     const { newFileContents, deletedFiles, references } =
                         await this.config.proxyClient.exportResultArchive(this.conversationId)
+
+                    const logFileInfo = newFileContents.find(
+                        (file: { zipFilePath: string; fileContent: string }) =>
+                            file.zipFilePath === RunCommandLogFileName
+                    )
+                    if (logFileInfo) {
+                        getLogger().info(`Run Command logs: \n ${logFileInfo.fileContent}`)
+                        newFileContents.splice(newFileContents.indexOf(logFileInfo), 1)
+                    }
+
                     const newFileInfo = registerNewFiles(
                         fs,
                         newFileContents,

packages/core/src/shared/virtualFilesystem.ts

@@ -46,7 +46,6 @@ export class VirtualFileSystem implements vscode.FileSystemProvider {
         if (this.fileProviders[key] !== undefined) {
             throw new Error('Cannot re-register a provider for the same URI')
         }
-
         this.fileProviders[key] = provider
         const onDidChange = provider.onDidChange(() => {
             this._onDidChangeFile.fire([{ uri, type: vscode.FileChangeType.Changed }])

packages/core/src/test/amazonq/session/sessionState.test.ts

@@ -0,0 +1,186 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as vscode from 'vscode'
+import sinon from 'sinon'
+import { CodeGenBase } from '../../../amazonq/session/sessionState'
+import { RunCommandLogFileName } from '../../../amazonq/session/sessionState'
+import assert from 'assert'
+import * as workspaceUtils from '../../../shared/utilities/workspaceUtils'
+import * as loggerModule from '../../../shared/logger/logger'
+
+describe('CodeGenBase generateCode log file handling', () => {
+    class TestCodeGen extends CodeGenBase {
+        public generatedFiles: any[] = []
+        constructor(config: any, tabID: string) {
+            super(config, tabID)
+        }
+        protected handleProgress(_messenger: any): void {
+            // No-op for test.
+        }
+        protected getScheme(): string {
+            return 'file'
+        }
+        protected getTimeoutErrorCode(): string {
+            return 'test_timeout'
+        }
+        protected handleGenerationComplete(_messenger: any, newFileInfo: any[]): void {
+            this.generatedFiles = newFileInfo
+        }
+        protected handleError(_messenger: any, _codegenResult: any): Error {
+            throw new Error('handleError called')
+        }
+    }
+
+    let fakeProxyClient: any
+    let testConfig: any
+    let fsMock: any
+    let messengerMock: any
+    let telemetryMock: any
+    let loggerMock: any
+    let testAction: any
+
+    beforeEach(async () => {
+        // const workspaceFolder = await createTestWorkspace(1, { workspaceName: 'test-workspace-folder' })
+        const ret = {
+            testworkspacefolder: {
+                uri: vscode.Uri.file('/path/to/testworkspacefolder'),
+                name: 'testworkspacefolder',
+                index: 0,
+            },
+        }
+        // Stub getWorkspaceFoldersByPrefixes to return the real workspace folder.
+        sinon.stub(workspaceUtils, 'getWorkspaceFoldersByPrefixes').returns(ret)
+
+        fakeProxyClient = {
+            getCodeGeneration: sinon.stub().resolves({
+                codeGenerationStatus: { status: 'Complete' },
+                codeGenerationRemainingIterationCount: 0,
+                codeGenerationTotalIterationCount: 1,
+            }),
+            exportResultArchive: sinon.stub(),
+        }
+
+        testConfig = {
+            conversationId: 'conv_test',
+            uploadId: 'upload_test',
+            workspaceRoots: ['/path/to/testworkspacefolder'],
+            proxyClient: fakeProxyClient,
+        }
+
+        fsMock = {
+            writeFile: sinon.stub().resolves(),
+            registerProvider: sinon.stub().resolves(),
+        }
+
+        messengerMock = { sendAnswer: sinon.spy() }
+
+        telemetryMock = {
+            setCodeGenerationResult: sinon.spy(),
+            setNumberOfFilesGenerated: sinon.spy(),
+            setAmazonqNumberOfReferences: sinon.spy(),
+            setGenerateCodeIteration: sinon.spy(),
+            setGenerateCodeLastInvocationTime: sinon.spy(),
+            recordUserCodeGenerationTelemetry: sinon.spy(),
+        }
+
+        loggerMock = {
+            info: sinon.spy(),
+        }
+
+        testAction = {
+            fs: fsMock,
+            messenger: messengerMock,
+            logger: loggerMock,
+            tokenSource: {
+                token: {
+                    isCancellationRequested: false,
+                    onCancellationRequested: () => {},
+                },
+            },
+        }
+    })
+
+    afterEach(() => {
+        sinon.restore()
+    })
+
+    it('adds the log content to logger if present and excludes it from new files', async () => {
+        const logFileInfo = {
+            zipFilePath: RunCommandLogFileName,
+            fileContent: 'Log content',
+        }
+        const otherFile = { zipFilePath: 'other.ts', fileContent: 'other content' }
+        fakeProxyClient.exportResultArchive.resolves({
+            newFileContents: [logFileInfo, otherFile],
+            deletedFiles: [],
+            references: [],
+        })
+        const controlledLogger = {
+            info: sinon.spy(),
+            debug: sinon.spy(),
+            verbose: sinon.spy(),
+            warn: sinon.spy(),
+            error: sinon.spy(),
+            log: sinon.spy(),
+            setLogLevel: sinon.spy(),
+            setLogLevelToDefault: sinon.spy(),
+            logLevelEnabled: sinon.spy(),
+            getLogById: sinon.spy(),
+            sendToLog: sinon.spy(),
+        }
+        sinon.stub(loggerModule, 'getLogger').returns(controlledLogger)
+        const testCodeGen = new TestCodeGen(testConfig, 'tab1')
+
+        const result = await testCodeGen.generateCode({
+            messenger: messengerMock,
+            fs: fsMock,
+            codeGenerationId: 'codegen1',
+            telemetry: telemetryMock,
+            workspaceFolders: [testConfig.workspaceRoots[0]],
+            action: testAction,
+        })
+
+        sinon.assert.calledWith(controlledLogger.info, sinon.match(`Run Command logs: \n Log content`))
+        assert.deepStrictEqual(result.newFiles, [otherFile])
+    })
+
+    it('skips log file handling if log file is not present', async () => {
+        const file1 = { zipFilePath: 'file1.ts', fileContent: 'content1' }
+        fakeProxyClient.exportResultArchive.resolves({
+            newFileContents: [file1],
+            deletedFiles: [],
+            references: [],
+        })
+
+        const testCodeGen = new TestCodeGen(testConfig, 'tab1')
+
+        const result = await testCodeGen.generateCode({
+            messenger: messengerMock,
+            fs: fsMock,
+            codeGenerationId: 'codegen2',
+            telemetry: telemetryMock,
+            workspaceFolders: [testConfig.workspaceRoots[0]],
+            action: testAction,
+        })
+
+        sinon.assert.notCalled(loggerMock.info)
+
+        const expectedNewFile = {
+            zipFilePath: 'file1.ts',
+            fileContent: 'content1',
+            changeApplied: false,
+            rejected: false,
+            relativePath: 'file1.ts',
+            virtualMemoryUri: vscode.Uri.file(`/upload_test/file1.ts`),
+            workspaceFolder: {
+                index: 0,
+                name: 'testworkspacefolder',
+                uri: vscode.Uri.file('/path/to/testworkspacefolder'),
+            },
+        }
+        assert.deepStrictEqual(result.newFiles, [expectedNewFile])
+    })
+})

packages/core/src/test/amazonqDoc/session/sessionState.test.ts

@@ -8,7 +8,6 @@ import assert from 'assert'
 import sinon from 'sinon'
 import { DocPrepareCodeGenState } from '../../../amazonqDoc'
 import { createMockSessionStateAction } from '../../amazonq/utils'
-
 import { createTestContext, setupTestHooks } from '../../amazonq/session/testSetup'
 
 describe('sessionStateDoc', () => {