Technical debt (#248)

* technical debt

.golangci.yml

@@ -6,16 +6,16 @@ run:
     - tmp/stream
 linters:
   enable:
-    - deadcode
     - gofmt
     - goimports
-    - varcheck
-    - errcheck
     - gosimple
     - ineffassign
-  #   - staticcheck
-  #   - structcheck
-  #   - unused
-  #   - govet
+  #  - deadcode
+  #  - varcheck
+  #  - errcheck
+  #  - staticcheck
+  #  - structcheck
+  #  - unused
+  #  - govet
   disable-all: true
-go: '1.18'
+go: '1.20'

Makefile

@@ -75,7 +75,7 @@ test:
 	go test -race $(go list ./... | grep -v /tests/)
 
 install_linter:
-	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $$(go env GOPATH)/bin v1.45.0
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $$(go env GOPATH)/bin v1.55.2
 
 lint-todo:
 	@echo MARK: make lint todo

Makefile.local

@@ -77,7 +77,7 @@ test:
 	go test -race $(go list ./... | grep -v /tests/)
 
 install_linter:
-	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $$(go env GOPATH)/bin v1.45.0
+	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $$(go env GOPATH)/bin v1.55.2
 
 lint-todo:
 	@echo MARK: make lint todo

adaptors/action.go

@@ -20,13 +20,14 @@ package adaptors
 
 import (
 	"context"
-	"github.com/e154/smart-home/system/orm"
 	"time"
 
+	"gorm.io/gorm"
+
 	"github.com/e154/smart-home/common"
 	"github.com/e154/smart-home/db"
 	m "github.com/e154/smart-home/models"
-	"gorm.io/gorm"
+	"github.com/e154/smart-home/system/orm"
 )
 
 // IAction ...

adaptors/entity.go

@@ -22,16 +22,16 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"github.com/e154/smart-home/system/orm"
 	"strings"
 
-	"github.com/e154/smart-home/common/apperr"
 	"github.com/pkg/errors"
 	"gorm.io/gorm"
 
 	"github.com/e154/smart-home/common"
+	"github.com/e154/smart-home/common/apperr"
 	"github.com/e154/smart-home/db"
 	m "github.com/e154/smart-home/models"
+	"github.com/e154/smart-home/system/orm"
 )
 
 // IEntity ...

adaptors/image.go

@@ -20,10 +20,12 @@ package adaptors
 
 import (
 	"context"
+
+	"gorm.io/gorm"
+
 	"github.com/e154/smart-home/common"
 	"github.com/e154/smart-home/db"
 	m "github.com/e154/smart-home/models"
-	"gorm.io/gorm"
 )
 
 // IImage ...

adaptors/run_history.go

@@ -57,19 +57,20 @@ func GetRunHistoryAdaptor(d *gorm.DB) IRunHistory {
 func (n *RunHistory) Add(ctx context.Context, story *m.RunStory) (id int64, err error) {
 
 	var dbVer *db.RunStory
-	dbVer, err = n.toDb(story)
-	if id, err = n.table.Add(ctx, dbVer); err != nil {
+	if dbVer, err = n.toDb(story); err != nil {
 		return
 	}
-
+	id, err = n.table.Add(ctx, dbVer)
 	return
 }
 
 // Update ...
 func (n *RunHistory) Update(ctx context.Context, story *m.RunStory) (err error) {
 
 	var dbVer *db.RunStory
-	dbVer, err = n.toDb(story)
+	if dbVer, err = n.toDb(story); err != nil {
+		return
+	}
 	err = n.table.Update(ctx, dbVer)
 	return
 }

adaptors/script.go

@@ -20,10 +20,12 @@ package adaptors
 
 import (
 	"context"
+	"sort"
+
+	"gorm.io/gorm"
+
 	"github.com/e154/smart-home/db"
 	m "github.com/e154/smart-home/models"
-	"gorm.io/gorm"
-	"sort"
 )
 
 // IScript ...

adaptors/task.go

@@ -21,11 +21,12 @@ package adaptors
 import (
 	"context"
 	"fmt"
-	"github.com/e154/smart-home/system/orm"
+
+	"gorm.io/gorm"
 
 	"github.com/e154/smart-home/db"
 	m "github.com/e154/smart-home/models"
-	"gorm.io/gorm"
+	"github.com/e154/smart-home/system/orm"
 )
 
 // ITask ...

adaptors/trigger.go

@@ -21,14 +21,14 @@ package adaptors
 import (
 	"context"
 	"encoding/json"
-	"github.com/e154/smart-home/system/orm"
 	"time"
 
-	"github.com/e154/smart-home/common"
+	"gorm.io/gorm"
 
+	"github.com/e154/smart-home/common"
 	"github.com/e154/smart-home/db"
 	m "github.com/e154/smart-home/models"
-	"gorm.io/gorm"
+	"github.com/e154/smart-home/system/orm"
 )
 
 // ITrigger ...

api/api.go

@@ -106,10 +106,11 @@ func (a *Api) Start() (err error) {
 
 	a.echo.HideBanner = true
 	a.echo.HidePort = true
-	a.echo.Use(middleware.GzipWithConfig(middleware.GzipConfig{
-		Level: -1,
-	}))
-	a.echo.Use(middleware.Decompress())
+
+	if a.cfg.Gzip {
+		a.echo.Use(middleware.GzipWithConfig(middleware.DefaultGzipConfig))
+		a.echo.Use(middleware.Decompress())
+	}
 
 	a.registerHandlers()
 

api/config.go

@@ -27,6 +27,7 @@ type Config struct {
 	Swagger  bool
 	Debug    bool
 	Pprof    bool
+	Gzip     bool
 }
 
 // String ...

api/dto/role.go

@@ -111,9 +111,7 @@ func (r Role) GetStubRole(from *m.Role) (to stub.ApiRole) {
 		for levelName, levels := range from.AccessList {
 			if len(levels) > 0 {
 				var items []string
-				for _, item := range levels {
-					items = append(items, item)
-				}
+				items = append(items, levels...)
 				if _, ok := to.AccessList.Levels[levelName]; !ok {
 					to.AccessList.Levels[levelName] = stub.AccessListListOfString{
 						Items: items,

cmd/server/commands/backup.go

@@ -39,7 +39,7 @@ var (
 				logger *logging.Logging,
 				backup *backup.Backup) {
 
-				if err := backup.New(); err != nil {
+				if err := backup.New(false); err != nil {
 					log.Error(err.Error())
 				}
 			}))

cmd/server/container/api.go

@@ -33,5 +33,6 @@ func NewApiConfig(cfg *models.AppConfig) api.Config {
 		Swagger:  cfg.ApiSwagger,
 		Pprof:    cfg.Pprof,
 		Debug:    cfg.ApiDebug,
+		Gzip:     cfg.ApiGzip,
 	}
 }

cmd/server/container/init.go

@@ -50,5 +50,6 @@ func MigrationList(adaptors *adaptors.Adaptors,
 		local_migrations.NewMigrationJavascriptV2(adaptors),
 		local_migrations.NewMigrationTimezone(adaptors),
 		local_migrations.NewMigrationSpeedtest(adaptors),
+		local_migrations.NewMigrationBackup(adaptors),
 	}
 }

common/common.go

@@ -93,3 +93,16 @@ func Dir() string {
 	dir = strings.Replace(dir, "+/", "", -1)
 	return dir
 }
+
+func IsRunningInDockerContainer() bool {
+	// docker creates a .dockerenv file at the root
+	// of the directory tree inside the container.
+	// if this file exists then the viewer is running
+	// from inside a container so return true
+
+	if _, err := os.Stat("/.dockerenv"); err == nil {
+		return true
+	}
+
+	return false
+}

common/events/backup.go

@@ -18,8 +18,11 @@
 
 package events
 
+import "github.com/e154/smart-home/common"
+
 type EventCreatedBackup struct {
-	Name string `json:"name"`
+	Name      string `json:"name"`
+	Scheduler bool   `json:"scheduler"`
 }
 
 type EventRemovedBackup struct {
@@ -33,3 +36,18 @@ type EventUploadedBackup struct {
 type EventStartedRestore struct {
 	Name string `json:"name"`
 }
+
+type CommandCreateBackup struct {
+	Scheduler bool `json:"scheduler"`
+}
+
+type CommandClearStorage struct {
+	Num int64 `json:"num"`
+}
+
+type CommandSendFileToTelegram struct {
+	Filename  string          `json:"filename"`
+	EntityId  common.EntityId `json:"entity_id"`
+	Chunks    bool            `json:"chunks"`
+	ChunkSize int             `json:"chunk_size"`
+}

common/location/location.go

@@ -21,6 +21,7 @@ package location
 import (
 	"encoding/json"
 	"fmt"
+
 	"github.com/golang/geo/s1"
 	"github.com/golang/geo/s2"
 

common/location/location_test.go

@@ -19,11 +19,12 @@
 package location
 
 import (
-	m "github.com/e154/smart-home/models"
 	"math"
 	"testing"
 
 	"github.com/stretchr/testify/require"
+
+	m "github.com/e154/smart-home/models"
 )
 
 func TestGetDistanceBetweenPoints(t *testing.T) {

common/web/digest.go

@@ -147,7 +147,7 @@ func (d *DigestHeaders) Auth(username string, password string, uri string) (*Dig
 		d.Username = username
 		d.Password = password
 
-		req, err = http.NewRequest("GET", uri, nil)
+		req, _ = http.NewRequest("GET", uri, nil)
 		d.ApplyAuth(req)
 		resp, err = client.Do(req)
 		if err != nil {

conf/config.dev.json

@@ -29,6 +29,7 @@
   "api_http_port": 3011,
   "api_swagger": true,
   "api_debug": false,
+  "api_gzip": false,
   "pprof": false,
   "domain": "localhost",
   "https": false

db/entity.go

@@ -337,10 +337,10 @@ func (n Entities) DeleteScripts(ctx context.Context, id common.EntityId) (err er
 }
 
 // PreloadStorage ...
-//todo: fix
-// temporary solution because Preload("Storage", func(db *gorm.DB) *gorm.DB { - does not work ...
 func (n Entities) PreloadStorage(ctx context.Context, list []*Entity) (err error) {
 
+	//todo: fix
+	// temporary solution because Preload("Storage", func(db *gorm.DB) *gorm.DB { - does not work ...
 	for _, item := range list {
 		err = n.Db.WithContext(ctx).Model(&EntityStorage{}).
 			Order("created_at desc").

db/entity_storage.go

@@ -84,7 +84,7 @@ func (n *EntityStorages) List(ctx context.Context, limit, offset int, orderBy, s
 
 	q := n.Db.WithContext(ctx).Model(&EntityStorage{})
 
-	if entityIds != nil && len(entityIds) > 0 {
+	if len(entityIds) > 0 {
 		var ids = make([]string, 0, len(entityIds))
 		for _, id := range entityIds {
 			ids = append(ids, id.String())

db/variable.go

@@ -23,11 +23,11 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/pkg/errors"
 	"gorm.io/gorm"
 
 	"github.com/e154/smart-home/common"
 	"github.com/e154/smart-home/common/apperr"
-	"github.com/pkg/errors"
 )
 
 // Variables ...
@@ -60,7 +60,11 @@ func (n Variables) Add(ctx context.Context, variable Variable) (err error) {
 
 // CreateOrUpdate ...
 func (n *Variables) CreateOrUpdate(ctx context.Context, v Variable) (err error) {
-	if n.Db.WithContext(ctx).Model(&v).Where("name = ?", v.Name).Updates(&v).RowsAffected == 0 {
+	params := map[string]interface{}{
+		"name":  v.Name,
+		"value": v.Value,
+	}
+	if n.Db.WithContext(ctx).Model(&v).Where("name = ?", v.Name).Updates(params).RowsAffected == 0 {
 		err = n.Db.WithContext(ctx).Create(&v).Error
 	}
 	return

doc/content/en/docs/plugins/notify/telegram.md

@@ -41,7 +41,11 @@ msg.entity_id = 'telegram.name';
 msg.attributes = {
   'body': 'some text msg',
   'chat_id': 123456,
-  'keys': ['foo', 'bar']
+  'keys': ['foo', 'bar'],
+  'photo_uri': ['foo', 'bar'],
+  'photo_path': ['foo', 'bar'],
+  'file_path': ['foo', 'bar'],
+  'file_uri': ['foo', 'bar']
 };
 
 ```
@@ -57,6 +61,10 @@ attributes:
 | body |  Type: string,  message body   |
 | chat_id | Type: int64,  user's id  |
 | keys |  Type: []string, keyboard   |
+| photo_uri |  Type: []string, image   |
+| photo_path |  Type: []string, image   |
+| file_path |  Type: []string, file   |
+| file_uri |  Type: []string, file   |
 
 ----------------