Bug 173770 – [WPE] Add env var WPE_USE_HEADLESS_VIEW_BACKEND

• Status: RESOLVED
• Resolution: FIXED
• Component: WPE WebKit

[Carlos Garcia Campos]

To automatically create the views with the headless view backend. Right now the headless view backend is only used by WTR using WKViewCreateWithViewBackend. However, we want to use the headless backend to run the unit tests too. We still don't have glib API to create a WebKitWebView with a custom WPE view backend, and even in that case, using a different webkit_web_view_new function in the tests would require adding ifdefs in every single case since GTK+ doesn't have such AI, of course. Also, we would need to find a place to share the headless view backend implementation. Using an environment variable we can simply add a headless driver to webkitpy, used by default, that ensures the WPE_USE_HEADLESS_VIEW_BACKEND variable is present in the environment. Then, we can move the headless view backend to WKWPE and use it in the View constructor when no backend is given and the variable WPE_USE_HEADLESS_VIEW_BACKEND is present and enabled. This will make unit tests work automatically once we add run-wpe-tests scripts, and also allows to run the layout tests in X11 without having to unset environment variables.

[Carlos Garcia Campos]

Created attachment 313722 [details]
Patch

[Build Bot]

Attachment 313722 [details] did not pass style-queue:


ERROR: Source/WebKit2/UIProcess/API/wpe/HeadlessViewBackend.h:28:  Alphabetical sorting problem.  [build/include_order] [4]
Total errors found: 1 in 14 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Carlos Garcia Campos]

It failed to build in EWS, it works here, maybe it needs a clean build

[Zan Dobersek]

Comment on attachment 313722 [details]
Patch

We can't add a WPEBackend-mesa dependency to libWPEWebKit. I didn't account for that.

Same approach should be taken as with WKTR, creating a custom headless view backend.

[Carlos Garcia Campos]

(In reply to Zan Dobersek from comment #4)
> Comment on attachment 313722 [details]
> Patch
> 
> We can't add a WPEBackend-mesa dependency to libWPEWebKit. I didn't account
> for that.

Ah :-( Could you elaborate? what's the problem of making libWPEWebKit link to WPEBackend-mesa?

> Same approach should be taken as with WKTR, creating a custom headless view
> backend.

What do you mean? Using a different headless view backend that doesn't need WPEBackend-mesa?

[Zan Dobersek]

(In reply to Carlos Garcia Campos from comment #5)
> (In reply to Zan Dobersek from comment #4)
> > Comment on attachment 313722 [details]
> > Patch
> > 
> > We can't add a WPEBackend-mesa dependency to libWPEWebKit. I didn't account
> > for that.
> 
> Ah :-( Could you elaborate? what's the problem of making libWPEWebKit link
> to WPEBackend-mesa?
> 

Because other platforms can't use that, so it can't be depended on universally.

> > Same approach should be taken as with WKTR, creating a custom headless view
> > backend.
> 
> What do you mean? Using a different headless view backend that doesn't need
> WPEBackend-mesa?

We still use WPEBackend-mesa as a reference backend implementation, and depend on it for testing. There's no generic exportable interface, but it might make sense to look into creating one. But for now we have to leverage WPEBackend-mesa, just not as a hard-coded dependency of the main libWPEWebKit.so library.

What could be used for unit tests is basically a pass-through wpe_mesa_view_backend_exportable_dma_buf_client implementation. The export_dma_buf callback would only call wpe_mesa_view_backend_exportable_dma_buf_dispatch_frame_complete() and wpe_mesa_view_backend_exportable_dma_buf_dispatch_release_buffer(), and not bother with any other operation like we do in the WKTR HeadlessViewBackend.

[Carlos Garcia Campos]

(In reply to Zan Dobersek from comment #6)
> (In reply to Carlos Garcia Campos from comment #5)
> > (In reply to Zan Dobersek from comment #4)
> > > Comment on attachment 313722 [details]
> > > Patch
> > > 
> > > We can't add a WPEBackend-mesa dependency to libWPEWebKit. I didn't account
> > > for that.
> > 
> > Ah :-( Could you elaborate? what's the problem of making libWPEWebKit link
> > to WPEBackend-mesa?
> > 
> 
> Because other platforms can't use that, so it can't be depended on
> universally.

I see.

> > > Same approach should be taken as with WKTR, creating a custom headless view
> > > backend.
> > 
> > What do you mean? Using a different headless view backend that doesn't need
> > WPEBackend-mesa?
> 
> We still use WPEBackend-mesa as a reference backend implementation, and
> depend on it for testing. There's no generic exportable interface, but it
> might make sense to look into creating one. But for now we have to leverage
> WPEBackend-mesa, just not as a hard-coded dependency of the main
> libWPEWebKit.so library.

Understood.

> What could be used for unit tests is basically a pass-through
> wpe_mesa_view_backend_exportable_dma_buf_client implementation. The
> export_dma_buf callback would only call
> wpe_mesa_view_backend_exportable_dma_buf_dispatch_frame_complete() and
> wpe_mesa_view_backend_exportable_dma_buf_dispatch_release_buffer(), and not
> bother with any other operation like we do in the WKTR HeadlessViewBackend.

I'm not familiar enough with WPE yet to understand this, thought :-P

[Carlos Garcia Campos]

Oops, sorry, yusuke and Caio I added you to the wrong bug :-P

[Carlos Garcia Campos]

Created attachment 327162 [details]
New patch

This won't apply because it depends on the patch adding the new API.

[Michael Catanzaro]

Comment on attachment 327162 [details]
New patch

Looks good to me, but maybe you should wait for Zan as this obviously does not implement his suggestion regarding the wpe_mesa_view_backend_exportable_dma_buf_client... thing.

[Carlos Garcia Campos]

Committed r225045: <https://trac.webkit.org/changeset/225045>