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.

8.1 KB
Raw Blame
import React, { useCallback, useMemo } from 'react';
import { KeyRound, X } from '@signozhq/icons';
import { Pagination, Skeleton, Table, Tooltip } from 'antd';
import type { ColumnsType } from 'antd/es/table/interface';
import type { ServiceaccounttypesGettableFactorAPIKeyDTO } from 'api/generated/services/sigNoz.schemas';
import AuthZButton from 'lib/authz/components/AuthZButton/AuthZButton';
import { withAuthZContent } from 'lib/authz/components/withAuthZ/withAuthZContent';
import {
	APIKeyCreatePermission,
	APIKeyListPermission,
	buildAPIKeyDeletePermission,
	buildSAAttachPermission,
	buildSADetachPermission,
} from 'lib/authz/hooks/useAuthZ/permissions/service-account.permissions';
import { DATE_TIME_FORMATS } from 'constants/dateTimeFormats';
import dayjs from 'dayjs';
import { parseAsBoolean, parseAsString, useQueryState } from 'nuqs';
import { useTimezone } from 'providers/Timezone';

import EditKeyModal from './EditKeyModal';
import RevokeKeyModal from './RevokeKeyModal';
import { formatLastObservedAt } from './utils';

interface KeysTabProps {
	keys: ServiceaccounttypesGettableFactorAPIKeyDTO[];
	isLoading: boolean;
	isDisabled?: boolean;
	accountId?: string;
	currentPage: number;
	pageSize: number;
	onPageChange: (page: number) => void;
}

interface BuildColumnsParams {
	isDisabled: boolean;
	accountId: string;
	onRevokeClick: (keyId: string) => void;
	handleformatLastObservedAt: (
		lastObservedAt: Date | null | undefined,
	) => string;
}

function formatExpiry(expiresAt: number): JSX.Element {
	if (expiresAt === 0) {
		return <span className="keys-tab__expiry--never">Never</span>;
	}
	const expiryDate = dayjs.unix(expiresAt);
	if (expiryDate.isBefore(dayjs())) {
		return <span className="keys-tab__expiry--expired">Expired</span>;
	}
	return <span>{expiryDate.format(DATE_TIME_FORMATS.MONTH_DATE)}</span>;
}

function buildColumns({
	isDisabled,
	accountId,
	onRevokeClick,
	handleformatLastObservedAt,
}: BuildColumnsParams): ColumnsType<ServiceaccounttypesGettableFactorAPIKeyDTO> {
	return [
		{
			title: 'Name',
			dataIndex: 'name',
			key: 'name',
			className: 'keys-tab__name-column',
			sorter: (a, b): number => (a.name ?? '').localeCompare(b.name ?? ''),
			render: (_, record): JSX.Element => (
				<span className="keys-tab__name-text">{record.name ?? '—'}</span>
			),
		},
		{
			title: 'Expiry',
			dataIndex: 'expiresAt',
			key: 'expiry',
			width: 160,
			align: 'right' as const,
			sorter: (a, b): number => {
				const aVal = a.expiresAt === 0 ? Infinity : a.expiresAt;
				const bVal = b.expiresAt === 0 ? Infinity : b.expiresAt;
				return aVal - bVal;
			},
			render: (expiresAt: number): JSX.Element => formatExpiry(expiresAt),
		},
		{
			title: 'Last Observed At',
			dataIndex: 'lastObservedAt',
			key: 'lastObservedAt',
			width: 220,
			align: 'right' as const,
			sorter: (a, b): number => {
				const aVal = a.lastObservedAt
					? new Date(a.lastObservedAt).getTime()
					: -Infinity;
				const bVal = b.lastObservedAt
					? new Date(b.lastObservedAt).getTime()
					: -Infinity;
				return aVal - bVal;
			},
			render: (lastObservedAt: Date | null | undefined): string =>
				handleformatLastObservedAt(lastObservedAt),
		},
		{
			title: '',
			key: 'action',
			width: 48,
			align: 'right' as const,
			onCell: (): {
				onClick: (e: React.MouseEvent) => void;
				style: React.CSSProperties;
			} => ({
				onClick: (e): void => e.stopPropagation(),
				style: { cursor: 'default' },
			}),
			render: (_, record): JSX.Element => {
				return (
					<Tooltip title={isDisabled ? undefined : 'Revoke Key'} placement="bottom">
						<AuthZButton
							checks={[
								buildAPIKeyDeletePermission(record.id),
								buildSADetachPermission(accountId),
							]}
							authZEnabled={!isDisabled && !!accountId}
							variant="solid"
							size="sm"
							color="danger"
							icon
							aria-label="Revoke Key"
							disabled={isDisabled}
							disabledTooltip={isDisabled ? 'Service account disabled' : undefined}
							onClick={(e): void => {
								e.stopPropagation();
								onRevokeClick(record.id);
							}}
							testId="keys-tab-revoke-btn"
						>
							<X size={12} />
						</AuthZButton>
					</Tooltip>
				);
			},
		},
	];
}

function KeysTab({
	keys,
	isLoading,
	isDisabled = false,
	accountId = '',
	currentPage,
	pageSize,
	onPageChange,
}: KeysTabProps): JSX.Element {
	const [, setIsAddKeyOpen] = useQueryState(
		'add-key',
		parseAsBoolean.withDefault(false),
	);
	const { formatTimezoneAdjustedTimestamp } = useTimezone();
	const [editKeyId, setEditKeyId] = useQueryState(
		'edit-key',
		parseAsString.withDefault(''),
	);
	const [, setRevokeKeyId] = useQueryState(
		'revoke-key',
		parseAsString.withDefault(''),
	);
	const editKey = keys.find((k) => k.id === editKeyId) ?? null;

	const handleformatLastObservedAt = useCallback(
		(lastObservedAt: Date | null | undefined): string =>
			formatLastObservedAt(lastObservedAt, formatTimezoneAdjustedTimestamp),
		[formatTimezoneAdjustedTimestamp],
	);

	const onRevokeClick = useCallback(
		(keyId: string): void => {
			void setRevokeKeyId(keyId);
		},
		[setRevokeKeyId],
	);

	const columns = useMemo(
		() =>
			buildColumns({
				isDisabled,
				accountId,
				onRevokeClick,
				handleformatLastObservedAt,
			}),
		[isDisabled, accountId, onRevokeClick, handleformatLastObservedAt],
	);

	if (isLoading) {
		return (
			<div className="keys-tab__loading">
				<Skeleton active paragraph={{ rows: 4 }} />
			</div>
		);
	}

	if (keys.length === 0) {
		return (
			<div className="keys-tab__empty">
				<KeyRound size={24} className="keys-tab__empty-icon" />
				<p className="keys-tab__empty-text">
					No keys. Start by creating one.{' '}
					<a
						href="https://signoz.io/docs/manage/administrator-guide/iam/service-accounts/#step-3-generate-an-api-key"
						target="_blank"
						rel="noopener noreferrer"
						className="keys-tab__learn-more"
					>
						Learn more
					</a>
				</p>
				<AuthZButton
					size="md"
					checks={[APIKeyCreatePermission, buildSAAttachPermission(accountId)]}
					authZEnabled={!isDisabled && !!accountId}
					variant="link"
					color="primary"
					onClick={async (): Promise<void> => {
						await setIsAddKeyOpen(true);
					}}
					disabled={isDisabled}
				>
					+ Add your first key
				</AuthZButton>
			</div>
		);
	}

	return (
		<>
			{/* Todo: use new table component from periscope when ready */}
			<Table<ServiceaccounttypesGettableFactorAPIKeyDTO>
				columns={columns}
				dataSource={keys}
				rowKey="id"
				pagination={{
					style: { display: 'none' },
					current: currentPage,
					pageSize,
				}}
				showSorterTooltip={false}
				className={`keys-tab__table${
					isDisabled ? ' keys-tab__table--disabled' : ''
				}`}
				rowClassName={(_, index): string =>
					index % 2 === 0 ? 'keys-tab__table-row--alt' : ''
				}
				onRow={(
					record,
				): {
					onClick: () => void;
					onKeyDown: (e: React.KeyboardEvent) => void;
					role: string;
					tabIndex: number;
					'aria-label': string;
				} => ({
					onClick: async (): Promise<void> => {
						if (!isDisabled) {
							await setEditKeyId(record.id);
						}
					},
					onKeyDown: async (e: React.KeyboardEvent): Promise<void> => {
						if ((e.key === 'Enter' || e.key === ' ') && !isDisabled) {
							if (e.key === ' ') {
								e.preventDefault();
							}
							await setEditKeyId(record.id);
						}
					},
					role: 'button',
					tabIndex: 0,
					'aria-label': `Edit key ${record.name || 'options'}`,
				})}
			/>

			<Pagination
				current={currentPage}
				pageSize={pageSize}
				total={keys.length}
				showTotal={(total: number, range: number[]): JSX.Element => (
					<>
						<span className="sa-drawer__pagination-range">
							{range[0]} &#8212; {range[1]}
						</span>
						<span className="sa-drawer__pagination-total"> of {total}</span>
					</>
				)}
				showSizeChanger={false}
				hideOnSinglePage
				onChange={onPageChange}
				className="sa-drawer__keys-pagination"
			/>

			<EditKeyModal keyItem={editKey} />

			<RevokeKeyModal />
		</>
	);
}

export default withAuthZContent(KeysTab, {
	checks: [APIKeyListPermission],
	fallbackOnLoading: <Skeleton active paragraph={{ rows: 6 }} />,
});