feat: add GraphQL to fetch notifications (#68)

apps/api/.env.example

@@ -2,6 +2,9 @@
 SERVER_PORT=
 SERVER_API_KEY= # Add your API Key
 
+# Node env
+NODE_ENV= # Use "development" for graphql playground to work
+
 # Database configuration
 DB_TYPE=
 DB_HOST=

apps/api/.gitignore

@@ -35,4 +35,5 @@ lerna-debug.log*
 !.vscode/extensions.json
 
 # Environment variable file
-.env
+.env
+.schema.gpl

apps/api/package.json

@@ -28,18 +28,23 @@
     "database:reset": "ts-node src/database/database-reset.ts"
   },
   "dependencies": {
+    "@apollo/server": "^4.9.5",
+    "@nestjs/apollo": "^12.0.11",
     "@nestjs/axios": "^3.0.0",
     "@nestjs/bull": "^10.0.1",
     "@nestjs/common": "^10.0.0",
     "@nestjs/config": "^3.0.0",
     "@nestjs/core": "^10.0.0",
+    "@nestjs/graphql": "^12.0.11",
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/schedule": "^3.0.3",
     "@nestjs/typeorm": "^10.0.0",
     "axios": "^1.5.1",
     "bull": "^4.11.3",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
+    "graphql": "^16.8.1",
+    "graphql-type-json": "^0.3.2",
     "mailgun.js": "^9.2.1",
     "mysql2": "^3.6.0",
     "nest-winston": "^1.9.4",

apps/api/src/app.module.ts

@@ -6,7 +6,11 @@ import { ScheduleModule } from '@nestjs/schedule';
 import { NotificationsModule } from './modules/notifications/notifications.module';
 import { BullModule } from '@nestjs/bull';
 import { DatabaseModule } from './database/database.module';
+import { GraphQLModule } from '@nestjs/graphql';
+import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
+import { join } from 'path';
 
+const configService = new ConfigService();
 @Module({
   imports: [
     ConfigModule.forRoot(),
@@ -23,6 +27,12 @@ import { DatabaseModule } from './database/database.module';
     }),
     ScheduleModule.forRoot(),
     NotificationsModule.register(),
+    GraphQLModule.forRoot<ApolloDriverConfig>({
+      driver: ApolloDriver,
+      autoSchemaFile: join(process.cwd(), 'src/schema.gpl'),
+      sortSchema: true,
+      playground: configService.getOrThrow('NODE_ENV') === 'development',
+    }),
   ],
   controllers: [AppController],
   providers: [AppService],

apps/api/src/common/guards/api-key/api-key.guard.ts

@@ -1,5 +1,6 @@
 import { CanActivate, ExecutionContext, Injectable, UnauthorizedException } from '@nestjs/common';
 import { ConfigService } from '@nestjs/config';
+import { GqlExecutionContext } from '@nestjs/graphql';
 import { Observable } from 'rxjs';
 
 const configService = new ConfigService();
@@ -9,7 +10,19 @@ export class ApiKeyGuard implements CanActivate {
     const apiKey = configService.getOrThrow<string>('SERVER_API_KEY');
     const request = context.switchToHttp().getRequest();
 
-    const authHeader = request.headers['authorization'];
+    // Get auth header incase of http request
+    if (request && request.headers) {
+      const authHeader = request.headers['authorization'];
+
+      if (authHeader && authHeader === `Bearer ${apiKey}`) {
+        return true;
+      }
+    }
+
+    // Get quth header incase of graphql request
+    const ctx = GqlExecutionContext.create(context);
+    const req = ctx.getContext().req;
+    const authHeader = req.headers.authorization;
 
     if (authHeader && authHeader === `Bearer ${apiKey}`) {
       return true;

apps/api/src/common/http-exception.filter.ts

@@ -17,6 +17,12 @@ export class HttpExceptionFilter implements ExceptionFilter {
     const response = ctx.getResponse<Response>();
     const status = exception.getStatus();
     const data = exception.getResponse() as HttpExceptionBody;
-    response.status(status).json(this.jsend.fail(data.message));
+
+    try {
+      response.status(status).json(this.jsend.fail(data.message));
+    } catch (error) {
+      // throw the original exception incase response.status doesn't workout
+      throw exception;
+    }
   }
 }

apps/api/src/modules/notifications/entities/notification.entity.ts

@@ -8,18 +8,24 @@ import {
 import { IsEnum, IsOptional, IsObject } from 'class-validator';
 import { Status } from 'src/common/constants/database';
 import { ChannelType, DeliveryStatus } from 'src/common/constants/notifications';
+import { Field, ObjectType } from '@nestjs/graphql';
+import { GraphQLJSONObject } from 'graphql-type-json';
 
 @Entity({ name: 'notify_notifications' })
+@ObjectType()
 export class Notification {
   @PrimaryGeneratedColumn()
+  @Field()
   id: number;
 
   @Column({ name: 'channel_type', type: 'tinyint', width: 1 })
   @IsEnum(ChannelType)
+  @Field()
   channelType: number;
 
   @Column({ type: 'json' })
   @IsObject()
+  @Field(() => GraphQLJSONObject)
   data: Record<string, unknown>;
 
   @Column({
@@ -29,23 +35,28 @@ export class Notification {
     default: DeliveryStatus.PENDING,
   })
   @IsEnum(DeliveryStatus)
+  @Field()
   deliveryStatus: number;
 
   @Column({ type: 'json', nullable: true })
   @IsObject()
   @IsOptional()
+  @Field(() => GraphQLJSONObject, { nullable: true })
   result: Record<string, unknown>;
 
   @CreateDateColumn({ name: 'created_on' })
+  @Field()
   createdOn: Date;
 
   @UpdateDateColumn({ name: 'updated_on' })
   updatedOn: Date;
 
   @Column({ name: 'created_by' })
+  @Field()
   createdBy: string;
 
   @Column({ name: 'updated_by' })
+  @Field()
   updatedBy: string;
 
   @Column({
@@ -54,6 +65,7 @@ export class Notification {
     default: Status.ACTIVE,
   })
   @IsEnum(Status)
+  @Field()
   status: number;
 
   constructor(notification: Partial<Notification>) {

apps/api/src/modules/notifications/notifications.module.ts

@@ -17,6 +17,7 @@ import { MailgunModule } from '../providers/mailgun/mailgun.module';
 import { SmtpModule } from '../providers/smtp/smtp.module';
 import { Wa360dialogModule } from '../providers/wa360dialog/wa360dialog.module';
 import { ScheduleService } from './schedule/schedule.service';
+import { NotificationsResolver } from './notifications.resolver';
 
 @Module({})
 export class NotificationsModule {
@@ -68,6 +69,7 @@ export class NotificationsModule {
         ConfigService,
         JsendFormatter,
         Logger,
+        NotificationsResolver,
       ],
       exports: [NotificationsService],
       controllers: [NotificationsController],

apps/api/src/modules/notifications/notifications.resolver.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { NotificationsResolver } from './notifications.resolver';
+
+describe('NotificationsResolver', () => {
+  let resolver: NotificationsResolver;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [NotificationsResolver],
+    }).compile();
+
+    resolver = module.get<NotificationsResolver>(NotificationsResolver);
+  });
+
+  it('should be defined', () => {
+    expect(resolver).toBeDefined();
+  });
+});

apps/api/src/modules/notifications/notifications.resolver.ts

@@ -0,0 +1,16 @@
+import { Query, Resolver } from '@nestjs/graphql';
+import { NotificationsService } from './notifications.service';
+import { Notification } from './entities/notification.entity';
+import { ApiKeyGuard } from 'src/common/guards/api-key/api-key.guard';
+import { UseGuards } from '@nestjs/common';
+
+@Resolver(() => Notification)
+@UseGuards(ApiKeyGuard)
+export class NotificationsResolver {
+  constructor(private readonly notificationsService: NotificationsService) {}
+
+  @Query(() => [Notification], { name: 'notifications' })
+  async findAll(): Promise<Notification[]> {
+    return this.notificationsService.getAllNotifications();
+  }
+}

apps/api/src/modules/notifications/notifications.service.ts

@@ -97,4 +97,13 @@ export class NotificationsService {
       },
     });
   }
+
+  getAllNotifications(): Promise<Notification[]> {
+    this.logger.log('Getting all active notifications');
+    return this.notificationRepository.find({
+      where: {
+        status: Status.ACTIVE,
+      },
+    });
+  }
 }