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: Performance bug fix to emit marks for only first tab #3182

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Performance bug fix to emit marks for only first tab #3182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions src/internal/context/tab-context.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { createContext, useContext } from 'react';
export interface TabContextProps {
isInFirstTab: boolean | null;
}
export const TabContext = createContext<TabContextProps>({
isInFirstTab: null,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest to change this to isInDefaultTab or hasTabChanged. First tab means the first one from the left and the default tab might not be that one.

});
export const useTabContext = () => {
return useContext(TabContext);
};
7 changes: 5 additions & 2 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 @@ -4,6 +4,7 @@
import { useEffect, useState } from 'react';

import { useModalContext } from '../../context/modal-context';
import { useTabContext } from '../../context/tab-context';
import { useDOMAttribute } from '../use-dom-attribute';
import { useEffectOnUpdate } from '../use-effect-on-update';
import { useRandomId } from '../use-unique-id';
Expand Down Expand Up @@ -48,10 +49,11 @@
) {
const id = useRandomId();
const { isInModal } = useModalContext();
const { isInFirstTab } = useTabContext();
const attributes = useDOMAttribute(elementRef, 'data-analytics-performance-mark', id);
const evaluateComponentVisibility = useEvaluateComponentVisibility();
useEffect(() => {
if (!enabled() || !elementRef.current || isInModal) {
if (!enabled || !elementRef.current || isInModal || isInFirstTab === false) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have changed !enabled() to enabled. Is this on purpose?

The type of enabled is still function.

components/src/internal/hooks/use-performance-marks/index.ts

Line 44 in e1c488b

enabled: () => boolean,

return;
}
const elementVisible =
Expand All @@ -64,6 +66,7 @@
}

const renderedMarkName = `${name}Rendered`;
console.log('mark');

Check warning on line 69 in src/internal/hooks/use-performance-marks/index.ts

View check run for this annotation

Codecov / codecov/patch

src/internal/hooks/use-performance-marks/index.ts#L69 

Added line #L69 was not covered by tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a left-over.

performance.mark(renderedMarkName, {
detail: {
source: 'awsui',
Expand All @@ -75,7 +78,7 @@
}, []);

useEffectOnUpdate(() => {
if (!enabled() || !elementRef.current || isInModal) {
if (!enabled || !elementRef.current || isInModal || isInFirstTab === false) {
return;
}
const elementVisible =
Expand Down
13 changes: 12 additions & 1 deletion src/tabs/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { getAnalyticsMetadataAttribute } from '@cloudscape-design/component-tool

import InternalContainer from '../container/internal';
import { getBaseProps } from '../internal/base-component';
import { TabContext } from '../internal/context/tab-context';
import { fireNonCancelableEvent } from '../internal/events';
import useBaseComponent from '../internal/hooks/use-base-component';
import { useControllable } from '../internal/hooks/use-controllable';
Expand Down Expand Up @@ -96,7 +97,17 @@ export default function Tabs({
};

const isContentShown = isTabSelected && !selectedTab.disabled;
return <div {...contentAttributes}>{isContentShown && selectedTab.content}</div>;
const firstTab = firstEnabledTab(tabs);

return (
<TabContext.Provider
value={{
isInFirstTab: firstTab !== null && firstTab.id === tab.id,
}}
>
<div {...contentAttributes}>{isContentShown && selectedTab.content}</div>
</TabContext.Provider>
);
};

return (
Expand Down
Loading