titles

Author: Skn0tt

playwright/src/main/java/com/microsoft/playwright/impl/AssertionsBase.java

@@ -38,27 +38,27 @@ class AssertionsBase {
     this.isNot = isNot;
   }
 
-  void expectImpl(String expression, ExpectedTextValue textValue, Object expected, String message, FrameExpectOptions options) {
-    expectImpl(expression, asList(textValue), expected, message, options);
+  void expectImpl(String expression, ExpectedTextValue textValue, Object expected, String message, FrameExpectOptions options, String title) {
+    expectImpl(expression, asList(textValue), expected, message, options, title);
   }
 
-  void expectImpl(String expression, List<ExpectedTextValue> expectedText, Object expected, String message, FrameExpectOptions options) {
+  void expectImpl(String expression, List<ExpectedTextValue> expectedText, Object expected, String message, FrameExpectOptions options, String title) {
     if (options == null) {
       options = new FrameExpectOptions();
     }
     options.expectedText = expectedText;
-    expectImpl(expression, options, expected, message);
+    expectImpl(expression, options, expected, message, title);
   }
 
-  void expectImpl(String expression, FrameExpectOptions expectOptions, Object expected, String message) {
+  void expectImpl(String expression, FrameExpectOptions expectOptions, Object expected, String message, String title) {
     if (expectOptions.timeout == null) {
       expectOptions.timeout = AssertionsTimeout.defaultTimeout;
     }
     expectOptions.isNot = isNot;
     if (isNot) {
       message = message.replace("expected to", "expected not to");
     }
-    FrameExpectResult result = actualLocator.expect(expression, expectOptions);
+    FrameExpectResult result = actualLocator.expect(expression, expectOptions, title);
     if (result.matches == isNot) {
       Object actual = result.received == null ? null : Serialization.deserialize(result.received);
       String log = (result.log == null) ? "" : String.join("\n", result.log);

playwright/src/main/java/com/microsoft/playwright/impl/BrowserImpl.java

@@ -229,7 +229,7 @@ private BrowserContextImpl newContextImpl(NewContextOptions options) {
 
   @Override
   public Page newPage(NewPageOptions options) {
-    return withLogging("Browser.newPage", () -> newPageImpl(options));
+    return withTitle("Create Page", () -> newPageImpl(options));
   }
 
   @Override

playwright/src/main/java/com/microsoft/playwright/impl/ChannelOwner.java

@@ -82,13 +82,27 @@ <T> T withWaitLogging(String apiName, Function<Logger, T> code) {
     return new WaitForEventLogger<>(this, apiName, code).get();
   }
 
+  @Deprecated
   @Override
   <T> T withLogging(String apiName, Supplier<T> code) {
-    String previousApiName = connection.setApiName(apiName);
+    // this has so many callers, removing it would clutter this PR.
+    // it's a no-op for now, and i'll remove it from the codebase in the next PR.
+    return super.withLogging(apiName, code);
+  }
+
+  void withTitle(String title, Runnable code) {
+    withTitle(title, () -> {
+      code.run();
+      return null;
+    });
+  }
+
+  <T> T withTitle(String title, Supplier<T> code) {
+    String previousTitle = connection.setTitle(title);
     try {
-      return super.withLogging(apiName, code);
+      return code.get();
     } finally {
-      connection.setApiName(previousApiName);
+      connection.setTitle(previousTitle);
     }
   }
 

playwright/src/main/java/com/microsoft/playwright/impl/Connection.java

@@ -19,7 +19,6 @@
 import com.google.gson.JsonArray;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
-import com.microsoft.playwright.Playwright;
 import com.microsoft.playwright.PlaywrightException;
 import com.microsoft.playwright.TimeoutError;
 
@@ -64,7 +63,8 @@ public class Connection {
   private int lastId = 0;
   private final StackTraceCollector stackTraceCollector;
   private final Map<Integer, WaitableResult<JsonElement>> callbacks = new HashMap<>();
-  private String apiName;
+  private String title;
+  private boolean titleReported = false;
   private static final boolean isLogging;
   static {
     String debug = System.getenv("DEBUG");
@@ -116,9 +116,10 @@ void setIsTracing(boolean tracing) {
     }
   }
 
-  String setApiName(String name) {
-    String previous = apiName;
-    apiName = name;
+  String setTitle(String newTitle) {
+    String previous = title;
+    titleReported = false;
+    title = newTitle;
     return previous;
   }
 
@@ -146,12 +147,12 @@ private WaitableResult<JsonElement> internalSendMessage(String guid, String meth
     JsonObject metadata = new JsonObject();
     metadata.addProperty("wallTime", currentTimeMillis());
     JsonArray stack = null;
-    if (apiName == null) {
+    if (titleReported) {
       metadata.addProperty("internal", true);
     } else {
-      metadata.addProperty("apiName", apiName);
-      // All but first message in an API call are considered internal and will be hidden from the inspector.
-      apiName = null;
+      metadata.addProperty("title", title);
+      // All but first message in a custom-titled API call are considered internal and will be hidden from the inspector.
+      titleReported = true;
       if (stackTraceCollector != null) {
         stack = stackTraceCollector.currentStackTrace();
         if (!stack.isEmpty()) {