Add correct accept header to ajaxSubmit to prevent 406 error

[nieuwenhuisen]

Add correct accept header to ajaxSubmit to prevent 406 error

The modeltype save request gives a 406 (Not acceptable) error in my browser. This is causes because my browser sends an wildcard Accept header */* and the code checks on an exact match of application/json. To fix this I set the accept header before the ajax request.

I am targeting this branch, because the deprecation is introduce in 3.x and the error is given in the master branch.

Changelog

### Fixed
- Set the Accept header for ajaxSubmit in `Resources/views/CRUD/Association/edit_many_script.html.twig` to  "application/json" to prevent 406 (Not acceptable)  error.
- CRUDController::handleXmlHttpRequestErrorResponse also accepts the wildcard Accept header  "*/*".
- CRUDController::handleXmlHttpRequestSuccessResponse also accepts the wildcard Accept header  "*/*".

[SonataCI]

Could you please rebase your PR and fix merge conflicts?

[nieuwenhuisen]

The test are failing, I am working on that.

[nieuwenhuisen]

If I edit the deprecation error test, I am getting a syntax error. I have tried with escaping but without success (*//* and *\/*). Anyone an idea how to solve this?

This is error is caused because the use of a closing phpdoc tag. But this is not working:
New 1.2.0rc1: If you need to use the closing comment "/" in a DocBlock, use the special escape sequence "{@}."

[nieuwenhuisen]

I have changed the solution strategy for this probleem, to a simpler solution.

[jordisala1991]

If I edit the deprecation error test, I am getting a syntax error. I have tried with escaping but without success (*//* and *\/*). Anyone an idea how to solve this?

This is error is caused because the use of a closing phpdoc tag. But this is not working:
New 1.2.0rc1: If you need to use the closing comment "/" in a DocBlock, use the special escape sequence "{@}."

To fix that you could have used the builtin phpunit methods, instead of that syntax (which is deprecated AFAIK).

$this->expectDeprecation(..)

[nieuwenhuisen]

@jordisala1991 Yes I have tried that, but is not working correctly in all versions. See https://travis-ci.org/github/sonata-project/SonataAdminBundle/jobs/711372401

What do you think of the new solution with Javascript. In this solution there is no PHP changes needed.

[jordisala1991]

That could be a problem with phpunit-brdige 5.1.0 🤔

I like the new solution with only js changes, just wondering if someone in some case can still end up with that problem because of the restriction on php

[phansys]

The problem related to ExpectDeprecationTrait::expectDeprecation() was solved at symfony/symfony#37153, which is released since version 5.1.1.

[phansys]

I like the new solution with only js changes, just wondering if someone in some case can still end up with that problem because of the restriction on php

I think we should make both changes:

• Send the proper header in the request (Accept: application/json);
• Allow to deliver JSON responses to requests accepting anything (Accept: */*).

[greg0ire]

You said you were getting a 406, yet the code in the controller does not produce a 406 yet, it will only do so in next major. Please link to the piece of code you get a 406 from (use the profiler to find the controller that is involved, etc.)

[nieuwenhuisen]

Yes the 406 is produced in the master branch, I have switched the base branch. The 3.x branch only triggers a deprecation.
https://github.com/sonata-project/SonataAdminBundle/blob/master/src/Controller/CRUDController.php#L1443

[VincentLanglet]

.idea files should not commited.

@sonata-project/contributors Shouldn't we add this in .gitignore ?

[nieuwenhuisen]

Yeah I added the .idea folder by mistake :-( It's now untracked

[phansys]

.idea files should not commited.

@sonata-project/contributors Shouldn't we add this in .gitignore ?

I really don't like the idea (:trollface:) to track every possible IDE configuration path or other residual files which are related to the specific environment or the operating system.
For those cases, the users should be responsible to keep track of these paths, which are surely commonly present in every project they work, through a global .gitignore.

[franmomu]

Thanks @nieuwenhuisen !

[fancyweb]

Ref #5710 (comment)

This commit broke SonataPageBundle a little more. SonataPageBundle uses the CRUDController and does all edit with ajax requests with the */* Accept header. SonataPageBundle javascript only handle a HTML return, not a json one when there are errors.

[nieuwenhuisen]

See #6250