Fix an issue where "spot providers enabled by default" was still being fetched through WEB_UI_OPTIONS on a path that required spot providers to have a "name" field in *config* rather than at runtime. Closes #124

alertproviders/alert_provider.py

@@ -12,7 +12,7 @@ class AlertProvider:
         """Constructor"""
 
         self.name = name
-        self.enabled = provider_config["enabled"]
+        self.enabled = provider_config.get("enabled", True)
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"
         self._alerts = None

core/config.py

@@ -24,12 +24,3 @@ WEB_UI_OPTIONS = config["web-ui-options"]
 API_ONLY_MODE = config.get("api-only-mode", False)
 LOG_LEVEL = config.get("log-level", "INFO")
 LOG_WEB_REQUESTS = config.get("log-web-requests", False)
-
-# For ease of config, each spot provider owns its own config about whether it should be enabled by default in the web UI
-# but for consistency we provide this to the front-end in web-ui-options because it has no impact outside of the web UI.
-WEB_UI_OPTIONS["spot-providers-enabled-by-default"] = [p["name"] for p in config["spot-providers"] if p["enabled"] and (
-        "enabled-by-default-in-web-ui" not in p or p["enabled-by-default-in-web-ui"])]
-# If spotting to this server is enabled, "API" is another valid spot source even though it does not come from
-# one of our proviers. We set that to also be enabled by default.
-if ALLOW_SPOTTING:
-    WEB_UI_OPTIONS["spot-providers-enabled-by-default"].append("API")

core/status_reporter.py

@@ -60,7 +60,8 @@ class StatusReporter:
         self._status_data["num_spots"] = len(self._spots)
         self._status_data["num_alerts"] = len(self._alerts)
         self._status_data["spot_providers"] = list(
-            map(lambda p: {"name": p.name, "enabled": p.enabled, "status": p.status,
+            map(lambda p: {"name": p.name, "enabled": p.enabled,
+                           "enabled_by_default_in_web_ui": p.enabled_by_default_in_web_ui, "status": p.status,
                            "last_updated": p.last_update_time.replace(
                                tzinfo=pytz.UTC).timestamp() if p.last_update_time.year > 2000 else 0,
                            "last_spot": p.last_spot_time.replace(

server/handlers/api/options.py

@@ -39,9 +39,14 @@ class APIOptionsHandler(tornado.web.RequestHandler):
                        "sigs": SIGS,
                        # Spot/alert sources are filtered for only ones that are enabled in config, no point letting the user toggle things that aren't even available.
                        "spot_sources": list(
-                           map(lambda p: p["name"], filter(lambda p: p["enabled"], self._status_data["spot_providers"]))),
+                           map(lambda p: p["name"],
+                               filter(lambda p: p["enabled"], self._status_data["spot_providers"]))),
+                       "spot-providers-enabled-by-default": list(
+                           map(lambda p: p["name"], filter(lambda p: p["enabled"] and p["enabled_by_default_in_web_ui"],
+                                                           self._status_data["spot_providers"]))),
                        "alert_sources": list(
-                           map(lambda p: p["name"], filter(lambda p: p["enabled"], self._status_data["alert_providers"]))),
+                           map(lambda p: p["name"],
+                               filter(lambda p: p["enabled"], self._status_data["alert_providers"]))),
                        "continents": CONTINENTS,
                        "propagation_modes": list(PROPAGATION_MODES.values()),
                        "max_spot_age": MAX_SPOT_AGE,
@@ -50,6 +55,7 @@ class APIOptionsHandler(tornado.web.RequestHandler):
             # one of our proviers.
             if ALLOW_SPOTTING:
                 options["spot_sources"].append("API")
+                options["spot-providers-enabled-by-default"].append("API")
 
             self.write(safe_json_dumps(options))
             self.set_status(200)

solarconditionsproviders/solar_conditions_provider.py

@@ -12,7 +12,7 @@ class SolarConditionsProvider:
 
         self._solar_conditions_cache = None
         self.name = name
-        self.enabled = provider_config["enabled"]
+        self.enabled = provider_config.get("enabled", True)
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"
         self._solar_conditions = None

spotproviders/spot_provider.py

@@ -12,7 +12,8 @@ class SpotProvider:
         """Constructor"""
 
         self.name = name
-        self.enabled = provider_config["enabled"]
+        self.enabled = provider_config.get("enabled", True)
+        self.enabled_by_default_in_web_ui = provider_config.get("enabled-by-default-in-web-ui", True)
         self.last_update_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.last_spot_time = datetime.min.replace(tzinfo=pytz.UTC)
         self.status = "Not Started" if self.enabled else "Disabled"

static/js/bands.js

@@ -291,7 +291,7 @@ function loadOptions() {
         generateMultiToggleFilterCard("#dx-continent-options", "dx_continent", options["continents"]);
         generateMultiToggleFilterCard("#de-continent-options", "de_continent", options["continents"]);
         generateModesMultiToggleFilterCard(options["modes"]);
-        generateSourcesMultiToggleFilterCard(options["spot_sources"], spotProvidersEnabledByDefault);
+        generateSourcesMultiToggleFilterCard(options["spot_sources"], options["spot-providers-enabled-by-default"]);
 
         // Load URL params. These may select things from the various filter & display options, so the function needs
         // to be called after these are set up, but if the URL params ask for "embedded mode", this will suppress

static/js/map.js

@@ -322,7 +322,7 @@ function loadOptions() {
         generateMultiToggleFilterCard("#dx-continent-options", "dx_continent", options["continents"]);
         generateMultiToggleFilterCard("#de-continent-options", "de_continent", options["continents"]);
         generateModesMultiToggleFilterCard(options["modes"]);
-        generateSourcesMultiToggleFilterCard(options["spot_sources"], spotProvidersEnabledByDefault);
+        generateSourcesMultiToggleFilterCard(options["spot_sources"], options["spot-providers-enabled-by-default"]);
 
         // Load URL params. These may select things from the various filter & display options, so the function needs
         // to be called after these are set up, but if the URL params ask for "embedded mode", this will suppress

static/js/spots.js

@@ -436,7 +436,7 @@ function loadOptions() {
         generateMultiToggleFilterCard("#dx-continent-options", "dx_continent", options["continents"]);
         generateMultiToggleFilterCard("#de-continent-options", "de_continent", options["continents"]);
         generateModesMultiToggleFilterCard(options["modes"]);
-        generateSourcesMultiToggleFilterCard(options["spot_sources"], spotProvidersEnabledByDefault);
+        generateSourcesMultiToggleFilterCard(options["spot_sources"], options["spot-providers-enabled-by-default"]);
 
         // Load URL params. These may select things from the various filter & display options, so the function needs
         // to be called after these are set up, but if the URL params ask for "embedded mode", this will suppress

templates/add_spot.html

@@ -76,7 +76,7 @@
 
 </div>
 
-<script src="/static/js/add-spot.js?v=1786175023"></script>
+<script src="/static/js/add-spot.js?v=1786338394"></script>
 <script>$(document).ready(function () {
     $("#nav-link-add-spot").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/alerts.html

@@ -75,7 +75,7 @@
 
 </div>
 
-<script src="/static/js/alerts.js?v=1786175024"></script>
+<script src="/static/js/alerts.js?v=1786338394"></script>
 <script>$(document).ready(function () {
     $("#nav-link-alerts").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/bands.html

@@ -72,11 +72,8 @@
 
 </div>
 
-<script>
+<script src="/static/js/spotsbandsandmap.js?v=1786338394"></script>
-    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
+<script src="/static/js/bands.js?v=1786338394"></script>
-</script>
-<script src="/static/js/spotsbandsandmap.js?v=1786175023"></script>
-<script src="/static/js/bands.js?v=1786175023"></script>
 <script>$(document).ready(function () {
     $("#nav-link-bands").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/base.html

@@ -1,6 +1,6 @@
 {% extends "skeleton.html" %}
 {% block head_extra %}
-<link rel="stylesheet" href="/static/css/style.css?v=1786175023" type="text/css">
+<link rel="stylesheet" href="/static/css/style.css?v=1786338394" type="text/css">
 <link href="/static/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
 <link href="/static/vendor/css/fontawesome-6.7.2.min.css" rel="stylesheet">
 <link href="/static/vendor/css/solid-6.7.2.min.css" rel="stylesheet">
@@ -10,10 +10,10 @@
 <script src="/static/vendor/js/bootstrap-5.3.8.bundle.min.js"></script>
 <script src="/static/vendor/js/tinycolor2-1.6.0.min.js"></script>
 
-<script src="/static/js/utils.js?v=1786175023"></script>
+<script src="/static/js/utils.js?v=1786338394"></script>
-<script src="/static/js/ui-ham.js?v=1786175023"></script>
+<script src="/static/js/ui-ham.js?v=1786338394"></script>
-<script src="/static/js/geo.js?v=1786175023"></script>
+<script src="/static/js/geo.js?v=1786338394"></script>
-<script src="/static/js/common.js?v=1786175023"></script>
+<script src="/static/js/common.js?v=1786338394"></script>
 {% end %}
 {% block body %}
 <div class="container">

templates/conditions.html

@@ -284,7 +284,7 @@
 </div>
 
 <script src="/static/vendor/js/chart-4.4.9.umd.min.js"></script>
-<script src="/static/js/conditions.js?v=1786175023"></script>
+<script src="/static/js/conditions.js?v=1786338394"></script>
 <script>$(document).ready(function () {
     $("#nav-link-conditions").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/map.html

@@ -105,11 +105,8 @@
 <script src="/static/vendor/js/leaflet-cqzones.js"></script>
 <script src="/static/vendor/js/leaflet-workedallbritainireland.js" type="module"></script>
 
-<script>
+<script src="/static/js/spotsbandsandmap.js?v=1786338394"></script>
-    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
+<script src="/static/js/map.js?v=1786338394"></script>
-</script>
-<script src="/static/js/spotsbandsandmap.js?v=1786175024"></script>
-<script src="/static/js/map.js?v=1786175024"></script>
 <script>$(document).ready(function () {
     $("#nav-link-map").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/spots.html

@@ -113,11 +113,8 @@
 
 </div>
 
-<script>
+<script src="/static/js/spotsbandsandmap.js?v=1786338394"></script>
-    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
+<script src="/static/js/spots.js?v=1786338394"></script>
-</script>
-<script src="/static/js/spotsbandsandmap.js?v=1786175023"></script>
-<script src="/static/js/spots.js?v=1786175023"></script>
 <script>$(document).ready(function () {
     $("#nav-link-spots").addClass("active");
 }); <!-- highlight active page in nav --></script>

templates/status.html

@@ -59,7 +59,7 @@
     </div>
 </div>
 
-<script src="/static/js/status.js?v=1786175023"></script>
+<script src="/static/js/status.js?v=1786338394"></script>
 <script>
     $(document).ready(function () {
         $("#nav-link-status").addClass("active");