@atlaskit/editor-synced-block-provider 3.12.0 → 3.13.0

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

@@ -2,7 +2,8 @@ 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 } 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.
@@ -22,15 +23,9 @@ export class SourceSyncBlockStoreManager {
   }
   setFireAnalyticsEvent(fireAnalyticsEvent) {
     this.fireAnalyticsEvent = fireAnalyticsEvent;
-  }
-  setCreateExperience(createExperience) {
-    this.createExperience = createExperience;
-  }
-  setSaveExperience(saveExperience) {
-    this.saveExperience = saveExperience;
-  }
-  setDeleteExperience(deleteExperience) {
-    this.deleteExperience = deleteExperience;
+    this.createExperience = getCreateSourceExperience(fireAnalyticsEvent);
+    this.saveExperience = getSaveSourceExperience(fireAnalyticsEvent);
+    this.deleteExperience = getDeleteSourceExperience(fireAnalyticsEvent);
   }
   isSourceBlock(node) {
     return node.type.name === 'bodiedSyncBlock';
@@ -101,16 +96,14 @@ export class SourceSyncBlockStoreManager {
       if (bodiedSyncBlockNodes.length === 0) {
         return Promise.resolve(true);
       }
-
-      // only start the save experience if we have sync blocks to save
+      if (!this.dataProvider) {
+        throw new Error('Data provider not set');
+      }
       if (fg('platform_synced_block_dogfooding')) {
         var _this$saveExperience;
         (_this$saveExperience = this.saveExperience) === null || _this$saveExperience === void 0 ? void 0 : _this$saveExperience.start({});
       }
       ;
-      if (!this.dataProvider) {
-        throw new Error('Data provider not set');
-      }
       const writeResults = await this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
       writeResults.forEach(result => {
         // set isDirty to true for cases where it failed to save the sync block to the BE
@@ -121,19 +114,14 @@ export class SourceSyncBlockStoreManager {
           }
         }
       });
-      const successfulSaved = writeResults.filter(result => result.resourceId && !result.error).map(result => ({
-        resourceId: result.resourceId
-      }));
-      const failedSave = writeResults.filter(result => !result.resourceId || result.error).map(result => ({
-        resourceId: result.resourceId || 'unknown',
-        failReason: result.error || 'Failed to save sync blocks'
-      }));
       if (writeResults.every(result => result.resourceId && !result.error)) {
         if (fg('platform_synced_block_dogfooding')) {
           var _this$saveExperience2;
-          (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 ? void 0 : _this$saveExperience2.success({
-            metadata: {
-              successfulSaved
+          (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 ? void 0 : _this$saveExperience2.success();
+          writeResults.forEach(result => {
+            if (result.resourceId && !result.error) {
+              var _this$fireAnalyticsEv2;
+              (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 ? void 0 : _this$fireAnalyticsEv2.call(this, updateSuccessPayload(result.resourceId, false));
             }
           });
         }
@@ -142,33 +130,20 @@ export class SourceSyncBlockStoreManager {
       } else {
         if (fg('platform_synced_block_dogfooding')) {
           var _this$saveExperience3;
-          (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 ? void 0 : _this$saveExperience3.failure({
-            metadata: {
-              successfulSaved,
-              failedSave
-            }
-          });
-        } else {
-          writeResults.filter(result => !result.resourceId || result.error).forEach(result => {
-            var _this$fireAnalyticsEv2;
-            (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 ? void 0 : _this$fireAnalyticsEv2.call(this, updateErrorPayload(result.error || 'Failed to write data'));
-          });
+          (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 ? void 0 : _this$saveExperience3.failure();
         }
+        writeResults.filter(result => !result.resourceId || result.error).forEach(result => {
+          var _this$fireAnalyticsEv3;
+          (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 ? void 0 : _this$fireAnalyticsEv3.call(this, updateErrorPayload(result.error || 'Failed to write data', result.resourceId));
+        });
         return false;
       }
     } catch (error) {
+      var _this$fireAnalyticsEv4;
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      if (fg('platform_synced_block_dogfooding')) {
-        var _this$saveExperience4;
-        (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 ? void 0 : _this$saveExperience4.failure({
-          reason: error.message
-        });
-      } else {
-        var _this$fireAnalyticsEv3;
-        (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 ? void 0 : _this$fireAnalyticsEv3.call(this, updateErrorPayload(error.message));
-      }
+      (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, updateErrorPayload(error.message));
       return false;
     }
   }
@@ -190,6 +165,13 @@ export class SourceSyncBlockStoreManager {
   commitPendingCreation(success) {
     if (success && this.creationCallback) {
       this.creationCallback();
+      if (fg('platform_synced_block_dogfooding')) {
+        var _this$fireAnalyticsEv5;
+        (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, createSuccessPayload(this.pendingResourceId || ''));
+      }
+    } else if (success && !this.creationCallback && fg('platform_synced_block_dogfooding')) {
+      var _this$fireAnalyticsEv6;
+      (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createErrorPayload('creation callback missing', this.pendingResourceId));
     }
     this.pendingResourceId = undefined;
     this.creationCallback = undefined;
@@ -235,6 +217,7 @@ export class SourceSyncBlockStoreManager {
    */
   createBodiedSyncBlockNode(attrs) {
     try {
+      var _this$createExperienc;
       if (!this.dataProvider) {
         throw new Error('Data provider not set');
       }
@@ -242,6 +225,7 @@ export class SourceSyncBlockStoreManager {
         resourceId,
         localId: blockInstanceId
       } = attrs;
+      (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 ? void 0 : _this$createExperienc.start({});
       this.dataProvider.createNodeData({
         content: [],
         blockInstanceId,
@@ -250,50 +234,45 @@ export class SourceSyncBlockStoreManager {
         const resourceId = result.resourceId;
         if (resourceId) {
           this.commitPendingCreation(true);
+          if (fg('platform_synced_block_dogfooding')) {
+            var _this$createExperienc2;
+            (_this$createExperienc2 = this.createExperience) === null || _this$createExperienc2 === void 0 ? void 0 : _this$createExperienc2.success();
+          }
         } else {
+          var _this$fireAnalyticsEv7;
           this.commitPendingCreation(false);
           if (fg('platform_synced_block_dogfooding')) {
-            var _this$createExperienc;
-            (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 ? void 0 : _this$createExperienc.failure({
+            var _this$createExperienc3;
+            (_this$createExperienc3 = this.createExperience) === null || _this$createExperienc3 === void 0 ? void 0 : _this$createExperienc3.failure({
               reason: result.error || 'Failed to create bodied sync block'
             });
-          } else {
-            var _this$fireAnalyticsEv4;
-            (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block'));
           }
+          (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 ? void 0 : _this$fireAnalyticsEv7.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId));
         }
       }).catch(error => {
+        var _this$fireAnalyticsEv8;
         this.commitPendingCreation(false);
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
         if (fg('platform_synced_block_dogfooding')) {
-          var _this$createExperienc2;
-          (_this$createExperienc2 = this.createExperience) === null || _this$createExperienc2 === void 0 ? void 0 : _this$createExperienc2.failure({
+          var _this$createExperienc4;
+          (_this$createExperienc4 = this.createExperience) === null || _this$createExperienc4 === void 0 ? void 0 : _this$createExperienc4.failure({
             reason: error.message
           });
-        } else {
-          var _this$fireAnalyticsEv5;
-          (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, createErrorPayload(error.message));
         }
+        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.call(this, createErrorPayload(error.message, resourceId));
       });
       this.registerPendingCreation(resourceId);
     } catch (error) {
+      var _this$fireAnalyticsEv9;
       if (this.hasPendingCreation()) {
         this.commitPendingCreation(false);
       }
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      if (fg('platform_synced_block_dogfooding')) {
-        var _this$createExperienc3;
-        (_this$createExperienc3 = this.createExperience) === null || _this$createExperienc3 === void 0 ? void 0 : _this$createExperienc3.failure({
-          reason: error.message
-        });
-      } else {
-        var _this$fireAnalyticsEv6;
-        (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createErrorPayload(error.message));
-      }
+      (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 ? void 0 : _this$fireAnalyticsEv9.call(this, createErrorPayload(error.message));
     }
   }
   async delete(syncBlockIds, onDelete, onDeleteCompleted) {
@@ -304,6 +283,10 @@ export class SourceSyncBlockStoreManager {
       syncBlockIds.forEach(Ids => {
         this.setPendingDeletion(Ids, true);
       });
+      if (fg('platform_synced_block_dogfooding')) {
+        var _this$deleteExperienc;
+        (_this$deleteExperienc = this.deleteExperience) === null || _this$deleteExperienc === void 0 ? void 0 : _this$deleteExperienc.start({});
+      }
       const results = await this.dataProvider.deleteNodesData(syncBlockIds.map(attrs => attrs.resourceId));
       let callback;
       const isDeleteSuccessful = results.every(result => result.success);
@@ -312,29 +295,34 @@ export class SourceSyncBlockStoreManager {
         onDelete();
         callback = Ids => this.syncBlockCache.delete(Ids.resourceId);
         this.clearPendingDeletion();
+        if (fg('platform_synced_block_dogfooding')) {
+          var _this$deleteExperienc2;
+          (_this$deleteExperienc2 = this.deleteExperience) === null || _this$deleteExperienc2 === void 0 ? void 0 : _this$deleteExperienc2.success();
+          results.forEach(result => {
+            var _this$fireAnalyticsEv0;
+            (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 ? void 0 : _this$fireAnalyticsEv0.call(this, deleteSuccessPayload(result.resourceId));
+          });
+        }
       } else {
         callback = Ids => {
           this.setPendingDeletion(Ids, false);
         };
         if (fg('platform_synced_block_dogfooding')) {
-          var _this$deleteExperienc;
-          const successfulDeleted = results.filter(result => result.success).map(result => ({
-            resourceId: result.resourceId
-          }));
-          const failedDelete = results.filter(result => !result.success).map(result => ({
-            resourceId: result.resourceId || 'unknown',
-            failReason: result.error || 'Failed to delete sync block'
-          }));
-          (_this$deleteExperienc = this.deleteExperience) === null || _this$deleteExperienc === void 0 ? void 0 : _this$deleteExperienc.failure({
-            metadata: {
-              successfulDeleted,
-              failedDelete
+          var _this$deleteExperienc3;
+          (_this$deleteExperienc3 = this.deleteExperience) === null || _this$deleteExperienc3 === void 0 ? void 0 : _this$deleteExperienc3.failure();
+          results.forEach(result => {
+            if (result.success) {
+              var _this$fireAnalyticsEv1;
+              (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 ? void 0 : _this$fireAnalyticsEv1.call(this, deleteSuccessPayload(result.resourceId));
+            } else {
+              var _this$fireAnalyticsEv10;
+              (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 ? void 0 : _this$fireAnalyticsEv10.call(this, deleteErrorPayload(result.error || 'Failed to delete synced block', result.resourceId));
             }
           });
         } else {
           results.filter(result => result.resourceId === undefined).forEach(result => {
-            var _this$fireAnalyticsEv7;
-            (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 ? void 0 : _this$fireAnalyticsEv7.call(this, deleteErrorPayload(result.error || 'Failed to delete synced block'));
+            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'));
           });
         }
       }
@@ -342,20 +330,13 @@ export class SourceSyncBlockStoreManager {
       return isDeleteSuccessful;
     } catch (error) {
       syncBlockIds.forEach(Ids => {
+        var _this$fireAnalyticsEv12;
         this.setPendingDeletion(Ids, false);
+        (_this$fireAnalyticsEv12 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv12 === void 0 ? void 0 : _this$fireAnalyticsEv12.call(this, deleteErrorPayload(error.message, Ids.resourceId));
       });
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      if (fg('platform_synced_block_dogfooding')) {
-        var _this$deleteExperienc2;
-        (_this$deleteExperienc2 = this.deleteExperience) === null || _this$deleteExperienc2 === void 0 ? void 0 : _this$deleteExperienc2.failure({
-          reason: error.message
-        });
-      } else {
-        var _this$fireAnalyticsEv8;
-        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.call(this, deleteErrorPayload(error.message));
-      }
       onDeleteCompleted(false);
       return false;
     }
@@ -417,20 +398,30 @@ export class SourceSyncBlockStoreManager {
       }
       return this.dataProvider.fetchSyncBlockSourceInfo(localId, undefined, undefined, this.fireAnalyticsEvent);
     } catch (error) {
-      var _this$fireAnalyticsEv9;
+      var _this$fireAnalyticsEv13;
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 ? void 0 : _this$fireAnalyticsEv9.call(this, getSourceInfoErrorPayload(error.message));
+      (_this$fireAnalyticsEv13 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv13 === void 0 ? void 0 : _this$fireAnalyticsEv13.call(this, getSourceInfoErrorPayload(error.message));
       return Promise.resolve(undefined);
     }
   }
   destroy() {
+    var _this$saveExperience4, _this$createExperienc5, _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 ? void 0 : _this$saveExperience4.abort({
+      reason: 'editor-destroyed'
+    });
+    (_this$createExperienc5 = this.createExperience) === null || _this$createExperienc5 === void 0 ? void 0 : _this$createExperienc5.abort({
+      reason: 'editor-destroyed'
+    });
+    (_this$deleteExperienc4 = this.deleteExperience) === null || _this$deleteExperienc4 === void 0 ? void 0 : _this$deleteExperienc4.abort({
+      reason: 'editor-destroyed'
+    });
     this.clearPendingDeletion();
   }
 }

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

@@ -47,7 +47,7 @@ export class SyncBlockStoreManager {
         }
         return {
           ...sourceInfo,
-          onSamePage: reference.onSamePage,
+          onSameDocument: reference.onSameDocument,
           hasAccess: reference.hasAccess,
           productType: sourceInfo.productType
         };
@@ -57,7 +57,7 @@ export class SyncBlockStoreManager {
       if (sourceSyncBlockData) {
         sourceInfos.push({
           ...sourceSyncBlockData,
-          onSamePage: Boolean(sourceSyncBlockData === null || sourceSyncBlockData === void 0 ? void 0 : sourceSyncBlockData.onSamePage),
+          onSameDocument: Boolean(sourceSyncBlockData === null || sourceSyncBlockData === void 0 ? void 0 : sourceSyncBlockData.onSameDocument),
           hasAccess: true,
           isSource: true,
           productType: sourceSyncBlockData === null || sourceSyncBlockData === void 0 ? void 0 : sourceSyncBlockData.productType

package/dist/es2019/utils/errorHandling.js

@@ -1,4 +1,5 @@
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
+import { fg } from '@atlaskit/platform-feature-flags';
 export const stringifyError = error => {
   try {
     return JSON.stringify(error);
@@ -6,20 +7,70 @@ export const stringifyError = error => {
     return undefined;
   }
 };
-export const getErrorPayload = (actionSubjectId, error) => ({
+export const getErrorPayload = (actionSubjectId, error, resourceId) => ({
   action: ACTION.ERROR,
   actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
   actionSubjectId,
   eventType: EVENT_TYPE.OPERATIONAL,
-  attributes: {
+  attributes: fg('platform_synced_block_dogfooding') ? {
+    error,
+    ...(resourceId && {
+      resourceId
+    })
+  } : {
     error
   }
 });
-export const fetchErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error);
-export const getSourceInfoErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error);
-export const updateErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error);
-export const updateReferenceErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error);
-export const createErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error);
-export const deleteErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error);
-export const updateCacheErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error);
-export const fetchReferencesErrorPayload = error => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH_REFERENCES, error);
+export const fetchErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error, resourceId);
+export const getSourceInfoErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId);
+export const updateErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId);
+export const updateReferenceErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId);
+export const createErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId);
+export const deleteErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId);
+export const updateCacheErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error, resourceId);
+export const fetchReferencesErrorPayload = (error, resourceId) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH_REFERENCES, error, resourceId);
+
+// Success payloads
+export const fetchSuccessPayload = (resourceId, blockInstanceId, sourceProduct) => ({
+  action: ACTION.FETCHED,
+  actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+  actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH,
+  eventType: EVENT_TYPE.OPERATIONAL,
+  attributes: {
+    resourceId,
+    blockInstanceId,
+    ...(sourceProduct && {
+      sourceProduct
+    })
+  }
+});
+export const createSuccessPayload = resourceId => ({
+  action: ACTION.INSERTED,
+  actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+  actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE,
+  eventType: EVENT_TYPE.OPERATIONAL,
+  attributes: {
+    resourceId
+  }
+});
+export const updateSuccessPayload = (resourceId, hasReference) => ({
+  action: ACTION.UPDATED,
+  actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+  actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE,
+  eventType: EVENT_TYPE.OPERATIONAL,
+  attributes: {
+    resourceId,
+    ...(hasReference !== undefined && {
+      hasReference
+    })
+  }
+});
+export const deleteSuccessPayload = resourceId => ({
+  action: ACTION.DELETED,
+  actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+  actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE,
+  eventType: EVENT_TYPE.OPERATIONAL,
+  attributes: {
+    resourceId
+  }
+});

package/dist/es2019/utils/experienceTracking.js

@@ -0,0 +1,113 @@
+import { ACTION } from '@atlaskit/editor-common/analytics';
+import { Experience, EXPERIENCE_ID, ExperienceCheckTimeout } from '@atlaskit/editor-common/experiences';
+const TIMEOUT_DURATION = 30000;
+export const createExperienceDispatcher = fireAnalyticsEvent => {
+  return payload => {
+    // Runtime type guard - only forward experience events
+    if (payload.action === ACTION.EXPERIENCE_MEASURED || payload.action === ACTION.EXPERIENCE_SAMPLED) {
+      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? 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 const 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 const 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 const 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 const 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 const 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 const getCreateSourceExperience = fireAnalyticsEvent => {
+  return new Experience(EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: ACTION.SYNCED_BLOCK_CREATE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};

package/dist/es2019/utils/resolveSyncBlockInstance.js

@@ -33,7 +33,7 @@ export const resolveSyncBlockInstance = (oldResult, newResult) => {
       sourceTitle: ((_newResult$data2 = newResult.data) === null || _newResult$data2 === void 0 ? void 0 : _newResult$data2.sourceTitle) || ((_oldResult$data2 = oldResult.data) === null || _oldResult$data2 === void 0 ? void 0 : _oldResult$data2.sourceTitle) || undefined,
       ...(fg('platform_synced_block_dogfooding') && {
         sourceSubType: ((_newResult$data3 = newResult.data) === null || _newResult$data3 === void 0 ? void 0 : _newResult$data3.sourceSubType) || ((_oldResult$data3 = oldResult.data) === null || _oldResult$data3 === void 0 ? void 0 : _oldResult$data3.sourceSubType) || undefined,
-        onSamePage: ((_newResult$data4 = newResult.data) === null || _newResult$data4 === void 0 ? void 0 : _newResult$data4.onSamePage) || ((_oldResult$data4 = oldResult.data) === null || _oldResult$data4 === void 0 ? void 0 : _oldResult$data4.onSamePage) || undefined
+        onSameDocument: ((_newResult$data4 = newResult.data) === null || _newResult$data4 === void 0 ? void 0 : _newResult$data4.onSameDocument) || ((_oldResult$data4 = oldResult.data) === null || _oldResult$data4 === void 0 ? void 0 : _oldResult$data4.onSameDocument) || undefined
       })
     }
   };