register route handler context provider

elastic · Jun 12, 2020 · 1136503 · 1136503
1 parent ed011c0
commit 1136503
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 4 deletions.
diff --git a/x-pack/plugins/reporting/server/core.ts b/x-pack/plugins/reporting/server/core.ts
@@ -60,18 +60,22 @@ export class ReportingCore {
     this.pluginStart$.next(reportingStartDeps);
   }
 
-  public async pluginIsSetup(): Promise<boolean> {
+  public async pluginSetsUp(): Promise<boolean> {
     // use deps and config as a cached resolver
     if (this.pluginSetupDeps && this.config) {
       return true;
     }
     return await this.pluginSetup$.pipe(take(2)).toPromise(); // once for pluginSetupDeps (sync) and twice for config (async)
   }
 
-  public async pluginHasStarted(): Promise<boolean> {
+  public async pluginStartsUp(): Promise<boolean> {
     return await this.getPluginStartDeps().then(() => true);
   }
 
+  public pluginIsStarted() {
+    return this.pluginStartDeps !== undefined;
+  }
+
   public setConfig(config: ReportingConfig) {
     this.config = config;
     this.pluginSetup$.next(true);

diff --git a/x-pack/plugins/reporting/server/plugin.ts b/x-pack/plugins/reporting/server/plugin.ts
@@ -14,6 +14,12 @@ import { setFieldFormats } from './services';
 import { ReportingSetup, ReportingSetupDeps, ReportingStart, ReportingStartDeps } from './types';
 import { registerReportingUsageCollector } from './usage';
 
+declare module 'src/core/server' {
+  interface RequestHandlerContext {
+    reporting?: ReportingCore | null;
+  }
+}
+
 export class ReportingPlugin
   implements Plugin<ReportingSetup, ReportingStart, ReportingSetupDeps, ReportingStartDeps> {
   private readonly initializerContext: PluginInitializerContext<ReportingConfigType>;
@@ -27,6 +33,14 @@ export class ReportingPlugin
   }
 
   public setup(core: CoreSetup, plugins: ReportingSetupDeps) {
+    core.http.registerRouteHandlerContext('reporting', () => {
+      if (this.reportingCore.pluginIsStarted()) {
+        return this.reportingCore;
+      } else {
+        return null;
+      }
+    });
+
     const { elasticsearch, http } = core;
     const { licensing, security } = plugins;
     const { initializerContext: initContext, reportingCore } = this;
@@ -67,7 +81,7 @@ export class ReportingPlugin
 
     // async background start
     (async () => {
-      await this.reportingCore.pluginIsSetup();
+      await this.reportingCore.pluginSetsUp();
       const config = reportingCore.getConfig();
 
       const browserDriverFactory = await initializeBrowserDriverFactory(config, logger);

diff --git a/x-pack/plugins/reporting/server/routes/generation.ts b/x-pack/plugins/reporting/server/routes/generation.ts
@@ -27,6 +27,11 @@ export function registerJobGenerationRoutes(reporting: ReportingCore, logger: Lo
    * Generates enqueued job details to use in responses
    */
   const handler: HandlerFunction = async (user, exportTypeId, jobParams, context, req, res) => {
+    // ensure the async dependencies are loaded
+    if (!context.reporting) {
+      return res.custom({ statusCode: 503, body: 'Not Available' });
+    }
+
     const licenseInfo = await reporting.getLicenseInfo();
     const licenseResults = licenseInfo[exportTypeId];
 

diff --git a/x-pack/plugins/reporting/server/routes/jobs.ts b/x-pack/plugins/reporting/server/routes/jobs.ts
@@ -22,6 +22,10 @@ interface ListQuery {
 }
 const MAIN_ENTRY = `${API_BASE_URL}/jobs`;
 
+const handleUnavailable = (res: any) => {
+  return res.custom({ statusCode: 503, body: 'Not Available' });
+};
+
 export function registerJobInfoRoutes(reporting: ReportingCore) {
   const setupDeps = reporting.getPluginSetupDeps();
   const userHandler = authorizedUserPreRoutingFactory(reporting);
@@ -34,6 +38,11 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
       validate: false,
     },
     userHandler(async (user, context, req, res) => {
+      // ensure the async dependencies are loaded
+      if (!context.reporting) {
+        return handleUnavailable(res);
+      }
+
       const {
         management: { jobTypes = [] },
       } = await reporting.getLicenseInfo();
@@ -64,6 +73,11 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
       validate: false,
     },
     userHandler(async (user, context, req, res) => {
+      // ensure the async dependencies are loaded
+      if (!context.reporting) {
+        return handleUnavailable(res);
+      }
+
       const {
         management: { jobTypes = [] },
       } = await reporting.getLicenseInfo();
@@ -91,6 +105,11 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
       },
     },
     userHandler(async (user, context, req, res) => {
+      // ensure the async dependencies are loaded
+      if (!context.reporting) {
+        return handleUnavailable(res);
+      }
+
       const { docId } = req.params as { docId: string };
       const {
         management: { jobTypes = [] },
@@ -131,6 +150,11 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
       },
     },
     userHandler(async (user, context, req, res) => {
+      // ensure the async dependencies are loaded
+      if (!context.reporting) {
+        return res.custom({ statusCode: 503 });
+      }
+
       const { docId } = req.params as { docId: string };
       const {
         management: { jobTypes = [] },
@@ -178,6 +202,11 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
       },
     },
     userHandler(async (user, context, req, res) => {
+      // ensure the async dependencies are loaded
+      if (!context.reporting) {
+        return handleUnavailable(res);
+      }
+
       const { docId } = req.params as { docId: string };
       const {
         management: { jobTypes = [] },
@@ -199,6 +228,11 @@ export function registerJobInfoRoutes(reporting: ReportingCore) {
       },
     },
     userHandler(async (user, context, req, res) => {
+      // ensure the async dependencies are loaded
+      if (!context.reporting) {
+        return handleUnavailable(res);
+      }
+
       const { docId } = req.params as { docId: string };
       const {
         management: { jobTypes = [] },

diff --git a/x-pack/plugins/reporting/server/usage/reporting_usage_collector.ts b/x-pack/plugins/reporting/server/usage/reporting_usage_collector.ts
@@ -78,7 +78,7 @@ export function registerReportingUsageCollector(
       )
       .toPromise();
   };
-  const collectionIsReady = reporting.pluginHasStarted.bind(reporting);
+  const collectionIsReady = reporting.pluginStartsUp.bind(reporting);
 
   const collector = getReportingUsageCollector(
     reporting,