feat: [#495] Centralize Error Messages in Framework (PR#1) #663

kkumar-gcc · 2024-10-02T20:57:14Z

📑 Description

Example

ErrDriverNotSupported := errors.New("driver [%s] not supported", "session")

func Driver(driver string) (any, error) {
       // withLocation default is true
       return nil, ErrDriverNotSupported.Args(driver).WithLocation(true)
}

_, err := Driver("file")
print(err)
// [session] Driver [file] not supported

RelatedTo goravel/goravel#495

Summary by CodeRabbit

New Features
- Introduced a custom error handling mechanism that provides detailed error messages with optional location context.
- Added an interface for enhanced error management, allowing users to set arguments and control the inclusion of location in error messages.

These changes improve the clarity and context of error reporting within the application.

✅ Checks

Added test cases for my code

codecov · 2024-10-02T21:04:29Z

Codecov Report

Attention: Patch coverage is 52.94118% with 16 lines in your changes missing coverage. Please review.

Project coverage is 70.52%. Comparing base (2c6c7e7) to head (edb7827).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
errors/errors.go	48.00%	11 Missing and 2 partials ⚠️
session/service_provider.go	0.00%	2 Missing ⚠️
session/manager.go	80.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #663      +/-   ##
==========================================
- Coverage   70.57%   70.52%   -0.05%     
==========================================
  Files         186      187       +1     
  Lines       11877    11902      +25     
==========================================
+ Hits         8382     8394      +12     
- Misses       2924     2935      +11     
- Partials      571      573       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

…495

coderabbitai · 2024-10-02T21:25:38Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

🚀 Review Ready

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

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

hwbrzzl

How to use it? Add an example?

errors/errors.go

kkumar-gcc · 2024-10-03T06:54:59Z

Added an example

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.50.

Benchmark suite	Current: `11dd986`	Previous: `aeaf75d`	Ratio
`Benchmark_Panic`	`0.001077` ns/op 0 B/op 0 allocs/op	`0.0006658` ns/op 0 B/op 0 allocs/op	`1.62`
`Benchmark_Panic - ns/op`	`0.001077` ns/op	`0.0006658` ns/op	`1.62`

This comment was automatically generated by workflow using github-action-benchmark.

hwbrzzl · 2024-10-03T08:28:15Z

contracts/errors/errors.go

It seems unnecessary.

It's good to have, don't want to return errorString.

hwbrzzl · 2024-10-03T08:28:41Z

errors/errors.go

+	return formattedText
+}
+
+func (e *errorString) Location(location string) contractserrors.Error {


Location vs Module?

errors/errors.go

hwbrzzl · 2024-10-03T08:29:29Z

errors/errors.go

+func Is(err, target error) bool {
+	return errors.Is(err, target)
+}
+
+func As(err error, target any) bool {
+	return errors.As(err, &target)
+}
+
+func Unwrap(err error) error {
+	return errors.Unwrap(err)
+}


We can add them when needed.

Is is being used at some places

errors/errors_list.go

session/service_provider.go

hwbrzzl

Great 👍

implement errors for framework

198821f

kkumar-gcc requested a review from a team as a code owner October 2, 2024 20:57

chore: update mocks

3b16da6

kkumar-gcc closed this Oct 2, 2024

kkumar-gcc reopened this Oct 2, 2024

kkumar-gcc changed the title ~~feat: [#495] Centralize Error Messages in Framework~~ feat: [#495] Centralize Error Messages in Framework (PR#1) Oct 2, 2024

goravel deleted a comment from coderabbitai bot Oct 2, 2024

kkumar-gcc added 2 commits October 3, 2024 02:55

implement errors for framework

f73d027

Merge remote-tracking branch 'origin/kkumar-gcc/#495' into kkumar-gcc/#…

1470f25

…495

hwbrzzl reviewed Oct 3, 2024

View reviewed changes

errors/errors.go Outdated Show resolved Hide resolved

rename contract import

5cad20f

coderabbitai bot previously approved these changes Oct 3, 2024

View reviewed changes

add errors for session

11dd986

kkumar-gcc dismissed coderabbitai[bot]’s stale review via 11dd986 October 3, 2024 07:35

github-actions bot reviewed Oct 3, 2024

View reviewed changes

hwbrzzl reviewed Oct 3, 2024

View reviewed changes

coderabbitai bot previously approved these changes Oct 3, 2024

View reviewed changes

rename location to module

2b4cfc8

kkumar-gcc dismissed coderabbitai[bot]’s stale review via 2b4cfc8 October 3, 2024 09:16

coderabbitai bot previously approved these changes Oct 3, 2024

View reviewed changes

chore: update mocks

c5cecb2

github-actions bot dismissed coderabbitai[bot]’s stale review via c5cecb2 October 3, 2024 09:17

coderabbitai bot approved these changes Oct 3, 2024

View reviewed changes

kkumar-gcc closed this Oct 3, 2024

kkumar-gcc reopened this Oct 3, 2024

hwbrzzl approved these changes Oct 3, 2024

View reviewed changes

Merge branch 'master' into kkumar-gcc/#495

edb7827

kkumar-gcc enabled auto-merge (squash) October 3, 2024 09:51

kkumar-gcc merged commit 804ff1f into master Oct 3, 2024
9 of 10 checks passed

kkumar-gcc deleted the kkumar-gcc/#495 branch October 3, 2024 09:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [#495] Centralize Error Messages in Framework (PR#1) #663

feat: [#495] Centralize Error Messages in Framework (PR#1) #663

kkumar-gcc commented Oct 2, 2024 •

edited

Loading

codecov bot commented Oct 2, 2024 •

edited

Loading

coderabbitai bot commented Oct 2, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

hwbrzzl left a comment

kkumar-gcc commented Oct 3, 2024

github-actions bot left a comment

hwbrzzl Oct 3, 2024

kkumar-gcc Oct 3, 2024 •

edited

Loading

hwbrzzl Oct 3, 2024

hwbrzzl Oct 3, 2024

kkumar-gcc Oct 3, 2024

hwbrzzl left a comment

feat: [#495] Centralize Error Messages in Framework (PR#1) #663

feat: [#495] Centralize Error Messages in Framework (PR#1) #663

Conversation

kkumar-gcc commented Oct 2, 2024 • edited Loading

📑 Description

Example

Summary by CodeRabbit

✅ Checks

codecov bot commented Oct 2, 2024 • edited Loading

Codecov Report

coderabbitai bot commented Oct 2, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

hwbrzzl left a comment

Choose a reason for hiding this comment

kkumar-gcc commented Oct 3, 2024

github-actions bot left a comment

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

hwbrzzl Oct 3, 2024

Choose a reason for hiding this comment

kkumar-gcc Oct 3, 2024 • edited Loading

Choose a reason for hiding this comment

hwbrzzl Oct 3, 2024

Choose a reason for hiding this comment

hwbrzzl Oct 3, 2024

Choose a reason for hiding this comment

kkumar-gcc Oct 3, 2024

Choose a reason for hiding this comment

hwbrzzl left a comment

Choose a reason for hiding this comment

kkumar-gcc commented Oct 2, 2024 •

edited

Loading

codecov bot commented Oct 2, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

kkumar-gcc Oct 3, 2024 •

edited

Loading