issues.tsx 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. import {Client} from 'sentry/api';
  2. import {joinQuery, parseSearch, Token} from 'sentry/components/searchSyntax/parser';
  3. import {t} from 'sentry/locale';
  4. import GroupStore from 'sentry/stores/groupStore';
  5. import {Group, Organization, PageFilters} from 'sentry/types';
  6. import {getIssueFieldRenderer} from 'sentry/utils/dashboards/issueFieldRenderers';
  7. import {getUtcDateString} from 'sentry/utils/dates';
  8. import {TableData, TableDataRow} from 'sentry/utils/discover/discoverQuery';
  9. import {
  10. DISCOVER_EXCLUSION_FIELDS,
  11. getSortLabel,
  12. IssueSortOptions,
  13. } from 'sentry/views/issueList/utils';
  14. import {DEFAULT_TABLE_LIMIT, DisplayType, WidgetQuery} from '../types';
  15. import {IssuesSearchBar} from '../widgetBuilder/buildSteps/filterResultsStep/issuesSearchBar';
  16. import {ISSUE_FIELD_TO_HEADER_MAP} from '../widgetBuilder/issueWidget/fields';
  17. import {generateIssueWidgetFieldOptions} from '../widgetBuilder/issueWidget/utils';
  18. import {DatasetConfig} from './base';
  19. const DEFAULT_WIDGET_QUERY: WidgetQuery = {
  20. name: '',
  21. fields: ['issue', 'assignee', 'title'] as string[],
  22. columns: ['issue', 'assignee', 'title'],
  23. fieldAliases: [],
  24. aggregates: [],
  25. conditions: '',
  26. orderby: IssueSortOptions.DATE,
  27. };
  28. const DEFAULT_SORT = IssueSortOptions.DATE;
  29. const DEFAULT_EXPAND = ['owners'];
  30. type EndpointParams = Partial<PageFilters['datetime']> & {
  31. environment: string[];
  32. project: number[];
  33. collapse?: string[];
  34. cursor?: string;
  35. expand?: string[];
  36. groupStatsPeriod?: string | null;
  37. limit?: number;
  38. page?: number | string;
  39. query?: string;
  40. sort?: string;
  41. statsPeriod?: string | null;
  42. };
  43. export const IssuesConfig: DatasetConfig<never, Group[]> = {
  44. defaultWidgetQuery: DEFAULT_WIDGET_QUERY,
  45. enableEquations: false,
  46. disableSortOptions,
  47. getTableRequest,
  48. getCustomFieldRenderer: getIssueFieldRenderer,
  49. SearchBar: IssuesSearchBar,
  50. getTableSortOptions,
  51. getTableFieldOptions: (_organization: Organization) =>
  52. generateIssueWidgetFieldOptions(),
  53. fieldHeaderMap: ISSUE_FIELD_TO_HEADER_MAP,
  54. supportedDisplayTypes: [DisplayType.TABLE],
  55. transformTable: transformIssuesResponseToTable,
  56. };
  57. function disableSortOptions(_widgetQuery: WidgetQuery) {
  58. return {
  59. disableSort: false,
  60. disableSortDirection: true,
  61. disableSortReason: t('Issues dataset does not yet support descending order'),
  62. };
  63. }
  64. function getTableSortOptions(organization: Organization, _widgetQuery: WidgetQuery) {
  65. const hasBetterPrioritySort = organization.features.includes(
  66. 'issue-list-better-priority-sort'
  67. );
  68. const sortOptions = [
  69. ...(hasBetterPrioritySort ? [IssueSortOptions.BETTER_PRIORITY] : []), // show better priority for EA orgs
  70. IssueSortOptions.DATE,
  71. IssueSortOptions.NEW,
  72. ...(hasBetterPrioritySort ? [] : [IssueSortOptions.PRIORITY]), // hide regular priority for EA orgs
  73. IssueSortOptions.FREQ,
  74. IssueSortOptions.USER,
  75. ];
  76. return sortOptions.map(sortOption => ({
  77. label: getSortLabel(sortOption),
  78. value: sortOption,
  79. }));
  80. }
  81. export function transformIssuesResponseToTable(
  82. data: Group[],
  83. widgetQuery: WidgetQuery,
  84. _organization: Organization,
  85. pageFilters: PageFilters
  86. ): TableData {
  87. GroupStore.add(data);
  88. const transformedTableResults: TableDataRow[] = [];
  89. data.forEach(
  90. ({
  91. id,
  92. shortId,
  93. title,
  94. lifetime,
  95. filtered,
  96. count,
  97. userCount,
  98. project,
  99. annotations,
  100. ...resultProps
  101. }) => {
  102. const transformedResultProps: Omit<TableDataRow, 'id'> = {};
  103. Object.keys(resultProps)
  104. .filter(key => ['number', 'string'].includes(typeof resultProps[key]))
  105. .forEach(key => {
  106. transformedResultProps[key] = resultProps[key];
  107. });
  108. const transformedTableResult: TableDataRow = {
  109. ...transformedResultProps,
  110. events: count,
  111. users: userCount,
  112. id,
  113. 'issue.id': id,
  114. issue: shortId,
  115. title,
  116. project: project.slug,
  117. links: annotations?.join(', '),
  118. };
  119. // Get lifetime stats
  120. if (lifetime) {
  121. transformedTableResult.lifetimeEvents = lifetime?.count;
  122. transformedTableResult.lifetimeUsers = lifetime?.userCount;
  123. }
  124. // Get filtered stats
  125. if (filtered) {
  126. transformedTableResult.filteredEvents = filtered?.count;
  127. transformedTableResult.filteredUsers = filtered?.userCount;
  128. }
  129. // Discover Url properties
  130. const query = widgetQuery.conditions;
  131. const parsedResult = parseSearch(query);
  132. const filteredTerms = parsedResult?.filter(
  133. p => !(p.type === Token.FILTER && DISCOVER_EXCLUSION_FIELDS.includes(p.key.text))
  134. );
  135. transformedTableResult.discoverSearchQuery = joinQuery(filteredTerms, true);
  136. transformedTableResult.projectId = project.id;
  137. const {period, start, end} = pageFilters.datetime || {};
  138. if (start && end) {
  139. transformedTableResult.start = getUtcDateString(start);
  140. transformedTableResult.end = getUtcDateString(end);
  141. }
  142. transformedTableResult.period = period ?? '';
  143. transformedTableResults.push(transformedTableResult);
  144. }
  145. );
  146. return {data: transformedTableResults} as TableData;
  147. }
  148. function getTableRequest(
  149. api: Client,
  150. query: WidgetQuery,
  151. organization: Organization,
  152. pageFilters: PageFilters,
  153. limit?: number,
  154. cursor?: string
  155. ) {
  156. const groupListUrl = `/organizations/${organization.slug}/issues/`;
  157. const params: EndpointParams = {
  158. project: pageFilters.projects ?? [],
  159. environment: pageFilters.environments ?? [],
  160. query: query.conditions,
  161. sort: query.orderby || DEFAULT_SORT,
  162. expand: DEFAULT_EXPAND,
  163. limit: limit ?? DEFAULT_TABLE_LIMIT,
  164. cursor,
  165. };
  166. if (pageFilters.datetime.period) {
  167. params.statsPeriod = pageFilters.datetime.period;
  168. }
  169. if (pageFilters.datetime.end) {
  170. params.end = getUtcDateString(pageFilters.datetime.end);
  171. }
  172. if (pageFilters.datetime.start) {
  173. params.start = getUtcDateString(pageFilters.datetime.start);
  174. }
  175. if (pageFilters.datetime.utc) {
  176. params.utc = pageFilters.datetime.utc;
  177. }
  178. return api.requestPromise(groupListUrl, {
  179. includeAllArgs: true,
  180. method: 'GET',
  181. data: {
  182. ...params,
  183. },
  184. });
  185. }