Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Emit performance marks only for loaded components #3175

Merged
merged 3 commits into from
Jan 10, 2025
Merged

fix: Emit performance marks only for loaded components #3175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0458b51
fix: Emit performance marks only for loaded components
guptbhum Dec 10, 2024
1c670c7
Merge branch 'main' of https://github.com/cloudscape-design/component…
guptbhum Jan 8, 2025
c79323c
Merge branch 'main' into performanceBugFix
abdhalees Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pages/button/performance-marks.page.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ export default function ButtonsPerformanceMarkPage() {
</Button>
</label>
<Button variant="primary" loading={loading} disabled={disabled}>
Primary button
Primary button with loading and disabled props
</Button>
<Button variant="primary">Primary button</Button>
<Button>Non-primary button</Button>

<Modal visible={false} footer={<Button variant="primary">Submit modal</Button>}></Modal>
Expand Down
35 changes: 18 additions & 17 deletions src/button/__integ__/performance-marks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ function setupTest(

describe('Button', () => {
test(
'Emits a mark only for primary visible buttons',
'Emits a mark only for primary visible buttons which are loaded',
setupTest('performance-marks', async ({ getMarks, getElementPerformanceMarkText }) => {
const marks = await getMarks();

Expand All @@ -35,7 +35,7 @@ describe('Button', () => {
expect(marks[0].detail).toMatchObject({
source: 'awsui',
instanceIdentifier: expect.any(String),
loading: true,
loading: false,
disabled: false,
text: 'Primary button',
});
Expand All @@ -47,32 +47,33 @@ describe('Button', () => {
test(
'Emits a mark when properties change',
setupTest('performance-marks', async ({ page, getMarks, getElementPerformanceMarkText }) => {
await page.click('#disabled');
await page.click('#loading');
const marks = await getMarks();

expect(marks).toHaveLength(3);
expect(marks[1].name).toBe('primaryButtonUpdated');
expect(marks[1].detail).toMatchObject({
expect(marks).toHaveLength(2);
expect(marks[0].name).toBe('primaryButtonRendered');
expect(marks[0].detail).toMatchObject({
source: 'awsui',
instanceIdentifier: marks[0].detail.instanceIdentifier,
loading: true,
disabled: true,
loading: false,
disabled: false,
text: 'Primary button',
});

await expect(getElementPerformanceMarkText(marks[1].detail.instanceIdentifier)).resolves.toBe('Primary button');
await expect(getElementPerformanceMarkText(marks[0].detail.instanceIdentifier)).resolves.toBe('Primary button');

expect(marks[2].name).toBe('primaryButtonUpdated');
expect(marks[2].detail).toMatchObject({
expect(marks[1].name).toBe('primaryButtonUpdated');
expect(marks[1].detail).toMatchObject({
source: 'awsui',
instanceIdentifier: marks[1].detail.instanceIdentifier,
loading: false,
disabled: true,
text: 'Primary button',
disabled: false,
text: 'Primary button with loading and disabled props',
});

await expect(getElementPerformanceMarkText(marks[2].detail.instanceIdentifier)).resolves.toBe('Primary button');
await expect(getElementPerformanceMarkText(marks[1].detail.instanceIdentifier)).resolves.toBe(
'Primary button with loading and disabled props'
);
})
);

Expand All @@ -92,7 +93,7 @@ describe('Button', () => {
);

test(
'Emits a mark when evaluateComponentVisibility event for button components',
'Emits a mark when evaluateComponentVisibility event for loaded button components',
setupTest('performance-marks', async ({ page, getMarks, getElementPerformanceMarkText }) => {
let marks = await getMarks();
expect(marks).toHaveLength(1);
Expand All @@ -106,7 +107,7 @@ describe('Button', () => {
expect(marks[0].detail).toMatchObject({
source: 'awsui',
instanceIdentifier: marks[0].detail.instanceIdentifier,
loading: true,
loading: false,
disabled: false,
text: 'Primary button',
});
Expand All @@ -117,7 +118,7 @@ describe('Button', () => {
expect(marks[1].detail).toMatchObject({
source: 'awsui',
instanceIdentifier: marks[1].detail.instanceIdentifier,
loading: true,
loading: false,
disabled: false,
text: 'Primary button',
});
Expand Down
2 changes: 1 addition & 1 deletion src/button/internal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ export const InternalButton = React.forwardRef(

const performanceMarkAttributes = usePerformanceMarks(
'primaryButton',
variant === 'primary' && __emitPerformanceMarks,
() => variant === 'primary' && __emitPerformanceMarks && !loading && !disabled,
buttonRef,
() => ({
loading,
Expand Down
8 changes: 7 additions & 1 deletion src/internal/hooks/use-performance-marks/__tests__/use-performance-marks.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ import { usePerformanceMarks } from '../index';

function Demo() {
const ref = useRef<HTMLDivElement>(null);
const attributes = usePerformanceMarks('test-component', true, ref, () => ({}), []);
const attributes = usePerformanceMarks(
'test-component',
() => true,
ref,
() => ({}),
[]
);
return <div {...attributes} ref={ref} data-testid="element" />;
}

Expand Down
6 changes: 3 additions & 3 deletions src/internal/hooks/use-performance-marks/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const useEvaluateComponentVisibility = () => {
*/
export function usePerformanceMarks(
name: string,
enabled: boolean,
enabled: () => boolean,
elementRef: React.RefObject<HTMLElement>,
getDetails: () => Record<string, string | boolean | number | undefined>,
dependencies: React.DependencyList
Expand All @@ -51,7 +51,7 @@ export function usePerformanceMarks(
const attributes = useDOMAttribute(elementRef, 'data-analytics-performance-mark', id);
const evaluateComponentVisibility = useEvaluateComponentVisibility();
useEffect(() => {
if (!enabled || !elementRef.current || isInModal) {
if (!enabled() || !elementRef.current || isInModal) {
return;
}
const elementVisible =
Expand All @@ -75,7 +75,7 @@ export function usePerformanceMarks(
}, []);

useEffectOnUpdate(() => {
if (!enabled || !elementRef.current || isInModal) {
if (!enabled() || !elementRef.current || isInModal) {
return;
}
const elementVisible =
Expand Down
64 changes: 13 additions & 51 deletions src/table/__integ__/performance-marks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,29 +27,18 @@ function setupTest(

describe('Table', () => {
test(
'Emits a mark only for visible tables',
'Emits a mark only for visible tables which are loaded completely',
setupTest(async ({ getMarks, isElementPerformanceMarkExisting }) => {
const marks = await getMarks();

expect(marks).toHaveLength(2);
expect(marks).toHaveLength(1);
expect(marks[0].name).toBe('tableRendered');
expect(marks[0].detail).toEqual({
source: 'awsui',
instanceIdentifier: expect.any(String),
loading: true,
header: 'This is my table',
});

expect(marks[1].name).toBe('tableRendered');
expect(marks[1].detail).toEqual({
source: 'awsui',
instanceIdentifier: expect.any(String),
loading: false,
header: 'A table without the Header component',
});

expect(marks[0].detail.instanceIdentifier).not.toEqual(marks[1].detail.instanceIdentifier);

await expect(isElementPerformanceMarkExisting(marks[0].detail.instanceIdentifier)).resolves.toBeTruthy();
})
);
Expand All @@ -58,47 +47,27 @@ describe('Table', () => {
'Emits a mark when properties change',
setupTest(async ({ page, getMarks, isElementPerformanceMarkExisting }) => {
await page.click('#loading');
let marks = await getMarks();
const marks = await getMarks();

expect(marks).toHaveLength(3);
expect(marks[2].name).toBe('tableUpdated');
expect(marks[2].detail).toMatchObject({
expect(marks).toHaveLength(2);
expect(marks[1].name).toBe('tableUpdated');
expect(marks[1].detail).toMatchObject({
source: 'awsui',
instanceIdentifier: marks[0].detail.instanceIdentifier,
instanceIdentifier: expect.any(String),
loading: false,
header: 'This is my table',
});
await expect(isElementPerformanceMarkExisting(marks[2].detail.instanceIdentifier)).resolves.toBeTruthy();

await page.click('#loading');

marks = await getMarks();

expect(marks[3].name).toBe('tableUpdated');
expect(marks[3].detail).toMatchObject({
source: 'awsui',
instanceIdentifier: marks[2].detail.instanceIdentifier,
loading: true,
header: 'This is my table',
});
await expect(isElementPerformanceMarkExisting(marks[2].detail.instanceIdentifier)).resolves.toBeTruthy();
await expect(isElementPerformanceMarkExisting(marks[1].detail.instanceIdentifier)).resolves.toBeTruthy();
})
);

test(
'Emits a mark when evaluateComponentVisibility event is emitted',
'Emits a mark for loaded table components when evaluateComponentVisibility event is emitted',
setupTest(async ({ page, getMarks, isElementPerformanceMarkExisting }) => {
let marks = await getMarks();
expect(marks).toHaveLength(2);
expect(marks).toHaveLength(1);
expect(marks[0].name).toBe('tableRendered');
expect(marks[0].detail).toEqual({
source: 'awsui',
instanceIdentifier: expect.any(String),
loading: true,
header: 'This is my table',
});
expect(marks[1].name).toBe('tableRendered');
expect(marks[1].detail).toEqual({
source: 'awsui',
instanceIdentifier: expect.any(String),
loading: false,
Expand All @@ -108,17 +77,10 @@ describe('Table', () => {
await expect(isElementPerformanceMarkExisting(marks[0].detail.instanceIdentifier)).resolves.toBeTruthy();
await page.click('#evaluateComponentVisibility');
marks = await getMarks();
expect(marks).toHaveLength(4);
expect(marks).toHaveLength(2);

expect(marks[2].name).toBe('tableUpdated');
expect(marks[2].detail).toEqual({
source: 'awsui',
instanceIdentifier: expect.any(String),
loading: true,
header: 'This is my table',
});
expect(marks[3].name).toBe('tableUpdated');
expect(marks[3].detail).toEqual({
expect(marks[1].name).toBe('tableUpdated');
expect(marks[1].detail).toEqual({
source: 'awsui',
instanceIdentifier: expect.any(String),
loading: false,
Expand Down
2 changes: 1 addition & 1 deletion src/table/internal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ const InternalTable = React.forwardRef(

const performanceMarkAttributes = usePerformanceMarks(
'table',
true,
() => !loading,
tableRefObject,
() => ({
loading: loading ?? false,
Expand Down
Loading