Stop double-encoding

Author: wylieconlon

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 { ParsedUrlQuery } from 'querystring';
+import { stringify, ParsedUrlQuery } from 'querystring';
 import { transform } from 'lodash';
 
 /**
@@ -55,3 +55,6 @@ export const encodeQuery = (
       );
     }
   });
+
+export const makeUrlFromQuery = (query: ParsedUrlQuery | {}) =>
+  stringify(query, undefined, undefined, { encodeURIComponent: encodeUriQuery });

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

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

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

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { parse, stringify } from 'querystring';
+import { parse } from 'querystring';
 import { History, Location } from 'history';
 import { url } from '../../common';
 
@@ -28,7 +28,7 @@ export function removeQueryParam(history: History, param: string, replace: boole
 
   delete query[param];
 
-  const newSearch = stringify(url.encodeQuery(query));
+  const newSearch = url.makeUrlFromQuery(query);
   const newLocation: Location<any> = {
     ...oldLocation,
     search: newSearch,

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

@@ -18,7 +18,7 @@
  */
 
 import { format as formatUrl } from 'url';
-import { stringify, ParsedUrlQuery } from 'querystring';
+import { ParsedUrlQuery } from 'querystring';
 import { parseUrl, parseUrlHash } from './parse';
 import { url as urlUtils } from '../../../common';
 
@@ -29,7 +29,7 @@ export function replaceUrlHashQuery(
   const url = parseUrl(rawUrl);
   const hash = parseUrlHash(rawUrl);
   const newQuery = queryReplacer(hash?.query || {});
-  const searchQueryString = stringify(urlUtils.encodeQuery(newQuery));
+  const searchQueryString = urlUtils.makeUrlFromQuery(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,7 @@
  */
 
 import { format as formatUrl } from 'url';
-import { stringify } from 'querystring';
+// import { stringify } from 'querystring';
 import { createBrowserHistory, History } from 'history';
 import { decodeState, encodeState } from '../state_encoder';
 import { getCurrentUrl, parseUrl, parseUrlHash } from './parse';
@@ -244,11 +244,11 @@ export function getRelativeToHistoryPath(absoluteUrl: string, history: History):
 
   return formatUrl({
     pathname: stripBasename(parsedUrl.pathname),
-    search: stringify(urlUtils.encodeQuery(parsedUrl.query)),
+    search: urlUtils.makeUrlFromQuery(parsedUrl.query),
     hash: parsedHash
       ? formatUrl({
           pathname: parsedHash.pathname,
-          search: stringify(urlUtils.encodeQuery(parsedHash.query)),
+          search: urlUtils.makeUrlFromQuery(parsedHash.query),
         })
       : parsedUrl.hash,
   });

x-pack/plugins/infra/public/utils/use_url_state.ts

@@ -115,12 +115,10 @@ export const replaceStateKeyInQueryString = <UrlState extends any>(
   const encodedUrlState =
     typeof urlState !== 'undefined' ? encodeRisonUrlState(urlState) : undefined;
 
-  return stringify(
-    url.encodeQuery({
-      ...previousQueryValues,
-      [stateKey]: encodedUrlState,
-    })
-  );
+  return url.makeUrlFromQuery({
+    ...previousQueryValues,
+    [stateKey]: encodedUrlState,
+  });
 };
 
 const replaceQueryStringInLocation = (location: Location, queryString: string): Location => {