ADS-4131 Add LiftIgniterAnalyticsAdapter

[yonran]

This change adds LiftIgniterAnalyticsAdapter, which sends the CPM from AuctionEnd to LiftIgniter.

It’s sort of based on mavenAnalyticsAdapter (hummingbird). Like mavenAnalyticsAdapter, this adapter waits 1s after the auctionEnd event before sending the event to LiftIgniter. Like mavenAnalyticsAdapter, it combines multiple auctionEnd events into a single request. (Hopefully we don’t hit the Google Load Balancer’s 16KiB headers + URL limit.) And unlike mavenAnalyticsAdapter, it only sends the auction’s id and the ad units’ code and cpm for now.

Current format:

$p('send', 'prebid', {
  batch: JSON.stringify([
    {
      auc: args.auctionId,
      codes: [adUnit.code],  // one per ad unit; can be zipped with cpms
      cpms: [max(bid.cpm)],  // one per ad unit
  ])
})

Sample batch:

[
  {
    "auc": "17beb41d-d650-40a2-90bf-011e0635012a",
    "codes": [
      "ad-efb258fe6fee427e991a9c7ba76927a9",
      "ad-a05abdb5a6be42b6a1a738c9dc0442c0",
      "ad-b1b93a0e4cda4ed3a52f939ec505ca7c",
      "ad-7e3da3ca8639437e92fff1fae3ad83e7",
      "ad-5d118e9a51e446fda8e37d5a3157109e"
    ],
    "cpms": [
      0,
      0,
      0,
      0,
      0
    ]
  }
]

This compares to mavenAnalyticsAdapter (hummingbird), which has many more fields:

\d hummingbird_auction
                               Table "admin.hummingbird_auction"
       Column        |           Type           | Collation | Nullable |        Default        
---------------------+--------------------------+-----------+----------+-----------------------
 auction_id          | character varying(50)    |           | not null | 
 correlator          | bigint                   |           | not null | 
 country_code        | character(2)             |           | not null | 
 maven_channel       | character varying(40)    |           | not null | 
 path                | character varying(2000)  |           | not null | 
 pod                 | smallint                 |           | not null | 
 production_domain   | character varying(40)    |           | not null | 
 screen_size         | character(1)             |           | not null | 
 timeout_period      | integer                  |           | not null | 
 bidder              | character varying(20)    |           | not null | 
 action              | character(1)             |           | not null | 
 cpm_mills           | integer                  |           |          | 
 time_to_respond     | integer                  |           |          | 
 adzone_id           | character varying(50)    |           |          | 
 zone_name           | character varying(20)    |           |          | 
 zone_index          | smallint                 |           |          | 
 datetime            | timestamp with time zone |           | not null | 
 content_item_id     | character varying(32)    |           | not null | ''::character varying
 is_deal             | boolean                  |           |          | 
 deal_id             | character varying(50)    |           |          | 
 conn_effective_type | character varying(20)    |           |          | 
 browser_type        | character varying(20)    |           |          | 

[partha0solapurkar]

I approve the data format, but someone who is familiar with the codebase should review the actual changes

[snark]

So this looks broadly right to me, but if we want to offer this as a public Prebid.js adapter--which I think we should, as there are LiftIgniter clients not on any of the Maven platforms, correct?--we want to handle the sampling behavior slightly differently. In particular, we want to accept samplingFactor as a config option (this is going to be in the form of an int n, where the sampling factor is 1/n--i.e. "20" means sample at a 5% rate) in addition to sampling. If you take a look at the rubiconAnalyticsAdapter in the repo, you can see how they've set it up. Once you do that, you can in fact hand it off to baseAdapter.enableAnalytics.call(this, config), and let the PBJS code handle the dice roll for you. (We don't do this on Tempest with mavenAnalyticsAdapter, because we want Tempest to have the ability to force-override this behavior, but the LI adapter will be less tightly integrated with Tempest and I don't think needs that.)

[martiantim]

I wonder if we should give this a more Maven-y name? MavenRecommendationAdapter? MavenDistributionAdapter?

[yonran]

Vipul and Partha said that they want zone names (e.g. ["fixed_bottom", "in_content"]) and indexes (e.g. [0, 0]) instead of adUnit codes (e.g. ["ad-2187d2c4fe0e41cba63ce02d28fc202e", "ad-44c4b8c1c5a14d01bc57e15f4441c18a"]), so I have changed the format.

@snark I rg’d samplingFactor and found that the only references are inrubiconAnalyticsAdapter, so it is the only adapter that supports this option as an alternative to sampling. Therefore, I don’t think it should be added.

In the latest commit I made it use an AnalyticsAdapter object as a base. I am a bit concerned that the code for queuing requests until window[global] is available seems to be broken because this conditional (if (analyticsType === ENDPOINT || BUNDLE) {…}) is always true. Hopefully this doesn’t break when that code is fixed.

@martiantim I am open to any name change

[yonran]

I rebased to combine all the commits into one and set the author.

[snark]

This looks solid to me. +1.

[snark]

Do we want to have a separate liftigniter feature flag? We currently use a use-prebid-next feature flag for activating the "prebid-next.js" script instead of the normal one, which is what I was thinking of when I mentioned feature flags. (If we do want to use a separate liftigniter feature flag, that's fine, just not what I was thinking of).

[yonran]

Do we want to have a separate liftigniter feature flag? We currently use a use-prebid-next feature flag for activating the "prebid-next.js" script instead of the normal one, which is what I was thinking of when I mentioned feature flags. (If we do want to use a separate liftigniter feature flag, that's fine, just not what I was thinking of).

Are you saying that I should take out if (this.features.isEnabled('use-liftigniter-prebid-analytics') && config.pbjsConfig) in PrebidJS.js of themaven-net/tempest-phoenix#417?

[yonran]

I have taken @martiantim ’s suggestion and renamed it to mavenDistributionAnalyticsAdapter.

[martiantim]

+1!

[snark]

@yonran Yes, sorry, I was commenting on the wrong PR. I'll move my comments over there.