test/unit/utils/test-xhr-utils.js - main - githubmirror/amphtml

test/unit/utils/test-xhr-utils.js
196 строк6 KB
Alan Orozco
🚮 Remove `dict()` (#37383)
14 янв 2022, 21:45
14 янв 2022, 21:4542c3b1d
import {Services} from '#service';

import {
  getViewerInterceptResponse,
  setupAMPCors,
  setupInit,
  setupJsonFetchInit,
} from '#utils/xhr-utils';

describes.sandboxed('utils/xhr-utils', {}, (env) => {
  describe('setupAMPCors', () => {
    it('should set AMP-Same-Origin header', () => {
      // Given a same origin request.
      const fetchInitDef = setupAMPCors(
        {origin: 'http://www.origin.org'},
        'http://www.origin.org',
        {}
      );
      // Expect proper header to be set.
      expect(fetchInitDef['headers']['AMP-Same-Origin']).to.equal('true');
    });

    it('should not set AMP-Same-Origin header', () => {
      // If not a same origin request.
      const fetchInitDef = setupAMPCors(
        {origin: 'http://www.originz.org'},
        'http://www.origin.org',
        {headers: {}}
      );
      expect(fetchInitDef['headers']['AMP-Same-Origin']).to.be.undefined;
    });
  });

  describe('setupInit', () => {
    it('should set up init', () => {
      const init = setupInit();
      expect(init).to.deep.equal({method: 'GET', headers: {}});
    });

    it('should set up init with Accept header value', () => {
      const init = setupInit(undefined, 'text/html');
      expect(init['headers']['Accept']).to.equal('text/html');
    });

    it('should handle null credentials', () => {
      allowConsoleError(() => {
        expect(() => {
          setupInit({credentials: null}, 'text/html');
        }).to.throw(/Only credentials=include\|omit support: null/);
      });
    });
  });

  describe('setupJsonFetchInit', () => {
    it('set proper properties', () => {
      expect(setupJsonFetchInit({body: {}})).to.deep.equal({
        headers: {
          'Accept': 'application/json',
        },
        body: {},
        method: 'GET',
      });

      expect(setupJsonFetchInit({body: {}, method: 'POST'})).to.deep.equal({
        headers: {
          'Accept': 'application/json',
          'Content-Type': 'text/plain;charset=utf-8',
        },
        body: '{}',
        method: 'POST',
      });
    });
  });

  describe('getViewerInterceptResponse', () => {
    let ampDocSingle, doc, init, input, viewer, viewerForDoc, win;

    beforeEach(() => {
      ampDocSingle = {
        getRootNode() {
          return {documentElement: doc};
        },
        whenFirstVisible: env.sandbox.stub().returns(Promise.resolve()),
      };
      doc = document.createElement('html');
      doc.setAttribute('allow-xhr-interception', 'true');
      init = {};
      input = 'https://sample.com';
      viewer = {
        hasCapability: (unusedParam) => true,
        isTrustedViewer: () => Promise.resolve(true),
        sendMessageAwaitResponse: env.sandbox
          .stub()
          .returns(Promise.resolve({})),
      };
      viewerForDoc = env.sandbox.stub(Services, 'viewerForDoc').returns(viewer);
      win = {
        __AMP_MODE: {
          localDev: false,
        },
        location: {
          hash: '',
        },
      };
    });

    it('should be no-op if amp doc is absent', async () => {
      ampDocSingle = null;

      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      // Expect no-op.
      expect(viewerForDoc).to.not.have.been.called;
    });

    it('should not intercept if viewer can not intercept', async () => {
      viewer.hasCapability = (unusedParam) => false;

      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      // Expect no interception.
      expect(viewer.sendMessageAwaitResponse).to.not.have.been.called;
    });

    it('should not intercept if request is initialized to bypass for local development', async () => {
      // Given the bypass flag and localDev being true.
      init = {
        bypassInterceptorForDev: true,
      };
      win.__AMP_MODE = {
        localDev: true,
      };

      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      // Expect no interception.
      expect(viewer.sendMessageAwaitResponse).to.not.have.been.called;
    });

    it('should not intercept if amp doc does not support xhr interception', async () => {
      doc.removeAttribute('allow-xhr-interception');

      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      // Expect no interception.
      expect(viewer.sendMessageAwaitResponse).to.not.have.been.called;
    });

    it('should not intercept if URL is known as a proxy URL', async () => {
      input = 'https://cdn.ampproject.org';

      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      // Expect no interception.
      expect(viewer.sendMessageAwaitResponse).to.not.have.been.called;
    });

    it('should send xhr request to viewer', async () => {
      init = {
        body: {},
      };
      input = 'https://www.shouldsendxhrrequesttoviewer.org';

      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      const msgPayload = {
        'originalRequest': {
          'input': 'https://www.shouldsendxhrrequesttoviewer.org',
          'init': {
            'body': {},
          },
        },
      };
      expect(viewer.sendMessageAwaitResponse).to.have.been.calledOnceWith(
        'xhr',
        msgPayload
      );
    });

    it('should wait for visibility', async () => {
      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      expect(ampDocSingle.whenFirstVisible).to.have.been.calledOnce;
    });

    it('should not wait for visibility if prerenderSafe', async () => {
      init = {
        prerenderSafe: true,
      };

      await getViewerInterceptResponse(win, ampDocSingle, input, init);

      expect(ampDocSingle.whenFirstVisible).to.not.have.been.called;
    });
  });
});