[WIP] *: use buf to format the proto files

.github/workflows/unit-test.yml

@@ -3,6 +3,15 @@ name: "Unit Test"
 on: [ push,pull_request ]
 
 jobs:
+  proto-format:
+    name: Check proto format
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Check format
+        run: make proto-fmt-check
+
   go:
     name: Test go generation
     runs-on: ubuntu-latest

Makefile

@@ -1,4 +1,4 @@
-.PHONY: all go rust c++
+.PHONY: all dependence check proto-fmt proto-fmt-check go rust c++
 
 CURDIR := $(shell pwd)
 
@@ -13,6 +13,12 @@ dependence:
 check: dependence
 	./scripts/check.sh
 
+proto-fmt:
+	./scripts/proto_format.sh --write
+
+proto-fmt-check:
+	./scripts/proto_format.sh --check
+
 go: dependence check
 	./scripts/generate-go.sh
 	GO111MODULE=on go mod tidy

README.md

@@ -8,6 +8,13 @@ TiDB protobuf files
 
 We use `protoc` 3.5.1, to download: [protobuf/releases/tag/v3.5.1](https://github.com/google/protobuf/releases/tag/v3.5.1)
 
+## Proto formatting
+
+To avoid IDE-induced diffs, we use `buf format` to keep `.proto` files consistently formatted.
+
+- Check formatting (also runs as part of `make check`): `make proto-fmt-check`
+- Format in-place: `make proto-fmt`
+
 ## Generate the Go and Rust codes
 
 ```sh

include/rustproto.proto

@@ -1,47 +1,47 @@
 syntax = "proto2";
 
-import "google/protobuf/descriptor.proto";
-
 // see https://github.com/gogo/protobuf/blob/master/gogoproto/gogo.proto
 // for the original idea
 
 package rustproto;
 
+import "google/protobuf/descriptor.proto";
+
 extend google.protobuf.FileOptions {
-    // When true, oneof field is generated public
-    optional bool expose_oneof_all = 17001;
-    // When true all fields are public, and not accessors generated
-    optional bool expose_fields_all = 17003;
-    // When false, `get_`, `set_`, `mut_` etc. accessors are not generated
-    optional bool generate_accessors_all = 17004;
-    // Use `bytes::Bytes` for `bytes` fields
-    optional bool carllerche_bytes_for_bytes_all = 17011;
-    // Use `bytes::Bytes` for `string` fields
-    optional bool carllerche_bytes_for_string_all = 17012;
-    // When true, will only generate codes that works with lite runtime.
-    optional bool lite_runtime_all = 17035;
+  // When true, oneof field is generated public
+  optional bool expose_oneof_all = 17001;
+  // When true all fields are public, and not accessors generated
+  optional bool expose_fields_all = 17003;
+  // When false, `get_`, `set_`, `mut_` etc. accessors are not generated
+  optional bool generate_accessors_all = 17004;
+  // Use `bytes::Bytes` for `bytes` fields
+  optional bool carllerche_bytes_for_bytes_all = 17011;
+  // Use `bytes::Bytes` for `string` fields
+  optional bool carllerche_bytes_for_string_all = 17012;
+  // When true, will only generate codes that works with lite runtime.
+  optional bool lite_runtime_all = 17035;
 }
 
 extend google.protobuf.MessageOptions {
-    // When true, oneof field is generated public
-    optional bool expose_oneof = 17001;
-    // When true all fields are public, and not accessors generated
-    optional bool expose_fields = 17003;
-    // When false, `get_`, `set_`, `mut_` etc. accessors are not generated
-    optional bool generate_accessors = 17004;
-    // Use `bytes::Bytes` for `bytes` fields
-    optional bool carllerche_bytes_for_bytes = 17011;
-    // Use `bytes::Bytes` for `string` fields
-    optional bool carllerche_bytes_for_string = 17012;
+  // When true, oneof field is generated public
+  optional bool expose_oneof = 17001;
+  // When true all fields are public, and not accessors generated
+  optional bool expose_fields = 17003;
+  // When false, `get_`, `set_`, `mut_` etc. accessors are not generated
+  optional bool generate_accessors = 17004;
+  // Use `bytes::Bytes` for `bytes` fields
+  optional bool carllerche_bytes_for_bytes = 17011;
+  // Use `bytes::Bytes` for `string` fields
+  optional bool carllerche_bytes_for_string = 17012;
 }
 
 extend google.protobuf.FieldOptions {
-    // When true all fields are public, and not accessors generated
-    optional bool expose_fields_field = 17003;
-    // When false, `get_`, `set_`, `mut_` etc. accessors are not generated
-    optional bool generate_accessors_field = 17004;
-    // Use `bytes::Bytes` for `bytes` fields
-    optional bool carllerche_bytes_for_bytes_field = 17011;
-    // Use `bytes::Bytes` for `string` fields
-    optional bool carllerche_bytes_for_string_field = 17012;
-}
+  // When true all fields are public, and not accessors generated
+  optional bool expose_fields_field = 17003;
+  // When false, `get_`, `set_`, `mut_` etc. accessors are not generated
+  optional bool generate_accessors_field = 17004;
+  // Use `bytes::Bytes` for `bytes` fields
+  optional bool carllerche_bytes_for_bytes_field = 17011;
+  // Use `bytes::Bytes` for `string` fields
+  optional bool carllerche_bytes_for_string_field = 17012;
+}

proto/analyze.proto

@@ -2,175 +2,173 @@ syntax = "proto2";
 
 package tipb;
 
-option java_multiple_files = true;
-option java_package = "com.pingcap.tidb.tipb";
-
-import "schema.proto";
-
 import "gogoproto/gogo.proto";
 import "rustproto.proto";
+import "schema.proto";
 
+option java_multiple_files = true;
+option java_package = "com.pingcap.tidb.tipb";
+option (gogoproto.goproto_sizecache_all) = false;
+option (gogoproto.goproto_unkeyed_all) = false;
+option (gogoproto.goproto_unrecognized_all) = false;
 option (gogoproto.marshaler_all) = true;
 option (gogoproto.sizer_all) = true;
 option (gogoproto.unmarshaler_all) = true;
-option (gogoproto.goproto_unkeyed_all) = false;
-option (gogoproto.goproto_unrecognized_all) = false;
-option (gogoproto.goproto_sizecache_all) = false;
 option (rustproto.lite_runtime_all) = true;
 
 enum AnalyzeType {
-    TypeIndex = 0;
-    TypeColumn = 1;
-    TypeCommonHandle = 2;
-    TypeSampleIndex = 3;
-    TypeMixed = 4;
-    TypeFullSampling = 5;
+  TypeIndex = 0;
+  TypeColumn = 1;
+  TypeCommonHandle = 2;
+  TypeSampleIndex = 3;
+  TypeMixed = 4;
+  TypeFullSampling = 5;
 }
 
 message AnalyzeReq {
-    optional AnalyzeType tp = 1 [(gogoproto.nullable) = false];
-    // Deprecated. Start Ts has been moved to coprocessor.Request.
-    optional uint64 start_ts_fallback = 2;
-    optional uint64 flags = 3 [(gogoproto.nullable) = false];
-    optional int64 time_zone_offset = 4 [(gogoproto.nullable) = false];
-    optional AnalyzeIndexReq idx_req = 5;
-    optional AnalyzeColumnsReq col_req = 6;
+  optional AnalyzeType tp = 1 [(gogoproto.nullable) = false];
+  // Deprecated. Start Ts has been moved to coprocessor.Request.
+  optional uint64 start_ts_fallback = 2;
+  optional uint64 flags = 3 [(gogoproto.nullable) = false];
+  optional int64 time_zone_offset = 4 [(gogoproto.nullable) = false];
+  optional AnalyzeIndexReq idx_req = 5;
+  optional AnalyzeColumnsReq col_req = 6;
 }
 
 message AnalyzeIndexReq {
-    // bucket_size is the max histograms bucket size.
-    optional int64 bucket_size = 1 [(gogoproto.nullable) = false];
+  // bucket_size is the max histograms bucket size.
+  optional int64 bucket_size = 1 [(gogoproto.nullable) = false];
 
-    // num_columns is the number of columns in the index.
-    optional int32 num_columns = 2 [(gogoproto.nullable) = false];
+  // num_columns is the number of columns in the index.
+  optional int32 num_columns = 2 [(gogoproto.nullable) = false];
 
-    optional int32 cmsketch_depth = 3;
+  optional int32 cmsketch_depth = 3;
 
-    optional int32 cmsketch_width = 4;
+  optional int32 cmsketch_width = 4;
 
-    optional int64 sample_size = 5 [(gogoproto.nullable) = false];
+  optional int64 sample_size = 5 [(gogoproto.nullable) = false];
 
-    optional int64 sketch_size = 6 [(gogoproto.nullable) = false];
+  optional int64 sketch_size = 6 [(gogoproto.nullable) = false];
 
-    optional int32 top_n_size = 7;
+  optional int32 top_n_size = 7;
 
-    optional int32 version = 8;
+  optional int32 version = 8;
 }
 
 message AnalyzeColumnsReq {
-    // bucket_size is the max histograms bucket size, we need this because when primary key is handle,
-    // the histogram will be directly built.
-    optional int64 bucket_size = 1 [(gogoproto.nullable) = false];
+  // bucket_size is the max histograms bucket size, we need this because when primary key is handle,
+  // the histogram will be directly built.
+  optional int64 bucket_size = 1 [(gogoproto.nullable) = false];
 
-    // sample_size is the max number of samples that will be collected.
-    optional int64 sample_size = 2 [(gogoproto.nullable) = false];
+  // sample_size is the max number of samples that will be collected.
+  optional int64 sample_size = 2 [(gogoproto.nullable) = false];
 
-    // sketch_size is the max sketch size.
-    optional int64 sketch_size = 3 [(gogoproto.nullable) = false];
+  // sketch_size is the max sketch size.
+  optional int64 sketch_size = 3 [(gogoproto.nullable) = false];
 
-    // columns_info is the info of all the columns that needs to be analyzed.
-    repeated ColumnInfo columns_info = 4;
+  // columns_info is the info of all the columns that needs to be analyzed.
+  repeated ColumnInfo columns_info = 4;
 
-    optional int32 cmsketch_depth = 5;
+  optional int32 cmsketch_depth = 5;
 
-    optional int32 cmsketch_width = 6;
+  optional int32 cmsketch_width = 6;
 
-    repeated int64 primary_column_ids = 7;
+  repeated int64 primary_column_ids = 7;
 
-    optional int32 version = 8;
+  optional int32 version = 8;
 
-    repeated int64 primary_prefix_column_ids = 9;
+  repeated int64 primary_prefix_column_ids = 9;
 
-    repeated AnalyzeColumnGroup column_groups = 10;
-    // sample_rate is the sampling rate that how many samples will collected.
-    // There must be one non-zero value in sample_rate and sample_size.
-    optional double sample_rate = 11;
+  repeated AnalyzeColumnGroup column_groups = 10;
+  // sample_rate is the sampling rate that how many samples will collected.
+  // There must be one non-zero value in sample_rate and sample_size.
+  optional double sample_rate = 11;
 }
 
 message AnalyzeMixedResp {
-    optional AnalyzeColumnsResp columns_resp = 1;
+  optional AnalyzeColumnsResp columns_resp = 1;
 
-    optional AnalyzeIndexResp index_resp = 2;
+  optional AnalyzeIndexResp index_resp = 2;
 }
 
 message AnalyzeColumnGroup {
-    repeated int64 column_offsets = 1;
-    repeated int64 prefix_lengths = 2;
+  repeated int64 column_offsets = 1;
+  repeated int64 prefix_lengths = 2;
 }
 
 message AnalyzeColumnsResp {
-    // collectors is the sample collectors for columns.
-    repeated SampleCollector collectors = 1;
+  // collectors is the sample collectors for columns.
+  repeated SampleCollector collectors = 1;
 
-    // pk_hist is the histogram for primary key when it is the handle.
-    optional Histogram pk_hist = 2;
+  // pk_hist is the histogram for primary key when it is the handle.
+  optional Histogram pk_hist = 2;
 
-    optional RowSampleCollector row_collector = 3;
+  optional RowSampleCollector row_collector = 3;
 }
 
 message AnalyzeIndexResp {
-    optional Histogram hist = 1;
-    optional CMSketch cms = 2;
-    optional SampleCollector collector = 3;
+  optional Histogram hist = 1;
+  optional CMSketch cms = 2;
+  optional SampleCollector collector = 3;
 }
 
 // Bucket is an element of histogram.
 message Bucket {
-    optional int64 count = 1 [(gogoproto.nullable) = false];
-    optional bytes lower_bound = 2;
-    optional bytes upper_bound = 3;
-    optional int64 repeats = 4 [(gogoproto.nullable) = false];
-    optional int64 ndv = 5;
+  optional int64 count = 1 [(gogoproto.nullable) = false];
+  optional bytes lower_bound = 2;
+  optional bytes upper_bound = 3;
+  optional int64 repeats = 4 [(gogoproto.nullable) = false];
+  optional int64 ndv = 5;
 }
 
 message Histogram {
-    // ndv is the number of distinct values.
-    optional int64 ndv = 1 [(gogoproto.nullable) = false];
+  // ndv is the number of distinct values.
+  optional int64 ndv = 1 [(gogoproto.nullable) = false];
 
-    // buckets represents all the buckets.
-    repeated Bucket buckets = 2;
+  // buckets represents all the buckets.
+  repeated Bucket buckets = 2;
 }
 
 // FMSketch is used to count distinct values for columns.
 message FMSketch {
-    optional uint64 mask = 1 [(gogoproto.nullable) = false];
-    repeated uint64 hashset = 2;
+  optional uint64 mask = 1 [(gogoproto.nullable) = false];
+  repeated uint64 hashset = 2;
 }
 
 // SampleCollector is used for collect samples and calculate the count and ndv of an column.
 message SampleCollector {
-    repeated bytes samples = 1;
-    optional int64 null_count = 2 [(gogoproto.nullable) = false];
-    optional int64 count = 3 [(gogoproto.nullable) = false];
-    optional FMSketch fm_sketch = 4;
-    optional CMSketch cm_sketch = 5;
-    optional int64 total_size = 6;
+  repeated bytes samples = 1;
+  optional int64 null_count = 2 [(gogoproto.nullable) = false];
+  optional int64 count = 3 [(gogoproto.nullable) = false];
+  optional FMSketch fm_sketch = 4;
+  optional CMSketch cm_sketch = 5;
+  optional int64 total_size = 6;
 }
 
 message RowSampleCollector {
-    repeated RowSample samples = 1;
-    repeated int64 null_counts = 2 [(gogoproto.nullable) = false];
-    optional int64 count = 3 [(gogoproto.nullable) = false];
-    repeated FMSketch fm_sketch = 4;
-    repeated int64 total_size = 5;
+  repeated RowSample samples = 1;
+  repeated int64 null_counts = 2 [(gogoproto.nullable) = false];
+  optional int64 count = 3 [(gogoproto.nullable) = false];
+  repeated FMSketch fm_sketch = 4;
+  repeated int64 total_size = 5;
 }
 
 message RowSample {
-    repeated bytes row = 1;
-    optional int64 weight = 2 [(gogoproto.nullable) = false];
+  repeated bytes row = 1;
+  optional int64 weight = 2 [(gogoproto.nullable) = false];
 }
 
 message CMSketchRow {
-    repeated uint32 counters = 1;
+  repeated uint32 counters = 1;
 }
 
 message CMSketchTopN {
-    optional bytes data = 1;
-    optional uint64 count = 2 [(gogoproto.nullable) = false];
+  optional bytes data = 1;
+  optional uint64 count = 2 [(gogoproto.nullable) = false];
 }
 
 message CMSketch {
-    repeated CMSketchRow rows = 1;
-    repeated CMSketchTopN top_n = 2;
-    optional uint64 default_value = 3 [(gogoproto.nullable) = false];
+  repeated CMSketchRow rows = 1;
+  repeated CMSketchTopN top_n = 2;
+  optional uint64 default_value = 3 [(gogoproto.nullable) = false];
 }