599e8a05d3
Port of: Ensure we check intention service prefix permissions for per service (#11270) Previously, when showing some action buttons for 'per service intentions' we used a global 'can I do something with any intention' permission to decide whether to show a certain button or not. If a user has a token that does not have 'global' intention permissions, but does have intention permissions on one or more specific services (for example via service / service_prefix), this meant that we did not show them certain buttons required to create/edit the intentions for this specific service. This PR adds that extra permissions check so we now check the intentions permissions per service instead of using the 'global' "can I edit intentions" question/request. **Notes:** - If a HTML button is `disabled` this means tippy.js doesn't adopt the popover properly and subsequently hide it from the user, so aswell as just disabling the button so you can't active the popover, we also don't even put the popover on the page - If `ability.item` or `ability.item.Resources` are empty then assume no access **We don't try to disable service > right hand side intention actions here** Whether you can create intentions for a service depends on the _destination_ of the intention you would like to create. For the topology view going from the LHS to the center, this is straightforwards as we only need to know the permissions for the central service, as when you are going from the LHS to the center, the center is the _destination_. When going from the center to the RHS the _destination[s]_ are on the RHS. This means we need to know the permissions for potentially 1000s of services all in one go in order to know when to show a button or not. We can't realistically discover the permissions for service > RHS services as we'd have either make a HTTP request per right hand service, or potentially make an incredibly large POST request for all the potentially 1000s of services on the right hand side (more preferable to 1000s of HTTP requests). Therefore for the moment at least we keep the old functionality (thin client) for the middle to RHS here. If you do go to click on the button and you don't have permissions to update the intention you will still not be able to update it, only you won't know this until you click the button (at which point you'll get a UI visible 403 error) Note: We reversed the conditional here between 1.10 and 1.11 So this make 100% sense that the port is different here to 1.11 |
||
|---|---|---|
| .. | ||
| 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 | ||
| ember-cli-build.js | ||
| GNUmakefile | ||
| package.json | ||
| README.md | ||
| testem.js | ||
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-ui
then:
To run the UI
From within ui/packages/consul-ui directory run:
make start
To run tests
From within ui/packages/consul-ui directory run:
make test-oss-viewwhich will run the tests in Chrome
(see below and/or the testing section of the engineering docs for further detail)
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
Environment Variables
See ./docs/index.mdx
Branching
Follow a ui/**/** branch naming pattern. This branch naming pattern allows front-end focused builds, such as FE tests, to run automatically in Pull Requests. It also adds the theme/ui label to Pull Requests.
Examples:
ui/feature/add...ui/bugfix/fix...ui/enhancement/update...
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. Alternatively all of these docs are also readable via GitHub's UI, so folks can use whatever works best for them.
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), the mock-api runs automatically during testing, you don't need to run anything separately from the below commands in order for the tests to use the mock-api.
make testoryarn run testmake test-vieworyarn run test:viewto view the tests running in Chrome
For more guidance on running tests, see the testing section of the engineering docs.
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
You probably don't need to understand this if you are simply running some tests locally.
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.