From: Tom Hughes <tom@compton.nu>
Date: Mon, 15 Jul 2019 19:27:42 +0000 (+0100)
Subject: Stop creating a shared global querystring variable
X-Git-Tag: live~3084
X-Git-Url: https://git.openstreetmap.org./rails.git/commitdiff_plain/6dd451c7ee48663d6b0753bfe8b4da2060c4cf60?ds=sidebyside

Stop creating a shared global querystring variable
---

diff --git a/app/assets/javascripts/application.js b/app/assets/javascripts/application.js
index 7c2e4665e..fbc76e4a8 100644
--- a/app/assets/javascripts/application.js
+++ b/app/assets/javascripts/application.js
@@ -17,16 +17,15 @@
 //= require richtext
 //= require querystring
 
-var qs = require("querystring-component");
-
 /*
  * Called as the user scrolls/zooms around to maniplate hrefs of the
  * view tab and various other links
  */
 window.updateLinks = function (loc, zoom, layers, object) {
   $(".geolink").each(function (index, link) {
-    var href = link.href.split(/[?#]/)[0],
-        args = qs.parse(link.search.substring(1)),
+    var querystring = require("querystring-component"),
+        href = link.href.split(/[?#]/)[0],
+        args = querystring.parse(link.search.substring(1)),
         editlink = $(link).hasClass("editlink");
 
     delete args.node;
@@ -38,7 +37,7 @@ window.updateLinks = function (loc, zoom, layers, object) {
       args[object.type] = object.id;
     }
 
-    var query = qs.stringify(args);
+    var query = querystring.stringify(args);
     if (query) href += "?" + query;
 
     args = {
diff --git a/app/assets/javascripts/edit/id.js.erb b/app/assets/javascripts/edit/id.js.erb
index 933031d8c..23726519e 100644
--- a/app/assets/javascripts/edit/id.js.erb
+++ b/app/assets/javascripts/edit/id.js.erb
@@ -1,4 +1,7 @@
+//= require querystring
+
 $(document).ready(function () {
+  var querystring = require("querystring-component");
   var id = $("#id-embed");
 
   if (id.data("key")) {
@@ -36,7 +39,7 @@ $(document).ready(function () {
       params.gpx = hashParams.gpx;
     }
 
-    id.attr("src", id.data("url") + "#" + qs.stringify(params));
+    id.attr("src", id.data("url") + "#" + querystring.stringify(params));
   } else {
     alert(I18n.t("site.edit.id_not_configured"));
   }
diff --git a/app/assets/javascripts/index.js b/app/assets/javascripts/index.js
index d15ee5859..2c7d70e11 100644
--- a/app/assets/javascripts/index.js
+++ b/app/assets/javascripts/index.js
@@ -21,8 +21,11 @@
 //= require index/query
 //= require router
 //= require bowser
+//= require querystring
 
 $(document).ready(function () {
+  var querystring = require("querystring-component");
+
   var loaderTimeout;
 
   var map = new L.OSM.Map("map", {
@@ -264,7 +267,7 @@ $(document).ready(function () {
     var iframe = $("<iframe>")
       .hide()
       .appendTo("body")
-      .attr("src", url + qs.stringify(query))
+      .attr("src", url + querystring.stringify(query))
       .on("load", function () {
         $(this).remove();
         loaded = true;
@@ -309,7 +312,7 @@ $(document).ready(function () {
     };
 
     page.load = function () {
-      var params = qs.parse(location.search.substring(1));
+      var params = querystring.parse(location.search.substring(1));
       if (params.query) {
         $("#sidebar .search_form input[name=query]").value(params.query);
       }
diff --git a/app/assets/javascripts/index/contextmenu.js b/app/assets/javascripts/index/contextmenu.js
index 1adfa2c24..fdde8dec4 100644
--- a/app/assets/javascripts/index/contextmenu.js
+++ b/app/assets/javascripts/index/contextmenu.js
@@ -1,4 +1,8 @@
+//= require querystring
+
 OSM.initializeContextMenu = function (map) {
+  var querystring = require("querystring-component");
+
   map.contextmenu.addItem({
     text: I18n.t("javascripts.context.directions_from"),
     callback: function directionsFromHere(e) {
@@ -7,7 +11,7 @@ OSM.initializeContextMenu = function (map) {
           lat = latlng.lat.toFixed(precision),
           lng = latlng.lng.toFixed(precision);
 
-      OSM.router.route("/directions?" + qs.stringify({
+      OSM.router.route("/directions?" + querystring.stringify({
         from: lat + "," + lng,
         to: $("#route_to").val()
       }));
@@ -22,7 +26,7 @@ OSM.initializeContextMenu = function (map) {
           lat = latlng.lat.toFixed(precision),
           lng = latlng.lng.toFixed(precision);
 
-      OSM.router.route("/directions?" + qs.stringify({
+      OSM.router.route("/directions?" + querystring.stringify({
         from: $("#route_from").val(),
         to: lat + "," + lng
       }));
diff --git a/app/assets/javascripts/index/directions.js b/app/assets/javascripts/index/directions.js
index 71eedaa83..4f79ca471 100644
--- a/app/assets/javascripts/index/directions.js
+++ b/app/assets/javascripts/index/directions.js
@@ -1,7 +1,10 @@
 //= require_self
 //= require_tree ./directions
+//= require querystring
 
 OSM.Directions = function (map) {
+  var querystring = require("querystring-component");
+
   var awaitingGeocode; // true if the user has requested a route, but we're waiting on a geocode result
   var awaitingRoute; // true if we've asked the engine for a route and are waiting to hear back
   var chosenEngine;
@@ -139,7 +142,7 @@ OSM.Directions = function (map) {
     var from = endpoints[0].latlng,
         to = endpoints[1].latlng;
 
-    OSM.router.route("/directions?" + qs.stringify({
+    OSM.router.route("/directions?" + querystring.stringify({
       from: $("#route_to").val(),
       to: $("#route_from").val(),
       route: to.lat + "," + to.lng + ";" + from.lat + "," + from.lng
@@ -210,7 +213,7 @@ OSM.Directions = function (map) {
 
     var precision = OSM.zoomPrecision(map.getZoom());
 
-    OSM.router.replace("/directions?" + qs.stringify({
+    OSM.router.replace("/directions?" + querystring.stringify({
       engine: chosenEngine.id,
       route: o.lat.toFixed(precision) + "," + o.lng.toFixed(precision) + ";" +
              d.lat.toFixed(precision) + "," + d.lng.toFixed(precision)
@@ -367,7 +370,7 @@ OSM.Directions = function (map) {
       getRoute(true, true);
     });
 
-    var params = qs.parse(location.search.substring(1)),
+    var params = querystring.parse(location.search.substring(1)),
         route = (params.route || "").split(";"),
         from = route[0] && L.latLng(route[0].split(",")),
         to = route[1] && L.latLng(route[1].split(","));
diff --git a/app/assets/javascripts/index/new_note.js b/app/assets/javascripts/index/new_note.js
index 9bcaf2505..9d68ab65c 100644
--- a/app/assets/javascripts/index/new_note.js
+++ b/app/assets/javascripts/index/new_note.js
@@ -1,4 +1,8 @@
+//= require querystring
+
 OSM.NewNote = function (map) {
+  var querystring = require("querystring-component");
+
   var noteLayer = map.noteLayer,
       content = $("#sidebar_content"),
       page = {},
@@ -107,7 +111,7 @@ OSM.NewNote = function (map) {
 
     map.addLayer(noteLayer);
 
-    var params = qs.parse(path.substring(path.indexOf("?") + 1));
+    var params = querystring.parse(path.substring(path.indexOf("?") + 1));
     var markerLatlng;
 
     if (params.lat && params.lon) {
diff --git a/app/assets/javascripts/index/query.js b/app/assets/javascripts/index/query.js
index cb76a3446..49d162b1f 100644
--- a/app/assets/javascripts/index/query.js
+++ b/app/assets/javascripts/index/query.js
@@ -1,6 +1,9 @@
 //= require jquery.simulate
+//= require querystring
 
 OSM.Query = function (map) {
+  var querystring = require("querystring-component");
+
   var url = OSM.OVERPASS_URL,
       queryButton = $(".control-query .control-button"),
       uninterestingTags = ["source", "source_ref", "source:ref", "history", "attribution", "created_by", "tiger:county", "tiger:tlid", "tiger:upload_uuid", "KSJ2:curve_id", "KSJ2:lat", "KSJ2:lon", "KSJ2:coordinate", "KSJ2:filename", "note:ja"],
@@ -342,7 +345,7 @@ OSM.Query = function (map) {
   };
 
   page.load = function (path, noCentre) {
-    var params = qs.parse(path.substring(path.indexOf("?") + 1)),
+    var params = querystring.parse(path.substring(path.indexOf("?") + 1)),
         latlng = L.latLng(params.lat, params.lon);
 
     if (!window.location.hash && !noCentre && !map.getBounds().contains(latlng)) {
diff --git a/app/assets/javascripts/index/search.js b/app/assets/javascripts/index/search.js
index cfdcdf64f..ba66f4782 100644
--- a/app/assets/javascripts/index/search.js
+++ b/app/assets/javascripts/index/search.js
@@ -1,6 +1,9 @@
 //= require jquery.simulate
+//= require querystring
 
 OSM.Search = function (map) {
+  var querystring = require("querystring-component");
+
   $(".search_form input[name=query]").on("input", function (e) {
     if ($(e.target).val() === "") {
       $(".describe_location").fadeIn(100);
@@ -120,7 +123,7 @@ OSM.Search = function (map) {
   var page = {};
 
   page.pushstate = page.popstate = function (path) {
-    var params = qs.parse(path.substring(path.indexOf("?") + 1));
+    var params = querystring.parse(path.substring(path.indexOf("?") + 1));
     $(".search_form input[name=query]").val(params.query);
     $(".describe_location").hide();
     OSM.loadSidebarContent(path, page.load);
diff --git a/app/assets/javascripts/leaflet.map.js b/app/assets/javascripts/leaflet.map.js
index 5bd53e8f3..797a57e20 100644
--- a/app/assets/javascripts/leaflet.map.js
+++ b/app/assets/javascripts/leaflet.map.js
@@ -1,3 +1,5 @@
+//= require querystring
+
 L.extend(L.LatLngBounds.prototype, {
   getSize: function () {
     return (this._northEast.lat - this._southWest.lat) *
@@ -114,8 +116,9 @@ L.OSM.Map = L.Map.extend({
       params.mlon = latLng.lng.toFixed(precision);
     }
 
-    var url = window.location.protocol + "//" + OSM.SERVER_URL + "/",
-        query = qs.stringify(params),
+    var querystring = require("querystring-component"),
+        url = window.location.protocol + "//" + OSM.SERVER_URL + "/",
+        query = querystring.stringify(params),
         hash = OSM.formatHash(this);
 
     if (query) url += "?" + query;
@@ -180,7 +183,8 @@ L.OSM.Map = L.Map.extend({
       params[this._object.type] = this._object.id;
     }
 
-    var query = qs.stringify(params);
+    var querystring = require("querystring-component"),
+        query = querystring.stringify(params);
     if (query) {
       str += "?" + query;
     }
diff --git a/app/assets/javascripts/login.js b/app/assets/javascripts/login.js
index c997e538b..74b226bf6 100644
--- a/app/assets/javascripts/login.js
+++ b/app/assets/javascripts/login.js
@@ -1,4 +1,8 @@
+//= querystring
+
 $(document).ready(function () {
+  var querystring = require("querystring-component");
+
   // Preserve location hash in referer
   if (window.location.hash) {
     $("#referer").val($("#referer").val() + window.location.hash);
@@ -6,9 +10,9 @@ $(document).ready(function () {
 
   // Attach referer to authentication buttons
   $(".auth_button").each(function () {
-    var params = qs.parse(this.search.substring(1));
+    var params = querystring.parse(this.search.substring(1));
     params.referer = $("#referer").val();
-    this.search = qs.stringify(params);
+    this.search = querystring.stringify(params);
   });
 
   // Add click handler to show OpenID field
@@ -33,7 +37,7 @@ $(document).ready(function () {
     if (referer) {
       args.referer = referer;
     }
-    window.location = action + "?" + qs.stringify(args);
+    window.location = action + "?" + querystring.stringify(args);
     return false;
   });
 });
diff --git a/app/assets/javascripts/osm.js.erb b/app/assets/javascripts/osm.js.erb
index 09b3ebd75..391ba64ef 100644
--- a/app/assets/javascripts/osm.js.erb
+++ b/app/assets/javascripts/osm.js.erb
@@ -1,5 +1,6 @@
 //= depend_on settings.yml
 //= depend_on settings.local.yml
+//= require querystring
 
 OSM = {
 <% if defined?(PIWIK) %>
@@ -138,14 +139,15 @@ OSM = {
   },
 
   parseHash: function(hash) {
-    var args = {};
+    var querystring = require("querystring-component"),
+        args = {};
 
     var i = hash.indexOf('#');
     if (i < 0) {
       return args;
     }
 
-    hash = qs.parse(hash.substr(i + 1));
+    hash = querystring.parse(hash.substr(i + 1));
 
     var map = (hash.map || '').split('/'),
       zoom = parseInt(map[0], 10),
diff --git a/config/eslint.json b/config/eslint.json
index 2e9567a4e..cd235e678 100644
--- a/config/eslint.json
+++ b/config/eslint.json
@@ -12,7 +12,6 @@
     "L": "readonly",
     "OSM": "writable",
     "Piwik": "readonly",
-    "querystring": "readonly",
     "require": "readonly",
     "updateLinks": "readonly"
   },