refactor(accounts): implement GetAccountHandler

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

src/subdomains/accounts/accounts.module.mts

@@ -8,6 +8,7 @@ import Account from '#accounts/entities/account.entity'
 import JwtOptionsFactory from '#accounts/factories/jwt-options.factory'
 import CreateAccountHandler from '#accounts/handlers/create-account.handler'
 import DeleteAccountHandler from '#accounts/handlers/delete-account.handler'
+import GetAccountHandler from '#accounts/handlers/get-account.handler'
 import AccountsRepository from '#accounts/providers/accounts.repository'
 import AuthService from '#accounts/services/auth.service'
 import JwtStrategy from '#accounts/strategies/jwt.strategy'
@@ -31,6 +32,7 @@ import { JwtModule } from '@nestjs/jwt'
     AuthService,
     CreateAccountHandler,
     DeleteAccountHandler,
+    GetAccountHandler,
     JwtOptionsFactory,
     JwtStrategy
   ]

src/subdomains/accounts/controllers/__tests__/accounts.controller.spec.mts

@@ -11,6 +11,7 @@ import Account from '#accounts/entities/account.entity'
 import JwtOptionsFactory from '#accounts/factories/jwt-options.factory'
 import CreateAccountHandler from '#accounts/handlers/create-account.handler'
 import DeleteAccountHandler from '#accounts/handlers/delete-account.handler'
+import GetAccountHandler from '#accounts/handlers/get-account.handler'
 import AccountsRepository from '#accounts/providers/accounts.repository'
 import AuthService from '#accounts/services/auth.service'
 import DependenciesModule from '#modules/dependencies.module'
@@ -37,7 +38,8 @@ describe('unit:accounts/controllers/AccountsController', () => {
         AccountsRepository,
         AuthService,
         CreateAccountHandler,
-        DeleteAccountHandler
+        DeleteAccountHandler,
+        GetAccountHandler
       ]
     }).compile()
 

src/subdomains/accounts/guards/existing-account.guard.mts

@@ -3,15 +3,13 @@
  * @module sneusers/accounts/guards/ExistingAccount
  */
 
-import AccountsRepository from '#accounts/providers/accounts.repository'
-import {
-  MissingAccountException
-} from '@flex-development/sneusers/accounts/errors'
+import GetAccountQuery from '#accounts/queries/get-account.query'
 import {
   Injectable,
   type CanActivate,
   type ExecutionContext
 } from '@nestjs/common'
+import { QueryBus } from '@nestjs/cqrs'
 import type { FastifyRequest } from 'fastify'
 
 /**
@@ -25,10 +23,10 @@ class ExistingAccountGuard implements CanActivate {
   /**
    * Create a new existing account guard.
    *
-   * @param {AccountsRepository} accounts
-   *  User accounts repository
+   * @param {QueryBus} queries
+   *  The query bus
    */
-  constructor(protected accounts: AccountsRepository) {}
+  constructor(protected queries: QueryBus) {}
 
   /**
    * Check `request.params.uid` references an existing account.
@@ -43,8 +41,6 @@ class ExistingAccountGuard implements CanActivate {
    *  Object containing details about the current request pipeline
    * @return {Promise<true>}
    *  Whether the current request is allowed to proceed
-   * @throws {MissingAccountException}
-   *  If an account is not found
    */
   public async canActivate(context: ExecutionContext): Promise<true> {
     /**
@@ -54,16 +50,9 @@ class ExistingAccountGuard implements CanActivate {
      */
     const req: FastifyRequest = context.switchToHttp().getRequest()
 
-    /**
-     * Unique account id.
-     *
-     * @const {string} uid
-     */
-    const uid: string = String(req.params.uid)
-
-    if (!await this.accounts.findById(uid)) {
-      throw new MissingAccountException(uid)
-    }
+    // check for existing user account.
+    // the query handler will throw if an account is not found.
+    await this.queries.execute(new GetAccountQuery(String(req.params.uid)))
 
     return true
   }

src/subdomains/accounts/handlers/__tests__/get-account.handler.spec.mts

@@ -0,0 +1,67 @@
+/**
+ * @file Unit Tests - GetAccountHandler
+ * @module sneusers/accounts/handlers/tests/unit/GetAccount
+ */
+
+import Account from '#accounts/entities/account.entity'
+import MissingAccountException from '#accounts/errors/missing-account.exception'
+import TestSubject from '#accounts/handlers/get-account.handler'
+import AccountsRepository from '#accounts/providers/accounts.repository'
+import GetAccountQuery from '#accounts/queries/get-account.query'
+import AccountFactory from '#tests/utils/account.factory'
+import Seeder from '#tests/utils/seeder'
+import type { AccountDocument } from '@flex-development/sneusers/accounts'
+import DatabaseModule from '@flex-development/sneusers/database'
+import { Test, type TestingModule } from '@nestjs/testing'
+import { ObjectId } from 'bson'
+
+describe('unit:accounts/handlers/GetAccountHandler', () => {
+  let ref: TestingModule
+  let seeder: Seeder<AccountDocument>
+  let subject: TestSubject
+
+  afterAll(async () => {
+    await seeder.down()
+  })
+
+  beforeAll(async () => {
+    ref = await Test.createTestingModule({
+      imports: [DatabaseModule.forFeature(Account)],
+      providers: [AccountsRepository, TestSubject]
+    }).compile()
+
+    seeder = new Seeder(new AccountFactory(), ref.get(AccountsRepository))
+    subject = ref.get(TestSubject)
+
+    await seeder.up(1)
+  })
+
+  describe('#execute', () => {
+    it('should return user account referenced by `query.uid`', async () => {
+      // Arrange
+      const account: Account = new Account(seeder.seeds[0]!)
+      const query: GetAccountQuery = new GetAccountQuery(account.uid)
+
+      // Act
+      const result = await subject.execute(query)
+
+      // Expect
+      expect(result).to.be.instanceof(Account).and.eql(account)
+    })
+
+    it('should throw if an account is not found', async () => {
+      // Arrange
+      let error!: MissingAccountException
+
+      // Act
+      try {
+        await subject.execute(new GetAccountQuery(new ObjectId()))
+      } catch (e: unknown) {
+        error = e as typeof error
+      }
+
+      // Expect
+      expect(error).to.be.instanceof(MissingAccountException)
+    })
+  })
+})

src/subdomains/accounts/handlers/get-account.handler.mts

@@ -0,0 +1,59 @@
+/**
+ * @file Handlers - GetAccountHandler
+ * @module sneusers/accounts/handlers/GetAccount
+ */
+
+import Account from '#accounts/entities/account.entity'
+import MissingAccountException from '#accounts/errors/missing-account.exception'
+import AccountsRepository from '#accounts/providers/accounts.repository'
+import GetAccountQuery from '#accounts/queries/get-account.query'
+import { QueryHandler, type IQueryHandler } from '@nestjs/cqrs'
+
+/**
+ * Account query handler.
+ *
+ * @class
+ * @implements {IQueryHandler<GetAccountQuery>}
+ */
+@QueryHandler(GetAccountQuery)
+class GetAccountHandler implements IQueryHandler<GetAccountQuery> {
+  /**
+   * Create a new account query handler.
+   *
+   * @param {AccountsRepository} accounts
+   *  User accounts repository
+   */
+  constructor(protected accounts: AccountsRepository) {}
+
+  /**
+   * Get a user account by id.
+   *
+   * Fails if an account is not found.
+   *
+   * @public
+   * @instance
+   * @async
+   *
+   * @param {GetAccountQuery} query
+   *  The query to execute
+   * @return {Promise<Account>}
+   *  The user account referenced by {@linkcode query.uid}
+   * @throws {MissingAccountException}
+   *  If an account is not found
+   */
+  public async execute(query: GetAccountQuery): Promise<Account> {
+    /**
+     * The user account referenced by {@linkcode query.uid}.
+     *
+     * @const {Account | null} account
+     */
+    const account: Account | null = await this.accounts.findById(query.uid)
+
+    // throw on missing account.
+    if (!account) throw new MissingAccountException(query.uid)
+
+    return account
+  }
+}
+
+export default GetAccountHandler

src/subdomains/accounts/queries/get-account.query.mts

@@ -0,0 +1,41 @@
+/**
+ * @file Queries - GetAccountQuery
+ * @module sneusers/accounts/queries/GetAccount
+ */
+
+import type { Account } from '@flex-development/sneusers/accounts'
+import { Query } from '@nestjs/cqrs'
+import { ApiProperty, ApiSchema } from '@nestjs/swagger'
+import type { ObjectId } from 'bson'
+
+/**
+ * Get account query.
+ *
+ * @class
+ * @extends {Query<Account>}
+ */
+@ApiSchema()
+class GetAccountQuery extends Query<Account> {
+  /**
+   * The id of the account to retrieve.
+   *
+   * @public
+   * @instance
+   * @member {string} uid
+   */
+  @ApiProperty({ description: 'id of account to retrieve', type: 'string' })
+  public uid!: string
+
+  /**
+   * Create a new account query.
+   *
+   * @param {ObjectId | string | null | undefined} [uid]
+   *  The id of the account to retrieve
+   */
+  constructor(uid?: ObjectId | string | null | undefined) {
+    super()
+    if (uid !== null && uid !== undefined) this.uid = String(uid)
+  }
+}
+
+export default GetAccountQuery