Skip to content

Commit d83c0e5

Browse files
committed
refactor(tasks): create subdirectory for alerts code
The alerts code and some of our private source tasks are becoming complex enough for multiple files. In order to keep the code clearer to debug and read, this commit moves the check alerts tasks into a subdirectory for just alert related code.
1 parent 778092d commit d83c0e5

File tree

8 files changed

+29
-24
lines changed

8 files changed

+29
-24
lines changed

packages/api/src/tasks/__tests__/checkAlerts.test.ts renamed to packages/api/src/tasks/checkAlerts/__tests__/checkAlerts.test.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,19 @@ import {
2727
getPreviousAlertHistories,
2828
processAlert,
2929
} from '@/tasks/checkAlerts';
30-
import { AlertDetails, AlertTaskType, loadProvider } from '@/tasks/providers';
30+
import {
31+
AlertDetails,
32+
AlertTaskType,
33+
loadProvider,
34+
} from '@/tasks/checkAlerts/providers';
3135
import {
3236
AlertMessageTemplateDefaultView,
3337
buildAlertMessageTemplateHdxLink,
3438
buildAlertMessageTemplateTitle,
3539
getDefaultExternalAction,
3640
renderAlertTemplate,
3741
translateExternalActionsToInternal,
38-
} from '@/tasks/template';
42+
} from '@/tasks/checkAlerts/template';
3943
import * as slack from '@/utils/slack';
4044

4145
// Create provider instance for tests

packages/api/src/tasks/__tests__/checkAlertsTask.test.ts renamed to packages/api/src/tasks/checkAlerts/__tests__/checkAlertsTask.test.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@ import { ObjectId } from '@/models';
66
import { AlertSource, AlertThresholdType, IAlert } from '@/models/alert';
77
import { ISource } from '@/models/source';
88
import { IWebhook } from '@/models/webhook';
9-
import CheckAlertTask from '@/tasks/checkAlerts';
109
import * as checkAlerts from '@/tasks/checkAlerts';
10+
import CheckAlertTask from '@/tasks/checkAlerts';
1111
import {
1212
AlertDetails,
1313
AlertProvider,
1414
AlertTaskType,
1515
loadProvider,
16-
} from '@/tasks/providers';
17-
18-
import { CheckAlertsTaskArgs } from '../types';
16+
} from '@/tasks/checkAlerts/providers';
17+
import { CheckAlertsTaskArgs } from '@/tasks/types';
1918

20-
jest.mock('@/tasks/providers', () => {
19+
jest.mock('@/tasks/checkAlerts/providers', () => {
2120
return {
22-
...jest.requireActual('@/tasks/providers'),
21+
...jest.requireActual('@/tasks/checkAlerts/providers'),
2322
loadProvider: jest.fn(),
2423
};
2524
});

packages/api/src/tasks/__tests__/singleInvocationAlert.test.ts renamed to packages/api/src/tasks/checkAlerts/__tests__/singleInvocationAlert.test.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,11 @@ import { SavedSearch } from '@/models/savedSearch';
1515
import { Source } from '@/models/source';
1616
import Webhook from '@/models/webhook';
1717
import { processAlert } from '@/tasks/checkAlerts';
18-
import { AlertDetails, AlertTaskType, loadProvider } from '@/tasks/providers';
18+
import {
19+
AlertDetails,
20+
AlertTaskType,
21+
loadProvider,
22+
} from '@/tasks/checkAlerts/providers';
1923
import * as slack from '@/utils/slack';
2024

2125
describe('Single Invocation Alert Test', () => {

packages/api/src/tasks/checkAlerts.ts renamed to packages/api/src/tasks/checkAlerts/index.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,14 @@ import {
2828
AlertTask,
2929
AlertTaskType,
3030
loadProvider,
31-
} from '@/tasks/providers';
31+
} from '@/tasks/checkAlerts/providers';
3232
import {
3333
AlertMessageTemplateDefaultView,
3434
buildAlertMessageTemplateTitle,
3535
handleSendGenericWebhook,
3636
renderAlertTemplate,
37-
} from '@/tasks/template';
37+
} from '@/tasks/checkAlerts/template';
38+
import { tasksTracer } from '@/tasks/tracer';
3839
import { CheckAlertsTaskArgs, HdxTask } from '@/tasks/types';
3940
import {
4041
calcAlertDateRange,
@@ -43,8 +44,6 @@ import {
4344
} from '@/tasks/util';
4445
import logger from '@/utils/logger';
4546

46-
import { tasksTracer } from './tracer';
47-
4847
export const doesExceedThreshold = (
4948
thresholdType: AlertThresholdType,
5049
threshold: number,

packages/api/src/tasks/providers/__tests__/default.test.ts renamed to packages/api/src/tasks/checkAlerts/providers/__tests__/default.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {
1212
AlertProvider,
1313
AlertTaskType,
1414
loadProvider,
15-
} from '@/tasks/providers/index';
15+
} from '@/tasks/checkAlerts/providers';
1616

1717
const MOCK_SAVED_SEARCH: any = {
1818
id: 'fake-saved-search-id',

packages/api/src/tasks/providers/default.ts renamed to packages/api/src/tasks/checkAlerts/providers/default.ts

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,12 @@ import {
1919
type AlertProvider,
2020
type AlertTask,
2121
AlertTaskType,
22-
} from '@/tasks/providers';
22+
} from '@/tasks/checkAlerts/providers';
23+
import { MappedOmit } from '@/tasks/types';
2324
import { convertMsToGranularityString } from '@/utils/common';
2425
import logger from '@/utils/logger';
2526

26-
import {
27-
AggregatedAlertHistory,
28-
getPreviousAlertHistories,
29-
} from '../checkAlerts';
30-
import { MappedOmit } from '../types';
27+
import { AggregatedAlertHistory, getPreviousAlertHistories } from '..';
3128

3229
type PartialAlertDetails = MappedOmit<AlertDetails, 'previous'>;
3330

packages/api/src/tasks/providers/index.ts renamed to packages/api/src/tasks/checkAlerts/providers/index.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ import { IDashboard } from '@/models/dashboard';
1010
import { ISavedSearch } from '@/models/savedSearch';
1111
import { ISource } from '@/models/source';
1212
import { IWebhook } from '@/models/webhook';
13-
import DefaultAlertProvider from '@/tasks/providers/default';
13+
import DefaultAlertProvider from '@/tasks/checkAlerts/providers/default';
1414
import logger from '@/utils/logger';
1515

16-
import { AggregatedAlertHistory } from '../checkAlerts';
17-
import { CheckAlertsTaskArgs } from '../types';
16+
import { AggregatedAlertHistory } from '..';
1817

1918
export enum AlertTaskType {
2019
SAVED_SEARCH,

packages/api/src/tasks/template.ts renamed to packages/api/src/tasks/checkAlerts/template.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ import { ISavedSearch } from '@/models/savedSearch';
2424
import { ISource } from '@/models/source';
2525
import { IWebhook } from '@/models/webhook';
2626
import { doesExceedThreshold } from '@/tasks/checkAlerts';
27-
import { AlertProvider, PopulatedAlertChannel } from '@/tasks/providers';
27+
import {
28+
AlertProvider,
29+
PopulatedAlertChannel,
30+
} from '@/tasks/checkAlerts/providers';
2831
import { escapeJsonString, unflattenObject } from '@/tasks/util';
2932
import { truncateString } from '@/utils/common';
3033
import logger from '@/utils/logger';

0 commit comments

Comments
 (0)