Skip to content

A local-first personal finance app

API quiet mode (#5762)

Matt Fiddaman2c9a66cec6c7
diff --git a/eslint.config.mjs b/eslint.config.mjs
index 667d18959a..223d854041 100644
--- a/eslint.config.mjs
+++ b/eslint.config.mjs
@@ -451,6 +451,7 @@ export default pluginTypescript.config(
'actual/typography': 'warn',
'actual/prefer-if-statement': 'warn',
+ 'actual/prefer-logger-over-console': 'error',
// Note: base rule explicitly disabled in favor of the TS one
'no-unused-vars': 'off',
@@ -775,6 +776,7 @@ export default pluginTypescript.config(
rules: {
'actual/typography': 'off',
'actual/no-untranslated-strings': 'off',
+ 'actual/prefer-logger-over-console': 'off',
},
},
{
diff --git a/packages/eslint-plugin-actual/lib/index.js b/packages/eslint-plugin-actual/lib/index.js
index 2d10052aeb..a314b12cbe 100644
--- a/packages/eslint-plugin-actual/lib/index.js
+++ b/packages/eslint-plugin-actual/lib/index.js
@@ -4,5 +4,6 @@ module.exports = {
'prefer-trans-over-t': require('./rules/prefer-trans-over-t'),
typography: require('./rules/typography'),
'prefer-if-statement': require('./rules/prefer-if-statement'),
+ 'prefer-logger-over-console': require('./rules/prefer-logger-over-console'),
},
};
diff --git a/packages/eslint-plugin-actual/lib/rules/__tests__/prefer-logger-over-console.test.js b/packages/eslint-plugin-actual/lib/rules/__tests__/prefer-logger-over-console.test.js
new file mode 100644
index 0000000000..08ba7c9bd4
--- /dev/null
+++ b/packages/eslint-plugin-actual/lib/rules/__tests__/prefer-logger-over-console.test.js
@@ -0,0 +1,150 @@
+import { runClassic } from 'eslint-vitest-rule-tester';
+
+import * as rule from '../prefer-logger-over-console';
+
+runClassic(
+ 'prefer-logger-over-console',
+ rule,
+ {
+ valid: [
+ {
+ code: 'console.log("test");',
+ filename: 'packages/some-other-package/src/file.js',
+ },
+ {
+ code: 'logger.log("test");',
+ filename: 'packages/loot-core/src/server/test.ts',
+ },
+ ],
+ invalid: [
+ {
+ code: 'console.log("test");',
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger } from '../platform/server/log';
+logger.log("test");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'log' },
+ },
+ ],
+ },
+ {
+ code: 'console.warn("warning");',
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger } from '../platform/server/log';
+logger.warn("warning");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'warn' },
+ },
+ ],
+ },
+ {
+ code: 'console.error("error");',
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger } from '../platform/server/log';
+logger.error("error");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'error' },
+ },
+ ],
+ },
+ {
+ code: 'console.info("info");',
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger } from '../platform/server/log';
+logger.info("info");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'info' },
+ },
+ ],
+ },
+ {
+ code: 'console.debug("debug");',
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger } from '../platform/server/log';
+logger.debug("debug");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'debug' },
+ },
+ ],
+ },
+ {
+ code: 'console.group("Group Name");',
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger } from '../platform/server/log';
+logger.group("Group Name");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'group' },
+ },
+ ],
+ },
+ {
+ code: 'console.groupEnd();',
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger } from '../platform/server/log';
+logger.groupEnd();`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'groupEnd' },
+ },
+ ],
+ },
+ {
+ code: 'console.log("test");',
+ filename: 'packages/loot-core/src/server/sync/test.ts',
+ output: `import { logger } from '../../platform/server/log';
+logger.log("test");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'log' },
+ },
+ ],
+ },
+ {
+ code: `import { setVerboseMode } from '../platform/server/log';
+console.log("test");`,
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { setVerboseMode, logger } from '../platform/server/log';
+logger.log("test");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'log' },
+ },
+ ],
+ },
+ {
+ code: `import { logger as log } from '../platform/server/log';
+console.log("test");`,
+ filename: 'packages/loot-core/src/server/test.ts',
+ output: `import { logger as log } from '../platform/server/log';
+log.log("test");`,
+ errors: [
+ {
+ messageId: 'preferLogger',
+ data: { method: 'log' },
+ },
+ ],
+ },
+ ],
+ },
+ {
+ parserOptions: {
+ ecmaVersion: 2020,
+ sourceType: 'module',
+ },
+ },
+);
diff --git a/packages/eslint-plugin-actual/lib/rules/prefer-logger-over-console.js b/packages/eslint-plugin-actual/lib/rules/prefer-logger-over-console.js
new file mode 100644
index 0000000000..33ed508554
--- /dev/null
+++ b/packages/eslint-plugin-actual/lib/rules/prefer-logger-over-console.js
@@ -0,0 +1,155 @@
+/* eslint-disable actual/typography */
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+ meta: {
+ type: 'suggestion',
+ docs: {
+ description:
+ 'Replace console.log/warn/error calls with logger in loot-core files',
+ },
+ fixable: 'code',
+ schema: [],
+ messages: {
+ preferLogger: 'Use logger.{{method}} instead of console.{{method}}',
+ },
+ },
+
+ create(context) {
+ const filenameRaw = context.getFilename();
+ const normalizedFilename = filenameRaw.replace(/\\/g, '/');
+
+ const isLootCoreFile = normalizedFilename.includes(
+ 'packages/loot-core/src/server',
+ );
+
+ if (!isLootCoreFile) {
+ return {};
+ }
+
+ const methodMap = {
+ log: 'log',
+ warn: 'warn',
+ error: 'error',
+ info: 'info',
+ debug: 'debug',
+ group: 'group',
+ groupEnd: 'groupEnd',
+ };
+
+ function getLoggerImportInfo() {
+ const { ast } = context.getSourceCode();
+ for (const node of ast.body) {
+ if (
+ node.type === 'ImportDeclaration' &&
+ typeof node.source.value === 'string' &&
+ node.source.value.includes('platform/server/log')
+ ) {
+ const spec = node.specifiers.find(
+ s => s.type === 'ImportSpecifier' && s.imported.name === 'logger',
+ );
+ if (spec) {
+ return { decl: node, localName: spec.local.name };
+ }
+ return { decl: node, localName: null };
+ }
+ }
+ return { decl: null, localName: null };
+ }
+
+ function getLoggerImportPath() {
+ const pathParts = normalizedFilename.split('/');
+ const serverIndex = pathParts.indexOf('server');
+
+ if (serverIndex > -1) {
+ const depth = pathParts.length - serverIndex - 1;
+ return '../'.repeat(depth) + 'platform/server/log';
+ }
+
+ return '../platform/server/log';
+ }
+
+ return {
+ CallExpression(node) {
+ if (
+ node.callee.type === 'MemberExpression' &&
+ node.callee.object.type === 'Identifier' &&
+ node.callee.object.name === 'console' &&
+ node.callee.property.type === 'Identifier' &&
+ methodMap.hasOwnProperty(node.callee.property.name)
+ ) {
+ const method = node.callee.property.name;
+
+ context.report({
+ node,
+ messageId: 'preferLogger',
+ data: { method },
+ fix(fixer) {
+ const sourceCode = context.getSourceCode();
+ const program = sourceCode.ast;
+
+ const { decl, localName } = getLoggerImportInfo();
+ const loggerIdent = localName || 'logger';
+ const fixes = [
+ fixer.replaceText(
+ node.callee,
+ `${loggerIdent}.${methodMap[method]}`,
+ ),
+ ];
+
+ if (!localName) {
+ // If the module is already imported, append { logger } to it
+ if (decl && decl.specifiers && decl.specifiers.length > 0) {
+ const lastSpec = decl.specifiers[decl.specifiers.length - 1];
+ if (lastSpec.type === 'ImportSpecifier') {
+ fixes.unshift(fixer.insertTextAfter(lastSpec, ', logger'));
+ } else {
+ // Fallback: separate import if default/namespace import only
+ const importPath = getLoggerImportPath();
+ fixes.unshift(
+ fixer.insertTextAfter(
+ decl,
+ `\nimport { logger } from '${importPath}';`,
+ ),
+ );
+ }
+ } else if (decl) {
+ // No specifiers at all; insert a fresh named import after it
+ const importPath = getLoggerImportPath();
+ fixes.unshift(
+ fixer.insertTextAfter(
+ decl,
+ `\nimport { logger } from '${importPath}';`,
+ ),
+ );
+ } else {
+ const importPath = getLoggerImportPath();
+ const firstImport = program.body.find(
+ n => n.type === 'ImportDeclaration',
+ );
+ if (firstImport) {
+ fixes.unshift(
+ fixer.insertTextAfter(
+ firstImport,
+ `\nimport { logger } from '${importPath}';`,
+ ),
+ );
+ } else {
+ fixes.unshift(
+ fixer.insertTextBefore(
+ program.body[0],
+ `import { logger } from '${importPath}';\n`,
+ ),
+ );
+ }
+ }
+ }
+
+ return fixes;
+ },
+ });
+ }
+ },
+ };
+ },
+};
diff --git a/packages/loot-core/src/platform/server/log/index.ts b/packages/loot-core/src/platform/server/log/index.ts
index 500194c110..1be48bc621 100644
--- a/packages/loot-core/src/platform/server/log/index.ts
+++ b/packages/loot-core/src/platform/server/log/index.ts
@@ -1,8 +1,43 @@
+let verboseMode = true;
+
+export function setVerboseMode(verbose: boolean) {
+ verboseMode = verbose;
+}
+
+export function isVerboseMode(): boolean {
+ return verboseMode;
+}
+
export const logger = {
info: (...args: unknown[]) => {
- console.log(...args);
+ if (verboseMode) {
+ console.log(...args);
+ }
},
warn: (...args: unknown[]) => {
console.warn(...args);
},
+ log: (...args: unknown[]) => {
+ if (verboseMode) {
+ console.log(...args);
+ }
+ },
+ error: (...args: unknown[]) => {
+ console.error(...args);
+ },
+ debug: (...args: unknown[]) => {
+ if (verboseMode) {
+ console.debug(...args);
+ }
+ },
+ group: (...args: unknown[]) => {
+ if (verboseMode) {
+ console.group(...args);
+ }
+ },
+ groupEnd: () => {
+ if (verboseMode) {
+ console.groupEnd();
+ }
+ },
};
diff --git a/packages/loot-core/src/server/accounts/app.ts b/packages/loot-core/src/server/accounts/app.ts
index 67da0b13f6..2c6eb7b1bf 100644
--- a/packages/loot-core/src/server/accounts/app.ts
+++ b/packages/loot-core/src/server/accounts/app.ts
@@ -4,6 +4,7 @@ import { v4 as uuidv4 } from 'uuid';
import { captureException } from '../../platform/exceptions';
import * as asyncStorage from '../../platform/server/asyncStorage';
import * as connection from '../../platform/server/connection';
+import { logger } from '../../platform/server/log';
import { isNonProductionEnvironment } from '../../shared/environment';
import { dayFromDate } from '../../shared/months';
import * as monthUtils from '../../shared/months';
@@ -537,7 +538,7 @@ async function checkSecret(name: string) {
'X-ACTUAL-TOKEN': userToken,
});
} catch (error) {
- console.error(error);
+ logger.error(error);
return { error: 'failed' };
}
}
@@ -589,7 +590,7 @@ async function pollGoCardlessWebToken({
if (data) {
if (data.error_code) {
- console.error('Failed linking gocardless account:', data);
+ logger.error('Failed linking gocardless account:', data);
cb({ status: 'unknown', message: data.error_type });
} else {
cb({ status: 'success', data });
@@ -790,7 +791,7 @@ async function createGoCardlessWebToken({
},
);
} catch (error) {
- console.error(error);
+ logger.error(error);
return { error: 'failed' };
}
}
@@ -923,7 +924,7 @@ async function accountsBankSync({
for (const acct of accounts) {
if (acct.bankId && acct.account_id) {
try {
- console.group('Bank Sync operation for account:', acct.name);
+ logger.group('Bank Sync operation for account:', acct.name);
const syncResponse = await bankSync.syncAccount(
userId as string,
userKey as string,
@@ -945,7 +946,7 @@ async function accountsBankSync({
message: 'Failed syncing account “' + acct.name + '.”',
} as Error);
} finally {
- console.groupEnd();
+ logger.groupEnd();
}
}
}
@@ -992,7 +993,7 @@ async function simpleFinBatchSync({
};
}> = [];
- console.group('Bank Sync operation for all SimpleFin accounts');
+ logger.group('Bank Sync operation for all SimpleFin accounts');
try {
const syncResponses: Array<{
accountId: AccountEntity['id'];
@@ -1011,7 +1012,7 @@ async function simpleFinBatchSync({
for (const syncResponse of syncResponses) {
const account = accounts.find(a => a.id === syncResponse.accountId);
if (!account) {
- console.error(
+ logger.error(
`Invalid account ID found in response: ${syncResponse.accountId}. Proceeding to the next account...`,
);
continue;
@@ -1074,7 +1075,7 @@ async function simpleFinBatchSync({
});
}
- console.groupEnd();
+ logger.groupEnd();
return retVal;
}
@@ -1203,7 +1204,7 @@ async function unlinkAccount({ id }: { id: AccountEntity['id'] }) {
},
);
} catch (error) {
- console.log({ error });
+ logger.log({ error });
}
}
diff --git a/packages/loot-core/src/server/accounts/sync.ts b/packages/loot-core/src/server/accounts/sync.ts
index f9200a0792..ea6ff45fdc 100644
--- a/packages/loot-core/src/server/accounts/sync.ts
+++ b/packages/loot-core/src/server/accounts/sync.ts
@@ -3,6 +3,7 @@ import * as dateFns from 'date-fns';
import { v4 as uuidv4 } from 'uuid';
import * as asyncStorage from '../../platform/server/asyncStorage';
+import { logger } from '../../platform/server/log';
import * as monthUtils from '../../shared/months';
import { q } from '../../shared/query';
import {
@@ -138,7 +139,7 @@ async function downloadGoCardlessTransactions(
const userToken = await asyncStorage.getItem('user-token');
if (!userToken) return;
- console.log('Pulling transactions from GoCardless');
+ logger.log('Pulling transactions from GoCardless');
const res = await post(
getServer().GOCARDLESS_SERVER + '/transactions',
@@ -170,7 +171,7 @@ async function downloadGoCardlessTransactions(
startingBalance,
} = res;
- console.log('Response:', res);
+ logger.log('Response:', res);
return {
transactions: all,
@@ -178,7 +179,7 @@ async function downloadGoCardlessTransactions(
startingBalance,
};
} else {
- console.log('Response:', res);
+ logger.log('Response:', res);
return {
transactions: res.transactions.all,
@@ -195,7 +196,7 @@ async function downloadSimpleFinTransactions(
const batchSync = Array.isArray(acctId);
- console.log('Pulling transactions from SimpleFin');
+ logger.log('Pulling transactions from SimpleFin');
let res;
try {
@@ -212,7 +213,7 @@ async function downloadSimpleFinTransactions(
Array.isArray(acctId) ? 300000 : 60000,
);
} catch (error) {
- console.error('Suspected timeout during bank sync:', error);
+ logger.error('Suspected timeout during bank sync:', error);
throw BankSyncError('TIMED_OUT', 'TIMED_OUT');
}
@@ -252,7 +253,7 @@ async function downloadSimpleFinTransactions(
};
}
- console.log('Response:', retVal);
+ logger.log('Response:', retVal);
return retVal;
}
@@ -263,7 +264,7 @@ async function downloadPluggyAiTransactions(
const userToken = await asyncStorage.getItem('user-token');
if (!userToken) return;
- console.log('Pulling transactions from Pluggy.ai');
+ logger.log('Pulling transactions from Pluggy.ai');
const res = await post(
getServer().PLUGGYAI_SERVER + '/transactions',
@@ -291,7 +292,7 @@ async function downloadPluggyAiTransactions(
startingBalance: singleRes.startingBalance,
};
- console.log('Response:', retVal);
+ logger.log('Response:', retVal);
return retVal;
}
@@ -487,7 +488,7 @@ export async function reconcileTransactions(
isPreview = false,
defaultCleared = true,
): Promise<ReconcileTransactionsResult> {
- console.log('Performing transaction reconciliation');
+ logger.log('Performing transaction reconciliation');
const updated = [];
const added = [];
@@ -594,7 +595,7 @@ export async function reconcileTransactions(
await batchUpdateTransactions({ added, updated });
}
- console.log('Debug data for the operations:', {
+ logger.log('Debug data for the operations:', {
transactionsStep1,
transactionsStep2,
transactionsStep3,
@@ -616,7 +617,7 @@ export async function matchTransactions(
isBankSyncAccount = false,
strictIdChecking = true,
) {
- console.log('Performing transaction reconciliation matching');
+ logger.log('Performing transaction reconciliation matching');
const reimportDeleted = await aqlQuery(
q('preferences')
diff --git a/packages/loot-core/src/server/api.ts b/packages/loot-core/src/server/api.ts
index 3c12287408..cd7aa8a469 100644
--- a/packages/loot-core/src/server/api.ts
+++ b/packages/loot-core/src/server/api.ts
@@ -2,6 +2,7 @@
import { getClock } from '@actual-app/crdt';
import * as connection from '../platform/server/connection';
+import { logger } from '../platform/server/log';
import {
getBankSyncError,
getDownloadError,
@@ -233,7 +234,7 @@ handlers['api/download-budget'] = async function ({ syncId, password }) {
cloudFileId: remoteBudget.fileId,
});
if (result.error) {
- console.log('Full error details', result.error);
+ logger.log('Full error details', result.error);
throw new Error(getDownloadError(result.error));
}
await handlers['load-budget']({ id: result.id });
diff --git a/packages/loot-core/src/server/auth/app.ts b/packages/loot-core/src/server/auth/app.ts
index 07af2eb84e..f7c910cf82 100644
--- a/packages/loot-core/src/server/auth/app.ts
+++ b/packages/loot-core/src/server/auth/app.ts
@@ -1,4 +1,5 @@
import * as asyncStorage from '../../platform/server/asyncStorage';
+import { logger } from '../../platform/server/log';
import { OpenIdConfig } from '../../types/models';
import { createApp } from '../app';
import * as encryption from '../encryption';
@@ -196,7 +197,7 @@ async function getUser() {
tokenExpired,
};
} catch (e) {
- console.log(e);
+ logger.log(e);
return { offline: true };
}
}
diff --git a/packages/loot-core/src/server/bench.ts b/packages/loot-core/src/server/bench.ts
index 4607493426..92233ef111 100644
--- a/packages/loot-core/src/server/bench.ts
+++ b/packages/loot-core/src/server/bench.ts
@@ -2,6 +2,8 @@
// @ts-strict-ignore
import * as fs from 'fs';
+import { logger } from '../platform/server/log';
+
import * as db from './db';
const queries = fs
@@ -21,7 +23,7 @@ async function run() {
await db.openDatabase();
const start = Date.now();
runQueries();
- console.log(Date.now() - start);
+ logger.log(Date.now() - start);
}
run();
diff --git a/packages/loot-core/src/server/budgetfiles/app.ts b/packages/loot-core/src/server/budgetfiles/app.ts
index 2684579801..49fe6cb4b1 100644
--- a/packages/loot-core/src/server/budgetfiles/app.ts
+++ b/packages/loot-core/src/server/budgetfiles/app.ts
@@ -109,7 +109,7 @@ async function getBudgets() {
try {
prefs = JSON.parse(await fs.readFile(prefsPath));
} catch (e) {
- console.log('Error parsing metadata:', e.stack);
+ logger.log('Error parsing metadata:', e.stack);
return null;
}
@@ -165,7 +165,7 @@ async function uploadBudget({ id }: { id?: Budget['id'] } = {}): Promise<{
try {
await cloudStorage.upload();
} catch (e) {
- console.log(e);
+ logger.log(e);
if (e.type === 'FileUploadError') {
return { error: e };
}
@@ -373,7 +373,7 @@ async function duplicateBudget({
// load in and validate
const { error } = await _loadBudget(newId);
if (error) {
- console.log('Error duplicating budget: ' + error);
+ logger.log('Error duplicating budget: ' + error);
return error;
}
@@ -381,7 +381,7 @@ async function duplicateBudget({
try {
await cloudStorage.upload();
} catch (error) {
- console.warn('Failed to sync duplicated budget to cloud:', error);
+ logger.warn('Failed to sync duplicated budget to cloud:', error);
// Ignore any errors uploading. If they are offline they should
// still be able to create files.
}
@@ -437,7 +437,7 @@ async function createBudget({
// Load it in
const { error } = await _loadBudget(id);
if (error) {
- console.log('Error creating budget: ' + error);
+ logger.log('Error creating budget: ' + error);
return { error };
}
@@ -544,7 +544,7 @@ async function _loadBudget(id: Budget['id']): Promise<{
try {
await updateVersion();
} catch (e) {
- console.warn('Error updating', e);
+ logger.warn('Error updating', e);
let result;
if (e.message.includes('out-of-sync-migrations')) {
result = { error: 'out-of-sync-migrations' };
@@ -553,7 +553,7 @@ async function _loadBudget(id: Budget['id']): Promise<{
} else {
captureException(e);
logger.info('Error updating budget ' + id, e);
- console.log('Error updating budget', e);
+ logger.log('Error updating budget', e);
result = { error: 'loading-budget' };
}
diff --git a/packages/loot-core/src/server/budgetfiles/backups.ts b/packages/loot-core/src/server/budgetfiles/backups.ts
index ac8de1bd03..3ebe7bdffe 100644
--- a/packages/loot-core/src/server/budgetfiles/backups.ts
+++ b/packages/loot-core/src/server/budgetfiles/backups.ts
@@ -4,6 +4,7 @@ import { v4 as uuidv4 } from 'uuid';
import * as connection from '../../platform/server/connection';
import * as fs from '../../platform/server/fs';
+import { logger } from '../../platform/server/log';
import * as sqlite from '../../platform/server/sqlite';
import * as monthUtils from '../../shared/months';
import * as cloudStorage from '../cloud-storage';
@@ -159,7 +160,7 @@ export async function loadBackup(id: string, backupId: string) {
}
if (backupId === LATEST_BACKUP_FILENAME) {
- console.log('Reverting backup');
+ logger.log('Reverting backup');
// If reverting back to the latest, copy and delete the latest
// backup
@@ -180,7 +181,7 @@ export async function loadBackup(id: string, backupId: string) {
} catch (e) {}
prefs.unloadPrefs();
} else {
- console.log('Loading backup', backupId);
+ logger.log('Loading backup', backupId);
// This function is only ever called when a budget isn't loaded,
// so it's safe to load our prefs in. We need to forget about any
@@ -215,7 +216,7 @@ export function startBackupService(id: string) {
// Make a backup every 15 minutes
serviceInterval = setInterval(
async () => {
- console.log('Making backup');
+ logger.log('Making backup');
await makeBackup(id);
},
1000 * 60 * 15,
diff --git a/packages/loot-core/src/server/cloud-storage.ts b/packages/loot-core/src/server/cloud-storage.ts
index 1bf6371014..8968c4ecb2 100644
--- a/packages/loot-core/src/server/cloud-storage.ts
+++ b/packages/loot-core/src/server/cloud-storage.ts
@@ -5,6 +5,7 @@ import { v4 as uuidv4 } from 'uuid';
import * as asyncStorage from '../platform/server/asyncStorage';
import { fetch } from '../platform/server/fetch';
import * as fs from '../platform/server/fs';
+import { logger } from '../platform/server/log';
import * as sqlite from '../platform/server/sqlite';
import * as monthUtils from '../shared/months';
@@ -82,7 +83,7 @@ export async function checkKey(): Promise<{
fileId: cloudFileId,
});
} catch (e) {
- console.log(e);
+ logger.log(e);
return { valid: false, error: { reason: 'network' } };
}
@@ -310,7 +311,7 @@ export async function upload() {
body: uploadContent,
});
} catch (err) {
- console.log('Upload failure', err);
+ logger.log('Upload failure', err);
if (err instanceof PostError) {
throw FileUploadError(
@@ -382,12 +383,12 @@ export async function listRemoteFiles(): Promise<RemoteFile[]> {
},
});
} catch (e) {
- console.log('Unexpected error fetching file list from server', e);
+ logger.log('Unexpected error fetching file list from server', e);
return null;
}
if (res.status === 'error') {
- console.log('Error fetching file list from server', res);
+ logger.log('Error fetching file list from server', res);
return null;
}
@@ -416,12 +417,12 @@ export async function getRemoteFile(
},
});
} catch (e) {
- console.log('Unexpected error fetching file from server', e);
+ logger.log('Unexpected error fetching file from server', e);
return null;
}
if (res.status === 'error') {
- console.log('Error fetching file from server', res);
+ logger.log('Error fetching file from server', res);
return null;
}
@@ -449,7 +450,7 @@ export async function download(cloudFileId) {
return res.buffer();
})
.catch(err => {
- console.log('Download failure', err);
+ logger.log('Download failure', err);
throw FileDownloadError('download-failure');
});
@@ -459,7 +460,7 @@ export async function download(cloudFileId) {
'X-ACTUAL-FILE-ID': cloudFileId,
},
}).catch(err => {
- console.log('Error fetching file info', err);
+ logger.log('Error fetching file info', err);
throw FileDownloadError('internal', { fileId: cloudFileId });
});
@@ -469,7 +470,7 @@ export async function download(cloudFileId) {
]);
if (userFileInfoRes.status !== 'ok') {
- console.log(
+ logger.log(
'Could not download file from the server. Are you sure you have the right file ID?',
userFileInfoRes,
);
diff --git a/packages/loot-core/src/server/encryption/app.ts b/packages/loot-core/src/server/encryption/app.ts
index f6102c2510..a6d85656ec 100644
--- a/packages/loot-core/src/server/encryption/app.ts
+++ b/packages/loot-core/src/server/encryption/app.ts
@@ -1,6 +1,7 @@
import { v4 as uuidv4 } from 'uuid';
import * as asyncStorage from '../../platform/server/asyncStorage';
+import { logger } from '../../platform/server/log';
import { Budget } from '../../types/budget';
import { createApp } from '../app';
import { post } from '../post';
@@ -83,7 +84,7 @@ async function keyTest({
});
validCloudFileId = cloudFileId!;
} catch (e) {
- console.log(e);
+ logger.log(e);
return { error: { reason: 'network' } };
}
@@ -109,7 +110,7 @@ async function keyTest({
try {
await encryption.decrypt(Buffer.from(test.value, 'base64'), test.meta);
} catch (e) {
- console.log(e);
+ logger.log(e);
// Unload the key, it's invalid
encryption.unloadKey(key);
diff --git a/packages/loot-core/src/server/importers/index.ts b/packages/loot-core/src/server/importers/index.ts
index c4bdf118d7..52e7f6d7bc 100644
--- a/packages/loot-core/src/server/importers/index.ts
+++ b/packages/loot-core/src/server/importers/index.ts
@@ -1,4 +1,5 @@
// @ts-strict-ignore
+import { logger } from '../../platform/server/log';
import { handlers } from '../main';
import { importActual } from './actual';
@@ -34,7 +35,7 @@ export async function handleBudgetImport(
data = importer.parseFile(buffer);
budgetName = importer.getBudgetName(filepath, data);
} catch (e) {
- console.error('failed to parse file', e);
+ logger.error('failed to parse file', e);
}
if (!budgetName) {
return { error: 'not-' + type };
@@ -43,13 +44,13 @@ export async function handleBudgetImport(
try {
await handlers['api/start-import']({ budgetName });
} catch (e) {
- console.error('failed to start import', e);
+ logger.error('failed to start import', e);
return { error: 'unknown' };
}
await importer.doImport(data);
} catch (e) {
await handlers['api/abort-import']();
- console.error('failed to run import', e);
+ logger.error('failed to run import', e);
return { error: 'unknown' };
}
diff --git a/packages/loot-core/src/server/importers/ynab4.ts b/packages/loot-core/src/server/importers/ynab4.ts
index b3f98d8904..1c84f6dcb4 100644
--- a/packages/loot-core/src/server/importers/ynab4.ts
+++ b/packages/loot-core/src/server/importers/ynab4.ts
@@ -10,6 +10,7 @@ import AdmZip from 'adm-zip';
import normalizePathSep from 'slash';
import { v4 as uuidv4 } from 'uuid';
+import { logger } from '../../platform/server/log';
import * as monthUtils from '../../shared/months';
import { groupBy, sortByKey } from '../../shared/util';
@@ -349,22 +350,22 @@ function findLatestDevice(zipped: AdmZip, entries: AdmZip.IZipEntry[]): string {
export async function doImport(data: YNAB4.YFull) {
const entityIdMap = new Map<string, string>();
- console.log('Importing Accounts...');
+ logger.log('Importing Accounts...');
await importAccounts(data, entityIdMap);
- console.log('Importing Categories...');
+ logger.log('Importing Categories...');
await importCategories(data, entityIdMap);
- console.log('Importing Payees...');
+ logger.log('Importing Payees...');
await importPayees(data, entityIdMap);
- console.log('Importing Transactions...');
+ logger.log('Importing Transactions...');
await importTransactions(data, entityIdMap);
- console.log('Importing Budgets...');
+ logger.log('Importing Budgets...');
await importBudgets(data, entityIdMap);
- console.log('Setting up...');
+ logger.log('Setting up...');
}
export function getBudgetName(filepath) {
@@ -430,7 +431,7 @@ export function parseFile(buffer: Buffer): YNAB4.YFull {
try {
contents = zipped.readFile(getFile(entries, yfullPath)).toString('utf8');
} catch (e) {
- console.log(e);
+ logger.log(e);
throw new Error('Error reading Budget.yfull file');
}
diff --git a/packages/loot-core/src/server/importers/ynab5.ts b/packages/loot-core/src/server/importers/ynab5.ts
index b3dba76ca9..435398e6cd 100644
--- a/packages/loot-core/src/server/importers/ynab5.ts
+++ b/packages/loot-core/src/server/importers/ynab5.ts
@@ -7,6 +7,7 @@ import { send } from '@actual-app/api/injected';
import * as actual from '@actual-app/api/methods';
import { v4 as uuidv4 } from 'uuid';
+import { logger } from '../../platform/server/log';
import * as monthUtils from '../../shared/months';
import { sortByKey, groupBy } from '../../shared/util';
@@ -499,22 +500,22 @@ async function importBudgets(
export async function doImport(data: YNAB5.Budget) {
const entityIdMap = new Map<string, string>();
- console.log('Importing Accounts...');
+ logger.log('Importing Accounts...');
await importAccounts(data, entityIdMap);
- console.log('Importing Categories...');
+ logger.log('Importing Categories...');
await importCategories(data, entityIdMap);
- console.log('Importing Payees...');
+ logger.log('Importing Payees...');
await importPayees(data, entityIdMap);
- console.log('Importing Transactions...');
+ logger.log('Importing Transactions...');
await importTransactions(data, entityIdMap);
- console.log('Importing Budgets...');
+ logger.log('Importing Budgets...');
await importBudgets(data, entityIdMap);
- console.log('Setting up...');
+ logger.log('Setting up...');
}
export function parseFile(buffer: Buffer): YNAB5.Budget {
diff --git a/packages/loot-core/src/server/main.ts b/packages/loot-core/src/server/main.ts
index febe114628..12d754be9e 100644
--- a/packages/loot-core/src/server/main.ts
+++ b/packages/loot-core/src/server/main.ts
@@ -6,6 +6,7 @@ import * as injectAPI from '@actual-app/api/injected';
import * as asyncStorage from '../platform/server/asyncStorage';
import * as connection from '../platform/server/connection';
import * as fs from '../platform/server/fs';
+import { logger, setVerboseMode } from '../platform/server/log';
import * as sqlite from '../platform/server/sqlite';
import { q } from '../shared/query';
import { Handlers } from '../types/handlers';
@@ -200,7 +201,7 @@ export async function initApp(isDev, socketName) {
}),
);
} catch (e) {
- console.log('Error loading key', e);
+ logger.log('Error loading key', e);
throw new Error('load-key-error');
}
}
@@ -229,6 +230,7 @@ export type InitConfig = {
dataDir?: string;
serverURL?: string;
password?: string;
+ verbose?: boolean;
};
export async function init(config: InitConfig) {
@@ -238,6 +240,11 @@ export async function init(config: InitConfig) {
if (config) {
dataDir = config.dataDir;
serverURL = config.serverURL;
+
+ // Set verbose mode if specified
+ if (config.verbose !== undefined) {
+ setVerboseMode(config.verbose);
+ }
} else {
dataDir = process.env.ACTUAL_DATA_DIR;
serverURL = process.env.ACTUAL_SERVER_URL;
diff --git a/packages/loot-core/src/server/migrate/cli.ts b/packages/loot-core/src/server/migrate/cli.ts
index 5928b67141..c70e35bae8 100755
--- a/packages/loot-core/src/server/migrate/cli.ts
+++ b/packages/loot-core/src/server/migrate/cli.ts
@@ -3,6 +3,7 @@
import * as fs from 'fs';
import * as path from 'path';
+import { logger } from '../../platform/server/log';
import * as sqlite from '../../platform/server/sqlite';
import {
@@ -52,11 +53,11 @@ async function list(db) {
const all = await getMigrationList(migrationsDir);
const pending = getPending(applied, all);
- console.log('Applied migrations:');
- applied.forEach(id => console.log(' ', getUpMigration(id, all)));
+ logger.log('Applied migrations:');
+ applied.forEach(id => logger.log(' ', getUpMigration(id, all)));
- console.log('\nPending migrations:');
- pending.forEach(name => console.log(' ', name));
+ logger.log('\nPending migrations:');
+ pending.forEach(name => logger.log(' ', name));
}
const cmd = argv._[0];
@@ -74,9 +75,9 @@ withMigrationsDir(argv.migrationsDir || getMigrationsDir(), async () => {
case 'migrate':
const applied = await migrate(getDatabase());
if (applied.length === 0) {
- console.log('No pending migrations');
+ logger.log('No pending migrations');
} else {
- console.log('Applied migrations:\n' + applied.join('\n'));
+ logger.log('Applied migrations:\n' + applied.join('\n'));
}
break;
case 'list':
@@ -86,7 +87,7 @@ withMigrationsDir(argv.migrationsDir || getMigrationsDir(), async () => {
default:
const name = argv.name;
if (name == null || name === '') {
- console.log('Must pass a name for the new migration with --name');
+ logger.log('Must pass a name for the new migration with --name');
process.exit(1);
}
await create(name);
diff --git a/packages/loot-core/src/server/migrate/migrations.ts b/packages/loot-core/src/server/migrate/migrations.ts
index 3d933e7952..ff5a063b5c 100644
--- a/packages/loot-core/src/server/migrate/migrations.ts
+++ b/packages/loot-core/src/server/migrate/migrations.ts
@@ -9,6 +9,7 @@ import m1722717601000 from '../../../migrations/1722717601000_reports_move_selec
import m1722804019000 from '../../../migrations/1722804019000_create_dashboard_table';
import m1723665565000 from '../../../migrations/1723665565000_prefs';
import * as fs from '../../platform/server/fs';
+import { logger } from '../../platform/server/log';
import * as sqlite from '../../platform/server/sqlite';
import * as prefs from '../prefs';
@@ -119,7 +120,7 @@ async function applySql(db, sql) {
try {
await sqlite.execQuery(db, sql);
} catch (e) {
- console.log('Error applying sql:', sql);
+ logger.log('Error applying sql:', sql);
throw e;
}
}
@@ -149,7 +150,7 @@ function checkDatabaseValidity(
i >= available.length ||
appliedIds[i] !== getMigrationId(available[i])
) {
- console.error('Database is out of sync with migrations:', {
+ logger.error('Database is out of sync with migrations:', {
appliedIds,
available,
});
diff --git a/packages/loot-core/src/server/post.ts b/packages/loot-core/src/server/post.ts
index 5e1a278e56..740ba06c9c 100644
--- a/packages/loot-core/src/server/post.ts
+++ b/packages/loot-core/src/server/post.ts
@@ -1,5 +1,6 @@
// @ts-strict-ignore
import { fetch } from '../platform/server/fetch';
+import { logger } from '../platform/server/log';
import * as Platform from '../shared/platform';
import { PostError } from './errors';
@@ -72,7 +73,7 @@ export async function post(
}
if (responseData.status !== 'ok') {
- console.log(
+ logger.log(
'API call failed: ' +
url +
'\nData: ' +
@@ -122,7 +123,7 @@ export async function del(url, data, headers = {}, timeout = null) {
}
if (res.status !== 'ok') {
- console.log(
+ logger.log(
'API call failed: ' +
url +
'\nData: ' +
@@ -170,7 +171,7 @@ export async function patch(url, data, headers = {}, timeout = null) {
}
if (res.status !== 'ok') {
- console.log(
+ logger.log(
'API call failed: ' +
url +
'\nData: ' +
diff --git a/packages/loot-core/src/server/rules/app.ts b/packages/loot-core/src/server/rules/app.ts
index 37cce38d1d..2c48c7b302 100644
--- a/packages/loot-core/src/server/rules/app.ts
+++ b/packages/loot-core/src/server/rules/app.ts
@@ -1,4 +1,5 @@
// @ts-strict-ignore
+import { logger } from '../../platform/server/log';
import {
RuleActionEntity,
TransactionEntity,
@@ -22,7 +23,7 @@ function validateRule(rule: Partial<RuleEntity>) {
validate(item);
} catch (e) {
if (e instanceof RuleError) {
- console.warn('Invalid rule', e);
+ logger.warn('Invalid rule', e);
return e.type;
}
throw e;
diff --git a/packages/loot-core/src/server/rules/index.ts b/packages/loot-core/src/server/rules/index.ts
index e3ccf7766e..057fe08427 100644
--- a/packages/loot-core/src/server/rules/index.ts
+++ b/packages/loot-core/src/server/rules/index.ts
@@ -10,6 +10,7 @@ import {
} from 'date-fns';
import * as Handlebars from 'handlebars';
+import { logger } from '../../platform/server/log';
import {
monthFromDate,
yearFromDate,
@@ -146,7 +147,7 @@ function registerHandlebarsHelpers() {
return format(addDays(date, day - actualDay), 'yyyy-MM-dd');
},
debug: (value: unknown) => {
- console.log(value);
+ logger.log(value);
},
concat: (...args: unknown[]) => args.join(''),
} as Record<string, Handlebars.HelperDelegate>;
@@ -594,7 +595,7 @@ export class Condition {
try {
return new RegExp(this.value).test(fieldValue);
} catch (e) {
- console.log('invalid regexp in matches condition', e);
+ logger.log('invalid regexp in matches condition', e);
return false;
}
@@ -671,7 +672,7 @@ export class Action {
try {
this.handlebarsTemplate({});
} catch (e) {
- console.debug(e);
+ logger.debug(e);
assert(false, 'invalid-template', `Invalid Handlebars template`);
}
}
@@ -716,7 +717,7 @@ export class Action {
object[this.field] = format(parsed, 'yyyy-MM-dd');
} else {
// Keep original string; log for diagnostics but avoid hard crash
- console.error(
+ logger.error(
`rules: invalid date produced by template for field “${this.field}”:`,
object[this.field],
);
@@ -1060,7 +1061,7 @@ const OP_SCORES: Record<RuleConditionEntity['op'], number> = {
function computeScore(rule: Rule): number {
const initialScore = rule.conditions.reduce((score, condition) => {
if (OP_SCORES[condition.op] == null) {
- console.log(`Found invalid operation while ranking: ${condition.op}`);
+ logger.log(`Found invalid operation while ranking: ${condition.op}`);
return 0;
}
diff --git a/packages/loot-core/src/server/server-config.ts b/packages/loot-core/src/server/server-config.ts
index 2455af1ed1..260f463ddb 100644
--- a/packages/loot-core/src/server/server-config.ts
+++ b/packages/loot-core/src/server/server-config.ts
@@ -1,4 +1,5 @@
import * as fs from '../platform/server/fs';
+import { logger } from '../platform/server/log';
type ServerConfig = {
BASE_SERVER: string;
@@ -46,7 +47,7 @@ export function getServer(url?: string): ServerConfig | null {
PLUGGYAI_SERVER: joinURL(url, '/pluggyai'),
};
} catch (error) {
- console.warn(
+ logger.warn(
'Unable to parse server URL - using the global config.',
{ config },
error,
diff --git a/packages/loot-core/src/server/sheet.ts b/packages/loot-core/src/server/sheet.ts
index cc62892ef0..a065bd15e6 100644
--- a/packages/loot-core/src/server/sheet.ts
+++ b/packages/loot-core/src/server/sheet.ts
@@ -2,6 +2,7 @@
import { type Database } from '@jlongster/sql.js';
import { captureBreadcrumb } from '../platform/exceptions';
+import { logger } from '../platform/server/log';
import * as sqlite from '../platform/server/sqlite';
import { sheetForMonth } from '../shared/months';
import * as Platform from '../shared/platform';
@@ -156,14 +157,14 @@ export async function loadSpreadsheet(
[],
true,
);
- console.log(`Loaded spreadsheet from cache (${cachedRows.length} items)`);
+ logger.log(`Loaded spreadsheet from cache (${cachedRows.length} items)`);
for (const row of cachedRows) {
const parsed = JSON.parse(row.value);
sheet.load(row.key, parsed);
}
} else {
- console.log('Loading fresh spreadsheet');
+ logger.log('Loading fresh spreadsheet');
await loadUserBudgets(db);
}
diff --git a/packages/loot-core/src/server/spreadsheet/spreadsheet.ts b/packages/loot-core/src/server/spreadsheet/spreadsheet.ts
index 307bc06b9a..124a123b21 100644
--- a/packages/loot-core/src/server/spreadsheet/spreadsheet.ts
+++ b/packages/loot-core/src/server/spreadsheet/spreadsheet.ts
@@ -1,6 +1,7 @@
// @ts-strict-ignore
import mitt from 'mitt';
+import { logger } from '../../platform/server/log';
import { QueryState } from '../../shared/query';
import { compileQuery, aqlCompiledQuery, schema, schemaConfig } from '../aql';
import { BudgetType } from '../prefs';
@@ -104,7 +105,7 @@ export class Spreadsheet {
try {
func();
} catch (e) {
- console.log(e);
+ logger.log(e);
}
return this.endTransaction();
}
@@ -164,7 +165,7 @@ export class Spreadsheet {
result = node._run(...args);
if (result instanceof Promise) {
- console.warn(
+ logger.warn(
`dynamic cell ${name} returned a promise! this is discouraged because errors are not handled properly`,
);
}
@@ -179,7 +180,7 @@ export class Spreadsheet {
continue;
}
} catch (e) {
- console.log('Error while evaluating ' + name + ':', e);
+ logger.log('Error while evaluating ' + name + ':', e);
// If an error happens, bail on the rest of the computations
this.running = false;
this.computeQueue = [];
@@ -196,7 +197,7 @@ export class Spreadsheet {
},
err => {
// TODO: use captureException here
- console.warn(`Failed running ${node.name}!`, err);
+ logger.warn(`Failed running ${node.name}!`, err);
this.runComputations(idx + 1);
},
);
diff --git a/packages/loot-core/src/server/sync/encoder.ts b/packages/loot-core/src/server/sync/encoder.ts
index dacc675626..771b592c34 100644
--- a/packages/loot-core/src/server/sync/encoder.ts
+++ b/packages/loot-core/src/server/sync/encoder.ts
@@ -1,6 +1,7 @@
// @ts-strict-ignore
import { Timestamp, SyncProtoBuf } from '@actual-app/crdt';
+import { logger } from '../../platform/server/log';
import * as encryption from '../encryption';
import { SyncError } from '../errors';
import * as prefs from '../prefs';
@@ -102,7 +103,7 @@ export async function decode(
authTag: coerceBuffer(binary.getAuthtag()),
});
} catch (e) {
- console.log(e);
+ logger.log(e);
throw new SyncError('decrypt-failure', {
isMissingKey: e.message === 'missing-key',
});
diff --git a/packages/loot-core/src/server/sync/index.ts b/packages/loot-core/src/server/sync/index.ts
index 5b65124dda..7f7bbebc2c 100644
--- a/packages/loot-core/src/server/sync/index.ts
+++ b/packages/loot-core/src/server/sync/index.ts
@@ -560,7 +560,7 @@ export const fullSync = once(async function (): Promise<
try {
messages = await _fullSync(null, 0, null);
} catch (e) {
- console.log(e);
+ logger.log(e);
if (e instanceof SyncError) {
if (e.reason === 'out-of-sync') {
@@ -590,7 +590,7 @@ export const fullSync = once(async function (): Promise<
app.events.emit('sync', { type: 'error', meta: e.meta });
}
} else if (e instanceof PostError) {
- console.log(e);
+ logger.log(e);
if (e.reason === 'unauthorized') {
app.events.emit('sync', { type: 'unauthorized' });
@@ -724,7 +724,7 @@ async function _fullSync(
const rebuiltMerkle = rebuildMerkleHash();
- console.log(
+ logger.log(
count,
'messages:',
messages.length,
@@ -757,10 +757,10 @@ async function _fullSync(
'SELECT * FROM messages_clock',
);
if (clocks.length !== 1) {
- console.log('Bad number of clocks:', clocks.length);
+ logger.log('Bad number of clocks:', clocks.length);
}
const hash = deserializeClock(clocks[0].clock).merkle.hash;
- console.log('Merkle hash in db:', hash);
+ logger.log('Merkle hash in db:', hash);
}
throw new SyncError('out-of-sync');
diff --git a/packages/loot-core/src/server/transactions/import/parse-file.ts b/packages/loot-core/src/server/transactions/import/parse-file.ts
index d2d513f161..5be6de39c5 100644
--- a/packages/loot-core/src/server/transactions/import/parse-file.ts
+++ b/packages/loot-core/src/server/transactions/import/parse-file.ts
@@ -2,6 +2,7 @@
import { parse as csv2json } from 'csv-parse/sync';
import * as fs from '../../../platform/server/fs';
+import { logger } from '../../../platform/server/log';
import { looselyParseAmount } from '../../../shared/util';
import { ofx2json } from './ofx2json';
@@ -169,7 +170,7 @@ async function parseCAMT(
try {
data = await xmlCAMT2json(contents);
} catch (err) {
- console.error(err);
+ logger.error(err);
errors.push({
message: 'Failed importing file',
internal: err.stack,
diff --git a/packages/loot-core/src/server/transactions/transaction-rules.ts b/packages/loot-core/src/server/transactions/transaction-rules.ts
index c395f8bec0..4c2fc61d30 100644
--- a/packages/loot-core/src/server/transactions/transaction-rules.ts
+++ b/packages/loot-core/src/server/transactions/transaction-rules.ts
@@ -1,5 +1,6 @@
// @ts-strict-ignore
+import { logger } from '../../platform/server/log';
import {
currentDay,
addDays,
@@ -157,7 +158,7 @@ export function makeRule(data) {
try {
rule = new Rule(ruleModel.toJS(data));
} catch (e) {
- console.warn('Invalid rule', e);
+ logger.warn('Invalid rule', e);
if (e instanceof RuleError) {
return null;
}
@@ -408,7 +409,7 @@ export function conditionsToAQL(
return new Condition(cond.op, cond.field, cond.value, cond.options);
} catch (e) {
errors.push(e.type || 'internal');
- console.log('conditionsToAQL: invalid condition: ' + e.message);
+ logger.log('conditionsToAQL: invalid condition: ' + e.message);
return null;
}
})
@@ -672,7 +673,7 @@ export async function applyActions(
action.options,
);
} catch (e) {
- console.log('Action error', e);
+ logger.log('Action error', e);
return null;
}
})
diff --git a/upcoming-release-notes/5762.md b/upcoming-release-notes/5762.md
new file mode 100644
index 0000000000..a94eb0d9c0
--- /dev/null
+++ b/upcoming-release-notes/5762.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [matt-fidd]
+---
+
+Add quiet mode to API