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

Build Related : rename constants.json to constants.js #11292

Merged
merged 30 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
e210f4e
Fix lintWarnings gulp parameter
muuki88 Apr 4, 2024
15be9f4
Fix #10829 Rename constants.json to constant.js
muuki88 Apr 4, 2024
3958a4e
Remove unnecessary quotes
muuki88 Apr 4, 2024
53a545f
Fix import in genericAnalyticsAdapter
muuki88 Apr 4, 2024
6d327c1
remove unnecessary quotes
muuki88 Apr 4, 2024
fd88316
Change require to imports
muuki88 Apr 4, 2024
cccecc9
Revert "Fix lintWarnings gulp parameter"
muuki88 Apr 5, 2024
a83ab95
Add nolint and no-lint-warnings docs to README
muuki88 Apr 5, 2024
a452c02
WIP refactoring constants into separated exported files
muuki88 Apr 5, 2024
bf3a162
Refactor the rest of imports
muuki88 Apr 5, 2024
8e2652f
Fix invalid import
muuki88 Apr 5, 2024
7ed33b7
Add missing MESSAGSES import
muuki88 Apr 5, 2024
b7544db
Add missing S2S import
muuki88 Apr 5, 2024
2bcc554
Fix broken constants.js import
muuki88 Apr 5, 2024
dbbb680
Use proper events import in magnite adapter
muuki88 Apr 5, 2024
c2136c1
Add import to pubmatic spec
muuki88 Apr 5, 2024
df98199
Found another CONSTANTS import
muuki88 Apr 5, 2024
165767e
Fix shadowed var
muuki88 Apr 5, 2024
156c590
fix zeta global test
muuki88 Apr 5, 2024
0bc5bad
Add missing BID_STATUS import
muuki88 Apr 5, 2024
da52a0c
Fix zeta global ssp analytics for real
muuki88 Apr 5, 2024
2c83df2
fix lint error
muuki88 Apr 5, 2024
c8c2571
Remove duplicated TARGETING_KEYS definition
muuki88 Apr 5, 2024
ee94899
Move FLOOR_SKIPPED_REASON into priceFloors.js
muuki88 Apr 10, 2024
1fb8017
Remove unused CB constants
muuki88 Apr 10, 2024
8b449f4
Move FLOOR_SKIPPED_REASON into pubmaticAnalyticsAdapter
muuki88 Apr 10, 2024
9984468
Merge remote-tracking branch 'origin/master' into fix-10829-constants…
muuki88 Apr 10, 2024
35e2881
Use proper import
muuki88 Apr 10, 2024
52011ee
Merge remote-tracking branch 'origin' into fix-10829-constants-json
muuki88 Apr 15, 2024
616530d
Remove unused var and fix linting error
muuki88 Apr 15, 2024
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
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,12 @@ To lint the code:
gulp lint
```

To lint and only show errors

```bash
gulp lint --no-lint-warnings
```

To run the unit tests:

```bash
Expand All @@ -245,7 +251,7 @@ gulp test

To run the unit tests for a particular file (example for pubmaticBidAdapter_spec.js):
```bash
gulp test --file "test/spec/modules/pubmaticBidAdapter_spec.js"
gulp test --file "test/spec/modules/pubmaticBidAdapter_spec.js" --nolint
```

To generate and view the code coverage reports:
Expand Down
14 changes: 7 additions & 7 deletions creative/constants.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// eslint-disable-next-line prebid/validate-imports
import CONSTANTS from '../src/constants.json';
import { AD_RENDER_FAILED_REASON, EVENTS, MESSAGES } from '../src/constants.js';

export const MESSAGE_REQUEST = CONSTANTS.MESSAGES.REQUEST;
export const MESSAGE_RESPONSE = CONSTANTS.MESSAGES.RESPONSE;
export const MESSAGE_EVENT = CONSTANTS.MESSAGES.EVENT;
export const EVENT_AD_RENDER_FAILED = CONSTANTS.EVENTS.AD_RENDER_FAILED;
export const EVENT_AD_RENDER_SUCCEEDED = CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED;
export const ERROR_EXCEPTION = CONSTANTS.AD_RENDER_FAILED_REASON.EXCEPTION;
export const MESSAGE_REQUEST = MESSAGES.REQUEST;
export const MESSAGE_RESPONSE = MESSAGES.RESPONSE;
export const MESSAGE_EVENT = MESSAGES.EVENT;
export const EVENT_AD_RENDER_FAILED = EVENTS.AD_RENDER_FAILED;
export const EVENT_AD_RENDER_SUCCEEDED = EVENTS.AD_RENDER_SUCCEEDED;
export const ERROR_EXCEPTION = AD_RENDER_FAILED_REASON.EXCEPTION;
4 changes: 2 additions & 2 deletions creative/renderers/display/constants.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// eslint-disable-next-line prebid/validate-imports
import CONSTANTS from '../../../src/constants.json';
import { AD_RENDER_FAILED_REASON } from '../../../src/constants.js';

export const ERROR_NO_AD = CONSTANTS.AD_RENDER_FAILED_REASON.NO_AD;
export const ERROR_NO_AD = AD_RENDER_FAILED_REASON.NO_AD;
4 changes: 2 additions & 2 deletions creative/renderers/native/constants.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// eslint-disable-next-line prebid/validate-imports
import CONSTANTS from '../../../src/constants.json';
import { MESSAGES } from '../../../src/constants.js';

export const MESSAGE_NATIVE = CONSTANTS.MESSAGES.NATIVE;
export const MESSAGE_NATIVE = MESSAGES.NATIVE;
export const ACTION_RESIZE = 'resizeNativeHeight';
export const ACTION_CLICK = 'click';
export const ACTION_IMP = 'fireNativeImpressionTrackers';
Expand Down
8 changes: 4 additions & 4 deletions libraries/analyticsAdapter/AnalyticsAdapter.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import CONSTANTS from '../../src/constants.json';
import { EVENTS } from '../../src/constants.js';
import {ajax} from '../../src/ajax.js';
import {logError, logMessage} from '../../src/utils.js';
import * as events from '../../src/events.js';
Expand All @@ -9,8 +9,8 @@ export const _internal = {
const ENDPOINT = 'endpoint';
const BUNDLE = 'bundle';

export const DEFAULT_INCLUDE_EVENTS = Object.values(CONSTANTS.EVENTS)
.filter(ev => ev !== CONSTANTS.EVENTS.AUCTION_DEBUG);
export const DEFAULT_INCLUDE_EVENTS = Object.values(EVENTS)
.filter(ev => ev !== EVENTS.AUCTION_DEBUG);

let debounceDelay = 100;

Expand Down Expand Up @@ -114,7 +114,7 @@ export default function AnalyticsAdapter({ url, analyticsType, global, handler }
const trackedEvents = (() => {
const {includeEvents = DEFAULT_INCLUDE_EVENTS, excludeEvents = []} = (config || {});
return new Set(
Object.values(CONSTANTS.EVENTS)
Object.values(EVENTS)
.filter(ev => includeEvents.includes(ev))
.filter(ev => !excludeEvents.includes(ev))
);
Expand Down
6 changes: 2 additions & 4 deletions modules/33acrossAnalyticsAdapter.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
import { deepAccess, logInfo, logWarn, logError, deepClone } from '../src/utils.js';
import buildAdapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
import adapterManager, { coppaDataHandler, gdprDataHandler, gppDataHandler, uspDataHandler } from '../src/adapterManager.js';
import CONSTANTS from '../src/constants.json';

/**
* @typedef {typeof import('../src/constants.json').EVENTS} EVENTS
* @typedef {typeof import('../src/constants.js').EVENTS} EVENTS
*/
const { EVENTS } = CONSTANTS;
import { EVENTS } from '../src/constants.js';

/** @typedef {'pending'|'available'|'targetingSet'|'rendered'|'timeout'|'rejected'|'noBid'|'error'} BidStatus */
/**
Expand Down
20 changes: 9 additions & 11 deletions modules/adWMGAnalyticsAdapter.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
import adapterManager from '../src/adapterManager.js';
import CONSTANTS from '../src/constants.json';
import { EVENTS } from '../src/constants.js';
import { ajax } from '../src/ajax.js';
const analyticsType = 'endpoint';
const url = 'https://analytics.wmgroup.us/analytic/collection';
const {
EVENTS: {
AUCTION_INIT,
AUCTION_END,
BID_REQUESTED,
BID_WON,
BID_TIMEOUT,
NO_BID,
BID_RESPONSE
}
} = CONSTANTS;
AUCTION_INIT,
AUCTION_END,
BID_REQUESTED,
BID_WON,
BID_TIMEOUT,
NO_BID,
BID_RESPONSE
} = EVENTS;

let timestampInit = null;

Expand Down
16 changes: 8 additions & 8 deletions modules/adagioAnalyticsAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
import adapterManager from '../src/adapterManager.js';
import CONSTANTS from '../src/constants.json';
import { EVENTS } from '../src/constants.js';
import { ajax } from '../src/ajax.js';
import { BANNER } from '../src/mediaTypes.js';
import { getWindowTop, getWindowSelf, deepAccess, logInfo, logError } from '../src/utils.js';
import { getGlobal } from '../src/prebidGlobal.js';

const emptyUrl = '';
const analyticsType = 'endpoint';
const events = Object.keys(CONSTANTS.EVENTS).map(key => CONSTANTS.EVENTS[key]);
const events = Object.keys(EVENTS).map(key => EVENTS[key]);
const ADAGIO_GVLID = 617;
const VERSION = '3.0.0';
const PREBID_VERSION = '$prebid.version$';
Expand Down Expand Up @@ -383,22 +383,22 @@ let adagioAdapter = Object.assign(adapter({ emptyUrl, analyticsType }), {

try {
switch (eventType) {
case CONSTANTS.EVENTS.AUCTION_INIT:
case EVENTS.AUCTION_INIT:
handlerAuctionInit(args);
break;
case CONSTANTS.EVENTS.BID_RESPONSE:
case EVENTS.BID_RESPONSE:
handlerBidResponse(args);
break;
case CONSTANTS.EVENTS.AUCTION_END:
case EVENTS.AUCTION_END:
handlerAuctionEnd(args);
break;
case CONSTANTS.EVENTS.BID_WON:
case EVENTS.BID_WON:
handlerBidWon(args);
break;
// AD_RENDER_SUCCEEDED seems redundant with BID_WON.
// case CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED:
case CONSTANTS.EVENTS.AD_RENDER_FAILED:
handlerAdRender(args, eventType === CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED);
case EVENTS.AD_RENDER_FAILED:
handlerAdRender(args, eventType === EVENTS.AD_RENDER_SUCCEEDED);
break;
}
} catch (error) {
Expand Down
16 changes: 8 additions & 8 deletions modules/adkernelAdnAnalyticsAdapter.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
import CONSTANTS from '../src/constants.json';
import {EVENTS} from '../src/constants.js';
import adapterManager from '../src/adapterManager.js';
import { logError, parseUrl, _each } from '../src/utils.js';
import {ajax} from '../src/ajax.js';
Expand Down Expand Up @@ -51,26 +51,26 @@ let analyticsAdapter = Object.assign(adapter({analyticsType: 'endpoint'}),
}
let handler = null;
switch (eventType) {
case CONSTANTS.EVENTS.AUCTION_INIT:
case EVENTS.AUCTION_INIT:
if (analyticsAdapter.context.queue) {
analyticsAdapter.context.queue.init();
}
initPrivacy(analyticsAdapter.context.requestTemplate, args.bidderRequests);
handler = trackAuctionInit;
break;
case CONSTANTS.EVENTS.BID_REQUESTED:
case EVENTS.BID_REQUESTED:
handler = trackBidRequest;
break;
case CONSTANTS.EVENTS.BID_RESPONSE:
case EVENTS.BID_RESPONSE:
handler = trackBidResponse;
break;
case CONSTANTS.EVENTS.BID_WON:
case EVENTS.BID_WON:
handler = trackBidWon;
break;
case CONSTANTS.EVENTS.BID_TIMEOUT:
case EVENTS.BID_TIMEOUT:
handler = trackBidTimeout;
break;
case CONSTANTS.EVENTS.AUCTION_END:
case EVENTS.AUCTION_END:
handler = trackAuctionEnd;
break;
}
Expand All @@ -79,7 +79,7 @@ let analyticsAdapter = Object.assign(adapter({analyticsType: 'endpoint'}),
if (analyticsAdapter.context.queue) {
analyticsAdapter.context.queue.push(events);
}
if (eventType === CONSTANTS.EVENTS.AUCTION_END) {
if (eventType === EVENTS.AUCTION_END) {
sendAll();
}
}
Expand Down
4 changes: 2 additions & 2 deletions modules/adlooxAdServerVideo.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import { registerVideoSupport } from '../src/adServerManager.js';
import { command as analyticsCommand, COMMAND } from './adlooxAnalyticsAdapter.js';
import { ajax } from '../src/ajax.js';
import CONSTANTS from '../src/constants.json';
import { EVENTS } from '../src/constants.js';
import { targeting } from '../src/targeting.js';
import { logInfo, isFn, logError, isPlainObject, isStr, isBoolean, deepSetValue, deepClone, timestamp, logWarn } from '../src/utils.js';

Expand Down Expand Up @@ -74,7 +74,7 @@ function track(options, callback) {
bid.ext.adloox.video.adserver = false;

analyticsCommand(COMMAND.TRACK, {
eventType: CONSTANTS.EVENTS.BID_WON,
eventType: EVENTS.BID_WON,
args: bid
});
}
Expand Down
8 changes: 4 additions & 4 deletions modules/adlooxAnalyticsAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
import {loadExternalScript} from '../src/adloader.js';
import {auctionManager} from '../src/auctionManager.js';
import {AUCTION_COMPLETED} from '../src/auction.js';
import CONSTANTS from '../src/constants.json';
import {EVENTS} from '../src/constants.js';
import {find} from '../src/polyfill.js';
import {getRefererInfo} from '../src/refererDetection.js';
import {
Expand Down Expand Up @@ -220,9 +220,9 @@ analyticsAdapter.url = function(url, args, bid) {
return url + a2qs(args);
}

analyticsAdapter[`handle_${CONSTANTS.EVENTS.AUCTION_END}`] = function(auctionDetails) {
analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = function(auctionDetails) {
if (!(auctionDetails.auctionStatus == AUCTION_COMPLETED && auctionDetails.bidsReceived.length > 0)) return;
analyticsAdapter[`handle_${CONSTANTS.EVENTS.AUCTION_END}`] = NOOP;
analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = NOOP;

logMessage(MODULE, 'preloading verification JS');

Expand All @@ -235,7 +235,7 @@ analyticsAdapter[`handle_${CONSTANTS.EVENTS.AUCTION_END}`] = function(auctionDet
insertElement(link);
}

analyticsAdapter[`handle_${CONSTANTS.EVENTS.BID_WON}`] = function(bid) {
analyticsAdapter[`handle_${EVENTS.BID_WON}`] = function(bid) {
if (deepAccess(bid, 'ext.adloox.video.adserver')) {
logMessage(MODULE, `measuring '${bid.mediaType}' ad unit code '${bid.adUnitCode}' via Ad Server module`);
return;
Expand Down
14 changes: 7 additions & 7 deletions modules/adomikAnalyticsAdapter.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
import CONSTANTS from '../src/constants.json';
import {EVENTS} from '../src/constants.js';
import adapterManager from '../src/adapterManager.js';
import {logInfo} from '../src/utils.js';
import {find, findIndex} from '../src/polyfill.js';

// Events used in adomik analytics adapter.
const auctionInit = CONSTANTS.EVENTS.AUCTION_INIT;
const auctionEnd = CONSTANTS.EVENTS.AUCTION_END;
const bidRequested = CONSTANTS.EVENTS.BID_REQUESTED;
const bidResponse = CONSTANTS.EVENTS.BID_RESPONSE;
const bidWon = CONSTANTS.EVENTS.BID_WON;
const bidTimeout = CONSTANTS.EVENTS.BID_TIMEOUT;
const auctionInit = EVENTS.AUCTION_INIT;
const auctionEnd = EVENTS.AUCTION_END;
const bidRequested = EVENTS.BID_REQUESTED;
const bidResponse = EVENTS.BID_RESPONSE;
const bidWon = EVENTS.BID_WON;
const bidTimeout = EVENTS.BID_TIMEOUT;
const ua = navigator.userAgent;

var _sampled = true;
Expand Down
6 changes: 3 additions & 3 deletions modules/adpod.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import {config} from '../src/config.js';
import {ADPOD} from '../src/mediaTypes.js';
import {find, arrayFrom as from} from '../src/polyfill.js';
import {auctionManager} from '../src/auctionManager.js';
import CONSTANTS from '../src/constants.json';
import { TARGETING_KEYS } from '../src/constants.js';

const TARGETING_KEY_PB_CAT_DUR = 'hb_pb_cat_dur';
const TARGETING_KEY_CACHE_ID = 'hb_cache_id';
Expand Down Expand Up @@ -454,10 +454,10 @@ export function callPrebidCacheAfterAuction(bids, callback) {
* @param {Object} bid
*/
export function sortByPricePerSecond(a, b) {
if (a.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / a.video.durationBucket < b.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / b.video.durationBucket) {
if (a.adserverTargeting[TARGETING_KEYS.PRICE_BUCKET] / a.video.durationBucket < b.adserverTargeting[TARGETING_KEYS.PRICE_BUCKET] / b.video.durationBucket) {
return 1;
}
if (a.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / a.video.durationBucket > b.adserverTargeting[CONSTANTS.TARGETING_KEYS.PRICE_BUCKET] / b.video.durationBucket) {
if (a.adserverTargeting[TARGETING_KEYS.PRICE_BUCKET] / a.video.durationBucket > b.adserverTargeting[TARGETING_KEYS.PRICE_BUCKET] / b.video.durationBucket) {
return -1;
}
return 0;
Expand Down
20 changes: 10 additions & 10 deletions modules/adxcgAnalyticsAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { parseSizesInput, uniques, buildUrl, logError } from '../src/utils.js';
import { ajax } from '../src/ajax.js';
import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
import adapterManager from '../src/adapterManager.js';
import CONSTANTS from '../src/constants.json';
import { EVENTS } from '../src/constants.js';
import {getGlobal} from '../src/prebidGlobal.js';

/**
Expand All @@ -22,29 +22,29 @@ var adxcgAnalyticsAdapter = Object.assign(adapter(
}), {
track ({eventType, args}) {
switch (eventType) {
case CONSTANTS.EVENTS.AUCTION_INIT:
case EVENTS.AUCTION_INIT:
adxcgAnalyticsAdapter.context.events.auctionInit = mapAuctionInit(args);
adxcgAnalyticsAdapter.context.auctionTimestamp = args.timestamp;
break;
case CONSTANTS.EVENTS.BID_REQUESTED:
case EVENTS.BID_REQUESTED:
adxcgAnalyticsAdapter.context.auctionId = args.auctionId;
adxcgAnalyticsAdapter.context.events.bidRequests.push(mapBidRequested(args));
break;
case CONSTANTS.EVENTS.BID_ADJUSTMENT:
case EVENTS.BID_ADJUSTMENT:
break;
case CONSTANTS.EVENTS.BID_TIMEOUT:
case EVENTS.BID_TIMEOUT:
adxcgAnalyticsAdapter.context.events.bidTimeout = args.map(item => item.bidder).filter(uniques);
break;
case CONSTANTS.EVENTS.BIDDER_DONE:
case EVENTS.BIDDER_DONE:
break;
case CONSTANTS.EVENTS.BID_RESPONSE:
case EVENTS.BID_RESPONSE:
adxcgAnalyticsAdapter.context.events.bidResponses.push(mapBidResponse(args, eventType));
break;
case CONSTANTS.EVENTS.BID_WON:
case EVENTS.BID_WON:
let outData2 = {bidWons: mapBidWon(args)};
send(outData2);
break;
case CONSTANTS.EVENTS.AUCTION_END:
case EVENTS.AUCTION_END:
send(adxcgAnalyticsAdapter.context.events);
break;
}
Expand Down Expand Up @@ -87,7 +87,7 @@ function mapBidResponse (bidResponse, eventType) {
currency: bidResponse.currency,
netRevenue: bidResponse.netRevenue,
timeToRespond: bidResponse.timeToRespond,
bidId: eventType === CONSTANTS.EVENTS.BID_TIMEOUT ? bidResponse.bidId : bidResponse.requestId,
bidId: eventType === EVENTS.BID_TIMEOUT ? bidResponse.bidId : bidResponse.requestId,
dealId: bidResponse.dealId,
status: bidResponse.status,
creativeId: bidResponse.creativeId.toString()
Expand Down
Loading