Skip to content

fix: parse sourcelib with packaging Version.release in openedx-events - #606

Open
luisfelipec95 wants to merge 1 commit into
openedx:mainfrom
Pearson-Advance:lfc/sourcelib-pep440-release-parsing
Open

luisfelipec95 wants to merge 1 commit into
openedx:mainfrom
Pearson-Advance:lfc/sourcelib-pep440-release-parsing

Conversation

@luisfelipec95

Copy link
Copy Markdown

Summary

This PR standardizes sourcelib parsing in openedx-events to keep metadata backward-compatible and consistent across event bus implementations.

What changed

  • Added and used shared helper:
    from openedx_events.utils import parse_sourcelib_release
  • Updated EventsMetadata sourcelib parsing to use packaging.version.Version(...).release.
  • Ensured sourcelib remains a tuple of integers (release segment only).
  • Added/updated tests to cover PEP 440 inputs (including post/dev/rc variants).

Behavior

  • "11.2.0" → (11, 2, 0)
  • "9.10.post1" → (9, 10)
  • "1.2.3rc1" → (1, 2, 3)

Why

A recent Redis event bus change exposed inconsistencies around PEP 440 handling.
Keeping this logic in openedx-events avoids divergence across implementations and prevents breaking downstream consumers that expect sourcelib as tuple[int, ...].

@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @luisfelipec95!

This repository is currently maintained by @openedx/committers-openedx-events.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are 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.

Details
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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 5, 2026
@luisfelipec95
luisfelipec95 force-pushed the lfc/sourcelib-pep440-release-parsing branch from 4919fe0 to 8875ef3 Compare October 5, 2026 21:10

@bmtcril bmtcril left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Just a couple of little things, otherwise it looks good to me. Will you also be doing the follow-on PRs for the event bus repos?

Comment thread openedx_events/data.py
- sourcehost (str): physical source of the event.
- time (datetime): (optional) timestamp when the event was sent with UTC timezone.
Defaults to current time in UTC. See OEP-41 fordetails.
- sourcelib (tuple of ints): Open edX Events library version. A tuple was

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you add a note here that only the release segment is kept and that additional information (pre/post/dev etc) is dropped?

Comment thread openedx_events/utils.py
import traceback
from pprint import PrettyPrinter

from packaging.version import Version

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should add packaging as a direct dependency in requirements/base.in . It works right now, but only because it's being indirectly installed via celery / kombu.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Oct 22, 2026
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

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

3 participants