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

Rename mature to includeSensitiveResults #2721

Merged
merged 5 commits into from
Aug 3, 2023
Merged

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jul 26, 2023

Fixes

Fixes #2548 by @dhruvkb

Description

The mature query parameter is renamed to unstable__include_sensitive_results.
The filter category is renamed from mature to includeSensitiveResults
The filter object in the search store is changed from mature: { code: "mature", name: "...", checked: true } to includeSensitiveResults: { code: "includeSensitiveResults", name: "", checked: true }.

Testing Instructions

We have extensive unit tests for transforming the query to filters in the search store, and filters to the API query parameters. They should pass.

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 self-assigned this Jul 26, 2023
@obulat obulat requested a review from a team as a code owner July 26, 2023 04:44
@obulat obulat requested review from AetherUnbound and dhruvkb July 26, 2023 04:44
@github-actions github-actions bot added 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend labels Jul 26, 2023
@obulat obulat force-pushed the rename_mature_query_param branch from 4c7516b to 396309a Compare July 26, 2023 04:45
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository labels Jul 26, 2023
@github-actions
Copy link

github-actions bot commented Jul 26, 2023

Size Change: +314 B (0%)

Total Size: 871 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 122 kB +95 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 113 kB +81 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 80.8 kB +15 B (0%)
./frontend/.nuxt/dist/client/vendors/app.js 68.3 kB +33 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 68.1 kB +11 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/239.js 273 B 0 B
./frontend/.nuxt/dist/client/239.modern.js 277 B 0 B
./frontend/.nuxt/dist/client/240.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB +5 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.17 kB +3 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.62 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.js 729 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 733 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B 0 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 4.02 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 3.98 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid/components/v-audio-collection/components/v-related-audio/pages/audio/_/0a3edca7.js 3.18 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid/components/v-audio-collection/components/v-related-audio/pages/audio/_/0a3edca7.modern.js 3.08 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 895 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 881 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-collection.js 1.7 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-collection.modern.js 1.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 1.79 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.76 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details/components/v-image-details/pages/image/_id/index.js 3.79 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details/components/v-image-details/pages/image/_id/index.modern.js 3.67 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-list.js 1.25 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-list.modern.js 1.23 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 958 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 961 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.46 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.41 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 635 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 640 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 632 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.modern.js 637 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.33 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.33 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.js 1.06 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-page.js 530 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 534 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-button.js 493 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 497 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.33 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.21 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.79 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.67 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 3.99 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 792 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 798 B 0 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.41 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.38 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 375 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.99 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.98 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 896 B 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 896 B 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.57 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.58 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.53 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.54 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-hide-button.js 812 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-hide-button.modern.js 813 B 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.26 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.8 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.77 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-icon-button.js 523 B 0 B
./frontend/.nuxt/dist/client/components/v-icon-button.modern.js 528 B 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.95 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.94 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-details.js 1.44 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.42 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.3 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 650 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 1.18 kB 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 932 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 939 B 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.93 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B 0 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 B 0 B
./frontend/.nuxt/dist/client/components/v-modal.js 1 kB 0 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 995 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.js 855 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 857 B 0 B
./frontend/.nuxt/dist/client/components/v-radio.js 1 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.01 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.js 2.15 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 2.03 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.js 805 B 0 B
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 718 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 975 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 981 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.72 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.73 kB 0 B
./frontend/.nuxt/dist/client/components/v-safety-wall.js 1.32 kB 0 B
./frontend/.nuxt/dist/client/components/v-safety-wall.modern.js 1.32 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.js 891 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 891 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.83 kB 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.18 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.js 617 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 622 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-server-timeout.js 302 B +4 B (+1%)
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 306 B +3 B (+1%)
./frontend/.nuxt/dist/client/components/v-single-result-controls.js 1.35 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-single-result-controls.modern.js 1.36 kB 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 914 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.07 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.07 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.4 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.4 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B 0 B
./frontend/.nuxt/dist/client/pages/about.js 1.42 kB 0 B
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 10.9 kB +6 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 10.6 kB +9 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.36 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 8.23 kB +4 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 8.04 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.js 4.9 kB +4 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.68 kB +7 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 6.34 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.3 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.31 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.js 1.26 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.26 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.js 1.62 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.61 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.27 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.09 kB 0 B
./frontend/.nuxt/dist/client/pages/search/audio.js 1.86 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 1.84 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.js 462 B +2 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.modern.js 462 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.js 313 B -2 B (-1%)
./frontend/.nuxt/dist/client/pages/search/index.modern.js 4.04 kB +6 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B 0 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 244 B 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.54 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB +2 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.78 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.78 kB 0 B

compressed-size-action

@github-actions
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/2721

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@obulat obulat force-pushed the rename_mature_query_param branch from 396309a to c84ce9a Compare July 27, 2023 17:14
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.

Are there any tests that we should be making locally? Is the app expected to behave as normal?

*/
const filterToString = (filterItem: FilterItem[]) => {
const filterString = filterItem
.filter((f) => f.checked)
.map((filterItem) => filterItem.code)
.join(",")
return filterString === "mature" ? "true" : filterString
// TODO: check this
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this still be checked? 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope :D Removed the comment.

includeSensitiveResults: [
{
code: "includeSensitiveResults",
name: "filters.mature.mature",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does this name need to change as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since this PR does not change the string, it's better not to rename this key, too. Otherwise, we will make this string "fuzzy" in GlotPress - which is not really necessary just yet.

@@ -31,7 +32,7 @@ export const NoResultsTemplate = (args) => ({
<template #image>
<VErrorImage :error-code="args.errorCode" />
</template>
<VNoResults :type="args.type" :query="args.query"/>
<VNoResults :media-type="args.type" :query="args.query" :search-term="args.query.q" :external-sources=[] />
Copy link
Member

Choose a reason for hiding this comment

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

VNoResults doesn't take query as a prop.

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

LGTM.

@obulat obulat force-pushed the rename_mature_query_param branch from 473ec94 to 59c36a0 Compare August 2, 2023 11:03
@obulat obulat requested a review from zackkrida August 2, 2023 15:30
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.

LGTM.

@obulat obulat merged commit 61c7abd into main Aug 3, 2023
@obulat obulat deleted the rename_mature_query_param branch August 3, 2023 03:43
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: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Rename 'mature' query param to 'include_sensitive_results'
5 participants