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

Replace "Over..." language with more precise "Top..." #4509

Merged
merged 1 commit into from
Jun 25, 2024

Conversation

sarayourfriend
Copy link
Collaborator

Fixes

Follow up to #4476 by @obulat

Description

The API no longer returns an abstract, unreachable limit of 10k results. With this comment, we will show a precise number of actually reachable results, while still clarifying that these (may) be only the top results for that query (and not all results for that query).

This is one option for resolving this, as described in the linked discussion.

Testing Instructions

Checkout the branch and run ./ov just p frontend dev and visit http://localhost:8443. Search for something that will return heaps of results, like "birds". Now try something more niche like "big green bird" (which mostly just reduces audio results). Notice for each of these the text in the search bar and in the media type buttons says "Top results/".

Do this for each of the three types of searches (all media, image, audio), and confirm you get the same "Top " text when the results are at the "max" value for any of the individual media types (240).

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 (just catalog/generate-docs for catalog
    PRs) or the media properties generator (just catalog/generate-docs media-props
    for the catalog or just api/generate-docs for the API) where 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.

@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 🕹 aspect: interface Concerns end-users' experience with the software 🧱 stack: frontend Related to the Nuxt frontend labels Jun 18, 2024
@sarayourfriend sarayourfriend requested a review from a team as a code owner June 18, 2024 06:00
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

I like this approach; LGTM.

The API no longer returns an abstract, unreachable limit of 10k results. With this comment, we will show a precise number of actually reachable results, while still clarifying that these (may) be only the _top_ <x> results for that query (and not _all_ <x> results for that query).
@sarayourfriend sarayourfriend force-pushed the fix/frontend-results-count branch from 3053277 to bd04171 Compare June 19, 2024 03:22
@sarayourfriend
Copy link
Collaborator Author

That storybook visual regression test might be flaky. Re-running it to confirm. The visual diff shows that the test failed due to the icon never loading.

Here's the failed run for the record: https://github.com/WordPress/openverse/actions/runs/9575642719/job/26400882637?pr=4509

And the test results zip

storybook_test_results.zip

@openverse-bot
Copy link
Collaborator

Based on the medium urgency of this PR, the following reviewers are being gently reminded to review this PR:

@obulat
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 4 day(s) ago. PRs labelled with medium urgency are expected to be reviewed within 4 weekday(s)2.

@sarayourfriend, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Everything works great, thank you for updating this so fast!

@sarayourfriend sarayourfriend merged commit f7491a2 into main Jun 25, 2024
45 checks passed
@sarayourfriend sarayourfriend deleted the fix/frontend-results-count branch June 25, 2024 22:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants