123 ]; } ], [ 'evaluates multiple locators', // expected result [ [ 123 ], [ 456 ] ], // event user locator config [ function () { return [ 123 => 123 ]; }, function () { return [ 456 => 456 ]; }, ], ], [ 'Passes parameters to locateFromEventExtra in expected manner', // expected result [ [ 123 ] ], // event user locator config [ [ [ EchoUserLocator::class, 'locateFromEventExtra' ], [ 'other-user' ] ], ], // additional setup function ( $test, $event ) { $event->expects( $test->any() ) ->method( 'getExtraParam' ) ->with( 'other-user' ) ->will( $test->returnValue( 123 ) ); } ], ]; } /** * @dataProvider evaluateUserLocatorsProvider */ public function testEvaluateUserLocators( $message, $expect, $locatorConfigForEventType, $setup = null ) { $this->setMwGlobals( [ 'wgEchoNotifications' => [ 'unit-test' => [ EchoAttributeManager::ATTR_LOCATORS => $locatorConfigForEventType ], ], ] ); $event = $this->getMockBuilder( EchoEvent::class ) ->disableOriginalConstructor() ->getMock(); $event->expects( $this->any() ) ->method( 'getType' ) ->will( $this->returnValue( 'unit-test' ) ); if ( $setup !== null ) { $setup( $this, $event ); } $result = EchoNotificationController::evaluateUserCallable( $event, EchoAttributeManager::ATTR_LOCATORS ); $this->assertEquals( $expect, array_map( 'array_keys', $result ), $message ); } public function testEvaluateUserLocatorPassesParameters() { $test = $this; $callback = function ( $event, $firstOption, $secondOption ) use ( $test ) { $test->assertInstanceOf( EchoEvent::class, $event ); $test->assertEquals( 'first', $firstOption ); $test->assertEquals( 'second', $secondOption ); return []; }; self::testEvaluateUserLocators( __FUNCTION__, [ [] ], [ [ $callback, 'first', 'second' ] ] ); } public function getUsersToNotifyForEventProvider() { return [ [ 'Filters anonymous users', // expected result [], // users returned from locator [ User::newFromName( '4.5.6.7', false ) ], ], [ 'Filters duplicate users', // expected result [ 123 ], // users returned from locator [ User::newFromId( 123 ), User::newFromId( 123 ) ], ], [ 'Filters non-user objects', // expected result [ 123 ], // users returned from locator [ null, 'foo', User::newFromId( 123 ), (object)[], 456 ], ], ]; } /** * @dataProvider getUsersToNotifyForEventProvider */ public function testGetUsersToNotifyForEvent( $message, $expect, $users ) { $this->setMwGlobals( [ 'wgEchoNotifications' => [ 'unit-test' => [ EchoAttributeManager::ATTR_LOCATORS => function () use ( $users ) { return $users; }, ], ], ] ); $event = $this->getMockBuilder( EchoEvent::class ) ->disableOriginalConstructor() ->getMock(); $event->expects( $this->any() ) ->method( 'getType' ) ->will( $this->returnValue( 'unit-test' ) ); $result = EchoNotificationController::getUsersToNotifyForEvent( $event ); $ids = []; foreach ( $result as $user ) { $ids[] = $user->getId(); } $this->assertEquals( $expect, $ids, $message ); } public function testDoesNotDeliverDisabledEvent() { $event = $this->getMockBuilder( EchoEvent::class ) ->disableOriginalConstructor() ->getMock(); $event->expects( $this->any() ) ->method( 'isEnabledEvent' ) ->will( $this->returnValue( false ) ); // Assume it would have to check the event type to // determine how to deliver $event->expects( $this->never() ) ->method( 'getType' ); EchoNotificationController::notify( $event, false ); } public static function getEventNotifyTypesProvider() { return [ [ 'Selects the `all` configuration by default', // expected result [ 'web' ], // event type 'bar', // default notification types configuration [ 'web' => true ], // per-category notification type availability [ 'f' => [ 'email' => true ] ], // event types [ 'foo' => [ 'category' => 'f', ], 'bar' => [ 'category' => 'b', ] ], ], [ 'Overrides `all` configuration with event category configuration', // expected result [ 'web' ], // event type 'foo', // default notification types configuration [ 'web' => true, 'email' => true ], // per-category notification type availability [ 'f' => [ 'email' => false ], 'b' => [ 'sms' => true ], ], // event types [ 'foo' => [ 'category' => 'f', ], 'bar' => [ 'category' => 'b', ], ], ] ]; } /** * @dataProvider getEventNotifyTypesProvider */ public function testGetEventNotifyTypes( $message, $expect, $type, array $defaultNotifyTypeAvailability, array $notifyTypeAvailabilityByCategory, array $notifications ) { $this->setMwGlobals( [ 'wgDefaultNotifyTypeAvailability' => $defaultNotifyTypeAvailability, 'wgNotifyTypeAvailabilityByCategory' => $notifyTypeAvailabilityByCategory, 'wgEchoNotifications' => $notifications, 'wgEchoNotificationCategories' => array_fill_keys( array_keys( $notifyTypeAvailabilityByCategory ), [ 'priority' => 4 ] ), ] ); $result = EchoNotificationController::getEventNotifyTypes( $type ); $this->assertEquals( $expect, $result, $message ); } public function testEnqueueEvent() { $event = $this->getMockBuilder( EchoEvent::class ) ->disableOriginalConstructor() ->getMock(); $event->expects( $this->any() ) ->method( 'getExtraParam' ) ->will( $this->returnValue( null ) ); $event->expects( $this->exactly( 1 ) ) ->method( 'getTitle' ) ->will( $this->returnValue( Title::newFromText( 'test-title' ) ) ); $event->expects( $this->exactly( 1 ) ) ->method( 'getId' ) ->will( $this->returnValue( 42 ) ); EchoNotificationController::enqueueEvent( $event ); $queues = JobQueueGroup::singleton()->getQueuesWithJobs(); $this->assertCount( 1, $queues ); $this->assertEquals( 'EchoNotificationJob', $queues[0] ); $job = JobQueueGroup::singleton()->pop( 'EchoNotificationJob' ); $this->assertEquals( 'Test-title', $job->params[ 'title' ] ); $this->assertEquals( 42, $job->params[ 'eventId' ] ); } public function testEventParams() { $rootJobTimestamp = wfTimestamp(); MWTimestamp::setFakeTime( 0 ); $event = $this->getMockBuilder( EchoEvent::class ) ->disableOriginalConstructor() ->getMock(); $event->expects( $this->any() ) ->method( 'getExtraParam' ) ->will( $this->returnValueMap( [ [ 'delay', null, 10 ], [ 'rootJobSignature', null, 'test-signature' ], [ 'rootJobTimestamp', null, $rootJobTimestamp ] ] ) ); $event->expects( $this->exactly( 1 ) ) ->method( 'getId' ) ->will( $this->returnValue( 42 ) ); $params = EchoNotificationController::getEventParams( $event ); $expectedParams = [ 'eventId' => 42, 'rootJobSignature' => 'test-signature', 'rootJobTimestamp' => $rootJobTimestamp, 'jobReleaseTimestamp' => 10 ]; $this->assertArrayEquals( $expectedParams, $params ); } }