[9.1] [ResponseOps] Cases analytics integration tests (#225231)

x-pack/platform/plugins/shared/cases/common/constants/index.ts

@@ -176,6 +176,8 @@ export const DEFAULT_FEATURES: CasesFeaturesAllRequired = Object.freeze({
  */
 
 export const CASES_TELEMETRY_TASK_NAME = 'cases-telemetry-task';
+export const ANALYTICS_BACKFILL_TASK_TYPE = 'cai:cases_analytics_index_backfill';
+export const ANALYTICS_SYNCHRONIZATION_TASK_TYPE = 'cai:cases_analytics_index_synchronization';
 
 /**
  * Telemetry

x-pack/platform/plugins/shared/cases/server/cases_analytics/analytics_index.test.ts

@@ -118,6 +118,7 @@ describe('AnalyticsIndex', () => {
       },
       settings: {
         index: {
+          hidden: true,
           auto_expand_replicas: '0-1',
           mode: 'lookup',
           number_of_shards: 1,

x-pack/platform/plugins/shared/cases/server/cases_analytics/analytics_index.ts

@@ -93,6 +93,7 @@ export class AnalyticsIndex {
     this.sourceIndex = sourceIndex;
     this.sourceQuery = sourceQuery;
     this.indexSettings = {
+      hidden: true,
       // settings are not supported on serverless ES
       ...(isServerless
         ? {}

x-pack/platform/plugins/shared/cases/server/cases_analytics/tasks/backfill_task/constants.ts

@@ -5,5 +5,4 @@
  * 2.0.
  */
 
-export const TASK_TYPE = 'cai:cases_analytics_index_backfill';
 export const BACKFILL_RUN_AT = 60 * 1000; // milliseconds

x-pack/platform/plugins/shared/cases/server/cases_analytics/tasks/backfill_task/index.ts

@@ -13,9 +13,10 @@ import type {
 } from '@kbn/task-manager-plugin/server';
 import type { CoreSetup, ElasticsearchClient } from '@kbn/core/server';
 import type { QueryDslQueryContainer } from '@elastic/elasticsearch/lib/api/types';
+import { ANALYTICS_BACKFILL_TASK_TYPE } from '../../../../common/constants';
 import type { CasesServerStartDependencies } from '../../../types';
 import { CaseAnalyticsIndexBackfillTaskFactory } from './backfill_task_factory';
-import { TASK_TYPE, BACKFILL_RUN_AT } from './constants';
+import { BACKFILL_RUN_AT } from './constants';
 
 export function registerCAIBackfillTask({
   taskManager,
@@ -32,7 +33,7 @@ export function registerCAIBackfillTask({
   };
 
   taskManager.registerTaskDefinitions({
-    [TASK_TYPE]: {
+    [ANALYTICS_BACKFILL_TASK_TYPE]: {
       title: 'Backfill cases analytics indexes.',
       maxAttempts: 3,
       createTaskRunner: (context: RunContext) => {
@@ -60,7 +61,7 @@ export async function scheduleCAIBackfillTask({
   try {
     await taskManager.ensureScheduled({
       id: taskId,
-      taskType: TASK_TYPE,
+      taskType: ANALYTICS_BACKFILL_TASK_TYPE,
       params: { sourceIndex, destIndex, sourceQuery },
       runAt: new Date(Date.now() + BACKFILL_RUN_AT), // todo, value is short for testing but should run after 5 minutes
       state: {},

x-pack/platform/plugins/shared/cases/server/cases_analytics/tasks/synchronization_task/index.ts

@@ -13,10 +13,10 @@ import type {
   TaskManagerStartContract,
 } from '@kbn/task-manager-plugin/server';
 import type { CoreSetup, ElasticsearchClient } from '@kbn/core/server';
+import { ANALYTICS_SYNCHRONIZATION_TASK_TYPE } from '../../../../common/constants';
 import type { CasesServerStartDependencies } from '../../../types';
 import { AnalyticsIndexSynchronizationTaskFactory } from './synchronization_task_factory';
 
-const TASK_TYPE = 'cai:cases_analytics_index_synchronization';
 const SCHEDULE: IntervalSchedule = { interval: '5m' };
 
 export function registerCAISynchronizationTask({
@@ -34,7 +34,7 @@ export function registerCAISynchronizationTask({
   };
 
   taskManager.registerTaskDefinitions({
-    [TASK_TYPE]: {
+    [ANALYTICS_SYNCHRONIZATION_TASK_TYPE]: {
       title: 'Synchronization for the cases analytics index',
       createTaskRunner: (context: RunContext) => {
         return new AnalyticsIndexSynchronizationTaskFactory({ getESClient, logger }).create(
@@ -64,7 +64,7 @@ export async function scheduleCAISynchronizationTask({
   try {
     await taskManager.ensureScheduled({
       id: taskId,
-      taskType: TASK_TYPE,
+      taskType: ANALYTICS_SYNCHRONIZATION_TASK_TYPE,
       params: { sourceIndex, destIndex },
       schedule: SCHEDULE, // every 5 minutes
       state: {},

x-pack/platform/plugins/shared/cases/server/config.test.ts

@@ -12,7 +12,11 @@ describe('config validation', () => {
     it('sets the defaults correctly', () => {
       expect(ConfigSchema.validate({})).toMatchInlineSnapshot(`
         Object {
-          "analytics": Object {},
+          "analytics": Object {
+            "index": Object {
+              "enabled": true,
+            },
+          },
           "files": Object {
             "allowedMimeTypes": Array [
               "image/aces",

x-pack/platform/plugins/shared/cases/server/config.ts

@@ -48,11 +48,9 @@ export const ConfigSchema = schema.object({
     }),
   }),
   analytics: schema.object({
-    index: schema.maybe(
-      schema.object({
-        enabled: schema.boolean({ defaultValue: true }),
-      })
-    ),
+    index: schema.object({
+      enabled: schema.boolean({ defaultValue: true }),
+    }),
   }),
 });
 

x-pack/platform/plugins/shared/cases/server/plugin.test.ts

@@ -29,7 +29,7 @@ function getConfig(overrides: Partial<ConfigType> = {}): ConfigType {
     files: { maxSize: 1, allowedMimeTypes: ALLOWED_MIME_TYPES },
     stack: { enabled: true },
     incrementalId: { enabled: true, taskIntervalMinutes: 10, taskStartDelayMinutes: 10 },
-    analytics: {},
+    analytics: { index: { enabled: true } },
     ...overrides,
   };
 }

x-pack/platform/plugins/shared/cases/server/plugin.ts

@@ -225,6 +225,7 @@ export class CasePlugin
       if (this.caseConfig.incrementalId.enabled) {
         void this.incrementalIdTaskManager?.setupIncrementIdTask(plugins.taskManager, core);
       }
+
       if (this.caseConfig.analytics.index?.enabled) {
         scheduleCasesAnalyticsSyncTasks({ taskManager: plugins.taskManager, logger: this.logger });
         createCasesAnalyticsIndexes({

x-pack/platform/test/api_integration/apis/search/search.ts

@@ -63,6 +63,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -89,6 +90,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -116,6 +118,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -159,6 +162,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -196,6 +200,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -258,6 +263,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set(ELASTIC_HTTP_VERSION_HEADER, '1')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -277,6 +283,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -298,6 +305,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -478,6 +486,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},
@@ -519,6 +528,7 @@ export default function ({ getService }: FtrProviderContext) {
           .set('kbn-xsrf', 'foo')
           .send({
             params: {
+              index: 'search-api-test',
               body: {
                 query: {
                   match_all: {},

x-pack/platform/test/cases_api_integration/common/lib/api/analytics.ts

@@ -0,0 +1,121 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type SuperTest from 'supertest';
+
+import {
+  CAI_ACTIVITY_BACKFILL_TASK_ID,
+  CAI_ACTIVITY_SYNCHRONIZATION_TASK_ID,
+  CAI_ACTIVITY_SOURCE_INDEX,
+  CAI_ACTIVITY_INDEX_NAME,
+  CAI_ACTIVITY_SOURCE_QUERY,
+} from '@kbn/cases-plugin/server/cases_analytics/activity_index/constants';
+import {
+  CAI_ATTACHMENTS_BACKFILL_TASK_ID,
+  CAI_ATTACHMENTS_SYNCHRONIZATION_TASK_ID,
+  CAI_ATTACHMENTS_SOURCE_INDEX,
+  CAI_ATTACHMENTS_INDEX_NAME,
+  CAI_ATTACHMENTS_SOURCE_QUERY,
+} from '@kbn/cases-plugin/server/cases_analytics/attachments_index/constants';
+import {
+  CAI_CASES_BACKFILL_TASK_ID,
+  CAI_CASES_SYNCHRONIZATION_TASK_ID,
+  CAI_CASES_SOURCE_INDEX,
+  CAI_CASES_INDEX_NAME,
+  CAI_CASES_SOURCE_QUERY,
+} from '@kbn/cases-plugin/server/cases_analytics/cases_index/constants';
+import {
+  CAI_COMMENTS_BACKFILL_TASK_ID,
+  CAI_COMMENTS_SYNCHRONIZATION_TASK_ID,
+  CAI_COMMENTS_SOURCE_INDEX,
+  CAI_COMMENTS_INDEX_NAME,
+  CAI_COMMENTS_SOURCE_QUERY,
+} from '@kbn/cases-plugin/server/cases_analytics/comments_index/constants';
+
+export const runCasesBackfillTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/backfill/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({
+      taskId: CAI_CASES_BACKFILL_TASK_ID,
+      sourceIndex: CAI_CASES_SOURCE_INDEX,
+      destIndex: CAI_CASES_INDEX_NAME,
+      sourceQuery: JSON.stringify(CAI_CASES_SOURCE_QUERY),
+    })
+    .expect(200);
+};
+
+export const runCasesSynchronizationTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/synchronization/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({ taskId: CAI_CASES_SYNCHRONIZATION_TASK_ID })
+    .expect(200);
+};
+
+export const runAttachmentsBackfillTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/backfill/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({
+      taskId: CAI_ATTACHMENTS_BACKFILL_TASK_ID,
+      sourceIndex: CAI_ATTACHMENTS_SOURCE_INDEX,
+      destIndex: CAI_ATTACHMENTS_INDEX_NAME,
+      sourceQuery: JSON.stringify(CAI_ATTACHMENTS_SOURCE_QUERY),
+    })
+    .expect(200);
+};
+
+export const runAttachmentsSynchronizationTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/synchronization/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({ taskId: CAI_ATTACHMENTS_SYNCHRONIZATION_TASK_ID })
+    .expect(200);
+};
+
+export const runCommentsBackfillTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/backfill/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({
+      taskId: CAI_COMMENTS_BACKFILL_TASK_ID,
+      sourceIndex: CAI_COMMENTS_SOURCE_INDEX,
+      destIndex: CAI_COMMENTS_INDEX_NAME,
+      sourceQuery: JSON.stringify(CAI_COMMENTS_SOURCE_QUERY),
+    })
+    .expect(200);
+};
+
+export const runCommentsSynchronizationTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/synchronization/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({ taskId: CAI_COMMENTS_SYNCHRONIZATION_TASK_ID })
+    .expect(200);
+};
+
+export const runActivityBackfillTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/backfill/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({
+      taskId: CAI_ACTIVITY_BACKFILL_TASK_ID,
+      sourceIndex: CAI_ACTIVITY_SOURCE_INDEX,
+      destIndex: CAI_ACTIVITY_INDEX_NAME,
+      sourceQuery: JSON.stringify(CAI_ACTIVITY_SOURCE_QUERY),
+    })
+    .expect(200);
+};
+
+export const runActivitySynchronizationTask = async (supertest: SuperTest.Agent) => {
+  await supertest
+    .post('/api/analytics_index/synchronization/run_soon')
+    .set('kbn-xsrf', 'xxx')
+    .send({ taskId: CAI_ACTIVITY_SYNCHRONIZATION_TASK_ID })
+    .expect(200);
+};

x-pack/platform/test/cases_api_integration/common/lib/api/index.ts

@@ -904,3 +904,52 @@ export const findInternalCaseUserActions = async ({
 
   return userActions;
 };
+
+export const deleteAllCaseAnalyticsItems = async (es: Client) => {
+  await Promise.all([
+    deleteCasesAnalytics(es),
+    deleteAttachmentsAnalytics(es),
+    deleteCommentsAnalytics(es),
+    deleteActivityAnalytics(es),
+  ]);
+};
+
+export const deleteCasesAnalytics = async (es: Client): Promise<void> => {
+  await es.deleteByQuery({
+    index: '.internal.cases',
+    query: { match_all: {} },
+    wait_for_completion: true,
+    refresh: true,
+    conflicts: 'proceed',
+  });
+};
+
+export const deleteAttachmentsAnalytics = async (es: Client): Promise<void> => {
+  await es.deleteByQuery({
+    index: '.internal.cases-attachments',
+    query: { match_all: {} },
+    wait_for_completion: true,
+    refresh: true,
+    conflicts: 'proceed',
+  });
+};
+
+export const deleteCommentsAnalytics = async (es: Client): Promise<void> => {
+  await es.deleteByQuery({
+    index: '.internal.cases-comments',
+    query: { match_all: {} },
+    wait_for_completion: true,
+    refresh: true,
+    conflicts: 'proceed',
+  });
+};
+
+export const deleteActivityAnalytics = async (es: Client): Promise<void> => {
+  await es.deleteByQuery({
+    index: '.internal.cases-activity',
+    query: { match_all: {} },
+    wait_for_completion: true,
+    refresh: true,
+    conflicts: 'proceed',
+  });
+};