merge dev to main (v2.7.3)

[ymc9]

No description provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request include the addition of a new framework adapter for Hono in the README.md, enhancing documentation for ZenStack's compatibility with various frameworks. The version of the JetBrains plugin is updated from 2.7.2 to 2.7.3 in build.gradle.kts, along with configuration adjustments. Additionally, the RequestHandler class in index.ts is modified to include relationship IDs in API responses for resource creation and updates. Finally, new tests are added in rest.test.ts to verify the correct handling of empty relationships in API responses.

Changes

File	Change Summary
README.md	Added Hono framework adapter to the "Framework adapters" section; minor formatting adjustments made.
packages/ide/jetbrains/build.gradle.kts	Updated version from 2.7.2 to 2.7.3; configured IntelliJ plugin settings and tasks for compilation.
packages/server/src/api/rest/index.ts	Enhanced RequestHandler to include relationship IDs in responses for resource creation and updates.
packages/server/tests/api/rest.test.ts	Added tests to verify that empty relationships are correctly represented in API responses for users.

Possibly related PRs

• feat(server): implementing hono adapter #1739: This PR implements a Hono adapter, which is directly related to the main PR's addition of the Hono framework adapter in the README.md.
• chore: add Hono adapter to README #1795: This PR also adds the Hono adapter to the README.md, reinforcing the changes made in the main PR regarding documentation updates for the Hono framework.
• fix(server): rest handler not returning correct id when model with compound id is read as a relation #1784: This PR enhances the RequestHandler class in the same file as the main PR, focusing on handling compound IDs, which may relate to the overall improvements in API response handling mentioned in the main PR.
• Include relationships in REST result from creates and updates #1798: This PR modifies the RequestHandler to include relationship IDs in the results from updates, which aligns with the main PR's focus on enhancing API response structures.

---

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between dbe6bb9 and 74dd0f7.

⛔ Files ignored due to path filters (14)

• .github/workflows/github-releases-to-discord.yml is excluded by !**/*.yml
• package.json is excluded by !**/*.json
• packages/ide/jetbrains/package.json is excluded by !**/*.json
• packages/language/package.json is excluded by !**/*.json
• packages/misc/redwood/package.json is excluded by !**/*.json
• packages/plugins/openapi/package.json is excluded by !**/*.json
• packages/plugins/swr/package.json is excluded by !**/*.json
• packages/plugins/tanstack-query/package.json is excluded by !**/*.json
• packages/plugins/trpc/package.json is excluded by !**/*.json
• packages/runtime/package.json is excluded by !**/*.json
• packages/schema/package.json is excluded by !**/*.json
• packages/sdk/package.json is excluded by !**/*.json
• packages/server/package.json is excluded by !**/*.json
• packages/testtools/package.json is excluded by !**/*.json

📒 Files selected for processing (4)

• README.md (1 hunks)
• packages/ide/jetbrains/build.gradle.kts (1 hunks)
• 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/ide/jetbrains/build.gradle.kts (1)

12-12: LGTM: Version bump aligns with PR objectives.

The version increment from 2.7.2 to 2.7.3 is consistent with the PR title for merging dev to main.

README.md (1)

175-175: LGTM! The Hono framework adapter addition looks good.

The new framework adapter entry follows the established format and links to the correct documentation path.

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

802-804: LGTM! Relationship IDs are now included in create response.

The change ensures that relationship IDs are properly included in the API response when creating a resource, which aligns with JSON:API specification requirements.

---

976-978: LGTM! Relationship IDs are now included in update response.

The change maintains consistency with the create operation by ensuring relationship IDs are included in the API response when updating a resource.

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

308-340: LGTM! Well-structured test for empty relationships.

The test case properly verifies that the API follows JSON:API specification by including empty relationships in the response, which is crucial for maintaining consistent response structure regardless of the relationship state.

---

1836-1882: LGTM! Good consistency check for PUT endpoint.

This test complements the GET endpoint test by ensuring consistent handling of empty relationships across different HTTP methods, which is important for maintaining API behavior predictability.