feat: Add google auth for signin

package.json

@@ -23,14 +23,22 @@
  "@types/swagger-ui-express": "^4.1.6",
  "bcrypt": "^5.1.1",
  "class-validator": "^0.14.1",
+ "cloudinary": "^2.2.0",
  "cors": "^2.8.5",
+ "crypto": "^1.0.1",
  "dotenv": "^16.4.5",
  "express": "^4.19.2",
+ "express-session": "^1.18.0",
  "express-winston": "^4.2.0",
  "highlight.js": "^11.9.0",
  "jsend": "^1.1.0",
+ "jsonwebtoken": "^9.0.2",
  "morgan": "^1.10.0",
  "nodemon": "^3.1.0",
+ "passport": "^0.7.0",
+ "passport-facebook": "^3.0.0",
+ "passport-google-oauth": "^2.0.0",
+ "passport-google-oauth20": "^2.0.0",
  "pg": "^8.11.5",
  "reflect-metadata": "^0.2.2",
  "source-map-support": "^0.5.21",
@@ -53,10 +61,15 @@
  "@types/eslint": "^8.56.10",
  "@types/eslint__js": "^8.42.3",
  "@types/express": "^4.17.21",
+ "@types/express-session": "^1.18.0",
  "@types/jest": "^29.5.12",
  "@types/jsend": "^1.0.32",
+ "@types/jsonwebtoken": "^9.0.6",
  "@types/morgan": "^1.9.9",
  "@types/node": "^20.12.7",
+ "@types/passport": "^1.0.16",
+ "@types/passport-facebook": "^3.0.3",
+ "@types/passport-google-oauth20": "^2.0.14",
  "@types/reflect-metadata": "^0.1.0",
  "@types/supertest": "^6.0.2",
  "@types/winston": "^2.4.4",
@@ -75,4 +88,4 @@
  "typescript": "^5.4.5",
  "typescript-eslint": "^7.7.1"
  }
-}
+}

src/__test__/gmailController.test.ts

@@ -0,0 +1,24 @@
+import { Request, Response } from 'express';
+import { initiateGoogleLogin } from '../controllers/google.auth';
+
+describe('initiateGoogleLogin', () => {
+ const req = {} as Request;
+ const res = {
+ redirect: jest.fn(),
+ } as unknown as Response;
+ const next = jest.fn();
+
+ it('should redirect to Google OAuth with appropriate scope', () => {
+ initiateGoogleLogin(req, res, next);
+
+ expect(res.redirect).toHaveBeenCalledWith(
+ expect.stringContaining('google')
+ );
+ expect(res.redirect).toHaveBeenCalledWith(
+ expect.stringContaining('profile')
+ );
+ expect(res.redirect).toHaveBeenCalledWith(
+ expect.stringContaining('email')
+ );
+ });
+});

src/__test__/route.test.ts

@@ -1,5 +1,5 @@
 import request from 'supertest';
-import { app, server } from '../index'; // update this with the path to your app file
+import { app} from '../index'; // update this with the path to your app file
 import { createConnection, getConnection, getConnectionOptions } from 'typeorm';
 import { User } from '../entities/User';
 import { getRepository, Repository } from 'typeorm';
@@ -12,7 +12,7 @@ beforeAll(async () => {
 
 afterAll(async () => {
  await getConnection('testConnection').close();
- server.close();
+ // server.close();
 });
 
 

src/configs/config.js

@@ -0,0 +1,34 @@
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const dotenv = require('dotenv');
+
+dotenv.config();
+
+const getPrefix = () => {
+ const env = process.env.NODE_ENV || 'production';
+ const envPrefixMap = {
+ development: 'DATABASE',
+ test: 'TEST_DATABASE',
+ production: 'PROD_DATABASE',
+ };
+ const prefix = envPrefixMap[env];
+ return prefix;
+};
+
+const getDatabaseConfig = () => {
+ const prefix = getPrefix();
+ const config = {
+ secret: process.env.JWT_SECRET || 'secret',
+ };
+
+ if (prefix === 'PROD_DATABASE') {
+ config.dialectOptions = {
+ ssl: {
+ require: true,
+ rejectUnauthorized: false,
+ },
+ };
+ }
+ return config;
+};
+
+module.exports = getDatabaseConfig;

src/controllers/authController.ts

@@ -1,5 +1,5 @@
 import { Request, Response } from 'express';
-import { User } from '../entities/User';;
+import { User } from '../entities/User';
 import bcrypt from 'bcrypt';
 import { getRepository } from 'typeorm';
 

src/controllers/google.auth.ts

@@ -0,0 +1,43 @@
+/* eslint-disable no-console */
+import { Request, Response, NextFunction } from 'express';
+import passport from 'passport';
+import { User } from '../entities/User';
+import { responseSuccess, signToken } from '../utils';
+
+export const initiateGoogleLogin = (
+ req: Request,
+ res: Response,
+ next: NextFunction
+) => {
+ passport.authenticate('google', { scope: ['profile', 'email'] })(
+ req,
+ res,
+ next
+ );
+};
+
+export const handleGoogleCallback = async (req: Request, res: Response) => {
+ passport.authenticate(
+ 'google',
+ async (err: unknown, user: User | null) => {
+ if (err) {
+ return res.status(500).json({error: 'Failed to authenticate with Google'});
+ }
+ if (!user) {
+ return res.status(401).json({error: 'User not found'});
+ }
+
+ try {
+ const token = signToken({ id: user.id });
+
+ responseSuccess(res, 200, token, 'User authenticated successfully');
+ } catch (error) {
+ console.error('Error occurred:', error);
+ res.status(500).json({ error: 'Internal server error' });
+ }
+
+ }
+ )(req, res);
+};
+
+export { passport };

src/entities/User.ts

@@ -11,6 +11,16 @@ import {
  @Entity()
  @Unique(['email'])
  export class User {
+ static User: any;
+ save() {
+ throw new Error('Method not implemented.');
+ }
+ static create(arg0: { accountId: string; name: string; provider: string; }): User | PromiseLike<User | null> | null {
+ throw new Error('Method not implemented.');
+ }
+ static findOne(arg0: { accountId: any; provider: string; }) {
+ throw new Error('Method not implemented.');
+ }
  @PrimaryGeneratedColumn('uuid')
  @IsNotEmpty()
  id!: string;
@@ -66,4 +76,21 @@ import {
 
  @UpdateDateColumn()
  updatedAt!: Date;
+
+ @Column({ nullable: true })
+ @IsString()
+ accountId?: string;
+
+ @Column({ nullable: true })
+ @IsString()
+ name?: string;
+
+ @Column({ nullable: true })
+ @IsString()
+ photoURL?: string;
+
+ @Column({ nullable: true })
+ @IsString()
+ provider?: string;
+
  }

src/index.ts

@@ -1,19 +1,19 @@
 import express, { Request, Response } from 'express';
 import cors from 'cors';
-import dotenv from 'dotenv';
 import router from './routes';
 import { addDocumentation } from './startups/docs';
 import 'reflect-metadata';
-
-
+import dotenv from 'dotenv';
+dotenv.config();
 import { CustomError, errorHandler } from './middlewares/errorHandler';
 import morgan from 'morgan';
 import { dbConnection } from './startups/dbConnection';
+import passport from 'passport';
+import session from 'express-session';
+import routerGmail from '../src/routes/googleRoutes.auth';
 dotenv.config();
 
 export const app = express();
-const port = process.env.PORT || 8000;
-app.use(express.json());
 
 app.use(cors({ origin: '*' }));
 app.use(router);
@@ -32,6 +32,11 @@ dbConnection();
 const morganFormat = ':method :url :status :response-time ms - :res[content-length]';
 app.use(morgan(morganFormat));
 
-export const server = app.listen(port, () => {
- console.log(`[server]: Server is running at http://localhost:${port}`);
-});
+
+//Google OAuth routes
+app.use('/auth/google', routerGmail);
+
+const port = process.env.PORT || 6890;
+app.listen(port, () => {
+ console.log(`Server is running at http://localhost:${port}`);
+});

src/routes/googleRoutes.auth.ts

@@ -0,0 +1,9 @@
+import { Router } from 'express';
+import * as authController from '../controllers/google.auth';
+
+const routerGmail = Router();
+
+routerGmail.get('/users/google-auth', authController.initiateGoogleLogin);
+routerGmail.get('/users/google-auth/callback', authController.handleGoogleCallback);
+
+export default routerGmail;

src/utils/cloud.ts

@@ -0,0 +1,59 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import {
+ v2 as cloudinary,
+ UploadApiResponse,
+ UploadApiErrorResponse,
+ } from 'cloudinary';
+ import dotenv from 'dotenv';
+ import path from 'path';
+ import fs from 'fs';
+ import os from 'os';
+
+ dotenv.config();
+
+ cloudinary.config({
+ cloud_name: process.env.CLOUDINARY_NAME,
+ api_key: process.env.CLOUDINARY_KEY,
+ api_secret: process.env.CLOUDINARY_SECRET,
+ });
+
+ export const cloudUpload = async (
+ buffer: Buffer,
+ fileName: string
+ ): Promise<string> => {
+ return new Promise((resolve, reject) => {
+ const tempFilePath = path.join(os.tmpdir(), fileName);
+
+ fs.writeFile(tempFilePath, buffer, writeError => {
+ if (writeError) {
+ reject(writeError);
+ return;
+ }
+
+ cloudinary.uploader.upload(
+ tempFilePath,
+ (
+ uploadError: UploadApiErrorResponse | undefined,
+ result: UploadApiResponse
+ ) => {
+
+ if (uploadError) {
+ reject(new Error(uploadError.message));
+ } else {
+ const uploadResult: string = result.secure_url;
+ resolve(uploadResult);
+ }
+ }
+ );
+ });
+ });
+ };
+ export const deleteCloudinaryFile = async (url: string) => {
+ try {
+ await cloudinary.uploader.destroy(url);
+ return true;
+ } catch (error) {
+ return error;
+ }
+ };
+

src/utils/index.ts

@@ -1 +1,6 @@
 // export all utils
+export * from './response.utils';
+export * from './logger';
+export * from './cloud';
+export * from './jwtToken';
+

src/utils/jwtToken.ts

@@ -0,0 +1,27 @@
+import jwt from 'jsonwebtoken';
+import getDatabaseConfig from '../configs/config';
+
+
+const { secret } = getDatabaseConfig();
+
+// Verifies a token
+export const verifyToken = (
+ token: string
+): { email: string; id: string } | null => {
+ const decoded = jwt.verify(token, secret) as { email: string; id: string };
+ return decoded;
+};
+
+// Generates a token
+interface TokenPayload {
+ id?: string;
+ email?: string;
+}
+
+export const signToken = (
+ payload: TokenPayload,
+ expiresIn: string = '2h'
+): string => {
+ const token = jwt.sign(payload, secret, { expiresIn });
+ return token;
+};