chore: refactor

Author: ryanbas21

e2e/davinci-app/components/social-login-button.ts

@@ -17,14 +17,11 @@ export default function submitButtonComponent(
   button.value = collector.output.label;
   button.innerHTML = collector.output.label;
   button.onclick = () => {
-    const url = updater();
-    if (typeof url === 'string') {
-      window.location.assign(url);
+    updater();
+    if ('url' in collector.output && typeof collector.output.url === 'string') {
+      window.location.assign(collector.output.url);
     } else {
-      /**
-       * this is an error now
-       **/
-      console.error(url);
+      console.error('no url to continue from');
     }
   };
 

packages/davinci-client/package.json

@@ -27,6 +27,7 @@
     "@forgerock/sdk-oidc": "workspace:*",
     "@forgerock/sdk-request-middleware": "workspace:*",
     "@forgerock/sdk-types": "workspace:*",
+    "@forgerock/storage": "workspace:*",
     "@reduxjs/toolkit": "catalog:",
     "immer": "catalog:"
   },

packages/davinci-client/src/lib/client.store.ts

@@ -8,6 +8,7 @@
  * Import RTK slices and api
  */
 import { CustomLogger, logger as loggerFn, LogLevel } from '@forgerock/sdk-logger';
+import { createStorage } from '@forgerock/storage';
 
 import { createClientStore, handleUpdateValidateError, RootState } from './client.store.utils.js';
 import { nodeSlice } from './node.slice.js';
@@ -28,7 +29,6 @@ import type {
 } from './davinci.types.js';
 import type {
   SingleValueCollectors,
-  IdpCollector,
   MultiSelectCollector,
   ObjectValueCollectors,
   PhoneNumberInputValue,
@@ -41,8 +41,7 @@ import type {
   Validator,
 } from './client.types.js';
 import { returnValidator } from './collector.utils.js';
-import { StartNode } from './node.types.js';
-import { returnRedirectUrlForSocialLogin } from './davinci.utils.js';
+import { ContinueNode, StartNode } from './node.types.js';
 
 /**
  * Create a client function that returns a set of methods
@@ -66,7 +65,10 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
 }) {
   const log = loggerFn({ level: logger?.level || 'error', custom: logger?.custom });
   const store = createClientStore({ requestMiddleware, logger: log });
-
+  const serverStorage = createStorage<ContinueNode['server']>(
+    { storeType: 'localStorage' },
+    'socialLoginUrl',
+  );
   if (!config.serverConfig.wellknown) {
     const error = new Error(
       '`wellknown` property is a required as part of the `config.serverConfig`',
@@ -114,17 +116,23 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
      * @param collector IdpCollector
      * @returns {function}
      */
-    externalIdp: (collector: IdpCollector): (() => string | InternalErrorResponse) => {
+    externalIdp: (): (() => Promise<void | InternalErrorResponse>) => {
       const rootState: RootState = store.getState();
-
       const serverSlice = nodeSlice.selectors.selectServer(rootState);
 
-      return () => {
-        const result = returnRedirectUrlForSocialLogin(serverSlice, collector, log);
-        if (typeof result == 'string') {
-          return result;
-        }
-        return result;
+      if (serverSlice && serverSlice.status === 'continue') {
+        return async () => {
+          await serverStorage.set(serverSlice);
+        };
+      }
+      return async () => {
+        return {
+          error: {
+            message:
+              'Not in a continue node state, must be in a continue node to use external idp method',
+            type: 'state_error',
+          },
+        } as InternalErrorResponse;
       };
     },
 
@@ -178,12 +186,34 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
      * @method: resume - Resume a social login flow when returned to application
      * @returns unknown
      */
-    resume: async ({ continueToken }: { continueToken: string }) => {
-      await store.dispatch(davinciApi.endpoints.resume.initiate({ continueToken }));
-
-      const node = nodeSlice.selectSlice(store.getState());
-
-      return node;
+    resume: async ({
+      continueToken,
+    }: {
+      continueToken: string;
+    }): Promise<InternalErrorResponse | NodeStates> => {
+      try {
+        const serverInfo = await serverStorage.get();
+        if (serverInfo && '_links' in serverInfo) {
+          await store.dispatch(davinciApi.endpoints.resume.initiate({ continueToken, serverInfo }));
+          await serverStorage.remove();
+
+          const node = nodeSlice.selectSlice(store.getState());
+
+          return node;
+        } else {
+          throw new Error('failure to get continue url');
+        }
+      } catch {
+        // logger.error('No url found in collector, social login needs a url in the collector');
+        return {
+          error: {
+            message:
+              'No url found in storage, social login needs a continue url which is saved in local storage. You may have cleared your browser data',
+            type: 'internal_error',
+          },
+          type: 'internal_error',
+        };
+      }
     },
 
     /**

packages/davinci-client/src/lib/davinci.api.ts

@@ -347,10 +347,10 @@ export const davinciApi = createApi({
         handleResponse(cacheEntry, api.dispatch, response?.status || 0, logger);
       },
     }),
-    resume: builder.query<unknown, { continueToken: string }>({
-      async queryFn({ continueToken }, api, _c, baseQuery) {
-        const continueUrl = window.localStorage.getItem('continueUrl') || null;
+    resume: builder.query<unknown, { serverInfo: ContinueNode['server']; continueToken: string }>({
+      async queryFn({ serverInfo, continueToken }, api, _c, baseQuery) {
         const { requestMiddleware, logger } = api.extra as Extras;
+        const links = serverInfo._links;
 
         if (!continueToken) {
           return {
@@ -362,7 +362,12 @@ export const davinciApi = createApi({
             },
           };
         }
-        if (!continueUrl) {
+        if (
+          !links ||
+          !('continue' in links) ||
+          !('href' in links['continue']) ||
+          !links['continue'].href
+        ) {
           return {
             error: {
               data: 'No continue url',
@@ -373,10 +378,7 @@ export const davinciApi = createApi({
           };
         }
 
-        if (continueUrl) {
-          window.localStorage.removeItem('continueUrl');
-        }
-
+        const continueUrl = links['continue'].href;
         const request: FetchArgs = {
           url: continueUrl,
           credentials: 'include',

packages/davinci-client/src/lib/davinci.utils.ts

@@ -11,8 +11,6 @@ import type { Dispatch } from '@reduxjs/toolkit';
 
 import { logger as loggerFn } from '@forgerock/sdk-logger';
 
-import type { RootState } from './client.store.utils.js';
-
 import { nodeSlice } from './node.slice.js';
 
 import type {
@@ -24,9 +22,7 @@ import type {
   DaVinciSuccessResponse,
 } from './davinci.types.js';
 import type { ContinueNode } from './node.types.js';
-import { DeviceValue, IdpCollector, PhoneNumberInputValue } from './collector.types.js';
-import { InternalErrorResponse } from './client.types.js';
-
+import { DeviceValue, PhoneNumberInputValue } from './collector.types.js';
 /**
  * @function transformSubmitRequest - Transforms a NextNode into a DaVinciRequest for form submissions
  * @param {ContinueNode} node - The node to transform into a DaVinciRequest
@@ -245,44 +241,3 @@ export function handleResponse(
     }
   }
 }
-
-export function returnRedirectUrlForSocialLogin(
-  serverSlice: RootState['node']['server'],
-  collector: IdpCollector,
-  logger: ReturnType<typeof loggerFn>,
-): InternalErrorResponse | string {
-  if (serverSlice && '_links' in serverSlice) {
-    const continueUrl = serverSlice._links?.['continue']?.href ?? null;
-    if (continueUrl) {
-      window.localStorage.setItem('continueUrl', continueUrl);
-      if (collector.output.url) {
-        return collector.output.url;
-      } else {
-        logger.error('No url found in collector, social login needs a url in the collector');
-        return {
-          error: {
-            message:
-              'No url found in collector, social login needs a url in the collector to navigate to',
-            type: 'network_error',
-          },
-          type: 'internal_error',
-        };
-      }
-    }
-  }
-  /**
-   * If we have no continue url
-   * we have to return an error
-   **/
-  logger.error(
-    'No Continue Url found, social login needs a continue url to be saved in localStorage',
-  );
-  return {
-    error: {
-      message:
-        'No Continue Url found, social login needs a continue url to be saved in localStorage',
-      type: 'network_error',
-    },
-    type: 'internal_error',
-  };
-}

packages/davinci-client/tsconfig.json

@@ -11,7 +11,7 @@
   },
   "references": [
     {
-      "path": "../sdk-effects/logger"
+      "path": "../sdk-effects/storage"
     },
     {
       "path": "../sdk-types"
@@ -22,6 +22,9 @@
     {
       "path": "../sdk-effects/oidc"
     },
+    {
+      "path": "../sdk-effects/logger"
+    },
     {
       "path": "./tsconfig.lib.json"
     },

packages/davinci-client/tsconfig.lib.json

@@ -32,7 +32,7 @@
   ],
   "references": [
     {
-      "path": "../sdk-effects/logger/tsconfig.lib.json"
+      "path": "../sdk-effects/storage/tsconfig.lib.json"
     },
     {
       "path": "../sdk-types/tsconfig.lib.json"
@@ -42,6 +42,9 @@
     },
     {
       "path": "../sdk-effects/oidc/tsconfig.lib.json"
+    },
+    {
+      "path": "../sdk-effects/logger/tsconfig.lib.json"
     }
   ]
 }