Various minor improvements

Contributed on behalf of STMicroelectronics

Co-authored-by: Christian W. Damus <[email protected]>
Co-authored-by: Stefan Dirix <[email protected]>
Co-authored-by: Gabriel GASNOT <[email protected]>
Co-authored-by: Camille Letavernier <[email protected]>
Co-authored-by: FlorentPastorSTM <[email protected]>
Co-authored-by: Anthony Fusco <[email protected]>

* feat: add hook for modelhub fully initialized
* feat: add an abstraction layer for logger
* feat: multi client MAB
* fix: properly handle ModelHub notifications in multi-window setup
* fix: allow no command in CompoundCommand
* fix: Quash unhandled exceptions in command execution
  Catch exceptions thrown by command execution in the exclusive lock for
  command execution sequencing and log them tersely at debug level so that
  they don't appear in the normal course but are still available for
  diagnosis in detailed debugging.
* chore: migrate to Theia 1.58.4
  specify inversify resolution instead of dependency
* chore: bump hub initialization to 2min

Author: eneufeld

docs/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "overrides": [
+    {
+      "files": "*.md",
+      "options": {
+        "tabWidth": 2,
+        "singleQuote": true,
+        "printWidth": 160
+      }
+    }
+  ]
+}

examples/theia/electron-app/package.json

@@ -26,7 +26,7 @@
   },
   "devDependencies": {
     "@theia/cli": "*",
-    "electron": "^23.3.13",
+    "electron": "30.1.2",
     "rimraf": "^6.0.1"
   },
   "scripts": {

examples/theia/model-hub-integration/src/browser/model-form-widget.ts

@@ -53,6 +53,12 @@ export abstract class ModelFormWidget<M extends NonNullable<object>>
   @inject(ILogger)
   protected readonly logger: ILogger;
 
+  protected readonly onContentChangeEmitter = new Emitter<void>();
+
+  get onContentChanged() {
+    return this.onContentChangeEmitter.event;
+  }
+
   private _dirty = false;
   private dirtyChangedEmitter = new Emitter<void>();
   readonly onDirtyChanged = this.dirtyChangedEmitter.event;

ext/model-service-theia/package.json

@@ -27,7 +27,7 @@
   },
   "engines": {
     "yarn": ">=1.7.0 <2.x.x",
-    "node": ">=18.0.0"
+    "node": ">=20.14.0"
   },
   "files": [
     "lib",
@@ -45,7 +45,7 @@
     "@types/chai": "^4.2.22",
     "@types/chai-like": "^1.1.1",
     "@types/mocha": "^9.0.0",
-    "@types/node": "^16.10.3",
+    "@types/node": "^20.14.0",
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.9",
     "@typescript-eslint/eslint-plugin": "^6.7.5",

ext/model-service-theia/src/browser/__tests__/frontend-model-hub-provider.spec.ts

@@ -48,7 +48,7 @@ const MODEL1 = { name: 'Model 1' };
 describe('FrontendModelHubProvider', () => {
   const appContext = 'test-app';
 
-  let fake: FakeModelHubProtocol;
+  let fake: FakeModelHubProtocol<string>;
   let subscriber: FrontendModelHubSubscriber;
   let modelHubProvider: FrontendModelHubProvider<string>;
   let bombFrontendModelHubImpl: () => void;
@@ -62,7 +62,7 @@ describe('FrontendModelHubProvider', () => {
       FrontendModelHubProvider
     );
 
-    fake = container.get(FakeModelHubProtocol);
+    fake = container.get<FakeModelHubProtocol<string>>(FakeModelHubProtocol);
     fake.setModel(MODEL1_ID, MODEL1);
     connectClient(fake, subscriber);
 

ext/model-service-theia/src/browser/__tests__/frontend-model-hub-subscriber.spec.ts

@@ -54,7 +54,7 @@ describe('FrontendModelHubSubscriber', () => {
   const appContext = 'test-app';
 
   let sandbox: sinon.SinonSandbox;
-  let fake: FakeModelHubProtocol;
+  let fake: FakeModelHubProtocol<string>;
   let subscriber: FrontendModelHubSubscriber;
   let tracker: ModelHubTracker;
 
@@ -78,7 +78,7 @@ describe('FrontendModelHubSubscriber', () => {
     );
     tracker = container.get<ModelHubTracker>(ModelHubTracker);
 
-    fake = container.get(FakeModelHubProtocol);
+    fake = container.get<FakeModelHubProtocol<string>>(FakeModelHubProtocol);
     fake.setModel(MODEL1_ID, MODEL1);
     connectClient(fake, subscriber);
 

ext/model-service-theia/src/browser/__tests__/frontend-model-hub.spec.ts

@@ -59,7 +59,7 @@ describe('FrontendModelHub', () => {
 
   let sandbox: sinon.SinonSandbox;
   let modelHub: FrontendModelHub;
-  let fake: FakeModelHubProtocol;
+  let fake: FakeModelHubProtocol<string>;
   let provider: FrontendModelHubProvider;
 
   beforeEach(async () => {
@@ -73,7 +73,7 @@ describe('FrontendModelHub', () => {
       FrontendModelHubSubscriber
     );
 
-    fake = container.get(FakeModelHubProtocol);
+    fake = container.get<FakeModelHubProtocol<string>>(FakeModelHubProtocol);
     fake.setModel(MODEL1_ID, MODEL1);
     connectClient(fake, subscriber);
   });

ext/model-service-theia/src/browser/frontend-model-hub-provider.ts

@@ -50,7 +50,9 @@ export function bindFrontendModelHubProvider(bind: interfaces.Bind): void {
           sub.onModelHubCreated = (createdContext) => {
             if (createdContext === context) {
               try {
-                resolve(child.get(FrontendModelHubImpl));
+                resolve(
+                  child.get<FrontendModelHubImpl<string>>(FrontendModelHubImpl)
+                );
               } catch (error) {
                 reject(error);
               }

ext/model-service-theia/src/browser/frontend-model-hub.ts

@@ -16,6 +16,7 @@
 import {
   ModelHub,
   ModelHubSubscription,
+  ModelServiceSubscription,
 } from '@eclipse-emfcloud/model-service';
 import { Diagnostic } from '@eclipse-emfcloud/model-validation';
 import { ILogger } from '@theia/core';
@@ -80,11 +81,16 @@ export type FrontendModelHub<K = string> = {
     | 'getModelService'
     | 'liveValidation'
     | 'getModelAccessorBus'
+    | 'subscribe'
   >]: MakeAsync<ModelHub<K, string>[key]>;
 } & {
   readonly context: string;
   readonly isDisposed: boolean;
   getModelAccessorBus: () => FrontendModelAccessorBus;
+  subscribe<M extends object = object>(): Promise<ModelHubSubscription<K, M>>;
+  subscribe<M extends object = object>(
+    ...modelIds: K[]
+  ): Promise<ModelServiceSubscription<K, M>>;
 };
 
 export const FrontendModelHubContext = Symbol('FrontendModelHubContext');

ext/model-service-theia/src/node/__tests__/model-accessor-bus-server.spec.ts

@@ -42,6 +42,7 @@ import {
   RpcConnectionFactory,
   bindFakeRpcConnectionFactory,
 } from './fake-json-rpc';
+import { Emitter, Event } from '@theia/core';
 
 type FakeModel = Record<string, unknown>;
 const FAKE_MODEL_ID = 'test.fake-model';
@@ -58,26 +59,44 @@ function createTestContainer(contrib: ModelServiceContribution): Container {
 type FullModelAccessorBusServer = ModelAccessorBusServer<string> & {
   getModelAccessorBus: (context: string) => Promise<ModelAccessorBus>;
 };
+
 describe('Model Accessor Bus Server', () => {
   const appContext = 'test-app';
 
   let sandbox: sinon.SinonSandbox;
   let modelAccessorBusServer: ModelAccessorBusServer;
+  let modelAccessorBusServer2: ModelAccessorBusServer;
+
   let fakeContribution: FakeContribution;
   let clientProxy: {
-    [key in keyof ModelAccessorBusClient]: sinon.SinonSpy<
-      Parameters<ModelAccessorBusClient[key]>
-    >;
+    onAccessorChanged: sinon.SinonSpy;
+    closeSubscription: sinon.SinonSpy;
+    onDidOpenConnection: Event<void>;
+    onDidCloseConnection: Event<void>;
+    closeConnection: () => void;
+  };
+  let clientProxy2: {
+    onAccessorChanged: sinon.SinonSpy;
+    closeSubscription: sinon.SinonSpy;
+    onDidOpenConnection: Event<void>;
+    onDidCloseConnection: Event<void>;
+    closeConnection: () => void;
   };
 
   beforeEach(async () => {
     sandbox = sinon.createSandbox();
     fakeContribution = new FakeContribution();
     const container = createTestContainer(fakeContribution);
     const factory = container.get(RpcConnectionFactory);
+    const closeConnectionEmitter = new Emitter<void>();
     clientProxy = {
       onAccessorChanged: sandbox.stub(),
       closeSubscription: sandbox.stub(),
+      onDidOpenConnection: new Emitter<void>().event,
+      onDidCloseConnection: closeConnectionEmitter.event,
+      closeConnection(): void {
+        closeConnectionEmitter.fire();
+      },
     };
     modelAccessorBusServer = await factory.getServer<ModelAccessorBusServer>(
       ModelAccessorBusProtocolServicePath,
@@ -275,6 +294,7 @@ describe('Model Accessor Bus Server', () => {
       expect(clientProxy.onAccessorChanged.calledOnceWith(1)).to.be.true;
     });
   });
+
   describe('getModelAccessorBus', async () => {
     it('expect to be different on different contexts', async () => {
       const spiedAccessorBusAccess = sandbox.spy(
@@ -307,6 +327,45 @@ describe('Model Accessor Bus Server', () => {
       expect(bus_0 === bus_1).to.be.true;
     });
   });
+
+  describe('multiple clients', () => {
+    beforeEach(async () => {
+      const closeConnectionEmitter = new Emitter<void>();
+      clientProxy2 = {
+        onAccessorChanged: sandbox.stub(),
+        closeSubscription: sandbox.stub(),
+        onDidOpenConnection: new Emitter<void>().event,
+        onDidCloseConnection: closeConnectionEmitter.event,
+        closeConnection(): void {
+          closeConnectionEmitter.fire();
+        },
+      };
+      const container = createTestContainer(fakeContribution);
+      const factory = container.get(RpcConnectionFactory);
+      modelAccessorBusServer2 = await factory.getServer<ModelAccessorBusServer>(
+        ModelAccessorBusProtocolServicePath,
+        clientProxy2
+      );
+    });
+
+    it('supports multiple clients', async () => {
+      expect(modelAccessorBusServer2).to.exist;
+      expect(modelAccessorBusServer2).not.to.be.equal(modelAccessorBusServer); // Different instances
+    });
+
+    it('can close client', async () => {
+      const token = await modelAccessorBusServer.subscribe(appContext, 'test');
+      clientProxy.closeConnection();
+      // closeSubscription should be called before the client is removed. A real
+      // client would not receive the event (since the connection is closed), but our
+      // mock client doesn't actually have a connection to close.
+      sinon.assert.calledWithExactly(clientProxy.closeSubscription, token.id);
+      expect(modelAccessorBusServer.getClient()).to.be.undefined;
+
+      // Other server+client still exists
+      expect(modelAccessorBusServer2.getClient()).to.exist;
+    });
+  });
 });
 
 export class MockProvider extends HubAwareProvider {