Release 3.17.1

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "npm"
+    directory: "./frontend" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/action-intall-and-test.yml

@@ -1,29 +1,45 @@
 name: Install and test
 
-on: [pull_request]
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - develop
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  CYPRESS_INSTALL_BINARY: 0
 
 jobs:
   install-and-test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+
       - name: Setup node
         id: cache-node-modules
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ./frontend/.nvmrc
           cache: "yarn"
           cache-dependency-path: "**/yarn.lock"
+
       - name: Install dependencies
-        if: steps.cache.outputs.cache-hit != 'true'
         run: yarn install --frozen-lockfile
         working-directory: ./frontend
+
       - name: Check types
         run: yarn tsc
         working-directory: ./frontend
+
       - name: Run tests
         run: yarn test:coverage
         working-directory: ./frontend
+
       - name: Check linter
         run: yarn lint
         working-directory: ./frontend

.github/workflows/e2e.yml

@@ -0,0 +1,45 @@
+name: E2E tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - develop
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  e2e:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup node
+        id: cache-node-modules
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ./frontend/.nvmrc
+          cache: "yarn"
+          cache-dependency-path: "**/yarn.lock"
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+        working-directory: ./frontend
+
+      - name: Cypress run
+        uses: cypress-io/github-action@v6
+        with:
+          start: yarn dev
+          working-directory: ./frontend
+
+      - name: Archive results as artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: cypress
+          path: |
+            /home/runner/work/Geotrek-rando-v3/Geotrek-rando-v3/frontend/cypress/videos/*.mp4
+            /home/runner/work/Geotrek-rando-v3/Geotrek-rando-v3/frontend/cypress/screenshots/*.png

docs/changelog.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 3.17.1 (2024-01-25)
+
+**🚀 New features**
+
+- Customization of result card (#987)
+
+**✨ Improvements**
+
+- Remove the limitation of result card max height (#1012)
+
+**🔧 Maintenance**
+
+- Upgrade Cypress package to 13.6.3 (#1028)
+- Run Cypress tests on CI (#948 and #1028)
+
+**🐛 Fixes**
+
+- Fix regression customization header - regression since v3.17.0 (#1019 and #1020)
+- Fix scriptsHeader/Footer containing only one node - regression since v3.15.4 (#1029 and #1030)
+
 ## 3.17.0 (2024-01-12)
 
 Require Geotrek-admin 2.98.0 (March 2023) minimum.

docs/customization.md

@@ -193,6 +193,19 @@ NB: For "report" and "reservationWidget" sections with `anchors` set to `true`,
 
   - `zoomAvailableOffline` allows you to define the zoom modes allowed in offline mode. This allows you to control the amount of disk space required when caching. Default `[13,14,15]`
 
+- `resultCard.json` to customize the elements to be displayed on featured cards that link to a details page (only trek cards for now).
+
+  - You can display/hide the `location` and `themes` by defining a `display` key.
+  - You can define an array of keywords in `informations` to display them (their order in the array matters). The keywords are as follows:
+    - `'difficulty'`,
+    - `'duration'`,
+    - `'distance'`,
+    - `'positiveElevation'`,
+    - `'negativeElevation'`,
+    - `'courseType'`,
+    - `'networks'`,
+      Default value is `"informations": ["difficulty", "duration", "distance", "positiveElevation"]`. See https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/frontend/config/resultCard.json.
+
 - `redirects.json` to define URL rewriting for your instance. For example, you can use this customization to redirect old URL style (Geotrek-rando V2) to the new URL style (Geotrek-rando V3) or to redirect old URL to a new URL after changing the name of a hike in the backend.
 
   - In `rules`, you can define all the rules needed to redirect clients

docs/development.md

@@ -8,7 +8,7 @@ Installation in development:
 - Use nvm and then:
 
 ```bash
-nvm use 18
+nvm use
 ```
 
 Install yarn

frontend/.gitignore

@@ -8,6 +8,7 @@ node_modules
 
 # testing
 /coverage
+**/public/*@cypress
 
 # production
 /build

frontend/config/resultCard.json

@@ -0,0 +1,11 @@
+{
+  "trek": {
+    "location": {
+      "display": true
+    },
+    "themes": {
+      "display": true
+    },
+    "informations": ["difficulty", "duration", "distance", "positiveElevation"]
+  }
+}

frontend/customization/config/resultCard.json

@@ -0,0 +1,11 @@
+{
+  "trek": {
+    "location": {
+      "display": true
+    },
+    "themes": {
+      "display": true
+    },
+    "informations": ["difficulty", "duration", "distance", "positiveElevation"]
+  }
+}

frontend/cypress.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  e2e: {
+    baseUrl: "http://rando.localhost:3000",
+    retries: {
+      runMode: 3,
+    },
+    viewportHeight: 1080,
+    viewportWidth: 1920,
+  },
+});

frontend/cypress/e2e/homePage.cy.ts

@@ -0,0 +1,5 @@
+describe('template spec', () => {
+  it('Visits homepage', () => {
+    cy.visit('/')
+  })
+})

frontend/cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

frontend/cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

frontend/cypress/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["es5", "dom"],
+    "types": ["cypress", "node"],
+  },
+  "include": ["**/*.ts"],
+}

frontend/docs/quick-start.md

@@ -12,6 +12,8 @@ Useful commands:
 
 - `npm run test` to launch tests in watch mode
 
+- `npm run e2e` to launch cypress end-to-end tests (after ```npm run dev```)
+
 - * `npm run generate` to generate a new component or a new page. You will be prompted the following questions:
 
   * Do you want a page or a component?

frontend/jestAfterEnv.setup.tsx

@@ -232,6 +232,20 @@ setConfig({
         touristicEvent: []
       },
     },
+    resultCard: {
+      trek: {
+        location: {
+          display: true,
+        },
+        themes: {
+          display: true,
+        },
+        labels: {
+          display: true,
+        },
+        informations: ['difficulty', 'duration', 'distance', 'positiveElevation'],
+      },
+    },
     detailsSectionHtml: {
       forecastWidget: { default: '<iframe\n  id="widget_autocomplete_preview"\n  className="w-full"\n  height="150"\n  src="https://meteofrance.com/widget/prevision/{{ cityCode }}0"\n></iframe>\n' }
     },

frontend/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geotrek-rando-frontend",
-  "version": "3.17.0",
+  "version": "3.17.1",
   "private": true,
   "scripts": {
     "debug": "NODE_OPTIONS='--inspect' next ./src",
@@ -12,6 +12,7 @@
     "prestart": "node ./src/services/rewriteBuildedPages.mjs",
     "start": "NODE_ENV=production node ./src/server.js",
     "test": "jest --coverage=false --runInBand",
+    "e2e": "cypress run",
     "test:coverage": "jest --coverage --runInBand",
     "test:compact": "DEBUG_PRINT_LIMIT=50 yarn test",
     "tsc": "tsc -p ./src/tsconfig.json",
@@ -44,7 +45,7 @@
     "autoprefixer": "^10.4.14",
     "axios": "0.25.0",
     "compression": "^1.7.4",
-    "cypress": "^4.12.1",
+    "cypress": "^13.6.3",
     "debounce": "^1.2.1",
     "deepmerge": "^4.3.1",
     "diacritics": "^1.3.0",