@salesforce/lds-drafts 1.443.0 → 1.445.0

package/dist/ldsDrafts.js

@@ -259,7 +259,7 @@ function customActionHandler(executor, id, draftQueue) {
             }, result.error.type === CustomActionErrorType.NETWORK_ERROR);
         }
     };
-    const buildPendingAction = (action, queue) => {
+    const buildPendingAction = (action, queue, observabilityContext) => {
         const { data, tag, targetId, handler } = action;
         const id = generateUniqueDraftActionId(queue.map((a) => a.id));
         return Promise.resolve({
@@ -271,6 +271,7 @@ function customActionHandler(executor, id, draftQueue) {
             timestamp: Date.now(),
             metadata: data,
             handler,
+            observabilityContext,
         });
     };
     const getQueueOperationsForCompletingDrafts = (_queue, action) => {
@@ -306,6 +307,13 @@ function customActionHandler(executor, id, draftQueue) {
 }
 
 const DRAFT_SEGMENT = 'DRAFT';
+/**
+ * Metadata key under which an action's upload retry-attempt count is persisted.
+ * Lives in the action's durable `metadata` bag so the count survives app restarts
+ * (the in-memory backoff interval resets on every startQueue()). Written by the
+ * action handler on each retry and cleared when an action is manually retried.
+ */
+const DRAFT_ACTION_RETRY_COUNT_METADATA_KEY = 'retryCount';
 class DurableDraftQueue {
     getHandler(id) {
         const handler = this.handlers[id];
@@ -442,12 +450,12 @@ class DurableDraftQueue {
             return aTime - bTime;
         });
     }
-    async enqueue(handlerId, data) {
+    async enqueue(handlerId, data, observabilityContext) {
         return this.workerPool.push({
             workFn: async () => {
                 let queue = await this.getQueueActions();
                 const handler = this.getHandler(handlerId);
-                const pendingAction = (await handler.buildPendingAction(data, queue));
+                const pendingAction = (await handler.buildPendingAction(data, queue, observabilityContext));
                 await this.draftStore.writeAction(pendingAction);
                 queue = await this.getQueueActions();
                 await this.notifyChangedListeners({
@@ -674,10 +682,14 @@ class DurableDraftQueue {
         if (!isDraftError(target)) {
             throw Error(`Action ${actionId} is not in Error state`);
         }
+        // A manual retry is a fresh start: clear the persisted upload retry-attempt
+        // count so the action doesn't immediately re-cap after a single failure.
+        const { [DRAFT_ACTION_RETRY_COUNT_METADATA_KEY]: _retryCount, ...metadataWithoutRetryCount } = target.metadata || {};
         let pendingAction = {
             ...target,
             status: DraftActionStatus.Pending,
             error: undefined,
+            metadata: metadataWithoutRetryCount,
         };
         await this.draftStore.writeAction(pendingAction);
         await this.notifyChangedListeners({
@@ -1269,7 +1281,7 @@ class DraftManager {
     }
     buildDraftQueueItem(action) {
         const operationType = getOperationTypeFrom(action);
-        const { id, status, timestamp, targetId, metadata } = action;
+        const { id, status, timestamp, targetId, metadata, observabilityContext } = action;
         const item = {
             id,
             targetId,
@@ -1277,6 +1289,7 @@ class DraftManager {
             timestamp,
             operationType,
             metadata,
+            observabilityContext,
         };
         if (isDraftError(action)) {
             // We should always return an array, if the body is just a dictionary,
@@ -1380,4 +1393,4 @@ function isResourceRequestAction(action) {
     return (dataAsAny !== undefined && dataAsAny.method !== undefined && dataAsAny.body !== undefined);
 }
 
-export { CustomActionResultType, DRAFT_ERROR_CODE, DRAFT_SEGMENT, DraftActionOperationType, DraftActionStatus, DraftErrorFetchResponse, DraftFetchResponse, DraftManager, DraftQueueEventType, DraftQueueState, DraftSynthesisError, DurableDraftQueue, DurableDraftStore, ProcessActionResult, QueueOperationType, createBadRequestResponse, createDeletedResponse, createDraftSynthesisErrorResponse, createInternalErrorResponse, createNotFoundResponse, createOkResponse, generateUniqueDraftActionId, isDraftSynthesisError, transformErrorToDraftSynthesisError };
+export { CustomActionResultType, DRAFT_ACTION_RETRY_COUNT_METADATA_KEY, DRAFT_ERROR_CODE, DRAFT_SEGMENT, DraftActionOperationType, DraftActionStatus, DraftErrorFetchResponse, DraftFetchResponse, DraftManager, DraftQueueEventType, DraftQueueState, DraftSynthesisError, DurableDraftQueue, DurableDraftStore, ProcessActionResult, QueueOperationType, createBadRequestResponse, createDeletedResponse, createDraftSynthesisErrorResponse, createInternalErrorResponse, createNotFoundResponse, createOkResponse, generateUniqueDraftActionId, isDraftSynthesisError, transformErrorToDraftSynthesisError };

package/dist/types/DraftManager.d.ts

@@ -1,4 +1,5 @@
 import type { CustomActionResult } from './actionHandlers/CustomActionHandler';
+import type { ObservabilityContext } from '@salesforce/nimbus-plugin-lds';
 import type { DraftQueue, DraftAction, DraftActionMetadata, PendingDraftAction, DraftQueueState } from './DraftQueue';
 import { DraftActionStatus } from './DraftQueue';
 import type { ResourceRequest } from '@luvio/engine';
@@ -37,6 +38,8 @@ export interface DraftQueueItem {
     error?: undefined | DraftQueueItemError;
     /** The stored metadata for the draft queue item */
     metadata: DraftQueueItemMetadata;
+    /** o11y context from draft creation time, forwarded at replay */
+    observabilityContext?: ObservabilityContext;
 }
 /**
  * An error of a draft action that was submitted and failed

package/dist/types/DraftQueue.d.ts

@@ -1,4 +1,5 @@
 import type { FetchResponse } from '@luvio/engine';
+import type { ObservabilityContext } from '@salesforce/nimbus-plugin-lds';
 import type { ActionHandler } from './actionHandlers/ActionHandler';
 import type { CustomActionExecutor } from './actionHandlers/CustomActionHandler';
 export declare enum DraftActionStatus {
@@ -25,6 +26,8 @@ interface BaseDraftAction<Data> {
     /** the data being enqueued */
     data: Data;
     version: '242.0.0';
+    /** o11y context from draft creation time, forwarded verbatim at replay */
+    observabilityContext?: ObservabilityContext;
 }
 export interface CompletedDraftAction<Data, Response> extends BaseDraftAction<Data> {
     status: DraftActionStatus.Completed;
@@ -162,10 +165,11 @@ export interface DraftQueue {
      * Enqueues a draft action into the DraftQueue
      * @param handlerId the id of the handler associated with the data
      * @param data the data the handler will use to create the draft action with
+     * @param observabilityContext optional o11y context from the enqueuing call site, persisted for replay
      * @returns A promise including the pending action created for the request and the data associated with the action
      * @throws {Error} An error when a proper action handler is not found or conditions are not met to enqueue the action
      */
-    enqueue<Data>(handlerId: string, data: Data): Promise<PendingDraftAction<Data>>;
+    enqueue<Data>(handlerId: string, data: Data, observabilityContext?: ObservabilityContext): Promise<PendingDraftAction<Data>>;
     /**
      * add a new handler to the draft queue to process the data in the actions
      * @param id identifier to the handler

package/dist/types/DurableDraftQueue.d.ts

@@ -3,7 +3,15 @@ import { ProcessActionResult, DraftQueueState } from './DraftQueue';
 import type { CustomActionExecutor } from './actionHandlers/CustomActionHandler';
 import type { ActionHandler } from './actionHandlers/ActionHandler';
 import type { DraftStore } from './DraftStore';
+import type { ObservabilityContext } from '@salesforce/nimbus-plugin-lds';
 export declare const DRAFT_SEGMENT = "DRAFT";
+/**
+ * Metadata key under which an action's upload retry-attempt count is persisted.
+ * Lives in the action's durable `metadata` bag so the count survives app restarts
+ * (the in-memory backoff interval resets on every startQueue()). Written by the
+ * action handler on each retry and cleared when an action is manually retried.
+ */
+export declare const DRAFT_ACTION_RETRY_COUNT_METADATA_KEY = "retryCount";
 export declare class DurableDraftQueue implements DraftQueue {
     private retryIntervalMilliseconds;
     private minimumRetryInterval;
@@ -33,7 +41,7 @@ export declare class DurableDraftQueue implements DraftQueue {
      */
     private stopQueueManually;
     getQueueActions<Data = unknown, Response = unknown>(): Promise<DraftAction<Data, Response>[]>;
-    enqueue<Data>(handlerId: string, data: unknown): Promise<PendingDraftAction<Data>>;
+    enqueue<Data>(handlerId: string, data: unknown, observabilityContext?: ObservabilityContext): Promise<PendingDraftAction<Data>>;
     registerOnChangedListener(listener: DraftQueueChangeListener): () => Promise<void>;
     actionCompleted(action: CompletedDraftAction<unknown, unknown>): Promise<void>;
     actionFailed(action: DraftAction<unknown, unknown>, retry: boolean, retryDelayInMs?: number, actionDataChanged?: boolean): Promise<void>;

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

@@ -1,3 +1,4 @@
+import type { ObservabilityContext } from '@salesforce/nimbus-plugin-lds';
 import type { CompletedDraftAction, DraftAction, DraftActionMetadata, PendingDraftAction, ProcessActionResult, QueueOperation } from '../DraftQueue';
 export interface ReplacingActions<Response, Data> {
     original: DraftAction<Response, Data>;
@@ -26,10 +27,11 @@ export interface ActionHandler<Data, Type> {
      * Used to build a PendingDraftAction that is specific to the type of Data and Response.
      * @param data
      * @param queue
+     * @param observabilityContext optional o11y context to persist on the action for replay
      *
      * @throws {Error} if any preconditions to building the draft action are not satisfied
      */
-    buildPendingAction(data: unknown, queue: DraftAction<unknown, unknown>[]): Promise<PendingDraftAction<Data>>;
+    buildPendingAction(data: unknown, queue: DraftAction<unknown, unknown>[], observabilityContext?: ObservabilityContext): Promise<PendingDraftAction<Data>>;
     /**
      * Invoked after an action is enqueued into the draft queue
      * @param action The action that was just enqueued

package/dist/types/main.d.ts

@@ -1,5 +1,5 @@
 export { DraftQueue, DraftQueueState, DraftAction, ErrorDraftAction, PendingDraftAction, CompletedDraftAction, DraftActionStatus, ProcessActionResult, DraftQueueChangeListener, DraftActionMetadata, DraftQueueEventType, QueueOperation, UpdateQueueOperation, QueueOperationType, type DraftQueueEvent, type DraftQueueActionFailedEvent, } from './DraftQueue';
-export { DurableDraftQueue, DRAFT_SEGMENT } from './DurableDraftQueue';
+export { DurableDraftQueue, DRAFT_SEGMENT, DRAFT_ACTION_RETRY_COUNT_METADATA_KEY, } from './DurableDraftQueue';
 export { generateUniqueDraftActionId, uuidv4 } from './utils/id';
 export { DurableDraftStore } from './DurableDraftStore';
 export { DraftStore } from './DraftStore';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-drafts",
-    "version": "1.443.0",
+    "version": "1.445.0",
     "license": "SEE LICENSE IN LICENSE.txt",
     "description": "LDS Drafts",
     "main": "dist/ldsDrafts.js",
@@ -24,12 +24,12 @@
         "release:corejar": "yarn build && ../core-build/scripts/core.js --adapter=lds-drafts"
     },
     "dependencies": {
-        "@luvio/engine": "0.160.5",
-        "@luvio/environments": "0.160.5",
-        "@salesforce/lds-utils-adapters": "^1.443.0"
+        "@luvio/engine": "0.161.0",
+        "@luvio/environments": "0.161.0",
+        "@salesforce/lds-utils-adapters": "^1.445.0"
     },
     "devDependencies": {
-        "@salesforce/nimbus-plugin-lds": "^1.443.0"
+        "@salesforce/nimbus-plugin-lds": "^1.445.0"
     },
     "volta": {
         "extends": "../../package.json"