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.

Sign up for GitHub

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

Jump to bottom

Performance: Optimized data loading of course #416

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Performance: Optimized data loading of course #416

wants to merge 5 commits into from

Conversation

Sh-AhsanArif
Copy link

  • Optimized data loading on app dashboard screen (cached data first)
  • Optimized data loading on course outline screen (cached data first)
  • Minor code refactoring

@openedx-webhooks
Copy link

Thanks for the pull request, @Sh-AhsanArif!

This repository is currently maintained by @openedx/openedx-mobile-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 16, 2025
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 22, 2025
@e0d
Copy link

e0d commented Jan 23, 2025

@Sh-AhsanArif as you are covered by the Arbisoft entity CLA, I've added you to the triage team. This will allow tests to run automatically on your PRs. Please accept the invite.

@Sh-AhsanArif Sh-AhsanArif force-pushed the ahsan/data-loading-optimisations branch from cd9e651 to e816e86 Compare January 23, 2025 21:39
@Sh-AhsanArif Sh-AhsanArif force-pushed the ahsan/data-loading-optimisations branch from e816e86 to e86d49f Compare January 24, 2025 20:39
@Sh-AhsanArif Sh-AhsanArif force-pushed the ahsan/data-loading-optimisations branch from d2c5156 to 44803f0 Compare January 27, 2025 11:52
@PavloNetrebchuk
Copy link
Contributor

@Sh-AhsanArif
Hi, great job. If you are moving the logic to Flow, it would be great to make methods that do not return Flow private. What do you think?

@Sh-AhsanArif
Copy link
Author

Hi @PavloNetrebchuk

Thank you for your feedback! That’s a great suggestion, and I completely agree that moving all relevant methods to return Flow would improve consistency. However, making these changes in this PR would increase its scope and require additional effort and testing.
If the experience with Flow in this implementation turns out to be positive, we should consider replacing all previous methods accordingly. I’d be more than happy to take that up in a separate PR to ensure a smooth transition.

Let me know what you think!

@PavloNetrebchuk
Copy link
Contributor

@Sh-AhsanArif
Okay, please resolve the conflicts and I'll approve

@Sh-AhsanArif Sh-AhsanArif force-pushed the ahsan/data-loading-optimisations branch from 44803f0 to d28d821 Compare January 29, 2025 12:06
@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 29, 2025
@PavloNetrebchuk
Copy link
Contributor

Hi, @Sh-AhsanArif

I’ve reviewed the app again and have a few questions:
1. When opening a course in a fresh install of the app, we encounter a NoCachedDataException. Could you please take a look and fix this?
2. The Result layer seems unnecessary and inconsistent with the rest of the app. Since we typically use catch, it would be great if we could stick to this approach for consistency.
3. I have some doubts regarding the following code in CourseContainerViewModel and similar code in CourseOutlineViewModel:

courseFlow.take(1).combine(enrollmentFlow.take(1)) { course, enrollment ->
    course to enrollment
}

Could you clarify why we are using take(1) here? Would it be possible to achieve the same result with:

courseFlow.combine(enrollmentFlow) { course, enrollment ->
    ...
}

@omerhabib26
Copy link
Contributor

omerhabib26 commented Feb 6, 2025 •
edited
Loading

Hey @Sh-AhsanArif, thank you so much for this improvement! I had a chance to take a quick look, and I noticed a couple of small UI issues in your repo, as shown in the video:

  • There’s a glitch on the home screen when the user lands for the first time. IMO, it should show a loader instead.
  • The API seems to be crashing on the Course dashboard with the error org.openedx.core.exception.NoCachedDataException.
OpenEdxPR.webm

@Sh-AhsanArif
Copy link
Author

Hey @PavloNetrebchuk, @omerhabib26

Thank you for reviewing the PR and providing valuable feedback. I’ve incorporated the suggested changes and fixed the mentioned issues. Please have a look at the latest updates and let me know if any further adjustments are needed.
I appreciate your time and guidance!

@PavloNetrebchuk
Copy link
Contributor

@Sh-AhsanArif Hello. It looks good to me. Just 2 question ⬆️

@Sh-AhsanArif Sh-AhsanArif force-pushed the ahsan/data-loading-optimisations branch from f9b8ad1 to aaee6ff Compare February 12, 2025 13:25
PavloNetrebchuk
PavloNetrebchuk approved these changes Feb 12, 2025
View reviewed changes
Copy link
Contributor

@PavloNetrebchuk PavloNetrebchuk left a comment

Choose a reason for hiding this comment

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

Approve

@omerhabib26
Copy link
Contributor

Thank you @Sh-AhsanArif for the update. I'll start its review on monday.

omerhabib26
omerhabib26 approved these changes Feb 17, 2025
View reviewed changes
Copy link
Contributor

@omerhabib26 omerhabib26 left a comment

Choose a reason for hiding this comment

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

only a minor nit

app/schemas/org.openedx.app.room.AppDatabase/1.json
"INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'bcac519e74e751a75f3e6fa5d39ac5a3')"
]
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add a line at EOF.

Copy link
Author

@Sh-AhsanArif Sh-AhsanArif Feb 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Hi @omerhabib26.
Thank you for reviewing the PR. The Schema files are auto-generated by Room, so it's best not to edit them manually to ensure schema consistency and avoid auto migration issues. Let me know your thoughts on this!

app/schemas/org.openedx.app.room.AppDatabase/2.json
"INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'ed545aec6739ec7692c4bb72179331c4')"
]
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

same here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@omerhabib26 omerhabib26 omerhabib26 approved these changes

@PavloNetrebchuk PavloNetrebchuk PavloNetrebchuk approved these changes

@volodymyr-chekyrta volodymyr-chekyrta Awaiting requested review from volodymyr-chekyrta

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: In Eng Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Sh-AhsanArif @openedx-webhooks @e0d @PavloNetrebchuk @omerhabib26 @mphilbrick211