story(notifications): support apache kafka #55
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
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,137 @@ | ||
| // Copyright 2022 Z5Labs and Contributors | ||
| // | ||
| // 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 notification provides a common abstraction over various notification bus services. | ||
| package notification | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| evryspb "github.com/z5labs/evrys/proto" | ||
| ) | ||
|
|
||
| var ( | ||
| ErrMissingLogger = errors.New("logger is required") | ||
| ) | ||
|
|
||
| // Bus | ||
| type Bus interface { | ||
| // Publish | ||
|
|
||
| Publish(context.Context, *evryspb.Notification) error | ||
| } | ||
|
|
||
| // Error represents a generic error a Bus implementation encountered | ||
| type Error struct { | ||
| Bus string | ||
| Cause error | ||
| } | ||
|
|
||
| func (e Error) Error() string { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return fmt.Sprintf("%s: encountered unexpected error: %s", e.Bus, e.Cause) | ||
| } | ||
|
|
||
| func (e Error) Unwrap() error { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return e.Cause | ||
| } | ||
|
|
||
| // MarshalError | ||
| type MarshalError struct { | ||
| Protocol string | ||
| Cause error | ||
| } | ||
|
|
||
| func (e MarshalError) Error() string { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return fmt.Sprintf("%s: failed to marshal notification: %s", e.Protocol, e.Cause) | ||
| } | ||
|
|
||
| func (e MarshalError) Unwrap() error { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return e.Cause | ||
| } | ||
|
|
||
| // ConfigurationError | ||
| type ConfigurationError struct { | ||
| Bus string | ||
| Cause error | ||
| } | ||
|
|
||
| func (e ConfigurationError) Error() string { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return fmt.Sprintf("%s: invalid configuration: %s", e.Bus, e.Cause) | ||
| } | ||
|
|
||
| func (e ConfigurationError) Unwrap() error { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return e.Cause | ||
| } | ||
|
|
||
| // ValidationError | ||
| type ValidationError struct { | ||
| Cause error | ||
| } | ||
|
|
||
| func (e ValidationError) Error() string { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return fmt.Sprintf("notification: must provide a valid notification: %s", e.Cause) | ||
| } | ||
|
|
||
| func (e ValidationError) Unwrap() error { | ||
|
There was a problem hiding this comment. need comment for exported function |
||
| return e.Cause | ||
| } | ||
|
|
||
| var ( | ||
| ErrInvalidEventType = errors.New("event type must be non-empty and non-blank") | ||
| ErrInvalidEventId = errors.New("event id must be non-empty and non-blank") | ||
| ErrInvalidEventSource = errors.New("event source must be non-empty and non-blank") | ||
|
Comment on lines
+93
to
+95
There was a problem hiding this comment. need comments for exported types |
||
| ) | ||
|
|
||
| type validator func(*evryspb.Notification) error | ||
|
|
||
| func validateNotification(n *evryspb.Notification) error { | ||
| validators := []validator{ | ||
| validateEventType, | ||
| validateEventId, | ||
| validateEventSource, | ||
| } | ||
| for _, validator := range validators { | ||
| err := validator(n) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func validateEventType(n *evryspb.Notification) error { | ||
| eventType := strings.TrimSpace(n.EventType) | ||
| if len(eventType) == 0 { | ||
| return ErrInvalidEventType | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func validateEventId(n *evryspb.Notification) error { | ||
| eventId := strings.TrimSpace(n.EventId) | ||
| if len(eventId) == 0 { | ||
| return ErrInvalidEventId | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func validateEventSource(n *evryspb.Notification) error { | ||
| eventSource := strings.TrimSpace(n.EventSource) | ||
| if len(eventSource) == 0 { | ||
| return ErrInvalidEventSource | ||
| } | ||
| return nil | ||
| } | ||
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,142 @@ | ||
| // Copyright 2022 Z5Labs and Contributors | ||
| // | ||
| // 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 notification | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| evryspb "github.com/z5labs/evrys/proto" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestValidateNotification(t *testing.T) { | ||
| t.Run("will report a notification as invalid", func(t *testing.T) { | ||
| testCases := []struct { | ||
| Condition string | ||
| N *evryspb.Notification | ||
| Err error | ||
| }{ | ||
| // Event Type cases | ||
| { | ||
| Condition: "if the event type is not set", | ||
| N: &evryspb.Notification{ | ||
| EventSource: "source", | ||
| EventId: "id", | ||
| }, | ||
| Err: ErrInvalidEventType, | ||
| }, | ||
| { | ||
| Condition: "if the event type is an empty string", | ||
| N: &evryspb.Notification{ | ||
| EventSource: "source", | ||
| EventId: "id", | ||
| EventType: "", | ||
| }, | ||
| Err: ErrInvalidEventType, | ||
| }, | ||
| { | ||
| Condition: "if the event type is a blank string", | ||
| N: &evryspb.Notification{ | ||
| EventSource: "source", | ||
| EventId: "id", | ||
| EventType: " ", | ||
| }, | ||
| Err: ErrInvalidEventType, | ||
| }, | ||
| // Event Id cases | ||
| { | ||
| Condition: "if the event id is not set", | ||
| N: &evryspb.Notification{ | ||
| EventSource: "source", | ||
| EventType: "type", | ||
| }, | ||
| Err: ErrInvalidEventId, | ||
| }, | ||
| { | ||
| Condition: "if the event id is an empty string", | ||
| N: &evryspb.Notification{ | ||
| EventSource: "source", | ||
| EventId: "", | ||
| EventType: "type", | ||
| }, | ||
| Err: ErrInvalidEventId, | ||
| }, | ||
| { | ||
| Condition: "if the event id is a blank string", | ||
| N: &evryspb.Notification{ | ||
| EventSource: "source", | ||
| EventId: " ", | ||
| EventType: "type", | ||
| }, | ||
| Err: ErrInvalidEventId, | ||
| }, | ||
| // Event Source cases | ||
| { | ||
| Condition: "if the event source is not set", | ||
| N: &evryspb.Notification{ | ||
| EventId: "id", | ||
| EventType: "type", | ||
| }, | ||
| Err: ErrInvalidEventSource, | ||
| }, | ||
| { | ||
| Condition: "if the event source is an empty string", | ||
| N: &evryspb.Notification{ | ||
| EventSource: "", | ||
| EventId: "id", | ||
| EventType: "type", | ||
| }, | ||
| Err: ErrInvalidEventSource, | ||
| }, | ||
| { | ||
| Condition: "if the event source is a blank string", | ||
| N: &evryspb.Notification{ | ||
| EventSource: " ", | ||
| EventId: "id", | ||
| EventType: "type", | ||
| }, | ||
| Err: ErrInvalidEventSource, | ||
| }, | ||
| } | ||
|
|
||
| for _, testCase := range testCases { | ||
| t.Run(testCase.Condition, func(t *testing.T) { | ||
| err := validateNotification(testCase.N) | ||
| if !assert.Error(t, err) { | ||
| return | ||
| } | ||
| if !assert.Equal(t, testCase.Err, err) { | ||
| return | ||
| } | ||
| }) | ||
| } | ||
| }) | ||
|
|
||
| t.Run("will report a notification as valid", func(t *testing.T) { | ||
| t.Run("if the event id, source, and type are set to non blank or empty strings", func(t *testing.T) { | ||
| n := &evryspb.Notification{ | ||
| EventSource: "source", | ||
| EventId: "id", | ||
| EventType: "type", | ||
| } | ||
|
|
||
| err := validateNotification(n) | ||
| if !assert.Nil(t, err) { | ||
| return | ||
| } | ||
| }) | ||
| }) | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more descriptive comment needed