fix(dojo-lang): ensure compiler tests have unique id to not avoid output conflicts

[glihm]

Add a unique id for each compiler test to ensure reproducibility and avoid output conflicts.

Summary by CodeRabbit

• New Features

  • Enhanced error diagnostics with clearer paths for the introspect, model, print, and system modules.
  • Added unique test identifiers to improve organization and clarity in test results.

• Bug Fixes

  • Updated error messages to ensure they reflect the correct file locations, improving debugging accuracy across multiple modules.
  • Strengthened enforcement of function signature rules within the system module to ensure compliance with interface guidelines.

[coderabbitai]

Walkthrough

Ohayo, sensei! The recent changes enhance the error diagnostics and organization of the dojo-lang codebase. Key modifications include dynamic temporary directory paths in tests based on test IDs, improved clarity in error messages, and stricter adherence to type usage and function signatures. These updates aim to facilitate better debugging, prevent conflicts during concurrent tests, and ensure compliance with coding standards.

Changes

Files	Change Summary
crates/dojo-lang/src/plugin_test.rs, crates/dojo-lang/src/plugin_test_data/*	Updated diagnostics for error handling, added test_id for better categorization, and modified paths for clarity in error reporting.
crates/dojo-lang/src/plugin_test_data/introspect, model, print, system	Enhanced error messages with specific file paths, enforced stricter rules for attribute usage, and clarified requirements for function signatures.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant Plugin
    participant ErrorLogger

    TestRunner->>Plugin: Start test
    Plugin->>Plugin: Create dynamic tmp_dir with test_id
    Plugin->>ErrorLogger: Log error with specific path
    ErrorLogger-->>TestRunner: Provide detailed error info

Loading

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8ec82d4 and aa0f1cb.

Files selected for processing (5)

• crates/dojo-lang/src/plugin_test.rs (1 hunks)
• crates/dojo-lang/src/plugin_test_data/introspect (2 hunks)
• crates/dojo-lang/src/plugin_test_data/model (2 hunks)
• crates/dojo-lang/src/plugin_test_data/print (2 hunks)
• crates/dojo-lang/src/plugin_test_data/system (2 hunks)

Files skipped from review due to trivial changes (1)

• crates/dojo-lang/src/plugin_test_data/model

Additional comments not posted (7)

crates/dojo-lang/src/plugin_test_data/print (2)

6-7: Ohayo, sensei! Test identifier added correctly.

The test identifier print is correctly added and follows the expected format.

---

119-134: Ohayo, sensei! Error diagnostic paths updated correctly.

The paths in error diagnostics are correctly updated to include the test identifier print.

crates/dojo-lang/src/plugin_test.rs (1)

99-104: Ohayo, sensei! Dynamic path construction looks good.

The test_id is correctly extracted from the inputs and incorporated into the tmp_dir path, ensuring unique temporary directories for each test case.

crates/dojo-lang/src/plugin_test_data/introspect (2)

6-7: Ohayo, sensei! Test identifier added correctly.

The test identifier introspect is correctly added and follows the expected format.

---

2907-2942: Ohayo, sensei! Error diagnostic paths updated correctly.

The paths in error diagnostics are correctly updated to include the test identifier introspect.

crates/dojo-lang/src/plugin_test_data/system (2)

362-467: Ensure compliance with starknet::interface standards.

The diagnostics highlight critical issues:

• Functions must only support specific constructs.
• The world parameter must be the first parameter.
• self and world cannot be used together.
• Only the first parameter can be a reference.
• world must be a snapshot if ref is not used.
• The first parameter must be a reference to the trait's generic parameter or a snapshot of it.
• ref parameters are not supported beyond the first one.
• Generated traits must match the implementation's generic parameters.

These rules are essential for maintaining the integrity and expected behavior of the starknet::interface.

Ensure that all tests reflect these diagnostics accurately and that the code adheres to these standards.

---

6-8: Fix the namespace format in the cairo_code.

The namespace format My@Namespace is invalid. Consider using a valid identifier format.

- #[dojo::contract(namespace: "My@Namespace")]
+ #[dojo::contract(namespace: "MyNamespace")]

Likely invalid or redundant comment.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.07%. Comparing base (c87358e) to head (aa0f1cb).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2206      +/-   ##
==========================================
+ Coverage   68.17%   69.07%   +0.89%     
==========================================
  Files         339      339              
  Lines       44066    44052      -14     
==========================================
+ Hits        30044    30429     +385     
+ Misses      14022    13623     -399     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.