fix: ensure database migration errors are returned

[tolgaOzen]

Summary by CodeRabbit

• New Features
  • Updated API documentation version to v1.0.3, indicating potential enhancements or bug fixes.
• Bug Fixes
  • Improved error handling in the database migration process to ensure errors are properly communicated.
• Documentation
  • Incremented version number in the OpenAPI specification and related API documentation files to v1.0.3.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
permify	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 25, 2024 0:02am

[coderabbitai]

Walkthrough

The recent updates involve a minor version increment of the Permify API from "v1.0.2" to "v1.0.3" across multiple documentation files and constants. Additionally, the error handling logic in the serve function has been modified to return errors encountered during database migration. These changes reflect a new release with potential enhancements and improved error handling without altering the overall functionality.

Changes

Files	Change Summary
docs/api-reference/apidocs.swagger.json, docs/api-reference/openapiv2/apidocs.swagger.json, proto/base/v1/openapi.proto	Version updated from "v1.0.2" to "v1.0.3".
internal/info.go	Version constant updated from "v1.0.2" to "v1.0.3".
pkg/cmd/serve.go	Modified error handling to return migration errors.

Poem

In the garden of code, where the rabbits play,
A new version hops in, brightening the day.
With errors now caught, no more silent fright,
We'll dance through the changes, all fluffy and light! 🐇✨
Hooray for the updates, let’s cheer and rejoice,
For every small change, we’ll sing with a voice! 🎶

---

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:

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5624dc6 and c9fecaf.

Files ignored due to path filters (1)

• pkg/pb/base/v1/openapi.pb.go is excluded by !**/*.pb.go

Files selected for processing (5)

• docs/api-reference/apidocs.swagger.json (1 hunks)
• docs/api-reference/openapiv2/apidocs.swagger.json (1 hunks)
• internal/info.go (1 hunks)
• pkg/cmd/serve.go (1 hunks)
• proto/base/v1/openapi.proto (1 hunks)

Files skipped from review due to trivial changes (4)

• docs/api-reference/apidocs.swagger.json
• docs/api-reference/openapiv2/apidocs.swagger.json
• internal/info.go
• proto/base/v1/openapi.proto

Additional comments not posted (1)

pkg/cmd/serve.go (1)

268-268: Ensure proper error propagation in database migration.

The modification to return the error directly after logging it is a significant improvement. This change ensures that errors during the database migration are not just logged but also returned, allowing the calling function to handle them appropriately.

This aligns with the PR's objective to enhance error handling by making sure migration errors are properly propagated.