test(editor): check if workspace configuration is updated (#7403)

Sysix · web-flow · commit 779f4798e28e · 2024-11-23T12:59:18.000+08:00
setter methods can not return anything (void), so that why I needed to
refactor them :)
diff --git a/editors/vscode/.vscode-test.mjs b/editors/vscode/.vscode-test.mjs
@@ -2,4 +2,5 @@ import { defineConfig } from '@vscode/test-cli';
 
 export default defineConfig({
   files: 'out/**/*.spec.js',
+  workspaceFolder: './test_workspace',
 });
diff --git a/editors/vscode/client/Config.ts b/editors/vscode/client/Config.ts
@@ -27,9 +27,9 @@ export class Config implements ConfigInterface {
     return this._runTrigger;
   }
 
-  set runTrigger(value: Trigger) {
+  updateRunTrigger(value: Trigger): PromiseLike<void> {
     this._runTrigger = value;
-    workspace
+    return workspace
       .getConfiguration(Config._namespace)
       .update('lint.run', value);
   }
@@ -38,9 +38,9 @@ export class Config implements ConfigInterface {
     return this._enable;
   }
 
-  set enable(value: boolean) {
+  updateEnable(value: boolean): PromiseLike<void> {
     this._enable = value;
-    workspace
+    return workspace
       .getConfiguration(Config._namespace)
       .update('enable', value);
   }
@@ -49,9 +49,9 @@ export class Config implements ConfigInterface {
     return this._trace;
   }
 
-  set trace(value: TraceLevel) {
+  updateTrace(value: TraceLevel): PromiseLike<void> {
     this._trace = value;
-    workspace
+    return workspace
       .getConfiguration(Config._namespace)
       .update('trace.server', value);
   }
@@ -60,9 +60,9 @@ export class Config implements ConfigInterface {
     return this._configPath;
   }
 
-  set configPath(value: string) {
+  updateConfigPath(value: string): PromiseLike<void> {
     this._configPath = value;
-    workspace
+    return workspace
       .getConfiguration(Config._namespace)
       .update('configPath', value);
   }
@@ -71,9 +71,9 @@ export class Config implements ConfigInterface {
     return this._binPath;
   }
 
-  set binPath(value: string | undefined) {
+  updateBinPath(value: string | undefined): PromiseLike<void> {
     this._binPath = value;
-    workspace
+    return workspace
       .getConfiguration(Config._namespace)
       .update('path.server', value);
   }
diff --git a/editors/vscode/client/config.spec.ts b/editors/vscode/client/config.spec.ts
@@ -1,7 +1,15 @@
 import { strictEqual } from 'assert';
+import { workspace } from 'vscode';
 import { Config } from './Config.js';
 
 suite('Config', () => {
+  setup(async () => {
+    const wsConfig = workspace.getConfiguration('oxc');
+    const keys = ['lint.run', 'enable', 'trace.server', 'configPath', 'path.server'];
+
+    await Promise.all(keys.map(key => wsConfig.update(key, undefined)));
+  });
+
   test('default values on initialization', () => {
     const config = new Config();
 
@@ -11,4 +19,24 @@ suite('Config', () => {
     strictEqual(config.configPath, '.eslintrc');
     strictEqual(config.binPath, '');
   });
+
+  test('updating values updates the workspace configuration', async () => {
+    const config = new Config();
+
+    await Promise.all([
+      config.updateRunTrigger('onSave'),
+      config.updateEnable(false),
+      config.updateTrace('messages'),
+      config.updateConfigPath('./somewhere'),
+      config.updateBinPath('./binary'),
+    ]);
+
+    const wsConfig = workspace.getConfiguration('oxc');
+
+    strictEqual(wsConfig.get('lint.run'), 'onSave');
+    strictEqual(wsConfig.get('enable'), false);
+    strictEqual(wsConfig.get('trace.server'), 'messages');
+    strictEqual(wsConfig.get('configPath'), './somewhere');
+    strictEqual(wsConfig.get('path.server'), './binary');
+  });
 });
diff --git a/editors/vscode/client/extension.ts b/editors/vscode/client/extension.ts
@@ -58,7 +58,7 @@ export async function activate(context: ExtensionContext) {
   const toggleEnable = commands.registerCommand(
     OxcCommands.ToggleEnable,
     () => {
-      configService.config.enable = !configService.config.enable;
+      configService.config.updateEnable(!configService.config.enable);
     },
   );
 
diff --git a/editors/vscode/test_workspace/.gitignore b/editors/vscode/test_workspace/.gitignore
@@ -0,0 +1,2 @@
+**
+!.gitignore

Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,9 @@ export class Config implements ConfigInterface {`
`27`	`27`	`return this._runTrigger;`
`28`	`28`	`}`
`29`	`29`
`30`		`- set runTrigger(value: Trigger) {`
	`30`	`+ updateRunTrigger(value: Trigger): PromiseLike<void> {`
`31`	`31`	`this._runTrigger = value;`
`32`		`- workspace`
	`32`	`+ return workspace`
`33`	`33`	`.getConfiguration(Config._namespace)`
`34`	`34`	`.update('lint.run', value);`
`35`	`35`	`}`
`@@ -38,9 +38,9 @@ export class Config implements ConfigInterface {`
`38`	`38`	`return this._enable;`
`39`	`39`	`}`
`40`	`40`
`41`		`- set enable(value: boolean) {`
	`41`	`+ updateEnable(value: boolean): PromiseLike<void> {`
`42`	`42`	`this._enable = value;`
`43`		`- workspace`
	`43`	`+ return workspace`
`44`	`44`	`.getConfiguration(Config._namespace)`
`45`	`45`	`.update('enable', value);`
`46`	`46`	`}`
`@@ -49,9 +49,9 @@ export class Config implements ConfigInterface {`
`49`	`49`	`return this._trace;`
`50`	`50`	`}`
`51`	`51`
`52`		`- set trace(value: TraceLevel) {`
	`52`	`+ updateTrace(value: TraceLevel): PromiseLike<void> {`
`53`	`53`	`this._trace = value;`
`54`		`- workspace`
	`54`	`+ return workspace`
`55`	`55`	`.getConfiguration(Config._namespace)`
`56`	`56`	`.update('trace.server', value);`
`57`	`57`	`}`
`@@ -60,9 +60,9 @@ export class Config implements ConfigInterface {`
`60`	`60`	`return this._configPath;`
`61`	`61`	`}`
`62`	`62`
`63`		`- set configPath(value: string) {`
	`63`	`+ updateConfigPath(value: string): PromiseLike<void> {`
`64`	`64`	`this._configPath = value;`
`65`		`- workspace`
	`65`	`+ return workspace`
`66`	`66`	`.getConfiguration(Config._namespace)`
`67`	`67`	`.update('configPath', value);`
`68`	`68`	`}`
`@@ -71,9 +71,9 @@ export class Config implements ConfigInterface {`
`71`	`71`	`return this._binPath;`
`72`	`72`	`}`
`73`	`73`
`74`		`- set binPath(value: string \| undefined) {`
	`74`	`+ updateBinPath(value: string \| undefined): PromiseLike<void> {`
`75`	`75`	`this._binPath = value;`
`76`		`- workspace`
	`76`	`+ return workspace`
`77`	`77`	`.getConfiguration(Config._namespace)`
`78`	`78`	`.update('path.server', value);`
`79`	`79`	`}`