feat(amazonq): add user requirement to zipfile for code review tool (#2430)

yueny2020 · laileni-aws · web-flow · commit 2c33b384a0e4 · 2025-10-20T13:34:53.000-07:00
Co-authored-by: Laxman Reddy &lt;141967714+laileni-aws@users.noreply.github.com&gt;
diff --git a/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReview.test.ts b/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReview.test.ts
@@ -104,6 +104,7 @@ describe('CodeReview', () => {
                 folderLevelArtifacts: [],
                 ruleArtifacts: [],
                 scopeOfReview: FULL_REVIEW,
+                userRequirement: 'Test requirement',
                 modelId: 'claude-4-sonnet',
             }
         })
@@ -136,7 +137,9 @@ describe('CodeReview', () => {
                 md5Hash: 'hash123',
                 isCodeDiffPresent: false,
                 programmingLanguages: new Set(['javascript']),
+                numberOfFilesInCustomerCodeZip: 1,
                 codeDiffFiles: new Set(),
+                filePathsInZip: new Set(['/test/file.js']),
             })
             sandbox.stub(codeReview as any, 'parseFindings').returns([])
 
@@ -265,7 +268,9 @@ describe('CodeReview', () => {
                 md5Hash: 'hash123',
                 isCodeDiffPresent: false,
                 programmingLanguages: new Set(['javascript']),
+                numberOfFilesInCustomerCodeZip: 1,
                 codeDiffFiles: new Set(),
+                filePathsInZip: new Set(['/test/file.js']),
             })
             sandbox.stub(codeReview as any, 'parseFindings').returns([])
 
@@ -305,6 +310,7 @@ describe('CodeReview', () => {
                 folderLevelArtifacts: [],
                 ruleArtifacts: [],
                 scopeOfReview: FULL_REVIEW,
+                userRequirement: 'Test requirement',
                 modelId: 'claude-4-sonnet',
             }
 
@@ -428,6 +434,7 @@ describe('CodeReview', () => {
                 folderLevelArtifacts: [],
                 ruleArtifacts: [],
                 scopeOfReview: FULL_REVIEW,
+                userRequirement: 'Test requirement',
                 modelId: 'claude-4-sonnet',
             }
 
@@ -453,6 +460,7 @@ describe('CodeReview', () => {
                 folderLevelArtifacts: [{ path: '/test/folder' }],
                 ruleArtifacts: [],
                 scopeOfReview: CODE_DIFF_REVIEW,
+                userRequirement: 'Test requirement',
                 modelId: 'claude-4-sonnet',
             }
 
@@ -488,6 +496,7 @@ describe('CodeReview', () => {
             const ruleArtifacts: any[] = []
 
             const result = await (codeReview as any).prepareFilesAndFoldersForUpload(
+                'Test requirement',
                 fileArtifacts,
                 folderArtifacts,
                 ruleArtifacts,
@@ -507,6 +516,7 @@ describe('CodeReview', () => {
             sandbox.stub(CodeReviewUtils, 'processArtifactWithDiff').resolves('diff content\n')
 
             const result = await (codeReview as any).prepareFilesAndFoldersForUpload(
+                'Test requirement',
                 fileArtifacts,
                 folderArtifacts,
                 ruleArtifacts,
@@ -526,6 +536,7 @@ describe('CodeReview', () => {
 
             try {
                 await (codeReview as any).prepareFilesAndFoldersForUpload(
+                    'Test requirement',
                     fileArtifacts,
                     folderArtifacts,
                     ruleArtifacts,
@@ -554,6 +565,7 @@ describe('CodeReview', () => {
             sandbox.stub(require('crypto'), 'randomUUID').returns('test-uuid-123')
 
             await (codeReview as any).prepareFilesAndFoldersForUpload(
+                'Test requirement',
                 fileArtifacts,
                 folderArtifacts,
                 ruleArtifacts,
@@ -767,6 +779,7 @@ describe('CodeReview', () => {
                 folderLevelArtifacts: [],
                 ruleArtifacts: [],
                 scopeOfReview: FULL_REVIEW,
+                userRequirement: 'Test requirement',
                 modelId: 'claude-4-sonnet',
             }
 
diff --git a/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReview.ts b/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReview.ts
@@ -39,6 +39,7 @@ export class CodeReview {
     private static readonly CODE_ARTIFACT_PATH = 'code_artifact'
     private static readonly CUSTOMER_CODE_ZIP_NAME = 'customerCode.zip'
     private static readonly CODE_DIFF_PATH = 'code_artifact/codeDiff/customerCodeDiff.diff'
+    private static readonly USER_REQUIREMENT_PATH = 'code_artifact/userRequirement/userRequirement.txt'
     private static readonly RULE_ARTIFACT_PATH = '.amazonq/rules'
     private static readonly MAX_POLLING_ATTEMPTS = 90 // 90 * POLLING_INTERVAL_MS (10000) = 15 mins
     private static readonly MID_POLLING_ATTEMPTS = 20
@@ -176,6 +177,7 @@ export class CodeReview {
 
         // parse input
         const validatedInput = Z_CODE_REVIEW_INPUT_SCHEMA.parse(input)
+        const userRequirement = validatedInput.userRequirement
         const fileArtifacts = validatedInput.fileLevelArtifacts || []
         const folderArtifacts = validatedInput.folderLevelArtifacts || []
         const ruleArtifacts = validatedInput.ruleArtifacts || []
@@ -204,9 +206,12 @@ export class CodeReview {
         const programmingLanguage = 'java'
         const scanName = 'Standard-' + randomUUID()
 
-        this.logging.info(`Agentic scan name: ${scanName} selectedModel: ${modelId}`)
+        this.logging.info(
+            `Agentic scan name: ${scanName} selectedModel: ${modelId} userRequirement: ${userRequirement}`
+        )
 
         return {
+            userRequirement,
             fileArtifacts,
             folderArtifacts,
             isFullReviewRequest,
@@ -235,6 +240,7 @@ export class CodeReview {
             codeDiffFiles,
             filePathsInZip,
         } = await this.prepareFilesAndFoldersForUpload(
+            setup.userRequirement,
             setup.fileArtifacts,
             setup.folderArtifacts,
             setup.ruleArtifacts,
@@ -603,6 +609,7 @@ export class CodeReview {
      * @returns An object containing the zip file buffer and its MD5 hash
      */
     private async prepareFilesAndFoldersForUpload(
+        userRequirement: string,
         fileArtifacts: FileArtifacts,
         folderArtifacts: FolderArtifacts,
         ruleArtifacts: RuleArtifacts,
@@ -660,6 +667,9 @@ export class CodeReview {
                 codeArtifactZip.file(CodeReview.CODE_DIFF_PATH, codeDiff)
             }
 
+            // Add user requirement
+            codeArtifactZip.file(CodeReview.USER_REQUIREMENT_PATH, userRequirement)
+
             // Generate the final code artifact zip
             const zipBuffer = await CodeReviewUtils.generateZipBuffer(codeArtifactZip)
             CodeReviewUtils.logZipStructure(codeArtifactZip, 'Code artifact', this.logging)
diff --git a/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReviewSchemas.ts b/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReviewSchemas.ts
@@ -12,8 +12,9 @@ import { FINDING_SEVERITY, SCOPE_OF_CODE_REVIEW } from './codeReviewConstants'
 export const CODE_REVIEW_INPUT_SCHEMA = {
     type: <const>'object',
     description: [
-        '**3 main fields in the tool:**',
+        '**4 main fields in the tool:**',
         '- scopeOfReview: CRITICAL - Must be set to either FULL_REVIEW (analyze entire file/folder/project/workspace) or CODE_DIFF_REVIEW (focus only on changes/modifications in the file/folder/project/workspace). This is a required field.',
+        '- userRequirement: CRITICAL - Must be set as a string to describe the user requirement by analyzing the current conversation and extracting all the related information for code review. This is a required field.',
         '- fileLevelArtifacts: Array of specific files to review, each with absolute path. Use this when reviewing individual files, not folders. Format: [{"path": "/absolute/path/to/file.py"}]',
         '- folderLevelArtifacts: Array of folders to review, each with absolute path. Use this when reviewing entire directories, not individual files. Format: [{"path": "/absolute/path/to/folder/"}]',
         "Note: Either fileLevelArtifacts OR folderLevelArtifacts should be provided based on what's being reviewed, but not both for the same items.",
@@ -84,14 +85,15 @@ export const CODE_REVIEW_INPUT_SCHEMA = {
             },
         },
     },
-    required: ['scopeOfReview'] as const,
+    required: ['scopeOfReview', 'userRequirement'] as const,
 }
 
 /**
  * Zod schema for input validation during execution of Code Review tool
  */
 export const Z_CODE_REVIEW_INPUT_SCHEMA = z.object({
     scopeOfReview: z.enum(SCOPE_OF_CODE_REVIEW as [string, ...string[]]),
+    userRequirement: z.string(),
     fileLevelArtifacts: z
         .array(
             z.object({
diff --git a/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReviewTypes.ts b/server/aws-lsp-codewhisperer/src/language-server/agenticChat/tools/qCodeAnalysis/codeReviewTypes.ts
@@ -14,6 +14,7 @@ export enum SuccessMetricName {
 }
 
 export type ValidateInputAndSetupResult = {
+    userRequirement: string
     fileArtifacts: FileArtifacts
     folderArtifacts: FolderArtifacts
     isFullReviewRequest: boolean

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ export enum SuccessMetricName {`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`export type ValidateInputAndSetupResult = {`
	`17`	`+ userRequirement: string`
`17`	`18`	`fileArtifacts: FileArtifacts`
`18`	`19`	`folderArtifacts: FolderArtifacts`
`19`	`20`	`isFullReviewRequest: boolean`