feat: implement luigi config communication settings api

Author: gkrajniak

src/lib/injection-tokens.ts

@@ -1,2 +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';

src/lib/portal.module.ts

@@ -2,7 +2,10 @@ import { NgModule, Type } from '@angular/core';
 import { HttpClientModule } from '@angular/common/http';
 import { BrowserModule } from '@angular/platform-browser';
 import { RouterOutlet } from '@angular/router';
-import { LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN } from './injection-tokens';
+import {
+  LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
+  LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
+} from './injection-tokens';
 import { LogoutComponent } from './logout/logout.component';
 import { LuigiComponent } from './luigi/luigi.component';
 import { CallbackComponent } from './callback/callback.component';
@@ -11,11 +14,16 @@ import { PortalComponent } from './portal.component';
 import {
   StaticSettingsConfigService,
   StaticSettingsConfigServiceImpl,
-} from './services/luigi-config/static-settings-config.service';
+  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>;
 }
 
 @NgModule({
@@ -30,6 +38,10 @@ 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],
@@ -51,6 +63,12 @@ export class PortalModule {
             options.staticSettingsConfigService ||
             StaticSettingsConfigServiceImpl,
         },
+        {
+          provide: LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
+          useClass:
+            options.communicationConfigService ||
+            CommunicationConfigServiceImpl,
+        },
       ],
       imports: [
         PortalRoutingModule,

src/lib/services/index.ts

@@ -1,3 +1,5 @@
 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';

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

@@ -0,0 +1,23 @@
+import {
+  CommunicationConfigService,
+  CommunicationConfigServiceImpl,
+} from './communication-config.service';
+
+describe('CommunicationConfigServiceImpl', () => {
+  let service: CommunicationConfigService;
+
+  beforeEach(() => {
+    service = new CommunicationConfigServiceImpl();
+  });
+
+  it('should be created', () => {
+    expect(service).toBeTruthy();
+  });
+
+  describe('getCommunicationConfig', () => {
+    it('should return undefined', () => {
+      const result = service.getCommunicationConfig();
+      expect(result).toBeUndefined();
+    });
+  });
+});

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

@@ -0,0 +1,15 @@
+export interface MessagesListeners {
+  customMessagesListeners: Record<string, any>;
+}
+
+export interface CommunicationConfigService {
+  getCommunicationConfig(): MessagesListeners;
+}
+
+export class CommunicationConfigServiceImpl
+  implements CommunicationConfigService
+{
+  getCommunicationConfig(): MessagesListeners {
+    return undefined;
+  }
+}

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

@@ -1,3 +1,4 @@
+import { CommunicationConfigService } from './communication-config.service';
 import { LuigiConfigService } from './luigi-config.service';
 import { EnvConfigService } from '../env-config.service';
 import { AuthConfigService } from './auth-config.service';
@@ -9,6 +10,7 @@ describe('LuigiConfigService', () => {
   let envConfigServiceMock: jest.Mocked<EnvConfigService>;
   let authConfigServiceMock: jest.Mocked<AuthConfigService>;
   let staticSettingsConfigServiceMock: jest.Mocked<StaticSettingsConfigService>;
+  let communicationConfigServiceMock: jest.Mocked<CommunicationConfigService>;
 
   beforeEach(() => {
     envConfigServiceMock = {
@@ -23,10 +25,15 @@ describe('LuigiConfigService', () => {
       getInitialStaticSettingsConfig: jest.fn(),
     } as any;
 
+    communicationConfigServiceMock = {
+      getCommunicationConfig: jest.fn(),
+    } as any;
+
     service = new LuigiConfigService(
       envConfigServiceMock,
       authConfigServiceMock,
-      staticSettingsConfigServiceMock
+      staticSettingsConfigServiceMock,
+      communicationConfigServiceMock
     );
   });
 
@@ -49,11 +56,18 @@ describe('LuigiConfigService', () => {
         filed: 'filed',
       };
 
+      const mockCommunicationConfig = {
+        customMessagesListeners: { '43545': () => {} },
+      };
+
       envConfigServiceMock.getEnvConfig.mockResolvedValue(mockEnvConfig);
       authConfigServiceMock.getAuthConfig.mockReturnValue(mockAuthConfig);
       staticSettingsConfigServiceMock.getInitialStaticSettingsConfig.mockReturnValue(
         mockStaticSettings
       );
+      communicationConfigServiceMock.getCommunicationConfig.mockReturnValue(
+        mockCommunicationConfig
+      );
 
       const config = await service.getLuigiConfiguration();
 
@@ -70,6 +84,7 @@ describe('LuigiConfigService', () => {
         auth: mockAuthConfig,
         routing: expect.any(Object),
         settings: mockStaticSettings,
+        communication: mockCommunicationConfig,
       });
 
       // Check routing config
@@ -83,9 +98,9 @@ describe('LuigiConfigService', () => {
     });
   });
 
-  describe('getRoutingConfig', () => {
+  describe('getInitialRoutingConfig', () => {
     it('should return the correct routing configuration', () => {
-      const routingConfig = (service as any).getRoutingConfig();
+      const routingConfig = (service as any).getInitialRoutingConfig();
 
       expect(routingConfig).toEqual({
         useHashRouting: false,

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

@@ -1,8 +1,12 @@
 import { Inject, Injectable } from '@angular/core';
-import { LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN } from '../../injection-tokens';
+import {
+  LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
+  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';
 
 @Injectable({
@@ -13,7 +17,9 @@ export class LuigiConfigService {
     private envConfigService: EnvConfigService,
     private authConfigService: AuthConfigService,
     @Inject(LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN)
-    private staticSettingsConfigService: StaticSettingsConfigService
+    private staticSettingsConfigService: StaticSettingsConfigService,
+    @Inject(LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN)
+    private communicationConfigService: CommunicationConfigService
   ) {}
 
   public async getLuigiConfiguration() {
@@ -24,13 +30,14 @@ export class LuigiConfigService {
         envConfig.oauthServerUrl,
         envConfig.clientId
       ),
-      routing: this.getRoutingConfig() as any,
+      routing: this.getInitialRoutingConfig(),
+      communication: this.communicationConfigService.getCommunicationConfig(),
       settings:
         this.staticSettingsConfigService.getInitialStaticSettingsConfig(),
     };
   }
 
-  private getRoutingConfig() {
+  private getInitialRoutingConfig() {
     return {
       useHashRouting: false,
       showModalPathInUrl: false,