module Session.Timing.Timeout
  ( Timeout (..)
  , defaultTimeout
  ) where

import Internal.Prelude

import Time

-- | How long sessions are allowed to live
--
-- See 'defaultTimeout'.
data Timeout a = Timeout
  { forall a. Timeout a -> Maybe a
idle :: Maybe a
  -- ^ The amount of time a session will remain active in case there
  --   is no activity in the session
  --
  -- This is used both on the client side (by setting the cookie expires fields)
  -- and on the server.
  --
  -- Setting to 'Nothing' removes the idle timeout.
  , forall a. Timeout a -> Maybe a
absolute :: Maybe a
  -- ^ The maximum amount of time a session can be active
  --
  -- This is used both on the client side (by setting the cookie expires fields)
  -- and on the server side.
  --
  -- Setting to 'Nothing' removes the absolute timeout.
  }
  deriving stock (Timeout a -> Timeout a -> Bool
(Timeout a -> Timeout a -> Bool)
-> (Timeout a -> Timeout a -> Bool) -> Eq (Timeout a)
forall a. Eq a => Timeout a -> Timeout a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: forall a. Eq a => Timeout a -> Timeout a -> Bool
== :: Timeout a -> Timeout a -> Bool
$c/= :: forall a. Eq a => Timeout a -> Timeout a -> Bool
/= :: Timeout a -> Timeout a -> Bool
Eq, Int -> Timeout a -> ShowS
[Timeout a] -> ShowS
Timeout a -> String
(Int -> Timeout a -> ShowS)
-> (Timeout a -> String)
-> ([Timeout a] -> ShowS)
-> Show (Timeout a)
forall a. Show a => Int -> Timeout a -> ShowS
forall a. Show a => [Timeout a] -> ShowS
forall a. Show a => Timeout a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: forall a. Show a => Int -> Timeout a -> ShowS
showsPrec :: Int -> Timeout a -> ShowS
$cshow :: forall a. Show a => Timeout a -> String
show :: Timeout a -> String
$cshowList :: forall a. Show a => [Timeout a] -> ShowS
showList :: [Timeout a] -> ShowS
Show, (forall x. Timeout a -> Rep (Timeout a) x)
-> (forall x. Rep (Timeout a) x -> Timeout a)
-> Generic (Timeout a)
forall x. Rep (Timeout a) x -> Timeout a
forall x. Timeout a -> Rep (Timeout a) x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
forall a x. Rep (Timeout a) x -> Timeout a
forall a x. Timeout a -> Rep (Timeout a) x
$cfrom :: forall a x. Timeout a -> Rep (Timeout a) x
from :: forall x. Timeout a -> Rep (Timeout a) x
$cto :: forall a x. Rep (Timeout a) x -> Timeout a
to :: forall x. Rep (Timeout a) x -> Timeout a
Generic, (forall a b. (a -> b) -> Timeout a -> Timeout b)
-> (forall a b. a -> Timeout b -> Timeout a) -> Functor Timeout
forall a b. a -> Timeout b -> Timeout a
forall a b. (a -> b) -> Timeout a -> Timeout b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall a b. (a -> b) -> Timeout a -> Timeout b
fmap :: forall a b. (a -> b) -> Timeout a -> Timeout b
$c<$ :: forall a b. a -> Timeout b -> Timeout a
<$ :: forall a b. a -> Timeout b -> Timeout a
Functor)

instance Arbitrary a => Arbitrary (Timeout a) where
  arbitrary :: Gen (Timeout a)
arbitrary = Gen (Timeout a)
forall a (ga :: * -> *) (some :: Bool).
(Generic a, GArbitrary a ga some, ga ~ Rep a) =>
Gen a
genericArbitrary
  shrink :: Timeout a -> [Timeout a]
shrink = Timeout a -> [Timeout a]
forall a.
(Generic a, RecursivelyShrink (Rep a), GSubterms (Rep a) a) =>
a -> [a]
genericShrink

-- | Default timeouts
--
--   - idle = 8 hours
--   - absolute = 30 days
defaultTimeout :: Timeout NominalDiffTime
defaultTimeout :: Timeout NominalDiffTime
defaultTimeout =
  Timeout
    { $sel:idle:Timeout :: Maybe NominalDiffTime
idle = NominalDiffTime -> Maybe NominalDiffTime
forall a. a -> Maybe a
Just (NominalDiffTime -> Maybe NominalDiffTime)
-> NominalDiffTime -> Maybe NominalDiffTime
forall a b. (a -> b) -> a -> b
$ NominalDiffTime -> NominalDiffTime
hours NominalDiffTime
8
    , $sel:absolute:Timeout :: Maybe NominalDiffTime
absolute = NominalDiffTime -> Maybe NominalDiffTime
forall a. a -> Maybe a
Just (NominalDiffTime -> Maybe NominalDiffTime)
-> NominalDiffTime -> Maybe NominalDiffTime
forall a b. (a -> b) -> a -> b
$ NominalDiffTime -> NominalDiffTime
days NominalDiffTime
30
    }