issueAnalyticsEvents.tsx

import type {SourceMapProcessingIssueType} from 'sentry/components/events/interfaces/crashContent/exception/useSourceMapDebug';
import type {FieldValue} from 'sentry/components/forms/model';
import type {PriorityLevel} from 'sentry/types/group';
import type {IntegrationType} from 'sentry/types/integrations';
import type {Broadcast} from 'sentry/types/system';
import type {BaseEventAnalyticsParams} from 'sentry/utils/analytics/workflowAnalyticsEvents';
import type {CommonGroupAnalyticsData} from 'sentry/utils/events';

type IssueStream = {
  group_id: string;
  tab: string;
  was_shown_suggestion: boolean;
};

type SourceMapDebugParam = {
  type: SourceMapProcessingIssueType;
  group_id?: string;
} & BaseEventAnalyticsParams;

type ActionableItemDebugParam = {
  type: string;
  group_id?: string;
} & BaseEventAnalyticsParams;

type SourceMapWizardParam = {
  project_id: string;
  group_id?: string;
} & BaseEventAnalyticsParams;

interface GroupEventParams extends CommonGroupAnalyticsData, BaseEventAnalyticsParams {}

interface StreamlineGroupEventParams extends GroupEventParams {
  streamline: boolean;
}

interface EventDropdownParams {
  event_id: string;
  from_event_type: string;
  group_id: string;
  selected_event_type: string;
}

interface ExternalIssueParams extends CommonGroupAnalyticsData {
  external_issue_provider: string;
  external_issue_type: IntegrationType;
}

interface SetPriorityParams extends CommonGroupAnalyticsData {
  from_priority: PriorityLevel;
  to_priority: PriorityLevel;
}

export type IssueEventParameters = {
  'actionable_items.expand_clicked': ActionableItemDebugParam;
  'autofix.setup_modal_viewed': {
    groupId: string;
    projectId: string;
    setup_gen_ai_consent: boolean;
    setup_integration: boolean;
    setup_write_integration?: boolean;
  };
  'breadcrumbs.drawer.action': {control: string; value?: string};
  'breadcrumbs.issue_details.change_time_display': {value: string};
  'breadcrumbs.issue_details.drawer_opened': {control: string};
  'device.classification.high.end.android.device': {
    processor_count: number;
    processor_frequency: number;
    class?: string;
    family?: string;
    model?: string;
  };
  'device.classification.unclassified.ios.device': {
    model: string;
  };
  'event_cause.dismissed': {};
  'event_cause.docs_clicked': {};
  'event_cause.snoozed': {};
  'event_cause.viewed': {
    platform?: string;
    project_id?: string;
  };
  'highlights.edit_modal.add_context_key': {};
  'highlights.edit_modal.add_tag': {};
  'highlights.edit_modal.cancel_clicked': {};
  'highlights.edit_modal.remove_context_key': {};
  'highlights.edit_modal.remove_tag': {};
  'highlights.edit_modal.save_clicked': {};
  'highlights.edit_modal.use_default_clicked': {};
  'highlights.issue_details.edit_clicked': {};
  'highlights.issue_details.view_all_clicked': {};
  'highlights.project_settings.updated_manually': {};
  'integrations.integration_reinstall_clicked': {
    provider: string;
  };
  'issue-details.replay-cta-dismiss': {type: string};
  'issue.search_sidebar_clicked': {};
  'issue.share_from_icon': {};
  'issue.shared_publicly': {};
  'issue_details.comment_created': {streamline: boolean};
  'issue_details.comment_deleted': {streamline: boolean};
  'issue_details.comment_updated': {streamline: boolean};
  'issue_details.copy_event_id_clicked': StreamlineGroupEventParams;
  'issue_details.copy_event_link_clicked': StreamlineGroupEventParams;
  'issue_details.escalating_feedback_received': {
    group_id: string;
    is_high_priority: boolean;
  };
  'issue_details.escalating_issues_banner_feedback_received': {
    group_id: string;
    should_be_escalating: boolean;
    reason?: string;
  };
  'issue_details.event_details_clicked': GroupEventParams;
  'issue_details.event_dropdown_option_selected': EventDropdownParams;
  'issue_details.event_navigation_selected': {
    content: string;
  };
  'issue_details.external_issue_created': ExternalIssueParams;
  'issue_details.external_issue_loaded': ExternalIssueParams & {success: boolean};
  'issue_details.external_issue_modal_opened': ExternalIssueParams;
  'issue_details.header_view_replay_clicked': GroupEventParams;
  'issue_details.issue_content_selected': {
    content: string;
  };
  'issue_details.issue_status_docs_clicked': {};
  'issue_details.performance.autogrouped_siblings_toggle': {};
  'issue_details.performance.hidden_spans_expanded': {};
  'issue_details.related_trace_issue.trace_issue_clicked': {
    group_id: number;
  };
  'issue_details.section_fold': {
    open: boolean;
    sectionKey: string;
  };
  'issue_details.set_priority': SetPriorityParams;
  'issue_details.similar_issues.diff_clicked': {
    error_message?: string;
    group_id?: string;
    parent_error_message?: string;
    parent_group_id?: string;
    parent_stacktrace?: string;
    parent_transaction?: string;
    project_id?: string;
    shouldBeGrouped?: string;
    stacktrace?: string;
    transaction?: string;
  };
  'issue_details.similar_issues.similarity_embeddings_feedback_recieved': {
    groupId: string;
    parentGroupId: string;
    value: string;
    projectId?: string;
    wouldGroup?: string;
  };
  'issue_details.sourcemap_wizard_copy': SourceMapWizardParam;
  'issue_details.sourcemap_wizard_dismiss': SourceMapWizardParam;
  'issue_details.sourcemap_wizard_learn_more': SourceMapWizardParam;
  'issue_details.streamline_ui_toggle': {
    isEnabled: boolean;
  };
  'issue_details.view_full_trace_waterfall_clicked': {};
  'issue_details.view_hierarchy.hover_rendering_system': {
    platform?: string;
    user_org_role?: string;
  };
  'issue_details.view_hierarchy.select_from_tree': {
    platform?: string;
    user_org_role?: string;
  };
  'issue_details.view_hierarchy.select_from_wireframe': {
    platform?: string;
    user_org_role?: string;
  };
  'issue_error_banner.proguard_misconfigured.clicked': {
    group?: string;
    platform?: string;
  };
  'issue_error_banner.proguard_misconfigured.displayed': {
    group?: string;
    platform?: string;
  };
  'issue_error_banner.proguard_missing_mapping.displayed': {
    group?: string;
    platform?: string;
  };
  'issue_error_banner.viewed': {
    error_message: string[];
    error_type: string[];
    group?: string;
    platform?: string;
  };
  'issue_group_details.anr_root_cause_detected': {
    culprit?: string;
    group?: string;
  };
  'issue_group_details.stack_traces.setup_source_maps_alert.clicked': {
    platform?: string;
    project_id?: string;
  };
  'issue_group_details.tab.clicked': {
    tab: string;
    browser?: string;
    device?: string;
    os?: string;
    platform?: string;
  };
  'issue_group_details.tags.bar.clicked': {
    is_mobile: boolean;
    tag: string;
    value: string;
    platform?: string;
  };
  'issue_group_details.tags.show_all_tags.clicked': {
    is_mobile: boolean;
    platform?: string;
    tag?: string;
  };
  'issue_group_details.tags.switcher.clicked': {
    is_mobile: boolean;
    previous_tag: string;
    tag: string;
    platform?: string;
  };
  'issue_group_details.tags_distribution.bar.clicked': {
    is_mobile: boolean;
    tag: string;
    value: string;
    platform?: string;
  };
  'issue_search.empty': {
    query: string;
    search_source: string;
    search_type: string;
  };
  'issue_search.failed': {
    error: string;
    search_source: string;
    search_type: string;
  };
  'issue_views.add_view.all_saved_searches_saved': {};
  'issue_views.add_view.banner_dismissed': {};
  'issue_views.add_view.clicked': {};
  'issue_views.add_view.custom_query_saved': {
    query: string;
  };
  'issue_views.add_view.recommended_view_saved': {
    label: string;
    persisted: boolean;
    query: string;
  };
  'issue_views.add_view.saved_search_saved': {
    query: string;
  };
  'issue_views.deleted_view': {};
  'issue_views.discarded_changes': {};
  'issue_views.duplicated_view': {};
  'issue_views.renamed_view': {};
  'issue_views.reordered_views': {};
  'issue_views.saved_changes': {};
  'issue_views.shared_view_opened': {
    query: string;
  };
  'issue_views.switched_views': {};
  'issue_views.temp_view_discarded': {};
  'issue_views.temp_view_saved': {};
  'issues_stream.archived': {
    action_status_details?: string;
    action_substatus?: string | null;
  };
  'issues_stream.issue_assigned': IssueStream & {
    assigned_type: string;
    did_assign_suggestion: boolean;
    assigned_suggestion_reason?: string;
  };
  'issues_stream.merged': {
    items_merged: number | 'all_in_query' | undefined;
    platform: string | undefined;
    project_id: string | undefined;
  };
  'issues_stream.paginate': {
    direction: string;
  };
  'issues_stream.realtime_clicked': {
    enabled: boolean;
  };
  'issues_stream.sort_changed': {
    sort: string;
  };
  'issues_stream.updated_priority': {
    priority: PriorityLevel;
  };
  'issues_tab.viewed': {
    issue_views_enabled: boolean;
    num_issues: number;
    num_new_issues: number;
    num_old_issues: number;
    num_perf_issues: number;
    page: number;
    query: string;
    sort: string;
    total_issues_count: number | null;
    tab?: string;
  };
  'one_other_related_trace_issue.clicked': {
    area: string;
    // Equivalent to 'issue_details.related_trace_issue.trace_issue_clicked', but `area` is dynamic.
    group_id: number;
  };
  'project_modal.created': {
    issue_alert: 'Default' | 'Custom' | 'No Rule';
    project_id: string;
    rule_id: string;
  };
  'quick_trace.connected_services': {
    projects: number;
  };
  'quick_trace.dropdown.clicked': {
    node_key: string;
  };
  'quick_trace.dropdown.clicked_extra': {
    node_key: string;
  };
  'quick_trace.missing_service.dismiss': {
    platform: string;
  };
  'quick_trace.missing_service.docs': {
    platform: string;
  };
  'quick_trace.node.clicked': {
    node_key: string;
  };
  'quick_trace.trace_id.clicked': {
    source: string;
  };
  resolve_issue: {release: string};
  'settings.inbound_filter_updated': {
    filter: string;
    new_state: FieldValue;
    project_id: number;
  };
  'source_map_debug.docs_link_clicked': SourceMapDebugParam;
  'source_map_debug.expand_clicked': SourceMapDebugParam;
  'span_view.embedded_child.hide': {};
  'span_view.embedded_child.show': {};
  'tag.clicked': {
    is_clickable: boolean;
  };
  'whats_new.link_clicked': Pick<Broadcast, 'title'> &
    Partial<Pick<Broadcast, 'category'>>;
};

export type IssueEventKey = keyof IssueEventParameters;

export const issueEventMap: Record<IssueEventKey, string | null> = {
  'autofix.setup_modal_viewed': 'Autofix: Setup Modal Viewed',
  'breadcrumbs.issue_details.change_time_display': 'Breadcrumb Time Display Toggled',
  'breadcrumbs.issue_details.drawer_opened': 'Breadcrumb Drawer Opened',
  'breadcrumbs.drawer.action': 'Breadcrumb Drawer Action Taken',
  'event_cause.viewed': null,
  'event_cause.docs_clicked': 'Event Cause Docs Clicked',
  'event_cause.snoozed': 'Event Cause Snoozed',
  'event_cause.dismissed': 'Event Cause Dismissed',
  'highlights.edit_modal.add_context_key': 'Highlights: Add Context in Edit Modal',
  'highlights.edit_modal.add_tag': 'Highlights: Add Tag in Edit Modal',
  'highlights.edit_modal.cancel_clicked': 'Highlights: Cancel from Edit Modal',
  'highlights.edit_modal.remove_context_key': 'Highlights: Remove Context in Edit Modal',
  'highlights.edit_modal.remove_tag': 'Highlights: Remove Tag in Edit Modal',
  'highlights.edit_modal.save_clicked': 'Highlights: Save from Edit Modal',
  'highlights.edit_modal.use_default_clicked':
    'Highlights: Defaults Applied from Edit Modal',
  'highlights.issue_details.edit_clicked': 'Highlights: Open Edit Modal',
  'highlights.issue_details.view_all_clicked': 'Highlights: View All Clicked',
  'highlights.project_settings.updated_manually':
    'Highlights: Updated Manually from Settings',
  'issue_details.escalating_feedback_received':
    'Issue Details: Escalating Feedback Received',
  'issue_details.escalating_issues_banner_feedback_received':
    'Issue Details: Escalating Issues Banner Feedback Received',
  'issue_details.event_navigation_selected': 'Issue Details: Event Navigation Selected',
  'issue_details.issue_content_selected': 'Issue Details: Issue Content Selected',
  'issue_details.similar_issues.diff_clicked':
    'Issue Details: Similar Issues: Diff Clicked',
  'issue_details.similar_issues.similarity_embeddings_feedback_recieved':
    'Issue Details: Similar Issues: Similarity Embeddings Feedback Recieved',
  'issue_details.streamline_ui_toggle': 'Streamline: UI Toggle Clicked',
  'issue_details.view_hierarchy.hover_rendering_system':
    'View Hierarchy: Hovered rendering system icon',
  'issue_details.view_hierarchy.select_from_tree': 'View Hierarchy: Selection from tree',
  'issue_details.view_hierarchy.select_from_wireframe':
    'View Hierarchy: Selection from wireframe',
  'issue_details.issue_status_docs_clicked': 'Issue Details: Issue Status Docs Clicked',
  'issue_details.related_trace_issue.trace_issue_clicked':
    'Related Issue: Trace Issue Clicked',
  'issue_error_banner.viewed': 'Issue Error Banner Viewed',
  'issue_error_banner.proguard_misconfigured.displayed':
    'Proguard Potentially Misconfigured Issue Error Banner Displayed',
  'issue_error_banner.proguard_missing_mapping.displayed':
    'Proguard Missing Mapping Issue Error Banner Displayed',
  'issue_error_banner.proguard_misconfigured.clicked':
    'Proguard Potentially Misconfigured Issue Error Banner Link Clicked',
  'issues_tab.viewed': 'Viewed Issues Tab',
  'issue_views.switched_views': 'Issue Views: Switched Views',
  'issue_views.saved_changes': 'Issue Views: Updated View',
  'issue_views.discarded_changes': 'Issue Views: Discarded Changes',
  'issue_views.renamed_view': 'Issue Views: Renamed View',
  'issue_views.duplicated_view': 'Issue Views: Duplicated View',
  'issue_views.deleted_view': 'Issue Views: Deleted View',
  'issue_views.reordered_views': 'Issue Views: Views Reordered',
  'issue_views.add_view.clicked': 'Issue Views: Add View Clicked',
  'issue_views.add_view.custom_query_saved':
    'Issue Views: Custom Query Saved From Add View',
  'issue_views.add_view.saved_search_saved': 'Issue Views: Saved Search Saved',
  'issue_views.add_view.all_saved_searches_saved':
    'Issue Views: All Saved Searches Saved',
  'issue_views.add_view.recommended_view_saved': 'Issue Views: Recommended View Saved',
  'issue_views.add_view.banner_dismissed': 'Issue Views: Add View Banner Dismissed',
  'issue_views.shared_view_opened': 'Issue Views: Shared View Opened',
  'issue_views.temp_view_discarded': 'Issue Views: Temporary View Discarded',
  'issue_views.temp_view_saved': 'Issue Views: Temporary View Saved',
  'issue_search.failed': 'Issue Search: Failed',
  'issue_search.empty': 'Issue Search: Empty',
  'issue.search_sidebar_clicked': 'Issue Search Sidebar Clicked',
  'issues_stream.archived': 'Issues Stream: Archived',
  'issues_stream.updated_priority': 'Issues Stream: Updated Priority',
  'issues_stream.realtime_clicked': 'Issues Stream: Realtime Clicked',
  'issues_stream.issue_assigned': 'Assigned Issue from Issues Stream',
  'issues_stream.merged': 'Merged Issues from Issues Stream',
  'issues_stream.sort_changed': 'Changed Sort on Issues Stream',
  'issues_stream.paginate': 'Paginate Issues Stream',
  'issue.shared_publicly': 'Issue Shared Publicly',
  'issue.share_from_icon': 'Issue Share Opened from Icon',
  'issue_group_details.stack_traces.setup_source_maps_alert.clicked':
    'Issue Group Details: Setup Source Maps Alert Clicked',
  resolve_issue: 'Resolve Issue',
  'tag.clicked': 'Tag: Clicked',
  'project_modal.created': 'Project Modal: Created',
  'quick_trace.missing_service.dismiss': 'Quick Trace: Missing Service Dismissed',
  'quick_trace.missing_service.docs': 'Quick Trace: Missing Service Clicked',
  'quick_trace.dropdown.clicked': 'Quick Trace: Dropdown clicked',
  'quick_trace.dropdown.clicked_extra': 'Quick Trace: Dropdown clicked',
  'quick_trace.node.clicked': 'Quick Trace: Node clicked',
  'quick_trace.connected_services': 'Quick Trace: Connected Services',
  'quick_trace.trace_id.clicked': 'Quick Trace: Trace ID clicked',
  'settings.inbound_filter_updated': 'Settings: Inbound Filter Updated',
  'span_view.embedded_child.hide': 'Span View: Hide Embedded Transaction',
  'span_view.embedded_child.show': 'Span View: Show Embedded Transaction',
  'issue_group_details.tab.clicked': 'Issue Group Details: Header Tab Clicked',
  'issue_group_details.tags.show_all_tags.clicked':
    'Issue Group Details: Tags show all clicked',
  'issue_group_details.tags.switcher.clicked':
    'Issue Group Details: Tags switcher clicked',
  'issue_group_details.tags.bar.clicked': 'Issue Group Details: Tags value bar clicked',
  'issue_group_details.tags_distribution.bar.clicked':
    'Issue Group Details: Tags distribution value bar clicked',
  'integrations.integration_reinstall_clicked': 'Integration Reinstall Button Clicked',
  'one_other_related_trace_issue.clicked': 'One Other Related Trace Issue Clicked',
  'issue_details.view_full_trace_waterfall_clicked':
    ' Issue Details: View Full Trace Waterfall Clicked',

  // Performance Issue specific events here
  'issue_details.performance.autogrouped_siblings_toggle':
    'Performance Issue Details: Autogrouped Siblings Toggled',
  'issue_details.performance.hidden_spans_expanded':
    'Performance Issue Details: Hidden Spans Expanded',
  'source_map_debug.docs_link_clicked': 'Source Map Debug: Docs Clicked',
  'source_map_debug.expand_clicked': 'Source Map Debug: Expand Clicked',
  'actionable_items.expand_clicked': 'Actionable Item: Expand Clicked',
  'issue_details.copy_event_link_clicked': 'Issue Details: Copy Event Link Clicked',
  'issue_details.copy_event_id_clicked': 'Issue Details: Copy Event ID Clicked',
  'issue_details.event_details_clicked': 'Issue Details: Full Event Details Clicked',
  'issue_details.event_dropdown_option_selected':
    'Issue Details: Event Dropdown Option Selected',
  'issue_details.header_view_replay_clicked': 'Issue Details: Header View Replay Clicked',
  'issue-details.replay-cta-dismiss': 'Issue Details Replay CTA Dismissed',
  'issue_group_details.anr_root_cause_detected': 'Detected ANR Root Cause',
  'issue_details.external_issue_loaded': 'Issue Details: External Issue Loaded',
  'issue_details.external_issue_modal_opened':
    'Issue Details: External Issue Modal Opened',
  'issue_details.external_issue_created': 'Issue Details: External Issue Created',
  'device.classification.unclassified.ios.device':
    'Event from iOS device missing device.class',
  'device.classification.high.end.android.device': 'Event from high end Android device',
  'issue_details.sourcemap_wizard_dismiss': 'Issue Details: Sourcemap Wizard Dismiss',
  'issue_details.sourcemap_wizard_copy': 'Issue Details: Sourcemap Wizard Copy',
  'issue_details.sourcemap_wizard_learn_more':
    'Issue Details: Sourcemap Wizard Learn More',
  'issue_details.set_priority': 'Issue Details: Set Priority',
  'issue_details.section_fold': 'Issue Details: Section Fold',
  'issue_details.comment_created': 'Issue Details: Comment Created',
  'issue_details.comment_deleted': 'Issue Details: Comment Deleted',
  'issue_details.comment_updated': 'Issue Details: Comment Updated',
  'whats_new.link_clicked': "What's New: Link Clicked",
};