BREAKING-CHANGE: the frameContext to portalContext for PortalConfig #25

- removing tenant id from the library
- changing the frameContext to portalContext for PortalConfig
- optimize some imports

Co-authored-by: Grzegorz Krajniak <[email protected]>

Author: gkrajniak

integration-tests/config.integration-spec.ts

@@ -3,16 +3,14 @@ import { mock } from 'jest-mock-extended';
 import { Test, TestingModule } from '@nestjs/testing';
 import request from 'supertest';
 import { INestApplication, ValidationPipe } from '@nestjs/common';
-import { LuigiConfigNodesService } from '../src/config/luigi/luigi-config-nodes/luigi-config-nodes.service';
-import { TenantService } from '../src/auth/tenant.service';
-import { HeaderParserService } from '../src/services/header-parser.service';
-import { FeatureTogglesProvider } from '../src/config/context/feature-toggles-provider';
 import {
+  LuigiConfigNodesService,
+  HeaderParserService,
+  FeatureTogglesProvider,
+  ServiceProvider,
   FEATURE_TOGGLES_INJECTION_TOKEN,
   PortalModule,
-  TENANT_PROVIDER_INJECTION_TOKEN,
 } from '../src';
-import { ServiceProvider } from '../src/config/model/luigi.node';
 
 const MockEntityProvider = 'MockEntityProvider';
 const entityContext = { abc: 'def' };
@@ -24,7 +22,6 @@ describe('ConfigController', () => {
   let nodesService: LuigiConfigNodesService;
   let getEntityContextMock: jest.Mock;
   let requestMock: Request;
-  let tenantProvider: TenantService;
   let headerParserService: HeaderParserService;
   let featureTogglesProvider: FeatureTogglesProvider;
   const mockTenant = '01emp2m3v3batersxj73qhm5zq';
@@ -54,16 +51,11 @@ describe('ConfigController', () => {
     featureTogglesProvider = module.get<FeatureTogglesProvider>(
       FEATURE_TOGGLES_INJECTION_TOKEN
     );
-    tenantProvider = module.get<TenantService>(TENANT_PROVIDER_INJECTION_TOKEN);
 
     jest
       .spyOn(featureTogglesProvider, 'getFeatureToggles')
       .mockResolvedValue({});
 
-    jest
-      .spyOn(tenantProvider, 'provideTenant')
-      .mockReturnValue(Promise.resolve(mockTenant));
-
     jest
       .spyOn(headerParserService, 'extractBearerToken')
       .mockReturnValue(token);

package-lock.json

@@ -15,7 +15,7 @@
   "prettier": "@openmfp/config-prettier",
   "scripts": {
     "build": "nest build",
-    "build:watch": "mkdir dist && nodemon --ignore dist --ext js,yml,yaml,ts,html,css,scss,json,md --exec \"rimraf dist && npm run build && yalc publish --push --sig\"",
+    "build:watch": "mkdirp dist && nodemon --ignore dist --ext js,yml,yaml,ts,html,css,scss,json,md --exec \"rimraf dist && npm run build && yalc publish --push --sig\"",
     "lint": "eslint \"./**/*.ts\"",
     "lint:fix": "eslint \"./**/*.ts\" --fix",
     "test": "npm run test:unit && npm run test:integration",
@@ -61,6 +61,7 @@
     "jest": "29.7.0",
     "jest-junit": "16.0.0",
     "jest-mock-extended": "3.0.5",
+    "mkdirp": "^3.0.1",
     "nock": "13.5.4",
     "nodemon": "^3.1.4",
     "prettier": "^3.2.0",

package.json

@@ -3,4 +3,3 @@ export { AuthController } from './auth.controller';
 export * from './auth.callback';
 export { AuthTokenService, AuthTokenData } from './auth-token.service';
 export { AuthCallback } from './auth.callback';
-export { TenantService, EmptyTenantService } from './tenant.service';

src/auth/index.ts

@@ -4,14 +4,12 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { ConfigController } from './config.controller';
 import { PortalModule } from '../portal.module';
 import { LuigiConfigNodesService } from './luigi/luigi-config-nodes/luigi-config-nodes.service';
-import { TenantService } from '../auth/tenant.service';
 import {
   FEATURE_TOGGLES_INJECTION_TOKEN,
   PORTAL_CONTEXT_INJECTION_TOKEN,
-  TENANT_PROVIDER_INJECTION_TOKEN,
 } from '../injection-tokens';
 import { FeatureTogglesProvider } from './context/feature-toggles-provider';
-import { HeaderParserService } from '../services/header-parser.service';
+import { HeaderParserService } from '../services';
 import { ServiceProvider } from './model/luigi.node';
 import { PortalContextProvider } from './context/portal-context-provider';
 import {
@@ -31,8 +29,7 @@ describe('ConfigController', () => {
   let getEntityContextMock: jest.Mock;
   let requestMock: Request;
   let responseMock: Response;
-  let tenantProvider: TenantService;
-  let frameContextProvider: PortalContextProvider;
+  let portalContextProvider: PortalContextProvider;
   let headerParserService: HeaderParserService;
   let featureTogglesProvider: FeatureTogglesProvider;
   let entityContextProviders: EntityContextProviders;
@@ -65,19 +62,14 @@ describe('ConfigController', () => {
     featureTogglesProvider = module.get<FeatureTogglesProvider>(
       FEATURE_TOGGLES_INJECTION_TOKEN
     );
-    tenantProvider = module.get<TenantService>(TENANT_PROVIDER_INJECTION_TOKEN);
-    frameContextProvider = module.get<PortalContextProvider>(
+    portalContextProvider = module.get<PortalContextProvider>(
       PORTAL_CONTEXT_INJECTION_TOKEN
     );
 
     jest
       .spyOn(featureTogglesProvider, 'getFeatureToggles')
       .mockResolvedValue({});
 
-    jest
-      .spyOn(tenantProvider, 'provideTenant')
-      .mockReturnValue(Promise.resolve(mockTenant));
-
     jest
       .spyOn(headerParserService, 'extractBearerToken')
       .mockReturnValue(token);
@@ -106,12 +98,10 @@ describe('ConfigController', () => {
       );
 
       expect(config.providers).toBe(resultingNodes);
-      expect(getNodesMock).toHaveBeenCalledWith(token, [], acceptLanguage, {
-        tenant: mockTenant,
-      });
+      expect(getNodesMock).toHaveBeenCalledWith(token, [], acceptLanguage);
     });
 
-    it('should handle frameContextProvider error', async () => {
+    it('should handle portalContextProvider error', async () => {
       // Arrange
       const error = new Error('this is a test error');
 
@@ -124,7 +114,7 @@ describe('ConfigController', () => {
         );
 
       jest
-        .spyOn(frameContextProvider, 'getContextValues')
+        .spyOn(portalContextProvider, 'getContextValues')
         .mockRejectedValue(error);
 
       // Act
@@ -154,7 +144,7 @@ describe('ConfigController', () => {
         );
 
       jest
-        .spyOn(frameContextProvider, 'getContextValues')
+        .spyOn(portalContextProvider, 'getContextValues')
         .mockImplementation(
           () => new Promise((resolve) => setTimeout(resolve, 0))
         );
@@ -169,45 +159,6 @@ describe('ConfigController', () => {
       // Assert
       await expect(result).rejects.toEqual(error);
     });
-
-    it('should handle tenantProvider error', async () => {
-      // Arrange
-      const forbiddenException = new ForbiddenException('you shall not pass');
-
-      jest.spyOn(luigiConfigNodesService, 'getNodes').mockResolvedValue([]);
-
-      jest
-        .spyOn(tenantProvider, 'provideTenant')
-        .mockImplementation(
-          () =>
-            new Promise((resolve, reject) =>
-              setTimeout(reject.bind(reject, forbiddenException), 0)
-            )
-        );
-
-      jest
-        .spyOn(featureTogglesProvider, 'getFeatureToggles')
-        .mockImplementation(
-          () => new Promise((resolve) => setTimeout(resolve, 0))
-        );
-
-      jest
-        .spyOn(frameContextProvider, 'getContextValues')
-        .mockImplementation(
-          () => new Promise((resolve) => setTimeout(resolve, 0))
-        );
-
-      // Act
-      const result = controller.getConfig(
-        requestMock,
-        responseMock,
-        acceptLanguage
-      );
-
-      // Assert
-      await expect(result).resolves.toBeUndefined();
-      expect(responseMock.status).toHaveBeenCalledWith(HttpStatus.FORBIDDEN);
-    });
   });
 
   describe('getEntityConfig', () => {

src/auth/tenant.service.spec.ts

@@ -13,14 +13,12 @@ import {
 } from '@nestjs/common';
 import { LuigiConfigNodesService } from './luigi/luigi-config-nodes/luigi-config-nodes.service';
 import { Request, Response } from 'express';
-import { HeaderParserService } from '../services/header-parser.service';
+import { HeaderParserService } from '../services';
 import {
   ENTITY_CONTEXT_INJECTION_TOKEN,
   FEATURE_TOGGLES_INJECTION_TOKEN,
   PORTAL_CONTEXT_INJECTION_TOKEN,
-  TENANT_PROVIDER_INJECTION_TOKEN,
 } from '../injection-tokens';
-import { TenantService } from '../auth/tenant.service';
 import { PortalContextProvider } from './context/portal-context-provider';
 import { EntityParams } from './model/entity';
 import { FeatureTogglesProvider } from './context/feature-toggles-provider';
@@ -40,8 +38,6 @@ export class ConfigController {
     private logger: Logger,
     private luigiConfigNodesService: LuigiConfigNodesService,
     private headerParser: HeaderParserService,
-    @Inject(TENANT_PROVIDER_INJECTION_TOKEN)
-    private tenantProvider: TenantService,
     @Inject(PORTAL_CONTEXT_INJECTION_TOKEN)
     private portalContextProvider: PortalContextProvider,
     @Inject(ENTITY_CONTEXT_INJECTION_TOKEN)
@@ -61,13 +57,12 @@ export class ConfigController {
     @Res({ passthrough: true }) response: Response,
     @Headers('Accept-language') acceptLanguage: string
   ): Promise<PortalConfig> {
-    const providersAndTenantPromise = this.getProvidersAndTenant(
-      request,
-      acceptLanguage
-    ).catch((e: Error) => {
-      this.logger.error(e);
-      return e;
-    });
+    const providersPromise = this.getProviders(request, acceptLanguage).catch(
+      (e: Error) => {
+        this.logger.error(e);
+        return e;
+      }
+    );
     const featureTogglePromise = this.featureTogglesProvider
       .getFeatureToggles()
       .catch((e: Error) => {
@@ -76,7 +71,7 @@ export class ConfigController {
       });
 
     const portalContextPromise = this.portalContextProvider
-      .getContextValues(request, response, providersAndTenantPromise)
+      .getContextValues(request, response, providersPromise)
       .catch((e: Error) => {
         this.logger.error(e);
         return e;
@@ -86,17 +81,14 @@ export class ConfigController {
       const featureToggles = ConfigController.getOrThrow(
         await featureTogglePromise
       );
-      const frameContext = ConfigController.getOrThrow(
+      const portalContext = ConfigController.getOrThrow(
         await portalContextPromise
       );
-      const { tenantId, providers } = ConfigController.getOrThrow(
-        await providersAndTenantPromise
-      );
+      const providers = ConfigController.getOrThrow(await providersPromise);
 
       return {
         providers,
-        tenantId,
-        frameContext,
+        portalContext,
         featureToggles,
       };
     } catch (e) {
@@ -108,20 +100,18 @@ export class ConfigController {
     }
   }
 
-  private async getProvidersAndTenant(
+  private async getProviders(
     request: Request,
     acceptLanguage: string
-  ) {
+  ): Promise<ServiceProvider[]> {
     const token = this.headerParser.extractBearerToken(request);
-    const tenantId = await this.tenantProvider.provideTenant(request);
 
     const providers = await this.luigiConfigNodesService.getNodes(
       token,
       [],
-      acceptLanguage,
-      { tenant: tenantId }
+      acceptLanguage
     );
-    return { tenantId, providers };
+    return providers;
   }
 
   @Get(':entity')

src/auth/tenant.service.ts

@@ -1,14 +1,10 @@
 import { Request, Response } from 'express';
 import { ServiceProvider } from '../model/luigi.node';
 
-export interface ProvidersResult {
-  providers: ServiceProvider[];
-}
-
 export interface PortalContextProvider {
   getContextValues(
     request: Request,
     response: Response,
-    providersPromise: Promise<ProvidersResult | Error>
+    providersPromise: Promise<ServiceProvider[] | Error>
   ): Promise<Record<string, any>>;
 }