feat: implement luigi config communication settings api

Author: gkrajniak

src/lib/injection-tokens.ts

@@ -1,4 +1,4 @@
 export const LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN =
   'OPENMFP_LUIGI_STATIC_SETTINGS_CONFIG_SERVICE';
-export const LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN =
-  'OPENMFP_LUIGI_COMMUNICATION_CONFIG_SERVICE';
+export const LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN =
+  'OPENMFP_LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN';

src/lib/portal.module.ts

@@ -3,7 +3,7 @@ import { HttpClientModule } from '@angular/common/http';
 import { BrowserModule } from '@angular/platform-browser';
 import { RouterOutlet } from '@angular/router';
 import {
-  LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
+  LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN,
   LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
 } from './injection-tokens';
 import { LogoutComponent } from './logout/logout.component';
@@ -12,18 +12,17 @@ import { CallbackComponent } from './callback/callback.component';
 import { PortalRoutingModule } from './portal-routing.module';
 import { PortalComponent } from './portal.component';
 import {
+  CustomMessageListener,
   StaticSettingsConfigService,
   StaticSettingsConfigServiceImpl,
-  CommunicationConfigService,
-  CommunicationConfigServiceImpl,
 } from './services';
 
 export interface PortalModuleOptions {
   /** Service containing and providing the luigi settings configuration **/
   staticSettingsConfigService?: Type<StaticSettingsConfigService>;
 
-  /** Service containing and providing the luigi communication configuration **/
-  communicationConfigService?: Type<CommunicationConfigService>;
+  /** A set of class representing custom listeners **/
+  customMessageListeners?: Type<CustomMessageListener>[];
 }
 
 @NgModule({
@@ -38,17 +37,21 @@ export interface PortalModuleOptions {
       provide: LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
       useClass: StaticSettingsConfigServiceImpl,
     },
-    {
-      provide: LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
-      useClass: CommunicationConfigServiceImpl,
-    },
   ],
   imports: [PortalRoutingModule, BrowserModule, RouterOutlet, HttpClientModule],
   exports: [PortalComponent],
   bootstrap: [PortalComponent],
 })
 export class PortalModule {
   static create(options: PortalModuleOptions): NgModule {
+    const customMessageListeners = (options.customMessageListeners || []).map(
+      (customMessageListenerClass) => ({
+        provide: LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN,
+        multi: true,
+        useClass: customMessageListenerClass,
+      })
+    );
+
     return {
       declarations: [
         LuigiComponent,
@@ -57,18 +60,13 @@ export class PortalModule {
         LogoutComponent,
       ],
       providers: [
+        ...customMessageListeners,
         {
           provide: LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
           useClass:
             options.staticSettingsConfigService ||
             StaticSettingsConfigServiceImpl,
         },
-        {
-          provide: LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
-          useClass:
-            options.communicationConfigService ||
-            CommunicationConfigServiceImpl,
-        },
       ],
       imports: [
         PortalRoutingModule,

src/lib/services/index.ts

@@ -2,4 +2,4 @@ export * from './auth.service';
 export * from './luigi-core.service';
 export * from './luigi-config/luigi-config.service';
 export * from './luigi-config/static-settings-config.service';
-export * from './luigi-config/communication-config.service';
+export * from './luigi-config/custom-message-listener';

src/lib/services/luigi-config/communication-config.service.spec.ts

@@ -0,0 +1,26 @@
+/**
+ * A representation of a custom message listener and the custom message the listener listens on.
+ * See also {@link https://docs.luigi-project.io/docs/communication/?section=luigi-client-to-luigi-core}
+ */
+import { Subject } from 'rxjs';
+
+export interface CustomMessageListener {
+  /**
+   * The custom message id the listener is registered for.
+   */
+  messageId(): string;
+  changed?: Subject<void>;
+
+  /**
+   * The callback to be executed when the custom message is send by Luigi.
+   *
+   * @param customMessage The message object, see also {@link https://docs.luigi-project.io/docs/luigi-client-api?section=sendcustommessage}
+   * @param mfObject The micro frontend object, see also {@link https://docs.luigi-project.io/docs/luigi-core-api?section=getmicrofrontends}
+   * @param mfNodesObject The nodes object of the micro frontend, see also {@link https://docs.luigi-project.io/docs/navigation-parameters-reference?section=node-parameters}
+   */
+  onCustomMessageReceived(
+    customMessage: string,
+    mfObject: any,
+    mfNodesObject: any
+  ): void;
+}

src/lib/services/luigi-config/communication-config.service.ts

@@ -0,0 +1,67 @@
+import { TestBed } from '@angular/core/testing';
+import { LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN } from '../../injection-tokens';
+import { Subject } from 'rxjs';
+import { CustomMessageListener } from './custom-message-listener';
+import { CustomMessageListeners } from './custom-message-listeners.service';
+
+class ProjectCreatedListener implements CustomMessageListener {
+  messageId(): string {
+    return 'ProjectCreatedListener';
+  }
+  changed?: Subject<void>;
+  onCustomMessageReceived(): void {}
+}
+
+class EntityChangedListener implements CustomMessageListener {
+  messageId(): string {
+    return 'EntityChangedListener';
+  }
+  changed?: Subject<void>;
+  onCustomMessageReceived(): void {}
+}
+
+describe('CustomMessageListeners', () => {
+  let customMessageListeners: CustomMessageListeners;
+
+  beforeEach(() => {
+    TestBed.configureTestingModule({
+      providers: [
+        {
+          provide: LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN,
+          multi: true,
+          useClass: ProjectCreatedListener,
+        },
+        {
+          provide: LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN,
+          multi: true,
+          useClass: EntityChangedListener,
+        },
+      ],
+    }).compileComponents();
+
+    customMessageListeners = TestBed.inject(CustomMessageListeners);
+  });
+
+  it('should be defined', () => {
+    expect(customMessageListeners).toBeDefined();
+  });
+
+  it('should provide a customMessageListeners object', () => {
+    expect(Object.keys(customMessageListeners.messageListeners)).toContain(
+      'customMessagesListeners'
+    );
+  });
+
+  it('should provide custom message listeners', () => {
+    expect(listeners()).toBeDefined();
+    expect(listeners()).toContain('ProjectCreatedListener');
+    expect(listeners()).toContain('EntityChangedListener');
+    expect(listeners().length).toBe(2);
+  });
+
+  function listeners(): string[] {
+    return Object.keys(
+      customMessageListeners.messageListeners.customMessagesListeners
+    );
+  }
+});

src/lib/services/luigi-config/custom-message-listener.ts

@@ -0,0 +1,41 @@
+import { Inject, Injectable } from '@angular/core';
+import { Subject } from 'rxjs';
+import { LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN } from '../../injection-tokens';
+import { CustomMessageListener } from './custom-message-listener';
+
+/**
+ * This class holds the listeners for custom messages used by the application portal.
+ * See also {@link https://docs.luigi-project.io/docs/communication/?section=luigi-core-to-luigi-client}
+ * See also {@link https://docs.luigi-project.io/docs/luigi-core-api/?section=custommessages}
+ */
+@Injectable({
+  providedIn: 'root',
+})
+export class CustomMessageListeners {
+  public changed: Subject<void> = new Subject<void>();
+
+  constructor(
+    @Inject(LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN)
+    private listeners: CustomMessageListener[]
+  ) {}
+
+  /**
+   * An object containing the property 'customMessageListeners' in which the message-id and listener assignments are made.
+   * See also {@link https://docs.luigi-project.io/docs/communication/?section=luigi-core-to-luigi-client}
+   */
+  public get messageListeners(): any {
+    const result = { customMessagesListeners: {} };
+    for (const listener of this.listeners) {
+      const obj = {
+        [listener.messageId()]: (msg, mf, mfNodes) => {
+          listener.onCustomMessageReceived(msg, mf, mfNodes);
+          listener.changed?.subscribe(() => {
+            this.changed.next();
+          });
+        },
+      };
+      Object.assign(result.customMessagesListeners, obj);
+    }
+    return result;
+  }
+}

src/lib/services/luigi-config/custom-message-listeners.service.spec.ts

@@ -1,13 +1,10 @@
 import { Inject, Injectable } from '@angular/core';
-import {
-  LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
-  LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
-} from '../../injection-tokens';
+import { LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN } from '../../injection-tokens';
 import { ClientEnvironment } from '../../model/env';
 import { AuthConfigService } from './auth-config.service';
 import { EnvConfigService } from '../env-config.service';
-import { CommunicationConfigService } from './communication-config.service';
 import { StaticSettingsConfigService } from './static-settings-config.service';
+import { CustomMessageListeners } from './custom-message-listeners.service';
 
 @Injectable({
   providedIn: 'root',
@@ -16,10 +13,9 @@ export class LuigiConfigService {
   constructor(
     private envConfigService: EnvConfigService,
     private authConfigService: AuthConfigService,
+    private customMessageListeners: CustomMessageListeners,
     @Inject(LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN)
-    private staticSettingsConfigService: StaticSettingsConfigService,
-    @Inject(LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN)
-    private communicationConfigService: CommunicationConfigService
+    private staticSettingsConfigService: StaticSettingsConfigService
   ) {}
 
   public async getLuigiConfiguration() {
@@ -31,7 +27,7 @@ export class LuigiConfigService {
         envConfig.clientId
       ),
       routing: this.getInitialRoutingConfig(),
-      communication: this.communicationConfigService.getCommunicationConfig(),
+      communication: this.customMessageListeners.messageListeners,
       settings:
         this.staticSettingsConfigService.getInitialStaticSettingsConfig(),
     };