- <%= f.label :mapbox_access_token %>
- <%= f.text_field :mapbox_access_token %>
+ <% unless Map.offline? %>
+
+
+
-
<% end %>
@@ -171,84 +189,104 @@ const pitchValue = themeForm.querySelector("#pitchValue");
const bearingInput = themeForm.querySelector("#theme_bearing");
const bearingValue = themeForm.querySelector("#bearingValue");
-const themeMap = new mapboxgl.Map({
- accessToken: "<%= @theme.mapbox_token %>",
- container: "themeMap", // container ID
- center: <%= [@theme.center_long, @theme.center_lat] %>, // starting position [lng, lat]
- zoom: <%= @theme.zoom || 0 %>, // starting zoom
- pitch: <%= @theme.pitch || 0 %>, // starting pitch
- bearing: <%= @theme.bearing || 0 %>, // starting bearing
- style: "<%= @theme.mapbox_style %>", // style URL or style object
- projection: "<%= @theme.map_projection %>",
- hash: false,
- cooperativeGestures: true
-});
-
-themeMap.on("moveend", (e) => {
- let themeForm = document.querySelector("#themeForm");
- let { lng, lat } = e.target.getCenter();
- themeCenterLongInput.value = lng.toFixed(5);
- themeCenterLatInput.value = lat.toFixed(5);
-
- if (!themeForm.querySelector("input#unrestricted_bounds").checked) {
- let { _ne, _sw } = themeMap.getBounds();
- themeForm.querySelector("input#theme_ne_boundary_long").value = _ne.lng.toFixed(5);
- themeForm.querySelector("input#theme_ne_boundary_lat").value = _ne.lat.toFixed(5);
- themeForm.querySelector("input#theme_sw_boundary_long").value = _sw.lng.toFixed(5);
- themeForm.querySelector("input#theme_sw_boundary_lat").value = _sw.lat.toFixed(5);
- }
+Terrastories.map_utils.mapgl(<%= @theme.use_maplibre? %>).then((lib) => {
+ const themeMap = Terrastories.map_utils.interactiveMap(
+ lib,
+ {
+ accessToken: "<%= @theme.mapbox_token %>",
+ container: "themeMap", // container ID
+ center: <%= [@theme.center_long, @theme.center_lat] %>, // starting position [lng, lat]
+ zoom: <%= @theme.zoom || 0 %>, // starting zoom
+ pitch: <%= @theme.pitch || 0 %>, // starting pitch
+ bearing: <%= @theme.bearing || 0 %>, // starting bearing
+ style: "<%= @theme.map_style_url %>", // style URL or style object
+ projection: "<%= @theme.map_projection %>",
+ hash: false,
+ cooperativeGestures: true,
+ basemapStyle: "<%= @theme.basemap_style %>",
+ }
+ );
+
+ const marker = new lib.Marker({draggable: true, color: "<%= t("protomaps_basemap_markers.#{@theme.basemap_style}") %>"}).setLngLat(<%= [@theme.center_long, @theme.center_lat] %>)
+
+ themeMap.on("load", () => {
+ marker.addTo(themeMap)
+ })
+
+ marker.on("dragend", (e) => {
+ const { lng, lat } = marker.getLngLat()
+
+ themeMap.setCenter([lng, lat])
+ })
+
+ themeMap.on("moveend", (e) => {
+ let themeForm = document.querySelector("#themeForm");
+ let { lng, lat } = e.target.getCenter();
+
+ marker.setLngLat({ lng, lat })
+
+ themeCenterLongInput.value = lng.toFixed(5);
+ themeCenterLatInput.value = lat.toFixed(5);
+
+ if (!themeForm.querySelector("input#unrestricted_bounds").checked) {
+ let { _ne, _sw } = themeMap.getBounds();
+ themeForm.querySelector("input#theme_ne_boundary_long").value = _ne.lng.toFixed(5);
+ themeForm.querySelector("input#theme_ne_boundary_lat").value = _ne.lat.toFixed(5);
+ themeForm.querySelector("input#theme_sw_boundary_long").value = _sw.lng.toFixed(5);
+ themeForm.querySelector("input#theme_sw_boundary_lat").value = _sw.lat.toFixed(5);
+ }
+ });
+
+ themeMap.on("zoomend", (e) => {
+ zoomValue.innerHTML = e.target.getZoom().toPrecision(5);
+ zoomInput.value = e.target.getZoom();
+ });
+
+ themeMap.on("pitchend", (e) => {
+ pitchValue.innerHTML = e.target.getPitch().toPrecision(5);
+ pitchInput.value = e.target.getPitch();
+ bearingValue.innerHTML = e.target.getBearing().toPrecision(5);
+ bearingInput.value = e.target.getBearing();
+ });
+
+ const nav = new lib.NavigationControl({
+ visualizePitch: true
+ });
+ themeMap.addControl(nav, "top-right");
+
+ themeForm.querySelector("input#unrestricted_bounds").addEventListener("click", (e) => {
+ themeForm.querySelector(".unrestricted_bounds").classList.toggle("hidden", e.target.checked)
+ if (e.target.checked) {
+ themeForm.querySelectorAll(".unrestricted_bounds input").forEach((item)=>{item.removeAttribute("value")})
+ } else {
+ var { _ne, _sw } = themeMap.getBounds();
+ themeForm.querySelector("input#theme_ne_boundary_long").value = _ne.lng.toFixed(5);
+ themeForm.querySelector("input#theme_ne_boundary_lat").value = _ne.lat.toFixed(5);
+ themeForm.querySelector("input#theme_sw_boundary_long").value = _sw.lng.toFixed(5);
+ themeForm.querySelector("input#theme_sw_boundary_lat").value = _sw.lat.toFixed(5);
+ }
+ })
+
+ themeCenterLongInput.addEventListener("change", (e) => {
+ let { lat } = themeMap.getCenter();
+ themeMap.setCenter({lng: e.target.value, lat: lat});
+ });
+ themeCenterLatInput.addEventListener("change", (e) => {
+ let { lng } = themeMap.getCenter();
+ themeMap.setCenter({lng: lng, lat: e.target.value});
+ });
+
+ zoomInput.addEventListener("input", (e) => {
+ zoomValue.innerHTML = e.target.value;
+ themeMap.setZoom(e.target.value);
+ });
+ pitchInput.addEventListener("input", (e) => {
+ pitchValue.innerHTML = e.target.value;
+ themeMap.setPitch(e.target.value);
+ });
+ bearingInput.addEventListener("input", (e) => {
+ bearingValue.innerHTML = e.target.value;
+ themeMap.setBearing(e.target.value);
+ });
});
-
-themeMap.on("zoomend", (e) => {
- zoomValue.innerHTML = e.target.getZoom().toPrecision(5);
- zoomInput.value = e.target.getZoom();
-});
-
-themeMap.on("pitchend", (e) => {
- pitchValue.innerHTML = e.target.getPitch().toPrecision(5);
- pitchInput.value = e.target.getPitch();
- bearingValue.innerHTML = e.target.getBearing().toPrecision(5);
- bearingInput.value = e.target.getBearing();
-});
-
-const nav = new mapboxgl.NavigationControl({
- visualizePitch: true
-});
-themeMap.addControl(nav, "top-right");
-
-themeForm.querySelector("input#unrestricted_bounds").addEventListener("click", (e) => {
- themeForm.querySelector(".unrestricted_bounds").classList.toggle("hidden", e.target.checked)
- if (e.target.checked) {
- themeForm.querySelectorAll(".unrestricted_bounds input").forEach((item)=>{item.removeAttribute("value")})
- } else {
- var { _ne, _sw } = themeMap.getBounds();
- themeForm.querySelector("input#theme_ne_boundary_long").value = _ne.lng.toFixed(5);
- themeForm.querySelector("input#theme_ne_boundary_lat").value = _ne.lat.toFixed(5);
- themeForm.querySelector("input#theme_sw_boundary_long").value = _sw.lng.toFixed(5);
- themeForm.querySelector("input#theme_sw_boundary_lat").value = _sw.lat.toFixed(5);
- }
-})
-
-themeCenterLongInput.addEventListener("change", (e) => {
- let { lat } = themeMap.getCenter();
- themeMap.setCenter({lng: e.target.value, lat: lat});
-});
-themeCenterLatInput.addEventListener("change", (e) => {
- let { lng } = themeMap.getCenter();
- themeMap.setCenter({lng: lng, lat: e.target.value});
-});
-
-zoomInput.addEventListener("input", (e) => {
- zoomValue.innerHTML = e.target.value;
- themeMap.setZoom(e.target.value);
-});
-pitchInput.addEventListener("input", (e) => {
- pitchValue.innerHTML = e.target.value;
- themeMap.setPitch(e.target.value);
-});
-bearingInput.addEventListener("input", (e) => {
- bearingValue.innerHTML = e.target.value;
- themeMap.setBearing(e.target.value);
-});
-
-
\ No newline at end of file
+
diff --git a/rails/app/views/home/_home.json.jbuilder b/rails/app/views/home/_home.json.jbuilder
index 7db4d3e0d..e1f761d5f 100644
--- a/rails/app/views/home/_home.json.jbuilder
+++ b/rails/app/views/home/_home.json.jbuilder
@@ -30,10 +30,11 @@ end
json.logo_path image_path("logocombo.svg")
json.mapbox_access_token @community.theme.mapbox_token
-json.mapbox_style @community.theme.mapbox_style
+json.map_style @community.theme.map_style_url
+json.basemap_style @community.theme.basemap_style
json.mapbox_3d @community.theme.mapbox_3d
json.map_projection @community.theme.map_projection
-json.use_local_map_server @community.theme.offline_mode?
+json.use_local_map_server @community.theme.use_maplibre?
json.center_lat @community.theme.center_lat
json.center_long @community.theme.center_long
json.sw_boundary_lat @community.theme.sw_boundary_lat
diff --git a/rails/app/views/layouts/dashboard.html.erb b/rails/app/views/layouts/dashboard.html.erb
index 281aae014..0c49bc08a 100644
--- a/rails/app/views/layouts/dashboard.html.erb
+++ b/rails/app/views/layouts/dashboard.html.erb
@@ -9,6 +9,9 @@
<%= yield (:title) %> - Terrastories
<%= csrf_meta_tags %>
+
+ <%= javascript_pack_tag 'map_utils', 'data-turbolinks-track': 'reload', defer: false %>
+
<%= stylesheet_link_tag 'dashboard', media: 'all' %>
<%= javascript_include_tag 'dashboard', media: 'all' %>
diff --git a/rails/config/initializers/tileserver.rb b/rails/config/initializers/tileserver.rb
deleted file mode 100644
index 2cb922cbb..000000000
--- a/rails/config/initializers/tileserver.rb
+++ /dev/null
@@ -1,38 +0,0 @@
-### Setup for Mapbox Tileservers ###
-# This configures for both online (mapbox-gl) and offline (tileserver-gl)
-# however only one configuration is used by the app.
-
-# By default, local tileserver / offline mode is turned off.
-Rails.application.config.offline_mode = false
-
-#######################
-## Online Configuration
-# !!!! NOTE: If you are setting up your own online instance,
-# please utilize your Community's settings page to configure
-# your mapbox access token and preferred map style! These
-# are only meant to be FALLBACK values.
-
-# == Default Mapbox Token
-# The default mapbox token is used to provide a base mapbox token
-# to render maps, even when one is not provided by the user.
-# Mapbox tokens are set per-community in-app.
-Rails.application.config.default_mapbox_token = ENV["DEFAULT_MAPBOX_TOKEN"] || ENV["MAPBOX_ACCESS_TOKEN"] || "pk.ey"
-
-# == Default Map Style
-# The default map style is used to provide a default-style for map
-# rendering. It's configurable per-community via settings to override
-# what is defined here.
-Rails.application.config.default_map_style = ENV["DEFAULT_MAP_STYLE"] || ENV["MAPBOX_STYLE"] || "mapbox://styles/mapbox/streets-v11"
-
-########################
-## Offline Configuration
-# Running in offline mode requires a hosted tileserver
-# While an access token is not required, Mapbox does require a formatted "token"
-# in order to load the JS.
-if Rails.env.offline? || ENV["OFFLINE_MODE"]&.downcase == "yes"
- Rails.application.config.offline_mode = true
-end
-
-if ENV["USE_LOCAL_MAP_SERVER"].present? || ENV["OFFLINE_MAP_STYLE"].present?
- Rails.application.config.default_map_style = ENV["OFFLINE_MAP_STYLE"]
-end
diff --git a/rails/config/locales/en/dashboard.en.yml b/rails/config/locales/en/dashboard.en.yml
index 91198804f..d6971cf02 100644
--- a/rails/config/locales/en/dashboard.en.yml
+++ b/rails/config/locales/en/dashboard.en.yml
@@ -2,6 +2,21 @@ en:
profile: Profile
interviewer: Interviewer
import: Import
+ protomaps_basemap_styles:
+ contrast: Contrast
+ light: Light
+ dark: Dark
+ white: White
+ grayscale: Grayscale
+ black: Black
+ protomaps_basemap_markers:
+ default: "#3FB1CE"
+ contrast: "#B5C481"
+ light: "#3FB1CE"
+ dark: "#555"
+ white: "#bbb"
+ grayscale: "#999"
+ black: "#666"
map:
center: Map Center
bounds: Map Bounds
@@ -10,6 +25,8 @@ en:
ne_corner: Northeast Corner
unrestricted_bounds: Allow unrestricted bounds
online: Online Map Configuration
+ mapbox_configuration: Mapbox Map Configuration (Optional)
+ protomaps_configuration: Protomaps API Configuration (Optional)
settings: Map Settings
settings_description: Customize your community's map settings.
projection:
diff --git a/rails/config/locales/en/models.en.yml b/rails/config/locales/en/models.en.yml
index fc4eead32..8c6cf4738 100644
--- a/rails/config/locales/en/models.en.yml
+++ b/rails/config/locales/en/models.en.yml
@@ -73,8 +73,10 @@ en:
sponsor_logos: Sponsor Logos
mapbox_style_url: Mapbox Style URL
mapbox_access_token: Mapbox access token associated with the style
- mapbox_3d: Activate 3D Terrain view for online map
+ mapbox_3d: Activate 3D Terrain view
map_projection: Set projection for map
+ protomaps_api_key: API Key (free at protomaps.com)
+ protomaps_basemap_style: Basemap Style
center_lat: Map center, latitude
center_long: Map center, longitude
sw_boundary_lat: SW bounding box, latitude (optional)
diff --git a/rails/config/webpack/webpack.config.js b/rails/config/webpack/webpack.config.js
index cab47726e..5e3fcd7df 100644
--- a/rails/config/webpack/webpack.config.js
+++ b/rails/config/webpack/webpack.config.js
@@ -1,9 +1,14 @@
-// // See the shakacode/shakapacker README and docs directory for advice on customizing your webpackConfig.
+// See the shakacode/shakapacker README and docs directory for advice on customizing your generateWebpackConfig.
const { generateWebpackConfig } = require('shakapacker')
+// Be sure to reload your server if you make changes to this config.
const customConfig = {
resolve: {
extensions: ['.css']
+ },
+ output: {
+ library: ['Terrastories', '[name]'],
+ libraryTarget: 'var',
}
}
diff --git a/rails/db/migrate/20240112163116_add_protomaps_config_to_theme.rb b/rails/db/migrate/20240112163116_add_protomaps_config_to_theme.rb
new file mode 100644
index 000000000..579635b6e
--- /dev/null
+++ b/rails/db/migrate/20240112163116_add_protomaps_config_to_theme.rb
@@ -0,0 +1,6 @@
+class AddProtomapsConfigToTheme < ActiveRecord::Migration[6.1]
+ def change
+ add_column :themes, :protomaps_api_key, :text
+ add_column :themes, :protomaps_basemap_style, :text
+ end
+end
diff --git a/rails/db/schema.rb b/rails/db/schema.rb
index c30ae604e..7fcd63c24 100644
--- a/rails/db/schema.rb
+++ b/rails/db/schema.rb
@@ -10,7 +10,7 @@
#
# It's strongly recommended that you check this file into your version control system.
-ActiveRecord::Schema.define(version: 2023_08_08_135800) do
+ActiveRecord::Schema.define(version: 2024_01_12_163116) do
# These are extensions that must be enabled in order to support this database
enable_extension "plpgsql"
@@ -174,6 +174,8 @@
t.boolean "mapbox_3d", default: false
t.integer "map_projection", default: 0
t.bigint "community_id", null: false
+ t.text "protomaps_api_key"
+ t.text "protomaps_basemap_style"
end
create_table "users", force: :cascade do |t|
diff --git a/rails/package.json b/rails/package.json
index 27140fb26..cce924a22 100644
--- a/rails/package.json
+++ b/rails/package.json
@@ -40,7 +40,7 @@
"i18next-http-backend": "^2.1.1",
"jest": "24.0.0",
"mapbox-gl": "^2.12.0",
- "maplibre-gl": "^3.3.1",
+ "maplibre-gl": "^3.6.2",
"mini-css-extract-plugin": "^2.7.6",
"postcss": "^8.4.31",
"postcss-flexbugs-fixes": "^5.0.2",
@@ -48,6 +48,7 @@
"postcss-loader": "^7.3.3",
"postcss-preset-env": "^9.2.0",
"prop-types": "^15.8.1",
+ "protomaps-themes-base": "2.0.0-alpha.4",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-i18next": "^12.1.5",
diff --git a/rails/spec/models/theme_spec.rb b/rails/spec/models/theme_spec.rb
index efc62a7b9..44e24554f 100644
--- a/rails/spec/models/theme_spec.rb
+++ b/rails/spec/models/theme_spec.rb
@@ -26,4 +26,106 @@
expect(theme.sw_boundary).to eq nil # was [-180, -85]
expect(theme.ne_boundary).to eq nil # was [180, 85]
end
+
+ describe "#basemap_style" do
+ it "returns 'contrast' with default configuration" do
+ expect(theme.basemap_style).to eq("contrast")
+ end
+
+ it "returns configured protomaps_basemap_style even without protomaps API key" do
+ theme.protomaps_basemap_style = "light"
+ expect(theme.basemap_style).to eq("light")
+ end
+
+ context "when offline" do
+ it "returns 'default'" do
+ expect(Map).to receive(:offline?).and_return(true)
+ expect(theme.basemap_style).to eq("default")
+ end
+ end
+
+ context "when default map is mapbox" do
+ before { allow(Map).to receive(:use_mapbox?).and_return(true) }
+
+ it "returns 'default'" do
+ # this value should be ignored
+ theme.protomaps_basemap_style = "light"
+ expect(theme.basemap_style).to eq("default")
+ end
+
+ it "returns 'contrast' if protomaps is configured" do
+ theme.protomaps_api_key = "123123123"
+ expect(theme.basemap_style).to eq("contrast")
+ end
+ end
+
+ context "when community has mapbox configured" do
+ it "returns 'default'" do
+ theme.mapbox_access_token = "pk.eyTest"
+ theme.protomaps_basemap_style = "light"
+ expect(theme.basemap_style).to eq("default")
+ end
+ end
+ end
+
+ describe "#mapbox_token" do
+ it "returns nil by default" do
+ expect(theme.mapbox_token).to be_nil
+ end
+
+ it "returns server configured token" do
+ theme.mapbox_access_token = "custom"
+ expect(theme.mapbox_token).to eq("custom")
+ end
+
+ context "when server is configured for mapbox" do
+ before { allow(Map).to receive(:mapbox_access_token).and_return("pk.eyTest") }
+
+ it "returns default server configured token" do
+ expect(theme.mapbox_token).to eq("pk.eyTest")
+ end
+
+ it "returns community configured token when available" do
+ theme.mapbox_access_token = "custom"
+ expect(theme.mapbox_token).to eq("custom")
+ end
+ end
+ end
+
+ describe "#map_style_url" do
+ context "when offline" do
+ it "returns default configured style" do
+ expect(Map).to receive(:offline?) { true }
+ expect(Map).to receive(:default_style) { "default_style" }
+
+ expect(theme.map_style_url).to eq("default_style")
+ end
+ end
+
+ it "returns community configured mapbox style" do
+ theme.mapbox_access_token = "pk.eyTest"
+ theme.mapbox_style_url = "mapbox://style"
+ expect(theme.map_style_url).to eq("mapbox://style")
+ end
+
+ it "returns protomaps tile json url" do
+ theme.mapbox_access_token = "pk.eyTest"
+ theme.mapbox_style_url = "mapbox://style"
+ theme.protomaps_api_key = "123123123"
+ expect(theme.map_style_url).to eq("https://api.protomaps.com/tiles/v3.json?key=123123123")
+ end
+
+ it "returns default protomaps tile json url" do
+ expect(ENV).to receive(:[]).with("PROTOMAPS_API_KEY").and_return("CUSTOM")
+ expect(theme.map_style_url).to eq("https://api.protomaps.com/tiles/v3.json?key=CUSTOM")
+ end
+
+ context "when community has mapbox configured" do
+ it "returns default configured style" do
+ expect(Map).to receive(:default_style) { "default_style" }
+
+ expect(theme.map_style_url).to eq("default_style")
+ end
+ end
+ end
end
diff --git a/rails/spec/requests/dashboard/manage_community_spec.rb b/rails/spec/requests/dashboard/manage_community_spec.rb
index 8375281f8..1a762d818 100644
--- a/rails/spec/requests/dashboard/manage_community_spec.rb
+++ b/rails/spec/requests/dashboard/manage_community_spec.rb
@@ -17,31 +17,32 @@
allow(Flipper).to receive(:enabled?).with(:public_communities, community) { true }
end
- it "generates a static map when public is enabled" do
- allow(URI).to receive(:open) { File.open("./spec/fixtures/media/terrastories.png") }
+ context "when Mapbox is configured" do
+ before { allow(Map).to receive(:mapbox_access_token).and_return("pk.eyTest") }
- patch "/en/member/community", params: {community: {public: true}}
+ it "generates a static map when public is enabled & Mapbox is configured" do
+ allow(URI).to receive(:open) { File.open("./spec/fixtures/media/terrastories.png") }
- expect(response).to redirect_to(community_settings_path)
- expect(community.theme.static_map.attached?).to be true
- end
+ patch "/en/member/community", params: {community: {public: true}}
- it "skips generation if no access token is present (either self-added or not set in server eng)" do
- # set default to nil (set in initializers/tileserver.rb)
- expect(Rails.application.config).to receive(:default_mapbox_token)
+ expect(response).to redirect_to(community_settings_path)
+ expect(community.theme.static_map.attached?).to be true
+ end
- patch "/en/member/community", params: {community: {public: true}}
+ it "continues even if the generated static map cannot be attached to community" do
+ expect(URI).to receive(:open).and_raise(OpenURI::HTTPError.new("401 Unauthorized", {}))
- expect(community.theme.static_map.attached?).to be false
- end
+ patch "/en/member/community", params: {community: {public: true}}
- it "continues even if the generated static map cannot be attached to community" do
- expect(URI).to receive(:open).and_raise(OpenURI::HTTPError.new("401 Unauthorized", {}))
+ expect(community.theme.static_map.attached?).to be false
+ end
+ end
+ it "skips generation if no access token is present (either self-added or not set in server eng)" do
patch "/en/member/community", params: {community: {public: true}}
expect(community.theme.static_map.attached?).to be false
end
end
end
-end
\ No newline at end of file
+end
diff --git a/rails/spec/services/map_spec.rb b/rails/spec/services/map_spec.rb
new file mode 100644
index 000000000..0d156f7e3
--- /dev/null
+++ b/rails/spec/services/map_spec.rb
@@ -0,0 +1,127 @@
+require "rails_helper"
+
+RSpec.describe Map do
+ before do
+ Map.reload
+ end
+
+ describe "#offline?" do
+ it "returns true if Rails.env.offline?" do
+ allow(Rails).to receive(:env).and_return("offline".inquiry).once
+ expect(Map.offline?).to be true
+ end
+
+ it "returns true if Rails.env.offline?" do
+ allow(ENV).to receive(:[]).with("OFFLINE_MODE").and_return("yes")
+ expect(Map.offline?).to be true
+ end
+
+ it "returns false" do
+ expect(Map.offline?).to be false
+ end
+
+ it "memoizes value" do
+ expect(Rails.env).to receive(:offline?).and_return(false).once
+ expect(ENV).to receive(:[]).with("OFFLINE_MODE").and_return("t").once
+
+ Map.offline?
+ # subsequent calls should not trigger additional checks
+ Map.offline?
+ Map.offline?
+ end
+ end
+
+ describe "#use_mapbox?" do
+ it "returns false if running in offline mode even if mapbox is configured" do
+ allow(Map).to receive(:offline?).and_return(true)
+
+ expect(ENV).not_to receive(:[]).with("MAPBOX_ACCESS_TOKEN")
+ expect(ENV).not_to receive(:[]).with("DEFAULT_MAPBOX_TOKEN")
+
+ expect(Map.use_mapbox?).to be false
+ end
+
+ context "returns true" do
+ it "when MAPBOX_ACCESS_TOKEN is set" do
+ allow(ENV).to receive(:[]).with("MAPBOX_ACCESS_TOKEN").and_return("pk.ey")
+ expect(Map.use_mapbox?).to be true
+ end
+
+ it "when [deprecated] DEFAULT_MAPBOX_TOKEN is set" do
+ allow(ENV).to receive(:[]).with("DEFAULT_MAPBOX_TOKEN").and_return("pk.ey")
+
+ expect(ActiveSupport::Deprecation).to receive(:warn).with(
+ "Setting DEFAULT_MAPBOX_TOKEN to configure Mapbox is deprecated. " \
+ "Use MAPBOX_ACCESS_TOKEN instead."
+ )
+ expect(Map.use_mapbox?).to be true
+ end
+ end
+
+ it "returns false when no mapbox configuration is set" do
+ allow(ENV).to receive(:[]).with("MAPBOX_ACCESS_TOKEN")
+ allow(ENV).to receive(:[]).with("DEFAULT_MAPBOX_TOKEN")
+ expect(Map.use_mapbox?).to be false
+ end
+ end
+
+ describe "#default_style" do
+ context "when mapbox is configured" do
+ before { allow(Map).to receive(:use_mapbox?).and_return(true) }
+
+ it "returns [deprecated] DEFAULT_MAP_STYLE" do
+ allow(ENV).to receive(:[]).with("DEFAULT_MAP_STYLE").and_return("mapbox://styles/terrastories/custom-v1")
+ # shouldn't use fallback
+ expect(ENV).not_to receive(:[]).with("MAPBOX_STYLE")
+
+ expect(ActiveSupport::Deprecation).to receive(:warn).with(
+ "Setting DEFAULT_MAP_STYLE to configure Mapbox is deprecated. " \
+ "Use MAPBOX_STYLE instead."
+ )
+
+ expect(Map.default_style).to eq("mapbox://styles/terrastories/custom-v1")
+ end
+
+ it "returns MAPBOX_STYLE" do
+ expect(ENV).to receive(:[]).with("DEFAULT_MAP_STYLE")
+ expect(ENV).to receive(:[]).with("MAPBOX_STYLE").and_return("mapbox://styles/terrastories/custom-v2")
+
+ expect(Map.default_style).to eq("mapbox://styles/terrastories/custom-v2")
+ end
+
+ it "fallsback to a default mapbox managed style" do
+ expect(ENV).to receive(:[]).with("DEFAULT_MAP_STYLE")
+ expect(ENV).to receive(:[]).with("MAPBOX_STYLE")
+
+ expect(Map.default_style).to eq("mapbox://styles/mapbox/streets-v11")
+ end
+ end
+
+ context "when tileserver is configured" do
+ it "returns TILESERVER_URL" do
+ allow(ENV).to receive(:[]).with("TILESERVER_URL").and_return("https://tileserver.terrastories.app/style.json")
+
+ expect(Map.default_style).to eq("https://tileserver.terrastories.app/style.json")
+ end
+ end
+
+ context "when protomaps API key is configured" do
+ it "returns protomaps tilesjson w/ configured API key" do
+ allow(ENV).to receive(:[]).with("PROTOMAPS_API_KEY").and_return("1234567890")
+
+ expect(Map.default_style).to eq("https://api.protomaps.com/tiles/v3.json?key=1234567890")
+ end
+ end
+ end
+
+ describe "[deprecated] offline map style set to tileserver" do
+ it "returns offline map style url as-is if set as tileserver url" do
+ allow(ENV).to receive(:[]).with("OFFLINE_MAP_STYLE").and_return("http://tileserver.local/custom-map-style/style.json")
+ expect(ActiveSupport::Deprecation).to receive(:warn).with(
+ "Setting OFFLINE_MAP_STYLE to configure Tileserver is deprecated. " \
+ "Use TILESERVER_URL instead."
+ )
+ expect(Map.default_style).to eq("http://tileserver.local/custom-map-style/style.json")
+ end
+ end
+end
diff --git a/rails/spec/support/env_helpers.rb b/rails/spec/support/env_helpers.rb
new file mode 100644
index 000000000..53f66f528
--- /dev/null
+++ b/rails/spec/support/env_helpers.rb
@@ -0,0 +1,6 @@
+RSpec.configure do |config|
+ config.before(:each) do
+ allow(ENV).to receive(:[]).and_call_original
+ allow(ENV).to receive(:fetch).and_call_original
+ end
+end
\ No newline at end of file
diff --git a/rails/yarn.lock b/rails/yarn.lock
index 586a4d8db..4a7588403 100644
--- a/rails/yarn.lock
+++ b/rails/yarn.lock
@@ -2065,11 +2065,16 @@
"@types/qs" "*"
"@types/serve-static" "*"
-"@types/geojson@*", "@types/geojson@^7946.0.12":
+"@types/geojson@*":
version "7946.0.12"
resolved "https://registry.yarnpkg.com/@types/geojson/-/geojson-7946.0.12.tgz#0307536218d32e6b970bccd1d148b9c4e5b6f10d"
integrity sha512-uK2z1ZHJyC0nQRbuovXFt4mzXDwf27vQeUWNhfKGwRcWW429GOhP8HxUHlM6TLH4bzmlv/HlEjpvJh3JfmGsAA==
+"@types/geojson@^7946.0.13":
+ version "7946.0.13"
+ resolved "https://registry.yarnpkg.com/@types/geojson/-/geojson-7946.0.13.tgz#e6e77ea9ecf36564980a861e24e62a095988775e"
+ integrity sha512-bmrNrgKMOhM3WsafmbGmC+6dsF2Z308vLFsQ3a/bT8X8Sv5clVYpPars/UPq+sAaJP+5OoLAYgwbkS5QEJdLUQ==
+
"@types/http-errors@*":
version "2.0.3"
resolved "https://registry.yarnpkg.com/@types/http-errors/-/http-errors-2.0.3.tgz#c54e61f79b3947d040f150abd58f71efb422ff62"
@@ -2124,15 +2129,20 @@
resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee"
integrity sha512-dRLjCWHYg4oaA77cxO64oO+7JwCwnIzkZPdrrC71jQmQtlhM556pwKo5bUzqvZndkVbeFLIIi+9TC40JNF5hNQ==
-"@types/mapbox__point-geometry@*", "@types/mapbox__point-geometry@^0.1.3":
+"@types/mapbox__point-geometry@*":
version "0.1.3"
resolved "https://registry.yarnpkg.com/@types/mapbox__point-geometry/-/mapbox__point-geometry-0.1.3.tgz#3050f58fcdcc9da96998655268d477ea266dbe76"
integrity sha512-2W46IOXlu7vC8m3+M5rDqSnuY22GFxxx3xhkoyqyPWrD+eP2iAwNst0A1+umLYjCTJMJTSpiofphn9h9k+Kw+w==
-"@types/mapbox__vector-tile@^1.3.3":
- version "1.3.3"
- resolved "https://registry.yarnpkg.com/@types/mapbox__vector-tile/-/mapbox__vector-tile-1.3.3.tgz#f8bf33d91f9951c6090dbd454d4e33626f5107cc"
- integrity sha512-d263B3KCQtXKVZMHpMJrEW5EeLBsQ8jvAS9nhpUKC5hHIlQaACG9PWkW8qxEeNuceo9120AwPjeS91uNa4ltqA==
+"@types/mapbox__point-geometry@^0.1.4":
+ version "0.1.4"
+ resolved "https://registry.yarnpkg.com/@types/mapbox__point-geometry/-/mapbox__point-geometry-0.1.4.tgz#0ef017b75eedce02ff6243b4189210e2e6d5e56d"
+ integrity sha512-mUWlSxAmYLfwnRBmgYV86tgYmMIICX4kza8YnE/eIlywGe2XoOxlpVnXWwir92xRLjwyarqwpu2EJKD2pk0IUA==
+
+"@types/mapbox__vector-tile@^1.3.4":
+ version "1.3.4"
+ resolved "https://registry.yarnpkg.com/@types/mapbox__vector-tile/-/mapbox__vector-tile-1.3.4.tgz#ad757441ef1d34628d9e098afd9c91423c1f8734"
+ integrity sha512-bpd8dRn9pr6xKvuEBQup8pwQfD4VUyqO/2deGjfpe6AwC8YRlyEipvefyRJUSiCJTZuCb8Pl1ciVV5ekqJ96Bg==
dependencies:
"@types/geojson" "*"
"@types/mapbox__point-geometry" "*"
@@ -2170,11 +2180,16 @@
resolved "https://registry.yarnpkg.com/@types/parse-json/-/parse-json-4.0.1.tgz#27f7559836ad796cea31acb63163b203756a5b4e"
integrity sha512-3YmXzzPAdOTVljVMkTMBdBEvlOLg2cDQaDhnnhT3nT9uDbnJzjWhKlzb+desT12Y7tGqaN6d+AbozcKzyL36Ng==
-"@types/pbf@*", "@types/pbf@^3.0.4":
+"@types/pbf@*":
version "3.0.4"
resolved "https://registry.yarnpkg.com/@types/pbf/-/pbf-3.0.4.tgz#32f8cd8bb2fb53e5870a5d751210d1dcdce23f85"
integrity sha512-SOFlLGZkLbEXJRwcWCqeP/Koyaf/uAqLXHUsdo/nMfjLsNd8kqauwHe9GBOljSmpcHp/LC6kOjo3SidGjNirVA==
+"@types/pbf@^3.0.5":
+ version "3.0.5"
+ resolved "https://registry.yarnpkg.com/@types/pbf/-/pbf-3.0.5.tgz#a9495a58d8c75be4ffe9a0bd749a307715c07404"
+ integrity sha512-j3pOPiEcWZ34R6a6mN07mUkM4o4Lwf6hPNt8eilOeZhTFbxFXmKhvXl9Y28jotFPaI1bpPDJsbCprUoNke6OrA==
+
"@types/prop-types@*":
version "15.7.9"
resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.9.tgz#b6f785caa7ea1fe4414d9df42ee0ab67f23d8a6d"
@@ -2252,10 +2267,10 @@
resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-1.0.1.tgz#0a851d3bd96498fa25c33ab7278ed3bd65f06c3e"
integrity sha512-l42BggppR6zLmpfU6fq9HEa2oGPEI8yrSPL3GITjfRInppYFahObbIQOQK3UGxEnyQpltZLaPe75046NOZQikw==
-"@types/supercluster@^7.1.2":
- version "7.1.2"
- resolved "https://registry.yarnpkg.com/@types/supercluster/-/supercluster-7.1.2.tgz#2391a1b22ef108e37d51d4c8bdea7dc04ebf4bcf"
- integrity sha512-qMhofL945Z4njQUuntadexAgPtpiBC014WvVqU70Prj42LC77Xgmz04us7hSMmwjs7KbgAwGBmje+FSOvDbP0Q==
+"@types/supercluster@^7.1.3":
+ version "7.1.3"
+ resolved "https://registry.yarnpkg.com/@types/supercluster/-/supercluster-7.1.3.tgz#1a1bc2401b09174d9c9e44124931ec7874a72b27"
+ integrity sha512-Z0pOY34GDFl3Q6hUFYf3HkTwKEE02e7QgtJppBt+beEAxnyOpJua+voGFvxINBHa06GwLFFym7gRPY2SiKIfIA==
dependencies:
"@types/geojson" "*"
@@ -6709,10 +6724,10 @@ mapbox-gl@^2.12.0:
tinyqueue "^2.0.3"
vt-pbf "^3.1.3"
-maplibre-gl@^3.3.1:
- version "3.5.2"
- resolved "https://registry.yarnpkg.com/maplibre-gl/-/maplibre-gl-3.5.2.tgz#84a352f1845c6ccf6fe5d86aaa0d0e8b0f18923c"
- integrity sha512-deqYA/RiEyXMGroZMDbOWNQTLnFsxREC+mDkQnuyCUNdBWm1KHafsXJYZP7rlLa5RLQNq05IAUAizY9aHTpIUw==
+maplibre-gl@^3.6.2:
+ version "3.6.2"
+ resolved "https://registry.yarnpkg.com/maplibre-gl/-/maplibre-gl-3.6.2.tgz#abc2f34bddecabef8c20028eff06d62e36d75ccc"
+ integrity sha512-krg2KFIdOpLPngONDhP6ixCoWl5kbdMINP0moMSJFVX7wX1Clm2M9hlNKXS8vBGlVWwR5R3ZfI6IPrYz7c+aCQ==
dependencies:
"@mapbox/geojson-rewind" "^0.5.2"
"@mapbox/jsonlint-lines-primitives" "^2.0.2"
@@ -6722,11 +6737,11 @@ maplibre-gl@^3.3.1:
"@mapbox/vector-tile" "^1.3.1"
"@mapbox/whoots-js" "^3.1.0"
"@maplibre/maplibre-gl-style-spec" "^19.3.3"
- "@types/geojson" "^7946.0.12"
- "@types/mapbox__point-geometry" "^0.1.3"
- "@types/mapbox__vector-tile" "^1.3.3"
- "@types/pbf" "^3.0.4"
- "@types/supercluster" "^7.1.2"
+ "@types/geojson" "^7946.0.13"
+ "@types/mapbox__point-geometry" "^0.1.4"
+ "@types/mapbox__vector-tile" "^1.3.4"
+ "@types/pbf" "^3.0.5"
+ "@types/supercluster" "^7.1.3"
earcut "^2.2.4"
geojson-vt "^3.2.1"
gl-matrix "^3.4.3"
@@ -8079,6 +8094,11 @@ protocol-buffers-schema@^3.3.1:
resolved "https://registry.yarnpkg.com/protocol-buffers-schema/-/protocol-buffers-schema-3.6.0.tgz#77bc75a48b2ff142c1ad5b5b90c94cd0fa2efd03"
integrity sha512-TdDRD+/QNdrCGCE7v8340QyuXd4kIWIgapsE2+n/SaGiSSbomYl4TjHlvIoCWRpE7wFt02EpB35VVA2ImcBVqw==
+protomaps-themes-base@2.0.0-alpha.4:
+ version "2.0.0-alpha.4"
+ resolved "https://registry.yarnpkg.com/protomaps-themes-base/-/protomaps-themes-base-2.0.0-alpha.4.tgz#277096362007bb4403b371297f066873bf66807a"
+ integrity sha512-XHwrN0yzXYsNCgdHTy6Kr2pFFTuOsoMHbpvoNzrAhBx11A/JV2rt9lKa3Dh7oTYVuarkHaFHQQ9bpqd7cLE8zg==
+
proxy-addr@~2.0.7:
version "2.0.7"
resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-2.0.7.tgz#f19fe69ceab311eeb94b42e70e8c2070f9ba1025"
diff --git a/tileserver/data/config.json b/tileserver/data/config.json
index 822a2d494..d6445a275 100644
--- a/tileserver/data/config.json
+++ b/tileserver/data/config.json
@@ -3,7 +3,8 @@
"paths": {
"fonts": "fonts",
"sprites": "sprites"
- }
+ },
+ "serveAllFonts": true
},
"data": {
"terrastories-map": {