Skip to content

A local-first personal finance app

expand logger to cover more of loot-core (#6503)

Matt Fiddaman47aef8ca5137
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
index 08ba7c9bd4..46c37cc72d 100644
--- 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
@@ -21,6 +21,7 @@ runClassic(
code: 'console.log("test");',
filename: 'packages/loot-core/src/server/test.ts',
output: `import { logger } from '../platform/server/log';
+
logger.log("test");`,
errors: [
{
@@ -33,6 +34,7 @@ logger.log("test");`,
code: 'console.warn("warning");',
filename: 'packages/loot-core/src/server/test.ts',
output: `import { logger } from '../platform/server/log';
+
logger.warn("warning");`,
errors: [
{
@@ -45,6 +47,7 @@ logger.warn("warning");`,
code: 'console.error("error");',
filename: 'packages/loot-core/src/server/test.ts',
output: `import { logger } from '../platform/server/log';
+
logger.error("error");`,
errors: [
{
@@ -57,6 +60,7 @@ logger.error("error");`,
code: 'console.info("info");',
filename: 'packages/loot-core/src/server/test.ts',
output: `import { logger } from '../platform/server/log';
+
logger.info("info");`,
errors: [
{
@@ -69,6 +73,7 @@ logger.info("info");`,
code: 'console.debug("debug");',
filename: 'packages/loot-core/src/server/test.ts',
output: `import { logger } from '../platform/server/log';
+
logger.debug("debug");`,
errors: [
{
@@ -81,6 +86,7 @@ logger.debug("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: [
{
@@ -93,6 +99,7 @@ logger.group("Group Name");`,
code: 'console.groupEnd();',
filename: 'packages/loot-core/src/server/test.ts',
output: `import { logger } from '../platform/server/log';
+
logger.groupEnd();`,
errors: [
{
@@ -105,6 +112,7 @@ logger.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: [
{
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
index fc2d8b995e..e33285ef95 100644
--- a/packages/eslint-plugin-actual/lib/rules/prefer-logger-over-console.js
+++ b/packages/eslint-plugin-actual/lib/rules/prefer-logger-over-console.js
@@ -1,4 +1,6 @@
-const { getImportFix } = require('../utils/import-helpers');
+const path = require('path');
+
+const { ensureImport } = require('../utils/import-helpers');
/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
@@ -19,11 +21,16 @@ module.exports = {
const filenameRaw = context.getFilename();
const normalizedFilename = filenameRaw.replace(/\\/g, '/');
- const isLootCoreFile = normalizedFilename.includes(
- 'packages/loot-core/src/server',
+ const isLootCoreFile = normalizedFilename.match(
+ /packages\/loot-core\/src\/(server|shared|platform)/,
);
- if (!isLootCoreFile) {
+ if (
+ !isLootCoreFile ||
+ normalizedFilename.includes(
+ 'packages/loot-core/src/platform/server/log/index.ts',
+ )
+ ) {
return {};
}
@@ -37,13 +44,23 @@ module.exports = {
groupEnd: 'groupEnd',
};
+ function getLoggerImportPath() {
+ const loggerPath = 'packages/loot-core/src/platform/server/log';
+ const fileDir = path.dirname(normalizedFilename);
+ const relativePath = path.posix.relative(fileDir, loggerPath);
+ return relativePath || './log';
+ }
+
function getLoggerImportInfo() {
const { ast } = context.getSourceCode();
+ const importPath = getLoggerImportPath();
+
for (const node of ast.body) {
if (
node.type === 'ImportDeclaration' &&
typeof node.source.value === 'string' &&
- node.source.value.includes('platform/server/log')
+ (node.source.value === importPath ||
+ node.source.value.includes('platform/server/log'))
) {
const spec = node.specifiers.find(
s => s.type === 'ImportSpecifier' && s.imported.name === 'logger',
@@ -51,24 +68,11 @@ module.exports = {
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 (
@@ -86,7 +90,7 @@ module.exports = {
data: { method },
fix(fixer) {
const sourceCode = context.getSourceCode();
- const { decl, localName } = getLoggerImportInfo();
+ const { localName } = getLoggerImportInfo();
const loggerIdent = localName || 'logger';
const fixes = [
fixer.replaceText(
@@ -95,32 +99,9 @@ module.exports = {
),
];
+ const importPath = getLoggerImportPath();
if (!localName) {
- const importPath = getLoggerImportPath();
-
- // 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
- fixes.unshift(
- fixer.insertTextAfter(
- decl,
- `\nimport { logger } from '${importPath}';`,
- ),
- );
- }
- } else {
- // Use shared utility to add the import
- const importFix = getImportFix(
- sourceCode,
- 'logger',
- importPath,
- )(fixer);
- if (importFix) fixes.unshift(importFix);
- }
+ ensureImport(fixes, sourceCode, fixer, 'logger', importPath);
}
return fixes;
diff --git a/packages/eslint-plugin-actual/lib/utils/import-helpers.js b/packages/eslint-plugin-actual/lib/utils/import-helpers.js
index 66c327c1a7..4631abbea4 100644
--- a/packages/eslint-plugin-actual/lib/utils/import-helpers.js
+++ b/packages/eslint-plugin-actual/lib/utils/import-helpers.js
@@ -41,6 +41,15 @@ function getImportFix(sourceCode, importName, moduleName) {
);
if (existingImport) {
+ const hasImportAlready = existingImport.specifiers.some(
+ spec =>
+ spec.type === 'ImportSpecifier' && spec.imported.name === importName,
+ );
+
+ if (hasImportAlready) {
+ return null;
+ }
+
if (existingImport.specifiers.length === 0) {
const importStatement = `import { ${importName} } from '${moduleName}';\n`;
return fixer =>
@@ -62,7 +71,8 @@ function getImportFix(sourceCode, importName, moduleName) {
if (firstImport) {
return fixer => fixer.insertTextAfter(targetNode, `\n${importStatement}`);
} else {
- return fixer => fixer.insertTextBefore(targetNode, importStatement);
+ return fixer =>
+ fixer.insertTextBefore(targetNode, `${importStatement}\n`);
}
}
}
diff --git a/packages/loot-core/src/platform/exceptions/index.ts b/packages/loot-core/src/platform/exceptions/index.ts
index 43e0ba3de1..280c98fd8c 100644
--- a/packages/loot-core/src/platform/exceptions/index.ts
+++ b/packages/loot-core/src/platform/exceptions/index.ts
@@ -1,7 +1,9 @@
+import { logger } from '../server/log';
+
export const captureException = function (exc: Error) {
- console.error('[Exception]', exc);
+ logger.error('[Exception]', exc);
};
export const captureBreadcrumb = function (crumb: unknown) {
- console.info('[Breadcrumb]', crumb);
+ logger.info('[Breadcrumb]', crumb);
};
diff --git a/packages/loot-core/src/platform/server/connection/index.electron.ts b/packages/loot-core/src/platform/server/connection/index.electron.ts
index cf899296e2..3f2186ef99 100644
--- a/packages/loot-core/src/platform/server/connection/index.electron.ts
+++ b/packages/loot-core/src/platform/server/connection/index.electron.ts
@@ -1,5 +1,7 @@
// @ts-strict-ignore
import { APIError } from '../../../server/errors';
+import { logger } from '../log';
+
import { runHandler, isMutating } from '../../../server/mutators';
import { captureException } from '../../exceptions';
@@ -65,7 +67,7 @@ export const init: T.Init = function (_socketName, handlers) {
},
);
} else {
- console.warn('Unknown method: ' + name);
+ logger.warn('Unknown method: ' + name);
captureException(new Error('Unknown server method: ' + name));
process.parentPort.postMessage({
type: 'reply',
diff --git a/packages/loot-core/src/platform/server/connection/index.ts b/packages/loot-core/src/platform/server/connection/index.ts
index 91b8937de4..bbfe3fb717 100644
--- a/packages/loot-core/src/platform/server/connection/index.ts
+++ b/packages/loot-core/src/platform/server/connection/index.ts
@@ -1,5 +1,7 @@
// @ts-strict-ignore
import { APIError } from '../../../server/errors';
+import { logger } from '../log';
+
import { runHandler, isMutating } from '../../../server/mutators';
import { captureException } from '../../exceptions';
@@ -46,7 +48,7 @@ export const init: T.Init = function (serverChn, handlers) {
if (msg.name === 'client-connected-to-backend') {
// the client is indicating that it is connected to this backend. Stop attempting to connect
- console.info('Backend: Client connected');
+ logger.info('Backend: Client connected');
clearInterval(reconnectToClientInterval);
return;
}
@@ -93,7 +95,7 @@ export const init: T.Init = function (serverChn, handlers) {
},
);
} else {
- console.warn('Unknown method: ' + name);
+ logger.warn('Unknown method: ' + name);
serverChannel.postMessage({
type: 'reply',
id,
@@ -110,7 +112,7 @@ export const init: T.Init = function (serverChn, handlers) {
let reconnectAttempts = 0;
const reconnectToClientInterval = setInterval(() => {
- console.info('Backend: Trying to connect to client');
+ logger.info('Backend: Trying to connect to client');
serverChannel.postMessage({ type: 'connect' });
reconnectAttempts++;
if (reconnectAttempts >= MAX_RECONNECT_ATTEMPTS) {
diff --git a/packages/loot-core/src/platform/server/fetch/index.electron.ts b/packages/loot-core/src/platform/server/fetch/index.electron.ts
index 2271fef095..34fbbb146e 100644
--- a/packages/loot-core/src/platform/server/fetch/index.electron.ts
+++ b/packages/loot-core/src/platform/server/fetch/index.electron.ts
@@ -1,3 +1,5 @@
+import { logger } from '../log';
+
export const fetch = async (
input: RequestInfo | URL,
options?: RequestInit,
@@ -11,7 +13,7 @@ export const fetch = async (
},
});
} catch (error) {
- console.error(error); // log error
+ logger.error(error); // log error
throw error;
}
};
diff --git a/packages/loot-core/src/platform/server/fs/index.electron.ts b/packages/loot-core/src/platform/server/fs/index.electron.ts
index 7a3eaed36d..16fc729797 100644
--- a/packages/loot-core/src/platform/server/fs/index.electron.ts
+++ b/packages/loot-core/src/platform/server/fs/index.electron.ts
@@ -1,5 +1,7 @@
// @ts-strict-ignore
import * as fs from 'fs';
+import { logger } from '../log';
+
import * as path from 'path';
import promiseRetry from 'promise-retry';
@@ -125,13 +127,13 @@ export const writeFile: T.WriteFile = async (filepath, contents) => {
// @ts-expect-error contents type needs refining
fs.writeFile(filepath, contents, 'utf8', err => {
if (err) {
- console.error(
+ logger.error(
`Failed to write to ${filepath}. Attempted ${attempt} times. Something is locking the file - potentially a virus scanner or backup software.`,
);
reject(err);
} else {
if (attempt > 1) {
- console.info(
+ logger.info(
`Successfully recovered from file lock. It took ${attempt} retries`,
);
}
@@ -150,7 +152,7 @@ export const writeFile: T.WriteFile = async (filepath, contents) => {
return undefined;
} catch (err) {
- console.error(`Unable to recover from file lock on file ${filepath}`);
+ logger.error(`Unable to recover from file lock on file ${filepath}`);
throw err;
}
};
diff --git a/packages/loot-core/src/platform/server/fs/index.web.ts b/packages/loot-core/src/platform/server/fs/index.web.ts
index a11728030a..50be62f348 100644
--- a/packages/loot-core/src/platform/server/fs/index.web.ts
+++ b/packages/loot-core/src/platform/server/fs/index.web.ts
@@ -1,5 +1,7 @@
// @ts-strict-ignore
import { SQLiteFS } from 'absurd-sql';
+import { logger } from '../log';
+
import IndexedDBBackend from 'absurd-sql/dist/indexeddb-backend';
import * as connection from '../connection';
@@ -191,7 +193,7 @@ async function _copySqlFile(
tofile.close();
fromfile.close();
_removeFile(toDbPath);
- console.error('Failed to copy database file', error);
+ logger.error('Failed to copy database file', error);
return false;
} finally {
tofile.close();
diff --git a/packages/loot-core/src/platform/server/indexeddb/index.ts b/packages/loot-core/src/platform/server/indexeddb/index.ts
index 1d5062ed04..aa2cd6d513 100644
--- a/packages/loot-core/src/platform/server/indexeddb/index.ts
+++ b/packages/loot-core/src/platform/server/indexeddb/index.ts
@@ -1,3 +1,5 @@
+import { logger } from '../log';
+
let openedDb: null | ReturnType<typeof _openDatabase> = _openDatabase();
// The web version uses IndexedDB to store data
@@ -26,10 +28,10 @@ function _openDatabase() {
}
};
- openRequest.onblocked = e => console.log('blocked', e);
+ openRequest.onblocked = e => logger.log('blocked', e);
openRequest.onerror = () => {
- console.log('openRequest error');
+ logger.log('openRequest error');
reject(new Error('indexeddb-failure: Could not open IndexedDB'));
};
@@ -43,7 +45,7 @@ function _openDatabase() {
db.onerror = function (event) {
const error = (event.target as IDBOpenDBRequest)?.error;
- console.log('Database error: ' + error);
+ logger.log('Database error: ' + error);
if (event.target && error) {
if (error.name === 'QuotaExceededError') {
diff --git a/packages/loot-core/src/platform/server/sqlite/index.electron.ts b/packages/loot-core/src/platform/server/sqlite/index.electron.ts
index 24fee4eb29..53252ac7ed 100644
--- a/packages/loot-core/src/platform/server/sqlite/index.electron.ts
+++ b/packages/loot-core/src/platform/server/sqlite/index.electron.ts
@@ -1,5 +1,7 @@
// @ts-strict-ignore
import SQL from 'better-sqlite3';
+import { logger } from '../log';
+
import { v4 as uuidv4 } from 'uuid';
import { removeFile, readFile } from '../fs';
@@ -10,7 +12,7 @@ import { unicodeLike } from './unicodeLike';
function verifyParamTypes(sql, arr) {
arr.forEach(val => {
if (typeof val !== 'string' && typeof val !== 'number' && val !== null) {
- console.log(sql, arr);
+ logger.log(sql, arr);
throw new Error('Invalid field type ' + val + ' for sql ' + sql);
}
});
@@ -38,7 +40,7 @@ export function runQuery(
try {
stmt = typeof sql === 'string' ? db.prepare(sql) : sql;
} catch (e) {
- console.log('error', sql);
+ logger.log('error', sql);
throw e;
}
@@ -47,7 +49,7 @@ export function runQuery(
const result = stmt.all(...params);
return result;
} catch (e) {
- console.log('error', sql);
+ logger.log('error', sql);
throw e;
}
} else {
diff --git a/packages/loot-core/src/platform/server/sqlite/index.web.ts b/packages/loot-core/src/platform/server/sqlite/index.web.ts
index d974a9cb10..212a84c4ac 100644
--- a/packages/loot-core/src/platform/server/sqlite/index.web.ts
+++ b/packages/loot-core/src/platform/server/sqlite/index.web.ts
@@ -1,5 +1,6 @@
// @ts-strict-ignore
import initSqlJS, { type Database } from '@jlongster/sql.js';
+import { logger } from '../log';
import { normalise } from './normalise';
import { unicodeLike } from './unicodeLike';
@@ -87,7 +88,7 @@ export function runQuery(
}
return rows;
} catch (e) {
- console.log(sql);
+ logger.log(sql);
throw e;
}
} else {
diff --git a/packages/loot-core/src/shared/test-helpers.ts b/packages/loot-core/src/shared/test-helpers.ts
index 8ea87a3f9d..81603591b9 100644
--- a/packages/loot-core/src/shared/test-helpers.ts
+++ b/packages/loot-core/src/shared/test-helpers.ts
@@ -1,3 +1,5 @@
+import { logger } from '../platform/server/log';
+
export let tracer: null | ReturnType<typeof execTracer> = null;
function timeout<T extends Promise<unknown>>(promise: T, n: number) {
@@ -35,7 +37,7 @@ export function execTracer<T>() {
if (!hasStarted) {
return;
} else if (log) {
- console.log(`--- event(${name}, ${JSON.stringify(data)}) ---`);
+ logger.log(`--- event(${name}, ${JSON.stringify(data)}) ---`);
}
if (ended) {
@@ -76,7 +78,7 @@ export function execTracer<T>() {
if (!hasStarted) {
throw new Error(`Expected "${name}" but tracer hasn't started yet`);
} else if (log) {
- console.log(`--- expectWait(${name}) ---`);
+ logger.log(`--- expectWait(${name}) ---`);
}
const promise = this.wait(name);
@@ -108,7 +110,7 @@ export function execTracer<T>() {
if (!hasStarted) {
throw new Error(`Expected "${name}" but tracer hasn't started yet`);
} else if (log) {
- console.log(`--- expectNow(${name}) ---`);
+ logger.log(`--- expectNow(${name}) ---`);
}
const entry = queue.shift();
diff --git a/packages/loot-core/src/shared/transactions.ts b/packages/loot-core/src/shared/transactions.ts
index caca4ebaf7..7137d81981 100644
--- a/packages/loot-core/src/shared/transactions.ts
+++ b/packages/loot-core/src/shared/transactions.ts
@@ -1,4 +1,5 @@
import { v4 as uuidv4 } from 'uuid';
+import { logger } from '../platform/server/log';
import { type TransactionEntity } from '../types/models';
@@ -179,7 +180,7 @@ function replaceTransactions(
if (trans.is_parent || trans.is_child) {
const parentIndex = findParentIndex(transactions, idx);
if (parentIndex == null) {
- console.log('Cannot find parent index');
+ logger.log('Cannot find parent index');
return {
data: [],
diff: { added: [], deleted: [], updated: [] },
diff --git a/upcoming-release-notes/6503.md b/upcoming-release-notes/6503.md
new file mode 100644
index 0000000000..a153feb758
--- /dev/null
+++ b/upcoming-release-notes/6503.md
@@ -0,0 +1,6 @@
+---
+category: Enhancements
+authors: [matt-fidd]
+---
+
+Expand `verbose: false` support in the API