Change ads embed mechanism to be more generic for all 3p content.

cramforce · cramforce · commit 91ca3f41e37f · 2015-09-21T22:37:24.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@
 build
 dist
 dist.ads
+dist.3p
 examples.build
 examples.min
 node_modules
diff --git a/3p/frame.max.html b/3p/frame.max.html
@@ -2,11 +2,11 @@
 <head>
 <meta charset="utf-8">
 <meta name="robots" content="noindex">
-<script src="./ads.js"></script>
+<script src="./integration.js"></script>
 </head>
 <body style="margin:0">
 <div id="c" style="position:absolute;top:0;left:0;bottom:0;right:0;">
-  <script>drawAd()</script>
+  <script>draw3p()</script>
 </div>
 <script>if (window.docEndCallback) window.docEndCallback()</script>
 </body>
diff --git a/3p/integration.js b/3p/integration.js
@@ -20,33 +20,31 @@
  */
 
 import '../src/polyfills';
-import {a9} from './a9';
-import {adreactor} from './adreactor';
-import {adsense} from './adsense';
-import {adtech} from './adtech';
-import {doubleclick} from './doubleclick';
+import {a9} from '../ads/a9';
+import {adreactor} from '../ads/adreactor';
+import {adsense} from '../ads/adsense';
+import {adtech} from '../ads/adtech';
+import {doubleclick} from '../ads/doubleclick';
 import {twitter} from './twitter';
 import {register, run} from '../src/3p';
 
-register('ad', 'a9', a9);
-register('ad', 'adreactor', adreactor);
-register('ad', 'adsense', adsense);
-register('ad', 'adtech', adtech);
-register('ad', 'doubleclick', doubleclick);
-
-// TODO(malteubl) Move somewhere else since this is not an ad.
-register('ad', 'twitter', twitter);
+register('a9', a9);
+register('adreactor', adreactor);
+register('adsense', adsense);
+register('adtech', adtech);
+register('doubleclick', doubleclick);
+register('twitter', twitter);
 
 /**
  * Visible for testing.
  * Draws an ad to the window. Expects the data to include the ad type.
  * @param {!Window} win
  * @param {!Object} data
  */
-export function drawAd(win, data) {
+export function draw3p(win, data) {
   var type = data.type;
-  run('ad', type, win, data);
-}
+  run(type, win, data);
+};
 
 /**
  * Returns the "master frame" for all widgets of a given type.
@@ -78,12 +76,12 @@ function masterSelection(type) {
 /**
  * Draws an optionally synchronously to the DOM.
  */
-window.drawAd = function() {
+window.draw3p = function() {
   var fragment = location.hash;
   var data = fragment ? JSON.parse(fragment.substr(1)) : {};
   window.context = data._context;
   window.context.master = masterSelection(data.type);
   window.context.isMaster = window.context.master == window;
   delete data._context;
-  drawAd(window, data);
+  draw3p(window, data);
 };
diff --git a/3p/twitter.js b/3p/twitter.js
diff --git a/build-system/tasks/presubmit-checks.js b/build-system/tasks/presubmit-checks.js
@@ -20,7 +20,7 @@ var util = require('gulp-util');
 // Directories to check for presubmit checks.
 var srcGlobs = [
   '**/*.{css,js,html,md}',
-  '!{node_modules,dist,dist.ads}/**/*.*',
+  '!{node_modules,dist,dist.3p}/**/*.*',
   '!build-system/tasks/presubmit-checks.js',
   '!build/polyfills.js',
   '!gulpfile.js'
diff --git a/gulpfile.js b/gulpfile.js
@@ -72,7 +72,7 @@ function buildExtensions(options) {
 }
 
 function clean(done) {
-  del(['dist', 'dist.ads', 'build', 'examples.build'], done);
+  del(['dist', 'dist.3p', 'build', 'examples.build'], done);
 }
 
 function polyfillsForTests() {
@@ -86,12 +86,12 @@ function compile(watch, shouldMinify) {
     watch: watch,
     minify: shouldMinify
   });
-  compileJs('./ads/', 'ads.js', './dist.ads/' + internalRuntimeVersion, {
+  compileJs('./3p/', 'integration.js', './dist.3p/' + internalRuntimeVersion, {
     minifiedName: 'f.js',
     watch: watch,
     minify: shouldMinify
   });
-  adsBootstrap(watch);
+  thirdPartyBootstrap(watch);
 }
 
 
@@ -240,8 +240,8 @@ function examplesWithMinifiedJs(name) {
       .pipe(gulp.dest('examples.build/'));
 }
 
-function adsBootstrap(watch) {
-  var input = 'ads/frame.max.html';
+function thirdPartyBootstrap(watch) {
+  var input = '3p/frame.max.html';
   if (watch) {
     gulpWatch(input, function() {
       adsBootstrap(false);
@@ -250,10 +250,10 @@ function adsBootstrap(watch) {
   console.log('Processing ' + input);
   var html = fs.readFileSync(input, 'utf8');
   var min = html;
-  min = min.replace(/\.\/ads\.js/g, './f.js');
+  min = min.replace(/\.\/integration\.js/g, './f.js');
   gulp.src(input)
       .pipe(file('frame.html', min))
-      .pipe(gulp.dest('dist.ads/' + internalRuntimeVersion));
+      .pipe(gulp.dest('dist.3p/' + internalRuntimeVersion));
 }
 
 
diff --git a/src/3p-frame.js b/src/3p-frame.js
@@ -132,11 +132,11 @@ export function addDataAndJsonAttributes_(element, attributes) {
 function getBootstrapBaseUrl(parentWindow) {
   // TODO(malteubl): Change to final URL.
   var url =
-      'https://ads.ampproject.net/$internalRuntimeVersion$/frame.html';
+      'https://3p.ampproject.net/$internalRuntimeVersion$/frame.html';
   if (getMode().localDev) {
 
     url = 'http://ads.localhost:' + parentWindow.location.port +
-        '/dist.ads/$internalRuntimeVersion$/frame' +
+        '/dist.3p/$internalRuntimeVersion$/frame' +
         (getMode().minified ? '' : '.max') +
         '.html';
   }
diff --git a/src/3p.js b/src/3p.js
@@ -27,34 +27,29 @@ import {assert} from './asserts';
 var ThirdPartyFunction;
 
 
-/** @const {!Object<!Object<ThirdPartyFunction>>} */
-var registrations = {
-  ad: {}
-};
+/** @const {!Object<ThirdPartyFunction>} */
+var registrations = {};
 
 var syncScriptLoads = 0;
 
 /**
- * @param {string} type The type of 3p integration. See keys in the
- *     registrations objects.
  * @param {string} id The specific 3p integration.
  * @param {ThirdPartyFunction} draw Function that draws the 3p integration.
  */
-export function register(type, id, draw) {
-  var ofType = assert(registrations[type], 'Unknown type ' + type);
-  ofType[id] = draw;
+export function register(id, draw) {
+  assert(!registrations[id], 'Double registration %s', id);
+  registrations[id] = draw;
 }
 
 /**
- * Execute the 3p integration with the given type and id.
- * @param {string} type
+ * Execute the 3p integration with the given id.
  * @param {id} id
  * @param {!Window} win
  * @param {!Object} data
  */
-export function run(type, id, win, data) {
-  var fn = assert(registrations[type], 'Unknown type ' + type)[id];
-  assert(fn, 'Unknown ' + type + ': ' + id);
+export function run(id, win, data) {
+  var fn = registrations[id];
+  assert(fn, 'Unknown 3p: ' + id);
   fn(win, data);
 }
 
diff --git a/test/functional/test-error.js b/test/functional/test-error.js
@@ -67,6 +67,7 @@ describe('reportErrorToServer', () => {
     expect(query.m).to.equal('XYZ');
     expect(query.el).to.equal('FOO-BAR');
     expect(query.a).to.equal('0');
+    expect(query.v).to.equal('$internalRuntimeVersion$');
   });
 
   it('reportError mark asserts', () => {
@@ -78,6 +79,7 @@ describe('reportErrorToServer', () => {
 
     expect(query.m).to.equal('XYZ');
     expect(query.a).to.equal('1');
+    expect(query.v).to.equal('$internalRuntimeVersion$');
   });
 
   it('reportError without error object', () => {
