Skip to content

SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.

feat(authz): add frontend support for telemetry resources (#12292)

Vikrant Guptae62bfb4a4c84
diff --git a/cmd/authz.go b/cmd/authz.go
index a2c0abff3b..c17137841c 100644
--- a/cmd/authz.go
+++ b/cmd/authz.go
@@ -93,9 +93,13 @@ func runGenerateAuthz(_ context.Context) error {
registry := coretypes.NewRegistry()
allowedResources := map[string]bool{
- coretypes.NewResourceRef(coretypes.ResourceServiceAccount).String(): true,
- coretypes.NewResourceRef(coretypes.ResourceRole).String(): true,
- coretypes.NewResourceRef(coretypes.ResourceMetaResourceFactorAPIKey).String(): true,
+ coretypes.NewResourceRef(coretypes.ResourceServiceAccount).String(): true,
+ coretypes.NewResourceRef(coretypes.ResourceRole).String(): true,
+ coretypes.NewResourceRef(coretypes.ResourceMetaResourceFactorAPIKey).String(): true,
+ coretypes.NewResourceRef(coretypes.ResourceTelemetryResourceLogs).String(): true,
+ coretypes.NewResourceRef(coretypes.ResourceTelemetryResourceTraces).String(): true,
+ coretypes.NewResourceRef(coretypes.ResourceTelemetryResourceMetrics).String(): true,
+ coretypes.NewResourceRef(coretypes.ResourceTelemetryResourceMeterMetrics).String(): true,
}
allowedTypes := map[string]bool{}
diff --git a/frontend/src/AppRoutes/Private.tsx b/frontend/src/AppRoutes/Private.tsx
index b1775d1810..5680915f7c 100644
--- a/frontend/src/AppRoutes/Private.tsx
+++ b/frontend/src/AppRoutes/Private.tsx
@@ -14,7 +14,10 @@ import { useAppContext } from 'providers/App/App';
import { LicensePlatform, LicenseState } from 'types/api/licensesV3/getActive';
import { OrgPreference } from 'types/api/preferences/preference';
import { USER_ROLES } from 'types/roles';
-import { routePermission } from 'utils/permission';
+import {
+ routePermission,
+ routeWithInitialAuthZSupport,
+} from 'utils/permission';
import routes, {
LIST_LICENSES,
@@ -42,7 +45,6 @@ function PrivateRoute({ children }: PrivateRouteProps): JSX.Element {
const isAdmin = user.role === USER_ROLES.ADMIN;
const isAIAssistantEnabled = useIsAIAssistantEnabled();
const isAIObservabilityEnabled = useIsAIObservabilityEnabled();
-
const mapRoutes = useMemo(
() =>
new Map(
@@ -226,7 +228,16 @@ function PrivateRoute({ children }: PrivateRouteProps): JSX.Element {
if (isPrivate) {
if (isLoggedInState) {
const route = routePermission[key];
- if (route && route.find((e) => e === user.role) === undefined) {
+ const hasInitialAuthZSupport = Object.hasOwn(
+ routeWithInitialAuthZSupport,
+ key,
+ );
+
+ if (
+ route &&
+ route.find((e) => e === user.role) === undefined &&
+ hasInitialAuthZSupport === false
+ ) {
return <Redirect to={ROUTES.UN_AUTHORIZED} />;
}
} else {
diff --git a/frontend/src/AppRoutes/__tests__/Private.test.tsx b/frontend/src/AppRoutes/__tests__/Private.test.tsx
index 9d356b4041..8656794f05 100644
--- a/frontend/src/AppRoutes/__tests__/Private.test.tsx
+++ b/frontend/src/AppRoutes/__tests__/Private.test.tsx
@@ -17,6 +17,7 @@ import {
} from 'types/api/licensesV3/getActive';
import { OrgPreference } from 'types/api/preferences/preference';
import { ROLES, USER_ROLES } from 'types/roles';
+import { routeWithInitialAuthZSupport } from 'utils/permission';
import PrivateRoute from '../Private';
@@ -178,6 +179,7 @@ function createMockAppContext(
isFetchingHosts: false,
isFetchingFeatureFlags: false,
isFetchingOrgPreferences: false,
+ isFetchingUserPreferences: false,
userFetchError: null,
activeLicenseFetchError: null,
hostsFetchError: null,
@@ -198,24 +200,39 @@ function createMockAppContext(
};
}
+// Roles that no authz-aware route grants through the legacy routePermission table
+const DENIED_ROLES: ROLES[] = [
+ USER_ROLES.ANONYMOUS as ROLES,
+ USER_ROLES.AUTHOR as ROLES,
+];
+
+const PERMITTED_ROLES: ROLES[] = [
+ USER_ROLES.ADMIN as ROLES,
+ USER_ROLES.EDITOR as ROLES,
+ USER_ROLES.VIEWER as ROLES,
+];
+
+interface AuthzRouteCase {
+ path: string;
+ deniedRoles: ROLES[];
+}
+
interface RenderPrivateRouteOptions {
initialRoute?: string;
appContext?: Partial<IAppContext>;
isCloudUser?: boolean;
}
-function renderPrivateRoute(options: RenderPrivateRouteOptions = {}): void {
- const {
- initialRoute = ROUTES.HOME,
- appContext = {},
- isCloudUser = true,
- } = options;
+function buildPrivateRouteTree(
+ options: RenderPrivateRouteOptions,
+): ReactElement {
+ const { initialRoute = ROUTES.HOME, appContext = {} } = options;
- mockIsCloudUser = isCloudUser;
-
- const contextValue = createMockAppContext(appContext);
+ const contextValue = createMockAppContext({
+ ...appContext,
+ });
- render(
+ return (
<QueryClientProvider client={queryClient}>
<MemoryRouter initialEntries={[initialRoute]}>
<AppContext.Provider value={contextValue}>
@@ -229,10 +246,15 @@ function renderPrivateRoute(options: RenderPrivateRouteOptions = {}): void {
</PrivateRoute>
</AppContext.Provider>
</MemoryRouter>
- </QueryClientProvider>,
+ </QueryClientProvider>
);
}
+function renderPrivateRoute(options: RenderPrivateRouteOptions = {}): void {
+ mockIsCloudUser = options.isCloudUser ?? true;
+ render(buildPrivateRouteTree(options));
+}
+
// Generic assertion helpers for navigation behavior
// Using location-based assertions since Private.tsx now uses Redirect component
@@ -1432,6 +1454,25 @@ describe('PrivateRoute', () => {
assertStaysOnRoute(ROUTES.GET_STARTED_WITH_CLOUD);
});
+
+ it.each([...PERMITTED_ROLES, ...DENIED_ROLES])(
+ 'should render the unauthorized page for a %s instead of bouncing off it',
+ (role) => {
+ // routePermission.UN_AUTHORIZED must grant every role: a role denied here
+ // is redirected to /un-authorized and then redirected away from it again,
+ // which loops until React bails out with a blank screen.
+ renderPrivateRoute({
+ initialRoute: ROUTES.UN_AUTHORIZED,
+ appContext: {
+ isLoggedIn: true,
+ user: createMockUser({ role }),
+ },
+ });
+
+ assertStaysOnRoute(ROUTES.UN_AUTHORIZED);
+ assertRendersChildren();
+ },
+ );
});
describe('Edge Cases', () => {
@@ -1477,6 +1518,174 @@ describe('PrivateRoute', () => {
});
});
+ describe('AuthZ Support (routeWithInitialAuthZSupport)', () => {
+ // Routes in routeWithInitialAuthZSupport always bypass legacy role check
+ const AUTHZ_ROUTE_CASES: Record<
+ keyof typeof routeWithInitialAuthZSupport,
+ AuthzRouteCase
+ > = {
+ // Everything under /settings resolves to the non-exact SETTINGS route
+ SETTINGS: { path: ROUTES.SETTINGS, deniedRoles: DENIED_ROLES },
+ MY_SETTINGS: { path: ROUTES.MY_SETTINGS, deniedRoles: DENIED_ROLES },
+ ROLES_SETTINGS: { path: ROUTES.ROLES_SETTINGS, deniedRoles: DENIED_ROLES },
+ ROLE_CREATE: { path: ROUTES.ROLE_CREATE, deniedRoles: DENIED_ROLES },
+ ROLE_DETAILS: {
+ path: ROUTES.ROLE_DETAILS.replace(':roleId', 'role-id-1'),
+ deniedRoles: DENIED_ROLES,
+ },
+ ROLE_EDIT: {
+ path: ROUTES.ROLE_EDIT.replace(':roleId', 'role-id-1'),
+ deniedRoles: DENIED_ROLES,
+ },
+ SERVICE_ACCOUNTS_SETTINGS: {
+ path: ROUTES.SERVICE_ACCOUNTS_SETTINGS,
+ deniedRoles: DENIED_ROLES,
+ },
+ TRACES_EXPLORER: { path: ROUTES.TRACES_EXPLORER, deniedRoles: DENIED_ROLES },
+ TRACE: { path: ROUTES.TRACE, deniedRoles: DENIED_ROLES },
+ TRACE_DETAIL: {
+ path: ROUTES.TRACE_DETAIL.replace(':id', 'trace-id-1'),
+ deniedRoles: DENIED_ROLES,
+ },
+ TRACE_DETAIL_OLD: {
+ path: ROUTES.TRACE_DETAIL_OLD.replace(':id', 'trace-id-1'),
+ deniedRoles: DENIED_ROLES,
+ },
+ // LOGS and LOGS_EXPLORER share a path - matchPath resolves it to whichever
+ // route definition comes last, and both keys are authz-aware either way.
+ LOGS: { path: ROUTES.LOGS, deniedRoles: DENIED_ROLES },
+ LOGS_EXPLORER: { path: ROUTES.LOGS_EXPLORER, deniedRoles: DENIED_ROLES },
+ LIVE_LOGS: { path: ROUTES.LIVE_LOGS, deniedRoles: DENIED_ROLES },
+ OLD_LOGS_EXPLORER: {
+ path: ROUTES.OLD_LOGS_EXPLORER,
+ deniedRoles: DENIED_ROLES,
+ },
+ METRICS_EXPLORER: {
+ path: ROUTES.METRICS_EXPLORER,
+ deniedRoles: DENIED_ROLES,
+ },
+ METRICS_EXPLORER_EXPLORER: {
+ path: ROUTES.METRICS_EXPLORER_EXPLORER,
+ deniedRoles: DENIED_ROLES,
+ },
+ METRICS_EXPLORER_VOLUME_CONTROL: {
+ path: ROUTES.METRICS_EXPLORER_VOLUME_CONTROL,
+ deniedRoles: DENIED_ROLES,
+ },
+ METER: { path: ROUTES.METER, deniedRoles: DENIED_ROLES },
+ METER_EXPLORER: { path: ROUTES.METER_EXPLORER, deniedRoles: DENIED_ROLES },
+ // SUPPORT already grants ANONYMOUS in routePermission, so only AUTHOR
+ // exercises the redirect branch here.
+ SUPPORT: {
+ path: ROUTES.SUPPORT,
+ deniedRoles: [USER_ROLES.AUTHOR as ROLES],
+ },
+ };
+
+ const authzRouteRolePairs: [string, string, ROLES][] = Object.entries(
+ AUTHZ_ROUTE_CASES,
+ ).flatMap(([name, { path, deniedRoles }]) =>
+ deniedRoles.map((role): [string, string, ROLES] => [name, path, role]),
+ );
+
+ // Routes with no authz check - legacy role check still applies
+ const NON_AUTHZ_ROUTE_CASES: [string, string, ROLES][] = [
+ ['ALERTS_NEW', ROUTES.ALERTS_NEW, USER_ROLES.VIEWER as ROLES],
+ ['LIST_LICENSES', ROUTES.LIST_LICENSES, USER_ROLES.EDITOR as ROLES],
+ ['ONBOARDING', ROUTES.ONBOARDING, USER_ROLES.VIEWER as ROLES],
+ ['APPLICATION', ROUTES.APPLICATION, USER_ROLES.ANONYMOUS as ROLES],
+ [
+ 'METRICS_EXPLORER_VIEWS',
+ ROUTES.METRICS_EXPLORER_VIEWS,
+ USER_ROLES.ANONYMOUS as ROLES,
+ ],
+ ];
+
+ it.each(authzRouteRolePairs)(
+ 'should not redirect %s (%s) for role %s - authz routes bypass legacy role check',
+ (_name, path, role) => {
+ // Routes in routeWithInitialAuthZSupport always bypass the legacy role check.
+ // Authorization is handled by downstream components via fine-grained authz.
+ renderPrivateRoute({
+ initialRoute: path,
+ appContext: {
+ isLoggedIn: true,
+ user: createMockUser({ role }),
+ },
+ });
+
+ assertStaysOnRoute(path);
+ assertRendersChildren();
+ },
+ );
+
+ it.each([...PERMITTED_ROLES, ...DENIED_ROLES])(
+ 'should not redirect a %s from an authz-aware route',
+ (role) => {
+ // All roles pass through - authorization handled downstream
+ renderPrivateRoute({
+ initialRoute: ROUTES.LOGS_EXPLORER,
+ appContext: {
+ isLoggedIn: true,
+ user: createMockUser({ role }),
+ },
+ });
+
+ assertStaysOnRoute(ROUTES.LOGS_EXPLORER);
+ assertRendersChildren();
+ },
+ );
+
+ it.each(NON_AUTHZ_ROUTE_CASES)(
+ 'should redirect %s (%s) for role %s - non-authz routes use legacy role check',
+ async (_name, path, role) => {
+ // Routes NOT in routeWithInitialAuthZSupport still use legacy role check
+ renderPrivateRoute({
+ initialRoute: path,
+ appContext: {
+ isLoggedIn: true,
+ user: createMockUser({ role }),
+ },
+ });
+
+ await assertRedirectsTo(ROUTES.UN_AUTHORIZED);
+ },
+ );
+
+ it.each(authzRouteRolePairs)(
+ 'should still redirect unauthenticated users away from %s (%s) with role %s',
+ async (_name, path, role) => {
+ // The authz bypass only relaxes the role check, never the login check.
+ renderPrivateRoute({
+ initialRoute: path,
+ appContext: {
+ isLoggedIn: false,
+ user: createMockUser({ role }),
+ },
+ });
+
+ await assertRedirectsTo(ROUTES.LOGIN);
+ },
+ );
+
+ it('should still redirect to workspace locked from an authz-aware route', async () => {
+ // Workspace guards run before the role check and must not be bypassed.
+ renderPrivateRoute({
+ initialRoute: ROUTES.LOGS_EXPLORER,
+ appContext: {
+ isLoggedIn: true,
+ isFetchingActiveLicense: false,
+ activeLicense: createMockLicense({ platform: LicensePlatform.CLOUD }),
+ trialInfo: createMockTrialInfo({ workSpaceBlock: true }),
+ user: createMockUser({ role: USER_ROLES.VIEWER as ROLES }),
+ },
+ isCloudUser: true,
+ });
+
+ await assertRedirectsTo(ROUTES.WORKSPACE_LOCKED);
+ });
+ });
+
describe('Old channel route redirects', () => {
it.each([
['/settings/channels', '/alerts', 'tab=Channels'],
diff --git a/frontend/src/container/AppLayout/index.tsx b/frontend/src/container/AppLayout/index.tsx
index 75c792a69a..3b293e8863 100644
--- a/frontend/src/container/AppLayout/index.tsx
+++ b/frontend/src/container/AppLayout/index.tsx
@@ -104,6 +104,7 @@ function AppLayout(props: AppLayoutProps): JSX.Element {
isFetchingFeatureFlags,
featureFlagsFetchError,
userPreferences,
+ isFetchingUserPreferences,
updateChangelog,
toggleChangelogModal,
showChangelogModal,
@@ -724,12 +725,12 @@ function AppLayout(props: AppLayoutProps): JSX.Element {
}
}, []);
- // Set sidebar as loaded after user preferences are fetched
+ // Set sidebar as loaded after user preferences fetch completes (success or error)
useEffect(() => {
- if (userPreferences !== null) {
+ if (!isFetchingUserPreferences) {
setIsSidebarLoaded(true);
}
- }, [userPreferences]);
+ }, [isFetchingUserPreferences]);
// Use localStorage value as fallback until preferences are loaded
const isSideNavPinned = isSidebarLoaded
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/JsonEditor.test.tsx b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/JsonEditor.test.tsx
index 59fb80daa7..02edf36400 100644
--- a/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/JsonEditor.test.tsx
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/JsonEditor.test.tsx
@@ -151,7 +151,9 @@ describe('JsonEditor', () => {
);
await user.click(await within(readToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'test-key-123{enter}');
await switchToJsonMode();
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/PermissionEditor.test.tsx b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/PermissionEditor.test.tsx
index 14caf99f35..0b7f082c3c 100644
--- a/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/PermissionEditor.test.tsx
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/PermissionEditor.test.tsx
@@ -1,17 +1,8 @@
-import { Route, Switch } from 'react-router-dom';
-import ROUTES from 'constants/routes';
import { server } from 'mocks-server/server';
-import { render, screen, userEvent, waitFor, within } from 'tests/test-utils';
+import { screen, userEvent, waitFor, within } from 'tests/test-utils';
import { setupAuthzAdmin } from 'lib/authz/utils/authz-test-utils';
-import { TooltipProvider } from '@signozhq/ui/tooltip';
-import CreateEditRolePage from '../CreateEditRolePage';
-
-async function expandAllCards(): Promise<void> {
- const user = userEvent.setup();
- const expandButton = await screen.findByTestId('expand-all-button');
- await user.click(expandButton);
-}
+import { expandAllCards, renderCreateRolePage } from './testUtils';
beforeEach(() => {
server.use(setupAuthzAdmin());
@@ -21,35 +12,16 @@ afterEach(() => {
server.resetHandlers();
});
-async function renderPage(): Promise<ReturnType<typeof render>> {
- const result = render(
- <TooltipProvider>
- <Switch>
- <Route path={ROUTES.ROLES_SETTINGS} exact>
- <div data-testid="roles-list-redirect" />
- </Route>
- <Route path={ROUTES.ROLE_CREATE}>
- <CreateEditRolePage />
- </Route>
- </Switch>
- </TooltipProvider>,
- undefined,
- { initialRoute: '/settings/roles/new' },
- );
- await screen.findByTestId('permission-editor');
- return result;
-}
-
describe('PermissionEditor', () => {
describe('mode toggle', () => {
it('renders permission editor with testId', async () => {
- await renderPage();
+ await renderCreateRolePage();
expect(screen.getByTestId('permission-editor')).toBeInTheDocument();
});
it('defaults to interactive mode', async () => {
- await renderPage();
+ await renderCreateRolePage();
const interactiveRadio = screen.getByTestId(
'permission-editor-mode-interactive',
@@ -59,7 +31,7 @@ describe('PermissionEditor', () => {
it('switches to JSON mode when clicked', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
const jsonRadio = screen.getByTestId('permission-editor-mode-json');
await user.click(jsonRadio);
@@ -70,7 +42,7 @@ describe('PermissionEditor', () => {
it('switches back to interactive mode', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
const jsonRadio = screen.getByTestId('permission-editor-mode-json');
await user.click(jsonRadio);
@@ -87,7 +59,7 @@ describe('PermissionEditor', () => {
describe('resource cards', () => {
it('renders all resource cards', async () => {
- await renderPage();
+ await renderCreateRolePage();
expect(
screen.getByTestId('resource-card-factor-api-key'),
@@ -99,7 +71,7 @@ describe('PermissionEditor', () => {
});
it('resource cards are collapsed by default', async () => {
- await renderPage();
+ await renderCreateRolePage();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
const header = within(apiKeyCard).getByTestId(
@@ -111,7 +83,7 @@ describe('PermissionEditor', () => {
it('expands resource card when header clicked', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
const header = within(apiKeyCard).getByTestId(
@@ -125,7 +97,7 @@ describe('PermissionEditor', () => {
it('collapses expanded resource card when header clicked again', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
const header = within(apiKeyCard).getByTestId(
@@ -139,7 +111,7 @@ describe('PermissionEditor', () => {
});
it('shows granted count in resource card header', async () => {
- await renderPage();
+ await renderCreateRolePage();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
await expect(
@@ -150,7 +122,7 @@ describe('PermissionEditor', () => {
describe('action toggles', () => {
it('renders action toggles for each available action', async () => {
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -169,7 +141,7 @@ describe('PermissionEditor', () => {
});
it('defaults all actions to None scope', async () => {
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -187,7 +159,7 @@ describe('PermissionEditor', () => {
it('changes scope to All when clicked', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -208,7 +180,7 @@ describe('PermissionEditor', () => {
it('updates granted count when scope changed', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -227,7 +199,7 @@ describe('PermissionEditor', () => {
describe('Only Selected scope', () => {
it('shows item input selector when Only Selected is chosen', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -239,12 +211,14 @@ describe('PermissionEditor', () => {
await within(createToggle).findByText('Only selected');
await user.click(onlySelectedBtn);
- expect(screen.getByTestId('item-input-selector')).toBeInTheDocument();
+ expect(
+ screen.getByTestId('item-input-selector-factor-api-key-read'),
+ ).toBeInTheDocument();
});
it('adds item when typed and Enter pressed', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -254,7 +228,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'api-key-001{enter}');
await expect(screen.findByText('api-key-001')).resolves.toBeInTheDocument();
@@ -262,7 +238,7 @@ describe('PermissionEditor', () => {
it('adds item when Add button clicked', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -272,10 +248,14 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'api-key-002');
- const addBtn = screen.getByTestId('item-input-selector-add-btn');
+ const addBtn = screen.getByTestId(
+ 'item-input-selector-add-btn-factor-api-key-read',
+ );
await user.click(addBtn);
await expect(screen.findByText('api-key-002')).resolves.toBeInTheDocument();
@@ -283,7 +263,7 @@ describe('PermissionEditor', () => {
it('adds multiple items separated by comma', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -293,7 +273,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'key-a, key-b, key-c{enter}');
await expect(screen.findByText('key-a')).resolves.toBeInTheDocument();
@@ -303,7 +285,7 @@ describe('PermissionEditor', () => {
it('adds multiple items separated by space', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -313,7 +295,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'key-x key-y key-z{enter}');
await expect(screen.findByText('key-x')).resolves.toBeInTheDocument();
@@ -323,7 +307,7 @@ describe('PermissionEditor', () => {
it('does not add duplicate items', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -333,7 +317,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'same-key{enter}');
await user.type(input, 'same-key{enter}');
@@ -343,7 +329,7 @@ describe('PermissionEditor', () => {
it('removes item when X clicked', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -353,20 +339,138 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'removable-key{enter}');
- const removeBtn = screen.getByRole('button', {
- name: /remove removable-key/i,
+ const badge = await screen.findByTestId('item-badge-factor-api-key-read-0');
+ const removeBtn = within(badge).getByRole('button', {
+ name: 'Remove removable-key',
});
await user.click(removeBtn);
expect(screen.queryByText('removable-key')).not.toBeInTheDocument();
});
+ it('names each badge close button after the item it removes', async () => {
+ const user = userEvent.setup();
+ await renderCreateRolePage();
+ await expandAllCards();
+
+ const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
+ const readToggle = within(apiKeyCard).getByTestId(
+ 'action-toggle-factor-api-key-read',
+ );
+ await user.click(await within(readToggle).findByText('Only selected'));
+
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
+ await user.type(input, 'key-one key-two{enter}');
+
+ const firstBadge = await screen.findByTestId(
+ 'item-badge-factor-api-key-read-0',
+ );
+ const secondBadge = screen.getByTestId('item-badge-factor-api-key-read-1');
+
+ expect(
+ within(firstBadge).getByRole('button', { name: 'Remove key-one' }),
+ ).toBeInTheDocument();
+ expect(
+ within(secondBadge).getByRole('button', { name: 'Remove key-two' }),
+ ).toBeInTheDocument();
+ });
+
+ it('exposes the full item value as a title so truncated badges stay readable', async () => {
+ const user = userEvent.setup();
+ await renderCreateRolePage();
+ await expandAllCards();
+
+ const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
+ const readToggle = within(apiKeyCard).getByTestId(
+ 'action-toggle-factor-api-key-read',
+ );
+ await user.click(await within(readToggle).findByText('Only selected'));
+
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
+ await user.type(input, 'a-very-long-api-key-identifier-000001{enter}');
+
+ const badge = await screen.findByTestId('item-badge-factor-api-key-read-0');
+ expect(
+ within(badge).getByTitle('a-very-long-api-key-identifier-000001'),
+ ).toBeInTheDocument();
+ });
+
+ it('moves focus to the previous badge when closed with the keyboard', async () => {
+ const user = userEvent.setup();
+ await renderCreateRolePage();
+ await expandAllCards();
+
+ const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
+ const readToggle = within(apiKeyCard).getByTestId(
+ 'action-toggle-factor-api-key-read',
+ );
+ await user.click(await within(readToggle).findByText('Only selected'));
+
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
+ await user.type(input, 'key-one key-two{enter}');
+
+ const secondBadge = await screen.findByTestId(
+ 'item-badge-factor-api-key-read-1',
+ );
+ within(secondBadge).getByRole('button', { name: 'Remove key-two' }).focus();
+
+ await user.keyboard('{Enter}');
+
+ await waitFor(() => {
+ const firstBadge = screen.getByTestId('item-badge-factor-api-key-read-0');
+ expect(
+ within(firstBadge).getByRole('button', { name: 'Remove key-one' }),
+ ).toHaveFocus();
+ });
+ });
+
+ it('does not steal focus when a badge is closed with the mouse', async () => {
+ const user = userEvent.setup();
+ await renderCreateRolePage();
+ await expandAllCards();
+
+ const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
+ const readToggle = within(apiKeyCard).getByTestId(
+ 'action-toggle-factor-api-key-read',
+ );
+ await user.click(await within(readToggle).findByText('Only selected'));
+
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
+ await user.type(input, 'key-one key-two{enter}');
+
+ const secondBadge = await screen.findByTestId(
+ 'item-badge-factor-api-key-read-1',
+ );
+ await user.click(
+ within(secondBadge).getByRole('button', { name: 'Remove key-two' }),
+ );
+
+ await waitFor(() => {
+ expect(screen.queryByText('key-two')).not.toBeInTheDocument();
+ });
+
+ const firstBadge = screen.getByTestId('item-badge-factor-api-key-read-0');
+ expect(
+ within(firstBadge).getByRole('button', { name: 'Remove key-one' }),
+ ).not.toHaveFocus();
+ });
+
it('shows Add button disabled when input is empty', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -376,7 +480,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const addBtn = screen.getByTestId('item-input-selector-add-btn');
+ const addBtn = screen.getByTestId(
+ 'item-input-selector-add-btn-factor-api-key-read',
+ );
expect(addBtn).toBeDisabled();
});
});
@@ -384,7 +490,7 @@ describe('PermissionEditor', () => {
describe('scope change confirmation dialog', () => {
it('shows confirm dialog when leaving Only Selected with items', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -394,7 +500,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'will-be-cleared{enter}');
await user.click(await within(createToggle).findByText('All'));
@@ -406,7 +514,7 @@ describe('PermissionEditor', () => {
it('clears items when confirmed', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -416,7 +524,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'to-be-cleared{enter}');
await user.click(await within(createToggle).findByText('All'));
@@ -433,7 +543,7 @@ describe('PermissionEditor', () => {
it('keeps items when cancelled', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -443,7 +553,9 @@ describe('PermissionEditor', () => {
await user.click(await within(createToggle).findByText('Only selected'));
- const input = screen.getByTestId('item-input-selector-input');
+ const input = screen.getByTestId(
+ 'item-input-selector-input-factor-api-key-read',
+ );
await user.type(input, 'preserved-key{enter}');
await user.click(await within(createToggle).findByText('None'));
@@ -455,12 +567,14 @@ describe('PermissionEditor', () => {
screen.findByText('preserved-key'),
).resolves.toBeInTheDocument();
- expect(screen.getByTestId('item-input-selector')).toBeInTheDocument();
+ expect(
+ screen.getByTestId('item-input-selector-factor-api-key-read'),
+ ).toBeInTheDocument();
});
it('does not show dialog when leaving Only Selected with no items', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -479,7 +593,7 @@ describe('PermissionEditor', () => {
describe('verbs without Only Selected option', () => {
it('does not show Only Selected for list verb', async () => {
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -501,7 +615,7 @@ describe('PermissionEditor', () => {
describe('collapse/expand all resources', () => {
it('shows expand/collapse toggle group', async () => {
- await renderPage();
+ await renderCreateRolePage();
expect(screen.getByTestId('toggle-all-group')).toBeInTheDocument();
expect(screen.getByTestId('expand-all-button')).toBeInTheDocument();
@@ -509,7 +623,7 @@ describe('PermissionEditor', () => {
});
it('expands all cards when expand button clicked', async () => {
- await renderPage();
+ await renderCreateRolePage();
await expandAllCards();
const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
@@ -523,7 +637,7 @@ describe('PermissionEditor', () => {
describe('resource card error states', () => {
it('shows error border on collapsed card with validation error', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
const nameInput = screen.getByTestId('role-name-input');
await user.type(nameInput, 'valid-role');
@@ -553,7 +667,7 @@ describe('PermissionEditor', () => {
it('hides error border when card is expanded', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
const nameInput = screen.getByTestId('role-name-input');
await user.type(nameInput, 'valid-role');
@@ -590,7 +704,7 @@ describe('PermissionEditor', () => {
it('clears validation error when permission is changed', async () => {
const user = userEvent.setup();
- await renderPage();
+ await renderCreateRolePage();
const nameInput = screen.getByTestId('role-name-input');
await user.type(nameInput, 'valid-role');
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/PermissionEditor.wizard.test.tsx b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/PermissionEditor.wizard.test.tsx
new file mode 100644
index 0000000000..33138a7015
--- /dev/null
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/PermissionEditor.wizard.test.tsx
@@ -0,0 +1,462 @@
+import { server } from 'mocks-server/server';
+import { screen, userEvent, waitFor, within } from 'tests/test-utils';
+import { setupAuthzAdmin } from 'lib/authz/utils/authz-test-utils';
+
+import { expandAllCards, renderCreateRolePage } from './testUtils';
+
+beforeEach(() => {
+ server.use(setupAuthzAdmin());
+});
+
+afterEach(() => {
+ server.resetHandlers();
+});
+
+async function selectOnlySelected(
+ user: ReturnType<typeof userEvent.setup>,
+ resource = 'logs',
+): Promise<void> {
+ await renderCreateRolePage();
+ await expandAllCards();
+
+ const card = screen.getByTestId(`resource-card-${resource}`);
+ const readToggle = within(card).getByTestId(`action-toggle-${resource}-read`);
+ await user.click(await within(readToggle).findByText('Only selected'));
+}
+
+async function selectLogsOnlySelected(
+ user: ReturnType<typeof userEvent.setup>,
+): Promise<void> {
+ await selectOnlySelected(user, 'logs');
+}
+
+async function openWizard(
+ user: ReturnType<typeof userEvent.setup>,
+ resource = 'logs',
+): Promise<void> {
+ await selectOnlySelected(user, resource);
+
+ await user.click(
+ screen.getByTestId(`telemetry-wizard-trigger-${resource}-read`),
+ );
+ await screen.findByTestId(`telemetry-wizard-dialog-${resource}-read`);
+}
+
+async function openLogsWizard(
+ user: ReturnType<typeof userEvent.setup>,
+): Promise<void> {
+ await openWizard(user, 'logs');
+}
+
+describe('PermissionEditor - TelemetrySelectorWizard', () => {
+ it('shows wizard button for telemetry resources', async () => {
+ const user = userEvent.setup();
+ await selectLogsOnlySelected(user);
+
+ expect(
+ screen.getByTestId('telemetry-wizard-trigger-logs-read'),
+ ).toBeInTheDocument();
+ });
+
+ it('does not show wizard button for non-telemetry resources', async () => {
+ await renderCreateRolePage();
+ await expandAllCards();
+
+ const apiKeyCard = screen.getByTestId('resource-card-factor-api-key');
+ const readToggle = within(apiKeyCard).getByTestId(
+ 'action-toggle-factor-api-key-read',
+ );
+
+ const user = userEvent.setup();
+ await user.click(await within(readToggle).findByText('Only selected'));
+
+ expect(
+ screen.queryByTestId('telemetry-wizard-trigger-logs-read'),
+ ).not.toBeInTheDocument();
+ });
+
+ it('opens wizard dialog when trigger clicked', async () => {
+ const user = userEvent.setup();
+ await selectLogsOnlySelected(user);
+
+ await user.click(screen.getByTestId('telemetry-wizard-trigger-logs-read'));
+
+ await expect(
+ screen.findByTestId('telemetry-wizard-dialog-logs-read'),
+ ).resolves.toBeInTheDocument();
+ });
+
+ it('adds a query-type wildcard when the value is left empty', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ await expect(
+ screen.findByText('builder_query/*'),
+ ).resolves.toBeInTheDocument();
+ });
+
+ it('does not offer builder sub query', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByTestId('wizard-query-type-select-logs-read'));
+
+ expect(screen.queryByText('Builder Sub Query')).not.toBeInTheDocument();
+ });
+
+ it('does not show PromQL for logs', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByTestId('wizard-query-type-select-logs-read'));
+
+ expect(
+ screen.queryByTestId('wizard-query-type-option-promql-logs-read'),
+ ).not.toBeInTheDocument();
+ });
+
+ it('does not show PromQL for traces', async () => {
+ const user = userEvent.setup();
+ await openWizard(user, 'traces');
+
+ await user.click(screen.getByTestId('wizard-query-type-select-traces-read'));
+
+ expect(
+ screen.queryByTestId('wizard-query-type-option-promql-traces-read'),
+ ).not.toBeInTheDocument();
+ });
+
+ it('allows PromQL for metrics', async () => {
+ const user = userEvent.setup();
+ await openWizard(user, 'metrics');
+
+ await user.click(screen.getByTestId('wizard-query-type-select-metrics-read'));
+ await user.click(
+ await screen.findByTestId('wizard-query-type-option-promql-metrics-read'),
+ );
+
+ await user.click(screen.getByTestId('wizard-add-btn-metrics-read'));
+
+ await expect(screen.findByText('promql/*')).resolves.toBeInTheDocument();
+ });
+
+ it('hardcodes the key and does not let it be edited', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const keyInput = screen.getByTestId('wizard-key-input-logs-read');
+ expect(keyInput).toHaveValue('signoz.workspace.key.id');
+ expect(keyInput).toBeDisabled();
+ });
+
+ it('hides Key field for query types that do not support key scoping', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByTestId('wizard-query-type-select-logs-read'));
+ await user.click(await screen.findByText('ClickHouse SQL'));
+
+ expect(
+ screen.queryByTestId('wizard-key-input-logs-read'),
+ ).not.toBeInTheDocument();
+ });
+
+ it('adds a key-scoped selector when the value is filled', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.type(screen.getByTestId('wizard-value-input-logs-read'), '123');
+
+ expect(screen.getByTestId('wizard-selector-input-logs-read')).toHaveValue(
+ 'builder_query/signoz.workspace.key.id/123',
+ );
+
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ await expect(
+ screen.findByText('builder_query/signoz.workspace.key.id/123'),
+ ).resolves.toBeInTheDocument();
+ });
+
+ it('replaces the value with a wildcard when any resource is checked', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByLabelText('Any value'));
+
+ expect(screen.getByTestId('wizard-value-input-logs-read')).toHaveValue('*');
+
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ await expect(
+ screen.findByText('builder_query/signoz.workspace.key.id/*'),
+ ).resolves.toBeInTheDocument();
+ });
+
+ it('clears the value when any resource is unchecked', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const anyResource = screen.getByLabelText('Any value');
+ await user.click(anyResource);
+ expect(anyResource).toBeChecked();
+
+ await user.click(anyResource);
+
+ expect(anyResource).not.toBeChecked();
+ expect(screen.getByTestId('wizard-value-input-logs-read')).toHaveValue('');
+ });
+
+ it('checks any resource when the value is typed as a wildcard', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.type(screen.getByTestId('wizard-value-input-logs-read'), '*');
+
+ expect(screen.getByLabelText('Any value')).toBeChecked();
+ });
+
+ it('disables value scoping for query types that do not support it', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByTestId('wizard-query-type-select-logs-read'));
+ await user.click(await screen.findByText('ClickHouse SQL'));
+
+ expect(screen.getByTestId('wizard-value-input-logs-read')).toBeDisabled();
+ expect(screen.getByLabelText('Any value')).toBeDisabled();
+ });
+
+ it('clears the value when switching to a query type without key scoping', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.type(screen.getByTestId('wizard-value-input-logs-read'), '123');
+
+ await user.click(screen.getByTestId('wizard-query-type-select-logs-read'));
+ await user.click(await screen.findByText('ClickHouse SQL'));
+
+ expect(screen.getByTestId('wizard-value-input-logs-read')).toHaveValue('');
+ expect(screen.getByTestId('wizard-selector-input-logs-read')).toHaveValue(
+ 'clickhouse_sql/*',
+ );
+
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ await expect(
+ screen.findByText('clickhouse_sql/*'),
+ ).resolves.toBeInTheDocument();
+ });
+
+ it('follows a hand-edited selector on the query type and value inputs', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const selectorInput = screen.getByTestId('wizard-selector-input-logs-read');
+ await user.clear(selectorInput);
+ await user.type(
+ selectorInput,
+ 'clickhouse_sql/signoz.workspace.key.id/checkout',
+ );
+
+ const selectTrigger = screen.getByTestId(
+ 'wizard-query-type-select-logs-read',
+ );
+ expect(within(selectTrigger).getByText('ClickHouse SQL')).toBeInTheDocument();
+ expect(screen.getByTestId('wizard-value-input-logs-read')).toHaveValue(
+ 'checkout',
+ );
+ });
+
+ it('checks any resource when the selector is edited to a wildcard value', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const selectorInput = screen.getByTestId('wizard-selector-input-logs-read');
+ await user.clear(selectorInput);
+ await user.type(selectorInput, 'builder_query/signoz.workspace.key.id/*');
+
+ expect(screen.getByLabelText('Any value')).toBeChecked();
+ });
+
+ it('keeps the key input hardcoded when the selector uses another key', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const selectorInput = screen.getByTestId('wizard-selector-input-logs-read');
+ await user.clear(selectorInput);
+ await user.type(selectorInput, 'builder_query/service.name/frontend');
+
+ expect(screen.getByTestId('wizard-key-input-logs-read')).toHaveValue(
+ 'signoz.workspace.key.id',
+ );
+ expect(
+ screen.getByTestId('wizard-selector-hint-logs-read'),
+ ).toHaveTextContent('Allow service.name=frontend for Builder Query queries.');
+ expect(screen.getByTestId('wizard-add-btn-logs-read')).not.toBeDisabled();
+ });
+
+ it('restores the hardcoded key in the selector once the value changes', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const selectorInput = screen.getByTestId('wizard-selector-input-logs-read');
+ await user.clear(selectorInput);
+ await user.type(selectorInput, 'builder_query/service.name/frontend');
+
+ await user.type(screen.getByTestId('wizard-value-input-logs-read'), '2');
+
+ expect(selectorInput).toHaveValue(
+ 'builder_query/signoz.workspace.key.id/frontend2',
+ );
+ expect(screen.getByTestId('wizard-add-btn-logs-read')).not.toBeDisabled();
+ });
+
+ it('blocks adding when the selector has an unknown query type', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const selectorInput = screen.getByTestId('wizard-selector-input-logs-read');
+ await user.clear(selectorInput);
+ await user.type(selectorInput, 'sql_query/*');
+
+ expect(
+ screen.getByTestId('wizard-selector-hint-logs-read'),
+ ).toHaveTextContent('"sql_query" is not a supported query type.');
+ expect(screen.getByTestId('wizard-add-btn-logs-read')).toBeDisabled();
+ });
+
+ it('blocks adding when the selector is emptied', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.clear(screen.getByTestId('wizard-selector-input-logs-read'));
+
+ expect(
+ screen.getByTestId('wizard-selector-hint-logs-read'),
+ ).toHaveTextContent('Enter a selector.');
+ expect(screen.getByTestId('wizard-add-btn-logs-read')).toBeDisabled();
+ });
+
+ it('adds the hand-edited selector verbatim', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ const selectorInput = screen.getByTestId('wizard-selector-input-logs-read');
+ await user.clear(selectorInput);
+ await user.type(selectorInput, 'builder_query/signoz.workspace.key.id/a/b');
+
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ await expect(
+ screen.findByText('builder_query/signoz.workspace.key.id/a/b'),
+ ).resolves.toBeInTheDocument();
+ });
+
+ it('closes dialog after adding selector', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ await waitFor(() => {
+ expect(
+ screen.queryByTestId('telemetry-wizard-dialog-logs-read'),
+ ).not.toBeInTheDocument();
+ });
+ });
+
+ it('does not add duplicate selectors', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ await user.click(screen.getByTestId('telemetry-wizard-trigger-logs-read'));
+ await screen.findByTestId('telemetry-wizard-dialog-logs-read');
+ await user.click(screen.getByTestId('wizard-add-btn-logs-read'));
+
+ const badges = screen.getAllByText('builder_query/*');
+ expect(badges).toHaveLength(1);
+ });
+
+ it('resets wizard state when dialog is closed and reopened', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.type(screen.getByTestId('wizard-value-input-logs-read'), '123');
+ await user.click(screen.getByTestId('wizard-query-type-select-logs-read'));
+ await user.click(await screen.findByText('ClickHouse SQL'));
+
+ await user.click(screen.getByRole('button', { name: /cancel/i }));
+
+ await waitFor(() => {
+ expect(
+ screen.queryByTestId('telemetry-wizard-dialog-logs-read'),
+ ).not.toBeInTheDocument();
+ });
+
+ await user.click(screen.getByTestId('telemetry-wizard-trigger-logs-read'));
+ const selectTrigger = await screen.findByTestId(
+ 'wizard-query-type-select-logs-read',
+ );
+
+ expect(within(selectTrigger).getByText('Builder Query')).toBeInTheDocument();
+ expect(screen.getByTestId('wizard-value-input-logs-read')).toHaveValue('');
+ expect(screen.getByTestId('wizard-selector-input-logs-read')).toHaveValue(
+ 'builder_query/*',
+ );
+ });
+
+ it('previews the query-type wildcard while the value is empty', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ expect(screen.getByTestId('wizard-selector-input-logs-read')).toHaveValue(
+ 'builder_query/*',
+ );
+ expect(
+ screen.getByTestId('wizard-selector-hint-logs-read'),
+ ).toHaveTextContent('Allow every "Builder Query" query.');
+ });
+
+ it('describes a key-scoped selector', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.type(screen.getByTestId('wizard-value-input-logs-read'), '123');
+
+ expect(
+ screen.getByTestId('wizard-selector-hint-logs-read'),
+ ).toHaveTextContent(
+ 'Allow signoz.workspace.key.id=123 for Builder Query queries.',
+ );
+ });
+
+ it('describes an any-resource selector', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByLabelText('Any value'));
+
+ expect(
+ screen.getByTestId('wizard-selector-hint-logs-read'),
+ ).toHaveTextContent(
+ 'Allow every signoz.workspace.key.id for Builder Query queries.',
+ );
+ });
+
+ it('does not show query type descriptions', async () => {
+ const user = userEvent.setup();
+ await openLogsWizard(user);
+
+ await user.click(screen.getByTestId('wizard-query-type-select-logs-read'));
+
+ expect(
+ screen.queryByText(
+ 'Visual query builder for selecting data sources, filters, and aggregations',
+ ),
+ ).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/testUtils.tsx b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/testUtils.tsx
new file mode 100644
index 0000000000..7e6e8d1844
--- /dev/null
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/__tests__/testUtils.tsx
@@ -0,0 +1,33 @@
+import { Route, Switch } from 'react-router-dom';
+import ROUTES from 'constants/routes';
+import { render, screen, userEvent } from 'tests/test-utils';
+import { TooltipProvider } from '@signozhq/ui/tooltip';
+
+import CreateEditRolePage from '../CreateEditRolePage';
+
+export async function renderCreateRolePage(): Promise<
+ ReturnType<typeof render>
+> {
+ const result = render(
+ <TooltipProvider>
+ <Switch>
+ <Route path={ROUTES.ROLES_SETTINGS} exact>
+ <div data-testid="roles-list-redirect" />
+ </Route>
+ <Route path={ROUTES.ROLE_CREATE}>
+ <CreateEditRolePage />
+ </Route>
+ </Switch>
+ </TooltipProvider>,
+ undefined,
+ { initialRoute: '/settings/roles/new' },
+ );
+ await screen.findByTestId('permission-editor');
+ return result;
+}
+
+export async function expandAllCards(): Promise<void> {
+ const user = userEvent.setup();
+ const expandButton = await screen.findByTestId('expand-all-button');
+ await user.click(expandButton);
+}
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/ActionToggle.tsx b/frontend/src/container/RolesSettings/CreateEditRolePage/components/ActionToggle.tsx
index 65e766c18d..e6867146b2 100644
--- a/frontend/src/container/RolesSettings/CreateEditRolePage/components/ActionToggle.tsx
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/ActionToggle.tsx
@@ -7,6 +7,7 @@ import { Typography } from '@signozhq/ui/typography';
import { PermissionScope } from '../../types';
import { getResourcePanel } from '../../permissions.config';
import ItemInputSelector from './ItemInputSelector';
+import TelemetrySelectorWizard from './TelemetrySelectorWizard';
import styles from './ActionToggle.module.scss';
import { AuthZResource, AuthZVerb } from 'lib/authz/hooks/useAuthZ/types';
@@ -39,10 +40,13 @@ function ActionToggle({
onSelectedIdsChange,
hasError = false,
}: ActionToggleProps): JSX.Element {
+ const panel = getResourcePanel(resource);
+
const [confirmDialogOpen, setConfirmDialogOpen] = useState(false);
const [pendingScope, setPendingScope] = useState<PermissionScope | null>(null);
const displayLabel = getActionLabel(action);
+ const selectorTestId = `${resource}-${action}`;
const scopeItems: Array<{ value: PermissionScope; label: string }> =
useMemo(() => {
@@ -121,11 +125,25 @@ function ActionToggle({
<Divider />
<ItemInputSelector
- placeholder={getResourcePanel(resource).selectorPlaceholder}
+ placeholder={panel.selectorPlaceholder}
selectedIds={selectedIds}
onChange={onSelectedIdsChange}
- docsAnchor={getResourcePanel(resource).docsAnchor}
+ testId={selectorTestId}
+ docsAnchor={panel.docsAnchor}
hasError={hasError}
+ prefixElement={
+ panel.selectorType === 'telemetryBuilder' ? (
+ <TelemetrySelectorWizard
+ resource={resource}
+ testId={selectorTestId}
+ onAdd={(selector): void => {
+ if (!selectedIds.includes(selector)) {
+ onSelectedIdsChange([...selectedIds, selector]);
+ }
+ }}
+ />
+ ) : null
+ }
/>
</div>
)}
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.module.scss b/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.module.scss
index 8e672406f3..2243a7534e 100644
--- a/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.module.scss
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.module.scss
@@ -4,9 +4,10 @@
gap: var(--spacing-4);
background: var(--l1-background);
border: 1px solid var(--l1-border);
- border-radius: 4px;
+ border-radius: var(--radius-2);
padding: var(--spacing-4);
+ --input-prefix-padding: var(--spacing-2);
--input-suffix-padding: var(--spacing-2);
}
@@ -41,51 +42,17 @@
overflow-y: auto;
}
-.itemInputSelectorInfoIcon {
- flex-shrink: 0;
- color: var(--l2-foreground);
- cursor: pointer;
-
- &:hover {
- color: var(--l1-foreground);
- }
-}
-
.itemInputSelectorBadge {
- display: inline-flex;
- align-items: center;
- gap: 4px;
- max-width: 140px;
- padding: 2px 4px 2px 6px;
- background: var(--l2-background);
- border: 1px solid var(--l2-border);
- border-radius: 4px;
+ --badge-border-radius: 4px;
+ --badge-hover-background: var(--l2-background) !important;
}
-.itemInputSelectorBadgeLabel {
- flex: 1;
- min-width: 0;
-}
-
-.itemInputSelectorBadgeRemove {
+.itemInputSelectorInfoIcon {
flex-shrink: 0;
- display: flex;
- align-items: center;
- justify-content: center;
- width: 14px;
- height: 14px;
- padding: 0;
- background: transparent;
- border: none;
- border-radius: 2px;
color: var(--l2-foreground);
cursor: pointer;
- transition:
- background 0.15s ease,
- color 0.15s ease;
&:hover {
- background: var(--l1-background);
color: var(--l1-foreground);
}
}
@@ -93,13 +60,4 @@
.itemInputSelectorHint {
margin: 0;
color: var(--l2-foreground);
-
- a {
- color: var(--primary);
- text-decoration: none;
-
- &:hover {
- text-decoration: underline;
- }
- }
}
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.tsx b/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.tsx
index 2acca7e4cb..6ce5a15b3d 100644
--- a/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.tsx
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/ItemInputSelector.tsx
@@ -1,5 +1,6 @@
import { useCallback, useRef, useState } from 'react';
-import { Info, Plus, X } from '@signozhq/icons';
+import { Info, Plus } from '@signozhq/icons';
+import { Badge } from '@signozhq/ui/badge';
import { Button } from '@signozhq/ui/button';
import { Input } from '@signozhq/ui/input';
import { Typography } from '@signozhq/ui/typography';
@@ -15,8 +16,10 @@ export interface ItemInputSelectorProps {
placeholder: string;
selectedIds: string[];
onChange: (ids: string[]) => void;
+ testId: string;
docsAnchor?: string;
hasError?: boolean;
+ prefixElement?: React.ReactNode;
}
function parseInputValues(input: string): string[] {
@@ -30,11 +33,13 @@ function ItemInputSelector({
placeholder,
selectedIds,
onChange,
+ testId,
docsAnchor = 'role',
hasError = false,
+ prefixElement,
}: ItemInputSelectorProps): JSX.Element {
const [inputValue, setInputValue] = useState('');
- const footerRef = useRef<HTMLDivElement>(null);
+ const badgesRef = useRef<HTMLDivElement>(null);
const addValues = useCallback(
(input: string): void => {
@@ -87,26 +92,24 @@ function ItemInputSelector({
[selectedIds, onChange],
);
- const handleBadgeKeyDown = useCallback(
- (
- e: React.KeyboardEvent<HTMLButtonElement>,
- itemId: string,
- index: number,
- ): void => {
- if (e.key !== 'Enter' && e.key !== ' ') {
- return;
- }
-
+ const handleBadgeClose = useCallback(
+ (e: React.MouseEvent, itemId: string, index: number): void => {
e.preventDefault();
handleRemove(itemId);
+ // Activating a button via Enter/Space reports detail 0;
+ // a real click reports 1 or more
+ // Only trigger focus when using keyboard
+ const isKeyboardActivation = e.detail === 0;
+
+ if (!isKeyboardActivation) {
+ return;
+ }
+
const targetIndex = index > 0 ? index - 1 : 0;
requestAnimationFrame(() => {
- const buttons = footerRef.current?.querySelectorAll('button');
- const targetButton = buttons?.[targetIndex] as
- | HTMLButtonElement
- | undefined;
- targetButton?.focus();
+ const buttons = badgesRef.current?.querySelectorAll('button');
+ buttons?.[targetIndex]?.focus();
});
},
[handleRemove],
@@ -120,7 +123,7 @@ function ItemInputSelector({
styles.itemInputSelector,
showError ? styles.itemInputSelectorError : '',
)}
- data-testid="item-input-selector"
+ data-testid={`item-input-selector-${testId}`}
>
<Input
placeholder={placeholder}
@@ -128,14 +131,15 @@ function ItemInputSelector({
onChange={handleInputChange}
onKeyDown={handleInputKeyDown}
onBlur={handleInputBlur}
- data-testid="item-input-selector-input"
+ data-testid={`item-input-selector-input-${testId}`}
+ prefix={prefixElement}
suffix={
<Button
variant="solid"
size="sm"
onClick={handleAddClick}
disabled={!inputValue.trim()}
- data-testid="item-input-selector-add-btn"
+ data-testid={`item-input-selector-add-btn-${testId}`}
>
<Plus size={14} />
Add
@@ -144,28 +148,22 @@ function ItemInputSelector({
/>
{selectedIds.length > 0 ? (
- <div ref={footerRef} className={styles.itemInputSelectorFooter}>
- <div className={styles.itemInputSelectorBadges}>
+ <div className={styles.itemInputSelectorFooter}>
+ <div ref={badgesRef} className={styles.itemInputSelectorBadges}>
{selectedIds.map((id, index) => (
- <span key={id} className={styles.itemInputSelectorBadge} title={id}>
- <Typography
- as="span"
- size="small"
- truncate={1}
- className={styles.itemInputSelectorBadgeLabel}
- >
+ <Badge
+ key={id}
+ color="secondary"
+ className={styles.itemInputSelectorBadge}
+ testId={`item-badge-${testId}-${index}`}
+ closable
+ closeAriaLabel={`Remove ${id}`}
+ onClose={(e): void => handleBadgeClose(e, id, index)}
+ >
+ <Typography as="span" size="small" truncate={1} title={id}>
{id}
</Typography>
- <button
- type="button"
- className={styles.itemInputSelectorBadgeRemove}
- onClick={(): void => handleRemove(id)}
- onKeyDown={(e): void => handleBadgeKeyDown(e, id, index)}
- aria-label={`Remove ${id}`}
- >
- <X size={10} />
- </button>
- </span>
+ </Badge>
))}
</div>
<TooltipSimple
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.constants.ts b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.constants.ts
new file mode 100644
index 0000000000..1d310d006a
--- /dev/null
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.constants.ts
@@ -0,0 +1,50 @@
+// intentionally omitting few query types
+// from pkg/types/querybuildertypes/querybuildertypesv5/query_type.go
+export type QueryTypeId = 'builder_query' | 'promql' | 'clickhouse_sql';
+
+export interface QueryTypeOption {
+ id: QueryTypeId;
+ label: string;
+ supportsKeyScoping: boolean;
+ metricsOnly?: boolean;
+}
+
+export const QUERY_TYPES: readonly QueryTypeOption[] = [
+ {
+ id: 'builder_query',
+ label: 'Builder Query',
+ supportsKeyScoping: true,
+ },
+ {
+ id: 'promql',
+ label: 'PromQL',
+ supportsKeyScoping: false,
+ metricsOnly: true,
+ },
+ {
+ id: 'clickhouse_sql',
+ label: 'ClickHouse SQL',
+ supportsKeyScoping: false,
+ },
+] as const;
+
+export const DEFAULT_QUERY_TYPE: QueryTypeId = 'builder_query';
+
+export const SUPPORTED_GRANT_KEY = 'signoz.workspace.key.id';
+
+export const ANY_RESOURCE_VALUE = '*';
+
+export interface SelectorDraft {
+ queryType: QueryTypeId;
+ value: string;
+}
+
+export interface ParsedSelector {
+ queryType?: QueryTypeId;
+ value: string;
+}
+
+export interface SelectorValidation {
+ message: string;
+ isError: boolean;
+}
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.module.scss b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.module.scss
new file mode 100644
index 0000000000..bfcc531dd6
--- /dev/null
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.module.scss
@@ -0,0 +1,52 @@
+.wizardDialog {
+ border-color: var(--l1-border);
+
+ --select-trigger-background-color: var(--l3-background);
+ --select-trigger-border-color: var(--l3-background);
+ --select-content-background: var(--l3-background);
+ --select-item-highlight-background: var(--l3-background-hover);
+ --select-trigger-outline-width: 1px;
+ --select-trigger-outline-offset: 0px;
+
+ --input-background: var(--l3-background);
+ --input-hover-background: var(--l3-background);
+ --input-focus-background: var(--l3-background);
+ --input-disabled-background: var(--l3-background);
+ --input-border-color: var(--l3-border);
+ --input-hover-border-color: var(--l3-border);
+ --input-focus-border-color: var(--l3-border);
+
+ outline: none;
+
+ & > div {
+ background-color: var(--l2-background);
+ }
+}
+
+.wizardBody {
+ display: flex;
+ flex-direction: column;
+ gap: var(--spacing-6);
+}
+
+.wizardField {
+ display: flex;
+ flex-direction: column;
+ gap: var(--spacing-2);
+}
+
+.wizardValueRow {
+ display: flex;
+ align-items: center;
+ gap: var(--spacing-3);
+}
+
+.wizardValueInput {
+ flex: 1;
+ min-width: 0;
+}
+
+.selectContent {
+ z-index: 10;
+ background-color: var(--l3-background);
+}
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.tsx b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.tsx
new file mode 100644
index 0000000000..ee703ac25f
--- /dev/null
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.tsx
@@ -0,0 +1,190 @@
+import { Wand } from '@signozhq/icons';
+import { Button } from '@signozhq/ui/button';
+import { Checkbox } from '@signozhq/ui/checkbox';
+import { DialogWrapper } from '@signozhq/ui/dialog';
+import { Input } from '@signozhq/ui/input';
+import {
+ Select,
+ SelectContent,
+ SelectItem,
+ SelectTrigger,
+ SelectValue,
+} from '@signozhq/ui/select';
+import { Typography } from '@signozhq/ui/typography';
+
+import {
+ ANY_RESOURCE_VALUE,
+ QUERY_TYPES,
+ SUPPORTED_GRANT_KEY,
+} from './TelemetrySelectorWizard.constants';
+import { isQueryTypeAvailable } from './TelemetrySelectorWizard.utils';
+import useTelemetrySelectorWizard from './useTelemetrySelectorWizard';
+
+import styles from './TelemetrySelectorWizard.module.scss';
+import { AuthZResource } from 'lib/authz/hooks/useAuthZ/types';
+
+interface TelemetrySelectorWizardProps {
+ onAdd: (selector: string) => void;
+ resource: AuthZResource;
+ testId: string;
+}
+
+function TelemetrySelectorWizard({
+ onAdd,
+ resource,
+ testId,
+}: TelemetrySelectorWizardProps): JSX.Element {
+ const {
+ open,
+ queryType,
+ selectedQueryType,
+ value,
+ selector,
+ isAnyResource,
+ supportsKeyScoping,
+ validation,
+ canAdd,
+ handleOpenChange,
+ handleQueryTypeChange,
+ handleValueChange,
+ handleAnyResourceChange,
+ handleSelectorChange,
+ handleAdd,
+ handleInputKeyDown,
+ } = useTelemetrySelectorWizard({ onAdd });
+
+ const trigger = (
+ <Button
+ variant="solid"
+ size="sm"
+ data-testid={`telemetry-wizard-trigger-${testId}`}
+ >
+ <Wand size={14} />
+ Wizard
+ </Button>
+ );
+
+ const footer = (
+ <>
+ <Button
+ variant="ghost"
+ color="secondary"
+ onClick={(): void => handleOpenChange(false)}
+ >
+ Cancel
+ </Button>
+ <Button
+ variant="solid"
+ onClick={handleAdd}
+ disabled={!canAdd}
+ data-testid={`wizard-add-btn-${testId}`}
+ >
+ Add Selector
+ </Button>
+ </>
+ );
+
+ return (
+ <DialogWrapper
+ open={open}
+ onOpenChange={handleOpenChange}
+ title="Selector Wizard"
+ width="wide"
+ testId={`telemetry-wizard-dialog-${testId}`}
+ trigger={trigger}
+ footer={footer}
+ className={styles.wizardDialog}
+ >
+ <div className={styles.wizardBody}>
+ <div className={styles.wizardField}>
+ <Typography as="label" weight="medium">
+ Query Type
+ </Typography>
+ <Select value={queryType} onChange={handleQueryTypeChange}>
+ <SelectTrigger data-testid={`wizard-query-type-select-${testId}`}>
+ <SelectValue>{selectedQueryType?.label}</SelectValue>
+ </SelectTrigger>
+ <SelectContent withPortal={false} className={styles.selectContent}>
+ {QUERY_TYPES.filter((queryTypeOption) =>
+ isQueryTypeAvailable(queryTypeOption, resource),
+ ).map((queryTypeOption) => (
+ <SelectItem
+ key={queryTypeOption.id}
+ value={queryTypeOption.id}
+ testId={`wizard-query-type-option-${queryTypeOption.id}-${testId}`}
+ >
+ {queryTypeOption.label}
+ </SelectItem>
+ ))}
+ </SelectContent>
+ </Select>
+ </div>
+
+ {supportsKeyScoping && (
+ <div className={styles.wizardField}>
+ <Typography as="label" weight="medium">
+ Key
+ </Typography>
+ <Input
+ value={SUPPORTED_GRANT_KEY}
+ readOnly
+ disabled
+ testId={`wizard-key-input-${testId}`}
+ />
+ </div>
+ )}
+
+ <div className={styles.wizardField}>
+ <Typography as="label" weight="medium">
+ Value
+ </Typography>
+ <div className={styles.wizardValueRow}>
+ <Input
+ className={styles.wizardValueInput}
+ placeholder={
+ supportsKeyScoping
+ ? 'Value or leave empty to allow every query'
+ : ANY_RESOURCE_VALUE
+ }
+ value={value}
+ disabled={!supportsKeyScoping}
+ onChange={handleValueChange}
+ onKeyDown={handleInputKeyDown}
+ testId={`wizard-value-input-${testId}`}
+ />
+ <Checkbox
+ id={`wizard-any-resource-${testId}`}
+ value={isAnyResource}
+ disabled={!supportsKeyScoping}
+ onChange={(checked): void => handleAnyResourceChange(checked === true)}
+ testId={`wizard-any-resource-checkbox-${testId}`}
+ >
+ Any value
+ </Checkbox>
+ </div>
+ </div>
+
+ <div className={styles.wizardField}>
+ <Typography as="label" weight="medium">
+ Selector
+ </Typography>
+ <Input
+ value={selector}
+ onChange={handleSelectorChange}
+ onKeyDown={handleInputKeyDown}
+ testId={`wizard-selector-input-${testId}`}
+ />
+ <Typography.Text
+ size="small"
+ color={validation.isError ? 'danger' : 'muted'}
+ testId={`wizard-selector-hint-${testId}`}
+ >
+ {validation.message}
+ </Typography.Text>
+ </div>
+ </div>
+ </DialogWrapper>
+ );
+}
+
+export default TelemetrySelectorWizard;
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.utils.ts b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.utils.ts
new file mode 100644
index 0000000000..35c850ee4d
--- /dev/null
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/TelemetrySelectorWizard.utils.ts
@@ -0,0 +1,139 @@
+import { AuthZResource } from 'lib/authz/hooks/useAuthZ/types';
+
+import {
+ ANY_RESOURCE_VALUE,
+ ParsedSelector,
+ QUERY_TYPES,
+ QueryTypeId,
+ QueryTypeOption,
+ SelectorDraft,
+ SelectorValidation,
+ SUPPORTED_GRANT_KEY,
+} from './TelemetrySelectorWizard.constants';
+
+const METRIC_RESOURCES: ReadonlySet<AuthZResource> = new Set<AuthZResource>([
+ 'metrics',
+ 'meter-metrics',
+]);
+
+export function getQueryTypeOption(
+ queryType: string,
+): QueryTypeOption | undefined {
+ return QUERY_TYPES.find((option) => option.id === queryType);
+}
+
+export function isQueryTypeAvailable(
+ option: QueryTypeOption,
+ resource: AuthZResource,
+): boolean {
+ return !option.metricsOnly || METRIC_RESOURCES.has(resource);
+}
+
+export function supportsKeyScoping(queryType: string): boolean {
+ return getQueryTypeOption(queryType)?.supportsKeyScoping ?? false;
+}
+
+export function isAnyResourceValue(value: string): boolean {
+ return value.trim() === ANY_RESOURCE_VALUE;
+}
+
+function splitSelector(selector: string): string[] {
+ const parts = selector.split('/');
+
+ if (parts.length <= 3) {
+ return parts;
+ }
+
+ return [parts[0], parts[1], parts.slice(2).join('/')];
+}
+
+export function buildSelector({ queryType, value }: SelectorDraft): string {
+ const trimmedValue = value.trim();
+
+ if (!supportsKeyScoping(queryType) || !trimmedValue) {
+ return `${queryType}/${ANY_RESOURCE_VALUE}`;
+ }
+
+ return `${queryType}/${SUPPORTED_GRANT_KEY}/${trimmedValue}`;
+}
+
+export function parseSelector(selector: string): ParsedSelector {
+ const parts = splitSelector(selector.trim());
+
+ return {
+ queryType: getQueryTypeOption(parts[0])?.id,
+ value: parts.length >= 3 ? parts[2] : '',
+ };
+}
+
+/**
+ * This does a basic validation, intentionally omitting deep validations since this is to be made at backend,
+ * so this will allow to produce invalid selectors, and the validation will be done after the user try to save
+ */
+export function validateSelector(selector: string): SelectorValidation {
+ const trimmed = selector.trim();
+
+ if (!trimmed) {
+ return { message: 'Enter a selector.', isError: true };
+ }
+
+ if (trimmed === ANY_RESOURCE_VALUE) {
+ return { message: 'Allow every query of every type.', isError: false };
+ }
+
+ const parts = splitSelector(trimmed);
+ const option = getQueryTypeOption(parts[0]);
+
+ if (!option) {
+ return {
+ message: `"${parts[0]}" is not a supported query type.`,
+ isError: true,
+ };
+ }
+
+ if (parts.length < 3) {
+ if (parts.length === 2 && parts[1] !== ANY_RESOURCE_VALUE) {
+ if (!option.supportsKeyScoping) {
+ return {
+ message: `This query type does not support key scoping. Use ${option.id}/*`,
+ isError: false, // intentionally not an error
+ };
+ }
+
+ return {
+ message: `Use <query-type>/${ANY_RESOURCE_VALUE} or <query-type>/${SUPPORTED_GRANT_KEY}/<value>.`,
+ isError: false, // intentionally not an error
+ };
+ }
+
+ return {
+ message: `Allow every "${option.label}" query.`,
+ isError: false,
+ };
+ }
+
+ const [, key, value] = parts;
+
+ if (value === ANY_RESOURCE_VALUE) {
+ return {
+ message: `Allow every ${key} for ${option.label} queries.`,
+ isError: false,
+ };
+ }
+
+ if (!option.supportsKeyScoping) {
+ return {
+ message: `This query type does not support key scoping. Use ${option.id}/*`,
+ isError: false, // intentionally not an error
+ };
+ }
+
+ return {
+ message: `Allow ${key}=${value} for ${option.label} queries.`,
+ isError: false,
+ };
+}
+
+export function getDefaultSelector(queryType: QueryTypeId): string {
+ return buildSelector({ queryType, value: '' });
+}
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/jsonSchema.config.ts b/frontend/src/container/RolesSettings/CreateEditRolePage/components/jsonSchema.config.ts
index 19f38bb5fe..414f00c31e 100644
--- a/frontend/src/container/RolesSettings/CreateEditRolePage/components/jsonSchema.config.ts
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/jsonSchema.config.ts
@@ -76,9 +76,10 @@ function createGrantPermissionAsReadonly(
return {
label: 'readonly',
insertText: resources
- .filter(
- (r) => r.allowedVerbs.includes('read') || r.allowedVerbs.includes('list'),
- )
+ .filter((r) => {
+ const verbs: readonly string[] = r.allowedVerbs;
+ return verbs.includes('read') || verbs.includes('list');
+ })
.flatMap((r) => {
const verbs = r.allowedVerbs.filter((v) => v === 'read' || v === 'list');
return verbs.map(
@@ -103,7 +104,12 @@ function buildResourceSnippets(): SnippetDef[] {
for (const resource of resources) {
const { kind, type, allowedVerbs } = resource;
- snippets.push(createGrantAllPermissionSnippet(kind, allowedVerbs, type));
+ // If only one verb is supported, no point on add grant all
+ // that will only add one permission at time, just leave the verb snippet
+ // and it will look cleaner
+ if (allowedVerbs.length > 1) {
+ snippets.push(createGrantAllPermissionSnippet(kind, allowedVerbs, type));
+ }
for (const verb of allowedVerbs) {
snippets.push(createGrantPermissionToVerbAndKind(kind, verb, type));
diff --git a/frontend/src/container/RolesSettings/CreateEditRolePage/components/useTelemetrySelectorWizard.ts b/frontend/src/container/RolesSettings/CreateEditRolePage/components/useTelemetrySelectorWizard.ts
new file mode 100644
index 0000000000..b3d7abc2ee
--- /dev/null
+++ b/frontend/src/container/RolesSettings/CreateEditRolePage/components/useTelemetrySelectorWizard.ts
@@ -0,0 +1,157 @@
+import { useCallback, useMemo, useState } from 'react';
+
+import {
+ ANY_RESOURCE_VALUE,
+ DEFAULT_QUERY_TYPE,
+ QueryTypeId,
+ QueryTypeOption,
+ SelectorValidation,
+} from './TelemetrySelectorWizard.constants';
+import {
+ buildSelector,
+ getDefaultSelector,
+ getQueryTypeOption,
+ isAnyResourceValue,
+ parseSelector,
+ validateSelector,
+} from './TelemetrySelectorWizard.utils';
+
+interface UseTelemetrySelectorWizardParams {
+ onAdd: (selector: string) => void;
+}
+
+interface UseTelemetrySelectorWizardResult {
+ open: boolean;
+ queryType: QueryTypeId;
+ selectedQueryType: QueryTypeOption | undefined;
+ value: string;
+ selector: string;
+ isAnyResource: boolean;
+ supportsKeyScoping: boolean;
+ validation: SelectorValidation;
+ canAdd: boolean;
+ handleOpenChange: (nextOpen: boolean) => void;
+ handleQueryTypeChange: (value: string | string[]) => void;
+ handleValueChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+ handleAnyResourceChange: (checked: boolean) => void;
+ handleSelectorChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
+ handleAdd: () => void;
+ handleInputKeyDown: (event: React.KeyboardEvent<HTMLInputElement>) => void;
+}
+
+function useTelemetrySelectorWizard({
+ onAdd,
+}: UseTelemetrySelectorWizardParams): UseTelemetrySelectorWizardResult {
+ const [open, setOpen] = useState(false);
+ const [queryType, setQueryType] = useState<QueryTypeId>(DEFAULT_QUERY_TYPE);
+ const [value, setValue] = useState('');
+ const [selector, setSelector] = useState(() =>
+ getDefaultSelector(DEFAULT_QUERY_TYPE),
+ );
+
+ const selectedQueryType = useMemo(
+ () => getQueryTypeOption(queryType),
+ [queryType],
+ );
+ const supportsKeyScoping = selectedQueryType?.supportsKeyScoping ?? false;
+
+ const validation = useMemo(() => validateSelector(selector), [selector]);
+
+ const applyDraft = useCallback(
+ (nextQueryType: QueryTypeId, nextValue: string): void => {
+ setQueryType(nextQueryType);
+ setValue(nextValue);
+ setSelector(buildSelector({ queryType: nextQueryType, value: nextValue }));
+ },
+ [],
+ );
+
+ const handleQueryTypeChange = useCallback(
+ (next: string | string[]): void => {
+ const selected = (Array.isArray(next) ? next[0] : next) as QueryTypeId;
+ const keepsValue = getQueryTypeOption(selected)?.supportsKeyScoping ?? false;
+
+ applyDraft(selected, keepsValue ? value : '');
+ },
+ [applyDraft, value],
+ );
+
+ const handleValueChange = useCallback(
+ (event: React.ChangeEvent<HTMLInputElement>): void => {
+ applyDraft(queryType, event.target.value);
+ },
+ [applyDraft, queryType],
+ );
+
+ const handleAnyResourceChange = useCallback(
+ (checked: boolean): void => {
+ applyDraft(queryType, checked ? ANY_RESOURCE_VALUE : '');
+ },
+ [applyDraft, queryType],
+ );
+
+ const handleSelectorChange = useCallback(
+ (event: React.ChangeEvent<HTMLInputElement>): void => {
+ const nextSelector = event.target.value;
+ setSelector(nextSelector);
+
+ const parsed = parseSelector(nextSelector);
+ if (parsed.queryType) {
+ setQueryType(parsed.queryType);
+ }
+ setValue(parsed.value);
+ },
+ [],
+ );
+
+ const handleOpenChange = useCallback((nextOpen: boolean): void => {
+ setOpen(nextOpen);
+
+ if (!nextOpen) {
+ setQueryType(DEFAULT_QUERY_TYPE);
+ setValue('');
+ setSelector(getDefaultSelector(DEFAULT_QUERY_TYPE));
+ }
+ }, []);
+
+ const handleAdd = useCallback((): void => {
+ const trimmed = selector.trim();
+
+ if (validateSelector(trimmed).isError) {
+ return;
+ }
+
+ onAdd(trimmed);
+ handleOpenChange(false);
+ }, [selector, onAdd, handleOpenChange]);
+
+ const handleInputKeyDown = useCallback(
+ (event: React.KeyboardEvent<HTMLInputElement>): void => {
+ if (event.key === 'Enter') {
+ handleAdd();
+ }
+ },
+ [handleAdd],
+ );
+
+ return {
+ open,
+ queryType,
+ selectedQueryType,
+ value,
+ selector,
+ isAnyResource: isAnyResourceValue(value),
+ supportsKeyScoping,
+ validation,
+ canAdd: !validation.isError,
+ handleOpenChange,
+ handleQueryTypeChange,
+ handleValueChange,
+ handleAnyResourceChange,
+ handleSelectorChange,
+ handleAdd,
+ handleInputKeyDown,
+ };
+}
+
+export default useTelemetrySelectorWizard;
diff --git a/frontend/src/container/RolesSettings/hooks/__tests__/useRolePermissions.test.ts b/frontend/src/container/RolesSettings/hooks/__tests__/useRolePermissions.test.ts
index 22a227575a..df30eaa6f9 100644
--- a/frontend/src/container/RolesSettings/hooks/__tests__/useRolePermissions.test.ts
+++ b/frontend/src/container/RolesSettings/hooks/__tests__/useRolePermissions.test.ts
@@ -329,11 +329,15 @@ describe('transformTransactionGroupsToResourcePermissions', () => {
it('returns all resources from RESOURCE_ORDER even with empty transaction groups', () => {
const result = transformTransactionGroupsToResourcePermissions([]);
- expect(result).toHaveLength(3);
+ expect(result).toHaveLength(7);
expect(result.map((r) => r.resourceKind)).toStrictEqual([
'factor-api-key',
'role',
'serviceaccount',
+ 'logs',
+ 'traces',
+ 'metrics',
+ 'meter-metrics',
]);
});
@@ -414,11 +418,15 @@ describe('createEmptyRolePermissions', () => {
it('creates permissions for all resources in RESOURCE_ORDER', () => {
const result = createEmptyRolePermissions();
- expect(result).toHaveLength(3);
+ expect(result).toHaveLength(7);
expect(result.map((r) => r.resourceKind)).toStrictEqual([
'factor-api-key',
'role',
'serviceaccount',
+ 'logs',
+ 'traces',
+ 'metrics',
+ 'meter-metrics',
]);
});
diff --git a/frontend/src/container/RolesSettings/permissions.config.ts b/frontend/src/container/RolesSettings/permissions.config.ts
index 8a6fe58302..b1ce4b858b 100644
--- a/frontend/src/container/RolesSettings/permissions.config.ts
+++ b/frontend/src/container/RolesSettings/permissions.config.ts
@@ -1,4 +1,12 @@
-import { Bot, Key, Shield } from '@signozhq/icons';
+import {
+ Bot,
+ ChartLine,
+ DraftingCompass,
+ Gauge,
+ Key,
+ Logs,
+ Shield,
+} from '@signozhq/icons';
import permissionsType from 'lib/authz/hooks/useAuthZ/permissions.type';
import {
@@ -14,12 +22,15 @@ type IconComponent = typeof Shield;
const OBJECT_SCOPED_VERB_SET = new Set<string>(OBJECT_SCOPED_VERBS);
+export type SelectorType = 'input' | 'telemetryBuilder';
+
export interface ResourcePanelConfig {
label: string;
description: string;
icon: IconComponent;
selectorPlaceholder: string;
docsAnchor: string;
+ selectorType?: SelectorType;
}
/**
@@ -50,6 +61,42 @@ export const RESOURCE_PANELS: Record<AuthZResource, ResourcePanelConfig> = {
'Type service account ID, separate multiple with comma or space',
docsAnchor: 'service-account',
},
+ logs: {
+ label: 'Logs',
+ description: 'Log data collected across the workspace.',
+ icon: Logs,
+ selectorPlaceholder:
+ 'Enter selector as <query-type>/<key>/<value> or <query-type>/* or use wizard...',
+ docsAnchor: 'logs',
+ selectorType: 'telemetryBuilder',
+ },
+ traces: {
+ label: 'Traces',
+ description: 'Distributed tracing data collected across the workspace.',
+ icon: DraftingCompass,
+ selectorPlaceholder:
+ 'Enter selector as <query-type>/<key>/<value> or <query-type>/* or use wizard...',
+ docsAnchor: 'traces',
+ selectorType: 'telemetryBuilder',
+ },
+ metrics: {
+ label: 'Metrics',
+ description: 'Metric data collected across the workspace.',
+ icon: ChartLine,
+ selectorPlaceholder:
+ 'Enter selector as <query-type>/<key>/<value> or <query-type>/* or use wizard...',
+ docsAnchor: 'metrics',
+ selectorType: 'telemetryBuilder',
+ },
+ 'meter-metrics': {
+ label: 'Meter Metrics',
+ description: 'Usage metering data for the workspace.',
+ icon: Gauge,
+ selectorPlaceholder:
+ 'Enter selector as <query-type>/<key>/<value> or <query-type>/* or use wizard...',
+ docsAnchor: 'meter-metrics',
+ selectorType: 'telemetryBuilder',
+ },
};
export const RESOURCE_ORDER = Object.keys(RESOURCE_PANELS) as AuthZResource[];
diff --git a/frontend/src/container/RoutingPolicies/__tests__/testUtils.ts b/frontend/src/container/RoutingPolicies/__tests__/testUtils.ts
index a75987a08f..1e4ff4356a 100644
--- a/frontend/src/container/RoutingPolicies/__tests__/testUtils.ts
+++ b/frontend/src/container/RoutingPolicies/__tests__/testUtils.ts
@@ -108,6 +108,7 @@ export function getAppContextMockState(
isFetchingHosts: false,
isFetchingFeatureFlags: false,
isFetchingOrgPreferences: false,
+ isFetchingUserPreferences: false,
userFetchError: undefined,
activeLicenseFetchError: null,
hostsFetchError: undefined,
diff --git a/frontend/src/container/SideNav/SideNav.tsx b/frontend/src/container/SideNav/SideNav.tsx
index 67225b3457..bc3595f551 100644
--- a/frontend/src/container/SideNav/SideNav.tsx
+++ b/frontend/src/container/SideNav/SideNav.tsx
@@ -144,6 +144,7 @@ function SideNav({ isPinned }: { isPinned: boolean }): JSX.Element {
trialInfo,
isLoggedIn,
userPreferences,
+ isFetchingUserPreferences,
changelog,
toggleChangelogModal,
updateUserPreferenceInContext,
@@ -261,6 +262,11 @@ function SideNav({ isPinned }: { isPinned: boolean }): JSX.Element {
// Compute initial pinned items and secondary menu items synchronously to avoid flash
const computedPinnedMenuItems = useMemo(() => {
+ // While loading, return empty to avoid flash
+ if (isFetchingUserPreferences) {
+ return [];
+ }
+
const navShortcutsPreference = userPreferences?.find(
(preference) => preference.name === USER_PREFERENCES.NAV_SHORTCUTS,
);
@@ -268,11 +274,6 @@ function SideNav({ isPinned }: { isPinned: boolean }): JSX.Element {
| string[]
| undefined;
- // If userPreferences not loaded yet, return empty to avoid showing defaults before preferences load
- if (userPreferences === null) {
- return [];
- }
-
// If preference exists with non-empty array, use stored shortcuts
if (isArray(navShortcuts) && navShortcuts.length > 0) {
return navShortcuts
@@ -282,9 +283,9 @@ function SideNav({ isPinned }: { isPinned: boolean }): JSX.Element {
.filter((item): item is SidebarItem => item !== undefined);
}
- // No preference, or empty array → use defaults
+ // No preference, or empty array, or error loading → use defaults
return defaultMoreMenuItems.filter((item) => item.isPinned);
- }, [userPreferences]);
+ }, [isFetchingUserPreferences, userPreferences]);
const computedSecondaryMenuItems = useMemo(() => {
const shouldShowIntegrationsValue =
@@ -322,12 +323,16 @@ function SideNav({ isPinned }: { isPinned: boolean }): JSX.Element {
// Sync state only on initial load when userPreferences first becomes available
useEffect(() => {
// Only sync once: when userPreferences loads for the first time
- if (!hasInitializedRef.current && userPreferences !== null) {
+ if (!hasInitializedRef.current && isFetchingUserPreferences === false) {
setPinnedMenuItems(computedPinnedMenuItems);
setSecondaryMenuItems(computedSecondaryMenuItems);
hasInitializedRef.current = true;
}
- }, [computedPinnedMenuItems, computedSecondaryMenuItems, userPreferences]);
+ }, [
+ computedPinnedMenuItems,
+ computedSecondaryMenuItems,
+ isFetchingUserPreferences,
+ ]);
const isChatSupportEnabled = featureFlags?.find(
(flag) => flag.name === FeatureKeys.CHAT_SUPPORT,
diff --git a/frontend/src/lib/authz/components/PermissionDeniedCallout/PermissionDeniedCallout.test.tsx b/frontend/src/lib/authz/components/PermissionDeniedCallout/PermissionDeniedCallout.test.tsx
index 71ebd8b40f..2ce92e965c 100644
--- a/frontend/src/lib/authz/components/PermissionDeniedCallout/PermissionDeniedCallout.test.tsx
+++ b/frontend/src/lib/authz/components/PermissionDeniedCallout/PermissionDeniedCallout.test.tsx
@@ -19,7 +19,7 @@ describe('PermissionDeniedCallout', () => {
it('renders multiple denied permissions', () => {
const deniedPermissions = [
buildPermission('read', buildObjectString('serviceaccount', '*')),
- buildPermission('update', buildObjectString('role', 'admin')),
+ buildPermission('update', buildObjectString<'update'>('role', 'admin')),
];
render(<PermissionDeniedCallout deniedPermissions={deniedPermissions} />);
diff --git a/frontend/src/lib/authz/components/PermissionDeniedFullPage/PermissionDeniedFullPage.test.tsx b/frontend/src/lib/authz/components/PermissionDeniedFullPage/PermissionDeniedFullPage.test.tsx
index f18110e19d..f04b883e74 100644
--- a/frontend/src/lib/authz/components/PermissionDeniedFullPage/PermissionDeniedFullPage.test.tsx
+++ b/frontend/src/lib/authz/components/PermissionDeniedFullPage/PermissionDeniedFullPage.test.tsx
@@ -20,7 +20,7 @@ describe('PermissionDeniedFullPage', () => {
it('renders with multiple denied permissions', () => {
const deniedPermissions = [
buildPermission('read', buildObjectString('role', 'admin')),
- buildPermission('update', buildObjectString('role', 'admin')),
+ buildPermission('update', buildObjectString<'update'>('role', 'admin')),
];
render(<PermissionDeniedFullPage deniedPermissions={deniedPermissions} />);
expect(screen.getByText(/read:role:admin/)).toBeInTheDocument();
diff --git a/frontend/src/lib/authz/hooks/useAuthZ/permissions.type.ts b/frontend/src/lib/authz/hooks/useAuthZ/permissions.type.ts
index ee1bbac209..a6562d4711 100644
--- a/frontend/src/lib/authz/hooks/useAuthZ/permissions.type.ts
+++ b/frontend/src/lib/authz/hooks/useAuthZ/permissions.type.ts
@@ -35,6 +35,26 @@ export default {
'update',
],
},
+ {
+ kind: 'logs',
+ type: 'telemetryresource',
+ allowedVerbs: ['read'],
+ },
+ {
+ kind: 'meter-metrics',
+ type: 'telemetryresource',
+ allowedVerbs: ['read'],
+ },
+ {
+ kind: 'metrics',
+ type: 'telemetryresource',
+ allowedVerbs: ['read'],
+ },
+ {
+ kind: 'traces',
+ type: 'telemetryresource',
+ allowedVerbs: ['read'],
+ },
],
relations: {
assignee: ['role'],
@@ -43,7 +63,7 @@ export default {
delete: ['metaresource', 'role', 'serviceaccount'],
detach: ['metaresource', 'role', 'serviceaccount'],
list: ['metaresource', 'role', 'serviceaccount'],
- read: ['metaresource', 'role', 'serviceaccount'],
+ read: ['metaresource', 'role', 'serviceaccount', 'telemetryresource'],
update: ['metaresource', 'role', 'serviceaccount'],
},
},
diff --git a/frontend/src/lib/authz/hooks/useAuthZ/utils.ts b/frontend/src/lib/authz/hooks/useAuthZ/utils.ts
index 9a02b63c6f..f716fdefd0 100644
--- a/frontend/src/lib/authz/hooks/useAuthZ/utils.ts
+++ b/frontend/src/lib/authz/hooks/useAuthZ/utils.ts
@@ -23,6 +23,40 @@ export function buildPermission<R extends AuthZRelation>(
return `${relation}${PermissionSeparator}${object}` as BrandedPermission;
}
+/**
+ * Builds an object string for use with `buildPermission`.
+ *
+ * ## Type Inference Behavior
+ *
+ * TypeScript infers `R` from `resource`. If a resource belongs to multiple relations,
+ * the return type becomes a union of all matching `AuthZObject` types.
+ *
+ * Example: 'role' is valid for 'read', 'update', 'delete', 'assignee'.
+ * Without explicit generic, return type = `AuthZObject<'read' | 'update' | 'delete' | 'assignee'>`.
+ *
+ * ## When to specify explicit generic
+ *
+ * **Needed** when resource belongs to multiple relations AND you pass result to `buildPermission`
+ * with a relation that has FEWER valid resources than others:
+ *
+ * ```ts
+ * // ERROR: 'read' includes telemetry resources, 'update' does not
+ * buildPermission('update', buildObjectString('role', 'admin'))
+ *
+ * // OK: explicit generic narrows return type
+ * buildPermission('update', buildObjectString<'update'>('role', 'admin'))
+ * ```
+ *
+ * **Not needed** when:
+ * - Resource only belongs to one relation in the constraint
+ * - Using with 'read' relation (widest type, accepts all)
+ * - Storing in a variable typed as `BrandedPermission` (already opaque)
+ *
+ * ```ts
+ * // OK: 'read' is widest, accepts union return type
+ * buildPermission('read', buildObjectString('role', 'admin'))
+ * ```
+ */
export function buildObjectString<
R extends 'delete' | 'read' | 'update' | 'assignee',
>(resource: ResourcesForRelation<R>, objectId: string): AuthZObject<R> {
diff --git a/frontend/src/providers/App/App.tsx b/frontend/src/providers/App/App.tsx
index 43afca6c0f..ded917d343 100644
--- a/frontend/src/providers/App/App.tsx
+++ b/frontend/src/providers/App/App.tsx
@@ -434,6 +434,7 @@ export function AppProvider({ children }: PropsWithChildren): JSX.Element {
isFetchingHosts,
isFetchingFeatureFlags,
isFetchingOrgPreferences,
+ isFetchingUserPreferences,
userFetchError,
activeLicenseFetchError,
hostsFetchError,
@@ -464,6 +465,7 @@ export function AppProvider({ children }: PropsWithChildren): JSX.Element {
isFetchingHosts,
isFetchingFeatureFlags,
isFetchingOrgPreferences,
+ isFetchingUserPreferences,
isFetchingUser,
isLoggedIn,
hostsData,
diff --git a/frontend/src/providers/App/types.ts b/frontend/src/providers/App/types.ts
index 509978b72c..1f1d1a85f4 100644
--- a/frontend/src/providers/App/types.ts
+++ b/frontend/src/providers/App/types.ts
@@ -27,6 +27,7 @@ export interface IAppContext {
isFetchingHosts: boolean;
isFetchingFeatureFlags: boolean;
isFetchingOrgPreferences: boolean;
+ isFetchingUserPreferences: boolean;
userFetchError: unknown;
activeLicenseFetchError: APIError | null;
hostsFetchError: unknown;
diff --git a/frontend/src/tests/test-utils.tsx b/frontend/src/tests/test-utils.tsx
index 2f2a4e8ce2..a1307d0fde 100644
--- a/frontend/src/tests/test-utils.tsx
+++ b/frontend/src/tests/test-utils.tsx
@@ -242,6 +242,7 @@ export function getAppContextMock(
userPreferences: [],
updateUserPreferenceInContext: jest.fn(),
isFetchingOrgPreferences: false,
+ isFetchingUserPreferences: false,
orgPreferencesFetchError: null,
isLoggedIn: true,
isPreflightLoading: false,
diff --git a/frontend/src/utils/permission/index.ts b/frontend/src/utils/permission/index.ts
index f2af7c2fd7..c6fbd931b6 100644
--- a/frontend/src/utils/permission/index.ts
+++ b/frontend/src/utils/permission/index.ts
@@ -23,6 +23,11 @@ export type ComponentTypes =
| 'add_panel_locked_dashboard'
| 'manage_llm_pricing';
+/**
+ * @deprecated Before adding a new value here, check if what you want to add permission is supported by authz.
+ * If so, read AuthZ Guidelines on how to add permission check via AuthZ.
+ * If not, you can keep adding to this record.
+ */
export const componentPermission: Record<ComponentTypes, ROLES[]> = {
current_org_settings: ['ADMIN'],
invite_members: ['ADMIN'],
@@ -46,11 +51,16 @@ export const componentPermission: Record<ComponentTypes, ROLES[]> = {
manage_llm_pricing: ['ADMIN'],
};
+/**
+ * @deprecated You can still add new permissions/routes here but be aware if this page/module supports authz.
+ * If so, also implement the correct authz checks in the page itself, and here you can add ADMIN/EDITOR/VIEWER,
+ * and also update/include the route at {@link routeWithInitialAuthZSupport}
+ */
export const routePermission: Record<keyof typeof ROUTES, ROLES[]> = {
HOME: ['ADMIN', 'EDITOR', 'VIEWER'],
ALERTS_NEW: ['ADMIN', 'EDITOR'],
ORG_SETTINGS: ['ADMIN'],
- MY_SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
+ MY_SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER'],
SERVICE_MAP: ['ADMIN', 'EDITOR', 'VIEWER'],
ALL_CHANNELS: ['ADMIN', 'EDITOR', 'VIEWER'],
INGESTION_SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER'],
@@ -75,13 +85,15 @@ export const routePermission: Record<keyof typeof ROUTES, ROLES[]> = {
NOT_FOUND: ['ADMIN', 'VIEWER', 'EDITOR', 'ANONYMOUS'],
PASSWORD_RESET: ['ADMIN', 'EDITOR', 'VIEWER'],
SERVICE_METRICS: ['ADMIN', 'EDITOR', 'VIEWER'],
- SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
+ SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER'],
SIGN_UP: ['ADMIN', 'EDITOR', 'VIEWER'],
TRACES_EXPLORER: ['ADMIN', 'EDITOR', 'VIEWER'],
TRACE: ['ADMIN', 'EDITOR', 'VIEWER'],
TRACE_DETAIL: ['ADMIN', 'EDITOR', 'VIEWER'],
TRACE_DETAIL_OLD: ['ADMIN', 'EDITOR', 'VIEWER'],
- UN_AUTHORIZED: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
+ // Every role must be able to land here - a role missing from this list is
+ // redirected to /un-authorized and then redirected off it again, looping.
+ UN_AUTHORIZED: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS', 'AUTHOR'],
USAGE_EXPLORER: ['ADMIN', 'EDITOR', 'VIEWER'],
VERSION: ['ADMIN', 'EDITOR', 'VIEWER'],
LOGS: ['ADMIN', 'EDITOR', 'VIEWER'],
@@ -95,12 +107,12 @@ export const routePermission: Record<keyof typeof ROUTES, ROLES[]> = {
GET_STARTED_WITH_CLOUD: ['ADMIN', 'EDITOR'],
WORKSPACE_LOCKED: ['ADMIN', 'EDITOR', 'VIEWER'],
WORKSPACE_SUSPENDED: ['ADMIN', 'EDITOR', 'VIEWER'],
- ROLES_SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
- ROLE_CREATE: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
- ROLE_DETAILS: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
- ROLE_EDIT: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
+ ROLES_SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER'],
+ ROLE_CREATE: ['ADMIN', 'EDITOR', 'VIEWER'],
+ ROLE_DETAILS: ['ADMIN', 'EDITOR', 'VIEWER'],
+ ROLE_EDIT: ['ADMIN', 'EDITOR', 'VIEWER'],
MEMBERS_SETTINGS: ['ADMIN'],
- SERVICE_ACCOUNTS_SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
+ SERVICE_ACCOUNTS_SETTINGS: ['ADMIN', 'EDITOR', 'VIEWER'],
BILLING: ['ADMIN'],
SUPPORT: ['ADMIN', 'EDITOR', 'VIEWER', 'ANONYMOUS'],
SOMETHING_WENT_WRONG: ['ADMIN', 'EDITOR', 'VIEWER'],
@@ -141,3 +153,34 @@ export const routePermission: Record<keyof typeof ROUTES, ROLES[]> = {
AI_OBSERVABILITY_OVERVIEW: ['ADMIN', 'EDITOR', 'VIEWER'],
AI_OBSERVABILITY_CONFIGURATION: ['ADMIN', 'EDITOR', 'VIEWER'],
};
+
+/**
+ * Any route that will start be supported under AuthZ should be added here.
+ * This will help correctly identify when fallback to show the page
+ * or just return unauthorized.
+ *
+ * This prevents us from adding `ANONYMOUS` on the `routePermission`
+ */
+export const routeWithInitialAuthZSupport = {
+ MY_SETTINGS: true,
+ SETTINGS: true,
+ TRACES_EXPLORER: true,
+ TRACE: true,
+ TRACE_DETAIL: true,
+ TRACE_DETAIL_OLD: true,
+ LOGS: true,
+ LOGS_EXPLORER: true,
+ LIVE_LOGS: true,
+ ROLES_SETTINGS: true,
+ ROLE_CREATE: true,
+ ROLE_DETAILS: true,
+ ROLE_EDIT: true,
+ SERVICE_ACCOUNTS_SETTINGS: true,
+ SUPPORT: true,
+ OLD_LOGS_EXPLORER: true,
+ METRICS_EXPLORER: true,
+ METRICS_EXPLORER_EXPLORER: true,
+ METRICS_EXPLORER_VOLUME_CONTROL: true,
+ METER_EXPLORER: true,
+ METER: true,
+} as const satisfies Partial<Record<keyof typeof ROUTES, true>>;
diff --git a/pkg/signoz/provider.go b/pkg/signoz/provider.go
index 95070932c7..07aa4554ca 100644
--- a/pkg/signoz/provider.go
+++ b/pkg/signoz/provider.go
@@ -230,6 +230,7 @@ func NewSQLMigrationProviderFactories(
sqlmigration.NewAddTagRelationRankFactory(sqlstore, sqlschema),
sqlmigration.NewMigrateDashboardsV1ToV2Factory(sqlstore, sqlschema, dashboardStore, tagModule),
sqlmigration.NewFillDashboardMeterSourceFactory(sqlstore, dashboardStore),
+ sqlmigration.NewUpdateRoleTransactionGroupsFactory(),
)
}
diff --git a/pkg/sqlmigration/105_update_role_transaction_groups.go b/pkg/sqlmigration/105_update_role_transaction_groups.go
new file mode 100644
index 0000000000..64517c1599
--- /dev/null
+++ b/pkg/sqlmigration/105_update_role_transaction_groups.go
@@ -0,0 +1,77 @@
+package sqlmigration
+
+import (
+ "context"
+ "database/sql"
+ "encoding/json"
+
+ "github.com/SigNoz/signoz/pkg/factory"
+ "github.com/SigNoz/signoz/pkg/types/authtypes"
+ "github.com/SigNoz/signoz/pkg/types/coretypes"
+ "github.com/uptrace/bun"
+ "github.com/uptrace/bun/migrate"
+)
+
+type updateRoleTransactionGroups struct{}
+
+func NewUpdateRoleTransactionGroupsFactory() factory.ProviderFactory[SQLMigration, Config] {
+ return factory.NewProviderFactory(
+ factory.MustNewName("update_role_transaction_groups"),
+ func(ctx context.Context, ps factory.ProviderSettings, c Config) (SQLMigration, error) {
+ return &updateRoleTransactionGroups{}, nil
+ },
+ )
+}
+
+func (migration *updateRoleTransactionGroups) Register(migrations *migrate.Migrations) error {
+ return migrations.Register(migration.Up, migration.Down)
+}
+
+func (migration *updateRoleTransactionGroups) Up(ctx context.Context, db *bun.DB) error {
+ tx, err := db.BeginTx(ctx, nil)
+ if err != nil {
+ return err
+ }
+
+ defer func() {
+ _ = tx.Rollback()
+ }()
+
+ var orgIDs []string
+ err = tx.NewSelect().
+ Table("organizations").
+ Column("id").
+ Scan(ctx, &orgIDs)
+ if err != nil && err != sql.ErrNoRows {
+ return err
+ }
+
+ managedRoleGroups := make(map[string]string, len(coretypes.ManagedRoleToTransactions))
+ for roleName, transactions := range coretypes.ManagedRoleToTransactions {
+ data, err := json.Marshal(authtypes.NewTransactionGroupsFromTransactions(transactions))
+ if err != nil {
+ return err
+ }
+ managedRoleGroups[roleName] = string(data)
+ }
+
+ for _, orgID := range orgIDs {
+ for roleName, data := range managedRoleGroups {
+ if _, err := tx.NewUpdate().
+ Model(new(roles)).
+ Set("transaction_groups = ?", data).
+ Where("org_id = ?", orgID).
+ Where("type = ?", authtypes.RoleTypeManaged.StringValue()).
+ Where("name = ?", roleName).
+ Exec(ctx); err != nil {
+ return err
+ }
+ }
+ }
+
+ return tx.Commit()
+}
+
+func (migration *updateRoleTransactionGroups) Down(context.Context, *bun.DB) error {
+ return nil
+}