mirror of
https://github.com/HabitRPG/habitica.git
synced 2025-12-16 14:17:22 +01:00
Add API Call to bulk score tasks (#11389)
* Add new API call to complete multiple task scorings in one call * Improve API response * Improve saving process * Improve handling for multiple tasks scored at once * Handle challenge task errors better * Improve check for alias * Improve check for task scorings * Fix merge errors * make nodemon ignore content_cache * Fix completing group tasks * fix test * fix tests (again) * typo * WIP(a11y): task modal updates * fix(tasks): borders in modal * fix(tasks): circley locks * fix(task-modal): placeholders * WIP(task-modal): disabled states, hide empty options, +/- restyle * fix(task-modal): box shadows instead of borders, habit control pointer * fix(task-modal): button states? * fix(modal): tighten up layout, new spacing utils * fix(tasks): more stylin * fix(tasks): habit hovers * fix(css): checklist labels, a11y colors * fix(css): one more missed hover issue * fix(css): lock Challenges, label fixes * fix(css): scope input/textarea changes * fix(style): task tweakies * fix(style): more button fixage * WIP(component): start select list story * working example of a templated selectList * fix(style): more button corrections * fix(lint): EOL * fix(buttons): factor btn-secondary to better override Bootstrap * fix(styles): standardize more buttons * wip: difficulty select - style fixes * selectDifficulty works! 🎉 - fix styles * change the dropdown-item sizes only for the selectList ones * selectTranslatedArray * changed many label margins * more correct dropdown style * fix(modals): button corrections * input-group styling + datetime picker without today button * Style/margins for "repeat every" - extract selectTag.vue * working tag-selection / update - cleanup * fix stories * fix svg color on create modal (purple) * fix task modal bottom padding * correct dropdown shadow * update dropdown-toggle caret size / color * fixed checklist style * sync checked state * selectTag padding * fix spacing between positive/negative streak inputs * toggle-checkbox + fix some spacings * disable repeat-on when its a groupTask * fix new checklist-item * fix toggle-checkbox style - fix difficulty style * fix checklist ui * add tags label , when there arent any tags selected * WORKING select-tag component 🎉 * fix taglist story * show max 5 items in tag dropdown + "X more" label * fix datetime clear button * replace m-b-xs to mb-1 (bootstrap) - fix input-group-text style * fix styles of advanced settings * fix delete task styles * always show grippy on hover of the item * extract modal-text-input mixin + fix the borders/dropshadow * fix(spacing): revert most to Bootstrap * feat(checklists): make local copy of master checklist non-editable also aggressively update checklists because they weren't syncing?? * fix(checklists): handle add/remove options better * feat(teams): manager notes field * fix select/dropdown styles * input border + icon colors * delete task underline color * fix checklist "delete icon" vertical position * selectTag fixes - normal open/close toggle working again - remove icon color * fixing icons: Trash can - Delete Little X - Remove Big X - Close Block - Block * fix taglist margins / icon sizes * wip margin overview (in storybook) * fix routerlink * remove unused method * new selectTag style + add markdown inside tagList + scrollable tag selection * fix selectTag / selectList active border * fix difficulty select (svg default color) * fix input padding-left + fix reset habit streak fullwidth / padding + "repeat every" gray text (no border) * feat(teams): improved approval request > approve > reward flow * fix(tests): address failures * fix(lint): oops only * fix(tasks): short-circuit group related logic * fix(tasks): more short circuiting * fix(tasks): more lines, less lint * fix(tasks): how do i keep missing these * feat(teams): provide assigning user summary * fix(teams): don't attempt to record assiging user if not supplied * fix advanced-settings styling / margin * fix merge + hide advanced streak settings when none enabled * fix styles * set Roboto font for advanced settings * Add Challenge flag to the tag list * add tag with enter, when no other tag is found * fix styles + tag cancel button * refactor footer / margin * split repeat fields into option mt-3 groups * button all the things * fix(tasks): style updates * no hover state for non-editable tasks on team board * keep assign/claim footer on task after requesting approval * disable more fields on user copy of team task, and remove hover states for them * fix(tasks): functional revisions * "Claim Rewards" instead of "x" in task approved notif * Remove default transition supplied by Bootstrap, apply individually to some elements * Delete individual tasks and related notifications when master task deleted from team board * Manager notes now save when supplied at task initial creation * Can no longer dismiss rewards from approved task by hitting Dismiss All * fix(tasks): clean tasksOrder also adjust related test expectation * fix(tests): adjust integration expectations * fix(test): ratzen fratzen only * fix lint * fix tests * fix(teams): checklist, notes * handleSharedCompletion: handle error, make sure it is run after the user task has been saved * fix typo * correctly handle errors in handleSharedCompletion when approving a task * fix(teams): improve disabled states * handleSharedCompletion: do not increase completions by 1 manually to adjust for last approval not saved yet * revert changes to config.json.example * fix(teams): more style fixage * add unit tests for findMultipleByIdOrAlias * exclude api v4 route from apidocs * BREAKING(teams): return 202 instead of 401 for approval request * fix(teams): better taskboard sync also re-re-fix checklist borders * scoreTasks: validate body * fix tests, move string to api errors * fix(tests): update expectations for breaking change * start updating api docs, process tasks sequentially to avoid conflicts with user._tmp * do not crash entire bulk operation in case of errors * save task only if modified * fix lint * undo changes to error handling: either all tasks scoring are successfull or none * remove stale code * do not return user._tmp when bulk scoring, it would be the last version only * make sure user._tmp.leveledUp is not lost when bulk scoring * rewards tests * mixed tests * fix tests, allow scoring the same task multiple times * finish integration tests * fix api docs for the bulk score route * refactor(task-modal): lockable label component * wip loading spinner * refactor(teams): move task scoring to mixin * fix(teams): style corrections * fix(btn): fix padding to have height of 32px * implement loading spinner * remove console.log warnings * fix(tasks): spacing and wording corrections * fix(teams): don't bork manager notes * fix(teams): assignment fix and more approval flow revisions * WIP(teams): use tag dropdown control for assignment * finish merge - never throw an error when a group task requires approval (wip - needs tests) * fix taskModal merge * fix merge * fix(task modal): add newline * fix(column.vue): add newline at end of file * mvp yesterdaily modal * fix tests * fix api docs for bulk scoring group tasks * separate task scoring and _tmp handling * handle _tmp when bulk scoring * rya: close modal before calling cron API, prevents issues with modals * rya: fix conflicts with other modals * add sounds, support for group plans, analytics * use asyncResource for group plans * fix lint * streak bonus: add comment about missing in rya * move yesterdailyModal * fix issues with level up modals and rya * add comments for future use, fix level up modals not showing up at levels with a quest drop * handle errors in rya modal * bundle quest and crit notifications Co-authored-by: Phillip Thelen <phillip@habitica.com> Co-authored-by: Phillip Thelen <viirus@pherth.net> Co-authored-by: Sabe Jones <sabrecat@gmail.com> Co-authored-by: negue <eugen.bolz@gmail.com>
This commit is contained in:
Matteo Pagliazzi
GitHub
@@ -1,13 +1,25 @@
|
||||
import moment from 'moment';
|
||||
import _ from 'lodash';
|
||||
import validator from 'validator';
|
||||
import * as Tasks from '../models/task';
|
||||
import apiError from './apiError';
|
||||
import {
|
||||
BadRequest,
|
||||
NotAuthorized,
|
||||
NotFound,
|
||||
} from './errors';
|
||||
import {
|
||||
SHARED_COMPLETION,
|
||||
handleSharedCompletion,
|
||||
} from './groupTasks';
|
||||
import shared from '../../common';
|
||||
import { model as Group } from '../models/group'; // eslint-disable-line import/no-cycle
|
||||
import { model as User } from '../models/user'; // eslint-disable-line import/no-cycle
|
||||
import { taskScoredWebhook } from './webhook'; // eslint-disable-line import/no-cycle
|
||||
|
||||
import logger from './logger';
|
||||
|
||||
const requiredGroupFields = '_id leader tasksOrder name';
|
||||
|
||||
async function _validateTaskAlias (tasks, res) {
|
||||
const tasksWithAliases = tasks.filter(task => task.alias);
|
||||
@@ -291,3 +303,280 @@ export function moveTask (order, taskId, to) {
|
||||
order.splice(to, 0, taskId);
|
||||
}
|
||||
}
|
||||
|
||||
async function handleChallengeTask (task, delta, direction) {
|
||||
if (task.challenge && task.challenge.id && task.challenge.taskId && !task.challenge.broken && task.type !== 'reward') {
|
||||
// Wrapping everything in a try/catch block because if an error occurs
|
||||
// using `await` it MUST NOT bubble up because the request has already been handled
|
||||
try {
|
||||
const chalTask = await Tasks.Task.findOne({
|
||||
_id: task.challenge.taskId,
|
||||
}).exec();
|
||||
|
||||
if (!chalTask) return;
|
||||
|
||||
await chalTask.scoreChallengeTask(delta, direction);
|
||||
} catch (e) {
|
||||
logger.error(e, 'Error scoring challenge task');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async function handleGroupTask (task, delta, direction) {
|
||||
if (task.group && task.group.taskId) {
|
||||
// Wrapping everything in a try/catch block because if an error occurs
|
||||
// using `await` it MUST NOT bubble up because the request has already been handled
|
||||
try {
|
||||
const groupTask = await Tasks.Task.findOne({
|
||||
_id: task.group.taskId,
|
||||
}).exec();
|
||||
|
||||
if (groupTask) {
|
||||
await handleSharedCompletion(groupTask, task);
|
||||
|
||||
const groupDelta = groupTask.group.assignedUsers
|
||||
? delta / groupTask.group.assignedUsers.length
|
||||
: delta;
|
||||
await groupTask.scoreChallengeTask(groupDelta, direction);
|
||||
}
|
||||
} catch (e) {
|
||||
logger.error(e, 'Error scoring group task');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Scores a task.
|
||||
* @param user the user that is making the operation
|
||||
* @param task The task to score
|
||||
* @param direction "up" or "down" depending on how the task should be scored
|
||||
*
|
||||
* @return Response Data
|
||||
*/
|
||||
async function scoreTask (user, task, direction, req, res) {
|
||||
if (task.type === 'daily' || task.type === 'todo') {
|
||||
if (task.completed && direction === 'up') {
|
||||
throw new NotAuthorized(res.t('sessionOutdated'));
|
||||
} else if (!task.completed && direction === 'down') {
|
||||
throw new NotAuthorized(res.t('sessionOutdated'));
|
||||
}
|
||||
}
|
||||
|
||||
if (task.group.approval.required && !task.group.approval.approved) {
|
||||
const fields = requiredGroupFields.concat(' managers');
|
||||
const group = await Group.getGroup({ user, groupId: task.group.id, fields });
|
||||
|
||||
const managerIds = Object.keys(group.managers);
|
||||
managerIds.push(group.leader);
|
||||
|
||||
if (managerIds.indexOf(user._id) !== -1) {
|
||||
task.group.approval.approved = true;
|
||||
task.group.approval.requested = true;
|
||||
task.group.approval.requestedDate = new Date();
|
||||
} else {
|
||||
if (task.group.approval.requested) {
|
||||
return {
|
||||
task,
|
||||
requiresApproval: true,
|
||||
message: res.t('taskRequiresApproval'),
|
||||
};
|
||||
}
|
||||
|
||||
task.group.approval.requested = true;
|
||||
task.group.approval.requestedDate = new Date();
|
||||
|
||||
const managers = await User.find({ _id: managerIds }, 'notifications preferences').exec(); // Use this method so we can get access to notifications
|
||||
|
||||
// @TODO: we can use the User.pushNotification function because
|
||||
// we need to ensure notifications are translated
|
||||
const managerPromises = [];
|
||||
managers.forEach(manager => {
|
||||
manager.addNotification('GROUP_TASK_APPROVAL', {
|
||||
message: res.t('userHasRequestedTaskApproval', {
|
||||
user: user.profile.name,
|
||||
taskName: task.text,
|
||||
}, manager.preferences.language),
|
||||
groupId: group._id,
|
||||
// user task id, used to match the notification when the task is approved
|
||||
taskId: task._id,
|
||||
userId: user._id,
|
||||
groupTaskId: task.group.taskId, // the original task id
|
||||
direction,
|
||||
});
|
||||
managerPromises.push(manager.save());
|
||||
});
|
||||
|
||||
managerPromises.push(task.save());
|
||||
await Promise.all(managerPromises);
|
||||
|
||||
return {
|
||||
task,
|
||||
requiresApproval: true,
|
||||
message: res.t('taskApprovalHasBeenRequested'),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
if (task.group.approval.required && task.group.approval.approved) {
|
||||
const notificationIndex = user.notifications.findIndex(notification => notification
|
||||
&& notification.data && notification.data.task
|
||||
&& notification.data.task._id === task._id && notification.type === 'GROUP_TASK_APPROVED');
|
||||
|
||||
if (notificationIndex !== -1) {
|
||||
user.notifications.splice(notificationIndex, 1);
|
||||
}
|
||||
}
|
||||
|
||||
const wasCompleted = task.completed;
|
||||
|
||||
const firstTask = !user.achievements.completedTask;
|
||||
const [delta] = shared.ops.scoreTask({ task, user, direction }, req, res.analytics);
|
||||
// Drop system (don't run on the client,
|
||||
// as it would only be discarded since ops are sent to the API, not the results)
|
||||
if (direction === 'up' && !firstTask) shared.fns.randomDrop(user, { task, delta }, req, res.analytics);
|
||||
|
||||
// If a todo was completed or uncompleted move it in or out of the user.tasksOrder.todos list
|
||||
// TODO move to common code?
|
||||
let pullTask = false;
|
||||
let pushTask = false;
|
||||
if (task.type === 'todo') {
|
||||
if (!wasCompleted && task.completed) {
|
||||
// @TODO: mongoose's push and pull should be atomic and help with
|
||||
// our concurrency issues. If not, we need to use this update $pull and $push
|
||||
pullTask = true;
|
||||
// user.tasksOrder.todos.pull(task._id);
|
||||
} else if (
|
||||
wasCompleted
|
||||
&& !task.completed
|
||||
&& user.tasksOrder.todos.indexOf(task._id) === -1
|
||||
) {
|
||||
pushTask = true;
|
||||
// user.tasksOrder.todos.push(task._id);
|
||||
}
|
||||
}
|
||||
|
||||
setNextDue(task, user);
|
||||
|
||||
taskScoredWebhook.send(user, {
|
||||
task,
|
||||
direction,
|
||||
delta,
|
||||
user,
|
||||
});
|
||||
|
||||
// Track when new users (first 7 days) score tasks
|
||||
if (moment().diff(user.auth.timestamps.created, 'days') < 7) {
|
||||
res.analytics.track('task score', {
|
||||
uuid: user._id,
|
||||
hitType: 'event',
|
||||
category: 'behavior',
|
||||
taskType: task.type,
|
||||
direction,
|
||||
headers: req.headers,
|
||||
});
|
||||
}
|
||||
|
||||
return {
|
||||
task,
|
||||
delta,
|
||||
direction,
|
||||
pullTask,
|
||||
pushTask,
|
||||
// clone user._tmp so that it's not overwritten by other score operations
|
||||
// when using the bulk scoring API
|
||||
_tmp: _.cloneDeep(user._tmp),
|
||||
};
|
||||
}
|
||||
|
||||
export async function scoreTasks (user, taskScorings, req, res) {
|
||||
// Validate the parameters
|
||||
|
||||
// taskScorings must be array with at least one value
|
||||
if (!taskScorings || !Array.isArray(taskScorings) || taskScorings.length < 1) {
|
||||
throw new BadRequest(apiError('invalidTaskScorings'));
|
||||
}
|
||||
|
||||
taskScorings.forEach(({ id, direction }) => {
|
||||
if (!['up', 'down'].includes(direction)) throw new BadRequest(apiError('directionUpDown'));
|
||||
if (typeof id !== 'string') throw new BadRequest(apiError('invalidTaskIdentifier'));
|
||||
});
|
||||
|
||||
// Get an array of tasks identifiers
|
||||
const taskIds = taskScorings.map(taskScoring => taskScoring.id);
|
||||
|
||||
const tasks = {};
|
||||
(await Tasks.Task.findMultipleByIdOrAlias(taskIds, user._id)).forEach(task => {
|
||||
tasks[task._id] = task;
|
||||
if (task.alias) {
|
||||
tasks[task.alias] = task;
|
||||
}
|
||||
});
|
||||
|
||||
if (Object.keys(tasks).length === 0) throw new NotFound(res.t('taskNotFound'));
|
||||
|
||||
// Score each task separately to make sure changes to user._tmp don't overlap.
|
||||
// scoreTask is an async function but the only async operation happens when a group task
|
||||
// is involved
|
||||
// @TODO refactor user._tmp to allow more than one task scoring - breaking change
|
||||
const returnDatas = [];
|
||||
|
||||
for (const taskScoring of taskScorings) {
|
||||
const task = tasks[taskScoring.id];
|
||||
if (task) {
|
||||
// If one of the task scoring fails the entire operation will result in a failure
|
||||
// It's the only way to ensure the user doesn't end up in an inconsistent state.
|
||||
returnDatas.push(await scoreTask( // eslint-disable-line no-await-in-loop
|
||||
user,
|
||||
task,
|
||||
taskScoring.direction,
|
||||
req,
|
||||
res,
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
const savePromises = [user.save()];
|
||||
|
||||
// Save the tasks, use the tasks object and not returnDatas.*.task to avoid saving the same
|
||||
// task twice, allows scoring the same task multiple times in a single request
|
||||
Object.keys(tasks).forEach(identifier => {
|
||||
// Tasks identified by an alias exists with two keys (id and alias) in the tasks object
|
||||
// ignore the alias to avoid saving them twice
|
||||
if (validator.isUUID(String(identifier)) && tasks[identifier].isModified()) {
|
||||
savePromises.push(tasks[identifier].save());
|
||||
}
|
||||
});
|
||||
|
||||
// Handle todos removal or addition to the tasksOrder array
|
||||
const pullIDs = [];
|
||||
const pushIDs = [];
|
||||
|
||||
returnDatas.forEach(returnData => {
|
||||
if (returnData.pushTask === true) pushIDs.push(returnData.task._id);
|
||||
if (returnData.pullTask === true) pullIDs.push(returnData.task._id);
|
||||
});
|
||||
|
||||
const moveUpdateObject = {};
|
||||
if (pushIDs.length > 0) moveUpdateObject.$push = { 'tasksOrder.todos': { $each: pushIDs } };
|
||||
if (pullIDs.length > 0) moveUpdateObject.$pull = { 'tasksOrder.todos': { $in: pullIDs } };
|
||||
if (pushIDs.length > 0 || pullIDs.length > 0) {
|
||||
savePromises.push(user.updateOne(moveUpdateObject).exec());
|
||||
}
|
||||
|
||||
await Promise.all(savePromises);
|
||||
|
||||
return returnDatas.map(data => {
|
||||
// Handle challenge and group tasks tasks here because the task must have been saved first
|
||||
handleChallengeTask(data.task, data.delta, data.direction);
|
||||
handleGroupTask(data.task, data.delta, data.direction);
|
||||
|
||||
// Handle group tasks that require approval
|
||||
if (data.requiresApproval === true) {
|
||||
return {
|
||||
id: data.task._id, message: data.message, requiresApproval: true,
|
||||
};
|
||||
}
|
||||
|
||||
return { id: data.task._id, delta: data.delta, _tmp: data._tmp };
|
||||
});
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user