feat: Add support for finding the log event that's closest to a target timestamp. #42
Conversation
# Conflicts: # src/clp_ffi_js/ir/StreamReader.cpp # src/clp_ffi_js/ir/StreamReader.hpp
WalkthroughThis pull request introduces new methods across several log stream reader classes to retrieve the nearest log event index based on a specified timestamp. The method Changes
Sequence Diagram(s)sequenceDiagram
participant JS as JavaScript Interface
participant SR as StreamReader/StructuredIrStreamReader/UnstructuredIrStreamReader
participant GF as Generic Finder
JS->>SR: findNearestLogEventByTimestamp(timestamp)
SR->>GF: generic_find_nearest_log_event_by_timestamp(log_events, timestamp)
GF-->>SR: NullableLogEventIdx
SR-->>JS: NullableLogEventIdx
Possibly related PRs
Suggested reviewers
Tip 🌐 Web search-backed reviews and chat
✨ Finishing Touches
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 (
|
There was a problem hiding this comment.
For future commits, you may follow https://github.com/y-scope/clp-ffi-js?tab=readme-ov-file#linting to run the linter
|
This PR is blocking y-scope/yscope-log-viewer#152 |
…x_by_timestamp, use std::ranges::upper_bound instead of std::upper_bound
…s null when log events are empty, and return index with "best effort"
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/clp_ffi_js/ir/StreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StreamReader.hpp(6 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.hpp(2 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp(1 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StructuredIrStreamReader.cpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StructuredIrStreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.cpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
🪛 GitHub Actions: lint
src/clp_ffi_js/ir/StreamReader.hpp
[error] 65-66: Code formatting violation: Static create method declaration is not properly formatted
[error] 126-126: Code formatting violation: DecodedResultsTsType return type declaration is not properly formatted
[error] 138-139: Code formatting violation: get_log_event_index_by_timestamp method declaration is not properly formatted
[error] 201-203: Code formatting violation: requires clause and its parameters are not properly formatted
[error] 301-303: Code formatting violation: requires clause and its parameters are not properly formatted
🔇 Additional comments (10)
src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp (1)
74-75: LGTM! Method declaration is well-defined.The method signature is consistent with the base class and follows proper C++ practices with the [[nodiscard]] attribute.
src/clp_ffi_js/ir/StructuredIrStreamReader.hpp (2)
11-11: LGTM! Include directive is appropriately placed.The addition of
<clp/ir/types.hpp>provides the necessary type definitions.
78-79: LGTM! Method declaration is consistent.The method signature matches the base class and follows the same pattern as UnstructuredIrStreamReader.
src/clp_ffi_js/ir/StructuredIrStreamReader.cpp (2)
14-14: LGTM! Include directive is appropriately placed.The addition of
<clp/ir/types.hpp>provides the necessary type definitions.
151-158: LGTM! Implementation is clean and efficient.The implementation properly delegates to the generic function, promoting code reuse between different reader types.
src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp (1)
161-168: LGTM! Implementation is consistent with StructuredIrStreamReader.The implementation properly uses the generic function, ensuring consistent behaviour across different reader types.
src/clp_ffi_js/ir/StreamReader.cpp (1)
132-132: LGTM! Type registration and function binding are properly implemented.The new type registration and function binding follow the established patterns in the codebase.
Also applies to: 149-153
src/clp_ffi_js/ir/StreamReader.hpp (3)
14-14: LGTM! Include and type declaration are properly placed.The additions follow the established patterns in the codebase.
Also applies to: 33-33
128-137: LGTM! Documentation is clear and comprehensive.The documentation clearly explains the method's purpose, parameters, and return values.
313-331: LGTM! Implementation is efficient and handles edge cases properly.The implementation:
- Correctly handles empty log events
- Uses std::upper_bound for efficient binary search
- Properly handles the case when all timestamps are larger than the target
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/clp_ffi_js/ir/StreamReader.hpp (1)
312-312: Use Yoda condition for null check.According to the coding guidelines, prefer
false == <expression>over!<expression>.Apply this diff:
- if (log_events.empty()) { + if (true == log_events.empty()) {
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/clp_ffi_js/ir/StreamReader.hpp(5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
src/clp_ffi_js/ir/StreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint (ubuntu-latest)
- GitHub Check: lint (macos-latest)
🔇 Additional comments (5)
src/clp_ffi_js/ir/StreamReader.hpp (5)
33-33: LGTM! Type declaration follows established pattern.The declaration of
LogEventIdxTsTypealigns with other type declarations in the file and properly integrates with Emscripten's type system.
128-137: LGTM! Well-documented method declaration.The documentation thoroughly explains all possible return scenarios and the method signature follows C++ best practices with appropriate use of [[nodiscard]].
138-139: Fix method declaration formatting.The method declaration needs to be reformatted according to the linting rules.
Apply this diff:
- [[nodiscard]] virtual auto get_log_event_index_by_timestamp(clp::ir::epoch_time_ms_t timestamp - ) -> LogEventIdxTsType = 0; + [[nodiscard]] virtual auto get_log_event_index_by_timestamp( + clp::ir::epoch_time_ms_t timestamp + ) -> LogEventIdxTsType = 0;
312-314: LGTM! Efficient implementation with proper edge case handling.The implementation efficiently uses binary search via std::upper_bound and properly handles all edge cases:
- Empty log events return null
- No exact match returns the last smaller index
- All larger timestamps return the first index
Also applies to: 315-322, 323-329
300-307: Fix requires clause formatting.The requires clause needs to be reformatted according to the linting rules.
Apply this diff:
-requires requires( - LogEventWithFilterData<LogEvent> const& event, - clp::ir::epoch_time_ms_t timestamp - ) { + requires requires(LogEventWithFilterData<LogEvent> const& event, + clp::ir::epoch_time_ms_t timestamp) {
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/clp_ffi_js/ir/StreamReader.hpp (1)
298-305: Add comments explaining the binary search strategy.While the implementation using
std::upper_boundis efficient, it would benefit from a brief comment explaining why this approach was chosen and how it achieves the desired result.Add a comment before the
upper_boundcall:+ // Use binary search to find the first element greater than the target timestamp. + // This allows us to step back one position to find the last element less than or equal to the target. auto first_greater_it{std::upper_bound(
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
src/clp_ffi_js/ir/StreamReader.hpp(5 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.cpp(2 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp
- src/clp_ffi_js/ir/StructuredIrStreamReader.cpp
🧰 Additional context used
📓 Path-based instructions (1)
src/clp_ffi_js/ir/StreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
🔇 Additional comments (2)
src/clp_ffi_js/ir/StreamReader.hpp (2)
33-33: LGTM! Type declaration follows established patterns.The declaration of
LogEventIdxTsTypeis appropriately placed with other output types and follows the existing pattern for TypeScript type declarations.
128-138: LGTM! Well-documented virtual method with clear behaviour specification.The method signature and documentation follow best practices. The use of
epoch_time_ms_tfor timestamp handling is appropriate.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
CMakeLists.txt(1 hunks)src/clp_ffi_js/ir/StreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StreamReader.hpp(5 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.hpp(2 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp(1 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp
- src/clp_ffi_js/ir/StructuredIrStreamReader.cpp
- src/clp_ffi_js/ir/StructuredIrStreamReader.hpp
🧰 Additional context used
📓 Path-based instructions (3)
src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.cpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint (ubuntu-latest)
- GitHub Check: lint (macos-latest)
🔇 Additional comments (7)
src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp (1)
74-75: LGTM!The method signature is correct and properly marked with
[[nodiscard]]andoverrideattributes.src/clp_ffi_js/ir/StreamReader.cpp (2)
132-132: Consider using std::optional with register_optional().For better type safety and consistency, consider using
std::optional<T>with Embind'sregister_optional()function instead of custom nullable type definitions.This has been tracked in issue #51 for implementation in a future PR.
150-153: LGTM!The function binding is correctly added and properly formatted.
src/clp_ffi_js/ir/StreamReader.hpp (4)
14-14: LGTM!The include statement is correctly added.
33-33: LGTM!The type declaration is correctly added.
128-138: LGTM!The virtual method is well-documented with clear descriptions of parameters and return values.
289-314: LGTM!The template implementation:
- Uses
std::upper_boundfor efficient searching.- Properly handles edge cases (empty container and all timestamps greater than target).
- Uses clear and descriptive variable names.
|
Sorry for the delay in reviewing this. Let's keep further discussions in the PR so that we can all come to a consensus more quickly. |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/clp_ffi_js/ir/StreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StreamReader.hpp(5 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.hpp(2 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp(1 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp
- src/clp_ffi_js/ir/StructuredIrStreamReader.hpp
- src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp
🧰 Additional context used
📓 Path-based instructions (3)
src/clp_ffi_js/ir/StructuredIrStreamReader.cpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.cpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint (ubuntu-latest)
- GitHub Check: lint (macos-latest)
🔇 Additional comments (7)
src/clp_ffi_js/ir/StructuredIrStreamReader.cpp (2)
14-14: LGTM!The include is necessary for the
epoch_time_ms_ttype used in the new method.
151-155: LGTM!The implementation correctly delegates to the generic template function, maintaining consistency with other similar methods in the class.
src/clp_ffi_js/ir/StreamReader.cpp (2)
132-132: LGTM!The type registration follows the established pattern for nullable types.
150-153: LGTM!The function binding is properly placed and follows the naming convention used in other bindings.
src/clp_ffi_js/ir/StreamReader.hpp (3)
14-14: LGTM!The include is necessary for the
epoch_time_ms_ttype used throughout the file.
33-33: LGTM!The type declaration follows the established pattern for nullable types.
129-145: LGTM!The method declaration is well documented with clear examples and edge cases.
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/clp_ffi_js/ir/StreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StreamReader.hpp(5 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.cpp(2 hunks)src/clp_ffi_js/ir/StructuredIrStreamReader.hpp(2 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp(1 hunks)src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- src/clp_ffi_js/ir/StructuredIrStreamReader.cpp
- src/clp_ffi_js/ir/StructuredIrStreamReader.hpp
- src/clp_ffi_js/ir/UnstructuredIrStreamReader.hpp
- src/clp_ffi_js/ir/StreamReader.cpp
🧰 Additional context used
📓 Path-based instructions (2)
src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint (ubuntu-latest)
- GitHub Check: lint (macos-latest)
🔇 Additional comments (4)
src/clp_ffi_js/ir/UnstructuredIrStreamReader.cpp (1)
161-165: LGTM!The implementation correctly delegates to the generic implementation and follows the single responsibility principle.
src/clp_ffi_js/ir/StreamReader.hpp (3)
33-33: LGTM!The type name clearly indicates its purpose and nullability, following the pattern used for other type declarations.
129-146: LGTM!The method declaration is well-documented with clear explanation of its behaviour, correctly marked as virtual and nodiscard, and uses consistent parameter naming.
196-209: LGTM!The templated method declaration is well-structured with appropriate documentation and parameter types.
…nction ONLY works with timestamps in chronological order.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/clp_ffi_js/ir/StreamReader.hpp (1)
196-322: Consider improving variable names for better readability.The implementation is efficient and handles edge cases well. However, consider these variable name improvements:
first_greater_itcould beupper_bound_itto match STL terminologyfirst_greater_idxcould beupper_bound_idxfor consistencyApply this diff to improve readability:
- auto first_greater_it{std::upper_bound( + auto upper_bound_it{std::upper_bound( - if (first_greater_it == log_events.begin()) { + if (upper_bound_it == log_events.begin()) { - auto const first_greater_idx{std::distance(log_events.begin(), first_greater_it)}; + auto const upper_bound_idx{std::distance(log_events.begin(), upper_bound_it)}; - return NullableLogEventIdx{emscripten::val(first_greater_idx - 1)}; + return NullableLogEventIdx{emscripten::val(upper_bound_idx - 1)};
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/clp_ffi_js/ir/StreamReader.hpp(5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
src/clp_ffi_js/ir/StreamReader.hpp (1)
Pattern **/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint (ubuntu-latest)
- GitHub Check: lint (macos-latest)
🔇 Additional comments (2)
src/clp_ffi_js/ir/StreamReader.hpp (2)
33-33: LGTM!The type declaration is well-placed and follows the established naming pattern for output types.
129-145: LGTM with a verification note.The method declaration is well-documented and consistent with the class's style. The documentation clearly states the chronological order assumption.
Let's verify if the chronological order assumption is documented elsewhere in the codebase:
✅ Verification successful
I'm going to extend our search beyond markdown files to check for any references to a "chronological order" documentation anywhere in the repository. Please run the script below:
This will help verify whether the assumption is documented elsewhere. Thank you.
LGTM – Chronological order assumption verified.
The search confirms that the chronological ordering is documented within the method’s comment in
src/clp_ffi_js/ir/StreamReader.hpp. No other contradictory or additional documentation was found.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Search for documentation about log event ordering # Expected: Find documentation about chronological order assumption rg -i "chronological|timestamp.*order|sorted.*timestamp" --type mdLength of output: 68
Script:
#!/bin/bash # Search for any reference to "chronological order" in all files across the repository. rg -i "chronological order" --max-columns 200Length of output: 180
Co-authored-by: kirkrodrigues <[email protected]>
Henry8192
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/clp_ffi_js/ir/StreamReader.hpp (1)
199-206: Simplify documentation by referencing the virtual method.The documentation can be more concise by referencing the virtual method since the behavior is already well-documented there.
Apply this diff:
- * Templated implementation of `find_nearest_log_event_by_timestamp`. - * - * @tparam LogEvent - * @param log_events - * @param target_ts - * @return See `find_nearest_log_event_by_timestamp`. + * @see find_nearest_log_event_by_timestamp
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/clp_ffi_js/ir/StreamReader.hpp(5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,ts,tsx}`: - Prefer `false ==
**/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.hpp
**/*.{cpp,hpp,java,js,jsx,ts,tsx}: - Prefer false == <expression> rather than !<expression>.
src/clp_ffi_js/ir/StreamReader.hpp⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint (ubuntu-latest)
- GitHub Check: lint (macos-latest)
🔇 Additional comments (2)
src/clp_ffi_js/ir/StreamReader.hpp (2)
33-33: LGTM!The type declaration is well-named and appropriately placed with other output types.
129-148: LGTM!The method declaration is well-documented with clear assumptions and edge cases. The
[[nodiscard]]attribute ensures proper handling of return values.
|
@junhaoliao I think this PR is ready to be merged. |
Description
Adds
getLogEventIndexByTimestampAPI inclp_ffi_js/ir/StreamReader.cppfor ClpStreamReader. It returnsnullonly if there are no log events. Otherwise, it would search logs in "best effort", which means it returns the last index smaller than the timestamp if no exact timestamp match, unless all log event timestamps are larger than the target. In that case, return the first log event index.In
clp_ffi_js/ir/StreamReader.hpp, implementsgeneric_get_log_event_index_by_timestamp(), the core logic (basically just binary search) for finding log events by timestamp.This function is called both by
StructuredIrStreamReaderandUnstructuredIrStreamReader'sget_log_event_index_by_timestamp.Validation performed
Use the following javascript for testing structured and unstructured logs:
irv2 logs generating scripts:
Summary by CodeRabbit