@atlaskit/editor-synced-block-provider 8.5.7 → 8.6.1

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/editor-synced-block-provider
 
+## 8.6.1
+
+### Patch Changes
+
+- [`f543995529d9d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f543995529d9d) -
+  [ux] Synced blocks now recover automatically from realtime connection drops that happen while a
+  tab is hidden or the network is offline. Instead of showing a fetch error when reconnection
+  attempts are exhausted in the background, the block silently re-arms and reconnects when the tab
+  becomes visible again or the network comes back online.
+- Updated dependencies
+
+## 8.6.0
+
+### Minor Changes
+
+- [`c0b0b98789f7a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c0b0b98789f7a) -
+  Add analytics for synced block source creation: record the creation input method and whether the
+  block was created empty, and emit a one-off event the first time an empty source block gains
+  content.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.5.7
 
 ### Patch Changes

package/dist/cjs/store-manager/referenceSyncBlockStoreManager.js

@@ -1020,7 +1020,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 _context4.next = 1;
                 break;
               }
-              return _context4.abrupt("return", (0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_2'));
+              return _context4.abrupt("return", true);
             case 1:
               if (this.isCacheDirty) {
                 _context4.next = 2;

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

@@ -59,6 +59,20 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
      * multiple blocks are created concurrently. See EDITOR-7112.
      */
     (0, _defineProperty2.default)(this, "creationsTimedOutDuringFlush", new Set());
+    /**
+     * Creation-type signals captured at `createBodiedSyncBlockNode` time and read
+     * back in `commitPendingCreation` to enrich the `syncedBlockCreate` event.
+     * Kept out of the flushed cache record so it never leaks into Block Service /
+     * ADF; removed once consumed.
+     */
+    (0, _defineProperty2.default)(this, "creationEnrichment", new Map());
+    /**
+     * Resource IDs of blocks created empty this session that have not yet fired
+     * the first-content-added event. Added on empty creation, removed when the
+     * block first gains content (the event fires once). Blocks created with
+     * content or not created this session are never tracked.
+     */
+    (0, _defineProperty2.default)(this, "awaitingFirstContent", new Set());
     /**
      * resourceId -> timestamp (ms) of the last `syncedBlockDelete` emission, used
      * to suppress duplicates within {@link DELETE_DEDUPE_WINDOW_MS}. Only consulted
@@ -411,17 +425,48 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         var _this$fireAnalyticsEv4;
         var sourceProduct = (0, _utils.getSourceProductFromResourceIdSafe)(resourceId);
         (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, (0, _errorHandling.createSuccessPayload)(resourceId || '', sourceProduct));
-        // Operational create-success event with the join key.
+        // Operational create-success event with the join key + creation-type
+        // signals (inputMethod / createdEmpty) captured at the command layer.
         if ((0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_4')) {
           var _this$fireAnalyticsEv5, _this$syncBlockCache$;
-          (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, (0, _errorHandling.createSuccessOperationalPayload)(resourceId || '', (_this$syncBlockCache$ = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$ === void 0 ? void 0 : _this$syncBlockCache$.blockInstanceId, sourceProduct));
+          (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, (0, _errorHandling.createSuccessOperationalPayload)(resourceId || '', (_this$syncBlockCache$ = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$ === void 0 ? void 0 : _this$syncBlockCache$.blockInstanceId, sourceProduct, this.creationEnrichment.get(resourceId)));
         }
       } else {
         var _this$fireAnalyticsEv6;
         // Delete the node from cache if fail to create so it's not flushed to BE
         this.syncBlockCache.delete(resourceId || '');
+        // Creation failed, so there is no block to add content to — drop the
+        // first-content tracking entry so a later unrelated edit cannot fire it.
+        this.awaitingFirstContent.delete(resourceId || '');
         (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 || _this$fireAnalyticsEv6.call(this, (0, _errorHandling.createErrorPayload)('Fail to create bodied sync block', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
       }
+      // Enrichment is single-use — drop it once the create has resolved either way.
+      this.creationEnrichment.delete(resourceId || '');
+    }
+
+    /**
+     * Fire the first-content-added event once when a block created empty this
+     * session first gains content. The caller detects the in-block edit; this owns
+     * dedupe + emission (fires at most once per block, only for empty→content).
+     * Gated behind `platform_editor_blocks_patch_4`.
+     */
+  }, {
+    key: "maybeEmitFirstContentAdded",
+    value: function maybeEmitFirstContentAdded(resourceId, blockInstanceId) {
+      var _this$fireAnalyticsEv7;
+      if (this.viewMode === 'view') {
+        return;
+      }
+      if (!(0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_4')) {
+        return;
+      }
+      // `delete` returns false when the id was not tracked (already emitted, or
+      // the block was not created empty this session), so this both dedupes and
+      // scopes emission to genuine first-content transitions in one check.
+      if (!this.awaitingFirstContent.delete(resourceId)) {
+        return;
+      }
+      (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, (0, _errorHandling.addContentSuccessPayload)(resourceId, blockInstanceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
     }
   }, {
     key: "registerConfirmationCallback",
@@ -461,16 +506,28 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
      * @param attrs attributes Ids of the node
      * @param node the ProseMirror node to cache
      * @param onCompletion callback invoked when creation completes
+     * @param enrichment optional creation-type signals stashed and attached to the
+     *   `syncedBlockCreate` event when the async create resolves. When
+     *   `createdEmpty` is true the block is also registered for the
+     *   first-content-added event.
      */
   }, {
     key: "createBodiedSyncBlockNode",
-    value: function createBodiedSyncBlockNode(attrs, node, onCompletion) {
+    value: function createBodiedSyncBlockNode(attrs, node, onCompletion, enrichment) {
       var _this4 = this;
       if (this.viewMode === 'view') {
         return;
       }
       var resourceId = attrs.resourceId,
         blockInstanceId = attrs.localId;
+      // Stash creation-type signals for commitPendingCreation to read.
+      if (enrichment) {
+        this.creationEnrichment.set(resourceId, enrichment);
+        // Only empty-created blocks can produce an empty→content transition.
+        if (enrichment.createdEmpty) {
+          this.awaitingFirstContent.add(resourceId);
+        }
+      }
       try {
         var _this$createExperienc;
         if (!this.dataProvider) {
@@ -520,14 +577,14 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         });
         this.pendingCreationPromises.set(resourceId, creationPromise);
       } catch (error) {
-        var _this$fireAnalyticsEv7;
+        var _this$fireAnalyticsEv8;
         if (this.isPendingCreation(resourceId)) {
           this.commitPendingCreation(false, resourceId);
         }
         (0, _monitoring.logException)(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, (0, _errorHandling.createErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, (0, _errorHandling.createErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
       }
     }
   }, {
@@ -565,11 +622,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
   }, {
     key: "emitDeleteSuccess",
     value: function emitDeleteSuccess(resourceId, reason, mechanism) {
-      var _this$syncBlockCache$2, _this$fireAnalyticsEv9;
+      var _this$syncBlockCache$2, _this$fireAnalyticsEv0;
       var sourceProduct = (0, _utils.getSourceProductFromResourceIdSafe)(resourceId);
       if (!(0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_4')) {
-        var _this$fireAnalyticsEv8;
-        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, (0, _errorHandling.deleteSuccessPayload)(resourceId, sourceProduct));
+        var _this$fireAnalyticsEv9;
+        (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, (0, _errorHandling.deleteSuccessPayload)(resourceId, sourceProduct));
         return;
       }
       var now = Date.now();
@@ -584,7 +641,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         deletionReason: reason,
         mechanism: mechanism
       };
-      (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, (0, _errorHandling.deleteSuccessPayload)(resourceId, sourceProduct, enrichment));
+      (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 || _this$fireAnalyticsEv0.call(this, (0, _errorHandling.deleteSuccessPayload)(resourceId, sourceProduct, enrichment));
     }
   }, {
     key: "delete",
@@ -933,11 +990,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
           return sourceInfo;
         });
       } catch (error) {
-        var _this$fireAnalyticsEv0;
+        var _this$fireAnalyticsEv1;
         (0, _monitoring.logException)(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 || _this$fireAnalyticsEv0.call(this, (0, _errorHandling.getSourceInfoErrorPayload)(error.message));
+        (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 || _this$fireAnalyticsEv1.call(this, (0, _errorHandling.getSourceInfoErrorPayload)(error.message));
         return Promise.resolve(undefined);
       }
     }
@@ -950,11 +1007,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         }
         return this.dataProvider.fetchReferences(resourceId, true);
       } catch (error) {
-        var _this$fireAnalyticsEv1;
+        var _this$fireAnalyticsEv10;
         (0, _monitoring.logException)(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 || _this$fireAnalyticsEv1.call(this, (0, _errorHandling.fetchReferencesErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+        (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 || _this$fireAnalyticsEv10.call(this, (0, _errorHandling.fetchReferencesErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
         return Promise.resolve({
           error: _types.SyncBlockError.Errored
         });
@@ -971,6 +1028,8 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
       this.postCreationFlushCallback = undefined;
       this.pendingCreationPromises.clear();
       this.creationsTimedOutDuringFlush.clear();
+      this.creationEnrichment.clear();
+      this.awaitingFirstContent.clear();
       this.recentDeleteEmissions.clear();
       this.dataProvider = undefined;
       (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.abort({