Skip to content
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.

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

Update Jakarta Servlet chapter for Servlet 6.0 (part of Jakarta EE 10) #74

Open
kito99 opened this issue Nov 7, 2023 · 21 comments
Open
Assignees
Labels
help wanted Extra attention is needed

Comments

@kito99
Copy link

kito99 commented Nov 7, 2023

Current tutorial chapters for Servlet: https://jakartaee.github.io/jakartaee-documentation/jakartaee-tutorial/current/web/webapp/webapp.html

For background, here are the changes for Servlet 6.0:

The only change that may affect the tutorial is the removal of deprecated features.

Please do the following:

@kito99 kito99 converted this from a draft issue Nov 7, 2023
@kito99 kito99 added this to the Jakarta EE 10 Updates milestone Nov 7, 2023
@kito99 kito99 added the help wanted Extra attention is needed label Nov 7, 2023
@kito99
Copy link
Author

kito99 commented Nov 7, 2023

@markt-asf and @stuartwdouglas can you take a look at this in the next couple of days? I'd love to know (a) if this looks accurate for Jakarta EE 10 and (b) if you or someone on the team can make this change.

@kito99
Copy link
Author

kito99 commented Nov 9, 2023

@jhammen this is a good candidate.

@kito99 kito99 self-assigned this Nov 9, 2023
@kito99 kito99 moved this from 📋 Backlog to 🔖 Ready in Jakarta EE Tutorial Refresh Nov 9, 2023
@jhammen
Copy link

jhammen commented Nov 16, 2023

happy to work on this but it looks like there are some major changes to these sections still waiting in PR #36 @kito99 @BalusC do you think these changes are likely to be merged soon?

@kito99
Copy link
Author

kito99 commented Nov 16, 2023

@jhammen I think the changes to that PR are good; @BalusC can you merge in main and test the build (if you haven't already)?

@BalusC
Copy link
Member

BalusC commented Nov 16, 2023

Done. You can advance.

@jhammen
Copy link

jhammen commented Nov 21, 2023

First example mentioned is "hello-servlet" which does not exist at the path given, looks like it was repaced with a "hello2" example which has similar code and an additional servlet. So the copy needs to be updated, code snippets should use the new code and links should point to the new example paths.

The "hello2" example does not appear to have any deprecated methods, works fine with tomcat:10.1.16

@BalusC
Copy link
Member

BalusC commented Nov 21, 2023

So the copy needs to be updated, code snippets should use the new code and links should point to the new example paths.

Please no. It's the other way round. hello1 and hello2 from previous tutorial versions have been replaced by hello-faces and hello-servlet via https://github.com/jakartaee/jakartaee-tutorial/pull/24/files

Surely the old ones will work fine but they expose outdated/bad practices these days.

I am aware that the tutorial examples needed to catch up this but then Eclipse's budget for the initial work ran out and I've higher priorities in my free time (OmniFaces and Jakarta Faces itself, for example). I do however have a complete rewrite of Jakarta Faces chapter of the EE10 tutorial in my mind. So please leave that to me if possible. Note that its original source, the Faces 4.0 spec, has already been rewritten by me ~2y ago: https://jakarta.ee/specifications/faces/4.0/jakarta-faces-4.0

Btw I would love to continue reviewing the servlet chapters because I also had a lot of improvements for these in my mind. The existing examples are horribly outdated.

@BalusC
Copy link
Member

BalusC commented Nov 21, 2023

I am aware that the tutorial examples needed to catch up

Oh wait. They were already created. The PR is simply still pending review/merge. eclipse-ee4j/jakartaee-examples#80 The difficulty is that review/merge is beyond our control because repo is in different organization. As of now only @arjantijms can do that.

@jhammen
Copy link

jhammen commented Nov 21, 2023

OK that all makes sense and I'm glad this already fixed pending PR.

@BalusC I don't want to get in the way if you have this update under control, I'm happy to step back. Did you want to assign me tickets for things you intended to do? Otherwise maybe @kito99 can assign other sections for me to work while I have the time to spare

@BalusC
Copy link
Member

BalusC commented Nov 21, 2023

Current ticket is only for "Jakarta Servlet" so that's completely fine :)

@jhammen
Copy link

jhammen commented Nov 21, 2023

OK cool I'll continue, but maybe will wait until that PR is merged as I'm not sure it makes a lot of sense to review the examples before they are up to date

@kito99
Copy link
Author

kito99 commented Nov 21, 2023

@jhammen you can update the text in the meantime if you want..

jhammen added a commit to jhammen/jakartaee-tutorial that referenced this issue Nov 22, 2023
@jhammen
Copy link

jhammen commented Nov 22, 2023

@jhammen you can update the text in the meantime if you want..

You're right - the 6.0 links are now added/updated, please see the above commit reflected here:

https://jhammen.github.io/jeetutorial/current/web/servlets/servlets.html#_further_information_about_jakarta_servlet_technology

jhammen added a commit to jhammen/jakartaee-tutorial that referenced this issue Nov 22, 2023
@kito99 kito99 moved this from 🔖 Ready to 🏗 In progress in Jakarta EE Tutorial Refresh Nov 22, 2023
@kito99
Copy link
Author

kito99 commented Dec 14, 2023

@jhammen it would also be nice to add a couple sentences about the new feature to get a UUID and other connection details for an incoming request to the https://jakartaee.github.io/jakartaee-documentation/jakartaee-tutorial/current/web/servlets/servlets.html#_getting_information_from_requests section. See #91.

@kito99
Copy link
Author

kito99 commented Oct 16, 2024

@jhammen @BalusC what is the status of this?

@BalusC
Copy link
Member

BalusC commented Oct 20, 2024

As to my concerns, eclipse-ee4j/jakartaee-examples#80 was finally merged last June. So I don't have any technical concerns/blockers since.

@kito99
Copy link
Author

kito99 commented Oct 28, 2024

Cool! Thanks, @BalusC. @jhammen do you want to pick this back up again?

@jhammen
Copy link

jhammen commented Oct 28, 2024

For sure, will take a look this week

@kito99
Copy link
Author

kito99 commented Oct 28, 2024

thanks @jhammen !

@jhammen
Copy link

jhammen commented Oct 31, 2024

Review the examples and look for any deprecated methods. If you see one, let us know so we can create a ticket to fix the example, because it won't compile in Servlet 6.

I've reviewed and tested the servlet examples mentioned in this chapter and found no issues with deprecated methods.

Examples tested were:

  • hello-servlet
  • hello-faces
  • mood
  • dukeeft
  • fileupload

There are some smaller snippets that are not official examples e.g. TimeZoneHandler, ShutdownExample, these also look free of deprecated or removed methods.

jhammen added a commit to jhammen/jakartaee-tutorial that referenced this issue Nov 1, 2024
@jhammen
Copy link

jhammen commented Nov 1, 2024

@kito99 please check above PR with content changes. I'm not seeing much else to add or change for Servlet 6.0 so let me know if there's anything left for this issue

(BTW it's already a pretty long chapter, may want to chop it up into more than one page at some point.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
Status: 🏗 In progress
Development

No branches or pull requests

3 participants