Skip to content

Conversation

leynos
Copy link
Owner

@leynos leynos commented Jun 13, 2025

Summary

  • rewrite server and middleware modules to compile cleanly
  • fix SharedState docs and tests
  • add initial DDlog schema for physics engine positions and blocks

Testing

  • cargo fmt --all -- --check
  • cargo clippy -- -D warnings
  • cargo test

https://chatgpt.com/codex/tasks/task_e_684c36bd8b7c8322a1b645fb14bb6211

Summary by Sourcery

Rewrite server and middleware modules to compile cleanly, fix SharedState docs and tests, and introduce a basic DDlog schema for physics engine.

New Features:

  • Add initial DDlog schema for physics engine positions and blocks

Bug Fixes:

  • Fix compilation errors in server and middleware modules
  • Correct SharedState documentation examples

Enhancements:

  • Refactor server API and streamline documentation comments
  • Simplify middleware Next and Service trait implementations

Tests:

  • Restore and update SharedState byte payload tests

Summary by CodeRabbit

  • New Features

    • Introduced an experimental physics engine module with support for spatial positions, block types, blocks, slopes, and a derived output listing occupied positions.
  • Documentation

    • Condensed and simplified documentation across middleware and server components, removing extensive examples and redundant comments.
  • Style

    • Relocated inline tests for improved code organisation without altering test content.

Copy link
Contributor

sourcery-ai bot commented Jun 13, 2025

Reviewer's Guide

This PR refactors the server and middleware modules for cleaner builds by streamlining documentation, applying #[must_use] attributes, and simplifying control flow; corrects SharedState docs and consolidates tests under a test module; and introduces a new DDlog schema for physics engine positions and blocks.

File-Level Changes

Change Details Files
Refactor WireframeServer implementation and docs
  • Removed verbose and duplicated doc comments from new, workers, bind, and run methods
  • Added #[must_use] to builder methods and made listener an Option to enforce bind before run
  • Simplified run logic: removed commented placeholders, streamlined shutdown handling
src/server.rs
Clean up middleware module definitions
  • Stripped out redundant docs for ServiceRequest and ServiceResponse
  • Consolidated Next struct and its call method with focused doc comments
  • Removed outdated examples and extraneous trait doc blocks
src/middleware.rs
Fix SharedState docs and relocate tests
  • Updated doc examples to import SharedState from the correct path
  • Removed inline test block and reintroduced tests under #[cfg(test)] mod tests
src/extractor.rs
Add initial DDlog schema for physics engine
  • Created physics.dl with basic definitions for points, blocks, positions, and their relationships
physics/physics.dl

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

Warning

Rate limit exceeded

@leynos has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 4 minutes and 32 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4d14e64 and 67de183.

📒 Files selected for processing (3)
  • physics/physics.dl (1 hunks)
  • src/extractor.rs (3 hunks)
  • src/middleware.rs (1 hunks)

Walkthrough

A new DDlog module for an experimental physics engine was introduced, defining data types and relations for positions, blocks, and slopes, along with logic for occupied positions. In Rust source files, documentation and example comments were removed or condensed, and test modules were reorganised without altering any code logic or public APIs.

Changes

File(s) Change Summary
physics/physics.dl Added DDlog module for physics: defined Position, BlockType, Block, Slope; input/output relations and rules for occupancy.
src/extractor.rs Moved inline test module to file bottom; added explicit import lines in doc examples; no logic changes.
src/middleware.rs Removed all doc comments and examples; retained only essential code and minimal inline comments.
src/server.rs Condensed documentation comments; removed examples and redundant explanations; no code or API changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DDlogEngine

    User->>DDlogEngine: Provide Blocks and Slopes input
    DDlogEngine->>DDlogEngine: Apply Occupied rules
    DDlogEngine-->>User: Output Occupied positions
Loading

Poem

A hop, a skip, a physics leap,
With blocks and slopes, the rules run deep.
Docs trimmed down, the code is neat,
Tests moved aside—organisation’s treat!
In this meadow of logic, let’s cheer and clap,
For every change, a rabbit’s happy tap!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @leynos - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos
Copy link
Owner Author

leynos commented Jun 13, 2025

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai bot added a commit that referenced this pull request Jun 13, 2025
…and-slopes`

Docstrings generation was requested by @leynos.

* #17 (comment)

The following files were modified:

* `src/extractor.rs`
* `src/middleware.rs`
* `src/server.rs`
Copy link
Contributor

coderabbitai bot commented Jun 13, 2025

Note

Generated docstrings for this pull request at #18

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 (3)
physics/physics.dl (1)

36-38: Avoid generating superfluous duplicates in Occupied

Occupied is derived three times and DDlog’s set semantics deduplicate identical facts, so this is not wrong.
If you ever add aggregation on Occupied, however, emitting three copies of the same position will inflate counts.
A single rule that unions the three sources is marginally clearer:

-output relation Occupied(p: Position)

-Occupied(p) :- Blocks(Block{pos=p, ..}).
-Occupied(p) :- Slopes(Slope{from=p, ..}).
-Occupied(p) :- Slopes(Slope{to=p, ..}).
+output relation Occupied(p: Position)

+Occupied(p) :-
+    Blocks(Block{pos=p, ..});
+    Slopes(Slope{from=p, ..});
+    Slopes(Slope{to=p, ..}).
src/extractor.rs (1)

59-82: Consolidate duplicated docs and move #[must_use]

There are two independent doc blocks for new, and the attribute sits in the middle of them. Collapse them to one coherent comment to avoid rustdoc noise and keep the attribute adjacent to the function sig.

-    /// Construct a new [`SharedState`].
-    ///
-    /// # Examples
-    /// ...
-    /// ```
-    #[must_use]
-    /// Creates a new `SharedState` instance wrapping the provided `Arc<T>`.
-    ///
-    /// # Examples
+    /// Construct a new [`SharedState`].
+    ///
+    /// # Examples
     ///
     /// ```
     /// use std::sync::Arc;
     /// use wireframe::extractor::SharedState;
@@
-    pub fn new(inner: Arc<T>) -> Self {
+    #[must_use]
+    pub fn new(inner: Arc<T>) -> Self {
src/middleware.rs (1)

9-26: Consider allowing mutable services in Next::call

Next::call takes &self, which means middleware that needs interior mutability must rely on Mutex/Cell.
Accepting &mut self would give middleware authors the option of simple mutable state while still working for &self services thanks to auto-reborrowing:

-    pub async fn call(&self, req: ServiceRequest) -> Result<ServiceResponse, S::Error> {
+    pub async fn call(&mut self, req: ServiceRequest) -> Result<ServiceResponse, S::Error> {

This is optional, but switching later is a breaking change.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6b6f8c2 and 4d14e64.

📒 Files selected for processing (4)
  • physics/physics.dl (1 hunks)
  • src/extractor.rs (3 hunks)
  • src/middleware.rs (1 hunks)
  • src/server.rs (3 hunks)
🔇 Additional comments (3)
physics/physics.dl (1)

24-28: Clarify gradient semantics for future‐proofing

gradient is stored as a plain i32, but the comment does not explain the unit or expected range (e.g. rise-over-run, milli-percent, signed angle). Down-stream rules and client code will need a stable contract. Consider adding a short comment or a type alias such as type Gradient = i32 so the intent can evolve without breaking the schema.

src/extractor.rs (1)

109-129: Tests look good and are now in an isolated module

Relocating the payload tests under a dedicated #[cfg(test)] keeps the impl clean while maintaining coverage. The assertions cover both boundary cases; no further action needed.

src/server.rs (1)

29-37: Constructor initialisation LGTM

Initialising listener to None explicitly removes any ambiguity and makes the invariant in run clearer. No issues spotted.

@leynos
Copy link
Owner Author

leynos commented Jun 13, 2025

Wrong repository 😱

@leynos leynos closed this Jun 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant