Adding copying of gdpr consent string to openrtb bid request (#1189)

* Adding copying of gdpr consent string to openrtb bid request

* Updated video request to use OpenRTB Video and User objects

* Fixing unit test failure message

* Updates from code review comments

* Updating unit test initialization

* Updated mimes array construction

Author: camrice

endpoints/openrtb2/video_auction.go

@@ -328,12 +328,12 @@ func max(a, b int) int {
 	return b
 }
 
-func createImpressionTemplate(imp openrtb.Imp, video openrtb_ext.SimplifiedVideo) openrtb.Imp {
+func createImpressionTemplate(imp openrtb.Imp, video *openrtb.Video) openrtb.Imp {
 	imp.Video = &openrtb.Video{}
 	imp.Video.W = video.W
 	imp.Video.H = video.H
 	imp.Video.Protocols = video.Protocols
-	imp.Video.MIMEs = video.Mimes
+	imp.Video.MIMEs = video.MIMEs
 	return imp
 }
 
@@ -471,14 +471,7 @@ func mergeData(videoRequest *openrtb_ext.BidRequestVideo, bidRequest *openrtb.Bi
 		bidRequest.Device = &videoRequest.Device
 	}
 
-	if &videoRequest.User != nil {
-		bidRequest.User = &openrtb.User{
-			BuyerUID: videoRequest.User.Buyeruids["appnexus"], //TODO: map to string merging
-			Yob:      videoRequest.User.Yob,
-			Gender:   videoRequest.User.Gender,
-			Keywords: videoRequest.User.Keywords,
-		}
-	}
+	bidRequest.User = videoRequest.User
 
 	if len(videoRequest.BCat) != 0 {
 		bidRequest.BCat = videoRequest.BCat
@@ -660,27 +653,30 @@ func (deps *endpointDeps) validateVideoRequest(req *openrtb_ext.BidRequestVideo)
 		}
 	}
 
-	if len(req.Video.Mimes) == 0 {
-		err := errors.New("request missing required field: Video.Mimes")
-		errL = append(errL, err)
-	} else {
-		mimes := make([]string, 0, 0)
-		for _, mime := range req.Video.Mimes {
-			if mime != "" {
-				mimes = append(mimes, mime)
+	if req.Video != nil {
+		if len(req.Video.MIMEs) == 0 {
+			err := errors.New("request missing required field: Video.Mimes")
+			errL = append(errL, err)
+		} else {
+			mimes := make([]string, 0, len(req.Video.MIMEs))
+			for _, mime := range req.Video.MIMEs {
+				if mime != "" {
+					mimes = append(mimes, mime)
+				}
 			}
+			if len(mimes) == 0 {
+				err := errors.New("request missing required field: Video.Mimes, mime types contains empty strings only")
+				errL = append(errL, err)
+			}
+			req.Video.MIMEs = mimes
 		}
-		if len(mimes) == 0 {
-			err := errors.New("request missing required field: Video.Mimes, mime types contains empty strings only")
+
+		if len(req.Video.Protocols) == 0 {
+			err := errors.New("request missing required field: Video.Protocols")
 			errL = append(errL, err)
 		}
-		if len(mimes) > 0 {
-			req.Video.Mimes = mimes
-		}
-	}
-
-	if len(req.Video.Protocols) == 0 {
-		err := errors.New("request missing required field: Video.Protocols")
+	} else {
+		err := errors.New("request missing required field: Video")
 		errL = append(errL, err)
 	}
 

endpoints/openrtb2/video_auction_test.go

@@ -233,8 +233,8 @@ func TestVideoEndpointValidationsPositive(t *testing.T) {
 		IncludeBrandCategory: &openrtb_ext.IncludeBrandCategory{
 			PrimaryAdserver: 1,
 		},
-		Video: openrtb_ext.SimplifiedVideo{
-			Mimes:     mimes,
+		Video: &openrtb.Video{
+			MIMEs:     mimes,
 			Protocols: videoProtocols,
 		},
 	}
@@ -271,8 +271,8 @@ func TestVideoEndpointValidationsCritical(t *testing.T) {
 		IncludeBrandCategory: &openrtb_ext.IncludeBrandCategory{
 			PrimaryAdserver: 0,
 		},
-		Video: openrtb_ext.SimplifiedVideo{
-			Mimes:     mimes,
+		Video: &openrtb.Video{
+			MIMEs:     mimes,
 			Protocols: videoProtocols,
 		},
 	}
@@ -345,8 +345,8 @@ func TestVideoEndpointValidationsPodErrors(t *testing.T) {
 		IncludeBrandCategory: &openrtb_ext.IncludeBrandCategory{
 			PrimaryAdserver: 1,
 		},
-		Video: openrtb_ext.SimplifiedVideo{
-			Mimes:     mimes,
+		Video: &openrtb.Video{
+			MIMEs:     mimes,
 			Protocols: videoProtocols,
 		},
 	}
@@ -418,8 +418,8 @@ func TestVideoEndpointValidationsSiteAndApp(t *testing.T) {
 		IncludeBrandCategory: &openrtb_ext.IncludeBrandCategory{
 			PrimaryAdserver: 1,
 		},
-		Video: openrtb_ext.SimplifiedVideo{
-			Mimes:     mimes,
+		Video: &openrtb.Video{
+			MIMEs:     mimes,
 			Protocols: videoProtocols,
 		},
 	}
@@ -473,8 +473,8 @@ func TestVideoEndpointValidationsSiteMissingRequiredField(t *testing.T) {
 		IncludeBrandCategory: &openrtb_ext.IncludeBrandCategory{
 			PrimaryAdserver: 1,
 		},
-		Video: openrtb_ext.SimplifiedVideo{
-			Mimes:     mimes,
+		Video: &openrtb.Video{
+			MIMEs:     mimes,
 			Protocols: videoProtocols,
 		},
 	}
@@ -484,6 +484,43 @@ func TestVideoEndpointValidationsSiteMissingRequiredField(t *testing.T) {
 	assert.Len(t, podErrors, 0, "Pod errors should be empty")
 }
 
+func TestVideoEndpointValidationsMissingVideo(t *testing.T) {
+	ex := &mockExchangeVideo{}
+	deps := mockDeps(t, ex)
+	deps.cfg.VideoStoredRequestRequired = true
+
+	req := openrtb_ext.BidRequestVideo{
+		StoredRequestId: "123",
+		PodConfig: openrtb_ext.PodConfig{
+			DurationRangeSec:     []int{15, 30},
+			RequireExactDuration: true,
+			Pods: []openrtb_ext.Pod{
+				{
+					PodId:            1,
+					AdPodDurationSec: 30,
+					ConfigId:         "qwerty",
+				},
+				{
+					PodId:            2,
+					AdPodDurationSec: 30,
+					ConfigId:         "qwerty",
+				},
+			},
+		},
+		App: &openrtb.App{
+			Bundle: "pbs.com",
+		},
+		IncludeBrandCategory: &openrtb_ext.IncludeBrandCategory{
+			PrimaryAdserver: 1,
+		},
+	}
+
+	errors, podErrors := deps.validateVideoRequest(&req)
+	assert.Len(t, podErrors, 0, "Pod errors should be empty")
+	assert.Len(t, errors, 1, "Errors array should contain 1 error message")
+	assert.Equal(t, "request missing required field: Video", errors[0].Error(), "Errors array should contain message regarding missing Video field")
+}
+
 func TestVideoBuildVideoResponseMissedCacheForOneBid(t *testing.T) {
 	openRtbBidResp := openrtb.BidResponse{}
 	podErrors := make([]PodError, 0)
@@ -633,6 +670,13 @@ func TestMergeOpenRTBToVideoRequest(t *testing.T) {
 		Ext: json.RawMessage(`{"gdpr":1,"us_privacy":"1NYY","existing":"any","consent":"anyConsent"}`),
 	}
 
+	videoReq.User = &openrtb.User{
+		BuyerUID: "test UID",
+		Yob:      1980,
+		Keywords: "test keywords",
+		Ext:      json.RawMessage(`{"consent":"test string"}`),
+	}
+
 	mergeData(videoReq, bidReq)
 
 	assert.Equal(t, videoReq.BCat, bidReq.BCat, "BCat is incorrect")
@@ -647,6 +691,8 @@ func TestMergeOpenRTBToVideoRequest(t *testing.T) {
 	assert.Equal(t, videoReq.Site.Page, bidReq.Site.Page, "Device.Site.Page is incorrect")
 
 	assert.Equal(t, videoReq.Regs, bidReq.Regs, "Regs is incorrect")
+
+	assert.Equal(t, videoReq.User, bidReq.User, "User is incorrect")
 }
 
 func TestHandleError(t *testing.T) {

openrtb_ext/bid_request_video.go

@@ -43,7 +43,7 @@ type BidRequestVideo struct {
 	//   object; optional
 	// Description:
 	//   Container object for the user of of the actual device
-	User SimplifiedUser `json:"user,omitempty"`
+	User *openrtb.User `json:"user,omitempty"`
 
 	// Attribute:
 	//   device
@@ -67,7 +67,7 @@ type BidRequestVideo struct {
 	//   object; required
 	// Description:
 	//   Player container object
-	Video SimplifiedVideo `json:"video,omitempty"`
+	Video *openrtb.Video `json:"video,omitempty"`
 
 	// Attribute:
 	//   content
@@ -225,86 +225,3 @@ type Cacheconfig struct {
 	//  Time to Live for a cache entry specified in seconds
 	Ttl int `json:"ttl"`
 }
-
-type Gdpr struct {
-	// Attribute:
-	//   consentrequired
-	// Type:
-	//   boolean; optional
-	//  Indicates whether GDPR is in effect
-	ConsentRequired bool `json:"consentrequired"`
-
-	// Attribute:
-	//   consentstring
-	// Type:
-	//   string; optional
-	//  Contains the data structure developed by the GDPR
-	ConsentString string `json:"consentstring"`
-}
-
-type SimplifiedUser struct {
-	// Attribute:
-	//   buyeruids
-	// Type:
-	//   map; optional
-	//  ID of the stored config that corresponds to a single pod request
-	Buyeruids map[string]string `json:"buyeruids"`
-
-	// Attribute:
-	//   gdpr
-	// Type:
-	//   object; optional
-	//  Container object for GDPR
-	Gdpr Gdpr `json:"gdpr"`
-
-	// Attribute:
-	//   yob
-	// Type:
-	//   int; optional
-	//  Year of birth as a 4-digit integer
-	Yob int64 `json:"yob"`
-
-	// Attribute:
-	//   gender
-	// Type:
-	//   string; optional
-	//  Gender, where “M” = male, “F” = female, “O” = known to be other
-	Gender string `json:"gender"`
-
-	// Attribute:
-	//   keywords
-	// Type:
-	//   string; optional
-	//  Comma separated list of keywords, interests, or intent.
-	Keywords string `json:"keywords"`
-}
-
-type SimplifiedVideo struct {
-	// Attribute:
-	//   w
-	// Type:
-	//   uint64; optional
-	//  Width of video
-	W uint64 `json:"w"`
-
-	// Attribute:
-	//   h
-	// Type:
-	//   uint64; optional
-	//  Height of video
-	H uint64 `json:"h"`
-
-	// Attribute:
-	//   mimes
-	// Type:
-	//   array of strings; optional
-	//  Video mime types
-	Mimes []string `json:"mimes"`
-
-	// Attribute:
-	//   protocols
-	// Type:
-	//   array of objects; optional
-	//  protocols
-	Protocols []openrtb.Protocol `json:"protocols"`
-}