Fix: multiple calls to end of span (#75)

* fix: multiple span.end calling * fix: multiple span.end calling * fix: multiple span.end calling * integrate test framework for span * add stream=null * fix: execute tracer tests in separate execution * format: format pom * attempt to fix tests * add com.google.errorprone:error_prone_annotations to ignoredDependencies Co-authored-by: Knut Olav Løite <koloite@gmail.com>

Author: mayurkale22

google-cloud-spanner/pom.xml

@@ -38,17 +38,37 @@
  </execution>
  </executions>
  </plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <reportNameSuffix>sponge_log</reportNameSuffix>
+ </configuration>
+ <executions>
+ <execution>
+ <id>default-test</id>
+ <configuration>
+ <excludedGroups>com.google.cloud.spanner.TracerTest,com.google.cloud.spanner.IntegrationTest</excludedGroups>
+ </configuration>
+ </execution>
+ <execution>
+ <id>tracer</id>
+ <goals>
+ <goal>test</goal>
+ </goals>
+ <configuration>
+ <groups>com.google.cloud.spanner.TracerTest</groups>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
  </plugins>
  <pluginManagement>
  <plugins>
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <version>3.0.0-M4</version>
- <configuration>
- <excludedGroups>com.google.cloud.spanner.IntegrationTest</excludedGroups>
- <reportNameSuffix>sponge_log</reportNameSuffix>
- </configuration>
  </plugin>
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
@@ -60,15 +80,15 @@
  <spanner.testenv.instance>projects/gcloud-devel/instances/spanner-testing</spanner.testenv.instance>
  </systemPropertyVariables>
  <groups>com.google.cloud.spanner.IntegrationTest</groups>
- <excludedGroups>com.google.cloud.spanner.FlakyTest</excludedGroups>
+ <excludedGroups>com.google.cloud.spanner.FlakyTest,com.google.cloud.spanner.TracerTest</excludedGroups>
  <forkedProcessTimeoutInSeconds>2400</forkedProcessTimeoutInSeconds>
  </configuration>
  </plugin>
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-dependency-plugin</artifactId>
  <configuration>
- <ignoredDependencies>io.grpc:grpc-protobuf-lite,org.hamcrest:hamcrest,org.hamcrest:hamcrest-core</ignoredDependencies>
+ <ignoredDependencies>io.grpc:grpc-protobuf-lite,org.hamcrest:hamcrest,org.hamcrest:hamcrest-core,com.google.errorprone:error_prone_annotations</ignoredDependencies>
  </configuration>
  </plugin>
  </plugins>

google-cloud-spanner/src/main/java/com/google/cloud/spanner/AbstractResultSet.java

@@ -922,6 +922,7 @@ public void close(@Nullable String message) {
  if (stream != null) {
  stream.close(message);
  span.end(TraceUtil.END_SPAN_OPTIONS);
+ stream = null;
  }
  }
 
@@ -997,11 +998,11 @@ protected PartialResultSet computeNext() {
  continue;
  }
  span.addAnnotation("Stream broken. Not safe to retry");
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
  } catch (RuntimeException e) {
  span.addAnnotation("Stream broken. Not safe to retry");
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
  }
  }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/DatabaseClientImpl.java

@@ -66,7 +66,7 @@ public Timestamp apply(Session session) {
  }
  });
  } catch (RuntimeException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
  } finally {
  span.end(TraceUtil.END_SPAN_OPTIONS);
@@ -86,7 +86,7 @@ public Timestamp apply(Session session) {
  }
  });
  } catch (RuntimeException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
  } finally {
  span.end(TraceUtil.END_SPAN_OPTIONS);
@@ -165,8 +165,10 @@ public TransactionRunner readWriteTransaction() {
  try (Scope s = tracer.withSpan(span)) {
  return getReadWriteSession().readWriteTransaction();
  } catch (RuntimeException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
+ } finally {
+ span.end(TraceUtil.END_SPAN_OPTIONS);
  }
  }
 

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionClient.java

@@ -135,7 +135,7 @@ public void run() {
  try {
  sessions = internalBatchCreateSessions(remainingSessionsToCreate, channelHint);
  } catch (Throwable t) {
- TraceUtil.endSpanWithFailure(SpannerImpl.tracer.getCurrentSpan(), t);
+ TraceUtil.setWithFailure(SpannerImpl.tracer.getCurrentSpan(), t);
  consumer.onSessionCreateFailure(t, remainingSessionsToCreate);
  break;
  }
@@ -207,11 +207,12 @@ SessionImpl createSession() {
  spanner
  .getRpc()
  .createSession(db.getName(), spanner.getOptions().getSessionLabels(), options);
- span.end(TraceUtil.END_SPAN_OPTIONS);
  return new SessionImpl(spanner, session.getName(), options);
  } catch (RuntimeException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
+ } finally {
+ span.end(TraceUtil.END_SPAN_OPTIONS);
  }
  }
 

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionImpl.java

@@ -140,14 +140,15 @@ public Timestamp writeAtLeastOnce(Iterable<Mutation> mutations) throws SpannerEx
  try (Scope s = tracer.withSpan(span)) {
  CommitResponse response = spanner.getRpc().commit(request, options);
  Timestamp t = Timestamp.fromProto(response.getCommitTimestamp());
- span.end(TraceUtil.END_SPAN_OPTIONS);
  return t;
  } catch (IllegalArgumentException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw newSpannerException(ErrorCode.INTERNAL, "Could not parse commit timestamp", e);
  } catch (RuntimeException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
+ } finally {
+ span.end(TraceUtil.END_SPAN_OPTIONS);
  }
  }
 
@@ -208,10 +209,11 @@ public void close() {
  Span span = tracer.spanBuilder(SpannerImpl.DELETE_SESSION).startSpan();
  try (Scope s = tracer.withSpan(span)) {
  spanner.getRpc().deleteSession(name, options);
- span.end(TraceUtil.END_SPAN_OPTIONS);
  } catch (RuntimeException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
+ } finally {
+ span.end(TraceUtil.END_SPAN_OPTIONS);
  }
  }
 

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java

@@ -895,7 +895,7 @@ private PooledSession take() throws SpannerException {
  return s.session;
  }
  } catch (Exception e) {
- TraceUtil.endSpanWithFailure(tracer.getCurrentSpan(), e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
  } finally {
  span.end(TraceUtil.END_SPAN_OPTIONS);

google-cloud-spanner/src/main/java/com/google/cloud/spanner/TraceUtil.java

@@ -54,6 +54,16 @@ static ImmutableMap<String, AttributeValue> getExceptionAnnotations(SpannerExcep
  "Status", AttributeValue.stringAttributeValue(e.getErrorCode().toString()));
  }
 
+ static void setWithFailure(Span span, Throwable e) {
+ if (e instanceof SpannerException) {
+ span.setStatus(
+ StatusConverter.fromGrpcStatus(((SpannerException) e).getErrorCode().getGrpcStatus())
+ .withDescription(e.getMessage()));
+ } else {
+ span.setStatus(Status.INTERNAL.withDescription(e.getMessage()));
+ }
+ }
+
  static void endSpanWithFailure(Span span, Throwable e) {
  if (e instanceof SpannerException) {
  endSpanWithFailure(span, (SpannerException) e);

google-cloud-spanner/src/main/java/com/google/cloud/spanner/TransactionRunnerImpl.java

@@ -294,7 +294,7 @@ public <T> T run(TransactionCallable<T> callable) {
  }
  return runInternal(callable);
  } catch (RuntimeException e) {
- TraceUtil.endSpanWithFailure(span, e);
+ TraceUtil.setWithFailure(span, e);
  throw e;
  } finally {
  // Remove threadLocal rather than set to FALSE to avoid a possible memory leak.