chore(api): more test cases for mapped model names

[ymc9]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The test suite for the REST API was updated by removing the "post" model from the model name mapping configuration and enhancing tests related to the "user" and "post" models. New tests were introduced to validate creation and retrieval using the mapped model name "myUser," and the relationship between "post" and "user" was also tested.

Changes

File(s)	Change Summary
packages/server/tests/api/rest.test.ts	Removed "post" from model name mapping, added/updated tests for "user" (with mapped name "myUser") and "post" creation, retrieval, and relationships.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite
    participant RESTServer

    TestSuite->>RESTServer: POST /myUser (create user with id)
    RESTServer-->>TestSuite: 201 Created (user resource)

    TestSuite->>RESTServer: GET /myUser/{id}
    RESTServer-->>TestSuite: 200 OK (user resource)

    TestSuite->>RESTServer: POST /post (create post with user relationship)
    RESTServer-->>TestSuite: 201 Created (post resource with user relationship)

Loading

---

📜 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 f2c2725 and 6371ac9.

📒 Files selected for processing (1)

• packages/server/tests/api/rest.test.ts (2 hunks)

🧰 Additional context used

🧠 Learnings (2)

📓 Common learnings

Learnt from: ymc9
PR: zenstackhq/zenstack#2187
File: packages/server/src/api/rest/index.ts:287-289
Timestamp: 2025-07-16T03:09:04.699Z
Learning: In REST API URL pattern matching with model name mapping, only the `type` parameter (representing model names) should be mapped using `modelNameMapping`. The `relationship` parameter represents field names on models and should not be mapped, as field names are distinct from model names in the API structure.

packages/server/tests/api/rest.test.ts (1)

<retrieved_learning>
Learnt from: ymc9
PR: #2187
File: packages/server/src/api/rest/index.ts:287-289
Timestamp: 2025-07-16T03:09:04.699Z
Learning: In REST API URL pattern matching with model name mapping, only the type parameter (representing model names) should be mapped using modelNameMapping. The relationship parameter represents field names on models and should not be mapped, as field names are distinct from model names in the API structure.
</retrieved_learning>

🔇 Additional comments (4)

packages/server/tests/api/rest.test.ts (4)

3055-3055: LGTM: Improved test data consistency.

Adding the explicit id attribute ensures consistent test data that matches the subsequent test cases referencing user with id '1'.

---

3068-3076: LGTM: Essential test coverage for mapped model name creation.

This test case properly validates that POST operations work with the mapped model name "myUser" and verifies the response includes the correct mapped URL in the self link.

---

3078-3090: LGTM: Comprehensive GET operation coverage for mapped model names.

This test case ensures that retrieval operations work correctly with the mapped model name and maintains consistent URL patterns in the response links.

---

3092-3111: LGTM: Critical test for mixed mapped/unmapped model interactions.

This test case validates essential functionality:

• Unmapped model names continue to work correctly
• Relationships between mapped and unmapped models function properly
• The relationship correctly uses the original model type name ('user'), not the mapped name, which aligns with the retrieved learning about field names vs. model names

This provides comprehensive coverage for the model name mapping feature.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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