@atlaskit/editor-synced-block-provider 3.11.0 → 3.12.1

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

@@ -8,7 +8,8 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 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 } from '../utils/errorHandling';
+import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload } from '../utils/errorHandling';
+import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience } from '../utils/experienceTracking';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // 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.
@@ -32,21 +33,9 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     key: "setFireAnalyticsEvent",
     value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
       this.fireAnalyticsEvent = fireAnalyticsEvent;
-    }
-  }, {
-    key: "setCreateExperience",
-    value: function setCreateExperience(createExperience) {
-      this.createExperience = createExperience;
-    }
-  }, {
-    key: "setSaveExperience",
-    value: function setSaveExperience(saveExperience) {
-      this.saveExperience = saveExperience;
-    }
-  }, {
-    key: "setDeleteExperience",
-    value: function setDeleteExperience(deleteExperience) {
-      this.deleteExperience = deleteExperience;
+      this.createExperience = getCreateSourceExperience(fireAnalyticsEvent);
+      this.saveExperience = getSaveSourceExperience(fireAnalyticsEvent);
+      this.deleteExperience = getDeleteSourceExperience(fireAnalyticsEvent);
     }
   }, {
     key: "isSourceBlock",
@@ -96,7 +85,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: (function () {
       var _flush = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
         var _this2 = this;
-        var bodiedSyncBlockNodes, bodiedSyncBlockData, _this$saveExperience, writeResults, successfulSaved, failedSave, _this$saveExperience2, _this$saveExperience3, _this$saveExperience4, _this$fireAnalyticsEv2;
+        var bodiedSyncBlockNodes, bodiedSyncBlockData, _this$saveExperience, writeResults, _this$saveExperience2, _this$saveExperience3, _this$fireAnalyticsEv2;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -130,17 +119,16 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               }
               return _context.abrupt("return", Promise.resolve(true));
             case 6:
-              // only start the save experience if we have sync blocks to save
-              if (fg('platform_synced_block_dogfooding')) {
-                (_this$saveExperience = this.saveExperience) === null || _this$saveExperience === void 0 || _this$saveExperience.start({});
-              }
-              ;
               if (this.dataProvider) {
-                _context.next = 10;
+                _context.next = 8;
                 break;
               }
               throw new Error('Data provider not set');
-            case 10:
+            case 8:
+              if (fg('platform_synced_block_dogfooding')) {
+                (_this$saveExperience = this.saveExperience) === null || _this$saveExperience === void 0 || _this$saveExperience.start({});
+              }
+              ;
               _context.next = 12;
               return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
             case 12:
@@ -154,75 +142,50 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                   }
                 }
               });
-              successfulSaved = writeResults.filter(function (result) {
-                return result.resourceId && !result.error;
-              }).map(function (result) {
-                return {
-                  resourceId: result.resourceId
-                };
-              });
-              failedSave = writeResults.filter(function (result) {
-                return !result.resourceId || result.error;
-              }).map(function (result) {
-                return {
-                  resourceId: result.resourceId || 'unknown',
-                  failReason: result.error || 'Failed to save sync blocks'
-                };
-              });
               if (!writeResults.every(function (result) {
                 return result.resourceId && !result.error;
               })) {
-                _context.next = 22;
+                _context.next = 20;
                 break;
               }
               if (fg('platform_synced_block_dogfooding')) {
-                (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 || _this$saveExperience2.success({
-                  metadata: {
-                    successfulSaved: successfulSaved
+                (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 || _this$saveExperience2.success();
+                writeResults.forEach(function (result) {
+                  if (result.resourceId && !result.error) {
+                    var _this2$fireAnalyticsE;
+                    (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, updateSuccessPayload(result.resourceId, false));
                   }
                 });
               }
               ;
               return _context.abrupt("return", true);
-            case 22:
+            case 20:
               if (fg('platform_synced_block_dogfooding')) {
-                (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 || _this$saveExperience3.failure({
-                  metadata: {
-                    successfulSaved: successfulSaved,
-                    failedSave: failedSave
-                  }
-                });
-              } else {
-                writeResults.filter(function (result) {
-                  return !result.resourceId || result.error;
-                }).forEach(function (result) {
-                  var _this2$fireAnalyticsE;
-                  (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, updateErrorPayload(result.error || 'Failed to write data'));
-                });
+                (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 || _this$saveExperience3.failure();
               }
+              writeResults.filter(function (result) {
+                return !result.resourceId || result.error;
+              }).forEach(function (result) {
+                var _this2$fireAnalyticsE2;
+                (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, updateErrorPayload(result.error || 'Failed to write data', result.resourceId));
+              });
               return _context.abrupt("return", false);
-            case 24:
-              _context.next = 31;
+            case 23:
+              _context.next = 30;
               break;
-            case 26:
-              _context.prev = 26;
+            case 25:
+              _context.prev = 25;
               _context.t0 = _context["catch"](0);
               logException(_context.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
-              if (fg('platform_synced_block_dogfooding')) {
-                (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.failure({
-                  reason: _context.t0.message
-                });
-              } else {
-                (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, updateErrorPayload(_context.t0.message));
-              }
+              (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, updateErrorPayload(_context.t0.message));
               return _context.abrupt("return", false);
-            case 31:
+            case 30:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 26]]);
+        }, _callee, this, [[0, 25]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);
@@ -253,6 +216,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function commitPendingCreation(success) {
       if (success && this.creationCallback) {
         this.creationCallback();
+        if (fg('platform_synced_block_dogfooding')) {
+          var _this$fireAnalyticsEv3;
+          (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, createSuccessPayload(this.pendingResourceId || ''));
+        }
+      } else if (success && !this.creationCallback && fg('platform_synced_block_dogfooding')) {
+        var _this$fireAnalyticsEv4;
+        (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, createErrorPayload('creation callback missing', this.pendingResourceId));
       }
       this.pendingResourceId = undefined;
       this.creationCallback = undefined;
@@ -309,11 +279,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function createBodiedSyncBlockNode(attrs) {
       var _this4 = this;
       try {
+        var _this$createExperienc;
         if (!this.dataProvider) {
           throw new Error('Data provider not set');
         }
         var resourceId = attrs.resourceId,
           blockInstanceId = attrs.localId;
+        (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 || _this$createExperienc.start({});
         this.dataProvider.createNodeData({
           content: [],
           blockInstanceId: blockInstanceId,
@@ -322,50 +294,45 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           var resourceId = result.resourceId;
           if (resourceId) {
             _this4.commitPendingCreation(true);
+            if (fg('platform_synced_block_dogfooding')) {
+              var _this4$createExperien;
+              (_this4$createExperien = _this4.createExperience) === null || _this4$createExperien === void 0 || _this4$createExperien.success();
+            }
           } else {
+            var _this4$fireAnalyticsE;
             _this4.commitPendingCreation(false);
             if (fg('platform_synced_block_dogfooding')) {
-              var _this4$createExperien;
-              (_this4$createExperien = _this4.createExperience) === null || _this4$createExperien === void 0 || _this4$createExperien.failure({
+              var _this4$createExperien2;
+              (_this4$createExperien2 = _this4.createExperience) === null || _this4$createExperien2 === void 0 || _this4$createExperien2.failure({
                 reason: result.error || 'Failed to create bodied sync block'
               });
-            } else {
-              var _this4$fireAnalyticsE;
-              (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block'));
             }
+            (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId));
           }
         }).catch(function (error) {
+          var _this4$fireAnalyticsE2;
           _this4.commitPendingCreation(false);
           logException(error, {
             location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
           });
           if (fg('platform_synced_block_dogfooding')) {
-            var _this4$createExperien2;
-            (_this4$createExperien2 = _this4.createExperience) === null || _this4$createExperien2 === void 0 || _this4$createExperien2.failure({
+            var _this4$createExperien3;
+            (_this4$createExperien3 = _this4.createExperience) === null || _this4$createExperien3 === void 0 || _this4$createExperien3.failure({
               reason: error.message
             });
-          } else {
-            var _this4$fireAnalyticsE2;
-            (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, createErrorPayload(error.message));
           }
+          (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, createErrorPayload(error.message, resourceId));
         });
         this.registerPendingCreation(resourceId);
       } catch (error) {
+        var _this$fireAnalyticsEv5;
         if (this.hasPendingCreation()) {
           this.commitPendingCreation(false);
         }
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        if (fg('platform_synced_block_dogfooding')) {
-          var _this$createExperienc;
-          (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 || _this$createExperienc.failure({
-            reason: error.message
-          });
-        } else {
-          var _this$fireAnalyticsEv3;
-          (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, createErrorPayload(error.message));
-        }
+        (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, createErrorPayload(error.message));
       }
     }
   }, {
@@ -373,7 +340,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function () {
       var _delete2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(syncBlockIds, onDelete, onDeleteCompleted) {
         var _this5 = this;
-        var results, callback, isDeleteSuccessful, _this$deleteExperienc, successfulDeleted, failedDelete, _this$deleteExperienc2, _this$fireAnalyticsEv4;
+        var _this$deleteExperienc, results, callback, isDeleteSuccessful, _this$deleteExperienc2, _this$deleteExperienc3;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -387,11 +354,14 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, true);
               });
-              _context2.next = 6;
+              if (fg('platform_synced_block_dogfooding')) {
+                (_this$deleteExperienc = this.deleteExperience) === null || _this$deleteExperienc === void 0 || _this$deleteExperienc.start({});
+              }
+              _context2.next = 7;
               return this.dataProvider.deleteNodesData(syncBlockIds.map(function (attrs) {
                 return attrs.resourceId;
               }));
-            case 6:
+            case 7:
               results = _context2.sent;
               isDeleteSuccessful = results.every(function (result) {
                 return result.success;
@@ -403,66 +373,57 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                   return _this5.syncBlockCache.delete(Ids.resourceId);
                 };
                 this.clearPendingDeletion();
+                if (fg('platform_synced_block_dogfooding')) {
+                  (_this$deleteExperienc2 = this.deleteExperience) === null || _this$deleteExperienc2 === void 0 || _this$deleteExperienc2.success();
+                  results.forEach(function (result) {
+                    var _this5$fireAnalyticsE;
+                    (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, deleteSuccessPayload(result.resourceId));
+                  });
+                }
               } else {
                 callback = function callback(Ids) {
                   _this5.setPendingDeletion(Ids, false);
                 };
                 if (fg('platform_synced_block_dogfooding')) {
-                  successfulDeleted = results.filter(function (result) {
-                    return result.success;
-                  }).map(function (result) {
-                    return {
-                      resourceId: result.resourceId
-                    };
-                  });
-                  failedDelete = results.filter(function (result) {
-                    return !result.success;
-                  }).map(function (result) {
-                    return {
-                      resourceId: result.resourceId || 'unknown',
-                      failReason: result.error || 'Failed to delete sync block'
-                    };
-                  });
-                  (_this$deleteExperienc = this.deleteExperience) === null || _this$deleteExperienc === void 0 || _this$deleteExperienc.failure({
-                    metadata: {
-                      successfulDeleted: successfulDeleted,
-                      failedDelete: failedDelete
+                  (_this$deleteExperienc3 = this.deleteExperience) === null || _this$deleteExperienc3 === void 0 || _this$deleteExperienc3.failure();
+                  results.forEach(function (result) {
+                    if (result.success) {
+                      var _this5$fireAnalyticsE2;
+                      (_this5$fireAnalyticsE2 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE2 === void 0 || _this5$fireAnalyticsE2.call(_this5, deleteSuccessPayload(result.resourceId));
+                    } else {
+                      var _this5$fireAnalyticsE3;
+                      (_this5$fireAnalyticsE3 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE3 === void 0 || _this5$fireAnalyticsE3.call(_this5, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId));
                     }
                   });
                 } else {
                   results.filter(function (result) {
                     return result.resourceId === undefined;
                   }).forEach(function (result) {
-                    var _this5$fireAnalyticsE;
-                    (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, deleteErrorPayload(result.error || 'Failed to delete synced block'));
+                    var _this5$fireAnalyticsE4;
+                    (_this5$fireAnalyticsE4 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE4 === void 0 || _this5$fireAnalyticsE4.call(_this5, deleteErrorPayload(result.error || 'Failed to delete synced block'));
                   });
                 }
               }
               syncBlockIds.forEach(callback);
               return _context2.abrupt("return", isDeleteSuccessful);
-            case 14:
-              _context2.prev = 14;
+            case 15:
+              _context2.prev = 15;
               _context2.t0 = _context2["catch"](0);
               syncBlockIds.forEach(function (Ids) {
+                var _this5$fireAnalyticsE5;
                 _this5.setPendingDeletion(Ids, false);
+                (_this5$fireAnalyticsE5 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE5 === void 0 || _this5$fireAnalyticsE5.call(_this5, deleteErrorPayload(_context2.t0.message, Ids.resourceId));
               });
               logException(_context2.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
-              if (fg('platform_synced_block_dogfooding')) {
-                (_this$deleteExperienc2 = this.deleteExperience) === null || _this$deleteExperienc2 === void 0 || _this$deleteExperienc2.failure({
-                  reason: _context2.t0.message
-                });
-              } else {
-                (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, deleteErrorPayload(_context2.t0.message));
-              }
               onDeleteCompleted(false);
               return _context2.abrupt("return", false);
             case 21:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[0, 14]]);
+        }, _callee2, this, [[0, 15]]);
       }));
       function _delete(_x, _x2, _x3) {
         return _delete2.apply(this, arguments);
@@ -580,22 +541,32 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         }
         return this.dataProvider.fetchSyncBlockSourceInfo(localId, undefined, undefined, this.fireAnalyticsEvent);
       } catch (error) {
-        var _this$fireAnalyticsEv5;
+        var _this$fireAnalyticsEv6;
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, getSourceInfoErrorPayload(error.message));
+        (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 || _this$fireAnalyticsEv6.call(this, getSourceInfoErrorPayload(error.message));
         return Promise.resolve(undefined);
       }
     }
   }, {
     key: "destroy",
     value: function destroy() {
+      var _this$saveExperience4, _this$createExperienc2, _this$deleteExperienc4;
       this.syncBlockCache.clear();
       this.confirmationCallback = undefined;
       this.pendingResourceId = undefined;
       this.creationCallback = undefined;
       this.dataProvider = undefined;
+      (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.abort({
+        reason: 'editor-destroyed'
+      });
+      (_this$createExperienc2 = this.createExperience) === null || _this$createExperienc2 === void 0 || _this$createExperienc2.abort({
+        reason: 'editor-destroyed'
+      });
+      (_this$deleteExperienc4 = this.deleteExperience) === null || _this$deleteExperienc4 === void 0 || _this$deleteExperienc4.abort({
+        reason: 'editor-destroyed'
+      });
       this.clearPendingDeletion();
     }
   }]);

package/dist/esm/utils/errorHandling.js

@@ -1,4 +1,8 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
+import { fg } from '@atlaskit/platform-feature-flags';
 export var stringifyError = function stringifyError(error) {
   try {
     return JSON.stringify(error);
@@ -6,38 +10,93 @@ export var stringifyError = function stringifyError(error) {
     return undefined;
   }
 };
-export var getErrorPayload = function getErrorPayload(actionSubjectId, error) {
+export var getErrorPayload = function getErrorPayload(actionSubjectId, error, resourceId) {
   return {
     action: ACTION.ERROR,
     actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
     actionSubjectId: actionSubjectId,
     eventType: EVENT_TYPE.OPERATIONAL,
-    attributes: {
+    attributes: fg('platform_synced_block_dogfooding') ? _objectSpread({
+      error: error
+    }, resourceId && {
+      resourceId: resourceId
+    }) : {
       error: error
     }
   };
 };
-export var fetchErrorPayload = function fetchErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error);
+export var fetchErrorPayload = function fetchErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error, resourceId);
+};
+export var getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId);
+};
+export var updateErrorPayload = function updateErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId);
 };
-export var getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error);
+export var updateReferenceErrorPayload = function updateReferenceErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId);
 };
-export var updateErrorPayload = function updateErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error);
+export var createErrorPayload = function createErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId);
 };
-export var updateReferenceErrorPayload = function updateReferenceErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error);
+export var deleteErrorPayload = function deleteErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId);
 };
-export var createErrorPayload = function createErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error);
+export var updateCacheErrorPayload = function updateCacheErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error, resourceId);
 };
-export var deleteErrorPayload = function deleteErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error);
+export var fetchReferencesErrorPayload = function fetchReferencesErrorPayload(error, resourceId) {
+  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH_REFERENCES, error, resourceId);
+};
+
+// Success payloads
+export var fetchSuccessPayload = function fetchSuccessPayload(resourceId, blockInstanceId, sourceProduct) {
+  return {
+    action: ACTION.FETCHED,
+    actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH,
+    eventType: EVENT_TYPE.OPERATIONAL,
+    attributes: _objectSpread({
+      resourceId: resourceId,
+      blockInstanceId: blockInstanceId
+    }, sourceProduct && {
+      sourceProduct: sourceProduct
+    })
+  };
+};
+export var createSuccessPayload = function createSuccessPayload(resourceId) {
+  return {
+    action: ACTION.INSERTED,
+    actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE,
+    eventType: EVENT_TYPE.OPERATIONAL,
+    attributes: {
+      resourceId: resourceId
+    }
+  };
 };
-export var updateCacheErrorPayload = function updateCacheErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error);
+export var updateSuccessPayload = function updateSuccessPayload(resourceId, hasReference) {
+  return {
+    action: ACTION.UPDATED,
+    actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE,
+    eventType: EVENT_TYPE.OPERATIONAL,
+    attributes: _objectSpread({
+      resourceId: resourceId
+    }, hasReference !== undefined && {
+      hasReference: hasReference
+    })
+  };
 };
-export var fetchReferencesErrorPayload = function fetchReferencesErrorPayload(error) {
-  return getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH_REFERENCES, error);
+export var deleteSuccessPayload = function deleteSuccessPayload(resourceId) {
+  return {
+    action: ACTION.DELETED,
+    actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE,
+    eventType: EVENT_TYPE.OPERATIONAL,
+    attributes: {
+      resourceId: resourceId
+    }
+  };
 };

package/dist/esm/utils/experienceTracking.js

@@ -0,0 +1,113 @@
+import { ACTION } from '@atlaskit/editor-common/analytics';
+import { Experience, EXPERIENCE_ID, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
+var TIMEOUT_DURATION = 30000;
+export var createExperienceDispatcher = function createExperienceDispatcher(fireAnalyticsEvent) {
+  return function (payload) {
+    // Runtime type guard - only forward experience events
+    if (payload.action === ACTION.EXPERIENCE_MEASURED || payload.action === ACTION.EXPERIENCE_SAMPLED) {
+      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent(payload);
+    }
+  };
+};
+
+/**
+ * This experience tracks when a source sync block is saved to the BE.
+ *
+ * Start: When the flush source sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+export var getSaveSourceExperience = function getSaveSourceExperience(fireAnalyticsEvent) {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.SYNCED_BLOCK_UPDATE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a reference sync block is saved to the BE.
+ *
+ * Start: When the flush sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+export var getSaveReferenceExperience = function getSaveReferenceExperience(fireAnalyticsEvent) {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.REFERENCE_SYNCED_BLOCK_UPDATE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a reference sync block data is fetched from the BE.
+ *
+ * Start: When the fetchNodesData function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export var getFetchExperience = function getFetchExperience(fireAnalyticsEvent) {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.SYNCED_BLOCK_FETCH,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export var getFetchSourceInfoExperience = function getFetchSourceInfoExperience(fireAnalyticsEvent) {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.SYNCED_BLOCK_GET_SOURCE_INFO,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a source sync block is deleted from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export var getDeleteSourceExperience = function getDeleteSourceExperience(fireAnalyticsEvent) {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.SYNCED_BLOCK_DELETE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a source sync block is created and registered to the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export var getCreateSourceExperience = function getCreateSourceExperience(fireAnalyticsEvent) {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.SYNCED_BLOCK_CREATE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};