chore: add support for full log message in persist API #2659
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
WalkthroughThe changes involve updates to error handling messages in Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Server
participant Logger
Client->>Server: Send delete request
Server->>Logger: Log deletion attempt
Logger-->>Server: Log success/failure
Server-->>Client: Return response (error message updated)
Client->>Server: Send update request
Server->>Logger: Log update attempt
Logger-->>Server: Log success/failure
Server-->>Client: Return response (error message updated)
Client->>Server: Send log request
Server->>Logger: Log request with new structure
Logger-->>Server: Log success/failure
Server-->>Client: Return response
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
3 tasks
bodinsamuel
approved these changes
Sep 2, 2024
khaliqgant
approved these changes
Sep 3, 2024
TBonnin
force-pushed
the
tbonnin/refactor-persist-api
branch
4 times, most recently
from
736e70f
to
524f426
Compare
TBonnin
force-pushed
the
tbonnin/persist-full-log
branch
from
895ee27
to
00fee1c
Compare
![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 (3)
- packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/deleteRecords.ts (1 hunks)
- packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/putRecords.ts (1 hunks)
- packages/persist/lib/routes/environment/environmentId/postLog.ts (4 hunks)
Additional comments not posted (8)
packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/putRecords.ts (1)
51-51: LGTM!The change to the error message aligns it with the intended functionality of the
putRecordsoperation.packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/deleteRecords.ts (1)
51-51: LGTM!The updated error message accurately reflects the operation being performed and improves clarity in the API's response.
packages/persist/lib/routes/environment/environmentId/postLog.ts (6)
11-16: LGTM!The code changes are approved.
17-22: LGTM!The code changes are approved.
24-82: LGTM!The code changes are approved.
90-90: LGTM!The code changes are approved.
99-105: LGTM!The code changes are approved.
118-147: LGTM!The code changes are approved.
TBonnin
force-pushed
the
tbonnin/persist-full-log
branch
from
00fee1c
to
eb233d5
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/deleteRecords.ts (1 hunks)
- packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/putRecords.ts (1 hunks)
- packages/persist/lib/routes/environment/environmentId/postLog.ts (4 hunks)
Files skipped from review as they are similar to previous changes (2)
- packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/deleteRecords.ts
- packages/persist/lib/routes/environment/environmentId/connection/connectionId/sync/syncId/job/jobId/putRecords.ts
Additional comments not posted (6)
packages/persist/lib/routes/environment/environmentId/postLog.ts (6)
11-16: LGTM!The code changes are approved.
24-27: LGTM!The code changes are approved.
29-82: LGTM!The code changes are approved.
90-90: LGTM!The code changes are approved.
99-105: LGTM!The code changes are approved.
118-145: LGTM!The code changes are approved.
TBonnin
added a commit
that referenced
this pull request
Sep 5, 2024
## Describe your changes Please review #2659 first Sending full message logs from scripts instead of simplified ones allowing: - to attach request and response when proxying - better display of `nango.log('with payload', {a: 1})`. Payload now shows as payload in the UI and it is not appended as string to the message anymore. It is automatically fixing the display of validation output for instance    ## Issue ticket number and link https://linear.app/nango/issue/NAN-1525/improve-actions-error-logs ## Checklist before requesting a review (skip if just adding/editing APIs & templates) - [ ] I added tests, otherwise the reason is: - [ ] I added observability, otherwise the reason is: - [ ] I added analytics, otherwise the reason is: <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Enhanced logging capabilities with a new structured log format, including additional fields for improved detail and clarity. - **Bug Fixes** - Updated logging mechanisms to improve type safety and streamline logging processes. - **Chores** - Removed unnecessary dependencies to simplify the project's dependency management. - **Documentation** - Updated test cases to validate new log structures, ensuring consistency and clarity in logging behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
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.
Describe your changes
Following up on #2658 Please review this one first
Adding support for passing full log message to persistAPI. We are still sending legacy simplified logs for now.
Issue ticket number and link
https://linear.app/nango/issue/NAN-1525/improve-actions-error-logs
Checklist before requesting a review (skip if just adding/editing APIs & templates)
Summary by CodeRabbit
New Features
Bug Fixes
Documentation