fix(core-clp): Advance to the next message when a message has an out-of-range timestamp when searching archives (fixes #659).

[LinZhihao-723]

Description

#426 introduced a refactoring for querying messages in archive files. This refactoring has a bug that doesn't increment the message index when the message's timestamp is out of the query's timestamp range.
This PR fixes the issue by incrementing the message indices before any loop branching that could lead to the next loop iteration.

Validation performed

• Ensure all workflows passed.
• Ensure the bug has been fixed, confirmed with @junhaoliao

Summary by CodeRabbit

Summary by CodeRabbit

• Refactor
  • Improved index management in message search functionality.
  • Enhanced tracking of message and variable indices.
  • Clarified index advancement logic in search method.

These changes enhance the clarity and correctness of the message search process, ensuring a more straightforward experience for users without altering the external interface.

[coderabbitai]

Walkthrough

The changes modify the File class in the clp::streaming_archive::reader namespace, specifically the find_message_matching_query method. The modifications focus on improving index management during message searching. The updates introduce new variables like curr_msg_ix and vars_begin_ix to enhance tracking of message and variable indices. The changes clarify the advancement and referencing of indices, ensuring more precise message processing and index alignment.

Changes

File	Change Summary
components/core/src/clp/streaming_archive/reader/File.cpp	- Introduced curr_msg_ix to track current message index - Added vars_begin_ix for variable index tracking - Modified index advancement logic - Updated timestamp and message index access

Sequence Diagram

sequenceDiagram
    participant Reader as File Reader
    participant Query as Query Matcher
    
    Reader->>Query: find_message_matching_query()
    Query-->>Reader: Track message indices
    Reader->>Reader: Update curr_msg_ix
    Reader->>Reader: Calculate vars_begin_ix
    Reader->>Query: Check message match

Loading

---

📜 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 82cc349 and d54c2dc.

📒 Files selected for processing (1)

• components/core/src/clp/streaming_archive/reader/File.cpp (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• components/core/src/clp/streaming_archive/reader/File.cpp

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build-macos (macos-14, false)
• GitHub Check: build-macos (macos-13, false)
• GitHub Check: build-macos (macos-13, true)
• GitHub Check: lint-check (ubuntu-latest)
• GitHub Check: build (macos-latest)
• GitHub Check: lint-check (macos-latest)

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[junhaoliao]

I validated the changes in the WebUI with steps specified in #659 and the issue is now no longer observed.

I understand the source of the bug, and the changes look right to me, but someone with more experience with the CLP core code should also take a look.

[kirkrodrigues]

For the PR title, how about:

fix(core-clp): Advance to the next message when a message has an out-of-range timestamp when searching archives (fixes #659).