Bug 1899172 - Part 1: Cleanup TRACE_FOR_TEST macros. r=nbp

arai-a · arai-a · commit 24265d53c514 · 2024-05-30T05:01:14.000Z
Differential Revision: https://phabricator.services.mozilla.com/D211901
diff --git a/dom/script/ScriptLoadHandler.cpp b/dom/script/ScriptLoadHandler.cpp
@@ -322,8 +322,7 @@ nsresult ScriptLoadHandler::EnsureKnownDataType(
 
   if (mRequest->mFetchSourceOnly) {
     mRequest->SetTextSource(mRequest->mLoadContext.get());
-    TRACE_FOR_TEST(mRequest->GetScriptLoadContext()->GetScriptElement(),
-                   "scriptloader_load_source");
+    TRACE_FOR_TEST(mRequest, "scriptloader_load_source");
     return NS_OK;
   }
 
@@ -333,16 +332,14 @@ nsresult ScriptLoadHandler::EnsureKnownDataType(
     cic->GetAlternativeDataType(altDataType);
     if (altDataType.Equals(ScriptLoader::BytecodeMimeTypeFor(mRequest))) {
       mRequest->SetBytecode();
-      TRACE_FOR_TEST(mRequest->GetScriptLoadContext()->GetScriptElement(),
-                     "scriptloader_load_bytecode");
+      TRACE_FOR_TEST(mRequest, "scriptloader_load_bytecode");
       return NS_OK;
     }
     MOZ_ASSERT(altDataType.IsEmpty());
   }
 
   mRequest->SetTextSource(mRequest->mLoadContext.get());
-  TRACE_FOR_TEST(mRequest->GetScriptLoadContext()->GetScriptElement(),
-                 "scriptloader_load_source");
+  TRACE_FOR_TEST(mRequest, "scriptloader_load_source");
 
   MOZ_ASSERT(!mRequest->IsUnknownDataType());
   MOZ_ASSERT(mRequest->IsFetching());
diff --git a/dom/script/ScriptLoader.cpp b/dom/script/ScriptLoader.cpp
@@ -501,8 +501,7 @@ void ScriptLoader::RunScriptWhenSafe(ScriptLoadRequest* aRequest) {
 
 nsresult ScriptLoader::RestartLoad(ScriptLoadRequest* aRequest) {
   aRequest->DropBytecode();
-  TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                 "scriptloader_fallback");
+  TRACE_FOR_TEST(aRequest, "scriptloader_fallback");
 
   // Notify preload restart so that we can register this preload request again.
   aRequest->GetScriptLoadContext()->NotifyRestart(mDocument);
@@ -1326,8 +1325,7 @@ bool ScriptLoader::ProcessInlineScript(nsIScriptElement* aElement,
       aElement->GetScriptColumnNumber();
   request->mFetchSourceOnly = true;
   request->SetTextSource(request->mLoadContext.get());
-  TRACE_FOR_TEST_BOOL(request->GetScriptLoadContext()->GetScriptElement(),
-                      "scriptloader_load_source");
+  TRACE_FOR_TEST_BOOL(request, "scriptloader_load_source");
   CollectScriptTelemetry(request);
 
   // Only the 'async' attribute is heeded on an inline module script and
@@ -1720,8 +1718,7 @@ nsresult ScriptLoader::AttemptOffThreadScriptCompile(
   if (aRequest->IsTextSource()) {
     if (!StaticPrefs::javascript_options_parallel_parsing() ||
         aRequest->ScriptTextLength() < OffThreadMinimumTextLength) {
-      TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                     "scriptloader_main_thread_compile");
+      TRACE_FOR_TEST(aRequest, "scriptloader_main_thread_compile");
       return NS_OK;
     }
   } else {
@@ -2022,21 +2019,17 @@ nsresult ScriptLoader::CreateOffThreadTask(
   if (StaticPrefs::dom_expose_test_interfaces()) {
     switch (aOptions.eagerDelazificationStrategy()) {
       case JS::DelazificationOption::OnDemandOnly:
-        TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                       "delazification_on_demand_only");
+        TRACE_FOR_TEST(aRequest, "delazification_on_demand_only");
         break;
       case JS::DelazificationOption::CheckConcurrentWithOnDemand:
       case JS::DelazificationOption::ConcurrentDepthFirst:
-        TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                       "delazification_concurrent_depth_first");
+        TRACE_FOR_TEST(aRequest, "delazification_concurrent_depth_first");
         break;
       case JS::DelazificationOption::ConcurrentLargeFirst:
-        TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                       "delazification_concurrent_large_first");
+        TRACE_FOR_TEST(aRequest, "delazification_concurrent_large_first");
         break;
       case JS::DelazificationOption::ParseEverythingEagerly:
-        TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                       "delazification_parse_everything_eagerly");
+        TRACE_FOR_TEST(aRequest, "delazification_parse_everything_eagerly");
         break;
     }
   }
@@ -2639,8 +2632,7 @@ void ScriptLoader::MaybePrepareForBytecodeEncodingBeforeExecute(
 nsresult ScriptLoader::MaybePrepareForBytecodeEncodingAfterExecute(
     ScriptLoadRequest* aRequest, nsresult aRv) {
   if (aRequest->IsMarkedForBytecodeEncoding()) {
-    TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                   "scriptloader_encode");
+    TRACE_FOR_TEST(aRequest, "scriptloader_encode");
     // Check that the TranscodeBuffer which is going to receive the encoded
     // bytecode only contains the SRI, and nothing more.
     //
@@ -2655,8 +2647,7 @@ nsresult ScriptLoader::MaybePrepareForBytecodeEncodingAfterExecute(
 
   LOG(("ScriptLoadRequest (%p): Bytecode-cache: disabled (rv = %X)", aRequest,
        unsigned(aRv)));
-  TRACE_FOR_TEST_NONE(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                      "scriptloader_no_encode");
+  TRACE_FOR_TEST_NONE(aRequest, "scriptloader_no_encode");
   aRequest->mCacheInfo = nullptr;
   MOZ_ASSERT(IsAlreadyHandledForBytecodeEncodingPreparation(aRequest));
 
@@ -2750,8 +2741,7 @@ nsresult ScriptLoader::EvaluateScript(nsIGlobalObject* aGlobalObject,
          mTotalFullParseSize));
   }
 
-  TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                 "scriptloader_execute");
+  TRACE_FOR_TEST(aRequest, "scriptloader_execute");
   JS::Rooted<JSObject*> global(cx, aGlobalObject->GetGlobalJSObject());
   JSExecutionContext exec(cx, global, options, classicScriptValue,
                           introductionScript);
@@ -2914,10 +2904,8 @@ void ScriptLoader::EncodeRequestBytecode(JSContext* aCx,
   using namespace mozilla::Telemetry;
   nsresult rv = NS_OK;
   MOZ_ASSERT(aRequest->mCacheInfo);
-  auto bytecodeFailed = mozilla::MakeScopeExit([&]() {
-    TRACE_FOR_TEST_NONE(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                        "scriptloader_bytecode_failed");
-  });
+  auto bytecodeFailed = mozilla::MakeScopeExit(
+      [&]() { TRACE_FOR_TEST_NONE(aRequest, "scriptloader_bytecode_failed"); });
 
   bool result;
   if (aRequest->IsModuleRequest()) {
@@ -2991,8 +2979,7 @@ void ScriptLoader::EncodeRequestBytecode(JSContext* aCx,
   MOZ_RELEASE_ASSERT(compressedBytecode.length() == n);
 
   bytecodeFailed.release();
-  TRACE_FOR_TEST_NONE(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                      "scriptloader_bytecode_saved");
+  TRACE_FOR_TEST_NONE(aRequest, "scriptloader_bytecode_saved");
 }
 
 void ScriptLoader::GiveUpBytecodeEncoding() {
@@ -3018,8 +3005,7 @@ void ScriptLoader::GiveUpBytecodeEncoding() {
   while (!mBytecodeEncodingQueue.isEmpty()) {
     RefPtr<ScriptLoadRequest> request = mBytecodeEncodingQueue.StealFirst();
     LOG(("ScriptLoadRequest (%p): Cannot serialize bytecode", request.get()));
-    TRACE_FOR_TEST_NONE(request->GetScriptLoadContext()->GetScriptElement(),
-                        "scriptloader_bytecode_failed");
+    TRACE_FOR_TEST_NONE(request, "scriptloader_bytecode_failed");
     MOZ_ASSERT(!IsWebExtensionRequest(request));
 
     if (aes.isSome()) {
diff --git a/dom/script/ScriptTrace.h b/dom/script/ScriptTrace.h
@@ -9,41 +9,46 @@
 
 #include "mozilla/AsyncEventDispatcher.h"
 #include "mozilla/StaticPrefs_dom.h"
+#include "js/loader/ScriptLoadRequest.h"
+#include "mozilla/dom/ScriptLoadContext.h"
 
 // This macro is used to wrap a tracing mechanism which is scheduling events
 // which are then used by the JavaScript code of test cases to track the code
 // path to verify the optimizations are working as expected.
-#define TRACE_FOR_TEST(elem, str)                  \
-  PR_BEGIN_MACRO                                   \
-  nsresult rv = NS_OK;                             \
-  rv = mozilla::dom::script::TestingDispatchEvent( \
-      elem, NS_LITERAL_STRING_FROM_CSTRING(str));  \
-  NS_ENSURE_SUCCESS(rv, rv);                       \
+#define TRACE_FOR_TEST(request, str)                 \
+  PR_BEGIN_MACRO                                     \
+  nsresult rv = NS_OK;                               \
+  rv = mozilla::dom::script::TestingDispatchEvent(   \
+      request, NS_LITERAL_STRING_FROM_CSTRING(str)); \
+  NS_ENSURE_SUCCESS(rv, rv);                         \
   PR_END_MACRO
 
-#define TRACE_FOR_TEST_BOOL(elem, str)             \
-  PR_BEGIN_MACRO                                   \
-  nsresult rv = NS_OK;                             \
-  rv = mozilla::dom::script::TestingDispatchEvent( \
-      elem, NS_LITERAL_STRING_FROM_CSTRING(str));  \
-  NS_ENSURE_SUCCESS(rv, false);                    \
+#define TRACE_FOR_TEST_BOOL(request, str)            \
+  PR_BEGIN_MACRO                                     \
+  nsresult rv = NS_OK;                               \
+  rv = mozilla::dom::script::TestingDispatchEvent(   \
+      request, NS_LITERAL_STRING_FROM_CSTRING(str)); \
+  NS_ENSURE_SUCCESS(rv, false);                      \
   PR_END_MACRO
 
-#define TRACE_FOR_TEST_NONE(elem, str)            \
-  PR_BEGIN_MACRO                                  \
-  mozilla::dom::script::TestingDispatchEvent(     \
-      elem, NS_LITERAL_STRING_FROM_CSTRING(str)); \
+#define TRACE_FOR_TEST_NONE(request, str)            \
+  PR_BEGIN_MACRO                                     \
+  mozilla::dom::script::TestingDispatchEvent(        \
+      request, NS_LITERAL_STRING_FROM_CSTRING(str)); \
   PR_END_MACRO
 
 namespace mozilla::dom::script {
 
-static nsresult TestingDispatchEvent(nsIScriptElement* aScriptElement,
+static nsresult TestingDispatchEvent(JS::loader::ScriptLoadRequest* aRequest,
                                      const nsAString& aEventType) {
   if (!StaticPrefs::dom_expose_test_interfaces()) {
     return NS_OK;
   }
 
-  nsCOMPtr<nsINode> target(do_QueryInterface(aScriptElement));
+  nsIScriptElement* scriptElement =
+      aRequest->GetScriptLoadContext()->GetScriptElement();
+
+  nsCOMPtr<nsINode> target(do_QueryInterface(scriptElement));
   if (!target) {
     return NS_OK;
   }
diff --git a/js/loader/ModuleLoaderBase.cpp b/js/loader/ModuleLoaderBase.cpp
@@ -1301,8 +1301,7 @@ nsresult ModuleLoaderBase::EvaluateModuleInContext(
   NS_ENSURE_SUCCESS(rv, rv);
 
   if (request->HasScriptLoadContext()) {
-    TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),
-                   "scriptloader_evaluate_module");
+    TRACE_FOR_TEST(aRequest, "scriptloader_evaluate_module");
   }
 
   JS::Rooted<JS::Value> rval(aCx);

Original file line number	Diff line number	Diff line change
`@@ -1301,8 +1301,7 @@ nsresult ModuleLoaderBase::EvaluateModuleInContext(`
`1301`	`1301`	`NS_ENSURE_SUCCESS(rv, rv);`
`1302`	`1302`
`1303`	`1303`	`if (request->HasScriptLoadContext()) {`
`1304`		`- TRACE_FOR_TEST(aRequest->GetScriptLoadContext()->GetScriptElement(),`
`1305`		`- "scriptloader_evaluate_module");`
	`1304`	`+ TRACE_FOR_TEST(aRequest, "scriptloader_evaluate_module");`
`1306`	`1305`	`}`
`1307`	`1306`
`1308`	`1307`	`JS::Rooted<JS::Value> rval(aCx);`