35a92e856b
Our DataSource came in very iteratively, when we first started using it we specifically tried not to use it for things that would require portions of the @src="" attribute to be URL encoded (so things like service names couldn't be used, but dc etc would be fine). We then gradually added an easy way to url encode the @src="" attributes with a uri helper and began to use the DataSource component more and more. This meant that some DataSource usage continued to be used without our uri helper. Recently we hit #10901 which was a direct result of us not encoding @src values/URIs (I didn't realise this was one of the places that required URL encoding) and not going back over things to finish things off once we had implemented our uri helper, resulting in ~half of the codebase using it and ~half of it not. Now that almost all of the UI uses our DataSource component, this PR makes it even harder to not use the uri helper, by wrapping the string that it requires in a private URI class/object, that is then expected/asserted within the DataSource component/service. This means that as a result of this PR you cannot pass a plain string to the DataSource component without seeing an error in your JS console, which in turn means you have to use the uri helper, and it's very very hard to not URL encode any dynamic/user provided values, which otherwise could lead to bugs/errors similar to the one mentioned above. The error that you see when you don't use the uri helper is currently a 'soft' dev time only error, but like our other functionality that produces a soft error when you mistakenly pass an undefined value to a uri, at some point soon we will make these hard failing "do not do this" errors. Both of these 'soft error' DX features have been used this to great effect to implement our Admin Partition feature and these kind of things will minimize the amount of these types of bugs moving forwards in a preventative rather than curative manner. Hopefully these are the some of the kinds of things that get added to our codebase that prevent a multitude of problems and therefore are often never noticed/appreciated. Additionally here we moved the remaining non-uri using DataSources to use uri (that were now super easy to find), and also fixed up a place where I noticed (due to the soft errors) where we were sometimes passing undefined values to a uri call. The work here also led me to find another couple of non-important 'bugs' that I've PRed already separately, one of which is yet to be merged (#11105), hence the currently failing tests here. I'll rebase that once that PR is in and the tests here should then pass 🤞 Lastly, I didn't go the whole hog here to make DataSink also be this strict with its uri usage, there is a tiny bit more work on DataSink as a result of recently work, so I may (or may not) make DataSink equally as strict as part of that work in a separate PR. |
||
---|---|---|
.. | ||
app | ||
blueprints | ||
config | ||
docs | ||
lib | ||
mock-api | ||
node-tests/config | ||
public | ||
server | ||
tests | ||
translations | ||
vendor | ||
.dev.eslintrc.js | ||
.docfy-config.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.git
this repositorycd ui/packages/consul-ui
make start
oryarn && 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 start
oryarn start
to start the ember app- Visit your app at http://localhost:4200.
You can also run the UI against a normal Consul installation.
consul server -dev
to start consul listening on http://localhost:8500make start-consul
to start the ember app proxying toconsul
(this will respect theCONSUL_HTTP_ADDR
environment 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
Environment Variables
See ./docs/index.mdx
Contributing/Engineering Documentation
We have an in-app (only during development) component storybook and documentation site which can be visited using the Eng Docs link in the top navigation of the UI.
Browser 'Debug Utility' Functions and 'Environment' Variables
Run make start
then visit http://localhost:4200/ui/docs/bookmarklets for a
list of debug/engineering utilities you can use to help development of the UI
under certain scenarios.
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 test
oryarn run test
make test-view
oryarn run test:view
to view the tests running in Chrome
OSS only tests can also be run using:
make test-oss
oryarn run test:oss
make test-oss-view
oryarn run test:oss:view
to 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 build
builds the UI for production usage (env=production)make build-ci
builds 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.