Skip to content
Open
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
30 changes: 17 additions & 13 deletions src/hooks/useCapabilities.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { useCallback } from 'react';
import { useQuery } from '@tanstack/react-query';
import { getRouteApi } from '@tanstack/react-router';
import { queryOptions, useQuery } from '@tanstack/react-query';
import type * as t from '@/types';
import { getEffectiveCapabilitiesFn } from '@/server';
import { hasImpliedCapability } from '@/constants';

Expand All @@ -11,26 +12,20 @@ const GRANTS_UNAVAILABLE_PATTERN = /\b(404|503)\b|endpoint not found|fetch faile
const AUTH_DENIED_PATTERN =
/\b(401|403)\b|forbidden|unauthorized|authentication required|no admin session token/i;

export function useCapabilities(): {
capabilities: string[];
hasCapability: (cap: string) => boolean;
isLoading: boolean;
isError: boolean;
} {
const { user } = Route.useRouteContext();
const query = useQuery({
queryKey: ['effectiveCapabilities', user?.id ?? ''],
queryFn: async () => {
export const capabilitiesQueryOptions = (userId: string) =>
queryOptions({
queryKey: ['effectiveCapabilities', userId],
queryFn: async (): Promise<t.CapabilitiesData> => {
try {
const res = await getEffectiveCapabilitiesFn();
return { available: true, capabilities: res.capabilities };
} catch (err) {
const message = err instanceof Error ? err.message : String(err);
if (GRANTS_UNAVAILABLE_PATTERN.test(message)) {
return { available: false, capabilities: [] as string[] };
return { available: false, capabilities: [] };
}
if (AUTH_DENIED_PATTERN.test(message)) {
return { available: true, capabilities: [] as string[] };
return { available: true, capabilities: [] };
}
throw err;
}
Expand All @@ -39,6 +34,15 @@ export function useCapabilities(): {
retry: false,
});

export function useCapabilities(): {
capabilities: string[];
hasCapability: (cap: string) => boolean;
isLoading: boolean;
isError: boolean;
} {
const { user } = Route.useRouteContext();
const query = useQuery(capabilitiesQueryOptions(user?.id ?? ''));

const grantsAvailable = query.data?.available ?? false;
const capabilities = query.data?.capabilities ?? [];

Expand Down
5 changes: 3 additions & 2 deletions src/routes/__root.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ import {
Outlet,
ScriptOnce,
Scripts,
createRootRoute,
createRootRouteWithContext,
} from '@tanstack/react-router';
import type { ErrorComponentProps } from '@tanstack/react-router';
import type { QueryClient } from '@tanstack/react-query';
import { ThemeProvider, useTheme } from '../contexts/ThemeContext';
import appCss from '../styles.css?url';
import { useLocalize } from '@/hooks';
Expand All @@ -24,7 +25,7 @@ const themeScript = `(function(){
} catch(e) {}
})();`;

export const Route = createRootRoute({
export const Route = createRootRouteWithContext<{ queryClient: QueryClient }>()({
ssr: false,
head: () => ({
meta: [
Expand Down
26 changes: 19 additions & 7 deletions src/routes/_app.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
import { useState, useEffect } from 'react';
import { Icon } from '@clickhouse/click-ui';
import { useSuspenseQuery } from '@tanstack/react-query';
import { createFileRoute, Outlet, useRouter, Link, redirect } from '@tanstack/react-router';
import type { ErrorComponentProps } from '@tanstack/react-router';
import { useCapabilities, useCommandMenu, useLocalize } from '@/hooks';
import { capabilitiesQueryOptions, useCommandMenu, useLocalize } from '@/hooks';
import { verifyAdminTokenFn } from '@/server';
import { SystemCapabilities, hasImpliedCapability } from '@/constants';
import { AccessDenied, LoadingState } from '@/components/shared';
import { CommandMenu } from '@/components/CommandMenu';
import { AccessDenied } from '@/components/shared';
import { SystemCapabilities } from '@/constants';
import { Sidebar } from '@/components/Sidebar';
import { verifyAdminTokenFn } from '@/server';
import { Header } from '@/components/Header';

const ROUTE_TITLE_KEYS: Record<string, string> = {
Expand All @@ -19,7 +20,6 @@ const ROUTE_TITLE_KEYS: Record<string, string> = {
'/help': 'com_help_title',
};


export const Route = createFileRoute('/_app')({
beforeLoad: async ({ location }) => {
const result = await verifyAdminTokenFn();
Expand All @@ -33,14 +33,26 @@ export const Route = createFileRoute('/_app')({

return { user: result.user };
},
loader: async ({ context }) => {
await context.queryClient.ensureQueryData(capabilitiesQueryOptions(context.user.id));
},
pendingComponent: AppPending,
component: AppLayout,
errorComponent: AppError,
notFoundComponent: AppNotFound,
});

function AppPending() {
return (
<div className="flex h-screen items-center justify-center">
<LoadingState />
</div>
);
}

function AppLayout() {
const { user } = Route.useRouteContext();
const { hasCapability, isLoading, isError } = useCapabilities();
const { available, capabilities } = useSuspenseQuery(capabilitiesQueryOptions(user.id)).data;
const router = useRouter();
const localize = useLocalize();
const { open, setOpen } = useCommandMenu();
Expand Down Expand Up @@ -68,7 +80,7 @@ function AppLayout() {
return () => document.removeEventListener('keydown', handleKeyDown);
}, []);

if (!isLoading && !isError && !hasCapability(SystemCapabilities.ACCESS_ADMIN)) {
if (!available || !hasImpliedCapability(capabilities, SystemCapabilities.ACCESS_ADMIN)) {
return <AccessDenied />;
}

Expand Down
7 changes: 0 additions & 7 deletions src/server/capabilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,6 @@ export async function requireAllSectionCapabilities(sections: string[]): Promise
}
}

export const effectiveCapabilitiesOptions = (userId: string) =>
queryOptions<string[]>({
queryKey: ['effectiveCapabilities', userId],
queryFn: () => getEffectiveCapabilitiesFn().then((r) => r.capabilities),
staleTime: 30_000,
});

// ── Mutations ────────────────────────────────────────────────────────

export const grantCapabilityFn = createServerFn({ method: 'POST' })
Expand Down
5 changes: 5 additions & 0 deletions src/types/hooks.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ export type LocalizeFn = (key: string, options?: Record<string, string | number>

export type TranslationKeys = string;

export interface CapabilitiesData {
available: boolean;
capabilities: string[];
}

export interface UseProfileMutationsOptions {
fieldPath: string;
onProfileChange?: () => void;
Expand Down