Fix: logger service injection (#581)

joyet-simon · joyet.simon · web-flow · commit a9945989cf2e · 2026-04-20T10:59:01.000+02:00
* fix: update constructor parameters to require LoggerService

* fix: add LoggerService dependency to ConfigFormMapper and update related tests

* fix: inject ConfigService into AbstractLoggerService to simulate MullLogger

---------

Co-authored-by: joyet.simon &lt;joyet.simon@getalma.eu&gt;
diff --git a/includes/Application/Entity/Form/FeePlanConfiguration.php b/includes/Application/Entity/Form/FeePlanConfiguration.php
@@ -10,7 +10,6 @@
 use Alma\Gateway\Infrastructure\Adapter\FeePlanAdapter;
 use Alma\Gateway\Infrastructure\Service\LoggerService;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 /**
  * Class FeePlanDataForm
@@ -48,14 +47,14 @@ class FeePlanConfiguration {
 	 * @param int                $minAmount
 	 * @param int                $maxAmount
 	 * @param bool               $enabled
-	 * @param LoggerService|null $loggerService
+	 * @param LoggerService $loggerService
 	 */
-	public function __construct( string $planKey, int $minAmount, int $maxAmount, bool $enabled, ?LoggerService $loggerService = null ) {
+	public function __construct( string $planKey, int $minAmount, int $maxAmount, bool $enabled, LoggerService $loggerService ) {
 		$this->planKey       = $planKey;
 		$this->minAmount     = $minAmount;
 		$this->maxAmount     = $maxAmount;
 		$this->enabled       = $enabled;
-		$this->loggerService = $loggerService ?? new NullLogger();
+		$this->loggerService = $loggerService;
 	}
 
 	/**
diff --git a/includes/Application/Provider/FeePlanProvider.php b/includes/Application/Provider/FeePlanProvider.php
@@ -15,7 +15,6 @@
 use Alma\Plugin\Application\Port\FeePlanProviderInterface;
 use Alma\Plugin\Infrastructure\Adapter\FeePlanListInterface;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 class FeePlanProvider implements FeePlanProviderInterface, ProviderInterface {
 
@@ -32,11 +31,11 @@ class FeePlanProvider implements FeePlanProviderInterface, ProviderInterface {
 	 * FeePlanProvider constructor.
 	 *
 	 * @param MerchantEndpoint   $merchantEndpoint
-	 * @param LoggerService|null $loggerService
+	 * @param LoggerService $loggerService
 	 */
-	public function __construct( MerchantEndpoint $merchantEndpoint, ?LoggerService $loggerService = null ) {
+	public function __construct( MerchantEndpoint $merchantEndpoint, LoggerService $loggerService ) {
 		$this->merchantEndpoint = $merchantEndpoint;
-		$this->loggerService    = $loggerService ?? new NullLogger();
+		$this->loggerService    = $loggerService;
 	}
 
 	/**
diff --git a/includes/Application/Provider/MerchantProvider.php b/includes/Application/Provider/MerchantProvider.php
@@ -14,7 +14,6 @@
 use Alma\Gateway\Infrastructure\Service\LoggerService;
 use Alma\Plugin\Application\Port\MerchantProviderInterface;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 class MerchantProvider implements MerchantProviderInterface, ProviderInterface {
 
@@ -28,10 +27,11 @@ class MerchantProvider implements MerchantProviderInterface, ProviderInterface {
 	 * MerchantProvider constructor.
 	 *
 	 * @param MerchantEndpoint $merchantEndpoint The merchant endpoint to use for API calls.
+	 * @param LoggerService    $loggerService
 	 */
-	public function __construct( MerchantEndpoint $merchantEndpoint, ?LoggerService $loggerService = null ) {
+	public function __construct( MerchantEndpoint $merchantEndpoint, LoggerService $loggerService ) {
 		$this->merchantEndpoint = $merchantEndpoint;
-		$this->loggerService    = $loggerService ?? new NullLogger();
+		$this->loggerService    = $loggerService;
 	}
 
 	/**
diff --git a/includes/Application/Provider/PaymentProvider.php b/includes/Application/Provider/PaymentProvider.php
@@ -17,7 +17,6 @@
 use Alma\Gateway\Infrastructure\Service\LoggerService;
 use Alma\Plugin\Application\Port\PaymentProviderInterface;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 class PaymentProvider implements PaymentProviderInterface, ProviderInterface {
 
@@ -31,10 +30,11 @@ class PaymentProvider implements PaymentProviderInterface, ProviderInterface {
 	 * PaymentService constructor.
 	 *
 	 * @param PaymentEndpoint $paymentEndpoint The payment endpoint to use for API calls.
+	 * @param LoggerService   $loggerService
 	 */
-	public function __construct( PaymentEndpoint $paymentEndpoint, ?LoggerService $loggerService = null ) {
+	public function __construct( PaymentEndpoint $paymentEndpoint, LoggerService $loggerService ) {
 		$this->paymentEndpoint = $paymentEndpoint;
-		$this->loggerService   = $loggerService ?? new NullLogger();
+		$this->loggerService   = $loggerService;
 	}
 
 	/**
diff --git a/includes/Application/Service/AuthenticationService.php b/includes/Application/Service/AuthenticationService.php
@@ -13,7 +13,6 @@
 use Alma\Client\Domain\ValueObject\Environment;
 use Alma\Gateway\Infrastructure\Service\LoggerService;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 class AuthenticationService {
 
@@ -23,10 +22,10 @@ class AuthenticationService {
 	/**
 	 * AuthenticationService constructor.
 	 *
-	 * @param LoggerService|null $loggerService
+	 * @param LoggerService $loggerService
 	 */
-	public function __construct( ?LoggerService $loggerService = null ) {
-		$this->loggerService = $loggerService ?? new NullLogger();
+	public function __construct( LoggerService $loggerService ) {
+		$this->loggerService = $loggerService ;
 	}
 
 	/**
diff --git a/includes/Application/Service/IpnService.php b/includes/Application/Service/IpnService.php
@@ -21,7 +21,6 @@
 use Alma\Gateway\Plugin;
 use Alma\Plugin\Infrastructure\Helper\NavigationHelperInterface;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 /**
  * Class IpnService
@@ -57,14 +56,14 @@ public function __construct(
 		PaymentProvider $paymentService,
 		NavigationHelperInterface $navigationHelper,
 		IpnHelper $ipnHelper,
-		?LoggerService $loggerService = null
+		LoggerService $loggerService
 	) {
 		$this->configService    = $configService;
 		$this->fraudService     = $fraudService;
 		$this->paymentService   = $paymentService;
 		$this->navigationHelper = $navigationHelper;
 		$this->ipnHelper        = $ipnHelper;
-		$this->loggerService    = $loggerService ?? new NullLogger();
+		$this->loggerService    = $loggerService;
 	}
 
 	/**
diff --git a/includes/Infrastructure/Mapper/ConfigFormMapper.php b/includes/Infrastructure/Mapper/ConfigFormMapper.php
@@ -13,6 +13,7 @@
 use Alma\Gateway\Application\Helper\DisplayHelper;
 use Alma\Gateway\Application\Service\AuthenticationService;
 use Alma\Gateway\Application\Service\ConfigService;
+use Alma\Gateway\Infrastructure\Service\LoggerService;
 
 class ConfigFormMapper {
 
@@ -22,10 +23,13 @@ class ConfigFormMapper {
 	private array $settings;
 	/** @var AuthenticationService */
 	private AuthenticationService $authentication_service;
+	/** @var LoggerService */
+	private LoggerService $logger_service;
 
-	public function __construct( ConfigService $config_service, AuthenticationService $authentication_service ) {
+	public function __construct( ConfigService $config_service, AuthenticationService $authentication_service, LoggerService $logger_service ) {
 		$this->config_service         = $config_service;
 		$this->authentication_service = $authentication_service;
+		$this->logger_service         = $logger_service;
 	}
 
 	/**
@@ -124,7 +128,8 @@ private function process_fee_plan_configuration_list(): FeePlanConfigurationList
 				$key,
 				$value[ GatewayConfigurationForm::MIN_AMOUNT_SUFFIX ],
 				$value[ GatewayConfigurationForm::MAX_AMOUNT_SUFFIX ],
-				$value[ GatewayConfigurationForm::ENABLED_SUFFIX ]
+				$value[ GatewayConfigurationForm::ENABLED_SUFFIX ],
+				$this->logger_service
 			);
 			$fee_plan_configuration_array[] = $feePlanConfiguration;
 		}
diff --git a/includes/Infrastructure/Repository/GatewayRepository.php b/includes/Infrastructure/Repository/GatewayRepository.php
@@ -21,7 +21,6 @@
 use Alma\Gateway\Plugin;
 use Alma\Plugin\Infrastructure\Repository\GatewayRepositoryInterface;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 class GatewayRepository implements GatewayRepositoryInterface {
 
@@ -53,8 +52,8 @@ class GatewayRepository implements GatewayRepositoryInterface {
 		CreditGatewayBlock::class,
 	];
 
-	public function __construct( ?LoggerService $loggerService = null ) {
-		$this->loggerService = $loggerService ?? new NullLogger();
+	public function __construct( LoggerService $loggerService ) {
+		$this->loggerService = $loggerService;
 	}
 
 	/**
diff --git a/includes/Infrastructure/Service/AbstractLoggerService.php b/includes/Infrastructure/Service/AbstractLoggerService.php
@@ -6,6 +6,7 @@
 	die( 'Not allowed' ); // Exit if accessed directly.
 }
 
+use Alma\Gateway\Application\Service\ConfigService;
 use Psr\Log\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
@@ -22,10 +23,12 @@ abstract class AbstractLoggerService implements LoggerInterface {
 	 * @var string
 	 */
 	private string $source;
+	private ConfigService $configService;
 
-	public function __construct( string $source = 'alma' ) {
+	public function __construct( ConfigService $configService, string $source = 'alma' ) {
 		$this->woo_logger = new WC_Logger();
 		$this->source     = $source;
+		$this->configService = $configService;
 	}
 
 	/**
@@ -40,6 +43,9 @@ public function __construct( string $source = 'alma' ) {
 	 *
 	 */
 	public function log( $level, $message, array $context = array() ): void {
+		if (! $this->configService->isDebug() ) {
+			return;
+		}
 		if ( ! in_array( $level, $this->get_psr_levels(), true ) ) {
 			throw new InvalidArgumentException( "Invalid log level: $level" );
 		}
diff --git a/includes/Infrastructure/Service/GatewayService.php b/includes/Infrastructure/Service/GatewayService.php
@@ -23,6 +23,7 @@
 use Alma\Gateway\Infrastructure\Repository\UserRepository;
 use Alma\Gateway\Plugin;
 use Automattic\WooCommerce\Blocks\Payments\PaymentMethodRegistry;
+use Psr\Log\LoggerInterface;
 
 class GatewayService {
 
@@ -35,16 +36,21 @@ class GatewayService {
 
 	private BusinessEventsService $businessEventsService;
 
+	/** @var LoggerInterface */
+	private LoggerInterface $loggerService;
+
 	public function __construct(
 		PaymentProviderFactory $paymentProviderFactory,
 		GatewayRepository $gatewayRepository,
 		AssetsService $assetsService,
-		BusinessEventsService $businessEventsService
+		BusinessEventsService $businessEventsService,
+		LoggerService $loggerService
 	) {
 		$this->paymentProviderFactory = $paymentProviderFactory;
 		$this->gatewayRepository      = $gatewayRepository;
 		$this->assetsService          = $assetsService;
 		$this->businessEventsService  = $businessEventsService;
+		$this->loggerService    = $loggerService ;
 	}
 
 	/**
@@ -102,7 +108,7 @@ public function woocommerceOrderStatusChanged(
 		try {
 			$this->businessEventsService->onOrderConfirmed( $oldStatus, $newStatus, $order );
 		} catch ( BusinessEventsServiceException $e ) {
-			throw new GatewayServiceException( 'Order confirmed does not sent', 0, $e );
+			$this->loggerService->debug($e->getMessage());
 		}
 	}
 
diff --git a/tests/Unit/Application/Entity/Form/FeePlanConfigurationTest.php b/tests/Unit/Application/Entity/Form/FeePlanConfigurationTest.php
@@ -5,6 +5,7 @@
 use Alma\Client\Application\Exception\ParametersException;
 use Alma\Gateway\Application\Entity\Form\FeePlanConfiguration;
 use Alma\Gateway\Infrastructure\Adapter\FeePlanAdapter;
+use Alma\Gateway\Infrastructure\Service\LoggerService;
 use PHPUnit\Framework\TestCase;
 
 class FeePlanConfigurationTest extends TestCase {
@@ -16,18 +17,22 @@ class FeePlanConfigurationTest extends TestCase {
 	private FeePlanConfiguration $badFeePlanConfiguration;
 
 	public function setUp(): void {
+		$loggerServiceMock = $this->createMock( LoggerService::class );
+
 		$this->feePlanConfiguration = new FeePlanConfiguration(
 			'general_2_0_0',
 			self::MIN_PURCHASE_AMOUNT,
 			self::MAX_PURCHASE_AMOUNT,
-			true
+			true,
+			$loggerServiceMock
 		);
 
 		$this->badFeePlanConfiguration = new FeePlanConfiguration(
 			'general_2_0_0',
 			190000,
 			6000,
-			true
+			true,
+			$loggerServiceMock
 		);
 	}
 
diff --git a/tests/Unit/Application/Provider/FeePlanProviderTest.php b/tests/Unit/Application/Provider/FeePlanProviderTest.php
@@ -6,12 +6,14 @@
 use Alma\Client\Application\Exception\Endpoint\MerchantEndpointException;
 use Alma\Client\Domain\Entity\FeePlanList;
 use Alma\Gateway\Application\Provider\FeePlanProvider;
+use Alma\Gateway\Infrastructure\Service\LoggerService;
 use PHPUnit\Framework\TestCase;
 
 class FeePlanProviderTest extends TestCase {
 
 	private $feePlanProvider;
 	private $merchantEndpoint;
+	private $loggerServiceMock;
 
 
 	public function testGetFeePlanListCallsMerchantEndpointOnlyOnce() {
@@ -52,13 +54,15 @@ public function testGetFeePlanListCallsMerchantEndpointThrowException() {
 	}
 
 	protected function setUp(): void {
-		$this->merchantEndpoint = $this->createMock( MerchantEndpoint::class );
-		$this->feePlanProvider  = new FeePlanProvider( $this->merchantEndpoint );
+		$this->merchantEndpoint  = $this->createMock( MerchantEndpoint::class );
+		$this->loggerServiceMock = $this->createMock( LoggerService::class );
+		$this->feePlanProvider   = new FeePlanProvider( $this->merchantEndpoint, $this->loggerServiceMock );
 	}
 
 	protected function tearDown(): void {
-		$this->merchantEndpoint = null;
-		$this->feePlanProvider  = null;
+		$this->merchantEndpoint  = null;
+		$this->loggerServiceMock = null;
+		$this->feePlanProvider   = null;
 	}
 
 }
diff --git a/tests/Unit/Infrastructure/Mapper/ConfigFormMapperTest.php b/tests/Unit/Infrastructure/Mapper/ConfigFormMapperTest.php
@@ -10,6 +10,7 @@
 use Alma\Gateway\Application\Service\AuthenticationService;
 use Alma\Gateway\Application\Service\ConfigService;
 use Alma\Gateway\Infrastructure\Mapper\ConfigFormMapper;
+use Alma\Gateway\Infrastructure\Service\LoggerService;
 use PHPUnit\Framework\TestCase;
 
 class ConfigFormMapperTest extends TestCase {
@@ -40,10 +41,11 @@ class ConfigFormMapperTest extends TestCase {
 	public function setUp(): void {
 
 		$authenticationServiceMock = $this->createMock( AuthenticationService::class );
+		$loggerServiceMock         = $this->createMock( LoggerService::class );
 		$this->configServiceMock   = $this->createMock( ConfigService::class );
 		$env                       = new Environment( Environment::LIVE_MODE );
 		$this->configServiceMock->method( 'getEnvironment' )->willReturn( $env );
-		$this->configFormMapper = new ConfigFormMapper( $this->configServiceMock, $authenticationServiceMock );
+		$this->configFormMapper = new ConfigFormMapper( $this->configServiceMock, $authenticationServiceMock, $loggerServiceMock );
 
 		$this->keySettings        = [
 			'test_api_key' => 'test_key_123',
diff --git a/tests/Unit/Infrastructure/Service/GatewayServiceTest.php b/tests/Unit/Infrastructure/Service/GatewayServiceTest.php
