Skip to content

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

fix(embed-js): black background is shown on systems with dark mode preferences (#65534)

Phoomparin Manof893c48fde62
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts
index a7228aed53b..2e2d0804a75 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts
@@ -465,6 +465,26 @@ describe("scenarios > embedding > sdk iframe embedding > custom elements api", (
H.getSimpleEmbedIframeContent().should("not.contain", "Orders model");
});
});
+
+ it("should not define color-scheme meta tag on embeds (metabase#65533)", () => {
+ H.visitCustomHtmlPage(`
+ ${H.getNewEmbedScriptTag()}
+ ${H.getNewEmbedConfigurationScript()}
+ <metabase-question question-id="new" />
+ `);
+
+ H.waitForSimpleEmbedIframesToLoad();
+
+ cy.get("iframe[data-metabase-embed]")
+ .its("0.contentDocument")
+ .within(() => {
+ cy.log("a generic meta tag should exist");
+ cy.get("meta[name='viewport']").should("exist");
+
+ cy.log("the color-scheme tag should not exist on EAJS embeds");
+ cy.get("meta[name='color-scheme']").should("not.exist");
+ });
+ });
});
describe("sync vs async vs defer script loading", () => {
diff --git a/resources/frontend_client/index_template.html b/resources/frontend_client/index_template.html
index a713e1d663f..252f22a64d1 100644
--- a/resources/frontend_client/index_template.html
+++ b/resources/frontend_client/index_template.html
@@ -16,7 +16,10 @@
<meta name="apple-mobile-web-app-status-bar-style" content="default" />
<meta name="base-href" content="{{{baseHref}}}" />
<meta name="uri" content="{{{uri}}}" />
+
+ {{#hasColorSchemeMetaTag}}
<meta name="color-scheme" content="light dark" />
+ {{/hasColorSchemeMetaTag}}
{{{embedCode}}}
diff --git a/src/metabase/server/routes/index.clj b/src/metabase/server/routes/index.clj
index dd32769477e..fd4a1bba38b 100644
--- a/src/metabase/server/routes/index.clj
+++ b/src/metabase/server/routes/index.clj
@@ -78,33 +78,35 @@
(throw (Exception. message e))))))
(defn- template-parameters
- [embeddable? {:keys [uri params nonce]}]
+ [entrypoint-name embeddable? {:keys [uri params nonce]}]
(let [{:keys [anon-tracking-enabled google-auth-client-id], :as public-settings} (setting/user-readable-values-map #{:public})
;; We disable `locale` parameter on static embeds/public links (metabase#50313)
should-load-locale-params? (not embeddable?)]
- {:bootstrapJS (load-inline-js "index_bootstrap")
- :bootstrapJSON (escape-script (json/encode public-settings))
- :assetOnErrorJS (load-inline-js "asset_loading_error")
- :userLocalizationJSON (escape-script (load-localization (when should-load-locale-params? (:locale params))))
- :siteLocalizationJSON (escape-script (load-localization (system/site-locale)))
- :nonceJSON (escape-script (json/encode nonce))
- :language (hiccup.util/escape-html (or (i18n/user-locale-string) (system/site-locale)))
- :favicon (hiccup.util/escape-html (let [custom-favicon (appearance/application-favicon-url)]
- (if (and config/is-dev?
- (= custom-favicon "app/assets/img/favicon.ico"))
- "app/assets/img/favicon-dev.ico"
- custom-favicon)))
- :applicationName (hiccup.util/escape-html (appearance/application-name))
- :uri (hiccup.util/escape-html uri)
- :baseHref (hiccup.util/escape-html (base-href))
- :embedCode (when embeddable? (embed/head uri))
- :enableGoogleAuth (boolean google-auth-client-id)
- :enableAnonTracking (boolean anon-tracking-enabled)}))
+ {:bootstrapJS (load-inline-js "index_bootstrap")
+ :bootstrapJSON (escape-script (json/encode public-settings))
+ :assetOnErrorJS (load-inline-js "asset_loading_error")
+ :userLocalizationJSON (escape-script (load-localization (when should-load-locale-params? (:locale params))))
+ :siteLocalizationJSON (escape-script (load-localization (system/site-locale)))
+ :nonceJSON (escape-script (json/encode nonce))
+ :language (hiccup.util/escape-html (or (i18n/user-locale-string) (system/site-locale)))
+ :favicon (hiccup.util/escape-html (let [custom-favicon (appearance/application-favicon-url)]
+ (if (and config/is-dev?
+ (= custom-favicon "app/assets/img/favicon.ico"))
+ "app/assets/img/favicon-dev.ico"
+ custom-favicon)))
+ :applicationName (hiccup.util/escape-html (appearance/application-name))
+ :uri (hiccup.util/escape-html uri)
+ :baseHref (hiccup.util/escape-html (base-href))
+ :embedCode (when embeddable? (embed/head uri))
+ :enableGoogleAuth (boolean google-auth-client-id)
+ :enableAnonTracking (boolean anon-tracking-enabled)
+ ;; (metabase#65533) color-scheme meta tag breaks EAJS because it has a transparent background.
+ :hasColorSchemeMetaTag (not= entrypoint-name "embed-sdk")}))
(defn- load-entrypoint-template [entrypoint-name embeddable? opts]
(load-template
(str "frontend_client/" entrypoint-name ".html")
- (template-parameters embeddable? opts)))
+ (template-parameters entrypoint-name embeddable? opts)))
(defn- load-init-template []
(load-template
diff --git a/test/metabase/server/routes/index_test.clj b/test/metabase/server/routes/index_test.clj
index 6239b174a8c..542e645ebcb 100644
--- a/test/metabase/server/routes/index_test.clj
+++ b/test/metabase/server/routes/index_test.clj
@@ -76,12 +76,12 @@
(deftest load-entrypoint-template-contains-user-locale
(binding [i18n/*user-locale* "es"]
- (is (= "es" (:language (#'index/template-parameters false {})))))
+ (is (= "es" (:language (#'index/template-parameters "index" false {})))))
(binding [i18n/*user-locale* "en"]
- (is (= "en" (:language (#'index/template-parameters false {})))))
+ (is (= "en" (:language (#'index/template-parameters "index" false {})))))
(mt/with-temporary-setting-values [site-locale "es"]
;; site locale is used as the default
- (is (= "es" (:language (#'index/template-parameters false {}))))
+ (is (= "es" (:language (#'index/template-parameters "index" false {}))))
;; but we can override with the user locale
(binding [i18n/*user-locale* "fr"]
- (is (= "fr" (:language (#'index/template-parameters false {})))))))
+ (is (= "fr" (:language (#'index/template-parameters "index" false {})))))))