Browse Source

ref(breadcrumbs): Rename breadcrumbs types (#28853)

Priscila Oliveira 3 years ago
parent
commit
f550ddd165

+ 2 - 2
static/app/components/events/interfaces/breadcrumbs/breadcrumb/data/index.tsx

@@ -1,5 +1,5 @@
 import {Organization} from 'app/types';
 import {Organization} from 'app/types';
-import {Breadcrumb, BreadcrumbType} from 'app/types/breadcrumbs';
+import {BreadcrumbType, RawCrumb} from 'app/types/breadcrumbs';
 import {Event} from 'app/types/event';
 import {Event} from 'app/types/event';
 
 
 import Default from './default';
 import Default from './default';
@@ -8,7 +8,7 @@ import Http from './http';
 
 
 type Props = {
 type Props = {
   searchTerm: string;
   searchTerm: string;
-  breadcrumb: Breadcrumb;
+  breadcrumb: RawCrumb;
   event: Event;
   event: Event;
   orgSlug: Organization['slug'];
   orgSlug: Organization['slug'];
 };
 };

+ 2 - 2
static/app/components/events/interfaces/breadcrumbs/breadcrumb/index.tsx

@@ -4,7 +4,7 @@ import styled from '@emotion/styled';
 
 
 import space from 'app/styles/space';
 import space from 'app/styles/space';
 import {Organization} from 'app/types';
 import {Organization} from 'app/types';
-import {BreadcrumbsWithDetails, BreadcrumbType} from 'app/types/breadcrumbs';
+import {BreadcrumbType, Crumb} from 'app/types/breadcrumbs';
 import {Event} from 'app/types/event';
 import {Event} from 'app/types/event';
 
 
 import Category from './category';
 import Category from './category';
@@ -14,7 +14,7 @@ import Time from './time';
 import Type from './type';
 import Type from './type';
 
 
 type Props = {
 type Props = {
-  breadcrumb: BreadcrumbsWithDetails[0];
+  breadcrumb: Crumb;
   event: Event;
   event: Event;
   orgSlug: Organization['slug'];
   orgSlug: Organization['slug'];
   searchTerm: string;
   searchTerm: string;

+ 2 - 2
static/app/components/events/interfaces/breadcrumbs/breadcrumbs.tsx

@@ -13,7 +13,7 @@ import Tooltip from 'app/components/tooltip';
 import {IconSwitch} from 'app/icons';
 import {IconSwitch} from 'app/icons';
 import {t} from 'app/locale';
 import {t} from 'app/locale';
 import space from 'app/styles/space';
 import space from 'app/styles/space';
-import {BreadcrumbsWithDetails} from 'app/types/breadcrumbs';
+import {Crumb} from 'app/types/breadcrumbs';
 
 
 import Breadcrumb from './breadcrumb';
 import Breadcrumb from './breadcrumb';
 
 
@@ -28,7 +28,7 @@ type Props = Pick<
   React.ComponentProps<typeof Breadcrumb>,
   React.ComponentProps<typeof Breadcrumb>,
   'event' | 'orgSlug' | 'searchTerm' | 'relativeTime' | 'displayRelativeTime'
   'event' | 'orgSlug' | 'searchTerm' | 'relativeTime' | 'displayRelativeTime'
 > & {
 > & {
-  breadcrumbs: BreadcrumbsWithDetails;
+  breadcrumbs: Crumb[];
   onSwitchTimeFormat: () => void;
   onSwitchTimeFormat: () => void;
   emptyMessage: Pick<
   emptyMessage: Pick<
     React.ComponentProps<typeof PanelTable>,
     React.ComponentProps<typeof PanelTable>,

+ 8 - 8
static/app/components/events/interfaces/breadcrumbs/index.tsx

@@ -11,10 +11,10 @@ import {t} from 'app/locale';
 import space from 'app/styles/space';
 import space from 'app/styles/space';
 import {Organization} from 'app/types';
 import {Organization} from 'app/types';
 import {
 import {
-  Breadcrumb,
   BreadcrumbLevelType,
   BreadcrumbLevelType,
-  BreadcrumbsWithDetails,
   BreadcrumbType,
   BreadcrumbType,
+  Crumb,
+  RawCrumb,
 } from 'app/types/breadcrumbs';
 } from 'app/types/breadcrumbs';
 import {EntryType, Event} from 'app/types/event';
 import {EntryType, Event} from 'app/types/event';
 import {defined} from 'app/utils';
 import {defined} from 'app/utils';
@@ -42,15 +42,15 @@ type Props = {
   organization: Organization;
   organization: Organization;
   type: string;
   type: string;
   data: {
   data: {
-    values: Array<Breadcrumb>;
+    values: Array<RawCrumb>;
   };
   };
 };
 };
 
 
 type State = {
 type State = {
   searchTerm: string;
   searchTerm: string;
-  breadcrumbs: BreadcrumbsWithDetails;
-  filteredByFilter: BreadcrumbsWithDetails;
-  filteredBySearch: BreadcrumbsWithDetails;
+  breadcrumbs: Crumb[];
+  filteredByFilter: Crumb[];
+  filteredBySearch: Crumb[];
   filterOptions: FilterOptions;
   filterOptions: FilterOptions;
   displayRelativeTime: boolean;
   displayRelativeTime: boolean;
   relativeTime?: string;
   relativeTime?: string;
@@ -170,7 +170,7 @@ function BreadcrumbsContainer({data, event, organization, type: eventType}: Prop
     return filterLevels;
     return filterLevels;
   }
   }
 
 
-  function filterBySearch(newSearchTerm: string, crumbs: BreadcrumbsWithDetails) {
+  function filterBySearch(newSearchTerm: string, crumbs: Crumb[]) {
     if (!newSearchTerm.trim()) {
     if (!newSearchTerm.trim()) {
       return crumbs;
       return crumbs;
     }
     }
@@ -248,7 +248,7 @@ function BreadcrumbsContainer({data, event, organization, type: eventType}: Prop
     return match[1];
     return match[1];
   }
   }
 
 
-  function getVirtualCrumb(): Breadcrumb | undefined {
+  function getVirtualCrumb(): RawCrumb | undefined {
     const exception = event.entries.find(entry => entry.type === EntryType.EXCEPTION);
     const exception = event.entries.find(entry => entry.type === EntryType.EXCEPTION);
 
 
     if (!exception && !event.message) {
     if (!exception && !event.message) {

+ 5 - 5
static/app/components/events/interfaces/breadcrumbs/utils.tsx

@@ -1,13 +1,13 @@
 import {t} from 'app/locale';
 import {t} from 'app/locale';
 import {
 import {
-  Breadcrumb,
   BreadcrumbLevelType,
   BreadcrumbLevelType,
-  BreadcrumbsWithDetails,
   BreadcrumbType,
   BreadcrumbType,
+  Crumb,
+  RawCrumb,
 } from 'app/types/breadcrumbs';
 } from 'app/types/breadcrumbs';
 import {defined} from 'app/utils';
 import {defined} from 'app/utils';
 
 
-function convertCrumbType(breadcrumb: Breadcrumb): Breadcrumb {
+function convertCrumbType(breadcrumb: RawCrumb): RawCrumb {
   if (breadcrumb.type === BreadcrumbType.EXCEPTION) {
   if (breadcrumb.type === BreadcrumbType.EXCEPTION) {
     return {
     return {
       ...breadcrumb,
       ...breadcrumb,
@@ -62,7 +62,7 @@ function convertCrumbType(breadcrumb: Breadcrumb): Breadcrumb {
 
 
 function getCrumbDescriptionAndColor(
 function getCrumbDescriptionAndColor(
   type: BreadcrumbType
   type: BreadcrumbType
-): Pick<BreadcrumbsWithDetails[0], 'color' | 'description'> {
+): Pick<Crumb, 'color' | 'description'> {
   switch (type) {
   switch (type) {
     case BreadcrumbType.USER:
     case BreadcrumbType.USER:
     case BreadcrumbType.UI:
     case BreadcrumbType.UI:
@@ -134,7 +134,7 @@ function getCrumbDescriptionAndColor(
   }
   }
 }
 }
 
 
-export function transformCrumbs(breadcrumbs: Array<Breadcrumb>): BreadcrumbsWithDetails {
+export function transformCrumbs(breadcrumbs: Array<RawCrumb>): Crumb[] {
   return breadcrumbs.map((breadcrumb, index) => {
   return breadcrumbs.map((breadcrumb, index) => {
     const convertedCrumbType = convertCrumbType(breadcrumb);
     const convertedCrumbType = convertCrumbType(breadcrumb);
     const {color, description} = getCrumbDescriptionAndColor(convertedCrumbType.type);
     const {color, description} = getCrumbDescriptionAndColor(convertedCrumbType.type);

+ 6 - 4
static/app/types/breadcrumbs.tsx

@@ -95,11 +95,13 @@ export type BreadcrumbTypeDefault = {
   data?: Record<string, any>;
   data?: Record<string, any>;
 } & BreadcrumbTypeBase;
 } & BreadcrumbTypeBase;
 
 
-export type Breadcrumb =
+export type RawCrumb =
   | BreadcrumbTypeNavigation
   | BreadcrumbTypeNavigation
   | BreadcrumbTypeHTTP
   | BreadcrumbTypeHTTP
   | BreadcrumbTypeDefault;
   | BreadcrumbTypeDefault;
 
 
-export type BreadcrumbsWithDetails = Array<
-  Breadcrumb & {description: string; color: Color; id: number}
->;
+export type Crumb = RawCrumb & {
+  description: string;
+  color: Color;
+  id: number;
+};

+ 2 - 2
static/app/types/event.tsx

@@ -1,7 +1,7 @@
 import {DebugImage} from 'app/components/events/interfaces/debugMeta/types';
 import {DebugImage} from 'app/components/events/interfaces/debugMeta/types';
 import {TraceContextType} from 'app/components/events/interfaces/spans/types';
 import {TraceContextType} from 'app/components/events/interfaces/spans/types';
 
 
-import {Breadcrumb} from './breadcrumbs';
+import {RawCrumb} from './breadcrumbs';
 import {Thread} from './events';
 import {Thread} from './events';
 import {StacktraceType} from './stacktrace';
 import {StacktraceType} from './stacktrace';
 import {
 import {
@@ -41,7 +41,7 @@ type EntryDebugMeta = {
 type EntryBreadcrumbs = {
 type EntryBreadcrumbs = {
   type: EntryType.BREADCRUMBS;
   type: EntryType.BREADCRUMBS;
   data: {
   data: {
-    values: Array<Breadcrumb>;
+    values: Array<RawCrumb>;
   };
   };
 };
 };