Skip to content

A continuation of HomeBox the inventory and organization system built for the Home User

fix: better websocket auth/retry logic

Matthew Kilgore3397c78fb583
diff --git a/backend/app/api/handlers/v1/controller.go b/backend/app/api/handlers/v1/controller.go
index 36ade377..bb94071c 100644
--- a/backend/app/api/handlers/v1/controller.go
+++ b/backend/app/api/handlers/v1/controller.go
@@ -203,6 +203,7 @@ func (ctrl *V1Controller) HandleCacheWS() errchain.HandlerFunc {
}
m := melody.New()
+ m.Upgrader.Subprotocols = []string{"hb-auth"}
m.HandleConnect(func(s *melody.Session) {
auth := services.NewContext(s.Request.Context())
diff --git a/backend/app/api/middleware.go b/backend/app/api/middleware.go
index bdcd4cb7..ce3b7f75 100644
--- a/backend/app/api/middleware.go
+++ b/backend/app/api/middleware.go
@@ -148,6 +148,25 @@ func getQuery(r *http.Request) (string, error) {
return token, nil
}
+func getWebSocketProtocolToken(r *http.Request) (string, error) {
+ raw := r.Header.Get("Sec-WebSocket-Protocol")
+ if raw == "" {
+ return "", errors.New("websocket protocol token is required")
+ }
+
+ parts := strings.Split(raw, ",")
+ if len(parts) < 2 {
+ return "", errors.New("websocket protocol token is required")
+ }
+
+ token := strings.TrimSpace(parts[1])
+ if token == "" {
+ return "", errors.New("websocket protocol token is required")
+ }
+
+ return token, nil
+}
+
// mwAuthToken is a middleware that will check the database for a stateful token
// and attach it's user to the request context, or return an appropriate error.
// Authorization support is by token via Headers or Query Parameter
@@ -181,6 +200,7 @@ func (a *app) mwAuthToken(next errchain.Handler) errchain.Handler {
fn KeyFunc
}{
{"bearer", getBearer},
+ {"ws_protocol", getWebSocketProtocolToken},
{"query", getQuery},
}
diff --git a/frontend/composables/use-preferences.ts b/frontend/composables/use-preferences.ts
index a090549c..af3aa287 100644
--- a/frontend/composables/use-preferences.ts
+++ b/frontend/composables/use-preferences.ts
@@ -132,6 +132,8 @@ export function useViewPreferencesSync() {
let pauseServerSaves = true;
let applyingServerSnapshot = false;
let saveInFlight = false;
+ let refreshInFlight = false;
+ let refreshRequested = false;
let localRevision = 0;
let syncedRevision = 0;
let retryTimer: ReturnType<typeof setTimeout> | null = null;
@@ -185,17 +187,31 @@ export function useViewPreferencesSync() {
}, 400);
const refreshFromServer = async () => {
- pauseServerSaves = true;
- applyingServerSnapshot = true;
- try {
- await refreshViewPreferencesFromServer(preferences);
- } finally {
- applyingServerSnapshot = false;
+ refreshRequested = true;
+ if (refreshInFlight) {
+ return;
}
- pauseServerSaves = false;
- if (syncedRevision < localRevision) {
- void saveToServer();
+ refreshInFlight = true;
+ try {
+ while (refreshRequested) {
+ refreshRequested = false;
+
+ pauseServerSaves = true;
+ applyingServerSnapshot = true;
+ try {
+ await refreshViewPreferencesFromServer(preferences);
+ } finally {
+ applyingServerSnapshot = false;
+ }
+ pauseServerSaves = false;
+
+ if (syncedRevision < localRevision) {
+ await saveToServer();
+ }
+ }
+ } finally {
+ refreshInFlight = false;
}
};
diff --git a/frontend/composables/use-server-events.ts b/frontend/composables/use-server-events.ts
index 93e79b13..35e6853f 100644
--- a/frontend/composables/use-server-events.ts
+++ b/frontend/composables/use-server-events.ts
@@ -16,9 +16,53 @@ export type EventMessage = {
let socket: WebSocket | null = null;
let currentTenantId: string | null = null;
let watcherSetup = false;
+let reconnectTimer: ReturnType<typeof setTimeout> | null = null;
+let reconnectAttempts = 0;
+
+const RECONNECT_BASE_DELAY_MS = 1000;
+const RECONNECT_MAX_DELAY_MS = 30000;
const listeners = new Map<ServerEvent, (() => void)[]>();
+function getWebSocketProtocols() {
+ const auth = useAuthContext();
+ if (!auth.attachmentToken) {
+ return undefined;
+ }
+
+ // Browser WebSocket APIs cannot set arbitrary headers, so pass auth in the
+ // subprotocol header and parse it server-side.
+ return ["hb-auth", auth.attachmentToken];
+}
+
+function clearReconnectTimer() {
+ if (reconnectTimer !== null) {
+ clearTimeout(reconnectTimer);
+ reconnectTimer = null;
+ }
+}
+
+function nextReconnectDelay() {
+ const delay = Math.min(RECONNECT_BASE_DELAY_MS * 2 ** reconnectAttempts, RECONNECT_MAX_DELAY_MS);
+ reconnectAttempts += 1;
+ return delay;
+}
+
+function scheduleReconnect(onmessage: (m: EventMessage) => void) {
+ if (reconnectTimer !== null) {
+ return;
+ }
+
+ const delay = nextReconnectDelay();
+ reconnectTimer = setTimeout(() => {
+ reconnectTimer = null;
+ if (!useAuthContext().attachmentToken) {
+ return;
+ }
+ connect(onmessage);
+ }, delay);
+}
+
function connect(onmessage: (m: EventMessage) => void) {
let protocol = "ws";
if (window.location.protocol === "https:") {
@@ -34,17 +78,23 @@ function connect(onmessage: (m: EventMessage) => void) {
url += `?tenant=${currentTenantId}`;
}
- const ws = new WebSocket(url);
+ const protocols = getWebSocketProtocols();
+ if (!protocols) {
+ return;
+ }
+
+ const ws = new WebSocket(url, protocols);
ws.onopen = () => {
+ reconnectAttempts = 0;
+ clearReconnectTimer();
console.debug("connected to server");
};
ws.onclose = () => {
console.debug("disconnected from server");
- setTimeout(() => {
- connect(onmessage);
- }, 3000);
+ socket = null;
+ scheduleReconnect(onmessage);
};
ws.onerror = err => {
@@ -79,21 +129,27 @@ export function onServerEvent(event: ServerEvent, callback: () => void) {
() => prefs.value.collectionId,
newId => {
currentTenantId = newId || null;
+ reconnectAttempts = 0;
+ clearReconnectTimer();
+
if (socket) {
socket.onclose = null;
socket.close();
socket = null;
- connect(e => {
- console.debug("received event", e);
- listeners.get(e.event)?.forEach(c => c());
- });
}
+
+ connect(e => {
+ console.debug("received event", e);
+ listeners.get(e.event)?.forEach(c => c());
+ });
}
);
watcherSetup = true;
}
if (socket === null) {
+ reconnectAttempts = 0;
+ clearReconnectTimer();
connect(e => {
console.debug("received event", e);
listeners.get(e.event)?.forEach(c => c());