add methods to entity context

[withinboredom]

Summary by CodeRabbit

• New Features

  • Added a method to signal an entity using a callable, enabling more flexible signaling.
  • Introduced the ability to retrieve a snapshot of an entity's current state.

• Documentation

  • Improved PHPDoc comments and type annotations for better clarity and type safety.

• Style

  • Made minor formatting and style improvements for consistency and readability.

[coderabbitai]

Walkthrough

The changes introduce two new methods, signal and getSnapshot, to both the EntityContext class and its interface, enabling higher-level signaling and state snapshot retrieval for entities. Additional code style and PHPDoc improvements are made elsewhere, and generic type annotations are refined for entity identifiers.

Changes

Cohort / File(s)	Change Summary
Entity Context Enhancements src/EntityContext.php, src/EntityContextInterface.php	Added signal and getSnapshot methods to both the class and its interface, enabling dynamic signaling via callable proxies and retrieval of entity state snapshots. Refactored method placements and signatures for clarity and consistency.
Proxy Generator Formatting & Docs src/Proxy/Generator.php	Improved PHPDoc documentation, updated type hints, and applied minor formatting and whitespace adjustments. No logic or control flow changes.
EntityId Template Refinement src/State/EntityId.php	Refined generic type annotations, constraining template T to EntityState and documenting the $name property as a class-string of T. No logic changes.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant EntityContext
    participant SpyProxy
    participant EventDispatcher
    participant Entity

    Caller->>EntityContext: signal(EntityId, callable)
    EntityContext->>SpyProxy: Create proxy for EntityId
    Caller->>SpyProxy: Invoke callable on proxy
    SpyProxy-->>EntityContext: Throws SpyException (captures operation & args)
    EntityContext->>EntityContext: signalEntity(EntityId, operation, args)
    EntityContext->>EventDispatcher: Dispatch signal to Entity
    EventDispatcher->>Entity: Handle signal

Loading

sequenceDiagram
    participant Caller
    participant EntityContext
    participant EventDispatcher
    participant Entity

    Caller->>EntityContext: getSnapshot(EntityId)
    EntityContext->>EventDispatcher: Query state for EntityId
    EventDispatcher-->>EntityContext: Return EntityState
    EntityContext-->>Caller: Return EntityState

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

A signal sent, a snapshot caught,
New methods in our code are wrought.
Proxies spy and states reveal,
Entity secrets they unseal.
With tidy docs and types refined,
This bunny hops with peace of mind!
🐇✨

---

📜 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 c3b3e7d and a69a718.

📒 Files selected for processing (4)

• src/EntityContext.php (3 hunks)
• src/EntityContextInterface.php (2 hunks)
• src/Proxy/Generator.php (5 hunks)
• src/State/EntityId.php (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: build-docker
• GitHub Check: Unit Tests - PHP

🔇 Additional comments (13)

src/State/EntityId.php (2)

31-31: Excellent type safety improvement!

The bounded template constraint T of EntityState ensures that EntityId can only be parameterized with EntityState subtypes, providing better type safety and aligning with the new methods in EntityContext.

---

35-37: Good PHPDoc enhancement for better tooling support.

The class-string<T> annotation provides better IDE support and static analysis for the $name property, making it clear this should be a class name string of the generic type.

src/EntityContextInterface.php (3)

29-29: LGTM - Required import for new interface methods.

The EntityState import is needed for the return type of the new getSnapshot method.

---

106-114: Well-designed higher-level signaling abstraction.

The signal method provides a clean abstraction over signalEntity by accepting a callable that operates on the entity state. The generic constraint ensures type safety.

---

116-124: Clean state snapshot retrieval interface.

The getSnapshot method provides a straightforward way to retrieve entity state snapshots with proper generic typing.

src/Proxy/Generator.php (3)

37-37: Good use of nullable shorthand syntax.

The ?string syntax is cleaner and more readable than the union type alternative.

---

39-43: Helpful PHPDoc addition.

The documentation clarifies the method's purpose and potential exceptions, improving maintainability.

---

53-54: Code formatting improvements enhance readability.

The added blank lines and spacing improve code structure and readability without changing functionality.

Also applies to: 61-61, 115-116, 125-125, 150-151

src/EntityContext.php (5)

44-44: Required imports for new functionality.

The SpyException and EntityState imports are needed for the new signaling and snapshot methods.

Also applies to: 48-48

---

143-146: Method repositioning for better code organization.

Moving the addFrom helper method earlier in the class improves code organization and readability.

---

288-304: Clean entity signaling implementation.

The signalEntity method properly constructs the event chain with delay support and fires it through the event dispatcher.

---

306-312: State snapshot retrieval implementation looks correct.

The getSnapshot method properly retrieves state from the event dispatcher and asserts the expected type before returning the entity state.

---

271-286: No changes required: the signal method’s invocation and exception flow are correct

The current code intentionally calls the proxy with the signal closure ($proxy($signal)) so that the proxy’s __invoke method can execute the closure—passing itself in—to capture the operation name and arguments. The thrown SpyException is the expected control-flow signal (not an error), caught to then invoke signalEntity. You can safely ignore the proposed inversion ($signal($proxy)) and the remark about the exception handling.

Likely an incorrect or invalid review comment.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch add/entity-methods

---

🪧 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 generate unit tests to generate unit tests 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.

[github-actions]

Performance Metrics

test	time (s)	memory usage
perf	16.20	102
Fan out/in	60.06	8