Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity
Files
2add301b9f3b0ec1ed1fb8337f8847f761dca74c
piratepoet/tests/unit/Newsletter/Scheduler/SchedulerTest.php

457 lines
17 KiB
PHP
Raw Blame History

<?php
use Carbon\Carbon;
use MailPoet\Models\Newsletter;
use MailPoet\Models\NewsletterOption;
use MailPoet\Models\NewsletterOptionField;
use MailPoet\Models\NewsletterPost;
use MailPoet\Models\SendingQueue;
use MailPoet\Newsletter\Scheduler\Scheduler;
class NewsletterSchedulerTest extends MailPoetTest {
function testItSetsConstants() {
expect(Scheduler::SECONDS_IN_HOUR)->notEmpty();
expect(Scheduler::LAST_WEEKDAY_FORMAT)->notEmpty();
expect(Scheduler::WORDPRESS_ALL_ROLES)->notEmpty();
expect(Scheduler::INTERVAL_IMMEDIATELY)->notEmpty();
expect(Scheduler::INTERVAL_IMMEDIATE)->notEmpty();
expect(Scheduler::INTERVAL_DAILY)->notEmpty();
expect(Scheduler::INTERVAL_WEEKLY)->notEmpty();
expect(Scheduler::INTERVAL_MONTHLY)->notEmpty();
expect(Scheduler::INTERVAL_NTHWEEKDAY)->notEmpty();
}
function testItGetsActiveNewslettersFilteredByType() {
$newsletter = $this->_createNewsletter($type = Newsletter::TYPE_WELCOME);
// no newsletters wtih type "notification" should be found
expect(Scheduler::getNewsletters(Newsletter::TYPE_NOTIFICATION))->isEmpty();
// one newsletter with type "welcome" should be found
expect(Scheduler::getNewsletters(Newsletter::TYPE_WELCOME))->count(1);
}
function testItCanGetNextRunDate() {
// it accepts cron syntax and returns next run date
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
expect(Scheduler::getNextRunDate('* * * * *'))
->equals($current_time->addMinute()->format('Y-m-d H:i:00'));
// when invalid CRON expression is used, false response is returned
expect(Scheduler::getNextRunDate('invalid CRON expression'))->false();
}
function testItFormatsDatetimeString() {
expect(Scheduler::formatDatetimeString('April 20, 2016 4pm'))
->equals('2016-04-20 16:00:00');
}
function testItCreatesPostNotificationQueueRecord() {
$newsletter = $this->_createNewsletter();
$newsletter->schedule = '* 5 * * *';
// new queue record should be created
$queue = Scheduler::createPostNotificationQueue($newsletter);
expect(SendingQueue::findMany())->count(1);
expect($queue->newsletter_id)->equals($newsletter->id);
expect($queue->status)->equals(SendingQueue::STATUS_SCHEDULED);
expect($queue->scheduled_at)->equals(Scheduler::getNextRunDate('* 5 * * *'));
expect($queue->priority)->equals(SendingQueue::PRIORITY_MEDIUM);
// duplicate queue record should not be created
Scheduler::createPostNotificationQueue($newsletter);
expect(SendingQueue::findMany())->count(1);
}
function testItCreatesWelcomeNotificationQueueRecord() {
$newsletter = (object)array(
'id' => 1,
'afterTimeNumber' => 2
);
// queue is scheduled delivery in 2 hours
$newsletter->afterTimeType = 'hours';
Scheduler::createWelcomeNotificationQueue($newsletter, $subscriber_id = 1);
$queue = SendingQueue::where('newsletter_id', 1)
->findOne();
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
expect($queue->id)->greaterOrEquals(1);
expect($queue->priority)->equals(SendingQueue::PRIORITY_HIGH);
expect(Carbon::parse($queue->scheduled_at)->format('Y-m-d H:i'))
->equals($current_time->addHours(2)->format('Y-m-d H:i'));
$this->_after();
// queue is scheduled for delivery in 2 days
$newsletter->afterTimeType = 'days';
Scheduler::createWelcomeNotificationQueue($newsletter, $subscriber_id = 1);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
$queue = SendingQueue::where('newsletter_id', 1)
->findOne();
expect($queue->id)->greaterOrEquals(1);
expect($queue->priority)->equals(SendingQueue::PRIORITY_HIGH);
expect(Carbon::parse($queue->scheduled_at)->format('Y-m-d H:i'))
->equals($current_time->addDays(2)->format('Y-m-d H:i'));
$this->_after();
// queue is scheduled for delivery in 2 weeks
$newsletter->afterTimeType = 'weeks';
Scheduler::createWelcomeNotificationQueue($newsletter, $subscriber_id = 1);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
$queue = SendingQueue::where('newsletter_id', 1)
->findOne();
expect($queue->id)->greaterOrEquals(1);
expect($queue->priority)->equals(SendingQueue::PRIORITY_HIGH);
expect(Carbon::parse($queue->scheduled_at)->format('Y-m-d H:i'))
->equals($current_time->addWeeks(2)->format('Y-m-d H:i'));
$this->_after();
// queue is scheduled for immediate delivery
$newsletter->afterTimeType = null;
Scheduler::createWelcomeNotificationQueue($newsletter, $subscriber_id = 1);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
$queue = SendingQueue::where('newsletter_id', 1)
->findOne();
expect($queue->id)->greaterOrEquals(1);
expect($queue->priority)->equals(SendingQueue::PRIORITY_HIGH);
expect(Carbon::parse($queue->scheduled_at)->format('Y-m-d H:i'))
->equals($current_time->format('Y-m-d H:i'));
}
function tesIttDoesNotSchedulePostNotificationWhenNotificationWasAlreadySentForPost() {
$newsletter = $this->_createNewsletter();
$newsletter_post = NewsletterPost::create();
$newsletter_post->newsletter_id = $newsletter->id;
$newsletter_post->post_id = 10;
$newsletter_post->save();
// queue is not created when notification was already sent for the post
Scheduler::schedulePostNotification($post_id = 10);
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect($queue)->false();
}
function testItSchedulesPostNotification() {
$newsletter = $this->_createNewsletter();
$this->_createNewsletterOptions(
$newsletter->id,
Newsletter::TYPE_NOTIFICATION,
array(
'schedule' => '* 5 * * *'
)
);
// queue is created and scheduled for delivery one day later at 5 a.m.
Scheduler::schedulePostNotification($post_id = 10);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
$next_run_date = ($current_time->hour < 5) ?
$current_time :
$current_time->addDay();
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect($queue->scheduled_at)->equals($next_run_date->format('Y-m-d 05:00:00'));
}
function testItDoesNotSchedulesSubscriberWelcomeNotificationWhenSubscriberIsNotInSegment() {
// do not schedule when subscriber is not in segment
$newsletter = $this->_createNewsletter(Newsletter::TYPE_WELCOME);
Scheduler::scheduleSubscriberWelcomeNotification(
$subscriber_id = 10,
$segments = array()
);
// queue is not created
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect($queue)->false();
}
function testItSchedulesSubscriberWelcomeNotification() {
$newsletter = $this->_createNewsletter(Newsletter::TYPE_WELCOME);
$this->_createNewsletterOptions(
$newsletter->id,
Newsletter::TYPE_WELCOME,
array(
'event' => 'segment',
'segment' => 2,
'afterTimeType' => 'days',
'afterTimeNumber' => 1
)
);
// queue is created and scheduled for delivery one day later
Scheduler::scheduleSubscriberWelcomeNotification(
$subscriber_id = 10,
$segments = array(
3,
2,
1
)
);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect(Carbon::parse($queue->scheduled_at)->format('Y-m-d H:i'))
->equals($current_time->addDay()->format('Y-m-d H:i'));
}
function itDoesNotScheduleAnythingWhenNewsletterDoesNotExist() {
// post notification is not scheduled
expect(Scheduler::schedulePostNotification($post_id = 10))->false();
// subscriber welcome notification is not scheduled
$result = Scheduler::scheduleSubscriberWelcomeNotification(
$subscriber_id = 10,
$segments = array()
);
expect($result)->false();
// WP user welcome notification is not scheduled
$result = Scheduler::scheduleSubscriberWelcomeNotification(
$subscriber_id = 10,
$segments = array()
);
expect($result)->false();
}
function testItDoesNotScheduleWPUserWelcomeNotificationWhenRoleHasNotChanged() {
$newsletter = $this->_createNewsletter(Newsletter::TYPE_WELCOME);
$this->_createNewsletterOptions(
$newsletter->id,
Newsletter::TYPE_WELCOME,
array(
'event' => 'user',
'role' => 'editor',
'afterTimeType' => 'days',
'afterTimeNumber' => 1
)
);
Scheduler::scheduleWPUserWelcomeNotification(
$subscriber_id = 10,
$wp_user = array('roles' => array('editor')),
$old_user_data = array('roles' => array('editor'))
);
// queue is not created
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect($queue)->false();
}
function testItDoesNotScheduleWPUserWelcomeNotificationWhenUserRoleDoesNotMatch() {
$newsletter = $this->_createNewsletter(Newsletter::TYPE_WELCOME);
$this->_createNewsletterOptions(
$newsletter->id,
Newsletter::TYPE_WELCOME,
array(
'event' => 'user',
'role' => 'editor',
'afterTimeType' => 'days',
'afterTimeNumber' => 1
)
);
Scheduler::scheduleWPUserWelcomeNotification(
$subscriber_id = 10,
$wp_user = array('roles' => array('administrator'))
);
// queue is not created
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect($queue)->false();
}
function testItSchedulesWPUserWelcomeNotificationWhenUserRolesMatches() {
$newsletter = $this->_createNewsletter(Newsletter::TYPE_WELCOME);
$this->_createNewsletterOptions(
$newsletter->id,
Newsletter::TYPE_WELCOME,
array(
'event' => 'user',
'role' => 'administrator',
'afterTimeType' => 'days',
'afterTimeNumber' => 1
)
);
Scheduler::scheduleWPUserWelcomeNotification(
$subscriber_id = 10,
$wp_user = array('roles' => array('administrator'))
);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
// queue is created and scheduled for delivery one day later
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect(Carbon::parse($queue->scheduled_at)->format('Y-m-d H:i'))
->equals($current_time->addDay()->format('Y-m-d H:i'));
}
function testItSchedulesWPUserWelcomeNotificationWhenUserHasAnyRole() {
$newsletter = $this->_createNewsletter(Newsletter::TYPE_WELCOME);
$this->_createNewsletterOptions(
$newsletter->id,
Newsletter::TYPE_WELCOME,
array(
'event' => 'user',
'role' => Scheduler::WORDPRESS_ALL_ROLES,
'afterTimeType' => 'days',
'afterTimeNumber' => 1
)
);
Scheduler::scheduleWPUserWelcomeNotification(
$subscriber_id = 10,
$wp_user = array('roles' => array('administrator'))
);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
// queue is created and scheduled for delivery one day later
$queue = SendingQueue::where('newsletter_id', $newsletter->id)
->findOne();
expect(Carbon::parse($queue->scheduled_at)->format('Y-m-d H:i'))
->equals($current_time->addDay()->format('Y-m-d H:i'));
}
function testItProcessesPostNotificationSchedule() {
$newsletter_option_field = NewsletterOptionField::create();
$newsletter_option_field->name = 'schedule';
$newsletter_option_field->newsletter_type = Newsletter::TYPE_WELCOME;
$newsletter_option_field->save();
// daily notification is scheduled at 14:00
$newsletter = (object)array(
'id' => 1,
'intervalType' => Scheduler::INTERVAL_DAILY,
'monthDay' => null,
'nthWeekDay' => null,
'weekDay' => null,
'timeOfDay' => 50400 // 14:00
);
Scheduler::processPostNotificationSchedule($newsletter);
$newsletter_option = NewsletterOption::where('newsletter_id', $newsletter->id)
->where('option_field_id', $newsletter_option_field->id)
->findOne();
$current_time = 1483275600; // Sunday, 1 January 2017 @ 1:00pm (UTC)
expect(Scheduler::getNextRunDate($newsletter_option->value, $current_time))
->equals('2017-01-01 14:00:00');
// weekly notification is scheduled every Tuesday at 14:00
$newsletter = (object)array(
'id' => 1,
'intervalType' => Scheduler::INTERVAL_WEEKLY,
'monthDay' => null,
'nthWeekDay' => null,
'weekDay' => Carbon::TUESDAY,
'timeOfDay' => 50400 // 14:00
);
Scheduler::processPostNotificationSchedule($newsletter);
$current_time = Carbon::createFromTimestamp(current_time('timestamp'));
$newsletter_option = NewsletterOption::where('newsletter_id', $newsletter->id)
->where('option_field_id', $newsletter_option_field->id)
->findOne();
$current_time = 1483275600; // Sunday, 1 January 2017 @ 1:00pm (UTC)
expect(Scheduler::getNextRunDate($newsletter_option->value, $current_time))
->equals('2017-01-03 14:00:00');
// monthly notification is scheduled every 20th day at 14:00
$newsletter = (object)array(
'id' => 1,
'intervalType' => Scheduler::INTERVAL_MONTHLY,
'monthDay' => 19, // 20th (count starts from 0)
'nthWeekDay' => null,
'weekDay' => null,
'timeOfDay' => 50400 // 14:00
);
Scheduler::processPostNotificationSchedule($newsletter);
$newsletter_option = NewsletterOption::where('newsletter_id', $newsletter->id)
->where('option_field_id', $newsletter_option_field->id)
->findOne();
$current_time = 1483275600; // Sunday, 1 January 2017 @ 1:00pm (UTC)
expect(Scheduler::getNextRunDate($newsletter_option->value, $current_time))
->equals('2017-01-19 14:00:00');
// monthly notification is scheduled every last Saturday at 14:00
$newsletter = (object)array(
'id' => 1,
'intervalType' => Scheduler::INTERVAL_NTHWEEKDAY,
'monthDay' => null,
'nthWeekDay' => 'L', // L = last
'weekDay' => Carbon::SATURDAY,
'timeOfDay' => 50400 // 14:00
);
Scheduler::processPostNotificationSchedule($newsletter);
$newsletter_option = NewsletterOption::where('newsletter_id', $newsletter->id)
->where('option_field_id', $newsletter_option_field->id)
->findOne();
$current_time = 1485694800; // Sunday, 29 January 2017 @ 1:00pm (UTC)
expect(Scheduler::getNextRunDate($newsletter_option->value, $current_time))
->equals('2017-02-25 14:00:00');
// notification is scheduled immediately (next minute)
$newsletter = (object)array(
'id' => 1,
'intervalType' => Scheduler::INTERVAL_IMMEDIATELY,
'monthDay' => null,
'nthWeekDay' => null,
'weekDay' => null,
'timeOfDay' => null
);
Scheduler::processPostNotificationSchedule($newsletter);
$newsletter_option = NewsletterOption::where('newsletter_id', $newsletter->id)
->where('option_field_id', $newsletter_option_field->id)
->findOne();
$current_time = 1483275600; // Sunday, 1 January 2017 @ 1:00pm (UTC)
expect(Scheduler::getNextRunDate($newsletter_option->value, $current_time))
->equals('2017-01-01 13:01:00');
}
function _createQueue(
$newsletter_id,
$scheduled_at = null,
$status = SendingQueue::STATUS_SCHEDULED
) {
$queue = SendingQueue::create();
$queue->status = $status;
$queue->newsletter_id = $newsletter_id;
$queue->scheduled_at = $scheduled_at;
$queue->save();
expect($queue->getErrors())->false();
return $queue;
}
function _createNewsletter(
$type = Newsletter::TYPE_NOTIFICATION,
$status = Newsletter::STATUS_ACTIVE
) {
$newsletter = Newsletter::create();
$newsletter->type = $type;
$newsletter->status = $status;
$newsletter->save();
expect($newsletter->getErrors())->false();
return $newsletter;
}
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 = NewsletterOption::create();
$newsletter_option->option_field_id = $newsletter_option_field->id;
$newsletter_option->newsletter_id = $newsletter_id;
$newsletter_option->value = $value;
$newsletter_option->save();
expect($newsletter_option->getErrors())->false();
}
}
function _after() {
ORM::raw_execute('TRUNCATE ' . Newsletter::$_table);
ORM::raw_execute('TRUNCATE ' . NewsletterOption::$_table);
ORM::raw_execute('TRUNCATE ' . NewsletterOptionField::$_table);
ORM::raw_execute('TRUNCATE ' . NewsletterPost::$_table);
ORM::raw_execute('TRUNCATE ' . SendingQueue::$_table);
}
}
View Git Blame Copy Permalink