Add comments to all public methods in go.

Author: Reasno

pkg/config/config.go

@@ -8,6 +8,8 @@ const phpGet = "Reasno\\GoTask\\Wrapper\\ConfigWrapper::get"
 const phpSet = "Reasno\\GoTask\\Wrapper\\ConfigWrapper::set"
 const phpHas = "Reasno\\GoTask\\Wrapper\\ConfigWrapper::has"
 
+// Get retrieves a configuration from PHP, and fallback to the second parameter
+// if a config is missing at PHP's end.
 func Get(key string, fallback interface{}) (value interface{}, err error) {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
@@ -23,6 +25,7 @@ func Get(key string, fallback interface{}) (value interface{}, err error) {
 	return value, nil
 }
 
+// Has checks if a configuration exists in PHP
 func Has(key string) (value bool, err error) {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
@@ -35,6 +38,7 @@ func Has(key string) (value bool, err error) {
 	return value, nil
 }
 
+// Set sets a configuration in PHP
 func Set(key string, val interface{}) (err error) {
 	client, err := gotask.NewAutoClient()
 	if err != nil {

pkg/gotask/client.go

@@ -15,19 +15,23 @@ type Pool struct {
 
 var globalPool *Pool
 
+//SetGo2PHPAddress sets the go2php server socket address
 func SetGo2PHPAddress(address string) {
 	*go2phpAddress = address
 }
 
+//GetGo2PHPAddress retrieves the go2php server socket address
 func GetGo2PHPAddress() string {
 	return *go2phpAddress
 }
 
+//NewAutoPool creates a connection pool using pre-defined addresses
 func NewAutoPool() (*Pool, error) {
 	addresses := strings.Split(*go2phpAddress, ",")
 	return NewPool(addresses)
 }
 
+//NewPool creates a connection pool
 func NewPool(addresses []string) (*Pool, error) {
 	index := 0
 	factory := func() (net.Conn, error) {
@@ -42,10 +46,12 @@ func NewPool(addresses []string) (*Pool, error) {
 	}, nil
 }
 
+// Client represents a client for go2php IPC.
 type Client struct {
 	*rpc.Client
 }
 
+// NewAutoClient creates a client connected to predefined connection pool.
 func NewAutoClient() (c *Client, err error) {
 	if globalPool == nil {
 		globalPool, err = NewAutoPool()
@@ -61,6 +67,7 @@ func NewAutoClient() (c *Client, err error) {
 	return c, nil
 }
 
+// NewClient returns a new Client using the connection provided.
 func NewClient(conn net.Conn) *Client {
 	return &Client{
 		Client: rpc.NewClientWithCodec(goridge.NewClientCodec(conn)),

pkg/gotask/server.go

@@ -14,6 +14,8 @@ import (
 	"time"
 )
 
+var g run.Group
+
 func checkProcess(pid int, quit chan bool) {
 	if *standalone {
 		return
@@ -46,7 +48,7 @@ func GetAddress() string {
 
 // Run the sidecar, receive any fatal errors.
 func Run() error {
-	var g run.Group
+
 	if *listenOnPipe {
 		relay := goridge.NewPipeRelay(os.Stdin, os.Stdout)
 		codec := goridge.NewCodecWithRelay(relay)
@@ -112,3 +114,13 @@ func Run() error {
 
 	return g.Run()
 }
+
+// Add an actor (function) to the group. Each actor must be pre-emptable by an
+// interrupt function. That is, if interrupt is invoked, execute should return.
+// Also, it must be safe to call interrupt even after execute has returned.
+//
+// The first actor (function) to return interrupts all running actors.
+// The error is passed to the interrupt functions, and is returned by Run.
+func Add(execute func() error, interrupt func(error)) {
+	g.Add(execute, interrupt)
+}

pkg/log/log.go

@@ -6,126 +6,148 @@ import (
 
 const phpLog = "Reasno\\GoTask\\Wrapper\\LoggerWrapper::log"
 
-func Emergency(message string, context map[string]interface{}) error {
+// C is a type for passing PSR context.
+type C map[string]interface{}
+
+// Map returns itself
+func (c C) Map() map[string]interface{} {
+	return c
+}
+
+// Mapper is an interface for PSR Context
+type Mapper interface {
+	Map() map[string]interface{}
+}
+
+// Emergency logger
+func Emergency(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "emergency",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Alert(message string, context map[string]interface{}) error {
+// Alert logger
+func Alert(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "alert",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Critical(message string, context map[string]interface{}) error {
+// Critical logger
+func Critical(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "critical",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Error(message string, context map[string]interface{}) error {
+// Error logger
+func Error(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "error",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Warning(message string, context map[string]interface{}) error {
+// Warning logger
+func Warning(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "warning",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Notice(message string, context map[string]interface{}) error {
+// Notice logger
+func Notice(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "notice",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Info(message string, context map[string]interface{}) error {
+// Info logger
+func Info(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "info",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Debug(message string, context map[string]interface{}) error {
+// Debug logger
+func Debug(message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   "debug",
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)
 	return err
 }
 
-func Log(level string, message string, context map[string]interface{}) error {
+// Log logs a message at any given level
+func Log(level string, message string, context Mapper) error {
 	client, err := gotask.NewAutoClient()
 	if err != nil {
 		return err
 	}
 	payload := map[string]interface{}{
 		"level":   level,
-		"context": context,
+		"context": context.Map(),
 		"message": message,
 	}
 	err = client.Call(phpLog, payload, nil)

pkg/log/log_test.go

@@ -6,7 +6,7 @@ import (
 )
 
 func testInfo(t *testing.T) {
-	err := Info("hello", map[string]interface{}{
+	err := Info("hello", C{
 		"Some": "Value",
 	})
 	if err != nil {