Skip to content

A full-featured CRM built with React, shadcn/ui, and Supabase.

Leverage canAccess for access control

React-Admin CI66355263dd4e
diff --git a/src/layout/Header.tsx b/src/layout/Header.tsx
index fc9af8ba..8f299cfc 100644
--- a/src/layout/Header.tsx
+++ b/src/layout/Header.tsx
@@ -12,9 +12,9 @@ import {
Typography,
} from '@mui/material';
import {
+ CanAccess,
LoadingIndicator,
Logout,
- usePermissions,
UserMenu,
useUserMenu,
} from 'react-admin';
@@ -24,7 +24,6 @@ import { useConfigurationContext } from '../root/ConfigurationContext';
const Header = () => {
const { logo, title } = useConfigurationContext();
const location = useLocation();
- const { permissions } = usePermissions();
let currentPath: string | boolean = '/';
if (!!matchPath('/', location.pathname)) {
@@ -102,7 +101,9 @@ const Header = () => {
<LoadingIndicator />
<UserMenu>
<ConfigurationMenu />
- {permissions === 'admin' && <UsersMenu />}
+ <CanAccess resource="sales" action="list">
+ <UsersMenu />
+ </CanAccess>
<Logout />
</UserMenu>
</Box>
diff --git a/src/login/SignupPage.tsx b/src/login/SignupPage.tsx
index ddfd7544..62b6ecc7 100644
--- a/src/login/SignupPage.tsx
+++ b/src/login/SignupPage.tsx
@@ -6,13 +6,8 @@ import {
TextField,
Typography,
} from '@mui/material';
-import { useMutation, useQuery } from '@tanstack/react-query';
-import {
- useDataProvider,
- useLogin,
- useNotify,
- usePermissions,
-} from 'react-admin';
+import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
+import { useDataProvider, useLogin, useNotify } from 'react-admin';
import { SubmitHandler, useForm } from 'react-hook-form';
import { Navigate } from 'react-router';
import { CrmDataProvider } from '../providers/types';
@@ -21,7 +16,7 @@ import { SignUpData } from '../types';
import { LoginSkeleton } from './LoginSkeleton';
export const SignupPage = () => {
- const { refetch } = usePermissions();
+ const queryClient = useQueryClient();
const dataProvider = useDataProvider<CrmDataProvider>();
const { logo, title } = useConfigurationContext();
const { data: isInitialized, isPending } = useQuery({
@@ -43,7 +38,10 @@ export const SignupPage = () => {
redirectTo: '/contacts',
}).then(() => {
notify('Initial user successfully created');
- refetch();
+ // FIXME: We should probably provide a hook for that in the ra-core package
+ queryClient.invalidateQueries({
+ queryKey: ['auth', 'canAccess'],
+ });
});
},
onError: () => {
diff --git a/src/providers/commons/canAccess.ts b/src/providers/commons/canAccess.ts
new file mode 100644
index 00000000..70685843
--- /dev/null
+++ b/src/providers/commons/canAccess.ts
@@ -0,0 +1,26 @@
+// FIXME: This should be exported from the ra-core package
+type CanAccessParams<
+ RecordType extends Record<string, any> = Record<string, any>,
+> = {
+ action: string;
+ resource: string;
+ record?: RecordType;
+};
+
+export const canAccess = <
+ RecordType extends Record<string, any> = Record<string, any>,
+>(
+ role: string,
+ params: CanAccessParams<RecordType>
+) => {
+ if (role === 'admin') {
+ return true;
+ }
+
+ // Non admins can't access the sales resource
+ if (params.resource === 'sales') {
+ return false;
+ }
+
+ return true;
+};
diff --git a/src/providers/fakerest/authProvider.ts b/src/providers/fakerest/authProvider.ts
index e665fb84..ddc6f3cf 100644
--- a/src/providers/fakerest/authProvider.ts
+++ b/src/providers/fakerest/authProvider.ts
@@ -1,6 +1,7 @@
import { AuthProvider } from 'react-admin';
import { Sale } from '../../types';
import { dataProvider } from './dataProvider';
+import { canAccess } from '../commons/canAccess';
export const DEFAULT_USER = {
id: 0,
@@ -50,19 +51,21 @@ export const authProvider: AuthProvider = {
localStorage.getItem(USER_STORAGE_KEY)
? Promise.resolve()
: Promise.reject(),
- getPermissions: async () => {
+ canAccess: async ({ signal, ...params }) => {
+ // Get the current user
const userItem = localStorage.getItem(USER_STORAGE_KEY);
const localUser = userItem ? (JSON.parse(userItem) as Sale) : null;
- if (!localUser) {
- return Promise.reject('user is not logged in');
- }
+ if (!localUser) return false;
- // We fetch permissions from server to avoid local storage tampering
- const user = await dataProvider.getOne<Sale>('sales', {
+ // Get the matching sale
+ const { data } = await dataProvider.getOne<Sale>('sales', {
id: localUser.id,
});
+ if (!data) return false;
- return user.data?.administrator ? 'admin' : 'user';
+ // Compute access rights from the sale role
+ const role = data.administrator ? 'admin' : 'user';
+ return canAccess(role, params);
},
getIdentity: () => {
const userItem = localStorage.getItem(USER_STORAGE_KEY);
diff --git a/src/providers/supabase/authProvider.ts b/src/providers/supabase/authProvider.ts
index 7d546bda..2f147ae6 100644
--- a/src/providers/supabase/authProvider.ts
+++ b/src/providers/supabase/authProvider.ts
@@ -1,6 +1,7 @@
import { supabaseAuthProvider } from 'ra-supabase';
import { AuthProvider } from 'react-admin';
import { supabase } from './supabase';
+import { canAccess } from '../commons/canAccess';
const baseAuthProvider = supabaseAuthProvider(supabase, {
getIdentity: async user => {
@@ -20,20 +21,12 @@ const baseAuthProvider = supabaseAuthProvider(supabase, {
avatar: data.avatar?.src,
};
},
- getPermissions: async user => {
- const { data, error } = await supabase
- .from('sales')
- .select('administrator')
- .match({ user_id: user.id })
- .single();
-
- if (!data || error) {
- return null;
- }
-
- return data?.administrator ? 'admin' : 'user';
- },
});
+// FIXME: Now that react-admin pessimistically calls getPermissions, it calls getPermissions when it initializes its routes
+// However, getPermissions will currently fails if not signed in and that triggers a rerender of the signup page which clears
+// all current inputs.
+// The solution is to remove getPermissions from the authProvider as we now use canAccess.
+delete baseAuthProvider.getPermissions;
export async function getIsInitialized() {
if (getIsInitialized._is_initialized_cache == null) {
@@ -90,10 +83,26 @@ export const authProvider: AuthProvider = {
return baseAuthProvider.checkAuth(params);
},
- async getPermissions(params) {
+ // FIXME: supabaseAuthProvider does not yet provide canAccess
+ canAccess: async params => {
const isInitialized = await getIsInitialized();
- return isInitialized && baseAuthProvider.getPermissions
- ? baseAuthProvider.getPermissions(params)
- : null;
+ if (!isInitialized) return false;
+
+ // Get the current user
+ const { data: dataSession, error: errorSession } =
+ await supabase.auth.getSession();
+ if (!dataSession.session?.user || errorSession) return false;
+
+ // Get the matching sale
+ const { data: dataSale, error: errorSale } = await supabase
+ .from('sales')
+ .select('administrator')
+ .match({ user_id: dataSession.session.user.id })
+ .single();
+ if (!dataSale || errorSale) return false;
+
+ // Compute access rights from the sale role
+ const role = dataSale.administrator ? 'admin' : 'user';
+ return canAccess(role, params);
},
};
diff --git a/src/sales/SalesCreate.tsx b/src/sales/SalesCreate.tsx
index 42b66644..4216a094 100644
--- a/src/sales/SalesCreate.tsx
+++ b/src/sales/SalesCreate.tsx
@@ -4,17 +4,14 @@ import {
SimpleForm,
useDataProvider,
useNotify,
- usePermissions,
useRedirect,
} from 'react-admin';
import { SubmitHandler } from 'react-hook-form';
-import { Navigate } from 'react-router';
import { CrmDataProvider } from '../providers/types';
import { SalesFormData } from '../types';
import { SalesInputs } from './SalesInputs';
export function SalesCreate() {
- const { isPending, permissions } = usePermissions();
const dataProvider = useDataProvider<CrmDataProvider>();
const notify = useNotify();
const redirect = useRedirect();
@@ -40,14 +37,6 @@ export function SalesCreate() {
mutate(data);
};
- if (isPending) {
- return null;
- }
-
- if (permissions !== 'admin') {
- return <Navigate to="/" />;
- }
-
return (
<Container maxWidth="sm" sx={{ mt: 4 }}>
<Card>
diff --git a/src/sales/SalesEdit.tsx b/src/sales/SalesEdit.tsx
index a0e845de..c3f5a0a8 100644
--- a/src/sales/SalesEdit.tsx
+++ b/src/sales/SalesEdit.tsx
@@ -7,12 +7,10 @@ import {
useDataProvider,
useEditController,
useNotify,
- usePermissions,
useRecordContext,
useRedirect,
} from 'react-admin';
import { SubmitHandler } from 'react-hook-form';
-import { Navigate } from 'react-router';
import { CrmDataProvider } from '../providers/types';
import { Sale, SalesFormData } from '../types';
import { SalesInputs } from './SalesInputs';
@@ -26,8 +24,6 @@ function EditToolbar() {
}
export function SalesEdit() {
- const { isPending, permissions } = usePermissions();
-
const { record } = useEditController();
const dataProvider = useDataProvider<CrmDataProvider>();
@@ -54,14 +50,6 @@ export function SalesEdit() {
mutate(data);
};
- if (isPending) {
- return null;
- }
-
- if (permissions !== 'admin') {
- return <Navigate to="/" />;
- }
-
return (
<Container maxWidth="sm" sx={{ mt: 4 }}>
<Card>
diff --git a/src/sales/SalesList.tsx b/src/sales/SalesList.tsx
index c1ab0909..ca26e41a 100644
--- a/src/sales/SalesList.tsx
+++ b/src/sales/SalesList.tsx
@@ -7,10 +7,8 @@ import {
SearchInput,
TextField,
TopToolbar,
- usePermissions,
useRecordContext,
} from 'react-admin';
-import { Navigate } from 'react-router';
const SalesListActions = () => (
<TopToolbar>
@@ -47,15 +45,6 @@ const OptionsField = (_props: { label?: string | boolean }) => {
};
export function SalesList() {
- const { isPending, permissions } = usePermissions();
- if (isPending) {
- return null;
- }
-
- if (permissions !== 'admin') {
- return <Navigate to="/" />;
- }
-
return (
<Stack gap={4}>
<List