Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[HttpKernel] Introduce #[MapUploadedFile] controller argument attribute#49978

Merged
chalasr merged 1 commit into
symfony:7.1from
renedelima:map-uploaded-file
Apr 18, 2024
Merged

[HttpKernel] Introduce #[MapUploadedFile] controller argument attribute#49978
chalasr merged 1 commit into
symfony:7.1from
renedelima:map-uploaded-file

Conversation

@renedelima
Copy link
Copy Markdown
Contributor

@renedelima renedelima commented Apr 8, 2023 •
edited
Loading

Q A
Branch? 7.1
Bug fix? no
New feature? yes
Deprecations? no
Tickets #52678, #49138
License MIT
Doc PR -

Usage Example

# src/Controller/UserPictureController.php

namespace App\Controller;

use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\HttpKernel\Attribute\MapUploadedFile;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Validator\Constraints as Assert;

#[AsController]
final class UserPictureController
{
    #[Route('/user/picture', methods: ['PUT'])]
    public function __invoke(
        #[MapUploadedFile(
            new Assert\File(mimeTypes: ['image/png', 'image/jpeg']),
        )] ?UploadedFile $picture,
    ): Response {
        return new Response('Your picture was updated');
    }
}
# src/Controller/UserDocumentsController.php

namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\HttpKernel\Attribute\MapUploadedFile;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Validator\Constraints as Assert;

final class UserDocumentsController
{
    #[Route('/user/documents', methods: ['PUT'])]
    public function __invoke(
        #[MapUploadedFile(
            new Assert\File(mimeTypes: ['application/pdf'])
        )] array $documents
    ): Response {
        return new Response('Thanks for sharing your documents');
    }
}
# src/Controller/UserDocumentsController.php

namespace App\Controller;

use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\HttpKernel\Attribute\MapUploadedFile;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Validator\Constraints as Assert;

final class UserDocumentsController
{
    #[Route('/user/documents', methods: ['PUT'])]
    public function __invoke(
        #[MapUploadedFile(
            new Assert\File(mimeTypes: ['application/pdf'])
        )] UploadedFile ...$documents
    ): Response {
        return new Response('Thanks for sharing your documents');
    }
}

@renedelima renedelima requested a review from dunglas as a code owner April 8, 2023 12:12
@carsonbot carsonbot added this to the 6.3 milestone Apr 8, 2023
@carsonbot
Copy link
Copy Markdown

carsonbot commented Apr 8, 2023

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@renedelima renedelima force-pushed the map-uploaded-file branch 3 times, most recently from 66e8f09 to f366d35 Compare April 8, 2023 19:08
@Koc
Copy link
Copy Markdown
Contributor

Koc commented Apr 11, 2023 •
edited
Loading

Wow, I like idea of reusing infrastructure provided by RequestPayloadValueResolver 👏

Can you add support of the variadic arguments? + squash your commits for easier review until my PR hasn't merged.

@renedelima renedelima force-pushed the map-uploaded-file branch 2 times, most recently from b6fa35a to cb5a76f Compare April 12, 2023 16:49
@Koc Koc mentioned this pull request Apr 12, 2023
Closed
1 task
@renedelima
Copy link
Copy Markdown
Contributor Author

renedelima commented Apr 12, 2023

Can you add support of the variadic arguments? + squash your commits for easier review until my PR hasn't merged.

I Just added support to variadic arguments and the commits were squashed. @Koc

A missing file is like a missing form field in the payload. The code should be 422 too.

Status code changed to 422. @GromNaN

@Koc
Copy link
Copy Markdown
Contributor

Koc commented Apr 14, 2023

@renedelima you can rebase now 🎉

@renedelima renedelima force-pushed the map-uploaded-file branch 8 times, most recently from 75aad23 to 9eb9b53 Compare April 18, 2023 16:15
@renedelima
Copy link
Copy Markdown
Contributor Author

renedelima commented Apr 18, 2023

@renedelima you can rebase now 🎉

Rebased. For now, it seems there are no more suggestions to consider. Let's see what people have to say.

renanbr
renanbr reviewed Apr 19, 2023
View reviewed changes
Copy link
Copy Markdown

@renanbr renanbr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could also be great to have unit tests in RequestPayloadValueResolverTest.

@renedelima renedelima force-pushed the map-uploaded-file branch 2 times, most recently from 6312aee to 0a29c3a Compare April 20, 2023 17:32
@renedelima
Copy link
Copy Markdown
Contributor Author

renedelima commented Mar 19, 2024

LGTM. In case this triggers new ideas, I wondered why the attribute is needed when UploadedFile might be enough to do the mapping? Constraints is the answer I suppose.

Exactly, this way we are able to use constraints when mapping uploaded files.

I also wondered if we shouldn't add the All constraint automatically when the type is array. WDYT?

Good suggestion, the All constraint is now automatically added when the argument type is array.

@renedelima renedelima force-pushed the map-uploaded-file branch 2 times, most recently from 7c69c33 to c0c4a95 Compare March 21, 2024 20:55
@renedelima
Copy link
Copy Markdown
Contributor Author

renedelima commented Mar 21, 2024

LGTM. In case this triggers new ideas, I wondered why the attribute is needed when UploadedFile might be enough to do the mapping? Constraints is the answer I suppose. I also wondered if we shouldn't add the All constraint automatically when the type is array. WDYT?

Changes applied, branch rebased and all checks have passed.

nicolas-grekas
nicolas-grekas reviewed Mar 24, 2024
View reviewed changes
Comment thread src/Symfony/Component/HttpKernel/Attribute/MapUploadedFile.php Outdated
@renedelima renedelima force-pushed the map-uploaded-file branch 2 times, most recently from b3a06fb to 9701c13 Compare March 24, 2024 18:45
@renedelima renedelima force-pushed the map-uploaded-file branch 4 times, most recently from 9e64462 to dc068fb Compare April 6, 2024 23:27
@nicolas-grekas
Copy link
Copy Markdown
Member

nicolas-grekas commented Apr 12, 2024

Anyone @symfony/mergers?
(small rebase needed BTW)

yceruto
yceruto approved these changes Apr 12, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@yceruto yceruto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@OskarStark
Copy link
Copy Markdown
Contributor

OskarStark commented Apr 12, 2024

It looks like your commiter email is not associated with your GitHub account, maybe you want to change that?

@chalasr
Copy link
Copy Markdown
Member

chalasr commented Apr 18, 2024

1 year later. Thanks for your work and your endurance @renedelima!

@chalasr chalasr mentioned this pull request Apr 18, 2024
Closed
@DjordyKoert DjordyKoert mentioned this pull request May 2, 2024
Merged
@fabpot fabpot mentioned this pull request May 2, 2024
Merged
@DjordyKoert DjordyKoert mentioned this pull request May 13, 2024
Closed
@melya melya mentioned this pull request Jul 25, 2024
Closed
@nicolas-grekas nicolas-grekas mentioned this pull request Feb 12, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@OskarStark OskarStark OskarStark left review comments

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

@GromNaN GromNaN GromNaN approved these changes

@yceruto yceruto yceruto approved these changes

@chalasr chalasr chalasr approved these changes

@dunglas dunglas Awaiting requested review from dunglas

+1 more reviewer

@renanbr renanbr renanbr left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Feature HttpKernel Status: Reviewed

Projects

None yet

Milestone

7.1

Development

Successfully merging this pull request may close these issues.

9 participants

@renedelima @carsonbot @Koc @nicolas-grekas @OskarStark @chalasr @renanbr @GromNaN @yceruto