refreshIfNeeded method

Future<SecurityResult<String>> refreshIfNeeded(
  1. TokenRefresher refresher, {
  2. Duration? buffer,
  3. bool force = false,
  4. bool requireRefreshToken = true,
})

Returns a usable access token, refreshing it first when necessary.

  • Concurrent calls share a single refresh: refresher runs once and every caller gets the same result.
  • A throwing refresher yields Failure(TokenException) with code TokenException.refreshFailed; the stored tokens are left untouched and a later call may try again.
  • With requireRefreshToken (default) a missing refresh token fails with TokenException.noRefreshToken without calling refresher.
  • force refreshes even when the current token is still valid.

Implementation

Future<SecurityResult<String>> refreshIfNeeded(
  TokenRefresher refresher, {
  Duration? buffer,
  bool force = false,
  bool requireRefreshToken = true,
}) {
  final running = _inFlight;
  if (running != null) return running;

  final future = _refresh(
    refresher,
    buffer: buffer,
    force: force,
    requireRefreshToken: requireRefreshToken,
  );
  _inFlight = future;
  future.whenComplete(() {
    if (identical(_inFlight, future)) _inFlight = null;
  });
  return future;
}