@salesforce/lds-drafts 1.228.1 → 1.229.0-dev10

package/dist/ldsDrafts.js

@@ -6,6 +6,7 @@
 
 import { HttpStatusCode, StoreKeyMap } from '@luvio/engine';
 import { AsyncWorkerPool } from '@salesforce/lds-utils-adapters';
+import ldsIdempotencyWriteDisabled from '@salesforce/gate/lds.idempotencyWriteDisabled';
 
 var DraftActionStatus;
 (function (DraftActionStatus) {
@@ -236,8 +237,12 @@ function uuidv4() {
 
 const HTTP_HEADER_RETRY_AFTER = 'Retry-After';
 const HTTP_HEADER_IDEMPOTENCY_KEY = 'Idempotency-Key';
+const ERROR_CODE_IDEMPOTENCY_FEATURE_NOT_ENABLED = 'IDEMPOTENCY_FEATURE_NOT_ENABLED';
+const ERROR_CODE_IDEMPOTENCY_NOT_SUPPORTED = 'IDEMPOTENCY_NOT_SUPPORTED';
 const ERROR_CODE_IDEMPOTENCY_KEY_USED_DIFFERENT_USER = 'IDEMPOTENCY_KEY_USED_DIFFERENT_USER';
 const ERROR_CODE_IDEMPOTENCY_CONCURRENT_REQUEST = 'IDEMPOTENCY_CONCURRENT_REQUEST';
+const ERROR_CODE_IDEMPOTENCY_KEY_ALREADY_USED = 'IDEMPOTENCY_KEY_ALREADY_USED';
+const ERROR_CODE_IDEMPOTENCY_BACKEND_OPERATION_ERROR = 'IDEMPOTENCY_BACKEND_OPERATION_ERROR';
 /**
  * Get the retry after in milliseconds from the response headers, undefined if not specified.
  * The header could have two different format.
@@ -267,7 +272,9 @@ function buildLuvioOverrideForDraftAdapters(luvio, handler, extractTargetIdFromC
     const dispatchResourceRequest = async function (resourceRequest, _context) {
         const resourceRequestCopy = clone(resourceRequest);
         resourceRequestCopy.headers = resourceRequestCopy.headers || {};
-        resourceRequestCopy.headers[HTTP_HEADER_IDEMPOTENCY_KEY] = uuidv4();
+        if (handler.hasIdempotencySupport()) {
+            resourceRequestCopy.headers[HTTP_HEADER_IDEMPOTENCY_KEY] = uuidv4();
+        }
         // enable return extra fields for record creation and record update http call
         if (resourceRequest.basePath === '/ui-api/records' &&
             (resourceRequest.method === 'post' || resourceRequest.method === 'patch')) {
@@ -1103,6 +1110,12 @@ class AbstractResourceRequestActionHandler {
         // the luvio store redirect table, during which a new draft might be enqueued
         // which would not see a necessary mapping.
         this.ephemeralRedirects = {};
+        // determined by Server setup.
+        this.isIdempotencySupported = true;
+        // idempotency write flag set by lds
+        this.isLdsIdempotencyWriteDisabled = ldsIdempotencyWriteDisabled.isOpen({
+            fallback: false,
+        });
     }
     enqueue(data) {
         return this.draftQueue.enqueue(this.handlerId, data);
@@ -1132,21 +1145,43 @@ class AbstractResourceRequestActionHandler {
                         retryDelayInMs = getRetryAfterInMs(response.headers);
                         shouldRetry = true;
                         break;
-                    case HttpStatusCode.ServerError:
+                    case HttpStatusCode.ServerError: {
                         shouldRetry = true;
+                        if (this.handleIdempotencyServerError(response.body, updatedAction, false, ERROR_CODE_IDEMPOTENCY_BACKEND_OPERATION_ERROR)) {
+                            this.isIdempotencySupported = false;
+                            retryDelayInMs = 0;
+                            actionDataChanged = true;
+                        }
                         break;
+                    }
                     case 409 /* IdempotentWriteSpecificHttpStatusCode.Conflict */: {
-                        const errorCode = response.body[0].errorCode;
-                        if (errorCode === ERROR_CODE_IDEMPOTENCY_KEY_USED_DIFFERENT_USER) {
-                            updatedAction.data.headers = updatedAction.data.headers || {};
-                            updatedAction.data.headers[HTTP_HEADER_IDEMPOTENCY_KEY] = uuidv4();
+                        if (this.isUiApiErrors(response.body)) {
+                            const errorCode = response.body[0].errorCode;
+                            if (this.handleIdempotencyServerError(response.body, updatedAction, true, ERROR_CODE_IDEMPOTENCY_KEY_USED_DIFFERENT_USER)) {
+                                retryDelayInMs = 0;
+                                actionDataChanged = true;
+                            }
+                            else if (errorCode === ERROR_CODE_IDEMPOTENCY_CONCURRENT_REQUEST) {
+                                retryDelayInMs = getRetryAfterInMs(response.headers);
+                            }
+                            shouldRetry = true;
+                        }
+                        break;
+                    }
+                    case HttpStatusCode.BadRequest: {
+                        if (this.handleIdempotencyServerError(response.body, updatedAction, false, ERROR_CODE_IDEMPOTENCY_FEATURE_NOT_ENABLED, ERROR_CODE_IDEMPOTENCY_NOT_SUPPORTED)) {
                             retryDelayInMs = 0;
                             actionDataChanged = true;
+                            shouldRetry = true;
                         }
-                        else if (errorCode === ERROR_CODE_IDEMPOTENCY_CONCURRENT_REQUEST) {
-                            retryDelayInMs = getRetryAfterInMs(response.headers);
+                        break;
+                    }
+                    case 422 /* IdempotentWriteSpecificHttpStatusCode.UnProcessableEntity */: {
+                        if (this.handleIdempotencyServerError(response.body, updatedAction, true, ERROR_CODE_IDEMPOTENCY_KEY_ALREADY_USED)) {
+                            retryDelayInMs = 0;
+                            actionDataChanged = true;
+                            shouldRetry = true;
                         }
-                        shouldRetry = true;
                         break;
                     }
                 }
@@ -1165,6 +1200,27 @@ class AbstractResourceRequestActionHandler {
             return ProcessActionResult.NETWORK_ERROR;
         }
     }
+    // true if response is an idempotency server error. updates or deletes idempotency key if the reponse is idempotency related error. Idempotency related error is in format of UiApiError array.
+    handleIdempotencyServerError(responseBody, action, updateIdempotencyKey, ...targetErrorCodes) {
+        if (this.isUiApiErrors(responseBody)) {
+            const errorCode = responseBody[0].errorCode;
+            if (targetErrorCodes.includes(errorCode)) {
+                action.data.headers = action.data.headers || {};
+                if (updateIdempotencyKey) {
+                    action.data.headers[HTTP_HEADER_IDEMPOTENCY_KEY] = uuidv4();
+                }
+                else {
+                    delete action.data.headers[HTTP_HEADER_IDEMPOTENCY_KEY];
+                }
+                return true;
+            }
+        }
+        return false;
+    }
+    // checks if the body is an array of UiApiError. Sometimes the body has `enhancedErrorType` field as an error indicator(one example is the field validation failure). In such case Action being processed updates to an Error Action.
+    isUiApiErrors(body) {
+        return body !== undefined && Array.isArray(body) && body.length > 0 && body[0].errorCode;
+    }
     async buildPendingAction(request, queue) {
         const targetId = await this.getIdFromRequest(request);
         if (targetId === undefined) {
@@ -1378,6 +1434,10 @@ class AbstractResourceRequestActionHandler {
             ...targetData,
             body: this.mergeRequestBody(targetBody, sourceBody),
         };
+        // Updates Idempotency key if target has one
+        if (targetData.headers && targetData.headers[HTTP_HEADER_IDEMPOTENCY_KEY]) {
+            merged.data.headers[HTTP_HEADER_IDEMPOTENCY_KEY] = uuidv4();
+        }
         // overlay metadata
         merged.metadata = { ...targetMetadata, ...sourceMetadata };
         // put status back to pending to auto upload if queue is active and targed is at the head.
@@ -1414,6 +1474,9 @@ class AbstractResourceRequestActionHandler {
     getDraftIdsFromAction(action) {
         return [action.targetId];
     }
+    hasIdempotencySupport() {
+        return this.isIdempotencySupported && !this.isLdsIdempotencyWriteDisabled;
+    }
     async ingestResponses(responses, action) {
         const luvio = this.getLuvio();
         await luvio.handleSuccessResponse(() => {

package/dist/types/actionHandlers/AbstractResourceRequestActionHandler.d.ts

@@ -14,9 +14,13 @@ export declare abstract class AbstractResourceRequestActionHandler<ResponseType,
     ephemeralRedirects: {
         [key: string]: string;
     };
+    isIdempotencySupported: boolean;
+    isLdsIdempotencyWriteDisabled: boolean;
     constructor(draftQueue: DraftQueue, networkAdapter: NetworkAdapter, getLuvio: () => Luvio);
     enqueue(data: ResourceRequest): Promise<EnqueueResult<ResourceRequest, ResponseType>>;
     handleAction(action: DraftAction<ResourceRequest, ResponseType>, actionCompleted: (action: CompletedDraftAction<ResourceRequest, ResponseType>) => Promise<void>, actionErrored: (action: DraftAction<ResourceRequest, ResponseType>, retry: boolean, retryDelayInMs?: number, actionDataChanged?: boolean) => Promise<void>): Promise<ProcessActionResult>;
+    handleIdempotencyServerError(responseBody: any, action: DraftAction<ResourceRequest, ResponseType>, updateIdempotencyKey: boolean, ...targetErrorCodes: string[]): boolean;
+    isUiApiErrors(body: any): boolean;
     buildPendingAction(request: ResourceRequest, queue: DraftAction<unknown, unknown>[]): Promise<PendingDraftAction<ResourceRequest>>;
     handleActionEnqueued(action: PendingDraftAction<ResourceRequest>): Promise<void>;
     handleActionRemoved(action: DraftAction<ResourceRequest, ResponseType>): Promise<void>;
@@ -30,6 +34,7 @@ export declare abstract class AbstractResourceRequestActionHandler<ResponseType,
     private isActionOfType;
     protected reingestRecord(action: DraftAction<ResourceRequest, ResponseType>): Promise<void>;
     getDraftIdsFromAction(action: DraftAction<ResourceRequest, ResponseType>): string[];
+    hasIdempotencySupport(): boolean;
     ingestResponses(responses: ResponseIngestionEntry[], action: DraftAction<ResourceRequest, ResponseType>): Promise<void>;
     evictKey(key: string): Promise<void>;
     abstract handlerId: string;

package/dist/types/actionHandlers/IdempotentWrite.d.ts

@@ -7,7 +7,8 @@ export declare const enum IdempotentWriteSpecificHttpStatusCode {
     RequestTimeout = 408,
     Conflict = 409,
     BadGateway = 502,
-    ServiceUnavailable = 503
+    ServiceUnavailable = 503,
+    UnProcessableEntity = 422
 }
 /**
  * The http status code which could be returned from idempotent write.
@@ -15,8 +16,12 @@ export declare const enum IdempotentWriteSpecificHttpStatusCode {
 export type IdempotentWriteHttpStatusCode = IdempotentWriteSpecificHttpStatusCode | HttpStatusCode;
 export declare const HTTP_HEADER_RETRY_AFTER = "Retry-After";
 export declare const HTTP_HEADER_IDEMPOTENCY_KEY = "Idempotency-Key";
+export declare const ERROR_CODE_IDEMPOTENCY_FEATURE_NOT_ENABLED = "IDEMPOTENCY_FEATURE_NOT_ENABLED";
+export declare const ERROR_CODE_IDEMPOTENCY_NOT_SUPPORTED = "IDEMPOTENCY_NOT_SUPPORTED";
 export declare const ERROR_CODE_IDEMPOTENCY_KEY_USED_DIFFERENT_USER = "IDEMPOTENCY_KEY_USED_DIFFERENT_USER";
 export declare const ERROR_CODE_IDEMPOTENCY_CONCURRENT_REQUEST = "IDEMPOTENCY_CONCURRENT_REQUEST";
+export declare const ERROR_CODE_IDEMPOTENCY_KEY_ALREADY_USED = "IDEMPOTENCY_KEY_ALREADY_USED";
+export declare const ERROR_CODE_IDEMPOTENCY_BACKEND_OPERATION_ERROR = "IDEMPOTENCY_BACKEND_OPERATION_ERROR";
 /**
  * Get the retry after in milliseconds from the response headers, undefined if not specified.
  * The header could have two different format.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-drafts",
-    "version": "1.228.1",
+    "version": "1.229.0-dev10",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS Drafts",
     "main": "dist/ldsDrafts.js",
@@ -24,8 +24,8 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --adapter=lds-drafts"
     },
     "dependencies": {
-        "@luvio/engine": "0.145.2",
-        "@luvio/environments": "0.145.2",
-        "@salesforce/lds-utils-adapters": "*"
+        "@luvio/engine": "0.146.0-dev5",
+        "@luvio/environments": "0.146.0-dev5",
+        "@salesforce/lds-utils-adapters": "1.229.0-dev10"
     }
 }