@salesforce/lds-network-nimbus 1.260.0 → 1.262.0

package/dist/main.js

@@ -488,11 +488,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) {
@@ -604,6 +607,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(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';
@@ -628,9 +646,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);
         }
@@ -644,9 +662,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);
         }
@@ -692,9 +710,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);
         }
@@ -770,9 +788,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);
         }
@@ -795,7 +813,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,
@@ -804,7 +822,7 @@ function makeNetworkAdapterChunkRecordFields(networkAdapter) {
         makeNetworkChunkFieldsGetRelatedListRecordsBatch,
     ];
     return batchHandlers.reduce((network, handler) => {
-        return handler(network);
+        return handler(network, instrumentationSink);
     }, networkAdapter);
 }
 

package/dist/types/network/__mocks__/o11y/client.d.ts

@@ -7,4 +7,5 @@ export declare function getInstrumentation(_name: string): {
     startActivity: (_name: string) => any;
     incrementCounter: (_operation: string, _increment?: number | undefined, _hasError?: boolean | undefined, _tags?: any) => void;
     trackValue: (_operation: string, _value: number, _hasError?: boolean | undefined, _tags?: any) => void;
+    bucketValue: (_operation: string, _value: number, _buckets: number[]) => void;
 };

package/dist/types/network/__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/network/record-field-batching/makeNetworkAdapterChunkRecordFields.d.ts

@@ -6,4 +6,6 @@ import type { NetworkAdapter } from '@luvio/engine';
  *
  * @param networkAdapter the network adapter to do the call.
  */
-export declare function makeNetworkAdapterChunkRecordFields(networkAdapter: NetworkAdapter): NetworkAdapter;
+export declare function makeNetworkAdapterChunkRecordFields(networkAdapter: NetworkAdapter, instrumentationSink: {
+    reportChunkCandidateUrlLength: (urlLength: number) => void;
+}): NetworkAdapter;

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

@@ -1,6 +1,6 @@
 import type { NetworkAdapter, FetchResponse } from '@luvio/engine';
 import type { RecordRepresentation } from '@salesforce/lds-adapters-uiapi';
-import type { AggregateResponse, UiApiErrorResponse } from './utils';
+import type { AggregateResponse, InstrumentationSink, UiApiErrorResponse } from './utils';
 export type GetRecordResult = RecordRepresentation | UiApiErrorResponse;
 export type GetRecordAggregateResponse = AggregateResponse<GetRecordResult>;
 export type GetRecordResponse = FetchResponse<GetRecordResult>;
@@ -12,4 +12,4 @@ export type GetRecordResponse = FetchResponse<GetRecordResult>;
  * fields sub node will be merged recursively
  */
 export declare function mergeGetRecordResult(first: GetRecordResult, second: GetRecordResult): GetRecordResult;
-export declare function makeNetworkChunkFieldsGetRecord(networkAdapter: NetworkAdapter): NetworkAdapter;
+export declare function makeNetworkChunkFieldsGetRecord(networkAdapter: NetworkAdapter, instrumentationSink: InstrumentationSink): NetworkAdapter;

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

@@ -1,7 +1,7 @@
 import type { FetchResponse, NetworkAdapter } from '@luvio/engine';
 import type { BatchRepresentation } from '@salesforce/lds-adapters-uiapi';
-import type { AggregateResponse } from './utils';
+import type { AggregateResponse, InstrumentationSink } from './utils';
 export declare const RECORDS_BATCH_ENDPOINT_REGEX: RegExp;
 export type GetRecordsBatchAggregateResponse = AggregateResponse<BatchRepresentation>;
 export type GetRecordsBatchResponse = FetchResponse<BatchRepresentation>;
-export declare function makeNetworkChunkFieldsGetRecordsBatch(networkAdapter: NetworkAdapter): NetworkAdapter;
+export declare function makeNetworkChunkFieldsGetRecordsBatch(networkAdapter: NetworkAdapter, intrumentationSink: InstrumentationSink): NetworkAdapter;

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

@@ -1,5 +1,5 @@
 import type { NetworkAdapter } from '@luvio/engine';
-import type { AggregateResponse } from './utils';
+import type { AggregateResponse, InstrumentationSink } from './utils';
 import type { RelatedListRecordCollectionRepresentation } from '@salesforce/lds-adapters-uiapi';
 export type RelatedListAggregateResponse = AggregateResponse<RelatedListRecordCollectionRepresentation>;
 /**
@@ -8,7 +8,7 @@ export type RelatedListAggregateResponse = AggregateResponse<RelatedListRecordCo
  * Exports it for unit tests
  */
 export declare function mergeRelatedRecordsFields(first: RelatedListRecordCollectionRepresentation, second: RelatedListRecordCollectionRepresentation): RelatedListRecordCollectionRepresentation;
-export declare function makeNetworkChunkFieldsGetRelatedListRecords(networkAdapter: NetworkAdapter): NetworkAdapter;
+export declare function makeNetworkChunkFieldsGetRelatedListRecords(networkAdapter: NetworkAdapter, instrumentationSink: InstrumentationSink): NetworkAdapter;
 /**
  * merge to paging url with different set of fields or optional fields as combined one
  * the paging url is like

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

@@ -1,6 +1,6 @@
 import type { FetchResponse, NetworkAdapter } from '@luvio/engine';
-import type { AggregateResponse } from './utils';
+import type { AggregateResponse, InstrumentationSink } from './utils';
 import type { RelatedListRecordCollectionBatchRepresentation } from '@salesforce/lds-adapters-uiapi';
 export type RelatedListBatchAggregateResponse = AggregateResponse<RelatedListRecordCollectionBatchRepresentation>;
 export type RelatedListBatchResponse = FetchResponse<RelatedListRecordCollectionBatchRepresentation>;
-export declare function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter: NetworkAdapter): NetworkAdapter;
+export declare function makeNetworkChunkFieldsGetRelatedListRecordsBatch(networkAdapter: NetworkAdapter, instrumentationSink: InstrumentationSink): NetworkAdapter;

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

@@ -42,6 +42,9 @@ type SupportedBatchRepresentation = RelatedListRecordCollectionBatchRepresentati
  * Supported batch representation
  */
 type SupportedBatchCollectionRepresentation = RelatedListRecordCollectionRepresentation | RecordRepresentation;
+export interface InstrumentationSink {
+    reportChunkCandidateUrlLength: (urlLength: number) => void;
+}
 /**
  * merge the aggregate ui child responses into a single object representation
  * @param response
@@ -60,7 +63,7 @@ export declare function mergeBatchRecordsFields(first: SupportedBatchRepresentat
  * @param endpoint Regular Expression to check the endpoint to aggregate
  * @returns undefined if we should not aggregate. object if we should.
  */
-export declare function createAggregateBatchRequestInfo(resourceRequest: ResourceRequest, endpoint: RegExp): {
+export declare function createAggregateBatchRequestInfo(resourceRequest: ResourceRequest, endpoint: RegExp, instrumentationSink?: InstrumentationSink): {
     fieldCollection: ScopedFieldsCollection[];
     optionalFieldCollection: ScopedFieldsCollection[];
 } | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-network-nimbus",
-    "version": "1.260.0",
+    "version": "1.262.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "A nimbus-plugin-based implementation of the Luvio NetworkAdapter.",
     "main": "dist/main.js",
@@ -26,20 +26,20 @@
     },
     "dependencies": {
         "@luvio/engine": "0.154.4",
-        "@salesforce/lds-instrumentation": "^1.260.0",
+        "@salesforce/lds-instrumentation": "^1.262.0",
         "o11y": "242.8.3"
     },
     "devDependencies": {
-        "@salesforce/lds-adapters-uiapi": "^1.260.0",
-        "@salesforce/nimbus-plugin-lds": "^1.260.0"
+        "@salesforce/lds-adapters-uiapi": "^1.262.0",
+        "@salesforce/nimbus-plugin-lds": "^1.262.0"
     },
     "luvioBundlesize": [
         {
             "path": "./dist/main.js",
             "maxSize": {
-                "none": "32 kB",
-                "min": "12.5 kB",
-                "compressed": "6.5 kB"
+                "none": "33 kB",
+                "min": "13 kB",
+                "compressed": "7 kB"
             }
         }
     ]