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

Refactor syncUpload Method to improve flow and error handling #2173

Merged
merged 18 commits into from
Oct 5, 2023
Merged

Refactor syncUpload Method to improve flow and error handling #2173

merged 18 commits into from
Oct 5, 2023

Conversation

omarismail94
Copy link
Contributor

@omarismail94 omarismail94 commented Sep 15, 2023

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

One of the PRs to fix #760

Description
Clear and concise code change description.

  • syncUpload method is now structured to emit Flow<FetchProgress>
  • eliminated Flow<UploadState> and instead, have the uploader return an UploadSyncResult, that can be processed by the syncUpload method
  • Improved readability, with a clear and understandable flow of logic. Each step of the process is now more coherent and aligned with its functionality, improving maintainability (no more returning a flow within a flow and making sure you collect both at different places in the code)

Current upload:

image

Proposed upload:

image

Alternative(s) considered
Have you considered any alternatives? And if so, why have you chosen the approach in this PR?

Type
Choose one: (Bug fix | Feature | Documentation | Testing | Code health | Builds | Releases | Other)

Screenshots (if applicable)

Checklist

  • I have read and acknowledged the Code of conduct.
  • I have read the Contributing page.
  • I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
  • I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
  • I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
  • I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
  • I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

@omarismail94 omarismail94 marked this pull request as ready for review September 27, 2023 10:25
@omarismail94 omarismail94 changed the title use FetchProgress to track upload progress Refactor syncUpload Method to improve flow and error handling Sep 27, 2023
Copy link
Collaborator

@jingtang10 jingtang10 left a comment

Choose a reason for hiding this comment

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

have you tested the demo app with this?

@omarismail94
Copy link
Contributor Author

have you tested the demo app with this?

@jingtang10 yes, and it worked. I was able to see the upload status update emissions being printed in the logs

Copy link
Collaborator

@jingtang10 jingtang10 left a comment

Choose a reason for hiding this comment

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

woohoo!

@omarismail94 omarismail94 enabled auto-merge (squash) October 5, 2023 12:27
@omarismail94 omarismail94 merged commit c2b2e84 into google:master Oct 5, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

Create new resources on the server using POST
3 participants