refactor(ingest): use fixed Kafka event topic #5017
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,42 @@ | ||
| package common | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/openmeterio/openmeter/app/config" | ||
| ) | ||
|
|
||
| func TestNewEventTopic(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| ingestConfig config.KafkaIngestConfiguration | ||
| namespaceConfig config.NamespaceConfiguration | ||
| expected EventTopic | ||
| }{ | ||
| { | ||
| name: "explicit topic", | ||
| ingestConfig: config.KafkaIngestConfiguration{ | ||
| EventsTopic: "events", | ||
| EventsTopicTemplate: "om_%s_events", | ||
| }, | ||
| namespaceConfig: config.NamespaceConfiguration{Default: "default"}, | ||
| expected: EventTopic("events"), | ||
| }, | ||
| { | ||
| name: "default namespace fallback", | ||
| ingestConfig: config.KafkaIngestConfiguration{ | ||
| EventsTopicTemplate: "om_%s_events", | ||
| }, | ||
| namespaceConfig: config.NamespaceConfiguration{Default: "default"}, | ||
| expected: EventTopic("om_default_events"), | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| assert.Equal(t, test.expected, NewEventTopic(test.ingestConfig, test.namespaceConfig)) | ||
| }) | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,103 @@ | ||
| package kafkaingest | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "testing" | ||
|
|
||
| cloudevents "github.com/cloudevents/sdk-go/v2/event" | ||
| "github.com/confluentinc/confluent-kafka-go/v2/kafka" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.opentelemetry.io/otel/trace/noop" | ||
|
|
||
| "github.com/openmeterio/openmeter/openmeter/testutils" | ||
| pkgkafka "github.com/openmeterio/openmeter/pkg/kafka" | ||
| ) | ||
|
|
||
| type recordingSerializer struct { | ||
| topics []string | ||
| err error | ||
| } | ||
|
|
||
| func (s *recordingSerializer) SerializeKey(topic string, _ string, _ cloudevents.Event) ([]byte, error) { | ||
| s.topics = append(s.topics, topic) | ||
|
|
||
| return nil, s.err | ||
| } | ||
|
|
||
| func (s *recordingSerializer) SerializeValue(_ string, _ cloudevents.Event) ([]byte, error) { | ||
| return nil, nil | ||
|
Comment on lines
+18
to
+30
Contributor
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Exercise both serializer calls in the fixed-topic test.
As per path instructions, tests must be comprehensive and cover the changes. Suggested test adjustment type recordingSerializer struct {
topics []string
+ valueTopics []string
err error
}
func (s *recordingSerializer) SerializeKey(topic string, _ string, _ cloudevents.Event) ([]byte, error) {
s.topics = append(s.topics, topic)
- return nil, s.err
+ return nil, nil
}
-func (s *recordingSerializer) SerializeValue(_ string, _ cloudevents.Event) ([]byte, error) {
- return nil, nil
+func (s *recordingSerializer) SerializeValue(topic string, _ cloudevents.Event) ([]byte, error) {
+ s.valueTopics = append(s.valueTopics, topic)
+ return nil, s.err
}
+ assert.Equal(t, []string{"om_default_events", "om_default_events"}, serializer.valueTopics)Also applies to: 59-87 🤖 Prompt for AI AgentsSource: Path instructions |
||
| } | ||
|
|
||
| func (s *recordingSerializer) GetFormat() string { | ||
| return "" | ||
| } | ||
|
|
||
| func (s *recordingSerializer) GetKeySchemaId() int { | ||
| return 0 | ||
| } | ||
|
|
||
| func (s *recordingSerializer) GetValueSchemaId() int { | ||
| return 0 | ||
| } | ||
|
|
||
| type recordingTopicProvisioner struct { | ||
| topics []pkgkafka.TopicConfig | ||
| } | ||
|
|
||
| func (p *recordingTopicProvisioner) Provision(_ context.Context, topics ...pkgkafka.TopicConfig) error { | ||
| p.topics = append(p.topics, topics...) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (p *recordingTopicProvisioner) DeProvision(_ context.Context, _ ...string) error { | ||
| return nil | ||
| } | ||
|
|
||
| func TestCollectorUsesFixedTopic(t *testing.T) { | ||
| serializerError := errors.New("stop before producing") | ||
| serializer := &recordingSerializer{err: serializerError} | ||
| provisioner := &recordingTopicProvisioner{} | ||
|
|
||
| collector, err := NewCollector( | ||
| &kafka.Producer{}, | ||
| serializer, | ||
| "om_default_events", | ||
| provisioner, | ||
| 1, | ||
| testutils.NewDiscardLogger(t), | ||
| noop.NewTracerProvider().Tracer("test"), | ||
| ) | ||
| require.NoError(t, err) | ||
|
|
||
| ev := cloudevents.New() | ||
| ev.SetID("event-id") | ||
|
|
||
| for _, namespace := range []string{"default", "customer"} { | ||
| err = collector.Ingest(t.Context(), namespace, ev) | ||
| require.ErrorIs(t, err, serializerError) | ||
| } | ||
|
|
||
| assert.Equal(t, []string{"om_default_events", "om_default_events"}, serializer.topics) | ||
| assert.Equal(t, []pkgkafka.TopicConfig{ | ||
| {Name: "om_default_events", Partitions: 1}, | ||
| {Name: "om_default_events", Partitions: 1}, | ||
| }, provisioner.topics) | ||
| } | ||
|
|
||
| func TestNewCollectorRequiresTopic(t *testing.T) { | ||
| collector, err := NewCollector( | ||
| &kafka.Producer{}, | ||
| &recordingSerializer{}, | ||
| "", | ||
| &recordingTopicProvisioner{}, | ||
| 1, | ||
| testutils.NewDiscardLogger(t), | ||
| noop.NewTracerProvider().Tracer("test"), | ||
| ) | ||
|
|
||
| require.EqualError(t, err, "topic is required") | ||
| assert.Nil(t, collector) | ||
| } | ||
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.
If
ingest.kafka.eventsTopicis set to a valid Kafka topic such aseventsorom_events,NewEventTopicreturns it unchanged while the sink subscribes only to topics matching its namespace-topic regexp. Events are accepted and queued in Kafka, but the sink never consumes them for storage or usage aggregation.Prompt To Fix With AI
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.
The regexp used for topic name matching can be set in the sink worker configuration.
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.
You're right—the sink's
NamespaceTopicRegexpis configurable, so an explicitingest.kafka.eventsTopicis supported as long as the sink configuration matches it. My original comment treated the default regexp as invariant, which was too strong. The remaining concern is only an operational misconfiguration risk: the ingest topic and sink regexp are independent, so a mismatch would leave events unconsumed. I don't consider that a blocking defect in this PR and would withdraw the finding.