WIP - account & messages

Author: tacxou

.eslintrc.js

@@ -2,6 +2,7 @@ module.exports = {
   parser: '@typescript-eslint/parser',
   parserOptions: {
     project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
     sourceType: 'module',
   },
   plugins: ['@typescript-eslint/eslint-plugin'],
@@ -12,6 +13,7 @@ module.exports = {
   root: true,
   env: {
     node: true,
+    jest: true,
   },
   ignorePatterns: ['.eslintrc.js'],
   rules: {

.prettierrc

@@ -4,6 +4,6 @@
   "singleQuote": true,
   "trailingComma": "all",
   "arrowParens": "always",
-  "printWidth": 150,
+  "printWidth": 180,
   "bracketSpacing": true
 }

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

nest-cli.json

@@ -4,6 +4,7 @@
   "sourceRoot": "src",
   "root": "src",
   "compilerOptions": {
+    "deleteOutDir": true,
     "assets": [
       "**/*.hbs",
       "config/**/*",

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@libertech/mailrest",
+  "name": "@libertech-fr/mailrest",
   "version": "0.0.1",
   "description": "An email retrieval system with a REST API built with NestJS in NodeJS",
   "contributors": [
@@ -26,61 +26,69 @@
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "start": "nest start",
     "generate": "nest g resource",
+    "npm-check-updates": "npx npm-check-updates",
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
     "console": "node dist/console"
   },
   "dependencies": {
     "@nestjs-modules/ioredis": "^1.0.1",
-    "@nestjs-modules/mailer": "^1.8.1",
-    "@nestjs/common": "^9.0.11",
-    "@nestjs/config": "^2.2.0",
-    "@nestjs/core": "^9.0.11",
-    "@nestjs/jwt": "^9.0.0",
-    "@nestjs/mapped-types": "^1.2.0",
-    "@nestjs/passport": "^9.0.0",
-    "@nestjs/platform-express": "^9.0.11",
-    "@nestjs/testing": "^9.2.1",
+    "@nestjs-modules/mailer": "^1.9.1",
+    "@nestjs/common": "^10.1.3",
+    "@nestjs/config": "^3.0.0",
+    "@nestjs/core": "^10.1.3",
+    "@nestjs/jwt": "^10.1.0",
+    "@nestjs/mapped-types": "^2.0.2",
+    "@nestjs/passport": "^10.0.0",
+    "@nestjs/platform-express": "^10.1.3",
+    "@nestjs/testing": "^10.1.3",
     "class-transformer": "^0.5.1",
-    "class-validator": "^0.13.2",
-    "handlebars": "^4.7.7",
-    "ioredis": "^4.0.0",
-    "nest-commander": "^3.0.0",
-    "nodemailer": "^6.8.0",
+    "class-validator": "^0.14.0",
+    "handlebars": "^4.7.8",
+    "imapflow": "^1.0.136",
+    "ioredis": "^5.3.2",
+    "lru-cache": "^10.0.1",
+    "mailparser": "^3.6.5",
+    "nest-commander": "^3.11.1",
+    "nodemailer": "^6.9.4",
     "passport": "^0.6.0",
-    "passport-jwt": "^4.0.0",
+    "passport-jwt": "^4.0.1",
+    "radash": "^11.0.0",
     "reflect-metadata": "^0.1.13",
-    "rxjs": "^7.2.0",
+    "rxjs": "^7.8.1",
     "yaml": "^2.3.1"
   },
   "devDependencies": {
     "@babel/plugin-proposal-private-methods": "^7.18.6",
     "@compodoc/compodoc": "^1.1.21",
-    "@nestjs/cli": "8.2.6",
-    "@nestjs/schematics": "8.0.11",
-    "@nestjs/swagger": "^7.1.6",
-    "@types/express": "^4.17.13",
+    "@nestjs/cli": "^10.1.12",
+    "@nestjs/schematics": "10.0.2",
+    "@nestjs/swagger": "^7.1.8",
+    "@types/express": "^4.17.17",
+    "@types/imapflow": "^1.0.13",
     "@types/ioredis": "^4.28.10",
-    "@types/jest": "^29.2.4",
+    "@types/jest": "^29.5.3",
+    "@types/lru-cache": "^7.10.10",
+    "@types/mailparser": "^3.4.0",
     "@types/multer": "^1.4.7",
-    "@types/node": "^16.0.0",
+    "@types/node": "^20.5.0",
     "@types/nodemailer": "^6.4.9",
-    "@types/passport-jwt": "^3.0.6",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
-    "eslint": "^7.30.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "prettier": "^2.3.2",
-    "rimraf": "^3.0.2",
+    "@types/passport-jwt": "^3.0.9",
+    "@typescript-eslint/eslint-plugin": "^6.4.0",
+    "@typescript-eslint/parser": "^6.4.0",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "prettier": "^3.0.2",
+    "rimraf": "^5.0.1",
     "swagger-themes": "^1.2.30",
-    "ts-loader": "^9.2.3",
-    "ts-node": "^10.0.0",
-    "tsconfig-paths": "^3.10.1",
+    "ts-loader": "^9.4.4",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.2.0",
     "types-package-json": "^2.0.39",
-    "typescript": "^4.9.5",
-    "webpack": "^5.64.4"
+    "typescript": "^5.1.6",
+    "webpack": "^5.88.2"
   },
   "peerDependencies": {
     "express": "^4"

src/accounts/accounts.controller.ts

@@ -1,34 +1,78 @@
-import { Body, Controller, Delete, Get, Param, Patch, Post } from '@nestjs/common'
+import { BadRequestException, Body, Controller, Delete, Get, HttpException, Logger, Param, Patch, Post, Res, Sse } from '@nestjs/common'
+import { ModuleRef } from '@nestjs/core'
+import { Response } from 'express'
+import { AbstractController } from '~/abstract.controller'
+import { FSWatcher, watch } from 'fs'
+import { Observable } from 'rxjs'
 import { AccountsService } from './accounts.service'
-import { CreateAccountDto } from './dto/create-account.dto'
-import { UpdateAccountDto } from './dto/update-account.dto'
+import { ACCOUNTS_FILE_PATH, AccountsMetadataV1, readAccountsFile } from './accounts.setup'
 
 @Controller('accounts')
-export class AccountsController {
-  constructor(private readonly accountsService: AccountsService) {}
+export class AccountsController extends AbstractController {
+  public constructor(protected readonly moduleRef: ModuleRef, protected readonly service: AccountsService) {
+    super(moduleRef)
+  }
 
-  @Post()
-  create(@Body() createAccountDto: CreateAccountDto) {
-    return this.accountsService.create(createAccountDto)
+  @Sse('changes')
+  public async sse(@Res() res: Response): Promise<Observable<MessageEvent>> {
+    let subscriber: FSWatcher
+    res.socket.on('close', () => {
+      if (subscriber) {
+        subscriber.close()
+        Logger.debug(`Observer close connection from SSE<changes>`, this.constructor.name)
+      }
+    })
+    return new Observable((observer) => {
+      subscriber = watch(ACCOUNTS_FILE_PATH, async () => {
+        const data = await readAccountsFile()
+        observer.next({ data } as MessageEvent)
+      })
+    })
   }
 
   @Get()
-  findAll() {
-    return this.accountsService.findAll()
+  public async search(@Res() res: Response): Promise<Response> {
+    const data = await this.service.search()
+    return res.json(data)
+  }
+
+  @Post()
+  public async create(@Res() res: Response, @Body() data: AccountsMetadataV1): Promise<Response> {
+    try {
+      const account = await this.service.create(data)
+      return res.json({ account })
+    } catch (error) {
+      throw error instanceof HttpException ? error : new BadRequestException(error.message, error)
+    }
   }
 
-  @Get(':id')
-  findOne(@Param('id') id: string) {
-    return this.accountsService.findOne(+id)
+  @Get(':account([\\w-.]+)')
+  public async read(@Res() res: Response, @Param('account') id: string): Promise<Response> {
+    try {
+      const data = await this.service.read(id) // TODO: 404
+      return res.json({ data })
+    } catch (error) {
+      throw error instanceof HttpException ? error : new BadRequestException(error.message, error)
+    }
   }
 
-  @Patch(':id')
-  update(@Param('id') id: string, @Body() updateAccountDto: UpdateAccountDto) {
-    return this.accountsService.update(+id, updateAccountDto)
+  @Patch(':account([\\w-.]+)')
+  public async update(@Res() res: Response, @Param('account') id: string, @Body() data: AccountsMetadataV1): Promise<Response> {
+    try {
+      const account = await this.service.update(id, data) // TODO: 404
+      return res.json({ account })
+    } catch (error) {
+      throw error instanceof HttpException ? error : new BadRequestException(error.message, error)
+    }
   }
 
-  @Delete(':id')
-  remove(@Param('id') id: string) {
-    return this.accountsService.remove(+id)
+  @Delete(':account([\\w-.]+)')
+  public async delete(@Res() res: Response, @Param('account') id: string): Promise<Response> {
+    try {
+      const account = await this.service.delete(id) // TODO: 404
+      return res.json({ account })
+    } catch (error) {
+      throw error instanceof HttpException ? error : new BadRequestException(error.message, error)
+    }
   }
 }

src/accounts/accounts.service.ts

@@ -1,26 +1,68 @@
-import { Injectable } from '@nestjs/common'
-import { CreateAccountDto } from './dto/create-account.dto'
-import { UpdateAccountDto } from './dto/update-account.dto'
+import { Injectable, Logger, NotFoundException } from '@nestjs/common'
+import { ModuleRef } from '@nestjs/core'
+import { ImapFlow } from 'imapflow'
+import { find, pick } from 'lodash'
+import { LRUCache } from 'lru-cache'
+import { AbstractService } from '~/abstract.service'
+import { InjectImapflow } from '~/imapflow/imapflow.decorators'
+import { AccountsFileV1, AccountsMetadataV1, readAccountsFile, writeAccountsFile } from './accounts.setup'
 
 @Injectable()
-export class AccountsService {
-  create(createAccountDto: CreateAccountDto) {
-    return 'This action adds a new account'
+export class AccountsService extends AbstractService {
+  protected cache: LRUCache<string, AccountsFileV1>
+  protected logger: Logger = new Logger(AccountsService.name)
+  public constructor(protected readonly moduleRef: ModuleRef, @InjectImapflow() protected imapflow: Map<string, ImapFlow>) {
+    super({ moduleRef })
+    this.cache = new LRUCache({
+      max: 100,
+      maxSize: 1000,
+      sizeCalculation: () => 1,
+      ttl: 1000 * 60 * 5,
+    })
   }
 
-  findAll() {
-    return `This action returns all accounts`
+  public async search(): Promise<Partial<AccountsFileV1>> {
+    const data = await readAccountsFile(this.cache)
+    return pick(data, ['accounts'])
   }
 
-  findOne(id: number) {
-    return `This action returns a #${id} account`
+  public async create(data: Partial<AccountsMetadataV1>): Promise<Partial<AccountsMetadataV1>> {
+    const accounts = await readAccountsFile(this.cache)
+    const account = new AccountsMetadataV1()
+    Object.assign(account, data)
+    accounts.accounts.push(account)
+    await writeAccountsFile(accounts, this.cache)
+    return account
   }
 
-  update(id: number, updateAccountDto: UpdateAccountDto) {
-    return `This action updates a #${id} account`
+  public async read(id: string): Promise<Partial<AccountsMetadataV1>> {
+    const data = await readAccountsFile(this.cache)
+    const account = find(data.accounts, { id })
+    if (!account) {
+      throw new NotFoundException(`Account not found: ${id}`)
+    }
+    return account
   }
 
-  remove(id: number) {
-    return `This action removes a #${id} account`
+  public async update(id: string, data: Partial<AccountsMetadataV1>): Promise<Partial<AccountsMetadataV1>> {
+    const accounts = await readAccountsFile(this.cache)
+    const account: AccountsMetadataV1 = find(accounts.accounts, { id })
+    if (!account) {
+      throw new NotFoundException(`Account not found: ${id}`)
+    }
+    Object.assign(account, data)
+    await writeAccountsFile(accounts, this.cache)
+    return account
+  }
+
+  public async delete(id: string): Promise<Partial<AccountsMetadataV1>> {
+    const accounts = await readAccountsFile(this.cache)
+    const account = find(accounts.accounts, { id })
+    if (!account) {
+      throw new NotFoundException(`Account not found: ${id}`)
+    }
+    accounts.accounts = accounts.accounts.filter((a) => a.id !== id)
+    await writeAccountsFile(accounts, this.cache)
+    return account
   }
 }