FEATURE: Custom graphql adapter

.gitattributes

@@ -4,8 +4,7 @@
 Plugin.js binary
 Plugin.css binary
 
-/Resources/Private/JavaScript export-ignore
-/Tests export-ignore
+/packages export-ignore
 /.yarn export-ignore
 /.env export-ignore
 /.github export-ignore

.github/workflows/tests.yml

@@ -6,6 +6,10 @@ on:
   pull_request:
     branches: [ main ]
 
+env:
+  YARN_ENABLE_IMMUTABLE_INSTALLS: false
+  PACKAGE_FOLDER: media-ui
+
 jobs:
   lint:
     runs-on: ubuntu-latest
@@ -50,6 +54,7 @@ jobs:
         uses: php-actions/phpstan@v3
         with:
           php_version: 8.1
+          version: 2.1.17
           command: analyse
           path: 'Classes/'
 
@@ -64,10 +69,14 @@ jobs:
       fail-fast: false
       matrix:
         php-versions: ['8.1']
-        flow-versions: ['7.3']
+        flow-versions: ['8.3']
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+
+      - name: Set package branch name
+        run: echo "PACKAGE_TARGET_VERSION=${GITHUB_BASE_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_ENV
+        working-directory: .
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
@@ -78,7 +87,7 @@ jobs:
           ini-values: opcache.fast_shutdown=0
 
       - name: Cache dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: ~/.composer/cache
           key: dependencies-composer-${{ hashFiles('composer.json') }}
@@ -87,14 +96,17 @@ jobs:
         run: |
           git clone https://github.com/neos/flow-base-distribution.git -b ${{ matrix.flow-versions }} ${FLOW_FOLDER}
           cd ${FLOW_FOLDER}
-          composer require --no-update --no-interaction flowpack/media-ui
+          composer require --no-update --no-interaction flowpack/entity-usage:"^1.1"
+          composer require --no-update --no-interaction flowpack/entity-usage-databasestorage:"^0.1"
+
+          git -C ../${{ env.PACKAGE_FOLDER }} checkout -b build
+          composer config repositories.package '{ "type": "path", "url": "../${{ env.PACKAGE_FOLDER }}", "options": { "symlink": false } }'
+          composer require --no-update --no-interaction flowpack/media-ui:"dev-build as dev-${PACKAGE_TARGET_VERSION}"
 
-      - name: Install distribution
+      - name: Composer Install
         run: |
           cd ${FLOW_FOLDER}
-          composer install --no-interaction --no-progress
-          rm -rf Packages/Application/Flowpack.Media.Ui
-          cp -r ../media-ui Packages/Application/Flowpack.Media.Ui
+          composer update --no-interaction --no-progress
 
       - name: Run Unit tests
         run: |
@@ -126,6 +138,7 @@ jobs:
     env:
       # Solves error when parcel tries to count cpus via lscpu
       PARCEL_WORKERS: 1
+      DEBUG: 'testcafe:tested-app:*'
 
     runs-on: ubuntu-latest
 
@@ -146,11 +159,11 @@ jobs:
         run: yarn build:plugin
 
       - name: Run TestCafe
-        run: yarn test:github-actions
+        run: yarn test:e2e:github-actions
 
       - name: Archive failure screenshots
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: e2e-failure-screenshots
           path: screenshots

.gitignore

@@ -14,17 +14,14 @@ node_modules
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
-Packages
-vendor
-composer.lock
+yarn-error.log
 /.parcel-cache
+.cache
 
 #
 # Compiled assets.
 #
-.cache
-Resources/Private/JavaScript/dev-server/dist
-yarn-error.log
+/packages/dev-server/dist
 
 #
 # editors / IDEs

.mocharc.json

@@ -1,5 +1,5 @@
 {
   "extension": ["ts"],
-  "spec": "Resources/Private/JavaScript/**/*.spec.ts",
+  "spec": "packages/**/*.spec.ts",
   "require": "ts-node/register"
 }

.nvmrc

@@ -1 +1 @@
-16
+22

.testcaferc.json

@@ -1,19 +1,20 @@
 {
   "browsers": {
-    "path": "chromium",
+    "path": "firefox",
     "cmd": "--window-size=1280,720"
   },
-  "src": ["Resources/Private/JavaScript/media-module/tests/**/*.ts"],
-  "appCommand": "yarn ts-node --project Resources/Private/JavaScript/dev-server/tsconfig.json Resources/Private/JavaScript/dev-server/src/server.ts",
+  "src": ["packages/media-module/tests/**/*.ts"],
+  "appCommand": "yarn dev:test",
+  "appInitDelay": 2000,
   "screenshots": {
     "takeOnFails": true
   },
+  "debugOnFail": false,
   "stopOnFirstFail": true,
-  "hostname": "localhost",
+  "hostname": "127.0.0.1",
+  "baseUrl": "http://127.0.0.1:8000",
   "retryTestPages": true,
   "pageLoadTimeout": 10000,
   "pageRequestTimeout": 60000,
-  "skipJsErrors": {
-    "stack": "/.*chrome-extension.*/ig"
-  }
+  "skipJsErrors": true
 }

.yarnrc.yml

@@ -2,10 +2,4 @@ enableGlobalCache: true
 
 nodeLinker: node-modules
 
-plugins:
-  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
-    spec: "@yarnpkg/plugin-workspace-tools"
-  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
-    spec: "@yarnpkg/plugin-interactive-tools"
-
-yarnPath: .yarn/releases/yarn-3.4.1.cjs
+yarnPath: .yarn/releases/yarn-4.9.1.cjs

Classes/Aspect/HierarchicalAssetCollectionRepositoryAspect.php

@@ -47,6 +47,7 @@ public function remove(JoinPointInterface $joinPoint): void
         $persistenceManager = ObjectAccess::getProperty($assetCollectionRepository, 'persistenceManager', true);
 
         $deleteRecursively = static function (AssetCollection $collection) use (&$deleteRecursively, $persistenceManager, $assetCollectionRepository) {
+            /** @noinspection PhpUndefinedMethodInspection */
             $childCollections = $assetCollectionRepository->findByParent($collection);
             foreach ($childCollections as $childCollection) {
                 $deleteRecursively($childCollection);

Classes/Command/AssetCollectionsCommandController.php

@@ -71,11 +71,10 @@ public function hierarchyCommand(): void
 
     public function setParentCommand(string $assetCollectionIdentifier, string $parentAssetCollectionIdentifier): void
     {
-        /** @var AssetCollection $assetCollection */
+        /** @var HierarchicalAssetCollectionInterface $assetCollection */
         $assetCollection = $this->assetCollectionRepository->findByIdentifier($assetCollectionIdentifier);
-        /** @var AssetCollection $parentAssetCollection */
+        /** @var HierarchicalAssetCollectionInterface $parentAssetCollection */
         $parentAssetCollection = $this->assetCollectionRepository->findByIdentifier($parentAssetCollectionIdentifier);
-        /** @var HierarchicalAssetCollectionInterface $assetCollection */
         $assetCollection->setParent($parentAssetCollection);
         $this->assetCollectionRepository->update($assetCollection);
         $this->assetCollectionService->updatePathForNestedAssetCollections($assetCollection);

Classes/Command/MediaUiCommandController.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flowpack\Media\Ui\Command;
+
+/*
+ * This file is part of the Flowpack.Media.Ui package.
+ *
+ * (c) Contributors of the Neos Project - www.neos.io
+ *
+ * This package is Open Source Software. For the full copyright and license
+ * information, please view the LICENSE file which was distributed with this
+ * source code.
+ */
+
+use Flowpack\Media\Ui\GraphQL\MediaApi;
+use Flowpack\Media\Ui\GraphQL\Middleware\GraphQLMiddleware;
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\Cli\CommandController;
+use Neos\Flow\Package\PackageManager;
+use Neos\Utility\Files;
+use Wwwision\TypesGraphQL\GraphQLGenerator;
+
+#[Flow\Scope('singleton')]
+class MediaUiCommandController extends CommandController
+{
+
+    #[Flow\Inject]
+    protected PackageManager $packageManager;
+
+    /**
+     * @var GraphQLMiddleware
+     */
+    #[Flow\Inject('Flowpack.Media.Ui:GraphQLMiddleware')]
+    protected $mediaApiMiddleware;
+
+    /**
+     * @internal only for development
+     */
+    public function createSchemaCommand(): void
+    {
+        $this->outputLine('Creating GraphQL schema...');
+
+        $generator = new GraphQLGenerator();
+        $schema = $generator->generate(
+            MediaApi::class,
+            $this->mediaApiMiddleware->getCustomResolvers(),
+        )->render();
+
+        $path = Files::concatenatePaths([
+            $this->packageManager->getPackage('Flowpack.Media.Ui')->getPackagePath(),
+            'Resources',
+            'Private',
+            'GraphQL',
+            'schema.root.graphql',
+        ]);
+
+        file_put_contents($path, $schema);
+
+        $this->outputFormatted('GraphQL schema created at: %s', [$path]);
+    }
+}

Classes/Controller/MediaController.php

@@ -18,9 +18,7 @@
 use Neos\Fusion\View\FusionView;
 use Neos\Neos\Controller\Module\AbstractModuleController;
 
-/**
- * @Flow\Scope("singleton")
- */
+#[Flow\Scope('singleton')]
 class MediaController extends AbstractModuleController
 {
     /**

Classes/Domain/Model/AssetSource/NeosAssetProxyRepository.php

@@ -48,15 +48,15 @@ final class NeosAssetProxyRepository implements AssetProxyRepositoryInterface, S
                                                 SupportsCollectionsInterface, SupportsTaggingInterface
 {
     /**
-     * @Flow\Inject
      * @var ObjectManagerInterface
      */
+    #[Flow\Inject]
     protected $objectManager;
 
     /**
-     * @Flow\Inject
      * @var EntityManagerInterface
      */
+    #[Flow\Inject]
     protected $entityManager;
 
     /**
@@ -308,7 +308,7 @@ private function filterOutAssetsWithAssetCollections(QueryInterface $query): Que
         return $query;
     }
 
-    private function filterOutAssetsWithOtherMediaTypes(QueryInterface $query)
+    private function filterOutAssetsWithOtherMediaTypes(QueryInterface $query): QueryInterface
     {
         $constraints = $query->getConstraint();
         return $query->matching(

Classes/Domain/Model/Dto/AssetUsageDetails.php

@@ -24,6 +24,9 @@ final class AssetUsageDetails implements \JsonSerializable
 {
 
     private string $label;
+    /**
+     * @var array<string, string>
+     */
     private array $metadata;
     private string $url;
 
@@ -39,6 +42,9 @@ public function getLabel(): string
         return $this->label;
     }
 
+    /**
+     * @return array<string, string>
+     */
     public function getMetadata(): array
     {
         return $this->metadata;

Classes/Domain/Model/Dto/MutationResult.php

@@ -4,46 +4,44 @@
 
 namespace Flowpack\Media\Ui\Domain\Model\Dto;
 
+use Flowpack\Media\Ui\GraphQL\Types\MutationResponseMessages;
 use Neos\Flow\Annotations as Flow;
 
-/**
- * @Flow\Proxy(false)
- */
+#[Flow\Proxy(false)]
 class MutationResult implements \JsonSerializable
 {
 
-    private bool $success;
-    private ?array $messages;
-    private ?array $data;
+    public function __construct(
+        public readonly bool $success,
+        public readonly ?MutationResponseMessages $messages = null,
+    ) {
+    }
 
-    public function __construct(bool $success, array $messages = null, array $data = null)
+    public static function success(): self
     {
-        $this->success = $success;
-        $this->messages = $messages;
-        $this->data = $data;
+        return new self(true);
     }
 
-    public function isSuccess(): bool
+    public static function error(array $array): self
     {
-        return $this->success;
+        return new self(false, MutationResponseMessages::fromArray($array));
     }
 
-    public function getMessages(): ?array
+    public function isSuccess(): bool
     {
-        return $this->messages;
+        return $this->success;
     }
 
-    public function getData(): ?array
+    public function getMessages(): ?MutationResponseMessages
     {
-        return $this->data;
+        return $this->messages ?? MutationResponseMessages::empty();
     }
 
     public function toArray(): array
     {
         return [
             'success' => $this->success,
-            'messages' => $this->messages,
-            'data' => $this->data,
+            'messages' => $this->getMessages(),
         ];
     }
 

Classes/Domain/Model/HierarchicalAssetCollectionInterface.php

@@ -36,14 +36,14 @@ public function getTitle();
     public function getTags();
 
     /**
-     * @return AssetCollection|null
+     * @return HierarchicalAssetCollectionInterface|null
      */
     public function getParent();
 
     /**
      * @return void
      */
-    public function setParent(?AssetCollection $parent);
+    public function setParent(?HierarchicalAssetCollectionInterface $parent);
 
     /**
      * @return void