adding error log to api (Along with admin error log display)

Author: orthecreedence

config/config.default.lisp

@@ -58,6 +58,7 @@
 
 (defparameter *public-actions*
   `((:post . "/api/users")
+    (:post . "/api/log/error")
     (:get . ,(cl-ppcre:create-scanner "/api/invites/codes/([0-9a-f-]+)")))
   "A list of public resources/actions that do not require authentication.")
 

config/schema.lisp

@@ -45,7 +45,8 @@
                        (list (:attr s "user_id")
                              (:attr s "type")
                              (:attr s "id") )))
-        :rel (:version 1 :multi t))))
+        :rel (:version 1 :multi t)))
+    :log (:indexes (:hash (:version 1))))
   "Holds our entire db/table/index schema. Tables are are created if they don't
    exist. Indexes are also created/updated if they don't exist or if the version
    doesn't match. Index names store the version in them, ie the index `user_id`

controllers/admin.lisp

@@ -7,7 +7,10 @@
 (defroute (:get "/admin") (req res)
   "Get the admin page, populated with our data."
   (catch-errors (res)
+    ;(setf *admin-page* (file-contents (concatenate 'string (namestring *root*) "views/admin.html")))
     (alet* ((admin-stats (get-admin-stats))
-            (html (populate-stats *admin-page* admin-stats)))
+            (admin-log (get-logs 200))
+            (html (populate-stats *admin-page* admin-stats))
+            (html (populate-log html admin-log)))
       (send-response res :body html))))
 

controllers/log.lisp

@@ -0,0 +1,9 @@
+(in-package :turtl)
+
+(defroute (:post "/api/log/error") (req res)
+  "Log a client error. Used for debugging."
+  (catch-errors (res)
+    (alet* ((log-data (post-var req "data"))
+            (nil (add-log log-data)))
+      (send-json res "logged."))))
+

models/admin.lisp

@@ -18,6 +18,33 @@
         ;; write stat to string
         (format nil "~a" stat)))))
 
+(defun populate-log (html logs)
+  "Push the given logs into the admin HTML."
+  (let ((log-html (with-output-to-string (s)
+                    (loop for entry across logs do
+                      (let* ((log-data (gethash "data" entry))
+                             (url (gethash "url" log-data)))
+                        (format s "
+<li>
+  <div class=\"summary\">
+    <span class=\"count\">~a</span>
+    <span class=\"id\">~a</span>
+    <span class=\"file\">~a:~a</span>
+  </div>
+  <div class=\"expanded\">
+    ~a
+  </div>
+</li>"
+                                (round (gethash "c" entry))
+                                (gethash "id" entry)
+                                url
+                                (gethash "line" log-data)
+                                (gethash "msg" log-data)))))))
+    (cl-ppcre:regex-replace
+      "{{logs}}"
+      html
+      log-html)))
+
 (defafun get-admin-stats (future) ()
   "Grab statistics for the admin page."
   (macrolet ((count-not-deleted (table)

models/log.lisp

@@ -0,0 +1,45 @@
+(in-package :turtl)
+
+(defun hash-log (log-data)
+  "Generate a hash for this log from its data. Used to de-dupe log records."
+  (md5 (concatenate 'string (gethash "msg" log-data) (gethash "url" log-data) (gethash "line" log-data))))
+
+(defafun get-logs (future) (num-entries)
+  "Get N log entries. Please never add a controller interface to this without
+   resticting it."
+  (alet* ((sock (db-sock))
+          (query (r:r
+                   (:limit
+                     (:order-by
+                       (:table "log")
+                       (:desc "c"))
+                     num-entries)))
+          (cursor (r:run sock query))
+          (entries (r:to-array sock cursor)))
+    (r:stop/disconnect sock cursor)
+    (finish future entries)))
+
+(defafun add-log (future) (log-data)
+  "Add a log entry to the DB."
+  (alet* ((log-hash (hash-log log-data))
+          (log-entry (let ((hash (make-hash-table :test #'equal)))
+                       (setf (gethash "id" hash) log-hash
+                             (gethash "data" hash) log-data
+                             (gethash "created" hash) (get-timestamp)
+                             (gethash "c" hash) 1)
+                       hash))
+          (sock (db-sock))
+          (query (r:r
+                   (:replace
+                     (:get (:table "log") log-hash)
+                     (r:fn (x)
+                       (:branch
+                         (:== (:default x 0) 0)
+                         log-entry
+                         (:merge
+                           x
+                           `(("c" . ,(:+ (:attr x "c") 1)))))))))
+          (res (r:run sock query)))
+    (r:disconnect sock)
+    (finish future res)))
+

turtl.asd

@@ -52,6 +52,7 @@
      (:file "messages")
      (:file "invites")
      (:file "sync")
+     (:file "log")
      (:file "admin")
      (:file "analytics")
      (:file "feedback")))
@@ -71,7 +72,8 @@
      (:file "sync")
      (:file "users")
      (:file "keychain")
-     (:file "feedback")))
+     (:file "feedback")
+     (:file "log")))
    (:file "routes" :depends-on (lib "init" controllers "crypto" "errors"))
    (:file "init-thread" :depends-on (lib "init" "routes"))))
 

views/admin.html

@@ -5,27 +5,72 @@
 		<meta http-equiv="Content-Language" content="en">
 		<title>Turtl admin dashboard</title>
 		<style type="text/css">
+			.clearMe {display: block; height: 0; clear: both; font-size: 0;}
+			.clear:after {content: "."; display: block; height: 0; clear: both; visibility: hidden;}
+			.clear {display: inline-block;}
+			/* hide IE mac \*/
+			* html .clear {height: 1%;}
+			.clear {display: block;}
+			/* */
+
 			body {font-size: 14px; font-family: arial; color: #222; background: #fff;}
 			header h1 {font-size: 64px; font-weight: normal; color: #999; text-transform: lowercase;}
 			header h1 small {font-size: 14px;}
+			h2 {font-weight: normal; color: #777;}
 			div.admin {width: 960px; margin: 0 auto;}
-			ul.stats {margin: 0; padding: 0; list-style: none;}
+			ul.stats {margin: 0 0 32px 0; padding: 0; list-style: none;}
 			ul.stats li {float: left; display: block; width: 132px; height: 132px; margin: 0 16px 16px 0; padding: 16px; font-size: 17px; color: #666; text-align: center; background: #f4f4f4;}
 			ul.stats li span {display: block; margin: 32px 0 0 0; font-size: 32px; color: #79a;}
+			ul.logs {list-style: none; margin: 0; padding: 0;}
+			ul.logs li {}
+			ul.logs li:hover .summary {background: #f4fff4;}
+			ul.logs li:nth-child(2n) {background: #f4f4f4;}
+			ul.logs li .summary {padding: 4px; cursor: pointer; font-family: Consolas, "Liberation Mono", Courier, monospace;}
+			ul.logs li .summary .count {display: inline-block; width: 32px;}
+			ul.logs li .summary .id {display: inline-block; width: 64px; margin: 0 12px -4px 0; overflow: hidden; text-overflow: ellipsis;}
+			ul.logs li .expanded {display: none; padding: 16px;}
+			ul.logs li.open .expanded {display: block;}
 		</style>
 	</head>
 	<body>
 		<div class="admin">
 			<header>
 				<h1>Turtl. <small>admin</small></h1>
 			</header>
-			<ul class="stats">
+			<ul class="stats clear">
 				<li>Users <span>{{stat:num-users}}</span></li>
 				<li>Personas <span>{{stat:num-personas}}</span></li>
 				<li>Personas no RSA <span>{{stat:num-personas-wo-rsa}}</span></li>
 				<li>Boards <span>{{stat:num-boards}}</span></li>
 				<li>Notes <span>{{stat:num-notes}}</span></li>
 			</ul>
+
+			<h2>Error log</h2>
+			<ul class="logs">
+				{{logs}}
+			</ul>
 		</div>
+		<script>
+			(function() {
+				var ul = document.getElementsByClassName('logs')[0];
+				var lis = ul.children;
+				for(var i = 0; i < lis.length; i++)
+				{
+					(function (li) {
+						var summary = li.children[0];
+						summary.addEventListener('click', function() {
+							if(li.className.match(/open/))
+							{
+								li.className = li.className.replace(/open/, '');
+							}
+							else
+							{
+								li.className += 'open';
+							}
+						}, false);
+					})(lis[i]);
+				}
+			})();
+		</script>
 	</body>
 </html>