@atlaskit/collab-provider 39.0.1 → 39.0.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/collab-provider
 
+## 39.0.2
+
+### Patch Changes
+
+- [`1f937e76a1cea`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1f937e76a1cea) -
+  Presence goes back to WebSocket first after the upgrade from polling succeeds, and network errors
+  no longer trigger the polling fallback, behind `platform_editor_presence_ws_restore_after_upgrade`
+
 ## 39.0.1
 
 ### Patch Changes

package/dist/cjs/socket-io-provider.js

@@ -16,6 +16,9 @@ var _utils = require("./helpers/utils");
 var _provider = require("./provider");
 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) { (0, _defineProperty2.default)(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; }
+/**
+ * Creates the Socket.IO client for collab editing or presence, with the transports for that connection case.
+ */
 function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path, documentAri) {
   var _URL = new URL(url),
     pathname = _URL.pathname,
@@ -94,6 +97,10 @@ var WEBSOCKET_CONNECT_TIMEOUT_MS = exports.WEBSOCKET_CONNECT_TIMEOUT_MS = 8000;
  * drop every frame, and then no error fires. Switch to polling-first when WebSocket does not connect in time,
  * or fails at the transport level. A server rejection (error with `data`) proves WebSocket works, so it never
  * triggers the fallback. Once switched, all reconnects of this socket use polling-first.
+ *
+ * With `platform_editor_presence_ws_restore_after_upgrade`, the fallback is no longer sticky and errors no longer
+ * trigger it. Errors that reach `connect_error` mean polling failed too (network down), or WebSocket already opened.
+ * Once WebSocket carries data, on open or after an upgrade from polling, go back to WebSocket-first.
  */
 function addPollingFallback(client, url, analyticsHelper) {
   var timer;
@@ -102,6 +109,11 @@ function addPollingFallback(client, url, analyticsHelper) {
     var _client$io$opts$trans;
     return !webSocketWorks && ((_client$io$opts$trans = client.io.opts.transports) === null || _client$io$opts$trans === void 0 ? void 0 : _client$io$opts$trans[0]) === 'websocket';
   };
+  var markWebSocketWorks = function markWebSocketWorks() {
+    webSocketWorks = true;
+    client.io.opts.transports = ['websocket', 'polling'];
+    client.io.opts.tryAllTransports = true;
+  };
   var fallbackToPolling = function fallbackToPolling(reason) {
     clearTimeout(timer);
     if (!isWebSocketFirst() || typeof navigator !== 'undefined' && navigator.onLine === false) {
@@ -125,6 +137,21 @@ function addPollingFallback(client, url, analyticsHelper) {
   };
   startTimer();
   client.io.on('reconnect_attempt', startTimer);
+  if ((0, _fg.fg)('platform_editor_presence_ws_restore_after_upgrade')) {
+    // The engine opens when the server handshake arrives, so the auth token fetch is not timed
+    client.io.on('open', function () {
+      clearTimeout(timer);
+      var engine = client.io.engine;
+      if (engine.transport.name === 'websocket') {
+        markWebSocketWorks();
+      } else {
+        engine.once('upgrade', function (transport) {
+          return transport.name === 'websocket' && markWebSocketWorks();
+        });
+      }
+    });
+    return;
+  }
   client.on('connect', function () {
     clearTimeout(timer);
     webSocketWorks || (webSocketWorks = client.io.engine.transport.name === 'websocket');
@@ -139,6 +166,10 @@ function addPollingFallback(client, url, analyticsHelper) {
     }
   });
 }
+
+/**
+ * Creates a collab provider that connects with Socket.IO.
+ */
 function createSocketIOCollabProvider(config) {
   return new _provider.Provider(_objectSpread(_objectSpread({}, config), {}, {
     createSocket: createSocketIOSocket

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "39.0.0";
+var version = exports.version = "39.0.1";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/socket-io-provider.js

@@ -4,6 +4,9 @@ import { SOCKET_IO_OPTIONS, SOCKET_IO_OPTIONS_WITH_HIGH_JITTER } from './config'
 import { EVENT_ACTION, EVENT_STATUS } from './helpers/const';
 import { getProduct, getSubProduct, isGCPtenant } from './helpers/utils';
 import { Provider } from './provider';
+/**
+ * Creates the Socket.IO client for collab editing or presence, with the transports for that connection case.
+ */
 export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path, documentAri) {
   const {
     pathname,
@@ -85,6 +88,10 @@ export const WEBSOCKET_CONNECT_TIMEOUT_MS = 8000;
  * drop every frame, and then no error fires. Switch to polling-first when WebSocket does not connect in time,
  * or fails at the transport level. A server rejection (error with `data`) proves WebSocket works, so it never
  * triggers the fallback. Once switched, all reconnects of this socket use polling-first.
+ *
+ * With `platform_editor_presence_ws_restore_after_upgrade`, the fallback is no longer sticky and errors no longer
+ * trigger it. Errors that reach `connect_error` mean polling failed too (network down), or WebSocket already opened.
+ * Once WebSocket carries data, on open or after an upgrade from polling, go back to WebSocket-first.
  */
 function addPollingFallback(client, url, analyticsHelper) {
   let timer;
@@ -93,6 +100,11 @@ function addPollingFallback(client, url, analyticsHelper) {
     var _client$io$opts$trans;
     return !webSocketWorks && ((_client$io$opts$trans = client.io.opts.transports) === null || _client$io$opts$trans === void 0 ? void 0 : _client$io$opts$trans[0]) === 'websocket';
   };
+  const markWebSocketWorks = () => {
+    webSocketWorks = true;
+    client.io.opts.transports = ['websocket', 'polling'];
+    client.io.opts.tryAllTransports = true;
+  };
   const fallbackToPolling = reason => {
     clearTimeout(timer);
     if (!isWebSocketFirst() || typeof navigator !== 'undefined' && navigator.onLine === false) {
@@ -114,6 +126,21 @@ function addPollingFallback(client, url, analyticsHelper) {
   };
   startTimer();
   client.io.on('reconnect_attempt', startTimer);
+  if (fg('platform_editor_presence_ws_restore_after_upgrade')) {
+    // The engine opens when the server handshake arrives, so the auth token fetch is not timed
+    client.io.on('open', () => {
+      clearTimeout(timer);
+      const {
+        engine
+      } = client.io;
+      if (engine.transport.name === 'websocket') {
+        markWebSocketWorks();
+      } else {
+        engine.once('upgrade', transport => transport.name === 'websocket' && markWebSocketWorks());
+      }
+    });
+    return;
+  }
   client.on('connect', () => {
     clearTimeout(timer);
     webSocketWorks ||= client.io.engine.transport.name === 'websocket';
@@ -128,6 +155,10 @@ function addPollingFallback(client, url, analyticsHelper) {
     }
   });
 }
+
+/**
+ * Creates a collab provider that connects with Socket.IO.
+ */
 export function createSocketIOCollabProvider(config) {
   return new Provider({
     ...config,

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "39.0.0";
+export const version = "39.0.1";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/socket-io-provider.js

@@ -7,6 +7,9 @@ import { SOCKET_IO_OPTIONS, SOCKET_IO_OPTIONS_WITH_HIGH_JITTER } from './config'
 import { EVENT_ACTION, EVENT_STATUS } from './helpers/const';
 import { getProduct, getSubProduct, isGCPtenant } from './helpers/utils';
 import { Provider } from './provider';
+/**
+ * Creates the Socket.IO client for collab editing or presence, with the transports for that connection case.
+ */
 export function createSocketIOSocket(url, auth, productInfo, isPresenceOnly, analyticsHelper, path, documentAri) {
   var _URL = new URL(url),
     pathname = _URL.pathname,
@@ -85,6 +88,10 @@ export var WEBSOCKET_CONNECT_TIMEOUT_MS = 8000;
  * drop every frame, and then no error fires. Switch to polling-first when WebSocket does not connect in time,
  * or fails at the transport level. A server rejection (error with `data`) proves WebSocket works, so it never
  * triggers the fallback. Once switched, all reconnects of this socket use polling-first.
+ *
+ * With `platform_editor_presence_ws_restore_after_upgrade`, the fallback is no longer sticky and errors no longer
+ * trigger it. Errors that reach `connect_error` mean polling failed too (network down), or WebSocket already opened.
+ * Once WebSocket carries data, on open or after an upgrade from polling, go back to WebSocket-first.
  */
 function addPollingFallback(client, url, analyticsHelper) {
   var timer;
@@ -93,6 +100,11 @@ function addPollingFallback(client, url, analyticsHelper) {
     var _client$io$opts$trans;
     return !webSocketWorks && ((_client$io$opts$trans = client.io.opts.transports) === null || _client$io$opts$trans === void 0 ? void 0 : _client$io$opts$trans[0]) === 'websocket';
   };
+  var markWebSocketWorks = function markWebSocketWorks() {
+    webSocketWorks = true;
+    client.io.opts.transports = ['websocket', 'polling'];
+    client.io.opts.tryAllTransports = true;
+  };
   var fallbackToPolling = function fallbackToPolling(reason) {
     clearTimeout(timer);
     if (!isWebSocketFirst() || typeof navigator !== 'undefined' && navigator.onLine === false) {
@@ -116,6 +128,21 @@ function addPollingFallback(client, url, analyticsHelper) {
   };
   startTimer();
   client.io.on('reconnect_attempt', startTimer);
+  if (fg('platform_editor_presence_ws_restore_after_upgrade')) {
+    // The engine opens when the server handshake arrives, so the auth token fetch is not timed
+    client.io.on('open', function () {
+      clearTimeout(timer);
+      var engine = client.io.engine;
+      if (engine.transport.name === 'websocket') {
+        markWebSocketWorks();
+      } else {
+        engine.once('upgrade', function (transport) {
+          return transport.name === 'websocket' && markWebSocketWorks();
+        });
+      }
+    });
+    return;
+  }
   client.on('connect', function () {
     clearTimeout(timer);
     webSocketWorks || (webSocketWorks = client.io.engine.transport.name === 'websocket');
@@ -130,6 +157,10 @@ function addPollingFallback(client, url, analyticsHelper) {
     }
   });
 }
+
+/**
+ * Creates a collab provider that connects with Socket.IO.
+ */
 export function createSocketIOCollabProvider(config) {
   return new Provider(_objectSpread(_objectSpread({}, config), {}, {
     createSocket: createSocketIOSocket

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "39.0.0";
+export var version = "39.0.1";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/socket-io-provider.d.ts

@@ -2,6 +2,12 @@ import type { Socket } from 'socket.io-client';
 import type AnalyticsHelper from './analytics/analytics-helper';
 import { Provider } from './provider';
 import type { Config, ProductInformation, InitAndAuthData, AuthCallback } from './types';
+/**
+ * Creates the Socket.IO client for collab editing or presence, with the transports for that connection case.
+ */
 export declare function createSocketIOSocket(url: string, auth?: AuthCallback | InitAndAuthData, productInfo?: ProductInformation, isPresenceOnly?: boolean, analyticsHelper?: AnalyticsHelper, path?: string, documentAri?: string): Socket;
 export declare const WEBSOCKET_CONNECT_TIMEOUT_MS = 8000;
+/**
+ * Creates a collab provider that connects with Socket.IO.
+ */
 export declare function createSocketIOCollabProvider(config: Omit<Config, 'createSocket'>): Provider;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "39.0.1",
+	"version": "39.0.2",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -67,6 +67,9 @@
 		"platform_editor_presence_ws_first_with_fallback": {
 			"type": "boolean"
 		},
+		"platform_editor_presence_ws_restore_after_upgrade": {
+			"type": "boolean"
+		},
 		"collab_edit_via_websocket_only_for_gcp": {
 			"type": "boolean"
 		}