Bug 1689953: Harmonize shutdown phase definitions across nsTerminator and AppShutdown r=dthayer,chutten

This patch wants to solve several quirks around the shutdown terminator.

 - Use the same shutdown phase definitions in AppShutdown and nsTerminator. This touches quite a few files.
 - Ensure that the terminator phase shift is handled before any shutdown observer notifications are sent and reduce its heartbeat duration.
 - Add missing phases to the shutdown telemetry.

Please note that this changes the unit of "tick" to 100ms rather than 1s.
As a side effect, we also remove the obsolete "shutdown-persist" context.

While the existing test coverage continues to prove the most important functions, we acknowledge the wish for better test coverage with [[ https://bugzilla.mozilla.org/show_bug.cgi?id=1693966 | bug 1693966 ]].

Differential Revision: https://phabricator.services.mozilla.com/D103626

Author: jensstutte

accessible/ipc/win/DocAccessibleChild.cpp

@@ -22,7 +22,7 @@ DocAccessibleChild::DocAccessibleChild(DocAccessible* aDoc, IProtocol* aManager)
   MOZ_COUNT_CTOR_INHERITED(DocAccessibleChild, DocAccessibleChildBase);
   if (!sPlatformChild) {
     sPlatformChild = new PlatformChild();
-    ClearOnShutdown(&sPlatformChild, ShutdownPhase::Shutdown);
+    ClearOnShutdown(&sPlatformChild, ShutdownPhase::XPCOMShutdown);
   }
 
   SetManager(aManager);

browser/components/enterprisepolicies/tests/browser/browser_policy_cookie_settings.js

@@ -28,7 +28,7 @@ async function fake_profile_change() {
     }, "cookie-db-closed");
     Services.cookies
       .QueryInterface(Ci.nsIObserver)
-      .observe(null, "profile-before-change", "shutdown-persist");
+      .observe(null, "profile-before-change", null);
   });
   await new Promise(resolve => {
     Services.obs.addObserver(function waitForDBOpen() {

dom/ipc/ContentChild.cpp

@@ -575,7 +575,7 @@ ContentChild::ContentChild()
   // happens without requiring the observer service at this time.
   if (!sShutdownCanary) {
     sShutdownCanary = new ShutdownCanary();
-    ClearOnShutdown(&sShutdownCanary, ShutdownPhase::Shutdown);
+    ClearOnShutdown(&sShutdownCanary, ShutdownPhase::XPCOMShutdown);
   }
 }
 

dom/ipc/ContentParent.cpp

@@ -2839,7 +2839,7 @@ bool ContentParent::InitInternal(ProcessPriority aInitialPriority) {
   // can't init the process without it, and since we're going to be canceling
   // whatever load attempt that initiated this process creation anyway, just
   // bail out now if shutdown has already started.
-  if (PastShutdownPhase(ShutdownPhase::Shutdown)) {
+  if (PastShutdownPhase(ShutdownPhase::XPCOMShutdown)) {
     return false;
   }
 

dom/media/MediaCache.cpp

@@ -773,7 +773,7 @@ RefPtr<MediaCache> MediaCache::GetMediaCache(int64_t aContentLength,
         thread->Shutdown();
       }
     } sClearThread;
-    ClearOnShutdown(&sClearThread, ShutdownPhase::ShutdownThreads);
+    ClearOnShutdown(&sClearThread, ShutdownPhase::XPCOMShutdownThreads);
   }
 
   if (!sThread) {

dom/media/doctor/DecoderDoctorLogger.cpp

@@ -116,9 +116,11 @@ bool DecoderDoctorLogger::EnsureLogIsEnabled() {
               TaskCategory::Other,
               NS_NewRunnableFunction("DDLogger shutdown setup", [] {
                 sDDLogShutdowner = MakeUnique<DDLogShutdowner>();
-                ClearOnShutdown(&sDDLogShutdowner, ShutdownPhase::Shutdown);
+                ClearOnShutdown(&sDDLogShutdowner,
+                                ShutdownPhase::XPCOMShutdown);
                 sDDLogDeleter = MakeUnique<DDLogDeleter>();
-                ClearOnShutdown(&sDDLogDeleter, ShutdownPhase::ShutdownThreads);
+                ClearOnShutdown(&sDDLogDeleter,
+                                ShutdownPhase::XPCOMShutdownThreads);
               })));
 
           // Nobody else should change the state when *we* are enabling logging.

dom/media/mediacapabilities/MediaCapabilities.cpp

@@ -257,7 +257,7 @@ already_AddRefed<Promise> MediaCapabilities::DecodingInfo(
                 NS_NewRunnableFunction(
                     "MediaCapabilities::AllocPolicy:Video", []() {
                       ClearOnShutdown(&sVideoAllocPolicy,
-                                      ShutdownPhase::ShutdownThreads);
+                                      ShutdownPhase::XPCOMShutdownThreads);
                     }));
             return new SingleAllocPolicy(TrackInfo::TrackType::kVideoTrack,
                                          taskQueue);

dom/media/platforms/AllocationPolicy.cpp

@@ -97,7 +97,8 @@ NotNull<AllocPolicy*> GlobalAllocPolicy::Instance(TrackType aTrack) {
           TaskCategory::Other,
           NS_NewRunnableFunction(
               "GlobalAllocPolicy::GlobalAllocPolicy:Audio", []() {
-                ClearOnShutdown(&sAudioPolicy, ShutdownPhase::ShutdownThreads);
+                ClearOnShutdown(&sAudioPolicy,
+                                ShutdownPhase::XPCOMShutdownThreads);
               }));
       return new AllocPolicyImpl(MediaDecoderLimitDefault());
     }();
@@ -108,7 +109,8 @@ NotNull<AllocPolicy*> GlobalAllocPolicy::Instance(TrackType aTrack) {
         TaskCategory::Other,
         NS_NewRunnableFunction(
             "GlobalAllocPolicy::GlobalAllocPolicy:Audio", []() {
-              ClearOnShutdown(&sVideoPolicy, ShutdownPhase::ShutdownThreads);
+              ClearOnShutdown(&sVideoPolicy,
+                              ShutdownPhase::XPCOMShutdownThreads);
             }));
     return new AllocPolicyImpl(MediaDecoderLimitDefault());
   }();

dom/media/webrtc/CubebDeviceEnumerator.cpp

@@ -30,7 +30,7 @@ CubebDeviceEnumerator* CubebDeviceEnumerator::GetInstance() {
     sInstance = new CubebDeviceEnumerator();
     static bool clearOnShutdownSetup = []() -> bool {
       auto setClearOnShutdown = []() -> void {
-        ClearOnShutdown(&sInstance, ShutdownPhase::ShutdownThreads);
+        ClearOnShutdown(&sInstance, ShutdownPhase::XPCOMShutdownThreads);
       };
       if (NS_IsMainThread()) {
         setClearOnShutdown();

dom/media/webrtc/transport/nr_socket_prsock.cpp

@@ -241,7 +241,7 @@ class SingletonThreadHolder final {
 static StaticRefPtr<SingletonThreadHolder> sThread;
 
 static void ClearSingletonOnShutdown() {
-  ClearOnShutdown(&sThread, ShutdownPhase::ShutdownLoaders);
+  ClearOnShutdown(&sThread, ShutdownPhase::XPCOMShutdownLoaders);
 }
 #endif