weseek__growi/apps/app/test/integration/service/questionnaire.test.ts

import mongoose from 'mongoose';

import { StatusType } from '../../../src/features/questionnaire/interfaces/questionnaire-answer-status';
import QuestionnaireAnswerStatus from '../../../src/features/questionnaire/server/models/questionnaire-answer-status';
import QuestionnaireOrder from '../../../src/features/questionnaire/server/models/questionnaire-order';
import { getInstance } from '../setup-crowi';

describe('QuestionnaireService', () => {
  let crowi;
  let user;

  beforeAll(async() => {
    process.env.APP_SITE_URL = 'http://growi.test.jp';
    process.env.DEPLOYMENT_TYPE = 'growi-docker-compose';
    process.env.SAML_ENABLED = 'true';
    crowi = await getInstance();

    crowi.configManager.updateConfigs({
      'security:passport-saml:isEnabled': true,
      'security:passport-github:isEnabled': true,
    });

    await mongoose.model('Config').create({
      key: 'app:installed',
      value: true,
      createdAt: '2000-01-01',
    });

    crowi.setupQuestionnaireService();

    const User = crowi.model('User');
    user = await User.create({
      name: 'Example for Questionnaire Service Test',
      username: 'questionnaire test user',
      email: 'questionnaireTestUser@example.com',
      password: 'usertestpass',
      createdAt: '2000-01-01',
    });
  });

  describe('getGrowiInfo', () => {
    test('Should get correct GROWI info', async() => {
      const growiInfo = await crowi.questionnaireService.getGrowiInfo();

      expect(growiInfo.appSiteUrlHashed).toBeTruthy();
      expect(growiInfo.appSiteUrlHashed).not.toBe('http://growi.test.jp');
      expect(growiInfo.osInfo.type).toBeTruthy();
      expect(growiInfo.osInfo.platform).toBeTruthy();
      expect(growiInfo.osInfo.arch).toBeTruthy();
      expect(growiInfo.osInfo.totalmem).toBeTruthy();

      delete growiInfo.appSiteUrlHashed;
      delete growiInfo.currentActiveUsersCount;
      delete growiInfo.currentUsersCount;
      delete growiInfo.osInfo;

      expect(growiInfo).toEqual({
        activeExternalAccountTypes: ['saml', 'github'],
        appSiteUrl: 'http://growi.test.jp',
        installedAt: new Date('2000-01-01'),
        installedAtByOldestUser: new Date('2000-01-01'),
        attachmentType: 'aws',
        deploymentType: 'growi-docker-compose',
        type: 'on-premise',
        version: crowi.version,
        wikiType: 'closed',
      });
    });

    describe('When url hash settings is on', () => {
      beforeEach(async() => {
        process.env.QUESTIONNAIRE_IS_APP_SITE_URL_HASHED = 'true';
        await crowi.setupConfigManager();
      });

      test('Should return app url string', async() => {
        const growiInfo = await crowi.questionnaireService.getGrowiInfo();
        expect(growiInfo.appSiteUrl).toBe(null);
        expect(growiInfo.appSiteUrlHashed).not.toBe('http://growi.test.jp');
        expect(growiInfo.appSiteUrlHashed).toBeTruthy();
      });
    });
  });

  describe('getUserInfo', () => {
    test('Should get correct user info when user given', () => {
      const userInfo = crowi.questionnaireService.getUserInfo(user, 'growiurlhashfortest');
      expect(userInfo.userIdHash).toBeTruthy();
      expect(userInfo.userIdHash).not.toBe(user._id);

      delete userInfo.userIdHash;

      expect(userInfo).toEqual({ type: 'general', userCreatedAt: new Date('2000-01-01') });
    });

    test('Should get correct user info when user is null', () => {
      const userInfo = crowi.questionnaireService.getUserInfo(null, '');
      expect(userInfo).toEqual({ type: 'guest' });
    });
  });

  describe('getQuestionnaireOrdersToShow', () => {
    beforeAll(async() => {
      const questionnaireToBeShown = {
        _id: '63b8354837e7aa378e16f0b1',
        shortTitle: {
          ja_JP: 'GROWI に関するアンケート',
          en_US: 'Questions about GROWI',
        },
        title: {
          ja_JP: 'GROWI に関するアンケート',
          en_US: 'Questions about GROWI',
        },
        showFrom: '2022-12-11',
        showUntil: '2100-12-12',
        condition: {
          user: {
            types: ['general'],
            daysSinceCreation: {
              moreThanOrEqualTo: 365,
              lessThanOrEqualTo: 365 * 1000,
            },
          },
          growi: {
            types: ['on-premise'],
            versionRegExps: [crowi.version],
          },
        },
        createdAt: '2023-01-01',
        updatedAt: '2023-01-01',
      };

      // insert initial db data
      await QuestionnaireOrder.insertMany([
        questionnaireToBeShown,
        // finished
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b2',
          showFrom: '2020-12-11',
          showUntil: '2021-12-12',
        },
        // for admin or guest
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b3',
          condition: {
            user: {
              types: ['admin', 'guest'],
            },
            growi: {
              types: ['on-premise'],
              versionRegExps: [crowi.version],
            },
          },
        },
        // answered
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b4',
        },
        // skipped
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b5',
        },
        // denied
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b6',
        },
        // for different growi type
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b7',
          condition: {
            user: {
              types: ['general'],
            },
            growi: {
              types: ['cloud'],
              versionRegExps: [crowi.version],
            },
          },
        },
        // for different growi version
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b8',
          condition: {
            user: {
              types: ['general'],
            },
            growi: {
              types: ['on-premise'],
              versionRegExps: ['1.0.0-alpha'],
            },
          },
        },
        // for users that used GROWI for less than or equal to a year
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0b9',
          condition: {
            user: {
              types: ['general'],
              daysSinceCreation: {
                lessThanOrEqualTo: 365,
              },
            },
            growi: {
              types: ['on-premise'],
              versionRegExps: [crowi.version],
            },
          },
        },
        // for users that used GROWI for more than or equal to 1000 years
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0c1',
          condition: {
            user: {
              types: ['general'],
              daysSinceCreation: {
                moreThanOrEqualTo: 365 * 1000,
              },
            },
            growi: {
              types: ['on-premise'],
              versionRegExps: [crowi.version],
            },
          },
        },
        // for users that used GROWI for more than a month and less than 6 months
        {
          ...questionnaireToBeShown,
          _id: '63b8354837e7aa378e16f0c2',
          condition: {
            user: {
              types: ['general'],
              daysSinceCreation: {
                moreThanOrEqualTo: 30,
                lessThanOrEqualTo: 30 * 6,
              },
            },
            growi: {
              types: ['on-premise'],
              versionRegExps: [crowi.version],
            },
          },
        },
      ]);

      await QuestionnaireAnswerStatus.insertMany([
        {
          user: user._id,
          questionnaireOrderId: '63b8354837e7aa378e16f0b4',
          status: StatusType.answered,
        },
        {
          user: user._id,
          questionnaireOrderId: '63b8354837e7aa378e16f0b5',
          status: StatusType.skipped,
        },
        {
          user: user._id,
          questionnaireOrderId: '63b8354837e7aa378e16f0b6',
          status: StatusType.skipped,
        },
      ]);
    });

    test('Should get questionnaire orders to show', async() => {
      const growiInfo = await crowi.questionnaireService.getGrowiInfo();
      const userInfo = crowi.questionnaireService.getUserInfo(user, growiInfo.appSiteUrlHashed);
      const questionnaireOrderDocuments = await crowi.questionnaireService.getQuestionnaireOrdersToShow(userInfo, growiInfo, user._id);
      const questionnaireOrderObjects = questionnaireOrderDocuments.map((document) => {
        const qo = document.toObject();
        delete qo.condition._id;
        return { ...qo, _id: qo._id.toString() };
      });
      expect(questionnaireOrderObjects).toEqual([
        {
          _id: '63b8354837e7aa378e16f0b1',
          __v: 0,
          shortTitle: {
            ja_JP: 'GROWI に関するアンケート',
            en_US: 'Questions about GROWI',
          },
          title: {
            ja_JP: 'GROWI に関するアンケート',
            en_US: 'Questions about GROWI',
          },
          showFrom: new Date('2022-12-11'),
          showUntil: new Date('2100-12-12'),
          questions: [],
          condition: {
            user: {
              types: ['general'],
              daysSinceCreation: {
                moreThanOrEqualTo: 365,
                lessThanOrEqualTo: 365 * 1000,
              },
            },
            growi: {
              types: ['on-premise'],
              versionRegExps: [crowi?.version],
            },
          },
          createdAt: new Date('2023-01-01'),
          updatedAt: new Date('2023-01-01'),
        },
      ]);
    });
  });
});