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

Reset the media store state if collection state changes #3979

Merged
merged 3 commits into from
Mar 30, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Mar 27, 2024

Fixes

Fixes #3976 by @zackkrida

Description

This PR adds clearMedia call to the search store's function setting the collection state. This makes the setCollectionState similar to setSearchStateFromUrl. To make sure that we don't clear media when non-collection state params change (for instance, if we add filters to the collection views, or if we add page parameter to the frontend URL to improve pagination), we first check if the collectionParams are different.

Testing Instructions

Go through the following steps and check that the linked issue is fixed (step 5):

  1. Run the app locally using just frontend/run dev
  2. Make sure the additional_search_views feature is enabled: http://localhost:8443/preferences
  3. Search "rabbit" from StockSnap only: http://localhost:8443/search/image?q=rabbit&source=stocksnap
  4. Click on a single result, then a tag
  5. Observe that the tag view is not filtered to only show StockSnap results. You can refresh and see the same results.

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 March 27, 2024 17:17
@obulat obulat requested review from zackkrida and dhruvkb March 27, 2024 17:17
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Mar 27, 2024
@openverse-bot openverse-bot added 🟧 priority: high Stalls work on the project or its dependents 🛠 goal: fix Bug fix 🕹 aspect: interface Concerns end-users' experience with the software labels Mar 27, 2024
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 don't love having to manage isCollectionStateSame as a custom approach to checking for deep equality of two objects, but I am not sure we have a simpler alternative at the moment and this appears to be working. LGTM! We should really move to using lodash or similar in the future IMO.

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.

I wanted to try and review this PR, but it doesn't have any testing instructions so I'm not sure how best to proceed 🙂 I do have one question.

Comment on lines 336 to 339
isCollectionStateSame(
collectionParams: CollectionParams,
mediaType: SupportedMediaType
) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there an easy way to test this new function?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed this function in favor of @wordpress/is-shallow-equal that we are already using in another component.

@obulat obulat force-pushed the fix/media-loading-for-collection branch from 8cb65e3 to 1a5de2c Compare March 29, 2024 18:12
@obulat
Copy link
Contributor Author

obulat commented Mar 29, 2024

I wanted to try and review this PR, but it doesn't have any testing instructions so I'm not sure how best to proceed 🙂 I do have one question.

Sorry, I updated the instructions :)

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.

Perfect, thanks for the testing instructions! Glad we can use an existing function here too 😄

@obulat obulat merged commit aa9ea4b into main Mar 30, 2024
41 checks passed
@obulat obulat deleted the fix/media-loading-for-collection branch March 30, 2024 04:02
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: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Staging: Provider filter is preserved on collection tag views
4 participants