add getUserStats

src/app.ts

@@ -37,6 +37,7 @@ import {getLockCategories} from "./routes/getLockCategories";
 import {getLockCategoriesByHash} from "./routes/getLockCategoriesByHash";
 import {endpoint as getSearchSegments } from "./routes/getSearchSegments";
 import {getStatus } from "./routes/getStatus";
+import {getUserStats} from "./routes/getUserStats";
 import ExpressPromiseRouter from "express-promise-router";
 import { Server } from "http";
 
@@ -173,6 +174,9 @@ function setupRoutes(router: Router) {
     router.get("/api/status/:value", getStatus);
     router.get("/api/status", getStatus);
 
+    // get user category stats
+    router.get("/api/userStats", getUserStats);
+
     if (config.postgres) {
         router.get("/database", (req, res) => dumpDatabase(req, res, true));
         router.get("/database.json", (req, res) => dumpDatabase(req, res, false));

src/routes/getUserInfo.ts

@@ -43,12 +43,7 @@ async function dbGetIgnoredSegmentCount(userID: HashedUserID): Promise<number> {
 async function dbGetUsername(userID: HashedUserID) {
     try {
         const row = await db.prepare("get", `SELECT "userName" FROM "userNames" WHERE "userID" = ?`, [userID]);
-        if (row !== undefined) {
-            return row.userName;
-        } else {
-            //no username yet, just send back the userID
-            return userID;
-        }
+        return row?.userName ?? userID;
     } catch (err) {
         return false;
     }
@@ -172,7 +167,7 @@ async function getUserInfo(req: Request, res: Response): Promise<Response> {
         responseObj[property] = await dbGetValue(hashedUserID, property);
     }
     // add minutesSaved and segmentCount after to avoid getting overwritten
-    if (paramValues.includes("minutesSaved")) { responseObj["minutesSaved"] = segmentsSummary.minutesSaved; }
+    if (paramValues.includes("minutesSaved")) responseObj["minutesSaved"] = segmentsSummary.minutesSaved;
     if (paramValues.includes("segmentCount")) responseObj["segmentCount"] = segmentsSummary.segmentCount;
     return res.send(responseObj);
 }

src/routes/getUserStats.ts

@@ -0,0 +1,56 @@
+import {db} from "../databases/databases";
+import {getHash} from "../utils/getHash";
+import {Request, Response} from "express";
+import { HashedUserID, UserID } from "../types/user.model";
+import { Category } from "../types/segments.model";
+import {config} from "../config";
+const maxRewardTime = config.maxRewardTimePerSegmentInSeconds;
+
+async function dbGetCategorySummary(userID: HashedUserID, category: Category): Promise<{ minutesSaved: number, segmentCount: number }> {
+    try {
+        const row = await db.prepare("get",
+            `SELECT SUM(((CASE WHEN "endTime" - "startTime" > ? THEN ? ELSE "endTime" - "startTime" END) / 60) * "views") as "minutesSaved",
+            count(*) as "segmentCount" FROM "sponsorTimes"
+            WHERE "userID" = ? AND "category" = ? AND "votes" > -2 AND "shadowHidden" != 1`, [maxRewardTime, maxRewardTime, userID, category]);
+        if (row.minutesSaved != null) {
+            return {
+                minutesSaved: row.minutesSaved,
+                segmentCount: row.segmentCount,
+            };
+        } else {
+            return {
+                minutesSaved: 0,
+                segmentCount: 0,
+            };
+        }
+    } catch (err) {
+        return null;
+    }
+}
+
+async function dbGetUsername(userID: HashedUserID) {
+    try {
+        const row = await db.prepare("get", `SELECT "userName" FROM "userNames" WHERE "userID" = ?`, [userID]);
+        return row?.userName ?? userID;
+    } catch (err) {
+        return false;
+    }
+}
+
+export async function getUserStats(req: Request, res: Response): Promise<Response> {
+    const userID = req.query.userID as UserID;
+    const hashedUserID: HashedUserID = userID ? getHash(userID) : req.query.publicUserID as HashedUserID;
+
+    if (hashedUserID == undefined) {
+        //invalid request
+        return res.status(400).send("Invalid userID or publicUserID parameter");
+    }
+    const responseObj = {
+        userID: hashedUserID,
+        userName: await dbGetUsername(hashedUserID),
+    } as Record<string, Record<string, number> | string >;
+    for (const category of config.categoryList) {
+        responseObj[category] = await dbGetCategorySummary(hashedUserID, category as Category);
+    }
+    return res.send(responseObj);
+}

test/cases/getUserStats.ts

@@ -0,0 +1,95 @@
+import fetch from "node-fetch";
+import {Done, getbaseURL} from "../utils";
+import {db} from "../../src/databases/databases";
+import {getHash} from "../../src/utils/getHash";
+import assert from "assert";
+
+describe("getUserStats", () => {
+    before(async () => {
+        const insertUserNameQuery = 'INSERT INTO "userNames" ("userID", "userName") VALUES(?, ?)';
+        await db.prepare("run", insertUserNameQuery, [getHash("getuserstats_user_01"), "Username user 01"]);
+
+        const sponsorTimesQuery = 'INSERT INTO "sponsorTimes" ("videoID", "startTime", "endTime", "votes", "UUID", "userID", "timeSubmitted", views, category, "shadowHidden") VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?)';
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, 0, "getuserstatsuuid1", getHash("getuserstats_user_01"), 1, 1, "sponsor", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, 0, "getuserstatsuuid2", getHash("getuserstats_user_01"), 2, 2, "selfpromo", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, 0, "getuserstatsuuid3", getHash("getuserstats_user_01"), 3, 3, "interaction", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, 0, "getuserstatsuuid4", getHash("getuserstats_user_01"), 4, 4, "intro", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, 0, "getuserstatsuuid5", getHash("getuserstats_user_01"), 5, 5, "outro", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, 0, "getuserstatsuuid6", getHash("getuserstats_user_01"), 6, 6, "preview", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, 0, "getuserstatsuuid7", getHash("getuserstats_user_01"), 7, 7, "music_offtopic", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 11, 11, 0, "getuserstatsuuid8", getHash("getuserstats_user_01"), 8, 8, "poi_highlight", 0]);
+        await db.prepare("run", sponsorTimesQuery, ["getuserstats1", 0, 60, -2, "getuserstatsuuid9", getHash("getuserstats_user_02"), 8, 2, "sponsor", 0]);
+
+    });
+
+    it("Should be able to get a 400 (No userID parameter)", (done: Done) => {
+        fetch(`${getbaseURL()}/api/userStats`)
+            .then(res => {
+                assert.strictEqual(res.status, 400);
+                done();
+            })
+            .catch(err => done(err));
+    });
+
+    it("Should be able to get user info", (done: Done) => {
+        fetch(`${getbaseURL()}/api/userStats?userID=getuserstats_user_01`)
+            .then(async res => {
+                assert.strictEqual(res.status, 200);
+                const expected = {
+                    userName: "Username user 01",
+                    userID: getHash("getuserstats_user_01"),
+                    sponsor: {
+                        minutesSaved: 1, segmentCount: 1,
+                    }, selfpromo: {
+                        minutesSaved: 2, segmentCount: 1,
+                    }, interaction: {
+                        minutesSaved: 3, segmentCount: 1,
+                    }, intro: {
+                        minutesSaved: 4, segmentCount: 1,
+                    }, outro: {
+                        minutesSaved: 5, segmentCount: 1,
+                    }, preview: {
+                        minutesSaved: 6, segmentCount: 1,
+                    }, music_offtopic: {
+                        minutesSaved: 7, segmentCount: 1,
+                    }, poi_highlight: {
+                        minutesSaved: 0, segmentCount: 1,
+                    },
+                };
+                const data = await res.json();
+                assert.deepStrictEqual(data, expected);
+                done();
+            })
+            .catch(err => done(err));
+    });
+
+    it("Should be able to get all zeroes for invalid userid", (done: Done) => {
+        fetch(`${getbaseURL()}/api/userStats?userID=getuserstats_user_invalid`)
+            .then(async res => {
+                assert.strictEqual(res.status, 200);
+                const data = await res.json();
+                for (const value in data) {
+                    if (data[value]?.minutesSaved || data[value]?.segmentCount) {
+                        done(`returned non-zero for ${value}`);
+                    }
+                }
+                done();
+            })
+            .catch(err => done(err));
+    });
+
+    it("Should be able to get all zeroes for only ignored segments", (done: Done) => {
+        fetch(`${getbaseURL()}/api/userStats?userID=getuserstats_user_02`)
+            .then(async res => {
+                assert.strictEqual(res.status, 200);
+                const data = await res.json();
+                for (const value in data) {
+                    if (data[value]?.minutesSaved || data[value]?.segmentCount) {
+                        done(`returned non-zero for ${value}`);
+                    }
+                }
+                done();
+            })
+            .catch(err => done(err));
+    });
+});