[#80] fixed before hooks data and added optional interceptor to upsert submit

forms/admin_upsert.go

@@ -74,8 +74,11 @@ func (form *AdminUpsert) checkUniqueEmail(value any) error {
 	return validation.NewError("validation_admin_email_exists", "Admin email already exists.")
 }
 
-// Submit validates the form and upserts the form's admin model.
-func (form *AdminUpsert) Submit() error {
+// Submit validates the form and upserts the form admin model.
+//
+// You can optionally provide a list of InterceptorFunc to further
+// modify the form behavior before persisting it.
+func (form *AdminUpsert) Submit(interceptors ...InterceptorFunc) error {
 	if err := form.Validate(); err != nil {
 		return err
 	}
@@ -87,5 +90,7 @@ func (form *AdminUpsert) Submit() error {
 		form.admin.SetPassword(form.Password)
 	}
 
-	return form.app.Dao().SaveAdmin(form.admin)
+	return runInterceptors(func() error {
+		return form.app.Dao().SaveAdmin(form.admin)
+	}, interceptors...)
 }

forms/admin_upsert_test.go

@@ -2,6 +2,7 @@ package forms_test
 
 import (
 	"encoding/json"
+	"errors"
 	"testing"
 
 	validation "github.com/go-ozzo/ozzo-validation/v4"
@@ -252,7 +253,14 @@ func TestAdminUpsertSubmit(t *testing.T) {
 			continue
 		}
 
-		err := form.Submit()
+		interceptorCalls := 0
+
+		err := form.Submit(func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+			return func() error {
+				interceptorCalls++
+				return next()
+			}
+		})
 
 		hasErr := err != nil
 		if hasErr != s.expectError {
@@ -266,6 +274,14 @@ func TestAdminUpsertSubmit(t *testing.T) {
 			continue
 		}
 
+		expectInterceptorCall := 1
+		if s.expectError {
+			expectInterceptorCall = 0
+		}
+		if interceptorCalls != expectInterceptorCall {
+			t.Errorf("(%d) Expected interceptor to be called %d, got %d", i, expectInterceptorCall, interceptorCalls)
+		}
+
 		if s.expectError {
 			continue // skip persistence check
 		}
@@ -283,3 +299,51 @@ func TestAdminUpsertSubmit(t *testing.T) {
 		}
 	}
 }
+
+func TestAdminUpsertSubmitInterceptors(t *testing.T) {
+	app, _ := tests.NewTestApp()
+	defer app.Cleanup()
+
+	admin := &models.Admin{}
+	form := forms.NewAdminUpsert(app, admin)
+	form.Email = "test_new@example.com"
+	form.Password = "1234567890"
+	form.PasswordConfirm = form.Password
+
+	testErr := errors.New("test_error")
+	interceptorAdminEmail := ""
+
+	interceptor1Called := false
+	interceptor1 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptor1Called = true
+			return next()
+		}
+	}
+
+	interceptor2Called := false
+	interceptor2 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptorAdminEmail = admin.Email // to check if the record was filled
+			interceptor2Called = true
+			return testErr
+		}
+	}
+
+	err := form.Submit(interceptor1, interceptor2)
+	if err != testErr {
+		t.Fatalf("Expected error %v, got %v", testErr, err)
+	}
+
+	if !interceptor1Called {
+		t.Fatalf("Expected interceptor1 to be called")
+	}
+
+	if !interceptor2Called {
+		t.Fatalf("Expected interceptor2 to be called")
+	}
+
+	if interceptorAdminEmail != form.Email {
+		t.Fatalf("Expected the form model to be filled before calling the interceptors")
+	}
+}

forms/base.go

@@ -0,0 +1,19 @@
+// Package models implements various services used for request data
+// validation and applying changes to existing DB models through the app Dao.
+package forms
+
+// InterceptorNextFunc is a interceptor handler function.
+// Usually used in combination with InterceptorFunc.
+type InterceptorNextFunc = func() error
+
+// InterceptorFunc defines a single interceptor function that will execute the provided next func handler.
+type InterceptorFunc func(next InterceptorNextFunc) InterceptorNextFunc
+
+// runInterceptors executes the provided list of interceptors.
+func runInterceptors(next InterceptorNextFunc, interceptors ...InterceptorFunc) error {
+	for i := len(interceptors) - 1; i >= 0; i-- {
+		next = interceptors[i](next)
+	}
+
+	return next()
+}

forms/collection_upsert.go

@@ -189,7 +189,10 @@ func (form *CollectionUpsert) checkRule(value any) error {
 // Submit validates the form and upserts the form's Collection model.
 //
 // On success the related record table schema will be auto updated.
-func (form *CollectionUpsert) Submit() error {
+//
+// You can optionally provide a list of InterceptorFunc to further
+// modify the form behavior before persisting it.
+func (form *CollectionUpsert) Submit(interceptors ...InterceptorFunc) error {
 	if err := form.Validate(); err != nil {
 		return err
 	}
@@ -211,5 +214,7 @@ func (form *CollectionUpsert) Submit() error {
 	form.collection.UpdateRule = form.UpdateRule
 	form.collection.DeleteRule = form.DeleteRule
 
-	return form.app.Dao().SaveCollection(form.collection)
+	return runInterceptors(func() error {
+		return form.app.Dao().SaveCollection(form.collection)
+	}, interceptors...)
 }

forms/collection_upsert_test.go

@@ -2,6 +2,7 @@ package forms_test
 
 import (
 	"encoding/json"
+	"errors"
 	"testing"
 
 	validation "github.com/go-ozzo/ozzo-validation/v4"
@@ -387,14 +388,31 @@ func TestCollectionUpsertSubmit(t *testing.T) {
 			continue
 		}
 
+		interceptorCalls := 0
+		interceptor := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+			return func() error {
+				interceptorCalls++
+				return next()
+			}
+		}
+
 		// parse errors
-		result := form.Submit()
+		result := form.Submit(interceptor)
 		errs, ok := result.(validation.Errors)
 		if !ok && result != nil {
 			t.Errorf("(%d) Failed to parse errors %v", i, result)
 			continue
 		}
 
+		// check interceptor calls
+		expectInterceptorCall := 1
+		if len(s.expectedErrors) > 0 {
+			expectInterceptorCall = 0
+		}
+		if interceptorCalls != expectInterceptorCall {
+			t.Errorf("(%d) Expected interceptor to be called %d, got %d", i, expectInterceptorCall, interceptorCalls)
+		}
+
 		// check errors
 		if len(errs) > len(s.expectedErrors) {
 			t.Errorf("(%d) Expected error keys %v, got %v", i, s.expectedErrors, errs)
@@ -450,3 +468,53 @@ func TestCollectionUpsertSubmit(t *testing.T) {
 		}
 	}
 }
+
+func TestCollectionUpsertSubmitInterceptors(t *testing.T) {
+	app, _ := tests.NewTestApp()
+	defer app.Cleanup()
+
+	collection, err := app.Dao().FindCollectionByNameOrId("demo")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	form := forms.NewCollectionUpsert(app, collection)
+	form.Name = "test_new"
+
+	testErr := errors.New("test_error")
+	interceptorCollectionName := ""
+
+	interceptor1Called := false
+	interceptor1 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptor1Called = true
+			return next()
+		}
+	}
+
+	interceptor2Called := false
+	interceptor2 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptorCollectionName = collection.Name // to check if the record was filled
+			interceptor2Called = true
+			return testErr
+		}
+	}
+
+	submitErr := form.Submit(interceptor1, interceptor2)
+	if submitErr != testErr {
+		t.Fatalf("Expected submitError %v, got %v", testErr, submitErr)
+	}
+
+	if !interceptor1Called {
+		t.Fatalf("Expected interceptor1 to be called")
+	}
+
+	if !interceptor2Called {
+		t.Fatalf("Expected interceptor2 to be called")
+	}
+
+	if interceptorCollectionName != form.Name {
+		t.Fatalf("Expected the form model to be filled before calling the interceptors")
+	}
+}

forms/record_upsert.go

@@ -271,7 +271,10 @@ func (form *RecordUpsert) DrySubmit(callback func(txDao *daos.Dao) error) error
 }
 
 // Submit validates the form and upserts the form Record model.
-func (form *RecordUpsert) Submit() error {
+//
+// You can optionally provide a list of InterceptorFunc to further
+// modify the form behavior before persisting it.
+func (form *RecordUpsert) Submit(interceptors ...InterceptorFunc) error {
 	if err := form.Validate(); err != nil {
 		return err
 	}
@@ -281,25 +284,27 @@ func (form *RecordUpsert) Submit() error {
 		return err
 	}
 
-	return form.app.Dao().RunInTransaction(func(txDao *daos.Dao) error {
-		// persist record model
-		if err := txDao.SaveRecord(form.record); err != nil {
-			return err
-		}
+	return runInterceptors(func() error {
+		return form.app.Dao().RunInTransaction(func(txDao *daos.Dao) error {
+			// persist record model
+			if err := txDao.SaveRecord(form.record); err != nil {
+				return err
+			}
 
-		// upload new files (if any)
-		if err := form.processFilesToUpload(); err != nil {
-			return err
-		}
+			// upload new files (if any)
+			if err := form.processFilesToUpload(); err != nil {
+				return err
+			}
 
-		// delete old files (if any)
-		if err := form.processFilesToDelete(); err != nil { //nolint:staticcheck
-			// for now fail silently to avoid reupload when `form.Submit()`
-			// is called manually (aka. not from an api request)...
-		}
+			// delete old files (if any)
+			if err := form.processFilesToDelete(); err != nil { //nolint:staticcheck
+				// for now fail silently to avoid reupload when `form.Submit()`
+				// is called manually (aka. not from an api request)...
+			}
 
-		return nil
-	})
+			return nil
+		})
+	}, interceptors...)
 }
 
 func (form *RecordUpsert) processFilesToUpload() error {

forms/record_upsert_test.go

@@ -3,6 +3,7 @@ package forms_test
 import (
 	"bytes"
 	"encoding/json"
+	"errors"
 	"net/http"
 	"net/http/httptest"
 	"path/filepath"
@@ -400,13 +401,27 @@ func TestRecordUpsertSubmitFailure(t *testing.T) {
 	req.Header.Set(echo.HeaderContentType, mp.FormDataContentType())
 	form.LoadData(req)
 
+	interceptorCalls := 0
+	interceptor := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptorCalls++
+			return next()
+		}
+	}
+
 	// ensure that validate is triggered
 	// ---
-	result := form.Submit()
+	result := form.Submit(interceptor)
 	if result == nil {
 		t.Fatal("Expected error, got nil")
 	}
 
+	// check interceptor calls
+	// ---
+	if interceptorCalls != 0 {
+		t.Fatalf("Expected interceptor to be called 0 times, got %d", interceptorCalls)
+	}
+
 	// ensure that the record changes weren't persisted
 	// ---
 	recordAfter, err := app.Dao().FindFirstRecordByData(collection, "id", recordBefore.Id)
@@ -451,11 +466,25 @@ func TestRecordUpsertSubmitSuccess(t *testing.T) {
 	req.Header.Set(echo.HeaderContentType, mp.FormDataContentType())
 	form.LoadData(req)
 
-	result := form.Submit()
+	interceptorCalls := 0
+	interceptor := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptorCalls++
+			return next()
+		}
+	}
+
+	result := form.Submit(interceptor)
 	if result != nil {
 		t.Fatalf("Expected nil, got error %v", result)
 	}
 
+	// check interceptor calls
+	// ---
+	if interceptorCalls != 1 {
+		t.Fatalf("Expected interceptor to be called 1 time, got %d", interceptorCalls)
+	}
+
 	// ensure that the record changes were persisted
 	// ---
 	recordAfter, err := app.Dao().FindFirstRecordByData(collection, "id", recordBefore.Id)
@@ -482,6 +511,57 @@ func TestRecordUpsertSubmitSuccess(t *testing.T) {
 	}
 }
 
+func TestRecordUpsertSubmitInterceptors(t *testing.T) {
+	app, _ := tests.NewTestApp()
+	defer app.Cleanup()
+
+	collection, _ := app.Dao().FindCollectionByNameOrId("demo4")
+	record, err := app.Dao().FindFirstRecordByData(collection, "id", "054f9f24-0a0a-4e09-87b1-bc7ff2b336a2")
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	form := forms.NewRecordUpsert(app, record)
+	form.Data["title"] = "test_new"
+
+	testErr := errors.New("test_error")
+	interceptorRecordTitle := ""
+
+	interceptor1Called := false
+	interceptor1 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptor1Called = true
+			return next()
+		}
+	}
+
+	interceptor2Called := false
+	interceptor2 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptorRecordTitle = record.GetStringDataValue("title") // to check if the record was filled
+			interceptor2Called = true
+			return testErr
+		}
+	}
+
+	submitErr := form.Submit(interceptor1, interceptor2)
+	if submitErr != testErr {
+		t.Fatalf("Expected submitError %v, got %v", testErr, submitErr)
+	}
+
+	if !interceptor1Called {
+		t.Fatalf("Expected interceptor1 to be called")
+	}
+
+	if !interceptor2Called {
+		t.Fatalf("Expected interceptor2 to be called")
+	}
+
+	if interceptorRecordTitle != form.Data["title"].(string) {
+		t.Fatalf("Expected the form model to be filled before calling the interceptors")
+	}
+}
+
 func hasRecordFile(app core.App, record *models.Record, filename string) bool {
 	fs, _ := app.NewFilesystem()
 	defer fs.Close()

forms/settings_upsert.go

@@ -33,27 +33,32 @@ func (form *SettingsUpsert) Validate() error {
 // Submit validates the form and upserts the loaded settings.
 //
 // On success the app settings will be refreshed with the form ones.
-func (form *SettingsUpsert) Submit() error {
+//
+// You can optionally provide a list of InterceptorFunc to further
+// modify the form behavior before persisting it.
+func (form *SettingsUpsert) Submit(interceptors ...InterceptorFunc) error {
 	if err := form.Validate(); err != nil {
 		return err
 	}
 
 	encryptionKey := os.Getenv(form.app.EncryptionEnv())
 
-	saveErr := form.app.Dao().SaveParam(
-		models.ParamAppSettings,
-		form.Settings,
-		encryptionKey,
-	)
-	if saveErr != nil {
-		return saveErr
-	}
+	return runInterceptors(func() error {
+		saveErr := form.app.Dao().SaveParam(
+			models.ParamAppSettings,
+			form.Settings,
+			encryptionKey,
+		)
+		if saveErr != nil {
+			return saveErr
+		}
 
-	// explicitly trigger old logs deletion
-	form.app.LogsDao().DeleteOldRequests(
-		time.Now().AddDate(0, 0, -1*form.Settings.Logs.MaxDays),
-	)
+		// explicitly trigger old logs deletion
+		form.app.LogsDao().DeleteOldRequests(
+			time.Now().AddDate(0, 0, -1*form.Settings.Logs.MaxDays),
+		)
 
-	// merge the application settings with the form ones
-	return form.app.Settings().Merge(form.Settings)
+		// merge the application settings with the form ones
+		return form.app.Settings().Merge(form.Settings)
+	}, interceptors...)
 }

forms/settings_upsert_test.go

@@ -2,6 +2,7 @@ package forms_test
 
 import (
 	"encoding/json"
+	"errors"
 	"os"
 	"testing"
 
@@ -98,14 +99,31 @@ func TestSettingsUpsertSubmit(t *testing.T) {
 			continue
 		}
 
+		interceptorCalls := 0
+		interceptor := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+			return func() error {
+				interceptorCalls++
+				return next()
+			}
+		}
+
 		// parse errors
-		result := form.Submit()
+		result := form.Submit(interceptor)
 		errs, ok := result.(validation.Errors)
 		if !ok && result != nil {
 			t.Errorf("(%d) Failed to parse errors %v", i, result)
 			continue
 		}
 
+		// check interceptor calls
+		expectInterceptorCall := 1
+		if len(s.expectedErrors) > 0 {
+			expectInterceptorCall = 0
+		}
+		if interceptorCalls != expectInterceptorCall {
+			t.Errorf("(%d) Expected interceptor to be called %d, got %d", i, expectInterceptorCall, interceptorCalls)
+		}
+
 		// check errors
 		if len(errs) > len(s.expectedErrors) {
 			t.Errorf("(%d) Expected error keys %v, got %v", i, s.expectedErrors, errs)
@@ -128,3 +146,42 @@ func TestSettingsUpsertSubmit(t *testing.T) {
 		}
 	}
 }
+
+func TestSettingsUpsertSubmitInterceptors(t *testing.T) {
+	app, _ := tests.NewTestApp()
+	defer app.Cleanup()
+
+	form := forms.NewSettingsUpsert(app)
+	form.Meta.AppName = "test_new"
+
+	testErr := errors.New("test_error")
+
+	interceptor1Called := false
+	interceptor1 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptor1Called = true
+			return next()
+		}
+	}
+
+	interceptor2Called := false
+	interceptor2 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptor2Called = true
+			return testErr
+		}
+	}
+
+	submitErr := form.Submit(interceptor1, interceptor2)
+	if submitErr != testErr {
+		t.Fatalf("Expected submitError %v, got %v", testErr, submitErr)
+	}
+
+	if !interceptor1Called {
+		t.Fatalf("Expected interceptor1 to be called")
+	}
+
+	if !interceptor2Called {
+		t.Fatalf("Expected interceptor2 to be called")
+	}
+}

forms/user_upsert.go

@@ -98,7 +98,10 @@ func (form *UserUpsert) checkEmailDomain(value any) error {
 }
 
 // Submit validates the form and upserts the form user model.
-func (form *UserUpsert) Submit() error {
+//
+// You can optionally provide a list of InterceptorFunc to further
+// modify the form behavior before persisting it.
+func (form *UserUpsert) Submit(interceptors ...InterceptorFunc) error {
 	if err := form.Validate(); err != nil {
 		return err
 	}
@@ -114,5 +117,7 @@ func (form *UserUpsert) Submit() error {
 
 	form.user.Email = form.Email
 
-	return form.app.Dao().SaveUser(form.user)
+	return runInterceptors(func() error {
+		return form.app.Dao().SaveUser(form.user)
+	}, interceptors...)
 }

forms/user_upsert_test.go

@@ -2,6 +2,7 @@ package forms_test
 
 import (
 	"encoding/json"
+	"errors"
 	"testing"
 
 	validation "github.com/go-ozzo/ozzo-validation/v4"
@@ -212,13 +213,28 @@ func TestUserUpsertSubmit(t *testing.T) {
 			continue
 		}
 
-		err := form.Submit()
+		interceptorCalls := 0
+
+		err := form.Submit(func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+			return func() error {
+				interceptorCalls++
+				return next()
+			}
+		})
 
 		hasErr := err != nil
 		if hasErr != s.expectError {
 			t.Errorf("(%d) Expected hasErr to be %v, got %v (%v)", i, s.expectError, hasErr, err)
 		}
 
+		expectInterceptorCall := 1
+		if s.expectError {
+			expectInterceptorCall = 0
+		}
+		if interceptorCalls != expectInterceptorCall {
+			t.Errorf("(%d) Expected interceptor to be called %d, got %d", i, expectInterceptorCall, interceptorCalls)
+		}
+
 		if s.expectError {
 			continue
 		}
@@ -240,3 +256,51 @@ func TestUserUpsertSubmit(t *testing.T) {
 		}
 	}
 }
+
+func TestUserUpsertSubmitInterceptors(t *testing.T) {
+	app, _ := tests.NewTestApp()
+	defer app.Cleanup()
+
+	user := &models.User{}
+	form := forms.NewUserUpsert(app, user)
+	form.Email = "test_new@example.com"
+	form.Password = "1234567890"
+	form.PasswordConfirm = form.Password
+
+	testErr := errors.New("test_error")
+	interceptorUserEmail := ""
+
+	interceptor1Called := false
+	interceptor1 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptor1Called = true
+			return next()
+		}
+	}
+
+	interceptor2Called := false
+	interceptor2 := func(next forms.InterceptorNextFunc) forms.InterceptorNextFunc {
+		return func() error {
+			interceptorUserEmail = user.Email // to check if the record was filled
+			interceptor2Called = true
+			return testErr
+		}
+	}
+
+	err := form.Submit(interceptor1, interceptor2)
+	if err != testErr {
+		t.Fatalf("Expected error %v, got %v", testErr, err)
+	}
+
+	if !interceptor1Called {
+		t.Fatalf("Expected interceptor1 to be called")
+	}
+
+	if !interceptor2Called {
+		t.Fatalf("Expected interceptor2 to be called")
+	}
+
+	if interceptorUserEmail != form.Email {
+		t.Fatalf("Expected the form model to be filled before calling the interceptors")
+	}
+}