Add surrogate entity metadata to tracker events

Author: cursoragent

injected/integration-test/tracker-protection.spec.js

@@ -56,6 +56,8 @@ test('tracker-protection: loads surrogate for matching rule', async ({ page }, t
     const injected = await collector.waitForMessage('surrogateInjected', 1);
     expect(injected[0].payload.params.url).toBe('https://tracker.example/scripts/analytics.js');
     expect(injected[0].payload.params.isSurrogate).toBe(true);
+    expect(injected[0].payload.params.entityName).toBe('Tracker Inc');
+    expect(injected[0].payload.params.ownerName).toBe('Tracker Inc');
 });
 
 test('tracker-protection: reports non-tracker third-party URL as thirdPartyRequest', async ({ page }, testInfo) => {

injected/src/features/tracker-protection.js

@@ -476,6 +476,8 @@ export class TrackerProtection extends ContentFeature {
                     reason: result.reason,
                     isSurrogate: true,
                     pageUrl: this._topLevelUrl?.href || '',
+                    entityName: result.entity?.displayName || result.tracker?.owner?.displayName || null,
+                    ownerName: result.tracker?.owner?.name || null,
                 });
             }
 

injected/src/messages/tracker-protection/surrogateInjected.notify.json

@@ -24,6 +24,14 @@
     "pageUrl": {
       "type": "string",
       "description": "The URL of the page where the tracker was detected"
+    },
+    "entityName": {
+      "type": ["string", "null"],
+      "description": "The display name of the tracker entity"
+    },
+    "ownerName": {
+      "type": ["string", "null"],
+      "description": "The owner name of the tracker"
     }
   }
 }

injected/src/types/tracker-protection.ts

@@ -43,6 +43,14 @@ export interface SurrogateInjected {
    * The URL of the page where the tracker was detected
    */
   pageUrl: string;
+  /**
+   * The display name of the tracker entity
+   */
+  entityName?: string | null;
+  /**
+   * The owner name of the tracker
+   */
+  ownerName?: string | null;
 }
 /**
  * Generated from @see "../messages/tracker-protection/trackerDetected.notify.json"