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(decoder): Handle invalid UTF-8 sequences gracefully when converting structured log events to JSON. #170

Merged
merged 1 commit into from
Jan 20, 2025

Conversation

davemarco
Copy link
Contributor

@davemarco davemarco commented Jan 20, 2025

Description

Updates clp-ffi-js version to 0.3.4 and by doing so handles invalid UTF-8 sequences gracefully without exception

Validation performed

Tested no exception on test file

Summary by CodeRabbit

Release Notes

  • Chores
    • Updated clp-ffi-js dependency to version 0.3.4
    • Minor formatting improvement in ESLint configuration

Copy link

coderabbitai bot commented Jan 20, 2025

Walkthrough

This pull request involves a minor update to the package.json file for the yscope-log-viewer project. The primary change is a version bump of the clp-ffi-js dependency from version ^0.3.3 to ^0.3.4. Additionally, there is a formatting adjustment in the eslintConfig section, which improves the readability of the Jest configuration by introducing line breaks without changing its functional behaviour.

Changes

File Change Summary
package.json - Updated clp-ffi-js dependency from ^0.3.3 to ^0.3.4
- Reformatted eslintConfig extends array with line breaks

Possibly related PRs

Suggested reviewers

  • junhaoliao

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 07c3558 and 5976a24.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • package.json (2 hunks)
🔇 Additional comments (2)
package.json (2)

101-103: LGTM! Improved formatting.

The formatting change in the eslintConfig section enhances readability without affecting functionality.


33-33: Verify the clp-ffi-js version and its changelog.

The version bump to handle invalid UTF-8 sequences looks good. Let's verify it's the latest version and check for any breaking changes.

✅ Verification successful

Version 0.3.4 of clp-ffi-js is confirmed as the latest available version

The version bump to ^0.3.4 is appropriate as it's currently the latest release available on npm.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the clp-ffi-js version and changelog

# Check NPM for latest version
npm view clp-ffi-js versions --json

# Check for potential security advisories
npm audit clp-ffi-js

Length of output: 1002


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@davemarco davemarco changed the title fix(decoder): Update to clp-ffi-js 0.3.4; Handle invalid UTF-8 sequences gracefully when converting structured log events to JSON. fix(decoder): Upgrade to clp-ffi-js 0.3.4; Handle invalid UTF-8 sequences gracefully when converting structured log events to JSON. Jan 20, 2025
@davemarco davemarco requested a review from junhaoliao January 20, 2025 21:53
@davemarco
Copy link
Contributor Author

davemarco commented Jan 20, 2025

Perhaps chore(decoder): Upgrade to clp-ffi-js 0.3.4
is a better title. I will like if propagate the reason for the upgrade on every PR it might get redundant. But let me know what you prefer

@junhaoliao
Copy link
Member

Perhaps chore(decoder): Upgrade to clp-ffi-js 0.3.4 is a better title. I will like if propagate the reason for the upgrade on every PR it might get redundant. But let me know what you prefer

How about:

fix(decoder): Handle invalid UTF-8 sequences gracefully when converting structured log events to JSON.

then in the message body:

- Upgrade clp-ffi-js to 0.3.4

@davemarco davemarco changed the title fix(decoder): Upgrade to clp-ffi-js 0.3.4; Handle invalid UTF-8 sequences gracefully when converting structured log events to JSON. fix(decoder): Handle invalid UTF-8 sequences gracefully when converting structured log events to JSON. Jan 20, 2025
@davemarco davemarco merged commit a8b8da7 into y-scope:main Jan 20, 2025
7 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.

2 participants