Include relationships in REST result from creates and updates

[thomassnielsen]

Here are two test cases: For GET requests, we do get the expected empty data array in the relationship response. However, in the response of a PUT request, the data array is missing and the test fails before the included change.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces changes to the RequestHandler class in the packages/server/src/api/rest/index.ts file, enhancing the handling of relationship IDs during resource creation and updates. It adds calls to the includeRelationshipIds method in the processCreate and processUpdate methods to ensure that related entity IDs are included in the payload. Additionally, the packages/server/tests/api/rest.test.ts file is updated with new test cases and enhancements for CRUD operations, response structures, and error handling, ensuring comprehensive coverage of the API's functionality.

Changes

File	Change Summary
packages/server/src/api/rest/index.ts	- Enhanced RequestHandler class to include relationship IDs in processCreate and processUpdate methods.
packages/server/tests/api/rest.test.ts	- Added new test cases for empty related resources and updated response structures for user creation and updates. - Enhanced error handling tests for 404 responses. - Expanded tests for compound ID handling across CRUD operations.

Possibly related PRs

• RESTApiHandler support compound ids (@@id) #1754: Enhances the RequestHandler class in the same file, focusing on handling composite IDs, relevant to relationship ID modifications.
• fix(server): rest handler not returning correct id when model with compound id is read as a relation #1784: Addresses serialization for entities with compound IDs, directly related to the main PR's focus on relationship IDs.
• Configurable REST API id divider #1785: Introduces a configurable ID divider in the RequestHandler, affecting how relationship IDs are represented in API endpoints.

Suggested reviewers

• ymc9

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e9e0690 and c6cc84f.

📒 Files selected for processing (2)

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

🧰 Additional context used

🔇 Additional comments (6)

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

802-804: LGTM: Inclusion of relationship IDs in create payload

This change ensures that the IDs of related entities are included in the create payload, which aligns with the PR objective of including relationships in the API response. This modification will improve the consistency and completeness of the API's output.

---

976-978: LGTM: Consistent inclusion of relationship IDs in update payload

This change ensures that the IDs of related entities are included in the update payload, which is consistent with the earlier modification in the processCreate method. This addition aligns with the PR objective and maintains consistency in how relationships are handled across different operations.

---

802-804: Summary: Consistent implementation of relationship ID inclusion

The changes in both processCreate and processUpdate methods consistently implement the inclusion of relationship IDs in the respective payloads. This enhancement aligns well with the PR objective of including relationships in the results from update operations. The implementation is clean, consistent, and should improve the API's functionality in handling relationships.

Also applies to: 976-978

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

308-341: Test Correctly Verifies Empty Relationships in GET Response

The added test case ensures that when a user with no related posts is retrieved, the API returns an empty data array within the posts relationship. This aligns with the JSON:API specification and confirms consistent response structures for clients consuming the API.

---

1464-1478: User Creation Response Includes Empty Relationships

The response after creating a user now appropriately includes the posts relationship with an empty data array. This enhancement ensures that clients receive consistent relationship structures, even when no related resources are present.

---

1836-1883: PUT Response Consistently Reflects Empty Relationships

The updated test verifies that when a user is updated without any associated posts, the API response includes the posts relationship with an empty data array. This maintains consistency across CRUD operations and ensures that clients can reliably parse relationship data regardless of content.

---

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.

[ymc9]

Good catch! Merging and will make a release today. Thanks!