npm - @atlaskit/node-data-provider - Versions diffs - 4.4.0 → 4.5.0 - Mend

@atlaskit/node-data-provider 4.4.0 → 4.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,14 @@
 # @atlaskit/node-data-provider
+## 4.5.0
+### Minor Changes
+- [#193382](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/193382)
+  [`5c827a7e9ac42`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5c827a7e9ac42) -
+  [https://product-fabric.atlassian.net/browse/ED-28627](ED-28627) - add `duration` and `success` to
+  `prefetchNodeDataProvidersData` result
 ## 4.4.0
 ### Minor Changes

package/dist/cjs/utils/prefetch-node-data-providers-data.js CHANGED Viewed

@@ -20,14 +20,28 @@ var _findNodesToPrefetch = require("./find-nodes-to-prefetch");
  */
 /**
  * Represents the aggregated SSR data for all node data providers.
- * It's a map where each key is a provider's name and the value is the {@link SsrData} for that provider.
- * This structure is used to hydrate the client-side caches.
+ * Each key is a provider's name, and the value contains the fetch status, duration,
+ * and a map of node data keys to their prefetched data.
  *
  * @example
+ * ```
  * {
- *   'mentionProvider': { 'mention-1': { id: '1', name: 'John Doe' } },
- *   'emojiProvider': { 'emoji-123': { shortName: ':smile:', representation: '😊' } }
+ *   mentionProvider: {
+ *     success: true,
+ *     duration: 220,
+ *     data: {
+ *       'mention-1': { id: '1', name: 'John Doe' }
+ *     }
+ *   },
+ *   emojiProvider: {
+ *     success: true,
+ *     duration: 110,
+ *     data: {
+ *       'emoji-123': { shortName: ':smile:', representation: '😊' }
+ *     }
+ *   }
  * }
+ * ```
  */
 /**
  * Fetches data for nodes in the document that are supported by the given providers.
@@ -49,7 +63,7 @@ var _findNodesToPrefetch = require("./find-nodes-to-prefetch");
  *   },
  * ];
  *
- * window['__SSR_EDITOR_NODE_DATA_PROVIDERS_DATA__'] = await prefetchNodeDataProvidersData({
+ * const data = await prefetchNodeDataProvidersData({
  *   providers,
  *   doc,
  *   timeout: 1_000,
@@ -59,7 +73,7 @@ var _findNodesToPrefetch = require("./find-nodes-to-prefetch");
  *
  * @param props The properties for prefetching node data.
  * @returns Record of provider names to their respective SSR data,
- *          where each SSR data is a record of node data keys to the fetched data.
+ *          success status, and duration of the fetch operation.
  */
 function prefetchNodeDataProvidersData(_x) {
   return _prefetchNodeDataProvidersData.apply(this, arguments);
@@ -101,39 +115,47 @@ function _prefetchNodeDataProvidersData() {
           });
           promises = nodesWithProviders.map( /*#__PURE__*/function () {
             var _ref6 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(_ref5) {
-              var nodes, provider, timeout, timeoutPromise, data;
+              var nodes, provider, timeout, start, getDurationFromStart, timeoutPromise, data;
               return _regenerator.default.wrap(function _callee$(_context) {
                 while (1) switch (_context.prev = _context.next) {
                   case 0:
+                    getDurationFromStart = function _getDurationFromStart() {
+                      return Math.min(performance.now() - start, timeout);
+                    };
                     nodes = _ref5.nodes, provider = _ref5.provider, timeout = _ref5.timeout;
-                    _context.prev = 1;
-                    timeoutPromise = new Promise(function (resolve) {
+                    start = performance.now();
+                    _context.prev = 3;
+                    timeoutPromise = new Promise(function (_, reject) {
                       setTimeout(function () {
-                        resolve([]);
+                        reject();
                       }, timeout);
                     });
-                    _context.next = 5;
+                    _context.next = 7;
                     return Promise.race([provider.fetchNodesData(nodes), timeoutPromise]);
-                  case 5:
+                  case 7:
                     data = _context.sent;
                     return _context.abrupt("return", {
                       provider: provider,
+                      success: true,
+                      duration: getDurationFromStart(),
                       nodes: nodes,
                       data: data
                     });
-                  case 9:
-                    _context.prev = 9;
-                    _context.t0 = _context["catch"](1);
+                  case 11:
+                    _context.prev = 11;
+                    _context.t0 = _context["catch"](3);
                     return _context.abrupt("return", {
                       provider: provider,
+                      success: false,
+                      duration: getDurationFromStart(),
                       nodes: nodes,
                       data: []
                     });
-                  case 12:
+                  case 14:
                   case "end":
                     return _context.stop();
                 }
-              }, _callee, null, [[1, 9]]);
+              }, _callee, null, [[3, 11]]);
             }));
             return function (_x2) {
               return _ref6.apply(this, arguments);
@@ -145,14 +167,21 @@ function _prefetchNodeDataProvidersData() {
           results = _context2.sent;
           return _context2.abrupt("return", results.reduce(function (acc, _ref7) {
             var provider = _ref7.provider,
+              success = _ref7.success,
+              duration = _ref7.duration,
               nodes = _ref7.nodes,
               data = _ref7.data;
-            acc[provider.name] = data.reduce(function (providerSsrData, nodeData, nodeIndex) {
+            var ssrData = data.reduce(function (providerSsrData, nodeData, nodeIndex) {
               var node = nodes[nodeIndex];
               var nodeDataKey = provider.nodeDataKey(node);
               providerSsrData[nodeDataKey] = nodeData;
               return providerSsrData;
             }, {});
+            acc[provider.name] = {
+              data: ssrData,
+              success: success,
+              duration: duration
+            };
             return acc;
           }, {}));
         case 9:

package/dist/es2019/utils/prefetch-node-data-providers-data.js CHANGED Viewed

@@ -13,14 +13,28 @@ import { findNodesToPrefetch } from './find-nodes-to-prefetch';
 /**
  * Represents the aggregated SSR data for all node data providers.
- * It's a map where each key is a provider's name and the value is the {@link SsrData} for that provider.
- * This structure is used to hydrate the client-side caches.
+ * Each key is a provider's name, and the value contains the fetch status, duration,
+ * and a map of node data keys to their prefetched data.
  *
  * @example
+ * ```
  * {
- *   'mentionProvider': { 'mention-1': { id: '1', name: 'John Doe' } },
- *   'emojiProvider': { 'emoji-123': { shortName: ':smile:', representation: '😊' } }
+ *   mentionProvider: {
+ *     success: true,
+ *     duration: 220,
+ *     data: {
+ *       'mention-1': { id: '1', name: 'John Doe' }
+ *     }
+ *   },
+ *   emojiProvider: {
+ *     success: true,
+ *     duration: 110,
+ *     data: {
+ *       'emoji-123': { shortName: ':smile:', representation: '😊' }
+ *     }
+ *   }
  * }
+ * ```
  */
 /**
@@ -43,7 +57,7 @@ import { findNodesToPrefetch } from './find-nodes-to-prefetch';
  *   },
  * ];
  *
- * window['__SSR_EDITOR_NODE_DATA_PROVIDERS_DATA__'] = await prefetchNodeDataProvidersData({
+ * const data = await prefetchNodeDataProvidersData({
  *   providers,
  *   doc,
  *   timeout: 1_000,
@@ -53,7 +67,7 @@ import { findNodesToPrefetch } from './find-nodes-to-prefetch';
  *
  * @param props The properties for prefetching node data.
  * @returns Record of provider names to their respective SSR data,
- *          where each SSR data is a record of node data keys to the fetched data.
+ *          success status, and duration of the fetch operation.
  */
 export async function prefetchNodeDataProvidersData({
   providers,
@@ -91,21 +105,29 @@ export async function prefetchNodeDataProvidersData({
     provider,
     timeout
   }) => {
+    const start = performance.now();
+    function getDurationFromStart() {
+      return Math.min(performance.now() - start, timeout);
+    }
     try {
-      const timeoutPromise = new Promise(resolve => {
+      const timeoutPromise = new Promise((_, reject) => {
         setTimeout(() => {
-          resolve([]);
+          reject();
         }, timeout);
       });
       const data = await Promise.race([provider.fetchNodesData(nodes), timeoutPromise]);
       return {
         provider,
+        success: true,
+        duration: getDurationFromStart(),
         nodes,
         data
       };
     } catch {
       return {
         provider,
+        success: false,
+        duration: getDurationFromStart(),
         nodes,
         data: []
       };
@@ -114,15 +136,22 @@ export async function prefetchNodeDataProvidersData({
   const results = await Promise.all(promises);
   return results.reduce((acc, {
     provider,
+    success,
+    duration,
     nodes,
     data
   }) => {
-    acc[provider.name] = data.reduce((providerSsrData, nodeData, nodeIndex) => {
+    const ssrData = data.reduce((providerSsrData, nodeData, nodeIndex) => {
       const node = nodes[nodeIndex];
       const nodeDataKey = provider.nodeDataKey(node);
       providerSsrData[nodeDataKey] = nodeData;
       return providerSsrData;
     }, {});
+    acc[provider.name] = {
+      data: ssrData,
+      success,
+      duration
+    };
     return acc;
   }, {});
 }

package/dist/esm/utils/prefetch-node-data-providers-data.js CHANGED Viewed

@@ -15,14 +15,28 @@ import { findNodesToPrefetch } from './find-nodes-to-prefetch';
 /**
  * Represents the aggregated SSR data for all node data providers.
- * It's a map where each key is a provider's name and the value is the {@link SsrData} for that provider.
- * This structure is used to hydrate the client-side caches.
+ * Each key is a provider's name, and the value contains the fetch status, duration,
+ * and a map of node data keys to their prefetched data.
  *
  * @example
+ * ```
  * {
- *   'mentionProvider': { 'mention-1': { id: '1', name: 'John Doe' } },
- *   'emojiProvider': { 'emoji-123': { shortName: ':smile:', representation: '😊' } }
+ *   mentionProvider: {
+ *     success: true,
+ *     duration: 220,
+ *     data: {
+ *       'mention-1': { id: '1', name: 'John Doe' }
+ *     }
+ *   },
+ *   emojiProvider: {
+ *     success: true,
+ *     duration: 110,
+ *     data: {
+ *       'emoji-123': { shortName: ':smile:', representation: '😊' }
+ *     }
+ *   }
  * }
+ * ```
  */
 /**
@@ -45,7 +59,7 @@ import { findNodesToPrefetch } from './find-nodes-to-prefetch';
  *   },
  * ];
  *
- * window['__SSR_EDITOR_NODE_DATA_PROVIDERS_DATA__'] = await prefetchNodeDataProvidersData({
+ * const data = await prefetchNodeDataProvidersData({
  *   providers,
  *   doc,
  *   timeout: 1_000,
@@ -55,7 +69,7 @@ import { findNodesToPrefetch } from './find-nodes-to-prefetch';
  *
  * @param props The properties for prefetching node data.
  * @returns Record of provider names to their respective SSR data,
- *          where each SSR data is a record of node data keys to the fetched data.
+ *          success status, and duration of the fetch operation.
  */
 export function prefetchNodeDataProvidersData(_x) {
   return _prefetchNodeDataProvidersData.apply(this, arguments);
@@ -97,39 +111,47 @@ function _prefetchNodeDataProvidersData() {
           });
           promises = nodesWithProviders.map( /*#__PURE__*/function () {
             var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref5) {
-              var nodes, provider, timeout, timeoutPromise, data;
+              var nodes, provider, timeout, start, getDurationFromStart, timeoutPromise, data;
               return _regeneratorRuntime.wrap(function _callee$(_context) {
                 while (1) switch (_context.prev = _context.next) {
                   case 0:
+                    getDurationFromStart = function _getDurationFromStart() {
+                      return Math.min(performance.now() - start, timeout);
+                    };
                     nodes = _ref5.nodes, provider = _ref5.provider, timeout = _ref5.timeout;
-                    _context.prev = 1;
-                    timeoutPromise = new Promise(function (resolve) {
+                    start = performance.now();
+                    _context.prev = 3;
+                    timeoutPromise = new Promise(function (_, reject) {
                       setTimeout(function () {
-                        resolve([]);
+                        reject();
                       }, timeout);
                     });
-                    _context.next = 5;
+                    _context.next = 7;
                     return Promise.race([provider.fetchNodesData(nodes), timeoutPromise]);
-                  case 5:
+                  case 7:
                     data = _context.sent;
                     return _context.abrupt("return", {
                       provider: provider,
+                      success: true,
+                      duration: getDurationFromStart(),
                       nodes: nodes,
                       data: data
                     });
-                  case 9:
-                    _context.prev = 9;
-                    _context.t0 = _context["catch"](1);
+                  case 11:
+                    _context.prev = 11;
+                    _context.t0 = _context["catch"](3);
                     return _context.abrupt("return", {
                       provider: provider,
+                      success: false,
+                      duration: getDurationFromStart(),
                       nodes: nodes,
                       data: []
                     });
-                  case 12:
+                  case 14:
                   case "end":
                     return _context.stop();
                 }
-              }, _callee, null, [[1, 9]]);
+              }, _callee, null, [[3, 11]]);
             }));
             return function (_x2) {
               return _ref6.apply(this, arguments);
@@ -141,14 +163,21 @@ function _prefetchNodeDataProvidersData() {
           results = _context2.sent;
           return _context2.abrupt("return", results.reduce(function (acc, _ref7) {
             var provider = _ref7.provider,
+              success = _ref7.success,
+              duration = _ref7.duration,
               nodes = _ref7.nodes,
               data = _ref7.data;
-            acc[provider.name] = data.reduce(function (providerSsrData, nodeData, nodeIndex) {
+            var ssrData = data.reduce(function (providerSsrData, nodeData, nodeIndex) {
               var node = nodes[nodeIndex];
               var nodeDataKey = provider.nodeDataKey(node);
               providerSsrData[nodeDataKey] = nodeData;
               return providerSsrData;
             }, {});
+            acc[provider.name] = {
+              data: ssrData,
+              success: success,
+              duration: duration
+            };
             return acc;
           }, {}));
         case 9:

package/dist/types/utils/prefetch-node-data-providers-data.d.ts CHANGED Viewed

@@ -15,17 +15,35 @@ type SsrData = {
 };
 /**
  * Represents the aggregated SSR data for all node data providers.
- * It's a map where each key is a provider's name and the value is the {@link SsrData} for that provider.
- * This structure is used to hydrate the client-side caches.
+ * Each key is a provider's name, and the value contains the fetch status, duration,
+ * and a map of node data keys to their prefetched data.
  *
  * @example
+ * ```
  * {
- *   'mentionProvider': { 'mention-1': { id: '1', name: 'John Doe' } },
- *   'emojiProvider': { 'emoji-123': { shortName: ':smile:', representation: '😊' } }
+ *   mentionProvider: {
+ *     success: true,
+ *     duration: 220,
+ *     data: {
+ *       'mention-1': { id: '1', name: 'John Doe' }
+ *     }
+ *   },
+ *   emojiProvider: {
+ *     success: true,
+ *     duration: 110,
+ *     data: {
+ *       'emoji-123': { shortName: ':smile:', representation: '😊' }
+ *     }
+ *   }
  * }
+ * ```
  */
 type NodeDataProvidersSsrData = {
-    [providerName: string]: SsrData;
+    [providerName: string]: {
+        success: boolean;
+        duration: number;
+        data: SsrData;
+    };
 };
 interface Props {
     /**
@@ -91,7 +109,7 @@ interface Props {
  *   },
  * ];
  *
- * window['__SSR_EDITOR_NODE_DATA_PROVIDERS_DATA__'] = await prefetchNodeDataProvidersData({
+ * const data = await prefetchNodeDataProvidersData({
  *   providers,
  *   doc,
  *   timeout: 1_000,
@@ -101,7 +119,7 @@ interface Props {
  *
  * @param props The properties for prefetching node data.
  * @returns Record of provider names to their respective SSR data,
- *          where each SSR data is a record of node data keys to the fetched data.
+ *          success status, and duration of the fetch operation.
  */
 export declare function prefetchNodeDataProvidersData({ providers, doc, timeout, maxNodesToVisit, }: Props): Promise<NodeDataProvidersSsrData>;
 export {};

package/dist/types-ts4.5/utils/prefetch-node-data-providers-data.d.ts CHANGED Viewed

@@ -15,17 +15,35 @@ type SsrData = {
 };
 /**
  * Represents the aggregated SSR data for all node data providers.
- * It's a map where each key is a provider's name and the value is the {@link SsrData} for that provider.
- * This structure is used to hydrate the client-side caches.
+ * Each key is a provider's name, and the value contains the fetch status, duration,
+ * and a map of node data keys to their prefetched data.
  *
  * @example
+ * ```
  * {
- *   'mentionProvider': { 'mention-1': { id: '1', name: 'John Doe' } },
- *   'emojiProvider': { 'emoji-123': { shortName: ':smile:', representation: '😊' } }
+ *   mentionProvider: {
+ *     success: true,
+ *     duration: 220,
+ *     data: {
+ *       'mention-1': { id: '1', name: 'John Doe' }
+ *     }
+ *   },
+ *   emojiProvider: {
+ *     success: true,
+ *     duration: 110,
+ *     data: {
+ *       'emoji-123': { shortName: ':smile:', representation: '😊' }
+ *     }
+ *   }
  * }
+ * ```
  */
 type NodeDataProvidersSsrData = {
-    [providerName: string]: SsrData;
+    [providerName: string]: {
+        success: boolean;
+        duration: number;
+        data: SsrData;
+    };
 };
 interface Props {
     /**
@@ -91,7 +109,7 @@ interface Props {
  *   },
  * ];
  *
- * window['__SSR_EDITOR_NODE_DATA_PROVIDERS_DATA__'] = await prefetchNodeDataProvidersData({
+ * const data = await prefetchNodeDataProvidersData({
  *   providers,
  *   doc,
  *   timeout: 1_000,
@@ -101,7 +119,7 @@ interface Props {
  *
  * @param props The properties for prefetching node data.
  * @returns Record of provider names to their respective SSR data,
- *          where each SSR data is a record of node data keys to the fetched data.
+ *          success status, and duration of the fetch operation.
  */
 export declare function prefetchNodeDataProvidersData({ providers, doc, timeout, maxNodesToVisit, }: Props): Promise<NodeDataProvidersSsrData>;
 export {};

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/node-data-provider",
-	"version": "4.4.0",
+	"version": "4.5.0",
 	"description": "Node data provider for @atlaskit/editor-core plugins and @atlaskit/renderer",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -24,12 +24,12 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^50.0.1",
 		"@atlaskit/adf-utils": "^19.20.0",
-		"@atlaskit/editor-json-transformer": "^8.24.0",
+		"@atlaskit/editor-json-transformer": "^8.25.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.12.0"
+		"@atlaskit/editor-common": "^107.13.0"
 	},
 	"devDependencies": {
 		"typescript": "~5.4.2"