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

Add result kind to the SELECT_SEARCH_RESULT event #3173

Merged
merged 1 commit into from
Oct 13, 2023
Merged

Add result kind to the SELECT_SEARCH_RESULT event #3173

merged 1 commit into from
Oct 13, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 10, 2023

Fixes

Related to #3149 by @obulat

Description

The SELECT_SEARCH_RESULT event has a relatedTo property that shows whether a search result or a related media was clicked. However, it is not possible to get a ratio of related results to search results because all relatedTo identifiers are different. So, you can see how many selected images were related to a particular image, but not "what percentage of clicked images was from the search results and what percentage was from the related section".

This PR adds a kind property to the SELECT_SEARCH_RESULT event that will allow us to see whether a search result, a related result, or (soon) an additional search view collection result was clicked.
It also renames the props for Image grid to match the props of the audio collection.

Testing Instructions

Run the app and click on the search results or related results (image and audio). You should see the SELECT_SEARCH_RESULT event logged with the correct kind.

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 October 10, 2023 12:30
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Oct 10, 2023
@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Oct 10, 2023
@obulat obulat mentioned this pull request Oct 10, 2023
Merged
8 tasks
@obulat obulat added 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Oct 10, 2023
@github-actions
Copy link

Size Change: +108 B (0%)

Total Size: 931 kB

Filename Size Change
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 6.79 kB +10 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.js 2.22 kB +15 B (+1%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 2.21 kB +16 B (+1%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.49 kB +18 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.37 kB +17 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 17.3 kB +12 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 16.2 kB +14 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/240.js 343 B 0 B
./frontend/.nuxt/dist/client/240.modern.js 346 B 0 B
./frontend/.nuxt/dist/client/241.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/app.js 124 kB 0 B
./frontend/.nuxt/dist/client/app.modern.js 115 kB 0 B
./frontend/.nuxt/dist/client/commons/app.js 90 kB 0 B
./frontend/.nuxt/dist/client/commons/app.modern.js 81 kB 0 B
./frontend/.nuxt/dist/client/commons/components/v-error-section/components/v-external-search-form/components/v-external-source-li/e4094511.js 5.18 kB 0 B
./frontend/.nuxt/dist/client/commons/components/v-error-section/components/v-external-search-form/components/v-external-source-li/e4094511.modern.js 5.62 kB 0 B
./frontend/.nuxt/dist/client/components/loading-icon.js 730 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 735 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 515 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.62 kB +7 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-collection.js 4.5 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-collection.modern.js 4.38 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-control.js 1.5 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-control.modern.js 1.5 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-list.js 1.44 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-list.modern.js 1.42 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-result.js 1.12 kB +6 B (+1%)
./frontend/.nuxt/dist/client/components/v-audio-result.modern.js 1.1 kB +3 B (0%)
./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-audio-track.js 5.7 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.66 kB 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 643 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.35 kB 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.35 kB 0 B
./frontend/.nuxt/dist/client/components/v-collection-header.js 1.31 kB 0 B
./frontend/.nuxt/dist/client/components/v-collection-header.modern.js 1.31 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-link.js 1.07 kB 0 B
./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 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 496 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.33 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.21 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.79 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.67 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.34 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.31 kB 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 795 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B 0 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.51 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.47 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-section.js 5.2 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 4.57 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 4.1 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 3.43 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.js 2.63 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 1.99 kB 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.57 kB 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.57 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.53 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.53 kB 0 B
./frontend/.nuxt/dist/client/components/v-hide-button.js 577 B 0 B
./frontend/.nuxt/dist/client/components/v-hide-button.modern.js 573 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.82 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.79 kB 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 642 B 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 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.07 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-details.js 5.64 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-details.modern.js 5.49 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 931 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 940 B 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 3 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.97 kB 0 B
./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-media-tags.js 589 B 0 B
./frontend/.nuxt/dist/client/components/v-media-tags.modern.js 588 B 0 B
./frontend/.nuxt/dist/client/components/v-metadata-value.js 587 B 0 B
./frontend/.nuxt/dist/client/components/v-metadata-value.modern.js 593 B 0 B
./frontend/.nuxt/dist/client/components/v-metadata.js 1.3 kB 0 B
./frontend/.nuxt/dist/client/components/v-metadata.modern.js 1.31 kB 0 B
./frontend/.nuxt/dist/client/components/v-modal.js 980 B 0 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 973 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.js 2.67 kB 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 2.03 kB 0 B
./frontend/.nuxt/dist/client/components/v-radio.js 1 kB 0 B
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.js 824 B 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 743 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio/pages/search/audio.js 4.5 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio/pages/search/audio.modern.js 4.38 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.js 803 B -2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 721 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.72 kB 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.72 kB 0 B
./frontend/.nuxt/dist/client/components/v-safety-wall.js 1.44 kB 0 B
./frontend/.nuxt/dist/client/components/v-safety-wall.modern.js 1.44 kB 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 891 B 0 B
./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 620 B 0 B
./frontend/.nuxt/dist/client/components/v-single-result-controls.js 1.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-single-result-controls.modern.js 1.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 916 B 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.07 kB 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.07 kB 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.7 kB 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.7 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 0 B
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.js 1.36 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/index.js 15.6 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 14.6 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 4.96 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.73 kB 0 B
./frontend/.nuxt/dist/client/pages/index.js 6.38 kB 0 B
./frontend/.nuxt/dist/client/pages/index.modern.js 6.35 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.js 1.47 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.46 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 0 B
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.61 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 5.78 kB 0 B
./frontend/.nuxt/dist/client/pages/search.modern.js 8.13 kB 0 B
./frontend/.nuxt/dist/client/pages/search/audio.js 499 B -3 B (-1%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 504 B -3 B (-1%)
./frontend/.nuxt/dist/client/pages/search/image.js 452 B -8 B (-2%)
./frontend/.nuxt/dist/client/pages/search/image.modern.js 454 B -8 B (-2%)
./frontend/.nuxt/dist/client/pages/search/index.js 316 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 319 B 0 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 242 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/sensitive-content.js 1.52 kB 0 B
./frontend/.nuxt/dist/client/pages/sensitive-content.modern.js 1.53 kB 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/runtime.js 2.79 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.79 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.js 68.3 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.modern.js 68.1 kB 0 B

compressed-size-action

AetherUnbound
AetherUnbound approved these changes Oct 11, 2023
View reviewed changes
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.

Looks good! Since this is only adding a new field to events shipped to Plausible (not changing one), we don't need to take any extra action on existing events, do we?

dhruvkb
dhruvkb approved these changes Oct 12, 2023
View reviewed changes
Copy link
Member

@dhruvkb dhruvkb 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.

The changes make sense to me 👍! Thanks. I have a nit but it's totally ignorable.

Post-merge update: I forgot to mark the nit I had 🤦.

@obulat obulat merged commit ad4c814 into main Oct 13, 2023
70 checks passed
@obulat obulat deleted the add/select_search_result_kind branch October 13, 2023 04:24
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

@AetherUnbound AetherUnbound AetherUnbound approved these changes

Assignees
No one assigned
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 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.
4 participants
@obulat @AetherUnbound @dhruvkb @openverse-bot