-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GLSP-960 Improve Diagram container configuration
- Make import configuration constants available in DI container via `IDiagramOptions`. This includes diagramType, clientId, sourceUri and glspClient. - Introduce `DiagramLoader` as new central component responsible for configuring the glsp client and dispatching the intial model loading request - Introduce `IDiagramStartup` services that can hook into the diagram loader lifecycle (GLSP-587) - This means that feature modules are now self containted and can dispatch their initial actions, activate UI extensions on startup etc. without having to modifiy the `GLSPDiagram` (or similiar) componenent. -Add `onServerInitialized` event + tests to `GLSPClient` Part of eclipse-glsp/glsp#960 Part of eclipse-glsp/glsp#587
- Loading branch information
Showing
20 changed files
with
355 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| /******************************************************************************** | ||
| * 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 { inject, injectable, multiInject, optional, postConstruct } from 'inversify'; | ||
| import { | ||
| ApplicationIdProvider, | ||
| Args, | ||
| EMPTY_ROOT, | ||
| EndProgressAction, | ||
| GLSPClient, | ||
| MaybePromise, | ||
| RequestModelAction, | ||
| ServerStatusAction, | ||
| SetModelAction, | ||
| StartProgressAction, | ||
| TYPES | ||
| } from '~glsp-sprotty'; | ||
| import { GLSPActionDispatcher } from '../action-dispatcher'; | ||
| import { Ranked } from '../ranked'; | ||
|
|
||
| /** | ||
| * Instance specific configuration options for a GLSP diagram | ||
| */ | ||
| export interface IDiagramOptions { | ||
| /** | ||
| * Unique id associated with this diagram. Used on the server side to identify the | ||
| * corresponding client session. | ||
| */ | ||
| clientId: string; | ||
| /** | ||
| * The diagram type i.e. diagram language this diagram is associated with. | ||
| */ | ||
| diagramType: string; | ||
| /** | ||
| * The GLSP client used by this diagram to communicate with the server. | ||
| */ | ||
| glspClient: GLSPClient; | ||
| /** | ||
| * The file source URI associated with this diagram. | ||
| */ | ||
| sourceUri?: string; | ||
| } | ||
|
|
||
| /** | ||
| * Services that implement startup hooks which are invoked during the {@link DiagramLoader.load} process. | ||
| * Typically used to dispatch additional initial actions and/or activate UI extensions on startup. | ||
| * Execution order is derived by the `rank` property of the service. If not present, the {@link Ranked.DEFAULT_RANK} will be assumed. | ||
| * | ||
| */ | ||
| export interface IDiagramStartup extends Partial<Ranked> { | ||
| /** | ||
| * Hook for services that should be executed before the underlying GLSP client is configured and the server is initialized. | ||
| */ | ||
| preInitialize?(): MaybePromise<void>; | ||
| /** | ||
| * Hook for services that should be executed before the initial model loading request (i.e. `RequestModelAction`) but | ||
| * after the underlying GLSP client has been configured and the server is initialized. | ||
| */ | ||
| preModelLoading?(): MaybePromise<void>; | ||
| /** | ||
| * Hook for services that should be executed after the initial model loading request (i.e. `RequestModelAction`). | ||
| * Note that this hook is invoked directly after the `RequestModelAction` has been dispatched. It does not necessarily wait | ||
| * until the client-server update roundtrip is completed. If you need to wait until the diagram is fully initialized use the | ||
| * {@link GLSPActionDispatcher.onceModelInitialized} constraint. | ||
| */ | ||
| postModelLoading?(): MaybePromise<void>; | ||
| } | ||
|
|
||
| export namespace IDiagramStartup { | ||
| export function is(object: unknown): object is IDiagramStartup { | ||
| return Ranked.is(object) && ('preInitialize' in object || 'preModelLoading' in object || 'postModelLoading' in object); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The central component responsible for initializing the diagram and loading the graphical model | ||
| * from the GLSP server. | ||
| * Invoking the {@link DiagramLoader.load} method is typically the first operation that is executed after | ||
| * a diagram DI container has been created | ||
| */ | ||
| @injectable() | ||
| export class DiagramLoader { | ||
| @inject(TYPES.IDiagramOptions) | ||
| protected options: IDiagramOptions; | ||
|
|
||
| @inject(GLSPActionDispatcher) | ||
| protected actionDispatcher: GLSPActionDispatcher; | ||
|
|
||
| @multiInject(TYPES.IDiagramStartup) | ||
| @optional() | ||
| protected diagramStartups: IDiagramStartup[] = []; | ||
|
|
||
| protected enableLoadingNotifications = true; | ||
|
|
||
| @postConstruct() | ||
| protected postConstruct(): void { | ||
| this.diagramStartups.sort((a, b) => Ranked.getRank(a) - Ranked.getRank(b)); | ||
| } | ||
|
|
||
| async load(requestModelOptions: Args = {}): Promise<void> { | ||
| // Set placeholder model until real model from server is available | ||
| await this.actionDispatcher.dispatch(SetModelAction.create(EMPTY_ROOT)); | ||
| await this.invokeStartupHook('preInitialize'); | ||
| await this.configureGLSPClient(); | ||
| await this.invokeStartupHook('preModelLoading'); | ||
| await this.requestModel(requestModelOptions); | ||
| await this.invokeStartupHook('postModelLoading'); | ||
| } | ||
|
|
||
| protected async invokeStartupHook(hook: keyof Omit<IDiagramStartup, 'rank'>): Promise<void> { | ||
| for (const startup of this.diagramStartups) { | ||
| await startup[hook]?.(); | ||
| } | ||
| } | ||
|
|
||
| protected requestModel(requestModelOptions: Args = {}): Promise<void> { | ||
| const options = { sourceUri: this.options.sourceUri, diagramType: this.options.diagramType, ...requestModelOptions } as Args; | ||
| return this.actionDispatcher.dispatch(RequestModelAction.create({ options })); | ||
| } | ||
|
|
||
| protected async configureGLSPClient(): Promise<void> { | ||
| const glspClient = this.options.glspClient; | ||
|
|
||
| if (this.enableLoadingNotifications) { | ||
| this.actionDispatcher.dispatchAll([ | ||
| ServerStatusAction.create('Initializing...', { severity: 'INFO' }), | ||
| StartProgressAction.create({ progressId: 'initializeClient', title: 'Initializing' }) | ||
| ]); | ||
| } | ||
|
|
||
| await glspClient.start(); | ||
|
|
||
| if (!glspClient.initializeResult) { | ||
| await glspClient.initializeServer({ | ||
| applicationId: ApplicationIdProvider.get(), | ||
| protocolVersion: GLSPClient.protocolVersion | ||
| }); | ||
| } | ||
|
|
||
| if (this.enableLoadingNotifications) { | ||
| this.actionDispatcher.dispatchAll([ | ||
| ServerStatusAction.create('', { severity: 'NONE' }), | ||
| EndProgressAction.create('initializeClient') | ||
| ]); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.