Bug 147073 – Can't use Web Inspector on web views made by TestWebKitAPI

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

When running API tests, the web views made by TestWebKitAPI don’t show up in Safari’s Develop menu.

[Blaze Burg]

Hi Dan,

I looked into this yesterday. In 2021, this mostly works, except that it is necessary to spin a nested run loop at the point in the test where you would like to remote inspect the WebView. Messages from the remote connection are dispatched through UIProcess, so if lldb has paused UIProcess, WebInspectorUI will not be able to get any data from the inspected WebView.

I'm going to write some debug helper macros similar to SLEEP_THREAD_FOR_DEBUGGER() so that it's easy for a test to spin the run loop until a Web Inspector frontend has attached or detached to a specific webview.

[Radar WebKit Bug Importer]

<rdar://problem/76708379>

[Blaze Burg]

Created attachment 426451 [details]
Patch v1.0

This works without further modifications. I used two macros to debug a recent issue this way, and I think it's worth checking them in for future debugging sessions.

[Blaze Burg]

Addressing some unexpected header include mess.

[Blaze Burg]

Created attachment 426472 [details]
Patch v1.1

[Devin Rousso]

Comment on attachment 426472 [details]
Patch v1.1

View in context: https://bugs.webkit.org/attachment.cgi?id=426472&action=review

r=me

> Tools/ChangeLog:21
> +        * TestWebKitAPI/PlatformUtilities.h: Add missing `#pragma once`.
> +        * TestWebKitAPI/WTFStringUtilities.h: Force the build to fail noisily if we have
> +        attempted to redefine WTF_STRINGTYPEADAPTER_COPIED_WTF_STRING. Force the correct
> +        ordering between "WTFStringUtilities.h" and <wtf/text/StringConcatenate.h>.

NIT: would be preferable to have this be a separate patch

> Tools/TestWebKitAPI/DebugUtilities.h:41
> +        if ([webView _isBeingInspected]) \

NIT: Should we add `#import "WKWebViewPrivate.h` to this file, or just assume/hope that callers will have already done that?

> Tools/TestWebKitAPI/PlatformUtilities.h:26
> +#pragma once

NIT: Is it necessary/desirable to have both` #pragma once` and the `#ifndef` pattern in the same file?

[Blaze Burg]

(In reply to Devin Rousso from comment #6)
> Comment on attachment 426472 [details]
> Patch v1.1
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=426472&action=review
> 
> r=me
> 
> > Tools/ChangeLog:21
> > +        * TestWebKitAPI/PlatformUtilities.h: Add missing `#pragma once`.
> > +        * TestWebKitAPI/WTFStringUtilities.h: Force the build to fail noisily if we have
> > +        attempted to redefine WTF_STRINGTYPEADAPTER_COPIED_WTF_STRING. Force the correct
> > +        ordering between "WTFStringUtilities.h" and <wtf/text/StringConcatenate.h>.
> 
> NIT: would be preferable to have this be a separate patch

I added this and the forced import because including DebugUtilities.h before WTFStringUtilities.h or PlatformUtilities will hit this build failure in many files.

> 
> > Tools/TestWebKitAPI/DebugUtilities.h:41
> > +        if ([webView _isBeingInspected]) \
> 
> NIT: Should we add `#import "WKWebViewPrivate.h` to this file, or just
> assume/hope that callers will have already done that?

Hmm, good point.

> > Tools/TestWebKitAPI/PlatformUtilities.h:26
> > +#pragma once
> 
> NIT: Is it necessary/desirable to have both` #pragma once` and the `#ifndef`
> pattern in the same file?

They are not in the same file, and yes. The default definition of the macro is in StringConcatenate.h.

[Devin Rousso]

Comment on attachment 426472 [details]
Patch v1.1

View in context: https://bugs.webkit.org/attachment.cgi?id=426472&action=review

>>> Tools/TestWebKitAPI/PlatformUtilities.h:26
>>> +#pragma once
>> 
>> NIT: Is it necessary/desirable to have both` #pragma once` and the `#ifndef` pattern in the same file?
> 
> They are not in the same file, and yes. The default definition of the macro is in StringConcatenate.h.

err, sorry by "`#ifndef` pattern" i meant having both `#pragma once` and `#ifndef PlatformUtilities_h` in this file

[Blaze Burg]

(In reply to Devin Rousso from comment #8)
> Comment on attachment 426472 [details]
> Patch v1.1
> 
> View in context:
> https://bugs.webkit.org/attachment.cgi?id=426472&action=review
> 
> >>> Tools/TestWebKitAPI/PlatformUtilities.h:26
> >>> +#pragma once
> >> 
> >> NIT: Is it necessary/desirable to have both` #pragma once` and the `#ifndef` pattern in the same file?
> > 
> > They are not in the same file, and yes. The default definition of the macro is in StringConcatenate.h.
> 
> err, sorry by "`#ifndef` pattern" i meant having both `#pragma once` and
> `#ifndef PlatformUtilities_h` in this file

Ah I just figured it out when tweaking the patch. :P

[Blaze Burg]

Committed r276276 (236758@main): <https://commits.webkit.org/236758@main>