-
-
Notifications
You must be signed in to change notification settings - Fork 854
fix: don't mutate shared matrix AST when resolving ref: rows
#2894
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
Merged
+88
−6
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package task | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
|
|
||
| "github.com/go-task/task/v3/internal/templater" | ||
| "github.com/go-task/task/v3/taskfile/ast" | ||
| ) | ||
|
|
||
| // TestResolveMatrixRefsDoesNotMutateInput is a regression test for #2890. The | ||
| // *ast.Matrix passed to resolveMatrixRefs is part of the shared, cached Task | ||
| // AST: the same *ast.Matrix is reused on every invocation of a task. If | ||
| // resolveMatrixRefs resolved `ref:` rows in place, concurrent invocations of | ||
| // the same task (e.g. via parallel deps) would race on that mutation and leak | ||
| // a value resolved for one caller into another caller's expansion. | ||
| // | ||
| // The invariant that prevents this is that resolveMatrixRefs must resolve into | ||
| // a copy and leave its input untouched, which this test asserts deterministically. | ||
| func TestResolveMatrixRefsDoesNotMutateInput(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| matrix := ast.NewMatrix( | ||
| &ast.MatrixElement{Key: "ARCH", Value: &ast.MatrixRow{Ref: ".ARCH_VAR"}}, | ||
| ) | ||
|
|
||
| vars := ast.NewVars() | ||
| vars.Set("ARCH_VAR", ast.Var{Value: []any{"amd64"}}) | ||
| cache := &templater.Cache{Vars: vars} | ||
|
|
||
| resolved, err := resolveMatrixRefs(matrix, cache) | ||
| require.NoError(t, err) | ||
|
|
||
| // The returned matrix has the ref resolved... | ||
| row, ok := resolved.Get("ARCH") | ||
| require.True(t, ok, "ARCH row missing from resolved matrix") | ||
| require.Equal(t, []any{"amd64"}, row.Value) | ||
|
|
||
| // ...but the shared input matrix must be left untouched. | ||
| orig, ok := matrix.Get("ARCH") | ||
| require.True(t, ok, "ARCH row missing from input matrix") | ||
| require.Nil(t, orig.Value, "input matrix was mutated: Ref rows must be resolved into a copy") | ||
| require.Equal(t, ".ARCH_VAR", orig.Ref, "input matrix Ref was altered") | ||
| } |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.