Skip to content

fix(json): disable HTML escaping when writing JSON files #8090

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.

Sign up for GitHub

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
olblak merged 4 commits into from
Mar 25, 2026
+63 −0
Merged

fix(json): disable HTML escaping when writing JSON files #8090

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e87dff
fix(json): disable HTML escaping when writing JSON files
loispostula Mar 24, 2026
7543d21
Merge branch 'main' into push-msrwkournuty
olblak Mar 25, 2026
9899fcb
Merge branch 'main' into push-msrwkournuty
olblak Mar 25, 2026
16d1904
fix: typo
olblak Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions pkg/plugins/resources/json/target_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package json

import (
"fmt"
"os"
"strings"
"testing"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -97,3 +100,59 @@
})
}
}

// TestTargetPreservesSpecialCharacters verifies that HTML-special characters such as
// ">" are not escaped to their Unicode equivalents (e.g. \u003e) when the target
// writes back to disk. This is a regression test for the HTML-escaping bug.
func TestTargetPreservesSpecialCharacters(t *testing.T) {
// Initial JSON contains a browsers key with ">0.2%" that must survive a write
// cycle untouched, alongside a separate version key that the target will update.
initialJSON := `{
"browsers": ">0.2%",
"version": "1.0.0"
}
`

engines := []struct {
name string
engine *string
}{
{name: "dasel/v1 (default)", engine: nil},
{name: "dasel/v2", engine: strPtr(ENGINEDASEL_V2)},
}

for _, e := range engines {
t.Run(fmt.Sprintf("engine=%s", e.name), func(t *testing.T) {
dir := t.TempDir()
filePath := dir + "/test.json"

err := os.WriteFile(filePath, []byte(initialJSON), 0600)
require.NoError(t, err)

spec := Spec{
File: filePath,
Key: ".version",
Engine: e.engine,
}

j, err := New(spec)
require.NoError(t, err)

gotResult := result.Target{}
// dryRun=false so the file is actually written back to disk.
err = j.Target("2.0.0", nil, false, &gotResult)
require.NoError(t, err)
assert.True(t, gotResult.Changed)

content, err := os.ReadFile(filePath)
require.NoError(t, err)

// The literal ">" must be preserved; \u003e is the escaped form that
// Go's encoding/json emits by default via its HTMLEscape behaviour.

Check failure on line 151 in pkg/plugins/resources/json/target_test.go

View workflow job for this annotation

GitHub Actions / Build 

`behaviour` is a misspelling of `behavior` (misspell)
assert.True(t, strings.Contains(string(content), ">0.2%"),
"expected >0.2%% to be preserved in file, got:\n%s", string(content))
assert.False(t, strings.Contains(string(content), `\u003e`),
"expected > NOT to be HTML-escaped to \\u003e, got:\n%s", string(content))
})
}
}
4 changes: 4 additions & 0 deletions pkg/plugins/utils/dasel/write.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ func (f *FileContent) Write() error {
Key: storage.OptionPrettyPrint,
Value: true,
},
{
Key: storage.OptionEscapeHTML,
Value: false,
},
},
)
if err != nil {
Expand Down
Loading