Class DatabaseStore

src/stores/database.ts:28–272

 * })
 */
export class DatabaseStore implements SessionStoreWithTaggingContract {
  #client: QueryClientContract
  #tableName: string
  #ttlSeconds: number
  #gcProbability: number

  /**
   * Creates a new database store instance
   *
   * @param client - Lucid query client instance
   * @param age - Session age in seconds or time expression (e.g. '2 hours')
   * @param options - Configuration options
   * @param options.tableName - Database table name (defaults to "sessions")
   * @param options.gcProbability - Garbage collection probability in percent (defaults to 2)
   */
  constructor(
    client: QueryClientContract,
    age: string | number,
    options?: {
      /**
       * Defaults to "sessions"
       */
      tableName?: string

      /**
       * The probability (in percent) that garbage collection will be
       * triggered on any given request. For example, 2 means 2% chance.
       *
       * Set to 0 to disable garbage collection.
       *
       * Defaults to 2 (2% chance)
       */
      gcProbability?: number
    }
  ) {
    this.#client = client
    this.#tableName = options?.tableName ?? 'sessions'
    this.#ttlSeconds = string.seconds.parse(age)
    this.#gcProbability = options?.gcProbability ?? 2
    debug('initiating database store')
  }

  /**
   * Runs garbage collection to delete expired sessions from the database.
   * Executes probabilistically based on gcProbability setting after writing session data.
   * Helps maintain database performance by removing stale session records.
   */
  async #collectGarbage(): Promise<void> {
    if (this.#gcProbability <= 0) {
      return
    }

    const random = Math.random() * 100
    if (random < this.#gcProbability) {
      debug('database store: running garbage collection')
      const expiredBefore = new Date(Date.now())
      await this.#client.from(this.#tableName).where('expires_at', '<=', expiredBefore).delete()
    }