feat(backend): introduce usage module

Author: Skona27

apps/backend/src/api-key/api-key.module.ts

@@ -9,6 +9,7 @@ import { ApiKeyService } from './api-key.service';
 @Module({
   controllers: [ApiKeyController],
   providers: [ApiKeyService],
+  exports: [ApiKeyService],
   imports: [LoggerModule, TypeOrmModule.forFeature([ApiKey])],
 })
 export class ApiKeyModule {}

apps/backend/src/api-key/api-key.service.ts

@@ -77,6 +77,25 @@ export class ApiKeyService {
     }
   }
 
+  public async useApiKey(apiKeyValue: string): Promise<ApiKey> {
+    try {
+      const apiKey = await this.apiKeyRepository.findOneOrFail({
+        where: {
+          value: apiKeyValue,
+        },
+      });
+
+      apiKey.lastUsed = new Date();
+
+      await this.apiKeyRepository.save(apiKey);
+
+      return apiKey;
+    } catch (error) {
+      this.loggerService.log(`Failed to fetch owner of API key. ${error}`);
+      throw new NotFoundApiKeyError();
+    }
+  }
+
   private async findApiKeyById(apiKeyId: string): Promise<ApiKey> {
     return await this.apiKeyRepository.findOne({ id: apiKeyId });
   }

apps/backend/src/app/app.controller.spec.ts

@@ -4,10 +4,13 @@ import { AppController } from './app.controller';
 import { AppService } from './app.service';
 import { LoggerService } from '../logger/logger.service';
 import { LoggerServiceMock } from '../logger/logger.service.mock';
+import { UsageService } from '../usage/usage.service';
 
 describe('AppController', () => {
   let appController: AppController;
 
+  const usageServiceMock = {};
+
   beforeEach(async () => {
     const app: TestingModule = await Test.createTestingModule({
       controllers: [AppController],
@@ -17,6 +20,10 @@ describe('AppController', () => {
           provide: LoggerService,
           useValue: LoggerServiceMock,
         },
+        {
+          provide: UsageService,
+          useValue: usageServiceMock,
+        },
       ],
     }).compile();
 

apps/backend/src/app/app.controller.ts

@@ -1,5 +1,6 @@
 import { Controller, Get, HttpStatus } from '@nestjs/common';
 import { ApiTags, ApiResponse } from '@nestjs/swagger';
+import { TrackUsage } from '../usage/track-usage.decorator';
 import { AppService } from './app.service';
 
 @Controller()
@@ -12,6 +13,7 @@ export class AppController {
     status: HttpStatus.OK,
     description: 'Application is running',
   })
+  @TrackUsage()
   getHello(): string {
     return this.appService.getHello();
   }

apps/backend/src/app/app.module.ts

@@ -13,6 +13,7 @@ import { LoggerModule } from '../logger/logger.module';
 import { AuthModule } from '../auth/auth.module';
 import { ApiKeyModule } from '../api-key/api-key.module';
 import { CreditModule } from '../credit/credit.module';
+import { UsageModule } from '../usage/usage.module';
 
 @Module({
   imports: [
@@ -42,6 +43,7 @@ import { CreditModule } from '../credit/credit.module';
     AuthModule,
     ApiKeyModule,
     CreditModule,
+    UsageModule,
   ],
   controllers: [AppController],
   providers: [AppService],

apps/backend/src/credit/credit.module.ts

@@ -10,6 +10,7 @@ import { AppConfigModule } from '../config/config.module';
 @Module({
   providers: [CreditService],
   controllers: [CreditController],
+  exports: [CreditService],
   imports: [TypeOrmModule.forFeature([Credit]), LoggerModule, AppConfigModule],
 })
 export class CreditModule {}

apps/backend/src/credit/credit.service.ts

@@ -15,6 +15,7 @@ import { CreditDuration } from './interface/credit-duration.interface';
 import { ReadCreditError } from './error/read-credit.error';
 import { CreateCreditError } from './error/create-credit.error';
 import { IncrementCreditError } from './error/increment-credit.error';
+import { ReadActiveCreditError } from './error/read-active-credit.error';
 
 @Injectable()
 export class CreditService {
@@ -65,10 +66,25 @@ export class CreditService {
     }
   }
 
-  public async incrementActiveCreditUsage(user: User): Promise<void> {
+  public async getActiveCredit(user: User): Promise<Credit> {
     try {
-      const credit = await this.getActiveCredit(user);
+      const presentDate = new Date();
 
+      return await this.creditRepository.findOneOrFail({
+        where: {
+          user,
+          fromDate: LessThan(presentDate),
+          toDate: MoreThan(presentDate),
+        },
+      });
+    } catch (error) {
+      this.loggerService.log(`No active credit is available. ${error}`);
+      throw new ReadActiveCreditError(error);
+    }
+  }
+
+  public async incrementCreditUsage(credit: Credit): Promise<void> {
+    try {
       this.checkLimit(credit);
       credit.incrementUsage();
 
@@ -85,18 +101,6 @@ export class CreditService {
     }
   }
 
-  private async getActiveCredit(user: User): Promise<Credit> {
-    const presentDate = new Date();
-
-    return await this.creditRepository.findOneOrFail({
-      where: {
-        user,
-        fromDate: LessThan(presentDate),
-        toDate: MoreThan(presentDate),
-      },
-    });
-  }
-
   private calculateCreditDuration(duration: CreditDuration): {
     fromDate: Date;
     toDate: Date;

apps/backend/src/credit/error/read-active-credit.error.ts

@@ -0,0 +1,5 @@
+export class ReadActiveCreditError extends Error {
+  constructor(error) {
+    super(`No active credit is available. ${error}`);
+  }
+}

apps/backend/src/usage/error/invalid-api-key.error.ts

@@ -0,0 +1,5 @@
+export class InvalidApiKeyError extends Error {
+  constructor(error) {
+    super(`API Key is invalid. ${error}`);
+  }
+}

apps/backend/src/usage/error/no-active-credit.error.ts

@@ -0,0 +1,5 @@
+export class NoActiveCreditError extends Error {
+  constructor(error) {
+    super(`No active credit available. ${error}`);
+  }
+}