[Reporting] Define shims of legacy dependencies

x-pack/legacy/plugins/reporting/index.ts

@@ -16,11 +16,12 @@ import {
   getExportTypesRegistry,
   runValidations,
 } from './server/lib';
-import { config as reportingConfig } from './config';
-import { logConfiguration } from './log_configuration';
 import { createBrowserDriverFactory } from './server/browsers';
 import { registerReportingUsageCollector } from './server/usage';
 import { ReportingConfigOptions, ReportingPluginSpecOptions, ServerFacade } from './types.d';
+import { config as reportingConfig } from './config';
+import { logConfiguration } from './log_configuration';
+import { makeServerFacade } from './make_server_facade';
 
 const kbToBase64Length = (kb: number) => {
   return Math.floor((kb * 1024 * 8) / 6);
@@ -70,9 +71,8 @@ export const reporting = (kibana: any) => {
       },
     },
 
-    // TODO: Decouple Hapi: Build a server facade object based on the server to
-    // pass through to the libs. Do not pass server directly
-    async init(server: ServerFacade) {
+    async init(originalServer: ServerFacade) {
+      const server = makeServerFacade(originalServer);
       const exportTypesRegistry = getExportTypesRegistry();
 
       let isCollectorReady = false;

x-pack/legacy/plugins/reporting/make_server_facade.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { ServerFacade } from './types';
+
+export function makeServerFacade(server: ServerFacade): ServerFacade {
+  return {
+    config: server.config,
+    info: server.info,
+    route: server.route.bind(server),
+    newPlatform: server.newPlatform,
+    plugins: {
+      elasticsearch: server.plugins.elasticsearch,
+      xpack_main: server.plugins.xpack_main,
+      security: server.plugins.security,
+    },
+    savedObjects: server.savedObjects,
+    uiSettingsServiceFactory: server.uiSettingsServiceFactory,
+    log: server.log.bind(server),
+  };
+}

x-pack/legacy/plugins/reporting/server/lib/get_user.js → x-pack/legacy/plugins/reporting/server/lib/get_user.ts

@@ -4,14 +4,17 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-export function getUserFactory(server) {
-  return async request => {
+import { Request } from 'hapi';
+import { RequestFacade, ServerFacade } from '../../types';
+
+export function getUserFactory(server: ServerFacade) {
+  return async (request: RequestFacade) => {
     if (!server.plugins.security) {
       return null;
     }
 
     try {
-      return await server.plugins.security.getUser(request);
+      return await server.plugins.security.getUser((request as unknown) as Request);
     } catch (err) {
       server.log(['reporting', 'getUser', 'debug'], err);
       return null;

x-pack/legacy/plugins/reporting/server/lib/level_logger.ts

@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-type ServerLog = (tags: string[], msg: string) => void;
+import { ServerFacade } from '../../types';
 
 const trimStr = (toTrim: string) => {
   return typeof toTrim === 'string' ? toTrim.trim() : toTrim;
@@ -16,12 +16,12 @@ export class LevelLogger {
 
   public warn: (msg: string, tags?: string[]) => void;
 
-  static createForServer(server: any, tags: string[]) {
-    const serverLog: ServerLog = (tgs: string[], msg: string) => server.log(tgs, msg);
+  static createForServer(server: ServerFacade, tags: string[]) {
+    const serverLog: ServerFacade['log'] = (tgs: string[], msg: string) => server.log(tgs, msg);
     return new LevelLogger(serverLog, tags);
   }
 
-  constructor(logger: ServerLog, tags: string[]) {
+  constructor(logger: ServerFacade['log'], tags: string[]) {
     this._logger = logger;
     this._tags = tags;
 

x-pack/legacy/plugins/reporting/server/lib/once_per_server.ts

@@ -27,10 +27,6 @@ export function oncePerServer(fn: ServerFn) {
       throw new TypeError('This function expects to be called with a single argument');
     }
 
-    if (!server || typeof server.expose !== 'function') {
-      throw new TypeError('This function expects to be passed the server');
-    }
-
     // @ts-ignore
     return fn.call(this, server);
   });

x-pack/legacy/plugins/reporting/server/routes/generate_from_jobparams.ts

@@ -14,6 +14,7 @@ import {
   GetRouteConfigFactoryFn,
   RouteConfigFactory,
 } from './lib/route_config_factories';
+import { makeRequestFacade } from './lib/make_request_facade';
 import { HandlerErrorFunction, HandlerFunction } from './types';
 
 const BASE_GENERATE = `${API_BASE_URL}/generate`;
@@ -54,7 +55,8 @@ export function registerGenerateFromJobParams(
     path: `${BASE_GENERATE}/{exportType}`,
     method: 'POST',
     options: getRouteConfig(),
-    handler: async (request: RequestFacade, h: ReportingResponseToolkit) => {
+    handler: async (originalRequest: RequestFacade, h: ReportingResponseToolkit) => {
+      const request = makeRequestFacade(originalRequest);
       let jobParamsRison: string | null;
 
       if (request.payload) {

x-pack/legacy/plugins/reporting/server/routes/generate_from_savedobject.ts

@@ -9,6 +9,7 @@ import { API_BASE_GENERATE_V1, CSV_FROM_SAVEDOBJECT_JOB_TYPE } from '../../commo
 import { ServerFacade, RequestFacade, ReportingResponseToolkit } from '../../types';
 import { HandlerErrorFunction, HandlerFunction, QueuedJobPayload } from './types';
 import { getRouteOptionsCsv } from './lib/route_config_factories';
+import { makeRequestFacade } from './lib/make_request_facade';
 import { getJobParamsFromRequest } from '../../export_types/csv_from_savedobject/server/lib/get_job_params_from_request';
 
 /*
@@ -31,7 +32,8 @@ export function registerGenerateCsvFromSavedObject(
     path: `${API_BASE_GENERATE_V1}/csv/saved-object/{savedObjectType}:{savedObjectId}`,
     method: 'POST',
     options: routeOptions,
-    handler: async (request: RequestFacade, h: ReportingResponseToolkit) => {
+    handler: async (originalRequest: RequestFacade, h: ReportingResponseToolkit) => {
+      const request = makeRequestFacade(originalRequest);
       /*
        * 1. Build `jobParams` object: job data that execution will need to reference in various parts of the lifecycle
        * 2. Pass the jobParams and other common params to `handleRoute`, a shared function to enqueue the job with the params

x-pack/legacy/plugins/reporting/server/routes/generate_from_savedobject_immediate.ts

@@ -16,8 +16,9 @@ import {
   JobDocOutputExecuted,
 } from '../../types';
 import { JobDocPayloadPanelCsv } from '../../export_types/csv_from_savedobject/types';
-import { getRouteOptionsCsv } from './lib/route_config_factories';
 import { getJobParamsFromRequest } from '../../export_types/csv_from_savedobject/server/lib/get_job_params_from_request';
+import { getRouteOptionsCsv } from './lib/route_config_factories';
+import { makeRequestFacade } from './lib/make_request_facade';
 
 /*
  * This function registers API Endpoints for immediate Reporting jobs. The API inputs are:
@@ -43,7 +44,8 @@ export function registerGenerateCsvFromSavedObjectImmediate(
     path: `${API_BASE_GENERATE_V1}/immediate/csv/saved-object/{savedObjectType}:{savedObjectId}`,
     method: 'POST',
     options: routeOptions,
-    handler: async (request: RequestFacade, h: ReportingResponseToolkit) => {
+    handler: async (originalRequest: RequestFacade, h: ReportingResponseToolkit) => {
+      const request = makeRequestFacade(originalRequest);
       const logger = parentLogger.clone(['savedobject-csv']);
       const jobParams = getJobParamsFromRequest(request, { isImmediate: true });
 

x-pack/legacy/plugins/reporting/server/routes/generation.ts

@@ -18,6 +18,7 @@ import { registerGenerateFromJobParams } from './generate_from_jobparams';
 import { registerGenerateCsvFromSavedObject } from './generate_from_savedobject';
 import { registerGenerateCsvFromSavedObjectImmediate } from './generate_from_savedobject_immediate';
 import { createQueueFactory, enqueueJobFactory } from '../lib';
+import { makeRequestFacade } from './lib/make_request_facade';
 
 export function registerJobGenerationRoutes(
   server: ServerFacade,
@@ -39,9 +40,10 @@ export function registerJobGenerationRoutes(
   async function handler(
     exportTypeId: string,
     jobParams: object,
-    request: RequestFacade,
+    originalRequest: RequestFacade,
     h: ReportingResponseToolkit
   ) {
+    const request = makeRequestFacade(originalRequest);
     const user = request.pre.user;
     const headers = request.headers;
 

x-pack/legacy/plugins/reporting/server/routes/jobs.ts

@@ -23,6 +23,7 @@ import {
   getRouteConfigFactoryDownloadPre,
   getRouteConfigFactoryManagementPre,
 } from './lib/route_config_factories';
+import { makeRequestFacade } from './lib/make_request_facade';
 
 const MAIN_ENTRY = `${API_BASE_URL}/jobs`;
 
@@ -40,7 +41,8 @@ export function registerJobInfoRoutes(
     path: `${MAIN_ENTRY}/list`,
     method: 'GET',
     options: getRouteConfig(),
-    handler: (request: RequestFacade) => {
+    handler: (originalRequest: RequestFacade) => {
+      const request = makeRequestFacade(originalRequest);
       const { page: queryPage, size: querySize, ids: queryIds } = request.query;
       const page = parseInt(queryPage, 10) || 0;
       const size = Math.min(100, parseInt(querySize, 10) || 10);
@@ -62,7 +64,8 @@ export function registerJobInfoRoutes(
     path: `${MAIN_ENTRY}/count`,
     method: 'GET',
     options: getRouteConfig(),
-    handler: (request: RequestFacade) => {
+    handler: (originalRequest: RequestFacade) => {
+      const request = makeRequestFacade(originalRequest);
       const results = jobsQuery.count(request.pre.management.jobTypes, request.pre.user);
       return results;
     },
@@ -73,7 +76,8 @@ export function registerJobInfoRoutes(
     path: `${MAIN_ENTRY}/output/{docId}`,
     method: 'GET',
     options: getRouteConfig(),
-    handler: (request: RequestFacade) => {
+    handler: (originalRequest: RequestFacade) => {
+      const request = makeRequestFacade(originalRequest);
       const { docId } = request.params;
 
       return jobsQuery.get(request.pre.user, docId, { includeContent: true }).then(
@@ -98,7 +102,8 @@ export function registerJobInfoRoutes(
     path: `${MAIN_ENTRY}/info/{docId}`,
     method: 'GET',
     options: getRouteConfig(),
-    handler: (request: RequestFacade) => {
+    handler: (originalRequest: RequestFacade) => {
+      const request = makeRequestFacade(originalRequest);
       const { docId } = request.params;
 
       return jobsQuery
@@ -130,7 +135,8 @@ export function registerJobInfoRoutes(
     path: `${MAIN_ENTRY}/download/{docId}`,
     method: 'GET',
     options: getRouteConfigDownload(),
-    handler: async (request: RequestFacade, h: ReportingResponseToolkit) => {
+    handler: async (originalRequest: RequestFacade, h: ReportingResponseToolkit) => {
+      const request = makeRequestFacade(originalRequest);
       const { docId } = request.params;
 
       let response = await jobResponseHandler(

x-pack/legacy/plugins/reporting/server/routes/lib/make_request_facade.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License;
+ * you may not use this file except in compliance with the Elastic License.
+ */
+
+import { RequestFacade } from '../../../types';
+
+export function makeRequestFacade(request: RequestFacade): RequestFacade {
+  // This condition is for unit tests
+  const getSavedObjectsClient = request.getSavedObjectsClient
+    ? request.getSavedObjectsClient.bind(request)
+    : request.getSavedObjectsClient;
+  return {
+    getSavedObjectsClient,
+    headers: request.headers,
+    auth: request.auth, // for getUser
+    params: request.params,
+    payload: request.payload,
+    query: request.query,
+    pre: request.pre,
+    getBasePath: request.getBasePath,
+    route: request.route,
+  };
+}

x-pack/legacy/plugins/reporting/types.d.ts

@@ -64,34 +64,30 @@ interface GenerateQuery {
 interface GenerateExportTypePayload {
   jobParams: string;
 }
-interface DownloadParams {
-  docId: string;
-}
 
 /*
  * Legacy System
  */
 
 export type ReportingPluginSpecOptions = Legacy.PluginSpecOptions;
 
-export type ServerFacade = Legacy.Server & {
+type LegacyPlugins = Legacy.Server['plugins'];
+
+export interface ServerFacade {
+  config: Legacy.Server['config'];
+  info: Legacy.Server['info'];
+  log: Legacy.Server['log'];
+  newPlatform: Legacy.Server['newPlatform'];
   plugins: {
-    xpack_main?: XPackMainPlugin & {
+    elasticsearch: LegacyPlugins['elasticsearch'];
+    security: LegacyPlugins['security'];
+    xpack_main: XPackMainPlugin & {
       status?: any;
     };
   };
-};
-
-interface ReportingRequest {
-  query: ListQuery & GenerateQuery;
-  params: DownloadParams;
-  payload: GenerateExportTypePayload;
-  pre: {
-    management: {
-      jobTypes: any;
-    };
-    user: any;
-  };
+  route: Legacy.Server['route'];
+  savedObjects: Legacy.Server['savedObjects'];
+  uiSettingsServiceFactory: Legacy.Server['uiSettingsServiceFactory'];
 }
 
 export type EnqueueJobFn = <JobParamsType>(
@@ -103,7 +99,22 @@ export type EnqueueJobFn = <JobParamsType>(
   request: RequestFacade
 ) => Promise<Job>;
 
-export type RequestFacade = ReportingRequest & Legacy.Request;
+export interface RequestFacade {
+  getBasePath: Legacy.Request['getBasePath'];
+  getSavedObjectsClient: Legacy.Request['getSavedObjectsClient'];
+  auth: Legacy.Request['auth'];
+  headers: Legacy.Request['headers'];
+  params: Legacy.Request['params'];
+  payload: JobParamPostPayload | GenerateExportTypePayload;
+  query: ListQuery & GenerateQuery;
+  route: Legacy.Request['route'];
+  pre: {
+    management: {
+      jobTypes: any;
+    };
+    user: any;
+  };
+}
 
 export type ResponseFacade = ResponseObject & {
   isBoom: boolean;