METRON-1875: Expose configurable global settings in the Alerts UI #1266

merrimanr · 2018-11-15T23:33:48Z

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 apiRootproperty to a different value. Refresh the Alerts UI and verify the api path reflects the change inapp-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 for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines 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:

Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
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.
Has your PR been rebased against the latest commit within the target branch (typically master)?

For code changes:

Have you included steps to reproduce the behavior or problem that is being changed or addressed?
Have you included steps or a guide to how the change may be verified and tested manually?
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 
```
Have you written or updated unit tests and or integration tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
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:

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 is set up for your personal repository such that your branches are built there before submitting a pull request.

sardell · 2018-11-16T17:14:59Z

metron-interface/metron-alerts/src/app/service/app-config.service.ts

+
+  constructor(private http: HttpClient) { }
+
+  loadAppConfig() {


When we convert to a promise, we lose the advantages that come with using Observables, including it being cancelable. This helps to prevent possible memory leaks in the browser. Instead of converting to a promise, I think it would be better to use rxjs' take operator. For example:

loadAppConfig() { return this.http.get('assets/app-config.json').pipe( take(1) ).subscribe(data => { this.appConfig = data; }); }

The approach in this PR was inspired by https://juristr.com/blog/2018/01/ng-app-runtime-config/. It mentions promises are not supported in APP_INITIALIZER. I tried your suggestion and it did not work. I can add a comment explaining that.

The linked article explains it perfectly. Disregard my suggestion since we need to be using a promise here.

sardell · 2018-11-16T17:29:03Z

...n-interface/metron-alerts/src/app/alerts/alerts-list/table-view/table-view.component.spec.ts

@@ -31,12 +31,20 @@ import { UpdateService } from '../../../service/update.service';
 import { GlobalConfigService } from '../../../service/global-config.service';
 import { MetaAlertService } from '../../../service/meta-alert.service';
 import { DialogService } from 'app/service/dialog.service';
+import {AppConfigService} from "../../../service/app-config.service";


If possible, could you use single quotes and add spacing inside the brackets? This formatting is specified by our tslint config, and editors like VS code will show an error if it's not fixed.

sardell · 2018-11-16T17:29:49Z

metron-interface/metron-alerts/src/app/alerts/alerts-list/tree-view/tree-view.component.spec.ts

@@ -32,6 +32,14 @@ import { UpdateService } from '../../../service/update.service';
 import { GlobalConfigService } from '../../../service/global-config.service';
 import { MetaAlertService } from '../../../service/meta-alert.service';
 import { DialogService } from 'app/service/dialog.service';
+import {AppConfigService} from "../../../service/app-config.service";
