inventhouse
commented
2 years ago [2023 UPDATE: This project described here has been cancelled. See @MaferMazu 's comment below for the work we are doing instead -Kyle]
Ecommerce Service Deprecation and Replacement
INTRO
edX's monolithic Ecommerce Service was meant to be a full-featured product catalog, discounting, and order management service and has grown in complexity for many years until it has become very hard to maintain, let alone evolve. In that time, more and better hosted services have become available for solving many of these problems, and complex use cases have evolved that make flexibility vital for Open edX operators, including edx.org.
We are building a new system that should be flexible and adaptable enough to support any ecommerce product of choice. By uncoupling openedx from a specific ecommerce product, we will enable more contributors and deployments, and remove edX as a blocker for others’ ecommerce.
COMMERCE COORDINATOR
At the center of the new system is the Commerce Coordinator, a highly modular Django web service written in Python. Coordinator will provide a framework for configuring ecommerce capabilities. Individual Django apps will act as plugins to implement specific functionality, for example a webhook for a payment service provider to call when a purchase is successful, that plugin can then signal one that performs the fulfillment in the LMS. The core of the Coordinator will allow commerce workflows to be tailored by combining plugins and routing signals, and will eventually include tools for validating configurations and tracing signal flows.
ROADMAP
We have completed some upfront design and proof-of-concept work and are now bringing it to the community for awareness, review, and support. The next steps will be to flesh out the Coordinator Core while we begin building decoupling Coordinator Plugins to bridge legacy ecommerce. During this process, edX will also begin building plugins to bridge our ecommerce vendor of choice.
We intend to officially deprecate legacy ecommerce by April 1st 2022. When the legacy ecommerce service has been fully decoupled from the platform, it will be removed from openedx or transferred to a new maintainer. Please comment on the deprecation ticket by April 30th 2022 if you would be interested in taking over maintenance.
COMMUNITY SUPPORT
The community can support this development effort in three main ways:
- Help with Core improvements, particularly signal validation and signal traceability
- Write Plugins to decouple legacy ecommerce
- Write “minimum viable” Plugins for development environment
Please reach out if you are interested in collaborating on any of these.
Coordinator will be rapidly evolving and may need some time to stabilize before being included in named releases. Once stabilized, the core should require relatively few changes, and anyone can write their own plugins to suit their needs and sideload them as desired.
COMMUNICATION
Tight and transparent communication with the community will be critical to success. To keep the community informed of our progress, edX will provide monthly updates to Discourse.
ADDITIONAL REFERENCES
Legacy Ecommerce Deprecation Announcement Legacy Ecommerce Deprecation Ticket Commerce Coordinator Repo Commerce Coordinator Architecture Decisions
dianakhuang
robrap
MaferMazu
kdmccormick
fghaas
Proposal Date
22 Feb 2022
Ticket Acceptance Date
TBD
Technology Removal Date
TBD
First Open edX Named Release Without This Functionality
TBD
Rationale
The ecommerce service is based on Django Oscar, which is dropping support for MySQL. On top of that, the ecommerce system is extremely costly to maintain.
Removal
The ecommerce application, repository, and configuration will be removed. Hooks and supporting code in other Open edX systems may be deprecated if they do not support a more general-purpose use case. More details will be included in the specific tasks of this epic.
Replacement
~A new system is in very early design that will serve as a platform for managing the shopping cart, payment, order history, and financial reporting flows. Where it makes sense some current Ecommerce functionality may be moved to other existing systems such as LMS or Discovery. High level architecture documents for the new system are expected to be available for review in October 2021.~
2023 UPDATE: Rather than rebuilding ecommerce as another bespoke Open-edX application, we propose instead that edx-platform provide APIs and extension points so that it can easily integrate with third-party commerce systems. See @MaferMazu 's WooCommerce comment for work that has been done already).
Target Dates
This is a large project with many moving pieces and impacts on several systems and processes. Current thinking is that replacement will take place in several phases and result in final deprecation of ecommerce in early to mid 2023. As scope and timing become more clear this ticket will be updated.
Additional Context
The current Django Oscar based Ecommerce application has long been a pain point in the Open edX ecosystem, causing issues with performance, compliance, and reporting. It is a large maintenance burden and very difficult to configure and administer. Our desire is to ~move to a much smaller pluggable framework that will offer~ transition towards APIs that support third-party solutions that will hopefully offer operators and developers more flexibility and ease deployment and maintenance burdens.
Deprecation
No response
Migration
No response
Additional Info
Original Jira Ticket: https://openedx.atlassian.net/browse/DEPR-169