runOrScheduleOnMainActor function
#18
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
lukaskollmer
changed the title
RunOrScheduleOnMainActor functionrunOrScheduleOnMainActor function
the previous version could in some situations fail, if the main loop ran concurrently/before the schedule function returned and the TestActor continued execution (at least that's my guess, based on the fact that in some test runs the bool would unexpectedly be true.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #18 +/- ##
==========================================
+ Coverage 90.44% 90.61% +0.18%
==========================================
Files 13 14 +1
Lines 596 607 +11
==========================================
+ Hits 539 550 +11
Misses 57 57
Continue to review full report in Codecov by Sentry.
|
PSchmiedmayer
approved these changes
Jan 6, 2025
philippzagar
approved these changes
Jan 6, 2025
There was a problem hiding this comment.
Thanks for the PR @lukaskollmer! 🚀
Let's tag this quickly so that we can use it within SpeziViews and SpeziChat!
1 task
philippzagar
added a commit
to StanfordSpezi/SpeziChat
that referenced
this pull request
Jan 7, 2025
# Use SpeziFoundation `runOrScheduleOnMainActor()` ## ♻️ Current situation & Problem Currently, SpeziChat manually checks and then runs or schedules (on the `MainActor`) `onPreferenceClosure()`s changes that modify `MainActor` isolated `State` properties in the SwiftUI `View`. With StanfordSpezi/SpeziFoundation#18, this lengthy and repetitive code piece is now abstracted within SpeziFoundation. ## ⚙️ Release Notes - Use [SpeziFoundation `runOrScheduleOnMainActor()`](StanfordSpezi/SpeziFoundation#18) function ## 📚 Documentation Proper documentation changes in DocC and Markdown. ## ✅ Testing No new test cases added, as behavior stays strictly the same. ## 📝 Code of Conduct & Contributing Guidelines By submitting creating this pull request, you agree to follow our [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md): - [x] I agree to follow the [Code of Conduct](https://github.com/StanfordSpezi/.github/blob/main/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/StanfordSpezi/.github/blob/main/CONTRIBUTING.md).
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.
runOrScheduleOnMainActorfunction♻️ Current situation & Problem
As part of dealing with the
onPreferenceChangeAPI changes, we ended up having to duplicate code in a bunch of places, in a way that always used the same fundamental pattern (ie, if we're on the MainActor, run a piece of code directly, otherwise schedule it onto the MainActor).This PR simply abstracts this into a new global
func runOrScheduleOnMainActor.⚙️ Release Notes
runOrScheduleOnMainActorfunction📚 Documentation
n/a; all new code is directly documented.
✅ Testing
there are new test cases for the new function
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: