diff --git a/src/routes/getUserInfo.ts b/src/routes/getUserInfo.ts index 7fb3bf3..93dc7ad 100644 --- a/src/routes/getUserInfo.ts +++ b/src/routes/getUserInfo.ts @@ -88,31 +88,81 @@ async function dbGetLastSegmentForUser(userID: HashedUserID): Promise { + try { + const row = await db.prepare('get', `SELECT reason FROM "warnings" WHERE "userID" = ? AND "enabled" = 1 ORDER BY "issueTime" DESC LIMIT 1`, [userID]); + return row?.reason ?? ''; + } catch (err) { + Logger.error('Couldn\'t get reason for user ' + userID + '. returning blank'); + return ''; + } +} + +type cases = Record + +const executeIfFunction = (f: any) => + typeof f === 'function' ? f() : f; + +const objSwitch = (cases: cases) => (defaultCase: string) => (key: string) => + Object.prototype.hasOwnProperty.call(cases, key) ? cases[key] : defaultCase; + +const functionSwitch = (cases: cases) => (defaultCase: string) => (key: string) => + executeIfFunction(objSwitch(cases)(defaultCase)(key)); + +const dbGetValue = async (userID: HashedUserID, property: string): Promise => { + return functionSwitch({ + userID, + userName: dbGetUsername(userID), + ignoredSegmentCount: dbGetIgnoredSegmentCount(userID), + viewCount: dbGetViewsForUser(userID), + ignoredViewCount: dbGetIgnoredViewsForUser(userID), + warnings: dbGetWarningsForUser(userID), + warningReason: dbGetActiveWarningReasonForUser(userID), + reputation: getReputation(userID), + vip: isUserVIP(userID), + lastSegmentID: dbGetLastSegmentForUser(userID), + })("")(property); +}; + export async function getUserInfo(req: Request, res: Response): Promise { const userID = req.query.userID as UserID; const hashedUserID: HashedUserID = userID ? getHash(userID) : req.query.publicUserID as HashedUserID; + const allProperties: string[] = ["userID", "userName", "minutesSaved", "segmentCount", "ignoredSegmentCount", + "viewCount", "ignoredViewCount", "warnings", "warningReason", "reputation", + "vip", "lastSegmentID"]; + let paramValues: string[] = req.query.values + ? JSON.parse(req.query.values as string) + : req.query.value + ? Array.isArray(req.query.value) + ? req.query.value + : [req.query.value] + : allProperties; + if (!Array.isArray(paramValues)) { + return res.status(400).send("Invalid values JSON"); + } + // filter array to only include from allProperties + paramValues = paramValues.filter(param => allProperties.includes(param)); + if (paramValues.length === 0) { + // invalid values + return res.status(400).send("No valid values specified"); + } if (hashedUserID == undefined) { //invalid request - return res.status(400).send('Parameters are not valid'); + return res.status(400).send('Invalid userID or publicUserID parameter'); } const segmentsSummary = await dbGetSubmittedSegmentSummary(hashedUserID); + const responseObj = {} as Record; if (segmentsSummary) { - return res.send({ - userID: hashedUserID, - userName: await dbGetUsername(hashedUserID), - minutesSaved: segmentsSummary.minutesSaved, - segmentCount: segmentsSummary.segmentCount, - ignoredSegmentCount: await dbGetIgnoredSegmentCount(hashedUserID), - viewCount: await dbGetViewsForUser(hashedUserID), - ignoredViewCount: await dbGetIgnoredViewsForUser(hashedUserID), - warnings: await dbGetWarningsForUser(hashedUserID), - reputation: await getReputation(hashedUserID), - vip: await isUserVIP(hashedUserID), - lastSegmentID: await dbGetLastSegmentForUser(hashedUserID), - }); + for (const property of paramValues) { + 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("segmentCount")) responseObj["segmentCount"] = segmentsSummary.segmentCount; + res.send(responseObj); } else { - return res.sendStatus(400); + return res.sendStatus(404); } } diff --git a/test/cases/getUserInfo.ts b/test/cases/getUserInfo.ts index 2c21250..f726874 100644 --- a/test/cases/getUserInfo.ts +++ b/test/cases/getUserInfo.ts @@ -2,6 +2,7 @@ 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('getUserInfo', () => { before(async () => { @@ -18,10 +19,13 @@ describe('getUserInfo', () => { await db.prepare("run", sponsorTimesQuery, ['xxxyyyzzz', 1, 11, 2, 'uuid000007', getHash("getuserinfo_user_02"), 7, 10, 'sponsor', 1]); await db.prepare("run", sponsorTimesQuery, ['xxxyyyzzz', 1, 11, 2, 'uuid000008', getHash("getuserinfo_user_02"), 8, 10, 'sponsor', 1]); - const insertWarningQuery = 'INSERT INTO warnings ("userID", "issueTime", "issuerUserID", "enabled") VALUES (?, ?, ?, ?)'; - await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_0'), 10, 'getuserinfo_vip', 1]); - await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_1'), 10, 'getuserinfo_vip', 1]); - await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_1'), 10, 'getuserinfo_vip', 1]); + const insertWarningQuery = 'INSERT INTO warnings ("userID", "issueTime", "issuerUserID", "enabled", "reason") VALUES (?, ?, ?, ?, ?)'; + await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_0'), 10, 'getuserinfo_vip', 1, "warning0-0"]); + await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_1'), 20, 'getuserinfo_vip', 1, "warning1-0"]); + await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_1'), 30, 'getuserinfo_vip', 1, "warning1-1"]); + await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_2'), 40, 'getuserinfo_vip', 0, "warning2-0"]); + await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_3'), 50, 'getuserinfo_vip', 1, "warning3-0"]); + await db.prepare("run", insertWarningQuery, [getHash('getuserinfo_warning_3'), 60, 'getuserinfo_vip', 0, "warning3-1"]); }); it('Should be able to get a 200', (done: Done) => { @@ -74,7 +78,7 @@ describe('getUserInfo', () => { }); it('Should get warning data', (done: Done) => { - fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_0') + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_0&value=warnings') .then(async res => { if (res.status !== 200) { done('non 200 (' + res.status + ')'); @@ -88,7 +92,7 @@ describe('getUserInfo', () => { }); it('Should get warning data with public ID', (done: Done) => { - fetch(getbaseURL() + '/api/userInfo?publicUserID=' + getHash("getuserinfo_warning_0")) + fetch(getbaseURL() + `/api/userInfo?publicUserID=${getHash("getuserinfo_warning_0")}&values=["warnings"]`) .then(async res => { if (res.status !== 200) { done('non 200 (' + res.status + ')'); @@ -102,7 +106,7 @@ describe('getUserInfo', () => { }); it('Should get multiple warnings', (done: Done) => { - fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_1') + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_1&value=warnings') .then(async res => { if (res.status !== 200) { done('non 200 (' + res.status + ')'); @@ -116,7 +120,7 @@ describe('getUserInfo', () => { }); it('Should not get warnings if none', (done: Done) => { - fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_2') + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_2&value=warnings') .then(async res => { if (res.status !== 200) { done('non 200 (' + res.status + ')'); @@ -130,7 +134,7 @@ describe('getUserInfo', () => { }); it('Should done(userID for userName (No userName set)', (done: Done) => { - fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_user_02') + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_user_02&value=userName') .then(async res => { if (res.status !== 200) { done('non 200 (' + res.status + ')'); @@ -146,7 +150,7 @@ describe('getUserInfo', () => { }); it('Should return null segment if none', (done: Done) => { - fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_null') + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_null&value=lastSegmentID') .then(async res => { if (res.status !== 200) { done('non 200 (' + res.status + ')'); @@ -160,7 +164,7 @@ describe('getUserInfo', () => { }); it('Should return zeroes if userid does not exist', (done: Done) => { - fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_null') + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_null&value=lastSegmentID') .then(async res => { const data = await res.json(); for (const value in data) { @@ -172,4 +176,59 @@ describe('getUserInfo', () => { }) .catch(() => ("couldn't call endpoint")); }); + + it('Should get warning reason from from single enabled warning', (done: Done) => { + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_0&values=["warningReason"]') + .then(async res => { + assert.strictEqual(res.status, 200); + const data = await res.json(); + assert.strictEqual(data.warningReason, "warning0-0"); + done(); // pass + }) + .catch(err => done(err)); + }); + + it('Should get most recent warning from two enabled warnings', (done: Done) => { + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_1&value=warningReason') + .then(async res => { + assert.strictEqual(res.status, 200); + const data = await res.json(); + assert.strictEqual(data.warningReason, "warning1-1"); + done(); // pass + }) + .catch(err => done(err)); + }); + + it('Should not get disabled warning', (done: Done) => { + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_2&values=["warnings","warningReason"]') + .then(async res => { + assert.strictEqual(res.status, 200); + const data = await res.json(); + assert.strictEqual(data.warnings, 0); + assert.strictEqual(data.warningReason, ""); + done(); // pass + }) + .catch(err => done(err)); + }); + + it('Should not get newer disabled warning', (done: Done) => { + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_3&value=warnings&value=warningReason') + .then(async res => { + assert.strictEqual(res.status, 200); + const data = await res.json(); + assert.strictEqual(data.warnings, 1); + assert.strictEqual(data.warningReason, "warning3-0"); + done(); // pass + }) + .catch(err => done(err)); + }); + + it('Should get 400 if bad values specified', (done: Done) => { + fetch(getbaseURL() + '/api/userInfo?userID=getuserinfo_warning_3&value=invalid-value') + .then(async res => { + assert.strictEqual(res.status, 400); + done(); // pass + }) + .catch(err => done(err)); + }); });