xrilang/xiaoju-survey
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: xrilang:main
Branches Tags
xrilang:main
xrilang:develop
xrilang:feature/pause
xrilang:feature/status
xrilang:feature/peking
xrilang:feature/peking-quota
xrilang:feature/jumpLogic
xrilang:feature/server-java
xrilang:release/vuex
xrilang:feature/pinia
xrilang:feature/whitelist
xrilang:feature/logic
xrilang:feature/workflow
xrilang:release/vue2
xrilang:feature/vue3
xrilang:feature/server
xrilang:v1.2.0
xrilang:v1.1.0
xrilang:v1.0.0
..
compare: xrilang:release/vue2
Branches Tags
xrilang:main
xrilang:develop
xrilang:feature/pause
xrilang:feature/status
xrilang:feature/peking
xrilang:feature/peking-quota
xrilang:feature/jumpLogic
xrilang:feature/server-java
xrilang:release/vuex
xrilang:feature/pinia
xrilang:feature/whitelist
xrilang:feature/logic
xrilang:feature/workflow
xrilang:release/vue2
xrilang:feature/vue3
xrilang:feature/server
xrilang:v1.2.0
xrilang:v1.1.0
xrilang:v1.0.0

No commits in common. "main" and "release/vue2" have entirely different histories.
main ... release/vu

599 changed files with 17044 additions and 33874 deletions
Show Stats Expand all files Collapse all files

44
.github/workflows/codecov.yml vendored
View File

@ -1,44 +0,0 @@
# Unit Test Coverage Report
name: Test Coverage
on:
push:
branches:
- main
- releases/**
paths:
- server/**
pull_request:
branches:
- develop
- main
- releases/**
- feature/**
paths:
- server/**
workflow_dispatch:
jobs:
build:
name: Coverage
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup node
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: cd server && npm install
- name: Run tests and collect coverage
run: cd server && npm run test:cov
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4
env:
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

39
.github/workflows/server-lint.yml vendored
View File

@ -1,39 +0,0 @@
# Lint
name: Server Lint
on:
push:
branches:
- main
- releases/**
paths:
- server/**
pull_request:
branches:
- develop
- main
- releases/**
- feature/**
paths:
- server/**
workflow_dispatch:
jobs:
build:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup node
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: cd server && npm install
- name: Lint
run: cd server && npm run lint

42
.github/workflows/web-lint.yml vendored
View File

@ -1,42 +0,0 @@
# Lint
name: Web Lint
on:
push:
branches:
- main
- releases/**
paths:
- web/**
pull_request:
branches:
- develop
- main
- releases/**
- feature/**
paths:
- web/**
workflow_dispatch:
jobs:
build:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup node
uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: cd web && npm install
- name: Type-Check
run: cd web && npm run type-check
- name: Lint
run: cd web && npm run lint

7
.gitignore vendored
View File

@ -25,10 +25,3 @@ pnpm-debug.log*
*.sw?
.history
components.d.ts
# 默认的上传文件夹
userUpload
exportfile
yarn.lock

133
CODE_OF_CONDUCT.md
View File

@ -1,133 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[xiaojusurvey@gmail.com](mailto:xiaojusurvey@gmail.com).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

22
DATA_COLLECTION.md
View File

@ -1,22 +0,0 @@
# Important Disclosure re：XIAOJUSURVEY Data Collection
XIAOJUSURVEY is open-source software developed and maintained by XIAOJUSURVEY Team and available at https://github.com/didi/xiaoju-survey.
We hereby state the purpose and reason for collecting data.
## Purpose of data collection
Data collected is used to help improve XIAOJUSURVEY for all users. It is important that our team understands the usage patterns as soon as possible, so we can best decide how to design future features and prioritize current work.
## Types of data collected
XIAOJUSURVEY just collects data about version's information. The data collected is subsequently reported to the XIAOJUSURVEY's backend services.
All data collected will be used exclusively by the XIAOJUSURVEY team for analytical purposes only. The data will be neither accessible nor sold to any third party.
## Sensitive data
XIAOJUSURVEY will never collect and/or report sensitive information, such as private keys, API keys, or passwords.
## How do I opt-in to or opt-out of data sharing?
See [docs](https://xiaojusurvey.didi.cn/docs/next/community/%E6%95%B0%E6%8D%AE%E4%B8%8A%E6%8A%A5%E5%A3%B0%E6%98%8E) for information on configuring this functionality.

18
Dockerfile
View File

@ -1,5 +1,5 @@
# 镜像集成
FROM node:18-slim
FROM node:16
# 设置工作区间
WORKDIR /xiaoju-survey
@ -7,21 +7,17 @@ WORKDIR /xiaoju-survey
# 复制文件到工作区间
COPY . /xiaoju-survey
# 安装nginx
RUN apt-get update && apt-get install -y nginx
RUN npm config set registry https://registry.npmjs.org/
# 安装项目依赖
RUN cd /xiaoju-survey/web && npm install && npm run build-only
# 覆盖nginx配置文件
COPY ./nginx/nginx.conf /etc/nginx/nginx.conf
RUN cd /xiaoju-survey/web && npm install && npm run build
# 用了后端服务代理启动，建议使用nginx启动
RUN cd /xiaoju-survey && cp -af ./web/dist/* ./server/public/
RUN cd /xiaoju-survey/server && npm install && npm run build
# 暴露端口 需要跟nginx的port一致
EXPOSE 80
# 暴露端口 需要跟server的port一致
EXPOSE 3000
# docker入口文件,启动nginx和运行pm2启动,并保证监听不断
# docker入口文件,运行pm2启动,并保证监听不断
CMD ["sh","docker-run.sh"]

173
README.md
View File

@ -3,95 +3,69 @@
<img src="https://img-hxy021.didistatic.com/static/starimg/img/j8lBA6yy201698840712358.jpg" width="300" align='center' />
</p>
<div>
<a href="https://github.com/didi/xiaoju-survey/graphs/contributors">
<img src="https://img.shields.io/badge/node-%3E=18-green" alt="commit">
</a>
<a href="https://app.codecov.io/github/didi/xiaoju-survey">
<img src="https://img.shields.io/codecov/c/github/didi/xiaoju-survey" alt="codecov">
</a>
<a href="https://github.com/didi/xiaoju-survey/issues">
<img src="https://img.shields.io/github/issues/didi/xiaoju-survey" alt="issues">
</a>
<a href="https://github.com/didi/xiaoju-survey/graphs/contributors">
<img src="https://img.shields.io/github/last-commit/didi/xiaoju-survey?color=red" alt="commit">
</a>
<a href="https://github.com/didi/xiaoju-survey/pulls">
<img src="https://img.shields.io/badge/PRs-welcome-%23ffa600" alt="pr">
</a>
<a href="https://xiaojusurvey.didi.cn">
<img src="https://img.shields.io/badge/help-%E5%AE%98%E7%BD%91-blue" alt="docs">
<a href="https://github.com/didi/xiaoju-survey/issues">
<img src="https://img.shields.io/github/issues/didi/xiaoju-survey" alt="issues">
</a>
<a href="https://github.com/didi/xiaoju-survey/blob/main/README_EN.md">
<img src="https://img.shields.io/badge/help-README_EN-50c62a" alt="docs">
<a href="https://github.com/didi/xiaoju-survey/discussions">
<img src="https://img.shields.io/badge/Discussions-%E8%AE%A8%E8%AE%BA-blue" alt="discussions-">
</a>
<a href="https://xiaojusurvey.didi.cn">
<img src="https://img.shields.io/badge/help-%E6%96%87%E6%A1%A3-blue" alt="docs">
</a>
</div>
</div>
<br />
&ensp;&ensp;**XIAOJUSURVEY**是一套轻量、安全的调研系统，提供面向个人和企业的一站式产品级解决方案，用于构建各类问卷、考试、测评和复杂表单，快速满足各类线上调研场景。
&ensp;&ensp;**XIAOJUSURVEY**是一套轻量、安全的**问卷系统**，提供面向个人和企业的一站式产品级解决方案，快速满足各类线上调研场景。
&ensp;&ensp;内部系统已沉淀 40+种题型，累积精选模板 100+，适用于市场调研、客户满意度调研、在线考试、投票、报道、测评等众多场景。数据能力上，经过上亿量级打磨，沉淀了分题统计、交叉分析、多渠道分析等在线报表能力，快速满足专业化分析。
&ensp;&ensp;系统已沉淀40+种题型，累积精选模板100+，适用于市场调研、客户满意度调研、在线考试、投票、报道、测评等众多场景。数据能力上，经过上亿量级打磨，沉淀了分题统计、交叉分析、多渠道分析等在线报表能力，快速满足专业化分析。
# 功能特性
# 简介
本次开源主要围绕问卷生命周期提供了完整的产品化能力：
**🌈 易用**
- 问卷管理：创、编、投、收、数据分析
- 多类型数据采集，轻松创建调研表单：文本输入、数据选择、评分、投票、文件上传等。
- 多样化题型：单行输入框、多行输入框、单项选择、多项选择、判断题、评分、投票
- 智能逻辑编排，设计多规则动态表单：显示逻辑、跳转逻辑、选项引用、题目引用等。
_(更多题型将陆续开放。快速[自定义题型](https://xiaojusurvey.didi.cn/docs/next/document/%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C/%E9%A2%98%E5%9E%8B%E6%89%A9%E5%B1%95))_
- 精细权限管理，支持高效团队协同：空间管理、多角色权限管理等。
- 用户管理：登录、注册、权限管理
- 数据在线分析和导出，洞察调研结果：数据导出、回收数据管理、分题统计、交叉分析等。
- 数据安全：传输加密、脱敏等
**🎨 好看**
- 主题自由定制，适配您的品牌：自定义颜色、背景、图片、Logo、结果页规则等。
- 无缝嵌入各终端，满足不同场景需求：多端嵌入式小问卷 SDK。
**🚀 安全、可扩展**
- 安全能力可扩展，提供安全相关建设的经验指导：传输加密、敏感词库、发布审查等。
- 自定义 Hook 配置，轻松集成多方系统与各类工具：数据推送集成、消息推送集成等。
> 查阅[官方Feature](https://github.com/didi/xiaoju-survey/issues/45)
<img src="https://github.com/didi/xiaoju-survey/assets/16012672/dd427471-368d-49d9-bc44-13c34d84e3be" width="700" />
1、 **全部功能**请查看 [功能介绍](https://xiaojusurvey.didi.cn/docs/next/document/%E4%BA%A7%E5%93%81%E6%89%8B%E5%86%8C/%E5%8A%9F%E8%83%BD%E4%BB%8B%E7%BB%8D/%E5%9F%BA%E7%A1%80%E6%B5%81%E7%A8%8B)。
2、**企业**和**个人**均可快速构建特定领域的调研类解决方案。
_**(个人和企业用户均可快速构建特定领域的调研类解决方案。)**_
# 技术
Web端：Vue2（Vue3版本24年上半年推出）+ ElementUI
**1、Web 端：Vue3 + ElementPlus**
Server端：Nestjs + MongoDB
&ensp;&ensp;C 端多端渲染：ReactNative SDK 建设中
架构：[架构解读](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E6%9E%B6%E6%9E%84)
**2、Server 端：NestJS + MongoDB**
&ensp;&ensp;Java 版：建设中，[欢迎加入共建](https://github.com/didi/xiaoju-survey/issues/306)
**3、能力增强**
&ensp;&ensp;在线平台：建设中、智能化问卷：规划中
# 项目优势
**一、具备全面的综合性和专业性**
- [制定了问卷标准化协议规范](https://xiaojusurvey.didi.cn/docs/next/agreement/%E3%80%8A%E9%97%AE%E5%8D%B7Meta%E5%8D%8F%E8%AE%AE%E3%80%8B)
领域标准保障概念互通，是全系统的基础和核心。基于实际业务经验，沉淀了两大类：
- 业务描述：问卷协议、题型协议
- 物料描述：题型物料协议，包含题型和设置器
- [制定了问卷 UI/UX 规范](https://xiaojusurvey.didi.cn/docs/next/design/%E3%80%8A%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83%E3%80%8B)
- [制定了问卷UI/UX规范](https://xiaojusurvey.didi.cn/docs/next/design/%E3%80%8A%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83%E3%80%8B)
设计语言是系统灵活性、一致性的基石，保障系统支撑的实际业务运转拥有极高的用户体验。包含两部分：
- 设计规范：灵活、降噪、统一
- 交互规范：遵循用户行为特征，遵循产品定位，遵循成熟的用户习惯
@ -102,14 +76,13 @@
- [题型物料化设计，自由定制扩展](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E9%A2%98%E5%9E%8B%E7%89%A9%E6%96%99%E5%8C%96%E8%AE%BE%E8%AE%A1/%E5%9F%BA%E7%A1%80%E8%AE%BE%E8%AE%A1)
题型是问卷最核心的组成部分，而题型可配置化能力决定了上层业务可扩展的场景以及系统自身可复用的场景。
题型架构设计上，主打每一类题型拥有通用基础能力，每一种题型拥有原子化特性能力，并保障高度定制化。
题型架构设计上，主打每一类题型拥有通用基础能力，每一种题型拥有原子化特性能力，并保障高度定制化。
- [合规建设沉淀积累，安全能力拓展性高](https://xiaojusurvey.didi.cn/docs/next/document/%E5%AE%89%E5%85%A8%E8%AE%BE%E8%AE%A1/%E6%A6%82%E8%BF%B0)
数据加密传输、敏感信息精细化检测、投票防刷等能力，保障问卷发布、数据回收链路安全性。
**二、轻量化设计，快速接入、灵活扩展**
- [产品级开源方案，快速产出一套调研流程](https://xiaojusurvey.didi.cn/docs/next/document/%E4%BA%A7%E5%93%81%E6%89%8B%E5%86%8C/%E6%A6%82%E8%BF%B0)
围绕问卷生命周期提供了完整的产品化能力，包含用户管理: 登录、注册、问卷权限，问卷管理: 创、编、投、收、数据分析，可快速构建特定领域的调研类解决方案。
@ -124,54 +97,106 @@
- [部署成本低，快速上线](https://xiaojusurvey.didi.cn/docs/next/document/%E5%B7%A5%E7%A8%8B%E9%83%A8%E7%BD%B2/Docker%E9%83%A8%E7%BD%B2)
前后端分离，提供 Docker 化方案，提供了完善的部署指导手册。
前后端分离，提供Docker化方案，提供了完善的部署指导手册。
# 快速使用
# 快速启动
_（在线平台建设中）_
Node版本 >= 16.x，
[查看环境准备指导](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)
# 本地开发
复制工程
```shell
git clone git@github.com:didi/xiaoju-survey.git
```
请查看 [本地安装手册](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B) 来启动项目。
## 服务端启动
# 快速部署
### 方案一、快速启动，无需安装数据库
> _便于快速预览工程，对于正式项目需要使用方案二。_
### 服务部署
#### 1、安装依赖
```shell
cd server
npm install
```
请查看 [快速部署指导](https://xiaojusurvey.didi.cn/docs/next/document/%E5%B7%A5%E7%A8%8B%E9%83%A8%E7%BD%B2/Docker%E9%83%A8%E7%BD%B2) 。
#### 2、启动
```shell
npm run local
```
### 一键部署
> 服务运行依赖 [mongodb-memory-server](https://github.com/nodkz/mongodb-memory-server)：
>
> 1、数据保存在内存中，重启服务会更新数据。<br />2、启动内存服务器新实例时，如果找不到MongoDB二进制文件会自动下载，因此首次可能需要一些时间。
_（手册编写中）_
### 方案二、(生产推荐)
<br />
#### 1、启动数据库
## Star
> 项目使用MongoDB：[MongoDB安装指导](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E5%AE%89%E8%A3%85)
开源不易，如果该项目对你有帮助，请 star 一下 ❤️❤️❤️，你的支持是我们最大的动力。
- 配置数据库，查看[MongoDB配置](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93)
[![Star History Chart](https://api.star-history.com/svg?repos=didi/xiaoju-survey&type=Date)](https://star-history.com/#didi/xiaoju-survey&Date)
- 启动本地数据库，查看[MongoDB启动](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E4%BA%94%E5%90%AF%E5%8A%A8)
## 交流群
#### 2、安装依赖
```shell
cd server
npm install
```
官方群会发布项目最新消息、建设计划和社区活动，欢迎你的加入。
#### 3、启动
```shell
npm run dev
```
## 前端启动
### 安装依赖
```shell
cd web
npm install
```
### 启动
```shell
npm run serve
```
## 访问
### 问卷管理端
[http://localhost:8080/management](http://localhost:8080)
### 问卷投放端
创建并发布问卷。
[http://localhost:8080/render/:surveyPath](http://localhost:8080/render/:surveyPath)
<br /><br />
## 微信交流群
<img src="https://img-hxy021.didistatic.com/static/starimg/img/KXKvc7sjHz1700061188156.png" width="200" />
_任何问题和合作可以联系小助手。_
## QQ交流群
## 案例
[<img src="https://img-hxy021.didistatic.com/static/starimg/img/iJUmLIHKV21700192846057.png" width="210" />](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=P61UJI_q8AzizyBLGOm-bUvzNrUnSQq-&authKey=yZFtL9biGB5yiIME3%2Bi%2Bf6XMOdTNiuf0pCIaviEEAIryySNzVy6LJ4xl7uHdEcrM&noverify=0&group_code=920623419)
## Star
开源不易，如果该项目对你有帮助，请star一下 ❤️❤️❤️，你的支持是我们最大的动力。
[![Star History Chart](https://api.star-history.com/svg?repos=didi/xiaoju-survey&type=Date)](https://star-history.com/#didi/xiaoju-survey&Date)
## 记录
如果你使用了该项目，请记录反馈：[我在使用](https://github.com/didi/xiaoju-survey/issues/64)，你的支持是我们最大的动力。
## Future Tasks
[欢迎了解项目发展和共建](https://github.com/didi/xiaoju-survey/issues/85)，你的支持是我们最大的动力。
## 贡献
如果你想成为贡献者或者扩展技术栈，请查看：[贡献者指南](https://xiaojusurvey.didi.cn/docs/next/share/%E7%94%9F%E6%80%81%E5%BB%BA%E8%AE%BE)，你的加入使我们最大的荣幸。
如果你想成为贡献者或者扩展技术栈，请查看：[贡献者指南](https://xiaojusurvey.didi.cn/docs/next/share/%E5%A6%82%E4%BD%95%E5%8F%82%E4%B8%8E%E8%B4%A1%E7%8C%AE)，你的加入使我们最大的荣幸。
## Feature
关注每周推出的建设：[官方Feature](https://github.com/didi/xiaoju-survey/issues/45)
## CHANGELOG
关注重大变更：[MAJOR CHANGELOG](https://github.com/didi/xiaoju-survey/issues/48)
关注项目重大变更：[MAJOR CHANGELOG](https://github.com/didi/xiaoju-survey/issues/48)。
## 分享
跟大家晒一晒你的分享：[文章](https://github.com/didi/xiaoju-survey/issues)

237
README_EN.md
View File

@ -1,237 +0,0 @@
<div align=center>
<p>
<img src="https://img-hxy021.didistatic.com/static/starimg/img/j8lBA6yy201698840712358.jpg" width="300" align='center' />
</p>
<div>
<a href="https://github.com/didi/xiaoju-survey/graphs/contributors">
<img src="https://img.shields.io/badge/node-%3E=18-green" alt="commit">
</a>
<a href="https://app.codecov.io/github/didi/xiaoju-survey">
<img src="https://img.shields.io/codecov/c/github/didi/xiaoju-survey" alt="codecov">
</a>
<a href="https://github.com/didi/xiaoju-survey/issues">
<img src="https://img.shields.io/github/issues/didi/xiaoju-survey" alt="issues">
</a>
<a href="https://github.com/didi/xiaoju-survey/graphs/contributors">
<img src="https://img.shields.io/github/last-commit/didi/xiaoju-survey?color=red" alt="commit">
</a>
<a href="https://github.com/didi/xiaoju-survey/pulls">
<img src="https://img.shields.io/badge/PRs-welcome-%23ffa600" alt="pr">
</a>
<a href="https://xiaojusurvey.didi.cn">
<img src="https://img.shields.io/badge/help-website-blue" alt="docs">
</a>
<a href="https://github.com/didi/xiaoju-survey/blob/main/README.md">
<img src="https://img.shields.io/badge/help-README_ZH-50c62a" alt="docs">
</a>
</div>
</div>
<br />
&ensp;&ensp;XIAOJUSURVEY is an enterprises form builder and analytics platform to create questionnaires, exams, polls, quizzes, and analyze data online.
&ensp;&ensp;The internal system has accumulated over 40 question types and more than 100 selected templates, suitable for market research, customer satisfaction surveys, online exams, voting, reporting, evaluations, and many other scenarios. In terms of data capabilities, it has been honed through hundreds of millions of iterations, resulting in the ability to provide online reports with per-question statistics, cross-analysis, and multi-channel analysis, quickly meeting professional analysis needs.
# Features
**🌈 Easy to use**
- Multi-type data collection, easy to create forms: text input, data selection, scoring, voting, file upload, etc.
- Smart logic arrangement, design multi-rule dynamic forms: display logic, jump logic, option reference, title reference, etc.
- Multiple permission management, support efficient team collaboration: space management, multi-role permission management, etc.
- Online data analysis and export, insight into survey results: data export, recycled data management, sub-topic statistics, cross-analysis, etc.
**🎨 Good-looking**
- Free customization of themes to adapt to your brand: custom colors, backgrounds, pictures, logos, result page rules, etc.
- Seamlessly embedded in various terminals to meet the needs of different scenarios: multi-terminal embedded small questionnaire SDK.
**🚀 Secure and scalable**
- Scalable security capabilities, providing experience guidance for security-related construction: encrypted transmission, data masking, etc.
- Customized Hook configuration, easy integration of multiple systems and various tools: data push, message push, etc.
<img src="https://github.com/didi/xiaoju-survey/assets/16012672/508ce30f-0ae8-4f5f-84a7-e96de8238a7f" width="700" />
1. For more comprehensive features, please refer to the [documentation](https://xiaojusurvey.didi.cn/docs/next/document/%E4%BA%A7%E5%93%81%E6%89%8B%E5%86%8C/%E5%8A%9F%E8%83%BD%E4%BB%8B%E7%BB%8D/%E5%9F%BA%E7%A1%80%E6%B5%81%E7%A8%8B).
2. Both individual and enterprise users can quickly build survey solutions specific to their fields.
# Technology
Web: Vue3 + ElementPlus; Multi-end rendering for C-end (planning).
Server: NestJS + MongoDB; Java ([under construction](https://github.com/didi/xiaoju-survey/issues/306)).
Online Platform: (under construction).
Intelligent Foundation: (planning).
# Project Advantages
**1. Comprehensive and Professional**
- [Standardized Protocols for Questionnaires](https://xiaojusurvey.didi.cn/docs/next/agreement/%E3%80%8A%E9%97%AE%E5%8D%B7Meta%E5%8D%8F%E8%AE%AE%E3%80%8B)
Ensuring concept interoperability is the foundation and core of the entire system. Based on practical business experience, two main categories have been established:
Business Descriptions: Questionnaire protocol, question type protocol.
Material Descriptions: Question type material protocol, including question types and settings.
- [UI/UX Standardization for Questionnaires](https://xiaojusurvey.didi.cn/docs/next/design/%E3%80%8A%E8%AE%BE%E8%AE%A1%E8%A7%84%E8%8C%83%E3%80%8B)
The design language is the cornerstone of system flexibility and consistency, ensuring the system supports actual business operations with high user experience. It includes:
Design Standards: Flexible, noise-reducing, unified.
Interaction Standards: Follows user behavior characteristics, product positioning, and mature user habits.
- [WYSIWYG with High Consistency in Construction and Rendering](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E9%A2%98%E5%9E%8B%E5%9C%BA%E6%99%AF%E5%8C%96%E8%AE%BE%E8%AE%A1)
In practical business usage, the system includes both questionnaire generation and deployment. We design question types in a scenario-based manner to ensure high consistency from production to application.
- [Materialized Question Type Design for Free Customization and Extension](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E9%A2%98%E5%9E%8B%E7%89%A9%E6%96%99%E5%8C%96%E8%AE%BE%E8%AE%A1/%E5%9F%BA%E7%A1%80%E8%AE%BE%E8%AE%A1)
The core component of questionnaires is question types, and their configurability determines the extensibility of business scenarios and the system's reusability. Each question type has general capabilities and atomic characteristics, ensuring high customization.
- [Compliance Accumulation and High Expandability in Security Capabilities](https://xiaojusurvey.didi.cn/docs/next/document/%E5%AE%89%E5%85%A8%E8%AE%BE%E8%AE%A1/%E6%A6%82%E8%BF%B0)
Data encryption, sensitive information detection, and anti-vote brushing capabilities ensure the security of the questionnaire publishing and data collection process.
Lightweight Design for Quick Integration and Flexible Expansion.
**2. Product-Level Open-Source Solution for Rapid Survey Process Implementation**
- [Product-Level Open-Source Solution for Rapid Survey Process Implementation](https://xiaojusurvey.didi.cn/docs/next/document/%E4%BA%A7%E5%93%81%E6%89%8B%E5%86%8C/%E6%A6%82%E8%BF%B0)
Provides complete product capabilities around the questionnaire lifecycle, including user management (login, registration, questionnaire permissions) and questionnaire management (create, edit, distribute, collect, data analysis), allowing for quick construction of survey solutions in specific fields.
- [Out-of-the-Box Questionnaire Design to Reduce Domain Complexity](https://xiaojusurvey.didi.cn/docs/next/document/%E8%AE%BE%E8%AE%A1%E5%8E%9F%E7%90%86/%E9%97%AE%E5%8D%B7%E6%90%AD%E5%BB%BA%E9%A2%86%E5%9F%9F%E5%8C%96%E8%AE%BE%E8%AE%A1)
High flexibility in questionnaire composition leads to high complexity in editing capabilities. We divide questionnaire editing into five sub-domains for product capability clustering and guide system modular design and development. Based on module arrangement and management, it can be used out-of-the-box.
- [Low Cost for Secondary Development and Easy Customization](https://xiaojusurvey.didi.cn/docs/next/document/%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C/%E5%B7%A5%E7%A8%8B%E9%85%8D%E7%BD%AE%E5%8C%96)
The entire system is designed based on protocol standardization, function modularization, and management configuration, and provides a complete set of documentation and development and extension manuals.
- [Low Deployment Cost for Quick Online Launch](https://xiaojusurvey.didi.cn/docs/next/document/%E5%B7%A5%E7%A8%8B%E9%83%A8%E7%BD%B2/Docker%E9%83%A8%E7%BD%B2)
The front-end and back-end separation, Dockerization solutions, and complete deployment guidance manual.
# Quick Start
Node Version >= 18.x, [ check environment preparation guide.](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B)
Clone Project
```shell
git clone git@github.com:didi/xiaoju-survey.git
```
## Server Startup
### Option 1: Quick Start without Database Installation
> _This is convenient for quickly previewing the project. For formal projects, use Option 2._
#### 1.Install Dependencies
```shell
cd server
npm install
```
#### 2.Start
```shell
npm run local
```
> The service relies on mongodb-memory-server:
> 1.Data is stored in memory and will be updated upon service restart.
> 2.When starting a new instance of the memory server, it will automatically download MongoDB binaries if not found, which might take some time initially.
### Option 2: (Recommended for Production)
#### 1.Configure Database
> The project uses MongoDB: [MongoDB Guide](https://xiaojusurvey.didi.cn/docs/next/document/%E6%A6%82%E8%BF%B0/%E6%95%B0%E6%8D%AE%E5%BA%93#%E5%AE%89%E8%A3%85)
Configure the database, check MongoDB configuration.
#### 2.Install Dependencies
```shell
cd server
npm install
```
#### 2.Install Dependencies
```shell
npm run dev
```
## Frontend Startup
### Install Dependencies
```shell
cd web
npm install
```
### Start
```shell
npm run serve
```
## Access
### Questionnaire Management End
[http://localhost:8080/management](http://localhost:8080)
### Questionnaire Deployment End
Create and publish a questionnaire.
[http://localhost:8080/render/:surveyPath](http://localhost:8080/render/:surveyPath)
<br /><br />
## Star
Open source is not easy. If this project helps you, please star it ❤️❤️❤️. Your support is our greatest motivation.
[![Star History Chart](https://api.star-history.com/svg?repos=didi/xiaoju-survey&type=Date)](https://star-history.com/#didi/xiaoju-survey&Date)
## WeChat Group
The official group will release the latest project news, construction plans, and community activities. Any questions and cooperation can contact the assistant:
<img src="https://img-hxy021.didistatic.com/static/starimg/img/KXKvc7sjHz1700061188156.png" width="200" />
## Feedback
If you use this project, please leave feedback:[I'm using](https://github.com/didi/xiaoju-survey/issues/64), Your support is our greatest.
## Contribution
If you want to become a contributor or expand your technical stack, please check: [Contributor Guide](https://xiaojusurvey.didi.cn/docs/next/share/%E5%A6%82%E4%BD%95%E5%8F%82%E4%B8%8E%E8%B4%A1%E7%8C%AE). Your participation is our greatest honor.
## Future Tasks
1. [Official Feature](https://github.com/didi/xiaoju-survey/issues/45)
2. [WIP](https://github.com/didi/xiaoju-survey/labels/WIP)
## CHANGELOG
Follow major changes: [MAJOR CHANGELOG](https://github.com/didi/xiaoju-survey/issues/48)

4
docker-compose.yaml
View File

@ -15,11 +15,11 @@ services:
- xiaoju-survey
xiaoju-survey:
image: "xiaojusurvey/xiaoju-survey:1.3.0-slim" # 最新版本：https://hub.docker.com/r/xiaojusurvey/xiaoju-survey/tags
image: "xiaojusurvey/xiaoju-survey:1.0.4"
container_name: xiaoju-survey
restart: always
ports:
- "8080:80" # API端口
- "8080:3000" # API端口
environment:
XIAOJU_SURVEY_MONGO_URL: mongodb://${MONGO_INITDB_ROOT_USERNAME}:${MONGO_INITDB_ROOT_PASSWORD}@xiaoju-survey-mongo:27017 # docker-compose 会根据容器名称自动处理
links:

6
docker-run.sh
View File

@ -1,9 +1,3 @@
#! /bin/bash
# 启动nginx
echo 'nginx start'
nginx -g 'daemon on;'
# 启动后端服务
cd /xiaoju-survey/server
npm run start:prod

68
nginx/nginx.conf
View File

@ -1,68 +0,0 @@
# 启动的 worker 进程数量
worker_processes auto;
# 错误日志路径和级别
error_log /var/log/nginx/error.log warn;
events {
# 最大连接数
worker_connections 1024;
}
http {
include /etc/nginx/mime.types;
default_type application/octet-stream;
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" '
'"$http_user_agent" "$http_x_forwarded_for"';
access_log /var/log/nginx/access.log main;
sendfile on;
keepalive_timeout 65;
server {
listen 80;
# IPv6端口
listen [::]:80;
server_name localhost;
# gzip config
gzip on;
gzip_min_length 1k;
gzip_comp_level 9;
gzip_types text/plain text/css text/javascript application/json application/javascript application/x-javascript application/xml;
gzip_vary on;
gzip_disable "MSIE [1-6]\.";
root /xiaoju-survey/web/dist;
location / {
try_files $uri $uri /management.html;
}
location /management/ {
try_files $uri $uri/ /management.html;
}
location /management/preview/ {
try_files $uri $uri/ /render.html;
}
location /render/ {
try_files $uri $uri/ /render.html;
}
location /api {
proxy_pass http://127.0.0.1:3000;
}
location /exportfile {
proxy_pass http://127.0.0.1:3000;
}
# 静态文件的默认存储文件夹
# 文件夹的配置在 server/src/modules/file/config/index.ts SERVER_LOCAL_CONFIG.FILE_KEY_PREFIX
location /userUpload {
proxy_pass http://127.0.0.1:3000;
}
error_page 500 502 503 504 /500.html;
client_max_body_size 20M;
}
}

8
server/.env
View File

@ -1,13 +1,7 @@
XIAOJU_SURVEY_MONGO_DB_NAME=xiaojuSurvey
XIAOJU_SURVEY_MONGO_URL=
XIAOJU_SURVEY_MONGO_URL=mongodb://localhost:27017
XIAOJU_SURVEY_MONGO_AUTH_SOURCE=admin
XIAOJU_SURVEY_REDIS_HOST=
XIAOJU_SURVEY_REDIS_PORT=
XIAOJU_SURVEY_REDIS_USERNAME=
XIAOJU_SURVEY_REDIS_PASSWORD=
XIAOJU_SURVEY_REDIS_DB=
XIAOJU_SURVEY_RESPONSE_AES_ENCRYPT_SECRET_KEY=dataAesEncryptSecretKey
XIAOJU_SURVEY_HTTP_DATA_ENCRYPT_TYPE=rsa

20
server/.env.development
View File

@ -1,20 +0,0 @@
XIAOJU_SURVEY_MONGO_DB_NAME=xiaojuSurvey
XIAOJU_SURVEY_MONGO_URL=mongodb://127.0.0.1:27017
XIAOJU_SURVEY_MONGO_AUTH_SOURCE=admin
XIAOJU_SURVEY_REDIS_HOST=
XIAOJU_SURVEY_REDIS_PORT=
XIAOJU_SURVEY_REDIS_USERNAME=
XIAOJU_SURVEY_REDIS_PASSWORD=
XIAOJU_SURVEY_REDIS_DB=
XIAOJU_SURVEY_RESPONSE_AES_ENCRYPT_SECRET_KEY=dataAesEncryptSecretKey
XIAOJU_SURVEY_HTTP_DATA_ENCRYPT_TYPE=rsa
XIAOJU_SURVEY_JWT_SECRET=xiaojuSurveyJwtSecret
XIAOJU_SURVEY_JWT_EXPIRES_IN=8h
XIAOJU_SURVEY_LOGGER_FILENAME=./logs/app.log
XIAOJU_SURVEY_REPORT=true

17
server/.env.production
View File

@ -1,17 +0,0 @@
XIAOJU_SURVEY_MONGO_DB_NAME=xiaojuSurvey
XIAOJU_SURVEY_MONGO_URL=
XIAOJU_SURVEY_MONGO_AUTH_SOURCE=admin
XIAOJU_SURVEY_REDIS_HOST=
XIAOJU_SURVEY_REDIS_PORT=
XIAOJU_SURVEY_REDIS_USERNAME=
XIAOJU_SURVEY_REDIS_PASSWORD=
XIAOJU_SURVEY_REDIS_DB=
XIAOJU_SURVEY_RESPONSE_AES_ENCRYPT_SECRET_KEY=dataAesEncryptSecretKey
XIAOJU_SURVEY_HTTP_DATA_ENCRYPT_TYPE=rsa
XIAOJU_SURVEY_JWT_SECRET=xiaojuSurveyJwtSecret
XIAOJU_SURVEY_JWT_EXPIRES_IN=8h
XIAOJU_SURVEY_LOGGER_FILENAME=./logs/app.log

5
server/.gitignore vendored
View File

@ -13,7 +13,6 @@ pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
yarn.lock
# OS
.DS_Store
@ -37,7 +36,3 @@ yarn.lock
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
tmp
exportfile
userUpload

35
server/package.json
View File

@ -1,11 +1,11 @@
{
"name": "xiaoju-survey-server",
"version": "1.3.0",
"description": "XIAOJUSURVEY的server端",
"name": "server",
"version": "0.0.1",
"description": "",
"author": "",
"scripts": {
"build": "nest build",
"format": "prettier --write \"src/**/*.ts\" \"src/**/__test/*.ts\"",
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
"local": "ts-node ./scripts/run-local.ts",
"start": "nest start",
"dev": "npm run start:dev",
@ -22,17 +22,15 @@
"@nestjs/common": "^10.0.0",
"@nestjs/config": "^3.1.1",
"@nestjs/core": "^10.0.0",
"@nestjs/microservices": "^10.4.4",
"@nestjs/platform-express": "^10.0.0",
"@nestjs/serve-static": "^4.0.0",
"@nestjs/swagger": "^7.3.0",
"@nestjs/typeorm": "^10.0.1",
"ali-oss": "^6.20.0",
"cheerio": "1.0.0-rc.12",
"cheerio": "^1.0.0-rc.12",
"crypto-js": "^4.2.0",
"dotenv": "^16.3.2",
"fs-extra": "^11.2.0",
"ioredis": "^5.4.1",
"joi": "^17.11.0",
"jsonwebtoken": "^9.0.2",
"lodash": "^4.17.21",
@ -43,9 +41,7 @@
"nanoid": "^3.3.7",
"node-fetch": "^2.7.0",
"node-forge": "^1.3.1",
"node-xlsx": "^0.24.0",
"qiniu": "^7.11.1",
"redlock": "^5.0.0-beta.2",
"reflect-metadata": "^0.1.13",
"rxjs": "^7.8.1",
"svg-captcha": "^1.4.0",
@ -55,18 +51,14 @@
"@nestjs/cli": "^10.0.0",
"@nestjs/schematics": "^10.0.0",
"@nestjs/testing": "^10.0.0",
"@types/ali-oss": "^6.16.11",
"@types/express": "^4.17.17",
"@types/fs-extra": "^11.0.4",
"@types/jest": "^29.5.2",
"@types/jsonwebtoken": "^9.0.6",
"@types/lodash": "^4.17.0",
"@types/multer": "^1.4.11",
"@types/node": "^20.3.1",
"@types/node-forge": "^1.3.11",
"@types/supertest": "^2.0.12",
"@typescript-eslint/eslint-plugin": "^7.16.0",
"@typescript-eslint/parser": "^7.16.0",
"@typescript-eslint/eslint-plugin": "^6.0.0",
"@typescript-eslint/parser": "^6.0.0",
"cross-env": "^7.0.3",
"eslint": "^8.42.0",
"eslint-config-prettier": "^9.0.0",
@ -74,14 +66,13 @@
"jest": "^29.5.0",
"mongodb-memory-server": "^9.1.4",
"prettier": "^3.0.0",
"redis-memory-server": "^0.11.0",
"source-map-support": "^0.5.21",
"supertest": "^7.0.0",
"supertest": "^6.3.3",
"ts-jest": "^29.1.0",
"ts-loader": "^9.4.3",
"ts-node": "^10.9.1",
"tsconfig-paths": "^4.2.0",
"typescript": "^5.5.3"
"typescript": "^5.1.3"
},
"jest": {
"moduleFileExtensions": [
@ -95,18 +86,12 @@
"^.+\\.(t|j)s$": "ts-jest"
},
"collectCoverageFrom": [
"**/*.(t|j)s",
"!**/*.module.ts",
"!**/upgrade.*.ts"
"**/*.(t|j)s"
],
"coverageDirectory": "../coverage",
"testEnvironment": "node",
"moduleNameMapper": {
"^src/(.*)$": "<rootDir>/$1"
}
},
"engines": {
"node": ">=18.0.0",
"npm": ">=8.6.0"
}
}

13
server/scripts/run-local.ts
View File

@ -1,6 +1,5 @@
import { MongoMemoryServer } from 'mongodb-memory-server';
import { spawn } from 'child_process';
// import { RedisMemoryServer } from 'redis-memory-server';
async function startServerAndRunScript() {
// 启动 MongoDB 内存服务器
@ -9,19 +8,12 @@ async function startServerAndRunScript() {
console.log('MongoDB Memory Server started:', mongoUri);
// const redisServer = new RedisMemoryServer();
// const redisHost = await redisServer.getHost();
// const redisPort = await redisServer.getPort();
// 通过 spawn 运行另一个脚本，并传递 MongoDB 连接 URL 作为环境变量
const tsnode = spawn(
'cross-env',
[
`XIAOJU_SURVEY_MONGO_URL=${mongoUri}`,
// `XIAOJU_SURVEY_REDIS_HOST=${redisHost}`,
// `XIAOJU_SURVEY_REDIS_PORT=${redisPort}`,
'NODE_ENV=development',
'SERVER_ENV=local',
'npm',
'run',
'start:dev',
@ -39,10 +31,9 @@ async function startServerAndRunScript() {
console.error(data);
});
tsnode.on('close', async (code) => {
tsnode.on('close', (code) => {
console.log(`Nodemon process exited with code ${code}`);
await mongod.stop(); // 停止 MongoDB 内存服务器
// await redisServer.stop();
mongod.stop(); // 停止 MongoDB 内存服务器
});
}

23
server/src/app.module.ts
View File

@ -13,8 +13,6 @@ import { SurveyResponseModule } from './modules/surveyResponse/surveyResponse.mo
import { AuthModule } from './modules/auth/auth.module';
import { MessageModule } from './modules/message/message.module';
import { FileModule } from './modules/file/file.module';
import { WorkspaceModule } from './modules/workspace/workspace.module';
import { UpgradeModule } from './modules/upgrade/upgrade.module';
import { join } from 'path';
@ -33,24 +31,16 @@ import { ClientEncrypt } from './models/clientEncrypt.entity';
import { Word } from './models/word.entity';
import { MessagePushingTask } from './models/messagePushingTask.entity';
import { MessagePushingLog } from './models/messagePushingLog.entity';
import { WorkspaceMember } from './models/workspaceMember.entity';
import { Workspace } from './models/workspace.entity';
import { Collaborator } from './models/collaborator.entity';
import { DownloadTask } from './models/downloadTask.entity';
import { Session } from './models/session.entity';
import { LoggerProvider } from './logger/logger.provider';
import { PluginManagerProvider } from './securityPlugin/pluginManager.provider';
import { LogRequestMiddleware } from './middlewares/logRequest.middleware';
import { PluginManager } from './securityPlugin/pluginManager';
import { XiaojuSurveyPluginManager } from './securityPlugin/pluginManager';
import { Logger } from './logger';
@Module({
imports: [
ConfigModule.forRoot({
envFilePath: `.env.${process.env.NODE_ENV}`, // 根据 NODE_ENV 动态加载对应的 .env 文件
isGlobal: true, // 使配置模块在应用的任何地方可用
}),
ConfigModule.forRoot({}),
TypeOrmModule.forRootAsync({
imports: [ConfigModule],
inject: [ConfigService],
@ -84,11 +74,6 @@ import { Logger } from './logger';
Word,
MessagePushingTask,
MessagePushingLog,
Workspace,
WorkspaceMember,
Collaborator,
DownloadTask,
Session,
],
};
},
@ -107,8 +92,6 @@ import { Logger } from './logger';
}),
MessageModule,
FileModule,
WorkspaceModule,
UpgradeModule,
],
controllers: [AppController],
providers: [
@ -123,7 +106,7 @@ import { Logger } from './logger';
export class AppModule {
constructor(
private readonly configService: ConfigService,
private readonly pluginManager: PluginManager,
private readonly pluginManager: XiaojuSurveyPluginManager,
) {}
configure(consumer: MiddlewareConsumer) {
consumer.apply(LogRequestMiddleware).forRoutes('*');

26
server/src/config/index.ts Normal file
View File

@ -0,0 +1,26 @@
const mongo = {
url: process.env.XIAOJU_SURVEY_MONGO_URL || 'mongodb://localhost:27017',
dbName: process.env.XIAOJU_SURVER_MONGO_DBNAME || 'xiaojuSurvey',
};
const session = {
expireTime: parseInt(process.env.XIAOJU_SURVEY_JWT_EXPIRES_IN) || 8 * 3600 * 1000
};
const encrypt = {
type: process.env.XIAOJU_SURVEY_ENCRYPT_TYPE || 'aes',
aesCodelength: parseInt(process.env.XIAOJU_SURVEY_ENCRYPT_TYPE_LEN) || 10 //aes密钥长度
};
const jwt = {
secret: process.env.XIAOJU_SURVEY_JWT_SECRET || 'xiaojuSurveyJwtSecret',
expiresIn: process.env.XIAOJU_SURVEY_JWT_EXPIRES_IN || '8h'
};
export{
mongo,
session,
encrypt,
jwt,
};

6
server/src/enums/downloadTaskStatus.ts
View File

@ -1,6 +0,0 @@
export enum DOWNLOAD_TASK_STATUS {
WAITING = 'waiting', // 排队中
COMPUTING = 'computing', // 计算中
SUCCEED = 'succeed', // 导出成功
FAILED = 'failed', // 导出失败
}

9
server/src/enums/exceptionCode.ts
View File

@ -1,27 +1,20 @@
export enum EXCEPTION_CODE {
AUTHENTICATION_FAILED = 1001, // 未授权
AUTHENTICATION_FAILED = 1001, // 没有权限
PARAMETER_ERROR = 1002, // 参数有误
NO_PERMISSION = 1003, // 没有操作权限
USER_EXISTS = 2001, // 用户已存在
USER_NOT_EXISTS = 2002, // 用户不存在
USER_PASSWORD_WRONG = 2003, // 用户名或密码错误
PASSWORD_INVALID = 2004, // 密码无效
NO_SURVEY_PERMISSION = 3001, // 没有问卷权限
SURVEY_STATUS_TRANSFORM_ERROR = 3002, // 问卷状态转换报错
SURVEY_TYPE_ERROR = 3003, // 问卷类型错误
SURVEY_NOT_FOUND = 3004, // 问卷不存在
SURVEY_CONTENT_NOT_ALLOW = 3005, // 存在禁用内容
SURVEY_SAVE_CONFLICT = 3006, // 问卷冲突
CAPTCHA_INCORRECT = 4001, // 验证码不正确
WHITELIST_ERROR = 4002, // 白名单校验错误
RESPONSE_SIGN_ERROR = 9001, // 签名不正确
RESPONSE_CURRENT_TIME_NOT_ALLOW = 9002, // 当前时间不允许提交
RESPONSE_OVER_LIMIT = 9003, // 超出限制
RESPONSE_SCHEMA_REMOVED = 9004, // 问卷已删除
RESPONSE_DATA_DECRYPT_ERROR = 9005, // 问卷已删除
RESPONSE_PAUSING = 9006, // 问卷已暂停
UPLOAD_FILE_ERROR = 5001, // 上传文件错误
}

12
server/src/enums/index.ts
View File

@ -1,15 +1,11 @@
// 状态类型
export enum RECORD_STATUS {
NEW = 'new', // 新建 | 未发布
PUBLISHED = 'published', // 发布
NEW = 'new', // 新建
EDITING = 'editing', // 编辑
FINISHED = 'finished', // 已结束
REMOVED = 'removed',
}
export const enum RECORD_SUB_STATUS {
DEFAULT = '', // 默认
PAUSING = 'pausing', // 暂停
PUBLISHED = 'published', // 发布
REMOVED = 'removed', // 删除
FORCE_REMOVED = 'forceRemoved', // 从回收站删除
}
// 历史类型

37
server/src/enums/question.ts
View File

@ -1,37 +0,0 @@
/**
* @description 问卷题目类型
*/
export enum QUESTION_TYPE {
/**
* 单行输入框
*/
TEXT = 'text',
/**
* 多行输入框
*/
TEXTAREA = 'textarea',
/**
* 单项选择
*/
RADIO = 'radio',
/**
* 多项选择
*/
CHECKBOX = 'checkbox',
/**
* 判断题
*/
BINARY_CHOICE = 'binary-choice',
/**
* 评分
*/
RADIO_STAR = 'radio-star',
/**
* nps评分
*/
RADIO_NPS = 'radio-nps',
/**
* 投票
*/
VOTE = 'vote',
}

20
server/src/enums/surveyPermission.ts
View File

@ -1,20 +0,0 @@
export enum SURVEY_PERMISSION {
SURVEY_CONF_MANAGE = 'SURVEY_CONF_MANAGE',
SURVEY_RESPONSE_MANAGE = 'SURVEY_RESPONSE_MANAGE',
SURVEY_COOPERATION_MANAGE = 'SURVEY_COOPERATION_MANAGE',
}
export const SURVEY_PERMISSION_DESCRIPTION = {
SURVEY_CONF_MANAGE: {
name: '问卷配置管理',
value: SURVEY_PERMISSION.SURVEY_CONF_MANAGE,
},
surveyResponseManage: {
name: '问卷分析管理',
value: SURVEY_PERMISSION.SURVEY_RESPONSE_MANAGE,
},
surveyCooperatorManage: {
name: '协作者管理',
value: SURVEY_PERMISSION.SURVEY_COOPERATION_MANAGE,
},
};

4
server/src/enums/surveySessionStatus.ts
View File

@ -1,4 +0,0 @@
export enum SESSION_STATUS {
ACTIVATED = 'activated',
DEACTIVATED = 'deactivated',
}

41
server/src/enums/workspace.ts
View File

@ -1,41 +0,0 @@
export enum ROLE {
ADMIN = 'admin',
USER = 'user',
}
export const ROLE_DESCRIPTION = {
ADMIN: {
name: '管理员',
value: ROLE.ADMIN,
},
USER: {
name: '用户',
value: ROLE.USER,
},
};
export enum PERMISSION {
READ_WORKSPACE = 'READ_WORKSPACE',
WRITE_WORKSPACE = 'WRITE_WORKSPACE',
READ_MEMBER = 'READ_MEMBER',
WRITE_MEMBER = 'WRITE_MEMBER',
READ_SURVEY = 'READ_SURVEY',
WRITE_SURVEY = 'WRITE_SURVEY',
}
export const ROLE_PERMISSION: Record<ROLE, PERMISSION[]> = {
[ROLE.ADMIN]: [
PERMISSION.READ_WORKSPACE,
PERMISSION.WRITE_WORKSPACE,
PERMISSION.READ_MEMBER,
PERMISSION.WRITE_MEMBER,
PERMISSION.READ_SURVEY,
PERMISSION.WRITE_SURVEY,
],
[ROLE.USER]: [
PERMISSION.READ_WORKSPACE,
PERMISSION.READ_MEMBER,
PERMISSION.READ_SURVEY,
PERMISSION.WRITE_SURVEY,
],
};

55
server/src/exceptions/__test/httpExceptions.filter.spec.ts
View File

@ -1,55 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { HttpExceptionsFilter } from '../httpExceptions.filter';
import { ArgumentsHost } from '@nestjs/common';
import { HttpException } from '../httpException';
import { Response } from 'express';
describe('HttpExceptionsFilter', () => {
let filter: HttpExceptionsFilter;
let mockArgumentsHost: ArgumentsHost;
let mockResponse: Partial<Response>;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [HttpExceptionsFilter],
}).compile();
filter = module.get<HttpExceptionsFilter>(HttpExceptionsFilter);
mockResponse = {
status: jest.fn().mockReturnThis(),
json: jest.fn(),
};
mockArgumentsHost = {
switchToHttp: jest.fn().mockReturnThis(),
getResponse: jest.fn().mockReturnValue(mockResponse),
} as unknown as ArgumentsHost;
});
it('should return 500 status and "Internal Server Error" message for generic errors', () => {
const genericError = new Error('Some error');
filter.catch(genericError, mockArgumentsHost);
expect(mockResponse.status).toHaveBeenCalledWith(500);
expect(mockResponse.json).toHaveBeenCalledWith({
message: 'Internal Server Error',
code: 500,
errmsg: 'Some error',
});
});
it('should return 200 status and specific message for HttpException', () => {
const httpException = new HttpException('Specific error message', 1001);
filter.catch(httpException, mockArgumentsHost);
expect(mockResponse.status).toHaveBeenCalledWith(200);
expect(mockResponse.json).toHaveBeenCalledWith({
message: 'Specific error message',
code: 1001,
errmsg: 'Specific error message',
});
});
});

1
server/src/exceptions/httpExceptions.filter.ts
View File

@ -1,3 +1,4 @@
// all-exceptions.filter.ts
import {
ExceptionFilter,
Catch,

4
server/src/exceptions/noPermissionException.ts → server/src/exceptions/noSurveyPermissionException.ts
View File

@ -1,8 +1,8 @@
import { HttpException } from './httpException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
export class NoPermissionException extends HttpException {
export class NoSurveyPermissionException extends HttpException {
constructor(public readonly message: string) {
super(message, EXCEPTION_CODE.NO_PERMISSION);
super(message, EXCEPTION_CODE.NO_SURVEY_PERMISSION);
}
}

68
server/src/guards/__test/session.guard.spec.ts
View File

@ -1,68 +0,0 @@
import { ExecutionContext } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { SessionService } from 'src/modules/survey/services/session.service';
import { SessionGuard } from '../session.guard';
import { NoPermissionException } from 'src/exceptions/noPermissionException';
describe('SessionGuard', () => {
let sessionGuard: SessionGuard;
let reflector: Reflector;
let sessionService: SessionService;
beforeEach(() => {
reflector = new Reflector();
sessionService = {
findOne: jest.fn(),
} as unknown as SessionService;
sessionGuard = new SessionGuard(reflector, sessionService);
});
it('should return true when sessionId exists and sessionService returns sessionInfo', async () => {
const mockSessionId = '12345';
const mockSessionInfo = { id: mockSessionId, name: 'test session' };
const context = {
switchToHttp: jest.fn().mockReturnThis(),
getRequest: jest.fn().mockReturnValue({
sessionId: mockSessionId,
}),
getHandler: jest.fn(),
} as unknown as ExecutionContext;
jest.spyOn(reflector, 'get').mockReturnValue('sessionId');
jest
.spyOn(sessionService, 'findOne')
.mockResolvedValue(mockSessionInfo as any);
const result = await sessionGuard.canActivate(context);
const request = context.switchToHttp().getRequest();
expect(result).toBe(true);
expect(reflector.get).toHaveBeenCalledWith(
'sessionId',
context.getHandler(),
);
expect(sessionService.findOne).toHaveBeenCalledWith(mockSessionId);
expect(request.sessionInfo).toEqual(mockSessionInfo);
});
it('should throw NoPermissionException when sessionId is missing', async () => {
const context = {
switchToHttp: jest.fn().mockReturnThis(),
getRequest: jest.fn().mockReturnValue({}),
getHandler: jest.fn(),
} as unknown as ExecutionContext;
jest.spyOn(reflector, 'get').mockReturnValue('sessionId');
await expect(sessionGuard.canActivate(context)).rejects.toThrow(
NoPermissionException,
);
expect(reflector.get).toHaveBeenCalledWith(
'sessionId',
context.getHandler(),
);
});
});

198
server/src/guards/__test/survey.guard.spec.ts
View File

@ -1,198 +0,0 @@
import { Reflector } from '@nestjs/core';
import { Test, TestingModule } from '@nestjs/testing';
import { ExecutionContext } from '@nestjs/common';
import { SurveyGuard } from '../survey.guard';
import { WorkspaceMemberService } from 'src/modules/workspace/services/workspaceMember.service';
import { CollaboratorService } from 'src/modules/survey/services/collaborator.service';
import { SurveyMetaService } from 'src/modules/survey/services/surveyMeta.service';
import { SurveyNotFoundException } from 'src/exceptions/surveyNotFoundException';
import { NoPermissionException } from 'src/exceptions/noPermissionException';
import { SurveyMeta } from 'src/models/surveyMeta.entity';
import { WorkspaceMember } from 'src/models/workspaceMember.entity';
import { Collaborator } from 'src/models/collaborator.entity';
import { SURVEY_PERMISSION } from 'src/enums/surveyPermission';
describe('SurveyGuard', () => {
let guard: SurveyGuard;
let reflector: Reflector;
let collaboratorService: CollaboratorService;
let surveyMetaService: SurveyMetaService;
let workspaceMemberService: WorkspaceMemberService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
SurveyGuard,
{
provide: Reflector,
useValue: {
get: jest.fn(),
},
},
{
provide: CollaboratorService,
useValue: {
getCollaborator: jest.fn(),
},
},
{
provide: SurveyMetaService,
useValue: {
getSurveyById: jest.fn(),
},
},
{
provide: WorkspaceMemberService,
useValue: {
findOne: jest.fn(),
},
},
],
}).compile();
guard = module.get<SurveyGuard>(SurveyGuard);
reflector = module.get<Reflector>(Reflector);
collaboratorService = module.get<CollaboratorService>(CollaboratorService);
surveyMetaService = module.get<SurveyMetaService>(SurveyMetaService);
workspaceMemberService = module.get<WorkspaceMemberService>(
WorkspaceMemberService,
);
});
it('should be defined', () => {
expect(guard).toBeDefined();
});
it('should allow access if no surveyId is present', async () => {
const context = createMockExecutionContext();
jest.spyOn(reflector, 'get').mockReturnValue(null);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
it('should throw SurveyNotFoundException if survey does not exist', async () => {
const context = createMockExecutionContext();
jest.spyOn(reflector, 'get').mockReturnValue('params.surveyId');
jest.spyOn(surveyMetaService, 'getSurveyById').mockResolvedValue(null);
await expect(guard.canActivate(context)).rejects.toThrow(
SurveyNotFoundException,
);
});
it('should allow access if user is the owner of the survey by ownerId', async () => {
const context = createMockExecutionContext();
const surveyMeta = { ownerId: 'testUserId', workspaceId: null };
jest.spyOn(reflector, 'get').mockReturnValue('params.surveyId');
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
it('should allow access if user is the owner of the survey by username', async () => {
const context = createMockExecutionContext();
const surveyMeta = { owner: 'testUser', workspaceId: null };
jest.spyOn(reflector, 'get').mockReturnValue('params.surveyId');
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
it('should allow access if user is a workspace member', async () => {
const context = createMockExecutionContext();
const surveyMeta = { owner: 'anotherUser', workspaceId: 'workspaceId' };
jest.spyOn(reflector, 'get').mockReturnValue('params.surveyId');
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
jest
.spyOn(workspaceMemberService, 'findOne')
.mockResolvedValue({} as WorkspaceMember);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
it('should throw NoPermissionException if user is not a workspace member', async () => {
const context = createMockExecutionContext();
const surveyMeta = { owner: 'anotherUser', workspaceId: 'workspaceId' };
jest.spyOn(reflector, 'get').mockReturnValue('params.surveyId');
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
jest.spyOn(workspaceMemberService, 'findOne').mockResolvedValue(null);
await expect(guard.canActivate(context)).rejects.toThrow(
NoPermissionException,
);
});
it('should throw NoPermissionException if no permissions are provided', async () => {
const context = createMockExecutionContext();
const surveyMeta = { owner: 'anotherUser', workspaceId: null };
jest.spyOn(reflector, 'get').mockReturnValueOnce('params.surveyId');
jest.spyOn(reflector, 'get').mockReturnValueOnce(null);
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
await expect(guard.canActivate(context)).rejects.toThrow(
NoPermissionException,
);
});
it('should throw NoPermissionException if user has no matching permissions', async () => {
const context = createMockExecutionContext();
const surveyMeta = { owner: 'anotherUser', workspaceId: null };
jest.spyOn(reflector, 'get').mockReturnValueOnce('params.surveyId');
jest.spyOn(reflector, 'get').mockReturnValueOnce(['requiredPermission']);
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
jest
.spyOn(collaboratorService, 'getCollaborator')
.mockResolvedValue({ permissions: [] } as Collaborator);
await expect(guard.canActivate(context)).rejects.toThrow(
NoPermissionException,
);
});
it('should allow access if user has the required permissions', async () => {
const context = createMockExecutionContext();
const surveyMeta = { owner: 'anotherUser', workspaceId: null };
jest.spyOn(reflector, 'get').mockReturnValueOnce('params.surveyId');
jest
.spyOn(reflector, 'get')
.mockReturnValueOnce([SURVEY_PERMISSION.SURVEY_CONF_MANAGE]);
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
jest.spyOn(collaboratorService, 'getCollaborator').mockResolvedValue({
permissions: [SURVEY_PERMISSION.SURVEY_CONF_MANAGE],
} as Collaborator);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
function createMockExecutionContext(): ExecutionContext {
return {
switchToHttp: jest.fn().mockReturnValue({
getRequest: jest.fn().mockReturnValue({
user: { username: 'testUser', _id: 'testUserId' },
params: { surveyId: 'surveyId' },
}),
}),
getHandler: jest.fn(),
} as unknown as ExecutionContext;
}
});

137
server/src/guards/__test/workspace.guard.spec.ts
View File

@ -1,137 +0,0 @@
import { Reflector } from '@nestjs/core';
import { Test, TestingModule } from '@nestjs/testing';
import { ExecutionContext } from '@nestjs/common';
import { WorkspaceGuard } from '../workspace.guard';
import { WorkspaceMemberService } from 'src/modules/workspace/services/workspaceMember.service';
import { NoPermissionException } from '../../exceptions/noPermissionException';
import { WorkspaceMember } from 'src/models/workspaceMember.entity';
import { PERMISSION as WORKSPACE_PERMISSION } from 'src/enums/workspace';
describe('WorkspaceGuard', () => {
let guard: WorkspaceGuard;
let reflector: Reflector;
let workspaceMemberService: WorkspaceMemberService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
WorkspaceGuard,
{
provide: Reflector,
useValue: {
get: jest.fn(),
},
},
{
provide: WorkspaceMemberService,
useValue: {
findOne: jest.fn(),
},
},
],
}).compile();
guard = module.get<WorkspaceGuard>(WorkspaceGuard);
reflector = module.get<Reflector>(Reflector);
workspaceMemberService = module.get<WorkspaceMemberService>(
WorkspaceMemberService,
);
});
it('should be defined', () => {
expect(guard).toBeDefined();
});
it('should allow access if no roles are defined', async () => {
const context = createMockExecutionContext();
jest.spyOn(reflector, 'get').mockReturnValue(null);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
it('should throw NoPermissionException if workspaceId is missing and optional is false', async () => {
const context = createMockExecutionContext();
jest
.spyOn(reflector, 'get')
.mockReturnValueOnce([WORKSPACE_PERMISSION.READ_WORKSPACE]);
jest.spyOn(reflector, 'get').mockReturnValueOnce('params.workspaceId');
await expect(guard.canActivate(context)).rejects.toThrow(
NoPermissionException,
);
});
it('should allow access if workspaceId is missing and optional is true', async () => {
const context = createMockExecutionContext();
jest
.spyOn(reflector, 'get')
.mockReturnValueOnce([WORKSPACE_PERMISSION.WRITE_WORKSPACE]);
jest
.spyOn(reflector, 'get')
.mockReturnValueOnce({ key: 'params.workspaceId', optional: true });
jest
.spyOn(workspaceMemberService, 'findOne')
.mockResolvedValue({ role: 'admin' } as WorkspaceMember);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
it('should throw NoPermissionException if user is not a member of the workspace', async () => {
const context = createMockExecutionContext();
jest
.spyOn(reflector, 'get')
.mockReturnValueOnce([WORKSPACE_PERMISSION.WRITE_WORKSPACE]);
jest.spyOn(reflector, 'get').mockReturnValueOnce('params.workspaceId');
jest.spyOn(workspaceMemberService, 'findOne').mockResolvedValue(null);
await expect(guard.canActivate(context)).rejects.toThrow(
NoPermissionException,
);
});
it('should throw NoPermissionException if user role is not allowed', async () => {
const context = createMockExecutionContext();
jest
.spyOn(reflector, 'get')
.mockReturnValueOnce([WORKSPACE_PERMISSION.READ_MEMBER]);
jest.spyOn(reflector, 'get').mockReturnValueOnce('params.workspaceId');
jest
.spyOn(workspaceMemberService, 'findOne')
.mockResolvedValue({ role: 'member' } as WorkspaceMember);
await expect(guard.canActivate(context)).rejects.toThrow(
NoPermissionException,
);
});
it('should allow access if user role is allowed', async () => {
const context = createMockExecutionContext();
jest
.spyOn(reflector, 'get')
.mockReturnValueOnce([WORKSPACE_PERMISSION.READ_MEMBER]);
jest.spyOn(reflector, 'get').mockReturnValueOnce('params.workspaceId');
jest
.spyOn(workspaceMemberService, 'findOne')
.mockResolvedValue({ role: 'admin' } as WorkspaceMember);
const result = await guard.canActivate(context);
expect(result).toBe(true);
});
function createMockExecutionContext(): ExecutionContext {
return {
switchToHttp: jest.fn().mockReturnValue({
getRequest: jest.fn().mockReturnValue({
user: { _id: 'testUserId' },
params: { workspaceId: 'workspaceId' },
}),
}),
getHandler: jest.fn(),
} as unknown as ExecutionContext;
}
});

56
server/src/guards/__test/authentication.guard.spec.ts → server/src/guards/authtication.spec.ts
View File

@ -1,25 +1,26 @@
import { Test, TestingModule } from '@nestjs/testing';
import { Authtication } from './authtication';
import { UserService } from '../modules/auth/services/user.service';
import { ConfigService } from '@nestjs/config';
import { Authentication } from '../authentication.guard';
import { AuthService } from 'src/modules/auth/services/auth.service';
import { AuthenticationException } from 'src/exceptions/authException';
import { AuthenticationException } from '../exceptions/authException';
import { User } from 'src/models/user.entity';
import * as jwt from 'jsonwebtoken';
jest.mock('jsonwebtoken');
describe('Authentication', () => {
let guard: Authentication;
let authService: AuthService;
describe('Authtication', () => {
let guard: Authtication;
let userService: UserService;
let configService: ConfigService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
Authentication,
Authtication,
{
provide: AuthService,
provide: UserService,
useValue: {
verifyToken: jest.fn(),
getUserByUsername: jest.fn(),
},
},
{
@ -31,8 +32,8 @@ describe('Authentication', () => {
],
}).compile();
guard = module.get<Authentication>(Authentication);
authService = module.get<AuthService>(AuthService);
guard = module.get<Authtication>(Authtication);
userService = module.get<UserService>(UserService);
configService = module.get<ConfigService>(ConfigService);
});
@ -61,9 +62,7 @@ describe('Authentication', () => {
}),
};
jest
.spyOn(authService, 'verifyToken')
.mockRejectedValue(new Error('token is invalid'));
jest.spyOn(jwt, 'verify').mockReturnValue(new Error('token is invalid'));
jest
.spyOn(configService, 'get')
@ -74,6 +73,31 @@ describe('Authentication', () => {
);
});
it('should throw exception if user does not exist', async () => {
const context = {
switchToHttp: () => ({
getRequest: () => ({
headers: {
authorization: 'Bearer validToken',
},
}),
}),
};
const fakeUser = { username: 'testUser' } as User;
jest.spyOn(jwt, 'verify').mockReturnValue(fakeUser);
jest
.spyOn(configService, 'get')
.mockReturnValue('XIAOJU_SURVEY_JWT_SECRET');
jest.spyOn(userService, 'getUserByUsername').mockResolvedValue(null);
await expect(guard.canActivate(context as any)).rejects.toThrow(
AuthenticationException,
);
});
it('should set user in request object and return true if user exists', async () => {
const request = {
headers: {
@ -90,7 +114,9 @@ describe('Authentication', () => {
jest
.spyOn(configService, 'get')
.mockReturnValue('XIAOJU_SURVEY_JWT_SECRET');
jest.spyOn(authService, 'verifyToken').mockResolvedValue(fakeUser);
jest.spyOn(userService, 'getUserByUsername').mockResolvedValue(fakeUser);
jest.spyOn(jwt, 'verify').mockReturnValue(fakeUser);
const result = await guard.canActivate(context as any);

8
server/src/guards/authentication.guard.ts → server/src/guards/authtication.ts
View File

@ -1,10 +1,14 @@
import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { UserService } from '../modules/auth/services/user.service';
import { AuthenticationException } from '../exceptions/authException';
import { AuthService } from 'src/modules/auth/services/auth.service';
@Injectable()
export class Authentication implements CanActivate {
constructor(private readonly authService: AuthService) {}
export class Authtication implements CanActivate {
constructor(
private readonly userService: UserService,
private readonly authService: AuthService,
) {}
async canActivate(context: ExecutionContext): Promise<boolean> {
const request = context.switchToHttp().getRequest();

30
server/src/guards/session.guard.ts
View File

@ -1,30 +0,0 @@
import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { get } from 'lodash';
import { NoPermissionException } from 'src/exceptions/noPermissionException';
import { SessionService } from 'src/modules/survey/services/session.service';
@Injectable()
export class SessionGuard implements CanActivate {
constructor(
private reflector: Reflector,
private readonly sessionService: SessionService,
) {}
async canActivate(context: ExecutionContext): Promise<boolean> {
const request = context.switchToHttp().getRequest();
const sessionIdKey = this.reflector.get<string>(
'sessionId',
context.getHandler(),
);
const sessionId = get(request, sessionIdKey);
if (!sessionId) {
throw new NoPermissionException('没有权限');
}
const sessionInfo = await this.sessionService.findOne(sessionId);
request.sessionInfo = sessionInfo;
request.surveyId = sessionInfo.surveyId;
return true;
}
}

87
server/src/guards/survey.guard.ts
View File

@ -1,87 +0,0 @@
import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { get } from 'lodash';
import { WorkspaceMemberService } from 'src/modules/workspace/services/workspaceMember.service';
import { CollaboratorService } from 'src/modules/survey/services/collaborator.service';
import { SurveyMetaService } from 'src/modules/survey/services/surveyMeta.service';
import { SurveyNotFoundException } from 'src/exceptions/surveyNotFoundException';
import { NoPermissionException } from 'src/exceptions/noPermissionException';
@Injectable()
export class SurveyGuard implements CanActivate {
constructor(
private reflector: Reflector,
private readonly collaboratorService: CollaboratorService,
private readonly surveyMetaService: SurveyMetaService,
private readonly workspaceMemberService: WorkspaceMemberService,
) {}
async canActivate(context: ExecutionContext): Promise<boolean> {
const request = context.switchToHttp().getRequest();
const user = request.user;
const surveyIdKey = this.reflector.get<string>(
'surveyId',
context.getHandler(),
);
const surveyId = get(request, surveyIdKey);
if (!surveyId) {
return true;
}
const surveyMeta = await this.surveyMetaService.getSurveyById({ surveyId });
if (!surveyMeta) {
throw new SurveyNotFoundException('问卷不存在');
}
request.surveyMeta = surveyMeta;
// 兼容老的问卷没有ownerId
if (
surveyMeta.ownerId === user._id.toString() ||
surveyMeta.owner === user.username
) {
// 问卷的owner，可以访问和操作问卷
return true;
}
if (surveyMeta.workspaceId) {
const memberInfo = await this.workspaceMemberService.findOne({
workspaceId: surveyMeta.workspaceId,
userId: user._id.toString(),
});
if (!memberInfo) {
throw new NoPermissionException('没有权限');
}
return true;
}
const permissions = this.reflector.get<string[]>(
'surveyPermission',
context.getHandler(),
);
if (!Array.isArray(permissions) || permissions.length === 0) {
throw new NoPermissionException('没有权限');
}
const info = await this.collaboratorService.getCollaborator({
surveyId,
userId: user._id.toString(),
});
if (!info) {
throw new NoPermissionException('没有权限');
}
request.collaborator = info;
if (
permissions.some((permission) => info.permissions.includes(permission))
) {
return true;
}
throw new NoPermissionException('没有权限');
}
}

72
server/src/guards/workspace.guard.ts
View File

@ -1,72 +0,0 @@
import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { get } from 'lodash';
import { NoPermissionException } from '../exceptions/noPermissionException';
import { WorkspaceMemberService } from 'src/modules/workspace/services/workspaceMember.service';
import { ROLE_PERMISSION as WORKSPACE_ROLE_PERMISSION } from 'src/enums/workspace';
@Injectable()
export class WorkspaceGuard implements CanActivate {
constructor(
private reflector: Reflector,
private readonly workspaceMemberService: WorkspaceMemberService,
) {}
async canActivate(context: ExecutionContext): Promise<boolean> {
const allowPermissions = this.reflector.get<string[]>(
'workspacePermissions',
context.getHandler(),
);
if (!allowPermissions) {
return true; // 没有定义权限，可以访问
}
const request = context.switchToHttp().getRequest();
const user = request.user;
const workspaceIdInfo = this.reflector.get(
'workspaceId',
context.getHandler(),
);
let workspaceIdKey, optional;
if (typeof workspaceIdInfo === 'string') {
workspaceIdKey = workspaceIdInfo;
optional = false;
} else {
workspaceIdKey = workspaceIdInfo?.key;
optional = workspaceIdInfo?.optional || false;
}
const workspaceId = get(request, workspaceIdKey);
if (!workspaceId && optional === false) {
throw new NoPermissionException('没有空间权限');
}
if (workspaceId) {
const membersInfo = await this.workspaceMemberService.findOne({
workspaceId,
userId: user._id.toString(),
});
if (!membersInfo) {
throw new NoPermissionException('没有空间权限');
}
const userPermissions = WORKSPACE_ROLE_PERMISSION[membersInfo.role] || [];
if (
allowPermissions.some((permission) =>
userPermissions.includes(permission),
)
) {
return true;
}
throw new NoPermissionException('没有权限');
}
return true;
}
}

42
server/src/interfaces/survey.ts
View File

@ -94,58 +94,18 @@ export interface SubmitConf {
msgContent: MsgContent;
}
// 白名单类型
export enum WhitelistType {
ALL = 'ALL',
// 空间成员
MEMBER = 'MEMBER',
// 自定义
CUSTOM = 'CUSTOM',
}
// 白名单用户类型
export enum MemberType {
// 手机号
MOBILE = 'MOBILE',
// 邮箱
EMAIL = 'EMAIL',
}
export interface BaseConf {
beginTime: string;
begTime: string;
endTime: string;
answerBegTime: string;
answerEndTime: string;
tLimit: number;
language: string;
// 访问密码开关
passwordSwitch?: boolean;
// 密码
password?: string | null;
// 白名单类型
whitelistType?: WhitelistType;
// 白名单用户类型
memberType?: MemberType;
// 白名单列表
whitelist?: string[];
// 提示语
whitelistTip?: string;
}
export interface SkinConf {
skinColor: string;
inputBgColor: string;
backgroundConf: {
color: string;
type: string;
image: string;
};
contentConf: {
opacity: number;
};
themeConf: {
color: string;
};
}
export interface BottomConf {

24
server/src/logger/index.ts
View File

@ -1,18 +1,15 @@
import * as log4js from 'log4js';
import moment from 'moment';
import { Injectable, Scope, Inject } from '@nestjs/common';
import { CONTEXT, RequestContext } from '@nestjs/microservices';
import { Request } from 'express';
const log4jsLogger = log4js.getLogger();
@Injectable({ scope: Scope.REQUEST })
export class Logger {
private static inited = false;
constructor(@Inject(CONTEXT) private readonly ctx: RequestContext) {}
constructor() {}
static init(config: { filename: string }) {
if (Logger.inited) {
if (this.inited) {
return;
}
log4js.configure({
@ -33,26 +30,25 @@ export class Logger {
default: { appenders: ['app'], level: 'trace' },
},
});
Logger.inited = true;
}
_log(message, options: { dltag?: string; level: string }) {
_log(message, options: { dltag?: string; level: string; req?: Request }) {
const datetime = moment().format('YYYY-MM-DD HH:mm:ss.SSS');
const level = options?.level;
const dltag = options?.dltag ? `${options.dltag}||` : '';
const traceIdStr = this.ctx?.['traceId']
? `traceid=${this.ctx?.['traceId']}||`
const level = options.level;
const dltag = options.dltag ? `${options.dltag}||` : '';
const traceIdStr = options?.req['traceId']
? `traceid=${options?.req['traceId']}||`
: '';
return log4jsLogger[level](
`[${datetime}][${level.toUpperCase()}]${dltag}${traceIdStr}${message}`,
);
}
info(message, options?: { dltag?: string }) {
info(message, options?: { dltag?: string; req?: Request }) {
return this._log(message, { ...options, level: 'info' });
}
error(message, options?: { dltag?: string }) {
error(message, options: { dltag?: string; req?: Request }) {
return this._log(message, { ...options, level: 'error' });
}
}

8
server/src/logger/util.ts
View File

@ -10,9 +10,9 @@ const getCountStr = () => {
export const genTraceId = ({ ip }) => {
// ip转16位 + 当前时间戳（毫秒级）+自增序列（1000开始自增到9000）+ 当前进程id的后5位
ip = ip.replace('::ffff:', '').replace('::1', '');
ip = ip.replace('::ffff:', '');
let ipArr;
if (ip.indexOf(':') >= 0) {
if (ip.indexOf(':') > 0) {
ipArr = ip.split(':').map((segment) => {
// 将IPv6每个段转为16位，并补0到长度为4
return parseInt(segment, 16).toString(16).padStart(4, '0');
@ -20,9 +20,7 @@ export const genTraceId = ({ ip }) => {
} else {
ipArr = ip
.split('.')
.map((item) =>
item ? parseInt(item).toString(16).padStart(2, '0') : '',
);
.map((item) => parseInt(item).toString(16).padStart(2, '0'));
}
return `${ipArr.join('')}${Date.now().toString()}${getCountStr()}${process.pid.toString().slice(-5)}`;

1
server/src/main.ts
View File

@ -1,7 +1,6 @@
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import './report';
async function bootstrap() {
const PORT = process.env.PORT || 3000;

3
server/src/middlewares/logRequest.middleware.ts
View File

@ -1,3 +1,4 @@
// logger.middleware.ts
import { Injectable, NestMiddleware } from '@nestjs/common';
import { Request, Response, NextFunction } from 'express';
import { Logger } from '../logger/index'; // 替换为你实际的logger路径
@ -19,6 +20,7 @@ export class LogRequestMiddleware implements NestMiddleware {
`method=${method}||uri=${originalUrl}||ip=${ip}||ua=${userAgent}||query=${query}||body=${body}`,
{
dltag: 'request_in',
req,
},
);
@ -28,6 +30,7 @@ export class LogRequestMiddleware implements NestMiddleware {
`status=${res.statusCode.toString()}||duration=${duration}ms`,
{
dltag: 'request_out',
req,
},
);
});

30
server/src/models/__test/base.entity.spec.ts Normal file
View File

@ -0,0 +1,30 @@
import { BaseEntity } from '../base.entity';
import { RECORD_STATUS } from 'src/enums';
describe('BaseEntity', () => {
let baseEntity: BaseEntity;
beforeEach(() => {
baseEntity = new BaseEntity();
});
it('should initialize default info before insert', () => {
const now = Date.now();
baseEntity.initDefaultInfo();
expect(baseEntity.curStatus.status).toBe(RECORD_STATUS.NEW);
expect(baseEntity.curStatus.date).toBeCloseTo(now, -3);
expect(baseEntity.statusList).toHaveLength(1);
expect(baseEntity.statusList[0].status).toBe(RECORD_STATUS.NEW);
expect(baseEntity.statusList[0].date).toBeCloseTo(now, -3);
expect(baseEntity.createDate).toBeCloseTo(now, -3);
expect(baseEntity.updateDate).toBeCloseTo(now, -3);
});
it('should update updateDate before update', () => {
const now = Date.now();
baseEntity.onUpdate();
expect(baseEntity.updateDate).toBeCloseTo(now, -3);
});
});

57
server/src/models/__test/surveyMeta.entity.spec.ts
View File

@ -1,57 +0,0 @@
import { SurveyMeta } from '../surveyMeta.entity';
import { RECORD_STATUS, RECORD_SUB_STATUS } from 'src/enums';
// 模拟日期
const mockDateNow = Date.now();
describe('SurveyMeta Entity', () => {
let surveyMeta: SurveyMeta;
// 在每个测试之前，初始化 SurveyMeta 实例
beforeEach(() => {
surveyMeta = new SurveyMeta();
// 模拟 Date.now() 返回固定的时间
jest.spyOn(Date, 'now').mockReturnValue(mockDateNow);
});
afterEach(() => {
jest.restoreAllMocks(); // 每次测试后还原所有 mock
});
it('should set default curStatus and subStatus on insert when they are not provided', () => {
surveyMeta.initDefaultInfo();
// 验证 curStatus 是否被初始化为默认值
expect(surveyMeta.curStatus).toEqual({
status: RECORD_STATUS.NEW,
date: mockDateNow,
});
// 验证 statusList 是否包含 curStatus
expect(surveyMeta.statusList).toEqual([
{
status: RECORD_STATUS.NEW,
date: mockDateNow,
},
]);
// 验证 subStatus 是否被初始化为默认值
expect(surveyMeta.subStatus).toEqual({
status: RECORD_SUB_STATUS.DEFAULT,
date: mockDateNow,
});
});
it('should initialize statusList if curStatus is provided but statusList is empty', () => {
surveyMeta.curStatus = null;
surveyMeta.initDefaultInfo();
expect(surveyMeta.statusList).toEqual([
{
status: RECORD_STATUS.NEW,
date: expect.any(Number),
},
]);
});
});

40
server/src/models/base.entity.ts
View File

@ -1,13 +1,43 @@
import { ObjectIdColumn, CreateDateColumn, UpdateDateColumn } from 'typeorm';
import { Column, ObjectIdColumn, BeforeInsert, BeforeUpdate } from 'typeorm';
import { ObjectId } from 'mongodb';
import { RECORD_STATUS } from '../enums';
export class BaseEntity {
@ObjectIdColumn()
_id: ObjectId;
@CreateDateColumn({ type: 'timestamp', precision: 3 })
createdAt: Date;
@Column()
curStatus: {
status: RECORD_STATUS;
date: number;
};
@UpdateDateColumn({ type: 'timestamp', precision: 3 })
updatedAt: Date;
@Column()
statusList: Array<{
status: RECORD_STATUS;
date: number;
}>;
@Column()
createDate: number;
@Column()
updateDate: number;
@BeforeInsert()
initDefaultInfo() {
const now = Date.now();
if (!this.curStatus) {
const curStatus = { status: RECORD_STATUS.NEW, date: now };
this.curStatus = curStatus;
this.statusList = [curStatus];
}
this.createDate = now;
this.updateDate = now;
}
@BeforeUpdate()
onUpdate() {
this.updateDate = Date.now();
}
}

3
server/src/models/captcha.entity.ts
View File

@ -5,7 +5,8 @@ import { BaseEntity } from './base.entity';
@Entity({ name: 'captcha' })
export class Captcha extends BaseEntity {
@Index({
expireAfterSeconds: 3600,
expireAfterSeconds:
new Date(Date.now() + 2 * 60 * 60 * 1000).getTime() / 1000,
})
@ObjectIdColumn()
_id: ObjectId;

3
server/src/models/clientEncrypt.entity.ts
View File

@ -6,7 +6,8 @@ import { BaseEntity } from './base.entity';
@Entity({ name: 'clientEncrypt' })
export class ClientEncrypt extends BaseEntity {
@Index({
expireAfterSeconds: 3600,
expireAfterSeconds:
new Date(Date.now() + 2 * 60 * 60 * 1000).getTime() / 1000,
})
@ObjectIdColumn()
_id: ObjectId;

26
server/src/models/collaborator.entity.ts
View File

@ -1,26 +0,0 @@
import { Entity, Column } from 'typeorm';
import { BaseEntity } from './base.entity';
@Entity({ name: 'collaborator' })
export class Collaborator extends BaseEntity {
@Column()
surveyId: string;
@Column()
userId: string;
@Column('jsonb')
permissions: Array<string>;
@Column()
creator: string;
@Column()
creatorId: string;
@Column()
operator: string;
@Column()
operatorId: string;
}

48
server/src/models/downloadTask.entity.ts
View File

@ -1,48 +0,0 @@
import { Entity, Column } from 'typeorm';
import { BaseEntity } from './base.entity';
import { DOWNLOAD_TASK_STATUS } from 'src/enums/downloadTaskStatus';
@Entity({ name: 'downloadTask' })
export class DownloadTask extends BaseEntity {
@Column()
surveyId: string;
@Column()
surveyPath: string;
// 文件路径
@Column()
url: string;
// 文件key
@Column()
fileKey: string;
// 任务创建人
@Column()
creatorId: string;
// 任务创建人
@Column()
creator: string;
// 文件名
@Column()
filename: string;
// 文件大小
@Column()
fileSize: string;
@Column()
params: string;
@Column()
isDeleted: boolean;
@Column()
deletedAt: Date;
@Column()
status: DOWNLOAD_TASK_STATUS;
}

12
server/src/models/messagePushingTask.entity.ts
View File

@ -27,16 +27,4 @@ export class MessagePushingTask extends BaseEntity {
@Column()
ownerId: string;
@Column()
isDeleted: boolean;
@Column()
deletedAt: Date;
@Column()
operator: string;
@Column()
operatorId: string;
}

16
server/src/models/responseSchema.entity.ts
View File

@ -1,7 +1,6 @@
import { Entity, Column } from 'typeorm';
import { SurveySchemaInterface } from '../interfaces/survey';
import { BaseEntity } from './base.entity';
import { RECORD_STATUS, RECORD_SUB_STATUS } from '../enums';
@Entity({ name: 'surveyPublish' })
export class ResponseSchema extends BaseEntity {
@ -16,19 +15,4 @@ export class ResponseSchema extends BaseEntity {
@Column()
pageId: string;
@Column()
curStatus: {
status: RECORD_STATUS;
date: number;
};
@Column()
subStatus: {
status: RECORD_SUB_STATUS;
date: number;
};
@Column()
isDeleted: boolean;
}

22
server/src/models/session.entity.ts
View File

@ -1,22 +0,0 @@
import { Entity, Column, Index, ObjectIdColumn } from 'typeorm';
import { ObjectId } from 'mongodb';
import { BaseEntity } from './base.entity';
import { SESSION_STATUS } from 'src/enums/surveySessionStatus';
@Entity({ name: 'session' })
export class Session extends BaseEntity {
@Index({
expireAfterSeconds: 3600,
})
@ObjectIdColumn()
_id: ObjectId;
@Column()
surveyId: string;
@Column()
userId: string;
@Column()
status: SESSION_STATUS;
}

3
server/src/models/surveyHistory.entity.ts
View File

@ -19,7 +19,4 @@ export class SurveyHistory extends BaseEntity {
username: string;
_id: string;
};
@Column('string')
sessionId: string;
}

56
server/src/models/surveyMeta.entity.ts
View File

@ -1,6 +1,5 @@
import { Entity, Column, BeforeInsert } from 'typeorm';
import { Entity, Column } from 'typeorm';
import { BaseEntity } from './base.entity';
import { RECORD_STATUS, RECORD_SUB_STATUS } from '../enums';
@Entity({ name: 'surveyMeta' })
export class SurveyMeta extends BaseEntity {
@ -19,65 +18,12 @@ export class SurveyMeta extends BaseEntity {
@Column()
creator: string;
@Column()
creatorId: string;
@Column()
owner: string;
@Column()
ownerId: string;
@Column()
createMethod: string;
@Column()
createFrom: string;
@Column()
workspaceId: string;
@Column()
curStatus: {
status: RECORD_STATUS;
date: number;
};
@Column()
subStatus: {
status: RECORD_SUB_STATUS;
date: number;
};
@Column()
statusList: Array<{
status: RECORD_STATUS | RECORD_SUB_STATUS;
date: number;
}>;
@Column()
operator: string;
@Column()
operatorId: string;
@Column()
isDeleted: boolean;
@Column()
deletedAt: Date;
@BeforeInsert()
initDefaultInfo() {
const now = Date.now();
if (!this.curStatus) {
const curStatus = { status: RECORD_STATUS.NEW, date: now };
this.curStatus = curStatus;
this.statusList = [curStatus];
}
if (!this.subStatus) {
const subStatus = { status: RECORD_SUB_STATUS.DEFAULT, date: now };
this.subStatus = subStatus;
}
}
}

6
server/src/models/surveyResponse.entity.ts
View File

@ -14,7 +14,7 @@ export class SurveyResponse extends BaseEntity {
data: Record<string, any>;
@Column()
diffTime: number;
difTime: number;
@Column()
clientTime: number;
@ -27,11 +27,11 @@ export class SurveyResponse extends BaseEntity {
@BeforeInsert()
async onDataInsert() {
return await pluginManager.triggerHook('encryptResponseData', this);
return await pluginManager.triggerHook('beforeResponseDataCreate', this);
}
@AfterLoad()
async onDataLoaded() {
return await pluginManager.triggerHook('decryptResponseData', this);
return await pluginManager.triggerHook('afterResponseDataReaded', this);
}
}

35
server/src/models/workspace.entity.ts
View File

@ -1,35 +0,0 @@
import { Entity, Column } from 'typeorm';
import { BaseEntity } from './base.entity';
@Entity({ name: 'workspace' })
export class Workspace extends BaseEntity {
@Column()
creatorId: string;
@Column()
creator: string;
@Column()
ownerId: string;
@Column()
owner: string;
@Column()
name: string;
@Column()
description: string;
@Column()
operator: string;
@Column()
operatorId: string;
@Column()
isDeleted: boolean;
@Column()
deletedAt: Date;
}

26
server/src/models/workspaceMember.entity.ts
View File

@ -1,26 +0,0 @@
import { Entity, Column } from 'typeorm';
import { BaseEntity } from './base.entity';
@Entity({ name: 'workspaceMember' })
export class WorkspaceMember extends BaseEntity {
@Column()
userId: string;
@Column()
workspaceId: string;
@Column()
role: string;
@Column()
creator: string;
@Column()
creatorId: string;
@Column()
operator: string;
@Column()
operatorId: string;
}

82
server/src/modules/auth/__test/auth.controller.spec.ts
View File

@ -82,22 +82,6 @@ describe('AuthController', () => {
new HttpException('验证码不正确', EXCEPTION_CODE.CAPTCHA_INCORRECT),
);
});
it('should throw HttpException with PASSWORD_INVALID code when password is invalid', async () => {
const mockUserInfo = {
username: 'testUser',
password: '无效的密码abc123',
captchaId: 'testCaptchaId',
captcha: 'testCaptcha',
};
await expect(controller.register(mockUserInfo)).rejects.toThrow(
new HttpException(
'密码只能输入数字、字母、特殊字符',
EXCEPTION_CODE.PASSWORD_INVALID,
),
);
});
});
describe('login', () => {
@ -112,21 +96,12 @@ describe('AuthController', () => {
jest
.spyOn(captchaService, 'checkCaptchaIsCorrect')
.mockResolvedValue(true);
jest.spyOn(userService, 'getUser').mockResolvedValue(
Promise.resolve({
username: 'testUser',
_id: new ObjectId(),
} as User),
);
jest.spyOn(userService, 'getUserByUsername').mockResolvedValue(
Promise.resolve({
username: 'testUser',
_id: new ObjectId(),
} as User),
);
jest.spyOn(authService, 'generateToken').mockResolvedValue('testToken');
const result = await controller.login(mockUserInfo);
@ -168,40 +143,10 @@ describe('AuthController', () => {
jest
.spyOn(captchaService, 'checkCaptchaIsCorrect')
.mockResolvedValue(true);
jest.spyOn(userService, 'getUserByUsername').mockResolvedValue(null);
await expect(controller.login(mockUserInfo)).rejects.toThrow(
new HttpException(
'账号未注册，请进行注册',
EXCEPTION_CODE.USER_NOT_EXISTS,
),
);
});
it('should throw HttpException with USER_NOT_EXISTS code when user is not found', async () => {
const mockUserInfo = {
username: 'testUser',
password: 'testPassword',
captchaId: 'testCaptchaId',
captcha: 'testCaptcha',
};
jest
.spyOn(captchaService, 'checkCaptchaIsCorrect')
.mockResolvedValue(true);
jest.spyOn(userService, 'getUserByUsername').mockResolvedValue(
Promise.resolve({
username: 'testUser',
_id: new ObjectId(),
} as User),
);
jest.spyOn(userService, 'getUser').mockResolvedValue(null);
await expect(controller.login(mockUserInfo)).rejects.toThrow(
new HttpException(
'用户名或密码错误',
EXCEPTION_CODE.USER_PASSWORD_WRONG,
),
new HttpException('用户名或密码错误', EXCEPTION_CODE.USER_NOT_EXISTS),
);
});
});
@ -220,29 +165,4 @@ describe('AuthController', () => {
expect(typeof result.data.img).toBe('string');
});
});
describe('password strength', () => {
it('it should return strong', async () => {
await expect(
controller.getPasswordStrength('abcd&1234'),
).resolves.toEqual({
code: 200,
data: 'Strong',
});
});
it('it should return medium', async () => {
await expect(controller.getPasswordStrength('abc123')).resolves.toEqual({
code: 200,
data: 'Medium',
});
});
it('it should return weak', async () => {
await expect(controller.getPasswordStrength('123456')).resolves.toEqual({
code: 200,
data: 'Weak',
});
});
});
});

34
server/src/modules/auth/__test/auth.service.spec.ts
View File

@ -1,33 +1,18 @@
import { Test, TestingModule } from '@nestjs/testing';
import { ConfigModule } from '@nestjs/config';
import * as jwt from 'jsonwebtoken';
import { User } from 'src/models/user.entity';
import { AuthService } from '../services/auth.service';
import { UserService } from '../services/user.service';
import { sign } from 'jsonwebtoken';
jest.mock('jsonwebtoken', () => {
return {
sign: jest.fn(),
verify: jest.fn().mockReturnValue({}),
};
});
jest.mock('jsonwebtoken');
describe('AuthService', () => {
let service: AuthService;
let userService: UserService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
imports: [ConfigModule],
providers: [
AuthService,
{ provide: UserService, useValue: { getUserByUsername: jest.fn() } },
],
providers: [AuthService],
}).compile();
service = module.get<AuthService>(AuthService);
userService = module.get<UserService>(UserService);
});
describe('generateToken', () => {
@ -40,20 +25,9 @@ describe('AuthService', () => {
await service.generateToken(userData, tokenConfig);
expect(jwt.sign).toHaveBeenCalledWith(userData, tokenConfig.secret, {
expect(sign).toHaveBeenCalledWith(userData, tokenConfig.secret, {
expiresIn: tokenConfig.expiresIn,
});
});
});
describe('verifyToken', () => {
it('should verifyToken succeed', async () => {
const token = 'mock token';
jest
.spyOn(userService, 'getUserByUsername')
.mockResolvedValue({} as User);
await service.verifyToken(token);
expect(userService.getUserByUsername).toHaveBeenCalledTimes(1);
});
});
});

82
server/src/modules/auth/__test/user.controller.spec.ts
View File

@ -1,82 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { UserController } from '../controllers/user.controller';
import { UserService } from '../services/user.service';
import { GetUserListDto } from '../dto/getUserList.dto';
import { Authentication } from 'src/guards/authentication.guard';
import { HttpException } from 'src/exceptions/httpException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import { User } from 'src/models/user.entity';
describe('UserController', () => {
let userController: UserController;
let userService: UserService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [UserController],
providers: [
{
provide: UserService,
useValue: {
getUserListByUsername: jest.fn(),
},
},
],
})
.overrideGuard(Authentication)
.useValue({ canActivate: jest.fn(() => true) })
.compile();
userController = module.get<UserController>(UserController);
userService = module.get<UserService>(UserService);
});
describe('getUserList', () => {
it('should return a list of users', async () => {
const mockUserList = [
{ _id: '1', username: 'user1' },
{ _id: '2', username: 'user2' },
];
jest
.spyOn(userService, 'getUserListByUsername')
.mockResolvedValue(mockUserList as unknown as User[]);
const queryInfo: GetUserListDto = {
username: 'testuser',
pageIndex: 1,
pageSize: 10,
};
GetUserListDto.validate = jest
.fn()
.mockReturnValue({ value: queryInfo, error: null });
const result = await userController.getUserList(queryInfo);
expect(result).toEqual({
code: 200,
data: mockUserList.map((item) => ({
userId: item._id,
username: item.username,
})),
});
});
it('should throw an HttpException if validation fails', async () => {
const queryInfo: GetUserListDto = {
username: 'testuser',
pageIndex: 1,
pageSize: 10,
};
const validationError = new Error('Validation failed');
GetUserListDto.validate = jest
.fn()
.mockReturnValue({ value: null, error: validationError });
await expect(userController.getUserList(queryInfo)).rejects.toThrow(
new HttpException('参数有误', EXCEPTION_CODE.PARAMETER_ERROR),
);
});
});
});

129
server/src/modules/auth/__test/user.service.spec.ts
View File

@ -5,7 +5,6 @@ import { UserService } from '../services/user.service';
import { User } from 'src/models/user.entity';
import { HttpException } from 'src/exceptions/httpException';
import { hash256 } from 'src/utils/hash256';
import { ObjectId } from 'mongodb';
describe('UserService', () => {
let service: UserService;
@ -21,7 +20,6 @@ describe('UserService', () => {
create: jest.fn(),
save: jest.fn(),
findOne: jest.fn(),
find: jest.fn(),
},
},
],
@ -33,10 +31,6 @@ describe('UserService', () => {
);
});
it('should be defined', () => {
expect(service).toBeDefined();
});
it('should create a user', async () => {
const userInfo = {
username: 'testUser',
@ -107,7 +101,7 @@ describe('UserService', () => {
expect(user).toEqual({ ...userInfo, password: hashedPassword });
});
it('should return null when user is not found by credentials', async () => {
it('should return undefined when user is not found by credentials', async () => {
const userInfo = {
username: 'nonExistingUser',
password: 'nonExistingPassword',
@ -134,132 +128,15 @@ describe('UserService', () => {
const userInfo = {
username: username,
password: 'existingPassword',
curStatus: { status: 'ACTIVE' },
} as unknown as User;
} as User;
jest.spyOn(userRepository, 'findOne').mockResolvedValue(userInfo);
const user = await service.getUserByUsername(username);
expect(userRepository.findOne).toHaveBeenCalledWith({
where: {
username: username,
},
where: { username: username },
});
expect(user).toEqual(userInfo);
});
it('should return null when user is not found by username', async () => {
const username = 'nonExistingUser';
const findOneSpy = jest
.spyOn(userRepository, 'findOne')
.mockResolvedValue(null);
const user = await service.getUserByUsername(username);
expect(findOneSpy).toHaveBeenCalledWith({
where: {
username: username,
},
});
expect(user).toBe(null);
});
it('should return a user by id', async () => {
const id = '60c72b2f9b1e8a5f4b123456';
const userInfo = {
_id: new ObjectId(id),
username: 'testUser',
curStatus: { status: 'ACTIVE' },
} as unknown as User;
jest.spyOn(userRepository, 'findOne').mockResolvedValue(userInfo);
const user = await service.getUserById(id);
expect(userRepository.findOne).toHaveBeenCalledWith({
where: {
_id: new ObjectId(id),
},
});
expect(user).toEqual(userInfo);
});
it('should return null when user is not found by id', async () => {
const id = '60c72b2f9b1e8a5f4b123456';
const findOneSpy = jest
.spyOn(userRepository, 'findOne')
.mockResolvedValue(null);
const user = await service.getUserById(id);
expect(findOneSpy).toHaveBeenCalledWith({
where: {
_id: new ObjectId(id),
},
});
expect(user).toBe(null);
});
it('should return a list of users by username', async () => {
const username = 'test';
const userList = [
{ _id: new ObjectId(), username: 'testUser1', createdAt: new Date() },
{ _id: new ObjectId(), username: 'testUser2', createdAt: new Date() },
];
jest
.spyOn(userRepository, 'find')
.mockResolvedValue(userList as unknown as User[]);
const result = await service.getUserListByUsername({
username,
skip: 0,
take: 10,
});
expect(userRepository.find).toHaveBeenCalledWith({
where: {
username: new RegExp(username),
},
skip: 0,
take: 10,
select: ['_id', 'username', 'createdAt'],
});
expect(result).toEqual(userList);
});
it('should return a list of users by ids', async () => {
const idList = ['60c72b2f9b1e8a5f4b123456', '60c72b2f9b1e8a5f4b123457'];
const userList = [
{
_id: new ObjectId(idList[0]),
username: 'testUser1',
createdAt: new Date(),
},
{
_id: new ObjectId(idList[1]),
username: 'testUser2',
createdAt: new Date(),
},
];
jest
.spyOn(userRepository, 'find')
.mockResolvedValue(userList as unknown as User[]);
const result = await service.getUserListByIds({ idList });
expect(userRepository.find).toHaveBeenCalledWith({
where: {
_id: {
$in: idList.map((id) => new ObjectId(id)),
},
},
select: ['_id', 'username', 'createdAt'],
});
expect(result).toEqual(userList);
});
});

3
server/src/modules/auth/auth.module.ts
View File

@ -4,7 +4,6 @@ import { AuthService } from './services/auth.service';
import { CaptchaService } from './services/captcha.service';
import { AuthController } from './controllers/auth.controller';
import { UserController } from './controllers/user.controller';
import { User } from 'src/models/user.entity';
import { Captcha } from 'src/models/captcha.entity';
@ -14,7 +13,7 @@ import { ConfigModule } from '@nestjs/config';
@Module({
imports: [TypeOrmModule.forFeature([User, Captcha]), ConfigModule],
controllers: [AuthController, UserController],
controllers: [AuthController],
providers: [UserService, AuthService, CaptchaService],
exports: [UserService, AuthService],
})

98
server/src/modules/auth/controllers/auth.controller.ts
View File

@ -1,12 +1,4 @@
import {
Controller,
Post,
Body,
HttpCode,
Get,
Query,
Request,
} from '@nestjs/common';
import { Controller, Post, Body, HttpCode } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { UserService } from '../services/user.service';
import { CaptchaService } from '../services/captcha.service';
@ -15,9 +7,6 @@ import { HttpException } from 'src/exceptions/httpException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import { create } from 'svg-captcha';
import { ApiTags } from '@nestjs/swagger';
const passwordReg = /^[a-zA-Z0-9!@#$%^&*()_+\-=[\]{};':"\\|,.<>/?]+$/;
@ApiTags('auth')
@Controller('/api/auth')
export class AuthController {
@ -39,24 +28,6 @@ export class AuthController {
captcha: string;
},
) {
if (!userInfo.password) {
throw new HttpException('密码无效', EXCEPTION_CODE.PASSWORD_INVALID);
}
if (userInfo.password.length < 6 || userInfo.password.length > 16) {
throw new HttpException(
'密码长度在 6 到 16 个字符',
EXCEPTION_CODE.PASSWORD_INVALID,
);
}
if (!passwordReg.test(userInfo.password)) {
throw new HttpException(
'密码只能输入数字、字母、特殊字符',
EXCEPTION_CODE.PASSWORD_INVALID,
);
}
const isCorrect = await this.captchaService.checkCaptchaIsCorrect({
captcha: userInfo.captcha,
id: userInfo.captchaId,
@ -114,16 +85,6 @@ export class AuthController {
throw new HttpException('验证码不正确', EXCEPTION_CODE.CAPTCHA_INCORRECT);
}
const username = await this.userService.getUserByUsername(
userInfo.username,
);
if (!username) {
throw new HttpException(
'账号未注册，请进行注册',
EXCEPTION_CODE.USER_NOT_EXISTS,
);
}
const user = await this.userService.getUser({
username: userInfo.username,
password: userInfo.password,
@ -131,7 +92,7 @@ export class AuthController {
if (user === null) {
throw new HttpException(
'用户名或密码错误',
EXCEPTION_CODE.USER_PASSWORD_WRONG,
EXCEPTION_CODE.USER_NOT_EXISTS,
);
}
let token;
@ -191,59 +152,4 @@ export class AuthController {
},
};
}
/**
* 密码强度
*/
@Get('/password/strength')
@HttpCode(200)
async getPasswordStrength(@Query('password') password: string) {
const numberReg = /[0-9]/.test(password);
const letterReg = /[a-zA-Z]/.test(password);
const symbolReg = /[!@#$%^&*()_+\-=[\]{};':"\\|,.<>/?]/.test(password);
// 包含三种、且长度大于8
if (numberReg && letterReg && symbolReg && password.length >= 8) {
return {
code: 200,
data: 'Strong',
};
}
// 满足任意两种
if ([numberReg, letterReg, symbolReg].filter(Boolean).length >= 2) {
return {
code: 200,
data: 'Medium',
};
}
return {
code: 200,
data: 'Weak',
};
}
@Get('/verifyToken')
@HttpCode(200)
async verifyToken(@Request() req) {
const token = req.headers.authorization?.split(' ')[1];
if (!token) {
return {
code: 200,
data: false,
};
}
try {
await this.authService.verifyToken(token);
return {
code: 200,
data: true,
};
} catch (error) {
return {
code: 200,
data: false,
};
}
}
}

65
server/src/modules/auth/controllers/user.controller.ts
View File

@ -1,65 +0,0 @@
import {
Controller,
Get,
Query,
HttpCode,
UseGuards,
Request,
} from '@nestjs/common';
import { ApiTags, ApiBearerAuth } from '@nestjs/swagger';
import { Authentication } from 'src/guards/authentication.guard';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import { HttpException } from 'src/exceptions/httpException';
import { UserService } from '../services/user.service';
import { GetUserListDto } from '../dto/getUserList.dto';
@ApiTags('user')
@ApiBearerAuth()
@Controller('/api/user')
export class UserController {
constructor(private readonly userService: UserService) {}
@UseGuards(Authentication)
@Get('/getUserList')
@HttpCode(200)
async getUserList(
@Query()
queryInfo: GetUserListDto,
) {
const { value, error } = GetUserListDto.validate(queryInfo);
if (error) {
throw new HttpException('参数有误', EXCEPTION_CODE.PARAMETER_ERROR);
}
const userList = await this.userService.getUserListByUsername({
username: value.username,
skip: (value.pageIndex - 1) * value.pageSize,
take: value.pageSize,
});
return {
code: 200,
data: userList.map((item) => {
return {
userId: item._id.toString(),
username: item.username,
};
}),
};
}
@UseGuards(Authentication)
@Get('/getUserInfo')
async getUserInfo(@Request() req) {
return {
code: 200,
data: {
userId: req.user._id.toString(),
username: req.user.username,
},
};
}
}

21
server/src/modules/auth/dto/getUserList.dto.ts
View File

@ -1,21 +0,0 @@
import { ApiProperty } from '@nestjs/swagger';
import Joi from 'joi';
export class GetUserListDto {
@ApiProperty({ description: '用户名', required: true })
username: string;
@ApiProperty({ description: '页码', required: false, default: 1 })
pageIndex?: number;
@ApiProperty({ description: '每页查询数', required: false, default: 10 })
pageSize: number;
static validate(data) {
return Joi.object({
username: Joi.string().required(),
pageIndex: Joi.number().allow(null).default(1),
pageSize: Joi.number().allow(null).default(10),
}).validate(data);
}
}

35
server/src/modules/auth/services/user.service.ts
View File

@ -5,7 +5,6 @@ import { User } from 'src/models/user.entity';
import { HttpException } from 'src/exceptions/httpException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import { hash256 } from 'src/utils/hash256';
import { ObjectId } from 'mongodb';
@Injectable()
export class UserService {
@ -57,38 +56,4 @@ export class UserService {
return user;
}
async getUserById(id: string) {
const user = await this.userRepository.findOne({
where: {
_id: new ObjectId(id),
},
});
return user;
}
async getUserListByUsername({ username, skip, take }) {
const list = await this.userRepository.find({
where: {
username: new RegExp(username),
},
skip,
take,
select: ['_id', 'username', 'createdAt'],
});
return list;
}
async getUserListByIds({ idList }) {
const list = await this.userRepository.find({
where: {
_id: {
$in: idList.map((item) => new ObjectId(item)),
},
},
select: ['_id', 'username', 'createdAt'],
});
return list;
}
}

55
server/src/modules/file/__test/alioss.handler.spec.ts
View File

@ -1,55 +0,0 @@
import { AliOssHandler } from '../services/uploadHandlers/alioss.handler';
describe('AliOssHandler', () => {
describe('upload', () => {
it('should upload a file and return the key', async () => {
const file = {
originalname: 'mockFileName.txt',
buffer: Buffer.from('mockFileContent'),
} as Express.Multer.File;
const mockPutResult = { name: 'mockFileName.txt' };
const mockClient: any = {
put: jest.fn().mockResolvedValue(mockPutResult),
};
const handler = new AliOssHandler({
client: mockClient,
useSSL: true,
isPrivateRead: true,
expiryTime: '1h',
});
const result = await handler.upload(file);
expect(result).toEqual({
key: expect.stringMatching(/\w+\.txt/),
});
});
});
describe('getUrl', () => {
it('should return the URL for the given key', () => {
const key = 'mockFilePath/mockFileName.txt';
const bucket = 'xiaojusurvey';
const accessKey = 'mockAccessKey';
const region = 'mockRegion';
const handler = new AliOssHandler({
accessKey,
secretKey: 'mockSecretKey',
bucket,
region,
endPoint: 'mockEndPoint',
useSSL: true,
isPrivateRead: true,
expiryTime: '1h',
});
const result = handler.getUrl(key);
const keyReg = new RegExp(key);
const signatureReg = new RegExp('Signature=');
const expiredReg = new RegExp('Expires=');
expect(keyReg.test(result)).toBe(true);
expect(signatureReg.test(result)).toBe(true);
expect(expiredReg.test(result)).toBe(true);
});
});
});

150
server/src/modules/file/__test/file.controller.spec.ts
View File

@ -1,150 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { FileController } from '../controllers/file.controller';
import { FileService } from '../services/file.service';
import { uploadConfig, channels } from '../config/index';
import { AuthenticationException } from 'src/exceptions/authException';
import { HttpException } from 'src/exceptions/httpException';
import { AuthService } from 'src/modules/auth/services/auth.service';
import { User } from 'src/models/user.entity';
describe('FileController', () => {
let controller: FileController;
let fileService: FileService;
let authService: AuthService;
// let configService: ConfigService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
imports: [
ConfigModule.forFeature(() => {
return {
...channels,
...uploadConfig,
};
}),
],
controllers: [FileController],
providers: [
FileService,
{
provide: AuthService,
useValue: {
verifyToken: jest.fn(),
},
},
ConfigService,
],
}).compile();
controller = module.get<FileController>(FileController);
fileService = module.get<FileService>(FileService);
authService = module.get<AuthService>(AuthService);
// configService = module.get<ConfigService>(ConfigService);
});
describe('upload', () => {
it('should upload a file', async () => {
const file: Express.Multer.File = {
fieldname: '',
originalname: '',
encoding: '',
mimetype: '',
size: 0,
stream: null,
destination: '',
filename: '',
path: '',
buffer: null,
};
const req = { headers: { authorization: 'Bearer mockToken' } };
const reqBody = { channel: 'upload' };
jest.spyOn(authService, 'verifyToken').mockResolvedValueOnce({} as User);
const mockUploadResult = { key: 'mockKey', url: 'mockUrl' };
jest.spyOn(fileService, 'upload').mockResolvedValueOnce(mockUploadResult);
const result = await controller.upload(file, req, reqBody);
expect(result).toEqual({
code: 200,
data: {
url: mockUploadResult.url,
key: mockUploadResult.key,
},
});
});
it('should upload failed without token', async () => {
const file: Express.Multer.File = {
fieldname: '',
originalname: '',
encoding: '',
mimetype: '',
size: 0,
stream: null,
destination: '',
filename: '',
path: '',
buffer: null,
};
const req = { headers: { authorization: '' } };
const reqBody = { channel: 'upload' };
await expect(controller.upload(file, req, reqBody)).rejects.toThrow(
AuthenticationException,
);
});
it('should upload failed', async () => {
const file: Express.Multer.File = {
fieldname: '',
originalname: '',
encoding: '',
mimetype: '',
size: 0,
stream: null,
destination: '',
filename: '',
path: '',
buffer: null,
};
const req = { headers: { authorization: 'Bearer mockToken' } };
const reqBody = { channel: 'mockChannel' };
await expect(controller.upload(file, req, reqBody)).rejects.toThrow(
HttpException,
);
});
});
describe('generateGetUrl', () => {
it('should generate a URL for the given channel and key', async () => {
const reqBody = { channel: 'upload', key: 'mockKey' };
const mockUrl = 'mockGeneratedUrl';
jest.spyOn(fileService, 'getUrl').mockReturnValueOnce(mockUrl);
const result = await controller.generateGetUrl(reqBody);
expect(result).toEqual({
code: 200,
data: {
key: reqBody.key,
url: mockUrl,
},
});
});
it('should generate a URL failed', async () => {
const reqBody = { channel: 'mockChannel', key: 'mockKey' };
await expect(controller.generateGetUrl(reqBody)).rejects.toThrow(
HttpException,
);
});
});
});

65
server/src/modules/file/__test/file.service.spec.ts
View File

@ -1,65 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { FileService } from '../services/file.service';
import { LocalHandler } from '../services/uploadHandlers/local.handler';
import { uploadConfig, channels } from '../config/index';
describe('FileService', () => {
let fileService: FileService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
imports: [
ConfigModule.forFeature(() => {
return {
...channels,
...uploadConfig,
};
}),
],
providers: [FileService, ConfigService],
}).compile();
fileService = module.get<FileService>(FileService);
});
describe('upload', () => {
it('should upload a file and return key and URL', async () => {
const configKey = 'mockConfigKey';
const file = {} as Express.Multer.File;
const pathPrefix = 'mockPathPrefix';
const mockKey = 'mockKey';
jest
.spyOn(LocalHandler.prototype, 'upload')
.mockResolvedValueOnce({ key: mockKey });
const mockUrl = 'mockUrl';
jest
.spyOn(LocalHandler.prototype, 'getUrl')
.mockResolvedValueOnce(mockUrl as never);
const result = await fileService.upload({ configKey, file, pathPrefix });
expect(result).toEqual({
key: mockKey,
url: mockUrl,
});
});
});
describe('getUrl', () => {
it('should return URL for the given configKey and key', async () => {
const configKey = 'mockConfigKey';
const key = 'mockKey';
const mockUrl = 'mockUrl';
jest.spyOn(LocalHandler.prototype, 'getUrl').mockReturnValueOnce(mockUrl);
const result = fileService.getUrl({ configKey, key });
expect(result).toEqual(mockUrl);
});
});
});

32
server/src/modules/file/__test/local.handler.spec.ts
View File

@ -1,32 +0,0 @@
import { join } from 'path';
import { LocalHandler } from '../services/uploadHandlers/local.handler';
describe('LocalHandler', () => {
describe('upload', () => {
it('should upload a file and return the key', async () => {
const file = {
originalname: `mockFileName.txt`,
buffer: Buffer.from('mockFileContent'),
} as Express.Multer.File;
const physicalRootPath = join(__dirname, 'tmp');
const handler = new LocalHandler({ physicalRootPath });
const result = await handler.upload(file);
expect(result).toEqual({
key: expect.stringMatching(/\w+\.txt/),
});
});
});
describe('getUrl', () => {
it('should return the URL for the given key', () => {
const key = 'mockFilePath/mockFileName.txt';
const physicalRootPath = join(__dirname, 'tmp');
const handler = new LocalHandler({ physicalRootPath });
const result = handler.getUrl(key);
expect(result).toBe(`/${key}`);
});
});
});

75
server/src/modules/file/__test/minio.handler.spec.ts
View File

@ -1,75 +0,0 @@
import { Client } from 'minio';
import { MinIOHandler } from '../services/uploadHandlers/minio.handler';
import { HttpException } from 'src/exceptions/httpException';
describe('MinIOHandler', () => {
describe('upload', () => {
it('should upload a file and return the key', async () => {
const file = {
originalname: 'mockFileName.txt',
buffer: Buffer.from('mockFileContent'),
} as Express.Multer.File;
const mockPutObjectFn = jest.fn().mockResolvedValueOnce({});
const mockClient = {
putObject: mockPutObjectFn,
};
const handler = new MinIOHandler({
client: mockClient as unknown as Client,
useSSL: true,
isPrivateRead: true,
expiryTime: '1h',
});
const result = await handler.upload(file);
expect(result).toEqual({
key: expect.stringMatching('.txt'),
});
expect(mockPutObjectFn).toHaveBeenCalledTimes(1);
});
it('should throw an HttpException if upload fails', async () => {
const file = {
originalname: 'mockFileName.txt',
buffer: Buffer.from('mockFileContent'),
} as Express.Multer.File;
const mockPutObjectFn = jest
.fn()
.mockRejectedValueOnce(new Error('Upload failed'));
const mockClient = {
putObject: mockPutObjectFn,
};
const handler = new MinIOHandler({
client: mockClient as unknown as Client,
useSSL: true,
isPrivateRead: true,
expiryTime: '1h',
});
await expect(handler.upload(file)).rejects.toThrow(HttpException);
});
});
describe('getUrl', () => {
it('should return the URL for the given key', async () => {
const key = 'mockFilePath/mockFileName.txt';
const handler = new MinIOHandler({
accessKey: 'mockAccessKey',
secretKey: 'mockSecretKey',
bucket: 'xiaojusurvey',
region: 'mockRegion',
endPoint: 'mockEndPoint',
useSSL: true,
isPrivateRead: true,
expiryTime: '1h',
});
const result = await handler.getUrl(key);
const keyReg = new RegExp(key);
const signatureReg = new RegExp('X-Amz-Signature=');
expect(keyReg.test(result)).toBe(true);
expect(signatureReg.test(result)).toBe(true);
});
});
});

102
server/src/modules/file/__test/qiniu.handler.spec.ts
View File

@ -1,102 +0,0 @@
// In your test file
import { QiniuHandler } from '../services/uploadHandlers/qiniu.handler';
import qiniu from 'qiniu';
jest.mock('qiniu', () => ({
auth: {
digest: {
Mac: jest.fn(),
},
},
conf: {
Config: jest.fn(),
Zone: jest.fn(),
},
form_up: {
FormUploader: jest.fn().mockImplementation(() => {
return {
put: jest
.fn()
.mockImplementation(
(uploadToken, key, buffer, putExtra, callback) => {
callback && callback(null, null, { statusCode: 200 });
},
),
};
}),
PutExtra: jest.fn(),
},
rs: {
PutPolicy: jest.fn().mockImplementation(() => {
return {
uploadToken: jest.fn(),
};
}),
BucketManager: jest.fn().mockImplementation(() => {
return {
privateDownloadUrl: jest.fn().mockReturnValue(''),
publicDownloadUrl: jest.fn().mockReturnValue(''),
};
}),
},
}));
describe('QiniuHandler', () => {
describe('upload', () => {
it('should upload a file and return the key', async () => {
const file = {
originalname: 'mockFileName.txt',
buffer: Buffer.from('mockFileContent'),
} as Express.Multer.File;
const mockMacInstance = {
sign: jest.fn(),
};
jest
.spyOn(qiniu.auth.digest, 'Mac')
.mockImplementation(() => mockMacInstance as any);
// Create a new instance of QiniuHandler
const handler = new QiniuHandler({
accessKey: 'mockAccessKey',
secretKey: 'mockSecretKey',
bucket: 'mockBucket',
endPoint: 'mockEndPoint',
useSSL: true,
isPrivateRead: true,
expiryTime: '1h',
});
const result = await handler.upload(file);
expect(result).toEqual({
key: expect.stringMatching('.txt'),
});
expect(qiniu.auth.digest.Mac).toHaveBeenCalledWith(
'mockAccessKey',
'mockSecretKey',
);
expect(qiniu.form_up.FormUploader).toHaveBeenCalled();
});
});
describe('getUrl', () => {
it('should return the URL for the given key', async () => {
const key = 'mockFilePath/mockFileName.txt';
const handler = new QiniuHandler({
accessKey: 'mockAccessKey',
secretKey: 'mockSecretKey',
bucket: 'xiaojusurvey',
endPoint: 'mockEndPoint',
useSSL: true,
isPrivateRead: true,
expiryTime: '1h',
});
const result = await handler.getUrl(key);
expect(typeof result).toBe('string');
});
});
});

28
server/src/modules/file/controllers/file.controller.ts
View File

@ -8,16 +8,14 @@ import {
Body,
} from '@nestjs/common';
import { FileInterceptor } from '@nestjs/platform-express';
import { ConfigService } from '@nestjs/config';
import { ApiTags } from '@nestjs/swagger';
import { FileService } from '../services/file.service';
import { HttpException } from 'src/exceptions/httpException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import { AuthService } from 'src/modules/auth/services/auth.service';
import { AuthenticationException } from 'src/exceptions/authException';
import { ConfigService } from '@nestjs/config';
@ApiTags('file')
@Controller('/api/file')
export class FileController {
constructor(
@ -26,6 +24,26 @@ export class FileController {
private readonly configService: ConfigService,
) {}
private getPathPrefix(fileKeyPrefix: string, data: Record<string, string>) {
const regex = /\{([^}]*)\}/g;
let matches;
const keys = [];
while ((matches = regex.exec(fileKeyPrefix)) !== null) {
keys.push(matches[1]);
}
let result = fileKeyPrefix;
for (const key of keys) {
if (!data[key]) {
throw new HttpException(
`参数有误：${data[key]}`,
EXCEPTION_CODE.PARAMETER_ERROR,
);
}
result = result.replace(new RegExp(`{${key}}`), data[key]);
}
return result;
}
@Post('upload')
@HttpCode(200)
@UseInterceptors(FileInterceptor('file'))
@ -38,12 +56,12 @@ export class FileController {
if (!channel || !this.configService.get<string>(channel)) {
throw new HttpException(
`参数有误channel不正确:${reqBody.channel}`,
`参数有误：${channel}`,
EXCEPTION_CODE.PARAMETER_ERROR,
);
}
const configKey = this.configService.get<string>(channel);
const needAuth = this.configService.get<boolean>(`${configKey}.NEED_AUTH`);
const needAuth = this.configService.get<boolean>(configKey);
if (needAuth) {
const token = req.headers.authorization?.split(' ')[1];

11
server/src/modules/file/services/file.service.ts
View File

@ -10,22 +10,21 @@ import { LocalHandler } from './uploadHandlers/local.handler';
export class FileService {
constructor(private readonly configService: ConfigService) {}
private getConfig<T>(channel, key) {
return this.configService.get<T>(channel + '_' + key);
}
async upload({
configKey,
file,
pathPrefix,
filename,
}: {
configKey: string;
file: Express.Multer.File;
pathPrefix: string;
filename?: string;
}) {
const handler = this.getHandler(configKey);
const { key } = await handler.upload(file, {
pathPrefix,
filename,
});
const { key } = await handler.upload(file, { pathPrefix });
const url = await handler.getUrl(key);
return {
key,

15
server/src/modules/file/services/uploadHandlers/alioss.handler.ts
View File

@ -11,7 +11,6 @@ export class AliOssHandler implements FileUploadHandler {
isPrivateRead: boolean;
expiryTime: string;
constructor({
client,
accessKey,
secretKey,
bucket,
@ -20,25 +19,13 @@ export class AliOssHandler implements FileUploadHandler {
useSSL,
isPrivateRead,
expiryTime,
}: {
client?: OSS;
accessKey?: string;
secretKey?: string;
bucket?: string;
region?: string;
endPoint?: string;
useSSL?: boolean;
isPrivateRead?: boolean;
expiryTime?: string;
}) {
if (!client) {
client = new OSS({
const client = new OSS({
region,
accessKeyId: accessKey,
accessKeySecret: secretKey,
bucket,
});
}
this.client = client;
this.endPoint = endPoint;
this.useSSL = useSSL;

19
server/src/modules/file/services/uploadHandlers/local.handler.ts
View File

@ -1,4 +1,4 @@
import { join, dirname, sep } from 'path';
import { join, dirname } from 'path';
import fse from 'fs-extra';
import { createWriteStream } from 'fs';
import { FileUploadHandler } from './uploadHandler.interface';
@ -12,20 +12,13 @@ export class LocalHandler implements FileUploadHandler {
async upload(
file: Express.Multer.File,
options?: { pathPrefix?: string; filename?: string },
options?: { pathPrefix?: string },
): Promise<{ key: string }> {
let filename;
if (options?.filename) {
filename = file.filename;
} else {
filename = await generateUniqueFilename(file.originalname);
}
const filename = await generateUniqueFilename(file.originalname);
const filePath = join(
options?.pathPrefix ? options?.pathPrefix : '',
filename,
)
.split(sep)
.join('/');
);
const physicalPath = join(this.physicalRootPath, filePath);
await fse.mkdir(dirname(physicalPath), { recursive: true });
const writeStream = createWriteStream(physicalPath);
@ -42,10 +35,6 @@ export class LocalHandler implements FileUploadHandler {
}
getUrl(key: string): string {
if (process.env.SERVER_ENV === 'local') {
const port = process.env.PORT || 3000;
return `http://localhost:${port}/${key}`;
}
return `/${key}`;
}
}

15
server/src/modules/file/services/uploadHandlers/minio.handler.ts
View File

@ -14,7 +14,6 @@ export class MinIOHandler implements FileUploadHandler {
expiryTime: string;
bucket: string;
constructor({
client,
accessKey,
secretKey,
bucket,
@ -23,19 +22,8 @@ export class MinIOHandler implements FileUploadHandler {
useSSL,
isPrivateRead,
expiryTime,
}: {
client?: Client;
accessKey?: string;
secretKey?: string;
bucket?: string;
region?: string;
endPoint?: string;
useSSL?: boolean;
isPrivateRead?: boolean;
expiryTime?: string;
}) {
if (!client) {
client = new Client({
const client = new Client({
endPoint,
accessKey,
secretKey,
@ -43,7 +31,6 @@ export class MinIOHandler implements FileUploadHandler {
useSSL,
pathStyle: true,
});
}
this.client = client;
this.endPoint = endPoint;
this.useSSL = useSSL;

12
server/src/modules/file/utils/replaceFileKey.ts Normal file
View File

@ -0,0 +1,12 @@
export const replaceFileKey = (
originStr: string,
arr: Array<{ key; value }>,
) => {
let retStr = originStr;
for (const { key, value } of arr) {
if (value) {
retStr = retStr.replace(new RegExp(`{${key}}`), value);
}
}
return retStr;
};

18
server/src/modules/message/__test/messagePushingTask.controller.spec.ts
View File

@ -5,17 +5,17 @@ import { MessagePushingTaskService } from '../services/messagePushingTask.servic
import { CreateMessagePushingTaskDto } from '../dto/createMessagePushingTask.dto';
import { QueryMessagePushingTaskListDto } from '../dto/queryMessagePushingTaskList.dto';
import { HttpException } from 'src/exceptions/httpException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import {
MESSAGE_PUSHING_HOOK,
MESSAGE_PUSHING_TYPE,
} from 'src/enums/messagePushing';
import { MessagePushingTask } from 'src/models/messagePushingTask.entity';
import { Authentication } from 'src/guards/authentication.guard';
import { Authtication } from 'src/guards/authtication';
import { UserService } from 'src/modules/auth/services/user.service';
import { UpdateMessagePushingTaskDto } from '../dto/updateMessagePushingTask.dto';
import { ObjectId } from 'mongodb';
import { AuthService } from 'src/modules/auth/services/auth.service';
describe('MessagePushingTaskController', () => {
let controller: MessagePushingTaskController;
@ -38,7 +38,7 @@ describe('MessagePushingTaskController', () => {
},
},
{
provide: Authentication,
provide: Authtication,
useClass: jest.fn().mockImplementation(() => ({
canActivate: () => true,
})),
@ -51,14 +51,6 @@ describe('MessagePushingTaskController', () => {
},
})),
},
{
provide: AuthService,
useClass: jest.fn().mockImplementation(() => ({
verifyToken() {
return {};
},
})),
},
],
}).compile();
@ -145,7 +137,9 @@ describe('MessagePushingTaskController', () => {
await expect(
controller.findAll(req, queryDto as QueryMessagePushingTaskListDto),
).rejects.toThrow(HttpException);
).rejects.toThrow(
new HttpException('参数错误', EXCEPTION_CODE.PARAMETER_ERROR),
);
expect(service.findAll).toHaveBeenCalledTimes(0);
});
});

18
server/src/modules/message/__test/messagePushingTask.dto.spec.ts
View File

@ -8,6 +8,7 @@ import {
MESSAGE_PUSHING_TYPE,
MESSAGE_PUSHING_HOOK,
} from 'src/enums/messagePushing';
import { RECORD_STATUS } from 'src/enums';
describe('MessagePushingTaskDto', () => {
let dto: MessagePushingTaskDto;
@ -33,9 +34,9 @@ describe('MessagePushingTaskDto', () => {
});
it('should have a type', () => {
dto.type = MESSAGE_PUSHING_TYPE.HTTP;
dto.type = MESSAGE_PUSHING_TYPE.HTTP; // Set your desired type here
expect(dto.type).toBeDefined();
expect(dto.type).toEqual(MESSAGE_PUSHING_TYPE.HTTP);
expect(dto.type).toEqual(MESSAGE_PUSHING_TYPE.HTTP); // Adjust based on your enum
});
it('should have a push address', () => {
@ -45,13 +46,13 @@ describe('MessagePushingTaskDto', () => {
});
it('should have a trigger hook', () => {
dto.triggerHook = MESSAGE_PUSHING_HOOK.RESPONSE_INSERTED;
dto.triggerHook = MESSAGE_PUSHING_HOOK.RESPONSE_INSERTED; // Set your desired hook here
expect(dto.triggerHook).toBeDefined();
expect(dto.triggerHook).toEqual(MESSAGE_PUSHING_HOOK.RESPONSE_INSERTED);
expect(dto.triggerHook).toEqual(MESSAGE_PUSHING_HOOK.RESPONSE_INSERTED); // Adjust based on your enum
});
it('should have an array of surveys', () => {
dto.surveys = ['survey1', 'survey2'];
dto.surveys = ['survey1', 'survey2']; // Set your desired surveys here
expect(dto.surveys).toBeDefined();
expect(dto.surveys).toEqual(['survey1', 'survey2']);
});
@ -61,6 +62,13 @@ describe('MessagePushingTaskDto', () => {
expect(dto.owner).toBeDefined();
expect(dto.owner).toBe('test_owner');
});
it('should have current status', () => {
dto.curStatus = { status: RECORD_STATUS.NEW, date: Date.now() };
expect(dto.curStatus).toBeDefined();
expect(dto.curStatus.status).toEqual(RECORD_STATUS.NEW);
expect(dto.curStatus.date).toBeDefined();
});
});
describe('CodeDto', () => {

104
server/src/modules/message/__test/messagePushingTask.service.spec.ts
View File

@ -10,6 +10,7 @@ import { MessagePushingLogService } from '../services/messagePushingLog.service'
import { CreateMessagePushingTaskDto } from '../dto/createMessagePushingTask.dto';
import { UpdateMessagePushingTaskDto } from '../dto/updateMessagePushingTask.dto';
import { RECORD_STATUS } from 'src/enums';
import { MESSAGE_PUSHING_TYPE } from 'src/enums/messagePushing';
import { MESSAGE_PUSHING_HOOK } from 'src/enums/messagePushing';
import { MessagePushingTask } from 'src/models/messagePushingTask.entity';
@ -64,6 +65,7 @@ describe('MessagePushingTaskService', () => {
savedTask.type = MESSAGE_PUSHING_TYPE.HTTP;
savedTask.pushAddress = 'http://example.com';
savedTask.triggerHook = MESSAGE_PUSHING_HOOK.RESPONSE_INSERTED;
savedTask.surveys = ['surveyId1', 'surveyId2'];
const mockOwnerId = '66028642292c50f8b71a9eee';
@ -117,12 +119,10 @@ describe('MessagePushingTaskService', () => {
expect(result).toEqual(tasks);
expect(repository.find).toHaveBeenCalledWith({
where: {
isDeleted: {
$ne: true,
},
ownerId: mockOwnerId,
surveys: { $all: [surveyId] },
triggerHook: hook,
'curStatus.status': { $ne: RECORD_STATUS.REMOVED },
},
});
});
@ -147,19 +147,10 @@ describe('MessagePushingTaskService', () => {
where: {
ownerId: mockOwnerId,
_id: new ObjectId(taskId),
isDeleted: {
$ne: true,
},
'curStatus.status': { $ne: RECORD_STATUS.REMOVED },
},
});
});
it('should throw an error when message pushing task is not found', async () => {
const taskId = '65afc62904d5db18534c0f78';
jest.spyOn(repository, 'findOne').mockResolvedValue(null); // 模拟未找到任务
const mockOwnerId = '66028642292c50f8b71a9eee';
await expect(service.findOne({ id: taskId, ownerId: mockOwnerId }));
});
});
describe('update', () => {
@ -171,6 +162,10 @@ describe('MessagePushingTaskService', () => {
pushAddress: 'http://update.example.com',
triggerHook: MESSAGE_PUSHING_HOOK.RESPONSE_INSERTED,
surveys: ['new survey id'],
curStatus: {
status: RECORD_STATUS.EDITING,
date: Date.now(),
},
};
const existingTask = new MessagePushingTask();
existingTask._id = new ObjectId(taskId);
@ -196,20 +191,6 @@ describe('MessagePushingTaskService', () => {
});
expect(repository.save).toHaveBeenCalledWith(updatedTask);
});
it('should throw an error if the task to be updated is not found', async () => {
const taskId = '65afc62904d5db18534c0f78';
const updateDto: UpdateMessagePushingTaskDto = { name: 'Updated Task' };
jest.spyOn(repository, 'findOne').mockResolvedValue(null); // 模拟任务未找到
const mockOwnerId = '66028642292c50f8b71a9eee';
await expect(
service.update({
ownerId: mockOwnerId,
id: taskId,
updateData: updateDto,
}),
).rejects.toThrow(`Message pushing task with id ${taskId} not found`);
});
});
describe('remove', () => {
@ -217,52 +198,36 @@ describe('MessagePushingTaskService', () => {
const taskId = '65afc62904d5db18534c0f78';
const updateResult = { modifiedCount: 1 };
const mockOperatorId = '66028642292c50f8b71a9eee';
const mockOperator = 'mockOperator';
const mockOwnerId = '66028642292c50f8b71a9eee';
jest.spyOn(repository, 'updateOne').mockResolvedValue(updateResult);
const result = await service.remove({
id: taskId,
operatorId: mockOperatorId,
operator: mockOperator,
ownerId: mockOwnerId,
});
expect(result).toEqual(updateResult);
expect(repository.updateOne).toHaveBeenCalledWith(
{
ownerId: mockOwnerId,
_id: new ObjectId(taskId),
'curStatus.status': { $ne: RECORD_STATUS.REMOVED },
},
{
$set: {
isDeleted: true,
operatorId: mockOperatorId,
operator: mockOperator,
deletedAt: expect.any(Date),
curStatus: {
status: RECORD_STATUS.REMOVED,
date: expect.any(Number),
},
},
$push: {
statusList: {
status: RECORD_STATUS.REMOVED,
date: expect.any(Number),
},
},
);
});
it('should throw an error if the task to be removed is not found', async () => {
const taskId = '65afc62904d5db18534c0f78';
jest
.spyOn(repository, 'updateOne')
.mockResolvedValue({ modifiedCount: 0 }); // 模拟删除失败
const mockOperatorId = '66028642292c50f8b71a9eee';
const mockOperator = 'mockOperator';
const result = await service.remove({
id: taskId,
operatorId: mockOperatorId,
operator: mockOperator,
});
expect(result.modifiedCount).toBe(0);
expect(repository.updateOne).toHaveBeenCalledWith(
{
_id: new ObjectId(taskId),
},
expect.any(Object),
);
});
});
@ -294,34 +259,7 @@ describe('MessagePushingTaskService', () => {
$push: {
surveys: surveyId,
},
$set: {
updatedAt: expect.any(Date),
},
},
);
});
it('should not add the surveyId if it already exists in the task', async () => {
const taskId = '65afc62904d5db18534c0f78';
const surveyId = '65af380475b64545e5277dd9';
const mockOwnerId = '66028642292c50f8b71a9eee';
jest
.spyOn(repository, 'updateOne')
.mockResolvedValue({ modifiedCount: 0 }); // 模拟重复添加
const result = await service.surveyAuthorizeTask({
taskId,
surveyId,
ownerId: mockOwnerId,
});
expect(result.modifiedCount).toBe(0);
expect(repository.updateOne).toHaveBeenCalledWith(
{
_id: new ObjectId(taskId),
surveys: { $nin: [surveyId] }, // 确保只有不包含时才插入
ownerId: mockOwnerId,
},
expect.any(Object),
);
});
});

5
server/src/modules/message/__test/updateMessagePushingTask.dto.spec.ts
View File

@ -37,4 +37,9 @@ describe('UpdateMessagePushingTaskDto', () => {
dto.surveys = null;
expect(dto.surveys).toBeNull();
});
it('should have a nullable curStatus', () => {
dto.curStatus = null;
expect(dto.curStatus).toBeNull();
});
});

25
server/src/modules/message/controllers/messagePushingTask.controller.ts
View File

@ -25,9 +25,9 @@ import { QueryMessagePushingTaskListDto } from '../dto/queryMessagePushingTaskLi
import { HttpException } from 'src/exceptions/httpException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import { Authentication } from 'src/guards/authentication.guard';
import { Authtication } from 'src/guards/authtication';
@UseGuards(Authentication)
@UseGuards(Authtication)
@ApiBearerAuth()
@ApiTags('messagePushingTasks')
@Controller('/api/messagePushingTasks')
@ -47,10 +47,12 @@ export class MessagePushingTaskController {
req,
@Body() createMessagePushingTaskDto: CreateMessagePushingTaskDto,
) {
const { error, value } = CreateMessagePushingTaskDto.validate(
let data;
try {
data = await CreateMessagePushingTaskDto.validate(
createMessagePushingTaskDto,
);
if (error) {
} catch (error) {
throw new HttpException(
`参数错误: ${error.message}`,
EXCEPTION_CODE.PARAMETER_ERROR,
@ -59,7 +61,7 @@ export class MessagePushingTaskController {
const userId = req.user._id;
const messagePushingTask = await this.messagePushingTaskService.create({
...value,
...data,
ownerId: userId,
});
return {
@ -81,8 +83,10 @@ export class MessagePushingTaskController {
req,
@Query() query: QueryMessagePushingTaskListDto,
) {
const { error, value } = QueryMessagePushingTaskListDto.validate(query);
if (error) {
let data;
try {
data = await QueryMessagePushingTaskListDto.validate(query);
} catch (error) {
throw new HttpException(
`参数错误: ${error.message}`,
EXCEPTION_CODE.PARAMETER_ERROR,
@ -90,8 +94,8 @@ export class MessagePushingTaskController {
}
const userId = req.user._id;
const list = await this.messagePushingTaskService.findAll({
surveyId: value.surveyId,
hook: value.triggerHook,
surveyId: data.surveyId,
hook: data.triggerHook,
ownerId: userId,
});
return {
@ -150,9 +154,8 @@ export class MessagePushingTaskController {
async remove(@Request() req, @Param('id') id: string) {
const userId = req.user._id;
const res = await this.messagePushingTaskService.remove({
ownerId: userId,
id,
operator: req.user.username,
operatorId: userId,
});
return {
code: 200,

11
server/src/modules/message/dto/createMessagePushingTask.dto.ts
View File

@ -29,15 +29,18 @@ export class CreateMessagePushingTaskDto {
})
surveys?: string[];
static validate(data) {
return Joi.object({
static async validate(data) {
return await Joi.object({
name: Joi.string().required(),
type: Joi.string().allow(null).default(MESSAGE_PUSHING_TYPE.HTTP),
pushAddress: Joi.string().required(),
triggerHook: Joi.string()
.allow(null)
.default(MESSAGE_PUSHING_HOOK.RESPONSE_INSERTED),
surveys: Joi.array().items(Joi.string()).allow(null).default([]),
}).validate(data);
surveys: Joi.array()
.items(Joi.string().required())
.allow(null)
.default([]),
}).validateAsync(data);
}
}

7
server/src/modules/message/dto/messagePushingTask.dto.ts
View File

@ -4,6 +4,7 @@ import {
MESSAGE_PUSHING_TYPE,
MESSAGE_PUSHING_HOOK,
} from 'src/enums/messagePushing';
import { RECORD_STATUS } from 'src/enums';
export class MessagePushingTaskDto {
@ApiProperty({ description: '任务id' })
@ -26,6 +27,12 @@ export class MessagePushingTaskDto {
@ApiProperty({ description: '所有者' })
owner: string;
@ApiProperty({ description: '任务状态', required: false })
curStatus?: {
status: RECORD_STATUS;
date: number;
};
}
export class CodeDto {

2
server/src/modules/message/dto/queryMessagePushingTaskList.dto.ts
View File

@ -13,6 +13,6 @@ export class QueryMessagePushingTaskListDto {
return Joi.object({
surveyId: Joi.string().required(),
triggerHook: Joi.string().required(),
}).validate(data);
}).validateAsync(data);
}
}

7
server/src/modules/message/dto/updateMessagePushingTask.dto.ts
View File

@ -1,4 +1,5 @@
import { ApiProperty } from '@nestjs/swagger';
import { RECORD_STATUS } from 'src/enums';
import {
MESSAGE_PUSHING_TYPE,
MESSAGE_PUSHING_HOOK,
@ -19,4 +20,10 @@ export class UpdateMessagePushingTaskDto {
@ApiProperty({ description: '绑定的问卷id', required: false })
surveys?: string[];
@ApiProperty({ description: '任务状态', required: false })
curStatus?: {
status: RECORD_STATUS;
date: number;
};
}

42
server/src/modules/message/services/messagePushingTask.service.ts
View File

@ -6,6 +6,7 @@ import { MESSAGE_PUSHING_HOOK } from 'src/enums/messagePushing';
import { CreateMessagePushingTaskDto } from '../dto/createMessagePushingTask.dto';
import { UpdateMessagePushingTaskDto } from '../dto/updateMessagePushingTask.dto';
import { ObjectId } from 'mongodb';
import { RECORD_STATUS } from 'src/enums';
import { MESSAGE_PUSHING_TYPE } from 'src/enums/messagePushing';
import { MessagePushingLogService } from './messagePushingLog.service';
import { httpPost } from 'src/utils/request';
@ -43,8 +44,8 @@ export class MessagePushingTaskService {
ownerId?: string;
}): Promise<MessagePushingTask[]> {
const where: Record<string, any> = {
isDeleted: {
$ne: true,
'curStatus.status': {
$ne: RECORD_STATUS.REMOVED,
},
};
if (surveyId) {
@ -63,19 +64,19 @@ export class MessagePushingTaskService {
});
}
findOne({
async findOne({
id,
ownerId,
}: {
id: string;
ownerId: string;
}): Promise<MessagePushingTask> {
return this.messagePushingTaskRepository.findOne({
return await this.messagePushingTaskRepository.findOne({
where: {
ownerId,
_id: new ObjectId(id),
isDeleted: {
$ne: true,
'curStatus.status': {
$ne: RECORD_STATUS.REMOVED,
},
},
});
@ -103,25 +104,25 @@ export class MessagePushingTaskService {
return await this.messagePushingTaskRepository.save(updatedTask);
}
async remove({
id,
operator,
operatorId,
}: {
id: string;
operator: string;
operatorId: string;
}) {
async remove({ id, ownerId }: { id: string; ownerId: string }) {
const curStatus = {
status: RECORD_STATUS.REMOVED,
date: Date.now(),
};
return this.messagePushingTaskRepository.updateOne(
{
ownerId,
_id: new ObjectId(id),
'curStatus.status': {
$ne: RECORD_STATUS.REMOVED,
},
},
{
$set: {
isDeleted: true,
operator,
operatorId,
deletedAt: new Date(),
curStatus,
},
$push: {
statusList: curStatus as never,
},
},
);
@ -146,9 +147,6 @@ export class MessagePushingTaskService {
$push: {
surveys: surveyId as never,
},
$set: {
updatedAt: new Date(),
},
},
);
}

9
server/src/modules/redis/redis.module.ts
View File

@ -1,9 +0,0 @@
// src/redis/redis.module.ts
import { Module } from '@nestjs/common';
import { RedisService } from './redis.service';
@Module({
providers: [RedisService],
exports: [RedisService],
})
export class RedisModule {}

32
server/src/modules/redis/redis.service.ts
View File

@ -1,32 +0,0 @@
import { Injectable } from '@nestjs/common';
import { Redis } from 'ioredis';
import Redlock, { Lock } from 'redlock';
@Injectable()
export class RedisService {
private readonly redisClient: Redis;
private readonly redlock: Redlock;
constructor() {
this.redisClient = new Redis({
host: process.env.XIAOJU_SURVEY_REDIS_HOST,
port: parseInt(process.env.XIAOJU_SURVEY_REDIS_PORT),
password: process.env.XIAOJU_SURVEY_REDIS_PASSWORD || undefined,
username: process.env.XIAOJU_SURVEY_REDIS_USERNAME || undefined,
db: parseInt(process.env.XIAOJU_SURVEY_REDIS_DB) || 0,
});
this.redlock = new Redlock([this.redisClient], {
retryCount: 10,
retryDelay: 200, // ms
retryJitter: 200, // ms
});
}
async lockResource(resource: string, ttl: number): Promise<Lock> {
return this.redlock.acquire([resource], ttl);
}
async unlockResource(lock: Lock): Promise<void> {
await lock.release();
}
}

510
server/src/modules/survey/__test/collaborator.controller.spec.ts
View File

@ -1,510 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { CollaboratorController } from '../controllers/collaborator.controller';
import { CollaboratorService } from '../services/collaborator.service';
import { Logger } from 'src/logger';
import { HttpException } from 'src/exceptions/httpException';
import { CreateCollaboratorDto } from '../dto/createCollaborator.dto';
import { Collaborator } from 'src/models/collaborator.entity';
import { GetSurveyCollaboratorListDto } from '../dto/getSurveyCollaboratorList.dto';
import { UserService } from 'src/modules/auth/services/user.service';
import { ObjectId } from 'mongodb';
import { SurveyMetaService } from '../services/surveyMeta.service';
import { WorkspaceMemberService } from 'src/modules/workspace/services/workspaceMember.service';
import {
SURVEY_PERMISSION,
SURVEY_PERMISSION_DESCRIPTION,
} from 'src/enums/surveyPermission';
import { BatchSaveCollaboratorDto } from '../dto/batchSaveCollaborator.dto';
import { User } from 'src/models/user.entity';
import { SurveyMeta } from 'src/models/surveyMeta.entity';
jest.mock('src/guards/authentication.guard');
jest.mock('src/guards/survey.guard');
jest.mock('src/guards/workspace.guard');
describe('CollaboratorController', () => {
let controller: CollaboratorController;
let collaboratorService: CollaboratorService;
let logger: Logger;
let userService: UserService;
let surveyMetaService: SurveyMetaService;
let workspaceMemberServie: WorkspaceMemberService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [CollaboratorController],
providers: [
{
provide: CollaboratorService,
useValue: {
create: jest.fn(),
getSurveyCollaboratorList: jest.fn(),
changeUserPermission: jest.fn(),
deleteCollaborator: jest.fn(),
getCollaborator: jest.fn(),
batchDeleteBySurveyId: jest.fn(),
batchCreate: jest.fn(),
batchDelete: jest.fn(),
updateById: jest.fn(),
batchSaveCollaborator: jest.fn(),
},
},
{
provide: Logger,
useValue: {
error: jest.fn(),
info: jest.fn(),
},
},
{
provide: UserService,
useValue: {
getUserById: jest.fn().mockImplementation((id) => {
return Promise.resolve({
_id: new ObjectId(id),
});
}),
getUserListByIds: jest.fn(),
},
},
{
provide: SurveyMetaService,
useValue: {
getSurveyById: jest.fn(),
},
},
{
provide: WorkspaceMemberService,
useValue: {
findOne: jest.fn().mockResolvedValue(null),
},
},
],
}).compile();
controller = module.get<CollaboratorController>(CollaboratorController);
collaboratorService = module.get<CollaboratorService>(CollaboratorService);
logger = module.get<Logger>(Logger);
userService = module.get<UserService>(UserService);
surveyMetaService = module.get<SurveyMetaService>(SurveyMetaService);
workspaceMemberServie = module.get<WorkspaceMemberService>(
WorkspaceMemberService,
);
});
it('should be defined', () => {
expect(controller).toBeDefined();
});
describe('addCollaborator', () => {
it('should add a collaborator successfully', async () => {
const userId = new ObjectId().toString();
const reqBody: CreateCollaboratorDto = {
surveyId: 'surveyId',
userId: new ObjectId().toString(),
permissions: [SURVEY_PERMISSION.SURVEY_CONF_MANAGE],
};
const req = { user: { _id: 'userId' }, surveyMeta: { ownerId: userId } };
const result = { _id: 'collaboratorId' };
jest
.spyOn(collaboratorService, 'create')
.mockResolvedValue(result as unknown as Collaborator);
const response = await controller.addCollaborator(reqBody, req);
expect(response).toEqual({
code: 200,
data: {
collaboratorId: result._id,
},
});
});
it('should throw an exception if validation fails', async () => {
const reqBody: CreateCollaboratorDto = {
surveyId: '',
userId: '',
permissions: [SURVEY_PERMISSION.SURVEY_CONF_MANAGE],
};
const req = { user: { _id: 'userId' } };
await expect(controller.addCollaborator(reqBody, req)).rejects.toThrow(
HttpException,
);
});
it('should throw an exception if user does not exist', async () => {
const reqBody: CreateCollaboratorDto = {
surveyId: 'surveyId',
userId: new ObjectId().toString(),
permissions: [SURVEY_PERMISSION.SURVEY_CONF_MANAGE],
};
const req = {
user: { _id: 'userId' },
surveyMeta: { ownerId: new ObjectId().toString() },
};
jest.spyOn(userService, 'getUserById').mockResolvedValue(null);
await expect(controller.addCollaborator(reqBody, req)).rejects.toThrow(
HttpException,
);
});
it('should throw an exception if user is the survey owner', async () => {
const userId = new ObjectId().toString();
const reqBody: CreateCollaboratorDto = {
surveyId: 'surveyId',
userId: userId,
permissions: [SURVEY_PERMISSION.SURVEY_CONF_MANAGE],
};
const req = { user: { _id: 'userId' }, surveyMeta: { ownerId: userId } };
await expect(controller.addCollaborator(reqBody, req)).rejects.toThrow(
HttpException,
);
});
it('should throw an exception if user is already a collaborator', async () => {
const userId = new ObjectId().toString();
const reqBody: CreateCollaboratorDto = {
surveyId: 'surveyId',
userId: userId,
permissions: [SURVEY_PERMISSION.SURVEY_CONF_MANAGE],
};
const req = {
user: { _id: 'userId' },
surveyMeta: { ownerId: new ObjectId().toString() },
};
jest
.spyOn(collaboratorService, 'getCollaborator')
.mockResolvedValue({} as unknown as Collaborator);
await expect(controller.addCollaborator(reqBody, req)).rejects.toThrow(
HttpException,
);
});
});
describe('getSurveyCollaboratorList', () => {
it('should return collaborator list', async () => {
const query = { surveyId: 'surveyId' };
const result = [
{ _id: 'collaboratorId', userId: 'userId', username: '' },
];
jest
.spyOn(collaboratorService, 'getSurveyCollaboratorList')
.mockResolvedValue(result as unknown as Array<Collaborator>);
jest.spyOn(userService, 'getUserListByIds').mockResolvedValueOnce([]);
const response = await controller.getSurveyCollaboratorList(query);
expect(response).toEqual({
code: 200,
data: result,
});
});
it('should throw an exception if validation fails', async () => {
const query: GetSurveyCollaboratorListDto = {
surveyId: '',
};
await expect(controller.getSurveyCollaboratorList(query)).rejects.toThrow(
HttpException,
);
expect(logger.error).toHaveBeenCalledTimes(1);
});
});
describe('changeUserPermission', () => {
it('should change user permission successfully', async () => {
const reqBody = {
surveyId: 'surveyId',
userId: 'userId',
permissions: ['read'],
};
const result = { _id: 'userId', permissions: ['read'] };
jest
.spyOn(collaboratorService, 'changeUserPermission')
.mockResolvedValue(result);
const response = await controller.changeUserPermission(reqBody);
expect(response).toEqual({
code: 200,
data: result,
});
});
it('should throw an exception if validation fails', async () => {
const reqBody = {
surveyId: '',
userId: '',
permissions: ['surveyManage'],
};
await expect(controller.changeUserPermission(reqBody)).rejects.toThrow(
HttpException,
);
expect(logger.error).toHaveBeenCalledTimes(1);
});
});
describe('deleteCollaborator', () => {
it('should delete collaborator successfully', async () => {
const query = { surveyId: 'surveyId', userId: 'userId' };
const result = { acknowledged: true, deletedCount: 1 };
jest
.spyOn(collaboratorService, 'deleteCollaborator')
.mockResolvedValue(result);
const response = await controller.deleteCollaborator(query);
expect(response).toEqual({
code: 200,
data: result,
});
});
it('should throw an exception if validation fails', async () => {
const query = { surveyId: '', userId: '' };
await expect(controller.deleteCollaborator(query)).rejects.toThrow(
HttpException,
);
expect(logger.error).toHaveBeenCalledTimes(1);
});
});
// 新增的测试方法
describe('getPermissionList', () => {
it('should return the permission list', async () => {
const result = Object.values(SURVEY_PERMISSION_DESCRIPTION);
const response = await controller.getPermissionList();
expect(response).toEqual({
code: 200,
data: result,
});
});
});
describe('batchSaveCollaborator', () => {
it('should batch save collaborators successfully', async () => {
const userId0 = new ObjectId().toString();
const userId1 = new ObjectId().toString();
const existsCollaboratorId = new ObjectId().toString();
const surveyId = new ObjectId().toString();
const reqBody: BatchSaveCollaboratorDto = {
surveyId: surveyId,
collaborators: [
{
userId: userId0,
permissions: [SURVEY_PERMISSION.SURVEY_CONF_MANAGE],
},
{
_id: existsCollaboratorId,
userId: userId1,
permissions: [SURVEY_PERMISSION.SURVEY_RESPONSE_MANAGE],
},
],
};
const req = {
user: { _id: 'requestUserId' },
surveyMeta: { ownerId: 'ownerId' },
};
const userList = [
{ _id: new ObjectId(userId0) },
{ _id: new ObjectId(userId1) },
];
jest
.spyOn(userService, 'getUserListByIds')
.mockResolvedValue(userList as unknown as User[]);
jest
.spyOn(collaboratorService, 'batchDelete')
.mockResolvedValue({ deletedCount: 1, acknowledged: true });
jest
.spyOn(collaboratorService, 'batchCreate')
.mockResolvedValue([{}] as any);
jest.spyOn(collaboratorService, 'updateById').mockResolvedValue({});
const response = await controller.batchSaveCollaborator(reqBody, req);
expect(response).toEqual({
code: 200,
});
expect(userService.getUserListByIds).toHaveBeenCalled();
expect(collaboratorService.batchDelete).toHaveBeenCalled();
expect(collaboratorService.batchCreate).toHaveBeenCalled();
expect(collaboratorService.updateById).toHaveBeenCalled();
});
it('should throw an exception if validation fails', async () => {
const reqBody: BatchSaveCollaboratorDto = {
surveyId: '',
collaborators: [
{
userId: '',
permissions: [SURVEY_PERMISSION.SURVEY_COOPERATION_MANAGE],
},
],
};
const req = { user: { _id: 'userId' } };
await expect(
controller.batchSaveCollaborator(reqBody, req),
).rejects.toThrow(HttpException);
expect(logger.error).toHaveBeenCalledTimes(1);
});
});
describe('getUserSurveyPermissions', () => {
it('should return owner permissions if user is the owner', async () => {
const req = {
user: { _id: new ObjectId(), username: 'owner' },
};
const query = { surveyId: 'surveyId' };
const surveyMeta = {
ownerId: req.user._id.toString(),
owner: req.user.username,
workspaceId: 'workspaceId',
};
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
const response = await controller.getUserSurveyPermissions(req, query);
expect(response).toEqual({
code: 200,
data: {
isOwner: true,
permissions: [
SURVEY_PERMISSION.SURVEY_COOPERATION_MANAGE,
SURVEY_PERMISSION.SURVEY_RESPONSE_MANAGE,
SURVEY_PERMISSION.SURVEY_CONF_MANAGE,
],
},
});
});
it('should return default permissions if user is a workspace member', async () => {
const req = {
user: { _id: new ObjectId(), username: 'user' },
};
const query = { surveyId: 'surveyId' };
const surveyMeta = {
ownerId: 'ownerId',
owner: 'owner',
workspaceId: 'workspaceId',
};
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
jest.spyOn(workspaceMemberServie, 'findOne').mockResolvedValue({} as any);
const response = await controller.getUserSurveyPermissions(req, query);
expect(response).toEqual({
code: 200,
data: {
isOwner: false,
permissions: [
SURVEY_PERMISSION.SURVEY_COOPERATION_MANAGE,
SURVEY_PERMISSION.SURVEY_RESPONSE_MANAGE,
SURVEY_PERMISSION.SURVEY_CONF_MANAGE,
],
},
});
});
it('should return collaborator permissions if user is a collaborator', async () => {
const req = {
user: { _id: new ObjectId(), username: 'user' },
};
const query = { surveyId: 'surveyId' };
const surveyMeta = {
ownerId: 'ownerId',
owner: 'owner',
workspaceId: 'workspaceId',
};
const collaborator = {
permissions: ['read', 'write'],
};
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
jest.spyOn(workspaceMemberServie, 'findOne').mockResolvedValue(null);
jest
.spyOn(collaboratorService, 'getCollaborator')
.mockResolvedValue(collaborator as Collaborator);
const response = await controller.getUserSurveyPermissions(req, query);
expect(response).toEqual({
code: 200,
data: {
isOwner: false,
permissions: collaborator.permissions,
},
});
});
it('should return empty permissions if user has no permissions', async () => {
const req = {
user: { _id: new ObjectId(), username: 'user' },
};
const query = { surveyId: 'surveyId' };
const surveyMeta = {
ownerId: 'ownerId',
owner: 'owner',
workspaceId: 'workspaceId',
};
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValue(surveyMeta as SurveyMeta);
jest.spyOn(workspaceMemberServie, 'findOne').mockResolvedValue(null);
jest
.spyOn(collaboratorService, 'getCollaborator')
.mockResolvedValue(null);
const response = await controller.getUserSurveyPermissions(req, query);
expect(response).toEqual({
code: 200,
data: {
isOwner: false,
permissions: [],
},
});
});
it('should throw an exception if survey does not exist', async () => {
const req = { user: { _id: 'userId' } };
const query = { surveyId: 'nonexistentSurveyId' };
jest
.spyOn(surveyMetaService, 'getSurveyById')
.mockResolvedValueOnce(null);
await expect(
controller.getUserSurveyPermissions(req, query),
).rejects.toThrow(HttpException);
expect(logger.error).toHaveBeenCalledTimes(1);
});
});
});

418
server/src/modules/survey/__test/collaborator.service.spec.ts
View File

@ -1,418 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { CollaboratorService } from '../services/collaborator.service';
import { getRepositoryToken } from '@nestjs/typeorm';
import { Collaborator } from 'src/models/collaborator.entity';
import { MongoRepository } from 'typeorm';
import { Logger } from 'src/logger';
import { InsertManyResult, ObjectId } from 'mongodb';
describe('CollaboratorService', () => {
let service: CollaboratorService;
let repository: MongoRepository<Collaborator>;
let logger: Logger;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
CollaboratorService,
{
provide: getRepositoryToken(Collaborator),
useClass: MongoRepository,
},
{
provide: Logger,
useValue: {
info: jest.fn(),
},
},
],
}).compile();
service = module.get<CollaboratorService>(CollaboratorService);
repository = module.get<MongoRepository<Collaborator>>(
getRepositoryToken(Collaborator),
);
logger = module.get<Logger>(Logger);
});
describe('create', () => {
it('should create and save a collaborator', async () => {
const createSpy = jest.spyOn(repository, 'create').mockReturnValue({
surveyId: '1',
userId: '1',
permissions: [],
} as Collaborator);
const collaboratorId = new ObjectId().toString();
const saveSpy = jest.spyOn(repository, 'save').mockResolvedValue({
_id: new ObjectId(collaboratorId),
surveyId: '1',
userId: '1',
permissions: [],
} as Collaborator);
const result = await service.create({
surveyId: '1',
userId: '1',
permissions: [],
});
expect(createSpy).toHaveBeenCalledWith({
surveyId: '1',
userId: '1',
permissions: [],
});
expect(saveSpy).toHaveBeenCalledWith({
surveyId: '1',
userId: '1',
permissions: [],
});
expect(result).toEqual({
_id: new ObjectId(collaboratorId),
surveyId: '1',
userId: '1',
permissions: [],
});
});
});
describe('deleteCollaborator', () => {
it('should delete a collaborator by userId and surveyId', async () => {
const deleteOneSpy = jest
.spyOn(repository, 'deleteOne')
.mockResolvedValue({ acknowledged: true, deletedCount: 1 });
const result = await service.deleteCollaborator({
userId: '1',
surveyId: '1',
});
expect(deleteOneSpy).toHaveBeenCalledWith({
userId: '1',
surveyId: '1',
});
expect(result).toEqual({ acknowledged: true, deletedCount: 1 });
});
});
describe('batchCreate', () => {
it('should batch create collaborators', async () => {
const insertManySpy = jest
.spyOn(repository, 'insertMany')
.mockResolvedValue({
insertedCount: 1,
} as unknown as InsertManyResult<Document>);
const result = await service.batchCreate({
surveyId: '1',
collaboratorList: [{ userId: '1', permissions: [] }],
creator: 'testCreator',
creatorId: 'testCreatorId',
});
expect(insertManySpy).toHaveBeenCalledWith([
{
userId: '1',
permissions: [],
surveyId: '1',
createdAt: expect.any(Date),
updatedAt: expect.any(Date),
creator: 'testCreator',
creatorId: 'testCreatorId',
},
]);
expect(result).toEqual({ insertedCount: 1 });
});
});
describe('changeUserPermission', () => {
it("should update a user's permissions", async () => {
const updateOneSpy = jest
.spyOn(repository, 'updateOne')
.mockResolvedValue({});
const result = await service.changeUserPermission({
userId: '1',
surveyId: '1',
permission: 'read',
operator: 'testOperator',
operatorId: 'testOperatorId',
});
expect(updateOneSpy).toHaveBeenCalledWith(
{
surveyId: '1',
userId: '1',
},
{
$set: {
permission: 'read',
operator: 'testOperator',
operatorId: 'testOperatorId',
updatedAt: expect.any(Date),
},
},
);
expect(result).toEqual({});
});
});
describe('batchDelete', () => {
it('should batch delete collaborators', async () => {
const mockResult = { acknowledged: true, deletedCount: 1 };
const deleteManySpy = jest
.spyOn(repository, 'deleteMany')
.mockResolvedValue(mockResult);
const collaboratorId = new ObjectId().toString();
const result = await service.batchDelete({
surveyId: '1',
idList: [collaboratorId],
});
const expectedQuery = {
surveyId: '1',
$or: [
{
_id: {
$in: [new ObjectId(collaboratorId)],
},
},
],
};
expect(logger.info).toHaveBeenCalledWith(JSON.stringify(expectedQuery));
expect(deleteManySpy).toHaveBeenCalledWith(expectedQuery);
expect(result).toEqual(mockResult);
});
it('should batch delete collaborators by idList and userIdList', async () => {
const collaboratorId = new ObjectId().toString();
const deleteManySpy = jest
.spyOn(repository, 'deleteMany')
.mockResolvedValue({ acknowledged: true, deletedCount: 2 });
const result = await service.batchDelete({
idList: [collaboratorId],
userIdList: ['user1', 'user2'],
surveyId: '1',
});
const expectedQuery = {
surveyId: '1',
$or: [
{
userId: {
$in: ['user1', 'user2'],
},
},
{
_id: {
$in: [new ObjectId(collaboratorId)],
},
},
],
};
expect(deleteManySpy).toHaveBeenCalledWith(expectedQuery);
expect(result).toEqual({ acknowledged: true, deletedCount: 2 });
});
it('should handle batch delete with neIdList only', async () => {
const neCollaboratorId = new ObjectId().toString();
const deleteManySpy = jest
.spyOn(repository, 'deleteMany')
.mockResolvedValue({ acknowledged: true, deletedCount: 1 });
const result = await service.batchDelete({
neIdList: [neCollaboratorId],
surveyId: '1',
});
const expectedQuery = {
surveyId: '1',
$or: [
{
_id: {
$nin: [new ObjectId(neCollaboratorId)],
},
},
],
};
expect(deleteManySpy).toHaveBeenCalledWith(expectedQuery);
expect(result).toEqual({ acknowledged: true, deletedCount: 1 });
});
});
describe('batchDeleteBySurveyId', () => {
it('should batch delete collaborators by survey id', async () => {
const mockResult = { acknowledged: true, deletedCount: 1 };
const deleteManySpy = jest
.spyOn(repository, 'deleteMany')
.mockResolvedValue(mockResult);
const surveyId = new ObjectId().toString();
const result = await service.batchDeleteBySurveyId(surveyId);
expect(deleteManySpy).toHaveBeenCalledWith({
surveyId,
});
expect(result).toEqual(mockResult);
});
});
describe('updateById', () => {
it('should update collaborator by id', async () => {
const updateOneSpy = jest
.spyOn(repository, 'updateOne')
.mockResolvedValue({});
const collaboratorId = new ObjectId().toString();
const result = await service.updateById({
collaboratorId,
permissions: [],
operator: 'testOperator',
operatorId: 'testOperatorId',
});
expect(updateOneSpy).toHaveBeenCalledWith(
{
_id: new ObjectId(collaboratorId),
},
{
$set: {
permissions: [],
operator: 'testOperator',
operatorId: 'testOperatorId',
updatedAt: expect.any(Date),
},
},
);
expect(result).toEqual({});
});
});
describe('getSurveyCollaboratorList', () => {
it('should return a list of collaborators for a survey', async () => {
const collaboratorId = new ObjectId().toString();
const findSpy = jest.spyOn(repository, 'find').mockResolvedValue([
{
_id: new ObjectId(collaboratorId),
surveyId: '1',
userId: '1',
permissions: [],
},
] as Collaborator[]);
const result = await service.getSurveyCollaboratorList({ surveyId: '1' });
expect(findSpy).toHaveBeenCalledWith({ surveyId: '1' });
expect(result).toEqual([
{
_id: new ObjectId(collaboratorId),
surveyId: '1',
userId: '1',
permissions: [],
},
]);
});
});
describe('getCollaborator', () => {
it('should return a collaborator', async () => {
const collaboratorId = new ObjectId().toString();
const findOneSpy = jest.spyOn(repository, 'findOne').mockResolvedValue({
_id: new ObjectId(collaboratorId),
surveyId: '1',
userId: '1',
permissions: [],
} as Collaborator);
const result = await service.getCollaborator({
userId: '1',
surveyId: '1',
});
expect(findOneSpy).toHaveBeenCalledWith({
where: {
surveyId: '1',
userId: '1',
},
});
expect(result).toEqual({
_id: new ObjectId(collaboratorId),
surveyId: '1',
userId: '1',
permissions: [],
});
});
});
describe('getCollaboratorListByUserId', () => {
it('should return a list of collaborators by user id', async () => {
const userId = new ObjectId().toString();
const findSpy = jest.spyOn(repository, 'find').mockResolvedValue([
{
_id: '1',
surveyId: '1',
userId: userId,
permissions: [],
} as unknown as Collaborator,
]);
const result = await service.getCollaboratorListByUserId({ userId });
expect(findSpy).toHaveBeenCalledWith({
where: {
userId,
},
});
expect(result).toEqual([
{ _id: '1', surveyId: '1', userId, permissions: [] },
]);
});
it('should return a list of collaborators by their IDs', async () => {
const collaboratorId1 = new ObjectId().toString();
const collaboratorId2 = new ObjectId().toString();
const findSpy = jest.spyOn(repository, 'find').mockResolvedValue([
{
_id: new ObjectId(collaboratorId1),
surveyId: '1',
userId: 'user1',
permissions: [],
},
{
_id: new ObjectId(collaboratorId2),
surveyId: '2',
userId: 'user2',
permissions: [],
},
] as Collaborator[]);
const result = await service.getCollaboratorListByIds({
idList: [collaboratorId1, collaboratorId2],
});
expect(findSpy).toHaveBeenCalledWith({
_id: {
$in: [new ObjectId(collaboratorId1), new ObjectId(collaboratorId2)],
},
});
expect(result).toEqual([
{
_id: new ObjectId(collaboratorId1),
surveyId: '1',
userId: 'user1',
permissions: [],
},
{
_id: new ObjectId(collaboratorId2),
surveyId: '2',
userId: 'user2',
permissions: [],
},
]);
});
});
});

556
server/src/modules/survey/__test/dataStatistic.controller.spec.ts
View File

@ -8,27 +8,19 @@ import { SurveyMetaService } from '../services/surveyMeta.service';
import { ResponseSchemaService } from '../../surveyResponse/services/responseScheme.service';
import { PluginManagerProvider } from 'src/securityPlugin/pluginManager.provider';
import { PluginManager } from 'src/securityPlugin/pluginManager';
import { Logger } from 'src/logger';
import { XiaojuSurveyPluginManager } from 'src/securityPlugin/pluginManager';
import { Authtication } from 'src/guards/authtication';
import { UserService } from 'src/modules/auth/services/user.service';
import { ResponseSecurityPlugin } from 'src/securityPlugin/responseSecurityPlugin';
import { AuthService } from 'src/modules/auth/services/auth.service';
import { HttpException } from 'src/exceptions/httpException';
jest.mock('../services/dataStatistic.service');
jest.mock('../services/surveyMeta.service');
jest.mock('../../surveyResponse/services/responseScheme.service');
jest.mock('src/guards/authentication.guard');
jest.mock('src/guards/survey.guard');
describe('DataStatisticController', () => {
let controller: DataStatisticController;
let dataStatisticService: DataStatisticService;
let responseSchemaService: ResponseSchemaService;
let pluginManager: PluginManager;
let logger: Logger;
let surveyMetaService: SurveyMetaService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
@ -39,6 +31,12 @@ describe('DataStatisticController', () => {
ResponseSchemaService,
PluginManagerProvider,
ConfigService,
{
provide: Authtication,
useClass: jest.fn().mockImplementation(() => ({
canActivate: () => true,
})),
},
{
provide: UserService,
useClass: jest.fn().mockImplementation(() => ({
@ -47,32 +45,16 @@ describe('DataStatisticController', () => {
},
})),
},
{
provide: AuthService,
useClass: jest.fn().mockImplementation(() => ({
varifytoken() {
return {};
},
})),
},
{
provide: Logger,
useValue: {
error: jest.fn(),
},
},
],
}).compile();
controller = module.get<DataStatisticController>(DataStatisticController);
dataStatisticService =
module.get<DataStatisticService>(DataStatisticService);
responseSchemaService = module.get<ResponseSchemaService>(
ResponseSchemaService,
surveyMetaService = module.get<SurveyMetaService>(SurveyMetaService);
const pluginManager = module.get<XiaojuSurveyPluginManager>(
XiaojuSurveyPluginManager,
);
pluginManager = module.get<PluginManager>(PluginManager);
logger = module.get<Logger>(Logger);
pluginManager.registerPlugin(
new ResponseSecurityPlugin('dataAesEncryptSecretKey'),
);
@ -88,9 +70,6 @@ describe('DataStatisticController', () => {
const mockRequest = {
query: {
surveyId,
isMasked: false,
page: 1,
pageSize: 10,
},
user: {
username: 'testUser',
@ -104,24 +83,26 @@ describe('DataStatisticController', () => {
field: 'xxx',
title: 'xxx',
type: 'xxx',
diffTime: 'xxx',
othersCode: 'xxx',
},
],
listBody: [
{ diffTime: '0.5', createdAt: '2024-02-11' },
{ diffTime: '0.5', createdAt: '2024-02-11' },
{ difTime: '0.5', createDate: '2024-02-11' },
{ difTime: '0.5', createDate: '2024-02-11' },
],
};
jest
.spyOn(responseSchemaService, 'getResponseSchemaByPageId')
.spyOn(surveyMetaService, 'checkSurveyAccess')
.mockResolvedValueOnce(undefined);
jest
.spyOn(controller['responseSchemaService'], 'getResponseSchemaByPageId')
.mockResolvedValueOnce({} as any);
jest
.spyOn(dataStatisticService, 'getDataTable')
.mockResolvedValueOnce(mockDataTable);
const result = await controller.data(mockRequest.query);
const result = await controller.data(mockRequest.query, mockRequest);
expect(result).toEqual({
code: 200,
@ -129,14 +110,12 @@ describe('DataStatisticController', () => {
});
});
it('should return data table with isMasked', async () => {
it('should return data table with isDesensitive', async () => {
const surveyId = new ObjectId().toString();
const mockRequest = {
query: {
surveyId,
isMasked: true,
page: 1,
pageSize: 10,
isDesensitive: true,
},
user: {
username: 'testUser',
@ -150,510 +129,31 @@ describe('DataStatisticController', () => {
field: 'xxx',
title: 'xxx',
type: 'xxx',
diffTime: 'xxx',
othersCode: 'xxx',
},
],
listBody: [
{ diffTime: '0.5', createdAt: '2024-02-11', data123: '15200000000' },
{ diffTime: '0.5', createdAt: '2024-02-11', data123: '13800000000' },
{ difTime: '0.5', createDate: '2024-02-11', data123: '15200000000' },
{ difTime: '0.5', createDate: '2024-02-11', data123: '13800000000' },
],
};
jest
.spyOn(responseSchemaService, 'getResponseSchemaByPageId')
.spyOn(surveyMetaService, 'checkSurveyAccess')
.mockResolvedValueOnce(undefined);
jest
.spyOn(controller['responseSchemaService'], 'getResponseSchemaByPageId')
.mockResolvedValueOnce({} as any);
jest
.spyOn(dataStatisticService, 'getDataTable')
.mockResolvedValueOnce(mockDataTable);
const result = await controller.data(mockRequest.query);
const result = await controller.data(mockRequest.query, mockRequest);
expect(result).toEqual({
code: 200,
data: mockDataTable,
});
});
it('should throw an exception if validation fails', async () => {
const mockRequest = {
query: {
surveyId: '',
},
user: {
username: 'testUser',
},
};
await expect(controller.data(mockRequest.query)).rejects.toThrow(
HttpException,
);
expect(logger.error).toHaveBeenCalledTimes(1);
});
});
describe('aggregationStatis', () => {
it('should return aggregation statistics', async () => {
const mockRequest = {
query: {
surveyId: new ObjectId().toString(),
},
};
const mockResponseSchema = {
_id: new ObjectId('6659c3283b1cb279bc2e2b0c'),
curStatus: {
status: 'published',
date: 1717159136024,
},
statusList: [
{
status: 'published',
date: 1717158851823,
},
],
createdAt: 1717158851823,
updatedAt: 1717159136025,
title: '问卷调研',
surveyPath: 'ZdGNzTTR',
code: {
bannerConf: {
titleConfig: {
mainTitle:
'<h3 style="text-align: center">欢迎填写问卷</h3><p>为了给您提供更好的服务，希望您能抽出几分钟时间，将您的感受和建议告诉我们，<span style="color: rgb(204, 0, 0)">期待您的参与！</span></p>',
subTitle: '',
applyTitle: '',
},
bannerConfig: {
bgImage: '/imgs/skin/17e06b7604a007e1d3e1453b9ddadc3c.webp',
bgImageAllowJump: false,
bgImageJumpLink: '',
videoLink: '',
postImg: '',
},
},
baseConf: {
beginTime: '2024-05-31 20:31:36',
endTime: '2034-05-31 20:31:36',
language: 'chinese',
showVoteProcess: 'allow',
tLimit: 0,
answerBegTime: '00:00:00',
answerEndTime: '23:59:59',
answerLimitTime: 0,
},
bottomConf: {
logoImage: '/imgs/Logo.webp',
logoImageWidth: '60%',
},
skinConf: {
backgroundConf: {
color: '#fff',
type: 'color',
image: '',
},
themeConf: {
color: '#ffa600',
},
contentConf: {
opacity: 100,
},
skinColor: '#4a4c5b',
inputBgColor: '#ffffff',
},
submitConf: {
submitTitle: '提交',
msgContent: {
msg_200: '提交成功',
msg_9001: '您来晚了，感谢支持问卷~',
msg_9002: '请勿多次提交！',
msg_9003: '您来晚了，已经满额！',
msg_9004: '提交失败！',
},
confirmAgain: {
is_again: true,
again_text: '确认要提交吗？',
},
link: '',
},
logicConf: {
showLogicConf: [],
},
dataConf: {
dataList: [
{
isRequired: true,
showIndex: true,
showType: true,
showSpliter: true,
type: 'radio',
placeholderDesc: '',
field: 'data515',
title: '标题2',
placeholder: '',
randomSort: false,
checked: false,
minNum: '',
maxNum: '',
options: [
{
text: '选项1',
imageUrl: '',
others: false,
mustOthers: false,
othersKey: '',
placeholderDesc: '',
hash: '115019',
},
{
text: '选项2',
imageUrl: '',
others: false,
mustOthers: false,
othersKey: '',
placeholderDesc: '',
hash: '115020',
},
],
importKey: 'single',
importData: '',
cOption: '',
cOptions: [],
star: 5,
exclude: false,
textRange: {
min: {
placeholder: '0',
value: 0,
},
max: {
placeholder: '500',
value: 500,
},
},
},
{
field: 'data893',
showIndex: true,
showType: true,
showSpliter: true,
type: 'checkbox',
placeholderDesc: '',
sLimit: 0,
mhLimit: 0,
title: '标题2',
placeholder: '',
valid: '',
isRequired: true,
randomSort: false,
showLeftNum: true,
innerRandom: false,
checked: false,
selectType: 'radio',
sortWay: 'v',
noNps: '',
minNum: '',
maxNum: '',
starStyle: 'star',
starMin: 1,
starMax: 5,
min: 0,
max: 10,
minMsg: '极不满意',
maxMsg: '十分满意',
rangeConfig: {},
options: [
{
text: '选项1',
others: false,
othersKey: '',
placeholderDesc: '',
hash: '466671',
},
{
text: '选项2',
others: false,
othersKey: '',
placeholderDesc: '',
hash: '095415',
},
],
star: 5,
optionOrigin: '',
originType: 'selected',
matrixOptionsRely: '',
numberRange: {
min: {
placeholder: '0',
value: 0,
},
max: {
placeholder: '1000',
value: 1000,
},
},
textRange: {
min: {
placeholder: '0',
value: 0,
},
max: {
placeholder: '500',
value: 500,
},
},
},
{
field: 'data820',
showIndex: true,
showType: true,
showSpliter: true,
type: 'radio-nps',
placeholderDesc: '',
sLimit: 0,
mhLimit: 0,
title: '标题3',
placeholder: '',
valid: '',
isRequired: true,
randomSort: false,
showLeftNum: true,
innerRandom: false,
checked: false,
selectType: 'radio',
sortWay: 'v',
noNps: '',
minNum: '',
maxNum: '',
starStyle: 'star',
starMin: 1,
starMax: 5,
min: 0,
max: 10,
minMsg: '极不满意',
maxMsg: '十分满意',
rangeConfig: {},
options: [
{
text: '选项1',
others: false,
othersKey: '',
placeholderDesc: '',
hash: '268884',
},
{
text: '选项2',
others: false,
othersKey: '',
placeholderDesc: '',
hash: '371166',
},
],
star: 5,
optionOrigin: '',
originType: 'selected',
matrixOptionsRely: '',
numberRange: {
min: {
placeholder: '0',
value: 0,
},
max: {
placeholder: '1000',
value: 1000,
},
},
textRange: {
min: {
placeholder: '0',
value: 0,
},
max: {
placeholder: '500',
value: 500,
},
},
},
{
field: 'data549',
showIndex: true,
showType: true,
showSpliter: true,
type: 'radio-star',
placeholderDesc: '',
sLimit: 0,
mhLimit: 0,
title: '标题4',
placeholder: '',
valid: '',
isRequired: true,
randomSort: false,
showLeftNum: true,
innerRandom: false,
checked: false,
selectType: 'radio',
sortWay: 'v',
noNps: '',
minNum: '',
maxNum: '',
starStyle: 'star',
starMin: 1,
starMax: 5,
min: 0,
max: 10,
minMsg: '极不满意',
maxMsg: '十分满意',
rangeConfig: {},
options: [
{
text: '选项1',
others: false,
othersKey: '',
placeholderDesc: '',
hash: '274183',
},
{
text: '选项2',
others: false,
othersKey: '',
placeholderDesc: '',
hash: '842967',
},
],
star: 5,
optionOrigin: '',
originType: 'selected',
matrixOptionsRely: '',
numberRange: {
min: {
placeholder: '0',
value: 0,
},
max: {
placeholder: '1000',
value: 1000,
},
},
textRange: {
min: {
placeholder: '0',
value: 0,
},
max: {
placeholder: '500',
value: 500,
},
},
},
],
},
},
pageId: '6659c3283b1cb279bc2e2b0c',
};
const mockAggregationResult = [
{
field: 'data515',
data: {
aggregation: [
{
id: '115019',
count: 1,
},
{
id: '115020',
count: 1,
},
],
submitionCount: 2,
},
},
{
field: 'data893',
data: {
aggregation: [
{
id: '466671',
count: 2,
},
{
id: '095415',
count: 1,
},
],
submitionCount: 2,
},
},
{
field: 'data820',
data: {
aggregation: [
{
id: '8',
count: 1,
},
],
submitionCount: 1,
},
},
{
field: 'data549',
data: {
aggregation: [
{
id: '5',
count: 1,
},
],
submitionCount: 1,
},
},
];
jest
.spyOn(responseSchemaService, 'getResponseSchemaByPageId')
.mockResolvedValueOnce(mockResponseSchema as any);
jest
.spyOn(dataStatisticService, 'aggregationStatis')
.mockResolvedValueOnce(mockAggregationResult);
const result = await controller.aggregationStatis(mockRequest.query);
expect(result).toEqual({
code: 200,
data: expect.any(Array),
});
});
it('should throw an exception if validation fails', async () => {
const mockRequest = {
query: {
surveyId: '',
},
};
await expect(
controller.aggregationStatis(mockRequest.query),
).rejects.toThrow(HttpException);
});
it('should return empty data if response schema does not exist', async () => {
const mockRequest = {
query: {
surveyId: new ObjectId().toString(),
},
};
jest
.spyOn(responseSchemaService, 'getResponseSchemaByPageId')
.mockResolvedValueOnce(null);
const result = await controller.aggregationStatis(mockRequest.query);
expect(result).toEqual({
code: 200,
data: [],
});
});
});
});

186
server/src/modules/survey/__test/dataStatistic.service.spec.ts
View File

@ -11,7 +11,7 @@ import { cloneDeep } from 'lodash';
import { getRepositoryToken } from '@nestjs/typeorm';
import { RECORD_STATUS } from 'src/enums';
import { PluginManagerProvider } from 'src/securityPlugin/pluginManager.provider';
import { PluginManager } from 'src/securityPlugin/pluginManager';
import { XiaojuSurveyPluginManager } from 'src/securityPlugin/pluginManager';
import { ResponseSecurityPlugin } from 'src/securityPlugin/responseSecurityPlugin';
describe('DataStatisticService', () => {
@ -34,7 +34,9 @@ describe('DataStatisticService', () => {
surveyResponseRepository = module.get<MongoRepository<SurveyResponse>>(
getRepositoryToken(SurveyResponse),
);
const manager = module.get<PluginManager>(PluginManager);
const manager = module.get<XiaojuSurveyPluginManager>(
XiaojuSurveyPluginManager,
);
manager.registerPlugin(
new ResponseSecurityPlugin('dataAesEncryptSecretKey'),
);
@ -68,7 +70,7 @@ describe('DataStatisticService', () => {
data413: 3,
data863: '109239',
},
diffTime: 21278,
difTime: 21278,
clientTime: 1710340862733.0,
secretKeys: [],
optionTextAndId: {
@ -151,8 +153,8 @@ describe('DataStatisticService', () => {
date: 1710340863123.0,
},
],
createdAt: 1710340863123.0,
updatedAt: 1710340863123.0,
createDate: 1710340863123.0,
updateDate: 1710340863123.0,
},
] as unknown as Array<SurveyResponse>;
@ -195,14 +197,15 @@ describe('DataStatisticService', () => {
data413_3: expect.any(String),
data413: expect.any(Number),
data863: expect.any(String),
diffTime: expect.any(String),
createdAt: expect.any(String),
data413_custom: expect.any(String),
difTime: expect.any(String),
createDate: expect.any(String),
}),
]),
});
});
it('should return desensitized table data', async () => {
it('should return desensitive table data', async () => {
const mockSchema = cloneDeep(mockSensitiveResponseSchema);
const surveyResponseList: Array<SurveyResponse> = [
{
@ -218,7 +221,7 @@ describe('DataStatisticService', () => {
'U2FsdGVkX19bRmf3uEmXAJ/6zXd1Znr3cZsD5v4Nocr2v5XG1taXluz8cohFkDyH',
data770: 'U2FsdGVkX18ldQMhJjFXO8aerjftZLpFnRQ4/FVcCLI=',
},
diffTime: 806707,
difTime: 806707,
clientTime: 1710400229573.0,
secretKeys: ['data458', 'data450', 'data405', 'data770'],
optionTextAndId: {
@ -273,8 +276,8 @@ describe('DataStatisticService', () => {
date: 1710400232161.0,
},
],
createdAt: 1710400232161.0,
updatedAt: 1710400232161.0,
createDate: 1710400232161.0,
updateDate: 1710400232161.0,
},
] as unknown as Array<SurveyResponse>;
@ -295,173 +298,16 @@ describe('DataStatisticService', () => {
expect(result.listBody).toEqual(
expect.arrayContaining([
expect.objectContaining({
createdAt: expect.any(String),
createDate: expect.any(String),
data405: expect.any(String),
data450: expect.any(String),
data458: expect.any(String),
data515: expect.any(String),
data770: expect.any(String),
diffTime: expect.any(String),
difTime: expect.any(String),
}),
]),
);
});
});
describe('aggregationStatis', () => {
it('should return correct aggregation data', async () => {
const surveyId = '65afc62904d5db18534c0f78';
const mockAggregationResult = {
data515: [
{
count: 1,
data: {
data515: '115019',
},
},
{
count: 1,
data: {
data515: '115020',
},
},
],
data893: [
{
count: 1,
data: {
data893: ['466671'],
},
},
{
count: 1,
data: {
data893: ['466671', '095415'],
},
},
],
data820: [
{
count: 1,
data: {
data820: 8,
},
},
],
data549: [
{
count: 1,
data: {
data549: 5,
},
},
],
};
const fieldList = Object.keys(mockAggregationResult);
jest.spyOn(surveyResponseRepository, 'aggregate').mockReturnValue({
next: jest.fn().mockResolvedValue(mockAggregationResult),
} as any);
const result = await service.aggregationStatis({
surveyId,
fieldList,
});
expect(result).toEqual(
expect.arrayContaining([
{
field: 'data515',
data: {
aggregation: [
{
id: '115019',
count: 1,
},
{
id: '115020',
count: 1,
},
],
submitionCount: 2,
},
},
{
field: 'data893',
data: {
aggregation: [
{
id: '466671',
count: 2,
},
{
id: '095415',
count: 1,
},
],
submitionCount: 2,
},
},
{
field: 'data820',
data: {
aggregation: [
{
id: '8',
count: 1,
},
],
submitionCount: 1,
},
},
{
field: 'data549',
data: {
aggregation: [
{
id: '5',
count: 1,
},
],
submitionCount: 1,
},
},
]),
);
});
it('should return empty aggregation data when no responses', async () => {
const surveyId = '65afc62904d5db18534c0f78';
const fieldList = ['data458', 'data515'];
jest.spyOn(surveyResponseRepository, 'aggregate').mockReturnValue({
next: jest.fn().mockResolvedValue({}),
} as any);
const result = await service.aggregationStatis({
surveyId,
fieldList,
});
expect(result).toEqual(
expect.arrayContaining([
{
field: 'data458',
data: {
aggregation: [],
submitionCount: 0,
},
},
{
field: 'data515',
data: {
aggregation: [],
submitionCount: 0,
},
},
]),
);
});
});
});

264
server/src/modules/survey/__test/downloadTask.controller.spec.ts
View File

@ -1,264 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { ObjectId } from 'mongodb';
import { DownloadTaskController } from '../controllers/downloadTask.controller';
import { ResponseSchemaService } from '../../surveyResponse/services/responseScheme.service';
import { AuthService } from 'src/modules/auth/services/auth.service';
import { DownloadTaskService } from '../services/downloadTask.service';
import { CollaboratorService } from '../services/collaborator.service';
import { SurveyMetaService } from '../services/surveyMeta.service';
import { WorkspaceMemberService } from 'src/modules/workspace/services/workspaceMember.service';
import { Logger } from 'src/logger';
import { HttpException } from 'src/exceptions/httpException';
import { NoPermissionException } from 'src/exceptions/noPermissionException';
import { EXCEPTION_CODE } from 'src/enums/exceptionCode';
import { Authentication } from 'src/guards/authentication.guard';
import { SurveyGuard } from 'src/guards/survey.guard';
describe('DownloadTaskController', () => {
let controller: DownloadTaskController;
let responseSchemaService: ResponseSchemaService;
let downloadTaskService: DownloadTaskService;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [DownloadTaskController],
providers: [
{
provide: ResponseSchemaService,
useValue: {
getResponseSchemaByPageId: jest.fn(),
},
},
{
provide: DownloadTaskService,
useValue: {
createDownloadTask: jest.fn(),
processDownloadTask: jest.fn(),
getDownloadTaskList: jest.fn(),
getDownloadTaskById: jest.fn(),
deleteDownloadTask: jest.fn(),
},
},
{
provide: Logger,
useValue: {
error: jest.fn(),
},
},
{
provide: AuthService,
useClass: jest.fn().mockImplementation(() => ({
varifytoken() {
return {};
},
})),
},
{
provide: CollaboratorService,
useValue: {},
},
{
provide: SurveyMetaService,
useValue: {},
},
{
provide: WorkspaceMemberService,
useValue: {},
},
{
provide: Authentication,
useClass: jest.fn().mockImplementation(() => ({
canActivate: () => true,
})),
},
{
provide: SurveyGuard,
useClass: jest.fn().mockImplementation(() => ({
canActivate: () => true,
})),
},
],
}).compile();
controller = module.get<DownloadTaskController>(DownloadTaskController);
responseSchemaService = module.get<ResponseSchemaService>(
ResponseSchemaService,
);
downloadTaskService = module.get<DownloadTaskService>(DownloadTaskService);
});
describe('createTask', () => {
it('should create a download task successfully', async () => {
const mockReqBody = {
surveyId: new ObjectId().toString(),
isMasked: false,
};
const mockReq = { user: { _id: 'mockUserId', username: 'mockUsername' } };
const mockTaskId = 'mockTaskId';
jest
.spyOn(responseSchemaService, 'getResponseSchemaByPageId')
.mockResolvedValue({} as any);
jest
.spyOn(downloadTaskService, 'createDownloadTask')
.mockResolvedValue(mockTaskId);
const result = await controller.createTask(mockReqBody, mockReq);
expect(
responseSchemaService.getResponseSchemaByPageId,
).toHaveBeenCalledWith(mockReqBody.surveyId);
expect(downloadTaskService.createDownloadTask).toHaveBeenCalledWith({
surveyId: mockReqBody.surveyId,
responseSchema: {},
creatorId: mockReq.user._id.toString(),
creator: mockReq.user.username,
params: { isMasked: mockReqBody.isMasked },
});
expect(downloadTaskService.processDownloadTask).toHaveBeenCalledWith({
taskId: mockTaskId,
});
expect(result).toEqual({ code: 200, data: { taskId: mockTaskId } });
});
it('should throw HttpException if validation fails', async () => {
const mockReqBody: any = { isMasked: false };
const mockReq = { user: { _id: 'mockUserId', username: 'mockUsername' } };
await expect(controller.createTask(mockReqBody, mockReq)).rejects.toThrow(
HttpException,
);
});
});
describe('downloadList', () => {
it('should return the download task list', async () => {
const mockQueryInfo = { pageIndex: 1, pageSize: 10 };
const mockReq = { user: { _id: 'mockUserId' } };
const mockTaskList: any = {
total: 1,
list: [
{
_id: 'mockTaskId',
curStatus: 'completed',
filename: 'mockFile.csv',
url: 'http://mock-url.com',
fileSize: 1024,
createdAt: Date.now(),
},
],
};
jest
.spyOn(downloadTaskService, 'getDownloadTaskList')
.mockResolvedValue(mockTaskList);
const result = await controller.downloadList(mockQueryInfo, mockReq);
expect(downloadTaskService.getDownloadTaskList).toHaveBeenCalledWith({
creatorId: mockReq.user._id.toString(),
pageIndex: mockQueryInfo.pageIndex,
pageSize: mockQueryInfo.pageSize,
});
expect(result.data.total).toEqual(mockTaskList.total);
expect(result.data.list[0].taskId).toEqual(
mockTaskList.list[0]._id.toString(),
);
});
it('should throw HttpException if validation fails', async () => {
const mockQueryInfo: any = { pageIndex: 'invalid', pageSize: 10 };
const mockReq = { user: { _id: 'mockUserId' } };
await expect(
controller.downloadList(mockQueryInfo, mockReq),
).rejects.toThrow(HttpException);
});
});
describe('getDownloadTask', () => {
it('should return a download task', async () => {
const mockQuery = { taskId: 'mockTaskId' };
const mockReq = { user: { _id: 'mockUserId' } };
const mockTaskInfo: any = {
_id: 'mockTaskId',
creatorId: 'mockUserId',
curStatus: 'completed',
};
jest
.spyOn(downloadTaskService, 'getDownloadTaskById')
.mockResolvedValue(mockTaskInfo);
const result = await controller.getDownloadTask(mockQuery, mockReq);
expect(downloadTaskService.getDownloadTaskById).toHaveBeenCalledWith({
taskId: mockQuery.taskId,
});
expect(result.data.taskId).toEqual(mockTaskInfo._id.toString());
});
it('should throw NoPermissionException if user has no permission', async () => {
const mockQuery = { taskId: 'mockTaskId' };
const mockReq = { user: { _id: new ObjectId() } };
const mockTaskInfo: any = {
_id: 'mockTaskId',
creatorId: 'mockUserId',
curStatus: 'completed',
};
jest
.spyOn(downloadTaskService, 'getDownloadTaskById')
.mockResolvedValue(mockTaskInfo);
await expect(
controller.getDownloadTask(mockQuery, mockReq),
).rejects.toThrow(new NoPermissionException('没有权限'));
});
});
describe('deleteFileByName', () => {
it('should delete a download task successfully', async () => {
const mockBody = { taskId: 'mockTaskId' };
const mockUserId = new ObjectId();
const mockReq = {
user: { _id: mockUserId, username: 'mockUsername' },
};
const mockTaskInfo: any = {
_id: new ObjectId(),
creatorId: mockUserId.toString(),
};
const mockDelRes = { modifiedCount: 1 };
jest
.spyOn(downloadTaskService, 'getDownloadTaskById')
.mockResolvedValue(mockTaskInfo);
jest
.spyOn(downloadTaskService, 'deleteDownloadTask')
.mockResolvedValue(mockDelRes);
const result = await controller.deleteFileByName(mockBody, mockReq);
expect(downloadTaskService.deleteDownloadTask).toHaveBeenCalledWith({
taskId: mockBody.taskId,
operator: mockReq.user.username,
operatorId: mockReq.user._id.toString(),
});
expect(result).toEqual({ code: 200, data: true });
});
it('should throw HttpException if task does not exist', async () => {
const mockBody = { taskId: 'mockTaskId' };
const mockReq = { user: { _id: 'mockUserId' } };
jest
.spyOn(downloadTaskService, 'getDownloadTaskById')
.mockResolvedValue(null);
await expect(
controller.deleteFileByName(mockBody, mockReq),
).rejects.toThrow(
new HttpException('任务不存在', EXCEPTION_CODE.PARAMETER_ERROR),
);
});
});
});

245
server/src/modules/survey/__test/downloadTask.service.spec.ts
View File

@ -1,245 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { DownloadTaskService } from '../services/downloadTask.service';
import { MongoRepository } from 'typeorm';
import { getRepositoryToken } from '@nestjs/typeorm';
import { DownloadTask } from 'src/models/downloadTask.entity';
import { SurveyResponse } from 'src/models/surveyResponse.entity';
import { ResponseSchemaService } from 'src/modules/surveyResponse/services/responseScheme.service';
import { DataStatisticService } from '../services/dataStatistic.service';
import { FileService } from 'src/modules/file/services/file.service';
import { Logger } from 'src/logger';
import { ObjectId } from 'mongodb';
import { DOWNLOAD_TASK_STATUS } from 'src/enums/downloadTaskStatus';
describe('DownloadTaskService', () => {
let service: DownloadTaskService;
let downloadTaskRepository: MongoRepository<DownloadTask>;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
DownloadTaskService,
{
provide: getRepositoryToken(DownloadTask),
useClass: MongoRepository,
},
{
provide: getRepositoryToken(SurveyResponse),
useClass: MongoRepository,
},
{
provide: ResponseSchemaService,
useValue: {
getResponseSchemaByPageId: jest.fn(),
},
},
{
provide: DataStatisticService,
useValue: {
getDataTable: jest.fn(),
},
},
{
provide: FileService,
useValue: {
upload: jest.fn(),
},
},
{
provide: Logger,
useValue: {
info: jest.fn(),
error: jest.fn(),
},
},
],
}).compile();
service = module.get<DownloadTaskService>(DownloadTaskService);
downloadTaskRepository = module.get<MongoRepository<DownloadTask>>(
getRepositoryToken(DownloadTask),
);
});
describe('createDownloadTask', () => {
it('should create and save a download task', async () => {
const mockTaskId = new ObjectId().toString();
const mockDownloadTask = { _id: new ObjectId(mockTaskId) };
const mockParams: any = {
surveyId: 'survey1',
responseSchema: { title: 'test-title', surveyPath: '/path' },
creatorId: 'creator1',
creator: 'creatorName',
params: { isMasked: true },
};
jest
.spyOn(downloadTaskRepository, 'create')
.mockReturnValue(mockDownloadTask as any);
jest
.spyOn(downloadTaskRepository, 'save')
.mockResolvedValue(mockDownloadTask as any);
const result = await service.createDownloadTask(mockParams);
expect(downloadTaskRepository.create).toHaveBeenCalledWith({
surveyId: mockParams.surveyId,
surveyPath: mockParams.responseSchema.surveyPath,
fileSize: '计算中',
creatorId: mockParams.creatorId,
creator: mockParams.creator,
params: {
...mockParams.params,
title: mockParams.responseSchema.title,
},
filename: expect.any(String),
status: DOWNLOAD_TASK_STATUS.WAITING,
});
expect(downloadTaskRepository.save).toHaveBeenCalled();
expect(result).toEqual(mockTaskId);
});
});
describe('getDownloadTaskList', () => {
it('should return task list and total count', async () => {
const mockCreatorId = 'creator1';
const mockTasks = [{ _id: '1' }, { _id: '2' }];
const mockTotal = 2;
jest
.spyOn(downloadTaskRepository, 'findAndCount')
.mockResolvedValue([mockTasks as any, mockTotal]);
const result = await service.getDownloadTaskList({
creatorId: mockCreatorId,
pageIndex: 1,
pageSize: 10,
});
expect(downloadTaskRepository.findAndCount).toHaveBeenCalledWith({
where: {
creatorId: mockCreatorId,
isDeleted: { $ne: true },
},
take: 10,
skip: 0,
order: { createdAt: -1 },
});
expect(result).toEqual({
total: mockTotal,
list: mockTasks,
});
});
});
describe('getDownloadTaskById', () => {
it('should return task by id', async () => {
const mockTaskId = new ObjectId().toString();
const mockTask = { _id: new ObjectId(mockTaskId) };
jest
.spyOn(downloadTaskRepository, 'find')
.mockResolvedValue([mockTask as any]);
const result = await service.getDownloadTaskById({ taskId: mockTaskId });
expect(downloadTaskRepository.find).toHaveBeenCalledWith({
where: { _id: new ObjectId(mockTaskId) },
});
expect(result).toEqual(mockTask);
});
it('should return null if task is not found', async () => {
const mockTaskId = new ObjectId().toString();
jest.spyOn(downloadTaskRepository, 'find').mockResolvedValue([]);
const result = await service.getDownloadTaskById({ taskId: mockTaskId });
expect(result).toBeNull();
});
});
describe('deleteDownloadTask', () => {
it('should mark task as deleted and set deletedAt', async () => {
const mockTaskId = new ObjectId().toString();
const mockOperator = 'operatorName';
const mockOperatorId = 'operatorId1';
const mockUpdateResult = { matchedCount: 1 };
jest
.spyOn(downloadTaskRepository, 'updateOne')
.mockResolvedValue(mockUpdateResult as any);
const result = await service.deleteDownloadTask({
taskId: mockTaskId,
operator: mockOperator,
operatorId: mockOperatorId,
});
expect(downloadTaskRepository.updateOne).toHaveBeenCalledWith(
{ _id: new ObjectId(mockTaskId) },
{
$set: {
isDeleted: true,
operator: mockOperator,
operatorId: mockOperatorId,
deletedAt: expect.any(Date),
},
},
);
expect(result).toEqual(mockUpdateResult);
});
});
describe('processDownloadTask', () => {
it('should push task to queue and execute if not executing', async () => {
const mockTaskId = new ObjectId().toString();
jest.spyOn(service, 'executeTask').mockImplementation(jest.fn());
service.processDownloadTask({ taskId: mockTaskId });
expect(DownloadTaskService.taskList).toContain(mockTaskId);
expect(service.executeTask).toHaveBeenCalled();
});
it('should handle already executing case', async () => {
const mockTaskId = new ObjectId().toString();
DownloadTaskService.isExecuting = true;
jest.spyOn(service, 'executeTask').mockImplementation(jest.fn());
service.processDownloadTask({ taskId: mockTaskId });
expect(DownloadTaskService.taskList).toContain(mockTaskId);
expect(service.executeTask).not.toHaveBeenCalled();
});
});
describe('executeTask', () => {
it('should process and execute tasks in queue', async () => {
const mockTaskId = new ObjectId().toString();
DownloadTaskService.taskList.push(mockTaskId);
jest.spyOn(service, 'getDownloadTaskById').mockResolvedValue({
_id: new ObjectId(mockTaskId),
isDeleted: false,
} as any);
jest.spyOn(service, 'handleDownloadTask').mockResolvedValue(undefined);
await service.executeTask();
expect(service.getDownloadTaskById).toHaveBeenCalledWith({
taskId: mockTaskId,
});
expect(service.handleDownloadTask).toHaveBeenCalled();
});
it('should stop executing when queue is empty', async () => {
DownloadTaskService.taskList = [];
await service.executeTask();
expect(DownloadTaskService.isExecuting).toBe(false);
});
});
});

38
server/src/modules/survey/__test/mockResponseSchema.ts
View File

@ -14,8 +14,8 @@ export const mockSensitiveResponseSchema: ResponseSchema = {
date: 1710399368439,
},
],
createdAt: 1710399368440,
updatedAt: 1710399368440,
createDate: 1710399368440,
updateDate: 1710399368440,
title: '加密全流程',
surveyPath: 'EBzdmnSp',
code: {
@ -32,7 +32,7 @@ export const mockSensitiveResponseSchema: ResponseSchema = {
},
},
baseConf: {
beginTime: '2024-03-14 14:54:41',
begTime: '2024-03-14 14:54:41',
endTime: '2034-03-14 14:54:41',
language: 'chinese',
tLimit: 0,
@ -44,17 +44,6 @@ export const mockSensitiveResponseSchema: ResponseSchema = {
logoImageWidth: '60%',
},
skinConf: {
backgroundConf: {
color: '#fff',
type: 'color',
image: '',
},
themeConf: {
color: '#ffa600',
},
contentConf: {
opacity: 100,
},
skinColor: '#4a4c5b',
inputBgColor: '#ffffff',
},
@ -295,7 +284,7 @@ export const mockSensitiveResponseSchema: ResponseSchema = {
},
},
pageId: '65f29f3192862d6a9067ad1c',
} as unknown as ResponseSchema;
} as ResponseSchema;
export const mockResponseSchema: ResponseSchema = {
_id: new ObjectId('65b0d46e04d5db18534c0f7c'),
@ -326,7 +315,7 @@ export const mockResponseSchema: ResponseSchema = {
},
},
baseConf: {
beginTime: '2024-01-23 21:59:05',
begTime: '2024-01-23 21:59:05',
endTime: '2034-01-23 21:59:05',
language: 'chinese',
tLimit: 0,
@ -338,17 +327,6 @@ export const mockResponseSchema: ResponseSchema = {
logoImageWidth: '60%',
},
skinConf: {
backgroundConf: {
color: '#fff',
type: 'color',
image: '',
},
themeConf: {
color: '#ffa600',
},
contentConf: {
opacity: 100,
},
skinColor: '#4a4c5b',
inputBgColor: '#ffffff',
},
@ -654,6 +632,6 @@ export const mockResponseSchema: ResponseSchema = {
},
},
pageId: '65afc62904d5db18534c0f78',
createdAt: 1710340841289,
updatedAt: 1710340841289.0,
} as unknown as ResponseSchema;
createDate: 1710340841289,
updateDate: 1710340841289.0,
} as ResponseSchema;

87
server/src/modules/survey/__test/session.controller.spec.ts
View File

@ -1,87 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { SessionController } from '../controllers/session.controller';
import { SessionService } from '../services/session.service';
import { Logger } from 'src/logger';
import { HttpException } from 'src/exceptions/httpException';
import { Authentication } from 'src/guards/authentication.guard';
import { SurveyGuard } from 'src/guards/survey.guard';
import { SessionGuard } from 'src/guards/session.guard';
describe('SessionController', () => {
let controller: SessionController;
let sessionService: jest.Mocked<SessionService>;
let logger: jest.Mocked<Logger>;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
controllers: [SessionController],
providers: [
{
provide: SessionService,
useValue: {
create: jest.fn(),
updateSessionToEditing: jest.fn(),
},
},
{
provide: Logger,
useValue: {
error: jest.fn(),
},
},
],
})
.overrideGuard(Authentication)
.useValue({ canActivate: () => true })
.overrideGuard(SurveyGuard)
.useValue({ canActivate: () => true })
.overrideGuard(SessionGuard)
.useValue({ canActivate: () => true })
.compile();
controller = module.get<SessionController>(SessionController);
sessionService = module.get<jest.Mocked<SessionService>>(SessionService);
logger = module.get<jest.Mocked<Logger>>(Logger);
});
it('should create a session', async () => {
const reqBody = { surveyId: '123' };
const req = { user: { _id: 'userId' } };
const session: any = { _id: 'sessionId' };
sessionService.create.mockResolvedValue(session);
const result = await controller.create(reqBody, req);
expect(sessionService.create).toHaveBeenCalledWith({
surveyId: '123',
userId: 'userId',
});
expect(result).toEqual({ code: 200, data: { sessionId: 'sessionId' } });
});
it('should throw an exception if validation fails', async () => {
const reqBody = { surveyId: null };
const req = { user: { _id: 'userId' } };
try {
await controller.create(reqBody, req);
} catch (error) {
expect(error).toBeInstanceOf(HttpException);
expect(logger.error).toHaveBeenCalled();
}
});
it('should seize a session', async () => {
const req = {
sessionInfo: { _id: 'sessionId', surveyId: 'surveyId' },
};
await controller.seize(req);
expect(sessionService.updateSessionToEditing).toHaveBeenCalledWith({
sessionId: 'sessionId',
surveyId: 'surveyId',
});
});
});

144
server/src/modules/survey/__test/session.service.spec.ts
View File

@ -1,144 +0,0 @@
import { Test, TestingModule } from '@nestjs/testing';
import { MongoRepository } from 'typeorm';
import { getRepositoryToken } from '@nestjs/typeorm';
import { SessionService } from '../services/session.service';
import { Session } from 'src/models/session.entity';
import { ObjectId } from 'mongodb';
import { SESSION_STATUS } from 'src/enums/surveySessionStatus';
describe('SessionService', () => {
let service: SessionService;
let repository: MongoRepository<Session>;
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [
SessionService,
{
provide: getRepositoryToken(Session),
useClass: MongoRepository,
},
],
}).compile();
service = module.get<SessionService>(SessionService);
repository = module.get<MongoRepository<Session>>(
getRepositoryToken(Session),
);
});
afterEach(() => {
jest.clearAllMocks();
});
describe('create', () => {
it('should create and save a new session', async () => {
const mockSession = {
surveyId: 'survey123',
userId: 'user123',
status: SESSION_STATUS.DEACTIVATED,
};
const createdSession: any = { ...mockSession, _id: new ObjectId() };
jest.spyOn(repository, 'create').mockReturnValue(createdSession);
jest.spyOn(repository, 'save').mockResolvedValue(createdSession);
const result = await service.create({
surveyId: mockSession.surveyId,
userId: mockSession.userId,
});
expect(result).toEqual(createdSession);
expect(repository.create).toHaveBeenCalledWith(mockSession);
expect(repository.save).toHaveBeenCalledWith(createdSession);
});
});
describe('findOne', () => {
it('should find a session by id', async () => {
const sessionId = '65afc62904d5db18534c0f78';
const foundSession = {
_id: new ObjectId(sessionId),
surveyId: 'survey123',
userId: 'user123',
status: SESSION_STATUS.ACTIVATED,
};
jest
.spyOn(repository, 'findOne')
.mockResolvedValue(foundSession as Session);
const result = await service.findOne(sessionId);
expect(result).toEqual(foundSession);
expect(repository.findOne).toHaveBeenCalledWith({
where: { _id: new ObjectId(sessionId) },
});
});
});
describe('findLatestEditingOne', () => {
it('should find the latest editing session for a survey', async () => {
const surveyId = 'survey123';
const latestSession = {
_id: new ObjectId(),
surveyId: surveyId,
userId: 'user123',
status: SESSION_STATUS.ACTIVATED,
};
jest
.spyOn(repository, 'findOne')
.mockResolvedValue(latestSession as Session);
const result = await service.findLatestEditingOne({ surveyId });
expect(result).toEqual(latestSession);
expect(repository.findOne).toHaveBeenCalledWith({
where: {
surveyId,
status: SESSION_STATUS.ACTIVATED,
},
});
});
});
describe('updateSessionToEditing', () => {
it('should update a session to editing and deactivate other sessions', async () => {
const sessionId = '65afc62904d5db18534c0f78';
const surveyId = 'survey123';
const updateResult: any = { affected: 1 };
const updateManyResult = { modifiedCount: 1 };
jest.spyOn(repository, 'update').mockResolvedValue(updateResult);
jest.spyOn(repository, 'updateMany').mockResolvedValue(updateManyResult);
const result = await service.updateSessionToEditing({
sessionId,
surveyId,
});
expect(result).toEqual([updateResult, updateManyResult]);
expect(repository.update).toHaveBeenCalledWith(
{ _id: new ObjectId(sessionId) },
{
status: SESSION_STATUS.ACTIVATED,
updatedAt: expect.any(Date),
},
);
expect(repository.updateMany).toHaveBeenCalledWith(
{
surveyId,
_id: { $ne: new ObjectId(sessionId) },
},
{
$set: {
status: SESSION_STATUS.DEACTIVATED,
updatedAt: expect.any(Date),
},
},
);
});
});
});

Some files were not shown because too many files have changed in this diff Show More