Merge pull request #398 from testmycode/analytics

Add analytics and refactor system design

Author: irenenikk

README.md

@@ -81,9 +81,14 @@ Once installation is complete, you can log in using `tmc login`. This saves your
 server address:
 username:
 password:
-Login successful.
+Choose organization by writing its slug:
+Do you want to send crash reports for client development? (Y/n)
+Do you want to send analytics data for research? (Y/n)
 ```
 
+You can change your organization with the command `organization`. Use the option `-o` and give the slug of an organization as an argument. Otherwise all available organizations will be listed.
+You can inspect and change your settings such as sending data with the command `config`. Use the option `-l` to see your current settings and give `[KEY]=[NEW VALUE]` as arguments to change them.
+
 ## Listing courses
 
 Once you have logged in, you can list all the available courses on the server with `tmc courses`.
@@ -96,7 +101,7 @@ c-mooc
 javascript-for-lazy-hipsters
 ```
 
-Note that you can only submit exercises on courses for which you have enrolled.
+Note that you can only exercises on courses for which you have enrolled.
 
 ## Downloading courses
 
@@ -127,7 +132,7 @@ All tests passed! Submit to server with 'tmc submit'
 
 ## Submitting exercises
 
-You have now completed your first exercise! To submit your exercise, run `tmc submit`. The syntax is the same as for running tests.
+You have now completed your first exercise! To submit your exercise, run `tmc submit [exercise-name]` or run `tmc submit` in an exercise directory. The syntax is the same as for running tests.
 
 ```
 ~/tmc-courses/test-course/exercise1 $ tmc submit

docs/MANUAL.md

@@ -126,12 +126,10 @@ COMMAND: SUBMIT
 `tmc` `submit` [`-a`] [`-d`] [`-c`] [*path*] ...
 
 Submit exercises to the server. If no *path* is given, the exercise in the
-current working directory will be submitted. Several exercises can be submitted
-at once. If the current work directory is the course root directory or the
-course root directory was given as a *path*, then all exercises will be submitted.
+current working directory will be submitted. The submittable exercise(s) must be given as an argument.
 
 For every successful submission, you'll be prompted to send feedback for the
-exercise if the course has enabledfeedback questions. Sending feedback is
+exercise if the course has enabled feedback questions. Sending feedback is
 always optional.
 
 `-a` `--all`
@@ -192,7 +190,7 @@ Set or unset TMC-CLI properties. Only accepts certain keys. If not invoked with
   Do not ask for confirmations or print out set values.
 
 `-l` `--list`
-  List all current properties.
+  List all current settings.
 
 `-g` `--get=KEY` or `--get KEY`
   Get the value of a specific key.
@@ -206,8 +204,20 @@ List of configurable settings:
   blue, purple, cyan, white, none. Stored in properties.
 * *send-diagnostics*
   Allow sending crash reports and analytics for client development. Stored with account.
+* *send-analytics*
+  Allow sending analytics data of commands run. Stored in account.
 * *server-address*
-  Address to fetch courses from and submit to. Defaults to `https://tmc.mooc.fi`. Stored with account
+  Address to fetch courses from and submit to. Defaults to `https://tmc.mooc.fi`. Stored with account. Changing the server address will log the user out and prompt a new login.
+
+COMMAND: ORGANIZATION
+---------------
+
+`tmc` `organization` [`-o`][*slug*] ...
+
+Change organization, which determines the downloadable courses. If no slug is given, or the slug is invalid, all available organizations are listed, and the user will be prompted to choose one.
+
+`-o` `--organization`
+Change organization to slug given as an argument without the listing of all organizations.
 
 ---
 

docs/tmc.1

@@ -34,15 +34,12 @@ with a command, display a help message for that command.
 \l'\n(.lu'
 .SH COMMAND: LOGIN
 .PP
-\fB\fCtmc\fR \fB\fClogin\fR [\fB\fC\-s\fR \fIserver address\fP] [\fB\fC\-u\fR \fIusername\fP] [\fB\fC\-p\fR \fIpassword\fP]
+\fB\fCtmc\fR \fB\fClogin\fR [\fB\fC\-u\fR \fIusername\fP] [\fB\fC\-p\fR \fIpassword\fP]
 .PP
 Login to TMC server. If credentials are not given as options, the user will
 be asked to input any missing credentials. You will have to be logged in
 in order to use certain commands.
 .TP
-\fB\fC\-s\fR \fB\fC\-\-server\fR
-Specify which server to connect to.
-.TP
 \fB\fC\-u\fR \fB\fC\-\-user\fR
 Specify username.
 .TP
@@ -103,12 +100,12 @@ Display more detailed error messages.
 \fB\fCtmc\fR \fB\fCsubmit\fR [\fB\fC\-a\fR] [\fB\fC\-d\fR] [\fB\fC\-c\fR] [\fIpath\fP] ...
 .PP
 Submit exercises to the server. If no \fIpath\fP is given, the exercise in the
-current working directory will be submitted. Several exercises can be submitted
-at once. If the current work directory is the course root directory or the
-course root directory was given as a \fIpath\fP, then all exercises will be submitted.
+current working directory will be submitted. The submittable 
+.BR exercise (s) 
+must be given as an argument.
 .PP
 For every successful submission, you'll be prompted to send feedback for the
-exercise if the course has enabledfeedback questions. Sending feedback is
+exercise if the course has enabled feedback questions. Sending feedback is
 always optional.
 .TP
 \fB\fC\-a\fR \fB\fC\-\-all\fR
@@ -147,36 +144,62 @@ Do not send a message alongside the paste.
 .TP
 \fB\fC\-m\fR \fB\fC\-\-message\fR
 Give the message as an argument instead of opening a text editor.
-.SH COMMAND: PROP
+.SH COMMAND: CONFIG
 .PP
-\fB\fCtmc\fR \fB\fCprop\fR [\fIKEY\fP] [\fIVALUE\fP] ...
-      \fB\fCprop\fR \fB\fC\-u\fR \fIKEY\fP ... 
+\fB\fCtmc\fR \fB\fCconfig\fR \fB\fC[\-q]\fR[\fIKEY=VALUE\fP] ...
+      \fB\fCconfig\fR \fB\fC\-d\fR \fB\fC[\-q]\fR [\fIKEY\fP] ...
+      \fB\fCconfig\fR \fB\fC\-l\fR
+      \fB\fCconfig\fR \fB\fC\-g\fR [\fIKEY\fP] or \fB\fC\-g\fR=[\fIKEY\fP]
 .PP
-Set or unset TMC\-CLI properties. Invoke without any arguments to display all
-current properties. If more than a single property is added or removed, the user
-will be asked to confirm the changes.
+Set or unset TMC\-CLI properties. Only accepts certain keys. If not invoked with the option \fB\fCquiet\fR will ask to confirm changes.
 .TP
-\fB\fC\-u\fR \fB\fC\-\-unset\fR
+\fB\fC\-d\fR \fB\fC\-\-delete\fR
 Unset given properties.
+.TP
+\fB\fC\-q\fR \fB\fC\-\-quiet\fR
+Do not ask for confirmations or print out set values.
+.TP
+\fB\fC\-l\fR \fB\fC\-\-list\fR
+List all current settings.
+.TP
+\fB\fC\-g\fR \fB\fC\-\-get=KEY\fR or \fB\fC\-\-get KEY\fR
+Get the value of a specific key.
 .PP
-List of properties:
+List of configurable settings:
 .RS
 .IP \(bu 2
 \fIupdate\-date\fP
-Scheduled time for the next version check.
+Scheduled time for the next version check. Stored in properties.
 .IP \(bu 2
 \fItestresults\-left\fP \fItestresults\-right\fP \fIprogressbar\-left\fP \fIprogressbar\-right\fP
 Change progress bar colours. Recognised values: black, red, green, yellow,
-blue, purple, cyan, white, none.
+blue, purple, cyan, white, none. Stored in properties.
+.IP \(bu 2
+\fIsend\-diagnostics\fP
+Allow sending crash reports and analytics for client development. Stored with account.
+.IP \(bu 2
+\fIsend\-analytics\fP
+Allow sending analytics data of commands run. Stored in account.
+.IP \(bu 2
+\fIserver\-address\fP
+Address to fetch courses from and submit to. Defaults to \fB\fChttps://tmc.mooc.fi\fR\&. Stored with account.
 .RE
+.SH COMMAND: ORGANIZATION
+.PP
+\fB\fCtmc\fR \fB\fCorganization\fR [\fB\fC\-o\fR][\fIslug\fP] ...
+.PP
+Change organization, which determines the downloadable courses. If no slug is given, or the slug is invalid, all available organizations are listed, and the user will be prompted to choose one.
+.PP
+\fB\fC\-o\fR \fB\fC\-\-organization\fR
+Change organization to slug given as an argument without the listing of all organizations.
 .ti 0
 \l'\n(.lu'
 .SH FILES
 .TP
 \fB\fC[course directory]/.tmc.json\fR
 Course configuration and cache file. Saves the status of the username, server
 address and course's exercises. Manually editing this file may have adverse
-effects.  
+effects.
 .TP
 \fB\fC~/.config/tmc\-cli/properties.json\fR
 User configuration file. Use \fB\fCtmc prop\fR to edit properties.

src/main/java/fi/helsinki/cs/tmc/cli/Application.java

@@ -1,16 +1,29 @@
 package fi.helsinki.cs.tmc.cli;
 
+import fi.helsinki.cs.tmc.cli.analytics.AnalyticsFacade;
+import fi.helsinki.cs.tmc.cli.analytics.TimeTracker;
+import fi.helsinki.cs.tmc.cli.backend.CourseInfo;
+import fi.helsinki.cs.tmc.cli.backend.Settings;
+import fi.helsinki.cs.tmc.cli.command.SubmitCommand;
 import fi.helsinki.cs.tmc.cli.core.AbstractCommand;
 import fi.helsinki.cs.tmc.cli.core.CliContext;
-import fi.helsinki.cs.tmc.cli.core.CommandFactory;
-import fi.helsinki.cs.tmc.cli.io.Color;
-import fi.helsinki.cs.tmc.cli.io.ColorUtil;
+import fi.helsinki.cs.tmc.cli.io.ShutdownHandler;
+import fi.helsinki.cs.tmc.cli.io.Io;
 import fi.helsinki.cs.tmc.cli.io.EnvironmentUtil;
 import fi.helsinki.cs.tmc.cli.io.HelpGenerator;
-import fi.helsinki.cs.tmc.cli.io.Io;
-import fi.helsinki.cs.tmc.cli.io.ShutdownHandler;
+import fi.helsinki.cs.tmc.cli.io.WorkDir;
 import fi.helsinki.cs.tmc.cli.updater.AutoUpdater;
+import fi.helsinki.cs.tmc.cli.core.CommandFactory;
 
+
+import fi.helsinki.cs.tmc.cli.utils.OptionalToGoptional;
+import fi.helsinki.cs.tmc.core.TmcCore;
+import fi.helsinki.cs.tmc.core.holders.TmcSettingsHolder;
+import fi.helsinki.cs.tmc.core.utilities.TmcRequestProcessor;
+import fi.helsinki.cs.tmc.langs.util.TaskExecutor;
+import fi.helsinki.cs.tmc.langs.util.TaskExecutorImpl;
+import fi.helsinki.cs.tmc.spyware.EventSendBuffer;
+import fi.helsinki.cs.tmc.spyware.EventStore;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.GnuParser;
 import org.apache.commons.cli.Option;
@@ -20,14 +33,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.lang.management.ManagementFactory;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.Scanner;
-import java.util.Date;
-import java.util.ArrayList;
-import java.util.Arrays;
+import java.util.*;
 
 /**
  * The application class for the program.
@@ -47,7 +53,10 @@ public class Application {
     private String commandName;
     private boolean noAutoUpdate;
 
+    private TimeTracker timeTracker;
+
     public Application(CliContext context) {
+        this.timeTracker = new TimeTracker(context);
         this.parser = new GnuParser();
         this.options = new Options();
 
@@ -88,11 +97,39 @@ private boolean runCommand(String name, String[] args) {
             io.errorln("Command " + name + " doesn't exist.");
             return false;
         }
+        Optional<Thread> thread = sendAnalytics(command);
 
         command.execute(context, args);
+        joinNewThread(thread);
         return true;
     }
 
+    private Optional<Thread> sendAnalytics(AbstractCommand command) {
+        Optional<Thread> thread = Optional.empty();
+        if (command instanceof SubmitCommand || timeTracker.anHourHasPassedSinceLastSubmit()) {
+            this.context.loadUserInformation(true);
+            // get course info returns null
+            CourseInfo courseInfo = this.context.getCourseInfo();
+            if (courseInfo == null) {
+                return Optional.empty();
+            }
+            TmcSettingsHolder.get().setCourse(OptionalToGoptional.convert(Optional.of(courseInfo.getCourse())));
+            thread = this.context.getAnalyticsFacade().sendAnalytics();
+            timeTracker.restart();
+        }
+        return thread;
+    }
+
+    private void joinNewThread(Optional<Thread> thread) {
+        thread.ifPresent(t -> {
+            try {
+                t.join();
+            } catch (InterruptedException e) {
+                logger.warn("Analytics thread interrupted");
+            }
+        });
+    }
+
     private String[] parseArgs(String[] args) {
         CommandLine line;
         try {
@@ -178,10 +215,16 @@ public void run(String[] args) {
         }
     }
 
-
     public static void main(String[] args) {
-        Application app = new Application(new CliContext(null));
+        Settings settings = new Settings();
+        TaskExecutor tmcLangs = new TaskExecutorImpl();
+        TmcCore core = new TmcCore(settings, tmcLangs);
+        EventSendBuffer eventSendBuffer = new EventSendBuffer(settings, new EventStore());
+        AnalyticsFacade analyticsFacade = new AnalyticsFacade(settings, eventSendBuffer);
+        Application app = new Application(new CliContext(null, core, new WorkDir(), settings, analyticsFacade));
         app.run(args);
+        // Because of EventSendBuffer
+        TmcRequestProcessor.instance.shutdown();
     }
 
     private boolean versionCheck() {
@@ -194,8 +237,8 @@ private boolean versionCheck() {
             try {
                 time = Long.parseLong(previousTimestamp);
             } catch (NumberFormatException ex) {
-                io.errorln("The previous update date isn't number.");
-                logger.warn("The previous update date isn't number.", ex);
+                io.errorln("The previous update date isn't a number.");
+                logger.warn("The previous update date isn't a number.", ex);
                 return false;
             }
             previous = new Date(time);
@@ -217,28 +260,7 @@ public boolean runAutoUpdate() {
         long timestamp = now.getTime();
         properties.put(previousUpdateDateKey, Long.toString(timestamp));
         context.saveProperties();
-
         return updated;
     }
 
-    //TODO rename this as getColorProperty and move it somewhere else
-    public Color getColor(String propertyName) {
-        String propertyValue = context.getProperties().get(propertyName);
-        Color color = ColorUtil.getColor(propertyValue);
-        if (color == null) {
-            switch (propertyName) {
-                case "progressbar-left":
-                    return Color.CYAN;
-                case "progressbar-right":
-                    return Color.CYAN;
-                case "testresults-left":
-                    return Color.GREEN;
-                case "testresults-right":
-                    return Color.RED;
-                default:
-                    return Color.NONE;
-            }
-        }
-        return color;
-    }
 }