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

Remove duplicated plausible props #2578

Merged
merged 4 commits into from
Jul 11, 2023
Merged

Remove duplicated plausible props #2578

merged 4 commits into from
Jul 11, 2023

Conversation

zackkrida
Copy link
Member

Fixes

Fixes #2534 by @sarayourfriend

Description

Removes custom props added as defaults to all plausible events in favor of corresponding default values already provided by plausible.

Testing Instructions

Read the issue and make sure the removed events are correct. All tests should pass.

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 July 6, 2023 18:36
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Jul 6, 2023
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: analytics Related to the analytics setup labels Jul 6, 2023
@github-actions
Copy link

github-actions bot commented Jul 6, 2023

Size Change: -165 B (0%)

Total Size: 832 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 121 kB -235 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 113 kB -264 B (0%)
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB +12 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.8 kB +13 B (+1%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.77 kB +11 B (+1%)
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.1 kB +16 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.1 kB +20 B (0%)
./frontend/.nuxt/dist/client/pages/about.js 1.41 kB +17 B (+1%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB +22 B (+2%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.35 kB +19 B (+1%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB +19 B (+1%)
./frontend/.nuxt/dist/client/pages/index.js 7 kB +12 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.94 kB +21 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB +20 B (+2%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.32 kB +18 B (+1%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.25 kB +17 B (+1%)
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.26 kB +17 B (+1%)
./frontend/.nuxt/dist/client/pages/search-help.js 1.62 kB +20 B (+1%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.61 kB +22 B (+1%)
./frontend/.nuxt/dist/client/pages/search.js 2.26 kB +10 B (0%)
./frontend/.nuxt/dist/client/pages/sources.js 1.53 kB +21 B (+1%)
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB +23 B (+2%)
./frontend/.nuxt/dist/client/vendors/app.js 65.3 kB -91 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 64.8 kB +50 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/232.js 272 B 0 B
./frontend/.nuxt/dist/client/232.modern.js 276 B 0 B
./frontend/.nuxt/dist/client/233.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/commons/app.modern.js 80.7 kB -9 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 -1 B (0%)
./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 6.42 kB 0 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 6.26 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 571 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 573 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 1.79 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB -1 B (0%)
./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.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.23 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 634 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 643 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 -1 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.25 kB +1 B (0%)
./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 531 B +7 B (+1%)
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 535 B +9 B (+2%)
./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 +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.79 kB -1 B (0%)
./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 +1 B (0%)
./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 +2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB +1 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 0 B
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.56 kB +2 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 2 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.98 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 -1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.57 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.54 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 -1 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.88 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.44 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.28 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.16 kB 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B -1 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 1.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 1.07 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 931 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 939 B -2 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.94 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 kB +1 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 855 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-audio.js 1.47 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.47 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 -2 B (0%)
./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 7 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.35 kB +2 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 620 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 302 B 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 913 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.06 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/audio/_id/index.js 6.78 kB +7 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.54 kB +4 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.27 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 7.04 kB +1 B (0%)
./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 -3 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.05 kB +7 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 4.12 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.97 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.js 546 B 0 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 547 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 240 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 244 B 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

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.

LGTM, just one note about the ESLint rule.

frontend/src/composables/use-analytics.ts Outdated Show resolved Hide resolved
@zackkrida zackkrida marked this pull request as draft July 7, 2023 12:57
@zackkrida zackkrida marked this pull request as ready for review July 7, 2023 14:58
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!

I realised when re-reviewing that language could be derived from the built-in page, as we can derive the locale from locale prefix (or en if there isn't one). It's probably easier to query along those lines too because you can't combine custom prop filters to see, for example, if a "load more" events on image queries happen less for users of the RTL version of the site than LTR, because you couldn't query against both mediaType and language. However, you can filter page using wildcards, so you could filter, for example, event:page=/ar*&event:name=LOAD_MORE_RESULTS&event:props:mediaType=image to grab the event when it happened on the Arabic version of the site.

Anyway, not a blocker, but if you think it's worth removing and adding documentation to this effect somewhere, another issue would be good.

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.

It would be helpful to have some comment pointing to the Plausible docs listing the default params they provide.

LGTM otherwise.

@zackkrida
Copy link
Member Author

It would be helpful to have some comment pointing to the Plausible docs listing the default params they provide.

I can't find anything relating to this from Plausible! I'll ask them and create a new issue.

@zackkrida zackkrida merged commit 53c2e70 into main Jul 11, 2023
41 checks passed
@zackkrida zackkrida deleted the dedupe-plausible-props branch July 11, 2023 19:26
@sarayourfriend
Copy link
Collaborator

I can't find anything relating to this from Plausible! I'll ask them and create a new issue.

All of this is documented here, isn't it? https://plausible.io/docs/stats-api#properties (Linked in the issue, by the way)

Timestamp is the only think missing, as far as I can tell, but you can't query against timestamps directly from Plausible's API.

@zackkrida
Copy link
Member Author

That's perfect, thanks!

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: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: analytics Related to the analytics setup 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Default plausible prop payloads overlap with built-in Plausible stats data
4 participants