*: update to use full package name for option go_package in protos

Everywhere in the entire tree we use `option go_package` statements like the following: ``` option go_package = "build"; ``` We do this *instead of* using the entire fully-qualified package name, like: ``` option go_package = "github.com/cockroachdb/cockroach/pkg/build"; ``` This is apparently just an error. All the documentation I have seen (https://github.com/cockroachdb/gogoproto/blob/master/README) suggests that the fully-qualified package name should be used here. Further, this caused the `make` build to break after a refactor as the code generator doesn't know how to import a package like `"roachpb"` (since it should instead be importing `"github.com/cockroachdb/cockroach/pkg/roachpb"`). Correct this problem *everywhere* and update the `Makefile` to set `paths=source_relative` to tell `protoc` that output files should be placed next to input files. Epic: none Release note: None
cockroachdb · Feb 21, 2023 · d8baef9 · d8baef9
1 parent 4806560
commit d8baef9
Show file tree

Hide file tree

Showing 144 changed files with 152 additions and 154 deletions.
diff --git a/Makefile b/Makefile
@@ -1359,15 +1359,15 @@ $(ERRORS_PROTO): bin/.submodules-initialized
 bin/.go_protobuf_sources: $(GO_PROTOS) $(GOGOPROTO_PROTO) $(ERRORS_PROTO) bin/.bootstrap bin/protoc-gen-gogoroach c-deps/proto-rebuild vendor/modules.txt
 	$(FIND_RELEVANT) -type f -name '*.pb.go' -exec rm {} +
 	set -e; for dir in $(sort $(dir $(GO_PROTOS))); do \
-	  buf protoc -Ipkg -I$(GOGO_PROTOBUF_PATH) -I$(COREOS_PATH) -I$(PROMETHEUS_PATH) -I$(GRPC_GATEWAY_GOOGLEAPIS_PATH) -I$(ERRORS_PATH) --gogoroach_out=$(PROTO_MAPPINGS)plugins=grpc,import_prefix=github.com/cockroachdb/cockroach/pkg/:./pkg $$dir/*.proto; \
+	  buf protoc -Ipkg -I$(GOGO_PROTOBUF_PATH) -I$(COREOS_PATH) -I$(PROMETHEUS_PATH) -I$(GRPC_GATEWAY_GOOGLEAPIS_PATH) -I$(ERRORS_PATH) --gogoroach_out=$(PROTO_MAPPINGS)plugins=grpc,import_prefix=github.com/cockroachdb/cockroach/pkg/,paths=source_relative:./pkg $$dir/*.proto; \
 	done
 	gofmt -s -w $(GO_SOURCES)
 	touch $@
 
 bin/.gw_protobuf_sources: $(GW_SERVER_PROTOS) $(GW_TS_PROTOS) $(GO_PROTOS) $(GOGOPROTO_PROTO) $(ERRORS_PROTO) bin/.bootstrap c-deps/proto-rebuild vendor/modules.txt
 	$(FIND_RELEVANT) -type f -name '*.pb.gw.go' -exec rm {} +
-		buf protoc -Ipkg -I$(GOGO_PROTOBUF_PATH) -I$(ERRORS_PATH) -I$(COREOS_PATH) -I$(PROMETHEUS_PATH) -I$(GRPC_GATEWAY_GOOGLEAPIS_PATH) --grpc-gateway_out=logtostderr=true,request_context=true:./pkg $(GW_SERVER_PROTOS)
-		buf protoc -Ipkg -I$(GOGO_PROTOBUF_PATH) -I$(ERRORS_PATH) -I$(COREOS_PATH) -I$(PROMETHEUS_PATH) -I$(GRPC_GATEWAY_GOOGLEAPIS_PATH) --grpc-gateway_out=logtostderr=true,request_context=true:./pkg $(GW_TS_PROTOS)
+		buf protoc -Ipkg -I$(GOGO_PROTOBUF_PATH) -I$(ERRORS_PATH) -I$(COREOS_PATH) -I$(PROMETHEUS_PATH) -I$(GRPC_GATEWAY_GOOGLEAPIS_PATH) --grpc-gateway_out=logtostderr=true,request_context=true,paths=source_relative:./pkg $(GW_SERVER_PROTOS)
+		buf protoc -Ipkg -I$(GOGO_PROTOBUF_PATH) -I$(ERRORS_PATH) -I$(COREOS_PATH) -I$(PROMETHEUS_PATH) -I$(GRPC_GATEWAY_GOOGLEAPIS_PATH) --grpc-gateway_out=logtostderr=true,request_context=true,paths=source_relative:./pkg $(GW_TS_PROTOS)
 	gofmt -s -w $(GW_SOURCES)
 	@# TODO(jordan,benesch) This can be removed along with the above TODO.
 	goimports -w $(GW_SOURCES)

diff --git a/pkg/acceptance/cluster/testconfig.proto b/pkg/acceptance/cluster/testconfig.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto2";
 package cockroach.acceptance.cluster;
-option go_package = "cluster";
+option go_package = "github.com/cockroachdb/cockroach/pkg/acceptance/cluster";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/blobs/blobspb/blobs.proto b/pkg/blobs/blobspb/blobs.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.blobs;
-option go_package = "blobspb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/blobs/blobspb";
 
 // GetRequest is used to read a file from a remote node.
 // It's path is specified by `filename`, which can either

diff --git a/pkg/build/info.proto b/pkg/build/info.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto2";
 package cockroach.build;
-option go_package = "build";
+option go_package = "github.com/cockroachdb/cockroach/pkg/build";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/ccl/backupccl/backuppb/backup.proto b/pkg/ccl/backupccl/backuppb/backup.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 package cockroach.ccl.backupccl;
-option go_package = "backuppb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/ccl/backupccl/backuppb";
 
 import "build/info.proto";
 import "cloud/cloudpb/external_storage.proto";

diff --git a/pkg/ccl/baseccl/encryption_options.proto b/pkg/ccl/baseccl/encryption_options.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 package cockroach.ccl.baseccl;
-option go_package = "baseccl";
+option go_package = "github.com/cockroachdb/cockroach/pkg/ccl/baseccl";
 
 enum EncryptionKeySource {
   // Plain key files.

diff --git a/pkg/ccl/changefeedccl/changefeedpb/scheduled_changefeed.proto b/pkg/ccl/changefeedccl/changefeedpb/scheduled_changefeed.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 package cockroach.ccl.changefeedccl;
-option go_package = "changefeedpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/ccl/changefeedccl/changefeedpb";
 
 // ScheduledExportExecutionArgs is the arguments to the scheduled backup executor.
 message ScheduledChangefeedExecutionArgs {

diff --git a/pkg/ccl/storageccl/engineccl/enginepbccl/key_registry.proto b/pkg/ccl/storageccl/engineccl/enginepbccl/key_registry.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 package cockroach.ccl.storageccl.engineccl.enginepbccl;
-option go_package = "enginepbccl";
+option go_package = "github.com/cockroachdb/cockroach/pkg/ccl/storageccl/engineccl/enginepbccl";
 
 enum EncryptionType {
   // No encryption.

diff --git a/pkg/ccl/storageccl/engineccl/enginepbccl/stats.proto b/pkg/ccl/storageccl/engineccl/enginepbccl/stats.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 package cockroach.ccl.storageccl.engineccl.enginepbccl;
-option go_package = "enginepbccl";
+option go_package = "github.com/cockroachdb/cockroach/pkg/ccl/storageccl/engineccl/enginepbccl";
 
 import "ccl/storageccl/engineccl/enginepbccl/key_registry.proto";
 

diff --git a/pkg/ccl/utilccl/licenseccl/license.proto b/pkg/ccl/utilccl/licenseccl/license.proto
@@ -8,7 +8,7 @@
 
 syntax = "proto3";
 package cockroach.ccl.utilccl.licenseccl;
-option go_package = "licenseccl";
+option go_package = "github.com/cockroachdb/cockroach/pkg/ccl/utilccl/licenseccl";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/cloud/cloudpb/external_storage.proto b/pkg/cloud/cloudpb/external_storage.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.cloud.cloudpb;
-option go_package = "cloudpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/cloud/cloudpb";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/cloud/externalconn/connectionpb/connection.proto b/pkg/cloud/externalconn/connectionpb/connection.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.cloud.externalconn.connectionpb;
-option go_package = "connectionpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/cloud/externalconn/connectionpb";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/clusterversion/cluster_version.proto b/pkg/clusterversion/cluster_version.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.clusterversion;
-option go_package = "clusterversion";
+option go_package = "github.com/cockroachdb/cockroach/pkg/clusterversion";
 
 import "roachpb/metadata.proto";
 import "gogoproto/gogo.proto";

diff --git a/pkg/config/system.proto b/pkg/config/system.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto2";
 package cockroach.config;
-option go_package = "config";
+option go_package = "github.com/cockroachdb/cockroach/pkg/config";
 
 import "gogoproto/gogo.proto";
 import "roachpb/data.proto";

diff --git a/pkg/config/zonepb/zone.proto b/pkg/config/zonepb/zone.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto2";
 package cockroach.config.zonepb;
-option go_package = "zonepb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/config/zonepb";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/gen/gen.bzl b/pkg/gen/gen.bzl
@@ -47,7 +47,7 @@ load(":bnf.bzl", "BNF_SRCS")
 _GeneratedFileInfo = provider(
     "Info needed to hoist generated files",
     fields = {
-        "generated_files": "dictionary from prefix to list of files",
+        "generated_files": "dictionary from prefix (destination directory) to list of files",
         "cleanup_tasks": "list of bash commands to run",
     },
 )
@@ -74,12 +74,7 @@ def _go_proto_srcs_impl(ctx):
     generated_files = {}
     for s in ctx.attr._srcs:
         srcs = s[GoSource]
-        lbl = srcs.library.label
-        imp = srcs.library.importpath
-        imp = imp[:imp.find(lbl.package)]
-        prefix = "{}/{}_/{}".format(lbl.package, lbl.name, imp)
-        generated_files[prefix] = [f for f in srcs.srcs]
-
+        generated_files[srcs.library.label.package] = [f for f in srcs.srcs]
     return [
         _GeneratedFileInfo(
             generated_files = generated_files,
@@ -146,8 +141,9 @@ def _hoist_files_impl(ctx):
             if prefix not in generated_files:
                 generated_files[prefix] = []
             for file in files:
-                dst = '"${{BUILD_WORKSPACE_DIRECTORY}}/{}"'.format(
-                    file.short_path[len(prefix):],
+                dst = '"${{BUILD_WORKSPACE_DIRECTORY}}/{}/{}"'.format(
+                    prefix,
+                    file.basename,
                 )
                 src_dst_pairs.append((file.short_path, dst))
                 generated_files[prefix].append(file)

diff --git a/pkg/geo/geoindex/config.proto b/pkg/geo/geoindex/config.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.geo.geoindex;
-option go_package = "geoindex";
+option go_package = "github.com/cockroachdb/cockroach/pkg/geo/geoindex";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/geo/geopb/geopb.proto b/pkg/geo/geopb/geopb.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.geopb;
-option go_package = "geopb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/geo/geopb";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/gossip/gossip.proto b/pkg/gossip/gossip.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.gossip;
-option go_package = "gossip";
+option go_package = "github.com/cockroachdb/cockroach/pkg/gossip";
 
 import "roachpb/data.proto";
 import "util/hlc/timestamp.proto";

diff --git a/pkg/jobs/jobspb/jobs.proto b/pkg/jobs/jobspb/jobs.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.sql.jobs.jobspb;
-option go_package = "jobspb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/jobs/jobspb";
 
 import "errorspb/errors.proto";
 import "gogoproto/gogo.proto";

diff --git a/pkg/jobs/jobspb/schedule.proto b/pkg/jobs/jobspb/schedule.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.jobs.jobspb;
-option go_package = "jobspb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/jobs/jobspb";
 
 import "google/protobuf/any.proto";
 

diff --git a/pkg/keyvisualizer/keyvispb/key_visualizer.proto b/pkg/keyvisualizer/keyvispb/key_visualizer.proto
@@ -11,7 +11,7 @@
 
 syntax = "proto3";
 package cockroach.keyvisualizer.keyvispb;
-option go_package = "keyvispb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/keyvisualizer/keyvispb";
 
 import "roachpb/data.proto";
 import "gogoproto/gogo.proto";

diff --git a/pkg/kv/bulk/bulkpb/bulkpb.proto b/pkg/kv/bulk/bulkpb/bulkpb.proto
@@ -11,7 +11,7 @@
 
 syntax = "proto3";
 package cockroach.kv.bulk.bulkpb;
-option go_package = "bulkpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/bulk/bulkpb";
 
 import "gogoproto/gogo.proto";
 import "util/hlc/timestamp.proto";

diff --git a/pkg/kv/kvnemesis/operations.proto b/pkg/kv/kvnemesis/operations.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvnemesis;
-option go_package = "kvnemesis";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvnemesis";
 
 import "errorspb/errors.proto";
 import "gogoproto/gogo.proto";

diff --git a/pkg/kv/kvpb/api.proto b/pkg/kv/kvpb/api.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.roachpb;
-option go_package = "kvpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvpb";
 
 import "errorspb/errors.proto";
 import "kv/kvserver/concurrency/lock/locking.proto";

diff --git a/pkg/kv/kvpb/errors.proto b/pkg/kv/kvpb/errors.proto
@@ -24,7 +24,7 @@ syntax = "proto2";
 // correct name, the files can be moved into a newly created `kvpb` package
 // at leisure.
 package cockroach.kv.kvpb;
-option go_package = "kvpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvpb";
 
 import "errorspb/errors.proto";
 import "roachpb/data.proto";

diff --git a/pkg/kv/kvserver/api.proto b/pkg/kv/kvserver/api.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver;
-option go_package = "kvserver";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver";
 
 import "roachpb/data.proto";
 import "storage/enginepb/mvcc.proto";

diff --git a/pkg/kv/kvserver/closedts/ctpb/service.proto b/pkg/kv/kvserver/closedts/ctpb/service.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.ctupdate;
-option go_package = "ctpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/closedts/ctpb";
 
 import "roachpb/data.proto";
 import "util/hlc/timestamp.proto";

diff --git a/pkg/kv/kvserver/concurrency/lock/lock_waiter.proto b/pkg/kv/kvserver/concurrency/lock/lock_waiter.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.concurrency.lock;
-option go_package = "lock";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/concurrency/lock";
 
 import "kv/kvserver/concurrency/lock/locking.proto";
 import "storage/enginepb/mvcc3.proto";

diff --git a/pkg/kv/kvserver/concurrency/lock/locking.proto b/pkg/kv/kvserver/concurrency/lock/locking.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.concurrency.lock;
-option go_package = "lock";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/concurrency/lock";
 
 import "gogoproto/gogo.proto";
 import "util/hlc/timestamp.proto";

diff --git a/pkg/kv/kvserver/concurrency/poison/error.proto b/pkg/kv/kvserver/concurrency/poison/error.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.concurrency.poison;
-option go_package = "poison";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/concurrency/poison";
 
 import "util/hlc/timestamp.proto";
 import "roachpb/data.proto";

diff --git a/pkg/kv/kvserver/concurrency/poison/policy.proto b/pkg/kv/kvserver/concurrency/poison/policy.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.concurrency.poison;
-option go_package = "poison";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/concurrency/poison";
 
 // Policy determines how a request will react to encountering a poisoned
 // latch. A poisoned latch is a latch for which the holder is unable to make

diff --git a/pkg/kv/kvserver/kvflowcontrol/kvflowcontrolpb/kvflowcontrol.proto b/pkg/kv/kvserver/kvflowcontrol/kvflowcontrolpb/kvflowcontrol.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.kvflowcontrol.kvflowcontrolpb;
-option go_package = "kvflowcontrolpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvflowcontrol/kvflowcontrolpb";
 
 import "gogoproto/gogo.proto";
 

diff --git a/pkg/kv/kvserver/kvserverpb/lease_status.proto b/pkg/kv/kvserver/kvserverpb/lease_status.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.storagepb;
-option go_package = "kvserverpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvserverpb";
 
 import "roachpb/data.proto";
 import "kv/kvserver/liveness/livenesspb/liveness.proto";

diff --git a/pkg/kv/kvserver/kvserverpb/proposer_kv.proto b/pkg/kv/kvserver/kvserverpb/proposer_kv.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.storagepb;
-option go_package = "kvserverpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvserverpb";
 
 import "kv/kvpb/api.proto";
 import "roachpb/data.proto";

diff --git a/pkg/kv/kvserver/kvserverpb/raft.proto b/pkg/kv/kvserver/kvserverpb/raft.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.kvserverpb;
-option go_package = "kvserverpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvserverpb";
 
 import "errorspb/errors.proto";
 import "kv/kvpb/errors.proto";

diff --git a/pkg/kv/kvserver/kvserverpb/range_log.proto b/pkg/kv/kvserver/kvserverpb/range_log.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.storagepb;
-option go_package = "kvserverpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvserverpb";
 
 import "roachpb/metadata.proto";
 import "gogoproto/gogo.proto";

diff --git a/pkg/kv/kvserver/kvserverpb/state.proto b/pkg/kv/kvserver/kvserverpb/state.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.storagepb;
-option go_package = "kvserverpb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/kvserverpb";
 
 import "storage/enginepb/mvcc.proto";
 import "roachpb/internal_raft.proto";

diff --git a/pkg/kv/kvserver/liveness/livenesspb/liveness.proto b/pkg/kv/kvserver/liveness/livenesspb/liveness.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.liveness.livenesspb;
-option go_package = "livenesspb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/liveness/livenesspb";
 
 import "util/hlc/legacy_timestamp.proto";
 import "gogoproto/gogo.proto";

diff --git a/pkg/kv/kvserver/loqrecovery/loqrecoverypb/recovery.proto b/pkg/kv/kvserver/loqrecovery/loqrecoverypb/recovery.proto
@@ -10,7 +10,7 @@
 
 syntax = "proto3";
 package cockroach.kv.kvserver.loqrecovery.loqrecoverypb;
-option go_package = "loqrecoverypb";
+option go_package = "github.com/cockroachdb/cockroach/pkg/kv/kvserver/loqrecovery/loqrecoverypb";
 
 import "roachpb/data.proto";
 import "roachpb/metadata.proto";