fix(server): rest handler not returning correct id when model with compound id is read as a relation

[ymc9]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces significant changes to the RequestHandler class in the packages/server/src/api/rest/index.ts file, focusing on enhancing the serialization process for entities with compound IDs. A new method, injectCompoundId, is added to create synthetic ID fields, while the serializeItems method's signature is refined. Additionally, a new test case is added to the packages/server/tests/api/rest.test.ts file to verify the functionality of retrieving posts with their associated likes, ensuring proper API response structure and status.

Changes

File Path	Change Summary
packages/server/src/api/rest/index.ts	- Added method: private injectCompoundId(model: string, items: unknown)
	- Updated method signature: private serializeItems(model: string, items: unknown, options?: Partial<SerializerOptions>) to private serializeItems(model: string, items: unknown, options?: Partial<SerializerOptions>)
packages/server/tests/api/rest.test.ts	- Added test case: it('get as relationship', async () => {...}) to verify GET request for /post/1 with likes included.
	- Minor adjustments to existing test cases for enhanced coverage of relationships between posts and likes.

Possibly related PRs

• RESTApiHandler support compound ids (@@id) #1754: This PR modifies the RequestHandler class in the same file as the main PR and enhances the handling of composite IDs, which is directly related to the changes made in the injectCompoundId and serializeItems methods in the main PR.
• OpenApi @@id support #1757: This PR introduces a new PostLike model and updates the User and post_Item models to include relationships with PostLike, which aligns with the main PR's focus on enhancing serialization for entities with compound IDs, as it also involves handling relationships in the API.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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 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 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 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 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

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

1376-1409: LGTM! Consider adding more assertions.

The new test case "get as relationship" effectively verifies the API's handling of compound IDs when retrieving related data. It correctly sets up the test data, makes the appropriate request, and asserts the response structure.

Consider adding more specific assertions to verify the exact values of the included data, such as:

expect(r.body.included[0].attributes).toEqual({
  postId: 1,
  userId: 'user2',
  superLike: false,
});

This would provide a more thorough check of the response content.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c0ab830 and 8b2b0b9.

📒 Files selected for processing (2)

• packages/server/src/api/rest/index.ts (3 hunks)
• packages/server/tests/api/rest.test.ts (1 hunks)

🧰 Additional context used

🔇 Additional comments (2)

packages/server/src/api/rest/index.ts (2)

8-8: Approved the addition of necessary imports

The addition of clone, enumerate, getIdFields, and isPrismaClientKnownRequestError to the imports is appropriate and necessary for the implemented functionality.

---

1124-1125: Consider the performance impact of cloning large datasets

Cloning the items object before injecting compound IDs ensures immutability, which is good practice. However, if items can be large, cloning could introduce significant performance overhead. Please verify that this change does not adversely affect performance with large datasets.