[New platform] Introduce start phase for core services on server

src/core/public/plugins/plugins_service.mock.ts

@@ -31,6 +31,7 @@ type PluginsServiceContract = PublicMethodsOf<PluginsService>;
 const createMock = () => {
   const mocked: jest.Mocked<PluginsServiceContract> = {
     setup: jest.fn(),
+    start: jest.fn(),
     stop: jest.fn(),
   };
 

src/core/public/plugins/plugins_service.ts

@@ -98,6 +98,8 @@ export class PluginsService implements CoreService<PluginsServiceSetup> {
     return { contracts };
   }
 
+  public async start() {}
+
   public async stop() {
     // Stop plugins in reverse topological order.
     for (const pluginName of this.satupPlugins.reverse()) {

src/core/server/bootstrap.ts

@@ -84,6 +84,7 @@ export async function bootstrap({
 
   try {
     await root.setup();
+    await root.start();
   } catch (err) {
     await shutdown(err);
   }

src/core/server/elasticsearch/elasticsearch_service.mock.ts

@@ -39,6 +39,7 @@ type ElasticsearchServiceContract = PublicMethodsOf<ElasticsearchService>;
 const createMock = () => {
   const mocked: jest.Mocked<ElasticsearchServiceContract> = {
     setup: jest.fn(),
+    start: jest.fn(),
     stop: jest.fn(),
   };
   mocked.setup.mockResolvedValue(createSetupContractMock());

src/core/server/elasticsearch/elasticsearch_service.ts

@@ -106,6 +106,8 @@ export class ElasticsearchService implements CoreService<ElasticsearchServiceSet
     };
   }
 
+  public async start() {}
+
   public async stop() {
     this.log.debug('Stopping elasticsearch service');
 

src/core/server/http/http_server.test.ts

@@ -56,6 +56,7 @@ afterEach(async () => {
 test('listening after started', async () => {
   expect(server.isListening()).toBe(false);
 
+  await server.setup(config);
   await server.start(config);
 
   expect(server.isListening()).toBe(true);
@@ -68,8 +69,8 @@ test('200 OK with body', async () => {
     return res.ok({ key: 'value' });
   });
 
-  server.registerRouter(router);
-
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
   const { server: innerServer } = await server.start(config);
 
   await supertest(innerServer.listener)
@@ -87,7 +88,8 @@ test('202 Accepted with body', async () => {
     return res.accepted({ location: 'somewhere' });
   });
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -106,7 +108,8 @@ test('204 No content', async () => {
     return res.noContent();
   });
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -127,7 +130,8 @@ test('400 Bad request with error', async () => {
     return res.badRequest(err);
   });
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -156,7 +160,8 @@ test('valid params', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -185,7 +190,8 @@ test('invalid params', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -217,7 +223,8 @@ test('valid query', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -246,7 +253,8 @@ test('invalid query', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -278,7 +286,8 @@ test('valid body', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -311,7 +320,8 @@ test('invalid body', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -343,7 +353,8 @@ test('handles putting', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -373,7 +384,8 @@ test('handles deleting', async () => {
     }
   );
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -398,7 +410,8 @@ test('filtered headers', async () => {
     return res.noContent();
   });
 
-  server.registerRouter(router);
+  const { registerRouter } = await server.setup(config);
+  registerRouter(router);
 
   const { server: innerServer } = await server.start(config);
 
@@ -430,7 +443,8 @@ describe('with `basepath: /bar` and `rewriteBasePath: false`', () => {
       res.ok({ key: 'value:/foo' })
     );
 
-    server.registerRouter(router);
+    const { registerRouter } = await server.setup(config);
+    registerRouter(router);
 
     const { server: innerServer } = await server.start(configWithBasePath);
     innerServerListener = innerServer.listener;
@@ -490,7 +504,8 @@ describe('with `basepath: /bar` and `rewriteBasePath: true`', () => {
       res.ok({ key: 'value:/foo' })
     );
 
-    server.registerRouter(router);
+    const { registerRouter } = await server.setup(config);
+    registerRouter(router);
 
     const { server: innerServer } = await server.start(configWithBasePath);
     innerServerListener = innerServer.listener;
@@ -555,25 +570,28 @@ describe('with defined `redirectHttpFromPort`', () => {
     const router = new Router('/');
     router.get({ path: '/', validate: false }, async (req, res) => res.ok({ key: 'value:/' }));
 
-    server.registerRouter(router);
+    const { registerRouter } = await server.setup(config);
+    registerRouter(router);
 
     await server.start(configWithSSL);
   });
 });
 
 test('returns server and connection options on start', async () => {
-  const { server: innerServer, options } = await server.start({
+  const configWithPort = {
     ...config,
     port: 12345,
-  });
+  };
+  const { options } = await server.setup(configWithPort);
+  const { server: innerServer } = await server.start(configWithPort);
 
   expect(innerServer).toBeDefined();
   expect(innerServer).toBe((server as any).server);
   expect(options).toMatchSnapshot();
 });
 
 test('registers auth request interceptor only once', async () => {
-  const { registerAuth } = await server.start(config);
+  const { registerAuth } = await server.setup(config);
   const doRegister = () =>
     registerAuth(() => null as any, {
       encryptionKey: 'any_password',
@@ -584,7 +602,7 @@ test('registers auth request interceptor only once', async () => {
 });
 
 test('registers onRequest interceptor several times', async () => {
-  const { registerOnRequest } = await server.start(config);
+  const { registerOnRequest } = await server.setup(config);
   const doRegister = () => registerOnRequest(() => null as any);
 
   doRegister();

src/core/server/http/http_server.ts

@@ -31,9 +31,9 @@ import {
   createCookieSessionStorageFactory,
 } from './cookie_session_storage';
 
-export interface HttpServerInfo {
-  server: Server;
+export interface HttpServerSetup {
   options: ServerOptions;
+  registerRouter: (router: Router) => void;
   /**
    * Define custom authentication and/or authorization mechanism for incoming requests.
    * Applied to all resources by default. Only one AuthenticationHandler can be registered.
@@ -50,6 +50,10 @@ export interface HttpServerInfo {
   registerOnRequest: (requestHandler: OnRequestHandler) => void;
 }
 
+export interface HttpServerInfo {
+  server: Server;
+}
+
 export class HttpServer {
   private server?: Server;
   private registeredRouters = new Set<Router>();
@@ -61,20 +65,36 @@ export class HttpServer {
     return this.server !== undefined && this.server.listener.listening;
   }
 
-  public registerRouter(router: Router) {
+  private registerRouter(router: Router) {
     if (this.isListening()) {
       throw new Error('Routers can be registered only when HTTP server is stopped.');
     }
 
+    this.log.debug(`registering route handler for [${router.path}]`);
     this.registeredRouters.add(router);
   }
 
-  public async start(config: HttpConfig): Promise<HttpServerInfo> {
-    this.log.debug('starting http server');
-
+  public setup(config: HttpConfig): HttpServerSetup {
     const serverOptions = getServerOptions(config);
     this.server = createServer(serverOptions);
 
+    return {
+      options: serverOptions,
+      registerRouter: this.registerRouter.bind(this),
+      registerOnRequest: this.registerOnRequest.bind(this),
+      registerAuth: <T>(
+        fn: AuthenticationHandler<T>,
+        cookieOptions: SessionStorageCookieOptions<T>
+      ) => this.registerAuth(fn, cookieOptions, config.basePath),
+    };
+  }
+
+  public async start(config: HttpConfig): Promise<HttpServerInfo> {
+    if (this.server === undefined) {
+      throw new Error('server is not setup up yet');
+    }
+    this.log.debug('starting http server');
+
     this.setupBasePathRewrite(this.server, config);
 
     for (const router of this.registeredRouters) {
@@ -100,12 +120,6 @@ export class HttpServer {
     // needed anymore we shouldn't return anything from this method.
     return {
       server: this.server,
-      options: serverOptions,
-      registerOnRequest: this.registerOnRequest.bind(this),
-      registerAuth: <T>(
-        fn: AuthenticationHandler<T>,
-        cookieOptions: SessionStorageCookieOptions<T>
-      ) => this.registerAuth(fn, cookieOptions, config.basePath),
     };
   }
 

src/core/server/http/http_service.mock.ts

@@ -22,23 +22,31 @@ import { HttpService } from './http_service';
 
 const createSetupContractMock = () => {
   const setupContract = {
-    // we can mock some hapi server method when we need it
-    server: {} as Server,
     options: {} as ServerOptions,
     registerAuth: jest.fn(),
     registerOnRequest: jest.fn(),
+    registerRouter: jest.fn(),
   };
   return setupContract;
 };
 
+const createStartContractMock = () => {
+  const startContract = {
+    // we can mock some hapi server method when we need it
+    server: {} as Server,
+  };
+  return startContract;
+};
+
 type HttpServiceContract = PublicMethodsOf<HttpService>;
 const createHttpServiceMock = () => {
   const mocked: jest.Mocked<HttpServiceContract> = {
     setup: jest.fn(),
+    start: jest.fn(),
     stop: jest.fn(),
-    registerRouter: jest.fn(),
   };
   mocked.setup.mockResolvedValue(createSetupContractMock());
+  mocked.start.mockResolvedValue(createStartContractMock());
   return mocked;
 };