GitHub user merrimanr opened a pull request:
https://github.com/apache/metron/pull/1266
METRON-1875: Expose configurable global settings in the Alerts UI
## Contributor Comments
This PR exposes a JSON file that can be used to configure the Alerts UI.
Properties in this file are read on startup and available through an
`AppConfigService` that can be injected. The use case in this PR is a
configurable REST API path. This path was hardcoded throughout the Alerts UI
code but can now be changed in the configuration file directly. A restart or
rebuild is not necessary, the change is visible as soon as the Alerts UI is
refreshed in the browser. I think this could be generally useful for other use
cases in the future.
### Changes Included
- An `AppConfigService` was added that loads configuration settings by
requesting the config file as a static asset.
- The various services were updated to use the `apiRoot` configuration
setting instead of a hardcoded url.
- We currently load column names from local storage on startup. I don't
believe this is used anymore so I switched the initialization call to
`AppConfigService` and removed the unused code in `ColumnNameService`.
- Updated the unit tests to inject a mock `AppConfigService` instance.
### Testing
To test this feature, spin up full dev and verify that the UI continues to
function normally. Edit the file at
`/usr/metron/0.6.1/web/alerts-ui/assets/app-config.json' and set the `apiRoot`
property to a different value. Refresh the Alerts UI and verify the api path
reflects the change in `app-config.json`. For example if I changed
`app-config.json` to be:
```
{
"apiRoot": "/some/api/path"
}
```
I would expect to see the search request url (in the network tab of Chrome
developer tools for example) to be
`http://node1:4201/some/api/path/search/search`.
## Pull Request Checklist
Thank you for submitting a contribution to Apache Metron.
Please refer to our [Development
Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235)
for the complete guide to follow for contributions.
Please refer also to our [Build Verification
Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview)
for complete smoke testing guides.
In order to streamline the review of the contribution we ask you follow
these guidelines and ask you to double check the following:
### For all changes:
- [x] Is there a JIRA ticket associated with this PR? If not one needs to
be created at [Metron
Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
- [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA
number you are trying to resolve? Pay particular attention to the hyphen "-"
character.
- [x] Has your PR been rebased against the latest commit within the target
branch (typically master)?
### For code changes:
- [x] Have you included steps to reproduce the behavior or problem that is
being changed or addressed?
- [x] Have you included steps or a guide to how the change may be verified
and tested manually?
- [x] Have you ensured that the full suite of tests and checks have been
executed in the root metron folder via:
```
mvn -q clean integration-test install &&
dev-utilities/build-utils/verify_licenses.sh
```
- [x] Have you written or updated unit tests and or integration tests to
verify your changes?
- [x] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [x] Have you verified the basic functionality of the build by building
and running locally with Vagrant full-dev environment or the equivalent?
### For documentation related changes:
- [x] Have you ensured that format looks appropriate for the output in
which it is rendered by building and verifying the site-book? If not then run
the following commands and the verify changes via
`site-book/target/site/index.html`:
```
cd site-book
mvn site
```
#### Note:
Please ensure that once the PR is submitted, you check travis-ci for build
issues and submit an update to your PR as soon as possible.
It is also recommended that [travis-ci](https://travis-ci.org) is set up
for your personal repository such that your branches are built there before
submitting a pull request.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/merrimanr/incubator-metron METRON-1875
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/metron/pull/1266.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1266
----
commit dc3fc27f2d83c2d3e57e88165180b8c39661735c
Author: merrimanr <merrimanr@...>
Date: 2018-11-15T23:13:26Z
initial commit
----
---
