feat: parse Avro name field to custom x-parser-schema-id (#69)

README.md

@@ -28,6 +28,8 @@ channels:
         schemaFormat: 'application/vnd.apache.avro;version=1.9.0'
         payload: # The following is an Avro schema in YAML format (JSON format is also supported)
           type: record
+          name: User
+          namespace: com.company
           doc: User information
           fields:
             - name: displayName
@@ -136,6 +138,14 @@ Additional attributes not defined in the [Avro Specification](https://avro.apach
 
 - `example` - Can be used to define the example value from the business domain of given field. Value will be propagated into [examples attribute](https://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.9.5) of JSON schema and therefore will be picked for the generated "Example of payload" when using some AsyncAPI documentation generator.
 
+### Support for names and namespaces
+
+If, at the top level of the Avro schema, the 'name' attribute is defined, it will be copied to the corresponding JSON schema's 'x-parser-schema-id' attribute. If the Avro schema also has the 'namespace' attribute defined, then that schema's fully qualified name will be put into that attribute. The fully qualified name is defined by the namespace, followed by a dot, followed by the name.
+
+If there are two schemas that resolve to the same fully qualified name, only the last one will be returned by the parser. Make sure names of your schemas are unique.
+
+If no name attribute is present, the 'x-parser-schema-id' will have a generated unique id with a name like 'anonymous-schema-1' generated by the main parser. 'x-parser-schema-id' is one of the [custom extensions](https://github.com/asyncapi/parser-js/#custom-extensions) supported by the parser.
+
 ## Limitations
 
 ### Float and double-precision numbers

tests/asyncapi-avro-1.9.0-namespace.yaml

@@ -0,0 +1,11 @@
+asyncapi: 2.0.0
+info:
+  title: My API
+  version: '1.0.0'
+channels:
+  mychannel:
+    publish:
+      message:
+        schemaFormat: application/vnd.apache.avro;version=1.9.0
+        payload:
+          $ref: 'schemas/Person-1.9.0-namespace.avsc'

tests/schemas/Person-1.8.2.avsc

@@ -1,8 +1,7 @@
 {
-  "name": "Person",
   "type": "record",
   "fields": [
-    {"name": "name", "type": "string", example: "Donkey"},
+    {"name": "name", "type": "string", "example": "Donkey"},
     {"name": "age", "type": ["null", "int"], "default": null},
     {
       "name": "favoriteProgrammingLanguage",
@@ -13,7 +12,7 @@
       "type": {
         "name": "Address",
         "type": "record",
-        "fields": [{"name": "zipcode", "type": "int", example: "53003"}]
+        "fields": [{"name": "zipcode", "type": "int", "example": "53003"}]
       }
     }
   ]

tests/schemas/Person-1.9.0-namespace.avsc

@@ -0,0 +1,22 @@
+{
+  "name": "Person",
+  "namespace": "com.company",
+  "type": "record",
+  "fields": [
+    {"name": "name", "type": "string", "example": "Donkey"},
+    {"name": "age", "type": ["null", "int"], "default": null, "example": "123"},
+    {
+      "name": "favoriteProgrammingLanguage",
+      "type": {"name": "ProgrammingLanguage", "type": "enum", "symbols": ["JS", "Java", "Go", "Rust", "C"], "default": "JS"}
+    },
+    {
+      "name": "address",
+      "type": {
+        "name": "Address",
+        "type": "record",
+        "fields": [{"name": "zipcode", "type": "int", "example": "53003"}]
+      }
+    },
+    {"name": "someid", "type": "uuid"}
+  ]
+}

tests/schemas/Person-1.9.0.avsc

@@ -2,8 +2,8 @@
   "name": "Person",
   "type": "record",
   "fields": [
-    {"name": "name", "type": "string", example: "Donkey"},
-    {"name": "age", "type": ["null", "int"], "default": null, example: "123"},
+    {"name": "name", "type": "string", "example": "Donkey"},
+    {"name": "age", "type": ["null", "int"], "default": null, "example": "123"},
     {
       "name": "favoriteProgrammingLanguage",
       "type": {"name": "ProgrammingLanguage", "type": "enum", "symbols": ["JS", "Java", "Go", "Rust", "C"], "default": "JS"}
@@ -13,7 +13,7 @@
       "type": {
         "name": "Address",
         "type": "record",
-        "fields": [{"name": "zipcode", "type": "int", example: "53003"}]
+        "fields": [{"name": "zipcode", "type": "int", "example": "53003"}]
       }
     },
     {"name": "someid", "type": "uuid"}

tests/to-json-schema.test.js

@@ -81,13 +81,15 @@ describe('avroToJsonSchema()', function () {
     const result = await avroToJsonSchema({
       type: 'record',
       doc: 'My test record',
+      name: 'MyName',
       fields: [
         { name: 'key1', type: 'long', doc: 'Key1 docs' },
         { name: 'key2', type: 'string', default: 'value2', doc: 'Key2 docs' },
       ]
     });
     expect(result).toEqual({
       type: 'object',
+      'x-parser-schema-id': 'MyName',
       description: 'My test record',
       properties: {
         key1: {

to-json-schema.js

@@ -21,11 +21,30 @@ const typeMappings = {
   uuid: 'string',
 };
 
-const commonAttributesMapping = (avroDefinition, jsonSchema) => {
+const commonAttributesMapping = (avroDefinition, jsonSchema, isTopLevel) => {
   if (avroDefinition.doc) jsonSchema.description = avroDefinition.doc;
   if (avroDefinition.default !== undefined) jsonSchema.default = avroDefinition.default;
+
+  const fullyQualifiedName = getFullyQualifiedName(avroDefinition);
+  if (isTopLevel && fullyQualifiedName !== undefined) {
+    jsonSchema['x-parser-schema-id'] = fullyQualifiedName;
+  }
 };
 
+function getFullyQualifiedName(avroDefinition) {
+  let name;
+
+  if (avroDefinition.name) {
+    if (avroDefinition.namespace) {
+      name = `${avroDefinition.namespace}.${avroDefinition.name}`;
+    } else {
+      name = avroDefinition.name;
+    }
+  }
+
+  return name;
+}
+
 const exampleAttributeMapping = (typeInput, example, jsonSchemaInput) => {
   let type = typeInput;
   let jsonSchema = jsonSchemaInput;
@@ -51,15 +70,15 @@ const exampleAttributeMapping = (typeInput, example, jsonSchemaInput) => {
   }
 };
 
-module.exports.avroToJsonSchema = async function avroToJsonSchema(avroDefinition) {
+async function convertAvroToJsonSchema(avroDefinition, isTopLevel) {
   const jsonSchema = {};
   const isUnion = Array.isArray(avroDefinition);
 
   if (isUnion) {
     jsonSchema.oneOf = [];
     let nullDef = null;
     for (const avroDef of avroDefinition) {
-      const def = await avroToJsonSchema(avroDef);
+      const def = await convertAvroToJsonSchema(avroDef, isTopLevel);
       // avroDef can be { type: 'int', default: 1 } and this is why avroDef.type has priority here
       const defType = avroDef.type || avroDef;
       // To prefer non-null values in the examples skip null definition here and push it as the last element after loop
@@ -94,20 +113,20 @@ module.exports.avroToJsonSchema = async function avroToJsonSchema(avroDefinition
     jsonSchema.maxLength = avroDefinition.size;
     break;
   case 'map':
-    jsonSchema.additionalProperties = await avroToJsonSchema(avroDefinition.values);
+    jsonSchema.additionalProperties = await convertAvroToJsonSchema(avroDefinition.values, false);
     break;
   case 'array':
-    jsonSchema.items = await avroToJsonSchema(avroDefinition.items);
+    jsonSchema.items = await convertAvroToJsonSchema(avroDefinition.items, false);
     break;
   case 'enum':
     jsonSchema.enum = avroDefinition.symbols;
     break;
   case 'record':
     const propsMap = new Map();
     for (const field of avroDefinition.fields) {
-      const def = await avroToJsonSchema(field.type);
+      const def = await convertAvroToJsonSchema(field.type, false);
 
-      commonAttributesMapping(field, def);
+      commonAttributesMapping(field, def, false);
       exampleAttributeMapping(field.type, field.example, def);
 
       propsMap.set(field.name, def);
@@ -116,8 +135,12 @@ module.exports.avroToJsonSchema = async function avroToJsonSchema(avroDefinition
     break;
   }
 
-  commonAttributesMapping(avroDefinition, jsonSchema);
+  commonAttributesMapping(avroDefinition, jsonSchema, isTopLevel);
   exampleAttributeMapping(type, avroDefinition.example, jsonSchema);
 
   return jsonSchema;
-};
+}
+
+module.exports.avroToJsonSchema = async function avroToJsonSchema(avroDefinition) {
+  return convertAvroToJsonSchema(avroDefinition, true);
+};