Merge pull request #416 from MadAppGang/feature/missing-db-indexes

Feature/missing db indexes
MadAppGang · Jun 27, 2024 · 4164b0e · 4164b0e
2 parents 1386207 + f1921f5
commit 4164b0e
Show file tree

Hide file tree

Showing 18 changed files with 81 additions and 59 deletions.
diff --git a/api_test/main_test.go b/api_test/main_test.go
@@ -8,7 +8,7 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"log"
 	"net/http"
 	"net/http/httputil"
@@ -157,13 +157,13 @@ type (
 
 func validateJSON(validator validatorFunc) assert.Func {
 	return func(res *http.Response, req *http.Request) error {
-		body, err := ioutil.ReadAll(res.Body)
+		body, err := io.ReadAll(res.Body)
 		if err != nil {
 			return err
 		}
 
 		// Re-fill body reader stream after reading it
-		res.Body = ioutil.NopCloser(bytes.NewBuffer(body))
+		res.Body = io.NopCloser(bytes.NewBuffer(body))
 
 		// parse the data
 		var data map[string]interface{}
@@ -174,13 +174,13 @@ func validateJSON(validator validatorFunc) assert.Func {
 
 func validateBodyText(validator validatorFuncText) assert.Func {
 	return func(res *http.Response, req *http.Request) error {
-		body, err := ioutil.ReadAll(res.Body)
+		body, err := io.ReadAll(res.Body)
 		if err != nil {
 			return err
 		}
 
 		// Re-fill body reader stream after reading it
-		res.Body = ioutil.NopCloser(bytes.NewBuffer(body))
+		res.Body = io.NopCloser(bytes.NewBuffer(body))
 
 		return validator(string(body))
 	}

diff --git a/api_test/misconfig_test/main_test.go b/api_test/misconfig_test/main_test.go
@@ -7,7 +7,7 @@ import (
 	"encoding/base64"
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"log"
 	"net/http"
 	"net/http/httptest"
@@ -106,13 +106,13 @@ type validatorFunc = func(map[string]interface{}) error
 
 func validateJSON(validator validatorFunc) assert.Func {
 	return func(res *http.Response, req *http.Request) error {
-		body, err := ioutil.ReadAll(res.Body)
+		body, err := io.ReadAll(res.Body)
 		if err != nil {
 			return err
 		}
 
 		// Re-fill body reader stream after reading it
-		res.Body = ioutil.NopCloser(bytes.NewBuffer(body))
+		res.Body = io.NopCloser(bytes.NewBuffer(body))
 
 		// parse the data
 		var data map[string]interface{}

diff --git a/config/importer.go b/config/importer.go
@@ -1,7 +1,7 @@
 package config
 
 import (
-	"io/ioutil"
+	"io"
 	"os"
 
 	"github.com/madappgang/identifo/v2/model"
@@ -45,5 +45,5 @@ func dataFromFile(filename string) ([]byte, error) {
 		return nil, err
 	}
 	defer file.Close()
-	return ioutil.ReadAll(file)
+	return io.ReadAll(file)
 }
diff --git a/jwt/pem.go b/jwt/pem.go
@@ -10,7 +10,7 @@ import (
 	"encoding/pem"
 	"errors"
 	"fmt"
-	"io/ioutil"
+	"os"
 
 	"github.com/madappgang/identifo/v2/model"
 )
@@ -51,7 +51,7 @@ func LoadPrivateKeyFromPEMString(s string) (interface{}, model.TokenSignatureAlg
 
 // LoadPrivateKeyFromPEM loads private key from PEM file.
 func LoadPrivateKeyFromPEMFile(file string) (interface{}, model.TokenSignatureAlgorithm, error) {
-	prkb, err := ioutil.ReadFile(file)
+	prkb, err := os.ReadFile(file)
 	if err != nil {
 		return nil, model.TokenSignatureAlgorithmInvalid, err
 	}
@@ -82,7 +82,7 @@ func LoadPublicKeyFromString(s string) (interface{}, model.TokenSignatureAlgorit
 
 // LoadPublicKeyFromPEM loads public key from file
 func LoadPublicKeyFromPEM(file string) (interface{}, model.TokenSignatureAlgorithm, error) {
-	prkb, err := ioutil.ReadFile(file)
+	prkb, err := os.ReadFile(file)
 	if err != nil {
 		return nil, model.TokenSignatureAlgorithmInvalid, err
 	}

diff --git a/services/mail/mail.go b/services/mail/mail.go
@@ -112,18 +112,10 @@ func (es *EmailService) Transport() model.EmailTransport {
 }
 
 func (es *EmailService) watch() {
-	for {
-		select {
-		case files, ok := <-es.watcher.WatchChan():
-			// the channel is closed
-			if ok == false {
-				return
-			}
-			for _, f := range files {
-				es.cache.Delete(f)
-				log.Printf("email template changed, the email template cache has been invalidated: %v", f)
-
-			}
+	for files := range es.watcher.WatchChan() {
+		for _, f := range files {
+			es.cache.Delete(f)
+			log.Printf("email template changed, the email template cache has been invalidated: %v", f)
 		}
 	}
 }
diff --git a/services/mail/mock/mock.go b/services/mail/mock/mock.go
@@ -18,15 +18,15 @@ func NewTransport() model.EmailTransport {
 // SendMessage returns nil error.
 func (es *EmailService) SendMessage(subject, body, recipient string) error {
 	msg := fmt.Sprintf("✉️: MOCK EMAIL SERVICE: Sending message \nsubject: %s\nbody: %s\n recipient: %s\n\n", subject, body, recipient)
-	fmt.Printf(msg)
+	fmt.Print(msg)
 	es.SendMessages = append(es.SendMessages, msg)
 	return nil
 }
 
 // SendHTML returns nil error.
 func (es *EmailService) SendHTML(subject, html, recipient string) error {
 	msg := fmt.Sprintf("✉️: MOCK EMAIL SERVICE: Sending HTML \nsubject: %s\nhtml: %s\n recipient: %s\n\n", subject, html, recipient)
-	fmt.Printf(msg)
+	fmt.Print(msg)
 	es.SendMessages = append(es.SendMessages, msg)
 	return nil
 }

diff --git a/services/sms/routemobile/routemobile.go b/services/sms/routemobile/routemobile.go
@@ -2,7 +2,7 @@ package routemobile
 
 import (
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	"net/url"
 	"strings"
@@ -52,7 +52,7 @@ func (ss *SMSService) SendSMS(recipient, message string) error {
 	}
 	defer resp.Body.Close()
 
-	respBytes, err := ioutil.ReadAll(resp.Body)
+	respBytes, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return err
 	}

diff --git a/storage/boltdb/app_test.go b/storage/boltdb/app_test.go
@@ -41,9 +41,10 @@ func TestBoltDBAppCreateApp(t *testing.T) {
 		Path: dbpath,
 	}
 	apps, err := boltdb.NewAppStorage(sts)
-	defer apps.Close()
 	require.NoError(t, err)
 
+	defer apps.Close()
+
 	a, err := apps.CreateApp(testApp)
 	require.NoError(t, err)
 
@@ -64,9 +65,10 @@ func TestBoltDBAppFindAppById(t *testing.T) {
 		Path: dbpath,
 	}
 	apps, err := boltdb.NewAppStorage(sts)
-	defer apps.Close()
 	require.NoError(t, err)
 
+	defer apps.Close()
+
 	testApp2 := testApp
 	testApp2.ID = ""
 
@@ -86,9 +88,10 @@ func TestBoltDBAppFindAppFetchApps(t *testing.T) {
 		Path: dbpath,
 	}
 	apps, err := boltdb.NewAppStorage(sts)
-	defer apps.Close()
 	require.NoError(t, err)
 
+	defer apps.Close()
+
 	a, err := apps.CreateApp(testApp)
 	require.NoError(t, err)
 

diff --git a/storage/fs/config_storage.go b/storage/fs/config_storage.go
@@ -2,7 +2,6 @@ package fs
 
 import (
 	"fmt"
-	"io/ioutil"
 	"log"
 	"os"
 	"path/filepath"
@@ -72,7 +71,7 @@ func (cs *ConfigurationStorage) WriteConfig(settings model.ServerSettings) error
 		return fmt.Errorf("Cannot marshall configuration: %s", err)
 	}
 
-	if err = ioutil.WriteFile(cs.ServerConfigPath, ss, 0o644); err != nil {
+	if err = os.WriteFile(cs.ServerConfigPath, ss, 0o644); err != nil {
 		return fmt.Errorf("Cannot write configuration file: %s", err)
 	}
 
@@ -97,7 +96,7 @@ func (cs *ConfigurationStorage) LoadServerSettings(validate bool) (model.ServerS
 		return model.ServerSettings{}, cs.errors
 	}
 
-	yamlFile, err := ioutil.ReadFile(filepath.Join(dir, cs.ServerConfigPath))
+	yamlFile, err := os.ReadFile(filepath.Join(dir, cs.ServerConfigPath))
 	if err != nil {
 		cs.errors = append(cs.errors, fmt.Errorf("Cannot read server configuration file: %s", err))
 		return model.ServerSettings{}, cs.errors

diff --git a/storage/fs_watcher_test.go b/storage/fs_watcher_test.go
@@ -3,7 +3,6 @@ package storage_test
 import (
 	"bytes"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"strings"
 	"testing"
@@ -152,7 +151,7 @@ func makeFiles() {
 
 func updateFile(name string) {
 	data := fmt.Sprintf("This is file data has been created at: %v", time.Now())
-	_ = ioutil.WriteFile(name, []byte(data), 0o644)
+	_ = os.WriteFile(name, []byte(data), 0o644)
 }
 
 func deleteFiles() {

diff --git a/storage/mem/map_overlay_fs_test.go b/storage/mem/map_overlay_fs_test.go
@@ -11,8 +11,8 @@ import (
 
 func TestNewMapOverlayFS(t *testing.T) {
 	base := afero.NewMemMapFs()
-	afero.WriteFile(base, "./test1.txt", []byte("file1"), 644)
-	afero.WriteFile(base, "./path/test2.txt", []byte("file2"), 644)
+	afero.WriteFile(base, "./test1.txt", []byte("file1"), 0644)
+	afero.WriteFile(base, "./path/test2.txt", []byte("file2"), 0644)
 
 	files := map[string][]byte{
 		"./path/test3.txt": []byte("file3"),

diff --git a/storage/mongo/mongo.go b/storage/mongo/mongo.go
@@ -3,6 +3,7 @@ package mongo
 import (
 	"bytes"
 	"context"
+	"errors"
 	"fmt"
 	"log"
 	"strings"
@@ -80,7 +81,7 @@ func generateIndexName(index mongo.IndexModel) (string, error) {
 
 	keys, ok := index.Keys.(bson.D)
 	if !ok {
-		return "", fmt.Errorf("Incorrect index keys type - expecting bsonx.Doc")
+		return "", errors.New("incorrect index keys type - expecting bsonx.Doc")
 	}
 	for _, elem := range keys {
 		if !first {

diff --git a/storage/mongo/token.go → storage/mongo/token_blacklist.go b/storage/mongo/token.go → storage/mongo/token_blacklist.go
@@ -2,6 +2,7 @@ package mongo
 
 import (
 	"context"
+	"fmt"
 	"time"
 
 	"github.com/madappgang/identifo/v2/model"
@@ -25,6 +26,19 @@ func NewTokenBlacklist(settings model.MongoDatabaseSettings) (model.TokenBlackli
 	}
 
 	coll := db.Database.Collection(blacklistedTokensCollectionName)
+
+	// TODO: check that index exists for other DB's
+	err = db.EnsureCollectionIndices(blacklistedTokensCollectionName, []mongo.IndexModel{
+		{
+			Keys: bson.D{{Key: "token", Value: 1}},
+		},
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to create indexes for %s: %w",
+			blacklistedTokensCollectionName,
+			err)
+	}
+
 	return &TokenBlacklist{coll: coll, timeout: 30 * time.Second}, nil
 }
 

diff --git a/storage/mongo/token_storage.go → storage/mongo/token_refresh.go b/storage/mongo/token_storage.go → storage/mongo/token_refresh.go
@@ -2,6 +2,7 @@ package mongo
 
 import (
 	"context"
+	"fmt"
 	"time"
 
 	"github.com/madappgang/identifo/v2/model"
@@ -25,6 +26,19 @@ func NewTokenStorage(settings model.MongoDatabaseSettings) (model.TokenStorage,
 	}
 
 	coll := db.Database.Collection(tokensCollectionName)
+
+	// TODO: check that index exists for other DB's
+	err = db.EnsureCollectionIndices(tokensCollectionName, []mongo.IndexModel{
+		{
+			Keys: bson.D{{Key: "token", Value: 1}},
+		},
+	})
+	if err != nil {
+		return nil, fmt.Errorf("failed to create indexes for %s: %w",
+			tokensCollectionName,
+			err)
+	}
+
 	return &TokenStorage{coll: coll, timeout: 30 * time.Second}, nil
 }
 

diff --git a/storage/mongo/user.go b/storage/mongo/user.go
@@ -271,7 +271,7 @@ func (us *UserStorage) AddUserWithFederatedID(user model.User, provider string,
 	}
 
 	// unknown error during user existnce check
-	if err != nil && !errors.Is(err, model.ErrUserNotFound) {
+	if !errors.Is(err, model.ErrUserNotFound) {
 		return model.User{}, err
 	}
 

diff --git a/storage/s3/keys.go b/storage/s3/keys.go
@@ -3,7 +3,7 @@ package s3
 import (
 	"bytes"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"log"
 
 	"github.com/aws/aws-sdk-go/aws"
@@ -69,7 +69,7 @@ func (ks *KeyStorage) LoadPrivateKey() (interface{}, error) {
 	}
 	defer resp.Body.Close()
 
-	keyData, err := ioutil.ReadAll(resp.Body)
+	keyData, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return nil, fmt.Errorf("Cannot decode S3 response: %s", err)
 	}