fix(journey): moved journey clint configuration into journey store

Author: vatsalparikh

apps/login-app/src/routes/(app)/+layout.ts

@@ -8,7 +8,6 @@
  **/
 
 import configure from '$core/sdk.config';
-import { setJourneyClientConfig } from '$core/journey-client.config';
 import { initialize as initializeJourneys } from '$journey/config.store';
 import { initialize as initializeLinks } from '$core/links.store';
 
@@ -17,16 +16,6 @@ import { browser } from '$app/environment';
 import type { LayoutLoad } from './$types';
 
 export const load: LayoutLoad = ({ data }) => {
-  if (data.wellknown) {
-    setJourneyClientConfig({
-      serverConfig: {
-        wellknown: data.wellknown,
-      },
-    });
-  } else {
-    console.warn('Wellknown URL is not configured.');
-  }
-
   configure({
     clientId: data.clientId,
     redirectUri: `${browser ? window.location.origin : 'https://placeholder.com'}/callback`,

apps/login-app/src/routes/(app)/+page.svelte

@@ -29,7 +29,11 @@
   const journeyParam = $page.url.searchParams.get('journey');
   const suspendedIdParam = $page.url.searchParams.get('suspendedId');
 
-  const journeyStore: JourneyStore = initializeJourney();
+  const journeyStore: JourneyStore = initializeJourney({
+    serverConfig: {
+      wellknown: data.wellknown,
+    },
+  });
 
   let hasSubmitted = false;
   let redirectForm: HTMLFormElement | null = null;

apps/login-app/src/routes/(app)/register/+page.svelte

@@ -23,7 +23,11 @@
   /** @type {import('./$types').PageData} */
   export let data;
 
-  const journeyStore: JourneyStore = initializeJourney();
+  const journeyStore: JourneyStore = initializeJourney({
+    serverConfig: {
+      wellknown: data.wellknown,
+    },
+  });
   const oauthStore: OAuthStore = initializeOAuth();
   const userStore: UserStore = initializeUser();
 

core/journey-client.config.ts

@@ -13,18 +13,20 @@ import type { JourneyClient, JourneyClientConfig } from '@forgerock/journey-clie
 
 const journeyMock = vi.fn();
 
-vi.mock('@forgerock/journey-client', () => {
+vi.mock('@forgerock/journey-client', async (importOriginal) => {
+  const actual = (await importOriginal()) as Record<string, unknown>;
   return {
+    ...actual,
     journey: journeyMock,
   };
 });
 
 async function importSubject() {
-  const mod = await import('./journey-client.config');
+  const mod = await import('./journey.store');
   return mod;
 }
 
-describe('journey-client.config', () => {
+describe('journey.store (Journey Client configuration)', () => {
   beforeEach(() => {
     journeyMock.mockReset();
     vi.resetModules();

core/journey-client.config.test.ts core/journey/journey.store.test.tscore/journey-client.config.test.ts renamed to core/journey/journey.store.test.ts

@@ -7,6 +7,7 @@
  *
  **/
 
+import { journey } from '@forgerock/journey-client';
 import type {
   BaseCallback,
   JourneyStep,
@@ -15,9 +16,11 @@ import type {
   NextOptions,
   ResumeOptions,
   JourneyClient,
+  JourneyClientConfig,
   GenericError,
 } from '@forgerock/journey-client/types';
 import { writable, type Writable } from 'svelte/store';
+import { z } from 'zod';
 
 import { htmlDecode } from '$journey/_utilities/decode.utilities';
 import type { JourneyStore, JourneyStoreValue, StackStore, StepTypes } from './journey.interfaces';
@@ -30,7 +33,85 @@ import {
 } from './stages/_utilities/step.utilities';
 import { buildCallbackMetadata, buildStepMetadata } from '$journey/_utilities/metadata.utilities';
 import type { Maybe } from '$core/interfaces';
-import { getJourneyClient } from '$core/journey-client.config';
+
+/**
+ * Configure Journey Client
+ */
+
+const wellknownSchema = z
+  .string({
+    invalid_type_error:
+      '`serverConfig.wellknown` must be a URL string (this is generated by the Zod library).',
+    required_error:
+      'Setting the `serverConfig.wellknown` is required (this is generated by the Zod library).',
+  })
+  .url({
+    message: '`serverConfig.wellknown` must be a full URL (this is generated by the Zod library).',
+  });
+
+export const journeyClientConfigSchema: z.ZodType<JourneyClientConfig> = z
+  .object({
+    serverConfig: z
+      .object({
+        wellknown: wellknownSchema,
+      })
+      .strict(),
+  })
+  .strict();
+
+let journeyClientConfig: JourneyClientConfig | undefined;
+
+/**
+ * We cache the journey client promise instead of only caching the resolved client so concurrent callers
+ * share the same initialization work and we don't create multiple Journey Client instances in parallel.
+ */
+let journeyClientPromise: Promise<JourneyClient> | undefined;
+
+/**
+ * @function setJourneyClientConfig - Sets (or ensures) the Journey Client configuration.
+ * @param {JourneyClientConfig} [config] If omitted, reuses existing config.
+ * @throws {Error} If called without config before configuration is set.
+ * @throws {z.ZodError} If provided config fails validation.
+ * @returns {JourneyClientConfig} The active Journey Client configuration.
+ */
+export function setJourneyClientConfig(config?: JourneyClientConfig): JourneyClientConfig {
+  const parsed =
+    config === undefined ? journeyClientConfig : journeyClientConfigSchema.parse(config);
+
+  if (!parsed) {
+    throw new Error('Journey Client is not configured. Call setJourneyClientConfig() first.');
+  }
+
+  const hasChanged = parsed.serverConfig.wellknown !== journeyClientConfig?.serverConfig.wellknown;
+  journeyClientConfig = parsed;
+  // Reset the cached client promise when config changes.
+  if (hasChanged) {
+    journeyClientPromise = undefined;
+  }
+  return journeyClientConfig;
+}
+
+/**
+ * @function getJourneyClient - Gets a cached Journey Client (promise).
+ * @throws {Error} If no Journey Client configuration is available.
+ * @returns {Promise<JourneyClient>} A promise that resolves to a Journey Client.
+ */
+export async function getJourneyClient(): Promise<JourneyClient> {
+  if (!journeyClientConfig) {
+    throw new Error('Journey Client is not configured. Call setJourneyClientConfig() first.');
+  }
+
+  // Cache the journey client promise to reuse an existing journey client.
+  if (!journeyClientPromise) {
+    journeyClientPromise = journey({ config: journeyClientConfig }).catch((err) => {
+      // If creation fails, clear the cache so a later call can try again.
+      journeyClientPromise = undefined;
+      throw err;
+    });
+  }
+
+  return await journeyClientPromise;
+}
 
 /**
  * @function initializeJourney - Initializes the journey stack for tracking journey switches
@@ -104,9 +185,13 @@ export const journeyStore: Writable<JourneyStoreValue> = writable({
 
 /**
  * @function initialize - Initializes the journey store
- * @returns {object} - The journey store
+ * @param {JourneyClientConfig} Optional Journey Client configuration.
+ * @throws {Error} If no Journey Client configuration is available.
+ * @returns {JourneyStore} Journey store API.
  */
-export function initialize(): JourneyStore {
+export function initialize(config?: JourneyClientConfig | undefined): JourneyStore {
+  setJourneyClientConfig(config);
+
   const stack = initializeStack();
   let stepNumber = 0;
   // TODO: JourneyResult is not currently exported by Journey Client, so we define it here

core/journey/journey.store.ts

@@ -19,7 +19,6 @@ import { PIProtect } from '@forgerock/ping-protect';
 
 import { logErrorAndThrow } from '$core/_utilities/errors.utilities';
 import configure from '$core/sdk.config';
-import { setJourneyClientConfig } from '$core/journey-client.config';
 
 // Import the stores for initialization
 import { componentStore } from '$core/component.store';
@@ -73,10 +72,6 @@ export function widgetApiFactory(componentApi: ReturnType<typeof _componentApi>)
   }
 
   const configuration = (options?: WidgetConfigOptions) => {
-    if (options?.journeyClient) {
-      setJourneyClientConfig(options.journeyClient);
-    }
-
     if (options?.forgerock) {
       configure({
         // Set some basics by default
@@ -104,7 +99,7 @@ export function widgetApiFactory(componentApi: ReturnType<typeof _componentApi>)
     /**
      * Initialize all the stores.
      */
-    journeyStore = initializeJourney();
+    journeyStore = initializeJourney(options?.journeyClient);
     oauthStore = initializeOauth(options?.forgerock);
     userStore = initializeUser(options?.forgerock);
 
@@ -119,10 +114,6 @@ export function widgetApiFactory(componentApi: ReturnType<typeof _componentApi>)
        * @returns {void}
        **/
       set(setOptions?: WidgetConfigOptions): void {
-        if (setOptions?.journeyClient) {
-          setJourneyClientConfig(setOptions.journeyClient);
-        }
-
         if (setOptions?.forgerock) {
           configure({
             // Set some basics by default
@@ -150,7 +141,7 @@ export function widgetApiFactory(componentApi: ReturnType<typeof _componentApi>)
          * Initialize the stores and ensure both variables point to the same reference.
          * Variables with _ are the reactive version of the original variable from above.
          */
-        journeyStore = initializeJourney();
+        journeyStore = initializeJourney(setOptions?.journeyClient);
         oauthStore = initializeOauth(setOptions?.forgerock);
         userStore = initializeUser(setOptions?.forgerock);
 

packages/login-widget/src/lib/_utilities/api.utilities.ts

@@ -20,7 +20,7 @@ import type { journeyConfigSchema } from '$journey/config.store';
 import type { partialLinksSchema } from '$core/links.store';
 import type { partialStringsSchema } from '$core/locale.store';
 import type { partialStyleSchema } from '$core/style.store';
-import { journeyClientConfigSchema } from '$core/journey-client.config';
+import { journeyClientConfigSchema } from '$journey/journey.store';
 
 export interface JourneyOptions {
   oauth?: boolean; // defaults to true