keejef
/
session-desktop
mirror of https://github.com/oxen-io/session-desktop
2
0
Fork 0
Code Issues 8 Projects Releases Wiki Activity

feat: added free function to libsession wrappers

Browse Source 
almost processing the dump correctly
pull/3056/head
William Grant 1 year ago
parent a3262d7af9
commit 6a2af3e088
7 changed files with 87 additions and 48 deletions
Show Stats Download Patch File Download Diff File

1
ts/components/registration/stages/RestoreAccount.tsx
Unescape Escape View File

@ -75,6 +75,7 @@ async function signInAndFetchDisplayName(
await resetRegistration();
await signInByLinkingDevice(recoveryPassword, 'english', loadingAnimationCallback);
// TODO[epic-899] do we still need this? Should I change the polling timeout to ONBOARDING_RECOVERY_TIMEOUT?
await PromiseUtils.waitForTask(done => {
window.Whisper.events.on('configurationMessageReceived', async (displayName: string) => {
window.log.debug(

34
ts/receiver/configMessage.ts
Unescape Escape View File

@ -821,11 +821,9 @@ async function handleConvoInfoVolatileUpdate(
return result;
}
async function processMergingResults(
results: Map<ConfigWrapperObjectTypes, IncomingConfResult>
): Promise<IncomingConfResult | undefined> {
async function processMergingResults(results: Map<ConfigWrapperObjectTypes, IncomingConfResult>) {
if (!results || !results.size) {
return undefined;
return;
}
const keys = [...results.keys()];
@ -885,11 +883,9 @@ async function processMergingResults(
if (incomingResult.needsPush) {
anyNeedsPush = true;
}
return incomingResult;
} catch (e) {
window.log.error(`processMergingResults failed with ${e.message}`);
return undefined;
return;
}
}
// Now that the local state has been updated, trigger a config sync (this will push any
@ -897,21 +893,19 @@ async function processMergingResults(
if (anyNeedsPush) {
await ConfigurationSync.queueNewJobIfNeeded();
}
return undefined;
}
async function handleConfigMessagesViaLibSession(
configMessages: Array<IncomingMessage<SignalService.ISharedConfigMessage>>,
returnAndKeepInMemory?: boolean
): Promise<IncomingConfResult | undefined> {
configMessages: Array<IncomingMessage<SignalService.ISharedConfigMessage>>
) {
const userConfigLibsession = await ReleasedFeatures.checkIsUserConfigFeatureReleased();
if (!userConfigLibsession) {
return undefined;
return;
}
if (isEmpty(configMessages)) {
return undefined;
return;
}
window?.log?.debug(
@ -925,20 +919,8 @@ async function handleConfigMessagesViaLibSession(
);
const incomingMergeResult = await mergeConfigsWithIncomingUpdates(configMessages);
window.log.debug(
`WIP: [handleConfigMessagesViaLibSession] incomingMergeResult:`,
incomingMergeResult
);
if (returnAndKeepInMemory) {
// TODO[epic=899] we should return the display name and keep it in memory
return incomingMergeResult.get('UserConfig');
// const dump = await GenericWrapperActions.dump('UserConfig');
// return dump;
}
const result = await processMergingResults(incomingMergeResult);
return result;
await processMergingResults(incomingMergeResult);
}
async function updateOurProfileLegacyOrViaLibSession({

38
ts/session/apis/snode_api/swarmPolling.ts
Unescape Escape View File

@ -17,6 +17,7 @@ import { updateIsOnline } from '../../../state/ducks/onion';
import { ReleasedFeatures } from '../../../util/releaseFeature';
import {
GenericWrapperActions,
UserConfigWrapperActions,
UserGroupsWrapperActions,
} from '../../../webworker/workers/browser/libsession_worker_interface';
import { DURATION, SWARM_POLLING_TIMEOUT } from '../../constants';
@ -397,33 +398,40 @@ export class SwarmPolling {
if (returnAndKeepInMemory) {
try {
// TODO[epic=899] trying to create a dump in memory for the userconfig
const ourKeyPair = await UserUtils.getIdentityKeyPair();
if (ourKeyPair) {
if (!ourKeyPair) {
throw new Error('ourKeyPair not found');
}
// we take the lastest config message to create the wrapper in memory
const configMessage = allDecryptedConfigMessages.at(-1)?.message;
window.log.debug(`WIP: [SwarmPolling] configMessage: ${JSON.stringify(configMessage)}`);
await GenericWrapperActions.init(
'UserConfig',
new Uint8Array(ourKeyPair.privKey),
null
configMessage?.data || null
);
// save the newly created dump to the database even if it is empty, just so we do not need to recreate one next run
// const dump = await GenericWrapperActions.dump('UserConfig');
window.log.debug(
`WIP: [SwarmPolling] dump: ${StringUtils.toHex(await GenericWrapperActions.dump('UserConfig'))}`
);
// TODO[epic=899] this is still not working
const userInfo = await UserConfigWrapperActions.getUserInfo();
window.log.debug(`WIP: [SwarmPolling] userInfo: ${JSON.stringify(userInfo)}`);
if (!userInfo) {
throw new Error('UserInfo not found');
}
// await LibSessionUtil.initializeLibSessionUtilWrappers();
return userInfo.name;
} catch (e) {
window.log.warn(
'[SwarmPolling] LibSessionUtil.initializeLibSessionUtilWrappers failed with',
e.message
);
} finally {
await GenericWrapperActions.free('UserConfig');
}
}
const result = await ConfigMessageHandler.handleConfigMessagesViaLibSession(
allDecryptedConfigMessages,
returnAndKeepInMemory
);
window.log.debug(`WIP: [handleSharedConfigMessages] result ${JSON.stringify(result)} `);
return String(result);
await ConfigMessageHandler.handleConfigMessagesViaLibSession(allDecryptedConfigMessages);
} catch (e) {
const allMessageHases = allDecryptedConfigMessages.map(m => m.messageHash).join(',');
window.log.warn(
@ -696,7 +704,9 @@ export class SwarmPolling {
);
try {
const displayName = await this.handleSharedConfigMessages(userConfigMessagesMerged, true);
window.log.debug(`WIP: [pollForOurDisplayName] displayName ${displayName}`);
window.log.debug(
`WIP: [pollForOurDisplayName] displayName ${JSON.stringify(displayName)}`
);
return displayName;
} catch (e) {
window.log.warn(

3
ts/util/accountManager.ts
Unescape Escape View File

@ -98,10 +98,9 @@ export async function signInByLinkingDevice(
await createAccount(identityKeyPair);
await saveRecoveryPhrase(mnemonic);
const pubKeyString = toHex(identityKeyPair.pubKey);
// fetch configuration message to get the user's display name.
const displayName = await getSwarmPollingInstance().pollForOurDisplayName();
// await for the first configuration message to come in.
await registrationDone(pubKeyString, displayName);
return pubKeyString;
}

2
ts/webworker/workers/browser/libsession_worker_functions.d.ts vendored
Unescape Escape View File

@ -1,9 +1,9 @@
import {
BaseConfigActions,
ContactsConfigActionsType,
ConvoInfoVolatileConfigActionsType,
UserConfigActionsType,
UserGroupsConfigActionsType,
ConvoInfoVolatileConfigActionsType,
} from 'libsession_util_nodejs';
// we can only have one of those wrapper for our current user (but we can have a few configs for it to be merged into one)

9
ts/webworker/workers/browser/libsession_worker_interface.ts
Unescape Escape View File

@ -46,6 +46,11 @@ export const GenericWrapperActions = {
) =>
/** base wrapper generic actions */
callLibSessionWorker([wrapperId, 'init', ed25519Key, dump]) as Promise<void>,
/** This function is used to free wrappers from memory only.
*
* See freeUserWrapper() in libsession.worker.ts */
free: async (wrapperId: ConfigWrapperObjectTypes) =>
callLibSessionWorker([wrapperId, 'free']) as Promise<void>,
confirmPushed: async (wrapperId: ConfigWrapperObjectTypes, seqno: number, hash: string) =>
callLibSessionWorker([wrapperId, 'confirmPushed', seqno, hash]) as ReturnType<
BaseWrapperActionsCalls['confirmPushed']
@ -87,6 +92,7 @@ export const UserConfigWrapperActions: UserConfigWrapperActionsCalls = {
/* Reuse the GenericWrapperActions with the UserConfig argument */
init: async (ed25519Key: Uint8Array, dump: Uint8Array | null) =>
GenericWrapperActions.init('UserConfig', ed25519Key, dump),
free: async () => GenericWrapperActions.free('UserConfig'),
confirmPushed: async (seqno: number, hash: string) =>
GenericWrapperActions.confirmPushed('UserConfig', seqno, hash),
dump: async () => GenericWrapperActions.dump('UserConfig'),
@ -135,6 +141,7 @@ export const ContactsWrapperActions: ContactsWrapperActionsCalls = {
/* Reuse the GenericWrapperActions with the ContactConfig argument */
init: async (ed25519Key: Uint8Array, dump: Uint8Array | null) =>
GenericWrapperActions.init('ContactsConfig', ed25519Key, dump),
free: async () => GenericWrapperActions.free('ContactsConfig'),
confirmPushed: async (seqno: number, hash: string) =>
GenericWrapperActions.confirmPushed('ContactsConfig', seqno, hash),
dump: async () => GenericWrapperActions.dump('ContactsConfig'),
@ -171,6 +178,7 @@ export const UserGroupsWrapperActions: UserGroupsWrapperActionsCalls = {
/* Reuse the GenericWrapperActions with the ContactConfig argument */
init: async (ed25519Key: Uint8Array, dump: Uint8Array | null) =>
GenericWrapperActions.init('UserGroupsConfig', ed25519Key, dump),
free: async () => GenericWrapperActions.free('UserGroupsConfig'),
confirmPushed: async (seqno: number, hash: string) =>
GenericWrapperActions.confirmPushed('UserGroupsConfig', seqno, hash),
dump: async () => GenericWrapperActions.dump('UserGroupsConfig'),
@ -244,6 +252,7 @@ export const ConvoInfoVolatileWrapperActions: ConvoInfoVolatileWrapperActionsCal
/* Reuse the GenericWrapperActions with the ContactConfig argument */
init: async (ed25519Key: Uint8Array, dump: Uint8Array | null) =>
GenericWrapperActions.init('ConvoInfoVolatileConfig', ed25519Key, dump),
free: async () => GenericWrapperActions.free('ConvoInfoVolatileConfig'),
confirmPushed: async (seqno: number, hash: string) =>
GenericWrapperActions.confirmPushed('ConvoInfoVolatileConfig', seqno, hash),
dump: async () => GenericWrapperActions.dump('ConvoInfoVolatileConfig'),

40
ts/webworker/workers/node/libsession/libsession.worker.ts
Unescape Escape View File

@ -1,6 +1,5 @@
/* eslint-disable consistent-return */
/* eslint-disable no-case-declarations */
import { isEmpty, isNull } from 'lodash';
import {
BaseConfigWrapperNode,
ContactsConfigWrapperNode,
@ -8,6 +7,7 @@ import {
UserConfigWrapperNode,
UserGroupsWrapperNode,
} from 'libsession_util_nodejs';
import { isEmpty, isNull } from 'lodash';
// eslint-disable-next-line import/no-unresolved, import/extensions
import { ConfigWrapperObjectTypes } from '../../browser/libsession_worker_functions';
@ -119,6 +119,37 @@ function initUserWrapper(options: Array<any>, wrapperType: ConfigWrapperObjectTy
}
}
/**
* This function is used to free wrappers from memory only
*
* NOTE only use this function for wrappers that have not been saved to the database.
*
* EXAMPLE When restoring an account and fetching the display name of a user. We want to fetch a UserProfile config message and make a temporary wrapper for it in order to look up the display name.
*/
function freeUserWrapper(wrapperType: ConfigWrapperObjectTypes) {
const userWrapperType = assertUserWrapperType(wrapperType);
switch (userWrapperType) {
case 'UserConfig':
userProfileWrapper = undefined;
break;
case 'ContactsConfig':
contactsConfigWrapper = undefined;
break;
case 'UserGroupsConfig':
userGroupsConfigWrapper = undefined;
break;
case 'ConvoInfoVolatileConfig':
convoInfoVolatileConfigWrapper = undefined;
break;
default:
assertUnreachable(
userWrapperType,
`freeUserWrapper: Missing case error "${userWrapperType}"`
);
}
}
onmessage = async (e: { data: [number, ConfigWrapperObjectTypes, string, ...any] }) => {
const [jobId, config, action, ...args] = e.data;
@ -128,6 +159,13 @@ onmessage = async (e: { data: [number, ConfigWrapperObjectTypes, string, ...any]
postMessage([jobId, null, null]);
return;
}
if (action === 'free') {
freeUserWrapper(config);
postMessage([jobId, null, null]);
return;
}
const wrapper = getCorrespondingWrapper(config);
const fn = (wrapper as any)[action];

Write Preview
Loading…
Cancel
Save