fix: doc telemetry unit tests fail in windows platform issues

Author: KevinDing1

packages/core/src/test/amazonqDoc/controller.test.ts

@@ -23,6 +23,7 @@ import { waitUntil } from '../../shared'
 import { FollowUpTypes } from '../../amazonq/commons/types'
 import { FileSystem } from '../../shared/fs/fs'
 import { ReadmeBuilder } from './mockContent'
+import * as path from 'path'
 
 describe('Controller - Doc Generation', () => {
     const tabID = '123'
@@ -39,11 +40,11 @@ describe('Controller - Doc Generation', () => {
 
     const getFilePaths = (controllerSetup: ControllerSetup): NewFileInfo[] => [
         {
-            zipFilePath: 'README.md',
-            relativePath: 'README.md',
+            zipFilePath: path.normalize('README.md'),
+            relativePath: path.normalize('README.md'),
             fileContent: generatedReadme,
             rejected: false,
-            virtualMemoryUri: generateVirtualMemoryUri(uploadID, 'README.md', docScheme),
+            virtualMemoryUri: generateVirtualMemoryUri(uploadID, path.normalize('README.md'), docScheme),
             workspaceFolder: controllerSetup.workspaceFolder,
             changeApplied: false,
         },
@@ -138,7 +139,7 @@ describe('Controller - Doc Generation', () => {
             codewhispererChat: 'connected',
             amazonQ: 'connected',
         })
-        sinon.stub(FileSystem.prototype, 'exists').resolves(true)
+        sinon.stub(FileSystem.prototype, 'exists').callsFake(async () => true)
         getSessionStub = sinon.stub(controllerSetup.sessionStorage, 'getSession').resolves(session)
         modifiedReadme = ReadmeBuilder.createReadmeWithRepoStructure()
         sinon
@@ -228,6 +229,7 @@ describe('Controller - Doc Generation', () => {
         })
     })
     it('should emit generation telemetry for README update', async () => {
+        await updateFilePaths(session, modifiedReadme, uploadID, docScheme, controllerSetup.workspaceFolder)
         await performAction('update', getSessionStub)
 
         const expectedEvent = createExpectedEvent({
@@ -269,6 +271,7 @@ describe('Controller - Doc Generation', () => {
     })
 
     it('should emit acceptance telemetry for README update', async () => {
+        await updateFilePaths(session, modifiedReadme, uploadID, docScheme, controllerSetup.workspaceFolder)
         await performAction('update', getSessionStub)
         await new Promise((resolve) => setTimeout(resolve, 100))
 
@@ -289,6 +292,7 @@ describe('Controller - Doc Generation', () => {
     })
 
     it('should emit generation telemetry for README edit', async () => {
+        await updateFilePaths(session, modifiedReadme, uploadID, docScheme, controllerSetup.workspaceFolder)
         await performAction('edit', getSessionStub, 'add repository structure section')
 
         const expectedEvent = createExpectedEvent({
@@ -305,6 +309,7 @@ describe('Controller - Doc Generation', () => {
         })
     })
     it('should emit acceptance telemetry for README edit', async () => {
+        await updateFilePaths(session, modifiedReadme, uploadID, docScheme, controllerSetup.workspaceFolder)
         await performAction('edit', getSessionStub, 'add repository structure section')
         await new Promise((resolve) => setTimeout(resolve, 100))
 

packages/core/src/test/amazonqDoc/mockContent.ts

@@ -43,40 +43,44 @@ export class ReadmeBuilder {
     private sections: string[] = []
 
     addSection(section: string): this {
-        this.sections.push(section)
+        this.sections.push(section.replace(/\r\n/g, '\n'))
         return this
     }
 
     build(): string {
-        return this.sections.join('\n\n')
+        return this.sections.join('\n\n').replace(/\r\n/g, '\n')
     }
 
     static createBaseReadme(): string {
         return new ReadmeBuilder()
-            .addSection(ReadmeSections.HEADER)
-            .addSection(ReadmeSections.GETTING_STARTED)
-            .addSection(ReadmeSections.FEATURES)
-            .addSection(ReadmeSections.LICENSE)
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.HEADER))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.GETTING_STARTED))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.FEATURES))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.LICENSE))
             .build()
     }
 
     static createReadmeWithRepoStructure(): string {
         return new ReadmeBuilder()
-            .addSection(ReadmeSections.HEADER)
-            .addSection(ReadmeSections.REPO_STRUCTURE)
-            .addSection(ReadmeSections.GETTING_STARTED)
-            .addSection(ReadmeSections.FEATURES)
-            .addSection(ReadmeSections.LICENSE)
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.HEADER))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.REPO_STRUCTURE))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.GETTING_STARTED))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.FEATURES))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.LICENSE))
             .build()
     }
 
     static createReadmeWithDataFlow(): string {
         return new ReadmeBuilder()
-            .addSection(ReadmeSections.HEADER)
-            .addSection(ReadmeSections.GETTING_STARTED)
-            .addSection(ReadmeSections.FEATURES)
-            .addSection(ReadmeSections.DATA_FLOW)
-            .addSection(ReadmeSections.LICENSE)
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.HEADER))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.GETTING_STARTED))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.FEATURES))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.DATA_FLOW))
+            .addSection(ReadmeBuilder.normalizeSection(ReadmeSections.LICENSE))
             .build()
     }
+
+    private static normalizeSection(section: string): string {
+        return section.replace(/\r\n/g, '\n')
+    }
 }

packages/core/src/test/amazonqDoc/utils.ts

@@ -214,11 +214,11 @@ export async function updateFilePaths(
 ) {
     const updatedFilePaths: NewFileInfo[] = [
         {
-            zipFilePath: 'README.md',
-            relativePath: 'README.md',
+            zipFilePath: path.normalize('README.md'),
+            relativePath: path.normalize('README.md'),
             fileContent: content,
             rejected: false,
-            virtualMemoryUri: generateVirtualMemoryUri(uploadId, 'README.md', docScheme),
+            virtualMemoryUri: generateVirtualMemoryUri(uploadId, path.normalize('README.md'), docScheme),
             workspaceFolder: workspaceFolder,
             changeApplied: false,
         },