mirror of
https://github.com/HabitRPG/habitica.git
synced 2025-12-19 15:48:04 +01:00
6cc359a935
* Adding new method to user schema that pushes a new notification to the database with an update operation instead of a save. fixes #8264 * fixing test text * changing the addUserNotificationUpdate method to a static method as requested. * Renaming to push notification * fixing comment documentation based on pr comments. * Changed the update statement to do a multi update and added a validation step. Added tests for both these cases. * Updating pushNotification method to allow a query to be passed instead of an array of userIds to make it more flexible. * Removing createdAt field from tests as it's no longer used. * Removing only from test suite
94 lines
3.7 KiB
JavaScript
94 lines
3.7 KiB
JavaScript
import common from '../../../common';
|
|
import Bluebird from 'bluebird';
|
|
import {
|
|
chatDefaults,
|
|
TAVERN_ID,
|
|
} from '../group';
|
|
import { defaults } from 'lodash';
|
|
import { model as UserNotification } from '../userNotification';
|
|
import schema from './schema';
|
|
|
|
schema.methods.isSubscribed = function isSubscribed () {
|
|
return !!this.purchased.plan.customerId; // eslint-disable-line no-implicit-coercion
|
|
};
|
|
|
|
// Get an array of groups ids the user is member of
|
|
schema.methods.getGroups = function getUserGroups () {
|
|
let userGroups = this.guilds.slice(0); // clone user.guilds so we don't modify the original
|
|
if (this.party._id) userGroups.push(this.party._id);
|
|
userGroups.push(TAVERN_ID);
|
|
return userGroups;
|
|
};
|
|
|
|
|
|
/**
|
|
* Sends a message to a user. Archives a copy in sender's inbox.
|
|
*
|
|
* @param userToReceiveMessage The receiver
|
|
* @param options
|
|
* @param options.receiverMsg The message to send to the receiver
|
|
* @param options.senderMsg The message to archive instead of receiverMsg
|
|
* @return N/A
|
|
*/
|
|
schema.methods.sendMessage = async function sendMessage (userToReceiveMessage, options) {
|
|
let sender = this;
|
|
let senderMsg = options.senderMsg || options.receiverMsg;
|
|
|
|
common.refPush(userToReceiveMessage.inbox.messages, chatDefaults(options.receiverMsg, sender));
|
|
userToReceiveMessage.inbox.newMessages++;
|
|
userToReceiveMessage._v++;
|
|
userToReceiveMessage.markModified('inbox.messages');
|
|
|
|
common.refPush(sender.inbox.messages, defaults({sent: true}, chatDefaults(senderMsg, userToReceiveMessage)));
|
|
sender.markModified('inbox.messages');
|
|
|
|
let promises = [userToReceiveMessage.save(), sender.save()];
|
|
await Bluebird.all(promises);
|
|
};
|
|
|
|
/**
|
|
* Creates a notification based on the input parameters and adds it to the local user notifications array.
|
|
* This does not save the notification to the database or interact with the database in any way.
|
|
*
|
|
* @param type The type of notification to add to the user. Possible values are defined in the UserNotificaiton Schema
|
|
* @param data The data to add to the notification
|
|
*/
|
|
schema.methods.addNotification = function addUserNotification (type, data = {}) {
|
|
this.notifications.push({
|
|
type,
|
|
data,
|
|
});
|
|
};
|
|
|
|
/**
|
|
* Creates a notification based on the type and data input parameters and saves that new notification
|
|
* to the database directly using an update statement. The local copy of these users are not updated by
|
|
* this operation. Use this function when you want to add a notification to a user(s), but do not have
|
|
* the user document(s) opened.
|
|
*
|
|
* @param query A Mongoose query defining the users to add the notification to.
|
|
* @param type The type of notification to add to the user. Possible values are defined in the UserNotificaiton Schema
|
|
* @param data The data to add to the notification
|
|
*/
|
|
schema.statics.pushNotification = async function pushNotification (query, type, data = {}) {
|
|
let newNotification = new UserNotification({type, data});
|
|
let validationResult = newNotification.validateSync();
|
|
if (validationResult) {
|
|
throw validationResult;
|
|
}
|
|
await this.update(query, {$push: {notifications: newNotification}}, {multi: true}).exec();
|
|
};
|
|
|
|
// Add stats.toNextLevel, stats.maxMP and stats.maxHealth
|
|
// to a JSONified User stats object
|
|
schema.methods.addComputedStatsToJSONObj = function addComputedStatsToUserJSONObj (statsObject) {
|
|
// NOTE: if an item is manually added to user.stats then
|
|
// common/fns/predictableRandom must be tweaked so the new item is not considered.
|
|
// Otherwise the client will have it while the server won't and the results will be different.
|
|
statsObject.toNextLevel = common.tnl(this.stats.lvl);
|
|
statsObject.maxHealth = common.maxHealth;
|
|
statsObject.maxMP = common.statsComputed(this).maxMP;
|
|
|
|
return statsObject;
|
|
};
|