Add Emerge snapshot testing #1785
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tonidero
reviewed
Sep 3, 2024
| sha.set("") | ||
| // TODO: RevenueCat to set from CircleCi variables | ||
| // Should skip setting for main branch uploads | ||
| baseSha.set("") |
There was a problem hiding this comment.
Just to check, this will be the sha for the latest commit in main right? I don't think CircleCI gives us this https://circleci.com/docs/variables/? Though we can calculate it through a script of course
There was a problem hiding this comment.
That is correct, needs to be the commit in the default branch (i.e. main) that the PR is based on. Seems we might be able to get it from GitHub data in CircleCI.
Proposition here: let's add this in a future PR. Most snapshots integrations are best as two steps anyway:
- Add uploads from all main branch commits. This way we can ensure everything's running properly and we get snapshots for all base builds.
- In follow up PR, we add support for PR commits. That way diffs we can test that diffs are working properly.
So this PR will be step 1 above, and you or I can follow with step 2 where we add the baseSha just for PR commits. Sound good?
There was a problem hiding this comment.
Makes a lot of sense thank you!
tonidero
changed the base branch from
main
to
external/rbro112/add-emerge-snapshot-testing
tonidero
approved these changes
Sep 5, 2024
tonidero
merged commit f7b77f6
into
RevenueCat:external/rbro112/add-emerge-snapshot-testing
This was referenced Sep 5, 2024
tonidero
added a commit
that referenced
this pull request
Sep 6, 2024
### Checklist - [ ] If applicable, unit tests - [ ] If applicable, create follow-up issues for `purchases-ios` and hybrids ### Motivation Adds Emerge snapshots to purchases UI, as RevenueCat has expressed interest and we figured we'd make the process easier 😄 . ### Description Adds the basic integration necessary for getting up and running with Emerge snapshots: - Adds the Emerge gradle plugin to the `testpurchasesuiandroidcompatibility` module. - Worth noting that Emerge requires the plugin to be set on an `application` module vs a library module. @tonidero had mentioned that the Previews we want to snapshot are in `:ui:revenuecatui`. Given that this application module depends directly on the `:ui:revenuecatui` module and snapshots use a debug variant, all code should be present from that module, giving Emerge all `@Previews` automatically. - Adds what I believe is the necessary fastlane/CircleCI setup to invoke snapshots, but my experience here is a bit more limited. - Updates Compose BOM from `2023.05.01` to `2024.06.00`, as Emerge snapshots rely on compose foundation, which can't be resolved without an update. Happy to help test this! For the best usage, we recommend running snapshots on every commit - all PR commits and main commits. Emerge will run & snapshot all `@Preview` annotated functions, storing the generated snapshots based on the `sha` of that upload. If the commit has a valid `baseSha` set and we have snapshots for that `baseSha`, we'll automatically compare the snapshots and let you know if there's any visual changes directly on the PR. See our [snapshot docs](https://docs.emergetools.com/docs/snapshot-testing) for all functionality! Remaining tasks to implement to complete this: - [ ] Wire up CircleCI variables to see the `sha` & `baseSha` in the Emerge gradle plugin config block. These are what we use for [diffing snapshots](https://docs.emergetools.com/docs/continuous-integration). Will do this in follow up PRs Contributed by @rbro112 in #1785 --------- Co-authored-by: Ryan Brooks <[email protected]>
tonidero
added a commit
that referenced
this pull request
Sep 12, 2024
**This is an automatic release.** ### Bugfixes * Fixes a Paywall Template 7 crash when none of the tiers have any available products. (#1834) via JayShortway (@JayShortway) ### Dependency Updates * Bump fastlane-plugin-revenuecat_internal from `85e1c83` to `5140dbc` (#1835) via dependabot[bot] (@dependabot[bot]) ### Other Changes * [EXTERNAL] Add Emerge snapshot testing (#1785) by @rbro112 (#1831) via Toni Rico (@tonidero) --------- Co-authored-by: revenuecat-ops <[email protected]> Co-authored-by: Toni Rico <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
purchases-iosand hybridsMotivation
Adds Emerge snapshots to purchases UI, as RevenueCat has expressed interest and we figured we'd make the process easier 😄 .
Description
Adds the basic integration necessary for getting up and running with Emerge snapshots:
testpurchasesuiandroidcompatibilitymodule.applicationmodule vs a library module. @tonidero had mentioned that the Previews we want to snapshot are in:ui:revenuecatui. Given that this application module depends directly on the:ui:revenuecatuimodule and snapshots use a debug variant, all code should be present from that module, giving Emerge all@Previewsautomatically.2023.05.01to2024.06.00, as Emerge snapshots rely on compose foundation, which can't be resolved without an update. Happy to help test this!For the best usage, we recommend running snapshots on every commit - all PR commits and main commits. Emerge will run & snapshot all
@Previewannotated functions, storing the generated snapshots based on theshaof that upload.If the commit has a valid
baseShaset and we have snapshots for thatbaseSha, we'll automatically compare the snapshots and let you know if there's any visual changes directly on the PR. See our snapshot docs for all functionality!Remaining tasks for RevenueCat to implement to complete this:
EMERGE_API_TOKENas a GitHub secretsha&baseShain the Emerge gradle plugin config block. These are what we use for diffing snapshots.