on develop help sign in
3 files changed+98−28
since splitsnapshots
unifiedsplit
ChangeLog.md+4 reflex.cabal+3−2 src/Reflex/Requester/Base.hs+91−26
ChangeLog.md+4
@@ -1,5 +1,9 @@
11# Revision history for reflex
22
3+## 0.8.2.0
4+
5+* Add `matchResponseMapWithRequests`, which it similar to `matchResponsesWithRequests` but allows processing of multiple responses at once.
6+
37## 0.8.1.1
48
59* Allow newer hlint for older GHCs, and add upper bound for newer GHCs
reflex.cabal+3−2
@@ -1,5 +1,5 @@
11Name: reflex
2−Version: 0.8.1.1
2+Version: 0.8.2.0
33Synopsis: Higher-order Functional Reactive Programming
44Description:
55 Interactive programs without callbacks or side-effects.
@@ -74,6 +74,7 @@ library
7474 base >= 4.11 && < 4.15,
7575 bifunctors >= 5.2 && < 5.6,
7676 comonad >= 5.0.4 && < 5.1,
77+ constraints >= 0.10 && <0.14,
7778 constraints-extras >= 0.3 && < 0.4,
7879 containers >= 0.6 && < 0.7,
7980 data-default >= 0.5 && < 0.8,
@@ -96,7 +97,7 @@ library
9697 time >= 1.4 && < 1.10,
9798 transformers >= 0.5.6.0 && < 0.6,
9899 unbounded-delays >= 0.1.0.0 && < 0.2,
99− witherable >= 0.3 && < 0.4
100+ witherable >= 0.3 && < 0.5
100101
101102 if flag(split-these)
102103 build-depends: these >= 1 && <1.2,
src/Reflex/Requester/Base.hs+91−26
@@ -1,6 +1,7 @@
11-- | This module provides 'RequesterT', the standard implementation of
22-- 'Requester'.
33{-# LANGUAGE AllowAmbiguousTypes #-}
4+{-# LANGUAGE ApplicativeDo #-}
45{-# LANGUAGE CPP #-}
56{-# LANGUAGE EmptyDataDecls #-}
67{-# LANGUAGE ExistentialQuantification #-}
@@ -32,6 +33,7 @@ module Reflex.Requester.Base
3233 , requesterDataToList
3334 , singletonRequesterData
3435 , matchResponsesWithRequests
36+ , matchResponseMapWithRequests
3537 , multiEntry
3638 , unMultiEntry
3739 , requesting'
@@ -56,6 +58,7 @@ import Control.Monad.Ref
5658import Control.Monad.State.Strict
5759import Data.Bits
5860import Data.Coerce
61+import Data.Constraint
5962import Data.Dependent.Map (DMap)
6063import qualified Data.Dependent.Map as DMap
6164import Data.Dependent.Sum (DSum (..))
@@ -81,19 +84,51 @@ newtype TagMap (f :: * -> *) = TagMap (IntMap Any)
8184
8285newtype RequesterData f = RequesterData (TagMap (Entry f))
8386
87+emptyRequesterData :: RequesterData f
88+emptyRequesterData = RequesterData $ TagMap IntMap.empty
89+
8490data RequesterDataKey a where
8591 RequesterDataKey_Single :: {-# UNPACK #-} !(MyTag (Single a)) -> RequesterDataKey a
8692 RequesterDataKey_Multi :: {-# UNPACK #-} !(MyTag Multi) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a --TODO: Don't put a second Int here (or in the other Multis); use a single Int instead
87− RequesterDataKey_Multi2 :: {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
93+ RequesterDataKey_Multi2 :: GCompare k => {-# UNPACK #-} !(MyTag (Multi2 k)) -> !(Some k) -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
8894 RequesterDataKey_Multi3 :: {-# UNPACK #-} !(MyTag Multi3) -> {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> !(RequesterDataKey a) -> RequesterDataKey a
8995
9096singletonRequesterData :: RequesterDataKey a -> f a -> RequesterData f
9197singletonRequesterData rdk v = case rdk of
9298 RequesterDataKey_Single k -> RequesterData $ singletonTagMap k $ Entry v
9399 RequesterDataKey_Multi k k' k'' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ singletonRequesterData k'' v
94− RequesterDataKey_Multi2 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ Map.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
100+ RequesterDataKey_Multi2 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ Multi2Contents
101+ { _multi2Contents_values = Map.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
102+ , _multi2Contents_dict = Dict
103+ }
95104 RequesterDataKey_Multi3 k k' k'' k''' -> RequesterData $ singletonTagMap k $ Entry $ IntMap.singleton k' $ IntMap.singleton k'' $ singletonRequesterData k''' v
96105
106+mergeRequesterData :: RequesterData f -> RequesterData f -> RequesterData f
107+mergeRequesterData (RequesterData a) (RequesterData b) = RequesterData $ mergeTagMap a b
108+
109+mergeTagMap :: forall f. TagMap (Entry f) -> TagMap (Entry f) -> TagMap (Entry f)
110+mergeTagMap (TagMap m) (TagMap n) =
111+ TagMap $ IntMap.unionWithKey (g' combiner) m n
112+ where
113+ combiner :: forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a
114+ combiner k (Entry a) (Entry b) = Entry $ case myKeyType k of
115+ MyTagType_Single -> a
116+ MyTagType_Multi -> IntMap.unionWith mergeRequesterData a b
117+ MyTagType_Multi2 -> case _multi2Contents_dict a of
118+ Dict -> Multi2Contents
119+ { _multi2Contents_values = Map.unionWith (IntMap.unionWith mergeRequesterData) (_multi2Contents_values a) (_multi2Contents_values b)
120+ , _multi2Contents_dict = Dict
121+ }
122+ MyTagType_Multi3 -> IntMap.unionWith (IntMap.unionWith mergeRequesterData) a b
123+ g' :: (forall a. MyTag a -> Entry f a -> Entry f a -> Entry f a) -> Int -> Any -> Any -> Any
124+ g' f rawKey a b =
125+ let k = MyTag rawKey :: MyTag a
126+ fromAny :: Any -> Entry f a
127+ fromAny = unsafeCoerce
128+ toAny :: Entry f a -> Any
129+ toAny = unsafeCoerce
130+ in toAny $ f k (fromAny a) (fromAny b)
131+
97132requesterDataToList :: RequesterData f -> [DSum RequesterDataKey f]
98133requesterDataToList (RequesterData m) = do
99134 k :=> Entry e <- tagMapToList m
@@ -103,11 +138,12 @@ requesterDataToList (RequesterData m) = do
103138 (k', e') <- IntMap.toList e
104139 k'' :=> e'' <- requesterDataToList e'
105140 return $ RequesterDataKey_Multi k k' k'' :=> e''
106− MyTagType_Multi2 -> do
107− (k', e') <- Map.toList e
108− (k'', e'') <- IntMap.toList e'
109− k''' :=> e''' <- requesterDataToList e''
110− return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
141+ MyTagType_Multi2 -> case _multi2Contents_dict e of
142+ Dict -> do
143+ (k', e') <- Map.toList $ _multi2Contents_values e
144+ (k'', e'') <- IntMap.toList e'
145+ k''' :=> e''' <- requesterDataToList e''
146+ return $ RequesterDataKey_Multi2 k k' k'' k''' :=> e'''
111147 MyTagType_Multi3 -> do
112148 (k', e') <- IntMap.toList e
113149 (k'', e'') <- IntMap.toList e'
@@ -135,7 +171,13 @@ traverseRequesterData f (RequesterData m) = RequesterData <$> traverseTagMapWith
135171 go k (Entry request) = Entry <$> case myKeyType k of
136172 MyTagType_Single -> f request
137173 MyTagType_Multi -> traverse (traverseRequesterData f) request
138− MyTagType_Multi2 -> traverse (traverse (traverseRequesterData f)) request
174+ MyTagType_Multi2 -> case request of
175+ Multi2Contents { _multi2Contents_values = request', _multi2Contents_dict = Dict } -> do
176+ v <- traverse (traverse (traverseRequesterData f)) request'
177+ pure $ Multi2Contents
178+ { _multi2Contents_values = v
179+ , _multi2Contents_dict = Dict
180+ }
139181 MyTagType_Multi3 -> traverse (traverse (traverseRequesterData f)) request
140182
141183-- | 'traverseRequesterData' with its arguments flipped
@@ -179,9 +221,14 @@ instance MyTagTypeOffset Multi3 where
179221type family EntryContents request a where
180222 EntryContents request (Single a) = request a
181223 EntryContents request Multi = IntMap (RequesterData request)
182− EntryContents request (Multi2 k) = Map (Some k) (IntMap (RequesterData request))
224+ EntryContents request (Multi2 k) = Multi2Contents k request
183225 EntryContents request Multi3 = IntMap (IntMap (RequesterData request))
184226
227+data Multi2Contents k request = Multi2Contents
228+ { _multi2Contents_dict :: {-# UNPACK #-} !(Dict (GCompare k)) -- This is a Dict instead of an existential context because we only want to use it in certain circumstances
229+ , _multi2Contents_values :: {-# UNPACK #-} !(Map (Some k) (IntMap (RequesterData request)))
230+ }
231+
185232newtype Entry request x = Entry { unEntry :: EntryContents request x }
186233
187234{-# INLINE singleEntry #-}
@@ -310,7 +357,7 @@ tagRequest req = do
310357 return t
311358
312359{-# INLINE responseFromTag #-}
313−responseFromTag :: Monad m => MyTagWrap response (Entry response x) -> RequesterT t request response m (Event t (Entry response x))
360+responseFromTag :: forall m t request response x. Monad m => MyTagWrap response (Entry response x) -> RequesterT t request response m (Event t (Entry response x))
314361responseFromTag (MyTagWrap t) = do
315362 responses :: EventSelectorInt t Any <- RequesterT ask
316363 return $ (unsafeCoerce :: Event t Any -> Event t (Entry response x)) $ selectInt responses t
@@ -440,9 +487,9 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
440487 let responses :: EventSelector t (Const2 (Some k) (IntMap (RequesterData response)))
441488 responses = fanMap $ fmapCheap unpack response
442489 unpack :: Entry response (Multi2 k) -> Map (Some k) (IntMap (RequesterData response))
443− unpack = unEntry
490+ unpack = _multi2Contents_values . unEntry
444491 pack :: Map (Some k) (IntMap (RequesterData request)) -> Entry request (Multi2 k)
445− pack = Entry
492+ pack m = Entry $ Multi2Contents { _multi2Contents_values = m, _multi2Contents_dict = Dict }
446493 f' :: forall a. k a -> Compose ((,) Int) v a -> m (Compose ((,) (Event t (IntMap (RequesterData request)))) v' a)
447494 f' k (Compose (n, v)) = do
448495 (result, myRequests) <- runRequesterT (f k v) $ mapMaybeCheap (IntMap.lookup n) $ select responses (Const2 (Some k))
@@ -463,9 +510,6 @@ traverseDMapWithKeyWithAdjustRequesterTWith base mapPatch weakenPatchWith patchN
463510data Decoder rawResponse response =
464511 forall a. Decoder (RequesterDataKey a) (rawResponse -> response a)
465512
466−-- | Matches incoming responses with previously-sent requests
467−-- and uses the provided request "decoder" function to process
468−-- incoming responses.
469513matchResponsesWithRequests
470514 :: forall t rawRequest rawResponse request response m.
471515 ( MonadFix m
@@ -484,7 +528,30 @@ matchResponsesWithRequests
484528 )
485529 -- ^ A map of outgoing wire-format requests and an event of responses keyed
486530 -- by the 'RequesterData' key of the associated outgoing request
487−matchResponsesWithRequests f send recv = do
531+matchResponsesWithRequests f send recv = matchResponseMapWithRequests f send $ uncurry Map.singleton <$> recv
532+
533+-- | Matches incoming responses with previously-sent requests
534+-- and uses the provided request "decoder" function to process
535+-- incoming responses.
536+matchResponseMapWithRequests
537+ :: forall t rawRequest rawResponse request response m.
538+ ( MonadFix m
539+ , MonadHold t m
540+ , Reflex t
541+ )
542+ => (forall a. request a -> (rawRequest, rawResponse -> response a))
543+ -- ^ Given a request (from 'Requester'), produces the wire format of the
544+ -- request and a function used to process the associated response
545+ -> Event t (RequesterData request)
546+ -- ^ The outgoing requests
547+ -> Event t (Map Int rawResponse)
548+ -- ^ A map of incoming responses, tagged by an identifying key
549+ -> m ( Event t (Map Int rawRequest)
550+ , Event t (RequesterData response)
551+ )
552+ -- ^ A map of outgoing wire-format requests and an event of responses keyed
553+ -- by the 'RequesterData' key of the associated outgoing request
554+matchResponseMapWithRequests f send recv = do
488555 rec nextId <- hold 1 $ fmap (\(next, _, _) -> next) outgoing
489556 waitingFor :: Incremental t (PatchMap Int (Decoder rawResponse response)) <-
490557 holdIncremental mempty $ leftmost
@@ -526,17 +593,15 @@ matchResponsesWithRequests f send recv = do
526593 processIncoming
527594 :: Incremental t (PatchMap Int (Decoder rawResponse response))
528595 -- A map of outstanding expected responses
529− -> Event t (Int, rawResponse)
596+ -> Event t (Map Int rawResponse)
530597 -- A incoming response paired with its identifying key
531598 -> Event t (RequesterData response, PatchMap Int v)
532599 -- The decoded response and a patch that clears the outstanding responses queue
533− processIncoming waitingFor inc = flip push inc $ \(n, rawRsp) -> do
600+ processIncoming waitingFor inc = flip push inc $ \rspMap -> do
534601 wf <- sample $ currentIncremental waitingFor
535− case Map.lookup n wf of
536− Nothing -> return Nothing -- TODO How should lookup failures be handled here? They shouldn't ever happen..
537− Just (Decoder k rspF) -> do
538− let rsp = rspF rawRsp
539− return $ Just
540− ( singletonRequesterData k rsp
541− , PatchMap $ Map.singleton n Nothing
542− )
602+ let match rawRsp (Decoder k rspF) =
603+ let rsp = rspF rawRsp
604+ in singletonRequesterData k rsp
605+ matches = Map.intersectionWith match rspMap wf
606+ pure $ if Map.null matches then Nothing else Just
607+ (Map.foldl' mergeRequesterData emptyRequesterData matches, PatchMap $ Nothing <$ matches)