Merge pull request #1 from prebid/master

prebid-5.0

.babelrc.js

@@ -16,12 +16,12 @@ module.exports = {
       {
         "targets": {
           "browsers": [
-            "chrome >= 61",
-            "safari >=8",
-            "edge >= 14",
-            "ff >= 57",
-            "ie >= 10",
-            "ios >= 8"
+            "chrome >= 75",
+            "safari >=10",
+            "edge >= 70",
+            "ff >= 70",
+            "ie >= 11",
+            "ios >= 11"
           ]
         }
       }

.circleci/config.yml

@@ -2,49 +2,96 @@
 #
 # Check https://circleci.com/docs/2.0/language-javascript/ for more details
 #
+
+aliases: 
+  - &environment
+      docker:
+        # specify the version you desire here
+        - image: circleci/node:12.16.1
+      resource_class: xlarge
+        # 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:7.10
+    <<: *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
+  e2etest:
+    <<: *environment
+    steps: *endtoend_test_steps
+
+workflows:
+  version: 2
+  commit:
+    jobs:
+      - build
+  nightly:
+    triggers:
+      - schedule:
+          cron: "0 0 * * *"
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - e2etest
+
+experimental:
+  pipelines: true

.eslintrc.js

@@ -1,35 +1,53 @@
+
+const allowedModules = require('./allowedModules.js');
+
 module.exports = {
-  "env": {
-    "browser": true,
-    "commonjs": true
+  env: {
+    browser: true,
+    commonjs: true
   },
-  "settings": {
-    "import/resolver": {
-      "node": {
-        "moduleDirectory": ["node_modules", "./"]
+  settings: {
+    'import/resolver': {
+      node: {
+        moduleDirectory: ['node_modules', './']
       }
     }
   },
-  "extends": "standard",
-  "globals": {
-    "$$PREBID_GLOBAL$$": false
+  extends: 'standard',
+  plugins: [
+    'prebid',
+    'import'
+  ],
+  globals: {
+    '$$PREBID_GLOBAL$$': false,
+    'BROWSERSTACK_USERNAME': false,
+    'BROWSERSTACK_KEY': false
   },
-  "parserOptions": {
-    "sourceType": "module"
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2018,
   },
-  "rules": {
-    "comma-dangle": "off",
-    "semi": "off",
-    "space-before-function-paren": "off",
+  rules: {
+    '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.
     //
     // See Issue #1111.
-    "eqeqeq": "off",
-    "no-return-assign": "off",
-    "no-throw-literal": "off",
-    "no-undef": "off",
-    "no-useless-escape": "off",
-  }
+    eqeqeq: 'off',
+    'no-return-assign': 'off',
+    'no-throw-literal': 'off',
+    'no-undef': 2,
+    'no-useless-escape': 'off',
+    'no-console': 'error'
+  },
+  overrides: Object.keys(allowedModules).map((key) => ({
+    files: key + '/**/*.js',
+    rules: {
+      'prebid/validate-imports': ['error', allowedModules[key]]
+    }
+  }))
 };

.github/release-drafter.yml

@@ -0,0 +1,28 @@
+
+name-template: 'Prebid $RESOLVED_VERSION Release'
+tag-template: '$RESOLVED_VERSION'
+categories:
+  - title: '🚀 New Features'
+    label: 'feature'
+  - title: '🛠 Maintenance'
+    label: 'maintenance'    
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'      
+change-template: '- $TITLE (#$NUMBER)'
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: minor
+template: |
+  ## In This Release
+  $CHANGES

.github/stale.yml

@@ -8,6 +8,7 @@ exemptLabels:
   - security
   - bug
   - feature
+  - on hold
 # Label to use when marking an issue as stale
 staleLabel: stale
 # Comment to post when marking an issue as stale. Set to `false` to disable

.github/workflows/release-drafter.yml

@@ -0,0 +1,18 @@
+name: Release Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - uses: release-drafter/release-drafter@v5
+        with:
+         config-name: release-drafter.yml         
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -28,6 +28,9 @@ build/coverage/
 .idea/
 # if you remove the above rule, at least ignore the following:
 
+# VS Code
+.vscode/
+
 # User-specific stuff:
 # .idea/workspace.xml
 # .idea/tasks.xml

.nvmrc

@@ -1 +1 @@
-7.0
+12.16.1

CONTRIBUTING.md

@@ -3,8 +3,10 @@ Contributions are always welcome. To contribute, [fork](https://help.github.com/
 commit your changes, and [open a pull request](https://help.github.com/articles/using-pull-requests/) against the
 master branch.
 
-Pull requests must have 80% code coverage before beign considered for merge.
-Additional details about the process can be found [here](./pr_review.md).
+Pull requests must have 80% code coverage before being considered for merge.
+Additional details about the process can be found [here](./PR_REVIEW.md).
+
+There are more details available if you'd like to contribute a [bid adapter](https://docs.prebid.org/dev-docs/bidder-adaptor.html) or [analytics adapter](https://docs.prebid.org/dev-docs/integrate-with-the-prebid-analytics-api.html).
 
 ## Issues
 [prebid.org](http://prebid.org/) contains documentation that may help answer questions you have about using Prebid.js.
@@ -48,14 +50,16 @@ 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:
 
 - Look in `test/spec` and its subdirectories
-- Tests for bidder adaptors are located in `test/spec/modules`
+- Tests for bidder adapters are located in `test/spec/modules`
 
 A test module might have the following general structure: