Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/screenshots/analytics-filters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/analytics-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/audience-events-and-flags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/screenshots/custom-event-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 39 additions & 6 deletions src/TheBuilder.WebAnalytics/Services/MockVercelAnalyticsClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,13 @@ public Task<IReadOnlyList<AnalyticsBreakdownRow>> GetBreakdownAsync(
IReadOnlyList<AnalyticsBreakdownRow> rows = isUtm && scenario is not (MockAnalyticsScenario.Complete or MockAnalyticsScenario.Utm)
? []
: Breakdowns.GetValueOrDefault(dimension, []);
return Task.FromResult<IReadOnlyList<AnalyticsBreakdownRow>>(Filter(rows, search, limit, row => row.Value));
var filtered = ApplyDimensionFilter(rows, query, dimension, row => row.Value);
var scale = QueryScale(connection, query, dimension);
var scaled = filtered.Select(row => new AnalyticsBreakdownRow(
row.Value,
Scale(row.PageViews, scale),
Scale(row.Visitors, scale)));
return Task.FromResult<IReadOnlyList<AnalyticsBreakdownRow>>(Filter(scaled, search, limit, row => row.Value));
}

public Task<AnalyticsEventTotals> CountEventsAsync(
Expand All @@ -112,7 +118,8 @@ public Task<AnalyticsEventTotals> CountEventsAsync(
cancellationToken.ThrowIfCancellationRequested();
if (!HasEvents(connection)) return Task.FromResult(new AnalyticsEventTotals(0, 0));
var row = Events.FirstOrDefault(item => string.Equals(item.EventName, eventName, StringComparison.OrdinalIgnoreCase));
var scale = eventDataFilter is null ? 1d : 0.42d;
var scale = QueryScale(connection, query, AnalyticsDimension.EventName)
* (eventDataFilter is null ? 1d : 0.42d);
return Task.FromResult(row is null
? new AnalyticsEventTotals(0, 0)
: new AnalyticsEventTotals(Scale(row.Count, scale), Scale(row.Visitors, scale)));
Expand All @@ -127,7 +134,13 @@ public Task<IReadOnlyList<AnalyticsEventRow>> GetEventsAsync(
{
cancellationToken.ThrowIfCancellationRequested();
IReadOnlyList<AnalyticsEventRow> rows = HasEvents(connection) ? Events : [];
return Task.FromResult<IReadOnlyList<AnalyticsEventRow>>(Filter(rows, search, limit, row => row.EventName));
var filtered = ApplyDimensionFilter(rows, query, AnalyticsDimension.EventName, row => row.EventName);
var scale = QueryScale(connection, query, AnalyticsDimension.EventName);
var scaled = filtered.Select(row => new AnalyticsEventRow(
row.EventName,
Scale(row.Count, scale),
Scale(row.Visitors, scale)));
return Task.FromResult<IReadOnlyList<AnalyticsEventRow>>(Filter(scaled, search, limit, row => row.EventName));
}

public Task<IReadOnlyList<AnalyticsFlagRow>> GetFlagsAsync(
Expand All @@ -146,7 +159,11 @@ public Task<IReadOnlyList<AnalyticsFlagRow>> GetFlagsAsync(
"personalised-homepage" => [new("default", 2410, 1530), new("industry", 1390, 870), new("returning-visitor", 960, 610)],
_ => FlagKeys
};
return Task.FromResult<IReadOnlyList<AnalyticsFlagRow>>(rows.Take(Math.Max(0, limit)).ToArray());
var scale = QueryScale(connection, query);
return Task.FromResult<IReadOnlyList<AnalyticsFlagRow>>(rows
.Take(Math.Max(0, limit))
.Select(row => new AnalyticsFlagRow(row.Value, Scale(row.PageViews, scale), Scale(row.Visitors, scale)))
.ToArray());
}

public Task<IReadOnlyList<string>> GetEventPropertyNamesAsync(
Expand Down Expand Up @@ -207,14 +224,30 @@ private static T[] Filter<T>(IEnumerable<T> rows, string? search, int limit, Fun
return filtered.Take(Math.Max(0, limit)).ToArray();
}

private static double QueryScale(VercelAnalyticsConnection connection, AnalyticsQuery query)
private static IEnumerable<T> ApplyDimensionFilter<T>(
IEnumerable<T> rows,
AnalyticsQuery query,
AnalyticsDimension dimension,
Func<T, string> value)
{
var selected = query.Filters?.FirstOrDefault(filter => filter.Dimension == dimension);
return selected is null
? rows
: rows.Where(row => string.Equals(value(row), selected.Value, StringComparison.OrdinalIgnoreCase));
}

private static double QueryScale(
VercelAnalyticsConnection connection,
AnalyticsQuery query,
AnalyticsDimension? excludedDimension = null)
{
var scale = string.IsNullOrWhiteSpace(query.RequestPath) ? 1d : 0.36d;
var rangeScale = Math.Clamp((query.To - query.From).TotalDays / 30d, 0.03d, 24d);
var growthScale = Scenario(connection) is MockAnalyticsScenario.Complete
? DemoGrowthScale(query.To)
: 1d;
return scale * rangeScale * Math.Pow(0.62d, query.Filters?.Count ?? 0) * growthScale;
var filterCount = query.Filters?.Count(filter => filter.Dimension != excludedDimension) ?? 0;
return scale * rangeScale * Math.Pow(0.62d, filterCount) * growthScale;
}

private static double DemoGrowthScale(DateTimeOffset periodEnd)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,44 @@ public async Task Demo_totals_increase_slightly_over_the_previous_period()
Assert.InRange(pageViewGrowth, 1.01d, 1.04d);
}

[Fact]
public async Task Demo_filters_update_matching_and_cross_dimension_reports()
{
var client = new MockVercelAnalyticsClient();
var connection = CreateRegistry(MockAnalyticsScenario.Complete, true).Get(MockKey)!;
var baseline = CreateQuery();
var filtered = baseline with
{
Filters = [new AnalyticsFilter(AnalyticsDimension.Country, "DK")]
};

var baselineDevices = await client.GetBreakdownAsync(
connection, baseline, AnalyticsDimension.DeviceType, 10, null, CancellationToken.None);
var filteredDevices = await client.GetBreakdownAsync(
connection, filtered, AnalyticsDimension.DeviceType, 10, null, CancellationToken.None);
var filteredCountries = await client.GetBreakdownAsync(
connection, filtered, AnalyticsDimension.Country, 10, null, CancellationToken.None);

Assert.All(filteredDevices.Zip(baselineDevices), pair =>
Assert.True(pair.First.Visitors < pair.Second.Visitors));
Assert.Equal("DK", Assert.Single(filteredCountries).Value);
}

[Fact]
public async Task Demo_event_filter_returns_only_the_selected_event()
{
var client = new MockVercelAnalyticsClient();
var connection = CreateRegistry(MockAnalyticsScenario.Complete, true).Get(MockKey)!;
var query = CreateQuery() with
{
Filters = [new AnalyticsFilter(AnalyticsDimension.EventName, "Demo requested")]
};

var events = await client.GetEventsAsync(connection, query, 10, null, CancellationToken.None);

Assert.Equal("Demo requested", Assert.Single(events).EventName);
}

[Fact]
public async Task Router_serves_mock_reports_without_contacting_Vercel()
{
Expand Down