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

Add APPLY_FILTER analytics event #2423

Merged
merged 2 commits into from
Jun 21, 2023
Merged

Add APPLY_FILTER analytics event #2423

merged 2 commits into from
Jun 21, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jun 16, 2023

Fixes

Fixes #1070 by @dhruvkb

Description

This PR adds APPLY_FILTER event sent when the user selects a filter.
We might want to debounce it, I'm not sure if I should add it here?

Some unrelated changes were also added to clean up the unused ref, and use storeToRefs pinia helper to reduce the number of computeds used in the file.

Testing Instructions

Try clicking on the filters (both in the modal on mobile screen, and the sidebar on the desktop). You should see the event logged in the console, and tracked in Plausible at 0.0.0.0:50288 (if you run just frontend/up and just frontend/init as described in https://docs.openverse.org/frontend/guides/analytics.html).

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 Jun 16, 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 🧱 stack: frontend Related to the Nuxt frontend labels Jun 16, 2023
@obulat obulat force-pushed the add/APPLY_FILTER_event branch from dbbc8d1 to 830c504 Compare June 16, 2023 14:43
@obulat obulat marked this pull request as ready for review June 16, 2023 14:43
@obulat obulat requested a review from a team as a code owner June 16, 2023 14:43
@obulat obulat requested review from AetherUnbound and dhruvkb June 16, 2023 14:43
@github-actions
Copy link

github-actions bot commented Jun 16, 2023

Size Change: +96 B (0%)

Total Size: 840 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 122 kB +82 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 114 kB +98 B (0%)
./frontend/.nuxt/dist/client/vendors/app.js 65.3 kB +35 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 64.4 kB -90 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 +4 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 80.8 kB +2 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.18 kB -1 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.62 kB 0 B
./frontend/.nuxt/dist/client/components/loading-icon.js 728 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 732 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.76 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.64 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 571 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 573 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 1.76 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.74 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 958 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 962 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.32 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.27 kB 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 634 B -2 B (0%)
./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 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.26 kB 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.25 kB 0 B
./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 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 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 0 B
./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 0 B
./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 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.28 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 792 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.6 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.56 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 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.88 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 893 B -1 B (0%)
./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 +1 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.53 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.89 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.88 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.77 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.74 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.7 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.66 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.81 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.81 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-details.js 1.42 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.98 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.87 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B -3 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 648 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.js 844 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 743 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 932 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 940 B 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.93 kB +1 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 0 B
./frontend/.nuxt/dist/client/components/v-no-results.js 854 B -2 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 857 B -1 B (0%)
./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 1.42 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.42 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.06 kB -1 B (0%)
./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-row-layout.js 1.65 kB 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.65 kB -1 B (0%)
./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.89 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.24 kB 0 B
./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 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 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.2 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.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 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.33 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.12 kB -2 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.55 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.js 1.33 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.24 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.99 kB -5 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 5 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.74 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 6.97 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.91 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.24 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 0 B
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.59 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.21 kB 0 B
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB 0 B
./frontend/.nuxt/dist/client/pages/search/audio.js 3.5 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.38 kB 0 B
./frontend/.nuxt/dist/client/pages/search/image.js 546 B 0 B
./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 0 B
./frontend/.nuxt/dist/client/runtime.js 2.71 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.72 kB 0 B

compressed-size-action

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.

If we want to debounce this it should be added here, otherwise there will be a time span where the event happens far more often than otherwise, making it harder to understand the rate of the event being sent per session.

However, if we debounced it, what would we send? In debouncing, would we still send individual events per filter value changed? In that case, don't bother debouncing. We only debounce the filter changes being sent to search to prevent unnecessary search requests. If we debounced and combine all the updated filters into a single event, that might be worth it, but would slightly change the way this event would be queried. It would probably warrant a slightly different API to make it easier to tell both what filters are applied and how often a particular filter is applied then unapplied (which might imply the filter isn't as useful as others).

@obulat obulat mentioned this pull request Jun 19, 2023
26 tasks
@obulat obulat force-pushed the add/APPLY_FILTER_event branch from 830c504 to 5e3757f Compare June 20, 2023 09:41
@zackkrida
Copy link
Member

Olga and I chatted a bit yesterday and we concluded we should try without debouncing these. The only reason to debounce would be perceived performance for the user or performance of the /api/event endpoint and we don't suspect either of those will be an issue here.

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.

This works perfectly. However, I think we're missing a property for if the filter is being enabled or disabled in the payload. This was the original intention of the "value" property, but the way it's implemented here makes sense to me so I think we just need an additional property.

@obulat obulat force-pushed the add/APPLY_FILTER_event branch from 5e3757f to 9ba0f8c Compare June 21, 2023 09:25
@obulat obulat requested a review from zackkrida June 21, 2023 16:15
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! Works well.

@obulat obulat merged commit c93d8ab into main Jun 21, 2023
@obulat obulat deleted the add/APPLY_FILTER_event branch June 21, 2023 23:20
@sarayourfriend sarayourfriend mentioned this pull request Jun 26, 2023
8 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: APPLY_FILTER
5 participants