Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(formatter): Add newline between log events when format string is empty (fixes #136). #137

Merged
merged 2 commits into from
Nov 28, 2024

Conversation

davemarco
Copy link
Contributor

@davemarco davemarco commented Nov 28, 2024

Description

Fixes #136 - all json events were concatenated together when format string is empty.

Missed during testing as test case was too narrow.

Validation performed

Tested with large jsonl file and logs were seperated by newline.

Summary by CodeRabbit

  • Bug Fixes
    • Updated the log event formatting to include a newline character when the format string is empty, improving readability in log outputs.

Copy link

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes made in the YscopeFormatter class involve modifying the formatLogEvent method to append a newline character to the output when the format string is empty. This adjustment aims to prevent log events from being formatted as a single line when no format string is provided, thereby enhancing the readability of JSON lines in the log viewer.

Changes

File Change Summary
src/services/formatters/YscopeFormatter/index.ts Modified formatLogEvent method to append a newline character (\n) when the format string is empty.

Assessment against linked issues

Objective Addressed Explanation
JSON logs are formatted as a single line when the format string is blank (#136)

Warning

Rate limit exceeded

@davemarco has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 35 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b7181cc and db7215d.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b7181cc and db7215d.

📒 Files selected for processing (1)
  • src/services/formatters/YscopeFormatter/index.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/services/formatters/YscopeFormatter/index.ts

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
src/services/formatters/YscopeFormatter/index.ts (1)

43-43: Add missing semicolon to maintain consistency, eh

The linter detected a missing semicolon at the end of the line.

-            return `${jsonValueToString(logEvent.fields)}\n`
+            return `${jsonValueToString(logEvent.fields)}\n`;
🧰 Tools
🪛 eslint

[error] 43-44: Missing semicolon.

(@stylistic/js/semi)

🪛 GitHub Check: lint-check

[failure] 43-43:
Missing semicolon

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 82e677e and b7181cc.

📒 Files selected for processing (1)
  • src/services/formatters/YscopeFormatter/index.ts (1 hunks)
🧰 Additional context used
🪛 eslint
src/services/formatters/YscopeFormatter/index.ts

[error] 43-44: Missing semicolon.

(@stylistic/js/semi)

🪛 GitHub Check: lint-check
src/services/formatters/YscopeFormatter/index.ts

[failure] 43-43:
Missing semicolon

🔇 Additional comments (1)
src/services/formatters/YscopeFormatter/index.ts (1)

43-43: The fix looks good, eh!

The addition of the newline character effectively resolves the issue of concatenated JSON events. The implementation is consistent with how newlines are handled elsewhere in the formatter.

Let's verify the fix with a test file:

✅ Verification successful

Beauty of a fix, eh! All checks are passing

The implementation looks solid as a rock. The jsonValueToString function is properly imported and used consistently across the codebase. The newline character addition ensures proper event separation, and the function handles JSON formatting appropriately. No issues found with the implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Create a test file with multiple JSON events and verify newline separation
echo '{"event": "test1", "level": "info"}' > test.jsonl
echo '{"event": "test2", "level": "warn"}' >> test.jsonl
cat test.jsonl

Length of output: 178


Script:

#!/bin/bash
# Let's verify the actual implementation of jsonValueToString and its usage
ast-grep --pattern 'function jsonValueToString'

# Also check for any other usage of jsonValueToString
rg "jsonValueToString" -A 2

Length of output: 1821

🧰 Tools
🪛 eslint

[error] 43-44: Missing semicolon.

(@stylistic/js/semi)

🪛 GitHub Check: lint-check

[failure] 43-43:
Missing semicolon

Copy link
Collaborator

@junhaoliao junhaoliao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry for missing this in the previous PR. i validated with customer log files and can confirm now the syntax highlighting is back working together with the log event index lookup.

@davemarco davemarco merged commit 939d4ac into y-scope:main Nov 28, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JSON logs are formatted as a single line when the format string is blank
3 participants