Test and fix API Platform with Symfony 4.4 #3009

dunglas · 2019-08-21T16:18:26Z

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	no
Fixed tickets	n/a
License	MIT
Doc PR	n/a

~~Get rid of fig/link-util, use WebLink directly instead if available~~

fabpot · 2019-10-23T10:28:25Z

I think we will need this one as soon as possible :)

soyuka · 2019-10-23T14:35:15Z

Bump'd, :

Deprecations left to fix

Remaining self deprecation notices (10)
10x: The "twig.exception_listener" service is deprecated since Symfony 4.4.

1x in ApiTestCaseTest::testAssertJsonContains from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertJsonContainsWithJsonObjectString from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertJsonContainsWithJsonScalarString from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertJsonEquals from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertJsonEqualsWithJsonObjectString from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertJsonEqualsWithJsonScalarString from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertMatchesJsonSchema from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertMatchesResourceCollectionJsonSchema from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertMatchesResourceItemJsonSchema from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testFindIriBy from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test
Remaining direct deprecation notices (1)
1x: The "Doctrine\Bundle\DoctrineBundle\Registry" class implements "Symfony\Bridge\Doctrine\RegistryInterface" that is deprecated since Symfony 4.4, use Doctrine\Common\Persistence\ManagerRegistry instead.

1x in ApiTestCaseTest::testAssertJsonContains from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test
Remaining indirect deprecation notices (4)
4x: Loading the file "config/routing_test.yml" from the global resource directory "/home/soyuka/forks/coreb/tests/Fixtures/app" is deprecated since Symfony 4.4 and will be removed in 5.0.

1x in ApiTestCaseTest::testAssertJsonContains from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertJsonContainsWithJsonObjectString from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertJsonContainsWithJsonScalarString from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

1x in ApiTestCaseTest::testAssertMatchesJsonSchema from ApiPlatform\Core\Tests\Bridge\Symfony\Bundle\Test

src/Action/ExceptionAction.php

teohhanhui · 2019-10-23T15:04:08Z

We should target 2.5 instead, just like how we provided Symfony 4.3 compatibility in API Platform 2.4

composer.json

src/Bridge/Symfony/Bundle/Resources/config/api.xml

src/EventListener/SerializeListener.php

…:isMethodSafe() (dunglas) This PR was squashed before being merged into the 4.3 branch. Discussion ---------- [HttpFoundation] Allow to not pass a parameter to Request::isMethodSafe() | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | n/a | License | MIT | Doc PR | n/a This parameter was already deprecated in Symfony 4. Allowing to not pass it in Symfony 4.3 without triggering a deprecation allows to support both HttpFoundation 4.3 and 4.4, otherwise it's not possible. Needed to make API Platform compatible with Symfony 5 (api-platform/core#3009) Commits ------- e819256 [HttpFoundation] Allow to not pass a parameter to Request::isMethodSafe()

This PR was merged into the 4.4 branch. Discussion ---------- Re-allow to use "tagged" in service definitions | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | n/a | License | MIT | Doc PR | n/a Re-allow to use `tagged` in 4.4 and 5.0. It makes it easier for bundles to support both Symfony 4.3- and Symfony 4.4+. Needed to make API Platform compatible with Symfony 5 (api-platform/core#3009) Commits ------- 7b7dc0d Re-allow to use "tagged" in service definitions

teohhanhui · 2019-10-29T14:59:58Z

Is it not possible to target 2.5 instead? (And perhaps a separate PR to bump the dependencies in master to reduce maintenance burden?) I think it'd be very valuable for 2.5 to be compatible with Symfony 4.4 (if not 5.0).

dunglas · 2019-10-29T15:40:26Z

It already targets 2.5. I just forgot to update this in the GitHub UI.

src/Bridge/Doctrine/EventListener/WriteListener.php

tests/Bridge/Symfony/Bundle/Twig/ApiPlatformProfilerPanelTest.php

teohhanhui · 2019-10-30T16:11:12Z

tests/Fixtures/app/AppKernel.php

@@ -84,7 +84,7 @@ public function getProjectDir()

    protected function configureRoutes(RouteCollectionBuilder $routes)
    {
-        $routes->import("config/routing_{$this->getEnvironment()}.yml");
+        $routes->import(__DIR__."/config/routing_{$this->getEnvironment()}.yml");


What is the reason for this change?

A deprecation.

I can't find it in https://github.com/symfony/symfony/blob/4.4/UPGRADE-4.4.md and https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/Routing/RouteCollectionBuilder.php

Do you know which one it is?

I don't know, but it's related to resources, not to the routing directly.

But it's so weird that we have to use an absolute path... :x

phpstan.neon.dist

src/Validator/EventListener/ValidateListener.php

fabpot · 2019-11-01T17:26:06Z

There is one missing change to ensure compatibilty with Symfony 5: changing the even class names.

To ensure forward compatibility with Symfony 5.0

teohhanhui · 2019-11-01T22:11:49Z

Done and rebased.

…enormalization

dunglas · 2019-11-02T11:01:58Z

The last remaining failure with 4.4/5.0 is due to this Symfony issue: symfony/symfony#34220

In the meantime, we can allow failures for SF 4.4 or wait for this bug to be resolved.

teohhanhui · 2019-11-02T11:35:12Z

We should not merge this if there are still failing tests, IMO.

teohhanhui · 2019-11-02T13:47:36Z

So, we still have the last two failures related to CSV: https://github.com/api-platform/core/runs/285907674#step:14:67

dunglas · 2019-11-03T18:33:27Z

I'm not able to reproduce the failures related to CSV locally anymore :| I restarted the test suite to see...

teohhanhui · 2019-11-04T08:36:08Z

Thanks @dunglas! 🎉 🚀

teohhanhui · 2019-11-05T13:56:18Z

src/Serializer/SerializerContextBuilder.php

+            }
+
+            if ('csv' === $request->getContentType()) {
+                $context[CsvEncoder::AS_COLLECTION_KEY] = false;


Is this really the right thing to do? Using CSV for a single item (as in the previously failing test) is actually very weird and makes little sense. See symfony/symfony#25218 (comment)

I don't see the problem, (a resource is a resource from REST point of view, and you can update it using any supported format, what would be weird is to be able to update some resources using a given format, but not some others). Anyway, we need this for BC.

The problem is that the CSV format does not lend itself to describing a single resource (as explained in the linked comment). Perhaps what we should do is to still set as_collection to true, but take the first item? WDYT?

Late to the party but @teohhanhui is correct, CSV is a collection of data items by definition. Forcing any posted CSV data to be processed as single data item leads to errors. (In our case triggered by a CSV import after a CSV export in API tests.)

So IMO this should be dropped or at least made configurable. For now we add a custom serializer context builder to unset this override.

Notice that this workaround broke due to #6186 adding an array shape for ApiPlatform\State\SerializerContextBuilderInterface::createFromRequest(). Here CsvEncoder::AS_COLLECTION_KEY (as_collection) is not present which causes PHPStan to reject unsetting this key from the context. We worked around this by hinting the context to a plain array instead:

public function createFromRequest(Request $request, bool $normalization, ?array $extractedAttributes = null): array { /** @var array */ $context = $this->decorated->createFromRequest($request, $normalization, $extractedAttributes); unset($context[CsvEncoder::AS_COLLECTION_KEY]); return $context; }

can you open a new issue please?

Will do, but producing a minimal testcase for this will take a while.

mhh but it's just a matter of phpstan type missing an &array<string, mixed>? maybe a pr is enough

Oh you mean the array shape. I thought it was about the $context[CsvEncoder::AS_COLLECTION_KEY] = false; itself which is wrong from my POV.

soyuka force-pushed the test4.4 branch 3 times, most recently from e0d6bc8 to 24a7681 Compare October 23, 2019 14:33

teohhanhui reviewed Oct 23, 2019

View reviewed changes

src/Action/ExceptionAction.php Show resolved Hide resolved

teohhanhui reviewed Oct 23, 2019

View reviewed changes

composer.json Outdated Show resolved Hide resolved

teohhanhui reviewed Oct 23, 2019

View reviewed changes

src/Bridge/Symfony/Bundle/Resources/config/api.xml Outdated Show resolved Hide resolved

teohhanhui reviewed Oct 23, 2019

View reviewed changes

src/EventListener/SerializeListener.php Outdated Show resolved Hide resolved

dunglas mentioned this pull request Oct 29, 2019

[HttpFoundation] Allow to not pass a parameter to Request::isMethodSafe() symfony/symfony#34167

Merged

dunglas mentioned this pull request Oct 29, 2019

Re-allow to use "tagged" in service definitions symfony/symfony#34170

Merged

dunglas force-pushed the test4.4 branch from 24a7681 to 67326d2 Compare October 29, 2019 14:44

dunglas changed the base branch from master to 2.5 October 29, 2019 15:40

teohhanhui reviewed Oct 29, 2019

View reviewed changes

src/Bridge/Doctrine/EventListener/WriteListener.php Show resolved Hide resolved

teohhanhui force-pushed the test4.4 branch 4 times, most recently from 624312d to 885b6c7 Compare October 30, 2019 16:05

teohhanhui reviewed Oct 30, 2019

View reviewed changes

tests/Bridge/Symfony/Bundle/Twig/ApiPlatformProfilerPanelTest.php Show resolved Hide resolved

teohhanhui reviewed Oct 30, 2019

View reviewed changes

teohhanhui force-pushed the test4.4 branch 3 times, most recently from b008128 to 18b8841 Compare October 30, 2019 21:25

dunglas force-pushed the test4.4 branch from 18b8841 to cdc3c0b Compare October 30, 2019 23:00

teohhanhui force-pushed the test4.4 branch from cdc3c0b to e86a174 Compare October 31, 2019 10:43

teohhanhui force-pushed the test4.4 branch from 9552635 to c490b0f Compare October 31, 2019 13:32

teohhanhui reviewed Oct 31, 2019

View reviewed changes

phpstan.neon.dist Outdated Show resolved Hide resolved

soyuka reviewed Nov 1, 2019

View reviewed changes

src/Validator/EventListener/ValidateListener.php Show resolved Hide resolved

dunglas and others added 6 commits November 1, 2019 23:07

Test and fix API Platform with Symfony 4.4

aa01bd0

Fix more deprecations

c74f316

Add CI jobs for testing next release of Symfony

7a72246

Fix TwigBundle config

f5b0da6

Require HttpFoundation 4.3.6

6f6e23c

Use renamed HttpKernel event classes

56db34a

To ensure forward compatibility with Symfony 5.0

teohhanhui force-pushed the test4.4 branch from 82d37e6 to 56db34a Compare November 1, 2019 22:11

teohhanhui and others added 2 commits November 1, 2019 23:38

Fix TypeError due to invalid call to DenormalizerInterface::supportsD…

f344225

…enormalization

Fix tests by preventing to install Mink dev

e6d2227

Fix tests by making the firewall stateless

87727b5

teohhanhui mentioned this pull request Nov 2, 2019

Symfony 4.4 deprecation / Symfony 5.0 compatibility doctrine/DoctrineMongoDBBundle#596

Closed

Fix tests

eb95b21

dunglas mentioned this pull request Nov 3, 2019

Fix branch-alias (master is now 3.0) doctrine/dbal#3713

Merged

dunglas added 3 commits November 3, 2019 22:54

Temporarily exclude Doctrine master

8b3f282

Fix CSV issue

beefbb0

Fix CS

0b8776f

dunglas merged commit b47ccea into api-platform:2.5 Nov 4, 2019

dunglas deleted the test4.4 branch November 4, 2019 03:58

teohhanhui reviewed Nov 5, 2019

View reviewed changes

teohhanhui mentioned this pull request Nov 6, 2019

[WIP] Update symfony 5 #3240

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Test and fix API Platform with Symfony 4.4 #3009

Test and fix API Platform with Symfony 4.4 #3009

dunglas commented Aug 21, 2019 •

edited by teohhanhui

Loading

fabpot commented Oct 23, 2019

soyuka commented Oct 23, 2019 •

edited

Loading

teohhanhui commented Oct 23, 2019

teohhanhui commented Oct 29, 2019 •

edited

Loading

dunglas commented Oct 29, 2019

teohhanhui Oct 30, 2019

dunglas Oct 31, 2019

teohhanhui Oct 31, 2019

dunglas Oct 31, 2019

teohhanhui Oct 31, 2019

fabpot commented Nov 1, 2019

teohhanhui commented Nov 1, 2019

dunglas commented Nov 2, 2019

teohhanhui commented Nov 2, 2019

teohhanhui commented Nov 2, 2019

dunglas commented Nov 3, 2019

teohhanhui commented Nov 4, 2019

teohhanhui Nov 5, 2019

dunglas Nov 5, 2019

teohhanhui Nov 5, 2019 •

edited

Loading

mbrodala Apr 8, 2022 •

edited

Loading

mbrodala Jul 2, 2024

soyuka Jul 3, 2024

mbrodala Jul 3, 2024

soyuka Jul 4, 2024

mbrodala Jul 4, 2024

Test and fix API Platform with Symfony 4.4 #3009

Test and fix API Platform with Symfony 4.4 #3009

Conversation

dunglas commented Aug 21, 2019 • edited by teohhanhui Loading

fabpot commented Oct 23, 2019

soyuka commented Oct 23, 2019 • edited Loading

teohhanhui commented Oct 23, 2019

teohhanhui commented Oct 29, 2019 • edited Loading

dunglas commented Oct 29, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabpot commented Nov 1, 2019

teohhanhui commented Nov 1, 2019

dunglas commented Nov 2, 2019

teohhanhui commented Nov 2, 2019

teohhanhui commented Nov 2, 2019

dunglas commented Nov 3, 2019

teohhanhui commented Nov 4, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

teohhanhui Nov 5, 2019 • edited Loading

Choose a reason for hiding this comment

mbrodala Apr 8, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Aug 21, 2019 •

edited by teohhanhui

Loading

soyuka commented Oct 23, 2019 •

edited

Loading

teohhanhui commented Oct 29, 2019 •

edited

Loading

teohhanhui Nov 5, 2019 •

edited

Loading

mbrodala Apr 8, 2022 •

edited

Loading