Script v2: Change priority of CSP related error for verifying manual installations (#5707)

* Add logic to find Plausible script tag

* Clarify where cookies fixtures come from

* Add case for snippet not found

* Fix issue with installation type not propagating to diagnostics

* Better struct definition

* Refactor verification tests to be more comprehensive

* Fix compile error related to Test.Support.DNS

* Fix DNS imports for CE

* Refactor when tracker is in HTML is detected

Author: apata

config/test.exs

@@ -57,4 +57,9 @@ config :plausible, Plausible.InstallationSupport.Checks.Detection,
     plug: {Req.Test, :global}
   ]
 
+config :plausible, Plausible.InstallationSupport.Checks.InstallationV2,
+  req_opts: [
+    plug: {Req.Test, Plausible.InstallationSupport.Checks.InstallationV2}
+  ]
+
 config :plausible, Plausible.Session.Salts, interval: :timer.hours(1)

lib/plausible/installation_support/checks/installation_v2.ex

@@ -160,6 +160,7 @@ defmodule Plausible.InstallationSupport.Checks.InstallationV2 do
   defp parse_to_diagnostics(data),
     do: [
       disallowed_by_csp: data["disallowedByCsp"],
+      tracker_is_in_html: data["trackerIsInHtml"],
       plausible_is_on_window: data["plausibleIsOnWindow"],
       plausible_is_initialized: data["plausibleIsInitialized"],
       plausible_version: data["plausibleVersion"],

lib/plausible/installation_support/verification/diagnostics.ex

@@ -4,19 +4,23 @@ defmodule Plausible.InstallationSupport.Verification.Diagnostics do
   """
   require Logger
 
-  # in this struct, nil means indeterminate
-  defstruct selected_installation_type: nil,
-            disallowed_by_csp: nil,
-            plausible_is_on_window: nil,
-            plausible_is_initialized: nil,
-            plausible_version: nil,
-            plausible_variant: nil,
-            diagnostics_are_from_cache_bust: nil,
-            test_event: nil,
-            cookies_consent_result: nil,
-            response_status: nil,
-            service_error: nil,
-            attempts: nil
+  # In this struct
+  # - the default nil value for each field means that the value is indeterminate (e.g. we didn't even get to the part where response_status is set)
+  defstruct [
+    :selected_installation_type,
+    :disallowed_by_csp,
+    :tracker_is_in_html,
+    :plausible_is_on_window,
+    :plausible_is_initialized,
+    :plausible_version,
+    :plausible_variant,
+    :diagnostics_are_from_cache_bust,
+    :test_event,
+    :cookies_consent_result,
+    :response_status,
+    :service_error,
+    :attempts
+  ]
 
   @type t :: %__MODULE__{}
 
@@ -150,6 +154,21 @@ defmodule Plausible.InstallationSupport.Verification.Diagnostics do
     end
   end
 
+  def interpret(
+        %__MODULE__{
+          tracker_is_in_html: false,
+          selected_installation_type: selected_installation_type,
+          plausible_is_on_window: plausible_is_on_window,
+          plausible_is_initialized: plausible_is_initialized,
+          service_error: nil
+        },
+        _expected_domain,
+        _url
+      )
+      when selected_installation_type in ["manual", nil] and plausible_is_on_window != true and
+             plausible_is_initialized != true,
+      do: error_plausible_not_found(selected_installation_type)
+
   @error_csp_disallowed Error.new!(%{
                           message:
                             "We encountered an issue with your site's Content Security Policy (CSP)",

lib/plausible_web/live/installationv2.ex

@@ -294,17 +294,19 @@ defmodule PlausibleWeb.Live.InstallationV2 do
   end
 
   def handle_event("submit", %{"tracker_script_configuration" => params}, socket) do
-    PlausibleWeb.Tracker.update_script_configuration!(
-      socket.assigns.site,
-      params,
-      :installation
-    )
+    config =
+      PlausibleWeb.Tracker.update_script_configuration!(
+        socket.assigns.site,
+        params,
+        :installation
+      )
 
     {:noreply,
      push_navigate(socket,
        to:
          Routes.site_path(socket, :verification, socket.assigns.site.domain,
-           flow: socket.assigns.flow
+           flow: socket.assigns.flow,
+           installation_type: config.installation_type
          )
      )}
   end