CLN: Interface for User and UserCache Services (#68)

Author: arjun-keyvalue

src/authentication/authentication.module.ts

@@ -75,7 +75,7 @@ const providers: Provider[] = [
     TwilioImplModule,
     HttpModule,
   ],
-  providers: providers,
+  providers,
   controllers: [GoogleAuthController],
 })
 export class UserAuthModule {}

src/authentication/service/google.service.ts

@@ -1,15 +1,15 @@
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { InvalidPayloadException } from '../exception/userauth.exception';
 import User from '../../authorization/entity/user.entity';
 import { GoogleUserSchema } from '../validation/user.auth.schema.validation';
-import UserService from '../../authorization/service/user.service';
+import { UserServiceInterface } from '../../authorization/service/user.service.interface';
 import { AuthenticationHelper } from '../authentication.helper';
 import { GoogleLoginUser } from '../passport/googleStrategy';
 
 @Injectable()
 export class GoogleAuthService {
   constructor(
-    private userService: UserService,
+    @Inject(UserServiceInterface) private userService: UserServiceInterface,
     private authenticationHelper: AuthenticationHelper,
   ) {}
   private async validateInput(

src/authentication/service/otp.auth.service.ts

@@ -1,7 +1,7 @@
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import User from '../../authorization/entity/user.entity';
 import { UserNotFoundException } from '../../authorization/exception/user.exception';
-import UserService from '../../authorization/service/user.service';
+import { UserServiceInterface } from '../../authorization/service/user.service.interface';
 import {
   Status,
   TokenResponse,
@@ -20,7 +20,7 @@ import { TokenService } from './token.service';
 @Injectable()
 export default class OTPAuthService implements Authenticatable {
   constructor(
-    private userService: UserService,
+    @Inject(UserServiceInterface) private userService: UserServiceInterface,
     private tokenService: TokenService,
     private otpService: OTPVerifiable,
   ) {}

src/authentication/service/password.auth.service.ts

@@ -1,12 +1,12 @@
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import { DataSource } from 'typeorm';
 import User from '../../authorization/entity/user.entity';
 import {
   PasswordAlreadySetException,
   UserNotFoundException,
 } from '../../authorization/exception/user.exception';
-import UserService from '../../authorization/service/user.service';
+import { UserServiceInterface } from '../../authorization/service/user.service.interface';
 import {
   InviteTokenResponse,
   Status,
@@ -29,7 +29,7 @@ import { TokenService } from './token.service';
 @Injectable()
 export default class PasswordAuthService implements Authenticatable {
   constructor(
-    private userService: UserService,
+    @Inject(UserServiceInterface) private userService: UserServiceInterface,
     private tokenService: TokenService,
     private authenticationHelper: AuthenticationHelper,
     private dataSource: DataSource,

src/authentication/service/token.service.ts

@@ -1,11 +1,11 @@
-import { Injectable, UnauthorizedException } from '@nestjs/common';
+import { Inject, Injectable, UnauthorizedException } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
 import User from '../../authorization/entity/user.entity';
 import {
   InviteTokenAlreadyRevokedException,
   PasswordAlreadySetException,
 } from '../../authorization/exception/user.exception';
-import UserService from '../../authorization/service/user.service';
+import { UserServiceInterface } from '../../authorization/service/user.service.interface';
 import {
   InviteTokenResponse,
   TokenResponse,
@@ -15,7 +15,7 @@ import { AuthenticationHelper } from '../authentication.helper';
 @Injectable()
 export class TokenService {
   constructor(
-    private userService: UserService,
+    @Inject(UserServiceInterface) private userService: UserServiceInterface,
     private authenticationHelper: AuthenticationHelper,
     private configService: ConfigService,
   ) {}

src/authorization/authorization.guard.ts

@@ -1,11 +1,19 @@
-import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
+import {
+  CanActivate,
+  ExecutionContext,
+  Inject,
+  Injectable,
+} from '@nestjs/common';
 import { Reflector } from '@nestjs/core';
 import { GqlExecutionContext } from '@nestjs/graphql';
-import UserService from './service/user.service';
+import { UserServiceInterface } from './service/user.service.interface';
 
 @Injectable()
 export class AuthorizationGaurd implements CanActivate {
-  constructor(private userService: UserService, private reflector: Reflector) {}
+  constructor(
+    @Inject(UserServiceInterface) private userService: UserServiceInterface,
+    private reflector: Reflector,
+  ) {}
   public async canActivate(context: ExecutionContext): Promise<boolean> {
     const ctx = GqlExecutionContext.create(context).getContext();
     const permissionsRequired = this.reflector.get<string[]>(

src/authorization/authorization.module.ts

@@ -46,8 +46,10 @@ import { RoleServiceInterface } from './service/role.service.interface';
 import RoleCacheService from './service/rolecache.service';
 import { RoleCacheServiceInterface } from './service/rolecache.service.interface';
 import SearchService from './service/search.service';
-import UserService from './service/user.service';
-import UserCacheService from './service/usercache.service';
+import { UserService } from './service/user.service';
+import { UserServiceInterface } from './service/user.service.interface';
+import { UserCacheService } from './service/usercache.service';
+import { UserCacheServiceInterface } from './service/usercache.service.interface';
 
 @Module({
   imports: [
@@ -69,11 +71,9 @@ import UserCacheService from './service/usercache.service';
   providers: [
     GroupResolver,
     PermissionResolver,
-    UserService,
     UserResolver,
     EntityResolver,
     RedisCacheService,
-    UserCacheService,
     AuthenticationHelper,
     ConfigService,
     RoleResolver,
@@ -117,7 +117,20 @@ import UserCacheService from './service/usercache.service';
       provide: GroupCacheServiceInterface,
       useClass: GroupCacheService,
     },
+    {
+      provide: UserServiceInterface,
+      useClass: UserService,
+    },
+    {
+      provide: UserCacheServiceInterface,
+      useClass: UserCacheService,
+    },
+  ],
+  exports: [
+    {
+      provide: UserServiceInterface,
+      useClass: UserService,
+    },
   ],
-  exports: [UserService],
 })
 export class AuthorizationModule {}

src/authorization/resolver/user.resolver.ts

@@ -1,4 +1,4 @@
-import { UseGuards } from '@nestjs/common';
+import { Inject, UseGuards } from '@nestjs/common';
 import { ParseUUIDPipe } from '@nestjs/common/pipes';
 import {
   Args,
@@ -24,12 +24,14 @@ import {
 import ValidationPipe from '../../validation/validation.pipe';
 import { PermissionsType } from '../constants/authorization.constants';
 import { Permissions } from '../permissions.decorator';
-import UserService from '../service/user.service';
+import { UserServiceInterface } from '../service/user.service.interface';
 import * as UserSchema from '../validation/user.validation.schema';
 
 @Resolver('User')
 export class UserResolver {
-  constructor(private userService: UserService) {}
+  constructor(
+    @Inject(UserServiceInterface) private userService: UserServiceInterface,
+  ) {}
 
   @Permissions(PermissionsType.ViewUser)
   @Query()

src/authorization/service/group.service.ts

@@ -32,7 +32,7 @@ import { UserGroupRepository } from '../repository/userGroup.repository';
 import { GroupServiceInterface } from './group.service.interface';
 import { GroupCacheServiceInterface } from './groupcache.service.interface';
 import SearchService from './search.service';
-import UserCacheService from './usercache.service';
+import { UserCacheServiceInterface } from './usercache.service.interface';
 
 @Injectable()
 export class GroupService implements GroupServiceInterface {
@@ -47,7 +47,8 @@ export class GroupService implements GroupServiceInterface {
     private dataSource: DataSource,
     @Inject(GroupCacheServiceInterface)
     private groupCacheService: GroupCacheServiceInterface,
-    private userCacheService: UserCacheService,
+    @Inject(UserCacheServiceInterface)
+    private userCacheService: UserCacheServiceInterface,
     private searchService: SearchService,
   ) {}
 

src/authorization/service/user.service.interface.ts

@@ -0,0 +1,66 @@
+import User from '../entity/user.entity';
+import {
+  OperationType,
+  UpdateUserGroupInput,
+  UpdateUserInput,
+  UpdateUserPermissionInput,
+  UserInputFilter,
+} from '../../schema/graphql.schema';
+import Group from '../entity/group.entity';
+import Permission from '../entity/permission.entity';
+
+export interface UserServiceInterface {
+  getAllUsers(input?: UserInputFilter): Promise<[User[], number]>;
+
+  getUserById(id: string): Promise<User>;
+
+  createUser(user: User): Promise<User>;
+
+  updateUser(id: string, user: UpdateUserInput): Promise<User>;
+
+  updateUserGroups(id: string, user: UpdateUserGroupInput): Promise<Group[]>;
+
+  getUserGroups(id: string): Promise<Group[]>;
+
+  updateUserPermissions(
+    id: string,
+    request: UpdateUserPermissionInput,
+  ): Promise<Permission[]>;
+
+  getUserPermissions(id: string): Promise<Permission[]>;
+
+  deleteUser(id: string): Promise<User>;
+
+  getAllUserpermissionIds(id: string): Promise<Set<string>>;
+
+  permissionsOfUser(id: string): Promise<Permission[]>;
+
+  verifyUserPermissions(
+    id: string,
+    permissionsToVerify: string[],
+    operation?: OperationType,
+  ): Promise<boolean>;
+
+  verifyDuplicateUser(
+    email?: string | undefined,
+    phone?: string | undefined,
+  ): Promise<{ existingUserDetails?: User | null; duplicate: string }>;
+
+  getUserDetailsByEmailOrPhone(
+    email?: string | undefined,
+    phone?: string | undefined,
+  ): Promise<any>;
+
+  getUserDetailsByUsername(
+    email?: string | undefined,
+    phone?: string | undefined,
+  ): Promise<User | null>;
+
+  updateField(id: string, field: string, value: any): Promise<User>;
+
+  getActiveUserByPhoneNumber(phone: string): Promise<User | null>;
+
+  setOtpSecret(user: User, twoFASecret: string): Promise<void>;
+}
+
+export const UserServiceInterface = Symbol('UserServiceInterface');