Fix variable names and comments typos

[MAILPOET-4302]
This commit is contained in:
Rostislav Wolny
2022-08-04 15:20:19 +02:00
committed by Veljko V
parent d625457174
commit e03e375942
3 changed files with 31 additions and 31 deletions

View File

@@ -17,10 +17,10 @@ const makeApiRequest = (domain: string) =>
/** /**
* Check domain DMARC policy * Check domain DMARC policy
* *
* returns `false` if not required, `true` if DMARC policy is Retricted * returns `false` if not required, `true` if DMARC policy is Restricted
* @param {string} email Email address * @param {string} email Email address
* @param {boolean} isMssActive Is MailPoet sending service active? * @param {boolean} isMssActive Is MailPoet sending service active?
* @returns {Promise<boolean>} false if not required, `true` if DMARC policy is Retricted * @returns {Promise<boolean>} false if not required, `true` if DMARC policy is Restricted
*/ */
const checkSenderEmailDomainDmarcPolicy = async ( const checkSenderEmailDomainDmarcPolicy = async (
email: string, email: string,
@@ -43,8 +43,8 @@ const checkSenderEmailDomainDmarcPolicy = async (
try { try {
const res = await makeApiRequest(emailAddressDomain); const res = await makeApiRequest(emailAddressDomain);
const isDmarcPolicyRetricted = Boolean(res?.data?.isDmarcPolicyRetricted); const isDmarcPolicyRestricted = Boolean(res?.data?.isDmarcPolicyRestricted);
return isDmarcPolicyRetricted; return isDmarcPolicyRestricted;
} catch (error) { } catch (error) {
// do nothing for now when the request fails // do nothing for now when the request fails
return false; return false;

View File

@@ -263,7 +263,7 @@ class Settings extends APIEndpoint {
$domain = strtolower(trim($domain)); $domain = strtolower(trim($domain));
$response = ['isDmarcPolicyRetricted' => $this->senderDomainController->isDomainDmarcRestricted($domain)]; $response = ['isDmarcPolicyRestricted' => $this->senderDomainController->isDomainDmarcRestricted($domain)];
return $this->successResponse($response); return $this->successResponse($response);
} }

View File

@@ -77,18 +77,18 @@ class AuthorizedSenderDomainControllerTest extends \MailPoetTest {
} }
public function testItReturnsEmptyArrayWhenNoVerifiedSenderDomains() { public function testItReturnsEmptyArrayWhenNoVerifiedSenderDomains() {
$expectaton = Expected::once([]); // with empty array $expectation = Expected::once([]); // with empty array
$bridgeMock = $this->make(Bridge::class, ['getAuthorizedSenderDomains' => $expectaton]); $bridgeMock = $this->make(Bridge::class, ['getAuthorizedSenderDomains' => $expectation]);
$controller = $this->getController($bridgeMock); $controller = $this->getController($bridgeMock);
$verifiedDomains = $controller->getVerifiedSenderDomains(); $verifiedDomains = $controller->getVerifiedSenderDomains();
expect($verifiedDomains)->same([]); expect($verifiedDomains)->same([]);
$domains = ['testdomain.com' => []]; $domains = ['testdomain.com' => []];
$expectaton = Expected::once($domains); $expectation = Expected::once($domains);
$bridgeMock = $this->make(Bridge::class, ['getAuthorizedSenderDomains' => $expectaton]); $bridgeMock = $this->make(Bridge::class, ['getAuthorizedSenderDomains' => $expectation]);
$controller = $this->getController($bridgeMock); $controller = $this->getController($bridgeMock);
$verifiedDomains = $controller->getVerifiedSenderDomains(); $verifiedDomains = $controller->getVerifiedSenderDomains();
expect($verifiedDomains)->same([]); expect($verifiedDomains)->same([]);
@@ -99,12 +99,12 @@ class AuthorizedSenderDomainControllerTest extends \MailPoetTest {
$this->expectExceptionMessage('Sender domain exist'); $this->expectExceptionMessage('Sender domain exist');
$domains = ['testdomain.com' => []]; $domains = ['testdomain.com' => []];
$getSenderDomainsExpectaton = Expected::once($domains); $getSenderDomainsExpectation = Expected::once($domains);
$createSenderDomainsExpectaton = Expected::never(); $createSenderDomainsExpectation = Expected::never();
$bridgeMock = $this->make(Bridge::class, [ $bridgeMock = $this->make(Bridge::class, [
'getAuthorizedSenderDomains' => $getSenderDomainsExpectaton, 'getAuthorizedSenderDomains' => $getSenderDomainsExpectation,
'createAuthorizedSenderDomain' => $createSenderDomainsExpectaton, 'createAuthorizedSenderDomain' => $createSenderDomainsExpectation,
]); ]);
$controller = $this->getController($bridgeMock); $controller = $this->getController($bridgeMock);
$controller->createAuthorizedSenderDomain('testdomain.com'); $controller->createAuthorizedSenderDomain('testdomain.com');
@@ -115,12 +115,12 @@ class AuthorizedSenderDomainControllerTest extends \MailPoetTest {
$this->expectExceptionMessage('Sender domain does not exist'); $this->expectExceptionMessage('Sender domain does not exist');
$domains = ['newdomain.com' => []]; $domains = ['newdomain.com' => []];
$getSenderDomainsExpectaton = Expected::once($domains); $getSenderDomainsExpectation = Expected::once($domains);
$verifySenderDomainsExpectaton = Expected::never(); $verifySenderDomainsExpectation = Expected::never();
$bridgeMock = $this->make(Bridge::class, [ $bridgeMock = $this->make(Bridge::class, [
'getAuthorizedSenderDomains' => $getSenderDomainsExpectaton, 'getAuthorizedSenderDomains' => $getSenderDomainsExpectation,
'verifyAuthorizedSenderDomain' => $verifySenderDomainsExpectaton, 'verifyAuthorizedSenderDomain' => $verifySenderDomainsExpectation,
]); ]);
$controller = $this->getController($bridgeMock); $controller = $this->getController($bridgeMock);
$controller->verifyAuthorizedSenderDomain('testdomain.com'); $controller->verifyAuthorizedSenderDomain('testdomain.com');
@@ -135,12 +135,12 @@ class AuthorizedSenderDomainControllerTest extends \MailPoetTest {
['status' => 'valid'], ['status' => 'valid'],
['status' => 'valid'], ['status' => 'valid'],
]]; ]];
$getSenderDomainsExpectaton = Expected::once($domains); $getSenderDomainsExpectation = Expected::once($domains);
$verifySenderDomainsExpectaton = Expected::never(); $verifySenderDomainsExpectation = Expected::never();
$bridgeMock = $this->make(Bridge::class, [ $bridgeMock = $this->make(Bridge::class, [
'getAuthorizedSenderDomains' => $getSenderDomainsExpectaton, 'getAuthorizedSenderDomains' => $getSenderDomainsExpectation,
'verifyAuthorizedSenderDomain' => $verifySenderDomainsExpectaton, 'verifyAuthorizedSenderDomain' => $verifySenderDomainsExpectation,
]); ]);
$controller = $this->getController($bridgeMock); $controller = $this->getController($bridgeMock);
$controller->verifyAuthorizedSenderDomain('testdomain.com'); $controller->verifyAuthorizedSenderDomain('testdomain.com');
@@ -152,12 +152,12 @@ class AuthorizedSenderDomainControllerTest extends \MailPoetTest {
$this->expectExceptionMessage($errorMessage); $this->expectExceptionMessage($errorMessage);
$domains = ['testdomain.com' => []]; $domains = ['testdomain.com' => []];
$getSenderDomainsExpectaton = Expected::once($domains); $getSenderDomainsExpectation = Expected::once($domains);
$verifySenderDomainsExpectaton = Expected::once(['error' => $errorMessage, 'status' => false]); $verifySenderDomainsExpectation = Expected::once(['error' => $errorMessage, 'status' => false]);
$bridgeMock = $this->make(Bridge::class, [ $bridgeMock = $this->make(Bridge::class, [
'getAuthorizedSenderDomains' => $getSenderDomainsExpectaton, 'getAuthorizedSenderDomains' => $getSenderDomainsExpectation,
'verifyAuthorizedSenderDomain' => $verifySenderDomainsExpectaton, 'verifyAuthorizedSenderDomain' => $verifySenderDomainsExpectation,
]); ]);
$controller = $this->getController($bridgeMock); $controller = $this->getController($bridgeMock);
$controller->verifyAuthorizedSenderDomain('testdomain.com'); $controller->verifyAuthorizedSenderDomain('testdomain.com');
@@ -165,20 +165,20 @@ class AuthorizedSenderDomainControllerTest extends \MailPoetTest {
public function testItReturnsTrueWhenDmarcIsEnabled() { public function testItReturnsTrueWhenDmarcIsEnabled() {
$controller = $this->getController(); $controller = $this->getController();
$isRetricted = $controller->isDomainDmarcRestricted('mailpoet.com'); $isRestricted = $controller->isDomainDmarcRestricted('mailpoet.com');
expect($isRetricted)->same(true); expect($isRestricted)->same(true);
} }
public function testItReturnsFalseWhenDmarcIsNotEnabled() { public function testItReturnsFalseWhenDmarcIsNotEnabled() {
$controller = $this->getController(); $controller = $this->getController();
$isRetricted = $controller->isDomainDmarcRestricted('example.com'); $isRestricted = $controller->isDomainDmarcRestricted('example.com');
expect($isRetricted)->same(false); expect($isRestricted)->same(false);
} }
public function testItReturnsDmarcStatus() { public function testItReturnsDmarcStatus() {
$controller = $this->getController(); $controller = $this->getController();
$isRetricted = $controller->getDmarcPolicyForDomain('example.com'); $isRestricted = $controller->getDmarcPolicyForDomain('example.com');
expect($isRetricted)->same('none'); expect($isRestricted)->same('none');
} }
private function getController($bridgeMock = null): AuthorizedSenderDomainController { private function getController($bridgeMock = null): AuthorizedSenderDomainController {