Skip to content

send analytics flag to analytics server #1354

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

Merged
merged 2 commits into from
Jun 21, 2025

Conversation

nikhilsinhaparseable
Copy link
Contributor

@nikhilsinhaparseable nikhilsinhaparseable commented Jun 20, 2025

Summary by CodeRabbit

  • New Features
    • Added a new HTTP header to requests to indicate anonymous usage data preferences based on global configuration.

Copy link
Contributor

coderabbitai bot commented Jun 20, 2025

Walkthrough

The get_latest function in src/utils/update.rs was modified to pass the send_analytics flag from the global PARSEABLE configuration to the about::user_agent function. The user_agent function in src/about.rs was updated to accept this new boolean parameter and include it in the user agent string format.

Changes

File(s) Change Summary
src/utils/update.rs Modified get_latest to read send_analytics from global config and pass it to user_agent.
src/about.rs Updated user_agent signature to accept send_analytics and include it in the user agent string.

Poem

A flag hops softly in the code,
Passed along the user’s road.
Analytics joins the agent’s song,
A little hop to keep logs strong.
With every call, the message clear,
The rabbit’s whisper you can hear! 🐇✨


📜 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 e980ff6 and 1eddaa7.

📒 Files selected for processing (2)
  • src/about.rs (1 hunks)
  • src/utils/update.rs (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/utils/update.rs
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: coverage
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Build Kafka aarch64-apple-darwin
🔇 Additional comments (3)
src/about.rs (3)

74-75: LGTM! Documentation and signature correctly updated.

The comment and function signature have been properly updated to include the send_analytics parameter.


78-82: Implementation correctly formats the analytics flag.

The format string properly includes the send_analytics boolean value in the user agent string. The positioning between commit hash and OS information is logical and matches the updated documentation.


75-86: Verify all function callers have been updated.

The function signature change is a breaking change. Ensure all callers of user_agent have been updated to pass the new send_analytics parameter to prevent compilation errors.

#!/bin/bash
# Description: Find all calls to user_agent function to verify they include the new parameter
# Expected: All calls should pass the send_analytics parameter

# Search for function calls to user_agent
rg -A 3 "user_agent\(" --type rust
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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

🧹 Nitpick comments (1)
src/utils/update.rs (1)

36-41: Consider improving error handling for robustness.

The header creation logic is correct, but using expect() could theoretically cause a panic. While boolean string values should always be valid headers, consider using map_err() for more robust error handling.

-    headers.insert(
-        "P_SEND_ANONYMOUS_USAGE_DATA",
-        header::HeaderValue::from_str(send_analytics.as_str()).expect("valid header value"),
-    );
+    headers.insert(
+        "P_SEND_ANONYMOUS_USAGE_DATA",
+        header::HeaderValue::from_str(send_analytics.as_str())
+            .map_err(|_| anyhow!("Failed to create analytics header value"))?,
+    );
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4240fb5 and e980ff6.

📒 Files selected for processing (1)
  • src/utils/update.rs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
  • GitHub Check: coverage
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: Build Kafka aarch64-apple-darwin
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
🔇 Additional comments (2)
src/utils/update.rs (2)

23-23: LGTM! Import statements are appropriate.

The added imports are necessary for the header functionality and configuration access.

Also applies to: 25-25


44-44: LGTM! Clean integration with existing client builder pattern.

The header configuration fits well with the existing reqwest client setup.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jun 20, 2025
@nitisht nitisht merged commit c3c402d into parseablehq:main Jun 21, 2025
14 checks passed
@nikhilsinhaparseable nikhilsinhaparseable deleted the add-analytics branch June 21, 2025 03:33
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