chore: add x-goog-request-id insertion into *Exception

Allows users to examine and report the requestId in any
thrown exceptions.

Updates googleapis#3537

Author: odeke-em

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

@@ -35,16 +35,17 @@ public class AbortedException extends SpannerException {
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
   AbortedException(
       DoNotConstructDirectly token, @Nullable String message, @Nullable Throwable cause) {
-    this(token, message, cause, null);
+    this(token, message, cause, null, null);
   }
 
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
   AbortedException(
       DoNotConstructDirectly token,
       @Nullable String message,
       @Nullable Throwable cause,
-      @Nullable ApiException apiException) {
-    super(token, ErrorCode.ABORTED, IS_RETRYABLE, message, cause, apiException);
+      @Nullable ApiException apiException,
+      @Nullable XGoogSpannerRequestId reqId) {
+    super(token, ErrorCode.ABORTED, IS_RETRYABLE, message, cause, apiException, reqId);
   }
 
   /**

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

@@ -32,15 +32,16 @@ public class AdminRequestsPerMinuteExceededException extends SpannerException {
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
   AdminRequestsPerMinuteExceededException(
       DoNotConstructDirectly token, @Nullable String message, @Nullable Throwable cause) {
-    this(token, message, cause, null);
+    this(token, message, cause, null, null);
   }
 
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
   AdminRequestsPerMinuteExceededException(
       DoNotConstructDirectly token,
       @Nullable String message,
       @Nullable Throwable cause,
-      @Nullable ApiException apiException) {
-    super(token, ErrorCode.RESOURCE_EXHAUSTED, true, message, cause, apiException);
+      @Nullable ApiException apiException,
+      @Nullable XGoogSpannerRequestId reqId) {
+    super(token, ErrorCode.RESOURCE_EXHAUSTED, true, message, cause, apiException, reqId);
   }
 }

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

@@ -35,7 +35,7 @@ public class DatabaseNotFoundException extends ResourceNotFoundException {
       @Nullable String message,
       ResourceInfo resourceInfo,
       @Nullable Throwable cause) {
-    this(token, message, resourceInfo, cause, null);
+    this(token, message, resourceInfo, cause, null, null);
   }
 
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
@@ -44,7 +44,8 @@ public class DatabaseNotFoundException extends ResourceNotFoundException {
       @Nullable String message,
       ResourceInfo resourceInfo,
       @Nullable Throwable cause,
-      @Nullable ApiException apiException) {
-    super(token, message, resourceInfo, cause, apiException);
+      @Nullable ApiException apiException,
+      @Nullable XGoogSpannerRequestId reqId) {
+    super(token, message, resourceInfo, cause, apiException, reqId);
   }
 }

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

@@ -35,15 +35,16 @@ public class InstanceNotFoundException extends ResourceNotFoundException {
       @Nullable String message,
       ResourceInfo resourceInfo,
       @Nullable Throwable cause) {
-    this(token, message, resourceInfo, cause, null);
+    this(token, message, resourceInfo, cause, null, null);
   }
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
   InstanceNotFoundException(
       DoNotConstructDirectly token,
       @Nullable String message,
       ResourceInfo resourceInfo,
       @Nullable Throwable cause,
-      @Nullable ApiException apiException) {
-    super(token, message, resourceInfo, cause, apiException);
+      @Nullable ApiException apiException,
+      @Nullable XGoogSpannerRequestId reqId) {
+    super(token, message, resourceInfo, cause, apiException, reqId);
   }
 }

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

@@ -37,8 +37,9 @@ public class MissingDefaultSequenceKindException extends SpannerException {
       ErrorCode errorCode,
       String message,
       Throwable cause,
-      @Nullable ApiException apiException) {
-    super(token, errorCode, /*retryable = */ false, message, cause, apiException);
+      @Nullable ApiException apiException,
+      @Nullable XGoogSpannerRequestId reqId) {
+    super(token, errorCode, /*retryable = */ false, message, cause, apiException, reqId);
   }
 
   static boolean isMissingDefaultSequenceKindException(Throwable cause) {

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

@@ -89,7 +89,7 @@ private static <R, M> Operation<R, M> failed(
       SpannerRpc rpc, String name, Status status, M metadata, Parser<R, M> parser, ApiClock clock) {
     SpannerException e =
         SpannerExceptionFactory.newSpannerException(
-            ErrorCode.fromRpcStatus(status), status.getMessage(), null);
+            ErrorCode.fromRpcStatus(status), status.getMessage(), (Throwable) (null));
     return new Operation<>(rpc, name, metadata, null, e, true, parser, clock);
   }
 

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

@@ -180,10 +180,10 @@ private void backoffSleep(Context context, long backoffMillis) throws SpannerExc
       }
       if (latch.await(backoffMillis, TimeUnit.MILLISECONDS)) {
         // Woken by context cancellation.
-        throw newSpannerExceptionForCancellation(context, null);
+        throw newSpannerExceptionForCancellation(context, null, null /*TODO: requestId*/);
       }
     } catch (InterruptedException interruptExcept) {
-      throw newSpannerExceptionForCancellation(context, interruptExcept);
+      throw newSpannerExceptionForCancellation(context, interruptExcept, null /*TODO: requestId*/);
     } finally {
       context.removeListener(listener);
     }

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

@@ -35,7 +35,7 @@ public class SessionNotFoundException extends ResourceNotFoundException {
       @Nullable String message,
       ResourceInfo resourceInfo,
       @Nullable Throwable cause) {
-    this(token, message, resourceInfo, cause, null);
+    this(token, message, resourceInfo, cause, null, null);
   }
 
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
@@ -44,7 +44,8 @@ public class SessionNotFoundException extends ResourceNotFoundException {
       @Nullable String message,
       ResourceInfo resourceInfo,
       @Nullable Throwable cause,
-      @Nullable ApiException apiException) {
-    super(token, message, resourceInfo, cause, apiException);
+      @Nullable ApiException apiException,
+      @Nullable XGoogSpannerRequestId reqId) {
+    super(token, message, resourceInfo, cause, apiException, reqId);
   }
 }

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

@@ -35,9 +35,10 @@ public static <T> T getOrNull(ApiFuture<T> future) throws SpannerException {
       }
       throw SpannerExceptionFactory.newSpannerException(e.getCause());
     } catch (InterruptedException e) {
-      throw SpannerExceptionFactory.propagateInterrupt(e);
+      throw SpannerExceptionFactory.propagateInterrupt(e, null /*TODO: requestId*/);
     } catch (CancellationException e) {
-      throw SpannerExceptionFactory.newSpannerExceptionForCancellation(null, e);
+      throw SpannerExceptionFactory.newSpannerExceptionForCancellation(
+          null, e, null /*TODO: requestId*/);
     }
   }
 }

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

@@ -25,8 +25,9 @@ public class SpannerBatchUpdateException extends SpannerException {
       ErrorCode code,
       String message,
       long[] counts,
-      Throwable cause) {
-    super(token, code, false, message, cause);
+      Throwable cause,
+      XGoogSpannerRequestId reqId) {
+    super(token, code, false, message, cause, null, reqId);
     updateCounts = counts;
   }
 

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

@@ -40,8 +40,9 @@ public abstract static class ResourceNotFoundException extends SpannerException
         @Nullable String message,
         ResourceInfo resourceInfo,
         @Nullable Throwable cause,
-        @Nullable ApiException apiException) {
-      super(token, ErrorCode.NOT_FOUND, /* retryable */ false, message, cause, apiException);
+        @Nullable ApiException apiException,
+        @Nullable XGoogSpannerRequestId reqId) {
+      super(token, ErrorCode.NOT_FOUND, /* retryable */ false, message, cause, apiException, reqId);
       this.resourceInfo = resourceInfo;
     }
 
@@ -56,6 +57,7 @@ public String getResourceName() {
 
   private final ErrorCode code;
   private final ApiException apiException;
+  private final XGoogSpannerRequestId requestId;
 
   /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
   SpannerException(
@@ -75,19 +77,39 @@ public String getResourceName() {
       @Nullable String message,
       @Nullable Throwable cause,
       @Nullable ApiException apiException) {
+    this(token, code, retryable, message, cause, apiException, null);
+  }
+
+  /** Private constructor. Use {@link SpannerExceptionFactory} to create instances. */
+  SpannerException(
+      DoNotConstructDirectly token,
+      ErrorCode code,
+      boolean retryable,
+      @Nullable String message,
+      @Nullable Throwable cause,
+      @Nullable ApiException apiException,
+      @Nullable XGoogSpannerRequestId requestId) {
     super(message, cause, code.getCode(), retryable);
     if (token != DoNotConstructDirectly.ALLOWED) {
       throw new AssertionError("Do not construct directly: use SpannerExceptionFactory");
     }
     this.code = Preconditions.checkNotNull(code);
     this.apiException = apiException;
+    this.requestId = requestId;
   }
 
   /** Returns the error code associated with this exception. */
   public ErrorCode getErrorCode() {
     return code;
   }
 
+  public String getRequestId() {
+    if (requestId == null) {
+      return "";
+    }
+    return requestId.toString();
+  }
+
   enum DoNotConstructDirectly {
     ALLOWED
   }