[CORD-1043] Registering reducers on the graph
Change-Id: I5804025f25733b5b5da1fd95725db3467a65abef
diff --git a/src/app/service-graph/services/README.md b/src/app/service-graph/services/README.md
new file mode 100644
index 0000000..7058021
--- /dev/null
+++ b/src/app/service-graph/services/README.md
@@ -0,0 +1,37 @@
+# Service Graph extender example
+
+```
+XosServiceGraphExtender.register('coarse', 'test', (graph: IXosServiceGraph) => {
+ graph.nodes = graph.nodes.map(n => {
+ // do my changes
+ n.label = `reduced_${n.label}`;
+ return n;
+ });
+
+ graph.links = graph.links.map(l => {
+ // do my changes
+ return l;
+ });
+ return graph;
+});
+```
+
+Note that if you add classes you'll need to provide CSS for that
+
+## What can you change:
+
+### Nodes:
+
+You can change any of the property that are present in the `node` element, plus:
+
+property | type | effect
+-------- | ---- | -----:
+d3Class | space separated string |the class names get prefixed with `ext-`
+x | number | horizontal position
+y | number | vertical position
+
+### Links:
+
+property | type | effect
+-------- | ---- | -----:
+d3Class | space separated string |the class names get prefixed with `ext-`
diff --git a/src/app/service-graph/services/d3-helpers/graph.helpers.ts b/src/app/service-graph/services/d3-helpers/graph.helpers.ts
new file mode 100644
index 0000000..4bf4cb8
--- /dev/null
+++ b/src/app/service-graph/services/d3-helpers/graph.helpers.ts
@@ -0,0 +1,25 @@
+import * as d3 from 'd3';
+
+export interface Id3BBox {
+ x: number;
+ y: number;
+ width: number;
+ height: number;
+}
+
+export interface IXosGraphHelpers {
+ parseElemClasses (classes: string): string;
+ getSiblingTextBBox(contex: any /* D3 this */): Id3BBox;
+}
+
+export class XosGraphHelpers implements IXosGraphHelpers {
+ public parseElemClasses (classes: string): string {
+ return classes ? classes.split(' ')
+ .map(c => `ext-${c}`)
+ .join(' ') : '';
+ }
+
+ public getSiblingTextBBox(contex: any): Id3BBox {
+ return d3.select(contex.parentNode).select('text').node().getBBox();
+ }
+}
diff --git a/src/app/service-graph/services/graph.extender.spec.ts b/src/app/service-graph/services/graph.extender.spec.ts
new file mode 100644
index 0000000..28ab96e
--- /dev/null
+++ b/src/app/service-graph/services/graph.extender.spec.ts
@@ -0,0 +1,47 @@
+import * as angular from 'angular';
+import 'angular-mocks';
+import 'angular-ui-router';
+import {IXosServiceGraphExtender, XosServiceGraphExtender} from './graph.extender';
+
+let service: IXosServiceGraphExtender, registerSpy;
+
+const reducer = (graph) => {
+ return graph;
+};
+
+describe('The XosServiceGraphExtender service', () => {
+
+ beforeEach(() => {
+ angular.module('xosServiceGraphExtender', [])
+ .service('XosServiceGraphExtender', XosServiceGraphExtender);
+
+ angular.mock.module('xosServiceGraphExtender');
+ });
+
+ beforeEach(angular.mock.inject((
+ XosServiceGraphExtender: IXosServiceGraphExtender,
+ ) => {
+ service = XosServiceGraphExtender;
+
+ registerSpy = spyOn(service, 'register').and.callThrough();
+ }));
+
+ it('should register a reducer for the coarse service graph', () => {
+ service.register('coarse', 'testCoarse', reducer);
+ expect(registerSpy).toHaveBeenCalled();
+ const coarseReducers = service.getCoarse();
+ expect(coarseReducers).toHaveLength(1);
+ expect(coarseReducers[0].name).toEqual('testCoarse');
+ expect(typeof coarseReducers[0].reducer).toEqual('function');
+ });
+
+ it('should register a reducer for the fine-grained service graph', () => {
+ service.register('finegrained', 'testFinegrained', reducer);
+ expect(registerSpy).toHaveBeenCalled();
+ const coarseReducers = service.getFinegrained();
+ expect(coarseReducers).toHaveLength(1);
+ expect(coarseReducers[0].name).toEqual('testFinegrained');
+ expect(typeof coarseReducers[0].reducer).toEqual('function');
+ });
+
+});
diff --git a/src/app/service-graph/services/graph.extender.ts b/src/app/service-graph/services/graph.extender.ts
new file mode 100644
index 0000000..ba9218f
--- /dev/null
+++ b/src/app/service-graph/services/graph.extender.ts
@@ -0,0 +1,57 @@
+import {IXosServiceGraph} from '../interfaces';
+
+export interface IXosServiceGraphReducers {
+ coarse: IXosServiceGraphReducer[];
+ finegrained: IXosServiceGraphReducer[];
+}
+
+export interface IXosServiceGraphReducer {
+ name: string;
+ reducer: IXosServiceGraphReducerFn;
+}
+
+export interface IXosServiceGraphReducerFn {
+ (graph: IXosServiceGraph): IXosServiceGraph;
+}
+
+export interface IXosServiceGraphExtender {
+ register(type: 'coarse' | 'finegrained', name: string, reducer: IXosServiceGraphReducerFn): boolean;
+ getCoarse(): IXosServiceGraphReducer[];
+ getFinegrained(): IXosServiceGraphReducer[];
+}
+
+export class XosServiceGraphExtender implements IXosServiceGraphExtender {
+
+ static $inject = ['$log'];
+
+ private reducers: IXosServiceGraphReducers = {
+ coarse: [],
+ finegrained: []
+ };
+
+ constructor (
+ private $log: ng.ILogService
+ ) {
+ }
+
+ public getCoarse(): IXosServiceGraphReducer[] {
+ return this.reducers.coarse;
+ }
+
+ public getFinegrained(): IXosServiceGraphReducer[] {
+ return this.reducers.finegrained;
+ }
+
+ // NOTE
+ // as now extender support:
+ // - nodes property: x, y, d3Class (applied to the group element)
+ // - links propery: d3Class (applied to the line element, there's no group for now)
+ public register(type: 'coarse' | 'finegrained', name: string, reducer: IXosServiceGraphReducerFn): boolean {
+ this.$log.debug(`[XosServiceGraphExtender] Registering ${name} reducer in ${type} list`);
+ this.reducers[type].push({
+ name,
+ reducer
+ });
+ return false;
+ }
+}
diff --git a/src/app/service-graph/services/graph.store.spec.ts b/src/app/service-graph/services/graph.store.spec.ts
new file mode 100644
index 0000000..9073d58
--- /dev/null
+++ b/src/app/service-graph/services/graph.store.spec.ts
@@ -0,0 +1,138 @@
+import * as angular from 'angular';
+import 'angular-mocks';
+import 'angular-ui-router';
+import {IXosServiceGraphStore, XosServiceGraphStore} from './graph.store';
+import {Subject} from 'rxjs';
+import {XosDebouncer} from '../../core/services/helpers/debounce.helper';
+import {IXosServiceGraph} from '../interfaces';
+import {XosServiceGraphExtender, IXosServiceGraphExtender} from './graph.extender';
+
+let service: IXosServiceGraphStore, extender: IXosServiceGraphExtender;
+
+const subjects = {
+ service: new Subject<any>(),
+ tenant: new Subject<any>(),
+ subscriber: new Subject<any>(),
+ network: new Subject<any>(),
+};
+
+// COARSE data
+const coarseServices = [
+ {
+ id: 1,
+ name: 'Service A',
+ class_names: 'Service,PlCoreBase'
+ },
+ {
+ id: 2,
+ name: 'Service B',
+ class_names: 'Service,PlCoreBase'
+ }
+];
+
+const coarseTenants = [
+ {
+ id: 1,
+ provider_service_id: 2,
+ subscriber_service_id: 1,
+ kind: 'coarse',
+ class_names: 'Tenant,PlCoreBase'
+ }
+];
+
+const mockModelStore = {
+ query: (modelName: string) => {
+ return subjects[modelName.toLowerCase()].asObservable();
+ }
+};
+
+describe('The XosServiceGraphStore service', () => {
+
+ beforeEach(() => {
+ angular.module('xosServiceGraphStore', [])
+ .service('XosServiceGraphStore', XosServiceGraphStore)
+ .value('XosModelStore', mockModelStore)
+ .service('XosServiceGraphExtender', XosServiceGraphExtender)
+ .service('XosDebouncer', XosDebouncer);
+
+ angular.mock.module('xosServiceGraphStore');
+ });
+
+ beforeEach(angular.mock.inject((
+ XosServiceGraphStore: IXosServiceGraphStore,
+ XosServiceGraphExtender: IXosServiceGraphExtender
+ ) => {
+ service = XosServiceGraphStore;
+ extender = XosServiceGraphExtender;
+ }));
+
+ describe('when subscribing for the COARSE service graph', () => {
+ beforeEach((done) => {
+ subjects.service.next(coarseServices);
+ subjects.tenant.next(coarseTenants);
+ setTimeout(done, 500);
+ });
+
+ it('should return an observer for the Coarse Service Graph', (done) => {
+ service.getCoarse()
+ .subscribe(
+ (res: IXosServiceGraph) => {
+ expect(res.nodes.length).toBe(2);
+ expect(res.nodes[0].d3Class).toBeUndefined();
+ expect(res.links.length).toBe(1);
+ expect(res.links[0].d3Class).toBeUndefined();
+ done();
+ },
+ (err) => {
+ done(err);
+ }
+ );
+ });
+
+ describe('when a reducer is register', () => {
+
+ beforeEach((done) => {
+ extender.register('coarse', 'test', (graph: IXosServiceGraph) => {
+ graph.nodes = graph.nodes.map(n => {
+ n.d3Class = `testNode`;
+ return n;
+ });
+
+ graph.links = graph.links.map(n => {
+ n.d3Class = `testLink`;
+ return n;
+ });
+
+ return graph;
+ });
+
+ // triggering another next cycle to apply the reducer
+ subjects.service.next(coarseServices);
+ subjects.tenant.next(coarseTenants);
+ setTimeout(done, 500);
+ });
+
+ it('should transform the result', (done) => {
+ service.getCoarse()
+ .subscribe(
+ (res: IXosServiceGraph) => {
+ expect(res.nodes.length).toBe(2);
+ expect(res.nodes[0].d3Class).toEqual('testNode');
+ expect(res.links.length).toBe(1);
+ expect(res.links[0].d3Class).toEqual('testLink');
+ done();
+ },
+ (err) => {
+ done(err);
+ }
+ );
+ });
+ });
+ });
+
+ describe('when subscribing for the Fine-grained service graph', () => {
+ xit('should have a test', () => {
+ expect(true).toBeTruthy();
+ });
+ });
+});
diff --git a/src/app/service-graph/services/graph.store.ts b/src/app/service-graph/services/graph.store.ts
index 1bb5d4c..54bc083 100644
--- a/src/app/service-graph/services/graph.store.ts
+++ b/src/app/service-graph/services/graph.store.ts
@@ -6,6 +6,7 @@
IXosServiceGraphNode, IXosServiceGraphLink, IXosFineGrainedGraphData
} from '../interfaces';
import {IXosDebouncer} from '../../core/services/helpers/debounce.helper';
+import {IXosServiceGraphExtender, IXosServiceGraphReducer} from './graph.extender';
export interface IXosServiceGraphStore {
get(): Observable<IXosServiceGraph>;
getCoarse(): Observable<IXosServiceGraph>;
@@ -15,7 +16,8 @@
static $inject = [
'$log',
'XosModelStore',
- 'XosDebouncer'
+ 'XosDebouncer',
+ 'XosServiceGraphExtender'
];
// graph data store
@@ -48,7 +50,8 @@
constructor (
private $log: ng.ILogService,
private XosModelStore: IXosModelStoreService,
- private XosDebouncer: IXosDebouncer
+ private XosDebouncer: IXosDebouncer,
+ private XosServiceGraphExtender: IXosServiceGraphExtender
) {
this.$log.info(`[XosServiceGraphStore] Setup`);
@@ -199,92 +202,112 @@
private graphDataToCoarseGraph(data: IXosCoarseGraphData) {
- const links: IXosServiceGraphLink[] = _.chain(data.tenants)
- .filter((t: IXosTenantModel) => t.kind === 'coarse')
- .map((t: IXosTenantModel) => {
+ try {
+ const links: IXosServiceGraphLink[] = _.chain(data.tenants)
+ .filter((t: IXosTenantModel) => t.kind === 'coarse')
+ .map((t: IXosTenantModel) => {
+ return {
+ id: t.id,
+ source: this.getNodeIndexById(t.provider_service_id, data.services),
+ target: this.getNodeIndexById(t.subscriber_service_id, data.services),
+ model: t
+ };
+ })
+ .value();
+
+ const nodes: IXosServiceGraphNode[] = _.map(data.services, (s: IXosServiceModel) => {
return {
- id: t.id,
- source: this.getNodeIndexById(t.provider_service_id, data.services),
- target: this.getNodeIndexById(t.subscriber_service_id, data.services),
- model: t
+ id: s.id,
+ label: s.name,
+ model: s
};
- })
- .value();
+ });
- const nodes: IXosServiceGraphNode[] = _.map(data.services, (s: IXosServiceModel) => {
- return {
- id: s.id,
- label: s.name,
- model: s
+ let graph: IXosServiceGraph = {
+ nodes,
+ links
};
- });
- this.d3CoarseGraph.next({
- nodes: nodes,
- links: links
- });
+ _.forEach(this.XosServiceGraphExtender.getCoarse(), (r: IXosServiceGraphReducer) => {
+ graph = r.reducer(graph);
+ });
+
+ this.d3CoarseGraph.next(graph);
+ } catch (e) {
+ this.d3CoarseGraph.error(e);
+ }
}
private graphDataToFineGrainedGraph(data: IXosFineGrainedGraphData) {
- data = this.removeUnwantedFineGrainedData(data);
+ try {
+ data = this.removeUnwantedFineGrainedData(data);
- let nodes = _.reduce(Object.keys(data), (list: any[], k: string) => {
- return list.concat(data[k]);
- }, []);
+ let nodes = _.reduce(Object.keys(data), (list: any[], k: string) => {
+ return list.concat(data[k]);
+ }, []);
- nodes = _.chain(nodes)
- .map(n => {
- n.d3Id = this.d3Id(this.getNodeType(n), n.id);
- return n;
- })
- .map(n => {
- let node: IXosServiceGraphNode = {
- id: n.d3Id,
- label: this.getNodeLabel(n),
- model: n,
- type: this.getNodeType(n)
+ nodes = _.chain(nodes)
+ .map(n => {
+ n.d3Id = this.d3Id(this.getNodeType(n), n.id);
+ return n;
+ })
+ .map(n => {
+ let node: IXosServiceGraphNode = {
+ id: n.d3Id,
+ label: this.getNodeLabel(n),
+ model: n,
+ type: this.getNodeType(n)
+ };
+ return node;
+ })
+ .value();
+
+ const links = _.reduce(data.tenants, (links: IXosServiceGraphLink[], tenant: IXosTenantModel) => {
+ const sourceId = this.getSourceId(tenant);
+ const targetId = this.getTargetId(tenant);
+
+ if (!angular.isDefined(targetId)) {
+ // if the tenant is not pointing to anything, don't draw links
+ return links;
+ }
+
+ const tenantToProvider = {
+ id: `${sourceId}_${tenant.d3Id}`,
+ source: this.getNodeIndexById(sourceId, nodes),
+ target: this.getNodeIndexById(tenant.d3Id, nodes),
+ model: tenant
};
- return node;
- })
- .value();
- const links = _.reduce(data.tenants, (links: IXosServiceGraphLink[], tenant: IXosTenantModel) => {
- const sourceId = this.getSourceId(tenant);
- const targetId = this.getTargetId(tenant);
+ const tenantToSubscriber = {
+ id: `${tenant.d3Id}_${targetId}`,
+ source: this.getNodeIndexById(tenant.d3Id, nodes),
+ target: this.getNodeIndexById(targetId, nodes),
+ model: tenant
+ };
- if (!angular.isDefined(targetId)) {
- // if the tenant is not pointing to anything, don't draw links
+ links.push(tenantToProvider);
+ links.push(tenantToSubscriber);
return links;
+ }, []);
+
+ if (nodes.length === 0 || links.length === 0) {
+ return;
}
- const tenantToProvider = {
- id: `${sourceId}_${tenant.d3Id}`,
- source: this.getNodeIndexById(sourceId, nodes),
- target: this.getNodeIndexById(tenant.d3Id, nodes),
- model: tenant
+ let graph: IXosServiceGraph = {
+ nodes,
+ links
};
- const tenantToSubscriber = {
- id: `${tenant.d3Id}_${targetId}`,
- source: this.getNodeIndexById(tenant.d3Id, nodes),
- target: this.getNodeIndexById(targetId, nodes),
- model: tenant
- };
+ _.forEach(this.XosServiceGraphExtender.getFinegrained(), (r: IXosServiceGraphReducer) => {
+ graph = r.reducer(graph);
+ });
- links.push(tenantToProvider);
- links.push(tenantToSubscriber);
- return links;
- }, []);
-
- if (nodes.length === 0 || links.length === 0) {
- return;
+ this.d3FineGrainedGraph.next(graph);
+ } catch (e) {
+ this.d3FineGrainedGraph.error(e);
}
-
- this.d3FineGrainedGraph.next({
- nodes: nodes,
- links: links
- });
}
}