0
0
mirror of https://github.com/naturalcrit/homebrewery.git synced 2025-12-31 02:12:43 +00:00

Merge branch 'master' into issue_4201

This commit is contained in:
David Bolack
2025-10-03 18:47:54 -05:00
8 changed files with 129 additions and 107 deletions

View File

@@ -75,8 +75,9 @@ it using the two commands:
1. `npm install` 1. `npm install`
1. `npm start` 1. `npm start`
You should now be able to go to [http://localhost:8000](http://localhost:8000) When the Homebrewery server is started for the first time, it will modify the database to create the indexes required for better Homebrewery performance. This may take a few moments to complete for each index, dependent on how much content is in your local database - a brand new, empty database should be done in seconds.
in your browser and use The Homebrewery offline.
On completion, you should be able to go to [http://localhost:8000](http://localhost:8000) in your browser and use The Homebrewery offline.
If you had any issue at all, here are some links that may be useful: If you had any issue at all, here are some links that may be useful:
- [Course](https://learn.mongodb.com/courses/m103-basic-cluster-administration) on cluster administration, useful for beginners - [Course](https://learn.mongodb.com/courses/m103-basic-cluster-administration) on cluster administration, useful for beginners
@@ -145,3 +146,4 @@ your contribution to the project, please join our [gitter chat][gitter-url].
[github-pr-docs-url]: https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request [github-pr-docs-url]: https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request
[gitter-url]: https://gitter.im/naturalcrit/Lobby [gitter-url]: https://gitter.im/naturalcrit/Lobby

View File

@@ -40,11 +40,8 @@ const Editor = createClass({
style : '' style : ''
}, },
onTextChange : ()=>{}, onBrewChange : ()=>{},
onStyleChange : ()=>{}, reportError : ()=>{},
onMetaChange : ()=>{},
onSnipChange : ()=>{},
reportError : ()=>{},
onCursorPageChange : ()=>{}, onCursorPageChange : ()=>{},
onViewPageChange : ()=>{}, onViewPageChange : ()=>{},
@@ -438,7 +435,7 @@ const Editor = createClass({
language='gfm' language='gfm'
view={this.state.view} view={this.state.view}
value={this.props.brew.text} value={this.props.brew.text}
onChange={this.props.onTextChange} onChange={this.props.onBrewChange('text')}
editorTheme={this.state.editorTheme} editorTheme={this.state.editorTheme}
rerenderParent={this.rerenderParent} rerenderParent={this.rerenderParent}
style={{ height: `calc(100% - ${this.state.snippetbarHeight}px)` }} /> style={{ height: `calc(100% - ${this.state.snippetbarHeight}px)` }} />
@@ -451,7 +448,7 @@ const Editor = createClass({
language='css' language='css'
view={this.state.view} view={this.state.view}
value={this.props.brew.style ?? DEFAULT_STYLE_TEXT} value={this.props.brew.style ?? DEFAULT_STYLE_TEXT}
onChange={this.props.onStyleChange} onChange={this.props.onBrewChange('style')}
enableFolding={true} enableFolding={true}
editorTheme={this.state.editorTheme} editorTheme={this.state.editorTheme}
rerenderParent={this.rerenderParent} rerenderParent={this.rerenderParent}
@@ -467,7 +464,7 @@ const Editor = createClass({
<MetadataEditor <MetadataEditor
metadata={this.props.brew} metadata={this.props.brew}
themeBundle={this.props.themeBundle} themeBundle={this.props.themeBundle}
onChange={this.props.onMetaChange} onChange={this.props.onBrewChange('metadata')}
reportError={this.props.reportError} reportError={this.props.reportError}
userThemes={this.props.userThemes}/> userThemes={this.props.userThemes}/>
</>; </>;
@@ -481,7 +478,7 @@ const Editor = createClass({
language='gfm' language='gfm'
view={this.state.view} view={this.state.view}
value={this.props.brew.snippets} value={this.props.brew.snippets}
onChange={this.props.onSnipChange} onChange={this.props.onBrewChange('snippets')}
enableFolding={true} enableFolding={true}
editorTheme={this.state.editorTheme} editorTheme={this.state.editorTheme}
rerenderParent={this.rerenderParent} rerenderParent={this.rerenderParent}

View File

@@ -39,6 +39,11 @@ const SAVE_TIMEOUT = 10000;
const UNSAVED_WARNING_TIMEOUT = 900000; //Warn user afer 15 minutes of unsaved changes const UNSAVED_WARNING_TIMEOUT = 900000; //Warn user afer 15 minutes of unsaved changes
const UNSAVED_WARNING_POPUP_TIMEOUT = 4000; //Show the warning for 4 seconds const UNSAVED_WARNING_POPUP_TIMEOUT = 4000; //Show the warning for 4 seconds
const BREWKEY = 'homebrewery-new';
const STYLEKEY = 'homebrewery-new-style';
const SNIPKEY = 'homebrewery-new-snippets';
const METAKEY = 'homebrewery-new-meta';
const EditPage = (props)=>{ const EditPage = (props)=>{
props = { props = {
brew : DEFAULT_BREW_LOAD, brew : DEFAULT_BREW_LOAD,
@@ -69,6 +74,8 @@ const EditPage = (props)=>{
const trySaveRef = useRef(trySave); // CTRL+S listener lives outside React and needs ref to use trySave with latest copy of brew const trySaveRef = useRef(trySave); // CTRL+S listener lives outside React and needs ref to use trySave with latest copy of brew
const unsavedChangesRef = useRef(unsavedChanges); // Similarly, onBeforeUnload lives outside React and needs ref to unsavedChanges const unsavedChangesRef = useRef(unsavedChanges); // Similarly, onBeforeUnload lives outside React and needs ref to unsavedChanges
const useLocalStorage = false;
useEffect(()=>{ useEffect(()=>{
const autoSavePref = JSON.parse(localStorage.getItem('AUTOSAVE_ON') ?? true); const autoSavePref = JSON.parse(localStorage.getItem('AUTOSAVE_ON') ?? true);
setAutoSaveEnabled(autoSavePref); setAutoSaveEnabled(autoSavePref);
@@ -125,29 +132,27 @@ const EditPage = (props)=>{
setCurrentBrewRendererPageNum(pageNumber); setCurrentBrewRendererPageNum(pageNumber);
}; };
const handleTextChange = (text)=>{ const handleBrewChange = (field) => (value, subfield) => { //'text', 'style', 'snippets', 'metadata'
if (subfield == 'renderer' || subfield == 'theme')
fetchThemeBundle(setError, setThemeBundle, value.renderer, value.theme);
//If there are HTML errors, run the validator on every change to give quick feedback //If there are HTML errors, run the validator on every change to give quick feedback
if(HTMLErrors.length) if(HTMLErrors.length && (field == 'text' || field == 'snippets'))
setHTMLErrors(Markdown.validate(text)); setHTMLErrors(Markdown.validate(value));
setCurrentBrew((prevBrew)=>({ ...prevBrew, text }));
};
const handleStyleChange = (style)=>{ if(field == 'metadata') setCurrentBrew(prev => ({ ...prev, ...value }));
setCurrentBrew((prevBrew)=>({ ...prevBrew, style })); else setCurrentBrew(prev => ({ ...prev, [field]: value }));
};
const handleSnipChange = (snippet)=>{ if(useLocalStorage) {
//If there are HTML errors, run the validator on every change to give quick feedback if(field == 'text') localStorage.setItem(BREWKEY, value);
if(HTMLErrors.length) if(field == 'style') localStorage.setItem(STYLEKEY, value);
setHTMLErrors(Markdown.validate(snippet)); if(field == 'snippets') localStorage.setItem(SNIPKEY, value);
setCurrentBrew((prevBrew)=>({ ...prevBrew, snippets: snippet })); if(field == 'metadata') localStorage.setItem(METAKEY, JSON.stringify({
}; renderer : value.renderer,
theme : value.theme,
const handleMetaChange = (metadata, field = undefined)=>{ lang : value.lang
if(field === 'theme' || field === 'renderer') }));
fetchThemeBundle(setError, setThemeBundle, metadata.renderer, metadata.theme); }
setCurrentBrew((prev)=>({ ...prev, ...metadata }));
}; };
const updateBrew = (newData)=>setCurrentBrew((prevBrew)=>({ const updateBrew = (newData)=>setCurrentBrew((prevBrew)=>({
@@ -380,10 +385,7 @@ const EditPage = (props)=>{
<Editor <Editor
ref={editorRef} ref={editorRef}
brew={currentBrew} brew={currentBrew}
onTextChange={handleTextChange} onBrewChange={handleBrewChange}
onStyleChange={handleStyleChange}
onSnipChange={handleSnipChange}
onMetaChange={handleMetaChange}
reportError={setError} reportError={setError}
renderer={currentBrew.renderer} renderer={currentBrew.renderer}
userThemes={props.userThemes} userThemes={props.userThemes}

View File

@@ -3,6 +3,7 @@ import './homePage.less';
import React from 'react'; import React from 'react';
import { useEffect, useState, useRef } from 'react'; import { useEffect, useState, useRef } from 'react';
import request from '../../utils/request-middleware.js'; import request from '../../utils/request-middleware.js';
import Markdown from 'naturalcrit/markdown.js';
import { Meta } from 'vitreum/headtags'; import { Meta } from 'vitreum/headtags';
import Nav from 'naturalcrit/nav/nav.jsx'; import Nav from 'naturalcrit/nav/nav.jsx';
@@ -21,6 +22,11 @@ import BrewRenderer from '../../brewRenderer/brewRenderer.jsx
import { DEFAULT_BREW } from '../../../../server/brewDefaults.js'; import { DEFAULT_BREW } from '../../../../server/brewDefaults.js';
const BREWKEY = 'homebrewery-new';
const STYLEKEY = 'homebrewery-new-style';
const SNIPKEY = 'homebrewery-new-snippets';
const METAKEY = 'homebrewery-new-meta';
const HomePage =(props)=>{ const HomePage =(props)=>{
props = { props = {
brew : DEFAULT_BREW, brew : DEFAULT_BREW,
@@ -28,9 +34,10 @@ const HomePage =(props)=>{
...props ...props
}; };
const [brew , setBrew] = useState(props.brew); const [currentBrew , setCurrentBrew] = useState(props.brew);
const [welcomeText , setWelcomeText] = useState(props.brew.text); const [welcomeText , setWelcomeText] = useState(props.brew.text);
const [error , setError] = useState(undefined); const [error , setError] = useState(undefined);
const [HTMLErrors , setHTMLErrors ] = useState(Markdown.validate(props.brew.text));
const [currentEditorViewPageNum , setCurrentEditorViewPageNum] = useState(1); const [currentEditorViewPageNum , setCurrentEditorViewPageNum] = useState(1);
const [currentEditorCursorPageNum, setCurrentEditorCursorPageNum] = useState(1); const [currentEditorCursorPageNum, setCurrentEditorCursorPageNum] = useState(1);
const [currentBrewRendererPageNum, setCurrentBrewRendererPageNum] = useState(1); const [currentBrewRendererPageNum, setCurrentBrewRendererPageNum] = useState(1);
@@ -39,13 +46,15 @@ const HomePage =(props)=>{
const editorRef = useRef(null); const editorRef = useRef(null);
const useLocalStorage = false;
useEffect(()=>{ useEffect(()=>{
fetchThemeBundle(setError, setThemeBundle, brew.renderer, brew.theme); fetchThemeBundle(setError, setThemeBundle, currentBrew.renderer, currentBrew.theme);
}, []); }, []);
const save = ()=>{ const save = ()=>{
request.post('/api') request.post('/api')
.send(brew) .send(currentBrew)
.end((err, res)=>{ .end((err, res)=>{
if(err) { if(err) {
setError(err); setError(err);
@@ -72,8 +81,27 @@ const HomePage =(props)=>{
setCurrentBrewRendererPageNum(pageNumber); setCurrentBrewRendererPageNum(pageNumber);
}; };
const handleTextChange = (text)=>{ const handleBrewChange = (field) => (value, subfield) => { //'text', 'style', 'snippets', 'metadata'
setBrew((prevBrew) => ({ ...prevBrew, text })); if (subfield == 'renderer' || subfield == 'theme')
fetchThemeBundle(setError, setThemeBundle, value.renderer, value.theme);
//If there are HTML errors, run the validator on every change to give quick feedback
if(HTMLErrors.length && (field == 'text' || field == 'snippets'))
setHTMLErrors(Markdown.validate(value));
if(field == 'metadata') setCurrentBrew(prev => ({ ...prev, ...value }));
else setCurrentBrew(prev => ({ ...prev, [field]: value }));
if(useLocalStorage) {
if(field == 'text') localStorage.setItem(BREWKEY, value);
if(field == 'style') localStorage.setItem(STYLEKEY, value);
if(field == 'snippets') localStorage.setItem(SNIPKEY, value);
if(field == 'metadata') localStorage.setItem(METAKEY, JSON.stringify({
renderer : value.renderer,
theme : value.theme,
lang : value.lang
}));
}
}; };
const clearError = ()=>{ const clearError = ()=>{
@@ -105,9 +133,9 @@ const HomePage =(props)=>{
<SplitPane onDragFinish={handleSplitMove}> <SplitPane onDragFinish={handleSplitMove}>
<Editor <Editor
ref={editorRef} ref={editorRef}
brew={brew} brew={currentBrew}
onTextChange={handleTextChange} onBrewChange={handleBrewChange}
renderer={brew.renderer} renderer={currentBrew.renderer}
showEditButtons={false} showEditButtons={false}
themeBundle={themeBundle} themeBundle={themeBundle}
onCursorPageChange={handleEditorCursorPageChange} onCursorPageChange={handleEditorCursorPageChange}
@@ -117,9 +145,9 @@ const HomePage =(props)=>{
currentBrewRendererPageNum={currentBrewRendererPageNum} currentBrewRendererPageNum={currentBrewRendererPageNum}
/> />
<BrewRenderer <BrewRenderer
text={brew.text} text={currentBrew.text}
style={brew.style} style={currentBrew.style}
renderer={brew.renderer} renderer={currentBrew.renderer}
onPageChange={handleBrewRendererPageChange} onPageChange={handleBrewRendererPageChange}
currentEditorViewPageNum={currentEditorViewPageNum} currentEditorViewPageNum={currentEditorViewPageNum}
currentEditorCursorPageNum={currentEditorCursorPageNum} currentEditorCursorPageNum={currentEditorCursorPageNum}
@@ -128,7 +156,7 @@ const HomePage =(props)=>{
/> />
</SplitPane> </SplitPane>
</div> </div>
<div className={`floatingSaveButton${welcomeText !== brew.text ? ' show' : ''}`} onClick={save}> <div className={`floatingSaveButton${welcomeText !== currentBrew.text ? ' show' : ''}`} onClick={save}>
Save current <i className='fas fa-save' /> Save current <i className='fas fa-save' />
</div> </div>

View File

@@ -22,8 +22,9 @@ import { printCurrentBrew, fetchThemeBundle, splitTextStyleAndMetadata } from '.
const BREWKEY = 'homebrewery-new'; const BREWKEY = 'homebrewery-new';
const STYLEKEY = 'homebrewery-new-style'; const STYLEKEY = 'homebrewery-new-style';
const SNIPKEY = 'homebrewery-new-snippets';
const METAKEY = 'homebrewery-new-meta'; const METAKEY = 'homebrewery-new-meta';
const SAVEKEY = `HOMEBREWERY-DEFAULT-SAVE-LOCATION-${global.account?.username || ''}`; const SAVEKEYPREFIX = 'HOMEBREWERY-DEFAULT-SAVE-LOCATION-';
const NewPage = (props) => { const NewPage = (props) => {
props = { props = {
@@ -43,6 +44,8 @@ const NewPage = (props) => {
const editorRef = useRef(null); const editorRef = useRef(null);
const useLocalStorage = true;
useEffect(() => { useEffect(() => {
document.addEventListener('keydown', handleControlKeys); document.addEventListener('keydown', handleControlKeys);
loadBrew(); loadBrew();
@@ -67,6 +70,7 @@ const NewPage = (props) => {
brew.lang = metaStorage?.lang ?? brew.lang; brew.lang = metaStorage?.lang ?? brew.lang;
} }
const SAVEKEY = `${SAVEKEYPREFIX}${global.account?.username}`;
const saveStorage = localStorage.getItem(SAVEKEY) || 'HOMEBREWERY'; const saveStorage = localStorage.getItem(SAVEKEY) || 'HOMEBREWERY';
setCurrentBrew(brew); setCurrentBrew(brew);
@@ -108,40 +112,27 @@ const NewPage = (props) => {
setCurrentBrewRendererPageNum(pageNumber); setCurrentBrewRendererPageNum(pageNumber);
}; };
const handleTextChange = (text)=>{ const handleBrewChange = (field) => (value, subfield) => { //'text', 'style', 'snippets', 'metadata'
if (subfield == 'renderer' || subfield == 'theme')
fetchThemeBundle(setError, setThemeBundle, value.renderer, value.theme);
//If there are HTML errors, run the validator on every change to give quick feedback //If there are HTML errors, run the validator on every change to give quick feedback
if(HTMLErrors.length) if(HTMLErrors.length && (field == 'text' || field == 'snippets'))
HTMLErrors = Markdown.validate(text); setHTMLErrors(Markdown.validate(value));
setHTMLErrors(HTMLErrors); if(field == 'metadata') setCurrentBrew(prev => ({ ...prev, ...value }));
setCurrentBrew((prevBrew) => ({ ...prevBrew, text })); else setCurrentBrew(prev => ({ ...prev, [field]: value }));
localStorage.setItem(BREWKEY, text);
};
const handleStyleChange = (style) => { if(useLocalStorage) {
setCurrentBrew(prevBrew => ({ ...prevBrew, style })); if(field == 'text') localStorage.setItem(BREWKEY, value);
localStorage.setItem(STYLEKEY, style); if(field == 'style') localStorage.setItem(STYLEKEY, value);
}; if(field == 'snippets') localStorage.setItem(SNIPKEY, value);
if(field == 'metadata') localStorage.setItem(METAKEY, JSON.stringify({
const handleSnipChange = (snippet)=>{ renderer : value.renderer,
//If there are HTML errors, run the validator on every change to give quick feedback theme : value.theme,
if(HTMLErrors.length) lang : value.lang
HTMLErrors = Markdown.validate(snippet); }));
}
setHTMLErrors(HTMLErrors);
setCurrentBrew((prevBrew) => ({ ...prevBrew, snippets: snippet }));
};
const handleMetaChange = (metadata, field = undefined) => {
if (field === 'theme' || field === 'renderer')
fetchThemeBundle(setError, setThemeBundle, metadata.renderer, metadata.theme);
setCurrentBrew(prev => ({ ...prev, ...metadata }));
localStorage.setItem(METAKEY, JSON.stringify({
renderer : metadata.renderer,
theme : metadata.theme,
lang : metadata.lang
}));
}; };
const save = async () => { const save = async () => {
@@ -215,10 +206,7 @@ const NewPage = (props) => {
<Editor <Editor
ref={editorRef} ref={editorRef}
brew={currentBrew} brew={currentBrew}
onTextChange={handleTextChange} onBrewChange={handleBrewChange}
onStyleChange={handleStyleChange}
onMetaChange={handleMetaChange}
onSnipChange={handleSnipChange}
renderer={currentBrew.renderer} renderer={currentBrew.renderer}
userThemes={props.userThemes} userThemes={props.userThemes}
themeBundle={themeBundle} themeBundle={themeBundle}

View File

@@ -27,7 +27,10 @@ const disconnect = async ()=>{
}; };
const connect = async (config)=>{ const connect = async (config)=>{
return await Mongoose.connect(getMongoDBURL(config), { retryWrites: false }) return await Mongoose.connect(getMongoDBURL(config), {
retryWrites : false,
autoIndex : (config.get('local_environments').includes(config.get('node_env')))
})
.catch((error)=>handleConnectionError(error)); .catch((error)=>handleConnectionError(error));
}; };

View File

@@ -7,29 +7,29 @@ import zlib from 'zlib';
const HomebrewSchema = mongoose.Schema({ const HomebrewSchema = mongoose.Schema({
shareId : { type: String, default: ()=>{return nanoid(12);}, index: { unique: true } }, shareId : { type: String, default: ()=>{return nanoid(12);}, index: { unique: true } },
editId : { type: String, default: ()=>{return nanoid(12);}, index: { unique: true } }, editId : { type: String, default: ()=>{return nanoid(12);}, index: { unique: true } },
googleId : { type: String }, googleId : { type: String, index: true },
title : { type: String, default: '' }, title : { type: String, default: '', index: true },
text : { type: String, default: '' }, text : { type: String, default: '' },
textBin : { type: Buffer }, textBin : { type: Buffer },
pageCount : { type: Number, default: 1 }, pageCount : { type: Number, default: 1, index: true },
description : { type: String, default: '' }, description : { type: String, default: '' },
tags : [String], tags : { type: [String], index: true },
systems : [String], systems : [String],
lang : { type: String, default: 'en' }, lang : { type: String, default: 'en', index: true },
renderer : { type: String, default: '' }, renderer : { type: String, default: '', index: true },
authors : [String], authors : { type: [String], index: true },
invitedAuthors : [String], invitedAuthors : [String],
published : { type: Boolean, default: false }, published : { type: Boolean, default: false, index: true },
thumbnail : { type: String, default: '' }, thumbnail : { type: String, default: '', index: true },
createdAt : { type: Date, default: Date.now }, createdAt : { type: Date, default: Date.now, index: true },
updatedAt : { type: Date, default: Date.now }, updatedAt : { type: Date, default: Date.now, index: true },
lastViewed : { type: Date, default: Date.now }, lastViewed : { type: Date, default: Date.now, index: true },
views : { type: Number, default: 0 }, views : { type: Number, default: 0 },
version : { type: Number, default: 1 }, version : { type: Number, default: 1, index: true },
lock : { type: Object } lock : { type: Object, index: true }
}, { versionKey: false }); }, { versionKey: false });
HomebrewSchema.statics.increaseView = async function(query) { HomebrewSchema.statics.increaseView = async function(query) {
@@ -43,6 +43,8 @@ HomebrewSchema.statics.increaseView = async function(query) {
return brew; return brew;
}; };
// STATIC FUNCTIONS
HomebrewSchema.statics.get = async function(query, fields=null){ HomebrewSchema.statics.get = async function(query, fields=null){
const brew = await Homebrew.findOne(query, fields).orFail() const brew = await Homebrew.findOne(query, fields).orFail()
.catch((error)=>{throw 'Can not find brew';}); .catch((error)=>{throw 'Can not find brew';});
@@ -63,6 +65,15 @@ HomebrewSchema.statics.getByUser = async function(username, allowAccess=false, f
return brews; return brews;
}; };
// INDEXES
HomebrewSchema.index({ updatedAt: -1, lastViewed: -1 });
HomebrewSchema.index({ published: 1, title: 'text' });
HomebrewSchema.index({ lock: 1, sparse: true });
HomebrewSchema.path('lock.reviewRequested').index({ sparse: true });
const Homebrew = mongoose.model('Homebrew', HomebrewSchema); const Homebrew = mongoose.model('Homebrew', HomebrewSchema);
export { export {

View File

@@ -38,15 +38,6 @@
animation-duration : 0.4s; animation-duration : 0.4s;
} }
.CodeMirror-vscrollbar {
&::-webkit-scrollbar { width : 20px; }
&::-webkit-scrollbar-thumb {
width : 20px;
background : linear-gradient(90deg, #858585 15px, #808080 15px);
}
}
//.cm-tab { //.cm-tab {
// background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAMCAQAAACOs/baAAAARUlEQVR4nGJgIAG8JkXxUAcCtDWemcGR1lY4MvgzCEKY7jSBjgxBDAG09UEQzAe0AMwMHrSOAwEGRtpaMIwAAAAA//8DAG4ID9EKs6YqAAAAAElFTkSuQmCC) no-repeat right; // background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAMCAQAAACOs/baAAAARUlEQVR4nGJgIAG8JkXxUAcCtDWemcGR1lY4MvgzCEKY7jSBjgxBDAG09UEQzAe0AMwMHrSOAwEGRtpaMIwAAAAA//8DAG4ID9EKs6YqAAAAAElFTkSuQmCC) no-repeat right;
//} //}