Add support for user avatar configuration via USER_AVATAR_URL (#320)

- Improve validation configuration handling.

---------

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

Author: gkrajniak

README.md

@@ -35,19 +35,20 @@ The portal can run without any authentication infrastructure. Authentication con
 | TOKEN*URL*${idp}                        | The URL for the authentication token service provider specific to the idp name. This URL is used for retrieveing an auth tokens.                                                               |
 | OIDC*CLIENT_ID*${idp}                   | Client ID for the OpenID Connect (OIDC) configuration. The Client ID is used to identify the application to the OIDC provider (e.g., an authorization server).                                 |
 | OIDC*CLIENT_SECRET*${idp}               | Client Secret for the OIDC configuration. The Client Secret is a confidential value known only to the application and the OIDC provider, used to authenticate the application to the provider. |
-| CONTENT_CONFIGURATION_VALIDATOR_API_URL | Endpoint URL for custom content configuration validation. Endpoint returns useful error message when configuration is invalid.                                                                 |
 
 - **Optional**
 
-| Property name           | Description                                                                                                                                                                                                |
-| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| HEALTH_CHECK_INTERVAL   | The interval in _milliseconds_ at which the application performs health checks to ensure its components are functioning correctly. Default 2000 ms.                                                        |
-| LOGOUT_REDIRECT_URL     | The url to redirect user after logout action, by default _/logout_.                                                                                                                                        |
-| ENVIRONMENT             | This property indicates the environment in which the application is running, _local_ indicates development environment.                                                                                    |
-| DEVELOPMENT_INSTANCE    | This property indicates if the portal runs in development mode.                                                                                                                                            |
-| FRONTEND_PORT           | Set the port number on which the frontend of the application will run.                                                                                                               |
-| VALID_WEBCOMPONENT_URLS | To enable CORS Web component Loading: basically you need to add external domains where the Web Components are hosted; `".?"` in this examle, we are sepcify that we can load Web Components from everyhere. |
-| FEATURE_TOGGLES         | Comma separated values of features following the convention `featureName=boolean`. Boolean value indicates is the feature is on/off (true/false)                                                           |
+| Property name                           | Description                                                                                                                                                                                                            |
+|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| CONTENT_CONFIGURATION_VALIDATOR_API_URL | Endpoint URL for custom content configuration validation. Endpoint returns useful error message when configuration is invalid.                                                                                         |
+| HEALTH_CHECK_INTERVAL                   | The interval in _milliseconds_ at which the application performs health checks to ensure its components are functioning correctly. Default 2000 ms.                                                                    |
+| LOGOUT_REDIRECT_URL                     | The url to redirect user after logout action, by default _/logout_.                                                                                                                                                    |
+| ENVIRONMENT                             | This property indicates the environment in which the application is running, _local_ indicates development environment.                                                                                                |
+| DEVELOPMENT_INSTANCE                    | This property indicates if the portal runs in development mode.                                                                                                                                                        |
+| FRONTEND_PORT                           | Set the port number on which the frontend of the application will run.                                                                                                                                                 |
+| VALID_WEBCOMPONENT_URLS                 | To enable CORS Web component Loading: basically you need to add external domains where the Web Components are hosted; `".?"` in this examle, we are sepcify that we can load Web Components from everywhere.           |
+| FEATURE_TOGGLES                         | Comma separated values of features following the convention `featureName=boolean`. Boolean value indicates is the feature is on/off (true/false)                                                                       |
+| USER_AVATAR_URL                         | Url that indicates where to find a user avatar to be displayed in the application along with the user information. Should contain a user id placeholder ${userId} which will be automatically replaced with the value. |
 
 #### Full configuration (with authentication)
 
@@ -71,6 +72,7 @@ DEVELOPMENT_INSTANCE=true
 ENVIRONMENT='local'
 VALID_WEBCOMPONENT_URLS=".?"
 FEATURE_TOGGLES="foo=true,boo=false"
+USER_AVATAR_URL=https://example.com/avatar/${userId}
 ```
 
 ## Consuming the library

integration-tests/localnodes.integration-spec.ts

@@ -101,6 +101,8 @@ describe('LocalnodesController', () => {
 
     it('should call the getLuigiData method on valid params', async () => {
       const resultingNodes: LuigiNode[] = [];
+      process.env.CONTENT_CONFIGURATION_VALIDATOR_API_URL =
+        'http://localhost:8080';
 
       const validateContentConfiguration = jest
         .spyOn(

src/env/env-variables.service.ts

@@ -43,6 +43,7 @@ export class EnvVariablesServiceImpl implements EnvVariablesService {
       isLocal,
       developmentInstance,
       uiOptions,
+      userAvatarUrl,
     } = this.envService.getEnv();
     return {
       idpName,
@@ -56,6 +57,7 @@ export class EnvVariablesServiceImpl implements EnvVariablesService {
       isLocal,
       developmentInstance,
       uiOptions,
+      userAvatarUrl,
     };
   }
 }

src/env/env.service.ts

@@ -8,6 +8,7 @@ export interface EnvVariables extends Record<string, any> {
   logoutRedirectUrl?: string;
   healthCheckInterval?: number;
   isLocal?: boolean;
+  userAvatarUrl?: string;
   developmentInstance?: boolean;
   validWebcomponentUrls?: string[];
   uiOptions?: string[];
@@ -21,6 +22,7 @@ export class EnvService {
     return {
       idpNames: this.getIdpNames(),
       healthCheckInterval: parseInt(process.env.HEALTH_CHECK_INTERVAL, 10),
+      userAvatarUrl: process.env.USER_AVATAR_URL || '',
       logoutRedirectUrl: process.env.LOGOUT_REDIRECT_URL || '/logout',
       isLocal: process.env.ENVIRONMENT === 'local',
       developmentInstance: process.env.DEVELOPMENT_INSTANCE === 'true',

src/local-nodes/local-nodes.controller.spec.ts

@@ -5,15 +5,14 @@ import {
   IntentResolveService,
   LuigiNode,
   ValidationResult,
-} from '../config';
-import { ConfigTransferNodeService } from '../config/luigi/luigi-data/config-transfer-node.service';
-import { NodeExtendedDataService } from '../config/luigi/luigi-data/node-extended-data.service';
-import { TextsTranslateService } from '../config/luigi/luigi-data/texts-translate.service';
+} from '../config/index.js';
+import { ConfigTransferNodeService } from '../config/luigi/luigi-data/config-transfer-node.service.js';
+import { NodeExtendedDataService } from '../config/luigi/luigi-data/node-extended-data.service.js';
+import { TextsTranslateService } from '../config/luigi/luigi-data/texts-translate.service.js';
 import { ConfigDto, LocalNodesController } from './local-nodes.controller.js';
 import { HttpModule } from '@nestjs/axios';
 import { HttpException, HttpStatus, Logger } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
-import { AxiosResponse } from 'axios';
 import type { Request, Response } from 'express';
 import { mock } from 'jest-mock-extended';
 
@@ -135,6 +134,7 @@ describe('LocalNodesController', () => {
 
     it('should return HttpException when local nodes validator throws error', async () => {
       //Arrange
+      process.env.CONTENT_CONFIGURATION_VALIDATOR_API_URL = 'http://localhost';
       const validationResult: ValidationResult = {
         url: 'http://localhost:8080',
         validationErrors: [

src/local-nodes/local-nodes.controller.ts

@@ -46,19 +46,23 @@ export class LocalNodesController {
     @Body() config: ConfigDto,
     @Res({ passthrough: true }) response: ExpressResponse,
   ): Promise<TransformResult> {
-    const validationResults =
-      await this.contentConfigurationValidatorService.validateContentConfigurations(
-        config.contentConfigurations,
-      );
+    const ccValidatorApiUrl =
+      process.env.CONTENT_CONFIGURATION_VALIDATOR_API_URL;
+    if (ccValidatorApiUrl) {
+      const validationResults =
+        await this.contentConfigurationValidatorService.validateContentConfigurations(
+          config.contentConfigurations,
+        );
 
-    if (
-      validationResults.some(
-        (validationResult) =>
-          validationResult.validationErrors &&
-          validationResult.validationErrors.length,
-      )
-    ) {
-      return { errors: validationResults };
+      if (
+        validationResults.some(
+          (validationResult) =>
+            validationResult.validationErrors &&
+            validationResult.validationErrors.length,
+        )
+      ) {
+        return { errors: validationResults };
+      }
     }
 
     try {