Improving Error UX: Informative Messages and Recommendations for Migrations and Events

[MozirDmitriy]

Why is this change needed?

packages/shuttle/src/example-app/db.ts
Migration error messages now include the path to the migration file, possible causes of the failure (syntax, schema incompatibility, dependencies) and recommendations for fixing it.

packages/shuttle/src/example-app/app.ts
Error messages for insert events, get max fid and database migration now include detailed context (e.g. event parameters, host, schema) as well as recommendations for next steps to fix the problem.

This will improve debugging usability and speed up problem resolution during operation and development.

Merge Checklist

Choose all relevant options below by adding an x now or at any time before submitting for review

• PR title adheres to the conventional commits standard
• PR has a changeset
• PR has been tagged with a change label(s) (i.e. documentation, feature, bugfix, or chore)
• PR includes documentation if necessary.

---

PR-Codex overview

This PR enhances error logging in the db.ts and app.ts files, providing more detailed messages for migration failures and database issues. It aims to improve debugging by including specific information related to the errors encountered.

Detailed summary

• In db.ts, improved error messages for migration execution failures, including suggestions for troubleshooting.
• Enhanced logging for database migration application failures with additional context.
• In app.ts, refined error handling for on-chain event insertion, adding detailed context about the error and event data.
• Updated logging for retrieving max FID errors, providing more information about hub connectivity and request details.
• Added context to migration failure logs, emphasizing the need to check migration files and schema compatibility.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

[changeset-bot]

⚠️ No Changeset found

Latest commit: e387d48

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR