Skip to content

Add ReCaptcha coverage for Contact GraphQL (SwiftOtter's SOP-348) #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Add ReCaptcha coverage for Contact GraphQL (SwiftOtter's SOP-348) #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b37730b
SwiftOtter-SOP-348 Add missing ReCaptcha coverage for Contact GraphQL
lbajsarowicz May 14, 2024
36932d7
SwiftOtter-SOP-348 Contact From ReCaptcha name change
lbajsarowicz Aug 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions ReCaptchaContact/Model/WebapiConfigProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

declare(strict_types=1);

namespace Magento\ReCaptchaContact\Model;

use Magento\ContactGraphQl\Model\Resolver\ContactUs;
use Magento\ReCaptchaUi\Model\IsCaptchaEnabledInterface;
use Magento\ReCaptchaUi\Model\ValidationConfigResolverInterface;
use Magento\ReCaptchaValidationApi\Api\Data\ValidationConfigInterface;
use Magento\ReCaptchaWebapiApi\Api\Data\EndpointInterface;
use Magento\ReCaptchaWebapiApi\Api\WebapiValidationConfigProviderInterface;

class WebapiConfigProvider implements WebapiValidationConfigProviderInterface
{
private const CAPTCHA_ID = 'contact';

public function __construct(
private readonly IsCaptchaEnabledInterface $isCaptchaEnabled,
private readonly ValidationConfigResolverInterface $configResolver
) {
}

/**
* @inheritDoc
*/
public function getConfigFor(EndpointInterface $endpoint): ?ValidationConfigInterface
{
if ($endpoint->getServiceMethod() === 'resolve'
&& $endpoint->getServiceClass() === ContactUs::class) {
Copy link
Contributor

@ihor-sviziev ihor-sviziev Jul 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see in other places we have a || here. are you sure it should be &&?
Example: https://github.com/magento/security-package/blob/develop/ReCaptchaCustomer/Model/WebapiConfigProvider.php#L65-L69

Copy link
Author

@lbajsarowicz lbajsarowicz Aug 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ihor-sviziev After the research, I found out that \Magento\ReCaptchaSendFriend\Model\WebapiConfigProvider::getConfigFor is the most in-line with Contact form, that's why it's && not ||

if ($this->isCaptchaEnabled->isCaptchaEnabledFor(self::CAPTCHA_ID)) {
return $this->configResolver->get(self::CAPTCHA_ID);
}
}

return null;
}
}
11 changes: 11 additions & 0 deletions ReCaptchaContact/etc/di.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<type name="Magento\ReCaptchaWebapiApi\Model\CompositeWebapiValidationConfigProvider">
<arguments>
<argument name="providers" xsi:type="array">
<item name="contact" xsi:type="object">Magento\ReCaptchaContact\Model\WebapiConfigProvider</item>
</argument>
</arguments>
</type>
</config>