1#@!#!123s

: / usr / share / grafana / public / app / features / dashboard / utils /
Filename : getRefreshFromUrl.ts
back
import { defaultIntervals } from '@grafana/ui';

interface Args {
  urlRefresh: string | null;
  currentRefresh: string | false | undefined;
  isAllowedIntervalFn: (interval: string) => boolean;
  minRefreshInterval: string;
  refreshIntervals?: string[];
}

// getRefreshFromUrl function returns the value from the supplied &refresh= param in url.
// If the supplied interval is not allowed or does not exist in the refresh intervals for the dashboard then we
// try to find the first refresh interval that matches the minRefreshInterval (min_refresh_interval in ini)
// or just take the first interval.
export function getRefreshFromUrl({
  urlRefresh,
  currentRefresh,
  isAllowedIntervalFn,
  minRefreshInterval,
  refreshIntervals = defaultIntervals,
}: Args): string | false | undefined {
  if (!urlRefresh) {
    return currentRefresh;
  }

  const isAllowedInterval = isAllowedIntervalFn(urlRefresh);
  const isExistingInterval = refreshIntervals.find((interval) => interval === urlRefresh);

  if (!isAllowedInterval || !isExistingInterval) {
    const minRefreshIntervalInIntervals = minRefreshInterval
      ? refreshIntervals.find((interval) => interval === minRefreshInterval)
      : undefined;
    const lowestRefreshInterval = refreshIntervals?.length ? refreshIntervals[0] : undefined;

    return minRefreshIntervalInIntervals ?? lowestRefreshInterval ?? currentRefresh;
  }

  return urlRefresh || currentRefresh;
}