@atlaskit/editor-synced-block-provider 8.4.3 → 8.5.0

package/dist/es2019/store-manager/sourceSyncBlockStoreManager.js

@@ -2,12 +2,20 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
-import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload, buildErrorAttribution } from '../utils/errorHandling';
+import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, createSuccessPayloadNew, deleteSuccessPayload, fetchReferencesErrorPayload, buildErrorAttribution } from '../utils/errorHandling';
 import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience, getFetchSourceInfoExperience } from '../utils/experienceTracking';
 import { convertSyncBlockPMNodeToSyncBlockData, getSourceProductFromResourceIdSafe } from '../utils/utils';
 /** Maximum time (ms) flush() will wait for in-flight block creations before proceeding. */
 const FLUSH_CREATION_AWAIT_TIMEOUT_MS = 1000;
 
+/**
+ * Window (ms) within which a repeated `syncedBlockDelete` emission for the same
+ * resourceId is suppressed. The same logical removal can re-fire across
+ * rebased/remote/redo transactions; a short window collapses those bursts to one
+ * event while still allowing a genuine delete→recreate→delete later.
+ */
+const DELETE_DEDUPE_WINDOW_MS = 5000;
+
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Designed to manage local in-memory state and synchronize with an external data provider.
 // Supports create, flush, and delete operations for source sync blocks.
@@ -32,6 +40,12 @@ export class SourceSyncBlockStoreManager {
      * multiple blocks are created concurrently. See EDITOR-7112.
      */
     _defineProperty(this, "creationsTimedOutDuringFlush", new Set());
+    /**
+     * resourceId -> timestamp (ms) of the last `syncedBlockDelete` emission, used
+     * to suppress duplicates within {@link DELETE_DEDUPE_WINDOW_MS}. Only consulted
+     * behind `platform_editor_blocks_patch_4`.
+     */
+    _defineProperty(this, "recentDeleteEmissions", new Map());
     _defineProperty(this, "setPendingDeletion", (Ids, value) => {
       if (this.viewMode === 'view') {
         return;
@@ -322,12 +336,18 @@ export class SourceSyncBlockStoreManager {
     }
     if (success) {
       var _this$fireAnalyticsEv6;
-      (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createSuccessPayload(resourceId || '', getSourceProductFromResourceIdSafe(resourceId)));
+      const sourceProduct = getSourceProductFromResourceIdSafe(resourceId);
+      (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createSuccessPayload(resourceId || '', sourceProduct));
+      // Operational create-success event with the join key.
+      if (fg('platform_editor_blocks_patch_4')) {
+        var _this$fireAnalyticsEv7, _this$syncBlockCache$;
+        (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 ? void 0 : _this$fireAnalyticsEv7.call(this, createSuccessPayloadNew(resourceId || '', (_this$syncBlockCache$ = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$ === void 0 ? void 0 : _this$syncBlockCache$.blockInstanceId, sourceProduct));
+      }
     } else {
-      var _this$fireAnalyticsEv7;
+      var _this$fireAnalyticsEv8;
       // Delete the node from cache if fail to create so it's not flushed to BE
       this.syncBlockCache.delete(resourceId || '');
-      (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 ? void 0 : _this$fireAnalyticsEv7.call(this, createErrorPayload('Fail to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+      (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.call(this, createErrorPayload('Fail to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId)));
     }
   }
   registerConfirmationCallback(callback) {
@@ -398,15 +418,15 @@ export class SourceSyncBlockStoreManager {
           this.commitPendingCreation(true, resourceId);
           (_this$createExperienc2 = this.createExperience) === null || _this$createExperienc2 === void 0 ? void 0 : _this$createExperienc2.success();
         } else {
-          var _this$createExperienc3, _this$fireAnalyticsEv8;
+          var _this$createExperienc3, _this$fireAnalyticsEv9;
           this.commitPendingCreation(false, resourceId);
           (_this$createExperienc3 = this.createExperience) === null || _this$createExperienc3 === void 0 ? void 0 : _this$createExperienc3.failure({
             reason: result.error || 'Failed to create bodied sync block'
           });
-          (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId), buildErrorAttribution(fg('platform_editor_blocks_patch_3'), result.error, result.statusCode)));
+          (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 ? void 0 : _this$fireAnalyticsEv9.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId), buildErrorAttribution(fg('platform_editor_blocks_patch_3'), result.error, result.statusCode)));
         }
       }).catch(error => {
-        var _this$createExperienc4, _this$fireAnalyticsEv9;
+        var _this$createExperienc4, _this$fireAnalyticsEv0;
         this.commitPendingCreation(false, resourceId);
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
@@ -414,23 +434,63 @@ export class SourceSyncBlockStoreManager {
         (_this$createExperienc4 = this.createExperience) === null || _this$createExperienc4 === void 0 ? void 0 : _this$createExperienc4.failure({
           reason: error.message
         });
-        (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 ? void 0 : _this$fireAnalyticsEv9.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+        (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 ? void 0 : _this$fireAnalyticsEv0.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
       }).finally(() => {
         this.pendingCreationPromises.delete(resourceId);
       });
       this.pendingCreationPromises.set(resourceId, creationPromise);
     } catch (error) {
-      var _this$fireAnalyticsEv0;
+      var _this$fireAnalyticsEv1;
       if (this.isPendingCreation(resourceId)) {
         this.commitPendingCreation(false, resourceId);
       }
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 ? void 0 : _this$fireAnalyticsEv0.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+      (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 ? void 0 : _this$fireAnalyticsEv1.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+    }
+  }
+  /**
+   * Drop dedupe entries older than {@link DELETE_DEDUPE_WINDOW_MS} so
+   * `recentDeleteEmissions` stays bounded by the number of recent deletes.
+   */
+  pruneRecentDeleteEmissions(now) {
+    for (const [resourceId, emittedAt] of this.recentDeleteEmissions) {
+      if (now - emittedAt >= DELETE_DEDUPE_WINDOW_MS) {
+        this.recentDeleteEmissions.delete(resourceId);
+      }
     }
   }
-  async delete(syncBlockIds, onDelete, onDeleteCompleted, reason) {
+
+  /**
+   * Emit the `syncedBlockDelete` success event. Gate off: legacy payload. Gate
+   * on: attaches `deletionReason`, `mechanism` and `blockInstanceId`, and
+   * suppresses repeat emissions within {@link DELETE_DEDUPE_WINDOW_MS}. Must run
+   * while the cache entry still exists so `blockInstanceId` is available.
+   */
+  emitDeleteSuccess(resourceId, reason, mechanism) {
+    var _this$syncBlockCache$2, _this$fireAnalyticsEv11;
+    const sourceProduct = getSourceProductFromResourceIdSafe(resourceId);
+    if (!fg('platform_editor_blocks_patch_4')) {
+      var _this$fireAnalyticsEv10;
+      (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 ? void 0 : _this$fireAnalyticsEv10.call(this, deleteSuccessPayload(resourceId, sourceProduct));
+      return;
+    }
+    const now = Date.now();
+    const lastEmittedAt = this.recentDeleteEmissions.get(resourceId);
+    if (lastEmittedAt !== undefined && now - lastEmittedAt < DELETE_DEDUPE_WINDOW_MS) {
+      return; // duplicate emission for the same logical removal
+    }
+    this.pruneRecentDeleteEmissions(now);
+    this.recentDeleteEmissions.set(resourceId, now);
+    const enrichment = {
+      blockInstanceId: (_this$syncBlockCache$2 = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$2 === void 0 ? void 0 : _this$syncBlockCache$2.blockInstanceId,
+      deletionReason: reason,
+      mechanism
+    };
+    (_this$fireAnalyticsEv11 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv11 === void 0 ? void 0 : _this$fireAnalyticsEv11.call(this, deleteSuccessPayload(resourceId, sourceProduct, enrichment));
+  }
+  async delete(syncBlockIds, onDelete, onDeleteCompleted, reason, mechanism) {
     try {
       var _this$deleteExperienc;
       if (this.viewMode === 'view') {
@@ -450,13 +510,14 @@ export class SourceSyncBlockStoreManager {
       if (isDeleteSuccessful) {
         var _this$deleteExperienc2;
         onDelete();
+        // Emit before the cache entry is deleted below, so blockInstanceId
+        // is still available to emitDeleteSuccess.
+        results.forEach(result => {
+          this.emitDeleteSuccess(result.resourceId, reason, mechanism);
+        });
         callback = Ids => this.syncBlockCache.delete(Ids.resourceId);
         this.clearPendingDeletion();
         (_this$deleteExperienc2 = this.deleteExperience) === null || _this$deleteExperienc2 === void 0 ? void 0 : _this$deleteExperienc2.success();
-        results.forEach(result => {
-          var _this$fireAnalyticsEv1;
-          (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 ? void 0 : _this$fireAnalyticsEv1.call(this, deleteSuccessPayload(result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
-        });
       } else {
         var _this$deleteExperienc3;
         callback = Ids => {
@@ -466,11 +527,10 @@ export class SourceSyncBlockStoreManager {
         const attributionEnabled = fg('platform_editor_blocks_patch_3');
         results.forEach(result => {
           if (result.success) {
-            var _this$fireAnalyticsEv10;
-            (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 ? void 0 : _this$fireAnalyticsEv10.call(this, deleteSuccessPayload(result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId)));
+            this.emitDeleteSuccess(result.resourceId, reason, mechanism);
           } else {
-            var _this$fireAnalyticsEv11;
-            (_this$fireAnalyticsEv11 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv11 === void 0 ? void 0 : _this$fireAnalyticsEv11.call(this, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId), buildErrorAttribution(attributionEnabled, result.error, result.statusCode)));
+            var _this$fireAnalyticsEv12;
+            (_this$fireAnalyticsEv12 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv12 === void 0 ? void 0 : _this$fireAnalyticsEv12.call(this, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId, getSourceProductFromResourceIdSafe(result.resourceId), buildErrorAttribution(attributionEnabled, result.error, result.statusCode)));
           }
         });
       }
@@ -481,9 +541,9 @@ export class SourceSyncBlockStoreManager {
       // so the attribution `reason` falls back to `unknown` when the gate is on.
       const attribution = buildErrorAttribution(fg('platform_editor_blocks_patch_3'));
       syncBlockIds.forEach(Ids => {
-        var _this$fireAnalyticsEv12;
+        var _this$fireAnalyticsEv13;
         this.setPendingDeletion(Ids, false);
-        (_this$fireAnalyticsEv12 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv12 === void 0 ? void 0 : _this$fireAnalyticsEv12.call(this, deleteErrorPayload(error.message, Ids.resourceId, getSourceProductFromResourceIdSafe(Ids.resourceId), attribution));
+        (_this$fireAnalyticsEv13 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv13 === void 0 ? void 0 : _this$fireAnalyticsEv13.call(this, deleteErrorPayload(error.message, Ids.resourceId, getSourceProductFromResourceIdSafe(Ids.resourceId), attribution));
       });
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
@@ -506,10 +566,11 @@ export class SourceSyncBlockStoreManager {
       syncBlockIds,
       onDelete,
       onDeleteCompleted,
-      deletionReason
+      deletionReason,
+      mechanism
     } = this.deletionRetryInfo;
     if (this.confirmationCallback) {
-      await this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason);
+      await this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason, mechanism);
     }
   }
   clearPendingDeletion() {
@@ -583,7 +644,9 @@ export class SourceSyncBlockStoreManager {
     // onDelete: no-op, document is being discarded
     () => {},
     // onDeleteCompleted: no-op
-    'source-block-unpublished');
+    'source-block-unpublished',
+    // Cancel/discard cleanup is code-initiated, not a direct user edit.
+    'other');
   }
 
   /**
@@ -594,14 +657,14 @@ export class SourceSyncBlockStoreManager {
    * @param onDeleteCompleted - The callback for after the deletion is saved to BE (whether successful or not)
    * @param destroyCallback - The callback to clear any reference stored for deletion (regardless if deletion is completed or abort)
    */
-  async deleteSyncBlocksWithConfirmation(syncBlockIds, deletionReason, onDelete, onDeleteCompleted, destroyCallback) {
+  async deleteSyncBlocksWithConfirmation(syncBlockIds, deletionReason, onDelete, onDeleteCompleted, destroyCallback, mechanism) {
     if (this.viewMode === 'view') {
       return Promise.resolve();
     }
     if (this.confirmationCallback) {
       const confirmed = await this.confirmationCallback(syncBlockIds, deletionReason);
       if (confirmed) {
-        const isDeleteSuccessful = await this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason);
+        const isDeleteSuccessful = await this.delete(syncBlockIds, onDelete, onDeleteCompleted, deletionReason, mechanism);
         if (!isDeleteSuccessful) {
           // If deletion failed, save deletion info for potential retry
           this.deletionRetryInfo = {
@@ -609,7 +672,8 @@ export class SourceSyncBlockStoreManager {
             onDelete,
             onDeleteCompleted,
             destroyCallback,
-            deletionReason
+            deletionReason,
+            mechanism
           };
         } else {
           destroyCallback();
@@ -639,11 +703,11 @@ export class SourceSyncBlockStoreManager {
         return sourceInfo;
       });
     } catch (error) {
-      var _this$fireAnalyticsEv13;
+      var _this$fireAnalyticsEv14;
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      (_this$fireAnalyticsEv13 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv13 === void 0 ? void 0 : _this$fireAnalyticsEv13.call(this, getSourceInfoErrorPayload(error.message));
+      (_this$fireAnalyticsEv14 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv14 === void 0 ? void 0 : _this$fireAnalyticsEv14.call(this, getSourceInfoErrorPayload(error.message));
       return Promise.resolve(undefined);
     }
   }
@@ -654,11 +718,11 @@ export class SourceSyncBlockStoreManager {
       }
       return this.dataProvider.fetchReferences(resourceId, true);
     } catch (error) {
-      var _this$fireAnalyticsEv14;
+      var _this$fireAnalyticsEv15;
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      (_this$fireAnalyticsEv14 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv14 === void 0 ? void 0 : _this$fireAnalyticsEv14.call(this, fetchReferencesErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+      (_this$fireAnalyticsEv15 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv15 === void 0 ? void 0 : _this$fireAnalyticsEv15.call(this, fetchReferencesErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
       return Promise.resolve({
         error: SyncBlockError.Errored
       });
@@ -673,6 +737,7 @@ export class SourceSyncBlockStoreManager {
     this.postCreationFlushCallback = undefined;
     this.pendingCreationPromises.clear();
     this.creationsTimedOutDuringFlush.clear();
+    this.recentDeleteEmissions.clear();
     this.dataProvider = undefined;
     (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 ? void 0 : _this$saveExperience4.abort({
       reason: 'editorDestroyed'

package/dist/es2019/utils/errorHandling.js

@@ -313,13 +313,25 @@ export const createSuccessPayload = (resourceId, sourceProduct) => {
     }
   };
 };
-export const createSuccessPayloadNew = resourceId => ({
+
+/**
+ * Operational `syncedBlockCreate` success event (previously only error rows
+ * existed, so dashboards had no create denominator). Fired behind
+ * `platform_editor_blocks_patch_4` with the `blockInstanceId` join key.
+ */
+export const createSuccessPayloadNew = (resourceId, blockInstanceId, sourceProduct) => ({
   action: ACTION.INSERTED,
   actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
   actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE,
   eventType: EVENT_TYPE.OPERATIONAL,
   attributes: {
-    resourceId
+    resourceId,
+    ...(blockInstanceId && {
+      blockInstanceId
+    }),
+    ...(sourceProduct && {
+      sourceProduct
+    })
   }
 });
 export const updateSuccessPayload = (resourceId, hasReference, sourceProduct) => ({
@@ -337,7 +349,14 @@ export const updateSuccessPayload = (resourceId, hasReference, sourceProduct) =>
     })
   }
 });
-export const deleteSuccessPayload = (resourceId, sourceProduct) => ({
+
+/**
+ * Optional enrichment for the `syncedBlockDelete` success event behind
+ * `platform_editor_blocks_patch_4`. All fields optional so the gate-off payload
+ * is unchanged; `blockInstanceId` is the bare-uuid join key.
+ */
+
+export const deleteSuccessPayload = (resourceId, sourceProduct, enrichment) => ({
   action: ACTION.DELETED,
   actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
   actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE,
@@ -346,6 +365,15 @@ export const deleteSuccessPayload = (resourceId, sourceProduct) => ({
     resourceId,
     ...(sourceProduct && {
       sourceProduct
+    }),
+    ...((enrichment === null || enrichment === void 0 ? void 0 : enrichment.blockInstanceId) && {
+      blockInstanceId: enrichment.blockInstanceId
+    }),
+    ...((enrichment === null || enrichment === void 0 ? void 0 : enrichment.deletionReason) && {
+      deletionReason: enrichment.deletionReason
+    }),
+    ...((enrichment === null || enrichment === void 0 ? void 0 : enrichment.mechanism) && {
+      mechanism: enrichment.mechanism
     })
   }
 });

package/dist/esm/common/types.js

@@ -27,6 +27,22 @@ export var SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["EntityNotFound"] = "entity_not_found";
   return SyncBlockError;
 }({});
+
+/**
+ * How a source bodiedSyncBlock removal was performed, derived from the
+ * originating transaction. Distinct from {@link DeletionReason} (the outcome):
+ * `mechanism` tells deliberate deletes apart from undos and accidental overwrites.
+ *
+ * Values name the user action that produced the removal:
+ *  - `undo` / `redo` — removal came from a history undo/redo.
+ *  - `deleteButton` — the explicit "Delete" control in the synced-block toolbar.
+ *  - `keyboardDelete` — Backspace/Delete key on a caret or range selection.
+ *  - `selectionReplaced` — the block was selected and replaced by typing or
+ *    pasting over it (the accidental-overwrite path).
+ *  - `other` — any non-direct removal (unsync, conversion, code-dispatched, or a
+ *    structural wrap/lift/unwrap edit).
+ */
+
 /**
  * Helpers to distinguish "data provider not ready / torn down" from a genuine
  * fetch/subscribe failure (EDITOR-7860). On Jira the provider is wired