hints: separate out hint protobuf into separate package

This commit adds a new package `hintpb` for the protobuf structs used
to store hints in the `system.statement_hints` table. This will avoid
dependency cycles in future commits.

Epic: None

Release note: None

Author: DrewKimball

pkg/BUILD.bazel

@@ -2070,6 +2070,7 @@ GO_TARGETS = [
     "//pkg/sql/gcjob:gcjob",
     "//pkg/sql/gcjob:gcjob_test",
     "//pkg/sql/gcjob_test:gcjob_test_test",
+    "//pkg/sql/hintpb:hintpb",
     "//pkg/sql/hints:hints",
     "//pkg/sql/hints:hints_test",
     "//pkg/sql/idxrecommendations:idxrecommendations",

pkg/gen/protobuf.bzl

@@ -63,7 +63,7 @@ PROTOBUF_SRCS = [
     "//pkg/sql/catalog/schematelemetry/schematelemetrycontroller:schematelemetrycontroller_go_proto",
     "//pkg/sql/contentionpb:contentionpb_go_proto",
     "//pkg/sql/execinfrapb:execinfrapb_go_proto",
-    "//pkg/sql/hints:hints_go_proto",
+    "//pkg/sql/hintpb:hintpb_go_proto",
     "//pkg/sql/inverted:inverted_go_proto",
     "//pkg/sql/lex:lex_go_proto",
     "//pkg/sql/pgwire/pgerror:pgerror_go_proto",

pkg/sql/hintpb/BUILD.bazel

@@ -0,0 +1,29 @@
+load("@rules_proto//proto:defs.bzl", "proto_library")
+load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")
+
+proto_library(
+    name = "hintpb_proto",
+    srcs = ["statement_hint.proto"],
+    strip_import_prefix = "/pkg",
+    visibility = ["//visibility:public"],
+    deps = ["@com_github_gogo_protobuf//gogoproto:gogo_proto"],
+)
+
+go_proto_library(
+    name = "hintpb_go_proto",
+    compilers = ["//pkg/cmd/protoc-gen-gogoroach:protoc-gen-gogoroach_compiler"],
+    importpath = "github.com/cockroachdb/cockroach/pkg/sql/hintpb",
+    proto = ":hintpb_proto",
+    visibility = ["//visibility:public"],
+    deps = ["@com_github_gogo_protobuf//gogoproto"],
+)
+
+go_library(
+    name = "hintpb",
+    srcs = ["statement_hint.go"],
+    embed = [":hintpb_go_proto"],
+    importpath = "github.com/cockroachdb/cockroach/pkg/sql/hintpb",
+    visibility = ["//visibility:public"],
+    deps = ["//pkg/util/protoutil"],
+)

pkg/sql/hints/statement_hint.go renamed to pkg/sql/hintpb/statement_hint.go

@@ -3,7 +3,7 @@
 // Use of this software is governed by the CockroachDB Software License
 // included in the /LICENSE file.
 
-package hints
+package hintpb
 
 import "github.com/cockroachdb/cockroach/pkg/util/protoutil"
 

pkg/sql/hints/statement_hint.proto renamed to pkg/sql/hintpb/statement_hint.proto

@@ -4,7 +4,7 @@
 // included in the /LICENSE file.
 
 syntax = "proto3";
-package hints;
+package hintpb;
 
 import "gogoproto/gogo.proto";
 

pkg/sql/hints/BUILD.bazel

@@ -1,14 +1,8 @@
-load("@rules_proto//proto:defs.bzl", "proto_library")
-load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 
 go_library(
     name = "hints",
-    srcs = [
-        "hint_cache.go",
-        "statement_hint.go",
-    ],
-    embed = [":hints_go_proto"],
+    srcs = ["hint_cache.go"],
     importpath = "github.com/cockroachdb/cockroach/pkg/sql/hints",
     visibility = ["//visibility:public"],
     deps = [
@@ -25,6 +19,7 @@ go_library(
         "//pkg/sql/catalog/descpb",
         "//pkg/sql/catalog/descs",
         "//pkg/sql/catalog/systemschema",
+        "//pkg/sql/hintpb",
         "//pkg/sql/rowenc",
         "//pkg/sql/sem/tree",
         "//pkg/sql/sessiondata",
@@ -34,7 +29,6 @@ go_library(
         "//pkg/util/hlc",
         "//pkg/util/log",
         "//pkg/util/metamorphic",
-        "//pkg/util/protoutil",
         "//pkg/util/retry",
         "//pkg/util/startup",
         "//pkg/util/stop",
@@ -43,23 +37,6 @@ go_library(
     ],
 )
 
-go_proto_library(
-    name = "hints_go_proto",
-    compilers = ["//pkg/cmd/protoc-gen-gogoroach:protoc-gen-gogoroach_compiler"],
-    importpath = "github.com/cockroachdb/cockroach/pkg/sql/hints",
-    proto = ":hints_proto",
-    visibility = ["//visibility:public"],
-    deps = ["@com_github_gogo_protobuf//gogoproto"],
-)
-
-proto_library(
-    name = "hints_proto",
-    srcs = ["statement_hint.proto"],
-    strip_import_prefix = "/pkg",
-    visibility = ["//visibility:public"],
-    deps = ["@com_github_gogo_protobuf//gogoproto:gogo_proto"],
-)
-
 go_test(
     name = "hints_test",
     size = "medium",
@@ -80,6 +57,7 @@ go_test(
         "//pkg/server",
         "//pkg/sql/catalog",
         "//pkg/sql/catalog/descs",
+        "//pkg/sql/hintpb",
         "//pkg/sql/randgen",
         "//pkg/sql/stats",
         "//pkg/testutils",

pkg/sql/hints/hint_cache.go

@@ -25,6 +25,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descs"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/systemschema"
+	"github.com/cockroachdb/cockroach/pkg/sql/hintpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/rowenc"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
@@ -392,7 +393,7 @@ func (c *StatementHintsCache) GetGeneration() int64 {
 // retrieving them.
 func (c *StatementHintsCache) MaybeGetStatementHints(
 	ctx context.Context, statementFingerprint string,
-) (hints []StatementHint, ids []int64) {
+) (hints []hintpb.StatementHint, ids []int64) {
 	hash := fnv.New64()
 	_, err := hash.Write([]byte(statementFingerprint))
 	if err != nil {
@@ -450,7 +451,7 @@ func (c *StatementHintsCache) maybeWaitForRefreshLocked(
 // released while reading from the db, and then reacquired.
 func (c *StatementHintsCache) addCacheEntryLocked(
 	ctx context.Context, statementHash int64, statementFingerprint string,
-) (hints []StatementHint, ids []int64) {
+) (hints []hintpb.StatementHint, ids []int64) {
 	c.mu.AssertHeld()
 
 	// Add a cache entry that other queries can find and wait on until we have the
@@ -515,7 +516,7 @@ func (c *StatementHintsCache) getStatementHintsFromDB(
 		datums := it.Cur()
 		rowID := int64(tree.MustBeDInt(datums[0]))
 		fingerprint := string(tree.MustBeDString(datums[1]))
-		hint, err := NewStatementHint([]byte(tree.MustBeDBytes(datums[2])))
+		hint, err := hintpb.NewStatementHint([]byte(tree.MustBeDBytes(datums[2])))
 		if err != nil {
 			return err
 		}
@@ -542,7 +543,7 @@ type cacheEntry struct {
 	// be duplicate entries in the fingerprints slice.
 	// TODO(drewk): consider de-duplicating the fingerprint strings to reduce
 	// memory usage.
-	hints        []StatementHint
+	hints        []hintpb.StatementHint
 	fingerprints []string
 	ids          []int64
 }
@@ -551,7 +552,7 @@ type cacheEntry struct {
 // fingerprint, or nil if they don't exist. The results are in order of row ID.
 func (entry *cacheEntry) getMatchingHints(
 	statementFingerprint string,
-) (hints []StatementHint, ids []int64) {
+) (hints []hintpb.StatementHint, ids []int64) {
 	for i := range entry.hints {
 		if entry.fingerprints[i] == statementFingerprint {
 			hints = append(hints, entry.hints[i])

pkg/sql/hints/hint_cache_test.go

@@ -15,6 +15,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/kv/kvclient/rangefeed"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descs"
+	"github.com/cockroachdb/cockroach/pkg/sql/hintpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/hints"
 	"github.com/cockroachdb/cockroach/pkg/testutils"
 	"github.com/cockroachdb/cockroach/pkg/testutils/serverutils"
@@ -541,7 +542,7 @@ func checkIDOrder(t *testing.T, ids []int64) {
 // insertStatementHint inserts an empty statement hint into the
 // system.statement_hints table.
 func insertStatementHint(t *testing.T, r *sqlutils.SQLRunner, fingerprint string) {
-	emptyHint := &hints.StatementHintUnion{}
+	emptyHint := &hintpb.StatementHintUnion{}
 	hintBytes, err := emptyHint.ToBytes()
 	require.NoError(t, err)
 	const insertStmt = `INSERT INTO system.statement_hints ("fingerprint", "hint") VALUES ($1, $2)`