@salesforce/lds-network-fetch 1.412.1 → 1.414.0

package/dist/ldsNetworkFetch.js

@@ -12,7 +12,7 @@
  *  *******************************************************************************************
  */
 /* proxy-compat-disable */
-import { UIAPI_GET_LAYOUT, UIAPI_GET_LAYOUT_USER_STATE, UIAPI_OBJECT_INFO_BATCH_PATH, UIAPI_OBJECT_INFO_PATH, shouldForceRefresh, createOkResponse as createOkResponse$1, layoutUserStateStorage, layoutUserStateStorageStatsLogger, layoutStorage, layoutStorageStatsLogger, objectInfoStorage, objectInfoStorageStatsLogger, getTransactionKey as getTransactionKey$1 } from 'force/ldsNetwork';
+import { UIAPI_GET_LAYOUT, UIAPI_GET_LAYOUT_USER_STATE, UIAPI_OBJECT_INFO_BATCH_PATH, UIAPI_OBJECT_INFO_PATH, shouldForceRefresh, layoutUserStateStorage, layoutUserStateStorageStatsLogger, layoutStorage, layoutStorageStatsLogger, objectInfoStorage, objectInfoStorageStatsLogger, getTransactionKey as getTransactionKey$1, createOkResponse as createOkResponse$1 } from 'force/ldsNetwork';
 import { HttpStatusCode as HttpStatusCode$1 } from 'force/luvioEngine';
 
 var SnapshotState;
@@ -270,7 +270,7 @@ const { join, push, unshift } = Array.prototype;
 const { isArray } = Array;
 const { entries, keys } = Object;
 
-const UI_API_BASE_URI = '/services/data/v66.0/ui-api';
+const UI_API_BASE_URI = '/services/data/v67.0/ui-api';
 
 const LDS_RECORDS_AGGREGATE_UI = 'LDS_Records_AggregateUi';
 // Boundary which represents the limit that we start chunking at,
@@ -739,61 +739,24 @@ function getStorageAndLogger(path) {
     return null;
 }
 const platformFetchAdapter = platformNetworkAdapter(fetchNetworkAdapter);
-const platformFetchAdapterWithInterceptors = async (resourceRequest, resourceRequestContext, requestInterceptors) => {
-    const pending = requestInterceptors.reduce((previousPromise, interceptor) => previousPromise.then(interceptor), resolvedPromiseLike(resourceRequest));
+const platformFetchAdapterWithInterceptors = async (resourceRequest, resourceRequestContext, requestInterceptors, interceptorContext) => {
+    const pending = requestInterceptors.reduce((previousPromise, interceptor) => previousPromise.then((resourceRequest) => interceptor(resourceRequest, interceptorContext)), resolvedPromiseLike(resourceRequest));
     return pending.then((interceptedRequest) => platformFetchAdapter(interceptedRequest, resourceRequestContext));
 };
-/**
- * Helper function to fetch data, if available in aura storage cache returns that instead of going to network.
- * @param resourceRequest - {@link ResourceRequest}
- * @param resourceRequestContext {@link ResourceRequestContext}
- * @param storageAndLogger - Object containing a reference to aura storage/logger
- * @param transactionKey - The transaction key, derived from the resource request params.
- * @returns Promise<FetchResponse<any> - Promise that resolves to a fetch response.
- */
-function checkLdsStorageCacheOrFetch(resourceRequest, resourceRequestContext, storageAndLogger, transactionKey, requestInterceptors = []) {
+async function getDurableCacheDataForIncomingRequest(resourceRequest, storageAndLogger, transactionKey) {
     if (!shouldForceRefresh(resourceRequest)) {
         if (storageAndLogger?.storage) {
             return storageAndLogger.storage.get(transactionKey).then((cacheResult) => {
                 if (cacheResult !== undefined) {
                     storageAndLogger.statsLogger.logHits();
-                    // This creates an AuraFetchResponse, should it just be FetchResponse?
-                    return createOkResponse$1(cacheResult);
                 }
                 storageAndLogger.statsLogger.logMisses();
-                return platformFetchAdapterWithInterceptors(resourceRequest, resourceRequestContext, requestInterceptors);
-            }, () => {
-                return platformFetchAdapterWithInterceptors(resourceRequest, resourceRequestContext, requestInterceptors);
+                return cacheResult;
             });
         }
     }
-    return platformFetchAdapterWithInterceptors(resourceRequest, resourceRequestContext, requestInterceptors);
-}
-// Copied from requestId generation on core
-function generateRequestId() {
-    function guid() {
-        function s4() {
-            return Math.floor((1 + Math.random()) * 0x10000)
-                .toString(16)
-                .substring(1);
-        }
-        return s4() + s4();
-    }
-    return [
-        Math.round(window.performance.now() * 1000000),
-        guid(),
-        Math.round(Math.random() * 100000000),
-    ]
-        .join('')
-        .substring(0, 18);
 }
 
-// noop implementation for when one is not provided
-let internalRequestTracker = {
-    hasTracker: () => false,
-    registerHandler: (_request, _name, _loadedCheck) => { },
-    markFinished: (_request) => { },
-};
 // noop implementation for when one is not provided
 let internalRequestLogger = {
     resolve: (_request, _response) => { },
@@ -815,18 +778,22 @@ function setupFetchNetworkAdapter() {
  * @param resourceRequestContext {@link ResourceRequestContext}
  * @returns Promise<FetchResponse<any>>
  */
-function handleSendFetchRequest(resourceRequest, resourceRequestContext, interceptors) {
+async function handleSendFetchRequest(resourceRequest, resourceRequestContext, interceptors) {
     const { baseUri, basePath } = resourceRequest;
     const path = `${baseUri}${basePath}`;
     const storageAndLogger = getStorageAndLogger(path);
     const transactionKey = getTransactionKey$1(resourceRequest);
-    const trackerId = generateRequestId();
-    const response = checkLdsStorageCacheOrFetch(resourceRequest, resourceRequestContext, storageAndLogger, transactionKey, interceptors.request);
-    internalRequestTracker.registerHandler(trackerId, 'lds-inflight-network-request', () => {
-        // return false until we signal we are finished
-        return false;
-    });
-    const interceptedResponse = Promise.resolve(interceptors.response.reduce((previousPromise, interceptor) => previousPromise.then(interceptor), resolvedPromiseLike(response)));
+    // Create context per request if factory is provided
+    const context = interceptors.createContext?.();
+    const { request: requestInterceptors = [], response: responseInterceptors = [], finally: finallyInterceptors = [], } = interceptors;
+    const cachedData = await getDurableCacheDataForIncomingRequest(resourceRequest, storageAndLogger, transactionKey);
+    if (cachedData !== undefined) {
+        return createOkResponse$1(cachedData);
+    }
+    const response = platformFetchAdapterWithInterceptors(resourceRequest, resourceRequestContext, requestInterceptors, context);
+    const interceptedResponse = Promise.resolve(responseInterceptors.reduce((previousPromise, interceptor) => previousPromise.then((response) => interceptor(response, context)), resolvedPromiseLike(response)));
+    // This can probably be refactored once we add an error interceptor pattern to onestore, and then
+    // the intial then here can also most likely be moved to a response interceptor as well
     interceptedResponse
         .then((value) => {
         if (storageAndLogger !== null && storageAndLogger.storage !== null) {
@@ -838,22 +805,19 @@ function handleSendFetchRequest(resourceRequest, resourceRequestContext, interce
         internalRequestLogger.reject(resourceRequest, error);
     });
     return interceptedResponse.finally(() => {
-        internalRequestTracker.markFinished(trackerId);
+        return finallyInterceptors.reduce((previousPromise, interceptor) => previousPromise.then(() => interceptor(context)), Promise.resolve());
     });
 }
 /**
  * Wrapper around fetch network adapter from luvio
  *
- * @param requestTracker
  * @param requestLogger
  * @returns lexNetworkAdapter {@link NetworkAdapter}
  */
-function setupLexNetworkAdapter(requestTracker, requestLogger, interceptors) {
-    internalRequestTracker =
-        requestTracker && requestTracker.hasTracker() ? requestTracker : internalRequestTracker;
+function setupLexNetworkAdapter(requestLogger, interceptors) {
     internalRequestLogger = requestLogger || internalRequestLogger;
     return async (resourceRequest, resourceRequestContext) => {
-        return handleSendFetchRequest(resourceRequest, resourceRequestContext, interceptors ?? { request: [], response: [] });
+        return handleSendFetchRequest(resourceRequest, resourceRequestContext, interceptors ?? {});
     };
 }
 
@@ -875,5 +839,5 @@ function instrument(newInstrumentation) {
     Object.assign(instrumentation, newInstrumentation);
 }
 
-export { generateRequestId, instrument, internalRequestTracker, setupFetchNetworkAdapter, setupLexNetworkAdapter };
-// version: 1.412.1-054d9a1111
+export { instrument, setupFetchNetworkAdapter, setupLexNetworkAdapter };
+// version: 1.414.0-ff06871479

package/dist/types/main.d.ts

@@ -1,5 +1,4 @@
-export { internalRequestTracker, setupFetchNetworkAdapter, setupLexNetworkAdapter, } from './networkAdapter';
-export type { RequestLogger, RequestTracker } from './networkAdapter';
-export { generateRequestId } from './utils';
+export { setupFetchNetworkAdapter, setupLexNetworkAdapter } from './networkAdapter';
+export type { RequestLogger } from './networkAdapter';
 export type { RequestInterceptor, ResponseInterceptor, Interceptors } from './utils';
 export { instrument, FetchNetworkInstrumentation } from './instrumentation';

package/dist/types/networkAdapter.d.ts

@@ -1,19 +1,9 @@
 import type { NetworkAdapter, ResourceRequest } from '@luvio/engine';
 import { Interceptors } from './utils';
-export type RequestTracker = {
-    hasTracker: () => boolean;
-    registerHandler: (request: any, name: string, loadedCheck: () => boolean) => void;
-    markFinished: (request: any) => void;
-};
-export declare let internalRequestTracker: RequestTracker;
 export type RequestLogger = {
     resolve: (request: ResourceRequest, response: any) => void;
     reject: (request: ResourceRequest, error: Error) => void;
 };
-export declare function getTrackerAndLoggerForTest(): {
-    tracker: RequestTracker;
-    logger: RequestLogger;
-};
 /**
  * Wrapper around fetch network adapter from luvio
  *
@@ -23,8 +13,7 @@ export declare function setupFetchNetworkAdapter(): NetworkAdapter;
 /**
  * Wrapper around fetch network adapter from luvio
  *
- * @param requestTracker
  * @param requestLogger
  * @returns lexNetworkAdapter {@link NetworkAdapter}
  */
-export declare function setupLexNetworkAdapter(requestTracker?: RequestTracker, requestLogger?: RequestLogger, interceptors?: Interceptors): NetworkAdapter;
+export declare function setupLexNetworkAdapter(requestLogger?: RequestLogger, interceptors?: Interceptors): NetworkAdapter;

package/dist/types/utils.d.ts

@@ -11,20 +11,15 @@ type LdsStorageConfig = {
  * @returns LdsStorageConfig if we cache that resource, otherwise null.
  */
 export declare function getStorageAndLogger(path: string): LdsStorageConfig | null;
-export type RequestInterceptor = (fetchArgs: ResourceRequest) => PromiseLike<ResourceRequest>;
-export type ResponseInterceptor = (response: FetchResponse<any>) => PromiseLike<FetchResponse<any>>;
-export type Interceptors = {
-    request: RequestInterceptor[];
-    response: ResponseInterceptor[];
+export type RequestInterceptor<Context = any> = (fetchArgs: ResourceRequest, context?: Context) => PromiseLike<ResourceRequest>;
+export type ResponseInterceptor<Context = any> = (response: FetchResponse<any>, context?: Context) => PromiseLike<FetchResponse<any>>;
+export type FinallyInterceptor<Context = any> = (context?: Context) => PromiseLike<void> | void;
+export type Interceptors<Context = any> = {
+    createContext?: () => Context;
+    request?: RequestInterceptor<Context>[];
+    response?: ResponseInterceptor<Context>[];
+    finally?: FinallyInterceptor<Context>[];
 };
-/**
- * Helper function to fetch data, if available in aura storage cache returns that instead of going to network.
- * @param resourceRequest - {@link ResourceRequest}
- * @param resourceRequestContext {@link ResourceRequestContext}
- * @param storageAndLogger - Object containing a reference to aura storage/logger
- * @param transactionKey - The transaction key, derived from the resource request params.
- * @returns Promise<FetchResponse<any> - Promise that resolves to a fetch response.
- */
-export declare function checkLdsStorageCacheOrFetch(resourceRequest: ResourceRequest, resourceRequestContext: ResourceRequestContext, storageAndLogger: LdsStorageConfig | null, transactionKey: string, requestInterceptors?: RequestInterceptor[]): Promise<FetchResponse<any>>;
-export declare function generateRequestId(): string;
+export declare const platformFetchAdapterWithInterceptors: (resourceRequest: ResourceRequest, resourceRequestContext: ResourceRequestContext, requestInterceptors: RequestInterceptor[], interceptorContext: any) => Promise<FetchResponse<any>>;
+export declare function getDurableCacheDataForIncomingRequest(resourceRequest: ResourceRequest, storageAndLogger: LdsStorageConfig | null, transactionKey: string): Promise<unknown>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-network-fetch",
-    "version": "1.412.1",
+    "version": "1.414.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS Network Adapter using fetch",
     "main": "dist/ldsNetworkFetch.js",
@@ -38,6 +38,6 @@
         "@luvio/network-adapter-fetch": "0.158.7"
     },
     "devDependencies": {
-        "@salesforce/lds-network-aura": "^1.412.1"
+        "@salesforce/lds-network-aura": "^1.414.0"
     }
 }