Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add consumer proto schema validation for pulsar #3014

Merged
merged 5 commits into from
Jul 25, 2023
Merged

Add consumer proto schema validation for pulsar #3014

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c58dccf
add consumer proto schema validation for pulsar
yaron2 Jul 25, 2023
83ca190
Merge branch 'master' into pulsarproto
yaron2 Jul 25, 2023
06ab704
Update pubsub/pulsar/pulsar_test.go
yaron2 Jul 25, 2023
606b29d
changed to switch
yaron2 Jul 25, 2023
790fd6c
Merge branch 'pulsarproto' of github.com:yaron2/components-contrib-1 …
yaron2 Jul 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 16 additions & 6 deletions pubsub/pulsar/pulsar.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ const (
redeliveryDelay = "redeliveryDelay"
avroProtocol = "avro"
jsonProtocol = "json"
protoProtocol = "proto"
partitionKey = "partitionKey"

defaultTenant = "public"
Expand All @@ -61,11 +62,12 @@ const (
pulsarToken = "token"
// topicFormat is the format for pulsar, which have a well-defined structure: {persistent|non-persistent}://tenant/namespace/topic,
// see https://pulsar.apache.org/docs/en/concepts-messaging/#topics for details.
topicFormat = "%s://%s/%s/%s"
persistentStr = "persistent"
nonPersistentStr = "non-persistent"
topicJSONSchemaIdentifier = ".jsonschema"
topicAvroSchemaIdentifier = ".avroschema"
topicFormat = "%s://%s/%s/%s"
persistentStr = "persistent"
nonPersistentStr = "non-persistent"
topicJSONSchemaIdentifier = ".jsonschema"
topicAvroSchemaIdentifier = ".avroschema"
topicProtoSchemaIdentifier = ".protoschema"

// defaultBatchingMaxPublishDelay init default for maximum delay to batch messages.
defaultBatchingMaxPublishDelay = 10 * time.Millisecond
Expand Down Expand Up @@ -137,11 +139,17 @@ func parsePulsarMetadata(meta pubsub.Metadata) (*pulsarMetadata, error) {
value: v,
}
} else if strings.HasSuffix(k, topicAvroSchemaIdentifier) {
topic := k[:len(k)-len(topicJSONSchemaIdentifier)]
topic := k[:len(k)-len(topicAvroSchemaIdentifier)]
yaron2 marked this conversation as resolved.
Show resolved Hide resolved
m.internalTopicSchemas[topic] = schemaMetadata{
protocol: avroProtocol,
value: v,
}
} else if strings.HasSuffix(k, topicProtoSchemaIdentifier) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Total nit, but since we have 3 cases now it may be nice to change this to a switch

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed

topic := k[:len(k)-len(topicProtoSchemaIdentifier)]
m.internalTopicSchemas[topic] = schemaMetadata{
protocol: protoProtocol,
value: v,
}
}
}

Expand Down Expand Up @@ -267,6 +275,8 @@ func getPulsarSchema(metadata schemaMetadata) pulsar.Schema {
return pulsar.NewJSONSchema(metadata.value, nil)
case avroProtocol:
return pulsar.NewAvroSchema(metadata.value, nil)
case protoProtocol:
return pulsar.NewProtoSchema(metadata.value, nil)
default:
return nil
}
Expand Down
37 changes: 37 additions & 0 deletions pubsub/pulsar/pulsar_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,22 @@ func TestParsePulsarSchemaMetadata(t *testing.T) {
assert.Equal(t, "2", meta.internalTopicSchemas["kenobi.avroschema"].value)
})

t.Run("test proto", func(t *testing.T) {
m := pubsub.Metadata{}
m.Properties = map[string]string{
"host": "a",
"obiwan.avroschema": "1",
"kenobi.protoschema.protoschema": "2",
}
meta, err := parsePulsarMetadata(m)

assert.Nil(t, err)
yaron2 marked this conversation as resolved.
Show resolved Hide resolved
assert.Equal(t, "a", meta.Host)
assert.Len(t, meta.internalTopicSchemas, 2)
assert.Equal(t, "1", meta.internalTopicSchemas["obiwan"].value)
assert.Equal(t, "2", meta.internalTopicSchemas["kenobi.protoschema"].value)
})

t.Run("test combined avro/json", func(t *testing.T) {
m := pubsub.Metadata{}
m.Properties = map[string]string{
Expand All @@ -98,6 +114,27 @@ func TestParsePulsarSchemaMetadata(t *testing.T) {
assert.Equal(t, jsonProtocol, meta.internalTopicSchemas["kenobi"].protocol)
})

t.Run("test combined avro/json/proto", func(t *testing.T) {
m := pubsub.Metadata{}
m.Properties = map[string]string{
"host": "a",
"obiwan.avroschema": "1",
"kenobi.jsonschema": "2",
"darth.protoschema": "3",
}
meta, err := parsePulsarMetadata(m)

assert.Nil(t, err)
assert.Equal(t, "a", meta.Host)
assert.Len(t, meta.internalTopicSchemas, 3)
assert.Equal(t, "1", meta.internalTopicSchemas["obiwan"].value)
assert.Equal(t, "2", meta.internalTopicSchemas["kenobi"].value)
assert.Equal(t, "3", meta.internalTopicSchemas["darth"].value)
assert.Equal(t, avroProtocol, meta.internalTopicSchemas["obiwan"].protocol)
assert.Equal(t, jsonProtocol, meta.internalTopicSchemas["kenobi"].protocol)
assert.Equal(t, protoProtocol, meta.internalTopicSchemas["darth"].protocol)
})

t.Run("test funky edge case", func(t *testing.T) {
m := pubsub.Metadata{}
m.Properties = map[string]string{
Expand Down
Loading