@salesforce/lds-network-nimbus 1.163.0 → 1.163.2

package/dist/main.js

@@ -6,6 +6,7 @@
 
 import { idleDetector } from 'o11y/client';
 import { HttpStatusCode } from '@luvio/engine';
+import ldsUseShortUrlGate from '@salesforce/gate/lds.useShortUrl';
 
 const { keys, create, assign, entries } = Object;
 const { stringify, parse } = JSON;
@@ -353,6 +354,10 @@ class ScopedFieldsCollection {
 }
 
 const MAX_STRING_LENGTH_PER_CHUNK = 10000;
+//Salesforce/Akamai cdn uri max size is 8898 bytes, short than normal. Per
+//https://help.salesforce.com/s/articleView?id=sf.community_builder_cdn_considerations.htm&type=5
+//Due to we don't know the domain ResourceRequest, here we give 8000
+const MAX_URL_LENGTH = 8000;
 const PARSE_ERROR = 'PARSE_AGGREGATE_UI_RESPONSE_ERROR';
 function isErrorResponse(response) {
     return response.httpStatusCode >= 400;
@@ -431,8 +436,8 @@ function buildAggregateUiUrl(params, resourceRequest) {
     }
     return `${resourceRequest.baseUri}${resourceRequest.basePath}?${join.call(queryString, '&')}`;
 }
-function shouldUseAggregateUiForFields(fieldsArray, optionalFieldsArray) {
-    return fieldsArray.length + optionalFieldsArray.length >= MAX_STRING_LENGTH_PER_CHUNK;
+function shouldUseAggregateUiForFields(fieldsArray, optionalFieldsArray, maxLengthPerChunk) {
+    return fieldsArray.length + optionalFieldsArray.length >= maxLengthPerChunk;
 }
 function isSpanningRecord(fieldValue) {
     return fieldValue !== null && typeof fieldValue === 'object';
@@ -495,14 +500,15 @@ function createAggregateBatchRequestInfo(resourceRequest, endpoint) {
     if (fieldsArray.length === 0 && optionalFieldsArray.length === 0) {
         return undefined;
     }
+    const allowedMaxStringLengthPerChunk = getMaxLengthPerChunkAllowed(resourceRequest);
     const fieldsString = fieldsArray.join(',');
     const optionalFieldsString = optionalFieldsArray.join(',');
-    const shouldUseAggregate = shouldUseAggregateUiForFields(fieldsString, optionalFieldsString);
+    const shouldUseAggregate = shouldUseAggregateUiForFields(fieldsString, optionalFieldsString, allowedMaxStringLengthPerChunk);
     if (!shouldUseAggregate) {
         return undefined;
     }
-    const fieldCollection = ScopedFieldsCollection.fromQueryParameterValue(fieldsString).split(MAX_STRING_LENGTH_PER_CHUNK);
-    const optionalFieldCollection = ScopedFieldsCollection.fromQueryParameterValue(optionalFieldsString).split(MAX_STRING_LENGTH_PER_CHUNK);
+    const fieldCollection = ScopedFieldsCollection.fromQueryParameterValue(fieldsString).split(allowedMaxStringLengthPerChunk);
+    const optionalFieldCollection = ScopedFieldsCollection.fromQueryParameterValue(optionalFieldsString).split(allowedMaxStringLengthPerChunk);
     return {
         fieldCollection,
         optionalFieldCollection,
@@ -575,6 +581,25 @@ function isGetRequestForEndpoint(endpoint, request) {
 function arrayOrEmpty(array) {
     return array !== undefined && isArray(array) ? array : [];
 }
+/**
+ * Calculate the max lengh per chunk.
+ * If useShortUrlGate is open, allow max chunk size is MAX_URL_LENGTH - the url without fields and optional fields in url.
+ * Otherwise MAX_STRING_LENGTH_PER_CHUNK
+ * @param resourceRequest
+ * @returns
+ */
+function getMaxLengthPerChunkAllowed(request) {
+    if (!ldsUseShortUrlGate.isOpen({ fallback: false })) {
+        return MAX_STRING_LENGTH_PER_CHUNK;
+    }
+    // Too much work to get exact length of the final url, so use stringified json to get the rough length.
+    const roughUrlLengthWithoutFieldsAndOptionFields = request.basePath.length +
+        request.baseUri.length +
+        (request.urlParams ? stringify(request.urlParams).length : 0) +
+        stringify({ ...request.queryParams, fields: {}, optionalFields: {} }).length;
+    // MAX_URL_LENGTH  - full lenght without fields, optionalFields
+    return MAX_URL_LENGTH - roughUrlLengthWithoutFieldsAndOptionFields;
+}
 
 const RECORD_ENDPOINT_REGEX = /^\/ui-api\/records\/?(([a-zA-Z0-9]+))?$/;
 const referenceId$3 = 'LDS_Records_AggregateUi';

package/dist/types/network/record-field-batching/utils.d.ts

@@ -4,6 +4,7 @@ import type { RecordRepresentation, BatchRepresentation, RelatedListRecordCollec
 import type { GetRecordResult } from './makeNetworkChunkFieldsGetRecord';
 import { ScopedFieldsCollection } from './ScopedFields';
 export declare const MAX_STRING_LENGTH_PER_CHUNK = 10000;
+export declare const MAX_URL_LENGTH = 8000;
 export interface CompositeRequest {
     url: string;
     referenceId: string;
@@ -49,7 +50,7 @@ type SupportedBatchCollectionRepresentation = RelatedListRecordCollectionReprese
  */
 export declare function mergeAggregateUiResponse<T>(response: AggregateResponse<T>, mergeFunc: (first: T, second: T) => SupportedAggregateRepresentation<T>): FetchResponse<SupportedAggregateRepresentation<T> | UiApiErrorResponse>;
 export declare function buildAggregateUiUrl(params: UiApiParams, resourceRequest: ResourceRequest): string;
-export declare function shouldUseAggregateUiForFields(fieldsArray: string, optionalFieldsArray: string): boolean;
+export declare function shouldUseAggregateUiForFields(fieldsArray: string, optionalFieldsArray: string, maxLengthPerChunk: number): boolean;
 export declare function isSpanningRecord(fieldValue: null | string | number | boolean | RecordRepresentation): fieldValue is RecordRepresentation;
 export declare function mergeRecordFields(first: RecordRepresentation, second: RecordRepresentation): RecordRepresentation;
 export declare function mergeBatchRecordsFields(first: SupportedBatchRepresentation, second: SupportedBatchRepresentation, collectionMergeFunc: (first: SupportedBatchCollectionRepresentation, second: SupportedBatchCollectionRepresentation) => SupportedBatchCollectionRepresentation): SupportedBatchRepresentation;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-network-nimbus",
-    "version": "1.163.0",
+    "version": "1.163.2",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "A nimbus-plugin-based implementation of the Luvio NetworkAdapter.",
     "main": "dist/main.js",
@@ -39,7 +39,7 @@
             "maxSize": {
                 "none": "32 kB",
                 "min": "12.5 kB",
-                "compressed": "6 kB"
+                "compressed": "6.5 kB"
             }
         }
     ]