@wemap/osm 3.2.16 → 4.0.0

package/src/osrm/OsrmUtils.spec.js

@@ -5,16 +5,19 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 
 import {
-    Level, Coordinates
+    Level, Coordinates, Edge, GraphRouter
 } from '@wemap/geo';
-import { Edge } from '@wemap/graph';
+import { verifyCoherence } from '@wemap/geo/tests/CommonTest.js';
 
 import OsmParser from '../model/OsmParser.js';
-import OsmRouter from '../network/OsmRouter.js';
-import OsmNetwork from '../network/OsmNetwork.js';
-import OsrmUtils from './OsrmUtils.js';
-import OsmNode from '../model/OsmNode.js';
-import OsmWay from '../model/OsmWay.js';
+import OsmNetworkUtils from '../network/OsmNetworkUtils.js';
+import {
+    itineraryToOsrmJson,
+    jsonToCoordinates,
+    createItineraryFromJson,
+    getModifierFromAngle,
+    noRouteFoundJson
+} from './OsrmUtils.js';
 
 const { expect } = chai;
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -24,8 +27,8 @@ const load = fileName => {
     const filePath = path.resolve(__dirname, '../../assets/' + fileName);
     const osmXmlString = fs.readFileSync(filePath, 'utf8');
     const model = OsmParser.parseOsmXmlString(osmXmlString);
-    const network = OsmNetwork.fromOsmModel(model);
-    const router = new OsmRouter(network);
+    const network = OsmNetworkUtils.createNetworkFromOsmModel(model);
+    const router = new GraphRouter(network);
     return {
         network,
         router
@@ -48,7 +51,7 @@ describe('OsrmUtils - itineraryToOsrmJson', () => {
         const itinerary = router.getShortestPath(wemapIndoorStart, wemapIndoorEnd);
         wemapIndoorItinerary = itinerary;
 
-        const osrmJson = OsrmUtils.itineraryToOsrmJson(itinerary);
+        const osrmJson = itineraryToOsrmJson(itinerary);
         wemapIndoorJsonItinerary = osrmJson;
         const itinerarySteps = itinerary.steps;
 
@@ -64,7 +67,7 @@ describe('OsrmUtils - itineraryToOsrmJson', () => {
         for (let i = 1; i < 11; i++) {
             expect(
                 network.getNodeByName('p' + (i + 6)).coords.equalsTo(
-                    OsrmUtils.jsonToCoordinates(coordinates[i]))
+                    jsonToCoordinates(coordinates[i]))
             ).true;
         }
 
@@ -76,7 +79,7 @@ describe('OsrmUtils - itineraryToOsrmJson', () => {
             const {
                 location, type
             } = steps[i].maneuver;
-            expect(itinerarySteps[i].node.coords.equalsTo(OsrmUtils.jsonToCoordinates(location))).true;
+            expect(itinerarySteps[i].node.coords.equalsTo(jsonToCoordinates(location))).true;
 
             let expectedType;
             switch (i) {
@@ -141,7 +144,7 @@ describe('OsrmUtils - itineraryToOsrmJson', () => {
 
         const itinerary = router.getShortestPath(start, end);
 
-        wemapOutdoorJsonItinerary = OsrmUtils.itineraryToOsrmJson(itinerary);
+        wemapOutdoorJsonItinerary = itineraryToOsrmJson(itinerary);
 
         wemapOutdoorStart = start.coords;
         wemapOutdoorEnd = end.coords;
@@ -158,7 +161,7 @@ describe('OsrmUtils - itineraryToOsrmJson', () => {
         const end = network.getNodeByName('end');
 
         const itinerary = router.getShortestPath(start, end);
-        expect(() => OsrmUtils.itineraryToOsrmJson(itinerary)).not.throw(Error);
+        expect(() => itineraryToOsrmJson(itinerary)).not.throw(Error);
 
     });
 
@@ -178,7 +181,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
         const start = new Coordinates(43.6007871, 3.8757218000000004);
         const end = new Coordinates(43.598877, 3.873866);
 
-        const itinerary = OsrmUtils.createItineraryFromJson(json, start, end);
+        const itinerary = createItineraryFromJson(json, start, end);
 
         expect(json.routes[0].geometry.coordinates.length).equal(itinerary.nodes.length);
         expect(itinerary.nodes.length).equal(itinerary.edges.length + 1);
@@ -190,7 +193,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
         let step;
         step = steps[0];
         expect(Coordinates.equalsTo(step.location, new Coordinates(43.600777, 3.875607))).true;
-        expect(OsrmUtils.getModifierFromAngle(step.angle)).equals('left');
+        expect(getModifierFromAngle(step.angle)).equals('left');
         expect(step.nodes.length).equals(6);
         expect(step.edges.length).equals(5);
         expect(step.firstStep).true;
@@ -199,7 +202,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
 
         step = steps[1];
         expect(Coordinates.equalsTo(step.location, new Coordinates(43.599881, 3.876396))).true;
-        expect(OsrmUtils.getModifierFromAngle(step.angle)).equals('right');
+        expect(getModifierFromAngle(step.angle)).equals('right');
         expect(step.nodes.length).equals(12);
         expect(step.edges.length).equals(11);
         expect(step.firstStep).false;
@@ -208,7 +211,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
 
         step = steps[2];
         expect(Coordinates.equalsTo(step.location, new Coordinates(43.599577, 3.874655))).true;
-        expect(OsrmUtils.getModifierFromAngle(step.angle)).equals('left');
+        expect(getModifierFromAngle(step.angle)).equals('left');
         expect(step.nodes.length).equals(2);
         expect(step.edges.length).equals(1);
         expect(step.firstStep).false;
@@ -217,7 +220,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
 
         step = steps[3];
         expect(Coordinates.equalsTo(step.location, new Coordinates(43.599063, 3.874623))).true;
-        expect(OsrmUtils.getModifierFromAngle(step.angle)).equals('right');
+        expect(getModifierFromAngle(step.angle)).equals('right');
         expect(step.nodes.length).equals(2);
         expect(step.edges.length).equals(1);
         expect(step.firstStep).false;
@@ -226,7 +229,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
 
         step = steps[4];
         expect(Coordinates.equalsTo(step.location, new Coordinates(43.59906, 3.873865))).true;
-        expect(OsrmUtils.getModifierFromAngle(step.angle)).equals('left');
+        expect(getModifierFromAngle(step.angle)).equals('left');
         expect(step.nodes.length).equals(1);
         expect(step.edges.length).equals(0);
         expect(step.firstStep).false;
@@ -248,7 +251,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
 
     it('Without levels (from itineraryToOsrmJson)', () => {
 
-        const itinerary = OsrmUtils.createItineraryFromJson(wemapOutdoorJsonItinerary,
+        const itinerary = createItineraryFromJson(wemapOutdoorJsonItinerary,
             wemapOutdoorStart, wemapOutdoorEnd);
 
         expect(itinerary.nodes.length).equal(wemapOutdoorItinerary.nodes.length);
@@ -282,7 +285,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
         const start = new Coordinates(43.6007871, 3.8757218000000004);
         const end = new Coordinates(43.598877, 3.873866);
 
-        const itinerary = OsrmUtils.createItineraryFromJson(json, start, end);
+        const itinerary = createItineraryFromJson(json, start, end);
 
         expect(json.routes[0].geometry.coordinates.length).equal(itinerary.nodes.length);
         expect(itinerary.nodes.length).equal(itinerary.edges.length + 1);
@@ -295,7 +298,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
 
     it('With levels (from itineraryToOsrmJson)', () => {
 
-        const itinerary = OsrmUtils.createItineraryFromJson(wemapIndoorJsonItinerary,
+        const itinerary = createItineraryFromJson(wemapIndoorJsonItinerary,
             wemapIndoorStart, wemapIndoorEnd);
 
         expect(itinerary.nodes.length).equal(wemapIndoorItinerary.nodes.length);
@@ -329,7 +332,7 @@ describe('OsrmUtils - createItineraryFromJson', () => {
         const start = new Coordinates(44.810569099999995, 4.9503924999999995);
         const end = new Coordinates(44.302673, 4.556377);
 
-        const itinerary = OsrmUtils.createItineraryFromJson(json, start, end);
+        const itinerary = createItineraryFromJson(json, start, end);
         itinerary.edges.forEach(edge => {
             expect(edge).instanceOf(Edge);
         });
@@ -352,22 +355,34 @@ describe('OsrmUtils - itineraryToOsrmJson - createItineraryFromJson - way/node',
         const end = new Coordinates(43.60949854, 3.88452048, null, new Level(0));
         const itinerary = router.getShortestPath(start, end);
 
-        const osrmJson = OsrmUtils.itineraryToOsrmJson(itinerary);
+        const osrmJson = itineraryToOsrmJson(itinerary);
         const jsonSteps = osrmJson.routes[0].legs[0].steps;
 
-        expect(jsonSteps[0].wemap.nextEdgeData.type).equals('way');
-        expect(jsonSteps[4].wemap.nextEdgeData.type).equals('node');
+        expect(jsonSteps[0].wemap.nextEdgeProperties.name).equals('w2');
+        expect(jsonSteps[0].wemap.nextEdgeProperties.level).equals('2');
+        expect(jsonSteps[0].wemap.nodeProperties.name).equals('w2');
+
+        expect(jsonSteps[4].wemap.nextEdgeProperties.name).equals('p19');
+        expect(jsonSteps[4].wemap.nextEdgeProperties.level).equals('0;2');
+        expect(jsonSteps[4].wemap.nodeProperties.name).equals('p19');
+
+        expect(jsonSteps[6].name).equals('p21');
+        expect(jsonSteps[6].wemap.nextEdgeProperties).is.undefined;
+        expect(jsonSteps[6].wemap.nodeProperties.name).equals('p21');
+
+        const itineraryBis = createItineraryFromJson(osrmJson, start, end);
+        verifyCoherence(itineraryBis);
 
-        const itineraryBis = OsrmUtils.createItineraryFromJson(osrmJson, start, end);
-        expect(itineraryBis.steps[4].edges[0].data).instanceOf(OsmNode);
-        expect(itineraryBis.steps[0].edges[0].data).instanceOf(OsmWay);
+        expect(itineraryBis.nodes.length).equals(itinerary.nodes.length);
+        expect(itineraryBis.edges.length).equals(itinerary.edges.length);
+        expect(itineraryBis.steps.length).equals(itinerary.steps.length);
     });
 });
 
 describe('OsrmUtils - Output JSON', () => {
 
     it('noRouteFoundJson', () => {
-        expect(OsrmUtils.noRouteFoundJson('foo')).deep.equals({
+        expect(noRouteFoundJson('foo')).deep.equals({
             'code': 'NoRoute',
             'message': 'foo'
         });

package/src/network/OsmNetwork.js

@@ -1,156 +0,0 @@
-import { Level } from '@wemap/geo';
-import {
-    Edge, Node, Network
-} from '@wemap/graph';
-
-import OsmModel from '../model/OsmModel.js';
-
-const HIGHWAYS_PEDESTRIANS = ['footway', 'steps', 'pedestrian', 'living_street', 'path', 'track', 'sidewalk'];
-const DEFAULT_WAY_SELECTOR = way => HIGHWAYS_PEDESTRIANS.includes(way.tags.highway) || way.tags.footway === 'sidewalk';
-
-/**
- * A typical network with nodes (Node) and edges (Edge)
- */
-class OsmNetwork extends Network {
-
-    /**
-     * @param {OsmModel} osmModel
-     * @param {function} _waySelectionFilter
-     * @returns {OsmNetwork}
-     */
-    static fromOsmModel(osmModel, _waySelectionFilter) {
-
-        const waySelectionFilter = _waySelectionFilter || DEFAULT_WAY_SELECTOR;
-
-        const networkModel = new OsmNetwork();
-
-        const getOrCreateNode = osmNode => {
-            let node = networkModel.nodes.find(graphNode => osmNode.id === graphNode.data.id);
-            if (!node) {
-                node = new Node(osmNode.coords, osmNode);
-                networkModel.nodes.push(node);
-            }
-            return node;
-        };
-
-        osmModel.ways.forEach(way => {
-            if (!waySelectionFilter(way)) {
-                return;
-            }
-
-            let firstNode = getOrCreateNode(way.nodes[0]);
-            for (let i = 1; i < way.nodes.length; i++) {
-                const secondNode = getOrCreateNode(way.nodes[i]);
-
-                const edge = new Edge(firstNode, secondNode);
-                edge.data = way;
-                edge.level = way.level;
-                networkModel.edges.push(edge);
-
-                firstNode = secondNode;
-            }
-
-        });
-
-        networkModel.nodes.forEach(node => {
-            if (node.data.tags.highway === 'elevator') {
-                // We have to clone this node for each connected edge
-                OsmNetwork._createNodesAndEdgesFromElevator(networkModel, node);
-            }
-        });
-
-        Node.generateNodesLevels(networkModel.nodes);
-
-        return networkModel;
-    }
-
-    static _createNodesAndEdgesFromElevator(networkModel, node) {
-
-        const createdNodes = [];
-        const isLevelAlreadyCreated = level => createdNodes.some(
-            createdNode => Level.equalsTo(level, createdNode.coords.level)
-        );
-
-        // Create nodes from node.edges
-        node.edges.forEach(edge => {
-            if (edge.level.isRange) {
-                throw new Error('Cannot handle this elevator edge due to ambiguity');
-            }
-
-            if (isLevelAlreadyCreated(edge.level)) {
-                return;
-            }
-
-            const newNode = node.clone();
-            newNode.coords = node.coords.clone();
-            newNode.coords.level = edge.level.clone();
-
-            const otherNode = edge.node1 === node ? edge.node2 : edge.node1;
-            otherNode.edges = otherNode.edges.filter(_edge => _edge !== edge);
-            const modifiedEdge = new Edge(newNode, otherNode, edge.data, edge.level);
-            networkModel.edges.push(modifiedEdge);
-
-            createdNodes.push(newNode);
-            networkModel.nodes.push(newNode);
-        });
-
-        // Create edges from createdNodes
-        for (let i = 0; i < createdNodes.length; i++) {
-            for (let j = i + 1; j < createdNodes.length; j++) {
-
-                const createdNode1 = createdNodes[i];
-                const createdNode2 = createdNodes[j];
-
-                const newEdge = new Edge(
-                    createdNode1,
-                    createdNode2,
-                    createdNode1.data,
-                    new Level(createdNode1.coords.level.val, createdNode2.coords.level.val)
-                );
-                networkModel.edges.push(newEdge);
-            }
-        }
-
-        networkModel.nodes = networkModel.nodes.filter(_node => _node !== node);
-        networkModel.edges = networkModel.edges.filter(edge =>
-            !node.edges.some(_edge => _edge === edge)
-        );
-    }
-
-    /**
-     * @param {number} id
-     * @returns {Node}
-     */
-    getNodeById(id) {
-        return this.nodes.find(node => node.data.id === id);
-    }
-
-    /**
-     * @param {name} name
-     * @returns {Node}
-     */
-    getNodeByName(name) {
-        return this.nodes.find(node => node.data.tags.name === name);
-    }
-
-    /**
-     * @param {number} id
-     * @returns {Edge[]}
-     */
-    getEdgesById(id) {
-        return this.edges.filter(edge => edge.data.id === id);
-    }
-
-    /**
-     * @returns {string}
-     */
-    toDetailedString() {
-        return super.toDetailedString(
-            node => node.data.tags.name,
-            edge => edge.data.id
-        );
-    }
-
-}
-
-export default OsmNetwork;

package/src/network/OsmNetwork.spec.js

@@ -1,107 +0,0 @@
-/* eslint-disable max-statements */
-import chai from 'chai';
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-import OsmParser from '../model/OsmParser.js';
-import OsmNetwork from './OsmNetwork.js';
-
-const { expect } = chai;
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-
-const loadFile = fileName => {
-    const filePath = path.resolve(__dirname, '../../assets/' + fileName);
-    return fs.readFileSync(filePath, 'utf8');
-};
-
-describe('OsmNetwork - simple', () => {
-
-    let osmModel, osmNetwork;
-    const osmXmlString = loadFile('network-simple.osm');
-
-    it('Network creation', () => {
-
-        osmModel = OsmParser.parseOsmXmlString(osmXmlString);
-        osmNetwork = OsmNetwork.fromOsmModel(osmModel);
-
-        expect(osmNetwork.nodes.length).equals(3);
-        expect(osmNetwork.edges.length).equals(2);
-    });
-
-
-    it('Network creation - waySelectionFilter', () => {
-
-        const selectionNetwork = OsmNetwork.fromOsmModel(osmModel, () => true);
-
-        expect(selectionNetwork.nodes.length).equals(4);
-        expect(selectionNetwork.edges.length).equals(3);
-    });
-
-    it('Network creation - elevator', () => {
-
-        const elevatorModel = OsmParser.parseOsmXmlString(loadFile('network-elevator.osm'));
-        const elevatorNetwork = OsmNetwork.fromOsmModel(elevatorModel);
-
-        expect(elevatorNetwork.nodes.length).equals(7);
-        expect(elevatorNetwork.edges.length).equals(6);
-
-
-        const osmModel2 = OsmParser.parseOsmXmlString(`
-        <osm>
-            <node id='1' lat='43' lon='4'>
-                <tag k='highway' v='elevator' />
-                <tag k='level' v='0;1' />
-            </node>
-            <node id='2' lat='43' lon='3' />
-            <way id='3'>
-                <nd ref='1' />
-                <nd ref='2' />
-                <tag k='highway' v='footway' />
-                <tag k='level' v='0;1' />
-            </way>
-        </osm>
-        `);
-        expect(() => OsmNetwork.fromOsmModel(osmModel2)).throw(Error);
-    });
-
-
-    it('getNodeById', () => {
-        let node = osmNetwork.getNodeById(1);
-        expect(node).not.null;
-        expect(node.data.tags.name).equals('p1');
-
-        node = osmNetwork.getNodeById(5);
-        expect(node).undefined;
-    });
-
-
-    it('getNodeByName', () => {
-        let node = osmNetwork.getNodeByName('p1');
-        expect(node).not.undefined;
-
-        node = osmNetwork.getNodeByName('p5');
-        expect(node).undefined;
-    });
-
-    it('getEdgesById', () => {
-        let edges = osmNetwork.getEdgesById(101);
-        expect(edges.length).equals(2);
-        expect(edges[0].data.tags.name).equals('w1');
-        expect(edges[0].node1.data.tags.name).equals('p1');
-        expect(edges[0].node2.data.tags.name).equals('p2');
-        expect(edges[1].data.tags.name).equals('w1');
-        expect(edges[1].node1.data.tags.name).equals('p2');
-        expect(edges[1].node2.data.tags.name).equals('p3');
-
-        edges = osmNetwork.getEdgesById(3);
-        expect(edges.length).equals(0);
-    });
-
-    it('toDetailedString', () => {
-        expect(() => osmNetwork.toDetailedString()).not.throw(Error);
-    });
-});
-
-

package/src/network/OsmRouter.js

@@ -1,75 +0,0 @@
-import { Coordinates } from '@wemap/geo';
-import {
-    Edge, GraphRouter, Node, Utils
-} from '@wemap/graph';
-
-const DEFAULT_OPTIONS = { useStairs: true };
-
-class OsmRouter extends GraphRouter {
-
-    /**
-     * @param {Node|Coordinates} start
-     * @param {Node|Coordinates} end
-     * @param {object} _options
-     */
-    getShortestPath(start, end, _options) {
-
-        const options = Object.assign({}, DEFAULT_OPTIONS, _options);
-
-        return super.getShortestPath(
-            start, end,
-            options.useStairs ? null : OsmRouter.edgeSelectionFilter,
-            OsmRouter.edgeWeightFn,
-            OsmRouter.acceptOneWayFn
-        );
-    }
-
-    /**
-     * @param {Edge} edge
-     * @returns {boolean}
-     */
-    static edgeSelectionFilter = edge => {
-        return !edge.data || !edge.data.tags
-            || (
-                edge.data.tags.stairs !== 'yes'
-                && edge.data.tags.highway !== 'steps'
-            );
-    }
-
-    /**
-     * @param {Edge} edge
-     * @returns {boolean}
-     */
-    static edgeWeightFn = edge => {
-        if (edge.data.tags.highway === 'elevator') {
-            return 30;
-        }
-        return Utils.getDurationFromLength(edge.length);
-    };
-
-    /**
-     * @param {Edge} edge
-     * @param {boolean} reversed
-     * @returns {boolean}
-     */
-    static acceptOneWayFn = (edge, reversed) => {
-        const {
-            oneway, highway, conveying
-        } = edge.data.tags;
-        if (reversed && (oneway === 'yes' || oneway === 'true' || oneway === '1')) {
-            return false;
-        }
-        if (conveying && highway) {
-            if (conveying === 'forward' && reversed) {
-                return false;
-            } if (conveying === 'backward' && !reversed) {
-                return false;
-            } if (conveying === 'yes' && reversed) {
-                return false;
-            }
-        }
-        return true;
-    };
-}
-
-export default OsmRouter;