AsyncAPI Hacktoberfest Office Hours, 22 Oct 2020

Previous Meeting

Next Meeting

⏯

youtube image

►

From YouTube: #Hacktoberfest Support Office Hours 22.10

Description

Read more at https://www.asyncapi.com/blog/hacktoberfest-2020

A

Welcome welcome welcome.

A

It's me your favorite favorite youtuber.

A

um Will probably not speak until I see at least one viewer.

A

Don't know why I just think it's better to speak to someone to myself even for the recording purposes.

A

So how are you, how are you.

A

Doing fine, what time is it on your site? It's six in poland.

A

Okay, we have one viewer, no, oh, come on, I'm not that ugly.

A

Come on dear viewer, come back, don't leave.

A

A

Oh finally, one viewer stay longer.

A

um Okay, so we started it's two past six. uh It's another stream for oktoberfest participants that we're doing here at using api.

A

um You have one hour to ask any questions about the issues that we offered for the oktoberfest the list, two issues, uh I'm gonna paste it in the comment section.

A

um So I just sent you a link to a to a spreadsheet that contains the list of all the issues that we prepared for.

A

For the hacktoberfest, so you can during this hour you can ask for more explanation about some particular issue um and if you want we can even do some per programming.

A

You can join me here to the stream or or not or just stay in the comment section and ask me questions.

B

A

So we it's like 10 days left until the end of october. First.

A

I'm gonna send you a link to the status update of our.

A

Participation so basically we closed and merged or already 59 pull requests submitted um for the oktoberfest, which is amazing, basically, and we had like 24 different contributors involved, which is awesome and I started inquiring um them like how they got uh here to act as an api to do those contributions and looks like most of people came through discord channel because there's a discord channel for oktoberfest participants, the official discord channel of prepared by digitalocean. I guess where and you have a it's- not channel- I'm not sure, really like discord.

A

Profile how to use? How do you call it like with slack you have workspaces? How does it work with discord?

A

Let me check. That's, I think, that's a really important information. I think it's probably written on the oktoberfest page.

A

How do they advertise it.

A

A

Faq, maybe significa.

A

A

Discord server. Oh so it's called not workspace, but it's discord: server. Okay, so um digitalocean organized a discord, server um dedicated for oktoberfest and there's a channel where you can promote your project. So that's a place where I go once a week to put links to um asking api and that's how people get get here, which is interesting and most of them. They are happy with the spreadsheet that we prepared, which is also cool.

A

So, who is there this one person watching? Can you write something in the comments I see you're on on.

A

Twitch, so for your information, I hi it's you, man, hey man,.

A

Antoneth, is it correct how I'm pronouncing it? I was practicing a bit untoneth.

A

Perfect, my spanish is getting better.

A

Okay, so once you're here and nobody else- is here asking for oktoberfest issues, I saw there's a new issue in html templates. That might be interesting for you. If you.

A

A

So there is an issue in in html template that I think you antonette um would be interested with.

A

You are working like you're in like your job like in work.

A

Like working like your job working or what do you mean by working.

A

A

A

Job learning code, ah bootcamp right.

A

ah Okay, awesome um cool, so I will um so I see comments from antonette and I see those this guy from extra madura from bad bad buddy. But uh I I will not let you in before. I try to say it.

A

He showed a finger by the way you could not see it, but I saw his in his like window. He showed me finger and again.

C

A

I I can't sorry I would just have to quit.

B

C

A

You can't what.

C

That's a joke, you know kind.

A

A discount, like the british one, yeah.

C

I remember seeing a t-shirt with this german something, but it was something else. I can't something.

C

A

So- and I I had it in the morning.

C

A

C

C

This time of the day, no, not really, but um this time of the day is the second morning for spanish people, because we have we're.

D

Sleeping we have breakfast.

C

We work, we eat, we sleep, we have breakfast again, we work and then we have dinner and we're going to sleep again. So we have we split the day. So.

A

C

So this is my second um breakfast, but I haven't had it yesterday, so I'm just used to.

A

Actually, I today talked with my karinka and we we have an agreement that we will eat this crap now every every morning, because it's healthy this crap, like I don't know it's oats with francine and something right well,.

C

Actually, no, it's actually what they call raisins raisins cereals. So it's a mix of cereals and and I'm assuming that cereals is correct, but maybe it's a false frame.

C

Fruit, dry fruit as well yeah.

A

Raisins, so it's dry fruits like grape dry, dry, grapes right.

C

Not great, it's actually able so oh.

A

C

Like april um some, um I can't remember the name of this.

C

So the thing is, I'm very, I'm very used to uh speaking english tech and when it comes to food english, I have no idea. So I don't know the names. Sorry and.

A

What's the color.

C

The color I mean now it's mixed, so it's a little bit strange.

A

Yeah, so it's oats, this white stuff, is it banana.

C

A

C

It's dried apricot.

A

C

Maybe I don't know, I don't know the name.

A

ah Figure figure, I know.

C

And this is it's not figure? No, it's not! It's not ego. It's not! Okay! It's not.

B

This way, I know, I know what.

C

You mean, and even if it's in polish, because fig figures or figa figures are the name in portuguese so of um of this fruit, I don't remember so. I know what you mean by tina.

C

A

It's super hard to get those in poland like fresh ones, they're, usually dry, and this is from little- and this is coming from germany.

A

You have a little in spain.

C

Of course it's full of they're everywhere yeah, so it's probably from germany.

A

Yeah, it's german, like they have to be everywhere.

C

Yeah, so paul is figa fig ego yeah, so.

B

Now it's hp, it's not figa vega,.

C

It's um look at the name.

A

You don't even know in spanish.

C

I can't think in spanish now it happens all the time to me when I'm speaking in, I I'm not able to think in spanish again bird.

B

See it with yogurt.

C

That's that's about right. It's.

D

Actually, nothing.

C

It's birth, food right.

C

I guess I don't know it will be. It would be strange if I eat birth seeds.

C

It will be straight if they exist actually.

C

You can go on.

C

I'm gonna mute otherwise you're gonna usually chew a lot.

A

Yeah mute okay, so some coding.

A

So franito, please, because I don't have two monitors yet by the way. I'm thinking about.

A

Adapting a an attic to get a few square meters of my of place of, like uh my my personal space, to get a desk where I can have monitors, because I I really uh that's the only thing, I'm missing from sap that I had a desk and I had three monitors.

A

That's the only one. That's the only thing.

C

What do you want me to want to share no.

A

No, I just want no, I want you to just tell me whenever there are some questions from from the.

B

Comment section.

A

C

Be because when I'm sharing.

C

You know like like, like in the tv shows I am the the person um you know like. We got a new question from the audience.

A

I'm not I'm not sure what kind of shows you have there in spain.

C

You know the usual ones, the bad ones.

C

The things that you can find on tv.

A

Screen so antoneth, that's um I'm gonna talk about the issue. That is um it's not on the list of oktoberfest issues because it was raised, I think on monday, but it's um it's. It still can be done. It's. I think it's easier than the one that you completed today.

A

um So if you want you can pick it up as well, but you sure.

A

Where is it, can you see my screen.

C

A

Okay, perfect. Thank you so short long story short.

A

The request is to have in html para an html template, another parameter that would be called version and whatever value you put here, it should override the the version that we render in the template that we take from async api file.

A

So let me show you the playground. What I mean.

C

I'm curious: why is this useful or how.

A

Is this useful.

C

A

Yeah, so it's useful because how they generate so it's described here is some some java, thingy, etc.

A

So so, basically uh ludovic explained that it's much much easier for them would be to just override it rather than uh then have some hacks that override it uh in the file and at.

C

The end because it sounds like a huge, huge bad practice to me, but.

A

So so for me, it also sounds strange. That's why I first asked: um what's the point of it, but um we anyway do not enforce any format for the version, and that would be a parameter anyway. So that would be something uh uh damn it.

C

Yeah, I'm worrying if we're encouraging people to do this kind of tricks, instead of telling them that they should be updating the version on the on the file on this kpi file, because you think about it.

C

um The idea, the idea behind the version is that you can, um it doesn't have to be. You don't have to use this kind of um semantic versioning right, you can. You can use whatever kind of version you want. uh You can probably have one two, three, four five, where or preview final, whatever you can use whatever you want there, um so so, if they don't want to be increasing, this number very often something you can they can do is just use.

C

A word like this is draft preview, final version, whatever and or draft preview one through two, three, four five. You know that could be the version, and um so I don't. I don't get why the versioning is a problem and why we will want to encourage people by having a parameter specifically for that um to do it right to because then it's to me.

B

C

Like I mean it's, okay and I understand that there could be a point here um or a use case for them whatever the thing is that looks to me that we will be like kind of somehow recommending people or showing people that this is a good practice or something that you should be doing or you could be doing and it's fine right, uh and I don't think it's fine, because it sounds to me that they have the keypad file in a single pipeline and they use it, for instance, to generate documentation as an example, but tomorrow they want to.

C

They want to fit the assistant kpi5 into another system and not documentation, but for instance, they think if they have or something like. You know the proxy or something like this and then what you have a version on the documentation that is, that doesn't correspond to the version and the on the other system.

C

So you know what I mean you see what I'm saying so sounds like you're tricky and you're tricking it, and if you want to do it, you can always. If you want to do it yourself for your specific use case, that's fine, you can use a pass command. Something like please find, uh I don't know best command that will find the version of your async, a file that will replace it and then input this file to the input result to the um uh to the sync a generator right.

C

uh So we don't have to provide this functionality right because it's only for your specific use case right. uh So I don't know it sounds. Can you can you paste the the link to the to the issue? So I can have a look at it as well, because it really looks weird to me. You cannot.

A

C

Yeah, but I can, I cannot read it well, it's just too small and also would love to have the link. So I can okay sure comment.

A

So basically, the the approach here is it's not about having different version. It's just about it's a it's like with a node. You keep versioning in the packages and with java it's in pom in mpom file, so half damn it again, this infinite loop. um Let me paste.

A

So it's uh not about encouraging to have different versions different in application and different in the file. It's just about making it's it much easier to to pass the version in the command line um and not sure. If we should, I mean that one thing is the the file, the second, the the async api file. The second is the the tooling.

A

um I always think that tooling is to make things easier and not to enforce any any best or bad practices, because, like best practices, it's always pretty subjective um and especially if it's as simple as just having a an additional parameter in the template, I didn't check it yet, but I think it's like super tiny change in the template and it just makes stuff easier.

A

It's like with react component. That would be the same, so you have a prop for version and if you don't provide it, we take it from the file, but you can always specify different for the component in the props just to make your life easier. I think so. So. Looking on the description, I don't think it's super specific for a for for one user, because usually you you do versioning of your application.

A

As I said like in java, it's bomb uh with different languages, it's it's different and then everyone will have to come up with a solution like to always bump automatically version. Also in the um industry, api file.

A

So yeah adding a simple flag. I think it's it's pretty fine.

C

So I'm reading and I was listening as well.

C

D

C

Reading the thing, I think, there's a confusion here, so the info version is not the version of your application. It's a version of your api of your interface right. It shouldn't be changing with every um with every change. uh Every change you make on your on your code, it's it will only change when you change the interface right like, for instance, you change the message or you change the schema or you change it or you add a new channel or remove a channel or whatever some. You know what I mean.

C

So if you have new versions of your code behind the scenes um doing something, this is not the version. This is not a version of the uh of the info object right, so the version on the info object is about uh the interface, not the not the application, so yeah.

A

C

About, I think, he's trying to use info.version for uh application version. It's not the same, and that's why he's having conflicts like hey? I don't want to be changing this very often right. That's why he's referring to palm.xml uh and- and you were saying, like packages and all this stuff, package.json version is one thing it's in kpi version is another thing. This kpi version is uh info version is, is about your interface, it's not about your application.

C

Your application can be on on version 100 and you still own number version, one of your api right because yeah you created the api and an interface and it didn't change, but the code handling these these messages is continually changing or whatever or doing whatever stuff. um You know what I mean.

C

So I think that's the confusion here that maybe maybe.

B

um When you see the.

C

B

C

um The version of the documentation on the html template um it will somehow say that this is the version of the api and not of your, not the version of your of your application right in this case. Yes, we can have something like a parameter for version or even better. We can have a an attribute, a a an extension right like x, dash application version right.

C

We can have something like this. We can have both this version parameter can overwrite. This extension parameter uh this extension application version, but maybe it's it's been misunderstood because we're not explaining it well enough that the info.version attribute is not really for the application version right and it's probably very visible on the on the top of the html template. I guess streetlights 1.0 right and sounds like this is the version of your application. That's that's correct.

C

Maybe it would be like street light. The the version that you pass on a param or something and then below can be something like interface version, blah blah blah the number from info version right.

C

You know what I mean that will make more sense. Maybe that.

B

Makes me think.

C

That me, I don't know if, if, if the the info.version attribute makes sense at all, it does because at some point you will want to have like version management for your documents right yeah um anyway, we'll keep discussing on the on the youtube. um I gotta jump now, I'm committing so as I promised, I was going to be only until 6 30, even though I arrived late so.

C

So I'll leave you here alone again and today take care everyone watching take care of lucas and you save yourselves. It's crazy.

C

A

A

Okey-Dokey so I'm alone again not alone but alone. With my face.

A

A

Going back to the to the codings, so let's see, if that's, uh if this issue we talked about.

A

It's it's not that clear.

A

So, let's see if there's some other.

A

Issue we could work on.

A

So maybe let's have a look.

A

On this issue, let me share my.

A

A

Okay, so there's another issue from ludovic: it's about supporting display of correlation id.

A

Correlation id some background.

A

It's part of the message.

C

A

Not message, oh here, so the message when you describe the message that goes into the channel except of headers payload, you can also provide the correlation id and the problem is that we know I mean you can add it to the document, but we don't support it in the html template. So we don't render it in the ui and there's a use case for it.

A

A

Which said that he wants to give it a try, so let me just help and understand how to add it. So we know we agreed already how to how it should be displayed. We have the html, like hard-coded html, how it looks like.

A

And now it's just about yeah um coding it into the template.

A

Let's open playground again so so, basically, whenever you have payload.

B

A

Above payload, we want to have information about correlation id.

A

Let's go to html template code. Let's make it bigger a bit.

A

A

Yeah, it's message, of course,.

A

Okay, so here you can see in the message: html partial, the location where we um yeah render the payload and the headers.

A

And message tags as well: let's, let's see.

A

You know what I'm gonna render the dummy example.

A

B

D

A

Doesn't support redirects.

A

A

A

Okay- and now I forgot now- I just remember- give me uno memento. I need to turn on music. Would it be possible for another life, an example of really.

A

uh Really use of asking api so um could you so antoinette? Could you elaborate a bit more like what do you mean by real use like you would like to see how to create a file from scratch or.

A

Or or what really um like, who? What you, what really use you'd like to see um what the, if you could try to specify.

A

ah You could okay, so I'd like to see uh how how come the file is is useful and what I can like use it for that. I can actually generate application and then this application kind of responds to events or send.

A

A

That's I don't see a problem I can.

A

I can prepare something for uh for next tuesday, because we actually, we already have an example of streetlight. We have node.js template where we can generate application uh from using api file. We have a like tutorial that guides you step by step, how to do it, so I can do it and explain not a big deal.

A

Okay, you have it on tuesday.

A

Okay, so music.

A

A

um And underneath uh would be awesome if, if you could confirm, I'm gonna ask you and just confirm if you can hear the.

B

A

A

Can you hear the music.

A

A

How about now? Because I don't want to make it too loud to not.

B

A

A

Good, okay, cool so screen sharing.

A

Again so back into business, so it's about adding support for correlation id.

A

So I'm in the message and yeah I was checking out. I wanted to check how tax are rendered. I don't remember so. Let's take a look into the playground.

A

Let's find some.

A

Message: okay, so we definitely should put the correlation id in between tags and in between the payload, so the correlation id should go basically here.

A

A

We have html ready.

A

So now, let's just save it hardcoded and let's generate.

A

A

Do we actually have.

A

Correlation and id in the dummy example.

A

We don't have a correlation.

A

Id in the example.

B

A

Okay, but we can add it, it's not a problem. The only thing is that I I cannot use this dummy example. I have to just copy locally.

A

So let us create a not here.

A

Let's create a.

B

A

A

Let's find a message.

A

So we have a channel.

A

It's a publish.

A

A

Take a look on the dummy created message: okay, no correlation id. So let's just add one.

A

um Description.

A

B

A

Location and let's just.

B

A

This from the official example.

A

That's fine, but because we say that it's in the message header in correlation id header, then it would be good practice to yeah write. It.

A

C

A

Looks good, I will not add description because it's not important now um so looks good looks like we have a good sample data sample data later, whatever dummy jamal, I'm doing dot slash, so the generator picks up sources from my current directory.

A

Let's save it into the output and.

A

Force right because it's yeah kit.

B

A

Okay, open output index html.

A

Okay, so so far, so good, uh of course, as you can see, we don't have values that I've put into the into the async api file.

A

So I need to, of course now make sure that there are no hard coded values but values taken from the from the async api document.

A

Okay, so this value that's hard coded. That's fine!.

A

A

Should be taken from the async api spec.

A

Okay, so it's um in the context some a bit of highlight. So whenever message macro is called in the template, it gets into the context a a message, a particular message, so I can access its content um by invoking a specific helper method.

A

So let me just show it and show you. um How do I know like how do I know how to call it right.

A

So, let's go to the parser because async api generator before it consumes your template like html template it uh parses the asking api file that you passed into the generator it's parsed and then the parser in return gives you a lot of helpers to access the contents of asking api file. So you, basically, when you get a json, you don't have to do like um value, dot, value, dot value to access some data, but you get functions um to do it and all the models.

A

Oh actually, I'm not gonna force you to read the source code. We have api docs right.

A

So, let's see for for the message.

A

Where are the message.

B

A

Okay, because message you, you can also have a message trade. So we have like a message: tradable model with yeah functions that are available for the message and message, trade, and you can see correlation.

B

A

Okay, so the correlation id function returns, a correlation id object.

A

B

A

Correlation id.

A

Okay and then this object, like correlation id object, has another set of helper functions, so we can access the location or the description right.

A

But now let me I really prefer reading the source code.

A

So let's go to the message again.

A

Of course, message tradable.

A

Correlation id, so you can see that um if there is no correlation id provided in your document, we're gonna return.

A

Now so, if we do.

A

Correlation id.

A

That this will return something right. um Let me maybe show you how to log it out to the console. So, let's now let us know in the template get the correlation id value, but not do anything with it, but just put it into the logs.

A

Okay, so you can see that in two in one message into messages: actually the correlation id was locked, but when the correlation id was not present, you got no, and now you can. Basically, um you can basically do um something like this and access. For example, the.

A

Location and with location, that's a required field, so we don't have to check if location was provided or not to secure, to make sure that everything is rendered properly, because if somebody did not provide location in the file, the parser will when anyway block the generation, because parsing will fail. So we can access location like this, but but we're going to get an error. Look.

A

Okay, I didn't save my changes again. We should get an error perfect. Why we got error.

A

It's because we assume that correlation id is always there and then we access its location, but but, as you could see, one message did not have the correlation id and therefore, when I try to access the location value of undefined, I got an error.

A

So the thing is that this this new snippet responsible for rendering correlation id it should be used only if correlation id is provided so we're closing it into the. If statement um like that's how you do it with nunchuck.

A

A

B

A

If correlation id.

A

Have a look now: okay, no errors, and because we have like two messages uh like it's one message in two different channels, but then it's you can see. It's protest processed twice because it's it's used in two channels um and you can see that without errors we could log out the location which is pretty cool um now, let's just make it like ident.

A

So whenever there is a message correlation id provided, that's awesome, but I I mean I don't like that. We have this and again this same stuff here twice, so I prefer to use some feature of nunjucks that is for setting variables so set correlation id.

A

Let's put it here and.

A

Therefore, now it should be much much better and let us not log it out anymore, but let's just render it and see if it's gonna be visible, no errors. Let's see the output.

A

Oh yeah, so you can see a proper correlation id is rendered. It's now just a matter of handling the description.

A

Now, the problem with description is that it is not a um it's not something that ah no wait. What am I doing? It's not a required.

A

A

So I basically cannot do.

A

I mean I cannot, I mean I can.

A

I can't do something like this.

A

A

Okay and my dummy correlation id description, it's visible like um maybe, let's make it bigger, so I forgot so it's it's rendered, but but what if I.

A

Where is it? What if I don't provide it.

A

A

It's not rendered.

A

But have a look on this div element.

A

Now it was p yeah, so the value if value is not provided in this paragraph there's no undefined or whatsoever, but I mean that's not nice. When you have some leftovers of html, I mean I don't think it's it's a good practice.

A

So how can we solve it.

A

How can we solve.

B

A

The the model gives you additional function, which is called test description and returns boolean, so you can um basically have a condition like if uh something is present, then uh only then do it. Wait.

A

Wait let me structure it difftif spandiff, okay, so we basically have to um have a condition here that this paragraph it's only it's going to be rendered only if, um if the correlation id has a.

B

D

A

So that's how you do it copy paste.

A

A

So if it has description, then render description as simple as that, let's render.

A

Okay, description is visible now, when I comment out the description.

A

Wait, why not adding it like it's stupid that I have to comment it out all the time dummy info? What object, what messages do we use yeah dummy info is here so good.

B

A

A

And here it's gonna be for.

A

ah What uh for domi created.

A

A

What dot and here for dummy info message, header do we have any headers.

D

A

Okay, we have trades common headers.

A

Let's go to trades common.

D

A

Okay, we have it all good, oh, come on. um I don't want to have description in this dummy info, of course, because I want to have an example of correlation id with and without the description.

A

So it was a pointless, pointless waste of time.

A

Okay, so now in the file I have like yeah, let's just start refresh so correlation id for dummy um or maybe just scroll, to messages section.

A

Okay, so dummy message, correlation id with description checked, I'm info correlation id without the description checked.

A

And do we see any empty paragraph?

A

No, we don't, which is cool.

A

um So we're basically done here so we have, we have what we need.

A

A

And it's done so.

A

That's how it could be, it could be solved to add no, not this one to display the correlation id.

A

And can see we we're actually after it's after seven, so that would be it from my side antonette any questions before we finish.

A

Okay, no questions.

A

Okay thanks man um so hear you on the next live on tuesday 10 a.m. My time 8 a.m, utc.

A

Or is it already a time change.

A

Thanks man, I think it's a time change on this weekend.

A

A

25Th of october yeah this weekend we're switching um this weekend.

A

From like sunday, saturday to sunday the night on sunday, we switch time, uh so we are, I think, glow like it's gonna, be instead of 10, it's gonna, be nine, am so on tuesday we have a live stream at 8. 00 am utc and 9 am cet.

A

um Yeah anyway, see.

A

A