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

clp: Add missing C++ standard library includes in IR parsing files. #561

Merged
merged 2 commits into from
Oct 22, 2024

Conversation

LinZhihao-723
Copy link
Member

@LinZhihao-723 LinZhihao-723 commented Oct 22, 2024

Description

clp-ffi-py workflow build failed on Windows: y-scope/clp-ffi-py#70
This is due to missing <string> headers in clp/ir/parsing.cpp and clp/ir/parsing.hpp. This PR adds all missing headers to these files to solve the issue.

Validation performed

  • All workflow passed
  • Verified that clp-ffi-py can be successfully built on Window (tested locally) with the change of this PR

Summary by CodeRabbit

  • New Features
    • Introduced a new function for appending constants to log types, enhancing string handling capabilities.
  • Improvements
    • Added necessary include directives to streamline compilation.
    • Updated comments for better context on variable handling and string parsing.

Copy link
Contributor

coderabbitai bot commented Oct 22, 2024

Walkthrough

The changes involve modifications to three files within the clp::ir namespace: parsing.cpp, parsing.hpp, and parsing.inc. New include directives for <cstddef>, <string>, and <string_view> have been added, while <vector> has been removed from parsing.hpp. The existing functions' logic and signatures remain unchanged. A new template function, append_constant_to_logtype, has been introduced in parsing.inc, which processes a string view and appends relevant substrings to a specified log type.

Changes

File Path Change Summary
components/core/src/clp/ir/parsing.cpp Added include directives for <cstddef>, <string>, and <string_view>. No changes to function logic.
components/core/src/clp/ir/parsing.hpp Added include directives for <cstddef> and <string>, removed <vector>. No changes to functions.
components/core/src/clp/ir/parsing.inc Added include directive for <cstddef> and defined a new function append_constant_to_logtype.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Parser
    participant LogType

    User->>Parser: Call append_constant_to_logtype(constant, escape_handler, logtype)
    Parser->>Parser: Iterate over characters in constant
    alt Escape character found
        Parser->>LogType: Append substring to logtype
        Parser->>escape_handler: Call escape handler
    else Variable placeholder found
        Parser->>LogType: Append substring to logtype
        Parser->>escape_handler: Call escape handler
    end
    Parser->>LogType: Append remaining substring to logtype
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ce9eb67 and d846723.

📒 Files selected for processing (1)
  • components/core/src/clp/ir/parsing.cpp (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/core/src/clp/ir/parsing.cpp

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
Contributor

@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)
components/core/src/clp/ir/parsing.inc (1)

Line range hint 12-35: Consider adding documentation and optimizations.

A few suggestions to improve the implementation:

  1. Document the EscapeHandler concept requirements
  2. Pre-reserve space in logtype
  3. Simplify the boolean expression

Here's a suggested improvement:

 template <typename EscapeHandler>
+// EscapeHandler requirements:
+// - Callable with signature: void(std::string_view, size_t&, std::string&)
+// - May modify the size_t index for multi-character escape sequences
 void append_constant_to_logtype(
         std::string_view constant,
         EscapeHandler escape_handler,
         std::string& logtype
 ) {
     size_t begin_pos = 0;
     auto constant_len = constant.length();
+    logtype.reserve(logtype.size() + constant_len);  // Reserve space upfront
     for (size_t i = 0; i < constant_len; ++i) {
         auto const c = constant[i];
-        bool const is_escape_char = (enum_to_underlying_type(VariablePlaceholder::Escape) == c);
-        if (false == is_escape_char && false == is_variable_placeholder(c)) {
+        if (c != enum_to_underlying_type(VariablePlaceholder::Escape) 
+            && !is_variable_placeholder(c)) {
             continue;
         }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e21672b and ce9eb67.

📒 Files selected for processing (3)
  • components/core/src/clp/ir/parsing.cpp (1 hunks)
  • components/core/src/clp/ir/parsing.hpp (1 hunks)
  • components/core/src/clp/ir/parsing.inc (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • components/core/src/clp/ir/parsing.cpp
  • components/core/src/clp/ir/parsing.hpp
🧰 Additional context used
🔇 Additional comments (2)
components/core/src/clp/ir/parsing.inc (2)

4-6: LGTM: Header additions address the Windows build issue.

The added standard library headers are necessary and correctly ordered according to C++ best practices.


Line range hint 28-30: Verify escape handler bounds safety.

The escape_handler can modify 'i', but there's no verification that it stays within bounds. Consider adding bounds checking or documenting this requirement.

@kirkrodrigues kirkrodrigues changed the title clp: Add missing C/C++ standard library includes in IR parsing methods. clp: Add missing C++ standard library includes in IR parsing files. Oct 22, 2024
@LinZhihao-723 LinZhihao-723 merged commit 65b231b into y-scope:main Oct 22, 2024
18 checks passed
LinZhihao-723 added a commit to LinZhihao-723/clp that referenced this pull request Nov 12, 2024
* ffi: Add support for serializing/deserializing auto-generated and user-generated schema tree node IDs. (y-scope#557)

Co-authored-by: kirkrodrigues <[email protected]>

* clp: Add missing C++ standard library includes in IR parsing files. (y-scope#561)

Co-authored-by: kirkrodrigues <[email protected]>

* log-viewer-webui: Update `yscope-log-viewer` to the latest version (which uses `clp-ffi-js`). (y-scope#562)

* package: Upgrade dependencies to resolve security issues. (y-scope#536)

* clp-s: Implement table packing (y-scope#466)

Co-authored-by: wraymo <[email protected]>
Co-authored-by: Kirk Rodrigues <[email protected]>
Co-authored-by: wraymo <[email protected]>

* log-viewer-webui: Update `yscope-log-viewer` to the latest version. (y-scope#565)

* ci: Switch GitHub macOS build workflow to use macos-13 (x86) and macos-14 (ARM) runners. (y-scope#566)

* core: Add support for user-defined HTTP headers in `NetworkReader`. (y-scope#568)

Co-authored-by: Lin Zhihao <[email protected]>
Co-authored-by: Xiaochong Wei <[email protected]>

* chore: Update to the latest version of yscope-dev-utils. (y-scope#574)

* build(core): Upgrade msgpack to v7.0.0. (y-scope#575)

* feat(ffi): Update IR stream protocol version handling in preparation for releasing the kv-pair IR stream format: (y-scope#573)

- Bump the IR stream protocol version to 0.1.0 for the kv-pair IR stream format.
- Treat the previous IR stream format's versions as backwards compatible.
- Differentiate between backwards-compatible and supported versions during validation.

Co-authored-by: kirkrodrigues <[email protected]>

* fix(taskfiles): Trim trailing slash from URL prefix in `download-and-extract-tar` (fixes y-scope#577). (y-scope#578)

* fix(ffi): Correct `clp::ffi::ir_stream::Deserializer::deserialize_next_ir_unit`'s return value when failing to read the next IR unit's type tag. (y-scope#579)

* fix(taskfiles): Update `yscope-log-viewer` sources in `log-viewer-webui-clients` sources list (fixes y-scope#576). (y-scope#580)

* fix(cmake): Add Homebrew path detection for `mariadb-connector-c` to fix macOS build failure. (y-scope#582)

Co-authored-by: kirkrodrigues <[email protected]>

* refactor(ffi): Make `get_schema_subtree_bitmap` a public method of `KeyValuePairLogEvent`. (y-scope#581)

* ci: Schedule GitHub workflows to daily run to detect failures due to upgraded dependencies or environments. (y-scope#583)

* docs: Update the required version of task. (y-scope#567)

* Add pr check workflow

---------

Co-authored-by: kirkrodrigues <[email protected]>
Co-authored-by: Junhao Liao <[email protected]>
Co-authored-by: Henry8192 <[email protected]>
Co-authored-by: Devin Gibson <[email protected]>
Co-authored-by: wraymo <[email protected]>
Co-authored-by: wraymo <[email protected]>
Co-authored-by: Xiaochong(Eddy) Wei <[email protected]>
Co-authored-by: Xiaochong Wei <[email protected]>
Co-authored-by: haiqi96 <[email protected]>
jackluo923 pushed a commit to jackluo923/clp that referenced this pull request Dec 4, 2024
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