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 TOGGLE_FILTER_SIDEBAR analytics event #2405

Merged
merged 8 commits into from
Jun 27, 2023

Conversation

zackkrida
Copy link
Member

Fixes

Fixes #1088 by @dhruvkb

Description

Adds an event for toggling the desktop filter sidebar. I renamed the event to TOGGLE_FILTER_SIDEBAR to better accurately reflect it's behavior. As the original author of the proposal, my intention of this event was to track the desktop sidebar specifically as it's a piece of potentially persistent UI a user may choose to keep open at all times.

Testing Instructions

Toggle the filter sidebar on different media type search views. Observe that the state of the filter sidebar is accurately reported in the event in the logs.

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 June 14, 2023 21:54
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Jun 14, 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 14, 2023
@github-actions
Copy link

github-actions bot commented Jun 14, 2023

Size Change: +121 B (0%)

Total Size: 840 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 122 kB +61 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 114 kB +60 B (0%)
ℹ️ View Unchanged
Filename Size
./frontend/.nuxt/dist/client/234.js 272 B
./frontend/.nuxt/dist/client/234.modern.js 277 B
./frontend/.nuxt/dist/client/235.js 1.85 kB
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB
./frontend/.nuxt/dist/client/commons/app.modern.js 80.8 kB
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.18 kB
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.62 kB
./frontend/.nuxt/dist/client/components/loading-icon.js 728 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 732 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.76 kB
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.64 kB
./frontend/.nuxt/dist/client/components/v-audio-cell.js 571 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 573 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 1.76 kB
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.74 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 958 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 962 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.32 kB
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.27 kB
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 634 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 644 B
./frontend/.nuxt/dist/client/components/v-bone.js 632 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 636 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.26 kB
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.25 kB
./frontend/.nuxt/dist/client/components/v-content-link.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 526 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 491 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 497 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.33 kB
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.21 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.8 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.67 kB
./frontend/.nuxt/dist/client/components/v-copy-button.js 3.99 kB
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.28 kB
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 792 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.6 kB
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.56 kB
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 376 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.89 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.88 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.js 893 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 897 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.57 kB
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.57 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.53 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.54 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.89 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.88 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.77 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.74 kB
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.7 kB
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.66 kB
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.81 kB
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.81 kB
./frontend/.nuxt/dist/client/components/v-image-details.js 1.42 kB
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB
./frontend/.nuxt/dist/client/components/v-image-grid.js 3.98 kB
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.87 kB
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 648 B
./frontend/.nuxt/dist/client/components/v-load-more.js 844 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 743 B
./frontend/.nuxt/dist/client/components/v-media-license.js 932 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 940 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.93 kB
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 kB
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 B
./frontend/.nuxt/dist/client/components/v-modal.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-modal.modern.js 995 B
./frontend/.nuxt/dist/client/components/v-no-results.js 854 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 857 B
./frontend/.nuxt/dist/client/components/v-radio.js 1 kB
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.42 kB
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.42 kB
./frontend/.nuxt/dist/client/components/v-related-images.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 976 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.65 kB
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.65 kB
./frontend/.nuxt/dist/client/components/v-scroll-button.js 891 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 892 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.89 kB
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.24 kB
./frontend/.nuxt/dist/client/components/v-search-results-title.js 618 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 300 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 915 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.2 kB
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.2 kB
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B
./frontend/.nuxt/dist/client/pages/about.js 1.4 kB
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.33 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.12 kB
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.55 kB
./frontend/.nuxt/dist/client/pages/feedback.js 1.33 kB
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.24 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.99 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.js 5 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.74 kB
./frontend/.nuxt/dist/client/pages/index.js 6.97 kB
./frontend/.nuxt/dist/client/pages/index.modern.js 6.91 kB
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB
./frontend/.nuxt/dist/client/pages/privacy.js 1.24 kB
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.24 kB
./frontend/.nuxt/dist/client/pages/search-help.js 1.6 kB
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.59 kB
./frontend/.nuxt/dist/client/pages/search.js 2.21 kB
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB
./frontend/.nuxt/dist/client/pages/search/audio.js 3.5 kB
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.38 kB
./frontend/.nuxt/dist/client/pages/search/image.js 546 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 549 B
./frontend/.nuxt/dist/client/pages/search/index.js 442 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B
./frontend/.nuxt/dist/client/pages/search/video.js 239 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B
./frontend/.nuxt/dist/client/pages/sources.js 1.51 kB
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.52 kB
./frontend/.nuxt/dist/client/runtime.js 2.71 kB
./frontend/.nuxt/dist/client/runtime.modern.js 2.72 kB
./frontend/.nuxt/dist/client/vendors/app.js 65.3 kB
./frontend/.nuxt/dist/client/vendors/app.modern.js 64.4 kB

compressed-size-action

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.

Are there any new tests which should be added for this change?

@zackkrida
Copy link
Member Author

Drafting while updates are made.

@zackkrida zackkrida marked this pull request as draft June 16, 2023 13:04
@zackkrida zackkrida marked this pull request as ready for review June 19, 2023 15:56
@zackkrida zackkrida requested a review from obulat June 19, 2023 15:56
@zackkrida
Copy link
Member Author

@obulat and @AetherUnbound this is ready for review. The type signature of the event was fixed and I've added a unit test.

@zackkrida zackkrida requested a review from obulat June 19, 2023 17:05
@zackkrida
Copy link
Member Author

@obulat suggestions made; thanks!

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.

Tested locally, and all works well 🚀

@zackkrida zackkrida requested a review from AetherUnbound June 19, 2023 17:41
@obulat obulat mentioned this pull request Jun 19, 2023
26 tasks
@obulat obulat requested a review from dhruvkb June 21, 2023 08:37
@openverse-bot
Copy link
Collaborator

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

@AetherUnbound
@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 medium urgency are expected to be reviewed within 4 weekday(s)2.

@zackkrida, 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

@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 verified locally that it fires off appropriately!

@zackkrida zackkrida merged commit 233580d into main Jun 27, 2023
@zackkrida zackkrida deleted the fix-#1088-add-TOGGLE_FILTERS-event branch June 27, 2023 15:40
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: TOGGLE_FILTERS
4 participants