Alerting: Swap useAsync return signature params (#91634)

This commit is contained in:
Gilles De Mey 2024-08-07 17:58:07 +02:00 committed by GitHub
parent 9cfcc16d1a
commit d312e2aacf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 16 additions and 16 deletions

View File

@ -25,7 +25,7 @@ interface Props {
*/
const MenuItemPauseRule = ({ rule, onPauseChange }: Props) => {
const notifyApp = useAppNotification();
const [updateState, pauseRule] = usePauseRuleInGroup();
const [pauseRule, updateState] = usePauseRuleInGroup();
const isPaused = isGrafanaRulerRule(rule.rulerRule) && isGrafanaRulerRulePaused(rule.rulerRule);
const icon = isPaused ? 'play' : 'pause';

View File

@ -66,7 +66,7 @@ export const AlertRuleForm = ({ existing, prefill }: Props) => {
const [queryParams] = useQueryParams();
const [showEditYaml, setShowEditYaml] = useState(false);
const [evaluateEvery, setEvaluateEvery] = useState(existing?.group.interval ?? DEFAULT_GROUP_EVALUATION_INTERVAL);
const [_deleteRuleState, deleteRuleFromGroup] = useDeleteRuleFromGroup();
const [deleteRuleFromGroup] = useDeleteRuleFromGroup();
const routeParams = useParams<{ type: string; id: string }>();
const ruleType = translateRouteParamToRuleType(routeParams.type);

View File

@ -13,7 +13,7 @@ type DeleteModalHook = [JSX.Element, (rule: CombinedRule) => void, () => void];
export const useDeleteModal = (redirectToListView = false): DeleteModalHook => {
const [ruleToDelete, setRuleToDelete] = useState<CombinedRule | undefined>();
const [_deleteState, deleteRuleFromGroup] = useDeleteRuleFromGroup();
const [deleteRuleFromGroup] = useDeleteRuleFromGroup();
const dismissModal = useCallback(() => {
setRuleToDelete(undefined);

View File

@ -192,9 +192,9 @@ export function EditCloudGroupModal(props: ModalProps): React.ReactElement {
* 2. rename the rule group, but keeping it in the same namespace
* 3. move the rule group to a new namespace, optionally with a different group name
*/
const [updateRuleGroupState, updateRuleGroup] = useUpdateRuleGroupConfiguration();
const [renameRuleGroupState, renameRuleGroup] = useRenameRuleGroup();
const [moveRuleGroupState, moveRuleGroup] = useMoveRuleGroup();
const [updateRuleGroup, updateRuleGroupState] = useUpdateRuleGroupConfiguration();
const [renameRuleGroup, renameRuleGroupState] = useRenameRuleGroup();
const [moveRuleGroup, moveRuleGroupState] = useMoveRuleGroup();
const { loading, error } = anyOfRequestState(updateRuleGroupState, moveRuleGroupState, renameRuleGroupState);

View File

@ -132,7 +132,7 @@ type DeleteTestComponentProps = {
rule: CombinedRule;
};
const DeleteTestComponent = ({ rule }: DeleteTestComponentProps) => {
const [requestState, deleteRuleFromGroup] = useDeleteRuleFromGroup();
const [deleteRuleFromGroup, requestState] = useDeleteRuleFromGroup();
// always handle your errors!
const ruleGroupID = getRuleGroupLocationFromCombinedRule(rule);

View File

@ -76,7 +76,7 @@ describe('pause rule', () => {
// this test component will cycle through the loading states
const PauseTestComponent = (options: { rulerRule?: RulerGrafanaRuleDTO }) => {
const [requestState, pauseRule] = usePauseRuleInGroup();
const [pauseRule, requestState] = usePauseRuleInGroup();
const rulerRule = options.rulerRule ?? grafanaRulerRule;
const rule = mockCombinedRule({

View File

@ -85,7 +85,7 @@ describe('useUpdateRuleGroupConfiguration', () => {
});
const UpdateRuleGroupComponent = () => {
const [requestState, updateRuleGroup] = useUpdateRuleGroupConfiguration();
const [updateRuleGroup, requestState] = useUpdateRuleGroupConfiguration();
const ruleGroupID: RuleGroupIdentifier = {
dataSourceName: GRAFANA_RULES_SOURCE_NAME,
@ -102,7 +102,7 @@ const UpdateRuleGroupComponent = () => {
};
const RenameRuleGroupComponent = ({ group = 'another-group-name' }: { group?: string }) => {
const [requestState, renameRuleGroup] = useRenameRuleGroup();
const [renameRuleGroup, requestState] = useRenameRuleGroup();
const ruleGroupID: RuleGroupIdentifier = {
dataSourceName: GRAFANA_RULES_SOURCE_NAME,
@ -119,7 +119,7 @@ const RenameRuleGroupComponent = ({ group = 'another-group-name' }: { group?: st
};
const MoveGrafanaManagedRuleGroupComponent = () => {
const [requestState, moveRuleGroup] = useMoveRuleGroup();
const [moveRuleGroup, requestState] = useMoveRuleGroup();
const ruleGroupID: RuleGroupIdentifier = {
dataSourceName: GRAFANA_RULES_SOURCE_NAME,
@ -146,7 +146,7 @@ const MoveDataSourceManagedRuleGroupComponent = ({
group,
interval,
}: MoveDataSourceManagedRuleGroupComponentProps) => {
const [requestState, moveRuleGroup] = useMoveRuleGroup();
const [moveRuleGroup, requestState] = useMoveRuleGroup();
const ruleGroupID: RuleGroupIdentifier = {
dataSourceName: MIMIR_DATASOURCE_UID,

View File

@ -54,11 +54,11 @@ export type UseAsyncMeta<Result, Args extends unknown[] = unknown[]> = {
export function useAsync<Result, Args extends unknown[] = unknown[]>(
asyncFn: (...params: Args) => Promise<Result>,
initialValue: Result
): [AsyncState<Result>, UseAsyncActions<Result, Args>, UseAsyncMeta<Result, Args>];
): [UseAsyncActions<Result, Args>, AsyncState<Result>, UseAsyncMeta<Result, Args>];
export function useAsync<Result, Args extends unknown[] = unknown[]>(
asyncFn: (...params: Args) => Promise<Result>,
initialValue?: Result
): [AsyncState<Result | undefined>, UseAsyncActions<Result, Args>, UseAsyncMeta<Result, Args>];
): [UseAsyncActions<Result, Args>, AsyncState<Result | undefined>, UseAsyncMeta<Result, Args>];
/**
* Tracks the result and errors of the provided async function and provides handles to control its execution.
@ -70,7 +70,7 @@ export function useAsync<Result, Args extends unknown[] = unknown[]>(
export function useAsync<Result, Args extends unknown[] = unknown[]>(
asyncFn: (...params: Args) => Promise<Result>,
initialValue?: Result
): [AsyncState<Result | undefined>, UseAsyncActions<Result, Args>, UseAsyncMeta<Result, Args>] {
): [UseAsyncActions<Result, Args>, AsyncState<Result | undefined>, UseAsyncMeta<Result, Args>] {
const [state, setState] = useState<AsyncState<Result | undefined>>({
status: 'not-executed',
error: undefined,
@ -119,7 +119,6 @@ export function useAsync<Result, Args extends unknown[] = unknown[]>(
});
return [
state,
useMemo(
() => ({
reset() {
@ -130,6 +129,7 @@ export function useAsync<Result, Args extends unknown[] = unknown[]>(
// eslint-disable-next-line react-hooks/exhaustive-deps
[]
),
state,
{ promise: promiseRef.current, lastArgs: argsRef.current },
];
}