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: Add guard to handle null decode results; Update log event query to use active event count (fixes #166). #167

Merged
merged 8 commits into from
Jan 10, 2025

Conversation

davemarco
Copy link
Contributor

@davemarco davemarco commented Jan 10, 2025

Description

clp-ffi-js:decode_range will print an error and return null if it is provided invalid args. This PR adds a guard, so if the result is null, the javascript wrapper decodeRange for structuredIR will not attempt to iterate over results, and return early.

Moreover, this was indirectly caused by invalid args being sent to decodeRange when querying. It does not check if there are no log events (like loadPage), and the calculation is based on the total log events, and not the amount of active events. This can lead to decodeRange being called with invalid args, and printing an error and returning null, leading to the exception, and potentially missing results with no exception in other cases.

This PR also fixes the args passed to decode_range when searching.

Validation performed

Tested there is no more exception. Tested that the range is based on active log events.

Summary by CodeRabbit

Summary by CodeRabbit

Release Notes

  • Bug Fixes

    • Improved log event querying to handle filtered events more accurately.
    • Enhanced decoding method to better manage null result scenarios.
  • Performance

    • Optimized progress calculation for log event processing.
    • Refined method to prevent unnecessary processing when no active events exist.

The updates focus on improving the robustness and precision of log file management and decoding processes.

Copy link

coderabbitai bot commented Jan 10, 2025

Warning

Rate limit exceeded

@davemarco has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 15 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 b71dcb0 and 0cdb800.

📒 Files selected for processing (1)
  • src/services/LogFileManager/index.ts (3 hunks)

Walkthrough

The pull request introduces changes to the LogFileManager and ClpIrDecoder classes, enhancing the handling of filtered log events and decoding processes. The #queryChunkAndScheduleNext method in LogFileManager is updated to focus on active log events, incorporating an early return for scenarios with no active events. Simultaneously, the decodeRange method in ClpIrDecoder is modified to allow for nullable results, improving its control flow when decoding yields no results.

Changes

File Change Summary
src/services/LogFileManager/index.ts - Updated #queryChunkAndScheduleNext method to use numActiveEvents instead of this.#numEvents
- Added early return when no active events exist
- Modified progress calculation to reflect active events
src/services/decoders/ClpIrDecoder.ts - Updated decodeRange method return type to Nullable<DecodeResult[]>
- Added conditional check to return null if results are null

Possibly Related PRs

Suggested Reviewers

  • kirkrodrigues

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.

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

🧹 Nitpick comments (1)
src/services/LogFileManager/index.ts (1)

Line range hint 1-451: File exceeds maximum line limit.

The file has 451 lines, exceeding the maximum allowed 450 lines. Consider removing one blank line to meet the limit.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f74bacf and 4b9cfca.

📒 Files selected for processing (2)
  • src/services/LogFileManager/index.ts (2 hunks)
  • src/services/decoders/ClpIrDecoder.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
src/services/LogFileManager/index.ts (1)

Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

src/services/decoders/ClpIrDecoder.ts (1)

Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

📓 Learnings (1)
src/services/LogFileManager/index.ts (1)
Learnt from: Henry8192
PR: y-scope/yscope-log-viewer#80
File: new-log-viewer/src/services/LogFileManager/index.ts:305-321
Timestamp: 2024-11-10T16:46:58.543Z
Learning: When a function like `#searchChunkAndScheduleNext` requires significant improvements, it's preferred to rewrite the entire function rather than making incremental changes.
🪛 GitHub Actions: lint
src/services/LogFileManager/index.ts

[error] 451-451: File has too many lines (451). Maximum allowed is 450

🪛 GitHub Check: lint-check
src/services/decoders/ClpIrDecoder.ts

[failure] 107-107:
Unnecessary conditional, the types have no overlap

🔇 Additional comments (4)
src/services/decoders/ClpIrDecoder.ts (2)

104-109: LGTM! Proper null handling implementation.

The explicit null check is a good defensive programming practice that prevents potential runtime errors from iterating over null results.

🧰 Tools
🪛 GitHub Check: lint-check

[failure] 107-107:
Unnecessary conditional, the types have no overlap


Line range hint 139-139: LGTM! Follows coding guidelines.

The boolean comparison using false === isJsonObject(fields) correctly follows the coding guidelines.

🧰 Tools
🪛 GitHub Check: lint-check

[failure] 107-107:
Unnecessary conditional, the types have no overlap

src/services/LogFileManager/index.ts (2)

378-386: LGTM! Robust handling of active events count.

The implementation properly handles both filtered and unfiltered cases, with an appropriate early return when no active events are present.


Line range hint 388-405: LGTM! Improved chunk processing logic.

The implementation correctly handles null decode results and accurately calculates progress based on active events.

@davemarco davemarco changed the title fix: Add guard to prevent iterating over null decode result; Modify range when querying to use correct number of log events (fixes #166). fix: Add guard to prevent iterating over null decode result; Modify log event range when querying to use number of active log events (fixes #166). Jan 10, 2025
@davemarco davemarco requested a review from junhaoliao January 10, 2025 02:18
Copy link
Member

@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.

For the PR title, how about

fix: Add guard to handle null decode results; Update log event query to use active event count range.

@@ -383,7 +383,17 @@ class LogFileManager {
// Current task no longer corresponds to the latest query in the LogFileManager.
return;
}
const chunkEndIdx = Math.min(chunkBeginIdx + QUERY_CHUNK_SIZE, this.#numEvents);

const filteredLogEventMap = this.#decoder.getFilteredLogEventMap();
Copy link
Member

Choose a reason for hiding this comment

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

Let's replace the this.#decoder.getFilteredLogEventMap() call in L401 with this const.

@davemarco davemarco changed the title fix: Add guard to prevent iterating over null decode result; Modify log event range when querying to use number of active log events (fixes #166). fix: Add guard to handle null decode results; Update log event query to use active event count range (fixes #166). Jan 10, 2025
@davemarco
Copy link
Contributor Author

For the PR title, how about

fix: Add guard to handle null decode results; Update log event query to use active event count range.

How about
fix: Add guard to handle null decode results; Update log event query to use active event count (fixes #166).

@davemarco davemarco changed the title fix: Add guard to handle null decode results; Update log event query to use active event count range (fixes #166). fix: Add guard to handle null decode results; Update log event query to use active event count (fixes #166). Jan 10, 2025
@davemarco davemarco requested a review from junhaoliao January 10, 2025 03:25
@davemarco davemarco merged commit ff13649 into y-scope:main Jan 10, 2025
4 of 5 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