skip binary provisioning for run command #4731
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
Signed-off-by: Pablo Chacin <[email protected]>
pablochacin
requested review from
mstoykov,
inancgumus and
codebien
and removed request for
a team,
mstoykov and
inancgumus
codebien
requested changes
Apr 23, 2025
There was a problem hiding this comment.
Binary provisioning feature is enabled. If one of the commands between `cloud run`, `cloud run --local-exeuction`, `archive` or `inspect` is used then k6 will try to provision a new k6 binary.
I think we need a better UX, because if someone now tries k6 run it won't be able to get why it doesn't work as expected.
Signed-off-by: Pablo Chacin <[email protected]>
codebien
reviewed
Apr 24, 2025
internal/cmd/launcher.go
Outdated
|
|
||
| deps, err := analyze(l.gs, l.gs.CmdArgs[1:]) | ||
| if err != nil { | ||
| l.gs.Logger. | ||
| WithError(err). | ||
| Error("Failed to analyze the required dependencies. Please, make sure to report this issue by" + | ||
| Error("Binary provisioning enabled but failed to analyze dependencies. Please, make sure to report this issue by" + |
There was a problem hiding this comment.
Suggested change
| Error("Binary provisioning enabled but failed to analyze dependencies. Please, make sure to report this issue by" + | |
| Error("Binary provisioning is enabled but it failed to analyze the dependencies. Please, make sure to report this issue by" + |
internal/cmd/launcher.go
Outdated
| @@ -76,22 +77,21 @@ func (l *Launcher) Launch() { | |||
| // if the command does not have dependencies or a custom build | |||
| if !customBuildRequired(build.Version, deps) { | |||
| l.gs.Logger. | |||
| Debug("The current k6 binary already satisfies all the required dependencies," + | |||
| " it isn't required to provision a new binary.") | |||
| Debug("Binary provisioning is not required to execute this command.") | |||
There was a problem hiding this comment.
I find the previous message better because it explains the why. Can we restore it?
internal/cmd/launcher.go
Outdated
| @@ -194,7 +194,7 @@ func k6buildProvision(gs *state.GlobalState, deps k6deps.Dependencies) (commandE | |||
| } | |||
|
|
|||
| if config.BuildServiceAuth == "" { | |||
| return nil, errors.New("k6 cloud token is required when Binary provisioning feature is enabled." + | |||
| return nil, errors.New("k6 cloud token is required when the binary provisioning feature is enabled." + | |||
There was a problem hiding this comment.
Suggested change
| return nil, errors.New("k6 cloud token is required when the binary provisioning feature is enabled." + | |
| return nil, errors.New("k6 cloud token is required when the binary provisioning feature is enabled." + |
I'm using Binary provisioning because it is the name of the feature. So, any name requires to be capitalized.
There was a problem hiding this comment.
I think it should be "Binary Provisioning"
There was a problem hiding this comment.
It is fine to me, go for it 👍
internal/cmd/launcher.go
Outdated
| @@ -249,6 +249,8 @@ func analyze(gs *state.GlobalState, args []string) (k6deps.Dependencies, error) | |||
| } | |||
|
|
|||
| if !isScriptRequired(args) { | |||
| gs.Logger. | |||
| Debug("command does not require binary provisioning") | |||
There was a problem hiding this comment.
Suggested change
| Debug("command does not require binary provisioning") | |
| Debug("The command to execute does not require binary provisioning") |
A follow-up improvement might be to return the identified command from isScriptRequired function and log it here. However, it can be a low priority improvement for the future.
Signed-off-by: Pablo Chacin <[email protected]>
Signed-off-by: Pablo Chacin <[email protected]>
codebien
approved these changes
Apr 24, 2025
8 tasks
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.
What?
skip binary provisioning for
k6 runcommandWhy?
Binary provisioning is currently supported only for users who have a cloud account, because it requires authenticating to GCK6.
Enabling binary provisioning only for cloud command (e.g.
k6 cloud run) offers a more consistent user experience. The exception to this are thek6 archiveandk6 inspectcommands that are require for the users to upload tests to the cloud.Checklist
make check) and all pass.Checklist: Documentation (only for k6 maintainers and if relevant)
Please do not merge this PR until the following items are filled out.
Related PR(s)/Issue(s)