[Env] Add buildFlavor to package info (#161930)

## Summary Add a `buildFavor` property to `Env` (accessible from the plugin's initializer context), Mimicking the idea of ES's `version.buildFlavor` field. Note: this is not supposed to be a replacement for feature flags, but can be useful when wanting to toggle features based on actual capabilities of our serverless product. Also, we already expose this value through the configuration via the `serverless` context value, so it now adds another way to access the information. --------- Co-authored-by: Kibana Machine <[email protected]>
elastic · Jul 20, 2023 · ab486af · ab486af
1 parent e79f244
commit ab486af
Show file tree

Hide file tree

Showing 16 changed files with 79 additions and 4 deletions.
diff --git a/...ages/core/apps/core-apps-server-internal/src/bundle_routes/register_bundle_routes.test.ts b/...ages/core/apps/core-apps-server-internal/src/bundle_routes/register_bundle_routes.test.ts
@@ -15,13 +15,14 @@ import { registerBundleRoutes } from './register_bundle_routes';
 import { FileHashCache } from './file_hash_cache';
 
 const createPackageInfo = (parts: Partial<PackageInfo> = {}): PackageInfo => ({
-  ...parts,
   buildNum: 42,
   buildSha: 'sha',
   dist: true,
   branch: 'master',
   version: '8.0.0',
   buildDate: new Date('2023-05-15T23:12:09.000Z'),
+  buildFlavor: 'traditional',
+  ...parts,
 });
 
 const createUiPlugins = (...ids: string[]): UiPlugins => ({

diff --git a/packages/core/base/core-base-browser-mocks/src/core_context.mock.ts b/packages/core/base/core-base-browser-mocks/src/core_context.mock.ts
@@ -26,6 +26,7 @@ function createCoreContext({ production = false }: { production?: boolean } = {}
         buildSha: 'buildSha',
         dist: false,
         buildDate: new Date('2023-05-15T23:12:09.000Z'),
+        buildFlavor: 'traditional',
       },
     },
   };

diff --git a/packages/core/plugins/core-plugins-browser-internal/src/test_helpers/mocks.ts b/packages/core/plugins/core-plugins-browser-internal/src/test_helpers/mocks.ts
@@ -25,6 +25,7 @@ export const createPluginInitializerContextMock = (config: unknown = {}) => {
         buildSha: 'buildSha',
         dist: false,
         buildDate: new Date('2023-05-15T23:12:09.000Z'),
+        buildFlavor: 'traditional',
       },
     },
     logger: loggerMock.create(),

diff --git a/packages/core/plugins/core-plugins-browser-mocks/src/plugins_service.mock.ts b/packages/core/plugins/core-plugins-browser-mocks/src/plugins_service.mock.ts
@@ -43,6 +43,7 @@ const createPluginInitializerContextMock = (config: unknown = {}) => {
         buildSha: 'buildSha',
         dist: false,
         buildDate: new Date('2023-05-15T23:12:09.000Z'),
+        buildFlavor: 'serverless',
       },
     },
     logger: loggerMock.create(),

diff --git a/...es/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.test.ts b/...es/core/plugins/core-plugins-server-internal/src/discovery/plugin_manifest_parser.test.ts
@@ -8,20 +8,21 @@
 
 import { mockReadFile } from './plugin_manifest_parser.test.mocks';
 
-import { PluginDiscoveryErrorType } from './plugin_discovery_error';
-
 import { resolve } from 'path';
+import type { PackageInfo } from '@kbn/config';
+import { PluginDiscoveryErrorType } from './plugin_discovery_error';
 import { parseManifest } from './plugin_manifest_parser';
 
 const pluginPath = resolve('path', 'existent-dir');
 const pluginManifestPath = resolve(pluginPath, 'kibana.json');
-const packageInfo = {
+const packageInfo: PackageInfo = {
   branch: 'master',
   buildNum: 1,
   buildSha: '',
   version: '7.0.0-alpha1',
   dist: false,
   buildDate: new Date('2023-05-15T23:12:09.000Z'),
+  buildFlavor: 'traditional',
 };
 
 afterEach(() => {

diff --git a/...rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap b/...rendering/core-rendering-server-internal/src/__snapshots__/rendering_service.test.ts.snap
diff --git a/...es/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts b/...es/core/rendering/core-rendering-server-internal/src/bootstrap/bootstrap_renderer.test.ts
@@ -28,6 +28,7 @@ const createPackageInfo = (parts: Partial<PackageInfo> = {}): PackageInfo => ({
   buildDate: new Date('2023-05-15T23:12:09.000Z'),
   dist: false,
   version: '8.0.0',
+  buildFlavor: 'traditional',
   ...parts,
 });
 

diff --git a/packages/core/rendering/core-rendering-server-internal/src/rendering_service.test.ts b/packages/core/rendering/core-rendering-server-internal/src/rendering_service.test.ts
@@ -45,6 +45,7 @@ const INJECTED_METADATA = {
       dist: expect.any(Boolean),
       version: expect.any(String),
       buildDate: new Date(BUILD_DATE).toISOString(),
+      buildFlavor: expect.any(String),
     },
   },
 };

diff --git a/packages/kbn-config/src/__snapshots__/env.test.ts.snap b/packages/kbn-config/src/__snapshots__/env.test.ts.snap
diff --git a/packages/kbn-config/src/env.test.ts b/packages/kbn-config/src/env.test.ts
@@ -208,3 +208,43 @@ test('pluginSearchPaths only includes kibana-extra, regardless of plugin filters
 
   expect(env4.pluginSearchPaths).toEqual(['/some/home/kibana-extra', '/some/home/dir/plugins']);
 });
+
+describe('packageInfo.buildFlavor', () => {
+  it('is set to `serverless` when the `serverless` cli flag is `true`', () => {
+    mockPackage.raw = {
+      branch: 'some-branch',
+      version: 'some-version',
+    };
+
+    const env = Env.createDefault(
+      REPO_ROOT,
+      getEnvOptions({
+        configs: ['/test/cwd/config/kibana.yml'],
+        cliArgs: {
+          serverless: true,
+        },
+      })
+    );
+
+    expect(env.packageInfo.buildFlavor).toEqual('serverless');
+  });
+
+  it('is set to `traditional` when the `serverless` cli flag is `false`', () => {
+    mockPackage.raw = {
+      branch: 'some-branch',
+      version: 'some-version',
+    };
+
+    const env = Env.createDefault(
+      REPO_ROOT,
+      getEnvOptions({
+        configs: ['/test/cwd/config/kibana.yml'],
+        cliArgs: {
+          serverless: false,
+        },
+      })
+    );
+
+    expect(env.packageInfo.buildFlavor).toEqual('traditional');
+  });
+});
diff --git a/packages/kbn-config/src/env.ts b/packages/kbn-config/src/env.ts
@@ -124,6 +124,7 @@ export class Env {
       version: pkg.version,
       dist: isKibanaDistributable,
       buildDate: isKibanaDistributable ? new Date(pkg.build.date) : new Date(),
+      buildFlavor: this.cliArgs.serverless ? 'serverless' : 'traditional',
     });
   }
 }
diff --git a/packages/kbn-config/src/types.ts b/packages/kbn-config/src/types.ts
@@ -15,6 +15,7 @@ export interface PackageInfo {
   buildNum: number;
   buildSha: string;
   buildDate: Date;
+  buildFlavor: BuildFlavor;
   dist: boolean;
 }
 
@@ -26,3 +27,5 @@ export interface EnvironmentMode {
   dev: boolean;
   prod: boolean;
 }
+
+export type BuildFlavor = 'serverless' | 'traditional';
diff --git a/src/core/server/integration_tests/status/routes/status.test.ts b/src/core/server/integration_tests/status/routes/status.test.ts
@@ -86,6 +86,7 @@ describe('GET /api/status', () => {
           dist: true,
           version: '9.9.9-SNAPSHOT',
           buildDate: new Date('2023-05-15T23:12:09.000Z'),
+          buildFlavor: 'traditional',
         },
         serverName: 'xkibana',
         uuid: 'xxxx-xxxxx',

diff --git a/src/core/server/mocks.ts b/src/core/server/mocks.ts
@@ -100,6 +100,7 @@ function pluginInitializerContextMock<T>(config: T = {} as T) {
         buildSha: 'buildSha',
         dist: false,
         buildDate: new Date('2023-05-15T23:12:09.000Z'),
+        buildFlavor: 'traditional',
       },
       instanceUuid: 'instance-uuid',
       configs: ['/some/path/to/config/kibana.yml'],

diff --git a/...ck/plugins/screenshotting/server/formats/pdf/pdf_maker/integration_tests/pdfmaker.test.ts b/...ck/plugins/screenshotting/server/formats/pdf/pdf_maker/integration_tests/pdfmaker.test.ts
@@ -36,6 +36,7 @@ describe('PdfMaker', () => {
       dist: false,
       version: '1000.0.0',
       buildDate: new Date('2023-05-15T23:12:09.000Z'),
+      buildFlavor: 'traditional',
     };
     pdf = new PdfMaker(layout, undefined, packageInfo, logger);
   });

diff --git a/x-pack/plugins/screenshotting/server/screenshots/index.test.ts b/x-pack/plugins/screenshotting/server/screenshots/index.test.ts
@@ -58,6 +58,7 @@ describe('Screenshot Observable Pipeline', () => {
       dist: false,
       version: '5000.0.0',
       buildDate: new Date('2023-05-15T23:12:09.000Z'),
+      buildFlavor: 'traditional',
     };
     options = {
       browserTimezone: 'UTC',