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 event: SUBMIT_SEARCH #2120

Merged
merged 1 commit into from
May 25, 2023
Merged

Analytics event: SUBMIT_SEARCH #2120

merged 1 commit into from
May 25, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented May 17, 2023

Fixes

Fixes #1068 by @obulat

Description

This PR adds a SUBMIT_SEARCH analytics event that is fired when the search is submitted from the homepage, the search bar in the search page header, and the 404 page.

This PR also simplifies the VSearchButton component removing the version that used a text label, and using it in both the SearchBar and the StandaloneSearchBar (which is used on 404 and home pages, and does not remove the search text when the server-rendered page is hydrated). Edit: Extracted to standalone PR #2148.

The unused input sizes (standalone/large) are also removed.
Home page directly imports the child components instead of lazy-loading them, because they are always loaded anyways.

Testing Instructions

Set up analytics (just frontend/up, just frontend/init) and run the app (just frontend/run dev).
Open the app (localhost:8443) and the analytics server (http://0.0.0.0:50288/).
Try executing searches from all three places in the description, and see that the Custom events section1 shows the events correctly.

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.

Footnotes

  1. https://docs.openverse.org/frontend/guides/analytics.html#custom-events

@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label May 17, 2023
@obulat obulat changed the title Analytics: SUBMIT_SEARCH event Analytics event: SUBMIT_SEARCH May 17, 2023
@obulat obulat added 💻 aspect: code Concerns the software code in the repository 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature labels May 17, 2023
@github-actions
Copy link

github-actions bot commented May 17, 2023

Size Change: +179 B (0%)

Total Size: 834 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 127 kB +90 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 118 kB +96 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/233.js 272 B 0 B
./frontend/.nuxt/dist/client/233.modern.js 277 B 0 B
./frontend/.nuxt/dist/client/234.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB -5 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 78.5 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.js 766 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 769 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 5.75 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.62 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 397 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.35 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.78 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 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.27 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.21 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 637 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 642 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 688 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 692 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.27 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.js 1.04 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.04 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 528 B 0 B
./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.86 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.69 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 913 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.14 kB -5 B (0%)
./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.09 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.06 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 793 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B 0 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.6 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.57 kB -1 B (0%)
./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 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.88 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.87 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 893 B 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 896 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.56 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.55 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.92 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.9 kB +1 B (0%)
./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-carousel.js 4.74 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.68 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.67 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-details.js 1.96 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 3.91 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.8 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 643 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 846 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 740 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 828 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 836 B 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.69 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.65 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 421 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 0 B
./frontend/.nuxt/dist/client/components/v-no-results.js 814 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 815 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.29 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.29 kB +1 B (0%)
./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 0 B
./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 979 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 +1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 829 B 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.55 kB 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.46 kB -3 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 -1 B (0%)
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 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 912 B 0 B
./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.2 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.2 kB -1 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.39 kB 0 B
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.52 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 5.9 kB +4 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB 0 B
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.46 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.77 kB +7 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 2.23 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 5.21 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 7.03 kB -5 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.95 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.23 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.24 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.js 1.59 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.2 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 3.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.58 kB 0 B
./frontend/.nuxt/dist/client/pages/search/image.js 545 B 0 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 550 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.js 443 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 447 B +1 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/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 240 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.51 kB 0 B
./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.js 64.6 kB -5 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.9 kB -4 B (0%)

compressed-size-action

@obulat obulat self-assigned this May 17, 2023
@obulat obulat force-pushed the add/SUBMIT_SEARCH_event branch from 830ddbd to f493115 Compare May 17, 2023 09:24
@obulat obulat marked this pull request as ready for review May 17, 2023 09:49
@obulat obulat requested a review from a team as a code owner May 17, 2023 09:49
@obulat obulat requested review from AetherUnbound and dhruvkb May 17, 2023 09:49
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, I can see the events showing up in the console! I wasn't able to get plausible setup, but I'll do that on my own at some point in the interest of time.

@obulat obulat force-pushed the add/SUBMIT_SEARCH_event branch from 5f78d52 to 3d1fc03 Compare May 18, 2023 07:41
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.

Does this PR also involve style changes along with the analytics event?

@obulat
Copy link
Contributor Author

obulat commented May 18, 2023

Does this PR also involve style changes along with the analytics event?

Not style changes, but refactoring of the search button. The old search button used to have logic to decide whether to show an icon or a text label, and there were two different components for StandaloneSearchBar and the SearchBar - I combined them in this PR.

Edited to add: @dhruvkb , I've extracted the style changes to a separate PR and rebased this on it.

@obulat obulat force-pushed the add/SUBMIT_SEARCH_event branch 4 times, most recently from affda65 to 9106907 Compare May 20, 2023 03:38
@obulat obulat mentioned this pull request May 20, 2023
8 tasks
@obulat obulat changed the base branch from main to update/search_button May 20, 2023 03:51
@obulat obulat force-pushed the update/search_button branch 5 times, most recently from 9dd91a3 to 27167a7 Compare May 21, 2023 13:22
@obulat obulat force-pushed the add/SUBMIT_SEARCH_event branch from 9106907 to 23377ba Compare May 21, 2023 13:24
@obulat obulat changed the base branch from update/search_button to main May 21, 2023 13:27
@obulat obulat force-pushed the add/SUBMIT_SEARCH_event branch from 23377ba to b2292ed Compare May 21, 2023 13:32
@zackkrida zackkrida requested a review from dhruvkb May 22, 2023 13:50
@obulat obulat mentioned this pull request May 23, 2023
26 tasks
@openverse-bot
Copy link
Collaborator

Based on the high 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 5 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 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.

@obulat obulat merged commit f138b15 into main May 25, 2023
@obulat obulat deleted the add/SUBMIT_SEARCH_event branch May 25, 2023 16:10
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.

Analytics event: SUBMIT_SEARCH
4 participants