From 0130f91830ebf70f88cac44062f4801cf035e724 Mon Sep 17 00:00:00 2001
From: mcilwain <mcilwain@google.com>
Date: Mon, 28 Jan 2019 09:48:37 -0800
Subject: [PATCH] Add logging to DNL fetch action

This will help us to debug the current MarksDB issue.  This also throws an explicit error earlier when attempting to connect to MarksDB without login credentials being specified, which we know will fail.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=231236317
---
 java/google/registry/tmch/Marksdb.java        | 41 ++++++++++++++++---
 .../registry/tmch/TmchSmdrlActionTest.java    |  2 +-
 2 files changed, 37 insertions(+), 6 deletions(-)

diff --git a/java/google/registry/tmch/Marksdb.java b/java/google/registry/tmch/Marksdb.java
index 07fe2337e..a99f3087d 100644
--- a/java/google/registry/tmch/Marksdb.java
+++ b/java/google/registry/tmch/Marksdb.java
@@ -16,6 +16,7 @@ package google.registry.tmch;
 
 import static com.google.appengine.api.urlfetch.FetchOptions.Builder.validateCertificate;
 import static com.google.appengine.api.urlfetch.HTTPMethod.GET;
+import static com.google.common.base.Preconditions.checkArgument;
 import static google.registry.util.HexDumper.dumpHex;
 import static google.registry.util.UrlFetchUtils.setAuthorizationHeader;
 import static java.nio.charset.StandardCharsets.US_ASCII;
@@ -24,6 +25,8 @@ import static javax.servlet.http.HttpServletResponse.SC_OK;
 import com.google.appengine.api.urlfetch.HTTPRequest;
 import com.google.appengine.api.urlfetch.HTTPResponse;
 import com.google.appengine.api.urlfetch.URLFetchService;
+import com.google.common.collect.ImmutableList;
+import com.google.common.flogger.FluentLogger;
 import com.google.common.io.ByteSource;
 import google.registry.config.RegistryConfig.Config;
 import google.registry.keyring.api.KeyModule.Key;
@@ -33,6 +36,7 @@ import java.io.IOException;
 import java.net.URL;
 import java.security.Security;
 import java.security.SignatureException;
+import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import javax.annotation.Tainted;
@@ -50,6 +54,9 @@ import org.bouncycastle.openpgp.operator.bc.BcPGPContentVerifierBuilderProvider;
 /** Shared code for tasks that download stuff from MarksDB. */
 public final class Marksdb {
 
+  private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+  private static final int MAX_DNL_LOGGING_LENGTH = 500;
+
   @Inject URLFetchService fetchService;
   @Inject @Config("tmchMarksdbUrl") String tmchMarksdbUrl;
   @Inject @Key("marksdbPublicKey") PGPPublicKey marksdbPublicKey;
@@ -115,12 +122,36 @@ public final class Marksdb {
     return rsp.getContent();
   }
 
-  List<String> fetchSignedCsv(
-      Optional<String> login, String csvPath, String sigPath)
+  List<String> fetchSignedCsv(Optional<String> login, String csvPath, String sigPath)
       throws IOException, SignatureException, PGPException {
-    byte[] csv = fetch(new URL(tmchMarksdbUrl + csvPath), login);
-    byte[] sig = fetch(new URL(tmchMarksdbUrl + sigPath), login);
+    checkArgument(login.isPresent(), "Cannot fetch from MarksDB without login credentials");
+
+    String csvUrl = tmchMarksdbUrl + csvPath;
+    byte[] csv = fetch(new URL(csvUrl), login);
+    logFetchedBytes(csvUrl, csv);
+
+    String sigUrl = tmchMarksdbUrl + sigPath;
+    byte[] sig = fetch(new URL(sigUrl), login);
+    logFetchedBytes(sigUrl, sig);
+
     pgpVerifySignature(csv, sig, marksdbPublicKey);
-    return ByteSource.wrap(csv).asCharSource(US_ASCII).readLines();
+    ImmutableList<String> lines = ByteSource.wrap(csv).asCharSource(US_ASCII).readLines();
+    logger.atInfo().log("Parsed %d lines.", lines.size());
+    return lines;
+  }
+
+  /**
+   * Logs the length and first 500 characters of a byte array of the given name.
+   *
+   * <p>Note that the DNL is long, hence truncating it instead of logging the whole thing.
+   */
+  private static void logFetchedBytes(String sourceUrl, byte[] bytes) throws IOException {
+    logger.atInfo().log(
+        "Fetched contents of %s -- Size: %d bytes; first %d chars:\n\n%s%s",
+        sourceUrl,
+        bytes.length,
+        MAX_DNL_LOGGING_LENGTH,
+        new String(Arrays.copyOf(bytes, Math.min(bytes.length, MAX_DNL_LOGGING_LENGTH)), US_ASCII),
+        (bytes.length > MAX_DNL_LOGGING_LENGTH) ? "<truncated>" : "");
   }
 }
diff --git a/javatests/google/registry/tmch/TmchSmdrlActionTest.java b/javatests/google/registry/tmch/TmchSmdrlActionTest.java
index ae0e3db2a..68b4145c1 100644
--- a/javatests/google/registry/tmch/TmchSmdrlActionTest.java
+++ b/javatests/google/registry/tmch/TmchSmdrlActionTest.java
@@ -33,7 +33,7 @@ public class TmchSmdrlActionTest extends TmchActionTestCase {
   private TmchSmdrlAction newTmchSmdrlAction() {
     TmchSmdrlAction action = new TmchSmdrlAction();
     action.marksdb = marksdb;
-    action.marksdbSmdrlLogin = Optional.empty();
+    action.marksdbSmdrlLogin = Optional.of("username:password");
     return action;
   }