Skip to content

Fix #881 (#464): Added JSON encoder to disable escaping html symbols #887

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

Open
Moskovych wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix #881 (#464): Added JSON encoder to disable escaping html symbols #887

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion stores/json/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,14 +149,24 @@ func (store Store) treeBranchFromJSONDecoder(dec *json.Decoder) (sops.TreeBranch
}
}

// Encoder to disable escaping html symbols
// See: https://github.com/getsops/sops/issues/881
func jsonMarshal(v interface{}) ([]byte, error) {
buffer := &bytes.Buffer{}
encoder := json.NewEncoder(buffer)
encoder.SetEscapeHTML(false)
err := encoder.Encode(v)
Copy link
Contributor

@felixfontein felixfontein Sep 20, 2023

Choose a reason for hiding this comment

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

Encode appends a newline (https://pkg.go.dev/encoding/json#Encoder.Encode), which json.Marshal apparently does not do. (This makes the unit tests fail.) This is apparently because Encoder is for JSON streams, while Marshal produces a single JSON file.

Copy link
Contributor

@felixfontein felixfontein Dec 17, 2023

Choose a reason for hiding this comment

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

Simply adding code which removes a trailing newline (if exists) probably suffices to fix this. I don't see another way to do this with Go's API.

Copy link
Author

@Moskovych Moskovych Jan 19, 2024

Choose a reason for hiding this comment

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

Shouldn't we stick with newline in new files instead?

Copy link
Contributor

@felixfontein felixfontein Jan 19, 2024

Choose a reason for hiding this comment

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

This function is called from encodeValue and used during serialization of any JSON value, so if you use this to create JSON of a map, you get someting like

{
  "foo"
: "bar"
,
  "baz"
: 42
,
  "bam"
: null
}

return buffer.Bytes(), err
}

func (store Store) encodeValue(v interface{}) ([]byte, error) {
switch v := v.(type) {
case sops.TreeBranch:
return store.encodeTree(v)
case []interface{}:
return store.encodeArray(v)
default:
return json.Marshal(v)
return jsonMarshal(v)
}
}

Expand Down