Skip to content

Commit

Permalink
encoding: fix duplicate compressor names (#5958)
Browse files Browse the repository at this point in the history
  • Loading branch information
jronak authored Jan 24, 2023
1 parent 4adb2a7 commit e5a0237
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 1 deletion.
4 changes: 3 additions & 1 deletion encoding/encoding.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,9 @@ var registeredCompressor = make(map[string]Compressor)
// registered with the same name, the one registered last will take effect.
func RegisterCompressor(c Compressor) {
registeredCompressor[c.Name()] = c
grpcutil.RegisteredCompressorNames = append(grpcutil.RegisteredCompressorNames, c.Name())
if !grpcutil.IsCompressorNameRegistered(c.Name()) {
grpcutil.RegisteredCompressorNames = append(grpcutil.RegisteredCompressorNames, c.Name())
}
}

// GetCompressor returns Compressor for the given compressor name.
Expand Down
55 changes: 55 additions & 0 deletions encoding/encoding_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
*
* Copyright 2023 gRPC authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/

package encoding

import (
"testing"

"github.com/google/go-cmp/cmp"
"google.golang.org/grpc/internal/grpcutil"
)

type mockNamedCompressor struct {
Compressor
}

func (mockNamedCompressor) Name() string {
return "mock-compressor"
}

func TestDuplicateCompressorRegister(t *testing.T) {
defer func(m map[string]Compressor) { registeredCompressor = m }(registeredCompressor)
defer func(c []string) { grpcutil.RegisteredCompressorNames = c }(grpcutil.RegisteredCompressorNames)
registeredCompressor = map[string]Compressor{}
grpcutil.RegisteredCompressorNames = []string{}

RegisterCompressor(&mockNamedCompressor{})

// Register another instance of the same compressor.
mc := &mockNamedCompressor{}
RegisterCompressor(mc)
if got := registeredCompressor["mock-compressor"]; got != mc {
t.Fatalf("Unexpected compressor, got: %+v, want:%+v", got, mc)
}

wantNames := []string{"mock-compressor"}
if !cmp.Equal(wantNames, grpcutil.RegisteredCompressorNames) {
t.Fatalf("Unexpected compressor names, got: %+v, want:%+v", grpcutil.RegisteredCompressorNames, wantNames)
}
}

0 comments on commit e5a0237

Please sign in to comment.