Adding OpenRTB support #196

dbemiller · 2017-11-13T20:04:09Z

This PR defines an /openrtb2/auction endpoint which serves OpenRTB requests.

At a high level, the packages are:

openrtb_ext: contract classes for the prebid-server extensions
exchange: OpenRTB auction logic
endpoints: HTTP-serving code & request input validation

I updated the Appnexus adapter to serve from this endpoint, as a proof of concept. It's mostly copy & paste now, to be cleaned up later (see the last part of this description)

There are many TODOs before OpenRTB is truly production-ready. I plan to open issues about them once it looks like the reviews are winding down.

In parallel, we can:

Implement the Bidder interface on all other adapters.
Add Targeting key support
Add Influx Metrics
Support Configs
Respect User syncs

Once those are done, we should:

Rewrite the /auction endpoint implementation to use the Exchange
Delete the Adapter interface (now in adapters/legacy.go) and all the code which implements it.

… openrtb-types

Openrtb types

…so that it compiles again.

…rategies.

sandraleon

Suggested a couple of small improvements in tests but overall looks good.

sandraleon · 2017-11-21T03:16:28Z

exchange/bidder_test.go

+	if bids != nil {
+		t.Errorf("There should be no seatbid if no http requests are returned.")
+	}
+	if len(errs) != 1 {


Could also check the contents of the error received to make sure it's what is expected.

sandraleon · 2017-11-21T03:17:24Z

adapters/appnexus/appnexus_test.go

+		t.Fatalf("Failed to unmarshal outgoing request: %v", err)
+	}
+
+	if len(apnRequest.Imp) != 2 {


Could also check that the 2 imps are the correct ones.

sandraleon · 2017-11-21T03:18:34Z

exchange/exchange.go

+	return e
+}
+
+func (e *exchange) HoldAuction(ctx context.Context, bidRequest *openrtb.BidRequest) (*openrtb.BidResponse, error) {


cindyhere33 · 2017-11-30T18:42:46Z

openrtb_ext/request.go

+	MaxLength        int              `json:"lengthmax"`
+}
+
+// PriceGranularity defines the allowed values for bidrequest.ext.targeting.pricegranularity


Shouldn't it be bidrequest.ext.prebid.targeting.pricegranularity?

Yes! good catch... I'll fix it.

cindyhere33 · 2017-12-15T19:24:33Z

exchange/exchange.go

+	e.adapters = make([]openrtb_ext.BidderName, 0, len(e.adapterMap))
+	for a, _ := range e.adapterMap {
+		e.adapters = append(e.adapters, a)
+	}


I know it's late, but I believe it is slightly better to not use append when we know the size already.

nods, I think that's a good point... it probably is more efficient to index into it directly. Will try to remember it in the future.

* Added openrtb contract classes. * Normalized the documentation. * Ran gofmt. * fixed some more comments. * Added CacheURL to the openrtb types. * Bidder interface. * First pass at appnexus adapter implementation. * Limited the Appnexus adapter to only handle banner and video requests. * Made a first pass at Bidder interfaces. * Removed an unused class. * First pass at openrtb BidRequest cleaning * Added a return so that the code builds. * Renamed adapter.go to bidder.go * Changed appnexus adapter to implement the SingleHttpBidder. * Changed the Bidder type signature slightly. * Pass 2 of BidRequest cleaner * Updated API contract classes, and refactored the singleBidderAdapter so that it compiles again. * Wrote an http bidder which should work for everyone. * Replaced the old base bidder with one which works for both bidding strategies. * Updated the appnexus adapter so that it still implements the interface. * Updated documentation. * Added tests to http_bidder.go, and fixed some bugs. * Exchange probably compiles, but is not done * Swapped the order of the HoldAuction arguments. * Added an openrtb endpoint. Made an interface for Exchange. * End of the week commit. Should be in a relatively sane state * Fixed some build errors. * Fixed a bug in NewExchange. * Fixed some more bugs in the exchange. * Added an openrtb2/auction endpoint for end-to-end tests. * First exchange that can (theoretically) produce a bid response * Fixes for <adapter>.Bid() returning a null pointer * Fixes for <adapter>.Bid() null fix: keep existing debug info * Added input validation for incoming openrtb requests. * Fixes for <adapter>.Bid() : actually save debugging info now * Some input validation cleanup. * Added a test for a successful bid. * Fixed some more bugs. The auction with the appnexus adapter now works from end-to-end. * Made a BidderName enum type, and ported some method signatures to use it. * Removed silly newlines. * Removed some more dead code. * Starting to add exchange tests * Added lots of unit tests for input validation. * Renamed ServerCalls to HttpCalls everywhere. * pre-merge commit * Tests and fixes * Connected bidder param request validation to the json schemas * Fixed some bugs. * Undid some changes to the facebook json schema. * Updated glide.lock. Removed more unexpected changes. * Cleaned up the endpoint_test file. * Added more tests. Improved the endpoint class role to avoid glog.Fatals. * Added some tests for the bidder json-schema validation. * Improved handling of GetAllBids go routine and more tests * Added a benchmark for the openrtb endpoint. * Renamed the openrtb_auction package to openrtb2. * Added a markdown file describing the openrtb2 endpoint. * More tests in, including a null response from an adapter as their bid response. * Add proper error handling of the json Marshal errors to the exchange code. * Implemented the timeout. * Return a 500 if the exchange fails with an error. * Added lots of tests. More to come soon. * More appnexus tests. * Removed some of the TODOs. * Added tests for appnexus param validation * Added another test where unit coverage was spotty. * Deleted some unused code, including the Cache stuff. * Removed some dead comments. * Removed some more TODOs * Added a doc.go to the openrtb_ext package. * Refactoring and cleanup based on suggestions from Nicole. * Moved the appnexus imp.ext into its own file. * Renamed exchange.bidder to exchange.adaptedBidder. * Fixed more docs, and made more things private. * Replaced the response.seatbid.ext map with the contract class. * Added support for Targeting. Adding tests to CleanOpenRTBRequests, work needed here still. * Revert "Added support for Targeting. Adding tests to CleanOpenRTBRequests, work needed here still." This reverts commit f2efcca. * Adding tests to insure proper extensions get passed to adapters during the request cleaning stage. * Fixed docs based on the documentation writer's feedback * Fixed some spaces => tabs formatting. * Fixed go vet errors. * Added docs for adding a new bidder. * Linked the README to the adding a new bidder doc. * Relocated utils.go into exchange, and made the functions private. * Privitized internal exchange functions. * Code review improvements. * A few small fixes from PR comments * Optimizations in cleanOpenRTBRequests * Fixed a bug which resulted in empty seatbid.ext objects. * Fixed some bugs in the contract classes. * Improved two of the unit tests.

* Support redis client * change redis params * Read redis conf from env

dbemiller and others added 30 commits October 30, 2017 12:14

Added openrtb contract classes.

3688ac7

Normalized the documentation.

14bb101

Ran gofmt.

74dcc55

fixed some more comments.

fdb14d0

Merge branch 'master' of https://github.com/prebid/prebid-server into…

6fc14df

… openrtb-types

Merge branch 'master' of https://github.com/prebid/prebid-server into…

133cd59

… openrtb-types

Added CacheURL to the openrtb types.

b6f740f

Merge pull request #1 from prebid/openrtb-types

54b7634

Openrtb types

Bidder interface.

7eecef4

First pass at appnexus adapter implementation.

b469834

Limited the Appnexus adapter to only handle banner and video requests.

d3322a7

Made a first pass at Bidder interfaces.

a344439

Removed an unused class.

7ab94ae

First pass at openrtb BidRequest cleaning

6b88ba2

Merge branch 'master' of https://github.com/dbemiller/prebid-server

1646922

Added a return so that the code builds.

587acf3

Renamed adapter.go to bidder.go

2a6bf4f

Changed appnexus adapter to implement the SingleHttpBidder.

0dfaeb0

Changed the Bidder type signature slightly.

1ee2105

Pass 2 of BidRequest cleaner

4718216

Pass 2 of BidRequest cleaner/merge conflicts

632f2b2

Updated API contract classes, and refactored the singleBidderAdapter …

cd6ddd2

…so that it compiles again.

Merge branch 'master' of https://github.com/dbemiller/prebid-server

e9cab40

Wrote an http bidder which should work for everyone.

d094d74

Replaced the old base bidder with one which works for both bidding st…

0951d7f

…rategies.

Updated the appnexus adapter so that it still implements the interface.

d1c48e2

Updated documentation.

f6c88f1

Added tests to http_bidder.go, and fixed some bugs.

0096cc1

Exchange probably compiles, but is not done

445cf91

Swapped the order of the HoldAuction arguments.

779a436

Fixed a bug which resulted in empty seatbid.ext objects.

bed7d7e

ndhimehta assigned DucChau Nov 15, 2017

dbemiller mentioned this pull request Nov 16, 2017

Conversant s2s adapter #202

Merged

Fixed some bugs in the contract classes.

b256e48

bretg requested a review from sandraleon November 17, 2017 21:21

sandraleon previously approved these changes Nov 21, 2017

View reviewed changes

dbemiller dismissed sandraleon’s stale review via e42d8f6 November 21, 2017 14:18

Improved two of the unit tests.

e42d8f6

mkendall07 approved these changes Nov 21, 2017

View reviewed changes

dbemiller merged commit 9a7fec4 into master Nov 21, 2017

dbemiller deleted the support-openrtb branch November 21, 2017 14:23

dbemiller restored the support-openrtb branch November 21, 2017 14:27

dbemiller deleted the support-openrtb branch November 21, 2017 14:37

dbemiller restored the support-openrtb branch November 21, 2017 14:38

dbemiller mentioned this pull request Nov 21, 2017

Handle optout cookie #205

Merged

dbemiller deleted the support-openrtb branch November 21, 2017 15:39

cindyhere33 reviewed Nov 30, 2017

View reviewed changes

dbemiller mentioned this pull request Dec 7, 2017

Create Auction endpoints which are OpenRTB-compliant #150

Closed

cindyhere33 reviewed Dec 15, 2017

View reviewed changes

dbemiller mentioned this pull request Dec 19, 2017

OpenRTB Support: Conversant adapter #267

Closed

pm-nilesh-chate pushed a commit to pm-nilesh-chate/prebid-server that referenced this pull request Feb 25, 2023

Handled NPE in interstitial.go (prebid#196)

1ef324d

allar15 pushed a commit to allar15/prebid-server that referenced this pull request Nov 24, 2023

[PBS-234] Support redis client (prebid#196)

dbd9dd8

* Support redis client * change redis params * Read redis conf from env

StarWindMoonCloud pushed a commit to ParticleMedia/prebid-server that referenced this pull request Jun 5, 2024

ad cache (prebid#196)

cfa5cef

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding OpenRTB support #196

Adding OpenRTB support #196

dbemiller commented Nov 13, 2017

sandraleon left a comment

sandraleon Nov 21, 2017

sandraleon Nov 21, 2017

sandraleon Nov 21, 2017

cindyhere33 Nov 30, 2017

dbemiller Nov 30, 2017

cindyhere33 Dec 15, 2017

dbemiller Dec 18, 2017

Adding OpenRTB support #196

Adding OpenRTB support #196

Conversation

dbemiller commented Nov 13, 2017

sandraleon left a comment

Choose a reason for hiding this comment

sandraleon Nov 21, 2017

Choose a reason for hiding this comment

sandraleon Nov 21, 2017

Choose a reason for hiding this comment

sandraleon Nov 21, 2017

Choose a reason for hiding this comment

cindyhere33 Nov 30, 2017

Choose a reason for hiding this comment

dbemiller Nov 30, 2017

Choose a reason for hiding this comment

cindyhere33 Dec 15, 2017

Choose a reason for hiding this comment

dbemiller Dec 18, 2017

Choose a reason for hiding this comment