Minor fixes by mjjbell · Pull Request #6655 · Project-OSRM/osrm-backend

mjjbell · 2023-07-17T22:00:57Z

Issue

A couple of minor issues spotted whilst working on optional data loading.

Correct HTTP docs to reflect summary output dependency on steps parameter.
There is no summary parameter.
Ensure required file check in osrm-routed is correctly enforced.
The storage module has a stricter check. This keeps the IOConfig check in sync.

Tasklist

CHANGELOG.md entry (How to write a changelog entry)
update relevant Wiki pages
add tests (see testing documentation)
review
adjust for comments
cherry pick to release branch

mjjbell · 2023-07-17T22:02:55Z

include/storage/storage_config.hpp

+                    ".osrm.nbg_nodes",
                    ".osrm.timestamp",
+                    ".osrm.tls",
+                    ".osrm.tld",


osrm-backend/src/storage/storage.cpp

Lines 294 to 332 in 62e11fd

std::vector<std::pair<bool, boost::filesystem::path>> files = {

{IS_OPTIONAL, config.GetPath(".osrm.cells")},

{IS_OPTIONAL, config.GetPath(".osrm.partition")},

{IS_REQUIRED, config.GetPath(".osrm.icd")},

{IS_REQUIRED, config.GetPath(".osrm.properties")},

{IS_REQUIRED, config.GetPath(".osrm.nbg_nodes")},

{IS_REQUIRED, config.GetPath(".osrm.ebg_nodes")},

{IS_REQUIRED, config.GetPath(".osrm.tls")},

{IS_REQUIRED, config.GetPath(".osrm.tld")},

{IS_REQUIRED, config.GetPath(".osrm.timestamp")},

{IS_REQUIRED, config.GetPath(".osrm.maneuver_overrides")},

{IS_REQUIRED, config.GetPath(".osrm.edges")},

{IS_REQUIRED, config.GetPath(".osrm.names")},

{IS_REQUIRED, config.GetPath(".osrm.ramIndex")}};

for (const auto &file : files)

{

if (file.first == IS_REQUIRED && !boost::filesystem::exists(file.second))

{

throw util::exception("Could not find required file(s): " + std::get<1>(file).string());

}

}

return files;

}

std::vector<std::pair<bool, boost::filesystem::path>> Storage::GetUpdatableFiles()

{

constexpr bool IS_REQUIRED = true;

constexpr bool IS_OPTIONAL = false;

std::vector<std::pair<bool, boost::filesystem::path>> files = {

{IS_OPTIONAL, config.GetPath(".osrm.mldgr")},

{IS_OPTIONAL, config.GetPath(".osrm.cell_metrics")},

{IS_OPTIONAL, config.GetPath(".osrm.hsgr")},

{IS_REQUIRED, config.GetPath(".osrm.datasource_names")},

{IS_REQUIRED, config.GetPath(".osrm.geometry")},

{IS_REQUIRED, config.GetPath(".osrm.turn_weight_penalties")},

{IS_REQUIRED, config.GetPath(".osrm.turn_duration_penalties")}};

mjjbell · 2023-07-17T22:05:06Z

docs/http.md

-| true         | Names of the two major roads used. Can be empty if the route is too short.|
-| false        | empty `string`                                                        |
+| steps |                                                                       |
+|-------|-----------------------------------------------------------------------|


osrm-backend/include/engine/api/route_api.hpp

Lines 913 to 917 in 62e11fd

if (parameters.steps)

{

leg.summary = guidance::assembleSummary(

facade, path_data, phantoms.target_phantom, reversed_target);

The storage module had a stricter check. This keeps the IOConfig check in sync.

…eter. There is no summary parameter.

mjjbell · 2023-07-17T22:07:29Z

include/storage/storage_config.hpp

+               ".osrm.icd",
+               ".osrm.maneuver_overrides"},
+              {".osrm.hsgr", ".osrm.cells", ".osrm.cell_metrics", ".osrm.mldgr", ".osrm.partition"},
+              {})


osrm-backend/src/storage/storage.cpp

Lines 294 to 332 in 62e11fd

std::vector<std::pair<bool, boost::filesystem::path>> files = {

{IS_OPTIONAL, config.GetPath(".osrm.cells")},

{IS_OPTIONAL, config.GetPath(".osrm.partition")},

{IS_REQUIRED, config.GetPath(".osrm.icd")},

{IS_REQUIRED, config.GetPath(".osrm.properties")},

{IS_REQUIRED, config.GetPath(".osrm.nbg_nodes")},

{IS_REQUIRED, config.GetPath(".osrm.ebg_nodes")},

{IS_REQUIRED, config.GetPath(".osrm.tls")},

{IS_REQUIRED, config.GetPath(".osrm.tld")},

{IS_REQUIRED, config.GetPath(".osrm.timestamp")},

{IS_REQUIRED, config.GetPath(".osrm.maneuver_overrides")},

{IS_REQUIRED, config.GetPath(".osrm.edges")},

{IS_REQUIRED, config.GetPath(".osrm.names")},

{IS_REQUIRED, config.GetPath(".osrm.ramIndex")}};

for (const auto &file : files)

{

if (file.first == IS_REQUIRED && !boost::filesystem::exists(file.second))

{

throw util::exception("Could not find required file(s): " + std::get<1>(file).string());

}

}

return files;

}

std::vector<std::pair<bool, boost::filesystem::path>> Storage::GetUpdatableFiles()

{

constexpr bool IS_REQUIRED = true;

constexpr bool IS_OPTIONAL = false;

std::vector<std::pair<bool, boost::filesystem::path>> files = {

{IS_OPTIONAL, config.GetPath(".osrm.mldgr")},

{IS_OPTIONAL, config.GetPath(".osrm.cell_metrics")},

{IS_OPTIONAL, config.GetPath(".osrm.hsgr")},

{IS_REQUIRED, config.GetPath(".osrm.datasource_names")},

{IS_REQUIRED, config.GetPath(".osrm.geometry")},

{IS_REQUIRED, config.GetPath(".osrm.turn_weight_penalties")},

{IS_REQUIRED, config.GetPath(".osrm.turn_duration_penalties")}};

* Ensure required file check in osrm-routed is correctly enforced. The storage module had a stricter check. This keeps the IOConfig check in sync. * Correct HTTP docs to reflect summary output dependency on steps parameter. There is no summary parameter. * npm audit fix

mjjbell commented Jul 17, 2023

View reviewed changes

mjjbell added 2 commits July 17, 2023 23:06

Ensure required file check in osrm-routed is correctly enforced.

947afd9

The storage module had a stricter check. This keeps the IOConfig check in sync.

Correct HTTP docs to reflect summary output dependency on steps param…

07b2337

…eter. There is no summary parameter.

mjjbell force-pushed the mbell/minor_fixes branch from d8bf708 to 07b2337 Compare July 17, 2023 22:06

mjjbell commented Jul 17, 2023

View reviewed changes

npm audit fix

e783cb2

SiarheiFedartsou approved these changes Jul 17, 2023

View reviewed changes

mjjbell merged commit 3bb82ce into master Jul 18, 2023

mjjbell deleted the mbell/minor_fixes branch July 18, 2023 19:23

bevanjkay mentioned this pull request Apr 21, 2025

osrm-backend 6.0.0 Homebrew/homebrew-core#220847

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Minor fixes#6655

Minor fixes#6655
mjjbell merged 3 commits intomasterfrom
mbell/minor_fixes

mjjbell commented Jul 17, 2023

Uh oh!

mjjbell Jul 17, 2023

Uh oh!

mjjbell Jul 17, 2023

Uh oh!

mjjbell Jul 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	std::vector<std::pair<bool, boost::filesystem::path>> files = {
	{IS_OPTIONAL, config.GetPath(".osrm.cells")},
	{IS_OPTIONAL, config.GetPath(".osrm.partition")},
	{IS_REQUIRED, config.GetPath(".osrm.icd")},
	{IS_REQUIRED, config.GetPath(".osrm.properties")},
	{IS_REQUIRED, config.GetPath(".osrm.nbg_nodes")},
	{IS_REQUIRED, config.GetPath(".osrm.ebg_nodes")},
	{IS_REQUIRED, config.GetPath(".osrm.tls")},
	{IS_REQUIRED, config.GetPath(".osrm.tld")},
	{IS_REQUIRED, config.GetPath(".osrm.timestamp")},
	{IS_REQUIRED, config.GetPath(".osrm.maneuver_overrides")},
	{IS_REQUIRED, config.GetPath(".osrm.edges")},
	{IS_REQUIRED, config.GetPath(".osrm.names")},
	{IS_REQUIRED, config.GetPath(".osrm.ramIndex")}};

	for (const auto &file : files)
	{
	if (file.first == IS_REQUIRED && !boost::filesystem::exists(file.second))
	{
	throw util::exception("Could not find required file(s): " + std::get<1>(file).string());
	}
	}

	return files;
	}

	std::vector<std::pair<bool, boost::filesystem::path>> Storage::GetUpdatableFiles()
	{
	constexpr bool IS_REQUIRED = true;
	constexpr bool IS_OPTIONAL = false;

	std::vector<std::pair<bool, boost::filesystem::path>> files = {
	{IS_OPTIONAL, config.GetPath(".osrm.mldgr")},
	{IS_OPTIONAL, config.GetPath(".osrm.cell_metrics")},
	{IS_OPTIONAL, config.GetPath(".osrm.hsgr")},
	{IS_REQUIRED, config.GetPath(".osrm.datasource_names")},
	{IS_REQUIRED, config.GetPath(".osrm.geometry")},
	{IS_REQUIRED, config.GetPath(".osrm.turn_weight_penalties")},
	{IS_REQUIRED, config.GetPath(".osrm.turn_duration_penalties")}};

	if (parameters.steps)
	{
	leg.summary = guidance::assembleSummary(
	facade, path_data, phantoms.target_phantom, reversed_target);

Uh oh!

Conversation

mjjbell commented Jul 17, 2023

Issue

Tasklist

Uh oh!

mjjbell Jul 17, 2023

Choose a reason for hiding this comment

Uh oh!

mjjbell Jul 17, 2023

Choose a reason for hiding this comment

Uh oh!

mjjbell Jul 17, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants