Support for dynamic initialization of nested classes by mokuzon · Pull Request #461 · line/line-bot-sdk-ruby

mokuzon · 2025-04-04T02:23:27Z

When classes are nested, child classes were not initialized.
This caused the following problems

Need to write webhook parser by hand with detailed conditionals V2: Automatically create a webhook parser #404
Responses could not be parsed correctly Accessing a nested structure results in a NoMethodError #440

This PR resolves those problems.
This also adds support for MembershipEvent, which was not supported by the webhook parser. 61c4a5a

mokuzon · 2025-04-04T02:25:16Z

+          def self.create(args)
+            klass = detect_class(args[:type])
+            return klass.new(**args) if klass
+
+            return new(**args)
+          end
+
+          private
+
+          def self.detect_class(type)
+            {
+              accountLink: Line::Bot::V2::Webhook::AccountLinkEvent,
+              activated: Line::Bot::V2::Webhook::ActivatedEvent,
+              beacon: Line::Bot::V2::Webhook::BeaconEvent,
+              botResumed: Line::Bot::V2::Webhook::BotResumedEvent,
+              botSuspended: Line::Bot::V2::Webhook::BotSuspendedEvent,
+              deactivated: Line::Bot::V2::Webhook::DeactivatedEvent,
+              follow: Line::Bot::V2::Webhook::FollowEvent,
+              join: Line::Bot::V2::Webhook::JoinEvent,
+              leave: Line::Bot::V2::Webhook::LeaveEvent,
+              memberJoined: Line::Bot::V2::Webhook::MemberJoinedEvent,
+              memberLeft: Line::Bot::V2::Webhook::MemberLeftEvent,
+              membership: Line::Bot::V2::Webhook::MembershipEvent,
+              message: Line::Bot::V2::Webhook::MessageEvent,
+              module: Line::Bot::V2::Webhook::ModuleEvent,
+              delivery: Line::Bot::V2::Webhook::PnpDeliveryCompletionEvent,
+              postback: Line::Bot::V2::Webhook::PostbackEvent,
+              things: Line::Bot::V2::Webhook::ThingsEvent,
+              unfollow: Line::Bot::V2::Webhook::UnfollowEvent,
+              unsend: Line::Bot::V2::Webhook::UnsendEvent,
+              videoPlayComplete: Line::Bot::V2::Webhook::VideoPlayCompleteEvent,
+            }[type.to_sym]
+          end


This is an important change sample in the generated code.

✅ Keys are correct 👍 : https://github.com/line/line-openapi/blob/4e10c73df579b4c1821a305f0190dfbe8710d2de/webhook.yml#L95-L117

mokuzon · 2025-04-04T02:44:36Z

-            @audience_groups = audience_groups
+            @audience_groups = audience_groups&.map do |item|
+              if item.is_a?(Hash)
+                Line::Bot::V2::ManageAudience::AudienceGroup.create(**item)
+              else
+                item
+              end
+            end


Here is another important sample of generated code differences.

Yang-33

Thanks!

Yang-33 · 2025-04-04T02:44:03Z

+          def self.detect_class(type)
+            {
+              camera: Line::Bot::V2::MessagingApi::CameraAction,
+              cameraRoll: Line::Bot::V2::MessagingApi::CameraRollAction,
+              clipboard: Line::Bot::V2::MessagingApi::ClipboardAction,
+              datetimepicker: Line::Bot::V2::MessagingApi::DatetimePickerAction,
+              location: Line::Bot::V2::MessagingApi::LocationAction,
+              message: Line::Bot::V2::MessagingApi::MessageAction,
+              postback: Line::Bot::V2::MessagingApi::PostbackAction,
+              richmenuswitch: Line::Bot::V2::MessagingApi::RichMenuSwitchAction,
+              uri: Line::Bot::V2::MessagingApi::URIAction,
+            }[type.to_sym]


✅ Keys are correct: https://github.com/line/line-openapi/blob/4e10c73df579b4c1821a305f0190dfbe8710d2de/messaging-api.yml#L4744-L4756

special point: richmenuswitch

Yang-33 · 2025-04-04T02:47:01Z

+          def self.detect_class(type)
+            {
+              buttons: Line::Bot::V2::MessagingApi::ButtonsTemplate,
+              carousel: Line::Bot::V2::MessagingApi::CarouselTemplate,
+              confirm: Line::Bot::V2::MessagingApi::ConfirmTemplate,
+              image_carousel: Line::Bot::V2::MessagingApi::ImageCarouselTemplate,
+            }[type.to_sym]
+          end


✅ Keys are correct https://github.com/line/line-openapi/blob/4e10c73df579b4c1821a305f0190dfbe8710d2de/messaging-api.yml#L3900-L3906

special point: image_carousel

Yang-33 · 2025-04-04T02:48:08Z

+          def self.create(args)
+            klass = detect_class(args[:type])
+            return klass.new(**args) if klass
+
+            return new(**args)
+          end
+
+          private
+
+          def self.detect_class(type)
+            {
+              accountLink: Line::Bot::V2::Webhook::AccountLinkEvent,
+              activated: Line::Bot::V2::Webhook::ActivatedEvent,
+              beacon: Line::Bot::V2::Webhook::BeaconEvent,
+              botResumed: Line::Bot::V2::Webhook::BotResumedEvent,
+              botSuspended: Line::Bot::V2::Webhook::BotSuspendedEvent,
+              deactivated: Line::Bot::V2::Webhook::DeactivatedEvent,
+              follow: Line::Bot::V2::Webhook::FollowEvent,
+              join: Line::Bot::V2::Webhook::JoinEvent,
+              leave: Line::Bot::V2::Webhook::LeaveEvent,
+              memberJoined: Line::Bot::V2::Webhook::MemberJoinedEvent,
+              memberLeft: Line::Bot::V2::Webhook::MemberLeftEvent,
+              membership: Line::Bot::V2::Webhook::MembershipEvent,
+              message: Line::Bot::V2::Webhook::MessageEvent,
+              module: Line::Bot::V2::Webhook::ModuleEvent,
+              delivery: Line::Bot::V2::Webhook::PnpDeliveryCompletionEvent,
+              postback: Line::Bot::V2::Webhook::PostbackEvent,
+              things: Line::Bot::V2::Webhook::ThingsEvent,
+              unfollow: Line::Bot::V2::Webhook::UnfollowEvent,
+              unsend: Line::Bot::V2::Webhook::UnsendEvent,
+              videoPlayComplete: Line::Bot::V2::Webhook::VideoPlayCompleteEvent,
+            }[type.to_sym]
+          end


✅ Keys are correct 👍 : https://github.com/line/line-openapi/blob/4e10c73df579b4c1821a305f0190dfbe8710d2de/webhook.yml#L95-L117

Yang-33 · 2025-04-04T02:51:30Z

@@ -35,13 +38,15 @@
        expect(events).not_to be_empty

        event = events.first
-        expect(event).to be_a(Struct)
+        expect(event).to be_a(Line::Bot::V2::Webhook::Event)


can you fix 2 files?

line-bot-sdk-ruby/sig/line/bot/v2/webhook_parser.rbs

Lines 10 to 13 in 9e34215

def parse: (

body: String,

signature: String

) -> Array[Webhook::Event | ::Struct[untyped]]

now it always return Line::Bot::V2::Webhook::Event

line-bot-sdk-ruby/lib/line/bot/v2/webhook_parser.rb

Lines 24 to 28 in 9e34215

# @return [Array<Line::Bot::V2::Webhook::Event, Struct>]

# An array of event objects. Recognized events become instances of classes

# under `Line::Bot::V2::Webhook::*Event`; otherwise, they're returned as `Struct`.

# `Struct` is returned as fallback only when the event class is not defined in line-bot-sdk library.

# When you update the SDK, you may not need to handle `Struct` anymore.

comment should be update(maybe we can update sentences more simply)

👍 49e89af
The RBS file has already been updated.

Yang-33 · 2025-04-04T02:51:52Z

+      expect(body.sent_messages).to be_a(Array)
+      expect(body.sent_messages[0]).to be_a(Line::Bot::V2::MessagingApi::SentMessage)
+      expect(body.sent_messages[0].id).to eq('461230966842064897')
+      expect(body.sent_messages[0].quote_token).to eq('IStG5h1Tz7b...')


👍👍👍

Yang-33 · 2025-04-04T02:52:41Z

@@ -22,6 +22,12 @@ module Line
            quick_reply: QuickReply?,
            sender: Sender?
          ) -> void
+
+          def self.create: (args: Hash[Symbol, untyped]) -> Message


- many query parameters with whitespace - nested response (#461 resolved this)

As confirmed [here](#461 (comment)), the value of type embedded in the class has some peculiarities. There are sufficient tests for deserializing (webhook), so this change adds the missing tests for serialization.

mokuzon self-assigned this Apr 4, 2025

mokuzon commented Apr 4, 2025

View reviewed changes

mokuzon requested a review from a team April 4, 2025 02:25

mokuzon force-pushed the release_v2/dynamic_parse branch from 61c4a5a to 9cedfba Compare April 4, 2025 02:34

mokuzon added 4 commits April 4, 2025 11:35

Implement dynamic parsing

6621f72

Run generate-code.py

805c78d

Update & fix current specs

e1bc9cd

Add an spec for MembershipEvent webhook

91cb949

mokuzon force-pushed the release_v2/dynamic_parse branch from 9cedfba to 91cb949 Compare April 4, 2025 02:35

mokuzon commented Apr 4, 2025

View reviewed changes

Yang-33 approved these changes Apr 4, 2025

View reviewed changes

This was linked to issues Apr 4, 2025

V2: Automatically create a webhook parser #404

Closed

Parse membership event in webhook parser #426

Closed

Accessing a nested structure results in a NoMethodError #440

Closed

Update YARD document

49e89af

Yang-33 approved these changes Apr 4, 2025

View reviewed changes

mokuzon merged commit d9366ab into line:master Apr 4, 2025
6 checks passed

mokuzon deleted the release_v2/dynamic_parse branch April 4, 2025 03:05

Yang-33 mentioned this pull request Apr 4, 2025

Add test for audiencegroup list API #462

Merged

Yang-33 added a commit that referenced this pull request Apr 4, 2025

Add test for audiencegroup list API (#462)

710d0d8

- many query parameters with whitespace - nested response (#461 resolved this)

Yang-33 mentioned this pull request Apr 4, 2025

Add test using special fixed value for 'type' parameter #466

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for dynamic initialization of nested classes#461

Support for dynamic initialization of nested classes#461
mokuzon merged 5 commits intoline:masterfrom
mokuzon:release_v2/dynamic_parse

mokuzon commented Apr 4, 2025

Uh oh!

mokuzon Apr 4, 2025

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

mokuzon Apr 4, 2025

Uh oh!

Yang-33 left a comment

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

mokuzon Apr 4, 2025

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

Yang-33 Apr 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	def parse: (
	body: String,
	signature: String
	) -> Array[Webhook::Event \| ::Struct[untyped]]

	# @return [Array<Line::Bot::V2::Webhook::Event, Struct>]
	# An array of event objects. Recognized events become instances of classes
	# under `Line::Bot::V2::Webhook::*Event`; otherwise, they're returned as `Struct`.
	# `Struct` is returned as fallback only when the event class is not defined in line-bot-sdk library.
	# When you update the SDK, you may not need to handle `Struct` anymore.

Conversation

mokuzon commented Apr 4, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yang-33 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants