Skip to content

feat: when running in preparation_mode, pack graph #2185

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

feat: when running in preparation_mode, pack graph #2185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5e22af5
feat: when running in preparation_mode, pack graph
takb Nov 27, 2025
684e66f
fix: call it graph_extent instead of coverage, corresponding to how i…
takb Nov 27, 2025
e52c3e4
docs: configuration YAML changes, CHANGEDOC
takb Nov 27, 2025
def1687
fix: apitests spanning multiple contexts
takb Nov 27, 2025
ecda2e9
fix: make RoutingProfileManager singleton pattern a bit safer
takb Nov 28, 2025
16c0e01
fix: make prepareGeneratedGraphForUpload more safe and readable, add …
takb Nov 28, 2025
c7f1073
fix: resolve ORSInitContextListener anti-pattern with RoutingProfileM…
takb Nov 28, 2025
2f4cd45
test: remove apitest for preparation_mode in favor of unit tests
takb Nov 28, 2025
2372fb6
fix: mockito javaagent seems to cause trouble in the github runner
takb Nov 28, 2025
9a8f5e2
fix: remove bytebuddy version variable no longer needed
takb Nov 28, 2025
230b015
Merge branch 'main' into feat/preparation-mode-pack-graph
takb Nov 29, 2025
1acc0d7
refactor: extract method to reduce complexity
takb Nov 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Releasing is documented in RELEASE.md

### Changed
- enhanced status endpoint to expose dynamic data statistics and feature store metrics ([#2156](https://github.com/GIScience/openrouteservice/pull/2156))
- when running in `preparation_mode`, pack the graph for upload ([#2185](https://github.com/GIScience/openrouteservice/pull/2185))

### Deprecated

Expand Down
6 changes: 4 additions & 2 deletions docs/run-instance/configuration/engine/profiles/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ graphs for the specified profile.
| key | type | description | default value |
|----------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
| source_file | string | The OSM file to be used, supported formats are `.osm`, `.osm.gz`, `.osm.zip` and `.pbf` | `ors-api/src/test/files/heidelberg.test.pbf` |
| graph_extent | string | Used only in `preparation_mode` to determine the `graph_extent` part of the filename of the packed archive. See [graph repo client](/technical-details/graph-repo-client/) for more information. | _NA_ |
| profile_group | string | Used only in `preparation_mode` to determine the `profile_group` part of the filename of the packed archive. See [graph repo client](/technical-details/graph-repo-client/) for more information. | _NA_ |
| elevation | boolean | Specifies whether to download and use elevation data. If true, `cache_path` and `provider` must be set in ors.engine.elevation as well. | `false` |
| elevation_smoothing | boolean | Smooth out elevation data | `false` |
| traffic | boolean | Use traffic data if available | `false` |
Expand Down Expand Up @@ -34,7 +36,7 @@ Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.encoder_options`:
| problematic_speed_factor | number | wheelchair | Travel speeds on edges classified as problematic for wheelchair users are multiplied by this factor, use to set slow traveling speeds on such ways | `0.7` |
| turn_costs | boolean | car, hgv, bike-* | Should turn restrictions be respected | `true` |
| use_acceleration | boolean | car, hgv | Models how a vehicle would accelerate on the road segment to the maximum allowed speed. In practice it reduces speed on shorter road segments such as ones between nearby intersections in a city | `true` |
| enable_custom_models | boolean | * | Enables whether the profile is prepared to support custom models. Also see the corresponding parameter `allow_custom_models` in the [service properties](service.md). | `false` |
| enable_custom_models | boolean | * | Enables whether the profile is prepared to support custom models. Also see the corresponding parameter `allow_custom_models` in the [service properties](service.md). | `false` |

## `preparation`

Expand Down Expand Up @@ -160,7 +162,7 @@ country borders, compatible with any profile type.
| key | type | description | example value |
|--------------|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| boundaries | string | The path to a GeoJSON file containing polygons representing country borders. Ignored if `preprocessed = true` is set. | `borders.geojson.tar.gz` |
| preprocessed | boolean | Indicates whether the source OSM file has been enriched with country data. If set to `true` then country codes are read from `country` node tags rather than being resolved at build time based on geometries provided in `boundaries`. | `true` |
| preprocessed | boolean | Indicates whether the source OSM file has been enriched with country data. If set to `true` then country codes are read from `country` node tags rather than being resolved at build time based on geometries provided in `boundaries`. | `true` |
| ids | string | Path to a csv file containing a unique id for each country, its local name and its English name | `ids.csv` |
| openborders | string | Path to a csv file containing pairs of countries where the borders are open (i.e. Schengen borders) | `openborders.csv` |

Expand Down
16 changes: 8 additions & 8 deletions docs/run-instance/configuration/engine/profiles/repo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ and if graph management is
enabled [ors.engine.graph_management.enabled](/run-instance/configuration/engine/graph-management.md),
openrouteservice will use the specified repository to load the graph data.

| key | type | description | example values |
|--------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| repository_uri | string | The base URL (for a http or minio repository) or path (for a file system repository) | * `http://some.domain.ors`<br/>* `file:///absolute/path`<br/>* `/absolute/path`<br/>* `relative/path` |
| repository_name | string | An editorial name representing the target group or vendor for the graphs. | `public`, `my-organization` |
| repository_profile_group | string | A group of profiles with specific characteristics lke the usage of traffic data or the pre-calculation of advanced data structures e.g. for fastisochrones | `traffic`, `fastiso` |
| graph_extent | string | The geographic region covered by the graph. This corresponds to the OSM PBF file used for graph building. | `planet` |
| repository_user | string | The user name (key_id) for authentication at the repository. Currently only used by the minio client. | `username` |
| repository_password | string | The password (access_key) for authentication at the repository. Currently only used by the minio client. | `password` |
| key | type | description | example values |
|--------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| repository_uri | string | The base URL (for a http or minio repository) or path (for a file system repository) | * `http://some.domain.ors`<br/>* `file:///absolute/path`<br/>* `/absolute/path`<br/>* `relative/path` |
| repository_name | string | An editorial name representing the target group or vendor for the graphs. | `public`, `my-organization` |
| repository_profile_group | string | A group of profiles with specific characteristics like the usage of traffic data or the pre-calculation of advanced data structures e.g. for fastisochrones | `traffic`, `fastiso` |
| graph_extent | string | The geographic region covered by the graph. This corresponds to the OSM PBF file used for graph building. | `planet` |
| repository_user | string | The user name (key_id) for authentication at the repository. Currently only used by the minio client. | `username` |
| repository_password | string | The password (access_key) for authentication at the repository. Currently only used by the minio client. | `password` |

Each routing profile can have its individual repository parameters,
which makes it possible to have routing profiles from different repositories
Expand Down
4 changes: 2 additions & 2 deletions docs/technical-details/graph-repo-client/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ In the following graph repository example there are graphs for three target grou
http://repos.provider.com/graphs/ # repo base URL
├── project-b # repo name
│ └── basic # profile group
│ └── switzerland # coverage
│ └── switzerland # graph extent
│ └── 2 # graph version
│ ├── switzerland_2_cycling-mountain.ghz # compacted graph
│ ├── switzerland_2_cycling-mountain.yml # metadata
Expand All @@ -113,7 +113,7 @@ http://repos.provider.com/graphs/ # repo base URL
│ └── switzerland_2_cycling-street.yml # metadata
├── public # repo name
│ └── basic # profile group
│ └── europe # coverage
│ └── europe # graph extent
│ ├── 1 # graph version
│ │ ├── europe_1_driving-car.ghz # compacted graph
│ │ ├── europe_1_driving-car.yml # metadata
Expand Down
5 changes: 3 additions & 2 deletions ors-api/src/main/java/org/heigit/ors/api/Application.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
import org.springframework.context.annotation.Bean;
import org.springframework.core.env.Environment;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.scheduling.annotation.EnableScheduling;

Expand All @@ -40,9 +41,9 @@ public static void main(String[] args) {
}

@Bean("orsInitContextListenerBean")
public ServletListenerRegistrationBean<ServletContextListener> createORSInitContextListenerBean(ApiEngineProperties apiEngineProperties, GraphService graphService) {
public ServletListenerRegistrationBean<ServletContextListener> createORSInitContextListenerBean(ApiEngineProperties apiEngineProperties, GraphService graphService, Environment environment) {
ServletListenerRegistrationBean<ServletContextListener> bean = new ServletListenerRegistrationBean<>();
bean.setListener(new ORSInitContextListener(apiEngineProperties, graphService));
bean.setListener(new ORSInitContextListener(apiEngineProperties, graphService, environment));
return bean;
}
}
Loading
Loading