-
Notifications
You must be signed in to change notification settings - Fork 29
feat(core): Freeze UIActivityIndicatorView spinners during snapshots #279
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
7b428fe
feat(core): Freeze UIActivityIndicatorView spinners during snapshots
NicoHinderling 64c784d
feat(core): Add opt-out for spinner freezing and exclude watchOS
NicoHinderling 9889f67
test(demo): Add loading indicator preview to MultiModuleDemo
NicoHinderling 9ee063c
ref(core): Use snapshot-specific spinner control names
NicoHinderling File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
27 changes: 27 additions & 0 deletions
27
Sources/SnapshotPreviewsCore/ActivityIndicatorFreezing.swift
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| #if canImport(UIKit) && !os(watchOS) | ||
| import UIKit | ||
| import ObjectiveC | ||
|
|
||
| enum ActivityIndicatorFreezing { | ||
| private static let installed: Void = { | ||
| guard | ||
| let original = class_getInstanceMethod(UIActivityIndicatorView.self, #selector(UIActivityIndicatorView.startAnimating)), | ||
| let replacement = class_getInstanceMethod(UIActivityIndicatorView.self, #selector(UIActivityIndicatorView.snapshotPreviews_frozenStartAnimating)) | ||
| else { return } | ||
| method_exchangeImplementations(original, replacement) | ||
| }() | ||
|
|
||
| static func isEnabled(environment: [String: String] = ProcessInfo.processInfo.environment) -> Bool { | ||
| environment["SNAPSHOTS_DISABLE_FREEZE_SPINNERS"] != "1" | ||
| } | ||
|
NicoHinderling marked this conversation as resolved.
|
||
|
|
||
| static func install() { | ||
| guard isEnabled() else { return } | ||
| _ = installed | ||
| } | ||
| } | ||
|
|
||
| private extension UIActivityIndicatorView { | ||
| @objc dynamic func snapshotPreviews_frozenStartAnimating() {} | ||
| } | ||
|
sentry[bot] marked this conversation as resolved.
|
||
| #endif | ||
This file contains hidden or 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
25 changes: 25 additions & 0 deletions
25
Tests/SnapshotPreviewsTests/ActivityIndicatorFreezingTests.swift
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| #if canImport(UIKit) && !os(watchOS) | ||
| import XCTest | ||
| import UIKit | ||
| @testable import SnapshotPreviewsCore | ||
|
|
||
| final class ActivityIndicatorFreezingTests: XCTestCase { | ||
| @MainActor | ||
| func testStartAnimatingIsNoOpAfterRenderingSetup() { | ||
| UIKitRenderingStrategy.setup() | ||
|
|
||
| let indicator = UIActivityIndicatorView(style: .medium) | ||
| indicator.startAnimating() | ||
|
|
||
| XCTAssertFalse(indicator.isAnimating) | ||
| } | ||
|
|
||
| func testFreezingIsEnabledByDefault() { | ||
| XCTAssertTrue(ActivityIndicatorFreezing.isEnabled(environment: [:])) | ||
| } | ||
|
|
||
| func testFreezingIsDisabledByEnvironmentVariable() { | ||
| XCTAssertFalse(ActivityIndicatorFreezing.isEnabled(environment: ["SNAPSHOTS_DISABLE_FREEZE_SPINNERS": "1"])) | ||
| } | ||
| } | ||
| #endif |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe you all tried this in the past, but could/should we just disable core animation 'actions' around the point where the snapshots are rendered? Or does that not work for some reason?
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @noahsmartin
(not going to treat this as a blocker btw)