-
Notifications
You must be signed in to change notification settings - Fork 210
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
Rename MXSessionSyncProgress #1686
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| // | ||
| // Copyright 2022 The Matrix.org Foundation C.I.C | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| import Foundation | ||
|
|
||
| /// Different stages of starting up a session that may complete | ||
| /// in non-trivial amount of time. These stages can be observed | ||
| /// and used to update the user interface during session loading. | ||
| public enum MXSessionStartupStage { | ||
|
|
||
| /// Migrating data to a new store version | ||
| case migratingData(progress: Double) | ||
|
|
||
| /// Syncing with the server as Nth attempt | ||
| case serverSyncing(attempt: Int) | ||
|
|
||
| /// Processing server response | ||
| case processingResponse(progress: Double) | ||
|
|
||
| var isSyncing: Bool { | ||
| guard case .serverSyncing = self else { | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
| } | ||
|
|
||
| /// Delegate that recieves stage updates | ||
| public protocol MXSessionStartupProgressDelegate: AnyObject { | ||
| func sessionDidUpdateStartupStage(_ stage: MXSessionStartupStage) | ||
| } | ||
|
|
||
| /// Distinct phases of the `processingResponse` stage that report | ||
| /// their own local progress separately and complete in a given order | ||
| @objc public enum MXSessionProcessingResponsePhase: Int, CaseIterable { | ||
|
|
||
| /// Processing the response from the server | ||
| case syncResponse | ||
|
|
||
| /// Updating room summaries | ||
| case roomSummaries | ||
| } | ||
|
|
||
| /// `MXSessionStartupProgress` tracks individual stages and per-stage progress | ||
| /// during a session startup, where the application may be blocking user interactions. | ||
| @objc public class MXSessionStartupProgress: NSObject { | ||
| private var syncAttempts = 0 | ||
| private var stage: MXSessionStartupStage? { | ||
| didSet { | ||
| if let state = stage { | ||
| delegate?.sessionDidUpdateStartupStage(state) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public weak var delegate: MXSessionStartupProgressDelegate? { | ||
| didSet { | ||
| if let state = stage { | ||
| delegate?.sessionDidUpdateStartupStage(state) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Increment the total number of sync attempts during the `serverSyncing` stage | ||
| @objc public func incrementSyncAttempt() { | ||
| guard stage == nil || stage?.isSyncing == true else { | ||
| return | ||
| } | ||
|
|
||
| syncAttempts += 1 | ||
| stage = .serverSyncing(attempt: syncAttempts) | ||
| } | ||
|
|
||
| /// Update the local progress of a specific phase within `processingResponse` | ||
| /// | ||
| /// The overal progress will be computed and reported automatically | ||
| @objc public func updateProcessingProgress(_ progress: Double, forPhase phase: MXSessionProcessingResponsePhase) { | ||
| let totalPhases = Double(MXSessionProcessingResponsePhase.allCases.count) | ||
| let currentPhaseProgress = progress / totalPhases | ||
| let previousPhasesProgress = Double(phase.rawValue) / totalPhases | ||
| let totalProgress = previousPhasesProgress + currentPhaseProgress | ||
|
|
||
| stage = .processingResponse(progress: totalProgress) | ||
| } | ||
| } | ||
This file was deleted.
Oops, something went wrong.
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.
No change of functionality from
MXSessionSyncProgress, only renaming