Performance (#74)

* Performance
* Add task to launch performance metrics on all combinations of use cases
* Add sui-perf dev dependency

* Remove unused arrow functions params as suggested @pablovegau

* Optional Performance Bootstraping
* Add window and performance instance as optional params in bootstrap
* Update performance use cases for use performance bootstrap from production code
* Add Container and Bootstrap performance in production code

* Fix integration tests

* Update minor version

* Add pull request template

* * Add Performance documentation
* Add Bootstraping marks in all use cases

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+# Background
+
+X
+
+# Goal
+
+X
+
+# Implementation
+
+X
+
+# Further considerations
+
+X
+
+# Checklist
+
+- [ ] The PR relates to *only* one subject with a clear title.
+- [ ] I have performed a self-review of my own code
+- [ ] Wrote [good commit messages](http://chris.beams.io/posts/git-commit/)
+- [ ] My code is readable by someone else, and I commented the hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have added tests that prove my fix is effective or that my feature works
+

.npmignore

@@ -2,4 +2,5 @@ src
 coverage
 .travis.yml
 .idea
-.eslintignore
+.eslintignore
+resources

README.md

@@ -208,6 +208,19 @@ http://your.web.app/page?price=5000&openads_debug
 
 Currently, OpenAds uses [LogLevel](https://github.com/pimterry/loglevel) as its logging framework.
 
+
+# Performance
+
+We care about performance, we know that showing ads in your page can penalize your user experience so we tried to do our best to not have bottle necks in our code.
+You can take a look at the time line of all use cases using the performance task.
+
+```bash
+npm run performance
+```
+
+![Timeline performance](./resources/timeline.png)
+
+
 # Roadmap
 
 * Add support to Google AdSense

package.json

@@ -1,16 +1,17 @@
 {
   "name": "@schibstedspain/openads",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "OpenAds: Advertising library",
   "main": "dist/",
   "scripts": {
     "cleanDistFolder": "rm -Rf ./dist",
     "prepublishOnly": "npm run cleanDistFolder && npm run build",
     "build": "npm run cleanDistFolder && babel src --ignore test --out-dir dist ",
     "test": "mocha --recursive --require babel-polyfill --compilers js:babel-register \"src/test/**/*.js\"",
-    "test:integration": "mocha --recursive --require babel-polyfill --compilers js:babel-register \"src/itest/**/*.js\"",
+    "test:integration": "mocha --recursive --require babel-polyfill --compilers js:babel-register \"src/itest/openads/**/*.js\"",
     "coverage": "istanbul cover --report html _mocha -- ./src/*test --recursive --compilers js:babel-register",
     "coverage:ci": "istanbul cover _mocha -- ./src/*test --recursive --compilers js:babel-register && codecov",
+    "performance": "babel-node src/itest/performance",
     "watch": "onchange 'src/**/*.js' -- npm run build",
     "lint": "sui-lint js"
   },
@@ -23,10 +24,11 @@
     "advertising",
     "schibsted"
   ],
-  "author": "The Mighty Ducks of Advertising",
+  "author": "One Punch Team",
   "license": "ISC",
   "devDependencies": {
     "@s-ui/lint": "^2.13.0",
+    "@s-ui/perf": "^1.4.0",
     "@schibstedspain/openads-connector-api": "^1.2.0",
     "babel-cli": "^6.24.0",
     "babel-loader": "^7.1.4",

src/index.js

@@ -1,2 +1,2 @@
-import OpenAds from './openads/infrastructure/bootstrap/index'
+import OpenAds from './openads/infrastructure/bootstrap/Main'
 export default OpenAds

src/itest/openads/infrastructure/bootstrap/index.js

@@ -2,7 +2,7 @@ import ContainerTest from '../configuration/ContainerTest'
 import OpenAds from '../../../../openads/application/OpenAds'
 
 export default class BootstrapTest {
-  static init ({config, appNexusClient}) {
-    return new OpenAds({container: new ContainerTest({config, appNexusClient})})
+  static init ({config}) {
+    return new OpenAds({container: new ContainerTest({config})})
   }
 }

src/itest/openads/infrastructure/configuration/ContainerTest.js

@@ -3,17 +3,18 @@ import HTMLDOMDriver from '../../../../openads/infrastructure/service/HTMLDOMDri
 import {JSDOM} from 'jsdom'
 
 export default class ContainerTest extends Container {
-  constructor ({config, appNexusClient}) {
-    super({config, eager: false})
-    this._appNexusClient = appNexusClient
-    super._buildEagerSingletonInstances()
+  constructor ({config, eager = true} = {}) {
+    super({
+      config,
+      eager: false,
+      currentWindow: new HTMLDOMDriver({
+        dom: new JSDOM('<!DOCTYPE html><div id="forlayo">Hello world</div>').window
+      })
+    })
+    if (eager) super._buildEagerSingletonInstances()
   }
 
   _buildDOMDriver () {
-    return new HTMLDOMDriver({dom: new JSDOM('<!DOCTYPE html><div id="forlayo">Hello world</div>').window.document})
-  }
-
-  _buildAppNexusClient () {
-    return this._appNexusClient
+    return this._currentWindow
   }
 }

src/itest/performance/index.js

@@ -0,0 +1,15 @@
+import {
+  addPositionAndDisplay,
+  addPosition,
+  displayNonexistentPosition,
+  refreshNonexistentPosition,
+  addPositionAndDisplayAndRefresh
+
+} from './performanceUseCases'
+
+Promise.resolve()
+  .then(() => addPosition())
+  .then(() => displayNonexistentPosition())
+  .then(() => refreshNonexistentPosition())
+  .then(() => addPositionAndDisplay())
+  .then(() => addPositionAndDisplayAndRefresh())