@salesforce/lds-runtime-aura 1.290.0 → 1.291.0

package/dist/ldsEngineCreator.js

@@ -16,6 +16,7 @@ import { HttpStatusCode, InMemoryStore as InMemoryStore$1, Environment, Luvio, I
 import ldsTrackedFieldsBehaviorGate from '@salesforce/gate/lds.useNewTrackedFieldBehavior';
 import usePredictiveLoading from '@salesforce/gate/lds.usePredictiveLoading';
 import useRelatedListsPredictions from '@salesforce/gate/lds.pdl.useRelatedListsPredictions';
+import applyPredictionRequestLimit from '@salesforce/gate/lds.pdl.applyRequestLimit';
 import { instrument, getRecordAvatarsAdapterFactory, getRecordAdapterFactory, coerceFieldIdArray, getRecordsAdapterFactory, getRecordActionsAdapterFactory, getObjectInfosAdapterFactory, coerceObjectIdArray, getObjectInfoAdapterFactory, coerceObjectId, getRelatedListsActionsAdapterFactory, getRelatedListInfoBatchAdapterFactory, getRelatedListRecordsBatchAdapterFactory, getRelatedListRecordsAdapterFactory, configuration, InMemoryRecordRepresentationQueryEvaluator, UiApiNamespace, RecordRepresentationRepresentationType, registerPrefetcher } from 'force/ldsAdaptersUiapi';
 import { withRegistration as withRegistration$1 } from 'force/luvioRegistry3';
 import oneStoreEnabled from '@salesforce/gate/lds.oneStoreEnabled.ltng';
@@ -1359,9 +1360,10 @@ function logCRUDLightningInteraction(eventSource, attributes) {
 const instrumentation = new Instrumentation();
 
 class ApplicationPredictivePrefetcher {
-    constructor(context, repository, requestRunner) {
+    constructor(context, repository, requestRunner, options) {
         this.repository = repository;
         this.requestRunner = requestRunner;
+        this.options = options;
         this.isRecording = false;
         this.queuedPredictionRequests = [];
         this._context = context;
@@ -1394,17 +1396,23 @@ class ApplicationPredictivePrefetcher {
         }, PDL_EXECUTE_ASYNC_OPTIONS);
     }
     async predict() {
-        const exactPageRequests = (await this.repository.getPageRequests(this.context)) || [];
-        const similarPageRequests = await this.getSimilarPageRequests();
         const alwaysRequests = this.page.getAlwaysRunRequests();
-        const predictedRequests = [
-            ...alwaysRequests,
-            ...this.requestRunner.reduceRequests([
-                ...exactPageRequests,
-                ...similarPageRequests,
-                ...this.page.getAlwaysRunRequests(),
-            ]),
-        ];
+        const similarPageRequests = await this.getSimilarPageRequests();
+        const exactPageRequests = (await this.repository.getPageRequests(this.context)) || [];
+        // Runs all reducers, then limits the total # of requests, prioritizing earlier requests over later ones.
+        const alwaysRequestEntries = alwaysRequests.map((request) => {
+            return {
+                request,
+                requestMetadata: { requestTime: 0 },
+            };
+        });
+        const reducedRequests = this.requestRunner
+            .reduceRequests([...exactPageRequests, ...similarPageRequests, ...alwaysRequestEntries]) // In future - remove alwaysRequestEntries when on OneStore
+            .sort((a, b) => a.requestMetadata.requestTime - b.requestMetadata.requestTime) // In future - choose sort algorithm via Gate?
+            .slice(0, this.options.inflightRequestLimit - alwaysRequests.length)
+            .map((entry) => entry.request);
+        // Always requests can't be reduced in - Some of them are essential to keep the page rendering at the beginning.
+        const predictedRequests = [...alwaysRequests, ...reducedRequests];
         this.queuedPredictionRequests.push(...predictedRequests);
         return Promise.all(predictedRequests.map((request) => this.requestRunner.runRequest(request))).then();
     }
@@ -1424,7 +1432,12 @@ class ApplicationPredictivePrefetcher {
         if (this.page.similarContext !== undefined) {
             const similarPageRequests = this.repository.getPageRequests(this.page.similarContext);
             if (similarPageRequests !== undefined) {
-                resolvedSimilarPageRequests = similarPageRequests.map((request) => this.page.resolveSimilarRequest(request));
+                resolvedSimilarPageRequests = similarPageRequests.map((entry) => {
+                    return {
+                        ...entry,
+                        request: this.page.resolveSimilarRequest(entry.request),
+                    };
+                });
             }
         }
         return resolvedSimilarPageRequests;
@@ -1435,8 +1448,8 @@ class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
     constructor(context, repository, requestRunner, 
     // These strategies need to be in sync with the "predictiveDataLoadCapable" list
     // from scripts/lds-uiapi-plugin.js
-    requestStrategies) {
-        super(context, repository, requestRunner);
+    requestStrategies, options) {
+        super(context, repository, requestRunner, options);
         this.requestStrategies = requestStrategies;
         this.page = this.getPage();
     }
@@ -1590,7 +1603,7 @@ class PrefetchRepository {
         if (page === undefined) {
             return [];
         }
-        return page.requests.map((requestEntry) => requestEntry.request);
+        return page.requests;
     }
 }
 
@@ -1623,7 +1636,7 @@ class LuvioAdapterRequestStrategy extends RequestStrategy {
      * @returns
      */
     filterRequests(unfilteredRequests) {
-        return unfilteredRequests.filter((request) => request.adapterName === this.adapterName);
+        return unfilteredRequests.filter((entry) => entry.request.adapterName === this.adapterName);
     }
     /**
      * Reduce requests by combining those based on a strategies implementations
@@ -1641,9 +1654,15 @@ class LuvioAdapterRequestStrategy extends RequestStrategy {
                 const combinedRequest = { ...currentRequest };
                 for (let j = i + 1; j < n; j++) {
                     const hasNotBeenVisited = !visitedRequests.has(requests[j]);
-                    const canCombineConfigs = this.canCombine(combinedRequest.config, requests[j].config);
+                    const canCombineConfigs = this.canCombine(combinedRequest.request.config, requests[j].request.config);
                     if (hasNotBeenVisited && canCombineConfigs) {
-                        combinedRequest.config = this.combineRequests(combinedRequest.config, requests[j].config);
+                        combinedRequest.request.config = this.combineRequests(combinedRequest.request.config, requests[j].request.config);
+                        if (combinedRequest.requestMetadata.requestTime >
+                            requests[j].requestMetadata.requestTime) {
+                            // This logic is debateable - Currently this always assigns the lowest requestTime to a reduced request.
+                            combinedRequest.requestMetadata.requestTime =
+                                requests[j].requestMetadata.requestTime;
+                        }
                         visitedRequests.add(requests[j]);
                     }
                 }
@@ -2028,13 +2047,13 @@ class GetObjectInfoRequestStrategy extends LuvioAdapterRequestStrategy {
      * @returns
      */
     reduce(unfilteredRequests) {
-        const objectApiNamesInBatchRequest = unfilteredRequests.filter((request) => request.adapterName === GET_OBJECT_INFO_BATCH_ADAPTER_NAME).reduce((acc, { config }) => {
-            config.objectApiNames.forEach((apiName) => acc.add(apiName));
+        const objectApiNamesInBatchRequest = unfilteredRequests.filter((entry) => entry.request.adapterName === GET_OBJECT_INFO_BATCH_ADAPTER_NAME).reduce((acc, { request }) => {
+            request.config.objectApiNames.forEach((apiName) => acc.add(apiName));
             return acc;
         }, new Set());
         const singleRequests = this.filterRequests(unfilteredRequests);
-        return singleRequests.filter((request) => {
-            return !objectApiNamesInBatchRequest.has(request.config.objectApiName);
+        return singleRequests.filter((singleEntry) => {
+            return !objectApiNamesInBatchRequest.has(singleEntry.request.config.objectApiName);
         });
     }
 }
@@ -2234,19 +2253,19 @@ class GetRelatedListRecordsRequestStrategy extends LuvioAdapterRequestStrategy {
      */
     reduce(unfilteredRequests) {
         // Batch requests by [parentRecordId]->[RelatedListIds]
-        const batchRequests = unfilteredRequests.filter((request) => request.adapterName === GET_RELATED_LIST_RECORDS_BATCH_ADAPTER_NAME).reduce((acc, request) => {
+        const batchRequests = unfilteredRequests.filter((entry) => entry.request.adapterName === GET_RELATED_LIST_RECORDS_BATCH_ADAPTER_NAME).reduce((acc, entry) => {
             // required properties, enforced by adapter typecheck
-            const { parentRecordId, relatedListParameters } = request.config;
+            const { parentRecordId, relatedListParameters } = entry.request.config;
             const existingRlSet = acc.get(parentRecordId) || new Set();
             // relatedListId enforced by adapter typecheck
             relatedListParameters.forEach((rlParam) => existingRlSet.add(rlParam.relatedListId));
             acc.set(parentRecordId, existingRlSet);
             return acc;
         }, new Map());
-        const singleRequests = unfilteredRequests.filter((request) => request.adapterName === this.adapterName);
-        return singleRequests.filter((request) => {
+        const singleRequests = unfilteredRequests.filter((entry) => entry.request.adapterName === this.adapterName);
+        return singleRequests.filter((entry) => {
             // required props enforced by adapter typecheck
-            const { parentRecordId, relatedListId } = request.config;
+            const { parentRecordId, relatedListId } = entry.request.config;
             const batchForParentRecordId = batchRequests.get(parentRecordId);
             return !(batchForParentRecordId && batchForParentRecordId.has(relatedListId));
         });
@@ -2531,10 +2550,14 @@ function setupQueryEvaluators(luvio, store) {
     luvio.registerTypeQueryEvaluator(UiApiNamespace, RecordRepresentationRepresentationType, recordRepresentationQueryEvaluator);
 }
 let __lexPrefetcher;
+const HARDCODED_REQUEST_LIMIT = 9;
 function setupPredictivePrefetcher(luvio) {
     const storage = buildAuraPrefetchStorage();
     const repository = new PrefetchRepository(storage);
     const requestRunner = new LexRequestRunner(luvio);
+    const inflightRequestLimit = applyPredictionRequestLimit.isOpen({ fallback: false })
+        ? HARDCODED_REQUEST_LIMIT
+        : 1000;
     const prefetcher = new LexPredictivePrefetcher({ context: 'unknown' }, repository, requestRunner, {
         getRecord: new GetRecordRequestStrategy(),
         getRecords: new GetRecordsRequestStrategy(),
@@ -2546,6 +2569,8 @@ function setupPredictivePrefetcher(luvio) {
         getRelatedListRecords: new GetRelatedListRecordsRequestStrategy(),
         getRelatedListRecordsBatch: new GetRelatedListRecordsBatchRequestStrategy(),
         getRelatedListInfoBatch: new GetRelatedListInfoBatchRequestStrategy(),
+    }, {
+        inflightRequestLimit,
     });
     registerPrefetcher(luvio, prefetcher);
     __lexPrefetcher = prefetcher;
@@ -2682,4 +2707,4 @@ function ldsEngineCreator() {
 }
 
 export { buildPredictorForContext, ldsEngineCreator as default, initializeLDS, initializeOneStore };
-// version: 1.290.0-18c27a6e9
+// version: 1.291.0-8df6969f6

package/dist/types/predictive-loading/common/index.d.ts

@@ -2,3 +2,9 @@ export declare const PDL_EXECUTE_ASYNC_OPTIONS: {
     LOG_ERROR_ONLY: boolean;
     ERROR_SCOPE: string;
 };
+export type RequestEntry<Request> = {
+    request: Request;
+    requestMetadata: {
+        requestTime: number;
+    };
+};

package/dist/types/predictive-loading/prefetcher/lex-predictive-prefetcher.d.ts

@@ -1,4 +1,5 @@
 import type { DefaultPageContext, PredictivePrefetchPage } from '../pages';
+import type { PrefetcherOptions } from './predictive-prefetcher';
 import { ApplicationPredictivePrefetcher } from './predictive-prefetcher';
 import type { GetRecordActionsRequestStrategy, GetRecordAvatarsRequestStrategy, GetRecordRequestStrategy, GetRecordsRequestStrategy, GetObjectInfoRequestStrategy, GetObjectInfosRequestStrategy, GetRelatedListsActionsRequestStrategy, GetRelatedListInfoBatchRequestStrategy, GetRelatedListRecordsRequestStrategy, GetRelatedListRecordsBatchRequestStrategy } from '../request-strategy';
 import type { RequestRunner } from '../request-runner';
@@ -19,6 +20,6 @@ export declare class LexPredictivePrefetcher extends ApplicationPredictivePrefet
         getRelatedListInfoBatch: GetRelatedListInfoBatchRequestStrategy;
         getRelatedListRecords: GetRelatedListRecordsRequestStrategy;
         getRelatedListRecordsBatch: GetRelatedListRecordsBatchRequestStrategy;
-    });
+    }, options: PrefetcherOptions);
     getPage(): PredictivePrefetchPage<LexRequest, LexContext>;
 }

package/dist/types/predictive-loading/prefetcher/predictive-prefetcher.d.ts

@@ -1,14 +1,19 @@
 import type { PrefetchRepository } from '../repository/prefetch-repository';
 import type { PredictivePrefetchPage } from '../pages';
 import type { RequestRunner } from '../request-runner';
+import type { RequestEntry } from '../common';
+export type PrefetcherOptions = {
+    inflightRequestLimit: number;
+};
 export declare abstract class ApplicationPredictivePrefetcher<Request, Context extends Record<string, any>> {
     private repository;
     private requestRunner;
+    protected options: PrefetcherOptions;
     private _context;
     isRecording: boolean;
     page: PredictivePrefetchPage<Request, Context>;
     queuedPredictionRequests: Request[];
-    constructor(context: Context, repository: PrefetchRepository, requestRunner: RequestRunner<Request>);
+    constructor(context: Context, repository: PrefetchRepository, requestRunner: RequestRunner<Request>, options: PrefetcherOptions);
     abstract getPage(): PredictivePrefetchPage<Request, Context>;
     set context(value: Context);
     get context(): Context;
@@ -21,5 +26,5 @@ export declare abstract class ApplicationPredictivePrefetcher<Request, Context e
         similar: number;
     };
     hasPredictions(): boolean;
-    getSimilarPageRequests(): Request[];
+    getSimilarPageRequests(): RequestEntry<Request>[];
 }

package/dist/types/predictive-loading/repository/prefetch-repository.d.ts

@@ -1,4 +1,5 @@
 import type { PrefetchStorage } from '../storage';
+import type { RequestEntry } from '../common';
 type Key = Record<string, any>;
 export type History = {
     version: '1.0';
@@ -8,12 +9,6 @@ export type PageEntry<Request> = {
     id: string;
     requests: RequestEntry<Request>[];
 };
-export type RequestEntry<Request> = {
-    request: Request;
-    requestMetadata: {
-        requestTime: number;
-    };
-};
 export declare class PrefetchRepository {
     private storage;
     private requestBuffer;
@@ -23,6 +18,6 @@ export declare class PrefetchRepository {
     getKeyId(key: Key): string;
     saveRequest<Request>(key: Key, request: Request): Promise<void>;
     getPage<Request>(key: Key): PageEntry<Request> | undefined;
-    getPageRequests<Request>(key: Key): Request[];
+    getPageRequests<Request>(key: Key): RequestEntry<Request>[];
 }
 export {};

package/dist/types/predictive-loading/request-runner/lex-request-runner.d.ts

@@ -1,10 +1,11 @@
 import type { Luvio } from '@luvio/engine';
 import type { LexRequest } from '../prefetcher';
 import type { RequestRunner } from './request-runner';
+import type { RequestEntry } from '../common';
 export declare class LexRequestRunner implements RequestRunner<LexRequest> {
     private luvio;
     private requestStrategies;
     constructor(luvio: Luvio);
-    reduceRequests(requests: LexRequest[]): LexRequest[];
+    reduceRequests(requests: RequestEntry<LexRequest>[]): RequestEntry<LexRequest>[];
     runRequest(request: LexRequest): Promise<void>;
 }

package/dist/types/predictive-loading/request-runner/request-runner.d.ts

@@ -1,4 +1,5 @@
+import type { RequestEntry } from '../common';
 export type RequestRunner<Request> = {
     runRequest(request: Request): Promise<void>;
-    reduceRequests(requests: Request[]): Request[];
+    reduceRequests(requests: RequestEntry<Request>[]): RequestEntry<Request>[];
 };

package/dist/types/predictive-loading/request-strategy/get-object-info-request-strategy.d.ts

@@ -1,6 +1,7 @@
 import type { GetObjectInfoConfig } from '@salesforce/lds-adapters-uiapi';
 import type { LuvioAdapterRequest } from './luvio-adapter-request';
 import { LuvioAdapterRequestStrategy } from './luvio-adapter-request-strategy';
+import type { RequestEntry } from '../common';
 export type GetObjectInfoRequest = {
     adapterName: 'getObjectInfo';
     config: GetObjectInfoConfig;
@@ -24,5 +25,5 @@ export declare class GetObjectInfoRequestStrategy extends LuvioAdapterRequestStr
      * @param unfilteredRequests all prediction requests
      * @returns
      */
-    reduce(unfilteredRequests: LuvioAdapterRequest<unknown>[]): GetObjectInfoRequest[];
+    reduce(unfilteredRequests: RequestEntry<LuvioAdapterRequest<unknown>>[]): RequestEntry<GetObjectInfoRequest>[];
 }

package/dist/types/predictive-loading/request-strategy/get-related-list-records-request-strategy.d.ts

@@ -1,6 +1,7 @@
 import type { GetRelatedListRecordsConfig } from '@salesforce/lds-adapters-uiapi';
 import type { LuvioAdapterRequest } from './luvio-adapter-request';
 import { LuvioAdapterRequestStrategy } from './luvio-adapter-request-strategy';
+import type { RequestEntry } from '../common';
 export type GetRelatedListRecordsRequest = {
     adapterName: 'getRelatedListRecords';
     config: GetRelatedListRecordsConfig;
@@ -25,7 +26,7 @@ export declare class GetRelatedListRecordsRequestStrategy extends LuvioAdapterRe
      * @param unfilteredRequests All of the request available for predictions.
      * @returns GetRelatedListRecordsRequest[] That should be a prediction.
      */
-    reduce(unfilteredRequests: LuvioAdapterRequest<unknown>[]): GetRelatedListRecordsRequest[];
+    reduce(unfilteredRequests: RequestEntry<LuvioAdapterRequest<unknown>>[]): RequestEntry<GetRelatedListRecordsRequest>[];
     buildSaveRequestData<C extends GetRelatedListRecordsContext>(similarContext: C, context: C, request: GetRelatedListRecordsRequest): {
         request: GetRelatedListRecordsRequest;
         context: C;

package/dist/types/predictive-loading/request-strategy/luvio-adapter-request-strategy.d.ts

@@ -1,6 +1,7 @@
 import type { AdapterFactory } from '@luvio/engine';
 import { RequestStrategy } from './request-strategy';
 import type { LuvioAdapterRequest } from './luvio-adapter-request';
+import type { RequestEntry } from '../common';
 export declare abstract class LuvioAdapterRequestStrategy<AdapterConfig, Request extends LuvioAdapterRequest<AdapterConfig>, Context> extends RequestStrategy<Request, Context> {
     /**
      * Name of the adapter used in this strategy.
@@ -26,14 +27,14 @@ export declare abstract class LuvioAdapterRequestStrategy<AdapterConfig, Request
      * @param unfilteredRequests array of requests to filter
      * @returns
      */
-    protected filterRequests(unfilteredRequests: LuvioAdapterRequest<unknown>[]): Request[];
+    protected filterRequests(unfilteredRequests: RequestEntry<LuvioAdapterRequest<unknown>>[]): RequestEntry<Request>[];
     /**
      * Reduce requests by combining those based on a strategies implementations
      * of canCombine and combineRequests.
      * @param unfilteredRequests array of requests to filter
      * @returns
      */
-    reduce(unfilteredRequests: LuvioAdapterRequest<unknown>[]): Request[];
+    reduce(unfilteredRequests: RequestEntry<LuvioAdapterRequest<unknown>>[]): RequestEntry<Request>[];
     /**
      * Check if two requests can be combined.
      *

package/dist/types/predictive-loading/request-strategy/request-strategy.d.ts

@@ -1,5 +1,6 @@
+import type { RequestEntry } from '../common';
 export declare abstract class RequestStrategy<Request, Context> {
     abstract buildConcreteRequest(similarRequest: Request, context: Context): Request;
     transformForSave(request: Request): Request;
-    reduce(requests: Request[]): Request[];
+    reduce(requests: RequestEntry<Request>[]): RequestEntry<Request>[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-aura",
-    "version": "1.290.0",
+    "version": "1.291.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS engine for Aura runtime",
     "main": "dist/ldsEngineCreator.js",
@@ -44,17 +44,17 @@
         "@luvio/service-subscription": "^1.0.0",
         "@luvio/service-type-registry": "^1.0.0",
         "@luvio/utils": "^3.6.0",
-        "@salesforce/lds-adapters-uiapi": "^1.290.0",
-        "@salesforce/lds-ads-bridge": "^1.290.0",
-        "@salesforce/lds-aura-storage": "^1.290.0",
-        "@salesforce/lds-bindings": "^1.290.0",
-        "@salesforce/lds-instrumentation": "^1.290.0",
-        "@salesforce/lds-network-aura": "^1.290.0",
-        "@salesforce/lds-network-fetch-with-jwt": "^1.290.0"
+        "@salesforce/lds-adapters-uiapi": "^1.291.0",
+        "@salesforce/lds-ads-bridge": "^1.291.0",
+        "@salesforce/lds-aura-storage": "^1.291.0",
+        "@salesforce/lds-bindings": "^1.291.0",
+        "@salesforce/lds-instrumentation": "^1.291.0",
+        "@salesforce/lds-network-aura": "^1.291.0",
+        "@salesforce/lds-network-fetch-with-jwt": "^1.291.0"
     },
     "dependencies": {
         "@luvio/network-adapter-composable": "0.154.18",
-        "@salesforce/lds-adapters-uiapi-lex": "^1.290.0"
+        "@salesforce/lds-adapters-uiapi-lex": "^1.291.0"
     },
     "luvioBundlesize": [
         {
@@ -62,7 +62,7 @@
             "maxSize": {
                 "none": "105 kB",
                 "min": "44 kB",
-                "compressed": "18.5 kB"
+                "compressed": "19 kB"
             }
         }
     ],