entur / enki Goto Github PK

View Code? Open in Web Editor NEW

9.0 10.0 5.0 12.03 MB

Front-end for Nplan

Home Page: https://nplan.entur.org

License: European Union Public License 1.2

JavaScript 0.50% HTML 0.09% TypeScript 94.70% SCSS 4.70%

uttu enki frontend nplan ror

enki's Introduction

Enki

Frontend app for Nplan - a simple timetable editor. Backend is Uttu.

Development

To run for development, simply do:

npm install
npm start

Note: The app uses Node version 18 (LTS).

To run together with a local instance of Uttu on port 11701, add the following to .env.development.local.

REACT_APP_UTTU_API_URL=http://localhost:11701/services/flexible-lines

Configuration

Configuration is bootstrapped from /bootstrap.json, when the app loads. You should add your environment-specific config to the deployment, along with the built static files (i.e. in the build/ folder).

For local development, add a bootstrap.json file to the public/ folder.

See src/config/ConfigContext.ts for the shape of the configuration.

Authentication

Uses OIDC for authentication. This solution is agnostic to which authentication provider you use.

Example configuration (works with Auth0):

{
  "oidcConfig": {
    "authority": "https://<authentication domain>",
    "client_id": "<client id>",
    "extraQueryParams": {
      "audience": "<example audience>"
    }
  }
}

For full configuration reference, see oidc-client-ts documentation.

Bypass authentication locally

It's possible to bypass authentication locally with the configuration parameter disableAuthentication set to true. This can be used in combination with the local-no-authentication profile in the backend.

Testing

Uses Jest for unit and reducer testing.

npm test

enki's People

Contributors

Stargazers

Watchers

Forkers

strandoe okina-transport tjalexander97 solita-sabinaf esuomi

enki's Issues

Use "modern" redux patterns

Steps:

Fix useSelector usage (completed in #1259)
Fix useDispatch usage
Migrate to modern redux apis
Address renovate PRs (#1139 #1140) (see migration guide https://redux.js.org/usage/migrations/migrating-rtk-2)

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

WARN: Encrypted value is using deprecated PKCS1 padding, please change to using PGP encryption.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Update dependency @reduxjs/toolkit from v1.9.7 to v2
Update dependency @sentry/react from v7.117.0 to v8
Update dependency @testing-library/react from v15.0.7 to v16
Update dependency @types/node from v18.19.34 to v20
Update dependency date-fns from v2.30.0 to v3
Update dependency graphql-request from v6.1.0 to v7
Update dependency react-redux from v8.1.3 to v9
Update dependency uuid from v9.0.1 to v10
Click on this checkbox to rebase all open PRs at once

Detected dependencies

github-actions

.github/workflows/build.yml

actions/checkout v4

actions/setup-node v4

actions/cache v4

sonarsource/sonarqube-scan-action v2.1.0

actions/upload-artifact v4

.github/workflows/deploy.yml

actions/checkout v4

actions/download-artifact v4

FirebaseExtended/action-hosting-deploy v0

actions/checkout v4

actions/download-artifact v4

FirebaseExtended/action-hosting-deploy v0

actions/checkout v4

actions/download-artifact v4

FirebaseExtended/action-hosting-deploy v0

.github/workflows/pull-request-build-and-deploy.yml

actions/checkout v4

actions/setup-node v4

actions/cache v4

sonarsource/sonarqube-scan-action v2.1.0

FirebaseExtended/action-hosting-deploy v0

npm

package.json

@apollo/client 3.10.4

@entur/a11y 0.2.85

@entur/alert 0.16.9

@entur/button 3.2.25

@entur/chip 0.7.11

@entur/datepicker 9.4.10

@entur/dropdown 5.4.10

@entur/expand 3.5.14

@entur/form 7.1.10

@entur/grid 0.3.51

@entur/icons 6.17.1

@entur/layout 2.3.9

@entur/menu 4.2.33

@entur/modal 1.7.46

@entur/table 4.8.10

@entur/tokens 3.15.0

@entur/tooltip 2.7.9

@entur/typography 1.8.38

@reduxjs/toolkit 1.9.7

@sentry/react 7.117.0

axios 1.7.2

classnames 2.5.1

date-fns 2.30.0

duration-fns 3.0.2

file-saver 2.0.5

graphql 16.8.1

graphql-request 6.1.0

leaflet 1.9.4

lodash.clonedeep 4.5.0

lodash.isempty 4.4.0

lodash.isequal 4.5.0

moment 2.30.1

oidc-client-ts 3.0.1

react 18.3.1

react-dom 18.3.1

react-helmet 6.1.0

react-intl 6.6.8

react-leaflet 4.2.1

react-oidc-context 3.1.0

react-redux 8.1.3

react-router-dom 6.23.1

redux-sentry-middleware 0.2.2

uuid 9.0.1

@redux-devtools/extension 3.3.0

@testing-library/jest-dom 6.4.6

@testing-library/react 15.0.7

@testing-library/user-event 14.5.2

@types/file-saver 2.0.7

@types/leaflet 1.9.12

@types/lodash.clonedeep 4.5.9

@types/lodash.isempty 4.4.9

@types/lodash.isequal 4.5.8

@types/node 18.19.34

@types/react 18.3.3

@types/react-dom 18.3.0

@types/react-helmet 6.1.11

@types/react-intl-redux 0.1.19

@types/react-leaflet 3.0.0

@types/react-modal 3.16.3

@types/redux-immutable-state-invariant 2.1.4

@types/uuid 9.0.8

@vitejs/plugin-react 4.3.1

@vitest/coverage-v8 1.6.0

@vitest/ui 1.6.0

check-node-version 4.2.1

husky 9.0.11

identity-obj-proxy 3.0.0

jsdom 24.1.0

lint-staged 15.2.5

prettier 3.3.2

prettier-plugin-organize-imports 3.2.4

redux-immutable-state-invariant 2.1.0

sass 1.77.4

source-map-explorer 2.5.3

typescript 5.4.5

vite 5.2.13

vite-plugin-svgr 4.2.0

vite-tsconfig-paths 4.3.2

vitest 1.6.0

vitest-sonar-reporter 2.0.0

Check this box to trigger a request for Renovate to run again on this repository

Setup a framework for "sandbox" features

A separate folder for "sandbox" features, e.g. src/ext, so feature X would live in src/ext/x
Add a configuration-controlled feature flag system for sandbox features, all sandbox features are default OFF, unless turned ON by configuration
Do Chunk splitting
Each sandbox feature should have a codeowner
Review will be more lenient in case of code changes in a sandbox feature, and should be signed off by the codeowner of that feature

Potential use cases:

Mapview in journey pattern - interactions within it needs to affect the state of the application

Replace Create React App with Vite

This work has been started in #793

Make default locale configurable

Maybe as a part of this PR:

Consider how adding translations could be done more generic

Switch to "bootstrap"-based config

Instead of adding configuration to the static build, the CI/CD should add a config file to the public folder prior to deployment. The app will download this during loading to "bootstrap" the application.

Move Entur's infrastructure setup elsewhere and publish artifact from building this source

More to come

Probably includes introducing versioning

Dropdown component used across the UI is missing localized string for case when no options are available

In various places, such as when creating a new line or selecting an authority to a new network, if there's no options available at all, the dropdown component shows

Ingen treff for søket

as the default text;

This string is not localized. From what I can gather, it seems to come from within the component itself (@entur/dropdown?) and since it repeats everywhere where the dropdown component is used, the problem should be isolated in the component itself.

Technical wishlist

Could be nice to generate TypeScript typings from the GraphQL scheme. See for example this. https://github.com/dotansimha/graphql-code-generator
Same for Swagger: can export TypeScript typings for example from here: http://editor.swagger.io/#/
Upgrade to newest version av React-Intl: https://github.com/formatjs/react-intl
Replace moment.js with date-fns (https://momentjs.com/docs/#/-project-status/)
Finish migrating to apollo graphql client

First time login causes the UI to load indefinitely until a provider is chosen

As shown by this screenshot, the UI gets stuck with infinite spinner and "unknown error" alert popup:

This is immediately fixed by choosing a data provider, so it's simply missing a default value and/or some kind of landing page, or even just a bit more descriptive error message.

Feature detection for export downloads is too broad

The try/catch surround the feature detection for export downloads masks other errors, e.g. server errors:

This is the feature detection code:

    const isFileSaverSupported = !!new Blob();

The try/catch should wrap only this line of code. Other errors should be handled separately.

Additionally:

We should not use an alert to display the error message
The error message should be localized

Add possibility to opt out of authentication when running locally

Move environment icons to .github folder

These are Entur-specific. Will be moved away with #1265

Clean up date handling

There's a mix of date-fns, moment, native date and string / iso across models and components. This needs to be cleaned up.

Ideally, models should use @internationalized, and transform from/to api formats.

Solving this issue should remove the need to upgrade date-fns (#1159).

Make day types / calendars "first class citizens"

Make it possible to edit day types / calendars independently from lines / service journeys.

TBD

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (github>entur/abt-renovate-config:renovate). Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.