plumbing: FilterObjectType, enforce supported object types

edigaryev · edigaryev · commit 83f87a265c4d · 2024-01-28T12:18:30.000+04:00
diff --git a/plumbing/protocol/packp/filter.go b/plumbing/protocol/packp/filter.go
@@ -1,12 +1,15 @@
 package packp
 
 import (
+	"errors"
 	"fmt"
 	"github.com/go-git/go-git/v5/plumbing"
 	"net/url"
 	"strings"
 )
 
+var ErrUnsupportedObjectFilterType = errors.New("unsupported object filter type")
+
 // Filter values enable the partial clone capability which causes
 // the server to omit objects that match the filter.
 type Filter string
@@ -30,8 +33,19 @@ func FilterTreeDepth(depth uint64) Filter {
 
 // FilterObjectType omits all objects which are not of the requested type t.
 // Supported types are TagObject, CommitObject, TreeObject and BlobObject.
-func FilterObjectType(t plumbing.ObjectType) Filter {
-	return Filter(fmt.Sprintf("object:type=%s", t.String()))
+func FilterObjectType(t plumbing.ObjectType) (Filter, error) {
+	switch t {
+	case plumbing.TagObject:
+		fallthrough
+	case plumbing.CommitObject:
+		fallthrough
+	case plumbing.TreeObject:
+		fallthrough
+	case plumbing.BlobObject:
+		return Filter(fmt.Sprintf("object:type=%s", t.String())), nil
+	default:
+		return "", fmt.Errorf("%w: %s", ErrUnsupportedObjectFilterType, t.String())
+	}
 }
 
 // FilterCombine combines multiple Filter values together.
diff --git a/plumbing/protocol/packp/filter_test.go b/plumbing/protocol/packp/filter_test.go
@@ -22,10 +22,27 @@ func TestFilterTreeDepth(t *testing.T) {
 }
 
 func TestFilterObjectType(t *testing.T) {
-	require.EqualValues(t, "object:type=tag", FilterObjectType(plumbing.TagObject))
-	require.EqualValues(t, "object:type=commit", FilterObjectType(plumbing.CommitObject))
-	require.EqualValues(t, "object:type=tree", FilterObjectType(plumbing.TreeObject))
-	require.EqualValues(t, "object:type=blob", FilterObjectType(plumbing.BlobObject))
+	filter, err := FilterObjectType(plumbing.TagObject)
+	require.NoError(t, err)
+	require.EqualValues(t, "object:type=tag", filter)
+
+	filter, err = FilterObjectType(plumbing.CommitObject)
+	require.NoError(t, err)
+	require.EqualValues(t, "object:type=commit", filter)
+
+	filter, err = FilterObjectType(plumbing.TreeObject)
+	require.NoError(t, err)
+	require.EqualValues(t, "object:type=tree", filter)
+
+	filter, err = FilterObjectType(plumbing.BlobObject)
+	require.NoError(t, err)
+	require.EqualValues(t, "object:type=blob", filter)
+
+	_, err = FilterObjectType(plumbing.InvalidObject)
+	require.Error(t, err)
+
+	_, err = FilterObjectType(plumbing.OFSDeltaObject)
+	require.Error(t, err)
 }
 
 func TestFilterCombine(t *testing.T) {
