TECH: Mock Service Worker (MSW) v2

packages/cli/package.json

@@ -112,6 +112,7 @@
     "config": "3.3.9",
     "cross-env": "7.0.3",
     "jest": "29.6.2",
+    "msw": "2.6.8",
     "nanoid": "3.3.4",
     "oclif": "3.7.3",
     "simple-git-hooks": "2.11.1",

packages/cli/src/mocks/handlers.ts

@@ -0,0 +1,8 @@
+import { http, HttpHandler, HttpResponse } from 'msw'
+import alertChannelsJson from './json/alert-channels.json'
+
+export const handlers: HttpHandler[] = [
+  http.get('https://api.checklyhq.com/v1/alert-channels', () => {
+    return HttpResponse.json(alertChannelsJson)
+  }),
+]

packages/cli/src/mocks/json/alert-channels.json

@@ -0,0 +1,64 @@
+[
+  {
+    "id": 240783,
+    "type": "SMS",
+    "config": {
+      "number": "+35612345678"
+    },
+    "created_at": "2024-12-02T10:18:24.012Z",
+    "updated_at": "2024-12-05T10:54:20.983Z",
+    "sendRecovery": false,
+    "sendFailure": true,
+    "sendDegraded": false,
+    "sslExpiry": true,
+    "sslExpiryThreshold": 25,
+    "autoSubscribe": false,
+    "subscriptions": [
+      {
+        "id": 12799454,
+        "checkId": "dde39bfb-f85a-4546-84d7-4085623dc4c9",
+        "activated": true,
+        "groupId": null
+      }
+    ]
+  },
+  {
+    "id": 240784,
+    "type": "EMAIL",
+    "config": {
+      "address": "[email protected]"
+    },
+    "created_at": "2024-12-02T10:18:24.020Z",
+    "updated_at": "2024-12-05T10:54:20.988Z",
+    "sendRecovery": false,
+    "sendFailure": true,
+    "sendDegraded": false,
+    "sslExpiry": true,
+    "sslExpiryThreshold": 25,
+    "autoSubscribe": false,
+    "subscriptions": [
+      {
+        "id": 12799455,
+        "checkId": "dde39bfb-f85a-4546-84d7-4085623dc4c9",
+        "activated": true,
+        "groupId": null
+      }
+    ]
+  },
+  {
+    "id": 240593,
+    "type": "EMAIL",
+    "config": {
+      "address": "[email protected]"
+    },
+    "created_at": "2024-11-28T17:24:33.252Z",
+    "updated_at": null,
+    "sendRecovery": true,
+    "sendFailure": true,
+    "sendDegraded": false,
+    "sslExpiry": false,
+    "sslExpiryThreshold": 30,
+    "autoSubscribe": false,
+    "subscriptions": []
+  }
+]

packages/cli/src/mocks/server.ts

@@ -0,0 +1,4 @@
+import { setupServer } from 'msw/node'
+import { handlers } from './handlers'
+
+export const server = setupServer(...handlers)

packages/cli/src/rest/__tests__/alert-channels.spec.ts

@@ -0,0 +1,23 @@
+/* TODO: add path aliases */
+import { server } from '../../mocks/server'
+import * as api from '../api'
+import alertChannelsJson from '../../mocks/json/alert-channels.json'
+
+describe('AlertChannels API REST', () => {
+  beforeAll(() => {
+    server.listen()
+  })
+
+  afterEach(() => {
+    server.resetHandlers()
+  })
+
+  afterAll(() => {
+    server.close()
+  })
+
+  it('can get data', async () => {
+    const { data } = await api.alertChannels.getAll()
+    expect(data).toEqual(alertChannelsJson)
+  })
+})

packages/cli/src/rest/alert-channels.ts

@@ -0,0 +1,39 @@
+import type { AxiosInstance } from 'axios'
+
+interface Subscription {
+  id: number;
+  checkId: string;
+  activated: boolean;
+  groupId: string | null;
+}
+
+export interface AlertChannelApi {
+  id: number;
+  type: string;
+  config: {
+    number?: string;
+    address?: string;
+  };
+  created_at: string;
+  updated_at: string | null;
+  sendRecovery: boolean;
+  sendFailure: boolean;
+  sendDegraded: boolean;
+  sslExpiry: boolean;
+  sslExpiryThreshold: number;
+  autoSubscribe: boolean;
+  subscriptions: Subscription[];
+}
+
+class AlertChannels {
+  protected api: AxiosInstance
+  constructor (api: AxiosInstance) {
+    this.api = api
+  }
+
+  getAll () {
+    return this.api.get<AlertChannelApi[]>('/v1/alert-channels')
+  }
+}
+
+export default AlertChannels

packages/cli/src/rest/api.ts

@@ -13,6 +13,7 @@ import TestSessions from './test-sessions'
 import EnvironmentVariables from './environment-variables'
 import HeartbeatChecks from './heartbeat-checks'
 import ChecklyStorage from './checkly-storage'
+import AlertChannels from './alert-channels';
 
 export function getDefaults () {
   const apiKey = config.getApiKey()
@@ -100,3 +101,4 @@ export const testSessions = new TestSessions(api)
 export const environmentVariables = new EnvironmentVariables(api)
 export const heartbeatCheck = new HeartbeatChecks(api)
 export const checklyStorage = new ChecklyStorage(api)
+export const alertChannels = new AlertChannels(api)

packages/cli/tsconfig.json

@@ -9,13 +9,13 @@
     "rootDirs": ["src", "e2e"],
     "strict": true,
     "target": "es2019",
-    "sourceMap": true
+    "sourceMap": true,
+    "resolveJsonModule": true
   },
   "include": [
     "src/**/*"
   ],
   "exclude": [
-    "src/**/__tests__",
     "e2e"
   ]
 }