feat: add new endpoints for api (#22)

* refractor: update package name (#21)

* feat: add new type definitions for discovered endpoints

* refractor: remove static war id

* feat: add new database models

* refractor: add data pulling logic for new endpoints

* feat: add statistic route for planets

* fix: delete reward data on refresh

* lib(routes): add statistic routes

* feat: integrate statistic routes

* lib(routes): add assignment routes

* feat: integrate assignment routes

* lib(routes): add report routes

* feat: integrate assignment routes

* fix: resolve error in data refresh method

* refractor: remove unused variable

* chore(tests): add tests for assignments, reports and statistics

---------

Signed-off-by: Fabio Nettis <nettisfabio@gmail.com>

Author: fabio-nettis

.github/workflows/tests.yml

@@ -4,7 +4,6 @@ env:
   # prisma setip
   DATABASE_URL: "file:./database/data.db"
   # api setup
-  WAR_ID: "801"
   RATE_LIMIT: "200"
   API_URL: "https://api.live.prod.thehelldiversgame.com/api"
   # stratagem setup

Dockerfile

@@ -4,7 +4,6 @@ FROM oven/bun:latest as base
 WORKDIR /usr/src/app
 
 # Set environment variables
-ENV WAR_ID="801"
 ENV RATE_LIMIT="200"
 ENV DATABASE_URL="file:./database/data.db"
 ENV API_URL="https://api.live.prod.thehelldiversgame.com/api"

__tests__/routes/assignments.test.ts

@@ -0,0 +1,42 @@
+import app from "../../src";
+import type { Order } from "@prisma/client";
+import { describe, expect, it } from "bun:test";
+
+describe("Assignment endpoints work as expected", () => {
+  it("GET /assignment", async () => {
+    const response = await app.request("/api/assignments");
+    const json: { data: Order[]; error: object | null } =
+      (await response.json()) as any;
+    expect(response.status).toBe(200);
+    expect(json).toHaveProperty("data");
+    expect(json.data).toBeInstanceOf(Array);
+  });
+
+  it("GET /assignment/:id", async () => {
+    try {
+      const response = await app.request("/api/assignments/1");
+      const json: { data: Order; error: object | null } =
+        (await response.json()) as any;
+      expect(response.status).toBe(200);
+      expect(json).toHaveProperty("data");
+      expect(json.data).toHaveProperty("id");
+    } catch {
+      // this is ok, there is not always an assignment with id 1
+      // because they are more dynamic than other entities
+    }
+  });
+
+  it("GET /assignment/:id/rewards", async () => {
+    try {
+      const response = await app.request("/api/assignments/1/rewards");
+      const json: { data: Order; error: object | null } =
+        (await response.json()) as any;
+      expect(response.status).toBe(200);
+      expect(json).toHaveProperty("data");
+      expect(json.data).toHaveProperty("id");
+    } catch {
+      // this is ok, there is not always an reward for assignment with id 1
+      // because they are more dynamic than other entities
+    }
+  });
+});

__tests__/routes/orders.test.ts

@@ -2,8 +2,6 @@ import app from "../../src";
 import type { Order } from "@prisma/client";
 import { describe, expect, it } from "bun:test";
 
-let res = null;
-
 describe("Order endpoints work as expected", () => {
   it("GET /orders", async () => {
     const response = await app.request("/api/orders");

__tests__/routes/planets.test.ts

@@ -1,5 +1,5 @@
 import app from "../../src";
-import type { Planet } from "@prisma/client";
+import type { Planet, Stats } from "@prisma/client";
 import { describe, expect, it } from "bun:test";
 
 describe("Planet endpoints work as expected", () => {
@@ -53,4 +53,13 @@ describe("Planet endpoints work as expected", () => {
     expect(json).toHaveProperty("data");
     expect(json.data).toBeInstanceOf(Array);
   });
+
+  it("GET /planets/:id/statistics", async () => {
+    const response = await app.request("/api/planets/1/statistics");
+    const json: { data: Stats; error: object | null } =
+      (await response.json()) as any;
+    expect(response.status).toBe(200);
+    expect(json).toHaveProperty("data");
+    expect(json.data).toHaveProperty("id");
+  });
 });

__tests__/routes/reports.test.ts

@@ -0,0 +1,28 @@
+import app from "../../src";
+import type { Order } from "@prisma/client";
+import { describe, expect, it } from "bun:test";
+
+describe("Report endpoints work as expected", () => {
+  it("GET /reports", async () => {
+    const response = await app.request("/api/reports");
+    const json: { data: Order[]; error: object | null } =
+      (await response.json()) as any;
+    expect(response.status).toBe(200);
+    expect(json).toHaveProperty("data");
+    expect(json.data).toBeInstanceOf(Array);
+  });
+
+  it("GET /reports/:id", async () => {
+    try {
+      const response = await app.request("/api/reports/1");
+      const json: { data: Order; error: object | null } =
+        (await response.json()) as any;
+      expect(response.status).toBe(200);
+      expect(json).toHaveProperty("data");
+      expect(json.data).toHaveProperty("id");
+    } catch {
+      // this is ok, there is not always an report with id 1
+      // because they are more dynamic than other entities
+    }
+  });
+});

__tests__/routes/statistics.test.ts

@@ -0,0 +1,37 @@
+import app from "../../src";
+import type { Order } from "@prisma/client";
+import { describe, expect, it } from "bun:test";
+
+describe("Statistic endpoints work as expected", () => {
+  it("GET /statistics", async () => {
+    const response = await app.request("/api/statistics");
+    const json: { data: Order[]; error: object | null } =
+      (await response.json()) as any;
+    expect(response.status).toBe(200);
+    expect(json).toHaveProperty("data");
+    expect(json.data).toBeInstanceOf(Array);
+  });
+
+  it("GET /statistics/:id", async () => {
+    try {
+      const response = await app.request("/api/statistics/94");
+      const json: { data: Order; error: object | null } =
+        (await response.json()) as any;
+      expect(response.status).toBe(200);
+      expect(json).toHaveProperty("data");
+      expect(json.data).toHaveProperty("id");
+    } catch {
+      // this is ok, there is not always an statistic with id 94
+      // because they are more dynamic than other entities
+    }
+  });
+
+  it("GET /statistics/galaxy", async () => {
+    const response = await app.request("/api/statistics/galaxy");
+    const json: { data: Order; error: object | null } =
+      (await response.json()) as any;
+    expect(response.status).toBe(200);
+    expect(json).toHaveProperty("data");
+    expect(json.data).toHaveProperty("id");
+  });
+});

prisma/migrations/20240327083947_new_endpoints/migration.sql

@@ -0,0 +1,123 @@
+/*
+  Warnings:
+
+  - Added the required column `time` to the `War` table without a default value. This is not possible if the table is not empty.
+
+*/
+-- CreateTable
+CREATE TABLE "News" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "index" INTEGER NOT NULL,
+    "type" INTEGER NOT NULL,
+    "tagIds" TEXT NOT NULL,
+    "message" TEXT NOT NULL,
+    "publishedAt" DATETIME NOT NULL,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL
+);
+
+-- CreateTable
+CREATE TABLE "Stats" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "missionsWon" BIGINT NOT NULL,
+    "missionsLost" BIGINT NOT NULL,
+    "missionTime" BIGINT NOT NULL,
+    "bugKills" BIGINT NOT NULL,
+    "automatonKills" BIGINT NOT NULL,
+    "illuminateKills" BIGINT NOT NULL,
+    "bulletsFired" BIGINT NOT NULL,
+    "bulletsHit" BIGINT NOT NULL,
+    "timePlayed" BIGINT NOT NULL,
+    "deaths" BIGINT NOT NULL,
+    "revives" BIGINT NOT NULL,
+    "friendlyKills" BIGINT NOT NULL,
+    "missionSuccessRate" INTEGER NOT NULL,
+    "accuracy" INTEGER NOT NULL,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL
+);
+
+-- CreateTable
+CREATE TABLE "Reward" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "index" INTEGER NOT NULL,
+    "type" INTEGER NOT NULL,
+    "amount" INTEGER NOT NULL,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL
+);
+
+-- CreateTable
+CREATE TABLE "Assignment" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "index" INTEGER NOT NULL,
+    "progress" INTEGER NOT NULL,
+    "expiresAt" DATETIME NOT NULL,
+    "type" INTEGER NOT NULL,
+    "title" TEXT NOT NULL,
+    "briefing" TEXT NOT NULL,
+    "description" TEXT NOT NULL,
+    "rewardId" INTEGER NOT NULL,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL,
+    CONSTRAINT "Assignment_rewardId_fkey" FOREIGN KEY ("rewardId") REFERENCES "Reward" ("id") ON DELETE RESTRICT ON UPDATE CASCADE
+);
+
+-- RedefineTables
+PRAGMA foreign_keys=OFF;
+CREATE TABLE "new_Planet" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "index" INTEGER NOT NULL,
+    "name" TEXT NOT NULL,
+    "ownerId" INTEGER NOT NULL,
+    "sectorId" INTEGER NOT NULL,
+    "health" INTEGER NOT NULL,
+    "maxHealth" INTEGER NOT NULL,
+    "players" INTEGER NOT NULL,
+    "disabled" BOOLEAN NOT NULL,
+    "regeneration" INTEGER NOT NULL,
+    "initialOwnerId" INTEGER NOT NULL,
+    "positionX" REAL NOT NULL,
+    "positionY" REAL NOT NULL,
+    "globalEventId" INTEGER,
+    "statisticId" INTEGER,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL,
+    CONSTRAINT "Planet_ownerId_fkey" FOREIGN KEY ("ownerId") REFERENCES "Faction" ("id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "Planet_sectorId_fkey" FOREIGN KEY ("sectorId") REFERENCES "Sector" ("id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "Planet_initialOwnerId_fkey" FOREIGN KEY ("initialOwnerId") REFERENCES "Faction" ("id") ON DELETE RESTRICT ON UPDATE CASCADE,
+    CONSTRAINT "Planet_globalEventId_fkey" FOREIGN KEY ("globalEventId") REFERENCES "GlobalEvent" ("id") ON DELETE SET NULL ON UPDATE CASCADE,
+    CONSTRAINT "Planet_statisticId_fkey" FOREIGN KEY ("statisticId") REFERENCES "Stats" ("id") ON DELETE SET NULL ON UPDATE CASCADE
+);
+INSERT INTO "new_Planet" ("createdAt", "disabled", "globalEventId", "health", "id", "index", "initialOwnerId", "maxHealth", "name", "ownerId", "players", "positionX", "positionY", "regeneration", "sectorId", "updatedAt") SELECT "createdAt", "disabled", "globalEventId", "health", "id", "index", "initialOwnerId", "maxHealth", "name", "ownerId", "players", "positionX", "positionY", "regeneration", "sectorId", "updatedAt" FROM "Planet";
+DROP TABLE "Planet";
+ALTER TABLE "new_Planet" RENAME TO "Planet";
+CREATE UNIQUE INDEX "Planet_index_key" ON "Planet"("index");
+CREATE UNIQUE INDEX "Planet_statisticId_key" ON "Planet"("statisticId");
+CREATE TABLE "new_War" (
+    "id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
+    "index" INTEGER NOT NULL,
+    "startDate" DATETIME NOT NULL,
+    "endDate" DATETIME NOT NULL,
+    "time" DATETIME NOT NULL,
+    "createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    "updatedAt" DATETIME NOT NULL
+);
+INSERT INTO "new_War" ("createdAt", "endDate", "id", "index", "startDate", "updatedAt") SELECT "createdAt", "endDate", "id", "index", "startDate", "updatedAt" FROM "War";
+DROP TABLE "War";
+ALTER TABLE "new_War" RENAME TO "War";
+CREATE UNIQUE INDEX "War_index_key" ON "War"("index");
+PRAGMA foreign_key_check;
+PRAGMA foreign_keys=ON;
+
+-- CreateIndex
+CREATE UNIQUE INDEX "News_index_key" ON "News"("index");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Reward_index_key" ON "Reward"("index");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Assignment_index_key" ON "Assignment"("index");
+
+-- CreateIndex
+CREATE UNIQUE INDEX "Assignment_rewardId_key" ON "Assignment"("rewardId");

prisma/schema.prisma

@@ -16,6 +16,7 @@ model War {
   index     Int      @unique
   startDate DateTime
   endDate   DateTime
+  time      DateTime
   createdAt DateTime @default(now())
   updatedAt DateTime @updatedAt
 }
@@ -66,6 +67,8 @@ model Planet {
   homeWorld      HomeWorld[]  @relation("HomeWorld")
   attacking      Attack[]     @relation("Attack")
   defending      Attack[]     @relation("Defend")
+  statistic      Stats?       @relation(fields: [statisticId], references: [id])
+  statisticId    Int?         @unique
   createdAt      DateTime     @default(now())
   updatedAt      DateTime     @updatedAt
 }
@@ -155,3 +158,60 @@ model Stratagem {
   createdAt  DateTime        @default(now())
   updatedAt  DateTime        @updatedAt
 }
+
+model News {
+  id          Int      @id @default(autoincrement())
+  index       Int      @unique
+  type        Int
+  tagIds      String
+  message     String
+  publishedAt DateTime
+  createdAt   DateTime @default(now())
+  updatedAt   DateTime @updatedAt
+}
+
+model Stats {
+  id                 Int      @id @default(autoincrement())
+  missionsWon        BigInt
+  missionsLost       BigInt
+  missionTime        BigInt
+  bugKills           BigInt
+  automatonKills     BigInt
+  illuminateKills    BigInt
+  bulletsFired       BigInt
+  bulletsHit         BigInt
+  timePlayed         BigInt
+  deaths             BigInt
+  revives            BigInt
+  friendlyKills      BigInt
+  missionSuccessRate Int
+  accuracy           Int
+  createdAt          DateTime @default(now())
+  updatedAt          DateTime @updatedAt
+  planet             Planet?
+}
+
+model Reward {
+  id         Int         @id @default(autoincrement())
+  index      Int         @unique
+  type       Int
+  amount     Int
+  createdAt  DateTime    @default(now())
+  updatedAt  DateTime    @updatedAt
+  assignment Assignment?
+}
+
+model Assignment {
+  id          Int      @id @default(autoincrement())
+  index       Int      @unique
+  progress    Int
+  expiresAt   DateTime
+  type        Int
+  title       String
+  briefing    String
+  description String
+  reward      Reward   @relation(fields: [rewardId], references: [id])
+  rewardId    Int      @unique
+  createdAt   DateTime @default(now())
+  updatedAt   DateTime @updatedAt
+}