Dla kogoś, kto ma problem populate
i też chce to zrobić:
- czatuj z prostym tekstem i szybkimi odpowiedziami (dymki)
- 4 zbiory baz danych do czatu:
clients
, users
, rooms
, messasges
.
- ta sama struktura bazy danych wiadomości dla 3 typów nadawców: bot, użytkownicy i klienci
refPath
lub dynamiczne odniesienie
populate
z path
model
opcjami i
- posługiwać się
findOneAndReplace
/ replaceOne
z$exists
- utwórz nowy dokument, jeśli pobrany dokument nie istnieje
KONTEKST
Cel
- Zapisz nową prostą wiadomość tekstową w bazie danych i wypełnij ją danymi użytkownika lub klienta (2 różne modele).
- Zapisz nową wiadomość quickReplies w bazie danych i wypełnij ją danymi użytkownika lub klienta.
- Każda wiadomość zapisać swój typ nadawcy:
clients
, users
&bot
.
- Wypełniaj tylko wiadomości, które mają nadawcę
clients
lub users
jego modele Mongoose. Modele klienta typu _sender to clients
, dla użytkownika to users
.
Schemat wiadomości :
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);
ROZWIĄZANIE
Moje żądanie API po stronie serwera
Mój kod
Funkcja narzędzia (w chatUtils.js
pliku), aby uzyskać typ wiadomości, którą chcesz zapisać:
/**
* 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
};
Po mojej stronie serwera (używając Nodejs), aby otrzymać prośbę o zapisanie wiadomości:
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);
}
});
WSKAZÓWKI :
W przypadku bazy danych:
- Każda wiadomość jest samym dokumentem.
- Zamiast używać
refPath
, używamy narzędzia, getSenderModel
które jest używane w populate()
. To z powodu bota. sender.type
Może być: users
z jego bazy danych, clients
z jego bazy danych i bot
bez bazy danych. PlikrefPath
Potrzebuje prawdziwego modelu odniesienia, jeśli nie, Mongooose rzucać błąd.
sender._id
można wpisać ObjectId
dla użytkowników i klientów lub null
dla bota.
Logika żądań API:
- Zastępujemy
quickReply
wiadomość (baza danych wiadomości musi mieć tylko jedną szybką odpowiedź, ale tyle prostych wiadomości tekstowych, ile chcesz). Używamy findOneAndUpdate
zamiast replaceOne
lub findOneAndReplace
.
- Wykonujemy operację zapytania (the
findOneAndUpdate
) i populate
operację z callback
każdym z nich. Jest to ważne, jeśli nie wiem, czy stosowanie async/await
, then()
, exec()
lub callback(err, document)
. Aby uzyskać więcej informacji, zajrzyj do Populate Doc .
- Szybką odpowiedź zastępujemy
overwrite
opcją i bez$set
operatora zapytania.
- Jeśli nie znajdziemy szybkiej odpowiedzi, tworzymy nową. Musisz o tym powiedzieć Mongoose
upsert
opcją.
- Wypełniamy tylko raz, dla zastąpionej wiadomości lub nowej zapisanej wiadomości.
- Wracamy do wywołań zwrotnych, niezależnie od wiadomości, którą zapisaliśmy z
findOneAndUpdate
i dla populate()
.
- W programie
populate
tworzymy niestandardowe dynamiczne odniesienie do modelu z rozszerzeniem getSenderModel
. Możemy użyć dynamicznego odniesienia Mongoose, ponieważ sender.type
for bot
nie ma żadnego modelu Mongoose. Używamy wypełniania w całej bazie danych z opcjami model
i path
opcjami.
Spędziłem wiele godzin na rozwiązywaniu drobnych problemów tu i tam i mam nadzieję, że to komuś pomoże! 😃