// Module to upgrade the schema of messages, e.g. migrate attachments to disk. // `processAll` purposely doesn’t rely on our Backbone IndexedDB adapter to // prevent automatic migrations. Rather, it uses direct IndexedDB access. // This includes avoiding usage of `storage` module which uses Backbone under // the hood. /* global IDBKeyRange */ const isFunction = require('lodash/isFunction'); const isNumber = require('lodash/isNumber'); const isObject = require('lodash/isObject'); const isString = require('lodash/isString'); const last = require('lodash/last'); const database = require('./database'); const Message = require('./types/message'); const settings = require('./settings'); const { deferredToPromise } = require('./deferred_to_promise'); const MESSAGES_STORE_NAME = 'messages'; const NUM_MESSAGES_PER_BATCH = 1; exports.processNext = async ({ BackboneMessage, BackboneMessageCollection, count, upgradeMessageSchema, } = {}) => { if (!isFunction(BackboneMessage)) { throw new TypeError('"BackboneMessage" (Whisper.Message) constructor is required'); } if (!isFunction(BackboneMessageCollection)) { throw new TypeError('"BackboneMessageCollection" (Whisper.MessageCollection)' + ' constructor is required'); } if (!isNumber(count)) { throw new TypeError('"count" is required'); } if (!isFunction(upgradeMessageSchema)) { throw new TypeError('"upgradeMessageSchema" is required'); } const startTime = Date.now(); const fetchStartTime = Date.now(); const messagesRequiringSchemaUpgrade = await _fetchMessagesRequiringSchemaUpgrade({ BackboneMessageCollection, count }); const fetchDuration = Date.now() - fetchStartTime; const upgradeStartTime = Date.now(); const upgradedMessages = await Promise.all(messagesRequiringSchemaUpgrade.map(upgradeMessageSchema)); const upgradeDuration = Date.now() - upgradeStartTime; const saveStartTime = Date.now(); const saveMessage = _saveMessageBackbone({ BackboneMessage }); await Promise.all(upgradedMessages.map(saveMessage)); const saveDuration = Date.now() - saveStartTime; const totalDuration = Date.now() - startTime; const numProcessed = messagesRequiringSchemaUpgrade.length; const hasMore = numProcessed > 0; return { hasMore, numProcessed, fetchDuration, upgradeDuration, saveDuration, totalDuration, }; }; exports.processAll = async ({ databaseName, minDatabaseVersion, upgradeMessageSchema, } = {}) => { if (!isString(databaseName)) { throw new TypeError('"databaseName" must be a string'); } if (!isNumber(minDatabaseVersion)) { throw new TypeError('"minDatabaseVersion" must be a number'); } if (!isFunction(upgradeMessageSchema)) { throw new TypeError('"upgradeMessageSchema" is required'); } const connection = await database.open(databaseName); const databaseVersion = connection.version; const isValidDatabaseVersion = databaseVersion >= minDatabaseVersion; console.log('Database status', { databaseVersion, isValidDatabaseVersion, minDatabaseVersion, }); if (!isValidDatabaseVersion) { throw new Error(`Expected database version (${databaseVersion})` + ` to be at least ${minDatabaseVersion}`); } const isComplete = await settings.isAttachmentMigrationComplete(connection); console.log('Attachment migration status:', isComplete ? 'complete' : 'incomplete'); if (isComplete) { return; } let numTotalMessages = null; // eslint-disable-next-line more/no-then getNumMessages({ connection }).then((numMessages) => { numTotalMessages = numMessages; }); const migrationStartTime = Date.now(); let unprocessedMessages = []; let totalMessagesProcessed = 0; do { const lastProcessedIndex = // eslint-disable-next-line no-await-in-loop await settings.getAttachmentMigrationLastProcessedIndex(connection); const fetchUnprocessedMessagesStartTime = Date.now(); unprocessedMessages = // eslint-disable-next-line no-await-in-loop await _dangerouslyFetchMessagesRequiringSchemaUpgradeWithoutIndex({ connection, count: NUM_MESSAGES_PER_BATCH, lastIndex: lastProcessedIndex, }); const fetchDuration = Date.now() - fetchUnprocessedMessagesStartTime; const numUnprocessedMessages = unprocessedMessages.length; if (numUnprocessedMessages === 0) { break; } const upgradeStartTime = Date.now(); const upgradedMessages = // eslint-disable-next-line no-await-in-loop await Promise.all(unprocessedMessages.map(upgradeMessageSchema)); const upgradeDuration = Date.now() - upgradeStartTime; const saveMessagesStartTime = Date.now(); const transaction = connection.transaction(MESSAGES_STORE_NAME, 'readwrite'); const transactionCompletion = database.completeTransaction(transaction); // eslint-disable-next-line no-await-in-loop await Promise.all(upgradedMessages.map(_saveMessage({ transaction }))); // eslint-disable-next-line no-await-in-loop await transactionCompletion; const saveDuration = Date.now() - saveMessagesStartTime; // TODO: Confirm transaction is complete const lastMessage = last(upgradedMessages); const newLastProcessedIndex = lastMessage ? lastMessage.id : null; if (newLastProcessedIndex) { // eslint-disable-next-line no-await-in-loop await settings.setAttachmentMigrationLastProcessedIndex( connection, newLastProcessedIndex ); } totalMessagesProcessed += numUnprocessedMessages; console.log('Upgrade message schema:', { lastProcessedIndex, numUnprocessedMessages, numCumulativeMessagesProcessed: totalMessagesProcessed, numTotalMessages, fetchDuration, saveDuration, upgradeDuration, newLastProcessedIndex, targetSchemaVersion: Message.CURRENT_SCHEMA_VERSION, }); } while (unprocessedMessages.length > 0); await settings.markAttachmentMigrationComplete(connection); await settings.deleteAttachmentMigrationLastProcessedIndex(connection); console.log('Close database connection'); connection.close(); const totalDuration = Date.now() - migrationStartTime; console.log('Attachment migration complete:', { totalDuration, totalMessagesProcessed, }); }; const _saveMessageBackbone = ({ BackboneMessage } = {}) => (message) => { const backboneMessage = new BackboneMessage(message); return deferredToPromise(backboneMessage.save()); }; const _saveMessage = ({ transaction } = {}) => (message) => { if (!isObject(transaction)) { throw new TypeError('"transaction" is required'); } const messagesStore = transaction.objectStore(MESSAGES_STORE_NAME); const request = messagesStore.put(message, message.id); return new Promise((resolve, reject) => { request.onsuccess = () => resolve(); request.onerror = event => reject(event.target.error); }); }; const _fetchMessagesRequiringSchemaUpgrade = async ({ BackboneMessageCollection, count } = {}) => { if (!isFunction(BackboneMessageCollection)) { throw new TypeError('"BackboneMessageCollection" (Whisper.MessageCollection)' + ' constructor is required'); } if (!isNumber(count)) { throw new TypeError('"count" is required'); } const collection = new BackboneMessageCollection(); return new Promise(resolve => collection.fetch({ limit: count, index: { name: 'schemaVersion', upper: Message.CURRENT_SCHEMA_VERSION, excludeUpper: true, order: 'desc', }, }).always(() => { const models = collection.models || []; const messages = models.map(model => model.toJSON()); resolve(messages); })); }; // NOTE: Named ‘dangerous’ because it is not as efficient as using our // `messages` `schemaVersion` index: const _dangerouslyFetchMessagesRequiringSchemaUpgradeWithoutIndex = ({ connection, count, lastIndex } = {}) => { if (!isObject(connection)) { throw new TypeError('"connection" is required'); } if (!isNumber(count)) { throw new TypeError('"count" is required'); } if (lastIndex && !isString(lastIndex)) { throw new TypeError('"lastIndex" must be a string'); } const hasLastIndex = Boolean(lastIndex); const transaction = connection.transaction(MESSAGES_STORE_NAME, 'readonly'); const messagesStore = transaction.objectStore(MESSAGES_STORE_NAME); const excludeLowerBound = true; const query = hasLastIndex ? IDBKeyRange.lowerBound(lastIndex, excludeLowerBound) : undefined; const request = messagesStore.getAll(query, count); return new Promise((resolve, reject) => { request.onsuccess = event => resolve(event.target.result); request.onerror = event => reject(event.target.error); }); }; const getNumMessages = async ({ connection } = {}) => { if (!isObject(connection)) { throw new TypeError('"connection" is required'); } const transaction = connection.transaction(MESSAGES_STORE_NAME, 'readonly'); const messagesStore = transaction.objectStore(MESSAGES_STORE_NAME); const numTotalMessages = await database.getCount({ store: messagesStore }); await database.completeTransaction(transaction); return numTotalMessages; };