feat: added avro validation

Author: sarthakNITT

package.json

@@ -50,7 +50,8 @@
     "uuid": "^11.1.0",
     "winston": "^3.17.0",
     "ws": "^8.2.3",
-    "yaml": "^2.6.1"
+    "yaml": "^2.6.1",
+    "avsc": "^5.7.7"
   },
   "devDependencies": {
     "@asyncapi/minimaltemplate": "./test/fixtures/minimaltemplate",

src/domains/services/validation.service.ts

@@ -31,6 +31,7 @@ import { Specification } from '@models/SpecificationFile';
 import { ParseOptions } from '@asyncapi/parser';
 import { ParserOptions } from '@asyncapi/parser/cjs/parser';
 import { calculateScore } from '@/utils/scoreCalculator';
+import { Type as AvroType } from 'avsc';
 
 import { ConfigService } from './config.service';
 
@@ -282,11 +283,66 @@ export class ValidationService extends BaseService {
         },
       );
 
-      const status = this.determineDiagnosticsStatus(diagnostics, options);
+      // Additional diagnostics for Avro payload schemas using avsc
+      const extraDiagnostics: Diagnostic[] = [];
+      try {
+        const docJson: any = document?.json ? document.json() : undefined;
+        if (docJson && docJson.components && docJson.components.messages) {
+          const messages = docJson.components.messages as Record<string, any>;
+          for (const [msgKey, msgVal] of Object.entries(messages)) {
+            const payload = (msgVal as any)?.payload;
+            if (!payload || typeof payload !== 'object') {
+              continue;
+            }
+            const schemaFormat: string | undefined = payload.schemaFormat || payload.schemaformat;
+            if (!schemaFormat || typeof schemaFormat !== 'string') {
+              continue;
+            }
+            const isAvro = (/application\/vnd\.apache\.avro\+(json|yaml)/i).test(schemaFormat);
+            if (!isAvro) {
+              continue;
+            }
+
+            const avroSchema = (payload as any).schema;
+            if (!avroSchema || typeof avroSchema !== 'object') {
+              extraDiagnostics.push({
+                code: 'avro-schema-missing',
+                message: 'Avro payload has schemaFormat set to Avro but no schema provided.',
+                path: ['components', 'messages', msgKey, 'payload', 'schema'],
+                severity: DiagnosticSeverity.Error,
+                range: {
+                  start: { line: 0, character: 0 },
+                  end: { line: 0, character: 0 },
+                },
+              } as unknown as Diagnostic);
+              continue;
+            }
+            try {
+              AvroType.forSchema(avroSchema as any);
+            } catch (e: any) {
+              extraDiagnostics.push({
+                code: 'avro-schema-invalid',
+                message: e?.message || 'Invalid Avro schema.',
+                path: ['components', 'messages', msgKey, 'payload', 'schema'],
+                severity: DiagnosticSeverity.Error,
+                range: {
+                  start: { line: 0, character: 0 },
+                  end: { line: 0, character: 0 },
+                },
+              } as unknown as Diagnostic);
+            }
+          }
+        }
+      } catch {
+        //Outer catch block will handle the error
+      }
+
+      const allDiagnostics = [...diagnostics, ...extraDiagnostics];
+      const status = this.determineDiagnosticsStatus(allDiagnostics, options);
 
       const result: ValidationResult = {
         status: status as 'valid' | 'invalid',
-        diagnostics,
+        diagnostics: allDiagnostics,
         score: await calculateScore(document),
         document: document?.json ? document.json() : undefined,
       };

test/fixtures/asyncapi_avro_invalid.yml

@@ -0,0 +1,34 @@
+# yaml-language-server: $schema=https://asyncapi.com/schema-store/3.0.0-without-$id.json
+asyncapi: 3.0.0
+info:
+  title: Coffee Bar Checkout Events
+  version: 1.0.0
+  description: AsyncAPI definition for order execution events in a coffee bar microservice.
+
+channels:
+  orderExecuted:
+    address: coffee-bar.checkout.order-executed
+    messages:
+      orderExecuted:
+        $ref: '#/components/messages/orderExecuted'
+
+operations:
+  sendAdCreated:
+    action: receive
+    channel:
+      $ref: '#/channels/orderExecuted'
+
+components:
+  messages:
+    orderExecuted:
+      payload:
+        schemaFormat: 'application/vnd.apache.avro+yaml;version=1.9.0'
+        schema:
+          type: record
+          namespace: io.examples.checkout
+          name: OrderExecuted
+          fields:
+          - name: orderId
+            type: notexisting
+
+

test/integration/validate.test.ts

@@ -84,6 +84,16 @@ describe('validate', () => {
         expect(ctx.stderr).to.equal('');
         done();
       });
+
+    test
+      .stderr()
+      .stdout()
+      .command(['validate', './test/fixtures/asyncapi_avro_invalid.yml', '--log-diagnostics'])
+      .it('fails and reports diagnostics when Avro schema is invalid', (ctx, done) => {
+        expect(process.exitCode).to.equal(1);
+        expect(ctx.stdout).to.contain('Errors');
+        done();
+      });
   });
 
   describe('with context names', () => {