Skip to content

Feature/1004 update javalin drop tomcat - #1985

Open
MikeNeilson wants to merge 92 commits into
developfrom
feature/1004-update-javalin-drop-tomcat
Open

MikeNeilson wants to merge 92 commits into
developfrom
feature/1004-update-javalin-drop-tomcat

Conversation

@MikeNeilson

@MikeNeilson MikeNeilson commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Move to latest javalin (7.2.3)

Remove Use of Tomcat, no Tomcat 11+ in our local environment so will just use Javalin's default jetty and package it up.

NOTE: Due to Javalin updating the annotation plugin (this happened in javalin 5) this is going to be a large change as it touches every file and will need to alter how the OpenAPI static test works.

TODO:

  • - Make a decision on examples (thinking a follow up given the current size)
  • - Security operations behaving correctly. (I may give up for now and just put a note on the Swagger UI about the lock icons.)
  • - Get the version behaving correctly.
  • - LRTS selection Header Handled.

Related Issue

Validation

Existing integration tests

Checklist

  • AI tools used

@MikeNeilson

Copy link
Copy Markdown
Contributor Author

NOTE: at best I will have the annotations updated today. Getting the API running again in it's standalone mode will likely take until the end of the week if not longer.

@MikeNeilson

Copy link
Copy Markdown
Contributor Author

For the record. I have considered keeping with tomcat and just using like embedded tomcat for the packaging, but Javalin was made for Jetty so since that would be a fair amount of work anyway, better to use a tool that was actually built for this given style of packaging an app.

@MikeNeilson

Copy link
Copy Markdown
Contributor Author

FYI, I am aware this PR is rather huge.

The OpenAPI changes basically have to be all or nothing. I think we can all agree on that.

It also requires the migration to Jakarta EE (javalin update) which would may or may not (java.security.Principal so probably not) affect the CwmsAaaIdentityProvider.

So fair amount of changes to Tomcat anyway.

So is this likely to be a pain... yes, but I'm arguing it's worth it.

I could pivot back and do the move to standalone Javalin (e.g. Jetty whatever version that was) first, but then without updating javalin frankly it wouldn't be in a releasable state (security concerns, that's a really old Jetty)

So. for now I'm going to barrel through. I'm open to addressing concerns and pivoting if they're strong enough.

We do have a lot of plans. and the bulk are passing. What's failing is most likely various validation I've intentionally disabled due to the location of initialization changing.

@MikeNeilson
MikeNeilson force-pushed the feature/1004-update-javalin-drop-tomcat branch 2 times, most recently from e041252 to 0263cc0 Compare October 7, 2026 21:46
@MikeNeilson
MikeNeilson marked this pull request as ready for review October 8, 2026 15:06
@MikeNeilson

Copy link
Copy Markdown
Contributor Author

I'm still working through dealing with the lock icons. the behavior as a whole has change. I may need to be drastic and take the given out put to json, and put it through the Swagger OpenAPI object, but i'm hoping to do it all within the javalin openapi annotations.

I think most of issue is assumptions we previously made that are no longer required that may be getting in the way.

The primary work of the Javalin update and removal of Tomcat are finished and should be reviewed. I think I got all of the paths in correctly, but it's definitely possible that some have been missed that also weren't detected by the various validations, new and old.

NOTE: This does break /CWMSLogin. That is intentional and will be dealt with in a follow up. Once merged CDA is a standalone app like the CWMS Server apps and thus won't be getting randomly deployed to a T7 any time soon.

@MikeNeilson
MikeNeilson force-pushed the feature/1004-update-javalin-drop-tomcat branch from 33e7c77 to c7d3788 Compare October 8, 2026 16:31
Comment thread cwms-data-api/src/main/java/cwms/cda/CwmsDataApi.java
Comment thread cwms-data-api/src/main/java/cwms/cda/CwmsDataApi.java
Comment thread cwms-data-api/src/main/java/cwms/cda/CwmsDataApi.java Outdated
Comment thread cwms-data-api/src/test/java/fixtures/TestSessionHandler.java
Comment thread cda-gui/src/main/java/cwms/cda/ui/SpaErrorStatusFilter.java
Comment thread cwms-data-api/src/main/java/cwms/cda/CwmsDataApi.java Outdated
Comment thread cwms-data-api/src/main/java/picocli/CommandLine.java Outdated
Comment thread cwms-data-api/src/main/java/picocli/CommandLine.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/api/ProjectController.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/api/ProjectController.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/api/ParametersController.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/api/StreamLocationController.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/api/TurbineController.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/api/MeasurementTimeExtentsGetController.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/CwmsDataApi.java Outdated
Comment thread cwms-data-api/src/main/java/cwms/cda/api/TimeSeriesController.java Outdated
Comment thread cwms-data-api/build.gradle Outdated
Comment thread cwms-data-api/src/main/webapp/WEB-INF/web.xml Outdated
Comment thread cwms-data-api/build.gradle Outdated
@MikeNeilson
MikeNeilson force-pushed the feature/1004-update-javalin-drop-tomcat branch from bec683a to 62a5c9e Compare October 29, 2026 16:44
@MikeNeilson

Copy link
Copy Markdown
Contributor Author

Okay, I think that's it. Or at the very least, I think that's all we're going to find without just moving forward. Too many staged PR that need different imports and certain structural elements to let this linger too much longer even if it might break a few things.

@MikeNeilson

Copy link
Copy Markdown
Contributor Author

@oskarhurst @rma-rripken @rma-psmorris

NOTE: I'm aware it's a bit, abrupt, but I don't want this to lag. Should I here nothing by end of day Friday I'm going to merge and accept the consequences.

Comment on lines 45 to +46
@JsonProperty("datatype")
@OpenApiName("datatype")

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

weird that we need JsonProperty and OpenApiName

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obnoxious is the better word.
We use a specific FasterXML library library to do the mapping, it uses JsonProperty.

The updated javalin-openapi does it's own thing, thus the addition of the OpenApiName annotation.

@rma-psmorris

Copy link
Copy Markdown
Collaborator

NOTE: I'm aware it's a bit, abrupt, but I don't want this to lag. Should I here nothing by end of day Friday I'm going to merge and accept the consequences.

@MikeNeilson -- could you delay this for a week? I'm setup to go through this review and would like to be able to do so. I'm off tomorrow so would not be able to complete a review before end of day. I will certainly be able to do my review next week.

@MikeNeilson

Copy link
Copy Markdown
Contributor Author

NOTE: I'm aware it's a bit, abrupt, but I don't want this to lag. Should I here nothing by end of day Friday I'm going to merge and accept the consequences.

@MikeNeilson -- could you delay this for a week? I'm setup to go through this review and would like to be able to do so. I'm off tomorrow so would not be able to complete a review before end of day. I will certainly be able to do my review next week.

I would prefer not to; however, there's already going to be follow up, there's a few known things, and I changed 500+ files - there's no way we caught everything. So there will still be value in that review.

The burden of updates to this PR is getting high. And there's about 4-5 more that need to start getting merged in. I want to just get it over with, the initial hurdle anyway.

So no, but this PR being closed doesn't me you shouldn't review anyway so things can get fixed.

tags = {TAG}
methods = HttpMethod.POST,
tags = {TAG},
path = "/v2/blob/"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this class get registered as /v2/blobs/ ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wait, yeah, probably. Good catch, I actually meant to go back and check that. Will do so in the morning. (currently having network issues.)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants