From 26e4ad9bf99fb501be3fec2cb0b85d9daf5bfe43 Mon Sep 17 00:00:00 2001 From: azivner Date: Mon, 2 Apr 2018 21:25:20 -0400 Subject: [PATCH] separated DB initialization methods into sql_init --- src/routes/api/setup.js | 4 +- src/services/auth.js | 13 ++-- src/services/backup.js | 4 +- src/services/consistency_checks.js | 3 +- src/services/migration.js | 5 +- src/services/scheduler.js | 6 +- src/services/source_id.js | 3 +- src/services/sql.js | 102 ++--------------------------- src/services/sql_init.js | 101 ++++++++++++++++++++++++++++ src/services/sync.js | 5 +- src/www | 3 +- 11 files changed, 133 insertions(+), 116 deletions(-) create mode 100644 src/services/sql_init.js diff --git a/src/routes/api/setup.js b/src/routes/api/setup.js index 005e2e064..644cd42dd 100644 --- a/src/routes/api/setup.js +++ b/src/routes/api/setup.js @@ -1,7 +1,7 @@ "use strict"; const optionService = require('../../services/options'); -const sql = require('../../services/sql'); +const sqlInit = require('../../services/sql_init'); const utils = require('../../services/utils'); const myScryptService = require('../../services/my_scrypt'); const passwordEncryptionService = require('../../services/password_encryption'); @@ -19,7 +19,7 @@ async function setup(req) { await passwordEncryptionService.setDataKey(password, utils.randomSecureToken(16)); - sql.setDbReadyAsResolved(); + sqlInit.setDbReadyAsResolved(); } module.exports = { diff --git a/src/services/auth.js b/src/services/auth.js index 445f464cf..a24b79784 100644 --- a/src/services/auth.js +++ b/src/services/auth.js @@ -2,16 +2,17 @@ const migrationService = require('./migration'); const sql = require('./sql'); +const sqlInit = require('./sql_init'); const utils = require('./utils'); async function checkAuth(req, res, next) { - if (!await sql.isUserInitialized()) { + if (!await sqlInit.isUserInitialized()) { res.redirect("setup"); } else if (!req.session.loggedIn && !utils.isElectron()) { res.redirect("login"); } - else if (!await sql.isDbUpToDate()) { + else if (!await sqlInit.isDbUpToDate()) { res.redirect("migration"); } else { @@ -34,7 +35,7 @@ async function checkApiAuthOrElectron(req, res, next) { if (!req.session.loggedIn && !utils.isElectron()) { res.status(401).send("Not authorized"); } - else if (await sql.isDbUpToDate()) { + else if (await sqlInit.isDbUpToDate()) { next(); } else { @@ -46,7 +47,7 @@ async function checkApiAuth(req, res, next) { if (!req.session.loggedIn) { res.status(401).send("Not authorized"); } - else if (await sql.isDbUpToDate()) { + else if (await sqlInit.isDbUpToDate()) { next(); } else { @@ -64,7 +65,7 @@ async function checkApiAuthForMigrationPage(req, res, next) { } async function checkAppNotInitialized(req, res, next) { - if (await sql.isUserInitialized()) { + if (await sqlInit.isUserInitialized()) { res.status(400).send("App already initialized."); } else { @@ -78,7 +79,7 @@ async function checkSenderToken(req, res, next) { if (await sql.getValue("SELECT COUNT(*) FROM api_tokens WHERE isDeleted = 0 AND token = ?", [token]) === 0) { res.status(401).send("Not authorized"); } - else if (await sql.isDbUpToDate()) { + else if (await sqlInit.isDbUpToDate()) { next(); } else { diff --git a/src/services/backup.js b/src/services/backup.js index 840bfb481..687020ff3 100644 --- a/src/services/backup.js +++ b/src/services/backup.js @@ -5,7 +5,7 @@ const optionService = require('./options'); const fs = require('fs-extra'); const dataDir = require('./data_dir'); const log = require('./log'); -const sql = require('./sql'); +const sqlInit = require('./sql_init'); const syncMutexService = require('./sync_mutex'); const cls = require('./cls'); @@ -60,7 +60,7 @@ if (!fs.existsSync(dataDir.BACKUP_DIR)) { fs.mkdirSync(dataDir.BACKUP_DIR, 0o700); } -sql.dbReady.then(() => { +sqlInit.dbReady.then(() => { setInterval(cls.wrap(regularBackup), 60 * 60 * 1000); // kickoff backup immediately diff --git a/src/services/consistency_checks.js b/src/services/consistency_checks.js index 17fcc39d6..b7c3aae4f 100644 --- a/src/services/consistency_checks.js +++ b/src/services/consistency_checks.js @@ -1,6 +1,7 @@ "use strict"; const sql = require('./sql'); +const sqlInit = require('./sql_init'); const log = require('./log'); const messagingService = require('./messaging'); const syncMutexService = require('./sync_mutex'); @@ -265,7 +266,7 @@ async function runChecks() { } } -sql.dbReady.then(() => { +sqlInit.dbReady.then(() => { setInterval(cls.wrap(runChecks), 60 * 60 * 1000); // kickoff backup immediately diff --git a/src/services/migration.js b/src/services/migration.js index 207347a16..e02c84d9e 100644 --- a/src/services/migration.js +++ b/src/services/migration.js @@ -1,5 +1,6 @@ const backupService = require('./backup'); const sql = require('./sql'); +const sqlInit = require('./sql_init'); const optionService = require('./options'); const fs = require('fs-extra'); const log = require('./log'); @@ -84,8 +85,8 @@ async function migrate() { } } - if (sql.isDbUpToDate()) { - sql.setDbReadyAsResolved(); + if (sqlInit.isDbUpToDate()) { + sqlInit.setDbReadyAsResolved(); } return migrations; diff --git a/src/services/scheduler.js b/src/services/scheduler.js index 98fd4be1b..711833e7a 100644 --- a/src/services/scheduler.js +++ b/src/services/scheduler.js @@ -19,8 +19,8 @@ async function runNotesWithLabel(runAttrValue) { } } -setTimeout(cls.wrap(() => runNotesWithLabel('backend_startup')), 10 * 1000); +setTimeout(() => cls.wrap(() => runNotesWithLabel('backend_startup')), 10 * 1000); -setInterval(cls.wrap(() => runNotesWithLabel('hourly')), 3600 * 1000); +setInterval(() => cls.wrap(() => runNotesWithLabel('hourly')), 3600 * 1000); -setInterval(cls.wrap(() => runNotesWithLabel('daily'), 24 * 3600 * 1000)); \ No newline at end of file +setInterval(() => cls.wrap(() => runNotesWithLabel('daily'), 24 * 3600 * 1000)); \ No newline at end of file diff --git a/src/services/source_id.js b/src/services/source_id.js index 262c881d3..e0b027158 100644 --- a/src/services/source_id.js +++ b/src/services/source_id.js @@ -2,6 +2,7 @@ const utils = require('./utils'); const dateUtils = require('./date_utils'); const log = require('./log'); const sql = require('./sql'); +const sqlInit = require('./sql_init'); const cls = require('./cls'); async function saveSourceId(sourceId) { @@ -41,7 +42,7 @@ function isLocalSourceId(srcId) { const currentSourceId = createSourceId(); // this will also refresh source IDs -sql.dbReady.then(cls.wrap(() => saveSourceId(currentSourceId))); +sqlInit.dbReady.then(cls.wrap(() => saveSourceId(currentSourceId))); function getCurrentSourceId() { return currentSourceId; diff --git a/src/services/sql.js b/src/services/sql.js index 67b6662e4..12bd2efd5 100644 --- a/src/services/sql.js +++ b/src/services/sql.js @@ -1,80 +1,12 @@ "use strict"; const log = require('./log'); -const dataDir = require('./data_dir'); -const fs = require('fs'); -const sqlite = require('sqlite'); -const appInfo = require('./app_info'); -const resourceDir = require('./resource_dir'); const cls = require('./cls'); -async function createConnection() { - return await sqlite.open(dataDir.DOCUMENT_PATH, {Promise}); -} +let dbConnection; -const dbConnected = createConnection(); - -let dbReadyResolve = null; -const dbReady = new Promise((resolve, reject) => { - dbConnected.then(cls.wrap(async db => { - await execute("PRAGMA foreign_keys = ON"); - - dbReadyResolve = () => { - log.info("DB ready."); - - resolve(db); - }; - - const tableResults = await getRows("SELECT name FROM sqlite_master WHERE type='table' AND name='notes'"); - if (tableResults.length !== 1) { - log.info("Connected to db, but schema doesn't exist. Initializing schema ..."); - - const schema = fs.readFileSync(resourceDir.DB_INIT_DIR + '/schema.sql', 'UTF-8'); - const notesSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_notes.sql', 'UTF-8'); - const notesTreeSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_branches.sql', 'UTF-8'); - const imagesSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_images.sql', 'UTF-8'); - const notesImageSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_note_images.sql', 'UTF-8'); - - await doInTransaction(async () => { - await executeScript(schema); - await executeScript(notesSql); - await executeScript(notesTreeSql); - await executeScript(imagesSql); - await executeScript(notesImageSql); - - const startNoteId = await getValue("SELECT noteId FROM branches WHERE parentNoteId = 'root' AND isDeleted = 0 ORDER BY notePosition"); - - await require('./options').initOptions(startNoteId); - await require('./sync_table').fillAllSyncRows(); - }); - - log.info("Schema and initial content generated. Waiting for user to enter username/password to finish setup."); - - // we don't resolve dbReady promise because user needs to setup the username and password to initialize - // the database - } - else { - if (!await isUserInitialized()) { - log.info("Login/password not initialized. DB not ready."); - - return; - } - - if (!await isDbUpToDate()) { - return; - } - - resolve(db); - } - })) - .catch(e => { - console.log("Error connecting to DB.", e); - process.exit(1); - }); -}); - -function setDbReadyAsResolved() { - dbReadyResolve(); +function setDbConnection(connection) { + dbConnection = connection; } async function insert(table_name, rec, replace = false) { @@ -174,10 +106,9 @@ async function executeScript(query) { async function wrap(func) { const thisError = new Error(); - const db = await dbConnected; try { - return await func(db); + return await func(dbConnection); } catch (e) { log.error("Error executing query. Inner exception: " + e.stack + thisError.stack); @@ -238,27 +169,8 @@ async function doInTransaction(func) { return ret; } -async function isDbUpToDate() { - const dbVersion = parseInt(await getValue("SELECT value FROM options WHERE name = 'db_version'")); - - const upToDate = dbVersion >= appInfo.db_version; - - if (!upToDate) { - log.info("App db version is " + appInfo.db_version + ", while db version is " + dbVersion + ". Migration needed."); - } - - return upToDate; -} - -async function isUserInitialized() { - const username = await getValue("SELECT value FROM options WHERE name = 'username'"); - - return !!username; -} - module.exports = { - dbReady, - isUserInitialized, + setDbConnection, insert, replace, getValue, @@ -269,7 +181,5 @@ module.exports = { getColumn, execute, executeScript, - doInTransaction, - setDbReadyAsResolved, - isDbUpToDate + doInTransaction }; \ No newline at end of file diff --git a/src/services/sql_init.js b/src/services/sql_init.js new file mode 100644 index 000000000..6f33abe46 --- /dev/null +++ b/src/services/sql_init.js @@ -0,0 +1,101 @@ +const log = require('./log'); +const dataDir = require('./data_dir'); +const fs = require('fs'); +const sqlite = require('sqlite'); +const resourceDir = require('./resource_dir'); +const appInfo = require('./app_info'); +const sql = require('./sql'); + +async function createConnection() { + return await sqlite.open(dataDir.DOCUMENT_PATH, {Promise}); +} + +let dbReadyResolve = null; +const dbReady = new Promise((resolve, reject) => { + createConnection().then(async db => { + sql.setDbConnection(db); + + await sql.execute("PRAGMA foreign_keys = ON"); + + dbReadyResolve = () => { + log.info("DB ready."); + + resolve(db); + }; + + const tableResults = await sql.getRows("SELECT name FROM sqlite_master WHERE type='table' AND name='notes'"); + if (tableResults.length !== 1) { + log.info("Connected to db, but schema doesn't exist. Initializing schema ..."); + + const schema = fs.readFileSync(resourceDir.DB_INIT_DIR + '/schema.sql', 'UTF-8'); + const notesSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_notes.sql', 'UTF-8'); + const notesTreeSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_branches.sql', 'UTF-8'); + const imagesSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_images.sql', 'UTF-8'); + const notesImageSql = fs.readFileSync(resourceDir.DB_INIT_DIR + '/main_note_images.sql', 'UTF-8'); + + await sql.doInTransaction(async () => { + await sql.executeScript(schema); + await sql.executeScript(notesSql); + await sql.executeScript(notesTreeSql); + await sql.executeScript(imagesSql); + await sql.executeScript(notesImageSql); + + const startNoteId = await sql.getValue("SELECT noteId FROM branches WHERE parentNoteId = 'root' AND isDeleted = 0 ORDER BY notePosition"); + + await require('./options').initOptions(startNoteId); + await require('./sync_table').fillAllSyncRows(); + }); + + log.info("Schema and initial content generated. Waiting for user to enter username/password to finish setup."); + + // we don't resolve dbReady promise because user needs to setup the username and password to initialize + // the database + } + else { + if (!await isUserInitialized()) { + log.info("Login/password not initialized. DB not ready."); + + return; + } + + if (!await isDbUpToDate()) { + return; + } + + resolve(db); + } + }) + .catch(e => { + console.log("Error connecting to DB.", e); + process.exit(1); + }); +}); + +function setDbReadyAsResolved() { + dbReadyResolve(); +} + +async function isDbUpToDate() { + const dbVersion = parseInt(await sql.getValue("SELECT value FROM options WHERE name = 'db_version'")); + + const upToDate = dbVersion >= appInfo.db_version; + + if (!upToDate) { + log.info("App db version is " + appInfo.db_version + ", while db version is " + dbVersion + ". Migration needed."); + } + + return upToDate; +} + +async function isUserInitialized() { + const username = await sql.getValue("SELECT value FROM options WHERE name = 'username'"); + + return !!username; +} + +module.exports = { + dbReady, + isUserInitialized, + setDbReadyAsResolved, + isDbUpToDate +}; \ No newline at end of file diff --git a/src/services/sync.js b/src/services/sync.js index 7b8df8b50..31921703c 100644 --- a/src/services/sync.js +++ b/src/services/sync.js @@ -3,6 +3,7 @@ const log = require('./log'); const rp = require('request-promise'); const sql = require('./sql'); +const sqlInit = require('./sql_init'); const optionService = require('./options'); const utils = require('./utils'); const sourceIdService = require('./source_id'); @@ -23,7 +24,7 @@ let syncServerCertificate = null; async function sync() { try { await syncMutexService.doExclusively(async () => { - if (!await sql.isDbUpToDate()) { + if (!await sqlInit.isDbUpToDate()) { return { success: false, message: "DB not up to date" @@ -330,7 +331,7 @@ async function syncRequest(syncContext, method, uri, body) { } } -sql.dbReady.then(() => { +sqlInit.dbReady.then(() => { if (syncSetup.isSyncSetup) { log.info("Setting up sync to " + syncSetup.SYNC_SERVER + " with timeout " + syncSetup.SYNC_TIMEOUT); diff --git a/src/www b/src/www index 0ee2031f8..5fad53097 100755 --- a/src/www +++ b/src/www @@ -19,6 +19,7 @@ const appInfo = require('./services/app_info'); const messagingService = require('./services/messaging'); const utils = require('./services/utils'); const sql = require('./services/sql'); +const sqlInit = require('./services/sql_init'); const port = normalizePort(config['Network']['port'] || '3000'); app.set('port', port); @@ -55,7 +56,7 @@ httpServer.listen(port); httpServer.on('error', onError); httpServer.on('listening', onListening); -sql.dbReady.then(() => messagingService.init(httpServer, sessionParser)); +sqlInit.dbReady.then(() => messagingService.init(httpServer, sessionParser)); if (utils.isElectron()) { const electronRouting = require('./routes/electron');