refactor: rename generateZip

Author: Hweinstock

packages/core/src/amazonq/util/files.ts

@@ -299,3 +299,7 @@ export function registerNewFiles(
 
     return result
 }
+
+export function isFileOpenAndDirty(uri: vscode.Uri) {
+    return vscode.workspace.textDocuments.some((document) => document.uri.fsPath === uri.fsPath && document.isDirty)
+}

packages/core/src/codewhisperer/commands/startSecurityScan.ts

@@ -157,7 +157,7 @@ export async function startSecurityScan(
             })
         }
         const zipType = scope === CodeAnalysisScope.PROJECT ? 'project' : 'file'
-        const zipMetadata = await zipUtil.generateZip(editor?.document.uri, zipType)
+        const zipMetadata = await zipUtil.generateZipCodeScan(editor?.document.uri, zipType)
         const projectPaths = getWorkspacePaths()
 
         const contextTruncationStartTime = performance.now()

packages/core/src/codewhisperer/util/zipUtil.ts

@@ -28,6 +28,7 @@ import { ZipStream } from '../../shared/utilities/zipStream'
 import { getTextContent } from '../../shared/utilities/textDocumentUtilities'
 import { ChildProcess, ChildProcessOptions } from '../../shared/utilities/processUtils'
 import { removeAnsi } from '../../shared/utilities/textUtilities'
+import { isFileOpenAndDirty } from '../../amazonq/util/files'
 
 export interface ZipMetadata {
     rootDir: string
@@ -245,8 +246,8 @@ export class ZipUtil {
             if (ZipConstants.knownBinaryFileExts.includes(path.extname(file.fileUri.fsPath)) && includeBinary) {
                 await this.processBinaryFile(zip, file.fileUri, zipEntryPath)
             } else {
-                const isFileOpenAndDirty = this.isFileOpenAndDirty(file.fileUri)
-                const fileContent = isFileOpenAndDirty ? await getTextContent(file.fileUri) : file.fileContent
+                const hasUnsavedChanges = isFileOpenAndDirty(file.fileUri)
+                const fileContent = hasUnsavedChanges ? await getTextContent(file.fileUri) : file.fileContent
                 this.processTextFile(zip, file.fileUri, fileContent, languageCount, zipEntryPath)
             }
         }
@@ -327,18 +328,14 @@ export class ZipUtil {
         }
     }
 
-    protected isFileOpenAndDirty(uri: vscode.Uri) {
-        return vscode.workspace.textDocuments.some((document) => document.uri.fsPath === uri.fsPath && document.isDirty)
-    }
-
     public getZipDirPath(): string {
         if (this._zipDir === '') {
             this._zipDir = path.join(this._tmpDir, `${this._zipDirPrefix}_${this._timestamp}`)
         }
         return this._zipDir
     }
 
-    public async generateZip(
+    public async generateZipCodeScan(
         uri: vscode.Uri | undefined,
         zipType: ZipType,
         options?: GenerateZipOptions

packages/core/src/test/codewhisperer/zipUtil.test.ts

@@ -58,7 +58,7 @@ describe('zipUtil', function () {
         )
     })
 
-    describe('generateZip', function () {
+    describe('generateZipCodeScan', function () {
         let zipUtil: ZipUtil
         beforeEach(function () {
             zipUtil = new ZipUtil(CodeWhispererConstants.codeScanTruncDirPrefix)
@@ -68,7 +68,7 @@ describe('zipUtil', function () {
         })
 
         it('Should generate zip for file scan and return expected metadata', async function () {
-            const zipMetadata = await zipUtil.generateZip(vscode.Uri.file(appCodePath), 'file', {
+            const zipMetadata = await zipUtil.generateZipCodeScan(vscode.Uri.file(appCodePath), 'file', {
                 includeGitDiff: true,
             })
             assert.strictEqual(zipMetadata.lines, 49)
@@ -84,13 +84,13 @@ describe('zipUtil', function () {
             sinon.stub(ZipUtil, 'aboveByteLimit').returns(true)
 
             await assert.rejects(
-                () => zipUtil.generateZip(vscode.Uri.file(appCodePath), 'file', { includeGitDiff: true }),
+                () => zipUtil.generateZipCodeScan(vscode.Uri.file(appCodePath), 'file', { includeGitDiff: true }),
                 new ToolkitError(`Payload size limit reached`, { code: 'FileSizeExceeded' })
             )
         })
 
         it('Should generate zip for project scan and return expected metadata', async function () {
-            const zipMetadata = await zipUtil.generateZip(vscode.Uri.file(appCodePath), 'project')
+            const zipMetadata = await zipUtil.generateZipCodeScan(vscode.Uri.file(appCodePath), 'project')
             assert.ok(zipMetadata.lines > 0)
             assert.ok(zipMetadata.rootDir.includes(codeScanTruncDirPrefix))
             assert.ok(zipMetadata.srcPayloadSizeInBytes > 0)
@@ -104,7 +104,7 @@ describe('zipUtil', function () {
             sinon.stub(ZipUtil, 'aboveByteLimit').returns(true)
 
             await assert.rejects(
-                () => zipUtil.generateZip(vscode.Uri.file(appCodePath), 'project'),
+                () => zipUtil.generateZipCodeScan(vscode.Uri.file(appCodePath), 'project'),
                 new ToolkitError('Payload size limit reached', { code: 'ProjectSizeExceeded' })
             )
         })
@@ -113,29 +113,32 @@ describe('zipUtil', function () {
             sinon.stub(ZipUtil, 'aboveByteLimit').returns(true)
 
             await assert.rejects(
-                () => zipUtil.generateZip(vscode.Uri.file(appCodePath), 'project'),
+                () => zipUtil.generateZipCodeScan(vscode.Uri.file(appCodePath), 'project'),
                 new ToolkitError('Payload size limit reached', { code: 'ProjectSizeExceeded' })
             )
         })
 
         it('Should read file content instead of from disk if file is dirty', async function () {
-            const zipMetadata = await zipUtil.generateZip(vscode.Uri.file(appCodePath), 'project')
+            const zipMetadata = await zipUtil.generateZipCodeScan(vscode.Uri.file(appCodePath), 'project')
 
             const document = await vscode.workspace.openTextDocument(appCodePath)
             await vscode.window.showTextDocument(document)
             void vscode.window.activeTextEditor?.edit((editBuilder) => {
                 editBuilder.insert(new vscode.Position(0, 0), '// a comment\n')
             })
 
-            const zipMetadata2 = await new ZipUtil(CodeWhispererConstants.codeScanTruncDirPrefix).generateZip(
+            const zipMetadata2 = await new ZipUtil(CodeWhispererConstants.codeScanTruncDirPrefix).generateZipCodeScan(
                 vscode.Uri.file(appCodePath),
                 'project'
             )
             assert.equal(zipMetadata2.lines, zipMetadata.lines + 1)
         })
 
         it('should handle path with repeated project name for file scan', async function () {
-            const zipMetadata = await zipUtil.generateZip(vscode.Uri.file(appCodePathWithRepeatedProjectName), 'file')
+            const zipMetadata = await zipUtil.generateZipCodeScan(
+                vscode.Uri.file(appCodePathWithRepeatedProjectName),
+                'file'
+            )
 
             const zipFileData = await fs.readFileBytes(zipMetadata.zipFilePath)
             const zip = await JSZip.loadAsync(zipFileData)
@@ -144,7 +147,7 @@ describe('zipUtil', function () {
         })
 
         it('should handle path with repeated project name for project scan', async function () {
-            const zipMetadata = await zipUtil.generateZip(
+            const zipMetadata = await zipUtil.generateZipCodeScan(
                 vscode.Uri.file(appCodePathWithRepeatedProjectName),
                 'project'
             )

packages/core/src/testE2E/codewhisperer/securityScan.test.ts

@@ -95,7 +95,7 @@ describe('CodeWhisperer security scan', async function () {
 
         const projectPaths = getWorkspacePaths()
         const scope = CodeWhispererConstants.CodeAnalysisScope.PROJECT
-        const zipMetadata = await zipUtil.generateZip(uri, 'project')
+        const zipMetadata = await zipUtil.generateZipCodeScan(uri, 'project')
         const codeScanName = randomUUID()
 
         let artifactMap

packages/core/src/testInteg/perf/startSecurityScan.test.ts

@@ -102,7 +102,7 @@ describe('startSecurityScanPerformanceTest', function () {
                     assert.ok(setup.commandSpy.neverCalledWith('workbench.action.problems.focus'))
                     assert.ok(setup.securityScanRenderSpy.calledOnce)
 
-                    assert.ok(setup.zipSpy.generateZip.calledOnce)
+                    assert.ok(setup.zipSpy.generateZipCodeScan.calledOnce)
                     assert.ok(setup.zipSpy.removeTmpFiles.calledOnce)
                     assert.ok(
                         getFsCallsUpperBound(setup.fsSpy) <= 5,