Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: enhance CR status with clearer brief error message #1734

Merged
merged 4 commits into from
Sep 2, 2024

Conversation

binbin-li
Copy link
Collaborator

@binbin-li binbin-li commented Aug 21, 2024

Description

What this PR does / why we need it:

The PR will address the issue that brief error is too short. Basically, the brief error will just contain the error code and root cause. And if it exceeds the max length(150 charactoers), the brief error will be truncated.

  1. Add a new GetConciseError method to custom error to create an error message consisting of the error code and reason.
  2. Update all controllers to use the new GetConciseError method to assign brief error value.
  3. Set the maxLength from 30 to 150.

Examples:
Screenshot for Policy CR:
image

image

Screenshot for Verifier CR:
image

image

Screenshot for KMP CR:
image

image

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #1453

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

@binbin-li binbin-li force-pushed the brief-error branch 2 times, most recently from 735db82 to ac56ec3 Compare August 21, 2024 14:02
@binbin-li binbin-li changed the title feat: improve the brief error displayed in CR status feat: enhance CR status with clearer brief error message Aug 21, 2024
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

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

Files with missing lines Patch % Lines
...anagementprovider/refresh/kubeRefreshNamespaced.go 57.89% 8 Missing ⚠️
pkg/keymanagementprovider/refresh/kubeRefresh.go 61.11% 7 Missing ⚠️
...kg/controllers/clusterresource/store_controller.go 88.88% 1 Missing ⚠️
Files with missing lines Coverage Δ
errors/types.go 90.90% <100.00%> (+0.43%) ⬆️
...g/controllers/clusterresource/policy_controller.go 91.83% <100.00%> (-0.33%) ⬇️
...controllers/clusterresource/verifier_controller.go 90.00% <100.00%> (+10.00%) ⬆️
...controllers/namespaceresource/policy_controller.go 91.83% <100.00%> (-0.33%) ⬇️
.../controllers/namespaceresource/store_controller.go 89.74% <100.00%> (+23.07%) ⬆️
...ntrollers/namespaceresource/verifier_controller.go 89.74% <100.00%> (+9.74%) ⬆️
pkg/controllers/utils/kmp.go 100.00% <100.00%> (ø)
...kg/controllers/clusterresource/store_controller.go 84.61% <88.88%> (+10.25%) ⬆️
pkg/keymanagementprovider/refresh/kubeRefresh.go 78.00% <61.11%> (-3.82%) ⬇️
...anagementprovider/refresh/kubeRefreshNamespaced.go 78.00% <57.89%> (-3.82%) ⬇️

... and 13 files with indirect coverage changes

Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Binbin. Left some questions on the clustered controllers , some are also applicable to namespaced controllers. let me know if you have any questions :)

errors/pluginerrors.go Show resolved Hide resolved
internal/constants/constants.go Outdated Show resolved Hide resolved
pkg/controllers/clusterresource/verifier_controller.go Outdated Show resolved Hide resolved
Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. thanks Binbin!

@binbin-li binbin-li merged commit e7655fe into ratify-project:dev Sep 2, 2024
19 checks passed
akashsinghal pushed a commit to akashsinghal/ratify that referenced this pull request Sep 13, 2024
binbin-li added a commit to binbin-li/ratify that referenced this pull request Sep 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The brief error message is too short
2 participants