Added ability to disable tracking on certain pages (#38)

Co-authored-by: Tomás López <tlopez@facephi.com>
isc30 · Jul 29, 2021 · 8febc94 · 8febc94
1 parent 796d07d
commit 8febc94
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 6 deletions.
diff --git a/demo/DemoApp/DemoApp.Client/Pages/Counter.razor b/demo/DemoApp/DemoApp.Client/Pages/Counter.razor
@@ -1,5 +1,8 @@
 @page "/counter"
 
+@using Blazor.Analytics.Abstractions
+@inject ITrackingNavigationState TrackingNavigationState
+
 <h1>Counter</h1>
 
 <p>Current count: @currentCount</p>
@@ -12,12 +15,17 @@
     [Inject]
     private Blazor.Analytics.IAnalytics Analytics { get; set; }
 
+    protected override void OnInitialized()
+    {
+        TrackingNavigationState.DisableTracking();
+    }
+
     private void IncrementCount()
     {
         currentCount++;
-        Analytics.TrackEvent("Increment", currentCount,  "CountPage");
+        Analytics.TrackEvent("Increment", currentCount, "CountPage");
 
         //Example of how to track a generic event (see also https://developers.google.com/gtagjs/reference/ga4-events)
-        Analytics.TrackEvent("generate_lead", new {currency = "USD", value = 99.99});
+        Analytics.TrackEvent("generate_lead", new { currency = "USD", value = 99.99 });
     }
 }
diff --git a/demo/DemoApp/DemoApp.Server/Pages/Counter.razor b/demo/DemoApp/DemoApp.Server/Pages/Counter.razor
@@ -1,5 +1,8 @@
 @page "/counter"
 
+@using Blazor.Analytics.Abstractions
+@inject ITrackingNavigationState TrackingNavigationState
+
 <h1>Counter</h1>
 
 <p>Current count: @currentCount</p>
@@ -12,12 +15,17 @@
     [Inject]
     private Blazor.Analytics.IAnalytics Analytics { get; set; }
 
+    protected override void OnInitialized()
+    {
+        TrackingNavigationState.DisableTracking();
+    }
+
     private void IncrementCount()
     {
         currentCount++;
         //Analytics.TrackEvent("Increment", currentCount, "CountPage");
 
         //Example of how to track a generic event (see also https://developers.google.com/gtagjs/reference/ga4-events)
-        Analytics.TrackEvent("generate_lead", new {currency = "USD", value = currentCount});
+        Analytics.TrackEvent("generate_lead", new { currency = "USD", value = currentCount });
     }
 }
diff --git a/src/Blazor.Analytics/Abstractions/ITrackingNavigationState.cs b/src/Blazor.Analytics/Abstractions/ITrackingNavigationState.cs
@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Blazor.Analytics.Abstractions
+{
+    public interface ITrackingNavigationState
+    {
+        void EnableTracking();
+
+        void DisableTracking();
+
+        bool IsTrackingEnabled();
+    }
+}
diff --git a/src/Blazor.Analytics/Blazor.Analytics.csproj b/src/Blazor.Analytics/Blazor.Analytics.csproj
@@ -38,7 +38,7 @@
 
     <!-- TypeScript Build -->
     <ItemGroup>
-        <PackageReference Include="Microsoft.TypeScript.MSBuild" Version="4.2.4">
+        <PackageReference Include="Microsoft.TypeScript.MSBuild" Version="4.3.5">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
         </PackageReference>

diff --git a/src/Blazor.Analytics/Components/NavigationTracker.razor b/src/Blazor.Analytics/Components/NavigationTracker.razor
@@ -1,6 +1,7 @@
 @using System.Threading.Tasks
 @using Microsoft.AspNetCore.Components
 @using Microsoft.AspNetCore.Components.Routing
+@using Blazor.Analytics.Abstractions
 
 @code
 {
@@ -10,6 +11,9 @@
     [Inject]
     protected NavigationManager NavigationManager { get; set; } = null;
 
+    [Inject]
+    protected ITrackingNavigationState TrackingNavigationState { get; set; } = null;
+
     protected override async Task OnInitializedAsync()
     {
         await base.OnInitializedAsync();
@@ -38,6 +42,11 @@
 
     private async Task OnLocationChanged(string location)
     {
-        await Analytics.TrackNavigation(location);
+        if (TrackingNavigationState.IsTrackingEnabled())
+        {
+            await Analytics.TrackNavigation(location);
+        }
+
+        TrackingNavigationState.EnableTracking();
     }
 }
diff --git a/src/Blazor.Analytics/Components/TrackingNavigationState.cs b/src/Blazor.Analytics/Components/TrackingNavigationState.cs
@@ -0,0 +1,18 @@
+using Blazor.Analytics.Abstractions;
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Blazor.Analytics.GoogleAnalytics
+{
+    public class TrackingNavigationState : ITrackingNavigationState
+    {
+        private bool _isEnableTracking = true;
+
+        public void DisableTracking() => _isEnableTracking = false;
+
+        public void EnableTracking() => _isEnableTracking = true;
+
+        public bool IsTrackingEnabled() => _isEnableTracking;
+    }
+}
diff --git a/src/Blazor.Analytics/GoogleAnalytics/GoogleAnalyticsExtensions.cs b/src/Blazor.Analytics/GoogleAnalytics/GoogleAnalyticsExtensions.cs
@@ -1,4 +1,5 @@
-using Blazor.Analytics.GoogleAnalytics;
+using Blazor.Analytics.Abstractions;
+using Blazor.Analytics.GoogleAnalytics;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace Blazor.Analytics
@@ -14,6 +15,7 @@ public static IServiceCollection AddGoogleAnalytics(
             string trackingId,
             bool debug)
         {
+            services.AddScoped<ITrackingNavigationState, TrackingNavigationState>();
             return services.AddScoped<IAnalytics>(p =>
             {
                 var googleAnalytics = ActivatorUtilities.CreateInstance<GoogleAnalyticsStrategy>(p);