makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-08 04:18:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/17010] Properly handle expired subscriptions and extend tests

Browse source 
PHPBB3-17010
This commit is contained in:
Marc Alexander 2024-03-01 19:40:26 +01:00
parent 93a6b8d87a
commit fcfed79385
No known key found for this signature in database
GPG key ID: 50E0D2423696F995
3 changed files with 169 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
phpBB/phpbb/notification/method/webpush.php
View file

@ -253,7 +253,7 @@ class webpush extends messenger_base implements extended_method_interface
// Fill array of endpoints to remove if subscription has expired // Fill array of endpoints to remove if subscription has expired
if ($report->isSubscriptionExpired()) if ($report->isSubscriptionExpired())
{ {
$expired_endpoints = $report->getEndpoint(); $expired_endpoints[] = $report->getEndpoint();
} }
else else
{ {
@ -415,11 +415,14 @@ class webpush extends messenger_base implements extended_method_interface
$remove_subscriptions = []; $remove_subscriptions = [];
foreach ($expired_endpoints as $endpoint) foreach ($expired_endpoints as $endpoint)
{ {
foreach ($user_subscription_map as $user_id => $subscriptions) foreach ($user_subscription_map as $subscriptions)
{ {
if (isset($subscriptions['endpoint']) && $subscriptions['endpoint'] == $endpoint) foreach ($subscriptions as $subscription)
{ {
$remove_subscriptions[] = $subscriptions[$endpoint]['subscription_id']; if (isset($subscription['endpoint']) && $subscription['endpoint'] == $endpoint)
{
$remove_subscriptions[] = $subscription['subscription_id'];
}
} }
} }
} }

2
tests/notification/fixtures/webpush_notification.type.post.xml
View file

@ -1,5 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<dataset> <dataset>
<table name="phpbb_log">
</table>
<table name="phpbb_forums_watch"> <table name="phpbb_forums_watch">
<column>forum_id</column> <column>forum_id</column>
<column>user_id</column> <column>user_id</column>

165
tests/notification/notification_method_webpush_test.php
View file

@ -406,7 +406,7 @@ class notification_method_webpush_test extends phpbb_tests_notification_base
foreach ($expected_users as $user_id => $data) foreach ($expected_users as $user_id => $data)
{ {
$messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']); $messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']);
$this->assertNotEmpty($messages); $this->assertNotEmpty($messages, 'Failed asserting that user ' . $user_id . ' has received messages.');
} }
} }
@ -438,10 +438,10 @@ class notification_method_webpush_test extends phpbb_tests_notification_base
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options); $notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals(0, count($notified_users), 'Assert no user has been notified yet'); $this->assertEquals(0, count($notified_users), 'Assert no user has been notified yet');
$this->notifications->add_notifications($notification_type, $post_data); $this->notification_method_webpush->notify(); // should have no effect
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options); $notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals($expected_users, $notified_users, 'Assert that expected users have been notified'); $this->assertEquals(0, count($notified_users), 'Assert no user has been notified yet');
$post_data['post_id']++; $post_data['post_id']++;
$notification_options['item_id'] = $post_data['post_id']; $notification_options['item_id'] = $post_data['post_id'];
@ -504,7 +504,7 @@ class notification_method_webpush_test extends phpbb_tests_notification_base
foreach ($expected_users as $user_id => $data) foreach ($expected_users as $user_id => $data)
{ {
$messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']); $messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']);
$this->assertNotEmpty($messages); $this->assertNotEmpty($messages, 'Failed asserting that user ' . $user_id . ' has received messages.');
} }
if (isset($first_user_sub)) if (isset($first_user_sub))
@ -520,11 +520,139 @@ class notification_method_webpush_test extends phpbb_tests_notification_base
} }
} }
/**
* @dataProvider data_notification_webpush
*/
public function test_notify_expired($notification_type, $post_data, $expected_users)
{
$subscription_info = [];
foreach ($expected_users as $user_id => $user_data)
{
$subscription_info[$user_id][] = $this->create_subscription_for_user($user_id);
}
$expected_delivered_users = $expected_users;
// Expire subscriptions for first user
if (count($expected_users))
{
$first_user_id = array_key_first($expected_users);
$first_user_subs = $subscription_info[$first_user_id];
unset($expected_delivered_users[$first_user_id]);
$this->expire_subscription($first_user_subs[0]['clientHash']);
}
$post_data = array_merge([
'post_time' => 1349413322,
'poster_id' => 1,
'topic_title' => '',
'post_subject' => '',
'post_username' => '',
'forum_name' => '',
],
$post_data);
$notification_options = [
'item_id' => $post_data['post_id'],
'item_parent_id' => $post_data['topic_id'],
];
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals(0, count($notified_users), 'Assert no user has been notified yet');
foreach ($expected_delivered_users as $user_id => $data)
{
$messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']);
$this->assertEmpty($messages);
}
$this->notifications->add_notifications($notification_type, $post_data);
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals($expected_users, $notified_users, 'Assert that expected users have been notified');
foreach ($expected_delivered_users as $user_id => $data)
{
$messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']);
$this->assertNotEmpty($messages, 'Failed asserting that user ' . $user_id . ' has received messages.');
}
}
public function test_get_type(): void public function test_get_type(): void
{ {
$this->assertEquals('notification.method.webpush', $this->notification_method_webpush->get_type()); $this->assertEquals('notification.method.webpush', $this->notification_method_webpush->get_type());
} }
/**
* @dataProvider data_notification_webpush
*/
public function test_prune_notifications($notification_type, $post_data, $expected_users): void
{
$subscription_info = [];
foreach ($expected_users as $user_id => $user_data)
{
$subscription_info[$user_id][] = $this->create_subscription_for_user($user_id);
}
// Create second subscription for first user ID passed
if (count($expected_users))
{
$first_user_id = array_key_first($expected_users);
$subscription_info[$first_user_id][] = $this->create_subscription_for_user($first_user_id);
}
$post_data = array_merge([
'post_time' => 1349413322,
'poster_id' => 1,
'topic_title' => '',
'post_subject' => '',
'post_username' => '',
'forum_name' => '',
],
$post_data);
$notification_options = [
'item_id' => $post_data['post_id'],
'item_parent_id' => $post_data['topic_id'],
];
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals(0, count($notified_users), 'Assert no user has been notified yet');
foreach ($expected_users as $user_id => $data)
{
$messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']);
$this->assertEmpty($messages);
}
$this->notifications->add_notifications($notification_type, $post_data);
$notified_users = $this->notification_method_webpush->get_notified_users($this->notifications->get_notification_type_id($notification_type), $notification_options);
$this->assertEquals($expected_users, $notified_users, 'Assert that expected users have been notified');
foreach ($expected_users as $user_id => $data)
{
$messages = $this->get_messages_for_subscription($subscription_info[$user_id][0]['clientHash']);
$this->assertNotEmpty($messages, 'Failed asserting that user ' . $user_id . ' has received messages.');
}
// Prune notifications with 0 time, shouldn't change anything
$prune_time = time();
$this->notification_method_webpush->prune_notifications(0);
$this->assertGreaterThanOrEqual($prune_time, $this->config->offsetGet('read_notification_last_gc'), 'Assert that prune time was set');
$cur_notifications = $this->get_notifications();
$this->assertSameSize($cur_notifications, $expected_users, 'Assert that no notifications have been pruned');
// Prune only read not supported, will prune all
$this->notification_method_webpush->prune_notifications($prune_time);
$this->assertGreaterThanOrEqual($prune_time, $this->config->offsetGet('read_notification_last_gc'), 'Assert that prune time was set');
$cur_notifications = $this->get_notifications();
$this->assertCount(0, $cur_notifications, 'Assert that no notifications have been pruned');
}
protected function create_subscription_for_user($user_id, bool $invalidate_endpoint = false): array protected function create_subscription_for_user($user_id, bool $invalidate_endpoint = false): array
{ {
$client = new \GuzzleHttp\Client(); $client = new \GuzzleHttp\Client();
@ -563,6 +691,22 @@ class notification_method_webpush_test extends phpbb_tests_notification_base
return $subscription_data; return $subscription_data;
} }
protected function expire_subscription(string $client_hash): void
{
$client = new \GuzzleHttp\Client();
try
{
$response = $client->request('POST', 'http://localhost:9012/expire-subscription/' . $client_hash);
}
catch (\GuzzleHttp\Exception\GuzzleException $exception)
{
$this->fail('Failed expiring subscription with web-push-testing client: ' . $exception->getMessage());
}
$subscription_return = \phpbb\json\sanitizer::decode((string) $response->getBody());
$this->assertEquals(200, $response->getStatusCode(), 'Expected response status to be 200');
}
protected function get_messages_for_subscription($client_hash): array protected function get_messages_for_subscription($client_hash): array
{ {
$client = new \GuzzleHttp\Client(); $client = new \GuzzleHttp\Client();
@ -574,7 +718,7 @@ class notification_method_webpush_test extends phpbb_tests_notification_base
} }
catch (\GuzzleHttp\Exception\GuzzleException $exception) catch (\GuzzleHttp\Exception\GuzzleException $exception)
{ {
$this->fail('Failed getting messages from web-push-testing client'); $this->fail('Failed getting messages from web-push-testing client: ' . $exception->getMessage());
} }
$response_data = json_decode($response->getBody()->getContents(), true); $response_data = json_decode($response->getBody()->getContents(), true);
@ -584,4 +728,15 @@ class notification_method_webpush_test extends phpbb_tests_notification_base
return $response_data['data']['messages']; return $response_data['data']['messages'];
} }
protected function get_notifications(): array
{
$webpush_table = $this->container->getParameter('tables.notification_push');
$sql = 'SELECT * FROM ' . $webpush_table;
$result = $this->db->sql_query($sql);
$sql_ary = $this->db->sql_fetchrowset($result);
$this->db->sql_freeresult($result);
return $sql_ary;
}
} }