Add custom gtag events

app/helpers/template_helpers.py

@@ -119,7 +119,7 @@ def service_links_context(
     @property
     def data_layer_context(
         self,
-    ) -> list[dict]:
+    ) -> dict[str, str]:
         tx_id_context = (
             {"tx_id": metadata.tx_id}
             if (metadata := get_metadata(current_user))
@@ -130,9 +130,14 @@ def data_layer_context(
             key: value for key in DATA_LAYER_KEYS if (value := cookie_session.get(key))
         }
         context = [*additional_context, schema_context]
+
         if tx_id_context:
             context.append(tx_id_context)
-        return context
+
+        flattened_context: dict[str, str] = {}
+        for d in context:
+            flattened_context |= d
+        return flattened_context
 
     @property
     def footer_context(self) -> dict[str, Any]:

templates/layouts/_base.html

@@ -73,9 +73,6 @@
 {% block head %}
     {# djlint:off #}
     {% if google_tag_id %}
-        <script nonce="{{ csp_nonce }}">
-            dataLayer = {{ data_layer | tojson }}
-        </script>
         <!-- Google tag (gtag.js) -->
         <script nonce="{{ csp_nonce }}">
             function loadGoogleTagScript() {
@@ -98,7 +95,9 @@
                     loadGoogleTagScript()
                     function gtag(){dataLayer.push(arguments);}
                     gtag('js', new Date());
+                    gtag('set', {{ data_layer }});
                     gtag('config', '{{ google_tag_id }}');
+                    gtag('event', 'survey_data', {{ data_layer | tojson }});
                 }
         </script>
     {% endif %}

tests/app/helpers/test_template_helpers.py

@@ -1029,85 +1029,85 @@ def test_use_default_survey_title_in_context_when_no_cookie(
             SurveyType.DEFAULT,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.DEFAULT,
             "en",
             QuestionnaireSchema({"survey_id": "001", "form_type": "test"}),
-            [{"form_type": "test", "survey_id": "001"}],
+            {"form_type": "test", "survey_id": "001"},
         ),
         (
             SurveyType.BUSINESS,
             "en",
             QuestionnaireSchema(
                 {"survey_id": "001", "form_type": "test", "title": "test_title"}
             ),
-            [{"form_type": "test", "survey_id": "001", "title": "test_title"}],
+            {"form_type": "test", "survey_id": "001", "title": "test_title"},
         ),
         (
             SurveyType.HEALTH,
             "en",
             QuestionnaireSchema(
                 {"survey_id": "001", "form_type": "test", "title": "test_title"}
             ),
-            [{"form_type": "test", "survey_id": "001", "title": "test_title"}],
+            {"form_type": "test", "survey_id": "001", "title": "test_title"},
         ),
         (
             SurveyType.SOCIAL,
             "en",
             QuestionnaireSchema(
                 {"survey_id": "001", "form_type": "test", "title": "test_title"}
             ),
-            [{"form_type": "test", "survey_id": "001", "title": "test_title"}],
+            {"form_type": "test", "survey_id": "001", "title": "test_title"},
         ),
         (
             SurveyType.NORTHERN_IRELAND,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.DBT_DSIT,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.DBT_DSIT_NI,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.DBT,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.DBT_NI,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.ORR,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.DESNZ,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
         (
             SurveyType.DESNZ_NI,
             "en",
             QuestionnaireSchema({"survey_id": "001"}),
-            [{"survey_id": "001"}],
+            {"survey_id": "001"},
         ),
     ],
 )

tests/integration/test_application_variables.py

@@ -24,7 +24,7 @@ def test_google_analytics_code_and_credentials_are_present(self):
         self.get("/questionnaire/feedback/")
         self.assertStatusOK()
         self.assertInHead(
-            f'dataLayer = [{{"form_type": "H", "survey_id": "0", "title": "Feedback test schema"}}, {{"tx_id": "{actual["METADATA"]["tx_id"]}"}}]'
+            f'"form_type": "H", "survey_id": "0", "title": "Feedback test schema", "tx_id": "{actual["METADATA"]["tx_id"]}"'
         )
         self.assertInHead("https://www.googletagmanager.com")
         self.assertInHead(settings.EQ_GOOGLE_TAG_ID)
@@ -40,7 +40,7 @@ def test_google_analytics_data_layer_has_no_null_fields(self):
         self.assertStatusOK()
         # form_type is empty so should not be present
         self.assertInHead(
-            f'dataLayer = [{{"survey_id": "001", "title": "Other input fields"}}, {{"tx_id": "{actual["METADATA"]["tx_id"]}"}}]'
+            f'"survey_id": "001", "title": "Other input fields", "tx_id": "{actual["METADATA"]["tx_id"]}"'
         )
 
     def test_livereload_script_rendered(self):