Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CRDCDH-2102 fix: The useProfileFields hook should utilize PBAC #577

Merged
merged 1 commit into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions src/hooks/useProfileFields.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,23 @@ describe("Users View", () => {
jest.clearAllMocks();
});

it("should return UNLOCKED for role and userStatus when viewing users as an Admin", () => {
const user = { _id: "User-A", role: "Admin" } as User;
const profileOf: Pick<User, "_id" | "role"> = { _id: "I-Am-User-B", role: "Submitter" };
// NOTE: This is mostly a sanity check to ensure we're ignoring the signed-in user's role
it.each<UserRole>(["Admin", "Data Commons Personnel", "Federal Lead", "Submitter", "User"])(
"should return UNLOCKED for role, status, and PBAC when viewing users with management permission (%s)",
(role) => {
const user = { _id: "User-A", role, permissions: ["user:manage"] } as User;
const profileOf: Pick<User, "_id" | "role"> = { _id: "I-Am-User-B", role: "Submitter" };

jest.spyOn(Auth, "useAuthContext").mockReturnValue({ user } as Auth.ContextState);
jest.spyOn(Auth, "useAuthContext").mockReturnValue({ user } as Auth.ContextState);

const { result } = renderHook(() => useProfileFields(profileOf, "users"));
const { result } = renderHook(() => useProfileFields(profileOf, "users"));

expect(result.current.role).toBe("UNLOCKED");
expect(result.current.userStatus).toBe("UNLOCKED");
expect(result.current.permissions).toBe("UNLOCKED");
expect(result.current.notifications).toBe("UNLOCKED");
});
expect(result.current.role).toBe("UNLOCKED");
expect(result.current.userStatus).toBe("UNLOCKED");
expect(result.current.permissions).toBe("UNLOCKED");
expect(result.current.notifications).toBe("UNLOCKED");
}
);

it("should return READ_ONLY for all standard fields when a Submitter views the page", () => {
const user = { _id: "User-A", role: "Submitter" } as User;
Expand All @@ -44,7 +48,7 @@ describe("Users View", () => {
["UNLOCKED", "Federal Lead"],
["UNLOCKED", "Submitter"],
])("should return %s for the studies field on the users page for role %s", (state, role) => {
const user = { _id: "User-A", role: "Admin" } as User;
const user = { _id: "User-A", role: "Admin", permissions: ["user:manage"] } as User;
const profileOf: Pick<User, "_id" | "role"> = { _id: "I-Am-User-B", role };

jest.spyOn(Auth, "useAuthContext").mockReturnValue({ user } as Auth.ContextState);
Expand All @@ -63,7 +67,7 @@ describe("Users View", () => {
["HIDDEN", "fake role" as UserRole],
["UNLOCKED", "Data Commons Personnel"], // NOTE: accepts Data Commons
])("should return %s for the dataCommons field on the users page for role %s", (state, role) => {
const user = { _id: "User-A", role: "Admin" } as User;
const user = { _id: "User-A", role: "Admin", permissions: ["user:manage"] } as User;
const profileOf: Pick<User, "_id" | "role"> = { _id: "I-Am-User-B", role };

jest.spyOn(Auth, "useAuthContext").mockReturnValue({ user } as Auth.ContextState);
Expand Down
12 changes: 8 additions & 4 deletions src/hooks/useProfileFields.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { useAuthContext } from "../components/Contexts/AuthContext";
import { hasPermission } from "../config/AuthPermissions";
import { RequiresStudiesAssigned } from "../config/AuthRoles";

/**
* Constrains the fields that this hook supports generating states for
*/
Expand Down Expand Up @@ -47,6 +49,9 @@ const useProfileFields = (
viewType: "users" | "profile"
): Readonly<Partial<ProfileFields>> => {
const { user } = useAuthContext();
const canManage = hasPermission(user, "user", "manage");

const isSelf: boolean = user?._id === profileOf?._id;
const fields: ProfileFields = {
firstName: "READ_ONLY",
lastName: "READ_ONLY",
Expand All @@ -57,16 +62,15 @@ const useProfileFields = (
permissions: "HIDDEN",
notifications: "HIDDEN",
};
const isSelf: boolean = user?._id === profileOf?._id;

// Editable for the current user viewing their own profile
if (isSelf && viewType === "profile") {
fields.firstName = "UNLOCKED";
fields.lastName = "UNLOCKED";
}

// Editable for Admin viewing Manage Users
if (user?.role === "Admin" && viewType === "users") {
// Editable for user with permission to Manage Users
if (canManage && viewType === "users") {
fields.role = "UNLOCKED";
fields.userStatus = "UNLOCKED";
fields.permissions = "UNLOCKED";
Expand All @@ -78,7 +82,7 @@ const useProfileFields = (

// Only applies to Data Commons Personnel
if (profileOf?.role === "Data Commons Personnel") {
fields.dataCommons = user?.role === "Admin" && viewType === "users" ? "UNLOCKED" : "READ_ONLY";
fields.dataCommons = canManage && viewType === "users" ? "UNLOCKED" : "READ_ONLY";
} else {
fields.dataCommons = "HIDDEN";
}
Expand Down
Loading