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

Fix the "search query" in the time took logs #3313

Merged
merged 2 commits into from
Nov 7, 2023
Merged

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Nov 3, 2023

Fixes

Follow up on #3300

Description

#3300 added logging of the time it takes for the ES requests, but the search_query parameter is always logged as None because the parameter was passed as a non-keyword arg. This PR fixes that and renames the param to es_query.

Testing Instructions

Run the app and perform several search requests (including search, related, stats). You should see the correct value for es_query in the logs.

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.

@obulat obulat requested a review from a team as a code owner November 3, 2023 04:32
@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API labels Nov 3, 2023
Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM, but I think I would recommend a different approach to ensuring that the kwarg is passed: set it as a keyword only argument with no default:

def wrapper(*args, es_query, **kwargs):
    # ...

Then get_es_response and get_raw_es_response don't need to define arguments only relevant to the decorator they happen to have, or define defaults, or unused *args, **kwargs. To me, it's a bit more ergonomic and we get the automatically helpful error if es_query isn't passed to the decorated function.

In any case, this approach also works, just leaves it easy to accidentally misuse the two get* functions.

@obulat obulat force-pushed the fix/timing-of-es-queries branch from 2b930c7 to 21d8a05 Compare November 4, 2023 03:48
@obulat obulat requested review from dhruvkb and removed request for stacimc November 6, 2023 10:03
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.

Local testing confirmed that the right es_query values were showing up!

@obulat obulat merged commit 3e4a871 into main Nov 7, 2023
44 checks passed
@obulat obulat deleted the fix/timing-of-es-queries branch November 7, 2023 15:21
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.

3 participants