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

Analytics: Add SELECT_SEARCH_RESULT event #2373

Merged
merged 3 commits into from
Jun 16, 2023
Merged

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jun 9, 2023

Fixes

Fixes #1079 by @dhruvkb

Description

This PR sends analytics events when the user selects one of the search results on the search page or one of the related media items on the single result page.

Testing Instructions

Try selecting results on the search pages (all content/image/audio) or the related items on the single result page. You should see the events in Plausible UI or in the 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.

@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Jun 9, 2023
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository labels Jun 9, 2023
@github-actions
Copy link

github-actions bot commented Jun 9, 2023

Size Change: +1.57 kB (0%)

Total Size: 847 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 124 kB -35 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 115 kB -57 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 80.8 kB +10 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.94 kB +165 B (+3%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.83 kB +184 B (+3%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 572 B +150 B (+36%) 🚨
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 574 B +149 B (+35%) 🚨
./frontend/.nuxt/dist/client/components/v-error-image.js 2.6 kB -10 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.56 kB -11 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.89 kB -26 B (-1%)
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.88 kB -29 B (-1%)
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.71 kB -18 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.68 kB -20 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.81 kB +154 B (+9%) 🔍
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.81 kB +154 B (+9%) 🔍
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.09 kB +186 B (+5%) 🔍
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.97 kB +191 B (+5%) 🔍
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.46 kB +172 B (+13%) ⚠️
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.46 kB +172 B (+13%) ⚠️
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.4 kB +96 B (+2%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.19 kB +101 B (+2%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.28 kB -18 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 7.03 kB -19 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 5 kB -11 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.74 kB -10 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 7 kB -31 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.93 kB -26 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 64.4 kB +24 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/234.js 272 B 0 B
./frontend/.nuxt/dist/client/234.modern.js 277 B 0 B
./frontend/.nuxt/dist/client/235.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB -1 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.18 kB +2 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 764 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 768 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-audio-details.js 1.81 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.78 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.36 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.3 kB -2 B (0%)
./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 644 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 689 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 693 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.27 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-link.js 1.07 kB +2 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 524 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 526 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 491 B -1 B (0%)
./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 +1 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.8 kB +3 B (0%)
./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 3.99 kB -2 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 -9 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB -6 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 792 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B 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 376 B 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.89 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.87 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.js 895 B 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 897 B 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.62 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.77 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.74 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.js 1.43 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 644 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 843 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 743 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.js 931 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 940 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.93 kB -9 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 kB -7 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 856 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 858 B 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-images.js 1.1 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.1 kB +1 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.68 kB 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.js 891 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 892 B 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.89 kB -8 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.24 kB -9 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.js 618 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 300 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.02 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 915 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.1 kB 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.2 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.4 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.js 1.33 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.js 1.23 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.24 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.js 1.6 kB +6 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.59 kB +5 B (0%)
./frontend/.nuxt/dist/client/pages/search.js 2.2 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB 0 B
./frontend/.nuxt/dist/client/pages/search/audio.js 3.67 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.56 kB 0 B
./frontend/.nuxt/dist/client/pages/search/image.js 546 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.modern.js 549 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.js 442 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B 0 B
./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/search-page.types.js 266 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.js 239 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.51 kB 0 B
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.52 kB +1 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.71 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.72 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.js 65.2 kB -3 B (0%)

compressed-size-action

@obulat obulat force-pushed the add/SELECT_SEARCH_RESULT_event branch from 33f6467 to b34c7f6 Compare June 10, 2023 05:43
@obulat obulat marked this pull request as ready for review June 10, 2023 11:59
@obulat obulat requested a review from a team as a code owner June 10, 2023 11:59
@obulat obulat requested review from AetherUnbound and dhruvkb June 10, 2023 11:59
@obulat obulat self-assigned this Jun 12, 2023
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.

LGTM and the events are firing off locally!

props: {
image,
searchTerm: "cat",
aspectRatio: "square",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this prop necessary for this test?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

square is the default for aspectRatio, so you're right, we can remove it.

@openverse-bot
Copy link
Collaborator

Based on the medium urgency of this PR, the following reviewers are being gently reminded to review this PR:

@dhruvkb
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 4 day(s) ago. PRs labelled with medium urgency are expected to be reviewed within 4 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

Copy link
Collaborator

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

LGTM! Tested perfectly locally in all the places 🎉

Something to note is that homepage images do not have this event, so the total number of works "navigated to" on the site from another page of the site won't necessarily be equal to the number of SELECT_SEARCH_RESULT events. I doubt this will have any bearing on anything, but I could easily see some discrepancy between these causing us to scratch our heads in the future 😂

@obulat
Copy link
Contributor Author

obulat commented Jun 16, 2023

LGTM! Tested perfectly locally in all the places 🎉

Something to note is that homepage images do not have this event, so the total number of works "navigated to" on the site from another page of the site won't necessarily be equal to the number of SELECT_SEARCH_RESULT events. I doubt this will have any bearing on anything, but I could easily see some discrepancy between these causing us to scratch our heads in the future 😂

Actually, we have CLICK_HOME_GALLERY_IMAGE for those, so the total number of works "navigated to" should equal to the number of CLICK_HOME_GALLERY_IMAGE plus the number of SELECT_SEARCH_RESULT events.

@obulat obulat merged commit 528c41d into main Jun 16, 2023
@obulat obulat deleted the add/SELECT_SEARCH_RESULT_event branch June 16, 2023 14:32
@obulat obulat mentioned this pull request Jun 19, 2023
26 tasks
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: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Analytics event: SELECT_SEARCH_RESULT
4 participants