Skip to content

Conversation

@PavloNetrebchuk
Copy link
Contributor

@PavloNetrebchuk PavloNetrebchuk commented Nov 1, 2024

Plugin System Integration for Open edX Mobile Application

This PR introduces a plugin architecture to the Open edX mobile app for Android platforms. By moving functionalities such as analytics, push notifications, and eCommerce to a modularized plugin system, this enhancement aims to increase the app’s extendability and scalability, while supporting company-specific customizations without altering the core code.

Key Changes:

  • Plugin Interface: Defines standard methods and properties for all plugins.
  • Plugin Manager: Manages loading, initialization, and handling of plugins within the application.
  • Core Application Update: Restructured to focus on essential functions, delegating extended features to plugins.

Additional Changes in Libraries and Dependencies:

  • OEXFoundation Library: Migrated core dependencies and extensions, including ViewPager2, Retrofit, LoggingInterceptor, Koin, Coil, Room, WebKit, WorkRuntime, androidxWindow, and essential extensions to the new openedx-app-foundation-android library.
  • Firebase Analytics: Moved to a dedicated library, openedx-app-firebase-analytics-android, to better modularize analytics functionality.
  • Analytics Removal: Removed Segment and FullStory analytics from the project.

Objectives:

  • Extendability: Enables adding new features without modifying core code.
  • Customization: Allows companies to build and configure their own plugins.
  • Separation of Concerns: Simplifies maintenance by isolating features.
  • Scalability: Supports easy integration of new plugins over time.

This update will make the mobile app more adaptable to various business needs, fostering a sustainable and flexible framework for ongoing development.

# Conflicts:
#	app/build.gradle
#	app/src/main/java/org/openedx/app/analytics/FullstoryAnalytics.kt
#	core/build.gradle
#	core/src/main/java/org/openedx/core/extension/StringExt.kt
#	core/src/main/java/org/openedx/core/extension/ViewExt.kt
#	core/src/main/java/org/openedx/core/ui/ComposeCommon.kt
#	course/src/main/java/org/openedx/course/presentation/dates/CourseDatesScreen.kt
#	course/src/main/java/org/openedx/course/presentation/handouts/HandoutsWebViewFragment.kt
#	course/src/main/java/org/openedx/course/presentation/outline/CourseOutlineScreen.kt
#	course/src/main/java/org/openedx/course/presentation/ui/CourseVideosUI.kt
#	course/src/main/java/org/openedx/course/presentation/unit/html/HtmlUnitFragment.kt
#	course/src/main/java/org/openedx/course/presentation/unit/html/HtmlUnitViewModel.kt
#	discovery/src/main/java/org/openedx/discovery/presentation/WebViewDiscoveryViewModel.kt
#	discovery/src/main/java/org/openedx/discovery/presentation/catalog/CatalogWebView.kt
#	discovery/src/main/java/org/openedx/discovery/presentation/info/CourseInfoViewModel.kt
#	discovery/src/main/java/org/openedx/discovery/presentation/program/ProgramUIState.kt
#	discovery/src/main/java/org/openedx/discovery/presentation/program/ProgramViewModel.kt
#	discussion/src/main/java/org/openedx/discussion/presentation/topics/DiscussionTopicsScreen.kt
#	discussion/src/test/java/org/openedx/discussion/presentation/topics/DiscussionTopicsViewModelTest.kt
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 1, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @PavloNetrebchuk!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/openedx-mobile-maintainers. Tag them in a comment and let them know that your changes are ready for review.

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 changed the title Feat: Mobile Plugin Architecture feat: [FC-0072] Mobile Plugin Architecture Nov 1, 2024
Copy link
Contributor

@volodymyr-chekyrta volodymyr-chekyrta left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@volodymyr-chekyrta volodymyr-chekyrta changed the title feat: [FC-0072] Mobile Plugin Architecture [FC-0072] Mobile Plugin Architecture Nov 1, 2024
Copy link
Contributor

@k1rill k1rill left a comment

Choose a reason for hiding this comment

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

LGTM

@volodymyr-chekyrta volodymyr-chekyrta merged commit e61523e into openedx:develop Nov 4, 2024
@PavloNetrebchuk PavloNetrebchuk deleted the feat/imp_foundation_lib branch November 4, 2024 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants