Don't throw errors

[dalyathan]

Description

The changes in this PR implement and close #509

Breaking changes

Does this PR include any breaking changes we should be aware of? NO

Screenshots

You can add screenshots here if applicable.

Checklist

📌 Always:

• I have set a clear title
• My PR is small and contains a single feature
• I have checked my own PR

👍 Most of the time:

• I have added or updated test cases for important functionality
• I have updated the README if needed

📦 For publishable packages:

• I have increased the version number in package.json
• I have added my changes to the CHANGELOG.md See this example

[coderabbitai]

Walkthrough

The update to version 1.2.5 of the Vendure plugin for Shipmate introduces enhanced error handling for the /shipmate endpoint. The event method in the ShipmateController now utilizes a try-catch block to manage errors during order state updates, replacing the previous implementation that could lead to unhandled promise rejections. Additionally, detailed error logging has been incorporated to aid in debugging.

Changes

Files	Change Summary
packages/vendure-plugin-shipmate/CHANGELOG.md	Updated changelog for version 1.2.5, highlighting the removal of error-throwing behavior from the /shipmate endpoint and a focus on error handling.
packages/vendure-plugin-shipmate/src/api/shipmate.controller.ts	Added try-catch block to the event method for error handling during order state updates, with detailed error logging implemented using the Logger utility.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1171958 and d08d9f9.

Files ignored due to path filters (3)

• package.json is excluded by !**/*.json
• packages/vendure-plugin-shipmate/package.json is excluded by !**/*.json
• yarn.lock is excluded by !**/yarn.lock, !**/*.lock, !**/*.lock

Files selected for processing (1)

• packages/vendure-plugin-shipmate/CHANGELOG.md (1 hunks)

Additional comments not posted (1)

packages/vendure-plugin-shipmate/CHANGELOG.md (1)

3-3: The past review comment by @coderabbitai[bot] is still valid. Please apply the suggested diff to fix the typo in the word "errors".

---

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>, please review it.
  -- 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 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 44453d8 and 1171958.

Files ignored due to path filters (3)

• package.json is excluded by !**/*.json
• packages/vendure-plugin-shipmate/package.json is excluded by !**/*.json
• yarn.lock is excluded by !**/yarn.lock, !**/*.lock, !**/*.lock

Files selected for processing (2)

• packages/vendure-plugin-shipmate/CHANGELOG.md (1 hunks)
• packages/vendure-plugin-shipmate/src/api/shipmate.controller.ts (1 hunks)

Additional comments not posted (2)

packages/vendure-plugin-shipmate/src/api/shipmate.controller.ts (2)

4-5: LGTM!

The new imports are appropriate for the added error handling logic.

---

12-20: LGTM!

The try-catch block is correctly implemented to handle errors and log them appropriately.

[martijnvdbrug]

Nice, catch-unknown, finally (pun intended)! But, can you move this to normal dependencies instead of dev-seps?

[martijnvdbrug]

Yes, nice! Finally no more disable tslint any's. Small change requested though

[martijnvdbrug]

Also, there seems to be a merge conflict regarding the changelog

[martijnvdbrug]

Perfecto!