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

Core: Disable SidebarContextMenu in static builds #29743

Merged
merged 7 commits into from
Dec 2, 2024
Merged

Core: Disable SidebarContextMenu in static builds #29743

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
61a7b2a
disable SidebarContextMenu in static build
ndelangen Nov 29, 2024
d78f58d
Merge branch 'next' into norbert/no-context-in-prod
ndelangen Nov 29, 2024
351b2ac
Merge branch 'next' into norbert/no-context-in-prod
ndelangen Nov 29, 2024
0241fb3
fix tests
ndelangen Nov 29, 2024
65161ab
Merge branch 'norbert/no-context-in-prod' of https://github.com/story…
ndelangen Nov 29, 2024
60ec2fe
apply global for CONFIG_TYPE in the preview annotation
ndelangen Nov 29, 2024
0768cd1
Merge branch 'next' into norbert/no-context-in-prod
ndelangen Dec 2, 2024
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
1 change: 1 addition & 0 deletions code/.storybook/preview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { DocsPageWrapper } from '../lib/blocks/src/components';
import { isChromatic } from './isChromatic';

const { document } = global;
globalThis.CONFIG_TYPE = 'DEVELOPMENT';
Copy link
Contributor

Choose a reason for hiding this comment

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

style: setting CONFIG_TYPE globally could affect other parts of the codebase that rely on this value. Consider using an environment variable or configuration option instead

Comment on lines 24 to +25
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: this change forces development mode for all preview environments, which may have unintended consequences for production builds


const ThemeBlock = styled.div<{ side: 'left' | 'right'; layout: string }>(
{
Expand Down
13 changes: 11 additions & 2 deletions code/core/src/manager/components/sidebar/ContextMenu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ import type { API } from '@storybook/core/manager-api';
import type { Link } from '../../../components/components/tooltip/TooltipLinkList';
import { StatusButton } from './StatusButton';
import type { ExcludesNull } from './Tree';
import { ContextMenu } from './Tree';

const empty = {
onMouseEnter: () => {},
node: null,
};

export const useContextMenu = (context: API_HashEntry, links: Link[], api: API) => {
const [hoverCount, setHoverCount] = useState(0);
Expand All @@ -34,7 +38,7 @@ export const useContextMenu = (context: API_HashEntry, links: Link[], api: API)
}, []);

/**
* Calculate the providerLinks whenever the user mouses over the container. We use an incrementer,
* Calculate the providerLinks whenever the user mouses over the container. We use an incrementor,
* instead of a simple boolean to ensure that the links are recalculated
*/
const providerLinks = useMemo(() => {
Expand All @@ -51,6 +55,11 @@ export const useContextMenu = (context: API_HashEntry, links: Link[], api: API)
const isRendered = providerLinks.length > 0 || links.length > 0;

return useMemo(() => {
// Never show the SidebarContextMenu in production
if (globalThis.CONFIG_TYPE !== 'DEVELOPMENT') {
return empty;
}
Comment on lines +59 to +61
Copy link
Contributor

Choose a reason for hiding this comment

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

style: Consider using process.env.NODE_ENV instead of globalThis.CONFIG_TYPE for more reliable environment detection


return {
onMouseEnter: handlers.onMouseEnter,
node: isRendered ? (
Expand Down