@atlaskit/editor-synced-block-provider 3.14.6 → 3.16.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.16.0
+
+### Minor Changes
+
+- [`ff4d035bb0bda`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ff4d035bb0bda) -
+  EDITOR-2849 fix editor and live page ssr
+
+## 3.15.0
+
+### Minor Changes
+
+- [`04b96fcb2ac43`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/04b96fcb2ac43) -
+  Use existing function to check if SSR
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.14.6
 
 ### Patch Changes

package/dist/cjs/clients/block-service/blockSubscription.js

@@ -5,12 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.subscribeToBlockUpdates = void 0;
 var _graphqlWs = require("graphql-ws");
+var _coreUtils = require("@atlaskit/editor-common/core-utils");
 var _utils = require("../../utils/utils");
 var GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
 var blockServiceClient = null;
 var getBlockServiceClient = function getBlockServiceClient() {
   // Don't create client during SSR
-  if (typeof window === 'undefined') {
+  if ((0, _coreUtils.isSSR)()) {
     return null;
   }
   if (!blockServiceClient) {

package/dist/cjs/hooks/useFetchSyncBlockData.js

@@ -10,6 +10,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = require("react");
+var _coreUtils = require("@atlaskit/editor-common/core-utils");
 var _monitoring = require("@atlaskit/editor-common/monitoring");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _types = require("../common/types");
@@ -110,6 +111,11 @@ var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyn
     }, _callee, null, [[2, 11]]);
   })), [isLoading, localId, manager.referenceManager, resourceId, fireAnalyticsEvent]);
   (0, _react.useEffect)(function () {
+    if ((0, _coreUtils.isSSR)()) {
+      // in SSR, we don't need to subscribe to updates,
+      // instead we rely on pre-fetched data ONLY, see initialization of syncBlockInstance above
+      return;
+    }
     var unsubscribe = manager.referenceManager.subscribeToSyncBlock(resourceId || '', localId || '', function (data) {
       setFetchState({
         syncBlockInstance: data,

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

@@ -11,6 +11,7 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _coreUtils = require("@atlaskit/editor-common/core-utils");
 var _monitoring = require("@atlaskit/editor-common/monitoring");
 var _providerFactory = require("@atlaskit/editor-common/provider-factory");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
@@ -194,9 +195,16 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "getInitialSyncBlockData",
     value: function getInitialSyncBlockData(resourceId) {
-      var _this$dataProvider;
+      var _this$dataProvider2;
       var syncBlockNode = (0, _utils.createSyncBlockNode)('', resourceId);
-      return this.getFromCache(resourceId) || ((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 || (_this$dataProvider = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.data);
+      if ((0, _coreUtils.isSSR)() && (0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
+        var _this$dataProvider;
+        // In SSR, prefer data from data provider cache
+        // should not take from store manager cache as it may be in incomplete state
+        // will be unified to the same cache later.
+        return (_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 || (_this$dataProvider = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.data;
+      }
+      return this.getFromCache(resourceId) || ((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 || (_this$dataProvider2 = _this$dataProvider2.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider2 === void 0 ? void 0 : _this$dataProvider2.data);
     }
 
     /**
@@ -301,13 +309,13 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "setupGraphQLSubscription",
     value: function setupGraphQLSubscription(resourceId) {
-      var _this$dataProvider2,
+      var _this$dataProvider3,
         _this3 = this;
       // Don't set up duplicate subscriptions
       if (this.graphqlSubscriptions.has(resourceId)) {
         return;
       }
-      if (!((_this$dataProvider2 = this.dataProvider) !== null && _this$dataProvider2 !== void 0 && _this$dataProvider2.subscribeToBlockUpdates)) {
+      if (!((_this$dataProvider3 = this.dataProvider) !== null && _this$dataProvider3 !== void 0 && _this$dataProvider3.subscribeToBlockUpdates)) {
         return;
       }
       var unsubscribe = this.dataProvider.subscribeToBlockUpdates(resourceId, function (syncBlockInstance) {
@@ -709,7 +717,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "subscribeToSyncBlock",
     value: function subscribeToSyncBlock(resourceId, localId, callback) {
-      var _this$dataProvider3,
+      var _this$dataProvider4,
+        _this$dataProvider5,
         _this6 = this;
       // Cancel any pending cache deletion for this resourceId.
       // This handles the case where a block is moved - the old component unmounts
@@ -737,7 +746,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
 
       // call the callback immediately if we have cached data
       // prefer cache from store manager first, should update data provider to use the same cache
-      var cachedData = this.getFromCache(resourceId) || ((_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 || (_this$dataProvider3 = _this$dataProvider3.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider3 === void 0 ? void 0 : _this$dataProvider3.data);
+      var cachedData = (0, _coreUtils.isSSR)() && (0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding') // in SSR, prefer data provider cache
+      ? ((_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) || this.getFromCache(resourceId) : this.getFromCache(resourceId) || ((_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);
       if (cachedData) {
         callback(cachedData);
       } else {

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

@@ -1,10 +1,11 @@
 import { createClient } from 'graphql-ws';
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { convertContentUpdatedAt } from '../../utils/utils';
 const GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
 let blockServiceClient = null;
 const getBlockServiceClient = () => {
   // Don't create client during SSR
-  if (typeof window === 'undefined') {
+  if (isSSR()) {
     return null;
   }
   if (!blockServiceClient) {

package/dist/es2019/hooks/useFetchSyncBlockData.js

@@ -1,4 +1,5 @@
 import { useCallback, useEffect, useMemo, useState } from 'react';
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
@@ -73,6 +74,11 @@ export const useFetchSyncBlockData = (manager, resourceId, localId, fireAnalytic
     }));
   }, [isLoading, localId, manager.referenceManager, resourceId, fireAnalyticsEvent]);
   useEffect(() => {
+    if (isSSR()) {
+      // in SSR, we don't need to subscribe to updates,
+      // instead we rely on pre-fetched data ONLY, see initialization of syncBlockInstance above
+      return;
+    }
     const unsubscribe = manager.referenceManager.subscribeToSyncBlock(resourceId || '', localId || '', data => {
       setFetchState({
         syncBlockInstance: data,

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

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -151,9 +152,16 @@ export class ReferenceSyncBlockStoreManager {
     this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   getInitialSyncBlockData(resourceId) {
-    var _this$dataProvider, _this$dataProvider$ge;
+    var _this$dataProvider2, _this$dataProvider2$g;
     const syncBlockNode = createSyncBlockNode('', resourceId);
-    return this.getFromCache(resourceId) || ((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : (_this$dataProvider$ge = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider$ge === void 0 ? void 0 : _this$dataProvider$ge.data);
+    if (isSSR() && fg('platform_synced_block_dogfooding')) {
+      var _this$dataProvider, _this$dataProvider$ge;
+      // In SSR, prefer data from data provider cache
+      // should not take from store manager cache as it may be in incomplete state
+      // will be unified to the same cache later.
+      return (_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : (_this$dataProvider$ge = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider$ge === void 0 ? void 0 : _this$dataProvider$ge.data;
+    }
+    return this.getFromCache(resourceId) || ((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 ? void 0 : (_this$dataProvider2$g = _this$dataProvider2.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider2$g === void 0 ? void 0 : _this$dataProvider2$g.data);
   }
 
   /**
@@ -196,12 +204,12 @@ export class ReferenceSyncBlockStoreManager {
    * @param resourceId - The resource ID of the block to subscribe to
    */
   setupGraphQLSubscription(resourceId) {
-    var _this$dataProvider2;
+    var _this$dataProvider3;
     // Don't set up duplicate subscriptions
     if (this.graphqlSubscriptions.has(resourceId)) {
       return;
     }
-    if (!((_this$dataProvider2 = this.dataProvider) !== null && _this$dataProvider2 !== void 0 && _this$dataProvider2.subscribeToBlockUpdates)) {
+    if (!((_this$dataProvider3 = this.dataProvider) !== null && _this$dataProvider3 !== void 0 && _this$dataProvider3.subscribeToBlockUpdates)) {
       return;
     }
     const unsubscribe = this.dataProvider.subscribeToBlockUpdates(resourceId, syncBlockInstance => {
@@ -537,7 +545,7 @@ export class ReferenceSyncBlockStoreManager {
     this.providerFactories.delete(resourceId);
   }
   subscribeToSyncBlock(resourceId, localId, callback) {
-    var _this$dataProvider3, _this$dataProvider3$g;
+    var _this$dataProvider4, _this$dataProvider4$g, _this$dataProvider5, _this$dataProvider5$g;
     // Cancel any pending cache deletion for this resourceId.
     // This handles the case where a block is moved - the old component unmounts
     // (scheduling deletion) but the new component mounts and subscribes before
@@ -567,7 +575,8 @@ export class ReferenceSyncBlockStoreManager {
 
     // call the callback immediately if we have cached data
     // prefer cache from store manager first, should update data provider to use the same cache
-    const cachedData = this.getFromCache(resourceId) || ((_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 ? void 0 : (_this$dataProvider3$g = _this$dataProvider3.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider3$g === void 0 ? void 0 : _this$dataProvider3$g.data);
+    const cachedData = isSSR() && fg('platform_synced_block_dogfooding') // in SSR, prefer data provider cache
+    ? ((_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) || this.getFromCache(resourceId) : this.getFromCache(resourceId) || ((_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);
     if (cachedData) {
       callback(cachedData);
     } else {

package/dist/esm/clients/block-service/blockSubscription.js

@@ -1,10 +1,11 @@
 import { createClient } from 'graphql-ws';
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { convertContentUpdatedAt } from '../../utils/utils';
 var GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
 var blockServiceClient = null;
 var getBlockServiceClient = function getBlockServiceClient() {
   // Don't create client during SSR
-  if (typeof window === 'undefined') {
+  if (isSSR()) {
     return null;
   }
   if (!blockServiceClient) {

package/dist/esm/hooks/useFetchSyncBlockData.js

@@ -5,6 +5,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { useCallback, useEffect, useMemo, useState } from 'react';
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
@@ -103,6 +104,11 @@ export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, resou
     }, _callee, null, [[2, 11]]);
   })), [isLoading, localId, manager.referenceManager, resourceId, fireAnalyticsEvent]);
   useEffect(function () {
+    if (isSSR()) {
+      // in SSR, we don't need to subscribe to updates,
+      // instead we rely on pre-fetched data ONLY, see initialization of syncBlockInstance above
+      return;
+    }
     var unsubscribe = manager.referenceManager.subscribeToSyncBlock(resourceId || '', localId || '', function (data) {
       setFetchState({
         syncBlockInstance: data,

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

@@ -9,6 +9,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+import { isSSR } from '@atlaskit/editor-common/core-utils';
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { fg } from '@atlaskit/platform-feature-flags';
@@ -188,9 +189,16 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "getInitialSyncBlockData",
     value: function getInitialSyncBlockData(resourceId) {
-      var _this$dataProvider;
+      var _this$dataProvider2;
       var syncBlockNode = createSyncBlockNode('', resourceId);
-      return this.getFromCache(resourceId) || ((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 || (_this$dataProvider = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.data);
+      if (isSSR() && fg('platform_synced_block_dogfooding')) {
+        var _this$dataProvider;
+        // In SSR, prefer data from data provider cache
+        // should not take from store manager cache as it may be in incomplete state
+        // will be unified to the same cache later.
+        return (_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 || (_this$dataProvider = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.data;
+      }
+      return this.getFromCache(resourceId) || ((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 || (_this$dataProvider2 = _this$dataProvider2.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider2 === void 0 ? void 0 : _this$dataProvider2.data);
     }
 
     /**
@@ -295,13 +303,13 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "setupGraphQLSubscription",
     value: function setupGraphQLSubscription(resourceId) {
-      var _this$dataProvider2,
+      var _this$dataProvider3,
         _this3 = this;
       // Don't set up duplicate subscriptions
       if (this.graphqlSubscriptions.has(resourceId)) {
         return;
       }
-      if (!((_this$dataProvider2 = this.dataProvider) !== null && _this$dataProvider2 !== void 0 && _this$dataProvider2.subscribeToBlockUpdates)) {
+      if (!((_this$dataProvider3 = this.dataProvider) !== null && _this$dataProvider3 !== void 0 && _this$dataProvider3.subscribeToBlockUpdates)) {
         return;
       }
       var unsubscribe = this.dataProvider.subscribeToBlockUpdates(resourceId, function (syncBlockInstance) {
@@ -703,7 +711,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "subscribeToSyncBlock",
     value: function subscribeToSyncBlock(resourceId, localId, callback) {
-      var _this$dataProvider3,
+      var _this$dataProvider4,
+        _this$dataProvider5,
         _this6 = this;
       // Cancel any pending cache deletion for this resourceId.
       // This handles the case where a block is moved - the old component unmounts
@@ -731,7 +740,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
 
       // call the callback immediately if we have cached data
       // prefer cache from store manager first, should update data provider to use the same cache
-      var cachedData = this.getFromCache(resourceId) || ((_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 || (_this$dataProvider3 = _this$dataProvider3.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider3 === void 0 ? void 0 : _this$dataProvider3.data);
+      var cachedData = isSSR() && fg('platform_synced_block_dogfooding') // in SSR, prefer data provider cache
+      ? ((_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) || this.getFromCache(resourceId) : this.getFromCache(resourceId) || ((_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);
       if (cachedData) {
         callback(cachedData);
       } else {

package/package.json

@@ -78,7 +78,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.14.6",
+	"version": "3.16.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",