feat(api): 🚀 Add anime data handling and environment setup

- Introduced `.env.example` for environment variable management.
- Moved and updated `package.json` within the `apps/api` directory, adding new dependencies and scripts for development and build processes.
- Created a new Prisma migration for the `Anime` table, outlining the structure for anime data storage.
- Developed new services and routes for fetching, caching, and serving anime data.
- Configured Docker Compose with PostgreSQL and Redis services to support local development.
- Enhanced the codebase with TypeScript configurations and utility functions for environment variable and fetch operations.

apps/api/.env.example

@@ -0,0 +1,7 @@
+# Rename this file to ".env" and put your datas
+PROXY_URL=
+NEKO_JSON_URL=
+NEKO_URL=
+HOST=
+PORT=
+JWT_SECRET=

packages/api/package.json → apps/api/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@gazes/api",
   "scripts": {
-    "dev": "bun run src/index.ts",
+    "dev": "bun run --hot src/index.ts",
     "build": "bun build src/index.ts --outdir dist/ --target bun"
   },
   "dependencies": {
+    "@fastify/type-provider-typebox": "^4.0.0",
+    "@gazes/types": "workspace:*",
     "fastify": "^4.26.2",
-    "@gazes/types": "workspace:*"
+    "redis": "^4.6.13"
   }
 }

apps/api/prisma/migrations/20240403165832_init/migration.sql

@@ -0,0 +1,25 @@
+-- CreateTable
+CREATE TABLE "Anime" (
+    "id" INTEGER NOT NULL,
+    "titleOriginal" TEXT NOT NULL,
+    "titleEnglish" TEXT,
+    "titleRomanized" TEXT,
+    "titleFrench" TEXT,
+    "alternativeTitles" TEXT,
+    "mediaType" TEXT NOT NULL,
+    "airingStatus" TEXT NOT NULL,
+    "externalUrl" TEXT NOT NULL,
+    "genres" TEXT[],
+    "coverImageUrl" TEXT NOT NULL,
+    "popularityScore" DOUBLE PRECISION NOT NULL,
+    "averageScore" DOUBLE PRECISION NOT NULL,
+    "startYear" INTEGER NOT NULL,
+    "episodesCount" INTEGER,
+    "synopsis" TEXT,
+    "bannerImageUrl" TEXT,
+
+    CONSTRAINT "Anime_pkey" PRIMARY KEY ("id")
+);
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Anime_id_key" ON "Anime"("id");

apps/api/prisma/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (i.e. Git)
+provider = "postgresql"

packages/api/prisma/schema.prisma → apps/api/prisma/schema.prisma

@@ -16,11 +16,13 @@ model Anime {
   alternativeTitles String?
   mediaType         String
   airingStatus      String
-  popularityScore   Float
   externalUrl       String
   genres            String[]
   coverImageUrl     String
+  popularityScore   Float
   averageScore      Float
   startYear         Int
   episodesCount     Int?
+  synopsis          String?
+  bannerImageUrl    String?
 }

packages/api/src/app.ts → apps/api/src/app.ts

@@ -1,17 +1,30 @@
+import type { TypeBoxTypeProvider } from "@fastify/type-provider-typebox";
 import { Glob } from "bun";
 import fastify from "fastify";
 import { join } from "node:path";
+import { createClient, type RedisClientType } from "redis";
+import { AnimeService } from "./services/animeService";
+import { PrismaClient } from "prisma/prisma-client";
 
 // Initialize a Fastify application instance with specific configurations.
 export const app = fastify({
 	logger: true, // Enable loggin for the application
 	disableRequestLogging: true, // Disable request logging to avoid clutter in the log output
-});
+}).withTypeProvider<TypeBoxTypeProvider>();
 
 // Synamically import and register router modules found by globbing thep roject directory for files
 // with a ".router." in their names.
 for await (const file of new Glob("**/*Router.*").scan(import.meta.dir)) {
+	const prismaClient = new PrismaClient();
+	const redisClient = (await createClient().connect()) as RedisClientType;
+
+	const animeService = new AnimeService(redisClient, prismaClient)
+	await animeService.updateDatabase()
+
 	// Register each found router module with the Fastify application.
 	// The router modules are expected to export a default function that defines routes.
-	app.register((await import(join(import.meta.dir, file))).default);
+	app.register((await import(join(import.meta.dir, file))).default, {
+		prismaClient,
+		redisClient,
+	});
 }

apps/api/src/index.ts

@@ -0,0 +1,10 @@
+import { app } from "@/app";
+
+const { ADDRESS = "0.0.0.0", PORT = "3000" } = Bun.env;
+
+app.listen({ port: Number.parseInt(PORT, 10), host: ADDRESS }, (error) => {
+	if (error) {
+		console.error(error);
+		process.exit(1);
+	}
+});

apps/api/src/routers/animeRouter.ts

@@ -0,0 +1,21 @@
+import { AnimeService } from "@/services/animeService";
+import { AnimeListQuerystring, type RouteOptions } from "@/types/routeTypes";
+import type { FastifyInstance } from "fastify";
+
+export default async function (
+	app: FastifyInstance,
+	{ prismaClient, redisClient }: RouteOptions,
+) {
+	const animeService = new AnimeService(redisClient, prismaClient);
+
+	app.get<{ Querystring: AnimeListQuerystring }>(
+		"/",
+		{
+			schema: { querystring: AnimeListQuerystring },
+		},
+		(request, response) => {
+			const { page = 1, title, genres, status, releaseDate } = request.query;
+
+		},
+	);
+}

apps/api/src/services/animeService.ts

@@ -0,0 +1,50 @@
+import type { RedisClientType } from "redis";
+import { CacheService } from "./cacheService";
+import { fetchType } from "@/utils/fetchUtils";
+import { getEnv } from "@/utils/envUtils";
+import type { Anime, PrismaClient } from "@prisma/client";
+
+const HOUR = 3.6e+6;
+
+export class AnimeService {
+  private cacheService: CacheService;
+
+  constructor(
+    private redisClient: RedisClientType,
+    private prismaClient: PrismaClient,
+  ) {
+    this.cacheService = new CacheService(redisClient);
+  }
+
+  public async updateDatabase() {
+    await this.prismaClient.anime.deleteMany({})
+    const animesList: any[] = await fetchType(getEnv("NEKO_JSON_URL"), "json")
+
+    const animesData: Anime[] = animesList.map(anime => ({
+      id: anime.id,
+      titleOriginal: anime.title,
+      titleEnglish: anime.title_english,
+      titleRomanized: anime.title_romanji,
+      titleFrench: anime.title_french,
+      alternativeTitles: anime.others,
+      mediaType: anime.type,
+      airingStatus: anime.type === "1" ? "en cours" : "finis",
+      popularityScore: anime.popularity,
+      externalUrl: anime.url,
+      genres: anime.genres,
+      coverImageUrl: anime.url_image,
+      averageScore: Number.parseFloat(anime.score),
+      startYear: Number.parseInt(anime.start_date_year),
+      episodesCount: Number.parseInt(anime.nb_eps),
+      bannerImageUrl: null,
+      synopsis: null
+    }))
+
+    await this.prismaClient.anime.createMany({
+      data: animesData,
+      skipDuplicates: true
+    })
+
+    setInterval(this.updateDatabase, HOUR)
+  }
+}

apps/api/src/services/cacheService.ts

@@ -0,0 +1,19 @@
+import type { RedisClientType } from "redis";
+
+export class CacheService {
+    constructor(
+		private readonly redisClient: RedisClientType
+	) {}
+
+	async setCache(key: string, value: unknown, ttl = 3600): Promise<void> {
+		const stringValue = JSON.stringify(value);
+		await this.redisClient.setEx(key, ttl, stringValue);
+	}
+
+	async getCache<T>(key: string): Promise<T | undefined> {
+		const cachedValue = await this.redisClient.get(key);
+		if (!cachedValue) return undefined;
+
+		return JSON.parse(cachedValue) as T;
+	}
+}

apps/api/src/types/routeTypes.ts

@@ -0,0 +1,35 @@
+import type { PrismaClient } from "@prisma/client";
+import { Type, type Static } from "@sinclair/typebox";
+import type { RedisClientType } from "redis";
+
+// Route-related types and interfaces below
+
+export type RouteOptions = {
+	prismaClient: PrismaClient;
+	redisClient: RedisClientType;
+};
+
+export type SuccessResponse = {
+	data: unknown;
+	error: never;
+};
+
+export type ErrorResponse = {
+	data: never;
+	error: {
+		title: string;
+		detail: string;
+	};
+};
+
+export type Response = SuccessResponse|ErrorResponse
+
+export const AnimeListQuerystring = Type.Object({
+	page: Type.Optional(Type.Number()),
+	title: Type.Optional(Type.String()),
+	genres: Type.Optional(Type.String()),
+	status: Type.Optional(Type.Number()),
+	releaseDate: Type.Optional(Type.Number()),
+});
+
+export type AnimeListQuerystring = Static<typeof AnimeListQuerystring>

apps/api/src/utils/envUtils.ts

@@ -0,0 +1,5 @@
+export function getEnv(key: string): string {
+  const value = Bun.env[key]
+  if (!value) throw `Missing ${key} env variable`
+  return value
+}

apps/api/src/utils/fetchUtils.ts

@@ -0,0 +1,8 @@
+export async function fetchType<T>(
+	url: string,
+	type: "json" | "text",
+): Promise<T> {
+	const response = await fetch(url);
+	if (!response.ok) throw Error("Error fetching the URL");
+	return await response[type]();
+}

biome.json

@@ -0,0 +1,15 @@
+{
+	"$schema": "https://biomejs.dev/schemas/1.6.3/schema.json",
+	"organizeImports": {
+		"enabled": true
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"suspicious": {
+				"noExplicitAny":"off"
+			}
+		}
+	}
+}

docker-compose.yml

@@ -0,0 +1,17 @@
+services:
+
+  db:
+    image: postgres:alpine
+    restart: always
+    shm_size: 128mb
+    environment:
+      POSTGRES_USER: dev
+      POSTGRES_PASSWORD: dev
+      POSTGRES_DB: pg-dev
+    ports:
+      - "5432:5432"
+
+  redis:
+    image: 'redislabs/redismod'
+    ports:
+      - '6379:6379'

package.json

@@ -1,7 +1,10 @@
 {
   "name": "gazes",
   "private": true,
-  "workspaces": ["packages/*"],
+  "workspaces": [
+    "packages/*",
+    "apps/*"
+  ],
   "scripts": {
     "format": "biome format . --write",
     "clean": "rm -rf node_modules packages/a/node_modules packages/b/node_modules bun.lockb packages/a/bun.lockb packages/b/bun.lockb"
@@ -14,6 +17,7 @@
     "typescript": "^5.0.0"
   },
   "dependencies": {
+    "@sinclair/typebox": "^0.32.20",
     "prisma": "^5.12.0"
   }
 }