Orchestrator UI

Pre-requisites:

This project requires yarn to be installed globally. It will also install nx to manage the mono repo tooling. Supported Node versions: "^14.18.0 || >=16.0.0"

Development server

Run nx serve example-orchestrator-ui for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

Storybook server

Run nx storybook orchestrator-ui-components for a storybook server. Navigate to http://localhost:4400/. The app will automatically reload if you change any of the story files.

Understand this workspace

Run nx graph to see a diagram of the dependencies of the projects.

Remote caching

Run npx nx connect-to-nx-cloud to enable remote caching and make CI faster.

Further help

Visit the Nx Documentation to learn more.

Link locally to the orchestrator-ui-components npm library

When working on the orchestrator-ui-components library combined with an implementation of the orchestrator-ui app, a local link can be used by running ./link-start.sh. This will expose the library for local development. To connect to the local version of the npm package, run the folowing commands in the custom orchestrator-ui app:

rm -rf node_modules/.cache
yarn link @orchestrator-ui/orchestrator-ui-components
yarn link react
yarn link react-dom

To stop using the link, first run the following commands in the custom version of the orchestrator-ui app:

yarn unlink @orchestrator-ui/orchestrator-ui-components
yarn unlink react
yarn unlink react-dom
rm -rf node_modules/.cache
yarn install --force

Finally run ./link-stop.sh to stop exposing the orchestrator-ui-components library package

Types

Generic rules

We will have some basic type definitions in the lib: Subscriptions, Subscription, Processes, Process
We will not use the generated types direct in the components; instead we map it to and from generated types
We assume that most users will only want to add columns/fields in Subscriptions, Subscription, Processes, Process
We assume that certain fields are not changeable, for example fields that are used by workflow engine related objects; like workflow status, subscription status.
Naming, no real naming convention yet, but for starters: SubscriptionDetailBase and SubscriptionTableBase for stuff in lib

Actions:

When orchestrator subscription graphql reference endpoint is ready -> move the __generated__ folder to lib (or to a separate types package); so the lib will contain the reference graphql types for a specific version of orchestrator-core: upon build we can check this and let the build fail when the type mappers can not be used without warning, because backwards incompatible changes were done in the backend
There are fields in the core like: Process.Assignee and Subscription.CustomerAbbrevation they should be removed/changed for enum values like KLANTSUPPORT. Probably around 4 a 5 SURF specific fields, Note: when the remove is done, this is the first actual use case for type customisation that we can test.

Georgi2704/orchestrator-ui