print: pretty print WAG node contents

Epic: none
Release note: none

Author: pav-kv

pkg/kv/kvserver/kvstorage/wag/store_test.go

@@ -8,6 +8,7 @@ package wag
 import (
 	"fmt"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/cockroachdb/cockroach/pkg/kv/kvpb"
@@ -45,6 +46,9 @@ func TestWrite(t *testing.T) {
 	write("init", func(w storage.Writer) error { return initReplica(&s, w, id, 10) })
 	write("split", func(w storage.Writer) error { return splitReplica(&s, w, id, 200) })
 
+	// TODO(pav-kv): the trailing \n in DecodeWriteBatch is duplicated with
+	// recursion. Remove it, and let the caller handle new lines.
+	out = strings.ReplaceAll(out, "\n\n", "\n")
 	echotest.Require(t, out, filepath.Join("testdata", t.Name()+".txt"))
 }
 

pkg/kv/kvserver/kvstorage/wag/testdata/TestWrite.txt

@@ -1,9 +1,13 @@
 echo
 ----
 >> create
-Put: 0,0 /Local/Store/wag/1 (0x01737761676e000000000000000100): "\n\x04\b{\x10\x04\x10\x01\x1a(\n&\x00\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x01\x12state-machine-key\x00\x05state"
+Put: 0,0 /Local/Store/wag/1 (0x01737761676e000000000000000100): NodeCreate r123/4:0
+> Put: 0,0 "state-machine-key" (0x73746174652d6d616368696e652d6b657900): "state"
 >> init
-Put: 0,0 /Local/Store/wag/2 (0x01737761676e000000000000000200): "\n\x06\b{\x10\x04 \n\x10\x02\x1a\x18\x12\x16\n\ttmp/1.sst\n\ttmp/2.sst"
+Put: 0,0 /Local/Store/wag/2 (0x01737761676e000000000000000200): NodeSnap r123/4:10
+ingestion: SSTs:"tmp/1.sst" SSTs:"tmp/2.sst" 
 >> split
-Put: 0,0 /Local/Store/wag/3 (0x01737761676e000000000000000300): "\n\a\b{\x10\x04 \xc7\x01\x10\x03\x1a\x00"
-Put: 0,0 /Local/Store/wag/4 (0x01737761676e000000000000000400): "\n\a\b{\x10\x04 \xc8\x01\x10\x04\x1a6\n4\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x00\x00\x01\blhs-key\x00\tlhs-state\x01\brhs-key\x00\trhs-state \xb7\x04"
+Put: 0,0 /Local/Store/wag/3 (0x01737761676e000000000000000300): NodeApply r123/4:199
+Put: 0,0 /Local/Store/wag/4 (0x01737761676e000000000000000400): NodeSplit r123/4:200 create:567
+> Put: 0,0 "lhs-key" (0x6c68732d6b657900): "lhs-state"
+> Put: 0,0 "rhs-key" (0x7268732d6b657900): "rhs-state"

pkg/kv/kvserver/kvstorage/wag/wagpb/BUILD.bazel

@@ -32,5 +32,8 @@ go_library(
     embed = [":wagpb_go_proto"],
     importpath = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvstorage/wag/wagpb",
     visibility = ["//visibility:public"],
-    deps = ["//pkg/kv/kvpb"],
+    deps = [
+        "//pkg/kv/kvpb",
+        "@com_github_cockroachdb_redact//:redact",
+    ],
 )

pkg/kv/kvserver/kvstorage/wag/wagpb/wag.go

@@ -5,6 +5,19 @@
 
 package wagpb
 
-// TODO(pav-kv): remove this once the dev gen bazel picks up this dependency
-// from the .pb.go file.
-import _ "github.com/cockroachdb/cockroach/pkg/kv/kvpb"
+import (
+	// TODO(pav-kv): remove this once the dev gen bazel picks up this dependency
+	// from the .pb.go file.
+	_ "github.com/cockroachdb/cockroach/pkg/kv/kvpb"
+	"github.com/cockroachdb/redact"
+)
+
+// String implements the fmt.Stringer interface.
+func (a Addr) String() string {
+	return redact.StringWithoutMarkers(a)
+}
+
+// SafeFormat implements the redact.SafeFormatter interface.
+func (a Addr) SafeFormat(w redact.SafePrinter, _ rune) {
+	w.Printf("r%d/%d:%d", a.RangeID, a.ReplicaID, a.Index)
+}

pkg/kv/kvserver/kvstorage/wag/wagpb/wag.proto

@@ -45,6 +45,8 @@ enum NodeType {
 // with lower ReplicaIDs (including their destruction), or same ReplicaID and
 // lower Index have been applied.
 message Addr {
+  option (gogoproto.goproto_stringer) = false;
+
   // RangeID is the ID of the range that the WAG node pertains to.
   int64 range_id = 1 [
     (gogoproto.customname) = "RangeID",

pkg/kv/kvserver/print/BUILD.bazel

@@ -11,6 +11,7 @@ go_library(
     deps = [
         "//pkg/keys",
         "//pkg/kv/kvserver/kvserverpb",
+        "//pkg/kv/kvserver/kvstorage/wag/wagpb",
         "//pkg/kv/kvserver/raftlog",
         "//pkg/raft/raftpb",
         "//pkg/roachpb",
@@ -22,6 +23,7 @@ go_library(
         "@com_github_cockroachdb_errors//:errors",
         "@com_github_cockroachdb_pebble//:pebble",
         "@com_github_gogo_protobuf//proto",
+        "@com_github_kr_text//:text",
     ],
 )
 

pkg/kv/kvserver/print/debug_print.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/cockroachdb/cockroach/pkg/keys"
 	"github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvserverpb"
+	"github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvstorage/wag/wagpb"
 	"github.com/cockroachdb/cockroach/pkg/kv/kvserver/raftlog"
 	"github.com/cockroachdb/cockroach/pkg/raft/raftpb"
 	"github.com/cockroachdb/cockroach/pkg/roachpb"
@@ -23,6 +24,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/util/protoutil"
 	"github.com/cockroachdb/errors"
 	"github.com/cockroachdb/pebble"
+	"github.com/kr/text"
 )
 
 // PrintEngineKeyValue attempts to print the given key-value pair to
@@ -136,14 +138,16 @@ func SprintMVCCKeyValue(kv storage.MVCCKeyValue, printKey bool) string {
 
 	// TODO(pav-kv): some functions here do not check the key, so can accidentally
 	// succeed parsing values that have a different "type", and print them in a
-	// misleading way. Make all these functions key-aware.
+	// misleading way. Make all these functions key-aware, and use lookups for
+	// efficiency.
 	decoders := append(DebugSprintMVCCKeyValueDecoders,
 		tryRangeIDKey,
 		tryRangeDescriptor,
 		tryMeta,
 		tryTxn,
 		tryTimeSeries,
 		tryIntent,
+		tryWAGKey,
 		func(kv storage.MVCCKeyValue) (string, error) {
 			// No better idea, just print raw bytes and hope that folks use `less -S`.
 			return fmt.Sprintf("%q", kv.Value), nil
@@ -465,6 +469,40 @@ func tryRangeIDKey(kv storage.MVCCKeyValue) (string, error) {
 	return msg.String(), nil
 }
 
+func tryWAGKey(kv storage.MVCCKeyValue) (string, error) {
+	if !bytes.HasPrefix(kv.Key.Key, keys.StoreWAGPrefix()) {
+		return "", errors.New("not a WAG node key")
+	}
+	var node wagpb.Node
+	if err := node.Unmarshal(kv.Value); err != nil { // nolint:protounmarshal
+		return "", err
+	}
+
+	str := fmt.Appendf(nil, "%v %s", node.Type, node.Addr)
+	if c, d := node.Create, node.Destroy; c != 0 || len(d) != 0 {
+		if c != 0 {
+			str = fmt.Appendf(str, " create:%d", c)
+		}
+		if len(d) != 0 {
+			str = fmt.Appendf(str, " destroy:%v", d)
+		}
+	}
+
+	if b := node.Mutation.Batch; len(b) > 0 {
+		bs, err := DecodeWriteBatch(b)
+		if err != nil {
+			bs = "failed to decode write batch: " + err.Error()
+		}
+		str = fmt.Appendf(str, "\n%s", text.Indent(bs, "> "))
+	}
+	if ing := node.Mutation.Ingestion; ing != nil {
+		// TODO(pav-kv): make this format nicely. Currently, this proto is too big.
+		str = fmt.Appendf(str, "\ningestion: %v", ing)
+	}
+
+	return string(str), nil
+}
+
 func tryMeta(kv storage.MVCCKeyValue) (string, error) {
 	if !bytes.HasPrefix(kv.Key.Key, keys.Meta1Prefix) && !bytes.HasPrefix(kv.Key.Key, keys.Meta2Prefix) {
 		return "", errors.New("not a meta key")