Skip to content

A local-first personal finance app

[AI] Fix stale session token recovery (#8648)

Reza Namazi1e68c82716a3
diff --git a/packages/loot-core/src/server/cloud-storage.test.ts b/packages/loot-core/src/server/cloud-storage.test.ts
new file mode 100644
index 0000000000..bcb4af2f7b
--- /dev/null
+++ b/packages/loot-core/src/server/cloud-storage.test.ts
@@ -0,0 +1,73 @@
+const { mockedFetch, mockedGetItem, mockedRemoveItem } = vi.hoisted(() => ({
+ mockedFetch: vi.fn(),
+ mockedGetItem: vi.fn(),
+ mockedRemoveItem: vi.fn(),
+}));
+
+vi.unmock('#server/post');
+vi.unmock('./post');
+
+vi.mock('#platform/server/fetch', () => ({
+ fetch: mockedFetch,
+}));
+
+vi.mock('#platform/server/asyncStorage', () => ({
+ getItem: mockedGetItem,
+ removeItem: mockedRemoveItem,
+}));
+
+describe('listRemoteFiles', () => {
+ beforeEach(() => {
+ vi.resetModules();
+ mockedFetch.mockReset();
+ mockedGetItem.mockReset().mockResolvedValue('stale-token');
+ mockedRemoveItem.mockReset();
+ });
+
+ it('removes a token whose server session no longer exists', async () => {
+ mockedFetch.mockResolvedValue(
+ new Response(
+ JSON.stringify({
+ status: 'error',
+ reason: 'unauthorized',
+ details: 'token-not-found',
+ }),
+ {
+ status: 401,
+ headers: { 'Content-Type': 'application/json' },
+ },
+ ),
+ );
+
+ const { setServer } = await import('./server-config');
+ setServer('https://test.env');
+ const { listRemoteFiles } = await import('./cloud-storage');
+ await listRemoteFiles();
+
+ expect(mockedGetItem).toHaveBeenCalledWith('user-token');
+ expect(mockedFetch).toHaveBeenCalledOnce();
+ expect(mockedRemoveItem).toHaveBeenCalledWith('user-token');
+ });
+
+ it('removes an expired token reported by an older server', async () => {
+ mockedFetch.mockResolvedValue(
+ new Response(
+ JSON.stringify({
+ status: 'error',
+ data: { reason: 'token-expired' },
+ }),
+ {
+ status: 403,
+ headers: { 'Content-Type': 'application/json' },
+ },
+ ),
+ );
+
+ const { setServer } = await import('./server-config');
+ setServer('https://test.env');
+ const { listRemoteFiles } = await import('./cloud-storage');
+ await listRemoteFiles();
+
+ expect(mockedRemoveItem).toHaveBeenCalledWith('user-token');
+ });
+});
diff --git a/packages/loot-core/src/server/cloud-storage.ts b/packages/loot-core/src/server/cloud-storage.ts
index c79a202db3..0e1c375742 100644
--- a/packages/loot-core/src/server/cloud-storage.ts
+++ b/packages/loot-core/src/server/cloud-storage.ts
@@ -17,7 +17,7 @@ import {
PostError,
} from './errors';
import { runMutator } from './mutators';
-import { post } from './post';
+import { getServerErrorReason, post } from './post';
import * as prefs from './prefs';
import { getServer } from './server-config';
import {
@@ -47,25 +47,24 @@ export type RemoteFile = {
};
async function checkHTTPStatus(res) {
- if (res.status !== 200) {
- if (res.status === 403) {
- try {
- const text = await res.text();
- const data = JSON.parse(text)?.data;
- if (data?.reason === 'token-expired') {
- await asyncStorage.removeItem('user-token');
- throw new HTTPError(403, 'token-expired');
- }
- } catch (e) {
- if (e instanceof HTTPError) throw e;
+ if (res.status === 200) {
+ return res;
+ }
+
+ const text = await res.text();
+ if (res.status === 401 || res.status === 403) {
+ try {
+ const body = JSON.parse(text);
+ const error = res.status === 403 ? body.data : body;
+ if (getServerErrorReason(error) === 'token-expired') {
+ await asyncStorage.removeItem('user-token');
}
+ } catch {
+ // Preserve the original HTTP error when the response is not JSON.
}
- return res.text().then(str => {
- throw new HTTPError(res.status, str);
- });
- } else {
- return res;
}
+
+ throw new HTTPError(res.status, text);
}
async function fetchJSON(...args: Parameters<typeof fetch>) {
diff --git a/packages/loot-core/src/server/post.test.ts b/packages/loot-core/src/server/post.test.ts
index 57fff0fa72..d3e2618f45 100644
--- a/packages/loot-core/src/server/post.test.ts
+++ b/packages/loot-core/src/server/post.test.ts
@@ -54,6 +54,29 @@ describe('postBinary', () => {
expect((error as PostError).reason).toBe('network-failure');
expect((error as PostError).cause).toBe(underlying);
});
+
+ it('treats a missing server session as an expired token', async () => {
+ mockedFetch.mockResolvedValue(
+ new Response(
+ JSON.stringify({
+ status: 'error',
+ reason: 'unauthorized',
+ details: 'token-not-found',
+ }),
+ {
+ status: 401,
+ headers: { 'Content-Type': 'application/json' },
+ },
+ ),
+ );
+
+ const error = await captureError(
+ postBinary('https://test.env/sync/sync', new Uint8Array([1]), {}),
+ );
+
+ expect(error).toBeInstanceOf(PostError);
+ expect((error as PostError).reason).toBe('token-expired');
+ });
});
describe('post', () => {
diff --git a/packages/loot-core/src/server/post.ts b/packages/loot-core/src/server/post.ts
index 7ade9d20df..6355a80a3d 100644
--- a/packages/loot-core/src/server/post.ts
+++ b/packages/loot-core/src/server/post.ts
@@ -5,6 +5,12 @@ import * as Platform from '#shared/platform';
import { PostError } from './errors';
+export function getServerErrorReason(error) {
+ return error.reason === 'unauthorized' && error.details === 'token-not-found'
+ ? 'token-expired'
+ : error.reason;
+}
+
function throwIfNot200(res: Response, text: string) {
if (res.status !== 200) {
if (res.status === 500) {
@@ -14,7 +20,7 @@ function throwIfNot200(res: Response, text: string) {
const contentType = res.headers.get('Content-Type') ?? '';
if (contentType.toLowerCase().indexOf('application/json') !== -1) {
const json = JSON.parse(text);
- throw new PostError(json.reason);
+ throw new PostError(getServerErrorReason(json));
}
// Actual Sync Server may be exposed via a tunnel (e.g. ngrok). Tunnel errors should be treated as network errors.
diff --git a/upcoming-release-notes/fix-stale-session-token.md b/upcoming-release-notes/fix-stale-session-token.md
new file mode 100644
index 0000000000..5e37343205
--- /dev/null
+++ b/upcoming-release-notes/fix-stale-session-token.md
@@ -0,0 +1,6 @@
+---
+category: Bugfix
+authors: [rezanmz]
+---
+
+Return to login when a saved server session is no longer valid