Merge pull request #250 from alma/feature/ecom-4030-fix-php-client-to-avoid-api-mode-values-to-silently-fallback

feat: Fix PHP client to avoid API mode values to silently fallback to…

Author: Benjamin-Freoua-Alma

src/Client/Domain/ValueObject/Environment.php

@@ -27,9 +27,14 @@ final class Environment {
      * @param string $customApiUrl The custom API URL, required if mode is custom
      */
     public function __construct(string $mode, string $customApiUrl = '') {
-        // Check mode
-        if (!in_array($mode, [self::LIVE_MODE, self::TEST_MODE, self::CUSTOM_MODE])) {
-            $mode = self::LIVE_MODE;
+        if (!in_array($mode, [self::LIVE_MODE, self::TEST_MODE, self::CUSTOM_MODE], true)) {
+            throw new InvalidArgumentException(
+                sprintf(
+                    'Invalid environment mode "%s". Allowed values are: %s.',
+                    $mode,
+                    implode(', ', [self::LIVE_MODE, self::TEST_MODE, self::CUSTOM_MODE])
+                )
+            );
         }
         if ($mode === self::CUSTOM_MODE && empty($customApiUrl)) {
             throw new InvalidArgumentException('Custom API URL must be provided for custom mode.');

tests/Client/Unit/Application/ClientConfigurationTest.php

@@ -4,6 +4,7 @@
 
 use Alma\Client\Application\ClientConfiguration;
 use Alma\Client\Domain\ValueObject\Environment;
+use InvalidArgumentException;
 use PHPUnit\Framework\TestCase;
 
 class ClientConfigurationTest extends TestCase
@@ -24,14 +25,14 @@ public function testTestMode()
     }
 
     /**
-     * Ensure we can't create a ClientConfiguration with an invalid mode,
-     * and it defaults to LIVE_MODE
+     * Ensure that creating an Environment with an invalid mode throws an InvalidArgumentException.
      * @return void
      */
     public function testInvalidMode()
     {
-        $clientConfiguration = new ClientConfiguration('sk_test_xxxxxxxxxxxx', new Environment('INVALID_MODE'));
-        $this->assertEquals(new Environment(Environment::LIVE_MODE), $clientConfiguration->getEnvironment());
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Invalid environment mode "INVALID_MODE". Allowed values are: live, test, custom.');
+        new Environment('INVALID_MODE');
     }
 
     /**

tests/Client/Unit/Domain/Entity/EnvironmentTest.php

@@ -28,11 +28,25 @@ public function testEnvironmentModesAreSetCorrectly($mode, $expectedUrl)
         $this->assertEquals(Uri::fromString($expectedUrl), $environment->getBaseUri());
     }
 
-    public function testInvalidModeDefaultsToLive()
+    public static function invalidModesProvider(): array
     {
-        $environment = new Environment('invalid_mode');
-        $this->assertEquals(Environment::LIVE_MODE, $environment->getMode());
-        $this->assertEquals(Uri::fromString(Environment::LIVE_API_URL), $environment->getBaseUri());
+        return [
+            ['invalid_mode'],
+            ['Live'],
+            ['Test'],
+            ['LIVE'],
+        ];
+    }
+
+    /** @dataProvider invalidModesProvider */
+    public function testInvalidModeThrowsException(string $invalidMode)
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage(sprintf(
+            'Invalid environment mode "%s". Allowed values are: live, test, custom.',
+            $invalidMode
+        ));
+        new Environment($invalidMode);
     }
 
     public function testCustomModeWithoutUrlThrowsException()