[6.x] Remove dependency on doc versions (#29906) (#30036)

Backports the following commits to 6.x:
 - Remove dependency on doc versions  (#29906)

Author: Spencer

src/legacy/core_plugins/elasticsearch/lib/__tests__/health_check.js

@@ -61,7 +61,6 @@ describe('plugins/elasticsearch', () => {
 
       cluster = { callWithInternalUser: sinon.stub() };
       cluster.callWithInternalUser.withArgs('index', sinon.match.any).returns(Promise.resolve());
-      cluster.callWithInternalUser.withArgs('create', sinon.match.any).returns(Promise.resolve({ _id: '1', _version: 1 }));
       cluster.callWithInternalUser.withArgs('mget', sinon.match.any).returns(Promise.resolve({ ok: true }));
       cluster.callWithInternalUser.withArgs('get', sinon.match.any).returns(Promise.resolve({ found: false }));
       cluster.callWithInternalUser.withArgs('search', sinon.match.any).returns(Promise.resolve({ hits: { hits: [] } }));

src/legacy/core_plugins/kibana/server/tutorials/apm/saved_objects/index_pattern.json

@@ -7,5 +7,5 @@
   },
   "id": "apm-*",
   "type": "index-pattern",
-  "version": 1
+  "version": "1"
 }

src/legacy/core_plugins/kibana/server/tutorials/apm/saved_objects/saved_objects.json

@@ -11,7 +11,7 @@
     },
     "id": "1ffc5e20-7827-11e7-8c47-65b845b5cfb3",
     "type": "visualization",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -26,7 +26,7 @@
     },
     "id": "1bdca740-7828-11e7-8c47-65b845b5cfb3",
     "type": "visualization",
-    "version": 2
+    "version": "2"
 },
 {
     "attributes": {
@@ -41,7 +41,7 @@
     },
     "id": "804ffc40-7828-11e7-8c47-65b845b5cfb3",
     "type": "visualization",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -59,7 +59,7 @@
     },
     "id": "8d3ed660-7828-11e7-8c47-65b845b5cfb3",
     "type": "dashboard",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -74,7 +74,7 @@
     },
     "id": "c618e4e0-7c69-11e7-aa55-3b0d52c71c60",
     "type": "visualization",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -100,7 +100,7 @@
     },
     "id": "ceefd050-7c6a-11e7-aa55-3b0d52c71c60",
     "type": "search",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -118,7 +118,7 @@
     },
     "id": "5f08a870-7c6a-11e7-aa55-3b0d52c71c60",
     "type": "dashboard",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -133,7 +133,7 @@
     },
     "id": "22518e70-7c69-11e7-aa55-3b0d52c71c60",
     "type": "visualization",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -151,7 +151,7 @@
     },
     "id": "37f6fac0-7c6a-11e7-aa55-3b0d52c71c60",
     "type": "dashboard",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -166,7 +166,7 @@
     },
     "id": "a2e199b0-7820-11e7-8c47-65b845b5cfb3",
     "type": "visualization",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -181,7 +181,7 @@
     },
     "id": "09bcf890-7822-11e7-8c47-65b845b5cfb3",
     "type": "visualization",
-    "version": 2
+    "version": "2"
 },
 {
     "attributes": {
@@ -196,7 +196,7 @@
     },
     "id": "55606a60-7823-11e7-8c47-65b845b5cfb3",
     "type": "visualization",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -214,7 +214,7 @@
     },
     "id": "41b5d920-7821-11e7-8c47-65b845b5cfb3",
     "type": "dashboard",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -238,7 +238,7 @@
     },
     "id": "d7735b90-7ddf-11e7-b115-df9c90da2df1",
     "type": "search",
-    "version": 1
+    "version": "1"
 },
 {
     "attributes": {
@@ -256,5 +256,5 @@
     },
     "id": "3e3de700-7de0-11e7-b115-df9c90da2df1",
     "type": "dashboard",
-    "version": 2
+    "version": "2"
 }]

src/server/saved_objects/routes/bulk_create.js

@@ -35,7 +35,7 @@ export const createBulkCreateRoute = prereqs => ({
           type: Joi.string().required(),
           id: Joi.string(),
           attributes: Joi.object().required(),
-          version: Joi.number(),
+          version: Joi.string(),
           migrationVersion: Joi.object().optional(),
         }).required()
       ),

src/server/saved_objects/routes/bulk_get.test.js

@@ -59,7 +59,7 @@ describe('POST /api/saved_objects/_bulk_get', () => {
         id: 'abc123',
         type: 'index-pattern',
         title: 'logstash-*',
-        version: 2
+        version: 'foo',
       }]
     };
 

src/server/saved_objects/routes/update.js

@@ -32,7 +32,7 @@ export const createUpdateRoute = (prereqs) => {
         }).required(),
         payload: Joi.object({
           attributes: Joi.object().required(),
-          version: Joi.number().min(1)
+          version: Joi.string(),
         }).required()
       },
       handler(request) {

src/server/saved_objects/routes/update.test.js

@@ -66,7 +66,7 @@ describe('PUT /api/saved_objects/{type}/{id?}', () => {
 
   it('calls upon savedObjectClient.update', async () => {
     const attributes = { title: 'Testing' };
-    const options = { version: 2 };
+    const options = { version: 'foo' };
     const request = {
       method: 'PUT',
       url: '/api/saved_objects/index-pattern/logstash-*',

src/server/saved_objects/serialization/index.ts

@@ -24,6 +24,7 @@
 
 import uuid from 'uuid';
 import { SavedObjectsSchema } from '../schema';
+import { decodeVersion, encodeVersion } from '../version';
 
 /**
  * The root document type. In 7.0, this needs to change to '_doc'.
@@ -37,7 +38,8 @@ export interface RawDoc {
   _id: string;
   _source: any;
   _type?: string;
-  _version?: number;
+  _seq_no?: number;
+  _primary_term?: number;
 }
 
 /**
@@ -60,7 +62,7 @@ export interface SavedObjectDoc {
   type: string;
   namespace?: string;
   migrationVersion?: MigrationVersion;
-  version?: number;
+  version?: string;
   updated_at?: Date;
 
   [rootProp: string]: any;
@@ -99,16 +101,22 @@ export class SavedObjectsSerializer {
    *
    *  @param {RawDoc} rawDoc - The raw ES document to be converted to saved object format.
    */
-  public rawToSavedObject({ _id, _source, _version }: RawDoc): SavedObjectDoc {
+  public rawToSavedObject({ _id, _source, _seq_no, _primary_term }: RawDoc): SavedObjectDoc {
     const { type, namespace } = _source;
+
+    const version =
+      _seq_no != null || _primary_term != null
+        ? encodeVersion(_seq_no!, _primary_term!)
+        : undefined;
+
     return {
       type,
       id: this.trimIdPrefix(namespace, type, _id),
       ...(namespace && !this.schema.isNamespaceAgnostic(type) && { namespace }),
       attributes: _source[type],
       ...(_source.migrationVersion && { migrationVersion: _source.migrationVersion }),
       ...(_source.updated_at && { updated_at: _source.updated_at }),
-      ...(_version != null && { version: _version }),
+      ...(version && { version }),
     };
   }
 
@@ -131,7 +139,7 @@ export class SavedObjectsSerializer {
       _id: this.generateRawId(namespace, type, id),
       _source: source,
       _type: ROOT_TYPE,
-      ...(version != null && { _version: version }),
+      ...(version != null && decodeVersion(version)),
     };
   }
 

src/server/saved_objects/serialization/serialization.test.ts

@@ -20,6 +20,7 @@
 import _ from 'lodash';
 import { ROOT_TYPE, SavedObjectsSerializer } from '.';
 import { SavedObjectsSchema } from '../schema';
+import { encodeVersion } from '../version';
 
 describe('saved object conversion', () => {
   describe('#rawToSavedObject', () => {
@@ -69,7 +70,8 @@ describe('saved object conversion', () => {
       const actual = serializer.rawToSavedObject({
         _id: 'hello:world',
         _type: ROOT_TYPE,
-        _version: 3,
+        _seq_no: 3,
+        _primary_term: 1,
         _source: {
           type: 'hello',
           hello: {
@@ -86,7 +88,7 @@ describe('saved object conversion', () => {
       const expected = {
         id: 'world',
         type: 'hello',
-        version: 3,
+        version: encodeVersion(3, 1),
         attributes: {
           a: 'b',
           c: 'd',
@@ -112,17 +114,46 @@ describe('saved object conversion', () => {
       expect(actual).not.toHaveProperty('version');
     });
 
-    test(`if specified it copies _version to version`, () => {
+    test(`if specified it encodes _seq_no and _primary_term to version`, () => {
       const serializer = new SavedObjectsSerializer(new SavedObjectsSchema());
       const actual = serializer.rawToSavedObject({
         _id: 'foo:bar',
-        _version: 4,
+        _seq_no: 4,
+        _primary_term: 1,
         _source: {
           type: 'foo',
           hello: {},
         },
       });
-      expect(actual).toHaveProperty('version', 4);
+      expect(actual).toHaveProperty('version', encodeVersion(4, 1));
+    });
+
+    test(`if only _seq_no is specified it throws`, () => {
+      const serializer = new SavedObjectsSerializer(new SavedObjectsSchema());
+      expect(() =>
+        serializer.rawToSavedObject({
+          _id: 'foo:bar',
+          _seq_no: 4,
+          _source: {
+            type: 'foo',
+            hello: {},
+          },
+        })
+      ).toThrowErrorMatchingInlineSnapshot(`"_primary_term from elasticsearch must be an integer"`);
+    });
+
+    test(`if only _primary_term is throws`, () => {
+      const serializer = new SavedObjectsSerializer(new SavedObjectsSchema());
+      expect(() =>
+        serializer.rawToSavedObject({
+          _id: 'foo:bar',
+          _primary_term: 1,
+          _source: {
+            type: 'foo',
+            hello: {},
+          },
+        })
+      ).toThrowErrorMatchingInlineSnapshot(`"_seq_no from elasticsearch must be an integer"`);
     });
 
     test('if specified it copies the _source.updated_at property to updated_at', () => {
@@ -206,7 +237,8 @@ describe('saved object conversion', () => {
       const raw = {
         _id: 'foo-namespace:foo:bar',
         _type: ROOT_TYPE,
-        _version: 24,
+        _primary_term: 24,
+        _seq_no: 42,
         _source: {
           type: 'foo',
           foo: {
@@ -440,25 +472,38 @@ describe('saved object conversion', () => {
       expect(actual._source).not.toHaveProperty('migrationVersion');
     });
 
-    test('it copies the version property to _version', () => {
+    test('it decodes the version property to _seq_no and _primary_term', () => {
       const serializer = new SavedObjectsSerializer(new SavedObjectsSchema());
       const actual = serializer.savedObjectToRaw({
         type: '',
         attributes: {},
-        version: 4,
+        version: encodeVersion(1, 2),
       } as any);
 
-      expect(actual).toHaveProperty('_version', 4);
+      expect(actual).toHaveProperty('_seq_no', 1);
+      expect(actual).toHaveProperty('_primary_term', 2);
     });
 
-    test(`if unspecified it doesn't add _version property`, () => {
+    test(`if unspecified it doesn't add _seq_no or _primary_term properties`, () => {
       const serializer = new SavedObjectsSerializer(new SavedObjectsSchema());
       const actual = serializer.savedObjectToRaw({
         type: '',
         attributes: {},
       } as any);
 
-      expect(actual).not.toHaveProperty('_version');
+      expect(actual).not.toHaveProperty('_seq_no');
+      expect(actual).not.toHaveProperty('_primary_term');
+    });
+
+    test(`if version invalid it throws`, () => {
+      const serializer = new SavedObjectsSerializer(new SavedObjectsSchema());
+      expect(() =>
+        serializer.savedObjectToRaw({
+          type: '',
+          attributes: {},
+          version: 'foo',
+        } as any)
+      ).toThrowErrorMatchingInlineSnapshot(`"Invalid version [foo]"`);
     });
 
     test('it copies attributes to _source[type]', () => {

src/server/saved_objects/service/lib/errors.d.ts

@@ -25,3 +25,6 @@ export function isNotFoundError(maybeError: any): boolean;
 export function isConflictError(maybeError: any): boolean;
 export function isEsUnavailableError(maybeError: any): boolean;
 export function isEsAutoCreateIndexError(maybeError: any): boolean;
+
+export function createInvalidVersionError(version: any): Error;
+export function isInvalidVersionError(maybeError: Error): boolean;