The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Don't send new user login for SDK or Embedded Analytics JS (#63883)
Mahatthana (Kelvin) Nomsawadie60e38682be0
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.ednindex 38fd34124d9..16db4768ab3 100644--- a/.clj-kondo/config/modules/config.edn+++ b/.clj-kondo/config/modules/config.edn@@ -502,6 +502,7 @@metabase.embedding.initmetabase.embedding.jwtmetabase.embedding.settings+ metabase.embedding.utilmetabase.embedding.validation}:uses #{analyticsapi@@ -1020,6 +1021,7 @@metabase.request.schema}:uses #{apiconfig+ embeddingpermissions ; FIXMEsessionsettingsdiff --git a/enterprise/backend/src/metabase_enterprise/sso/integrations/jwt.clj b/enterprise/backend/src/metabase_enterprise/sso/integrations/jwt.cljindex ebb75e300e2..d37b87ed0c9 100644--- a/enterprise/backend/src/metabase_enterprise/sso/integrations/jwt.clj+++ b/enterprise/backend/src/metabase_enterprise/sso/integrations/jwt.clj@@ -9,6 +9,7 @@[metabase-enterprise.sso.integrations.token-utils :as token-utils][metabase-enterprise.sso.settings :as sso-settings][metabase.embedding.settings :as embed.settings]+ [metabase.embedding.util :as embed.util][metabase.premium-features.core :as premium-features][metabase.request.core :as request][metabase.session.models.session :as session]@@ -155,14 +156,14 @@[{{:keys [jwt redirect]} :params, :as request}](premium-features/assert-has-feature :sso-jwt (tru "JWT-based authentication"))(let [jwt-data (when jwt (session-data jwt request))- is-react-sdk? (sso-utils/is-react-sdk-header? request)- is-simple-embed? (sso-utils/is-simple-embed-header? request)- is-embed? (or is-react-sdk? is-simple-embed?)]+ is-react-sdk? (embed.util/has-react-sdk-header? request)+ is-embedded-analytics-js? (embed.util/has-embedded-analytics-js-header? request)+ is-modular-embedding? (or is-react-sdk? is-embedded-analytics-js?)](cond(and is-react-sdk? (not (embed.settings/enable-embedding-sdk))) (throw-react-sdk-embedding-disabled)- (and is-simple-embed? (not (embed.settings/enable-embedding-simple))) (throw-simple-embedding-disabled)- (and is-embed? jwt (token-utils/has-token request)) (generate-response-token (:session jwt-data) (:jwt-data jwt-data))- is-embed? (response/response (token-utils/with-token {:url (sso-settings/jwt-identity-provider-uri) :method "jwt"}))+ (and is-embedded-analytics-js? (not (embed.settings/enable-embedding-simple))) (throw-simple-embedding-disabled)+ (and is-modular-embedding? jwt (token-utils/has-token request)) (generate-response-token (:session jwt-data) (:jwt-data jwt-data))+ is-modular-embedding? (response/response (token-utils/with-token {:url (sso-settings/jwt-identity-provider-uri) :method "jwt"}))jwt (request/set-session-cookies request(response/redirect (:redirect-url jwt-data))(:session jwt-data)diff --git a/enterprise/backend/src/metabase_enterprise/sso/integrations/saml.clj b/enterprise/backend/src/metabase_enterprise/sso/integrations/saml.cljindex 22b0147640d..e288e4dd520 100644--- a/enterprise/backend/src/metabase_enterprise/sso/integrations/saml.clj+++ b/enterprise/backend/src/metabase_enterprise/sso/integrations/saml.clj@@ -39,6 +39,7 @@[metabase-enterprise.sso.settings :as sso-settings][metabase.api.common :as api][metabase.channel.urls :as urls]+ [metabase.embedding.util :as embed.util][metabase.premium-features.core :as premium-features][metabase.request.core :as request][metabase.session.core :as session]@@ -135,7 +136,7 @@[req](let [redirect (get-in req [:params :redirect])origin (get-in req [:headers "origin"])- embedding-sdk-header? (or (sso-utils/is-react-sdk-header? req) (sso-utils/is-simple-embed-header? req))]+ embedding-sdk-header? (embed.util/is-modular-embedding-request? req)](cond;; Case 1: Embedding SDK header is present - use ACS URL with token and origin@@ -163,7 +164,7 @@(premium-features/assert-has-feature :sso-saml (tru "SAML-based authentication"))(check-saml-enabled)(let [redirect (get-in req [:params :redirect])- embedding-sdk-header? (or (sso-utils/is-react-sdk-header? req) (sso-utils/is-simple-embed-header? req))+ embedding-sdk-header? (embed.util/is-modular-embedding-request? req)redirect-url (construct-redirect-url req)](sso-utils/check-sso-redirect redirect)(trydiff --git a/enterprise/backend/src/metabase_enterprise/sso/integrations/sso_utils.clj b/enterprise/backend/src/metabase_enterprise/sso/integrations/sso_utils.cljindex 3bbbd6e2b5d..12ad30c50fa 100644--- a/enterprise/backend/src/metabase_enterprise/sso/integrations/sso_utils.clj+++ b/enterprise/backend/src/metabase_enterprise/sso/integrations/sso_utils.clj@@ -126,16 +126,6 @@{:status-code 400:redirect-url redirect-url})))))-(defn is-react-sdk-header?- "Check if the client has indicated it is from the react embedding sdk"- [request]- (= (get-in request [:headers "x-metabase-client"]) "embedding-sdk-react"))--(defn is-simple-embed-header?- "Check if the client has indicated it is from simple embedding"- [request]- (= (get-in request [:headers "x-metabase-client"]) "embedding-simple"))-(defn filter-non-stringable-attributes"Removes vectors and map json attribute values that cannot be turned into strings."[attrs]diff --git a/enterprise/backend/test/metabase_enterprise/sso/integrations/sso_utils_test.clj b/enterprise/backend/test/metabase_enterprise/sso/integrations/sso_utils_test.cljindex f2194979239..93f130d6ed6 100644--- a/enterprise/backend/test/metabase_enterprise/sso/integrations/sso_utils_test.clj+++ b/enterprise/backend/test/metabase_enterprise/sso/integrations/sso_utils_test.clj@@ -56,13 +56,3 @@(into [] cat)(map :subject)(filter #(str/includes? % "You're invited to join")))))))))--(deftest is-embedding-header-test- (testing "is-react-sdk-header? detects embedding-sdk-react client header"- (is (sso-utils/is-react-sdk-header? {:headers {"x-metabase-client" "embedding-sdk-react"}})))- (testing "is-react-sdk-header? returns false for other client headers"- (is (not (sso-utils/is-react-sdk-header? {:headers {"x-metabase-client" "embedding-iframe"}}))))- (testing "is-simple-embed-header? detects embedding-simple client header"- (is (sso-utils/is-simple-embed-header? {:headers {"x-metabase-client" "embedding-simple"}})))- (testing "is-simple-embed-header? returns false for other client headers"- (is (not (sso-utils/is-simple-embed-header? {:headers {"x-metabase-client" "embedding-iframe"}})))))diff --git a/src/metabase/embedding/util.clj b/src/metabase/embedding/util.cljnew file mode 100644index 00000000000..070225de9b5--- /dev/null+++ b/src/metabase/embedding/util.clj@@ -0,0 +1,21 @@+(ns metabase.embedding.util+ "Utility functions for common operations related to embedding.")++(def ^:private embedding-sdk-client "embedding-sdk-react")+(def ^:private embedded-analytics-js-client "embedding-simple")++(defn has-react-sdk-header?+ "Check if the client has indicated it is from the Embedding SDK for React "+ [request]+ (= (get-in request [:headers "x-metabase-client"]) embedding-sdk-client))++(defn has-embedded-analytics-js-header?+ "Check if the client has indicated it is from Embedded Analytics JS"+ [request]+ (= (get-in request [:headers "x-metabase-client"]) embedded-analytics-js-client))++(defn is-modular-embedding-request?+ "Check if the request is either from Embedding SDK for React or from Embedded Analytics JS"+ [request]+ (or (has-react-sdk-header? request)+ (has-embedded-analytics-js-header? request)))diff --git a/src/metabase/request/util.clj b/src/metabase/request/util.cljindex ece8d001d14..0116dbf870c 100644--- a/src/metabase/request/util.clj+++ b/src/metabase/request/util.clj@@ -5,6 +5,7 @@[clojure.string :as str][java-time.api :as t][metabase.config.core :as config]+ [metabase.embedding.util :as embed.util][metabase.request.settings :as request.settings][metabase.util :as u][metabase.util.i18n :refer [trs tru]]@@ -105,7 +106,7 @@(mu/defn device-info :- DeviceInfo"Information about the device that made this request, as recorded by the `LoginHistory` table."- [{{:strs [user-agent]} :headers, {:strs [token]} :query-params, :keys [browser-id], :as request}]+ [{{:strs [user-agent]} :headers, :keys [browser-id], :as request}](let [id (or browser-id(log/warn "Login request is missing device ID information"))description (or user-agent@@ -116,7 +117,7 @@(log/warn "Error determining login history for request")){:device_id (or id (trs "unknown")):device_description (or description (trs "unknown")),- :embedded (= "true" token)+ :embedded (embed.util/is-modular-embedding-request? request):ip_address (or ip-address (trs "unknown"))}))(defn describe-user-agentdiff --git a/test/metabase/embedding/util_test.clj b/test/metabase/embedding/util_test.cljnew file mode 100644index 00000000000..43bd8bde34d--- /dev/null+++ b/test/metabase/embedding/util_test.clj@@ -0,0 +1,22 @@+(ns metabase.embedding.util-test+ (:require+ [clojure.test :refer :all]+ [metabase.embedding.util :as embed.util]))++(deftest is-embedding-header-test+ (testing "has-react-sdk-header? detects embedding-sdk-react client header"+ (is (embed.util/has-react-sdk-header? {:headers {"x-metabase-client" "embedding-sdk-react"}})))+ (testing "has-react-sdk-header? returns false for other client headers"+ (is (not (embed.util/has-react-sdk-header? {:headers {"x-metabase-client" "embedding-iframe"}}))))+ (testing "has-embedded-analytics-js-header? detects embedding-simple client header"+ (is (embed.util/has-embedded-analytics-js-header? {:headers {"x-metabase-client" "embedding-simple"}})))+ (testing "has-embedded-analytics-js-header? returns false for other client headers"+ (is (not (embed.util/has-embedded-analytics-js-header? {:headers {"x-metabase-client" "embedding-iframe"}})))))++(deftest is-modular-embedding-request-test+ (testing "is-modular-embedding-request? detects embedding-sdk-react client header"+ (is (embed.util/is-modular-embedding-request? {:headers {"x-metabase-client" "embedding-sdk-react"}})))+ (testing "is-modular-embedding-request? detects embedding-simple client header"+ (is (embed.util/is-modular-embedding-request? {:headers {"x-metabase-client" "embedding-simple"}})))+ (testing "is-modular-embedding-request? returns false for other client headers"+ (is (not (embed.util/is-modular-embedding-request? {:headers {"x-metabase-client" "embedding-iframe"}})))))diff --git a/test/metabase/request/util_test.clj b/test/metabase/request/util_test.cljindex 2ab0cfc5eb2..3d900434014 100644--- a/test/metabase/request/util_test.clj+++ b/test/metabase/request/util_test.clj@@ -34,12 +34,18 @@:embedded false:ip_address "0:0:0:0:0:0:0:1"}(req.util/device-info @mock-request))))- (testing "Embedded request"+ (testing "SDK request"(is (= {:device_id "129d39d1-6758-4d2c-a751-35b860007002":device_description "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.72 Safari/537.36":embedded true:ip_address "0:0:0:0:0:0:0:1"}- (req.util/device-info (update @mock-request :query-params assoc "token" "true"))))))+ (req.util/device-info (update @mock-request :headers assoc "x-metabase-client" "embedding-sdk-react")))))+ (testing "Embedded Analytics JS request"+ (is (= {:device_id "129d39d1-6758-4d2c-a751-35b860007002"+ :device_description "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.72 Safari/537.36"+ :embedded true+ :ip_address "0:0:0:0:0:0:0:1"}+ (req.util/device-info (update @mock-request :headers assoc "x-metabase-client" "embedding-simple"))))))(deftest ^:parallel describe-user-agent-test(are [user-agent expected] (= expected (req.util/describe-user-agent user-agent))