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: LOAD_MORE_RESULTS #2449

Merged
merged 12 commits into from
Jul 3, 2023
Merged

Analytics Event: LOAD_MORE_RESULTS #2449

merged 12 commits into from
Jul 3, 2023

Conversation

zackkrida
Copy link
Member

@zackkrida zackkrida commented Jun 19, 2023

Fixes

Fixes #1074 by @dhruvkb
Fixes #1992 by @sarayourfriend

Description

This PR adds a LOAD_MORE_RESULTS analytics event to the load more button. Crucially, I did not include the original page number property in the event payload, as it requires major additions to the media and search stores. Thanks, @obulat.

Testing Instructions

CI should pass, and then review the code. Let me know what you think of this API surface! Should we even be testing analytics events in e2e tests? I suspect it could be a nice additional assurance. If so we might want to add it in other places, like for pageviews and other custom events. That gets into larger issues about our frontend test consistency and coverage though.

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

github-actions bot commented Jun 19, 2023

Size Change: +242 B (0%)

Total Size: 843 kB

Filename Size Change
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 6.11 kB +35 B (+1%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.96 kB +32 B (+1%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.29 kB +33 B (+1%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.16 kB +28 B (+1%)
./frontend/.nuxt/dist/client/components/v-load-more.js 1.17 kB +31 B (+3%)
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 1.07 kB +31 B (+3%)
./frontend/.nuxt/dist/client/pages/search/audio.js 3.82 kB +27 B (+1%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.69 kB +29 B (+1%)
ℹ️ 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/app.js 122 kB 0 B
./frontend/.nuxt/dist/client/app.modern.js 114 kB 0 B
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB 0 B
./frontend/.nuxt/dist/client/commons/app.modern.js 80.8 kB 0 B
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.18 kB 0 B
./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-audio-cell.js 572 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 572 B 0 B
./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 0 B
./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 635 B 0 B
./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 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 0 B
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.05 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 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 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 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB 0 B
./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 0 B
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.56 kB 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 894 B 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 896 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.53 kB 0 B
./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.87 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 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.8 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 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 647 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 933 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 939 B 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.93 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 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-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 856 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 856 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-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 0 B
./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 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 892 B 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.89 kB 0 B
./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 0 B
./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 0 B
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.12 kB 0 B
./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 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.js 5 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.74 kB 0 B
./frontend/.nuxt/dist/client/pages/index.js 6.97 kB 0 B
./frontend/.nuxt/dist/client/pages/index.modern.js 6.91 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB -3 B (0%)
./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.25 kB 0 B
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 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
./frontend/.nuxt/dist/client/vendors/app.js 65.4 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.modern.js 64.5 kB 0 B

compressed-size-action

@zackkrida
Copy link
Member Author

I just remembered @obulat added some Playwright analytics testing previously:

https://github.com/WordPress/openverse/blob/9471728b4686d054493cd4528554e957dfee4350/frontend/test/playwright/e2e/external-sources.spec.ts

I'll try updating that implementation to use this new code, which would be a good way to validate its usefulness!

This was referenced Jun 19, 2023
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.

I think this PR can use the currentPage changes from #2454, and #2454 should use the excellent testing utilities for e2e tests :)

@sarayourfriend
Copy link
Collaborator

sarayourfriend commented Jun 22, 2023

how many times in a session a user + query + mediaType

Can you clarify how this would work? Plausible only allows querying by a single custom prop at a time (see the note here). We could work around that by combining the media type and query into a single prop. The media type is critical information for all queries anyway.

@obulat
Copy link
Contributor

obulat commented Jun 23, 2023

how many times in a session a user + query + mediaType

Can you clarify how this would work? Plausible only allows querying by a single custom prop at a time (see the note here). We could work around that by combining the media type and query into a single prop. The media type is critical information for all queries anyway.

I've added the currentPage to the media store in REACH_RESULT_END event PR, and the plan is to add that in here, too. So we won't need the workaround anymore.

@sarayourfriend
Copy link
Collaborator

@zackkrida According to @obulat's comment, I suppose this needs to be rebased now that #2454 is merged before it can be reviewed?

@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
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 6 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.

@zackkrida zackkrida marked this pull request as draft June 28, 2023 13:43
@zackkrida
Copy link
Member Author

Drafting to implement the currentPage functionality merged in #2454

@zackkrida zackkrida changed the title Add LOAD_MORE_RESULTS analytics event + Playwright helpers for analytics events Analytics Event: LOAD_MORE_RESULTS Jun 30, 2023
@zackkrida zackkrida marked this pull request as ready for review June 30, 2023 23:02
@zackkrida zackkrida requested a review from obulat June 30, 2023 23:18
@zackkrida
Copy link
Member Author

@AetherUnbound and @obulat I've added the currentPage logic and this PR is ready for review.

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.

This worked as expected! One comment about tests but otherwise this is good to go :)

frontend/test/playwright/e2e/load-more.spec.ts Outdated Show resolved Hide resolved
@zackkrida zackkrida requested a review from dhruvkb June 30, 2023 23:39
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 just fine locally 👍

@zackkrida zackkrida merged commit c40b5e2 into main Jul 3, 2023
@zackkrida zackkrida deleted the fix-#1074 branch July 3, 2023 12:30
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.

Add a Playwright fixture that allows retrieving POST request parameters Analytics event: LOAD_MORE_RESULTS
5 participants