Make IntegrationVariable type safe

eclipse-glsp · Aug 8, 2024 · 8c3d7e6 · 8c3d7e6
1 parent 0e7af7e
commit 8c3d7e6
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 20 deletions.
diff --git a/examples/workflow-test/tests/features/hover/popup.spec.ts b/examples/workflow-test/tests/features/hover/popup.spec.ts
@@ -76,7 +76,7 @@ test.describe('The popup', () => {
     test.beforeEach(async ({ integration, glspServer }) => {
         app = new WorkflowApp({
             type: 'integration',
-            integration: integration
+            integration
         });
         graph = app.graph;
         expectedManualPopupText.setServer(glspServer);

diff --git a/examples/workflow-test/tests/features/validation/marker-navigator.spec.ts b/examples/workflow-test/tests/features/validation/marker-navigator.spec.ts
@@ -41,7 +41,7 @@ test.describe('The marker navigator', () => {
             integration
         });
         graph = app.graph;
-        const navigatorProvider = new IntegrationVariable({
+        const navigatorProvider = new IntegrationVariable<MarkerNavigator>({
             value: {
                 Standalone: new StandaloneMarkerNavigator(app),
                 Theia: new TheiaMarkerNavigator(app)

diff --git a/packages/glsp-playwright/src/test/dynamic-variable.ts b/packages/glsp-playwright/src/test/dynamic-variable.ts
@@ -14,45 +14,47 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
+import { Integration, IntegrationType } from '~/integration';
 import type { GLSPServer } from '../glsp-server';
-import { Integration } from '../integration';
 
-export interface DynamicVariableOptions<T> {
-    defaultValue?: T;
-    value?: Record<string, T>;
+type RecordKey = string | number | symbol;
+
+export interface DynamicVariableOptions<TKey extends RecordKey, TValue> {
+    defaultValue?: TValue;
+    value?: Partial<Record<TKey, TValue | undefined>>;
 }
 
-export interface DynamicVariable<T> {
-    getOrThrow(key: string): T;
+export interface DynamicVariable<TKey extends RecordKey, TValue> {
+    getOrThrow(key: TKey): TValue;
 }
 
-export abstract class BaseDynamicVariable<T> {
-    protected readonly value: Record<string, T>;
-    protected readonly defaultValue?: T;
+export abstract class BaseDynamicVariable<TKey extends RecordKey, TValue> {
+    protected readonly value: Partial<Record<TKey, TValue | undefined>>;
+    protected readonly defaultValue?: TValue;
 
-    constructor(protected readonly options: DynamicVariableOptions<T>) {
+    constructor(protected readonly options: DynamicVariableOptions<TKey, TValue>) {
         this.defaultValue = options?.defaultValue;
         this.value = options?.value ?? {};
     }
 
-    getOrThrow(key: string): T {
+    getOrThrow(key: TKey): TValue {
         const value = this.value[key] ?? this.defaultValue;
         if (value === undefined) {
-            throw new Error(`No value found for key ${key}`);
+            throw new Error(`No value found for key ${String(key)}`);
         }
         return value;
     }
 }
 
-export class IntegrationVariable<T> extends BaseDynamicVariable<T> {
+export class IntegrationVariable<TValue> extends BaseDynamicVariable<IntegrationType, TValue> {
     protected integration?: Integration;
 
-    constructor(options: DynamicVariableOptions<T> & { integration?: Integration }) {
+    constructor(options: DynamicVariableOptions<IntegrationType, TValue> & { integration?: Integration }) {
         super(options);
         this.integration = options.integration;
     }
 
-    get(): T {
+    get(): TValue {
         if (this.integration === undefined) {
             throw new Error('No integration set');
         }
@@ -65,15 +67,15 @@ export class IntegrationVariable<T> extends BaseDynamicVariable<T> {
     }
 }
 
-export class ServerVariable<T> extends BaseDynamicVariable<T> {
+export class ServerVariable<TValue> extends BaseDynamicVariable<string, TValue> {
     protected server?: GLSPServer;
 
-    constructor(options: DynamicVariableOptions<T> & { server?: GLSPServer }) {
+    constructor(options: DynamicVariableOptions<string, TValue> & { server?: GLSPServer }) {
         super(options);
         this.server = options.server;
     }
 
-    get(): T {
+    get(): TValue {
         if (this.server === undefined) {
             throw new Error('No GLSP server set');
         }