[api] add support for batch webhooks#247
Open
capcom6 wants to merge 1 commit into
Open
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (6)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (5)
📝 WalkthroughWalkthroughThis PR replaces the nullable ChangesWebhookDelivery refresh flow
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant Client
participant ThirdPartyController
participant InboxService
participant Events
Client->>ThirdPartyController: POST inbox refresh/export
ThirdPartyController->>ThirdPartyController: ResolveWebhookDelivery()
ThirdPartyController->>InboxService: Refresh(webhookDelivery)
InboxService->>Events: NewMessagesExportRequestedEvent(webhookDelivery)
Events-->>InboxService: Event payload
InboxService-->>ThirdPartyController: result
Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
internal/sms-gateway/openapi/docs.go (1)
484-484: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winStale endpoint description references only the deprecated field.
The
/3rdparty/v1/inbox/refreshdescription still says the webhook trigger depends ontriggerWebhooks, but this file now documents the newwebhookDeliveryfield (and markstriggerWebhooksdeprecated) a few hundred lines later. Update the underlying Go doc comment in the handler (not shown in this diff) that generates this swagger description, so it reflectswebhookDeliveryas the primary control.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@internal/sms-gateway/openapi/docs.go` at line 484, The `/3rdparty/v1/inbox/refresh` swagger description is stale and still mentions only the deprecated triggerWebhooks flag. Update the Go doc comment on the handler that generates this OpenAPI text so it describes webhookDelivery as the primary control, while still acknowledging triggerWebhooks only as deprecated if needed; use the refresh endpoint handler and its generated docs source to locate the comment.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@internal/sms-gateway/openapi/docs.go`:
- Line 484: The `/3rdparty/v1/inbox/refresh` swagger description is stale and
still mentions only the deprecated triggerWebhooks flag. Update the Go doc
comment on the handler that generates this OpenAPI text so it describes
webhookDelivery as the primary control, while still acknowledging
triggerWebhooks only as deprecated if needed; use the refresh endpoint handler
and its generated docs source to locate the comment.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0073990f-bbb5-47d6-9cf1-3576a9705d9b
⛔ Files ignored due to path filters (1)
go.sumis excluded by!**/*.sum
📒 Files selected for processing (6)
go.modinternal/sms-gateway/handlers/inbox/3rdparty.gointernal/sms-gateway/handlers/messages/3rdparty.gointernal/sms-gateway/inbox/service.gointernal/sms-gateway/modules/events/events.gointernal/sms-gateway/openapi/docs.go
🤖 Pull request artifacts
|
capcom6
force-pushed
the
api/batch-webhooks
branch
2 times, most recently
from
8239b7c to
2712c9f
Compare
capcom6
force-pushed
the
api/batch-webhooks
branch
from
2712c9f to
a72cf83
Compare
capcom6
force-pushed
the
api/batch-webhooks
branch
from
a72cf83 to
61b837a
Compare
capcom6
force-pushed
the
api/batch-webhooks
branch
from
1621f50 to
93d4331
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary by CodeRabbit
New Features
webhookDeliverymodes (Disabled,Individual,Batch) for inbox refresh and related message export webhook behavior.Bug Fixes
webhookDeliverymode instead of the legacy boolean.Documentation
webhookDelivery, deprecatetriggerWebhooks, and refresh related schemas.Chores