@salesforce/lds-runtime-aura 1.308.0-dev3 → 1.308.0-dev4

package/dist/ldsEngineCreator.js

@@ -26,7 +26,7 @@ import { BaseCommand, convertAuraResponseToData, convertFetchResponseToData } fr
 import { serviceBroker } from 'force/luvioServiceBroker5';
 import oneStoreEnabled from '@salesforce/gate/lds.oneStoreEnabled.ltng';
 import oneStoreUiapiEnabled from '@salesforce/gate/lds.oneStoreUiapiEnabled.ltng';
-import { getDefinition, executeGlobalControllerRawResponse } from 'aura';
+import { unstable_loadComponentDefs, executeGlobalControllerRawResponse } from 'aura';
 import { buildJwtNetworkAdapter, instrument as instrument$2, setupLexJwtNetworkAdapter } from 'force/ldsNetworkFetchWithJwt';
 import auraNetworkAdapter, { dispatchAuraAction, defaultActionConfig, instrument as instrument$1, forceRecordTransactionsDisabled as forceRecordTransactionsDisabled$1, ldsNetworkAdapterInstrument, CrudEventState, CrudEventType, UIAPI_RECORDS_PATH, UIAPI_RELATED_LIST_RECORDS_BATCH_PATH, UIAPI_RELATED_LIST_RECORDS_PATH } from 'force/ldsNetwork';
 import { LRUCache, instrumentAdapter, instrumentLuvio, setupInstrumentation as setupInstrumentation$1, logObjectInfoChanged as logObjectInfoChanged$1, updatePercentileHistogramMetric, incrementCounterMetric, incrementGetRecordNotifyChangeAllowCount, incrementGetRecordNotifyChangeDropCount, incrementNotifyRecordUpdateAvailableAllowCount, incrementNotifyRecordUpdateAvailableDropCount, setLdsAdaptersUiapiInstrumentation, logError, setLdsNetworkAdapterInstrumentation, executeAsyncActivity, METRIC_KEYS, onIdleDetected } from 'force/ldsInstrumentation';
@@ -1833,10 +1833,12 @@ class RecordHomePage extends LexDefaultPage {
                 return requestBuckets;
             }
         }
-        requestBuckets.push({
-            context: this.context,
-            request: matchingRequestStrategy.transformForSave(request),
-        });
+        if (!matchingRequestStrategy.onlySavedInSimilar) {
+            requestBuckets.push({
+                context: this.context,
+                request: matchingRequestStrategy.transformForSave(request),
+            });
+        }
         return requestBuckets;
     }
     resolveSimilarRequest(similarRequest) {
@@ -2030,7 +2032,7 @@ const TOTAL_ADAPTER_REQUEST_SUCCESS_COUNT = {
     },
 };
 
-const { create, keys, hasOwnProperty } = Object;
+const { create, keys, hasOwnProperty, entries } = Object;
 const { isArray, from } = Array;
 const { stringify } = JSON;
 
@@ -2724,10 +2726,13 @@ class LexPredictivePrefetcher extends ApplicationPredictivePrefetcher {
     }
     getAllPageRequests() {
         const exactPageRequests = this.getExactPageRequest();
+        let similarPageRequests = this.getSimilarPageRequests();
         if (exactPageRequests.length > 0 && this.options.useExactMatchesPlus === true) {
-            return exactPageRequests;
+            similarPageRequests = similarPageRequests.filter((requestEntry) => {
+                const strategy = this.requestStrategies[requestEntry.request.adapterName];
+                return strategy && strategy.onlySavedInSimilar;
+            });
         }
-        const similarPageRequests = this.getSimilarPageRequests();
         return [...exactPageRequests, ...similarPageRequests];
     }
     async predict() {
@@ -3013,6 +3018,14 @@ class RequestStrategy {
     isContextDependent(_context, _request) {
         return false;
     }
+    /**
+     * This tells PDL that requests of this strategy can only be saved in the similar bucket.
+     *
+     * @returns boolean
+     */
+    get onlySavedInSimilar() {
+        return false;
+    }
 }
 
 const noop = () => { };
@@ -3102,20 +3115,31 @@ const onePreloads = new Set([
     'markup://sfa:inspectionDesktopObjectHome',
     'markup://records:outputPhone',
 ]);
+function canPreloadDefinition(def) {
+    return (def.startsWith('markup://') &&
+        !(
+        // some "virtual" components from flexipages are with `__` in the name, eg: design templates.
+        // Not filtering out them will not cause errors, but will cause a server request that returns with error.
+        (def.includes('__') ||
+            // any generated template
+            def.includes('forceGenerated') ||
+            // part of onePreload
+            def.includes('one:onePreloads') ||
+            onePreloads.has(def))));
+}
 function requestComponents(config) {
-    try {
-        for (let index = 0, n = config.length; index < n; index++) {
-            const def = config[index];
-            if (def.startsWith('markup://') &&
-                !(def.includes('forceGenerated') ||
-                    def.includes('one:onePreloads') ||
-                    onePreloads.has(def))) {
-                getDefinition(def, noop);
-            }
+    // Because { foo: undefined } can't be saved in indexedDB (serialization is {})
+    // we need to manually save it as { "foo": "" }, and transform it to { foo: undefined }
+    const descriptorsMap = {};
+    let hasComponentsToLoad = false;
+    for (const [def, uid] of entries(config)) {
+        if (canPreloadDefinition(def)) {
+            hasComponentsToLoad = true;
+            descriptorsMap[def] = uid === '' ? undefined : uid;
         }
     }
-    catch (e) {
-        // dismiss the error.
+    if (hasComponentsToLoad) {
+        unstable_loadComponentDefs(descriptorsMap, noop);
     }
 }
 class GetComponentsDefStrategy extends RequestStrategy {
@@ -3132,7 +3156,14 @@ class GetComponentsDefStrategy extends RequestStrategy {
         };
     }
     transformForSave(request) {
-        const normalizedConfig = (request.config || []).map((def) => def.indexOf('://') === -1 ? 'markup://' + def : def);
+        const normalizedConfig = {};
+        for (const [def, uid] of entries(request.config || {})) {
+            const normalizedDescriptorName = def.indexOf('://') === -1 ? 'markup://' + def : def;
+            // uid can be a string, an object, or undefined.
+            // when is an object or undefined, we can't say anything about the version,
+            // and we can't save it as `undefined` as it can't be persisted to indexed db.
+            normalizedConfig[normalizedDescriptorName] = typeof uid === 'string' ? uid : '';
+        }
         return {
             ...request,
             config: normalizedConfig,
@@ -3142,18 +3173,21 @@ class GetComponentsDefStrategy extends RequestStrategy {
         return true;
     }
     combineRequests(reqA, reqB) {
-        const result = new Set(reqA);
-        reqB.forEach((c) => result.add(c));
-        // remove the ones that can't be preloaded.
-        return [...result].filter((def) => {
-            return (def.startsWith('markup://') &&
-                !(
-                // any generated template
-                (def.includes('forceGenerated') ||
-                    // part of onePreload
-                    def.includes('one:onePreloads') ||
-                    onePreloads.has(def))));
-        });
+        const combinedDescriptors = {};
+        // Note the order is important [reqA, reqB], reqB is always after reqA, and we want to keep the last seen uid
+        // of a specific component.
+        for (const descriptorMap of [reqA, reqB]) {
+            for (const [def, uid] of entries(descriptorMap)) {
+                if (canPreloadDefinition(def)) {
+                    combinedDescriptors[def] = uid;
+                }
+            }
+        }
+        return combinedDescriptors;
+    }
+    get onlySavedInSimilar() {
+        // Important: tells PDL to save this request only in the similar buckets.
+        return true;
     }
     isContextDependent(_context, _request) {
         return true;
@@ -4023,7 +4057,7 @@ function getEnvironmentSetting(name) {
     }
     return undefined;
 }
-// version: 1.308.0-dev3-5eb971dcf6
+// version: 1.308.0-dev4-f0bdc19646
 
 const forceRecordTransactionsDisabled = getEnvironmentSetting(EnvironmentSettings.ForceRecordTransactionsDisabled);
 //TODO: Some duplication here that can be most likely moved to a util class
@@ -4406,7 +4440,7 @@ function loadComponentsDefStartedOverride(...args) {
     const config = Array.prototype.shift.apply(args);
     const ret = config['fn'].apply(config['scope'], args);
     try {
-        const defs = keys(args[0] || {});
+        const defs = args[0] || {};
         __lexPrefetcher.saveRequest({
             adapterName: 'getComponentsDef',
             config: defs,
@@ -4456,13 +4490,21 @@ function buildPredictorForContext(context) {
         watchPageLoadForPredictions() {
             // This chunk tells the prefetcher to receive events, send off any predictions we have from previous loads, then setup idle detection to stop predicting.
             __lexPrefetcher.startRecording();
-            if (useCmpDefPredictions.isOpen({ fallback: false })) {
-                window['$A'].installOverride('ComponentService.loadComponentDefsStarted', loadComponentsDefStartedOverride);
+            // We only want to use cmpDef predictions on PROD code,
+            // as in dev, it is assumed that the definitions will change often
+            if (process.env.NODE_ENV === 'production') {
+                if (useCmpDefPredictions.isOpen({ fallback: false })) {
+                    window['$A'].installOverride('ComponentService.loadComponentDefsStarted', loadComponentsDefStartedOverride);
+                }
             }
             onIdleDetected(() => {
                 __lexPrefetcher.stopRecording();
-                if (useCmpDefPredictions.isOpen({ fallback: false })) {
-                    window['$A'].uninstallOverride('ComponentService.loadComponentDefsStarted', loadComponentsDefStartedOverride);
+                // We only want to use cmpDef predictions on PROD code,
+                // as in dev, it is assumed that the definitions will change often
+                if (process.env.NODE_ENV === 'production') {
+                    if (useCmpDefPredictions.isOpen({ fallback: false })) {
+                        window['$A'].uninstallOverride('ComponentService.loadComponentDefsStarted', loadComponentsDefStartedOverride);
+                    }
                 }
             });
         },
@@ -4578,4 +4620,4 @@ function ldsEngineCreator() {
 }
 
 export { buildPredictorForContext, ldsEngineCreator as default, initializeLDS, initializeOneStore };
-// version: 1.308.0-dev3-d47029eab2
+// version: 1.308.0-dev4-d65a66df4a

package/dist/types/language.d.ts

@@ -4,7 +4,12 @@ declare const create: {
 }, keys: {
     (o: object): string[];
     (o: {}): string[];
-}, hasOwnProperty: (v: PropertyKey) => boolean;
+}, hasOwnProperty: (v: PropertyKey) => boolean, entries: {
+    <T>(o: {
+        [s: string]: T;
+    } | ArrayLike<T>): [string, T][];
+    (o: {}): [string, any][];
+};
 declare const isArray: (arg: any) => arg is any[], from: {
     <T>(arrayLike: ArrayLike<T>): T[];
     <T_1, U>(arrayLike: ArrayLike<T_1>, mapfn: (v: T_1, k: number) => U, thisArg?: any): U[];
@@ -15,4 +20,4 @@ declare const stringify: {
     (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
     (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
 };
-export { create as ObjectCreate, keys as ObjectKeys, hasOwnProperty as ObjectHasOwnProperty, isArray as ArrayIsArray, from as ArrayFrom, stringify as JSONStringify, };
+export { create as ObjectCreate, keys as ObjectKeys, hasOwnProperty as ObjectHasOwnProperty, entries as ObjectEntries, isArray as ArrayIsArray, from as ArrayFrom, stringify as JSONStringify, };

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

@@ -1,17 +1,25 @@
 import { RequestStrategy } from './request-strategy';
+type DescriptorsMap = Record<string, unknown | string | undefined>;
+type NormalizedDescriptorsMap = Record<string, string>;
 export type GetComponentsRequest = {
     adapterName: 'getComponentsDef';
-    config: string[];
+    config: DescriptorsMap;
+};
+export type NormalizedGetComponentsRequest = {
+    adapterName: 'getComponentsDef';
+    config: NormalizedDescriptorsMap;
 };
 export type GetComponentsContext = {
     objectApiName: string;
 };
-export declare class GetComponentsDefStrategy extends RequestStrategy<string[], GetComponentsRequest, GetComponentsContext> {
+export declare class GetComponentsDefStrategy extends RequestStrategy<DescriptorsMap, GetComponentsRequest, GetComponentsContext> {
     adapterName: string;
-    execute(config: string[]): void;
+    execute(config: NormalizedDescriptorsMap): void;
     buildConcreteRequest(similarRequest: GetComponentsRequest, _context: GetComponentsContext): GetComponentsRequest;
-    transformForSave(request: GetComponentsRequest): GetComponentsRequest;
+    transformForSave(request: GetComponentsRequest): NormalizedGetComponentsRequest;
     canCombine(): boolean;
-    combineRequests(reqA: string[], reqB: string[]): string[];
+    combineRequests(reqA: NormalizedDescriptorsMap, reqB: NormalizedDescriptorsMap): NormalizedDescriptorsMap;
+    get onlySavedInSimilar(): boolean;
     isContextDependent(_context: GetComponentsContext, _request: GetComponentsRequest): boolean;
 }
+export {};

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

@@ -65,4 +65,10 @@ export declare abstract class RequestStrategy<Config, Request extends BaseAdapte
      * @returns
      */
     isContextDependent(_context: Context, _request: Request): boolean;
+    /**
+     * This tells PDL that requests of this strategy can only be saved in the similar bucket.
+     *
+     * @returns boolean
+     */
+    get onlySavedInSimilar(): boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-aura",
-    "version": "1.308.0-dev3",
+    "version": "1.308.0-dev4",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS engine for Aura runtime",
     "main": "dist/ldsEngineCreator.js",
@@ -35,15 +35,15 @@
     },
     "devDependencies": {
         "@luvio/service-broker": "5.3.1",
-        "@salesforce/lds-adapters-apex": "^1.308.0-dev3",
-        "@salesforce/lds-adapters-uiapi": "^1.308.0-dev3",
+        "@salesforce/lds-adapters-apex": "^1.308.0-dev4",
+        "@salesforce/lds-adapters-uiapi": "^1.308.0-dev4",
         "@salesforce/lds-adapters-uiapi-lex": "^1.302.0",
-        "@salesforce/lds-ads-bridge": "^1.308.0-dev3",
-        "@salesforce/lds-aura-storage": "^1.308.0-dev3",
-        "@salesforce/lds-bindings": "^1.308.0-dev3",
-        "@salesforce/lds-instrumentation": "^1.308.0-dev3",
-        "@salesforce/lds-network-aura": "^1.308.0-dev3",
-        "@salesforce/lds-network-fetch-with-jwt": "^1.308.0-dev3"
+        "@salesforce/lds-ads-bridge": "^1.308.0-dev4",
+        "@salesforce/lds-aura-storage": "^1.308.0-dev4",
+        "@salesforce/lds-bindings": "^1.308.0-dev4",
+        "@salesforce/lds-instrumentation": "^1.308.0-dev4",
+        "@salesforce/lds-network-aura": "^1.308.0-dev4",
+        "@salesforce/lds-network-fetch-with-jwt": "^1.308.0-dev4"
     },
     "dependencies": {
         "@luvio/command-aura-network": "5.3.1",
@@ -64,7 +64,7 @@
         "@luvio/service-subscription": "5.3.1",
         "@luvio/service-type-registry": "5.3.1",
         "@luvio/utils": "5.3.1",
-        "@salesforce/lds-adapters-uiapi-lex": "^1.308.0-dev3"
+        "@salesforce/lds-adapters-uiapi-lex": "^1.308.0-dev4"
     },
     "luvioBundlesize": [
         {
@@ -72,7 +72,7 @@
             "maxSize": {
                 "none": "175 kB",
                 "min": "75 kB",
-                "compressed": "31 kB"
+                "compressed": "32 kB"
             }
         }
     ],