Removes deprecated request and @percy/agent

* Addresses first set of dependencies that are upstream from `[email protected]`. There is more work to do but a webpack upgrade is required first. * Replaces usage of `request` in integration tests with `tough-cookie`. * `@percy/agent` is deprecated and is replaced by `@percy/cli`. * Bumps `follow-redirects- to address CVE. * Also removes unnecessary user management logic from functional tests. Resolves opensearch-project#1133 Incremental change towards addressing opensearch-project#1066 Signed-off-by: Tommy Markley <[email protected]>
tmarkley · Feb 4, 2022 · 6988c63 · 6988c63
1 parent a7da974
commit 6988c63
Show file tree

Hide file tree

Showing 10 changed files with 592 additions and 890 deletions.
diff --git a/package.json b/package.json
@@ -89,7 +89,6 @@
     "**/prismjs": "^1.23.0",
     "**/react-syntax-highlighter": "^15.3.1",
     "**/react-syntax-highlighter/**/highlight.js": "^10.4.1",
-    "**/request": "^2.88.2",
     "**/ssri": "^6.0.2",
     "**/tar": "^6.1.11",
     "**/trim": "^0.0.3",
@@ -199,7 +198,6 @@
     "react-use": "^13.27.0",
     "redux-thunk": "^2.3.0",
     "regenerator-runtime": "^0.13.3",
-    "request": "^2.88.0",
     "require-in-the-middle": "^5.0.2",
     "rison-node": "1.0.2",
     "rxjs": "^6.5.5",
@@ -245,7 +243,8 @@
     "@osd/test": "1.0.0",
     "@osd/test-subj-selector": "0.2.1",
     "@osd/utility-types": "1.0.0",
-    "@percy/agent": "^0.28.6",
+    "@percy/cli": "^1.0.0-beta.71",
+    "@percy/sdk-utils": "^1.0.0-beta.71",
     "@testing-library/dom": "^7.24.2",
     "@testing-library/jest-dom": "^5.11.4",
     "@testing-library/react": "^11.0.4",
@@ -325,6 +324,7 @@
     "@types/tar": "^4.0.3",
     "@types/testing-library__jest-dom": "^5.9.3",
     "@types/testing-library__react-hooks": "^3.4.0",
+    "@types/tough-cookie": "^4.0.1",
     "@types/type-detect": "^4.0.1",
     "@types/uuid": "^3.4.4",
     "@types/vinyl": "^2.0.4",
@@ -406,7 +406,7 @@
     "leaflet-responsive-popup": "0.6.4",
     "leaflet-vega": "^0.8.6",
     "leaflet.heat": "0.2.0",
-    "less": "npm:@elastic/[email protected]",
+    "less": "^4.1.2",
     "license-checker": "^16.0.0",
     "listr": "^0.14.1",
     "load-grunt-config": "^3.0.1",
@@ -450,6 +450,7 @@
     "supertest-as-promised": "^4.0.2",
     "tape": "^5.0.1",
     "topojson-client": "3.0.0",
+    "tough-cookie": "^4.0.0",
     "tree-kill": "^1.2.2",
     "typescript": "4.0.2",
     "ui-select": "0.19.8",

diff --git a/packages/osd-test/src/functional_tests/lib/auth.js b/packages/osd-test/src/functional_tests/lib/auth.js
diff --git a/packages/osd-test/src/functional_tests/lib/run_opensearch.js b/packages/osd-test/src/functional_tests/lib/run_opensearch.js
@@ -39,8 +39,6 @@ import { resolve } from 'path';
 import { OPENSEARCH_DASHBOARDS_ROOT } from './paths';
 import { createLegacyOpenSearchTestCluster } from '../../legacy_opensearch';
 
-import { setupUsers, DEFAULT_SUPERUSER_PASS } from './auth';
-
 export async function runOpenSearch({ config, options }) {
   const { log, opensearchFrom } = options;
   const ssl = config.get('opensearchTestCluster.ssl');
@@ -51,9 +49,7 @@ export async function runOpenSearch({ config, options }) {
 
   const cluster = createLegacyOpenSearchTestCluster({
     port: config.get('servers.opensearch.port'),
-    password: isSecurityEnabled
-      ? DEFAULT_SUPERUSER_PASS
-      : config.get('servers.opensearch.password'),
+    password: isSecurityEnabled ? 'changethispassword' : config.get('servers.opensearch.password'),
     license,
     log,
     basePath: resolve(OPENSEARCH_DASHBOARDS_ROOT, '.opensearch'),
@@ -66,22 +62,5 @@ export async function runOpenSearch({ config, options }) {
 
   await cluster.start();
 
-  if (isSecurityEnabled) {
-    await setupUsers({
-      log,
-      opensearchPort: config.get('servers.opensearch.port'),
-      updates: [config.get('servers.opensearch'), config.get('servers.opensearchDashboards')],
-      protocol: config.get('servers.opensearch').protocol,
-      caPath: getRelativeCertificateAuthorityPath(config.get('osdTestServer.serverArgs')),
-    });
-  }
-
   return cluster;
 }
-
-function getRelativeCertificateAuthorityPath(opensearchConfig = []) {
-  const caConfig = opensearchConfig.find(
-    (config) => config.indexOf('--opensearch.ssl.certificateAuthorities') === 0
-  );
-  return caConfig ? caConfig.split('=')[1] : undefined;
-}
diff --git a/packages/osd-test/src/index.ts b/packages/osd-test/src/index.ts
@@ -57,9 +57,6 @@ export {
   adminTestUser,
 } from './osd';
 
-// @ts-ignore not typed yet
-export { setupUsers, DEFAULT_SUPERUSER_PASS } from './functional_tests/lib/auth';
-
 export { readConfigFile } from './functional_test_runner/lib/config/read_config_file';
 
 export { runFtrCli } from './functional_test_runner/cli';

diff --git a/src/core/server/http/cookie_session_storage.test.ts b/src/core/server/http/cookie_session_storage.test.ts
@@ -29,7 +29,8 @@
  * Modifications Copyright OpenSearch Contributors. See
  * GitHub history for details.
  */
-import request from 'request';
+
+import { parse as parseCookie } from 'tough-cookie';
 import supertest from 'supertest';
 import { REPO_ROOT } from '@osd/dev-utils';
 import { ByteSizeValue } from '@osd/config-schema';
@@ -107,7 +108,7 @@ interface Storage {
 }
 
 function retrieveSessionCookie(cookies: string) {
-  const sessionCookie = request.cookie(cookies);
+  const sessionCookie = parseCookie(cookies);
   if (!sessionCookie) {
     throw new Error('session cookie expected to be defined');
   }
@@ -487,7 +488,7 @@ describe('Cookie based SessionStorage', () => {
           expect(cookies).toHaveLength(1);
 
           const sessionCookie = retrieveSessionCookie(cookies[0]);
-          expect(sessionCookie.extensions).toContain(`SameSite=${sameSite}`);
+          expect(sessionCookie.sameSite).toEqual(sameSite.toLowerCase());
 
           await supertest(innerServer.listener)
             .get('/')

diff --git a/src/core/server/http/integration_tests/lifecycle.test.ts b/src/core/server/http/integration_tests/lifecycle.test.ts
@@ -31,7 +31,7 @@
  */
 
 import supertest from 'supertest';
-import request from 'request';
+import { parse as parseCookie } from 'tough-cookie';
 import { schema } from '@osd/config-schema';
 
 import { ensureRawRequest } from '../router';
@@ -774,7 +774,7 @@ describe('Auth', () => {
     const cookies = response.header['set-cookie'];
     expect(cookies).toHaveLength(1);
 
-    const sessionCookie = request.cookie(cookies[0]);
+    const sessionCookie = parseCookie(cookies[0]);
     if (!sessionCookie) {
       throw new Error('session cookie expected to be defined');
     }

diff --git a/src/core/test_helpers/osd_server.ts b/src/core/test_helpers/osd_server.ts
@@ -33,12 +33,9 @@ import { Client } from 'elasticsearch';
 import { ToolingLog, REPO_ROOT } from '@osd/dev-utils';
 import {
   createLegacyOpenSearchTestCluster,
-  DEFAULT_SUPERUSER_PASS,
   opensearchTestConfig,
-  osdTestConfig,
   opensearchDashboardsServerTestUser,
   opensearchDashboardsTestUser,
-  setupUsers,
 } from '@osd/test';
 import { defaultsDeep, get } from 'lodash';
 import { resolve } from 'path';
@@ -253,7 +250,6 @@ export function createTestServers({
     defaultsDeep({}, get(settings, 'opensearch', {}), {
       log,
       license,
-      password: license === 'trial' ? DEFAULT_SUPERUSER_PASS : undefined,
     })
   );
 
@@ -269,19 +265,7 @@ export function createTestServers({
       await opensearch.start(get(settings, 'opensearch.opensearchArgs', []));
 
       if (['gold', 'trial'].includes(license)) {
-        await setupUsers({
-          log,
-          opensearchPort: opensearchTestConfig.getUrlParts().port,
-          updates: [
-            ...usersToBeAdded,
-            // user opensearch
-            opensearchTestConfig.getUrlParts(),
-            // user opensearchDashboards
-            osdTestConfig.getUrlParts(),
-          ],
-        });
-
-        // Override provided configs, we know what the opensearch user is now
+        // Override provided configs
         osdSettings.opensearch = {
           hosts: [opensearchTestConfig.getUrl()],
           username: opensearchDashboardsServerTestUser.username,

diff --git a/test/visual_regression/services/visual_testing/take_percy_snapshot.js b/test/visual_regression/services/visual_testing/take_percy_snapshot.js
@@ -30,9 +30,6 @@
  * GitHub history for details.
  */
 
-import { readFileSync } from 'fs';
-import { agentJsFilename } from '@percy/agent/dist/utils/sdk-utils';
-
 export function takePercySnapshot(show, hide) {
   if (!window.PercyAgent) {
     return false;
@@ -120,7 +117,5 @@ export function takePercySnapshot(show, hide) {
 }
 
 export const takePercySnapshotWithAgent = `
-  ${readFileSync(agentJsFilename(), 'utf8')}
-
   return (${takePercySnapshot.toString()}).apply(null, arguments);
 `;
diff --git a/test/visual_regression/services/visual_testing/visual_testing.ts b/test/visual_regression/services/visual_testing/visual_testing.ts
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-import { postSnapshot } from '@percy/agent/dist/utils/sdk-utils';
+import { postSnapshot } from '@percy/sdk-utils';
 import { Test } from 'mocha';
 
 import testSubjSelector from '@osd/test-subj-selector';