Skip to content

feat: add AccountActivationEmailComposed and AccountActivationCompleted filters - #382

Draft
marlonkeating wants to merge 1 commit into
openedx:mainfrom
marlonkeating:mkeating/ENT-11816
Draft

feat: add AccountActivationEmailComposed and AccountActivationCompleted filters#382
marlonkeating wants to merge 1 commit into
openedx:mainfrom
marlonkeating:mkeating/ENT-11816

Conversation

@marlonkeating

Copy link
Copy Markdown
Contributor

ENT-11816

This pull request introduces two new public filters for account activation events and updates the package version to 3.9.0. It also includes comprehensive tests for the new filters and documents the changes in the changelog.

New Account Activation Filters:

  • Added AccountActivationEmailComposed filter to allow modification of the activation email context before it is sent. (openedx_filters/learning/filters.py, openedx_filters/learning/tests/test_filters.py) [1] [2] [3]
  • Added AccountActivationCompleted filter to allow modification of the redirect URL after account activation. (openedx_filters/learning/filters.py, openedx_filters/learning/tests/test_filters.py) [1] [2] [3]

Testing:

  • Added unit tests for both new filters to verify their filter types and default behavior when no pipeline steps are configured. (openedx_filters/learning/tests/test_filters.py)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Adds two new public filters in the learning subdomain to support account activation customization, alongside a version bump and changelog entry.

Changes:

  • Introduces AccountActivationEmailComposed and AccountActivationCompleted public filters for activation email context and post-activation redirect customization.
  • Adds unit tests validating filter_type values and default “no pipeline configured” behavior.
  • Bumps package version to 3.9.0 and documents the release in CHANGELOG.rst.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
openedx_filters/learning/filters.py Adds the two new account activation filters and their run_filter implementations.
openedx_filters/learning/tests/test_filters.py Adds test coverage for the new filters’ type identifiers and default behavior.
openedx_filters/init.py Updates the package __version__ to 3.9.0.
CHANGELOG.rst Adds a 3.9.0 changelog entry documenting the new filters.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

filter_type = "org.openedx.learning.account.activation.email.compose.v1"

@classmethod
def run_filter(cls, user: Any, message_context: dict) -> tuple[Any, dict | None]:
Comment thread CHANGELOG.rst
@@ -35,6 +35,14 @@ Unreleased

.. _changelog-3.7.0:
Comment on lines +1692 to +1695
tuple[User, str]:
- User: Django User object.
- str: URL to redirect to, possibly modified. Falsy values fall back to the
dashboard.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants