Create test.js

.eslintrc.js

@@ -83,27 +83,52 @@ module.exports = {
  files: key + '/**/*.js',
  rules: {
  'prebid/validate-imports': ['error', allowedModules[key]],
- 'prebid/no-innerText': ['error', allowedModules[key]],
  'no-restricted-globals': [
  'error',
  {
  name: 'require',
  message: 'use import instead'
  }
+ ],
+ 'prebid/no-global': [
+ 'error',
+ ...['localStorage', 'sessionStorage'].map(name => ({name, message: 'use storageManager instead'})),
+ {
+ name: 'XMLHttpRequest',
+ message: 'use ajax.js instead'
+ },
+ ],
+ 'prebid/no-member': [
+ 'error',
+ {
+ name: 'cookie',
+ target: 'document',
+ message: 'use storageManager instead'
+ },
+ {
+ name: 'sendBeacon',
+ target: 'navigator',
+ message: 'use ajax.js instead'
+ },
+ ...['outerText', 'innerText'].map(name => ({
+ name,
+ message: 'use .textContent instead'
+ }))
  ]
  }
  })).concat([{
  // code in other packages (such as plugins/eslint) is not "seen" by babel and its parser will complain.
  files: 'plugins/*/**/*.js',
  parser: 'esprima'
- }, 
- {
+ }, {
  files: '**BidAdapter.js',
  rules: {
  'no-restricted-imports': [
  'error', {
- patterns: ["**/src/events.js",
- "**/src/adloader.js"]
+ patterns: [
+ '**/src/events.js',
+ '**/src/adloader.js'
+ ]
  }
  ]
  }

.github/workflows/linter.yml

@@ -0,0 +1,105 @@
+name: Check for linter warnings / exceptions
+
+on:
+ pull_request_target:
+ branches:
+ - master
+
+jobs:
+ check-linter:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Set up Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '20'
+
+ - name: Checkout code
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ ref: ${{ github.event.pull_request.base.sha }}
+
+ - name: Fetch base and target branches
+ run: |
+ git fetch origin +refs/heads/${{ github.event.pull_request.base.ref }}:refs/remotes/origin/${{ github.event.pull_request.base.ref }}
+ git fetch origin +refs/pull/${{ github.event.pull_request.number }}/merge:refs/remotes/pull/${{ github.event.pull_request.number }}/merge
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Get the diff
+ run: git diff --name-only origin/${{ github.event.pull_request.base.ref }}...refs/remotes/pull/${{ github.event.pull_request.number }}/merge > __changed_files.txt
+
+ - name: Run linter on base branch
+ run: npx eslint --no-inline-config --format json $(cat __changed_files.txt | xargs stat --printf '%n\n' 2> /dev/null) > __base.json
+
+ - name: Check out PR
+ run: git checkout ${{ github.event.pull_request.head.sha }}
+
+ - name: Run linter on PR
+ run: npx eslint --no-inline-config --format json $(cat __changed_files.txt | xargs stat --printf '%n\n' 2> /dev/null) > __pr.json
+
+ - name: Compare them and post comment if necessary
+ if: env.filtered_report_exists == 'true'
+ uses: actions/github-script@v7
+ with:
+ script: |
+ const fs = require('fs');
+ const path = require('path');
+ const process = require('process');
+
+ function parse(fn) {
+ return JSON.parse(fs.readFileSync(fn)).reduce((memo, data) => {
+ const file = path.relative(process.cwd(), data.filePath);
+ if (!memo.hasOwnProperty(file)) { memo[file] = { errors: 0, warnings: 0} }
+ data.messages.forEach(({severity}) => {
+ memo[file][severity > 1 ? 'errors' : 'warnings']++;
+ });
+ return memo;
+ }, {})
+ }
+
+ function mkDiff(old, new_) {
+ const files = Object.fromEntries(
+ Object.entries(new_)
+ .map(([file, {errors, warnings}]) => {
+ const {errors: oldErrors, warnings: oldWarnings} = old[file] || {};
+ return [file, {errors: errors - (oldErrors ?? 0), warnings: warnings - (oldWarnings ?? 0)}]
+ })
+ .filter(([_, {errors, warnings}]) => errors > 0 || warnings > 0)
+ )
+ return Object.values(files).reduce((memo, {warnings, errors}) => {
+ memo.errors += errors;
+ memo.warnings += warnings;
+ return memo;
+ }, {errors: 0, warnings: 0, files})
+ }
+
+ function mkComment({errors, warnings, files}) {
+ if (errors === 0 && warnings === 0) return;
+ const summary = [];
+ if (errors) summary.push(`**${errors}** linter errors`)
+ if (warnings) summary.push(`**${warnings}** linter warnings`)
+ let cm = `This pr adds ${summary.join(' and ')} (possibly disabled through directives):\n\n`;
+ Object.entries(files).forEach(([file, {errors, warnings}]) => {
+ const summary = [];
+ if (errors) summary.push(`+${errors} errors`);
+ if (warnings) summary.push(`+${warnings} warnings`)
+ cm += ` * \`${file}\` (${summary.join(', ')})\n`
+ })
+ return cm;
+ }
+
+ const [base, pr] = ['__base.json', '__pr.json'].map(parse);
+ const comment = mkComment(mkDiff(base, pr));
+
+ if (comment) {
+ github.rest.issues.createComment({
+ owner: context.repo.owner,
+ repo: context.repo.repo,
+ issue_number: context.issue.number,
+ body: comment
+ });
+ }

modules/33acrossAnalyticsAdapter.js

@@ -629,6 +629,8 @@ function setCachedBidStatus(auctionId, bidId, status) {
  * @param {string} endpoint URL
  */
 function sendReport(report, endpoint) {
+ // TODO FIX THIS RULES VIOLATION
+ // eslint-disable-next-line
  if (navigator.sendBeacon(endpoint, JSON.stringify(report))) {
  log.info(`Analytics report sent to ${endpoint}`, report);
 

modules/adlooxAnalyticsAdapter.js

@@ -232,6 +232,7 @@ analyticsAdapter[`handle_${EVENTS.AUCTION_END}`] = function(auctionDetails) {
  link.setAttribute('href', `${uri.protocol}://${uri.host}${uri.pathname}`);
  link.setAttribute('rel', 'preload');
  link.setAttribute('as', 'script');
+ // TODO fix rules violation
  insertElement(link);
 }
 

modules/automatadAnalyticsAdapter.js

@@ -18,6 +18,8 @@ var isLoggingEnabled; var queuePointer = 0; var retryCount = 0; var timer = null
 
 const prettyLog = (level, text, isGroup = false, cb = () => {}) => {
  if (self.isLoggingEnabled === undefined) {
+ // TODO FIX THIS RULES VIOLATION
+ // eslint-disable-next-line prebid/no-global
  if (window.localStorage.getItem('__aggLoggingEnabled')) {
  self.isLoggingEnabled = true
  } else {

modules/cleanioRtdProvider.js

@@ -43,6 +43,7 @@ let preloadStatus = 0;
  * @param {string} scriptURL The script URL to preload
  */
 function pageInitStepPreloadScript(scriptURL) {
+ // TODO: this bypasses adLoader
  const linkElement = document.createElement('link');
  linkElement.rel = 'preload';
  linkElement.as = 'script';

modules/connectIdSystem.js

@@ -313,11 +313,13 @@ export const connectIdSubmodule = {
 
  /**
  * Utility function that returns a boolean flag indicating if the user
- * has opeted out via the Yahoo easy-opt-out mechanism.
+ * has opted out via the Yahoo easy-opt-out mechanism.
  * @returns {Boolean}
  */
  userHasOptedOut() {
  try {
+ // TODO FIX THIS RULES VIOLATION
+ // eslint-disable-next-line
  return localStorage.getItem(OVERRIDE_OPT_OUT_KEY) === '1';
  } catch {
  return false;

modules/contxtfulRtdProvider.js

@@ -36,6 +36,8 @@ function getRxEngineReceptivity(requester) {
 }
 
 function loadSessionReceptivity(requester) {
+ // TODO: commented out because of rule violations
+ /*
  let sessionStorageValue = sessionStorage.getItem(requester);
  if (!sessionStorageValue) {
  return null;
@@ -54,7 +56,8 @@ function loadSessionReceptivity(requester) {
  } catch {
  return null;
  }
-};
+ */
+}
 
 /**
  * Prepare a receptivity batch

modules/cwireBidAdapter.js

@@ -224,6 +224,8 @@ export const spec = {
  bid: bid
  }
  }
+ // TODO FIX THIS RULES VIOLATION
+ // eslint-disable-next-line prebid/no-member
  navigator.sendBeacon(EVENT_ENDPOINT, JSON.stringify(event))
  },
 
@@ -236,6 +238,8 @@ export const spec = {
  bidderRequest: bidderRequest
  }
  }
+ // TODO FIX THIS RULES VIOLATION
+ // eslint-disable-next-line prebid/no-member
  navigator.sendBeacon(EVENT_ENDPOINT, JSON.stringify(event))
  },
 

modules/debugging/debugging.js

@@ -31,6 +31,7 @@ export function disableDebugging({hook, logger}) {
  }
 }
 
+// eslint-disable-next-line prebid/no-global
 function saveDebuggingConfig(debugConfig, {sessionStorage = window.sessionStorage, DEBUG_KEY} = {}) {
  if (!debugConfig.enabled) {
  try {
@@ -49,6 +50,7 @@ function saveDebuggingConfig(debugConfig, {sessionStorage = window.sessionStorag
  }
 }
 
+// eslint-disable-next-line prebid/no-global
 export function getConfig(debugging, {getStorage = () => window.sessionStorage, DEBUG_KEY, config, hook, logger} = {}) {
  if (debugging == null) return;
  let sessionStorage;
@@ -70,6 +72,7 @@ export function getConfig(debugging, {getStorage = () => window.sessionStorage,
 export function sessionLoader({DEBUG_KEY, storage, config, hook, logger}) {
  let overrides;
  try {
+ // eslint-disable-next-line prebid/no-global
  storage = storage || window.sessionStorage;
  overrides = JSON.parse(storage.getItem(DEBUG_KEY));
  } catch (e) {

modules/dgkeywordRtdProvider.js

@@ -101,6 +101,8 @@ export function getProfileApiUrl(customeUrl, enableReadFpid) {
 
 export function readFpidFromLocalStrage() {
  try {
+ // TODO: use storageManager
+ // eslint-disable-next-line prebid/no-global
  const fpid = window.localStorage.getItem('ope_fpid');
  if (fpid) {
  return fpid;

modules/fintezaAnalyticsAdapter.js

@@ -70,7 +70,8 @@ function initFirstVisit() {
  let cookies;
 
  try {
- cookies = parseCookies(document.cookie);
+ // TODO: commented out because of rule violations
+ cookies = {} // parseCookies(document.cookie);
  } catch (a) {
  cookies = {};
  }
@@ -91,7 +92,8 @@ function initFirstVisit() {
 
  return visitDate;
 }
-
+// TODO: commented out because of rule violations
+/*
 function trim(string) {
  if (string.trim) {
  return string.trim();
@@ -130,6 +132,7 @@ function parseCookies(cookie) {
 
  return values;
 }
+*/
 
 function getRandAsStr(digits) {
  let str = '';
@@ -172,7 +175,8 @@ function initSession() {
  let isNew = false;
 
  try {
- cookies = parseCookies(document.cookie);
+ // TODO: commented out because of rule violations
+ cookies = {} // parseCookies(document.cookie);
  } catch (a) {
  cookies = {};
  }
@@ -263,7 +267,8 @@ function getTrackRequestLastTime() {
  );
  }
 
- cookie = parseCookies(document.cookie);
+ // TODO: commented out because of rule violations
+ cookie = {} // parseCookies(document.cookie);
  cookie = cookie[ TRACK_TIME_KEY ];
  if (cookie) {
  return parseInt(cookie, 10);

modules/growthCodeAnalyticsAdapter.js

@@ -140,7 +140,7 @@ function logToServer() {
  if (pid === DEFAULT_PID) return;
  if (eventQueue.length >= 1) {
  // Get the correct GCID
- let gcid = localStorage.getItem('gcid')
+ let gcid = storage.getDataFromLocalStorage('gcid');
 
  let data = {
  session: sessionId,

modules/growthCodeRtdProvider.js

@@ -75,7 +75,7 @@ function callServer(configParams, items, expiresAt, userConsent) {
  storage.removeDataFromLocalStorage(RTD_EXPIRE_KEY, null)
  }
  if ((items === null) && (isNaN(expiresAt))) {
- let gcid = localStorage.getItem('gcid')
+ let gcid = storage.getDataFromLocalStorage('gcid')
 
  let url = configParams.url ? configParams.url : ENDPOINT_URL;
  url = tryAppendQueryString(url, 'pid', configParams.pid);

modules/relevatehealthBidAdapter.js

@@ -142,7 +142,8 @@ function buildUser(bid) {
  if (bid && bid.params) {
  return {
  id: bid.params.user_id && typeof bid.params.user_id == 'string' ? bid.params.user_id : '',
- buyeruid: localStorage.getItem('adx_profile_guid') ? localStorage.getItem('adx_profile_guid') : '',
+ // TODO: commented out because of rule violations
+ buyeruid: '', // localStorage.getItem('adx_profile_guid') ? localStorage.getItem('adx_profile_guid') : '',
  keywords: bid.params.keywords && typeof bid.params.keywords == 'string' ? bid.params.keywords : '',
  customdata: bid.params.customdata && typeof bid.params.customdata == 'string' ? bid.params.customdata : ''
  };

modules/sirdataRtdProvider.js

@@ -219,6 +219,8 @@ export function postContentForSemanticAnalysis(postContentToken, actualUrl) {
 
  // Use the Beacon API if supported to send the payload
  if ('sendBeacon' in navigator) {
+ // TODO FIX RULES VIOLATION
+ // eslint-disable-next-line prebid/no-member
  navigator.sendBeacon(url, payload);
  } else {
  // Fallback to using AJAX if Beacon API is not supported