Switch back to querystring-browser library

.eslintrc.js

@@ -343,7 +343,7 @@ module.exports = {
       settings: {
         // instructs import/no-extraneous-dependencies to treat certain modules
         // as core modules, even if they aren't listed in package.json
-        'import/core-modules': ['plugins', 'legacy/ui', 'uiExports'],
+        'import/core-modules': ['plugins', 'legacy/ui', 'uiExports', 'querystring'],
 
         'import/resolver': {
           '@kbn/eslint-import-resolver-kibana': {

package.json

@@ -225,7 +225,7 @@
     "prop-types": "15.6.0",
     "proxy-from-env": "1.0.0",
     "pug": "^2.0.4",
-    "query-string": "6.10.1",
+    "querystring-browser": "1.0.4",
     "raw-loader": "3.1.0",
     "react": "^16.12.0",
     "react-color": "^2.13.8",

packages/kbn-eslint-import-resolver-kibana/lib/get_webpack_config.js

@@ -29,6 +29,7 @@ exports.getWebpackConfig = function(kibanaPath, projectRoot, config) {
     // Kibana defaults https://github.com/elastic/kibana/blob/6998f074542e8c7b32955db159d15661aca253d7/src/legacy/ui/ui_bundler_env.js#L30-L36
     ui: fromKibana('src/legacy/ui/public'),
     test_harness: fromKibana('src/test_harness/public'),
+    querystring: 'querystring-browser',
 
     // Dev defaults for test bundle https://github.com/elastic/kibana/blob/6998f074542e8c7b32955db159d15661aca253d7/src/core_plugins/tests_bundle/index.js#L73-L78
     ng_mock$: fromKibana('src/test_utils/public/ng_mock'),

src/core/server/http/http_server.mocks.ts

@@ -19,7 +19,7 @@
 import { Request } from 'hapi';
 import { merge } from 'lodash';
 import { Socket } from 'net';
-import { stringify } from 'query-string';
+import querystring from 'querystring';
 
 import { schema } from '@kbn/config-schema';
 
@@ -66,7 +66,7 @@ function createKibanaRequestMock<P = any, Q = any, B = any>({
   validation = {},
   kibanaRouteState = { xsrfRequired: true },
 }: RequestFixtureOptions<P, Q, B> = {}) {
-  const queryString = stringify(query, { sort: false });
+  const queryString = querystring.stringify(query);
 
   return KibanaRequest.from<P, Q, B>(
     createRawRequestMock({

src/core/utils/url.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { ParsedQuery } from 'query-string';
+import { ParsedUrlQuery } from 'querystring';
 import { format as formatUrl, parse as parseUrl, UrlObject } from 'url';
 
 /**
@@ -32,7 +32,7 @@ export interface URLMeaningfulParts {
   protocol?: string | null;
   slashes?: boolean | null;
   port?: string | null;
-  query: ParsedQuery;
+  query: ParsedUrlQuery;
 }
 
 /**

src/legacy/server/logging/log_format.js

@@ -20,7 +20,7 @@
 import Stream from 'stream';
 import moment from 'moment-timezone';
 import { get, _ } from 'lodash';
-import queryString from 'query-string';
+import querystring from 'querystring';
 import numeral from '@elastic/numeral';
 import chalk from 'chalk';
 import stringify from 'json-stringify-safe';
@@ -108,7 +108,7 @@ export default class TransformObjStream extends Stream.Transform {
         contentLength: contentLength,
       };
 
-      const query = queryString.stringify(event.query, { sort: false });
+      const query = querystring.stringify(event.query);
       if (query) data.req.url += '?' + query;
 
       data.message = data.req.method.toUpperCase() + ' ';

src/plugins/console/public/application/containers/editor/legacy/console_editor/editor.tsx

@@ -20,7 +20,7 @@
 import { EuiFlexGroup, EuiFlexItem, EuiIcon, EuiScreenReaderOnly, EuiToolTip } from '@elastic/eui';
 import { i18n } from '@kbn/i18n';
 import { debounce } from 'lodash';
-import { parse } from 'query-string';
+import { parse } from 'querystring';
 import React, { CSSProperties, useCallback, useEffect, useRef, useState } from 'react';
 // @ts-ignore
 import mappings from '../../../../../lib/mappings/mappings';
@@ -101,7 +101,7 @@ function EditorUI({ initialTextValue }: EditorProps) {
     const readQueryParams = () => {
       const [, queryString] = (window.location.hash || '').split('?');
 
-      return parse(queryString || '', { sort: false }) as Required<QueryParams>;
+      return parse(queryString || '') as Required<QueryParams>;
     };
 
     const loadBufferFromRemote = (url: string) => {

src/plugins/console/public/lib/es/es.ts

@@ -18,7 +18,7 @@
  */
 
 import $ from 'jquery';
-import { stringify } from 'query-string';
+import { stringify } from 'querystring';
 
 const esVersion: string[] = [];
 
@@ -35,7 +35,7 @@ export function send(method: string, path: string, data: any) {
   const wrappedDfd = $.Deferred(); // eslint-disable-line new-cap
 
   const options: JQuery.AjaxSettings = {
-    url: '../api/console/proxy?' + stringify({ path, method }, { sort: false }),
+    url: '../api/console/proxy?' + stringify({ path, method }),
     data,
     contentType: getContentType(data),
     cache: false,

src/plugins/data/public/query/timefilter/lib/parse_querystring.ts

@@ -16,7 +16,7 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { parse } from 'query-string';
+import { parse } from 'querystring';
 
 export function parseQueryString() {
   // window.location.search is an empty string
@@ -26,5 +26,5 @@ export function parseQueryString() {
     return {};
   }
 
-  return parse(hrefSplit[1], { sort: false });
+  return parse(hrefSplit[1]);
 }

src/plugins/kibana_utils/common/url/encode_uri_query.test.ts

@@ -67,4 +67,27 @@ describe('encodeQuery', () => {
       g: 'null',
     });
   });
+
+  test('encodeQuery without encoding', () => {
+    expect(
+      encodeQuery(
+        {
+          a: 'asdf1234asdf',
+          b: "-_.!~*'() -_.!~*'()",
+          c: ':@$, :@$,',
+          d: "&;=+# &;=+#'",
+          f: ' ',
+          g: 'null',
+        },
+        v => v
+      )
+    ).toEqual({
+      a: 'asdf1234asdf',
+      b: "-_.!~*'() -_.!~*'()",
+      c: ':@$, :@$,',
+      d: "&;=+# &;=+#'",
+      f: ' ',
+      g: 'null',
+    });
+  });
 });

src/plugins/kibana_utils/common/url/encode_uri_query.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { ParsedQuery } from 'query-string';
+import { stringify, ParsedUrlQuery } from 'querystring';
 import { transform } from 'lodash';
 
 /**
@@ -42,9 +42,9 @@ export function encodeUriQuery(val: string, pctEncodeSpaces = false) {
 }
 
 export const encodeQuery = (
-  query: ParsedQuery,
+  query: ParsedUrlQuery | {},
   encodeFunction: (val: string, pctEncodeSpaces?: boolean) => string = encodeUriQuery
-) =>
+): ParsedUrlQuery =>
   transform(query, (result, value, key) => {
     if (key) {
       const singleValue = Array.isArray(value) ? value.join(',') : value;
@@ -55,3 +55,9 @@ export const encodeQuery = (
       );
     }
   });
+
+export const stringifyWithEncoding = (query: ParsedUrlQuery | {}) =>
+  stringify(query, undefined, undefined, { encodeURIComponent: encodeUriQuery });
+
+export const stringifyWithoutEncoding = (query: ParsedUrlQuery | {}) =>
+  stringify(query, undefined, undefined, { encodeURIComponent: (c: unknown) => c });

src/plugins/kibana_utils/common/url/index.ts

@@ -17,9 +17,16 @@
  * under the License.
  */
 
-import { encodeUriQuery, encodeQuery } from './encode_uri_query';
+import {
+  encodeUriQuery,
+  encodeQuery,
+  stringifyWithEncoding,
+  stringifyWithoutEncoding,
+} from './encode_uri_query';
 
 export const url = {
   encodeQuery,
   encodeUriQuery,
+  stringifyWithEncoding,
+  stringifyWithoutEncoding,
 };

src/plugins/kibana_utils/public/history/remove_query_param.ts

@@ -17,18 +17,18 @@
  * under the License.
  */
 
-import { parse, stringify } from 'query-string';
+import { parse } from 'querystring';
 import { History, Location } from 'history';
 import { url } from '../../common';
 
 export function removeQueryParam(history: History, param: string, replace: boolean = true) {
   const oldLocation = history.location;
   const search = (oldLocation.search || '').replace(/^\?/, '');
-  const query = parse(search, { sort: false });
+  const query = parse(search);
 
   delete query[param];
 
-  const newSearch = stringify(url.encodeQuery(query), { sort: false, encode: false });
+  const newSearch = url.stringifyWithEncoding(query);
   const newLocation: Location<any> = {
     ...oldLocation,
     search: newSearch,

src/plugins/kibana_utils/public/state_management/url/format.ts

@@ -18,21 +18,18 @@
  */
 
 import { format as formatUrl } from 'url';
-import { stringify, ParsedQuery } from 'query-string';
+import { ParsedUrlQuery } from 'querystring';
 import { parseUrl, parseUrlHash } from './parse';
 import { url as urlUtils } from '../../../common';
 
 export function replaceUrlHashQuery(
   rawUrl: string,
-  queryReplacer: (query: ParsedQuery) => ParsedQuery
+  queryReplacer: (query: ParsedUrlQuery) => ParsedUrlQuery
 ) {
   const url = parseUrl(rawUrl);
   const hash = parseUrlHash(rawUrl);
   const newQuery = queryReplacer(hash?.query || {});
-  const searchQueryString = stringify(urlUtils.encodeQuery(newQuery), {
-    sort: false,
-    encode: false,
-  });
+  const searchQueryString = urlUtils.stringifyWithEncoding(newQuery);
 
   if ((!hash || !hash.search) && !searchQueryString) return rawUrl; // nothing to change. return original url
   return formatUrl({

src/plugins/kibana_utils/public/state_management/url/kbn_url_storage.ts

@@ -18,7 +18,6 @@
  */
 
 import { format as formatUrl } from 'url';
-import { stringify } from 'query-string';
 import { createBrowserHistory, History } from 'history';
 import { decodeState, encodeState } from '../state_encoder';
 import { getCurrentUrl, parseUrl, parseUrlHash } from './parse';
@@ -244,11 +243,11 @@ export function getRelativeToHistoryPath(absoluteUrl: string, history: History):
 
   return formatUrl({
     pathname: stripBasename(parsedUrl.pathname),
-    search: stringify(urlUtils.encodeQuery(parsedUrl.query), { sort: false, encode: false }),
+    search: urlUtils.stringifyWithEncoding(parsedUrl.query),
     hash: parsedHash
       ? formatUrl({
           pathname: parsedHash.pathname,
-          search: stringify(urlUtils.encodeQuery(parsedHash.query), { sort: false, encode: false }),
+          search: urlUtils.stringifyWithEncoding(parsedHash.query),
         })
       : parsedUrl.hash,
   });

src/plugins/timelion/server/series_functions/quandl.test.js

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { parse } from 'query-string';
+import { parse } from 'querystring';
 import fn from './quandl';
 import moment from 'moment';
 import fetchMock from 'node-fetch';
@@ -26,7 +26,7 @@ const parseURL = require('url').parse;
 const tlConfig = require('./fixtures/tl_config')();
 
 function parseUrlParams(url) {
-  return parse(parseURL(url).query, { sort: false });
+  return parse(parseURL(url).query);
 }
 
 jest.mock('node-fetch', () =>

x-pack/legacy/plugins/apm/public/components/shared/Links/url_helpers.ts

@@ -4,21 +4,21 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { parse, stringify } from 'query-string';
+import { parse, stringify } from 'querystring';
 // eslint-disable-next-line @kbn/eslint/no-restricted-paths
 import { LocalUIFilterName } from '../../../../../../../plugins/apm/server/lib/ui_filters/local_ui_filters/config';
 import { url } from '../../../../../../../../src/plugins/kibana_utils/public';
 
 export function toQuery(search?: string): APMQueryParamsRaw {
-  return search ? parse(search.slice(1), { sort: false }) : {};
+  return search ? parse(search.slice(1)) : {};
 }
 
 export function fromQuery(query: Record<string, any>) {
   const encodedQuery = url.encodeQuery(query, value =>
     encodeURIComponent(value).replace(/%3A/g, ':')
   );
 
-  return stringify(encodedQuery, { sort: false, encode: false });
+  return url.stringifyWithEncoding(encodedQuery);
 }
 
 export type APMQueryParams = {

x-pack/legacy/plugins/beats_management/public/containers/with_url_state.tsx

@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { parse, stringify } from 'query-string';
+import { parse, stringify } from 'querystring';
 import React from 'react';
 import { withRouter, RouteComponentProps } from 'react-router-dom';
 import { FlatObject } from '../frontend_types';
@@ -31,9 +31,7 @@ export class WithURLStateComponent<URLState extends object> extends React.Compon
 > {
   private get URLState(): URLState {
     // slice because parse does not account for the initial ? in the search string
-    return parse(decodeURIComponent(this.props.history.location.search).substring(1), {
-      sort: false,
-    }) as URLState;
+    return parse(decodeURIComponent(this.props.history.location.search).substring(1)) as URLState;
   }
 
   private historyListener: (() => void) | null = null;
@@ -65,13 +63,10 @@ export class WithURLStateComponent<URLState extends object> extends React.Compon
       newState = state;
     }
 
-    const search: string = stringify(
-      {
-        ...pastState,
-        ...newState,
-      },
-      { sort: false }
-    );
+    const search: string = stringify({
+      ...pastState,
+      ...newState,
+    });
 
     const newLocation = {
       ...this.props.history.location,

x-pack/legacy/plugins/canvas/public/lib/app_state.ts

@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { parse } from 'query-string';
+import { parse } from 'querystring';
 import { get } from 'lodash';
 // @ts-ignore untyped local
 import { getInitialState } from '../state/initial_state';
@@ -38,7 +38,7 @@ export function getDefaultAppState(): AppState {
 export function getCurrentAppState(): AppState {
   const history = historyProvider(getWindow());
   const { search } = history.getLocation();
-  const qs = !!search ? parse(search.replace(/^\?/, ''), { sort: false }) : {};
+  const qs = !!search ? parse(search.replace(/^\?/, '')) : {};
   const appState = assignAppState({}, qs);
 
   return appState;

x-pack/legacy/plugins/canvas/public/lib/modify_url.ts

@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { ParsedQuery } from 'query-string';
+import { ParsedUrlQuery } from 'querystring';
 import { format as formatUrl, parse as parseUrl, UrlObject } from 'url';
 
 /**
@@ -20,7 +20,7 @@ export interface URLMeaningfulParts {
   protocol?: string | null;
   slashes?: boolean | null;
   port?: string | null;
-  query: ParsedQuery;
+  query: ParsedUrlQuery;
 }
 
 /**