[DEPR]: Commerce Coordinator functionality in edx-platform

[bmtcril]

Proposal Date

2024-08-06

Target Ticket Acceptance Date

2024-08-20

Earliest Open edX Named Release Without This Functionality

Sumac - 2024-10

Rationale

When originally developed at 2U the Commerce Coordinator was intended to be released as an extension to edx-platform to ease the transition away from the ecommerce project and create pluggable, flexible integrations paths for commerce systems into the platform.

Progress was made toward a path where CC had some integration points in edx-platform, however the current state is that it will remain a 2U tool and won't be adopted into Open edX. As such we would like to remove the explicit CC integration points in favor of making it a plugin that uses standard extension points like hooks and filters.

Ideally this is a first step toward removing the commerce djangoapp, which has been marked in the code for deprecation for about 5 years now.

Removal

This DEPR is for edx-platform removal. There may be CC related code in other systems that are being deprecated separately such as ecommerce.

• The should_redirect_to_commerce_coordinator… Waffle flags
• References to Commerce Coordinator in lms/djangoapps/commerce/utils.py (and their tests)
• CC related settings in the edx-platform settings files

Replacement

Where needed, new hooks and filters will be added to things like unenrollment to allow any plugin to access those events and take action.

Deprecation

No response

Migration

No response

Additional Info

No response

Task List

• The should_redirect_to_commerce_coordinator… Waffle flags
• References to Commerce Coordinator in lms/djangoapps/commerce/utils.py (and their tests)
• CC related settings in the edx-platform settings files

[aht007]

Hi again @bmtcril,
So as per the original ask of this ticket we have removed all of the explicit integration points of commerce-coordinator from edx-platform. Code removal was done in pull-35527. We have already added extension points to commerce app in these PRs: PR1, PR2 so anyone who wants to extend the commerce functionality can do so without explicitly adding code into edx-platform codebase. I know that commerce app is itself slated for deprecation down the line but do you want to us announce the code removal and addition of extension points to the broader openedX community somewhere else apart from this issue?

[bmtcril]

I think that if you link to this ticket from the Sumac dev / operator release notes with a quick summary of the work that was done and a note that the edx-platform commerce app is still slated for deprecation that should be enough. Thanks for getting this work over the line!

[robrap]

@bmtcril @grmartin: Can you confirm if Draft is an accurate state for this ticket? If you think it is past draft, the ticket would need a DEPR coordinator assigned to help update the ticket.

In all cases, It would be great to clarify what is complete vs what work remains. Thank you.

[bmtcril]

I'd created this ticket to hand off to Glenn, but he's since been offboarded. It wasn't really a full community DEPR since only 2U was able to use commerce-coordinator and 2U handled the deprecation as mentioned above. Based on my review I believe this is done and it's removal was announced in the Sumac release notes. So I'm going to move this to "done" and close it out.

[robrap]

Thanks @bmtcril.
FYI: @dianakhuang, in case there are any other steps required.