Merge branch 'master' into SwappableThemes-ReorganizeFolderStructure

server/homebrew.api.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-lines */
 const _ = require('lodash');
 const HomebrewModel = require('./homebrew.model.js').model;
 const router = require('express').Router();
@@ -6,6 +7,7 @@ const GoogleActions = require('./googleActions.js');
 const Markdown = require('../shared/naturalcrit/markdown.js');
 const yaml = require('js-yaml');
 const asyncHandler = require('express-async-handler');
+const { nanoid } = require('nanoid');
 
 // const getTopBrews = (cb) => {
 // 	HomebrewModel.find().sort({ views: -1 }).limit(5).exec(function(err, brews) {
@@ -13,6 +15,53 @@ const asyncHandler = require('express-async-handler');
 // 	});
 // };
 
+const getBrew = (accessType)=>{
+	// Create middleware with the accessType passed in as part of the scope
+	return async (req, res, next)=>{
+		// Set the id and initial potential google id, where the google id is present on the existing brew.
+		let id = req.params.id, googleId = req.body?.googleId;
+
+		// If the id is longer than 12, then it's a google id + the edit id. This splits the longer id up.
+		if(id.length > 12) {
+			googleId = id.slice(0, -12);
+			id = id.slice(-12);
+		}
+		// Try to find the document in the Homebrewery database -- if it doesn't exist, that's fine.
+		let stub = await HomebrewModel.get(accessType === 'edit' ? { editId: id } : { shareId: id })
+			.catch((err)=>{
+				if(googleId) {
+					console.warn(`Unable to find document stub for ${accessType}Id ${id}`);
+				} else {
+					console.warn(err);
+				}
+			});
+		stub = stub?.toObject();
+
+		// If there is a google id, try to find the google brew
+		if(googleId || stub?.googleId) {
+			let googleError;
+			const googleBrew = await GoogleActions.getGoogleBrew(googleId || stub?.googleId, id, accessType)
+				.catch((err)=>{
+					console.warn(err);
+					googleError = err;
+				});
+			// If we can't find the google brew and there is a google id for the brew, throw an error.
+			if(!googleBrew) throw googleError;
+			// Combine the Homebrewery stub with the google brew, or if the stub doesn't exist just use the google brew
+			stub = stub ? _.assign({ ...excludeStubProps(stub), stubbed: true }, excludeGoogleProps(googleBrew)) : googleBrew;
+		}
+
+		// If after all of that we still don't have a brew, throw an exception
+		if(!stub) {
+			throw 'Brew not found in Homebrewery database or Google Drive';
+		}
+
+		req.brew = stub;
+
+		next();
+	};
+};
+
 const mergeBrewText = (brew)=>{
 	let text = brew.text;
 	if(brew.style !== undefined) {
@@ -33,15 +82,33 @@ const MAX_TITLE_LENGTH = 100;
 
 const getGoodBrewTitle = (text)=>{
 	const tokens = Markdown.marked.lexer(text);
- 	return (tokens.find((token)=>token.type == 'heading' ||	token.type == 'paragraph')?.text || 'No Title')
+ 	return (tokens.find((token)=>token.type === 'heading' || token.type === 'paragraph')?.text || 'No Title')
 				 .slice(0, MAX_TITLE_LENGTH);
 };
 
 const excludePropsFromUpdate = (brew)=>{
 	// Remove undesired properties
-	const propsToExclude = ['views', 'lastViewed'];
+	const modified = _.clone(brew);
+	const propsToExclude = ['_id', 'views', 'lastViewed', 'editId', 'shareId', 'googleId'];
 	for (const prop of propsToExclude) {
-		delete brew[prop];
+		delete modified[prop];
+	}
+	return modified;
+};
+
+const excludeGoogleProps = (brew)=>{
+	const modified = _.clone(brew);
+	const propsToExclude = ['tags', 'systems', 'published', 'authors', 'owner', 'views'];
+	for (const prop of propsToExclude) {
+		delete modified[prop];
+	}
+	return modified;
+};
+
+const excludeStubProps = (brew)=>{
+	const propsToExclude = ['text', 'textBin', 'renderer', 'pageCount', 'version'];
+	for (const prop of propsToExclude) {
+		brew[prop] = undefined;
 	}
 	return brew;
 };
@@ -55,33 +122,17 @@ const beforeNewSave = (account, brew)=>{
 	brew.text = mergeBrewText(brew);
 };
 
-const newLocalBrew = async (brew)=>{
-	const newHomebrew = new HomebrewModel(brew);
-	// Compress brew text to binary before saving
-	newHomebrew.textBin = zlib.deflateRawSync(newHomebrew.text);
-	// Delete the non-binary text field since it's not needed anymore
-	newHomebrew.text = undefined;
-
-	let saved = await newHomebrew.save()
-		.catch((err)=>{
-			console.error(err, err.toString(), err.stack);
-			throw `Error while creating new brew, ${err.toString()}`;
-		});
-
-	saved = saved.toObject();
-	saved.gDrive = false;
-	return saved;
-};
-
 const newGoogleBrew = async (account, brew, res)=>{
 	const oAuth2Client = GoogleActions.authCheck(account, res);
 
-	return await GoogleActions.newGoogleBrew(oAuth2Client, brew);
+	const newBrew = excludeGoogleProps(brew);
+
+	return await GoogleActions.newGoogleBrew(oAuth2Client, newBrew);
 };
 
 const newBrew = async (req, res)=>{
 	const brew = req.body;
-	const { transferToGoogle } = req.query;
+	const { saveToGoogle } = req.query;
 
 	delete brew.editId;
 	delete brew.shareId;
@@ -89,148 +140,179 @@ const newBrew = async (req, res)=>{
 
 	beforeNewSave(req.account, brew);
 
-	let saved;
-	if(transferToGoogle) {
-		saved = await newGoogleBrew(req.account, brew, res)
+	const newHomebrew = new HomebrewModel(brew);
+	newHomebrew.editId = nanoid(12);
+	newHomebrew.shareId = nanoid(12);
+
+	let googleId, saved;
+	if(saveToGoogle) {
+		googleId = await newGoogleBrew(req.account, newHomebrew, res)
 			.catch((err)=>{
-				res.status(err.status || err.response.status).send(err.message || err);
+				console.error(err);
+				res.status(err?.status || err?.response?.status || 500).send(err?.message || err);
 			});
+		if(!googleId) return;
+		excludeStubProps(newHomebrew);
+		newHomebrew.googleId = googleId;
 	} else {
-		saved = await newLocalBrew(brew)
-			.catch((err)=>{
-				res.status(500).send(err);
-			});
+		// Compress brew text to binary before saving
+		newHomebrew.textBin = zlib.deflateRawSync(newHomebrew.text);
+		// Delete the non-binary text field since it's not needed anymore
+		newHomebrew.text = undefined;
 	}
+
+	saved = await newHomebrew.save()
+		.catch((err)=>{
+			console.error(err, err.toString(), err.stack);
+			throw `Error while creating new brew, ${err.toString()}`;
+		});
 	if(!saved) return;
-	return res.status(200).send(saved);
+	saved = saved.toObject();
+
+	res.status(200).send(saved);
 };
 
 const updateBrew = async (req, res)=>{
-	let brew = excludePropsFromUpdate(req.body);
-	const { transferToGoogle, transferFromGoogle } = req.query;
+	// Initialize brew from request and body, destructure query params, set a constant for the google id, and set the initial value for the after-save method
+	let brew = _.assign(req.brew, excludePropsFromUpdate(req.body));
+	const { saveToGoogle, removeFromGoogle } = req.query;
+	const googleId = brew.googleId;
+	let afterSave = async ()=>true;
 
-	let saved;
-	if(brew.googleId && transferFromGoogle) {
-		beforeNewSave(req.account, brew);
+	brew.text = mergeBrewText(brew);
 
-		saved = await newLocalBrew(brew)
-			.catch((err)=>{
-				console.error(err);
-				res.status(500).send(err);
-			});
-		if(!saved) return;
+	if(brew.googleId && removeFromGoogle) {
+		// If the google id exists and we're removing it from google, set afterSave to delete the google brew and mark the brew's google id as undefined
+		afterSave = async ()=>{
+			return await deleteGoogleBrew(req.account, googleId, brew.editId, res)
+				.catch((err)=>{
+					console.error(err);
+					res.status(err?.status || err?.response?.status || 500).send(err.message || err);
+				});
+		};
 
-		await deleteGoogleBrew(req.account, `${brew.googleId}${brew.editId}`, res)
+		brew.googleId = undefined;
+	} else if(!brew.googleId && saveToGoogle) {
+		// If we don't have a google id and the user wants to save to google, create the google brew and set the google id on the brew
+		brew.googleId = await newGoogleBrew(req.account, excludeGoogleProps(brew), res)
 			.catch((err)=>{
 				console.error(err);
 				res.status(err.status || err.response.status).send(err.message || err);
 			});
-	} else if(!brew.googleId && transferToGoogle) {
-		saved = await newGoogleBrew(req.account, brew, res)
-			.catch((err)=>{
-				console.error(err);
-				res.status(err.status || err.response.status).send(err.message || err);
-			});
-		if(!saved) return;
-
-		await deleteLocalBrew(req.account, brew.editId)
-			.catch((err)=>{
-				console.error(err);
-				res.status(err.status).send(err.message);
-			});
+		if(!brew.googleId) return;
 	} else if(brew.googleId) {
-		brew.text = mergeBrewText(brew);
-
-		saved = await GoogleActions.updateGoogleBrew(brew)
+		// If the google id exists and no other actions are being performed, update the google brew
+		const updated = await GoogleActions.updateGoogleBrew(excludeGoogleProps(brew))
 			.catch((err)=>{
 				console.error(err);
-				res.status(err.response?.status || 500).send(err);
+				res.status(err?.response?.status || 500).send(err);
 			});
+		if(!updated) return;
+	}
+
+	if(brew.googleId) {
+		// If the google id exists after all those actions, exclude the props that are stored in google and aren't needed for rendering the brew items
+		excludeStubProps(brew);
 	} else {
-		const dbBrew = await HomebrewModel.get({ editId: req.params.id })
-			.catch((err)=>{
-				console.error(err);
-				return res.status(500).send('Error while saving');
-			});
-
-		brew = _.merge(dbBrew, brew);
-		brew.text = mergeBrewText(brew);
-
 		// Compress brew text to binary before saving
 		brew.textBin = zlib.deflateRawSync(brew.text);
 		// Delete the non-binary text field since it's not needed anymore
 		brew.text = undefined;
-		brew.updatedAt = new Date();
-
-		if(req.account) {
-			brew.authors = _.uniq(_.concat(brew.authors, req.account.username));
-		}
-
-		brew.markModified('authors');
-		brew.markModified('systems');
-
-		saved = await brew.save();
 	}
+	brew.updatedAt = new Date();
+
+	if(req.account) {
+		brew.authors = _.uniq(_.concat(brew.authors, req.account.username));
+	}
+
+	// Fetch the brew from the database again (if it existed there to begin with), and assign the existing brew to it
+	brew = _.assign(await HomebrewModel.findOne({ _id: brew._id }), brew);
+
+	if(!brew.markModified) {
+		// If it wasn't in the database, create a new db brew
+		brew = new HomebrewModel(brew);
+	}
+
+	brew.markModified('authors');
+	brew.markModified('systems');
+
+	// Save the database brew
+	const saved = await brew.save()
+		.catch((err)=>{
+			console.error(err);
+			res.status(err.status || 500).send(err.message || 'Unable to save brew to Homebrewery database');
+		});
 	if(!saved) return;
+	// Call and wait for afterSave to complete
+	const after = await afterSave();
+	if(!after) return;
 
-	if(!res.headersSent) return res.status(200).send(saved);
+	res.status(200).send(saved);
 };
 
-const deleteBrew = async (req, res)=>{
-	if(req.params.id.length > 12) {
-		const deleted = await deleteGoogleBrew(req.account, req.params.id, res)
-			.catch((err)=>{
-				res.status(500).send(err);
-			});
-		if(deleted) return res.status(200).send();
-	} else {
-		const deleted = await deleteLocalBrew(req.account, req.params.id)
-			.catch((err)=>{
-				res.status(err.status).send(err.message);
-			});
-		if(deleted) return res.status(200).send(deleted);
-		return res.status(200).send();
-	}
-};
-
-const deleteLocalBrew = async (account, id)=>{
-	const brew = await HomebrewModel.findOne({ editId: id });
-	if(!brew) {
-		throw { status: 404, message: 'Can not find homebrew with that id' };
-	}
-
-	if(account) {
-		// Remove current user as author
-		brew.authors = _.pull(brew.authors, account.username);
-		brew.markModified('authors');
-	}
-
-	if(brew.authors.length === 0) {
-		// Delete brew if there are no authors left
-		await brew.remove()
-			.catch((err)=>{
-				console.error(err);
-				throw { status: 500, message: 'Error while removing' };
-			});
-	} else {
-		// Otherwise, save the brew with updated author list
-		return await brew.save()
-			.catch((err)=>{
-				throw { status: 500, message: err };
-			});
-	}
-};
-
-const deleteGoogleBrew = async (account, id, res)=>{
+const deleteGoogleBrew = async (account, id, editId, res)=>{
 	const auth = await GoogleActions.authCheck(account, res);
-	await GoogleActions.deleteGoogleBrew(auth, id);
+	await GoogleActions.deleteGoogleBrew(auth, id, editId);
 	return true;
 };
 
-router.post('/api', asyncHandler(newBrew));
-router.put('/api/:id', asyncHandler(updateBrew));
-router.put('/api/update/:id', asyncHandler(updateBrew));
-router.delete('/api/:id', asyncHandler(deleteBrew));
-router.get('/api/remove/:id', asyncHandler(deleteBrew));
+const deleteBrew = async (req, res)=>{
+	let brew = req.brew;
+	const { googleId, editId } = brew;
+	const account = req.account;
+	const isOwner = account && (brew.authors.length === 0 || brew.authors[0] === account.username);
+	// If the user is the owner and the file is saved to google, mark the google brew for deletion
+	const shouldDeleteGoogleBrew = googleId && isOwner;
 
-module.exports = router;
+	if(brew._id) {
+		brew = _.assign(await HomebrewModel.findOne({ _id: brew._id }), brew);
+		if(account) {
+			// Remove current user as author
+			brew.authors = _.pull(brew.authors, account.username);
+			brew.markModified('authors');
+		}
+
+		if(brew.authors.length === 0) {
+			// Delete brew if there are no authors left
+			await brew.remove()
+				.catch((err)=>{
+					console.error(err);
+					throw { status: 500, message: 'Error while removing' };
+				});
+		} else {
+			if(shouldDeleteGoogleBrew) {
+				// When there are still authors remaining, we delete the google brew but store the full brew in the Homebrewery database
+				brew.googleId = undefined;
+				brew.textBin = zlib.deflateRawSync(brew.text);
+				brew.text = undefined;
+			}
+
+			// Otherwise, save the brew with updated author list
+			await brew.save()
+				.catch((err)=>{
+					throw { status: 500, message: err };
+				});
+		}
+	}
+	if(shouldDeleteGoogleBrew) {
+		const deleted = await deleteGoogleBrew(account, googleId, editId, res)
+			.catch((err)=>{
+				console.error(err);
+				res.status(500).send(err);
+			});
+		if(!deleted) return;
+	}
+
+	res.status(204).send();
+};
+
+router.post('/api', asyncHandler(newBrew));
+router.put('/api/:id', asyncHandler(getBrew('edit')), asyncHandler(updateBrew));
+router.put('/api/update/:id', asyncHandler(getBrew('edit')), asyncHandler(updateBrew));
+router.delete('/api/:id', asyncHandler(getBrew('edit')), asyncHandler(deleteBrew));
+router.get('/api/remove/:id', asyncHandler(getBrew('edit')), asyncHandler(deleteBrew));
+
+module.exports = {
+	homebrewApi : router,
+	getBrew
+};