Merge pull request #1 from romsar/always-props

always prop
romsar · Jun 12, 2024 · 06fb643 · 06fb643
2 parents 75bc28d + 1e13995
commit 06fb643
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -169,6 +169,14 @@ props := inertia.Props{
 i.Render(w, r, "Some/Page", props)
 ```
 
+Also, Gonertia have support for `always` props ([learn more](https://github.com/inertiajs/inertia-laravel/pull/627)):
+
+```go
+props := inertia.Props{
+    "foo": AlwaysProp(func() any { return "bar" }),
+}
+```
+
 #### Redirects ([learn more](https://inertiajs.com/redirects))
 
 ```go

diff --git a/inertia_test.go b/inertia_test.go
@@ -251,19 +251,21 @@ func TestInertia_Render(t *testing.T) {
 				asInertiaRequest(r)
 
 				err := I().Render(w, r, "Some/Component", Props{
-					"foo":     "bar",
-					"closure": func() (any, error) { return "prop", nil },
-					"lazy":    LazyProp(func() (any, error) { return "prop", nil }),
+					"foo":              "bar",
+					"closure":          func() any { return "prop" },
+					"closure_with_err": func() (any, error) { return "prop", nil },
+					"lazy":             LazyProp(func() (any, error) { return "prop", nil }),
 				})
 				if err != nil {
 					t.Fatalf("unexpected error: %#v", err)
 				}
 
 				assertable := AssertFromString(t, w.Body.String())
 				assertable.AssertProps(Props{
-					"foo":     "bar",
-					"closure": "prop",
-					"errors":  map[string]any{},
+					"foo":              "bar",
+					"closure":          "prop",
+					"closure_with_err": "prop",
+					"errors":           map[string]any{},
 				})
 			})
 
@@ -283,6 +285,7 @@ func TestInertia_Render(t *testing.T) {
 						"abc":     "123",
 						"closure": func() (any, error) { return "prop", nil },
 						"lazy":    LazyProp(func() (any, error) { return "prop", nil }),
+						"always":  AlwaysProp(func() any { return "prop" }),
 					})
 					if err != nil {
 						t.Fatalf("unexpected error: %#v", err)
@@ -293,6 +296,8 @@ func TestInertia_Render(t *testing.T) {
 						"foo":     "bar",
 						"closure": "prop",
 						"lazy":    "prop",
+						"always":  "prop",
+						"errors":  map[string]interface{}{},
 					})
 				})
 

diff --git a/props.go b/props.go
@@ -14,6 +14,11 @@ type Props map[string]any
 // https://inertiajs.com/partial-reloads
 type LazyProp func() (any, error)
 
+// AlwaysProp is a property value that will always evaluated.
+//
+// https://github.com/inertiajs/inertia-laravel/pull/627
+type AlwaysProp func() any
+
 func (i *Inertia) prepareProps(r *http.Request, component string, props Props) (Props, error) {
 	result := make(Props)
 
@@ -22,7 +27,7 @@ func (i *Inertia) prepareProps(r *http.Request, component string, props Props) (
 	if err != nil {
 		return nil, fmt.Errorf("getting validation errors from context: %w", err)
 	}
-	result["errors"] = ctxValidationErrors
+	result["errors"] = AlwaysProp(func() any { return ctxValidationErrors })
 
 	// Add shared props to the result.
 	for key, val := range i.sharedProps {
@@ -49,10 +54,15 @@ func (i *Inertia) prepareProps(r *http.Request, component string, props Props) (
 
 	// Filter props.
 	if len(only) > 0 {
-		for key := range result {
-			if _, ok := only[key]; !ok {
-				delete(result, key)
+		for key, val := range result {
+			if _, ok := only[key]; ok {
+				continue
+			}
+			if _, ok := val.(AlwaysProp); ok {
+				continue
 			}
+
+			delete(result, key)
 		}
 	} else {
 		for key, val := range result {
@@ -64,7 +74,7 @@ func (i *Inertia) prepareProps(r *http.Request, component string, props Props) (
 
 	// Resolve props values.
 	for key, val := range result {
-		val, err := resolvePropVal(val)
+		val, err = resolvePropVal(val)
 		if err != nil {
 			return nil, fmt.Errorf("resolve prop value: %w", err)
 		}
@@ -79,20 +89,25 @@ func (i *Inertia) propsKeysToReturn(r *http.Request, component string) map[strin
 	//
 	// https://inertiajs.com/partial-reloads
 	if partialComponentFromRequest(r) == component {
-		return set[string](partialDataFromRequest(r))
+		return setOf[string](partialDataFromRequest(r))
 	}
 
 	return nil
 }
 
 func resolvePropVal(val any) (_ any, err error) {
-	if closure, ok := val.(func() (any, error)); ok {
-		val, err = closure()
+	switch typed := val.(type) {
+	case func() any:
+		return typed, nil
+	case AlwaysProp:
+		return typed(), nil
+	case func() (any, error):
+		val, err = typed()
 		if err != nil {
 			return nil, fmt.Errorf("closure prop resolving: %w", err)
 		}
-	} else if lazy, ok := val.(LazyProp); ok {
-		val, err = lazy()
+	case LazyProp:
+		val, err = typed()
 		if err != nil {
 			return nil, fmt.Errorf("lazy prop resolving: %w", err)
 		}

diff --git a/utils.go b/utils.go
@@ -7,7 +7,7 @@ import (
 	"os"
 )
 
-func set[T comparable](data []T) map[T]struct{} {
+func setOf[T comparable](data []T) map[T]struct{} {
 	if len(data) == 0 {
 		return nil
 	}

diff --git a/utils_test.go b/utils_test.go
@@ -5,69 +5,69 @@ import (
 	"testing"
 )
 
-func Test_set(t *testing.T) {
+func Test_setOf(t *testing.T) {
 	t.Parallel()
 
 	t.Run("nil", func(t *testing.T) {
 		t.Parallel()
 
-		got := set[string](nil)
+		got := setOf[string](nil)
 		var want map[string]struct{}
 
 		if !reflect.DeepEqual(got, want) {
-			t.Fatalf("set()=%#v, want=%#v", got, want)
+			t.Fatalf("setOf()=%#v, want=%#v", got, want)
 		}
 	})
 
 	t.Run("empty", func(t *testing.T) {
 		t.Parallel()
 
-		got := set[string]([]string{})
+		got := setOf[string]([]string{})
 		var want map[string]struct{}
 
 		if !reflect.DeepEqual(got, want) {
-			t.Fatalf("set()=%#v, want=%#v", got, want)
+			t.Fatalf("setOf()=%#v, want=%#v", got, want)
 		}
 	})
 
 	t.Run("duplicates", func(t *testing.T) {
 		t.Parallel()
 
-		got := set[string]([]string{"foo", "foo"})
+		got := setOf[string]([]string{"foo", "foo"})
 		want := map[string]struct{}{
 			"foo": {},
 		}
 
 		if !reflect.DeepEqual(got, want) {
-			t.Fatalf("set()=%#v, want=%#v", got, want)
+			t.Fatalf("setOf()=%#v, want=%#v", got, want)
 		}
 	})
 
 	t.Run("strings", func(t *testing.T) {
 		t.Parallel()
 
-		got := set[string]([]string{"foo", "bar"})
+		got := setOf[string]([]string{"foo", "bar"})
 		want := map[string]struct{}{
 			"foo": {},
 			"bar": {},
 		}
 
 		if !reflect.DeepEqual(got, want) {
-			t.Fatalf("set()=%#v, want=%#v", got, want)
+			t.Fatalf("setOf()=%#v, want=%#v", got, want)
 		}
 	})
 
 	t.Run("integers", func(t *testing.T) {
 		t.Parallel()
 
-		got := set[int]([]int{123, 456})
+		got := setOf[int]([]int{123, 456})
 		want := map[int]struct{}{
 			123: {},
 			456: {},
 		}
 
 		if !reflect.DeepEqual(got, want) {
-			t.Fatalf("set()=%#v, want=%#v", got, want)
+			t.Fatalf("setOf()=%#v, want=%#v", got, want)
 		}
 	})
 }