yarn.lock

Reviewed-on: #19
Co-authored-by: Alie <bizcochito@anartist.org>
Co-committed-by: Alie <bizcochito@anartist.org>

.gitea/workflows/test.yaml

@@ -6,15 +6,17 @@ jobs:
     container:
       image: docker:dind
       volumes:
-        - /var/lib/docker:/var/lib/docker
+        - /usr/local/share/.cache/yarn:/usr/local/share/.cache/yarn
+        - /var/lib/docker/image:/var/lib/docker/image
+        - /var/lib/docker/overlay2:/var/lib/docker/overlay2
     steps:
       - name: Starting docker daemon
         run: docker-init -- dockerd --host=unix:///var/run/docker.sock &
       - name: Installing necessary packages
-        run: apk add npm git curl bash
+        run: apk add yarn git curl bash
       - name: Check out repository code
         uses: actions/checkout@v3
       - name: Install project dependencies
-        run: npm install
+        run: yarn install --frozen-lockfile --ignore-scripts
       - name: Run docker-compose
         run: docker compose down -v && docker compose run bot-api bun test

README.md

@@ -37,13 +37,12 @@ bun install
 To run:
 
 ```bash
-docker compose up
+bun run dev
 ```
 
 For testing, remember:
 ```bash
-docker compose down -v
-docker compose run bot-api bun run test
+bun run test
 ```
 
 This project was created using `bun init` in bun v1.0.13. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.

bunfig.toml

@@ -0,0 +1,4 @@
+[install.lockfile]
+# whether to save a non-Bun lockfile alongside bun.lockb
+# only "yarn" is supported
+print = "yarn"

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "fib-api",
+  "name": "bot-api",
   "module": "index.ts",
   "type": "module",
   "devDependencies": {

src/app.ts

@@ -15,6 +15,7 @@ app.get("/", (_, res) => {
 
 app.get("/images", imageController.getAllImages);
 app.get("/images/:id", imageController.getImageById);
+app.put("/images/:id", authControler.authorize, imageController.editImage);
 app.post("/images", authControler.authorize, imageController.addImage);
 app.post("/login", authControler.login);
 
@@ -30,6 +31,7 @@ export const startApp = async () => {
       user: mongo_user,
       pass: mongo_pass,
     });
+    mongoose.set("runValidators", true);
     app.listen(port, () =>
       console.log(`Express server listening on port ${port}`)
     );

src/controllers/ImageController.ts

@@ -4,6 +4,34 @@ import mongoose, { mongo } from "mongoose";
 import { Image } from "../models/ImageModel";
 
 class ImageController {
+  async editImage(req: Request, res: Response) {
+    try {
+      const change: Image = req.body;
+      const result = await imageService.replaceOne(req.params.id, change);
+      if (result.matchedCount > 0) {
+        res.status(204).json();
+      } else {
+        res.status(404).json({ error: "Image not found" });
+      }
+    } catch (error: any) {
+      if (error instanceof mongoose.Error.CastError) {
+        res.status(400).json({ error: "Invalid Id" });
+      } else if (error instanceof mongoose.Error.ValidationError) {
+        // Should return 400 Bad request for invalid requests
+        res.status(400).json({ error: error.message });
+      } else if (
+        error instanceof mongo.MongoServerError &&
+        error.code === 11000
+      ) {
+        // Should return 409 Conflict for existing urls
+        res.status(409).json({
+          error: `the image with URL ${error.keyValue.url} already exists`,
+        });
+      } else {
+        res.status(500).json({ error: "Internal Server Error" });
+      }
+    }
+  }
   async getImageById(req: Request, res: Response) {
     try {
       const image = await imageService.findById(req.params.id);

src/index.ts

@@ -6,7 +6,7 @@ await startApp();
 // This try carch is to prevent hot reload from making the process die due to coliding entries
 try {
   // Not insert test data into production
-  if (process.env.NODE_ENV != "production"){
+  if (process.env.NODE_ENV != "production") {
     await populateDatabase();
   }
 } catch {}

src/services/ImageService.ts

@@ -1,6 +1,10 @@
 import imageModel, { Image } from "../models/ImageModel";
 
 class ImageService {
+  async replaceOne(id: string, newimage: Image) {
+    const result = await imageModel.updateOne({ _id: id }, newimage);
+    return result;
+  }
   async findById(id: string) {
     const image = await imageModel.findOne({ _id: id });
     return image;

tests/app.test.ts

@@ -229,7 +229,6 @@ describe("POST /images works properly", () => {
   });
 
   it("should return 400 for malformed requests", async () => {
-    mock.restore();
     const res = await request(app)
       .post("/images")
       .set("authorization", `Bearer ${token}`)
@@ -242,18 +241,23 @@ describe("POST /images works properly", () => {
   });
 });
 
-describe("GET /images/:id works properly", () => {
+describe("GET /images/<id> works properly", () => {
+  let id: string;
+  let list: Image[];
+  beforeAll(async () => {
+    const res = await request(app).get("/images");
+    list = res.body.images;
+    id = list[0]._id;
+  });
+
   it("should return 200 for existing ids", async () => {
-    const list = await request(app).get("/images");
-    const id = list.body.images[0]._id;
     const res = await request(app).get(`/images/${id}`);
     expect(res.status).toBe(200);
   });
 
   it("should return 404 for non-existing ids", async () => {
-    const list = await request(app).get("/images");
     const id = "000000000000000000000000"; // this was the least posible to exist ID
-    if (!(id in list.body.images)) {
+    if (!(id in list)) {
       const res = await request(app).get(`/images/${id}`);
       expect(res.status).toBe(404);
     }
@@ -264,3 +268,108 @@ describe("GET /images/:id works properly", () => {
     expect(res.status).toBe(400);
   });
 });
+
+describe("PUT /images/<id> works properly", () => {
+  let id: string;
+  let list: Image[];
+  beforeAll(async () => {
+    const res = await request(app).get("/images");
+    list = res.body.images;
+    id = list[0]._id;
+  });
+
+  it("should return 204 for valid modifications", async () => {
+    const res = await request(app)
+      .put(`/images/${id}`)
+      .set("authorization", `Bearer ${token}`)
+      .send({ status: "available" });
+    expect(res.status).toBe(204);
+  });
+
+  it("should return 404 for non-existing ids", async () => {
+    const id = "000000000000000000000000"; // this was the least posible to exist ID
+    if (!(id in list)) {
+      const res = await request(app)
+        .put(`/images/${id}`)
+        .set("authorization", `Bearer ${token}`)
+        .send({ status: "available" });
+      expect(res.status).toBe(404);
+    }
+  });
+
+  it("should return 400 for malformed ids", async () => {
+    const res = await request(app)
+      .put("/images/98439384")
+      .set("authorization", `Bearer ${token}`)
+      .send({ status: "available" });
+    expect(res.status).toBe(400);
+    expect(res.body).toEqual({ error: "Invalid Id" });
+  });
+
+  it("should return 400 for malformed requests", async () => {
+    const res = await request(app)
+      .put(`/images/${id}`)
+      .set("authorization", `Bearer ${token}`)
+      .send({ status: "wrong" });
+    expect(res.status).toBe(400);
+  });
+
+  it("should return 409 if we try to modify the url into an existing one", async () => {
+    const res = await request(app)
+      .put(`/images/${id}`)
+      .set("authorization", `Bearer ${token}`)
+      .send({ url: "https://test.url.com/2" });
+    expect(res.status).toBe(409);
+  });
+
+  it("should return 500 for an error on the service", async () => {
+    mock.module("../src/services/ImageService", () => ({
+      default: {
+        replaceOne: () => {
+          throw new Error("This is an expected testing error");
+        },
+      },
+    }));
+
+    const res = await request(app)
+      .put(`/images/${id}`)
+      .set("authorization", `Bearer ${token}`)
+      .send({ status: "available" });
+
+    expect(res.status).toBe(500);
+  });
+
+  it("should return 401 for unauthenticated requests", async () => {
+    const res = await request(app)
+      .put(`/images/${id}`)
+      .send({ status: "available" });
+    expect(res.status).toBe(401);
+  });
+
+  it("should return 403 for invalid tokens", async () => {
+    const res = await request(app)
+      .put(`/images/${id}`)
+      .set("authorization", `Bearer token`)
+      .send({ status: "available" });
+    expect(res.status).toBe(403);
+  });
+
+  it("should have its changes be reflected onto the DB", async () => {
+    const image = await request(app)
+    .post("/images")
+    .set("authorization", `Bearer ${token}`)
+    .send({
+      url: "https://test.url.com/5",
+      status: "available",
+      tags: ["2girls", "touhou"],
+    });
+    const id = image.body.image._id;
+    await request(app)
+    .put(`/images/${id}`)
+    .set("authorization", `Bearer ${token}`)
+    .send({ status: "consumed" });
+    
+    const res = await request(app).get(`/images/${id}`);
+    expect(res.body.image).toHaveProperty("status", "consumed");
+  })
+});