misostack/finance.api.sonnm.com

Finance Service

API

Overview Architecture

Stack

Database + ORM

• Database: MongoDB
• ORM: Mongoose

Client-Server

• HTTP REST API
• JWT Token

Background Jobs

• BullMQ
• Bull Dashboard

Cron

• Repeatable Job

Test

• JestJS

Log

• Log4js
• Sentry

Document

• Gitbook

Monitoring tools

• [Prometheus]
• Prom Client
• Grafana

Devops

• Devopscube

Third party tools

• Mailjet
• [S3]

Setup

cp .env.sample .env
# replace with your environment's values
# start database
docker-compose up -d

Jest

• JEST CLI

How to run test

How to run a specific file ?

npx jest ./test/class-validator-with-schema.spec.ts

finance.api.sonnm.com's Issues

3rd: API Design

Includes:

• Controller and Methods for CRUD
• Input validation: DTOs, Pipes
• Unify response: input validation errors, crud responses, processing error, server error - Interceptors
• API Doc with Swagger
• Transform Output: class transformer and response DTOs
• Pagination : limit, offset
• Search: filter
• Authorization: Middleware, Auth Guard, Role base Access Control
• Unit Tests: Mock, Spy & Stubs
• Upload file: multipart form data
• Multi media endpoints: display image, download file, html, streaming
• Cache: header cache keys, redis cache, cache invalidation

2nd Create Schema and Model in NestJS with Mongoose

2nd Create Schema and Model in NestJS with Mongoose

Define Schema

import * as mongoose from 'mongoose';
export type Schema = mongoose.Schema;
export class SchemaFactory {
  static createSchema(options: any): Schema {
    return new mongoose.Schema({
      ...options,
      createdAt: { type: Date, default: Date.now },
      updatedAt: { type: Date, default: Date.now },
    });
  }
}

Create Provider to inject Model ( created from Schema )

const CompanySchema = SchemaFactory.createSchema({
  name: { type: String, required: true, maxLength: 75 },
});

const companyProvider = {
      provide: `EXAMPLE_MODEL`,
      useFactory: (connection: Connection) =>
        connection.model('Company', CompanySchema ),
      inject: ['DatabaseConnection'],
    };

export const databaseProviders = [
  {
    provide: 'DatabaseConnection',
    useFactory: (): Promise<typeof mongoose> =>
      mongoose.connect(MONGODB_URL, mongooseOptions),
  },
];


@Module({
  imports: [],
  providers: [...databaseProviders, companyProvider],
  exports: [...databaseProviders, companyProvider],
})

Usage

@Module({
  imports: [DatabaseModule],
  controllers: [HealthController],
})
export class HealthModule {}

@Controller('health')
export class HealthController {
  constructor(
    @Inject('COMPANY_MODEL')
    private companyModel: Model<Company>,
  ) {}

  @Get()
  async check() {
    await this.companyModel.create({ name: 'dasd' });
    const totalOfCompany = await this.companyModel.count();
    console.log({ totalOfCompany });

    return {totalOfCompany}
  }

1st: Architecture Overview

Overview

Gold Price Dataset

Datasource:

• https://sjc.com.vn/giavang/
• https://www.pnj.com.vn/blog/gia-vang/

Entity Diagram