Changeset 273215 in webkit

Timestamp:

Feb 20, 2021 8:24:31 PM (3 years ago)

Author:

BJ Burg

Message:

[Cocoa] Web Inspector: expose the WKBrowsingContextHandle associated with Web Inspector's page
​https://bugs.webkit.org/show_bug.cgi?id=222226

Reviewed by Timothy Hatcher.

In order to implement browser.devtools.inspectedWindow.tabId for Web Extensions,
we need a way to do a reverse lookup of the tabId using the current browsing context
controller (WKWebProcessPlugInBrowserContextController) in the injected bundle.

This patch exposes the browsing context handle for the underlying WKWebView that
hosts the inspector page. Clients can use this to precompute a tabId for each
inspector browsing context that may be encountered by injected bundle code.

• UIProcess/API/Cocoa/_WKInspectorPrivate.h:
• UIProcess/API/Cocoa/_WKInspector.mm:

(-[_WKInspector handle]): Added.

• WebProcess/InjectedBundle/mac/InjectedBundleMac.mm:

(WebKit::InjectedBundle::classesForCoder):
Drive-by, make it possible to use WKBrowsingContextHandle in injected bundle parameters.
This is easy because it conforms to NSSecureCoding and is simply a pageId + frameId.

Location:

trunk/Source/WebKit

Files:

• ChangeLog (modified) (1 diff)
• UIProcess/API/Cocoa/_WKInspector.mm (modified) (2 diffs)
• UIProcess/API/Cocoa/_WKInspectorPrivate.h (modified) (3 diffs)
• WebProcess/InjectedBundle/mac/InjectedBundleMac.mm (modified) (2 diffs)

trunk/Source/WebKit/ChangeLog

@@ +1 @@
+2021-02-20  BJ Burg  <bburg@apple.com>
+
+        [Cocoa] Web Inspector: expose the WKBrowsingContextHandle associated with Web Inspector's page
+        https://bugs.webkit.org/show_bug.cgi?id=222226
+
+        Reviewed by Timothy Hatcher.
+
+        In order to implement browser.devtools.inspectedWindow.tabId for Web Extensions,
+        we need a way to do a reverse lookup of the tabId using the current browsing context
+        controller (WKWebProcessPlugInBrowserContextController) in the injected bundle.
+
+        This patch exposes the browsing context handle for the underlying WKWebView that
+        hosts the inspector page. Clients can use this to precompute a tabId for each
+        inspector browsing context that may be encountered by injected bundle code.
+
+        * UIProcess/API/Cocoa/_WKInspectorPrivate.h:
+        * UIProcess/API/Cocoa/_WKInspector.mm:
+        (-[_WKInspector handle]): Added.
+
+        * WebProcess/InjectedBundle/mac/InjectedBundleMac.mm:
+        (WebKit::InjectedBundle::classesForCoder):
+        Drive-by, make it possible to use WKBrowsingContextHandle in injected bundle parameters.
+        This is easy because it conforms to NSSecureCoding and is simply a pageId + frameId.
+
 2021-02-20  Chris Fleizach  <cfleizach@apple.com>
 

trunk/Source/WebKit/UIProcess/API/Cocoa/_WKInspector.mm

@@ -1 +1 @@
 /*
- * Copyright (C) 2018 Apple Inc. All rights reserved.
+ * Copyright (C) 2018-2021 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -170 +170 @@
 }
 
+- (WKBrowsingContextHandle *)handle
+{
+    return self.inspectorWebView._handle;
+}
+
 // MARK: _WKInspectorInternal methods
 

trunk/Source/WebKit/UIProcess/API/Cocoa/_WKInspectorPrivate.h

@@ -1 +1 @@
 /*
- * Copyright (C) 2019 Apple Inc. All rights reserved.
+ * Copyright (C) 2019-2021 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -26 +26 @@
 #import "_WKInspector.h"
 
+@class WKBrowsingContextHandle;
 @protocol _WKDiagnosticLoggingDelegate;
 
@@ -32 +33 @@
 @property (nonatomic, weak, setter=_setDiagnosticLoggingDelegate:) id<_WKDiagnosticLoggingDelegate> _diagnosticLoggingDelegate;
 
+/**
+ * @abstract The browsing context handle associated with Web Inspector's user interface.
+ * @discussion This can be used to identify the inspector page and any associated subframes
+ * from within the injected bundle.
+ */
+@property (nonatomic, readonly) WKBrowsingContextHandle *handle;
+
 @end

trunk/Source/WebKit/WebProcess/InjectedBundle/mac/InjectedBundleMac.mm

@@ -30 +30 @@
 #import "APIData.h"
 #import "ObjCObjectGraph.h"
+#import "WKBrowsingContextHandle.h"
 #import "WKBundleAPICast.h"
 #import "WKBundleInitialize.h"
@@ -267 +268 @@
 {
     if (!m_classesForCoder)
-        m_classesForCoder = [NSSet setWithObjects:[NSArray class], [NSData class], [NSDate class], [NSDictionary class], [NSNull class], [NSNumber class], [NSSet class], [NSString class], [NSTimeZone class], [NSURL class], [NSUUID class], nil];
+        m_classesForCoder = [NSSet setWithObjects:[NSArray class], [NSData class], [NSDate class], [NSDictionary class], [NSNull class], [NSNumber class], [NSSet class], [NSString class], [NSTimeZone class], [NSURL class], [NSUUID class], [WKBrowsingContextHandle class], nil];
 
     return m_classesForCoder.get();