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.

Sign up for GitHub

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

Jump to bottom

Wrap the RecentSearches in ClientOnly #2188

Merged
merged 1 commit into from
May 25, 2023
Merged

Wrap the RecentSearches in ClientOnly #2188

merged 1 commit into from
May 25, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented May 25, 2023

Fixes

Fixes #473 by @obulat

Description

This PR fixes the client-server mismatch on the mobile.

When you open the server-rendered mobile search page (directly opening the address like localhost:8443/search/?q=cat, or refreshing the search page) instead of navigating to it from the homepage, the contents of the recent searches list from the server are different from the local list saved in the local storage. This causes a mismatch of the server-rendered layout and the client-rendered layout. Nuxt re-renders the layout completely instead of adding the event handlers to the server-rendered layout when "hydrating".

To prevent this, we use the ClientOnly wrapper component, which stops the Recent Searches from rendering on the server. Recent Searches on mobile will now only render on the client, after the server-rendered layout is ready. This will match the way it is done on desktop.

Testing Instructions

Open the app on a narrow screen with mobile layout. Execute a search to fill in the local storage with some "recent searches. Then, go to localhost:8443/search/?q=openverse directly. You should not see the "client-server mismatch" error messages in the browser console.

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 May 25, 2023 06:10
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label May 25, 2023
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository labels May 25, 2023
@github-actions
Copy link

Size Change: +28 B (0%)

Total Size: 850 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 129 kB +15 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 120 kB +13 B (0%)
ℹ️ View Unchanged
Filename Size
./frontend/.nuxt/dist/client/234.js 272 B
./frontend/.nuxt/dist/client/234.modern.js 277 B
./frontend/.nuxt/dist/client/235.js 1.85 kB
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB
./frontend/.nuxt/dist/client/commons/app.modern.js 78.6 kB
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.17 kB
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.61 kB
./frontend/.nuxt/dist/client/components/loading-icon.js 766 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 768 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.75 kB
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.62 kB
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 397 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.34 kB
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.27 kB
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.22 kB
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 637 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 641 B
./frontend/.nuxt/dist/client/components/v-bone.js 687 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 693 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.27 kB
./frontend/.nuxt/dist/client/components/v-content-link.js 1.05 kB
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 529 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 493 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 496 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.86 kB
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.69 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 913 B
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.15 kB
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.09 kB
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.06 kB
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 800 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.61 kB
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.57 kB
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 375 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.88 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.87 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.js 892 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 895 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.55 kB
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.55 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.92 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.9 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.77 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.74 kB
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.73 kB
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.68 kB
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.67 kB
./frontend/.nuxt/dist/client/components/v-image-details.js 1.96 kB
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB
./frontend/.nuxt/dist/client/components/v-image-grid.js 3.91 kB
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.79 kB
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 642 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 648 B
./frontend/.nuxt/dist/client/components/v-load-more.js 846 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 740 B
./frontend/.nuxt/dist/client/components/v-media-license.js 828 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 836 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.69 kB
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.65 kB
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 B
./frontend/.nuxt/dist/client/components/v-modal.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-modal.modern.js 995 B
./frontend/.nuxt/dist/client/components/v-no-results.js 816 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 818 B
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.29 kB
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.29 kB
./frontend/.nuxt/dist/client/components/v-related-images.js 1.1 kB
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.1 kB
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 981 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.68 kB
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 829 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.82 kB
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.17 kB
./frontend/.nuxt/dist/client/components/v-search-results-title.js 620 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 912 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.3 kB
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.3 kB
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B
./frontend/.nuxt/dist/client/pages/about.js 1.4 kB
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.52 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 5.89 kB
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.46 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.76 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.js 2.23 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 5.22 kB
./frontend/.nuxt/dist/client/pages/index.js 7.04 kB
./frontend/.nuxt/dist/client/pages/index.modern.js 6.96 kB
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB
./frontend/.nuxt/dist/client/pages/privacy.js 1.23 kB
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.24 kB
./frontend/.nuxt/dist/client/pages/search-help.js 1.59 kB
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB
./frontend/.nuxt/dist/client/pages/search.js 2.19 kB
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB
./frontend/.nuxt/dist/client/pages/search/audio.js 3.69 kB
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.58 kB
./frontend/.nuxt/dist/client/pages/search/image.js 545 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 548 B
./frontend/.nuxt/dist/client/pages/search/index.js 442 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B
./frontend/.nuxt/dist/client/pages/sources.js 1.51 kB
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.52 kB
./frontend/.nuxt/dist/client/runtime.js 2.71 kB
./frontend/.nuxt/dist/client/runtime.modern.js 2.72 kB
./frontend/.nuxt/dist/client/vendors/app.js 64.6 kB
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.9 kB

compressed-size-action

sarayourfriend
sarayourfriend approved these changes May 25, 2023
View reviewed changes
Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM! This fix makes sense, especially as the component is only ever shown as a result of user interaction and is based on local storage data 👍

@obulat obulat merged commit f0d0441 into main May 25, 2023
@obulat obulat deleted the add/clientonly_to_recent_searches branch May 25, 2023 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dhruvkb dhruvkb dhruvkb approved these changes

@sarayourfriend sarayourfriend sarayourfriend approved these changes

@AetherUnbound AetherUnbound Awaiting requested review from AetherUnbound AetherUnbound is a code owner automatically assigned from WordPress/openverse-frontend

Assignees
No one assigned
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Openverse PRs
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Recent searches on mobile cause client-server mismatch
4 participants
@obulat @dhruvkb @sarayourfriend @openverse-bot