Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Move geojson and logger REST into .rest modules (#83611)

Chris Truter03d01f671307
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index c889918a6d0..d34501a962a 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -1170,14 +1170,16 @@
geojson
{:team "UX West"
- :api #{metabase.geojson.api
- metabase.geojson.init
- metabase.geojson.settings}
+ :api #{metabase.geojson.core metabase.geojson.init metabase.geojson.settings}
+ :uses #{settings util util.config}}
+
+ geojson.rest
+ {:team "UX West"
+ :api #{metabase.geojson.rest.api}
:uses #{api
+ geojson
permissions
- settings
- util
- util.config}}
+ util}}
glossary
{:team "Gadget"
@@ -1389,15 +1391,17 @@
logger
{:team "DevEx"
- :api #{metabase.logger.api
- metabase.logger.core
- metabase.logger.init}
+ :api #{metabase.logger.core metabase.logger.init}
+ :uses #{util.classloader util.config}}
+
+ logger.rest
+ {:team "DevEx"
+ :api #{metabase.logger.rest.api}
:uses #{analytics
api
+ logger
permissions
- util
- util.classloader
- util.config}}
+ util}}
mcp
{:team "Metabot"
diff --git a/enterprise/backend/test/metabase_enterprise/advanced_permissions/api/setting_test.clj b/enterprise/backend/test/metabase_enterprise/advanced_permissions/api/setting_test.clj
index 11e5c5b90aa..e8b387655cb 100644
--- a/enterprise/backend/test/metabase_enterprise/advanced_permissions/api/setting_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/advanced_permissions/api/setting_test.clj
@@ -4,7 +4,7 @@
[clojure.test :refer :all]
[metabase.channel.email :as email]
[metabase.channel.slack :as slack]
- [metabase.geojson.api-test :as geojson-test]
+ [metabase.geojson.rest.api-test :as geojson-test]
[metabase.permissions.models.permissions :as perms]
[metabase.test :as mt]
[metabase.test.fixtures :as fixtures]))
diff --git a/src/metabase/api/macros/defendpoint/open_api.clj b/src/metabase/api/macros/defendpoint/open_api.clj
index 34ead84e789..f9d136a3bce 100644
--- a/src/metabase/api/macros/defendpoint/open_api.clj
+++ b/src/metabase/api/macros/defendpoint/open_api.clj
@@ -297,7 +297,7 @@
(comment
(require '[metabase.api.macros])
- (open-api-spec (metabase.api.macros/ns-routes 'metabase.geojson.api) "/api/geojson")
+ (open-api-spec (metabase.api.macros/ns-routes 'metabase.geojson.rest.api) "/api/geojson")
(metabase.api.macros.defendpoint.open-api/path-item
"/api/card/:id/series"
diff --git a/src/metabase/api/open_api.clj b/src/metabase/api/open_api.clj
index fc8aa9e8519..242bafbbc34 100644
--- a/src/metabase/api/open_api.clj
+++ b/src/metabase/api/open_api.clj
@@ -222,5 +222,5 @@
(comment
(require '[metabase.api.macros])
- (open-api-spec (metabase.api.macros/ns-handler 'metabase.geojson.api) "/api/geojson")
+ (open-api-spec (metabase.api.macros/ns-handler 'metabase.geojson.rest.api) "/api/geojson")
(root-open-api-object (requiring-resolve 'metabase.api-routes.core/routes)))
diff --git a/src/metabase/api_routes/routes.clj b/src/metabase/api_routes/routes.clj
index 70c31366185..9bca15513d0 100644
--- a/src/metabase/api_routes/routes.clj
+++ b/src/metabase/api_routes/routes.clj
@@ -32,13 +32,13 @@
[metabase.embedding-rest.api]
[metabase.explorations.api]
[metabase.frontend-errors.api]
- [metabase.geojson.api]
+ [metabase.geojson.rest.api]
[metabase.glossary.api]
[metabase.health-inspector.api]
[metabase.indexed-entities.api]
[metabase.indexes-rest.api]
[metabase.llm.api]
- [metabase.logger.api]
+ [metabase.logger.rest.api]
[metabase.login-history.api]
[metabase.mcp.callback-api]
[metabase.mcp.core :as mcp]
@@ -104,11 +104,11 @@
metabase.eid-translation.api/keep-me
metabase.explorations.api/keep-me
metabase.frontend-errors.api/keep-me
- metabase.geojson.api/keep-me
+ metabase.geojson.rest.api/keep-me
metabase.glossary.api/keep-me
metabase.indexed-entities.api/keep-me
metabase.indexes-rest.api/keep-me
- metabase.logger.api/keep-me
+ metabase.logger.rest.api/keep-me
metabase.login-history.api/keep-me
metabase.mcp.callback-api/keep-me
metabase.mcp.v2.api/keep-me
@@ -247,14 +247,14 @@
"/exploration" (+auth metabase.explorations.api/routes)
"/field" (+auth metabase.warehouse-schema-rest.api/field-routes)
"/frontend-errors" metabase.frontend-errors.api/routes
- "/geojson" 'metabase.geojson.api
+ "/geojson" 'metabase.geojson.rest.api
"/glossary" (+auth 'metabase.glossary.api)
"/google" (+auth metabase.sso.api/google-auth-routes)
"/health-inspector" (+auth 'metabase.health-inspector.api)
"/index" (+auth 'metabase.indexes-rest.api)
"/ldap" (+auth metabase.sso.api/ldap-routes)
"/llm" (+auth metabase.llm.api/routes)
- "/logger" (+auth 'metabase.logger.api)
+ "/logger" (+auth 'metabase.logger.rest.api)
"/login-history" (+auth 'metabase.login-history.api)
;; `/mcp` is a legacy alias of the canonical `/metabase-mcp` below, kept for back-compat with
;; existing clients. See [[metabase.mcp.paths/endpoint-paths]].
diff --git a/src/metabase/channel/render/body.clj b/src/metabase/channel/render/body.clj
index b830a6f3f3e..078ef0a25e2 100644
--- a/src/metabase/channel/render/body.clj
+++ b/src/metabase/channel/render/body.clj
@@ -16,7 +16,7 @@
[metabase.channel.settings :as channel.settings]
[metabase.dashboards.schema]
[metabase.formatter.core :as formatter]
- [metabase.geojson.api :as geojson.api]
+ [metabase.geojson.core :as geojson.core]
[metabase.geojson.settings :as geojson.settings]
[metabase.lib.schema :as lib.schema]
[metabase.lib.schema.id :as lib.schema.id]
@@ -836,7 +836,7 @@
;; Resolve the display type the same way detection does, so a visualizer dashcard's display wins.
(let [display-type (or (render.util/visualizer-display-type dashcard) (:display card))
region-key (region-map-region-key display-type card dashcard data)
- geojson (some-> region-key geojson.api/region-geojson)]
+ geojson (some-> region-key geojson.core/region-geojson)]
(if-not geojson
;; The region's GeoJSON couldn't be resolved (e.g. a custom map whose fetch failed); degrade to a
;; table of the data rather than emit an empty map.
diff --git a/src/metabase/geojson/api.clj b/src/metabase/geojson/core.clj
similarity index 59%
rename from src/metabase/geojson/api.clj
rename to src/metabase/geojson/core.clj
index 15e991dc21f..3c3ee4039dd 100644
--- a/src/metabase/geojson/api.clj
+++ b/src/metabase/geojson/core.clj
@@ -1,23 +1,15 @@
-(ns metabase.geojson.api
+(ns metabase.geojson.core
(:require
[clj-http.client :as http]
[clojure.core.memoize :as memoize]
[clojure.java.io :as io]
[clojure.string :as str]
- [metabase.api.macros :as api.macros]
[metabase.geojson.settings :as geojson.settings]
- [metabase.permissions.core :as perms]
[metabase.util :as u]
[metabase.util.http :as u.http]
[metabase.util.i18n :refer [tru]]
[metabase.util.json :as json]
- [metabase.util.log :as log]
- [metabase.util.malli.schema :as ms]
- [ring.util.codec :as codec]
- [ring.util.response :as response])
- (:import
- (java.io BufferedReader)
- (org.apache.commons.io.input ReaderInputStream)))
+ [metabase.util.log :as log]))
(set! *warn-on-reflection* true)
@@ -55,7 +47,10 @@
:else (:body resp))))
-(defn- url->reader [url]
+(defn url->reader
+ "A reader over the GeoJSON at `url`: a classpath resource when classpath GeoJSON is allowed, otherwise a remote
+ fetch that refuses redirects and internal hosts."
+ [url]
(if-let [resource (and (geojson.settings/valid-geojson-resource-path? url)
(io/resource url))]
(io/reader resource)
@@ -103,59 +98,3 @@
(when region-key
(or (geojson.settings/builtin-region-geojson region-key)
(custom-region-geojson region-key))))
-
-(defn- read-url-and-respond
- "Reads the provided URL and responds with the contents as a stream."
- [url respond]
- (with-open [^BufferedReader reader (url->reader url)
- is (.get (doto (ReaderInputStream/builder) (.setReader reader)))]
- (respond (-> (response/response is)
- (response/content-type "application/json")))))
-
-;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
-;; use our API + we will need it when we make auto-TypeScript-signature generation happen
-;;
-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}
-(api.macros/defendpoint :get "/:key"
- "Fetch a custom GeoJSON file as defined in the [[metabase.geojson.settings/custom-geojson]] setting. (This just acts
- as a simple proxy for the file specified for `key`)."
- [{k :key, :as _route-params} :- [:map {:closed true}
- [:key ms/NonBlankString]]
- _query-params
- _body
- _request
- respond
- raise]
- (when-not (geojson.settings/custom-geojson-enabled)
- (raise (ex-info (tru "Custom GeoJSON is not enabled") {:status-code 400})))
- (if-let [url (get-in (geojson.settings/user-defined-custom-geojson) [(keyword k) :url])]
- (try
- (read-url-and-respond url respond)
- (catch Throwable e
- (raise e)))
- (raise (ex-info (tru "Invalid custom GeoJSON key: {0}" k) {:status-code 400}))))
-
-;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
-;; use our API + we will need it when we make auto-TypeScript-signature generation happen
-;;
-#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}
-(api.macros/defendpoint :get "/"
- "Load a custom GeoJSON file based on a URL or file path provided as a query parameter.
- This behaves similarly to /api/geojson/:key but doesn't require the custom map to be saved to the DB first."
- [_route-params
- {:keys [url], :as _query-params} :- [:map {:closed true}
- [:url ms/NonBlankString]]
- _body
- _request
- respond
- raise]
- (perms/check-has-application-permission :setting)
- (when-not (geojson.settings/custom-geojson-enabled)
- (raise (ex-info (tru "Custom GeoJSON is not enabled") {:status-code 400})))
- (let [decoded-url (codec/url-decode url)]
- (try
- (when-not (geojson.settings/valid-geojson-url? decoded-url)
- (throw (ex-info (geojson.settings/invalid-location-msg) {:status-code 400})))
- (read-url-and-respond decoded-url respond)
- (catch Throwable e
- (raise e)))))
diff --git a/src/metabase/geojson/rest/api.clj b/src/metabase/geojson/rest/api.clj
new file mode 100644
index 00000000000..69b0c909a2c
--- /dev/null
+++ b/src/metabase/geojson/rest/api.clj
@@ -0,0 +1,71 @@
+(ns metabase.geojson.rest.api
+ (:require
+ [metabase.api.macros :as api.macros]
+ [metabase.geojson.core :as geojson]
+ [metabase.geojson.settings :as geojson.settings]
+ [metabase.permissions.core :as perms]
+ [metabase.util.i18n :refer [tru]]
+ [metabase.util.malli.schema :as ms]
+ [ring.util.codec :as codec]
+ [ring.util.response :as response])
+ (:import
+ (java.io BufferedReader)
+ (org.apache.commons.io.input ReaderInputStream)))
+
+(set! *warn-on-reflection* true)
+
+(defn- read-url-and-respond
+ "Reads the provided URL and responds with the contents as a stream."
+ [url respond]
+ (with-open [^BufferedReader reader (geojson/url->reader url)
+ is (.get (doto (ReaderInputStream/builder) (.setReader reader)))]
+ (respond (-> (response/response is)
+ (response/content-type "application/json")))))
+
+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
+;; use our API + we will need it when we make auto-TypeScript-signature generation happen
+;;
+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}
+(api.macros/defendpoint :get "/:key"
+ "Fetch a custom GeoJSON file as defined in the [[metabase.geojson.settings/custom-geojson]] setting. (This just acts
+ as a simple proxy for the file specified for `key`)."
+ [{k :key, :as _route-params} :- [:map {:closed true}
+ [:key ms/NonBlankString]]
+ _query-params
+ _body
+ _request
+ respond
+ raise]
+ (when-not (geojson.settings/custom-geojson-enabled)
+ (raise (ex-info (tru "Custom GeoJSON is not enabled") {:status-code 400})))
+ (if-let [url (get-in (geojson.settings/user-defined-custom-geojson) [(keyword k) :url])]
+ (try
+ (read-url-and-respond url respond)
+ (catch Throwable e
+ (raise e)))
+ (raise (ex-info (tru "Invalid custom GeoJSON key: {0}" k) {:status-code 400}))))
+
+;; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to
+;; use our API + we will need it when we make auto-TypeScript-signature generation happen
+;;
+#_{:clj-kondo/ignore [:metabase/validate-defendpoint-has-response-schema]}
+(api.macros/defendpoint :get "/"
+ "Load a custom GeoJSON file based on a URL or file path provided as a query parameter.
+ This behaves similarly to /api/geojson/:key but doesn't require the custom map to be saved to the DB first."
+ [_route-params
+ {:keys [url], :as _query-params} :- [:map {:closed true}
+ [:url ms/NonBlankString]]
+ _body
+ _request
+ respond
+ raise]
+ (perms/check-has-application-permission :setting)
+ (when-not (geojson.settings/custom-geojson-enabled)
+ (raise (ex-info (tru "Custom GeoJSON is not enabled") {:status-code 400})))
+ (let [decoded-url (codec/url-decode url)]
+ (try
+ (when-not (geojson.settings/valid-geojson-url? decoded-url)
+ (throw (ex-info (geojson.settings/invalid-location-msg) {:status-code 400})))
+ (read-url-and-respond decoded-url respond)
+ (catch Throwable e
+ (raise e)))))
diff --git a/src/metabase/geojson/settings.clj b/src/metabase/geojson/settings.clj
index 45c81d5ca81..be646f430e1 100644
--- a/src/metabase/geojson/settings.clj
+++ b/src/metabase/geojson/settings.clj
@@ -158,7 +158,7 @@
(defn defined-region?
"Whether `region-key` names a region map whose GeoJSON we could resolve: a built-in region (when default
maps are enabled), or a user-defined one (when custom GeoJSON is enabled). Mirrors what
- [[metabase.geojson.api/region-geojson]] can resolve, minus the fetch itself."
+ [[metabase.geojson.core/region-geojson]] can resolve, minus the fetch itself."
[region-key]
(let [k (keyword region-key)]
(or (contains? (builtin-geojson) k)
diff --git a/src/metabase/logger/api.clj b/src/metabase/logger/rest/api.clj
similarity index 99%
rename from src/metabase/logger/api.clj
rename to src/metabase/logger/rest/api.clj
index 77d2cc68c9f..294d5d289d4 100644
--- a/src/metabase/logger/api.clj
+++ b/src/metabase/logger/rest/api.clj
@@ -1,4 +1,4 @@
-(ns metabase.logger.api
+(ns metabase.logger.rest.api
"/api/logger endpoints"
(:require
[clojure.string :as str]
diff --git a/test/metabase/analytics/api/proxy_test.clj b/test/metabase/analytics/api/proxy_test.clj
index 3adcbed0e3b..fd7954ac723 100644
--- a/test/metabase/analytics/api/proxy_test.clj
+++ b/test/metabase/analytics/api/proxy_test.clj
@@ -1,7 +1,7 @@
(ns metabase.analytics.api.proxy-test
"Integration tests for the public Snowplow telemetry proxy (`POST /api/analytics-proxy`).
- Mirrors `metabase.geojson.api-test`: a public endpoint that forwards an outbound HTTP call, exercised with
+ Mirrors `metabase.geojson.rest.api-test`: a public endpoint that forwards an outbound HTTP call, exercised with
`clj-http.fake/with-fake-routes` to mock the collector and `metabase.test.http-client/client` for anonymous
requests."
(:require
diff --git a/test/metabase/geojson/api_test.clj b/test/metabase/geojson/rest/api_test.clj
similarity index 95%
rename from test/metabase/geojson/api_test.clj
rename to test/metabase/geojson/rest/api_test.clj
index 88b13227e07..200c7b665dc 100644
--- a/test/metabase/geojson/api_test.clj
+++ b/test/metabase/geojson/rest/api_test.clj
@@ -1,9 +1,9 @@
-(ns metabase.geojson.api-test
+(ns metabase.geojson.rest.api-test
(:require
[clj-http.fake :as fake]
[clojure.core.memoize :as memoize]
[clojure.test :refer :all]
- [metabase.geojson.api :as api.geojson]
+ [metabase.geojson.core :as geojson.core]
[metabase.geojson.settings :as geojson.settings]
[metabase.test :as mt]
[metabase.test.http-client :as client]
@@ -157,7 +157,7 @@
(deftest url-proxy-endpoint-non-responding-server-test
(testing "a loopback URL is refused by the connection-time SSRF resolver, returning a good error
immediately instead of hanging on a server that accepts a connection but never responds"
- (with-redefs [api.geojson/connection-timeout-ms 200]
+ (with-redefs [geojson.core/connection-timeout-ms 200]
;; a webserver which accepts a connection and never responds -- the case that used to hang for 45s.
;; We never even connect now: `localhost` resolves to loopback, which the resolver refuses.
(with-open [server (non-responding-server)]
@@ -192,21 +192,21 @@
(deftest region-geojson-test
(testing "built-in regions resolve from the classpath without a network fetch"
- (let [us (api.geojson/region-geojson "us_states")]
+ (let [us (geojson.core/region-geojson "us_states")]
(is (= "STATE" (:region_key us)))
(is (pos? (count (get-in us [:data "features"]))))))
(testing "unknown / nil regions resolve to nil"
- (is (nil? (api.geojson/region-geojson "not-a-real-region")))
- (is (nil? (api.geojson/region-geojson nil))))
+ (is (nil? (geojson.core/region-geojson "not-a-real-region")))
+ (is (nil? (geojson.core/region-geojson nil))))
(with-geojson-mocks
(mt/with-temporary-setting-values [custom-geojson test-custom-geojson]
- (memoize/memo-clear! @#'api.geojson/fetch-geojson-data)
+ (memoize/memo-clear! @#'geojson.core/fetch-geojson-data)
(testing "user-defined custom maps are fetched and parsed"
- (is (= "Point" (get-in (api.geojson/region-geojson "middle-earth") [:data "type"]))))
- (memoize/memo-clear! @#'api.geojson/fetch-geojson-data)
+ (is (= "Point" (get-in (geojson.core/region-geojson "middle-earth") [:data "type"]))))
+ (memoize/memo-clear! @#'geojson.core/fetch-geojson-data)
(testing "returns nil when custom GeoJSON is disabled"
(mt/with-temp-env-var-value! [mb-custom-geojson-enabled false]
- (is (nil? (api.geojson/region-geojson "middle-earth"))))))))
+ (is (nil? (geojson.core/region-geojson "middle-earth"))))))))
(deftest disable-custom-geojson-test
(testing "Should be able to disable GeoJSON proxying endpoints by env var"
diff --git a/test/metabase/logger/api_test.clj b/test/metabase/logger/rest/api_test.clj
similarity index 99%
rename from test/metabase/logger/api_test.clj
rename to test/metabase/logger/rest/api_test.clj
index 5d0a887d361..6d92e253a99 100644
--- a/test/metabase/logger/api_test.clj
+++ b/test/metabase/logger/rest/api_test.clj
@@ -1,4 +1,4 @@
-(ns metabase.logger.api-test
+(ns metabase.logger.rest.api-test
(:require
[clojure.test :refer :all]
[metabase.analytics.snowplow-test :as snowplow-test]