chore: Allow super admin to suspend an account (#5174)

app/javascript/dashboard/helper/routeHelpers.js

@@ -0,0 +1,51 @@
+export const getCurrentAccount = ({ accounts } = {}, accountId) => {
+  return accounts.find(account => account.id === accountId);
+};
+
+export const getUserRole = ({ accounts } = {}, accountId) => {
+  const currentAccount = getCurrentAccount({ accounts }, accountId) || {};
+  return currentAccount.role || null;
+};
+
+export const routeIsAccessibleFor = (route, role, roleWiseRoutes) => {
+  return roleWiseRoutes[role].includes(route);
+};
+
+const validateActiveAccountRoutes = (to, user, roleWiseRoutes) => {
+  // If the current account is active, then check for the route permissions
+  const accountDashboardURL = `accounts/${to.params.accountId}/dashboard`;
+
+  // If the user is trying to access suspended route, redirect them to dashboard
+  if (to.name === 'account_suspended') {
+    return accountDashboardURL;
+  }
+
+  const userRole = getUserRole(user, Number(to.params.accountId));
+  const isAccessible = routeIsAccessibleFor(to.name, userRole, roleWiseRoutes);
+  // If the route is not accessible for the user, return to dashboard screen
+  return isAccessible ? null : accountDashboardURL;
+};
+
+export const validateLoggedInRoutes = (to, user, roleWiseRoutes) => {
+  const currentAccount = getCurrentAccount(user, Number(to.params.accountId));
+
+  // If current account is missing, either user does not have
+  // access to the account or the account is deleted, return to login screen
+  if (!currentAccount) {
+    return `app/login`;
+  }
+
+  const isCurrentAccountActive = currentAccount.status === 'active';
+
+  if (isCurrentAccountActive) {
+    return validateActiveAccountRoutes(to, user, roleWiseRoutes);
+  }
+
+  // If the current account is not active, then redirect the user to the suspended screen
+  if (to.name !== 'account_suspended') {
+    return `accounts/${to.params.accountId}/suspended`;
+  }
+
+  // Proceed to the route if none of the above conditions are met
+  return null;
+};

app/javascript/dashboard/helper/specs/routeHelpers.spec.js

@@ -0,0 +1,96 @@
+import {
+  getCurrentAccount,
+  getUserRole,
+  routeIsAccessibleFor,
+  validateLoggedInRoutes,
+} from '../routeHelpers';
+
+describe('#getCurrentAccount', () => {
+  it('should return the current account', () => {
+    expect(getCurrentAccount({ accounts: [{ id: 1 }] }, 1)).toEqual({ id: 1 });
+    expect(getCurrentAccount({ accounts: [] }, 1)).toEqual(undefined);
+  });
+});
+
+describe('#getUserRole', () => {
+  it('should return the current role', () => {
+    expect(
+      getUserRole({ accounts: [{ id: 1, role: 'administrator' }] }, 1)
+    ).toEqual('administrator');
+    expect(getUserRole({ accounts: [] }, 1)).toEqual(null);
+  });
+});
+
+describe('#routeIsAccessibleFor', () => {
+  it('should return the correct access', () => {
+    const roleWiseRoutes = { agent: ['conversations'], admin: ['billing'] };
+    expect(routeIsAccessibleFor('billing', 'agent', roleWiseRoutes)).toEqual(
+      false
+    );
+    expect(routeIsAccessibleFor('billing', 'admin', roleWiseRoutes)).toEqual(
+      true
+    );
+  });
+});
+
+describe('#validateLoggedInRoutes', () => {
+  describe('when account access is missing', () => {
+    it('should return the login route', () => {
+      expect(
+        validateLoggedInRoutes(
+          { params: { accountId: 1 } },
+          { accounts: [] },
+          {}
+        )
+      ).toEqual(`app/login`);
+    });
+  });
+  describe('when account access is available', () => {
+    describe('when account is suspended', () => {
+      it('return suspended route', () => {
+        expect(
+          validateLoggedInRoutes(
+            { name: 'conversations', params: { accountId: 1 } },
+            { accounts: [{ id: 1, role: 'agent', status: 'suspended' }] },
+            { agent: ['conversations'] }
+          )
+        ).toEqual(`accounts/1/suspended`);
+      });
+    });
+    describe('when account is active', () => {
+      describe('when route is accessible', () => {
+        it('returns null (no action required)', () => {
+          expect(
+            validateLoggedInRoutes(
+              { name: 'conversations', params: { accountId: 1 } },
+              { accounts: [{ id: 1, role: 'agent', status: 'active' }] },
+              { agent: ['conversations'] }
+            )
+          ).toEqual(null);
+        });
+      });
+      describe('when route is not accessible', () => {
+        it('returns dashboard url', () => {
+          expect(
+            validateLoggedInRoutes(
+              { name: 'conversations', params: { accountId: 1 } },
+              { accounts: [{ id: 1, role: 'agent', status: 'active' }] },
+              { admin: ['conversations'], agent: [] }
+            )
+          ).toEqual(`accounts/1/dashboard`);
+        });
+      });
+      describe('when route is suspended route', () => {
+        it('returns dashboard url', () => {
+          expect(
+            validateLoggedInRoutes(
+              { name: 'account_suspended', params: { accountId: 1 } },
+              { accounts: [{ id: 1, role: 'agent', status: 'active' }] },
+              { agent: ['account_suspended'] }
+            )
+          ).toEqual(`accounts/1/dashboard`);
+        });
+      });
+    });
+  });
+});