amp-auto-ads.js

/**
 * Copyright 2016 The AMP HTML Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS-IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {AdTracker, getExistingAds} from './ad-tracker';
import {AdStrategy} from './ad-strategy';
import {AnchorAdStrategy} from './anchor-ad-strategy';
import {user} from '../../../src/log';
import {xhrFor} from '../../../src/services';
import {getAdNetworkConfig} from './ad-network-config';
import {isExperimentOn} from '../../../src/experiments';
import {getAttributesFromConfigObj} from './attributes';
import {getPlacementsFromConfigObj} from './placement';

/** @const */
const TAG = 'amp-auto-ads';


export class AmpAutoAds extends AMP.BaseElement {

  /** @override */
  buildCallback() {
    user().assert(isExperimentOn(self, 'amp-auto-ads'), 'Experiment is off');

    const type = this.element.getAttribute('type');
    user().assert(type, 'Missing type attribute');

    const adNetwork = getAdNetworkConfig(type, this.element);
    user().assert(adNetwork, 'No AdNetworkConfig for type: ' + type);

    if (!adNetwork.isEnabled(this.win)) {
      return;
    }

    const configPromise = this.getConfig_(adNetwork.getConfigUrl());
    const docPromise = this.getAmpDoc().whenReady();
    Promise.all([configPromise, docPromise]).then(values => {
      const configObj = values[0];
      if (!configObj) {
        return;
      }

      const placements = getPlacementsFromConfigObj(this.win, configObj);
      const attributes = /** @type {!JsonObject} */ (
          Object.assign(adNetwork.getAttributes(),
              getAttributesFromConfigObj(configObj)));
      const adTracker =
          new AdTracker(getExistingAds(this.win), adNetwork.getAdConstraints());
      new AdStrategy(placements, attributes, adTracker).run();
      new AnchorAdStrategy(this.win, attributes, configObj).run();
    });
  }

  /** @override */
  isLayoutSupported() {
    return true;
  }

  /**
   * Tries to load an auto-ads configuration from the given URL. This uses a
   * non-credentialed request.
   * @param {string} configUrl
   * @return {!Promise<!JsonObject>}
   * @private
   */
  getConfig_(configUrl) {
    // Non-credentialed request
    const xhrInit = {
      mode: 'cors',
      method: 'GET',
      credentials: 'omit',
      requireAmpResponseSourceOrigin: false,
    };
    return xhrFor(this.win)
        .fetchJson(configUrl, xhrInit)
        .then(res => res.json())
        .catch(reason => {
          user().error(TAG, 'amp-auto-ads config xhr failed: ' + reason);
          return null;
        });
  }
}

AMP.registerElement('amp-auto-ads', AmpAutoAds);