habitica/test/api/v4/faq/GET-faq.test.js

import {
  requester,
  translate,
} from '../../../helpers/api-integration/v4';
import i18n from '../../../../website/common/script/i18n';

describe('GET /faq', () => {
  describe('language parameter', () => {
    it('returns faq (and does not require authentication)', async () => {
      const res = await requester().get('/faq');

      expect(res).to.have.property('stillNeedHelp');
      expect(res.stillNeedHelp.ios).to.equal(translate('iosFaqStillNeedHelp'));
      expect(res).to.have.property('questions');
      expect(res.questions[0].question).to.equal(translate('faqQuestion0'));
    });

    it('returns faq not in English', async () => {
      const res = await requester().get('/faq?language=de');
      expect(res).to.have.nested.property('stillNeedHelp.ios');
      expect(res.stillNeedHelp.ios).to.equal(i18n.t('iosFaqStillNeedHelp', 'de'));
    });

    it('falls back to English if the desired language is not found', async () => {
      const res = await requester().get('/faq?language=wrong');
      expect(res).to.have.nested.property('stillNeedHelp.ios');
      expect(res.stillNeedHelp.ios).to.equal(translate('iosFaqStillNeedHelp'));
    });
  });

  describe('platform parameter', () => {
    it('returns faq with answers for ios platform only', async () => {
      const res = await requester().get('/faq?platform=ios');

      expect(res).to.have.property('stillNeedHelp');
      expect(res.stillNeedHelp).to.eql({ ios: translate('iosFaqStillNeedHelp') });

      expect(res).to.have.property('questions');
      expect(res.questions[0]).to.eql({
        question: translate('faqQuestion0'),
        ios: translate('iosFaqAnswer0'),
      });
    });
    it('returns an error when invalid platform parameter is specified', async () => {
      const request = requester().get('/faq?platform=wrong');
      await expect(request)
        .to.eventually.be.rejected.and.eql({
          code: 400,
          error: 'BadRequest',
          message: i18n.t('invalidReqParams'),
        });
    });
    it('falls back to "web" description if there is no description for specified platform', async () => {
      const res = await requester().get('/faq?platform=android');
      expect(res).to.have.property('stillNeedHelp');
      expect(res.stillNeedHelp).to.eql({ web: translate('webFaqStillNeedHelp') });

      expect(res).to.have.property('questions');
      expect(res.questions[0]).to.eql({
        question: translate('faqQuestion0'),
        android: translate('androidFaqAnswer0'),
      });
    });
  });
});