From 6ed55167c1e8fdc39f9bb29030f106e456f3e14f Mon Sep 17 00:00:00 2001
From: Catalin Ciocov <catalin.ciocov@gmail.com>
Date: Wed, 24 Mar 2021 22:09:54 +0200
Subject: [PATCH 1/5] Add support for multiple custom configurations on the
 MASS module

---
 integrationExamples/mass/index.html |  24 +++-
 modules/mass.js                     | 173 ++++++++++++++++++----------
 test/spec/modules/mass_spec.js      |  20 +---
 3 files changed, 139 insertions(+), 78 deletions(-)

diff --git a/integrationExamples/mass/index.html b/integrationExamples/mass/index.html
index 80fe4cfb934..3b034957d13 100644
--- a/integrationExamples/mass/index.html
+++ b/integrationExamples/mass/index.html
@@ -36,8 +36,30 @@
           pbjs.setConfig({
             mass: {
               enabled: true,
+
+              // official MASS-supported config:
+              dealIdPattern: /^MASS/i,
               renderUrl: 'https://cdn.massplatform.net/bootloader.js',
-              dealIdPattern: /^MASS/i
+
+              // custom configs:
+              custom: [
+                // simple:
+                {
+                  dealIdPattern: /^abc/i,
+                  renderUrl: 'https://my.domain.com/script.js'
+                },
+
+                // flexible:
+                {
+                  match: function(bid) {
+                    // return true or false, based on given bid
+                  },
+
+                  render: function(payload) {
+                    // render the ad
+                  }
+                }
+              ]
             }
           });
         });
diff --git a/modules/mass.js b/modules/mass.js
index 14fe556a466..67b3cc9e599 100644
--- a/modules/mass.js
+++ b/modules/mass.js
@@ -6,15 +6,16 @@ import { config } from '../src/config.js';
 import { getHook } from '../src/hook.js';
 import find from 'core-js-pure/features/array/find.js';
 
-export let listenerAdded = false;
-export let massEnabled = false;
-
 const defaultCfg = {
   dealIdPattern: /^MASS/i
 };
 let cfg;
 
-const massBids = {};
+export let listenerAdded = false;
+export let isEnabled = false;
+
+const matchedBids = {};
+let renderers;
 
 init();
 config.getConfig('mass', config => init(config.mass));
@@ -22,68 +23,111 @@ config.getConfig('mass', config => init(config.mass));
 /**
  * Module init.
  */
-export function init(customCfg) {
-  cfg = Object.assign({}, defaultCfg, customCfg);
+export function init(userCfg) {
+  cfg = Object.assign({}, defaultCfg, userCfg);
 
   if (cfg.enabled === false) {
-    if (massEnabled) {
-      massEnabled = false;
+    if (isEnabled) {
       getHook('addBidResponse').getHooks({hook: addBidResponseHook}).remove();
+      isEnabled = false;
     }
   } else {
-    if (!massEnabled) {
+    if (!isEnabled) {
       getHook('addBidResponse').before(addBidResponseHook);
-      massEnabled = true;
+      isEnabled = true;
     }
   }
+
+  if (isEnabled) {
+    updateRenderers();
+  }
 }
 
 /**
- * Before hook for 'addBidResponse'.
+ * Update the list of renderers based on current config.
  */
-export function addBidResponseHook(next, adUnitCode, bid) {
-  if (!isMassBid(bid) || !cfg.renderUrl) {
-    return next(adUnitCode, bid);
+function updateRenderers() {
+  renderers = [];
+
+  // official MASS renderer:
+  if (cfg.dealIdPattern && cfg.renderUrl) {
+    renderers.push({
+      match: isMassBid,
+      render: useDefaultRender(cfg.renderUrl, 'mass')
+    });
   }
 
-  const bidRequest = find(this.bidderRequest.bids, bidRequest =>
-    bidRequest.bidId === bid.requestId
-  );
-
-  massBids[bid.requestId] = {
-    bidRequest,
-    bid,
-    adm: bid.ad
-  };
-
-  bid.ad = '<script>window.parent.postMessage({massBidId: "' + bid.requestId + '"}, "*");\x3c/script>';
+  // add any custom renderer defined in the config:
+  (cfg.custom || []).forEach(renderer => {
+    if (!renderer.match && renderer.dealIdPattern) {
+      renderer.match = useDefaultMatch(renderer.dealIdPattern);
+    }
 
-  addListenerOnce();
+    if (!renderer.render && renderer.renderUrl && renderer.namespace) {
+      renderer.render = useDefaultRender(renderer.renderUrl, renderer.namespace);
+    }
 
-  next(adUnitCode, bid);
+    if (renderer.match && renderer.render) {
+      renderers.push(renderer);
+    }
+  });
 }
 
 /**
- * Check if a bid is MASS.
+ * Before hook for 'addBidResponse'.
  */
-export function isMassBid(bid) {
-  // either bid.meta.mass is set or deal ID matches a publisher specified pattern:
-  if (!((bid.meta && bid.meta.mass) || (cfg.dealIdPattern && cfg.dealIdPattern.test(bid.dealId)))) {
-    return false;
+export function addBidResponseHook(next, adUnitCode, bid) {
+  let renderer;
+  for (let i = 0; i < renderers.length; i++) {
+    if (renderers[i].match(bid)) {
+      renderer = renderers[i];
+      break;
+    }
   }
 
-  // there must be a 'mass://' or 'pcreative?' in the ad markup:
-  return /mass:\/\/|\/pcreative\?/i.test(bid.ad);
+  if (renderer) {
+    const bidRequest = find(this.bidderRequest.bids, bidRequest =>
+      bidRequest.bidId === bid.requestId
+    );
+
+    matchedBids[bid.requestId] = {
+      renderer,
+      payload: {
+        bidRequest,
+        bid,
+        adm: bid.ad
+      }
+    };
+
+    bid.ad = '<script>window.parent.postMessage({massBidId: "' + bid.requestId + '"}, "*");\x3c/script>';
+
+    addListenerOnce();
+  }
+
+  next(adUnitCode, bid);
 }
 
 /**
- * Add listener to detect requests to render MASS ads.
+ * Add listener for the "message" event sent by the winning bid
  */
 export function addListenerOnce() {
   if (!listenerAdded) {
     window.addEventListener('message', e => {
-      if (e && e.data && e.data.massBidId) {
-        render(getRenderPayload(e));
+      if (!e || !e.data || !e.data.massBidId) {
+        return;
+      }
+
+      const matchedBid = matchedBids[e.data.massBidId];
+      if (matchedBid) {
+        const payload = {
+          type: 'prebid',
+          event: e,
+          ...matchedBid.payload
+        };
+
+        delete payload.bid.ad;
+
+        matchedBid.renderer.render(payload);
       }
     });
 
@@ -92,38 +136,47 @@ export function addListenerOnce() {
 }
 
 /**
- * Prepare payload for render.
+ * Check if a bid is MASS.
  */
-export function getRenderPayload(e) {
-  const payload = {
-    type: 'prebid',
-    e
-  };
+export function isMassBid(bid) {
+  // either bid.meta.mass is set or deal ID matches a publisher specified pattern:
+  if (!((bid.meta && bid.meta.mass) || (cfg.dealIdPattern && cfg.dealIdPattern.test(bid.dealId)))) {
+    return false;
+  }
 
-  Object.assign(payload, massBids[e.data.massBidId]);
-  delete payload.bid.ad;
+  // there must be a 'mass://' or 'pcreative?' in the ad markup:
+  return /mass:\/\/|\/pcreative\?/i.test(bid.ad);
+}
 
-  return payload;
+/**
+ * Default match (factory).
+ */
+export function useDefaultMatch(dealIdPattern) {
+  return function(bid) {
+    return dealIdPattern.test(bid.dealId);
+  };
 }
 
 /**
- * Render a MASS ad.
+ * Default render (factory).
  */
-export function render(payload) {
-  const ns = window.mass = window.mass || {};
+export function useDefaultRender(renderUrl, namespace) {
+  return function render(payload) {
+    const ns = window[namespace] = window[namespace] || {};
+    ns.queue = ns.queue || [];
 
-  ns.bootloader = ns.bootloader || {queue: []};
-  ns.bootloader.queue.push(payload);
+    ns.queue.push(payload);
 
-  if (!ns.bootloader.loaded) {
-    const s = document.createElement('script');
-    s.type = 'text/javascript';
-    s.async = true;
-    s.src = cfg.renderUrl;
+    if (!ns.loaded) {
+      const s = document.createElement('script');
+      s.type = 'text/javascript';
+      s.async = true;
+      s.src = renderUrl;
 
-    const x = document.getElementsByTagName('script')[0];
-    x.parentNode.insertBefore(s, x);
+      const x = document.getElementsByTagName('script')[0];
+      x.parentNode.insertBefore(s, x);
 
-    ns.bootloader.loaded = true;
-  }
+      ns.loaded = true;
+    }
+  };
 }
diff --git a/test/spec/modules/mass_spec.js b/test/spec/modules/mass_spec.js
index d8d27348bde..2e7020c788d 100644
--- a/test/spec/modules/mass_spec.js
+++ b/test/spec/modules/mass_spec.js
@@ -3,10 +3,8 @@ import {
   init,
   addBidResponseHook,
   addListenerOnce,
-  getRenderPayload,
-  render,
   listenerAdded,
-  massEnabled
+  isEnabled
 } from 'modules/mass';
 import { logInfo } from 'src/utils.js';
 
@@ -70,12 +68,12 @@ describe('MASS Module', function() {
   let bidderRequest = Object.assign({}, mockedBidderRequest);
 
   it('should be enabled by default', function() {
-    expect(massEnabled).to.equal(true);
+    expect(isEnabled).to.equal(true);
   });
 
   it('can be disabled', function() {
     init({enabled: false});
-    expect(massEnabled).to.equal(false);
+    expect(isEnabled).to.equal(false);
   });
 
   it('should only affect MASS bids', function() {
@@ -115,16 +113,4 @@ describe('MASS Module', function() {
     addListenerOnce();
     expect(listenerAdded).to.equal(true);
   });
-
-  it('should get correct bid in render payload', function() {
-    const payload = getRenderPayload({data: {massBidId: 'mass-bid-1'}});
-    expect(payload.type).to.equal('prebid');
-    expect(payload.bid.bidId).to.equal('mass-bid-1');
-  });
-
-  it('should load the bootloader on rendering', function() {
-    render({});
-    expect(window.mass).to.be.an('object');
-    expect(window.mass.bootloader.loaded).to.equal(true);
-  });
 });

From f378e6879aad7b73d05c55f276e933a4dc23b055 Mon Sep 17 00:00:00 2001
From: Catalin Ciocov <catalin.ciocov@gmail.com>
Date: Tue, 30 Mar 2021 16:57:08 +0300
Subject: [PATCH 2/5] Look for MASS settings in window.massConfig as well

---
 modules/mass.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/modules/mass.js b/modules/mass.js
index 67b3cc9e599..e8875d2a44a 100644
--- a/modules/mass.js
+++ b/modules/mass.js
@@ -24,7 +24,7 @@ config.getConfig('mass', config => init(config.mass));
  * Module init.
  */
 export function init(userCfg) {
-  cfg = Object.assign({}, defaultCfg, userCfg);
+  cfg = Object.assign({}, defaultCfg, window.massConfig && window.massConfig.mass, userCfg);
 
   if (cfg.enabled === false) {
     if (isEnabled) {

From b45f68d76baa861aa509e2470509dff148834e7e Mon Sep 17 00:00:00 2001
From: Catalin Ciocov <catalin.ciocov@gmail.com>
Date: Tue, 30 Mar 2021 16:58:11 +0300
Subject: [PATCH 3/5] Updated docs

---
 modules/mass.md | 100 +++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 87 insertions(+), 13 deletions(-)

diff --git a/modules/mass.md b/modules/mass.md
index 0db5b5d5bea..fc0add6a18e 100644
--- a/modules/mass.md
+++ b/modules/mass.md
@@ -1,11 +1,5 @@
 ## Overview
 
-```
-Module Name: MASS
-Module Type: Other
-Maintainer: dev@massplatform.net
-```
-
 This module enables the MASS protocol for Prebid. To use it, you'll need to
 work with a MASS enabled provider.
 
@@ -19,12 +13,14 @@ selected a MASS enabled bid as a winner.
 
 Find out more [here](https://massplatform.net).
 
+{: .alert.alert-warning :}
 ## Disclosure
 
-- This module loads external JavaScript to render creatives
+This module loads external JavaScript to render creatives
 
-## Generic Mode
-- You can specify your our own renderUrl using the module configuration option. When specifying a custom renderer, quality assurance is your responsibility.
+## Custom Mode
+
+You can specify your own `dealIdPattern` and `renderUrl` by adding one or more entries into the `custom` configuration option (see [Configuration Parameters](#configuration-parameters) below). When specifying a custom renderer, quality assurance is your responsibility.
 
 ## Integration
 
@@ -34,6 +30,7 @@ Build the MASS module into the Prebid.js package with:
 gulp build --modules=mass,...
 ```
 
+
 ## Module Configuration
 
 ```js
@@ -42,22 +39,99 @@ pbjs.que.push(function() {
     mass: {
       enabled: true,
       renderUrl: 'https://cdn.massplatform.net/bootloader.js',
-      dealIdPattern: /^MASS/i
+      dealIdPattern: /^MASS/i,
+      custom: [
+        {
+          dealIdPattern: /xyz/,
+          renderUrl: 'https://my.domain.com/render.js',
+          namespace: 'xyz'
+        }
+      ]
+    }
+  });
+});
+```
+
+### Configuration Parameters
+
+|Name |Type |Description |Notes |
+| :------------ | :------------ | :------------ |:------------ |
+|enabled | Boolean |Enable/disable the module |Defaults to `true` |
+|dealIdPattern | RegExp |The pattern used to identify MASS deal IDs |Defaults to `/^MASS/i` |
+|renderUrl | String |The MASS render script to load |`https://cdn.massplatform.net/bootloader.js` |
+|custom | Array |Add custom renderers | |
+|custom[].dealIdPattern | RegExp |A pattern used to identify matching deal IDs |Either this parameter or `custom[].match` must be specified |
+|custom[].renderUrl | String |The render script to load |Either this parameter or `custom[].render` must be specified |
+|custom[].namespace | String |The namespace (i.e.: object) created on `window` to pass parameters to the render script |Required with `custom[].renderUrl` |
+|custom[].match | Function(bid) |A custom function to identify matching bids |Either this parameter or `custom[].dealIdPattern` must be specified |
+|custom[].render | Function(payload) |A custom function to render the matchig/winning bid |Either this parameter or `custom[].renderUrl` must be specified. The `payload` parameter contains: `payload.bid`, `payload.bidRequest`, `payload.adm` |
+
+### Example Configurations
+
+### Only (official) MASS support enabled
+
+```js
+pbjs.que.push(function() {
+  pbjs.setConfig({
+    mass: {
+      renderUrl: 'https://cdn.massplatform.net/bootloader.js'
     }
   });
 });
 ```
 
-## Disable MASS
+### MASS support disabled, custom renderer enabled
 
-The MASS module is enabled by default, but you can disable it using:
+```js
+pbjs.que.push(function() {
+  pbjs.setConfig({
+    mass: {
+      custom: [
+        {
+          dealIdPattern: /xyz/,
+          renderUrl: 'https://my.domain.com/render.js',
+          namespace: 'xyz'
+        }
+      ]
+    }
+  });
+});
+```
+
+### Custom `match` and `render`
 
 ```js
 pbjs.que.push(function() {
   pbjs.setConfig({
     mass: {
-      enabled: false
+      custom: [
+        {
+          match: function(bid) {
+            // return true/false if matching/non-matching bid
+          },
+
+          render: function(payload) {
+            console.log(payload);
+          }
+        }
+      ]
     }
   });
 });
 ```
+
+## Integration Example
+
+To view the integration example:
+ 
+1) in your cli run:
+
+```
+gulp serve --modules=ixBidAdapter,mass
+```
+
+2) in your browser, navigate to:
+
+```
+http://localhost:9999/integrationExamples/mass/index.html
+```

From 962a2c534838a6ba0d6278f101ddc020c6efebab Mon Sep 17 00:00:00 2001
From: Catalin Ciocov <catalin.ciocov@gmail.com>
Date: Mon, 5 Apr 2021 16:32:44 +0300
Subject: [PATCH 4/5] Added more testing

---
 modules/mass.js                |  4 +++-
 test/spec/modules/mass_spec.js | 35 ++++++++++++++++++++++++++++++++++
 2 files changed, 38 insertions(+), 1 deletion(-)

diff --git a/modules/mass.js b/modules/mass.js
index e8875d2a44a..01135e7ddff 100644
--- a/modules/mass.js
+++ b/modules/mass.js
@@ -46,7 +46,7 @@ export function init(userCfg) {
 /**
  * Update the list of renderers based on current config.
  */
-function updateRenderers() {
+export function updateRenderers() {
   renderers = [];
 
   // official MASS renderer:
@@ -71,6 +71,8 @@ function updateRenderers() {
       renderers.push(renderer);
     }
   });
+
+  return renderers;
 }
 
 /**
diff --git a/test/spec/modules/mass_spec.js b/test/spec/modules/mass_spec.js
index 2e7020c788d..3dd7a4aa5a3 100644
--- a/test/spec/modules/mass_spec.js
+++ b/test/spec/modules/mass_spec.js
@@ -3,6 +3,10 @@ import {
   init,
   addBidResponseHook,
   addListenerOnce,
+  isMassBid,
+  useDefaultMatch,
+  useDefaultRender,
+  updateRenderers,
   listenerAdded,
   isEnabled
 } from 'modules/mass';
@@ -113,4 +117,35 @@ describe('MASS Module', function() {
     addListenerOnce();
     expect(listenerAdded).to.equal(true);
   });
+
+  it('should support custom renderers', function() {
+    init({
+      renderUrl: 'http://...',
+      custom: [
+        {
+          dealIdPattern: /abc/,
+          render: function() {}
+        }
+      ]
+    });
+
+    const renderers = updateRenderers();
+
+    expect(renderers.length).to.equal(2);
+  });
+
+  it('should match bids by deal ID with the default matcher', function() {
+    const match = useDefaultMatch(/abc/);
+
+    expect(match({dealId: 'abc'})).to.equal(true);
+    expect(match({dealId: 'xyz'})).to.equal(false);
+  });
+
+  it('should have a default renderer', function() {
+    const render = useDefaultRender('http://example.com/render.js', 'abc');
+    render({});
+
+    expect(window.abc.loaded).to.equal(true);
+    expect(window.abc.queue.length).to.equal(1);
+  });
 });

From 6b49f4d0d2bafba4420bde506c2f8d4bdfd6b151 Mon Sep 17 00:00:00 2001
From: Catalin Ciocov <catalin.ciocov@gmail.com>
Date: Tue, 6 Apr 2021 12:50:32 +0300
Subject: [PATCH 5/5] Updated test URLs to https

---
 test/spec/modules/mass_spec.js | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/test/spec/modules/mass_spec.js b/test/spec/modules/mass_spec.js
index 3dd7a4aa5a3..a4a87ce113f 100644
--- a/test/spec/modules/mass_spec.js
+++ b/test/spec/modules/mass_spec.js
@@ -81,7 +81,7 @@ describe('MASS Module', function() {
   });
 
   it('should only affect MASS bids', function() {
-    init({renderUrl: 'http://...'});
+    init({renderUrl: 'https://...'});
     mockedNonMassBids.forEach(function(mockedBid) {
       const originalBid = Object.assign({}, mockedBid);
       const bid = Object.assign({}, originalBid);
@@ -95,7 +95,7 @@ describe('MASS Module', function() {
   });
 
   it('should only update the ad markup field', function() {
-    init({renderUrl: 'http://...'});
+    init({renderUrl: 'https://...'});
     mockedMassBids.forEach(function(mockedBid) {
       const originalBid = Object.assign({}, mockedBid);
       const bid = Object.assign({}, originalBid);
@@ -120,7 +120,7 @@ describe('MASS Module', function() {
 
   it('should support custom renderers', function() {
     init({
-      renderUrl: 'http://...',
+      renderUrl: 'https://...',
       custom: [
         {
           dealIdPattern: /abc/,
@@ -142,7 +142,7 @@ describe('MASS Module', function() {
   });
 
   it('should have a default renderer', function() {
-    const render = useDefaultRender('http://example.com/render.js', 'abc');
+    const render = useDefaultRender('https://example.com/render.js', 'abc');
     render({});
 
     expect(window.abc.loaded).to.equal(true);