Skip to content

Commit

Permalink
Merge pull request #125 from Workiva/module-name-in-operation-name
Browse files Browse the repository at this point in the history 
AF-2560 module name in operation name
  • Loading branch information
@rmconsole4-wk
rmconsole4-wk authored Sep 24, 2018
2 parents 3875848 + 0ea0d7c commit 514c7a2
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 56 deletions.
4 changes: 1 addition & 3 deletions lib/src/lifecycle_module.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,8 @@ abstract class LifecycleModule extends SimpleModule with Disposable {
references.add(new Reference.followsFrom(_parentContext));
}

return tracer.startSpan('LifecycleModule.$operationName',
references: references)
return tracer.startSpan('$name.$operationName', references: references)
..addTags({
'module.name': name,
'module.instanceId': _instanceId,
});
}
Expand Down
92 changes: 39 additions & 53 deletions test/lifecycle_module_test.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class TestLifecycleModule extends LifecycleModule {
List<String> eventList;
bool mockShouldUnload;

TestLifecycleModule({String name: 'TestLifecycleModule'}) : name = name {
TestLifecycleModule({this.name: 'TestLifecycleModule'}) {
// init test validation data
eventList = [];
mockShouldUnload = true;
Expand Down Expand Up @@ -149,7 +149,7 @@ class TestLifecycleModule extends LifecycleModule {
throw onLoadError;
}
if (activeSpan != null) {
expect(activeSpan.operationName, 'LifecycleModule.load');
expect(activeSpan.operationName, '$name.load');
activeSpan.setTag('custom.load.tag', 'somevalue');
}
eventList.add('onLoad');
Expand All @@ -174,7 +174,7 @@ class TestLifecycleModule extends LifecycleModule {
throw onUnloadError;
}
if (activeSpan != null) {
expect(activeSpan.operationName, 'LifecycleModule.unload');
expect(activeSpan.operationName, '$name.unload');
activeSpan.setTag('custom.unload.tag', 'somevalue');
}
eventList.add('onUnload');
Expand All @@ -188,7 +188,7 @@ class TestLifecycleModule extends LifecycleModule {
throw onSuspendError;
}
if (activeSpan != null) {
expect(activeSpan.operationName, 'LifecycleModule.suspend');
expect(activeSpan.operationName, '$name.suspend');
activeSpan.setTag('custom.suspend.tag', 'somevalue');
}
eventList.add('onSuspend');
Expand All @@ -202,7 +202,7 @@ class TestLifecycleModule extends LifecycleModule {
throw onResumeError;
}
if (activeSpan != null) {
expect(activeSpan.operationName, 'LifecycleModule.resume');
expect(activeSpan.operationName, '$name.resume');
activeSpan.setTag('custom.resume.tag', 'somevalue');
}
eventList.add('onResume');
Expand Down Expand Up @@ -396,8 +396,7 @@ void runTests(bool runSpanTests) {
if (runSpanTests) {
test('should record a span', () async {
subs.add(getTestTracer().onSpanFinish.listen(expectAsync1((span) {
expect(span.operationName, 'LifecycleModule.load');
expect(span.tags['module.name'], 'TestLifecycleModule');
expect(span.operationName, 'TestLifecycleModule.load');
expect(span.tags['custom.load.tag'], 'somevalue');
expect(span.tags['error'], isNull);
})));
Expand Down Expand Up @@ -426,8 +425,7 @@ void runTests(bool runSpanTests) {
if (runSpanTests) {
test('should add the `error` span tag', () async {
subs.add(getTestTracer().onSpanFinish.listen(expectAsync1((span) {
expect(span.operationName, 'LifecycleModule.load');
expect(span.tags['module.name'], 'TestLifecycleModule');
expect(span.operationName, 'TestLifecycleModule.load');
expect(span.tags['error'], true);
})));

Expand Down Expand Up @@ -804,7 +802,8 @@ void runTests(bool runSpanTests) {
await gotoState(module, LifecycleState.loaded);
subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.suspend')
.where(
(span) => span.operationName == 'TestLifecycleModule.suspend')
.listen(expectAsync1((span) {
expect(span.tags['custom.suspend.tag'], 'somevalue');
})));
Expand All @@ -825,14 +824,14 @@ void runTests(bool runSpanTests) {
bool foundFirstSuspend = false;

subs.add(getTestTracer().onSpanFinish.listen(expectAsync1((span) {
if (span.operationName == 'LifecycleModule.suspend') {
if (span.operationName == 'TestLifecycleModule.suspend') {
expect(span.tags['custom.suspend.tag'], 'somevalue');
if (foundFirstSuspend) {
suspendCompleter.complete(span);
} else {
foundFirstSuspend = true;
}
} else if (span.operationName == 'LifecycleModule.resume') {
} else if (span.operationName == 'TestLifecycleModule.resume') {
expect(span.tags['custom.resume.tag'], 'somevalue');
resumeCompleter.complete(span);
} else {
Expand Down Expand Up @@ -882,8 +881,8 @@ void runTests(bool runSpanTests) {
await gotoState(module, LifecycleState.loaded);
subs.add(getTestTracer()
.onSpanFinish
.where(
(span) => span.operationName == 'LifecycleModule.suspend')
.where((span) =>
span.operationName == 'TestLifecycleModule.suspend')
.listen(expectAsync1((span) {
expect(span.tags['error'], true);
})));
Expand Down Expand Up @@ -1066,7 +1065,8 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.resume')
.where(
(span) => span.operationName == 'TestLifecycleModule.resume')
.listen(expectAsync1((span) {
expect(span.tags['custom.resume.tag'], 'somevalue');
})));
Expand All @@ -1083,13 +1083,13 @@ void runTests(bool runSpanTests) {
Completer<Span> resumeCompleter = new Completer();

subs.add(getTestTracer().onSpanFinish.listen(expectAsync1((span) {
if (span.operationName == 'LifecycleModule.suspend') {
if (span.operationName == 'TestLifecycleModule.suspend') {
expect(span.tags['custom.suspend.tag'], 'somevalue');
suspendCompleter.complete(span);
} else if (span.operationName == 'LifecycleModule.resume') {
} else if (span.operationName == 'TestLifecycleModule.resume') {
expect(span.tags['custom.resume.tag'], 'somevalue');
resumeCompleter.complete(span);
} else if (span.operationName == 'LifecycleModule.load') {
} else if (span.operationName == 'TestLifecycleModule.load') {
// Do nothing; this is just to handle the third expected span
} else {
fail(
Expand Down Expand Up @@ -1137,7 +1137,8 @@ void runTests(bool runSpanTests) {
test('should add the `error` span tag', () async {
subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.resume')
.where((span) =>
span.operationName == 'TestLifecycleModule.resume')
.listen(expectAsync1((span) {
expect(span.tags['error'], true);
})));
Expand Down Expand Up @@ -1534,9 +1535,7 @@ void runTests(bool runSpanTests) {
if (runSpanTests) {
subs.add(getTestTracer()
.onSpanFinish
.where((span) =>
span.operationName == 'LifecycleModule.load' &&
span.tags['module.name'] == 'parent')
.where((span) => span.operationName == 'parent.load')
.listen(expectAsync1((span) {
expect(parentSpanContext, isNull,
reason:
Expand Down Expand Up @@ -1610,7 +1609,7 @@ void runTests(bool runSpanTests) {
test('should record a span with `followsFrom` ref', () async {
subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.load')
.listen(expectAsync1((span) {
expect(span.parentContext.spanId, parentSpanContext.spanId);
expect(span.tags['custom.load.tag'], 'somevalue');
Expand Down Expand Up @@ -1645,7 +1644,7 @@ void runTests(bool runSpanTests) {
() async {
subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.load')
.where((span) => span.operationName == 'child.load')
.listen(expectAsync1((span) {
expect(span.parentContext.spanId, parentSpanContext.spanId);
expect(span.tags['error'], true);
Expand Down Expand Up @@ -1732,9 +1731,7 @@ void runTests(bool runSpanTests) {
if (runSpanTests) {
subs.add(getTestTracer()
.onSpanFinish
.where((span) =>
span.operationName == 'LifecycleModule.suspend' &&
span.tags['module.name'] == 'parent')
.where((span) => span.operationName == 'parent.suspend')
.listen(expectAsync1((span) {
parentSuspendContext = span.context;
})));
Expand Down Expand Up @@ -1773,7 +1770,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.suspend')
.listen(expectAsync1(childSpanCompleter.complete)));

parentModule.eventList.clear();
Expand Down Expand Up @@ -1815,7 +1812,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.suspend')
.listen(expectAsync1(childSpanCompleter.complete)));

expect(parentModule.suspend(),
Expand Down Expand Up @@ -1848,9 +1845,7 @@ void runTests(bool runSpanTests) {
if (runSpanTests) {
subs.add(getTestTracer()
.onSpanFinish
.where((span) =>
span.operationName == 'LifecycleModule.resume' &&
span.tags['module.name'] == 'parent')
.where((span) => span.operationName == 'parent.resume')
.listen(expectAsync1((span) {
parentResumeContext = span.context;
})));
Expand Down Expand Up @@ -1880,7 +1875,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.resume')
.listen(expectAsync1(childSpanCompleter.complete)));

parentModule.eventList.clear();
Expand Down Expand Up @@ -1922,7 +1917,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.resume')
.listen(expectAsync1(childSpanCompleter.complete)));

expect(parentModule.resume(),
Expand Down Expand Up @@ -1955,9 +1950,7 @@ void runTests(bool runSpanTests) {
if (runSpanTests) {
subs.add(getTestTracer()
.onSpanFinish
.where((span) =>
span.operationName == 'LifecycleModule.unload' &&
span.tags['module.name'] == 'parent')
.where((span) => span.operationName == 'parent.unload')
.listen(expectAsync1((span) {
parentUnloadContext = span.context;
})));
Expand Down Expand Up @@ -2006,7 +1999,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.unload')
.listen(expectAsync1(childSpanCompleter.complete)));

await parentModule.unload();
Expand Down Expand Up @@ -2326,7 +2319,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.tags['module.name'] != 'child')
.where((span) => !span.operationName.startsWith('child'))
.listen((span) {
fail(
'Only the child module should have spans. Found: ${span.tags['module.name']}');
Expand All @@ -2346,8 +2339,7 @@ void runTests(bool runSpanTests) {
test('should record a span for child with no parent', () async {
subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.load')
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.load')
.listen(expectAsync1((span) {
expect(span.parentContext, isNull);
expect(span.tags['custom.load.tag'], 'somevalue');
Expand All @@ -2361,8 +2353,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.load')
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.load')
.listen(expectAsync1((span) {
expect(span.parentContext, isNull);
expect(span.tags['error'], true);
Expand All @@ -2376,8 +2367,7 @@ void runTests(bool runSpanTests) {
await parentModule.loadChildModule(childModule);
subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.suspend')
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.suspend')
.listen(expectAsync1((span) {
expect(span.parentContext, isNull);
expect(span.tags['custom.suspend.tag'], 'somevalue');
Expand All @@ -2394,8 +2384,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.suspend')
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.suspend')
.listen(expectAsync1((span) {
expect(span.parentContext, isNull);
expect(span.tags['error'], true);
Expand All @@ -2410,8 +2399,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.resume')
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.resume')
.listen(expectAsync1((span) {
expect(span.parentContext, isNull);
expect(span.tags['custom.resume.tag'], 'somevalue');
Expand All @@ -2429,8 +2417,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.resume')
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.resume')
.listen(expectAsync1((span) {
expect(span.parentContext, isNull);
expect(span.tags['error'], true);
Expand All @@ -2445,8 +2432,7 @@ void runTests(bool runSpanTests) {

subs.add(getTestTracer()
.onSpanFinish
.where((span) => span.operationName == 'LifecycleModule.unload')
.where((span) => span.tags['module.name'] == 'child')
.where((span) => span.operationName == 'child.unload')
.listen(expectAsync1((span) {
expect(span.parentContext, isNull);
expect(span.tags['custom.unload.tag'], 'somevalue');
Expand Down

0 comments on commit 514c7a2

Please sign in to comment.