From 719a0956ace4d06a90a8924e8379c5099ad9820c Mon Sep 17 00:00:00 2001 From: Michael C Date: Sun, 4 Jul 2021 17:03:28 -0400 Subject: [PATCH 1/8] add getLockCategories --- src/app.ts | 4 ++ src/routes/getLockCategories.ts | 28 +++++++++++ test/cases/getLockCategories.ts | 84 +++++++++++++++++++++++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 src/routes/getLockCategories.ts create mode 100644 test/cases/getLockCategories.ts diff --git a/src/app.ts b/src/app.ts index a9e4df6..7b05b31 100644 --- a/src/app.ts +++ b/src/app.ts @@ -33,6 +33,7 @@ import {postClearCache} from './routes/postClearCache'; import { addUnlistedVideo } from './routes/addUnlistedVideo'; import {postPurgeAllSegments} from './routes/postPurgeAllSegments'; import {getUserID} from './routes/getUserID'; +import {getLockCategories} from './routes/getLockCategories'; import ExpressPromiseRouter from 'express-promise-router'; export function createServer(callback: () => void) { @@ -155,6 +156,9 @@ function setupRoutes(router: Router) { // get userID from username router.get('/api/userID', getUserID); + // get lock categores from userID + router.get('/api/lockCategories', getLockCategories); + if (config.postgres) { router.get('/database', (req, res) => dumpDatabase(req, res, true)); router.get('/database.json', (req, res) => dumpDatabase(req, res, false)); diff --git a/src/routes/getLockCategories.ts b/src/routes/getLockCategories.ts new file mode 100644 index 0000000..13d1eac --- /dev/null +++ b/src/routes/getLockCategories.ts @@ -0,0 +1,28 @@ +import {db} from '../databases/databases'; +import {getHash} from '../utils/getHash'; +import {Logger} from '../utils/logger'; +import {Request, Response} from 'express'; +import { Category, CategoryActionType, DBSegment, HashedIP, IPAddress, OverlappingSegmentGroup, Segment, SegmentCache, SegmentUUID, Service, VideoData, VideoID, VideoIDHash, Visibility, VotableObject } from "../types/segments.model"; +import { UserID } from '../types/user.model'; + +export async function getLockCategories(req: Request, res: Response) { + const videoID = req.query.videoID as VideoID; + + if (videoID == undefined) { + //invalid request + return res.sendStatus(400); + } + + try { + // Get existing lock categories markers + let lockCategoryList = await db.prepare('all', 'SELECT "category", "userID" from "lockCategories" where "videoID" = ?', [videoID]) as {category: Category, userID: UserID}[] + if (lockCategoryList.length === 0 || !lockCategoryList[0]) { + return res.sendStatus(404); + } else { + return res.send(lockCategoryList) + } + } catch (err) { + Logger.error(err); + return res.sendStatus(500); + } +} diff --git a/test/cases/getLockCategories.ts b/test/cases/getLockCategories.ts new file mode 100644 index 0000000..27e342f --- /dev/null +++ b/test/cases/getLockCategories.ts @@ -0,0 +1,84 @@ +import fetch from 'node-fetch'; +import {Done, getbaseURL} from '../utils'; +import {getHash} from '../../src/utils/getHash'; +import {db} from '../../src/databases/databases'; + + +describe('lockCategoriesRecords', () => { + before(async () => { + const insertVipUserQuery = 'INSERT INTO "vipUsers" ("userID") VALUES (?)'; + await db.prepare("run", insertVipUserQuery, [getHash("VIPUser-getLockCategories")]); + + const insertLockCategoryQuery = 'INSERT INTO "lockCategories" ("userID", "videoID", "category") VALUES (?, ?, ?)'; + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-1', 'sponsor']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-1', 'intro']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-2', 'preview']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-3', 'nonmusic']); + }); + + it('Should update the database version when starting the application', async () => { + let version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; + if (version > 1) return; + else return 'Version isn\'t greater than 1. Version is ' + version; + }); + + it('Should be able to get multiple locks', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories?videoID=getLock-1') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 2) { + done(`Returned incorrect number of locks "${data.length}"`); + } else if (data[0].category !== "sponsor") { + done(`Returned incorrect category "${data[0].category}"`); + } else if (data[1].category !== "intro") { + done(`Returned incorrect category "${data[1].category}"`); + } else { + done(); // pass + } + } + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('Should be able to get single locks', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories?videoID=getLock-2') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 1) { + done('Returned incorrect number of locks "' + data.length + '"'); + } else if (data[0].category !== "preview") { + done(`Returned incorrect category "${data[0].category}"`); + } else { + done(); // pass + } + } + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('should return 404 if no lock exists', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories?videoID=getLock-0') + .then(res => { + if (res.status !== 404) done('non 404 (' + res.status + ')'); + else done(); // pass + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('should return 400 if no videoID specified', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories') + .then(res => { + if (res.status !== 400) done('non 400 (' + res.status + ')'); + else done(); // pass + }) + .catch(err => ("couldn't call endpoint")); + }); +}); From a860e96d3508528e7e4b8f94d2cbc16e403ed887 Mon Sep 17 00:00:00 2001 From: Michael C Date: Sun, 4 Jul 2021 23:33:12 -0400 Subject: [PATCH 2/8] getLockCategoresByHash --- databases/_upgrade_sponsorTimes_18.sql | 9 ++ src/app.ts | 4 + src/routes/getLockCategories.ts | 3 +- src/routes/getLockCategoriesByHash.ts | 27 +++++ test/cases/getLockCategories.ts | 6 +- test/cases/getLockCategoriesByHash.ts | 145 +++++++++++++++++++++++++ 6 files changed, 189 insertions(+), 5 deletions(-) create mode 100644 databases/_upgrade_sponsorTimes_18.sql create mode 100644 src/routes/getLockCategoriesByHash.ts create mode 100644 test/cases/getLockCategoriesByHash.ts diff --git a/databases/_upgrade_sponsorTimes_18.sql b/databases/_upgrade_sponsorTimes_18.sql new file mode 100644 index 0000000..f50d454 --- /dev/null +++ b/databases/_upgrade_sponsorTimes_18.sql @@ -0,0 +1,9 @@ +BEGIN TRANSACTION; + +/* Add hash field */ +ALTER TABLE "lockCategories" ADD "hashedVideoID" TEXT NOT NULL default ''; +UPDATE "lockCategories" SET "hashedVideoID" = sha256("videoID"); + +UPDATE "config" SET value = 18 WHERE key = 'version'; + +COMMIT; diff --git a/src/app.ts b/src/app.ts index 7b05b31..8e67bb1 100644 --- a/src/app.ts +++ b/src/app.ts @@ -34,6 +34,7 @@ import { addUnlistedVideo } from './routes/addUnlistedVideo'; import {postPurgeAllSegments} from './routes/postPurgeAllSegments'; import {getUserID} from './routes/getUserID'; import {getLockCategories} from './routes/getLockCategories'; +import {getLockCategoriesByHash} from './routes/getLockCategoriesByHash'; import ExpressPromiseRouter from 'express-promise-router'; export function createServer(callback: () => void) { @@ -159,6 +160,9 @@ function setupRoutes(router: Router) { // get lock categores from userID router.get('/api/lockCategories', getLockCategories); + // get privacy protecting lock categories functions + router.get('/api/lockCategories/:prefix', getLockCategoriesByHash); + if (config.postgres) { router.get('/database', (req, res) => dumpDatabase(req, res, true)); router.get('/database.json', (req, res) => dumpDatabase(req, res, false)); diff --git a/src/routes/getLockCategories.ts b/src/routes/getLockCategories.ts index 13d1eac..f94b9ec 100644 --- a/src/routes/getLockCategories.ts +++ b/src/routes/getLockCategories.ts @@ -1,8 +1,7 @@ import {db} from '../databases/databases'; -import {getHash} from '../utils/getHash'; import {Logger} from '../utils/logger'; import {Request, Response} from 'express'; -import { Category, CategoryActionType, DBSegment, HashedIP, IPAddress, OverlappingSegmentGroup, Segment, SegmentCache, SegmentUUID, Service, VideoData, VideoID, VideoIDHash, Visibility, VotableObject } from "../types/segments.model"; +import { Category, VideoID } from "../types/segments.model"; import { UserID } from '../types/user.model'; export async function getLockCategories(req: Request, res: Response) { diff --git a/src/routes/getLockCategoriesByHash.ts b/src/routes/getLockCategoriesByHash.ts new file mode 100644 index 0000000..34b3456 --- /dev/null +++ b/src/routes/getLockCategoriesByHash.ts @@ -0,0 +1,27 @@ +import {db} from '../databases/databases'; +import {Logger} from '../utils/logger'; +import {Request, Response} from 'express'; +import {hashPrefixTester} from '../utils/hashPrefixTester'; +import { Category, VideoID, VideoIDHash } from "../types/segments.model"; +import { UserID } from '../types/user.model'; + +export async function getLockCategoriesByHash(req: Request, res: Response): Promise { + let hashPrefix = req.params.prefix as VideoIDHash; + if (!hashPrefixTester(req.params.prefix)) { + return res.status(400).send("Hash prefix does not match format requirements."); // Exit early on faulty prefix + } + hashPrefix = hashPrefix.toLowerCase() as VideoIDHash; + + try { + // Get existing lock categories markers + let lockCategoryList = await db.prepare('all', 'SELECT * from "lockCategories" where "hashedVideoID" LIKE ? ORDER BY videoID', [hashPrefix + '%']) as {videoID: VideoID, userID: UserID,category: Category}[] + if (lockCategoryList.length === 0 || !lockCategoryList[0]) { + return res.sendStatus(404); + } else { + return res.send(lockCategoryList) + } + } catch (err) { + Logger.error(err); + return res.sendStatus(500); + } +} diff --git a/test/cases/getLockCategories.ts b/test/cases/getLockCategories.ts index 27e342f..1f62642 100644 --- a/test/cases/getLockCategories.ts +++ b/test/cases/getLockCategories.ts @@ -4,14 +4,14 @@ import {getHash} from '../../src/utils/getHash'; import {db} from '../../src/databases/databases'; -describe('lockCategoriesRecords', () => { +describe('getLockCategories', () => { before(async () => { const insertVipUserQuery = 'INSERT INTO "vipUsers" ("userID") VALUES (?)'; await db.prepare("run", insertVipUserQuery, [getHash("VIPUser-getLockCategories")]); const insertLockCategoryQuery = 'INSERT INTO "lockCategories" ("userID", "videoID", "category") VALUES (?, ?, ?)'; await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-1', 'sponsor']); - await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-1', 'intro']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-1', 'interaction']); await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-2', 'preview']); @@ -35,7 +35,7 @@ describe('lockCategoriesRecords', () => { done(`Returned incorrect number of locks "${data.length}"`); } else if (data[0].category !== "sponsor") { done(`Returned incorrect category "${data[0].category}"`); - } else if (data[1].category !== "intro") { + } else if (data[1].category !== "interaction") { done(`Returned incorrect category "${data[1].category}"`); } else { done(); // pass diff --git a/test/cases/getLockCategoriesByHash.ts b/test/cases/getLockCategoriesByHash.ts new file mode 100644 index 0000000..312f2ed --- /dev/null +++ b/test/cases/getLockCategoriesByHash.ts @@ -0,0 +1,145 @@ +import fetch from 'node-fetch'; +import {Done, getbaseURL} from '../utils'; +import {getHash} from '../../src/utils/getHash'; +import {db} from '../../src/databases/databases'; + + +describe('getLockCategoriesByHash', () => { + before(async () => { + const insertVipUserQuery = 'INSERT INTO "vipUsers" ("userID") VALUES (?)'; + await db.prepare("run", insertVipUserQuery, [getHash("VIPUser-getLockCategories")]); + + const insertLockCategoryQuery = 'INSERT INTO "lockCategories" ("userID", "videoID", "category", "hashedVideoID") VALUES (?, ?, ?, ?)'; + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-1', 'sponsor', '67a654898fda3a5541774aea345796c7709982bb6018cb08d22a18eeddccc1d0']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-1', 'interaction', '67a654898fda3a5541774aea345796c7709982bb6018cb08d22a18eeddccc1d0']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-2', 'preview', 'dff09120437b4bd594dffae5f3cde3cfc5f6099fb01d0ef4051919b2908d9a50']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-3', 'nonmusic', 'bf1b122fd5630e0df8626d00c4a95c58954ad715e5595b0f75a19ac131e28928']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-1', 'outro', 'b05a20424f24a53dac1b059fb78d861ba9723645026be2174c93a94f9106bb35']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-2', 'intro', 'b05acd1cd6ec7dffe5ffea64ada91ae7469d6db2ce21c7e30ad7fa62075d450']); + }); + + it('Database should be greater or equal to version 18', async () => { + let version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; + if (version >= 18) return; + else return 'Version isn\'t greater than 18. Version is ' + version; + }); + + it('Should be able to get multiple locks', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/67a65') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 2) { + done(`Returned incorrect number of locks "${data.length}"`); + } else if (data[0].category !== "sponsor") { + done(`Returned incorrect category "${data[0].category}"`); + } else if (data[1].category !== "interaction") { + done(`Returned incorrect category "${data[1].category}"`); + } else { + done(); // pass + } + } + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('Should be able to get single locks', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/dff09') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 1) { + done('Returned incorrect number of locks "' + data.length + '"'); + } else if (data[0].category !== "preview") { + done(`Returned incorrect category "${data[0].category}"`); + } else { + done(); // pass + } + } + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('Should be able to get by half full hash', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/bf1b122fd5630e0df8626d00c4a95c58') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 1) { + done('Returned incorrect number of locks "' + data.length + '"'); + } else if (data[0].category !== "nonmusic") { + done(`Returned incorrect category "${data[0].category}"`); + } else { + done(); // pass + } + } + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('Should be able to get multiple by similar hash', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/b05a') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 2) { + done(`Returned incorrect number of locks "${data.length}"`); + } else if (data[0].category !== "outro") { + done(`Returned incorrect category "${data[0].category}"`); + } else if (data[1].category !== "intro") { + done(`Returned incorrect category "${data[1].category}"`); + } else { + done(); // pass + } + } + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('should return 404 once hash prefix varies', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/aaaaaa') + .then(res => { + if (res.status !== 404) done('non 404 (' + res.status + ')'); + else done(); // pass + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('should return 404 if no lock exists', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/aaaaaa') + .then(res => { + if (res.status !== 404) done('non 404 (' + res.status + ')'); + else done(); // pass + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('should return 400 if no videoID specified', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/') + .then(res => { + if (res.status !== 400) done('non 400 (' + res.status + ')'); + else done(); // pass + }) + .catch(err => ("couldn't call endpoint")); + }); + + it('should return 400 if full hash sent', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/b05a20424f24a53dac1b059fb78d861ba9723645026be2174c93a94f9106bb35') + .then(res => { + if (res.status !== 400) done('non 400 (' + res.status + ')'); + else done(); // pass + }) + .catch(err => ("couldn't call endpoint")); + }); +}); From cef6d5f365c017450f620058f9562d29c9c41069 Mon Sep 17 00:00:00 2001 From: Michael C Date: Sun, 4 Jul 2021 23:36:47 -0400 Subject: [PATCH 3/8] fix eslint errors --- src/routes/getLockCategories.ts | 6 +++--- src/routes/getLockCategoriesByHash.ts | 4 ++-- test/cases/getLockCategories.ts | 10 +++++----- test/cases/getLockCategoriesByHash.ts | 18 +++++++++--------- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/routes/getLockCategories.ts b/src/routes/getLockCategories.ts index f94b9ec..bbe922c 100644 --- a/src/routes/getLockCategories.ts +++ b/src/routes/getLockCategories.ts @@ -4,7 +4,7 @@ import {Request, Response} from 'express'; import { Category, VideoID } from "../types/segments.model"; import { UserID } from '../types/user.model'; -export async function getLockCategories(req: Request, res: Response) { +export async function getLockCategories(req: Request, res: Response): Promise { const videoID = req.query.videoID as VideoID; if (videoID == undefined) { @@ -14,11 +14,11 @@ export async function getLockCategories(req: Request, res: Response) { try { // Get existing lock categories markers - let lockCategoryList = await db.prepare('all', 'SELECT "category", "userID" from "lockCategories" where "videoID" = ?', [videoID]) as {category: Category, userID: UserID}[] + const lockCategoryList = await db.prepare('all', 'SELECT "category", "userID" from "lockCategories" where "videoID" = ?', [videoID]) as {category: Category, userID: UserID}[]; if (lockCategoryList.length === 0 || !lockCategoryList[0]) { return res.sendStatus(404); } else { - return res.send(lockCategoryList) + return res.send(lockCategoryList); } } catch (err) { Logger.error(err); diff --git a/src/routes/getLockCategoriesByHash.ts b/src/routes/getLockCategoriesByHash.ts index 34b3456..b236a16 100644 --- a/src/routes/getLockCategoriesByHash.ts +++ b/src/routes/getLockCategoriesByHash.ts @@ -14,11 +14,11 @@ export async function getLockCategoriesByHash(req: Request, res: Response): Prom try { // Get existing lock categories markers - let lockCategoryList = await db.prepare('all', 'SELECT * from "lockCategories" where "hashedVideoID" LIKE ? ORDER BY videoID', [hashPrefix + '%']) as {videoID: VideoID, userID: UserID,category: Category}[] + const lockCategoryList = await db.prepare('all', 'SELECT * from "lockCategories" where "hashedVideoID" LIKE ? ORDER BY videoID', [hashPrefix + '%']) as {videoID: VideoID, userID: UserID,category: Category}[]; if (lockCategoryList.length === 0 || !lockCategoryList[0]) { return res.sendStatus(404); } else { - return res.send(lockCategoryList) + return res.send(lockCategoryList); } } catch (err) { Logger.error(err); diff --git a/test/cases/getLockCategories.ts b/test/cases/getLockCategories.ts index 1f62642..23b9e8a 100644 --- a/test/cases/getLockCategories.ts +++ b/test/cases/getLockCategories.ts @@ -19,7 +19,7 @@ describe('getLockCategories', () => { }); it('Should update the database version when starting the application', async () => { - let version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; + const version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; if (version > 1) return; else return 'Version isn\'t greater than 1. Version is ' + version; }); @@ -42,7 +42,7 @@ describe('getLockCategories', () => { } } }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('Should be able to get single locks', (done: Done) => { @@ -61,7 +61,7 @@ describe('getLockCategories', () => { } } }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('should return 404 if no lock exists', (done: Done) => { @@ -70,7 +70,7 @@ describe('getLockCategories', () => { if (res.status !== 404) done('non 404 (' + res.status + ')'); else done(); // pass }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('should return 400 if no videoID specified', (done: Done) => { @@ -79,6 +79,6 @@ describe('getLockCategories', () => { if (res.status !== 400) done('non 400 (' + res.status + ')'); else done(); // pass }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); }); diff --git a/test/cases/getLockCategoriesByHash.ts b/test/cases/getLockCategoriesByHash.ts index 312f2ed..a101b0a 100644 --- a/test/cases/getLockCategoriesByHash.ts +++ b/test/cases/getLockCategoriesByHash.ts @@ -22,7 +22,7 @@ describe('getLockCategoriesByHash', () => { }); it('Database should be greater or equal to version 18', async () => { - let version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; + const version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; if (version >= 18) return; else return 'Version isn\'t greater than 18. Version is ' + version; }); @@ -45,7 +45,7 @@ describe('getLockCategoriesByHash', () => { } } }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('Should be able to get single locks', (done: Done) => { @@ -64,7 +64,7 @@ describe('getLockCategoriesByHash', () => { } } }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('Should be able to get by half full hash', (done: Done) => { @@ -83,7 +83,7 @@ describe('getLockCategoriesByHash', () => { } } }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('Should be able to get multiple by similar hash', (done: Done) => { @@ -104,7 +104,7 @@ describe('getLockCategoriesByHash', () => { } } }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('should return 404 once hash prefix varies', (done: Done) => { @@ -113,7 +113,7 @@ describe('getLockCategoriesByHash', () => { if (res.status !== 404) done('non 404 (' + res.status + ')'); else done(); // pass }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('should return 404 if no lock exists', (done: Done) => { @@ -122,7 +122,7 @@ describe('getLockCategoriesByHash', () => { if (res.status !== 404) done('non 404 (' + res.status + ')'); else done(); // pass }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('should return 400 if no videoID specified', (done: Done) => { @@ -131,7 +131,7 @@ describe('getLockCategoriesByHash', () => { if (res.status !== 400) done('non 400 (' + res.status + ')'); else done(); // pass }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); it('should return 400 if full hash sent', (done: Done) => { @@ -140,6 +140,6 @@ describe('getLockCategoriesByHash', () => { if (res.status !== 400) done('non 400 (' + res.status + ')'); else done(); // pass }) - .catch(err => ("couldn't call endpoint")); + .catch(() => ("couldn't call endpoint")); }); }); From 9a4cd431e8eacad2202bfde993fddc52423c598c Mon Sep 17 00:00:00 2001 From: Michael C Date: Mon, 5 Jul 2021 02:33:32 -0400 Subject: [PATCH 4/8] rewrite getLockCategores to new spec --- src/routes/getLockCategories.ts | 14 +++--- src/routes/getLockCategoriesByHash.ts | 43 +++++++++++++++--- test/cases/getLockCategories.ts | 20 ++++----- test/cases/getLockCategoriesByHash.ts | 65 ++++++++++++++++++++------- 4 files changed, 101 insertions(+), 41 deletions(-) diff --git a/src/routes/getLockCategories.ts b/src/routes/getLockCategories.ts index bbe922c..e27acea 100644 --- a/src/routes/getLockCategories.ts +++ b/src/routes/getLockCategories.ts @@ -2,7 +2,6 @@ import {db} from '../databases/databases'; import {Logger} from '../utils/logger'; import {Request, Response} from 'express'; import { Category, VideoID } from "../types/segments.model"; -import { UserID } from '../types/user.model'; export async function getLockCategories(req: Request, res: Response): Promise { const videoID = req.query.videoID as VideoID; @@ -14,12 +13,13 @@ export async function getLockCategories(req: Request, res: Response): Promise entry.category); + return res.send({ + categories + }); } catch (err) { Logger.error(err); return res.sendStatus(500); diff --git a/src/routes/getLockCategoriesByHash.ts b/src/routes/getLockCategoriesByHash.ts index b236a16..0e85990 100644 --- a/src/routes/getLockCategoriesByHash.ts +++ b/src/routes/getLockCategoriesByHash.ts @@ -3,7 +3,38 @@ import {Logger} from '../utils/logger'; import {Request, Response} from 'express'; import {hashPrefixTester} from '../utils/hashPrefixTester'; import { Category, VideoID, VideoIDHash } from "../types/segments.model"; -import { UserID } from '../types/user.model'; + +interface byHashLockResult { + videoID: VideoID, + hash: VideoIDHash, + categories: Category[] +} + +interface DBLock { + videoID: VideoID, + hash: VideoIDHash, + category: Category +} + +const mergeLocks = (source: DBLock[]) => { + const dest: byHashLockResult[] = []; + for (const obj of source) { + // videoID already exists + const destMatch = dest.find(s => s.videoID === obj.videoID); + if (destMatch) { + // push to categories + destMatch.categories.push(obj.category); + } else { + dest.push({ + videoID: obj.videoID, + hash: obj.hash, + categories: [obj.category] + }); + } + } + return dest; +}; + export async function getLockCategoriesByHash(req: Request, res: Response): Promise { let hashPrefix = req.params.prefix as VideoIDHash; @@ -14,12 +45,10 @@ export async function getLockCategoriesByHash(req: Request, res: Response): Prom try { // Get existing lock categories markers - const lockCategoryList = await db.prepare('all', 'SELECT * from "lockCategories" where "hashedVideoID" LIKE ? ORDER BY videoID', [hashPrefix + '%']) as {videoID: VideoID, userID: UserID,category: Category}[]; - if (lockCategoryList.length === 0 || !lockCategoryList[0]) { - return res.sendStatus(404); - } else { - return res.send(lockCategoryList); - } + const lockedRows = await db.prepare('all', 'SELECT "videoID", "hashedVideoID" as "hash", "category" from "lockCategories" where "hashedVideoID" LIKE ?', [hashPrefix + '%']) as DBLock[]; + if (lockedRows.length === 0 || !lockedRows[0]) return res.sendStatus(404); + // merge all locks + return res.send(mergeLocks(lockedRows)); } catch (err) { Logger.error(err); return res.sendStatus(500); diff --git a/test/cases/getLockCategories.ts b/test/cases/getLockCategories.ts index 23b9e8a..177710e 100644 --- a/test/cases/getLockCategories.ts +++ b/test/cases/getLockCategories.ts @@ -31,12 +31,12 @@ describe('getLockCategories', () => { done("non 200"); } else { const data = await res.json(); - if (data.length !== 2) { - done(`Returned incorrect number of locks "${data.length}"`); - } else if (data[0].category !== "sponsor") { - done(`Returned incorrect category "${data[0].category}"`); - } else if (data[1].category !== "interaction") { - done(`Returned incorrect category "${data[1].category}"`); + if (data.categories.length !== 2) { + done(`Returned incorrect number of locks "${data.categories.length}"`); + } else if (data.categories[0] !== "sponsor") { + done(`Returned incorrect category "${data.categories[0]}"`); + } else if (data.categories[1] !== "interaction") { + done(`Returned incorrect category "${data.categories[1]}"`); } else { done(); // pass } @@ -52,10 +52,10 @@ describe('getLockCategories', () => { done("non 200"); } else { const data = await res.json(); - if (data.length !== 1) { - done('Returned incorrect number of locks "' + data.length + '"'); - } else if (data[0].category !== "preview") { - done(`Returned incorrect category "${data[0].category}"`); + if (data.categories.length !== 1) { + done('Returned incorrect number of locks "' + data.categories.length + '"'); + } else if (data.categories[0] !== "preview") { + done(`Returned incorrect category "${data.categories[0].category}"`); } else { done(); // pass } diff --git a/test/cases/getLockCategoriesByHash.ts b/test/cases/getLockCategoriesByHash.ts index a101b0a..585c08e 100644 --- a/test/cases/getLockCategoriesByHash.ts +++ b/test/cases/getLockCategoriesByHash.ts @@ -19,6 +19,7 @@ describe('getLockCategoriesByHash', () => { await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-1', 'outro', 'b05a20424f24a53dac1b059fb78d861ba9723645026be2174c93a94f9106bb35']); await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-2', 'intro', 'b05acd1cd6ec7dffe5ffea64ada91ae7469d6db2ce21c7e30ad7fa62075d450']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-2', 'preview', 'b05acd1cd6ec7dffe5ffea64ada91ae7469d6db2ce21c7e30ad7fa62075d450']); }); it('Database should be greater or equal to version 18', async () => { @@ -27,19 +28,23 @@ describe('getLockCategoriesByHash', () => { else return 'Version isn\'t greater than 18. Version is ' + version; }); - it('Should be able to get multiple locks', (done: Done) => { + it('Should be able to get multiple locks in one object', (done: Done) => { fetch(getbaseURL() + '/api/lockCategories/67a65') .then(async res => { if (res.status !== 200) { done("non 200"); } else { const data = await res.json(); - if (data.length !== 2) { - done(`Returned incorrect number of locks "${data.length}"`); - } else if (data[0].category !== "sponsor") { - done(`Returned incorrect category "${data[0].category}"`); - } else if (data[1].category !== "interaction") { - done(`Returned incorrect category "${data[1].category}"`); + if (data.length !== 1) { + done(`Returned incorrect number of videos "${data.length}"`); + } else if (data[0].videoID !== "getLockHash-1") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[0].hash !== getHash("getLockHash-1", 1)) { + done(`Returned incorrect hash "${data[0].hash}"`); + } else if (data[0].categories[0] !== "sponsor") { + done(`Returned incorrect category "${data[0].categories[0]}"`); + } else if (data[0].categories[1] !== "interaction") { + done(`Returned incorrect category "${data[0].categories[1]}"`); } else { done(); // pass } @@ -48,7 +53,7 @@ describe('getLockCategoriesByHash', () => { .catch(() => ("couldn't call endpoint")); }); - it('Should be able to get single locks', (done: Done) => { + it('Should be able to get single lock', (done: Done) => { fetch(getbaseURL() + '/api/lockCategories/dff09') .then(async res => { if (res.status !== 200) { @@ -56,9 +61,15 @@ describe('getLockCategoriesByHash', () => { } else { const data = await res.json(); if (data.length !== 1) { - done('Returned incorrect number of locks "' + data.length + '"'); - } else if (data[0].category !== "preview") { - done(`Returned incorrect category "${data[0].category}"`); + done('Returned incorrect number of videos "' + data.length + '"'); + } else if (data[0].videoID !== "getLockHash-2") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[0].hash !== getHash("getLockHash-2", 1)) { + done(`Returned incorrect hashedVideoID hash "${data[0].hash}"`); + } else if (data[0].categories.length !== 1) { + done(`Returned incorrect number of categories "${data[0].categories.length}"`); + } else if (data[0].categories[0] !== "preview") { + done(`Returned incorrect category "${data[0].categories[0]}"`); } else { done(); // pass } @@ -75,9 +86,15 @@ describe('getLockCategoriesByHash', () => { } else { const data = await res.json(); if (data.length !== 1) { - done('Returned incorrect number of locks "' + data.length + '"'); - } else if (data[0].category !== "nonmusic") { - done(`Returned incorrect category "${data[0].category}"`); + done('Returned incorrect number of videos "' + data.length + '"'); + } else if (data[0].videoID !== "getLockHash-3") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[0].hash !== getHash("getLockHash-3", 1)) { + done(`Returned incorrect hashedVideoID hash "${data[0].hash}"`); + } else if (data[0].categories.length !== 1) { + done(`Returned incorrect number of categories "${data[0].categories.length}"`); + } else if (data[0].categories[0] !== "nonmusic") { + done(`Returned incorrect category "${data[0].categories[0]}"`); } else { done(); // pass } @@ -86,7 +103,7 @@ describe('getLockCategoriesByHash', () => { .catch(() => ("couldn't call endpoint")); }); - it('Should be able to get multiple by similar hash', (done: Done) => { + it('Should be able to get multiple by similar hash with multiple categories', (done: Done) => { fetch(getbaseURL() + '/api/lockCategories/b05a') .then(async res => { if (res.status !== 200) { @@ -95,9 +112,23 @@ describe('getLockCategoriesByHash', () => { const data = await res.json(); if (data.length !== 2) { done(`Returned incorrect number of locks "${data.length}"`); - } else if (data[0].category !== "outro") { + } else if (data[0].videoID !== "fakehash-1") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[1].videoID !== "fakehash-2") { + done(`Returned incorrect videoID "${data[1].videoID}"`); + } else if (data[0].hash !== "b05a20424f24a53dac1b059fb78d861ba9723645026be2174c93a94f9106bb35") { + done(`Returned incorrect hashedVideoID hash "${data[0].hash}"`); + } else if (data[1].hash !== "b05acd1cd6ec7dffe5ffea64ada91ae7469d6db2ce21c7e30ad7fa62075d450") { + done(`Returned incorrect hashedVideoID hash "${data[1].hash}"`); + } else if (data[0].categories.length !== 1) { + done(`Returned incorrect number of categories "${data[0].categories.length}"`); + } else if (data[1].categories.length !== 2) { + done(`Returned incorrect number of categories "${data[1].categories.length}"`); + } else if (data[0].categories[0] !== "outro") { done(`Returned incorrect category "${data[0].category}"`); - } else if (data[1].category !== "intro") { + } else if (data[1].categories[0] !== "intro") { + done(`Returned incorrect category "${data[1].category}"`); + } else if (data[1].categories[1] !== "preview") { done(`Returned incorrect category "${data[1].category}"`); } else { done(); // pass From 351c89f235d598193b8e70799b3b639dee771e81 Mon Sep 17 00:00:00 2001 From: Michael C Date: Mon, 5 Jul 2021 02:40:17 -0400 Subject: [PATCH 5/8] add types from ajayyyy/lru-diskcache - added existing types - disbled no-unused-vars since there is no other way --- src/utils/diskCache.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/utils/diskCache.ts b/src/utils/diskCache.ts index 5e08603..b653fc5 100644 --- a/src/utils/diskCache.ts +++ b/src/utils/diskCache.ts @@ -8,6 +8,7 @@ if (config.diskCache) { DiskCache.init(); } else { DiskCache = { + /* eslint-disable @typescript-eslint/no-unused-vars */ // constructor(rootPath, options): {}; init(): void { return; }, @@ -16,16 +17,17 @@ if (config.diskCache) { has(key: string): boolean { return false; }, - get(key: string, opts): string { return null; }, + get(key: string, opts?: {encoding?: string}): string { return null; }, // Returns size - set(key: string, dataOrSteam): Promise { return new Promise(() => 0); }, + set(key: string, dataOrSteam: string): Promise { return new Promise(() => 0); }, del(key: string): void { return; }, size(): number { return 0; }, prune(): void {return; }, + /* eslint-enable @typescript-eslint/no-unused-vars */ }; } From d29c9613b92afa860aec551135711c6d84cb8022 Mon Sep 17 00:00:00 2001 From: Michael C Date: Mon, 5 Jul 2021 02:59:01 -0400 Subject: [PATCH 6/8] type config & remove await from memoryCache --- src/config.ts | 1 - src/types/config.model.ts | 1 + src/utils/createMemoryCache.ts | 6 +++--- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/config.ts b/src/config.ts index ab60804..1e900b9 100644 --- a/src/config.ts +++ b/src/config.ts @@ -84,7 +84,6 @@ addDefaults(config, { function addDefaults(config: SBSConfig, defaults: SBSConfig) { for (const key in defaults) { if (!Object.prototype.hasOwnProperty.call(config, key)) { - // @ts-ignore config[key] = defaults[key]; } } diff --git a/src/types/config.model.ts b/src/types/config.model.ts index 3685919..1dabdbe 100644 --- a/src/types/config.model.ts +++ b/src/types/config.model.ts @@ -3,6 +3,7 @@ import * as redis from 'redis'; import { CacheOptions } from "@ajayyy/lru-diskcache"; export interface SBSConfig { + [index: string]: any port: number; mockPort?: number; globalSalt: string; diff --git a/src/utils/createMemoryCache.ts b/src/utils/createMemoryCache.ts index ce26b00..bd7b207 100644 --- a/src/utils/createMemoryCache.ts +++ b/src/utils/createMemoryCache.ts @@ -1,4 +1,4 @@ -export function createMemoryCache(memoryFn: (...args: any[]) => void, cacheTimeMs: number) { +export function createMemoryCache(memoryFn: (...args: any[]) => void, cacheTimeMs: number): any { if (isNaN(cacheTimeMs)) cacheTimeMs = 0; // holds the promise results @@ -22,8 +22,8 @@ export function createMemoryCache(memoryFn: (...args: any[]) => void, cacheTimeM } } // create new promise - const promise = new Promise(async (resolve) => { - resolve((await memoryFn(...args))); + const promise = new Promise((resolve) => { + resolve(memoryFn(...args)); }); // store promise reference until fulfilled promiseMemory.set(cacheKey, promise); From d5204e98130e5091605e40b22a7e35a94624dc6b Mon Sep 17 00:00:00 2001 From: Michael C Date: Mon, 5 Jul 2021 03:14:05 -0400 Subject: [PATCH 7/8] lint & fix tests --- package.json | 4 ++-- test/cases/getSkipSegments.ts | 4 ++-- test/cases/getSkipSegmentsByHash.ts | 6 +++--- test/cases/getUserInfo.ts | 2 +- test/cases/setUsername.ts | 1 + test/mocks.ts | 3 ++- test/test.ts | 6 +++--- 7 files changed, 14 insertions(+), 12 deletions(-) diff --git a/package.json b/package.json index 06381b4..fd9280b 100644 --- a/package.json +++ b/package.json @@ -9,8 +9,8 @@ "dev:bash": "nodemon -x 'npm test ; npm start'", "start": "ts-node src/index.ts", "tsc": "tsc -p tsconfig.json", - "lint": "eslint src", - "lint:fix": "eslint src --fix" + "lint": "eslint src test", + "lint:fix": "eslint src test --fix" }, "author": "Ajay Ramachandran", "license": "MIT", diff --git a/test/cases/getSkipSegments.ts b/test/cases/getSkipSegments.ts index c4a741c..407ce3e 100644 --- a/test/cases/getSkipSegments.ts +++ b/test/cases/getSkipSegments.ts @@ -326,7 +326,7 @@ describe('getSkipSegments', () => { else done(); } }) - .catch(err => done("Couldn't call endpoint")); + .catch(() => done("Couldn't call endpoint")); }); it('Should be able to get specific segments with repeating requiredSegment', (done: Done) => { @@ -341,6 +341,6 @@ describe('getSkipSegments', () => { else done(); } }) - .catch(err => done("Couldn't call endpoint")); + .catch(() => done("Couldn't call endpoint")); }); }); diff --git a/test/cases/getSkipSegmentsByHash.ts b/test/cases/getSkipSegmentsByHash.ts index 1aeb780..e2891ab 100644 --- a/test/cases/getSkipSegmentsByHash.ts +++ b/test/cases/getSkipSegmentsByHash.ts @@ -252,7 +252,7 @@ describe('getSegmentsByHash', () => { } } }) - .catch(err => ("Couldn't call endpoint")); + .catch(() => ("Couldn't call endpoint")); }); it('Should be able to get specific segments with requiredSegments', (done: Done) => { @@ -268,7 +268,7 @@ describe('getSegmentsByHash', () => { else done(); } }) - .catch(err => done("Couldn't call endpoint")); + .catch(() => done("Couldn't call endpoint")); }); it('Should be able to get specific segments with repeating requiredSegment', (done: Done) => { @@ -284,6 +284,6 @@ describe('getSegmentsByHash', () => { else done(); } }) - .catch(err => done("Couldn't call endpoint")); + .catch(() => done("Couldn't call endpoint")); }); }); diff --git a/test/cases/getUserInfo.ts b/test/cases/getUserInfo.ts index f641e1b..2c21250 100644 --- a/test/cases/getUserInfo.ts +++ b/test/cases/getUserInfo.ts @@ -165,7 +165,7 @@ describe('getUserInfo', () => { const data = await res.json(); for (const value in data) { if (data[value] === null && value !== "lastSegmentID") { - done(`returned null for ${value}`) + done(`returned null for ${value}`); } } done(); // pass diff --git a/test/cases/setUsername.ts b/test/cases/setUsername.ts index 5216dd0..b3e5ad4 100644 --- a/test/cases/setUsername.ts +++ b/test/cases/setUsername.ts @@ -46,6 +46,7 @@ async function getLastLogUserNameChange(userID: string) { } function wellFormatUserName(userName: string) { + // eslint-disable-next-line no-control-regex return userName.replace(/[\u0000-\u001F\u007F-\u009F]/g, ''); } diff --git a/test/mocks.ts b/test/mocks.ts index dfa449b..b96861b 100644 --- a/test/mocks.ts +++ b/test/mocks.ts @@ -1,5 +1,6 @@ import express from 'express'; import {config} from '../src/config'; +import { Server } from 'http'; const app = express(); @@ -46,6 +47,6 @@ app.post('/CustomWebhook', (req, res) => { res.sendStatus(200); }); -export function createMockServer(callback: () => void) { +export function createMockServer(callback: () => void): Server { return app.listen(config.mockPort, callback); } diff --git a/test/test.ts b/test/test.ts index 59fd5f0..bba97ab 100644 --- a/test/test.ts +++ b/test/test.ts @@ -18,15 +18,15 @@ async function init() { })); // delete old test database - if (fs.existsSync(config.db)) fs.unlinkSync(config.db) + if (fs.existsSync(config.db)) fs.unlinkSync(config.db); if (fs.existsSync(config.privateDB)) fs.unlinkSync(config.privateDB); await initDb(); const dbMode = config.mysql ? 'mysql' : config.postgres ? 'postgres' - : 'sqlite' - Logger.info('Database Mode: ' + dbMode) + : 'sqlite'; + Logger.info('Database Mode: ' + dbMode); // Instantiate a Mocha instance. const mocha = new Mocha(); From c3dcd583906ba7954e9c69c5e9db87bd18520bfe Mon Sep 17 00:00:00 2001 From: Ajay Ramachandran Date: Mon, 5 Jul 2021 13:25:54 -0400 Subject: [PATCH 8/8] Rename type --- src/routes/getLockCategoriesByHash.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/routes/getLockCategoriesByHash.ts b/src/routes/getLockCategoriesByHash.ts index 0e85990..90772b2 100644 --- a/src/routes/getLockCategoriesByHash.ts +++ b/src/routes/getLockCategoriesByHash.ts @@ -4,7 +4,7 @@ import {Request, Response} from 'express'; import {hashPrefixTester} from '../utils/hashPrefixTester'; import { Category, VideoID, VideoIDHash } from "../types/segments.model"; -interface byHashLockResult { +interface LockResultByHash { videoID: VideoID, hash: VideoIDHash, categories: Category[] @@ -17,7 +17,7 @@ interface DBLock { } const mergeLocks = (source: DBLock[]) => { - const dest: byHashLockResult[] = []; + const dest: LockResultByHash[] = []; for (const obj of source) { // videoID already exists const destMatch = dest.find(s => s.videoID === obj.videoID);