duongdev commented 5 years ago

Purpose

Admin sẽ tạo một đợt đăng ký ăn cho phép học sinh đăng ký trước các buổi ăn và món ăn trong khoảng thời gian cho phép.
Admin có thể quản lý các đợt đăng ký đã tạo, các buổi ăn có trong đợt đăng ký, thời gian bắt đầu và thời gian kết thúc của mỗi đợt ăn.
Admin lên được thực đơn cho mỗi buổi ăn có trong đợt đăng ký.
Admin có thể hủy đăng ký ăn cho một hoặc nhiều học sinh hoặc toàn trường theo từng buổi ăn và có thể được nhập từ excel.
Admin có thể nhập danh sách học sinh đã ăn bằng excel.
Admin có thể Approve/Reject yêu cầu huỷ ăn của học sinh, nếu yêu cầu được tạo bởi admin hoặc trước X ngày hoặc ngày nghỉ có phép thì sẽ được tự động Approve.
Học sinh có thể đăng ký ăn và gửi yêu cầu hủy ăn.
Yêu cầu hủy ăn của học sinh sẽ được tự động tạo dựa theo ngày nghỉ có phép của học sinh.

nguyenthienthanh commented 5 years ago

Implementation

Đợt đăng ký

Model:

name: MealPeriod
fields:
- name: string, mặc định là "", có thể cập nhật lại
- registrationStartsAt: Date, ngày mở đăng ký
- registrationEndsAt: Date, ngày đóng đăng ký
- createdByUserId: ID, mã người dùng tạo MealPeriod

Services

createMealPeriod

Input

name: (optional)
registrationStartsAt: (required) Date
registrationEndsAt: (required) Date
createdByUserId: (required) ID
Validation
Nếu createdByUserId không được nhập thì thông báo lỗi Mã người tạo không được để trống
Nếu registrationStartsAt không được nhập thì thông báo lỗi Ngày mở đăng ký không được để trống
Nếu registrationEndsAt không được nhập thì thông báo lỗi Ngày đóng đăng ký không được để trống
Nếu registrationStartsAt sau ngày registrationEndsAt thì thông báo lỗi Ngày mở đăng ký phải trước ngày đóng đăng ký (registrationEndsAt) registrationEndsAt định dạng theo MM/DD/YYYY
Process
Tạo đợt đăng ký với dữ liệu hợp lệ
Output
Thông tin đợt đăng ký đã tạo

getMealPeriods

Input

search: (optional) string, từ khóa để tìm kiếm theo name
registrationStartSince: (optional) Date, thời gian mở đăng ký từ registrationStartSince đến nay hoặc registrationStartUntil
registrationStartUntil: (optional) Date, thời gian mở đăng ký từ registrationStartSince đến registrationStartUntil
registrationEndSince: (optional) Date, thời gian đóng đăng ký từ registrationEndSince đến nay hoặc registrationStartUntil
registrationEndUntil: (optional) Date, thời gian đóng đăng ký từ registrationEndSince đến registrationEndUntil
offset: (optional) number, mặc định là 0, số lượng bỏ qua
limit: (optional) number, mặc định là 10, giới hạn số MealPeriod được trả về mỗi query
orderBY: (optional) string, mặc định là reverse_ registrationStartsAt, thứ tự sắp xếp danh sách MealPeriod, là một trong các key sau registrationStartsAt, reverse_ registrationStartsAt, registrationEndsAt, reverse_ registrationEndsAt
Validation
Nếu search được nhập và không phải là string thì thông báo lỗi Từ khóa phải là chuỗi ký tự
Nếu registrationStartSince được nhập và không phải ngày thì thông báo lỗi Thời gian mở đăng ký phải là ngày
Nếu registrationStartUntil được nhập và không phải ngày thì thông báo lỗi Thời gian mở đăng ký phải là ngày
Nếu registrationStartSince sau thời gian registrationStartUntil thì thông báo lỗi Thời gian mở đăng ký "từ" phải trước thời gian đăng ký "đến"
Nếu registrationEndSince được nhập và không phải ngày thì thông báo lỗi Thời gian đóng đăng ký phải là ngày
Nếu registrationEndSince được nhập và không phải ngày thì thông báo lỗi Thời gian đóng đăng ký phải là ngày
Nếu registrationEndSince sau thời gian registrationEndUntil thì thông báo lỗi Thời gian đóng đăng ký "từ" phải trước thời gian đăng ký "đến"
Nếu offset không phải là số nguyên dương thì thông báo lỗi Số lượng bỏ qua phải là một số nguyên dương
Nếu limit không phải là số nguyên dương thì thông báo lỗi Giới hạn số lượng phải là một số nguyên dương
Nếu orderBy không phải là một trong các từ khóa hợp lệ thì thông báo lỗi Sắp xếp phải là một trong các giá trị sau registrationStartsAt, reverse_ registrationStartsAt, registrationEndsAt, reverse_ registrationEndsAt
Process: xử lý này được viết cho dự án sử dụng mongoose
Sử dụng filter để tìm các MealPeriod
Nếu search được nhập thì filter.name = { $regex: ${search}, $options: 'i' }
Nếu registrationStartSince được nhập và filter.registrationStartsAt chưa có thì khởi tạo là {}, và filter. registrationStartsAt.$gte = ${registrationStartSince}
Nếu registrationStartUntil được nhập và filter.registrationStartsAt chưa có thì khởi tạo là {}, và filter. registrationStartsAt.$lt = ${registrationStartUntil}
Nếu registrationEndSince được nhập và filter.registrationEndsAt chưa có thì khởi tạo là {}, và filter. registrationEndsAt.$gte = ${registrationEndSince}
Nếu registrationEndUntil được nhập và filter.registrationEndsAt chưa có thì khởi tạo là {}, và filter. registrationEndsAt.$lt = ${registrationEndUntil}
skip = offset
limit = limit
Nếu orderBy có reverse thì sortBy sẽ có dạng { [key]: -1 } và { [key]: 1 } nếu không có reverse
Tìm tất cả các MealPeriod theo filter với skip, limit và sortBy vừa lấy được,
Đồng thời đếm tất cả MealPeriod theo filter
Thu được danh sách các MealPeriod và tổng số lượng các MealPeriod hợp lệ
Output

Một object bao gồm:
total: Tổng số MealPeriod
offset: Số lượng bỏ qua hiện tại
limit: Số lượng được giới hạn
mealPeriods: Danh sách MealPeriod

getMealPeriod

Input

id: Mã của MealPeriod
Process
TÌm MealPeriod ứng với id
Output
MealPeriod nếu tìm được, null nếu không tim được

Mutations

createMealPeriod

Authenticate

Nếu người dùng chưa đăng nhập thì thông báo lỗi unauthorized
Nếu người dùng đang có roles là deactivated thì thông báo lỗi unauthorized
Nếu người dùng không có roles là admin thì thông báo lỗi permission_denied
Input
name: (optional)
registrationStartsAt: (required) Date
registrationEndsAt: (required) Date
Validation
Nếu registrationStartsAt không được nhập thì thông báo lỗi Ngày mở đăng ký không được để trống
Nếu registrationEndsAt không được nhập thì thông báo lỗi Ngày đóng đăng ký không được để trống
Nếu registrationStartsAt sau ngày registrationEndsAt thì thông báo lỗi Ngày mở đăng ký phải trước ngày đóng đăng ký (registrationEndsAt) registrationEndsAt định dạng theo MM/DD/YYYY
Process
Sau khi người dùng đã đăng nhập và có đầy đủ quyền để tạo MealPeriod thì createdByUserId sẽ là ID của người dùng đang đăng nhập user.id
Thực thi service createMealPeriod với input hợp lệ.
Output
Thông tin MealPeriod đã tạo

Queries

mealPeriods

Input

search: (optional) string, từ khóa để tìm kiếm theo name
registrationStartSince: (optional) DateTime, thời gian mở đăng ký từ registrationStartSince đến nay hoặc registrationStartUntil
registrationStartUntil: (optional) DateTime, thời gian mở đăng ký từ registrationStartSince đến registrationStartUntil
registrationEndSince: (optional) DateTime, thời gian đóng đăng ký từ registrationEndSince đến nay hoặc registrationStartUntil
registrationEndUntil: (optional) DateTime, thời gian đóng đăng ký từ registrationEndSince đến registrationEndUntil
offset: (optional) Int, mặc định là 1
limit: (optional) Int, mặc định là 10, tổng số MealPeriod trên một trang
orderBy: (optional) string, mặc định là reverse_ registrationStartsAt, thứ tự sắp xếp danh sách MealPeriod, là một trong các enum sau registrationStartsAt, reverse_ registrationStartsAt, registrationEndsAt, reverse_ registrationEndsAt
Process
Gọi service getMealPeriods với input hợp lệ
Output

Một type (MealPeriodsResult) bao gồm:
total: Tổng số MealPeriod
offset: Số lượng bỏ qua hiện tại
limit: Số lượng được giới hạn
mealPeriods: Danh sách MealPeriod

mealPeriod

Input

id: String!
Process
Gọi service getMealPeriod
Output
MealPeriod nếu tìm được, null nếu không tìm được

nguyenthienthanh commented 5 years ago

Buổi ăn

Model

name: Meal
fields:
- type: string, một trong các giá trị breakfast, lunch, dinner
- dishIds: string[], danh sách id món ăn có trong buổi
- date: Date, thời gian của buổi ăn.
- mealPeriodId: ID, mã của MealPeriod
  Services
  
  createMeal
  
  Input
type: (required)
dishIds: (required)
date: (required)
mealPeriodId: (required)
Validation
Nếu type không được nhập thì thông báo lỗi Buổi ăn không được để trống
Nếu type không phải là một trong breakfast, lunch, dinner thì thông báo lỗi Buổi ăn phải là "buổi sáng", "buổi trưa", hoặc "buổi tối"
Nếu mealPeriodId không được nhập thì thông báo lỗi Mã đợt ăn không được để trống
Nếu không tìm thấy MealPeriod ứng với mealPeriodId thì thông báo lỗi Đợt ăn không tồn tại
Nếu dishIds không được nhập thì thông báo lỗi Danh sách món ăn không được để trống
Nếu có một hoặc nhiều dishId trong dishIds thì thông báo lỗi Các món ăn {danh sách dishId không tìm thấy} không tồn tại
Nếu date không được nhập thì thông báo lỗi Ngày ăn không được để trống
Process
Kiểm tra dữ liệu đầu vào
Kiểm tra từng món ăn trong danh sách dishIds
Tạo buổi ăn với dữ liệu hợp lệ
Output
Buổi ăn cùng danh sách món ăn hợp lệ
createMeals

Input

Một danh sách với mỗi phần tử có dạng
type: (required)
dishIds: (required)
date: (required)
mealPeriodId: (required)
Validation
Kiểm tra mỗi phần tử trong danh sách tương tự như createMeal
Process
Với mỗi phần tử hợp lệ, gọi hàm createMeal để tạo một Meal.
Nếu không thể tạo Meal, thông tin dữ liệu đầu vào sẽ được lưu vào danh sách notCreatedMeals
Với mỗi Meal được tạo thành công sẽ được lưu vào danh sách createdMeals
Output
createdMeals: Danh sách các Meal đã được tạo thành công
notCreatedMeals: Danh sách các Meal chưa được tạo

getMeals

Input

mealPeriodId: (required) string, mã MealPeriod
orderBy: (optional) reverse_date, date
offset: (optional) number, mặc định là 0
limit: (optional) number, mặc định là 10
Validation
Nếu orderBy không hợp lệ thì thông báo lỗi Sắp xếp phải là một trong reverse_date, date
Nếu offset không phải là số nguyên dương thì thông báo lỗi Số lượng bỏ qua phải là một số nguyên dương
Nếu limit không phải là số nguyên dương thì thông báo lỗi Số lượng giới hạn phải là một số nguyên dương
Process
Tìm danh sách Meal theo mealPeriodId và orderBy, skip, limit
Trong đó skip = offset, và limit = limit
Đồng thời đếm tất cả các Meal theo mealPeriodId
Output
total: Tổng số lượng Meal
offset: Số offset hiện tại
limit: Giới hạn hiện tại
meals: Danh sách các Meal tìm được

Mutations

createMeal

Authenticate

Nếu người dùng chưa đăng nhập thì thông báo lỗi unauthorized
Nếu người dùng có roles chứa deactivated thì thông báo lỗi unauthorized
Nếu người dùng không có roles là admin thì thông báo lỗi permission_denied
Input
type: (required) String
dishIds: (required): [String]
date: (required): DateTime
mealPeriodId: (required) String
Process
Gọi service createMeal
Output
Meal đã được tạo thành công

createMeals

Authenticate

Nếu người dùng chưa đăng nhập thì thông báo lỗi unauthorized
Nếu người dùng có roles chứa deactivated thì thông báo lỗi unauthorized
Nếu người dùng không có roles là admin thì thông báo lỗi permission_denied
Input
file: (required) Upload, file excel đang được upload
Process
Kiểm tra định dạng file đang được tải lên
Nếu đúng định dạng excel file thì lưu vào thư mục public
Đọc dữ liệu trong excel theo sheet đầu tiên và parse về object
Thông báo lỗi nếu không thể đọc hoặc không thể parse về object
Gọi service createMeals với dữ liệu đọc được trong excel
Output
createdMeals: Danh sách các Meal đã được tạo thành công
notCreatedMeals: Danh sách các Meal chưa được tạo

Queries

meals

####### Input

mealPeriodId: (required) string, mã MealPeriod
orderBy: (optional) reverse_date, date
offset: (optional) number, mặc định là 0
limit: (optional) number, mặc định là 10 ####### Process
Gọi service getMeals với input hợp lệ ####### Output
total: Tổng số lượng Meal
offset: Số offset hiện tại
limit: Giới hạn hiện tại
meals: Danh sách các Meal tìm được

nguyenthienthanh commented 5 years ago

Học sinh đăng ký ăn

Model

name: UserMealBooking
fields:
- mealId: (ID) mã của buổi ăn
- mealPeriodId: (ID) mã của đợt đăng ký
- dishIds: (IDs) danh sách các món ăn mà học sinh đã đăng ký
  Services
  
  createUserMealBooking
  
  Input
mealId: (required) string, mã của buổi ăn
mealPeriodId: (required) string, mã đợt đăng ký
dishIds: (required) string[], Danh sách các món ăn trong buổi
Validation
Nếu mealId không được nhập thì thông báo lỗi Mã buổi ăn không được để trống
Nếu mealId không được tìm thấy thì thông báo lỗi Không tìm thấy buổi ăn {mealId}
Nếu dishIds không được nhập thì thông báo lỗi Danh sách món ăn không được để trống
Nếu có một hoặc nhiều dishId trong dishIds thì thông báo lỗi Các món ăn {danh sách dishId không tìm thấy} không tồn tại
Process
Kiểm tra dữ liệu đầu vào
Kiểm tra danh sách món ăn
Tạo một userMealBooking với dữ liệu hợp lệ
Output
Thông tin userMealBooking hợp lệ đã tạo được

Mutations

createUserMealBookings

Input

Danh sách với mỗi phần tử có dạng

mealId: String!
mealPeriodId: String!
dishIds: [String!]!
Process
Với mỗi phần tử trong danh sách gọi service createUserMealBooking với input hợp lệ
Nếu tạo thành công, UserMealBooking sẽ được thêm vào createdUserMealBookings, ngược lại thêm vào notCreatedUserMealBookings
Output
createdUserMealBookings: Danh sách UserMealBooking vừa tạo
notCreatedUserMealBookings: Danh sách userMealBooking chưa tạo được

duongdev / ctg-canteen

As an admin, I want to create a new meal registration #91

Purpose

Implementation

Đợt đăng ký

Model:

Services

createMealPeriod

Input

Validation

Process

Output

getMealPeriods

Input

Validation

Process: xử lý này được viết cho dự án sử dụng mongoose

Output

getMealPeriod

Input

Process

Output

Mutations

createMealPeriod

Authenticate

Input

Validation

Process

Output

Queries

mealPeriods

Input

Process

Output

mealPeriod

Input

Process

Output

Buổi ăn

Model

Services

createMeal

Input

Validation

Process

Output

createMeals

Input

Validation

Process

Output

getMeals

Input

Validation

Process

Output

Mutations

createMeal

Authenticate

Input

Process

Output

createMeals

Authenticate

Input

Process

Output

Queries

meals

Học sinh đăng ký ăn

Model

Services

createUserMealBooking

Input

Validation

Process

Output

Mutations

createUserMealBookings

Input

Process

Process: xử lý này được viết cho dự án sử dụng `mongoose`