You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
virt/web/tests/SiteAnalyticsServiceTest.php

193 lines
7.6 KiB
PHP

<?php
require dirname(__DIR__) . '/vendor/autoload.php';
use App\Middleware\SiteAnalytics;
use App\Models\SiteVisitEvent;
use App\Services\SiteAnalyticsRecorder;
use App\Services\SiteAnalyticsService;
use Illuminate\Database\Capsule\Manager as Capsule;
use Slim\Http\Environment;
use Slim\Http\Request;
use Slim\Http\Response;
$System_Config = [
'timeZone' => 'Asia/Shanghai',
'key' => 'site-analytics-test-key',
];
date_default_timezone_set($System_Config['timeZone']);
$capsule = new Capsule();
$capsule->addConnection(['driver' => 'sqlite', 'database' => ':memory:'], 'default');
$capsule->addConnection(['driver' => 'sqlite', 'database' => ':memory:'], 'log');
$capsule->setAsGlobal();
$capsule->bootEloquent();
$assertSame = function ($expected, $actual, $label) {
if ($expected !== $actual) {
fwrite(STDERR, sprintf(
"%s failed: expected %s, got %s\n",
$label,
var_export($expected, true),
var_export($actual, true)
));
exit(1);
}
};
$assertTrue = function ($actual, $label) {
if (!$actual) {
fwrite(STDERR, $label . " failed\n");
exit(1);
}
};
SiteAnalyticsService::ensureTables();
$schema = $capsule->getConnection('log')->getSchemaBuilder();
$assertTrue($schema->hasTable('site_visit_events'), 'event table created');
$assertTrue($schema->hasTable('site_visit_daily_stats'), 'daily table created');
$assertTrue($schema->hasTable('site_security_events'), 'security table created');
$assertTrue(!$schema->hasTable('site_redirect_links'), 'redirect table not created');
$today = date('Y-m-d');
$now = time();
$base = [
'session_id' => str_repeat('b', 32),
'user_id' => 0,
'site_host' => 'panel.example',
'landing_path' => '/',
'referrer_host' => '(direct)',
'ip_address' => '192.0.2.1',
'ip_hash' => hash('sha256', '192.0.2.1'),
'user_agent' => 'Mozilla/5.0 Chrome/120.0',
'browser' => 'Chrome',
'operating_system' => 'Windows',
'device_type' => 'desktop',
'utm_source' => '',
'utm_medium' => '',
'utm_campaign' => '',
'status_code' => 200,
'occurred_at' => $now,
'created_at' => $now,
];
SiteVisitEvent::insert(array_merge($base, [
'event_key' => hash('sha256', 'pageview-a'),
'event_type' => 'visit',
'visitor_id' => str_repeat('a', 32),
]));
SiteVisitEvent::insert(array_merge($base, [
'event_key' => hash('sha256', 'pageview-b'),
'event_type' => 'visit',
'visitor_id' => str_repeat('a', 32),
'user_id' => 42,
'landing_path' => '/user/shop',
'referrer_host' => 'panel.example',
]));
SiteVisitEvent::insert(array_merge($base, [
'event_key' => hash('sha256', 'pageview-c'),
'event_type' => 'visit',
'visitor_id' => str_repeat('c', 32),
'session_id' => str_repeat('d', 32),
'landing_path' => '/auth/register',
'referrer_host' => 'search.example',
'operating_system' => 'Android',
'device_type' => 'mobile',
]));
$assertSame(1, SiteAnalyticsService::refreshRecentDays(1), 'one day refreshed');
$report = SiteAnalyticsService::report($today, $today, 20);
$assertSame(3, $report['summary']['pageviews'], 'pageview total');
$assertSame(2, $report['summary']['unique_visitors'], 'unique visitor total');
$assertSame(2, $report['summary']['sessions'], 'session total');
$assertSame(1, $report['summary']['direct_pageviews'], 'direct pageview total');
$assertSame(3, $report['trend'][0]['pageviews'], 'pageview trend');
$assertSame(2, $report['trend'][0]['sessions'], 'session trend');
$assertSame(3, count($report['recent_events']), 'recent pageviews');
$assertTrue(isset($report['rankings']['operating_systems']), 'operating system ranking');
$assertTrue(isset($report['rankings']['ip_addresses']), 'IP ranking');
$assertSame('192.0.2.1', $report['rankings']['ip_addresses'][0]['value'], 'ranked IP address');
$assertSame(3, $report['rankings']['ip_addresses'][0]['count'], 'ranked IP pageviews');
$assertSame(2, $report['rankings']['ip_addresses'][0]['unique_visitors'], 'ranked IP visitors');
$assertSame('内网或保留地址', $report['rankings']['ip_addresses'][0]['location'], 'reserved IP location');
$assertSame(
1,
(int) $capsule->getConnection('log')->table('site_visit_daily_stats')
->where('dimension_type', 'ip_address')
->where('dimension_value', '192.0.2.1')
->count(),
'IP daily dimension'
);
$homeRequest = Request::createFromEnvironment(Environment::mock([
'REQUEST_METHOD' => 'GET',
'REQUEST_URI' => '/',
'HTTP_HOST' => 'panel.example',
'HTTP_ACCEPT' => 'text/html,application/xhtml+xml',
'HTTP_SEC_FETCH_MODE' => 'navigate',
'HTTP_SEC_FETCH_DEST' => 'document',
'HTTP_USER_AGENT' => 'Mozilla/5.0 Chrome/120.0',
]));
$userRequest = Request::createFromEnvironment(Environment::mock([
'REQUEST_METHOD' => 'GET',
'REQUEST_URI' => '/user/shop',
'HTTP_HOST' => 'panel.example',
'HTTP_ACCEPT' => 'text/html,application/xhtml+xml',
'HTTP_SEC_FETCH_MODE' => 'navigate',
'HTTP_SEC_FETCH_DEST' => 'document',
'HTTP_USER_AGENT' => 'Mozilla/5.0 Chrome/120.0',
]));
$ajaxRequest = Request::createFromEnvironment(Environment::mock([
'REQUEST_METHOD' => 'GET',
'REQUEST_URI' => '/user/ticket',
'HTTP_HOST' => 'panel.example',
'HTTP_X_REQUESTED_WITH' => 'XMLHttpRequest',
'HTTP_USER_AGENT' => 'Mozilla/5.0 Chrome/120.0',
]));
$jsonRequest = Request::createFromEnvironment(Environment::mock([
'REQUEST_METHOD' => 'GET',
'REQUEST_URI' => '/user/code_check',
'HTTP_HOST' => 'panel.example',
'HTTP_ACCEPT' => 'application/json',
'HTTP_USER_AGENT' => 'Mozilla/5.0 Chrome/120.0',
]));
$apiRequest = Request::createFromEnvironment(Environment::mock([
'REQUEST_METHOD' => 'GET',
'REQUEST_URI' => '/api/captch',
'HTTP_HOST' => 'panel.example',
'HTTP_USER_AGENT' => 'Mozilla/5.0 Chrome/120.0',
]));
$actionRequest = Request::createFromEnvironment(Environment::mock([
'REQUEST_METHOD' => 'GET',
'REQUEST_URI' => '/user/logout',
'HTTP_HOST' => 'panel.example',
'HTTP_USER_AGENT' => 'Mozilla/5.0 Chrome/120.0',
]));
$assertTrue(SiteAnalyticsRecorder::isTrackableRequest($homeRequest), 'home page tracked');
$assertTrue(SiteAnalyticsRecorder::isTrackableRequest($userRequest), 'authenticated page tracked');
$assertTrue(!SiteAnalyticsRecorder::isTrackableRequest($ajaxRequest), 'ajax request excluded');
$assertTrue(!SiteAnalyticsRecorder::isTrackableRequest($jsonRequest), 'json polling excluded');
$assertTrue(!SiteAnalyticsRecorder::isTrackableRequest($apiRequest), 'api request excluded');
$assertTrue(!SiteAnalyticsRecorder::isTrackableRequest($actionRequest), 'state-changing GET excluded');
$identity = SiteAnalyticsRecorder::resolveIdentity($homeRequest);
$assertTrue(SiteAnalyticsRecorder::recordPageView($homeRequest, $identity, 200), 'first pageview recorded');
$assertTrue(SiteAnalyticsRecorder::recordPageView($homeRequest, $identity, 200), 'page refresh recorded');
$middlewareResponse = (new SiteAnalytics())($userRequest, new Response(), function ($request, $response) {
$response->getBody()->write('ok');
return $response;
});
$assertSame(2, count($middlewareResponse->getHeader('Set-Cookie')), 'visitor and session cookies set');
SiteVisitEvent::insert(array_merge($base, [
'event_key' => hash('sha256', 'old-pageview'),
'event_type' => 'visit',
'visitor_id' => str_repeat('e', 32),
'occurred_at' => strtotime('-40 days'),
'created_at' => strtotime('-40 days'),
]));
$assertTrue(!method_exists(SiteAnalyticsService::class, 'cleanupRawEvents'), 'automatic cleanup is removed');
$assertSame(1, SiteVisitEvent::where('event_key', hash('sha256', 'old-pageview'))->count(), 'old event remains available');
echo "Site analytics service tests passed.\n";