Harden GitHub query cache validation and cleanup

Author: stylessh

apps/dashboard/src/lib/query-client.tsx

@@ -20,7 +20,7 @@ type PersistedGitHubQueryCache = {
 type PersistBehavior = true | "tab";
 
 type PersistableGitHubQuery = {
-	state: { status: string };
+	state: { data?: unknown; status: string };
 	meta?: Record<string, unknown>;
 	queryKey: readonly unknown[];
 };
@@ -88,6 +88,10 @@ function shouldPersistGitHubQuery(query: PersistableGitHubQuery) {
 		return false;
 	}
 
+	if (query.state.data == null) {
+		return false;
+	}
+
 	if (persist === true) {
 		return true;
 	}
@@ -108,6 +112,13 @@ function pruneClosedTabQueries(queryClient: QueryClient, tabs: Tab[]) {
 	});
 }
 
+function pruneNullGitHubQueries(queryClient: QueryClient) {
+	queryClient.removeQueries({
+		predicate: (query) =>
+			query.queryKey[0] === "github" && query.state.data == null,
+	});
+}
+
 function usePruneClosedTabQueries(queryClient: QueryClient) {
 	const tabs = useTabs();
 	const tabsRef = useRef(tabs);
@@ -143,6 +154,7 @@ function restorePersistedGitHubQueryCache(queryClient: QueryClient) {
 		}
 
 		hydrate(queryClient, persistedState.clientState);
+		pruneNullGitHubQueries(queryClient);
 	} catch {
 		window.localStorage.removeItem(GITHUB_QUERY_CACHE_STORAGE_KEY);
 	}

apps/dashboard/src/routes/_protected/$owner/$repo/issues.$issueId.tsx

@@ -16,9 +16,15 @@ export const Route = createFileRoute(
 		});
 
 		const cachedData = context.queryClient.getQueryData(pageOptions.queryKey);
-		if (cachedData !== undefined) {
+		if (cachedData !== null && cachedData !== undefined) {
 			return cachedData;
 		}
+		if (cachedData === null) {
+			context.queryClient.removeQueries({
+				queryKey: pageOptions.queryKey,
+				exact: true,
+			});
+		}
 
 		return context.queryClient.ensureQueryData(pageOptions);
 	},

apps/dashboard/src/routes/_protected/$owner/$repo/pull.$pullId.tsx

@@ -17,10 +17,16 @@ export const Route = createFileRoute("/_protected/$owner/$repo/pull/$pullId")({
 		});
 
 		const cachedData = context.queryClient.getQueryData(pageOptions.queryKey);
-		if (cachedData !== undefined) {
+		if (cachedData?.detail) {
 			void context.queryClient.ensureQueryData(githubViewerQueryOptions(scope));
 			return cachedData;
 		}
+		if (cachedData !== undefined) {
+			context.queryClient.removeQueries({
+				queryKey: pageOptions.queryKey,
+				exact: true,
+			});
+		}
 
 		const [pageData] = await Promise.all([
 			context.queryClient.ensureQueryData(pageOptions),

apps/dashboard/src/routes/_protected/$owner/$repo/review.$pullId.tsx

@@ -22,12 +22,19 @@ export const Route = createFileRoute("/_protected/$owner/$repo/review/$pullId")(
 				input,
 			);
 
-			const cachedPageData = context.queryClient.getQueryData(
+			let cachedPageData = context.queryClient.getQueryData(
 				pageOptions.queryKey,
 			);
 			const cachedFileSummaries = context.queryClient.getQueryData(
 				fileSummariesOptions.queryKey,
 			);
+			if (cachedPageData !== undefined && !cachedPageData?.detail) {
+				context.queryClient.removeQueries({
+					queryKey: pageOptions.queryKey,
+					exact: true,
+				});
+				cachedPageData = undefined;
+			}
 
 			// Check if infinite query already has data
 			const filesQueryKey = githubQueryKeys.pulls.files(scope, input);

paseo.json

@@ -0,0 +1,11 @@
+{
+  "worktree": {
+    "setup": [
+      "pnpm i && cd apps/dashboard && yes | node ../../scripts/run-d1-migrations.mjs diffkit-db --local; exit 0"
+    ],
+    "teardown": [
+      "rm -rf \"$PASEO_WORKTREE_PATH/node_modules\" \"$PASEO_WORKTREE_PATH/apps/*/node_modules\" \"$PASEO_WORKTREE_PATH/packages/*/node_modules\"",
+      "if [ -n \"$PASEO_WORKTREE_PORT\" ]; then lsof -ti :$PASEO_WORKTREE_PORT | xargs -r kill -9; fi"
+    ]
+  }
+}