refac(auth): loading github module optionally

apps/api/src/auth/auth.module.ts

@@ -1,9 +1,9 @@
-import { Module } from '@nestjs/common'
+import { Logger, Module } from '@nestjs/common'
 import { AuthService } from './service/auth.service'
 import { AuthController } from './controller/auth.controller'
 import { JwtModule } from '@nestjs/jwt'
 import { UserModule } from '../user/user.module'
-import { GithubStrategy } from './github.stratergy'
+import { GithubEnvService, GithubStrategy } from './github.stratergy'
 
 @Module({
   imports: [
@@ -18,7 +18,27 @@ import { GithubStrategy } from './github.stratergy'
     }),
     UserModule
   ],
-  providers: [AuthService, GithubStrategy],
+  providers: [
+    AuthService,
+    GithubEnvService,
+    {
+      provide: GithubStrategy,
+      useFactory: (githubEnvService: GithubEnvService) => {
+        if (githubEnvService.isGithubEnabled()) {
+          const creds = githubEnvService.getGithubCredentials()
+          return new GithubStrategy(
+            creds.clientID,
+            creds.clientSecret,
+            creds.callbackURL
+          )
+        } else {
+          Logger.warn('Github Login Is Not Enabled In This Environment')
+          return null
+        }
+      },
+      inject: [GithubEnvService]
+    }
+  ],
   controllers: [AuthController]
 })
 export class AuthModule {}

apps/api/src/auth/controller/auth.controller.spec.ts

@@ -6,6 +6,8 @@ import { JwtService } from '@nestjs/jwt'
 import { PrismaService } from '../../prisma/prisma.service'
 import { AuthController } from './auth.controller'
 import { mockDeep } from 'jest-mock-extended'
+import { GithubEnvService } from '../github.stratergy'
+import { ConfigService } from '@nestjs/config'
 
 describe('AuthController', () => {
   let controller: AuthController
@@ -15,6 +17,8 @@ describe('AuthController', () => {
       controllers: [AuthController],
       providers: [
         AuthService,
+        GithubEnvService,
+        ConfigService,
         { provide: MAIL_SERVICE, useClass: MockMailService },
         JwtService,
         PrismaService

apps/api/src/auth/controller/auth.controller.ts

@@ -1,23 +1,29 @@
 import {
   Controller,
   Get,
+  HttpException,
   HttpStatus,
   Param,
   Post,
   Query,
   Req,
+  Res,
   UseGuards
 } from '@nestjs/common'
 import { AuthService } from '../service/auth.service'
 import { UserAuthenticatedResponse } from '../auth.types'
 import { Public } from '../../decorators/public.decorator'
 import { ApiOperation, ApiParam, ApiResponse, ApiTags } from '@nestjs/swagger'
 import { AuthGuard } from '@nestjs/passport'
+import { GithubEnvService } from '../github.stratergy'
 
 @ApiTags('Auth Controller')
 @Controller('auth')
 export class AuthController {
-  constructor(private authService: AuthService) {}
+  constructor(
+    private authService: AuthService,
+    private readonly githubEnvService: GithubEnvService
+  ) {}
 
   @Public()
   @Post('send-otp/:email')
@@ -84,18 +90,20 @@ export class AuthController {
 
   @Public()
   @Get('github')
-  @UseGuards(AuthGuard('github'))
   @ApiOperation({
     summary: 'Github OAuth',
     description:
       'This endpoint validates Github OAuth. If the OAuth is valid, it returns a valid token along with the user details'
   })
-  async githubOAuthLogin() {
-    /**
-     * NOTE:
-     * This function does nothing and the oauth redirect is managed my AuthGuard
-     * - The 'github' method inside the authguard is managed by passport
-     */
+  async githubOAuthLogin(@Res() res) {
+    if (!this.githubEnvService.isGithubEnabled()) {
+      throw new HttpException(
+        'Github Login Is Not Enabled In This Environment',
+        HttpStatus.BAD_REQUEST
+      )
+    }
+
+    res.status(302).redirect('/api/auth/github/callback')
   }
 
   @Public()

apps/api/src/auth/github.stratergy.ts

@@ -5,10 +5,7 @@ import { Profile, Strategy } from 'passport-github2'
 
 @Injectable()
 export class GithubStrategy extends PassportStrategy(Strategy, 'github') {
-  constructor(configService: ConfigService) {
-    const clientID = configService.get<string>('GITHUB_CLIENT_ID')
-    const clientSecret = configService.get<string>('GITHUB_CLIENT_SECRET')
-    const callbackURL = configService.get<string>('GITHUB_CALLBACK_URL')
+  constructor(clientID: string, clientSecret: string, callbackURL: string) {
     super({
       clientID,
       clientSecret,
@@ -17,7 +14,36 @@ export class GithubStrategy extends PassportStrategy(Strategy, 'github') {
     })
   }
 
-  async validate(accessToken: string, _refreshToken: string, profile: Profile) {
+  async validate(
+    _accessToken: string,
+    _refreshToken: string,
+    profile: Profile
+  ) {
     return profile
   }
 }
+
+// todo: find a better place to keep this
+@Injectable()
+export class GithubEnvService {
+  private clientID: string
+  private clientSecret: string
+  private callbackURL: string
+  constructor(private readonly configService: ConfigService) {}
+
+  isGithubEnabled(): boolean {
+    this.clientID = this.configService.get<string>('GITHUB_CLIENT_ID')
+    this.clientSecret = this.configService.get<string>('GITHUB_CLIENT_SECRET')
+    this.callbackURL = this.configService.get<string>('GITHUB_CALLBACK_URL')
+
+    return Boolean(this.clientID && this.clientSecret && this.callbackURL)
+  }
+
+  getGithubCredentials() {
+    return {
+      clientID: this.clientID,
+      clientSecret: this.clientSecret,
+      callbackURL: this.callbackURL
+    }
+  }
+}