@salesforce/lds-runtime-mobile 1.260.0 → 1.262.0

package/dist/main.js

@@ -14959,11 +14959,14 @@ function mergeBatchRecordsFields(first, second, collectionMergeFunc) {
  * @param endpoint Regular Expression to check the endpoint to aggregate
  * @returns undefined if we should not aggregate. object if we should.
  */
-function createAggregateBatchRequestInfo(resourceRequest, endpoint) {
+function createAggregateBatchRequestInfo(resourceRequest, endpoint, instrumentationSink) {
     // only handle GETs on the given endpoint regex
     if (!isGetRequestForEndpoint(endpoint, resourceRequest)) {
         return undefined;
     }
+    if (instrumentationSink) {
+        instrumentationSink.reportChunkCandidateUrlLength(calculateEstimatedTotalUrlLength(resourceRequest));
+    }
     const { queryParams: { fields, optionalFields }, } = resourceRequest;
     // only handle requests with fields or optional fields
     if (fields === undefined && optionalFields === undefined) {
@@ -15075,6 +15078,21 @@ function getMaxLengthPerChunkAllowed(request) {
     // MAX_URL_LENGTH  - full lenght without fields, optionalFields
     return MAX_URL_LENGTH - roughUrlLengthWithoutFieldsAndOptionFields;
 }
+// we don't have access to the host so we cannot calculate the exact length of the url
+// so we will estimate it
+function calculateEstimatedTotalUrlLength(request) {
+    const { baseUri, basePath, queryParams } = request;
+    let url = `${baseUri}${basePath}`;
+    if (queryParams) {
+        const queryParamString = entries$2(queryParams)
+            .map(([key, value]) => `${key}=${value}`)
+            .join('&');
+        if (queryParamString) {
+            url += `?${queryParamString}`;
+        }
+    }
+    return url.length;
+}
 
 const RECORD_ENDPOINT_REGEX = /^\/ui-api\/records\/?(([a-zA-Z0-9]+))?$/;
 const referenceId$3 = 'LDS_Records_AggregateUi';
@@ -15099,9 +15117,9 @@ function mergeGetRecordResult(first, second) {
     mergeRecordFields(first, second);
     return first;
 }
-function makeNetworkChunkFieldsGetRecord(networkAdapter) {
+function makeNetworkChunkFieldsGetRecord(networkAdapter, instrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORD_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORD_ENDPOINT_REGEX, instrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15115,9 +15133,9 @@ function makeNetworkChunkFieldsGetRecord(networkAdapter) {
 
 const RECORDS_BATCH_ENDPOINT_REGEX = /^\/ui-api\/records\/batch\/?(([a-zA-Z0-9|,]+))?$/;
 const referenceId$2 = 'LDS_Records_Batch_AggregateUi';
-function makeNetworkChunkFieldsGetRecordsBatch(networkAdapter) {
+function makeNetworkChunkFieldsGetRecordsBatch(networkAdapter, intrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORDS_BATCH_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORDS_BATCH_ENDPOINT_REGEX, intrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15163,9 +15181,9 @@ function mergeRelatedRecordsFields(first, second) {
         throw new Error('Aggregate UI response is invalid');
     }
 }
-function makeNetworkChunkFieldsGetRelatedListRecords(networkAdapter) {
+function makeNetworkChunkFieldsGetRelatedListRecords(networkAdapter, instrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_ENDPOINT_REGEX, instrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15241,9 +15259,9 @@ function recordIdsAllMatch(first, second) {
 
 const RELATED_LIST_RECORDS_BATCH_ENDPOINT_REGEX = /^\/ui-api\/related-list-records\/batch\/?(([a-zA-Z0-9]+))?\//;
 const referenceId = 'LDS_Related_List_Records_AggregateUi';
-function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter) {
+function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter, instrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_BATCH_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_BATCH_ENDPOINT_REGEX, instrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15266,7 +15284,7 @@ function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter) {
  *
  * @param networkAdapter the network adapter to do the call.
  */
-function makeNetworkAdapterChunkRecordFields(networkAdapter) {
+function makeNetworkAdapterChunkRecordFields(networkAdapter, instrumentationSink) {
     // endpoint handlers that support aggregate-ui field batching
     const batchHandlers = [
         makeNetworkChunkFieldsGetRecord,
@@ -15275,7 +15293,7 @@ function makeNetworkAdapterChunkRecordFields(networkAdapter) {
         makeNetworkChunkFieldsGetRelatedListRecordsBatch,
     ];
     return batchHandlers.reduce((network, handler) => {
-        return handler(network);
+        return handler(network, instrumentationSink);
     }, networkAdapter);
 }
 
@@ -15552,6 +15570,11 @@ function reportPrimingConflict(resolutionType, recordCount) {
         resolutionType,
     });
 }
+/** Network */
+function reportChunkCandidateUrlLength(urlLength) {
+    const buckets = [8000, 10000, 12000, 14000, 16000];
+    ldsMobileInstrumentation.bucketValue('chunk-candidate-url-length-histogram', urlLength, buckets);
+}
 
 /**
  * HOF (high-order-function) that instruments any async operation.  If the operation
@@ -17762,7 +17785,9 @@ function getRuntime() {
         const { newRecordId, isGenerated } = recordIdGenerator(userId);
         // non-draft-aware base services
         const store = new InMemoryStore();
-        lazyNetworkAdapter = platformNetworkAdapter(makeNetworkAdapterChunkRecordFields(NimbusNetworkAdapter));
+        lazyNetworkAdapter = platformNetworkAdapter(makeNetworkAdapterChunkRecordFields(NimbusNetworkAdapter, {
+            reportChunkCandidateUrlLength: reportChunkCandidateUrlLength,
+        }));
         lazyBaseDurableStore = getNimbusDurableStore();
         // specific adapters
         const internalAdapterStore = new InMemoryStore();
@@ -17891,4 +17916,4 @@ register({
 });
 
 export { O11Y_NAMESPACE_LDS_MOBILE, getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.260.0-95d02abca
+// version: 1.262.0-af6b3d211

package/dist/types/__mocks__/o11y/instrumentation.d.ts

@@ -3,12 +3,14 @@ declare function error(_err: Error, _userSchemaOrText?: string, _data?: any): vo
 declare function startActivity(_name: string): any;
 declare function incrementCounter(_operation: string, _increment?: number, _hasError?: boolean, _tags?: any): void;
 declare function trackValue(_operation: string, _value: number, _hasError?: boolean, _tags?: any): void;
+declare function bucketValue(_operation: string, _value: number, _buckets: number[]): void;
 export declare const instrumentation: {
     log: typeof log;
     error: typeof error;
     startActivity: typeof startActivity;
     incrementCounter: typeof incrementCounter;
     trackValue: typeof trackValue;
+    bucketValue: typeof bucketValue;
 };
 export declare const METRIC_KEYS: {};
 export {};

package/dist/types/instrumentation/metrics.d.ts

@@ -15,3 +15,5 @@ export declare function reportPrimingSessionCreated(): void;
 export declare function reportPrimingError(errorType: string, recordCount: number): void;
 export declare function reportPrimingSuccess(recordCount: number): void;
 export declare function reportPrimingConflict(resolutionType: string, recordCount: number): void;
+/** Network */
+export declare function reportChunkCandidateUrlLength(urlLength: number): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-runtime-mobile",
-    "version": "1.260.0",
+    "version": "1.262.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS runtime for mobile/hybrid environments.",
     "main": "dist/main.js",
@@ -32,25 +32,25 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --name=lds-runtime-mobile"
     },
     "dependencies": {
-        "@salesforce/lds-adapters-uiapi": "^1.260.0",
-        "@salesforce/lds-bindings": "^1.260.0",
-        "@salesforce/lds-instrumentation": "^1.260.0",
-        "@salesforce/lds-priming": "^1.260.0",
+        "@salesforce/lds-adapters-uiapi": "^1.262.0",
+        "@salesforce/lds-bindings": "^1.262.0",
+        "@salesforce/lds-instrumentation": "^1.262.0",
+        "@salesforce/lds-priming": "^1.262.0",
         "@salesforce/user": "0.0.21",
         "o11y": "244.0.0"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-graphql": "^1.260.0",
-        "@salesforce/lds-drafts": "^1.260.0",
-        "@salesforce/lds-drafts-adapters-uiapi": "^1.260.0",
-        "@salesforce/lds-graphql-eval": "^1.260.0",
-        "@salesforce/lds-network-adapter": "^1.260.0",
-        "@salesforce/lds-network-nimbus": "^1.260.0",
-        "@salesforce/lds-store-binary": "^1.260.0",
-        "@salesforce/lds-store-nimbus": "^1.260.0",
-        "@salesforce/lds-store-sql": "^1.260.0",
-        "@salesforce/lds-utils-adapters": "^1.260.0",
-        "@salesforce/nimbus-plugin-lds": "^1.260.0",
+        "@salesforce/lds-adapters-graphql": "^1.262.0",
+        "@salesforce/lds-drafts": "^1.262.0",
+        "@salesforce/lds-drafts-adapters-uiapi": "^1.262.0",
+        "@salesforce/lds-graphql-eval": "^1.262.0",
+        "@salesforce/lds-network-adapter": "^1.262.0",
+        "@salesforce/lds-network-nimbus": "^1.262.0",
+        "@salesforce/lds-store-binary": "^1.262.0",
+        "@salesforce/lds-store-nimbus": "^1.262.0",
+        "@salesforce/lds-store-sql": "^1.262.0",
+        "@salesforce/lds-utils-adapters": "^1.262.0",
+        "@salesforce/nimbus-plugin-lds": "^1.262.0",
         "babel-plugin-dynamic-import-node": "^2.3.3",
         "wait-for-expect": "^3.0.2"
     },

package/sfdc/main.js

@@ -14959,11 +14959,14 @@ function mergeBatchRecordsFields(first, second, collectionMergeFunc) {
  * @param endpoint Regular Expression to check the endpoint to aggregate
  * @returns undefined if we should not aggregate. object if we should.
  */
-function createAggregateBatchRequestInfo(resourceRequest, endpoint) {
+function createAggregateBatchRequestInfo(resourceRequest, endpoint, instrumentationSink) {
     // only handle GETs on the given endpoint regex
     if (!isGetRequestForEndpoint(endpoint, resourceRequest)) {
         return undefined;
     }
+    if (instrumentationSink) {
+        instrumentationSink.reportChunkCandidateUrlLength(calculateEstimatedTotalUrlLength(resourceRequest));
+    }
     const { queryParams: { fields, optionalFields }, } = resourceRequest;
     // only handle requests with fields or optional fields
     if (fields === undefined && optionalFields === undefined) {
@@ -15075,6 +15078,21 @@ function getMaxLengthPerChunkAllowed(request) {
     // MAX_URL_LENGTH  - full lenght without fields, optionalFields
     return MAX_URL_LENGTH - roughUrlLengthWithoutFieldsAndOptionFields;
 }
+// we don't have access to the host so we cannot calculate the exact length of the url
+// so we will estimate it
+function calculateEstimatedTotalUrlLength(request) {
+    const { baseUri, basePath, queryParams } = request;
+    let url = `${baseUri}${basePath}`;
+    if (queryParams) {
+        const queryParamString = entries$2(queryParams)
+            .map(([key, value]) => `${key}=${value}`)
+            .join('&');
+        if (queryParamString) {
+            url += `?${queryParamString}`;
+        }
+    }
+    return url.length;
+}
 
 const RECORD_ENDPOINT_REGEX = /^\/ui-api\/records\/?(([a-zA-Z0-9]+))?$/;
 const referenceId$3 = 'LDS_Records_AggregateUi';
@@ -15099,9 +15117,9 @@ function mergeGetRecordResult(first, second) {
     mergeRecordFields(first, second);
     return first;
 }
-function makeNetworkChunkFieldsGetRecord(networkAdapter) {
+function makeNetworkChunkFieldsGetRecord(networkAdapter, instrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORD_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORD_ENDPOINT_REGEX, instrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15115,9 +15133,9 @@ function makeNetworkChunkFieldsGetRecord(networkAdapter) {
 
 const RECORDS_BATCH_ENDPOINT_REGEX = /^\/ui-api\/records\/batch\/?(([a-zA-Z0-9|,]+))?$/;
 const referenceId$2 = 'LDS_Records_Batch_AggregateUi';
-function makeNetworkChunkFieldsGetRecordsBatch(networkAdapter) {
+function makeNetworkChunkFieldsGetRecordsBatch(networkAdapter, intrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORDS_BATCH_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RECORDS_BATCH_ENDPOINT_REGEX, intrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15163,9 +15181,9 @@ function mergeRelatedRecordsFields(first, second) {
         throw new Error('Aggregate UI response is invalid');
     }
 }
-function makeNetworkChunkFieldsGetRelatedListRecords(networkAdapter) {
+function makeNetworkChunkFieldsGetRelatedListRecords(networkAdapter, instrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_ENDPOINT_REGEX, instrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15241,9 +15259,9 @@ function recordIdsAllMatch(first, second) {
 
 const RELATED_LIST_RECORDS_BATCH_ENDPOINT_REGEX = /^\/ui-api\/related-list-records\/batch\/?(([a-zA-Z0-9]+))?\//;
 const referenceId = 'LDS_Related_List_Records_AggregateUi';
-function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter) {
+function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter, instrumentationSink) {
     return (resourceRequest, resourceRequestContext) => {
-        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_BATCH_ENDPOINT_REGEX);
+        const batchRequestInfo = createAggregateBatchRequestInfo(resourceRequest, RELATED_LIST_RECORDS_BATCH_ENDPOINT_REGEX, instrumentationSink);
         if (batchRequestInfo === undefined) {
             return networkAdapter(resourceRequest, resourceRequestContext);
         }
@@ -15266,7 +15284,7 @@ function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter) {
  *
  * @param networkAdapter the network adapter to do the call.
  */
-function makeNetworkAdapterChunkRecordFields(networkAdapter) {
+function makeNetworkAdapterChunkRecordFields(networkAdapter, instrumentationSink) {
     // endpoint handlers that support aggregate-ui field batching
     const batchHandlers = [
         makeNetworkChunkFieldsGetRecord,
@@ -15275,7 +15293,7 @@ function makeNetworkAdapterChunkRecordFields(networkAdapter) {
         makeNetworkChunkFieldsGetRelatedListRecordsBatch,
     ];
     return batchHandlers.reduce((network, handler) => {
-        return handler(network);
+        return handler(network, instrumentationSink);
     }, networkAdapter);
 }
 
@@ -15552,6 +15570,11 @@ function reportPrimingConflict(resolutionType, recordCount) {
         resolutionType,
     });
 }
+/** Network */
+function reportChunkCandidateUrlLength(urlLength) {
+    const buckets = [8000, 10000, 12000, 14000, 16000];
+    ldsMobileInstrumentation.bucketValue('chunk-candidate-url-length-histogram', urlLength, buckets);
+}
 
 /**
  * HOF (high-order-function) that instruments any async operation.  If the operation
@@ -17762,7 +17785,9 @@ function getRuntime() {
         const { newRecordId, isGenerated } = recordIdGenerator(userId);
         // non-draft-aware base services
         const store = new InMemoryStore();
-        lazyNetworkAdapter = platformNetworkAdapter(makeNetworkAdapterChunkRecordFields(NimbusNetworkAdapter));
+        lazyNetworkAdapter = platformNetworkAdapter(makeNetworkAdapterChunkRecordFields(NimbusNetworkAdapter, {
+            reportChunkCandidateUrlLength: reportChunkCandidateUrlLength,
+        }));
         lazyBaseDurableStore = getNimbusDurableStore();
         // specific adapters
         const internalAdapterStore = new InMemoryStore();
@@ -17891,4 +17916,4 @@ register({
 });
 
 export { O11Y_NAMESPACE_LDS_MOBILE, getRuntime, registerReportObserver, reportGraphqlQueryParseError };
-// version: 1.260.0-95d02abca
+// version: 1.262.0-af6b3d211

package/sfdc/types/__mocks__/o11y/instrumentation.d.ts

@@ -3,12 +3,14 @@ declare function error(_err: Error, _userSchemaOrText?: string, _data?: any): vo
 declare function startActivity(_name: string): any;
 declare function incrementCounter(_operation: string, _increment?: number, _hasError?: boolean, _tags?: any): void;
 declare function trackValue(_operation: string, _value: number, _hasError?: boolean, _tags?: any): void;
+declare function bucketValue(_operation: string, _value: number, _buckets: number[]): void;
 export declare const instrumentation: {
     log: typeof log;
     error: typeof error;
     startActivity: typeof startActivity;
     incrementCounter: typeof incrementCounter;
     trackValue: typeof trackValue;
+    bucketValue: typeof bucketValue;
 };
 export declare const METRIC_KEYS: {};
 export {};

package/sfdc/types/instrumentation/metrics.d.ts

@@ -15,3 +15,5 @@ export declare function reportPrimingSessionCreated(): void;
 export declare function reportPrimingError(errorType: string, recordCount: number): void;
 export declare function reportPrimingSuccess(recordCount: number): void;
 export declare function reportPrimingConflict(resolutionType: string, recordCount: number): void;
+/** Network */
+export declare function reportChunkCandidateUrlLength(urlLength: number): void;