Merge pull request #889 from launchableinc/commit-message

Add the option to collect commit messages

Author: ono-max

launchable/commands/record/commit.py

@@ -6,6 +6,9 @@
 
 import click
 
+from launchable.utils.launchable_client import LaunchableClient
+from launchable.utils.tracking import Tracking, TrackingClient
+
 from ...app import Application
 from ...utils.commit_ingester import upload_commits
 from ...utils.env_keys import REPORT_ERROR_KEY
@@ -54,8 +57,25 @@ def commit(ctx, source: str, executable: bool, max_days: int, scrub_pii: bool, i
         _import_git_log(import_git_log_output, ctx.obj)
         return
 
+    tracking_client = TrackingClient(Tracking.Command.COMMIT, app=ctx.obj)
+    client = LaunchableClient(tracking_client=tracking_client, app=ctx.obj)
+
+    # Commit messages are not collected in the default.
+    is_collect_message = False
+    try:
+        res = client.request("get", "commits/collect/options")
+        res.raise_for_status()
+        is_collect_message = res.json().get("commitMessage", False)
+    except Exception as e:
+        tracking_client.send_error_event(
+            event_name=Tracking.ErrorEvent.INTERNAL_CLI_ERROR,
+            stack_trace=str(e),
+            api="commits/options",
+        )
+        client.print_exception_and_recover(e)
+
     try:
-        exec_jar(os.path.abspath(source), max_days, ctx.obj)
+        exec_jar(os.path.abspath(source), max_days, ctx.obj, is_collect_message)
     except Exception as e:
         if os.getenv(REPORT_ERROR_KEY):
             raise e
@@ -69,7 +89,7 @@ def commit(ctx, source: str, executable: bool, max_days: int, scrub_pii: bool, i
             print(e)
 
 
-def exec_jar(source: str, max_days: int, app: Application):
+def exec_jar(source: str, max_days: int, app: Application, is_collect_message: bool):
     java = get_java_command()
 
     if not java:
@@ -89,7 +109,7 @@ def exec_jar(source: str, max_days: int, app: Application):
         "{}/intake/".format(base_url),
         "-max-days",
         str(max_days),
-        "-scrub-pii",
+        "-scrub-pii"
     ])
 
     if Logger().logger.isEnabledFor(LOG_LEVEL_AUDIT):
@@ -98,6 +118,8 @@ def exec_jar(source: str, max_days: int, app: Application):
         command.append("-dry-run")
     if app.skip_cert_verification:
         command.append("-skip-cert-verification")
+    if is_collect_message:
+        command.append("-commit-message")
     command.append(cygpath(source))
 
     subprocess.run(

launchable/jar/exe_deploy.jar

@@ -32,6 +32,7 @@ class Command(Enum):
         RECORD_BUILD = 'RECORD_BUILD'
         RECORD_SESSION = 'RECORD_SESSION'
         SUBSET = 'SUBSET'
+        COMMIT = 'COMMIT'
 
 
 class TrackingClient:

launchable/utils/tracking.py

@@ -74,6 +74,8 @@ public class CommitGraphCollector {
 
   private int commitsSent;
 
+  private boolean collectCommitMessage;
+
   private int maxDays;
 
   private boolean audit;
@@ -268,6 +270,10 @@ private CloseableHttpResponse handleError(URL url, CloseableHttpResponse respons
     return response;
   }
 
+  public void collectCommitMessage(boolean commitMessage) {
+    this.collectCommitMessage = commitMessage;
+  }
+
   public void setMaxDays(int days) {
     this.maxDays = days;
   }
@@ -381,6 +387,7 @@ That is, find submodules that are available in the working tree (thus `!isBare()
     private JSCommit transform(RevCommit r) throws IOException {
       JSCommit c = new JSCommit();
       c.setCommitHash(r.name());
+      c.setMessage(collectCommitMessage ? r.getFullMessage() : "");
 
       PersonIdent author = r.getAuthorIdent();
       c.setAuthorEmailAddress(JSCommit.hashEmail(author.getEmailAddress()));

src/main/java/com/launchableinc/ingest/commits/CommitGraphCollector.java

@@ -47,10 +47,6 @@ public class CommitIngester {
   @Option(name = "-scrub-pii", usage = "Scrub emails and names", hidden = true)
   public boolean scrubPii;
 
-  /**
-   * @deprecated this is an old option and this is off always.
-   */
-  @Deprecated
   @Option(name = "-commit-message", usage = "Collect commit messages")
   public boolean commitMessage;
 
@@ -145,6 +141,7 @@ void run() throws CmdLineException, IOException {
       cgc.setMaxDays(maxDays);
       cgc.setAudit(audit);
       cgc.setDryRun(dryRun);
+      cgc.collectCommitMessage(commitMessage);
       cgc.transfer(endpoint, authenticator);
       int numCommits = cgc.getCommitsSent();
       String suffix = "commit";

src/main/java/com/launchableinc/ingest/commits/CommitIngester.java

@@ -31,6 +31,9 @@ public class JSCommit {
   /** Time zone offset in minutes. For example, JST is +9:00 so this field is 540. */
   private int committerTimezoneOffset;
 
+  /** Commit message. */
+  private String message;
+
   private Map<String, List<JSFileChange>> parentHashes = new HashMap<>();
 
   public String getCommitHash() {
@@ -96,4 +99,12 @@ public Map<String, List<JSFileChange>> getParentHashes() {
   public static String hashEmail(String email) {
     return EMAIL_HASHER.newHasher().putString(email, StandardCharsets.UTF_8).hash().toString();
   }
+
+  public String getMessage() {
+    return message;
+  }
+
+  public void setMessage(String message) {
+    this.message = message;
+  }
 }

src/main/java/com/launchableinc/ingest/commits/JSCommit.java

@@ -178,6 +178,14 @@ def setUp(self):
                 self.workspace),
             json={'keys': ["GITHUB_ACTOR", "BRANCH_NAME"]},
             status=200)
+        responses.add(
+            responses.GET,
+            "{}/intake/organizations/{}/workspaces/{}/commits/collect/options".format(
+                get_base_url(),
+                self.organization,
+                self.workspace),
+            json={'commitMessage': True},
+            status=200)
 
     def get_test_files_dir(self):
         file_name = Path(inspect.getfile(self.__class__))  # obtain the file of the concrete type

tests/cli_test_case.py

@@ -111,6 +111,14 @@ def test_record_build(self):
         host, port = success_server.server_address
         endpoint = "http://{}:{}".format(host, port)
         with mock.patch.dict(os.environ, {BASE_URL_KEY: endpoint}):
+            responses.add(
+                responses.GET,
+                "{}/intake/organizations/{}/workspaces/{}/commits/collect/options".format(
+                    get_base_url(),
+                    self.organization,
+                    self.workspace),
+                json={'commitMessage': True},
+                status=200)
             responses.add(responses.POST, "{base}/intake/organizations/{org}/workspaces/{ws}/builds".format(
                 base=get_base_url(), org=self.organization, ws=self.workspace), status=500)
             tracking = responses.add(
@@ -137,6 +145,14 @@ def test_record_build(self):
         endpoint = "http://{}:{}".format(host, port)
 
         with mock.patch.dict(os.environ, {BASE_URL_KEY: endpoint}):
+            responses.add(
+                responses.GET,
+                "{}/intake/organizations/{}/workspaces/{}/commits/collect/options".format(
+                    get_base_url(),
+                    self.organization,
+                    self.workspace),
+                json={'commitMessage': True},
+                status=200)
             responses.add(responses.POST, "{base}/intake/organizations/{org}/workspaces/{ws}/builds".format(
                 base=get_base_url(), org=self.organization, ws=self.workspace), status=500)
             tracking = responses.add(