The complete open source platform to run your entire marketplace. Storefront, vendor panel, admin console, and integrations in one enterprise-grade platform you own.
TypeScript b2b-marketplacecomposable-commerceecommerceenterpriseheadless-commercemarketplacemedusamedusajsmulti-vendortypescript
fix: permission layer follow-ups for restricted roles (#1597)
Viktor Holik4cd0ecd9b829
diff --git a/integration-tests/http/permissions/admin/permissions.spec.ts b/integration-tests/http/permissions/admin/permissions.spec.tsindex 8783aac89..5f02d6dc9 100644--- a/integration-tests/http/permissions/admin/permissions.spec.ts+++ b/integration-tests/http/permissions/admin/permissions.spec.ts@@ -88,6 +88,31 @@ medusaIntegrationTestRunner({expect(response.data.permission).toEqual("sellers.approval")})+ it("lets any admin read the store but requires store:edit to update it", async () => {+ useResolver({ products: "view" })++ const list = await api.get("/admin/stores", adminHeaders)+ expect(list.status).toEqual(200)++ const storeId = list.data.stores[0].id++ const detail = await api.get(`/admin/stores/${storeId}`, adminHeaders)+ expect(detail.status).toEqual(200)++ const update = await api+ .post(`/admin/stores/${storeId}`, { name: "Renamed" }, adminHeaders)+ .catch((error) => error.response)++ expect(update.status).toEqual(403)+ expect(update.data).toEqual(+ expect.objectContaining({+ code: "MISSING_PERMISSION",+ permission: "store",+ right: "edit",+ })+ )+ })+it("returns permissions on users/me when requested", async () => {useResolver({ users: "view" })diff --git a/packages/admin/src/components/layout/main-layout/main-layout.tsx b/packages/admin/src/components/layout/main-layout/main-layout.tsxindex 450485c41..23f5a251d 100644--- a/packages/admin/src/components/layout/main-layout/main-layout.tsx+++ b/packages/admin/src/components/layout/main-layout/main-layout.tsx@@ -89,7 +89,7 @@ const addNestedItems = (return [...(items ?? []), ...nestedNavItems];};-const MainSidebar = () => {+const useSidebarRoutes = () => {const coreRoutes = useCoreRoutes();const navOverrides = useExtension().getNavOverrides();const { hasAnyPermission, hasAllPermissions, hasPermission } =@@ -135,6 +135,20 @@ const MainSidebar = () => {items: addNestedItems(item.path, visibleMenuItems),}));+ return { routesWithNested, customRoutesWithNested };+};++// First sidebar entry the actor can open, in sidebar order. Falls back to the+// profile page, which needs no permission.+export const useLandingRoute = () => {+ const { routesWithNested, customRoutesWithNested } = useSidebarRoutes();+ const first = [...routesWithNested, ...customRoutesWithNested][0];+ return first?.to ?? "/settings/profile";+};++const MainSidebar = () => {+ const { routesWithNested, customRoutesWithNested } = useSidebarRoutes();+return (<asideclassName="flex flex-1 flex-col justify-between overflow-y-auto overflow-x-hidden"diff --git a/packages/admin/src/pages/home/home.tsx b/packages/admin/src/pages/home/home.tsxindex 8ac29ffc4..455538908 100644--- a/packages/admin/src/pages/home/home.tsx+++ b/packages/admin/src/pages/home/home.tsx@@ -1,12 +1,20 @@import { useEffect } from "react"import { useNavigate } from "react-router-dom"+import { usePermissions } from "@mercurjs/dashboard-shared"++import { useLandingRoute } from "../../components/layout/main-layout/main-layout"export const Home = () => {const navigate = useNavigate()+ const { isLoading } = usePermissions()+ const landing = useLandingRoute()useEffect(() => {- navigate("/orders", { replace: true })- }, [navigate])+ if (isLoading) {+ return+ }+ navigate(landing, { replace: true })+ }, [navigate, landing, isLoading])return <div />}diff --git a/packages/core/src/api/__tests__/route-permissions.unit.spec.ts b/packages/core/src/api/__tests__/route-permissions.unit.spec.tsindex 1ee692ac8..f36929c27 100644--- a/packages/core/src/api/__tests__/route-permissions.unit.spec.ts+++ b/packages/core/src/api/__tests__/route-permissions.unit.spec.ts@@ -159,4 +159,16 @@ describe("route permissions", () => {expect([...new Set(unknown)]).toEqual([])})++ it("lets any admin read the store but gates writes", () => {+ expect(matchCoreRoutePermission("/admin/stores", "GET")).toBeNull()+ expect(matchCoreRoutePermission("/admin/stores/store_1", "GET")).toBeNull()+ expect(matchCoreRoutePermission("/admin/stores/store_1", "POST")).toEqual({+ key: "store",+ right: "edit",+ })+ expect(+ matchCoreRoutePermission("/admin/stores/store_1/locales", "GET")+ ).toEqual({ key: "store", right: "view" })+ })})diff --git a/packages/core/src/api/admin/core-route-permissions.ts b/packages/core/src/api/admin/core-route-permissions.tsindex 02a643b20..bd9ce5e85 100644--- a/packages/core/src/api/admin/core-route-permissions.ts+++ b/packages/core/src/api/admin/core-route-permissions.ts@@ -57,6 +57,8 @@ export const CORE_ROUTE_PERMISSIONS: CoreRoutePermission[] = [{ pattern: /^\/admin\/sales-channels(\/|$)/, key: "sales_channels" },{ pattern: /^\/admin\/return-reasons(\/|$)/, key: "return_reasons" },{ pattern: /^\/admin\/refund-reasons(\/|$)/, key: "refund_reasons" },+ // The shell and most forms read the store (currencies, default region and sales channel).+ { pattern: /^\/admin\/stores(\/[^/]+)?$/, key: "store", methods: { GET: undefined } },{ pattern: /^\/admin\/stores(\/|$)/, key: "store" },{ pattern: /^\/admin\/invites(\/|$)/, key: "users" },{ pattern: /^\/admin\/users\/me$/, key: "users", methods: { GET: undefined } },diff --git a/packages/vendor/src/components/layout/main-layout/main-layout.tsx b/packages/vendor/src/components/layout/main-layout/main-layout.tsxindex e6a7ab489..188698e53 100644--- a/packages/vendor/src/components/layout/main-layout/main-layout.tsx+++ b/packages/vendor/src/components/layout/main-layout/main-layout.tsx@@ -87,7 +87,7 @@ const addNestedItems = (return [...(items ?? []), ...nestedNavItems];};-const MainSidebar = () => {+const useSidebarRoutes = () => {const coreRoutes = useCoreRoutes();const navOverrides = useExtension().getNavOverrides();const { hasAnyPermission, hasAllPermissions, hasPermission } =@@ -136,6 +136,20 @@ const MainSidebar = () => {};});+ return { routesWithNested, customRoutesWithNested };+};++// First sidebar entry the actor can open, in sidebar order. Falls back to the+// profile page, which needs no permission.+export const useLandingRoute = () => {+ const { routesWithNested, customRoutesWithNested } = useSidebarRoutes();+ const first = [...routesWithNested, ...customRoutesWithNested][0];+ return first?.to ?? "/settings/profile";+};++const MainSidebar = () => {+ const { routesWithNested, customRoutesWithNested } = useSidebarRoutes();+return (<aside className="flex flex-1 flex-col justify-between overflow-y-auto overflow-x-hidden"><div className="flex flex-1 flex-col">diff --git a/packages/vendor/src/hooks/api/members.tsx b/packages/vendor/src/hooks/api/members.tsxindex 9e771c548..e97dfa65c 100644--- a/packages/vendor/src/hooks/api/members.tsx+++ b/packages/vendor/src/hooks/api/members.tsx@@ -26,6 +26,17 @@ const withPermissionsField = (fields: unknown) =>.filter(Boolean).join(",");+// Shared by `useMe` and route loaders so every entry under the `me` key holds+// the same shape, including `permissions`.+export const meQueryOptions = (query?: Record<string, unknown>) => ({+ queryFn: () =>+ sdk.vendor.members.me.query({+ ...query,+ fields: withPermissionsField(query?.fields),+ } as Parameters<typeof sdk.vendor.members.me.query>[0]),+ queryKey: query ? [...membersQueryKeys.me(), query] : membersQueryKeys.me(),+});+export const useMe = (query?: Record<string, unknown>,options?: UseQueryOptions<@@ -35,12 +46,7 @@ export const useMe = (>,) => {const { data, ...rest } = useQuery({- queryFn: () =>- sdk.vendor.members.me.query({- ...query,- fields: withPermissionsField(query?.fields),- } as Parameters<typeof sdk.vendor.members.me.query>[0]),- queryKey: query ? [...membersQueryKeys.me(), query] : membersQueryKeys.me(),+ ...meQueryOptions(query),...options,});diff --git a/packages/vendor/src/pages/home/home.tsx b/packages/vendor/src/pages/home/home.tsxindex 8ac29ffc4..455538908 100644--- a/packages/vendor/src/pages/home/home.tsx+++ b/packages/vendor/src/pages/home/home.tsx@@ -1,12 +1,20 @@import { useEffect } from "react"import { useNavigate } from "react-router-dom"+import { usePermissions } from "@mercurjs/dashboard-shared"++import { useLandingRoute } from "../../components/layout/main-layout/main-layout"export const Home = () => {const navigate = useNavigate()+ const { isLoading } = usePermissions()+ const landing = useLandingRoute()useEffect(() => {- navigate("/orders", { replace: true })- }, [navigate])+ if (isLoading) {+ return+ }+ navigate(landing, { replace: true })+ }, [navigate, landing, isLoading])return <div />}diff --git a/packages/vendor/src/pages/settings/store/loader.ts b/packages/vendor/src/pages/settings/store/loader.tsindex add8df64b..d8d43aeab 100644--- a/packages/vendor/src/pages/settings/store/loader.ts+++ b/packages/vendor/src/pages/settings/store/loader.ts@@ -1,17 +1,11 @@import { LoaderFunctionArgs } from "react-router-dom"-import { membersQueryKeys } from "@hooks/api/members"-import { sdk } from "@lib/client"+import { meQueryOptions } from "@hooks/api/members"import { queryClient } from "@lib/query-client"-const meQuery = () => ({- queryKey: membersQueryKeys.me(),- queryFn: async () => sdk.vendor.members.me.query(),-})-export const storeDetailLoader = async (_: LoaderFunctionArgs) => {return queryClient.ensureQueryData({- ...meQuery(),+ ...meQueryOptions(),staleTime: 90000,})}