Merge pull request #36 from kleydon/dev-4

expires -> expiresAt; min express-session and prisma versions

.gitignore

@@ -67,4 +67,5 @@ dist
 
 # Testing
 coverage
-prisma/dev.db
+prisma/dev.db
+prisma/migrations/**

CONTRIBUTING.md

@@ -73,11 +73,13 @@ Must be one of the following:
 - **build**: Changes that affect the build system or external dependencies
 - **ci**: Changes to our CI configuration files and scripts
 - **docs**: Documentation only changes
+- **style**: Changes that do not affect the meaning of the code
 - **feat**: A new feature
 - **fix**: A bug fix
 - **perf**: A code change that improves performance
 - **refactor**: A code change that neither fixes a bug nor adds a feature
 - **test**: Adding missing tests or correcting existing tests
+- **chore**: Changes to the build process or auxiliary tools and libraries
 
 ### Commit Message Body
 

README.md

@@ -93,7 +93,7 @@ model Session {
   id        String   @id
   sid       String   @unique
   data      String
-  expires   DateTime
+  expiresAt   DateTime
 }
 ```
 
@@ -112,7 +112,7 @@ If you are using [@nexus/schema](https://www.npmjs.com/package/@nexus/schema) yo
     t.model.id();
     t.model.sid();
     t.model.data();
-    t.model.expires();
+    t.model.expiresAt();
   }
 }
 ...
@@ -137,6 +137,11 @@ Prisma `String` properties are mapped to `VARCHAR(191)` by default. Session data
 
 If you are using a version of Prisma that supports [migrating with native types](https://github.com/prisma/prisma/issues/4330) you can use a type annotation in your `schema.prisma` file instead of manually modifying your data column.
 
+## Migrating from versions following `2.0.0`
+
+Following version `2.0.0`, the `Session` `expires` field was renamed to `expiresAt` to match Prisma's naming convention for date fields.
+
+
 ## Migrating from versions prior to `1.0.0`
 
 In `1.0.0` the public API of this library was reworked. Previously the default export that was a

package.json

@@ -48,22 +48,22 @@
     "type-fest": "^0.20.2"
   },
   "peerDependencies": {
-    "@prisma/client": "*",
-    "express-session": "*"
+    "@prisma/client": ">=2.16.1",
+    "express-session": ">=1.17.3"
   },
   "devDependencies": {
     "@commitlint/cli": "^11.0.0",
     "@commitlint/config-conventional": "^11.0.0",
-    "@prisma/cli": "^2.14.0",
-    "@prisma/client": "^2.14.0",
+    "@prisma/cli": "^2.16.1",
+    "@prisma/client": "^2.16.1",
     "@semantic-release/changelog": "^5.0.1",
     "@semantic-release/git": "^9.0.0",
-    "@types/express": "^4.17.9",
+    "@types/express": "^4.17.11",
     "@types/express-session": "^1.17.3",
     "@types/jest": "^26.0.20",
-    "@types/node": "^14.14.20",
+    "@types/node": "^14.14.28",
     "@types/supertest": "^2.0.10",
-    "commitizen": "^4.2.2",
+    "commitizen": "^4.2.3",
     "cz-conventional-changelog": "3.3.0",
     "express": "^4.17.1",
     "express-session": "^1.17.1",
@@ -72,11 +72,11 @@
     "prettier": "^2.2.1",
     "pretty-quick": "^3.1.0",
     "semantic-release": "^17.3.1",
-    "supertest": "^6.0.1",
-    "ts-jest": "^26.4.4",
+    "supertest": "^6.1.3",
+    "ts-jest": "^26.5.1",
     "tslint": "^6.1.3",
     "tslint-config-suiyobi": "^0.4.8",
-    "typescript": "^4.1.3"
+    "typescript": "^4.1.5"
   },
   "config": {
     "commitizen": {

prisma/schema.prisma

@@ -14,5 +14,5 @@ model Session {
   id      String   @id
   sid     String   @unique
   data    String
-  expires DateTime
+  expiresAt DateTime
 }

src/@types/prisma.ts

@@ -1,6 +1,6 @@
 export interface IPrismaSession {
   data: string | null;
-  expires: Date;
+  expiresAt: Date;
   id: string;
   sid: string;
 }
@@ -11,7 +11,7 @@ interface ICreatePrismaSession extends IPrismaSession {
 
 interface IFindUniqueArgs {
   select?: {
-    expires?: boolean;
+    expiresAt?: boolean;
     sid?: boolean;
   };
   where: {
@@ -22,7 +22,7 @@ interface IFindUniqueArgs {
 interface IFindManyArgs {
   select?: {
     data?: boolean;
-    expires?: boolean;
+    expiresAt?: boolean;
     sid?: boolean;
   };
   where?: {

src/lib/prisma-session-store.spec.ts

@@ -361,8 +361,8 @@ describe('PrismaSessionStore', () => {
       });
 
       findManyMock.mockResolvedValueOnce([
-        { sid: 'sid-0', expires: createExpiration(-1, { rounding: 100 }) },
-        { sid: 'sid-1', expires: createExpiration(500, { rounding: 100 }) },
+        { sid: 'sid-0', expiresAt: createExpiration(-1, { rounding: 100 }) },
+        { sid: 'sid-1', expiresAt: createExpiration(500, { rounding: 100 }) },
       ]);
       deleteMock.mockResolvedValue(undefined);
 
@@ -729,7 +729,7 @@ describe('PrismaSessionStore', () => {
         });
         deleteMock.mockResolvedValue(undefined);
         findManyMock.mockResolvedValue([
-          { expires: createExpiration(-1, { rounding: 100 }) },
+          { expiresAt: createExpiration(-1, { rounding: 100 }) },
         ]);
 
         await sleep(10);
@@ -745,7 +745,7 @@ describe('PrismaSessionStore', () => {
         });
 
         findManyMock.mockResolvedValue([
-          { expires: createExpiration(-1, { rounding: 100 }) },
+          { expiresAt: createExpiration(-1, { rounding: 100 }) },
         ]);
 
         await sleep(10);
@@ -761,7 +761,7 @@ describe('PrismaSessionStore', () => {
 
         expect(createMock).toHaveBeenCalledWith({
           data: expect.objectContaining({
-            expires: createExpiration(500, { rounding: 100 }),
+            expiresAt: createExpiration(500, { rounding: 100 }),
           }),
         });
       });
@@ -776,7 +776,7 @@ describe('PrismaSessionStore', () => {
 
         expect(createMock).toHaveBeenCalledWith({
           data: expect.objectContaining({
-            expires: createExpiration(500, { rounding: 100 }),
+            expiresAt: createExpiration(500, { rounding: 100 }),
           }),
         });
       });
@@ -797,7 +797,7 @@ describe('PrismaSessionStore', () => {
 
         expect(createMock).toHaveBeenCalledWith({
           data: expect.objectContaining({
-            expires: createExpiration(100, { rounding: 100 }),
+            expiresAt: createExpiration(100, { rounding: 100 }),
           }),
         });
       });
@@ -809,7 +809,7 @@ describe('PrismaSessionStore', () => {
 
         expect(createMock).toHaveBeenCalledWith({
           data: expect.objectContaining({
-            expires: createExpiration(500, { rounding: 100 }),
+            expiresAt: createExpiration(500, { rounding: 100 }),
           }),
         });
       });

src/lib/prisma-session-store.ts

@@ -315,17 +315,17 @@ export class PrismaSessionStore extends Store {
     this.logger.log('Checking for any expired sessions...');
     const sessions = await this.prisma.session.findMany({
       select: {
-        expires: true,
+        expiresAt: true,
         sid: true,
       },
     });
 
     for (const session of sessions) {
       const now = new Date();
-      const remainingSec = (session.expires.valueOf() - now.valueOf()) / 1000;
+      const remainingSec = (session.expiresAt.valueOf() - now.valueOf()) / 1000;
       this.logger.log(`session:${session.sid} expires in ${remainingSec}sec`);
 
-      if (now.valueOf() >= session.expires.valueOf()) {
+      if (now.valueOf() >= session.expiresAt.valueOf()) {
         this.logger.log(`Deleting session with sid: ${session.sid}`);
         await this.prisma.session.delete({
           where: { sid: session.sid },
@@ -350,7 +350,9 @@ export class PrismaSessionStore extends Store {
     if (!(await this.validateConnection())) return callback?.();
 
     const ttl = getTTL(this.options, session, sid);
-    const expires = createExpiration(ttl, { rounding: this.options.roundTTL });
+    const expiresAt = createExpiration(ttl, {
+      rounding: this.options.roundTTL,
+    });
 
     let sessionString;
     try {
@@ -370,7 +372,7 @@ export class PrismaSessionStore extends Store {
 
     const data = {
       sid,
-      expires,
+      expiresAt,
       data: sessionString,
       id: this.dbRecordIdIsSessionId ? sid : this.dbRecordIdFunction(sid),
     };
@@ -434,7 +436,9 @@ export class PrismaSessionStore extends Store {
     if (!(await this.validateConnection())) return callback?.();
 
     const ttl = getTTL(this.options, session, sid);
-    const expires = createExpiration(ttl, { rounding: this.options.roundTTL });
+    const expiresAt = createExpiration(ttl, {
+      rounding: this.options.roundTTL,
+    });
 
     try {
       const existingSession = await this.prisma.session.findUnique({
@@ -450,7 +454,7 @@ export class PrismaSessionStore extends Store {
         await this.prisma.session.update({
           where: { sid: existingSession.sid },
           data: {
-            expires,
+            expiresAt,
             data: this.serializer.stringify(existingSessionData),
           },
         });