@atlaskit/collab-provider 11.2.2 → 11.2.4

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 (15) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/dist/cjs/document/document-service.js +8 -5
  3. package/dist/cjs/provider/index.js +10 -5
  4. package/dist/cjs/version-wrapper.js +1 -1
  5. package/dist/es2019/document/document-service.js +8 -5
  6. package/dist/es2019/provider/index.js +10 -5
  7. package/dist/es2019/version-wrapper.js +1 -1
  8. package/dist/esm/document/document-service.js +8 -5
  9. package/dist/esm/provider/index.js +10 -5
  10. package/dist/esm/version-wrapper.js +1 -1
  11. package/dist/types/document/document-service.d.ts +1 -1
  12. package/dist/types/helpers/const.d.ts +1 -0
  13. package/dist/types-ts4.5/document/document-service.d.ts +1 -1
  14. package/dist/types-ts4.5/helpers/const.d.ts +1 -0
  15. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # @atlaskit/collab-provider
2
2
 
3
+ ## 11.2.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`4c8b9cd44cb83`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4c8b9cd44cb83) -
8
+ HOT-119930: added a caller param to updateDocumentAnalytics, to allow further investigation into
9
+ thecause of failed updates for HOT-119930
10
+ - Updated dependencies
11
+
12
+ ## 11.2.3
13
+
14
+ ### Patch Changes
15
+
16
+ - Updated dependencies
17
+
3
18
  ## 11.2.2
4
19
 
5
20
  ### Patch Changes
package/dist/cjs/document/document-service.js CHANGED
@@ -395,7 +395,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
395
395
  doc: doc,
396
396
  version: version,
397
397
  metadata: metadata,
398
- reserveCursor: true
398
+ reserveCursor: true,
399
+ caller: 'onRestore'
399
400
  });
400
401
  _this.metadataService.updateMetadata(metadata);
401
402
  _context3.prev = 13;
@@ -573,7 +574,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
573
574
  var doc = _ref9.doc,
574
575
  version = _ref9.version,
575
576
  metadata = _ref9.metadata,
576
- reserveCursor = _ref9.reserveCursor;
577
+ reserveCursor = _ref9.reserveCursor,
578
+ caller = _ref9.caller;
577
579
  _this.providerEmitCallback('init', _objectSpread({
578
580
  doc: doc,
579
581
  version: version,
@@ -581,11 +583,11 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
581
583
  }, reserveCursor ? {
582
584
  reserveCursor: reserveCursor
583
585
  } : {}));
584
- _this.updateDocumentAnalytics(doc, version);
586
+ _this.updateDocumentAnalytics(doc, version, caller);
585
587
  });
586
588
  // Ignored via go/ees005
587
589
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
588
- (0, _defineProperty2.default)(this, "updateDocumentAnalytics", function (doc, version) {
590
+ (0, _defineProperty2.default)(this, "updateDocumentAnalytics", function (doc, version, caller) {
589
591
  var updatedVersion = _this.getCurrentPmVersion();
590
592
  var isDocContentValid = _this.validatePMJSONDocument(doc);
591
593
  // ESS-5023: only emit error event if updated client version is still behind server version
@@ -597,7 +599,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
597
599
  editorVersion: updatedVersion,
598
600
  isDocTruthy: !!doc,
599
601
  docHasContent: (doc === null || doc === void 0 || (_doc$content = doc.content) === null || _doc$content === void 0 ? void 0 : _doc$content.length) >= 1,
600
- isDocContentValid: isDocContentValid
602
+ isDocContentValid: isDocContentValid,
603
+ caller: caller
601
604
  });
602
605
  (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 || _this$analyticsHelper22.sendErrorEvent(error, 'Failed to update the document in document service');
603
606
  if (_this.enableErrorOnFailedDocumentApply) {
package/dist/cjs/provider/index.js CHANGED
@@ -85,12 +85,14 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
85
85
  (0, _defineProperty2.default)(_this, "updateDocumentAndMetadata", function (_ref) {
86
86
  var doc = _ref.doc,
87
87
  version = _ref.version,
88
- metadata = _ref.metadata;
88
+ metadata = _ref.metadata,
89
+ caller = _ref.caller;
89
90
  try {
90
91
  _this.documentService.updateDocument({
91
92
  doc: doc,
92
93
  version: version,
93
- metadata: metadata
94
+ metadata: metadata,
95
+ caller: caller
94
96
  });
95
97
  _this.metadataService.updateMetadata(metadata);
96
98
  _this.isProviderInitialized = true;
@@ -134,7 +136,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
134
136
  _this.updateDocumentAndMetadata({
135
137
  doc: document,
136
138
  version: version,
137
- metadata: metadata
139
+ metadata: metadata,
140
+ caller: 'connectedHandler'
138
141
  });
139
142
  }
140
143
  // If already initialized, `connected` means reconnected
@@ -162,7 +165,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
162
165
  _this.updateDocumentAndMetadata({
163
166
  doc: doc,
164
167
  version: version,
165
- metadata: metadata
168
+ metadata: metadata,
169
+ caller: 'initHandler'
166
170
  });
167
171
  }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
168
172
  _this.permit = Object.assign(_this.permit, permit);
@@ -476,7 +480,8 @@ var Provider = exports.Provider = /*#__PURE__*/function (_Emitter) {
476
480
  this.updateDocumentAndMetadata({
477
481
  doc: document,
478
482
  version: version,
479
- metadata: metadata
483
+ metadata: metadata,
484
+ caller: 'Provider.setup'
480
485
  });
481
486
  (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 || _this$analyticsHelper6.sendActionEvent(_const.EVENT_ACTION.PROVIDER_INITIALIZED, _const.EVENT_STATUS.INFO, {
482
487
  isBuffered: true
package/dist/cjs/version-wrapper.js CHANGED
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.version = exports.nextMajorVersion = exports.name = void 0;
7
7
  var name = exports.name = "@atlaskit/collab-provider";
8
- var version = exports.version = "11.2.1";
8
+ var version = exports.version = "11.2.3";
9
9
  var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
10
10
  return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
11
11
  };
package/dist/es2019/document/document-service.js CHANGED
@@ -359,7 +359,8 @@ export class DocumentService {
359
359
  doc,
360
360
  version,
361
361
  metadata,
362
- reserveCursor: true
362
+ reserveCursor: true,
363
+ caller: 'onRestore'
363
364
  });
364
365
  this.metadataService.updateMetadata(metadata);
365
366
  try {
@@ -492,7 +493,8 @@ export class DocumentService {
492
493
  doc,
493
494
  version,
494
495
  metadata,
495
- reserveCursor
496
+ reserveCursor,
497
+ caller
496
498
  }) => {
497
499
  this.providerEmitCallback('init', {
498
500
  doc,
@@ -502,11 +504,11 @@ export class DocumentService {
502
504
  reserveCursor
503
505
  } : {})
504
506
  });
505
- this.updateDocumentAnalytics(doc, version);
507
+ this.updateDocumentAnalytics(doc, version, caller);
506
508
  });
507
509
  // Ignored via go/ees005
508
510
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
509
- _defineProperty(this, "updateDocumentAnalytics", (doc, version) => {
511
+ _defineProperty(this, "updateDocumentAnalytics", (doc, version, caller) => {
510
512
  const updatedVersion = this.getCurrentPmVersion();
511
513
  const isDocContentValid = this.validatePMJSONDocument(doc);
512
514
  // ESS-5023: only emit error event if updated client version is still behind server version
@@ -518,7 +520,8 @@ export class DocumentService {
518
520
  editorVersion: updatedVersion,
519
521
  isDocTruthy: !!doc,
520
522
  docHasContent: (doc === null || doc === void 0 ? void 0 : (_doc$content = doc.content) === null || _doc$content === void 0 ? void 0 : _doc$content.length) >= 1,
521
- isDocContentValid
523
+ isDocContentValid,
524
+ caller
522
525
  });
523
526
  (_this$analyticsHelper22 = this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 ? void 0 : _this$analyticsHelper22.sendErrorEvent(error, 'Failed to update the document in document service');
524
527
  if (this.enableErrorOnFailedDocumentApply) {
package/dist/es2019/provider/index.js CHANGED
@@ -61,13 +61,15 @@ export class Provider extends Emitter {
61
61
  _defineProperty(this, "updateDocumentAndMetadata", ({
62
62
  doc,
63
63
  version,
64
- metadata
64
+ metadata,
65
+ caller
65
66
  }) => {
66
67
  try {
67
68
  this.documentService.updateDocument({
68
69
  doc,
69
70
  version,
70
- metadata
71
+ metadata,
72
+ caller
71
73
  });
72
74
  this.metadataService.updateMetadata(metadata);
73
75
  this.isProviderInitialized = true;
@@ -113,7 +115,8 @@ export class Provider extends Emitter {
113
115
  this.updateDocumentAndMetadata({
114
116
  doc: document,
115
117
  version,
116
- metadata
118
+ metadata,
119
+ caller: 'connectedHandler'
117
120
  });
118
121
  }
119
122
  // If already initialized, `connected` means reconnected
@@ -142,7 +145,8 @@ export class Provider extends Emitter {
142
145
  this.updateDocumentAndMetadata({
143
146
  doc,
144
147
  version,
145
- metadata
148
+ metadata,
149
+ caller: 'initHandler'
146
150
  });
147
151
  }).on('restore', this.documentService.onRestore).on('permission', permit => {
148
152
  this.permit = Object.assign(this.permit, permit);
@@ -383,7 +387,8 @@ export class Provider extends Emitter {
383
387
  this.updateDocumentAndMetadata({
384
388
  doc: document,
385
389
  version,
386
- metadata
390
+ metadata,
391
+ caller: 'Provider.setup'
387
392
  });
388
393
  (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 ? void 0 : _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.PROVIDER_INITIALIZED, EVENT_STATUS.INFO, {
389
394
  isBuffered: true
package/dist/es2019/version-wrapper.js CHANGED
@@ -1,5 +1,5 @@
1
1
  export const name = "@atlaskit/collab-provider";
2
- export const version = "11.2.1";
2
+ export const version = "11.2.3";
3
3
  export const nextMajorVersion = () => {
4
4
  return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
5
5
  };
package/dist/esm/document/document-service.js CHANGED
@@ -388,7 +388,8 @@ export var DocumentService = /*#__PURE__*/function () {
388
388
  doc: doc,
389
389
  version: version,
390
390
  metadata: metadata,
391
- reserveCursor: true
391
+ reserveCursor: true,
392
+ caller: 'onRestore'
392
393
  });
393
394
  _this.metadataService.updateMetadata(metadata);
394
395
  _context3.prev = 13;
@@ -566,7 +567,8 @@ export var DocumentService = /*#__PURE__*/function () {
566
567
  var doc = _ref9.doc,
567
568
  version = _ref9.version,
568
569
  metadata = _ref9.metadata,
569
- reserveCursor = _ref9.reserveCursor;
570
+ reserveCursor = _ref9.reserveCursor,
571
+ caller = _ref9.caller;
570
572
  _this.providerEmitCallback('init', _objectSpread({
571
573
  doc: doc,
572
574
  version: version,
@@ -574,11 +576,11 @@ export var DocumentService = /*#__PURE__*/function () {
574
576
  }, reserveCursor ? {
575
577
  reserveCursor: reserveCursor
576
578
  } : {}));
577
- _this.updateDocumentAnalytics(doc, version);
579
+ _this.updateDocumentAnalytics(doc, version, caller);
578
580
  });
579
581
  // Ignored via go/ees005
580
582
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
581
- _defineProperty(this, "updateDocumentAnalytics", function (doc, version) {
583
+ _defineProperty(this, "updateDocumentAnalytics", function (doc, version, caller) {
582
584
  var updatedVersion = _this.getCurrentPmVersion();
583
585
  var isDocContentValid = _this.validatePMJSONDocument(doc);
584
586
  // ESS-5023: only emit error event if updated client version is still behind server version
@@ -590,7 +592,8 @@ export var DocumentService = /*#__PURE__*/function () {
590
592
  editorVersion: updatedVersion,
591
593
  isDocTruthy: !!doc,
592
594
  docHasContent: (doc === null || doc === void 0 || (_doc$content = doc.content) === null || _doc$content === void 0 ? void 0 : _doc$content.length) >= 1,
593
- isDocContentValid: isDocContentValid
595
+ isDocContentValid: isDocContentValid,
596
+ caller: caller
594
597
  });
595
598
  (_this$analyticsHelper22 = _this.analyticsHelper) === null || _this$analyticsHelper22 === void 0 || _this$analyticsHelper22.sendErrorEvent(error, 'Failed to update the document in document service');
596
599
  if (_this.enableErrorOnFailedDocumentApply) {
package/dist/esm/provider/index.js CHANGED
@@ -78,12 +78,14 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
78
78
  _defineProperty(_this, "updateDocumentAndMetadata", function (_ref) {
79
79
  var doc = _ref.doc,
80
80
  version = _ref.version,
81
- metadata = _ref.metadata;
81
+ metadata = _ref.metadata,
82
+ caller = _ref.caller;
82
83
  try {
83
84
  _this.documentService.updateDocument({
84
85
  doc: doc,
85
86
  version: version,
86
- metadata: metadata
87
+ metadata: metadata,
88
+ caller: caller
87
89
  });
88
90
  _this.metadataService.updateMetadata(metadata);
89
91
  _this.isProviderInitialized = true;
@@ -127,7 +129,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
127
129
  _this.updateDocumentAndMetadata({
128
130
  doc: document,
129
131
  version: version,
130
- metadata: metadata
132
+ metadata: metadata,
133
+ caller: 'connectedHandler'
131
134
  });
132
135
  }
133
136
  // If already initialized, `connected` means reconnected
@@ -155,7 +158,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
155
158
  _this.updateDocumentAndMetadata({
156
159
  doc: doc,
157
160
  version: version,
158
- metadata: metadata
161
+ metadata: metadata,
162
+ caller: 'initHandler'
159
163
  });
160
164
  }).on('restore', _this.documentService.onRestore).on('permission', function (permit) {
161
165
  _this.permit = Object.assign(_this.permit, permit);
@@ -469,7 +473,8 @@ export var Provider = /*#__PURE__*/function (_Emitter) {
469
473
  this.updateDocumentAndMetadata({
470
474
  doc: document,
471
475
  version: version,
472
- metadata: metadata
476
+ metadata: metadata,
477
+ caller: 'Provider.setup'
473
478
  });
474
479
  (_this$analyticsHelper6 = this.analyticsHelper) === null || _this$analyticsHelper6 === void 0 || _this$analyticsHelper6.sendActionEvent(EVENT_ACTION.PROVIDER_INITIALIZED, EVENT_STATUS.INFO, {
475
480
  isBuffered: true
package/dist/esm/version-wrapper.js CHANGED
@@ -1,5 +1,5 @@
1
1
  export var name = "@atlaskit/collab-provider";
2
- export var version = "11.2.1";
2
+ export var version = "11.2.3";
3
3
  export var nextMajorVersion = function nextMajorVersion() {
4
4
  return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
5
5
  };
package/dist/types/document/document-service.d.ts CHANGED
@@ -136,7 +136,7 @@ export declare class DocumentService implements DocumentServiceInterface {
136
136
  * @example
137
137
  */
138
138
  getIsNamespaceLocked(): boolean;
139
- updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
139
+ updateDocument: ({ doc, version, metadata, reserveCursor, caller }: CollabInitPayload) => void;
140
140
  private updateDocumentAnalytics;
141
141
  private validatePMJSONDocument;
142
142
  /**
package/dist/types/helpers/const.d.ts CHANGED
@@ -42,6 +42,7 @@ export type DocumentUpdateErrorAttributes = {
42
42
  newVersion?: number;
43
43
  docHasContent?: boolean;
44
44
  isDocContentValid?: boolean;
45
+ caller?: string;
45
46
  };
46
47
  export type CantSyncUpErrorAttributes = {
47
48
  unconfirmedStepsInfo: string;
package/dist/types-ts4.5/document/document-service.d.ts CHANGED
@@ -136,7 +136,7 @@ export declare class DocumentService implements DocumentServiceInterface {
136
136
  * @example
137
137
  */
138
138
  getIsNamespaceLocked(): boolean;
139
- updateDocument: ({ doc, version, metadata, reserveCursor }: CollabInitPayload) => void;
139
+ updateDocument: ({ doc, version, metadata, reserveCursor, caller }: CollabInitPayload) => void;
140
140
  private updateDocumentAnalytics;
141
141
  private validatePMJSONDocument;
142
142
  /**
package/dist/types-ts4.5/helpers/const.d.ts CHANGED
@@ -42,6 +42,7 @@ export type DocumentUpdateErrorAttributes = {
42
42
  newVersion?: number;
43
43
  docHasContent?: boolean;
44
44
  isDocContentValid?: boolean;
45
+ caller?: string;
45
46
  };
46
47
  export type CantSyncUpErrorAttributes = {
47
48
  unconfirmedStepsInfo: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/collab-provider",
3
- "version": "11.2.2",
3
+ "version": "11.2.4",
4
4
  "description": "A provider for collaborative editing.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -41,8 +41,8 @@
41
41
  "@atlaskit/feature-gate-js-client": "^5.5.0",
42
42
  "@atlaskit/platform-feature-flags": "^1.1.0",
43
43
  "@atlaskit/prosemirror-collab": "^0.17.0",
44
- "@atlaskit/react-ufo": "^4.3.0",
45
- "@atlaskit/tmp-editor-statsig": "^10.0.0",
44
+ "@atlaskit/react-ufo": "^4.4.0",
45
+ "@atlaskit/tmp-editor-statsig": "^11.3.0",
46
46
  "@atlaskit/ufo": "^0.4.0",
47
47
  "@atlaskit/util-service-support": "^6.3.0",
48
48
  "@babel/runtime": "^7.0.0",