Remove id attribute from canvas attributes (#30736) (#31138)

* Remove id attribute from canvas attributes

* Fix create and update API

* Add migration tests

* Use constants

* Add API tests

* Cleanup tests

* Apply PR feedback

x-pack/plugins/canvas/index.js

@@ -8,6 +8,7 @@ import { resolve } from 'path';
 import init from './init';
 import { mappings } from './server/mappings';
 import { CANVAS_APP } from './common/lib';
+import { migrations } from './migrations';
 
 export function canvas(kibana) {
   return new kibana.Plugin({
@@ -30,6 +31,7 @@ export function canvas(kibana) {
       ],
       home: ['plugins/canvas/register_feature'],
       mappings,
+      migrations,
     },
 
     config: Joi => {

x-pack/plugins/canvas/migrations.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { CANVAS_TYPE } from './common/lib';
+
+export const migrations = {
+  [CANVAS_TYPE]: {
+    '7.0.0': doc => {
+      if (doc.attributes) {
+        delete doc.attributes.id;
+      }
+      return doc;
+    },
+  },
+};

x-pack/plugins/canvas/migrations.test.js

@@ -0,0 +1,37 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { migrations } from './migrations';
+import { CANVAS_TYPE } from './common/lib';
+
+describe(CANVAS_TYPE, () => {
+  describe('7.0.0', () => {
+    const migrate = doc => migrations[CANVAS_TYPE]['7.0.0'](doc);
+
+    it('does not throw error on empty object', () => {
+      const migratedDoc = migrate({});
+      expect(migratedDoc).toMatchInlineSnapshot(`Object {}`);
+    });
+
+    it('removes id from "attributes"', () => {
+      const migratedDoc = migrate({
+        foo: true,
+        attributes: {
+          id: '123',
+          bar: true,
+        },
+      });
+      expect(migratedDoc).toMatchInlineSnapshot(`
+Object {
+  "attributes": Object {
+    "bar": true,
+  },
+  "foo": true,
+}
+`);
+    });
+  });
+});

x-pack/plugins/canvas/server/mappings.js

@@ -18,7 +18,6 @@ export const mappings = {
           },
         },
       },
-      id: { type: 'text', index: false },
       '@timestamp': { type: 'date' },
       '@created': { type: 'date' },
     },

x-pack/plugins/canvas/server/routes/workpad.js

@@ -5,6 +5,7 @@
  */
 
 import boom from 'boom';
+import { omit } from 'lodash';
 import {
   CANVAS_TYPE,
   API_ROUTE_WORKPAD,
@@ -44,22 +45,23 @@ export function workpad(server) {
     return resp;
   }
 
-  function createWorkpad(req, id) {
+  function createWorkpad(req) {
     const savedObjectsClient = req.getSavedObjectsClient();
 
     if (!req.payload) {
       return Promise.reject(boom.badRequest('A workpad payload is required'));
     }
 
     const now = new Date().toISOString();
+    const { id, ...payload } = req.payload;
     return savedObjectsClient.create(
       CANVAS_TYPE,
       {
-        ...req.payload,
+        ...payload,
         '@timestamp': now,
         '@created': now,
       },
-      { id: id || req.payload.id || getId('workpad') }
+      { id: id || getId('workpad') }
     );
   }
 
@@ -74,7 +76,7 @@ export function workpad(server) {
       return savedObjectsClient.create(
         CANVAS_TYPE,
         {
-          ...req.payload,
+          ...omit(req.payload, 'id'),
           '@timestamp': now,
           '@created': workpad.attributes['@created'],
         },
@@ -158,7 +160,7 @@ export function workpad(server) {
 
       return savedObjectsClient
         .get(CANVAS_TYPE, id)
-        .then(obj => obj.attributes)
+        .then(obj => ({ id: obj.id, ...obj.attributes }))
         .then(formatResponse)
         .catch(formatResponse);
     },
@@ -233,7 +235,7 @@ export function workpad(server) {
         .then(resp => {
           return {
             total: resp.total,
-            workpads: resp.saved_objects.map(hit => hit.attributes),
+            workpads: resp.saved_objects.map(hit => ({ id: hit.id, ...hit.attributes })),
           };
         })
         .catch(() => {