Skip to content

Commit

Permalink
fix: Drop support for retiring E-Commerce Service accounts
Browse files Browse the repository at this point in the history
This never worked, and can't ever work, due to limitations in the
E-Commerce service itself.

Thus, rather than rely on whether ECOMMERCE_HOST is defined to decide
whether the retirement pipeline for that service should be enabled,
always disable it.

Also, update the README explaining that this plugin can't be used to
retire E-Commerce accounts.

Fixes #36.
  • Loading branch information
fghaas committed Jun 27, 2024
1 parent bb17c84 commit 6e15384
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## Unreleased

* [Bug fix] Drop support for retiring users in the [Open edX E-Commerce Service](https://github.com/openedx/ecommerce).
Per the discussion in [Issue #36](https://github.com/hastexo/tutor-contrib-retirement/issues/36), account retirement for the E-Commerce Service "will never" work and "has never" worked, thus this is not a breaking change.

## Version 3.3.0 (2024-04-05)

* [Enhancement] Support Python 3.12.
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ appropriate one:
[which was introduced with that
 release](https://github.com/overhangio/tutor/blob/master/CHANGELOG.md#v1320-2022-04-24).


Limitations
------------

This plugin cannot be used for retiring accounts in the [Open edX E-Commerce Service](https://github.com/openedx/ecommerce).
See [Issue #36](https://github.com/hastexo/tutor-contrib-retirement/issues/36) in this repository for a related discussion of missing functionality in E-Commerce account retirement.


Installation
------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,11 @@ client_secret: {{ RETIREMENT_EDX_OAUTH2_CLIENT_SECRET }}

base_urls:
lms: {{ "https" if ENABLE_HTTPS else "http" }}://{{ LMS_HOST }}
{% if ECOMMERCE_HOST is defined %}ecommerce: {{ "https" if ENABLE_HTTPS else "http" }}://{{ ECOMMERCE_HOST }}{% endif %}
{% if DISCOVERY_HOST is defined %}discovery: {{ "https" if ENABLE_HTTPS else "http" }}://{{ DISCOVERY_HOST }}{% endif %}
{% if NOTES_HOST is defined %}notes: {{ "https" if ENABLE_HTTPS else "http" }}://{{ NOTES_HOST }}{% endif %}

retirement_pipeline:
{% if FORUM_VERSION is defined %}- [ 'RETIRING_FORUMS', 'FORUMS_COMPLETE', 'LMS', 'retirement_retire_forum' ]{% endif %}
{% if ECOMMERCE_HOST is defined %}- [ 'RETIRING_ECOMMERCE', 'ECOMMERCE_COMPLETE', 'ECOMMERCE', 'retire_learner' ]{% endif %}
{% if DISCOVERY_HOST is defined %}- [ 'RETIRING_DISCOVERY', 'DISCOVERY_COMPLETE', 'DISCOVERY', 'replace_usernames' ]{% endif %}
{% if NOTES_HOST is defined %}- [ 'RETIRING_NOTES', 'NOTES_COMPLETE', 'LMS', 'retirement_retire_notes' ]{% endif %}
- [ 'RETIRING_EMAIL_LISTS', 'EMAIL_LISTS_COMPLETE', 'LMS', 'retirement_retire_mailings' ]
Expand Down

0 comments on commit 6e15384

Please sign in to comment.