feat: add basic counter setup

.env.example

@@ -1,4 +1,6 @@
 NODE_ENV=development
 API_DOMAIN=localhost
 PORT=3000
-CORS_ORIGINS=http://localhost,http://localhost:3000
+CORS_ORIGINS=http://localhost,http://localhost:3000,https://piquetde.stream
+
+REDIS_URL=redis://localhost:6379

fly.toml

@@ -23,8 +23,8 @@ processes = []
   protocol = "tcp"
   script_checks = []
   [services.concurrency]
-    hard_limit = 25
-    soft_limit = 20
+    hard_limit = 100
+    soft_limit = 90
     type = "connections"
 
   [[services.ports]]

nest-cli.json

@@ -1,8 +1,11 @@
 {
-  "$schema": "https://json.schemastore.org/nest-cli",
-  "collection": "@nestjs/schematics",
-  "sourceRoot": "src",
-  "compilerOptions": {
-    "deleteOutDir": true
-  }
+	"$schema": "https://json.schemastore.org/nest-cli",
+	"collection": "@nestjs/schematics",
+	"sourceRoot": "src",
+	"compilerOptions": {
+		"plugins": [
+			"@nestjs/swagger"
+		],
+		"deleteOutDir": true
+	}
 }

package.json

@@ -29,10 +29,12 @@
 		"@nestjs/config": "^2.2.0",
 		"@nestjs/core": "^9.2.1",
 		"@nestjs/platform-express": "^9.2.1",
+		"@nestjs/swagger": "^6.1.4",
 		"axios": "^1.2.2",
 		"class-transformer": "^0.5.1",
 		"class-validator": "^0.14.0",
 		"dayjs": "^1.11.7",
+		"helmet": "^6.0.1",
 		"reflect-metadata": "^0.1.13",
 		"rxjs": "^7.8.0"
 	},

src/app.module.ts

@@ -3,9 +3,10 @@ import { AppController } from "./app.controller"
 import { AppService } from "./app.service"
 import { ExtendedConfigModule } from "./config/config.module"
 import { HelloAssoModule } from "./helloasso/helloasso.module"
+import { CounterModule } from "./counter/counter.module"
 
 @Module({
-	imports: [ExtendedConfigModule, HelloAssoModule],
+	imports: [ExtendedConfigModule, HelloAssoModule, CounterModule],
 	controllers: [AppController],
 	providers: [AppService]
 })

src/counter/counter.controller.spec.ts

@@ -0,0 +1,20 @@
+import { Test, TestingModule } from "@nestjs/testing"
+import { CounterController } from "./counter.controller"
+import { CounterService } from "./counter.service"
+
+describe("CounterController", () => {
+	let controller: CounterController
+
+	beforeEach(async () => {
+		const module: TestingModule = await Test.createTestingModule({
+			providers: [CounterService],
+			controllers: [CounterController]
+		}).compile()
+
+		controller = module.get<CounterController>(CounterController)
+	})
+
+	it("should be defined", () => {
+		expect(controller).toBeDefined()
+	})
+})

src/counter/counter.controller.ts

@@ -0,0 +1,24 @@
+import { Controller, Get, Sse } from "@nestjs/common"
+import { ApiTags } from "@nestjs/swagger"
+import { from, map, Observable } from "rxjs"
+import { CounterService } from "./counter.service"
+import { CounterMessage, CounterMessagePayload } from "./interfaces/counter-message.interface"
+
+@ApiTags("Counter")
+@Controller("counter")
+export class CounterController {
+	constructor(private readonly counterService: CounterService) {}
+
+	@Sse("sse")
+	counterSse(): Observable<CounterMessage> {
+		return from(this.counterService.counterSubject).pipe(map((data) => data))
+	}
+
+	@Get("state")
+	getState(): CounterMessagePayload {
+		return {
+			amount: 0,
+			updatedAt: Date.now()
+		}
+	}
+}

src/counter/counter.module.ts

@@ -0,0 +1,9 @@
+import { Module } from "@nestjs/common"
+import { CounterController } from "./counter.controller"
+import { CounterService } from "./counter.service"
+
+@Module({
+	controllers: [CounterController],
+	providers: [CounterService]
+})
+export class CounterModule {}

src/counter/counter.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from "@nestjs/testing"
+import { CounterService } from "./counter.service"
+
+describe("CounterService", () => {
+	let service: CounterService
+
+	beforeEach(async () => {
+		const module: TestingModule = await Test.createTestingModule({
+			providers: [CounterService]
+		}).compile()
+
+		service = module.get<CounterService>(CounterService)
+	})
+
+	it("should be defined", () => {
+		expect(service).toBeDefined()
+	})
+})

src/counter/counter.service.ts

@@ -0,0 +1,27 @@
+import { Injectable } from "@nestjs/common"
+import { Subject } from "rxjs"
+import { CounterMessage, CounterMessagePayload } from "./interfaces/counter-message.interface"
+
+@Injectable()
+export class CounterService {
+	public counterSubject: Subject<CounterMessage>
+
+	constructor() {
+		this.counterSubject = new Subject()
+	}
+
+	public updateCounter(amount: number): void {
+		const payload: CounterMessagePayload = {
+			amount,
+			updatedAt: Date.now()
+		}
+		this.counterSubject.next({ data: payload, type: "counter-update" })
+	}
+
+	public newDonation(amount: number): void {
+		const payload: CounterMessagePayload = {
+			amount
+		}
+		this.counterSubject.next({ data: payload, type: "new-donation" })
+	}
+}

src/counter/interfaces/counter-message.interface.ts

@@ -0,0 +1,29 @@
+export interface NewDonationEvent {
+	data: NewDonationPayload
+	id?: string
+	type: "new-donation"
+	retry?: number
+}
+
+export interface NewDonationPayload {
+	// Amount of the donation in euros
+	amount: number
+}
+
+export interface CounterUpdateEvent {
+	data: CounterUpdatePayload
+	id?: string
+	type: "counter-update"
+	retry?: number
+}
+
+export interface CounterUpdatePayload {
+	// Total amount of donations in euros
+	amount: number
+	// Timestamp in milliseconds
+	updatedAt: number
+}
+
+export type CounterMessage = NewDonationEvent | CounterUpdateEvent
+
+export type CounterMessagePayload = NewDonationPayload | CounterUpdatePayload