#429: Implement GET /subscription_user Endpoint (#580)

* refactor: add GetSubscriptionUserDto and getUserSubscriptions endpoint [WIP][Refactor][Tests]

* refactor: remove userId property from GetSubscriptionUserDto, fixed overly nested response.

* test: add getUserSubscriptions service tests

* refactor: add try catch to getSubscriptions service.

* chore: abstract serialization into utils

* Remove GetSubscriptionUsersDto

* Update get-subscription-user.dto.ts

---------

Co-authored-by: eleanorreem <[email protected]>

Author: Tim-Quattrochi

src/subscription-user/dto/get-subscription-user.dto.ts

@@ -0,0 +1,39 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Expose } from 'class-transformer';
+import { IsDefined, IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
+@Expose()
+export class GetSubscriptionUserDto {
+  @ApiProperty()
+  @IsString()
+  @IsDefined()
+  @IsNotEmpty()
+  id: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsDefined()
+  @IsNotEmpty()
+  subscriptionId: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsDefined()
+  @IsNotEmpty()
+  @Expose()
+  subscriptionName: string;
+
+  @ApiProperty()
+  @IsString()
+  @IsDefined()
+  @IsNotEmpty()
+  subscriptionInfo: string;
+
+  @ApiProperty()
+  @IsDefined()
+  createdAt: Date;
+
+  @ApiProperty()
+  @IsOptional()
+  cancelledAt: Date | null;
+}

src/subscription-user/subscription-user.controller.ts

@@ -1,10 +1,12 @@
-import { Body, Controller, Param, Patch, Post, Req, UseGuards } from '@nestjs/common';
+import { Body, Controller, Get, Param, Patch, Post, Req, UseGuards } from '@nestjs/common';
 import { ApiBearerAuth, ApiOperation, ApiParam, ApiTags } from '@nestjs/swagger';
 import { Request } from 'express';
 import { UserEntity } from 'src/entities/user.entity';
+import { mapToSubscriptionUserDtos } from 'src/utils/serialize';
 import { FirebaseAuthGuard } from '../firebase/firebase-auth.guard';
 import { ControllerDecorator } from '../utils/controller.decorator';
 import { CreateSubscriptionUserDto } from './dto/create-subscription-user.dto';
+import { GetSubscriptionUserDto } from './dto/get-subscription-user.dto';
 import { UpdateSubscriptionUserDto } from './dto/update-subscription-user.dto';
 import { ISubscriptionUser } from './subscription-user.interface';
 import { SubscriptionUserService } from './subscription-user.service';
@@ -15,6 +17,23 @@ import { SubscriptionUserService } from './subscription-user.service';
 export class SubscriptionUserController {
   constructor(private readonly subscriptionUserService: SubscriptionUserService) {}
 
+  @Get('/')
+  @ApiBearerAuth('access-token')
+  @ApiOperation({
+    description: 'Returns all the subscriptions of the authenticated user.',
+  })
+  @UseGuards(FirebaseAuthGuard)
+  async getUserSubscriptions(@Req() req: Request): Promise<GetSubscriptionUserDto[]> {
+    const user = req['userEntity'] as UserEntity;
+    const userId = user.id;
+
+    const userSubscriptions = await this.subscriptionUserService.getSubscriptions(userId);
+
+    const subscriptionDtos = mapToSubscriptionUserDtos(userSubscriptions);
+
+    return subscriptionDtos;
+  }
+
   @Post('/whatsapp')
   @ApiBearerAuth('access-token')
   @ApiOperation({

src/subscription-user/subscription-user.service.spec.ts

@@ -61,4 +61,24 @@ describe('SubscriptionUserService', () => {
       ]);
     });
   });
+
+  describe('getUserSubscriptions', () => {
+    it('should return a list of subscriptions for the given userId', async () => {
+      const result = await service.getSubscriptions(mockUserEntity.id);
+
+      expect(result).toMatchObject([mockSubscriptionUserEntity]);
+    });
+
+    it('should return an empty array if the user has no subscriptions', async () => {
+      mockedSubscriptionUserRepository.find.mockResolvedValueOnce([]);
+
+      const result = await service.getSubscriptions(mockUserEntity.id);
+
+      expect(result).toEqual([]);
+      expect(mockedSubscriptionUserRepository.find).toHaveBeenCalledWith({
+        where: { userId: mockUserEntity.id },
+        relations: ['subscription'],
+      });
+    });
+  });
 });

src/subscription-user/subscription-user.service.ts

@@ -153,4 +153,19 @@ export class SubscriptionUserService {
       );
     }
   }
+
+  async getSubscriptions(userId: string): Promise<SubscriptionUserEntity[]> {
+    try {
+      const userSubscriptions = await this.subscriptionUserRepository.find({
+        where: { userId: userId },
+        relations: ['subscription'],
+      });
+
+      this.logger.log(`User ${userId} has ${userSubscriptions.length} subscriptions`);
+
+      return userSubscriptions;
+    } catch (err) {
+      throw new HttpException(`getSubscriptions error - ${err}`, HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+  }
 }

src/utils/serialize.ts

@@ -2,6 +2,7 @@ import { PartnerAdminEntity } from 'src/entities/partner-admin.entity';
 import { PartnerEntity } from 'src/entities/partner.entity';
 import { IPartnerFeature } from 'src/partner-feature/partner-feature.interface';
 import { IPartner } from 'src/partner/partner.interface';
+import { GetSubscriptionUserDto } from 'src/subscription-user/dto/get-subscription-user.dto';
 import { CourseUserEntity } from '../entities/course-user.entity';
 import { PartnerAccessEntity } from '../entities/partner-access.entity';
 import { SubscriptionUserEntity } from '../entities/subscription-user.entity';
@@ -203,3 +204,19 @@ export const formatSubscriptionObject = (
     cancelledAt: userSubscription.cancelledAt,
   };
 };
+
+export const mapToSubscriptionUserDtos = (
+  userSubscriptions: SubscriptionUserEntity[],
+): GetSubscriptionUserDto[] => {
+  return userSubscriptions.map((subscriptionUser) => {
+    const dto = new GetSubscriptionUserDto();
+    dto.id = subscriptionUser.id;
+    dto.subscriptionId = subscriptionUser.subscription.id;
+    dto.subscriptionName = subscriptionUser.subscription.name;
+    dto.subscriptionInfo = subscriptionUser.subscription.info;
+    dto.createdAt = subscriptionUser.createdAt;
+    dto.cancelledAt = subscriptionUser.cancelledAt;
+    dto.subscriptionInfo = subscriptionUser.subscriptionInfo;
+    return dto;
+  });
+};