SpringCloud/spring-cloud-sleuth
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix NPE in TracePreZuulFilter

Browse Source 
Fixes gh-135
This commit is contained in:
Dave Syer
2016-01-30 16:47:23 +00:00
parent 39998a5def
commit 12620a4725
3 changed files with 150 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/zuul/TracePreZuulFilter.java
View File

@@ -33,8 +33,8 @@ import com.netflix.zuul.context.RequestContext;
* @author Dave Syer
*
*/
public class TracePreZuulFilter extends ZuulFilter implements
ApplicationEventPublisherAware {
public class TracePreZuulFilter extends ZuulFilter
implements ApplicationEventPublisherAware {
private ApplicationEventPublisher publisher;
@@ -58,7 +58,8 @@ ApplicationEventPublisherAware {
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
Map<String, String> response = ctx.getZuulRequestHeaders();
// N.B. this will only work with the simple host filter (not ribbon) unless you set hystrix.execution.isolation.strategy=SEMAPHORE
// N.B. this will only work with the simple host filter (not ribbon) unless you
// set hystrix.execution.isolation.strategy=SEMAPHORE
Span span = getCurrentSpan();
if (span == null) {
setHeader(response, Span.NOT_SAMPLED_NAME, "true");
@@ -68,6 +69,9 @@ ApplicationEventPublisherAware {
setHeader(response, Span.SPAN_ID_NAME, span.getSpanId());
setHeader(response, Span.TRACE_ID_NAME, span.getTraceId());
setHeader(response, Span.SPAN_NAME_NAME, span.getName());
if (!span.isExportable()) {
setHeader(response, Span.NOT_SAMPLED_NAME, "true");
}
setHeader(response, Span.PARENT_ID_NAME, getParentId(span));
setHeader(response, Span.PROCESS_ID_NAME, span.getProcessId());
// TODO: the client sent event should come from the client not the filter!
@@ -84,8 +88,7 @@ ApplicationEventPublisherAware {
}
private Long getParentId(Span span) {
return !span.getParents().isEmpty() ? span
.getParents().get(0) : null;
return !span.getParents().isEmpty() ? span.getParents().get(0) : null;
}
public void setHeader(Map<String, String> request, String name, String value) {
@@ -93,8 +96,11 @@ ApplicationEventPublisherAware {
request.put(name, value);
}
}
public void setHeader(Map<String, String> request, String name, Long value) {
setHeader(request, name, Span.toHex(value));
if (value != null) {
setHeader(request, name, Span.toHex(value));
}
}
@Override

62
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/zuul/TracePostZuulFilterTests.java Normal file
View File

@@ -0,0 +1,62 @@
/*
* Copyright 2015 the original author or authors.
*
* Licensed 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.
*/
package org.springframework.cloud.sleuth.instrument.zuul;
import static org.mockito.Matchers.isA;
import static org.mockito.Mockito.verify;
import java.util.Random;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mockito;
import org.springframework.cloud.sleuth.event.ClientReceivedEvent;
import org.springframework.cloud.sleuth.sampler.AlwaysSampler;
import org.springframework.cloud.sleuth.trace.DefaultTracer;
import org.springframework.cloud.sleuth.trace.SpanContextHolder;
import org.springframework.context.ApplicationEventPublisher;
import com.netflix.zuul.context.RequestContext;
/**
* @author Dave Syer
*
*/
public class TracePostZuulFilterTests {
private ApplicationEventPublisher publisher = Mockito.mock(ApplicationEventPublisher.class);
private DefaultTracer tracer = new DefaultTracer(new AlwaysSampler(), new Random(), Mockito.mock(ApplicationEventPublisher.class));
private TracePostZuulFilter filter = new TracePostZuulFilter(this.tracer);
@After
@Before
public void clean() {
RequestContext.getCurrentContext().unset();
SpanContextHolder.removeCurrentSpan();
}
@Test
public void filterPublishesEvent() throws Exception {
this.filter.setApplicationEventPublisher(this.publisher);
this.tracer.startTrace("start");
this.filter.run();
verify(this.publisher).publishEvent(isA(ClientReceivedEvent.class));
}
}

76
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/zuul/TracePreZuulFilterTests.java Normal file
View File

@@ -0,0 +1,76 @@
/*
* Copyright 2015 the original author or authors.
*
* Licensed 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.
*/
package org.springframework.cloud.sleuth.instrument.zuul;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.junit.Assert.assertThat;
import java.util.Random;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.mockito.Mockito;
import org.springframework.cloud.sleuth.Span;
import org.springframework.cloud.sleuth.sampler.AlwaysSampler;
import org.springframework.cloud.sleuth.sampler.IsTracingSampler;
import org.springframework.cloud.sleuth.trace.DefaultTracer;
import org.springframework.cloud.sleuth.trace.SpanContextHolder;
import org.springframework.context.ApplicationEventPublisher;
import com.netflix.zuul.context.RequestContext;
/**
* @author Dave Syer
*
*/
public class TracePreZuulFilterTests {
private ApplicationEventPublisher publisher = Mockito.mock(ApplicationEventPublisher.class);
private DefaultTracer tracer = new DefaultTracer(new AlwaysSampler(), new Random(), this.publisher);
private TracePreZuulFilter filter = new TracePreZuulFilter(this.tracer);
@After
@Before
public void clean() {
RequestContext.getCurrentContext().unset();
SpanContextHolder.removeCurrentSpan();
}
@Test
public void filterAddsHeaders() throws Exception {
this.tracer.startTrace("start");
this.filter.run();
RequestContext ctx = RequestContext.getCurrentContext();
assertThat(ctx.getZuulRequestHeaders().get(Span.TRACE_ID_NAME), is(notNullValue()));
assertThat(ctx.getZuulRequestHeaders().get(Span.NOT_SAMPLED_NAME), is(nullValue()));
}
@Test
public void notSampledIfNotExportable() throws Exception {
this.tracer.startTrace("start", new IsTracingSampler());
this.filter.run();
RequestContext ctx = RequestContext.getCurrentContext();
assertThat(ctx.getZuulRequestHeaders().get(Span.TRACE_ID_NAME), is(notNullValue()));
assertThat(ctx.getZuulRequestHeaders().get(Span.NOT_SAMPLED_NAME), is(notNullValue()));
}
}