Merge pull request #57 from cham11ng/bye-bye-bookshelf

cham11ng · web-flow · commit f1f7377b865b · 2022-06-30T17:50:56.000+05:45
Bye Bye bookshelf, say Hi objection.js
diff --git a/package.json b/package.json
@@ -53,28 +53,27 @@
   ],
   "dependencies": {
     "bcrypt": "^5.0.1",
-    "bookshelf": "^1.2.0",
     "bookshelf-case-converter-plugin": "^2.0.0",
     "cors": "^2.8.5",
     "date-fns": "^2.11.1",
     "dotenv": "^16.0.1",
-    "express": "4.17.1",
+    "express": "4.18.1",
     "helmet": "^5.1.0",
     "http-status-codes": "^2.1.4",
     "joi": "^17.6.0",
     "jsonwebtoken": "^8.5.1",
-    "knex": "^0.21.19",
+    "knex": "^2.1.0",
     "morgan": "^1.10.0",
     "nodemailer": "^6.6.3",
     "nodemailer-markdown": "^1.0.3",
+    "objection": "^3.0.1",
     "pg": "^8.6.0",
     "winston": "^3.3.3",
     "winston-daily-rotate-file": "^4.5.5"
   },
   "devDependencies": {
     "@faker-js/faker": "^7.3.0",
     "@types/bcrypt": "^5.0.0",
-    "@types/bookshelf": "^1.2.2",
     "@types/cors": "^2.8.12",
     "@types/express": "^4.17.13",
     "@types/jest": "^28.1.3",
diff --git a/src/app.ts b/src/app.ts
@@ -1,13 +1,17 @@
 import cors from 'cors';
 import helmet from 'helmet';
 import express from 'express';
+import { Model } from 'objection';
 
 import routes from './routes';
+import knex from './config/knex';
 import logHandler from './middlewares/logHandler';
 import notFoundHandler from './middlewares/notFoundHandler';
 import transactionHandler from './middlewares/transactionHandler';
 import genericErrorHandler from './middlewares/genericErrorHandler';
 
+Model.knex(knex);
+
 const app: express.Application = express();
 
 app.use(cors());
diff --git a/src/config/bookshelf.ts b/src/config/bookshelf.ts
diff --git a/src/config/knex.ts b/src/config/knex.ts
@@ -1,7 +1,8 @@
 import Knex from 'knex';
+import { knexSnakeCaseMappers } from 'objection';
 
 import config from '../config/config';
 
-const dbConfig: Knex.Config = config.db;
+const dbConfig = config.db;
 
-export default Knex(dbConfig);
+export default Knex({ ...dbConfig, ...knexSnakeCaseMappers() });
diff --git a/src/database/migrations/20170517164638_create_user_roles_table.ts b/src/database/migrations/20170517164638_create_user_roles_table.ts
@@ -1,4 +1,4 @@
-import Knex from 'knex';
+import { Knex } from 'knex';
 
 import Table from '../../resources/enums/Table';
 
diff --git a/src/database/migrations/20180130005620_create_users_table.ts b/src/database/migrations/20180130005620_create_users_table.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import Table from '../../resources/enums/Table';
 
diff --git a/src/database/migrations/20180517164647_create_user_sessions_table.ts b/src/database/migrations/20180517164647_create_user_sessions_table.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import Table from '../../resources/enums/Table';
 
diff --git a/src/database/seeds/user_table_seeder.ts b/src/database/seeds/user_table_seeder.ts
@@ -1,4 +1,4 @@
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 import * as bcrypt from '../../utils/bcrypt';
 import Role from '../../resources/enums/Role';
diff --git a/src/domain/requests/UserSessionPayload.ts b/src/domain/requests/UserSessionPayload.ts
@@ -3,7 +3,7 @@
  */
 interface UserSessionPayload {
   token: string;
-  userId: string;
+  userId: number;
 }
 
 export default UserSessionPayload;
diff --git a/src/models/User.ts b/src/models/User.ts
@@ -1,18 +1,26 @@
-import bookshelf from '../config/bookshelf';
+import { Model } from 'objection';
 
 import Table from '../resources/enums/Table';
 
-class User extends bookshelf.Model<User> {
-  get requireFetch(): boolean {
-    return false;
-  }
+class User extends Model {
+  id!: number;
+  name!: string;
+  email!: string;
+  password!: string;
+  roleId!: number;
+  createdAt!: string;
+  updatedAt!: string;
 
-  get tableName(): string {
+  static get tableName(): string {
     return Table.USERS;
   }
 
-  get hasTimestamps(): boolean {
-    return true;
+  $beforeInsert() {
+    this.createdAt = new Date().toISOString();
+  }
+
+  $beforeUpdate() {
+    this.updatedAt = new Date().toISOString();
   }
 }
 
diff --git a/src/models/UserRole.ts b/src/models/UserRole.ts
@@ -1,18 +1,24 @@
-import bookshelf from '../config/bookshelf';
+import { Model } from 'objection';
 
 import Table from '../resources/enums/Table';
 
-class UserRole extends bookshelf.Model<UserRole> {
-  get requireFetch(): boolean {
-    return false;
-  }
+class UserRole extends Model {
+  id!: number;
+  name!: number;
+  description!: number;
+  createdAt!: string;
+  updatedAt!: string;
 
-  get tableName(): string {
+  static get tableName(): string {
     return Table.USER_ROLES;
   }
 
-  get hasTimestamps(): boolean {
-    return true;
+  $beforeInsert() {
+    this.createdAt = new Date().toISOString();
+  }
+
+  $beforeUpdate() {
+    this.updatedAt = new Date().toISOString();
   }
 }
 
diff --git a/src/models/UserSession.ts b/src/models/UserSession.ts
@@ -1,19 +1,18 @@
-import bookshelf from '../config/bookshelf';
+import { Model } from 'objection';
 
 import Table from '../resources/enums/Table';
 
-class UserSession extends bookshelf.Model<UserSession> {
-  get requireFetch(): boolean {
-    return false;
-  }
+class UserSession extends Model {
+  id!: number;
+  token!: string;
+  userId!: number;
+  isActive!: boolean;
+  updatedBy!: string;
+  createdBy!: string;
 
-  get tableName(): string {
+  static get tableName(): string {
     return Table.USER_SESSIONS;
   }
-
-  get hasTimestamps(): boolean {
-    return true;
-  }
 }
 
 export default UserSession;
diff --git a/src/services/authService.ts b/src/services/authService.ts
@@ -25,18 +25,18 @@ export async function login(
   const { email, password } = loginPayload;
 
   logger.log('info', 'Checking email: %s', email);
-  const user = await new User({ email }).fetch();
+  const user = await User.query().findOne({ email });
 
   if (user) {
-    logger.log('debug', 'Login: Fetched user by email -', user.attributes);
+    logger.log('debug', 'Login: Fetched user by email -', user);
     logger.log('debug', 'Login: Comparing password');
 
-    const isSame = await bcrypt.compare(password, user.attributes.password);
+    const isSame = await bcrypt.compare(password, user.password);
 
     logger.log('debug', 'Login: Password match status - %s', isSame);
 
     if (isSame) {
-      const { name, roleId, id: userId } = user.attributes;
+      const { name, roleId, id: userId } = user;
       const loggedInUser = { name, email, userId, roleId };
       const refreshToken = jwt.generateRefreshToken(loggedInUser);
       const userSessionPayload = { userId, token: refreshToken };
@@ -66,13 +66,15 @@ export async function refresh(
 ): Promise<TokenResponse> {
   logger.log('info', 'User Session: Fetching session of token - %s', token);
 
-  const session = await new UserSession({ token, isActive: true }).fetch();
-
+  const session = await UserSession.query().findOne({
+    token,
+    isActive: true
+  });
   if (!session) {
     throw new ForbiddenError(errors.sessionNotMaintained);
   }
 
-  logger.log('debug', 'User Session: Fetched session -', session.serialize());
+  logger.log('debug', 'User Session: Fetched session -', session);
   logger.log('info', 'JWT: Generating new access token');
 
   const accessToken = jwt.generateAccessToken({
diff --git a/src/services/sessionService.ts b/src/services/sessionService.ts
@@ -1,6 +1,5 @@
 import logger from '../utils/logger';
 import config from '../config/config';
-import * as object from '../utils/object';
 import UserSession from '../models/UserSession';
 import ErrorType from '../resources/enums/ErrorType';
 import ForbiddenError from '../exceptions/ForbiddenError';
@@ -20,11 +19,11 @@ export async function create(
 ): Promise<UserSessionDetail> {
   logger.log('info', 'User Session: Creating session -', params);
 
-  const session = (await new UserSession(params).save()).serialize();
+  const session = await UserSession.query().insert(params).returning('*');
 
   logger.log('debug', 'User Session: Session created successfully -', session);
 
-  return object.camelize(session);
+  return session;
 }
 
 /**
@@ -37,16 +36,14 @@ export async function remove(token: string): Promise<UserSessionDetail> {
   try {
     logger.log('info', 'User Session: Deactivating token - %s', token);
 
-    const session = (
-      await new UserSession()
-        // TODO: Fix this via. knex
-        .where({ token, is_active: true })
-        .save({ isActive: false }, { patch: true })
-    ).serialize();
-
+    const [session] = await UserSession.query()
+      .update({ isActive: false })
+      .where('token', token)
+      .where('isActive', true)
+      .returning('*');
     logger.log('debug', 'User Session: Deactivated session -', session);
 
-    return object.camelize(session);
+    return session;
   } catch (err: any) {
     if (err.message === ErrorType.NO_ROWS_UPDATED_ERROR) {
       throw new ForbiddenError(errors.sessionNotMaintained);
diff --git a/src/services/userService.ts b/src/services/userService.ts
@@ -15,8 +15,8 @@ import UserPayload from '../domain/requests/UserPayload';
 export async function fetchAll(): Promise<UserDetail[]> {
   logger.log('info', 'Fetching users from database');
 
-  const users = await User.fetchAll();
-  const res = transform(users.serialize(), (user: UserDetail) => ({
+  const users = await await User.query();
+  const res = transform(users, (user: UserDetail) => ({
     name: user.name,
     email: user.email,
     roleId: user.roleId,
@@ -39,9 +39,9 @@ export async function insert(params: UserPayload): Promise<UserDetail> {
   logger.log('info', 'Inserting user into database:', params);
 
   const password = await bcrypt.hash(params.password);
-  const user = (
-    await new User({ ...params, password, roleId: Role.NORMAL_USER }).save()
-  ).serialize();
+  const user = await User.query()
+    .insert({ ...params, password, roleId: Role.NORMAL_USER })
+    .returning('*');
 
   logger.log('debug', 'Inserted user successfully:', user);
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -29,7 +29,7 @@
     "types": ["node", "express", "jest"],
     "allowSyntheticDefaultImports": true,
     "paths": {
-      "*": ["node_modules/*", "src/types/*"]
+      "*": ["src/types/*"]
     },
 
     "emitDecoratorMetadata": true,
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import Knex from 'knex';`
	`1`	`+import { Knex } from 'knex';`
`2`	`2`
`3`	`3`	`import Table from '../../resources/enums/Table';`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import * as Knex from 'knex';`
	`1`	`+import { Knex } from 'knex';`
`2`	`2`
`3`	`3`	`import Table from '../../resources/enums/Table';`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`*/`
`4`	`4`	`interface UserSessionPayload {`
`5`	`5`	`token: string;`
`6`		`- userId: string;`
	`6`	`+ userId: number;`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`export default UserSessionPayload;`