feat: include network information in activity response #3299
Conversation
WalkthroughWalkthroughThe recent changes enhance the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Server
Client->>Server: Create Activity
Server->>Server: Process Activity
Server-->>Server: Handle Response
alt Success
Server->>Server: Add Network Info
Server-->>Client: Return Activity with Network
else Error
Server-->>Client: Return Errors
end
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## staging #3299 +/- ##
========================================
Coverage 30.25% 30.25%
========================================
Files 184 184
Lines 24528 24528
Branches 3210 3210
========================================
Hits 7421 7421
Misses 16993 16993
Partials 114 114
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- src/device-registry/controllers/create-activity.js (7 hunks)
Additional comments not posted (7)
src/device-registry/controllers/create-activity.js (7)
37-38: LGTM! Improved readability.The formatting adjustment enhances readability without altering the logic.
73-73: LGTM! Network information added to the response.The addition of the
networkproperty in the response enhances the data returned.
126-126: LGTM! Network information added to the response.The addition of the
networkproperty in the response enhances the data returned.
179-179: LGTM! Network information added to the response.The addition of the
networkproperty in the response enhances the data returned.
298-298: LGTM! Network information added to the response.The addition of the
networkproperty in the response enhances the data returned.
353-353: LGTM! Network information added to the response.The addition of the
networkproperty in the response enhances the data returned.
407-407: LGTM! Network information added to the response.The addition of the
networkproperty in the response enhances the data returned.
There was a problem hiding this comment.
Thanks @AnthonyByansi , just left a small review comment.
It is also okay and perfectly fine to just reach out to the authors of some critical microservices just to fast track required changes. For device-registry and auth-service, it is @BenjaminSsempala and myself who author them.
| @@ -70,6 +70,7 @@ const activity = { | |||
| message: result.message, | |||
| createdActivity: result.data.createdActivity, | |||
| updatedDevice: result.data.updatedDevice, | |||
| network: result.data.network, | |||
There was a problem hiding this comment.
Hello @AnthonyByansi :
Thank you for your contribution.
However, I foresee potential runtime issues (errors) that could disrupt the service due to the absence of network-related functionality in the utilised method, as evidenced by the attached screenshot.
It's crucial to manually test functionalities, especially for critical services like device-registry and auth-service, before submitting PRs.
There was a problem hiding this comment.
Thanks @Baalmart for your constructive feedback!
I will definitely carry out the manual tests and submit my findings afterwards.
Cheers 🥂
WHAT DOES THIS PR DO?
Referencing the conversation via slack, this PR updates the activity controller methods to include
network detailsin the responseSummary by CodeRabbit
New Features
network, to the activity object, providing enhanced information in responses related to created, updated, and deleted activities.Bug Fixes