Bug 1752332: Move ShouldSyncPreferences to Preferences module r=KrisW…

…right Depends on D141409 Differential Revision: https://phabricator.services.mozilla.com/D141410
iaxat · Apr 20, 2022 · df927bd · df927bd
1 parent 0e11fa9
commit df927bd
Show file tree

Hide file tree

Showing 14 changed files with 49 additions and 50 deletions.
diff --git a/dom/ipc/ContentParent.cpp b/dom/ipc/ContentParent.cpp
@@ -3786,39 +3786,6 @@ ContentParent::Observe(nsISupports* aSubject, const char* aTopic,
   return NS_OK;
 }
 
-/* static */
-bool ContentParent::ShouldSyncPreference(const char* aPref) {
-#define PREF_LIST_ENTRY(s) \
-  { s, (sizeof(s) / sizeof(char)) - 1 }
-  struct PrefListEntry {
-    const char* mPrefBranch;
-    size_t mLen;
-  };
-
-  // These prefs are not useful in child processes.
-  static const PrefListEntry sParentOnlyPrefBranchList[] = {
-      PREF_LIST_ENTRY("app.update.lastUpdateTime."),
-      PREF_LIST_ENTRY("datareporting.policy."),
-      PREF_LIST_ENTRY("browser.safebrowsing.provider."),
-      PREF_LIST_ENTRY("browser.shell."),
-      PREF_LIST_ENTRY("browser.slowStartup."),
-      PREF_LIST_ENTRY("browser.startup."),
-      PREF_LIST_ENTRY("extensions.getAddons.cache."),
-      PREF_LIST_ENTRY("media.gmp-manager."),
-      PREF_LIST_ENTRY("media.gmp-gmpopenh264."),
-      PREF_LIST_ENTRY("privacy.sanitize."),
-  };
-#undef PREF_LIST_ENTRY
-
-  for (const auto& entry : sParentOnlyPrefBranchList) {
-    if (strncmp(entry.mPrefBranch, aPref, entry.mLen) == 0) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
 void ContentParent::UpdateNetworkLinkType() {
   nsresult rv;
   nsCOMPtr<nsINetworkLinkService> nls =

diff --git a/dom/ipc/ContentParent.h b/dom/ipc/ContentParent.h
@@ -1460,8 +1460,6 @@ class ContentParent final
 
   void UpdateNetworkLinkType();
 
-  static bool ShouldSyncPreference(const char* aPref);
-
   already_AddRefed<JSActor> InitJSActor(JS::HandleObject aMaybeActor,
                                         const nsACString& aName,
                                         ErrorResult& aRv) override;

diff --git a/dom/media/ipc/RDDProcessHost.cpp b/dom/media/ipc/RDDProcessHost.cpp
@@ -46,8 +46,8 @@ bool RDDProcessHost::Launch(StringVector aExtraOpts) {
   MOZ_ASSERT(mLaunchPhase == LaunchPhase::Unlaunched);
   MOZ_ASSERT(!mRDDChild);
 
-  mPrefSerializer = MakeUnique<ipc::SharedPreferenceSerializer>(
-      dom::ContentParent::ShouldSyncPreference);
+  mPrefSerializer =
+      MakeUnique<ipc::SharedPreferenceSerializer>(ShouldSyncPreference);
   if (!mPrefSerializer->SerializeToSharedMemory()) {
     return false;
   }

diff --git a/dom/media/ipc/RDDProcessManager.cpp b/dom/media/ipc/RDDProcessManager.cpp
@@ -97,7 +97,7 @@ void RDDProcessManager::OnPreferenceChange(const char16_t* aData) {
   NS_LossyConvertUTF16toASCII strData(aData);
 
   // A pref changed. If it is useful to do so, inform child processes.
-  if (!dom::ContentParent::ShouldSyncPreference(strData.Data())) {
+  if (!ShouldSyncPreference(strData.Data())) {
     return;
   }
 

diff --git a/gfx/ipc/GPUProcessHost.cpp b/gfx/ipc/GPUProcessHost.cpp
@@ -42,8 +42,8 @@ bool GPUProcessHost::Launch(StringVector aExtraOpts) {
   MOZ_ASSERT(!mGPUChild);
   MOZ_ASSERT(!gfxPlatform::IsHeadless());
 
-  mPrefSerializer = MakeUnique<ipc::SharedPreferenceSerializer>(
-      dom::ContentParent::ShouldSyncPreference);
+  mPrefSerializer =
+      MakeUnique<ipc::SharedPreferenceSerializer>(ShouldSyncPreference);
   if (!mPrefSerializer->SerializeToSharedMemory()) {
     return false;
   }

diff --git a/gfx/ipc/GPUProcessManager.cpp b/gfx/ipc/GPUProcessManager.cpp
@@ -164,7 +164,7 @@ void GPUProcessManager::OnPreferenceChange(const char16_t* aData) {
   NS_LossyConvertUTF16toASCII strData(aData);
 
   // A pref changed. If it is useful to do so, inform child processes.
-  if (!dom::ContentParent::ShouldSyncPreference(strData.Data())) {
+  if (!ShouldSyncPreference(strData.Data())) {
     return;
   }
 

diff --git a/gfx/vr/ipc/VRProcessManager.cpp b/gfx/vr/ipc/VRProcessManager.cpp
@@ -217,7 +217,7 @@ void VRProcessManager::OnPreferenceChange(const char16_t* aData) {
   NS_LossyConvertUTF16toASCII strData(aData);
 
   // A pref changed. If it is useful to do so, inform child processes.
-  if (!dom::ContentParent::ShouldSyncPreference(strData.Data())) {
+  if (!ShouldSyncPreference(strData.Data())) {
     return;
   }
 

diff --git a/gfx/vr/ipc/VRProcessParent.cpp b/gfx/vr/ipc/VRProcessParent.cpp
@@ -16,6 +16,7 @@
 #include "mozilla/ipc/ProcessUtils.h"
 #include "mozilla/ipc/ProtocolTypes.h"
 #include "mozilla/ipc/ProtocolUtils.h"  // for IToplevelProtocol
+#include "mozilla/Preferences.h"
 #include "mozilla/StaticPrefs_dom.h"
 #include "mozilla/TimeStamp.h"  // for TimeStamp
 #include "mozilla/Unused.h"
@@ -54,8 +55,8 @@ bool VRProcessParent::Launch() {
   std::vector<std::string> extraArgs;
   ProcessChild::AddPlatformBuildID(extraArgs);
 
-  mPrefSerializer = MakeUnique<ipc::SharedPreferenceSerializer>(
-      dom::ContentParent::ShouldSyncPreference);
+  mPrefSerializer =
+      MakeUnique<ipc::SharedPreferenceSerializer>(ShouldSyncPreference);
   if (!mPrefSerializer->SerializeToSharedMemory()) {
     return false;
   }

diff --git a/ipc/glue/UtilityProcessHost.cpp b/ipc/glue/UtilityProcessHost.cpp
@@ -60,8 +60,8 @@ bool UtilityProcessHost::Launch(StringVector aExtraOpts) {
   MOZ_ASSERT(mLaunchPhase == LaunchPhase::Unlaunched);
   MOZ_ASSERT(!mUtilityProcessParent);
 
-  mPrefSerializer = MakeUnique<ipc::SharedPreferenceSerializer>(
-      dom::ContentParent::ShouldSyncPreference);
+  mPrefSerializer =
+      MakeUnique<ipc::SharedPreferenceSerializer>(ShouldSyncPreference);
   if (!mPrefSerializer->SerializeToSharedMemory()) {
     return false;
   }

diff --git a/ipc/glue/UtilityProcessManager.cpp b/ipc/glue/UtilityProcessManager.cpp
@@ -95,7 +95,7 @@ void UtilityProcessManager::OnPreferenceChange(const char16_t* aData) {
   NS_LossyConvertUTF16toASCII strData(aData);
 
   // A pref changed. If it is useful to do so, inform child processes.
-  if (!dom::ContentParent::ShouldSyncPreference(strData.Data())) {
+  if (!ShouldSyncPreference(strData.Data())) {
     return;
   }
 

diff --git a/ipc/ipdl/test/gtest/IPDLUnitTest.cpp b/ipc/ipdl/test/gtest/IPDLUnitTest.cpp
@@ -50,7 +50,7 @@ already_AddRefed<IPDLUnitTestParent> IPDLUnitTestParent::CreateCrossProcess() {
   std::vector<std::string> extraArgs;
 
   auto prefSerializer = MakeUnique<ipc::SharedPreferenceSerializer>(
-      mozilla::dom::ContentParent::ShouldSyncPreference);
+      ShouldSyncPreference);
   if (!prefSerializer->SerializeToSharedMemory()) {
     ADD_FAILURE()
         << "SharedPreferenceSerializer::SerializeToSharedMemory failed";

diff --git a/modules/libpref/Preferences.cpp b/modules/libpref/Preferences.cpp
@@ -5673,6 +5673,38 @@ namespace mozilla {
 
 void UnloadPrefsModule() { Preferences::Shutdown(); }
 
+bool ShouldSyncPreference(const char* aPref) {
+#define PREF_LIST_ENTRY(s) \
+  { s, (sizeof(s) / sizeof(char)) - 1 }
+  struct PrefListEntry {
+    const char* mPrefBranch;
+    size_t mLen;
+  };
+
+  // These prefs are not useful in child processes.
+  static const PrefListEntry sParentOnlyPrefBranchList[] = {
+      PREF_LIST_ENTRY("app.update.lastUpdateTime."),
+      PREF_LIST_ENTRY("datareporting.policy."),
+      PREF_LIST_ENTRY("browser.safebrowsing.provider."),
+      PREF_LIST_ENTRY("browser.shell."),
+      PREF_LIST_ENTRY("browser.slowStartup."),
+      PREF_LIST_ENTRY("browser.startup."),
+      PREF_LIST_ENTRY("extensions.getAddons.cache."),
+      PREF_LIST_ENTRY("media.gmp-manager."),
+      PREF_LIST_ENTRY("media.gmp-gmpopenh264."),
+      PREF_LIST_ENTRY("privacy.sanitize."),
+  };
+#undef PREF_LIST_ENTRY
+
+  for (const auto& entry : sParentOnlyPrefBranchList) {
+    if (strncmp(entry.mPrefBranch, aPref, entry.mLen) == 0) {
+      return false;
+    }
+  }
+
+  return true;
+}
+
 }  // namespace mozilla
 
 // This file contains the C wrappers for the C++ static pref getters, as used

diff --git a/modules/libpref/Preferences.h b/modules/libpref/Preferences.h
@@ -532,6 +532,8 @@ class Preferences final : public nsIPrefService,
   static bool InitStaticMembers();
 };
 
+bool ShouldSyncPreference(const char* aPref);
+
 }  // namespace mozilla
 
 #endif  // mozilla_Preferences_h
diff --git a/netwerk/ipc/SocketProcessHost.cpp b/netwerk/ipc/SocketProcessHost.cpp
@@ -68,8 +68,7 @@ bool SocketProcessHost::Launch() {
   std::vector<std::string> extraArgs;
   ProcessChild::AddPlatformBuildID(extraArgs);
 
-  SharedPreferenceSerializer prefSerializer(
-      mozilla::dom::ContentParent::ShouldSyncPreference);
+  SharedPreferenceSerializer prefSerializer(ShouldSyncPreference);
   if (!prefSerializer.SerializeToSharedMemory()) {
     return false;
   }