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

test/unit/test-video-iframe-integration.js
316 строк9 KB
Shihua Zheng
Fix videojs amp-video-iframe intergration on ios (#39894)
14 мар 2024, 02:16
14 мар 2024, 02:16dad25b2
import {
  AmpVideoIntegration,
  adopt,
  getVideoJs,
} from '../../src/video-iframe-integration';

const NOOP = () => {};

describes.realWin('video-iframe-integration', {amp: false}, (env) => {
  function pushToGlobal(global, callback) {
    (global.AmpVideoIframe = global.AmpVideoIframe || []).push(callback);
  }

  function expectCalledWithAmpVideoIntegration(spy) {
    expect(spy.withArgs(env.sandbox.match({isAmpVideoIntegration_: true}))).to
      .have.been.calledOnce;
  }

  describe('adopt(win)', () => {
    describe('<script async> support', () => {
      it('should execute callbacks pushed before adoption', () => {
        const global = {};
        const callback = env.sandbox.spy();
        pushToGlobal(global, callback);
        adopt(global);
        expectCalledWithAmpVideoIntegration(callback);
      });

      it('should execute callbacks pushed after adoption', () => {
        const global = {};
        adopt(global);
        const callback = env.sandbox.spy();
        pushToGlobal(global, callback);
        expectCalledWithAmpVideoIntegration(callback);
      });
    });
  });

  describe('AmpVideoIntegration', () => {
    describe('#getMetadata', () => {
      it('gets metadata from window name', () => {
        const metadata = {
          canonicalUrl: 'foo.html',
          sourceUrl: 'bar.html',
        };

        const win = {name: JSON.stringify(metadata)};
        const integration = new AmpVideoIntegration(win);

        // Sinon does not support env.sandbox.match on to.equal
        const dummySpy = env.sandbox.spy();

        dummySpy(integration.getMetadata());

        expect(dummySpy.withArgs(env.sandbox.match(metadata))).to.have.been
          .calledOnce;
      });
    });

    describe('#method', () => {
      it('should execute on message', () => {
        const integration = new AmpVideoIntegration();

        const listenToOnce = env.sandbox.stub(integration, 'listenToOnce_');

        const validMethods = [
          'pause',
          'play',
          'mute',
          'unmute',
          'fullscreenenter',
          'fullscreenexit',
          'showcontrols',
          'hidecontrols',
        ];

        validMethods.forEach((method) => {
          const spy = env.sandbox.spy();
          integration.method(method, spy);
          integration.onMessage_({event: 'method', method});
          expect(spy).to.have.been.calledOnce;
        });

        expect(listenToOnce.callCount).to.equal(validMethods.length);
      });

      it('should reject invalid methods', () => {
        const integration = new AmpVideoIntegration();

        const listenToOnce = env.sandbox.stub(integration, 'listenToOnce_');

        const invalidMethods = 'tacos al pastor'.split(' ');

        invalidMethods.forEach((method) => {
          const spy = env.sandbox.spy();
          expect(() => integration.method(method, spy)).to.throw(
            /Invalid method/
          );
        });

        expect(listenToOnce).to.not.have.been.called;
      });
    });

    describe('#postEvent', () => {
      it('should post any event', () => {
        const integration = new AmpVideoIntegration();

        const postToParent = env.sandbox.stub(integration, 'postToParent_');

        const events = [
          'canplay',
          'load',
          'playing',
          'pause',
          'ended',
          'muted',
          'unmuted',
          'tacos',
          'al',
          'pastor',
        ];

        for (let i = 0; i < events.length; i++) {
          const event = events[i];
          integration.postEvent(event);
          expect(postToParent.withArgs(env.sandbox.match({event}))).to.have.been
            .calledOnce;
        }
      });
    });

    describe('get async value from host document', () => {
      let integration;
      let postToParent;
      let callback;

      beforeEach(() => {
        integration = new AmpVideoIntegration();
        postToParent = env.sandbox.spy(integration, 'postToParent_');
        callback = env.sandbox.spy();

        integration.listenToOnce_ = env.sandbox.spy();
      });

      it('getIntersection should request and receive intersection', () => {
        const id = integration.getFromHostForTesting_(
          'getIntersection',
          callback
        );

        expect(
          postToParent.withArgs(env.sandbox.match({method: 'getIntersection'}))
        ).to.have.been.calledOnce;

        expect(integration.listenToOnce_).to.have.been.calledOnce;

        const response = {tacos: 'al pastor'};
        integration.onMessage_({id, args: response});
        expect(callback.withArgs(response)).to.have.been.calledOnce;
      });

      it('getConsentData should request and receive consent data', () => {
        const id = integration.getFromHostForTesting_(
          'getConsentData',
          callback
        );

        expect(
          postToParent.withArgs(env.sandbox.match({method: 'getConsentData'}))
        ).to.have.been.calledOnce;

        expect(integration.listenToOnce_).to.have.been.calledOnce;

        const response = {tacos: 'al pastor'};
        integration.onMessage_({id, args: response});
        expect(callback.withArgs(response)).to.have.been.calledOnce;
      });
    });

    describe('#listenTo', () => {
      describe('jwplayer', () => {
        it('registers all events and methods', () => {
          const player = {
            on: env.sandbox.spy(),
            play: env.sandbox.spy(),
            pause: env.sandbox.spy(),
            setMuted: env.sandbox.spy(),
            setControls: env.sandbox.spy(),
            setFullscreen: env.sandbox.spy(),
          };

          const expectedEvents = [
            'error',
            'setupError',
            'adSkipped',
            'adComplete',
            'adError',
            'adStarted',
            'play',
            'ready',
            'pause',
            'volume',
          ];

          const expectedMethods = [
            'play',
            'pause',
            'mute',
            'unmute',
            'showcontrols',
            'hidecontrols',
            'fullscreenenter',
            'fullscreenexit',
          ];

          const integration = new AmpVideoIntegration();
          const listenToOnce = env.sandbox.stub(integration, 'listenToOnce_');
          const methodSpy = env.sandbox.spy(integration, 'method');

          integration.listenTo('jwplayer', player);

          expectedEvents.forEach((event) => {
            expect(player.on.withArgs(event, env.sandbox.match.any)).to.have
              .been.calledOnce;
          });

          expectedMethods.forEach((method) => {
            expect(methodSpy.withArgs(method, env.sandbox.match.any)).to.have
              .been.calledOnce;
          });

          expect(listenToOnce.callCount).to.equal(expectedMethods.length);
        });
      });

      it('uses global jwplayer() to get instance when not passed in', () => {
        const instance = {on: env.sandbox.spy()};
        env.win.jwplayer = env.sandbox.stub().returns(instance);
        new AmpVideoIntegration(env.win).listenTo('jwplayer');
        expect(instance.on).to.have.been.called;
      });

      function mockVideoJsPlayer() {
        return {
          ready(fn) {
            fn();
          },
          readyState() {
            return 0;
          },
          on: env.sandbox.spy(),
        };
      }

      describe('video.js', () => {
        it('registers all methods', () => {
          const expectedMethods = [
            'play',
            'pause',
            'mute',
            'unmute',
            'showcontrols',
            'hidecontrols',
            'fullscreenenter',
            'fullscreenexit',
          ];

          const player = mockVideoJsPlayer();

          const integration = new AmpVideoIntegration(env.win);

          const listenToOnce = env.sandbox.stub(integration, 'listenToOnce_');
          const methodSpy = env.sandbox.spy(integration, 'method');
          const dummyElement = env.win.document.createElement('video');

          integration.listenTo(
            'videojs',
            dummyElement,
            /* initializer */ () => player
          );

          expectedMethods.forEach((method) => {
            expect(methodSpy.withArgs(method, env.sandbox.match.any)).to.have
              .been.calledOnce;
          });

          expect(listenToOnce.callCount).to.equal(expectedMethods.length);
        });

        describe('getVideoJs', () => {
          it('returns window global if no initializer provided', () => {
            const initializer = NOOP;
            const win = {
              videojs: initializer,
            };
            expect(getVideoJs(win).toString()).to.equal(initializer.toString());
          });

          it('returns initializer if provided', () => {
            const win = {};
            const initializer = NOOP;
            expect(getVideoJs(win, initializer).toString()).to.equal(
              initializer.toString()
            );
          });

          it('fails if no initializer provided or Video.JS not present', () => {
            const win = {};
            expect(() => getVideoJs(win)).to.throw();
          });
        });
      });
    });
  });
});