Para alguém que tem problemas populate
e também deseja fazer isso:
- converse com texto simples e respostas rápidas (bolhas)
- 4 coleções de banco de dados para bate-papo:
clients
, users
, rooms
, messasges
.
- mesma estrutura de banco de dados de mensagem para 3 tipos de remetentes: bot, usuários e clientes
refPath
ou referência dinâmica
populate
com path
e model
opções
- usar
findOneAndReplace
/ replaceOne
com$exists
- crie um novo documento se o documento buscado não existir
CONTEXTO
Objetivo
- Salve uma nova mensagem de texto simples no banco de dados e preencha-a com os dados do usuário ou cliente (2 modelos diferentes).
- Salve uma nova mensagem quickReplies no banco de dados e preencha-a com os dados do usuário ou cliente.
- Salve cada mensagem de seu tipo remetente:
clients
, users
&bot
.
- Preencha apenas as mensagens que têm o remetente
clients
ou users
com seus Modelos Mongoose. _sender type client models is clients
, for user is users
.
Esquema de mensagem :
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);
SOLUÇÃO
Minha solicitação de API do lado do servidor
Meu código
Função utilitária (no chatUtils.js
arquivo) para obter o tipo de mensagem que deseja salvar:
/**
* 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
};
Meu lado do servidor (usando Nodejs) para obter a solicitação de salvar a mensagem:
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);
}
});
DICAS :
Para o banco de dados:
- Cada mensagem é um documento em si.
- Em vez de usar
refPath
, usamos o utilitário getSenderModel
que é usado no populate()
. Isso é por causa do bot. O sender.type
pode ser: users
com seu banco de dados, clients
com seu banco de dados e bot
sem banco de dados. O refPath
precisa de uma verdadeira referência de modelo, se não, Mongooose lança um erro.
sender._id
pode ser um tipo ObjectId
para usuários e clientes ou null
para o bot.
Para lógica de solicitação de API:
- Substituímos a
quickReply
mensagem (Message DB deve ter apenas um quickReply, mas quantas mensagens de texto simples você quiser). Usamos o em findOneAndUpdate
vez de replaceOne
ou findOneAndReplace
.
- Executamos a operação de consulta (o
findOneAndUpdate
) e a populate
operação com o callback
de cada um. Isto é importante se você não sabe se o uso async/await
, then()
, exec()
ou callback(err, document)
. Para obter mais informações, consulte o Populate Doc .
- Substituímos a mensagem de resposta rápida pela
overwrite
opção e sem $set
operador de consulta.
- Se não encontrarmos uma resposta rápida, criamos uma nova. Você tem que dizer ao Mongoose isso com
upsert
opção.
- Preenchemos apenas uma vez, para a mensagem substituída ou a nova mensagem salva.
- Voltamos aos callbacks, seja qual for a mensagem que salvamos com
findOneAndUpdate
e para o populate()
.
- Em
populate
, criamos uma referência de modelo dinâmico personalizado com o getSenderModel
. Podemos usar a referência dinâmica Mongoose porque o sender.type
for bot
não tem nenhum modelo Mongoose. Usamos um Populating Across Database com model
e path
optins.
Passei muitas horas resolvendo pequenos problemas aqui e ali e espero que isso ajude alguém! 😃