Skip to content

refactor: remove use of lazy_static #1216

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 1 commit into from
Feb 28, 2025
Merged

refactor: remove use of lazy_static #1216

merged 1 commit into from
Feb 28, 2025

Conversation

de-sh
Copy link
Contributor

@de-sh de-sh commented Feb 28, 2025

ref: rust-lang-nursery/lazy-static.rs#214

Fixes #XXXX.

Description


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

Summary by CodeRabbit

  • Chore
    • Removed an outdated dependency to streamline internal code maintenance.
  • Refactor
    • Enhanced internal state management by updating initialization routines and encapsulating key variables.

Copy link

coderabbitai bot commented Feb 28, 2025

Walkthrough

This pull request removes the dependency lazy_static version "1.4" from the Cargo.toml file and updates the initialization of the global variable in the health check handler. The SIGNAL_RECEIVED variable is now initialized using once_cell::sync::Lazy instead of the lazy_static macro, and its visibility is changed from public to private. No other changes are introduced.

Changes

File Change Summary
Cargo.toml Removed the dependency declaration lazy_static = "1.4".
src/handlers/http/health_check.rs Replaced the use of lazy_static! for SIGNAL_RECEIVED with a declaration using once_cell::sync::Lazy and changed its visibility from public to private.

Sequence Diagram(s)

No sequence diagrams to display as changes do not modify control flow or introduce new features.

Possibly related PRs

  • fix: ensure panic safety #1212: Involves similar changes with the removal of lazy_static and modifications to static variable initialization, directly relating to these dependency and usage updates.

Suggested reviewers

  • nikhilsinhaparseable

Poem

I'm a bunny in the code, so light and free,
Hoping through changes in dependency spree.
Lazy_static hops away as once_cell takes the lead,
In quiet code meadows, I savor this new speed.
With each lovely nibble of code fresh and bright,
I celebrate these changes deep into the night! 🐇✨


📜 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 f7d366e and 507bf16.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (2)
  • Cargo.toml (0 hunks)
  • src/handlers/http/health_check.rs (1 hunks)
💤 Files with no reviewable changes (1)
  • Cargo.toml
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: Build Default x86_64-pc-windows-msvc
  • GitHub Check: Build Default aarch64-apple-darwin
  • GitHub Check: Build Default x86_64-apple-darwin
  • GitHub Check: Build Default aarch64-unknown-linux-gnu
  • GitHub Check: Build Kafka aarch64-apple-darwin
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
  • GitHub Check: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: coverage
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
🔇 Additional comments (2)
src/handlers/http/health_check.rs (2)

30-30: Good choice using once_cell as replacement for lazy_static

The import of once_cell::sync::Lazy is an appropriate replacement for the lazy_static dependency. The once_cell crate is now part of the Rust standard library (as std::sync::OnceLock and std::sync::LazyLock since Rust 1.70), making this a more future-proof approach for lazy initialization.


37-37: Improved implementation with proper encapsulation

The refactoring from lazy_static! macro to once_cell::sync::Lazy is well-implemented. Additionally, changing the visibility from public (pub static ref) to private (static) is a good practice since SIGNAL_RECEIVED is only used within this module and doesn't need to be exposed externally.

This change maintains the same functionality while using a more modern Rust pattern, resulting in cleaner code.

✨ Finishing Touches
  • 📝 Generate Docstrings

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

@nitisht nitisht merged commit e732821 into parseablehq:main Feb 28, 2025
14 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