refactor: update user profile handling in AppInitializer and improve fetchFn error handling

Author: paustint

apps/jetstream-canvas/src/app/core/AppInitializer.tsx

@@ -2,7 +2,7 @@
 import { logger } from '@jetstream/shared/client-logger';
 import { getCanvasPreferences, updateCanvasPreferences } from '@jetstream/shared/data';
 import { useObservable } from '@jetstream/shared/ui-utils';
-import { JetstreamEventSaveSoqlQueryFormatOptionsPayload, UserProfileUi } from '@jetstream/types';
+import { JetstreamEventSaveSoqlQueryFormatOptionsPayload } from '@jetstream/types';
 import { AppLoading, fromJetstreamEvents } from '@jetstream/ui-core';
 import { fromAppState } from '@jetstream/ui/app-state';
 import { initDexieDb } from '@jetstream/ui/db';
@@ -59,10 +59,18 @@ export const AppInitializer: FunctionComponent<AppInitializerProps> = ({ allowWi
         const org = getCanvasOrg();
         const preferences = await getCanvasPreferences(org);
         if (preferences && Object.keys(preferences).length > 0) {
-          setUserProfile((prev: UserProfileUi) => ({
-            ...prev,
-            preferences: { ...prev.preferences, ...preferences },
-          }));
+          setUserProfile((prev) => {
+            if (prev instanceof Promise) {
+              return prev.then((resolved) => ({
+                ...resolved,
+                preferences: { ...resolved.preferences, ...preferences },
+              }));
+            }
+            return {
+              ...prev,
+              preferences: { ...prev.preferences, ...preferences },
+            };
+          });
         }
       } catch (ex) {
         logger.error('Error loading canvas preferences', ex);
@@ -78,10 +86,18 @@ export const AppInitializer: FunctionComponent<AppInitializerProps> = ({ allowWi
           const org = getCanvasOrg();
           const soqlQueryFormatOptions = onSaveSoqlQueryFormatOptions.value;
           await updateCanvasPreferences(org, { soqlQueryFormatOptions });
-          setUserProfile((prev: UserProfileUi) => ({
-            ...prev,
-            preferences: { ...prev.preferences, soqlQueryFormatOptions },
-          }));
+          setUserProfile((prev) => {
+            if (prev instanceof Promise) {
+              return prev.then((resolved) => ({
+                ...resolved,
+                preferences: { ...resolved.preferences, soqlQueryFormatOptions },
+              }));
+            }
+            return {
+              ...prev,
+              preferences: { ...prev.preferences, soqlQueryFormatOptions },
+            };
+          });
         } catch (ex) {
           logger.error('Error saving query format options', ex);
         }

apps/jetstream-canvas/src/controllers/route.utils.ts

@@ -81,7 +81,7 @@ export function createRoute<TParamsSchema extends z.ZodTypeAny, TBodySchema exte
     try {
       const data = {
         params: params ? params.parse(req.params) : undefined,
-        body: body && parsedBody ? body.parse(parsedBody) : undefined,
+        body: body && parsedBody !== undefined ? body.parse(parsedBody) : undefined,
         query: query ? query.parse(queryParams) : undefined,
         jetstreamConn: req.jetstreamConn,
         targetJetstreamConn: req.targetJetstreamConn,

apps/jetstream-canvas/src/utils/api-client.ts

@@ -7,11 +7,12 @@ import { OrgAndApiConnection } from './canvas.types';
 export const fetchFn: Parameters<typeof getApiRequestFactoryFn>[0] = (url, options) => {
   return new Promise<Response>((resolve, reject) => {
     const headers = (options.headers as Record<string, string>) || {};
+    const contentType = Object.entries(headers).find(([key]) => key.toLowerCase() === 'content-type')?.[1] || 'application/json';
     window.Sfdc.canvas.client.ajax(url, {
       client: sr.client,
       method: options.method,
       async: true,
-      contentType: headers['content-type'] || 'application/json',
+      contentType,
       headers,
       data: options.body,
       // targetOrigin
@@ -21,8 +22,8 @@ export const fetchFn: Parameters<typeof getApiRequestFactoryFn>[0] = (url, optio
         // based on the caller-specified `outputType`, not content-type headers.
         resolve(new Response(payload, { status, statusText }));
       },
-      failure: ({ status, statusText }) => {
-        reject(new Error(`Canvas AJAX failed: ${status} ${statusText}`));
+      failure: (responseText, xhr) => {
+        reject(new Error(`Canvas AJAX failed: ${xhr.status} ${responseText}`));
       },
     });
   });

libs/types/src/lib/salesforce/canvas.types.ts

@@ -614,6 +614,14 @@ export interface SfdcCanvasXd {
 /** `Sfdc.canvas.client.ajax` settings inferred from defaults + code */
 export interface SfdcCanvasClientAjaxSettings {
   success: (response: SfdcCanvasClientResponse<any>) => void;
+  /** Called when the XHR returns a non-2xx/304 status or on network error. */
+  failure?: (responseText: string, xhr: XMLHttpRequest, config: SfdcCanvasClientAjaxSettings) => void;
+  /** Called before the request is sent. Return `false` to cancel. */
+  beforerequest?: () => boolean;
+  /** Called after success or failure, regardless of outcome. */
+  complete?: (responseText: string, xhr: XMLHttpRequest, config: SfdcCanvasClientAjaxSettings) => void;
+  /** The `this` context used when invoking success/failure/complete callbacks. */
+  context?: any;
 
   client: SfdcCanvasOAuthClient;