Manage avoid parameter

[AlainFolletete]

Hi,

Like this topic : https://discuss.graphhopper.com/t/new-routing-api-feature-path-details-and-support-for-avoiding-motorway-ferry-toll/2539

We can add "avoid" parameter to request, this allows to avoid motorway, toll, ferry, ...

Regards,

[boldtrn]

Thank you very much for this PR @AlainFolletete.

Would you mind to add a test case for this feature in the GraphHopperRoutingSpec.js? The avoid feature should be used similar to for example the point_hint parameter, because it is allowed to specify avoid=toll&avoid=motorway. Therefore in js we should specify the avoid parameter as an array. (this is wrong)

[AlainFolletete]

Hi @boldtrn ,

Thank you for your reply. I just push two new commits.

First one is for using "avoid" parameter as array. I create only one "avoid" parameter in url, like is in documentation (https://graphhopper.com/api/1/docs/routing/#flexible).

semicolon separated parameter

The second commit, add a test case in order to test "avoid" parameter is working. I cannot make test working with my API key... I don't know is it working correctly 😢 .

Regards

[boldtrn]

You are right sorry, I just double checked. The avoid parameter is semicolon separated and not exactly like point_hint. I should have looked this up. In this case your initial implementation would have worked as well.

I think I would still prefer the array solution. WDYT @karussell should the avoid parameter be a simple string or an array for the js client?

The second commit, add a test case in order to test "avoid" parameter is working. I cannot make test working with my API key... I don't know is it working correctly

I just created another PR to fix the API key issue #37.

[karussell]

Yes, this inconsistency is a bit ugly. Related to https://github.com/graphhopper/graphhopper/issues/1241

But having the avoid parameter as array is also a bit ugly as we need to skip it explicitly when reading the URL (somewhere)

[boldtrn]

But having the avoid parameter as array is also a bit ugly as we need to skip it explicitly when reading the URL (somewhere)

Yes but this is an issue of the GraphHopper maps demo and not really an issue of the client. Having it as an array also allows to put the parameter as a single string like avoid = ["motorway;toll"] or avoid = ["motorway", "toll"], so we would not need to use it as an array for the GHMaps demo.

[karussell]

Yes but this is an issue of the GraphHopper maps demo and not really an issue of the client

yes, right

Having it as an array also allows to put the parameter as a single string

Sounds interesting, what do you mean exactly?

(btw: we allow avoid=motorway;toll or if this is wrong we should allow this like with the details...)

[boldtrn]

Sounds interesting, what do you mean exactly?

In order to avoid motorway and toll, you can either call:

ghRouting.doRequest({ch: {disable: true}, avoid: [ 'motorway', 'toll' ]})

or:

ghRouting.doRequest({ch: {disable: true}, avoid: [ 'motorway;toll' ]})

(btw: we allow avoid=motorway;toll or if this is wrong we should allow this like with the details...)

Wouldn't say it's wrong, it's just different to most of the other parameters, related to the issue you posted above.

[karussell]

avoid: [ 'motorway;toll' ]

This looks wrong. Let's use a real array of strings.

[boldtrn]

This looks wrong. Let's use a real array of strings.

Ok, that's no problem. Will merge this PR now and release new version on npm.

[boldtrn]

Thanks again @AlainFolletete for providing this PR.