campaigns: move validation code to campaignutils #353
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes sourcegraph/sourcegraph#14249.
eseliger
approved these changes
Oct 16, 2020
Comment on lines
+292
to
+315
| func campaignsParseSpec(out *output.Output, svc *campaigns.Service, input io.ReadCloser) (*campaigns.CampaignSpec, string, error) { | ||
| spec, raw, err := svc.ParseCampaignSpec(input) | ||
| if err != nil { | ||
| if merr, ok := err.(*multierror.Error); ok { | ||
| block := out.Block(output.Line("\u274c", output.StyleWarning, "Campaign spec failed validation.")) | ||
| defer block.Close() | ||
|
|
||
| for i, err := range merr.Errors { | ||
| block.Writef("%d. %s", i+1, err) | ||
| } | ||
|
|
||
| return nil, "", &exitCodeError{ | ||
| error: nil, | ||
| exitCode: 2, | ||
| } | ||
| } else { | ||
| // This shouldn't happen; let's just punt and let the normal | ||
| // rendering occur. | ||
| return nil, "", err | ||
| } | ||
| } | ||
|
|
||
| return spec, raw, nil | ||
| } |
There was a problem hiding this comment.
Just wondering if we should incorporate this logic into ParseCampaignSpec, then we wouldn't need this function that gets passed in a service, and it can't be forgotten. Are there use-cases where we explicitly would not want to have this error prettify logic?
There was a problem hiding this comment.
It's basically a layering thing: I don't want internal/campaigns (in this case, the Service methods) to have any specific knowledge of internal/output, so this code lives here to basically handle the rendering of any errors. This function is used by each of the campaign commands that have to parse a spec file, though, so it's still shared.
mrnugget
approved these changes
Oct 16, 2020
scjohns
pushed a commit
that referenced
this pull request
Apr 24, 2023
Fixes sourcegraph/sourcegraph#14249.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This turned out to be a nicer cleanup than I expected: the parse and validate helper functions in
cmd/srcwere separate for mostly historical reasons, but now we can unify them.Fixes sourcegraph/sourcegraph#14249.