chore: fix linting

Author: TristanSpeakEasy

.golangci.yaml

@@ -41,4 +41,11 @@ issues:
     - EXC0014
     - EXC0015
 run:
-  go: "1.14"
+  go: "1.18"
+linters-settings:
+  tagliatelle:
+    case:
+      use-field-name: true
+      rules:
+        json: snake
+        yaml: camel

cmd/server/main.go

@@ -13,7 +13,6 @@ import (
 	httptransport "github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/transport/http"
 	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/users"
 	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/users/store"
-
 	"go.uber.org/zap"
 )
 

config/config-docker.yaml

@@ -1,8 +1,4 @@
 http:
   port: "8080"
 psql:
-  username: guest
-  password: guest
-  host: postgres
-  port: 5432
-  database: speakeasy
+  dsn: "postgresql://guest:guest@postgres:5432/speakeasy?sslmode=disable"

config/config.yaml

@@ -1,8 +1,4 @@
 http:
   port: "8080"
 psql:
-  username: guest
-  password: guest
-  host: localhost
-  port: 5432
-  database: speakeasy
+  dsn: "postgresql://guest:guest@localhost:5432/speakeasy?sslmode=disable"

go.mod

@@ -4,6 +4,7 @@ go 1.18
 
 require (
 	github.com/AlekSi/pointer v1.2.0
+	github.com/cenkalti/backoff/v4 v4.1.2
 	github.com/golang-migrate/migrate/v4 v4.15.1
 	github.com/golang/mock v1.6.0
 	github.com/gorilla/mux v1.8.0
@@ -24,7 +25,6 @@ require (
 	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
 	github.com/Microsoft/go-winio v0.5.2 // indirect
 	github.com/Nvveen/Gotty v0.0.0-20120604004816-cd527374f1e5 // indirect
-	github.com/cenkalti/backoff/v4 v4.1.2 // indirect
 	github.com/containerd/continuity v0.2.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/docker/cli v20.10.14+incompatible // indirect

internal/config/config.go

@@ -2,17 +2,16 @@ package config
 
 import "github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/config"
 
-// Config represents the configuration of our application
+// Config represents the configuration of our application.
 type Config struct {
 	config.AppConfig `yaml:",inline"`
 }
 
-// Load loads the configuration from the config/config.yaml file
+// Load loads the configuration from the config/config.yaml file.
 func Load() (*Config, error) {
 	cfg := &Config{}
 
-	err := config.Load(cfg)
-	if err != nil {
+	if err := config.Load(cfg); err != nil {
 		return nil, err
 	}
 

internal/core/app/app.go

@@ -2,50 +2,59 @@ package app
 
 import (
 	"context"
+	"log"
 	"os"
 	"os/signal"
 	"sync"
 	"syscall"
 
 	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/logging"
 	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/tracing"
-
 	"go.uber.org/zap"
 )
 
+// Listener represents a type that can listen for incoming connections.
 type Listener interface {
 	Listen(context.Context) error
 }
 
+// OnShutdownFunc is a function that is called when the app is shutdown.
 type OnShutdownFunc func()
 
+// App represents the application run by this service.
 type App struct {
 	Name          string
 	shutdownFuncs []OnShutdownFunc
 }
 
+// OnStart is a function that is called when the app is started.
 type OnStart func(context.Context, *App) ([]Listener, error)
 
+// Start starts the application.
 func Start(onStart OnStart) {
 	ctx := context.Background()
 
 	a := &App{
 		Name: "test-app", // TODO determine how to configure this
 	}
 	a.OnShutdown(func() {
-		logging.Sync(ctx)
+		if err := logging.Sync(ctx); err != nil {
+			log.Printf("failed to sync logging: %v", err)
+		}
 	})
 
 	logging.From(ctx).Info("app starting...")
 
-	tracing.EnableTracing(ctx, a.Name, a)
+	if err := tracing.EnableTracing(ctx, a.Name, a); err != nil {
+		logging.From(ctx).Fatal("failed to enable tracing", zap.Error(err))
+	}
 
 	listeners, err := onStart(ctx, a)
 	if err != nil {
 		logging.From(ctx).Fatal("failed to start app", zap.Error(err))
 	}
 
-	c := make(chan os.Signal)
+	c := make(chan os.Signal, 1)
 	signal.Notify(c, os.Interrupt, syscall.SIGTERM)
 	go func() {
 		<-c
@@ -73,6 +82,7 @@ func Start(onStart OnStart) {
 	shutdown(ctx, a)
 }
 
+// OnShutdown registers a function that is called when the app is shutdown.
 func (a *App) OnShutdown(onShutdown func()) {
 	a.shutdownFuncs = append([]OnShutdownFunc{onShutdown}, a.shutdownFuncs...)
 }

internal/core/config/config.go

@@ -6,20 +6,23 @@ import (
 	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/drivers/psql"
 	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/errors"
 	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/listeners/http"
-
 	"gopkg.in/yaml.v2"
 )
 
 const (
-	ErrRead      = errors.Error("failed to read file")
+	// ErrRead is returned when we cannot read the config file.
+	ErrRead = errors.Error("failed to read file")
+	// ErrUnmarshal is returned when we cannot unmarshal the config file.
 	ErrUnmarshal = errors.Error("failed to unmarshal file")
 )
 
+// AppConfig represents the configuration of our application.
 type AppConfig struct {
 	HTTP http.Config `yaml:"http"`
 	PSQL psql.Config `yaml:"psql"`
 }
 
+// Load loads the configuration from a yaml file on disk.
 func Load(cfg interface{}) error {
 	data, err := ioutil.ReadFile("config/config.yaml") // TODO support different environments
 	if err != nil {

internal/core/drivers/psql/migrations.go

@@ -3,22 +3,23 @@ package psql
 import (
 	"context"
 
-	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/errors"
-	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/logging"
-
 	"github.com/golang-migrate/migrate/v4"
 	"github.com/golang-migrate/migrate/v4/database/postgres"
-
-	// import file driver for migrate
-	_ "github.com/golang-migrate/migrate/v4/source/file"
+	_ "github.com/golang-migrate/migrate/v4/source/file" // import file driver for migrate
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/errors"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/logging"
 )
 
 const (
-	ErrDriverInit  = errors.Error("failed to initialize postgres driver")
+	// ErrDriverInit is returned when we cannot initialize the driver.
+	ErrDriverInit = errors.Error("failed to initialize postgres driver")
+	// ErrMigrateInit is returned when we cannot initialize the migrate driver.
 	ErrMigrateInit = errors.Error("failed to initialize migration driver")
-	ErrMigration   = errors.Error("failed to migrate database")
+	// ErrMigration is returned when we cannot run a migration.
+	ErrMigration = errors.Error("failed to migrate database")
 )
 
+// MigratePostgres migrates the database to the latest version.
 func (d *Driver) MigratePostgres(ctx context.Context, migrationsPath string) error {
 	driver, err := postgres.WithInstance(d.db.DB, &postgres.Config{})
 	if err != nil {
@@ -43,6 +44,7 @@ func (d *Driver) MigratePostgres(ctx context.Context, migrationsPath string) err
 	return nil
 }
 
+// RevertMigrations reverts the database to the previous version.
 func (d *Driver) RevertMigrations(ctx context.Context, migrationsPath string) error {
 	driver, err := postgres.WithInstance(d.db.DB, &postgres.Config{})
 	if err != nil {

internal/core/drivers/psql/psql.go

@@ -2,40 +2,40 @@ package psql
 
 import (
 	"context"
-	"fmt"
-
-	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/errors"
 
 	"github.com/jmoiron/sqlx"
-	_ "github.com/lib/pq"
+	_ "github.com/lib/pq" // imports the postgres driver
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/errors"
 )
 
 const (
+	// ErrConnect is returned when we cannot connect to the database.
 	ErrConnect = errors.Error("failed to connect to postgres db")
-	ErrClose   = errors.Error("failed to close postgres db connection")
+	// ErrClose is returned when we cannot close the database.
+	ErrClose = errors.Error("failed to close postgres db connection")
 )
 
+// Config represents the configuration for our postgres database.
 type Config struct {
-	Username string `yaml:"username"` // TODO get these from secrets in the future
-	Password string `yaml:"password"` // TODO get these from secrets in the future
-	Host     string `yaml:"host"`
-	Port     string `yaml:"port"`
-	Database string `yaml:"database"`
+	DSN string `yaml:"dsn"` // TODO get this  from secrets in the future
 }
 
+// Driver provides an implementation for connecting to a postgres database.
 type Driver struct {
 	cfg Config
 	db  *sqlx.DB
 }
 
+// New instantiates a instance of the Driver.
 func New(cfg Config) *Driver {
 	return &Driver{
 		cfg: cfg,
 	}
 }
 
+// Connect connects to the database.
 func (d *Driver) Connect(ctx context.Context) error {
-	db, err := sqlx.Connect("postgres", fmt.Sprintf("postgresql://%s:%s@%s:%s/%s?sslmode=disable", d.cfg.Username, d.cfg.Password, d.cfg.Host, d.cfg.Port, d.cfg.Database))
+	db, err := sqlx.Connect("postgres", d.cfg.DSN)
 	if err != nil {
 		return ErrConnect.Wrap(err)
 	}
@@ -45,6 +45,7 @@ func (d *Driver) Connect(ctx context.Context) error {
 	return nil
 }
 
+// Close closes the database connection.
 func (d *Driver) Close(ctx context.Context) error {
 	if err := d.db.Close(); err != nil {
 		return ErrClose.Wrap(err)
@@ -53,6 +54,7 @@ func (d *Driver) Close(ctx context.Context) error {
 	return nil
 }
 
+// GetDB returns the underlying database connection.
 func (d *Driver) GetDB() *sqlx.DB {
 	return d.db
 }