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

feat: configuration using YAML files #1506

Merged
merged 43 commits into from
Jul 28, 2023
Merged

feat: configuration using YAML files #1506

merged 43 commits into from
Jul 28, 2023

Conversation

takb
Copy link
Contributor

@takb takb commented Jul 24, 2023

Pull Request Checklist

  • 1. I have [rebased][rebase] 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][config]
    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][api].

Information about the changes

  • default configuration in application.yml
  • apitests configuration in application-test.yml
  • look for config files named ors-config.yml in /etc/openrouteservice/, ~/.openrouteservice/and./` able to override the default settings
  • deprecated AppConfig class and removed JSON files
  • for the deprecation phase, old JSON configurations override every setting in yml files, temporary code bundled in org.heigit.ors.api.util.AppConfigMigration class
  • some fixes to log formatting, log settings in JSON don't work anymore
  • refactoring of API request handling and limit checks

@takb takb linked an issue Jul 24, 2023 that may be closed by this pull request
@takb takb changed the title Refactor/ors config feat: configuration using YAML files Jul 24, 2023
@takb takb marked this pull request as ready for review July 24, 2023 11:34
@github-actions github-actions bot added feature and removed feature labels Jul 24, 2023
@takb takb requested a review from jhaeu July 26, 2023 10:54
@github-actions github-actions bot added feature and removed feature labels Jul 26, 2023
Copy link
Contributor

@jhaeu jhaeu left a comment

Choose a reason for hiding this comment

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

LGTM

docker-entrypoint.sh Outdated Show resolved Hide resolved
docs/installation/Configuration.md Show resolved Hide resolved
ors-api/pom.xml Show resolved Hide resolved
@MichaelsJP MichaelsJP self-requested a review July 26, 2023 15:24
@github-actions github-actions bot added feature and removed feature labels Jul 26, 2023
.github/workflows/build-and-publish.yml Outdated Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
docker-compose.yml Outdated Show resolved Hide resolved
ors-api/src/main/resources/log4j.properties Outdated Show resolved Hide resolved
@takb takb force-pushed the refactor/ors_config branch 3 times, most recently from 01495d9 to 2a5ffb5 Compare July 27, 2023 12:58
@takb takb force-pushed the refactor/ors_config branch from 2a5ffb5 to fca382e Compare July 27, 2023 13:24
@takb takb requested a review from MichaelsJP July 27, 2023 15:07
@github-actions github-actions bot added feature and removed feature labels Jul 27, 2023
docker-entrypoint.sh Show resolved Hide resolved
Co-authored-by: Julian Psotta <22392104+MichaelsJP@users.noreply.github.com>
@takb takb requested a review from MichaelsJP July 28, 2023 07:35
@github-actions github-actions bot added feature and removed feature labels Jul 28, 2023
@takb takb merged commit 224e634 into master Jul 28, 2023
@takb takb deleted the refactor/ors_config branch July 28, 2023 10:37
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.

Configuration Rework
4 participants