IBX-9727: Added type-hints and adapted codebase to PHP8+ for Behat-related code

Author: konradoboza

phpstan-baseline.neon

@@ -12,8 +12,6 @@ services:
 
   Ibexa\AdminUi\Behat\BrowserContext\SystemInfoContext: ~
 
-  Ibexa\AdminUi\Behat\BrowserContext\AdministrationContext: ~
-
   Ibexa\AdminUi\Behat\BrowserContext\DashboardContext: ~
 
   Ibexa\AdminUi\Behat\BrowserContext\ContentActionsMenuContext: ~

src/bundle/Resources/config/services/test/feature_contexts.yaml

@@ -15,18 +15,18 @@
 
 final class AutosaveService implements AutosaveServiceInterface
 {
-    private UserSettingService $userSettingService;
-
     private bool $inProgress = false;
 
-    public function __construct(UserSettingService $userSettingService)
-    {
-        $this->userSettingService = $userSettingService;
+    public function __construct(
+        private readonly UserSettingService $userSettingService
+    ) {
     }
 
     public function isEnabled(): bool
     {
-        return $this->userSettingService->getUserSetting(Autosave::IDENTIFIER)->value === Autosave::ENABLED_OPTION;
+        return $this->userSettingService->getUserSetting(
+            Autosave::IDENTIFIER
+        )->value === Autosave::ENABLED_OPTION;
     }
 
     /**

src/lib/Autosave/AutosaveService.php

@@ -12,13 +12,11 @@
 use Behat\Gherkin\Node\TableNode;
 use Ibexa\AdminUi\Behat\Page\AdminUpdateItemPage;
 
-class AdminUpdateContext implements Context
+final readonly class AdminUpdateContext implements Context
 {
-    private AdminUpdateItemPage $adminUpdateItemPage;
-
-    public function __construct(AdminUpdateItemPage $adminUpdateItemPage)
-    {
-        $this->adminUpdateItemPage = $adminUpdateItemPage;
+    public function __construct(
+        private AdminUpdateItemPage $adminUpdateItemPage
+    ) {
     }
 
     /**

src/lib/Behat/BrowserContext/AdminUpdateContext.php

@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\AdminUi\Behat\BrowserContext;
 
@@ -12,16 +13,12 @@
 use Ibexa\AdminUi\Behat\Page\ContentViewPage;
 use PHPUnit\Framework\Assert;
 
-class BookmarkContext implements Context
+final readonly class BookmarkContext implements Context
 {
-    private ContentViewPage $contentViewPage;
-
-    private BookmarksPage $bookmarksPage;
-
-    public function __construct(ContentViewPage $contentViewPage, BookmarksPage $bookmarksPage)
-    {
-        $this->contentViewPage = $contentViewPage;
-        $this->bookmarksPage = $bookmarksPage;
+    public function __construct(
+        private ContentViewPage $contentViewPage,
+        private BookmarksPage $bookmarksPage
+    ) {
     }
 
     /**

src/lib/Behat/BrowserContext/BookmarkContext.php

@@ -13,13 +13,10 @@
 use Ibexa\AdminUi\Behat\Component\ContentActionsMenu;
 use PHPUnit\Framework\Assert;
 
-class ContentActionsMenuContext implements Context
+final readonly class ContentActionsMenuContext implements Context
 {
-    private ContentActionsMenu $contentActionsMenu;
-
-    public function __construct(ContentActionsMenu $contentActionsMenu)
+    public function __construct(private ContentActionsMenu $contentActionsMenu)
     {
-        $this->contentActionsMenu = $contentActionsMenu;
     }
 
     /**

src/lib/Behat/BrowserContext/ContentActionsMenuContext.php

@@ -11,13 +11,10 @@
 use Behat\Behat\Context\Context;
 use Ibexa\AdminUi\Behat\Page\ContentPreviewPage;
 
-class ContentPreviewContext implements Context
+final readonly class ContentPreviewContext implements Context
 {
-    private ContentPreviewPage $contentPreviewPage;
-
-    public function __construct(ContentPreviewPage $contentPreviewPage)
+    public function __construct(private ContentPreviewPage $contentPreviewPage)
     {
-        $this->contentPreviewPage = $contentPreviewPage;
     }
 
     /**

src/lib/Behat/BrowserContext/ContentPreviewContext.php

@@ -16,26 +16,14 @@
 use Ibexa\AdminUi\Behat\Page\ContentTypeUpdatePage;
 use PHPUnit\Framework\Assert;
 
-class ContentTypeContext implements Context
+final readonly class ContentTypeContext implements Context
 {
-    private ContentTypePage $contentTypePage;
-
-    private ContentTypeUpdatePage $contentTypeUpdatePage;
-
-    private ContentTypeGroupPage $contentTypeGroupPage;
-
-    private ContentTypeGroupsPage $contentTypeGroupsPage;
-
     public function __construct(
-        ContentTypePage $contentTypePage,
-        ContentTypeUpdatePage $contentTypeUpdatePage,
-        ContentTypeGroupPage $contentTypeGroupPage,
-        ContentTypeGroupsPage $contentTypeGroupsPage
+        private ContentTypePage $contentTypePage,
+        private ContentTypeUpdatePage $contentTypeUpdatePage,
+        private ContentTypeGroupPage $contentTypeGroupPage,
+        private ContentTypeGroupsPage $contentTypeGroupsPage
     ) {
-        $this->contentTypePage = $contentTypePage;
-        $this->contentTypeUpdatePage = $contentTypeUpdatePage;
-        $this->contentTypeGroupPage = $contentTypeGroupPage;
-        $this->contentTypeGroupsPage = $contentTypeGroupsPage;
     }
 
     /**
@@ -79,7 +67,7 @@ public function contentTypeHasProperFields(TableNode $table): void
     /**
      * @Given there's no :contentTypeName on content types list
      */
-    public function thereSNoOnContentTypesList($contentTypeName): void
+    public function thereSNoOnContentTypesList(string $contentTypeName): void
     {
         Assert::assertFalse($this->contentTypeGroupPage->isContentTypeOnTheList($contentTypeName));
     }
@@ -103,7 +91,7 @@ public function thereSAOnContentTypesGroupList(string $contentTypeGroupName): vo
     /**
      * @Given there's a :contentTypeName on content types list
      */
-    public function thereAContentTypeOnContentTypesList($contentTypeName): void
+    public function thereAContentTypeOnContentTypesList(string $contentTypeName): void
     {
         Assert::assertTrue($this->contentTypeGroupPage->isContentTypeOnTheList($contentTypeName));
     }
@@ -129,9 +117,9 @@ public function iAddField(string $fieldName): void
     /**
      * @When I set :field to :value for :fieldName field
      */
-    public function iSetFieldDefinitionData(string $label, string $value, string $fieldName): void
+    public function iSetFieldDefinitionData(string $label, string $value): void
     {
-        $this->contentTypeUpdatePage->fillFieldDefinitionFieldWithValue($fieldName, $label, $value);
+        $this->contentTypeUpdatePage->fillFieldDefinitionFieldWithValue($label, $value);
     }
 
     /**
@@ -232,7 +220,7 @@ public function contentTypeGroupCannotBeSelected(string $contentTypeGroupName):
     public function iCheckBlockInField(string $blockName): void
     {
         $this->contentTypeUpdatePage->verifyIsLoaded();
-        $this->contentTypeUpdatePage->expandLastFieldDefinition('fieldDefinitionOpenContainerEdit');
+        $this->contentTypeUpdatePage->expandLastFieldDefinition();
         $this->contentTypeUpdatePage->expandDefaultBlocksOption();
         $this->contentTypeUpdatePage->selectBlock($blockName);
     }

src/lib/Behat/BrowserContext/ContentTypeContext.php

@@ -15,16 +15,12 @@
 use Ibexa\AdminUi\Behat\Page\UserUpdatePage;
 use PHPUnit\Framework\Assert;
 
-class ContentUpdateContext implements Context
+final readonly class ContentUpdateContext implements Context
 {
-    private ContentUpdateItemPage $contentUpdateItemPage;
-
-    private UserUpdatePage $userUpdatePage;
-
-    public function __construct(ContentUpdateItemPage $contentUpdateItemPage, UserUpdatePage $userUpdatePage)
-    {
-        $this->contentUpdateItemPage = $contentUpdateItemPage;
-        $this->userUpdatePage = $userUpdatePage;
+    public function __construct(
+        private ContentUpdateItemPage $contentUpdateItemPage,
+        private UserUpdatePage $userUpdatePage
+    ) {
     }
 
     /**
@@ -49,7 +45,7 @@ public function fieldContainsValidationError(string $fieldName, string $errorMes
     }
 
     /**
-     * @Given the :fieldName field is noneditable
+     * @Given the :fieldName field is non-editable
      */
     public function verifyFieldIsNotEditable(string $fieldName): void
     {
@@ -85,6 +81,11 @@ public function selectContentFromIARepository(string $contentPath, string $field
         $this->contentUpdateItemPage->getField($fieldName)->selectFromRepository($contentPath);
     }
 
+    /**
+     * @param array<string, mixed> $parameters
+     *
+     * @return array<string, mixed>
+     */
     private function filterOutNonEmptyValues(array $parameters): array
     {
         $values = $parameters;

src/lib/Behat/BrowserContext/ContentUpdateContext.php

@@ -15,22 +15,13 @@
 use Ibexa\Behat\Core\Behat\ArgumentParser;
 use PHPUnit\Framework\Assert;
 
-final class ContentViewContext implements Context
+final readonly class ContentViewContext implements Context
 {
-    private ArgumentParser $argumentParser;
-
-    private ContentViewPage $contentViewPage;
-
-    private DraftConflictDialog $draftConflictDialog;
-
     public function __construct(
-        ArgumentParser $argumentParser,
-        ContentViewPage $contentViewPage,
-        DraftConflictDialog $draftConflictDialog
+        private ArgumentParser $argumentParser,
+        private ContentViewPage $contentViewPage,
+        private DraftConflictDialog $draftConflictDialog
     ) {
-        $this->argumentParser = $argumentParser;
-        $this->contentViewPage = $contentViewPage;
-        $this->draftConflictDialog = $draftConflictDialog;
     }
 
     /**