feat: module separation of Cucumber parser

Author: mato533

packages/vscode-wdio-worker/package.json

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

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

@@ -12,7 +12,7 @@ import type { CucumberTestData, StepType, WorkerMetaContext } from '@vscode-wdio
  * @returns Array of test case information
  */
 export function parseCucumberFeature(this: WorkerMetaContext, fileContent: string, uri: string) {
-    this.log.debug('Cucumber parser is used.')
+    this.log.debug(`Start parsing the cucumber feature file: ${uri}`)
     try {
         // Initialize the parser components
         const builder = new AstBuilder(IdGenerator.uuid())

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

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

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

@@ -0,0 +1,20 @@
+import path from 'node:path'
+
+import type { WorkerMetaContext } from '@vscode-wdio/types/worker'
+import type { parseCucumberFeature } from './cucumber.js'
+
+export type CucumberParser = typeof parseCucumberFeature
+
+const CUCUMBER_PARSER_PATH = path.resolve(__dirname, 'parser/cucumber.cjs')
+
+let cucumberParser: CucumberParser | undefined
+
+export async function getCucumberParser(context: WorkerMetaContext): Promise<CucumberParser> {
+    if (cucumberParser) {
+        context.log.debug('Use cached Cucumber parser')
+        return cucumberParser
+    }
+    context.log.debug('Import Cucumber parser')
+    cucumberParser = (await import(CUCUMBER_PARSER_PATH)).parseCucumberFeature as CucumberParser
+    return cucumberParser
+}

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

@@ -340,7 +340,9 @@ describe('Cucumber Parser', () => {
             parseCucumberFeature.call(mockContext, basicFeatureContent, 'basic-feature.feature')
 
             // Verify debug log was called
-            expect(mockContext.log.debug).toHaveBeenCalledWith('Cucumber parser is used.')
+            expect(mockContext.log.debug).toHaveBeenCalledWith(
+                'Start parsing the cucumber feature file: basic-feature.feature'
+            )
         })
 
         it('should include proper source ranges for each element', () => {

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

@@ -5,9 +5,9 @@ import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'
 
 // Import parse function from parsers
 
-import { parseCucumberFeature } from '../../src/parsers/cucumber.js'
 import { parse } from '../../src/parsers/index.js'
 import { parseTestCases } from '../../src/parsers/js.js'
+import { getCucumberParser } from '../../src/parsers/utils.js'
 import type { ReadSpecsOptions } from '@vscode-wdio/types/api'
 import type { WorkerMetaContext, TestData, CucumberTestData } from '@vscode-wdio/types/worker'
 
@@ -18,8 +18,8 @@ vi.mock('node:fs/promises', () => ({
 }))
 
 // Mock the parsers
-vi.mock('../../src/parsers/cucumber.js', () => ({
-    parseCucumberFeature: vi.fn(),
+vi.mock('../../src/parsers/utils.js', () => ({
+    getCucumberParser: vi.fn(),
 }))
 
 vi.mock('../../src/parsers/js.js', () => ({
@@ -87,13 +87,14 @@ describe('Parser Index', () => {
             metadata: {},
         },
     ]
+    const mockCucumberParser = vi.fn(()=>cucumberMockTestData)
 
     beforeEach(() => {
         vi.resetAllMocks()
 
         // Mock the parseTestCases and parseCucumberFeature functions
         vi.mocked(parseTestCases).mockReturnValue(jsMockTestData)
-        vi.mocked(parseCucumberFeature).mockReturnValue(cucumberMockTestData)
+        vi.mocked(getCucumberParser).mockResolvedValue(mockCucumberParser)
     })
 
     afterEach(() => {
@@ -120,7 +121,7 @@ describe('Parser Index', () => {
 
             // Verify the correct parser was called
             expect(parseTestCases).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.js'))
-            expect(parseCucumberFeature).not.toHaveBeenCalled()
+            expect(mockCucumberParser).not.toHaveBeenCalled()
 
             // Verify logging
             expect(mockContext.log.debug).toHaveBeenCalledWith(`Parse spec file: ${path.normalize('/path/to/test.js')}`)
@@ -148,7 +149,7 @@ describe('Parser Index', () => {
 
             // Verify the correct parser was called
             expect(parseTestCases).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.ts'))
-            expect(parseCucumberFeature).not.toHaveBeenCalled()
+            expect(mockCucumberParser).not.toHaveBeenCalled()
         })
 
         it('should parse Cucumber feature files correctly', async () => {
@@ -169,7 +170,7 @@ describe('Parser Index', () => {
             expect(result[0].tests).toEqual(cucumberMockTestData)
 
             // Verify the correct parser was called
-            expect(parseCucumberFeature).toHaveBeenCalledWith(
+            expect(mockCucumberParser).toHaveBeenCalledWith(
                 cucumberFeatureContent,
                 path.normalize('/path/to/test.feature')
             )
@@ -194,7 +195,7 @@ describe('Parser Index', () => {
             expect(result[0].tests).toEqual(cucumberMockTestData)
 
             // Verify the correct parser was called
-            expect(parseCucumberFeature).toHaveBeenCalledWith(
+            expect(mockCucumberParser).toHaveBeenCalledWith(
                 cucumberFeatureContent,
                 path.normalize('/path/to/test.FEATURE')
             )
@@ -232,7 +233,7 @@ describe('Parser Index', () => {
 
             // Verify the correct parsers were called
             expect(parseTestCases).toHaveBeenCalledWith(jsTestContent, path.normalize('/path/to/test.js'))
-            expect(parseCucumberFeature).toHaveBeenCalledWith(
+            expect(mockCucumberParser).toHaveBeenCalledWith(
                 cucumberFeatureContent,
                 path.normalize('/path/to/test.feature')
             )
@@ -284,7 +285,7 @@ describe('Parser Index', () => {
             expect(result).toEqual([])
             expect(fs.readFile).not.toHaveBeenCalled()
             expect(parseTestCases).not.toHaveBeenCalled()
-            expect(parseCucumberFeature).not.toHaveBeenCalled()
+            expect(mockCucumberParser).not.toHaveBeenCalled()
         })
     })
 })

packages/vscode-webdriverio/package.json

@@ -23,6 +23,10 @@
         "./parser/ast": {
             "requireSource": "./src/parser/ast.ts",
             "require": "./dist/parser/ast.cjs"
+        },
+        "./parser/cucumber": {
+            "requireSource": "./src/parser/cucumber.ts",
+            "require": "./dist/parser/cucumber.cjs"
         }
     },
     "scripts": {

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

@@ -0,0 +1 @@
+export { parseCucumberFeature } from '@vscode-wdio/worker/parser/cucumber'