Open
Conversation
WorkaroundIn conversations v2, anything returned from
So, the idea is to persist the entire conversation state as a single string field (
This avoids invalid nested entities and CodeAdapter const { stringify, parse } = require("flatted");
const BIGINT_PREFIX = "bigint:";
const TIMESTAMP_PREFIX = "timestamp:";
function replacer(key, value) {
if (typeof value === "function" || typeof value === "symbol" || value === undefined) {
return undefined;
}
if (typeof value === "bigint") {
return BIGINT_PREFIX + value.toString();
}
if (value instanceof Date) {
return TIMESTAMP_PREFIX + value.getTime();
}
return value;
}
function reviver(key, value) {
if (typeof value === "string" && value.startsWith(BIGINT_PREFIX)) {
try {
return BigInt(value.slice(BIGINT_PREFIX.length));
}
catch { }
}
if (typeof value === "string" && value.startsWith(TIMESTAMP_PREFIX)) {
try {
return new Date(Number(value.slice(TIMESTAMP_PREFIX.length)));
}
catch { }
}
return value;
}
function firestoreAdapter(collection) {
return {
async read(key) {
const snapshot = await collection.doc(key).get();
try {
return parse(snapshot.data()?.state, reviver);
}
catch {
return undefined;
}
},
async write(key, value) {
const state = stringify(value, replacer);
await collection.doc(key).set({ state }, { merge: false });
},
async delete(key) {
await collection.doc(key).delete();
},
};
}
module.exports = {
firestoreAdapter
};Wiring const { Composer, session } = require("grammy");
const { conversations, createConversation } = require("@grammyjs/conversations");
const { hydrate } = require("@grammyjs/hydrate");
const { getFirestore } = require("firebase-admin/firestore");
const admin = require("firebase-admin");
const { firestoreAdapter } = require("../utils/adapter");
const conversation = require("./conversations/conversation");
admin.initializeApp();
const composer = new Composer();
composer.use(session({
initial: () => ({ user: null })
}));
composer.use(hydrate());
composer.use(conversations({
storage: firestoreAdapter(getFirestore().collection("conversations")),
plugins: [hydrate()]
}));
composer.use(createConversation(conversation, "conversation"));ExampleHere’s what the serialized conversation state looks like in Firestore (5.87 KB): Notes
Status / Help wantedI’d really appreciate reviews, test cases, and fixes from anyone interested. Happy to iterate on this and adjust the approach if maintainers prefer a different direction. Also, big thanks to @KnorpelSenf for the initial idea to use |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Suggested in https://t.me/grammyjs/320305