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
13 changes: 3 additions & 10 deletions ProcessMaker/Http/Middleware/ServerTimingMiddleware.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,10 @@

class ServerTimingMiddleware
{
// Minimum time in ms to include a package in the Server-Timing header
private static $minPackageTime;

public function __construct()
{
self::$minPackageTime = config('app.server_timing.min_package_time');
}

/**
* Handle an incoming request.
*
* @param \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response) $next
* @param Closure(Request): (Response) $next
*/
public function handle(Request $request, Closure $next): Response
{
Expand Down Expand Up @@ -56,12 +48,13 @@ public function handle(Request $request, Closure $next): Response
}

$packageTimes = ProcessMakerServiceProvider::getPackageBootTiming();
$minPackageTime = config('app.server_timing.min_package_time');

foreach ($packageTimes as $package => $timing) {
$time = ($timing['end'] - $timing['start']) * 1000;

// Only include packages that took more than MIN_PACKAGE_TIME ms
if ($time > self::$minPackageTime) {
if ($time > $minPackageTime) {
$serverTiming[] = "{$package};dur={$time}";
}
}
Expand Down
53 changes: 53 additions & 0 deletions tests/Feature/ServerTimingMiddlewareTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ private function getHeader($response, $header)
return $headers[$header];
}

private function getServerTimingHeaderValue($response): string
{
return implode(',', $this->getHeader($response, 'server-timing'));
}

private function getMetricDuration($response, string $metric): float
{
$serverTiming = implode(',', $this->getHeader($response, 'server-timing'));
Expand Down Expand Up @@ -229,6 +234,54 @@ public function testServerTimingOnLogin()
$this->assertStringContainsString('db;dur=', $serverTiming[2]);
}

public function testPackageTimingRespectsMinPackageTimeThreshold()
{
config([
'app.server_timing.enabled' => true,
'app.server_timing.min_package_time' => 5,
]);

ProcessMakerServiceProvider::setPackageBootStart('foour32507-fast-package', 0.0);
ProcessMakerServiceProvider::setPackageBootedTime('foour32507-fast-package', 0.002);

ProcessMakerServiceProvider::setPackageBootStart('foour32507-slow-package', 0.0);
ProcessMakerServiceProvider::setPackageBootedTime('foour32507-slow-package', 0.010);

Route::middleware(ServerTimingMiddleware::class)->get('/package-threshold-test', function () {
return response()->json(['message' => 'Package threshold test']);
});

$response = $this->get('/package-threshold-test');
$response->assertHeader('Server-Timing');

$serverTiming = $this->getServerTimingHeaderValue($response);

$this->assertStringNotContainsString('foour32507-fast-package;dur=', $serverTiming);
$this->assertStringContainsString('foour32507-slow-package;dur=', $serverTiming);
}

public function testMinPackageTimeReadsConfigPerRequest()
{
config(['app.server_timing.enabled' => true]);

ProcessMakerServiceProvider::setPackageBootStart('foour32507-octane-package', 0.0);
ProcessMakerServiceProvider::setPackageBootedTime('foour32507-octane-package', 0.008);

Route::middleware(ServerTimingMiddleware::class)->get('/octane-min-package-test', function () {
return response()->json(['message' => 'Octane min package test']);
});

config(['app.server_timing.min_package_time' => 10]);
$responseAboveThreshold = $this->get('/octane-min-package-test');
$serverTimingAboveThreshold = $this->getServerTimingHeaderValue($responseAboveThreshold);
$this->assertStringNotContainsString('foour32507-octane-package;dur=', $serverTimingAboveThreshold);

config(['app.server_timing.min_package_time' => 5]);
$responseBelowThreshold = $this->get('/octane-min-package-test');
$serverTimingBelowThreshold = $this->getServerTimingHeaderValue($responseBelowThreshold);
$this->assertStringContainsString('foour32507-octane-package;dur=', $serverTimingBelowThreshold);
}

public function testServerTimingIfIsDisabled()
{
config(['app.server_timing.enabled' => false]);
Expand Down
Loading