,
): Params;
-// Warning: (ae-missing-release-tag) "withAnalyticsContext" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public
-export function withAnalyticsContext(
- Component: React_2.ComponentType
,
- values: AnalyticsContextValue,
-): {
- (props: P): JSX.Element;
- displayName: string;
-};
-
// Warning: (ae-missing-release-tag) "withApis" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
diff --git a/packages/core-plugin-api/src/analytics/AnalyticsContext.test.tsx b/packages/core-plugin-api/src/analytics/AnalyticsContext.test.tsx
index cad6d5ec38..88e8afa6ef 100644
--- a/packages/core-plugin-api/src/analytics/AnalyticsContext.test.tsx
+++ b/packages/core-plugin-api/src/analytics/AnalyticsContext.test.tsx
@@ -17,11 +17,7 @@
import React from 'react';
import { render } from '@testing-library/react';
import { renderHook } from '@testing-library/react-hooks';
-import {
- AnalyticsContext,
- useAnalyticsContext,
- withAnalyticsContext,
-} from './AnalyticsContext';
+import { AnalyticsContext, useAnalyticsContext } from './AnalyticsContext';
const AnalyticsSpy = () => {
const context = useAnalyticsContext();
@@ -29,7 +25,7 @@ const AnalyticsSpy = () => {
<>
{context.routeRef}
{context.pluginId}
- {context.componentName}
+ {context.extension}
{context.custom}
>
);
@@ -40,7 +36,7 @@ describe('AnalyticsContext', () => {
it('returns default values', () => {
const { result } = renderHook(() => useAnalyticsContext());
expect(result.current).toEqual({
- componentName: 'App',
+ extension: 'App',
pluginId: 'root',
routeRef: 'unknown',
});
@@ -55,7 +51,7 @@ describe('AnalyticsContext', () => {
,
);
- expect(result.getByTestId('component-name')).toHaveTextContent('App');
+ expect(result.getByTestId('extension')).toHaveTextContent('App');
expect(result.getByTestId('plugin-id')).toHaveTextContent('root');
expect(result.getByTestId('route-ref')).toHaveTextContent('unknown');
});
@@ -67,7 +63,7 @@ describe('AnalyticsContext', () => {
,
);
- expect(result.getByTestId('component-name')).toHaveTextContent('App');
+ expect(result.getByTestId('extension')).toHaveTextContent('App');
expect(result.getByTestId('plugin-id')).toHaveTextContent('custom');
expect(result.getByTestId('route-ref')).toHaveTextContent('unknown');
});
@@ -75,30 +71,15 @@ describe('AnalyticsContext', () => {
it('uses nested analytics context', () => {
const result = render(
-
+
,
);
- expect(result.getByTestId('component-name')).toHaveTextContent(
- 'AnalyticsSpy',
- );
+ expect(result.getByTestId('extension')).toHaveTextContent('AnalyticsSpy');
expect(result.getByTestId('plugin-id')).toHaveTextContent('custom');
expect(result.getByTestId('route-ref')).toHaveTextContent('unknown');
});
});
-
- describe('withAnalyticsContext', () => {
- it('wraps component with analytics context', () => {
- const AnalyticsSpyHOC = withAnalyticsContext(AnalyticsSpy, {
- custom: 'attr',
- });
- const result = render();
- expect(result.getByTestId('custom')).toHaveTextContent('attr');
- expect(AnalyticsSpyHOC.displayName).toBe(
- 'WithAnalyticsContext(AnalyticsSpy)',
- );
- });
- });
});
diff --git a/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx b/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx
index f50375d42f..5852dab51c 100644
--- a/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx
+++ b/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx
@@ -20,7 +20,7 @@ import { AnalyticsContextValue } from './types';
const AnalyticsReactContext = createContext({
routeRef: 'unknown',
pluginId: 'root',
- componentName: 'App',
+ extension: 'App',
});
/**
diff --git a/packages/core-plugin-api/src/analytics/index.ts b/packages/core-plugin-api/src/analytics/index.ts
index dbf82aa4e3..651e8e105e 100644
--- a/packages/core-plugin-api/src/analytics/index.ts
+++ b/packages/core-plugin-api/src/analytics/index.ts
@@ -14,6 +14,6 @@
* limitations under the License.
*/
-export { AnalyticsContext, withAnalyticsContext } from './AnalyticsContext';
+export { AnalyticsContext } from './AnalyticsContext';
export type { AnalyticsContextValue, CommonAnalyticsContext } from './types';
export { useAnalytics } from './useAnalytics';
diff --git a/packages/core-plugin-api/src/analytics/types.ts b/packages/core-plugin-api/src/analytics/types.ts
index 189d182328..045328f613 100644
--- a/packages/core-plugin-api/src/analytics/types.ts
+++ b/packages/core-plugin-api/src/analytics/types.ts
@@ -29,9 +29,9 @@ export type CommonAnalyticsContext = {
routeRef: string;
/**
- * The name of the associated component.
+ * The name of the associated extension.
*/
- componentName: string;
+ extension: string;
};
/**
diff --git a/packages/core-plugin-api/src/analytics/useAnalytics.test.tsx b/packages/core-plugin-api/src/analytics/useAnalytics.test.tsx
index ce27602e6c..22021026af 100644
--- a/packages/core-plugin-api/src/analytics/useAnalytics.test.tsx
+++ b/packages/core-plugin-api/src/analytics/useAnalytics.test.tsx
@@ -55,7 +55,7 @@ describe('useAnalytics', () => {
some: 'value',
},
context: {
- componentName: 'App',
+ extension: 'App',
pluginId: 'root',
routeRef: 'unknown',
},
diff --git a/packages/core-plugin-api/src/extensions/extensions.test.tsx b/packages/core-plugin-api/src/extensions/extensions.test.tsx
index 42a2bf5e66..eff8db5029 100644
--- a/packages/core-plugin-api/src/extensions/extensions.test.tsx
+++ b/packages/core-plugin-api/src/extensions/extensions.test.tsx
@@ -121,7 +121,7 @@ describe('extensions', () => {
<>
{context.pluginId}
{context.routeRef}
- {context.componentName}
+ {context.extension}
>
);
},
@@ -134,8 +134,6 @@ describe('extensions', () => {
expect(result.getByTestId('plugin-id')).toHaveTextContent('my-plugin');
expect(result.getByTestId('route-ref')).toHaveTextContent('some-ref');
- expect(result.getByTestId('component-name')).toHaveTextContent(
- 'AnalyticsSpy',
- );
+ expect(result.getByTestId('extension')).toHaveTextContent('AnalyticsSpy');
});
});
diff --git a/packages/core-plugin-api/src/extensions/extensions.tsx b/packages/core-plugin-api/src/extensions/extensions.tsx
index 7aa16f5692..31bb08a13f 100644
--- a/packages/core-plugin-api/src/extensions/extensions.tsx
+++ b/packages/core-plugin-api/src/extensions/extensions.tsx
@@ -140,7 +140,7 @@ export function createReactExtension<
{
+export const Playground = () => {
return (
<>
Click Here
>
);
};
-
-export const Playground = withAnalyticsContext(ContextlessPlayground, {});
diff --git a/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.test.ts b/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.test.ts
index 34ee70a3b8..c262849695 100644
--- a/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.test.ts
+++ b/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.test.ts
@@ -51,7 +51,7 @@ describe('GoogleAnalytics', () => {
describe('integration', () => {
const context = {
- componentName: 'App',
+ extension: 'App',
pluginId: 'some-plugin',
releaseNum: 1337,
};
@@ -125,7 +125,7 @@ describe('GoogleAnalytics', () => {
expect(command).toBe('send');
expect(data).toMatchObject({
hitType: 'event',
- eventCategory: context.componentName,
+ eventCategory: context.extension,
eventAction: expectedAction,
eventLabel: expectedLabel,
eventValue: expectedValue,
@@ -178,7 +178,7 @@ describe('GoogleAnalytics', () => {
expect(command).toBe('send');
expect(data).toMatchObject({
hitType: 'event',
- eventCategory: context.componentName,
+ eventCategory: context.extension,
eventAction: expectedAction,
eventLabel: expectedLabel,
eventValue: expectedValue,
diff --git a/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.ts b/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.ts
index dceaf7b2d6..a05b4fe127 100644
--- a/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.ts
+++ b/plugins/analytics-module-ga/src/apis/implementations/AnalyticsApi/GoogleAnalytics.ts
@@ -106,7 +106,7 @@ export class GoogleAnalytics implements AnalyticsApi {
}: AnalyticsEvent) {
const customMetadata = this.getCustomDimensionMetrics(context, attributes);
- if (action === 'navigate' && context?.componentName === 'App') {
+ if (action === 'navigate' && context?.extension === 'App') {
// Set any/all custom dimensions.
if (Object.keys(customMetadata).length) {
ReactGA.set(customMetadata);
@@ -117,7 +117,7 @@ export class GoogleAnalytics implements AnalyticsApi {
}
ReactGA.event({
- category: context.componentName || 'App',
+ category: context.extension || 'App',
action,
label: subject,
value,