pocketbase/core/field_autodate_test.go

package core_test

import (
	"context"
	"fmt"
	"strings"
	"testing"
	"time"

	"github.com/pocketbase/pocketbase/core"
	"github.com/pocketbase/pocketbase/tests"
	"github.com/pocketbase/pocketbase/tools/types"
)

func TestAutodateFieldBaseMethods(t *testing.T) {
	testFieldBaseMethods(t, core.FieldTypeAutodate)
}

func TestAutodateFieldColumnType(t *testing.T) {
	app, _ := tests.NewTestApp()
	defer app.Cleanup()

	f := &core.AutodateField{}

	expected := "TEXT DEFAULT '' NOT NULL"

	if v := f.ColumnType(app); v != expected {
		t.Fatalf("Expected\n%q\ngot\n%q", expected, v)
	}
}

func TestAutodateFieldPrepareValue(t *testing.T) {
	app, _ := tests.NewTestApp()
	defer app.Cleanup()

	f := &core.AutodateField{}
	record := core.NewRecord(core.NewBaseCollection("test"))

	scenarios := []struct {
		raw      any
		expected string
	}{
		{"", ""},
		{"invalid", ""},
		{"2024-01-01 00:11:22.345Z", "2024-01-01 00:11:22.345Z"},
		{time.Date(2024, 1, 2, 3, 4, 5, 0, time.UTC), "2024-01-02 03:04:05.000Z"},
	}

	for i, s := range scenarios {
		t.Run(fmt.Sprintf("%d_%#v", i, s.raw), func(t *testing.T) {
			v, err := f.PrepareValue(record, s.raw)
			if err != nil {
				t.Fatal(err)
			}

			vDate, ok := v.(types.DateTime)
			if !ok {
				t.Fatalf("Expected types.DateTime instance, got %T", v)
			}

			if vDate.String() != s.expected {
				t.Fatalf("Expected %v, got %v", s.expected, v)
			}
		})
	}
}

func TestAutodateFieldValidateValue(t *testing.T) {
	app, _ := tests.NewTestApp()
	defer app.Cleanup()

	collection := core.NewBaseCollection("test_collection")

	scenarios := []struct {
		name        string
		field       *core.AutodateField
		record      func() *core.Record
		expectError bool
	}{
		{
			"invalid raw value",
			&core.AutodateField{Name: "test"},
			func() *core.Record {
				record := core.NewRecord(collection)
				record.SetRaw("test", 123)
				return record
			},
			false,
		},
		{
			"missing field value",
			&core.AutodateField{Name: "test"},
			func() *core.Record {
				record := core.NewRecord(collection)
				record.SetRaw("abc", true)
				return record
			},
			false,
		},
		{
			"existing field value",
			&core.AutodateField{Name: "test"},
			func() *core.Record {
				record := core.NewRecord(collection)
				record.SetRaw("test", types.NowDateTime())
				return record
			},
			false,
		},
	}

	for _, s := range scenarios {
		t.Run(s.name, func(t *testing.T) {
			err := s.field.ValidateValue(context.Background(), app, s.record())

			hasErr := err != nil
			if hasErr != s.expectError {
				t.Fatalf("Expected hasErr %v, got %v (%v)", s.expectError, hasErr, err)
			}
		})
	}
}

func TestAutodateFieldValidateSettings(t *testing.T) {
	testDefaultFieldIdValidation(t, core.FieldTypeAutodate)
	testDefaultFieldNameValidation(t, core.FieldTypeAutodate)

	app, _ := tests.NewTestApp()
	defer app.Cleanup()

	superusers, err := app.FindCollectionByNameOrId(core.CollectionNameSuperusers)
	if err != nil {
		t.Fatal(err)
	}

	scenarios := []struct {
		name         string
		field        func() *core.AutodateField
		expectErrors []string
	}{
		{
			"empty onCreate and onUpdate",
			func() *core.AutodateField {
				return &core.AutodateField{
					Id:   "test",
					Name: "test",
				}
			},
			[]string{"onCreate", "onUpdate"},
		},
		{
			"with onCreate",
			func() *core.AutodateField {
				return &core.AutodateField{
					Id:       "test",
					Name:     "test",
					OnCreate: true,
				}
			},
			[]string{},
		},
		{
			"with onUpdate",
			func() *core.AutodateField {
				return &core.AutodateField{
					Id:       "test",
					Name:     "test",
					OnUpdate: true,
				}
			},
			[]string{},
		},
		{
			"change of a system autodate field",
			func() *core.AutodateField {
				created := superusers.Fields.GetByName("created").(*core.AutodateField)
				created.OnCreate = !created.OnCreate
				created.OnUpdate = !created.OnUpdate
				return created
			},
			[]string{"onCreate", "onUpdate"},
		},
	}

	for _, s := range scenarios {
		t.Run(s.name, func(t *testing.T) {
			errs := s.field().ValidateSettings(context.Background(), app, superusers)

			tests.TestValidationErrors(t, errs, s.expectErrors)
		})
	}
}

func TestAutodateFieldFindSetter(t *testing.T) {
	field := &core.AutodateField{Name: "test"}

	collection := core.NewBaseCollection("test_collection")
	collection.Fields.Add(field)

	initialDate, err := types.ParseDateTime("2024-01-02 03:04:05.789Z")
	if err != nil {
		t.Fatal(err)
	}

	record := core.NewRecord(collection)
	record.SetRaw("test", initialDate)

	t.Run("no matching setter", func(t *testing.T) {
		f := field.FindSetter("abc")
		if f != nil {
			t.Fatal("Expected nil setter")
		}
	})

	t.Run("matching setter", func(t *testing.T) {
		f := field.FindSetter("test")
		if f == nil {
			t.Fatal("Expected non-nil setter")
		}

		f(record, types.NowDateTime()) // should be ignored

		if v := record.GetString("test"); v != "2024-01-02 03:04:05.789Z" {
			t.Fatalf("Expected no value change, got %q", v)
		}
	})
}

func TestAutodateFieldIntercept(t *testing.T) {
	app, _ := tests.NewTestApp()
	defer app.Cleanup()

	initialDate, err := types.ParseDateTime("2024-01-02 03:04:05.789Z")
	if err != nil {
		t.Fatal(err)
	}

	collection := core.NewBaseCollection("test_collection")

	scenarios := []struct {
		name       string
		actionName string
		field      *core.AutodateField
		record     func() *core.Record
		expected   string
	}{
		{
			"non-matching action",
			"test",
			&core.AutodateField{Name: "test", OnCreate: true, OnUpdate: true},
			func() *core.Record {
				return core.NewRecord(collection)
			},
			"",
		},
		{
			"create with zero value (disabled onCreate)",
			core.InterceptorActionCreate,
			&core.AutodateField{Name: "test", OnCreate: false, OnUpdate: true},
			func() *core.Record {
				return core.NewRecord(collection)
			},
			"",
		},
		{
			"create with zero value",
			core.InterceptorActionCreate,
			&core.AutodateField{Name: "test", OnCreate: true, OnUpdate: true},
			func() *core.Record {
				return core.NewRecord(collection)
			},
			"{NOW}",
		},
		{
			"create with non-zero value",
			core.InterceptorActionCreate,
			&core.AutodateField{Name: "test", OnCreate: true, OnUpdate: true},
			func() *core.Record {
				record := core.NewRecord(collection)
				record.SetRaw("test", initialDate)
				return record
			},
			initialDate.String(),
		},
		{
			"update with zero value (disabled onUpdate)",
			core.InterceptorActionUpdate,
			&core.AutodateField{Name: "test", OnCreate: true, OnUpdate: false},
			func() *core.Record {
				return core.NewRecord(collection)
			},
			"",
		},
		{
			"update with zero value",
			core.InterceptorActionUpdate,
			&core.AutodateField{Name: "test", OnCreate: true, OnUpdate: true},
			func() *core.Record {
				return core.NewRecord(collection)
			},
			"{NOW}",
		},
		{
			"update with non-zero value",
			core.InterceptorActionUpdate,
			&core.AutodateField{Name: "test", OnCreate: true, OnUpdate: true},
			func() *core.Record {
				record := core.NewRecord(collection)
				record.SetRaw("test", initialDate)
				return record
			},
			initialDate.String(),
		},
	}

	for _, s := range scenarios {
		t.Run(s.name, func(t *testing.T) {
			actionCalls := 0
			record := s.record()

			now := types.NowDateTime().String()
			err := s.field.Intercept(context.Background(), app, record, s.actionName, func() error {
				actionCalls++
				return nil
			})
			if err != nil {
				t.Fatal(err)
			}

			if actionCalls != 1 {
				t.Fatalf("Expected actionCalls %d, got %d", 1, actionCalls)
			}

			expected := cutMilliseconds(strings.ReplaceAll(s.expected, "{NOW}", now))

			v := cutMilliseconds(record.GetString(s.field.GetName()))
			if v != expected {
				t.Fatalf("Expected value %q, got %q", expected, v)
			}
		})
	}
}

func cutMilliseconds(datetime string) string {
	if len(datetime) > 19 {
		return datetime[:19]
	}
	return datetime
}