Merge pull request #223 from erizocosmico/feature/logs

*: add logging

Author: erizocosmico

Gopkg.lock

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"fmt"
 	"os"
 
 	"github.com/jessevdk/go-flags"
@@ -13,8 +12,8 @@ const (
 
 func main() {
 	parser := flags.NewNamedParser(name, flags.Default)
-	parser.AddCommand("server", "Start SQL server.", "", &CmdServer{})
-	parser.AddCommand("version", "Show the version information.", "", &CmdVersion{})
+	parser.AddCommand("server", "Start SQL server.", "", &cmdServer{})
+	parser.AddCommand("version", "Show the version information.", "", &cmdVersion{})
 
 	_, err := parser.Parse()
 	if err != nil {
@@ -25,15 +24,3 @@ func main() {
 		os.Exit(1)
 	}
 }
-
-type cmd struct {
-	Verbose bool `short:"v" description:"Activates the verbose mode"`
-}
-
-func (c *cmd) print(format string, a ...interface{}) {
-	if !c.Verbose {
-		return
-	}
-
-	fmt.Printf(format, a...)
-}

cmd/gitbase/main.go

@@ -5,6 +5,8 @@ import (
 	"os"
 	"strconv"
 
+	"github.com/sirupsen/logrus"
+
 	"github.com/src-d/gitbase"
 	"github.com/src-d/gitbase/internal/function"
 	"github.com/src-d/gitbase/internal/rule"
@@ -19,9 +21,8 @@ import (
 // not be empty.
 var enableUnstableSquash = os.Getenv("UNSTABLE_SQUASH_ENABLE") != ""
 
-// CmdServer defines server command
-type CmdServer struct {
-	cmd
+type cmdServer struct {
+	Verbose bool `short:"v" description:"Activates the verbose mode"`
 
 	Git      string `short:"g" long:"git" description:"Path where the git repositories are located, one per dir"`
 	Host     string `short:"h" long:"host" default:"localhost" description:"Host where the server is going to listen"`
@@ -34,12 +35,14 @@ type CmdServer struct {
 	name   string
 }
 
-func (c *CmdServer) buildDatabase() error {
+func (c *cmdServer) buildDatabase() error {
 	if c.engine == nil {
 		c.engine = sqle.New()
 	}
 
-	c.print("opening %q repository...\n", c.Git)
+	if c.Git != "" {
+		logrus.WithField("dir", c.Git).Debug("added folder containing git repositories")
+	}
 
 	var err error
 
@@ -51,18 +54,25 @@ func (c *CmdServer) buildDatabase() error {
 	}
 
 	c.engine.AddDatabase(gitbase.NewDatabase(c.name))
+	logrus.WithField("db", c.name).Debug("registered database to catalog")
 	c.engine.Catalog.RegisterFunctions(function.Functions)
+	logrus.Debug("registered all available functions in catalog")
 
 	if enableUnstableSquash {
+		logrus.Warn("unstable squash tables rule is enabled")
 		c.engine.Analyzer.AddRule(rule.SquashJoinsRule, rule.SquashJoins)
 	}
 
 	return nil
 }
 
-// Execute starts the server
-func (c *CmdServer) Execute(args []string) error {
+func (c *cmdServer) Execute(args []string) error {
+	if c.Verbose {
+		logrus.SetLevel(logrus.DebugLevel)
+	}
+
 	if err := c.buildDatabase(); err != nil {
+		logrus.WithField("error", err).Fatal("unable to start database server")
 		return err
 	}
 
@@ -85,5 +95,7 @@ func (c *CmdServer) Execute(args []string) error {
 		return err
 	}
 
+	logrus.Debug("starting server")
+
 	return s.Start()
 }

cmd/gitbase/server.go

@@ -1,16 +1,15 @@
 package main
 
-import (
-	"fmt"
-)
+import "fmt"
 
-var version string
-var build string
+var (
+	version string
+	build   string
+)
 
-type CmdVersion struct{}
+type cmdVersion struct{}
 
-func (c *CmdVersion) Execute(args []string) error {
+func (c *cmdVersion) Execute(args []string) error {
 	fmt.Printf("%s (%s) - build %s\n", name, version, build)
-
 	return nil
 }

cmd/gitbase/version.go

@@ -1,6 +1,7 @@
 package gitbase
 
 import (
+	"fmt"
 	"io"
 	"path/filepath"
 	"strings"
@@ -12,6 +13,8 @@ import (
 	"gopkg.in/src-d/go-git.v4/plumbing/object"
 	"gopkg.in/src-d/go-git.v4/plumbing/storer"
 	"gopkg.in/src-d/go-mysql-server.v0/sql"
+
+	"github.com/sirupsen/logrus"
 )
 
 // ChainableIter is an iterator meant to have a chaining-friendly API.
@@ -391,6 +394,10 @@ func (i *refIter) Advance() error {
 		}
 
 		if ref.Type() != plumbing.HashReference {
+			logrus.WithFields(logrus.Fields{
+				"type": ref.Type(),
+				"ref":  ref.Name(),
+			}).Debug("ignoring reference, it's not a hash reference")
 			continue
 		}
 
@@ -507,6 +514,10 @@ func (i *repoRefsIter) Advance() error {
 		}
 
 		if ref.Type() != plumbing.HashReference {
+			logrus.WithFields(logrus.Fields{
+				"type": ref.Type(),
+				"ref":  ref.Name(),
+			}).Debug("ignoring reference, it's not a hash reference")
 			continue
 		}
 
@@ -630,6 +641,10 @@ func (i *remoteRefsIter) Advance() error {
 		}
 
 		if ref.Type() != plumbing.HashReference {
+			logrus.WithFields(logrus.Fields{
+				"type": ref.Type(),
+				"ref":  ref.Name(),
+			}).Debug("ignoring reference, it's not a hash reference")
 			continue
 		}
 
@@ -799,6 +814,10 @@ func (i *refCommitsIter) Advance() error {
 			_, err = resolveCommit(i.repo, i.refs.Ref().Hash())
 			if err != nil {
 				if errInvalidCommit.Is(err) {
+					logrus.WithFields(logrus.Fields{
+						"ref":  i.refs.Ref().Name(),
+						"hash": i.refs.Ref().Hash(),
+					}).Debug("skipping reference, it's not pointing to a commit")
 					continue
 				}
 
@@ -904,6 +923,10 @@ func (i *refHeadCommitsIter) Advance() error {
 		i.commit, err = resolveCommit(i.repo, i.refs.Ref().Hash())
 		if err != nil {
 			if errInvalidCommit.Is(err) {
+				logrus.WithFields(logrus.Fields{
+					"ref":  i.refs.Ref().Name(),
+					"hash": i.refs.Ref().Hash(),
+				}).Debug("skipping reference, it's not pointing to a commit")
 				continue
 			}
 			return err
@@ -1619,6 +1642,10 @@ func resolveCommit(repo *git.Repository, hash plumbing.Hash) (*object.Commit, er
 	case *object.Tag:
 		return resolveCommit(repo, obj.Target)
 	default:
+		logrus.WithFields(logrus.Fields{
+			"hash": hash,
+			"type": fmt.Sprintf("%T", obj),
+		}).Debug("expecting hash to belong to a commit object")
 		return nil, errInvalidCommit.New(obj)
 	}
 }

iterator.go

@@ -3,6 +3,7 @@ package gitbase
 import (
 	"strings"
 
+	"github.com/sirupsen/logrus"
 	"gopkg.in/src-d/go-mysql-server.v0/sql"
 
 	"gopkg.in/src-d/go-git.v4/plumbing"
@@ -154,6 +155,10 @@ func (i *referenceIter) Next() (sql.Row, error) {
 		}
 
 		if o.Type() != plumbing.HashReference {
+			logrus.WithFields(logrus.Fields{
+				"type": o.Type(),
+				"ref":  o.Name(),
+			}).Debug("ignoring reference, it's not a hash reference")
 			continue
 		}
 
@@ -224,6 +229,10 @@ func (i *filteredReferencesIter) Next() (sql.Row, error) {
 		}
 
 		if o.Type() != plumbing.HashReference {
+			logrus.WithFields(logrus.Fields{
+				"type": o.Type(),
+				"ref":  o.Name(),
+			}).Debug("ignoring reference, it's not a hash reference")
 			continue
 		}
 

references.go

@@ -7,6 +7,7 @@ import (
 	"runtime"
 	"sync"
 
+	"github.com/sirupsen/logrus"
 	"gopkg.in/src-d/go-git.v4"
 	"gopkg.in/src-d/go-mysql-server.v0/sql"
 )
@@ -83,8 +84,11 @@ func (p *RepositoryPool) AddDir(path string) error {
 	for _, f := range dirs {
 		if f.IsDir() {
 			name := filepath.Join(path, f.Name())
-			// TODO: log that the repo could not be opened
-			p.AddGit(name)
+			if _, err := p.AddGit(name); err != nil {
+				logrus.WithField("path", name).Error("repository could not be opened")
+			} else {
+				logrus.WithField("path", name).Debug("repository added")
+			}
 		}
 	}
 

repository_pool.go

@@ -4,6 +4,7 @@ import (
 	"sync"
 	"time"
 
+	"github.com/sirupsen/logrus"
 	"google.golang.org/grpc/connectivity"
 	bblfsh "gopkg.in/bblfsh/client-go.v2"
 	errors "gopkg.in/src-d/go-errors.v1"
@@ -79,12 +80,16 @@ func (s *Session) BblfshClient() (*bblfsh.Client, error) {
 			return s.bblfshClient, nil
 		case connectivity.Connecting:
 			attempts = 0
+			logrus.WithField("attempts", totalAttempts).
+				Debug("bblfsh is connecting, sleeping 100ms")
 			time.Sleep(100 * time.Millisecond)
 		default:
 			if err := s.bblfshClient.Close(); err != nil {
 				return nil, err
 			}
 
+			logrus.Debug("bblfsh connection is closed, opening a new one")
+
 			s.bblfshClient, err = bblfsh.NewClient(s.bblfshEndpoint)
 			if err != nil {
 				return nil, err
@@ -98,6 +103,9 @@ func (s *Session) BblfshClient() (*bblfsh.Client, error) {
 
 // Close implements the io.Closer interface.
 func (s *Session) Close() error {
+	s.bblfshMu.Lock()
+	defer s.bblfshMu.Unlock()
+
 	if s.bblfshClient != nil {
 		return s.bblfshClient.Close()
 	}