Merge lp:~mikemc/unity-scope-click/log-improvements into lp:unity-scope-click

[Mike McCracken]

- Add timestamps to log messages and ensure that all debug() messages are written to disk.

- Add timestamps to log messages and ensure that all debug() messages are written to disk.

Adds timestamps to messages - both those written to screen if G_MESSAGES_DEBUG=all is set, and to those written to ~/.cache/unity-scope-click.log

Fixes typo in makefile to correctly set G_LOG_DOMAIN, and uses domain to ensure that log file only gets sent messages from our code.

[lp:~mikemc/unity-scope-click/log-improvements]

100. By Mike McCracken on 2014-01-06

Tag as fixing bug LP: #1266583

[dobey (dobey)]

30 - Log.set_handler ("unity-scope-click", LogLevelFlags.LEVEL_MASK,
31 + Log.set_handler (null, LogLevelFlags.LEVEL_MASK,

I don't understand why you made this change. You want log messages from all the underlying libraries to go to the file too?

53 internal async Unity.Preview build_app_preview(Unity.ScopeResult result) {
54 + debug ("build_app_preview");
55 var app_id = result.metadata.get(METADATA_APP_ID).get_string();

Different spacing here on the added line.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:99
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/142/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/40
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/40

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/142/rebuild

review: Approve (continuous-integration)

[lp:~mikemc/unity-scope-click/log-improvements]

101. By Mike McCracken on 2014-01-06

fix G_LOG_DOMAIN typo, revert to using unity-scope-click as domain for custom handler. Fix whitespace issue.

[Mike McCracken (mikemc)]

@dobey, Thanks for pointing out the hole in my understanding of the log domain. Fixed that, now the file only contains messages from the unity-scope-click domain.

[dobey (dobey)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:100
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/143/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/41
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/41

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/143/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:101
http://jenkins.qa.ubuntu.com/job/unity-scope-click-ci/144/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-amd64-ci/42
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-click-trusty-armhf-ci/42

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scope-click-ci/144/rebuild

review: Approve (continuous-integration)

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2013-12-18 19:19:12 +0000
+++ src/Makefile.am	2014-01-06 22:37:10 +0000
@@ -3,7 +3,7 @@
 	-g -w \
 	$(COVERAGE_CFLAGS) \
 	-DGETTEXT_PACKAGE=\"$(GETTEXT_PACKAGE)\" \
-	-D_LOG_DOMAIN=\"unity-scope-click\" \
+	-DG_LOG_DOMAIN=\"unity-scope-click\" \
 	$(SCOPE_DAEMON_CFLAGS) \
 	$(OTHERS_CFLAGS) \
 	-I$(srcdir) \
 
=== modified file 'src/click-scope-main.vala'
--- src/click-scope-main.vala	2013-12-05 20:35:45 +0000
+++ src/click-scope-main.vala	2014-01-06 22:37:10 +0000
@@ -42,14 +42,18 @@
 								  LogLevelFlags level,
 								  string message)
 {
-	Log.default_handler (domain, level, message);
+    var now = new DateTime.now_local ();
+    string timestamp = now.format ("%T");
+    var msg = "%s: %s".printf(timestamp, message);
+
+    Log.default_handler (domain, level, msg);
 
     try {
         var log_stream = log_file.append_to (FileCreateFlags.NONE);
 
         if (log_stream != null) {
-            string log_message = "[%s] - %s: %s\n".printf(
-                domain, _level_string (level), message);
+            string log_message = "%-7s %s: %s\n".printf(
+                _level_string (level), timestamp, message);
             log_stream.write (log_message.data);
             log_stream.flush ();
             log_stream.close ();
 
=== modified file 'src/click-scope.vala'
--- src/click-scope.vala	2013-12-24 00:33:07 +0000
+++ src/click-scope.vala	2014-01-06 22:37:10 +0000
@@ -55,8 +55,10 @@
     }
 
     public override void run_async (Unity.AbstractPreviewCallback async_callback) {
+        debug ("ClickPreviewer: run_async()");
         scope.build_default_preview.begin(result, (obj, res) => {
             var preview = scope.build_default_preview.end(res);
+            debug ("ClickPreviewer: run_async() done, calling async_callback");
             async_callback (this, preview);
         });
     }
@@ -113,6 +115,7 @@
   }
 
   internal async Unity.Preview build_app_preview(Unity.ScopeResult result) {
+    debug ("build_app_preview");
     var app_id = result.metadata.get(METADATA_APP_ID).get_string();
     try {
         var details = yield webservice.get_details(app_id);
@@ -136,8 +139,10 @@
     }
 
     public async virtual Unity.Preview build_uninstalled_preview (Unity.ScopeResult result) {
+        Unity.Preview preview = yield build_app_preview (result);
+        debug ("build_uninstalled_preview");
+
         var price = result.metadata.get(METADATA_PRICE).get_double();
-        Unity.Preview preview = yield build_app_preview (result);
         if (!(preview is Unity.GenericPreview)) {
             if (price == 0.0f) {
                 preview.add_action (new Unity.PreviewAction (ACTION_INSTALL_CLICK, ("Install"), null));
@@ -149,10 +154,12 @@
     }
 
     public async virtual Unity.Preview build_installed_preview (Unity.ScopeResult result, string application_uri) {
-        var app_id = result.metadata.get(METADATA_APP_ID).get_string();
         Unity.Preview preview = yield build_app_preview (result);
+        debug ("build_installed_preview");
+
         preview.add_action (new Unity.PreviewAction (ACTION_OPEN_CLICK + ":" + application_uri, ("Open"), null));
 
+        var app_id = result.metadata.get(METADATA_APP_ID).get_string();
         if (yield click_if.can_uninstall (app_id)) {
             preview.add_action (new Unity.PreviewAction (ACTION_UNINSTALL_CLICK, ("Uninstall"), null));
         }
@@ -161,7 +168,7 @@
 
     public async virtual Unity.Preview build_installing_preview (Unity.ScopeResult result, string progress_source) {
         Unity.Preview preview = yield build_app_preview (result);
-
+        debug ("build_installing_preview");
         // When the progressbar is shown by the preview in the dash no buttons should be shown.
         // The two following actions (marked with ***) are not shown as buttons, but instead are triggered by the dash
         // when the download manager succeeds or fails with a given download+installation.
@@ -287,6 +294,7 @@
 
         MainLoop mainloop = new MainLoop ();
         activate_async.begin(result, metadata, action_id, (obj, res) => {
+            debug ("activate_async: done.");
             response = activate_async.end(res);
             mainloop.quit ();
         });