frameworkSuggestionModal.tsx 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  1. import {Fragment, useCallback, useEffect, useState} from 'react';
  2. import {css} from '@emotion/react';
  3. import styled from '@emotion/styled';
  4. import {PlatformIcon} from 'platformicons';
  5. import onboardingFrameworkSelectionJavascript from 'sentry-images/spot/onboarding-framework-selection-javascript.svg';
  6. import onboardingFrameworkSelectionNode from 'sentry-images/spot/onboarding-framework-selection-node.svg';
  7. import onboardingFrameworkSelectionPython from 'sentry-images/spot/onboarding-framework-selection-python.svg';
  8. import {ModalRenderProps} from 'sentry/actionCreators/modal';
  9. import {Button} from 'sentry/components/button';
  10. import {RadioLineItem} from 'sentry/components/forms/controls/radioGroup';
  11. import List from 'sentry/components/list';
  12. import ListItem from 'sentry/components/list/listItem';
  13. import {Panel, PanelBody} from 'sentry/components/panels';
  14. import Radio from 'sentry/components/radio';
  15. import categoryList from 'sentry/data/platformCategories';
  16. import platforms from 'sentry/data/platforms';
  17. import {t} from 'sentry/locale';
  18. import {space} from 'sentry/styles/space';
  19. import {OnboardingSelectedSDK, Organization} from 'sentry/types';
  20. import {trackAnalytics} from 'sentry/utils/analytics';
  21. import TextBlock from 'sentry/views/settings/components/text/textBlock';
  22. export enum SUPPORTED_LANGUAGES {
  23. JAVASCRIPT = 'javascript',
  24. PYTHON = 'python',
  25. NODE = 'node',
  26. }
  27. export const languageDetails = {
  28. [SUPPORTED_LANGUAGES.JAVASCRIPT]: {
  29. description: t(
  30. 'Our JavaScript framework SDK’s include all the features of our Browser Javascript SDK with additional features specific to that framework'
  31. ),
  32. topFrameworksImage: onboardingFrameworkSelectionJavascript,
  33. },
  34. [SUPPORTED_LANGUAGES.NODE]: {
  35. description: t(
  36. 'Our Node framework SDK’s include all the features of our Node SDK with instructions specific to that framework'
  37. ),
  38. topFrameworksImage: onboardingFrameworkSelectionNode,
  39. },
  40. [SUPPORTED_LANGUAGES.PYTHON]: {
  41. description: t(
  42. 'Our Python framework SDK’s include all the features of our Python SDK with instructions specific to that framework'
  43. ),
  44. topFrameworksImage: onboardingFrameworkSelectionPython,
  45. },
  46. };
  47. type Props = ModalRenderProps & {
  48. onConfigure: (selectedFramework: OnboardingSelectedSDK) => void;
  49. onSkip: () => void;
  50. organization: Organization;
  51. selectedPlatform: OnboardingSelectedSDK;
  52. newOrg?: boolean;
  53. };
  54. export function FrameworkSuggestionModal({
  55. Body,
  56. Footer,
  57. selectedPlatform,
  58. onSkip,
  59. onConfigure,
  60. closeModal,
  61. CloseButton,
  62. organization,
  63. newOrg,
  64. }: Props) {
  65. const [selectedFramework, setSelectedFramework] = useState<
  66. OnboardingSelectedSDK | undefined
  67. >(undefined);
  68. const frameworks = platforms.filter(
  69. platform =>
  70. platform.type === 'framework' && platform.language === selectedPlatform.key
  71. );
  72. useEffect(() => {
  73. trackAnalytics(
  74. newOrg
  75. ? 'onboarding.select_framework_modal_rendered'
  76. : 'project_creation.select_framework_modal_rendered',
  77. {
  78. platform: selectedPlatform.key,
  79. organization,
  80. }
  81. );
  82. }, [selectedPlatform.key, organization, newOrg]);
  83. const handleConfigure = useCallback(() => {
  84. if (!selectedFramework) {
  85. return;
  86. }
  87. trackAnalytics(
  88. newOrg
  89. ? 'onboarding.select_framework_modal_configure_sdk_button_clicked'
  90. : 'project_creation.select_framework_modal_configure_sdk_button_clicked',
  91. {
  92. platform: selectedPlatform.key,
  93. framework: selectedFramework.key,
  94. organization,
  95. }
  96. );
  97. onConfigure(selectedFramework);
  98. closeModal();
  99. }, [
  100. selectedPlatform,
  101. selectedFramework,
  102. organization,
  103. onConfigure,
  104. closeModal,
  105. newOrg,
  106. ]);
  107. const handleSkip = useCallback(() => {
  108. trackAnalytics(
  109. newOrg
  110. ? 'onboarding.select_framework_modal_skip_button_clicked'
  111. : 'project_creation.select_framework_modal_skip_button_clicked',
  112. {
  113. platform: selectedPlatform.key,
  114. organization,
  115. }
  116. );
  117. onSkip();
  118. closeModal();
  119. }, [selectedPlatform, organization, closeModal, onSkip, newOrg]);
  120. return (
  121. <Fragment>
  122. <Header>
  123. <CloseButton onClick={closeModal} />
  124. </Header>
  125. <Body>
  126. <TopFrameworksImage
  127. src={languageDetails[selectedPlatform.key].topFrameworksImage}
  128. />
  129. <Heading>{t('Do you use a framework?')}</Heading>
  130. <Description>{languageDetails[selectedPlatform.key].description}</Description>
  131. <Panel>
  132. <PanelBody>
  133. <Frameworks>
  134. {frameworks.map((framework, index) => {
  135. const frameworkCategory =
  136. categoryList.find(category => {
  137. return category.platforms.includes(framework.id as never);
  138. })?.id ?? 'all';
  139. return (
  140. <Framework key={framework.id}>
  141. <RadioLabel
  142. index={index}
  143. onClick={() =>
  144. setSelectedFramework({
  145. key: framework.id,
  146. type: framework.type,
  147. language: framework.language,
  148. category: frameworkCategory,
  149. })
  150. }
  151. >
  152. <RadioBox
  153. radioSize="small"
  154. checked={selectedFramework?.key === framework.id}
  155. readOnly
  156. />
  157. <FrameworkIcon size={24} platform={framework.id} />
  158. {framework.name}
  159. </RadioLabel>
  160. </Framework>
  161. );
  162. })}
  163. </Frameworks>
  164. </PanelBody>
  165. </Panel>
  166. </Body>
  167. <Footer>
  168. <Actions>
  169. <Button size="md" onClick={handleSkip}>
  170. {t('Skip')}
  171. </Button>
  172. <Button
  173. size="md"
  174. priority="primary"
  175. onClick={handleConfigure}
  176. disabled={!selectedFramework}
  177. title={!selectedFramework ? t('Select a framework to configure') : undefined}
  178. >
  179. {t('Configure SDK')}
  180. </Button>
  181. </Actions>
  182. </Footer>
  183. </Fragment>
  184. );
  185. }
  186. const Header = styled('header')`
  187. position: relative;
  188. height: 30px;
  189. margin: -${space(4)} -${space(2)} 0 -${space(3)};
  190. @media (min-width: ${p => p.theme.breakpoints.medium}) {
  191. margin: -${space(4)} -${space(4)} 0 -${space(4)};
  192. }
  193. `;
  194. const TopFrameworksImage = styled('img')`
  195. margin-bottom: ${space(2)};
  196. `;
  197. const Heading = styled('h6')`
  198. margin-bottom: ${space(1)};
  199. text-align: center;
  200. `;
  201. const Description = styled(TextBlock)`
  202. margin-bottom: ${space(2)};
  203. text-align: center;
  204. `;
  205. const Frameworks = styled(List)`
  206. max-height: 240px;
  207. overflow-y: auto;
  208. `;
  209. const Framework = styled(ListItem)`
  210. height: 40px;
  211. display: grid;
  212. text-align: left;
  213. cursor: pointer;
  214. :not(:last-child) {
  215. border-bottom: 1px solid ${p => p.theme.border};
  216. }
  217. `;
  218. const FrameworkIcon = styled(PlatformIcon)`
  219. border: 1px solid ${p => p.theme.innerBorder};
  220. `;
  221. const RadioLabel = styled(RadioLineItem)`
  222. display: inline-grid;
  223. grid-template-columns: max-content max-content 1fr;
  224. align-items: center;
  225. padding: ${space(1)} ${space(1.5)};
  226. gap: ${space(1.5)};
  227. input {
  228. cursor: pointer;
  229. }
  230. `;
  231. const RadioBox = styled(Radio)`
  232. padding: ${space(0.5)};
  233. `;
  234. const Actions = styled('div')`
  235. display: grid;
  236. grid-template-columns: 1fr 1fr;
  237. gap: ${space(1)};
  238. width: 100%;
  239. `;
  240. export const modalCss = css`
  241. max-width: 400px;
  242. width: 100%;
  243. `;