Add lock routes #3421
Add lock routes #3421
Conversation
|
We could use two columns in the lock tab there Attaching screenshot for reference
|
|
Still working on functionality, visibility will come next. |
|
I'm afraid to report the number of locks doesn't seem to work for me. Also, is lock review request supposed to work yet? Lock removal works fine, and i could set another lock, but doesn't seem to block in share page any longer. |
|
It should work - the change to I've updated to the latest master, I'll have a look soon. |
|
Looks like it's getting back 503 Service Unavailable errors, possibly related to DB request timeouts. |
|
Have in mind the main brew count function in admin returns always a 503, you might be reading that one as well. Better to disable that automatic query on page load for the moment. |
|
The addition of indexes on the database have greatly increased the speed of the lock functions. |
|
Well, with that, the lock count works, and i can see lock review requests. |
G-Ambatte
added
blocked
|
| const version = require('../../../package.json').version; | ||
|
|
||
| const addHeader = (request)=>request.set('Homebrewery-Version', global.version); | ||
| const addHeader = (request)=>request.set('Homebrewery-Version', version); |
There was a problem hiding this comment.
Not sure the purpose of this change. global.version works.
| router.get('/api/lock/count', mw.adminOnly, async (req, res)=>{ | ||
| try { | ||
| const countLocksQuery = { | ||
| lock : { $exists: true } | ||
| }; | ||
| const count = await HomebrewModel.countDocuments(countLocksQuery) | ||
| .then((result)=>{ | ||
| return result; | ||
| }); | ||
| return res.json({ | ||
| count | ||
| }); | ||
| } catch (error) { | ||
| console.error(error); | ||
| return res.json({ status: 'ERROR', detail: 'Unable to get lock count', error }); | ||
| } | ||
| }); |
There was a problem hiding this comment.
Might I suggest the following, and a similar pattern to the other try/catch blocks?
| router.get('/api/lock/count', mw.adminOnly, async (req, res)=>{ | |
| try { | |
| const countLocksQuery = { | |
| lock : { $exists: true } | |
| }; | |
| const count = await HomebrewModel.countDocuments(countLocksQuery) | |
| .then((result)=>{ | |
| return result; | |
| }); | |
| return res.json({ | |
| count | |
| }); | |
| } catch (error) { | |
| console.error(error); | |
| return res.json({ status: 'ERROR', detail: 'Unable to get lock count', error }); | |
| } | |
| }); | |
| router.get('/api/lock/count', mw.adminOnly, async (req, res)=>{ | |
| const countLocksQuery = { lock : { $exists: true } }; | |
| const count = await HomebrewModel.countDocuments(countLocksQuery); | |
| .catch((error)=>{ | |
| console.error(error); | |
| return res.json({ status: 'ERROR', detail: 'Unable to get lock count', error }); | |
| }); | |
| if (count) | |
| return res.json({count}); | |
| }); |
| return res.json({ status: 'LOCKED', detail: `Lock applied to brew ID ${brew.shareId} - ${brew.title}`, ...lock }); | ||
| } catch (error) { | ||
| console.error(error); | ||
| return res.json({ status: 'ERROR', error, message: `Unable to set lock on brew ${req.params.id}` }); |
There was a problem hiding this comment.
We should utilize our central error handling middleware. I.e., just throw the error here, and the error handler in app.js will automatically organize the error into a common format (include a stack trace, etc.), console.error it, and send it to the client.
This PR contributes towards Issue #3326.
This PR adds the following routes to the Admin API:
/admin/lock:GETreturns the number of documents in the collection that have thelock.lockedproperty set totrue./admin/lock/:id:POSTtakes a brew ID and a JSONlockobject; updates the identified brew with the properties of thelockobject./admin/unlock/:id:PUTtakes a brew ID; removes the lock from the identified brew/admin/lock/reviews:GETreturns a collection of documents that has thelock.lockedset totrueandlock.reviewRequestedexists./admin/lock/review/request/:id:PUTupdates the identified brew'slockobject with areviewRequestedproperty (current date/time). NON-ADMIN ROUTE/admin/lock/review/remove/:id:PUTupdates the identified brew'slockobject to remove thereviewRequestedproperty without removing the entirelock.