Add Scarf.sh pixel - open source analytics & marketing intelligence

kiwitcms · Feb 2, 2025 · 7240542 · 7240542
1 parent 87dd61f
commit 7240542
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 4 deletions.
diff --git a/etc/nginx.conf b/etc/nginx.conf
@@ -63,7 +63,7 @@ http {
     }
 
     # WARNING: make sure these match tcms.core.middleware.ExtraHeadersMiddleware
-    add_header Content-Security-Policy "script-src 'self' cdn.crowdin.com *.ethicalads.io plausible.io;";
+    add_header Content-Security-Policy "script-src 'self' cdn.crowdin.com *.ethicalads.io plausible.io static.scarf.sh;";
 
     server {
         listen       8080;

diff --git a/tcms/core/middleware.py b/tcms/core/middleware.py
@@ -29,7 +29,7 @@ class ExtraHeadersMiddleware(MiddlewareMixin):
     def process_response(self, request, response):
         if settings.DEBUG:
             response.headers["Content-Security-Policy"] = (
-                "script-src 'self' cdn.crowdin.com *.ethicalads.io plausible.io;"
+                "script-src 'self' cdn.crowdin.com *.ethicalads.io plausible.io static.scarf.sh;"
             )
 
             if request.path.find("/uploads/") > -1:

diff --git a/tcms/settings/common.py b/tcms/settings/common.py
@@ -589,3 +589,6 @@
 
 # https://plausible.io/kiwitcms-container
 PLAUSIBLE_DOMAIN = "kiwitcms-container"
+
+# https://app.scarf.sh/analytics/kiwitcms?pixelId=d7cc874e-5b3b-409f-bb20-bb1e410cdcb0
+SCARF_PIXEL_ID = "d7cc874e-5b3b-409f-bb20-bb1e410cdcb0"
diff --git a/tcms/templates/base.html b/tcms/templates/base.html
@@ -66,5 +66,9 @@
 
     {% block contents %}{% endblock %}
     {% include 'include/ads.html' %}
+
+    {% if SETTINGS.ANONYMOUS_ANALYTICS %}
+    <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid={{ SETTINGS.SCARF_PIXEL_ID }}">
+    {% endif %}
 </body>
 </html>
diff --git a/tests/test_http.sh b/tests/test_http.sh
@@ -93,8 +93,8 @@ _EOF_
     rlPhaseEnd
 
     rlPhaseStartTest "Should send Content-Security-Policy header"
-        rlRun -t -c "curl -k -D- $HTTPS 2>/dev/null | grep $'Content-Security-Policy: script-src \'self\' cdn.crowdin.com \*.ethicalads.io plausible.io;'"
-        rlRun -t -c "curl -k -D- $PROXY 2>/dev/null | grep $'Content-Security-Policy: script-src \'self\' cdn.crowdin.com \*.ethicalads.io plausible.io;'"
+        rlRun -t -c "curl -k -D- $HTTPS 2>/dev/null | grep $'Content-Security-Policy: script-src \'self\' cdn.crowdin.com \*.ethicalads.io plausible.io static.scarf.sh;'"
+        rlRun -t -c "curl -k -D- $PROXY 2>/dev/null | grep $'Content-Security-Policy: script-src \'self\' cdn.crowdin.com \*.ethicalads.io plausible.io static.scarf.sh;'"
     rlPhaseEnd
 
     rlPhaseStartTest "Should not execute inline JavaScript"