summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/attribution-reporting
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:47:29 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:47:29 +0000
commit0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d (patch)
treea31f07c9bcca9d56ce61e9a1ffd30ef350d513aa /testing/web-platform/tests/attribution-reporting
parentInitial commit. (diff)
downloadfirefox-esr-0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d.tar.xz
firefox-esr-0ebf5bdf043a27fd3dfb7f92e0cb63d88954c44d.zip
Adding upstream version 115.8.0esr.upstream/115.8.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'testing/web-platform/tests/attribution-reporting')
-rw-r--r--testing/web-platform/tests/attribution-reporting/__init__.py0
-rw-r--r--testing/web-platform/tests/attribution-reporting/resources/__init__.py0
-rw-r--r--testing/web-platform/tests/attribution-reporting/resources/reports.py114
3 files changed, 114 insertions, 0 deletions
diff --git a/testing/web-platform/tests/attribution-reporting/__init__.py b/testing/web-platform/tests/attribution-reporting/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/testing/web-platform/tests/attribution-reporting/__init__.py
diff --git a/testing/web-platform/tests/attribution-reporting/resources/__init__.py b/testing/web-platform/tests/attribution-reporting/resources/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/testing/web-platform/tests/attribution-reporting/resources/__init__.py
diff --git a/testing/web-platform/tests/attribution-reporting/resources/reports.py b/testing/web-platform/tests/attribution-reporting/resources/reports.py
new file mode 100644
index 0000000000..9682a6dd24
--- /dev/null
+++ b/testing/web-platform/tests/attribution-reporting/resources/reports.py
@@ -0,0 +1,114 @@
+"""Methods for the report-event-attribution and report-aggregate-attribution endpoints"""
+import json
+from typing import List, Optional, Tuple, TypedDict
+
+from wptserve.request import Request
+from wptserve.stash import Stash
+from wptserve.utils import isomorphic_decode, isomorphic_encode
+
+# Key used to access the reports in the stash.
+REPORTS = "4691a2d7fca5430fb0f33b1bd8a9d388"
+
+CLEAR_STASH = isomorphic_encode("clear_stash")
+
+Header = Tuple[str, str]
+Status = Tuple[int, str]
+Response = Tuple[Status, List[Header], str]
+
+
+def decode_headers(headers: dict) -> dict:
+ """Decodes the headers from wptserve.
+
+ wptserve headers are encoded like
+ {
+ encoded(key): [encoded(value1), encoded(value2),...]
+ }
+ This method decodes the above using the wptserve.utils.isomorphic_decode
+ method
+ """
+ return {
+ isomorphic_decode(key): [isomorphic_decode(el) for el in value
+ ] for key, value in headers.items()
+ }
+
+def get_request_origin(request: Request) -> str:
+ return "%s://%s" % (request.url_parts.scheme,
+ request.url_parts.netloc)
+
+
+def handle_post_report(request: Request, headers: List[Header]) -> Response:
+ """Handles POST request for reports.
+
+ Retrieves the report from the request body and stores the report in the
+ stash. If clear_stash is specified in the query params, clears the stash.
+ """
+ if request.GET.get(CLEAR_STASH):
+ clear_stash(request.server.stash)
+ return (200, "OK"), headers, json.dumps({
+ "code": 200,
+ "message": "Stash successfully cleared.",
+ })
+ store_report(
+ request.server.stash, get_request_origin(request), {
+ "body": request.body.decode("utf-8"),
+ "headers": decode_headers(request.headers)
+ })
+ return (201, "OK"), headers, json.dumps({
+ "code": 201,
+ "message": "Report successfully stored."
+ })
+
+
+def handle_get_reports(request: Request, headers: List[Header]) -> Response:
+ """Handles GET request for reports.
+
+ Retrieves and returns all reports from the stash.
+ """
+ reports = take_reports(request.server.stash, get_request_origin(request))
+ headers.append(("Access-Control-Allow-Origin", "*"))
+ return (200, "OK"), headers, json.dumps({
+ "code": 200,
+ "reports": reports,
+ })
+
+
+def store_report(stash: Stash, origin: str, report: str) -> None:
+ """Stores the report in the stash. Report here is a JSON."""
+ with stash.lock:
+ reports_dict = stash.take(REPORTS)
+ if not reports_dict:
+ reports_dict = {}
+ reports = reports_dict.get(origin, [])
+ reports.append(report)
+ reports_dict[origin] = reports
+ stash.put(REPORTS, reports_dict)
+ return None
+
+def clear_stash(stash: Stash) -> None:
+ "Clears the stash."
+ stash.take(REPORTS)
+ return None
+
+def take_reports(stash: Stash, origin: str) -> List[str]:
+ """Takes all the reports from the stash and returns them."""
+ with stash.lock:
+ reports_dict = stash.take(REPORTS)
+ if not reports_dict:
+ reports_dict = {}
+
+ reports = reports_dict.pop(origin, [])
+ stash.put(REPORTS, reports_dict)
+ return reports
+
+
+def handle_reports(request: Request) -> Response:
+ """Handles request to get or store reports."""
+ headers = [("Content-Type", "application/json")]
+ if request.method == "POST":
+ return handle_post_report(request, headers)
+ if request.method == "GET":
+ return handle_get_reports(request, headers)
+ return (405, "Method Not Allowed"), headers, json.dumps({
+ "code": 405,
+ "message": "Only GET or POST methods are supported."
+ })