Improve javadoc and logging

2025-04-04 17:55:05 +00:00 · 2016-12-17 16:09:01 +00:00 · 2016-12-17 16:09:01 +00:00 · 76eb0a3200
commit 76eb0a3200
parent d3fd17aab5
19 changed files with 85 additions and 11 deletions
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/Main.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/Main.java
@ -5,6 +5,8 @@ import uk.ac.ic.wlgitbridge.bridge.Bridge;
 import uk.ac.ic.wlgitbridge.server.GitBridgeServer;
 import uk.ac.ic.wlgitbridge.util.Log;

+import java.util.Arrays;
+
 /**
 * Created by Winston on 01/11/14.
 */
@ -28,6 +30,10 @@ import uk.ac.ic.wlgitbridge.util.Log;
 public class Main {

    public static void main(String[] args) {
+        Log.info(
+                "Git Bridge started with args: "
+                        + Arrays.toString(args)
+        );
        try {
            new GitBridgeApp(args).run();
        } catch (Throwable t) {
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/application/GitBridgeApp.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/application/GitBridgeApp.java
@ -91,6 +91,7 @@ public class GitBridgeApp implements Runnable {
    }

    private void loadConfigFile() throws ConfigFileException, IOException {
+        Log.info("Loading config file at path: " + configFilePath);
        config = new Config(configFilePath);
    }

--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/bridge/Bridge.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/bridge/Bridge.java
@ -306,6 +306,7 @@ public class Bridge {
            String projectName
    ) throws ServiceMayNotContinueException,
             GitUserException {
+        Log.info("[{}] Checking that project exists", projectName);
        try (LockGuard __ = lock.lockGuard(projectName)) {
            GetDocRequest getDocRequest = new GetDocRequest(
                    oauth2,
@ -335,7 +336,7 @@ public class Bridge {
    ) throws IOException, GitUserException {
        String projectName = repo.getProjectName();
        try (LockGuard __ = lock.lockGuard(projectName)) {
-            Log.info("[{}] Updating", projectName);
+            Log.info("[{}] Updating repository", projectName);
            updateRepositoryCritical(oauth2, repo);
        }
    }
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/git/handler/WLReceivePackFactory.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/git/handler/WLReceivePackFactory.java
@ -9,6 +9,7 @@ import uk.ac.ic.wlgitbridge.bridge.snapshot.SnapshotAPI;
 import uk.ac.ic.wlgitbridge.git.handler.hook.WriteLatexPutHook;
 import uk.ac.ic.wlgitbridge.git.servlet.WLGitServlet;
 import uk.ac.ic.wlgitbridge.server.Oauth2Filter;
+import uk.ac.ic.wlgitbridge.util.Log;
 import uk.ac.ic.wlgitbridge.util.Util;

 import javax.servlet.http.HttpServletRequest;
@ -54,6 +55,10 @@ public class WLReceivePackFactory
            HttpServletRequest httpServletRequest,
            Repository repository
    ) {
+        Log.info(
+                "[{}] Creating receive-pack",
+                repository.getWorkTree().getName()
+        );
        Credential oauth2 = (Credential) httpServletRequest.getAttribute(
                Oauth2Filter.ATTRIBUTE_KEY
        );
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/git/handler/WLRepositoryResolver.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/git/handler/WLRepositoryResolver.java
@ -81,6 +81,7 @@ public class WLRepositoryResolver
    ) throws RepositoryNotFoundException,
             ServiceNotAuthorizedException,
             ServiceMayNotContinueException {
+        Log.info("[{}] Request to open git repo", name);
        Credential oauth2 = (Credential) httpServletRequest.getAttribute(
                Oauth2Filter.ATTRIBUTE_KEY
        );
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/git/handler/WLUploadPackFactory.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/git/handler/WLUploadPackFactory.java
@ -4,6 +4,7 @@ import org.eclipse.jgit.lib.Repository;
 import org.eclipse.jgit.transport.UploadPack;
 import org.eclipse.jgit.transport.resolver.UploadPackFactory;
 import uk.ac.ic.wlgitbridge.git.servlet.WLGitServlet;
+import uk.ac.ic.wlgitbridge.util.Log;
 import uk.ac.ic.wlgitbridge.util.Util;

 import javax.servlet.http.HttpServletRequest;
@ -34,11 +35,11 @@ public class WLUploadPackFactory
            HttpServletRequest __,
            Repository repository
    ) {
-        UploadPack uploadPack = new UploadPack(repository);
-        uploadPack.sendMessage(
-                "Downloading files from " + Util.getServiceName()
+        Log.info(
+                "[{}] Creating upload-pack",
+                repository.getWorkTree().getName()
        );
-        return uploadPack;
+       return new UploadPack(repository);
    }

 }
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/server/PostbackHandler.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/server/PostbackHandler.java
@ -32,7 +32,11 @@ public class PostbackHandler extends AbstractHandler {
            HttpServletRequest request,
            HttpServletResponse response
    ) throws IOException, ServletException {
-
+        Log.info(
+                "PostbackHandler: " + baseRequest.getMethod()
+                        + " <- "
+                        + baseRequest.getHttpURI()
+        );
        try {
            if (
                    request.getMethod().equals("POST")
@ -46,11 +50,6 @@ public class PostbackHandler extends AbstractHandler {
                }
                String projectName = parts[1];
                String postbackKey = parts[2];
-                Log.info(
-                        baseRequest.getMethod()
-                                + " <- "
-                                + baseRequest.getHttpURI()
-                );
                PostbackContents postbackContents = new PostbackContents(
                        bridge,
                        projectName,
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getdoc/GetDocRequest.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getdoc/GetDocRequest.java
@ -1,10 +1,14 @@
 package uk.ac.ic.wlgitbridge.snapshot.getdoc;

 import com.google.api.client.auth.oauth2.Credential;
+import com.google.api.client.http.HttpRequest;
 import com.google.gson.JsonElement;
 import uk.ac.ic.wlgitbridge.snapshot.base.HTTPMethod;
 import uk.ac.ic.wlgitbridge.snapshot.base.SnapshotAPIRequest;
 import uk.ac.ic.wlgitbridge.snapshot.exception.FailedConnectionException;
+import uk.ac.ic.wlgitbridge.util.Log;
+
+import java.io.IOException;

 /**
 * Created by Winston on 06/11/14.
@ -15,6 +19,11 @@ public class GetDocRequest extends SnapshotAPIRequest<GetDocResult> {

    public GetDocRequest(Credential oauth2, String projectName) {
        super(projectName, API_CALL, oauth2);
+        Log.info(
+                "GetDocRequest({}, {})",
+                "oauth2: <oauth2>",
+                "projectName: "  + projectName
+        );
    }

    public GetDocRequest(String projectName) {
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getdoc/GetDocResult.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getdoc/GetDocResult.java
@ -10,6 +10,7 @@ import uk.ac.ic.wlgitbridge.snapshot.base.Result;
 import uk.ac.ic.wlgitbridge.snapshot.exception.FailedConnectionException;
 import uk.ac.ic.wlgitbridge.snapshot.getdoc.exception.InvalidProjectException;
 import uk.ac.ic.wlgitbridge.snapshot.getsavedvers.WLUser;
+import uk.ac.ic.wlgitbridge.util.Log;

 /**
 * Created by Winston on 06/11/14.
@ -73,6 +74,7 @@ public class GetDocResult extends Result {

    @Override
    public void fromJSON(JsonElement json) {
+        Log.info("GetDocResult: " + json);
        JsonObject jsonObject = json.getAsJsonObject();
        if (jsonObject.has("status")) {
            switch (jsonObject.get("status").getAsInt()) {
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/GetForVersionRequest.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/GetForVersionRequest.java
@ -5,6 +5,7 @@ import com.google.gson.JsonElement;
 import uk.ac.ic.wlgitbridge.snapshot.base.HTTPMethod;
 import uk.ac.ic.wlgitbridge.snapshot.base.SnapshotAPIRequest;
 import uk.ac.ic.wlgitbridge.snapshot.exception.FailedConnectionException;
+import uk.ac.ic.wlgitbridge.util.Log;

 /**
 * Created by Winston on 06/11/14.
@ -23,6 +24,12 @@ public class GetForVersionRequest
    ) {
        super(projectName, API_CALL + "/" + versionID, oauth2);
        this.versionID = versionID;
+        Log.info(
+                "GetForVersionRequest({}, {}, {})",
+                "oauth2: <oauth2>",
+                "projectName: " + projectName,
+                "versionID: " + versionID
+        );
    }

    @Override
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/GetForVersionResult.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/GetForVersionResult.java
@ -3,6 +3,7 @@ package uk.ac.ic.wlgitbridge.snapshot.getforversion;
 import com.google.gson.JsonElement;
 import uk.ac.ic.wlgitbridge.snapshot.base.Request;
 import uk.ac.ic.wlgitbridge.snapshot.base.Result;
+import uk.ac.ic.wlgitbridge.util.Log;

 /**
 * Created by Winston on 06/11/14.
@ -27,6 +28,7 @@ public class GetForVersionResult extends Result {
    @Override
    public void fromJSON(JsonElement json) {
        snapshotData = new SnapshotData(json);
+        Log.info("GetForVersionResult({})", snapshotData);
    }

    public SnapshotData getSnapshotData() {
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/SnapshotAttachment.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/SnapshotAttachment.java
@ -17,6 +17,11 @@ public class SnapshotAttachment implements JSONSource {
        fromJSON(json);
    }

+    @Override
+    public String toString() {
+        return "SnapshotAttachment(url: " + url + ", path: " + path + ")";
+    }
+
    @Override
    public void fromJSON(JsonElement json) {
        JsonArray jsonArray = json.getAsJsonArray();
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/SnapshotData.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/SnapshotData.java
@ -33,6 +33,11 @@ public class SnapshotData implements JSONSource {
        this.atts = atts;
    }

+    @Override
+    public String toString() {
+        return "SnapshotData(srcs: " + srcs + ", atts: " + atts + ")";
+    }
+
    public JsonElement toJson() {
        JsonObject jsonThis = new JsonObject();
        JsonArray jsonSrcs = new JsonArray();
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/SnapshotFile.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getforversion/SnapshotFile.java
@ -18,6 +18,15 @@ public class SnapshotFile extends RawFile implements JSONSource {
        fromJSON(json);
    }

+    @Override
+    public String toString() {
+        return "SnapshotFile(path: "
+                + path
+                + ", contents: byte["
+                + contents.length
+                + "])";
+    }
+
    @Override
    public void fromJSON(JsonElement json) {
        JsonArray jsonArray = json.getAsJsonArray();
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getsavedvers/GetSavedVersRequest.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getsavedvers/GetSavedVersRequest.java
@ -5,6 +5,7 @@ import com.google.gson.JsonElement;
 import uk.ac.ic.wlgitbridge.snapshot.base.SnapshotAPIRequest;
 import uk.ac.ic.wlgitbridge.snapshot.exception.FailedConnectionException;
 import uk.ac.ic.wlgitbridge.snapshot.base.HTTPMethod;
+import uk.ac.ic.wlgitbridge.util.Log;

 /**
 * Created by Winston on 06/11/14.
@ -16,6 +17,11 @@ public class GetSavedVersRequest

    public GetSavedVersRequest(Credential oauth2, String projectName) {
        super(projectName, API_CALL, oauth2);
+        Log.info(
+                "GetSavedVersRequest({}, {})",
+                "oauth2: <oauth2>",
+                "projectName: " + projectName
+        );
    }

    @Override
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getsavedvers/GetSavedVersResult.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getsavedvers/GetSavedVersResult.java
@ -7,6 +7,7 @@ import com.google.gson.JsonObject;
 import uk.ac.ic.wlgitbridge.snapshot.base.Request;
 import uk.ac.ic.wlgitbridge.snapshot.base.Result;
 import uk.ac.ic.wlgitbridge.snapshot.exception.FailedConnectionException;
+import uk.ac.ic.wlgitbridge.util.Log;

 import java.util.ArrayList;
 import java.util.List;
@ -49,6 +50,7 @@ public class GetSavedVersResult extends Result {

    @Override
    public void fromJSON(JsonElement json) {
+        Log.info("GetSavedVersResult({})", json);
        savedVers = new ArrayList<>();
        for (JsonElement elem : json.getAsJsonArray()) {
            savedVers.add(
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getsavedvers/WLUser.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/getsavedvers/WLUser.java
@ -34,4 +34,8 @@ public class WLUser {
        return email;
    }

+    @Override
+    public String toString() {
+        return "(" + name + ", " + email + ")";
+    }
 }
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/push/PushRequest.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/push/PushRequest.java
@ -6,6 +6,7 @@ import uk.ac.ic.wlgitbridge.data.CandidateSnapshot;
 import uk.ac.ic.wlgitbridge.snapshot.base.HTTPMethod;
 import uk.ac.ic.wlgitbridge.snapshot.base.SnapshotAPIRequest;
 import uk.ac.ic.wlgitbridge.snapshot.exception.FailedConnectionException;
+import uk.ac.ic.wlgitbridge.util.Log;

 /**
 * Created by Winston on 16/11/14.
@ -25,6 +26,12 @@ public class PushRequest extends SnapshotAPIRequest<PushResult> {
        super(candidateSnapshot.getProjectName(), API_CALL, oauth2);
        this.candidateSnapshot = candidateSnapshot;
        this.postbackKey = postbackKey;
+        Log.info(
+                "PushRequest({}, {}, {})",
+                "oauth2: <oauth2>",
+                "candidateSnapshot: " + candidateSnapshot,
+                "postbackKey: " + postbackKey
+        );
    }

    @Override
--- a/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/push/PushResult.java
+++ b/services/git-bridge/src/main/java/uk/ac/ic/wlgitbridge/snapshot/push/PushResult.java
@ -5,6 +5,7 @@ import com.google.gson.JsonObject;
 import uk.ac.ic.wlgitbridge.snapshot.base.Result;
 import uk.ac.ic.wlgitbridge.snapshot.base.Request;
 import uk.ac.ic.wlgitbridge.snapshot.exception.FailedConnectionException;
+import uk.ac.ic.wlgitbridge.util.Log;
 import uk.ac.ic.wlgitbridge.util.Util;

 /**
@ -32,6 +33,7 @@ public class PushResult extends Result {

    @Override
    public void fromJSON(JsonElement json) {
+        Log.info("PushResult({})", json);
        JsonObject responseObject = json.getAsJsonObject();
        String code = Util.getCodeFromResponse(responseObject);