You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by merrimanr <gi...@git.apache.org> on 2018/11/15 23:33:53 UTC
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
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 <me...@...>
Date: 2018-11-15T23:13:26Z
initial commit
----
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288233
--- Diff: metron-interface/metron-alerts/src/app/service/global-config.service.ts ---
@@ -21,14 +21,15 @@ import { Injectable } from '@angular/core';
import { HttpClient } from '@angular/common/http';
import { Observable } from 'rxjs';
import {HttpUtil} from '../utils/httpUtil';
+import {AppConfigService} from "./app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288308
--- Diff: metron-interface/metron-alerts/src/app/service/search.service.ts ---
@@ -30,6 +30,7 @@ import { RestError } from '../model/rest-error';
import {INDEXES} from '../utils/constants';
import {ColumnMetadata} from '../model/column-metadata';
import {QueryBuilder} from '../alerts/alerts-list/query-builder';
+import {AppConfigService} from "./app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288056
--- Diff: metron-interface/metron-alerts/src/app/pcap/service/pcap.service.spec.ts ---
@@ -33,6 +33,7 @@ import { PcapStatusResponse } from '../model/pcap-status-response';
import { PcapRequest } from '../model/pcap.request';
import { fakePdml, fakePacket } from '../model/pdml.mock';
import { fakePcapStatusResponse, fakePcapRequest } from '../model/pcap.mock';
+import {AppConfigService} from "../../service/app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234289363
--- Diff: metron-interface/metron-alerts/src/app/pcap/service/pcap.service.ts ---
@@ -47,47 +48,47 @@ export class PcapService {
public submitRequest(
pcapRequest: PcapRequest
): Observable<PcapStatusResponse> {
- return this.http.post('/api/v1/pcap/fixed', pcapRequest).pipe(
+ return this.http.post(this.appConfigService.getApiRoot() + '/pcap/fixed', pcapRequest).pipe(
map(HttpUtil.extractData),
catchError(HttpUtil.handleError)
);
}
public getStatus(id: string): Observable<PcapStatusResponse> {
- return this.http.get(`/api/v1/pcap/${id}`).pipe(
+ return this.http.get(this.appConfigService.getApiRoot() + `/pcap/${id}`).pipe(
map(HttpUtil.extractData),
catchError(HttpUtil.handleError)
);
}
public getRunningJob(): Observable<PcapStatusResponse[]> {
- return this.http.get(`/api/v1/pcap?state=RUNNING`).pipe(
+ return this.http.get(this.appConfigService.getApiRoot() + `/pcap?state=RUNNING`).pipe(
--- End diff --
I think since you're not using multi-line strings and string interpolation features here, it's better to use single quotes rather than a template literal.
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288280
--- Diff: metron-interface/metron-alerts/src/app/service/meta-alert.service.ts ---
@@ -26,14 +26,15 @@ import {Alert} from '../model/alert';
import { HttpClient } from '@angular/common/http';
import {MetaAlertCreateRequest} from '../model/meta-alert-create-request';
import {MetaAlertAddRemoveRequest} from '../model/meta-alert-add-remove-request';
+import {AppConfigService} from "./app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234287914
--- Diff: metron-interface/metron-alerts/src/app/app.module.ts ---
@@ -48,13 +48,11 @@ import { GlobalConfigService } from './service/global-config.service';
import { DefaultHeadersInterceptor } from './http-interceptors/default-headers.interceptor';
import { DialogService } from './service/dialog.service';
import { MetronDialogComponent } from './shared/metron-dialog/metron-dialog.component';
-
-
-
import {PcapModule} from './pcap/pcap.module';
+import {AppConfigService} from "./service/app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288118
--- Diff: metron-interface/metron-alerts/src/app/service/alerts.service.ts ---
@@ -22,14 +22,15 @@ import {Alert} from '../model/alert';
import { HttpClient } from '@angular/common/http';
import {HttpUtil} from '../utils/httpUtil';
import { RestError } from '../model/rest-error';
+import {AppConfigService} from "./app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/metron/pull/1266
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234287609
--- Diff: metron-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";
--- End diff --
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.
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288083
--- Diff: metron-interface/metron-alerts/src/app/pcap/service/pcap.service.ts ---
@@ -25,6 +25,7 @@ import { HttpUtil } from '../../utils/httpUtil';
import { PcapRequest } from '../model/pcap.request';
import { Pdml } from '../model/pdml';
import { PcapStatusResponse } from '../model/pcap-status-response';
+import {AppConfigService} from "../../service/app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288029
--- Diff: metron-interface/metron-alerts/src/app/pcap/pcap-panel/pcap-panel.component.spec.ts ---
@@ -28,6 +28,7 @@ import { PcapRequest } from '../model/pcap.request';
import { of, defer } from 'rxjs';
import { RestError } from '../../model/rest-error';
import { ConfirmationPopoverModule } from 'angular-confirmation-popover';
+import {AppConfigService} from "../../service/app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234287807
--- Diff: 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";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron issue #1266: METRON-1875: Expose configurable global settings in the ...
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on the issue:
https://github.com/apache/metron/pull/1266
I addressed the style issues and added a comment about APP_INITIALIZER and promises. Let me know what you think.
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288335
--- Diff: metron-interface/metron-alerts/src/app/service/update.service.ts ---
@@ -28,6 +28,7 @@ import {Utils} from '../utils/utils';
import {Patch} from '../model/patch';
import { GlobalConfigService } from './global-config.service';
import {CommentAddRemoveRequest} from "../model/comment-add-remove-request";
+import {AppConfigService} from "./app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234296496
--- Diff: metron-interface/metron-alerts/src/app/service/app-config.service.ts ---
@@ -0,0 +1,40 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Injectable } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+
+@Injectable()
+export class AppConfigService {
+
+ private appConfig;
+
+ constructor(private http: HttpClient) { }
+
+ loadAppConfig() {
--- End diff --
The linked article explains it perfectly. Disregard my suggestion since we need to be using a promise here.
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234283406
--- Diff: metron-interface/metron-alerts/src/app/service/app-config.service.ts ---
@@ -0,0 +1,40 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Injectable } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+
+@Injectable()
+export class AppConfigService {
+
+ private appConfig;
+
+ constructor(private http: HttpClient) { }
+
+ loadAppConfig() {
--- End diff --
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](https://www.learnrxjs.io/operators/filtering/take.html). For example:
```
loadAppConfig() {
return this.http.get('assets/app-config.json').pipe(
take(1)
).subscribe(data => {
this.appConfig = data;
});
}
```
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234288184
--- Diff: metron-interface/metron-alerts/src/app/service/authentication.service.ts ---
@@ -22,26 +22,28 @@ import {Router} from '@angular/router';
import { ReplaySubject } from 'rxjs';
import { GlobalConfigService } from './global-config.service';
import { DataSource } from './data-source';
+import {AppConfigService} from "./app-config.service";
--- End diff --
Could you use single quotes and add spacing inside the brackets here?
---
[GitHub] metron issue #1266: METRON-1875: Expose configurable global settings in the ...
Posted by sardell <gi...@git.apache.org>.
Github user sardell commented on the issue:
https://github.com/apache/metron/pull/1266
After addressing my concerns listed, I think this looks great! It's nice to have this architecture in place to make a change like this at runtime vs. compile time. I can see us taking advantage of this in the future for other use cases. +1 tested on full dev per the instructions provided.
---
[GitHub] metron pull request #1266: METRON-1875: Expose configurable global settings ...
Posted by merrimanr <gi...@git.apache.org>.
Github user merrimanr commented on a diff in the pull request:
https://github.com/apache/metron/pull/1266#discussion_r234293206
--- Diff: metron-interface/metron-alerts/src/app/service/app-config.service.ts ---
@@ -0,0 +1,40 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Injectable } from '@angular/core';
+import { HttpClient } from '@angular/common/http';
+
+@Injectable()
+export class AppConfigService {
+
+ private appConfig;
+
+ constructor(private http: HttpClient) { }
+
+ loadAppConfig() {
--- End diff --
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.
---