feat: luigi nodes service implementation

Author: gkrajniak

angular.json

@@ -45,6 +45,7 @@
   "cli": {
     "schematicCollections": [
       "@angular-eslint/schematics"
-    ]
+    ],
+    "analytics": false
   }
 }

src/lib/injection-tokens.ts

@@ -2,3 +2,5 @@ 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 LOCAL_NODES_SERVICE_INJECTION_TOKEN =
+  'OPENMFP_LOCAL_NODES_SERVICE_INJECTION_TOKEN';

src/lib/model/luigi.ts

@@ -0,0 +1,42 @@
+export interface EntityDefinition {
+  id: string;
+  dynamicFetchId?: string;
+  contextKey?: string;
+  useBack?: boolean;
+  label?: string;
+  pluralLabel?: string;
+  notFoundConfig?: {
+    entityListNavigationContext: string;
+    sapIllusSVG: string;
+  };
+}
+
+export interface LuigiStatusBadge {
+  label: string;
+  type: string;
+}
+
+export interface PortalLuigiNodeExtensions {
+  entityType?: string;
+  requiredPolicies?: string[];
+}
+
+export interface LuigiNodeCategory {
+  label: string;
+  collapsible?: boolean;
+  order?: number;
+  id?: string;
+  icon?: string;
+}
+
+export interface LuigiNodeContext extends Record<string, any> {
+  serviceProviderConfig?: any;
+}
+
+export interface LuigiNode extends PortalLuigiNodeExtensions {
+  pathSegment?: string;
+  label?: string;
+  category?: LuigiNodeCategory | string;
+  context?: LuigiNodeContext;
+  statusBadge?: LuigiStatusBadge;
+}

src/lib/model/env.ts renamed to src/lib/models/env.ts

@@ -4,6 +4,7 @@ export interface ServiceProvider {
   nodes: LuigiNode[];
   config: Record<string, string>;
   installationData?: Record<string, string>;
+  isMandatoryExtension?: boolean;
   creationTimestamp: string;
 }
 

src/lib/models/luigi.ts

@@ -3,6 +3,7 @@ import { HttpClientModule } from '@angular/common/http';
 import { BrowserModule } from '@angular/platform-browser';
 import { RouterOutlet } from '@angular/router';
 import {
+  LOCAL_NODES_SERVICE_INJECTION_TOKEN,
   LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
   LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
 } from './injection-tokens';
@@ -16,6 +17,8 @@ import {
   StaticSettingsConfigServiceImpl,
   CommunicationConfigService,
   CommunicationConfigServiceImpl,
+  LocalNodesService,
+  NoopLocalNodesService,
 } from './services';
 
 export interface PortalModuleOptions {
@@ -24,6 +27,9 @@ export interface PortalModuleOptions {
 
   /** Service containing and providing the luigi communication configuration **/
   communicationConfigService?: Type<CommunicationConfigService>;
+
+  /** Service containing and providing the luigi communication configuration **/
+  localNodesService?: Type<LocalNodesService>;
 }
 
 @NgModule({
@@ -42,6 +48,10 @@ export interface PortalModuleOptions {
       provide: LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
       useClass: CommunicationConfigServiceImpl,
     },
+    {
+      provide: LOCAL_NODES_SERVICE_INJECTION_TOKEN,
+      useClass: NoopLocalNodesService,
+    },
   ],
   imports: [PortalRoutingModule, BrowserModule, RouterOutlet, HttpClientModule],
   exports: [PortalComponent],
@@ -69,6 +79,10 @@ export class PortalModule {
             options.communicationConfigService ||
             CommunicationConfigServiceImpl,
         },
+        {
+          provide: LOCAL_NODES_SERVICE_INJECTION_TOKEN,
+          useClass: options.localNodesService || NoopLocalNodesService,
+        },
       ],
       imports: [
         PortalRoutingModule,

src/lib/model/portal-config.ts renamed to src/lib/models/portal.ts

@@ -3,3 +3,4 @@ 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-nodes/local-nodes.service';

src/lib/model/user.ts renamed to src/lib/models/user.ts

@@ -2,7 +2,7 @@ import { CommunicationConfigService } from './communication-config.service';
 import { LuigiConfigService } from './luigi-config.service';
 import { EnvConfigService } from '../portal/env-config.service';
 import { AuthConfigService } from './auth-config.service';
-import { ClientEnvironment } from '../../model/env';
+import { ClientEnvironment } from '../../models/env';
 import { RoutingConfigService } from './routing-config.service';
 import { StaticSettingsConfigService } from './static-settings-config.service';
 

src/lib/portal.module.ts

@@ -3,7 +3,7 @@ import {
   LUIGI_COMMUNICATION_CONFIG_SERVICE_INJECTION_TOKEN,
   LUIGI_STATIC_SETTINGS_CONFIG_SERVICE_INJECTION_TOKEN,
 } from '../../injection-tokens';
-import { ClientEnvironment } from '../../model/env';
+import { ClientEnvironment } from '../../models/env';
 import { AuthConfigService } from './auth-config.service';
 import { EnvConfigService } from '../portal/env-config.service';
 import { CommunicationConfigService } from './communication-config.service';

src/lib/services/index.ts

@@ -0,0 +1,34 @@
+import { NoopLocalNodesService } from './local-nodes.service';
+import { LuigiNode } from '../../models/luigi';
+
+describe('NoopLocalNodesService', () => {
+  let service: NoopLocalNodesService;
+
+  beforeEach(() => {
+    service = new NoopLocalNodesService();
+  });
+
+  describe('getLocalNodes', () => {
+    it('should return an empty array', async () => {
+      const localNodes = await service.getLocalNodes();
+      expect(localNodes).toEqual([]);
+    });
+  });
+
+  describe('replaceServerNodesWithLocalOnes', () => {
+    it('should return the original server nodes', async () => {
+      const serverNodes: LuigiNode[] = [
+        { label: 'Node 1', pathSegment: '/node1' },
+        { label: 'Node 2', pathSegment: '/node2' },
+      ];
+      const currentEntities = ['entity1', 'entity2'];
+
+      const replacedNodes = await service.replaceServerNodesWithLocalOnes(
+        serverNodes,
+        currentEntities
+      );
+
+      expect(replacedNodes).toEqual(serverNodes);
+    });
+  });
+});

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

@@ -0,0 +1,23 @@
+import { LuigiNode } from '../../models/luigi';
+
+export interface LocalNodesService {
+  replaceServerNodesWithLocalOnes(
+    serverLuigiNodes: LuigiNode[],
+    currentEntities: string[]
+  ): Promise<LuigiNode[]>;
+
+  getLocalNodes(): Promise<LuigiNode[]>;
+}
+
+export class NoopLocalNodesService implements LocalNodesService {
+  async getLocalNodes(): Promise<LuigiNode[]> {
+    return [];
+  }
+
+  async replaceServerNodesWithLocalOnes(
+    serverLuigiNodes: LuigiNode[],
+    currentEntities: string[]
+  ): Promise<LuigiNode[]> {
+    return serverLuigiNodes;
+  }
+}