React components, HOCs and hooks to assist with tracking user activity with React components
Tools for tracking interactions with UI components. Easily capture UI context and state when these events occur.
Maintaince Mode: \ This package is officially in maintenance mode, which means only bugfixes or VULN fixes are currently being accepted and no known breaking changes will be approved in the PR process. \ Please refer to this DACI for more details.
atlassian
yarn add @atlaskit/analytics-nextDetailed docs and example usage can be found here.
2752a069d8a01 -
Cleaning up feature flag changes that remove the legacy contextTypes API, which is deprecated and
will be removed in the next major React release.604dd578f00d9 -
Types the withAnalyticsEvents WrappedComponent as allowing a forwardRefExoticComponent3298a6307027c -
Sorted type and interface props to improve Atlaskit docsad595df3d2ec0 -
We are testing the migration to the ADS Link component behind a feature flag. If this fix is
successful it will be available in a later release.#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
4660ec858a305 -
Update React from v16 to v18ec8b221900f5c -
Adds a package.json#overrides in hopes that it will override the peerDependencies of
@atlaskit/analytics-next-stable-react-context (NOTE: This may not work across all platforms and
was only tested in one scenario, but should have zero impact if it doesn't work)c0c1a54579ce7 -
Set @atlaskit/analytics deprecated and move functions to @atlaskit/analytics-next2573c7152094d -
Package.json dependecies update#127511
db30e29344013 -
Widening range of react and react-dom peer dependencies from ^16.8.0 || ^17.0.0 || ~18.2.0
to the wider range of ^16.8.0 || ^17.0.0 || ^18.0.0` (where applicable).
This change has been done to enable usage of `react@18.3as well as to have a consistent peer
dependency range forreactandreact-domfor/platform` packages.
7d3290f61ac09 -
AFO-2278: React-dom 18 resolving yarn build package errors. Introducing react-dom as a peer
dependency https://hello.atlassian.net/wiki/x/HtE481dd14118edb5c -
Fixing event bubbling difference between Modern and Legacy context69348340269b2 -
Switch AnalyticsErrorBoundary between Modern and Legacy context06f31de41af3a -
Upgrading react version to 183aa3cd8db606 -
Improve compatibility with React 1836ccb66917fb -
Fix a bug in ModernAnalyticsContext when it's bit late to update data in new React context when
mounting a component8d4e99057fe0 -
Upgrade Typescript from 4.9.5 to 5.4.27febfed958dd -
Update usage of React.FC to explicity include children0443b2194bd9 -
Allow using modern react context via platform feature flags9af31f3c1ae - Delete
version.json9d00501a414 - Ensure
legacy types are published for TS 4.5-4.841fae2c6f68 - Upgrade
Typescript from 4.5.5 to 4.9.57cc1e8f18ec - Move
analytics-next to maintenance mode56507598609 - Skip
minor dependency bump7caf968e4cf - Move
analytics-next to maintenance modefbff320b423 - Move
package to continuous model and to push model consumptioncf21f06ff72 - Bugfix,
removed sending event fn and deprecated AnalyticErrorBoundaryccdc8e150f9 - AFO-771
Analytics next - fix node process check2cbb787f8b3 - AFO-711
Analytics-next: nullable check for context8cc2f888c83 - Upgrade
Typescript from 4.3.5 to 4.5.58d4228767b0 - Upgrade
Typescript from 4.2.4 to 4.3.5.cb2392f6d33 - Upgrade
to TypeScript 4.2.437fd554209e - Add
instance checks for analytics events in analytics-next. Update check in mpt-analytics for events
too.a4420ad5104 - Improves
referential stability of analytics-next wrapped callbacks0dbf0427287 - [ux]
Added new optional props to allow executing on catching error and rendering an error screen on
errord6f7ff383cf - Updates
to development dependency storybook-addon-performance5a9b102eef0 - Add
optional actionSubject parameter to usePlatformLeafHandlerHookb290f591719 - Add
process type check in analytics nextd3265f19be - Transpile
packages using babel rather than tsc4eb71695b5 - Added
usePlatformLeafSyntheticEventHandler, which acts similarly to usePlatformLeafEventHandler but is
used for synthetic events where the event handler takes no value prop5f58283e1f - Export
types using Typescript's new "export type" syntax to satisfy Typescript's --isolatedModules
compiler option. This requires version 3.8 of Typescript, read more about how we handle Typescript
versions here: https://atlaskit.atlassian.com/get-started Also add typescript to
devDependencies to denote version that the package was built with.b6af9198dd -
Restructure back to original lite mode file structure#5344
b485472340 - Export
WithContextProps type to prevent deep import path references in dependent packages declaration
output.
Released as a major to prevent existing Atlaskit dependencies that use analytics-next from breaking when analytics-next file structure changes in the future.
2ac834240e - Undo
analytics-next file restructure to allow external ts definitions to continue working#4749
0e2a914932 - ###
Additions
useAnalyticsEventHandler for sole use in Atlaskit componentsAnalyticsContextConsumerwithAnalyticsHookusePatchedPropscleanPropsAnalyticsReactContextAnalyticsEventMap(Legacy React context)[https://reactjs.org/docs/legacy-context.html] will be removed in a future version of React.
In addition its presence can be (problematic for performance)[https://twitter.com/dan_abramov/status/1064559184010723330].
As a result, we have taken steps to migrate away from it and use the new (React Context API)[https://reactjs.org/docs/context.html].
To achieve this we are rolling the drop out in 2 phases:
We have changed analytics components to receive modern context. Listeners and the Context layer will provide both modern and legacy context by default.
At their own risk, package consumers can opt in to no longer supply legacy context by using the environment variable ANALYTICS_NEXT_MODERN_CONTEXT=true.
When doing so, any analytics consumers that rely on legacy context will not receive any, and events may be lost! This would happen when using old atlaskit packages that consume a version of @atlaskit/analytics-next before this version.
In a future release (TBA) we will remove all legacy context support and clean up the branching around ANALYTICS_NEXT_MODERN_CONTEXT. After this point, @atlaskit/analytics-next will not work with components that use a version prior to this one.
967279b3f8 - Fix for
type names that ship with new hook#3885
6c525a8229 - Upgraded
to TypeScript 3.9.6 and tslib to 2.0.0
Since tslib is a dependency for all our packages we recommend that products also follow this tslib upgrade to prevent duplicates of tslib being bundled.
Updated dependencies
723a322186 - Hotfix to
have a stable react context across multiple versions of @atlaskit/analytics-nextbff2f273bf -
useAnalyticsEvents will no longer log errors when used without an AnalyticsListerner or
AnalyticsContext87f4720f27 - Officially
dropping IE11 support, from this version onwards there are no warranties of the package working in
IE11. For more information see:
https://community.developer.atlassian.com/t/atlaskit-to-drop-support-for-internet-explorer-11-from-1st-july-2020/39534[patch]109004a98e:
Deletes internal package @atlaskit/type-helpers and removes all usages. @atlaskit/type-helpers has been superseded by native typescript helper utilities.- Updated dependencies 168b5f90e5:
Updated dependencies 109004a98e:
[patch]6548261c9a:
Remove namespace imports from React, ReactDom, and PropTypes- Updated dependencies 6548261c9a:
[patch]6940a2107f:
Removes cycle in internal components.
[patch]24865cfaff:
Fixes useAnalyticsEvents() not having a stable function reference.- [patch]24865cfaff:
Fixes data type to Object- Updated dependencies 24865cfaff:
[patch]768bac6d81:
Remove redundant object check (which was previously required to appease type checking)
[patch]35d2229b2a:
Adding missing license to packages and update to Copyright 2019 Atlassian Pty Ltd.
[minor]2252a7a999:
Bug fix for using the hook with nested contexts, performance improvements, new
useAnalyticsEventsCallback hook to provide a performance enhanced-abstraction for firing events
with a callback.
[minor]42fd897e16:
useAnalyticsEvents_experimental, for creating analytics
events within functional components. This hook replaces the need for the withAnalyticsEvents
HOC. See the
Reference documentation
for details on how to use this new hook.[minor]c6efb2f5b6:
Prefix the legacy lifecycle methods with UNSAFE_* to avoid warning in React 16.9+
More information about the deprecation of lifecycles methods can be found here: https://reactjs.org/blog/2018/03/29/react-v-16-3.html#component-lifecycle-changes
[patch]097b696613:
Components now depend on TS 3.6 internally, in order to fix an issue with TS resolving non-relative imports as relative imports
[patch]ecca4d1dbb:
Upgraded Typescript to 3.3.x
[patch]de35ce8c67:
Updates component maintainers
[major]926b43142b:
Analytics-next has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided. No behavioural changes.
Breaking changes
withAnalyticsForSumTypeProps alias has been removed, please use withAnalyticsEventsAnalyticsContextWrappedComp alias has been removed, please use withAnalyticsContextBreaking changes to TypeScript annotations
withAnalyticsEvents now infers proptypes automatically, consumers no longer need to provide
props as a generic type.withAnalyticsContext now infers proptypes automatically, consumers no longer need to provide
props as a generic type.WithAnalyticsEventProps has been renamed to WithAnalyticsEventsProps to match source
codeCreateUIAnalyticsEventSignature has been renamed to CreateUIAnalyticsEvent to match
source codeUIAnalyticsEventHandlerSignature has been renamed to UIAnalyticsEventHandler to match
source codeAnalyticsEventsPayload has been renamed to AnalyticsEventPayloadObjectType has been removed, please use Record<string, any> or [key: string]: anyUIAnalyticsEventInterface has been removed, please use UIAnalyticsEventAnalyticsEventInterface has been removed, please use AnalyticsEventCreateAndFireEventFunction removed and should now be inferred by TypeScriptAnalyticsEventUpdater removed and should now be inferred by TypeScript[patch]1439241943:
Adding error boundary in media picker dropzone
[minor]e1f8aaf33b:
AnalyticsErrorBoundary package// How to use
// Import via entry point
import AnalyticsListener from '@atlaskit/analytics-next/AnalyticsListener';
import AnalyticsErrorBoundary from '@atlaskit/analytics-next/AnalyticsErrorBoundary';
// Wrapping your component with the component
class ButtonWithAnalyticsErrorBoundary extends React.Component {
handleEvent = (analyticsEvent) => {
const { payload, context } = analyticsEvent;
console.log('Received event:', analyticsEvent, { payload, context });
};
render() {
return (
<AnalyticsListener channel="atlaskit" onEvent={this.handleEvent}>
<AnalyticsErrorBoundary
channel="atlaskit"
data={{
componentName: 'button',
packageName: '@atlaskit/button',
componentVersion: '999.9.9',
}}
>
<Button>Click me</Button>
</AnalyticsErrorBoundary>
</AnalyticsListener>
)
}
}Notes on new API:
AnalyticsListener as a top level component to work properly, otherwise it won't trigger
analytics events.[patch]281451e6dc:
Republishing package to export AnalyticsErrorBoundaryProps
[minor]ed9ae90c94:
Adding Analytics Error Boundary component
[minor]8fcbe23ec6:
Updated types for analytics-next and buttons to make them easier to consume
[patch]c6ad66d326:
The types property in package.json now points to the correct file"
[patch]9f8ab1084b:
Consume analytics-next ts type definitions as an ambient declaration.
[patch]6ea9bb7873:
analytics-next now exports an ambient module declaration which resolves an issue with types being required via relative imports
[minor]d0db01b410:
TypeScript users of withAnalyticsEvents and withAnalyticsContext are now required to provide props as a generic type. This is so that TypeScript can correctly calculate the props and defaultProps of the returned component.
Before:
withAnalyticsEvents()(Button) as ComponentClass<Props>;After:
withAnalyticsEvents<Props>()(Button);[patch]4615439434:
index.ts will now be ignored when publishing to npm
[patch]47acb57783:
[major]7c17b35107:
[patch]3f28e6443c:
[patch]9321da655d:
[patch]98e11001ff:
[major]76299208e6:
As a breaking change, all @atlaskit packages will be dropping cjs distributions and will only
distribute esm. This means all distributed code will be transpiled, but will still contain
import and export declarations.
The major reason for doing this is to allow us to support multiple entry points in packages, e.g:
import colors from `@atlaskit/theme/colors`;Previously this was sort of possible for consumers by doing something like:
import colors from `@atlaskit/theme/dist/esm/colors`;This has a couple of issues. 1, it treats the file system as API making internal refactors harder, we have to worry about how consumers might be using things that aren't actually supposed to be used. 2. We are unable to do this internally in @atlaskit packages. This leads to lots of packages bundling all of theme, just to use a single color, especially in situations where tree shaking fails.
To support being able to use multiple entrypoints internally, we unfortunately cannot have multiple distributions as they would need to have very different imports from of their own internal dependencies.
ES Modules are widely supported by all modern bundlers and can be worked around in node environments.
We may choose to revisit this solution in the future if we find any unintended condequences, but we see this as a pretty sane path forward which should lead to some major bundle size decreases, saner API's and simpler package architecture.
Please reach out to #fabric-build (if in Atlassian) or create an issue in Design System Support (for external) if you have any questions or queries about this.
[patch]8de4c3f:
[minor]c3fa0b6:
[minor]cffeed0:
Type withAnalyticsEvents and withAnalyticsContext HOCs so that they do not lose flow types
of the components they wrap when chained together.
This will fix flow types not flowing through all of the components that we have instrumented with analytics as they are typically wrapped with both HOCs. To get flow types flowing through your components again, upgrade them to the latest version and also update their @atlaskit/analytics-next dependency to the latest version.
We also now export AnalyticsContextWrappedComp and AnalyticsEventsWrappedComp parameterised
types that allow you to explicitly type components wrapped with these HOCs which is necessary in
cases where the HOC wrapping is extracted into another function.
[patch]d903ab5: