Enhance Wazuh integration by adding version, revision, and stage on wz dashboard (#1327)

* Enhance Wazuh integration by adding version, revision, and stage metadata. Update related interfaces and mocks to support new properties across the application.

* Add production flag handling in VERSION.json and update related interfaces

This commit introduces a new step in the build workflow to set the production flag in VERSION.json based on the deployment stage. Additionally, it updates various interfaces and mocks across the application to include the new  property, ensuring consistent handling of this metadata throughout the codebase.

* Refactor Wazuh build metadata handling and update related interfaces

This commit removes the production flag handling from the build workflow and integrates it directly into the package.json during the build process. It also introduces a new WazuhBuildInfo interface to encapsulate version, revision, stage, and production status, updating various components and mocks across the application to utilize this new structure for consistent metadata management.

* Update health check mock and enhance injected metadata in tests

This commit replaces the hardcoded health check configuration in the injected metadata service mock with a reference to the centralized healthCheckConfig. Additionally, it updates the PluginsService tests to include the new 'getWazuhBuildInfo' method in the injected metadata mock, ensuring consistency across the application.

* fix prettier

* tmp change on workflow

* restore file

Author: felipegonzalezmv

dev-tools/build-packages/deb/deb-builder.sh

@@ -60,6 +60,11 @@ log "Extracting base tar.gz..."
 tar -zxf "${out_dir}/wazuh-dashboard-$version-$revision-linux-$architecture.tar.gz"
 log "Preparing the package..."
 jq '.wazuh.revision="'${revision}'"' package.json > pkgtmp.json && mv pkgtmp.json package.json
+if [ "${is_production}" = "yes" ]; then
+  jq '.wazuh.isProduction = true' package.json > pkgtmp.json && mv pkgtmp.json package.json
+else
+  jq '.wazuh.isProduction = false' package.json > pkgtmp.json && mv pkgtmp.json package.json
+fi
 mkdir -p etc/services
 cp "${config_path}"/* etc/services
 jq '.version="'${version}'"' VERSION.json > VERSION.tmp && mv VERSION.tmp VERSION.json

dev-tools/build-packages/rpm/rpm-builder.sh

@@ -58,6 +58,11 @@ log "Extracting base tar.gz..."
 tar -zxf "${out_dir}/wazuh-dashboard-$version-$revision-linux-$architecture.tar.gz"
 log "Preparing the package..."
 jq '.wazuh.revision="'${revision}'"' package.json > pkgtmp.json && mv pkgtmp.json package.json
+if [ "${is_production}" = "yes" ]; then
+  jq '.wazuh.isProduction = true' package.json > pkgtmp.json && mv pkgtmp.json package.json
+else
+  jq '.wazuh.isProduction = false' package.json > pkgtmp.json && mv pkgtmp.json package.json
+fi
 mkdir -p etc/services
 cp "${config_path}"/* etc/services
 jq '.version="'${version}'"' VERSION.json > VERSION.tmp && mv VERSION.tmp VERSION.json

packages/osd-config/src/env.test.mocks.ts

@@ -44,6 +44,15 @@ export const mockPackage = {
   raw: {},
 };
 
+export const mockVersionFile = {
+  raw: { stage: '' },
+};
+
 jest.doMock('load-json-file', () => ({
-  sync: () => mockPackage.raw,
+  sync: (filePath: string) => {
+    if (filePath.endsWith('VERSION.json')) {
+      return mockVersionFile.raw;
+    }
+    return mockPackage.raw;
+  },
 }));

packages/osd-config/src/env.ts

@@ -69,9 +69,25 @@ export interface RawPackageInfo {
   };
   wazuh: {
     version: string;
+    revision?: string;
+    isProduction?: boolean;
   };
 }
 
+/** @internal */
+interface RawWazuhVersionFile {
+  version?: string;
+  stage?: string;
+}
+
+function loadWazuhVersionFile(repoRoot: string): RawWazuhVersionFile {
+  try {
+    return loadJsonFile.sync(join(repoRoot, 'VERSION.json')) as RawWazuhVersionFile;
+  } catch {
+    return {};
+  }
+}
+
 export class Env {
   /**
    * @internal
@@ -154,6 +170,7 @@ export class Env {
     const isOpenSearchDashboardsDistributable = Boolean(
       pkg.build && pkg.build.distributable === true
     );
+    const wazuhVersionFile = loadWazuhVersionFile(this.homeDir);
     this.packageInfo = Object.freeze({
       branch: pkg.branch,
       buildNum: isOpenSearchDashboardsDistributable ? pkg.build.number : Number.MAX_SAFE_INTEGER,
@@ -163,6 +180,9 @@ export class Env {
       version: pkg.version,
       dist: isOpenSearchDashboardsDistributable,
       wazuhVersion: pkg.wazuh.version,
+      wazuhRevision: pkg.wazuh.revision ?? '01',
+      wazuhStage: wazuhVersionFile.stage ?? '',
+      wazuhIsProduction: pkg.wazuh.isProduction ?? false,
     });
   }
 }

packages/osd-config/src/types.ts

@@ -38,6 +38,9 @@ export interface PackageInfo {
   buildSha: string;
   dist: boolean;
   wazuhVersion: string;
+  wazuhRevision: string;
+  wazuhStage: string;
+  wazuhIsProduction: boolean;
 }
 
 /**

src/core/public/chrome/chrome_service.tsx

@@ -406,7 +406,7 @@ export class ChromeService {
           homeHref={application.getUrlForApp('wz-home')}
           isVisible$={this.isVisible$}
           headerVariant$={this.headerVariant$}
-          opensearchDashboardsVersion={injectedMetadata.getWazuhVersion()}
+          opensearchDashboardsVersion={injectedMetadata.getWazuhBuildInfo().version}
           navLinks$={navLinks.getNavLinks$()}
           recentlyAccessed$={recentlyAccessed.get$()}
           navControlsLeft$={navControls.getLeft$()}

src/core/public/core_system.ts

@@ -304,7 +304,11 @@ export class CoreSystem {
         docLinks,
         http,
         i18n,
-        injectedMetadata: pick(injectedMetadata, ['getInjectedVar', 'getBranding']),
+        injectedMetadata: pick(injectedMetadata, [
+          'getInjectedVar',
+          'getBranding',
+          'getWazuhBuildInfo',
+        ]),
         notifications,
         overlays,
         savedObjects,

src/core/public/index.ts

@@ -106,9 +106,11 @@ import { KeyboardShortcutSetup, KeyboardShortcutStart } from './keyboard_shortcu
 import { ChatServiceSetup, ChatServiceStart } from './chat';
 import type { TelemetryServiceSetup, TelemetryServiceStart } from './telemetry';
 import { HealthCheckServiceSetup, HealthCheckServiceStart } from './healthcheck';
+import type { WazuhBuildInfo } from '../types/wazuh_build_info';
 
 export type { Logos } from '../common';
 export { PackageInfo, EnvironmentMode } from '../server/types';
+export type { WazuhBuildInfo } from '../types/wazuh_build_info';
 /** @interal */
 export { CoreContext, CoreSystem } from './core_system';
 export {
@@ -288,6 +290,8 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
   injectedMetadata: {
     getInjectedVar: (name: string, defaultValue?: any) => unknown;
     getBranding: () => Branding;
+    // Wazuh
+    getWazuhBuildInfo: () => WazuhBuildInfo;
   };
   /** {@link StartServicesAccessor} */
   getStartServices: StartServicesAccessor<TPluginsStart, TStart>;
@@ -355,6 +359,8 @@ export interface CoreStart {
   injectedMetadata: {
     getInjectedVar: (name: string, defaultValue?: any) => unknown;
     getBranding: () => Branding;
+    // Wazuh
+    getWazuhBuildInfo: () => WazuhBuildInfo;
   };
   /** {@link WorkspacesStart} */
   workspaces: WorkspacesStart;

src/core/public/injected_metadata/injected_metadata_service.mock.ts

@@ -29,8 +29,17 @@
  */
 
 import type { PublicMethodsOf } from '@osd/utility-types';
+import { healthCheckConfig } from 'src/core/server/healthcheck/healthcheck/health_check.mock';
+import { WazuhBuildInfo } from '../../types/wazuh_build_info';
 import { InjectedMetadataService, InjectedMetadataSetup } from './injected_metadata_service';
 
+export const mockWazuhBuildInfo: WazuhBuildInfo = {
+  version: '4.x.x',
+  revision: '01',
+  stage: '',
+  isProduction: false,
+};
+
 const createSetupContractMock = () => {
   const setupContract: jest.Mocked<InjectedMetadataSetup> = {
     getBasePath: jest.fn(),
@@ -48,7 +57,7 @@ const createSetupContractMock = () => {
     getSurvey: jest.fn(),
     getEnableIconSideNav: jest.fn(),
     getKeyboardShortcuts: jest.fn(),
-    getWazuhVersion: jest.fn(),
+    getWazuhBuildInfo: jest.fn(),
     getWazuhDocVersion: jest.fn(),
     // Wazuh
     getHealthCheck: jest.fn(),
@@ -70,18 +79,27 @@ const createSetupContractMock = () => {
   setupContract.getPlugins.mockReturnValue([]);
   setupContract.getEnableIconSideNav.mockReturnValue(true);
   setupContract.getKeyboardShortcuts.mockReturnValue({ enabled: true });
-  setupContract.getWazuhVersion.mockReturnValue('4.x.x');
+  setupContract.getWazuhBuildInfo.mockReturnValue(mockWazuhBuildInfo);
   setupContract.getWazuhDocVersion.mockReturnValue('4.x');
+  setupContract.getHealthCheck.mockReturnValue(healthCheckConfig);
   return setupContract;
 };
 
-const createStartContractMock = createSetupContractMock;
-
 type InjectedMetadataServiceContract = PublicMethodsOf<InjectedMetadataService>;
-const createMock = (): jest.Mocked<InjectedMetadataServiceContract> => ({
-  setup: jest.fn().mockReturnValue(createSetupContractMock()),
-  start: jest.fn().mockReturnValue(createStartContractMock()),
-});
+
+const createStartContractMock = () => createSetupContractMock();
+
+const createMock = () => {
+  const mocked: jest.Mocked<InjectedMetadataServiceContract> = {
+    setup: jest.fn(),
+    start: jest.fn(),
+  };
+
+  mocked.setup.mockReturnValue(createSetupContractMock());
+  mocked.start.mockReturnValue(createStartContractMock());
+
+  return mocked;
+};
 
 export const injectedMetadataServiceMock = {
   create: createMock,

src/core/public/injected_metadata/injected_metadata_service.ts

@@ -39,6 +39,7 @@ import {
   UserProvidedValues,
 } from '../../server/types';
 import { AppCategory, Branding } from '../';
+import { WazuhBuildInfo } from '../../types/wazuh_build_info';
 
 export interface InjectedPluginMetadata {
   id: PluginName;
@@ -54,7 +55,7 @@ export interface InjectedMetadataParams {
     version: string;
     buildNumber: number;
     branch: string;
-    wazuhVersion: string;
+    wazuhBuildInfo: WazuhBuildInfo;
     basePath: string;
     serverBasePath: string;
     category?: AppCategory;
@@ -171,13 +172,13 @@ export class InjectedMetadataService {
       },
 
       // Wazuh
-      getWazuhVersion: () => {
-        return this.state.wazuhVersion;
+      getWazuhBuildInfo: () => {
+        return this.state.wazuhBuildInfo;
       },
 
       // Wazuh
       getWazuhDocVersion: () => {
-        return this.state.wazuhVersion?.split('.').slice(0, 2).join('.') || 'current';
+        return this.state.wazuhBuildInfo.version?.split('.').slice(0, 2).join('.') || 'current';
       },
 
       // Wazuh
@@ -224,7 +225,7 @@ export interface InjectedMetadataSetup {
     enabled: boolean;
   };
   // Wazuh
-  getWazuhVersion: () => string;
+  getWazuhBuildInfo: () => WazuhBuildInfo;
   getWazuhDocVersion: () => string;
   getHealthCheck: () => HealthCheckConfig;
 }