Move subscribe() method to a separate class an make it non-static [MAILPOET-1825]

2019-02-20 15:16:02 +03:00
parent 56f6441d36
commit 7528f0f52b
5 changed files with 421 additions and 337 deletions
--- a/tests/integration/Subscribers/SubscriberActionsTest.php
+++ b/tests/integration/Subscribers/SubscriberActionsTest.php
@@ -0,0 +1,323 @@
+<?php
+
+namespace MailPoet\Subscribers;
+
+use MailPoet\DI\ContainerWrapper;
+use MailPoet\Models\Newsletter;
+use MailPoet\Models\NewsletterOption;
+use MailPoet\Models\NewsletterOptionField;
+use MailPoet\Models\ScheduledTask;
+use MailPoet\Models\Segment;
+use MailPoet\Models\SendingQueue;
+use MailPoet\Models\Setting;
+use MailPoet\Models\Subscriber;
+use MailPoet\Models\SubscriberSegment;
+use MailPoet\Settings\SettingsController;
+use MailPoet\Subscribers\SubscriberActions;
+
+class SubscriberActionsTest extends \MailPoetTest {
+
+  /** @var array */
+  private $test_data;
+
+  /** @var SubscriberActions */
+  private $subscriber_actions;
+
+  /** @var SettingsController */
+  private $settings;
+
+  function _before() {
+    parent::_before();
+    $this->test_data = array(
+      'first_name' => 'John',
+      'last_name' => 'Mailer',
+      'email' => 'john@mailpoet.com'
+    );
+    $this->subscriber_actions = ContainerWrapper::getInstance()->get(SubscriberActions::class);
+    $this->settings = new SettingsController();
+    $this->settings->set('sender', array(
+      'name' => 'John Doe',
+      'address' => 'john.doe@example.com'
+    ));
+  }
+
+  function testItCanSubscribe() {
+    $segment = Segment::create();
+    $segment->hydrate(array('name' => 'List #1'));
+    $segment->save();
+
+    $segment2 = Segment::create();
+    $segment2->hydrate(array('name' => 'List #2'));
+    $segment2->save();
+
+    $subscriber = $this->subscriber_actions->subscribe(
+      $this->test_data,
+      array($segment->id(), $segment2->id())
+    );
+
+    expect($subscriber->id() > 0)->equals(true);
+    expect($subscriber->segments()->count())->equals(2);
+    expect($subscriber->email)->equals($this->test_data['email']);
+    expect($subscriber->first_name)->equals($this->test_data['first_name']);
+    expect($subscriber->last_name)->equals($this->test_data['last_name']);
+    // signup confirmation is enabled by default
+    expect($subscriber->status)->equals(Subscriber::STATUS_UNCONFIRMED);
+    expect($subscriber->deleted_at)->equals(null);
+  }
+
+  function testItSchedulesWelcomeNotificationUponSubscriptionWhenSubscriptionConfirmationIsDisabled() {
+    // create segment
+    $segment = Segment::create();
+    $segment->hydrate(array('name' => 'List #1'));
+    $segment->save();
+    expect($segment->getErrors())->false();
+
+    // create welcome notification newsletter and relevant scheduling options
+    $newsletter = Newsletter::create();
+    $newsletter->type = Newsletter::TYPE_WELCOME;
+    $newsletter->status = Newsletter::STATUS_ACTIVE;
+    $newsletter->save();
+    expect($newsletter->getErrors())->false();
+
+    $newsletter_options = array(
+      'event' => 'segment',
+      'segment' => $segment->id,
+      'afterTimeType' => 'days',
+      'afterTimeNumber' => 1
+    );
+    foreach ($newsletter_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();
+    }
+
+    $this->settings->set('signup_confirmation.enabled', false);
+    $subscriber = $this->subscriber_actions->subscribe($this->test_data, array($segment->id()));
+    expect($subscriber->id() > 0)->equals(true);
+    expect($subscriber->segments()->count())->equals(1);
+    $scheduled_notification = SendingQueue::findTaskByNewsletterId($newsletter->id)
+      ->where('tasks.status', SendingQueue::STATUS_SCHEDULED)
+      ->findOne();
+    expect($scheduled_notification)->notEmpty();
+  }
+
+  function testItDoesNotScheduleWelcomeNotificationUponSubscriptionWhenSubscriptionConfirmationIsEnabled() {
+    // create segment
+    $segment = Segment::create();
+    $segment->hydrate(array('name' => 'List #1'));
+    $segment->save();
+    expect($segment->getErrors())->false();
+
+    // create welcome notification newsletter and relevant scheduling options
+    $newsletter = Newsletter::create();
+    $newsletter->type = Newsletter::TYPE_WELCOME;
+    $newsletter->status = Newsletter::STATUS_ACTIVE;
+    $newsletter->save();
+    expect($newsletter->getErrors())->false();
+
+    $newsletter_options = array(
+      'event' => 'segment',
+      'segment' => $segment->id,
+      'afterTimeType' => 'days',
+      'afterTimeNumber' => 1
+    );
+    foreach ($newsletter_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();
+    }
+
+    $this->settings->set('signup_confirmation.enabled', true);
+    $subscriber = $this->subscriber_actions->subscribe($this->test_data, array($segment->id()));
+    expect($subscriber->id() > 0)->equals(true);
+    expect($subscriber->segments()->count())->equals(1);
+    $scheduled_notification = SendingQueue::findTaskByNewsletterId($newsletter->id)
+      ->where('tasks.status', SendingQueue::STATUS_SCHEDULED)
+      ->findOne();
+    expect($scheduled_notification)->isEmpty();
+  }
+
+  function testItCannotSubscribeWithReservedColumns() {
+    $segment = Segment::create();
+    $segment->hydrate(array('name' => 'List #1'));
+    $segment->save();
+
+    $subscriber = $this->subscriber_actions->subscribe(
+      array(
+        'email' => 'donald@mailpoet.com',
+        'first_name' => 'Donald',
+        'last_name' => 'Trump',
+        // the fields below should NOT be taken into account
+        'id' => 1337,
+        'wp_user_id' => 7331,
+        'is_woocommerce_user' => 1,
+        'status' => Subscriber::STATUS_SUBSCRIBED,
+        'created_at' => '1984-03-09 00:00:01',
+        'updated_at' => '1984-03-09 00:00:02',
+        'deleted_at' => '1984-03-09 00:00:03'
+      ),
+      array($segment->id())
+    );
+
+    expect($subscriber->id > 0)->equals(true);
+    expect($subscriber->id)->notEquals(1337);
+    expect($subscriber->segments()->count())->equals(1);
+    expect($subscriber->email)->equals('donald@mailpoet.com');
+    expect($subscriber->first_name)->equals('Donald');
+    expect($subscriber->last_name)->equals('Trump');
+
+    expect($subscriber->wp_user_id)->equals(null);
+    expect($subscriber->is_woocommerce_user)->equals(0);
+    expect($subscriber->status)->equals(Subscriber::STATUS_UNCONFIRMED);
+    expect($subscriber->created_at)->notEquals('1984-03-09 00:00:01');
+    expect($subscriber->updated_at)->notEquals('1984-03-09 00:00:02');
+    expect($subscriber->created_at)->equals($subscriber->updated_at);
+    expect($subscriber->deleted_at)->equals(null);
+  }
+
+  function testItOverwritesSubscriberDataWhenConfirmationIsDisabled() {
+    $original_setting_value = $this->settings->get('signup_confirmation.enabled');
+    $this->settings->set('signup_confirmation.enabled', false);
+
+    $segment = Segment::create();
+    $segment->hydrate(array('name' => 'List #1'));
+    $segment->save();
+
+    $segment2 = Segment::create();
+    $segment2->hydrate(array('name' => 'List #2'));
+    $segment2->save();
+
+    $data = array(
+      'email' => 'some@example.com',
+      'first_name' => 'Some',
+      'last_name' => 'Example',
+    );
+
+    $subscriber = $this->subscriber_actions->subscribe(
+      $data,
+      array($segment->id())
+    );
+
+    expect($subscriber->id() > 0)->equals(true);
+    expect($subscriber->segments()->count())->equals(1);
+    expect($subscriber->email)->equals($data['email']);
+    expect($subscriber->first_name)->equals($data['first_name']);
+    expect($subscriber->last_name)->equals($data['last_name']);
+
+    $data2 = $data;
+    $data2['first_name'] = 'Aaa';
+    $data2['last_name'] = 'Bbb';
+
+    $subscriber = $this->subscriber_actions->subscribe(
+      $data2,
+      array($segment->id(), $segment2->id())
+    );
+
+    expect($subscriber->id() > 0)->equals(true);
+    expect($subscriber->segments()->count())->equals(2);
+    expect($subscriber->email)->equals($data2['email']);
+    expect($subscriber->first_name)->equals($data2['first_name']);
+    expect($subscriber->last_name)->equals($data2['last_name']);
+
+    $this->settings->set('signup_confirmation.enabled', $original_setting_value);
+  }
+
+  function testItStoresUnconfirmedSubscriberDataWhenConfirmationIsEnabled() {
+    $original_setting_value = $this->settings->get('signup_confirmation.enabled');
+    $this->settings->set('signup_confirmation.enabled', true);
+
+    $segment = Segment::create();
+    $segment->hydrate(array('name' => 'List #1'));
+    $segment->save();
+
+    $segment2 = Segment::create();
+    $segment2->hydrate(array('name' => 'List #2'));
+    $segment2->save();
+
+    $data = array(
+      'email' => 'some@example.com',
+      'first_name' => 'Some',
+      'last_name' => 'Example',
+    );
+
+    $subscriber = $this->subscriber_actions->subscribe(
+      $data,
+      array($segment->id())
+    );
+
+    expect($subscriber->id() > 0)->equals(true);
+    expect($subscriber->segments()->count())->equals(1);
+    expect($subscriber->email)->equals($data['email']);
+    expect($subscriber->first_name)->equals($data['first_name']);
+    expect($subscriber->last_name)->equals($data['last_name']);
+
+    expect($subscriber->unconfirmed_data)->isEmpty();
+
+    $data2 = $data;
+    $data2['first_name'] = 'Aaa';
+    $data2['last_name'] = 'Bbb';
+
+    $subscriber = $this->subscriber_actions->subscribe(
+      $data2,
+      array($segment->id(), $segment2->id())
+    );
+
+    expect($subscriber->id() > 0)->equals(true);
+    expect($subscriber->segments()->count())->equals(2);
+    // fields should be left intact
+    expect($subscriber->email)->equals($data['email']);
+    expect($subscriber->first_name)->equals($data['first_name']);
+    expect($subscriber->last_name)->equals($data['last_name']);
+
+    expect($subscriber->unconfirmed_data)->notEmpty();
+    expect($subscriber->unconfirmed_data)->equals(json_encode($data2));
+
+    // Unconfirmed data should be wiped after any direct update
+    // during confirmation, manual admin editing
+    $subscriber = Subscriber::createOrUpdate($data2);
+    expect($subscriber->unconfirmed_data)->isEmpty();
+    // during import
+    $subscriber->unconfirmed_data = json_encode($data2);
+    $subscriber->save();
+    expect($subscriber->isDirty('unconfirmed_data'))->false();
+    expect($subscriber->unconfirmed_data)->notEmpty();
+    Subscriber::updateMultiple(
+      array_keys($data2),
+      array(array_values($data2))
+    );
+    $subscriber = Subscriber::where('email', $data2['email'])->findOne();
+    expect($subscriber->unconfirmed_data)->isEmpty();
+
+    $this->settings->set('signup_confirmation.enabled', $original_setting_value);
+  }
+
+  function _after() {
+    \ORM::raw_execute('TRUNCATE ' . Subscriber::$_table);
+    \ORM::raw_execute('TRUNCATE ' . Segment::$_table);
+    \ORM::raw_execute('TRUNCATE ' . SubscriberSegment::$_table);
+    \ORM::raw_execute('TRUNCATE ' . Newsletter::$_table);
+    \ORM::raw_execute('TRUNCATE ' . NewsletterOptionField::$_table);
+    \ORM::raw_execute('TRUNCATE ' . NewsletterOption::$_table);
+    \ORM::raw_execute('TRUNCATE ' . ScheduledTask::$_table);
+    \ORM::raw_execute('TRUNCATE ' . SendingQueue::$_table);
+    \ORM::raw_execute('TRUNCATE ' . Setting::$_table);
+  }
+}