Files
2024-02-15 17:01:50 +00:00

187 lines
5.0 KiB
TypeScript

import {Fragment, useMemo} from 'react';
import styled from '@emotion/styled';
import HookOrDefault from 'sentry/components/hookOrDefault';
import ExternalLink from 'sentry/components/links/externalLink';
import List from 'sentry/components/list';
import ListItem from 'sentry/components/list/listItem';
import {AuthTokenGeneratorProvider} from 'sentry/components/onboarding/gettingStartedDoc/authTokenGenerator';
import {Step} from 'sentry/components/onboarding/gettingStartedDoc/step';
import type {
ConfigType,
Docs,
DocsParams,
} from 'sentry/components/onboarding/gettingStartedDoc/types';
import {useSourcePackageRegistries} from 'sentry/components/onboarding/gettingStartedDoc/useSourcePackageRegistries';
import {
PlatformOptionsControl,
useUrlPlatformOptions,
} from 'sentry/components/onboarding/platformOptionsControl';
import {
ProductSelection,
ProductSolution,
} from 'sentry/components/onboarding/productSelection';
import {t} from 'sentry/locale';
import {space} from 'sentry/styles/space';
import type {PlatformKey, Project} from 'sentry/types';
import useOrganization from 'sentry/utils/useOrganization';
const ProductSelectionAvailabilityHook = HookOrDefault({
hookName: 'component:product-selection-availability',
defaultComponent: ProductSelection,
});
export type OnboardingLayoutProps = {
docsConfig: Docs<any>;
dsn: string;
platformKey: PlatformKey;
projectId: Project['id'];
projectSlug: Project['slug'];
activeProductSelection?: ProductSolution[];
cdn?: string;
configType?: ConfigType;
newOrg?: boolean;
};
const EMPTY_ARRAY: never[] = [];
export function OnboardingLayout({
cdn,
docsConfig,
dsn,
platformKey,
projectId,
projectSlug,
activeProductSelection = EMPTY_ARRAY,
newOrg,
configType = 'onboarding',
}: OnboardingLayoutProps) {
const organization = useOrganization();
const {isLoading: isLoadingRegistry, data: registryData} =
useSourcePackageRegistries(organization);
const selectedOptions = useUrlPlatformOptions(docsConfig.platformOptions);
const {platformOptions} = docsConfig;
const {introduction, steps, nextSteps} = useMemo(() => {
const doc = docsConfig[configType] ?? docsConfig.onboarding;
const docParams: DocsParams<any> = {
cdn,
dsn,
organization,
platformKey,
projectId,
projectSlug,
isPerformanceSelected: activeProductSelection.includes(
ProductSolution.PERFORMANCE_MONITORING
),
isProfilingSelected: activeProductSelection.includes(ProductSolution.PROFILING),
isReplaySelected: activeProductSelection.includes(ProductSolution.SESSION_REPLAY),
sourcePackageRegistries: {
isLoading: isLoadingRegistry,
data: registryData,
},
platformOptions: selectedOptions,
newOrg,
};
return {
introduction: doc.introduction?.(docParams),
steps: [
...doc.install(docParams),
...doc.configure(docParams),
...doc.verify(docParams),
],
nextSteps: doc.nextSteps?.(docParams) || [],
};
}, [
cdn,
activeProductSelection,
docsConfig,
dsn,
isLoadingRegistry,
newOrg,
organization,
platformKey,
projectId,
projectSlug,
registryData,
selectedOptions,
configType,
]);
return (
<AuthTokenGeneratorProvider projectSlug={projectSlug}>
<Wrapper>
<Header>
{introduction && <div>{introduction}</div>}
{configType === 'onboarding' && (
<ProductSelectionAvailabilityHook
organization={organization}
platform={platformKey}
/>
)}
{platformOptions && !['customMetricsOnboarding'].includes(configType) ? (
<PlatformOptionsControl platformOptions={platformOptions} />
) : null}
</Header>
<Divider withBottomMargin />
<Steps>
{steps.map(step => (
<Step key={step.title ?? step.type} {...step} />
))}
</Steps>
{nextSteps.length > 0 && (
<Fragment>
<Divider />
<h4>{t('Next Steps')}</h4>
<List symbol="bullet">
{nextSteps.map(step => (
<ListItem key={step.name}>
<ExternalLink href={step.link}>{step.name}</ExternalLink>
{': '}
{step.description}
</ListItem>
))}
</List>
</Fragment>
)}
</Wrapper>
</AuthTokenGeneratorProvider>
);
}
const Header = styled('div')`
display: flex;
flex-direction: column;
gap: ${space(2)};
`;
const Divider = styled('hr')<{withBottomMargin?: boolean}>`
height: 1px;
width: 100%;
background: ${p => p.theme.border};
border: none;
${p => p.withBottomMargin && `margin-bottom: ${space(3)}`}
`;
const Steps = styled('div')`
display: flex;
flex-direction: column;
gap: 1.5rem;
`;
const Wrapper = styled('div')`
h4 {
margin-bottom: 0.5em;
}
&& {
p {
margin-bottom: 0;
}
h5 {
margin-bottom: 0;
}
}
`;