refactor core messaging and RPC (electron-only so far)

dev-packages/application-manager/src/generator/backend-generator.ts

@@ -91,7 +91,7 @@ const serverModule = require('./server');
 const serverAddress = main.start(serverModule());
 
 serverAddress.then(({ port, address }) => {
-    if (process && process.send) {
+    if (process.send) {
         process.send({ port, address });
     }
 });

dev-packages/localization-manager/src/localization-manager.ts

@@ -17,8 +17,7 @@
 import * as chalk from 'chalk';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { sortLocalization } from '.';
-import { Localization } from './common';
+import { Localization, sortLocalization } from './common';
 import { deepl, DeeplLanguage, DeeplParameters, isSupportedLanguage, supportedLanguages } from './deepl-api';
 
 export interface LocalizationOptions {

dev-packages/private-re-exports/src/package-re-exports.ts

@@ -17,8 +17,7 @@
 import cp = require('child_process');
 import fs = require('fs');
 import path = require('path');
-import { parseModule } from '.';
-import { PackageJson, ReExportJson } from './utility';
+import { PackageJson, parseModule, ReExportJson } from './utility';
 
 export async function readJson<T = unknown>(jsonPath: string): Promise<T> {
     return JSON.parse(await fs.promises.readFile(jsonPath, 'utf8')) as T;

doc/Migration.md

@@ -42,14 +42,14 @@ This version updates the Monaco code used in Theia to the state of VSCode 1.65.2
 
 #### ASM to ESM
 
-Two kinds of changes may be required to consume Monaco using ESM modules. 
+Two kinds of changes may be required to consume Monaco using ESM modules.
 
  - If your application uses its own Webpack config rather than that generated by the @theia/dev-packages, you
 will need to update that config to remove the `CopyWebpackPlugin` formerly used to place Monaco
 code in the build folder and to build a separate entrypoint for the `editor.worker`. See [the changes here](https://github.com/eclipse-theia/theia/pull/10736/files#diff-b4677f3ff57d8b952eeefc10493ed3600d2737f9b5c9b0630b172472acb9c3a2)
  - If your application uses its own frontend generator, you should modify the code that generates the `index.html` to load the `script` containing the bundle into the `body` element rather than the head. See [changes here](https://github.com/eclipse-theia/theia/pull/10947/files)
- - References to the `window.monaco` object should be replaced with imports from `@theia/monaco-editor-core`. In most cases, simply adding an import `import * as monaco from 
-'@theia/monaco-editor-core'` will suffice. More complex use cases may require imports from specific parts of Monaco. Please see 
+ - References to the `window.monaco` object should be replaced with imports from `@theia/monaco-editor-core`. In most cases, simply adding an import `import * as monaco from
+'@theia/monaco-editor-core'` will suffice. More complex use cases may require imports from specific parts of Monaco. Please see
 [the PR](https://github.com/eclipse-theia/theia/pull/10736) for details, and please post any questions or problems there.
 
 Using ESM modules, it is now possible to follow imports to definitions and to the Monaco source code. This should aid in tracking down issues related to changes in Monaco discussed

examples/api-samples/package.json

@@ -26,6 +26,10 @@
     {
       "electronMain": "lib/electron-main/update/sample-updater-main-module",
       "frontendElectron": "lib/electron-browser/updater/sample-updater-frontend-module"
+    },
+    {
+      "electronMain": "lib/electron-main/ipc/electron-main-ipc-module",
+      "backendElectron": "lib/electron-node/ipc/electron-backend-ipc-module"
     }
   ],
   "keywords": [

examples/api-samples/src/common/updater/sample-updater.ts

@@ -13,25 +13,20 @@
 //
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
-import { JsonRpcServer } from '@theia/core/lib/common/messaging/proxy-factory';
+
+import { Event, serviceIdentifier, servicePath } from '@theia/core/lib/common';
 
 export enum UpdateStatus {
     InProgress = 'in-progress',
     Available = 'available',
     NotAvailable = 'not-available'
 }
 
-export const SampleUpdaterPath = '/services/sample-updater';
-export const SampleUpdater = Symbol('SampleUpdater');
-export interface SampleUpdater extends JsonRpcServer<SampleUpdaterClient> {
+export const SampleUpdaterPath = servicePath<SampleUpdater>('/services/sample-updater');
+export const SampleUpdater = serviceIdentifier<SampleUpdater>('SampleUpdater');
+export interface SampleUpdater {
+    onReadyToInstall: Event<void>;
     checkForUpdates(): Promise<{ status: UpdateStatus }>;
     onRestartToUpdateRequested(): void;
-    disconnectClient(client: SampleUpdaterClient): void;
-
     setUpdateAvailable(available: boolean): Promise<void>; // Mock
 }
-
-export const SampleUpdaterClient = Symbol('SampleUpdaterClient');
-export interface SampleUpdaterClient {
-    notifyReadyToInstall(): void;
-}

examples/api-samples/src/electron-browser/updater/sample-updater-frontend-contribution.ts

@@ -20,7 +20,6 @@ import { inject, injectable, postConstruct } from '@theia/core/shared/inversify'
 import { isOSX } from '@theia/core/lib/common/os';
 import { CommonMenus } from '@theia/core/lib/browser';
 import {
-    Emitter,
     Command,
     MenuPath,
     MessageService,
@@ -31,7 +30,7 @@ import {
 } from '@theia/core/lib/common';
 import { ElectronMainMenuFactory } from '@theia/core/lib/electron-browser/menu/electron-main-menu-factory';
 import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
-import { SampleUpdater, UpdateStatus, SampleUpdaterClient } from '../../common/updater/sample-updater';
+import { SampleUpdater, UpdateStatus } from '../../common/updater/sample-updater';
 
 export namespace SampleUpdaterCommands {
 
@@ -68,18 +67,6 @@ export namespace SampleUpdaterMenu {
     export const MENU_PATH: MenuPath = [...CommonMenus.FILE_SETTINGS_SUBMENU, '3_settings_submenu_update'];
 }
 
-@injectable()
-export class SampleUpdaterClientImpl implements SampleUpdaterClient {
-
-    protected readonly onReadyToInstallEmitter = new Emitter<void>();
-    readonly onReadyToInstall = this.onReadyToInstallEmitter.event;
-
-    notifyReadyToInstall(): void {
-        this.onReadyToInstallEmitter.fire();
-    }
-
-}
-
 // Dynamic menus aren't yet supported by electron: https://github.com/eclipse-theia/theia/issues/446
 @injectable()
 export class ElectronMenuUpdater {
@@ -113,14 +100,11 @@ export class SampleUpdaterFrontendContribution implements CommandContribution, M
     @inject(SampleUpdater)
     protected readonly updater: SampleUpdater;
 
-    @inject(SampleUpdaterClientImpl)
-    protected readonly updaterClient: SampleUpdaterClientImpl;
-
     protected readyToUpdate = false;
 
     @postConstruct()
     protected init(): void {
-        this.updaterClient.onReadyToInstall(async () => {
+        this.updater.onReadyToInstall(async () => {
             this.readyToUpdate = true;
             this.menuUpdater.update();
             this.handleUpdatesAvailable();
@@ -138,7 +122,7 @@ export class SampleUpdaterFrontendContribution implements CommandContribution, M
                     }
                     case UpdateStatus.NotAvailable: {
                         const { applicationName } = FrontendApplicationConfigProvider.get();
-                        this.messageService.info(`[Not Available]: You’re all good. You’ve got the latest version of ${applicationName}.`, { timeout: 3000 });
+                        this.messageService.info(`[Not Available]: You're all good. You've got the latest version of ${applicationName}.`, { timeout: 3000 });
                         break;
                     }
                     case UpdateStatus.InProgress: {

examples/api-samples/src/electron-browser/updater/sample-updater-frontend-module.ts

@@ -14,21 +14,17 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
 
+import { bindContribution, CommandContribution, MenuContribution, ProxyProvider } from '@theia/core/lib/common';
+import { ElectronMainAndFrontend } from '@theia/core/lib/electron-common';
 import { ContainerModule } from '@theia/core/shared/inversify';
-import { ElectronIpcConnectionProvider } from '@theia/core/lib/electron-browser/messaging/electron-ipc-connection-provider';
-import { CommandContribution, MenuContribution } from '@theia/core/lib/common';
-import { SampleUpdater, SampleUpdaterPath, SampleUpdaterClient } from '../../common/updater/sample-updater';
-import { SampleUpdaterFrontendContribution, ElectronMenuUpdater, SampleUpdaterClientImpl } from './sample-updater-frontend-contribution';
+import { SampleUpdater, SampleUpdaterPath } from '../../common/updater/sample-updater';
+import { ElectronMenuUpdater, SampleUpdaterFrontendContribution } from './sample-updater-frontend-contribution';
 
 export default new ContainerModule(bind => {
+    bind(SampleUpdater)
+        .toDynamicValue(ctx => ctx.container.getNamed(ProxyProvider, ElectronMainAndFrontend).getProxy(SampleUpdaterPath))
+        .inSingletonScope();
     bind(ElectronMenuUpdater).toSelf().inSingletonScope();
-    bind(SampleUpdaterClientImpl).toSelf().inSingletonScope();
-    bind(SampleUpdaterClient).toService(SampleUpdaterClientImpl);
-    bind(SampleUpdater).toDynamicValue(context => {
-        const client = context.container.get(SampleUpdaterClientImpl);
-        return ElectronIpcConnectionProvider.createProxy(context.container, SampleUpdaterPath, client);
-    }).inSingletonScope();
     bind(SampleUpdaterFrontendContribution).toSelf().inSingletonScope();
-    bind(MenuContribution).toService(SampleUpdaterFrontendContribution);
-    bind(CommandContribution).toService(SampleUpdaterFrontendContribution);
+    bindContribution(bind, SampleUpdaterFrontendContribution, [MenuContribution, CommandContribution]);
 });

examples/api-samples/src/electron-common/ipc/electron-ipc.ts

@@ -0,0 +1,23 @@
+// *****************************************************************************
+// Copyright (C) 2022 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { serviceIdentifier, servicePath } from '@theia/core/lib/common';
+
+export const ELECTRON_MAIN_AND_BACKEND_IPC_SAMPLE_PATH = servicePath<ElectronMainAndBackendIpcSample>('/services/test-connection');
+export const ElectronMainAndBackendIpcSample = serviceIdentifier<ElectronMainAndBackendIpcSample>('TestConnection');
+export interface ElectronMainAndBackendIpcSample {
+    getBrowserWindowTitles(): Promise<string[]>
+}

packages/core/src/electron-common/messaging/electron-connection-handler.ts → examples/api-samples/src/electron-main/ipc/electron-main-ipc-impl.ts

@@ -1,5 +1,5 @@
 // *****************************************************************************
-// Copyright (C) 2020 Ericsson and others.
+// Copyright (C) 2022 TypeFox and others.
 //
 // This program and the accompanying materials are made available under the
 // terms of the Eclipse Public License v. 2.0 which is available at
@@ -14,17 +14,14 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 // *****************************************************************************
 
-import { ConnectionHandler } from '../../common/messaging/handler';
+import { BrowserWindow } from '@theia/core/electron-shared/electron';
+import { injectable } from '@theia/core/shared/inversify';
+import { ElectronMainAndBackendIpcSample } from '../../electron-common/ipc/electron-ipc';
 
-/**
- * Name of the channel used with `ipcMain.on/emit`.
- */
-export const THEIA_ELECTRON_IPC_CHANNEL_NAME = 'theia-electron-ipc';
+@injectable()
+export class ElectronMainAndBackendIpcSampleImpl implements ElectronMainAndBackendIpcSample {
 
-/**
- * Electron-IPC-specific connection handler.
- * Use this if you want to establish communication between the frontend and the electron-main process.
- */
-export const ElectronConnectionHandler = Symbol('ElectronConnectionHandler');
-export interface ElectronConnectionHandler extends ConnectionHandler {
+    async getBrowserWindowTitles(): Promise<string[]> {
+        return BrowserWindow.getAllWindows().map(browserWindow => browserWindow.getTitle());
+    }
 }

examples/api-samples/src/electron-main/ipc/electron-main-ipc-module.ts

@@ -0,0 +1,32 @@
+// *****************************************************************************
+// Copyright (C) 2022 Ericsson// *****************************************************************************
+// Copyright (C) 2020 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ServiceContribution } from '@theia/core/lib/common';
+import { ElectronMainAndBackend } from '@theia/core/lib/electron-common';
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { ElectronMainAndBackendIpcSample, ELECTRON_MAIN_AND_BACKEND_IPC_SAMPLE_PATH } from '../../electron-common/ipc/electron-ipc';
+import { ElectronMainAndBackendIpcSampleImpl } from './electron-main-ipc-impl';
+
+export default new ContainerModule(bind => {
+    bind(ElectronMainAndBackendIpcSample).to(ElectronMainAndBackendIpcSampleImpl).inSingletonScope();
+    bind(ServiceContribution)
+        .toDynamicValue(ctx => ({
+            [ELECTRON_MAIN_AND_BACKEND_IPC_SAMPLE_PATH]: () => ctx.container.get(ElectronMainAndBackendIpcSample)
+        }))
+        .inSingletonScope()
+        .whenTargetNamed(ElectronMainAndBackend);
+});

examples/api-samples/src/electron-main/update/sample-updater-impl.ts

@@ -16,15 +16,20 @@
 
 import { injectable } from '@theia/core/shared/inversify';
 import { ElectronMainApplication, ElectronMainApplicationContribution } from '@theia/core/lib/electron-main/electron-main-application';
-import { SampleUpdater, SampleUpdaterClient, UpdateStatus } from '../../common/updater/sample-updater';
+import { SampleUpdater, UpdateStatus } from '../../common/updater/sample-updater';
+import { Emitter, Event } from '@theia/core/lib/common';
 
 @injectable()
 export class SampleUpdaterImpl implements SampleUpdater, ElectronMainApplicationContribution {
 
-    protected clients: Array<SampleUpdaterClient> = [];
+    protected onReadyToInstallEmitter = new Emitter<void>();
     protected inProgressTimer: NodeJS.Timer | undefined;
     protected available = false;
 
+    get onReadyToInstall(): Event<void> {
+        return this.onReadyToInstallEmitter.event;
+    }
+
     async checkForUpdates(): Promise<{ status: UpdateStatus }> {
         if (this.inProgressTimer) {
             return { status: UpdateStatus.InProgress };
@@ -48,9 +53,7 @@ export class SampleUpdaterImpl implements SampleUpdater, ElectronMainApplication
             this.inProgressTimer = setTimeout(() => {
                 this.inProgressTimer = undefined;
                 this.available = true;
-                for (const client of this.clients) {
-                    client.notifyReadyToInstall();
-                }
+                this.onReadyToInstallEmitter.fire();
             }, 5000);
         }
     }
@@ -62,30 +65,4 @@ export class SampleUpdaterImpl implements SampleUpdater, ElectronMainApplication
     onStop(application: ElectronMainApplication): void {
         // Invoked when the contribution is stopping. You can clean up things here. You are not allowed call async code from here.
     }
-
-    setClient(client: SampleUpdaterClient | undefined): void {
-        if (client) {
-            this.clients.push(client);
-            console.info('Registered a new sample updater client.');
-        } else {
-            console.warn("Couldn't register undefined client.");
-        }
-    }
-
-    disconnectClient(client: SampleUpdaterClient): void {
-        const index = this.clients.indexOf(client);
-        if (index !== -1) {
-            this.clients.splice(index, 1);
-            console.info('Disposed a sample updater client.');
-        } else {
-            console.warn("Couldn't dispose client; it was not registered.");
-        }
-    }
-
-    dispose(): void {
-        console.info('>>> Disposing sample updater service...');
-        this.clients.forEach(this.disconnectClient.bind(this));
-        console.info('>>> Disposed sample updater service.');
-    }
-
 }

examples/api-samples/src/electron-main/update/sample-updater-main-module.ts

@@ -15,22 +15,27 @@
 // *****************************************************************************
 
 import { ContainerModule } from '@theia/core/shared/inversify';
-import { JsonRpcConnectionHandler } from '@theia/core/lib/common/messaging/proxy-factory';
 import { ElectronMainApplicationContribution } from '@theia/core/lib/electron-main/electron-main-application';
-import { ElectronConnectionHandler } from '@theia/core/lib/electron-common/messaging/electron-connection-handler';
-import { SampleUpdaterPath, SampleUpdater, SampleUpdaterClient } from '../../common/updater/sample-updater';
+import { SampleUpdaterPath, SampleUpdater } from '../../common/updater/sample-updater';
 import { SampleUpdaterImpl } from './sample-updater-impl';
+import { ServiceContribution } from '@theia/core/lib/common';
+import { ElectronMainAndFrontend } from '@theia/core/lib/electron-common';
+
+export const SampleUpdaterElectronMainAndFrontendContainerModule = new ContainerModule(bind => {
+    bind(ServiceContribution)
+        .toDynamicValue(ctx => ({
+            // This will return the same singleton instance from the main container module
+            // for `SampleUpdater`, but this is by design here.
+            [SampleUpdaterPath]: () => ctx.container.get(SampleUpdater)
+        }))
+        .inSingletonScope()
+        .whenTargetNamed(ElectronMainAndFrontend);
+});
 
 export default new ContainerModule(bind => {
-    bind(SampleUpdaterImpl).toSelf().inSingletonScope();
-    bind(SampleUpdater).toService(SampleUpdaterImpl);
+    bind(SampleUpdater).to(SampleUpdaterImpl).inSingletonScope();
     bind(ElectronMainApplicationContribution).toService(SampleUpdater);
-    bind(ElectronConnectionHandler).toDynamicValue(context =>
-        new JsonRpcConnectionHandler<SampleUpdaterClient>(SampleUpdaterPath, client => {
-            const server = context.container.get<SampleUpdater>(SampleUpdater);
-            server.setClient(client);
-            client.onDidCloseConnection(() => server.disconnectClient(client));
-            return server;
-        })
-    ).inSingletonScope();
+    bind(ContainerModule)
+        .toConstantValue(SampleUpdaterElectronMainAndFrontendContainerModule)
+        .whenTargetNamed(ElectronMainAndFrontend);
 });