Skip to content

feat: add instance selection store (InstanceStore) - #512

Merged
volodymyr-chekyrta merged 2 commits into
openedx:developfrom
raccoongang:infra/02-instance-store
Oct 21, 2026
Merged

volodymyr-chekyrta merged 2 commits into
openedx:developfrom
raccoongang:infra/02-instance-store

Conversation

@IvanStepanok

Copy link
Copy Markdown
Contributor

Summary

Adds InstanceStore: the single source of truth for the instance catalog and the selected instance. Port of openedx-app-ios#673. Still foundation: nothing in the app reads it yet.

Stacked PR: builds on #511. Please review and merge in order.

Included

  • InstanceProvider: read-only access to the selected instance, plus a StateFlow of it (the Android counterpart of iOS's .instanceDidChange notification).
  • InstanceStore: holds the catalog in effect and the selection, persisted by key in its own SharedPreferences file and written synchronously, so a switch right before a process kill isn't lost. A single-instance catalog selects its only instance automatically, including after a deselect. A saved key the catalog no longer contains resolves to nothing but stays saved, so the site is selected again if a later catalog brings it back.
  • Config.getInstancesConfig() exposes the bundled catalog; Koin registers InstanceStore and InstanceProvider.
  • InstanceStoreTest: 10 cases.

Not included

  • Any consumer (networking, storage, session lifecycle): later PRs.
  • Remote catalog fetch: next-but-one PR.

Testing

  • ./gradlew detektAll testProdDebugUnitTest :app:assembleProdDebug

Note

This is the 2nd pull request of the multi-instance stack.

Introduces Instance and InstancesConfig: what one Open edX platform is and how it is
parsed from the INSTANCES block of the bundled config. Nothing reads it yet.

Required fields are NAME, API_HOST_URL and OAUTH_CLIENT_ID; a malformed entry is dropped.
KEY falls back to a slug of NAME, INSTANCE_NAME is localized with an English fallback,
and PLATFORM_NAME defaults to the display name. The schema matches iOS (#672).
InstanceStore holds the instance catalog and the selected instance, persists the
selection by key and publishes it as a StateFlow. A single-instance catalog selects its
only instance automatically. Registered in Koin as InstanceStore and InstanceProvider;
nothing consumes it yet. Mirrors iOS #673.
@IvanStepanok IvanStepanok mentioned this pull request Oct 19, 2026
2 tasks done
@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 Oct 19, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @IvanStepanok!

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.

@volodymyr-chekyrta
volodymyr-chekyrta merged commit 5a6f586 into openedx:develop Oct 21, 2026
6 checks passed
@volodymyr-chekyrta
volodymyr-chekyrta deleted the infra/02-instance-store branch October 21, 2026 17:23
@github-project-automation github-project-automation Bot moved this from Needs Triage to Done in Contributions Oct 21, 2026
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.

4 participants