Merge pull request #1 from prebid/master

Merging back with prebid master

.babelrc.js

@@ -0,0 +1,34 @@
+
+let path = require('path');
+
+function useLocal(module) {
+ return require.resolve(module, {
+ paths: [
+ __dirname
+ ]
+ })
+}
+
+module.exports = {
+ "presets": [
+ [
+ useLocal('@babel/preset-env'),
+ {
+ "targets": {
+ "browsers": [
+ "chrome >= 61",
+ "safari >=8",
+ "edge >= 14",
+ "ff >= 57",
+ "ie >= 10",
+ "ios >= 8"
+ ]
+ }
+ }
+ ]
+ ],
+ "plugins": [
+ path.resolve(__dirname, './plugins/pbjsGlobals.js'),
+ useLocal('babel-plugin-transform-object-assign')
+ ]
+};

.circleci/config.yml

@@ -33,7 +33,7 @@ jobs:
  - node_modules
  key: v1-dependencies-{{ checksum "package.json" }}
 
- - run: sudo npm install -g gulp
+ - run: sudo npm install -g gulp-cli
  # Download and run BrowserStack local
  - run:
  name : Download BrowserStack Local binary and start it.

CONTRIBUTING.md

@@ -64,8 +64,8 @@ A test module might have the following general structure:
 import { expect } from 'chai'; // may prefer 'assert' in place of 'expect'
 import adapter from 'src/adapters/<adapter>';
 
-describe('<Adapter>', () => {
- it('<description of unit or feature being tested>', () => {
+describe('<Adapter>', function () {
+ it('<description of unit or feature being tested>', function () {
  // Arrange - set up preconditions and inputs
  // Act - call or act on the code under test
  // Assert - use chai to check that expected results have occurred

PREBID_VERSIONING_DEPRECATION.md

@@ -0,0 +1,25 @@
+# Prebid versioning and deprecation policy
+
+## Goals
+Provide clear definitions and policy around versioning and breaking changes to APIs that are both publisher and demand partner facing.
+
+ - Limit the number of breaking changes.
+ - Ensure significant time for updates for breaking changes so that publisher or demand partners do not break.
+ - Provide a path to deprecation and reduce technical debt and increase security.
+ - Major versions should not be changed more than once per 30 days.
+
+## Versioning
+
+Follow semantic versioning so that all breaking changes occur within a major release. A breaking change includes both demand partner internal APIs* and publisher facing APIs (global APIs).
+
+*Demand partner APIs may be excluded from breaking change policy at the core teams discretion if the changes are made so to be transparent to the bidders (such as internal refactoring).
+
+## Deprecation process
+
+ - Open an issue with an "intent to implement" and "API impact" labels.
+ - Allow 2 weeks for discussion.
+ - Announce breaking change to the mailing list (TBD needs to be created).
+ - At least 2 core members needs to provide explicit approval for the deprecation.
+ - Open a PR against current master for console warning for possible breakage.
+ - Support the previous major version for a minimum of 30 days.
+ - Coordinate with the core team to ensure clean merging into feature branch if applicable (future major version branch).

PR_REVIEW.md

@@ -18,6 +18,7 @@ For modules and core platform updates, the initial reviewer should request an ad
 - Once there is 2 `LGTM` on the PR, merge to master
 - Ask the submitter to add a PR for documentation if applicable.
 - Add a line into the [draft release](https://github.com/prebid/Prebid.js/releases) notes for this submission. If no draft release is available, create one using [this template]( https://gist.github.com/mkendall07/c3af6f4691bed8a46738b3675cb5a479)
+- Add the PR to the appropriate project board (I.E. 1.23.0 Release) for the week, [see](https://github.com/prebid/Prebid.js/projects)
 
 ### New Adapter or updates to adapter process
 - Follow steps above for general review process. In addition, please verify the following:
@@ -39,9 +40,9 @@ For modules and core platform updates, the initial reviewer should request an ad
 ## Ticket Coordinator
 
 Each week, Prebid Org assigns one person to keep an eye on incoming issues and PRs. That person should:
-- Review issues and PRs at least once per weekday for new items.
+- Review issues and PRs at least once per weekday for new items. Encourage a 48 "SLA" on PRs/issues assigned. Aim for touchpoint once every 48/hours. 
 - For PRs: assign PRs to individuals on the PR review list. Try to be equitable -- not all PRs are created equally. Use the "Assigned" field and add the "Needs Review" label.
-- For Issues: try to address questions and troubleshooting requests on your own, assigning them to others as needed.
+- For Issues: try to address questions and troubleshooting requests on your own, assigning them to others as needed. Please add labels as appropriate (I.E. bug, question, backlog etc).
 - Issues that are questions or troubleshooting requests may be closed if the originator doesn't respond within a week to requests for confirmation or details.
 - Issues that are bug reports should be left open and assigned to someone in PR rotation to confirm or deny the bug status.
 - It's polite to check with others before assigning them large tasks.

README.md

@@ -4,6 +4,7 @@
 [![Code Climate](https://codeclimate.com/github/prebid/Prebid.js/badges/gpa.svg)](https://codeclimate.com/github/prebid/Prebid.js)
 [![Coverage Status](https://coveralls.io/repos/github/prebid/Prebid.js/badge.svg)](https://coveralls.io/github/prebid/Prebid.js)
 [![devDependencies Status](https://david-dm.org/prebid/Prebid.js/dev-status.svg)](https://david-dm.org/prebid/Prebid.js?type=dev)
+[![Total Alerts](https://img.shields.io/lgtm/alerts/g/prebid/Prebid.js.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/prebid/Prebid.js/alerts/)
 
 # Prebid.js
 
@@ -15,11 +16,94 @@ Working examples can be found in [the developer docs](http://prebid.org/dev-docs
 
 **Table of Contents**
 
+- [Usage](#Usage)
 - [Install](#Install)
 - [Build](#Build)
 - [Run](#Run)
 - [Contribute](#Contribute)
 
+<a name="Usage"></a>
+
+## Usage (as a npm dependency)
+
+*Note:* Requires Prebid.js v1.38.0+
+
+Prebid.js depends on Babel and some Babel Plugins in order to run correctly in the browser. Here are some examples for 
+configuring webpack to work with Prebid.js.
+
+With Babel 7:
+```javascript
+// webpack.conf.js
+let path = require('path');
+module.exports = {
+ mode: 'production',
+ module: {
+ rules: [
+
+ // this rule can be excluded if you don't require babel-loader for your other application files
+ {
+ test: /\.m?js$/,
+ exclude: /node_modules/,
+ use: {
+ loader: 'babel-loader',
+ }
+ },
+
+ // this separate rule is required to make sure that the Prebid.js files are babel-ified. this rule will
+ // override the regular exclusion from above (for being inside node_modules).
+ {
+ test: /.js$/,
+ include: new RegExp(`\\${path.sep}prebid\.js`),
+ use: {
+ loader: 'babel-loader',
+ // presets and plugins for Prebid.js must be manually specified separate from your other babel rule.
+ // this can be accomplished by requiring prebid's .babelrc.js file (requires Babel 7 and Node v8.9.0+)
+ options: require('prebid.js/.babelrc.js')
+ }
+ }
+ ]
+ }
+}
+```
+
+Or for Babel 6 and/or Node v8.6.0 and less:
+```javascript
+ // you must manually install and specify the presets and plugins yourself
+ options: {
+ plugins: [
+ "transform-object-assign", // required (for IE support) and "babel-plugin-transform-object-assign" 
+ // must be installed as part of your package.
+ require('prebid.js/plugins/pbjsGlobals.js') // required!
+ ],
+ presets: [
+ ["env", { // you can use other presets if you wish.
+ "targets": { // this example is using "babel-presets-env", which must be installed if you
+ "browsers": [ // follow this example.
+ ... // your browser targets. they should probably match the targets you're using for the rest 
+ // of your application
+ ]
+ }
+ }]
+ ]
+ }
+```
+
+Then you can use Prebid.js as any other npm depedendency
+
+```javascript
+import prebid from 'prebid.js';
+import 'prebid.js/modules/rubiconBidAdapter'; // imported modules will register themselves automatically with prebid
+import 'prebid.js/modules/appnexusBidAdapter';
+prebid.processQueue(); // required to process existing pbjs.queue blocks and setup any further pbjs.queue execution
+
+prebid.requestBids({
+ ...
+})
+
+```
+
+
+
 <a name="Install"></a>
 
 ## Install
@@ -28,7 +112,16 @@ Working examples can be found in [the developer docs](http://prebid.org/dev-docs
  $ cd Prebid.js
  $ npm install
 
-*Note:* You need to have `NodeJS` 4.x or greater installed.
+*Note:* You need to have `NodeJS` 6.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.
+
+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 installd 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).
+
+To remove the old package, you can use the command: `npm rm gulp -g`
+
+Once setup, run the following command to globally install the `gulp-cli` package: `npm install gulp-cli -g`
+
 
 <a name="Build"></a>
 
@@ -167,7 +260,7 @@ Many SSPs, bidders, and publishers have contributed to this project. [60+ Bidder
 
 For guidelines, see [Contributing](./CONTRIBUTING.md).
 
-Our PR review process can be found [here](https://github.com/prebid/Prebid.js/tree/master/pr_review.md).
+Our PR review process can be found [here](https://github.com/prebid/Prebid.js/tree/master/PR_REVIEW.md).
 
 ### Add a Bidder Adapter
 
@@ -207,7 +300,7 @@ For instructions on writing tests for Prebid.js, see [Testing Prebid.js](http://
 
 ### Supported Browsers
 
-Prebid.js is supported on IE10+ and modern browsers.
+Prebid.js is supported on IE11 and modern browsers.
 
 ### Governance
 Review our governance model [here](https://github.com/prebid/Prebid.js/tree/master/governance.md).

RELEASE_SCHEDULE.md

@@ -17,13 +17,17 @@ Announcements regarding releases will be made to the #headerbidding-dev channel
 
 ## Release Process
 
-1. Make Sure all browserstack tests are passing. On PR merge to master travis will run unit tests on browserstack. Checking the last travis build [here](https://travis-ci.org/prebid/Prebid.js/branches) for master branch will show you detailed results. 
+_Note: If `github.com/prebid/Prebid.js` is not configured as the git origin for your repo, all of the following git commands will have to be modified to reference the proper remote (e.g. `upstream`)_
+
+1. Make Sure all browserstack tests are passing. On PR merge to master CircleCI will run unit tests on browserstack. Checking the last CircleCI build [here](https://circleci.com/gh/prebid/Prebid.js) for master branch will show you detailed results. 
 
  In case of failure do following, 
  - Try to fix the failing tests.
  - If you are not able to fix tests in time. Skip the test, create issue and tag contributor.
 
  #### How to run tests in browserstack
+
+ _Note: the following browserstack information is only relevant for debugging purposes, if you will not be debugging then it can be skipped._
 
  Set the environment variables. You may want to add these to your `~/.bashrc` for convenience.
 
@@ -59,11 +63,12 @@ Announcements regarding releases will be made to the #headerbidding-dev channel
  Pull these changes locally by running command 
  ```
  git pull
+ git fetch --tags
  ``` 
 
  and verify the tag.
 
-5. Update coveralls
+5. Update coveralls _(skip for legacy)_
 
  We use https://coveralls.io/ to show parts of code covered by unit tests.
 
@@ -75,22 +80,35 @@ Announcements regarding releases will be made to the #headerbidding-dev channel
 
  Run `gulp coveralls` to update code coverage history.
 
-6. Distribute the code
+6. Distribute the code 
+
+ _Note: do not go to step 7 until step 6 has been verified completed._
 
  Reach out to any of the Appnexus folks to trigger the jenkins job.
 
  // TODO 
  Jenkins job is moving files to appnexus cdn, pushing prebid.js to npm, purging cache and sending notification to slack.
  Move all the files from Appnexus CDN to jsDelivr and create bash script to do above tasks.
 
-7. Post Release Steps
+7. Post Release Version
 
  Update the version
  Manually edit Prebid's package.json to become "1.x.x-pre" (using the values for the next release). Then commit your changes.
  ```
  git commit -m "Increment pre version"
  git push
  ```
+
+8. Create new release draft
+
+ Go to [github releases](https://github.com/prebid/Prebid.js/releases) and add a new draft for the next version of Prebid.js with the following template:
+```
+## 🚀New Features
+ 
+## 🛠Maintenance
+ 
+## 🐛Bug Fixes
+```
 
 ## Beta Releases
 

gulpHelpers.js

@@ -66,7 +66,7 @@ module.exports = {
  try {
  var absoluteModulePath = path.join(__dirname, MODULE_PATH);
  internalModules = fs.readdirSync(absoluteModulePath)
- .filter(file => !(/(^|\/)\.[^\/\.]/g).test(file))
+ .filter(file => (/^[^\.]+(\.js)?$/).test(file))
  .reduce((memo, file) => {
  var moduleName = file.split(new RegExp('[.\\' + path.sep + ']'))[0];
  var modulePath = path.join(absoluteModulePath, file);