Skip to:

Top Bar
Sidebar
Main Content

Atlaskit

Editor performance metrics

Typescript ❤️

Experimental code to track Editor Full Page performance on some particular scenarios

Install

yarn add @atlaskit/editor-performance-metrics

npm

@atlaskit/editor-performance-metrics

Source

Bundle

Latest

2.0.2

Patch Changes

#118627 964bf43e21dc5 - ### Patch Changes

Race Condition

This update fix a race condition between Timeline.attemptFlushIdleBuffer and Timeline.callOnNextIdleCallbacks,
- The attemptFlushIdleBuffer was cleaning the idle buffer before the callOnNextIdleCallbacks call the listerners.
Buffer size

This update increase the default buffer size from 1000 to 3000.

Performance Observers

This update improves when the performance observer should starts the observation

Experimental code to track Editor Full Page performance on some particular scenarios

Usage

Basic example

You should not see me

My content go here

You should not see me

Content Div 1

Content Div 2

Content Div 3

2.0.2

Patch Changes

#118627 964bf43e21dc5 - ### Patch Changes

Race Condition

This update fix a race condition between Timeline.attemptFlushIdleBuffer and Timeline.callOnNextIdleCallbacks,
- The attemptFlushIdleBuffer was cleaning the idle buffer before the callOnNextIdleCallbacks call the listerners.
Buffer size

This update increase the default buffer size from 1000 to 3000.

Performance Observers

This update improves when the performance observer should starts the observation

2.0.1

Patch Changes

#118205 8a4aaaa9b7d26 - ### Patch Changes

This update fix a race condition caused by wrongly scope binding.
- The idle callbacks will be called with a shallow copy of timelineBuffer from the lexical scope
- The handleIdle is manually bindided with the Timeline class instance to avoid race-condition issues

2.0.0

Major Changes

#117363 10a0f7f6c2027 - This package's peerDependencies have been adjusted for react and/or react-dom to reflect the status of only supporting React 18 going forward. No explicit breaking change to React support has been made in this release, but this is to signify going forward, breaking changes for React 16 or React 17 may come via non-major semver releases.

Please refer this community post for more details: https://community.developer.atlassian.com/t/rfc-78-dropping-support-for-react-16-and-rendering-in-a-react-18-concurrent-root-in-jira-and-confluence/87026

1.5.1

Patch Changes

#116860 fe10f83753ea7 - ### Patch Changes

Ticket: AFO-3446

This update enhances error handling in the wrapping functions for global timers and fetch operations, ensuring that resources are properly released even when exceptions occur.

1.5.0

Minor Changes

#116155 27cf8da4bec02 - Ticket: ED-26671

Minor Changes

This update introduces improved lifecycle management for the Timeline and EditorPerformanceObserver, providing better control over observer states and cleanup operations.

1.4.0

Minor Changes

#113957 9bf5ff8b2ae82 - ## Minor Changes

This update adds the onTTAI callback functionality to the PerformanceMetrics component, which allows tracking of the Time To App Idle (TTAI) event. The onTTAI callback is triggered when the first idle time is detected after the component is mounted, providing a DOMHighResTimeStamp indicating when the browser is truly idle.
```
New Callback: onTTAI
    Type: (result: { idleAt: DOMHighResTimeStamp }) => void
    Description: This callback is called once when the component detects its first idle state after mounting, supplying the timestamp of this idle state.

Enhancements:
    Updated the PerformanceMetricsProps to include the new onTTAI callback.
    Modified the PerformanceMetrics component to check for server-side rendering (SSR) and handle observers accordingly.
    Incorporated useTTAI hook to manage the subscription to the idle event.
```
These enhancements provide additional metrics for analyzing editor performance, specifically focusing on idle state detection, which can be critical for improving user experience and resource management in applications.

1.3.2

Patch Changes

#109782 9129332a66d2b - [ED-26431] Fix rounding error when calculating the TTVC targets

1.3.1

Patch Changes

#109717 3f2415568258b - [ED-26435] Add option to override the timeout allowed to be tracked on EditorPerformanceObserver

1.3.0

Minor Changes

#109060 4660ec858a305 - Update React from v16 to v18

1.2.0

Minor Changes

#107955 02bde230bde80 - [AFO-3352] Multiple improvements to detect TTAI on Editor

1.1.0

Minor Changes

#102282 5e1d47c2c7c16 - # New Features

1.0.0

Major Changes

#174435 fec297262a299 - [NO ISSUE] Initial code for Editor Performance Metrics