Load User Defaults list asynchronously to improve performance #22535
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
Generated by 🚫 Danger |
salimbraksa
changed the base branch from
trunk
to
salim/issue/22479-debug-screen-local-flags
salimbraksa
commented
Feb 2, 2024
| @@ -16,40 +16,51 @@ final class BooleanUserDefaultsDebugViewModel: ObservableObject { | |||
| } | |||
| } | |||
|
|
|||
| @Published var userDefaultsSections: Sections = [] | |||
| @MainActor @Published private(set) var userDefaultsSections: Sections = [] | |||
There was a problem hiding this comment.
Decorating this property with @MainActor means that it must be mutated on the main thread.
salimbraksa
commented
Feb 2, 2024
|
|
||
| init(coreDataStack: CoreDataStack = ContextManager.shared, | ||
| init(coreDataStack: CoreDataStackSwift = ContextManager.shared, |
There was a problem hiding this comment.
The CoreDataStackSwift is the same as CoreDataStack protocol, but with additional async APIs.
salimbraksa
commented
Feb 2, 2024
| Task { | ||
| await self.load() | ||
| } | ||
| } |
There was a problem hiding this comment.
This load method is for convenience only so that callers don't have to do the Task { } wrapping.
salimbraksa
commented
Feb 2, 2024
| let (key, value) = keyValue | ||
| result.append(processSingleUserDefault(key: key, value: value)) | ||
| private func processGroupedUserDefaults(_ userDefaults: [String: Bool]) async -> [Row] { | ||
| let rows = try? await self.coreDataStack.performAndSave { [weak self] context -> [Row] in |
There was a problem hiding this comment.
When retrieving Core Data objects from a background thread, it's important not to use the mainContext since it's meant for the main thread only. Calling the main context from a background thread could cause the app to crash.
Instead, the method coreDataStack.performAndSave generates a new context and executes out the block on a background thread. This context is then used to fetch Core Data objects.
|
| App Name |  WordPress Alpha |
|
| Configuration | Release-Alpha | |
| Build Number | pr22535-a4e6276 | |
| Version | 24.1 | |
| Bundle ID | org.wordpress.alpha | |
| Commit | a4e6276 | |
| App Center Build | WPiOS - One-Offs #8667 |
|
| App Name |  Jetpack Alpha |
|
| Configuration | Release-Alpha | |
| Build Number | pr22535-a4e6276 | |
| Version | 24.1 | |
| Bundle ID | com.jetpack.alpha | |
| Commit | a4e6276 | |
| App Center Build | jetpack-installable-builds #7695 |
…issue/22479-debug-screen-local-flags-async-load
salimbraksa
force-pushed
the
salim/issue/22479-debug-screen-local-flags-async-load
branch
from
e0523c2 to
a4e6276
Compare
Base automatically changed from
salim/issue/22479-debug-screen-local-flags
to
trunk
February 5, 2024 16:34
Generated by 🚫 dangerJS |
justtwago
approved these changes
Feb 5, 2024
justtwago
deleted the
salim/issue/22479-debug-screen-local-flags-async-load
branch
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.
Related PR
This PR depends on:
Description
There was a short ( but noticeable ) delay when navigating to User Default Debug screen, this was due to running the
loadmethod on the main thread. This PR fixes the issue by running it asynchronously.CleanShot.2024-02-02.at.19.43.29.mp4
CleanShot.2024-02-02.at.19.44.52.mp4
Test Instructions
Regression Notes
Potential unintended areas of impact
Double check the User Defaults can be loaded.
What I did to test those areas of impact (or what existing automated tests I relied on)
N/A
What automated tests I added (or what prevented me from doing so)
N/A
PR submission checklist:
RELEASE-NOTES.txtif necessary.