Bug 1729026 - Test that GPU-process FOG metrics work r=Dexter,nical

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

gfx/ipc/GPUParent.cpp

@@ -39,6 +39,7 @@
 #include "mozilla/dom/MemoryReportRequest.h"
 #include "mozilla/gfx/2D.h"
 #include "mozilla/gfx/gfxVars.h"
+#include "mozilla/glean/GleanMetrics.h"
 #include "mozilla/image/ImageMemoryReporter.h"
 #include "mozilla/ipc/CrashReporterClient.h"
 #include "mozilla/ipc/ProcessChild.h"
@@ -624,6 +625,11 @@ mozilla::ipc::IPCResult GPUParent::RecvFlushFOGData(
   return IPC_OK();
 }
 
+mozilla::ipc::IPCResult GPUParent::RecvTestTriggerMetrics() {
+  mozilla::glean::test_only_ipc::a_counter.Add(45326);
+  return IPC_OK();
+}
+
 void GPUParent::ActorDestroy(ActorDestroyReason aWhy) {
   if (AbnormalShutdown == aWhy) {
     NS_WARNING("Shutting down GPU process early due to a crash!");

gfx/ipc/GPUParent.h

@@ -99,6 +99,8 @@ class GPUParent final : public PGPUParent {
 
   mozilla::ipc::IPCResult RecvFlushFOGData(FlushFOGDataResolver&& aResolver);
 
+  mozilla::ipc::IPCResult RecvTestTriggerMetrics();
+
   void ActorDestroy(ActorDestroyReason aWhy) override;
 
  private:

gfx/ipc/GPUProcessManager.cpp

@@ -1265,5 +1265,11 @@ RefPtr<MemoryReportingProcess> GPUProcessManager::GetProcessMemoryReporter() {
   return new GPUMemoryReporter();
 }
 
+void GPUProcessManager::TestTriggerMetrics() {
+  if (!NS_WARN_IF(!mGPUChild)) {
+    mGPUChild->SendTestTriggerMetrics();
+  }
+}
+
 }  // namespace gfx
 }  // namespace mozilla

gfx/ipc/GPUProcessManager.h

@@ -192,6 +192,13 @@ class GPUProcessManager final : public GPUProcessHost::Listener {
   // Returns the process host
   GPUProcessHost* Process() { return mProcess; }
 
+  /*
+   * ** Test-only Method **
+   *
+   * Trigger GPU-process test metric instrumentation.
+   */
+  void TestTriggerMetrics();
+
  private:
   // Called from our xpcom-shutdown observer.
   void OnXPCOMShutdown();

gfx/ipc/PGPU.ipdl

@@ -118,6 +118,10 @@ parent:
   // https://firefox-source-docs.mozilla.org/toolkit/components/glean/dev/ipc.html
   async FlushFOGData() returns (ByteBuf buf);
 
+  // Test-only method.
+  // Asks the gpu process to trigger test-only instrumentation.
+  async TestTriggerMetrics();
+
 child:
   // Sent when the GPU process has initialized devices. This occurs once, after
   // Init().

toolkit/components/glean/docs/dev/testing.md

@@ -12,7 +12,9 @@ To run all the things, here's the tl;dr:
 && ./mach rusttests && ./mach gtest FOG*
 && python3 ./mach python-test toolkit/components/glean/tests/pytest
 && ./mach test toolkit/components/glean/tests/xpcshell
-&& ./mach telemetry-tests-client toolkit/components/telemetry/tests/marionette/tests/client/test_fog* --gecko-log "-"`
+&& ./mach telemetry-tests-client toolkit/components/telemetry/tests/marionette/tests/client/test_fog* --gecko-log "-"
+&& ./mach test toolkit/components/glean/tests/browser
+`
 
 ## Logging
 
@@ -162,6 +164,21 @@ or the test runner will not be able to find it.
 To run FOG's JS tests, run:
 `./mach test toolkit/components/glean/tests/xpcshell`
 
+## Non-content-process multiprocess (Browser Chrome Mochitests with Treeherder symbol `M(bcN)` for some number `N`)
+
+To test e.g. the GPU process support you need a full Firefox browser:
+xpcshell doesn't have the flexibility.
+To test that and have access to privileged JS (i.e. `Glean` and `FOG` APIs),
+we use browser-chrome-flavoured mochitests you can find in
+[`browser/`](https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/glean/tests/browser).
+
+If you need to add a new test file, remember to add it to the
+[`browser.ini`](https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/glean/tests/browser/browser.ini)
+manifest, or the test runner will not be able to find it.
+
+To run FOG's browser chrome tests, run:
+`./mach test toolkit/components/glean/tests/browser`
+
 ## Integration (Marionette, borrowing `telemetry-tests-client` Treeherder symbol `tt(c)`)
 
 To test pings (See [bug 1681742](https://bugzilla.mozilla.org/show_bug.cgi?id=1681742))

toolkit/components/glean/ipc/FOGIPC.cpp

@@ -181,5 +181,9 @@ RefPtr<GenericPromise> FlushAndUseFOGData() {
   return ret;
 }
 
+void TestTriggerGPUMetrics() {
+  gfx::GPUProcessManager::Get()->TestTriggerMetrics();
+}
+
 }  // namespace glean
 }  // namespace mozilla

toolkit/components/glean/ipc/FOGIPC.h

@@ -59,6 +59,13 @@ void SendFOGData(ipc::ByteBuf&& buf);
  */
 RefPtr<GenericPromise> FlushAndUseFOGData();
 
+/**
+ * ** Test-only Method **
+ *
+ * Trigger GPU-process test instrumentation.
+ */
+void TestTriggerGPUMetrics();
+
 }  // namespace glean
 }  // namespace mozilla
 

toolkit/components/glean/tests/browser/browser.ini

@@ -0,0 +1,4 @@
+[DEFAULT]
+support-files =
+
+[browser_fog_gpu.js]

toolkit/components/glean/tests/browser/browser_fog_gpu.js

@@ -0,0 +1,36 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+// Glean's here on `window`, but eslint doesn't know that. bug 1715542.
+/* global Glean:false */
+
+add_task(async () => {
+  if (
+    !(await ChromeUtils.requestProcInfo()).children.some(p => p.type == "gpu")
+  ) {
+    ok(
+      true,
+      'No GPU process? No test. Try again with --setpref "layers.gpu-process.force-enabled=true".'
+    );
+    return;
+  }
+  ok(true, "GPU Process found: Let's test.");
+
+  is(
+    undefined,
+    Glean.testOnlyIpc.aCounter.testGetValue(),
+    "Ensure we begin without value."
+  );
+
+  let FOG = Cc["@mozilla.org/toolkit/glean;1"].createInstance(Ci.nsIFOG);
+  FOG.testTriggerGPUMetrics();
+  await FOG.testFlushAllChildren();
+
+  is(
+    45326, // See gfx/ipc/GPUParent.cpp's RecvTestTriggerMetrics().
+    Glean.testOnlyIpc.aCounter.testGetValue(),
+    "Ensure the GPU-process-set value shows up in the parent process."
+  );
+});

toolkit/components/glean/tests/moz.build

@@ -10,5 +10,7 @@ TEST_DIRS += ["gtest"]
 
 XPCSHELL_TESTS_MANIFESTS += ["xpcshell/xpcshell.ini"]
 
+BROWSER_CHROME_MANIFESTS += ["browser/browser.ini"]
+
 with Files("**"):
     BUG_COMPONENT = ("Toolkit", "Telemetry")

toolkit/components/glean/xpcom/FOG.cpp

@@ -298,6 +298,12 @@ FOG::TestResetFOG(const nsACString& aDataPathOverride,
   return glean::impl::fog_test_reset(&aDataPathOverride, &aAppIdOverride);
 }
 
+NS_IMETHODIMP
+FOG::TestTriggerGPUMetrics() {
+  glean::TestTriggerGPUMetrics();
+  return NS_OK;
+}
+
 NS_IMPL_ISUPPORTS(FOG, nsIFOG, nsIObserver)
 
 }  //  namespace mozilla

toolkit/components/glean/xpcom/nsIFOG.idl

@@ -118,4 +118,11 @@ interface nsIFOG : nsISupports
    * Reset FOG and the Glean SDK, clearing storage.
    */
   void testResetFOG([optional] in AUTF8String aDataPathOverride, [optional] in AUTF8String aAppIdOverride);
+
+  /**
+   * ** Test-only Method **
+   *
+   * Trigger test metric instrumentation on the GPU process.
+   */
+  void testTriggerGPUMetrics();
 };