-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding compressReadCloser to ensure underlying resources are closed
- Loading branch information
1 parent
32086ca
commit ecac030
Showing
3 changed files
with
104 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package confighttp | ||
|
||
import "io" | ||
|
||
// compressReadCloser couples the original compressed reader | ||
// and the compression reader to ensure that the original body | ||
// is correctly closed to ensure resources are freed. | ||
type compressReadCloser struct { | ||
io.Reader | ||
orig io.ReadCloser | ||
} | ||
|
||
var ( | ||
_ io.Reader = (*compressReadCloser)(nil) | ||
_ io.Closer = (*compressReadCloser)(nil) | ||
) | ||
|
||
func (crc *compressReadCloser) Close() error { | ||
return crc.orig.Close() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
// Copyright The OpenTelemetry Authors | ||
// SPDX-License-Identifier: Apache-2.0 | ||
|
||
package confighttp | ||
|
||
import ( | ||
"bytes" | ||
"errors" | ||
"io" | ||
"testing" | ||
"testing/iotest" | ||
|
||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
type errorReadCloser struct { | ||
io.Reader | ||
err error | ||
} | ||
|
||
func (erc errorReadCloser) Close() error { | ||
return erc.err | ||
} | ||
|
||
func TestCompressReadCloser(t *testing.T) { | ||
t.Parallel() | ||
|
||
for _, tc := range []struct { | ||
name string | ||
wrapper func(r io.Reader) io.ReadCloser | ||
content []byte | ||
errVal string | ||
}{ | ||
{ | ||
name: "non mutating wrapper", | ||
wrapper: func(r io.Reader) io.ReadCloser { | ||
return errorReadCloser{ | ||
Reader: r, | ||
err: nil, | ||
} | ||
}, | ||
content: []byte("hello world"), | ||
errVal: "", | ||
}, | ||
{ | ||
name: "failed reader", | ||
wrapper: func(r io.Reader) io.ReadCloser { | ||
return errorReadCloser{ | ||
Reader: r, | ||
err: errors.New("failed to close reader"), | ||
} | ||
}, | ||
errVal: "failed to close reader", | ||
}, | ||
} { | ||
tc := tc | ||
t.Run(tc.name, func(t *testing.T) { | ||
t.Parallel() | ||
|
||
orig := bytes.NewBuffer([]byte("hello world")) | ||
|
||
crc := &compressReadCloser{ | ||
Reader: orig, | ||
orig: tc.wrapper(orig), | ||
} | ||
|
||
require.NoError(t, iotest.TestReader(crc, orig.Bytes()), "Must be able to read original content") | ||
|
||
err := crc.Close() | ||
if tc.errVal != "" { | ||
require.EqualError(t, err, tc.errVal, "Must match the expected error message") | ||
} else { | ||
require.NoError(t, err, "Must not error when closing reader") | ||
} | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters