diff --git a/web/database/queries/db-queries.js b/web/database/queries/db-queries.js index fb1ae3a07..e3e0cfc30 100644 --- a/web/database/queries/db-queries.js +++ b/web/database/queries/db-queries.js @@ -1,38 +1,69 @@ // @flow import type { SqliteDatabase } from 'sql.js'; +import { migrations } from '../utils/migrations.js'; + function getSQLiteDBVersion(db: SqliteDatabase): number { const versionData = db.exec('PRAGMA user_version;'); if (!versionData.length || !versionData[0].values.length) { throw new Error('Error while retrieving database version: empty result'); } const [dbVersion] = versionData[0].values[0]; if (typeof dbVersion !== 'number') { throw new Error( 'Error while retrieving database version: invalid type returned', ); } return dbVersion; } +function setSQLiteDBVersion(db: SqliteDatabase, version: number) { + db.exec(`PRAGMA user_version=${version};`); +} + function setupSQLiteDB(db: SqliteDatabase) { db.exec(` CREATE TABLE IF NOT EXISTS drafts ( key TEXT UNIQUE PRIMARY KEY NOT NULL, text TEXT NOT NULL ); CREATE TABLE IF NOT EXISTS metadata ( name TEXT UNIQUE PRIMARY KEY NOT NULL, data TEXT NOT NULL ); CREATE TABLE IF NOT EXISTS persist_storage ( key TEXT UNIQUE PRIMARY KEY NOT NULL, item TEXT NOT NULL ); `); + const migrationKeys = migrations.size ? migrations.keys() : [0]; + const newDatabaseVersion = Math.max(...migrationKeys); + setSQLiteDBVersion(db, newDatabaseVersion); +} + +function migrate(sqliteDb: SqliteDatabase): boolean { + const dbVersion = getSQLiteDBVersion(sqliteDb); + console.info(`Db version: ${dbVersion}`); + + for (const [idx, migration] of migrations.entries()) { + if (idx <= dbVersion) { + continue; + } + + try { + migration(sqliteDb); + console.log(`migration ${idx} succeeded.`); + setSQLiteDBVersion(sqliteDb, idx); + } catch (e) { + console.error(`migration ${idx} failed.`); + console.error(e); + return false; + } + } + return true; } -export { getSQLiteDBVersion, setupSQLiteDB }; +export { getSQLiteDBVersion, setupSQLiteDB, setSQLiteDBVersion, migrate }; diff --git a/web/database/sql-js.test.js b/web/database/sql-js.test.js index 46bf83d50..33c53643d 100644 --- a/web/database/sql-js.test.js +++ b/web/database/sql-js.test.js @@ -1,19 +1,29 @@ // @flow import initSqlJs from 'sql.js'; -import { getSQLiteDBVersion } from './queries/db-queries.js'; +import { + getSQLiteDBVersion, + setSQLiteDBVersion, +} from './queries/db-queries.js'; describe('sql.js', () => { it('should construct a Database', async () => { const SQL = await initSqlJs(); const db = new SQL.Database(); expect(db).not.toBe(undefined); }); it('should return default database version', async () => { const SQL = await initSqlJs(); const db = new SQL.Database(); expect(getSQLiteDBVersion(db)).toBe(0); }); + + it('should update database version', async () => { + const SQL = await initSqlJs(); + const db = new SQL.Database(); + setSQLiteDBVersion(db, 10); + expect(getSQLiteDBVersion(db)).toBe(10); + }); }); diff --git a/web/database/utils/migrations.js b/web/database/utils/migrations.js new file mode 100644 index 000000000..b95bb7366 --- /dev/null +++ b/web/database/utils/migrations.js @@ -0,0 +1,8 @@ +// @flow + +import type { SqliteDatabase } from 'sql.js'; + +const migrations: $ReadOnlyMap void> = + new Map([]); + +export { migrations }; diff --git a/web/database/worker/db-worker.js b/web/database/worker/db-worker.js index ffa41952b..c1d4d4f7d 100644 --- a/web/database/worker/db-worker.js +++ b/web/database/worker/db-worker.js @@ -1,278 +1,276 @@ // @flow import localforage from 'localforage'; import initSqlJs, { type SqliteDatabase } from 'sql.js'; import type { ClientDBDraftStoreOperation, DraftStoreOperation, } from 'lib/types/draft-types.js'; import type { ClientDBStore } from 'lib/types/store-ops-types.js'; import { type SharedWorkerMessageEvent, type WorkerRequestMessage, type WorkerResponseMessage, workerRequestMessageTypes, workerResponseMessageTypes, type WorkerRequestProxyMessage, workerWriteRequests, } from '../../types/worker-types.js'; -import { getSQLiteDBVersion, setupSQLiteDB } from '../queries/db-queries.js'; +import { migrate, setupSQLiteDB } from '../queries/db-queries.js'; import { getAllDrafts, moveDraft, removeAllDrafts, updateDraft, } from '../queries/draft-queries.js'; import { getMetadata, setMetadata } from '../queries/metadata-queries.js'; import { getPersistStorageItem, removePersistStorageItem, setPersistStorageItem, } from '../queries/storage-engine-queries.js'; import { CURRENT_USER_ID_KEY, SQLITE_CONTENT, SQLITE_ENCRYPTION_KEY, } from '../utils/constants.js'; import { decryptDatabaseFile, encryptDatabaseFile, generateDatabaseCryptoKey, } from '../utils/worker-crypto-utils.js'; const localforageConfig: PartialConfig = { driver: localforage.INDEXEDDB, name: 'comm', storeName: 'commStorage', description: 'Comm encrypted database storage', version: '1.0', }; localforage.config(localforageConfig); let sqliteDb: ?SqliteDatabase = null; let encryptionKey: ?CryptoKey = null; let persistNeeded: boolean = false; let persistInProgress: boolean = false; async function initDatabase(sqljsFilePath: string, sqljsFilename: ?string) { encryptionKey = await localforage.getItem(SQLITE_ENCRYPTION_KEY); if (!encryptionKey) { const cryptoKey = await generateDatabaseCryptoKey(); await localforage.setItem(SQLITE_ENCRYPTION_KEY, cryptoKey); } const encryptedContent = await localforage.getItem(SQLITE_CONTENT); let dbContent = null; try { if (encryptionKey && encryptedContent) { dbContent = await decryptDatabaseFile(encryptedContent, encryptionKey); } } catch (e) { console.error('Error while decrypting content, clearing database content'); await localforage.removeItem(SQLITE_CONTENT); } const locateFile = defaultFilename => { if (sqljsFilename) { return `${sqljsFilePath}/${sqljsFilename}`; } return `${sqljsFilePath}/${defaultFilename}`; }; const SQL = await initSqlJs({ locateFile, }); if (dbContent) { sqliteDb = new SQL.Database(dbContent); console.info( 'Database exists and is properly encrypted, using persisted data', ); + migrate(sqliteDb); } else { sqliteDb = new SQL.Database(); setupSQLiteDB(sqliteDb); console.info('Creating fresh database'); } - - const dbVersion = getSQLiteDBVersion(sqliteDb); - console.info(`Db version: ${dbVersion}`); } function processDraftStoreOperations( operations: $ReadOnlyArray, ) { if (!sqliteDb) { throw new Error('Database not initialized'); } for (const operation: DraftStoreOperation of operations) { if (operation.type === 'remove_all') { removeAllDrafts(sqliteDb); } else if (operation.type === 'update') { const { key, text } = operation.payload; updateDraft(sqliteDb, key, text); } else if (operation.type === 'move') { const { oldKey, newKey } = operation.payload; moveDraft(sqliteDb, oldKey, newKey); } else { throw new Error('Unsupported draft operation'); } } } function getClientStore(): ClientDBStore { if (!sqliteDb) { throw new Error('Database not initialized'); } return { drafts: getAllDrafts(sqliteDb), messages: [], threads: [], messageStoreThreads: [], reports: [], }; } async function persist() { persistInProgress = true; if (!sqliteDb) { persistInProgress = false; throw new Error('Database not initialized'); } if (!encryptionKey) { encryptionKey = await localforage.getItem(SQLITE_ENCRYPTION_KEY); } while (persistNeeded) { persistNeeded = false; const dbData = sqliteDb.export(); if (!encryptionKey) { persistInProgress = false; throw new Error('Encryption key is missing'); } const encryptedData = await encryptDatabaseFile(dbData, encryptionKey); await localforage.setItem(SQLITE_CONTENT, encryptedData); } persistInProgress = false; } async function processAppRequest( message: WorkerRequestMessage, ): Promise { // non-database operations if (message.type === workerRequestMessageTypes.PING) { return { type: workerResponseMessageTypes.PONG, text: 'PONG', }; } else if ( message.type === workerRequestMessageTypes.GENERATE_DATABASE_ENCRYPTION_KEY ) { const cryptoKey = await generateDatabaseCryptoKey(); await localforage.setItem(SQLITE_ENCRYPTION_KEY, cryptoKey); return undefined; } // database operations if (message.type === workerRequestMessageTypes.INIT) { await initDatabase(message.sqljsFilePath, message.sqljsFilename); return undefined; } else if (message.type === workerRequestMessageTypes.CLEAR_SENSITIVE_DATA) { encryptionKey = null; if (sqliteDb) { sqliteDb.close(); } await localforage.clear(); return undefined; } if (!sqliteDb) { throw new Error('Database not initialized'); } // read-only operations if (message.type === workerRequestMessageTypes.GET_CLIENT_STORE) { return { type: workerResponseMessageTypes.CLIENT_STORE, store: getClientStore(), }; } else if (message.type === workerRequestMessageTypes.GET_CURRENT_USER_ID) { return { type: workerResponseMessageTypes.GET_CURRENT_USER_ID, userID: getMetadata(sqliteDb, CURRENT_USER_ID_KEY), }; } else if ( message.type === workerRequestMessageTypes.GET_PERSIST_STORAGE_ITEM ) { return { type: workerResponseMessageTypes.GET_PERSIST_STORAGE_ITEM, item: getPersistStorageItem(sqliteDb, message.key), }; } // write operations if (!workerWriteRequests.includes(message.type)) { throw new Error('Request type not supported'); } if (message.type === workerRequestMessageTypes.PROCESS_STORE_OPERATIONS) { const { draftStoreOperations } = message.storeOperations; if (draftStoreOperations) { processDraftStoreOperations(draftStoreOperations); } } else if (message.type === workerRequestMessageTypes.SET_CURRENT_USER_ID) { setMetadata(sqliteDb, CURRENT_USER_ID_KEY, message.userID); } else if ( message.type === workerRequestMessageTypes.SET_PERSIST_STORAGE_ITEM ) { setPersistStorageItem(sqliteDb, message.key, message.item); } else if ( message.type === workerRequestMessageTypes.REMOVE_PERSIST_STORAGE_ITEM ) { removePersistStorageItem(sqliteDb, message.key); } persistNeeded = true; if (!persistInProgress) { persist(); } return undefined; } function connectHandler(event: SharedWorkerMessageEvent) { if (!event.ports.length) { return; } const port: MessagePort = event.ports[0]; console.log('Web database worker alive!'); port.onmessage = async function (messageEvent: MessageEvent) { const data: WorkerRequestProxyMessage = (messageEvent.data: any); const { id, message } = data; if (!id) { port.postMessage({ error: new Error('Request without identifier'), }); } try { const result = await processAppRequest(message); port.postMessage({ id, message: result, }); } catch (e) { port.postMessage({ id, error: e, }); } }; } self.addEventListener('connect', connectHandler);