Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use the keyword field for tags in related query #3346

Merged
merged 1 commit into from
Nov 13, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Nov 13, 2023

Fixes

Follow up for #3307

Description

The related query uses the terms query to match the tags. It was, however, using a text field (tags.name) instead of a keyword field(tags.name.keyword), which is bad for performance1. This PR fixes it by adding the .keyword suffix to the query. The tests are updated accordingly.

Setting the priority to high because this needs to be deployed together with the other changes to the related query in #3307.

Testing Instructions

CI passing is a good indication that the change is correct because we have the tests for the related endpoint.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Footnotes

  1. Why you should avoid using text fields for term query

@obulat obulat requested a review from a team as a code owner November 13, 2023 08:05
@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 🧱 stack: api Related to the Django API 💻 aspect: code Concerns the software code in the repository labels Nov 13, 2023
@obulat obulat force-pushed the fix/use-keyword-for-tags-in-related branch from 42b46ae to 4eb516c Compare November 13, 2023 08:19
@obulat obulat requested a review from dhruvkb November 13, 2023 08:25
Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

LGTM!

@stacimc stacimc merged commit fcbc519 into main Nov 13, 2023
43 checks passed
@stacimc stacimc deleted the fix/use-keyword-for-tags-in-related branch November 13, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants