feat: module separation of AST parser

Author: mato533

packages/vscode-wdio-worker/package.json

@@ -10,6 +10,9 @@
         "./windows": {
             "import": "./dist/config.js"
         },
+        "./parser/ast": {
+            "import": "./dist/parsers/js.js"
+        },
         "./parser/cucumber": {
             "import": "./dist/parsers/cucumber.js"
         }

packages/vscode-wdio-worker/src/parsers/index.ts

@@ -1,8 +1,7 @@
 import * as fs from 'node:fs/promises'
 import path from 'node:path'
 
-import { parseTestCases } from './js.js'
-import { getCucumberParser } from './utils.js'
+import { getAstParser, getCucumberParser } from './utils.js'
 import type { ReadSpecsOptions } from '@vscode-wdio/types/api'
 import type { WorkerMetaContext } from '@vscode-wdio/types/worker'
 
@@ -11,6 +10,11 @@ async function parseFeatureFile(context: WorkerMetaContext, contents: string, no
     return p.call(context, contents, normalizeSpecPath)
 }
 
+async function parseJsFile(context: WorkerMetaContext, contents: string, normalizeSpecPath: string) {
+    const p = await getAstParser(context)
+    return p.call(context, contents, normalizeSpecPath)
+}
+
 export async function parse(this: WorkerMetaContext, options: ReadSpecsOptions) {
     return await Promise.all(
         options.specs.map(async (spec) => {
@@ -20,7 +24,7 @@ export async function parse(this: WorkerMetaContext, options: ReadSpecsOptions)
             try {
                 const testCases = isCucumberFeatureFile(normalizeSpecPath)
                     ? await parseFeatureFile(this, contents, normalizeSpecPath) // Parse Cucumber feature file
-                    : parseTestCases.call(this, contents, normalizeSpecPath) // Parse JavaScript/TypeScript test file
+                    : await parseJsFile(this, contents, normalizeSpecPath) // Parse JavaScript/TypeScript test file
 
                 this.log.debug(`Successfully parsed: ${normalizeSpecPath}`)
                 return {

packages/vscode-wdio-worker/src/parsers/utils.ts

@@ -2,12 +2,16 @@ import path from 'node:path'
 
 import type { WorkerMetaContext } from '@vscode-wdio/types/worker'
 import type { parseCucumberFeature } from './cucumber.js'
+import type { parseTestCases } from './js.js'
 
 export type CucumberParser = typeof parseCucumberFeature
+export type AstParser = typeof parseTestCases
 
 const CUCUMBER_PARSER_PATH = path.resolve(__dirname, 'parser/cucumber.cjs')
+const AST_PARSER_PATH = path.resolve(__dirname, 'parser/ast.cjs')
 
 let cucumberParser: CucumberParser | undefined
+let astParser: AstParser | undefined
 
 export async function getCucumberParser(context: WorkerMetaContext): Promise<CucumberParser> {
     if (cucumberParser) {
@@ -18,3 +22,13 @@ export async function getCucumberParser(context: WorkerMetaContext): Promise<Cuc
     cucumberParser = (await import(CUCUMBER_PARSER_PATH)).parseCucumberFeature as CucumberParser
     return cucumberParser
 }
+
+export async function getAstParser(context: WorkerMetaContext): Promise<AstParser> {
+    if (astParser) {
+        context.log.debug('Use cached Ast parser')
+        return astParser
+    }
+    context.log.debug('Import Ast parser')
+    astParser = (await import(AST_PARSER_PATH)).parseTestCases as AstParser
+    return astParser
+}

packages/vscode-wdio-worker/tests/parsers/index.test.ts

@@ -6,12 +6,10 @@ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
 // Import parse function from parsers
 
 import { parse } from '../../src/parsers/index.js'
-import { parseTestCases } from '../../src/parsers/js.js'
-import { getCucumberParser } from '../../src/parsers/utils.js'
+import { getAstParser, getCucumberParser } from '../../src/parsers/utils.js'
 import type { ReadSpecsOptions } from '@vscode-wdio/types/api'
 import type { WorkerMetaContext, TestData, CucumberTestData } from '@vscode-wdio/types/worker'
 
-// Import the types
 // Mock fs module
 vi.mock('node:fs/promises', () => ({
     readFile: vi.fn(),
@@ -20,14 +18,9 @@ vi.mock('node:fs/promises', () => ({
 // Mock the parsers
 vi.mock('../../src/parsers/utils.js', () => ({
     getCucumberParser: vi.fn(),
+    getAstParser: vi.fn(),
 }))
 
-vi.mock('../../src/parsers/js.js', () => ({
-    parseTestCases: vi.fn(),
-}))
-
-// Import mocked modules
-
 describe('Parser Index', () => {
     // Create mock context
     const mockContext: WorkerMetaContext = {
@@ -59,6 +52,7 @@ describe('Parser Index', () => {
             ],
         },
     ]
+    const mockAstParser = vi.fn(()=>jsMockTestData)
 
     const cucumberMockTestData: CucumberTestData[] = [
         {
@@ -93,8 +87,9 @@ describe('Parser Index', () => {
         vi.resetAllMocks()
 
         // Mock the parseTestCases and parseCucumberFeature functions
-        vi.mocked(parseTestCases).mockReturnValue(jsMockTestData)
+        // vi.mocked(parseTestCases).mockReturnValue(jsMockTestData)
         vi.mocked(getCucumberParser).mockResolvedValue(mockCucumberParser)
+        vi.mocked(getAstParser).mockResolvedValue(mockAstParser)
     })
 
     afterEach(() => {
@@ -120,7 +115,7 @@ describe('Parser Index', () => {
             expect(result[0].tests).toEqual(jsMockTestData)
 
             // Verify the correct parser was called
-            expect(parseTestCases).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.js'))
+            expect(mockAstParser).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.js'))
             expect(mockCucumberParser).not.toHaveBeenCalled()
 
             // Verify logging
@@ -148,7 +143,7 @@ describe('Parser Index', () => {
             expect(result[0].tests).toEqual(jsMockTestData)
 
             // Verify the correct parser was called
-            expect(parseTestCases).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.ts'))
+            expect(mockAstParser).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.ts'))
             expect(mockCucumberParser).not.toHaveBeenCalled()
         })
 
@@ -174,7 +169,7 @@ describe('Parser Index', () => {
                 cucumberFeatureContent,
                 path.normalize('/path/to/test.feature')
             )
-            expect(parseTestCases).not.toHaveBeenCalled()
+            expect(mockAstParser).not.toHaveBeenCalled()
         })
 
         it('should handle uppercase feature file extensions', async () => {
@@ -199,7 +194,7 @@ describe('Parser Index', () => {
                 cucumberFeatureContent,
                 path.normalize('/path/to/test.FEATURE')
             )
-            expect(parseTestCases).not.toHaveBeenCalled()
+            expect(mockAstParser).not.toHaveBeenCalled()
         })
 
         it('should parse multiple spec files', async () => {
@@ -232,7 +227,7 @@ describe('Parser Index', () => {
             expect(result[1].tests).toEqual(cucumberMockTestData)
 
             // Verify the correct parsers were called
-            expect(parseTestCases).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.js'))
+            expect(mockAstParser).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.js'))
             expect(mockCucumberParser).toHaveBeenCalledWith(
                 cucumberFeatureContent,
                 path.normalize('/path/to/test.feature')
@@ -269,7 +264,7 @@ describe('Parser Index', () => {
             expect(result[0].spec).toBe(path.normalize('C:\\path\\to\\test.js'))
 
             // Verify the parser was called with the normalized path
-            expect(parseTestCases).toHaveBeenCalledWith(jsTestContent, path.normalize('C:\\path\\to\\test.js'))
+            expect(mockAstParser).toHaveBeenCalledWith(jsTestContent, path.normalize('C:\\path\\to\\test.js'))
         })
 
         it('should handle empty specs array', async () => {
@@ -284,7 +279,7 @@ describe('Parser Index', () => {
             // Verify
             expect(result).toEqual([])
             expect(fs.readFile).not.toHaveBeenCalled()
-            expect(parseTestCases).not.toHaveBeenCalled()
+            expect(mockAstParser).not.toHaveBeenCalled()
             expect(mockCucumberParser).not.toHaveBeenCalled()
         })
     })

packages/vscode-webdriverio/src/parser/ast.ts

@@ -1 +1,2 @@
 export { createTempConfigFile } from '@vscode-wdio/worker/windows'
+export { parseTestCases } from '@vscode-wdio/worker/parser/ast'