Merge pull request #2 from factorio-item-browser/feature/better-error-messages

feature/better-error-messages

Author: BluePsyduck

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.1.0 - 2020-12-02
+
+### Changed
+
+- Moved output in case of an error to stderr, so stdout stays empty if no final image can be rendered.
+- Error message now contains more details, e.g. which file caused it.
+
 ## 1.0.0 - 2020-04-24
 
 - Initial release of the icon renderer, as port of the PHP implementation.

cmd/render-icon/render-icon.go

@@ -1,18 +1,21 @@
 package main
 
 import (
+	"encoding/json"
 	"fmt"
-	"github.com/factorio-item-browser/export-icon-renderer/pkg/command"
 	"github.com/factorio-item-browser/export-icon-renderer/pkg/env"
+	"github.com/factorio-item-browser/export-icon-renderer/pkg/log"
+	"github.com/factorio-item-browser/export-icon-renderer/pkg/render"
+	"github.com/factorio-item-browser/export-icon-renderer/pkg/transfer"
 	"os"
 )
 
 const usage = `Factorio Item Browser - Export Icon Renderer 
 Version: %s
 
-Usage: render-icon icon_definition
-    icon_definition: The JSON string defining the icon and its layers to render. This string must represent an Icon of
-                     the factorio-item-browser/export-data PHP package.
+Usage: render-icon <icon_definition>
+    <icon_definition>: The JSON string defining the icon and its layers to render. This string must represent an Icon
+                       of the factorio-item-browser/export-data PHP package.
 
 Environment variables:
     FACTORIO_DATA_DIRECTORY: The data directory of the Factorio game, containing the base and core mods.
@@ -22,17 +25,24 @@ Environment variables:
 
 func main() {
 	if len(os.Args) < 2 {
-		fmt.Printf("Missing icon definition as first argument.\n\n")
-		fmt.Printf(usage, env.Version)
+		logger := log.Logger()
+		logger.Error().Msg("Missing icon definition as first argument.")
+		logger.Info().Msgf(usage, env.Version)
 		os.Exit(1)
 	}
 
-	cmd := command.NewRenderIcon()
-	img, err := cmd.Run(os.Args[1])
+	var icon transfer.Icon
+	err := json.Unmarshal([]byte(os.Args[1]), &icon)
 	if err != nil {
-		fmt.Printf("Failed to render icon: %s\n", err)
+		log.Error(err)
 		os.Exit(1)
 	}
 
-	fmt.Print(img)
+	renderer := render.NewRenderer()
+	image, err := renderer.Render(icon)
+	if err != nil {
+		log.Error(err)
+		os.Exit(1)
+	}
+	fmt.Print(image)
 }

go.mod

@@ -3,6 +3,7 @@ module github.com/factorio-item-browser/export-icon-renderer
 go 1.15
 
 require (
-	github.com/anthonynsimon/bild v0.11.2-0.20200422162521-c58fb61a4c52
-	github.com/stretchr/testify v1.2.2
+	github.com/anthonynsimon/bild v0.13.0
+	github.com/rs/zerolog v1.20.0
+	github.com/stretchr/testify v1.6.1
 )

go.sum

@@ -1,11 +1,13 @@
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/anthonynsimon/bild v0.11.2-0.20200422162521-c58fb61a4c52 h1:FTLTizjeQCP9Rwv/zEIlEqj8dXEaHpIkgPDpZ0/IvwE=
-github.com/anthonynsimon/bild v0.11.2-0.20200422162521-c58fb61a4c52/go.mod h1:tpzzp0aYkAsMi1zmfhimaDyX1xjn2OUc1AJZK/TF0AE=
+github.com/anthonynsimon/bild v0.13.0 h1:mN3tMaNds1wBWi1BrJq0ipDBhpkooYfu7ZFSMhXt1C8=
+github.com/anthonynsimon/bild v0.13.0/go.mod h1:tpzzp0aYkAsMi1zmfhimaDyX1xjn2OUc1AJZK/TF0AE=
 github.com/armon/consul-api v0.0.0-20180202201655-eb2c6b5be1b6/go.mod h1:grANhF5doyWs3UAsr3K4I6qtAmlQcZDesFNEHPZAzj8=
 github.com/coreos/etcd v3.3.10+incompatible/go.mod h1:uF7uidLiAD3TWHmW31ZFd/JWoc32PjwdhPthX9715RE=
 github.com/coreos/go-etcd v2.0.0+incompatible/go.mod h1:Jez6KQU2B/sWsbdaef3ED8NzMklzPG4d5KIOhIy30Tk=
 github.com/coreos/go-semver v0.2.0/go.mod h1:nnelYz7RCh+5ahJtPPxZlU+153eP4D4r3EedlOD2RNk=
+github.com/coreos/go-systemd v0.0.0-20190321100706-95778dfbb74e/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
 github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
@@ -16,8 +18,12 @@ github.com/magiconair/properties v1.8.0/go.mod h1:PppfXfuXeibc/6YijjN8zIbojt8czP
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
+github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rs/xid v1.2.1/go.mod h1:+uKXf+4Djp6Md1KODXJxgGQPKngRmWyn10oCKFzNHOQ=
+github.com/rs/zerolog v1.20.0 h1:38k9hgtUBdxFwE34yS8rTHmHBa4eN16E4DJlv177LNs=
+github.com/rs/zerolog v1.20.0/go.mod h1:IzD0RJ65iWH0w97OQQebJEvTZYvsCUm9WVLWBQrJRjo=
 github.com/russross/blackfriday v1.5.2/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
 github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
 github.com/spf13/cast v1.3.0/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
@@ -27,14 +33,27 @@ github.com/spf13/jwalterweatherman v1.0.0/go.mod h1:cQK4TGJAtQXfYWX+Ddv3mKDzgVb6
 github.com/spf13/pflag v1.0.3 h1:zPAT6CGy6wXeQ7NtTnaTerfKOsV6V6F8agHXFiazDkg=
 github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
 github.com/spf13/viper v1.3.2/go.mod h1:ZiWeW+zYFKm7srdB9IoDzzZXaJaI5eL9QjNiN/DMA2s=
+github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
 github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q=
 golang.org/x/crypto v0.0.0-20181203042331-505ab145d0a9/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/image v0.0.0-20190703141733-d6a02ce849c9 h1:uc17S921SPw5F2gJo7slQ3aqvr2RwpL7eb3+DZncu3s=
 golang.org/x/image v0.0.0-20190703141733-d6a02ce849c9/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
+golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20181205085412-a5c9d58dba9a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/tools v0.0.0-20190828213141-aed303cbaa74/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
+golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/command/rendericon.go

@@ -0,0 +1,67 @@
+package errors
+
+import "fmt"
+
+type InvalidFileNameError struct {
+	fileName string
+}
+
+func NewInvalidFileNameError(fileName string) error {
+	return &InvalidFileNameError{
+		fileName: fileName,
+	}
+}
+
+func (e *InvalidFileNameError) Error() string {
+	return "unable to parse file name"
+}
+
+func (e *InvalidFileNameError) LogFields() map[string]interface{} {
+	return map[string]interface{}{
+		"file": e.fileName,
+	}
+}
+
+type ImageLoadError struct {
+	fileName      string
+	originalError error
+}
+
+func NewImageLoadError(fileName string, originalError error) error {
+	return &ImageLoadError{
+		fileName:      fileName,
+		originalError: originalError,
+	}
+}
+
+func (e *ImageLoadError) Error() string {
+	return fmt.Sprintf("unable to load image: %s", e.originalError)
+}
+
+func (e *ImageLoadError) Unwrap() error {
+	return e.originalError
+}
+
+func (e *ImageLoadError) LogFields() map[string]interface{} {
+	return map[string]interface{}{
+		"file": e.fileName,
+	}
+}
+
+type EncodingError struct {
+	originalError error
+}
+
+func NewEncodingError(originalError error) error {
+	return &EncodingError{
+		originalError: originalError,
+	}
+}
+
+func (e *EncodingError) Error() string {
+	return fmt.Sprintf("unable to encode image: %s", e.originalError)
+}
+
+func (e *EncodingError) Unwrap() error {
+	return e.originalError
+}

pkg/errors/image.go

@@ -0,0 +1,49 @@
+package errors
+
+import (
+	"errors"
+	"fmt"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestInvalidFileNameError(t *testing.T) {
+	fileName := "abc"
+	expectedMessage := "unable to parse file name"
+	expectedLogFields := map[string]interface{}{
+		"file": "abc",
+	}
+
+	err := NewInvalidFileNameError(fileName)
+
+	assert.IsType(t, &InvalidFileNameError{}, err)
+	assert.Exactly(t, expectedMessage, err.Error())
+	assert.Exactly(t, expectedLogFields, err.(*InvalidFileNameError).LogFields())
+}
+
+func TestImageLoadError(t *testing.T) {
+	fileName := "abc"
+	originalError := fmt.Errorf("test error")
+	expectedMessage := "unable to load image: test error"
+	expectedLogFields := map[string]interface{}{
+		"file": "abc",
+	}
+
+	err := NewImageLoadError(fileName, originalError)
+
+	assert.IsType(t, &ImageLoadError{}, err)
+	assert.Exactly(t, expectedMessage, err.Error())
+	assert.Exactly(t, originalError, errors.Unwrap(err))
+	assert.Exactly(t, expectedLogFields, err.(*ImageLoadError).LogFields())
+}
+
+func TestEncodingError(t *testing.T) {
+	originalError := fmt.Errorf("test error")
+	expectedMessage := "unable to encode image: test error"
+
+	err := NewEncodingError(originalError)
+
+	assert.IsType(t, &EncodingError{}, err)
+	assert.Exactly(t, expectedMessage, err.Error())
+	assert.Exactly(t, originalError, errors.Unwrap(err))
+}

pkg/errors/image_test.go

@@ -0,0 +1,29 @@
+package errors
+
+import "fmt"
+
+type RenderIconError struct {
+	iconId        string
+	originalError error
+}
+
+func NewRenderIconError(iconId string, originalError error) error {
+	return &RenderIconError{
+		iconId:        iconId,
+		originalError: originalError,
+	}
+}
+
+func (e *RenderIconError) Error() string {
+	return fmt.Sprintf("render icon error: %s", e.originalError)
+}
+
+func (e *RenderIconError) Unwrap() error {
+	return e.originalError
+}
+
+func (e *RenderIconError) LogFields() map[string]interface{} {
+	return map[string]interface{}{
+		"icon": e.iconId,
+	}
+}

pkg/errors/render.go

@@ -0,0 +1,24 @@
+package errors
+
+import (
+	"errors"
+	"fmt"
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestRenderIconError(t *testing.T) {
+	iconId := "abc"
+	originalError := fmt.Errorf("test error")
+	expectedMessage := "render icon error: test error"
+	expectedLogFields := map[string]interface{}{
+		"icon": "abc",
+	}
+
+	err := NewRenderIconError(iconId, originalError)
+
+	assert.IsType(t, &RenderIconError{}, err)
+	assert.Exactly(t, expectedMessage, err.Error())
+	assert.Exactly(t, originalError, errors.Unwrap(err))
+	assert.Exactly(t, expectedLogFields, err.(*RenderIconError).LogFields())
+}