diff --git a/ts/data/channels.ts b/ts/data/channels.ts index 6ba4bc00b..d2801432b 100644 --- a/ts/data/channels.ts +++ b/ts/data/channels.ts @@ -1,10 +1 @@ export const channels = {} as Record; - -// export const addChannel = (id: string, action: any) => { -// (window as any).channels = (window as any).channels || {}; -// (window as any).channels[id] = action; -// }; - -// export const getChannel = (id: string): ((...args: any) => Promise) => { -// return (window as any).channels[id]; -// }; diff --git a/ts/data/configDump/configDump.ts b/ts/data/configDump/configDump.ts new file mode 100644 index 000000000..1c9a8d1dc --- /dev/null +++ b/ts/data/configDump/configDump.ts @@ -0,0 +1,26 @@ +import { + AsyncWrapper, + ConfigDumpRow, + GetByPubkeyConfigDump, + GetByVariantAndPubkeyConfigDump, + SaveConfigDump, + SharedConfigSupportedVariant, +} from '../../types/sqlSharedTypes'; +import { channels } from '../channels'; + +const getByVariantAndPubkey: AsyncWrapper = ( + variant: SharedConfigSupportedVariant, + pubkey: string +) => { + return channels.getConfigDumpByVariantAndPubkey(variant, pubkey); +}; + +const getByPubkey: AsyncWrapper = (pubkey: string) => { + return channels.getConfigDumpsByPk(pubkey); +}; + +const saveConfigDump: AsyncWrapper = (dump: ConfigDumpRow) => { + return channels.saveConfigDump(dump); +}; + +export const ConfigDumpData = { getByVariantAndPubkey, getByPubkey, saveConfigDump }; diff --git a/ts/data/configDump/configDumpType.ts b/ts/data/configDump/configDumpType.ts new file mode 100644 index 000000000..e69de29bb diff --git a/ts/data/dataInit.ts b/ts/data/dataInit.ts index f838adfcc..93f75f963 100644 --- a/ts/data/dataInit.ts +++ b/ts/data/dataInit.ts @@ -1,6 +1,7 @@ import { ipcRenderer } from 'electron'; import _ from 'lodash'; import { channels } from './channels'; +import { ConfigDumpData } from './configDump/configDump'; const channelsToMakeForOpengroupV2 = [ 'getAllV2OpenGroupRooms', @@ -10,6 +11,8 @@ const channelsToMakeForOpengroupV2 = [ 'getAllOpenGroupV2Conversations', ]; +const channelsToMakeForConfigDumps = [...Object.keys(ConfigDumpData)]; + const channelsToMake = new Set([ 'shutdown', 'close', @@ -89,6 +92,7 @@ const channelsToMake = new Set([ 'removeAllClosedGroupEncryptionKeyPairs', 'fillWithTestData', ...channelsToMakeForOpengroupV2, + ...channelsToMakeForConfigDumps, ]); const SQL_CHANNEL_KEY = 'sql-channel'; diff --git a/ts/node/migration/sessionMigrations.ts b/ts/node/migration/sessionMigrations.ts index 8f3b7980f..8a45af40d 100644 --- a/ts/node/migration/sessionMigrations.ts +++ b/ts/node/migration/sessionMigrations.ts @@ -80,6 +80,7 @@ const LOKI_SCHEMA_VERSIONS = [ updateToSessionSchemaVersion28, updateToSessionSchemaVersion29, updateToSessionSchemaVersion30, + updateToSessionSchemaVersion31, ]; function updateToSessionSchemaVersion1(currentVersion: number, db: BetterSqlite3.Database) { @@ -1223,9 +1224,33 @@ function updateToSessionSchemaVersion30(currentVersion: number, db: BetterSqlite console.log(`updateToSessionSchemaVersion${targetVersion}: success!`); } -// function printTableColumns(table: string, db: BetterSqlite3.Database) { -// console.info(db.pragma(`table_info('${table}');`)); -// } +function updateToSessionSchemaVersion31(currentVersion: number, db: BetterSqlite3.Database) { + const targetVersion = 31; + if (currentVersion >= targetVersion) { + return; + } + + console.log(`updateToSessionSchemaVersion${targetVersion}: starting...`); + /** + * Create a table to store our sharedConfigMessage dumps + **/ + db.transaction(() => { + db.exec(`CREATE TABLE configDump( + variant TEXT NOT NULL, + publicKey TEXT NOT NULL, + data BLOB, + combinedMessageHashes TEXT); + `); + throw null; + writeSessionSchemaVersion(targetVersion, db); + })(); + + console.log(`updateToSessionSchemaVersion${targetVersion}: success!`); +} + +export function printTableColumns(table: string, db: BetterSqlite3.Database) { + console.info(db.pragma(`table_info('${table}');`)); +} function writeSessionSchemaVersion(newVersion: number, db: BetterSqlite3.Database) { db.prepare( diff --git a/ts/node/sql.ts b/ts/node/sql.ts index ed8bb3d0a..590574e04 100644 --- a/ts/node/sql.ts +++ b/ts/node/sql.ts @@ -46,7 +46,12 @@ import { toSqliteBoolean, } from './database_utility'; -import { UpdateLastHashType } from '../types/sqlSharedTypes'; +import { + ConfigDumpDataNode, + ConfigDumpRow, + SharedConfigSupportedVariant, + UpdateLastHashType, +} from '../types/sqlSharedTypes'; import { OpenGroupV2Room } from '../data/opengroups'; import { @@ -55,6 +60,13 @@ import { updateSchema, } from './migration/signalMigrations'; import { SettingsKey } from '../data/settings-key'; +import { + assertGlobalInstance, + assertGlobalInstanceOrInstance, + closeDbInstance, + initDbInstanceWith, + isInstanceInitialized, +} from './sqlInstance'; // tslint:disable: no-console function-name non-literal-fs-path @@ -74,14 +86,14 @@ function openAndSetUpSQLCipher(filePath: string, { key }: { key: string }) { } function setSQLPassword(password: string) { - if (!globalInstance) { + if (!assertGlobalInstance()) { throw new Error('setSQLPassword: db is not initialized'); } // If the password isn't hex then we need to derive a key from it const deriveKey = HEX_KEY.test(password); const value = deriveKey ? `'${password}'` : `"x'${password}'"`; - globalInstance.pragma(`rekey = ${value}`); + assertGlobalInstance().pragma(`rekey = ${value}`); } function vacuumDatabase(db: BetterSqlite3.Database) { @@ -94,26 +106,6 @@ function vacuumDatabase(db: BetterSqlite3.Database) { console.info(`Vacuuming DB Finished in ${Date.now() - start}ms.`); } -let globalInstance: BetterSqlite3.Database | null = null; - -function assertGlobalInstance(): BetterSqlite3.Database { - if (!globalInstance) { - throw new Error('globalInstance is not initialized.'); - } - return globalInstance; -} - -function assertGlobalInstanceOrInstance( - instance?: BetterSqlite3.Database | null -): BetterSqlite3.Database { - // if none of them are initialized, throw - if (!globalInstance && !instance) { - throw new Error('neither globalInstance nor initialized is initialized.'); - } - // otherwise, return which ever is true, priority to the global one - return globalInstance || (instance as BetterSqlite3.Database); -} - let databaseFilePath: string | undefined; function _initializePaths(configDir: string) { @@ -143,7 +135,7 @@ async function initializeSql({ passwordAttempt: boolean; }) { console.info('initializeSql sqlnode'); - if (globalInstance) { + if (isInstanceInitialized()) { throw new Error('Cannot initialize more than once!'); } @@ -184,7 +176,7 @@ async function initializeSql({ } // At this point we can allow general access to the database - globalInstance = db; + initDbInstanceWith(db); console.info('total message count before cleaning: ', getMessageCount()); console.info('total conversation count before cleaning: ', getConversationCount()); @@ -215,7 +207,7 @@ async function initializeSql({ if (button.response === 0) { clipboard.writeText(`Database startup error:\n\n${redactAll(error.stack)}`); } else { - close(); + closeDbInstance(); showFailedToStart(); } @@ -226,20 +218,8 @@ async function initializeSql({ return true; } -function close() { - if (!globalInstance) { - return; - } - const dbRef = globalInstance; - globalInstance = null; - // SQLLite documentation suggests that we run `PRAGMA optimize` right before - // closing the database connection. - dbRef.pragma('optimize'); - dbRef.close(); -} - function removeDB(configDir = null) { - if (globalInstance) { + if (isInstanceInitialized()) { throw new Error('removeDB: Cannot erase database when it is open!'); } @@ -1232,7 +1212,7 @@ function getMessagesByConversation(conversationId: string, { messageId = null } // If messageId is null, it means we are just opening the convo to the last unread message, or at the bottom const firstUnread = getFirstUnreadMessageIdInConversation(conversationId); - const numberOfMessagesInConvo = getMessagesCountByConversation(conversationId, globalInstance); + const numberOfMessagesInConvo = getMessagesCountByConversation(conversationId); const floorLoadAllMessagesInConvo = 70; if (messageId || firstUnread) { @@ -2046,6 +2026,70 @@ function removeV2OpenGroupRoom(conversationId: string) { }); } +/** + * Config dumps sql calls + */ + +const configDumpData: ConfigDumpDataNode = { + getConfigDumpByVariantAndPubkey: (variant: SharedConfigSupportedVariant, pubkey: string) => { + const rows = assertGlobalInstance() + .prepare(`SELECT * from configDump WHERE variant = $variant AND pubkey = $pubkey;`) + .get({ + pubkey, + variant, + }); + + if (!rows) { + return []; + } + throw new Error(`getConfigDumpByVariantAndPubkey: rows: ${JSON.stringify(rows)} `); + + return rows; + }, + + getConfigDumpsByPubkey: (pubkey: string) => { + const rows = assertGlobalInstance() + .prepare(`SELECT * from configDump WHERE pubkey = $pubkey;`) + .get({ + pubkey, + }); + + if (!rows) { + return []; + } + throw new Error(`getConfigDumpsByPubkey: rows: ${JSON.stringify(rows)} `); + + return rows; + }, + + saveConfigDump: ({ data, pubkey, variant, combinedMessageHashes }: ConfigDumpRow) => { + assertGlobalInstance() + .prepare( + `INSERT OR REPLACE INTO configDump ( + pubkey, + variant, + combinedMessageHashes, + data + ) values ( + $pubkey, + $variant, + $combinedMessageHashes, + $data, + );` + ) + .run({ + pubkey, + variant, + combinedMessageHashes, + data, + }); + }, +}; + +/** + * Others + */ + function getEntriesCountInTable(tbl: string) { try { const row = assertGlobalInstance() @@ -2424,6 +2468,10 @@ function fillWithTestData(numConvosToAdd: number, numMsgsToAdd: number) { export type SqlNodeType = typeof sqlNode; +export function close() { + closeDbInstance(); +} + export const sqlNode = { initializeSql, close, @@ -2528,4 +2576,7 @@ export const sqlNode = { saveV2OpenGroupRoom, getAllV2OpenGroupRooms, removeV2OpenGroupRoom, + + // config dumps + ...configDumpData, }; diff --git a/ts/node/sqlInstance.ts b/ts/node/sqlInstance.ts new file mode 100644 index 000000000..7a3ba12d4 --- /dev/null +++ b/ts/node/sqlInstance.ts @@ -0,0 +1,44 @@ +import * as BetterSqlite3 from 'better-sqlite3'; + +let globalInstance: BetterSqlite3.Database | null = null; + +export function assertGlobalInstance(): BetterSqlite3.Database { + if (!globalInstance) { + throw new Error('globalInstance is not initialized.'); + } + return globalInstance; +} + +export function isInstanceInitialized(): boolean { + return !!globalInstance; +} + +export function assertGlobalInstanceOrInstance( + instance?: BetterSqlite3.Database | null +): BetterSqlite3.Database { + // if none of them are initialized, throw + if (!globalInstance && !instance) { + throw new Error('neither globalInstance nor initialized is initialized.'); + } + // otherwise, return which ever is true, priority to the global one + return globalInstance || (instance as BetterSqlite3.Database); +} + +export function initDbInstanceWith(instance: BetterSqlite3.Database) { + if (globalInstance) { + throw new Error('already init'); + } + globalInstance = instance; +} + +export function closeDbInstance() { + if (!globalInstance) { + return; + } + const dbRef = globalInstance; + globalInstance = null; + // SQLLite documentation suggests that we run `PRAGMA optimize` right before + // closing the database connection. + dbRef.pragma('optimize'); + dbRef.close(); +} diff --git a/ts/session/apis/snode_api/retrieveRequest.ts b/ts/session/apis/snode_api/retrieveRequest.ts index 262a54a2d..85d1aefa6 100644 --- a/ts/session/apis/snode_api/retrieveRequest.ts +++ b/ts/session/apis/snode_api/retrieveRequest.ts @@ -90,7 +90,6 @@ async function retrieveNextMessages( // let exceptions bubble up // no retry for this one as this a call we do every few seconds while polling for messages - console.warn(`fetching messages associatedWith:${associatedWith} namespaces:${namespaces}`); const results = await doSnodeBatchRequest(retrieveRequestsParams, targetNode, 4000); if (!results || !results.length) { diff --git a/ts/session/apis/snode_api/snodeSignatures.ts b/ts/session/apis/snode_api/snodeSignatures.ts index 8ab5eda2e..22d4db730 100644 --- a/ts/session/apis/snode_api/snodeSignatures.ts +++ b/ts/session/apis/snode_api/snodeSignatures.ts @@ -1,4 +1,3 @@ -import { to_string } from 'libsodium-wrappers-sumo'; import { getSodiumRenderer } from '../../crypto'; import { UserUtils, StringUtils } from '../../utils'; import { fromHexToArray, fromUInt8ArrayToBase64 } from '../../utils/String'; @@ -40,9 +39,6 @@ async function getSnodeSignatureParams(params: { try { const signature = sodium.crypto_sign_detached(message, edKeyPrivBytes); const signatureBase64 = fromUInt8ArrayToBase64(signature); - console.warn( - `signing: "${to_string(new Uint8Array(verificationData))}" signature:"${signatureBase64}"` - ); return { timestamp: signatureTimestamp, diff --git a/ts/session/apis/snode_api/swarmPolling.ts b/ts/session/apis/snode_api/swarmPolling.ts index e4ac9b8da..ec7876e9e 100644 --- a/ts/session/apis/snode_api/swarmPolling.ts +++ b/ts/session/apis/snode_api/swarmPolling.ts @@ -236,8 +236,8 @@ export class SwarmPolling { ); } - console.warn(`received userConfigMessagesMerged: ${userConfigMessagesMerged.length}`); - console.warn( + console.info(`received userConfigMessagesMerged: ${userConfigMessagesMerged.length}`); + console.info( `received allNamespacesWithoutUserConfigIfNeeded: ${allNamespacesWithoutUserConfigIfNeeded.length}` ); diff --git a/ts/session/sending/MessageSender.ts b/ts/session/sending/MessageSender.ts index 682bf6cd1..4f3fd2348 100644 --- a/ts/session/sending/MessageSender.ts +++ b/ts/session/sending/MessageSender.ts @@ -125,7 +125,7 @@ export async function send( : SnodeNamespaces.UserMessages; } let timestamp = networkTimestamp; - // the user config namespacesm requires a signature to be added + // the user config namespaces requires a signature to be added let signOpts: SnodeSignatureResult | undefined; if (SnodeNamespace.isUserConfigNamespace(namespace)) { signOpts = await SnodeSignature.getSnodeSignatureParams({ diff --git a/ts/types/sqlSharedTypes.ts b/ts/types/sqlSharedTypes.ts index d781b3614..a64d56167 100644 --- a/ts/types/sqlSharedTypes.ts +++ b/ts/types/sqlSharedTypes.ts @@ -1,3 +1,11 @@ +/** + * This wrapper can be used to make a function type not async, asynced. + * We use it in the typing of the database communication, because the data calls (renderer side) have essentially the same signature of the sql calls (node side), with an added `await` + */ +export type AsyncWrapper any> = ( + ...args: Parameters +) => Promise>; + export type MsgDuplicateSearchOpenGroup = Array<{ sender: string; serverTimestamp: number; @@ -11,3 +19,30 @@ export type UpdateLastHashType = { expiresAt: number; namespace: number; }; + +/** + * Shared config dump types + */ + +export type SharedConfigSupportedVariant = 'user-profile' | 'contacts'; + +export type ConfigDumpRow = { + variant: SharedConfigSupportedVariant; // the variant this entry is about. (user-config, contacts, ...) + pubkey: string; // either our pubkey if a dump for our own swarm or the closed group pubkey + data: Uint8Array; // the blob returned by libsession.dump() call + combinedMessageHashes?: string; // array of lastHashes to keep track of, stringified + // we might need to add a `seqno` field here. +}; + +export type GetByVariantAndPubkeyConfigDump = ( + variant: SharedConfigSupportedVariant, + pubkey: string +) => Array; +export type GetByPubkeyConfigDump = (pubkey: string) => Array; +export type SaveConfigDump = (dump: ConfigDumpRow) => void; + +export type ConfigDumpDataNode = { + getConfigDumpByVariantAndPubkey: GetByVariantAndPubkeyConfigDump; + getConfigDumpsByPubkey: GetByPubkeyConfigDump; + saveConfigDump: SaveConfigDump; +}; diff --git a/ts/webworker/workers/node/libsession/libsession.worker.ts b/ts/webworker/workers/node/libsession/libsession.worker.ts index 9b1eb0cbe..df55da608 100644 --- a/ts/webworker/workers/node/libsession/libsession.worker.ts +++ b/ts/webworker/workers/node/libsession/libsession.worker.ts @@ -8,8 +8,6 @@ import { ConfigWrapperObjectTypes } from '../../browser/libsession_worker_functi let userConfig: UserConfigWrapper; -/* eslint-disable strict */ - // async function getSodiumWorker() { // await sodiumWrappers.ready; @@ -50,8 +48,8 @@ function initUserConfigWrapper(options: Array) { userConfig = new UserConfigWrapper(edSecretKey, dump); } -// tslint:disable: function-name -//tslint-disable no-console +// tslint:disable: function-name no-console + onmessage = async (e: { data: [number, ConfigWrapperObjectTypes, string, ...any] }) => { const [jobId, config, action, ...args] = e.data;