Skip to content

make Nominatim host and protocol configurable via search service options #12316

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
jwkaltz wants to merge 3 commits into
base: master
Choose a base branch
from
+178 −10
Open

make Nominatim host and protocol configurable via search service options #12316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f334a9
Restructure nominatim URL construction in order to make hostname and …
Apr 27, 2026
1f4027b
Restructure nominatim URL construction in order to make hostname and …
Apr 27, 2026
bcddcdf
restore copyright notice
Apr 27, 2026
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
21 changes: 11 additions & 10 deletions web/client/api/Nominatim.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
/**
* Copyright 2015, GeoSolutions Sas.
* Copyright 2015-2026, GeoSolutions Sas.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/
import axios from '../libs/ajax';

import urlUtil from 'url';
const DEFAULT_URL = 'nominatim.openstreetmap.org';
const DEFAULT_REVERSE_URL = 'nominatim.openstreetmap.org/reverse';
const DEFAULT_PROTOCOL = 'https';
const defaultOptions = {
format: 'json',
bounded: 0,
Expand All @@ -21,23 +21,24 @@ const defaultOptions = {
*/
const Api = {
geocode: function(text, options) {
var params = Object.assign({q: text}, defaultOptions, options || {});
const {host, protocol, ...queryOptions} = options || {};
var params = Object.assign({q: text}, defaultOptions, queryOptions);
var url = urlUtil.format({
protocol: "https",
host: DEFAULT_URL,
protocol: protocol || DEFAULT_PROTOCOL,
host: host || DEFAULT_URL,
query: params
});
return axios.get(url); // TODO the jsonp method returns .promise and .cancel method,the last can be called when user cancel the query
return axios.get(url);
},
reverseGeocode: function(coords, options) {
const params = Object.assign({lat: coords.lat, lon: coords.lng}, options || {}, defaultOptions);
const {host, protocol, ...queryOptions} = options || {};
const params = Object.assign({lat: coords.lat, lon: coords.lng}, queryOptions, defaultOptions);
const url = urlUtil.format({
protocol: "https",
host: DEFAULT_REVERSE_URL,
protocol: protocol || DEFAULT_PROTOCOL,
host: host ? host + '/reverse' : DEFAULT_REVERSE_URL,
query: params
});
return axios.get(url);
}
};

export default Api;
167 changes: 167 additions & 0 deletions web/client/api/__tests__/Nominatim-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
/*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree.
*/
import Nominatim from '../Nominatim';
import expect from 'expect';
import axios from '../../libs/ajax';
import MockAdapter from 'axios-mock-adapter';

let mockAxios;

describe('Test Nominatim API', () => {
beforeEach(done => {
mockAxios = new MockAdapter(axios);
setTimeout(done);
});
afterEach(done => {
mockAxios.restore();
setTimeout(done);
});

describe('geocode', () => {
it('should use default host and protocol when no options provided', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('nominatim.openstreetmap.org');
expect(config.url).toContain('https');
} catch (e) {
done(e);
}
return [200, []];
});
Nominatim.geocode('Bern').then(() => done()).catch(done);
});

it('should use custom host from options', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('my-nominatim.example.com');
expect(config.url).toNotContain('nominatim.openstreetmap.org');
} catch (e) {
done(e);
}
return [200, []];
});
Nominatim.geocode('Bern', {host: 'my-nominatim.example.com'}).then(() => done()).catch(done);
});

it('should use custom protocol from options', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('http://');
expect(config.url).toNotContain('https://');
} catch (e) {
done(e);
}
return [200, []];
});
Nominatim.geocode('Bern', {protocol: 'http'}).then(() => done()).catch(done);
});

it('should use custom host and protocol from options', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('http://');
expect(config.url).toContain('my-nominatim.example.com');
} catch (e) {
done(e);
}
return [200, []];
});
Nominatim.geocode('Bern', {
host: 'my-nominatim.example.com',
protocol: 'http'
}).then(() => done()).catch(done);
});

it('should not pass host and protocol as query parameters', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toNotContain('host=');
expect(config.url).toNotContain('protocol=');
} catch (e) {
done(e);
}
return [200, []];
});
Nominatim.geocode('Bern', {
host: 'my-nominatim.example.com',
protocol: 'http'
}).then(() => done()).catch(done);
});

it('should pass other options as query parameters', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('limit=2');
expect(config.url).toContain('polygon_geojson=1');
} catch (e) {
done(e);
}
return [200, []];
});
Nominatim.geocode('Bern', {limit: 2, polygon_geojson: 1}).then(() => done()).catch(done);
});
});

describe('reverseGeocode', () => {
it('should use default host and protocol when no options provided', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('nominatim.openstreetmap.org/reverse');
expect(config.url).toContain('https');
} catch (e) {
done(e);
}
return [200, {}];
});
Nominatim.reverseGeocode({lat: 46.7, lng: 7.6}).then(() => done()).catch(done);
});

it('should use custom host for reverse geocode', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('my-nominatim.example.com/reverse');
expect(config.url).toNotContain('nominatim.openstreetmap.org');
} catch (e) {
done(e);
}
return [200, {}];
});
Nominatim.reverseGeocode({lat: 46.7, lng: 7.6}, {
host: 'my-nominatim.example.com'
}).then(() => done()).catch(done);
});

it('should use custom protocol for reverse geocode', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toContain('http://');
} catch (e) {
done(e);
}
return [200, {}];
});
Nominatim.reverseGeocode({lat: 46.7, lng: 7.6}, {
protocol: 'http'
}).then(() => done()).catch(done);
});

it('should not pass host and protocol as query parameters in reverse geocode', (done) => {
mockAxios.onGet().reply(config => {
try {
expect(config.url).toNotContain('host=');
expect(config.url).toNotContain('protocol=');
} catch (e) {
done(e);
}
return [200, {}];
});
Nominatim.reverseGeocode({lat: 46.7, lng: 7.6}, {
host: 'my-nominatim.example.com',
protocol: 'http'
}).then(() => done()).catch(done);
});
});
});