Skip to content

Commit

Permalink
Provide extension points for namespace, name and docs (#539)
Browse files Browse the repository at this point in the history 
* Provide extension points for namespace, name and docs

* Fix bug

---------

Co-authored-by: Karthik Ramgopal <kramgopa@linkedin.com>
  • Loading branch information
@karthikrg @li-kramgopa
karthikrg and li-kramgopa authored Jan 18, 2024
1 parent 42ca14f commit eea7e61
Showing 1 changed file with 48 additions and 22 deletions.
70 changes: 48 additions & 22 deletions parser/src/main/java/com/linkedin/avroutil1/writer/avsc/AvscSchemaWriter.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,10 @@ protected Path pathForSchema(AvroSchema maybeNamed) {
AvroName name = namedSchema.getName();

if (!name.hasNamespace()) {
return Paths.get(name.getSimpleName() + "." + AvscFile.SUFFIX);
return Paths.get(getSimpleName(name) + "." + AvscFile.SUFFIX);
}
String fullname = name.getFullname();

String fullname = getFullName(name, false);
String[] parts = fullname.split("\\.");
String[] pathParts = new String[parts.length - 1];
for (int i = 1; i < parts.length; i++) {
Expand Down Expand Up @@ -162,8 +163,9 @@ protected void writeNamedSchema(AvroNamedSchema schema, AvscWriterContext contex
generator.writeStartObject();
AvroName extraAlias = emitSchemaName(schema, context, config, generator);
emitSchemaAliases(schema, context, config, extraAlias, generator);
if (schema.getDoc() != null) {
generator.writeStringField("doc", schema.getDoc());
String schemaDoc = getSchemaDoc(schema);
if (schemaDoc != null) {
generator.writeStringField("doc", schemaDoc);
}

AvroType type = schema.type();
Expand Down Expand Up @@ -211,7 +213,7 @@ protected void writeSchemaRef(AvroNamedSchema schema, AvscWriterContext context,

// Emit fullname always if configured to do so.
if (config.isAlwaysEmitNamespace()) {
generator.writeString(schema.getFullName());
generator.writeString(getFullName(schema.getName(), false));
}

// Figure out what the context namespace is
Expand All @@ -232,7 +234,7 @@ protected AvroName emitSchemaName(AvroNamedSchema schema, AvscWriterContext cont
String contextNamespaceAfter702;
boolean shouldEmitNSPre702 = shouldEmitNamespace(schemaName, context.getAvro702ContextNamespace());
if (shouldEmitNSPre702) {
contextNamespaceAfter702 = schema.getNamespace();
contextNamespaceAfter702 = getNamespace(schemaName);
} else {
contextNamespaceAfter702 = context.getAvro702ContextNamespace();
}
Expand All @@ -241,14 +243,14 @@ protected AvroName emitSchemaName(AvroNamedSchema schema, AvscWriterContext cont
String contextNamespaceAfter;
boolean shouldEmitNSNormally = shouldEmitNamespace(schemaName, context.getCorrectContextNamespace());
if (shouldEmitNSNormally) {
contextNamespaceAfter = schema.getNamespace();
contextNamespaceAfter = getNamespace(schemaName);
} else {
contextNamespaceAfter = context.getCorrectContextNamespace();
}

//how will Schema.parse() read the output of ancient and modern avro?
AvroName fullnameWhenParsedUnder702 = new AvroName(schemaName.getSimpleName(), contextNamespaceAfter702);
AvroName fullnameWhenParsed = new AvroName(schemaName.getSimpleName(), contextNamespaceAfter);
AvroName fullnameWhenParsedUnder702 = new AvroName(getSimpleName(schemaName), contextNamespaceAfter702);
AvroName fullnameWhenParsed = new AvroName(getSimpleName(schemaName), contextNamespaceAfter);

AvroName extraAlias = null;
if (!fullnameWhenParsed.equals(fullnameWhenParsedUnder702)) {
Expand All @@ -260,27 +262,48 @@ protected AvroName emitSchemaName(AvroNamedSchema schema, AvscWriterContext cont
}

if (config.isAlwaysEmitNamespace()) {
if (config.isEmitNamespacesSeparately() || schemaName.getNamespace().isEmpty()) {
String namespace = getNamespace(schemaName);
if (config.isEmitNamespacesSeparately() || namespace.isEmpty()) {
//there's no way to build a fullname for something in the empty namespace
//so for those we always need to emit an empty namespace prop.
generator.writeStringField("namespace", schemaName.getNamespace());
generator.writeStringField("name", schemaName.getSimpleName());
generator.writeStringField("namespace", namespace);
generator.writeStringField("name", getSimpleName(schemaName));
} else {
generator.writeStringField("name", schemaName.getFullname());
generator.writeStringField("name", getFullName(schemaName, false));
}
} else {
boolean emitNS = config.isUsePreAvro702Logic() ? shouldEmitNSPre702 : shouldEmitNSNormally;
if (emitNS) {
generator.writeStringField("namespace", schemaName.getNamespace());
generator.writeStringField("namespace", getNamespace(schemaName));
}
generator.writeStringField("name", schemaName.getSimpleName());
generator.writeStringField("name", getSimpleName(schemaName));
}

context.pushNamingContext(schema, contextNamespaceAfter, contextNamespaceAfter702);

return extraAlias;
}

protected String getNamespace(AvroName schemaName) {
return schemaName.getNamespace();
}

protected String getSimpleName(AvroName schemaName) {
return schemaName.getSimpleName();
}

protected String getFullName(AvroName schemaName, boolean isAlias) {
return schemaName.getFullname();
}

protected String getSchemaDoc(AvroNamedSchema schema) {
return schema.getDoc();
}

protected String getSchemaFieldDoc(AvroSchemaField field) {
return field.getDoc();
}

protected void emitSchemaAliases(AvroNamedSchema schema, AvscWriterContext context, AvscWriterConfig config,
AvroName extraAlias, JsonGenerator generator) throws IOException {
List<AvroName> aliases = schema.getAliases();
Expand All @@ -291,13 +314,15 @@ protected void emitSchemaAliases(AvroNamedSchema schema, AvscWriterContext conte

generator.writeFieldName("aliases");
generator.writeStartArray();

if (aliases != null) {
for (AvroName alias : aliases) {
generator.writeString(alias.getFullname());
generator.writeString(getFullName(alias, true));
}
}

if (extraAlias != null) {
generator.writeString(extraAlias.getFullname());
generator.writeString(getFullName(extraAlias, true));
}
generator.writeEndArray();
}
Expand Down Expand Up @@ -326,8 +351,9 @@ protected void emitRecordFields(AvroRecordSchema schema, AvscWriterContext conte
generator.writeStringField("name", field.getName());

// Field doc.
if (field.hasDoc()) {
generator.writeStringField("doc", field.getDoc());
String fieldDoc = getSchemaFieldDoc(field);
if (fieldDoc != null) {
generator.writeStringField("doc", fieldDoc);
}

// Field type.
Expand Down Expand Up @@ -363,7 +389,6 @@ protected void emitRecordFields(AvroRecordSchema schema, AvscWriterContext conte
protected void writeDefaultValue(AvroSchema schemaForLiteral, AvroLiteral literal, AvroSchemaField field,
JsonGenerator generator) throws IOException {
AvroType type = schemaForLiteral.type();
String temp;
AvroSchema valueSchema;

// if literal is of type AvscUnparsedLiteral, throw an exception
Expand Down Expand Up @@ -478,10 +503,11 @@ protected void writeDefaultValue(AvroSchema schemaForLiteral, AvroLiteral litera
* @return true if vanilla avro would emit a "namespace" json property
*/
private boolean shouldEmitNamespace(AvroName name, String contextNamespace) {
String namespace = getNamespace(name);
if (contextNamespace == null) {
return name.getNamespace() != null && !name.getNamespace().isEmpty();
return namespace != null && !namespace.isEmpty();
}
//name.namespace could be "" and sometimes need to be emitted explicitly still
return !contextNamespace.equals(name.getNamespace());
return !contextNamespace.equals(namespace);
}
}

0 comments on commit eea7e61

Please sign in to comment.