New Adapter: SmartHub

[SmartHubSolutions]

No description provided.

[SmartHubSolutions]

@VeronikaSolovei9 @AlexBVolcy @SyntaxNode

Hello, guys! :) Could you please confirm that we meet requirements to start a review process? Maybe we've done something wrong and need to fix this or add something else?

There is our PR with docs: prebid/prebid.github.io#3131

[mansinahar]

Please rename this to adapter. There's no need to repeat the package name in the adapter type. Please review our new adapter docs: https://docs.prebid.org/prebid-server/developers/add-new-bidder-go.html

[SmartHubSolutions]

Thank you, I've fixed this. Do other things look correct?

[VeronikaSolovei9]

Hello @SmartHubSolutions, I apologize for the delay in review.
I added some comments, other than that it looks good to me.
Thank you for adding documentation PR!

[VeronikaSolovei9]

What is the reason behind naming output parameters? In MakeBids function as well.

[SmartHubSolutions]

There is no reason. I've removed in both

[VeronikaSolovei9]

Is it always only one bid in response?

[SmartHubSolutions]

Yes, we don't support more than one bid in response

[VeronikaSolovei9]

Can you please don't add aliases for other bidders? There shouldn't be any name conflicts.

[SmartHubSolutions]

Yes, of course. I've removed them

[guscarreon]

Nitpick: Prebid server core filters out requests with empty []Imp arrays so there's no need for this check. I realize this isn't a lot overhead so you could leave it or remove it if you want.

[SmartHubSolutions]

Removed this

[guscarreon]

I see you pass all three parameters to your URL. Do you need all three to NOT be empty? As of right now, you marked them as required inside static/bidder-params/smarthub.json but they can still be zero-lenght strings. In case you need that any or all three of your parameters to not be empty you could add the minLength property like:

   {
     "$schema": "http://json-schema.org/draft-04/schema#",
     "title": "SmartHub Adapter Params",
     "description": "A schema which validates params accepted by the SmartHub adapter",
     "type": "object",
     "properties": {
       "host": {
         "type": "string",
         "description": "Network host to send request"
 +       "minLength": 1
       },
       "seat": {
         "type": "string",
         "description": "Seat"
 +       "minLength": 1
       },
       "token": {
         "type": "string",
         "description": "Token"
 +       "minLength": 1
       }
     },
     "required": [
       "host",
       "seat",
       "token"
     ]
   }
static/bidder-params/smarthub.json

Without the additions shown above, an all empty parameter req.Imp[i].Ext would be allowed. In other words, for the moment, a test case like this is currently passing:

   var invalidParams = []string{
   	``,
   	`null`,
   	`true`,
   	`5`,
   	`[]`,
   	`{}`,
   	`{"anyparam": "anyvalue"}`,
   	`{"host":"smarthub.test"}`,
   	`{"seat":"9Q20EdGxzgWdfPYShScl"}`,
   	`{"token":"Y9Evrh40ejsrCR4EtidUt1cSxhJsz8X1"}`,
   	`{"seat":"9Q20EdGxzgWdfPYShScl", "token":"alNYtemWggraDVbhJrsOs9pXc3Eld32E"}`,
   	`{"host":"smarthub.test", "token":"LNywdP2ebX5iETF8gvBeEoB6Cam64eeq"}`,
   	`{"host":"smarthub.test", "seat":"9Q20EdGxzgWdfPYShScl"}`,
 + 	`{"host":"", "seat":"", "token":""}`,  // <-- all empty fields test case is passing right now
   }
adapters/smarthub/params_test.go

[guscarreon]

If that's what you intended, it's fine

[SmartHubSolutions]

Yes, thanks a lot for pointing the mistake! All three parameters mustn't be an empty string. I've fixed this in static/bidder-params/smarthub.json and also added possible cases to test into invalidParams

[VeronikaSolovei9]

Thank you for addressing comments. LGTM.

[guscarreon]

Hello @SmartHubSolutions . Despite being a proxy server, our policy is that Prebid server can pass subdomains but not whole domains. Can you please modify?
Allowed:

952      v.SetDefault("adapters.smarthub.endpoint", "http://{{.Host}}.restofsmarthubdomain.com/?seat={{.AccountID}}&token={{.SourceId}}")
config/config.go

Not-allowed:

952      v.SetDefault("adapters.smarthub.endpoint", "http://{{.Host}}/?seat={{.AccountID}}&token={{.SourceId}}")
config/config.go

[SmartHubSolutions]

Unfortunately, impossible for us. Replacing of all host is the only one way how we work with our partners. We need to leave this how it is. BTW, there are a lot of adapters with the same pattern. Several examples:

858	v.SetDefault("adapters.adkernel.endpoint", "http://{{.Host}}/hb?zone={{.ZoneID}}")
config/config.go

link

918	v.SetDefault("adapters.invibes.endpoint", "https://{{.Host}}/bid/ServerBidAdContent")
config/config.go

link

978	v.SetDefault("adapters.zeroclickfraud.endpoint", "http://{{.Host}}/openrtb2?sid={{.SourceId}}")
config/config.go

link

[mansinahar]

@SmartHubSolutions We're aware that there are a few other adapters that use this approach for the hosts but it's an anti-pattern that we as a Prebid Server committee strongly oppose and are currently working with these adapters to correct their behavior. We're focused on making sure that this pattern isn't used for any other adapters going further. It's odd to ask the publisher to specify the server address of the bidder, it greatly harms Prebid Server's performance which is based on keep alive connections to bidders, and allowing the publisher to pass the host through opens up PBS to a variety of attacks.

Can you please help us understand your use case for this? We'd be happy to work with you to find a better solution for your use case, if possible.

In case the use case here is to have the Publishers specify the host based on the region they are in then the recommended approach for that is to use a default endpoint pointing to your company's global load balancer. If you don't have a global load balancer, consider marking the adapter as disabled by default and add instructions in your bidder docs to let hosts know which endpoints to use for their geo regions, or ask them to contact you directly to setup if you don't want to publicly post those endpoints.

[SmartHubSolutions]

@mansinahar Thank you for this detailed explanation! Now, everything is clear. I'll discuss this with my team to find a solution. We'll definitely find it and back soon.

[SmartHubSolutions]

@mansinahar I've written below how we had changed URL template.Does it meet requirements now? :) Can we continue our review process?

[guscarreon]

Just double-checking: are you registered with IAB Europe? If you don't, that's fine. If you do, IAB's GVL id number must be written into this file as shown below. Just double-checking in case you are.

 1   maintainer:
 2     email: "support@smart-hub.io"
   + gvlVendorID: <IABs_GVL_ID>
 3   capabilities:
 4     app:
 5       mediaTypes:
 6         - banner
 7         - video
 8         - native
 9     site:
10       mediaTypes:
11         - banner
12         - video
13         - native
static/bidder-info/smarthub.yaml

[SmartHubSolutions]

SmartHub is the solution for different companies which every has own registration and Vendor ID. Every company which receive traffic will process European data by itself. If a company doesn't have Vendor ID, SmartHub clean all data due to IAB recommendations. SmartHub completely support GDPR, but I think it's incorrect to write our Vendor ID here

[SmartHubSolutions]

@guscarreon @mansinahar Hi!
We've fixed the way how to build endpoint URL according your recommendations. Thank you! Now our URL template looks like:

"http://{{.Host}}-prebid.smart-hub.io/?seat={{.AccountID}}&token={{.SourceId}}"

Also, we've updated docs PR: prebid/prebid.github.io#3131
Could we continue the review process?

[VeronikaSolovei9]

LGTM

[guscarreon]

@SmartHubSolutions thank you for addressing our feedback. Your code looks pretty good.