Skip to content

Commit 1e65b75

Browse files
timacdonaldgithub-actions[bot]
timacdonald
and
github-actions[bot]
authored
Context handling improvements (#273)
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
1 parent be177b3 commit 1e65b75

File tree

7 files changed

+133
-47
lines changed

7 files changed

+133
-47
lines changed

‎agent/build/agent.phar‎

0 Bytes
Binary file not shown.

‎agent/build/signature.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
AD9C093DCAF4E29611954BA36EBF7FCBBD756C29195909315C1420D3D60BE625693389D990544484C753473879A520EDB2DB153D5F1A5779925F1449206B981A
1+
88EA194AA44600EDDF6423EF930CCB00DE00D1AC4FC5DA6FEDD26D60573745254FF765AEED2FBC321B74C908DF9C26D5AEC3F59AEBE01869158F4AF03AC1F5E1

‎src/Compatibility.php‎

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22

33
namespace Laravel\Nightwatch;
44

5-
use Illuminate\Contracts\Events\Dispatcher;
65
use Illuminate\Contracts\Foundation\Application;
7-
use Illuminate\Log\Context\Repository;
8-
use Illuminate\Queue\Events\JobProcessing;
9-
use Illuminate\Queue\Queue;
106
use Illuminate\Support\Facades\Context;
117
use ReflectionProperty;
128
use Symfony\Component\Console\Input\ArgvInput;
@@ -95,48 +91,6 @@ public static function boot(Application $app): void
9591
*/
9692
self::$queuedJobDurationCapturable =
9793
version_compare($version, '10.42.0', '>=');
98-
99-
if (self::$contextExists) {
100-
Context::dehydrating(static function (Repository $context) use ($app) {
101-
if (($context->getHidden('nightwatch_user_id') ?? '') === '') {
102-
$context->addHidden('nightwatch_user_id', $app->make(Core::class)->executionState->user->resolvedUserId());
103-
}
104-
});
105-
} else {
106-
Queue::createPayloadUsing(static function ($c, $q, array $payload) use ($app) {
107-
/*
108-
* Dehydrating...
109-
*/
110-
if ((self::$context['nightwatch_user_id'] ?? '') === '') {
111-
self::$context['nightwatch_user_id'] = $app->make(Core::class)->executionState->user->resolvedUserId();
112-
}
113-
114-
return [
115-
...$payload,
116-
'nightwatch' => [
117-
...($payload['nightwatch'] ?? []),
118-
'nightwatch_trace_id' => self::$context['nightwatch_trace_id'] ?? null,
119-
'nightwatch_should_sample' => self::$context['nightwatch_should_sample'] ?? null,
120-
'nightwatch_user_id' => self::$context['nightwatch_user_id'],
121-
],
122-
];
123-
});
124-
125-
/** @var Dispatcher */
126-
$events = $app->make(Dispatcher::class);
127-
$events->listen(static function (JobProcessing $event) {
128-
$nightwatch = $event->job->payload()['nightwatch'] ?? [];
129-
130-
/*
131-
* Hydrating...
132-
*/
133-
self::$context = [
134-
'nightwatch_trace_id' => $nightwatch['nightwatch_trace_id'] ?? null,
135-
'nightwatch_should_sample' => $nightwatch['nightwatch_should_sample'] ?? null,
136-
'nightwatch_user_id' => $nightwatch['nightwatch_user_id'] ?? '',
137-
];
138-
});
139-
}
14094
}
14195

14296
/**

‎src/Hooks/ContextDehydratingHandler.php‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?php
2+
3+
namespace Laravel\Nightwatch\Hooks;
4+
5+
use Illuminate\Log\Context\Repository;
6+
use Laravel\Nightwatch\Core;
7+
use Laravel\Nightwatch\State\CommandState;
8+
use Laravel\Nightwatch\State\RequestState;
9+
use Throwable;
10+
11+
class ContextDehydratingHandler
12+
{
13+
/**
14+
* @param Core<RequestState|CommandState> $nightwatch
15+
*/
16+
public function __construct(
17+
private Core $nightwatch,
18+
) {
19+
//
20+
}
21+
22+
public function __invoke(Repository $context): void
23+
{
24+
try {
25+
if (($context->getHidden('nightwatch_user_id') ?? '') === '') {
26+
$context->addHidden('nightwatch_user_id', $this->nightwatch->executionState->user->resolvedUserId());
27+
}
28+
} catch (Throwable $e) {
29+
$this->nightwatch->report($e);
30+
}
31+
}
32+
}

‎src/Hooks/PolyfillContextDehydration.php‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php
2+
3+
namespace Laravel\Nightwatch\Hooks;
4+
5+
use Laravel\Nightwatch\Compatibility;
6+
use Laravel\Nightwatch\Core;
7+
use Laravel\Nightwatch\State\CommandState;
8+
use Laravel\Nightwatch\State\RequestState;
9+
use Throwable;
10+
11+
class PolyfillContextDehydration
12+
{
13+
/**
14+
* @param Core<RequestState|CommandState> $nightwatch
15+
*/
16+
public function __construct(
17+
private Core $nightwatch,
18+
) {
19+
//
20+
}
21+
22+
/**
23+
* @param array<string, mixed> $payload
24+
* @return array<string, mixed>
25+
*/
26+
public function __invoke(mixed $connection, mixed $queue, array $payload): array
27+
{
28+
$context = Compatibility::$context;
29+
30+
try {
31+
if (($context['nightwatch_user_id'] ?? '') === '') {
32+
$context['nightwatch_user_id'] = $this->nightwatch->executionState->user->resolvedUserId();
33+
}
34+
35+
return [
36+
...$payload,
37+
'nightwatch' => [
38+
...($payload['nightwatch'] ?? []), // @phpstan-ignore arrayUnpacking.nonIterable
39+
'nightwatch_trace_id' => $context['nightwatch_trace_id'] ?? null,
40+
'nightwatch_should_sample' => $context['nightwatch_should_sample'] ?? null,
41+
'nightwatch_user_id' => $context['nightwatch_user_id'],
42+
],
43+
];
44+
} catch (Throwable $e) {
45+
$this->nightwatch->report($e);
46+
47+
return $payload;
48+
}
49+
}
50+
}

‎src/Hooks/PolyfillContextHydration.php‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<?php
2+
3+
namespace Laravel\Nightwatch\Hooks;
4+
5+
use Illuminate\Queue\Events\JobProcessing;
6+
use Laravel\Nightwatch\Compatibility;
7+
use Laravel\Nightwatch\Core;
8+
use Laravel\Nightwatch\State\CommandState;
9+
use Laravel\Nightwatch\State\RequestState;
10+
use Throwable;
11+
12+
class PolyfillContextHydration
13+
{
14+
/**
15+
* @param Core<RequestState|CommandState> $nightwatch
16+
*/
17+
public function __construct(
18+
private Core $nightwatch,
19+
) {
20+
//
21+
}
22+
23+
public function __invoke(JobProcessing $event): void
24+
{
25+
try {
26+
$nightwatch = $event->job->payload()['nightwatch'] ?? [];
27+
28+
Compatibility::$context = [
29+
'nightwatch_trace_id' => $nightwatch['nightwatch_trace_id'] ?? null,
30+
'nightwatch_should_sample' => $nightwatch['nightwatch_should_sample'] ?? null,
31+
'nightwatch_user_id' => $nightwatch['nightwatch_user_id'] ?? '',
32+
];
33+
} catch (Throwable $e) {
34+
$this->nightwatch->report($e);
35+
36+
Compatibility::$context = [];
37+
}
38+
}
39+
}

‎src/NightwatchServiceProvider.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
use Illuminate\Routing\Events\ResponsePrepared;
3838
use Illuminate\Routing\Events\RouteMatched;
3939
use Illuminate\Support\Env;
40+
use Illuminate\Support\Facades\Context;
4041
use Illuminate\Support\ServiceProvider;
4142
use Laravel\Nightwatch\Console\AgentCommand;
4243
use Laravel\Nightwatch\Facades\Nightwatch;
@@ -45,6 +46,7 @@
4546
use Laravel\Nightwatch\Hooks\CacheEventListener;
4647
use Laravel\Nightwatch\Hooks\CommandBootedHandler;
4748
use Laravel\Nightwatch\Hooks\CommandStartingListener;
49+
use Laravel\Nightwatch\Hooks\ContextDehydratingHandler;
4850
use Laravel\Nightwatch\Hooks\ExceptionHandlerResolvedHandler;
4951
use Laravel\Nightwatch\Hooks\GlobalMiddleware;
5052
use Laravel\Nightwatch\Hooks\HttpClientFactoryResolvedHandler;
@@ -54,6 +56,8 @@
5456
use Laravel\Nightwatch\Hooks\MailListener;
5557
use Laravel\Nightwatch\Hooks\NotificationListener;
5658
use Laravel\Nightwatch\Hooks\OctaneListener;
59+
use Laravel\Nightwatch\Hooks\PolyfillContextDehydration;
60+
use Laravel\Nightwatch\Hooks\PolyfillContextHydration;
5761
use Laravel\Nightwatch\Hooks\PreparingResponseListener;
5862
use Laravel\Nightwatch\Hooks\QueryExecutedListener;
5963
use Laravel\Nightwatch\Hooks\QueuedJobListener;
@@ -361,6 +365,13 @@ private function registerHooks(): void
361365
],
362366
]);
363367

368+
if (Compatibility::$contextExists) {
369+
Context::dehydrating(new ContextDehydratingHandler($core));
370+
} else {
371+
Queue::createPayloadUsing(new PolyfillContextDehydration($core));
372+
$events->listen((new PolyfillContextHydration($core))(...));
373+
}
374+
364375
//
365376
// -------------------------------------------------------------------------
366377
// Execution stage hooks

0 commit comments

Comments
 (0)