Move to Str helper in ClientForm

Author: cicnavi

src/Factories/FormFactory.php

@@ -18,13 +18,19 @@
 
 use Nette\Forms\Form;
 use SimpleSAML\Error\Exception;
+use SimpleSAML\Module\oidc\Bridges\SspBridge;
 use SimpleSAML\Module\oidc\Forms\Controls\CsrfProtection;
+use SimpleSAML\Module\oidc\Helpers;
 use SimpleSAML\Module\oidc\ModuleConfig;
 
 class FormFactory
 {
-    public function __construct(private readonly ModuleConfig $moduleConfig, protected CsrfProtection $csrfProtection)
-    {
+    public function __construct(
+        protected readonly ModuleConfig $moduleConfig,
+        protected readonly CsrfProtection $csrfProtection,
+        protected readonly SspBridge $sspBridge,
+        protected readonly Helpers $helpers,
+    ) {
     }
 
     /**
@@ -39,6 +45,11 @@ public function build(string $classname): Form
         }
 
         /** @psalm-suppress UnsafeInstantiation */
-        return new $classname($this->moduleConfig, $this->csrfProtection);
+        return new $classname(
+            $this->moduleConfig,
+            $this->csrfProtection,
+            $this->sspBridge,
+            $this->helpers,
+        );
     }
 }

src/Forms/ClientForm.php

@@ -20,6 +20,7 @@
 use SimpleSAML\Locale\Translate;
 use SimpleSAML\Module\oidc\Bridges\SspBridge;
 use SimpleSAML\Module\oidc\Forms\Controls\CsrfProtection;
+use SimpleSAML\Module\oidc\Helpers;
 use SimpleSAML\Module\oidc\ModuleConfig;
 use SimpleSAML\OpenID\Codebooks\ClientRegistrationTypesEnum;
 use Traversable;
@@ -62,6 +63,7 @@ public function __construct(
         protected readonly ModuleConfig $moduleConfig,
         protected CsrfProtection $csrfProtection,
         protected SspBridge $sspBridge,
+        protected Helpers $helpers,
     ) {
         parent::__construct();
 
@@ -217,14 +219,14 @@ public function getValues(string|object|bool|null $returnType = null, ?array $co
         $values = parent::getValues(self::TYPE_ARRAY);
 
         // Sanitize redirect_uri and allowed_origin
-        $values['redirect_uri'] = $this->convertTextToArrayWithLinesAsValues((string)$values['redirect_uri']);
+        $values['redirect_uri'] = $this->helpers->str()->convertTextToArray((string)$values['redirect_uri']);
         if (! $values['is_confidential'] && isset($values['allowed_origin'])) {
-            $values['allowed_origin'] = $this->convertTextToArrayWithLinesAsValues((string)$values['allowed_origin']);
+            $values['allowed_origin'] = $this->helpers->str()->convertTextToArray((string)$values['allowed_origin']);
         } else {
             $values['allowed_origin'] = [];
         }
         $values['post_logout_redirect_uri'] =
-        $this->convertTextToArrayWithLinesAsValues((string)$values['post_logout_redirect_uri']);
+        $this->helpers->str()->convertTextToArray((string)$values['post_logout_redirect_uri']);
 
         $bclUri = trim((string)$values['backchannel_logout_uri']);
         $values['backchannel_logout_uri'] = empty($bclUri) ? null : $bclUri;
@@ -423,18 +425,6 @@ protected function getScopes(): array
         );
     }
 
-    /**
-     * TODO mivanci Move to Str helper.
-     * @return string[]
-     */
-    protected function convertTextToArrayWithLinesAsValues(string $text): array
-    {
-        return array_filter(
-            preg_split("/[\t\r\n]+/", $text),
-            fn(string $line): bool => !empty(trim($line)),
-        );
-    }
-
     /**
      * @return string[]
      */

src/Services/Container.php

@@ -137,8 +137,19 @@ public function __construct()
         $session = Session::getSessionFromRequest();
         $this->services[Session::class] = $session;
 
+        $sspBridge = new SspBridge();
+        $this->services[SspBridge::class] = $sspBridge;
+
+        $helpers = new Helpers();
+        $this->services[Helpers::class] = $helpers;
+
         $csrfProtection = new CsrfProtection('{oidc:client:csrf_error}', $session);
-        $formFactory = new FormFactory($moduleConfig, $csrfProtection);
+        $formFactory = new FormFactory(
+            $moduleConfig,
+            $csrfProtection,
+            $sspBridge,
+            $helpers,
+        );
         $this->services[FormFactory::class] = $formFactory;
 
         $jsonWebKeySetService = new JsonWebKeySetService($moduleConfig);
@@ -150,9 +161,6 @@ public function __construct()
         $sessionMessagesService = new SessionMessagesService($session);
         $this->services[SessionMessagesService::class] = $sessionMessagesService;
 
-        $sspBridge = new SspBridge();
-        $this->services[SspBridge::class] = $sspBridge;
-
         $oidcMenu = new Menu();
         $this->services[Menu::class] = $oidcMenu;
 
@@ -193,8 +201,6 @@ public function __construct()
         $stateService = new StateService();
         $this->services[StateService::class] = $stateService;
 
-        $helpers = new Helpers();
-
         $core = new Core();
         $this->services[Core::class] = $core;
         $classInstanceBuilder = new ClassInstanceBuilder();

tests/unit/src/Forms/ClientFormTest.php

@@ -6,19 +6,21 @@
 
 use DateTimeImmutable;
 use Laminas\Diactoros\ServerRequest;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\TestDox;
+use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use SimpleSAML\Module\oidc\Bridges\SspBridge;
 use SimpleSAML\Module\oidc\Codebooks\RegistrationTypeEnum;
 use SimpleSAML\Module\oidc\Forms\ClientForm;
 use SimpleSAML\Module\oidc\Forms\Controls\CsrfProtection;
+use SimpleSAML\Module\oidc\Helpers;
 use SimpleSAML\Module\oidc\ModuleConfig;
 
-/**
- * @covers \SimpleSAML\Module\oidc\Forms\ClientForm
- */
+#[CoversClass(ClientForm::class)]
+#[UsesClass(Helpers::class)]
 class ClientFormTest extends TestCase
 {
     protected MockObject $csrfProtectionMock;
@@ -29,6 +31,7 @@ class ClientFormTest extends TestCase
     protected MockObject $sspBridgeMock;
     protected MockObject $sspBridgeAuthMock;
     protected MockObject $sspBridgeAuthSourceMock;
+    protected Helpers $helpers;
 
     protected array $clientDataSample;
 
@@ -42,6 +45,7 @@ public function setUp(): void
         $this->moduleConfigMock = $this->createMock(ModuleConfig::class);
         $this->serverRequestMock = $this->createMock(ServerRequest::class);
         $this->sspBridgeMock = $this->createMock(SspBridge::class);
+        $this->helpers = new Helpers();
 
         $this->sspBridgeAuthMock = $this->createMock(SspBridge\Auth::class);
         $this->sspBridgeMock->method('auth')->willReturn($this->sspBridgeAuthMock);
@@ -85,15 +89,18 @@ protected function sut(
         ?ModuleConfig $moduleConfig = null,
         ?CsrfProtection $csrfProtection = null,
         ?SspBridge $sspBridge = null,
+        ?Helpers $helpers = null,
     ): ClientForm {
         $moduleConfig ??= $this->moduleConfigMock;
         $csrfProtection ??= $this->csrfProtectionMock;
         $sspBridge ??= $this->sspBridgeMock;
+        $helpers ??= $this->helpers;
 
         return new ClientForm(
             $moduleConfig,
             $csrfProtection,
             $sspBridge,
+            $helpers,
         );
     }