adds createdAt and updatedAt fields to alerting (#53793) (#53952)

When users are writing UI's they need to see when an alert was created and when it was last updated, to this end we've added these two fields on the alert type.
elastic · Jan 3, 2020 · 851f37d · 851f37d
1 parent 9f885ed
commit 851f37d
Show file tree

Hide file tree

Showing 16 changed files with 139 additions and 25 deletions.
diff --git a/x-pack/legacy/plugins/alerting/mappings.json b/x-pack/legacy/plugins/alerting/mappings.json
@@ -54,6 +54,9 @@
       "updatedBy": {
         "type": "keyword"
       },
+      "createdAt": {
+        "type": "date"
+      },
       "apiKey": {
         "type": "binary"
       },

diff --git a/x-pack/legacy/plugins/alerting/server/alerts_client.test.ts b/x-pack/legacy/plugins/alerting/server/alerts_client.test.ts
@@ -100,6 +100,7 @@ describe('create()', () => {
         params: {
           bar: true,
         },
+        createdAt: '2019-02-12T21:01:22.479Z',
         actions: [
           {
             group: 'default',
@@ -160,6 +161,7 @@ describe('create()', () => {
           },
         ],
         "alertTypeId": "123",
+        "createdAt": 2019-02-12T21:01:22.479Z,
         "id": "1",
         "params": Object {
           "bar": true,
@@ -168,6 +170,7 @@ describe('create()', () => {
           "interval": "10s",
         },
         "scheduledTaskId": "task-123",
+        "updatedAt": 2019-02-12T21:01:22.479Z,
       }
     `);
     expect(savedObjectsClient.create).toHaveBeenCalledTimes(1);
@@ -189,6 +192,7 @@ describe('create()', () => {
         "apiKey": null,
         "apiKeyOwner": null,
         "consumer": "bar",
+        "createdAt": "2019-02-12T21:01:22.479Z",
         "createdBy": "elastic",
         "enabled": true,
         "muteAll": false,
@@ -311,6 +315,7 @@ describe('create()', () => {
         params: {
           bar: true,
         },
+        createdAt: new Date().toISOString(),
         actions: [
           {
             group: 'default',
@@ -407,6 +412,7 @@ describe('create()', () => {
           },
         ],
         "alertTypeId": "123",
+        "createdAt": 2019-02-12T21:01:22.479Z,
         "id": "1",
         "params": Object {
           "bar": true,
@@ -415,6 +421,7 @@ describe('create()', () => {
           "interval": "10s",
         },
         "scheduledTaskId": "task-123",
+        "updatedAt": 2019-02-12T21:01:22.479Z,
       }
     `);
     expect(savedObjectsClient.bulkGet).toHaveBeenCalledWith([
@@ -460,6 +467,7 @@ describe('create()', () => {
         params: {
           bar: true,
         },
+        createdAt: new Date().toISOString(),
         actions: [
           {
             group: 'default',
@@ -493,6 +501,7 @@ describe('create()', () => {
           },
         ],
         "alertTypeId": "123",
+        "createdAt": 2019-02-12T21:01:22.479Z,
         "enabled": false,
         "id": "1",
         "params": Object {
@@ -501,6 +510,7 @@ describe('create()', () => {
         "schedule": Object {
           "interval": 10000,
         },
+        "updatedAt": 2019-02-12T21:01:22.479Z,
       }
     `);
     expect(savedObjectsClient.create).toHaveBeenCalledTimes(1);
@@ -806,6 +816,7 @@ describe('create()', () => {
         apiKey: Buffer.from('123:abc').toString('base64'),
         apiKeyOwner: 'elastic',
         createdBy: 'elastic',
+        createdAt: '2019-02-12T21:01:22.479Z',
         updatedBy: 'elastic',
         enabled: true,
         schedule: { interval: '10s' },
@@ -1248,13 +1259,15 @@ describe('get()', () => {
           },
         ],
         "alertTypeId": "123",
+        "createdAt": 2019-02-12T21:01:22.479Z,
         "id": "1",
         "params": Object {
           "bar": true,
         },
         "schedule": Object {
           "interval": "10s",
         },
+        "updatedAt": 2019-02-12T21:01:22.479Z,
       }
     `);
     expect(savedObjectsClient.get).toHaveBeenCalledTimes(1);
@@ -1347,13 +1360,15 @@ describe('find()', () => {
               },
             ],
             "alertTypeId": "123",
+            "createdAt": 2019-02-12T21:01:22.479Z,
             "id": "1",
             "params": Object {
               "bar": true,
             },
             "schedule": Object {
               "interval": "10s",
             },
+            "updatedAt": 2019-02-12T21:01:22.479Z,
           },
         ],
         "page": 1,
@@ -1476,7 +1491,9 @@ describe('update()', () => {
           },
         ],
         scheduledTaskId: 'task-123',
+        createdAt: new Date().toISOString(),
       },
+      updated_at: new Date().toISOString(),
       references: [
         {
           name: 'action_0',
@@ -1517,6 +1534,7 @@ describe('update()', () => {
             },
           },
         ],
+        "createdAt": 2019-02-12T21:01:22.479Z,
         "enabled": true,
         "id": "1",
         "params": Object {
@@ -1526,6 +1544,7 @@ describe('update()', () => {
           "interval": "10s",
         },
         "scheduledTaskId": "task-123",
+        "updatedAt": 2019-02-12T21:01:22.479Z,
       }
     `);
     expect(savedObjectsClient.update).toHaveBeenCalledTimes(1);
@@ -1624,6 +1643,7 @@ describe('update()', () => {
         params: {
           bar: true,
         },
+        createdAt: new Date().toISOString(),
         actions: [
           {
             group: 'default',
@@ -1652,6 +1672,7 @@ describe('update()', () => {
         ],
         scheduledTaskId: 'task-123',
       },
+      updated_at: new Date().toISOString(),
       references: [
         {
           name: 'action_0',
@@ -1732,6 +1753,7 @@ describe('update()', () => {
             },
           },
         ],
+        "createdAt": 2019-02-12T21:01:22.479Z,
         "enabled": true,
         "id": "1",
         "params": Object {
@@ -1741,6 +1763,7 @@ describe('update()', () => {
           "interval": "10s",
         },
         "scheduledTaskId": "task-123",
+        "updatedAt": 2019-02-12T21:01:22.479Z,
       }
     `);
     expect(savedObjectsClient.bulkGet).toHaveBeenCalledWith([
@@ -1799,6 +1822,7 @@ describe('update()', () => {
         params: {
           bar: true,
         },
+        createdAt: new Date().toISOString(),
         actions: [
           {
             group: 'default',
@@ -1812,6 +1836,7 @@ describe('update()', () => {
         apiKey: Buffer.from('123:abc').toString('base64'),
         scheduledTaskId: 'task-123',
       },
+      updated_at: new Date().toISOString(),
       references: [
         {
           name: 'action_0',
@@ -1853,6 +1878,7 @@ describe('update()', () => {
           },
         ],
         "apiKey": "MTIzOmFiYw==",
+        "createdAt": 2019-02-12T21:01:22.479Z,
         "enabled": true,
         "id": "1",
         "params": Object {
@@ -1862,6 +1888,7 @@ describe('update()', () => {
           "interval": "10s",
         },
         "scheduledTaskId": "task-123",
+        "updatedAt": 2019-02-12T21:01:22.479Z,
       }
     `);
     expect(savedObjectsClient.update).toHaveBeenCalledTimes(1);

diff --git a/x-pack/legacy/plugins/alerting/server/alerts_client.ts b/x-pack/legacy/plugins/alerting/server/alerts_client.ts
@@ -77,6 +77,8 @@ interface CreateOptions {
       keyof Alert,
       | 'createdBy'
       | 'updatedBy'
+      | 'createdAt'
+      | 'updatedAt'
       | 'apiKey'
       | 'apiKeyOwner'
       | 'muteAll'
@@ -142,6 +144,7 @@ export class AlertsClient {
       actions,
       createdBy: username,
       updatedBy: username,
+      createdAt: new Date().toISOString(),
       params: validatedAlertTypeParams,
       muteAll: false,
       mutedInstanceIds: [],
@@ -171,12 +174,17 @@ export class AlertsClient {
       });
       createdAlert.attributes.scheduledTaskId = scheduledTask.id;
     }
-    return this.getAlertFromRaw(createdAlert.id, createdAlert.attributes, references);
+    return this.getAlertFromRaw(
+      createdAlert.id,
+      createdAlert.attributes,
+      createdAlert.updated_at,
+      references
+    );
   }
 
   public async get({ id }: { id: string }) {
     const result = await this.savedObjectsClient.get('alert', id);
-    return this.getAlertFromRaw(result.id, result.attributes, result.references);
+    return this.getAlertFromRaw(result.id, result.attributes, result.updated_at, result.references);
   }
 
   public async find({ options = {} }: FindOptions = {}): Promise<FindResult> {
@@ -186,7 +194,7 @@ export class AlertsClient {
     });
 
     const data = results.saved_objects.map(result =>
-      this.getAlertFromRaw(result.id, result.attributes, result.references)
+      this.getAlertFromRaw(result.id, result.attributes, result.updated_at, result.references)
     );
 
     return {
@@ -214,7 +222,7 @@ export class AlertsClient {
       updateResult.scheduledTaskId &&
       !isEqual(alert.attributes.schedule, updateResult.schedule)
     ) {
-      this.taskManager.runNow(updateResult.scheduledTaskId).catch(err => {
+      this.taskManager.runNow(updateResult.scheduledTaskId).catch((err: Error) => {
         this.logger.error(
           `Alert update failed to run its underlying task. TaskManager runNow failed with Error: ${err.message}`
         );
@@ -254,7 +262,12 @@ export class AlertsClient {
         references,
       }
     );
-    return this.getAlertFromRaw(id, updatedObject.attributes, updatedObject.references);
+    return this.getAlertFromRaw(
+      id,
+      updatedObject.attributes,
+      updatedObject.updated_at,
+      updatedObject.references
+    );
   }
 
   private apiKeyAsAlertAttributes(
@@ -301,6 +314,7 @@ export class AlertsClient {
           enabled: true,
           ...this.apiKeyAsAlertAttributes(await this.createAPIKey(), username),
           updatedBy: username,
+
           scheduledTaskId: scheduledTask.id,
         },
         { version }
@@ -382,6 +396,7 @@ export class AlertsClient {
         alertId,
         {
           updatedBy: await this.getUserName(),
+
           mutedInstanceIds: mutedInstanceIds.filter((id: string) => id !== alertInstanceId),
         },
         { version }
@@ -424,6 +439,7 @@ export class AlertsClient {
   private getAlertFromRaw(
     id: string,
     rawAlert: Partial<RawAlert>,
+    updatedAt: SavedObject['updated_at'],
     references: SavedObjectReference[] | undefined
   ) {
     if (!rawAlert.actions) {
@@ -436,6 +452,8 @@ export class AlertsClient {
     return {
       id,
       ...rawAlert,
+      updatedAt: updatedAt ? new Date(updatedAt) : new Date(rawAlert.createdAt!),
+      createdAt: new Date(rawAlert.createdAt!),
       actions,
     };
   }

diff --git a/x-pack/legacy/plugins/alerting/server/routes/create.test.ts b/x-pack/legacy/plugins/alerting/server/routes/create.test.ts
@@ -4,6 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { omit } from 'lodash';
 import { createMockServer } from './_mock_server';
 import { createAlertRoute } from './create';
 
@@ -39,8 +40,12 @@ test('creates an alert with proper parameters', async () => {
     payload: mockedAlert,
   };
 
+  const createdAt = new Date();
+  const updatedAt = new Date();
   alertsClient.create.mockResolvedValueOnce({
     ...mockedAlert,
+    createdAt,
+    updatedAt,
     id: '123',
     actions: [
       {
@@ -52,7 +57,8 @@ test('creates an alert with proper parameters', async () => {
   const { payload, statusCode } = await server.inject(request);
   expect(statusCode).toBe(200);
   const response = JSON.parse(payload);
-  expect(response).toMatchInlineSnapshot(`
+  expect(new Date(response.createdAt)).toEqual(createdAt);
+  expect(omit(response, 'createdAt', 'updatedAt')).toMatchInlineSnapshot(`
     Object {
       "actions": Array [
         Object {

diff --git a/x-pack/legacy/plugins/alerting/server/routes/get.test.ts b/x-pack/legacy/plugins/alerting/server/routes/get.test.ts
@@ -17,6 +17,8 @@ const mockedAlert = {
   params: {
     bar: true,
   },
+  createdAt: new Date(),
+  updatedAt: new Date(),
   actions: [
     {
       group: 'default',
@@ -40,8 +42,10 @@ test('calls get with proper parameters', async () => {
   alertsClient.get.mockResolvedValueOnce(mockedAlert);
   const { payload, statusCode } = await server.inject(request);
   expect(statusCode).toBe(200);
-  const response = JSON.parse(payload);
-  expect(response).toEqual(mockedAlert);
+  const { createdAt, updatedAt, ...response } = JSON.parse(payload);
+  expect({ createdAt: new Date(createdAt), updatedAt: new Date(updatedAt), ...response }).toEqual(
+    mockedAlert
+  );
   expect(alertsClient.get).toHaveBeenCalledTimes(1);
   expect(alertsClient.get.mock.calls[0]).toMatchInlineSnapshot(`
 Array [

diff --git a/x-pack/legacy/plugins/alerting/server/routes/update.test.ts b/x-pack/legacy/plugins/alerting/server/routes/update.test.ts
@@ -20,6 +20,8 @@ const mockedResponse = {
   params: {
     otherField: false,
   },
+  createdAt: new Date(),
+  updatedAt: new Date(),
   actions: [
     {
       group: 'default',
@@ -59,8 +61,10 @@ test('calls the update function with proper parameters', async () => {
   alertsClient.update.mockResolvedValueOnce(mockedResponse);
   const { payload, statusCode } = await server.inject(request);
   expect(statusCode).toBe(200);
-  const response = JSON.parse(payload);
-  expect(response).toEqual(mockedResponse);
+  const { createdAt, updatedAt, ...response } = JSON.parse(payload);
+  expect({ createdAt: new Date(createdAt), updatedAt: new Date(updatedAt), ...response }).toEqual(
+    mockedResponse
+  );
   expect(alertsClient.update).toHaveBeenCalledTimes(1);
   expect(alertsClient.update.mock.calls[0]).toMatchInlineSnapshot(`
     Array [