GeotrekCE · justinefricou · Apr 10, 2024 · Apr 10, 2024 · Apr 12, 2024 · Apr 12, 2024
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -43,7 +43,7 @@ jobs:
     name: Python Unittests
     runs-on: ubuntu-latest
     container: makinacorpus/geodjango:${{ matrix.os }}
-    
+
     permissions:
       packages: write  # required to publish docker image
 
@@ -60,7 +60,7 @@ jobs:
 
     services:
       postgres:
-        image: postgis/postgis:12-2.5
+        image: pgrouting/pgrouting:12-3.0-3.0.0
         env:
           POSTGRES_DB: ci_test
           POSTGRES_PASSWORD: ci_test
@@ -261,7 +261,7 @@ jobs:
 
     services:
       postgres:
-        image: postgis/postgis:12-2.5
+        image: pgrouting/pgrouting:12-3.0-3.0.0
         env:
           POSTGRES_DB: ci_test
           POSTGRES_PASSWORD: ci_test
@@ -348,7 +348,7 @@ jobs:
 
     services:
       postgres:
-        image: postgis/postgis:12-2.5
+        image: pgrouting/pgrouting:12-3.0-3.0.0
         env:
           POSTGRES_DB: ci_test
           POSTGRES_PASSWORD: ci_test

diff --git a/.gitignore b/.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

diff --git a/cypress/integration/nav_create_trek.js b/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');

diff --git a/cypress/support/commands.js b/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);
+  });
 });
diff --git a/debian/postinst b/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

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -15,7 +15,7 @@ x-images:
 
 services:
   postgres:
-    image: postgis/postgis:12-2.5
+    image: pgrouting/pgrouting:12-3.0-3.0.0
     env_file:
       - .env
     ports:

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -5,6 +5,20 @@ CHANGELOG
 2.111.0+dev     (XXXX-XX-XX)
 ----------------------------
 
+**Warnings**
+
+- When adding a via-point to a linear object's topology, it is now required to drop the new marker onto a path before the updated route is displayed, as the preview is no longer available when dragging the marker. This is due to the route computation now being performed on the backend. For more information, see https://github.com/GeotrekCE/Geotrek-admin/issues/4286
+- After adding new paths, pre-existing topologies can follow routes that are no longer the shortest. When editing topology-based linear objects through the interface, their route will no longer be automatically recomputed to the shortest option, which was unwanted behavior. This means you might now encounter topologies that take a detour despite not using a via-point marker. Be careful when editing such a route, as moving or adding neighboring markers will remove the detour. Note: this does not address the topology ordering issue when adding new paths. For more information, see https://github.com/GeotrekCE/Geotrek-admin/issues/4286
+
+**Improvements**
+
+- Optimize routing: computation is now done in the backend using the A* algorithm (#4070)
+- Prevent from placing route markers outside of paths or on unreachable paths (#4070)
+
+**Bug fixes**
+
+- Fix editing of topology-based linear objects via the interface: objects are no longer automatically rerouted (#4070)
+
 **Documentation**
 
 - Update theme color

diff --git a/docs/install/import.rst b/docs/install/import.rst
@@ -106,7 +106,7 @@ or `via QGis following this blog post <https://makina-corpus.com/sig-webmapping/
     * **Geometric type** : Linestring
     * **Expected formats** (supported by GDAL) : Shapefile, Geojson, Geopackage
     * **Template** : :download:`paths.geojson <../files/import/paths.geojson>`
-    * **Good to know** : 
+    * **Good to know** :
        * The default SRID code is 4326
        * The default encoding is UTF-8
        * Imported paths are unpublished by default
@@ -139,6 +139,26 @@ or `via QGis following this blog post <https://makina-corpus.com/sig-webmapping/
     --name-attribute id \
     --comments-attribute commentaire
 
+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
+
+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)
@@ -228,7 +248,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:
 
@@ -257,7 +277,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.
 
@@ -312,7 +332,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::
@@ -448,17 +468,17 @@ It is also possible to import sensitive areas through command line:
 
     sudo geotrek import geotrek.sensitivity.parsers.BiodivParser
 
-.. warning:: 
-  If you don't see any data in your area, it means that Biodiv'Sports does not contains data for your territory. 
-  Then it is widely recommended to add your data directly into Biodiv'Sports, as it will be available for 
-  multiple users, and then retrieve them into your Geotrek instance. To import data in Biodiv'Sports 
+.. warning::
+  If you don't see any data in your area, it means that Biodiv'Sports does not contains data for your territory.
+  Then it is widely recommended to add your data directly into Biodiv'Sports, as it will be available for
+  multiple users, and then retrieve them into your Geotrek instance. To import data in Biodiv'Sports
   go visit its website: https://biodiv-sports.fr
 
 
 Import from shapefile
 ---------------------
 
-Imported data must be in standard ESRI shapefile format. 
+Imported data must be in standard ESRI shapefile format.
 The various Shapefile files (``.shp``, ``.shx``, ``.dbf``, ``.prj``, *etc*.) must be assembled in a zip archive.
 
 .. warning::
@@ -468,7 +488,7 @@ Attribute data for sensitive areas species
 
 - ``espece``: Species name. Mandatory. A species with this name must first have been created in Biodiv'sports. Otherwise, import of the line will fail.
 - ``contact``: Contact in text or HTML format. *Optional*.
-- ``descriptio``: Description in text or HTML format. *Optional*. 
+- ``descriptio``: Description in text or HTML format. *Optional*.
 
 .. warning::
   Species name must strictly respect the species name string (accentuation, case and punctuation).
@@ -512,7 +532,7 @@ or:
     sudo geotrek  import geotrek.sensitivity.parsers.RegulatorySensitiveAreaShapeParser <file.shp>.
 
 
-.. warning:: 
+.. warning::
   Relaunching an import **with the same file** will create duplicates.
 
 
@@ -534,7 +554,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, 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:
 
@@ -553,7 +573,7 @@ To get help about a command:
 ::
 
     sudo geotrek help <subcommand>
-    
+
 .. _import-dem-altimetry:
 
 
@@ -671,7 +691,7 @@ Import POIs
     * **Geometric type** : Point
     * **Expected formats** (supported by GDAL) : Shapefile, Geojson, Geopackage
     * **Template** : :download:`poi.geojson <../files/import/poi.geojson>`
-    * **Good to know** : 
+    * **Good to know** :
        * The SRID must be 4326
        * The default encoding is UTF-8
        * Imported POIs are unpublished by default
@@ -801,7 +821,7 @@ Import Infrastructure
     * **Geometric type** : Point
     * **Expected formats** (supported by GDAL) : Shapefile, Geojson, Geopackage
     * **Template** : :download:`infrastructure.geojson <../files/import/infrastructure.geojson>`
-    * **Good to know** : 
+    * **Good to know** :
        * The SRID must be 4326
        * The default encoding is UTF-8
        * Imported infrastructures are unpublished by default
@@ -980,7 +1000,7 @@ Import Signage
     * **Geometric type** : Point
     * **Expected formats** (supported by GDAL) : Shapefile, Geojson, Geopackage
     * **Template** : :download:`signage.geojson <../files/import/signage.geojson>`
-    * **Good to know** : 
+    * **Good to know** :
        * The default SRID code is 4326
        * The default encoding is UTF-8
        * Imported signage are unpublished by default
@@ -1058,7 +1078,7 @@ Import Cities
     * **Geometric type** : Polygon
     * **Expected formats** (supported by GDAL) : Shapefile, Geojson, Geopackage
     * **Template** : :download:`cities.geojson <../files/import/cities.geojson>`
-    * **Good to know** : 
+    * **Good to know** :
        * The default SRID code is 4326
        * The default encoding is UTF-8
        * Imported cities are unpublished by default
@@ -1145,7 +1165,7 @@ Import Districts
     * **Geometric type** : Polygon
     * **Expected formats** (supported by GDAL) : Shapefile, Geojson, Geopackage
     * **Template** : :download:`districts.geojson <../files/import/districts.geojson>`
-    * **Good to know** : 
+    * **Good to know** :
        * The default SRID code is 4326
        * The default encoding is UTF-8
        * Imported districts are unpublished by default
@@ -1219,7 +1239,7 @@ Import Restricted areas
     * **Geometric type** : Polygon
     * **Expected formats** (supported by GDAL) : Shapefile, Geojson, Geopackage
     * **Template** : :download:`restrictedareas.geojson <../files/import/restrictedareas.geojson>`
-    * **Good to know** : 
+    * **Good to know** :
        * The default SRID code is 4326
        * The default encoding is UTF-8
        * Imported restricted areas are unpublished by default
@@ -1265,10 +1285,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 :
 ::

diff --git a/docs/install/installation.rst b/docs/install/installation.rst
@@ -79,8 +79,8 @@ If you are not confident with the ``install.sh`` script, or if you are having tr
 1. Add ``deb https://packages.geotrek.fr/ubuntu bionic main`` to APT sources list.
 2. Add https://packages.geotrek.fr/geotrek.gpg.key to apt keyring.
 3. Run ``apt-get update``
-4. If you want to use a local database, install PostGIS package (before installing Geotrek-admin, not at the same time).
-   If not, you must create database and enable PostGIS extension before.
+4. If you want to use a local database, install the pgRouting package by running ``sudo apt install -y postgresql-pgrouting wget software-properties-common`` (before installing Geotrek-admin, not at the same time).
+   If not, you must create database and enable PostGIS and pgRouting extensions before.
 5. Install the Geotrek-admin package (``sudo apt install geotrek-admin``).
 
 .. note ::