rememberAsyncImagePainter doesn't render correctly with Roborazzi/Paparazzi

[colinrtwhite]

Describe the bug
rememberAsyncImagePainter doesn't render properly when used with Roborazzi and Paparazzi. The issue appears to be related to the fact that it it needs to wait for a valid drawSize, which is set in DrawScope.onDraw immediately before the painter is then drawn. AsyncImage avoids this timing issue by using ConstraintsSizeResolver to listen to its own composable constraints, which are set before the draw stage.

Interestingly, Paparazzi and Roborazzi both render rememberAsyncImagePainter incorrectly, but differently. When intrinsicContentSize is set to a fixed value this fixes the issue on Roborazzi, but not Paparazzi. It's possible there are different root causes, but this needs to be debugged further.

Work-around
It's possible to work-around this issue by setting any custom size:

rememberAsyncImagePainter(
    model = ImageRequest.Builder(LocalContext.current)
        .data("https://www.example.com/image.jpg")
        .size(Size.ORIGINAL)
        .build(),
    contentDescription = null,
)

To Reproduce
See RoborazziComposeTest.rememberAsyncImagePainter and PaparazziTest.rememberAsyncImagePainter in this repository.

Version
Reproduced with Coil 2.4.0, Roborazzi 1.6.0, and Paparazzi 1.3.1.

Related: cashapp/paparazzi#1123

[takahirom]

I'm not sure about the issue with Roborazzi. Does "to specify an immediate size" mean we shouldn't use ".size(Size.ORIGINAL)"? Could you let me know if this is correct?

Expected	Actual

[colinrtwhite]

@takahirom Yep, the expected + actual are what I'm seeing too. Part of the reason AsyncImage works, but rememberAsyncImagePainter doesn't is rememberAsyncImagePainter has to grab the size for the image request here during onDraw. This occurs after intrinsicSize is called, so intrinsicSize is initially Size.Unspecified. This gets updated to the painter's size after onDraw which seems to be OK on-device but is too late for the Roborazzi capture.

Paparazzi is doing something differently as it doesn't render the image at all - even if intrinsicSize is hardcoded to an exact pixel size.

Ideally size(Size.ORIGINAL) isn't necessary - it's a work-around that skips waiting for the canvas size in onDraw.

[kprakash2]

Any updates here? This has become a huge blocker for us. The workaround mentioned to use Size.ORIGINAL doesn't seem to work for us.

[colinrtwhite]

@kartik-prakash I haven't had a chance to take a look at this further as I'm focused on the 3.x work. If you're able to track down the issue locally, I'd accept a PR that patches the issue.

[colinrtwhite]

This has been fixed in the 3.x alpha releases.

[colinrtwhite]

Closing as this is fixed in the 3.x release branch. For earlier versions check out the work-around above.