MySQL session middleware for Telegraf

MySQL powered session middleware for Telegraf. forked from Redis session project for telegraf. Saves session both on mysql and in memory and use memory where possible.

Installation

Node.js 12.0.0 or newer is required

MySQL 5.5.62 or newer is required

$ npm install telegraf-session-mysql

Setup

Module can auto create table in database, but if you want to create manually, use this request

CREATE TABLE IF NOT EXISTS sessions (
  user_id BIGINT(20) NOT NULL,
  chat_id BIGINT(20) NOT NULL,
  session LONGTEXT NOT NULL,
  UNIQUE KEY user_id(user_id, chat_id)
) ENGINE = innodb DEFAULT CHARSET = utf8

Example

const Telegraf = require('telegraf')
const MySQLSession = require('telegraf-session-mysql')

const telegraf = new Telegraf(process.env.BOT_TOKEN)

const session = new MySQLSession({
  host: 'localhost',
  user: 'user',
  password: 'pass',
  database: 'telegraf_sessions'
})

telegraf.use(session.middleware())

(async() => {
  await session.connect()

  telegraf.on('text', (ctx, next) => {
    ctx.session.counter = ctx.session.counter || 0
    ctx.session.counter++
    console.log('Session', ctx.session)
  })
  
  telegraf.startPolling()
})()

When you have stored the session key beforehand, you can access a session without having access to a context object. This is useful when you perform OAUTH or something similar, when a REDIRECT_URI is called on your bot server.

const session = new MySQLSession(...)

// Retrieve session state by session key
session.getSession (userID, chatID)
  .then((session) => {
    console.log('Session state', session)
  })

// Save session state
session.saveSession(userID, chatID, session)
  .then((session) => {
    console.log('Session saved')
  })

If you want get session without userID or chatID (userProperty or chatProperty enabled), you must pass 0 (zero) into field

For example:

const session = new MySQLSession(...)

// Retrieve session state by session key
session.getSession (userID, 0)
  .then((session) => {
    console.log('Session state', session)
  })

// Save session state
session.saveSession(userID, 0,  session)
  .then((session) => {
    console.log('Session saved')
  })

API

Options

• connection: Object with creditnails
  • host: hostname of mysql server
  • user: username
  • password: user password
  • database: Database name
• options
  • property: context property name (default: session)
  • userProperty: context property name for user session (default: not used)
  • chatProperty: context property name for chat session (default: not used)
  • table: name of database table (default: session)
  • lifetime: Sessions life time (default: 300 seconds)
  • interval: Garbage collector call interval (deleting sessions with expired lifetime, default: 300000 ms)
  • getSessionKey: session key function (ctx) => any

Method .connect(): Promise

Call .connect() method for create database connection pool and auto try to create table.

Default implementation of getSessionKey:

function getSessionKey(ctx) {
  if (ctx.updateType === 'callback_query') {
    ctx = ctx.update.callback_query.message
  }
  if (!ctx.from || !ctx.chat) {
    return
  }

  return [ctx.from.id, ctx.chat.id]
}

Useing userProperty/chatProperty:

const session = new MySQLSession(..., {
  chatProperty: 'chatSession',
  userProperty: 'userSession'
})
...
telegraf.on('text', (ctx) => {
  ctx.chatSession = {foo: 'bar'}; //Session data stored for chat (not related to user)
  ctx.userSession = {foo: 'bar'}; //Session data stored for user (not related to chat)
  ctx.session = {foo: 'bar'}; //Default session for chat & user
})

Destroying a session

To destroy a session simply set it to null.

telegraf.on('text', (ctx) => {
  ctx.session = null
})

To destroy sessions data and close databse connection, use destroy method.

const session = new MySQLSession();
...
session.destroy();