@eclipse-glsp/server 1.1.0-next.dc6b980.47 → 1.1.0-next.de91dcd.60

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eclipse-glsp/server",
-  "version": "1.1.0-next.dc6b980.47+dc6b980",
+  "version": "1.1.0-next.de91dcd.60+de91dcd",
   "description": "A js server framework for Eclipse GLSP",
   "keywords": [
     "eclipse",
@@ -59,12 +59,11 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@eclipse-glsp/graph": "1.1.0-next.dc6b980.47+dc6b980",
+    "@eclipse-glsp/graph": "1.1.0-next.de91dcd.60+de91dcd",
     "@eclipse-glsp/protocol": "next",
     "@types/uuid": "8.3.1",
     "commander": "^8.3.0",
     "fast-json-patch": "^3.1.0",
-    "inversify": "^5.1.1",
     "winston": "^3.3.3",
     "ws": "^8.12.1"
   },
@@ -72,8 +71,11 @@
     "@types/fs-extra": "^9.0.13",
     "@types/ws": "^8.5.4"
   },
+  "peerDependencies": {
+    "inversify": "^6.0.0"
+  },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "dc6b980a473afbce8e304a2b68efe6877069dc97"
+  "gitHead": "de91dcd22122b3f46536a9581dd9ed498b311659"
 }

package/src/browser/di/app-module.ts

@@ -14,42 +14,14 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { ContainerModule, interfaces } from 'inversify';
-import { InjectionContainer, Logger, LoggerFactory, LogLevel, ModuleContext, NullLogger } from '../../common/index';
-import { ConsoleLogger } from './console-logger';
+import { ContainerModule } from 'inversify';
+import { InjectionContainer, LogLevel, LoggerConfigOptions, configureConsoleLogger } from '../../common/';
 
-export interface LaunchOptions {
-    consoleLog?: boolean;
-    logLevel?: LogLevel;
-}
-export function createAppModule(options: LaunchOptions = {}): ContainerModule {
-    const resolvedOptions: LaunchOptions = { consoleLog: true, logLevel: LogLevel.info, ...options };
+export function createAppModule(options: LoggerConfigOptions = {}): ContainerModule {
+    const resolvedOptions: LoggerConfigOptions = { consoleLog: true, logLevel: LogLevel.info, ...options };
     return new ContainerModule((bind, unbind, isBound, rebind) => {
         bind(InjectionContainer).toDynamicValue(dynamicContext => dynamicContext.container);
         const context = { bind, unbind, isBound, rebind };
         configureConsoleLogger(context, resolvedOptions);
     });
 }
-
-export function configureConsoleLogger<T extends LaunchOptions>(context: ModuleContext, options: T): void {
-    if (!options.consoleLog) {
-        context.bind(Logger).to(NullLogger).inSingletonScope();
-    } else {
-        context.bind(Logger).toDynamicValue(ctx => new ConsoleLogger(options.logLevel, getRequestParentName(ctx)));
-    }
-    context.bind(LoggerFactory).toFactory(dynamicContext => (caller: string) => {
-        const logger = dynamicContext.container.get(Logger);
-        logger.caller = caller;
-        return logger;
-    });
-}
-
-function getRequestParentName(context: interfaces.Context): string | undefined {
-    if (context.currentRequest.parentRequest) {
-        const bindings = context.currentRequest.parentRequest.bindings;
-        if (bindings.length > 0) {
-            return bindings[0].implementationType?.name;
-        }
-    }
-    return undefined;
-}

package/src/browser/index.ts

@@ -15,5 +15,4 @@
  ********************************************************************************/
 export * from '../common/index';
 export * from './di/app-module';
-export * from './di/console-logger';
 export * from './launch/worker-server-launcher';

package/src/browser/launch/worker-server-launcher.ts

@@ -14,9 +14,10 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { Container, injectable } from 'inversify';
+import { injectable } from 'inversify';
 import * as jsonrpc from 'vscode-jsonrpc/browser';
-import { GLSPServer, GLSPServerLauncher, JsonRpcGLSPServer, MaybePromise } from '../../common/index';
+import { MaybePromise } from '../../common/index';
+import { JsonRpcGLSPServerLauncher, JsonRpcServerInstance } from '../../common/launch/jsonrpc-server-launcher';
 export interface WorkerLaunchOptions {
     context?: Worker;
 }
@@ -24,22 +25,16 @@ export interface WorkerLaunchOptions {
 export const START_UP_COMPLETE_MSG = '[GLSP-Server]:Startup completed.';
 
 @injectable()
-export class WorkerServerLauncher extends GLSPServerLauncher<WorkerLaunchOptions> {
+export class WorkerServerLauncher extends JsonRpcGLSPServerLauncher<WorkerLaunchOptions> {
     protected connection?: jsonrpc.MessageConnection;
 
     protected run(options: WorkerLaunchOptions): MaybePromise<void> {
         if (this.connection) {
             throw new Error('Error during launch. Server already has an active client connection');
         }
-        const container = this.createContainer();
         this.connection = this.createConnection(options);
-        const glspServer = container.get<JsonRpcGLSPServer>(JsonRpcGLSPServer);
-        glspServer.connect(this.connection);
-        this.connection.onDispose(() => this.disposeClientConnection(container, glspServer));
-
+        this.createServerInstance(this.connection);
         this.logger.info('GLSP server worker connection established');
-        this.connection.listen();
-        this.toDispose.push(this.connection);
         postMessage(START_UP_COMPLETE_MSG);
         return new Promise((resolve, rejects) => {
             this.connection?.onClose(() => resolve(undefined));
@@ -47,9 +42,8 @@ export class WorkerServerLauncher extends GLSPServerLauncher<WorkerLaunchOptions
         });
     }
 
-    protected disposeClientConnection(container: Container, glspServer: GLSPServer): void {
-        glspServer.shutdown();
-        container.unbindAll();
+    protected override disposeServerInstance(instance: JsonRpcServerInstance): void {
+        super.disposeServerInstance(instance);
         this.connection = undefined;
     }
 

package/src/common/actions/client-action-handler.ts

@@ -13,10 +13,9 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, ActionMessage } from '@eclipse-glsp/protocol';
+import { Action, ActionMessage, GLSPClientProxy } from '@eclipse-glsp/protocol';
 import { inject, injectable, optional } from 'inversify';
 import { ClientActionKinds, ClientId } from '../di/service-identifiers';
-import { GLSPClientProxy } from '../protocol/glsp-client-proxy';
 
 /**
  * The client action handler is responsible of handling action kinds that are intended for the

package/src/common/command/command-stack.ts

@@ -13,8 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { MaybePromise } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
-import { MaybePromise } from '..';
 import { Logger } from '../utils/logger';
 import { Command } from './command';
 

package/src/common/di/binding-target.ts

@@ -152,6 +152,7 @@ namespace NoOPSyntax {
         };
         const syntax = {
             onActivation: noOpReturn,
+            onDeactivation: noOpReturn,
             when: noOpReturn,
             whenAnyAncestorIs: noOpReturn,
             whenAnyAncestorMatches: noOpReturn,

package/src/common/di/client-session-module.ts

@@ -13,8 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { GLSPClientProxy } from '@eclipse-glsp/protocol';
 import { ContainerModule } from 'inversify';
-import { GLSPClientProxy } from '../protocol/glsp-client-proxy';
 import { ClientId } from './service-identifiers';
 
 export function createClientSessionModule(clientId: string, glspClient: GLSPClientProxy): ContainerModule {

package/src/common/di/diagram-module.ts

@@ -16,6 +16,7 @@
 import {
     CenterAction,
     DeleteMarkersAction,
+    EndProgressAction,
     ExportSvgAction,
     FitToScreenAction,
     NavigateToExternalTargetAction,
@@ -39,9 +40,11 @@ import {
     SetTypeHintsAction,
     SetViewportAction,
     SourceModelChangedAction,
+    StartProgressAction,
     TriggerEdgeCreationAction,
     TriggerNodeCreationAction,
-    UpdateModelAction
+    UpdateModelAction,
+    UpdateProgressAction
 } from '@eclipse-glsp/protocol';
 import { interfaces } from 'inversify';
 import { ActionDispatcher, DefaultActionDispatcher } from '../actions/action-dispatcher';
@@ -86,6 +89,7 @@ import { RequestNavigationTargetsActionHandler } from '../features/navigation/re
 import { ResolveNavigationTargetsActionHandler } from '../features/navigation/resolve-navigation-targets-action-handler';
 import { PopupModelFactory } from '../features/popup/popup-model-factory';
 import { RequestPopupModelActionHandler } from '../features/popup/request-popup-model-action-handler';
+import { DefaultProgressService, ProgressService } from '../features/progress/progress-service';
 import { ModelValidator } from '../features/validation/model-validator';
 import { RequestMarkersHandler } from '../features/validation/request-markers-handler';
 import { CompoundOperationHandler } from '../operations/compound-operation-handler';
@@ -93,7 +97,7 @@ import { OperationActionHandler } from '../operations/operation-action-handler';
 import { OperationHandlerConstructor, OperationHandlerFactory } from '../operations/operation-handler';
 import { OperationHandlerRegistry, OperationHandlerRegistryInitializer } from '../operations/operation-handler-registry';
 import { ClientSessionInitializer } from '../session/client-session-initializer';
-import { applyBindingTarget, applyOptionalBindingTarget, BindingTarget } from './binding-target';
+import { BindingTarget, applyBindingTarget, applyOptionalBindingTarget } from './binding-target';
 import { GLSPModule } from './glsp-module';
 import { InstanceMultiBinding, MultiBinding } from './multi-binding';
 import {
@@ -133,6 +137,7 @@ import {
  * - {@link ContextActionsProviders} as {@link ClassMultiBinding<ContextActionsProvider>} (empty)
  * - {@link ContextActionsProviderRegistry}
  * - {@link ActionDispatcher}
+ * - {@link ProgressService}
  * - {@link ClientActionKinds} as {@link InstanceMultiBinding<string>}
  * - {@link ActionHandler} as {@link InstanceMultiBinding<ActionHandlerConstructor>}
  * - {@link ActionHandlerFactory}
@@ -217,6 +222,7 @@ export abstract class DiagramModule extends GLSPModule {
         this.configureMultiBinding(new MultiBinding<ClientSessionInitializer>(ClientSessionInitializer), binding =>
             this.configureClientSessionInitializers(binding)
         );
+        applyBindingTarget(context, ProgressService, this.bindProgressService()).inSingletonScope();
         applyOptionalBindingTarget(context, PopupModelFactory, this.bindPopupModelFactory());
         applyOptionalBindingTarget(context, LayoutEngine, this.bindLayoutEngine?.());
     }
@@ -308,6 +314,10 @@ export abstract class DiagramModule extends GLSPModule {
         binding.add(LayoutOperationHandler);
     }
 
+    protected bindProgressService(): BindingTarget<ProgressService> {
+        return DefaultProgressService;
+    }
+
     protected configureContextActionProviders(binding: MultiBinding<ContextActionsProvider>): void {
         // empty as default
     }
@@ -322,16 +332,17 @@ export abstract class DiagramModule extends GLSPModule {
 
     protected configureClientActions(binding: InstanceMultiBinding<string>): void {
         binding.add(CenterAction.KIND);
-        binding.add(ExportSvgAction.KIND);
         binding.add(DeleteMarkersAction.KIND);
+        binding.add(EndProgressAction.KIND);
+        binding.add(ExportSvgAction.KIND);
         binding.add(FitToScreenAction.KIND);
-        binding.add(SourceModelChangedAction.KIND);
-        binding.add(NavigateToTargetAction.KIND);
         binding.add(NavigateToExternalTargetAction.KIND);
+        binding.add(NavigateToTargetAction.KIND);
         binding.add(RequestBoundsAction.KIND);
         binding.add(SelectAction.KIND);
         binding.add(SelectAllAction.KIND);
         binding.add(ServerMessageAction.KIND);
+        binding.add(ServerStatusAction.KIND);
         binding.add(SetBoundsAction.KIND);
         binding.add(SetClipboardDataAction.KIND);
         binding.add(SetContextActions.KIND);
@@ -345,10 +356,12 @@ export abstract class DiagramModule extends GLSPModule {
         binding.add(SetResolvedNavigationTargetAction.KIND);
         binding.add(SetTypeHintsAction.KIND);
         binding.add(SetViewportAction.KIND);
-        binding.add(ServerStatusAction.KIND);
-        binding.add(TriggerNodeCreationAction.KIND);
+        binding.add(SourceModelChangedAction.KIND);
+        binding.add(StartProgressAction.KIND);
         binding.add(TriggerEdgeCreationAction.KIND);
+        binding.add(TriggerNodeCreationAction.KIND);
         binding.add(UpdateModelAction.KIND);
+        binding.add(UpdateProgressAction.KIND);
     }
 
     protected bindContextActionsProviderRegistry(): BindingTarget<ContextActionsProviderRegistry> {

package/src/common/di/glsp-module.ts

@@ -13,12 +13,14 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { BindingContext } from '@eclipse-glsp/protocol';
 import { ContainerModule, injectable, interfaces } from 'inversify';
 import { AbstractMultiBinding } from './multi-binding';
 
 /**
  * A wrapper interface to get access to the binding related functions
  * for a inversify container.
+ * @deprecated Use `BindingContext` from `@eclipse-glsp/protocol` instead
  */
 export interface ModuleContext {
     bind: interfaces.Bind;
@@ -34,7 +36,7 @@ export interface ModuleContext {
 export abstract class GLSPModule extends ContainerModule {
     public static CLIENT_ACTIONS = 'ClientActions';
 
-    protected context: ModuleContext;
+    protected context: BindingContext;
 
     constructor() {
         super((bind, unbind, isBound, rebind) => {

package/src/common/di/multi-binding.ts

@@ -13,9 +13,8 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { distinctAdd, flatPush, MaybeArray, remove } from '@eclipse-glsp/protocol';
+import { BindingContext, distinctAdd, flatPush, MaybeArray, remove } from '@eclipse-glsp/protocol';
 import { applyBindingTarget, BindingTarget } from './binding-target';
-import { ModuleContext } from './glsp-module';
 
 /**
  * A helper class used in `GLSPModules` to ease the configuration of multi-injected service identifiers.
@@ -29,7 +28,7 @@ export abstract class AbstractMultiBinding<T> {
 
     constructor(readonly identifier: string | symbol) {}
 
-    abstract applyBindings(context: ModuleContext): void;
+    abstract applyBindings(context: BindingContext): void;
 
     add(newBinding: T): void {
         distinctAdd(this.bindings, newBinding);
@@ -71,7 +70,7 @@ export abstract class AbstractMultiBinding<T> {
  * @typeparam T the base type of {@link BindingTarget}.
  */
 export class MultiBinding<T> extends AbstractMultiBinding<BindingTarget<T>> {
-    applyBindings(context: ModuleContext): void {
+    applyBindings(context: BindingContext): void {
         this.bindings.forEach(binding => applyBindingTarget(context, this.identifier, binding));
     }
 }
@@ -83,7 +82,7 @@ export class MultiBinding<T> extends AbstractMultiBinding<BindingTarget<T>> {
  * * @typeparam T the type of the instances
  */
 export class InstanceMultiBinding<T> extends AbstractMultiBinding<T> {
-    applyBindings(context: ModuleContext): void {
+    applyBindings(context: BindingContext): void {
         context.bind(this.identifier).toConstantValue(this.bindings);
     }
 }

package/src/common/di/server-module.ts

@@ -13,14 +13,13 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
+import { GLSPServer, GLSPServerListener } from '@eclipse-glsp/protocol';
 import { ContainerModule, interfaces } from 'inversify';
 import { DefaultGlobalActionProvider, GlobalActionProvider } from '../actions/global-action-provider';
-import { DefaultGLSPClientProxy, GLSPClientProxy, JsonRpcGLSPClientProxy } from '../protocol/glsp-client-proxy';
-import { DefaultGLSPServer, GLSPServer, JsonRpcGLSPServer } from '../protocol/glsp-server';
-import { GLSPServerListener } from '../protocol/glsp-server-listener';
+import { DefaultGLSPServer } from '../protocol/glsp-server';
 import { ClientSessionFactory, DefaultClientSessionFactory } from '../session/client-session-factory';
 import { ClientSessionManager, DefaultClientSessionManager } from '../session/client-session-manager';
-import { applyBindingTarget, BindingTarget } from './binding-target';
+import { BindingTarget, applyBindingTarget } from './binding-target';
 import { DiagramModule } from './diagram-module';
 import { GLSPModule } from './glsp-module';
 import { MultiBinding } from './multi-binding';
@@ -74,7 +73,6 @@ export class ServerModule extends GLSPModule {
         applyBindingTarget(context, DiagramModules, this.bindDiagramModules());
 
         applyBindingTarget(context, GLSPServer, this.bindGLSPServer()).inSingletonScope();
-        applyBindingTarget(context, JsonRpcGLSPServer, this.bindJsonRpcGLSPServer());
         applyBindingTarget(context, ClientSessionFactory, this.bindClientSessionFactory()).inSingletonScope();
         applyBindingTarget(context, ClientSessionManager, this.bindClientSessionManager()).inSingletonScope();
         this.configureMultiBinding(new MultiBinding<GLSPServerListener>(GLSPServerListener), binding =>
@@ -83,10 +81,9 @@ export class ServerModule extends GLSPModule {
 
         applyBindingTarget(context, GlobalActionProvider, this.bindGlobalActionProvider()).inSingletonScope();
 
-        applyBindingTarget(context, InjectionContainer, this.bindInjectionContainer());
-
-        applyBindingTarget(context, GLSPClientProxy, this.bindGLSPClientProxy()).inSingletonScope();
-        applyBindingTarget(context, JsonRpcGLSPClientProxy, this.bindJsonRpcGLSPClientProxy());
+        if (!isBound(InjectionContainer)) {
+            applyBindingTarget(context, InjectionContainer, this.bindInjectionContainer());
+        }
     }
 
     protected bindDiagramModules(): BindingTarget<Map<string, ContainerModule[]>> {
@@ -97,10 +94,6 @@ export class ServerModule extends GLSPModule {
         return DefaultGLSPServer;
     }
 
-    protected bindJsonRpcGLSPServer(): BindingTarget<JsonRpcGLSPServer> {
-        return { service: GLSPServer };
-    }
-
     protected bindClientSessionFactory(): BindingTarget<ClientSessionFactory> {
         return DefaultClientSessionFactory;
     }
@@ -117,14 +110,6 @@ export class ServerModule extends GLSPModule {
         return { dynamicValue: context => context.container };
     }
 
-    protected bindGLSPClientProxy(): BindingTarget<GLSPClientProxy> {
-        return DefaultGLSPClientProxy;
-    }
-
-    protected bindJsonRpcGLSPClientProxy(): BindingTarget<JsonRpcGLSPClientProxy> {
-        return { service: GLSPClientProxy };
-    }
-
     protected configureGLSPServerListeners(binding: MultiBinding<GLSPServerListener>): void {
         binding.add({ service: ClientSessionManager });
     }

package/src/common/features/model/model-submission-handler.ts

@@ -17,16 +17,20 @@ import { GModelRootSchema } from '@eclipse-glsp/graph';
 import {
     Action,
     DirtyStateChangeReason,
+    MarkersReason,
     MaybePromise,
     RequestBoundsAction,
     SetDirtyStateAction,
+    SetMarkersAction,
     SetModelAction,
     UpdateModelAction
 } from '@eclipse-glsp/protocol';
+
 import { inject, injectable, optional } from 'inversify';
 import { CommandStack } from '../../command/command-stack';
 import { DiagramConfiguration, ServerLayoutKind } from '../../diagram/diagram-configuration';
 import { LayoutEngine } from '../layout/layout-engine';
+import { ModelValidator } from '../validation/model-validator';
 import { GModelFactory } from './gmodel-factory';
 import { GModelSerializer } from './gmodel-serializer';
 import { ModelState } from './model-state';
@@ -52,6 +56,10 @@ export class ModelSubmissionHandler {
     @inject(CommandStack)
     protected commandStack: CommandStack;
 
+    @inject(ModelValidator)
+    @optional()
+    protected validator?: ModelValidator;
+
     /**
      * Returns a list of actions to update the client-side model, based on the specified <code>modelState</code>.
      *
@@ -101,6 +109,10 @@ export class ModelSubmissionHandler {
         if (!this.diagramConfiguration.needsClientLayout) {
             result.push(SetDirtyStateAction.create(this.commandStack.isDirty, { reason }));
         }
+        if (this.validator) {
+            const markers = await this.validator.validate([this.modelState.root], MarkersReason.LIVE);
+            result.push(SetMarkersAction.create(markers, { reason: MarkersReason.LIVE }));
+        }
         return result;
     }
 

package/src/common/features/model/request-model-action-handler.ts

@@ -13,11 +13,12 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, RequestModelAction, ServerMessageAction, ServerStatusAction } from '@eclipse-glsp/protocol';
+import { Action, RequestModelAction, ServerStatusAction } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
 import { ActionDispatcher } from '../../actions/action-dispatcher';
 import { ActionHandler } from '../../actions/action-handler';
 import { Logger } from '../../utils/logger';
+import { ProgressMonitor, ProgressService } from '../progress/progress-service';
 import { ModelState } from './model-state';
 import { ModelSubmissionHandler } from './model-submission-handler';
 import { SourceModelStorage } from './source-model-storage';
@@ -41,27 +42,27 @@ export class RequestModelActionHandler implements ActionHandler {
     @inject(ModelSubmissionHandler)
     protected submissionHandler: ModelSubmissionHandler;
 
+    @inject(ProgressService)
+    protected progressService: ProgressService;
+
     async execute(action: RequestModelAction): Promise<Action[]> {
         this.logger.debug('Execute RequestModelAction:', action);
         this.modelState.setAll(action.options ?? {});
 
-        this.notifyClient('Model loading in progress');
+        const progress = this.reportModelLoading('Model loading in progress');
         await this.sourceModelStorage.loadSourceModel(action);
-        // Clear the previous notification.
-        this.notifyClient();
+        this.reportModelLoadingFinished(progress);
+
         return this.submissionHandler.submitModel();
     }
 
-    /**
-     * Send a message and status notification with the given message to the client.
-     * An empty message is an indication for the client to clear previously received notifications.
-     * @param message The message that should be sent to the client
-     */
-    protected notifyClient(message = ''): void {
-        const severity = message.length > 0 ? 'INFO' : 'NONE';
-        this.actionDispatcher.dispatchAll(
-            ServerMessageAction.create(message, { severity }),
-            ServerStatusAction.create(message, { severity })
-        );
+    protected reportModelLoading(message: string): ProgressMonitor {
+        this.actionDispatcher.dispatch(ServerStatusAction.create(message, { severity: 'INFO' }));
+        return this.progressService.start(message);
+    }
+
+    protected reportModelLoadingFinished(monitor: ProgressMonitor): void {
+        this.actionDispatcher.dispatch(ServerStatusAction.create('', { severity: 'NONE' }));
+        monitor.end();
     }
 }

package/src/common/features/progress/progress-service.ts

@@ -0,0 +1,74 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource 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 { EndProgressAction, StartProgressAction, UpdateProgressAction } from '@eclipse-glsp/protocol';
+import { inject, injectable } from 'inversify';
+import * as uuid from 'uuid';
+import { ActionDispatcher } from '../../actions/action-dispatcher';
+
+export const ProgressService = Symbol('ProgressService');
+
+/**
+ * Service for starting and monitoring progress reporting to the client.
+ */
+export interface ProgressService {
+    /**
+     * Start a progress reporting.
+     * @param title The title shown in the UI for the progress reporting.
+     * @param options Additional optional options for the progress reporting.
+     * @returns a monitor to update and end the progress reporting later.
+     */
+    start(title: string, options?: ProgressOptions): ProgressMonitor;
+}
+
+/**
+ * Optional progress reporting options.
+ */
+export interface ProgressOptions {
+    /** A message shown in the UI. */
+    message?: string;
+    /* The percentage (value range: 0 to 100) to show in the progress reporting. */
+    percentage?: number;
+}
+
+/**
+ * The monitor of a progress reporting, which can be used to update and end the reporting.
+ */
+export interface ProgressMonitor {
+    /**
+     * Updates an ongoing progress reporting.
+     * @param options Updated message and/or percentage (value range: 0 to 100).
+     */
+    update(options: { message?: string; percentage?: number }): void;
+    /**
+     * Ends an ongoing progress reporting.
+     */
+    end(): void;
+}
+
+@injectable()
+export class DefaultProgressService implements ProgressService {
+    @inject(ActionDispatcher)
+    protected actionDispatcher: ActionDispatcher;
+
+    start(title: string, options?: ProgressOptions): ProgressMonitor {
+        const progressId = uuid.v4();
+        this.actionDispatcher.dispatch(StartProgressAction.create({ progressId, title, ...options }));
+        return {
+            update: updateOptions => this.actionDispatcher.dispatch(UpdateProgressAction.create(progressId, updateOptions)),
+            end: () => this.actionDispatcher.dispatch(EndProgressAction.create(progressId))
+        };
+    }
+}