Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Adapter: Pixfuture #4117

Open
wants to merge 32 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
93e6573
added initila Pixfuture adapter files and codesd
pixfuture-media Dec 5, 2024
458fad1
Miodified vendors timewait
pixfuture-media Dec 5, 2024
d67a079
Adding test file
pixfuture-media Dec 9, 2024
a9fe81b
Added prams_test.go
pixfuture-media Dec 9, 2024
606b185
Changing pix endpoint to srv-adapter.pixfuture.com
pixfuture-media Dec 9, 2024
061b818
Made changes in test.go
pixfuture-media Dec 10, 2024
d0bc2e1
Addede changes to pixfuture_test.go
pixfuture-media Dec 10, 2024
eec17ff
Merge branch 'prebid:master' into master
pixfuture-media Dec 13, 2024
cb8e3a7
update coverage.out
pixfuture-media Dec 13, 2024
bba6eed
added doc
pixfuture-media Dec 13, 2024
22df0f8
fixing bags
pixfuture-media Dec 18, 2024
3f33089
Merge branch 'prebid:master' into master
pixfuture-media Dec 19, 2024
a22b19e
Fixed naming convention issue for Pixfuture adapter to align with bes…
pixfuture-media Dec 19, 2024
993f157
Merge branch 'master' of github.com:pixfuture-media/prebid-server
pixfuture-media Dec 19, 2024
284c847
Merge branch 'prebid:master' into master
pixfuture-media Jan 13, 2025
9e470a0
Made changes regarding github-actions
pixfuture-media Jan 13, 2025
3b4ca26
Made changes regarding github-actions
pixfuture-media Jan 13, 2025
1df8f71
Made changes regarding go test
pixfuture-media Jan 15, 2025
6a59158
Merge branch 'prebid:master' into master
pixfuture-media Jan 17, 2025
2ba1a64
Made changes regarding go test
pixfuture-media Jan 17, 2025
ea7d94e
Update adapters/pixfuture/pixfuture.go
pixfuture-media Jan 30, 2025
8dac147
Update adapters/pixfuture/pixfuture.go
pixfuture-media Jan 30, 2025
078c276
Update adapters/pixfuture/pixfuture.go
pixfuture-media Jan 30, 2025
0b62c21
Update adapters/pixfuture/pixfuture.go
pixfuture-media Jan 30, 2025
7bdabf4
Made changes in Pixfuture.go
pixfuture-media Jan 30, 2025
3f219c9
Made changes regarding GitHub reviews
pixfuture-media Jan 31, 2025
bb9b65d
Made changes regarding GitHub reviews
pixfuture-media Jan 31, 2025
7a3352f
Made changes regarding GitHub reviews
pixfuture-media Jan 31, 2025
3f13c25
Made changes regarding GitHub reviews
pixfuture-media Jan 31, 2025
a407b22
Made changes regarding GitHub reviews
pixfuture-media Jan 31, 2025
3457b8c
Made changes regarding GitHub reviews
pixfuture-media Feb 3, 2025
f1b859c
Merge branch 'prebid:master' into master
pixfuture-media Feb 4, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions adapters/pixfuture/params_test.go
Copy link
Collaborator

@bsardo bsardo Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please see the developer docs Bidder Parameter Tests on how to test your adapter params.

Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
package pixfuture

import (
"fmt"
"testing"

"github.com/prebid/prebid-server/v3/openrtb_ext"
"github.com/stretchr/testify/assert"
)

func TestPixfutureParams(t *testing.T) {
testCases := []struct {
name string
params openrtb_ext.ImpExtPixfuture
expectedError string
}{
{
name: "Valid Params",
params: openrtb_ext.ImpExtPixfuture{
PlacementID: "123",
},
expectedError: "",
},
{
name: "Missing PlacementID",
params: openrtb_ext.ImpExtPixfuture{
PlacementID: "",
},
expectedError: "PlacementID is required",
},
}

for _, test := range testCases {
t.Run(test.name, func(t *testing.T) {
err := validatePixfutureParams(test.params)
if test.expectedError == "" {
assert.NoError(t, err)
} else {
assert.EqualError(t, err, test.expectedError)
}
})
}
}

func validatePixfutureParams(params openrtb_ext.ImpExtPixfuture) error {
if params.PlacementID == "" {
return fmt.Errorf("PlacementID is required")
}
return nil
}
Comment on lines +11 to +50
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can delete all of this.

129 changes: 129 additions & 0 deletions adapters/pixfuture/pixfuture.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
package pixfuture

import (
"encoding/json"
"fmt"
"net/http"

"github.com/prebid/openrtb/v20/openrtb2"
"github.com/prebid/prebid-server/v3/adapters"
"github.com/prebid/prebid-server/v3/config"
"github.com/prebid/prebid-server/v3/errortypes"
"github.com/prebid/prebid-server/v3/openrtb_ext"
"github.com/prebid/prebid-server/v3/util/jsonutil"
)

type adapter struct {
endpoint string
}

// Builder builds a new instance of the Pixfuture adapter.
func Builder(bidderName openrtb_ext.BidderName, config config.Adapter, server config.Server) (adapters.Bidder, error) {
return &adapter{
endpoint: config.Endpoint,
}, nil
}

// MakeRequests prepares and serializes HTTP requests to be sent to the Pixfuture endpoint.
func (a *adapter) MakeRequests(bidRequest *openrtb2.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
var errs []error

// Validate the bid request
if bidRequest == nil || len(bidRequest.Imp) == 0 {
errs = append(errs, fmt.Errorf("no valid impressions in bid request"))
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
return nil, errs
}
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved

// Process impressions
var validImpressions []openrtb2.Imp
for _, imp := range bidRequest.Imp {
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
if imp.Banner == nil && imp.Video == nil {
errs = append(errs, fmt.Errorf("unsupported impression type for impID: %s", imp.ID))
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
continue
}
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
validImpressions = append(validImpressions, imp)
}
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved

if len(validImpressions) == 0 {
errs = append(errs, fmt.Errorf("no valid impressions after filtering"))
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
return nil, errs
}

// Create the outgoing request
bidRequest.Imp = validImpressions
body, err := json.Marshal(bidRequest)
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
if err != nil {
errs = append(errs, fmt.Errorf("failed to marshal bid request: %v", err))
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
return nil, errs
}

request := &adapters.RequestData{
Method: "POST",
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
Uri: a.endpoint,
Body: body,
Headers: http.Header{
"Content-Type": []string{"application/json"},
},
}

return []*adapters.RequestData{request}, errs
}

// getMediaTypeForBid extracts the bid type based on the bid extension data.
func getMediaTypeForBid(bid openrtb2.Bid) (openrtb_ext.BidType, error) {
if bid.Ext != nil {
var bidExt openrtb_ext.ExtBid
err := jsonutil.Unmarshal(bid.Ext, &bidExt)
if err == nil && bidExt.Prebid != nil {
return openrtb_ext.ParseBidType(string(bidExt.Prebid.Type))
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
}
}

return "", &errortypes.BadServerResponse{
Message: fmt.Sprintf("Failed to parse impression \"%s\" mediatype", bid.ImpID),
}
}

// MakeBids parses the HTTP response from the Pixfuture endpoint and generates a BidderResponse.
func (a *adapter) MakeBids(request *openrtb2.BidRequest, requestData *adapters.RequestData, responseData *adapters.ResponseData) (*adapters.BidderResponse, []error) {
// Handle No Content response
if adapters.IsResponseStatusCodeNoContent(responseData) {
return nil, nil
}

// Check for errors in response status code
if err := adapters.CheckResponseStatusCodeForErrors(responseData); err != nil {
return nil, []error{err}
}
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved

// Parse the response body
var response openrtb2.BidResponse
if err := jsonutil.Unmarshal(responseData.Body, &response); err != nil {
return nil, []error{err}
}

bidResponse := adapters.NewBidderResponseWithBidsCapacity(len(request.Imp))
bidResponse.Currency = response.Cur
var errors []error

for _, seatBid := range response.SeatBid {
for i, bid := range seatBid.Bid {
bidType, err := getMediaTypeForBid(bid)
if err != nil {
errors = append(errors, err)
continue
}

// Set the MType explicitly in the bid
//mType := openrtb2.MType(bidType)
//seatBid.Bid[i].MType = mType
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved

bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{
Bid: &seatBid.Bid[i],
BidType: bidType,
})
}
}

return bidResponse, errors
}
167 changes: 167 additions & 0 deletions adapters/pixfuture/pixfuture_test.go
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
package pixfuture

import (
"encoding/json"
"net/http"
"testing"

"github.com/prebid/openrtb/v20/openrtb2"
"github.com/prebid/prebid-server/v3/adapters"
"github.com/prebid/prebid-server/v3/config"
"github.com/prebid/prebid-server/v3/openrtb_ext"
"github.com/stretchr/testify/assert"
)

func TestBuilder(t *testing.T) {
adapter, err := Builder("pixfuture", config.Adapter{Endpoint: "https://mock-endpoint.com"}, config.Server{})
assert.NoError(t, err, "unexpected error during Builder execution")
assert.NotNil(t, adapter, "expected a non-nil adapter instance")
}

func TestAdapter_MakeRequests(t *testing.T) {
adapter := &adapter{endpoint: "https://mock-pixfuture-endpoint.com"}

t.Run("Valid Request", func(t *testing.T) {
bidRequest := &openrtb2.BidRequest{
ID: "test-request-id",
Imp: []openrtb2.Imp{
{
ID: "test-imp-id",
Banner: &openrtb2.Banner{W: int64Ptr(300), H: int64Ptr(250)},
Ext: jsonRawExt(`{"bidder":{"siteId":"123"}}`),
},
},
}

requests, errs := adapter.MakeRequests(bidRequest, nil)
assert.Empty(t, errs, "unexpected errors in MakeRequests")
assert.Equal(t, 1, len(requests), "expected exactly one request")

request := requests[0]
assert.Equal(t, "POST", request.Method, "unexpected HTTP method")
assert.Equal(t, "https://mock-pixfuture-endpoint.com", request.Uri, "unexpected request URI")
assert.Contains(t, string(request.Body), `"id":"test-request-id"`, "unexpected request body")
assert.Equal(t, "application/json", request.Headers.Get("Content-Type"), "unexpected content-type")
})

t.Run("No Impressions", func(t *testing.T) {
bidRequest := &openrtb2.BidRequest{ID: "test-request-id"}

requests, errs := adapter.MakeRequests(bidRequest, nil)
assert.NotEmpty(t, errs, "expected error for request with no impressions")
assert.Nil(t, requests, "expected no requests for request with no impressions")
})

t.Run("Malformed BidRequest", func(t *testing.T) {
bidRequest := &openrtb2.BidRequest{}

requests, errs := adapter.MakeRequests(bidRequest, nil)
assert.NotEmpty(t, errs, "expected error for malformed request")
assert.Nil(t, requests, "expected no requests for malformed request")
})
}

func TestAdapter_MakeBids(t *testing.T) {
adapter := &adapter{}

t.Run("Valid Response", func(t *testing.T) {
responseData := &adapters.ResponseData{
StatusCode: http.StatusOK,
Body: []byte(`{
"id": "test-response-id",
"seatbid": [{
"bid": [{
"id": "test-bid-id",
"impid": "test-imp-id",
"price": 1.23,
"adm": "<html>Ad Content</html>",
"crid": "creative-123",
"w": 300,
"h": 250,
"ext": {"prebid":{"type":"banner"}}
}]
}],
"cur": "USD"
}`),
}

bidRequest := &openrtb2.BidRequest{ID: "test-request-id", Imp: []openrtb2.Imp{{ID: "test-imp-id"}}}
bidResponse, errs := adapter.MakeBids(bidRequest, nil, responseData)

assert.Empty(t, errs, "unexpected errors in MakeBids")
assert.NotNil(t, bidResponse, "expected bid response")
assert.Equal(t, "USD", bidResponse.Currency, "unexpected currency")
assert.Equal(t, 1, len(bidResponse.Bids), "expected one bid")

bid := bidResponse.Bids[0]
assert.Equal(t, "test-bid-id", bid.Bid.ID, "unexpected bid ID")
assert.Equal(t, "test-imp-id", bid.Bid.ImpID, "unexpected impression ID")
assert.Equal(t, 1.23, bid.Bid.Price, "unexpected bid price")
assert.Equal(t, openrtb_ext.BidTypeBanner, bid.BidType, "unexpected bid type")
})

t.Run("No Content Response", func(t *testing.T) {
responseData := &adapters.ResponseData{StatusCode: http.StatusNoContent}
bidRequest := &openrtb2.BidRequest{}
bidResponse, errs := adapter.MakeBids(bidRequest, nil, responseData)
assert.Nil(t, bidResponse, "expected no bid response")
assert.Empty(t, errs, "unexpected errors for no content response")
})

t.Run("Bad Request Response", func(t *testing.T) {
responseData := &adapters.ResponseData{StatusCode: http.StatusBadRequest}
bidRequest := &openrtb2.BidRequest{}
bidResponse, errs := adapter.MakeBids(bidRequest, nil, responseData)
assert.Nil(t, bidResponse, "expected no bid response")
assert.NotEmpty(t, errs, "expected errors for bad request response")
})

t.Run("Unexpected Status Code", func(t *testing.T) {
responseData := &adapters.ResponseData{StatusCode: http.StatusInternalServerError}
bidRequest := &openrtb2.BidRequest{}
bidResponse, errs := adapter.MakeBids(bidRequest, nil, responseData)
assert.Nil(t, bidResponse, "expected no bid response")
assert.NotEmpty(t, errs, "expected errors for unexpected status code")
})

t.Run("Malformed Response Body", func(t *testing.T) {
responseData := &adapters.ResponseData{
StatusCode: http.StatusOK,
Body: []byte(`malformed response`),
}
bidRequest := &openrtb2.BidRequest{}
bidResponse, errs := adapter.MakeBids(bidRequest, nil, responseData)
assert.Nil(t, bidResponse, "expected no bid response")
assert.NotEmpty(t, errs, "expected errors for malformed response body")
})
}

func TestGetMediaTypeForBid(t *testing.T) {
t.Run("Valid Bid Ext", func(t *testing.T) {
bid := openrtb2.Bid{
ID: "test-bid",
Ext: json.RawMessage(`{"prebid":{"type":"banner"}}`),
}
bidType, err := getMediaTypeForBid(bid)
assert.NoError(t, err, "unexpected error in getMediaTypeForBid")
assert.Equal(t, openrtb_ext.BidTypeBanner, bidType, "unexpected bid type")
})

t.Run("Invalid Bid Ext", func(t *testing.T) {
bid := openrtb2.Bid{
ID: "test-bid",
Ext: json.RawMessage(`{"invalid":"data"}`),
}
bidType, err := getMediaTypeForBid(bid)
assert.Error(t, err, "expected error for invalid bid ext")
assert.Equal(t, openrtb_ext.BidType(""), bidType, "expected empty bid type for invalid bid ext")
})
}

func int64Ptr(i int64) *int64 {
return &i
}

func jsonRawExt(jsonStr string) json.RawMessage {
return json.RawMessage(jsonStr)
}
24 changes: 24 additions & 0 deletions adapters/pixfuture/testdata/valid-bid-request.json
pixfuture-media marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"id": "test-request-id",
"imp": [
{
"id": "test-imp-id",
"banner": {
"w": 300,
"h": 250
},
"ext": {
"bidder": {
"siteId": "123"
}
}
}
],
"site": {
"page": "http://example.com"
},
"device": {
"ua": "Mozilla/5.0",
"ip": "192.168.0.1"
}
}
24 changes: 24 additions & 0 deletions adapters/pixfuture/testdata/valid-bid-response.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"id": "test-response-id",
"seatbid": [
{
"bid": [
{
"id": "test-bid-id",
"impid": "test-imp-id",
"price": 1.23,
"adm": "<html>Ad Content</html>",
"crid": "creative-123",
"w": 300,
"h": 250,
"ext": {
"prebid": {
"type": "banner"
}
}
}
]
}
],
"cur": "USD"
}
Loading
Loading