Hummingbird analytics adapter prototype

.circleci/config.yml

@@ -2,49 +2,93 @@
 #
 # Check https://circleci.com/docs/2.0/language-javascript/ for more details
 #
+
+aliases: 
+  - &environment
+      docker:
+        # specify the version you desire here
+        - image: circleci/node:8.9.0
+
+        # Specify service dependencies here if necessary
+        # CircleCI maintains a library of pre-built images
+        # documented at https://circleci.com/docs/2.0/circleci-images/
+        # - image: circleci/mongo:3.4.4
+      working_directory: ~/Prebid.js
+
+  - &restore_dep_cache
+      keys:
+        - v1-dependencies-{{ checksum "package.json" }}
+        # fallback to using the latest cache if no exact match is found
+        - v1-dependencies-
+
+  - &save_dep_cache
+      paths:
+        - node_modules
+      key: v1-dependencies-{{ checksum "package.json" }}
+
+  - &install
+      name: Install gulp cli
+      command: sudo npm install -g gulp-cli
+
+  - &run_unit_test
+      name: BrowserStack testing
+      command: gulp test --browserstack --nolintfix
+
+  - &run_endtoend_test
+      name: BrowserStack End to end testing
+      command: echo "127.0.0.1 test.localhost" | sudo tee -a /etc/hosts && gulp e2e-test --host=test.localhost
+
+  # Download and run BrowserStack local
+  - &setup_browserstack
+      name : Download BrowserStack Local binary and start it.
+      command : |
+        # Download the browserstack binary file
+        wget "https://www.browserstack.com/browserstack-local/BrowserStackLocal-linux-x64.zip"
+        # Unzip it
+        unzip BrowserStackLocal-linux-x64.zip
+        # Run the file with user's access key
+        ./BrowserStackLocal ${BROWSERSTACK_ACCESS_KEY} &
+
+  - &unit_test_steps
+    - checkout
+    - restore_cache: *restore_dep_cache
+    - run: npm install
+    - save_cache: *save_dep_cache
+    - run: *install
+    - run: *setup_browserstack
+    - run: *run_unit_test
+
+  - &endtoend_test_steps
+    - checkout
+    - restore_cache: *restore_dep_cache
+    - run: npm install
+    - save_cache: *save_dep_cache
+    - run: *install
+    - run: *setup_browserstack
+    - run: *run_endtoend_test
+
 version: 2
 jobs:
   build:
-    docker:
-      # specify the version you desire here
-      - image: circleci/node:8.9.0
+    <<: *environment
+    steps: *unit_test_steps
 
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/mongo:3.4.4
-
-    working_directory: ~/Prebid.js
-
-    steps:
-      - checkout
-
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-          - v1-dependencies-{{ checksum "package.json" }}
-          # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
-
-      - run: npm install
-
-      - save_cache:
-          paths:
-            - node_modules
-          key: v1-dependencies-{{ checksum "package.json" }}
-
-      - run: sudo npm install -g gulp-cli
-      # Download and run BrowserStack local
-      - run:
-          name : Download BrowserStack Local binary and start it.
-          command : |
-            # Download the browserstack binary file
-            wget "https://www.browserstack.com/browserstack-local/BrowserStackLocal-linux-x64.zip"
-            # Unzip it
-            unzip BrowserStackLocal-linux-x64.zip
-            # Run the file with user's access key
-            ./BrowserStackLocal ${BROWSERSTACK_ACCESS_KEY} &
-      # run tests!
-      - run: 
-          name: BrowserStack testing
-          command: gulp test --browserstack --nolintfix
+  e2etest:
+    <<: *environment
+    steps: *endtoend_test_steps
+
+workflows:
+  version: 2
+  commit:
+    jobs:
+      - build
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - e2etest

README.md

@@ -114,7 +114,7 @@ prebid.requestBids({
 
 *Note:* You need to have `NodeJS` 8.9.x or greater installed.
 
-*Note:* In the 1.24.0 release of Prebid.js we have transitioned to using gulp 4.0 from using gulp 3.9.1.  To compily with gulp's recommended setup for 4.0, you'll need to have `gulp-cli` installed globally prior to running the general `npm install`.  This shouldn't impact any other projects you may work on that use an earlier version of gulp in it's setup.
+*Note:* In the 1.24.0 release of Prebid.js we have transitioned to using gulp 4.0 from using gulp 3.9.1.  To comply with gulp's recommended setup for 4.0, you'll need to have `gulp-cli` installed globally prior to running the general `npm install`.  This shouldn't impact any other projects you may work on that use an earlier version of gulp in its setup.
 
 If you have a previous version of `gulp` installed globally, you'll need to remove it before installing `gulp-cli`.  You can check if this is installed by running `gulp -v` and seeing the version that's listed in the `CLI` field of the output.  If you have the `gulp` package installed globally, it's likely the same version that you'll see in the `Local` field.  If you already have `gulp-cli` installed, it should be a lower major version (it's at version `2.0.1` at the time of the transition).
 

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 = [
@@ -214,16 +217,49 @@ function bundle(dev, moduleArr) {
 // If --browserstack is given, it will run the full suite of currently supported browsers.
 // If --browsers is given, browsers can be chosen explicitly. e.g. --browsers=chrome,firefox,ie9
 // If --notest is given, it will immediately skip the test task (useful for developing changes with `gulp serve --notest`)
+
 function test(done) {
   if (argv.notest) {
     done();
   } else if (argv.e2e) {
     let wdioCmd = path.join(__dirname, 'node_modules/.bin/wdio');
     let wdioConf = path.join(__dirname, 'wdio.conf.js');
-    let wdioOpts = [
-      wdioConf
-    ];
-    return execa(wdioCmd, wdioOpts, { stdio: 'inherit' });
+    let wdioOpts;
+
+    if (argv.file) {
+      wdioOpts = [
+        wdioConf,
+        `--spec`,
+        `${argv.file}`
+      ]
+    } else {
+      wdioOpts = [
+        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);
+      });
   } else {
     var karmaConf = karmaConfMaker(false, argv.browserstack, argv.watch, argv.file);
 
@@ -290,6 +326,12 @@ function setupE2e(done) {
   done();
 }
 
+gulp.task('updatepath', function(){
+  return gulp.src(['build/dist/*.js'])
+  .pipe(replace('ib.adnxs.com/ut/v3/prebid', host + ':' + mockServerPort + '/'))
+  .pipe(gulp.dest('build/dist'));
+});
+
 // support tasks
 gulp.task(lint);
 gulp.task(watch);
@@ -315,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-dev', 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

hpmodules.json

@@ -3,6 +3,7 @@
   "aolBidAdapter",
   "appnexusBidAdapter",
   "consentManagement",
+  "consentManagementUsp",
   "emx_digitalBidAdapter",
   "audienceNetworkBidAdapter",
   "ixBidAdapter",

integrationExamples/gpt/hello_world.html

@@ -8,84 +8,84 @@
 -->
 
 <html>
-  <head>
-      <script async src="../../build/dev/prebid.js"></script>
-      <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script>
-      <script>
+<head>
+    <script async src="../../build/dev/prebid.js"></script>
+    <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script>
+    <script>
         var FAILSAFE_TIMEOUT = 3300;
         var PREBID_TIMEOUT = 1000;
-  
+
         var adUnits = [{
-          code: 'div-gpt-ad-1460505748561-0',
-          mediaTypes: {
-            banner: {
-              sizes: [[300, 250], [300,600]],
-            }
-          },
-          // Replace this object to test a new Adapter!
-          bids: [{
-            bidder: 'appnexus',
-            params: {
-              placementId: 13144370
-            }
-          }]
-  
+            code: 'div-gpt-ad-1460505748561-0',
+            mediaTypes: {
+                banner: {
+                    sizes: [[300, 250], [300,600]],
+                }
+            },
+            // Replace this object to test a new Adapter!
+            bids: [{
+                bidder: 'appnexus',
+                params: {
+                    placementId: 13144370
+                }
+            }]
+
         }];
-  
+
         var pbjs = pbjs || {};
         pbjs.que = pbjs.que || [];
-  
-      </script>
-  
-      <script>
+
+    </script>
+
+    <script>
         var googletag = googletag || {};
         googletag.cmd = googletag.cmd || [];
         googletag.cmd.push(function() {
-          googletag.pubads().disableInitialLoad();
+            googletag.pubads().disableInitialLoad();
         });
-  
+
         pbjs.que.push(function() {
-          pbjs.addAdUnits(adUnits);
-          pbjs.requestBids({
-            bidsBackHandler: sendAdserverRequest,
-            timeout: PREBID_TIMEOUT
-          });
+            pbjs.addAdUnits(adUnits);
+            pbjs.requestBids({
+                bidsBackHandler: sendAdserverRequest,
+                timeout: PREBID_TIMEOUT
+            });
         });
-  
+
         function sendAdserverRequest() {
-          if (pbjs.adserverRequestSent) return;
-          pbjs.adserverRequestSent = true;
-          googletag.cmd.push(function() {
-            pbjs.que.push(function() {
-              pbjs.setTargetingForGPTAsync();
-              googletag.pubads().refresh();
+            if (pbjs.adserverRequestSent) return;
+            pbjs.adserverRequestSent = true;
+            googletag.cmd.push(function() {
+                pbjs.que.push(function() {
+                    pbjs.setTargetingForGPTAsync();
+                    googletag.pubads().refresh();
+                });
             });
-          });
         }
-  
+
         setTimeout(function() {
-          sendAdserverRequest();
+            sendAdserverRequest();
         }, FAILSAFE_TIMEOUT);
-  
-      </script>
-  
-      <script>
+
+    </script>
+
+    <script>
         googletag.cmd.push(function () {
-          googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-1460505748561-0').addService(googletag.pubads());
-  
-          googletag.pubads().enableSingleRequest();
-          googletag.enableServices();
+            googletag.defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-1460505748561-0').addService(googletag.pubads());
+
+            googletag.pubads().enableSingleRequest();
+            googletag.enableServices();
         });
-      </script>
-  </head>
-  
-  <body>
-  <h2>Prebid.js Test</h2>
-  <h5>Div-1</h5>
-  <div id='div-gpt-ad-1460505748561-0'>
-      <script type='text/javascript'>
+    </script>
+</head>
+
+<body>
+<h2>Prebid.js Test</h2>
+<h5>Div-1</h5>
+<div id='div-gpt-ad-1460505748561-0'>
+    <script type='text/javascript'>
         googletag.cmd.push(function() { googletag.display('div-gpt-ad-1460505748561-0'); });
-      </script>
-  </div>
-  </body>
-  </html>
+    </script>
+</div>
+</body>
+</html>