Skip to content

A local-first personal finance app

Extract spreadsheet related server handlers from main.ts to server/spreadsheet/app.ts (#4649)

Joel Jeremy Marqueze0bddaeb99b0
diff --git a/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx b/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx
index adf06212f8..b6d7bc4b07 100644
--- a/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx
+++ b/packages/desktop-client/src/components/transactions/TransactionsTable.test.tsx
@@ -239,10 +239,14 @@ function initBasicServer() {
throw new Error(`queried unknown table: ${query.table}`);
}
},
- getCell: () => ({
+ 'get-cell': async () => ({
+ name: 'test-cell',
value: 129_87,
}),
- 'get-categories': () => ({ grouped: categoryGroups, list: categories }),
+ 'get-categories': async () => ({
+ grouped: categoryGroups,
+ list: categories,
+ }),
});
}
diff --git a/packages/loot-core/src/client/SpreadsheetProvider.tsx b/packages/loot-core/src/client/SpreadsheetProvider.tsx
index 23d306776a..bbd6dcbfba 100644
--- a/packages/loot-core/src/client/SpreadsheetProvider.tsx
+++ b/packages/loot-core/src/client/SpreadsheetProvider.tsx
@@ -132,11 +132,11 @@ function makeSpreadsheet() {
}
get(sheetName: string, name: string) {
- return send('getCell', { sheetName, name });
+ return send('get-cell', { sheetName, name });
}
getCellNames(sheetName: string) {
- return send('getCellNamesInSheet', { sheetName });
+ return send('get-cell-names', { sheetName });
}
createQuery(sheetName: string, name: string, query: Query) {
diff --git a/packages/loot-core/src/platform/client/fetch/index.d.ts b/packages/loot-core/src/platform/client/fetch/index.d.ts
index dcb660ea90..67ce138505 100644
--- a/packages/loot-core/src/platform/client/fetch/index.d.ts
+++ b/packages/loot-core/src/platform/client/fetch/index.d.ts
@@ -1,5 +1,4 @@
import type { Handlers } from '../../../types/handlers';
-import type { CategoryGroupEntity } from '../../../types/models';
import type { ServerEvents } from '../../../types/server-events';
export function init(socketName: string): Promise<unknown>;
@@ -45,15 +44,7 @@ export function unlisten(name: string): void;
export type Unlisten = typeof unlisten;
/** Mock functions */
-export function initServer(handlers: {
- query: (query: { table: string; selectExpressions: unknown }) => Promise<{
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- data: any;
- dependencies: string[];
- }>;
- getCell?: () => { value: number };
- 'get-categories'?: () => { grouped: CategoryGroupEntity[] };
-}): void;
+export function initServer(handlers: Partial<Handlers>): void;
export type InitServer = typeof initServer;
export function serverPush(name: string, args: unknown): void;
diff --git a/packages/loot-core/src/server/budget/app.ts b/packages/loot-core/src/server/budget/app.ts
index a6a9697e86..2b368f7a9d 100644
--- a/packages/loot-core/src/server/budget/app.ts
+++ b/packages/loot-core/src/server/budget/app.ts
@@ -310,7 +310,7 @@ async function deleteCategory({
transferId,
}: {
id: CategoryEntity['id'];
- transferId: CategoryEntity['id'];
+ transferId?: CategoryEntity['id'];
}): Promise<{ error?: 'no-categories' | 'category-type' }> {
let result = {};
await batchMessages(async () => {
diff --git a/packages/loot-core/src/server/main.ts b/packages/loot-core/src/server/main.ts
index 334992a9ec..efe9da0aa8 100644
--- a/packages/loot-core/src/server/main.ts
+++ b/packages/loot-core/src/server/main.ts
@@ -50,7 +50,7 @@ import { app as rulesApp } from './rules/app';
import { app as schedulesApp } from './schedules/app';
import { getServer, isValidBaseURL, setServer } from './server-config';
import * as sheet from './sheet';
-import { resolveName, unresolveName } from './spreadsheet/util';
+import { app as spreadsheetApp } from './spreadsheet/app';
import {
initialFullSync,
fullSync,
@@ -106,44 +106,6 @@ handlers['make-filters-from-conditions'] = async function ({
return rules.conditionsToAQL(conditions, { applySpecialCases });
};
-handlers['getCell'] = async function ({ sheetName, name }) {
- const node = sheet.get()._getNode(resolveName(sheetName, name));
- return { name: node.name, value: node.value };
-};
-
-handlers['getCells'] = async function ({ names }) {
- return names.map(name => {
- const node = sheet.get()._getNode(name);
- return { name: node.name, value: node.value };
- });
-};
-
-handlers['getCellNamesInSheet'] = async function ({ sheetName }) {
- const names = [];
- for (const name of sheet.get().getNodes().keys()) {
- const { sheet: nodeSheet, name: nodeName } = unresolveName(name);
- if (nodeSheet === sheetName) {
- names.push(nodeName);
- }
- }
- return names;
-};
-
-handlers['debugCell'] = async function ({ sheetName, name }) {
- const node = sheet.get().getNode(resolveName(sheetName, name));
- return {
- ...node,
- _run: node._run && node._run.toString(),
- };
-};
-
-handlers['create-query'] = async function ({ sheetName, name, query }) {
- // Always run it regardless of cache. We don't know anything has changed
- // between the cache value being saved and now
- sheet.get().createQuery(sheetName, name, query);
- return 'ok';
-};
-
handlers['query'] = async function (query) {
if (query.table == null) {
throw new Error('query has no table, did you forgot to call `.serialize`?');
@@ -1143,6 +1105,7 @@ app.combine(
transactionsApp,
accountsApp,
payeesApp,
+ spreadsheetApp,
);
export function getDefaultDocumentDir() {
diff --git a/packages/loot-core/src/server/spreadsheet/app.ts b/packages/loot-core/src/server/spreadsheet/app.ts
new file mode 100644
index 0000000000..05443e8c76
--- /dev/null
+++ b/packages/loot-core/src/server/spreadsheet/app.ts
@@ -0,0 +1,54 @@
+import { QueryState } from '../../shared/query';
+import { createApp } from '../app';
+import * as sheet from '../sheet';
+
+import { resolveName, unresolveName } from './util';
+
+export type SpreadsheetHandlers = {
+ 'get-cell': typeof getCell;
+ 'get-cell-names': typeof getCellNames;
+ 'create-query': typeof createQuery;
+};
+
+// Expose functions to the client
+export const app = createApp<SpreadsheetHandlers>();
+app.method('get-cell', getCell);
+app.method('get-cell-names', getCellNames);
+app.method('create-query', createQuery);
+
+async function getCell({
+ sheetName,
+ name,
+}: {
+ sheetName: string;
+ name: string;
+}) {
+ const node = sheet.get()._getNode(resolveName(sheetName, name));
+ return { name: node.name, value: node.value };
+}
+
+async function getCellNames({ sheetName }: { sheetName: string }) {
+ const names = [];
+ for (const name of sheet.get().getNodes().keys()) {
+ const { sheet: nodeSheet, name: nodeName } = unresolveName(name);
+ if (nodeSheet === sheetName) {
+ names.push(nodeName);
+ }
+ }
+ return names;
+}
+
+async function createQuery({
+ sheetName,
+ name,
+ query,
+}: {
+ sheetName: string;
+ name: string;
+ query: QueryState;
+}) {
+ // Always run it regardless of cache. We don't know anything has changed
+ // between the cache value being saved and now
+ sheet.get().createQuery(sheetName, name, query);
+ return 'ok';
+}
diff --git a/packages/loot-core/src/server/spreadsheet/spreadsheet.ts b/packages/loot-core/src/server/spreadsheet/spreadsheet.ts
index 4aff0f0062..23aac3c1ae 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 { QueryState } from '../../shared/query';
import { compileQuery, runCompiledQuery, schema, schemaConfig } from '../aql';
import { Graph } from './graph-data-structure';
@@ -11,7 +12,7 @@ export type Node = {
expr: string | number | boolean;
value: string | number | boolean;
sheet: unknown;
- query?: string;
+ query?: QueryState;
sql?: { sqlPieces: unknown; state: { dependencies: unknown[] } };
dynamic?: boolean;
_run?: unknown;
@@ -338,7 +339,7 @@ export class Spreadsheet {
});
}
- createQuery(sheetName: string, cellName: string, query: string): void {
+ createQuery(sheetName: string, cellName: string, query: QueryState): void {
const name = resolveName(sheetName, cellName);
const node = this._getNode(name);
diff --git a/packages/loot-core/src/shared/async.ts b/packages/loot-core/src/shared/async.ts
index 13ad731dc0..a2b4ad4211 100644
--- a/packages/loot-core/src/shared/async.ts
+++ b/packages/loot-core/src/shared/async.ts
@@ -1,12 +1,18 @@
-// @ts-strict-ignore
-import { type HandlerFunctions } from '../types/handlers';
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type AnyFunction = (...args: any[]) => any;
-export function sequential<T extends HandlerFunctions>(
+export function sequential<T extends AnyFunction>(
fn: T,
): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>>> {
const sequenceState: {
running: Promise<Awaited<ReturnType<T>>> | null;
- queue: Array<{ args: Parameters<T>; resolve; reject }>;
+ queue: Array<{
+ args: Parameters<T>;
+ resolve: (
+ value: Awaited<ReturnType<T>> | PromiseLike<Awaited<ReturnType<T>>>,
+ ) => void;
+ reject: (reason?: unknown) => void;
+ }>;
} = {
running: null,
queue: [],
@@ -21,33 +27,39 @@ export function sequential<T extends HandlerFunctions>(
}
}
- function run(args: Parameters<T>, resolve, reject) {
+ function run(
+ args: Parameters<T>,
+ resolve: (
+ value: Awaited<ReturnType<T>> | PromiseLike<Awaited<ReturnType<T>>>,
+ ) => void,
+ reject: (reason?: unknown) => void,
+ ) {
sequenceState.running = fn.apply(null, args).then(
- val => {
+ (val: Awaited<ReturnType<T>> | PromiseLike<Awaited<ReturnType<T>>>) => {
pump();
resolve(val);
},
- err => {
+ (err: unknown) => {
pump();
reject(err);
},
);
}
- return (...args) => {
+ return ((...args: Parameters<T>) => {
if (!sequenceState.running) {
- return new Promise((resolve, reject) => {
+ return new Promise<Awaited<ReturnType<T>>>((resolve, reject) => {
return run(args, resolve, reject);
});
} else {
- return new Promise((resolve, reject) => {
+ return new Promise<Awaited<ReturnType<T>>>((resolve, reject) => {
sequenceState.queue.push({ resolve, reject, args });
});
}
- };
+ }) as T;
}
-export function once<T extends HandlerFunctions>(
+export function once<T extends AnyFunction>(
fn: T,
): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>>> | null {
let promise: Promise<Awaited<ReturnType<T>>> | null = null;
diff --git a/packages/loot-core/src/types/handlers.d.ts b/packages/loot-core/src/types/handlers.d.ts
index 00eb461c25..920b0246ab 100644
--- a/packages/loot-core/src/types/handlers.d.ts
+++ b/packages/loot-core/src/types/handlers.d.ts
@@ -9,6 +9,7 @@ import type { PreferencesHandlers } from '../server/preferences/app';
import type { ReportsHandlers } from '../server/reports/app';
import type { RulesHandlers } from '../server/rules/app';
import type { SchedulesHandlers } from '../server/schedules/app';
+import type { SpreadsheetHandlers } from '../server/spreadsheet/app';
import type { ToolsHandlers } from '../server/tools/app';
import type { TransactionHandlers } from '../server/transactions/app';
@@ -30,6 +31,7 @@ export interface Handlers
AdminHandlers,
ToolsHandlers,
AccountHandlers,
- PayeesHandlers {}
+ PayeesHandlers,
+ SpreadsheetHandlers {}
export type HandlerFunctions = Handlers[keyof Handlers];
diff --git a/packages/loot-core/src/types/server-handlers.d.ts b/packages/loot-core/src/types/server-handlers.d.ts
index c4d6b53fb0..e3c6e411c5 100644
--- a/packages/loot-core/src/types/server-handlers.d.ts
+++ b/packages/loot-core/src/types/server-handlers.d.ts
@@ -1,10 +1,8 @@
import { Backup } from '../server/backups';
import { RemoteFile } from '../server/cloud-storage';
-import { Node as SpreadsheetNode } from '../server/spreadsheet/spreadsheet';
import { Message } from '../server/sync';
import { Budget } from './budget';
-import { CategoryEntity, CategoryGroupEntity } from './models';
import { OpenIdConfig } from './models/openid';
// eslint-disable-next-line import/no-unresolved
import { Query } from './query';
@@ -14,80 +12,13 @@ export interface ServerHandlers {
undo: () => Promise<void>;
redo: () => Promise<void>;
- 'get-categories': () => Promise<{
- grouped: Array<CategoryGroupEntity>;
- list: Array<CategoryEntity>;
- }>;
-
'get-earliest-transaction': () => Promise<{ date: string }>;
- 'get-budget-bounds': () => Promise<{ start: string; end: string }>;
-
- 'envelope-budget-month': (arg: { month }) => Promise<
- {
- value: string | number | boolean;
- name: string;
- }[]
- >;
-
- 'tracking-budget-month': (arg: { month }) => Promise<
- {
- value: string | number | boolean;
- name: string;
- }[]
- >;
-
- 'category-create': (arg: {
- name;
- groupId;
- isIncome?;
- hidden?: boolean;
- }) => Promise<string>;
-
- 'category-update': (category) => Promise<unknown>;
-
- 'category-move': (arg: { id; groupId; targetId }) => Promise<unknown>;
-
- 'category-delete': (arg: { id; transferId? }) => Promise<{ error?: string }>;
-
- 'category-group-create': (arg: {
- name;
- isIncome?: boolean;
- hidden?: boolean;
- }) => Promise<string>;
-
- 'category-group-update': (group) => Promise<unknown>;
-
- 'category-group-move': (arg: { id; targetId }) => Promise<unknown>;
-
- 'category-group-delete': (arg: { id; transferId }) => Promise<unknown>;
-
- 'must-category-transfer': (arg: { id }) => Promise<unknown>;
-
'make-filters-from-conditions': (arg: {
conditions: unknown;
applySpecialCases?: boolean;
}) => Promise<{ filters: unknown[] }>;
- getCell: (arg: { sheetName; name }) => Promise<{
- name: SpreadsheetNode['name'];
- value: SpreadsheetNode['value'];
- }>;
-
- getCells: (arg: {
- names;
- }) => Promise<
- Array<{ name: SpreadsheetNode['name']; value?: SpreadsheetNode['value'] }>
- >;
-
- getCellNamesInSheet: (arg: {
- sheetName;
- }) => Promise<Array<SpreadsheetNode['name']>>;
-
- debugCell: (arg: { sheetName; name }) => Promise<unknown>;
-
- 'create-query': (arg: { sheetName; name; query }) => Promise<'ok'>;
-
// eslint-disable-next-line @typescript-eslint/no-explicit-any
query: (query: Query) => Promise<{ data: any; dependencies: string[] }>;
diff --git a/upcoming-release-notes/4649.md b/upcoming-release-notes/4649.md
new file mode 100644
index 0000000000..adce20ab1a
--- /dev/null
+++ b/upcoming-release-notes/4649.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [joel-jeremy]
+---
+
+Extract spreadsheet related server handlers from main.ts to server/spreadsheet/app.ts
\ No newline at end of file