Replace osrd-project NGE fork by SBB NGE package

[louisgreiner]

Who would benefit from this feature?

Software developers

What is this feature about?

Currently, the integration of NGE in OSRD requires a fork of NGE with several patches to use the NPM package that we can't apply for now directly in NGE official repo. It is mainly due to concepts that we can't implement for now, for functionnalities that require prior refactor to be used by the standalone environment (= backend disabled, no auth, some UI components disabled) that we are using.

However, this is time consuming to keep this fork up to date (thank you Simon!), as we have to manually integrate the latest updates form NGE, and also it can be dangerous as we could diverge very fast if we implement too much patches.

The forked and official NPM packages is published in NPM.

Here is the list of the patches implemented in the fork that we want to get rid of and handle directly upstream in NGE official repo (diff):

• some UI functionnalities disabled:
  • Saved filters
  • Import of a Netzgrafik
  • Edit sidebar
  • Environment header ("standalone" ribbon on the top-left corner)
  • Use light theme by default
• hiding the return travel for trains (making them one-way)
• allow travel times to be unset (in which case they show up as "?")
• node capacity

Why is this feature valuable?

• Reduce fork divergence
• Gain of time (no need to rebase fork, handle conflicts and so on)
• Make our features available to other NGE users

Working with a custom NGE package

To work with a custom NGE package and publish a new version, available here

• Outside osrd

$ git clone https://github.com/osrd-project/netzgrafik-editor-frontend

• Modify and save
• Build this new version of NGE

$ npm run build:standalone

• Move the generated dist/ file into osrd/netzgrafik-editor-frontend/

$ cp -R ./dist ../osrd/netzgrafik-editor-frontend

• Modify osrd/netzgrafik-editor-frontend/dist/package.json to keep only :

{
  "name": ...
  "version": ...
  "repository": ...
  "files": ...
}

• Modify osrd/front/package.json:

{
  ...
  "@osrd-project/": "file:netzgrafik-editor-frontend",
  ...
}

• Restart osrd-front container

$ docker compose restart -d osrd-front

• Yarn install

$ cd front
$ yarn

• Push your modifications, it will publish a new package on NPM, available here
• Do not forget to update the version in osrd/front/package.json

[louisgreiner]

Unrelevant anymore, can re-open if any one feels the need to