@atlaskit/editor-synced-block-provider 2.10.5 → 2.11.0

package/dist/cjs/utils/errorHandling.js

@@ -3,11 +3,41 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.stringifyError = void 0;
+exports.updateErrorPayload = exports.updateCacheErrorPayload = exports.stringifyError = exports.getSourceInfoErrorPayload = exports.getErrorPayload = exports.fetchErrorPayload = exports.deleteErrorPayload = exports.createErrorPayload = void 0;
+var _analytics = require("@atlaskit/editor-common/analytics");
 var stringifyError = exports.stringifyError = function stringifyError(error) {
   try {
     return JSON.stringify(error);
   } catch (_unused) {
     return undefined;
   }
+};
+var getErrorPayload = exports.getErrorPayload = function getErrorPayload(actionSubjectId, error) {
+  return {
+    action: _analytics.ACTION.ERROR,
+    actionSubject: _analytics.ACTION_SUBJECT.SYNCED_BLOCK,
+    actionSubjectId: actionSubjectId,
+    eventType: _analytics.EVENT_TYPE.OPERATIONAL,
+    attributes: {
+      error: error
+    }
+  };
+};
+var fetchErrorPayload = exports.fetchErrorPayload = function fetchErrorPayload(error) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error);
+};
+var getSourceInfoErrorPayload = exports.getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error);
+};
+var updateErrorPayload = exports.updateErrorPayload = function updateErrorPayload(error) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error);
+};
+var createErrorPayload = exports.createErrorPayload = function createErrorPayload(error) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error);
+};
+var deleteErrorPayload = exports.deleteErrorPayload = function deleteErrorPayload(error) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error);
+};
+var updateCacheErrorPayload = exports.updateCacheErrorPayload = function updateCacheErrorPayload(error) {
+  return getErrorPayload(_analytics.ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE_CACHE, error);
 };

package/dist/es2019/clients/block-service/blockService.js

@@ -12,7 +12,7 @@ export class BlockError extends Error {
 export const getSyncedBlockContent = async ({
   blockAri
 }) => {
-  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/${blockAri}`, {
+  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/${encodeURIComponent(blockAri)}`, {
     method: 'GET',
     headers: COMMON_HEADERS
   });
@@ -24,7 +24,7 @@ export const getSyncedBlockContent = async ({
 export const deleteSyncedBlock = async ({
   blockAri
 }) => {
-  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/${blockAri}`, {
+  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/${encodeURIComponent(blockAri)}`, {
     method: 'DELETE',
     headers: COMMON_HEADERS
   });
@@ -36,7 +36,7 @@ export const updateSyncedBlock = async ({
   blockAri,
   content
 }) => {
-  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/${blockAri}`, {
+  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/${encodeURIComponent(blockAri)}`, {
     method: 'PUT',
     headers: COMMON_HEADERS,
     body: JSON.stringify({
@@ -54,10 +54,11 @@ export const createSyncedBlock = async ({
   product,
   content
 }) => {
-  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block/${blockAri}`, {
+  const response = await fetch(`${BLOCK_SERVICE_API_URL}/block`, {
     method: 'POST',
     headers: COMMON_HEADERS,
     body: JSON.stringify({
+      blockAri,
       blockInstanceId,
       sourceAri,
       product,

package/dist/es2019/clients/confluence/sourceInfo.js

@@ -1,5 +1,7 @@
 /* eslint-disable require-unicode-regexp  */
 
+import { logException } from '@atlaskit/editor-common/monitoring';
+import { getSourceInfoErrorPayload } from '../../utils/errorHandling';
 import { getPageIdAndTypeFromConfluencePageAri } from './ari';
 import { isBlogPageType } from './utils';
 const COMMON_HEADERS = {
@@ -52,7 +54,7 @@ const getConfluenceSourceInfo = async ari => {
   }
   return await response.json();
 };
-export const fetchConfluenceSourceInfo = async (pageAri, localId) => {
+export const fetchConfluencePageInfo = async (pageAri, localId, fireAnalyticsEvent) => {
   try {
     var _response$data, _response$data$conten, _response$data$conten2, _contentData$space;
     const {
@@ -60,15 +62,12 @@ export const fetchConfluenceSourceInfo = async (pageAri, localId) => {
     } = getPageIdAndTypeFromConfluencePageAri(pageAri);
     const response = await getConfluenceSourceInfo(pageAri);
     const contentData = (_response$data = response.data) === null || _response$data === void 0 ? void 0 : (_response$data$conten = _response$data.content) === null || _response$data$conten === void 0 ? void 0 : (_response$data$conten2 = _response$data$conten.nodes) === null || _response$data$conten2 === void 0 ? void 0 : _response$data$conten2[0];
-    if (!contentData) {
-      throw new Error(`Failed to get content data`);
-    }
-    const title = contentData.title;
+    const title = contentData === null || contentData === void 0 ? void 0 : contentData.title;
     let url;
     const {
       base
-    } = contentData.links || {};
-    if (base && (_contentData$space = contentData.space) !== null && _contentData$space !== void 0 && _contentData$space.key && contentData.id) {
+    } = (contentData === null || contentData === void 0 ? void 0 : contentData.links) || {};
+    if (base && contentData !== null && contentData !== void 0 && (_contentData$space = contentData.space) !== null && _contentData$space !== void 0 && _contentData$space.key && contentData !== null && contentData !== void 0 && contentData.id) {
       if (isBlogPageType(pageType)) {
         url = `${base}/spaces/${contentData.space.key}/blog/edit-v2/${contentData.id}`;
       } else if (contentData.subType === 'live') {
@@ -78,12 +77,18 @@ export const fetchConfluenceSourceInfo = async (pageAri, localId) => {
       }
     }
     url = url && localId ? `${url}#block-${localId}` : url;
+    if (!title || !url) {
+      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? void 0 : fireAnalyticsEvent(getSourceInfoErrorPayload('Failed to get confluence page source info'));
+    }
     return Promise.resolve({
       title,
       url
     });
   } catch (error) {
-    // TODO: EDITOR-1921 - add error analytics
+    logException(error, {
+      location: 'editor-synced-block-provider/sourceInfo'
+    });
+    fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? void 0 : fireAnalyticsEvent(getSourceInfoErrorPayload(error.message));
     return Promise.resolve(undefined);
   }
 };

package/dist/es2019/hooks/useFetchSyncBlockData.js

@@ -1,22 +1,30 @@
 import { useCallback, useEffect, useState } from 'react';
+import { logException } from '@atlaskit/editor-common/monitoring';
 import { SyncBlockError } from '../common/types';
+import { fetchErrorPayload } from '../utils/errorHandling';
 import { createSyncBlockNode } from '../utils/utils';
-export const useFetchSyncBlockData = (manager, resourceId, localId) => {
+export const useFetchSyncBlockData = (manager, resourceId, localId, fireAnalyticsEvent) => {
   const [syncBlockInstance, setSyncBlockInstance] = useState(null);
   const [isLoading, setIsLoading] = useState(true);
   const reloadData = useCallback(async () => {
     if (isLoading) {
       return;
     }
-    const syncBlockNode = resourceId && localId ? createSyncBlockNode(localId, resourceId) : null;
-    if (!syncBlockNode) {
-      return;
-    }
-    setIsLoading(true);
     try {
+      const syncBlockNode = resourceId && localId ? createSyncBlockNode(localId, resourceId) : null;
+      if (!syncBlockNode) {
+        throw new Error('Failed to create sync block node from resourceid and localid');
+      }
+      setIsLoading(true);
+
       // Fetch sync block data, the `subscribeToSyncBlock` will update the state once data is fetched
       await manager.referenceManager.fetchSyncBlocksData([syncBlockNode]);
     } catch (error) {
+      logException(error, {
+        location: 'editor-synced-block-provider/useFetchSyncBlockData'
+      });
+      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? void 0 : fireAnalyticsEvent(fetchErrorPayload(error.message));
+
       // Set error state if fetching fails
       setSyncBlockInstance({
         resourceId: resourceId || '',
@@ -24,7 +32,7 @@ export const useFetchSyncBlockData = (manager, resourceId, localId) => {
       });
     }
     setIsLoading(false);
-  }, [isLoading, localId, manager.referenceManager, resourceId]);
+  }, [isLoading, localId, manager.referenceManager, resourceId, fireAnalyticsEvent]);
   useEffect(() => {
     const unsubscribe = manager.referenceManager.subscribeToSyncBlock(resourceId || '', localId || '', data => {
       setSyncBlockInstance(data);

package/dist/es2019/hooks/useHandleContentChanges.js

@@ -1,10 +1,6 @@
 import { useEffect } from 'react';
 export const useHandleContentChanges = (manager, syncBlockNode) => {
   useEffect(() => {
-    try {
-      manager.sourceManager.updateSyncBlockData(syncBlockNode);
-    } catch {
-      //TODO: EDITOR-1921 - add error analytics
-    }
+    manager.sourceManager.updateSyncBlockData(syncBlockNode);
   }, [manager, syncBlockNode]);
 };

package/dist/es2019/index.js

@@ -15,7 +15,7 @@ export { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageARIFromCo
 // providers
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders } from './providers/confluence/confluenceContentAPI';
-export { fetchConfluenceSourceInfo } from './clients/confluence/sourceInfo';
+export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
 // store managers
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';

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

@@ -56,24 +56,17 @@ class BlockServiceADFFetchProvider {
       };
     }
   }
-  retrieveSourceInfoFetchData(resourceId, pageARI) {
-    let sourceLocalId;
-    try {
-      sourceLocalId = getLocalIdFromBlockResourceId(resourceId);
-    } catch (error) {
-      // EDITOR-1921: log analytic here, safe to continue
-    }
-    return {
-      pageARI,
-      sourceLocalId
-    };
-  }
 }
 
 /**
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 class BlockServiceADFWriteProvider {
+  constructor(sourceAri, product) {
+    this.sourceAri = sourceAri;
+    this.product = product;
+  }
+
   // it will first try to update and if it can't (404) then it will try to create
   async writeData(data) {
     const {
@@ -95,8 +88,8 @@ class BlockServiceADFWriteProvider {
           await createSyncedBlock({
             blockAri: resourceId,
             blockInstanceId: data.blockInstanceId,
-            sourceAri: resourceId,
-            product: 'confluence-page',
+            sourceAri: this.sourceAri,
+            product: this.product,
             content: JSON.stringify(data.content)
           });
         } else {
@@ -139,22 +132,22 @@ class BlockServiceADFWriteProvider {
       };
     }
   }
-  generateResourceId(sourceId, localId) {
-    return blockResourceIdFromSourceAndLocalId(sourceId, localId);
+  generateResourceId(sourceAri, localId) {
+    return blockResourceIdFromSourceAndLocalId(sourceAri, localId);
   }
 }
 
 /**
  * Factory function to create both providers with shared configuration
  */
-const createBlockServiceAPIProviders = () => {
+const createBlockServiceAPIProviders = (sourceAri, product) => {
   const fetchProvider = new BlockServiceADFFetchProvider();
-  const writeProvider = new BlockServiceADFWriteProvider();
+  const writeProvider = new BlockServiceADFWriteProvider(sourceAri, product);
   return {
     fetchProvider,
     writeProvider
   };
 };
-export const useMemoizedBlockServiceAPIProviders = () => {
-  return useMemo(createBlockServiceAPIProviders, []);
+export const useMemoizedBlockServiceAPIProviders = (sourceAri, product) => {
+  return useMemo(() => createBlockServiceAPIProviders(sourceAri, product), [sourceAri, product]);
 };

package/dist/es2019/providers/confluence/confluenceContentAPI.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useMemo } from 'react';
-import { getConfluencePageAri, getPageARIFromContentPropertyResourceId, getLocalIdFromConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
+import { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
 import { getContentProperty, createContentProperty, updateContentProperty, deleteContentProperty } from '../../clients/confluence/contentProperty';
 import { isBlogPageType } from '../../clients/confluence/utils';
 import { SyncBlockError } from '../../common/types';
@@ -108,19 +108,6 @@ class ConfluenceADFFetchProvider {
       };
     }
   }
-  retrieveSourceInfoFetchData(resourceId) {
-    const pageARI = getPageARIFromContentPropertyResourceId(resourceId);
-    let sourceLocalId;
-    try {
-      sourceLocalId = getLocalIdFromConfluencePageAri(resourceId);
-    } catch (error) {
-      // EDITOR-1921: log analytic here, safe to continue
-    }
-    return {
-      pageARI,
-      sourceLocalId
-    };
-  }
 }
 
 /**

package/dist/es2019/providers/syncBlockProvider.js

@@ -1,7 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useMemo } from 'react';
 import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari';
-import { fetchConfluenceSourceInfo } from '../clients/confluence/sourceInfo';
+import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
 import { SyncBlockError } from '../common/types';
 import { SyncBlockDataProvider } from '../providers/types';
 export class SyncBlockProvider extends SyncBlockDataProvider {
@@ -61,7 +61,7 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
         return data;
       }, () => {
         return {
-          status: SyncBlockError.Errored,
+          error: SyncBlockError.Errored,
           resourceId
         };
       });
@@ -131,34 +131,26 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
   }
 
   /**
-   * Retrieve the source info from the source id
+   * Fetch the source info from the source id
    *
-   * @param node
+   * @param params
+   * @param params.sourceAri - The source ARI
+   * @param params.sourceProduct - The source product. e.g. 'confluence-page', 'jira-work-item'
    *
    * @returns The source info
    */
-  retrieveSyncBlockSourceInfo(node) {
-    // with content API, this is the concatenation of the page ARI and the block's localId.
-    // with block service, this is the ARI of the block.
-    // this can be cleaned up from the specific providers and placed here after platform_synced_blocks_block_service_provider
-    const {
-      resourceId
-    } = node.attrs;
-    let pageARI;
-    let sourceLocalId;
-    if (resourceId && typeof resourceId === 'string') {
-      try {
-        const fetchData = this.fetchProvider.retrieveSourceInfoFetchData(resourceId, this.sourceId);
-        pageARI = fetchData.pageARI;
-        sourceLocalId = fetchData.sourceLocalId;
-      } catch (error) {
-        return Promise.reject(error);
-      }
+  fetchSyncBlockSourceInfo(localId, sourceAri, sourceProduct, fireAnalyticsEvent) {
+    if (!sourceAri || !sourceProduct) {
+      return Promise.reject(new Error('Source ari or source product is undefined'));
+    }
+    switch (sourceProduct) {
+      case 'confluence-page':
+        return fetchConfluencePageInfo(sourceAri, localId, fireAnalyticsEvent);
+      case 'jira-work-item':
+        return Promise.reject(new Error('Jira work item source product not supported'));
+      default:
+        return Promise.reject(new Error(`${sourceProduct} source product not supported`));
     }
-
-    // TODO: EDITOR-3312 - based on the source sync block product,
-    // execute fetchConfluenceSourceInfo or fetchJiraItemSourceInfo or similar...
-    return pageARI ? fetchConfluenceSourceInfo(pageARI, sourceLocalId) : Promise.resolve(undefined);
   }
   generateResourceId(sourceId, localId) {
     return this.writeProvider.generateResourceId(sourceId, localId);
@@ -176,32 +168,26 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
   /**
    * Retrieve the parent info for the sync block
    *
-   * @param resourceId
-   * @param syncBlockInstance
+   * @param sourceAri - The source ARI
+   * @param sourceProduct - The source product. e.g. 'confluence-page', 'jira-work-item'
    *
    * @returns The parent info for the sync block
    */
-  retrieveSyncBlockParentInfo(syncBlockInstance) {
-    if (!syncBlockInstance || !syncBlockInstance.data) {
+  retrieveSyncBlockParentInfo(sourceAri, sourceProduct) {
+    if (!sourceAri || !sourceProduct) {
       return undefined;
     }
-    const {
-      sourceAri,
-      product
-    } = syncBlockInstance.data;
-    if (!sourceAri || !product) {
-      return undefined;
+    switch (sourceProduct) {
+      case 'confluence-page':
+        return {
+          contentId: getPageIdAndTypeFromConfluencePageAri(sourceAri).id,
+          contentProduct: sourceProduct
+        };
+      case 'jira-work-item':
+        throw new Error('Jira work item source product not supported');
+      default:
+        throw new Error(`${sourceProduct} source product not supported`);
     }
-
-    // TODO: EDITOR-3312 - based on the source sync block product,
-    // execute getPageIdAndTypeFromConfluencePageAri or getJiraItemIdAndTypeFromJiraItemAri or similar...
-    const {
-      id: contentId
-    } = getPageIdAndTypeFromConfluencePageAri(sourceAri);
-    return {
-      contentId,
-      contentProduct: product
-    };
   }
 }
 export const useMemoizedSyncedBlockProvider = (fetchProvider, writeProvider, sourceId, providerOptions) => {