Forcibly reload app from server when API is redirected (#3286)

* Add advanced setting to reload app from server

* Add change notes

* Automatically reload when API call is redirected

* Error on redirect so we don't use the response

* Remove setting to reload

* Update release notes

---------

Co-authored-by: youngcw <calebyoung94@gmail.com>

packages/desktop-client/src/browser-preload.browser.js

@@ -51,6 +51,22 @@ global.Actual = {
     window.location.reload();
   },
 
+  reload: () => {
+    if (window.navigator.serviceWorker == null) return;
+
+    // Unregister the service worker handling routing and then reload. This should force the reload
+    // to query the actual server rather than delegating to the worker
+    return window.navigator.serviceWorker
+      .getRegistration('/')
+      .then(registration => {
+        if (registration == null) return;
+        return registration.unregister();
+      })
+      .then(() => {
+        window.location.reload();
+      });
+  },
+
   restartElectronServer: () => {},
 
   openFileDialog: async ({ filters = [] }) => {

packages/desktop-client/src/global-events.ts

@@ -142,4 +142,8 @@ export function handleGlobalEvents(actions: BoundActions, store: Store<State>) {
     actions.closeBudgetUI();
     actions.setAppState({ loadingText: null });
   });
+
+  listen('api-fetch-redirected', () => {
+    actions.reloadApp();
+  });
 }

packages/loot-core/src/client/actions/app.ts

@@ -46,3 +46,9 @@ export function focused() {
     return send('app-focused');
   };
 }
+
+export function reloadApp() {
+  return () => {
+    global.Actual.reload();
+  };
+}

packages/loot-core/src/platform/server/fetch/index.web.ts

-export const fetch = globalThis.fetch;
+import * as connection from '../connection';
+
+export const fetch = async (
+  input: RequestInfo | URL,
+  options?: RequestInit,
+): Promise<Response> => {
+  const response = await globalThis.fetch(input, options);
+
+  // Detect if the API query has been redirected to a different origin. This may indicate that the
+  // request has been intercepted by an authentication proxy
+  const originalUrl = new URL(input instanceof Request ? input.url : input);
+  const responseUrl = new URL(response.url);
+  if (response.redirected && responseUrl.host !== originalUrl.host) {
+    connection.send('api-fetch-redirected');
+    throw new Error(`API request redirected to ${responseUrl.host}`);
+  }
+
+  return response;
+};

packages/loot-core/src/types/server-events.d.ts

@@ -18,4 +18,5 @@ export interface ServerEvents {
   'start-load': unknown;
   'sync-event': { type; subtype; meta; tables; syncDisabled };
   'undo-event': UndoState;
+  'api-fetch-redirected': unknown;
 }

packages/loot-core/typings/window.d.ts

@@ -15,6 +15,7 @@ declare global {
         opts: Parameters<import('electron').Dialog['showOpenDialogSync']>[0],
       ) => Promise<string[]>;
       relaunch: () => void;
+      reload: (() => Promise<void>) | undefined;
       restartElectronServer: () => void;
     };
 

upcoming-release-notes/3286.md

+---
+category: Bugfix
+authors: [TimQuelch]
+---
+
+Forcibly reload app when API request is redirected. This fixes issue #2793