Skip to content

fix: specify Studio Meilisearch document primary key - #39200

Open
Rudra-G-23 wants to merge 2 commits into
openedx:masterfrom
Rudra-G-23:fix/39171-meilisearch-missing-index
Open

Rudra-G-23 wants to merge 2 commits into
openedx:masterfrom
Rudra-G-23:fix/39171-meilisearch-missing-index

Conversation

@Rudra-G-23

Copy link
Copy Markdown

Fixes #39171.

Studio content-search document writes now explicitly send the established `id` primary key to Meilisearch. This prevents ambiguous primary-key inference when a missing index is auto-created by the first incremental or rebuild write. Existing configured indexes retain their current primary key.

Affected role: Course Author and Operator.

Testing instructions

  1. Start Studio with Meilisearch enabled and the Studio content index absent.
  2. Trigger an incremental content-index write or `reindex_studio`.
  3. Confirm the first document write succeeds and the index primary key is `id`.

Automated checks run:

  • uvx ruff check openedx/core/djangoapps/content/search/api.py openedx/core/djangoapps/content/search/tests/test_api.py
  • Python syntax compilation
  • git diff --check

Other information

  • No migration or configuration change is required.
  • AI disclosure: OpenAI Codex assisted with investigation, implementation, and test drafting. The resulting diff, Meilisearch client API behavior, and checks were reviewed before submission.

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

Copy link
Copy Markdown

Thanks for the pull request, @Rudra-G-23!

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

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.

@Rudra-G-23

Rudra-G-23 commented Oct 9, 2026 •

Copy link
Copy Markdown
Author

@openedx/wg-maintenance-openedx-platform-oncall
I have signed the Individual Contributor Agreement. Could you please re-run the CLA check? Thanks!

@mphilbrick211

Copy link
Copy Markdown

@openedx/wg-maintenance-openedx-platform-oncall I have signed the Individual Contributor Agreement. Could you please re-run the CLA check? Thanks!

Hi @Rudra-G-23! Apologies, but I'm not seeing your CLA form. Would you mind re-submitting?

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Oct 22, 2026
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Oct 22, 2026
@e0d

e0d commented Oct 23, 2026

Copy link
Copy Markdown
Member

@Rudra-G-23 I've run the tests, but it looks like there are conflicts that need to be resolved. Can you have a look?

@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Oct 27, 2026
…arch-missing-index

# Conflicts:
#	openedx/core/djangoapps/content/search/api.py
@Rudra-G-23

Copy link
Copy Markdown
Author

Hi @e0d and @mphilbrick211,

I've updated my PR branch against the latest master and resolved the merge conflicts. I've also addressed the relevant test failures and re-submitted my Individual Contributor Agreement.

Could you please re-run the CLA check and review the updated PR when possible?

Thanks!

This branch has not been deployed

No deployments
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 Tests Run or CLA Signed

Development

Successfully merging this pull request may close these issues.

Studio content-search first writes omit the primary key when the Meilisearch index is missing

4 participants