@atlaskit/editor-synced-block-provider 23.0.5 → 23.1.1

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

@@ -5,6 +5,7 @@ import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-e
 import { isProviderNotReadyError, ProviderNotReadyError, SyncBlockError } from '../common/types';
 import { buildErrorAttribution, buildFetchErrorAttribution, cacheDeletionForcedPayload, fetchErrorPayload, fetchSuccessPayload, getSourceInfoErrorPayload, sourceInfoOrphanedPayload, updateReferenceErrorPayload } from '../utils/errorHandling';
 import { getFetchExperience, getFetchSourceInfoExperience, getSaveReferenceExperience } from '../utils/experienceTracking';
+import { getSourceLocation } from '../utils/fieldAwareLocations';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { parseResourceId } from '../utils/resourceId';
 import { createSyncBlockNode, getSourceProductFromResourceIdSafe, normalizeSyncBlockJSONContent } from '../utils/utils';
@@ -192,9 +193,8 @@ export class ReferenceSyncBlockStoreManager {
     return this.getFromSessionCache(resourceId);
   }
   getSameDocumentReferenceParts(resourceId) {
-    var _this$dataProvider$ca, _this$dataProvider3;
     const parsed = parseResourceId(resourceId);
-    if (!parsed || !this.dataProvider || isExperimentEnabled('platform_editor_blocks_patch_12') && ((_this$dataProvider$ca = (_this$dataProvider3 = this.dataProvider).canGenerateResourceIdForReference) === null || _this$dataProvider$ca === void 0 ? void 0 : _this$dataProvider$ca.call(_this$dataProvider3)) === false || this.dataProvider.generateResourceIdForReference(parsed.uuid) !== resourceId) {
+    if (!parsed || !this.dataProvider || this.dataProvider.generateResourceIdForReference(parsed.uuid) !== resourceId) {
       return undefined;
     }
     return parsed;
@@ -348,15 +348,25 @@ export class ReferenceSyncBlockStoreManager {
         (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 ? void 0 : _this$fireAnalyticsEv3.call(this, getSourceInfoErrorPayload('SourceAri, product or blockInstanceId missing', resourceId, sourceProduct));
         return Promise.resolve(undefined);
       }
+      const sourceLocation = getSourceLocation(sourceAri);
+      // Undefined with `platform_editor_blocks_patch_13` off, so experience calls below keep
+      // exactly their previous arguments (no `metadata` key, `success()` without arguments).
+      const experienceMetadata = sourceLocation && {
+        sourceLocation
+      };
+      const withExperienceMetadata = options => experienceMetadata ? {
+        ...options,
+        metadata: experienceMetadata
+      } : options;
       (_this$fetchSourceInfo = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo === void 0 ? void 0 : _this$fetchSourceInfo.start({});
       const sourceInfoPromise = this.dataProvider.fetchSyncBlockSourceInfo(blockInstanceId, sourceAri, product, true // hasAccess
       ).then(sourceInfo => {
         if (!sourceInfo) {
           var _this$fetchSourceInfo2, _this$fireAnalyticsEv4;
-          (_this$fetchSourceInfo2 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo2 === void 0 ? void 0 : _this$fetchSourceInfo2.failure({
+          (_this$fetchSourceInfo2 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo2 === void 0 ? void 0 : _this$fetchSourceInfo2.failure(withExperienceMetadata({
             reason: 'No source info returned'
-          });
-          (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, getSourceInfoErrorPayload('No source info returned', resourceId, sourceProduct));
+          }));
+          (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 ? void 0 : _this$fireAnalyticsEv4.call(this, getSourceInfoErrorPayload('No source info returned', resourceId, sourceProduct, sourceLocation));
           return undefined;
         }
         this.updateCacheWithSourceInfo(resourceId, sourceInfo);
@@ -364,22 +374,29 @@ export class ReferenceSyncBlockStoreManager {
           this._subscriptionManager.updateSourceTitleSubscriptions(resourceId, sourceInfo.title);
         }
         if (sourceInfo.title && sourceInfo.url) {
-          var _this$fetchSourceInfo3;
-          (_this$fetchSourceInfo3 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo3 === void 0 ? void 0 : _this$fetchSourceInfo3.success();
+          if (experienceMetadata) {
+            var _this$fetchSourceInfo3;
+            (_this$fetchSourceInfo3 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo3 === void 0 ? void 0 : _this$fetchSourceInfo3.success({
+              metadata: experienceMetadata
+            });
+          } else {
+            var _this$fetchSourceInfo4;
+            (_this$fetchSourceInfo4 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo4 === void 0 ? void 0 : _this$fetchSourceInfo4.success();
+          }
         } else {
-          var _this$fetchSourceInfo4, _this$fireAnalyticsEv5;
-          (_this$fetchSourceInfo4 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo4 === void 0 ? void 0 : _this$fetchSourceInfo4.failure({
+          var _this$fetchSourceInfo5, _this$fireAnalyticsEv5;
+          (_this$fetchSourceInfo5 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo5 === void 0 ? void 0 : _this$fetchSourceInfo5.failure(withExperienceMetadata({
             reason: 'Missing title or url'
-          });
-          (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, getSourceInfoErrorPayload('Missing title or url', resourceId, sourceProduct));
+          }));
+          (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, getSourceInfoErrorPayload('Missing title or url', resourceId, sourceProduct, sourceLocation));
         }
         return sourceInfo;
       }).catch(error => {
-        var _this$fetchSourceInfo5, _this$fireAnalyticsEv6;
-        (_this$fetchSourceInfo5 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo5 === void 0 ? void 0 : _this$fetchSourceInfo5.failure({
+        var _this$fetchSourceInfo6, _this$fireAnalyticsEv6;
+        (_this$fetchSourceInfo6 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo6 === void 0 ? void 0 : _this$fetchSourceInfo6.failure(withExperienceMetadata({
           reason: error.message
-        });
-        (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, getSourceInfoErrorPayload(error.message, resourceId, sourceProduct));
+        }));
+        (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, getSourceInfoErrorPayload(error.message, resourceId, sourceProduct, sourceLocation));
         return undefined;
       }).finally(() => {
         this.syncBlockSourceInfoRequests.delete(resourceId);
@@ -631,8 +648,8 @@ export class ReferenceSyncBlockStoreManager {
       resourceId
     } = sanitizedSyncBlock;
     if (resourceId) {
-      var _this$dataProvider4;
-      (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 ? void 0 : _this$dataProvider4.updateCache({
+      var _this$dataProvider3;
+      (_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 ? void 0 : _this$dataProvider3.updateCache({
         [resourceId]: sanitizedSyncBlock
       }, {
         strategy: 'merge',
@@ -643,13 +660,13 @@ export class ReferenceSyncBlockStoreManager {
     }
   }
   getFromCache(resourceId) {
-    var _this$dataProvider5, _this$dataProvider5$g;
+    var _this$dataProvider4, _this$dataProvider4$g;
     const syncBlockNode = createSyncBlockNode('', resourceId);
-    return (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 ? void 0 : (_this$dataProvider5$g = _this$dataProvider5.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider5$g === void 0 ? void 0 : _this$dataProvider5$g.data;
+    return (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 ? void 0 : (_this$dataProvider4$g = _this$dataProvider4.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider4$g === void 0 ? void 0 : _this$dataProvider4$g.data;
   }
   deleteFromCache(resourceId) {
-    var _this$dataProvider6;
-    (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 ? void 0 : _this$dataProvider6.removeFromCache([resourceId]);
+    var _this$dataProvider5;
+    (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 ? void 0 : _this$dataProvider5.removeFromCache([resourceId]);
     this._providerFactoryManager.deleteFactory(resourceId);
     // Evict in-flight source-info promise and reset reschedule counter
     // so a stale resolution can't silently merge into a re-fetched entry.
@@ -1036,7 +1053,7 @@ export class ReferenceSyncBlockStoreManager {
     return success;
   }
   destroy() {
-    var _this$dataProvider7, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo6;
+    var _this$dataProvider6, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo7;
     // Mark destroyed first so in-flight timer callbacks can early-return.
     this.isDestroyed = true;
 
@@ -1058,7 +1075,7 @@ export class ReferenceSyncBlockStoreManager {
     this._subscriptionManager.destroy();
     this._providerFactoryManager.destroy();
     this._batchFetcher.destroy();
-    (_this$dataProvider7 = this.dataProvider) === null || _this$dataProvider7 === void 0 ? void 0 : _this$dataProvider7.resetCache();
+    (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 ? void 0 : _this$dataProvider6.resetCache();
     this.dataProvider = undefined;
     this.syncBlockFetchDataRequests.clear();
     this.syncBlockSourceInfoRequests.clear();
@@ -1068,7 +1085,7 @@ export class ReferenceSyncBlockStoreManager {
     (_this$fetchExperience0 = this.fetchExperience) === null || _this$fetchExperience0 === void 0 ? void 0 : _this$fetchExperience0.abort({
       reason: 'editorDestroyed'
     });
-    (_this$fetchSourceInfo6 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo6 === void 0 ? void 0 : _this$fetchSourceInfo6.abort({
+    (_this$fetchSourceInfo7 = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo7 === void 0 ? void 0 : _this$fetchSourceInfo7.abort({
       reason: 'editorDestroyed'
     });
     this.fireAnalyticsEvent = undefined;

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

@@ -4,6 +4,7 @@ import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-e
 import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, createSuccessOperationalPayload, addContentSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload, buildErrorAttribution } from '../utils/errorHandling';
 import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience, getFetchSourceInfoExperience } from '../utils/experienceTracking';
+import { getSourceLocation } from '../utils/fieldAwareLocations';
 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;
@@ -406,16 +407,17 @@ export class SourceSyncBlockStoreManager {
       }
     } else {
       var _this$fireAnalyticsEv5;
-      (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, createErrorPayload('creation complete callback missing', resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+      (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 ? void 0 : _this$fireAnalyticsEv5.call(this, createErrorPayload('creation complete callback missing', resourceId, getSourceProductFromResourceIdSafe(resourceId), undefined, this.getSourceLocation()));
     }
     if (success) {
       var _this$dataProvider$ge, _this$dataProvider, _this$fireAnalyticsEv6, _this$fireAnalyticsEv7, _this$syncBlockCache$2;
       const sourceProduct = getSourceProductFromResourceIdSafe(resourceId);
+      const sourceLocation = this.getSourceLocation();
       const documentInsertedResourceId = (_this$dataProvider$ge = (_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.generateResourceIdForReference(resourceId)) !== null && _this$dataProvider$ge !== void 0 ? _this$dataProvider$ge : resourceId;
-      (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createSuccessPayload(documentInsertedResourceId || '', sourceProduct));
+      (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createSuccessPayload(documentInsertedResourceId || '', sourceProduct, sourceLocation));
       // Operational create-success event with the join key + creation-type
       // signals (inputMethod / createdEmpty / nodeTypes) captured at the command layer.
-      (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 ? void 0 : _this$fireAnalyticsEv7.call(this, createSuccessOperationalPayload(resourceId || '', (_this$syncBlockCache$2 = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$2 === void 0 ? void 0 : _this$syncBlockCache$2.blockInstanceId, sourceProduct, this.creationEnrichment.get(resourceId)));
+      (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 ? void 0 : _this$fireAnalyticsEv7.call(this, createSuccessOperationalPayload(resourceId || '', (_this$syncBlockCache$2 = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$2 === void 0 ? void 0 : _this$syncBlockCache$2.blockInstanceId, sourceProduct, this.creationEnrichment.get(resourceId), sourceLocation));
     } else {
       var _this$fireAnalyticsEv8;
       // Delete the node from cache if fail to create so it's not flushed to BE
@@ -425,7 +427,7 @@ export class SourceSyncBlockStoreManager {
       // 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$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.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), undefined, this.getSourceLocation()));
     }
     // Enrichment is single-use — drop it once the create has resolved either way.
     this.creationEnrichment.delete(resourceId || '');
@@ -538,7 +540,7 @@ export class SourceSyncBlockStoreManager {
           (_this$createExperienc3 = this.createExperience) === null || _this$createExperienc3 === void 0 ? void 0 : _this$createExperienc3.failure({
             reason: result.error || 'Failed to create bodied sync block'
           });
-          (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 ? void 0 : _this$fireAnalyticsEv0.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId), buildErrorAttribution(result.error, result.statusCode)));
+          (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 ? void 0 : _this$fireAnalyticsEv0.call(this, createErrorPayload(result.error || 'Failed to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId), buildErrorAttribution(result.error, result.statusCode), this.getSourceLocation()));
         }
       }).catch(error => {
         var _this$createExperienc4, _this$fireAnalyticsEv1;
@@ -549,7 +551,7 @@ export class SourceSyncBlockStoreManager {
         (_this$createExperienc4 = this.createExperience) === null || _this$createExperienc4 === void 0 ? void 0 : _this$createExperienc4.failure({
           reason: error.message
         });
-        (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 ? void 0 : _this$fireAnalyticsEv1.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), undefined, this.getSourceLocation()));
       }).finally(() => {
         this.pendingCreationPromises.delete(resourceId);
       });
@@ -563,9 +565,13 @@ export class SourceSyncBlockStoreManager {
       logException(error, {
         location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
       });
-      (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 ? void 0 : _this$fireAnalyticsEv10.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+      (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 ? void 0 : _this$fireAnalyticsEv10.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId), undefined, this.getSourceLocation()));
     }
   }
+  getSourceLocation() {
+    var _this$dataProvider2, _this$dataProvider2$g;
+    return getSourceLocation((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 ? void 0 : (_this$dataProvider2$g = _this$dataProvider2.getParentAri) === null || _this$dataProvider2$g === void 0 ? void 0 : _this$dataProvider2$g.call(_this$dataProvider2));
+  }
   /**
    * Drop dedupe entries older than {@link DELETE_DEDUPE_WINDOW_MS} so
    * `recentDeleteEmissions` stays bounded by the number of recent deletes.
@@ -709,8 +715,8 @@ export class SourceSyncBlockStoreManager {
     // so we can update the correct cache entries.
     const sourceToReferenceMap = new Map();
     const syncBlockNodes = Array.from(this.syncBlockCache.entries()).map(([resourceId, data]) => {
-      var _this$dataProvider$ge2, _this$dataProvider2;
-      const referenceResourceId = (_this$dataProvider$ge2 = (_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 ? void 0 : _this$dataProvider2.generateResourceIdForReference(resourceId)) !== null && _this$dataProvider$ge2 !== void 0 ? _this$dataProvider$ge2 : resourceId;
+      var _this$dataProvider$ge2, _this$dataProvider3;
+      const referenceResourceId = (_this$dataProvider$ge2 = (_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 ? void 0 : _this$dataProvider3.generateResourceIdForReference(resourceId)) !== null && _this$dataProvider$ge2 !== void 0 ? _this$dataProvider$ge2 : resourceId;
       sourceToReferenceMap.set(referenceResourceId, resourceId);
       return {
         type: 'bodiedSyncBlock',

package/dist/es2019/utils/errorHandling.js

@@ -209,7 +209,7 @@ export const buildFetchErrorAttribution = (error, statusCode, deferred) => {
  * buckets like `source_deleted` they never emit.
  */
 
-export function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct, attribution) {
+export function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct, attribution, sourceLocation) {
   return {
     action: ACTION.ERROR,
     actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
@@ -223,6 +223,9 @@ export function getErrorPayload(actionSubjectId, error, resourceId, sourceProduc
       ...(sourceProduct && {
         sourceProduct
       }),
+      ...(sourceLocation && {
+        sourceLocation
+      }),
       ...((attribution === null || attribution === void 0 ? void 0 : attribution.reason) && {
         reason: attribution.reason
       }),
@@ -249,10 +252,10 @@ export const fetchErrorPayload = (error, resourceId, sourceProduct, attribution)
 // attribution it hits the fetch overload (wider `reason`); without it, the
 // no-attribution overload. Both produce a fetch event regardless.
 attribution ? getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error, resourceId, sourceProduct, attribution) : getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error, resourceId, sourceProduct);
-export const getSourceInfoErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId, sourceProduct);
+export const getSourceInfoErrorPayload = (error, resourceId, sourceProduct, sourceLocation) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId, sourceProduct, undefined, sourceLocation);
 export const updateErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
 export const updateReferenceErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
-export const createErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct, attribution);
+export const createErrorPayload = (error, resourceId, sourceProduct, attribution, sourceLocation) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct, attribution, sourceLocation);
 export const deleteErrorPayload = (error, resourceId, sourceProduct, attribution) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct, attribution);
 export const updateCacheErrorPayload = (error, resourceId, sourceProduct) => getErrorPayload(ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error, resourceId, sourceProduct);
 /**
@@ -316,7 +319,7 @@ export const fetchSuccessPayload = (resourceId, blockInstanceId, sourceProduct)
     })
   }
 });
-export const createSuccessPayload = (resourceId, sourceProduct) => {
+export const createSuccessPayload = (resourceId, sourceProduct, sourceLocation) => {
   return {
     action: ACTION.INSERTED,
     actionSubject: ACTION_SUBJECT.DOCUMENT,
@@ -326,6 +329,9 @@ export const createSuccessPayload = (resourceId, sourceProduct) => {
       resourceId,
       ...(sourceProduct && {
         sourceProduct
+      }),
+      ...(sourceLocation && {
+        sourceLocation
       })
     }
   };
@@ -343,7 +349,7 @@ export const createSuccessPayload = (resourceId, sourceProduct) => {
  * Operational `syncedBlockCreate` success event with the `blockInstanceId` join key and,
  * when available, the `inputMethod`, `createdEmpty`, and `nodeTypes` creation signals.
  */
-export const createSuccessOperationalPayload = (resourceId, blockInstanceId, sourceProduct, enrichment) => {
+export const createSuccessOperationalPayload = (resourceId, blockInstanceId, sourceProduct, enrichment, sourceLocation) => {
   var _enrichment$nodeTypes;
   return {
     action: ACTION.INSERTED,
@@ -366,6 +372,9 @@ export const createSuccessOperationalPayload = (resourceId, blockInstanceId, sou
       }),
       ...((enrichment === null || enrichment === void 0 ? void 0 : (_enrichment$nodeTypes = enrichment.nodeTypes) === null || _enrichment$nodeTypes === void 0 ? void 0 : _enrichment$nodeTypes.length) && {
         nodeTypes: enrichment.nodeTypes
+      }),
+      ...(sourceLocation && {
+        sourceLocation
       })
     }
   };

package/dist/es2019/utils/fieldAwareLocations.js

@@ -1,5 +1,7 @@
 import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
-import { getLocationScope } from '../clients/block-service/ari';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
+import { getLocationScope, getProductFromSourceAri } from '../clients/block-service/ari';
+import { JIRA_DESCRIPTION_FIELD_ID, parseJiraFieldLocation } from '../clients/jira/ari';
 /**
  * The product check runs first so a Confluence-only document never reads the experiment.
  */
@@ -18,4 +20,27 @@ export const getFieldAwareLocationScope = ({
     documentAri,
     hostAri
   })
-} : undefined;
+} : undefined;
+
+/**
+ * Analytics `sourceLocation` for a source ARI: `undefined` for non-Jira sources and for the
+ * control cohort, so events outside the experiment keep their current shape.
+ *
+ * The `platform_editor_blocks_patch_13` gate runs first: with it off this returns `undefined`
+ * without the product check or the experiment read, so no new exposure is logged.
+ */
+export const getSourceLocation = sourceAri => {
+  if (!fg('platform_editor_blocks_patch_13')) {
+    return undefined;
+  }
+  if (!sourceAri || !isFieldAwareJiraLocation(getProductFromSourceAri(sourceAri))) {
+    return undefined;
+  }
+  const location = parseJiraFieldLocation({
+    ari: sourceAri
+  });
+  if (!location) {
+    return undefined;
+  }
+  return location.fieldId === JIRA_DESCRIPTION_FIELD_ID ? 'description' : 'custom-field';
+};

package/dist/esm/clients/jira/ari.js

@@ -63,7 +63,7 @@ export var getJiraIssueAriFromSourceAri = function getJiraIssueAriFromSourceAri(
   }
   return ari;
 };
-var JIRA_DESCRIPTION_FIELD_ID = 'description';
+export var JIRA_DESCRIPTION_FIELD_ID = 'description';
 
 /**
  * One synced block location on a Jira work item, parsed once from its document ARI.

package/dist/esm/common/types.js

@@ -14,6 +14,8 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * `same-parent-document` is another field of the host work item.
  */
 
+/** Which Jira work item field holds a source block. */
+
 export var SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";

package/dist/esm/providers/block-service/blockServiceAPI.js

@@ -600,15 +600,27 @@ export var writeDataBatch = /*#__PURE__*/function () {
 var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
   function BlockServiceADFFetchProvider(_ref5) {
     var cloudId = _ref5.cloudId,
-      parentAri = _ref5.parentAri;
+      parentAri = _ref5.parentAri,
+      parentId = _ref5.parentId,
+      product = _ref5.product;
     _classCallCheck(this, BlockServiceADFFetchProvider);
     this.cloudId = cloudId;
     this.parentAri = parentAri;
+    this.parentId = parentId;
+    this.product = product;
   }
-
-  // resourceId of the reference synced block.
-  // the ARI must be constructed to call the block service API
   return _createClass(BlockServiceADFFetchProvider, [{
+    key: "generateResourceIdForReference",
+    value: function generateResourceIdForReference(sourceId) {
+      if (!this.product || !this.parentId) {
+        return sourceId;
+      }
+      return createResourceIdForReference(this.product, this.parentId, sourceId);
+    }
+
+    // resourceId of the reference synced block.
+    // the ARI must be constructed to call the block service API
+  }, {
     key: "fetchData",
     value: function () {
       var _fetchData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(resourceId) {
@@ -1488,7 +1500,9 @@ var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(_re
   return {
     fetchProvider: new BlockServiceADFFetchProvider({
       cloudId: cloudId,
-      parentAri: parentAri
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product
     }),
     writeProvider: new BlockServiceADFWriteProvider({
       cloudId: cloudId,
@@ -1517,11 +1531,15 @@ export var useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServic
 };
 var createBlockServiceFetchOnlyAPIProvider = function createBlockServiceFetchOnlyAPIProvider(_ref1) {
   var cloudId = _ref1.cloudId,
-    parentAri = _ref1.parentAri;
+    parentAri = _ref1.parentAri,
+    parentId = _ref1.parentId,
+    product = _ref1.product;
   return {
     fetchProvider: new BlockServiceADFFetchProvider({
       cloudId: cloudId,
-      parentAri: parentAri
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product
     }),
     writeProvider: undefined
   };
@@ -1532,11 +1550,15 @@ var createBlockServiceFetchOnlyAPIProvider = function createBlockServiceFetchOnl
  */
 export var useMemoizedBlockServiceFetchOnlyAPIProvider = function useMemoizedBlockServiceFetchOnlyAPIProvider(_ref10) {
   var cloudId = _ref10.cloudId,
-    parentAri = _ref10.parentAri;
+    parentAri = _ref10.parentAri,
+    parentId = _ref10.parentId,
+    product = _ref10.product;
   return useMemo(function () {
     return createBlockServiceFetchOnlyAPIProvider({
       cloudId: cloudId,
-      parentAri: parentAri
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product
     });
-  }, [cloudId, parentAri]);
+  }, [cloudId, parentAri, parentId, product]);
 };

package/dist/esm/providers/syncBlockProvider.js

@@ -12,6 +12,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { useMemo, useRef } from 'react';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { getProductFromSourceAri } from '../clients/block-service/ari';
 import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari';
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
@@ -381,6 +382,12 @@ export var SyncedBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
       }
       return fetchSyncBlockSourceInfo;
     }())
+  }, {
+    key: "getParentAri",
+    value: function getParentAri() {
+      var _this$writeProvider5;
+      return (_this$writeProvider5 = this.writeProvider) === null || _this$writeProvider5 === void 0 ? void 0 : _this$writeProvider5.parentAri;
+    }
   }, {
     key: "generateResourceId",
     value: function generateResourceId() {
@@ -391,14 +398,13 @@ export var SyncedBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
         resourceId: resourceId
       };
     }
-  }, {
-    key: "canGenerateResourceIdForReference",
-    value: function canGenerateResourceIdForReference() {
-      return this.writeProvider !== undefined;
-    }
   }, {
     key: "generateResourceIdForReference",
     value: function generateResourceIdForReference(sourceId) {
+      if (isExperimentEnabled('platform_editor_blocks_patch_12')) {
+        var _this$fetchProvider$g, _this$fetchProvider$g2, _this$fetchProvider;
+        return (_this$fetchProvider$g = (_this$fetchProvider$g2 = (_this$fetchProvider = this.fetchProvider).generateResourceIdForReference) === null || _this$fetchProvider$g2 === void 0 ? void 0 : _this$fetchProvider$g2.call(_this$fetchProvider, sourceId)) !== null && _this$fetchProvider$g !== void 0 ? _this$fetchProvider$g : sourceId;
+      }
       if (!this.writeProvider) {
         throw new Error('Write provider not set');
       }

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

@@ -16,6 +16,7 @@ import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-e
 import { isProviderNotReadyError, ProviderNotReadyError, SyncBlockError } from '../common/types';
 import { buildErrorAttribution, buildFetchErrorAttribution, cacheDeletionForcedPayload, fetchErrorPayload, fetchSuccessPayload, getSourceInfoErrorPayload, sourceInfoOrphanedPayload, updateReferenceErrorPayload } from '../utils/errorHandling';
 import { getFetchExperience, getFetchSourceInfoExperience, getSaveReferenceExperience } from '../utils/experienceTracking';
+import { getSourceLocation } from '../utils/fieldAwareLocations';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { parseResourceId } from '../utils/resourceId';
 import { createSyncBlockNode, getSourceProductFromResourceIdSafe, normalizeSyncBlockJSONContent } from '../utils/utils';
@@ -265,9 +266,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "getSameDocumentReferenceParts",
     value: function getSameDocumentReferenceParts(resourceId) {
-      var _this$dataProvider$ca, _this$dataProvider3;
       var parsed = parseResourceId(resourceId);
-      if (!parsed || !this.dataProvider || isExperimentEnabled('platform_editor_blocks_patch_12') && ((_this$dataProvider$ca = (_this$dataProvider3 = this.dataProvider).canGenerateResourceIdForReference) === null || _this$dataProvider$ca === void 0 ? void 0 : _this$dataProvider$ca.call(_this$dataProvider3)) === false || this.dataProvider.generateResourceIdForReference(parsed.uuid) !== resourceId) {
+      if (!parsed || !this.dataProvider || this.dataProvider.generateResourceIdForReference(parsed.uuid) !== resourceId) {
         return undefined;
       }
       return parsed;
@@ -433,15 +433,26 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
           (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, getSourceInfoErrorPayload('SourceAri, product or blockInstanceId missing', resourceId, sourceProduct));
           return Promise.resolve(undefined);
         }
+        var sourceLocation = getSourceLocation(sourceAri);
+        // Undefined with `platform_editor_blocks_patch_13` off, so experience calls below keep
+        // exactly their previous arguments (no `metadata` key, `success()` without arguments).
+        var experienceMetadata = sourceLocation && {
+          sourceLocation: sourceLocation
+        };
+        var withExperienceMetadata = function withExperienceMetadata(options) {
+          return experienceMetadata ? _objectSpread(_objectSpread({}, options), {}, {
+            metadata: experienceMetadata
+          }) : options;
+        };
         (_this$fetchSourceInfo = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo === void 0 || _this$fetchSourceInfo.start({});
         var sourceInfoPromise = this.dataProvider.fetchSyncBlockSourceInfo(blockInstanceId, sourceAri, product, true // hasAccess
         ).then(function (sourceInfo) {
           if (!sourceInfo) {
             var _this2$fetchSourceInf, _this2$fireAnalyticsE;
-            (_this2$fetchSourceInf = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf === void 0 || _this2$fetchSourceInf.failure({
+            (_this2$fetchSourceInf = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf === void 0 || _this2$fetchSourceInf.failure(withExperienceMetadata({
               reason: 'No source info returned'
-            });
-            (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, getSourceInfoErrorPayload('No source info returned', resourceId, sourceProduct));
+            }));
+            (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, getSourceInfoErrorPayload('No source info returned', resourceId, sourceProduct, sourceLocation));
             return undefined;
           }
           _this2.updateCacheWithSourceInfo(resourceId, sourceInfo);
@@ -449,22 +460,29 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
             _this2._subscriptionManager.updateSourceTitleSubscriptions(resourceId, sourceInfo.title);
           }
           if (sourceInfo.title && sourceInfo.url) {
-            var _this2$fetchSourceInf2;
-            (_this2$fetchSourceInf2 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf2 === void 0 || _this2$fetchSourceInf2.success();
+            if (experienceMetadata) {
+              var _this2$fetchSourceInf2;
+              (_this2$fetchSourceInf2 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf2 === void 0 || _this2$fetchSourceInf2.success({
+                metadata: experienceMetadata
+              });
+            } else {
+              var _this2$fetchSourceInf3;
+              (_this2$fetchSourceInf3 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf3 === void 0 || _this2$fetchSourceInf3.success();
+            }
           } else {
-            var _this2$fetchSourceInf3, _this2$fireAnalyticsE2;
-            (_this2$fetchSourceInf3 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf3 === void 0 || _this2$fetchSourceInf3.failure({
+            var _this2$fetchSourceInf4, _this2$fireAnalyticsE2;
+            (_this2$fetchSourceInf4 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf4 === void 0 || _this2$fetchSourceInf4.failure(withExperienceMetadata({
               reason: 'Missing title or url'
-            });
-            (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, getSourceInfoErrorPayload('Missing title or url', resourceId, sourceProduct));
+            }));
+            (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, getSourceInfoErrorPayload('Missing title or url', resourceId, sourceProduct, sourceLocation));
           }
           return sourceInfo;
         }).catch(function (error) {
-          var _this2$fetchSourceInf4, _this2$fireAnalyticsE3;
-          (_this2$fetchSourceInf4 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf4 === void 0 || _this2$fetchSourceInf4.failure({
+          var _this2$fetchSourceInf5, _this2$fireAnalyticsE3;
+          (_this2$fetchSourceInf5 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf5 === void 0 || _this2$fetchSourceInf5.failure(withExperienceMetadata({
             reason: error.message
-          });
-          (_this2$fireAnalyticsE3 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE3 === void 0 || _this2$fireAnalyticsE3.call(_this2, getSourceInfoErrorPayload(error.message, resourceId, sourceProduct));
+          }));
+          (_this2$fireAnalyticsE3 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE3 === void 0 || _this2$fireAnalyticsE3.call(_this2, getSourceInfoErrorPayload(error.message, resourceId, sourceProduct, sourceLocation));
           return undefined;
         }).finally(function () {
           _this2.syncBlockSourceInfoRequests.delete(resourceId);
@@ -761,8 +779,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       var sanitizedSyncBlock = this.normalizeReferenceData(syncBlock);
       var resourceId = sanitizedSyncBlock.resourceId;
       if (resourceId) {
-        var _this$dataProvider4;
-        (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 || _this$dataProvider4.updateCache(_defineProperty({}, resourceId, sanitizedSyncBlock), {
+        var _this$dataProvider3;
+        (_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 || _this$dataProvider3.updateCache(_defineProperty({}, resourceId, sanitizedSyncBlock), {
           strategy: 'merge',
           source: 'network'
         });
@@ -773,15 +791,15 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "getFromCache",
     value: function getFromCache(resourceId) {
-      var _this$dataProvider5;
+      var _this$dataProvider4;
       var syncBlockNode = createSyncBlockNode('', resourceId);
-      return (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 || (_this$dataProvider5 = _this$dataProvider5.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider5 === void 0 ? void 0 : _this$dataProvider5.data;
+      return (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 || (_this$dataProvider4 = _this$dataProvider4.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider4 === void 0 ? void 0 : _this$dataProvider4.data;
     }
   }, {
     key: "deleteFromCache",
     value: function deleteFromCache(resourceId) {
-      var _this$dataProvider6;
-      (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 || _this$dataProvider6.removeFromCache([resourceId]);
+      var _this$dataProvider5;
+      (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 || _this$dataProvider5.removeFromCache([resourceId]);
       this._providerFactoryManager.deleteFactory(resourceId);
       // Evict in-flight source-info promise and reset reschedule counter
       // so a stale resolution can't silently merge into a re-fetched entry.
@@ -1265,7 +1283,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "destroy",
     value: function destroy() {
-      var _this$dataProvider7, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo2;
+      var _this$dataProvider6, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo2;
       // Mark destroyed first so in-flight timer callbacks can early-return.
       this.isDestroyed = true;
 
@@ -1291,7 +1309,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       this._subscriptionManager.destroy();
       this._providerFactoryManager.destroy();
       this._batchFetcher.destroy();
-      (_this$dataProvider7 = this.dataProvider) === null || _this$dataProvider7 === void 0 || _this$dataProvider7.resetCache();
+      (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 || _this$dataProvider6.resetCache();
       this.dataProvider = undefined;
       this.syncBlockFetchDataRequests.clear();
       this.syncBlockSourceInfoRequests.clear();