Commit 6e9da664: #1702 switch analytics to event based

#1702 switch analytics to event based

6e9da664

Michael Schmitz

committed Apr 3

main

succeeded

Files

Details



	WPE.App.Services
	Analytics
	Logging
	LoggingAnalyticsService.cs
	LoggingLifecycleService.cs
	NoOp
	NoOpAnalyticsService.cs
	NoOpLifecycleService.cs
	AnalyticsService.cs +
	IAnalyticsService.cs
	ILifecycleService.cs
	IMetadataService.cs
	LifecycleService.cs +
	NoOpMetadataService.cs rename, edit
	Models
	AnalyticsEvent.cs +
	ServiceCollectionExtensions.cs
	WPE.App.Services.csproj

LoggingAnalyticsService.cs

-68

/WPE.App.Services/Analytics/Logging/LoggingAnalyticsService.cs

View

using Microsoft.AspNetCore.Components;

using Microsoft.Extensions.Logging;

namespace Infsoft.WPE.App.Services.Analytics.Logging

{

/// <summary>

/// Implements <see cref="IAnalyticsService"/> as logging only

/// </summary>

internal class LoggingAnalyticsService(ILogger<LoggingAnalyticsService> Logger, IPageTitleCache PageTitleCache, NavigationManager NavigationManager) : IAnalyticsService

{

/// <inheritdoc/>

public Task OnClick(string name, string text, InteractionType interactionType, string location) => Log($"Clicked {interactionType} with name '{name}' and text '{text}' at location {location}");

/// <inheritdoc/>

public Task OnSearch(int numberOfResults, string searchLocation, string? term = null, Dictionary<string, List<string>>? filters = null, DateTime? startDate = null, DateTime? endDate = null)

{

var msg = "Performed search";

var restrictions = new List<string>();

if (term is not null)

restrictions.Add($"term {term}");

if (filters is not null)

restrictions.Add($"filters: {string.Join(';', filters.Select(kv => $"{kv.Key}={string.Join(',', kv.Value)}"))}");

if (startDate is not null)

restrictions.Add($"startDate: {startDate.Value:o}");

if (endDate is not null)

restrictions.Add($"endDate: {endDate.Value:o}");

if (restrictions.Count != 0)

msg += $" with {string.Join(" and ", restrictions)}";

msg += $" at location {searchLocation} returning {numberOfResults} results";

if (startDate is null && endDate is not null)

Logger.LogWarning("End date was logged without start date, this is not supported");

return Log(msg);

}

/// <inheritdoc/>

public async Task Init() {

await Log("Initialized service");

await OnPageView(NavigationManager.ToBaseRelativePath(NavigationManager.Uri).Split('?')[0]);

}

/// <inheritdoc/>

public Task OnConsentUpdate(Dictionary<string, bool> givenConsents) => Log($"Updated consent: {string.Join(',', givenConsents.Select(consent => $"{consent.Key}: {consent.Value}"))}");

/// <inheritdoc/>

public Task OnLogin() => Log("Perfomed login");

/// <inheritdoc/>

public Task OnPageView(string relativeUrl) {

relativeUrl = $"/{relativeUrl}";

return Log($"Opened page with name '{relativeUrl}' and title '{(PageTitleCache.TryGetPageTitle(relativeUrl, out var title) ? title : "Unknown")}'");

}

/// <inheritdoc/>

public Task OnSilentLogin() => Log("Perfomed silent login");

private Task Log(string message)

{

using var scope = Logger.BeginScope("Analytics");

Logger.LogInformation("{Message}", message);

return Task.CompletedTask;

}

LoggingLifecycleService.cs

-30

/WPE.App.Services/Analytics/Logging/LoggingLifecycleService.cs

View

using Microsoft.Extensions.Logging;

namespace Infsoft.WPE.App.Services.Analytics.Logging

{

/// <summary>

/// Implements <see cref="ILifecycleService"/> as logging only

/// </summary>

internal class LoggingLifecycleService(ILogger<LoggingLifecycleService> Logger) : ILifecycleService

{

/// <inheritdoc/>

public Task Init() => Log("Initialized application");

/// <inheritdoc/>

public Task Pause() => Log("Paused application");

/// <inheritdoc/>

public Task Start() => Log("Started application");

/// <inheritdoc/>

public Task Stop() => Log("Stopped application");

private Task Log(string message)

{

using var scope = Logger.BeginScope("Lifecycle");

Logger.LogInformation("{LifecycleMessage}", message);

return Task.CompletedTask;

}

NoOpAnalyticsService.cs

-31

/WPE.App.Services/Analytics/NoOp/NoOpAnalyticsService.cs

View

namespace Infsoft.WPE.App.Services.Analytics.NoOp

{

/// <summary>

/// Implements <see cref="IAnalyticsService"/> as NoOp

/// </summary>

internal class NoOpAnalyticsService : IAnalyticsService

{

/// <inheritdoc/>

public Task OnClick(string name, string text, InteractionType interactionType, string location) => Task.CompletedTask;

/// <inheritdoc/>

public Task OnSearch(int numberOfResults, string searchLocation, string? term = null, Dictionary<string, List<string>>? filters = null, DateTime? startDate = null, DateTime? endDate = null) => Task.CompletedTask;

/// <inheritdoc/>

public Task Init() => Task.CompletedTask;

/// <inheritdoc/>

public Task OnConsentUpdate(Dictionary<string, bool> givenConsents) => Task.CompletedTask;

/// <inheritdoc/>

public Task OnLogin() => Task.CompletedTask;

/// <inheritdoc/>

public Task OnPageView(string relativeUrl) => Task.CompletedTask;

/// <inheritdoc/>

public Task OnSilentLogin() => Task.CompletedTask;

}