Exception with GenerateInstructions

[TomQv]

var instructions = _route.GenerateInstructions();

results in:

System.Collections.Generic.KeyNotFoundException HResult=0x80131577 Message=Key not found in dictionary. Source=mscorlib StackTrace: at System.ThrowHelper.ThrowKeyNotFoundException()

for every route, Germany, Namibia, short, long, doesn't matter. Profile is just Car.Fastest.

[xivk]

I still can't reproduce this.

Do you have a full stack trace? What platform is this on, or is this an issue everywhere? I need more details, I already tried the following to reproduce:

• Make sure that the functional tests are actually running and they are. During each build and before publishing packages this is run: https://github.com/itinero/routing/blob/develop/test/Itinero.Test.Functional/Tests/InstructionTests.cs
• Make sure the unittests are running properly. Same here tests run properly: https://github.com/itinero/routing/blob/develop/test/Itinero.Test/Navigation/InstructionGeneratorTests.cs

• Make sure things work with one of the countries you tested. I test with Namibia, not issues there, this is an example route. I ran the functional tests for instructions on namibia as follows:

          var routerDb = new RouterDb();
          using (var stream = File.OpenRead(@"/home/xivk/work/data/OSM/namibia-latest.osm.pbf"))
          {
              routerDb.LoadOsmData(stream, Itinero.Osm.Vehicles.Vehicle.Car);
          }
  
          // test instruction generation.
          InstructionTests.Run(routerDb);

  An example route: http://geojson.io/#id=gist:xivk/be4ae33e065ba6b6df9c5f1095ddb8fb&map=9/-17.6466/24.4638 With these instructions:

[TomQv]

The problem with all these unittests and functional tests is, its not real life. I'm using other machines, maybe other windows-version, different localisation, maybe different dependencies etc.

In this case, I'm just using your github-package, not the source-code, so I don't have a stack trace, only my first posting.

But will try to figure out more.

[xivk]

Do you do translations, perhaps a string is not in the translation table... I haven't tested this yet but that could be it. I'll change this part of the code later to report on this properly when this happens/

https://github.com/itinero/routing/blob/develop/src/Itinero/Navigation/Instructions/DynamicUnimodalInstructionGenerator.cs#L175

That should give you a proper message, and the fall back could be the default English instead of failing.

[TomQv]

I also thought of this, but even with no or default ILanguageReference the error occurs. Attached is a ToGeoJson of the route, maybe this helps to reproduce the issue. route.zip

var json = _calculatedRoute.ToGeoJson();
var instructions = _calculatedRoute.GenerateInstructions(  );

[xivk]

Ah that's a good idea to reproduce, could you do ToJson() instead of ToGeoJson()? The geojson leaves out branches needed to generate instructions.

[TomQv]

Here it is: route2.zip

But how do you get the original route back from that json?

[xivk]

I found the issue, this is happening because the profile used to generate the route wasn't globally registered in Itinero. Itinero used to, by default, globally register routing profiles once a routerdb was loaded, that was bad because it made it hard work with multiple routerdb's so that was removed but I forgot to anticipate the instructions-case.

Quickfix

So calling this for each profile you use should fix things:

Itinero.Profiles.Profile.Register(yourProfile)

Updates to Itinero

I've updated the code to make it easier to explicitly define a profile when generating instructions or to provide the routerdb that was used to generate the route so it can get the profiles from there. That should be the way to go from now on, removing the need to globally register profiles, they will now either live on their own or in the routerdb. Obviously you can still register them globally but when moving to 2.0 that won't be possible anymore.

Changes done to support this:

• Added a way to deserialize json routes in tests.
• Fixed an issue with route attributes not being serialized in json.
• Added a number of regression tests for this case.
• Added a better exception message for when GenerateInstructions() is called but the profile isn't registered (Cannot generate instructions because the profile 'car' wasn't found. Use the RouterDb or explicitly provide the Profile.). It should be way easier now for users to know why it fails and how to fix it.
• Marked the overloads of GenerateInstructions() using the global profile registry as obsolete.
• Marked any methods to register profiles globally as obsolete too.
• A new set of overloads on the GenerateInstructions extension methods doing things the good way.
• Removed the global registry from the functional tests, all tests now run without any profiles registered globally.

What needs to change in your code

starting @ Itinero 1.4.0-pre61

When you still have the routedb around, you best call:

var instructions = route.GenerateInstructions(routerDb);

or

var instructions = route.GenerateInstructions(routerDb, languageRef);

When you don't have the routerdb, you can call:

var instructions = route.GenerateInstructions(profile);

or

var instructions = route.GenerateInstructions(profile, languageRef);

The profile has to match the profile the route was generated with. Generating instructions without the profile is impossible. I can't remove the old way of doing this because that would a breaking change.

[xivk]

Feel free to reopen if not fixed.

[TomQv]

Sorry for late response, was out of office for a couple of days. Thanks for the fix, its working now. I still have the routerdb so my preferred usage is var instructions = route.GenerateInstructions(routerDb, languageRef); This is leading now to the next issue, the instructions.