[8.6] Fix SO service status when migration is disabled (elastic#145693)…

… (elastic#145974) # Backport This will backport the following commits from `main` to `8.6`: - [Fix SO service status when migration is disabled (elastic#145693)](elastic#145693)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
kibanamachine · Nov 22, 2022 · a06f55b · a06f55b
1 parent 6dfa1dd
commit a06f55b
Show file tree

Hide file tree

Showing 4 changed files with 169 additions and 41 deletions.
diff --git a/...s/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.ts b/...s/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.test.ts
@@ -17,8 +17,9 @@ import {
   registerRoutesMock,
   typeRegistryInstanceMock,
 } from './saved_objects_service.test.mocks';
-import { BehaviorSubject } from 'rxjs';
-import { RawPackageInfo, Env } from '@kbn/config';
+import { BehaviorSubject, firstValueFrom } from 'rxjs';
+import { skip } from 'rxjs/operators';
+import { type RawPackageInfo, Env } from '@kbn/config';
 import { ByteSizeValue } from '@kbn/config-schema';
 import { REPO_ROOT } from '@kbn/utils';
 import { getEnvOptions } from '@kbn/config-mocks';
@@ -249,6 +250,21 @@ describe('SavedObjectsService', () => {
         expect(getTypeRegistry()).toBe(typeRegistryInstanceMock);
       });
     });
+
+    describe('status$', () => {
+      it('return correct value when migration is skipped', async () => {
+        const coreContext = createCoreContext({ skipMigration: true });
+        const soService = new SavedObjectsService(coreContext);
+        const setup = await soService.setup(createSetupDeps());
+        await soService.start(createStartDeps(false));
+
+        const serviceStatus = await firstValueFrom(setup.status$.pipe(skip(1)));
+        expect(serviceStatus.level.toString()).toEqual('available');
+        expect(serviceStatus.summary).toEqual(
+          'SavedObjects service has completed migrations and is available'
+        );
+      });
+    });
   });
 
   describe('#start()', () => {

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/saved_objects_service.ts
@@ -6,7 +6,7 @@
  * Side Public License, v 1.
  */
 
-import { Subject, Observable, firstValueFrom } from 'rxjs';
+import { Subject, Observable, firstValueFrom, of } from 'rxjs';
 import { filter, take, switchMap } from 'rxjs/operators';
 import type { Logger } from '@kbn/logging';
 import type { ServiceStatus } from '@kbn/core-status-common';
@@ -148,9 +148,13 @@ export class SavedObjectsService
 
     registerCoreObjectTypes(this.typeRegistry);
 
+    const skipMigration = this.config.migration.skip;
+
     return {
       status$: calculateStatus$(
-        this.migrator$.pipe(switchMap((migrator) => migrator.getStatus$())),
+        skipMigration
+          ? of({ status: 'completed' })
+          : this.migrator$.pipe(switchMap((migrator) => migrator.getStatus$())),
         elasticsearch.status$
       ),
       setClientFactoryProvider: (provider) => {

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/status.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/status.ts
@@ -17,43 +17,7 @@ export const calculateStatus$ = (
   elasticsearchStatus$: Observable<ServiceStatus>
 ): Observable<ServiceStatus<SavedObjectStatusMeta>> => {
   const migratorStatus$: Observable<ServiceStatus<SavedObjectStatusMeta>> = rawMigratorStatus$.pipe(
-    map((migrationStatus) => {
-      if (migrationStatus.status === 'waiting_to_start') {
-        return {
-          level: ServiceStatusLevels.unavailable,
-          summary: `SavedObjects service is waiting to start migrations`,
-        };
-      } else if (migrationStatus.status === 'waiting_for_other_nodes') {
-        return {
-          level: ServiceStatusLevels.unavailable,
-          summary: `SavedObjects service is waiting for other nodes to complete the migration`,
-          detail:
-            `If no other Kibana instance is attempting ` +
-            `migrations, you can get past this message by deleting index ${migrationStatus.waitingIndex} and ` +
-            `restarting Kibana.`,
-        };
-      } else if (migrationStatus.status === 'running') {
-        return {
-          level: ServiceStatusLevels.unavailable,
-          summary: `SavedObjects service is running migrations`,
-        };
-      }
-
-      const statusCounts: SavedObjectStatusMeta['migratedIndices'] = { migrated: 0, skipped: 0 };
-      if (migrationStatus.result) {
-        migrationStatus.result.forEach(({ status }) => {
-          statusCounts[status] = (statusCounts[status] ?? 0) + 1;
-        });
-      }
-
-      return {
-        level: ServiceStatusLevels.available,
-        summary: `SavedObjects service has completed migrations and is available`,
-        meta: {
-          migratedIndices: statusCounts,
-        },
-      };
-    }),
+    map(migratorStatusToServiceStatus),
     startWith({
       level: ServiceStatusLevels.unavailable,
       summary: `SavedObjects service is waiting to start migrations`,
@@ -80,3 +44,43 @@ export const calculateStatus$ = (
     })
   );
 };
+
+const migratorStatusToServiceStatus = (
+  migrationStatus: KibanaMigratorStatus
+): ServiceStatus<SavedObjectStatusMeta> => {
+  if (migrationStatus.status === 'waiting_to_start') {
+    return {
+      level: ServiceStatusLevels.unavailable,
+      summary: `SavedObjects service is waiting to start migrations`,
+    };
+  } else if (migrationStatus.status === 'waiting_for_other_nodes') {
+    return {
+      level: ServiceStatusLevels.unavailable,
+      summary: `SavedObjects service is waiting for other nodes to complete the migration`,
+      detail:
+        `If no other Kibana instance is attempting ` +
+        `migrations, you can get past this message by deleting index ${migrationStatus.waitingIndex} and ` +
+        `restarting Kibana.`,
+    };
+  } else if (migrationStatus.status === 'running') {
+    return {
+      level: ServiceStatusLevels.unavailable,
+      summary: `SavedObjects service is running migrations`,
+    };
+  }
+
+  const statusCounts: SavedObjectStatusMeta['migratedIndices'] = { migrated: 0, skipped: 0 };
+  if (migrationStatus.result) {
+    migrationStatus.result.forEach(({ status }) => {
+      statusCounts[status] = (statusCounts[status] ?? 0) + 1;
+    });
+  }
+
+  return {
+    level: ServiceStatusLevels.available,
+    summary: `SavedObjects service has completed migrations and is available`,
+    meta: {
+      migratedIndices: statusCounts,
+    },
+  };
+};
diff --git a/src/core/server/integration_tests/saved_objects/migrations/skip_migration.test.ts b/src/core/server/integration_tests/saved_objects/migrations/skip_migration.test.ts
@@ -0,0 +1,104 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import Path from 'path';
+import Fs from 'fs';
+import Util from 'util';
+import { firstValueFrom } from 'rxjs';
+import * as kbnTestServer from '../../../../test_helpers/kbn_server';
+import { Root } from '@kbn/core-root-server-internal';
+
+const logFilePath = Path.join(__dirname, 'cleanup.log');
+const asyncUnlink = Util.promisify(Fs.unlink);
+
+async function removeLogFile() {
+  // ignore errors if it doesn't exist
+  await asyncUnlink(logFilePath).catch(() => void 0);
+}
+
+function createRoot({ skipMigration }: { skipMigration: boolean }) {
+  return kbnTestServer.createRootWithCorePlugins(
+    {
+      migrations: {
+        skip: skipMigration,
+      },
+      logging: {
+        appenders: {
+          file: {
+            type: 'file',
+            fileName: logFilePath,
+            layout: {
+              type: 'json',
+            },
+          },
+        },
+        loggers: [
+          {
+            name: 'root',
+            appenders: ['file'],
+            level: 'info',
+          },
+        ],
+      },
+    },
+    {
+      oss: true,
+    }
+  );
+}
+
+describe('starting with `migration.skip: true` when indices are up to date', () => {
+  let esServer: kbnTestServer.TestElasticsearchUtils;
+  let root: Root;
+
+  beforeAll(async () => {
+    await removeLogFile();
+  });
+
+  afterAll(async () => {
+    if (root) {
+      await root.shutdown();
+    }
+    if (esServer) {
+      await esServer.stop();
+    }
+
+    await new Promise((resolve) => setTimeout(resolve, 10000));
+  });
+
+  it('starts and display the correct service status', async () => {
+    const { startES } = kbnTestServer.createTestServers({
+      adjustTimeout: (t: number) => jest.setTimeout(t),
+      settings: {
+        es: {
+          license: 'basic',
+        },
+      },
+    });
+    esServer = await startES();
+
+    // booting root a first time to setup the indices
+    root = createRoot({ skipMigration: false });
+    await root.preboot();
+    await root.setup();
+    await root.start();
+    await root.shutdown();
+
+    // booting another root with migration skipped this time
+    root = createRoot({ skipMigration: true });
+    await root.preboot();
+    const setup = await root.setup();
+    await root.start();
+
+    const status = await firstValueFrom(setup.status.core$);
+    expect(status.savedObjects.level.toString()).toEqual('available');
+    expect(status.savedObjects.summary).toEqual(
+      'SavedObjects service has completed migrations and is available'
+    );
+  });
+});