resolve #1907 | handle record references when presenting avro schema #1911
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MiloszKorman
commented
Oct 16, 2024
| @@ -190,7 +190,7 @@ | |||
| "topics": [ | |||
| { | |||
| "id": "pl.allegro.public.group.DummyEvent", | |||
| "schema": "{\"type\":\"record\",\"name\":\"DummyEvent\",\"namespace\":\"pl.allegro.public.group.DummyEvent\",\"doc\":\"Event emitted when notification is sent to a user\",\"fields\":[{\"name\":\"__metadata\",\"type\":[\"null\",{\"type\":\"map\",\"values\":\"string\"}],\"doc\":\"Field internally used by Hermes to propagate metadata.\",\"default\":null},{\"name\":\"waybillId\",\"type\":[\"null\",{\"type\":\"record\",\"name\":\"WaybillId\",\"fields\":[{\"name\":\"waybill\",\"type\":\"string\",\"doc\":\"Waybill\"},{\"name\":\"carrierId\",\"type\":\"string\",\"doc\":\"CarrierId\"}]}],\"doc\":\"WaybillId\",\"default\":null},{\"name\":\"notificationId\",\"type\":\"string\",\"doc\":\"Notification Id\"},{\"name\":\"userId\",\"type\":\"string\",\"doc\":\"User Id\"}]}", | |||
| "schema": "{\"type\":\"record\",\"name\":\"DummyEvent\",\"namespace\":\"pl.allegro.public.group.DummyEvent\",\"doc\":\"Event emitted when notification is sent to a user\",\"fields\":[{\"name\":\"__metadata\",\"type\":[\"null\",{\"type\":\"map\",\"values\":\"string\"}],\"doc\":\"Field internally used by Hermes to propagate metadata.\",\"default\":null},{\"name\":\"waybillId\",\"type\":[\"null\",{\"type\":\"record\",\"name\":\"WaybillId\",\"fields\":[{\"name\":\"waybill\",\"type\":\"string\",\"doc\":\"Waybill\"},{\"name\":\"carrierId\",\"type\":\"string\",\"doc\":\"CarrierId\"}]}],\"doc\":\"WaybillId\",\"default\":null},{\"name\":\"otherWaybillId\",\"type\":[\"null\",\"WaybillId\"],\"doc\":\"other WaybillId\",\"default\":null},{\"name\":\"notificationId\",\"type\":\"string\",\"doc\":\"Notification Id\"},{\"name\":\"userId\",\"type\":\"string\",\"doc\":\"User Id\"}]}", | |||
There was a problem hiding this comment.
Unsure if this change and feature are significant enough to warrant adding new field with such record type reference to the DummyEvent, or should I just work with this more complex type locally, but merge to master with DummyEvent schema unchanged
There was a problem hiding this comment.
I think it is, it may be helpful in case of any debug related to this feature
MiloszKorman
force-pushed
the
issue-1907-show-referenced-record-type
branch
9 times, most recently
from
01013df
to
a4c3f37
Compare
MiloszKorman
commented
Oct 16, 2024
| const isEnum = types.some((type: Type) => type.includes('enum')); | ||
| const expandable = isRecord || isEnum; | ||
| const nestedType = isRecord && findNestedType(props.field.type); | ||
| const nestedType = | ||
| isRecord && (recordReference || findNestedType(props.field.type)); |
There was a problem hiding this comment.
{
"type": "record",
"name": "Example1",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "A1",
"fields": [
{
"name": "b",
"type": ["null", "string"],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "c",
"type": ["null", "A1"],
"doc": "c"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example2",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "A2",
"fields": [
{
"name": "b",
"type": ["null", "string"],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "c",
"type": ["null", "A2"],
"doc": "c"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example3",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "A3",
"fields": [
{
"name": "b",
"type": ["null", "string"],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "c",
"type": ["null", "a.b.c.A3"],
"doc": "c"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example4",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "A4",
"namespace": "d.e.f",
"fields": [
{
"name": "b",
"type": ["null", "string"],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "c",
"type": ["null", "d.e.f.A4"],
"doc": "c"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example5",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "d.e.f.A5",
"fields": [
{
"name": "b",
"type": ["null", "string"],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "c",
"type": ["null", "d.e.f.A5"],
"doc": "c"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example6",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "a.b.c.A6",
"fields": [
{
"name": "b",
"type": ["null", "string"],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "c",
"type": ["null", "A6"],
"doc": "c"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example7",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "a.b.c.A7",
"fields": [
{
"name": "b",
"type": ["null", "string"],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "c",
"type": ["null", "a.b.c.A7"],
"doc": "c"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example8",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "A8",
"namespace": "d.e.f",
"fields": [
{
"name": "b",
"type": ["null",
{
"type": "record",
"name": "B8",
"fields": [
{
"name": "c",
"type": ["null", "string"],
"doc": "c"
}
],
"doc": "b"
}],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "d",
"type": ["null", "d.e.f.B8"],
"doc": "d"
}
]
}
There was a problem hiding this comment.
{
"type": "record",
"name": "Example9",
"namespace": "a.b.c",
"doc": "root",
"fields": [
{
"name": "a",
"type": ["null", {
"type": "record",
"name": "A9",
"namespace": "d.e.f",
"fields": [
{
"name": "b",
"type": ["null",
{
"type": "record",
"name": "B9",
"namespace": "a.b.c",
"fields": [
{
"name": "c",
"type": ["null", "string"],
"doc": "c"
}
],
"doc": "b"
}],
"doc": "b"
}
],
"doc": "a"
}]
},
{
"name": "d",
"type": ["null", "B9"],
"doc": "d"
}
]
}
MiloszKorman
force-pushed
the
issue-1907-show-referenced-record-type
branch
from
a4c3f37
to
8e81aa0
Compare
faderskd
force-pushed
the
issue-1907-show-referenced-record-type
branch
from
8e81aa0
to
c3df9f3
Compare
|
Thanks for broad set of screen examples, it helped a lot ;) I think that future code readers will appreciate the link to the rules for resolving references. Pls add link to the avro specification. I guess you've used this one? :D https://avro.apache.org/docs/1.11.1/specification/#names |
faderskd
approved these changes
Nov 14, 2024
faderskd
force-pushed
the
issue-1907-show-referenced-record-type
branch
from
c3df9f3
to
2a33634
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.