Skip to content

fix: backport openedx-forum 0.4.1 to teak for thread sort bug#38709

Open
taimoor-ahmed-1 wants to merge 2 commits into
openedx:release/teakfrom
edly-io:backport/openedx-forum-0.4.1-teak
Open

fix: backport openedx-forum 0.4.1 to teak for thread sort bug#38709
taimoor-ahmed-1 wants to merge 2 commits into
openedx:release/teakfrom
edly-io:backport/openedx-forum-0.4.1-teak

Conversation

@taimoor-ahmed-1
Copy link
Copy Markdown
Contributor

Summary

Bumps the openedx-forum pin from 0.4.0 to 0.4.1 on release/teak to backport the fix for the discussion-forum "pinned"-NULL sort bug.

Why cap at 0.4.1?

A constraint openedx-forum<=0.4.1 is added to requirements/constraints.txt to keep the Teak line on the safe side of two breaking releases:

forum tag change safe for Teak?
0.4.1 The fix + adds optional Typesense search backend (off by default)
0.4.2 Drops Python 3.11 support ❌ (Teak supports 3.11)
0.4.3 Removes the MongoDB backend ❌ (Teak deployments may still use MongoDB)

The constraint should be dropped on master / post-Teak release lines.

Files changed

  • requirements/constraints.txt — adds the openedx-forum<=0.4.1 cap with an explanatory comment block.
  • requirements/edx/{base,development,testing,doc}.txt — bumps the pinned openedx-forum line from 0.4.0 → 0.4.1, and adds the new transitive typesense==2.0.0 dep that 0.4.1 pulls in.

If preferred, maintainers can re-run make upgrade-package package=openedx-forum to regenerate the compiled files canonically — the resulting diff should match this PR.

Test plan

  • Tutor Teak deployment running openedx-forum==0.4.1 no longer shows old threads at the top of "recent first" sort.
  • Forum migration 0005_alter_commentthread_pinned applies cleanly and pinned column has no NULL rows after manage.py lms migrate.
  • CI passes — make upgrade-package package=openedx-forum produces no further changes.

🤖 Generated with Claude Code

Bumps the `openedx-forum` pin from 0.4.0 to 0.4.1 on `release/teak`
to pull in the fix for the "pinned"-NULL sort bug
(openedx/forum#270, commit 78b36e4) where discussion threads were
not ordering correctly when users selected "recent first" — old
threads with NULL `pinned` values floated above newer threads.

Reported in:
https://discuss.openedx.org/t/discuss-forum-messages-order-not-organized-as-expected-in-teak/18665

Caps openedx-forum at <=0.4.1 in constraints.txt to avoid:
  * 0.4.2 — drops Python 3.11 support (Teak still supports 3.11)
  * 0.4.3 — removes the MongoDB backend (Teak deployments may rely on it)

The 0.4.0 -> 0.4.1 delta also adds the optional Typesense search
backend (additive, off by default), pulling in `typesense==2.0.0`
as a new transitive dependency. That pin is added to the compiled
requirements files. The constraint should be removed on master /
post-Teak release lines.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @taimoor-ahmed-1!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

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-forum 0.4.1 adds the (off-by-default) Typesense search backend,
which transitively requires `typesense`. typesense>=2.0.0 requires
httpx>=0.28.1, but pact-python==2.0.1 — a transitive test dependency
already pinned on release/teak — requires httpx==0.23.3. That is an
unresolvable pip conflict and causes CI's "Compile requirements" step
to fail with ResolutionImpossible.

typesense==1.3.0 only requires `requests`+`typing-extensions` (both
already present on teak) and is sufficient since the Typesense backend
is off by default on Teak; the active search backends are Meilisearch
and Elasticsearch which do not depend on the typesense client.

Adds `typesense<2.0.0` to requirements/constraints.txt with an
explanatory comment and regenerates the compiled requirements files
via `pip-compile --upgrade-package openedx-forum`.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Jun 4, 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: Waiting on Author

Development

Successfully merging this pull request may close these issues.

3 participants