feat: changed to monitor test file changes using specs defined in wdio.conf.js

mato533 · mato533 · commit 964ab24211c6 · 2025-05-12T03:22:09.000+09:00
- Modified TestRepository to allow acquisition of spec values in wdio.conf.js
- Fixed file pattern acquisition logic in TestFileWatcher
- Removed configuration items that are no longer used.
- Improved performance by removing unnecessary loop processing
diff --git a/package.json b/package.json
@@ -62,17 +62,6 @@
                     ],
                     "description": "Glob pattern for WebdriverIO configuration file"
                 },
-                "webdriverio.testFilePattern": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    },
-                    "default": [
-                        "**/*.{spec,test}.{ts,js}",
-                        "**/*.feature"
-                    ],
-                    "description": "Glob pattern for test files"
-                },
                 "webdriverio.logLevel": {
                     "type": "string",
                     "enum": [
diff --git a/src/api/types.ts b/src/api/types.ts
@@ -6,6 +6,7 @@ import type { NumericLogLevel } from '../types.js'
 
 export type WdioConfig = {
     specs: string[]
+    specPatterns: string[]
     framework: string
 }
 
diff --git a/src/config/index.ts b/src/config/index.ts
@@ -23,17 +23,12 @@ export class ExtensionConfigManager extends EventEmitter implements vscode.Dispo
         const config = vscode.workspace.getConfiguration(EXTENSION_ID)
 
         const configFilePattern = config.get<string[]>('configFilePattern')
-        const testFilePattern = config.get<string[]>('testFilePattern')
 
         this._globalConfig = {
             configFilePattern:
                 configFilePattern && configFilePattern.length > 0
                     ? configFilePattern
                     : [...DEFAULT_CONFIG_VALUES.configFilePattern],
-            testFilePattern:
-                testFilePattern && testFilePattern.length > 0
-                    ? testFilePattern
-                    : [...DEFAULT_CONFIG_VALUES.testFilePattern],
             showOutput: this.resolveBooleanConfig(config, 'showOutput', DEFAULT_CONFIG_VALUES.showOutput),
             logLevel: config.get<string>('logLevel', DEFAULT_CONFIG_VALUES.logLevel),
         }
diff --git a/src/config/watcher.ts b/src/config/watcher.ts
@@ -1,44 +1,49 @@
-import { convertUriToPath, type RepositoryManager } from '../test/index.js'
+import { convertUriToPath, TestfileWatcher, type RepositoryManager } from '../test/index.js'
 import { normalizePath } from '../utils/normalize.js'
-import { FileWatcherManager } from '../utils/watcher.js'
+import { FileWatcherManager, type WatchPattern } from '../utils/watcher.js'
 
 import type * as vscode from 'vscode'
 import type { ServerManager } from '../api/index.js'
 import type { ExtensionConfigManager } from '../config/index.js'
 
 export class ConfigFileWatcher extends FileWatcherManager {
+    private readonly testfileWatcher
     constructor(
         public readonly configManager: ExtensionConfigManager,
         private readonly serverManager: ServerManager,
-        private readonly repositoryManager: RepositoryManager
+        private readonly repositoryManager: RepositoryManager,
     ) {
         super()
+        this.testfileWatcher = new TestfileWatcher(repositoryManager)
     }
 
     public enable() {
         this.createWatchers()
         this.configManager.on('update:configFilePattern', () => this.refreshWatchers())
+        this.testfileWatcher.enable()
     }
 
-    protected getFilePatterns(): string[] {
-        return this.configManager.globalConfig.configFilePattern || []
+    protected getFilePatterns(): WatchPattern[] {
+        return this.configManager.globalConfig.configFilePattern.map((pattern)=>({ pattern }))
     }
 
     protected async handleFileCreate(uri: vscode.Uri): Promise<void> {
         const wdioConfigPath = normalizePath(convertUriToPath(uri))
         const workspaceUris = await this.configManager.addWdioConfig(wdioConfigPath)
-        for (const workspaceUri of workspaceUris) {
-            this.repositoryManager.addWdioConfig(workspaceUri, wdioConfigPath)
-        }
+        await Promise.all(workspaceUris.map(async (workspaceUri)=>
+            await this.repositoryManager.addWdioConfig(workspaceUri, wdioConfigPath)))
+
+        this.testfileWatcher.refreshWatchers()
     }
 
-    protected handleFileChange(uri: vscode.Uri): void | Promise<void> {
-        const targetRepos = this.repositoryManager.repos.filter((repo) => {
-            return normalizePath(repo.wdioConfigPath) === normalizePath(convertUriToPath(uri))
-        })
-        targetRepos.map((repo) => {
-            repo.reloadSpecFiles()
-        })
+    protected async handleFileChange(uri: vscode.Uri): Promise<void> {
+        await Promise.all(this.repositoryManager.repos.reduce((repos, repo) => {
+            if ( normalizePath(repo.wdioConfigPath) === normalizePath(convertUriToPath(uri))) {
+                repos.push(repo.reloadSpecFiles())
+            }
+            return repos
+        }, [] as Promise<void>[]))
+        this.testfileWatcher.refreshWatchers()
     }
 
     protected async handleFileDelete(uri: vscode.Uri): Promise<void> {
@@ -48,5 +53,11 @@ export class ConfigFileWatcher extends FileWatcherManager {
             this.repositoryManager.removeWdioConfig(workspaceUri, wdioConfigPath)
             await this.serverManager.reorganize(this.configManager.getWdioConfigPaths())
         }
+        this.testfileWatcher.refreshWatchers()
+    }
+
+    public dispose(): void {
+        this.testfileWatcher.dispose()
+        super.dispose()
     }
 }
diff --git a/src/constants.ts b/src/constants.ts
@@ -2,7 +2,6 @@ export const EXTENSION_ID = 'webdriverio'
 
 export const DEFAULT_CONFIG_VALUES = {
     configFilePattern: ['**/wdio.conf.{ts,js}'],
-    testFilePattern: ['**/*.{spec,test}.{ts,js}', '**/*.feature'],
     showOutput: true,
     logLevel: 'info',
 } as const
diff --git a/src/extension.ts b/src/extension.ts
@@ -4,7 +4,7 @@ import { ServerManager } from './api/index.js'
 import { configureTests } from './commands/configureTests.js'
 import { ConfigFileWatcher, ExtensionConfigManager } from './config/index.js'
 import { EXTENSION_ID } from './constants.js'
-import { TestfileWatcher, RepositoryManager } from './test/index.js'
+import { RepositoryManager } from './test/index.js'
 import { log } from './utils/logger.js'
 
 let extension: WdioExtension | null = null
@@ -46,12 +46,10 @@ class WdioExtension implements vscode.Disposable {
         // Create Manages and watchers
         const repositoryManager = new RepositoryManager(this.controller, this.configManager, this.serverManager)
         const configFileWatcher = new ConfigFileWatcher(this.configManager, this.serverManager, repositoryManager)
-        const testfileWatcher = new TestfileWatcher(this.configManager, repositoryManager)
 
         this._disposables = [
             vscode.commands.registerCommand('webdriverio.configureTests', configureTests),
             vscode.workspace.onDidChangeConfiguration((event) => this.configManager.listener(event)),
-            testfileWatcher,
             configFileWatcher,
             repositoryManager,
             this.serverManager,
@@ -67,11 +65,12 @@ class WdioExtension implements vscode.Disposable {
                 repositoryManager.repos.map(async (repo) => {
                     await repo.discoverAllTests()
                 })
-            ).then(() => repositoryManager.registerToTestController())
+            ).then(() => {
+                repositoryManager.registerToTestController()
+                // Enable watchers
+                configFileWatcher.enable()
+            })
 
-            // Enable watchers
-            configFileWatcher.enable()
-            testfileWatcher.enable()
         } catch (error) {
             console.log(error)
         }
diff --git a/src/test/manager.ts b/src/test/manager.ts
@@ -170,7 +170,7 @@ export class RepositoryManager implements vscode.Disposable {
             isConfigFile: true,
             isSpecFile: false,
             repository: repo,
-            runProfile: createRunProfile.call(this, configItem, !this.isCreatedDefaultProfile),
+            runProfiles: createRunProfile.call(this, configItem, !this.isCreatedDefaultProfile),
         }
         return configItem
     }
diff --git a/src/test/repository.ts b/src/test/repository.ts
@@ -16,8 +16,8 @@ import type { WdioExtensionWorkerInterface } from '../api/index.js'
  * the single WebdriverIO configuration file
  */
 export class TestRepository implements vscode.Disposable {
-    // Mapping for the id and TestItem
-    private _suiteMap = new Map<string, TestcaseTestItem>()
+    private _specPatterns:string[] = []
+    private _suiteMap = new Map<string, TestcaseTestItem>() // Mapping for the id and TestItem
     private _fileMap = new Map<string, SpecFileTestItem>()
     private _framework: string | undefined = undefined
     constructor(
@@ -27,6 +27,10 @@ export class TestRepository implements vscode.Disposable {
         private _wdioConfigTestItem: WdioConfigTestItem
     ) {}
 
+    public get specPatterns(){
+        return this._specPatterns
+    }
+
     public get framework() {
         if (!this._framework) {
             throw new Error('The configuration for WebdriverIO is not loaded')
@@ -46,6 +50,7 @@ export class TestRepository implements vscode.Disposable {
             }
 
             this._framework = config.framework
+            this._specPatterns = config.specPatterns
 
             // Get specs from configuration
             const allSpecs = this.convertPathString(config.specs)
@@ -77,6 +82,7 @@ export class TestRepository implements vscode.Disposable {
             }
 
             this._framework = config.framework
+            this._specPatterns = config.specPatterns
 
             // Get specs from configuration
             const allConfigSpecs = this.convertPathString(config.specs)
@@ -338,6 +344,7 @@ export class TestRepository implements vscode.Disposable {
     private resisterSpecFile(id: string, spec: vscode.Uri) {
         log.trace(`[repository] spec file was registered: ${id}`)
         const fileTestItem = this.controller.createTestItem(id, path.basename(spec.fsPath), spec) as SpecFileTestItem
+        fileTestItem.sortText = spec.fsPath
         fileTestItem['metadata'] = {
             isWorkspace: false,
             isConfigFile: false,
@@ -391,7 +398,7 @@ export class TestRepository implements vscode.Disposable {
      * Dispose of resources
      */
     public dispose() {
-        this._wdioConfigTestItem.metadata.runProfile.dispose()
+        this._wdioConfigTestItem.metadata.runProfiles.forEach((p)=>p.dispose())
         this._suiteMap.clear()
         this._fileMap.clear()
     }
diff --git a/src/test/types.ts b/src/test/types.ts
@@ -81,7 +81,7 @@ export interface WdioConfigTestItem extends WdioTestItem {
         isConfigFile: true
         isSpecFile: false
         repository: TestRepository
-        runProfile: vscode.TestRunProfile
+        runProfiles: vscode.TestRunProfile[]
     }
 }
 
diff --git a/src/test/watcher.ts b/src/test/watcher.ts
@@ -1,30 +1,41 @@
+import { dirname } from 'node:path'
+
+import * as vscode from 'vscode'
+
 import { log } from '../utils/logger.js'
 import { normalizePath } from '../utils/normalize.js'
-import { FileWatcherManager } from '../utils/watcher.js'
+import { FileWatcherManager, type WatchPattern } from '../utils/watcher.js'
 
-import type * as vscode from 'vscode'
 import type { RepositoryManager } from './manager.js'
-import type { ExtensionConfigManager } from '../config/index.js'
 
 export class TestfileWatcher extends FileWatcherManager {
     constructor(
-        public readonly configManager: ExtensionConfigManager,
         private readonly repositoryManager: RepositoryManager
     ) {
         super()
     }
 
     public enable() {
         this.createWatchers()
-        this.configManager.on('update:testFilePattern', () => this.refreshWatchers())
     }
 
-    protected getFilePatterns(): string[] {
-        return this.configManager.globalConfig.testFilePattern || []
+    protected getFilePatterns(): WatchPattern[] {
+        return this.repositoryManager.repos.reduce((patterns, repo)=>{
+            const configDirPath =  dirname(repo.wdioConfigPath)
+            for (const pattern of repo.specPatterns) {
+                patterns.push({
+                    base: vscode.Uri.file(configDirPath),
+                    pattern
+                })
+            }
+            return patterns
+        }, [] as WatchPattern[])
     }
+
     protected async handleFileCreate(uri: vscode.Uri): Promise<void> {
         await this._handleFileCreateAndChange(uri, true)
     }
+
     protected async handleFileChange(uri: vscode.Uri): Promise<void> {
         await this._handleFileCreateAndChange(uri, false)
     }
@@ -38,12 +49,15 @@ export class TestfileWatcher extends FileWatcherManager {
 
         // If a Spec file is newly created, attempt to read in all repositories,
         // as it is unclear which configuration file should be reflected.
-        const repos = isCreated
-            ? this.repositoryManager.repos
-            : this.repositoryManager.repos.filter((repo) => repo.getSpecByFilePath(uri.fsPath))
-
-        log.debug(`Affected repository are ${repos.length} repositories`)
-        await Promise.all(repos.map(async (repo) => await repo.reloadSpecFiles([normalizePath(specFilePath)])))
+        const promises = this.repositoryManager.repos.reduce((repos, repo)=>{
+            if (!isCreated && !repo.getSpecByFilePath(specFilePath)) {
+                return repos
+            }
+            repos.push(repo.reloadSpecFiles([normalizePath(specFilePath)]))
+            return repos
+        }, [] as Promise<void>[])
+        log.debug(`Affected repository are ${promises.length} repositories`)
+        await Promise.all(promises)
     }
 
     /**
@@ -52,12 +66,13 @@ export class TestfileWatcher extends FileWatcherManager {
     protected async handleFileDelete(uri: vscode.Uri): Promise<void> {
         const specFilePath = uri.fsPath
         log.debug(`Test file deleted: ${specFilePath}`)
-
-        const repos = this.repositoryManager.repos.filter((repo) => repo.getSpecByFilePath(uri.fsPath))
-        log.debug(`Affected repository are ${repos.length} repositories`)
-
-        repos.map(async (repo) => {
-            repo.removeSpecFile(normalizePath(specFilePath))
-        })
+        const count = this.repositoryManager.repos.reduce((counter, repo)=>{
+            if (!repo.getSpecByFilePath(specFilePath)) {
+                return counter
+            }
+            repo.removeSpecFile(specFilePath)
+            return ++counter
+        }, 0)
+        log.debug(`Affected repository are ${count} repositories`)
     }
 }
diff --git a/src/types.ts b/src/types.ts
@@ -2,7 +2,6 @@ import type { LOG_LEVEL } from './constants.js'
 
 export interface WebdriverIOConfig {
     configFilePattern: string[]
-    testFilePattern: string[]
     showOutput: boolean
     logLevel: string
 }
diff --git a/src/utils/watcher.ts b/src/utils/watcher.ts
@@ -2,6 +2,11 @@ import * as vscode from 'vscode'
 
 import { log } from '../utils/logger.js'
 
+export type WatchPattern ={
+    base?: vscode.Uri,
+    pattern: string
+}
+
 /**
  * Manages file watchers for WebdriverIO test files
  */
@@ -11,7 +16,7 @@ export abstract class FileWatcherManager implements vscode.Disposable {
     private _fileChangeHandlers: ((uri: vscode.Uri) => void)[] = [this.handleFileChange.bind(this)]
     private _fileDeleteHandlers: ((uri: vscode.Uri) => void)[] = [this.handleFileDelete.bind(this)]
 
-    protected abstract getFilePatterns(): string[]
+    protected abstract getFilePatterns(): WatchPattern[]
 
     protected abstract handleFileCreate(uri: vscode.Uri): void | Promise<void>
 
@@ -66,10 +71,12 @@ export abstract class FileWatcherManager implements vscode.Disposable {
         const patterns = this.getFilePatterns()
 
         // Split pattern by comma and create watchers for each
-        log.debug(`Creating file watchers for patterns: ${patterns.join(', ')}`)
 
-        for (const pattern of patterns) {
-            const watcher = vscode.workspace.createFileSystemWatcher(pattern)
+        for (const p of patterns) {
+            log.debug(`Creating file watchers for patterns: ${p.pattern}`)
+            const watcher = p.base
+                ? vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(p.base, p.pattern))
+                : vscode.workspace.createFileSystemWatcher(p.pattern)
 
             // Add event handlers
             watcher.onDidCreate(this._handleFileCreate.bind(this))
diff --git a/src/worker/handler.ts b/src/worker/handler.ts
@@ -62,6 +62,7 @@ export async function loadWdioConfig(this: WorkerMetaContext, options: LoadConfi
     await launcher.initialize()
 
     const configParser = await launcher.getProperty('configParser')
+    const specPatterns = configParser.getConfig().specs.flatMap((p)=>p)
     const specs = configParser.getSpecs().flatMap((specs) => {
         return Array.isArray(specs)
             ? specs.map((spec)=>normalizePath(spec))
@@ -73,5 +74,6 @@ export async function loadWdioConfig(this: WorkerMetaContext, options: LoadConfi
     return {
         framework,
         specs,
+        specPatterns,
     }
 }
diff --git a/tests/config/index.test.ts b/tests/config/index.test.ts
diff --git a/tests/config/watcher.test.ts b/tests/config/watcher.test.ts
diff --git a/tests/test/repository.spec.ts b/tests/test/repository.spec.ts
diff --git a/tests/test/watcher.test.ts b/tests/test/watcher.test.ts
diff --git a/tests/utils/watcher.test.ts b/tests/utils/watcher.test.ts
diff --git a/tests/worker/handler.test.ts b/tests/worker/handler.test.ts

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import type { NumericLogLevel } from '../types.js'`
`6`	`6`
`7`	`7`	`export type WdioConfig = {`
`8`	`8`	`specs: string[]`
	`9`	`+ specPatterns: string[]`
`9`	`10`	`framework: string`
`10`	`11`	`}`
`11`	`12`
Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ export class RepositoryManager implements vscode.Disposable {`
`170`	`170`	`isConfigFile: true,`
`171`	`171`	`isSpecFile: false,`
`172`	`172`	`repository: repo,`
`173`		`- runProfile: createRunProfile.call(this, configItem, !this.isCreatedDefaultProfile),`
	`173`	`+ runProfiles: createRunProfile.call(this, configItem, !this.isCreatedDefaultProfile),`
`174`	`174`	`}`
`175`	`175`	`return configItem`
`176`	`176`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ export interface WdioConfigTestItem extends WdioTestItem {`
`81`	`81`	`isConfigFile: true`
`82`	`82`	`isSpecFile: false`
`83`	`83`	`repository: TestRepository`
`84`		`- runProfile: vscode.TestRunProfile`
	`84`	`+ runProfiles: vscode.TestRunProfile[]`
`85`	`85`	`}`
`86`	`86`	`}`
`87`	`87`