Merge pull request #765 from AndriiNyzhnyk/remove_deprecated_components

hapi-swagger · Jun 11, 2022 · 6427bc7 · 6427bc7
2 parents 19c91af + ea35827
commit 6427bc7
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 27 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -2,8 +2,6 @@ const Hoek = require('@hapi/hoek');
 const Joi = require('joi');
 const Path = require('path');
 const { join, sep } = require('path');
-const Querystring = require('querystring');
-const Url = require('url');
 const swaggerUiAssetPath = require('swagger-ui-dist').getAbsoluteFSPath();
 
 const Pack = require('../package.json');
@@ -330,11 +328,9 @@ const appendDataContext = function (plugin, settings) {
       /* $lab:coverage:on$ */
 
       // append tags from document request to JSON request
-      if (request.query.tags) {
-        settings.jsonPath = appendQueryString(settings.jsonPath, 'tags', request.query.tags);
-      } else {
-        settings.jsonPath = appendQueryString(settings.jsonPath, null, null);
-      }
+      settings.jsonPath = request.query.tags
+        ? Utilities.appendQueryString(settings.jsonPath, 'tags', request.query.tags)
+        : Utilities.appendQueryString(settings.jsonPath);
 
       const prefixedSettings = Hoek.clone(settings);
       if (routePrefix) {
@@ -359,26 +355,6 @@ const appendDataContext = function (plugin, settings) {
   });
 };
 
-/**
- * appends a querystring to a url path - will overwrite existing values
- *
- * @param  {string} url
- * @param  {string} qsName
- * @param  {string} qsValue
- * @return {string}
- */
-const appendQueryString = function (url, qsName, qsValue) {
-  const urlObj = Url.parse(url);
-  if (qsName && qsValue) {
-    urlObj.query = Querystring.parse(qsName + '=' + qsValue);
-    urlObj.search = '?' + encodeURIComponent(qsName) + '=' + encodeURIComponent(qsValue);
-  } else {
-    urlObj.search = '';
-  }
-
-  return urlObj.format(urlObj);
-};
-
 /**
  * finds any keyPrefix in securityDefinitions - also add x- to name
  *

diff --git a/lib/utilities.js b/lib/utilities.js
@@ -478,3 +478,21 @@ utilities.assignVendorExtensions = function(target, source) {
 
   return target;
 };
+
+/**
+ * appends a querystring to an url
+ *
+ * @param  {string} url
+ * @param  {string} qsName
+ * @param  {string} qsValue
+ * @return {string}
+ */
+utilities.appendQueryString = function (url, qsName, qsValue) {
+   if (!qsName || !qsValue) {
+     return url;
+   }
+
+  const query = new URLSearchParams({[qsName]: qsValue});
+
+  return `${url}?${query.toString()}`;
+};
diff --git a/test/unit/utilities-test.js b/test/unit/utilities-test.js
@@ -308,4 +308,11 @@ lab.experiment('utilities', () => {
     });
     expect(Utilities.assignVendorExtensions({ a: 1, b: 2 }, { 'x-': 1 })).to.equal({ a: 1, b: 2 });
   });
+
+
+  lab.test('appendQueryString', () => {
+    expect(Utilities.appendQueryString('/test.json', 'tags', 'reduced')).to.equal('/test.json?tags=reduced');
+    expect(Utilities.appendQueryString('/test/test', 'tags', 'reduced')).to.equal('/test/test?tags=reduced');
+    expect(Utilities.appendQueryString('/swagger.json')).to.equal('/swagger.json');
+  });
 });