Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Store measurement values for each scale that a metric supports so tha… #642

Merged
merged 2 commits into from
Oct 2, 2019
Merged

Store measurement values for each scale that a metric supports so tha… #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0b31ed
Store measurement values for each scale that a metric supports so tha…
fniessink Oct 2, 2019
6150591
Fix unit tests.
fniessink Oct 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions components/frontend/src/metric/Measurement.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@ import { Tag } from '../widgets/Tag';
import { TableRowWithDetails } from '../widgets/TableRowWithDetails';

export function Measurement(props) {
const metric = props.report.subjects[props.subject_uuid].metrics[props.metric_uuid];
const metric_type = props.datamodel.metrics[metric.type];
const metric_scale = metric.scale || metric_type.default_scale || "count";
var latest_measurement, start, end, value, status, sources, measurement_timestring;
if (props.measurements.length === 0) {
latest_measurement = null;
value = null;
value = "?";
status = null;
sources = [];
start = new Date();
Expand All @@ -20,8 +23,8 @@ export function Measurement(props) {
} else {
latest_measurement = props.measurements[props.measurements.length - 1];
sources = latest_measurement.sources;
value = latest_measurement.value;
status = latest_measurement.status;
value = latest_measurement[metric_scale].value || "?";
status = latest_measurement[metric_scale].status || null;
start = new Date(latest_measurement.start);
end = new Date(latest_measurement.end);
measurement_timestring = latest_measurement.end;
Expand All @@ -30,15 +33,12 @@ export function Measurement(props) {
target_met: 'check', near_target_met: 'warning', debt_target_met: 'money',
target_not_met: 'x', null: 'question'
}[status];
const metric = props.report.subjects[props.subject_uuid].metrics[props.metric_uuid];
const metric_type = props.datamodel.metrics[metric.type];
const target = metric.accept_debt ? metric.debt_target : metric.target;
const metric_direction = {"<": "≦", ">": "≧"}[metric.direction || metric_type.direction];
const positive = status === "target_met";
const active = status === "debt_target_met";
const negative = status === "target_not_met";
const warning = status === "near_target_met";
const metric_scale = metric.scale || metric_type.default_scale || "count";
const metric_unit_prefix = metric_scale === "percentage" ? "% " : " ";
const metric_unit = `${metric_unit_prefix}${metric.unit || metric_type.unit}`;
const metric_name = metric.name || metric_type.name;
Expand All @@ -57,6 +57,7 @@ export function Measurement(props) {
readOnly={props.readOnly}
reload={props.reload}
report={props.report}
scale={metric_scale}
stop_sort={props.stop_sort}
subject_uuid={props.subject_uuid}
unit={metric_unit}
Expand All @@ -67,14 +68,14 @@ export function Measurement(props) {
{metric_name}
</Table.Cell>
<Table.Cell>
<TrendSparkline measurements={props.measurements.filter((measurement) => measurement.end >= week_ago_string)} />
<TrendSparkline measurements={props.measurements.filter((measurement) => measurement.end >= week_ago_string)} scale={metric_scale} />
</Table.Cell>
<Table.Cell>
<Icon size='large' name={status_icon} />
</Table.Cell>
<Table.Cell>
<Popup
trigger={<span>{(value === null ? '?' : value) + metric_unit}</span>}
trigger={<span>{value + metric_unit}</span>}
flowing hoverable>
Measured <TimeAgo date={measurement_timestring} /> ({start.toLocaleString()} - {end.toLocaleString()})
</Popup>
Expand Down
2 changes: 1 addition & 1 deletion components/frontend/src/metric/MeasurementDetails.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export function MeasurementDetails(props) {
{
menuItem: <Menu.Item key='trend'><FocusableTab>{'Trend'}</FocusableTab></Menu.Item>,
render: () => <Tab.Pane>
<TrendGraph measurements={props.measurements} unit={unit_name} title={props.metric_name} />
<TrendGraph measurements={props.measurements} unit={unit_name} scale={props.scale} title={props.metric_name} />
</Tab.Pane>
}
);
Expand Down
9 changes: 5 additions & 4 deletions components/frontend/src/metric/TrendGraph.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ export function TrendGraph(props) {
let max_y = 10;
for (var i = 0; i < props.measurements.length; i++) {
const measurement = props.measurements[i];
const m = measurement.value !== null ? Number(measurement.value) : null;
if (m !== null && m > max_y) { max_y = m }
const value = measurement[props.scale].value || null;
const y = value !== null ? Number(value) : null;
if (y !== null && y > max_y) { max_y = y }
const x1 = new Date(measurement.start);
const x2 = new Date(measurement.end);
measurements.push({ y: m, x: x1 });
measurements.push({ y: m, x: x2 });
measurements.push({ y: y, x: x1 });
measurements.push({ y: y, x: x2 });
}
const axisStyle = { axisLabel: { padding: 30, fontSize: 11 }, tickLabels: { fontSize: 8 } };
return (
Expand Down
2 changes: 1 addition & 1 deletion components/frontend/src/metric/TrendGraph.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ it('renders without crashing', () => {

it('renders measurements without crashing', () => {
const div = document.createElement('div');
ReactDOM.render(<TrendGraph measurements={[{value: "1", start: "2019-09-29", end: "2019-09-30"}]} />, div);
ReactDOM.render(<TrendGraph measurements={[{count: {value: "1"}, start: "2019-09-29", end: "2019-09-30"}]} scale="count" />, div);
ReactDOM.unmountComponentAtNode(div);
});
7 changes: 4 additions & 3 deletions components/frontend/src/metric/TrendSparkline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ export function TrendSparkline(props) {
let measurements = [];
for (var i = 0; i < props.measurements.length; i++) {
const measurement = props.measurements[i];
const m = measurement.value !== null ? Number(measurement.value) : null;
const value = measurement[props.scale].value || null;
const y = value !== null ? Number(value) : null;
const x1 = new Date(measurement.start);
const x2 = new Date(measurement.end);
measurements.push({y: m, x: x1});
measurements.push({y: m, x: x2});
measurements.push({y: y, x: x1});
measurements.push({y: y, x: x2});
}
return (
<VictoryGroup theme={VictoryTheme.material} scale={{ x: "time", y: "linear" }} height={60} padding={0}>
Expand Down
2 changes: 1 addition & 1 deletion components/frontend/src/metric/TrendSparkline.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ it('renders without crashing', () => {

it('renders measurements without crashing', () => {
const div = document.createElement('div');
ReactDOM.render(<TrendSparkline measurements={[{value: "1", start: "2019-09-29", end: "2019-09-30"}]} />, div);
ReactDOM.render(<TrendSparkline measurements={[{count: {value: "1"}, start: "2019-09-29", end: "2019-09-30"}]} scale="count" />, div);
ReactDOM.unmountComponentAtNode(div);
});
7 changes: 4 additions & 3 deletions components/server/src/database/measurements.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,11 @@ def insert_new_measurement(database: Database, measurement, metric=None):
database, measurement["report_uuid"], measurement["metric_uuid"]) if metric is None else metric
datamodel = latest_datamodel(database)
metric_type = datamodel["metrics"][metric["type"]]
scale = metric.get("scale") or metric_type["default_scale"]
direction = metric.get("direction") or metric_type["direction"]
measurement["value"] = calculate_measurement_value(measurement["sources"], metric["addition"], scale, direction)
measurement["status"] = determine_measurement_status(database, metric, measurement["value"])
for scale in metric_type["scales"]:
value = calculate_measurement_value(measurement["sources"], metric["addition"], scale, direction)
status = determine_measurement_status(database, metric, value)
measurement[scale] = dict(value=value, status=status)
measurement["start"] = measurement["end"] = iso_timestamp()
# Mark this measurement as the most recent one:
measurement["last"] = True
Expand Down
25 changes: 13 additions & 12 deletions components/server/src/database/reports.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
from pymongo.database import Database

from utilities.functions import iso_timestamp
from utilities.type import Summary
from .datamodels import latest_datamodel


def latest_reports(database: Database, max_iso_timestamp: str = ""):
Expand Down Expand Up @@ -39,21 +39,22 @@ def summarize_report(database: Database, report) -> None:
from .measurements import last_measurements # pylint:disable=cyclic-import
status_color_mapping = dict(
target_met="green", debt_target_met="grey", near_target_met="yellow", target_not_met="red")
summary = dict(red=0, green=0, yellow=0, grey=0, white=0)
summary_by_subject: Dict[str, Summary] = dict()
summary_by_tag: Dict[str, Summary] = dict()
report["summary"] = dict(red=0, green=0, yellow=0, grey=0, white=0)
report["summary_by_subject"] = dict()
report["summary_by_tag"] = dict()
last_measurements_by_metric_uuid = {m["metric_uuid"]: m for m in last_measurements(database, report["report_uuid"])}
datamodel = latest_datamodel(database)
for subject_uuid, subject in report.get("subjects", {}).items():
for metric_uuid, metric in subject.get("metrics", {}).items():
last_measurement = last_measurements_by_metric_uuid.get(metric_uuid)
color = status_color_mapping.get(last_measurement["status"], "white") if last_measurement else "white"
summary[color] += 1
summary_by_subject.setdefault(subject_uuid, dict(red=0, green=0, yellow=0, grey=0, white=0))[color] += 1
last_measurement = last_measurements_by_metric_uuid.get(metric_uuid, dict())
scale = metric.get("scale") or datamodel["metrics"][metric["type"]].get("default_scale", "count")
status = last_measurement.get(scale, {}).get("status", last_measurement.get("status", None))
color = status_color_mapping.get(status, "white")
report["summary"][color] += 1
report["summary_by_subject"].setdefault(
subject_uuid, dict(red=0, green=0, yellow=0, grey=0, white=0))[color] += 1
for tag in metric["tags"]:
summary_by_tag.setdefault(tag, dict(red=0, green=0, yellow=0, grey=0, white=0))[color] += 1
report["summary"] = summary
report["summary_by_subject"] = summary_by_subject
report["summary_by_tag"] = summary_by_tag
report["summary_by_tag"].setdefault(tag, dict(red=0, green=0, yellow=0, grey=0, white=0))[color] += 1


def latest_report(database: Database, report_uuid: str):
Expand Down
3 changes: 1 addition & 2 deletions components/server/src/routes/report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,7 @@ def post_metric_attribute(report_uuid: str, metric_uuid: str, metric_attribute:
description=f"{sessions.user(database)} changed the {metric_attribute} of metric '{data.metric_name}' of "
f"subject '{data.subject_name}' in report '{data.report_name}' from '{old_value}' to '{value}'.")
insert_new_report(database, data.report)
if metric_attribute in (
"accept_debt", "debt_target", "debt_end_date", "direction", "near_target", "scale", "target"):
if metric_attribute in ("accept_debt", "debt_target", "debt_end_date", "direction", "near_target", "target"):
latest = latest_measurement(database, metric_uuid)
if latest:
return insert_new_measurement(database, latest, data.metric)
Expand Down
5 changes: 0 additions & 5 deletions components/server/src/utilities/type.py
View file
Open in desktop

This file was deleted.

18 changes: 10 additions & 8 deletions components/server/tests/unittests/routes/test_measurement.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ def setUp(self):
sources=dict(source_uuid=dict()))))))
self.database.reports.find_one.return_value = report
self.database.reports.distinct.return_value = ["report_uuid"]
self.database.datamodels.find_one.return_value = dict(_id="", metrics=dict(metric_type=dict(direction="<")))
self.database.datamodels.find_one.return_value = dict(
_id="", metrics=dict(metric_type=dict(direction="<", scales=["count"])))

def set_measurement_id(measurement):
measurement["_id"] = "measurement_id"
Expand All @@ -48,8 +49,8 @@ def test_first_measurement(self, request):
self.database.measurements.find_one.return_value = None
request.json = dict(report_uuid="report_uuid", metric_uuid="metric_uuid", sources=[])
new_measurement = dict(
_id="measurement_id", report_uuid="report_uuid", metric_uuid="metric_uuid", sources=[], value=None,
status=None, start="2019-01-01", end="2019-01-01", last=True)
_id="measurement_id", report_uuid="report_uuid", metric_uuid="metric_uuid", sources=[],
count=dict(value=None, status=None), start="2019-01-01", end="2019-01-01", last=True)
self.assertEqual(new_measurement, post_measurement(self.database))
self.database.measurements.insert_one.assert_called_once()

Expand All @@ -67,8 +68,8 @@ def test_changed_measurement_value(self, request):
sources = [dict(value="1", total=None, parse_error=None, connection_error=None, entities=[])]
request.json = dict(report_uuid="report_uuid", metric_uuid="metric_uuid", sources=sources)
new_measurement = dict(
_id="measurement_id", report_uuid="report_uuid", metric_uuid="metric_uuid", status="near_target_met",
start="2019-01-01", end="2019-01-01", value="1", last=True, sources=sources)
_id="measurement_id", report_uuid="report_uuid", metric_uuid="metric_uuid", last=True,
count=dict(status="near_target_met", value="1"), start="2019-01-01", end="2019-01-01", sources=sources)
self.assertEqual(new_measurement, post_measurement(self.database))
self.database.measurements.insert_one.assert_called_once()

Expand All @@ -80,8 +81,8 @@ def test_changed_measurement_entities(self, request):
sources = [dict(value="1", total=None, parse_error=None, connection_error=None, entities=[dict(key="b")])]
request.json = dict(report_uuid="report_uuid", metric_uuid="metric_uuid", sources=sources)
new_measurement = dict(
_id="measurement_id", report_uuid="report_uuid", metric_uuid="metric_uuid", status="near_target_met",
start="2019-01-01", end="2019-01-01", value="1", last=True, sources=sources)
_id="measurement_id", report_uuid="report_uuid", metric_uuid="metric_uuid", last=True,
count=dict(status="near_target_met", value="1"), start="2019-01-01", end="2019-01-01", sources=sources)
self.assertEqual(new_measurement, post_measurement(self.database))
self.database.measurements.insert_one.assert_called_once()

Expand Down Expand Up @@ -128,7 +129,8 @@ def insert_one(new_measurement):
type="metric_type", target="0", near_target="10", debt_target="0", accept_debt=False,
scale="count", addition="sum", direction="<", tags=[])))))
database.datamodels = Mock()
database.datamodels.find_one.return_value = dict(_id=123, metrics=dict(metric_type=dict(direction="<")))
database.datamodels.find_one.return_value = dict(
_id=123, metrics=dict(metric_type=dict(direction="<", scales=["count"])))
with patch("bottle.request", Mock(json=dict(attribute="value"))):
measurement = set_entity_attribute("metric_uuid", "source_uuid", "entity_key", "attribute", database)
entity = measurement["sources"][0]["entity_user_data"]["entity_key"]
Expand Down
28 changes: 16 additions & 12 deletions components/server/tests/unittests/routes/test_report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ def setUp(self):
self.database.datamodels.find_one.return_value = dict(
_id="id",
metrics=dict(
old_type=dict(name="Old type"),
old_type=dict(name="Old type", scales=["count"]),
new_type=dict(
default_scale="count", addition="sum", direction="<", target="0", near_target="1", tags=[],
sources=["source_type"])))
scales=["count"], default_scale="count", addition="sum", direction="<", target="0", near_target="1",
tags=[], sources=["source_type"])))

def test_post_metric_name(self, request):
"""Test that the metric name can be changed."""
Expand Down Expand Up @@ -125,8 +125,8 @@ def set_measurement_id(measurement):
request.json = dict(target="10")
self.assertEqual(
dict(
_id="measurement_id", end="2019-01-01", sources=[], start="2019-01-01", status=None, value=None,
metric_uuid="metric_uuid", last=True),
_id="measurement_id", end="2019-01-01", sources=[], start="2019-01-01",
count=dict(status=None, value=None), metric_uuid="metric_uuid", last=True),
post_metric_attribute("report_uuid", "metric_uuid", "target", self.database))
self.assertEqual(
dict(report_uuid="report_uuid", subject_uuid="subject_uuid", metric_uuid="metric_uuid",
Expand All @@ -146,8 +146,8 @@ def set_measurement_id(measurement):
request.json = dict(debt_end_date="2019-06-07")
self.assertEqual(
dict(
_id="measurement_id", end="2019-01-01", sources=[], start="2019-01-01", last=True, status=None,
metric_uuid="metric_uuid", value=None),
_id="measurement_id", end="2019-01-01", sources=[], start="2019-01-01", last=True,
metric_uuid="metric_uuid", count=dict(value=None, status=None)),
post_metric_attribute("report_uuid", "metric_uuid", "debt_end_date", self.database))
self.assertEqual(
dict(report_uuid="report_uuid", subject_uuid="subject_uuid", metric_uuid="metric_uuid",
Expand Down Expand Up @@ -413,14 +413,14 @@ def test_get_metrics(self):
"""Test that the metrics can be retrieved and deleted reports are skipped."""
report = dict(
_id="id", report_uuid="report_uuid",
subjects=dict(subject_uuid=dict(metrics=dict(metric_uuid=dict(tags=[])))))
subjects=dict(subject_uuid=dict(metrics=dict(metric_uuid=dict(type="metric_type", tags=[])))))
self.database.reports_overviews.find_one.return_value = dict(_id="id", title="Reports", subtitle="")
self.database.reports.distinct.return_value = ["report_uuid", "deleted_report"]
self.database.reports.find_one.side_effect = [report, dict(deleted=True)]
self.database.measurements.find.return_value = [dict(
_id="id", metric_uuid="metric_uuid", status="red",
sources=[dict(source_uuid="source_uuid", parse_error=None, connection_error=None, value="42")])]
self.assertEqual(dict(metric_uuid=dict(tags=[])), get_metrics(self.database))
self.assertEqual(dict(metric_uuid=dict(type="metric_type", tags=[])), get_metrics(self.database))

def test_delete_metric(self):
"""Test that the metric can be deleted."""
Expand Down Expand Up @@ -476,6 +476,8 @@ def test_add_report(self):

def test_get_report(self):
"""Test that a report can be retrieved."""
self.database.datamodels.find_one.return_value = dict(
_id="id", metrics=dict(metric_type=dict(default_scale="count")))
self.database.reports_overviews.find_one.return_value = dict(_id="id", title="Reports", subtitle="")
self.database.measurements.find.return_value = [
dict(
Expand Down Expand Up @@ -513,6 +515,8 @@ def test_post_reports_attribute(self, request):
def test_get_tag_report(self, request):
"""Test that a tag report can be retrieved."""
date_time = request.report_date = iso_timestamp()
self.database.datamodels.find_one.return_value = dict(
_id="id", metrics=dict(metric_type=dict(default_scale="count")))
self.database.reports.find_one.return_value = None
self.database.measurements.find.return_value = []
self.database.reports.distinct.return_value = ["report_uuid"]
Expand All @@ -522,14 +526,14 @@ def test_get_tag_report(self, request):
subject_without_metrics=dict(metrics=dict()),
subject_uuid=dict(
metrics=dict(
metric_with_tag=dict(tags=["tag"]),
metric_without_tag=dict(tags=["other tag"])))))
metric_with_tag=dict(type="metric_type", tags=["tag"]),
metric_without_tag=dict(type="metric_type", tags=["other tag"])))))
self.assertEqual(
dict(
summary=dict(red=0, green=0, yellow=0, grey=0, white=1),
summary_by_tag=dict(tag=dict(red=0, green=0, yellow=0, grey=0, white=1)),
summary_by_subject=dict(subject_uuid=dict(red=0, green=0, yellow=0, grey=0, white=1)),
title='Report for tag "tag"', subtitle="Note: tag reports are read-only", report_uuid="tag-tag",
timestamp=date_time, subjects=dict(
subject_uuid=dict(metrics=dict(metric_with_tag=dict(tags=["tag"]))))),
subject_uuid=dict(metrics=dict(metric_with_tag=dict(type="metric_type", tags=["tag"]))))),
get_tag_report("tag", self.database))
Loading