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

fix: cleaned up WIP logging and used the window log debug function where appropriate

Browse Source
pull/2660/head
William Grant 2 years ago
parent 4c64997607
commit cfcf400ecf
11 changed files with 44 additions and 69 deletions
Show Stats Download Patch File Download Diff File

3
ts/hooks/useParamSelector.ts
Unescape Escape View File

@ -184,7 +184,8 @@ export function useMessageReactsPropsById(messageId?: string) {
}); });
} }
// TODO remove 10 seconds timer // TODO use env variable to toggle test values?
// https://github.com/oxen-io/session-desktop/pull/2660/files#r1174823750
export function useTimerOptionsByMode(disappearingMessageMode?: string, hasOnlyOneMode?: boolean) { export function useTimerOptionsByMode(disappearingMessageMode?: string, hasOnlyOneMode?: boolean) {
return useSelector((state: StateType) => { return useSelector((state: StateType) => {
const options = state.timerOptions.timerOptions; const options = state.timerOptions.timerOptions;

17
ts/models/conversation.ts
Unescape Escape View File

@ -678,10 +678,7 @@ export class ConversationModel extends Backbone.Model<ConversationAttributes> {
expireTimer: chatMessageParams.expireTimer, expireTimer: chatMessageParams.expireTimer,
}); });
window.log.info( window.log.debug('sendMessageJob() closedGroupVisibleMessage', closedGroupVisibleMessage);
'WIP: sendMessageJob() closedGroupVisibleMessage',
closedGroupVisibleMessage
);
// we need the return await so that errors are caught in the catch {} // we need the return await so that errors are caught in the catch {}
await getMessageQueue().sendToGroup(closedGroupVisibleMessage); await getMessageQueue().sendToGroup(closedGroupVisibleMessage);
@ -1075,9 +1072,7 @@ export class ConversationModel extends Backbone.Model<ConversationAttributes> {
existingMessage?: MessageModel; existingMessage?: MessageModel;
}): Promise<void> { }): Promise<void> {
if (this.isPublic()) { if (this.isPublic()) {
window.log.warning( window.log.warn("updateExpireTimer() Disappearing messages aren't supported in communities");
"WIP: updateExpireTimer() Disappearing messages aren't supported in communities"
);
return; return;
} }
@ -1094,7 +1089,7 @@ export class ConversationModel extends Backbone.Model<ConversationAttributes> {
if ( if (
this.get('lastDisappearingMessageChangeTimestamp') > lastDisappearingMessageChangeTimestamp this.get('lastDisappearingMessageChangeTimestamp') > lastDisappearingMessageChangeTimestamp
) { ) {
window.log.info('WIP: updateExpireTimer() This is an outdated disappearing message setting'); window.log.info('updateExpireTimer() This is an outdated disappearing message setting');
return; return;
} }
@ -1103,7 +1098,7 @@ export class ConversationModel extends Backbone.Model<ConversationAttributes> {
isEqual(expireTimer, this.get('expireTimer')) isEqual(expireTimer, this.get('expireTimer'))
) { ) {
window.log.info( window.log.info(
'WIP:updateExpireTimer() Dropping ExpireTimerUpdate message as we already have the same one set.' 'updateExpireTimer() Dropping ExpireTimerUpdate message as we already have the same one set.'
); );
return; return;
} }
@ -1126,7 +1121,7 @@ export class ConversationModel extends Backbone.Model<ConversationAttributes> {
lastDisappearingMessageChangeTimestamp, lastDisappearingMessageChangeTimestamp,
}); });
window?.log?.info('WIP: Updating conversation disappearing messages setting', { window?.log?.debug('Updating conversation disappearing messages setting', {
id: this.idForLogging(), id: this.idForLogging(),
expirationType, expirationType,
expireTimer, expireTimer,
@ -1197,7 +1192,7 @@ export class ConversationModel extends Backbone.Model<ConversationAttributes> {
// TODO Check that the args are correct // TODO Check that the args are correct
// This might be happening too late in the message pipeline. Maybe should be moved to handleExpirationTimerUpdateNoCommit() // This might be happening too late in the message pipeline. Maybe should be moved to handleExpirationTimerUpdateNoCommit()
if (expireUpdate.expirationType === 'deleteAfterRead') { if (expireUpdate.expirationType === 'deleteAfterRead') {
window.log.info('WIP: Note to Self messages cannot be delete after read!'); window.log.info('Note to Self messages cannot be delete after read!');
return; return;
} }

2
ts/models/message.ts
Unescape Escape View File

@ -1280,7 +1280,7 @@ export class MessageModel extends Backbone.Model<MessageAttributes> {
await this.commit(); await this.commit();
} }
window?.log?.info('WIP: Set message expiration', { window?.log?.debug('Set message expiration', {
expiresAt, expiresAt,
sentAt: this.get('sent_at'), sentAt: this.get('sent_at'),
}); });

2
ts/receiver/contentMessage.ts
Unescape Escape View File

@ -417,7 +417,7 @@ export async function innerHandleSwarmContentMessage(
expireUpdate expireUpdate
); );
if (expireUpdate.isLegacyConversationSettingMessage) { if (expireUpdate.isLegacyConversationSettingMessage) {
window.log.info('WIP: The legacy message is an expiration timer update. Ignoring it.'); window.log.info('The legacy message is an expiration timer update. Ignoring it.');
return; return;
} }
} }

2
ts/receiver/dataMessage.ts
Unescape Escape View File

@ -246,7 +246,7 @@ export async function handleSwarmDataMessage(
if (expireUpdate && !isEmpty(expireUpdate)) { if (expireUpdate && !isEmpty(expireUpdate)) {
if (isSyncedMessage) { if (isSyncedMessage) {
// TODO handle sync messages expiring separately? // TODO handle sync messages expiring separately?
window.log.info('WIP: Sync Message dropping'); window.log.debug('WIP: Sync Message dropping');
} else { } else {
msgModel = handleExpireUpdate(convoToAddMessageTo, msgModel, expireUpdate); msgModel = handleExpireUpdate(convoToAddMessageTo, msgModel, expireUpdate);
} }

4
ts/receiver/queuedJob.ts
Unescape Escape View File

@ -361,7 +361,7 @@ export async function handleMessageJob(
(!expirationTimerUpdate || isEmpty(expirationTimerUpdate)) (!expirationTimerUpdate || isEmpty(expirationTimerUpdate))
) { ) {
window.log.info( window.log.info(
'WIP: There is a problem with the expiration timer update', 'There is a problem with the expiration timer update',
messageModel, messageModel,
expirationTimerUpdate expirationTimerUpdate
); );
@ -380,7 +380,7 @@ export async function handleMessageJob(
) { ) {
confirm?.(); confirm?.();
window?.log?.info( window?.log?.info(
'WIP: Dropping ExpireTimerUpdate message as we already have the same one set.' 'Dropping ExpireTimerUpdate message as we already have the same one set.'
); );
return; return;
} }

2
ts/session/apis/snode_api/SNodeAPI.ts
Unescape Escape View File

@ -554,8 +554,6 @@ export async function retrieveNextMessages(
handleTimestampOffset('retrieve', json.t); handleTimestampOffset('retrieve', json.t);
await handleHardforkResult(json); await handleHardforkResult(json);
// console.log(`WIP: retrieveNextMessages`, json.messages);
return json.messages || []; return json.messages || [];
} catch (e) { } catch (e) {
window?.log?.warn('exception while parsing json of nextMessage:', e); window?.log?.warn('exception while parsing json of nextMessage:', e);

49
ts/session/apis/snode_api/expire.ts
Unescape Escape View File

@ -31,7 +31,7 @@ async function generateSignature({
// "expire" || ShortenOrExtend || expiry || messages[0] || ... || messages[N] // "expire" || ShortenOrExtend || expiry || messages[0] || ... || messages[N]
const verificationString = `expire${shortenOrExtend}${timestamp}${messageHashes.join('')}`; const verificationString = `expire${shortenOrExtend}${timestamp}${messageHashes.join('')}`;
const verificationData = StringUtils.encode(verificationString, 'utf8'); const verificationData = StringUtils.encode(verificationString, 'utf8');
// window.log.info(`WIP: generateSignature verificationString ${verificationString}`); window.log.debug(`generateSignature verificationString ${verificationString}`);
const message = new Uint8Array(verificationData); const message = new Uint8Array(verificationData);
const sodium = await getSodiumRenderer(); const sodium = await getSodiumRenderer();
@ -44,7 +44,7 @@ async function generateSignature({
pubkey_ed25519: pubkey_ed25519.pubKey, pubkey_ed25519: pubkey_ed25519.pubKey,
}; };
} catch (e) { } catch (e) {
window.log.warn('WIP: generateSignature failed with: ', e.message); window.log.warn('generateSignature failed with: ', e.message);
return null; return null;
} }
} }
@ -68,7 +68,7 @@ async function verifySignature({
unchangedHashes?: Record<string, string>; unchangedHashes?: Record<string, string>;
}): Promise<boolean> { }): Promise<boolean> {
if (!expiryApplied || isEmpty(messageHashes) || isEmpty(signature)) { if (!expiryApplied || isEmpty(messageHashes) || isEmpty(signature)) {
// window.log.info('WIP: WIP: verifySignature missing argument'); window.log.warn('verifySignature missing argument');
return false; return false;
} }
@ -91,7 +91,7 @@ async function verifySignature({
const verificationString = `${pubkey.key}${expiryApplied}${hashes.join('')}`; const verificationString = `${pubkey.key}${expiryApplied}${hashes.join('')}`;
const verificationData = StringUtils.encode(verificationString, 'utf8'); const verificationData = StringUtils.encode(verificationString, 'utf8');
// window.log.info(`WIP: verifySignature verificationString`, verificationString); window.log.debug(`verifySignature verificationString`, verificationString);
const sodium = await getSodiumRenderer(); const sodium = await getSodiumRenderer();
try { try {
@ -103,7 +103,7 @@ async function verifySignature({
return isValid; return isValid;
} catch (e) { } catch (e) {
window.log.warn('WIP: verifySignature failed with: ', e.message); window.log.warn('verifySignature failed with: ', e.message);
return false; return false;
} }
} }
@ -115,20 +115,19 @@ async function processExpirationResults(
messageHashes: Array<string> messageHashes: Array<string>
) { ) {
if (isEmpty(swarm)) { if (isEmpty(swarm)) {
throw Error(`WIP: expireOnNodes failed! ${messageHashes}`); throw Error(`expireOnNodes failed! ${messageHashes}`);
} }
// TODO need proper typing for swarm and results // TODO need proper typing for swarm and results
const results: Record<string, { hashes: Array<string>; expiry: number }> = {}; const results: Record<string, { hashes: Array<string>; expiry: number }> = {};
// window.log.info(`WIP: processExpirationResults start`, swarm, messageHashes); // window.log.debug(`processExpirationResults start`, swarm, messageHashes);
for (const nodeKey of Object.keys(swarm)) { for (const nodeKey of Object.keys(swarm)) {
// window.log.info(`WIP: processExpirationResults processing nodeKey`, nodeKey, swarm[nodeKey]);
if (!isEmpty(swarm[nodeKey].failed)) { if (!isEmpty(swarm[nodeKey].failed)) {
const reason = 'Unknown'; const reason = 'Unknown';
const statusCode = '404'; const statusCode = '404';
window?.log?.warn( window?.log?.warn(
`WIP: loki_message:::expireMessage - Couldn't delete data from: ${ `loki_message:::expireMessage - Couldn't delete data from: ${
targetNode.pubkey_ed25519 targetNode.pubkey_ed25519
}${reason && statusCode && ` due to an error ${reason} (${statusCode})`}` }${reason && statusCode && ` due to an error ${reason} (${statusCode})`}`
); );
@ -141,8 +140,6 @@ async function processExpirationResults(
const expiryApplied = swarm[nodeKey].expiry; const expiryApplied = swarm[nodeKey].expiry;
const signature = swarm[nodeKey].signature; const signature = swarm[nodeKey].signature;
// window.log.info(`WIP: processExpirationResults swarm[nodeKey]`, swarm[nodeKey]);
const isValid = await verifySignature({ const isValid = await verifySignature({
pubkey, pubkey,
snodePubkey: nodeKey, snodePubkey: nodeKey,
@ -155,7 +152,7 @@ async function processExpirationResults(
if (!isValid) { if (!isValid) {
window.log.warn( window.log.warn(
'WIP: loki_message:::expireMessage - Signature verification failed!', 'loki_message:::expireMessage - Signature verification failed!',
messageHashes messageHashes
); );
} }
@ -189,27 +186,21 @@ async function expireOnNodes(targetNode: Snode, params: ExpireParams) {
try { try {
const parsed = JSON.parse(result.body); const parsed = JSON.parse(result.body);
await processExpirationResults(params.pubkey, targetNode, parsed.swarm, params.messages); const expirationResults = await processExpirationResults(
params.pubkey,
// const expirationResults = await processExpirationResults( targetNode,
// params.pubkey, parsed.swarm,
// targetNode, params.messages
// parsed.swarm, );
// params.messages window.log.debug(`expireOnNodes attempt complete. Here are the results`, expirationResults);
// );
// window.log.info(`WIP: expireOnNodes attempt complete. Here are the results`, expirationResults);
return true; return true;
} catch (e) { } catch (e) {
window?.log?.warn('WIP: Failed to parse "swarm" result: ', e.msg); window?.log?.warn('expireOnNodes Failed to parse "swarm" result: ', e.msg);
} }
return false; return false;
} catch (e) { } catch (e) {
window?.log?.warn( window?.log?.warn('expire - send error:', e, `destination ${targetNode.ip}:${targetNode.port}`);
'WIP: expire - send error:',
e,
`destination ${targetNode.ip}:${targetNode.port}`
);
throw e; throw e;
} }
} }
@ -223,7 +214,6 @@ type ExpireMessageOnSnodeProps = {
export async function expireMessageOnSnode(props: ExpireMessageOnSnodeProps) { export async function expireMessageOnSnode(props: ExpireMessageOnSnodeProps) {
const { messageHash, expireTimer, extend, shorten } = props; const { messageHash, expireTimer, extend, shorten } = props;
// window.log.info('WIP: expireMessageOnSnode running!');
if (extend && shorten) { if (extend && shorten) {
window.log.error( window.log.error(
@ -270,8 +260,6 @@ export async function expireMessageOnSnode(props: ExpireMessageOnSnodeProps) {
signature: signResult?.signature, signature: signResult?.signature,
}; };
// window.log.info(`WIP: expireMessageOnSnode params`, params);
const usedNodes = slice(swarm, 0, DEFAULT_CONNECTIONS); const usedNodes = slice(swarm, 0, DEFAULT_CONNECTIONS);
if (!usedNodes || usedNodes.length === 0) { if (!usedNodes || usedNodes.length === 0) {
throw new EmptySwarmError(ourPubKey.key, 'Ran out of swarm nodes to query'); throw new EmptySwarmError(ourPubKey.key, 'Ran out of swarm nodes to query');
@ -289,7 +277,6 @@ export async function expireMessageOnSnode(props: ExpireMessageOnSnodeProps) {
try { try {
const firstSuccessSnode = await firstTrue(promises); const firstSuccessSnode = await firstTrue(promises);
snode = firstSuccessSnode; snode = firstSuccessSnode;
// window.log.info(`WIP: expireMessageOnSnode firstSuccessSnode`, firstSuccessSnode);
} catch (e) { } catch (e) {
const snodeStr = snode ? `${snode.ip}:${snode.port}` : 'null'; const snodeStr = snode ? `${snode.ip}:${snode.port}` : 'null';
window?.log?.warn( window?.log?.warn(

2
ts/session/utils/syncUtils.ts
Unescape Escape View File

@ -349,7 +349,7 @@ export const buildSyncMessage = (
if (expireUpdate && !isEmpty(expireUpdate)) { if (expireUpdate && !isEmpty(expireUpdate)) {
return buildSyncExpireTimerMessage(identifier, expireUpdate, timestamp, syncTarget); return buildSyncExpireTimerMessage(identifier, expireUpdate, timestamp, syncTarget);
} else { } else {
window.log.info('WIP: Building Sync Expire Timer Message failed', dataMessage, expireUpdate); window.log.warn('Building Sync Expire Timer Message failed', dataMessage, expireUpdate);
} }
} }
return buildSyncVisibleMessage(identifier, dataMessage, timestamp, syncTarget); return buildSyncVisibleMessage(identifier, dataMessage, timestamp, syncTarget);

24
ts/util/expiringMessages.ts
Unescape Escape View File

@ -235,8 +235,8 @@ export function setExpirationStartTimestamp(
// TODO legacy messages support will be removed in a future release // TODO legacy messages support will be removed in a future release
if (timestamp) { if (timestamp) {
window.log.info( window.log.debug(
`WIP: We compare 2 timestamps for a disappear ${ `We compare 2 timestamps for a disappear ${
isLegacyMode ? 'legacy' : mode === 'deleteAfterRead' ? 'after read' : 'after send' isLegacyMode ? 'legacy' : mode === 'deleteAfterRead' ? 'after read' : 'after send'
} message: \expirationStartTimestamp `, } message: \expirationStartTimestamp `,
new Date(expirationStartTimestamp).toLocaleTimeString(), new Date(expirationStartTimestamp).toLocaleTimeString(),
@ -248,22 +248,22 @@ export function setExpirationStartTimestamp(
// TODO legacy messages support will be removed in a future release // TODO legacy messages support will be removed in a future release
if (mode === 'deleteAfterRead') { if (mode === 'deleteAfterRead') {
window.log.info( window.log.debug(
`WIP: We set the start timestamp for a ${ `We set the start timestamp for a ${
isLegacyMode ? 'legacy ' : '' isLegacyMode ? 'legacy ' : ''
}delete after read message to ${new Date(expirationStartTimestamp).toLocaleTimeString()}` }delete after read message to ${new Date(expirationStartTimestamp).toLocaleTimeString()}`
); );
} else if (mode === 'deleteAfterSend') { } else if (mode === 'deleteAfterSend') {
window.log.info( window.log.debug(
`WIP: We set the start timestamp for a ${ `We set the start timestamp for a ${
isLegacyMode ? 'legacy ' : '' isLegacyMode ? 'legacy ' : ''
}delete after send message to ${new Date(expirationStartTimestamp).toLocaleTimeString()}` }delete after send message to ${new Date(expirationStartTimestamp).toLocaleTimeString()}`
); );
} else if (mode === 'off') { } else if (mode === 'off') {
window.log.info(`WIP: Disappearing message mode "${mode}" set. We can safely ignore this.`); window.log.debug(`Disappearing message mode "${mode}" set. We can safely ignore this.`);
expirationStartTimestamp = undefined; expirationStartTimestamp = undefined;
} else { } else {
window.log.info(`WIP: Invalid disappearing message mode "${mode}" set. Ignoring`); window.log.debug(`Invalid disappearing message mode "${mode}" set. Ignoring`);
expirationStartTimestamp = undefined; expirationStartTimestamp = undefined;
} }
@ -332,7 +332,7 @@ export async function checkForExpireUpdate(
isDisappearingMessagesV2Released && isDisappearingMessagesV2Released &&
(isLegacyDataMessage || isLegacyConversationSettingMessage || shouldDisappearButIsntMessage) (isLegacyDataMessage || isLegacyConversationSettingMessage || shouldDisappearButIsntMessage)
) { ) {
window.log.info('WIP: received a legacy disappearing message after v2 was released.'); window.log.warn('Received a legacy disappearing message after v2 was released.', content);
expirationType = convoToUpdate.get('expirationType'); expirationType = convoToUpdate.get('expirationType');
expirationTimer = convoToUpdate.get('expireTimer'); expirationTimer = convoToUpdate.get('expireTimer');
} }
@ -346,8 +346,6 @@ export async function checkForExpireUpdate(
isDisappearingMessagesV2Released, isDisappearingMessagesV2Released,
}; };
// window.log.info('WIP: checkForExpireUpdate', expireUpdate);
return expireUpdate; return expireUpdate;
} }
@ -358,9 +356,7 @@ export function handleExpireUpdate(
expireUpdate: DisappearingMessageUpdate expireUpdate: DisappearingMessageUpdate
) { ) {
if (converationModel.isPublic()) { if (converationModel.isPublic()) {
window.log.warning( window.log.warn("updateExpireTimer() Disappearing messages aren't supported in communities");
"WIP: updateExpireTimer() Disappearing messages aren't supported in communities"
);
return messageModel; return messageModel;
} }

6
ts/util/releaseFeature.ts
Unescape Escape View File

@ -36,9 +36,7 @@ export async function checkIsFeatureReleased(featureName: string): Promise<boole
if (featureAlreadyReleased) { if (featureAlreadyReleased) {
// Feature is already released and we don't need to update the db // Feature is already released and we don't need to update the db
} else { } else {
window.log.info( window.log.info(`[releaseFeature]: It is time to release ${featureName}. Releasing it now`);
`WIP: [releaseFeature]: It is time to release ${featureName}. Releasing it now`
);
await Data.createOrUpdateItem({ await Data.createOrUpdateItem({
id: 'featureReleased', id: 'featureReleased',
value: true, value: true,
@ -59,7 +57,7 @@ export async function checkIsFeatureReleased(featureName: string): Promise<boole
} }
window.log.info( window.log.info(
`WIP: [releaseFeature]: ${featureName} ${ `[releaseFeature]: ${featureName} ${
Boolean(isFeatureReleased) ? 'is released' : 'has not been released yet' Boolean(isFeatureReleased) ? 'is released' : 'has not been released yet'
}` }`
); );

Write Preview
Loading…
Cancel
Save