Restructure omni services and add Chatwoot research snapshot

research/chatwoot/app/javascript/v3/helpers/AuthHelper.js

@@ -0,0 +1,53 @@
+import Cookies from 'js-cookie';
+import { DEFAULT_REDIRECT_URL } from 'dashboard/constants/globals';
+import { frontendURL } from 'dashboard/helper/URLHelper';
+
+export const hasAuthCookie = () => {
+  return !!Cookies.get('cw_d_session_info');
+};
+
+const getSSOAccountPath = ({ ssoAccountId, user }) => {
+  const { accounts = [], account_id = null } = user || {};
+  const ssoAccount = accounts.find(
+    account => account.id === Number(ssoAccountId)
+  );
+  let accountPath = '';
+  if (ssoAccount) {
+    accountPath = `accounts/${ssoAccountId}`;
+  } else if (accounts.length) {
+    // If the account id is not found, redirect to the first account
+    const accountId = account_id || accounts[0].id;
+    accountPath = `accounts/${accountId}`;
+  }
+  return accountPath;
+};
+
+const capitalize = str =>
+  str
+    .split(/[._-]+/)
+    .map(word => word.charAt(0).toUpperCase() + word.slice(1))
+    .join(' ');
+
+export const getCredentialsFromEmail = email => {
+  const [localPart, domain] = email.split('@');
+  const namePart = localPart.split('+')[0];
+  return {
+    fullName: capitalize(namePart),
+    accountName: capitalize(domain.split('.')[0]),
+  };
+};
+
+export const getLoginRedirectURL = ({
+  ssoAccountId,
+  ssoConversationId,
+  user,
+}) => {
+  const accountPath = getSSOAccountPath({ ssoAccountId, user });
+  if (accountPath) {
+    if (ssoConversationId) {
+      return frontendURL(`${accountPath}/conversations/${ssoConversationId}`);
+    }
+    return frontendURL(`${accountPath}/dashboard`);
+  }
+  return DEFAULT_REDIRECT_URL;
+};

research/chatwoot/app/javascript/v3/helpers/CommonHelper.js

@@ -0,0 +1,9 @@
+export const replaceRouteWithReload = url => {
+  window.location = url;
+};
+
+export const userInitial = name => {
+  const parts = name.split(/[ -]/).filter(Boolean);
+  let initials = parts.map(part => part[0].toUpperCase()).join('');
+  return initials.slice(0, 2);
+};

research/chatwoot/app/javascript/v3/helpers/RouteHelper.js

@@ -0,0 +1,67 @@
+import { frontendURL } from 'dashboard/helper/URLHelper';
+import { clearBrowserSessionCookies } from 'dashboard/store/utils/api';
+import { hasAuthCookie } from './AuthHelper';
+import { DEFAULT_REDIRECT_URL } from 'dashboard/constants/globals';
+import { replaceRouteWithReload } from './CommonHelper';
+
+const validateSSOLoginParams = to => {
+  const isLoginRoute = to.name === 'login';
+  const { email, sso_auth_token: ssoAuthToken } = to.query || {};
+  const hasValidSSOParams = email && ssoAuthToken;
+  return isLoginRoute && hasValidSSOParams;
+};
+
+export const validateRouteAccess = (to, next, chatwootConfig = {}) => {
+  // Pages with ignoreSession:true would be rendered
+  // even if there is an active session
+  // Used for confirmation or password reset pages
+  if (to.meta && to.meta.ignoreSession) {
+    next();
+    return;
+  }
+
+  if (validateSSOLoginParams(to)) {
+    clearBrowserSessionCookies();
+    next();
+    return;
+  }
+
+  // Redirect to dashboard if a cookie is present, the cookie
+  // cleanup and token validation happens in the application pack.
+  if (hasAuthCookie()) {
+    replaceRouteWithReload(DEFAULT_REDIRECT_URL);
+    return;
+  }
+
+  // If the URL is an invalid path, redirect to login page
+  // Disable navigation to signup page if signups are disabled
+  // Signup route has an attribute (requireSignupEnabled) in it's definition
+  const isAnInalidSignupNavigation =
+    chatwootConfig.signupEnabled !== 'true' &&
+    to.meta &&
+    to.meta.requireSignupEnabled;
+
+  // Disable navigation to SAML login if enterprise is not enabled
+  // SAML route has an attribute (requireEnterprise) in it's definition
+  const isEnterpriseOnlyPath =
+    chatwootConfig.isEnterprise !== 'true' &&
+    to.meta &&
+    to.meta.requireEnterprise;
+
+  if (!to.name || isAnInalidSignupNavigation || isEnterpriseOnlyPath) {
+    next(frontendURL('login'));
+    return;
+  }
+
+  next();
+};
+
+export const isOnOnboardingView = route => {
+  const { name = '' } = route || {};
+
+  if (!name) {
+    return false;
+  }
+
+  return name.includes('onboarding_');
+};

research/chatwoot/app/javascript/v3/helpers/specs/AuthHelper.spec.js

@@ -0,0 +1,80 @@
+import { getLoginRedirectURL, getCredentialsFromEmail } from '../AuthHelper';
+
+describe('#URL Helpers', () => {
+  describe('getLoginRedirectURL', () => {
+    it('should return correct Account URL if account id is present', () => {
+      expect(
+        getLoginRedirectURL({
+          ssoAccountId: '7500',
+          user: {
+            accounts: [{ id: 7500, name: 'Test Account 7500' }],
+          },
+        })
+      ).toBe('/app/accounts/7500/dashboard');
+    });
+
+    it('should return correct conversation URL if account id and conversationId is present', () => {
+      expect(
+        getLoginRedirectURL({
+          ssoAccountId: '7500',
+          ssoConversationId: '752',
+          user: {
+            accounts: [{ id: 7500, name: 'Test Account 7500' }],
+          },
+        })
+      ).toBe('/app/accounts/7500/conversations/752');
+    });
+
+    it('should return default URL if account id is not present', () => {
+      expect(getLoginRedirectURL({ ssoAccountId: '7500', user: {} })).toBe(
+        '/app/'
+      );
+      expect(
+        getLoginRedirectURL({
+          ssoAccountId: '7500',
+          user: {
+            accounts: [{ id: '7501', name: 'Test Account 7501' }],
+          },
+        })
+      ).toBe('/app/accounts/7501/dashboard');
+      expect(getLoginRedirectURL('7500', null)).toBe('/app/');
+    });
+  });
+
+  describe('getCredentialsFromEmail', () => {
+    it('should capitalize fullName and accountName from a standard email', () => {
+      expect(getCredentialsFromEmail('john@company.com')).toEqual({
+        fullName: 'John',
+        accountName: 'Company',
+      });
+    });
+
+    it('should handle subdomains by using the first part of the domain', () => {
+      expect(getCredentialsFromEmail('jane@mail.example.org')).toEqual({
+        fullName: 'Jane',
+        accountName: 'Mail',
+      });
+    });
+
+    it('should split by dots and capitalize each word', () => {
+      expect(getCredentialsFromEmail('john.doe@acme.co')).toEqual({
+        fullName: 'John Doe',
+        accountName: 'Acme',
+      });
+    });
+
+    it('should omit everything after + in the local part', () => {
+      expect(getCredentialsFromEmail('user+tag@startup.io')).toEqual({
+        fullName: 'User',
+        accountName: 'Startup',
+      });
+    });
+
+    it('should split by underscores and hyphens', () => {
+      expect(getCredentialsFromEmail('first_last@my-company.com')).toEqual({
+        fullName: 'First Last',
+        accountName: 'My Company',
+      });
+    });
+  });
+});

research/chatwoot/app/javascript/v3/helpers/specs/CommonHelper.spec.js

@@ -0,0 +1,10 @@
+import { userInitial } from '../CommonHelper';
+
+describe('#userInitial', () => {
+  it('returns the initials of the user', () => {
+    expect(userInitial('John Doe')).toEqual('JD');
+    expect(userInitial('John')).toEqual('J');
+    expect(userInitial('John-Doe')).toEqual('JD');
+    expect(userInitial('John Doe Smith')).toEqual('JD');
+  });
+});

research/chatwoot/app/javascript/v3/helpers/specs/RouteHelper.spec.js

@@ -0,0 +1,94 @@
+import { validateRouteAccess, isOnOnboardingView } from '../RouteHelper';
+import { clearBrowserSessionCookies } from 'dashboard/store/utils/api';
+import { replaceRouteWithReload } from '../CommonHelper';
+import Cookies from 'js-cookie';
+
+const next = vi.fn();
+vi.mock('dashboard/store/utils/api', () => ({
+  clearBrowserSessionCookies: vi.fn(),
+}));
+vi.mock('../CommonHelper', () => ({ replaceRouteWithReload: vi.fn() }));
+
+describe('#validateRouteAccess', () => {
+  beforeEach(() => {
+    vi.spyOn(Cookies, 'set');
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  it('reset cookies and continues to the login page if the SSO parameters are present', () => {
+    validateRouteAccess(
+      {
+        name: 'login',
+        query: { sso_auth_token: 'random_token', email: 'random@email.com' },
+      },
+      next
+    );
+    expect(clearBrowserSessionCookies).toHaveBeenCalledTimes(1);
+    expect(next).toHaveBeenCalledTimes(1);
+  });
+
+  it('ignore session and continue to the page if the ignoreSession is present in route definition', () => {
+    validateRouteAccess(
+      {
+        name: 'login',
+        meta: { ignoreSession: true },
+      },
+      next
+    );
+    expect(clearBrowserSessionCookies).not.toHaveBeenCalled();
+    expect(next).toHaveBeenCalledTimes(1);
+  });
+
+  it('redirects to dashboard if auth cookie is present', () => {
+    vi.spyOn(Cookies, 'get').mockReturnValueOnce(true);
+
+    validateRouteAccess({ name: 'login' }, next);
+    expect(clearBrowserSessionCookies).not.toHaveBeenCalled();
+    expect(replaceRouteWithReload).toHaveBeenCalledWith('/app/');
+    expect(next).not.toHaveBeenCalled();
+  });
+
+  it('redirects to login if route is empty', () => {
+    validateRouteAccess({}, next);
+    expect(clearBrowserSessionCookies).not.toHaveBeenCalled();
+    expect(next).toHaveBeenCalledWith('/app/login');
+  });
+
+  it('redirects to login if signup is disabled', () => {
+    validateRouteAccess({ meta: { requireSignupEnabled: true } }, next, {
+      signupEnabled: 'true',
+    });
+    expect(clearBrowserSessionCookies).not.toHaveBeenCalled();
+    expect(next).toHaveBeenCalledWith('/app/login');
+  });
+
+  it('continues to the route in every other case', () => {
+    validateRouteAccess({ name: 'reset_password' }, next);
+    expect(clearBrowserSessionCookies).not.toHaveBeenCalled();
+    expect(next).toHaveBeenCalledWith();
+  });
+});
+
+describe('isOnOnboardingView', () => {
+  test('returns true for a route with onboarding name', () => {
+    const route = { name: 'onboarding_welcome' };
+    expect(isOnOnboardingView(route)).toBe(true);
+  });
+
+  test('returns false for a route without onboarding name', () => {
+    const route = { name: 'home' };
+    expect(isOnOnboardingView(route)).toBe(false);
+  });
+
+  test('returns false for a route with null name', () => {
+    const route = { name: null };
+    expect(isOnOnboardingView(route)).toBe(false);
+  });
+
+  test('returns false for an  undefined route object', () => {
+    expect(isOnOnboardingView()).toBe(false);
+  });
+});