[8.x] [Reporting] Delete the task from Task Manager when deleting a r…

…eport (#192417) (#194758) # Backport This will backport the following commits from `main` to `8.x`: - [[Reporting] Delete the task from Task Manager when deleting a report (#192417)](#192417)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Tim Sullivan <[email protected]>
elastic · Oct 2, 2024 · 69f3b54 · 69f3b54
1 parent 246f25d
commit 69f3b54
Show file tree

Hide file tree

Showing 5 changed files with 69 additions and 17 deletions.
diff --git a/x-pack/plugins/reporting/server/routes/common/jobs/get_job_routes.ts b/x-pack/plugins/reporting/server/routes/common/jobs/get_job_routes.ts
@@ -113,6 +113,8 @@ export const commonJobsRouteHandlerFactory = (
         const reportingSetup = reporting.getPluginSetupDeps();
         const logger = reportingSetup.logger.get('delete-report');
 
+        logger.debug(`Deleting report ${docId}`);
+
         // An "error" event is emitted if an error is
         // passed to the `stream.end` callback from
         // the _final method of the ContentStream.
@@ -121,6 +123,48 @@ export const commonJobsRouteHandlerFactory = (
           logger.error(err);
         });
 
+        // 1. Look for a task in task manager associated with the report job
+        try {
+          let taskId: string | undefined;
+          const { taskManager } = await reporting.getPluginStartDeps();
+          const result = await taskManager.fetch({
+            query: {
+              term: {
+                'task.taskType': { value: 'report:execute' },
+              },
+            },
+            size: 1000, // NOTE: this is an arbitrary size that is likely to include all running and pending reporting tasks in most deployments
+          });
+
+          if (result.docs.length > 0) {
+            // The task params are stored as a string of JSON. In order to find the task that corresponds to
+            // the report to delete, we need to check each task's params, look for the report id, and see if it
+            // matches our docId to delete.
+            for (const task of result.docs) {
+              const { params } = task;
+              if (params.id === docId) {
+                // found the matching task
+                taskId = task.id;
+                logger.debug(
+                  `Found a Task Manager task associated with the report being deleted: ${taskId}. Task status: ${task.status}.`
+                );
+                break;
+              }
+            }
+            if (taskId) {
+              // remove the task that was found
+              await taskManager.remove(taskId);
+              logger.debug(`Deleted Task Manager task ${taskId}.`);
+            }
+          }
+        } catch (error) {
+          logger.error(
+            'Encountered an error in finding a task associated with the report being deleted'
+          );
+          logger.error(error);
+        }
+
+        // 2. Remove the report document
         try {
           // Overwriting existing content with an
           // empty buffer to remove all the chunks.

diff --git a/x-pack/test_serverless/api_integration/test_suites/common/reporting/datastream.ts b/x-pack/test_serverless/api_integration/test_suites/common/reporting/datastream.ts
@@ -27,15 +27,15 @@ export default function ({ getService }: FtrProviderContext) {
   };
 
   describe('Data Stream', function () {
+    const generatedReports = new Set<string>();
     before(async () => {
       roleAuthc = await svlUserManager.createM2mApiKeyWithRoleScope('admin');
       internalReqHeader = svlCommonApi.getInternalRequestHeader();
 
       await esArchiver.load(archives.ecommerce.data);
       await kibanaServer.importExport.load(archives.ecommerce.savedObjects);
 
-      // for this test, we don't need to wait for the job to finish or verify the result
-      await reportingAPI.createReportJobInternal(
+      const { job } = await reportingAPI.createReportJobInternal(
         'csv_searchsource',
         {
           browserTimezone: 'UTC',
@@ -51,10 +51,15 @@ export default function ({ getService }: FtrProviderContext) {
         roleAuthc,
         internalReqHeader
       );
+
+      generatedReports.add(job.id);
     });
 
     after(async () => {
-      await reportingAPI.deleteAllReports(roleAuthc, internalReqHeader);
+      for (const reportId of generatedReports) {
+        await reportingAPI.deleteReport(reportId, roleAuthc, internalReqHeader);
+      }
+
       await esArchiver.unload(archives.ecommerce.data);
       await kibanaServer.importExport.unload(archives.ecommerce.savedObjects);
       await svlUserManager.invalidateM2mApiKeyWithRoleScope(roleAuthc);

diff --git a/x-pack/test_serverless/api_integration/test_suites/common/reporting/generate_csv_discover.ts b/x-pack/test_serverless/api_integration/test_suites/common/reporting/generate_csv_discover.ts
@@ -101,7 +101,6 @@ export default function ({ getService }: FtrProviderContext) {
       });
 
       after(async () => {
-        await reportingAPI.deleteAllReports(roleAuthc, internalReqHeader);
         await esArchiver.unload(archives.ecommerce.data);
         await kibanaServer.importExport.unload(archives.ecommerce.savedObjects);
       });

diff --git a/x-pack/test_serverless/shared/services/svl_reporting.ts b/x-pack/test_serverless/shared/services/svl_reporting.ts
@@ -8,7 +8,6 @@
 import expect from '@kbn/expect';
 import { INTERNAL_ROUTES } from '@kbn/reporting-common';
 import type { ReportingJobResponse } from '@kbn/reporting-plugin/server/types';
-import { REPORTING_DATA_STREAM_WILDCARD_WITH_LEGACY } from '@kbn/reporting-server';
 import rison from '@kbn/rison';
 import { FtrProviderContext } from '../../functional/ftr_provider_context';
 import { RoleCredentials } from '.';
@@ -111,17 +110,23 @@ export function SvlReportingServiceProvider({ getService }: FtrProviderContext)
         .set(roleAuthc.apiKeyHeader);
       return response.text as unknown;
     },
-    async deleteAllReports(roleAuthc: RoleCredentials, internalReqHeader: InternalRequestHeader) {
-      log.debug('ReportingAPI.deleteAllReports');
-
-      // ignores 409 errs and keeps retrying
-      await retry.tryForTime(5000, async () => {
-        await supertestWithoutAuth
-          .post(`/${REPORTING_DATA_STREAM_WILDCARD_WITH_LEGACY}/_delete_by_query`)
-          .set(internalReqHeader)
-          .set(roleAuthc.apiKeyHeader)
-          .send({ query: { match_all: {} } });
-      });
+
+    /*
+     * Ensures reports are cleaned up through the delete report API
+     */
+    async deleteReport(
+      reportId: string,
+      roleAuthc: RoleCredentials,
+      internalReqHeader: InternalRequestHeader
+    ) {
+      log.debug(`ReportingAPI.deleteReport ${INTERNAL_ROUTES.JOBS.DELETE_PREFIX}/${reportId}`);
+      const response = await supertestWithoutAuth
+        .delete(INTERNAL_ROUTES.JOBS.DELETE_PREFIX + `/${reportId}`)
+        .set(internalReqHeader)
+        .set(roleAuthc.apiKeyHeader)
+        .set('kbn-xsrf', 'xxx')
+        .expect(200);
+      return response.text as unknown;
     },
   };
 }
diff --git a/x-pack/test_serverless/tsconfig.json b/x-pack/test_serverless/tsconfig.json
@@ -90,7 +90,6 @@
     "@kbn/dataset-quality-plugin",
     "@kbn/alerting-comparators",
     "@kbn/search-types",
-    "@kbn/reporting-server",
     "@kbn/config-schema",
     "@kbn/features-plugin",
     "@kbn/observability-ai-assistant-plugin",