Analytics event: REPORT_MEDIA #1181

obulat · 2023-04-12T14:41:47Z

Fixes

Description

This PR adds REPORT_MEDIA analytics event.

The DMCA report uses an external form, and there is no way of getting the actual "report submitted" event programmatically from the app (we can, of course, create some automation for the Google form submission, but that is outside of scope for this PR). I decided to send the event when the user clicks on the "Open form" button for the DMCA report.

The RFC did not contain the reason property for the event even though it was mentioned in the docstrings. Do we want to update the RFC, @dhruvkb, or is implementing it here enough?

Testing Instructions

Set up the analytics by running just frontend/init.
Run the app using just frontend/run dev.
If you click on "Report content" on the single result page, you should see the event in Plausible: http://0.0.0.0:50288/localhost?goal=REPORT_MEDIA

Checklist

My pull request has a descriptive title (not a vague title like
Update 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.

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.

github-actions · 2023-04-12T14:47:02Z

Size Change: +6.34 kB (+1%)

Total Size: 859 kB

Filename	Size	Change
`./frontend/.nuxt/dist/client/234.js`	0 B	-272 B (removed)	🏆
`./frontend/.nuxt/dist/client/234.modern.js`	0 B	-277 B (removed)	🏆
`./frontend/.nuxt/dist/client/235.js`	273 B	-1.58 kB (-85%)	🏆
`./frontend/.nuxt/dist/client/components/v-audio-details.js`	3.06 kB	+576 B (+23%)	🚨
`./frontend/.nuxt/dist/client/components/v-audio-details.modern.js`	2.33 kB	+557 B (+31%)	🚨
`./frontend/.nuxt/dist/client/components/v-content-report-form.js`	778 B	-3 kB (-79%)	🏆
`./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js`	4.07 kB	+479 B (+13%)	⚠️
`./frontend/.nuxt/dist/client/components/v-content-report-popover.js`	1.77 kB	+600 B (+51%)	🆘
`./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js`	756 B	-3.43 kB (-82%)	🏆
`./frontend/.nuxt/dist/client/components/v-dmca-notice.js`	792 B	+39 B (+5%)	🔍
`./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js`	799 B	+40 B (+5%)	🔍
`./frontend/.nuxt/dist/client/components/v-image-details.js`	2.66 kB	+576 B (+28%)	🚨
`./frontend/.nuxt/dist/client/components/v-image-details.modern.js`	1.96 kB	+548 B (+39%)	🚨
`./frontend/.nuxt/dist/client/pages/image/_id/report.js`	1.85 kB	+577 B (+45%)	🚨
`./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js`	4.75 kB	+483 B (+11%)	⚠️
`./frontend/.nuxt/dist/client/runtime.js`	2.75 kB	+26 B (+1%)
`./frontend/.nuxt/dist/client/runtime.modern.js`	2.75 kB	+27 B (+1%)
`./frontend/.nuxt/dist/client/235.modern.js`	278 B	+278 B (new file)	🆕
`./frontend/.nuxt/dist/client/236.js`	1.85 kB	+1.85 kB (new file)	🆕
`./frontend/.nuxt/dist/client/components/v-audio-details/components/v-content-report-form/components/v-content-report-popover/comp/e356c88c.js`	3.89 kB	+3.89 kB (new file)	🆕
`./frontend/.nuxt/dist/client/components/v-audio-details/components/v-content-report-popover/components/v-image-details/pages/audi/7832d35f.modern.js`	4.32 kB	+4.32 kB (new file)	🆕

ℹ️ View Unchanged

Filename	Size	Change
`./frontend/.nuxt/dist/client/app.js`	127 kB	+2 B (0%)
`./frontend/.nuxt/dist/client/app.modern.js`	118 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/commons/app.js`	90.3 kB	0 B
`./frontend/.nuxt/dist/client/commons/app.modern.js`	78.5 kB	0 B
`./frontend/.nuxt/dist/client/components/loading-icon.js`	752 B	0 B
`./frontend/.nuxt/dist/client/components/loading-icon.modern.js`	758 B	0 B
`./frontend/.nuxt/dist/client/components/table-sort-icon.js`	515 B	0 B
`./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js`	518 B	0 B
`./frontend/.nuxt/dist/client/components/v-all-results-grid.js`	5.65 kB	0 B
`./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js`	5.49 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-audio-cell.js`	393 B	0 B
`./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js`	396 B	0 B
`./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js`	1.02 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.6 kB	+3 B (0%)
`./frontend/.nuxt/dist/client/components/v-audio-track.modern.js`	5.54 kB	+2 B (0%)
`./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js`	543 B	0 B
`./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js`	548 B	0 B
`./frontend/.nuxt/dist/client/components/v-bone.js`	689 B	0 B
`./frontend/.nuxt/dist/client/components/v-bone.modern.js`	693 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.28 kB	0 B
`./frontend/.nuxt/dist/client/components/v-content-link.js`	1.12 kB	0 B
`./frontend/.nuxt/dist/client/components/v-content-link.modern.js`	1.1 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`	528 B	0 B
`./frontend/.nuxt/dist/client/components/v-content-report-button.js`	784 B	0 B
`./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js`	787 B	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`	1.71 kB	0 B
`./frontend/.nuxt/dist/client/components/v-copy-license.modern.js`	1.69 kB	+2 B (0%)
`./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.js`	10 kB	-2 B (0%)
`./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js`	9.99 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-error-image.js`	1.7 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-error-image.modern.js`	1.69 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`	377 B	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-external-search-form.js`	1.86 kB	0 B
`./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js`	1.85 kB	0 B
`./frontend/.nuxt/dist/client/components/v-external-source-list.js`	843 B	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js`	845 B	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-full-layout.js`	2.13 kB	+4 B (0%)
`./frontend/.nuxt/dist/client/components/v-full-layout.modern.js`	2.11 kB	+3 B (0%)
`./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	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-home-gallery.js`	5.27 kB	+2 B (0%)
`./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js`	5.25 kB	0 B
`./frontend/.nuxt/dist/client/components/v-homepage-content.js`	1.76 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js`	1.73 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-carousel.js`	4.73 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js`	4.71 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-cell.js`	1.59 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-cell.modern.js`	1.59 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-grid.js`	2.67 kB	0 B
`./frontend/.nuxt/dist/client/components/v-image-grid.modern.js`	2.55 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-license-tab-panel.js`	1.24 kB	+4 B (0%)
`./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js`	1.21 kB	+3 B (0%)
`./frontend/.nuxt/dist/client/components/v-load-more.js`	809 B	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-load-more.modern.js`	709 B	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-media-license.js`	829 B	0 B
`./frontend/.nuxt/dist/client/components/v-media-license.modern.js`	837 B	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-media-reuse.js`	2.31 kB	+3 B (0%)
`./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js`	2.29 kB	+2 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`	419 B	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-modal.js`	1.01 kB	0 B
`./frontend/.nuxt/dist/client/components/v-modal.modern.js`	996 B	0 B
`./frontend/.nuxt/dist/client/components/v-no-results.js`	757 B	0 B
`./frontend/.nuxt/dist/client/components/v-no-results.modern.js`	755 B	0 B
`./frontend/.nuxt/dist/client/components/v-radio.js`	1.54 kB	0 B
`./frontend/.nuxt/dist/client/components/v-radio.modern.js`	1.51 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-related-audio.js`	1.26 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/components/v-related-audio.modern.js`	1.27 kB	0 B
`./frontend/.nuxt/dist/client/components/v-related-images.js`	3.24 kB	0 B
`./frontend/.nuxt/dist/client/components/v-related-images.modern.js`	3.13 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`	980 B	0 B
`./frontend/.nuxt/dist/client/components/v-row-layout.js`	1.67 kB	-1 B (0%)
`./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`	5.68 kB	0 B
`./frontend/.nuxt/dist/client/components/v-search-grid.modern.js`	5.61 kB	0 B
`./frontend/.nuxt/dist/client/components/v-search-results-title.js`	599 B	0 B
`./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js`	605 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.01 kB	+1 B (0%)
`./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.16 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/components/v-sources-table.js`	15.1 kB	0 B
`./frontend/.nuxt/dist/client/components/v-sources-table.modern.js`	15.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	+1 B (0%)
`./frontend/.nuxt/dist/client/pages/audio/_id/index.js`	5.66 kB	-4 B (0%)
`./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js`	4.96 kB	-2 B (0%)
`./frontend/.nuxt/dist/client/pages/external-sources.js`	1.56 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	+1 B (0%)
`./frontend/.nuxt/dist/client/pages/feedback.modern.js`	1.34 kB	+2 B (0%)
`./frontend/.nuxt/dist/client/pages/image/_id/index.js`	6.67 kB	+3 B (0%)
`./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js`	5.85 kB	+4 B (0%)
`./frontend/.nuxt/dist/client/pages/index.js`	7.34 kB	+3 B (0%)
`./frontend/.nuxt/dist/client/pages/index.modern.js`	7.28 kB	+3 B (0%)
`./frontend/.nuxt/dist/client/pages/preferences.js`	1.32 kB	0 B
`./frontend/.nuxt/dist/client/pages/preferences.modern.js`	1.32 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/privacy.js`	1.01 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/pages/privacy.modern.js`	1.02 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/pages/search-help.js`	1.6 kB	0 B
`./frontend/.nuxt/dist/client/pages/search-help.modern.js`	1.58 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/search.js`	2.2 kB	0 B
`./frontend/.nuxt/dist/client/pages/search.modern.js`	2.04 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/search/audio.js`	3.61 kB	0 B
`./frontend/.nuxt/dist/client/pages/search/audio.modern.js`	3.52 kB	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/search/image.js`	2.84 kB	0 B
`./frontend/.nuxt/dist/client/pages/search/image.modern.js`	2.74 kB	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	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`	270 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	-1 B (0%)
`./frontend/.nuxt/dist/client/pages/sources.js`	1.52 kB	0 B
`./frontend/.nuxt/dist/client/pages/sources.modern.js`	1.52 kB	+1 B (0%)
`./frontend/.nuxt/dist/client/vendors/app.js`	64.1 kB	0 B
`./frontend/.nuxt/dist/client/vendors/app.modern.js`	63.3 kB	0 B

_{compressed-size-action}

github-actions · 2023-04-12T14:53:41Z

Full-stack documentation: https://docs.openverse.org/_preview/1181

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

zackkrida

Working correctly for all report types.

However, should we also add the DMCA event when users click on the "DMCA form" text which also links to the form?

obulat · 2023-04-14T06:06:18Z

However, should we also add the DMCA event when users click on the "DMCA form" text which also links to the form?

Sure, great catch! I'll add this.

obulat requested a review from a team as a code owner April 12, 2023 14:41

obulat requested review from zackkrida and dhruvkb April 12, 2023 14:41

obulat 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 Apr 12, 2023

zackkrida approved these changes Apr 12, 2023

View reviewed changes

obulat force-pushed the add/REPORT_MEDIA_event branch 2 times, most recently from 40699fa to cdf7908 Compare April 16, 2023 05:36

obulat requested review from a team as code owners April 16, 2023 05:36

github-actions bot added 🧱 stack: api Related to the Django API 🧱 stack: ingestion server Related to the ingestion/data refresh server labels Apr 16, 2023

obulat changed the base branch from main_old to main April 16, 2023 05:42

obulat removed request for a team April 16, 2023 05:42

obulat removed 🧱 stack: api Related to the Django API 🧱 stack: ingestion server Related to the ingestion/data refresh server labels Apr 16, 2023

WordPress deleted a comment from github-actions bot Apr 16, 2023

obulat force-pushed the add/REPORT_MEDIA_event branch from cdf7908 to 5be593b Compare April 20, 2023 05:47

obulat added 2 commits April 20, 2023 17:49

Add REPORT_MEDIA event

850da4d

Handle the DMCA link in the same way as "Open form"

1a1da4f

obulat force-pushed the add/REPORT_MEDIA_event branch from 5be593b to 1a1da4f Compare April 20, 2023 14:49

dhruvkb approved these changes Apr 26, 2023

View reviewed changes

obulat merged commit 8e5ee35 into main Apr 27, 2023

obulat deleted the add/REPORT_MEDIA_event branch April 27, 2023 04:58

dhruvkb mentioned this pull request Jun 16, 2023

Usage Analytics #394

Closed

26 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Analytics event: REPORT_MEDIA #1181

Analytics event: REPORT_MEDIA #1181

obulat commented Apr 12, 2023 •

edited

Loading

github-actions bot commented Apr 12, 2023 •

edited

Loading

github-actions bot commented Apr 12, 2023

zackkrida left a comment

obulat commented Apr 14, 2023

Analytics event: REPORT_MEDIA #1181

Analytics event: REPORT_MEDIA #1181

Conversation

obulat commented Apr 12, 2023 • edited Loading

Fixes

Description

Testing Instructions

Checklist

Developer Certificate of Origin

github-actions bot commented Apr 12, 2023 • edited Loading

github-actions bot commented Apr 12, 2023

zackkrida left a comment

Choose a reason for hiding this comment

obulat commented Apr 14, 2023

obulat commented Apr 12, 2023 •

edited

Loading

github-actions bot commented Apr 12, 2023 •

edited

Loading