Skip to content

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

Closes EMB-851 static embed pin map (#63897)

Sébastien3c2d46151b19
diff --git a/frontend/src/metabase/visualizations/lib/map.ts b/frontend/src/metabase/visualizations/lib/map.ts
index 2eb11955749..eb8aeb62b15 100644
--- a/frontend/src/metabase/visualizations/lib/map.ts
+++ b/frontend/src/metabase/visualizations/lib/map.ts
@@ -1,3 +1,5 @@
+import { IS_EMBED_PREVIEW } from "metabase/lib/embed";
+import { isJWT } from "metabase/lib/utils";
import { isUuid } from "metabase/lib/uuid";
import type { DashboardId, Dataset, JsonQuery } from "metabase-types/api";
@@ -45,9 +47,14 @@ export function getTileUrl(params: TileUrlParams): string {
return adhocQueryTileUrl(zoom, coord, latField, lonField, datasetQuery);
}
- if (typeof dashboardId === "string" && !isUuid(dashboardId)) {
- throw Error("dashboardId must be an int or a uuid");
+ if (
+ typeof dashboardId === "string" &&
+ !isUuid(dashboardId) && // public dashboard
+ !isJWT(dashboardId) // embedded dashboard
+ ) {
+ throw new Error("dashboardId must be an int, an uuid or a jwt");
}
+
const isPublicDashboard = uuid;
if (isPublicDashboard) {
@@ -233,7 +240,8 @@ function embedDashboardTileUrl(
lonField: string,
parameters?: unknown[],
): string {
- let url = `/api/embed/tiles/dashboard/${token}/dashcard/${dashcardId}/card/${cardId}/${zoom}/${coord.x}/${coord.y}/${latField}/${lonField}`;
+ const endpoint = IS_EMBED_PREVIEW ? "preview_embed" : "embed";
+ let url = `/api/${endpoint}/tiles/dashboard/${token}/dashcard/${dashcardId}/card/${cardId}/${zoom}/${coord.x}/${coord.y}/${latField}/${lonField}`;
if (parameters && parameters.length > 0) {
url += `?parameters=${encodeURIComponent(JSON.stringify(parameters))}`;
}
diff --git a/frontend/src/metabase/visualizations/lib/map.unit.spec.ts b/frontend/src/metabase/visualizations/lib/map.unit.spec.ts
index 7924e57bb5b..43f2f1a703f 100644
--- a/frontend/src/metabase/visualizations/lib/map.unit.spec.ts
+++ b/frontend/src/metabase/visualizations/lib/map.unit.spec.ts
@@ -265,9 +265,12 @@ describe("map", () => {
});
describe("embed dashboard", () => {
+ const jwt = "th1s-l00ks-lik3.a-jwt-t0k3n.bu7-1s-n07"; // embedded dashboards have a JWT instead of an id
+
it("should generate url for embed dashboard without parameters", () => {
const url = getTileUrl({
- dashboardId: 10,
+ // embedded dashboards have a JWT instead of an id
+ dashboardId: jwt,
dashcardId: 20,
cardId: 30,
zoom,
@@ -290,7 +293,7 @@ describe("map", () => {
});
const url = getTileUrl({
- dashboardId: 10,
+ dashboardId: jwt,
dashcardId: 20,
cardId: 30,
zoom,
diff --git a/src/metabase/embedding/api/preview_embed.clj b/src/metabase/embedding/api/preview_embed.clj
index b45f60f63ea..402a4a198b1 100644
--- a/src/metabase/embedding/api/preview_embed.clj
+++ b/src/metabase/embedding/api/preview_embed.clj
@@ -15,6 +15,9 @@
[metabase.embedding.jwt :as embed]
[metabase.embedding.validation :as embedding.validation]
[metabase.query-processor.pivot :as qp.pivot]
+ [metabase.request.core :as request]
+ [metabase.tiles.api :as api.tiles]
+ [metabase.util.json :as json]
[metabase.util.malli.schema :as ms]
[ring.util.codec :as codec]))
@@ -144,3 +147,41 @@
:token-params token-params
:query-params (api.embed.common/parse-query-params query-params)
:qp qp.pivot/run-pivot-query)))
+
+(api.macros/defendpoint :get "/tiles/card/:token/:zoom/:x/:y/:lat-field/:lon-field"
+ "Generates a single tile image for an embedded Card using the map visualization."
+ [{:keys [token zoom x y lat-field lon-field]}
+ :- [:merge
+ :api.tiles/route-params
+ [:map
+ [:token string?]]]
+ {:keys [parameters]}
+ :- [:map
+ [:parameters {:optional true} ms/JSONString]]]
+ (let [unsigned-token (check-and-unsign token)
+ card-id (api.embed.common/unsigned-token->card-id unsigned-token)
+ parameters (json/decode+kw parameters)
+ lat-field (json/decode+kw lat-field)
+ lon-field (json/decode+kw lon-field)]
+ (request/as-admin
+ (api.tiles/process-tiles-query-for-card card-id parameters zoom x y lat-field lon-field))))
+
+(api.macros/defendpoint :get "/tiles/dashboard/:token/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y/:lat-field/:lon-field"
+ "Generates a single tile image for a Card on an embedded Dashboard using the map visualization."
+ [{:keys [token dashcard-id card-id zoom x y lat-field lon-field]}
+ :- [:merge
+ :api.tiles/route-params
+ [:map
+ [:token string?]
+ [:dashcard-id ms/PositiveInt]
+ [:card-id ms/PositiveInt]]]
+ {:keys [parameters]}
+ :- [:map
+ [:parameters {:optional true} ms/JSONString]]]
+ (let [unsigned-token (check-and-unsign token)
+ dashboard-id (embed/get-in-unsigned-token-or-throw unsigned-token [:resource :dashboard])
+ parameters (json/decode+kw parameters)
+ lat-field (json/decode+kw lat-field)
+ lon-field (json/decode+kw lon-field)]
+ (request/as-admin
+ (api.tiles/process-tiles-query-for-dashcard dashboard-id dashcard-id card-id parameters zoom x y lat-field lon-field))))
diff --git a/test/metabase/embedding/api/preview_embed_test.clj b/test/metabase/embedding/api/preview_embed_test.clj
index 7d34c3f10de..95fcbe5a254 100644
--- a/test/metabase/embedding/api/preview_embed_test.clj
+++ b/test/metabase/embedding/api/preview_embed_test.clj
@@ -8,6 +8,7 @@
[metabase.embedding.api.preview-embed :as api.preview-embed]
[metabase.query-processor.pivot.test-util :as api.pivots]
[metabase.test :as mt]
+ [metabase.tiles.api-test :as tiles.api-test]
[metabase.util :as u]
[metabase.util.json :as json]
[toucan2.core :as t2]))
@@ -663,3 +664,47 @@
:parameters (json/encode {:NAME "513"}))
:data
:rows))))))))))
+
+;;; ------------------------------------------ Tile endpoints ---------------------------------------------------------
+
+(defn- png? [s]
+ (= [\P \N \G] (drop 1 (take 4 s))))
+
+(defn- venues-query
+ []
+ {:database (mt/id)
+ :type :query
+ :query {:source-table (mt/id :people)
+ :fields [[:field (mt/id :people :id) nil]
+ [:field (mt/id :people :state) nil]
+ [:field (mt/id :people :latitude) nil]
+ [:field (mt/id :people :longitude) nil]]}})
+
+(deftest card-tile-query-test
+ (testing "GET api/preview_embed/tiles/card/:uuid/:zoom/:x/:y/:lat-field/:lon-field"
+ (embed-test/with-embedding-enabled-and-new-secret-key!
+ (mt/with-temp [:model/Card {card-id :id} {:dataset_query (venues-query)
+ :enable_embedding true}]
+ (let [token (embed-test/card-token card-id)]
+ (is (png? (mt/user-http-request
+ :crowberto :get 200 (format "preview_embed/tiles/card/%s/1/1/1/%s/%s"
+ token
+ (tiles.api-test/encoded-lat-field-ref)
+ (tiles.api-test/encoded-lon-field-ref))))))))))
+
+(deftest dashcard-tile-query-test
+ (testing "GET api/preview_embed/tiles/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y/:lat-field/:lon-field"
+ (embed-test/with-embedding-enabled-and-new-secret-key!
+ (mt/with-temp [:model/Dashboard {dashboard-id :id} {:enable_embedding true}
+
+ :model/Card {card-id :id} {:dataset_query (venues-query)}
+ :model/DashboardCard {dashcard-id :id} {:card_id card-id
+ :dashboard_id dashboard-id}]
+ (let [token (embed-test/dash-token dashboard-id)]
+ (is (png? (mt/user-http-request
+ :crowberto :get 200 (format "preview_embed/tiles/dashboard/%s/dashcard/%d/card/%d/1/1/1/%s/%s"
+ token
+ dashcard-id
+ card-id
+ (tiles.api-test/encoded-lat-field-ref)
+ (tiles.api-test/encoded-lon-field-ref))))))))))