Fix types in the templates #2584

obulat · 2023-07-07T14:07:18Z

~~Note: This PR is based on #2583, and should be reviewed after it.~~ ¹

Fixes

Description

This PR adds conditional rendering to the single result page templates to account for the fact that the main media (image/audio) can be null.

This PR was split from the bigger fix to simplify review.

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.
I ran the DAG documentation generator (if applicable).

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.

I realized that this PR doesn't really need the changes from 2583, so I rebased it on main. ↩

github-actions · 2023-07-07T14:13:05Z

Size Change: +67 B (0%)

Total Size: 832 kB

Filename	Size	Change
`./frontend/.nuxt/dist/client/pages/audio/_id/index.js`	6.77 kB	+15 B (0%)
`./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js`	6.54 kB	+18 B (0%)
`./frontend/.nuxt/dist/client/pages/image/_id/index.js`	7.27 kB	+14 B (0%)
`./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js`	7.04 kB	+20 B (0%)

ℹ️ View Unchanged

Filename	Size
`./frontend/.nuxt/dist/client/232.js`	272 B
`./frontend/.nuxt/dist/client/232.modern.js`	276 B
`./frontend/.nuxt/dist/client/233.js`	1.85 kB
`./frontend/.nuxt/dist/client/app.js`	122 kB
`./frontend/.nuxt/dist/client/app.modern.js`	113 kB
`./frontend/.nuxt/dist/client/commons/app.js`	90.2 kB
`./frontend/.nuxt/dist/client/commons/app.modern.js`	80.7 kB
`./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js`	5.18 kB
`./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js`	5.62 kB
`./frontend/.nuxt/dist/client/components/loading-icon.js`	728 B
`./frontend/.nuxt/dist/client/components/loading-icon.modern.js`	732 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`	6.42 kB
`./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js`	6.26 kB
`./frontend/.nuxt/dist/client/components/v-audio-cell.js`	571 B
`./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js`	573 B
`./frontend/.nuxt/dist/client/components/v-audio-details.js`	1.79 kB
`./frontend/.nuxt/dist/client/components/v-audio-details.modern.js`	1.77 kB
`./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js`	958 B
`./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js`	962 B
`./frontend/.nuxt/dist/client/components/v-audio-track.js`	5.28 kB
`./frontend/.nuxt/dist/client/components/v-audio-track.modern.js`	5.23 kB
`./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js`	634 B
`./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js`	643 B
`./frontend/.nuxt/dist/client/components/v-bone.js`	632 B
`./frontend/.nuxt/dist/client/components/v-bone.modern.js`	636 B
`./frontend/.nuxt/dist/client/components/v-box-layout.js`	1.26 kB
`./frontend/.nuxt/dist/client/components/v-box-layout.modern.js`	1.25 kB
`./frontend/.nuxt/dist/client/components/v-content-link.js`	1.06 kB
`./frontend/.nuxt/dist/client/components/v-content-link.modern.js`	1.06 kB
`./frontend/.nuxt/dist/client/components/v-content-page.js`	524 B
`./frontend/.nuxt/dist/client/components/v-content-page.modern.js`	526 B
`./frontend/.nuxt/dist/client/components/v-content-report-button.js`	491 B
`./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js`	497 B
`./frontend/.nuxt/dist/client/components/v-content-report-form.js`	3.33 kB
`./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js`	3.21 kB
`./frontend/.nuxt/dist/client/components/v-content-report-popover.js`	3.79 kB
`./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js`	3.68 kB
`./frontend/.nuxt/dist/client/components/v-copy-button.js`	3.99 kB
`./frontend/.nuxt/dist/client/components/v-copy-button.modern.js`	4 kB
`./frontend/.nuxt/dist/client/components/v-copy-license.js`	2.28 kB
`./frontend/.nuxt/dist/client/components/v-copy-license.modern.js`	2.25 kB
`./frontend/.nuxt/dist/client/components/v-dmca-notice.js`	792 B
`./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js`	799 B
`./frontend/.nuxt/dist/client/components/v-error-image.js`	2.6 kB
`./frontend/.nuxt/dist/client/components/v-error-image.modern.js`	2.56 kB
`./frontend/.nuxt/dist/client/components/v-error-section.js`	372 B
`./frontend/.nuxt/dist/client/components/v-error-section.modern.js`	376 B
`./frontend/.nuxt/dist/client/components/v-external-search-form.js`	2 kB
`./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js`	1.98 kB
`./frontend/.nuxt/dist/client/components/v-external-source-list.js`	895 B
`./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js`	897 B
`./frontend/.nuxt/dist/client/components/v-full-layout.js`	1.57 kB
`./frontend/.nuxt/dist/client/components/v-full-layout.modern.js`	1.57 kB
`./frontend/.nuxt/dist/client/components/v-grid-skeleton.js`	1.53 kB
`./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js`	1.54 kB
`./frontend/.nuxt/dist/client/components/v-home-gallery.js`	4.89 kB
`./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js`	4.88 kB
`./frontend/.nuxt/dist/client/components/v-homepage-content.js`	1.79 kB
`./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js`	1.76 kB
`./frontend/.nuxt/dist/client/components/v-image-cell.js`	1.81 kB
`./frontend/.nuxt/dist/client/components/v-image-cell.modern.js`	1.81 kB
`./frontend/.nuxt/dist/client/components/v-image-details.js`	1.44 kB
`./frontend/.nuxt/dist/client/components/v-image-details.modern.js`	1.43 kB
`./frontend/.nuxt/dist/client/components/v-image-grid.js`	4.29 kB
`./frontend/.nuxt/dist/client/components/v-image-grid.modern.js`	4.16 kB
`./frontend/.nuxt/dist/client/components/v-license-tab-panel.js`	642 B
`./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js`	649 B
`./frontend/.nuxt/dist/client/components/v-load-more.js`	1.17 kB
`./frontend/.nuxt/dist/client/components/v-load-more.modern.js`	1.07 kB
`./frontend/.nuxt/dist/client/components/v-media-license.js`	932 B
`./frontend/.nuxt/dist/client/components/v-media-license.modern.js`	941 B
`./frontend/.nuxt/dist/client/components/v-media-reuse.js`	2.93 kB
`./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js`	2.91 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`	994 B
`./frontend/.nuxt/dist/client/components/v-no-results.js`	855 B
`./frontend/.nuxt/dist/client/components/v-no-results.modern.js`	858 B
`./frontend/.nuxt/dist/client/components/v-radio.js`	1 kB
`./frontend/.nuxt/dist/client/components/v-radio.modern.js`	1.01 kB
`./frontend/.nuxt/dist/client/components/v-related-audio.js`	1.47 kB
`./frontend/.nuxt/dist/client/components/v-related-audio.modern.js`	1.47 kB
`./frontend/.nuxt/dist/client/components/v-related-images.js`	1.06 kB
`./frontend/.nuxt/dist/client/components/v-related-images.modern.js`	1.06 kB
`./frontend/.nuxt/dist/client/components/v-report-desc-form.js`	976 B
`./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js`	980 B
`./frontend/.nuxt/dist/client/components/v-row-layout.js`	1.65 kB
`./frontend/.nuxt/dist/client/components/v-row-layout.modern.js`	1.65 kB
`./frontend/.nuxt/dist/client/components/v-scroll-button.js`	891 B
`./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js`	892 B
`./frontend/.nuxt/dist/client/components/v-search-grid.js`	7 kB
`./frontend/.nuxt/dist/client/components/v-search-grid.modern.js`	6.35 kB
`./frontend/.nuxt/dist/client/components/v-search-results-title.js`	618 B
`./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js`	620 B
`./frontend/.nuxt/dist/client/components/v-server-timeout.js`	299 B
`./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js`	302 B
`./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js`	1.02 kB
`./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js`	914 B
`./frontend/.nuxt/dist/client/components/v-snackbar.js`	1.06 kB
`./frontend/.nuxt/dist/client/components/v-snackbar.modern.js`	1.06 kB
`./frontend/.nuxt/dist/client/components/v-sources-table.js`	14.1 kB
`./frontend/.nuxt/dist/client/components/v-sources-table.modern.js`	14.1 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/feedback.js`	1.34 kB
`./frontend/.nuxt/dist/client/pages/feedback.modern.js`	1.34 kB
`./frontend/.nuxt/dist/client/pages/image/_id/report.js`	5 kB
`./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js`	4.74 kB
`./frontend/.nuxt/dist/client/pages/index.js`	6.98 kB
`./frontend/.nuxt/dist/client/pages/index.modern.js`	6.92 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.24 kB
`./frontend/.nuxt/dist/client/pages/privacy.modern.js`	1.24 kB
`./frontend/.nuxt/dist/client/pages/search-help.js`	1.6 kB
`./frontend/.nuxt/dist/client/pages/search-help.modern.js`	1.58 kB
`./frontend/.nuxt/dist/client/pages/search.js`	2.25 kB
`./frontend/.nuxt/dist/client/pages/search.modern.js`	2.04 kB
`./frontend/.nuxt/dist/client/pages/search/audio.js`	4.12 kB
`./frontend/.nuxt/dist/client/pages/search/audio.modern.js`	3.98 kB
`./frontend/.nuxt/dist/client/pages/search/image.js`	546 B
`./frontend/.nuxt/dist/client/pages/search/image.modern.js`	547 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`	244 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.69 kB
`./frontend/.nuxt/dist/client/runtime.modern.js`	2.69 kB
`./frontend/.nuxt/dist/client/vendors/app.js`	65.4 kB
`./frontend/.nuxt/dist/client/vendors/app.modern.js`	64.8 kB

_{compressed-size-action}

zackkrida

👍 When we switch to Nuxt 3 we should consider using error boundaries for client-side errors like these:

https://nuxt.com/docs/api/components/nuxt-error-boundary

Currently, if a frontend request to a single media result from the API fails, the page will render blank like this:

I do wonder if we should be throwing a 404 error or displaying some "{media} not found or temporarily unavailable" message here. Perhaps we could show a specific message if the API 429s. All of those would be follow-up work though and require design from @fcoveram.

obulat · 2023-07-07T15:37:34Z

👍 When we switch to Nuxt 3 we should consider using error boundaries for client-side errors like these:

Nice!

Currently, if a frontend request to a single media result from the API fails, the page will render blank like this:

I do wonder if we should be throwing a 404 error or displaying some "{media} not found or temporarily unavailable" message here. Perhaps we could show a specific message if the API 429s. All of those would be follow-up work though and require design from @fcoveram.

This wasn't the intended behavior 😨 I did try to redirect to the error page (our generic FourOhFour) if the request fails.
I'm trying to fix it in the follow-up PR.

I had the same idea for 429, here's the issue: #2586

dhruvkb

The changes make sense, LGTM!

obulat added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 💻 aspect: code Concerns the software code in the repository 🧱 stack: frontend Related to the Nuxt frontend labels Jul 7, 2023

obulat self-assigned this Jul 7, 2023

obulat requested a review from a team as a code owner July 7, 2023 14:07

obulat requested review from AetherUnbound and sarayourfriend July 7, 2023 14:07

zackkrida approved these changes Jul 7, 2023

View reviewed changes

obulat mentioned this pull request Jul 7, 2023

Fix fetching and types on single result pages #2585

Merged

8 tasks

dhruvkb approved these changes Jul 7, 2023

View reviewed changes

obulat added 2 commits July 7, 2023 21:36

Fix types in the templates

17e7618

Fix unit test

91ad690

obulat force-pushed the fix/types_in_single_result_templates branch from db7b1af to 91ad690 Compare July 7, 2023 18:40

obulat requested a review from a team as a code owner July 7, 2023 18:40

obulat changed the base branch from move_single_page_unit_tests_to_e2e to main July 7, 2023 18:40

Fix audio event type to trigger CI

976dd85

obulat merged commit 7dc4c75 into main Jul 7, 2023

obulat deleted the fix/types_in_single_result_templates branch July 7, 2023 18:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix types in the templates #2584

Fix types in the templates #2584

obulat commented Jul 7, 2023 •

edited

Loading

github-actions bot commented Jul 7, 2023 •

edited

Loading

zackkrida left a comment

obulat commented Jul 7, 2023

dhruvkb left a comment

Fix types in the templates #2584

Fix types in the templates #2584

Conversation

obulat commented Jul 7, 2023 • edited Loading

Fixes

Description

Testing Instructions

Checklist

Developer Certificate of Origin

Footnotes

github-actions bot commented Jul 7, 2023 • edited Loading

zackkrida left a comment

Choose a reason for hiding this comment

obulat commented Jul 7, 2023

dhruvkb left a comment

Choose a reason for hiding this comment

obulat commented Jul 7, 2023 •

edited

Loading

github-actions bot commented Jul 7, 2023 •

edited

Loading