Skip to content

Add better Avro validation #365

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

Merged
merged 3 commits into from
Sep 11, 2025
Merged

Add better Avro validation #365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b628238
Add better Avro validation
rayokota Sep 10, 2025
f299bc6
Minor cleanup
rayokota Sep 10, 2025
39da52d
Minor cleanup
rayokota Sep 10, 2025
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
6 changes: 5 additions & 1 deletion schemaregistry/serde/avro.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import {
FieldTransform,
FieldType, Migration, RefResolver,
RuleConditionError,
RuleContext, SchemaId, SerdeType,
RuleContext, SchemaId, SerdeType, SerializationError,
Serializer, SerializerConfig
} from "./serde";
import {
Expand Down Expand Up @@ -93,6 +93,10 @@ export class AvroSerializer extends Serializer implements AvroSerde {
const subject = this.subjectName(topic, info)
msg = await this.executeRules(
subject, topic, RuleMode.WRITE, null, info, msg, getInlineTags(info, deps))
avroType.isValid(msg, {errorHook: (path, any, type) => {
throw new SerializationError(
`Invalid message at ${path.join('.')}, expected ${type}, got ${stringify(any)}`)
}})
let msgBytes = avroType.toBuffer(msg)
msgBytes = await this.executeRulesWithPhase(
subject, topic, RulePhase.ENCODING, RuleMode.WRITE, null, info, msgBytes, null)
Expand Down
30 changes: 30 additions & 0 deletions schemaregistry/test/serde/avro.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,18 @@ const demoSchema = `
]
}
`
const nameSchema = `
{
"type": "record",
"namespace": "examples",
"name": "NameSchema",
"fields": [
{ "name": "fullName", "type": "string" },
{ "name": "lastName", "type": "string" }
],
"version": "1"
}
`
const demoSchemaSingleTag = `
{
"name": "DemoSchema",
Expand Down Expand Up @@ -369,6 +381,24 @@ describe('AvroSerializer', () => {
expect(obj2.boolField).toEqual(obj.boolField);
expect(obj2.bytesField).toEqual(obj.bytesField);
})
it('bad serialization', async () => {
let conf: ClientConfig = {
baseURLs: [baseURL],
cacheCapacity: 1000
}
let client = SchemaRegistryClient.newClient(conf)
let ser = new AvroSerializer(client, SerdeType.VALUE, {useLatestVersion: true})
let info = {
schemaType: 'AVRO',
schema: nameSchema
}
await client.register(subject, info, false)
try {
await ser.serialize(topic, { lastName: "lastName" })
} catch (err) {
expect(err).toBeInstanceOf(SerializationError)
}
})
it('guid in header', async () => {
let conf: ClientConfig = {
baseURLs: [baseURL],
Expand Down