Update supertest and superagent to latest version (#183587)

## Summary Related to #7104 Update supertest, superagent, and the corresponding type package, to their latest version. (of course, types had some signature changes and we're massively using supertest in all our FTR suites so the whole Kibana multiverse has to review it) --------- Co-authored-by: kibanamachine <[email protected]>
elastic · May 17, 2024 · 148eeec · 148eeec
1 parent 4b7d014
commit 148eeec
Show file tree

Hide file tree

Showing 153 changed files with 439 additions and 431 deletions.
diff --git a/package.json b/package.json
@@ -1523,7 +1523,7 @@
     "@types/source-map-support": "^0.5.3",
     "@types/stats-lite": "^2.2.0",
     "@types/styled-components": "^5.1.0",
-    "@types/supertest": "^2.0.12",
+    "@types/supertest": "^6.0.2",
     "@types/tapable": "^1.0.6",
     "@types/tar": "^6.1.11",
     "@types/testing-library__jest-dom": "^5.14.7",
@@ -1697,8 +1697,8 @@
     "style-loader": "^1.1.3",
     "stylelint": "^14.9.1",
     "stylelint-scss": "^4.3.0",
-    "superagent": "^8.1.2",
-    "supertest": "^6.3.3",
+    "superagent": "^9.0.2",
+    "supertest": "^7.0.0",
     "svgo": "^2.8.0",
     "table": "^6.8.1",
     "tape": "^5.0.1",

diff --git a/packages/core/http/core-http-server-internal/src/http_server.test.ts b/packages/core/http/core-http-server-internal/src/http_server.test.ts
@@ -1622,7 +1622,7 @@ describe('setup contract', () => {
         .get('/static/some_json.json')
         .expect(200);
 
-      const etag = response.get('etag');
+      const etag = response.get('etag')!;
       expect(etag).not.toBeUndefined();
 
       await supertest(innerServer.listener)

diff --git a/packages/kbn-cli-dev-mode/src/integration_tests/base_path_proxy_server.test.ts b/packages/kbn-cli-dev-mode/src/integration_tests/base_path_proxy_server.test.ts
@@ -28,7 +28,7 @@ describe('BasePathProxyServer', () => {
   let logger: TestLog;
   let config: IHttpConfig;
   let basePath: string;
-  let proxySupertest: supertest.SuperTest<supertest.Test>;
+  let proxySupertest: supertest.Agent;
 
   beforeEach(async () => {
     logger = new TestLog();
@@ -330,7 +330,7 @@ describe('BasePathProxyServer', () => {
 
   describe('shouldRedirect', () => {
     let proxyServerWithoutShouldRedirect: BasePathProxyServer;
-    let proxyWithoutShouldRedirectSupertest: supertest.SuperTest<supertest.Test>;
+    let proxyWithoutShouldRedirectSupertest: supertest.Agent;
 
     beforeEach(async () => {
       // setup and start a proxy server which does not use "shouldRedirectFromOldBasePath"
@@ -373,7 +373,7 @@ describe('BasePathProxyServer', () => {
 
   describe('constructor option for sending in a custom basePath', () => {
     let proxyServerWithFooBasePath: BasePathProxyServer;
-    let proxyWithFooBasePath: supertest.SuperTest<supertest.Test>;
+    let proxyWithFooBasePath: supertest.Agent;
 
     beforeEach(async () => {
       // setup and start a proxy server which uses a basePath of "foo"

diff --git a/src/core/server/integration_tests/http/cookie_session_storage.test.ts b/src/core/server/integration_tests/http/cookie_session_storage.test.ts
@@ -134,7 +134,7 @@ describe('Cookie based SessionStorage', () => {
 
       const response = await supertest(innerServer.listener).get('/').expect(200);
 
-      const cookies = response.get('set-cookie');
+      const cookies = response.get('set-cookie')!;
       expect(cookies).toBeDefined();
       expect(cookies).toHaveLength(1);
 
@@ -172,7 +172,7 @@ describe('Cookie based SessionStorage', () => {
 
       const response = await supertest(innerServer.listener).get('/').expect(200);
 
-      const cookies = response.get('set-cookie');
+      const cookies = response.get('set-cookie')!;
       expect(cookies).toBeDefined();
       expect(cookies).toHaveLength(1);
 
@@ -204,7 +204,7 @@ describe('Cookie based SessionStorage', () => {
 
       const response = await supertest(innerServer.listener).get('/').expect(200, { value: null });
 
-      const cookies = response.get('set-cookie');
+      const cookies = response.get('set-cookie')!;
       expect(cookies).not.toBeDefined();
     });
 
@@ -237,7 +237,7 @@ describe('Cookie based SessionStorage', () => {
         .get('/')
         .expect(200, { value: userData });
 
-      const cookies = response.get('set-cookie');
+      const cookies = response.get('set-cookie')!;
       expect(cookies).toBeDefined();
 
       await delay(sessionDurationMs);
@@ -283,7 +283,7 @@ describe('Cookie based SessionStorage', () => {
         .get('/')
         .expect(200, { value: userData });
 
-      const cookies = response.get('set-cookie');
+      const cookies = response.get('set-cookie')!;
       expect(cookies).toBeDefined();
 
       const sessionCookie = retrieveSessionCookie(cookies[0]);
@@ -418,7 +418,7 @@ describe('Cookie based SessionStorage', () => {
 
       const response = await supertest(innerServer.listener).get('/').expect(200);
 
-      const cookies = response.get('set-cookie');
+      const cookies = response.get('set-cookie')!;
       const sessionCookie = retrieveSessionCookie(cookies[0]);
 
       const response2 = await supertest(innerServer.listener)
@@ -475,7 +475,7 @@ describe('Cookie based SessionStorage', () => {
 
           const response = await supertest(innerServer.listener).get('/').expect(200);
 
-          const cookies = response.get('set-cookie');
+          const cookies = response.get('set-cookie')!;
           expect(cookies).toBeDefined();
           expect(cookies).toHaveLength(1);
 

diff --git a/src/core/server/integration_tests/http/versioned_router.test.ts b/src/core/server/integration_tests/http/versioned_router.test.ts
@@ -29,7 +29,7 @@ interface AdditionalOptions {
 
 describe('Routing versioned requests', () => {
   let router: IRouter;
-  let supertest: Supertest.SuperTest<Supertest.Test>;
+  let supertest: Supertest.Agent;
 
   async function setupServer(cliArgs: Partial<CliArgs> = {}, options: AdditionalOptions = {}) {
     logger = loggingSystemMock.create();

diff --git a/src/core/server/integration_tests/metrics/server_collector.test.ts b/src/core/server/integration_tests/metrics/server_collector.test.ts
@@ -116,7 +116,7 @@ describe('ServerMetricsCollector', () => {
     // Subscribe to the aborted$ event
     const waitFor1stAbort = disconnectAborted$.pipe(take(1)).toPromise();
 
-    discoReq1.abort();
+    void discoReq1.abort();
 
     // Wait for the aborted$ event
     await waitFor1stAbort;
@@ -132,7 +132,7 @@ describe('ServerMetricsCollector', () => {
     // Subscribe to the aborted$ event
     const waitFor2ndAbort = disconnectAborted$.pipe(take(1)).toPromise();
 
-    discoReq2.abort();
+    void discoReq2.abort();
 
     // Wait for the aborted$ event
     await waitFor2ndAbort;

diff --git a/test/api_integration/apis/data_views/fields_route/cache.ts b/test/api_integration/apis/data_views/fields_route/cache.ts
@@ -70,7 +70,7 @@ export default function ({ getService }: FtrProviderContext) {
 
       await supertest
         .get(FIELDS_PATH)
-        .set('If-None-Match', response.get('etag'))
+        .set('If-None-Match', response.get('etag')!)
         .query({
           pattern: '*',
           include_unmapped: true,

diff --git a/test/api_integration/apis/saved_objects_management/scroll_count.ts b/test/api_integration/apis/saved_objects_management/scroll_count.ts
@@ -6,15 +6,14 @@
  * Side Public License, v 1.
  */
 
-import { SuperTest, Test } from 'supertest';
 import expect from '@kbn/expect';
 import { FtrProviderContext } from '../../ftr_provider_context';
 
 const apiUrl = '/api/kibana/management/saved_objects/scroll/counts';
 const defaultTypes = ['visualization', 'index-pattern', 'search', 'dashboard'];
 
 export default function ({ getService }: FtrProviderContext) {
-  const supertest = getService('supertest') as SuperTest<Test>;
+  const supertest = getService('supertest');
   const kibanaServer = getService('kibanaServer');
   const esArchiver = getService('esArchiver');
 

diff --git a/test/api_integration/apis/telemetry/opt_in.ts b/test/api_integration/apis/telemetry/opt_in.ts
@@ -87,7 +87,7 @@ export default function optInTest({ getService }: FtrProviderContext) {
 }
 
 async function postTelemetryV2OptIn(
-  supertest: SuperTest.SuperTest<SuperTest.Test>,
+  supertest: SuperTest.Agent,
   value: unknown,
   statusCode: number
 ): Promise<any> {

diff --git a/test/api_integration/services/supertest.ts b/test/api_integration/services/supertest.ts
@@ -13,13 +13,15 @@ import { format as formatUrl } from 'url';
 import supertest from 'supertest';
 import { FtrProviderContext } from '../../functional/ftr_provider_context';
 
-export function KibanaSupertestProvider({ getService }: FtrProviderContext) {
+export function KibanaSupertestProvider({ getService }: FtrProviderContext): supertest.Agent {
   const config = getService('config');
   const kibanaServerUrl = formatUrl(config.get('servers.kibana'));
   return supertest(kibanaServerUrl);
 }
 
-export function ElasticsearchSupertestProvider({ getService }: FtrProviderContext) {
+export function ElasticsearchSupertestProvider({
+  getService,
+}: FtrProviderContext): supertest.Agent {
   const config = getService('config');
   const esServerConfig = config.get('servers.elasticsearch');
 

diff --git a/test/common/services/bsearch.ts b/test/common/services/bsearch.ts
@@ -40,7 +40,7 @@ const getSpaceUrlPrefix = (spaceId?: string): string => {
  * Options for the send method
  */
 interface SendOptions {
-  supertest: SuperTest.SuperTest<SuperTest.Test>;
+  supertest: SuperTest.Agent;
   options: object;
   strategy: string;
   space?: string;

diff --git a/...ty_solution/apm/server/lib/helpers/create_es_client/create_apm_event_client/index.test.ts b/...ty_solution/apm/server/lib/helpers/create_es_client/create_apm_event_client/index.test.ts
@@ -74,7 +74,7 @@ describe('APMEventClient', () => {
             resolve(undefined);
           }, 100);
         });
-        incomingRequest.abort();
+        void incomingRequest.abort();
       }, 100);
     });
 

diff --git a/x-pack/test/alerting_api_integration/common/lib/wait_for_execution_count.ts b/x-pack/test/alerting_api_integration/common/lib/wait_for_execution_count.ts
@@ -13,7 +13,7 @@ async function delay(millis: number): Promise<void> {
 }
 
 export function createWaitForExecutionCount(
-  st: supertest.SuperTest<supertest.Test>,
+  st: supertest.Agent,
   spaceId?: string,
   delayMs: number = 3000
 ) {

diff --git a/x-pack/test/alerting_api_integration/observability/helpers/alerting_api_helper.ts b/x-pack/test/alerting_api_integration/observability/helpers/alerting_api_helper.ts
@@ -6,7 +6,7 @@
  */
 
 import type { Client } from '@elastic/elasticsearch';
-import type { SuperTest, Test } from 'supertest';
+import type { Agent as SuperTestAgent } from 'supertest';
 import { ToolingLog } from '@kbn/tooling-log';
 import { ThresholdParams } from '@kbn/observability-plugin/common/custom_threshold_rule/types';
 import { refreshSavedObjectIndices } from './refresh_index';
@@ -17,7 +17,7 @@ export async function createIndexConnector({
   indexName,
   logger,
 }: {
-  supertest: SuperTest<Test>;
+  supertest: SuperTestAgent;
   name: string;
   indexName: string;
   logger: ToolingLog;
@@ -51,7 +51,7 @@ export async function createRule<Params = ThresholdParams>({
   logger,
   esClient,
 }: {
-  supertest: SuperTest<Test>;
+  supertest: SuperTestAgent;
   ruleTypeId: string;
   name: string;
   params: Params;

diff --git a/x-pack/test/alerting_api_integration/observability/helpers/alerting_wait_for_helpers.ts b/x-pack/test/alerting_api_integration/observability/helpers/alerting_wait_for_helpers.ts
@@ -29,7 +29,7 @@ export async function waitForRuleStatus({
 }: {
   id: string;
   expectedStatus: string;
-  supertest: SuperTest.SuperTest<SuperTest.Test>;
+  supertest: SuperTest.Agent;
   retryService: RetryService;
   logger: ToolingLog;
 }): Promise<Record<string, any>> {

diff --git a/x-pack/test/alerting_api_integration/observability/helpers/data_view.ts b/x-pack/test/alerting_api_integration/observability/helpers/data_view.ts
@@ -5,7 +5,7 @@
  * 2.0.
  */
 
-import { SuperTest, Test } from 'supertest';
+import { Agent as SuperTestAgent } from 'supertest';
 import { ToolingLog } from '@kbn/tooling-log';
 
 export const createDataView = async ({
@@ -15,7 +15,7 @@ export const createDataView = async ({
   title,
   logger,
 }: {
-  supertest: SuperTest<Test>;
+  supertest: SuperTestAgent;
   id: string;
   name: string;
   title: string;
@@ -50,7 +50,7 @@ export const deleteDataView = async ({
   id,
   logger,
 }: {
-  supertest: SuperTest<Test>;
+  supertest: SuperTestAgent;
   id: string;
   logger: ToolingLog;
 }) => {

diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/group1/tests/alerting/find.ts b/x-pack/test/alerting_api_integration/security_and_spaces/group1/tests/alerting/find.ts
@@ -6,7 +6,7 @@
  */
 
 import expect from '@kbn/expect';
-import { SuperTest, Test } from 'supertest';
+import { Agent as SuperTestAgent } from 'supertest';
 import { chunk, omit } from 'lodash';
 import { v4 as uuidv4 } from 'uuid';
 import { SuperuserAtSpace1, UserAtSpaceScenarios } from '../../../scenarios';
@@ -16,7 +16,7 @@ import { FtrProviderContext } from '../../../../common/ftr_provider_context';
 const findTestUtils = (
   describeType: 'internal' | 'public',
   objectRemover: ObjectRemover,
-  supertest: SuperTest<Test>,
+  supertest: SuperTestAgent,
   supertestWithoutAuth: any
 ) => {
   describe.skip(describeType, () => {

diff --git a/...test/alerting_api_integration/security_and_spaces/group1/tests/alerting/find_with_post.ts b/...test/alerting_api_integration/security_and_spaces/group1/tests/alerting/find_with_post.ts
@@ -6,7 +6,7 @@
  */
 
 import expect from '@kbn/expect';
-import { SuperTest, Test } from 'supertest';
+import { Agent as SuperTestAgent } from 'supertest';
 import { chunk, omit } from 'lodash';
 import { v4 as uuidv4 } from 'uuid';
 import { UserAtSpaceScenarios } from '../../../scenarios';
@@ -16,7 +16,7 @@ import { FtrProviderContext } from '../../../../common/ftr_provider_context';
 const findTestUtils = (
   describeType: 'internal' | 'public',
   objectRemover: ObjectRemover,
-  supertest: SuperTest<Test>,
+  supertest: SuperTestAgent,
   supertestWithoutAuth: any
 ) => {
   // FLAKY: https://github.com/elastic/kibana/issues/182314

diff --git a/x-pack/test/alerting_api_integration/security_and_spaces/group1/tests/alerting/get.ts b/x-pack/test/alerting_api_integration/security_and_spaces/group1/tests/alerting/get.ts
@@ -6,7 +6,7 @@
  */
 
 import expect from '@kbn/expect';
-import { SuperTest, Test } from 'supertest';
+import { Agent as SuperTestAgent } from 'supertest';
 import { SuperuserAtSpace1, UserAtSpaceScenarios } from '../../../scenarios';
 import {
   getUrlPrefix,
@@ -19,7 +19,7 @@ import { FtrProviderContext } from '../../../../common/ftr_provider_context';
 const getTestUtils = (
   describeType: 'internal' | 'public',
   objectRemover: ObjectRemover,
-  supertest: SuperTest<Test>,
+  supertest: SuperTestAgent,
   supertestWithoutAuth: any
 ) => {
   describe(describeType, () => {

diff --git a/...g_api_integration/security_and_spaces/group2/tests/actions/connector_types/crowdstrike.ts b/...g_api_integration/security_and_spaces/group2/tests/actions/connector_types/crowdstrike.ts
@@ -131,7 +131,7 @@ export default function createCrowdstrikeTests({ getService }: FtrProviderContex
         password = 'changeme',
         errorLogger = logErrorDetails,
       }: {
-        supertest: SuperTest.SuperTest<SuperTest.Test>;
+        supertest: SuperTest.Agent;
         subAction: string;
         subActionParams: Record<string, unknown>;
         expectedHttpCode?: number;

diff --git a/...g_api_integration/security_and_spaces/group2/tests/actions/connector_types/sentinelone.ts b/...g_api_integration/security_and_spaces/group2/tests/actions/connector_types/sentinelone.ts
@@ -140,7 +140,7 @@ export default function createSentinelOneTests({ getService }: FtrProviderContex
         password = 'changeme',
         errorLogger = logErrorDetails,
       }: {
-        supertest: SuperTest.SuperTest<SuperTest.Test>;
+        supertest: SuperTest.Agent;
         subAction: string;
         subActionParams: Record<string, unknown>;
         expectedHttpCode?: number;

diff --git a/...ng_api_integration/security_and_spaces/group2/tests/actions/sub_action_framework/index.ts b/...ng_api_integration/security_and_spaces/group2/tests/actions/sub_action_framework/index.ts
@@ -22,7 +22,7 @@ const createSubActionConnector = async ({
   connectorTypeId = 'test.sub-action-connector',
   expectedHttpCode = 200,
 }: {
-  supertest: SuperTest.SuperTest<SuperTest.Test>;
+  supertest: SuperTest.Agent;
   config?: Record<string, unknown>;
   secrets?: Record<string, unknown>;
   connectorTypeId?: string;
@@ -56,7 +56,7 @@ const executeSubAction = async ({
   subActionParams,
   expectedHttpCode = 200,
 }: {
-  supertest: SuperTest.SuperTest<SuperTest.Test>;
+  supertest: SuperTest.Agent;
   connectorId: string;
   subAction: string;
   subActionParams: Record<string, unknown>;

diff --git a/.../test/alerting_api_integration/spaces_only/tests/actions/connector_types/stack/webhook.ts b/.../test/alerting_api_integration/spaces_only/tests/actions/connector_types/stack/webhook.ts
@@ -8,7 +8,7 @@
 import http from 'http';
 import https from 'https';
 import getPort from 'get-port';
-import { SuperTest, Test } from 'supertest';
+import { Agent as SuperTestAgent } from 'supertest';
 import expect from '@kbn/expect';
 import { URL, format as formatUrl } from 'url';
 import {
@@ -177,7 +177,7 @@ export default function webhookTest({ getService }: FtrProviderContext) {
 }
 
 export async function createWebhookAction(
-  supertest: SuperTest<Test>,
+  supertest: SuperTestAgent,
   webhookSimulatorURL: string,
   config: Record<string, string | Record<string, string>> = {}
 ): Promise<string> {