Use PGRouting to handle routing directly in Database through API

.github/workflows/test.yml

@@ -57,7 +57,7 @@ jobs:
 
     services:
       postgres:
-        image: postgis/postgis:12-2.5
+        image: pgrouting/pgrouting:12-3.0-2.6.3
         env:
           POSTGRES_DB: ci_test
           POSTGRES_PASSWORD: ci_test
@@ -253,7 +253,7 @@ jobs:
 
     services:
       postgres:
-        image: postgis/postgis:12-2.5
+        image: pgrouting/pgrouting:12-3.0-2.6.3
         env:
           POSTGRES_DB: ci_test
           POSTGRES_PASSWORD: ci_test
@@ -337,7 +337,7 @@ jobs:
 
     services:
       postgres:
-        image: postgis/postgis:12-2.5
+        image: pgrouting/pgrouting:12-3.0-2.6.3
         env:
           POSTGRES_DB: ci_test
           POSTGRES_PASSWORD: ci_test

.gitignore

@@ -13,6 +13,13 @@ __pycache__/
 geotrek/settings/custom.py
 geotrek/cypress/node_modules
 Makefile.perso.mk
+
+# Benchmarking
+tools/benchmarking/time_measures/
+tools/benchmarking/cypress/videos/
+tools/benchmarking/cypress/screenshots/
+tools/benchmarking/node_modules/
+
 # buildout stuff
 .mr.developer.cfg
 .installed.cfg

cypress/integration/nav_create_trek.js

@@ -25,14 +25,7 @@ describe('Create trek', () => {
         cy.visit('/trek/list');
         cy.wait('@tiles');
         cy.server();
-        cy.route('/api/path/drf/paths/graph.json').as('graph');
         cy.get("a.btn-success[href='/trek/add/']").contains('Add a new trek').click();
-        cy.wait('@graph');
-        cy.get("a.linetopology-control").click();
-        cy.get("textarea[id='id_topology']").type('[{"pk": 2, "kind": "TREK", "offset": 0.0, "paths": [3], "positions": {"0": [0.674882030756843, 0.110030805790642]}}]', {
-            force: true,
-            parseSpecialCharSequences: false
-        });
         cy.get("input[id='id_duration']").type('100');
         cy.get("input[name='name_en']").type('Trek number 1');
         cy.get("a[href='#name_fr']").click();
@@ -52,6 +45,10 @@ describe('Create trek', () => {
         cy.setTinyMceContent('id_description_teaser_en', 'Description teaser number 1');
         cy.setTinyMceContent('id_ambiance_en', 'Ambiance number 1');
         cy.setTinyMceContent('id_description_en', 'Description number 1');
+        cy.get("a.linetopology-control").click();
+        cy.clickOnPath(3, 67);
+        cy.clickOnPath(3, 11);
+        cy.get('[data-test^="route-step-"]');
         cy.get('#save_changes').click();
         cy.url().should('not.include', '/trek/add/');
         cy.get('.content').should('contain', 'Trek number 1');

cypress/support/commands.js

@@ -21,4 +21,55 @@ Cypress.Commands.add('loginByCSRF', (username, password) => {
 
 Cypress.Commands.add('mockTiles', (username, password) => {
     cy.intercept("https://*.tile.opentopomap.org/*/*/*.png", {fixture: "images/tile.png"}).as("tiles");
+});
+
+Cypress.Commands.add('getCoordsOnMap', (pathPk, percentage) => {
+  cy.getPath(pathPk).then(path => {
+    let domPath = path.get(0);
+
+    // Get the coordinates relative to the map element
+    let pathLength = domPath.getTotalLength();
+    let lengthAtPercentage = percentage * pathLength / 100;
+    return domPath.getPointAtLength(lengthAtPercentage);
+  })
+});
+
+Cypress.Commands.add('getCoordsOnPath', (pathPk, percentage) => {
+  cy.getPath(pathPk).then(path => {
+    cy.getCoordsOnMap(pathPk, percentage).then(coordsOnMap => {
+      // Convert the coords so they are relative to the path
+      cy.getMap().then(map => {
+        let domMap = map.get(0);
+        let domPath = path.get(0);
+
+        // Get the coords of the map and the path relative to the root DOM element
+        let mapCoords = domMap.getBoundingClientRect();
+        let pathCoords = domPath.getBoundingClientRect();
+        let horizontalDelta = pathCoords.x - mapCoords.x;
+        let verticalDelta = pathCoords.y - mapCoords.y;
+
+        // Return the coords relative to the path element
+        return {
+          x: coordsOnMap.x - horizontalDelta,
+          y: coordsOnMap.y - verticalDelta,
+        }
+      });
+    })
+
+  })
+})
+
+Cypress.Commands.add('getMap', () => cy.get('[id="id_topology-map"]'));
+Cypress.Commands.add('getPath', pathPk => cy.get(`[data-test=pathLayer-${pathPk}]`));
+
+Cypress.Commands.add('clickOnPath', (pathPk, percentage) => {
+  // Get the coordinates of the click and execute it
+  cy.getCoordsOnPath(pathPk, percentage).then(clickCoords => {
+    let startTime;
+    cy.getPath(pathPk)
+    .then((path) => {startTime = performance.now(); return path})
+    .click(clickCoords.x, clickCoords.y, {force: true})
+    // Return startTime so it is yielded by the command
+    .then(() => startTime);
+  });
 });

debian/postinst

@@ -65,6 +65,7 @@ if [ "$MANAGE_DB" = "true" ] && [ -z "$2" ]; then
 	# postgis_raster is only useful on postgis 3, it fails on postgis 2 but this is harmless
 	su postgres -c "psql -q -d $POSTGRES_DB -c 'CREATE EXTENSION postgis_raster;'" || true
 	su postgres -c "psql -q -d $POSTGRES_DB -c 'CREATE EXTENSION pgcrypto;'" || true
+	su postgres -c "psql -q -d $POSTGRES_DB -c 'CREATE EXTENSION pgrouting;'" || true
 fi
 
 # Generate secret key

docker-compose.yml

@@ -15,7 +15,7 @@ x-images:
 
 services:
   postgres:
-    image: postgis/postgis:12-2.5
+    image: pgrouting/pgrouting:12-3.0-2.6.3
     env_file:
       - .env
     ports:

docs/install/import.rst

@@ -53,6 +53,16 @@ To import a shapefile containing your paths, use the command ``loadpaths``::
         --srid=2154 --comments-attribute IT_VTT IT_EQ IT_PEDEST \
         --encoding latin9 -i
 
+After importing a large quantity of paths, it is recommended to pre-generate the
+paths graph needed for the routing. This action is not mandatory, but will reduce the time needed for the first
+routing following the import.
+
+To pre-generate the graph, use the ``generate_pgr_network_topology`` command::
+
+    sudo geotrek generate_pgr_network_topology
+    OR
+    docker compose run --rm web ./manage.py generate_pgr_network_topology
+
 .. _import-data-from-touristic-data-systems-sit:
 
 Import data from touristic data systems (SIT)
@@ -144,7 +154,7 @@ Don't forget the u character before strings if they contain non-ascii characters
 
 In this case categories and types in Geotrek database have to be the same as in Esprit parc database. Otherwise missing categories and types will be created in Geotrek database.
 
-Imported contents will be automatically published and approved. 
+Imported contents will be automatically published and approved.
 
 If you use an url that filters a unique category, you can change its name. Example to get only Honey products and set the Geotrek category and type in which import them:
 
@@ -173,7 +183,7 @@ When sensitive areas module is enabled, Geotrek provides 3 parsers to import dat
 
 * **Import sensitive areas from http://biodiv-sports.fr** (``geotrek.sensitivity.parsers.BiodivParser``). By default this
   parser imports all sensitive areas in configured spatial extent.
-* **Import species sensitive areas from a zipped shapefile**. 
+* **Import species sensitive areas from a zipped shapefile**.
   Imported field names are: ``espece`` (required), ``contact`` and ``descriptio``. Species with corresponding names have to be created manually before import.
 * **Import regulatory sensitive areas from a zipped shapefile**. Imported field names are: ``nom`` (required), ``contact``, ``descriptio``, ``periode`` (month numbers separated with comas), ``pratiques`` (separated with comas), and ``url``. Practices with corresponding names have to be created manually before import.
 
@@ -228,7 +238,7 @@ In the following example, ``Provider_1Parser`` and ``Provider_2Parser`` will eac
 
 
 .. danger::
-    It is recommended to use ``provider`` from the first import - Do not add a ``provider`` field to preexisting parsers that already imported objects, or you will have to manually set the same value for ``provider`` on all objects already created by this parser. 
+    It is recommended to use ``provider`` from the first import - Do not add a ``provider`` field to preexisting parsers that already imported objects, or you will have to manually set the same value for ``provider`` on all objects already created by this parser.
 
 
 .. danger::
@@ -450,7 +460,7 @@ You can also use some of Geotrek commands to import data from a vector file hand
 
 Possible data are e.g.: POI, infrastructures, signages, cities, districts, restricted areas, dives, paths.
 
-You must use these commands to import spatial data because of the dynamic segmentation, which will not be computed if you enter the data manually. 
+You must use these commands to import spatial data because of the dynamic segmentation, which will not be computed if you enter the data manually.
 
 Here are the Geotrek commands available to import data from file:
 
@@ -470,7 +480,7 @@ To get help about a command:
 ::
 
     sudo geotrek help <subcommand>
-    
+
 .. _import-dem-altimetry:
 
 
@@ -955,10 +965,10 @@ Merge segmented paths
 A path network is most optimized when there is only one path between intersections.
 If the path database includes many fragmented paths, they could be merged to improve performances.
 
-You can run ``sudo geotrek merge_segmented_paths``. 
+You can run ``sudo geotrek merge_segmented_paths``.
 
 .. danger::
-    This command can take several hours to run. During the process, every topology on a path will be set on the path it is merged with, but it would still be more efficient (and safer) to run it before creating topologies. 
+    This command can take several hours to run. During the process, every topology on a path will be set on the path it is merged with, but it would still be more efficient (and safer) to run it before creating topologies.
 
 Before :
 ::

geotrek/common/templates/common/sql/pre_20_extensions.sql

@@ -1,3 +1,6 @@
 -- Used to ensure extension is enabled even in test database (migrations disabled)
 -- Otherwise UUIDs on objects can not be generated on insert (including path splits)
-CREATE EXTENSION IF NOT EXISTS "pgcrypto";
+CREATE EXTENSION IF NOT EXISTS "pgcrypto";
+CREATE EXTENSION IF NOT EXISTS "postgis";
+CREATE EXTENSION IF NOT EXISTS "postgis_raster";
+CREATE EXTENSION IF NOT EXISTS "pgrouting" CASCADE;

geotrek/core/locale/de/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-04-03 15:39+0000\n"
+"POT-Creation-Date: 2024-05-28 14:23+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -311,6 +311,15 @@ msgstr ""
 msgid "Cancel"
 msgstr ""
 
+msgid "Warning"
+msgstr ""
+
+msgid "The marker was not dropped on a path."
+msgstr ""
+
+msgid "No routing found for this marker. Please move or delete it."
+msgstr ""
+
 msgid "No certification"
 msgstr ""
 

geotrek/core/locale/en/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-04-03 15:39+0000\n"
+"POT-Creation-Date: 2024-05-28 14:23+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -311,6 +311,15 @@ msgstr ""
 msgid "Cancel"
 msgstr ""
 
+msgid "Warning"
+msgstr ""
+
+msgid "The marker was not dropped on a path."
+msgstr ""
+
+msgid "No routing found for this marker. Please move or delete it."
+msgstr ""
+
 msgid "No certification"
 msgstr ""
 

geotrek/core/locale/es/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-04-03 15:39+0000\n"
+"POT-Creation-Date: 2024-05-28 14:23+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -311,6 +311,15 @@ msgstr ""
 msgid "Cancel"
 msgstr ""
 
+msgid "Warning"
+msgstr ""
+
+msgid "The marker was not dropped on a path."
+msgstr ""
+
+msgid "No routing found for this marker. Please move or delete it."
+msgstr ""
+
 msgid "No certification"
 msgstr ""
 

geotrek/core/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-04-03 15:39+0000\n"
+"POT-Creation-Date: 2024-05-28 14:23+0000\n"
 "PO-Revision-Date: 2020-09-23 07:10+0000\n"
 "Last-Translator: Emmanuelle Helly <emmanuelle.helly@makina-corpus.com>\n"
 "Language-Team: French <https://weblate.makina-corpus.net/projects/geotrek-"
@@ -316,6 +316,15 @@ msgstr "Fusionner les tronçons"
 msgid "Cancel"
 msgstr "Annuler"
 
+msgid "Warning"
+msgstr "Attention"
+
+msgid "The marker was not dropped on a path."
+msgstr "Le marqueur n'a pas été déposé sur un tronçon."
+
+msgid "No routing found for this marker. Please move or delete it."
+msgstr "Aucun routage n'a été trouvé pour ce marqueur. Veuillez le déplacer ou le supprimer."
+
 msgid "No certification"
 msgstr "Aucune labellisation"