Merge pull request #4918 from soyuka/merge-27

Merge 2.7 and update changelog

Author: soyuka

.commitlintrc

@@ -0,0 +1,97 @@
+{
+  "defaultIgnores": true,
+  "parserPreset": "conventional-changelog-conventionalcommits",
+  "rules": {
+    "scope-enum": [
+      2,
+      "always",
+      [
+        "symfony",
+        "doctrine",
+        "metadata",
+        "elasticsearch",
+        "mongodb",
+        "jsonld",
+        "hydra",
+        "jsonapi",
+        "graphql",
+        "openapi",
+        "serializer",
+        "jsonschema",
+        "validation"
+      ]
+    ],
+    "scope-empty": [
+      2,
+      "never"
+    ],
+    "body-leading-blank": [
+      1,
+      "always"
+    ],
+    "body-max-line-length": [
+      2,
+      "always",
+      100
+    ],
+    "footer-leading-blank": [
+      1,
+      "always"
+    ],
+    "footer-max-line-length": [
+      2,
+      "always",
+      100
+    ],
+    "header-max-length": [
+      2,
+      "always",
+      100
+    ],
+    "subject-case": [
+      2,
+      "never",
+      [
+        "sentence-case",
+        "start-case",
+        "pascal-case",
+        "upper-case"
+      ]
+    ],
+    "subject-empty": [
+      2,
+      "never"
+    ],
+    "subject-full-stop": [
+      2,
+      "never",
+      "."
+    ],
+    "type-case": [
+      2,
+      "always",
+      "lower-case"
+    ],
+    "type-empty": [
+      2,
+      "never"
+    ],
+    "type-enum": [
+      2,
+      "always",
+      [
+        "build",
+        "chore",
+        "ci",
+        "docs",
+        "feat",
+        "fix",
+        "perf",
+        "refactor",
+        "revert",
+        "style",
+        "test"
+      ]
+    ]
+  }
+}

.github/workflows/ci.yml

@@ -10,6 +10,14 @@ env:
   SYMFONY_DEPRECATIONS_HELPER: max[self]=0
 
 jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          configFile: .commitlintrc
+      - uses: wagoid/commitlint-github-action@v5
   php-cs-fixer:
     name: PHP-cs-fixer (PHP ${{ matrix.php }})
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -1,11 +1,39 @@
 # Changelog
 =======
 
-## 3.0.0-rc.3
+## 3.0.0
 
-* Symfony: removed the `$exceptionOnNoToken` parameter in `ResourceAccessChecker::__construct()` (#4900)
+* Symfony: 6.1 compatibility and remove 4.4 and 5.4 support (#4851)
+* Symfony: removed the $exceptionOnNoToken parameter in `ResourceAccessChecker::__construct()` (#4905)
+* Symfony: use conventional service names for Doctrine state providers and processors (#4859)
+* Symfony: adjust mapping paths to the SF best practices for Bundles **BC** `Resources/config/api_resources` to `config/api_resources`  (#4853)
+* Symfony: `src/ApiResource/` is the recommended place for API models (#4874)
+* Cache: remove guzzle from the Varnish purger (#4872)
 
-## 3.0.0-beta.2
+Various cleanup in services and removal of backward compatibility layer.
+
+## 2.7.0
+
+* Metadata: do not set id when identifier is `false` (#4880)
+* Metadata: automatic GET operation when none is declared (#4881)
+* Metadata: exception to status on operations (#4861)
+* Serializer: adds the JSON_INVALID_UTF8_IGNORE flag to JsonEncode (#4741)
+* Symfony: autoconfigure legacy Doctrine extensions (#4909)
+* Elasticsearch: skip metadata without ES nodes (#4913)
+* Symfony: deprecate the $exceptionOnNoToken parameter in ResourceAccessChecker::__construct() (#4900)
+* Symfony: deprecated the `$exceptionOnNoToken` parameter in `ResourceAccessChecker::__construct()` (#4900)
+
+Various cs fixes and PHPDoc to help upgrading to 3.0.
+
+## 3.0.0-rc.2 
+
+* JsonLd: correct the `api_jsonld_context` route format (#4844)
+* Metadata: remove metadata_backward_compatibility_layer option (#4843)
+* OpenApi: fixed required fields (in and name) within `ApiPlatform\OpenApi\Model\Parameter` **BC**
+
+Various cleanup, removed `Core` namespace leftovers and todos.
+
+## 3.0.0-beta.2 / 3.0.0-rc.1
 
 * ExpressionLanguage: deprecated class `ApiPlatform\Symfony\Security\ExpressionLanguage` has been removed in favor of `Symfony\Component\Security\Core\Authorization\ExpressionLanguage`.
 
@@ -21,6 +49,11 @@ Breaking changes:
 * Metadata: the `Core` namespace got removed (#4805)
 * Mercure: deprecation removed (#4805)
 
+## 2.7.0-rc.2 
+
+* Symfony: the upgrade command now updates ApiFilter as well (#4845)
+* Symfony: maker command to create a state Processor (#4423)
+
 ## 2.7.0-beta.5
 
 * Serializer: ignore no-operation on SerializeListener (#4828)

src/Elasticsearch/Metadata/Resource/Factory/ElasticsearchProviderResourceMetadataCollectionFactory.php

@@ -21,6 +21,7 @@
 use ApiPlatform\Util\Inflector;
 use Elasticsearch\Client;
 use Elasticsearch\Common\Exceptions\Missing404Exception;
+use Elasticsearch\Common\Exceptions\NoNodesAvailableException;
 
 final class ElasticsearchProviderResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
 {
@@ -88,6 +89,8 @@ private function hasIndices(string $shortName): bool
             return true;
         } catch (Missing404Exception) {
             return false;
+        } catch (NoNodesAvailableException) {
+            return false;
         }
     }
 }

src/GraphQl/Resolver/Stage/SerializeStage.php

@@ -17,7 +17,9 @@
 use ApiPlatform\GraphQl\Serializer\ItemNormalizer;
 use ApiPlatform\GraphQl\Serializer\SerializerContextBuilderInterface;
 use ApiPlatform\Metadata\CollectionOperationInterface;
+use ApiPlatform\Metadata\GraphQl\Mutation;
 use ApiPlatform\Metadata\GraphQl\Operation;
+use ApiPlatform\Metadata\GraphQl\Subscription;
 use ApiPlatform\State\Pagination\Pagination;
 use ApiPlatform\State\Pagination\PaginatorInterface;
 use ApiPlatform\State\Pagination\PartialPaginatorInterface;
@@ -38,9 +40,9 @@ public function __construct(private readonly NormalizerInterface $normalizer, pr
 
     public function __invoke(iterable|object|null $itemOrCollection, string $resourceClass, Operation $operation, array $context): ?array
     {
-        $isCollection = $context['is_collection'] || $operation instanceof CollectionOperationInterface;
-        $isMutation = $context['is_mutation'];
-        $isSubscription = $context['is_subscription'];
+        $isCollection = $operation instanceof CollectionOperationInterface;
+        $isMutation = $operation instanceof Mutation;
+        $isSubscription = $operation instanceof Subscription;
         $shortName = $operation->getShortName();
         $operationName = $operation->getName();
 

src/JsonApi/Serializer/ItemNormalizer.php

@@ -445,6 +445,7 @@ private function getIncludedNestedResources(string $relationshipName, array $con
         return array_map(static fn (string $nested): string => substr($nested, strpos($nested, '.') + 1), $filtered);
     }
 
+    // TODO: this code is similar to the one used in JsonLd
     private function getResourceShortName(string $resourceClass): string
     {
         if ($this->resourceClassResolver->isResourceClass($resourceClass)) {

tests/GraphQl/Resolver/Stage/SerializeStageTest.php

@@ -55,25 +55,25 @@ protected function setUp(): void
     /**
      * @dataProvider applyDisabledProvider
      */
-    public function testApplyDisabled(array $context, bool $paginationEnabled, ?array $expectedResult): void
+    public function testApplyDisabled(Operation $operation, bool $paginationEnabled, ?array $expectedResult): void
     {
         $resourceClass = 'myResource';
         /** @var Operation $operation */
-        $operation = (new Query())->withSerialize(false);
+        $operation = $operation->withSerialize(false);
 
-        $result = ($this->createSerializeStage($paginationEnabled))(null, $resourceClass, $operation, $context);
+        $result = ($this->createSerializeStage($paginationEnabled))(null, $resourceClass, $operation, []);
 
         $this->assertSame($expectedResult, $result);
     }
 
     public function applyDisabledProvider(): array
     {
         return [
-            'item' => [['is_collection' => false, 'is_mutation' => false, 'is_subscription' => false], false, null],
-            'collection with pagination' => [['is_collection' => true, 'is_mutation' => false, 'is_subscription' => false], true, ['totalCount' => 0., 'edges' => [], 'pageInfo' => ['startCursor' => null, 'endCursor' => null, 'hasNextPage' => false, 'hasPreviousPage' => false]]],
-            'collection without pagination' => [['is_collection' => true, 'is_mutation' => false, 'is_subscription' => false], false, []],
-            'mutation' => [['is_collection' => false, 'is_mutation' => true, 'is_subscription' => false], false, ['clientMutationId' => null]],
-            'subscription' => [['is_collection' => false, 'is_mutation' => false, 'is_subscription' => true], false, ['clientSubscriptionId' => null]],
+            'item' => [new Query(), false, null],
+            'collection with pagination' => [new QueryCollection(), true, ['totalCount' => 0., 'edges' => [], 'pageInfo' => ['startCursor' => null, 'endCursor' => null, 'hasNextPage' => false, 'hasPreviousPage' => false]]],
+            'collection without pagination' => [new QueryCollection(), false, []],
+            'mutation' => [new Mutation(), false, ['clientMutationId' => null]],
+            'subscription' => [new Subscription(), false, ['clientSubscriptionId' => null]],
         ];
     }