test/unit/test-integration.js - main - githubmirror/amphtml

test/unit/test-integration.js
355 строк10 KB
Kristofer Baxter
♻️ Remove Notice from JS and Markdown (#35717)
19 авг 2021, 21:21
19 авг 2021, 21:21f564b7e
// Tests integration.js
// Most coverage through test-3p-frame

import {getRegistrations, register} from '#3p/3p';
import {
  draw3pInternal,
  ensureFramed,
  parseFragment,
  validateAllowedEmbeddingOrigins,
  validateAllowedTypes,
  validateParentOrigin,
} from '#3p/integration-lib';

describes.sandboxed('3p integration.js', {}, () => {
  const registrations = getRegistrations();
  afterEach(() => {
    delete registrations.testAction;
  });

  it('should register integrations', () => {
    window.ampTestRuntimeConfig.adTypes.forEach((adType) => {
      expect(
        registrations,
        `Missing registration for [${adType}]`
      ).to.contain.key(adType);
    });
  });

  it('should not throw validateParentOrigin without ancestorOrigins', () => {
    let parent = {};
    validateParentOrigin(
      {
        location: {},
      },
      parent
    );

    parent = {};
    validateParentOrigin(
      {
        location: {
          ancestorOrigins: [],
        },
      },
      parent
    );
  });

  it('should validateParentOrigin with correct ancestorOrigins', () => {
    const parent = {
      origin: 'abc',
    };
    validateParentOrigin(
      {
        location: {
          ancestorOrigins: ['abc', 'xyz'],
        },
      },
      parent
    );
  });

  it('should throw in validateParentOrigin with incorrect ancestorOrigins', () => {
    const parent = {
      origin: 'abc',
    };

    allowConsoleError(() => {
      expect(() => {
        validateParentOrigin(
          {
            location: {
              ancestorOrigins: ['xyz'],
            },
          },
          parent
        );
      }).to.throw(/Parent origin mismatch/);
    });
  });

  it('should parse JSON from fragment unencoded (most browsers)', () => {
    const unencoded =
      '#{"tweetid":"638793490521001985","width":390,' +
      '"height":50,' +
      '"type":"twitter","_context":{"referrer":"http://localhost:8000/' +
      'examples/","canonicalUrl":"http://localhost:8000/' +
      'examples/amps.html","location":{"href":"http://' +
      'localhost:8000/examples/twitter.amp.html"},' +
      '"mode":{"localDev":true,"development":false,"minified":false}}}';
    const data = parseFragment(unencoded);
    expect(data).to.be.an('object');
    expect(data.tweetid).to.equal('638793490521001985');
    expect(data._context.location.href).to.equal(
      'http://localhost:8000/examples/twitter.amp.html'
    );
  });

  it('should parse JSON from fragment encoded (Firefox)', () => {
    const encoded =
      '#{%22tweetid%22:%22638793490521001985%22,%22width' +
      '%22:390,%22height%22:50,%22initialWindowWidth%22:1290,%22initial' +
      'WindowHeight%22:165,%22type%22:%22twitter%22,%22_context%22:{%22' +
      'referrer%22:%22http://localhost:8000/examples/%22,%22canoni' +
      'calUrl%22:%22http://localhost:8000/examples/amps.html%22,%22' +
      'location%22:{%22href%22:%22http://localhost:8000/examples/t' +
      'witter.amp.html%22},%22mode%22:{%22localDev%22:true,%22develop' +
      'ment%22:false,%22minified%22:false}}}';
    const data = parseFragment(encoded);
    expect(data).to.be.an('object');
    expect(data.tweetid).to.equal('638793490521001985');
    expect(data._context.location.href).to.equal(
      'http://localhost:8000/examples/twitter.amp.html'
    );
  });

  it('should be ok with empty fragment', () => {
    expect(parseFragment('')).to.be.empty;
    expect(parseFragment('#')).to.be.empty;
  });

  it('should call the right action based on type', () => {
    const data = {
      type: 'testAction',
    };
    const win = {
      context: {
        location: {
          originValidated: true,
        },
        data,
      },
    };
    let called = false;
    register('testAction', function (myWin, myData) {
      called = true;
      expect(myWin).to.equal(win);
      expect(myData).to.equal(myData);
    });
    expect(called).to.be.false;
    draw3pInternal(win, data);
    expect(called).to.be.true;
  });

  it('should support config processing in draw3pInternal', () => {
    const data = {
      type: 'testAction2',
    };
    const win = {
      context: {
        location: {
          originValidated: true,
        },
        data,
      },
    };
    let called = false;
    register('testAction2', function (myWin, myData) {
      expect(called).to.be.false;
      called = true;
      expect(myWin).to.equal(win);
      expect(myData).to.not.equal(data);
      expect(myData).to.have.property('custom');
    });
    expect(called).to.be.false;
    let finish;
    draw3pInternal(win, data, (_config, done) => {
      finish = () => {
        done({
          custom: true,
        });
      };
    });
    expect(called).to.be.false;
    finish();
    expect(called).to.be.true;
  });

  it('should throw if origin was never validated', () => {
    const data = {
      type: 'testAction',
    };
    const win = {
      context: {
        location: {
          originValidated: true,
        },
        data,
        tagName: 'AMP-EMBED',
      },
    };
    allowConsoleError(() => {
      expect(() => {
        draw3pInternal(win, data);
      }).to.throw(/Embed type testAction not allowed with tag AMP-EMBED/);
    });
  });

  it('should allow all types on localhost', () => {
    const localhost = {
      location: {
        hostname: 'ads.localhost',
      },
    };
    validateAllowedTypes(localhost, 'twitter');
    validateAllowedTypes(localhost, 'facebook');
    validateAllowedTypes(localhost, 'a9');
    validateAllowedTypes(localhost, 'not present');
  });

  it('should allow all types on default host', () => {
    const defaultHost = {
      location: {
        hostname: '3p.ampproject.net',
      },
    };
    validateAllowedTypes(defaultHost, 'twitter');
    validateAllowedTypes(defaultHost, 'facebook');
    validateAllowedTypes(defaultHost, 'a9');
    validateAllowedTypes(defaultHost, 'not present');
  });

  it('should allow all types on unique default host', () => {
    function get(domain) {
      return {
        location: {
          hostname: domain,
        },
      };
    }
    validateAllowedTypes(get('d-123.ampproject.net'), 'twitter');
    validateAllowedTypes(get('d-46851196780996873.ampproject.net'), 'adtech');
    validateAllowedTypes(get('d-46851196780996873.ampproject.net'), 'a9');
    allowConsoleError(() => {
      expect(() => {
        validateAllowedTypes(get('d-124.ampproject.net.com'), 'not present');
      }).to.throw(/3p type for custom iframe not allowed/);
    });
  });

  it('should validate types on custom host', () => {
    const defaultHost = {
      location: {
        hostname: 'other.com',
      },
    };
    validateAllowedTypes(defaultHost, 'twitter');
    validateAllowedTypes(defaultHost, 'facebook');
    validateAllowedTypes(defaultHost, 'doubleclick');
    allowConsoleError(() => {
      expect(() => {
        validateAllowedTypes(defaultHost, 'not present');
      }).to.throw(/3p type for custom iframe not allowed/);
    });
    allowConsoleError(() => {
      expect(() => {
        validateAllowedTypes(defaultHost, 'adtech');
      }).to.throw(/3p type for custom iframe not allowed/);
    });
    validateAllowedTypes(defaultHost, 'adtech', ['adtech']);
  });

  it('should ensure the 3p frame is actually framed', () => {
    ensureFramed(window); // Test window is always framed.
    ensureFramed({
      parent: 'other',
    });
    const win = {
      location: {
        href: 'sentinel',
      },
    };
    win.parent = win;
    expect(() => {
      ensureFramed(win);
    }).to.throw(/Must be framed: sentinel/);
  });

  it('should validateAllowedEmbeddingOrigins: non-cache', () => {
    const win = {
      document: {
        referrer: 'https://should-be-ignored',
      },
      location: {
        ancestorOrigins: ['https://www.foo.com'],
      },
    };
    function invalid(fn) {
      expect(fn).to.throw(/Invalid embedding hostname/);
    }
    validateAllowedEmbeddingOrigins(win, ['foo.com']);
    validateAllowedEmbeddingOrigins(win, ['foo.net', 'foo.com']);
    validateAllowedEmbeddingOrigins(win, ['www.foo.com']);
    invalid(() => validateAllowedEmbeddingOrigins(win, ['bar.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['amp.www.foo.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['ampwww.foo.com']));
  });

  it('should validateAllowedEmbeddingOrigins: cache', () => {
    const win = {
      location: {
        ancestorOrigins: ['https://cdn.ampproject.org'],
      },
      document: {
        referrer: 'https://cdn.ampproject.org/c/www.foo.com/test',
      },
    };
    function invalid(fn) {
      expect(fn).to.throw(/Invalid embedding hostname/);
    }
    validateAllowedEmbeddingOrigins(win, ['foo.com']);
    validateAllowedEmbeddingOrigins(win, ['www.foo.com']);
    invalid(() => validateAllowedEmbeddingOrigins(win, ['bar.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['amp.www.foo.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['ampwww.foo.com']));
    win.document.referrer = 'https://cdn.ampproject.net/c/www.foo.com/test';
    invalid(() => validateAllowedEmbeddingOrigins(win, ['foo.com']));
  });

  it('should validateAllowedEmbeddingOrigins: referrer non-cache', () => {
    const win = {
      location: {},
      document: {
        referrer: 'https://www.foo.com/test',
      },
    };
    function invalid(fn) {
      expect(fn).to.throw(/Invalid embedding hostname/);
    }
    validateAllowedEmbeddingOrigins(win, ['foo.com']);
    validateAllowedEmbeddingOrigins(win, ['www.foo.com']);
    invalid(() => validateAllowedEmbeddingOrigins(win, ['bar.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['amp.www.foo.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['ampwww.foo.com']));
  });

  it('should validateAllowedEmbeddingOrigins: referrer cache', () => {
    const win = {
      location: {},
      document: {
        referrer: 'https://cdn.ampproject.org/c/www.foo.com/test',
      },
    };
    function invalid(fn) {
      expect(fn).to.throw(/Invalid embedding hostname/);
    }
    validateAllowedEmbeddingOrigins(win, ['foo.com']);
    validateAllowedEmbeddingOrigins(win, ['www.foo.com']);
    invalid(() => validateAllowedEmbeddingOrigins(win, ['bar.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['amp.www.foo.com']));
    invalid(() => validateAllowedEmbeddingOrigins(win, ['ampwww.foo.com']));
    win.document.referrer = 'https://cdn.ampproject.net/c/www.foo.com/test';
    invalid(() => validateAllowedEmbeddingOrigins(win, ['foo.com']));
  });
});