Merge pull request #134 from mozilla-rally/port-beyond-the-paywall-me…

…asurements Port advertising and article-contents modules from "Beyond the Paywall".
mozilla-rally · Aug 4, 2022 · 9fcbc65 · 9fcbc65
2 parents 5add7f3 + a56259a
commit 9fcbc65
Show file tree

Hide file tree

Showing 12 changed files with 12,554 additions and 28,649 deletions.
diff --git a/common/config/rush/npm-shrinkwrap.json b/common/config/rush/npm-shrinkwrap.json
diff --git a/extensions/attention-stream/docs/metrics.md b/extensions/attention-stream/docs/metrics.md
@@ -8,11 +8,59 @@ This means you might have to go searching through the dependency tree to get a f
 
 # Pings
 
+- [advertisements](#advertisements)
+- [article-contents](#article-contents)
 - [deletion-request](#deletion-request)
 - [events](#events)
 - [study-enrollment](#study-enrollment)
 - [user-journey](#user-journey)
 
+## advertisements
+
+Metadata about any detected advertisements
+
+**Data reviews for this ping:**
+
+- <https://bugzilla.mozilla.org/show_bug.cgi?id=1778367>
+
+**Bugs related to this ping:**
+
+- <https://bugzilla.mozilla.org/show_bug.cgi?id=1778196>
+
+All Glean pings contain built-in metrics in the [`ping_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-ping_info-section) and [`client_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-client_info-section) sections.
+
+In addition to those built-in metrics, the following metrics are added to the ping:
+
+| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
+| --- | --- | --- | --- | --- | --- | --- |
+| advertisements.ads |[text](https://mozilla.github.io/glean/book/user/metrics/text.html) |Metadata about any ads on this page  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+| advertisements.body |[text](https://mozilla.github.io/glean/book/user/metrics/text.html) |Body of the current page  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+| advertisements.page_id |[uuid](https://mozilla.github.io/glean/book/user/metrics/uuid.html) |A unique ID for this visit  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+| advertisements.url |[url](https://mozilla.github.io/glean/book/user/metrics/url.html) |URL for the current page  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+
+## article-contents
+
+Article contents
+
+**Data reviews for this ping:**
+
+- <https://bugzilla.mozilla.org/show_bug.cgi?id=1778367>
+
+**Bugs related to this ping:**
+
+- <https://bugzilla.mozilla.org/show_bug.cgi?id=1778196>
+
+All Glean pings contain built-in metrics in the [`ping_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-ping_info-section) and [`client_info`](https://mozilla.github.io/glean/book/user/pings/index.html#the-client_info-section) sections.
+
+In addition to those built-in metrics, the following metrics are added to the ping:
+
+| Name | Type | Description | Data reviews | Extras | Expiration | [Data Sensitivity](https://wiki.mozilla.org/Firefox/Data_Collection) |
+| --- | --- | --- | --- | --- | --- | --- |
+| article_contents.page_id |[uuid](https://mozilla.github.io/glean/book/user/metrics/uuid.html) |A unique ID for this visit  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+| article_contents.text_content |[text](https://mozilla.github.io/glean/book/user/metrics/text.html) |Contents of current page  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+| article_contents.title |[string](https://mozilla.github.io/glean/book/user/metrics/string.html) |Title of the current page  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+| article_contents.url |[url](https://mozilla.github.io/glean/book/user/metrics/url.html) |URL for the current page  |[Bug 1778367](https://bugzilla.mozilla.org/show_bug.cgi?id=1778367)||never | |
+
 ## deletion-request
 
 This is a built-in ping that is assembled out of the box by the Glean SDK.

diff --git a/extensions/attention-stream/manifest.dev.json b/extensions/attention-stream/manifest.dev.json
@@ -3,7 +3,7 @@
   "author": "Mozilla",
   "manifest_version": 3,
   "name": "Rally Attention Stream",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "homepage_url": "https://github.com/mozilla/rally",
   "browser_specific_settings": {
     "gecko": {
@@ -23,9 +23,10 @@
     "webNavigation",
     "webRequest",
     "storage",
-    "unlimitedStorage"
+    "unlimitedStorage",
+    "scripting"
   ],
-  "host_permissions:": [
+  "host_permissions": [
     "<all_urls>"
   ],
   "content_scripts": [
@@ -37,16 +38,6 @@
       "js": [
         "dist/main.content.js"
       ]
-    },
-    {
-      "matches": [
-        "<all_urls>"
-      ],
-      "js": [
-        "dist/browser-polyfill.min.js",
-        "dist/webScience/pageManager.content.js",
-        "dist/webScience/pageNavigation.content.js"
-      ]
     }
   ],
   "action": {
@@ -56,4 +47,4 @@
     "service_worker": "dist/background-loader.js"
   },
   "incognito": "not_allowed"
-}
+}
diff --git a/extensions/attention-stream/manifest.prod.json b/extensions/attention-stream/manifest.prod.json
@@ -3,7 +3,7 @@
   "author": "Mozilla",
   "manifest_version": 3,
   "name": "Rally Attention Stream",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "homepage_url": "https://github.com/mozilla/rally",
   "browser_specific_settings": {
     "gecko": {
@@ -20,9 +20,10 @@
     "webNavigation",
     "webRequest",
     "storage",
-    "unlimitedStorage"
+    "unlimitedStorage",
+    "scripting"
   ],
-  "host_permissions:": [
+  "host_permissions": [
     "<all_urls>"
   ],
   "content_scripts": [
@@ -34,16 +35,6 @@
       "js": [
         "dist/main.content.js"
       ]
-    },
-    {
-      "matches": [
-        "<all_urls>"
-      ],
-      "js": [
-        "dist/browser-polyfill.min.js",
-        "dist/webScience/pageManager.content.js",
-        "dist/webScience/pageNavigation.content.js"
-      ]
     }
   ],
   "background": {

diff --git a/extensions/attention-stream/metrics.yaml b/extensions/attention-stream/metrics.yaml
@@ -182,3 +182,125 @@ user_journey:
     notification_emails:
       - [email protected]
     expires: never
+
+article_contents:
+  page_id:
+    type: uuid
+    description: |
+      A unique ID for this visit
+    lifetime: ping
+    send_in_pings:
+      - article-contents
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never
+
+  url:
+    type: url
+    description: |
+      URL for the current page
+    lifetime: ping
+    send_in_pings:
+      - article-contents
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never
+
+  title:
+    type: string
+    description: |
+      Title of the current page
+    lifetime: ping
+    send_in_pings:
+      - article-contents
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never
+
+  text_content:
+    type: text
+    description: |
+      Contents of current page
+    lifetime: ping
+    send_in_pings:
+      - article-contents
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never
+
+advertisements:
+  page_id:
+    type: uuid
+    description: |
+      A unique ID for this visit
+    lifetime: ping
+    send_in_pings:
+      - advertisements
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never
+
+  url:
+    type: url
+    description: |
+      URL for the current page
+    lifetime: ping
+    send_in_pings:
+      - advertisements
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never
+
+  body:
+    type: text
+    description: |
+      Body of the current page
+    lifetime: ping
+    send_in_pings:
+      - advertisements
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never
+
+  ads:
+    type: text
+    description: |
+      Metadata about any ads on this page
+    lifetime: ping
+    send_in_pings:
+      - advertisements
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778196
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1778367
+    notification_emails:
+      - [email protected]
+    expires: never