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

Skip to content

[Webhook] Pass original request to RequestParserInterface #58047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2024
Merged

[Webhook] Pass original request to RequestParserInterface #58047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Symfony/Component/Webhook/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ CHANGELOG
---

* Add `PayloadSerializerInterface` with implementations to decouple the remote event handling from the Serializer component
* Add optional `$request` argument to `RequestParserInterface::createSuccessfulResponse()` and `RequestParserInterface::createRejectedResponse()`

6.4
---
Expand Down
10 changes: 8 additions & 2 deletions src/Symfony/Component/Webhook/Client/AbstractRequestParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,18 @@ public function parse(Request $request, #[\SensitiveParameter] string $secret):
return $this->doParse($request, $secret);
}

public function createSuccessfulResponse(): Response
/**
* @param Request|null $request The original request that was received by the webhook controller
*/
public function createSuccessfulResponse(/* ?Request $request = null */): Response
{
return new Response('', 202);
}

public function createRejectedResponse(string $reason): Response
/**
* @param Request|null $request The original request that was received by the webhook controller
*/
public function createRejectedResponse(string $reason/* , ?Request $request = null */): Response
{
return new Response($reason, 406);
}
Expand Down
10 changes: 8 additions & 2 deletions src/Symfony/Component/Webhook/Client/RequestParserInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,13 @@ interface RequestParserInterface
*/
public function parse(Request $request, #[\SensitiveParameter] string $secret): ?RemoteEvent;

public function createSuccessfulResponse(): Response;
/**
* @param Request|null $request The original request that was received by the webhook controller
*/
public function createSuccessfulResponse(/* ?Request $request = null */): Response;

public function createRejectedResponse(string $reason): Response;
/**
* @param Request|null $request The original request that was received by the webhook controller
*/
public function createRejectedResponse(string $reason/* , ?Request $request = null */): Response;
}
4 changes: 2 additions & 2 deletions src/Symfony/Component/Webhook/Controller/WebhookController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ public function handle(string $type, Request $request): Response
$parser = $this->parsers[$type]['parser'];

if (!$event = $parser->parse($request, $this->parsers[$type]['secret'])) {
return $parser->createRejectedResponse('Unable to parse the webhook payload.');
return $parser->createRejectedResponse('Unable to parse the webhook payload.', $request);
}

$this->bus->dispatch(new ConsumeRemoteEventMessage($type, $event));

return $parser->createSuccessfulResponse();
return $parser->createSuccessfulResponse($request);
}
}
Loading