luciano/amazon-kinesis-client-go
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Simplify main function's name.

Browse source
This commit is contained in:
Taylor Sutton 2020-11-16 17:37:53 -05:00
parent cc4f7716b3
commit 42c3480288
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
splitter/splitter.go
View file

@ -5,7 +5,7 @@
// CloudWatch bundles. KCL automatically unbundles KPL aggregates before passing the records to the consumer. // CloudWatch bundles. KCL automatically unbundles KPL aggregates before passing the records to the consumer.
// Non-KCL applications (such as Lambdas consuming KPL-produced aggregates) should either use // Non-KCL applications (such as Lambdas consuming KPL-produced aggregates) should either use
// - KPLDeaggregate if the consumer purely wants to unbundle KPL aggregates, but will handle the raw records themselves. // - KPLDeaggregate if the consumer purely wants to unbundle KPL aggregates, but will handle the raw records themselves.
// - DeaggregateAndSplitIfNecessary if the consumer wants to apply the same decompress and split logic as SplitMessageIfNecessary // - Deaggregate if the consumer wants to apply the same decompress and split logic as SplitMessageIfNecessary
// in addition to the KPL splitting. // in addition to the KPL splitting.
package splitter package splitter
@ -65,7 +65,7 @@ func KPLDeaggregate(kinesisRecord []byte) ([][]byte, error) {
return records, nil return records, nil
} }
// DeaggregateAndSplitIfNecessary is a combination of KPLDeaggregate and SplitMessageIfNecessary // Deaggregate is a combination of KPLDeaggregate and SplitMessageIfNecessary
// First it tries to KPL-deaggregate. If unsuccessful, it calls SplitIfNecessary on the original record. // First it tries to KPL-deaggregate. If unsuccessful, it calls SplitIfNecessary on the original record.
// If successful, it iterates over the individual user records and attempts to unzlib them. // If successful, it iterates over the individual user records and attempts to unzlib them.
// If a record inside an aggregate is in zlib format, the output will contain the unzlibbed version. // If a record inside an aggregate is in zlib format, the output will contain the unzlibbed version.
@ -75,7 +75,7 @@ func KPLDeaggregate(kinesisRecord []byte) ([][]byte, error) {
// Also it lets us iterate over the user records one less time, since KPLDeaggregate loops over the records and we would need to loop again to unzlib. // Also it lets us iterate over the user records one less time, since KPLDeaggregate loops over the records and we would need to loop again to unzlib.
// //
// See the SplitMessageIfNecessary documentation for the format of output for CloudWatch log bundles. // See the SplitMessageIfNecessary documentation for the format of output for CloudWatch log bundles.
func DeaggregateAndSplitIfNecessary(kinesisRecord []byte) ([][]byte, error) { func Deaggregate(kinesisRecord []byte) ([][]byte, error) {
if !IsKPLAggregate(kinesisRecord) { if !IsKPLAggregate(kinesisRecord) {
return SplitMessageIfNecessary(kinesisRecord) return SplitMessageIfNecessary(kinesisRecord)
} }

4
splitter/splitter_test.go
View file

@ -448,7 +448,7 @@ func TestKPLDeaggregate(t *testing.T) {
} }
} }
func TestDeaggregateAndSplit(t *testing.T) { func TestDeaggregate(t *testing.T) {
type test struct { type test struct {
description string description string
input []byte input []byte
@ -542,7 +542,7 @@ func TestDeaggregateAndSplit(t *testing.T) {
}) })
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) { t.Run(tt.description, func(t *testing.T) {
out, err := DeaggregateAndSplitIfNecessary(tt.input) out, err := Deaggregate(tt.input)
if tt.shouldError { if tt.shouldError {
assert.Error(t, err) assert.Error(t, err)