mrtenz / typeorm-store

A TypeORM-based store for express-session.

typeorm-store

A TypeORM-based store for express-session.

Installation

$ yarn add typeorm-store

Usage

First, make a new Session entity. Make sure to synchronize the entity to the database. typeorm-store will not do this for you.

import { BaseEntity, Column, Entity, PrimaryColumn } from 'typeorm';
import { SessionEntity } from 'typeorm-store';

@Entity()
export class Session extends BaseEntity implements SessionEntity {
    @PrimaryColumn()
    id: string;

    @Column()
    expiresAt: number;

    @Column()
    data: string;
}

Use TypeormStore as store in express-session, specifying the repository of the new Session entity.

import * as express from 'express';
import * as session from 'express-session';
import { getConnection } from 'typeorm';
import { TypeormStore } from 'typeorm-store';
import { Session } from './entities/session';

const app = express();

// Make sure the connection is ready before doing this
const repository = getConnection().getRepository(Session);

app.use(session({
   secret: 'secret',
   resave: false,
   saveUninitialized: false,
   store: new TypeormStore({ repository })
}))

API

new TypeormStore(options)

Options

• repository (required) - The repository of the session entity.
• ttl (optional) - The time to live for the session in seconds. Defaults to 86400 (1 day).
• expirationInterval (optional) - The interval in seconds to check for expired sessions. Defaults to 86400 (1 minute).

typeorm-store's Issues

Update findOne to follow typeorm changes past 0.3.0

typeorm-store/src/store.ts

Line 115 in 5bc4d52

.findOne(id)

findOne({
where: {
id: 1,
})

Error: Argument passed in must be a single String of 12 bytes or a string of 24 hex characters

Error: Argument passed in must be a single String of 12 bytes or a string of 24 hex characters
at new ObjectID (/home/container/node_modules/bson/lib/bson/objectid.js:59:11)
at MongoEntityManager. (/home/container/node_modules/typeorm/entity-manager/MongoEntityManager.js:183:84)
at step (/home/container/node_modules/tslib/tslib.js:143:27)
at Object.next (/home/container/node_modules/tslib/tslib.js:124:57)
at /home/container/node_modules/tslib/tslib.js:117:75
at new Promise ()
at __awaiter (/home/container/node_modules/tslib/tslib.js:113:16)
at MongoEntityManager.findOne (/home/container/node_modules/typeorm/entity-manager/MongoEntityManager.js:173:38)
at MongoRepository.findOne (/home/container/node_modules/typeorm/repository/MongoRepository.js:57:29)
at e.TypeormStore.get (/home/container/node_modules/typeorm-store/lib/typeormStore.js:1:1636)

expirationInterval is defined in milliseconds, not seconds

The expirationInterval doc comment says:

The interval between checking for expired sessions in seconds. Defaults to 86400 (1 day).

But, the value is actually passed as-is to node's setInterval function, without first multiplying by 1000 (https://github.com/Mrtenz/typeorm-store/blob/master/src/store.ts#L189):

this.expirationIntervalId = setInterval(this.clearExpiredSessions, interval);

This means clearExpiredSessions() is getting called 1000x more times than would be expected given the documentation. :)

Type error when setting up connection

Type 'Repository<Session>' is not assignable to type 'Repository<SessionEntity>'.
  Types of property 'findOne' are incompatible.
    Type '{ (id?: string | number | Date | ObjectID, options?: FindOneOptions<Session>): Promise<Session>; (options?: FindOneOptions<Session>): Promise<Session>; (conditions?: FindConditions<Session>, options?: FindOneOptions<...>): Promise<...>; }' is not assignable to type '{ (id?: string | number | Date | ObjectID, options?: FindOneOptions<SessionEntity>): Promise<SessionEntity>; (options?: FindOneOptions<SessionEntity>): Promise<SessionEntity>; (conditions?: FindConditions<...>, options?: FindOneOptions<...>): Promise<...>; }'.

Peer Dependency for [email protected]

Thanks for this library! Is there a version that is compatible with Typeorm 0.3.7? I'm getting this error when trying to install with npm:

Could not resolve dependency: peer typeorm@"^0.2.7" from [email protected]

expired sessions are not deleted from database

there is no code that deletes expired sessions from database. It seems that some other stores implement interval based mechanism to delete expired sessions periodically from database

sequelize example:
https://github.com/mweibel/connect-session-sequelize/blob/master/lib/connect-session-sequelize.js#L152-L173

mysql example:
https://github.com/chill117/express-mysql-session/blob/master/index.js#L429-L445

Wrong units in documentation

Hello,

the documentation (README) says that ttl configuration is in millisecods.
However looking at the code, it expects seconds. The undocumented expirationInterval also expects 'seconds'.

This is just to prevent others to make the mistake i did.

---

BTW: Thanks @Mrtenz for writting this!

Error when using the latest version of typeorm

When using the latest version of typeorm npm install typeorm@next, I'm getting this error:
Type 'Repository<Session>' is not assignable to type 'Repository<SessionEntity>'.

Is there a way to add custom metadata to the session table?

Lets say I want to associate a user ID with my session entity, so I can easily retrieve all sessions from a user for a feature such as "logout from all devices".

Something like this:

@Entity()
export class Session extends BaseEntity implements SessionEntity {
  @Index()
  @Column('bigint')
  expiresAt: number;

  @PrimaryColumn()
  id: string;

  @Column('json')
  data: string;

  @ManyToOne(() => User, (user) => user.sessions)
  @JoinColumn({name: 'userId'})
  user: User;
}

How can I make it so, whenever a new session is created, this column is populated with the associated user ID?