Merge pull request #77 from zxan1285/excluded-clients-fix

ESD-3190: Excluded clients fix

package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-source-control-extension-tools",
-  "version": "3.5.1",
+  "version": "3.5.2",
   "description": "Supporting tools for the Source Control extensions",
   "main": "lib/index.js",
   "scripts": {

src/auth0/handlers/clientGrants.js

@@ -80,7 +80,7 @@ export default class ClientHandler extends DefaultHandler {
 
     const filterGrants = (list) => {
       if (excludedClients.length) {
-        return list.filter(item => item.client_id !== currentClient && !excludedClients.includes(item.client_id));
+        return list.filter(item => item.client_id !== currentClient && ![ ...excludedClientsByNames, ...excludedClients ].includes(item.client_id));
       }
 
       return list.filter(item => item.client_id !== currentClient);

src/auth0/handlers/connections.js

@@ -48,14 +48,20 @@ export default class ConnectionsHandler extends DefaultHandler {
 
     // Convert enabled_clients by name to the id
     const clients = await this.client.clients.getAll({ paginate: true });
+    const excludedClientsByNames = (assets.exclude && assets.exclude.clients) || [];
+    const excludedClients = excludedClientsByNames.map((clientName) => {
+      const found = clients.find(c => c.name === clientName);
+      return (found && found.client_id) || clientName;
+    });
+
     const formatted = assets.connections.map(connection => ({
       ...connection,
       enabled_clients: [
         ...(connection.enabled_clients || []).map((name) => {
           const found = clients.find(c => c.name === name);
           if (found) return found.client_id;
           return name;
-        })
+        }).filter(item => ![ ...excludedClientsByNames, ...excludedClients ].includes(item))
       ]
     }));
 

src/auth0/handlers/databases.js

@@ -68,6 +68,11 @@ export default class DatabaseHandler extends DefaultHandler {
 
     // Convert enabled_clients by name to the id
     const clients = await this.client.clients.getAll({ paginate: true });
+    const excludedClientsByNames = (assets.exclude && assets.exclude.clients) || [];
+    const excludedClients = excludedClientsByNames.map((clientName) => {
+      const found = clients.find(c => c.name === clientName);
+      return (found && found.client_id) || clientName;
+    });
     const formatted = databases.map((db) => {
       if (db.enabled_clients) {
         return {
@@ -76,7 +81,7 @@ export default class DatabaseHandler extends DefaultHandler {
             const found = clients.find(c => c.name === name);
             if (found) return found.client_id;
             return name;
-          })
+          }).filter(item => ![ ...excludedClientsByNames, ...excludedClients ].includes(item))
         };
       }
 

tests/auth0/handlers/connections.tests.js

@@ -144,6 +144,51 @@ describe('#connections handler', () => {
       await stageFn.apply(handler, [ { connections: data } ]);
     });
 
+    it('should omit excluded clients', async () => {
+      const auth0 = {
+        connections: {
+          create: (data) => {
+            expect(data).to.be.an('undefined');
+            return Promise.resolve(data);
+          },
+          update: (params, data) => {
+            expect(params).to.be.an('object');
+            expect(params.id).to.equal('con1');
+            expect(data).to.deep.equal({
+              enabled_clients: [ 'YwqVtt8W3pw5AuEz3B2Kse9l2Ruy7Tec' ],
+              options: { passwordPolicy: 'testPolicy' }
+            });
+
+            return Promise.resolve({ ...params, ...data });
+          },
+          delete: () => Promise.resolve([]),
+          getAll: () => [ { name: 'someConnection', id: 'con1', strategy: 'custom' } ]
+        },
+        clients: {
+          getAll: () => [
+            { name: 'client1', client_id: 'YwqVtt8W3pw5AuEz3B2Kse9l2Ruy7Tec' },
+            { name: 'excluded-one', client_id: 'YwqVtt8W3pw5AuEz3B2Kse9l2Ruy7Teb' }
+          ]
+        },
+        pool
+      };
+
+      const handler = new connections.default({ client: auth0, config });
+      const stageFn = Object.getPrototypeOf(handler).processChanges;
+      const data = [
+        {
+          name: 'someConnection',
+          strategy: 'custom',
+          enabled_clients: [ 'client1', 'excluded-one', 'excluded-two' ],
+          options: {
+            passwordPolicy: 'testPolicy'
+          }
+        }
+      ];
+
+      await stageFn.apply(handler, [ { connections: data, exclude: { clients: [ 'excluded-one', 'excluded-two' ] } } ]);
+    });
+
     it('should delete connection and create another one instead', async () => {
       const auth0 = {
         connections: {

tests/auth0/handlers/databases.tests.js

@@ -140,6 +140,54 @@ describe('#databases handler', () => {
       await stageFn.apply(handler, [ { databases: data } ]);
     });
 
+    it('should omit excluded clients', async () => {
+      const auth0 = {
+        connections: {
+          get: (params) => {
+            expect(params).to.be.an('object');
+            expect(params.id).to.equal('con1');
+            return Promise.resolve({ options: { someOldOption: true } });
+          },
+          create: (data) => {
+            expect(data).to.be.an('undefined');
+            return Promise.resolve(data);
+          },
+          update: (params, data) => {
+            expect(params).to.be.an('object');
+            expect(params.id).to.equal('con1');
+            expect(data).to.deep.equal({
+              enabled_clients: [ 'YwqVtt8W3pw5AuEz3B2Kse9l2Ruy7Tec' ],
+              options: { passwordPolicy: 'testPolicy', someOldOption: true }
+            });
+
+            return Promise.resolve({ ...params, ...data });
+          },
+          delete: () => Promise.resolve([]),
+          getAll: () => [ { name: 'someDatabase', id: 'con1', strategy: 'auth0' } ]
+        },
+        clients: {
+          getAll: () => [
+            { name: 'client1', client_id: 'YwqVtt8W3pw5AuEz3B2Kse9l2Ruy7Tec' },
+            { name: 'excluded-one', client_id: 'YwqVtt8W3pw5AuEz3B2Kse9l2Ruy7Teb' }
+          ]
+        },
+        pool
+      };
+
+      const handler = new databases.default({ client: auth0, config });
+      const stageFn = Object.getPrototypeOf(handler).processChanges;
+      const data = [
+        {
+          name: 'someDatabase',
+          strategy: 'auth0',
+          options: { passwordPolicy: 'testPolicy' },
+          enabled_clients: [ 'client1', 'excluded-one', 'excluded-two' ]
+        }
+      ];
+
+      await stageFn.apply(handler, [ { databases: data, exclude: { clients: [ 'excluded-one', 'excluded-two' ] } } ]);
+    });
+
     it('should update database without "enabled_clients" setting', async () => {
       const auth0 = {
         connections: {