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

useSensitiveMedia composable #2700

Merged
merged 9 commits into from
Jul 24, 2023
Merged

useSensitiveMedia composable #2700

merged 9 commits into from
Jul 24, 2023

Conversation

zackkrida
Copy link
Member

@zackkrida zackkrida commented Jul 21, 2023

Fixes

Related to #2462 by @dhruvkb

Description

This PR creates a new useSensitiveMedia composable for working with sensitive media, and updates the blurring logic to use this composable. This composable is fully tested with a unit test, and forms the basis of the "backend" work for the single result sensitivity UI. It includes hide/reveal methods that aren't used by this PR but will be for the VSafetyWall.

This PR also adds revealedSensitiveResults, a list of UUIDs of revealed sensitive media, to the UI store.

It was extracted into a standalone PR for ease of reviewing.

Testing Instructions

Check that blurring still works as-expected in the frontend search results, when all relevant /preferences toggles are enabled. Check that you like the useSensitiveMedia implementation and that test coverage is sufficient.

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.

@zackkrida zackkrida requested a review from a team as a code owner July 21, 2023 21:36
@zackkrida zackkrida requested review from obulat and dhruvkb July 21, 2023 21:36
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Jul 21, 2023
@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Jul 21, 2023
@github-actions
Copy link

github-actions bot commented Jul 21, 2023

Size Change: +168 B (0%)

Total Size: 837 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 122 kB +204 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 113 kB +207 B (0%)
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB -11 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 6.52 kB -15 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.38 kB -28 B (-1%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.35 kB -15 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.94 kB -10 B (-1%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.42 kB -11 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.72 kB -13 B (-1%)
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.73 kB -13 B (-1%)
./frontend/.nuxt/dist/client/vendors/app.js 68.3 kB -131 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/232.js 273 B +1 B (0%)
./frontend/.nuxt/dist/client/232.modern.js 277 B 0 B
./frontend/.nuxt/dist/client/233.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/commons/app.modern.js 80.8 kB +3 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.17 kB +1 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.61 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.js 731 B +1 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 733 B -1 B (0%)
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 518 B 0 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 6.35 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.js 571 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 576 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 1.79 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 959 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 961 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 636 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 641 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 632 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 636 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.33 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.33 kB -4 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 -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-page.js 530 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 536 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 492 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 497 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.33 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.21 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.79 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.67 kB +5 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 +2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 797 B 0 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.42 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.39 kB +6 B (0%)
./frontend/.nuxt/dist/client/components/v-error-section.js 373 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 376 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.99 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 894 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 -3 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.54 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-home-gallery.js 4.28 kB -1 B (0%)
./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 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.95 kB -9 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.js 1.44 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.29 kB -7 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 642 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.js 1.17 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.94 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 kB +3 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.01 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 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 857 B 0 B
./frontend/.nuxt/dist/client/components/v-radio.js 1 kB +1 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 1.73 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.64 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.js 806 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 718 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 976 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.js 891 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 892 B 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.81 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.17 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.js 618 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-server-timeout.js 298 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 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 915 B 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.06 kB 0 B
./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.3 kB 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.4 kB 0 B
./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 -1 B (0%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB 0 B
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.72 kB -5 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.57 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.36 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.04 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.87 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 4.89 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.67 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 6.34 kB 0 B
./frontend/.nuxt/dist/client/pages/index.modern.js 6.3 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB 0 B
./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 0 B
./frontend/.nuxt/dist/client/pages/search-help.js 1.62 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.61 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search.js 2.25 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.06 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 4.1 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.98 kB +4 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.js 544 B 0 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 549 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.js 441 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B 0 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 242 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 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.53 kB 0 B
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB -1 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.69 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.69 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.modern.js 68.1 kB 0 B

compressed-size-action

@zackkrida zackkrida added 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Jul 21, 2023
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.

Thank you for extracting these changes, they are really fun! They work well, but I found a problem with implementation, and one suggestion on possible simplification using Set.

The biggest blocker is the uiStore watcher that is called by every component using use-sensitive-media composable.

frontend/src/composables/use-sensitive-media.ts Outdated Show resolved Hide resolved
@zackkrida zackkrida requested a review from obulat July 22, 2023 21:12
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.

Works well and has great tests :)

frontend/src/composables/use-sensitive-media.ts Outdated Show resolved Hide resolved
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, this is a good abstraction over the sensitivity functionality.

frontend/src/composables/use-sensitive-media.ts Outdated Show resolved Hide resolved
@zackkrida zackkrida merged commit 5ef8122 into main Jul 24, 2023
41 checks passed
@zackkrida zackkrida deleted the use-sensitive-media-composable branch July 24, 2023 19:58
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: addition Addition of new feature 🟧 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.

4 participants