refactor: add types for customizations

Author: Hweinstock

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

@@ -7,7 +7,6 @@ import * as vscode from 'vscode'
 import * as path from 'path'
 import {
     CollectFilesFilter,
-    CollectFilesResultItem,
     defaultExcludePatterns,
     getWorkspaceFoldersByPrefixes,
 } from '../../shared/utilities/workspaceUtils'
@@ -28,7 +27,7 @@ import { ZipStream } from '../../shared/utilities/zipStream'
 import { isPresent } from '../../shared/utilities/collectionUtils'
 import { AuthUtil } from '../../codewhisperer/util/authUtil'
 import { TelemetryHelper } from '../util/telemetryHelper'
-import { zipProject } from './zipProjectUtil'
+import { ZipExcluder, zipProject } from './zipProjectUtil'
 
 export const SvgFileExtension = '.svg'
 
@@ -109,7 +108,7 @@ export async function prepareRepoData(
         const { excludePatterns, filterFn } = getFilterAndExcludePattern(useAutoBuildFeature, includeInfraDiagram)
 
         const ignoredExtensionMap = new Map<string, number>()
-        const isExcluded = (file: CollectFilesResultItem) => {
+        const isExcluded: ZipExcluder = (file) => {
             const isCodeFile_ = isCodeFile(file.relativeFilePath)
             const isDevFile = file.relativeFilePath === 'devfile.yaml'
             const isInfraDiagramFileExt = isInfraDiagramFile(file.relativeFilePath)

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

@@ -2,8 +2,14 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
+import vscode from 'vscode'
 import path from 'path'
-import { collectFiles, CollectFilesOptions, CollectFilesResultItem } from '../../shared/utilities/workspaceUtils'
+import {
+    collectFiles,
+    CollectFilesOptions,
+    CollectFilesResultItem,
+    getFileInfo,
+} from '../../shared/utilities/workspaceUtils'
 import { CurrentWsFolders } from '../commons/types'
 import { ZipStream } from '../../shared/utilities/zipStream'
 
@@ -28,14 +34,19 @@ interface ZipProjectOptions {
     nonPosixPath?: boolean
 }
 
+export type ZipExcluder = (file: Omit<CollectFilesResultItem, 'workspaceFolder'>) => boolean
+export type ZipErrorCheck = (file: Omit<CollectFilesResultItem, 'workspaceFolder'>) => Error | undefined
+export type ZipTracker = (file: Omit<CollectFilesResultItem, 'workspaceFolder'>) => Promise<void> | void
+
 interface ZipProjectCustomizations {
-    isExcluded?: (file: CollectFilesResultItem) => boolean
-    checkForError?: (file: CollectFilesResultItem) => Error | undefined
-    computeSideEffects?: (file: CollectFilesResultItem) => Promise<void> | void
+    isExcluded?: ZipExcluder
+    checkForError?: ZipErrorCheck
+    computeSideEffects?: ZipTracker
 }
 
 export async function addFileToZip(
-    file: CollectFilesResultItem,
+    file: Omit<CollectFilesResultItem, 'workspaceFolder'>,
+    targetFilePath: string,
     zip: ZipStream,
     customizations?: ZipProjectCustomizations,
     options?: ZipProjectOptions
@@ -48,19 +59,12 @@ export async function addFileToZip(
         throw errorToThrow
     }
 
-    // Paths in zip should be POSIX compliant regardless of OS
-    // Reference: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT
-    const zipFilePath = options?.includeProjectName
-        ? path.join(path.basename(file.workspaceFolder.uri.fsPath), file.zipFilePath)
-        : file.zipFilePath
-    const posixPath = options?.nonPosixPath ? zipFilePath : zipFilePath.split(path.sep).join(path.posix.sep)
-
     try {
         // filepath will be out-of-sync for files with unsaved changes.
         if (file.isText) {
-            zip.writeString(file.fileContent, posixPath)
+            zip.writeString(file.fileContent, targetFilePath)
         } else {
-            zip.writeFile(file.fileUri.fsPath, path.dirname(posixPath))
+            zip.writeFile(file.fileUri.fsPath, path.dirname(targetFilePath))
         }
     } catch (error) {
         if (error instanceof Error && error.message.includes('File not found')) {
@@ -95,7 +99,14 @@ export async function addProjectToZip(
         }
         zippedFiles.add(file.zipFilePath)
 
-        const addFileResult = await addFileToZip(file, zip, customizations, options)
+        // Paths in zip should be POSIX compliant regardless of OS
+        // Reference: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT
+        const zipFilePath = options?.includeProjectName
+            ? path.join(path.basename(file.workspaceFolder.uri.fsPath), file.zipFilePath)
+            : file.zipFilePath
+        const targetPath = options?.nonPosixPath ? zipFilePath : zipFilePath.split(path.sep).join(path.posix.sep)
+
+        const addFileResult = await addFileToZip(file, targetPath, zip, customizations, options)
         if (addFileResult.result === 'added') {
             totalBytes += addFileResult.addedBytes
         }
@@ -127,3 +138,22 @@ export async function zipProject(
         totalFileBytes: totalBytesAdded,
     }
 }
+// TODO: remove vscode dep
+export async function zipFile(
+    file: vscode.Uri,
+    targetPath: string,
+    customizations?: ZipProjectCustomizations,
+    options?: ZipProjectOptions
+) {
+    return await addFileToZip(
+        {
+            ...(await getFileInfo(file, true)),
+            zipFilePath: targetPath,
+            relativeFilePath: file.fsPath,
+        },
+        targetPath,
+        new ZipStream(),
+        customizations,
+        options
+    )
+}

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

@@ -12,12 +12,7 @@ import { fs } from '../../shared/fs/fs'
 import { getLoggerForScope } from '../service/securityScanHandler'
 import { runtimeLanguageContext } from './runtimeLanguageContext'
 import { CodewhispererLanguage } from '../../shared/telemetry/telemetry.gen'
-import {
-    CollectFilesOptions,
-    CollectFilesResultItem,
-    CurrentWsFolders,
-    defaultExcludePatterns,
-} from '../../shared/utilities/workspaceUtils'
+import { CollectFilesOptions, CurrentWsFolders, defaultExcludePatterns } from '../../shared/utilities/workspaceUtils'
 import {
     FileSizeExceededError,
     NoActiveFileError,
@@ -30,7 +25,7 @@ import { ProjectZipError } from '../../amazonqTest/error'
 import { removeAnsi } from '../../shared/utilities/textUtilities'
 import { normalize } from '../../shared/utilities/pathUtils'
 import { ZipStream } from '../../shared/utilities/zipStream'
-import { addProjectToZip } from '../../amazonq/util/zipProjectUtil'
+import { addProjectToZip, ZipErrorCheck, ZipExcluder, ZipTracker } from '../../amazonq/util/zipProjectUtil'
 
 export interface ZipMetadata {
     rootDir: string
@@ -430,17 +425,17 @@ export class ZipUtil {
                     : defaultExcludePatterns,
             includeContent: true,
         }
-        const isExcluded = (file: CollectFilesResultItem) =>
+        const isExcluded: ZipExcluder = (file) =>
             ZipConstants.knownBinaryFileExts.includes(path.extname(file.fileUri.fsPath)) &&
             useCase === FeatureUseCase.TEST_GENERATION
 
-        const checkForError = (file: CollectFilesResultItem) =>
+        const checkForError: ZipErrorCheck = (file) =>
             this.reachSizeLimit(this._totalSize, CodeWhispererConstants.CodeAnalysisScope.PROJECT) ||
             this.willReachSizeLimit(this._totalSize, file.fileSizeBytes)
                 ? new ProjectSizeExceededError()
                 : undefined
 
-        const computeSideEffects = (file: CollectFilesResultItem) => {
+        const computeSideEffects: ZipTracker = (file) => {
             if (file.isText) {
                 this._totalLines += file.fileContent.split(ZipConstants.newlineRegex).length
                 this.incrementCountForLanguage(file.fileUri, languageCount)

packages/core/src/shared/utilities/workspaceUtils.ts

@@ -330,17 +330,17 @@ async function filterOutGitignoredFiles(
     return gitIgnoreFilter.filterFiles(files)
 }
 
-export type FileInformation = {
+type FileInformation = {
     fileUri: vscode.Uri
     fileSizeBytes: number
     isText: boolean
 }
 
 export interface CollectFilesResultItem extends FileInformation {
     workspaceFolder: vscode.WorkspaceFolder
+    zipFilePath: string
     relativeFilePath: string
     fileContent: string
-    zipFilePath: string
 }
 export type CollectFilesFilter = (relativePath: string) => boolean // returns true if file should be filtered out
 export interface CollectFilesOptions {
@@ -426,7 +426,7 @@ export async function collectFiles(
                 continue
             }
 
-            const fileStats = await getFileStats(file, includeContent, fileStat.size)
+            const fileStats = await getFileInfo(file, includeContent, fileStat.size)
             if (fileStats) {
                 storage.push({
                     ...fileStats,
@@ -480,7 +480,18 @@ const workspaceFolderPrefixGuards = {
     maximumFoldersWithMatchingSubfolders: 10_000,
 }
 
-export async function getFileStats(file: vscode.Uri, includeContent: boolean, fileSize?: number) {
+export async function getFileInfo(
+    file: vscode.Uri,
+    includeContent: true,
+    fileSize?: number
+): Promise<FileInformation & { fileContent: string }>
+export async function getFileInfo(file: vscode.Uri, includeContent: false, fileSize?: number): Promise<FileInformation>
+export async function getFileInfo(
+    file: vscode.Uri,
+    includeContent: boolean,
+    fileSize?: number
+): Promise<FileInformation | (FileInformation & { fileContent: string })>
+export async function getFileInfo(file: vscode.Uri, includeContent: boolean, fileSize?: number) {
     const fileWithoutContent = {
         fileUri: file,
         fileSizeBytes: fileSize ?? (await fs.stat(file)).size,
@@ -490,9 +501,6 @@ export async function getFileStats(file: vscode.Uri, includeContent: boolean, fi
         const hasUnsavedChanges = isFileOpenAndDirty(file)
         const fileContent =
             fileWithoutContent.isText && hasUnsavedChanges ? await getCurrentTextContent(file) : await readFile(file)
-        if (fileContent === undefined) {
-            return
-        }
         return {
             ...fileWithoutContent,
             fileContent,