forest-express/test/services/apimap-sender.test.js

Official package for all Forest Express Lianas

const { init, inject } = require('@forestadmin/context');
const ApimapSender = require('../../src/services/apimap-sender');

describe('services > apimap-sender', () => {
  const setupTest = () => {
    const superagentRequestThenResult = Symbol('superagentRequestThenResult');
    const superagentRequestThenFunction = jest.fn(
      (callback) => callback(superagentRequestThenResult),
    );
    init((context) => context
      .addInstance('logger', () => ({ warn: jest.fn(), error: jest.fn() }))
      .addInstance('superagentRequest', () => ({
        post: () => ({
          set: () => ({
            send: () => ({
              catch: () => ({
                then: superagentRequestThenFunction,
              }),
            }),
          }),
        }),
      }))
      .addUsingClass('apimapSender', () => ApimapSender));

    const { apimapSender, logger } = inject();

    return {
      apimapSender,
      logger,
      superagentRequestThenFunction,
      superagentRequestThenResult,
    };
  };

  describe('checkHash', () => {
    it('should post content then get response from forestUrl', async () => {
      const {
        apimapSender,
        superagentRequestThenFunction,
        superagentRequestThenResult,
      } = setupTest();

      const result = await apimapSender.checkHash();
      expect(superagentRequestThenFunction).toHaveBeenCalledTimes(1);
      expect(result).toBe(superagentRequestThenResult);
    });
  });

  describe('send', () => {
    it('should post content then get response from forestUrl', () => {
      const { apimapSender, superagentRequestThenFunction } = setupTest();

      apimapSender.send();
      expect(superagentRequestThenFunction).toHaveBeenCalledTimes(1);
    });
  });

  describe('handleResult', () => {
    describe('with no result provided', () => {
      it('should return early', () => {
        const { apimapSender } = setupTest();

        expect(apimapSender.handleResult()).toBeUndefined();
      });
    });

    describe('when having a 20X status', () => {
      it('should be successful silently', () => {
        expect.assertions(3);

        const { apimapSender } = setupTest();

        [200, 202, 204].forEach((status) => {
          expect(apimapSender.handleResult({ status })).toBeUndefined();
        });
      });

      it('should log warning when result contains a body.warning value', () => {
        expect.assertions(3);

        const { apimapSender, logger } = setupTest();

        [200, 202, 204].forEach((status) => {
          apimapSender.handleResult({ status, body: { warning: 'Oops' } });
          expect(logger.warn).toHaveBeenCalledWith(expect.stringMatching('Oops'));
        });
      });
    });

    it('should log a warning when having a 0 status', () => {
      const { apimapSender, logger } = setupTest();

      apimapSender.handleResult({ status: 0 });
      expect(logger.warn).toHaveBeenCalledWith('Cannot send the apimap to Forest. Are you online?');
    });

    it('should log an error when having a 404 status', () => {
      const { apimapSender, logger } = setupTest();

      apimapSender.handleResult({ status: 404 });
      expect(logger.error).toHaveBeenCalledWith('Cannot find the project related to the envSecret you configured. Can you check on Forest that you copied it properly in the Forest initialization?');
    });

    it('should log a warning when having a 503 status', () => {
      const { apimapSender, logger } = setupTest();

      apimapSender.handleResult({ status: 503 });
      expect(logger.warn).toHaveBeenCalledWith('Forest is in maintenance for a few minutes. We are upgrading your experience in the forest. We just need a few more minutes to get it right.');
    });

    it('should log an error when having an unhandled status', () => {
      const { apimapSender, logger } = setupTest();

      apimapSender.handleResult({ status: 12345 });
      expect(logger.error).toHaveBeenCalledWith('An error occured with the apimap sent to Forest. Please contact support@forestadmin.com for further investigations.');
    });
  });
});