@salesforce/lds-drafts 1.145.0 → 1.146.0

package/dist/ldsDrafts.js

@@ -235,7 +235,6 @@ function buildLuvioOverrideForDraftAdapters(luvio, handler, extractTargetIdFromC
 }
 
 const DraftIdMappingKeyPrefix240 = 'DraftIdMapping::';
-const DraftKeyMappingKeyPrefix = 'DraftKeyMapping::V2::';
 const DRAFT_ID_MAPPINGS_SEGMENT = 'DRAFT_ID_MAPPINGS';
 function isLegacyDraftIdMapping(key, data) {
     return key.startsWith(DraftIdMappingKeyPrefix240);
@@ -245,9 +244,6 @@ function isLegacyDraftIdMapping(key, data) {
 function getRecordKeyForId(id) {
     return `UiApi::RecordRepresentation:${id}`;
 }
-function generateDraftIdMappingKey(draftIdMapping) {
-    return `${DraftKeyMappingKeyPrefix}${draftIdMapping.draftKey}::${draftIdMapping.canonicalKey}`;
-}
 /**
  *
  * @param mappingIds (optional) requested mapping ids, if undefined all will be retrieved
@@ -281,6 +277,15 @@ async function getDraftIdMappings(durableStore, mappingIds) {
     }
     return mappings;
 }
+async function clearDraftIdSegment(durableStore) {
+    const entries = await durableStore.getAllEntries(DRAFT_ID_MAPPINGS_SEGMENT);
+    if (entries) {
+        const keys$1 = keys(entries);
+        if (keys$1.length > 0) {
+            await durableStore.evictEntries(keys$1, DRAFT_ID_MAPPINGS_SEGMENT);
+        }
+    }
+}
 
 /**
  * Generates a time-ordered, unique id to associate with a DraftAction. Ensures
@@ -371,9 +376,6 @@ function customActionHandler(executor, id, draftQueue) {
         });
         return queueOperations;
     };
-    const getRedirectMappings = (_action) => {
-        return undefined;
-    };
     return {
         handlerId: id,
         enqueue: (data) => {
@@ -385,7 +387,6 @@ function customActionHandler(executor, id, draftQueue) {
         handleReplaceAction: () => {
             throw Error('replaceAction not supported for custom actions');
         },
-        getRedirectMappings,
         handleActionRemoved: () => Promise.resolve(),
         handleActionCompleted: () => Promise.resolve(),
         handleActionEnqueued: () => Promise.resolve(),
@@ -560,17 +561,11 @@ class DurableDraftQueue {
                 const handler = this.getHandler(action.handler);
                 let queue = await this.getQueueActions();
                 const queueOperations = handler.getQueueOperationsForCompletingDrafts(queue, action);
-                const idAndKeyMappings = handler.getRedirectMappings(action);
-                const keyMappings = idAndKeyMappings === undefined
-                    ? undefined
-                    : idAndKeyMappings.map((m) => {
-                        return { draftKey: m.draftKey, canonicalKey: m.canonicalKey };
-                    });
-                await this.draftStore.completeAction(queueOperations, keyMappings);
-                queue = await this.getQueueActions();
+                // write the queue operations to the store prior to ingesting the result
+                await this.draftStore.completeAction(queueOperations);
+                await handler.handleActionCompleted(action, queueOperations, values(this.handlers));
                 this.retryIntervalMilliseconds = 0;
                 this.uploadingActionId = undefined;
-                await handler.handleActionCompleted(action, queueOperations, queue, values(this.handlers));
                 await this.notifyChangedListeners({
                     type: DraftQueueEventType.ActionCompleted,
                     action,
@@ -893,7 +888,7 @@ class DurableDraftStore {
         };
         return this.enqueueAction(deleteAction);
     }
-    completeAction(queueOperations, mappings) {
+    completeAction(queueOperations) {
         const action = () => {
             const durableStoreOperations = [];
             const { draftStore } = this;
@@ -926,18 +921,6 @@ class DurableDraftStore {
                     });
                 }
             }
-            if (mappings !== undefined) {
-                const entries = {};
-                for (const mapping of mappings) {
-                    const mappingKey = generateDraftIdMappingKey(mapping);
-                    entries[mappingKey] = { data: mapping };
-                }
-                durableStoreOperations.push({
-                    entries,
-                    type: 'setEntries',
-                    segment: DRAFT_ID_MAPPINGS_SEGMENT,
-                });
-            }
             return this.durableStore.batchOperations(durableStoreOperations);
         };
         return this.enqueueAction(action);
@@ -1216,7 +1199,7 @@ class AbstractResourceRequestActionHandler {
             },
         ];
     }
-    async handleActionCompleted(action, queueOperations, _queue, allHandlers) {
+    async handleActionCompleted(action, queueOperations, allHandlers) {
         const { data: request, tag } = action;
         const { method } = request;
         if (method === 'delete') {
@@ -1330,11 +1313,18 @@ class AbstractResourceRequestActionHandler {
     async ingestResponses(responses, action) {
         const luvio = this.getLuvio();
         await luvio.handleSuccessResponse(() => {
+            if (action.status === DraftActionStatus.Completed) {
+                const mappings = this.getRedirectMappings(action);
+                if (mappings) {
+                    mappings.forEach((mapping) => {
+                        luvio.storeRedirect(mapping.draftKey, mapping.canonicalKey);
+                    });
+                }
+            }
             for (const entry of responses) {
                 const { response, synchronousIngest } = entry;
                 synchronousIngest(response, action);
             }
-            // must call base broadcast
             return luvio.storeBroadcast();
         }, 
         // getTypeCacheKeysRecord uses the response, not the full path factory
@@ -1663,6 +1653,8 @@ class DraftManager {
 
 function makeEnvironmentDraftAware(luvio, env, durableStore, handlers, draftQueue) {
     const draftMetadata = {};
+    // in 246 luvio took charge of persisting redirect mappings, this needs to stick around
+    // for a couple of releases to support older environments
     // setup existing store redirects when bootstrapping the environment
     (async () => {
         const mappings = await getDraftIdMappings(durableStore);
@@ -1670,23 +1662,9 @@ function makeEnvironmentDraftAware(luvio, env, durableStore, handlers, draftQueu
             const { draftKey, canonicalKey } = mapping;
             env.storeRedirect(draftKey, canonicalKey);
         });
+        await env.storeBroadcast(env.rebuildSnapshot, env.snapshotAvailable);
+        await clearDraftIdSegment(durableStore);
     })();
-    durableStore.registerOnChangedListener(async (changes) => {
-        const draftIdMappingsIds = [];
-        for (let i = 0, len = changes.length; i < len; i++) {
-            const change = changes[i];
-            if (change.segment === DRAFT_ID_MAPPINGS_SEGMENT) {
-                draftIdMappingsIds.push(...change.ids);
-            }
-        }
-        if (draftIdMappingsIds.length > 0) {
-            const mappings = await getDraftIdMappings(durableStore, draftIdMappingsIds);
-            mappings.forEach((mapping) => {
-                const { draftKey, canonicalKey } = mapping;
-                env.storeRedirect(draftKey, canonicalKey);
-            });
-        }
-    });
     const handleSuccessResponse = async function (ingestAndBroadcastFunc, getResponseCacheKeysFunc) {
         const queue = await draftQueue.getQueueActions();
         if (queue.length === 0) {

package/dist/types/DraftIdMapping.d.ts

@@ -4,9 +4,9 @@ export interface DraftKeyMapping {
     canonicalKey: string;
 }
 export declare const DRAFT_ID_MAPPINGS_SEGMENT = "DRAFT_ID_MAPPINGS";
-export declare function generateDraftIdMappingKey(draftIdMapping: DraftKeyMapping): string;
 /**
  *
  * @param mappingIds (optional) requested mapping ids, if undefined all will be retrieved
  */
 export declare function getDraftIdMappings(durableStore: DurableStore, mappingIds?: string[]): Promise<DraftKeyMapping[]>;
+export declare function clearDraftIdSegment(durableStore: DurableStore): Promise<void>;

package/dist/types/DraftStore.d.ts

@@ -1,5 +1,4 @@
 import type { DraftAction, QueueOperation } from './DraftQueue';
-import type { DraftKeyMapping } from './DraftIdMapping';
 /**
  * Defines the store where drafts are persisted
  */
@@ -8,5 +7,5 @@ export interface DraftStore {
     getAllDrafts(): Promise<DraftAction<unknown, unknown>[]>;
     deleteDraft(actionId: string): Promise<void>;
     deleteByTag(tag: string): Promise<void>;
-    completeAction(queueOperations: QueueOperation[], mappings: DraftKeyMapping[] | undefined): Promise<void>;
+    completeAction(queueOperations: QueueOperation[]): Promise<void>;
 }

package/dist/types/DurableDraftStore.d.ts

@@ -1,5 +1,4 @@
 import type { DurableStore } from '@luvio/environments';
-import type { DraftKeyMapping } from './DraftIdMapping';
 import type { DraftAction, QueueOperation } from './DraftQueue';
 import type { DraftStore } from './DraftStore';
 /**
@@ -21,7 +20,7 @@ export declare class DurableDraftStore implements DraftStore {
     getAllDrafts<_R, _D>(): Promise<DraftAction<unknown, unknown>[]>;
     deleteDraft(id: string): Promise<void>;
     deleteByTag(tag: string): Promise<void>;
-    completeAction(queueOperations: QueueOperation[], mappings: DraftKeyMapping[] | undefined): Promise<void>;
+    completeAction(queueOperations: QueueOperation[]): Promise<void>;
     /**
      * Runs a write operation against the draft store, if the initial
      * revive is still in progress, the action gets enqueued to run once the

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

@@ -22,7 +22,7 @@ export declare abstract class AbstractResourceRequestActionHandler<ResponseType,
     handleActionRemoved(action: DraftAction<ResourceRequest, ResponseType>): Promise<void>;
     getQueueOperationsForCompletingDrafts(queue: DraftAction<unknown, unknown>[], action: CompletedDraftAction<ResourceRequest, ResponseType>): QueueOperation[];
     getRedirectMappings(action: CompletedDraftAction<ResourceRequest, ResponseType>): DraftIdAndKeyMapping[] | undefined;
-    handleActionCompleted(action: CompletedDraftAction<ResourceRequest, ResponseType>, queueOperations: QueueOperation[], _queue: DraftAction<unknown, unknown>[], allHandlers: ActionHandler<unknown, unknown, unknown>[]): Promise<void>;
+    handleActionCompleted(action: CompletedDraftAction<ResourceRequest, ResponseType>, queueOperations: QueueOperation[], allHandlers: ActionHandler<unknown, unknown, unknown>[]): Promise<void>;
     handleReplaceAction(targetAction: DraftAction<ResourceRequest, ResponseType>, sourceAction: DraftAction<ResourceRequest, ResponseType>): DraftAction<ResourceRequest, ResponseType>;
     mergeActions(targetAction: DraftAction<ResourceRequest, ResponseType>, sourceAction: DraftAction<ResourceRequest, ResponseType>): DraftAction<ResourceRequest, ResponseType>;
     shouldDeleteActionByTagOnRemoval(action: DraftAction<ResourceRequest, ResponseType>): boolean;

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

@@ -72,20 +72,12 @@ export interface ActionHandler<Data, DraftMetadata, Type> {
      * @param action
      */
     getQueueOperationsForCompletingDrafts(queue: DraftAction<unknown, unknown>[], action: CompletedDraftAction<Data, Type>): QueueOperation[];
-    /**
-     * Invoked by the draft queue when an action is completing. Sometimes after an action completes we
-     * need to perform a key redirect (i.e. an object that used to have a draft id now has a real id and it needs to redirect the old id)
-     * This function returns an array of mappings if necessary or undefined if no redirect is necessary as a result of the completed operation
-     * @param action
-     */
-    getRedirectMappings(action: CompletedDraftAction<Data, Type>): DraftIdAndKeyMapping[] | undefined;
     /**
      * Invoked by the draft queue after an action completes and is removed from the queue
      * @param action The completed action
      * @param queueOperations The queue modification operations that were executes with the completed action
-     * @param queue The updated queue with the completed action removed
      */
-    handleActionCompleted(action: CompletedDraftAction<Data, Type>, queueOperations: QueueOperation[], queue: DraftAction<unknown, unknown>[], allHandlers: ActionHandler<unknown, unknown, unknown>[]): Promise<void>;
+    handleActionCompleted(action: CompletedDraftAction<Data, Type>, queueOperations: QueueOperation[], allHandlers: ActionHandler<unknown, unknown, unknown>[]): Promise<void>;
     /**
      * Replace the targetAction's data with the sourceAction's data and return
      * the targetAction.  Also sets the targetAction's status to Pending.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforce/lds-drafts",
-    "version": "1.145.0",
+    "version": "1.146.0",
     "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.142.4",
-        "@luvio/environments": "0.142.4",
+        "@luvio/engine": "0.143.0",
+        "@luvio/environments": "0.143.0",
         "@salesforce/lds-utils-adapters": "*"
     }
 }