[FEATURE] Afficher les bannières dynamiquement.

api/banner/scripts/add.js

@@ -0,0 +1,50 @@
+import { Script } from '../../src/shared/application/scripts/script.js';
+import { ScriptRunner } from '../../src/shared/application/scripts/script-runner.js';
+import { informationBannersStorage } from '../../src/shared/infrastructure/key-value-storages/index.js';
+
+export class AddInformationBanners extends Script {
+  constructor() {
+    super({
+      description: 'Add information banners data to Redis',
+      permanent: true,
+      options: {
+        target: {
+          type: 'string',
+          describe: 'application name we want to add information banners to',
+          required: true,
+          requiresArg: true,
+        },
+        severity: {
+          type: 'string',
+          describe: 'severity of the message',
+          choices: ['error', 'warning', 'information'],
+          required: true,
+          requiresArg: true,
+        },
+        message_fr: {
+          type: 'string',
+          describe: 'message content in French',
+          required: true,
+          requiresArg: true,
+        },
+        message_en: {
+          type: 'string',
+          describe: 'message content in English',
+          required: true,
+          requiresArg: true,
+        },
+      },
+    });
+  }
+
+  async handle({ options }) {
+    const { target, severity, message_fr, message_en } = options;
+    const banners = (await informationBannersStorage.get(target)) ?? [];
+
+    banners.push({ severity, message: `[fr]${message_fr}[/fr][en]${message_en}[/en]` });
+
+    await informationBannersStorage.save({ key: target, value: banners });
+  }
+}
+
+await ScriptRunner.execute(import.meta.url, AddInformationBanners);

api/banner/scripts/remove.js

@@ -0,0 +1,28 @@
+import { Script } from '../../src/shared/application/scripts/script.js';
+import { ScriptRunner } from '../../src/shared/application/scripts/script-runner.js';
+import { informationBannersStorage } from '../../src/shared/infrastructure/key-value-storages/index.js';
+
+export class RemoveInformationBanners extends Script {
+  constructor() {
+    super({
+      description: 'Remove information banners data from Redis',
+      permanent: true,
+      options: {
+        target: {
+          type: 'string',
+          describe: 'application name we want to remove information banners from',
+          required: true,
+          requiresArg: true,
+        },
+      },
+    });
+  }
+
+  async handle({ options }) {
+    const { target } = options;
+
+    await informationBannersStorage.delete(target);
+  }
+}
+
+await ScriptRunner.execute(import.meta.url, RemoveInformationBanners);

api/db/seeds/data/team-prescription/build-quests.js

@@ -2,7 +2,7 @@ import { ATTESTATIONS } from '../../../../src/profile/domain/constants.js';
 import { REWARD_TYPES } from '../../../../src/quest/domain/constants.js';
 import { COMPARISON } from '../../../../src/quest/domain/models/Quest.js';
 import { Assessment, CampaignParticipationStatuses, Membership } from '../../../../src/shared/domain/models/index.js';
-import { temporaryStorage } from '../../../../src/shared/infrastructure/temporary-storage/index.js';
+import { temporaryStorage } from '../../../../src/shared/infrastructure/key-value-storages/index.js';
 import {
   AEFE_TAG,
   FEATURE_ATTESTATIONS_MANAGEMENT_ID,

api/index.js

@@ -8,7 +8,7 @@ import { disconnect, prepareDatabaseConnection } from './db/knex-database-connec
 import { createServer } from './server.js';
 import { config } from './src/shared/config.js';
 import { learningContentCache } from './src/shared/infrastructure/caches/learning-content-cache.js';
-import { temporaryStorage } from './src/shared/infrastructure/temporary-storage/index.js';
+import { informationBannersStorage, temporaryStorage } from './src/shared/infrastructure/key-value-storages/index.js';
 import { logger } from './src/shared/infrastructure/utils/logger.js';
 import { redisMonitor } from './src/shared/infrastructure/utils/redis-monitor.js';
 
@@ -40,13 +40,15 @@ async function _exitOnSignal(signal) {
     logger.info('Stopping HAPI Oppsy server...');
     await server.oppsy.stop();
   }
-  logger.info('Closing connexions to database...');
+  logger.info('Closing connections to database...');
   await disconnect();
-  logger.info('Closing connexions to cache...');
+  logger.info('Closing connections to cache...');
   await learningContentCache.quit();
-  logger.info('Closing connexions to temporary storage...');
+  logger.info('Closing connections to temporary storage...');
   await temporaryStorage.quit();
-  logger.info('Closing connexions to redis monitor...');
+  logger.info('Closing connections to information banners storage...');
+  await informationBannersStorage.quit();
+  logger.info('Closing connections to redis monitor...');
   await redisMonitor.quit();
   logger.info('Exiting process...');
 }

api/package.json

@@ -127,6 +127,8 @@
   "scripts": {
     "clean": "rm -rf node_modules",
     "cache:refresh": "node scripts/refresh-cache",
+    "banner:add": "node banner/scripts/add.js",
+    "banner:remove": "node banner/scripts/remove.js",
     "datamart:create": "node scripts/datamart/create-datamart",
     "datamart:delete": "node scripts/datamart/drop-datamart",
     "datamart:new-migration": "npx knex --knexfile datamart/knexfile.js migrate:make --stub $PWD/db/template.js $migrationname",

api/scripts/create-organizations-with-tags-and-target-profiles.js

@@ -12,8 +12,8 @@ import * as targetProfileShareRepository from '../lib/infrastructure/repositorie
 import * as dataProtectionOfficerRepository from '../src/organizational-entities/infrastructure/repositories/data-protection-officer.repository.js';
 import * as organizationTagRepository from '../src/organizational-entities/infrastructure/repositories/organization-tag.repository.js';
 import { tagRepository } from '../src/organizational-entities/infrastructure/repositories/tag.repository.js';
+import { informationBannersStorage, temporaryStorage } from '../src/shared/infrastructure/key-value-storages/index.js';
 import * as organizationRepository from '../src/shared/infrastructure/repositories/organization-repository.js';
-import { temporaryStorage } from '../src/shared/infrastructure/temporary-storage/index.js';
 import { organizationInvitationRepository } from '../src/team/infrastructure/repositories/organization-invitation.repository.js';
 import { checkCsvHeader, parseCsvWithHeader } from './helpers/csvHelpers.js';
 
@@ -137,6 +137,7 @@ async function main() {
       // l'import de OidcIdentityProviders dans les validateurs démarre le service redis
       // il faut donc stopper le process pour que celui ci s'arrête, il suffit d'avoir l'import du storage pour y avoir accès
       temporaryStorage.quit();
+      informationBannersStorage.quit();
     }
   }
 })();

api/scripts/data-generation/generate-certif-cli.js

@@ -15,8 +15,11 @@ import { DatabaseBuilder } from '../../db/database-builder/database-builder.js';
 import { getNewSessionCode } from '../../src/certification/enrolment/domain/services/session-code-service.js';
 import { CampaignParticipationStatuses } from '../../src/shared/domain/models/index.js';
 import { learningContentCache } from '../../src/shared/infrastructure/caches/learning-content-cache.js';
+import {
+  informationBannersStorage,
+  temporaryStorage,
+} from '../../src/shared/infrastructure/key-value-storages/index.js';
 import * as skillRepository from '../../src/shared/infrastructure/repositories/skill-repository.js';
-import { temporaryStorage } from '../../src/shared/infrastructure/temporary-storage/index.js';
 import { logger } from '../../src/shared/infrastructure/utils/logger.js';
 import { PromiseUtils } from '../../src/shared/infrastructure/utils/promise-utils.js';
 import {
@@ -396,6 +399,7 @@ async function _disconnect() {
   logger.info('Closing connexions to cache...');
   await learningContentCache.quit();
   await temporaryStorage.quit();
+  await informationBannersStorage.quit();
   logger.info('Exiting process gracefully...');
 }
 

api/server.js

@@ -6,6 +6,7 @@ import { setupErrorHandling } from './config/server-setup-error-handling.js';
 import { knex } from './db/knex-database-connection.js';
 import { authentication } from './lib/infrastructure/authentication.js';
 import { routes } from './lib/routes.js';
+import { bannerRoutes } from './src/banner/routes.js';
 import {
   attachTargetProfileRoutes,
   complementaryCertificationRoutes,
@@ -243,6 +244,7 @@ const setupRoutesAndPlugins = async function (server) {
     ...certificationRoutes,
     ...prescriptionRoutes,
     ...parcoursupRoutes,
+    bannerRoutes,
     {
       name: 'root',
       register: async function (server) {

api/src/banner/application/banner-controller.js

@@ -0,0 +1,16 @@
+import { usecases } from '../domain/usecases/index.js';
+import * as informationBannerSerializer from '../infrastructure/serializers/jsonapi/information-banner-serializer.js';
+
+const getInformationBanner = async function (request) {
+  const { target: id } = request.params;
+
+  const informationBanner = await usecases.getInformationBanner({ id });
+
+  return informationBannerSerializer.serialize(informationBanner);
+};
+
+const bannerController = {
+  getInformationBanner,
+};
+
+export { bannerController };

api/src/banner/application/banner-route.js

@@ -0,0 +1,20 @@
+import { bannerController } from './banner-controller.js';
+
+const register = async function (server) {
+  server.route([
+    {
+      method: 'GET',
+      path: '/api/information-banners/{target}',
+      options: {
+        auth: false,
+        handler: bannerController.getInformationBanner,
+        cache: {
+          expiresIn: 30 * 1000,
+        },
+      },
+    },
+  ]);
+};
+
+const name = 'src-banners-api';
+export { name, register };

api/src/banner/domain/models/information-banner.js

@@ -0,0 +1,21 @@
+export class InformationBanner {
+  constructor({ id, banners }) {
+    this.id = id;
+    this.banners =
+      banners?.map((banner, index) => {
+        return new Banner({ ...banner, id: `${id}:${index + 1}` });
+      }) ?? [];
+  }
+
+  static empty({ id }) {
+    return new InformationBanner({ id });
+  }
+}
+
+class Banner {
+  constructor({ id, message, severity }) {
+    this.id = id;
+    this.message = message;
+    this.severity = severity;
+  }
+}

api/src/banner/domain/usecases/get-information-banner.js

@@ -0,0 +1,5 @@
+const getInformationBanner = async ({ id, informationBannerRepository }) => {
+  return informationBannerRepository.get({ id });
+};
+
+export { getInformationBanner };

api/src/banner/domain/usecases/index.js

@@ -0,0 +1,33 @@
+// eslint-disable import/no-restricted-paths
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { injectDependencies } from '../../../shared/infrastructure/utils/dependency-injection.js';
+import { importNamedExportsFromDirectory } from '../../../shared/infrastructure/utils/import-named-exports-from-directory.js';
+import * as informationBannerRepository from '../../infrastructure/repositories/information-banner-repository.js';
+
+/**
+ *
+ * Using {@link https://jsdoc.app/tags-type "Closure Compiler's syntax"} to document injected dependencies
+ *
+ * @typedef {informationBannerRepository} InformationBannerRepository
+ **/
+const dependencies = {
+  informationBannerRepository,
+};
+
+const path = dirname(fileURLToPath(import.meta.url));
+
+const usecasesWithoutInjectedDependencies = {
+  ...(await importNamedExportsFromDirectory({
+    path: join(path, './'),
+    ignoredFileNames: 'index.js',
+  })),
+};
+
+const usecases = injectDependencies(usecasesWithoutInjectedDependencies, dependencies);
+
+/**
+ * @typedef {dependencies} dependencies
+ */
+export { usecases };

api/src/banner/infrastructure/repositories/information-banner-repository.js

@@ -0,0 +1,13 @@
+import { informationBannersStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
+import { InformationBanner } from '../../domain/models/information-banner.js';
+
+const get = async function ({ id }) {
+  const banners = await informationBannersStorage.get(id);
+  if (!banners) {
+    return InformationBanner.empty({ id });
+  }
+
+  return new InformationBanner({ id, banners });
+};
+
+export { get };

api/src/banner/infrastructure/serializers/jsonapi/information-banner-serializer.js

@@ -0,0 +1,16 @@
+import jsonapiSerializer from 'jsonapi-serializer';
+
+const { Serializer } = jsonapiSerializer;
+
+const serialize = function (informationBanner) {
+  return new Serializer('information-banners', {
+    attributes: ['banners'],
+    banners: {
+      included: true,
+      ref: 'id',
+      attributes: ['severity', 'message'],
+    },
+  }).serialize(informationBanner);
+};
+
+export { serialize };

api/src/banner/routes.js

@@ -0,0 +1,3 @@
+import * as bannerRoute from './application/banner-route.js';
+
+export const bannerRoutes = [bannerRoute];

api/src/certification/enrolment/domain/services/temporary-sessions-storage-for-mass-import-service.js

@@ -1,5 +1,5 @@
 import { config } from '../../../../../src/shared/config.js';
-import { temporaryStorage } from '../../../../shared/infrastructure/temporary-storage/index.js';
+import { temporaryStorage } from '../../../../shared/infrastructure/key-value-storages/index.js';
 
 const sessionMassImportTemporaryStorage = temporaryStorage.withPrefix('sessions-mass-import:');
 import { randomUUID } from 'node:crypto';
@@ -19,9 +19,7 @@ const save = async function ({ sessions, userId }) {
 
 const getByKeyAndUserId = async function ({ cachedValidatedSessionsKey, userId }) {
   const key = `${userId}:${cachedValidatedSessionsKey}`;
-  const sessions = await sessionMassImportTemporaryStorage.get(key);
-
-  return sessions;
+  return sessionMassImportTemporaryStorage.get(key);
 };
 
 const remove = async function ({ cachedValidatedSessionsKey, userId }) {

api/src/evaluation/infrastructure/repositories/answer-job-repository.js

@@ -1,8 +1,8 @@
 import { AnswerJob } from '../../../quest/domain/models/AnwserJob.js';
 import { config } from '../../../shared/config.js';
 import { DomainTransaction } from '../../../shared/domain/DomainTransaction.js';
+import { temporaryStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
 import { JobRepository } from '../../../shared/infrastructure/repositories/jobs/job-repository.js';
-import { temporaryStorage } from '../../../shared/infrastructure/temporary-storage/index.js';
 
 const profileRewardTemporaryStorage = temporaryStorage.withPrefix('profile-rewards:');
 

api/src/identity-access-management/domain/services/authentication-session.service.js

@@ -1,5 +1,5 @@
 import { config } from '../../../shared/config.js';
-import { temporaryStorage } from '../../../shared/infrastructure/temporary-storage/index.js';
+import { temporaryStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
 const authenticationSessionTemporaryStorage = temporaryStorage.withPrefix('authentication-session:');
 
 const EXPIRATION_DELAY_SECONDS = config.authenticationSession.temporaryStorage.expirationDelaySeconds;

api/src/identity-access-management/domain/services/oidc-authentication-service.js

@@ -10,8 +10,8 @@ import { OIDC_ERRORS } from '../../../shared/domain/constants.js';
 import { DomainTransaction } from '../../../shared/domain/DomainTransaction.js';
 import { OidcError, OidcMissingFieldsError } from '../../../shared/domain/errors.js';
 import { AuthenticationMethod, AuthenticationSessionContent } from '../../../shared/domain/models/index.js';
+import { temporaryStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
 import { monitoringTools } from '../../../shared/infrastructure/monitoring-tools.js';
-import { temporaryStorage } from '../../../shared/infrastructure/temporary-storage/index.js';
 import { logger } from '../../../shared/infrastructure/utils/logger.js';
 import { DEFAULT_CLAIM_MAPPING } from '../constants/oidc-identity-providers.js';
 import { ClaimManager } from '../models/ClaimManager.js';

api/src/identity-access-management/infrastructure/repositories/email-validation-demand.repository.js

@@ -1,7 +1,7 @@
 import crypto from 'node:crypto';
 
 import { config } from '../../../shared/config.js';
-import { temporaryStorage } from '../../../shared/infrastructure/temporary-storage/index.js';
+import { temporaryStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
 
 const emailValidationDemandTemporaryStorage = temporaryStorage.withPrefix('email-validation-demand:');
 

api/src/identity-access-management/infrastructure/repositories/refresh-token.repository.js

@@ -1,4 +1,4 @@
-import { temporaryStorage } from '../../../shared/infrastructure/temporary-storage/index.js';
+import { temporaryStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
 import { PromiseUtils } from '../../../shared/infrastructure/utils/promise-utils.js';
 import { RefreshToken } from '../../domain/models/RefreshToken.js';
 

api/src/identity-access-management/infrastructure/repositories/user-email.repository.js

@@ -1,5 +1,5 @@
 import { config } from '../../../shared/config.js';
-import { temporaryStorage } from '../../../shared/infrastructure/temporary-storage/index.js';
+import { temporaryStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
 import { EmailModificationDemand } from '../../domain/models/EmailModificationDemand.js';
 const verifyEmailTemporaryStorage = temporaryStorage.withPrefix('verify-email:');
 

api/src/quest/application/jobs/answer-job-controller.js

@@ -1,6 +1,6 @@
 import { JobController, JobGroup } from '../../../shared/application/jobs/job-controller.js';
 import { DomainTransaction } from '../../../shared/domain/DomainTransaction.js';
-import { temporaryStorage } from '../../../shared/infrastructure/temporary-storage/index.js';
+import { temporaryStorage } from '../../../shared/infrastructure/key-value-storages/index.js';
 import { AnswerJob } from '../../domain/models/AnwserJob.js';
 import { usecases } from '../../domain/usecases/index.js';