diff --git a/lib/Newsletter/Scheduler/Scheduler.php b/lib/Newsletter/Scheduler/Scheduler.php index de50981fbf..f7ee0d3dc3 100644 --- a/lib/Newsletter/Scheduler/Scheduler.php +++ b/lib/Newsletter/Scheduler/Scheduler.php @@ -96,7 +96,7 @@ class Scheduler { $queue->setSubscribers(array($subscriber_id)); $queue->status = SendingQueue::STATUS_SCHEDULED; $queue->priority = SendingQueue::PRIORITY_HIGH; - $queue->scheduled_at = self::getScheduledTimeForWelcomeOrAutomaticEmails( + $queue->scheduled_at = self::getScheduledTimeForWelcomeNotificationOrAutomaticEmail( $newsletter->afterTimeType, $newsletter->afterTimeNumber ); @@ -114,7 +114,7 @@ class Scheduler { } $queue->status = SendingQueue::STATUS_SCHEDULED; $queue->priority = SendingQueue::PRIORITY_MEDIUM; - $queue->scheduled_at = self::getScheduledTimeForWelcomeNotificationOrAutomaticEmails( + $queue->scheduled_at = self::getScheduledTimeForWelcomeNotificationOrAutomaticEmail( $newsletter->afterTimeType, $newsletter->afterTimeNumber ); @@ -221,7 +221,7 @@ class Scheduler { return Carbon::parse($datetime_string)->format('Y-m-d H:i:s'); } - static function getScheduledTimeForWelcomeNotificationOrAutomaticEmails($after_time_type, $after_time_number) { + static function getScheduledTimeForWelcomeNotificationOrAutomaticEmail($after_time_type, $after_time_number) { $current_time = Carbon::createFromTimestamp(WPFunctions::currentTime('timestamp')); switch($after_time_type) { case 'hours': diff --git a/tests/unit/Newsletter/Scheduler/SchedulerTest.php b/tests/unit/Newsletter/Scheduler/SchedulerTest.php index 2d77acac5e..9c3954340f 100644 --- a/tests/unit/Newsletter/Scheduler/SchedulerTest.php +++ b/tests/unit/Newsletter/Scheduler/SchedulerTest.php @@ -2,13 +2,16 @@ namespace MailPoet\Test\Newsletter\Scheduler; use Carbon\Carbon; +use Codeception\Util\Fixtures; use Mailpoet\Config\Hooks; use MailPoet\Models\Newsletter; use MailPoet\Models\NewsletterOption; use MailPoet\Models\NewsletterOptionField; use MailPoet\Models\NewsletterPost; use MailPoet\Models\ScheduledTask; +use MailPoet\Models\ScheduledTaskSubscriber; use MailPoet\Models\SendingQueue; +use MailPoet\Models\Subscriber; use MailPoet\Newsletter\Scheduler\Scheduler; use MailPoet\Tasks\Sending as SendingTask; use MailPoet\WP\Posts as WPPosts; @@ -26,7 +29,7 @@ class SchedulerTest extends \MailPoetTest { expect(Scheduler::INTERVAL_NTHWEEKDAY)->notEmpty(); } - function testItGetsActiveNewslettersFilteredByType() { + function testItGetsActiveNewslettersFilteredByTypeAndGroup() { $newsletter = $this->_createNewsletter($type = Newsletter::TYPE_WELCOME); // no newsletters with type "notification" should be found @@ -34,6 +37,19 @@ class SchedulerTest extends \MailPoetTest { // one newsletter with type "welcome" should be found expect(Scheduler::getNewsletters(Newsletter::TYPE_WELCOME))->count(1); + + // one automatic email belonging to "test" group should be found + $newsletter = $this->_createNewsletter($type = Newsletter::TYPE_AUTOMATIC); + $this->_createNewsletterOptions( + $newsletter->id, + Newsletter::TYPE_AUTOMATIC, + array( + 'group' => 'test' + ) + ); + + expect(Scheduler::getNewsletters(Newsletter::TYPE_AUTOMATIC, 'group_does_not_exist'))->isEmpty(); + expect(Scheduler::getNewsletters(Newsletter::TYPE_WELCOME, 'test'))->count(1); } function testItCanGetNextRunDate() { @@ -438,11 +454,130 @@ class SchedulerTest extends \MailPoetTest { ->equals('2017-01-01 13:01:00'); } + function testItCreatesAutomaticEmailQueueRecordWithSubscriberAndMeta() { + $newsletter = $this->_createNewsletter(Newsletter::TYPE_AUTOMATIC); + $this->_createNewsletterOptions( + $newsletter->id, + Newsletter::TYPE_AUTOMATIC, + array( + 'sendTo' => 'user', + 'afterTimeType' => 'hours', + 'afterTimeNumber' => 2 + ) + ); + $newsletter = Newsletter::filter('filterWithOptions')->findOne($newsletter->id); + $subscriber = Subscriber::create(); + $subscriber->hydrate(Fixtures::get('subscriber_template')); + $subscriber->save(); + $meta = array('some' => 'value'); + + Scheduler::createAutomaticEmailQueue($newsletter, $subscriber->id, $meta); + // new queue record should be created with meta data + $queue = SendingQueue::where('newsletter_id', $newsletter->id)->findOne(); + expect($queue->getMeta())->equals($meta); + // new scheduled task should be created with 1 subscriber + $task = $queue->getTasks()->findOne(); + $current_time = Carbon::createFromTimestamp(current_time('timestamp')); + expect($task->id)->greaterOrEquals(1); + expect($task->priority)->equals(SendingQueue::PRIORITY_MEDIUM); + expect($task->status)->equals(SendingQueue::STATUS_SCHEDULED); + expect(Carbon::parse($task->scheduled_at)->format('Y-m-d H:i')) + ->equals($current_time->addHours(2)->format('Y-m-d H:i')); + // task should have 1 subscriber + $subscribers = $task->subscribers()->findMany(); + expect($subscribers)->count(1); + expect($subscribers[0]->id)->equals($subscriber->id); + } + + function testItCreatesAutomaticEmailQueueRecord() { + $newsletter = $this->_createNewsletter(Newsletter::TYPE_AUTOMATIC); + $this->_createNewsletterOptions( + $newsletter->id, + Newsletter::TYPE_AUTOMATIC, + array( + 'sendTo' => 'segment', + 'afterTimeType' => 'hours', + 'afterTimeNumber' => 2 + ) + ); + $newsletter = Newsletter::filter('filterWithOptions')->findOne($newsletter->id); + + Scheduler::createAutomaticEmailQueue($newsletter, $subscriber = null, $meta = null); + // new queue record should be created without meta + $queue = SendingQueue::where('newsletter_id', $newsletter->id)->findOne(); + expect($queue->getMeta())->isEmpty(); + // new scheduled task should be created + $task = $queue->getTasks()->findOne(); + $current_time = Carbon::createFromTimestamp(current_time('timestamp')); + expect($task->id)->greaterOrEquals(1); + expect($task->priority)->equals(SendingQueue::PRIORITY_MEDIUM); + expect($task->status)->equals(SendingQueue::STATUS_SCHEDULED); + expect(Carbon::parse($task->scheduled_at)->format('Y-m-d H:i')) + ->equals($current_time->addHours(2)->format('Y-m-d H:i')); + // task should not have any subscribers + $subscribers = $task->subscribers()->findMany(); + expect($subscribers)->count(0); + } + + function testItSchedulesAutomaticEmailOnlyWhenItMatchesCondition() { + $newsletter_1 = $this->_createNewsletter(Newsletter::TYPE_AUTOMATIC); + $this->_createNewsletterOptions( + $newsletter_1->id, + Newsletter::TYPE_AUTOMATIC, + array( + 'group' => 'some_group', + 'event' => 'some_event', + 'sendTo' => 'user', + 'afterTimeType' => 'hours', + 'afterTimeNumber' => 2 + ) + ); + $newsletter_2 = $this->_createNewsletter(Newsletter::TYPE_AUTOMATIC); + $this->_createNewsletterOptions( + $newsletter_2->id, + Newsletter::TYPE_AUTOMATIC, + array( + 'group' => 'some_group', + 'event' => 'some_event', + 'sendTo' => 'segment', + 'afterTimeType' => 'hours', + 'afterTimeNumber' => 2 + ) + ); + $condition = function($email) { + return $email->sendTo === 'segment'; + }; + $meta = array('some' => 'value'); + + // email should not be scheduled when group is not matched + Scheduler::scheduleAutomaticEmail('group_does_not_exist', 'some_event'); + expect(SendingQueue::findMany())->count(0); + + // email should not be scheduled when event is not matched + Scheduler::scheduleAutomaticEmail('some_group', 'event_does_not_exist'); + expect(SendingQueue::findMany())->count(0); + + // email should only be scheduled if it matches condition ("send to segment") + Scheduler::scheduleAutomaticEmail('some_group', 'some_event', $condition, $subscriber_id = null, $meta); + $result = SendingQueue::findMany(); + expect($result)->count(1); + expect($result[0]->newsletter_id)->equals($newsletter_2->id); + expect($result[0]->getMeta())->equals($meta); + // scheduled task should be created + $task = $result[0]->getTasks()->findOne(); + $current_time = Carbon::createFromTimestamp(current_time('timestamp')); + expect($task->id)->greaterOrEquals(1); + expect($task->priority)->equals(SendingQueue::PRIORITY_MEDIUM); + expect($task->status)->equals(SendingQueue::STATUS_SCHEDULED); + expect(Carbon::parse($task->scheduled_at)->format('Y-m-d H:i')) + ->equals($current_time->addHours(2)->format('Y-m-d H:i')); + } + function testUnsearchablePostTypeDoesNotSchedulePostNotification() { $hook = new Hooks; - + $newsletter = $this->_createNewsletter(Newsletter::TYPE_NOTIFICATION); - + $this->_createNewsletterOptions( $newsletter->id, Newsletter::TYPE_NOTIFICATION, @@ -451,33 +586,33 @@ class SchedulerTest extends \MailPoetTest { 'schedule' => '* * * * *' ) ); - + $this->_removePostNotificationHooks(); register_post_type('post', array('exclude_from_search' => true)); $hook->setupPostNotifications(); - + $post_data = array( 'post_title' => 'title', 'post_status' => 'publish', ); wp_insert_post($post_data); - + $queue = SendingQueue::findTaskByNewsletterId($newsletter->id)->findOne(); expect($queue)->equals(false); - + $this->_removePostNotificationHooks(); register_post_type('post', array('exclude_from_search' => false)); $hook->setupPostNotifications(); - + wp_insert_post($post_data); - + $queue = SendingQueue::findTaskByNewsletterId($newsletter->id)->findOne(); expect($queue)->notequals(false); } - + function testSchedulerWontRunIfUnsentNotificationHistoryExists() { $newsletter = $this->_createNewsletter(Newsletter::TYPE_NOTIFICATION); - + $this->_createNewsletterOptions( $newsletter->id, Newsletter::TYPE_NOTIFICATION, @@ -486,22 +621,22 @@ class SchedulerTest extends \MailPoetTest { 'schedule' => '* * * * *' ) ); - + $notification_history = Newsletter::create(); $notification_history->type = Newsletter::TYPE_NOTIFICATION_HISTORY; $notification_history->status = Newsletter::STATUS_SENDING; $notification_history->parent_id = $newsletter->id; $notification_history->save(); - + $post_data = array( 'post_title' => 'title', 'post_status' => 'publish', ); wp_insert_post($post_data); - + $queue = SendingQueue::findTaskByNewsletterId($newsletter->id)->findOne(); expect($queue)->equals(false); - } + } function _createQueue( $newsletter_id, @@ -531,11 +666,14 @@ class SchedulerTest extends \MailPoetTest { function _createNewsletterOptions($newsletter_id, $newsletter_type, $options) { foreach($options as $option => $value) { - $newsletter_option_field = NewsletterOptionField::create(); - $newsletter_option_field->name = $option; - $newsletter_option_field->newsletter_type = $newsletter_type; - $newsletter_option_field->save(); - expect($newsletter_option_field->getErrors())->false(); + $newsletter_option_field = NewsletterOptionField::where('name', $option)->findOne(); + if(!$newsletter_option_field) { + $newsletter_option_field = NewsletterOptionField::create(); + $newsletter_option_field->name = $option; + $newsletter_option_field->newsletter_type = $newsletter_type; + $newsletter_option_field->save(); + expect($newsletter_option_field->getErrors())->false(); + } $newsletter_option = NewsletterOption::create(); $newsletter_option->option_field_id = $newsletter_option_field->id; @@ -562,6 +700,8 @@ class SchedulerTest extends \MailPoetTest { \ORM::raw_execute('TRUNCATE ' . NewsletterOptionField::$_table); \ORM::raw_execute('TRUNCATE ' . NewsletterPost::$_table); \ORM::raw_execute('TRUNCATE ' . ScheduledTask::$_table); + \ORM::raw_execute('TRUNCATE ' . ScheduledTaskSubscriber::$_table); \ORM::raw_execute('TRUNCATE ' . SendingQueue::$_table); + \ORM::raw_execute('TRUNCATE ' . Subscriber::$_table); } } \ No newline at end of file