[8.x] [Entity Analytics][Entity Store] Init: Put engine in error stat…

…e if data view does not exist (#201140) (#201414) # Backport This will backport the following commits from `main` to `8.x`: - [[Entity Analytics][Entity Store] Init: Put engine in error state if data view does not exist (#201140)](#201140)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Mark Hopkin <[email protected]>
elastic · Nov 22, 2024 · 722d718 · 722d718
1 parent 6cb23a8
commit 722d718
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 14 deletions.
diff --git a/...ns/security_solution/server/lib/entity_analytics/entity_store/entity_store_data_client.ts b/...ns/security_solution/server/lib/entity_analytics/entity_store/entity_store_data_client.ts
@@ -241,19 +241,19 @@ export class EntityStoreDataClient {
   ) {
     const setupStartTime = moment().utc().toISOString();
     const { logger, namespace, appClient, dataViewsService } = this.options;
-    const indexPatterns = await buildIndexPatterns(namespace, appClient, dataViewsService);
+    try {
+      const indexPatterns = await buildIndexPatterns(namespace, appClient, dataViewsService);
 
-    const unitedDefinition = getUnitedEntityDefinition({
-      indexPatterns,
-      entityType,
-      namespace,
-      fieldHistoryLength,
-      syncDelay: `${config.syncDelay.asSeconds()}s`,
-      frequency: `${config.frequency.asSeconds()}s`,
-    });
-    const { entityManagerDefinition } = unitedDefinition;
+      const unitedDefinition = getUnitedEntityDefinition({
+        indexPatterns,
+        entityType,
+        namespace,
+        fieldHistoryLength,
+        syncDelay: `${config.syncDelay.asSeconds()}s`,
+        frequency: `${config.frequency.asSeconds()}s`,
+      });
+      const { entityManagerDefinition } = unitedDefinition;
 
-    try {
       // clean up any existing entity store
       await this.delete(entityType, taskManager, { deleteData: false, deleteEngine: false });
 

diff --git a/...ion/test_suites/entity_analytics/entity_store/trial_license_complete_tier/entity_store.ts b/...ion/test_suites/entity_analytics/entity_store/trial_license_complete_tier/entity_store.ts
@@ -43,6 +43,19 @@ export default ({ getService }: FtrProviderContext) => {
       });
     });
 
+    describe('init error handling', () => {
+      afterEach(async () => {
+        await dataView.create('security-solution');
+        await utils.cleanEngines();
+      });
+
+      it('should return "error" when the security data view does not exist', async () => {
+        await dataView.delete('security-solution');
+        await utils.initEntityEngineForEntityType('host');
+        await utils.waitForEngineStatus('host', 'error');
+      });
+    });
+
     describe('enablement', () => {
       afterEach(async () => {
         await utils.cleanEngines();

diff --git a/...ck/test/security_solution_api_integration/test_suites/entity_analytics/utils/data_view.ts b/...ck/test/security_solution_api_integration/test_suites/entity_analytics/utils/data_view.ts
@@ -10,7 +10,16 @@ export const dataViewRouteHelpersFactory = (
   supertest: SuperTest.Agent,
   namespace: string = 'default'
 ) => ({
-  create: (name: string) => {
+  create: async (name: string) => {
+    const { body: existingDataView, statusCode } = await supertest.get(
+      `/s/${namespace}/api/data_views/data_view/${name}-${namespace}`
+    );
+
+    if (statusCode === 200) {
+      // data view exists
+      return existingDataView;
+    }
+
     return supertest
       .post(`/s/${namespace}/api/data_views/data_view`)
       .set('kbn-xsrf', 'foo')

diff --git a/...test/security_solution_api_integration/test_suites/entity_analytics/utils/entity_store.ts b/...test/security_solution_api_integration/test_suites/entity_analytics/utils/entity_store.ts
@@ -51,7 +51,7 @@ export const EntityStoreUtils = (
     }
   };
 
-  const _initEntityEngineForEntityType = async (entityType: EntityType) => {
+  const initEntityEngineForEntityType = async (entityType: EntityType) => {
     log.info(
       `Initializing engine for entity type ${entityType} in namespace ${namespace || 'default'}`
     );
@@ -72,7 +72,7 @@ export const EntityStoreUtils = (
   };
 
   const initEntityEngineForEntityTypesAndWait = async (entityTypes: EntityType[]) => {
-    await Promise.all(entityTypes.map((entityType) => _initEntityEngineForEntityType(entityType)));
+    await Promise.all(entityTypes.map((entityType) => initEntityEngineForEntityType(entityType)));
 
     await retry.waitForWithTimeout(
       `Engines to start for entity types: ${entityTypes.join(', ')}`,
@@ -90,6 +90,20 @@ export const EntityStoreUtils = (
     );
   };
 
+  const waitForEngineStatus = async (entityType: EntityType, status: string) => {
+    await retry.waitForWithTimeout(
+      `Engine for entity type ${entityType} to be in status ${status}`,
+      60_000,
+      async () => {
+        const { body } = await api
+          .getEntityEngine({ params: { entityType } }, namespace)
+          .expect(200);
+        log.debug(`Engine status for ${entityType}: ${body.status}`);
+        return body.status === status;
+      }
+    );
+  };
+
   const enableEntityStore = async () => {
     const res = await api.initEntityStore({ body: {} }, namespace);
     if (res.status !== 200) {
@@ -155,5 +169,7 @@ export const EntityStoreUtils = (
     expectEngineAssetsExist,
     expectEngineAssetsDoNotExist,
     enableEntityStore,
+    waitForEngineStatus,
+    initEntityEngineForEntityType,
   };
 };