Skip to content

Improve AvroSchemaViewer nested type resolution and enum handling #2201

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

Open
seanmcilvenna wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve AvroSchemaViewer nested type resolution and enum handling #2201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2d6c21
Improve AvroSchemaViewer nested type resolution and enum handling
seanmcilvenna Feb 21, 2026
c2cb143
Create dry-planes-talk.md
boyney123 Feb 22, 2026
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
5 changes: 5 additions & 0 deletions .changeset/dry-planes-talk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@eventcatalog/core": patch
---

feat(core): improved AvroSchemaViewer nested type resolution and enum handling
42 changes: 25 additions & 17 deletions packages/core/eventcatalog/src/components/SchemaExplorer/AvroSchemaViewer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,31 @@ function formatAvroType(type: any): string {

// Check if a type has nested fields
function hasNestedFields(type: any): boolean {
// Check if it's a direct record type
if (!type) return false;
if (typeof type === 'object' && !Array.isArray(type)) {
return type.type === 'record' && type.fields && type.fields.length > 0;
if (type.type === 'record') return !!(type.fields && type.fields.length > 0);
if (type.type === 'array') return hasNestedFields(type.items);
if (type.type === 'map') return hasNestedFields(type.values);
}
if (Array.isArray(type)) return type.some((t) => hasNestedFields(t));
return false;
}

// Check if it's a union type that contains a record
// Deep extractor for Records or Enums
function getNestedType(type: any, target: 'record' | 'enum'): any {
if (!type) return null;
if (typeof type === 'object' && !Array.isArray(type)) {
if (type.type === target) return type;
if (type.type === 'array') return getNestedType(type.items, target);
if (type.type === 'map') return getNestedType(type.values, target);
}
if (Array.isArray(type)) {
return type.some((t) => typeof t === 'object' && !Array.isArray(t) && t.type === 'record' && t.fields && t.fields.length > 0);
for (const t of type) {
const result = getNestedType(t, target);
if (result) return result;
}
}

return false;
return null;
}

// Check if a field is required (not optional)
Expand Down Expand Up @@ -91,13 +105,6 @@ function isFieldRequired(field: any): boolean {
return true;
}

// Helper function to get the record type from a union if it exists
function getRecordFromUnion(type: any): any {
if (Array.isArray(type)) {
return type.find((t) => typeof t === 'object' && !Array.isArray(t) && t.type === 'record');
}
return null;
}

// AvroField component - displays a single field with nested support
const AvroField = ({ field, level, expand, showRequired }: AvroFieldProps) => {
Expand All @@ -106,8 +113,9 @@ const AvroField = ({ field, level, expand, showRequired }: AvroFieldProps) => {
const indentClass = `pl-${level * 4}`;
const isRequired = showRequired ? isFieldRequired(field) : undefined;

// Get the record type, either directly or from within a union
const recordType = typeof field.type === 'object' && field.type.type === 'record' ? field.type : getRecordFromUnion(field.type);
// Get the record and enum types by resolving deep nesting
const recordType = getNestedType(field.type, 'record');
const enumType = getNestedType(field.type, 'enum');

useEffect(() => {
setIsExpanded(expand);
Expand Down Expand Up @@ -142,10 +150,10 @@ const AvroField = ({ field, level, expand, showRequired }: AvroFieldProps) => {
{field.doc && <p className="text-[rgb(var(--ec-page-text-muted))] text-xs mt-1">{field.doc}</p>}

{/* Show enum values if present */}
{field.type?.type === 'enum' && field.type.symbols && (
{enumType && enumType.symbols && (
<div className="text-xs text-[rgb(var(--ec-page-text-muted))] mt-1">
Values:{' '}
{field.type.symbols.map((s: string) => (
{enumType.symbols.map((s: string) => (
<code key={s} className="bg-[rgb(var(--ec-content-hover))] px-1 rounded mx-0.5 text-[rgb(var(--ec-page-text))]">
{s}
</code>
Expand Down
Loading