piratepoet/mailpoet/tests/integration/API/JSON/v1/ServicesTest.php

<?php declare(strict_types = 1);

namespace MailPoet\Test\API\JSON\v1;

use Codeception\Stub\Expected;
use MailPoet\Analytics\Analytics;
use MailPoet\API\JSON\Response as APIResponse;
use MailPoet\API\JSON\v1\Services;
use MailPoet\Config\Installer;
use MailPoet\Config\ServicesChecker;
use MailPoet\Cron\Workers\KeyCheck\PremiumKeyCheck;
use MailPoet\Cron\Workers\KeyCheck\SendingServiceKeyCheck;
use MailPoet\Mailer\Mailer;
use MailPoet\Mailer\MailerLog;
use MailPoet\Services\AuthorizedEmailsController;
use MailPoet\Services\AuthorizedSenderDomainController;
use MailPoet\Services\Bridge;
use MailPoet\Services\CongratulatoryMssEmailController;
use MailPoet\Services\SubscribersCountReporter;
use MailPoet\Settings\SettingsController;
use MailPoet\WP\Functions as WPFunctions;

class ServicesTest extends \MailPoetTest {
  public $data;
  public $servicesEndpoint;
  /** @var SettingsController */
  private $settings;

  public function _before() {
    parent::_before();
    $this->servicesEndpoint = $this->diContainer->get(Services::class);
    $this->data = ['key' => '1234567890abcdef'];
    $this->settings = SettingsController::getInstance();
  }

  public function testItRespondsWithErrorIfNoMSSKeyIsGiven() {
    $response = $this->diContainer->get(Services::class)->checkMSSKey(['key' => '']);
    verify($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
    verify($response->errors[0]['message'])->equals('Please specify a key.');
  }

  public function testItRespondsWithSuccessIfMSSKeyIsValid() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => ['state' => Bridge::KEY_VALID],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
  }

  public function testItRespondsWithErrorIfMSSKeyIsInvalid() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => ['state' => Bridge::KEY_INVALID],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );
    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
  }

  public function testItRespondsWithErrorIfMSSKeyIsExpiring() {
    $date = new \DateTime;
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => [
          'state' => Bridge::KEY_EXPIRING,
          'data' => ['expire_at' => $date->format('c')],
        ],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify($response->data['message'])
      ->stringContainsString($date->format($servicesEndpoint->dateTime->getDateFormat()));
  }

  public function testItRespondsWithErrorIfServiceIsUnavailableDuringMSSCheck() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => ['code' => Bridge::CHECK_ERROR_UNAVAILABLE],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    $errorMessage = $this->invokeMethod(
      $servicesEndpoint,
      'getErrorDescriptionByCode',
      [Bridge::CHECK_ERROR_UNAVAILABLE]
    );
    $this->assertIsString($errorMessage);
    verify($response->errors[0]['message'])->stringContainsString($errorMessage);
  }

  public function testItRespondsWithErrorIfServiceDidNotReturnAResponseCodeDuringMSSCheck() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => null,
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    $errorMessage = $this->invokeMethod(
      $servicesEndpoint,
      'getErrorDescriptionByCode',
      [Bridge::CHECK_ERROR_UNKNOWN]
    );
    $this->assertIsString($errorMessage);
    verify($response->errors[0]['message'])->stringContainsString($errorMessage);
  }

  public function testItPrintsErrorCodeIfServiceReturnedAnUnexpectedResponseCodeDuringMSSCheck() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => ['code' => 404],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    verify($response->errors[0]['message'])->stringContainsString('404');
  }

  public function testItRespondsWithErrorIfMSSCheckThrowsAnException() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => function() {
          throw new \Exception('test');
        },
        'storeMSSKeyAndState' => Expected::never(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    verify($response->errors[0]['message'])->equals('test');
  }

  public function testItDoesNotPauseSendingWhenMSSKeyValidAndApproved() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    verify(MailerLog::isSendingPaused())->false();

    $bridge = $this->make(
      Bridge::class,
      [
        'settings' => SettingsController::getInstance(),
        'checkMSSKey' => [
          'state' => Bridge::KEY_VALID,
          'data' => ['is_approved' => true],
        ],
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify(MailerLog::isSendingPaused())->false();
  }

  public function testItPausesSendingWhenMSSKeyValidButNotApproved() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    verify(MailerLog::isSendingPaused())->false();

    $bridge = $this->make(
      Bridge::class,
      [
        'settings' => SettingsController::getInstance(),
        'checkMSSKey' => [
          'state' => Bridge::KEY_VALID,
          'data' => ['is_approved' => false],
        ],
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify(MailerLog::isSendingPaused())->true();
  }

  public function testItResumesSendingWhenMSSKeyBecomesApproved() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $this->settings->set(Bridge::API_KEY_SETTING_NAME, 'key');
    $this->settings->set(Bridge::API_KEY_STATE_SETTING_NAME, [
      'state' => Bridge::KEY_VALID,
      'data' => ['is_approved' => false],
    ]);
    MailerLog::pauseSending(MailerLog::getMailerLog());
    verify(MailerLog::isSendingPaused())->true();

    $bridge = $this->make(
      Bridge::class,
      [
        'settings' => SettingsController::getInstance(),
        'checkMSSKey' => [
          'state' => Bridge::KEY_VALID,
          'data' => ['is_approved' => true],
        ],
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify(MailerLog::isSendingPaused())->false();
  }

  public function testItRespondsWithErrorIfNoPremiumKeyIsGiven() {
    $response = $response = $this->diContainer->get(Services::class)->checkPremiumKey(['key' => '']);
    verify($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
    verify($response->errors[0]['message'])->equals('Please specify a key.');
  }

  public function testItRespondsWithSuccessIfPremiumKeyIsValid() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => ['state' => Bridge::KEY_VALID],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
    foreach (array_keys(Installer::getPremiumStatus()) as $key) {
      verify(array_key_exists($key, $response->meta))->true();
    }
  }

  public function testItRespondsWithErrorIfPremiumKeyIsInvalid() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => ['state' => Bridge::KEY_INVALID],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
  }

  public function testItRespondsWithErrorIfPremiumKeyIsUsed() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => ['state' => Bridge::KEY_ALREADY_USED],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
  }

  public function testItRespondsWithErrorIfPremiumKeyIsExpiring() {
    $date = new \DateTime;
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => [
          'state' => Bridge::KEY_EXPIRING,
          'data' => ['expire_at' => $date->format('c')],
        ],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify($response->data['message'])
      ->stringContainsString($date->format($servicesEndpoint->dateTime->getDateFormat()));
  }

  public function testItRespondsWithErrorIfServiceIsUnavailableDuringPremiumCheck() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => ['code' => Bridge::CHECK_ERROR_UNAVAILABLE],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    $errorMessage = $this->invokeMethod(
      $servicesEndpoint,
      'getErrorDescriptionByCode',
      [Bridge::CHECK_ERROR_UNAVAILABLE]
    );
    $this->assertIsString($errorMessage);
    verify($response->errors[0]['message'])->stringContainsString($errorMessage);
  }

  public function testItRespondsWithErrorIfServiceDidNotReturnAResponseCodeDuringPremiumCheck() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => null,
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    $errorMessage = $this->invokeMethod(
      $servicesEndpoint,
      'getErrorDescriptionByCode',
      [Bridge::CHECK_ERROR_UNKNOWN]
    );
    $this->assertIsString($errorMessage);
    verify($response->errors[0]['message'])->stringContainsString($errorMessage);
  }

  public function testItPrintsErrorCodeIfServiceReturnedAnUnexpectedResponseCodeDuringPremiumCheck() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => ['code' => 404],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    verify($response->errors[0]['message'])->stringContainsString('404');
  }

  public function testItRespondsWithErrorIfPremiumCheckThrowsAnException() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => function() {
          throw new \Exception('test');
        },
        'storePremiumKeyAndState' => Expected::never(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_NOT_FOUND);
    verify($response->errors[0]['message'])->equals('test');
  }

  public function testItRespondsWithPublicIdForMSS() {
    $fakePublicId = 'a-fake-public_id';
    $this->settings->delete('public_id');
    $this->settings->delete('new_public_id');

    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => [
          'state' => Bridge::KEY_VALID,
          'data' => [ 'public_id' => $fakePublicId ],
        ],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $servicesEndpoint->checkMSSKey($this->data);

    verify($this->settings->get('public_id'))->equals($fakePublicId);
    verify($this->settings->get('new_public_id'))->equals('true');
  }

  public function testItRespondsWithoutPublicIdForMSS() {
    $this->settings->delete('public_id');
    $this->settings->delete('new_public_id');

    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => [ 'state' => Bridge::KEY_VALID ],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);

    verify($this->settings->get('public_id', null))->null();
    verify($this->settings->get('new_public_id', null))->null();
  }

  public function testItRespondsWithPublicIdForPremium() {
    $fakePublicId = 'another-fake-public_id';
    $this->settings->delete('public_id');
    $this->settings->delete('new_public_id');

    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => [
          'state' => Bridge::KEY_VALID,
          'data' => [ 'public_id' => $fakePublicId ],
        ],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);

    verify($this->settings->get('public_id'))->equals($fakePublicId);
    verify($this->settings->get('new_public_id'))->equals('true');
  }

  public function testItRespondsWithoutPublicIdForPremium() {
    $this->settings->delete('public_id');
    $this->settings->delete('new_public_id');

    $bridge = $this->make(
      new Bridge(),
      [
        'checkPremiumKey' => ['state' => Bridge::KEY_VALID],
        'storePremiumKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkPremiumKey($this->data);

    verify($this->settings->get('public_id', null))->null();
    verify($this->settings->get('new_public_id', null))->null();
  }

  public function testCongratulatoryEmailIsSent() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $this->settings->set('sender.address', 'authorized@email.com');
    $authorizedEmailsController = $this->make(AuthorizedEmailsController::class, [
      'getAuthorizedEmailAddresses' => ['authorized@email.com'],
    ]);

    $congratulatoryEmailController = $this->make(CongratulatoryMssEmailController::class, [
      'sendCongratulatoryEmail' => Expected::once('authorized@email.com'),
    ]);

    $servicesEndpoint = $this->createServicesEndpointWithMocks([
      'authorizedEmailsController' => $authorizedEmailsController,
      'congratulatoryEmailController' => $congratulatoryEmailController,
    ]);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();
    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify($response->data)->equals(['email_address' => 'authorized@email.com']);
  }

  public function testCongratulatoryEmailRespondsWithErrorWhenMssNotActive() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_PHPMAIL]);
    $servicesEndpoint = $this->diContainer->get(Services::class);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();
    verify($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
    verify($response->errors[0]['message'])->equals('MailPoet Sending Service is not active.');
  }

  public function testCongratulatoryEmailRespondsWithErrorWhenNoEmailAuthorized() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $this->settings->set('sender.address', 'unauthorized@email.com');
    $authorizedEmailsController = $this->make(AuthorizedEmailsController::class, [
      'getAuthorizedEmailAddresses' => [],
    ]);

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['authorizedEmailsController' => $authorizedEmailsController]);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();
    verify($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
    verify($response->errors[0]['message'])->equals('No FROM email addresses are authorized.');
  }

  public function testCongratulatoryEmailRespondsWithDifferentErrorWhenNoEmailAuthorizedButDomainIsVerified() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $authorizedEmailsController = $this->make(AuthorizedEmailsController::class, [
      'getAuthorizedEmailAddresses' => [],
    ]);

    $verifiedDomains = ['email.com'];
    $senderDomainMock = $this->make(AuthorizedSenderDomainController::class, [
      'getVerifiedSenderDomainsIgnoringCache' => $verifiedDomains,
    ]);

    $servicesEndpoint = $this->createServicesEndpointWithMocks([
      'authorizedEmailsController' => $authorizedEmailsController,
      'senderDomain' => $senderDomainMock,
    ]);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();
    verify($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
    // when the sender domain is verified, we don't insist the FROM email be authorized
    // we instead get a different error when the sender email is not avaliable
    verify($response->errors[0]['message'])->equals('Sender email address is not set.');
  }

  public function testCongratulatoryEmailRespondsWithErrorWhenNoSenderSet() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $this->settings->set('sender.address', null);
    $authorizedEmailsController = $this->make(AuthorizedEmailsController::class, [
      'getAuthorizedEmailAddresses' => ['authorized@email.com'],
    ]);

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['authorizedEmailsController' => $authorizedEmailsController]);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();
    verify($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
    verify($response->errors[0]['message'])->equals('Sender email address is not set.');
  }

  public function testCongratulatoryEmailRespondsWithErrorWhenSenderNotAuthorized() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $this->settings->set('sender.address', 'unauthorized@email.com');
    $authorizedEmailsController = $this->make(AuthorizedEmailsController::class, [
      'getAuthorizedEmailAddresses' => ['authorized@email.com'],
    ]);

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['authorizedEmailsController' => $authorizedEmailsController]);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();
    verify($response->status)->equals(APIResponse::STATUS_BAD_REQUEST);
    verify($response->errors[0]['message'])->equals("Sender email address 'unauthorized@email.com' is not authorized.");
  }

  public function testCongratulatoryEmailRespondsWithSuccessWhenSenderNotAuthorizedButDomainIsVerified() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $this->settings->set('sender.address', 'unauthorized@email.com');
    $authorizedEmailsController = $this->make(AuthorizedEmailsController::class, [
      'getAuthorizedEmailAddresses' => ['authorized@email.com'],
    ]);

    $congratulatoryEmailController = $this->make(CongratulatoryMssEmailController::class, [
      'sendCongratulatoryEmail' => Expected::once('unauthorized@email.com'),
    ]);

    $verifiedDomains = ['email.com'];
    $senderDomainMock = $this->make(AuthorizedSenderDomainController::class, [
      'getVerifiedSenderDomainsIgnoringCache' => Expected::once($verifiedDomains),
    ]);

    $servicesEndpoint = $this->createServicesEndpointWithMocks([
      'authorizedEmailsController' => $authorizedEmailsController,
      'congratulatoryEmailController' => $congratulatoryEmailController,
      'senderDomain' => $senderDomainMock,
    ]);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();

    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify($response->data)->equals(['email_address' => 'unauthorized@email.com']);
  }

  public function testCongratulatoryEmailRespondsWithErrorWhenSendingFails() {
    $this->settings->set(Mailer::MAILER_CONFIG_SETTING_NAME, ['method' => Mailer::METHOD_MAILPOET]);
    $this->settings->set('sender.address', 'authorized@email.com');
    $authorizedEmailsController = $this->make(AuthorizedEmailsController::class, [
      'getAuthorizedEmailAddresses' => ['authorized@email.com'],
    ]);

    $congratulatoryEmailController = $this->make(CongratulatoryMssEmailController::class, [
      'sendCongratulatoryEmail' => function () {
        throw new \Exception('test');
      },
    ]);

    $servicesEndpoint = $this->createServicesEndpointWithMocks([
      'authorizedEmailsController' => $authorizedEmailsController,
      'congratulatoryEmailController' => $congratulatoryEmailController,
    ]);
    $response = $servicesEndpoint->sendCongratulatoryMssEmail();
    verify($response->status)->equals(APIResponse::STATUS_UNKNOWN);
    verify($response->errors[0]['message'])->equals('Sending of congratulatory email failed.');
  }

  public function testItRespondsWithCorrectMessageIfKeyDoesntSupportMSS() {
    $bridge = $this->make(
      new Bridge(),
      [
        'checkMSSKey' => [
          'state' => Bridge::KEY_VALID_UNDERPRIVILEGED,
          'code' => 403,
        ],
        'storeMSSKeyAndState' => Expected::once(),
      ]
    );

    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->checkMSSKey($this->data);
    verify($response->status)->equals(APIResponse::STATUS_OK);
    verify($response->data['message'])->stringContainsString(
      'Your Premium key has been successfully validated, but is not valid for MailPoet Sending Service'
    );
  }

  public function testItReturnsErrorIfBridgePingReturnWPError() {
    $errorMessage = 'cURL error 6: Could not resolve host: https://bridge.mailpoet.com';
    $bridge = $this->make(
      new Bridge(),
      [
        'pingBridge' => new \WP_Error('error', $errorMessage),
      ]
    );
    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->pingBridge();
    $response = $response->getData();
    verify($response['errors'][0])->isArray();
    verify($response['errors'][0]['message'])->stringContainsString($errorMessage);
    verify($response['errors'][0]['message'])->stringContainsString('Contact your hosting support');
    verify($response['errors'][0]['error'])->stringContainsString('unknown');
  }

  public function testItReturnsErrorIfBridgePingResultIsUnsuccessful() {
    $errorCode = 500;
    $bridge = $this->make(
      new Bridge(),
      [
        'pingBridge' => [
          'response' => ['code' => $errorCode],
        ],
      ]
    );
    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->pingBridge();
    $response = $response->getData();
    verify($response['errors'][0])->isArray();
    verify($response['errors'][0]['message'])->stringContainsString('code: 500');
    verify($response['errors'][0]['error'])->stringContainsString('unknown');
  }

  public function testItPingsBridgeSuccessfully() {
    $bridge = $this->make(
      new Bridge(),
      [
        'pingBridge' => [
          'response' => ['code' => 200],
        ],
      ]
    );
    $servicesEndpoint = $this->createServicesEndpointWithMocks(['bridge' => $bridge]);
    $response = $servicesEndpoint->pingBridge();
    verify($response->status)->equals(200);
    $response = $response->getData();
    verify($response['data'])->empty();
    verify(empty($response['errors']))->true();
  }

  private function createServicesEndpointWithMocks(array $mocks) {
    return new Services(
      $mocks['bridge'] ?? $this->diContainer->get(Bridge::class),
      $this->diContainer->get(SettingsController::class),
      $this->diContainer->get(Analytics::class),
      $this->diContainer->get(SendingServiceKeyCheck::class),
      $this->diContainer->get(PremiumKeyCheck::class),
      $this->diContainer->get(ServicesChecker::class),
      $this->diContainer->get(SubscribersCountReporter::class),
      $mocks['congratulatoryEmailController'] ?? $this->diContainer->get(CongratulatoryMssEmailController::class),
      $this->diContainer->get(WPFunctions::class),
      $mocks['senderDomain'] ?? $this->diContainer->get(AuthorizedSenderDomainController::class),
      $mocks['authorizedEmailsController'] ?? $this->diContainer->get(AuthorizedEmailsController::class)
    );
  }
}