browser(firefox): allow setting colorScheme on the context level

pavelfeldman · Apr 6, 2020 · ff36704 · ff36704
1 parent 19019c9
commit ff36704
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 6 deletions.
diff --git a/docshell/base/nsDocShell.cpp b/docshell/base/nsDocShell.cpp
@@ -363,6 +363,7 @@ nsDocShell::nsDocShell(BrowsingContext* aBrowsingContext,
       mFileInputInterceptionEnabled(false),
       mBypassCSPEnabled(false),
       mOnlineOverride(nsIDocShell::ONLINE_OVERRIDE_NONE),
+      mColorSchemeOverride(COLOR_SCHEME_OVERRIDE_NONE),
       mAllowAuth(mItemType == typeContent),
       mAllowKeywordFixup(false),
       mIsOffScreenBrowser(false),
@@ -3501,6 +3502,18 @@ nsDocShell::SetOnlineOverride(OnlineOverride aOnlineOverride) {
   return NS_OK;
 }
 
+NS_IMETHODIMP
+nsDocShell::GetColorSchemeOverride(ColorSchemeOverride* aColorSchemeOverride) {
+  *aColorSchemeOverride = GetRootDocShell()->mColorSchemeOverride;
+  return NS_OK;
+}
+
+NS_IMETHODIMP
+nsDocShell::SetColorSchemeOverride(ColorSchemeOverride aColorSchemeOverride) {
+  mColorSchemeOverride = aColorSchemeOverride;
+  return NS_OK;
+}
+
 // =============== Juggler End =======================
 
 NS_IMETHODIMP

diff --git a/docshell/base/nsDocShell.h b/docshell/base/nsDocShell.h
@@ -1308,6 +1308,7 @@ class nsDocShell final : public nsDocLoader,
   nsString mLanguageOverride;
   RefPtr<nsGeolocationService> mGeolocationServiceOverride;
   OnlineOverride mOnlineOverride;
+  ColorSchemeOverride mColorSchemeOverride;
 
   bool mAllowAuth : 1;
   bool mAllowKeywordFixup : 1;

diff --git a/docshell/base/nsIDocShell.idl b/docshell/base/nsIDocShell.idl
@@ -1146,5 +1146,13 @@ interface nsIDocShell : nsIDocShellTreeItem
   };
   [infallible] attribute nsIDocShell_OnlineOverride onlineOverride;
 
+  cenum ColorSchemeOverride : 8 {
+    COLOR_SCHEME_OVERRIDE_LIGHT,
+    COLOR_SCHEME_OVERRIDE_DARK,
+    COLOR_SCHEME_OVERRIDE_NO_PREFERENCE,
+    COLOR_SCHEME_OVERRIDE_NONE, /* This clears the override. */
+  };
+  [infallible] attribute nsIDocShell_ColorSchemeOverride colorSchemeOverride;
+
   void setGeolocationOverride(in nsIDOMGeoPosition position);
 };
diff --git a/dom/base/Document.cpp b/dom/base/Document.cpp
@@ -16122,6 +16122,20 @@ void Document::RemoveToplevelLoadingDocument(Document* aDoc) {
 }
 
 StylePrefersColorScheme Document::PrefersColorScheme() const {
+  auto* docShell = static_cast<nsDocShell*>(GetDocShell());
+  nsIDocShell::ColorSchemeOverride colorScheme;
+  if (docShell->GetColorSchemeOverride(&colorScheme) == NS_OK &&
+      colorScheme != nsIDocShell::COLOR_SCHEME_OVERRIDE_NONE) {
+    switch (colorScheme) {
+      case nsIDocShell::COLOR_SCHEME_OVERRIDE_LIGHT:
+        return StylePrefersColorScheme::Light;
+      case nsIDocShell::COLOR_SCHEME_OVERRIDE_DARK:
+        return StylePrefersColorScheme::Dark;
+      case nsIDocShell::COLOR_SCHEME_OVERRIDE_NO_PREFERENCE:
+        return StylePrefersColorScheme::NoPreference;
+    };
+  }
+
   if (nsContentUtils::ShouldResistFingerprinting(this)) {
     return StylePrefersColorScheme::Light;
   }

diff --git a/juggler/TargetRegistry.js b/juggler/TargetRegistry.js
@@ -327,6 +327,10 @@ class PageTarget {
     await this._channel.connect('').send('setOnlineOverride', override).catch(e => void e);
   }
 
+  async setColorScheme(colorScheme) {
+    await this._channel.connect('').send('setColorScheme', colorScheme).catch(e => void e);
+  }
+
   async hasFailedToOverrideTimezone() {
     return await this._channel.connect('').send('hasFailedToOverrideTimezone').catch(e => true);
   }
@@ -413,6 +417,11 @@ class BrowserContext {
     await Promise.all(Array.from(this.pages).map(page => page.setOnlineOverride(override)));
   }
 
+  async setColorScheme(colorScheme) {
+    this.options.colorScheme = colorScheme;
+    await Promise.all(Array.from(this.pages).map(page => page.setColorScheme(colorScheme)));
+  }
+
   async grantPermissions(origin, permissions) {
     this._permissions.set(origin, permissions);
     const promises = [];

diff --git a/juggler/content/FrameTree.js b/juggler/content/FrameTree.js
@@ -134,6 +134,16 @@ class FrameTree {
       frame._addBinding(name, script);
   }
 
+  setColorScheme(colorScheme) {
+    const docShell = this._mainFrame._docShell;
+    switch (colorScheme) {
+      case 'light': docShell.colorSchemeOverride = Ci.nsIDocShell.COLOR_SCHEME_OVERRIDE_LIGHT; break;
+      case 'dark': docShell.colorSchemeOverride = Ci.nsIDocShell.COLOR_SCHEME_OVERRIDE_DARK; break;
+      case 'no-preference': docShell.colorSchemeOverride = Ci.nsIDocShell.COLOR_SCHEME_OVERRIDE_NO_PREFERENCE; break;
+      default: docShell.colorSchemeOverride = Ci.nsIDocShell.COLOR_SCHEME_OVERRIDE_NONE; break;
+    }
+  }
+
   frameForDocShell(docShell) {
     return this._docShellToFrame.get(docShell) || null;
   }

diff --git a/juggler/content/PageAgent.js b/juggler/content/PageAgent.js
@@ -184,11 +184,7 @@ class PageAgent {
       cv.stopEmulatingMedium();
     else if (type)
       cv.emulateMedium(type);
-    switch (colorScheme) {
-      case 'light': cv.emulatePrefersColorScheme(cv.PREFERS_COLOR_SCHEME_LIGHT); break;
-      case 'dark': cv.emulatePrefersColorScheme(cv.PREFERS_COLOR_SCHEME_DARK); break;
-      case 'no-preference': cv.emulatePrefersColorScheme(cv.PREFERS_COLOR_SCHEME_NO_PREFERENCE); break;
-    }
+    this._frameTree.setColorScheme(colorScheme);
   }
 
   _addScriptToEvaluateOnNewDocument({script, worldName}) {

diff --git a/juggler/content/main.js b/juggler/content/main.js
@@ -65,7 +65,7 @@ function initialize() {
     response = { sessionIds: [], browserContextOptions: {} };
 
   const { sessionIds, browserContextOptions } = response;
-  const { userAgent, bypassCSP, javaScriptDisabled, viewport, scriptsToEvaluateOnNewDocument, bindings, locale, timezoneId, geolocation, onlineOverride } = browserContextOptions;
+  const { userAgent, bypassCSP, javaScriptDisabled, viewport, scriptsToEvaluateOnNewDocument, bindings, locale, timezoneId, geolocation, onlineOverride, colorScheme } = browserContextOptions;
 
   let failedToOverrideTimezone = false;
   if (timezoneId)
@@ -90,6 +90,8 @@ function initialize() {
   }
 
   frameTree = new FrameTree(docShell);
+  if (colorScheme !== undefined)
+    frameTree.setColorScheme(colorScheme);
   for (const script of scriptsToEvaluateOnNewDocument || [])
     frameTree.addScriptToEvaluateOnNewDocument(script);
   for (const { name, script } of bindings || [])
@@ -126,6 +128,10 @@ function initialize() {
       setOnlineOverrideInDocShell(override);
     },
 
+    setColorScheme(colorScheme) {
+      frameTree.setColorScheme(colorScheme);
+    },
+
     ensurePermissions() {
       // noop, just a rountrip.
     },

diff --git a/juggler/protocol/BrowserHandler.js b/juggler/protocol/BrowserHandler.js
@@ -149,6 +149,10 @@ class BrowserHandler {
     await this._targetRegistry.browserContextForId(browserContextId).setOnlineOverride(override);
   }
 
+  async setColorScheme({browserContextId, colorScheme}) {
+    await this._targetRegistry.browserContextForId(browserContextId).setColorScheme(colorScheme);
+  }
+
   async addScriptToEvaluateOnNewDocument({browserContextId, script}) {
     await this._targetRegistry.browserContextForId(browserContextId).addScriptToEvaluateOnNewDocument(script);
   }

diff --git a/juggler/protocol/Protocol.js b/juggler/protocol/Protocol.js
@@ -314,6 +314,12 @@ const Browser = {
         override: t.Optional(t.Enum(['online', 'offline'])),
       }
     },
+    'setColorScheme': {
+      params: {
+        browserContextId: t.Optional(t.String),
+        colorScheme: t.Optional(t.Enum(['dark', 'light', 'no-preference'])),
+      },
+    },
   },
 };