Skip to content

Commit fa4f3a2

Browse files
saphidgithub-actions[bot]maria-rcks
authored
fix(mobile): stop refreshes in hidden PR Guide panes (#25486)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: maria-rcks <[email protected]>
1 parent cb5fac9 commit fa4f3a2

4 files changed

Lines changed: 137 additions & 14 deletions

File tree

‎apps/mobile/src/features/pull-requests/PullRequestRouteScreen.tsx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,12 @@ export function PullRequestRouteScreen({ route }: StaticScreenProps<PullRequestP
794794
</View>
795795
</View>
796796
) : null}
797-
{tab === "guide" ? <PullRequestGuideContent params={params} /> : null}
797+
{tab === "guide" ? (
798+
<PullRequestGuideContent
799+
params={params}
800+
visible={section === "guide"}
801+
/>
802+
) : null}
798803
{tab === "activity" ? (
799804
<PullRequestActivityFilters
800805
value={activityFilter}

‎apps/mobile/src/features/pull-requests/guide/PullRequestGuideScreen.tsx‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,15 @@ const attentionLabels = {
4848
accessibility: "An accessibility call",
4949
};
5050

51-
export function PullRequestGuideContent({ params }: { readonly params: PullRequestParams }) {
51+
export function PullRequestGuideContent({
52+
params,
53+
visible = true,
54+
}: {
55+
readonly params: PullRequestParams;
56+
readonly visible?: boolean;
57+
}) {
5258
const navigation = useNavigation();
53-
const state = useReviewGuide(params);
59+
const state = useReviewGuide(params, visible);
5460
const { guide, stale } = reviewGuideState(state.data);
5561
return (
5662
<Animated.View layout={PR_ROW_LAYOUT} className="w-full max-w-[760px] self-center">

‎apps/mobile/src/features/pull-requests/guide/useReviewGuide.test.tsx‎

Lines changed: 121 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@ import {
33
type NavigationProp,
44
type ParamListBase,
55
} from "@react-navigation/native";
6-
import { act } from "react";
6+
import { AsyncResult } from "effect/reactivity";
7+
import { act, useLayoutEffect } from "react";
78
import { createRoot } from "react-dom/client";
89
import { expect, it, vi } from "vite-plus/test";
910

1011
const mocks = vi.hoisted(() => ({
12+
enabled: true,
13+
generate: vi.fn(),
1114
query: {
12-
data: null as { run: { _tag: "Running" | "Completed" } } | null,
15+
data: null as { run: { _tag: "Running" | "Completed" | "Failed" } | null } | null,
1316
isPending: false,
1417
refresh: vi.fn<() => void>(),
1518
},
1619
otherQuery: {
17-
data: null as { run: { _tag: "Running" | "Completed" } } | null,
20+
data: null as { run: { _tag: "Running" | "Completed" | "Failed" } | null } | null,
1821
isPending: false,
1922
refresh: vi.fn<() => void>(),
2023
},
@@ -33,7 +36,8 @@ vi.mock("@react-navigation/native", async () => {
3336
return { NavigationContext, useFocusEffect };
3437
});
3538
vi.mock("@effect/atom-react", () => ({
36-
useAtomValue: (atom: unknown) => (atom === "settings" ? { reviewGuidesEnabled: true } : true),
39+
useAtomValue: (atom: unknown) =>
40+
atom === "settings" ? { reviewGuidesEnabled: mocks.enabled } : true,
3741
}));
3842
vi.mock("../../../state/server", () => ({
3943
serverEnvironment: { settingsValueAtom: () => "settings" },
@@ -48,7 +52,7 @@ vi.mock("../../../state/pull-requests", () => ({
4852
vi.mock("../../../state/query", () => ({
4953
useEnvironmentQuery: (number: number) => ({ ...(number === 1 ? mocks.query : mocks.otherQuery) }),
5054
}));
51-
vi.mock("../../../state/use-atom-command", () => ({ useAtomCommand: () => vi.fn() }));
55+
vi.mock("../../../state/use-atom-command", () => ({ useAtomCommand: () => mocks.generate }));
5256
vi.mock("../usePullRequestConnected", () => ({ usePullRequestConnected: () => true }));
5357
vi.mock("../usePullRequestDiff", () => ({
5458
pullRequestTarget: (params: unknown) => params,
@@ -78,6 +82,8 @@ function createNavigation() {
7882

7983
function setup() {
8084
(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
85+
mocks.enabled = true;
86+
mocks.generate = vi.fn().mockResolvedValue(AsyncResult.success(undefined));
8187
mocks.query = { data: null, isPending: false, refresh: vi.fn() };
8288
mocks.otherQuery = { data: null, isPending: false, refresh: vi.fn() };
8389
const root = createRoot(document.createElement("div"));
@@ -88,20 +94,35 @@ function setup() {
8894
repository: "repo",
8995
number: 1,
9096
};
91-
function Probe({ number, environmentId }: { number: number; environmentId: string }) {
92-
useReviewGuide({ ...params, number, environmentId });
97+
let current: ReturnType<typeof useReviewGuide>;
98+
function Probe({
99+
number,
100+
environmentId,
101+
visible,
102+
}: {
103+
number: number;
104+
environmentId: string;
105+
visible?: boolean;
106+
}) {
107+
const state = useReviewGuide({ ...params, number, environmentId }, visible);
108+
useLayoutEffect(() => {
109+
current = state;
110+
});
93111
return null;
94112
}
95113
return {
96-
render(number = 1, environmentId = params.environmentId) {
114+
render(number = 1, environmentId = params.environmentId, visible?: boolean) {
97115
act(() =>
98116
root.render(
99117
<NavigationContext.Provider value={navigation.value}>
100-
<Probe number={number} environmentId={environmentId} />
118+
<Probe number={number} environmentId={environmentId} visible={visible} />
101119
</NavigationContext.Provider>,
102120
),
103121
);
104122
},
123+
get current() {
124+
return current;
125+
},
105126
focus: navigation.focus,
106127
[Symbol.dispose]() {
107128
act(() => root.unmount());
@@ -188,3 +209,94 @@ it("retires the old environment's polling on target change and clears polling on
188209
expect(mocks.otherQuery.refresh).toHaveBeenCalledTimes(2);
189210
expect(vi.getTimerCount()).toBe(0);
190211
});
212+
213+
it("suspends only manual refresh while hidden, including focus and target changes", () => {
214+
vi.useFakeTimers();
215+
using _timers = { [Symbol.dispose]: () => vi.useRealTimers() };
216+
{
217+
using screen = setup();
218+
mocks.query.data = { run: { _tag: "Running" } };
219+
mocks.otherQuery.data = { run: { _tag: "Running" } };
220+
screen.render();
221+
const cached = screen.current.data;
222+
screen.render(1, "environment", false);
223+
act(() => vi.advanceTimersByTime(60_000));
224+
expect(mocks.query.refresh).toHaveBeenCalledTimes(1);
225+
expect(screen.current.data).toBe(cached);
226+
screen.render();
227+
expect(mocks.query.refresh).toHaveBeenCalledTimes(2);
228+
act(() => vi.advanceTimersByTime(5_000));
229+
expect(mocks.query.refresh).toHaveBeenCalledTimes(3);
230+
screen.render(1, "environment", false);
231+
screen.focus(false);
232+
screen.focus(true);
233+
expect(mocks.query.refresh).toHaveBeenCalledTimes(3);
234+
235+
screen.render(2, "other-environment", false);
236+
act(() => vi.advanceTimersByTime(5_000));
237+
expect(mocks.otherQuery.refresh).not.toHaveBeenCalled();
238+
screen.focus(false);
239+
screen.render(2, "other-environment", true);
240+
expect(mocks.otherQuery.refresh).not.toHaveBeenCalled();
241+
screen.focus(true);
242+
expect(mocks.otherQuery.refresh).toHaveBeenCalledTimes(1);
243+
act(() => vi.advanceTimersByTime(5_000));
244+
expect(mocks.otherQuery.refresh).toHaveBeenCalledTimes(2);
245+
expect(mocks.query.refresh).toHaveBeenCalledTimes(3);
246+
}
247+
expect(vi.getTimerCount()).toBe(0);
248+
});
249+
250+
it("keeps disabled, completed and failed guides idle and refreshes once on reveal", () => {
251+
vi.useFakeTimers();
252+
using _timers = { [Symbol.dispose]: () => vi.useRealTimers() };
253+
using screen = setup();
254+
mocks.enabled = false;
255+
screen.render();
256+
act(() => vi.advanceTimersByTime(5_000));
257+
expect(mocks.query.refresh).not.toHaveBeenCalled();
258+
mocks.enabled = true;
259+
mocks.query.data = { run: null };
260+
screen.render();
261+
expect(mocks.query.refresh).toHaveBeenCalledTimes(1);
262+
act(() => vi.advanceTimersByTime(10_000));
263+
expect(mocks.query.refresh).toHaveBeenCalledTimes(1);
264+
screen.render(1, "environment", false);
265+
mocks.query.data = { run: { _tag: "Failed" } };
266+
screen.render(1, "environment", false);
267+
expect(mocks.query.refresh).toHaveBeenCalledTimes(1);
268+
screen.render();
269+
expect(mocks.query.refresh).toHaveBeenCalledTimes(2);
270+
act(() => vi.advanceTimersByTime(10_000));
271+
expect(mocks.query.refresh).toHaveBeenCalledTimes(2);
272+
expect(vi.getTimerCount()).toBe(0);
273+
});
274+
275+
it("leaves generation running when hidden and accepts its completion without a refresh", async () => {
276+
vi.useFakeTimers();
277+
using _timers = { [Symbol.dispose]: () => vi.useRealTimers() };
278+
using screen = setup();
279+
const generated = Promise.withResolvers<ReturnType<typeof AsyncResult.success<void>>>();
280+
mocks.generate.mockReturnValue(generated.promise);
281+
screen.render();
282+
let writing: Promise<void>;
283+
act(() => {
284+
writing = screen.current.write();
285+
});
286+
expect(screen.current.running).toBe(true);
287+
screen.render(1, "environment", false);
288+
const beforeHidden = mocks.query.refresh.mock.calls.length;
289+
act(() => vi.advanceTimersByTime(60_000));
290+
expect(mocks.query.refresh).toHaveBeenCalledTimes(beforeHidden);
291+
expect(mocks.generate).toHaveBeenCalledTimes(1);
292+
expect(screen.current.running).toBe(true);
293+
await act(async () => {
294+
generated.resolve(AsyncResult.success(undefined));
295+
await writing;
296+
});
297+
expect(screen.current.running).toBe(false);
298+
expect(mocks.query.refresh).toHaveBeenCalledTimes(beforeHidden);
299+
screen.render();
300+
expect(mocks.query.refresh).toHaveBeenCalledTimes(beforeHidden + 1);
301+
expect(vi.getTimerCount()).toBe(0);
302+
});

‎apps/mobile/src/features/pull-requests/guide/useReviewGuide.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export function useReviewGuidesEnabled(params: PullRequestParams) {
1717
return settings?.reviewGuidesEnabled === true;
1818
}
1919

20-
export function useReviewGuide(params: PullRequestParams) {
20+
export function useReviewGuide(params: PullRequestParams, visible = true) {
2121
const target = pullRequestTarget(params);
2222
const enabled = useReviewGuidesEnabled(params);
2323
const query = useEnvironmentQuery(enabled ? composerPullRequests.reviewGuide(target) : null);
@@ -35,7 +35,7 @@ export function useReviewGuide(params: PullRequestParams) {
3535
const running = starting || query.data?.run?._tag === "Running";
3636
const refresh = query.refresh;
3737
useFocusEffect(() => {
38-
if (!enabled) return;
38+
if (!enabled || !visible) return;
3939
refresh();
4040
if (!running) return;
4141
const timer = setInterval(refresh, 5_000);

0 commit comments

Comments
 (0)