fix: cross_origin_auth is deprecated and migrated to cross_origin_authentication (#1223)

* fix: added warning for legacy cross_origin_auth and added sanitizeDeprecatedClientFields for handling deprecated field and new field

* test: add migration tests for deprecated cross_origin_auth to cross_origin_authentication

* fix: rename variable for clarity in sanitizeClientFields function

* fix: update client sanitization to handle deprecated cross_origin_auth field

* fix: refactor client field sanitization to improve clarity and handle deprecated cross_origin_auth field

* fix: specify type for fields in sanitizeClientFields function

* fix: rename variable for clarity in sanitizeClientFields function and update handling of deprecated cross_origin_auth field

* fix: migrate deprecated cross_origin_auth to cross_origin_authentication in client export

* fix: ensure newline at end of file in clients.tests.js

* fix: refactor cross_origin_auth sanitization into a dedicated method

* fix: improve client field sanitization and handle deprecated cross_origin_auth field

* Refactor code structure for improved readability and maintainability

* fix: correct spelling of 'sanitized' in client field sanitization methods

* fix: update deprecation warning for 'cross_origin_auth' parameter

Author: palashgdev

src/tools/auth0/handlers/clients.ts

@@ -3,11 +3,13 @@ import {
   ClientExpressConfiguration,
   ClientOrganizationRequireBehaviorEnum,
 } from 'auth0';
+import { has, omit } from 'lodash';
 import { Assets, Auth0APIClient } from '../../../types';
 import { paginate } from '../client';
 import DefaultAPIHandler from './default';
 import { getConnectionProfile } from './connectionProfiles';
 import { getUserAttributeProfiles } from './userAttributeProfiles';
+import log from '../../../logger';
 
 const multiResourceRefreshTokenPoliciesSchema = {
   type: ['array', 'null'],
@@ -276,6 +278,8 @@ export type Client = {
   app_type?: string;
   is_first_party?: boolean;
   resource_server_identifier?: string;
+  cross_origin_authentication?: boolean;
+  cross_origin_auth?: boolean;
   custom_login_page?: string;
   custom_login_page_on?: boolean;
   express_configuration?: ClientExpressConfiguration;
@@ -344,9 +348,10 @@ export default class ClientHandler extends DefaultAPIHandler {
       );
 
     // Sanitize client fields
-    const sanitizeClientFields = (list: Client[]): Client[] =>
-      list.map((item) => {
-        // For resourceServers app type `resource_server`, don't include `oidc_backchannel_logout`, `oidc_logout`, `refresh_token`
+    const sanitizeClientFields = (list: Client[]): Client[] => {
+      const sanitizedClients = this.sanitizeCrossOriginAuth(list);
+
+      return sanitizedClients.map((item: Client) => {
         if (item.app_type === 'resource_server') {
           if ('oidc_backchannel_logout' in item) {
             delete item.oidc_backchannel_logout;
@@ -360,6 +365,7 @@ export default class ClientHandler extends DefaultAPIHandler {
         }
         return item;
       });
+    };
 
     const changes = {
       del: sanitizeClientFields(filterClients(del as Client[])),
@@ -373,6 +379,44 @@ export default class ClientHandler extends DefaultAPIHandler {
     });
   }
 
+  /**
+   * @description
+   * Sanitize the deprecated field `cross_origin_auth` to `cross_origin_authentication`
+   *
+   * @param {Client[]} clients - The client array to sanitize.
+   * @returns {Client[]} The sanitized array of clients.
+   */
+  private sanitizeCrossOriginAuth(clients: Client[]): Client[] {
+    const deprecatedClients: string[] = [];
+
+    const updatedClients = clients.map((client) => {
+      let updated: Client = { ...client };
+
+      if (has(updated, 'cross_origin_auth')) {
+        deprecatedClients.push(client.name);
+
+        if (!has(updated, 'cross_origin_authentication')) {
+          updated.cross_origin_authentication = updated.cross_origin_auth;
+        }
+
+        updated = omit(updated, 'cross_origin_auth') as Client;
+      }
+
+      return updated;
+    });
+
+    if (deprecatedClients.length > 0) {
+      log.warn(
+        "The 'cross_origin_auth' parameter is deprecated in clients and scheduled for removal in future releases.\n" +
+          `Use 'cross_origin_authentication' going forward. Clients using the deprecated setting: [${deprecatedClients.join(
+            ', '
+          )}]`
+      );
+    }
+
+    return updatedClients;
+  }
+
   async getType() {
     if (this.existing) return this.existing;
 
@@ -387,7 +431,9 @@ export default class ClientHandler extends DefaultAPIHandler {
       ...(excludeThirdPartyClients && { is_first_party: true }),
     });
 
-    this.existing = clients;
+    const sanitizedClients = this.sanitizeCrossOriginAuth(clients);
+
+    this.existing = sanitizedClients;
     return this.existing;
   }