[ML] New Platform server shim: update recognize modules routes to use…

… new platform router (#57206) * [ML] modules with NP router * [ML] use extendedRouteInitializationDeps * [ML] add apidoc annotations * [ML] address PR comments * [ML] convert data_recognizer test to jest * [ML] optional indexPatternName
elastic · Feb 11, 2020 · b133357 · b133357
1 parent 733f602
commit b133357
Show file tree

Hide file tree

Showing 13 changed files with 570 additions and 309 deletions.
diff --git a/x-pack/legacy/plugins/ml/common/types/jobs.ts b/x-pack/legacy/plugins/ml/common/types/jobs.ts
@@ -20,7 +20,10 @@ export interface MlJob {
  };
  create_time: number;
  custom_settings: object;
- data_counts: object;
+ data_counts: {
+ earliest_record_timestamp: number;
+ latest_record_timestamp: number;
+ };
  data_description: {
  time_field: string;
  time_format: string;

diff --git a/x-pack/legacy/plugins/ml/common/types/modules.ts b/x-pack/legacy/plugins/ml/common/types/modules.ts
@@ -11,16 +11,25 @@ export interface ModuleJob {
  config: Omit<Job, 'job_id'>;
 }
 
+export interface ModuleDataFeed {
+ id: string;
+ config: Omit<Datafeed, 'datafeed_id'>;
+}
+
 export interface KibanaObjectConfig extends SavedObjectAttributes {
  description: string;
  title: string;
  version: number;
+ kibanaSavedObjectMeta?: {
+ searchSourceJSON: string;
+ };
 }
 
 export interface KibanaObject {
  id: string;
  title: string;
  config: KibanaObjectConfig;
+ exists?: boolean;
 }
 
 export interface KibanaObjects {
@@ -39,14 +48,18 @@ export interface Module {
  defaultIndexPattern: string;
  query: any;
  jobs: ModuleJob[];
- datafeeds: Datafeed[];
+ datafeeds: ModuleDataFeed[];
  kibana: KibanaObjects;
 }
 
-export interface KibanaObjectResponse {
- exists?: boolean;
- success?: boolean;
+export interface ResultItem {
  id: string;
+ success?: boolean;
+}
+
+export interface KibanaObjectResponse extends ResultItem {
+ exists?: boolean;
+ error?: any;
 }
 
 export interface SetupError {
@@ -58,27 +71,27 @@ export interface SetupError {
  statusCode: number;
 }
 
-export interface DatafeedResponse {
- id: string;
- success: boolean;
+export interface DatafeedResponse extends ResultItem {
  started: boolean;
  error?: SetupError;
 }
 
-export interface JobResponse {
- id: string;
- success: boolean;
+export interface JobResponse extends ResultItem {
  error?: SetupError;
 }
 
 export interface DataRecognizerConfigResponse {
  datafeeds: DatafeedResponse[];
  jobs: JobResponse[];
  kibana: {
- search: KibanaObjectResponse;
- visualization: KibanaObjectResponse;
- dashboard: KibanaObjectResponse;
+ search: KibanaObjectResponse[];
+ visualization: KibanaObjectResponse[];
+ dashboard: KibanaObjectResponse[];
  };
 }
 
+export type GeneralOverride = any;
+
 export type JobOverride = Partial<Job>;
+
+export type DatafeedOverride = Partial<Datafeed>;
diff --git a/x-pack/legacy/plugins/ml/common/util/job_utils.d.ts b/x-pack/legacy/plugins/ml/common/util/job_utils.d.ts
@@ -45,3 +45,10 @@ export function mlFunctionToESAggregation(functionName: string): string | null;
 export function isModelPlotEnabled(job: Job, detectorIndex: number, entityFields: any[]): boolean;
 
 export function getSafeAggregationName(fieldName: string, index: number): string;
+
+export function getLatestDataOrBucketTimestamp(
+ latestDataTimestamp: number,
+ latestBucketTimestamp: number
+): number;
+
+export function prefixDatafeedId(datafeedId: string, prefix: string): string;
diff --git a/.../legacy/plugins/ml/public/application/jobs/new_job/common/job_creator/configs/datafeed.ts b/.../legacy/plugins/ml/public/application/jobs/new_job/common/job_creator/configs/datafeed.ts
@@ -15,6 +15,10 @@ export interface Datafeed {
  chunking_config?: ChunkingConfig;
  frequency?: string;
  indices: IndexPatternTitle[];
+ /**
+ * The datafeed can contain indexes and indices
+ */
+ indexes?: IndexPatternTitle[];
  job_id?: JobId;
  query: object;
  query_delay?: string;

diff --git a/...a_recognizer/__tests__/data_recognizer.js → ...s/data_recognizer/data_recognizer.test.ts b/...a_recognizer/__tests__/data_recognizer.js → ...s/data_recognizer/data_recognizer.test.ts
@@ -4,11 +4,26 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import expect from '@kbn/expect';
+import { RequestHandlerContext } from 'kibana/server';
+import { Module } from '../../../common/types/modules';
 import { DataRecognizer } from '../data_recognizer';
 
 describe('ML - data recognizer', () => {
- const dr = new DataRecognizer({});
+ const dr = new DataRecognizer(({
+ ml: {
+ mlClient: {
+ callAsCurrentUser: jest.fn(),
+ },
+ },
+ core: {
+ savedObjects: {
+ client: {
+ find: jest.fn(),
+ bulkCreate: jest.fn(),
+ },
+ },
+ },
+ } as unknown) as RequestHandlerContext);
 
  const moduleIds = [
  'apache_ecs',
@@ -34,20 +49,20 @@ describe('ML - data recognizer', () => {
  it('listModules - check all module IDs', async () => {
  const modules = await dr.listModules();
  const ids = modules.map(m => m.id);
- expect(ids.join()).to.equal(moduleIds.join());
+ expect(ids.join()).toEqual(moduleIds.join());
  });
 
  it('getModule - load a single module', async () => {
  const module = await dr.getModule(moduleIds[0]);
- expect(module.id).to.equal(moduleIds[0]);
+ expect(module.id).toEqual(moduleIds[0]);
  });
 
  describe('jobOverrides', () => {
  it('should apply job overrides correctly', () => {
  // arrange
  const prefix = 'pre-';
  const testJobId = 'test-job';
- const moduleConfig = {
+ const moduleConfig = ({
  jobs: [
  {
  id: `${prefix}${testJobId}`,
@@ -64,7 +79,7 @@ describe('ML - data recognizer', () => {
  },
  },
  ],
- };
+ } as unknown) as Module;
  const jobOverrides = [
  {
  analysis_limits: {
@@ -80,7 +95,7 @@ describe('ML - data recognizer', () => {
  // act
  dr.applyJobConfigOverrides(moduleConfig, jobOverrides, prefix);
  // assert
- expect(moduleConfig.jobs).to.eql([
+ expect(moduleConfig.jobs).toEqual([
  {
  config: {
  analysis_config: {