Support DelayedPreviews (not tested, just initial push) #633

sergio-sastre · 2025-01-18T12:32:43Z

No description provided.

takahirom · 2025-01-19T04:17:41Z

👀

takahirom · 2025-01-19T04:34:07Z

The build failed because of a setting in the root build.gradle file:

tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
  compilerOptions {
    freeCompilerArgs.addAll(
      "-Xopt-in=com.github.takahirom.roborazzi.InternalRoborazziApi",
      "-Xopt-in=com.github.takahirom.roborazzi.ExperimentalRoborazziApi",
    )
  }
}

I've addressed this by excluding the "roborazzi-annotations" module from this setting.

takahirom · 2025-01-19T05:17:06Z

I understand this is difficult, especially regarding ComposeRule. I'm exploring solutions. Please bear with me.

github-actions · 2025-01-19T05:40:42Z

Snapshot diff report

File name	Image
com.github.takahirom .preview.tests.Previ ewsKt.PreviewDelayed _TIME_0ms_compare.pn g
com.github.takahirom .preview.tests.Previ ewsKt.PreviewDelayed _TIME_516ms_compare. png
com.github.takahirom .preview.tests.Previ ewsKt.PreviewDelayed _TIME_1032ms_compare .png
com.github.takahirom .preview.tests.Previ ewsKt.PreviewWithEmp tyOptions_compare.pn g
PreviewNormal_compar e.png

takahirom · 2025-01-19T05:42:40Z

@sergio-sastre
Thank you for your contribution! I've made some minor changes to utilize RoborazziComposeOptions, which I believe results in a slight improvement. However, we may need to consider the preview changes. 👀

https://github.com/takahirom/roborazzi/pull/633/files/4c4646c6e01373c1becf9bfc9c49b4c52deb0499..2764156a105defb07e7b21376de596e2d46f08d6

takahirom · 2025-01-19T07:15:29Z

I think we might have multiple activities for each capture. I'm looking a little further into this.

sergio-sastre · 2025-01-19T08:17:41Z

Great work!
Let me know your thoughts after exploring and we can discuss how to better solve the problem 😊

takahirom · 2025-01-19T10:49:59Z

Thanks! I'm considering whether the name "DelayedPreview" is appropriate.
Currently, using this implementation prevents us from utilizing the activityTheme() option, which isn't used by the PreviewScreenshots parameter. While this shouldn't pose an immediate issue, it limits the robustness of the RoborazziComposeActivityScenarioCreatorOption API. I'm open to suggestions for improvement but currently lack a concrete solution.

sergio-sastre · 2025-01-19T15:19:26Z

Thanks! I'm considering whether the name "DelayedPreview" is appropriate.
Currently, using this implementation prevents us from utilizing the activityTheme() option, which isn't used by the PreviewScreenshots parameter. While this shouldn't pose an immediate issue, it limits the robustness of the RoborazziComposeActivityScenarioCreatorOption API. I'm open to suggestions for improvement but currently lack a concrete solution.

I've pushed a preview with the DelayedPreview annotation and the current implementation does not seem to work.
I'd say, let's focus first on having a working implementation, and then see what works or doesn't work and search for possible solutions

sergio-sastre · 2025-01-19T16:36:28Z

...anner-support/src/main/java/com/github/takahirom/roborazzi/RoborazziPreviewScannerSupport.kt

@@ -143,18 +197,28 @@ interface ComposePreviewTester<T : Any> {

 @ExperimentalRoborazziApi
 class AndroidComposePreviewTester : ComposePreviewTester<AndroidPreviewInfo> {
+  private val composeTestRule by lazy { createAndroidComposeRule<RoborazziActivity>() }


@takahirom
Actually, it does not matter whether lazy or not since it is called in EVERY test.

I was afraid that using this TestRule in every test would increase the execution time, but I haven't noticed any significant increase though... I believe that is different from Activity Scenario, which launches an Activity and that does add execution time indeed...

It could also be that my laptop (Mac M2) is very fast and the amount of preview tests is not that high (less than 15...). I'm unsure about this

I believe test isolation is important. I think it's good to have a separate Activity for each test, as we do now. Of course, it depends on how slow it is, but I'm fine with it.

I believe that too. However, even with this lazy, the ComposeTestRule is still being created in EVERY test, because it is called in other parts of the AndroidPreviewTester ( I’ve debugged it).
I’d also like it to be created when necessary … any ideas on how to avoid that?

sergio-sastre · 2025-01-19T16:38:12Z

roborazzi-compose/src/main/java/com/github/takahirom/roborazzi/RoborazziCompose.kt

        @SuppressLint("VisibleForTests")
        val viewRootForTest = composeView.getChildAt(0) as ViewRootForTest
+        doBeforeCapture()


@takahirom
I'm open to other solutions, but it does have to happen at this point. That was the reason why it was not working previously: the advanceTimeBy() was being before the Composable was set as content in the Activity

sergio-sastre · 2025-01-19T16:44:03Z

...nnotations/src/main/java/com/github/takahirom/roborazzi/annotations/DelayCaptureRoboImage.kt

+// TODO -> maybe add also parameter for ignoreFrames, as used in mainClock.advanceTime()
+// TODO -> Make BINARY annotation only applicable to Methods
+// TODO -> Docu: mention about the 16ms frame in Android
+annotation class DelayCaptureRoboImage(val delayInMillis: Long)


@takahirom
Feel free to give feedback on the name ;)

I'm thinking whether it'd also make sense to add the capability to take screenshots after a set of time intervals... what could be interesting to verify animations.

I think in that case, we could create a different annotation for that like
IntervalCaptureRoboImage(intervalsInMillis: arrayOf(500, 100, 200))

If you like the idea, we could make it either in this PR or afterwards, up to you :)

Thanks. I think the name CaptureRoboImage is a little misleading when used for DelayCaptureRoboImage, because we filter Previews by @Preview and not by @DelayCaptureRoboImage. So I've renamed it to RoboManualAdvance .

As for IntervalCaptureRoboImage, could we perhaps have a repeatable annotation?
When considering IntervalCaptureRoboImage, the use of CaptureRoboImage name is understandable though.

@RoboManualAdvance(advanceTimeMillis = 100) @RoboManualAdvance(advanceTimeMillis = 200) @RoboManualAdvance(advanceTimeMillis = 500)

Thanks for the suggestion!
I am also not very convinced about RoboManualAdvance, I think it does not tell its purpose clearly.

Its purpose is to advance the clock before capturing a screenshot.
I think something similar to
AdvanceClockBeforeCapture or the like makes more sense.

as of repeatable annotations, ComposablePreviewScanner still does not support them as stated in the corresponding method:

https://github.com/sergio-sastre/ComposablePreviewScanner/blob/ea9962eada536d81b9c8cdfa3df586df03c182a9/core/src/main/java/sergio/sastre/composable/preview/scanner/core/preview/ComposablePreview.kt#L34

That lies on me since it is a bit tricky 😅.
However, I agree that is a better solution.
I can create an issue and try to address it to support that in the future

I‘m planning to release support for repeated annotations in ComposablePreviewScanner 0.5.1.

However, what would be your expectation?
Would „duplicate“ previews for each repeated annotation, or would be more like a getRepeatedAnnotation() and get a list with all annotations?
I‘m more inclined to the last one, but I‘m wondering how we could integrate it in this case 🤔

Thanks. It might be good to consider when we should add another annotation.

@RoboManualAdvance(advanceTimeMillis = 100) @RoboManualAdvance(advanceTimeMillis = 200) @RoboFoo(true) @RoboFoo(false)

We might want to take a screenshot when RoboFoo is true and RoboManualAdvance is 100. So it might be good to have one annotation like @RoboComposeOption()? For example, we could use @RoboComposeOption(autoAdvance = false, advanceTimeMillis = 100, foo = true).

I believe I was able to implement a workaround.

63610f7

This is unrelated, but one area I'd like to investigate is whether we can incorporate users' custom ComposeRule or similar components in this implementation.

I have removed the options() override from AndroidComposePreviewTester and added ComposeRuleFactory to JUnit4TestLifecycleOptions. While this approach helps address the challenges of integrating custom ComposeRules, it introduces significant breaking changes that users need to be aware of during migration.
2056650

My main concern is whether the KMP Preview support is currently functioning properly. As we currently lack test cases, I would like to establish comprehensive test cases to verify its functionality.

I've added KMP Preview support sample, and it works great.

However, I believe we need to significantly refactor this code. The main issue is that we currently cannot capture multiple screenshots using different manualClockOptions because captureRoboImage{} closes the ActivityScenario.
I suggest creating separate tests for each screenshot to make the separation clearer, which would also require introducing a breaking change to the previews() function.

I've changed it and will review my code. 👀
1d3cade

… for one preview function

…ve type safety

…ed lazy initialization

takahirom · 2025-03-01T05:06:11Z

This is going to be a big release for users using Compose Preview Support. I'm thinking releasing this as 1.44.0-alpha01 to gather feedback.

Breaking changes for Experimental Compose Preview Support users

Key interface changes

ComposePreviewTester now handles TestParameter instead of raw ComposablePreview
New @RoboComposePreviewOptions annotation enables time-based captures
roborazzi-annotations module added as new dependency

Migration steps

Update custom testers:

// Before
class CustomTester : ComposePreviewTester<AndroidPreviewInfo> {
  override fun previews(): ComposablePreview<AndroidPreviewInfo>  = AndroidComposablePreviewScanner().scanPackageTrees(...)
  override fun test(preview: ComposablePreview<AndroidPreviewInfo>)
}

// After
class CustomTester : ComposePreviewTester<AndroidPreviewJUnit4TestParameter> {
  override fun testParameters(): AndroidPreviewJUnit4TestParameter = AndroidComposablePreviewScanner().scanPackageTrees(...)
  override fun test(preview: AndroidPreviewJUnit4TestParameter)
}

Add dependency:

implementation("io.github.takahirom.roborazzi:roborazzi-annotations:")

Use new annotation for time-based captures:

@RoboComposePreviewOptions(
  manualClockOptions = [ManualClockOptions(advanceTimeMillis = 500L)]
)
@Preview
@Composable
fun DelayedPreview() {
  // Content with animations/timed state changes
}

Sample implementations

[TODO: Update link]

CustomPreviewTester handling Android previews
MultiplatformPreviewTester for KMP previews

These changes enable annotation-driven screenshot control while maintaining backward compatibility for most preview configurations.

initial push (not tested)

4c4646c

sergio-sastre mentioned this pull request Jan 18, 2025

Render compose component with clock based logic #605

Open

Exclude roborazzi-annotations from allprojects

7ac7567

takahirom added 2 commits January 19, 2025 14:31

Use RoborazziComposeOptions instead of doBeforeCaptureRoboImage

b87c1de

Fix delayed time logic

2764156

takahirom added 2 commits January 19, 2025 14:54

Use JDK 17

13c6c7b

Use JDK 17

31da1d4

Use ComposeTestRule for Preview Activity

2f0b89d

Push example for Preview with Delay

629241e

Push first working solution

6071e3c

sergio-sastre commented Jan 19, 2025

View reviewed changes

takahirom added 2 commits January 20, 2025 09:53

Add some content for checking PreviewDelayed

07986a5

Rename DelayCaptureRoboImage to RoboManualAdvance

1364461

takahirom mentioned this pull request Jan 20, 2025

Roborazzi 1.37.0 and above brokes almost all screenshots in our app #628

Closed

sergio-sastre mentioned this pull request Jan 22, 2025

Add support for repeatable Annotations sergio-sastre/ComposablePreviewScanner#40

Open

takahirom added 3 commits January 28, 2025 11:50

Merge branch 'main' into origin/feature/takahirom#605

f05360a

Rename to RoboComposePreviewOptions

cbac859

Allow multiple values

f21f6ff

takahirom mentioned this pull request Feb 8, 2025

Is it possible to enable LocalInspectionMode for auto-generated tests from Compose Preview? #652

Open

takahirom added 2 commits February 15, 2025 18:01

Use reflection for getting annotation

63610f7

Remove .idea/AndroidProjectSystem.xml

387731f

takahirom added 14 commits February 16, 2025 16:05

Make it a breaking change to allow for user migration

2056650

Fix integration test

fc3c11b

Add document to activityTheme

c938c2f

Refactor

5f1caf5

Fix test

5a35a67

Add sample-generate-preview-tests-multiplatform

2532163

Add manualClockOptions

e8f64b4

Change the tester interface to enable generating multiple screenshots…

1d3cade

… for one preview function

Take time zero screenshot

56d4e84

Fix integration test

b37c6bf

Fix preview test preview

0c3712c

Use testParameter.composeTestRule

b99caea

Add PreviewWithEmptyOptions preview test

bf9851a

Refactor CustomPreviewTester to support JUnit4TestParameter and impro…

ae1b052

…ve type safety

takahirom force-pushed the origin/feature/#605 branch from f93e261 to ae1b052 Compare March 1, 2025 03:55

takahirom added 2 commits March 1, 2025 13:40

Refactor JUnit4TestParameter to use composeTestRuleFactory for improv…

d780a51

…ed lazy initialization

Add annotation-based capture control for Compose Previews

4efb881

takahirom marked this pull request as ready for review March 8, 2025 06:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support DelayedPreviews (not tested, just initial push) #633

Support DelayedPreviews (not tested, just initial push) #633

sergio-sastre commented Jan 18, 2025

takahirom commented Jan 19, 2025

takahirom commented Jan 19, 2025

takahirom commented Jan 19, 2025

github-actions bot commented Jan 19, 2025 •

edited

Loading

takahirom commented Jan 19, 2025 •

edited

Loading

takahirom commented Jan 19, 2025

sergio-sastre commented Jan 19, 2025

takahirom commented Jan 19, 2025

sergio-sastre commented Jan 19, 2025

sergio-sastre Jan 19, 2025 •

edited

Loading

takahirom Jan 20, 2025

sergio-sastre Jan 20, 2025

sergio-sastre Jan 19, 2025

sergio-sastre Jan 19, 2025 •

edited

Loading

takahirom Jan 20, 2025 •

edited

Loading

sergio-sastre Jan 20, 2025

sergio-sastre Jan 22, 2025

takahirom Jan 23, 2025 •

edited

Loading

takahirom Feb 15, 2025

takahirom Feb 16, 2025 •

edited

Loading

takahirom Feb 22, 2025

takahirom Feb 23, 2025 •

edited

Loading

takahirom Feb 23, 2025

takahirom commented Mar 1, 2025 •

edited

Loading

Support DelayedPreviews (not tested, just initial push) #633

Are you sure you want to change the base?

Support DelayedPreviews (not tested, just initial push) #633

Conversation

sergio-sastre commented Jan 18, 2025

takahirom commented Jan 19, 2025

takahirom commented Jan 19, 2025

takahirom commented Jan 19, 2025

github-actions bot commented Jan 19, 2025 • edited Loading

takahirom commented Jan 19, 2025 • edited Loading

takahirom commented Jan 19, 2025

sergio-sastre commented Jan 19, 2025

takahirom commented Jan 19, 2025

sergio-sastre commented Jan 19, 2025

sergio-sastre Jan 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sergio-sastre Jan 19, 2025 • edited Loading

Choose a reason for hiding this comment

takahirom Jan 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom Feb 16, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom Feb 23, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

takahirom commented Mar 1, 2025 • edited Loading

Breaking changes for Experimental Compose Preview Support users

Key interface changes

Migration steps

Sample implementations

github-actions bot commented Jan 19, 2025 •

edited

Loading

takahirom commented Jan 19, 2025 •

edited

Loading

sergio-sastre Jan 19, 2025 •

edited

Loading

sergio-sastre Jan 19, 2025 •

edited

Loading

takahirom Jan 20, 2025 •

edited

Loading

takahirom Jan 23, 2025 •

edited

Loading

takahirom Feb 16, 2025 •

edited

Loading

takahirom Feb 23, 2025 •

edited

Loading

takahirom commented Mar 1, 2025 •

edited

Loading