A local-first personal finance app
[AI] Fall back to IPv4 when binding to IPv6 is unavailable (#9226)
Dami Oyeniyifa10ddb9debf
diff --git a/packages/sync-server/src/app.ts b/packages/sync-server/src/app.tsindex 88f1c1de25..8d122a1ec1 100644--- a/packages/sync-server/src/app.ts+++ b/packages/sync-server/src/app.ts@@ -20,6 +20,7 @@ import * as secretApp from './app-secrets';import * as simpleFinApp from './app-simplefin/app-simplefin';import * as syncApp from './app-sync';import { config } from './load-config';+import { listen } from './util/server-listen';const debugSensitive = createDebug('actual-sensitive:server');@@ -190,14 +191,12 @@ export function parseHTTPSConfig(value: string) {return fs.readFileSync(value);}-function sendServerStartedMessage() {+function sendServerStartedMessage(address: string) {// Signify to any parent process that the server has started. Used in electron desktop app// oxlint-disable-next-line typescript/ban-ts-comment// @ts-ignore-error electron typesprocess.parentPort?.postMessage({ type: 'server-started' });- console.log(- 'Listening on ' + config.get('hostname') + ':' + config.get('port') + '...',- );+ console.log('Listening on ' + address + ':' + config.get('port') + '...');}export async function run() {@@ -229,12 +228,14 @@ export async function run() {key: parseHTTPSConfig(config.get('https.key')),cert: parseHTTPSConfig(config.get('https.cert')),};- https.createServer(httpsOptions, app).listen(port, hostname, () => {- sendServerStartedMessage();- });+ listen(+ https.createServer(httpsOptions, app),+ port,+ hostname,+ sendServerStartedMessage,+ );} else {- app.listen(port, hostname, () => {- sendServerStartedMessage();- });+ const http = await import('node:http');+ listen(http.createServer(app), port, hostname, sendServerStartedMessage);}}diff --git a/packages/sync-server/src/util/server-listen.test.ts b/packages/sync-server/src/util/server-listen.test.tsnew file mode 100644index 0000000000..1b60e99def--- /dev/null+++ b/packages/sync-server/src/util/server-listen.test.ts@@ -0,0 +1,34 @@+import { createServer } from 'node:net';+import type { Server } from 'node:net';++import { afterEach, describe, expect, it, vi } from 'vitest';++import { listen } from './server-listen';++describe('listen', () => {+ let server: Server;++ afterEach(() => new Promise(resolve => server.close(resolve)));++ it.each([+ { hostname: '::', host: undefined, addresses: ['::', '0.0.0.0'] },+ { hostname: '127.0.0.1', host: '127.0.0.1', addresses: ['127.0.0.1'] },+ ])(+ 'reports the bound address for $hostname',+ async ({ hostname, host, addresses }) => {+ server = createServer();+ const listenSpy = vi.spyOn(server, 'listen');++ const address = await new Promise<string>(resolve =>+ listen(server, 0, hostname, resolve),+ );++ expect(listenSpy).toHaveBeenCalledExactlyOnceWith(+ 0,+ host,+ expect.any(Function),+ );+ expect(addresses).toContain(address);+ },+ );+});diff --git a/packages/sync-server/src/util/server-listen.ts b/packages/sync-server/src/util/server-listen.tsnew file mode 100644index 0000000000..6881613e22--- /dev/null+++ b/packages/sync-server/src/util/server-listen.ts@@ -0,0 +1,16 @@+import type { Server } from 'node:net';++export function listen(+ server: Server,+ port: number,+ hostname: string,+ onListening: (address: string) => void,+): void {+ // Omitting the host lets Node fall back to `0.0.0.0` when IPv6 is unavailable+ server.listen(port, hostname === '::' ? undefined : hostname, () => {+ const address = server.address();+ onListening(+ address && typeof address === 'object' ? address.address : hostname,+ );+ });+}diff --git a/upcoming-release-notes/fallback-ipv4-when-ipv6-unavailable.md b/upcoming-release-notes/fallback-ipv4-when-ipv6-unavailable.mdnew file mode 100644index 0000000000..c5c7631a36--- /dev/null+++ b/upcoming-release-notes/fallback-ipv4-when-ipv6-unavailable.md@@ -0,0 +1,6 @@+---+category: Bugfix+authors: [grzdev]+---++Fix the sync server not starting on systems with IPv6 disabled