[FEATURE] Renommer les customProperties en additionalRequiredProperti…

…es (PIX-12209) #8702
1024pix · Apr 19, 2024 · 84e49bd · 84e49bd
2 parents 9d97f59 + d522236
commit 84e49bd
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 70 deletions.
diff --git a/api/OIDC_PROVIDERS.example.json b/api/OIDC_PROVIDERS.example.json
@@ -15,7 +15,7 @@
     "openidClientExtraMetadata": {
       "token_endpoint_auth_method": "client_secret_post"
     },
-    "customProperties": {
+    "additionalRequiredProperties": {
       "logoutUrl": "https://seeds.example.net/logout",
       "afterLogoutUrl": "http://app.dev.pix.org"
     }

diff --git a/api/db/database-builder/factory/build-oidc-provider.js b/api/db/database-builder/factory/build-oidc-provider.js
@@ -9,7 +9,7 @@ export async function buildOidcProvider({
   claimsToStore,
   clientId,
   clientSecret,
-  customProperties,
+  additionalRequiredProperties,
   enabled,
   enabledForPixAdmin,
   extraAuthorizationUrlParameters,
@@ -31,7 +31,7 @@ export async function buildOidcProvider({
     accessTokenLifespan,
     claimsToStore,
     clientId,
-    customProperties,
+    additionalRequiredProperties,
     enabled,
     enabledForPixAdmin,
     encryptedClientSecret,

diff --git a/...0240415144511_rename-oidc-providers-customProperties-into-additionalRequiredProperties.js b/...0240415144511_rename-oidc-providers-customProperties-into-additionalRequiredProperties.js
@@ -0,0 +1,19 @@
+const TABLE_NAME = 'oidc-providers';
+const COLUMN_NEW_NAME = 'additionalRequiredProperties';
+const COLUMN_OLD_NAME = 'customProperties';
+
+const up = async function (knex) {
+  await knex.schema.table(TABLE_NAME, function (table) {
+    table.jsonb(COLUMN_NEW_NAME);
+    table.dropColumn(COLUMN_OLD_NAME);
+  });
+};
+
+const down = async function (knex) {
+  await knex.schema.table(TABLE_NAME, function (table) {
+    table.jsonb(COLUMN_OLD_NAME);
+    table.dropColumn(COLUMN_NEW_NAME);
+  });
+};
+
+export { down, up };
diff --git a/api/scripts/team-acces/load-oidc-providers-from-env-variables.js b/api/scripts/team-acces/load-oidc-providers-from-env-variables.js
@@ -29,7 +29,7 @@ const OIDC_PROVIDERS_POLE_EMPLOI = {
 
   openidClientExtraMetadata: { token_endpoint_auth_method: 'client_secret_post' },
 
-  customProperties: {
+  additionalRequiredProperties: {
     logoutUrl: process.env.POLE_EMPLOI_OIDC_LOGOUT_URL,
     afterLogoutUrl: process.env.POLE_EMPLOI_OIDC_AFTER_LOGOUT_URL,
   },
@@ -51,7 +51,7 @@ const OIDC_PROVIDERS_FWB = {
   redirectUri: process.env.FWB_REDIRECT_URI,
   shouldCloseSession: true,
 
-  customProperties: {
+  additionalRequiredProperties: {
     logoutUrl: process.env.FWB_OIDC_LOGOUT_URL,
   },
 

diff --git a/api/src/authentication/domain/usecases/add-oidc-provider.js b/api/src/authentication/domain/usecases/add-oidc-provider.js
@@ -6,9 +6,9 @@ import { DomainTransaction } from '../../../shared/domain/DomainTransaction.js';
 /**
  * @param {Object} params
  * @param {string} params.accessTokenLifespan
+ * @param {Object} params.additionalRequiredProperties
  * @param {string} params.claimsToStore
  * @param {string} params.clientId
- * @param {Object} params.customProperties
  * @param {boolean} params.enabled
  * @param {boolean} params.enabledForPixAdmin
  * @param {string} params.encryptedClientSecret
@@ -29,9 +29,9 @@ import { DomainTransaction } from '../../../shared/domain/DomainTransaction.js';
  */
 const addOidcProvider = async function ({
   accessTokenLifespan,
+  additionalRequiredProperties,
   claimsToStore,
   clientId,
-  customProperties,
   enabled,
   enabledForPixAdmin,
   encryptedClientSecret,
@@ -52,9 +52,9 @@ const addOidcProvider = async function ({
   await oidcProviderRepository.create(
     {
       accessTokenLifespan,
+      additionalRequiredProperties,
       claimsToStore,
       clientId,
-      customProperties,
       enabled,
       enabledForPixAdmin,
       encryptedClientSecret,

diff --git a/api/src/authentication/infrastructure/repositories/oidc-provider-repository.js b/api/src/authentication/infrastructure/repositories/oidc-provider-repository.js
@@ -4,75 +4,34 @@ import { DomainTransaction } from '../../../shared/domain/DomainTransaction.js';
 const OIDC_PROVIDERS_TABLE_NAME = 'oidc-providers';
 
 /**
- * @param {Object} params
- * @param {string} params.accessTokenLifespan
- * @param {string} params.claimsToStore
- * @param {string} params.clientId
- * @param {Object} params.customProperties
- * @param {boolean} params.enabled
- * @param {boolean} params.enabledForPixAdmin
- * @param {string} params.encryptedClientSecret
- * @param {Object} params.extraAuthorizationUrlParameters
- * @param {string} params.identityProvider
- * @param {Object} params.openidClientExtraMetadata
- * @param {string} params.openidConfigurationUrl
- * @param {string} params.organizationName
- * @param {string} params.postLogoutRedirectUri
- * @param {string} params.redirectUri
- * @param {string} params.scope
- * @param {boolean} params.shouldCloseSession
- * @param {string} params.slug
- * @param {string} params.source
+ * @param {Object} oidcProviderProperties
+ * @param {string} oidcProviderProperties.accessTokenLifespan
+ * @param {Object} oidcProviderProperties.additionalRequiredProperties
+ * @param {string} oidcProviderProperties.claimsToStore
+ * @param {string} oidcProviderProperties.clientId
+ * @param {boolean} oidcProviderProperties.enabled
+ * @param {boolean} oidcProviderProperties.enabledForPixAdmin
+ * @param {string} oidcProviderProperties.encryptedClientSecret
+ * @param {Object} oidcProviderProperties.extraAuthorizationUrlParameters
+ * @param {string} oidcProviderProperties.identityProvider
+ * @param {Object} oidcProviderProperties.openidClientExtraMetadata
+ * @param {string} oidcProviderProperties.openidConfigurationUrl
+ * @param {string} oidcProviderProperties.organizationName
+ * @param {string} oidcProviderProperties.postLogoutRedirectUri
+ * @param {string} oidcProviderProperties.redirectUri
+ * @param {string} oidcProviderProperties.scope
+ * @param {boolean} oidcProviderProperties.shouldCloseSession
+ * @param {string} oidcProviderProperties.slug
+ * @param {string} oidcProviderProperties.source
  * @param {Object} dependencies
  * @param {DomainTransaction} dependencies.domainTransaction
  * @returns {Promise<any[]>}
  */
 const create = async function (
-  {
-    accessTokenLifespan,
-    claimsToStore,
-    clientId,
-    customProperties,
-    enabled,
-    enabledForPixAdmin,
-    encryptedClientSecret,
-    extraAuthorizationUrlParameters,
-    identityProvider,
-    openidClientExtraMetadata,
-    openidConfigurationUrl,
-    organizationName,
-    postLogoutRedirectUri,
-    redirectUri,
-    scope,
-    shouldCloseSession,
-    slug,
-    source,
-  },
+  oidcProviderProperties,
   dependencies = { domainTransaction: DomainTransaction.emptyTransaction() },
 ) {
   const knexConn = dependencies.domainTransaction.knexTransaction ?? knex;
-
-  const oidcProviderProperties = {
-    accessTokenLifespan,
-    claimsToStore,
-    clientId,
-    customProperties,
-    enabled,
-    enabledForPixAdmin,
-    encryptedClientSecret,
-    extraAuthorizationUrlParameters,
-    identityProvider,
-    openidClientExtraMetadata,
-    openidConfigurationUrl,
-    organizationName,
-    postLogoutRedirectUri,
-    redirectUri,
-    scope,
-    shouldCloseSession,
-    slug,
-    source,
-  };
-
   return await knexConn(OIDC_PROVIDERS_TABLE_NAME).insert(oidcProviderProperties).returning('*');
 };
 

diff --git a/api/tests/authentication/unit/domain/usecases/add-oidc-provider_test.js b/api/tests/authentication/unit/domain/usecases/add-oidc-provider_test.js
@@ -25,9 +25,9 @@ describe('Unit | Authentication | Domain | UseCases | add-oidc-provider', functi
     };
     const expectedOidcProviderProperties = {
       accessTokenLifespan: '7d',
+      additionalRequiredProperties: undefined,
       claimsToStore: undefined,
       clientId: 'client',
-      customProperties: undefined,
       enabled: undefined,
       enabledForPixAdmin: undefined,
       encryptedClientSecret: '#%@!!!!!!!!!!!!!',