Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uber/cadence-web
Web UI for visualizing workflows on Cadence
https://github.com/uber/cadence-web
cadence mocha stylus uber vuejs2 webpack workflows
Last synced: 29 days ago
JSON representation
Web UI for visualizing workflows on Cadence
- Host: GitHub
- URL: https://github.com/uber/cadence-web
- Owner: uber
- License: other
- Created: 2017-12-01T23:50:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-15T07:40:54.000Z (7 months ago)
- Last Synced: 2024-04-15T09:07:59.591Z (7 months ago)
- Topics: cadence, mocha, stylus, uber, vuejs2, webpack, workflows
- Language: JavaScript
- Homepage:
- Size: 9 MB
- Stars: 377
- Watchers: 932
- Forks: 100
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cadence-temporal-workflow - Cadence Web - Web UI for visualizing workflows on Cadence (Cadence)
README
# Cadence Web UI
[](https://github.com/uber/cadence-web/actions/workflows/build.yml) [](https://hub.docker.com/r/ubercadence/web/tags)
Cadence is a distributed, scalable, durable, and highly available orchestration engine we developed at Uber Engineering to execute asynchronous long-running business logic in a scalable and resilient way.
This web UI is used to view workflows from [Cadence][cadence], see what's running, and explore and debug workflow executions.
## Getting Started
### Configuration
Set these environment variables if you need to change their defaults
| Variable | Description | Default |
| -------------------------- | -------------------------------------------- | ---------------- |
| CADENCE_TCHANNEL_PEERS | Comma-delmited list of tchannel peers | 127.0.0.1:7933 |
| CADENCE_TCHANNEL_SERVICE | Name of the cadence tchannel service to call | cadence-frontend |
| CADENCE_WEB_PORT | HTTP port to serve on | 8088 |
| CADENCE_EXTERNAL_SCRIPTS | Addtional JavaScript tags to serve in the UI | |
| ENABLE_AUTH | Enable auth feature | false |
| AUTH_TYPE | supports ADMIN_JWT and OIDC | '' |
| AUTH_ADMIN_JWT_PRIVATE_KEY | JWT signing private key for ADMIN_JWT type | '' |
| OPENID_CLIENT_ID | Client ID for OIDC type authentication | '' |
| OPENID_CLIENT_SECRET | Client secret for OIDC type authentication | '' |
| OPENID_CALLBACK_URL | URL redirect to Cadence WEB after OIDC auth | '' |
| OPENID_DISCOVER_URL | Link to provider .well-known configuration | '' |
| OPENID_SCOPE | Scope to request from idp | openid |
### Running locally
`cadence-web` requires node `v10.22.1` or greater to be able to run correctly. `cadence-web` uses all the standard [npm scripts](https://docs.npmjs.com/misc/scripts) to install dependencies, run the
server, and run tests.
To provide a consistent environment we recommend using docker in development. We provide a default configuration for remote containers using docker-compose.
#### Using VSCode Dev Containers
1. Set up the [Remote Containers plugin](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in VSCode.
2. Open the cadence-web directory in VSCode.
3. Use the Command Palette to select the 'Reopen folder in Container' option. `npm install` should run automatically in the container upon doing so.
4. Run the app in the container with `npm run dev`.
5. Open `localhost:8088` (or the custom Cadence Web port you have defined) to load the webapp.
#### Using docker-compose to start the dev container
To start local server with live reload on code change you can run `docker-compose up`.
For development and contributing to `cadence-web`, please see the [contributing guide](https://github.com/uber/cadence-web/blob/master/CONTRIBUTING.md).
You may also use docker by pulling [ubercadence/web](https://hub.docker.com/r/ubercadence/web/). It is also included in the Cadence server's [local docker setup](https://github.com/uber/cadence/tree/master/docker).
### API
If you need to extend `cadence-web` to add middleware to the server, you can install `cadence-web` as a dependecy, and it will export the [Koa](http://koajs.com/) web server that has not yet been started or configured. It includes an additional `init` function that will then compose the built-in middleware. This gives you an option to add middleware before or after you call `init` so it will add the middleware at the beginning or the end of the chain, respectively.
#### `init(options)`
All options are optional.
`useWebpack`: If `true`, starts webpack and adds the middleware, otherwise if `false`, it assumes the UI bundle was already built and serves it statically. Defaults to `process.env.NODE_ENV === 'production'`.
`logErrors`: If `true`, thrown errors are logged to `console.error`. Defaults to `true`.
For example, here is how you would add a request count metric using `uber-statsd-client`:
```javascript
var app = require('cadence-web');
var createStatsd = require('uber-statsd-client');
var sdc = createStatsd({
host: 'statsd.example.com',
});
app
.use(async function(ctx, next) {
sdc.increment('http.request');
await next();
})
.init()
.listen(7000);
```
The [webpack](https://webpack.js.org/) configuration is also exported as `webpackConfig`, and can be modified before calling `init()`.
### Licence
MIT License, please see [LICENSE](https://github.com/uber/cadence-web/blob/master/LICENSE) for details.
[cadence]: https://github.com/uber/cadence