Add webhook definitions in EventRequestParser #556
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Yang-33
commented
Dec 22, 2023
Comment on lines
1681
to
1682
| $this->assertInstanceOf(\LINE\Webhook\Model\AttachedModuleContent::class, $module); | ||
| $this->assertInstanceOf(\LINE\Webhook\Model\AttachedModuleContent::class, $module, "Expected 'LINE\Webhook\Model\AttachedModuleContent', got '$actualClassName'"); |
There was a problem hiding this comment.
This fails even though debug(error) log in parseModuleContent showed its class is AttachedModuleContent. How should I do ...?
There was a problem hiding this comment.
It's resolved by 228f044. Thank you @moririnson san!!!!
moririnson
reviewed
Dec 22, 2023
| @@ -231,7 +254,7 @@ private static function parseThingsContent($eventData): ThingsContent | |||
| { | |||
| $thingsContentType = $eventData['things']['type']; | |||
| if (!isset(self::$thingsContentType2class[$thingsContentType])) { | |||
| return new ThingsContent($eventData['source']); | |||
| return new ThingsContent($eventData['things']); | |||
moririnson
approved these changes
Dec 22, 2023
Merged
eucyt
added a commit
that referenced
this pull request
Mar 26, 2025
Resolve #673 ## Summary When a new webhook type is added, we had to update manually (#664, #556). I've created a function to parse the class that uses polymorphism and fixed it. it prevents human errors in release new Webhook. ## Breaking changes This PR has some breaking changes to parse Webhook events automatically ### joined.members and left.members will be serialized into the UserSource classes. The joined.members and left.members were associative arrays, but now they are correctly serialized into the UserSource class. ```diff ... ["members"]=> array(1) { [0]=> - array(2) { - ["type"]=> - string(4) "user" - ["userId"]=> - string(14) "U4af4980629..." - } + object(LINE\Webhook\Model\UserSource)#256 (2) { + ["openAPINullablesSetToNull":protected]=> + array(0) { + } + ["container":protected]=> + array(2) { + ["type"]=> + string(4) "user" + ["userId"]=> + string(14) "U4af4980629..." + } + } ... ``` Until now, the elements of members were mistakenly treated as associative arrays, so we couldn't utilize the methods of UserSource. With this implementation, the following can now be achieved. ```diff $parsedEvents = EventRequestParser::parseEventRequest($req->getBody(), $secret, $req->getHeader(HTTPHeader::LINE_SIGNATURE)[0]); foreach ($parsedEvents->getEvents() as $event) { $joinedMembers = $event->getJoined()->getMembers(); $joinedMemberIds = array_map(function ($member) { - return $member["userId"]; + return $member->getUserId(); }, $joinedMembers); } ``` ### Default values will be unified to `NULL`. The default values of array fields were not consistently set to empty arrays (such as `message.emojis`) or `NULL` (such as `message. keywords`). Fields with keys that do not exist in the sent webhook event will have default values unified to `NULL`. For example, if the webhook does not contain emojis in a text message event, the emoji in ParsedEvent will change from an empty array to `NULL`. ```diff ... ["message"]=> object(LINE\Webhook\Model\TextMessageContent)#166 (2) { ["openAPINullablesSetToNull":protected]=> array(0) { } ["container":protected]=> array(7) { ["type"]=> string(4) "text" ["id"]=> string(9) "contentid" ["text"]=> string(21) "message without emoji" ["emojis"]=> - array(0) { - } + NULL ["mention"]=> NULL ["quoteToken"]=> NULL ["quotedMessageId"]=> NULL } } ... ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change allows SDK user to use 6 webhook events defined in https://github.com/line/line-openapi/blob/988429c5737e464bb891b949a874d5f389476681/webhook.yml#L111-L116 by modifying
EventRequestParser.