Skip to content

feat: scope CoreData records and downloads storage by instance - #679

Merged
RawanMatar89 merged 2 commits into
openedx:developfrom
zeit-labs:infra/07-coredata-downloads-scoping
Sep 21, 2026
Merged

RawanMatar89 merged 2 commits into
openedx:developfrom
zeit-labs:infra/07-coredata-downloads-scoping

Conversation

@RawanMatar89

Copy link
Copy Markdown
Contributor

Summary

Extends instance isolation to CoreData records and on-disk downloads, so cached course
data, offline progress, and downloaded files no longer bleed between instances.

Stacked PR — Please review/merge in
order starting from PR-1 (infra/01-tenant-model); this branch builds on PR-6
(infra/06-namespaced-local-storage).

Changes

  • CoreData models: add optional instanceKey to CDDownloadData, CDOfflineProgress
    (Core), CDCourseItem (Course), and CDDownloadCoursePreview (Downloads), widening each
    entity's uniqueness constraint to include it.
  • CorePersistence / CoursePersistence / DownloadsPersistence: every fetch now
    filters by the current instance's key (via NSCompoundPredicate alongside any
    caller-supplied predicate), every save stamps it.
  • Bug fix while porting: the reference implementation's
    DownloadsPersistence.saveDownloadCourses never stamped the key on save even though reads
    filtered by it — every load would have silently returned NoCachedDataError once fetches
    became instance-scoped. Fixed to stamp on save, consistent with the other two persistence
    classes.
  • Add InstanceFilePathProvider (Core/Network) — nests downloads under
    Documents/{instanceKey}/{userId}_Files/, replacing DownloadManager's old un-scoped
    {userId}_Files path.
  • Wire instanceStore / filePathProvider through AppAssembly, NetworkAssembly, and
    ScreenAssembly.
  • Update DownloadManagerTests for the new filePathProvider initializer parameter.

Out of scope

  • Session/auth lifecycle on instance switch (next PR).

Core/Course/Downloads CoreData models: add optional instanceKey to
CDDownloadData, CDOfflineProgress, CDCourseItem, and
CDDownloadCoursePreview, widening their uniqueness constraints so two
instances can't collide on the same id.

CorePersistence/CoursePersistence/DownloadsPersistence: filter every
fetch by the current instance's key and stamp it on every save. Also
fixes DownloadsPersistence.saveDownloadCourses never stamping the key,
which would have made every load return NoCachedDataError once reads
became instance-scoped.

Add InstanceFilePathProvider (Core/Network): nests downloads under
Documents/{instanceKey}/{userId}_Files/, replacing DownloadManager's
old un-scoped {userId}_Files path.

Wire instanceStore/filePathProvider through AppAssembly,
NetworkAssembly, and ScreenAssembly.
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Sep 20, 2026
@openedx-webhooks

openedx-webhooks commented Sep 20, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @RawanMatar89!

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
🔘 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.

Details
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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Sep 20, 2026
@RawanMatar89
RawanMatar89 marked this pull request as ready for review September 20, 2026 13:54
@codecov

codecov Bot commented Sep 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (0c72bd4) to head (603716a).

Additional details and impacted files
@@      Coverage Diff       @@
##   develop   #679   +/-   ##
==============================
==============================

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

IvanStepanok
IvanStepanok previously approved these changes Sep 20, 2026
@RawanMatar89
RawanMatar89 dismissed IvanStepanok’s stale review September 20, 2026 14:34

The merge-base changed after approval.

IvanStepanok
IvanStepanok previously approved these changes Sep 21, 2026
@RawanMatar89
RawanMatar89 dismissed IvanStepanok’s stale review September 21, 2026 12:58

The merge-base changed after approval.

IvanStepanok
IvanStepanok previously approved these changes Sep 21, 2026
@RawanMatar89
RawanMatar89 dismissed IvanStepanok’s stale review September 21, 2026 13:30

The merge-base changed after approval.

@IvanStepanok
IvanStepanok self-requested a review September 21, 2026 13:53
IvanStepanok
IvanStepanok previously approved these changes Sep 21, 2026
@RawanMatar89
RawanMatar89 dismissed IvanStepanok’s stale review September 21, 2026 13:53

The merge-base changed after approval.

@IvanStepanok
IvanStepanok self-requested a review September 21, 2026 13:54
@IvanStepanok
IvanStepanok self-requested a review September 21, 2026 13:55
IvanStepanok
IvanStepanok previously approved these changes Sep 21, 2026
@RawanMatar89
RawanMatar89 dismissed IvanStepanok’s stale review September 21, 2026 14:07

The merge-base changed after approval.

@RawanMatar89
RawanMatar89 merged commit aad36bf into openedx:develop Sep 21, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants