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

@@ -4,11 +4,12 @@
  */
 
 import * as vscode from 'vscode'
+import * as path from 'path'
 import { ToolkitError } from '../../shared/errors'
 import globals from '../../shared/extensionGlobals'
 import { getLogger } from '../../shared/logger/logger'
 import { AmazonqCreateUpload, Span, telemetry } from '../../shared/telemetry/telemetry'
-import { VirtualFileSystem } from '../../shared/virtualFilesystem'
+import { FileProvider, VirtualFileSystem } from '../../shared/virtualFilesystem'
 import { CodeReference, UploadHistory } from '../webview/ui/connector'
 import { AuthUtil } from '../../codewhisperer/util/authUtil'
 import { randomUUID } from '../../shared/crypto'
@@ -27,8 +28,10 @@ import {
 } from '../commons/types'
 import { prepareRepoData, getDeletedFileInfos, registerNewFiles, PrepareRepoDataOptions } from '../util/files'
 import { uploadCode } from '../util/upload'
+import { VirtualMemoryFile } from '../../shared/virtualMemoryFile'
 
 export const EmptyCodeGenID = 'EMPTY_CURRENT_CODE_GENERATION_ID'
+const RunCommandLogFileName = '.amazonq/dev/run_command.log'
 
 export interface BaseMessenger {
     sendAnswer(params: any): void
@@ -103,6 +106,44 @@ 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
+                    )
+                    getLogger().info(`Log file info: %O`, logFileInfo)
+                    if (logFileInfo) {
+                        const filePath = path.join(this.config.workspaceRoots[0], RunCommandLogFileName)
+                        // const fileUri = vscode.Uri.file(filePath)
+                        getLogger().info(`Writing log file to ${filePath}`)
+
+                        try {
+                            // ensure the directory exists before writing the log file
+                            // const logDir = path.dirname(fileUri.fsPath)
+                            // Optionally check if the directory exists or create it recursively
+                            const encoder = new TextEncoder()
+                            const contents = encoder.encode(logFileInfo.fileContent)
+                            const provider: FileProvider = new VirtualMemoryFile(contents)
+                            const options = {
+                                create: true,
+                                overwrite: true,
+                            }
+                            await provider.write(logFileInfo.fileContent, options)
+                            // await fs.writeFile(fileUri, logFileInfo.fileContent, {
+                            //     create: true,
+                            //     overwrite: true,
+                            // })
+                        } catch (e) {
+                            const errorDetails =
+                                e instanceof Error ? `${e.name}: ${e.message}\nStack Trace: ${e.stack}` : String(e)
+                            getLogger().error(`Error writing log file. Details: ${errorDetails}`)
+                        }
+
+                        // getLogger().info(`Log file written to ${filePath}`)
+                        newFileContents.splice(newFileContents.indexOf(logFileInfo), 1)
+                        getLogger().info(`Log file removed from new files %O`, newFileContents)
+                    }
+
                     const newFileInfo = registerNewFiles(
                         fs,
                         newFileContents,
@@ -111,6 +152,7 @@ export abstract class CodeGenBase {
                         this.conversationId,
                         this.getScheme()
                     )
+                    getLogger().info(`New files Info registered: %O`, newFileInfo)
                     telemetry.setNumberOfFilesGenerated(newFileInfo.length)
 
                     this.handleGenerationComplete(messenger, newFileInfo, action)
@@ -361,6 +403,7 @@ export abstract class BaseCodeGenState extends CodeGenBase implements SessionSta
                     workspaceFolders: this.config.workspaceFolders,
                     action,
                 })
+                getLogger().debug(`Code generation result: %O`, codeGeneration)
 
                 if (codeGeneration && !action.tokenSource?.token.isCancellationRequested) {
                     this.config.currentCodeGenerationId = codeGenerationId

packages/core/src/shared/virtualFilesystem.ts

@@ -4,6 +4,8 @@
  */
 
 import * as vscode from 'vscode'
+import { getLogger } from './logger/logger'
+import { get } from 'lodash'
 
 type StatNoType = Omit<vscode.FileStat, 'type'>
 
@@ -46,7 +48,7 @@ export class VirtualFileSystem implements vscode.FileSystemProvider {
         if (this.fileProviders[key] !== undefined) {
             throw new Error('Cannot re-register a provider for the same URI')
         }
-
+        getLogger().info(`in registerProvider: %s, %O`, key, provider)
         this.fileProviders[key] = provider
         const onDidChange = provider.onDidChange(() => {
             this._onDidChangeFile.fire([{ uri, type: vscode.FileChangeType.Changed }])
@@ -56,8 +58,11 @@ export class VirtualFileSystem implements vscode.FileSystemProvider {
     }
 
     private getProvider(uri: vscode.Uri): FileProvider {
+        getLogger().info(`in getProvider: ${this.uriToKey(uri)}`)
         const provider = this.fileProviders[this.uriToKey(uri)]
+        getLogger().info(`provider is: ${provider}`)
         if (!provider) {
+            getLogger().info(`error in getProvider: ${this.errorMessage}`)
             throw new Error(this.errorMessage)
         }
         return provider

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

@@ -8,8 +8,9 @@ import assert from 'assert'
 import sinon from 'sinon'
 import { DocPrepareCodeGenState } from '../../../amazonqDoc'
 import { createMockSessionStateAction } from '../../amazonq/utils'
-
 import { createTestContext, setupTestHooks } from '../../amazonq/session/testSetup'
+import * as filesModule from '../../../amazonq/util/files'
+import { CodeGenBase as CodeGenBaseClass } from '../../../amazonq/session/sessionState'
 
 describe('sessionStateDoc', () => {
     const context = createTestContext()
@@ -26,4 +27,111 @@ describe('sessionStateDoc', () => {
             })
         })
     })
+
+    describe('CodeGenBase generateCode log file handling', () => {
+        const RunCommandLogFileName = '.amazonq/dev/run_command.log'
+
+        class TestCodeGen extends CodeGenBaseClass {
+            public generatedFiles: any[] = []
+            constructor(config: any, tabID: string) {
+                super(config, tabID)
+            }
+            protected handleProgress(_messenger: any): void {}
+            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 testConfig: any, fakeProxyClient: any, fsMock: any, messengerMock: any, testAction: any, telemetryMock: any
+
+        beforeEach(() => {
+            fakeProxyClient = {
+                getCodeGeneration: sinon.stub().resolves({
+                    codeGenerationStatus: { status: 'Complete' },
+                    codeGenerationRemainingIterationCount: 0,
+                    codeGenerationTotalIterationCount: 1,
+                }),
+                exportResultArchive: sinon.stub(),
+            }
+
+            testConfig = {
+                conversationId: 'conv1',
+                uploadId: 'upload1',
+                workspaceRoots: ['/workspace'],
+                proxyClient: fakeProxyClient,
+            }
+
+            fsMock = {
+                writeFile: 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(),
+            }
+
+            testAction = {
+                fs: fsMock,
+                messenger: messengerMock,
+                tokenSource: { token: { isCancellationRequested: false, onCancellationRequested: () => {} } },
+            }
+        })
+
+        afterEach(() => {
+            sinon.restore()
+        })
+
+        it('writes to the log file, present or not', async () => {
+            const logFileInfo = {
+                zipFilePath: RunCommandLogFileName,
+                fileContent: 'newLog',
+            }
+            const otherFile = { zipFilePath: 'other.ts', fileContent: 'other' }
+
+            fakeProxyClient.exportResultArchive.resolves({
+                newFileContents: [logFileInfo, otherFile],
+                deletedFiles: [],
+                references: [],
+            })
+
+            // Minimal stubs to simulate file processing behavior.
+            sinon.stub(filesModule, 'registerNewFiles').callsFake((_, newFileContents: any[]) => newFileContents)
+            sinon.stub(filesModule, 'getDeletedFileInfos').callsFake(() => [])
+
+            const testCodeGen = new TestCodeGen(testConfig, 'tab1')
+
+            await testCodeGen.generateCode({
+                messenger: messengerMock,
+                fs: fsMock,
+                codeGenerationId: 'codegen2',
+                telemetry: telemetryMock,
+                workspaceFolders: {} as any,
+                action: testAction,
+            })
+
+            const expectedFilePath = `${testConfig.workspaceRoots[0]}/${RunCommandLogFileName}`
+            const fileUri = vscode.Uri.file(expectedFilePath)
+            sinon.assert.calledWith(fsMock.writeFile, fileUri, new TextEncoder().encode('newLog'), {
+                create: true,
+                overwrite: true,
+            })
+
+            assert.deepStrictEqual(testCodeGen.generatedFiles, [otherFile])
+        })
+    })
 })