Asserts deprecation config passes to router args

elastic · Nov 7, 2024 · 621cc36 · 621cc36
1 parent f21b1ea
commit 621cc36
Show file tree

Hide file tree

Showing 26 changed files with 251 additions and 201 deletions.
diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/index.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/index.ts
@@ -36,14 +36,6 @@ import { registerLegacyExportRoute } from './legacy_import_export/export';
 import { registerBulkResolveRoute } from './bulk_resolve';
 import { registerDeleteUnknownTypesRoute } from './deprecations';
 
-// export interface RouteDeprecationInfo {
-//   documentationUrl: string;
-//   severity: 'warning';
-//   reason: {
-//     type: 'deprecate' | 'remove';
-//   };
-// }
-
 export function registerRoutes({
   http,
   coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_create.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_create.test.ts
@@ -21,7 +21,7 @@ import {
 } from '@kbn/core-saved-objects-server-internal';
 import { createHiddenTypeVariants, setupServer } from '@kbn/core-test-helpers-test-utils';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -56,13 +56,7 @@ describe('POST /api/saved_objects/_bulk_create with allowApiAccess true', () =>
     const logger = loggerMock.create();
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerBulkCreateRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_delete.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_delete.test.ts
@@ -20,7 +20,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -60,13 +60,7 @@ describe('POST /api/saved_objects/_bulk_delete with allowApiAccess as true', ()
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerBulkDeleteRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_get.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_get.test.ts
@@ -20,7 +20,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -58,13 +58,7 @@ describe('POST /api/saved_objects/_bulk_get with allowApiAccess true', () => {
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerBulkGetRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_resolve.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_resolve.test.ts
@@ -20,7 +20,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -59,13 +59,7 @@ describe('POST /api/saved_objects/_bulk_resolve with allowApiAccess true', () =>
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerBulkResolveRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_update.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/bulk_update.test.ts
@@ -19,7 +19,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 const testTypes = [
@@ -52,13 +52,7 @@ describe('PUT /api/saved_objects/_bulk_update with allowApiAccess true', () => {
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerBulkUpdateRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/create.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/create.test.ts
@@ -20,7 +20,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -58,13 +58,7 @@ describe('POST /api/saved_objects/{type} with allowApiAccess true', () => {
     const logger = loggerMock.create();
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerCreateRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/delete.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/delete.test.ts
@@ -20,7 +20,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -55,13 +55,7 @@ describe('DELETE /api/saved_objects/{type}/{id} with allowApiAccess true', () =>
     const logger = loggerMock.create();
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerDeleteRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/find.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/find.test.ts
@@ -21,7 +21,7 @@ import {
   registerFindRoute,
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -71,13 +71,7 @@ describe('GET /api/saved_objects/_find with allowApiAccess true', () => {
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerFindRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/get.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/get.test.ts
@@ -25,7 +25,7 @@ import {
 } from '@kbn/core-saved-objects-server-internal';
 import { createHiddenTypeVariants } from '@kbn/core-test-helpers-test-utils';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 const coreId = Symbol('core');
 const testTypes = [
@@ -80,13 +80,7 @@ describe('GET /api/saved_objects/{type}/{id} with allowApiAccess true', () => {
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerGetRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/resolve.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/resolve.test.ts
@@ -25,7 +25,7 @@ import {
 } from '@kbn/core-saved-objects-server-internal';
 import { createHiddenTypeVariants } from '@kbn/core-test-helpers-test-utils';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 const coreId = Symbol('core');
 
@@ -80,13 +80,7 @@ describe('GET /api/saved_objects/resolve/{type}/{id} with allowApiAccess true',
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerResolveRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/allow_api_access/update.test.ts b/src/core/server/integration_tests/saved_objects/routes/allow_api_access/update.test.ts
@@ -20,7 +20,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from '../routes_test_utils';
+import { deprecationMock, setupConfig } from '../routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -56,13 +56,7 @@ describe('PUT /api/saved_objects/{type}/{id?} with allowApiAccess true', () => {
 
     const config = setupConfig(true);
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerUpdateRoute(router, {
       config,
       coreUsageData,

diff --git a/src/core/server/integration_tests/saved_objects/routes/bulk_create.test.ts b/src/core/server/integration_tests/saved_objects/routes/bulk_create.test.ts
@@ -21,7 +21,7 @@ import {
 } from '@kbn/core-saved-objects-server-internal';
 import { createHiddenTypeVariants, setupServer } from '@kbn/core-test-helpers-test-utils';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from './routes_test_utils';
+import { deprecationMock, setupConfig } from './routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -37,6 +37,7 @@ describe('POST /api/saved_objects/_bulk_create', () => {
   let savedObjectsClient: ReturnType<typeof savedObjectsClientMock.create>;
   let coreUsageStatsClient: jest.Mocked<ICoreUsageStatsClient>;
   let loggerWarnSpy: jest.SpyInstance;
+  let registrationSpy: jest.SpyInstance;
 
   beforeEach(async () => {
     ({ server, httpSetup, handlerContext } = await setupServer());
@@ -57,16 +58,11 @@ describe('POST /api/saved_objects/_bulk_create', () => {
 
     const logger = loggerMock.create();
     loggerWarnSpy = jest.spyOn(logger, 'warn').mockImplementation();
+    registrationSpy = jest.spyOn(router, 'post');
 
     const config = setupConfig();
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerBulkCreateRoute(router, {
       config,
       coreUsageData,
@@ -206,4 +202,24 @@ describe('POST /api/saved_objects/_bulk_create', () => {
       .expect(200);
     expect(loggerWarnSpy).toHaveBeenCalledTimes(1);
   });
+
+  it('passes deprecation config to the router arguments', async () => {
+    await supertest(httpSetup.server.listener)
+      .post('/api/saved_objects/_bulk_create')
+      .set('x-elastic-internal-origin', 'kibana')
+      .send([
+        {
+          id: 'abc1234',
+          type: 'index-pattern',
+          attributes: {
+            title: 'foo',
+          },
+          references: [],
+        },
+      ])
+      .expect(200);
+    expect(registrationSpy.mock.calls[0][0]).toMatchObject({
+      options: { deprecated: deprecationMock },
+    });
+  });
 });
diff --git a/src/core/server/integration_tests/saved_objects/routes/bulk_delete.test.ts b/src/core/server/integration_tests/saved_objects/routes/bulk_delete.test.ts
@@ -20,7 +20,7 @@ import {
   type InternalSavedObjectsRequestHandlerContext,
 } from '@kbn/core-saved-objects-server-internal';
 import { loggerMock } from '@kbn/logging-mocks';
-import { setupConfig } from './routes_test_utils';
+import { deprecationMock, setupConfig } from './routes_test_utils';
 
 type SetupServerReturn = Awaited<ReturnType<typeof setupServer>>;
 
@@ -36,6 +36,7 @@ describe('POST /api/saved_objects/_bulk_delete', () => {
   let savedObjectsClient: ReturnType<typeof savedObjectsClientMock.create>;
   let coreUsageStatsClient: jest.Mocked<ICoreUsageStatsClient>;
   let loggerWarnSpy: jest.SpyInstance;
+  let registrationSpy: jest.SpyInstance;
 
   beforeEach(async () => {
     ({ server, httpSetup, handlerContext } = await setupServer());
@@ -59,16 +60,11 @@ describe('POST /api/saved_objects/_bulk_delete', () => {
 
     const logger = loggerMock.create();
     loggerWarnSpy = jest.spyOn(logger, 'warn').mockImplementation();
+    registrationSpy = jest.spyOn(router, 'post');
 
     const config = setupConfig();
     const access = 'public';
-    const deprecationMock = {
-      documentationUrl: 'http://elastic.co',
-      severity: 'warning' as const,
-      reason: {
-        type: 'deprecate' as const,
-      },
-    };
+
     registerBulkDeleteRoute(router, {
       config,
       coreUsageData,
@@ -175,4 +171,21 @@ describe('POST /api/saved_objects/_bulk_delete', () => {
       .expect(400);
     expect(loggerWarnSpy).toHaveBeenCalledTimes(1);
   });
+
+  it('passes deprecation configuration to the router arguments', async () => {
+    await supertest(httpSetup.server.listener)
+      .post('/api/saved_objects/_bulk_delete')
+      .set('x-elastic-internal-origin', 'kibana')
+      .send([
+        {
+          id: 'hiddenID',
+          type: 'hidden-from-http',
+        },
+      ])
+      .expect(400);
+
+    expect(registrationSpy.mock.calls[0][0]).toMatchObject({
+      options: { deprecated: deprecationMock },
+    });
+  });
 });