[Reporting] Replace Job Completion Notifier as NP Plugin

Author: tsullivan

x-pack/.i18nrc.json

@@ -29,6 +29,7 @@
     "xpack.monitoring": "legacy/plugins/monitoring",
     "xpack.remoteClusters": "legacy/plugins/remote_clusters",
     "xpack.reporting": "legacy/plugins/reporting",
+    "xpack.reportingNotifier": "plugins/reporting_notifier",
     "xpack.rollupJobs": "legacy/plugins/rollup",
     "xpack.searchProfiler": "legacy/plugins/searchprofiler",
     "xpack.siem": "legacy/plugins/siem",

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

@@ -45,7 +45,6 @@ export const reporting = (kibana) => {
       embeddableActions: [
         'plugins/reporting/panel_actions/get_csv_panel_action',
       ],
-      hacks: ['plugins/reporting/hacks/job_completion_notifier'],
       home: ['plugins/reporting/register_feature'],
       managementSections: ['plugins/reporting/views/management'],
       injectDefaultVars(server, options) {

x-pack/legacy/plugins/reporting/public/hacks/__tests__/job_completion_notifier.js

@@ -5,6 +5,7 @@
  */
 
 import boom from 'boom';
+import { RequestQuery } from 'hapi';
 import { Request, ResponseToolkit } from 'hapi';
 import { API_BASE_URL } from '../../common/constants';
 import { JobDoc, KbnServer } from '../../types';
@@ -19,6 +20,12 @@ import {
 
 const MAIN_ENTRY = `${API_BASE_URL}/jobs`;
 
+type ListQuery = RequestQuery & {
+  page: string;
+  size: string;
+  ids?: string; // optional field forbids us from extending RequestQuery
+};
+
 export function registerJobs(server: KbnServer) {
   const jobsQuery = jobsQueryFactory(server);
   const getRouteConfig = getRouteConfigFactoryManagementPre(server);
@@ -30,12 +37,10 @@ export function registerJobs(server: KbnServer) {
     method: 'GET',
     config: getRouteConfig(),
     handler: (request: Request) => {
-      // @ts-ignore
-      const page = parseInt(request.query.page, 10) || 0;
-      // @ts-ignore
-      const size = Math.min(100, parseInt(request.query.size, 10) || 10);
-      // @ts-ignore
-      const jobIds = request.query.ids ? request.query.ids.split(',') : null;
+      const { page: queryPage, size: querySize, ids: queryIds } = request.query as ListQuery;
+      const page = parseInt(queryPage, 10) || 0;
+      const size = Math.min(100, parseInt(querySize, 10) || 10);
+      const jobIds = queryIds ? queryIds.split(',') : null;
 
       const results = jobsQuery.list(
         request.pre.management.jobTypes,

x-pack/legacy/plugins/reporting/public/hacks/job_completion_notifier.js

@@ -0,0 +1,10 @@
+/*
+ * 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.
+ */
+
+export const reportingPollConfig = {
+  jobCompletionNotifier: { interval: 10000, intervalErrorMultiplier: 5 },
+  jobsRefresh: { interval: 5000, intervalErrorMultiplier: 5 },
+};

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

@@ -0,0 +1,21 @@
+/*
+ * 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.
+ */
+
+export const JOB_COMPLETION_NOTIFICATIONS_SESSION_KEY =
+  'xpack.reporting.jobCompletionNotifications';
+
+export const JOB_COMPLETION_NOTIFICATIONS_POLLER_CONFIG = {
+  jobCompletionNotifier: {
+    interval: 10000,
+    intervalErrorMultiplier: 5
+  } // prettier-ignore
+};
+
+export const API_BASE_URL = '/api/reporting/jobs';
+export const REPORTING_MANAGEMENT_HOME = '/app/kibana#/management/kibana/reporting';
+
+export const JOB_STATUS_FAILED = 'failed';
+export const JOB_STATUS_COMPLETED = 'completed';

x-pack/plugins/reporting_notifier/config.ts

@@ -0,0 +1,59 @@
+/*
+ * 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 {
+  CoreSetup,
+  CoreStart,
+  HttpServiceBase,
+  Plugin,
+  PluginInitializerContext,
+  NotificationsStart,
+} from '../../../src/core/public';
+
+export type JobId = string;
+export type JobStatus = 'completed' | 'processing' | 'failed';
+
+export type HttpFn = () => HttpServiceBase;
+export type NotificationsFn = () => NotificationsStart;
+
+export interface SourceJob {
+  _id: JobId;
+  _source: {
+    status: JobStatus;
+    output: {
+      max_size_reached: boolean;
+      csv_contains_formulas: boolean;
+    };
+    payload: {
+      type: string;
+      title: string;
+    };
+  };
+}
+
+export interface JobContent {
+  content: string;
+}
+
+export interface JobSummary {
+  id: JobId;
+  status: JobStatus;
+  title: string;
+  type: string;
+  maxSizeReached: boolean;
+  csvContainsFormulas: boolean;
+}
+
+export interface JobStatusBuckets {
+  completed: JobSummary[];
+  failed: JobSummary[];
+}
+
+type DownloadLink = string;
+export type DownloadReportFn = (jobId: JobId) => DownloadLink;
+
+type ManagementLink = string;
+export type ManagementLinkFn = () => ManagementLink;

x-pack/plugins/reporting_notifier/constants.ts

@@ -0,0 +1,7 @@
+{
+  "id": "reportingNotifier",
+  "version": "kibana",
+  "requiredPlugins": [],
+  "server": false,
+  "ui": true
+}