From c7f7fd3c181c6975ed87aa9d6e1c83db55aa1398 Mon Sep 17 00:00:00 2001 From: Songlin Yang Date: Thu, 7 Dec 2023 04:33:26 +0800 Subject: [PATCH] chore(*): enable revive linter (#399) enable `revive` linter Signed-off-by: Soren Yang --- .golangci.yaml | 11 ++++++++++- cmd/main.go | 2 +- common/logger.go | 6 +++--- maelstrom/coordinator_rpc_client.go | 2 +- maelstrom/dispatcher.go | 4 ++-- maelstrom/grpc_provider.go | 4 ++-- maelstrom/main.go | 2 +- maelstrom/replication_rpc_provider.go | 2 +- server/leader_controller_test.go | 6 +++--- 9 files changed, 24 insertions(+), 15 deletions(-) diff --git a/.golangci.yaml b/.golangci.yaml index 3893defb..7b3fa8f9 100644 --- a/.golangci.yaml +++ b/.golangci.yaml @@ -27,7 +27,7 @@ linters: - ineffassign - staticcheck - unused - # - revive + - revive - asasalint - asciicheck - bodyclose @@ -64,6 +64,15 @@ linters-settings: local-prefixes: github.com/streamnative/oxia goconst: ignore-tests: true + revive: + rules: + - name: var-naming + severity: warning + disabled: false + arguments: + - ["ID", "RPC"] + - [""] + - - upperCaseConst: false issues: fix: true diff --git a/cmd/main.go b/cmd/main.go index 14003612..a3a08269 100644 --- a/cmd/main.go +++ b/cmd/main.go @@ -49,7 +49,7 @@ func (l LogLevelError) Error() string { func init() { rootCmd.PersistentFlags().StringVarP(&logLevelStr, "log-level", "l", common.DefaultLogLevel.String(), "Set logging level [debug|info|warn|error]") - rootCmd.PersistentFlags().BoolVarP(&common.LogJson, "log-json", "j", false, "Print logs in JSON format") + rootCmd.PersistentFlags().BoolVarP(&common.LogJSON, "log-json", "j", false, "Print logs in JSON format") rootCmd.PersistentFlags().BoolVar(&common.PprofEnable, "profile", false, "Enable pprof profiler") rootCmd.PersistentFlags().StringVar(&common.PprofBindAddress, "profile-bind-address", "127.0.0.1:6060", "Bind address for pprof") diff --git a/common/logger.go b/common/logger.go index d83f3aa0..faad8323 100644 --- a/common/logger.go +++ b/common/logger.go @@ -35,8 +35,8 @@ const DefaultLogLevel = slog.LevelInfo var ( // LogLevel Used for flags. LogLevel slog.Level - // LogJson Used for flags. - LogJson bool + // LogJSON Used for flags. + LogJSON bool ) // ParseLogLevel will convert the slog level configuration to slog.Level values. @@ -76,7 +76,7 @@ func ConfigureLogger() { Stack(). Logger() - if !LogJson { + if !LogJSON { zerologLogger = log.Output(zerolog.ConsoleWriter{ Out: os.Stdout, TimeFormat: time.StampMicro, diff --git a/maelstrom/coordinator_rpc_client.go b/maelstrom/coordinator_rpc_client.go index f2c5fa7c..4d24441e 100644 --- a/maelstrom/coordinator_rpc_client.go +++ b/maelstrom/coordinator_rpc_client.go @@ -135,7 +135,7 @@ func (m *maelstromShardAssignmentClient) Send(response *proto.ShardAssignments) Type: MsgTypeShardAssignmentsResponse, MsgId: msgIdGenerator.Add(1), }, - OxiaMsg: toJson(response), + OxiaMsg: toJSON(response), StreamId: m.streamId, }, } diff --git a/maelstrom/dispatcher.go b/maelstrom/dispatcher.go index 2bfb4cf1..45221b49 100644 --- a/maelstrom/dispatcher.go +++ b/maelstrom/dispatcher.go @@ -338,7 +338,7 @@ func (d *dispatcher) RpcRequest(ctx context.Context, dest string, msgType MsgTyp Type: msgType, MsgId: msgId, }, - OxiaMsg: toJson(message), + OxiaMsg: toJSON(message), }, } @@ -372,7 +372,7 @@ var protoMarshal = protojson.MarshalOptions{ EmitUnpopulated: true, } -func toJson(message pb.Message) []byte { +func toJSON(message pb.Message) []byte { r, err := protoMarshal.Marshal(message) if err != nil { slog.Error( diff --git a/maelstrom/grpc_provider.go b/maelstrom/grpc_provider.go index b5cc3879..4966de16 100644 --- a/maelstrom/grpc_provider.go +++ b/maelstrom/grpc_provider.go @@ -278,7 +278,7 @@ func (m *maelstromGrpcProvider) sendResponse(req *Message[OxiaMessage], msgType MsgId: msgIdGenerator.Add(1), InReplyTo: &req.Body.MsgId, }, - OxiaMsg: toJson(response), + OxiaMsg: toJSON(response), }, }) if err != nil { @@ -366,7 +366,7 @@ func (m *maelstromReplicateServerStream) Send(response *proto.Ack) error { Type: MsgTypeAck, MsgId: msgIdGenerator.Add(1), }, - OxiaMsg: toJson(response), + OxiaMsg: toJSON(response), StreamId: m.streamId, }, }) diff --git a/maelstrom/main.go b/maelstrom/main.go index dd2cf542..a78b94d5 100644 --- a/maelstrom/main.go +++ b/maelstrom/main.go @@ -48,7 +48,7 @@ func (l LogLevelError) Error() string { func init() { rootCmd.PersistentFlags().StringVarP(&logLevelStr, "log-level", "l", common.DefaultLogLevel.String(), "Set logging level [debug|info|warn|error]") - rootCmd.PersistentFlags().BoolVarP(&common.LogJson, "log-json", "j", false, "Print logs in JSON format") + rootCmd.PersistentFlags().BoolVarP(&common.LogJSON, "log-json", "j", false, "Print logs in JSON format") } func configureLogLevel(cmd *cobra.Command, args []string) error { diff --git a/maelstrom/replication_rpc_provider.go b/maelstrom/replication_rpc_provider.go index 6276257f..bb0d9131 100644 --- a/maelstrom/replication_rpc_provider.go +++ b/maelstrom/replication_rpc_provider.go @@ -108,7 +108,7 @@ func (m *maelstromReplicateClient) Send(request *proto.Append) error { Type: MsgTypeAppend, MsgId: msgIdGenerator.Add(1), }, - OxiaMsg: toJson(request), + OxiaMsg: toJSON(request), StreamId: m.streamId, }, }) diff --git a/server/leader_controller_test.go b/server/leader_controller_test.go index f8a16251..dc892152 100644 --- a/server/leader_controller_test.go +++ b/server/leader_controller_test.go @@ -35,9 +35,9 @@ func AssertProtoEqual(t *testing.T, expected, actual pb.Message) { protoMarshal := protojson.MarshalOptions{ EmitUnpopulated: true, } - expectedJson, _ := protoMarshal.Marshal(expected) - actualJson, _ := protoMarshal.Marshal(actual) - assert.Equal(t, string(expectedJson), string(actualJson)) + expectedJSON, _ := protoMarshal.Marshal(expected) + actualJSON, _ := protoMarshal.Marshal(actual) + assert.Equal(t, string(expectedJSON), string(actualJSON)) } }