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

Add a warning when source query parameter contains invalid values #3949

Merged
merged 2 commits into from
Apr 2, 2024

Conversation

manojks1999
Copy link
Contributor

@manojks1999 manojks1999 commented Mar 21, 2024

Fixes

Fixes #3945 by @obulat

Description

Added warning for invalid sources from input.

Testing instructions

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.
  • [N/A] 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.

@manojks1999 manojks1999 requested a review from a team as a code owner March 21, 2024 02:12
@openverse-bot openverse-bot added 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🏷 status: label work required Needs proper labelling before it can be worked on labels Mar 21, 2024
@manojks1999 manojks1999 changed the title Fixes for source query parameter contains invalid values [Added Warning] Fix: For source query parameter contains invalid values [Added Warning] Mar 21, 2024
@openverse-bot openverse-bot added 🟩 priority: low Low priority and doesn't need to be rushed ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Mar 21, 2024
@obulat obulat added 🧱 stack: api Related to the Django API and removed 🏷 status: label work required Needs proper labelling before it can be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Mar 21, 2024
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.

The code as is will not work.

Can you add testing instructions to the PR description, @manojks1999? A small unit test could also help verify that the code works as intended, and would have caught the existing bug.

sources = [source for source in sources if source in allowed_sources]
original_len = len(sources)
valid_sources = [source for source in sources if source in allowed_sources]
if original_len > len(sources):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
if original_len > len(sources):
if original_len > len(valid_sources):

api/api/serializers/media_serializers.py Outdated Show resolved Hide resolved
@zackkrida zackkrida marked this pull request as draft March 25, 2024 15:10
@zackkrida
Copy link
Member

Hi @manojks1999 I will draft this PR for you until you've had a chance to address feedback from reviewers. Thank you for the PR!

@obulat obulat force-pushed the fix_query_params_invalid_val branch 2 times, most recently from 6e8a96a to a9660fe Compare April 1, 2024 13:49
obulat added 2 commits April 1, 2024 16:54
Signed-off-by: Olga Bulat <[email protected]>
@obulat obulat force-pushed the fix_query_params_invalid_val branch from a9660fe to 718e75d Compare April 1, 2024 13:54
@obulat
Copy link
Contributor

obulat commented Apr 1, 2024

@manojks1999, thank you for your work on this PR!
I updated the PR to add the required changes and added a test. It's ready for re-review, @sarayourfriend .

@obulat obulat marked this pull request as ready for review April 1, 2024 13:57
@obulat obulat requested a review from sarayourfriend April 1, 2024 13:57
@obulat obulat changed the title Fix: For source query parameter contains invalid values [Added Warning] Add a warning when source query parameter contains invalid values Apr 1, 2024
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, thanks for updating the PR, Olga, and thanks for starting it, @manojks1999.

@obulat obulat merged commit 12d7162 into WordPress:main Apr 2, 2024
48 checks passed
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: improvement Improvement to an existing user-facing feature 🟩 priority: low Low priority and doesn't need to be rushed 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Log when source query parameter contains invalid values
5 participants