feat: luigi lifecycle hooks config service implementation

gkrajniak · gkrajniak · commit f7110336c109 · 2024-08-09T15:19:41.000+02:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -41,6 +41,7 @@
     "@angular-eslint/template-parser": "17.5.2",
     "@angular/cli": "^17.3.8",
     "@angular/compiler-cli": "^17.3.0",
+    "@angular/localize": "17.3.11",
     "@briebug/jest-schematic": "^6.0.0",
     "@luigi-project/client": "2.14.1",
     "@luigi-project/client-support-angular": "2.14.1",
diff --git a/src/lib/injection-tokens.ts b/src/lib/injection-tokens.ts
@@ -1,6 +1,10 @@
 export const LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN =
   'OPENMFP_LUIGI_STATIC_SETTINGS_CONFIG_SERVICE';
 export const LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN =
-  'OPENMFP_LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN';
+  'OPENMFP_LUIGI_CUSTOM_MESSAGE_LISTENERS';
+export const LUIGI_USER_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN =
+  'OPENMFP_LUIGI_USER_SETTINGS_CONFIG_SERVICE';
+export const LUIGI_GLOBAL_SEARCH_CONFIG_SERVICE_INJECTION_TOKEN =
+  'OPENMFP_LUIGI_GLOBAL_SEARCH_CONFIG_SERVICE';
 export const LOCAL_NODES_SERVICE_INJECTION_TOKEN =
   'OPENMFP_LOCAL_NODES_SERVICE_INJECTION_TOKEN';
diff --git a/src/lib/portal.module.ts b/src/lib/portal.module.ts
@@ -5,7 +5,9 @@ import { RouterOutlet } from '@angular/router';
 import {
   LOCAL_NODES_SERVICE_INJECTION_TOKEN,
   LUIGI_CUSTOM_MESSAGE_LISTENERS_INJECTION_TOKEN,
+  LUIGI_GLOBAL_SEARCH_CONFIG_SERVICE_INJECTION_TOKEN,
   LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
+  LUIGI_USER_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
 } from './injection-tokens';
 import { LogoutComponent } from './logout/logout.component';
 import { LuigiComponent } from './luigi/luigi.component';
@@ -19,6 +21,14 @@ import {
   LocalNodesService,
   NoopLocalNodesService,
 } from './services';
+import {
+  NoopUserSettingsConfigService,
+  UserSettingsConfigService,
+} from './services/luigi-config/user-settings-config.service';
+import {
+  GlobalSearchConfigService,
+  NoopGlobalSearchConfigService,
+} from './services/luigi-config/global-search-config.service';
 
 export interface PortalModuleOptions {
   /** Service containing and providing the luigi settings configuration **/
@@ -29,6 +39,12 @@ export interface PortalModuleOptions {
 
   /** Service providing local nodes merging services **/
   localNodesService?: Type<LocalNodesService>;
+
+  /** Service providing user setting specific configuration **/
+  userSettingsConfigService: Type<UserSettingsConfigService>;
+
+  /** Service providing global search configuration **/
+  globalSearchConfigService: Type<GlobalSearchConfigService>;
 }
 
 @NgModule({
@@ -43,6 +59,14 @@ export interface PortalModuleOptions {
       provide: LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
       useClass: StaticSettingsConfigServiceImpl,
     },
+    {
+      provide: LUIGI_USER_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
+      useClass: NoopUserSettingsConfigService,
+    },
+    {
+      provide: LUIGI_GLOBAL_SEARCH_CONFIG_SERVICE_INJECTION_TOKEN,
+      useClass: NoopGlobalSearchConfigService,
+    },
     {
       provide: LOCAL_NODES_SERVICE_INJECTION_TOKEN,
       useClass: NoopLocalNodesService,
@@ -81,6 +105,16 @@ export class PortalModule {
           provide: LOCAL_NODES_SERVICE_INJECTION_TOKEN,
           useClass: options.localNodesService || NoopLocalNodesService,
         },
+        {
+          provide: LUIGI_USER_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
+          useClass:
+            options.userSettingsConfigService || NoopUserSettingsConfigService,
+        },
+        {
+          provide: LUIGI_GLOBAL_SEARCH_CONFIG_SERVICE_INJECTION_TOKEN,
+          useClass:
+            options.globalSearchConfigService || NoopGlobalSearchConfigService,
+        },
       ],
       imports: [
         PortalRoutingModule,
diff --git a/src/lib/services/luigi-config/global-search-config.service.ts b/src/lib/services/luigi-config/global-search-config.service.ts
@@ -0,0 +1,11 @@
+export interface GlobalSearchConfigService {
+  getGlobalSearchConfig(): any;
+}
+
+export class NoopGlobalSearchConfigService
+  implements GlobalSearchConfigService
+{
+  getGlobalSearchConfig() {
+    return undefined;
+  }
+}
diff --git a/src/lib/services/luigi-config/lifecycle-hooks-config.service.ts b/src/lib/services/luigi-config/lifecycle-hooks-config.service.ts
@@ -0,0 +1,84 @@
+import { Inject, Injectable } from '@angular/core';
+import { $localize } from '@angular/localize/init';
+import { I18nService } from '../i18n.service';
+import { LuigiCoreService } from '../luigi-core.service';
+import { LuigiNodesService } from '../luigi-nodes/luigi-nodes.service';
+import { GlobalSearchConfigService } from './global-search-config.service';
+import { RoutingConfigService } from './routing-config.service';
+import { StaticSettingsConfigService } from './static-settings-config.service';
+import { UserSettingsConfigService } from './user-settings-config.service';
+import {
+  LUIGI_GLOBAL_SEARCH_CONFIG_SERVICE_INJECTION_TOKEN,
+  LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
+  LUIGI_USER_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
+} from '../../injection-tokens';
+import { LuigiNode } from '../../models/luigi';
+import { ClientEnvironment } from '../../models/env';
+
+@Injectable({ providedIn: 'root' })
+export class LifecycleHooksConfigService {
+  constructor(
+    private i18nService: I18nService,
+    private luigiNodesService: LuigiNodesService,
+    private luigiCoreService: LuigiCoreService,
+    private routingConfigService: RoutingConfigService,
+    @Inject(LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN)
+    private staticSettingsConfigService: StaticSettingsConfigService,
+    @Inject(LUIGI_USER_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN)
+    private userSettingsConfigService: UserSettingsConfigService,
+    @Inject(LUIGI_GLOBAL_SEARCH_CONFIG_SERVICE_INJECTION_TOKEN)
+    private globalSearchConfigService: GlobalSearchConfigService
+  ) {}
+
+  getLifecycleHooksConfig(envConfig: ClientEnvironment) {
+    return {
+      luigiAfterInit: async () => {
+        this.i18nService.afterInit();
+
+        let childrenByEntity: Record<string, LuigiNode[]>;
+
+        try {
+          childrenByEntity =
+            await this.luigiNodesService.retrieveChildrenByEntity();
+        } catch (e) {
+          console.error(`Error retrieving Luigi navigation nodes ${e}`);
+          this.openErrorDialog();
+        }
+
+        const config = {
+          ...this.luigiCoreService.getConfig(),
+          lifecycleHooks: {},
+          settings:
+            await this.staticSettingsConfigService.getStaticSettingsConfig(),
+          routing: this.routingConfigService.getRoutingConfig(),
+          userSettings:
+            await this.userSettingsConfigService.getUserSettings(
+              childrenByEntity
+            ),
+          globalSearch: this.globalSearchConfigService.getGlobalSearchConfig(),
+        };
+
+        this.luigiCoreService.ux().hideAppLoadingIndicator();
+        this.luigiCoreService.setConfig(config);
+        if (this.luigiCoreService.isFeatureToggleActive('btpLayout')) {
+          this.luigiCoreService.resetLuigi();
+        }
+      },
+    };
+  }
+
+  private openErrorDialog() {
+    const appTitle =
+      this.staticSettingsConfigService.getInitialStaticSettingsConfig()[
+        'header'
+      ].title;
+    this.luigiCoreService
+      .showAlert({
+        text: $localize`There was an error loading the ${appTitle}`,
+        type: 'error',
+      })
+      .then(() => {
+        location.reload();
+      });
+  }
+}
diff --git a/src/lib/services/luigi-config/luigi-config.service.spec.ts b/src/lib/services/luigi-config/luigi-config.service.spec.ts
@@ -5,6 +5,7 @@ import { ClientEnvironment } from '../../models/env';
 import { RoutingConfigService } from './routing-config.service';
 import { StaticSettingsConfigService } from './static-settings-config.service';
 import { CustomMessageListenersService } from './custom-message-listeners.service';
+import { LifecycleHooksConfigService } from './lifecycle-hooks-config.service';
 
 describe('LuigiConfigService', () => {
   let service: LuigiConfigService;
@@ -13,6 +14,7 @@ describe('LuigiConfigService', () => {
   let staticSettingsConfigServiceMock: jest.Mocked<StaticSettingsConfigService>;
   let customMessageListenersMock: jest.Mocked<CustomMessageListenersService>;
   let routingConfigServiceMock: jest.Mocked<RoutingConfigService>;
+  let lifecycleHooksConfigServiceMock: jest.Mocked<LifecycleHooksConfigService>;
 
   beforeEach(() => {
     envConfigServiceMock = {
@@ -36,11 +38,16 @@ describe('LuigiConfigService', () => {
       getRoutingConfig: jest.fn(),
     } as any;
 
+    lifecycleHooksConfigServiceMock = {
+      getLifecycleHooksConfig: jest.fn(),
+    } as any;
+
     service = new LuigiConfigService(
       envConfigServiceMock,
       authConfigServiceMock,
       customMessageListenersMock,
       routingConfigServiceMock,
+      lifecycleHooksConfigServiceMock,
       staticSettingsConfigServiceMock
     );
   });
@@ -69,6 +76,10 @@ describe('LuigiConfigService', () => {
         customMessagesListeners: { 'id-43545': () => {} },
       };
 
+      const mockLifecycleHooks = {
+        luigiAfterInit: null,
+      };
+
       const mockRoutingConfig = {
         useHashRouting: false,
         showModalPathInUrl: false,
@@ -78,12 +89,15 @@ describe('LuigiConfigService', () => {
 
       envConfigServiceMock.getEnvConfig.mockResolvedValue(mockEnvConfig);
       authConfigServiceMock.getAuthConfig.mockReturnValue(mockAuthConfig);
+      lifecycleHooksConfigServiceMock.getLifecycleHooksConfig.mockReturnValue(
+        mockLifecycleHooks
+      );
       staticSettingsConfigServiceMock.getInitialStaticSettingsConfig.mockReturnValue(
         mockStaticSettings
       );
-      jest
-        .spyOn(customMessageListenersMock, 'getMessageListeners')
-        .mockReturnValue(mockCommunicationConfig);
+      customMessageListenersMock.getMessageListeners.mockReturnValue(
+        mockCommunicationConfig
+      );
       routingConfigServiceMock.getInitialRoutingConfig.mockReturnValue(
         mockRoutingConfig
       );
@@ -106,6 +120,7 @@ describe('LuigiConfigService', () => {
         routing: mockRoutingConfig,
         settings: mockStaticSettings,
         communication: mockCommunicationConfig,
+        lifecycleHooks: mockLifecycleHooks,
       });
     });
   });
diff --git a/src/lib/services/luigi-config/luigi-config.service.ts b/src/lib/services/luigi-config/luigi-config.service.ts
@@ -6,6 +6,7 @@ import { EnvConfigService } from '../portal/env-config.service';
 import { RoutingConfigService } from './routing-config.service';
 import { StaticSettingsConfigService } from './static-settings-config.service';
 import { CustomMessageListenersService } from './custom-message-listeners.service';
+import { LifecycleHooksConfigService } from './lifecycle-hooks-config.service';
 
 @Injectable({
   providedIn: 'root',
@@ -16,6 +17,7 @@ export class LuigiConfigService {
     private authConfigService: AuthConfigService,
     private customMessageListenersService: CustomMessageListenersService,
     private routingConfigService: RoutingConfigService,
+    private lifecycleHooksConfigService: LifecycleHooksConfigService,
     @Inject(LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN)
     private staticSettingsConfigService: StaticSettingsConfigService
   ) {}
@@ -32,6 +34,8 @@ export class LuigiConfigService {
       communication: this.customMessageListenersService.getMessageListeners(),
       settings:
         this.staticSettingsConfigService.getInitialStaticSettingsConfig(),
+      lifecycleHooks:
+        this.lifecycleHooksConfigService.getLifecycleHooksConfig(envConfig),
     };
   }
 }
diff --git a/src/lib/services/luigi-config/static-settings-config.service.ts b/src/lib/services/luigi-config/static-settings-config.service.ts
@@ -1,5 +1,4 @@
 import { Injectable } from '@angular/core';
-import { LuigiCoreService } from '../luigi-core.service';
 
 export interface StaticSettingsConfigService {
   getInitialStaticSettingsConfig(): Record<string, any>;
diff --git a/src/lib/services/luigi-config/user-settings-config.service.ts b/src/lib/services/luigi-config/user-settings-config.service.ts
@@ -0,0 +1,13 @@
+import { LuigiNode } from '../../models/luigi';
+
+export interface UserSettingsConfigService {
+  getUserSettings(luigiNodes: Record<string, LuigiNode[]>): Promise<any>;
+}
+
+export class NoopUserSettingsConfigService
+  implements UserSettingsConfigService
+{
+  async getUserSettings(luigiNodes: Record<string, LuigiNode[]>): Promise<any> {
+    return undefined;
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`import { Injectable } from '@angular/core';`
`2`		`-import { LuigiCoreService } from '../luigi-core.service';`
`3`	`2`
`4`	`3`	`export interface StaticSettingsConfigService {`
`5`	`4`	`getInitialStaticSettingsConfig(): Record<string, any>;`