Skip to content

visibility updates #1325

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
May 26, 2025
Merged

visibility updates #1325

merged 2 commits into from
May 26, 2025

Conversation

parmesant
Copy link
Contributor

@parmesant parmesant commented May 25, 2025

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

  • Refactor
    • Updated visibility of certain data structures to improve accessibility for other components. No changes to app behavior or user interface.

Copy link
Contributor

coderabbitai bot commented May 25, 2025

Walkthrough

The visibility of several structs and struct fields was updated from private to public in two modules. Specifically, the Field struct in the LLM handler and the DatedStats, DataSet, and selected fields in the HomeResponse struct in the home module are now publicly accessible. No other logic or behavior was altered.

Changes

File(s) Change Summary
src/handlers/http/llm.rs Changed Field struct visibility from private to public.
src/prism/home/mod.rs Made DatedStats and DataSet structs public; made alerts_info, stats_details, and datasets fields of HomeResponse public.

Suggested reviewers

  • nikhilsinhaparseable

Poem

In the warren of code, some structs hid away,
But now they hop freely, out in the day.
Fields and stats wave their ears in the sun,
Public at last, their journey begun!
With a twitch of my nose, I cheer for this feat—
More open, more sharing, and oh-so neat! 🐇

✨ 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: 1

🧹 Nitpick comments (1)
src/prism/home/mod.rs (1)

64-68: Consider encapsulation implications of making fields public.

While making these HomeResponse fields public enables external access to response data, it breaks encapsulation by allowing direct field modification. Consider whether accessor methods might be more appropriate for maintaining data integrity.

If direct field access is intentional for serialization/deserialization purposes, this change is acceptable. However, if data integrity is a concern, consider implementing getter methods instead:

 #[derive(Debug, Serialize)]
 pub struct HomeResponse {
-    pub alerts_info: AlertsInfo,
-    pub stats_details: Vec<DatedStats>,
-    pub datasets: Vec<DataSet>,
+    alerts_info: AlertsInfo,
+    stats_details: Vec<DatedStats>,
+    datasets: Vec<DataSet>,
 }
+
+impl HomeResponse {
+    pub fn alerts_info(&self) -> &AlertsInfo {
+        &self.alerts_info
+    }
+    
+    pub fn stats_details(&self) -> &[DatedStats] {
+        &self.stats_details
+    }
+    
+    pub fn datasets(&self) -> &[DataSet] {
+        &self.datasets
+    }
+}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8ebd117 and acef657.

📒 Files selected for processing (2)
  • src/handlers/http/llm.rs (1 hunks)
  • src/prism/home/mod.rs (2 hunks)
⏰ 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: Build Default x86_64-unknown-linux-gnu
  • GitHub Check: Quest Smoke and Load Tests for Distributed deployments
  • GitHub Check: coverage
  • GitHub Check: Build Kafka x86_64-unknown-linux-gnu
  • GitHub Check: Quest Smoke and Load Tests for Standalone deployments
🔇 Additional comments (2)
src/prism/home/mod.rs (2)

43-48: LGTM: DatedStats visibility change is appropriate.

Making DatedStats public is reasonable as it contains statistical data that external consumers may need to access. The fields represent standard metrics data without sensitive information.


58-61: LGTM: DataSet visibility change enables external integration.

The DataSet struct contains dataset metadata that's appropriate for public API exposure, enabling external systems to work with dataset information.

@nitisht nitisht merged commit 18fcb40 into parseablehq:main May 26, 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