EsArchiver: support for injecting kibana version and use it for speed…

…ing up spaces tests
elastic · Mar 11, 2021 · c79a508 · c79a508
1 parent 716e2f7
commit c79a508
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 9 deletions.
diff --git a/packages/kbn-es-archiver/package.json b/packages/kbn-es-archiver/package.json
@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "license": "SSPL-1.0 OR Elastic License 2.0",
   "private": "true",
-  "main": "target/index.js",
+  "main": "target/packages/kbn-es-archiver/src/index.js",
   "kibana": {
     "devOnly": true
   },

diff --git a/packages/kbn-es-archiver/src/lib/archives/parse.test.ts b/packages/kbn-es-archiver/src/lib/archives/parse.test.ts
@@ -12,6 +12,7 @@ import { createGzip } from 'zlib';
 import { createConcatStream, createListStream, createPromiseFromStreams } from '@kbn/utils';
 
 import { createParseArchiveStreams } from './parse';
+import { version as kibanaPackageVersion } from '../../../../../package.json';
 
 describe('esArchiver createParseArchiveStreams', () => {
   describe('{ gzip: false }', () => {
@@ -54,6 +55,17 @@ describe('esArchiver createParseArchiveStreams', () => {
         expect(output).toEqual([{ a: 1 }, 1]);
       });
 
+      it('replaces $KIBANA_PACKAGE_VERSION with the current kibana version', async () => {
+        const output = await createPromiseFromStreams([
+          createListStream([
+            Buffer.from('{'),
+            Buffer.from('"$KIBANA_PACKAGE_VERSION": "enabled"}'),
+          ]),
+          ...createParseArchiveStreams({ gzip: false }),
+        ]);
+        return expect(output).toEqual({ [kibanaPackageVersion]: 'enabled' });
+      });
+
       it('provides each JSON object as soon as it is parsed', async () => {
         let onReceived: (resolved: any) => void;
         const receivedPromise = new Promise((resolve) => (onReceived = resolve));
@@ -74,11 +86,13 @@ describe('esArchiver createParseArchiveStreams', () => {
           createConcatStream([]),
         ] as [Readable, ...Writable[]]);
 
-        input.write(Buffer.from('{"a": 1}\n\n{"a":'));
+        // before emitting a result, the buffer waits until it at least receives toReplace.length bytes
+        // so we need a long second object to ensure that the first gets emitted.
+        input.write(Buffer.from('{"a": 1}\n\n{"propertyNameLongerThanToReplace":'));
         expect(await receivedPromise).toEqual({ a: 1 });
         input.write(Buffer.from('2}'));
         input.end();
-        expect(await finalPromise).toEqual([{ a: 1 }, { a: 2 }]);
+        expect(await finalPromise).toEqual([{ a: 1 }, { propertyNameLongerThanToReplace: 2 }]);
       });
     });
 

diff --git a/packages/kbn-es-archiver/src/lib/archives/parse.ts b/packages/kbn-es-archiver/src/lib/archives/parse.ts
@@ -13,6 +13,7 @@ import {
   createSplitStream,
   createReplaceStream,
   createMapStream,
+  kibanaPackageJson,
 } from '@kbn/utils';
 
 import { RECORD_SEPARATOR } from './constants';
@@ -21,6 +22,7 @@ export function createParseArchiveStreams({ gzip = false } = {}) {
   return [
     gzip ? createGunzip() : new PassThrough(),
     createReplaceStream('\r\n', '\n'),
+    createReplaceStream('$KIBANA_PACKAGE_VERSION', kibanaPackageJson.version),
     createSplitStream(RECORD_SEPARATOR),
     createFilterStream<string>((l) => !!l.match(/[^\s]/)),
     createMapStream<string>((json) => JSON.parse(json.trim())),

diff --git a/x-pack/test/functional/es_archives/saved_objects_management/spaces_integration/mappings.json b/x-pack/test/functional/es_archives/saved_objects_management/spaces_integration/mappings.json
@@ -2,10 +2,10 @@
   "type": "index",
   "value": {
     "aliases": {
-      ".kibana_8.0.0": {},
+      ".kibana_$KIBANA_PACKAGE_VERSION": {},
       ".kibana": {}
     },
-    "index": ".kibana_8.0.0_001",
+    "index": ".kibana_$KIBANA_PACKAGE_VERSION_001",
     "mappings": {
       "dynamic": "false",
       "properties": {

diff --git a/...ved_object_api_integration/common/fixtures/es_archiver/saved_objects/spaces/mappings.json b/...ved_object_api_integration/common/fixtures/es_archiver/saved_objects/spaces/mappings.json
@@ -2,10 +2,10 @@
   "type": "index",
   "value": {
     "aliases": {
-      ".kibana_8.0.0": {},
+      ".kibana_$KIBANA_PACKAGE_VERSION": {},
       ".kibana": {}
     },
-    "index": ".kibana_8.0.0_001",
+    "index": ".kibana_$KIBANA_PACKAGE_VERSION_001",
     "mappings": {
       "dynamic": "false",
       "properties": {

diff --git a/...est/spaces_api_integration/common/fixtures/es_archiver/saved_objects/spaces/mappings.json b/...est/spaces_api_integration/common/fixtures/es_archiver/saved_objects/spaces/mappings.json
@@ -2,10 +2,10 @@
   "type": "index",
   "value": {
     "aliases": {
-      ".kibana_8.0.0": {},
+      ".kibana_$KIBANA_PACKAGE_VERSION": {},
       ".kibana": {}
     },
-    "index": ".kibana_8.0.0_001",
+    "index": ".kibana_$KIBANA_PACKAGE_VERSION_001",
     "mappings": {
       "dynamic": "false"
     },