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.

Sign up for GitHub

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

Jump to bottom

refactor: 1348 upgrade to spring boot 3x #1504

Merged
merged 23 commits into from
Jul 24, 2023
Merged

refactor: 1348 upgrade to spring boot 3x #1504

merged 23 commits into from
Jul 24, 2023

Conversation

TheGreatRefrigerator
Copy link
Contributor

@TheGreatRefrigerator TheGreatRefrigerator commented Jul 20, 2023 •
edited
Loading

Pull Request Checklist

  • 1. I have rebased the latest version of the master branch into my feature branch and all conflicts
    have been resolved.
  • 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the
    [Unreleased] heading.
  • 3. I have documented my code using JDocs tags.
  • 4. I have removed unnecessary commented out code, imports and System.out.println statements.
  • 5. I have written JUnit tests for any new methods/classes and ensured that they pass.
  • 6. I have created API tests for any new functionality exposed to the API.
  • 7. If changes/additions are made to the ors-config.json file, I have added these to the ors config documentation
    along with a short description of what it is for, and documented this in the Pull Request (below).
  • 8. I have built graphs with my code of the Heidelberg.osm.gz file and run the api-tests with all test passing
  • 9. I have referenced the Issue Number in the Pull Request (if the changes were from an issue).
  • 10. For new features or changes involving building of graphs, I have tested on a larger dataset
    (at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
  • 11. For new features or changes involving the graphbuilding process (i.e. changing encoders, updating the
    importer etc.), I have generated longer distance routes for the affected profiles with different options
    (avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
    points generated from the current live ORS.
    If there are differences then the reasoning for these MUST be documented in the pull request.
  • 12. I have written in the Pull Request information about the changes made including their intended usage
    and why the change was needed.
  • 13. For changes touching the API documentation, I have tested that the API playground renders correctly.

Fixes # .

Information about the changes

  • Key functionality added: migration to spring-boot 3.1.1
  • Reason for change: being up to date
    As there were quite some refactorings done, this is not just a chore but refactor PR

Examples and reasons for differences between live ORS routes, and those generated from this pull request

Required changes to ors config (if applicable)

@TheGreatRefrigerator TheGreatRefrigerator linked an issue Jul 20, 2023 that may be closed by this pull request
Upgrade to spring-boot 3.x #1348
Closed
@TheGreatRefrigerator TheGreatRefrigerator marked this pull request as ready for review July 20, 2023 12:29
TheGreatRefrigerator and others added 5 commits July 20, 2023 14:30
@TheGreatRefrigerator
chore: migrate to Jakarta EE 9
d22353a 
using new `jakarta` namespace
@TheGreatRefrigerator @koebi
style(Java17): reformat multiline strings to codeblocks
302fe9c 
Co-authored-by: Jakob Schnell <jakob.schnell@heigit.org>
@TheGreatRefrigerator @koebi
style: use explicit over star import
5d7f6e0 
Co-authored-by: Jakob Schnell <jakob.schnell@heigit.org>
@TheGreatRefrigerator @koebi
style(Java15): use formatted() instead of String.format()
13f7a44 
Co-authored-by: Jakob Schnell <jakob.schnell@heigit.org>
@TheGreatRefrigerator @koebi
test(Junit5): use default package visibility
09f2395 
Co-authored-by: Jakob Schnell <jakob.schnell@heigit.org>
TheGreatRefrigerator and others added 15 commits July 21, 2023 16:37
@TheGreatRefrigerator
build(deps): use spring-boot-starter-parent v3.1.1
80e4e29
@TheGreatRefrigerator
build(deps): use springdoc-openapi-starter-webmvc-ui
7aafe81 
the previously uses package springdoc-openapi-ui was not the
correct one to be used with spring-boot 3

the application properties 'springdoc.packages-to-scan' and
'springdoc.pathsToMatch' are now needed for the OpenAPI specs
to be generated properly.
@TheGreatRefrigerator
chore: remove unused workaround for springfox-swagger package
792a42d 
as the springfox-swagger package was replaced, this workaround is not
needed anymore.

- optimize imports
@TheGreatRefrigerator
refactor: remove GroupedOpenApi builders
1b720a4 
as we currently only expose the v2 API we don't need the
grouped OpenAPI specs. Once we want to generate both v2 and v3
API specs in parallel we need to reintroduce this.
@TheGreatRefrigerator
style: remove default OpenAPI spec version
e59ab7d 
the SpecVersion used here should be the OpenAPI V30 which
is already the default for an OpenAPI instance and is therefore removed.
@TheGreatRefrigerator
refactor: SwaggerConfig.java to OpenAPIConfig.java
d860f40 
name change due to specs being OpenAPI 3 now instead of swagger 2
@koebi @TheGreatRefrigerator
test: re-enable openapi unittest
b9d6315
@TheGreatRefrigerator
test: reintroduce OpenAPI api tests
498f29f 
debugging the exact location of errors was not straight forward,
due to messages containing the wrong location.
Added Hint on how to debug in docstring.
Adjusted size numbers after removal of centrality endpoint.
@TheGreatRefrigerator
fix: defaultValue for matrix 'metrics' parameter
ff95ea1
@TheGreatRefrigerator
refactor: name changes from Swagger to OpenAPi
13f4f97
@koebi @TheGreatRefrigerator
fix: route request duration format
7a212a7 
due to the 'schedule_duration' and 'walking_time' being of
type Duration, the type of the parameters was exposed as objects.
The values passed were however always Strings.

- Adjusted schema type in RouteRequest to String for durations
@TheGreatRefrigerator
test: adjust openapi.ResultTest
19b1f8f 
as the exact number of tags, paths and components will change and for
components is not consistent, we just check if there are some at all.
@TheGreatRefrigerator
refactor: provide format info for duration parameters
28f8a31
@TheGreatRefrigerator
docs: add CHANGELOG.md entry for spring-boot migration changes
0732bce
@koebi @TheGreatRefrigerator
build: upgrade to tomcat 10
61523f7 
springboot 3 requires jakarta servlet 6 which in turn requires tomcat
10:
https://tomcat.apache.org/whichversion.html
@TheGreatRefrigerator TheGreatRefrigerator force-pushed the chore/1348-upgrade-to-spring-boot-3x branch from d38be18 to 61523f7 Compare July 21, 2023 14:37
@TheGreatRefrigerator
Copy link
Contributor Author

changed some more of the pattern variables, see
https://github.com/GIScience/openrouteservice/compare/d38be18950e9f434f70cb7a4143ec1ffd16cd66d..61523f797ba36b216dc104f8f1e8a4b23816bd0d

@MichaelsJP MichaelsJP enabled auto-merge July 24, 2023 14:44
@MichaelsJP MichaelsJP removed request for takb and jhaeu July 24, 2023 14:45
@MichaelsJP MichaelsJP disabled auto-merge July 24, 2023 14:45
@MichaelsJP MichaelsJP merged commit 9da1855 into master Jul 24, 2023
@MichaelsJP MichaelsJP deleted the chore/1348-upgrade-to-spring-boot-3x branch July 24, 2023 14:46
@TheGreatRefrigerator TheGreatRefrigerator mentioned this pull request Aug 2, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MichaelsJP MichaelsJP MichaelsJP approved these changes

Assignees
No one assigned
Labels
refactor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Upgrade to spring-boot 3.x
3 participants
@TheGreatRefrigerator @MichaelsJP @koebi