enconding/json: add ValidPos() function

[dveeden]

Add json.ValidPos() to allow getting the position of where the validation failed
in addition to a boolean to indicate the failure.

Closes #67423

[gopherbot]

This PR (HEAD: 9adaed7) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/585995.

Important tips:

• Don't comment on this PR. All discussion takes place in Gerrit.
• You need a Gmail or other Google account to log in to Gerrit.
• To change your code in response to feedback:
  • Push a new commit to the branch used by your GitHub PR.
  • A new "patch set" will then appear in Gerrit.
  • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
  • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
  • Multiple commits in the PR will be squashed by GerritBot.
• The title and description of the GitHub PR are used to construct the final commit message.
  • Edit these as needed via the GitHub web interface (not via Gerrit or git).
  • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
• See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

[dveeden]

We use json.Valid() in https://github.com/pingcap/tidb to implement the JSON_VALID() SQL function and would like to return the position on which the validation failed to the user.

https://github.com/pingcap/tidb/blob/0875abde25467897e4e81ae6c18c5e8792ca28a9/pkg/expression/builtin_json.go#L1019

Example usage:

package main

import (
	"encoding/json"
	"fmt"
	"strings"
)

func main() {
	inputs := []string{
		`{}`,
		`{"foo": "bar"}`,
		`{"foo: "bar"}`,
		`{"foo": "bar", "bar": foo}`,
		`{"foo": "bar", "bar", foo}`,
	}
	for _, input := range inputs {
		v, pos := json.ValidPos([]byte(input))
		fmt.Printf("'%s': valid: %#v, pos: %d\n", input, v, pos)
		if !v {
			fmt.Printf(strings.Repeat(" ", int(pos)) + "^\n")
		}
	}
}

Output:

go run main.go 
'{}': valid: true, pos: 2
'{"foo": "bar"}': valid: true, pos: 14
'{"foo: "bar"}': valid: false, pos: 9
         ^
'{"foo": "bar", "bar": foo}': valid: false, pos: 24
                        ^
'{"foo": "bar", "bar", foo}': valid: false, pos: 21
                     ^

This would make it easier to see why validation failed, especially for larger JSON documents.

[gopherbot]

Message from Gopher Robot:

Patch Set 1:

(1 comment)

---

Please don’t reply on this GitHub thread. Visit golang.org/cl/585995.
After addressing review feedback, remember to publish your drafts!

[gopherbot]

Message from Gopher Robot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
A maintainer will review your change and provide feedback. See
https://go.dev/doc/contribute#review for more info and tips to get your
patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11 or adds a tag like "wait-release", it means that this CL will be
reviewed as part of the next development cycle. See https://go.dev/s/release
for more details.

---

Please don’t reply on this GitHub thread. Visit golang.org/cl/585995.
After addressing review feedback, remember to publish your drafts!

[gopherbot]

Message from Daniël van Eeden:

Patch Set 1:

(1 comment)

---

Please don’t reply on this GitHub thread. Visit golang.org/cl/585995.
After addressing review feedback, remember to publish your drafts!