Для тех, у кого есть проблема, populateи они тоже хотят это сделать:
- чат с простым текстом и быстрыми ответами (пузыри)
- 4 коллекции базы данных для чата:
clients, users, rooms, messasges.
- одинаковая структура БД сообщений для 3 типов отправителей: бот, пользователи и клиенты
refPathили динамическая ссылкаpopulateс pathиmodel варианты- использовать
findOneAndReplace/ replaceOneс$exists
- создать новый документ, если полученный документ не существует
КОНТЕКСТ
Цель
- Сохраните новое простое текстовое сообщение в базе данных и заполните его данными пользователя или клиента (2 разные модели).
- Сохраните новое сообщение quickReplies в базе данных и заполните его данными пользователя или клиента.
- Сохранить каждое сообщение его тип отправителя:
clients, users&bot .
- Заполняйте только сообщения, у которых есть отправитель
clientsили usersего модели Mongoose. Клиентские модели типа _sender есть clients, для пользователя есть users.
Схема сообщения :
const messageSchema = new Schema({
room: {
type: Schema.Types.ObjectId,
ref: 'rooms',
required: [true, `Room's id`]
},
sender: {
_id: { type: Schema.Types.Mixed },
type: {
type: String,
enum: ['clients', 'users', 'bot'],
required: [true, 'Only 3 options: clients, users or bot.']
}
},
timetoken: {
type: String,
required: [true, 'It has to be a Nanosecond-precision UTC string']
},
data: {
lang: String,
// Format samples on https://docs.chatfuel.com/api/json-api/json-api
type: {
text: String,
quickReplies: [
{
text: String,
// Blocks' ids.
goToBlocks: [String]
}
]
}
}
mongoose.model('messages', messageSchema);
РЕШЕНИЕ
Мой запрос API на стороне сервера
Мой код
Служебная функция (в chatUtils.jsфайле) для получения сообщения типа, которое вы хотите сохранить:
/**
* We filter what type of message is.
*
* @param {Object} message
* @returns {string} The type of message.
*/
const getMessageType = message => {
const { type } = message.data;
const text = 'text',
quickReplies = 'quickReplies';
if (type.hasOwnProperty(text)) return text;
else if (type.hasOwnProperty(quickReplies)) return quickReplies;
};
/**
* Get the Mongoose's Model of the message's sender. We use
* the sender type to find the Model.
*
* @param {Object} message - The message contains the sender type.
*/
const getSenderModel = message => {
switch (message.sender.type) {
case 'clients':
return 'clients';
case 'users':
return 'users';
default:
return null;
}
};
module.exports = {
getMessageType,
getSenderModel
};
Моя серверная часть (с использованием Nodejs), чтобы получить запрос на сохранение сообщения:
app.post('/api/rooms/:roomId/messages/new', async (req, res) => {
const { roomId } = req.params;
const { sender, timetoken, data } = req.body;
const { uuid, state } = sender;
const { type } = state;
const { lang } = data;
// For more info about message structure, look up Message Schema.
let message = {
room: new ObjectId(roomId),
sender: {
_id: type === 'bot' ? null : new ObjectId(uuid),
type
},
timetoken,
data: {
lang,
type: {}
}
};
// ==========================================
// CONVERT THE MESSAGE
// ==========================================
// Convert the request to be able to save on the database.
switch (getMessageType(req.body)) {
case 'text':
message.data.type.text = data.type.text;
break;
case 'quickReplies':
// Save every quick reply from quickReplies[].
message.data.type.quickReplies = _.map(
data.type.quickReplies,
quickReply => {
const { text, goToBlocks } = quickReply;
return {
text,
goToBlocks
};
}
);
break;
default:
break;
}
// ==========================================
// SAVE THE MESSAGE
// ==========================================
/**
* We save the message on 2 ways:
* - we replace the message type `quickReplies` (if it already exists on database) with the new one.
* - else, we save the new message.
*/
try {
const options = {
// If the quickRepy message is found, we replace the whole document.
overwrite: true,
// If the quickRepy message isn't found, we create it.
upsert: true,
// Update validators validate the update operation against the model's schema.
runValidators: true,
// Return the document already updated.
new: true
};
Message.findOneAndUpdate(
{ room: roomId, 'data.type.quickReplies': { $exists: true } },
message,
options,
async (err, newMessage) => {
if (err) {
throw Error(err);
}
// Populate the new message already saved on the database.
Message.populate(
newMessage,
{
path: 'sender._id',
model: getSenderModel(newMessage)
},
(err, populatedMessage) => {
if (err) {
throw Error(err);
}
res.send(populatedMessage);
}
);
}
);
} catch (err) {
logger.error(
`#API Error on saving a new message on the database of roomId=${roomId}. ${err}`,
{ message: req.body }
);
// Bad Request
res.status(400).send(false);
}
});
СОВЕТЫ :
Для базы данных:
- Каждое сообщение - это сам документ.
- Вместо использования
refPathмы используем утилиту, getSenderModelкоторая используется в populate(). Это из-за бота. sender.typeМожет быть: usersс его базой данных, clientsс его базой данных и botбез базы данных. refPathНуждается в истинной эталонной модели, если нет, то Mongooose выдаст ошибку.
sender._idможет быть типа ObjectIdдля пользователей и клиентов или nullдля бота.
Для логики запроса API:
- Заменим
quickReplyсообщение (Message DB должен иметь только один quickReply, но , как многие простые текстовые сообщения , как вы хотите). Мы используем findOneAndUpdateвместо replaceOneили findOneAndReplace.
- Мы выполняем операцию запроса (
findOneAndUpdate) и populateоперацию с callbackкаждым из них. Это важно , если вы не знаете , если использовать async/await, then(), exec()или callback(err, document). Для получения дополнительной информации см. « Заполнить документ» .
- Мы заменяем сообщение быстрого ответа
overwriteопцией и без $setоператора запроса.
- Если мы не найдем быстрого ответа, мы создадим новый. Вы должны сообщить об этом Mongoose с помощью
upsertoption.
- Мы заполняем только один раз, для замененного сообщения или нового сохраненного сообщения.
- Мы возвращаемся к обратным вызовам независимо от того, какое сообщение мы сохранили с
findOneAndUpdateи для populate().
- В
populate, мы создаем настраиваемую ссылку на динамическую модель с расширением getSenderModel. Мы можем использовать динамическую ссылку Mongoose, потому что sender.typefor botне имеет модели Mongoose. Мы используем базу данных для заполнения с помощью modelи pathoptins.
Я провел много часов, решая небольшие проблемы здесь и там, и я надеюсь, что это кому-то поможет! 😃