[Reporting] Add warning logs about CSV export type being deprecated (e…

…lastic#104025) * add deprecation logging to csv export type * fix payload.isDeprecated Co-authored-by: Kibana Machine <[email protected]>
tsullivan · Jul 6, 2021 · 5d965a7 · 5d965a7
1 parent 7e9c20e
commit 5d965a7
Show file tree

Hide file tree

Showing 8 changed files with 476 additions and 122 deletions.
diff --git a/x-pack/plugins/reporting/common/types.ts b/x-pack/plugins/reporting/common/types.ts
@@ -65,6 +65,7 @@ export interface ReportSource {
     objectType: string;
     title: string;
     layout?: LayoutParams;
+    isDeprecated?: boolean;
   };
   meta: { objectType: string; layout?: string };
   browser_type: string;
@@ -130,6 +131,7 @@ export interface ReportApiJSON {
     layout?: LayoutParams;
     title: string;
     browserTimezone?: string;
+    isDeprecated?: boolean;
   };
   meta: {
     layout?: string;

diff --git a/x-pack/plugins/reporting/server/export_types/csv/create_job.ts b/x-pack/plugins/reporting/server/export_types/csv/create_job.ts
@@ -20,6 +20,9 @@ export const createJobFnFactory: CreateJobFnFactory<
   const crypto = cryptoFactory(config.get('encryptionKey'));
 
   return async function createJob(jobParams, context, request) {
+    logger.warn(
+      `The "/generate/csv" endpoint is deprecated and will be removed in Kibana 8.0. Please recreate the POST URL used to automate this CSV export.`
+    );
     const serializedEncryptedHeaders = await crypto.encrypt(request.headers);
 
     const savedObjectsClient = context.core.savedObjects.client;
@@ -29,6 +32,7 @@ export const createJobFnFactory: CreateJobFnFactory<
     )) as unknown) as IndexPatternSavedObjectDeprecatedCSV;
 
     return {
+      isDeprecated: true,
       headers: serializedEncryptedHeaders,
       spaceId: reporting.getSpaceId(request, logger),
       indexPatternSavedObject,

diff --git a/x-pack/plugins/reporting/server/routes/lib/jobs_query.ts b/x-pack/plugins/reporting/server/routes/lib/jobs_query.ts
@@ -5,9 +5,9 @@
  * 2.0.
  */
 
-import { UnwrapPromise } from '@kbn/utility-types';
-import { i18n } from '@kbn/i18n';
 import { ResponseError } from '@elastic/elasticsearch/lib/errors';
+import { i18n } from '@kbn/i18n';
+import { UnwrapPromise } from '@kbn/utility-types';
 import { ElasticsearchClient } from 'src/core/server';
 import { ReportingCore } from '../../';
 import { ReportDocument } from '../../lib/store';
@@ -87,6 +87,7 @@ export function jobsQueryFactory(reportingCore: ReportingCore) {
         elasticsearchClient.search({ body, index: getIndex() })
       );
 
+      // FIXME: return the info in ReportApiJSON format;
       return response?.body.hits?.hits ?? [];
     },
 
@@ -139,6 +140,7 @@ export function jobsQueryFactory(reportingCore: ReportingCore) {
         return;
       }
 
+      // FIXME: return the info in ReportApiJSON format;
       return response.body.hits.hits[0] as ReportDocument;
     },
 

diff --git a/x-pack/plugins/reporting/server/types.ts b/x-pack/plugins/reporting/server/types.ts
@@ -62,6 +62,7 @@ export { BaseParams };
 export interface BasePayload extends BaseParams {
   headers: string;
   spaceId?: string;
+  isDeprecated?: boolean;
 }
 
 // default fn type for CreateJobFnFactory

diff --git a/x-pack/test/reporting_api_integration/reporting_without_security/index.ts b/x-pack/test/reporting_api_integration/reporting_without_security/index.ts
@@ -11,7 +11,8 @@ import { FtrProviderContext } from '../ftr_provider_context';
 export default function ({ loadTestFile }: FtrProviderContext) {
   describe('Reporting API Integration Tests with Security disabled', function () {
     this.tags('ciGroup13');
-    loadTestFile(require.resolve('./job_apis'));
+    loadTestFile(require.resolve('./job_apis_csv'));
+    loadTestFile(require.resolve('./job_apis_csv_deprecated'));
     loadTestFile(require.resolve('./ilm_migration_apis'));
   });
 }
diff --git a/x-pack/test/reporting_api_integration/reporting_without_security/job_apis.ts b/x-pack/test/reporting_api_integration/reporting_without_security/job_apis.ts