Merge pull request #5 from prebid/master

updating master

Author: stevealliance

.eslintrc.js

@@ -15,7 +15,8 @@ module.exports = {
   },
   "extends": "standard",
   "plugins": [
-    "prebid"
+    "prebid",
+    "import"
   ],
   "globals": {
     "$$PREBID_GLOBAL$$": false
@@ -27,6 +28,7 @@ module.exports = {
     "comma-dangle": "off",
     "semi": "off",
     "space-before-function-paren": "off",
+    "import/extensions": ["error", "ignorePackages"],
 
     // Exceptions below this line are temporary, so that eslint can be added into the CI process.
     // Violations of these styles should be fixed, and the exceptions removed over time.
@@ -35,8 +37,9 @@ module.exports = {
     "eqeqeq": "off",
     "no-return-assign": "off",
     "no-throw-literal": "off",
-    "no-undef": "off",
+    "no-undef": 2,
     "no-useless-escape": "off",
+    "no-console": "error"
   },
   "overrides": Object.keys(allowedModules).map((key) => ({
     "files": key + "/**/*.js",

CONTRIBUTING.md

@@ -48,8 +48,10 @@ When you are adding code to Prebid.js, or modifying code that isn't covered by a
   - _Assert_: check that the expected results have occurred
     - e.g., use Chai assertions to check that the expected output is equal to the actual output
 - Test the public interface, not the internal implementation
-- If you need to check `adloader.loadScript` in a test, use a `stub` rather than a `spy`. `spy`s trigger a network call which can result in a `script error` and cause unrelated unit tests to fail. `stub`s will let you gather information about the `adloader.loadScript` call without affecting external resources
+- If you need to check `adloader.loadExternalScript` in a test, use a `stub` rather than a `spy`. `spy`s trigger a network call which can result in a `script error` and cause unrelated unit tests to fail. `stub`s will let you gather information about the `adloader.loadExternalScript` call without affecting external resources
+- If your test makes ajax requests, use the global xhr stub in `test/mocks/xhr`. Do not use your own `sinon.useFakeXMLHttpRequest()` or `sinon.createFakeServer()`.
 - When writing tests you may use ES2015 syntax if desired
+- If your test relies on `Window` or `global` object, do not mutate that object directly. Instead, create a separate copy of that object and perform operations on that new copy.
 
 ### Test Examples
 Prebid.js already has many tests. Read them to see how Prebid.js is tested, and for inspiration:

PR_REVIEW.md

@@ -16,9 +16,11 @@ For modules and core platform updates, the initial reviewer should request an ad
 - If the change results in needing updates to docs (such as public API change, module interface etc), add a label for "needs docs" and inform the submitter they must submit a docs PR to update the appropriate area of Prebid.org **before the PR can merge**. Help them with finding where the docs are located on prebid.org if needed. 
   - Below are some examples of bidder specific updates that should require docs update (in their dev-docs/bidders/bidder.md file):
     - Add support for GDPR consentManagement module > add `gdpr_supported: true`
+    - Add support for US Privacy consentManagement module > add `usp_supported: true`
     - Add support for userId module > add `userId: pubCommon, digitrust, newProviderHere`
     - Add support for video and/or native mediaTypes > add `media_types: video, native`
     - Add support for COPPA > add `coppa_supported: true`
+    - Add support for SChain > add `schain_supported: true`
 - If all above is good, add a `LGTM` comment and request 1 additional core member to review.
 - Once there is 2 `LGTM` on the PR, merge to master
 - Ask the submitter to add a PR for documentation if applicable.
@@ -29,7 +31,7 @@ For modules and core platform updates, the initial reviewer should request an ad
 - Follow steps above for general review process. In addition, please verify the following:
 - Verify that bidder has submitted valid bid params and that bids are being received.
 - Verify that bidder is not manipulating the prebid.js auction in any way or doing things that go against the principles of the project. If unsure check with the Tech Lead.
-- Verify that  the bidder is being as efficient as possible, ideally not loading an external library, however if they do load a library it should be cached.
+- Verify that the bidder is being as efficient as possible, ideally not loading an external library, however if they do load a library it should be cached.
 - Verify that code re-use is being done properly and that changes introduced by a bidder don't impact other bidders.
 - If the adapter being submitted is an alias type, check with the bidder contact that is being aliased to make sure it's allowed.
 - If the adapter is triggering any user syncs make sure they are using the user sync module in the Prebid.js core.

allowedModules.js

@@ -11,6 +11,7 @@ const sharedWhiteList = [
 module.exports = {
   'modules': [
     ...sharedWhiteList,
+    'criteo-direct-rsa-validate',
     'jsencrypt',
     'crypto-js'
   ],

browsers.json

@@ -7,11 +7,11 @@
     "device": null,
     "os": "Windows"
   },
-  "bs_edge_16_windows_10": {
+  "bs_edge_18_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "edge",
-    "browser_version": "16.0",
+    "browser_version": "18.0",
     "device": null,
     "os": "Windows"
   },
@@ -23,43 +23,43 @@
     "device": null,
     "os": "Windows"
   },
-  "bs_chrome_74_windows_10": {
+  "bs_chrome_80_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "chrome",
-    "browser_version": "74.0",
+    "browser_version": "80.0",
     "device": null,
     "os": "Windows"
   },
-  "bs_chrome_75_windows_10": {
+  "bs_chrome_79_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "chrome",
-    "browser_version": "75.0",
+    "browser_version": "79.0",
     "device": null,
     "os": "Windows"
   },
-  "bs_firefox_66_windows_10": {
+  "bs_firefox_73_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "firefox",
-    "browser_version": "66.0",
+    "browser_version": "73.0",
     "device": null,
     "os": "Windows"
   },
-  "bs_firefox_67_windows_10": {
+  "bs_firefox_72_windows_10": {
     "base": "BrowserStack",
     "os_version": "10",
     "browser": "firefox",
-    "browser_version": "67.0",
+    "browser_version": "72.0",
     "device": null,
     "os": "Windows"
   },
-  "bs_safari_11_mac_high_sierra": {
+  "bs_safari_11_mac_catalina": {
     "base": "BrowserStack",
-    "os_version": "High Sierra",
+    "os_version": "Catalina",
     "browser": "safari",
-    "browser_version": "11.1",
+    "browser_version": "13.0",
     "device": null,
     "os": "OS X"
   },

gulpHelpers.js

@@ -59,6 +59,7 @@ module.exports = {
       });
     }
 
+    // we need to forcefuly include the parentModule if the subModule is present in modules list and parentModule is not present in modules list
     Object.keys(submodules).forEach(parentModule => {
       if (
         !modules.includes(parentModule) &&

gulpfile.js

@@ -32,6 +32,9 @@ var prebid = require('./package.json');
 var dateString = 'Updated : ' + (new Date()).toISOString().substring(0, 10);
 var banner = '/* <%= prebid.name %> v<%= prebid.version %>\n' + dateString + ' */\n';
 var port = 9999;
+const mockServerPort = 4444;
+const host = argv.host ? argv.host : 'localhost';
+const { spawn } = require('child_process');
 
 // these modules must be explicitly listed in --modules to be included in the build, won't be part of "all" modules
 var explicitModules = [
@@ -64,11 +67,11 @@ function lint(done) {
   if (argv.nolint) {
     return done();
   }
-  const isFixed = function(file) {
+  const isFixed = function (file) {
     return file.eslint != null && file.eslint.fixed;
   }
-  return gulp.src(['src/**/*.js', 'modules/**/*.js', 'test/**/*.js'], {base: './'})
-    .pipe(gulpif(argv.nolintfix, eslint(), eslint({fix: true})))
+  return gulp.src(['src/**/*.js', 'modules/**/*.js', 'test/**/*.js'], { base: './' })
+    .pipe(gulpif(argv.nolintfix, eslint(), eslint({ fix: true })))
     .pipe(eslint.format('stylish'))
     .pipe(eslint.failAfterError())
     .pipe(gulpif(isFixed, gulp.dest('./')));
@@ -81,7 +84,7 @@ function viewCoverage(done) {
 
   connect.server({
     port: coveragePort,
-    root: 'build/coverage/karma_html',
+    root: 'build/coverage/lcov-report',
     livereload: false
   });
   opens('http://' + mylocalhost + ':' + coveragePort);
@@ -157,7 +160,7 @@ function nodeBundle(modules) {
       .on('error', (err) => {
         reject(err);
       })
-      .pipe(through.obj(function(file, enc, done) {
+      .pipe(through.obj(function (file, enc, done) {
         resolve(file.contents.toString(enc));
         done();
       }));
@@ -196,7 +199,7 @@ function bundle(dev, moduleArr) {
   return gulp.src(
     entries
   )
-    .pipe(gulpif(dev, sourcemaps.init({loadMaps: true})))
+    .pipe(gulpif(dev, sourcemaps.init({ loadMaps: true })))
     .pipe(concat(outputFileName))
     .pipe(gulpif(!argv.manualEnable, footer('\n<%= global %>.processQueue();', {
       global: prebid.globalVarName
@@ -234,12 +237,26 @@ function test(done) {
         wdioConf
       ];
     }
+
+    //run mock-server
+    const mockServer = spawn('node', ['./test/mock-server/index.js', '--port=' + mockServerPort]);
+    mockServer.stdout.on('data', (data) => {
+      console.log(`stdout: ${data}`);
+    });
+    mockServer.stderr.on('data', (data) => {
+      console.log(`stderr: ${data}`);
+    });
+
     execa(wdioCmd, wdioOpts, { stdio: 'inherit' })
       .then(stdout => {
+        //kill mock server
+        mockServer.kill('SIGINT');
         done();
         process.exit(0);
       })
       .catch(err => {
+        //kill mock server
+        mockServer.kill('SIGINT');
         done(new Error(`Tests failed with error: ${err}`));
         process.exit(1);
       });
@@ -256,7 +273,7 @@ function test(done) {
 }
 
 function newKarmaCallback(done) {
-  return function(exitCode) {
+  return function (exitCode) {
     if (exitCode) {
       done(new Error('Karma tests failed with exit code ' + exitCode));
       if (argv.browserstack) {
@@ -279,7 +296,7 @@ function testCoverage(done) {
 function coveralls() { // 2nd arg is a dependency: 'test' must be finished
   // first send results of istanbul's test coverage to coveralls.io.
   return gulp.src('gulpfile.js', { read: false }) // You have to give it a file, but you don't
-  // have to read it.
+    // have to read it.
     .pipe(shell('cat build/coverage/lcov.info | node_modules/coveralls/bin/coveralls.js'));
 }
 
@@ -309,6 +326,12 @@ function setupE2e(done) {
   done();
 }
 
+gulp.task('updatepath', function () {
+  return gulp.src(['build/dist/*.js'])
+    .pipe(replace('https://ib.adnxs.com/ut/v3/prebid', 'http://' + host + ':' + mockServerPort + '/'))
+    .pipe(gulp.dest('build/dist'));
+});
+
 // support tasks
 gulp.task(lint);
 gulp.task(watch);
@@ -334,7 +357,7 @@ gulp.task('build-postbid', gulp.series(escapePostbidConfig, buildPostbid));
 gulp.task('serve', gulp.series(clean, lint, gulp.parallel('build-bundle-dev', watch, test)));
 gulp.task('default', gulp.series(clean, makeWebpackPkg));
 
-gulp.task('e2e-test', gulp.series(clean, setupE2e, gulp.parallel('build-bundle-prod', watch), test))
+gulp.task('e2e-test', gulp.series(clean, setupE2e, gulp.parallel('build-bundle-prod', watch), 'updatepath', test));
 // other tasks
 gulp.task(bundleToStdout);
 gulp.task('bundle', gulpBundle.bind(null, false)); // used for just concatenating pre-built files with no build step