Merge pull request #341 from apasel422/user-clear

Add e2e tests for user-initiated data clears

Author: apasel422

api.bs

@@ -1338,7 +1338,7 @@ returning an [=epoch index=]:
 <div algorithm="clear browsing history for attribution">
 To <dfn>clear browsing history for attribution</dfn>,
 given a [=set=] of [=sites=] |sites|,
-a [=boolean=] |forgetVisits|,
+a [=boolean=] <dfn for="clear browsing history for attribution"><var>forgetVisits</var></dfn>,
 and a [=moment=] |now|:
 
 1.  If |forgetVisits| is false:
@@ -2947,7 +2947,7 @@ When clearing site data at the request of a [=user=],
 but retaining browsing history,
 a [=user agent=] invokes [=clear browsing history for attribution=],
 given the [=set=] of affected [=sites=],
-false (for |forgetVisits|),
+false (for [=clear browsing history for attribution/forgetVisits=]),
 and the time that the action was taken.
 This sets the privacy budget for that site to zero,
 preventing any use of conversion measurement on that site.
@@ -2975,7 +2975,7 @@ when removing browsing history.
 A user agent that clears browsing history
 invokes [=clear browsing history for attribution=],
 given the [=set=] of affected [=sites=],
-true (for |forgetVisits|),
+true (for [=clear browsing history for attribution/forgetVisits=]),
 and the time that the operation was initiated.
 
 When clearing browsing history,

impl/e2e-tests/clear-site-state.json

@@ -0,0 +1,51 @@
+{
+  "events": [
+    {
+      "seconds": 1,
+      "site": "a.example",
+      "event": "saveImpression",
+      "options": { "histogramIndex": 0 }
+    },
+    {
+      "seconds": 2,
+      "site": "advertiser-1.example",
+      "event": "measureConversion",
+      "options": {
+        "aggregationService": "https://agg-service.example",
+        "epsilon": 0.1,
+        "histogramSize": 1
+      },
+      "expected": [1]
+    },
+    {
+      "seconds": 3,
+      "event": "clearBrowsingHistoryForAttribution",
+      "sites": ["advertiser-1.example"],
+      "forgetVisits": false
+    },
+    {
+      "seconds": 4,
+      "site": "advertiser-1.example",
+      "event": "measureConversion",
+      "$comment": "re-run query, expecting budget to have been zeroed",
+      "options": {
+        "aggregationService": "https://agg-service.example",
+        "epsilon": 0.1,
+        "histogramSize": 1
+      },
+      "expected": [0]
+    },
+    {
+      "seconds": 5,
+      "site": "advertiser-2.example",
+      "$comment": "re-run query with different conversion site, expecting separate budget",
+      "event": "measureConversion",
+      "options": {
+        "aggregationService": "https://agg-service.example",
+        "epsilon": 0.1,
+        "histogramSize": 1
+      },
+      "expected": [1]
+    }
+  ]
+}

impl/e2e-tests/forget-one-site-conversions.json

@@ -0,0 +1,59 @@
+{
+  "$comment": "TODO: Add coverage for other epochs",
+  "events": [
+    {
+      "seconds": 1,
+      "site": "a.example",
+      "event": "saveImpression",
+      "options": { "histogramIndex": 0 }
+    },
+    {
+      "seconds": 2,
+      "site": "advertiser-1.example",
+      "event": "measureConversion",
+      "options": {
+        "aggregationService": "https://agg-service.example",
+        "epsilon": 0.1,
+        "histogramSize": 1
+      },
+      "expected": [1]
+    },
+    {
+      "seconds": 3,
+      "event": "clearBrowsingHistoryForAttribution",
+      "sites": ["advertiser-1.example"],
+      "forgetVisits": true
+    },
+    {
+      "seconds": 4,
+      "site": "a.example",
+      "event": "saveImpression",
+      "$comment": "add an impression to be sure that budget is affected below, rather than impressions",
+      "options": { "histogramIndex": 0 }
+    },
+    {
+      "seconds": 5,
+      "site": "advertiser-1.example",
+      "event": "measureConversion",
+      "$comment": "re-run query, expecting budget to have been zeroed",
+      "options": {
+        "aggregationService": "https://agg-service.example",
+        "epsilon": 0.1,
+        "histogramSize": 1
+      },
+      "expected": [0]
+    },
+    {
+      "seconds": 6,
+      "site": "advertiser-2.example",
+      "$comment": "re-run query with different conversion site, expecting epoch to be off-limits",
+      "event": "measureConversion",
+      "options": {
+        "aggregationService": "https://agg-service.example",
+        "epsilon": 0.1,
+        "histogramSize": 1
+      },
+      "expected": [0]
+    }
+  ]
+}

impl/e2e.schema.json

@@ -64,7 +64,7 @@
             "type": "object",
             "oneOf": [
               {
-                "$ref": "#/$defs/commonEvent",
+                "$ref": "#/$defs/siteEvent",
                 "properties": {
                   "event": {
                     "const": "saveImpression"
@@ -83,7 +83,7 @@
                 "unevaluatedProperties": false
               },
               {
-                "$ref": "#/$defs/commonEvent",
+                "$ref": "#/$defs/siteEvent",
                 "properties": {
                   "event": {
                     "const": "measureConversion"
@@ -113,13 +113,29 @@
                 "unevaluatedProperties": false
               },
               {
-                "$ref": "#/$defs/commonEvent",
+                "$ref": "#/$defs/siteEvent",
                 "properties": {
                   "event": {
                     "const": "clearImpressionsForSite"
                   }
                 },
                 "unevaluatedProperties": false
+              },
+              {
+                "$ref": "#/$defs/commonEvent",
+                "properties": {
+                  "event": {
+                    "const": "clearBrowsingHistoryForAttribution"
+                  },
+                  "forgetVisits": {
+                    "type": "boolean"
+                  },
+                  "sites": {
+                    "$ref": "#/$defs/siteList"
+                  }
+                },
+                "required": ["forgetVisits", "sites"],
+                "unevaluatedProperties": false
               }
             ]
           }
@@ -205,12 +221,9 @@
         },
         "seconds": {
           "type": "integer"
-        },
-        "site": {
-          "type": "string"
         }
       },
-      "required": ["seconds", "site"]
+      "required": ["seconds"]
     },
     "expectedError": {
       "oneOf": [
@@ -232,6 +245,16 @@
         }
       ]
     },
+    "siteEvent": {
+      "$ref": "#/$defs/commonEvent",
+      "type": "object",
+      "properties": {
+        "site": {
+          "type": "string"
+        }
+      },
+      "required": ["site"]
+    },
     "siteList": {
       "type": "array",
       "items": {

impl/src/clear.test.ts

@@ -127,7 +127,7 @@ void test("forget-one-site-conversions", async () => {
 
   backend.clearState(["conv-one.example"], true);
 
-  // Conversions are unaffected, and conversion state is gone.
+  // Impressions are unaffected, and conversion state is gone.
   assert.equal(backend.impressions.length, siteTable.length);
   assert.deepEqual(backend.privacyBudgetEntries, []);
   assert.deepEqual(backend.epochStarts, new Map());

impl/src/e2e.test.ts

@@ -19,7 +19,11 @@ interface TestCase {
   events: Event[];
 }
 
-type Event = SaveImpression | MeasureConversion | ClearImpressionsForSite;
+type Event =
+  | SaveImpression
+  | MeasureConversion
+  | ClearImpressionsForSite
+  | ClearBrowsingHistoryForAttribution;
 
 type ExpectedError =
   | "RangeError"
@@ -53,6 +57,13 @@ interface ClearImpressionsForSite {
   site: string;
 }
 
+interface ClearBrowsingHistoryForAttribution {
+  event: "clearBrowsingHistoryForAttribution";
+  seconds: number;
+  sites: string[];
+  forgetVisits: boolean;
+}
+
 function assertThrows(
   call: () => unknown,
   expectedError: ExpectedError,
@@ -148,6 +159,9 @@ function runTest(
       case "clearImpressionsForSite":
         backend.clearImpressionsForSite(event.site);
         break;
+      case "clearBrowsingHistoryForAttribution":
+        backend.clearState(event.sites, event.forgetVisits);
+        break;
     }
   }
 }