Skip to content

Commit 7240493

Browse files
author
Corentin Mors
authored
Rework logging system (#248)
This PR adds a much needed cleanup of the logging system.
1 parent 290195c commit 7240493

28 files changed

+182
-89
lines changed

‎src/command-handlers/backup.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import winston from 'winston';
21
import fs from 'fs';
32
import { connectAndPrepare, getDatabasePath } from '../modules/database';
3+
import { logger } from '../logger';
44

55
export const runBackup = async (options: { directory: string; filename: string }) => {
66
const { db } = await connectAndPrepare({ failIfNoDB: true, forceSync: true });
@@ -19,5 +19,5 @@ export const runBackup = async (options: { directory: string; filename: string }
1919

2020
fs.copyFileSync(databasePath, backupPath);
2121

22-
winston.info(`Backup saved to ${backupPath}`);
22+
logger.success(`Backup saved to ${backupPath}.`);
2323
};

‎src/command-handlers/configure.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import winston from 'winston';
21
import { encryptAesCbcHmac256 } from '../modules/crypto/encrypt';
32
import { deleteLocalKey, setLocalKey, warnUnreachableKeychainDisabled } from '../modules/crypto/keychainManager';
43
import { connectAndPrepare } from '../modules/database';
54
import { parseBooleanString } from '../utils';
65
import { DeviceConfiguration } from '../types';
6+
import { logger } from '../logger';
77

88
export const configureSaveMasterPassword = async (boolean: string) => {
99
let shouldNotSaveMasterPassword = !parseBooleanString(boolean);
@@ -23,7 +23,7 @@ export const configureSaveMasterPassword = async (boolean: string) => {
2323
if (error instanceof Error) {
2424
errorMessage = error.message;
2525
}
26-
winston.warn(`Unable to delete the local key from the keychain: ${errorMessage}`);
26+
logger.warn(`Unable to delete the local key from the keychain: ${errorMessage}`);
2727
}
2828
}
2929

‎src/command-handlers/devices.ts

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import winston from 'winston';
21
import { connectAndPrepare, reset } from '../modules/database';
32
import { deactivateDevices, listDevices, ListDevicesOutput } from '../endpoints';
43
import { askConfirmReset, epochTimestampToIso } from '../utils';
54
import { registerDevice } from '../modules/auth';
65
import { get2FAStatusUnauthenticated } from '../endpoints/get2FAStatusUnauthenticated';
6+
import { logger } from '../logger';
77

88
type OutputDevice = ListDevicesOutput['devices'][number] & {
99
isCurrentDevice: boolean;
@@ -22,7 +22,7 @@ export async function listAllDevices(options: { json: boolean }) {
2222
);
2323

2424
if (options.json) {
25-
console.log(JSON.stringify(result));
25+
logger.content(JSON.stringify(result));
2626
} else {
2727
// order by last activity, ascending.
2828
// we sort it only on non-json because it is likely that it will be used
@@ -127,14 +127,16 @@ export const registerNonInteractiveDevice = async (deviceName: string, options:
127127
const serviceDeviceKeys = `dls_${deviceAccessKey}_${serviceDeviceKeysPayloadB64}`;
128128

129129
if (options.json) {
130-
console.log(
130+
logger.content(
131131
JSON.stringify({
132132
DASHLANE_SERVICE_DEVICE_KEYS: serviceDeviceKeys,
133133
})
134134
);
135135
} else {
136-
winston.info('The device credentials have been generated, save and run the following command to export them:');
137-
console.log(`export DASHLANE_SERVICE_DEVICE_KEYS=${serviceDeviceKeys}`);
136+
logger.success(
137+
'The device credentials have been generated, save and run the following command to export them:'
138+
);
139+
logger.content(`export DASHLANE_SERVICE_DEVICE_KEYS=${serviceDeviceKeys}`);
138140
}
139141

140142
db.close();

‎src/command-handlers/exec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { Command } from 'commander';
2-
import winston from 'winston';
32
import { spawn } from 'child_process';
43
import { getVaultContent, initVaultContent } from '../modules/database';
4+
import { logger } from '../logger';
55

66
export const runExec = async (_options: unknown, program: Command) => {
77
const command = program.args.join(' ');
@@ -26,6 +26,6 @@ export const runExec = async (_options: unknown, program: Command) => {
2626

2727
// listen for process exit
2828
child.on('exit', (code) => {
29-
winston.debug(`Child process exited with code ${code ?? 'unknown'}`);
29+
logger.debug(`Child process exited with code ${code ?? 'unknown'}`);
3030
});
3131
};

‎src/command-handlers/inject.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import fs from 'fs';
22
import { getVaultContent, initVaultContent } from '../modules/database';
3+
import { logger } from '../logger';
34

45
interface InjectOpts {
56
in: string;
@@ -78,6 +79,6 @@ const outputContent = (output: string, outputFilePath?: string) => {
7879
if (outputFilePath) {
7980
fs.writeFileSync(outputFilePath, output);
8081
} else {
81-
console.log(output);
82+
logger.content(output);
8283
}
8384
};

‎src/command-handlers/logout.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { Database } from 'better-sqlite3';
2-
import winston from 'winston';
32
import { deactivateDevices } from '../endpoints';
43
import { connectAndPrepare, connect, reset } from '../modules/database';
54
import { LocalConfiguration, DeviceConfiguration } from '../types';
65
import { askConfirmReset } from '../utils';
6+
import { logger } from '../logger';
77

88
export const runLogout = async (options: { ignoreRevocation: boolean }) => {
99
if (options.ignoreRevocation) {
10-
winston.info("The device credentials won't be revoked on Dashlane's servers");
10+
logger.info("The device credentials won't be revoked on Dashlane's servers.");
1111
}
1212

1313
const resetConfirmation = await askConfirmReset();
@@ -28,7 +28,7 @@ export const runLogout = async (options: { ignoreRevocation: boolean }) => {
2828
if (error instanceof Error) {
2929
errorMessage = error.message;
3030
}
31-
winston.debug(`Unable to read device configuration during logout: ${errorMessage}`);
31+
logger.debug(`Unable to read device configuration during logout: ${errorMessage}`);
3232

3333
db = connect();
3434
db.serialize();
@@ -38,9 +38,9 @@ export const runLogout = async (options: { ignoreRevocation: boolean }) => {
3838
deviceIds: [deviceConfiguration.accessKey],
3939
login: deviceConfiguration.login,
4040
localConfiguration,
41-
}).catch((error) => console.error('Unable to deactivate the device', error));
41+
}).catch((error) => logger.error('Unable to deactivate the device', error));
4242
}
4343
reset({ db, localConfiguration });
44-
console.log('The local Dashlane local storage has been reset and you have been logged out');
44+
logger.success('The local Dashlane local storage has been reset and you have been logged out.');
4545
db.close();
4646
};

‎src/command-handlers/passwords.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import Database from 'better-sqlite3';
22
import { Clipboard } from '@napi-rs/clipboard';
33
import { authenticator } from 'otplib';
4-
import winston from 'winston';
54
import { AuthentifiantTransactionContent, BackupEditTransaction, LocalConfiguration, VaultCredential } from '../types';
65
import { decryptTransactions } from '../modules/crypto';
76
import { askCredentialChoice, filterMatches } from '../utils';
87
import { connectAndPrepare } from '../modules/database';
8+
import { logger } from '../logger';
99

1010
export const runPassword = async (
1111
filters: string[] | null,
@@ -18,7 +18,7 @@ export const runPassword = async (
1818
db.close();
1919

2020
if (output === 'json') {
21-
console.log(JSON.stringify(foundCredentials));
21+
logger.content(JSON.stringify(foundCredentials));
2222
return;
2323
}
2424

@@ -54,19 +54,19 @@ export const runPassword = async (
5454
}
5555

5656
if (output === 'console') {
57-
console.log(result);
57+
logger.content(result);
5858
}
5959

6060
const clipboard = new Clipboard();
6161
clipboard.setText(result);
62-
console.log(
62+
logger.content(
6363
`🔓 ${field} for "${selectedCredential.title || selectedCredential.url || 'N/C'}" copied to clipboard!`
6464
);
6565

6666
if (field === 'password' && selectedCredential.otpSecret) {
6767
const token = authenticator.generate(selectedCredential.otpSecret);
6868
const timeRemaining = authenticator.timeRemaining();
69-
console.log(`🔢 OTP code: ${token} \u001B[3m(expires in ${timeRemaining} seconds)\u001B[0m`);
69+
logger.content(`🔢 OTP code: ${token} \u001B[3m(expires in ${timeRemaining} seconds)\u001B[0m`);
7070
}
7171
};
7272

@@ -79,7 +79,7 @@ interface GetCredential {
7979
export const findCredentials = async (params: GetCredential): Promise<VaultCredential[]> => {
8080
const { localConfiguration, filters, db } = params;
8181

82-
winston.debug(`Retrieving: ${filters && filters.length > 0 ? filters.join(' ') : ''}`);
82+
logger.debug(`Retrieving: ${filters && filters.length > 0 ? filters.join(' ') : ''}`);
8383
const transactions = db
8484
.prepare(`SELECT * FROM transactions WHERE login = ? AND type = 'AUTHENTIFIANT' AND action = 'BACKUP_EDIT'`)
8585
.bind(localConfiguration.login)

‎src/command-handlers/read.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { logger } from '../logger';
12
import { decryptTransactions } from '../modules/crypto';
23
import { connectAndPrepare, findVaultContent } from '../modules/database';
34
import {
@@ -62,5 +63,5 @@ export const runRead = async (path: string) => {
6263
secrets: decryptedSecrets,
6364
});
6465

65-
console.log(findVaultContent(secretsDecrypted, parsedPath));
66+
logger.content(findVaultContent(secretsDecrypted, parsedPath));
6667
};

‎src/command-handlers/secrets.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import Database from 'better-sqlite3';
2-
import winston from 'winston';
32
import { BackupEditTransaction, LocalConfiguration, SecretTransactionContent, VaultSecret } from '../types';
43
import { decryptTransactions } from '../modules/crypto';
54
import { askSecretChoice, filterMatches } from '../utils';
65
import { connectAndPrepare } from '../modules/database';
6+
import { logger } from '../logger';
77

88
export const runSecret = async (filters: string[] | null, options: { output: 'text' | 'json' }) => {
99
const { db, localConfiguration } = await connectAndPrepare({});
@@ -26,7 +26,7 @@ interface GetSecret {
2626
export const getSecret = async (params: GetSecret): Promise<void> => {
2727
const { localConfiguration, filters, db, output } = params;
2828

29-
winston.debug(`Retrieving: ${filters && filters.length > 0 ? filters.join(' ') : ''}`);
29+
logger.debug(`Retrieving: ${filters && filters.length > 0 ? filters.join(' ') : ''}`);
3030
const transactions = db
3131
.prepare(`SELECT * FROM transactions WHERE login = ? AND type = 'SECRET' AND action = 'BACKUP_EDIT'`)
3232
.bind(localConfiguration.login)
@@ -49,7 +49,7 @@ export const getSecret = async (params: GetSecret): Promise<void> => {
4949

5050
switch (output) {
5151
case 'json':
52-
console.log(JSON.stringify(matchedSecrets));
52+
logger.content(JSON.stringify(matchedSecrets));
5353
break;
5454
case 'text': {
5555
let selectedSecret: VaultSecret | null = null;
@@ -63,7 +63,7 @@ export const getSecret = async (params: GetSecret): Promise<void> => {
6363
selectedSecret = await askSecretChoice({ matchedSecrets, hasFilters: Boolean(filters?.length) });
6464
}
6565

66-
console.log(selectedSecret.content);
66+
logger.content(selectedSecret.content);
6767
break;
6868
}
6969
default:

‎src/command-handlers/secureNotes.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import Database from 'better-sqlite3';
2-
import winston from 'winston';
32
import { BackupEditTransaction, LocalConfiguration, SecureNoteTransactionContent, VaultNote } from '../types';
43
import { decryptTransactions } from '../modules/crypto';
54
import { askSecureNoteChoice, filterMatches } from '../utils';
65
import { connectAndPrepare } from '../modules/database';
6+
import { logger } from '../logger';
77

88
export const runSecureNote = async (filters: string[] | null, options: { output: 'text' | 'json' }) => {
99
const { db, localConfiguration } = await connectAndPrepare({});
@@ -26,7 +26,7 @@ interface GetSecureNote {
2626
export const getNote = async (params: GetSecureNote): Promise<void> => {
2727
const { localConfiguration, filters, db, output } = params;
2828

29-
winston.debug(`Retrieving: ${filters && filters.length > 0 ? filters.join(' ') : ''}`);
29+
logger.debug(`Retrieving: ${filters && filters.length > 0 ? filters.join(' ') : ''}`);
3030
const transactions = db
3131
.prepare(`SELECT * FROM transactions WHERE login = ? AND type = 'SECURENOTE' AND action = 'BACKUP_EDIT'`)
3232
.bind(localConfiguration.login)
@@ -49,7 +49,7 @@ export const getNote = async (params: GetSecureNote): Promise<void> => {
4949

5050
switch (output) {
5151
case 'json':
52-
console.log(JSON.stringify(matchedNotes));
52+
logger.content(JSON.stringify(matchedNotes));
5353
break;
5454
case 'text': {
5555
let selectedNote: VaultNote | null = null;
@@ -63,7 +63,7 @@ export const getNote = async (params: GetSecureNote): Promise<void> => {
6363
selectedNote = await askSecureNoteChoice({ matchedNotes, hasFilters: Boolean(filters?.length) });
6464
}
6565

66-
console.log(selectedNote.content);
66+
logger.content(selectedNote.content);
6767
break;
6868
}
6969
default:

‎src/command-handlers/sync.ts

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import Database from 'better-sqlite3';
2-
import winston from 'winston';
32
import { connectAndPrepare } from '../modules/database';
43
import { decrypt } from '../modules/crypto/decrypt';
54
import { encryptAesCbcHmac256 } from '../modules/crypto/encrypt';
@@ -8,11 +7,12 @@ import { getLatestContent } from '../endpoints';
87
import type { DeviceConfiguration, LocalConfiguration } from '../types';
98
import { notEmpty } from '../utils';
109
import { askReplaceIncorrectMasterPassword } from '../utils/dialogs';
10+
import { logger } from '../logger';
1111

1212
export const runSync = async () => {
1313
const { db, localConfiguration, deviceConfiguration } = await connectAndPrepare({ autoSync: false });
1414
await sync({ db, localConfiguration, deviceConfiguration });
15-
winston.info('Successfully synced');
15+
logger.success('Successfully synced');
1616
db.close();
1717
};
1818

@@ -25,7 +25,7 @@ interface Sync {
2525
export const sync = async (params: Sync) => {
2626
const { db } = params;
2727
let { localConfiguration } = params;
28-
winston.debug('Start syncing...');
28+
logger.debug('Start syncing...');
2929

3030
const lastServerSyncTimestamp =
3131
(
@@ -64,7 +64,7 @@ export const sync = async (params: Sync) => {
6464
if (error instanceof Error) {
6565
errorMessage = error.message;
6666
}
67-
winston.debug(`Unable to decrypt a transactions while sync: ${errorMessage}`);
67+
logger.debug(`Unable to decrypt a transactions while sync: ${errorMessage}`);
6868

6969
if (transac.identifier === 'SETTINGS_userId') {
7070
if (!(await askReplaceIncorrectMasterPassword())) {
@@ -99,10 +99,10 @@ export const sync = async (params: Sync) => {
9999
const nbErrors = latestContent.transactions.length - values.length;
100100

101101
if (nbErrors !== 0) {
102-
winston.debug(`Ignored ${nbErrors} decryption errors`);
102+
logger.debug(`Ignored ${nbErrors} decryption errors`);
103103
}
104104

105-
winston.debug(`Number of new updates: ${values.length}`);
105+
logger.debug(`Number of new updates: ${values.length}`);
106106

107107
const statement = db.prepare(
108108
'REPLACE INTO transactions (login, identifier, type, action, content) VALUES (?, ?, ?, ?, ?)'
@@ -120,11 +120,11 @@ export const sync = async (params: Sync) => {
120120
.bind(localConfiguration.login, Number(latestContent.timestamp), Math.floor(Date.now() / 1000))
121121
.run();
122122

123-
winston.debug(`Requested timestamp ${lastServerSyncTimestamp}, new timestamp ${latestContent.timestamp}`);
123+
logger.debug(`Requested timestamp ${lastServerSyncTimestamp}, new timestamp ${latestContent.timestamp}`);
124124

125125
const summaryCounted: Record<string, number> = {};
126126
Object.keys(latestContent.summary).forEach((key) => {
127127
summaryCounted[key] = Object.keys(latestContent.summary[key]).length;
128128
});
129-
winston.debug(JSON.stringify(summaryCounted, null, 4));
129+
logger.debug(JSON.stringify(summaryCounted, null, 4));
130130
};

‎src/command-handlers/teamDarkWebInsightsReport.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { getTeamDarkWebInsightsReport } from '../endpoints';
2+
import { logger } from '../logger';
23
import { getTeamDeviceCredentials } from '../utils';
34

45
export const runTeamDarkWebInsightsReport = async (
@@ -17,5 +18,5 @@ export const runTeamDarkWebInsightsReport = async (
1718
offset: offset ?? 0,
1819
});
1920

20-
console.log(JSON.stringify(response));
21+
logger.content(JSON.stringify(response));
2122
};

‎src/command-handlers/teamDevices.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { connectAndPrepare } from '../modules/database';
22
import { listTeamDevices, registerTeamDevice } from '../endpoints';
33
import { epochTimestampToIso } from '../utils';
4+
import { logger } from '../logger';
45

56
export const listAllTeamDevices = async (options: { json: boolean }) => {
67
const { db, localConfiguration } = await connectAndPrepare({ autoSync: false });
@@ -21,7 +22,7 @@ export const listAllTeamDevices = async (options: { json: boolean }) => {
2122
};
2223
});
2324

24-
console.log(JSON.stringify(result));
25+
logger.content(JSON.stringify(result));
2526
return;
2627
}
2728

0 commit comments

Comments
 (0)