Skip to content

fix: report thread endorsement in list responses on the MySQL backend - #291

Open
rabeeh-ta wants to merge 1 commit into
openedx:masterfrom
rabeeh-ta:fix/endorsed-flag-mysql-thread-list
Open

fix: report thread endorsement in list responses on the MySQL backend#291
rabeeh-ta wants to merge 1 commit into
openedx:masterfrom
rabeeh-ta:fix/endorsed-flag-mysql-thread-list

Conversation

@rabeeh-ta

Copy link
Copy Markdown

On the MySQL backend, a question with an endorsed answer shows no answered indicator anywhere a thread list is rendered. Opening the post shows it correctly. The two disagree because the two code paths compute the flag differently.

  1. MySQLBackend.get_endorsed() returns a dict keyed by strings: {str(thread_id): True for ...}.
  2. MySQLBackend.threads_presentor() reads it back with an integer: threads_endorsed.get(thread.pk, False). thread.pk is Django's implicit auto id, so the lookup never matches and every thread in a list response is presented as endorsed: False.
  3. The two adjacent lookups in the same loop already convert (read_states.get(str(thread.pk), ...) and threads_flagged.get(str(thread.pk), 0)); only the endorsement one does not.
  4. Fetching a single thread is unaffected: to_dict() emits no endorsed key, so ThreadSerializer.get_endorsed() computes it fresh from obj["_id"], which is already a string, and returns the right answer. That is why the flag appears once a post is opened.

The MongoDB backend is not affected: its threads_presentor() uses one string thread_key throughout.

Downstream, has_endorsed in the edx-platform thread serializer is source="endorsed", and frontend-app-discussions renders its answered indicator on hasEndorsed && type === 'question'. So every MySQL-backend site loses that indicator in the posts list.

The line is unchanged since the first release and is present in v0.4.7. There was no test covering has_endorsed in a list response, which is why it went unnoticed; this adds one that fails before the fix and passes after, mirroring the existing test_computes_endorsed_correctly for the single-thread path.

Manual testing instructions:

  1. On a MySQL-backend course, create a question post and post a response to it.
  2. Mark the response as the answer.
  3. Reload the discussions posts list without opening the post. Before this change the post shows no answered indicator; after it, it does.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 10, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @rabeeh-ta!

This repository is currently maintained by @openedx/wg-maintainers-forums.

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
🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

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

@rabeeh-ta

Copy link
Copy Markdown
Author

@openedx-webhooks, I have signed the CLA.

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: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants