REGRESSION (281042@main): [ macOS ] 2x tiled-drawing/scrolling/overflow/overflow-scrolled-* are flaky failing.
https://bugs.webkit.org/show_bug.cgi?id=277109
<rdar://132528380>

Reviewed by Simon Fraser.

The regressing change here allowed
RenderLayerBacking::adjustTiledBackingCoverage to succeed, even if the
underlying GraphicsLayer hadn't yet allocated a TileController (which happens
during the rendering update layer flush), and exposed existing races in these
tests.

This converts HistoricalVelocityData to use a Deque with inline capacity rather
than manually managing a std::array circular buffer. This should be
functionally identical, but removes a bunch of complexity from this class.

It also removes the filtering/coalescing of updates from this class. The
existing comment suggested that this previously many times per frame, but that
appears to no longer be the case. It looks like the only callers are from a
CATransaction pre-commit handler, and from Page::updateRendering (and flushing
layers from the test harness). It should be ok to adds a new entry for each of
these instances.

This fixes a race with the test, where requestAnimationFrame/updateRendering
isn't guaranteed to be exactly 1/60th of a second apart (and is frequently
less, since we run the first instance after idle immediately, not waiting for
vsync). We now get a computed velocity in this case, rather than leaving it
blank. There also was the issue where the code filtered on exactly 1/60th of a
second, and vsync aligned callbacks (with any amount of variance) would often
be ever-so-slightly under that.

Finally, use the same MonotonicTime timestamp for both velocityForNewData and
adjustTileCoverageWithScrollingVelocity (on mac, iOS uses the
m_haveExternalVelocityData path). These previously used separate calls to
::now(), resulting in the futureRect being moved by tiny amounts (unlikely to
be useful, but causes test failures).

It's plausible that in the future we would want instead to use a useful
timeDelta (maybe a vsync duration) in this case, to predict where future
scrolling might end up, instead of just adding a single tile in the scrolled
direction.

* LayoutTests/platform/mac-wk2/TestExpectations:
* LayoutTests/tiled-drawing/scrolling/overflow/overflow-scrolled-down-tile-coverage-expected.txt:
* LayoutTests/tiled-drawing/scrolling/overflow/overflow-scrolled-up-tile-coverage-expected.txt:
* Source/WebCore/platform/graphics/VelocityData.cpp:
(WebCore::HistoricalVelocityData::velocityForNewData):
* Source/WebCore/platform/graphics/VelocityData.h:
(WebCore::HistoricalVelocityData::clear):
* Source/WebCore/platform/graphics/ca/TileController.cpp:
(WebCore::TileController::adjustTileCoverageWithScrollingVelocity const):
(WebCore::TileController::adjustTileCoverageRectForScrolling):
* Source/WebCore/platform/graphics/ca/TileController.h:

Canonical link: https://commits.webkit.org/294876@main
7 files changed
tree: 61f02b3a13b574fda4198e6c1e8cf1ed89c48eea
  1. .github/
  2. Configurations/
  3. JSTests/
  4. LayoutTests/
  5. ManualTests/
  6. metadata/
  7. PerformanceTests/
  8. resources/
  9. Source/
  10. Tools/
  11. WebDriverTests/
  12. WebKit.xcworkspace/
  13. WebKitLibraries/
  14. Websites/
  15. .ccls
  16. .clang-format
  17. .dir-locals.el
  18. .editorconfig
  19. .gitattributes
  20. .gitignore
  21. .sourcefilters
  22. .submitproject
  23. .submitproject-tools
  24. CMakeLists.txt
  25. CMakePresets.json
  26. Introduction.md
  27. Makefile
  28. Makefile.shared
  29. ReadMe.md
ReadMe.md

WebKit

WebKit is a cross-platform web browser engine. On iOS and macOS, it powers Safari, Mail, Apple Books, and many other applications. For more information about WebKit, see the WebKit project website.

Trying the Latest

On macOS, download Safari Technology Preview to test the latest version of WebKit. On Linux, download Epiphany Technology Preview. On Windows, you'll have to build it yourself.

Reporting Bugs

  1. Search WebKit Bugzilla to see if there is an existing report for the bug you've encountered.
  2. Create a Bugzilla account to report bugs (and comment on them) if you haven't done so already.
  3. File a bug in accordance with our guidelines.

Once your bug is filed, you will receive email when it is updated at each stage in the bug life cycle. After the bug is considered fixed, you may be asked to download the latest nightly and confirm that the fix works for you.

Getting the Code

Run the following command to clone WebKit's Git repository:

git clone https://github.com/WebKit/WebKit.git WebKit

You can enable git fsmonitor to make many git commands faster (such as git status) with git config core.fsmonitor true

Building WebKit

Building for Apple platforms

Install Xcode and its command line tools if you haven't done so already:

  1. Install Xcode Get Xcode from https://developer.apple.com/downloads. To build WebKit for OS X, Xcode 5.1.1 or later is required. To build WebKit for iOS Simulator, Xcode 7 or later is required.
  2. Install the Xcode Command Line Tools In Terminal, run the command: xcode-select --install

Run the following command to build a macOS debug build with debugging symbols and assertions:

Tools/Scripts/build-webkit --debug

For performance testing, and other purposes, use --release instead. If you also need debug symbols (dSYMs), run:

Tools/Scripts/build-webkit --release DEBUG_INFORMATION_FORMAT=dwarf-with-dsym 

Embedded Builds

To build for an embedded platform like iOS, tvOS, or watchOS, pass a platform argument to build-webkit.

For example, to build a debug build with debugging symbols and assertions for embedded simulators:

Tools/Scripts/build-webkit --debug --<platform>-simulator

or embedded devices:

Tools/Scripts/build-webkit --debug --<platform>-device

where platform is ios, tvos or watchos.

Using Xcode

You can open WebKit.xcworkspace to build and debug WebKit within Xcode. Select the “Everything up to WebKit + Tools” scheme to build the entire project.

If you don't use a custom build location in Xcode preferences, you have to update the workspace settings to use WebKitBuild directory. In menu bar, choose File > Workspace Settings, then click the Advanced button, select “Custom”, “Relative to Workspace”, and enter WebKitBuild for both Products and Intermediates.

Building the GTK Port

For production builds:

cmake -DPORT=GTK -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
ninja
sudo ninja install

For development builds:

Tools/gtk/install-dependencies
Tools/Scripts/update-webkitgtk-libs
Tools/Scripts/build-webkit --gtk --debug

For more information on building WebKitGTK, see the wiki page.

Building the WPE Port

For production builds:

cmake -DPORT=WPE -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja
ninja
sudo ninja install

For development builds:

Tools/wpe/install-dependencies
Tools/Scripts/update-webkitwpe-libs
Tools/Scripts/build-webkit --wpe --debug

Building Windows Port

For building WebKit on Windows, see the WebKit on Windows page.

Running WebKit

With Safari and Other macOS Applications

Run the following command to launch Safari with your local build of WebKit:

Tools/Scripts/run-safari --debug

The run-safari script sets the DYLD_FRAMEWORK_PATH environment variable to point to your build products, and then launches /Applications/Safari.app. DYLD_FRAMEWORK_PATH tells the system loader to prefer your build products over the frameworks installed in /System/Library/Frameworks.

To run other applications with your local build of WebKit, run the following command:

Tools/Scripts/run-webkit-app <application-path>

iOS Simulator

Run the following command to launch iOS simulator with your local build of WebKit:

run-safari --debug --ios-simulator

In both cases, if you have built release builds instead, use --release instead of --debug.

To run other applications, for example MobileMiniBrowser, with your local build of WebKit, run the following command:

Tools/Scripts/run-webkit-app --debug --iphone-simulator <application-path>

Using Xcode

Open WebKit.xcworkspace, select intended scheme such as MobileMiniBrowser and an iOS simulator as target, click run.

Linux Ports

If you have a development build, you can use the run-minibrowser script, e.g.:

run-minibrowser --debug --wpe

Pass one of --gtk, --jsc-only, or --wpe to indicate the port to use.

Contribute

Congratulations! You’re up and running. Now you can begin coding in WebKit and contribute your fixes and new features to the project. For details on submitting your code to the project, read Contributing Code.