Jakarta EE Tech Talks, 8 Apr 2021

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Eclipse Language Server for Jakarta EE: What's New & What's Next | Jakarta Tech Talks | Apr 8, 2021

Description

The Eclipse LSP4Jakarta project (https://projects.eclipse.org/projects/technology.lsp4jakarta) along with student contributors from the CANOSP initiative (https://canosp.ca/) would like to provide an update and demonstration of the latest progress on building a Language Server for Jakarta EE to enable cloud-native Java developers to build with Jakarta EE APIs.

Join us for a project update, a demonstration of the latest enhancements, and a look what's next!

Get involved: https://github.com/eclipse/lsp4jakarta

Speakers:

YK Chang (IBM)
Kathryn Kodama (IBM)
Matthew Shocrylas (University of Alberta)
Leslie Dawson (McGill University)

Get Social!

Website: jakarta.ee
Subscribe: https://www.youtube.com/user/EclipseF...
Follow us on Twitter: https://twitter.com/JakartaEE
Like us on Facebook: https://www.facebook.com/JakartaEE/
Join us on LinkedIn: https://www.linkedin.com/groups/13597...
Tag us: #JakartaEE
Want more great Eclipse Community webinars? Become a member of our Jakarta Tech Talks Meetup: https://www.meetup.com/jakartatechtalks

A

All right good, good morning, good afternoon and good evening, everyone we are glad to be here and thank you to uh to all of you for joining us today. We want to take the time here in the next 30 minutes or so to share with everyone what we have going on with eclipse sp for jakarta project, which is uh looking at building a language server for jakarta ee apis.

A

So we'll talk about where their project is and and provide everyone with a project update some project updates and then we'll dive into the team we'll dive into uh some of the rehab recent enhancements and uh contributions that that's been done. So that's what we'll do today and let us know if you have any questions or feedback, we would love to hear from you and work with you on this project.

A

Over to you, catherine.

B

Thanks, okay, so we'll be talking about what's new and what's next with our project today, uh so I'm here joined by uh leslie and matthew. So to start we are our the eclipse lsp for jakarta. Project offers language server protocol based coding, assistance for the jakarta ee apis and the jakarta. E-Apis are the open, cloud-native java apis that assist developers when they are creating their java enterprise applications.

B

So our project will offer a system such as code, completion or diagnostics errors and warnings, as developers are using these apis in their preferred ide or text editor, and for the past few months we have been working on this project in partnership with kanos, which is the canadian open source projects.

B

Academic program- and this is a program- that's run here in canada- that connects students with open source projects. They can work on. So we have been fortunate enough to participate in this program. This is our second term participating and we've had the honor of working with five very skilled university students this term, so I've got leslie from mcgill university and matthew from university of alberta here with us today.

B

I also like to call out hannie, mandy and bara, who have also been working on this project.

B

So, let's start with what's new with the project. So previously we did a tech talk like this back in december, but since then there have been a number of updates to the project, so uh the most important is that our project proposal has been approved. So we have created the project under the eclipse foundation and uh submitted the initial community contribution, and, along with that, we have renamed to use the eclipse namespace and we've added improved coverage for the web profile apis.

B

So before I hand it over to leslie and matthew, I will give a bit of a background on the project. So to start what is a language server, and so the language server language server protocol has become the standard way to provide language support, features things such as snippets document areas and warnings which we call diagnostics or code completion through a preferred, editor or ide, and so the idea here is you create one language server and it can be reused through minimal clients in multiple ides or text editors.

B

So by decoupling, this task, the same language server, can add language support for multiple different ides and text. Editors.

B

So here's an overview of what our project looks like, so we have the lsp for jakarta project, which is our language server for jakarta, ee and as per the language server protocol. It communicates with the eclipse ide through json rpc and in eclipse. We are offering as part of this project an eclipse, ide plugin and this plugin starts and consumes our language server.

B

So, as developers are using jakarta e apis in their java files, they will start receiving language feature. Support such as completion diagnostics, snippets and more, and so the eclipse also contains the eclipse jdt, which is the eclipse java development tools, and this is a set of tools that powers the eclipse development environment for java, and this can perform work such as competing class paths, compiling code manipulation.

B

So to avoid duplicating that work in our plugin, we also include a jdt extension, so whenever we need knowledge of the class path or we need to manipulate the code, that is also handled by the jdt extension within our plug-in.

B

So with that, I will hand it over to matthew and leslie to talk about some of these specific enhancements. They have made throughout the past few months and give us a demo.

C

Hey I'm matthew, so I'm gonna just talk about some of the enhancements we've done over the past semester, so some of the stuff, as a team we've been working on, are jakarta, restful, web services, support or jax rs, and doing uh making snippets diagnostics and quick fixes for that, as well as more jakarta content and dependency injection cdi support and making diagnostics and quick fixes for that as well.

C

So some examples of next slide, some examples of what I've specifically been working on is a diagnostic and a quick fix for jax arrest, resource method visibility.

C

So it's just one of the diagnostics: that's checking for proper visibility on resource methods and includes a quick fix as well to fix that as well as uh yeah uh diagnostic warnings for root resource class constructors for jax rs as well, where it'll just warn you, if there's multiple constructors, with different parameters of the same amount and give the proper diagnostic for that as well.

C

So yeah now uh leslie will talk about some of the other stuff. We've been working on.

D

Yeah hi um so um leslie and um some of the stuff that I've been working on this semester for um the language server enhancements was adding uh jakarta, jason b support, as well as adding quick fixes for the existing diagnostics for invalidation, and uh you can see in this gif here. Basically, the quick fix um identifies. So uh you can't have a static field with a annotation, the constraint, annotation and so there's two quick fixes available uh one to either remove the annotation and one to remove the uh the static modifier.

D

So you can choose um another one here and uh similarly, this one's just not static, and so you just get a quick fix to remove the constraint annotation in this situation.

D

And that's pretty much it go back to matthew to start the demo.

C

Okay, I'll just uh share my screen: real, quick and so yeah. I'm going to show you using open liberty, we're going to make a project. That kind of you want to show a list of students and then be able to display it and give it other students through a website. So I'll start off by making a student's class.

C

Okay, and so I can use this snippet, one of the jax rs snippets here- just set up the set up the file and set up all the correct paths we'll do.

C

C

C

Oh oops, there we go okay, so now we have this method and so, for example, if I for some reason wanted to make this private it'll, give me a warning that I can't do that, and I can just check the quick fix and I'll change it back over.

C

We'll add this to the path.

C

And then I can go here and just.

C

Working yep, so we get the hello. So I basically just using snippets and changing some of.

B

C

Names, I've already got it showing up here.

C

So now, if I wanted to be able to add students to a list, for example, I can use another code snippet.

C

C

C

And just import these.

C

Okay, so one other example of the diagnostic is: let's say I try to add a second argument to this.

C

We'll get a warning that resource methods can't have multiple end parameters, since uh this is just something outlined in spec. There'd be no way to access this, so um yeah, you might have. You might be debugging and you're, not sure why you're not getting this uh information? That's because the server just can't fix that and yeah. Now I will pass you over to leslie who will pick up with a version where we've implemented a bit more and show you some more stuff.

D

Yeah so sure my screen here all right, so here we have the uh the students app again um and I've just implemented. We've just implemented a little bit more of the uh the get students method and we also have a post method for creating a new student.

D

uh It doesn't do very much right now, um so we're just gonna add a little bit to that and also show the the person class that we're using for the uh the entity. um So first I've got some errors here. um So the diagnostic here, a class using the entity annotation, must not be final.

D

So another one of the quick fixes that we've implemented is um it will actually just remove the the final modifier from this class.

D

So that's better and then here we've got uh an internal id field, um which is a string, but it has future annotation uh and we'll get the diagnostic that the funeral future annotation can only be used on date, type fields, um and so we get another quick fix to remove the constraint annotation there.

D

So maybe we want to add a little bit more to this applications when we create students. So let's say we want to add a name to the students, um so we're going to add path, parameter.

D

D

And in here we can add.

D

D

Something like this, and then we get another diagnostic now that we've added stuff to the uh constructor um again a class using the entity annotation. It has to have a public or protected constructor with no arguments, and so we've added a quick, quick fix for this as well, um which will add either a you can choose between a no argument: protected constructor or a public one.

D

um Let's just go with the public one in this case um all right and you should be able now to uh make a post request um to add a new student and again I'm just running the uh the same open liberty, application here and we can see created the student chris. So if I refresh the page um student being there, but I've forgotten to actually add the name to the student anyway.

D

So there's also the ability to add.

D

We can add a name for the student as well.

D

So let's do another path.

D

D

D

D

And say for some reason: we wanted to make it static, um and then we added the constraint that it has to be positive. It doesn't really make sense to have a negative age, um we'll get another diagnostic uh constraint. Annotations are not allowed on static fields, um and so, as in the the give earlier, I'm just remove that static modifier.

D

um I also need getters.

D

So now we're creating a student with an age, um so we should be able to do something like student mark, who's, 24.

D

um again get the new message and refresh it uh and yeah. Now that I have the editors we're getting the names as well and the ages, so these um annotations again they're just constrained annotations. If we didn't have this positive one, we would be able to create.

D

Weird students with you know negative ages, um and it would get mad at us.

D

Whereas when we have the constraint we'll see here that we can't create um a student with a negative age,.

D

So that's just uh to show some of the the quick fixes we've added and how they can be used to make a little student list application, um and I will pass it back now. I think to catherine.

B

All right thanks, leslie matthews, so the point uh here is that, as you have your uh jakarta e language, server enabled and you're coding with your jakarta e apis, as you saw on the demo, you'll start to get some diagnostics. If perhaps you've used some of the specs wrong or as matthew showed, there are snippets so that you can get chunks of code that you may use very often easier.

B

So now, I'm going to talk a bit about what's next for the project, so as leslie and matthew showed, we have been working on adding support for some priority web profile apis.

B

So we have complete support for servlet persistence and beam validation, as well as context and dependency injection, and the team has been working on adding support for jakarta, restful, web services, json, b and annotations, and there are still a few priority web profile apis. We would like to add support for as well beyond that. We would like to work towards an easily installable eclipse, ide plugin, so that people can try out the application and their own eclipse id instances and just make it easier to install.

B

We also have a number of internal enhancements. We would like to add to the project such as dynamic templating for snippets and filtering diagnostics based on the class path, as well as expanding beyond the web profile apis. We would like to add language support for the remaining jakarta e apis and looking forward even more into the future, eventually expanding to more editors, so perhaps creating a vs code client that would consume the lsp for jakarta language server.

B

um And I'll end here with a call to get involved. So, as we mentioned, we are now under the eclipse namespace, as the project proposal has been approved. So you can contribute today directly to the lsp for jakarta project on github. We welcome issues for any enhancements or specific api support, you'd like to see or as it's open source, you know just submit any pull requests for any items you'd like to see and definitely try it out check out the project.

B

We welcome any feedback or suggestions you guys may have, and that's all we have for today. Yeah.

A

Yeah thanks team, so, as the team has demonstrated, unless we uh um catherine was sharing this, it's still the in the early days of the project right. So we have support for uh a preliminary set of apis and web profile for jakarta ee and we are working to uh with the team and the community to uh build uh additional support for additional apis. As we all know, there's a a significant number of apis in jakarta e itself, so we'll work towards that.

A

At the same time, there's also the client and client side support, whether it's with uh eclipse for sure and and others ides down the road that we will be uh want to build and be happy to um collaborate with any interested uh parties with right. So so, if you want to contribute, we would certainly be glad to uh to work with you on that.

A

Just reach out right on the the through the github or otherwise we'd be happy to discuss uh whether it's with contribution or working together on the language server itself or with the front-end eclipse, ide client, or with consuming the language server in other ids out there, whether it's netbeans uh vs code and so on and so forth for intellij um we'll be happy to discuss, because we really want to build a solid language right here.

A

For eclipse I mean for jakarta, ee and then to enable uh developers out there to work with jakarta e apis easily in in any editor. Essentially so yeah um kevin has a question, so it's yeah. We can take some questions if you have any questions, feel free to post in the chat and then they'll ask a question and we'll try to talk through them in the rest of the time we have here. um Yes, we do have a github project setup, which is there right uh whoa.

A

Well, I guess kevin is asking more more specifically about project plans, yeah, that's what we are looking to build out right, so so we've now that we have the initial contribution and the initial set of work going on so we'll flash out delta a bit more of a concrete project plan. We expect that uh we will work towards completing the support for web profile uh first and then also um having um and then one of the items that catherine was saying uh to look at to see.

A

If we can build a client for eclipse id and have it, maybe even in in the marketplace, if possible, um there's an early release for us. So so that's what we are. That's what we'll look to do and and and we'll fill in the blanks and flesh out the plan in more details as we move forward so um yeah. If you have any suggestions or feedback just just post them in get helpful or create an issue or whatnot right, so we'll look at them.

A

Yes, we certainly look forward to uh and we appreciate the community participation and contribution, because it's really open source and um and that's what jakarta itself is about right, so open cloud collaboration on uh moving forward the uh what we need to to define as the uh open set of cloud native java apis for for building uh cloud-native applications with uh with uh java right. So, similarly on on this end of this side of the fence with the tooling, it's again, it's an open cloud collaborative effort.

A

So so we look forward to any and all collaboration and contributions from anyone.

E

So awesome well, thank you, um yk catherine, leslie and matthew for that presentation today. um If there are any last minute questions, please feel free to ask them in the chat. Just while I wrap things up here. Thank you again team for all your hard work this year and uh your progress is definitely fantastic to see. We're really excited to see what comes next for this project um and we look forward to future tech talks that you guys present.

E

um So just a few housekeeping things before we wrap up the next jakarta tech talk will happen on tuesday um when chad, carlson from platform sh presents, get ops, keeps the focus on product metal infrastructure and you can register for that session. Using the link I just posted in the chat.

E

We are also always looking for more tech talks. So, if you'd like to sign up to present one, you can do so using the second link that I just posted.

E

And finally, if you have any feedback for the tech talk program as a whole um or if you really like this session, we'd love to hear from you. um So if you use the link that I just or used the button that I just posted at the bottom of the screen there to submit your feedback, we would love to hear that. So at this point I've got nothing else. So thank you, everyone for joining today and team. If you guys want to say goodbye and thank you by all means and we'll wrap this up.

A

Yeah, thank you all and reach out. If you have any uh feedback or suggestions, and it's great, you know being able to have the opportunity to uh share what the project where the project is and what the team has done and um well. Thank you for hosting us on the team. So.

E

All right, bye, everybody.