Pubxai Analytics Adapter: bug fixes and code revamp #6474
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,15 +6,19 @@ import * as utils from '../src/utils.js'; | |
|
|
||
| const emptyUrl = ''; | ||
| const analyticsType = 'endpoint'; | ||
| const pubxaiAnalyticsVersion = 'v1.1.0'; | ||
| const defaultHost = 'api.pbxai.com'; | ||
| const auctionPath = '/analytics/auction'; | ||
| const winningBidPath = '/analytics/bidwon'; | ||
|
|
||
| let initOptions; | ||
| let auctionTimestamp; | ||
| let auctionCache = []; | ||
| let events = { | ||
| bids: [], | ||
| floorDetail: {}, | ||
| pageDetail: {}, | ||
| deviceDetail: {} | ||
| }; | ||
|
|
||
| var pubxaiAnalyticsAdapter = Object.assign(adapter( | ||
|
|
@@ -27,14 +31,14 @@ var pubxaiAnalyticsAdapter = Object.assign(adapter( | |
| if (eventType === CONSTANTS.EVENTS.BID_TIMEOUT) { | ||
| args.forEach(item => { mapBidResponse(item, 'timeout'); }); | ||
| } else if (eventType === CONSTANTS.EVENTS.AUCTION_INIT) { | ||
| events.auctionInit = args; | ||
| events.floorDetail = {}; | ||
| events.bids = []; | ||
| const floorData = utils.deepAccess(args, 'bidderRequests.0.bids.0.floorData'); | ||
| if (typeof args.bidderRequests[0].bids[0] !== 'undefined' && typeof floorData !== 'undefined') { | ||
| Object.assign(events.floorDetail, floorData); | ||
| } | ||
| auctionTimestamp = args.timestamp; | ||
| } else if (eventType === CONSTANTS.EVENTS.BID_RESPONSE) { | ||
| mapBidResponse(args, 'response'); | ||
| } else if (eventType === CONSTANTS.EVENTS.BID_WON) { | ||
|
|
@@ -43,81 +47,48 @@ var pubxaiAnalyticsAdapter = Object.assign(adapter( | |
| }, 'bidwon'); | ||
| } | ||
| } | ||
| if (eventType === CONSTANTS.EVENTS.AUCTION_END) { | ||
| send(events, 'auctionEnd'); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| function mapBidResponse(bidResponse, status) { | ||
| if (typeof bidResponse !== 'undefined' && bidResponse) { | ||
|
There was a problem hiding this comment. Not sure if there is a need to check if type is undefined AND also if the value is truthy. I think just one of the other is enough. |
||
| let bid = { | ||
| adUnitCode: bidResponse.adUnitCode, | ||
| auctionId: bidResponse.auctionId, | ||
| bidderCode: bidResponse.bidder, | ||
| cpm: bidResponse.cpm, | ||
| creativeId: bidResponse.creativeId, | ||
| currency: bidResponse.currency, | ||
| floorData: bidResponse.floorData, | ||
| mediaType: bidResponse.mediaType, | ||
| netRevenue: bidResponse.netRevenue, | ||
| requestTimestamp: bidResponse.requestTimestamp, | ||
| responseTimestamp: bidResponse.responseTimestamp, | ||
| status: bidResponse.status, | ||
| statusMessage: bidResponse.statusMessage, | ||
| timeToRespond: bidResponse.timeToRespond, | ||
| transactionId: bidResponse.transactionId | ||
| }; | ||
| if (status !== 'bidwon') { | ||
| Object.assign(bid, { | ||
| bidId: status === 'timeout' ? bidResponse.bidId : bidResponse.requestId, | ||
| renderStatus: status === 'timeout' ? 3 : 2, | ||
| sizes: utils.parseSizesInput(bidResponse.size).toString(), | ||
| }); | ||
| events.bids.push(bid); | ||
| } else { | ||
| Object.assign(bid, { | ||
| bidId: bidResponse.requestId, | ||
| floorProvider: events.floorDetail ? events.floorDetail.floorProvider : null, | ||
| isWinningBid: true, | ||
| placementId: bidResponse.params ? utils.deepAccess(bidResponse, 'params.0.placementId') : null, | ||
| renderedSize: bidResponse.size, | ||
| renderStatus: 4 | ||
| }); | ||
| return bid; | ||
| } | ||
| } | ||
| } | ||
|
|
@@ -132,6 +103,36 @@ export function getDeviceType() { | |
| return 'desktop'; | ||
| } | ||
|
|
||
| export function getBrowser() { | ||
| var isChrome = | ||
| /Chrome/.test(navigator.userAgent) && /Google Inc/.test(navigator.vendor); | ||
| var isCriOS = navigator.userAgent.match('CriOS'); | ||
| var isSafari = | ||
| /Safari/.test(navigator.userAgent) && | ||
| /Apple Computer/.test(navigator.vendor); | ||
| var isFirefox = /Firefox/.test(navigator.userAgent); | ||
| var isIE = | ||
| /Trident/.test(navigator.userAgent) || /MSIE/.test(navigator.userAgent); | ||
| var isEdge = /Edge/.test(navigator.userAgent); | ||
| if (isIE) return 'Internet Explorer'; | ||
| if (isEdge) return 'Microsoft Edge'; | ||
| if (isCriOS) return 'Chrome'; | ||
| if (isSafari) return 'Safari'; | ||
| if (isFirefox) return 'Firefox'; | ||
| if (isChrome) return 'Chrome'; | ||
| return 'Others'; | ||
|
There was a problem hiding this comment. Instead of assigning variables for every single combo, I think it would be cleaner to just do a chain of if / else ifs (and maybe sort them in a order of % of users who use which browser even to make it even more optimized! if (/Chrome/.test(navigator.userAgent) && /Google Inc/.test(navigator.vendor)) return 'Chrome';
else if (navigator.userAgent.match('CriOS')) return 'Chrome';
else if (/Firefox/.test(navigator.userAgent)) return 'Firefox';
else if (/Safari/.test(navigator.userAgent) && /Apple Computer/.test(navigator.vendor)) return 'Safari';
else if (/Edge/.test(navigator.userAgent)) return 'Microsoft Edge';
else if (/Trident/.test(navigator.userAgent) || /MSIE/.test(navigator.userAgent)) return 'Internet Explorer';
else return 'Others';Maybe something like that? My best guess is Chrome > FF > Safari > Edge > IE But feel free to order them however you would like. There was a problem hiding this comment. This function was taken directly from another adapter and I kept it as it is. Thanks for your inputs, I have updated the code as you suggested. There was a problem hiding this comment. This seems wrong, order matters, you have to test for edge before safari for example and your edge test is wrong https://docs.microsoft.com/en-us/microsoft-edge/web-platform/user-agent-string There was a problem hiding this comment. @patmmccann I have updated the order so that edge test comes before safari and updated edge token to There was a problem hiding this comment. Sorry, was not aware that order mattered. Which is why I ordered by what I thought was most used browsers! Makes sense if both have similar UA's |
||
| } | ||
|
|
||
| export function getOS() { | ||
| if (navigator.userAgent.indexOf('Android') != -1) return 'Android'; | ||
| if (navigator.userAgent.indexOf('like Mac') != -1) return 'iOS'; | ||
| if (navigator.userAgent.indexOf('Win') != -1) return 'Windows'; | ||
| if (navigator.userAgent.indexOf('Mac') != -1) return 'Macintosh'; | ||
| if (navigator.userAgent.indexOf('Linux') != -1) return 'Linux'; | ||
| if (navigator.appVersion.indexOf('X11') != -1) return 'Unix'; | ||
| return 'Others'; | ||
| } | ||
|
|
||
| // add sampling rate | ||
| pubxaiAnalyticsAdapter.shouldFireEventRequest = function (samplingRate = 1) { | ||
| return (Math.floor((Math.random() * samplingRate + 1)) === parseInt(samplingRate)); | ||
|
|
@@ -140,12 +141,24 @@ pubxaiAnalyticsAdapter.shouldFireEventRequest = function (samplingRate = 1) { | |
| function send(data, status) { | ||
| if (pubxaiAnalyticsAdapter.shouldFireEventRequest(initOptions.samplingRate)) { | ||
| let location = utils.getWindowLocation(); | ||
| data.initOptions = initOptions; | ||
| if (typeof data !== 'undefined' && typeof data.auctionInit !== 'undefined') { | ||
| Object.assign(data.pageDetail, { | ||
| host: location.host, | ||
| path: location.pathname, | ||
| search: location.search, | ||
| adUnitCount: data.auctionInit.adUnitCodes ? data.auctionInit.adUnitCodes.length : null | ||
| }); | ||
| data.initOptions.auctionId = data.auctionInit.auctionId; | ||
| delete data.auctionInit; | ||
| } | ||
| data.deviceDetail = {}; | ||
| Object.assign(data.deviceDetail, { | ||
| platform: navigator.platform, | ||
| deviceType: getDeviceType(), | ||
| deviceOS: getOS(), | ||
| browser: getBrowser() | ||
| }); | ||
| let pubxaiAnalyticsRequestUrl = utils.buildUrl({ | ||
| protocol: 'https', | ||
| hostname: (initOptions && initOptions.hostName) || defaultHost, | ||
|
|
@@ -156,8 +169,12 @@ function send(data, status) { | |
| prebidVersion: $$PREBID_GLOBAL$$.version | ||
| } | ||
| }); | ||
| if (status == 'bidwon') { | ||
| ajax(pubxaiAnalyticsRequestUrl, undefined, JSON.stringify(data), { method: 'POST', contentType: 'text/json' }); | ||
| } else if (status == 'auctionEnd' && auctionCache.indexOf(data.initOptions.auctionId) === -1) { | ||
| ajax(pubxaiAnalyticsRequestUrl, undefined, JSON.stringify(data), { method: 'POST', contentType: 'text/json' }); | ||
| auctionCache.push(data.initOptions.auctionId); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this seems like overkill,
Can you simply just do: