@atlaskit/renderer 125.0.2 → 125.1.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 (10) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist/cjs/react/nodes/table/sticky.js +0 -2
  3. package/dist/cjs/ui/Renderer/index.js +10 -3
  4. package/dist/es2019/react/nodes/table/sticky.js +4 -2
  5. package/dist/es2019/ui/Renderer/index.js +11 -3
  6. package/dist/esm/react/nodes/table/sticky.js +0 -2
  7. package/dist/esm/ui/Renderer/index.js +10 -3
  8. package/dist/types/analytics/events.d.ts +9 -1
  9. package/dist/types-ts4.5/analytics/events.d.ts +9 -1
  10. package/package.json +7 -7
package/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # @atlaskit/renderer
2
2
 
3
+ ## 125.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`e8f5c745198b6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e8f5c745198b6) -
8
+ add sampled "renderer rendered" event
9
+
10
+ ### Patch Changes
11
+
12
+ - Updated dependencies
13
+
3
14
  ## 125.0.2
4
15
 
5
16
  ### Patch Changes
package/dist/cjs/react/nodes/table/sticky.js CHANGED
@@ -257,7 +257,6 @@ var OverflowParent = exports.OverflowParent = /*#__PURE__*/function () {
257
257
  * @example
258
258
  */
259
259
  // Ignored via go/ees005
260
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
261
260
  }, {
262
261
  key: "addEventListener",
263
262
  value: function addEventListener(type, cb) {
@@ -278,7 +277,6 @@ var OverflowParent = exports.OverflowParent = /*#__PURE__*/function () {
278
277
  * @example
279
278
  */
280
279
  // Ignored via go/ees005
281
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
282
280
  }, {
283
281
  key: "removeEventListener",
284
282
  value: function removeEventListener(type, cb) {
package/dist/cjs/ui/Renderer/index.js CHANGED
@@ -68,8 +68,9 @@ var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
68
68
 
69
69
  // we want to calculate all the table widths (which causes reflows) after the renderer has finished loading to mitigate performance impact
70
70
  var TABLE_INFO_TIMEOUT = 10000;
71
+ var RENDER_EVENT_SAMPLE_RATE = 0.2;
71
72
  var packageName = "@atlaskit/renderer";
72
- var packageVersion = "0.0.0-development";
73
+ var packageVersion = "125.0.2";
73
74
  var setAsQueryContainerStyles = (0, _react2.css)({
74
75
  containerName: 'ak-renderer-wrapper',
75
76
  containerType: 'inline-size'
@@ -348,7 +349,7 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
348
349
  var severity = !!forceSeverityTracking || analyticsEventSeverityTracking !== null && analyticsEventSeverityTracking !== void 0 && analyticsEventSeverityTracking.enabled ? (0, _utils.getAnalyticsEventSeverity)(duration, (_analyticsEventSeveri = analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.severityNormalThreshold) !== null && _analyticsEventSeveri !== void 0 ? _analyticsEventSeveri : NORMAL_SEVERITY_THRESHOLD, (_analyticsEventSeveri2 = analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.severityDegradedThreshold) !== null && _analyticsEventSeveri2 !== void 0 ? _analyticsEventSeveri2 : DEGRADED_SEVERITY_THRESHOLD) : undefined;
349
350
  var isTTRTrackingExplicitlyDisabled = (analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.enabled) === false;
350
351
  if (!isTTRTrackingExplicitlyDisabled) {
351
- _fireAnalyticsEvent({
352
+ var event = {
352
353
  action: _analytics.ACTION.RENDERED,
353
354
  actionSubject: _analytics.ACTION_SUBJECT.RENDERER,
354
355
  attributes: {
@@ -362,7 +363,13 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
362
363
  severity: severity
363
364
  },
364
365
  eventType: _analytics.EVENT_TYPE.OPERATIONAL
365
- });
366
+ };
367
+ _fireAnalyticsEvent(event);
368
+ if ((0, _expValEquals.expValEquals)('platform_editor_sample_renderer_rendered_event', 'isEnabled', true) && Math.random() < RENDER_EVENT_SAMPLE_RATE) {
369
+ _fireAnalyticsEvent(_objectSpread(_objectSpread({}, event), {}, {
370
+ action: _analytics.ACTION.RENDERED_SAMPLED
371
+ }));
372
+ }
366
373
  }
367
374
 
368
375
  // Ignored via go/ees005
package/dist/es2019/react/nodes/table/sticky.js CHANGED
@@ -254,8 +254,9 @@ export class OverflowParent {
254
254
  * @example
255
255
  */
256
256
  // Ignored via go/ees005
257
+ addEventListener(type, cb,
257
258
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
258
- addEventListener(type, cb, ...args) {
259
+ ...args) {
259
260
  // Ignored via go/ees005
260
261
  // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
261
262
  this.ref.addEventListener(type, cb, ...args);
@@ -269,8 +270,9 @@ export class OverflowParent {
269
270
  * @example
270
271
  */
271
272
  // Ignored via go/ees005
273
+ removeEventListener(type, cb,
272
274
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
273
- removeEventListener(type, cb, ...args) {
275
+ ...args) {
274
276
  // Ignored via go/ees005
275
277
  // eslint-disable-next-line @repo/internal/dom-events/no-unsafe-event-listeners
276
278
  this.ref.removeEventListener(type, cb, ...args);
package/dist/es2019/ui/Renderer/index.js CHANGED
@@ -54,8 +54,9 @@ export const DEGRADED_SEVERITY_THRESHOLD = 3000;
54
54
 
55
55
  // we want to calculate all the table widths (which causes reflows) after the renderer has finished loading to mitigate performance impact
56
56
  const TABLE_INFO_TIMEOUT = 10000;
57
+ const RENDER_EVENT_SAMPLE_RATE = 0.2;
57
58
  const packageName = "@atlaskit/renderer";
58
- const packageVersion = "0.0.0-development";
59
+ const packageVersion = "125.0.2";
59
60
  const setAsQueryContainerStyles = css({
60
61
  containerName: 'ak-renderer-wrapper',
61
62
  containerType: 'inline-size'
@@ -340,7 +341,7 @@ export const RendererFunctionalComponent = props => {
340
341
  const severity = !!forceSeverityTracking || analyticsEventSeverityTracking !== null && analyticsEventSeverityTracking !== void 0 && analyticsEventSeverityTracking.enabled ? getAnalyticsEventSeverity(duration, (_analyticsEventSeveri = analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.severityNormalThreshold) !== null && _analyticsEventSeveri !== void 0 ? _analyticsEventSeveri : NORMAL_SEVERITY_THRESHOLD, (_analyticsEventSeveri2 = analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.severityDegradedThreshold) !== null && _analyticsEventSeveri2 !== void 0 ? _analyticsEventSeveri2 : DEGRADED_SEVERITY_THRESHOLD) : undefined;
341
342
  const isTTRTrackingExplicitlyDisabled = (analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.enabled) === false;
342
343
  if (!isTTRTrackingExplicitlyDisabled) {
343
- fireAnalyticsEvent({
344
+ const event = {
344
345
  action: ACTION.RENDERED,
345
346
  actionSubject: ACTION_SUBJECT.RENDERER,
346
347
  attributes: {
@@ -354,7 +355,14 @@ export const RendererFunctionalComponent = props => {
354
355
  severity
355
356
  },
356
357
  eventType: EVENT_TYPE.OPERATIONAL
357
- });
358
+ };
359
+ fireAnalyticsEvent(event);
360
+ if (expValEquals('platform_editor_sample_renderer_rendered_event', 'isEnabled', true) && Math.random() < RENDER_EVENT_SAMPLE_RATE) {
361
+ fireAnalyticsEvent({
362
+ ...event,
363
+ action: ACTION.RENDERED_SAMPLED
364
+ });
365
+ }
358
366
  }
359
367
 
360
368
  // Ignored via go/ees005
package/dist/esm/react/nodes/table/sticky.js CHANGED
@@ -248,7 +248,6 @@ export var OverflowParent = /*#__PURE__*/function () {
248
248
  * @example
249
249
  */
250
250
  // Ignored via go/ees005
251
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
252
251
  }, {
253
252
  key: "addEventListener",
254
253
  value: function addEventListener(type, cb) {
@@ -269,7 +268,6 @@ export var OverflowParent = /*#__PURE__*/function () {
269
268
  * @example
270
269
  */
271
270
  // Ignored via go/ees005
272
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
273
271
  }, {
274
272
  key: "removeEventListener",
275
273
  value: function removeEventListener(type, cb) {
package/dist/esm/ui/Renderer/index.js CHANGED
@@ -59,8 +59,9 @@ export var DEGRADED_SEVERITY_THRESHOLD = 3000;
59
59
 
60
60
  // we want to calculate all the table widths (which causes reflows) after the renderer has finished loading to mitigate performance impact
61
61
  var TABLE_INFO_TIMEOUT = 10000;
62
+ var RENDER_EVENT_SAMPLE_RATE = 0.2;
62
63
  var packageName = "@atlaskit/renderer";
63
- var packageVersion = "0.0.0-development";
64
+ var packageVersion = "125.0.2";
64
65
  var setAsQueryContainerStyles = css({
65
66
  containerName: 'ak-renderer-wrapper',
66
67
  containerType: 'inline-size'
@@ -339,7 +340,7 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
339
340
  var severity = !!forceSeverityTracking || analyticsEventSeverityTracking !== null && analyticsEventSeverityTracking !== void 0 && analyticsEventSeverityTracking.enabled ? getAnalyticsEventSeverity(duration, (_analyticsEventSeveri = analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.severityNormalThreshold) !== null && _analyticsEventSeveri !== void 0 ? _analyticsEventSeveri : NORMAL_SEVERITY_THRESHOLD, (_analyticsEventSeveri2 = analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.severityDegradedThreshold) !== null && _analyticsEventSeveri2 !== void 0 ? _analyticsEventSeveri2 : DEGRADED_SEVERITY_THRESHOLD) : undefined;
340
341
  var isTTRTrackingExplicitlyDisabled = (analyticsEventSeverityTracking === null || analyticsEventSeverityTracking === void 0 ? void 0 : analyticsEventSeverityTracking.enabled) === false;
341
342
  if (!isTTRTrackingExplicitlyDisabled) {
342
- _fireAnalyticsEvent({
343
+ var event = {
343
344
  action: ACTION.RENDERED,
344
345
  actionSubject: ACTION_SUBJECT.RENDERER,
345
346
  attributes: {
@@ -353,7 +354,13 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
353
354
  severity: severity
354
355
  },
355
356
  eventType: EVENT_TYPE.OPERATIONAL
356
- });
357
+ };
358
+ _fireAnalyticsEvent(event);
359
+ if (expValEquals('platform_editor_sample_renderer_rendered_event', 'isEnabled', true) && Math.random() < RENDER_EVENT_SAMPLE_RATE) {
360
+ _fireAnalyticsEvent(_objectSpread(_objectSpread({}, event), {}, {
361
+ action: ACTION.RENDERED_SAMPLED
362
+ }));
363
+ }
357
364
  }
358
365
 
359
366
  // Ignored via go/ees005
package/dist/types/analytics/events.d.ts CHANGED
@@ -23,6 +23,14 @@ type RendererRenderedAEP = AEP<ACTION.RENDERED, ACTION_SUBJECT.RENDERER, undefin
23
23
  severity?: SEVERITY;
24
24
  ttfb?: number;
25
25
  }, EVENT_TYPE.OPERATIONAL>;
26
+ type RendererRenderedSampledAEP = AEP<ACTION.RENDERED_SAMPLED, ACTION_SUBJECT.RENDERER, undefined, {
27
+ distortedDuration: boolean;
28
+ duration: number;
29
+ nodes: Record<string, number>;
30
+ platform: PLATFORM.WEB;
31
+ severity?: SEVERITY;
32
+ ttfb?: number;
33
+ }, EVENT_TYPE.OPERATIONAL>;
26
34
  export type ComponentCrashErrorAEP = OperationalAEP<ACTION.CRASHED, ACTION_SUBJECT.RENDERER, ACTION_SUBJECT_ID, {
27
35
  componentStack?: string;
28
36
  errorMessage?: string;
@@ -151,6 +159,6 @@ type SyncedBlockGetSourceInfoErrorAEP = OperationalAEP<ACTION.ERROR, ACTION_SUBJ
151
159
  type ReferenceSyncedBlockUpdateErrorAEP = OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, {
152
160
  error: string;
153
161
  }>;
154
- export type AnalyticsEventPayload<_T = void> = RendererStartAEP | RendererRenderedAEP | ComponentCrashErrorAEP | RendererUnsupportedContentLevelsTrackingSucceeded | RendererUnsupportedContentLevelsTrackingErrored | RendererSelectAllCaughtAEP | RendererSelectAllEscapedAEP | CodeBlockCopyAEP | CodeBlockWrapAEP | HeadingAnchorLinkButtonAEP | HoverLabelAEP | AnchorLinkAEP | TableSortColumnNotAllowedAEP | TableSortColumnAEP | TableWidthInfoAEP | TableRendererHeightInfoAEP | VisitLinkAEP | VisitMediaLinkAEP | ExpandAEP | UnsupportedContentPayload | UnsupportedContentTooltipPayload | AnnotationAEP | AnnotationDeleteAEP | MediaLnkTransformedAEP | InvalidProsemirrorDocumentErrorAEP | NestedTableTransformedAEP | MediaRenderErrorEvent | SyncedBlockFetchErrorAEP | SyncedBlockGetSourceInfoErrorAEP | ReferenceSyncedBlockUpdateErrorAEP;
162
+ export type AnalyticsEventPayload<_T = void> = RendererStartAEP | RendererRenderedAEP | RendererRenderedSampledAEP | ComponentCrashErrorAEP | RendererUnsupportedContentLevelsTrackingSucceeded | RendererUnsupportedContentLevelsTrackingErrored | RendererSelectAllCaughtAEP | RendererSelectAllEscapedAEP | CodeBlockCopyAEP | CodeBlockWrapAEP | HeadingAnchorLinkButtonAEP | HoverLabelAEP | AnchorLinkAEP | TableSortColumnNotAllowedAEP | TableSortColumnAEP | TableWidthInfoAEP | TableRendererHeightInfoAEP | VisitLinkAEP | VisitMediaLinkAEP | ExpandAEP | UnsupportedContentPayload | UnsupportedContentTooltipPayload | AnnotationAEP | AnnotationDeleteAEP | MediaLnkTransformedAEP | InvalidProsemirrorDocumentErrorAEP | NestedTableTransformedAEP | MediaRenderErrorEvent | SyncedBlockFetchErrorAEP | SyncedBlockGetSourceInfoErrorAEP | ReferenceSyncedBlockUpdateErrorAEP;
155
163
  export type FireAnalyticsCallback = <T = void>(payload: AnalyticsEventPayload<T>) => void | undefined;
156
164
  export {};
package/dist/types-ts4.5/analytics/events.d.ts CHANGED
@@ -23,6 +23,14 @@ type RendererRenderedAEP = AEP<ACTION.RENDERED, ACTION_SUBJECT.RENDERER, undefin
23
23
  severity?: SEVERITY;
24
24
  ttfb?: number;
25
25
  }, EVENT_TYPE.OPERATIONAL>;
26
+ type RendererRenderedSampledAEP = AEP<ACTION.RENDERED_SAMPLED, ACTION_SUBJECT.RENDERER, undefined, {
27
+ distortedDuration: boolean;
28
+ duration: number;
29
+ nodes: Record<string, number>;
30
+ platform: PLATFORM.WEB;
31
+ severity?: SEVERITY;
32
+ ttfb?: number;
33
+ }, EVENT_TYPE.OPERATIONAL>;
26
34
  export type ComponentCrashErrorAEP = OperationalAEP<ACTION.CRASHED, ACTION_SUBJECT.RENDERER, ACTION_SUBJECT_ID, {
27
35
  componentStack?: string;
28
36
  errorMessage?: string;
@@ -151,6 +159,6 @@ type SyncedBlockGetSourceInfoErrorAEP = OperationalAEP<ACTION.ERROR, ACTION_SUBJ
151
159
  type ReferenceSyncedBlockUpdateErrorAEP = OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, {
152
160
  error: string;
153
161
  }>;
154
- export type AnalyticsEventPayload<_T = void> = RendererStartAEP | RendererRenderedAEP | ComponentCrashErrorAEP | RendererUnsupportedContentLevelsTrackingSucceeded | RendererUnsupportedContentLevelsTrackingErrored | RendererSelectAllCaughtAEP | RendererSelectAllEscapedAEP | CodeBlockCopyAEP | CodeBlockWrapAEP | HeadingAnchorLinkButtonAEP | HoverLabelAEP | AnchorLinkAEP | TableSortColumnNotAllowedAEP | TableSortColumnAEP | TableWidthInfoAEP | TableRendererHeightInfoAEP | VisitLinkAEP | VisitMediaLinkAEP | ExpandAEP | UnsupportedContentPayload | UnsupportedContentTooltipPayload | AnnotationAEP | AnnotationDeleteAEP | MediaLnkTransformedAEP | InvalidProsemirrorDocumentErrorAEP | NestedTableTransformedAEP | MediaRenderErrorEvent | SyncedBlockFetchErrorAEP | SyncedBlockGetSourceInfoErrorAEP | ReferenceSyncedBlockUpdateErrorAEP;
162
+ export type AnalyticsEventPayload<_T = void> = RendererStartAEP | RendererRenderedAEP | RendererRenderedSampledAEP | ComponentCrashErrorAEP | RendererUnsupportedContentLevelsTrackingSucceeded | RendererUnsupportedContentLevelsTrackingErrored | RendererSelectAllCaughtAEP | RendererSelectAllEscapedAEP | CodeBlockCopyAEP | CodeBlockWrapAEP | HeadingAnchorLinkButtonAEP | HoverLabelAEP | AnchorLinkAEP | TableSortColumnNotAllowedAEP | TableSortColumnAEP | TableWidthInfoAEP | TableRendererHeightInfoAEP | VisitLinkAEP | VisitMediaLinkAEP | ExpandAEP | UnsupportedContentPayload | UnsupportedContentTooltipPayload | AnnotationAEP | AnnotationDeleteAEP | MediaLnkTransformedAEP | InvalidProsemirrorDocumentErrorAEP | NestedTableTransformedAEP | MediaRenderErrorEvent | SyncedBlockFetchErrorAEP | SyncedBlockGetSourceInfoErrorAEP | ReferenceSyncedBlockUpdateErrorAEP;
155
163
  export type FireAnalyticsCallback = <T = void>(payload: AnalyticsEventPayload<T>) => void | undefined;
156
164
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/renderer",
3
- "version": "125.0.2",
3
+ "version": "125.1.0",
4
4
  "description": "Renderer component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -53,12 +53,12 @@
53
53
  "@atlaskit/platform-feature-flags": "^1.1.0",
54
54
  "@atlaskit/platform-feature-flags-react": "^0.4.0",
55
55
  "@atlaskit/react-ufo": "^4.16.0",
56
- "@atlaskit/smart-card": "^43.18.0",
56
+ "@atlaskit/smart-card": "^43.19.0",
57
57
  "@atlaskit/status": "^3.0.0",
58
58
  "@atlaskit/task-decision": "^19.2.0",
59
59
  "@atlaskit/theme": "^21.0.0",
60
- "@atlaskit/tmp-editor-statsig": "^16.3.0",
61
- "@atlaskit/tokens": "^9.0.0",
60
+ "@atlaskit/tmp-editor-statsig": "^16.7.0",
61
+ "@atlaskit/tokens": "^9.1.0",
62
62
  "@atlaskit/tooltip": "^20.11.0",
63
63
  "@atlaskit/visually-hidden": "^3.0.0",
64
64
  "@babel/runtime": "^7.0.0",
@@ -71,8 +71,8 @@
71
71
  "uuid": "^3.1.0"
72
72
  },
73
73
  "peerDependencies": {
74
- "@atlaskit/editor-common": "^111.2.0",
75
- "@atlaskit/link-provider": "^4.0.0",
74
+ "@atlaskit/editor-common": "^111.4.0",
75
+ "@atlaskit/link-provider": "^4.1.0",
76
76
  "@atlaskit/media-core": "^37.0.0",
77
77
  "react": "^18.2.0",
78
78
  "react-dom": "^18.2.0"
@@ -82,7 +82,7 @@
82
82
  "@af/visual-regression": "workspace:^",
83
83
  "@atlaskit/analytics-gas-types": "^5.1.0",
84
84
  "@atlaskit/checkbox": "^17.3.0",
85
- "@atlaskit/link-provider": "^4.0.0",
85
+ "@atlaskit/link-provider": "^4.1.0",
86
86
  "@atlaskit/link-test-helpers": "^9.0.0",
87
87
  "@atlaskit/media-core": "^37.0.0",
88
88
  "@atlaskit/media-integration-test-helpers": "workspace:^",