@atlaskit/collab-provider 28.0.0 → 28.2.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @atlaskit/collab-provider
 
+## 28.2.0
+
+### Minor Changes
+
+- [`9461b21b24472`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/9461b21b24472) -
+  Add the recovery:required provider event with a reason payload so Confluence can reset an NCS
+  document on request. NCS sends the event to the document's current socket. Rollout is controlled
+  by NCS emitting the event.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 28.1.0
+
+### Minor Changes
+
+- [`36e3ed7c27a98`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/36e3ed7c27a98) -
+  Fix missing userIds in steps by using the already known confluence userId, gated by
+  `confluence_ncs_step_diffing_version_history`.
+
+### Patch Changes
+
+- [`6f50f448a393e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6f50f448a393e) -
+  Stop deriving agent participants from editor steps when platform_editor_agent_edit_presence is
+  enabled.
+- Updated dependencies
+
 ## 28.0.0
 
 ### Patch Changes

package/dist/cjs/channel.js

@@ -637,6 +637,9 @@ var Channel = exports.Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('steps:added', function (data) {
         _this2.emit('steps:added', data);
       });
+      this.socket.on('recovery:required', function (data) {
+        _this2.emit('recovery:required', data);
+      });
       this.socket.on('participant:telepointer', function (_ref7) {
         var timestamp = _ref7.timestamp,
           data = _ref7.data;

package/dist/cjs/document/document-service.js

@@ -17,6 +17,7 @@ var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _state = require("@atlaskit/editor-prosemirror/state");
 var _JSONTransformer = require("@atlaskit/editor-json-transformer/JSONTransformer-2");
 var _unsafeExpValNoExposure = require("@atlaskit/platform-feature-experiments/unsafe-exp-val-no-exposure");
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _const = require("../helpers/const");
 var _performance = require("../analytics/performance");
@@ -953,10 +954,12 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
      * milestone independently — the milestone attributes its own local steps, which are echoed back
      * to this client, so it needs the facepile without the backend streaming visuals.
      *
+     * When agent edit presence is enabled, the canonical presence channel owns agent participants.
+     * Skip this step-derived fallback entirely in that cohort to avoid duplicate or stale participants.
+     *
      * The milestone value is read without logging an exposure: this runs on every received step
      * batch, whereas the canonical exposure is logged at the action-driven call sites that decide
-     * whether to attribute a step. The backend experiment is evaluated first so its exposure
-     * population is unchanged.
+     * whether to attribute a step.
      *
      * Known limitation (PoC): steps replayed via catch-up/reconnect can briefly re-surface an agent
      * whose activity is stale — a freshness guard is a follow-up.
@@ -965,7 +968,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
     key: "maybeAddAgentPresenceFromSteps",
     value: function maybeAddAgentPresenceFromSteps(steps) {
       var _this3 = this;
-      if (!(0, _expValEquals.expValEquals)('platform_editor_agent_be_streaming', 'isEnabled', true) && !(0, _unsafeExpValNoExposure.UNSAFE_expValNoExposure)('platform_editor_ai_streaming_ux_experience_m1', 'isEnabled', false)) {
+      if ((0, _fg.fg)('platform_editor_agent_edit_presence') || !(0, _expValEquals.expValEquals)('platform_editor_agent_be_streaming', 'isEnabled', true) && !(0, _unsafeExpValNoExposure.UNSAFE_expValNoExposure)('platform_editor_ai_streaming_ux_experience_m1', 'isEnabled', false)) {
         return;
       }
       try {

package/dist/cjs/participants/participants-service.js

@@ -859,9 +859,9 @@ var ParticipantsService = exports.ParticipantsService = /*#__PURE__*/function ()
     (0, _defineProperty2.default)(this, "onPresence", function (payload) {
       try {
         logger('onPresence userId: ', payload.userId);
-        // Ignored via go/ees005
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        _this.setUserId(payload.userId);
+        if (payload.userId) {
+          _this.setUserId(payload.userId);
+        }
         _this.sendPresence();
         _this.sendPresenceJoined();
       } catch (error) {

package/dist/cjs/provider/index.js

@@ -194,7 +194,11 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
       }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
         _this.permit = Object.assign(_this.permit, permit);
         _this.emit('permission', permit);
-      }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
+      }).on('steps:added', _this.documentService.onStepsAdded).on('recovery:required', function (payload) {
+        if (typeof (payload === null || payload === void 0 ? void 0 : payload.reason) === 'string') {
+          _this.emit('recovery:required', payload);
+        }
+      }).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
       }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_this)).on('error', _this.onErrorHandled).on('status', /*#__PURE__*/function () {
         var _ref4 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(status) {
@@ -444,6 +448,7 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
     _this.channel = new _channel.Channel(config, _this.analyticsHelper);
     _this.isChannelInitialized = false;
     _this.initialDraft = _this.config.initialDraft;
+    _this.userId = _this.config.userId;
     _this.isBufferingEnabled = Boolean(_this.config.isBufferingEnabled);
     _this.isProviderInitialized = false;
     _this.participantsService = new _participantsService.ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.config.batchProps, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId, _this.getAIProviderActiveIds, _this.config.fetchAnonymousAsset);

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 = "27.0.12";
+var version = exports.version = "28.1.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/channel.js

@@ -459,6 +459,9 @@ export class Channel extends Emitter {
     this.socket.on('steps:added', data => {
       this.emit('steps:added', data);
     });
+    this.socket.on('recovery:required', data => {
+      this.emit('recovery:required', data);
+    });
     this.socket.on('participant:telepointer', ({
       timestamp,
       data

package/dist/es2019/document/document-service.js

@@ -5,6 +5,7 @@ import { getCollabState, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer/JSONTransformer-2';
 import { UNSAFE_expValNoExposure } from '@atlaskit/platform-feature-experiments/unsafe-exp-val-no-exposure';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
@@ -831,16 +832,18 @@ export class DocumentService {
    * milestone independently — the milestone attributes its own local steps, which are echoed back
    * to this client, so it needs the facepile without the backend streaming visuals.
    *
+   * When agent edit presence is enabled, the canonical presence channel owns agent participants.
+   * Skip this step-derived fallback entirely in that cohort to avoid duplicate or stale participants.
+   *
    * The milestone value is read without logging an exposure: this runs on every received step
    * batch, whereas the canonical exposure is logged at the action-driven call sites that decide
-   * whether to attribute a step. The backend experiment is evaluated first so its exposure
-   * population is unchanged.
+   * whether to attribute a step.
    *
    * Known limitation (PoC): steps replayed via catch-up/reconnect can briefly re-surface an agent
    * whose activity is stale — a freshness guard is a follow-up.
    */
   maybeAddAgentPresenceFromSteps(steps) {
-    if (!expValEquals('platform_editor_agent_be_streaming', 'isEnabled', true) && !UNSAFE_expValNoExposure('platform_editor_ai_streaming_ux_experience_m1', 'isEnabled', false)) {
+    if (fg('platform_editor_agent_edit_presence') || !expValEquals('platform_editor_agent_be_streaming', 'isEnabled', true) && !UNSAFE_expValNoExposure('platform_editor_ai_streaming_ux_experience_m1', 'isEnabled', false)) {
       return;
     }
     try {

package/dist/es2019/participants/participants-service.js

@@ -698,9 +698,9 @@ export class ParticipantsService {
     _defineProperty(this, "onPresence", payload => {
       try {
         logger('onPresence userId: ', payload.userId);
-        // Ignored via go/ees005
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        this.setUserId(payload.userId);
+        if (payload.userId) {
+          this.setUserId(payload.userId);
+        }
         this.sendPresence();
         this.sendPresenceJoined();
       } catch (error) {

package/dist/es2019/provider/index.js

@@ -175,7 +175,11 @@ export class Provider extends Emitter {
       }).on('restore', this.documentService.onRestore).on('permission', permit => {
         this.permit = Object.assign(this.permit, permit);
         this.emit('permission', permit);
-      }).on('steps:added', this.documentService.onStepsAdded).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', async status => {
+      }).on('steps:added', this.documentService.onStepsAdded).on('recovery:required', payload => {
+        if (typeof (payload === null || payload === void 0 ? void 0 : payload.reason) === 'string') {
+          this.emit('recovery:required', payload);
+        }
+      }).on('metadata:changed', this.metadataService.onMetadataChanged).on('participant:telepointer', payload => this.participantsService.onParticipantTelepointer(payload, this.sessionId)).on('presence:joined', this.participantsService.onPresenceJoined).on('presence', this.participantsService.onPresence).on('participant:left', this.participantsService.onParticipantLeft).on('participant:updated', this.participantsService.onParticipantUpdated).on('disconnect', this.onDisconnected.bind(this)).on('error', this.onErrorHandled).on('status', async status => {
         await this.namespaceService.onNamespaceStatusChanged(status);
         const isLocked = this.namespaceService.getIsNamespaceLocked();
         this.emit('namespace-lock:check', {
@@ -361,6 +365,7 @@ export class Provider extends Emitter {
     this.channel = new Channel(config, this.analyticsHelper);
     this.isChannelInitialized = false;
     this.initialDraft = this.config.initialDraft;
+    this.userId = this.config.userId;
     this.isBufferingEnabled = Boolean(this.config.isBufferingEnabled);
     this.isProviderInitialized = false;
     this.participantsService = new ParticipantsService(this.analyticsHelper, undefined, this.emitCallback, this.config.getUser, this.config.batchProps, this.channel.broadcast, this.channel.sendPresenceJoined, this.getPresenceData, this.setUserId, this.getAIProviderActiveIds, this.config.fetchAnonymousAsset);

package/dist/es2019/version-wrapper.js

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

package/dist/esm/channel.js

@@ -630,6 +630,9 @@ export var Channel = /*#__PURE__*/function (_Emitter) {
       this.socket.on('steps:added', function (data) {
         _this2.emit('steps:added', data);
       });
+      this.socket.on('recovery:required', function (data) {
+        _this2.emit('recovery:required', data);
+      });
       this.socket.on('participant:telepointer', function (_ref7) {
         var timestamp = _ref7.timestamp,
           data = _ref7.data;

package/dist/esm/document/document-service.js

@@ -15,6 +15,7 @@ import { getCollabState, sendableSteps } from '@atlaskit/prosemirror-collab';
 import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer/JSONTransformer-2';
 import { UNSAFE_expValNoExposure } from '@atlaskit/platform-feature-experiments/unsafe-exp-val-no-exposure';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
@@ -947,10 +948,12 @@ export var DocumentService = /*#__PURE__*/function () {
      * milestone independently — the milestone attributes its own local steps, which are echoed back
      * to this client, so it needs the facepile without the backend streaming visuals.
      *
+     * When agent edit presence is enabled, the canonical presence channel owns agent participants.
+     * Skip this step-derived fallback entirely in that cohort to avoid duplicate or stale participants.
+     *
      * The milestone value is read without logging an exposure: this runs on every received step
      * batch, whereas the canonical exposure is logged at the action-driven call sites that decide
-     * whether to attribute a step. The backend experiment is evaluated first so its exposure
-     * population is unchanged.
+     * whether to attribute a step.
      *
      * Known limitation (PoC): steps replayed via catch-up/reconnect can briefly re-surface an agent
      * whose activity is stale — a freshness guard is a follow-up.
@@ -959,7 +962,7 @@ export var DocumentService = /*#__PURE__*/function () {
     key: "maybeAddAgentPresenceFromSteps",
     value: function maybeAddAgentPresenceFromSteps(steps) {
       var _this3 = this;
-      if (!expValEquals('platform_editor_agent_be_streaming', 'isEnabled', true) && !UNSAFE_expValNoExposure('platform_editor_ai_streaming_ux_experience_m1', 'isEnabled', false)) {
+      if (fg('platform_editor_agent_edit_presence') || !expValEquals('platform_editor_agent_be_streaming', 'isEnabled', true) && !UNSAFE_expValNoExposure('platform_editor_ai_streaming_ux_experience_m1', 'isEnabled', false)) {
         return;
       }
       try {

package/dist/esm/participants/participants-service.js

@@ -852,9 +852,9 @@ export var ParticipantsService = /*#__PURE__*/function () {
     _defineProperty(this, "onPresence", function (payload) {
       try {
         logger('onPresence userId: ', payload.userId);
-        // Ignored via go/ees005
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        _this.setUserId(payload.userId);
+        if (payload.userId) {
+          _this.setUserId(payload.userId);
+        }
         _this.sendPresence();
         _this.sendPresenceJoined();
       } catch (error) {

package/dist/esm/provider/index.js

@@ -188,7 +188,11 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
       }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
         _this.permit = Object.assign(_this.permit, permit);
         _this.emit('permission', permit);
-      }).on('steps:added', _this.documentService.onStepsAdded).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
+      }).on('steps:added', _this.documentService.onStepsAdded).on('recovery:required', function (payload) {
+        if (typeof (payload === null || payload === void 0 ? void 0 : payload.reason) === 'string') {
+          _this.emit('recovery:required', payload);
+        }
+      }).on('metadata:changed', _this.metadataService.onMetadataChanged).on('participant:telepointer', function (payload) {
         return _this.participantsService.onParticipantTelepointer(payload, _this.sessionId);
       }).on('presence:joined', _this.participantsService.onPresenceJoined).on('presence', _this.participantsService.onPresence).on('participant:left', _this.participantsService.onParticipantLeft).on('participant:updated', _this.participantsService.onParticipantUpdated).on('disconnect', _this.onDisconnected.bind(_this)).on('error', _this.onErrorHandled).on('status', /*#__PURE__*/function () {
         var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(status) {
@@ -438,6 +442,7 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
     _this.channel = new Channel(config, _this.analyticsHelper);
     _this.isChannelInitialized = false;
     _this.initialDraft = _this.config.initialDraft;
+    _this.userId = _this.config.userId;
     _this.isBufferingEnabled = Boolean(_this.config.isBufferingEnabled);
     _this.isProviderInitialized = false;
     _this.participantsService = new ParticipantsService(_this.analyticsHelper, undefined, _this.emitCallback, _this.config.getUser, _this.config.batchProps, _this.channel.broadcast, _this.channel.sendPresenceJoined, _this.getPresenceData, _this.setUserId, _this.getAIProviderActiveIds, _this.config.fetchAnonymousAsset);

package/dist/esm/version-wrapper.js

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

package/dist/types/document/document-service.d.ts

@@ -104,10 +104,12 @@ export declare class DocumentService implements DocumentServiceInterface {
      * milestone independently — the milestone attributes its own local steps, which are echoed back
      * to this client, so it needs the facepile without the backend streaming visuals.
      *
+     * When agent edit presence is enabled, the canonical presence channel owns agent participants.
+     * Skip this step-derived fallback entirely in that cohort to avoid duplicate or stale participants.
+     *
      * The milestone value is read without logging an exposure: this runs on every received step
      * batch, whereas the canonical exposure is logged at the action-driven call sites that decide
-     * whether to attribute a step. The backend experiment is evaluated first so its exposure
-     * population is unchanged.
+     * whether to attribute a step.
      *
      * Known limitation (PoC): steps replayed via catch-up/reconnect can briefly re-surface an agent
      * whose activity is stale — a freshness guard is a follow-up.

package/dist/types/types.d.ts

@@ -5,7 +5,7 @@ import type { InternalError } from './errors/internal-errors';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer/types';
 import type { BatchProps, GetUserType } from './participants/participants-helper';
 import type AnalyticsHelper from './analytics/analytics-helper';
-import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, PresenceActivity } from '@atlaskit/editor-common/collab';
+import type { StepJson, CollabSendableSelection, Metadata, UserPermitType, PresenceActivity, CollabRecoveryRequiredPayload } from '@atlaskit/editor-common/collab';
 import type { CatchupEventReason } from './helpers/const';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 export interface CollabEventDisconnectedData {
@@ -86,6 +86,8 @@ export interface Config {
      * multiple websocket connections, the presenceId is used to correlate the two.
      */
     presenceId?: string;
+    /** The authenticated account ID used to attribute locally committed steps. */
+    userId?: string;
     productInfo?: ProductInformation;
     /**
      * Configure the client side circuit breaker in the event that abnormal behaviour causes the client to flood
@@ -242,6 +244,7 @@ export type ChannelEvent = {
     presence: PresencePayload;
     'presence:joined': PresencePayload;
     reconnected: null;
+    'recovery:required': CollabRecoveryRequiredPayload;
     restore: InitPayload;
     status: NamespaceStatus;
     'steps:added': StepsPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "28.0.0",
+	"version": "28.2.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -20,7 +20,7 @@
 	"dependencies": {
 		"@atlaskit/adf-utils": "^20.9.0",
 		"@atlaskit/analytics-gas-types": "^6.2.0",
-		"@atlaskit/analytics-listeners": "^11.3.0",
+		"@atlaskit/analytics-listeners": "^11.4.0",
 		"@atlaskit/anonymous-assets": "^2.9.0",
 		"@atlaskit/atlassian-context": "^1.2.0",
 		"@atlaskit/editor-json-transformer": "^9.8.0",
@@ -29,8 +29,8 @@
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/prosemirror-collab": "^1.1.0",
-		"@atlaskit/react-ufo": "^7.12.0",
-		"@atlaskit/tmp-editor-statsig": "^199.0.0",
+		"@atlaskit/react-ufo": "^7.13.0",
+		"@atlaskit/tmp-editor-statsig": "^200.0.0",
 		"@atlaskit/ufo": "^1.2.0",
 		"@atlaskit/util-service-support": "^7.4.0",
 		"@babel/runtime": "^7.0.0",
@@ -57,6 +57,10 @@
 			"type": "boolean",
 			"referenceOnly": true
 		},
+		"platform_editor_agent_edit_presence": {
+			"type": "boolean",
+			"referenceOnly": true
+		},
 		"platform_editor_agentic_step_attribution": {
 			"type": "boolean"
 		},
@@ -71,6 +75,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^123.0.0"
+		"@atlaskit/editor-common": "^123.1.0"
 	}
 }