Skip to content

feat(nav): Update replay onboarding to use drawer #85267

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

Merged
merged 2 commits into from
Feb 14, 2025
Merged

feat(nav): Update replay onboarding to use drawer #85267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27b5a8d
feat(nav): Update replay onboarding to use drawer
malwilley Feb 14, 2025
16d6098
Add 'Legacy' to old component name
malwilley Feb 14, 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
18 changes: 14 additions & 4 deletions static/app/components/feedback/feedbackOnboarding/sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,26 @@ export function useFeedbackOnboardingDrawer() {

useEffect(() => {
if (isActive && hasProjectAccess) {
openDrawer(() => <SidebarContent />, {
openDrawer(() => <DrawerContent />, {
ariaLabel: t('Getting Started with User Feedback'),
onClose: () => {
SidebarPanelStore.hidePanel();
},
// Prevent the drawer from closing when the query params change
shouldCloseOnLocationChange: location =>
Copy link
Member Author

Choose a reason for hiding this comment

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

Realized that we needed to add some options to the feedback one to make it work correctly.

This is very similar to the replay onboarding one, so I think there is an opportunity for a common hook or component. Don't want to make that abstraction too early though, going to wait until after I convert more of these

location.pathname !== window.location.pathname,
});
}
}, [isActive, hasProjectAccess, openDrawer]);
}

function DrawerContent() {
useEffect(() => {
return () => {
SidebarPanelStore.hidePanel();
};
}, []);

return <SidebarContent />;
}

// Used by legacy navigation
function LegacyFeedbackOnboardingSidebar(props: CommonSidebarProps) {
const {currentPanel, collapsed, hidePanel, orientation} = props;
Expand Down
68 changes: 57 additions & 11 deletions static/app/components/replaysOnboarding/sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type {ReactNode} from 'react';
import {Fragment, useMemo, useState} from 'react';
import {Fragment, useEffect, useMemo, useState} from 'react';
import styled from '@emotion/styled';
import {PlatformIcon} from 'platformicons';

Expand All @@ -8,6 +8,7 @@ import HighlightTopRightPattern from 'sentry-images/pattern/highlight-top-right.
import {LinkButton} from 'sentry/components/button';
import {CompactSelect} from 'sentry/components/compactSelect';
import RadioGroup from 'sentry/components/forms/controls/radioGroup';
import useDrawer from 'sentry/components/globalDrawer';
import IdBadge from 'sentry/components/idBadge';
import LoadingIndicator from 'sentry/components/loadingIndicator';
import useCurrentProjectState from 'sentry/components/onboarding/gettingStartedDoc/utils/useCurrentProjectState';
Expand All @@ -29,19 +30,67 @@ import {
} from 'sentry/data/platformCategories';
import platforms, {otherPlatform} from 'sentry/data/platforms';
import {t, tct} from 'sentry/locale';
import SidebarPanelStore from 'sentry/stores/sidebarPanelStore';
import {useLegacyStore} from 'sentry/stores/useLegacyStore';
import {space} from 'sentry/styles/space';
import type {SelectValue} from 'sentry/types/core';
import type {PlatformKey, Project} from 'sentry/types/project';
import useOrganization from 'sentry/utils/useOrganization';
import useUrlParams from 'sentry/utils/useUrlParams';

function ReplaysOnboardingSidebar(props: CommonSidebarProps) {
export function useReplaysOnboardingDrawer() {
const organization = useOrganization();
const currentPanel = useLegacyStore(SidebarPanelStore);
const isActive = currentPanel === SidebarPanelKey.REPLAYS_ONBOARDING;
const hasProjectAccess = organization.access.includes('project:read');

const {openDrawer} = useDrawer();

useEffect(() => {
if (isActive && hasProjectAccess) {
openDrawer(() => <DrawerContent />, {
ariaLabel: t('Getting Started with Session Replay'),
// Prevent the drawer from closing when the query params change
shouldCloseOnLocationChange: location =>
location.pathname !== window.location.pathname,
});
}
}, [isActive, hasProjectAccess, openDrawer]);
}

function DrawerContent() {
useEffect(() => {
return () => {
SidebarPanelStore.hidePanel();
};
}, []);

return <SidebarContent />;
}

function LegacyReplaysOnboardingSidebar(props: CommonSidebarProps) {
const {currentPanel, collapsed, hidePanel, orientation} = props;
const organization = useOrganization();

const isActive = currentPanel === SidebarPanelKey.REPLAYS_ONBOARDING;
const hasProjectAccess = organization.access.includes('project:read');

if (!isActive || !hasProjectAccess) {
return null;
}

return (
<TaskSidebarPanel
orientation={orientation}
collapsed={collapsed}
hidePanel={hidePanel}
>
<SidebarContent />
</TaskSidebarPanel>
);
}

function SidebarContent() {
const {
hasDocs,
projects,
Expand All @@ -51,7 +100,7 @@ function ReplaysOnboardingSidebar(props: CommonSidebarProps) {
supportedProjects,
unsupportedProjects,
} = useCurrentProjectState({
currentPanel,
currentPanel: SidebarPanelKey.REPLAYS_ONBOARDING,
targetPanel: SidebarPanelKey.REPLAYS_ONBOARDING,
onboardingPlatforms: replayOnboardingPlatforms,
allPlatforms: replayPlatforms,
Expand Down Expand Up @@ -102,16 +151,13 @@ function ReplaysOnboardingSidebar(props: CommonSidebarProps) {
}, [supportedProjects, unsupportedProjects]);

const selectedProject = currentProject ?? projects[0] ?? allProjects[0];
if (!isActive || !hasProjectAccess || !selectedProject) {

if (!selectedProject) {
return null;
}

return (
<TaskSidebarPanel
orientation={orientation}
collapsed={collapsed}
hidePanel={hidePanel}
>
<Fragment>
<TopRightBackgroundImage src={HighlightTopRightPattern} />
<TaskList>
<Heading>{t('Getting Started with Session Replay')}</Heading>
Expand Down Expand Up @@ -150,7 +196,7 @@ function ReplaysOnboardingSidebar(props: CommonSidebarProps) {
</HeaderActions>
<OnboardingContent currentProject={selectedProject} hasDocs={hasDocs} />
</TaskList>
</TaskSidebarPanel>
</Fragment>
);
}

Expand Down Expand Up @@ -445,4 +491,4 @@ const StyledRadioGroup = styled(RadioGroup)`
padding: ${space(1)} 0;
`;

export default ReplaysOnboardingSidebar;
export default LegacyReplaysOnboardingSidebar;
2 changes: 2 additions & 0 deletions static/app/views/organizationLayout/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import Footer from 'sentry/components/footer';
import HookOrDefault from 'sentry/components/hookOrDefault';
import Nav from 'sentry/components/nav';
import {NavContextProvider} from 'sentry/components/nav/context';
import {useReplaysOnboardingDrawer} from 'sentry/components/replaysOnboarding/sidebar';
import SentryDocumentTitle from 'sentry/components/sentryDocumentTitle';
import Sidebar from 'sentry/components/sidebar';
import type {Organization} from 'sentry/types/organization';
Expand Down Expand Up @@ -58,6 +59,7 @@ interface LayoutProps extends Props {

function AppLayout({children, organization}: LayoutProps) {
useFeedbackOnboardingDrawer();
useReplaysOnboardingDrawer();

return (
<NavContextProvider>
Expand Down
Loading