guides.tsx 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. import * as Sentry from '@sentry/react';
  2. import {fetchOrganizationDetails} from 'sentry/actionCreators/organization';
  3. import {Client} from 'sentry/api';
  4. import ConfigStore from 'sentry/stores/configStore';
  5. import GuideStore from 'sentry/stores/guideStore';
  6. import type {Organization} from 'sentry/types/organization';
  7. import {trackAnalytics} from 'sentry/utils/analytics';
  8. import {isDemoModeEnabled} from 'sentry/utils/demoMode';
  9. import {getDemoGuides, getTourTask} from 'sentry/utils/demoMode/guides';
  10. import {demoEndModal} from './modal';
  11. import {updateOnboardingTask} from './onboardingTasks';
  12. const api = new Client();
  13. export async function fetchGuides() {
  14. try {
  15. if (isDemoModeEnabled()) {
  16. GuideStore.fetchSucceeded(getDemoGuides());
  17. return;
  18. }
  19. const data = await api.requestPromise('/assistant/');
  20. GuideStore.fetchSucceeded(data);
  21. } catch (err) {
  22. if (err.status !== 401 && err.status !== 403) {
  23. Sentry.captureException(err);
  24. }
  25. }
  26. }
  27. export function registerAnchor(target: string) {
  28. GuideStore.registerAnchor(target);
  29. }
  30. export function unregisterAnchor(target: string) {
  31. GuideStore.unregisterAnchor(target);
  32. }
  33. export function nextStep() {
  34. GuideStore.nextStep();
  35. }
  36. export function setForceHide(forceHide: boolean) {
  37. GuideStore.setForceHide(forceHide);
  38. }
  39. export function toStep(step: number) {
  40. GuideStore.toStep(step);
  41. }
  42. export function closeGuide(dismissed?: boolean) {
  43. GuideStore.closeGuide(dismissed);
  44. }
  45. export function dismissGuide(guide: string, step: number, orgId: string | null) {
  46. recordDismiss(guide, step, orgId);
  47. closeGuide(true);
  48. }
  49. export function recordFinish(
  50. guide: string,
  51. orgId: string | null,
  52. orgSlug: string | null,
  53. org: Organization | null
  54. ) {
  55. if (!isDemoModeEnabled()) {
  56. api.requestPromise('/assistant/', {
  57. method: 'PUT',
  58. data: {
  59. guide,
  60. status: 'viewed',
  61. },
  62. });
  63. }
  64. const tourTask = getTourTask(guide);
  65. if (isDemoModeEnabled() && tourTask && org) {
  66. const {tour, task} = tourTask;
  67. updateOnboardingTask(api, org, {task, status: 'complete', completionSeen: true});
  68. fetchOrganizationDetails(api, org.slug, true, false);
  69. demoEndModal({tour, orgSlug});
  70. }
  71. const user = ConfigStore.get('user');
  72. if (!user) {
  73. return;
  74. }
  75. trackAnalytics('assistant.guide_finished', {
  76. organization: orgId,
  77. guide,
  78. });
  79. }
  80. export function recordDismiss(guide: string, step: number, orgId: string | null) {
  81. if (!isDemoModeEnabled()) {
  82. api.requestPromise('/assistant/', {
  83. method: 'PUT',
  84. data: {
  85. guide,
  86. status: 'dismissed',
  87. },
  88. });
  89. }
  90. const user = ConfigStore.get('user');
  91. if (!user) {
  92. return;
  93. }
  94. trackAnalytics('assistant.guide_dismissed', {
  95. organization: orgId,
  96. guide,
  97. step,
  98. });
  99. }