Validate native inputs

endpoints/openrtb2/amp_auction_test.go

@@ -4,24 +4,66 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
 	"github.com/mxmCherry/openrtb"
 	"github.com/prebid/prebid-server/config"
 	"github.com/prebid/prebid-server/exchange"
 	"github.com/prebid/prebid-server/pbsmetrics"
 	"github.com/prebid/prebid-server/stored_requests/backends/empty_fetcher"
 	"github.com/rcrowley/go-metrics"
-	"net/http"
-	"net/http/httptest"
-	"testing"
 )
 
 // From auction_test.go
 // const maxSize = 1024 * 256
 
 // TestGoodRequests makes sure that the auction runs properly-formatted stored bids correctly.
 func TestGoodAmpRequests(t *testing.T) {
+	testAmpStoredRequestData := map[string]json.RawMessage{
+		"10":  json.RawMessage(validRequest(t, "site.json")),
+		"11":  json.RawMessage(validRequest(t, "app.json")),
+		"12":  json.RawMessage(validRequest(t, "timeout.json")),
+		"100": json.RawMessage("5"),
+		"101": json.RawMessage("5"),
+		"102": json.RawMessage("5"),
+		"103": json.RawMessage("5"),
+		"104": json.RawMessage("5"),
+		"105": json.RawMessage("5"),
+		"106": json.RawMessage("5"),
+		"107": json.RawMessage("5"),
+		"108": json.RawMessage("5"),
+		"109": json.RawMessage("5"),
+		"110": json.RawMessage("5"),
+		"111": json.RawMessage("5"),
+		"112": json.RawMessage("5"),
+		"113": json.RawMessage("5"),
+		"114": json.RawMessage("5"),
+		"115": json.RawMessage("5"),
+		"116": json.RawMessage("5"),
+		"117": json.RawMessage("5"),
+		"118": json.RawMessage("5"),
+		"119": json.RawMessage("5"),
+		"120": json.RawMessage("5"),
+		"121": json.RawMessage("5"),
+		"122": json.RawMessage("5"),
+		"123": json.RawMessage("5"),
+		"124": json.RawMessage("5"),
+		"125": json.RawMessage("5"),
+		"126": json.RawMessage("5"),
+		"127": json.RawMessage("5"),
+		"128": json.RawMessage("5"),
+		"129": json.RawMessage("5"),
+		"130": json.RawMessage("5"),
+		"131": json.RawMessage("5"),
+		"132": json.RawMessage("5"),
+		"133": json.RawMessage("5"),
+		"134": json.RawMessage("5"),
+	}
+
 	theMetrics := pbsmetrics.NewMetrics(metrics.NewRegistry(), exchange.AdapterList())
-	endpoint, _ := NewAmpEndpoint(&mockAmpExchange{}, &bidderParamValidator{}, &mockAmpStoredReqFetcher{}, &config.Configuration{MaxRequestSize: maxSize}, theMetrics)
+	endpoint, _ := NewAmpEndpoint(&mockAmpExchange{}, &bidderParamValidator{}, &mockAmpStoredReqFetcher{testAmpStoredRequestData}, &config.Configuration{MaxRequestSize: maxSize}, theMetrics)
 
 	for _, requestID := range storedValidRequests {
 		request := httptest.NewRequest("GET", fmt.Sprintf("/openrtb2/auction/amp?tag_id=%s", requestID), nil)
@@ -72,53 +114,12 @@ var storedInvalidRequests = []string{"11", "12", "100", "101", "102", "103", "10
 	"120", "121", "122", "123", "124", "125", "126", "127", "128", "129",
 	"103", "131", "132", "133", "134"}
 
-// Test stored request data
-var testAmpStoredRequestData = map[string]json.RawMessage{
-	"10":  json.RawMessage(validRequests[0]),
-	"11":  json.RawMessage(validRequests[1]),
-	"12":  json.RawMessage(validRequests[2]),
-	"100": json.RawMessage(invalidRequests[0]),
-	"101": json.RawMessage(invalidRequests[0]),
-	"102": json.RawMessage(invalidRequests[0]),
-	"103": json.RawMessage(invalidRequests[0]),
-	"104": json.RawMessage(invalidRequests[0]),
-	"105": json.RawMessage(invalidRequests[0]),
-	"106": json.RawMessage(invalidRequests[0]),
-	"107": json.RawMessage(invalidRequests[0]),
-	"108": json.RawMessage(invalidRequests[0]),
-	"109": json.RawMessage(invalidRequests[0]),
-	"110": json.RawMessage(invalidRequests[0]),
-	"111": json.RawMessage(invalidRequests[0]),
-	"112": json.RawMessage(invalidRequests[0]),
-	"113": json.RawMessage(invalidRequests[0]),
-	"114": json.RawMessage(invalidRequests[0]),
-	"115": json.RawMessage(invalidRequests[0]),
-	"116": json.RawMessage(invalidRequests[0]),
-	"117": json.RawMessage(invalidRequests[0]),
-	"118": json.RawMessage(invalidRequests[0]),
-	"119": json.RawMessage(invalidRequests[0]),
-	"120": json.RawMessage(invalidRequests[0]),
-	"121": json.RawMessage(invalidRequests[0]),
-	"122": json.RawMessage(invalidRequests[0]),
-	"123": json.RawMessage(invalidRequests[0]),
-	"124": json.RawMessage(invalidRequests[0]),
-	"125": json.RawMessage(invalidRequests[0]),
-	"126": json.RawMessage(invalidRequests[0]),
-	"127": json.RawMessage(invalidRequests[0]),
-	"128": json.RawMessage(invalidRequests[0]),
-	"129": json.RawMessage(invalidRequests[0]),
-	"130": json.RawMessage(invalidRequests[0]),
-	"131": json.RawMessage(invalidRequests[0]),
-	"132": json.RawMessage(invalidRequests[0]),
-	"133": json.RawMessage(invalidRequests[0]),
-	"134": json.RawMessage(invalidRequests[0]),
-}
-
 type mockAmpStoredReqFetcher struct {
+	data map[string]json.RawMessage
 }
 
-func (cf mockAmpStoredReqFetcher) FetchRequests(ctx context.Context, ids []string) (map[string]json.RawMessage, []error) {
-	return testAmpStoredRequestData, nil
+func (cf *mockAmpStoredReqFetcher) FetchRequests(ctx context.Context, ids []string) (map[string]json.RawMessage, []error) {
+	return cf.data, nil
 }
 
 type mockAmpExchange struct {

endpoints/openrtb2/auction.go

@@ -18,6 +18,7 @@ import (
 	"github.com/julienschmidt/httprouter"
 	"github.com/mssola/user_agent"
 	"github.com/mxmCherry/openrtb"
+	nativeRequests "github.com/mxmCherry/openrtb/native/request"
 	"github.com/prebid/prebid-server/config"
 	"github.com/prebid/prebid-server/exchange"
 	"github.com/prebid/prebid-server/openrtb_ext"
@@ -255,10 +256,8 @@ func (deps *endpointDeps) validateImp(imp *openrtb.Imp, aliases map[string]strin
 		}
 	}
 
-	if imp.Native != nil {
-		if imp.Native.Request == "" {
-			return fmt.Errorf("request.imp[%d].native.request must be a JSON encoded string conforming to the openrtb 1.2 Native spec", index)
-		}
+	if err := fillAndValidateNative(imp.Native, index); err != nil {
+		return err
 	}
 
 	if err := validatePmp(imp.PMP, index); err != nil {
@@ -300,6 +299,183 @@ func validateBanner(banner *openrtb.Banner, impIndex int) error {
 	return nil
 }
 
+// fillAndValidateNative validates the request, and assigns the Asset IDs as recommended by the Native v1.2 spec.
+func fillAndValidateNative(n *openrtb.Native, impIndex int) error {
+	if n == nil {
+		return nil
+	}
+
+	var nativePayload nativeRequests.Request
+	if err := json.Unmarshal(json.RawMessage(n.Request), &nativePayload); err != nil {
+		return err
+	}
+
+	if err := validateNativeContext(nativePayload.Context, impIndex); err != nil {
+		return err
+	}
+	if err := validateNativePlacementType(nativePayload.PlcmtType, impIndex); err != nil {
+		return err
+	}
+	if err := fillAndValidateNativeAssets(nativePayload.Assets, impIndex); err != nil {
+		return err
+	}
+
+	// TODO #218: Validate eventtrackers once mxmcherry/openrtb has been updated to support Native v1.2
+
+	serialized, err := json.Marshal(nativePayload)
+	if err != nil {
+		return err
+	}
+	encoded, err := json.Marshal(string(serialized))
+	if err != nil {
+		return err
+	}
+	n.Request = string(encoded)
+	return nil
+}
+
+func validateNativeContext(c nativeRequests.ContextType, impIndex int) error {
+	if c < 1 || c > 3 {
+		return fmt.Errorf("request.imp[%d].native.request.context must be in the range [1, 3]. Got %d", impIndex, c)
+	}
+	return nil
+}
+
+func validateNativePlacementType(pt nativeRequests.PlacementType, impIndex int) error {
+	if pt < 1 || pt > 4 {
+		return fmt.Errorf("request.imp[%d].native.request.plcmttype must be in the range [1, 4]. Got %d", impIndex, pt)
+	}
+	return nil
+}
+
+func fillAndValidateNativeAssets(assets []nativeRequests.Asset, impIndex int) error {
+	if len(assets) < 1 {
+		return fmt.Errorf("request.imp[%d].native.request.assets must be an array containing at least one object.", impIndex)
+	}
+
+	for i := 0; i < len(assets); i++ {
+		// Per the OpenRTB spec docs, this is a "unique asset ID, assigned by exchange. Typically a counter for the array"
+		// To avoid conflict with the Request, we'll return a 400 if the Request _did_ define this ID,
+		// and then populate it as the spec suggests.
+		if err := validateNativeAsset(assets[i], impIndex, i); err != nil {
+			return err
+		}
+		assets[i].ID = int64(i)
+	}
+	return nil
+}
+
+func validateNativeAsset(asset nativeRequests.Asset, impIndex int, assetIndex int) error {
+	if asset.ID != 0 {
+		return fmt.Errorf(`request.imp[%d].native.request.assets[%d].id must not be defined. Prebid Server will set this automatically, using the index of the asset in the array as the ID.`, impIndex, assetIndex)
+	}
+
+	foundType := false
+
+	if asset.Title != nil {
+		foundType = true
+		if err := validateNativeAssetTitle(asset.Title, impIndex, assetIndex); err != nil {
+			return err
+		}
+	}
+
+	if asset.Img != nil {
+		if foundType {
+			return fmt.Errorf("request.imp[%d].native.request.assets[%d] must define at most one of {title, img, video, data}", impIndex, assetIndex)
+		}
+		foundType = true
+		if err := validateNativeAssetImg(asset.Img, impIndex, assetIndex); err != nil {
+			return err
+		}
+	}
+
+	if asset.Video != nil {
+		if foundType {
+			return fmt.Errorf("request.imp[%d].native.request.assets[%d] must define at most one of {title, img, video, data}", impIndex, assetIndex)
+		}
+		foundType = true
+		if err := validateNativeAssetVideo(asset.Video, impIndex, assetIndex); err != nil {
+			return err
+		}
+	}
+
+	if asset.Data != nil {
+		if foundType {
+			return fmt.Errorf("request.imp[%d].native.request.assets[%d] must define at most one of {title, img, video, data}", impIndex, assetIndex)
+		}
+		foundType = true
+		if err := validateNativeAssetData(asset.Data, impIndex, assetIndex); err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func validateNativeAssetTitle(title *nativeRequests.Title, impIndex int, assetIndex int) error {
+	if title.Len < 1 {
+		return fmt.Errorf("request.imp[%d].native.request.assets[%d].title.len must be a positive integer", impIndex, assetIndex)
+	}
+	return nil
+}
+
+func validateNativeAssetImg(image *nativeRequests.Image, impIndex int, assetIndex int) error {
+	// Note that w, wmin, h, and hmin cannot be negative because these variables use unsigned ints.
+	// Those fail during the standard json.Unmarshal() call.
+	if image.W == 0 && image.WMin == 0 {
+		return fmt.Errorf(`request.imp[%d].native.request.assets[%d].img must contain at least one of "w" or "wmin"`, impIndex, assetIndex)
+	}
+	if image.H == 0 && image.HMin == 0 {
+		return fmt.Errorf(`request.imp[%d].native.request.assets[%d].img must contain at least one of "h" or "hmin"`, impIndex, assetIndex)
+	}
+
+	return nil
+}
+
+func validateNativeAssetVideo(video *nativeRequests.Video, impIndex int, assetIndex int) error {
+	if len(video.MIMEs) < 1 {
+		return fmt.Errorf("request.imp[%d].native.request.assets[%d].video.mimes must be an array with at least one MIME type.", impIndex, assetIndex)
+	}
+	if video.MinDuration < 1 {
+		return fmt.Errorf("request.imp[%d].native.request.assets[%d].video.minduration must be a positive integer.", impIndex, assetIndex)
+	}
+	if video.MaxDuration < 1 {
+		return fmt.Errorf("request.imp[%d].native.request.assets[%d].video.maxduration must be a positive integer.", impIndex, assetIndex)
+	}
+	if err := validateNativeVideoProtocols(video.Protocols, impIndex, assetIndex); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func validateNativeAssetData(data *nativeRequests.Data, impIndex int, assetIndex int) error {
+	if data.Type < 1 || data.Type > 11 {
+		return fmt.Errorf("request.imp[%d].native.request.assets[%d].data.type must in the range [1, 11]. Got %d.", impIndex, assetIndex, data.Type)
+	}
+
+	return nil
+}
+
+func validateNativeVideoProtocols(protocols []nativeRequests.Protocol, impIndex int, assetIndex int) error {
+	if len(protocols) < 1 {
+		return fmt.Errorf("request.imp[%d].native.request.assets[%d].video.protocols must be an array with at least one element", impIndex, assetIndex)
+	}
+	for i := 0; i < len(protocols); i++ {
+		if err := validateNativeVideoProtocol(protocols[i], impIndex, assetIndex, i); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func validateNativeVideoProtocol(protocol nativeRequests.Protocol, impIndex int, assetIndex int, protocolIndex int) error {
+	if protocol < 0 || protocol > 10 {
+		return fmt.Errorf("request.imp[%d].native.request.assets[%d].video.protocols[%d] must be in the range [1, 10]. Got %d", impIndex, assetIndex, protocolIndex, protocol)
+	}
+	return nil
+}
+
 func validateFormat(format *openrtb.Format, impIndex int, formatIndex int) error {
 	usesHW := format.W != 0 || format.H != 0
 	usesRatios := format.WMin != 0 || format.WRatio != 0 || format.HRatio != 0