25f989753b
There are many places in the API where we receive a property set to `null` which can then lead to defensive code deeper in the app in order to guard for this type of thing when usually we are expecting an array or for the property to be undefined using omitempty on the backend. Previously we had two places where we would deal with this in the serializer using our 'remove-null' util (KV and Intentions). This new decorator lets you declaritively define this type of data using a decorator @NullValue([]) (which would replce a null value with []. @NullValue in turn uses a more generic @replace helper, which we currently don't need but would let you replace any value with another, not just a null value. An additional benefit here is that the guard/replacement is executed lazily when we get the property instead of serializing all the values when they come in via the API. On super large datasets, where we only visualize part of the dataset (say in our scroll panes), this feels like a good improvement on the previous approach. |
||
|---|---|---|
| .. | ||
| .storybook | ||
| app | ||
| blueprints | ||
| config | ||
| lib | ||
| mock-api | ||
| node-tests/config | ||
| public | ||
| server | ||
| tests | ||
| translations | ||
| vendor | ||
| .dev.eslintrc.js | ||
| .editorconfig | ||
| .ember-cli | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .istanbul.yml | ||
| .nvmrc | ||
| .prettierrc | ||
| .template-lintrc.js | ||
| .watchmanconfig | ||
| GNUmakefile | ||
| README.md | ||
| ember-cli-build.js | ||
| package.json | ||
| testem.js | ||
README.md
consul-ui
Prerequisites
You will need the following things properly installed on your computer.
-
Node.js (with npm)
Installation
git clone https://github.com/hashicorp/consul.gitthis repositorycd ui/packages/consul-uimake startoryarn && yarn start
Yarn Commands
Most used tooling scripts below primarily use make which will yarn install
and in turn call node package scripts.
List of available project commands. yarn run <command-name>
| Command | Description |
|---|---|
| build:staging | Builds the UI in staging mode (ready for PR preview site). |
| build:ci | Builds the UI for CI. |
| build | Builds the UI for production. |
| lint | Runs all lint commands. |
| lint:hbs | Lints hbs template files. |
| lint:js | Lints js files. |
| format | Runs all auto-formatters. |
| format:js | Auto-formats js files using Prettier. |
| format:sass | Auto-formats scss files using Prettier. |
| start | Runs the development app on a local server using the mock API. |
| start:consul | Runs the development app local server using a real consul instance as the backend. |
| start:staging | Runs the staging app local server. |
| test | Runs the ember tests in a headless browser. |
| test:view | Runs the ember tests in a non-headless browser. |
| test:oss | Runs only the OSS ember tests in a headless browser. |
| test:oss:view | Runs only the OSS ember tests in a non-headless browser. |
| test:coverage:view | Runs only the test specified for coverage in a non-headless browser. |
| test:node | Runs tests that can't be run in ember using node. |
| doc:toc | Automatically generates a table of contents for this README file. |
Running / Development
The source code comes with a small development mode that runs enough of the consul API as a set of mocks/fixtures to be able to run the UI without having to run consul.
make startoryarn startto start the ember app- Visit your app at http://localhost:4200.
You can also run the UI against a normal Consul installation.
consul server -devto start consul listening on http://localhost:8500make start-consulto start the ember app proxying toconsul(this will respect theCONSUL_HTTP_ADDRenvironment variable to locate the Consul installation.- Visit your app at http://localhost:4200.
Example:
CONSUL_HTTP_ADDR=http://10.0.0.1:8500 make start-consul
Browser 'Environment' Variables
In order to configure different configurations of Consul you can use Web Inspector in your browser to set various cookie which to emulate different configurations whislt using the mock API.
For example: to enable ACLs, use Web Inspector to set a cookie as follows:
CONSUL_ACLS_ENABLE=1
This will enable the ACLs login page, to which you can login with any ACL token/secret.
| Variable | Default Value | Description |
|---|---|---|
CONSUL_ACLS_ENABLE |
false | Enable/disable ACLs support. |
CONSUL_ACLS_LEGACY |
false | Enable/disable legacy ACLs support. |
CONSUL_NSPACES_ENABLE |
false | Enable/disable Namespace support. |
CONSUL_SSO_ENABLE |
false | Enable/disable SSO support. |
CONSUL_OIDC_PROVIDER_URL |
undefined | Provide a OIDC provider URL for SSO. |
CONSUL_LATENCY |
0 | Add a latency to network requests (milliseconds) |
CONSUL_METRICS_POLL_INTERVAL |
10000 | Change the interval between requests to the metrics provider (milliseconds) |
CONSUL_METRICS_PROXY_ENABLE |
false | Enable/disable the metrics proxy |
CONSUL_METRICS_PROVIDER |
Set the metrics provider to use for the Topology Tab | |
CONSUL_SERVICE_DASHBOARD_URL |
Set the template URL to use for Service Dashboard links | |
CONSUL_UI_CONFIG |
Set the entire ui_config for the UI as JSON if you don't want to use the above singular variables |
|
CONSUL_SERVICE_COUNT |
(random) | Configure the number of services that the API returns. |
CONSUL_NODE_COUNT |
(random) | Configure the number of nodes that the API returns. |
CONSUL_KV_COUNT |
(random) | Configure the number of KV entires that the API returns. |
CONSUL_INTENTION_COUNT |
(random) | Configure the number of intentions that the API returns. |
CONSUL_POLICY_COUNT |
(random) | Configure the number of policies that the API returns. |
CONSUL_ROLE_COUNT |
(random) | Configure the number of roles that the API returns. |
CONSUL_NSPACE_COUNT |
(random) | Configure the number of namespaces that the API returns. |
CONSUL_UPSTREAM_COUNT |
(random) | Configure the number of upstreams that the API returns. |
CONSUL_EXPOSED_COUNT |
(random) | Configure the number of exposed paths that the API returns. |
CONSUL_CHECK_COUNT |
(random) | Configure the number of health checks that the API returns. |
CONSUL_OIDC_PROVIDER_COUNT |
(random) | Configure the number of OIDC providers that the API returns. |
See ./mock-api for more details.
Code Generators
Many classes used in the UI can be generated with ember generators, try ember help generate for more details
Running Tests
Tests use the mock api (see ./mock-api for details)
make testoryarn run testmake test-vieworyarn run test:viewto view the tests running in Chrome
OSS only tests can also be run using:
make test-ossoryarn run test:ossmake test-oss-vieworyarn run test:oss:viewto view the tests running in Chrome
Linting
make lint currently runs linting on the majority of js files and hbs files (using ember-template-lint).
See .eslintrc.js and .eslintignore for specific configuration.
Building
make buildbuilds the UI for production usage (env=production)make build-cibuilds the UI for CI/test usage (env=test)
Static files are built into ./dist
Running Tests in Parallel
Alternatively, ember-exam can be used to split the tests across multiple browser instances for faster results. Most options are the same as ember test. To see a full list of options, run ember exam --help.
Note: The EMBER_EXAM_PARALLEL environment variable must be set to override the default parallel value of 1 browser instance in testem.js.
To quickly run the tests across 4 parallel browser instances:
make test-parallel
To run manually:
$ EMBER_EXAM_PARALLEL=true ./node_modules/.bin/ember exam --split <num> --parallel
More ways to split tests can be found in the ember-exam README.md.