wikimedia/mediawiki-extensions-Echo
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo synced 2024-11-25 00:05:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Echo/tests/phpunit/integration/Push/SubscriptionManagerTest.php

48 lines
1.8 KiB
PHP
Raw Normal View History

Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
<?php
Create push subscription manager group/right to clean up dead subs Creates a new push-subscription-manager group and an associated right, manage-all-push-subscriptions. The purpose of this is to allow privileged accounts to purge expired subscriptions from the database on behalf of other users. A user with this right will be permitted to delete any subscription from the DB based on the token alone. For all other users, deletion requests will be limited to those associated with the requesting user's central ID. This right will be granted to a bot account on Metawiki associated with the Wikimedia push notifications service, and the push notifications service account will make push subscription delete requests to the API for subscriptions for which vendor APIs return bad subscription responses. Additionally, the providertoken parameter to ApiPushSubscriptionDelete is updated to allow multiple providertoken values. Bug: T259148 Change-Id: Ia6c17588ee94e6be74e5e3a75eb33e38f172fc93
2020-08-11 20:34:21 +00:00
use EchoPush\Utils;
Create and enforce a config setting for max subscriptions per user Creates a EchoPushMaxSubscriptionsPerUser config setting (default: 0) that controls the maximum number of subscriptions a user may associate with the user's central user ID. The setting is enforced in EchoPush\SubscriptionManager::create(). To allow creating push subscriptions for development, set $wgEchoPushMaxSubscriptionsPerUser to a positive integer value in LocalSettings.php: $wgEchoPushMaxSubscriptionsPerUser = 10; Bug: T259150 Change-Id: Ib97b6b6cbb8161dd75dad92c54b4fe4fff80c421
2020-08-12 21:33:06 +00:00
use Wikimedia\TestingAccessWrapper;
Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
/**
* @group Database
* @covers \EchoPush\SubscriptionManager
*/
Add push notifier Provides a basic push notifier implementation. Since the push service is not yet in place, all it does for now is log debug output when a notification is to be sent. To register the push notifier, add the following configuration to LocalSettings.php: $wgEchoNotifiers['push'] = [ 'EchoPush\\PushNotifier', 'notifyWithPush' ]; $wgDefaultNotifyTypeAvailability['push'] = true; $wgNotifyTypeAvailabilityByCategory['system']['push'] = false; $wgNotifyTypeAvailabilityByCategory['system-noemail']['push'] = false; We'll register the notifier in configuration for now, rather than hard-coding the default in extension.json, in order to have control over when and where it rolls out (beta vs. prod, as well as which wikis). Since the push notifier implementation depends on jobs being processed by the job queue, I also recommend adding the following configuration setting to ensure that all pending jobs are processed at the end of each web request: // ensure all pending jobs are processed when a web request completes $wgJobRunRate = PHP_INT_MAX; Bug: T252899 Change-Id: Ie7f222443045d30620ff297b006104ef18a074a8
2020-05-22 22:02:34 +00:00
class SubscriptionManagerTest extends MediaWikiIntegrationTestCase {
Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
public function setUp(): void {
parent::setUp();
$this->tablesUsed[] = 'echo_push_subscription';
$this->tablesUsed[] = 'echo_push_provider';
Create and enforce a config setting for max subscriptions per user Creates a EchoPushMaxSubscriptionsPerUser config setting (default: 0) that controls the maximum number of subscriptions a user may associate with the user's central user ID. The setting is enforced in EchoPush\SubscriptionManager::create(). To allow creating push subscriptions for development, set $wgEchoPushMaxSubscriptionsPerUser to a positive integer value in LocalSettings.php: $wgEchoPushMaxSubscriptionsPerUser = 10; Bug: T259150 Change-Id: Ib97b6b6cbb8161dd75dad92c54b4fe4fff80c421
2020-08-12 21:33:06 +00:00
$this->setMwGlobals( 'wgEchoPushMaxSubscriptionsPerUser', 1 );
Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
}
public function testManagePushSubscriptions(): void {
Create and enforce a config setting for max subscriptions per user Creates a EchoPushMaxSubscriptionsPerUser config setting (default: 0) that controls the maximum number of subscriptions a user may associate with the user's central user ID. The setting is enforced in EchoPush\SubscriptionManager::create(). To allow creating push subscriptions for development, set $wgEchoPushMaxSubscriptionsPerUser to a positive integer value in LocalSettings.php: $wgEchoPushMaxSubscriptionsPerUser = 10; Bug: T259150 Change-Id: Ib97b6b6cbb8161dd75dad92c54b4fe4fff80c421
2020-08-12 21:33:06 +00:00
$subscriptionManagerBase = EchoServices::getInstance()->getPushSubscriptionManager();
$subscriptionManager = TestingAccessWrapper::newFromObject( $subscriptionManagerBase );
Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
$user = $this->getTestUser()->getUser();
Create push subscription manager group/right to clean up dead subs Creates a new push-subscription-manager group and an associated right, manage-all-push-subscriptions. The purpose of this is to allow privileged accounts to purge expired subscriptions from the database on behalf of other users. A user with this right will be permitted to delete any subscription from the DB based on the token alone. For all other users, deletion requests will be limited to those associated with the requesting user's central ID. This right will be granted to a bot account on Metawiki associated with the Wikimedia push notifications service, and the push notifications service account will make push subscription delete requests to the API for subscriptions for which vendor APIs return bad subscription responses. Additionally, the providertoken parameter to ApiPushSubscriptionDelete is updated to allow multiple providertoken values. Bug: T259148 Change-Id: Ia6c17588ee94e6be74e5e3a75eb33e38f172fc93
2020-08-11 20:34:21 +00:00
$centralId = Utils::getPushUserId( $user );
Create and enforce a config setting for max subscriptions per user Creates a EchoPushMaxSubscriptionsPerUser config setting (default: 0) that controls the maximum number of subscriptions a user may associate with the user's central user ID. The setting is enforced in EchoPush\SubscriptionManager::create(). To allow creating push subscriptions for development, set $wgEchoPushMaxSubscriptionsPerUser to a positive integer value in LocalSettings.php: $wgEchoPushMaxSubscriptionsPerUser = 10; Bug: T259150 Change-Id: Ib97b6b6cbb8161dd75dad92c54b4fe4fff80c421
2020-08-12 21:33:06 +00:00
Create push subscription manager group/right to clean up dead subs Creates a new push-subscription-manager group and an associated right, manage-all-push-subscriptions. The purpose of this is to allow privileged accounts to purge expired subscriptions from the database on behalf of other users. A user with this right will be permitted to delete any subscription from the DB based on the token alone. For all other users, deletion requests will be limited to those associated with the requesting user's central ID. This right will be granted to a bot account on Metawiki associated with the Wikimedia push notifications service, and the push notifications service account will make push subscription delete requests to the API for subscriptions for which vendor APIs return bad subscription responses. Additionally, the providertoken parameter to ApiPushSubscriptionDelete is updated to allow multiple providertoken values. Bug: T259148 Change-Id: Ia6c17588ee94e6be74e5e3a75eb33e38f172fc93
2020-08-11 20:34:21 +00:00
$subscriptionManager->create( 'test', 'ABC123', $centralId );
Add push notifier Provides a basic push notifier implementation. Since the push service is not yet in place, all it does for now is log debug output when a notification is to be sent. To register the push notifier, add the following configuration to LocalSettings.php: $wgEchoNotifiers['push'] = [ 'EchoPush\\PushNotifier', 'notifyWithPush' ]; $wgDefaultNotifyTypeAvailability['push'] = true; $wgNotifyTypeAvailabilityByCategory['system']['push'] = false; $wgNotifyTypeAvailabilityByCategory['system-noemail']['push'] = false; We'll register the notifier in configuration for now, rather than hard-coding the default in extension.json, in order to have control over when and where it rolls out (beta vs. prod, as well as which wikis). Since the push notifier implementation depends on jobs being processed by the job queue, I also recommend adding the following configuration setting to ensure that all pending jobs are processed at the end of each web request: // ensure all pending jobs are processed when a web request completes $wgJobRunRate = PHP_INT_MAX; Bug: T252899 Change-Id: Ie7f222443045d30620ff297b006104ef18a074a8
2020-05-22 22:02:34 +00:00
$subscriptions = $subscriptionManager->getSubscriptionsForUser( $centralId );
Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
$this->assertCount( 1, $subscriptions );
Create and enforce a config setting for max subscriptions per user Creates a EchoPushMaxSubscriptionsPerUser config setting (default: 0) that controls the maximum number of subscriptions a user may associate with the user's central user ID. The setting is enforced in EchoPush\SubscriptionManager::create(). To allow creating push subscriptions for development, set $wgEchoPushMaxSubscriptionsPerUser to a positive integer value in LocalSettings.php: $wgEchoPushMaxSubscriptionsPerUser = 10; Bug: T259150 Change-Id: Ib97b6b6cbb8161dd75dad92c54b4fe4fff80c421
2020-08-12 21:33:06 +00:00
$this->assertTrue( $subscriptionManager->userHasMaxAllowedSubscriptions( $centralId ) );
Create push subscription manager group/right to clean up dead subs Creates a new push-subscription-manager group and an associated right, manage-all-push-subscriptions. The purpose of this is to allow privileged accounts to purge expired subscriptions from the database on behalf of other users. A user with this right will be permitted to delete any subscription from the DB based on the token alone. For all other users, deletion requests will be limited to those associated with the requesting user's central ID. This right will be granted to a bot account on Metawiki associated with the Wikimedia push notifications service, and the push notifications service account will make push subscription delete requests to the API for subscriptions for which vendor APIs return bad subscription responses. Additionally, the providertoken parameter to ApiPushSubscriptionDelete is updated to allow multiple providertoken values. Bug: T259148 Change-Id: Ia6c17588ee94e6be74e5e3a75eb33e38f172fc93
2020-08-11 20:34:21 +00:00
$subscriptionManager->delete( [ 'ABC123' ], $centralId );
$subscriptions = $subscriptionManager->getSubscriptionsForUser( $centralId );
$this->assertCount( 0, $subscriptions );
$this->assertFalse( $subscriptionManager->userHasMaxAllowedSubscriptions( $centralId ) );
$subscriptionManager->create( 'test', 'ABC123', $centralId );
$subscriptions = $subscriptionManager->getSubscriptionsForUser( $centralId );
$this->assertCount( 1, $subscriptions );
$this->assertTrue( $subscriptionManager->userHasMaxAllowedSubscriptions( $centralId ) );
$subscriptionManager->delete( [ 'ABC123' ] );
Add push notifier Provides a basic push notifier implementation. Since the push service is not yet in place, all it does for now is log debug output when a notification is to be sent. To register the push notifier, add the following configuration to LocalSettings.php: $wgEchoNotifiers['push'] = [ 'EchoPush\\PushNotifier', 'notifyWithPush' ]; $wgDefaultNotifyTypeAvailability['push'] = true; $wgNotifyTypeAvailabilityByCategory['system']['push'] = false; $wgNotifyTypeAvailabilityByCategory['system-noemail']['push'] = false; We'll register the notifier in configuration for now, rather than hard-coding the default in extension.json, in order to have control over when and where it rolls out (beta vs. prod, as well as which wikis). Since the push notifier implementation depends on jobs being processed by the job queue, I also recommend adding the following configuration setting to ensure that all pending jobs are processed at the end of each web request: // ensure all pending jobs are processed when a web request completes $wgJobRunRate = PHP_INT_MAX; Bug: T252899 Change-Id: Ie7f222443045d30620ff297b006104ef18a074a8
2020-05-22 22:02:34 +00:00
$subscriptions = $subscriptionManager->getSubscriptionsForUser( $centralId );
Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
$this->assertCount( 0, $subscriptions );
Create and enforce a config setting for max subscriptions per user Creates a EchoPushMaxSubscriptionsPerUser config setting (default: 0) that controls the maximum number of subscriptions a user may associate with the user's central user ID. The setting is enforced in EchoPush\SubscriptionManager::create(). To allow creating push subscriptions for development, set $wgEchoPushMaxSubscriptionsPerUser to a positive integer value in LocalSettings.php: $wgEchoPushMaxSubscriptionsPerUser = 10; Bug: T259150 Change-Id: Ib97b6b6cbb8161dd75dad92c54b4fe4fff80c421
2020-08-12 21:33:06 +00:00
$this->assertFalse( $subscriptionManager->userHasMaxAllowedSubscriptions( $centralId ) );
Add push subscription management Adds DB tables for storing push subscriptions, some DB interaction code for retrieving them within MediaWiki, and a set of API modules for managing them from the outside world. When testing this patch, be sure to run maintenance/update.php to create the new tables, and set $wgEchoEnablePush = true in LocalSettings.php to enable the API new API module. N.B. The current DB schema is centered on app push subscriptions. Web push subscriptions require slightly different handling, since they are provided by browsers as a JSON blob rather than a token string. How to handle web push subscriptions is a question we can defer until the time comes to add web push support. Subscription data is stored in the echo_push_subscription table, with provider names normalized into the echo_push_provider table. We expect to be looking up subscriptions by central user ID, so that column is indexed. The subscription data also includes a column to store SHA256 digests of the subscriber tokens. This is for use as a unique key constraint, since we expect every push token to be univerally unique, and the token values themselves may be too large to reasonably index in MySQL. Bug: T252899 Change-Id: I3928761b3fba12e54ff4850e9a05c68ec7772f62
2020-05-15 17:19:03 +00:00
}
}
Reference in a new issue Copy permalink