test-cache-cid-api.js

/**
 * Copyright 2018 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 * as lolex from 'lolex';
import {CacheCidApi} from '../../src/service/cache-cid-api';
import {installTimerService} from '../../src/service/timer-impl';
import {mockServiceForDoc, stubService} from '../../testing/test-helper';

describes.realWin('cacheCidApi', {amp: true}, env => {
  let ampdoc;
  let api;
  let sandbox;
  let viewerMock;
  let fetchJsonStub;
  let clock;

  beforeEach(() => {
    ampdoc = env.ampdoc;
    sandbox = env.sandbox;
    fetchJsonStub = stubService(env.sandbox, env.win, 'xhr', 'fetchJson');

    viewerMock = mockServiceForDoc(sandbox, ampdoc, 'viewer', [
      'isCctEmbedded',
      'isProxyOrigin',
    ]);

    clock = lolex.install({
      target: env.win,
      toFake: ['Date', 'setTimeout', 'clearTimeout'],
    });
    installTimerService(env.win);
    api = new CacheCidApi(env.ampdoc);
  });
  afterEach(() => {
    clock.uninstall();
  });

  describe('isSupported', () => {
    it('should return true if page is in CCT and is served by a proxy', () => {
      viewerMock.isCctEmbedded.returns(true);
      viewerMock.isProxyOrigin.returns(true);
      return expect(api.isSupported()).to.be.true;
    });

    it('should return false if page is not embedded in CCT', () => {
      viewerMock.isCctEmbedded.returns(false);
      viewerMock.isProxyOrigin.returns(true);
      return expect(api.isSupported()).to.be.false;
    });

    it('should return false if page is not served by a proxy', () => {
      viewerMock.isCctEmbedded.returns(true);
      viewerMock.isProxyOrigin.returns(false);
      return expect(api.isSupported()).to.be.false;
    });
  });

  describe('getScopedCid', () => {
    beforeEach(() => {
      viewerMock.isCctEmbedded.returns(true);
      viewerMock.isProxyOrigin.returns(true);
    });

    it('should use client ID API from api if everything great', () => {
      fetchJsonStub.returns(
        Promise.resolve({
          json: () => {
            return Promise.resolve({
              publisherClientId: 'publisher-client-id-from-cache',
            });
          },
        })
      );
      return api.getScopedCid('AMP_ECID_GOOGLE').then(cid => {
        expect(cid).to.equal(
          'amp-mJW1ZjoviqBJydzRI8KnitWEpqyhQqDegGCl' +
            'rvvfkCif_N9oYLdZEB976uJDhYgL'
        );
        expect(fetchJsonStub).to.be.calledWith(
          'https://ampcid.google.com/v1/cache:getClientId?key=AIzaSyDKtqGxnoeIqVM33Uf7hRSa3GJxuzR7mLc',
          {
            method: 'POST',
            ampCors: false,
            credentials: 'include',
            mode: 'cors',
            body: {
              publisherOrigin: 'about:srcdoc',
            },
          }
        );
      });
    });

    it('should return null if opted out', () => {
      fetchJsonStub.returns(
        Promise.resolve({
          json: () => {
            return Promise.resolve({
              optOut: true,
            });
          },
        })
      );
      return api.getScopedCid('AMP_ECID_GOOGLE').then(cid => {
        expect(cid).to.equal(null);
        expect(fetchJsonStub).to.be.calledWith(
          'https://ampcid.google.com/v1/cache:getClientId?key=AIzaSyDKtqGxnoeIqVM33Uf7hRSa3GJxuzR7mLc',
          {
            method: 'POST',
            ampCors: false,
            credentials: 'include',
            mode: 'cors',
            body: {
              publisherOrigin: 'about:srcdoc',
            },
          }
        );
      });
    });

    it('should try alternative url if API provides', () => {
      fetchJsonStub.onCall(0).returns(
        Promise.resolve({
          json: () => {
            return Promise.resolve({
              alternateUrl: 'https://ampcid.google.co.uk/v1/cache:getClientId',
            });
          },
        })
      );
      fetchJsonStub.onCall(1).returns(
        Promise.resolve({
          json: () => {
            return Promise.resolve({
              publisherClientId: 'publisher-client-id-from-cache',
            });
          },
        })
      );
      return api.getScopedCid('AMP_ECID_GOOGLE').then(cid => {
        expect(cid).to.equal(
          'amp-mJW1ZjoviqBJydzRI8KnitWEpqyhQqDegGCl' +
            'rvvfkCif_N9oYLdZEB976uJDhYgL'
        );
        expect(fetchJsonStub.getCall(1).args[0]).to.equal(
          'https://ampcid.google.co.uk/v1/cache:getClientId?key=AIzaSyDKtqGxnoeIqVM33Uf7hRSa3GJxuzR7mLc'
        );
      });
    });

    it('should fail if the request times out', () => {
      fetchJsonStub.callsFake(() => {
        return new Promise((resolve, unused) => {
          clock.setTimeout(resolve, 35000, {
            json: () => {
              return Promise.resolve({
                publisherClientId: 'publisher-client-id-from-cache',
              });
            },
          });
        });
      });
      const response = api
        .getScopedCid('AMP_ECID_GOOGLE')
        .then(cid => {
          expect(cid).to.equal(null);
          expect(fetchJsonStub).to.be.calledWith(
            'https://ampcid.google.com/v1/cache:getClientId?key=AIzaSyDKtqGxnoeIqVM33Uf7hRSa3GJxuzR7mLc',
            {
              method: 'POST',
              ampCors: false,
              credentials: 'include',
              mode: 'cors',
              body: {
                publisherOrigin: 'about:srcdoc',
              },
            }
          );
        })
        .catch(() => {});
      clock.tick(30000);
      return response;
    });
  });
});