Skip to content

A local-first personal finance app

Stop mixing platform-specific code (#1114)

Jed Fox02f1fe48c6e0
diff --git a/.eslintrc.js b/.eslintrc.js
index 4e7f3c5187..c5567bd7af 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -13,6 +13,13 @@ rulesDirPlugin.RULES_DIR = path.join(
const ruleFCMsg =
'Type the props argument and let TS infer or use ComponentType for a component prop';
+const restrictedImportPatterns = [
+ {
+ group: ['*.api', '*.web', '*.electron'],
+ message: 'Don’t directly reference imports from other platforms',
+ },
+];
+
module.exports = {
plugins: ['prettier', 'import', 'rulesdir', '@typescript-eslint'],
extends: ['react-app', 'plugin:@typescript-eslint/recommended'],
@@ -54,6 +61,13 @@ module.exports = {
// },
// ],
+ 'import/extensions': [
+ 'error',
+ 'never',
+ {
+ json: 'always',
+ },
+ ],
'import/no-useless-path-segments': 'error',
'import/no-duplicates': ['error', { 'prefer-inline': true }],
'import/order': [
@@ -95,6 +109,7 @@ module.exports = {
'Using default React import is discouraged, please use named exports directly instead.',
},
],
+ 'no-restricted-imports': ['error', { patterns: restrictedImportPatterns }],
// Rules disable during TS migration
'@typescript-eslint/no-var-requires': 'off',
@@ -140,6 +155,7 @@ module.exports = {
'error',
{
patterns: [
+ ...restrictedImportPatterns,
{
group: ['loot-core/**'],
message:
diff --git a/packages/api/index.js b/packages/api/index.js
index e36c3bb804..276332745c 100644
--- a/packages/api/index.js
+++ b/packages/api/index.js
@@ -1,6 +1,7 @@
import fetch from 'node-fetch';
-import * as bundle from './app/bundle.api';
+// eslint-disable-next-line import/extensions
+import * as bundle from './app/bundle.api.js';
import * as injected from './injected';
let actualApp;
diff --git a/packages/desktop-client/src/components/budget/misc.js b/packages/desktop-client/src/components/budget/misc.js
index 5f1554de3f..3a9c87ef1c 100644
--- a/packages/desktop-client/src/components/budget/misc.js
+++ b/packages/desktop-client/src/components/budget/misc.js
@@ -34,7 +34,7 @@ import {
useDroppable,
DropHighlight,
DropHighlightPosContext,
-} from '../sort.js';
+} from '../sort';
import NamespaceContext from '../spreadsheet/NamespaceContext';
import { Row, InputCell, ROW_HEIGHT } from '../table';
diff --git a/packages/desktop-client/src/components/sidebar.js b/packages/desktop-client/src/components/sidebar.js
index c72f1c3e68..db1cd3c12a 100644
--- a/packages/desktop-client/src/components/sidebar.js
+++ b/packages/desktop-client/src/components/sidebar.js
@@ -20,7 +20,7 @@ import { styles, colors } from '../style';
import { View, Block, AlignedText, AnchorLink, Button } from './common';
import { useSidebar } from './FloatableSidebar';
-import { useDraggable, useDroppable, DropHighlight } from './sort.js';
+import { useDraggable, useDroppable, DropHighlight } from './sort';
import CellValue from './spreadsheet/CellValue';
export const SIDEBAR_WIDTH = 240;
diff --git a/packages/desktop-client/src/components/spreadsheet/SheetValue.tsx b/packages/desktop-client/src/components/spreadsheet/SheetValue.tsx
index b1810c0085..ba32f81f9c 100644
--- a/packages/desktop-client/src/components/spreadsheet/SheetValue.tsx
+++ b/packages/desktop-client/src/components/spreadsheet/SheetValue.tsx
@@ -8,7 +8,7 @@ import {
import { useSpreadsheet } from 'loot-core/src/client/SpreadsheetProvider';
-import NamespaceContext from './NamespaceContext.js';
+import NamespaceContext from './NamespaceContext';
type Binding = { name: string; value; query?: unknown };
diff --git a/packages/desktop-client/src/components/spreadsheet/useSheetValue.js b/packages/desktop-client/src/components/spreadsheet/useSheetValue.js
index 4050263b54..3f626885c1 100644
--- a/packages/desktop-client/src/components/spreadsheet/useSheetValue.js
+++ b/packages/desktop-client/src/components/spreadsheet/useSheetValue.js
@@ -2,7 +2,7 @@ import { useContext, useState, useRef, useLayoutEffect } from 'react';
import { useSpreadsheet } from 'loot-core/src/client/SpreadsheetProvider';
-import NamespaceContext from './NamespaceContext.js';
+import NamespaceContext from './NamespaceContext';
function unresolveName(name) {
let idx = name.indexOf('!');
diff --git a/packages/desktop-electron/index.js b/packages/desktop-electron/index.js
index 7d5808e3ba..898c42aa3f 100644
--- a/packages/desktop-electron/index.js
+++ b/packages/desktop-electron/index.js
@@ -49,6 +49,7 @@ if (!isDev || !process.env.ACTUAL_DATA_DIR) {
process.env.ACTUAL_DATA_DIR = app.getPath('userData');
}
+// eslint-disable-next-line import/extensions
const WindowState = require('./window-state.js');
// Keep a global reference of the window object, if you don't, the window will
diff --git a/packages/desktop-electron/server.js b/packages/desktop-electron/server.js
index 5e21ae9c7d..d8c02c0442 100644
--- a/packages/desktop-electron/server.js
+++ b/packages/desktop-electron/server.js
@@ -5,6 +5,7 @@ global.fetch = require('node-fetch');
// Lazy load backend code
function getBackend() {
+ // eslint-disable-next-line import/extensions
return require('loot-core/lib-dist/bundle.desktop.js');
}
diff --git a/packages/desktop-electron/window-state.js b/packages/desktop-electron/window-state.js
index 119a38357c..27f9c51fd2 100644
--- a/packages/desktop-electron/window-state.js
+++ b/packages/desktop-electron/window-state.js
@@ -3,6 +3,7 @@ let path = require('path');
let electron = require('electron');
+// eslint-disable-next-line import/extensions
let backend = require('loot-core/lib-dist/bundle.desktop.js');
function loadState() {
diff --git a/packages/loot-core/init-node.js b/packages/loot-core/init-node.js
index 36b75e2126..a426a73b29 100644
--- a/packages/loot-core/init-node.js
+++ b/packages/loot-core/init-node.js
@@ -3,7 +3,8 @@ import { dirname, basename } from 'path';
import fetch from 'node-fetch';
import 'source-map-support/register';
-import bundle from './lib-dist/bundle.desktop';
+// eslint-disable-next-line import/extensions
+import bundle from './lib-dist/bundle.desktop.js';
global.fetch = fetch;
diff --git a/packages/loot-core/src/platform/client/fetch/index.testing.ts b/packages/loot-core/src/platform/client/fetch/index.testing.ts
index 0fe9f0e0b0..e96d886381 100644
--- a/packages/loot-core/src/platform/client/fetch/index.testing.ts
+++ b/packages/loot-core/src/platform/client/fetch/index.testing.ts
@@ -1 +1,2 @@
+// eslint-disable-next-line no-restricted-imports, import/extensions
export * from './__mocks__/index.web';
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 89d042397c..8e5df8d61e 100644
--- a/packages/loot-core/src/platform/server/fs/index.electron.ts
+++ b/packages/loot-core/src/platform/server/fs/index.electron.ts
@@ -3,7 +3,7 @@ import * as path from 'path';
import type * as T from '.';
-let documentDir;
+export { getDocumentDir, getBudgetDir, _setDocumentDir } from './shared';
let rootPath = path.join(__dirname, '..', '..', '..', '..');
@@ -24,36 +24,6 @@ export const getDataDir = () => {
return process.env.ACTUAL_DATA_DIR;
};
-export const _setDocumentDir = dir => (documentDir = dir);
-
-export const getDocumentDir = () => {
- if (!documentDir) {
- throw new Error('Document directory is not set');
- }
- return documentDir;
-};
-
-export const getBudgetDir = id => {
- if (!id) {
- throw new Error('getDocumentDir: id is falsy: ' + id);
- }
-
- // TODO: This should be better
- //
- // A cheesy safe guard. The id is generated from the budget name,
- // so it provides an entry point for the user to accidentally (or
- // intentionally) access other parts of the system. Always
- // restrict it to only access files within the budget directory by
- // never allowing slashes.
- if (id.match(/[^A-Za-z0-9\-_]/)) {
- throw new Error(
- `Invalid budget id “${id}”. Check the id of your budget in the Advanced section of the settings page.`,
- );
- }
-
- return path.join(getDocumentDir(), id);
-};
-
export const bundledDatabasePath = path.join(rootPath, 'default-db.sqlite');
export const migrationsPath = path.join(rootPath, 'migrations');
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 e85b27a408..c96e5821b9 100644
--- a/packages/loot-core/src/platform/server/fs/index.web.ts
+++ b/packages/loot-core/src/platform/server/fs/index.web.ts
@@ -16,12 +16,8 @@ export const bundledDatabasePath = '/default-db.sqlite';
export const migrationsPath = '/migrations';
export const demoBudgetPath = '/demo-budget';
export { join };
-export {
- getDataDir,
- getDocumentDir,
- getBudgetDir,
- _setDocumentDir,
-} from './index.electron';
+export { getDocumentDir, getBudgetDir, _setDocumentDir } from './shared';
+export const getDataDir = () => process.env.ACTUAL_DATA_DIR;
export const pathToId = function (filepath) {
return filepath.replace(/^\//, '').replace(/\//g, '-');
diff --git a/packages/loot-core/src/platform/server/fs/path-join.electron.ts b/packages/loot-core/src/platform/server/fs/path-join.electron.ts
new file mode 100644
index 0000000000..8ec5406307
--- /dev/null
+++ b/packages/loot-core/src/platform/server/fs/path-join.electron.ts
@@ -0,0 +1,3 @@
+import { join } from 'path';
+
+export default join;
diff --git a/packages/loot-core/src/platform/server/fs/shared.ts b/packages/loot-core/src/platform/server/fs/shared.ts
new file mode 100644
index 0000000000..bedc69b6c2
--- /dev/null
+++ b/packages/loot-core/src/platform/server/fs/shared.ts
@@ -0,0 +1,32 @@
+import join from './path-join';
+
+let documentDir;
+export const _setDocumentDir = dir => (documentDir = dir);
+
+export const getDocumentDir = () => {
+ if (!documentDir) {
+ throw new Error('Document directory is not set');
+ }
+ return documentDir;
+};
+
+export const getBudgetDir = id => {
+ if (!id) {
+ throw new Error('getDocumentDir: id is falsy: ' + id);
+ }
+
+ // TODO: This should be better
+ //
+ // A cheesy safe guard. The id is generated from the budget name,
+ // so it provides an entry point for the user to accidentally (or
+ // intentionally) access other parts of the system. Always
+ // restrict it to only access files within the budget directory by
+ // never allowing slashes.
+ if (id.match(/[^A-Za-z0-9\-_]/)) {
+ throw new Error(
+ `Invalid budget id “${id}”. Check the id of your budget in the Advanced section of the settings page.`,
+ );
+ }
+
+ return join(getDocumentDir(), id);
+};
diff --git a/packages/loot-core/src/platform/server/sqlite/index.web.test.ts b/packages/loot-core/src/platform/server/sqlite/index.web.test.ts
index c48a88f9fc..ab64c064e4 100644
--- a/packages/loot-core/src/platform/server/sqlite/index.web.test.ts
+++ b/packages/loot-core/src/platform/server/sqlite/index.web.test.ts
@@ -1,9 +1,11 @@
+// eslint-disable-next-line no-restricted-imports
import {
init,
openDatabase,
transaction,
execQuery,
runQuery,
+ // eslint-disable-next-line import/extensions
} from './index.web';
beforeAll(() => {
diff --git a/packages/loot-core/src/server/migrate/migrations.ts b/packages/loot-core/src/server/migrate/migrations.ts
index 898ff0fd6e..46326e0626 100644
--- a/packages/loot-core/src/server/migrate/migrations.ts
+++ b/packages/loot-core/src/server/migrate/migrations.ts
@@ -1,7 +1,7 @@
// We have to bundle in JS migrations manually to avoid having to `eval`
// them which doesn't play well with CSP. There isn't great, and eventually
// we can remove this migration.
-import m1632571489012 from '../../../migrations/1632571489012_remove_cache.js';
+import m1632571489012 from '../../../migrations/1632571489012_remove_cache';
import * as fs from '../../platform/server/fs';
import * as sqlite from '../../platform/server/sqlite';
import * as uuid from '../../platform/uuid';
diff --git a/packages/loot-core/src/types/api.handlers.d.ts b/packages/loot-core/src/types/api-handlers.d.ts
similarity index 100%
rename from packages/loot-core/src/types/api.handlers.d.ts
rename to packages/loot-core/src/types/api-handlers.d.ts
diff --git a/packages/loot-core/src/types/handlers.d.ts b/packages/loot-core/src/types/handlers.d.ts
index 8ed197b7a6..d77ae3613d 100644
--- a/packages/loot-core/src/types/handlers.d.ts
+++ b/packages/loot-core/src/types/handlers.d.ts
@@ -2,8 +2,8 @@ import type { BudgetHandlers } from '../server/budget/types/handlers';
import type { NotesHandlers } from '../server/notes/types/handlers';
import type { SchedulesHandlers } from '../server/schedules/types/handlers';
-import type { ApiHandlers } from './api.handlers';
-import type { MainHandlers } from './main.handlers';
+import type { ApiHandlers } from './api-handlers';
+import type { MainHandlers } from './main-handlers';
export interface Handlers
extends MainHandlers,
diff --git a/packages/loot-core/src/types/main.handlers.d.ts b/packages/loot-core/src/types/main-handlers.d.ts
similarity index 100%
rename from packages/loot-core/src/types/main.handlers.d.ts
rename to packages/loot-core/src/types/main-handlers.d.ts
diff --git a/upcoming-release-notes/1114.md b/upcoming-release-notes/1114.md
new file mode 100644
index 0000000000..25d28e9bcf
--- /dev/null
+++ b/upcoming-release-notes/1114.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [j-f1]
+---
+
+Stop mixing platform-specific code