π OpenHands: AI-Driven Development
fix(frontend): preserve settings page route on browser refresh (org project) (#13462)
Hiep Le5d1f9f815ac3
diff --git a/frontend/__tests__/utils/permission-checks.test.ts b/frontend/__tests__/utils/permission-checks.test.tsindex d4730cb2a7..db5a09951e 100644--- a/frontend/__tests__/utils/permission-checks.test.ts+++ b/frontend/__tests__/utils/permission-checks.test.ts@@ -1,10 +1,18 @@import { describe, expect, it, vi, beforeEach } from "vitest";import { PermissionKey } from "#/utils/org/permissions";+import { OrganizationMember, OrganizationsQueryData } from "#/types/org";+import {+ getAvailableRolesAUserCanAssign,+ getActiveOrganizationUser,+} from "#/utils/org/permission-checks";+import { getSelectedOrganizationIdFromStore } from "#/stores/selected-organization-store";+import { queryClient } from "#/query-client-config";-// Mock dependencies for getActiveOrganizationUser tests+// Mock dependenciesvi.mock("#/api/organization-service/organization-service.api", () => ({organizationService: {getMe: vi.fn(),+ getOrganizations: vi.fn(),},}));@@ -12,49 +20,60 @@ vi.mock("#/stores/selected-organization-store", () => ({getSelectedOrganizationIdFromStore: vi.fn(),}));-vi.mock("#/utils/query-client-getters", () => ({- getMeFromQueryClient: vi.fn(),-}));-vi.mock("#/query-client-config", () => ({queryClient: {+ getQueryData: vi.fn(),+ fetchQuery: vi.fn(),setQueryData: vi.fn(),},}));-// Import after mocks are set up-import {- getAvailableRolesAUserCanAssign,- getActiveOrganizationUser,-} from "#/utils/org/permission-checks";-import { organizationService } from "#/api/organization-service/organization-service.api";-import { getSelectedOrganizationIdFromStore } from "#/stores/selected-organization-store";-import { getMeFromQueryClient } from "#/utils/query-client-getters";+// Test fixtures+const mockUser: OrganizationMember = {+ org_id: "org-1",+ user_id: "user-1",+ email: "[email protected]",+ role: "admin",+ llm_api_key: "",+ max_iterations: 100,+ llm_model: "gpt-4",+ llm_api_key_for_byor: null,+ llm_base_url: "",+ status: "active",+};++const mockOrganizationsData: OrganizationsQueryData = {+ items: [+ { id: "org-1", name: "Org 1" },+ { id: "org-2", name: "Org 2" },+ ] as OrganizationsQueryData["items"],+ currentOrgId: "org-1",+};describe("getAvailableRolesAUserCanAssign", () => {- it("returns empty array if user has no permissions", () => {- const result = getAvailableRolesAUserCanAssign([]);- expect(result).toEqual([]);- });+ it("returns empty array if user has no permissions", () => {+ const result = getAvailableRolesAUserCanAssign([]);+ expect(result).toEqual([]);+ });- it("returns only roles the user has permission for", () => {- const userPermissions: PermissionKey[] = [- "change_user_role:member",- "change_user_role:admin",- ];- const result = getAvailableRolesAUserCanAssign(userPermissions);- expect(result.sort()).toEqual(["admin", "member"].sort());- });+ it("returns only roles the user has permission for", () => {+ const userPermissions: PermissionKey[] = [+ "change_user_role:member",+ "change_user_role:admin",+ ];+ const result = getAvailableRolesAUserCanAssign(userPermissions);+ expect(result.sort()).toEqual(["admin", "member"].sort());+ });- it("returns all roles if user has all permissions", () => {- const allPermissions: PermissionKey[] = [- "change_user_role:member",- "change_user_role:admin",- "change_user_role:owner",- ];- const result = getAvailableRolesAUserCanAssign(allPermissions);- expect(result.sort()).toEqual(["member", "admin", "owner"].sort());- });+ it("returns all roles if user has all permissions", () => {+ const allPermissions: PermissionKey[] = [+ "change_user_role:member",+ "change_user_role:admin",+ "change_user_role:owner",+ ];+ const result = getAvailableRolesAUserCanAssign(allPermissions);+ expect(result.sort()).toEqual(["member", "admin", "owner"].sort());+ });});describe("getActiveOrganizationUser", () => {@@ -62,18 +81,147 @@ describe("getActiveOrganizationUser", () => {vi.clearAllMocks();});- it("should return undefined when API call throws an error", async () => {- // Arrange: orgId exists, cache is empty, API call fails- vi.mocked(getSelectedOrganizationIdFromStore).mockReturnValue("org-1");- vi.mocked(getMeFromQueryClient).mockReturnValue(undefined);- vi.mocked(organizationService.getMe).mockRejectedValue(- new Error("Network error"),- );+ describe("when orgId exists in store", () => {+ it("should fetch user directly using stored orgId", async () => {+ // Arrange+ vi.mocked(getSelectedOrganizationIdFromStore).mockReturnValue("org-1");+ vi.mocked(queryClient.fetchQuery).mockResolvedValue(mockUser);++ // Act+ const result = await getActiveOrganizationUser();++ // Assert+ expect(result).toEqual(mockUser);+ expect(queryClient.getQueryData).not.toHaveBeenCalled();+ expect(queryClient.fetchQuery).toHaveBeenCalledWith(+ expect.objectContaining({+ queryKey: ["organizations", "org-1", "me"],+ }),+ );+ });++ it("should return undefined when user fetch fails", async () => {+ // Arrange+ vi.mocked(getSelectedOrganizationIdFromStore).mockReturnValue("org-1");+ vi.mocked(queryClient.fetchQuery).mockRejectedValue(+ new Error("Network error"),+ );- // Act- const result = await getActiveOrganizationUser();+ // Act+ const result = await getActiveOrganizationUser();- // Assert: should return undefined instead of propagating the error- expect(result).toBeUndefined();+ // Assert+ expect(result).toBeUndefined();+ });+ });++ describe("when orgId is null in store (page refresh scenario)", () => {+ beforeEach(() => {+ vi.mocked(getSelectedOrganizationIdFromStore).mockReturnValue(null);+ });++ it("should use currentOrgId from cached organizations data", async () => {+ // Arrange+ vi.mocked(queryClient.getQueryData).mockReturnValue(+ mockOrganizationsData,+ );+ vi.mocked(queryClient.fetchQuery).mockResolvedValue(mockUser);++ // Act+ const result = await getActiveOrganizationUser();++ // Assert+ expect(result).toEqual(mockUser);+ expect(queryClient.getQueryData).toHaveBeenCalledWith(["organizations"]);+ expect(queryClient.fetchQuery).toHaveBeenCalledWith(+ expect.objectContaining({+ queryKey: ["organizations", "org-1", "me"],+ }),+ );+ });++ it("should fallback to first org when currentOrgId is null", async () => {+ // Arrange+ const dataWithoutCurrentOrg: OrganizationsQueryData = {+ items: [+ { id: "first-org" },+ { id: "second-org" },+ ] as OrganizationsQueryData["items"],+ currentOrgId: null,+ };+ vi.mocked(queryClient.getQueryData).mockReturnValue(+ dataWithoutCurrentOrg,+ );+ vi.mocked(queryClient.fetchQuery).mockResolvedValue(mockUser);++ // Act+ const result = await getActiveOrganizationUser();++ // Assert+ expect(result).toEqual(mockUser);+ expect(queryClient.fetchQuery).toHaveBeenCalledWith(+ expect.objectContaining({+ queryKey: ["organizations", "first-org", "me"],+ }),+ );+ });++ it("should fetch organizations when not in cache", async () => {+ // Arrange+ vi.mocked(queryClient.getQueryData).mockReturnValue(undefined);+ vi.mocked(queryClient.fetchQuery)+ .mockResolvedValueOnce(mockOrganizationsData) // First call: fetch organizations+ .mockResolvedValueOnce(mockUser); // Second call: fetch user++ // Act+ const result = await getActiveOrganizationUser();++ // Assert+ expect(result).toEqual(mockUser);+ expect(queryClient.fetchQuery).toHaveBeenCalledTimes(2);+ expect(queryClient.fetchQuery).toHaveBeenNthCalledWith(+ 1,+ expect.objectContaining({+ queryKey: ["organizations"],+ }),+ );+ expect(queryClient.fetchQuery).toHaveBeenNthCalledWith(+ 2,+ expect.objectContaining({+ queryKey: ["organizations", "org-1", "me"],+ }),+ );+ });++ it("should return undefined when fetching organizations fails", async () => {+ // Arrange+ vi.mocked(queryClient.getQueryData).mockReturnValue(undefined);+ vi.mocked(queryClient.fetchQuery).mockRejectedValue(+ new Error("Failed to fetch organizations"),+ );++ // Act+ const result = await getActiveOrganizationUser();++ // Assert+ expect(result).toBeUndefined();+ });++ it("should return undefined when no organizations exist", async () => {+ // Arrange+ const emptyData: OrganizationsQueryData = {+ items: [],+ currentOrgId: null,+ };+ vi.mocked(queryClient.getQueryData).mockReturnValue(emptyData);++ // Act+ const result = await getActiveOrganizationUser();++ // Assert+ expect(result).toBeUndefined();+ // Should not attempt to fetch user since there's no orgId+ expect(queryClient.fetchQuery).not.toHaveBeenCalled();+ });});});diff --git a/frontend/src/types/org.ts b/frontend/src/types/org.tsindex a527d49c47..a7b83c1092 100644--- a/frontend/src/types/org.ts+++ b/frontend/src/types/org.ts@@ -56,3 +56,12 @@ export interface OrganizationMembersPage {export type UpdateOrganizationMemberParams = Partial<Omit<OrganizationMember, "org_id" | "user_id">>;++/**+ * Query data structure for the organizations query.+ * This represents the raw data returned by queryClient before any `select` transform.+ */+export type OrganizationsQueryData = {+ items: Organization[];+ currentOrgId: string | null;+};diff --git a/frontend/src/utils/org/permission-checks.ts b/frontend/src/utils/org/permission-checks.tsindex 5bf9db857e..4b439af6d8 100644--- a/frontend/src/utils/org/permission-checks.ts+++ b/frontend/src/utils/org/permission-checks.ts@@ -1,6 +1,10 @@import { organizationService } from "#/api/organization-service/organization-service.api";import { getSelectedOrganizationIdFromStore } from "#/stores/selected-organization-store";-import { OrganizationMember, OrganizationUserRole } from "#/types/org";+import {+ OrganizationMember,+ OrganizationsQueryData,+ OrganizationUserRole,+} from "#/types/org";import { PermissionKey } from "./permissions";import { queryClient } from "#/query-client-config";@@ -8,12 +12,45 @@ import { queryClient } from "#/query-client-config";* Get the active organization user.* Uses React Query's fetchQuery to leverage request deduplication,* preventing duplicate API calls when multiple consumers request the same data.+ *+ * On page refresh, the Zustand store resets and orgId becomes null.+ * In this case, we retrieve the organization from the query cache or fetch it+ * from the backend to ensure permission checks work correctly.+ ** @returns OrganizationMember*/export const getActiveOrganizationUser = async (): Promise<OrganizationMember | undefined> => {- const orgId = getSelectedOrganizationIdFromStore();+ let orgId = getSelectedOrganizationIdFromStore();++ // If no orgId in store (e.g., after page refresh), try to get it from query cache or fetch+ if (!orgId) {+ // Check if organizations data is already in the cache+ let organizationsData = queryClient.getQueryData<OrganizationsQueryData>([+ "organizations",+ ]);++ // If not in cache, fetch it+ if (!organizationsData) {+ try {+ organizationsData = await queryClient.fetchQuery({+ queryKey: ["organizations"],+ queryFn: organizationService.getOrganizations,+ staleTime: 1000 * 60 * 5, // 5 minutes - matches useOrganizations hook+ });+ } catch {+ return undefined;+ }+ }++ // Use currentOrgId from backend (user's last selected org) or first org as fallback+ orgId =+ organizationsData?.currentOrgId ??+ organizationsData?.items?.[0]?.id ??+ null;+ }+if (!orgId) return undefined;try {