Run migrations on savedobjects start

src/cli/serve/serve.js

@@ -194,7 +194,6 @@ export default function (program) {
     .option('--plugins <path>', 'an alias for --plugin-dir', pluginDirCollector)
     .option('--optimize', 'Optimize and then stop the server');
 
-
   if (CAN_REPL) {
     command.option('--repl', 'Run the server with a REPL prompt and access to the server object');
   }
@@ -211,7 +210,8 @@ export default function (program) {
       .option('--ssl', 'Run the dev server using HTTPS')
       .option('--no-base-path', 'Don\'t put a proxy in front of the dev server, which adds a random basePath')
       .option('--no-watch', 'Prevents automatic restarts of the server in --dev mode')
-      .option('--no-dev-config', 'Prevents loading the kibana.dev.yml file in --dev mode');
+      .option('--no-dev-config', 'Prevents loading the kibana.dev.yml file in --dev mode')
+      .option('--skip-migrations', 'Don\'t run Saved Object migrations (testing only)');
   }
 
   command
@@ -241,6 +241,7 @@ export default function (program) {
           basePath: !!opts.basePath,
           optimize: !!opts.optimize,
           oss: !!opts.oss,
+          skipMigrations: !!opts.skipMigrations,
         },
         features: {
           isClusterModeSupported: CAN_CLUSTER,

src/core/server/config/env.ts

@@ -56,6 +56,7 @@ export interface CliArgs {
   optimize: boolean;
   open: boolean;
   oss: boolean;
+  skipMigrations: boolean;
 }
 
 export class Env {

src/core/server/saved_objects/migrations/kibana/kibana_migrator.ts

@@ -104,7 +104,14 @@ export class KibanaMigrator {
    * @returns
    * @memberof KibanaMigrator
    */
-  public awaitMigration = once(async () => {
+  public awaitMigration = once(async (skipMigrations: boolean = false) => {
+    if (skipMigrations) {
+      this.log.warn(
+        'Skipping Saved Object migrations on startup. Note: Individual documents will still be migrated when reading or writing documents.'
+      );
+      return Object.keys(this.mappingProperties).map(() => ({ status: 'skipped' }));
+    }
+
     const kibanaIndexName = this.kibanaConfig.index;
     const indexMap = createIndexMap({
       config: this.config,

src/core/server/saved_objects/saved_objects_service.ts

@@ -64,6 +64,7 @@ export interface SetupDeps {
 export class SavedObjectsService
   implements CoreService<SavedObjectsServiceSetup, SavedObjectsServiceStart> {
   private migrator: KibanaMigrator | undefined;
+
   constructor(private readonly coreContext: CoreContext) {}
 
   public async setup(coreSetup: SetupDeps) {
@@ -146,8 +147,18 @@ export class SavedObjectsService
   }
 
   public async start(core: StartDeps): Promise<SavedObjectsServiceStart> {
-    // Start migrations, but don't wait for them to complete
-    this.migrator!.awaitMigration();
+    /**
+     * Note: We want to ensure that migrations have completed before
+     * continuing with further Core startup steps such as running the legacy
+     * server, legacy plugins and allowing HTTP requests.
+     *
+     * However, our build system optimize step and some tests depend on the
+     * HTTP server running without an Elasticsearch server being available.
+     */
+    const cliArgs = this.coreContext.env.cliArgs;
+    const skipMigrations = cliArgs.optimize || cliArgs.skipMigrations;
+    await this.migrator!.awaitMigration(skipMigrations);
+
     return { migrator: this.migrator as KibanaMigrator };
   }
 

src/core/server/server.ts

@@ -120,19 +120,6 @@ export class Server {
       plugins: mapToObject(pluginsStart.contracts),
     });
 
-    /**
-     * Note: ideally we'd like to wait for migrations to complete before
-     * loading the legacy service which in turn starts legacy plugins. But,
-     * our build process relies on the optimize phase being able to run
-     * without a running ES server. Optimize in turn depends on the legacy
-     * server being started. So until optimization has been moved to the
-     * NP we move migrations till after legacy.start() and only if we're not
-     * running optimize.
-     */
-    if (!this.env.cliArgs.optimize) {
-      await savedObjectsStart.migrator.awaitMigration();
-    }
-
     await this.http.start();
 
     return coreStart;

src/legacy/server/kbn_server.js

@@ -161,8 +161,6 @@ export default class KbnServer {
 
     const { server, config } = this;
 
-    await server.kibanaMigrator.awaitMigration();
-
     if (isWorker) {
       // help parent process know when we are ready
       process.send(['WORKER_LISTENING']);

tasks/config/run.js

@@ -60,6 +60,7 @@ module.exports = function (grunt) {
     '--plugins.initialize=false',
     '--optimize.bundleFilter=tests',
     '--server.port=5610',
+    '--skip-migrations'
   ];
 
   const NODE = 'node';