Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/detect connection outages #29

Merged
merged 4 commits into from
Mar 20, 2024
Merged

Fix/detect connection outages #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd8fdee
fix: detect redis outages
bpolaszek Mar 15, 2024
999511a
feat: immediately ping connection before subscribing
bpolaszek Mar 15, 2024
f3d2dfd
tests(RedisTransportFactoryTest): set pingInterval to 0 so that `Redi…
bpolaszek Mar 15, 2024
c632f1a
tests(RedisTransportTest): set pingInterval to 0 so that `RedisTransp…
bpolaszek Mar 15, 2024
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
3 changes: 3 additions & 0 deletions src/Hub/Transport/Redis/RedisTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Generator;
use React\EventLoop\Loop;
use React\Promise\PromiseInterface;
use RuntimeException;
use Symfony\Component\OptionsResolver\OptionsResolver;

use function Freddie\maybeTimeout;
Expand Down Expand Up @@ -48,8 +49,10 @@ public function __construct(
]);
$this->options = $resolver->resolve($options);
if ($this->options['pingInterval']) {
$this->ping();
Loop::addPeriodicTimer($this->options['pingInterval'], fn () => $this->ping());
}
$this->subscriber->on('unsubscribe', fn () => Hub::die(new RuntimeException('Redis connection lost')));
}

/**
Expand Down
19 changes: 10 additions & 9 deletions tests/Unit/Hub/Transport/Redis/RedisTransportFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
$factory = new RedisTransportFactory();
expect($factory->supports($dsn))->toBe($expected);
})->with(function () {
yield ['redis://localhost', true];
yield ['redis://localhost?pingInterval=0.0', true];
yield ['rediss://some.secure.place.com', true];
yield ['notredis://shrug', false];
});
Expand All @@ -23,21 +23,22 @@
expect($factory->create($dsn))->toEqual($expected);
})->with(function () {
$redisFactory = new Factory();
yield ['redis://localhost?foo=bar', new RedisTransport(
$redisFactory->createLazyClient('redis://localhost?foo=bar'),
$redisFactory->createLazyClient('redis://localhost?foo=bar'),
yield ['redis://localhost?foo=bar&pingInterval=0.0', new RedisTransport(
$redisFactory->createLazyClient('redis://localhost?foo=bar&pingInterval=0.0'),
$redisFactory->createLazyClient('redis://localhost?foo=bar&pingInterval=0.0'),
options: ['pingInterval' => 0.0],
)];
yield ['redis://localhost?size=1000&trimInterval=2.5', new RedisTransport(
$redisFactory->createLazyClient('redis://localhost?size=1000&trimInterval=2.5'),
$redisFactory->createLazyClient('redis://localhost?size=1000&trimInterval=2.5'),
options: ['size' => 1000, 'trimInterval' => 2.5],
yield ['redis://localhost?size=1000&trimInterval=2.5&pingInterval=0.0', new RedisTransport(
$redisFactory->createLazyClient('redis://localhost?size=1000&trimInterval=2.5&pingInterval=0.0'),
$redisFactory->createLazyClient('redis://localhost?size=1000&trimInterval=2.5&pingInterval=0.0'),
options: ['size' => 1000, 'trimInterval' => 2.5, 'pingInterval' => 0.0],
)];
});

it('instantiates 2 different clients', function () {
$factory = new RedisTransportFactory();
/** @var RedisTransport $transport */
$transport = $factory->create('redis://localhost?size=1000');
$transport = $factory->create('redis://localhost?size=1000&pingInterval=0.0');
expect($transport->redis)->toBeInstanceOf(Client::class);
expect($transport->subscriber)->toBeInstanceOf(Client::class);
expect($transport->redis)->not()->toBe($transport->subscriber);
Expand Down
11 changes: 8 additions & 3 deletions tests/Unit/Hub/Transport/Redis/RedisTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@
$eventEmitter = new EventEmitter();
$transport = new RedisTransport(
new RedisClientStub($storage, $eventEmitter),
new RedisClientStub($storage, $eventEmitter)
new RedisClientStub($storage, $eventEmitter),
options: ['pingInterval' => 0.0],
);

// Given
Expand All @@ -40,7 +41,7 @@

it('performs state reconciliation', function () {
$client = new RedisClientStub();
$transport = new RedisTransport($client, clone $client, options: ['size' => 3]);
$transport = new RedisTransport($client, clone $client, options: ['pingInterval' => 0.0, 'size' => 3]);

// Given
$updates = [
Expand Down Expand Up @@ -81,7 +82,11 @@

it('periodically trims the database', function () {
$client = new RedisClientStub();
$transport = new RedisTransport($client, clone $client, options: ['size' => 3, 'trimInterval' => 0.01]);
$transport = new RedisTransport($client, clone $client, options: [
'pingInterval' => 0.0,
'size' => 3,
'trimInterval' => 0.01
]);

// Given
$updates = [
Expand Down
Loading