Skip to content
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

[#982] Background syncing #985

Merged

Conversation

LukasKorba
Copy link
Collaborator

@LukasKorba LukasKorba commented Jan 2, 2024

Closes #982
Closes #984
Closes #987

  • Background processing task implemented
  • Doc for the Background Synchronization added
  • changelog update
  • custom wifi check

This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

  • Self-review: Did you review your own code in GitHub's web interface? Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.
  • Does the code abide by the Coding Guidelines?
  • Automated tests: Did you add appropriate automated tests for any code changes?
  • Code coverage: Did you check the code coverage report for the automated tests? While we are not looking for perfect coverage, the tool can point out potential cases that have been missed.
  • Documentation: Did you update Docs as appropiate? (E.g README.md, etc.)
  • Run the app: Did you run the app and try the changes?
  • Did you provide Screenshots of what the App looks like before and after your changes as part of the description of this PR? (only applicable to UI Changes)
  • Rebase and squash: Did you pull in the latest changes from the main branch and squash your commits before assigning a reviewer? Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

Reviewer

  • Checklist review: Did you go through the code with the Code Review Guidelines checklist?
  • Ad hoc review: Did you perform an ad hoc review? In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.
  • Automated tests: Did you review the automated tests?
  • Manual tests: Did you review the manual tests?You will find manual testing guidelines under our manual testing section
  • How is Code Coverage affected by this PR? We encourage you to compare coverage before and after your changes and when possible, leave it in a better place. Learn More...
  • Documentation: Did you review Docs, README.md, LICENSE.md, and Architecture.md as appropriate?
  • Run the app: Did you run the app and try the changes? While the CI server runs the app to look for build failures or crashes, humans running the app are more likely to notice unexpected log messages, UI inconsistencies, or bad output data.

Copy link
Contributor

@pacu pacu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congrats on this long-awaited feature ❤️🎉

BACKGROUND_SYNCING.md Outdated Show resolved Hide resolved
@LukasKorba LukasKorba marked this pull request as draft January 3, 2024 11:50
LukasKorba added a commit to LukasKorba/secant-ios-wallet that referenced this pull request Jan 3, 2024
- Background processing task implemented
- debug version of scheduling for testing purposes (the final one is commented out for now)
- Doc for the Background Synchronization added

[Electric-Coin-Company#982] Background syncing

- changelog update
- doc 2nd pass fixes

[Electric-Coin-Company#982] Background syncing

- refactor
- custom wifi check

[Electric-Coin-Company#982] Background syncing

- code cleanup + refactor

[Electric-Coin-Company#982] Background syncing

- uni tests fixed

[Electric-Coin-Company#982] Background syncing (Electric-Coin-Company#985)

- New background task with responsibility to schedule the syncing background task implemented - this is the way the recurrent tasks are implemented because the official API last recurrent scheduling
- Background processing task implemented
- debug version of scheduling for testing purposes (the final one is commented out for now)
- Doc for the Background Synchronization added

[Electric-Coin-Company#982] Background syncing

- changelog update
- doc 2nd pass fixes

[Electric-Coin-Company#982] Background syncing

- refactor
- custom wifi check

[Electric-Coin-Company#982] Background syncing

- code cleanup + refactor

[Electric-Coin-Company#982] Background syncing

- uni tests fixed

[Electric-Coin-Company#982] Background syncing (Electric-Coin-Company#985)

- New background task with responsibility to schedule the syncing background task implemented - this is the way the recurrent tasks are implemented because the official API last recurrent scheduling

[Electric-Coin-Company#982] Background syncing (Electric-Coin-Company#985)

- MD typo fixed
@LukasKorba LukasKorba marked this pull request as ready for review January 3, 2024 13:23
@LukasKorba LukasKorba requested a review from pacu January 3, 2024 13:23
@LukasKorba
Copy link
Collaborator Author

LukasKorba commented Jan 3, 2024

I realized we should implement at least one more advanced thing for background syncing - I call it Advanced Background Syncing, see #987. The scheduling in background tasks API lacks recurrence and typically this is solved with another background task that's only purpose is to create the recurrence "manually". Such task doesn't require a network or power and can finish its job real quick. With this extra work we increased the efficiency and meaning of background syncing by a huge leap.

I updated the code.

Copy link
Collaborator

@HonzaR HonzaR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mainly reviewed the documentation and left some advice on it.

I have one more general note on the background syncing feature, which could be addressed in a follow-up. Should we provide a straightforward UI for tweaking when the BG sync is triggered? So we ensure this feature is available for everyone because having it restricted on time, power, and connection type could make most of the users asking why the feature is not working. The new settings could have:

  • on/off for the whole sync feature (default on)
  • required plugged-in power (default on)
  • required wifi connection (default on)
  • time picker (default 3 am)


### Steps to make it work
1. Add a capability of `background modes` in the settings of the xcode project.
2. Turn the `Background Processing` mode on in the new capability.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend using reset numbering here as it's more future-proof, i.e.

1. Add a capability of `background modes` in the settings of the xcode project.
1. Turn the `Background Processing` mode on in the new capability.
...

See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists

@LukasKorba LukasKorba merged commit 1d60dd3 into Electric-Coin-Company:main Jan 8, 2024
@LukasKorba LukasKorba deleted the 982-Background-syncing branch April 4, 2024 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Advanced background syncing Check wifi connectivity only Background syncing
3 participants