Log using goa

Author: matteosuppo

.gitignore

@@ -1,7 +1,7 @@
 
 bufferflow_tinyg_old.md
 
-serial-port-json-server
+arduino-create-agent
 
 snapshot/*
 public/

design/tools.go

@@ -5,7 +5,7 @@ import . "goa.design/goa/dsl"
 var _ = Service("tools", func() {
 	Description("The tools service managed the tools installed in the system.")
 	Method("list", func() {
-		Result(Tool)
+		Result(CollectionOf(Tool))
 		HTTP(func() {
 			GET("/tools")
 			Response(StatusOK)

gen/http/openapi.json

@@ -1 +1 @@
-{"swagger":"2.0","info":{"title":"Arduino Create Agent","description":"A companion of Arduino Create. \n\tAllows the website to perform operations on the user computer, \n\tsuch as detecting which boards are connected and upload sketches on them.","version":""},"host":"localhost:80","basePath":"/v2","consumes":["application/json","application/xml","application/gob"],"produces":["application/json","application/xml","application/gob"],"paths":{"/tools":{"get":{"tags":["tools"],"summary":"list tools","operationId":"tools#list","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/ToolsListResponseBody"}}},"schemes":["http"]}}},"definitions":{"ToolsListResponseBody":{"title":"Mediatype identifier: application/vnd.arduino.tool; view=default","type":"object","properties":{"name":{"type":"string","description":"The name of the tool","example":"avrdude"},"packager":{"type":"string","description":"The packager of the tool","example":"arduino"},"version":{"type":"string","description":"The version of the tool","example":"6.3.0-arduino9"}},"description":"ListResponseBody result type (default view)","example":{"name":"avrdude","packager":"arduino","version":"6.3.0-arduino9"},"required":["name","version","packager"]}}}
+{"swagger":"2.0","info":{"title":"Arduino Create Agent","description":"A companion of Arduino Create. \n\tAllows the website to perform operations on the user computer, \n\tsuch as detecting which boards are connected and upload sketches on them.","version":""},"host":"localhost:80","basePath":"/v2","consumes":["application/json","application/xml","application/gob"],"produces":["application/json","application/xml","application/gob"],"paths":{"/tools":{"get":{"tags":["tools"],"summary":"list tools","operationId":"tools#list","responses":{"200":{"description":"OK response.","schema":{"$ref":"#/definitions/ToolsToolResponseCollection"}}},"schemes":["http"]}}},"definitions":{"ToolResponse":{"title":"Mediatype identifier: application/vnd.arduino.tool; view=default","type":"object","properties":{"name":{"type":"string","description":"The name of the tool","example":"avrdude"},"packager":{"type":"string","description":"The packager of the tool","example":"arduino"},"version":{"type":"string","description":"The version of the tool","example":"6.3.0-arduino9"}},"description":"A tool is an executable program that can upload sketches. (default view)","example":{"name":"avrdude","packager":"arduino","version":"6.3.0-arduino9"},"required":["name","version","packager"]},"ToolsToolResponseCollection":{"title":"Mediatype identifier: application/vnd.arduino.tool; type=collection; view=default","type":"array","items":{"$ref":"#/definitions/ToolResponse"},"description":"ListResponseBody is the result type for an array of ToolResponse (default view)","example":[{"name":"avrdude","packager":"arduino","version":"6.3.0-arduino9"},{"name":"avrdude","packager":"arduino","version":"6.3.0-arduino9"}]}}}

gen/http/openapi.yaml

@@ -26,11 +26,11 @@ paths:
         "200":
           description: OK response.
           schema:
-            $ref: '#/definitions/ToolsListResponseBody'
+            $ref: '#/definitions/ToolsToolResponseCollection'
       schemes:
       - http
 definitions:
-  ToolsListResponseBody:
+  ToolResponse:
     title: 'Mediatype identifier: application/vnd.arduino.tool; view=default'
     type: object
     properties:
@@ -46,7 +46,8 @@ definitions:
         type: string
         description: The version of the tool
         example: 6.3.0-arduino9
-    description: ListResponseBody result type (default view)
+    description: A tool is an executable program that can upload sketches. (default
+      view)
     example:
       name: avrdude
       packager: arduino
@@ -55,3 +56,17 @@ definitions:
     - name
     - version
     - packager
+  ToolsToolResponseCollection:
+    title: 'Mediatype identifier: application/vnd.arduino.tool; type=collection; view=default'
+    type: array
+    items:
+      $ref: '#/definitions/ToolResponse'
+    description: ListResponseBody is the result type for an array of ToolResponse
+      (default view)
+    example:
+    - name: avrdude
+      packager: arduino
+      version: 6.3.0-arduino9
+    - name: avrdude
+      packager: arduino
+      version: 6.3.0-arduino9

gen/http/tools/client/encode_decode.go

@@ -1,23 +1,45 @@
 package v2
 
 import (
+	"context"
 	"net/http"
 
+	"github.com/Sirupsen/logrus"
 	toolssvr "github.com/arduino/arduino-create-agent/gen/http/tools/server"
 	toolssvc "github.com/arduino/arduino-create-agent/gen/tools"
 	"github.com/arduino/arduino-create-agent/v2/tools"
 	goahttp "goa.design/goa/http"
+	"goa.design/goa/http/middleware"
 )
 
 func Server() http.Handler {
 	mux := goahttp.NewMuxer()
 
+	// Instantiate logger
+	logger := logrus.New()
+	logAdapter := LogAdapter{Logger: logger}
+
 	// Mount tools
 	toolsSvc := tools.Tools{}
 	toolsEndpoints := toolssvc.NewEndpoints(&toolsSvc)
 
-	toolsServer := toolssvr.New(toolsEndpoints, mux, goahttp.RequestDecoder, goahttp.ResponseEncoder, nil)
+	toolsServer := toolssvr.New(toolsEndpoints, mux, goahttp.RequestDecoder, goahttp.ResponseEncoder, errorHandler(logger))
 	toolssvr.Mount(mux, toolsServer)
 
-	return mux
+	// Mount middlewares
+	handler := middleware.Log(logAdapter)(mux)
+	handler = middleware.RequestID()(handler)
+
+	return handler
+}
+
+// errorHandler returns a function that writes and logs the given error.
+// The function also writes and logs the error unique ID so that it's possible
+// to correlate.
+func errorHandler(logger *logrus.Logger) func(context.Context, http.ResponseWriter, error) {
+	return func(ctx context.Context, w http.ResponseWriter, err error) {
+		id := ctx.Value(middleware.RequestIDKey).(string)
+		w.Write([]byte("[" + id + "] encoding: " + err.Error()))
+		logger.Printf("[%s] ERROR: %s", id, err.Error())
+	}
 }