[9.1] [Product docs] Fix bug not upgrading all previously installed product docs (E5) upon Kibana version upgrade (#234792) (#235285)

kibanamachine · qn895 · elasticmachine · web-flow · commit 1e4702ab4015 · 2025-09-17T03:25:38.000+02:00
# Backport This will backport the following commits from `main` to `9.1`: - [[Product docs] Fix bug not upgrading all previously installed product docs (E5) upon Kibana version upgrade (#234792)](#234792)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Quynh Nguyen (Quinn) <43350163+qn895@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
diff --git a/packages/kbn-optimizer/limits.yml b/packages/kbn-optimizer/limits.yml
@@ -117,7 +117,7 @@ pageLoadAssetSize:
   painlessLab: 6299
   presentationPanel: 11484
   presentationUtil: 9000
-  productDocBase: 3058
+  productDocBase: 3074
   productIntercept: 9860
   profiling: 20716
   remoteClusters: 10170
diff --git a/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/plugin.test.ts b/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/plugin.test.ts
@@ -15,13 +15,16 @@ import { ProductDocBaseSetupDependencies, ProductDocBaseStartDependencies } from
 jest.mock('./services/package_installer');
 jest.mock('./services/search');
 jest.mock('./services/doc_install_status');
+jest.mock('./services/doc_manager');
 jest.mock('./routes');
 jest.mock('./tasks');
 import { registerRoutes } from './routes';
 import { PackageInstaller } from './services/package_installer';
 import { registerTaskDefinitions, scheduleEnsureUpToDateTask } from './tasks';
+import { DocumentationManager } from './services/doc_manager';
 
 const PackageInstallMock = PackageInstaller as jest.Mock;
+const DocumentationManagerMock = DocumentationManager as jest.Mock;
 
 describe('ProductDocBasePlugin', () => {
   let initContext: ReturnType<typeof coreMock.createPluginInitializerContext>;
@@ -41,6 +44,14 @@ describe('ProductDocBasePlugin', () => {
     };
 
     PackageInstallMock.mockReturnValue({ ensureUpToDate: jest.fn().mockResolvedValue({}) });
+
+    DocumentationManagerMock.mockReturnValue({
+      install: jest.fn().mockResolvedValue({}),
+      update: jest.fn().mockResolvedValue({}),
+      uninstall: jest.fn().mockResolvedValue({}),
+      getStatus: jest.fn().mockResolvedValue({}),
+      updateAll: jest.fn().mockResolvedValue({}),
+    });
   });
 
   afterEach(() => {
@@ -81,6 +92,7 @@ describe('ProductDocBasePlugin', () => {
           install: expect.any(Function),
           uninstall: expect.any(Function),
           update: expect.any(Function),
+          updateAll: expect.any(Function),
         },
         search: expect.any(Function),
       });
@@ -89,8 +101,7 @@ describe('ProductDocBasePlugin', () => {
     it('schedules the update task', () => {
       plugin.setup(coreMock.createSetup(), pluginSetupDeps);
       plugin.start(coreMock.createStart(), pluginStartDeps);
-
-      expect(scheduleEnsureUpToDateTask).toHaveBeenCalledTimes(1);
+      expect(DocumentationManagerMock().updateAll).toHaveBeenCalledTimes(1);
     });
   });
 });
diff --git a/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/plugin.ts b/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/plugin.ts
@@ -10,7 +10,6 @@ import type { Logger } from '@kbn/logging';
 import { getDataPath } from '@kbn/utils';
 import type { CoreSetup, CoreStart, Plugin, PluginInitializerContext } from '@kbn/core/server';
 import { SavedObjectsClient } from '@kbn/core/server';
-import { defaultInferenceEndpoints } from '@kbn/inference-common';
 import { productDocInstallStatusSavedObjectTypeName } from '../common/consts';
 import type { ProductDocBaseConfig } from './config';
 import {
@@ -114,14 +113,14 @@ export class ProductDocBasePlugin
       taskManager,
     };
 
-    documentationManager.update({ inferenceId: defaultInferenceEndpoints.ELSER }).catch((err) => {
-      this.logger.error(`Error scheduling product documentation update task: ${err.message}`);
+    documentationManager.updateAll().catch((err) => {
+      this.logger.error(`Error scheduling product documentation updateAll task: ${err.message}`);
     });
-
     return {
       management: {
         install: documentationManager.install.bind(documentationManager),
         update: documentationManager.update.bind(documentationManager),
+        updateAll: documentationManager.updateAll.bind(documentationManager),
         uninstall: documentationManager.uninstall.bind(documentationManager),
         getStatus: documentationManager.getStatus.bind(documentationManager),
       },
diff --git a/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_install_status/product_doc_install_service.ts b/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_install_status/product_doc_install_service.ts
@@ -30,10 +30,11 @@ export class ProductDocInstallClient {
       perPage: 100,
     };
     const response = await this.soClient.find<TypeAttributes>(query);
+    const savedObjects = response?.saved_objects.filter(
+      (so) => so.attributes?.installation_status === 'installed'
+    );
     const inferenceIds = new Set(
-      response?.saved_objects.map(
-        (so) => so.attributes?.inference_id ?? defaultInferenceEndpoints.ELSER
-      )
+      savedObjects.map((so) => so.attributes?.inference_id ?? defaultInferenceEndpoints.ELSER)
     );
     return Array.from(inferenceIds);
   }
diff --git a/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_manager/doc_manager.test.ts b/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_manager/doc_manager.test.ts
@@ -54,6 +54,12 @@ describe('DocumentationManager', () => {
 
     docInstallClient = {
       getInstallationStatus: jest.fn(),
+      getPreviouslyInstalledInferenceIds: jest
+        .fn()
+        .mockResolvedValue([
+          defaultInferenceEndpoints.MULTILINGUAL_E5_SMALL,
+          defaultInferenceEndpoints.ELSER,
+        ]),
     } as unknown as jest.Mocked<ProductDocInstallClient>;
 
     docManager = new DocumentationManager({
diff --git a/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_manager/doc_manager.ts b/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_manager/doc_manager.ts
@@ -28,6 +28,7 @@ import type {
   DocInstallOptions,
   DocUninstallOptions,
   DocUpdateOptions,
+  DocUpdateAllOptions,
 } from './types';
 import { INSTALL_ALL_TASK_ID_MULTILINGUAL } from '../../tasks/install_all';
 
@@ -139,6 +140,18 @@ export class DocumentationManager implements DocumentationManagerAPI {
       });
     }
   }
+  async updateAll(options?: DocUpdateAllOptions): Promise<{ inferenceIds: string[] }> {
+    const { inferenceIds } = options ?? {};
+    const idsToUpdate: string[] =
+      inferenceIds ?? (await this.docInstallClient.getPreviouslyInstalledInferenceIds()) ?? [];
+    this.logger.info(
+      `Updating product documentation to latest version for Inference IDs: ${idsToUpdate}`
+    );
+    await Promise.all(idsToUpdate.map((inferenceId) => this.update({ inferenceId })));
+    return {
+      inferenceIds: idsToUpdate,
+    };
+  }
 
   async uninstall(options: DocUninstallOptions): Promise<void> {
     const { request, wait = false, inferenceId } = options;
diff --git a/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_manager/types.ts b/x-pack/platform/plugins/shared/ai_infra/product_doc_base/server/services/doc_manager/types.ts
@@ -23,6 +23,11 @@ export interface DocumentationManagerAPI {
    * No-op if the product documentation is not currently installed.
    */
   update(options?: DocUpdateOptions): Promise<void>;
+  /**
+   * Update the product documentation for all previously installed inference IDs to the latest version.
+   * No-op if the product documentation is not currently installed.
+   */
+  updateAll(options?: DocUpdateAllOptions): Promise<{ inferenceIds: string[] }>;
   /**
    * Uninstall the product documentation.
    * No-op if the product documentation is not currently installed.
@@ -110,3 +115,23 @@ export interface DocUpdateOptions {
    */
   inferenceId: string;
 }
+
+/**
+ * Options for {@link DocumentationManagerAPI.updateAll}
+ */
+export interface DocUpdateAllOptions {
+  /**
+   * When the operation was requested by a user, the request that initiated it.
+   *
+   * If not provided, the call will be considered as being done on behalf of system.
+   */
+  request?: KibanaRequest;
+  /**
+   * If true, the docs with the same version majorMinor version will be forced to updated regardless
+   */
+  forceUpdate?: boolean;
+  /**
+   * inferenceIds to update
+   */
+  inferenceIds?: string[];
+}
diff --git a/x-pack/solutions/security/plugins/elastic_assistant/server/ai_assistant_service/helpers.test.ts b/x-pack/solutions/security/plugins/elastic_assistant/server/ai_assistant_service/helpers.test.ts
@@ -14,6 +14,7 @@ const mockProductDocManager = {
   install: jest.fn(),
   uninstall: jest.fn(),
   update: jest.fn(),
+  updateAll: jest.fn(),
 };
 
 describe('helpers', () => {
diff --git a/x-pack/solutions/security/plugins/elastic_assistant/server/ai_assistant_service/index.test.ts b/x-pack/solutions/security/plugins/elastic_assistant/server/ai_assistant_service/index.test.ts
@@ -137,6 +137,7 @@ describe('AI Assistant Service', () => {
         getStatus: jest.fn(),
         install: jest.fn(),
         update: jest.fn(),
+        updateAll: jest.fn(),
         uninstall: jest.fn(),
       }),
     };
