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

Err comp config pairs code #10895

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Jougan-0
Copy link
Contributor

@Jougan-0 Jougan-0 commented May 8, 2024

Notes for Reviewers

This PR fixes #10762

Update documentation and error codes in Go by including missing long descriptions, probable causes, and suggested remedy.

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Jougan-0 <prasantmishra2018@gmail.com>
Signed-off-by: Jougan-0 <prasantmishra2018@gmail.com>
@Jougan-0 Jougan-0 requested a review from leecalcote May 8, 2024 07:12
@github-actions github-actions bot added area/docs Documentation update needed component/server labels May 8, 2024
Copy link

github-actions bot commented May 8, 2024

@l5io
Copy link
Collaborator

l5io commented May 8, 2024

"suggested_remediation": ""
"long_description": "An error occurred while trying to create Component Configuration.",
"short_description": "Unable to Create Component Configuration.",
"probable_cause": "Missing or invalid user token, invalid Kubernetes handler or serviceActionProvider error.",
Copy link
Member

Choose a reason for hiding this comment

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

Refactor to make this user-facing. To a user, what is a Kubernetes handler or serviceActionProvider?

Users know about Meshery Connections and can be offered a link to troubleshooting or understanding connections and Meshery's interactions with Kubernetes (in Meshery Docs), but they will not understand references to function names or golang routines.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

Signed-off-by: Jougan-0 <prasantmishra2018@gmail.com>
Signed-off-by: Jougan-0 <prasantmishra2018@gmail.com>
@l5io
Copy link
Collaborator

l5io commented May 14, 2024

@Jougan-0 Jougan-0 requested a review from leecalcote May 14, 2024 16:36
@Jougan-0
Copy link
Contributor Author

Jougan-0 commented May 14, 2024

should MeshMap Screenshot Service / MeshMapScreenshot (pull_request_target)
this fail?
(https://layer5io.slack.com/archives/G019GNQGPL4/p1715701779086639)?

@l5io
Copy link
Collaborator

l5io commented May 22, 2024

@@ -207,9 +207,8 @@ func ErrExecutionPlan(err error) error {
}

func ErrCompConfigPairs(err error) error {
return errors.New(ErrCompConfigPairsCode, errors.Alert, []string{"unable to Create Comp Config.", err.Error()}, []string{err.Error()}, []string{}, []string{})
return errors.New(ErrCompConfigPairsCode, errors.Alert, []string{"Unable to Create Component Configuration.", err.Error()}, []string{("An error occurred while trying to create Component Configuration."), err.Error()}, []string{"Missing or invalid user token, or an issue with Meshery's interactions with Kubernetes."}, []string{"For understanding and troubleshooting, refer to https://docs.meshery.io/guides/troubleshooting and https://docs.meshery.io/installation/kubernetes"})
Copy link
Contributor

Choose a reason for hiding this comment

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

Add name of the component for which it failed, (its kind and name).

"Missing or invalid user token, or an issue with Meshery's interactions with Kubernetes."
only single cause?

  1. No registered model/comp found inside registry
  2. failed validation

Will you verify what error you get if we try to deploy a CR inside a cluster which doesn't have a CRD deployed.

What error you get from meshery vs when you do same from kubectl

Copy link

codecov bot commented May 22, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 9.01%. Comparing base (036c67a) to head (b9a0b29).
Report is 37 commits behind head on master.

Files Patch % Lines
server/handlers/error.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master   #10895   +/-   ##
=======================================
  Coverage    9.01%    9.01%           
=======================================
  Files         146      146           
  Lines       19258    19258           
=======================================
  Hits         1736     1736           
  Misses      17220    17220           
  Partials      302      302           
Flag Coverage Δ
unittests 9.01% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed component/server
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Server] Meshery Server - ErrCompConfigPairsCode-1073: Missing probable cause and suggested remediation
4 participants