on develop help sign in
Merge pull request #330 from saulzar/cleanup-debug

Add debug flag, make reflex compile with DEBUG set

commitcf9a8dd97da497485a4aced3e1f646a88d1f3e43 authorJohn Ericson <John.Ericson@Obsidian.Systems> dateFri 17 Jan 2020, 18:16 (7 years ago) parent4f13ad401ddb99
8 files changed+650−249
.travis.yml+4 ChangeLog.md+3 cabal.haskell-ci+6 reflex.cabal+45−4 src/Data/FastMutableIntMap.hs+4 src/Reflex/Spider/Internal.hs+417−244 test/DebugCycles.hs+171 test/GC.hs−1
.travis.yml+4
@@ -168,6 +168,10 @@ script:
168168 - if $GHCJS || ! $GHCJS && [ $HCNUMVER -lt 80800 ] ; then ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='these <1' all | color_cabal_output ; fi
169169 # Constraint set old-witherable
170170 - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='witherable <0.3.2' all | color_cabal_output
171+ # Constraint set debug-propagation
172+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='reflex +debug-propagation' all | color_cabal_output
173+ # Constraint set debug-cycles
174+ - ${CABAL} v2-build $WITHCOMPILER --disable-tests --disable-benchmarks --constraint='reflex +debug-cycles' all | color_cabal_output
171175
172176# REGENDATA ["--config=cabal.haskell-ci","cabal.project"]
173177# EOF
ChangeLog.md+3
@@ -11,6 +11,9 @@
1111
1212* Additional instances for `Query` classes for basic types.
1313
14+* Add cabal flags `debug-propagation` and `debug-event-cycles` to build in debugging
15+ code for performance and for cyclic dependencies between events
16+
1417## 0.6.3
1518
1619* `Data.WeakBag.traverse` and `Data.FastWeakBag.traverse` have been deprecated.
cabal.haskell-ci+6
@@ -15,3 +15,9 @@ constraint-set old-these
1515
1616constraint-set old-witherable
1717 constraints: witherable <0.3.2
18+
19+constraint-set debug-propagation
20+ constraints: reflex +debug-propagation
21+
22+constraint-set debug-cycles
23+ constraints: reflex +debug-cycles
reflex.cabal+45−4
@@ -41,6 +41,16 @@ flag fast-weak
4141 default: False
4242 manual: True
4343
44+flag debug-propagation
45+ description: Enable debugging of spider internals
46+ default: False
47+ manual: True
48+
49+flag debug-cycles
50+ description: Enable debugging of event cycles
51+ default: False
52+ manual: True
53+
4454flag split-these
4555 description: Use split these/semialign packages
4656 manual: False
@@ -150,6 +160,12 @@ library
150160 build-depends: ghc
151161 exposed-modules: Reflex.Optimizer
152162
163+ if flag(debug-propagation)
164+ cpp-options: -DDEBUG -DDEBUG_TRACE_PROPAGATION -DDEBUG_TRACE_INVALIDATION
165+
166+ if flag(debug-cycles)
167+ cpp-options: -DDEBUG_CYCLES
168+
153169 if flag(use-template-haskell)
154170 cpp-options: -DUSE_TEMPLATE_HASKELL
155171 build-depends:
@@ -252,10 +268,35 @@ test-suite EventWriterT
252268 build-depends: these-lens
253269
254270 other-modules:
255− Reflex.Test
256− Reflex.TestPlan
257− Reflex.Plan.Reflex
258− Reflex.Plan.Pure
271+ Test.Run
272+
273+
274+test-suite DebugCycles
275+ default-language: Haskell2010
276+ type: exitcode-stdio-1.0
277+ main-is: DebugCycles.hs
278+ hs-source-dirs: test
279+ ghc-options: -threaded
280+ build-depends: base
281+ , containers
282+ , deepseq
283+ , dependent-map
284+ , dependent-sum
285+ , hspec
286+ , lens
287+ , mtl
288+ , these
289+ , transformers
290+ , reflex
291+ , ref-tf
292+ , witherable
293+ , proctest
294+
295+
296+ if flag(split-these)
297+ build-depends: these-lens, semialign
298+
299+ other-modules:
259300 Test.Run
260301
261302
src/Data/FastMutableIntMap.hs+4
@@ -21,6 +21,7 @@ module Data.FastMutableIntMap
2121 , patchIntMapNewElements
2222 , patchIntMapNewElementsMap
2323 , getDeletions
24+ , toList
2425 ) where
2526
2627--TODO: Pure JS version
@@ -91,3 +92,6 @@ applyPatch (FastMutableIntMap r) p@(PatchIntMap m) = do
9192 v <- readIORef r
9293 writeIORef r $! applyAlways p v
9394 return $ IntMap.intersection v m
95+
96+toList :: FastMutableIntMap a -> IO [(Int, a)]
97+toList (FastMutableIntMap r) = IntMap.toList <$> readIORef r
src/Reflex/Spider/Internal.hs+417−244
@@ -38,7 +38,6 @@ import Control.Monad hiding (forM, forM_, mapM, mapM_)
3838import Control.Monad.Exception
3939import Control.Monad.Identity hiding (forM, forM_, mapM, mapM_)
4040import Control.Monad.Primitive
41−--import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_)
4241import Control.Monad.Reader.Class
4342import Control.Monad.IO.Class
4443import Control.Monad.ReaderIO
@@ -61,13 +60,13 @@ import qualified Data.IntMap.Strict as IntMap
6160import Data.IORef
6261import Data.Kind (Type)
6362import Data.Maybe hiding (mapMaybe)
64−import Data.Monoid ((<>))
63+import Data.Monoid (mempty, (<>))
6564import Data.Proxy
6665import Data.These
6766import Data.Traversable
6867import Data.Type.Equality ((:~:)(Refl))
6968import Data.Witherable (Filterable, mapMaybe)
70−import GHC.Exts
69+import GHC.Exts hiding (toList)
7170import GHC.IORef (IORef (..))
7271import GHC.Stack
7372import Reflex.FastWeak
@@ -86,14 +85,16 @@ import Data.Zip (Zip (..))
8685
8786#ifdef DEBUG_CYCLES
8887import Control.Monad.State hiding (forM, forM_, mapM, mapM_, sequence)
88+#endif
89+
8990import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
9091import qualified Data.List.NonEmpty as NonEmpty
91−import Data.Monoid (mempty)
9292import Data.Tree (Forest, Tree (..), drawForest)
93−#endif
93+import Data.List (isPrefixOf)
9494
95−import Data.FastWeakBag (FastWeakBag)
95+import Data.FastWeakBag (FastWeakBag, FastWeakBagTicket)
9696import qualified Data.FastWeakBag as FastWeakBag
97+
9798import Data.Reflection
9899import Data.Some (Some(Some))
99100import Data.Type.Coercion
@@ -111,14 +112,19 @@ import Reflex.PerformEvent.Base (PerformEventT)
111112#ifdef DEBUG_TRACE_EVENTS
112113import qualified Data.ByteString.Char8 as BS8
113114import System.IO (stderr)
115+import Data.List (isPrefixOf)
114116#endif
115117
116−#ifdef DEBUG_TRACE_EVENTS
118+-- TODO stdout might not be the best channel for debug output
119+debugStrLn :: String -> IO ()
120+debugStrLn = putStrLn
117121
122+#ifdef DEBUG_TRACE_EVENTS
118123withStackOneLine :: (BS8.ByteString -> a) -> a
119124withStackOneLine expr = unsafePerformIO $ do
120125 stack <- currentCallStack
121− return (expr (BS8.pack (unwords (reverse stack))))
126+ return (expr . BS8.pack . unwords . dropInternal . reverse $ stack)
127+ where dropInternal = filterStack "Reflex.Spider.Internal"
122128
123129#endif
124130
@@ -129,28 +135,42 @@ debugInvalidateHeight :: Bool
129135debugInvalidate :: Bool
130136
131137#ifdef DEBUG
132−
133138#define DEBUG_NODEIDS
134139
140+#ifdef DEBUG_TRACE_PROPAGATION
135141debugPropagate = True
142+#else
143+debugPropagate = False
144+#endif
136145
146+#ifdef DEBUG_TRACE_HEIGHT
147+debugInvalidateHeight = True
148+#else
137149debugInvalidateHeight = False
150+#endif
138151
152+#ifdef DEBUG_TRACE_INVALIDATION
139153debugInvalidate = True
154+#else
155+debugInvalidate = False
156+#endif
140157
141158class HasNodeId a where
142159 getNodeId :: a -> Int
143160
144−instance HasNodeId (Hold x p a) where
145− getNodeId = holdNodeId
161+instance HasNodeId (CacheSubscribed x a) where
162+ getNodeId = _cacheSubscribed_nodeId
163+
164+instance HasNodeId (FanInt x a) where
165+ getNodeId = _fanInt_nodeId
146166
147−instance HasNodeId (PushSubscribed x a b) where
148− getNodeId = pushSubscribedNodeId
167+instance HasNodeId (Hold x p) where
168+ getNodeId = holdNodeId
149169
150170instance HasNodeId (SwitchSubscribed x a) where
151171 getNodeId = switchSubscribedNodeId
152172
153−instance HasNodeId (FanSubscribed x a) where
173+instance HasNodeId (FanSubscribed x v a) where
154174 getNodeId = fanSubscribedNodeId
155175
156176instance HasNodeId (CoincidenceSubscribed x a) where
@@ -164,41 +184,16 @@ instance HasNodeId (Pull x a) where
164184
165185{-# INLINE showNodeId #-}
166186showNodeId :: HasNodeId a => a -> String
167−showNodeId = ("#"<>) . show . getNodeId
168−
169−showSubscriberType :: Subscriber x a -> String
170−showSubscriberType = \case
171− SubscriberPush _ _ -> "SubscriberPush"
172− SubscriberMerge _ _ -> "SubscriberMerge"
173− SubscriberFan _ -> "SubscriberFan"
174− SubscriberMergeChange _ -> "SubscriberMergeChange"
175− SubscriberHold _ -> "SubscriberHold"
176− SubscriberHoldIdentity _ -> "SubscriberHoldIdentity"
177− SubscriberSwitch _ -> "SubscriberSwitch"
178− SubscriberCoincidenceOuter _ -> "SubscriberCoincidenceOuter"
179− SubscriberCoincidenceInner _ -> "SubscriberCoincidenceInner"
180− SubscriberHandle -> "SubscriberHandle"
181−
182−showEventType :: Event x a -> String
183−showEventType = \case
184− EventRoot _ _ -> "EventRoot"
185− EventNever -> "EventNever"
186− EventPush _ -> "EventPush"
187− EventMerge _ -> "EventMerge"
188− EventFan _ _ -> "EventFan"
189− EventSwitch _ -> "EventSwitch"
190− EventCoincidence _ -> "EventCoincidence"
191− EventHold _ -> "EventHold"
192− EventDyn _ -> "EventDyn"
193− EventHoldIdentity _ -> "EventHoldIdentity"
194− EventDynIdentity _ -> "EventDynIdentity"
187+showNodeId = showNodeId' . getNodeId
188+
189+showNodeId' :: Int -> String
190+showNodeId' = ("#"<>) . show
191+
195192
196193#else
197194
198195debugPropagate = False
199−
200196debugInvalidateHeight = False
201−
202197debugInvalidate = False
203198
204199-- This must be inline, or error messages will cause memory leaks due to retaining the node in question
@@ -206,6 +201,10 @@ debugInvalidate = False
206201showNodeId :: a -> String
207202showNodeId _ = ""
208203
204+{-# INLINE showNodeId' #-}
205+showNodeId' :: Int -> String
206+showNodeId' _ = ""
207+
209208#endif
210209
211210#ifdef DEBUG_NODEIDS
@@ -251,9 +250,9 @@ subscribeAndRead = unEvent
251250-- caching; if the computation function is very cheap, this is (much) more
252251-- efficient than 'push'
253252{-# INLINE [1] pushCheap #-}
254−pushCheap :: (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
253+pushCheap :: HasSpiderTimeline x => (a -> ComputeM x (Maybe b)) -> Event x a -> Event x b
255254pushCheap !f e = Event $ \sub -> do
256− (subscription, occ) <- subscribeAndRead e $ sub
255+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "push" $ sub
257256 { subscriberPropagate = \a -> do
258257 mb <- f a
259258 mapM_ (subscriberPropagate sub) mb
@@ -272,10 +271,10 @@ terminalSubscriber p = Subscriber
272271
273272-- | Subscribe to an Event only for the duration of one occurrence
274273{-# INLINE subscribeAndReadHead #-}
275−subscribeAndReadHead :: Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
274+subscribeAndReadHead :: HasSpiderTimeline x => Event x a -> Subscriber x a -> EventM x (EventSubscription x, Maybe a)
276275subscribeAndReadHead e sub = do
277276 subscriptionRef <- liftIO $ newIORef $ error "subscribeAndReadHead: not initialized"
278− (subscription, occ) <- subscribeAndRead e $ sub
277+ (subscription, occ) <- subscribeAndRead e $ debugSubscriber' "head" $ sub
279278 { subscriberPropagate = \a -> do
280279 liftIO $ unsubscribe =<< readIORef subscriptionRef
281280 subscriberPropagate sub a
@@ -286,24 +285,29 @@ subscribeAndReadHead e sub = do
286285 return (subscription, occ)
287286
288287--TODO: Make this lazy in its input event
289−headE :: (MonadIO m, Defer (SomeMergeInit x) m) => Event x a -> m (Event x a)
288+headE :: (MonadIO m, Defer (SomeMergeInit x) m, HasSpiderTimeline x) => Event x a -> m (Event x a)
290289headE originalE = do
291290 parent <- liftIO $ newIORef $ Just originalE
292291 defer $ SomeMergeInit $ do --TODO: Rename SomeMergeInit appropriately
293292 let clearParent = liftIO $ writeIORef parent Nothing
294− (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ \_ -> clearParent
293+ (_, occ) <- subscribeAndReadHead originalE $ terminalSubscriber $ const clearParent
295294 when (isJust occ) clearParent
296− return $ Event $ \sub -> do
295+ return $ Event $ \sub ->
297296 liftIO (readIORef parent) >>= \case
298− Nothing -> return (EventSubscription (return ()) $ EventSubscribed zeroRef $ toAny (), Nothing)
297+ Nothing -> subscribeAndReadNever
299298 Just e -> subscribeAndReadHead e sub
300299
301300data CacheSubscribed x a
302301 = CacheSubscribed { _cacheSubscribed_subscribers :: {-# UNPACK #-} !(FastWeakBag (Subscriber x a))
303302 , _cacheSubscribed_parent :: {-# UNPACK #-} !(EventSubscription x)
304303 , _cacheSubscribed_occurrence :: {-# UNPACK #-} !(IORef (Maybe a))
304+#ifdef DEBUG_NODEIDS
305+ , _cacheSubscribed_nodeId :: {-# UNPACK #-} !Int
306+#endif
305307 }
306308
309+
310+
307311-- | Construct an 'Event' whose value is guaranteed not to be recomputed
308312-- repeatedly
309313--
@@ -328,18 +332,23 @@ cacheEvent e =
328332 subscribedTicket <- liftIO (readIORef mSubscribedRef >>= getFastWeakTicket) >>= \case
329333 Just subscribedTicket -> return subscribedTicket
330334 Nothing -> do
335+#ifdef DEBUG_NODEIDS
336+ nodeId <- liftIO newNodeId
337+#endif
331338 subscribers <- liftIO FastWeakBag.empty
332339 occRef <- liftIO $ newIORef Nothing -- This should never be read prior to being set below
340+#ifdef DEBUG_NODEIDS
341+ (parentSub, occ) <- subscribeAndRead e $ debugSubscriber' ("cacheEvent" <> showNodeId' nodeId) $ Subscriber
342+#else
333343 (parentSub, occ) <- subscribeAndRead e $ Subscriber
334− { subscriberPropagate = \a -> do
335− liftIO $ writeIORef occRef $ Just a
336− scheduleClear occRef
337− propagateFast a subscribers
338− , subscriberInvalidateHeight = \old -> do
339− FastWeakBag.traverse_ subscribers $ invalidateSubscriberHeight old
340− , subscriberRecalculateHeight = \new -> do
341− FastWeakBag.traverse_ subscribers $ recalculateSubscriberHeight new
342− }
344+#endif
345+ { subscriberPropagate = \a -> do
346+ liftIO $ writeIORef occRef (Just a)
347+ scheduleClear occRef
348+ propagateFast a subscribers
349+ , subscriberInvalidateHeight = FastWeakBag.traverse_ subscribers . invalidateSubscriberHeight
350+ , subscriberRecalculateHeight = FastWeakBag.traverse_ subscribers . recalculateSubscriberHeight
351+ }
343352 when (isJust occ) $ do
344353 liftIO $ writeIORef occRef occ -- Set the initial value of occRef; we don't need to do this if occ is Nothing
345354 scheduleClear occRef
@@ -347,29 +356,45 @@ cacheEvent e =
347356 { _cacheSubscribed_subscribers = subscribers
348357 , _cacheSubscribed_parent = parentSub
349358 , _cacheSubscribed_occurrence = occRef
359+#ifdef DEBUG_NODEIDS
360+ , _cacheSubscribed_nodeId = nodeId
361+#endif
350362 }
351363 subscribedTicket <- liftIO $ mkFastWeakTicket subscribed
352364 liftIO $ writeIORef mSubscribedRef =<< getFastWeakTicketWeak subscribedTicket
353365 return subscribedTicket
354− liftIO $ do
355− subscribed <- getFastWeakTicketValue subscribedTicket
356− ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
357− occ <- readIORef $ _cacheSubscribed_occurrence subscribed
358− let es = EventSubscription
359− { _eventSubscription_unsubscribe = do
360− FastWeakBag.remove ticket
361− isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
362− when isEmpty $ do
363− writeIORef mSubscribedRef emptyFastWeak
364− unsubscribe $ _cacheSubscribed_parent subscribed
365− touch ticket
366− touch subscribedTicket
367− , _eventSubscription_subscribed = EventSubscribed
368− { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ _cacheSubscribed_parent subscribed
369− , eventSubscribedRetained = toAny subscribedTicket
370− }
371− }
372− return (es, occ)
366+ liftIO $ cacheSubscription sub mSubscribedRef subscribedTicket
367+
368+cacheSubscription :: Subscriber x a -> IORef (FastWeak (CacheSubscribed x a))
369+ -> FastWeakTicket (CacheSubscribed x a) -> IO (EventSubscription x, Maybe a)
370+cacheSubscription sub mSubscribedRef subscribedTicket = do
371+ subscribed <- getFastWeakTicketValue subscribedTicket
372+ ticket <- FastWeakBag.insert sub $ _cacheSubscribed_subscribers subscribed
373+ occ <- readIORef $ _cacheSubscribed_occurrence subscribed
374+
375+ let parentSub = _cacheSubscribed_parent subscribed
376+ es = EventSubscription
377+ { _eventSubscription_unsubscribe = do
378+ FastWeakBag.remove ticket
379+
380+ isEmpty <- FastWeakBag.isEmpty $ _cacheSubscribed_subscribers subscribed
381+ when isEmpty $ do
382+ writeIORef mSubscribedRef emptyFastWeak
383+ unsubscribe parentSub
384+ touch ticket
385+ touch subscribedTicket
386+ , _eventSubscription_subscribed = EventSubscribed
387+ { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed parentSub
388+ , eventSubscribedRetained = toAny subscribedTicket
389+#ifdef DEBUG_CYCLES
390+ , eventSubscribedGetParents = return [_eventSubscription_subscribed parentSub]
391+ , eventSubscribedHasOwnHeightRef = False
392+ , eventSubscribedWhoCreated = whoCreatedIORef mSubscribedRef
393+#endif
394+ }
395+ }
396+ return (es, occ)
397+
373398
374399subscribe :: Event x a -> Subscriber x a -> EventM x (EventSubscription x)
375400subscribe e s = fst <$> subscribeAndRead e s
@@ -381,11 +406,14 @@ wrap tag getSpecificSubscribed sub = do
381406 let es = tag subd
382407 return (EventSubscription (WeakBag.remove sln >> touch sln) es, occ)
383408
384−eventRoot :: GCompare k => k a -> Root x k -> Event x a
409+eventRoot :: (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Event x a
385410eventRoot !k !r = Event $ wrap eventSubscribedRoot $ liftIO . getRootSubscribed k r
386411
412+subscribeAndReadNever :: EventM x (EventSubscription x, Maybe a)
413+subscribeAndReadNever = return (EventSubscription (return ()) eventSubscribedNever, Nothing)
414+
387415eventNever :: Event x a
388−eventNever = Event $ \_ -> return (EventSubscription (return ()) eventSubscribedNever, Nothing)
416+eventNever = Event $ const subscribeAndReadNever
389417
390418eventFan :: (GCompare k, HasSpiderTimeline x) => k a -> Fan x k v -> Event x (v a)
391419eventFan !k !f = Event $ wrap eventSubscribedFan $ getFanSubscribed k f
@@ -440,10 +468,10 @@ newSubscriberHold h = return $ Subscriber
440468 }
441469
442470newSubscriberFan :: forall x k v. (HasSpiderTimeline x, GCompare k) => FanSubscribed x k v -> IO (Subscriber x (DMap k v))
443−newSubscriberFan subscribed = return $ Subscriber
471+newSubscriberFan subscribed = debugSubscriber ("SubscriberFan " <> showNodeId subscribed) $ Subscriber
444472 { subscriberPropagate = \a -> {-# SCC "traverseFan" #-} do
445473 subs <- liftIO $ readIORef $ fanSubscribedSubscribers subscribed
446− tracePropagate (Proxy :: Proxy x) $ "SubscriberFan" <> showNodeId subscribed <> ": " ++ show (DMap.size subs) ++ " keys subscribed, " ++ show (DMap.size a) ++ " keys firing"
474+ tracePropagate (Proxy :: Proxy x) $ show (DMap.size subs) <> " keys subscribed, " <> show (DMap.size a) <> " keys firing"
447475 liftIO $ writeIORef (fanSubscribedOccurrence subscribed) $ Just a
448476 scheduleClear $ fanSubscribedOccurrence subscribed
449477 let f _ (Pair v subsubs) = do
@@ -452,50 +480,40 @@ newSubscriberFan subscribed = return $ Subscriber
452480 _ <- DMap.traverseWithKey f $ DMap.intersectionWithKey (\_ -> Pair) a subs --TODO: Would be nice to have DMap.traverse_
453481 return ()
454482 , subscriberInvalidateHeight = \old -> do
455− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
456483 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
457484 forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ invalidateSubscriberHeight old
458− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
459485 , subscriberRecalculateHeight = \new -> do
460− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed
461486 subscribers <- readIORef $ fanSubscribedSubscribers subscribed
462487 forM_ (DMap.toList subscribers) $ \(_ :=> v) -> WeakBag.traverse_ (_fanSubscribedChildren_list v) $ recalculateSubscriberHeight new
463− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberFan" <> showNodeId subscribed <> " done"
464488 }
465489
466490newSubscriberSwitch :: forall x a. HasSpiderTimeline x => SwitchSubscribed x a -> IO (Subscriber x a)
467−newSubscriberSwitch subscribed = return $ Subscriber
491+newSubscriberSwitch subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
468492 { subscriberPropagate = \a -> {-# SCC "traverseSwitch" #-} do
469− tracePropagate (Proxy :: Proxy x) $ "SubscriberSwitch" <> showNodeId subscribed
470493 liftIO $ writeIORef (switchSubscribedOccurrence subscribed) $ Just a
471494 scheduleClear $ switchSubscribedOccurrence subscribed
472495 propagate a $ switchSubscribedSubscribers subscribed
473496 , subscriberInvalidateHeight = \_ -> do
474− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
475497 oldHeight <- readIORef $ switchSubscribedHeight subscribed
476498 when (oldHeight /= invalidHeight) $ do
477499 writeIORef (switchSubscribedHeight subscribed) $! invalidHeight
478500 WeakBag.traverse_ (switchSubscribedSubscribers subscribed) $ invalidateSubscriberHeight oldHeight
479− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
480− , subscriberRecalculateHeight = \new -> do
481− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed
482− updateSwitchHeight new subscribed
483− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberSwitch" <> showNodeId subscribed <> " done"
484− }
501+ , subscriberRecalculateHeight = (`updateSwitchHeight` subscribed)
502+ }
485503
486504newSubscriberCoincidenceOuter :: forall x b. HasSpiderTimeline x => CoincidenceSubscribed x b -> IO (Subscriber x (Event x b))
487−newSubscriberCoincidenceOuter subscribed = return $ Subscriber
505+newSubscriberCoincidenceOuter subscribed = debugSubscriber ("SubscriberCoincidenceOuter" <> showNodeId subscribed) $ Subscriber
488506 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceOuter" #-} do
489− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceOuter" <> showNodeId subscribed
490507 outerHeight <- liftIO $ readIORef $ coincidenceSubscribedHeight subscribed
491508 tracePropagate (Proxy :: Proxy x) $ " outerHeight = " <> show outerHeight
492509 (occ, innerHeight, innerSubd) <- subscribeCoincidenceInner a outerHeight subscribed
493510 tracePropagate (Proxy :: Proxy x) $ " isJust occ = " <> show (isJust occ)
494511 tracePropagate (Proxy :: Proxy x) $ " innerHeight = " <> show innerHeight
512+
495513 liftIO $ writeIORef (coincidenceSubscribedInnerParent subscribed) $ Just innerSubd
496514 scheduleClear $ coincidenceSubscribedInnerParent subscribed
497515 case occ of
498− Nothing -> do
516+ Nothing ->
499517 when (innerHeight > outerHeight) $ liftIO $ do -- If the event fires, it will fire at a later height
500518 writeIORef (coincidenceSubscribedHeight subscribed) $! innerHeight
501519 WeakBag.traverse_ (coincidenceSubscribedSubscribers subscribed) $ invalidateSubscriberHeight outerHeight
@@ -504,20 +522,13 @@ newSubscriberCoincidenceOuter subscribed = return $ Subscriber
504522 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) occ
505523 scheduleClear $ coincidenceSubscribedOccurrence subscribed
506524 propagate o $ coincidenceSubscribedSubscribers subscribed
507− , subscriberInvalidateHeight = \_ -> do
508− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
509− invalidateCoincidenceHeight subscribed
510− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
511− , subscriberRecalculateHeight = \_ -> do
512− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed
513− recalculateCoincidenceHeight subscribed
514− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceOuter" <> showNodeId subscribed <> " done"
525+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
526+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
515527 }
516528
517529newSubscriberCoincidenceInner :: forall x a. HasSpiderTimeline x => CoincidenceSubscribed x a -> IO (Subscriber x a)
518−newSubscriberCoincidenceInner subscribed = return $ Subscriber
530+newSubscriberCoincidenceInner subscribed = debugSubscriber ("SubscriberCoincidenceInner" <> showNodeId subscribed) $ Subscriber
519531 { subscriberPropagate = \a -> {-# SCC "traverseCoincidenceInner" #-} do
520− tracePropagate (Proxy :: Proxy x) $ "SubscriberCoincidenceInner" <> showNodeId subscribed
521532 occ <- liftIO $ readIORef $ coincidenceSubscribedOccurrence subscribed
522533 case occ of
523534 Just _ -> return () -- SubscriberCoincidenceOuter must have already propagated this event
@@ -525,14 +536,8 @@ newSubscriberCoincidenceInner subscribed = return $ Subscriber
525536 liftIO $ writeIORef (coincidenceSubscribedOccurrence subscribed) $ Just a
526537 scheduleClear $ coincidenceSubscribedOccurrence subscribed
527538 propagate a $ coincidenceSubscribedSubscribers subscribed
528− , subscriberInvalidateHeight = \_ -> do
529− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
530− invalidateCoincidenceHeight subscribed
531− when debugInvalidateHeight $ putStrLn $ "invalidateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
532− , subscriberRecalculateHeight = \_ -> do
533− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed
534− recalculateCoincidenceHeight subscribed
535− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: SubscriberCoincidenceInner" <> showNodeId subscribed <> " done"
539+ , subscriberInvalidateHeight = \_ -> invalidateCoincidenceHeight subscribed
540+ , subscriberRecalculateHeight = \_ -> recalculateCoincidenceHeight subscribed
536541 }
537542
538543invalidateSubscriberHeight :: Height -> Subscriber x a -> IO ()
@@ -542,15 +547,15 @@ recalculateSubscriberHeight :: Height -> Subscriber x a -> IO ()
542547recalculateSubscriberHeight = flip subscriberRecalculateHeight
543548
544549-- | Propagate everything at the current height
545−propagate :: a -> WeakBag (Subscriber x a) -> EventM x ()
546−propagate a subscribers = withIncreasedDepth $ do
550+propagate :: forall x a. HasSpiderTimeline x => a -> WeakBag (Subscriber x a) -> EventM x ()
551+propagate a subscribers = withIncreasedDepth (Proxy::Proxy x) $
547552 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
548553 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
549554 WeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
550555
551556-- | Propagate everything at the current height
552−propagateFast :: a -> FastWeakBag (Subscriber x a) -> EventM x ()
553−propagateFast a subscribers = withIncreasedDepth $ do
557+propagateFast :: forall x a. HasSpiderTimeline x => a -> FastWeakBag (Subscriber x a) -> EventM x ()
558+propagateFast a subscribers = withIncreasedDepth (Proxy::Proxy x) $
554559 -- Note: in the following traversal, we do not visit nodes that are added to the list during our traversal; they are new events, which will necessarily have full information already, so there is no need to traverse them
555560 --TODO: Should we check if nodes already have their values before propagating? Maybe we're re-doing work
556561 FastWeakBag.traverse_ subscribers $ \s -> subscriberPropagate s a
@@ -571,7 +576,7 @@ data EventSubscribed x = EventSubscribed
571576 { eventSubscribedHeightRef :: {-# UNPACK #-} !(IORef Height)
572577 , eventSubscribedRetained :: {-# NOUNPACK #-} !Any
573578#ifdef DEBUG_CYCLES
574− , eventSubscribedGetParents :: !(IO [Some (EventSubscribed x)]) -- For debugging loops
579+ , eventSubscribedGetParents :: !(IO [EventSubscribed x]) -- For debugging loops
575580 , eventSubscribedHasOwnHeightRef :: !Bool
576581 , eventSubscribedWhoCreated :: !(IO [String])
577582#endif
@@ -604,7 +609,7 @@ eventSubscribedFan !subscribed = EventSubscribed
604609 { eventSubscribedHeightRef = eventSubscribedHeightRef $ _eventSubscription_subscribed $ fanSubscribedParent subscribed
605610 , eventSubscribedRetained = toAny subscribed
606611#ifdef DEBUG_CYCLES
607− , eventSubscribedGetParents = return [Some $ _eventSubscription_subscribed $ fanSubscribedParent subscribed]
612+ , eventSubscribedGetParents = return [_eventSubscription_subscribed $ fanSubscribedParent subscribed]
608613 , eventSubscribedHasOwnHeightRef = False
609614 , eventSubscribedWhoCreated = whoCreatedIORef $ fanSubscribedCachedSubscribed subscribed
610615#endif
@@ -617,7 +622,7 @@ eventSubscribedSwitch !subscribed = EventSubscribed
617622#ifdef DEBUG_CYCLES
618623 , eventSubscribedGetParents = do
619624 s <- readIORef $ switchSubscribedCurrentParent subscribed
620− return [Some $ _eventSubscription_subscribed s]
625+ return [_eventSubscription_subscribed s]
621626 , eventSubscribedHasOwnHeightRef = True
622627 , eventSubscribedWhoCreated = whoCreatedIORef $ switchSubscribedCachedSubscribed subscribed
623628#endif
@@ -630,8 +635,8 @@ eventSubscribedCoincidence !subscribed = EventSubscribed
630635#ifdef DEBUG_CYCLES
631636 , eventSubscribedGetParents = do
632637 innerSubscription <- readIORef $ coincidenceSubscribedInnerParent subscribed
633− let outerParent = Some $ _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
634− innerParents = maybeToList $ fmap Some innerSubscription
638+ let outerParent = _eventSubscription_subscribed $ coincidenceSubscribedOuterParent subscribed
639+ innerParents = maybeToList $ innerSubscription
635640 return $ outerParent : innerParents
636641 , eventSubscribedHasOwnHeightRef = True
637642 , eventSubscribedWhoCreated = whoCreatedIORef $ coincidenceSubscribedCachedSubscribed subscribed
@@ -645,15 +650,15 @@ getEventSubscribedHeight es = readIORef $ eventSubscribedHeightRef es
645650whoCreatedEventSubscribed :: EventSubscribed x -> IO [String]
646651whoCreatedEventSubscribed = eventSubscribedWhoCreated
647652
648−walkInvalidHeightParents :: EventSubscribed x -> IO [Some (EventSubscribed x)]
653+walkInvalidHeightParents :: EventSubscribed x -> IO [EventSubscribed x]
649654walkInvalidHeightParents s0 = do
650− subscribers <- flip execStateT mempty $ ($ Some s0) $ fix $ \loop (Some s) -> do
655+ subscribers <- flip execStateT mempty $ ($ s0) $ fix $ \loop s -> do
651656 h <- liftIO $ readIORef $ eventSubscribedHeightRef s
652657 when (h == invalidHeight) $ do
653658 when (eventSubscribedHasOwnHeightRef s) $ liftIO $ writeIORef (eventSubscribedHeightRef s) $! invalidHeightBeingTraversed
654− modify (Some s :)
659+ modify (s :)
655660 mapM_ loop =<< liftIO (eventSubscribedGetParents s)
656− forM_ subscribers $ \(Some s) -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
661+ forM_ subscribers $ \s -> writeIORef (eventSubscribedHeightRef s) $! invalidHeight
657662 return subscribers
658663#endif
659664
@@ -1038,7 +1043,7 @@ data SomeMergeUpdate x = SomeMergeUpdate
10381043newtype SomeMergeInit x = SomeMergeInit { unSomeMergeInit :: EventM x () }
10391044
10401045-- EventM can do everything BehaviorM can, plus create holds
1041−newtype EventM x a = EventM { unEventM :: IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException) -- The environment should be Nothing if we are not in a frame, and Just if we are - in which case it is a list of assignments to be done after the frame is over
1046+newtype EventM x a = EventM { unEventM :: IO a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadException, MonadAsyncException)
10421047
10431048newtype MergeSubscribedParent x a = MergeSubscribedParent { unMergeSubscribedParent :: EventSubscription x }
10441049
@@ -1063,7 +1068,8 @@ heightBagFromList :: [Height] -> HeightBag
10631068heightBagFromList heights = heightBagVerify $ foldl' (flip heightBagAdd) heightBagEmpty heights
10641069
10651070heightBagAdd :: Height -> HeightBag -> HeightBag
1066−heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
1071+heightBagAdd (Height h) (HeightBag s c) = heightBagVerify $ HeightBag (succ s) $
1072+ IntMap.insertWithKey (\_ _ old -> succ old) h 0 c
10671073
10681074heightBagRemove :: Height -> HeightBag -> HeightBag
10691075heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.lookup h c of
@@ -1072,6 +1078,13 @@ heightBagRemove (Height h) b@(HeightBag s c) = heightBagVerify $ case IntMap.loo
10721078 0 -> IntMap.delete h c
10731079 _ -> IntMap.insert h (pred old) c
10741080
1081+heightBagRemoveMaybe :: Height -> HeightBag -> Maybe HeightBag
1082+heightBagRemoveMaybe (Height h) b@(HeightBag s c) = heightBagVerify . removed <$> IntMap.lookup h c where
1083+ removed old = HeightBag (pred s) $ case old of
1084+ 0 -> IntMap.delete h c
1085+ _ -> IntMap.insert h (pred old) c
1086+
1087+
10751088heightBagMax :: HeightBag -> Height
10761089heightBagMax (HeightBag _ c) = case IntMap.maxViewWithKey c of
10771090 Just ((h, _), _) -> Height h
@@ -1319,55 +1332,110 @@ mkWeakPtrWithDebug x debugNote = do
13191332 x' <- evaluate x
13201333 mkWeakPtr x' $
13211334 if debugFinalize
1322− then Just $ putStrLn $ "finalizing: " ++ debugNote
1335+ then Just $ debugStrLn $ "finalizing: " ++ debugNote
13231336 else Nothing
13241337
13251338type WeakList a = [Weak a]
13261339
1327−{-# INLINE withIncreasedDepth #-}
1340+type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
1341+
1342+
1343+
1344+
13281345#ifdef DEBUG
1329−withIncreasedDepth :: CanTrace x m => m a -> m a
1330−withIncreasedDepth a = do
1331− spiderTimeline <- askSpiderTimelineEnv
1332− liftIO $ modifyIORef' (_spiderTimeline_depth (unSTE spiderTimeline)) succ
1346+
1347+debugSubscriber :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> IO (Subscriber x a)
1348+debugSubscriber description = return . debugSubscriber' description
1349+
1350+debugSubscriber' :: forall x a. HasSpiderTimeline x => String -> Subscriber x a -> Subscriber x a
1351+debugSubscriber' description subscribed = Subscriber
1352+ {
1353+ subscriberPropagate = \m -> do
1354+ tracePropagate (Proxy :: Proxy x) ("subscriberPropagate: " <> description)
1355+ subscriberPropagate subscribed m
1356+ , subscriberInvalidateHeight = \old -> do
1357+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", old = " <> show (unHeight old)
1358+ subscriberInvalidateHeight subscribed old
1359+ traceInvalidateHeight $ "invalidateSubscriberHeight: " <> description <> ", done"
1360+ , subscriberRecalculateHeight = \new -> do
1361+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", new = " <> show (unHeight new)
1362+ subscriberRecalculateHeight subscribed new
1363+ traceInvalidateHeight $ "subscriberRecalculateHeight: " <> description <> ", done"
1364+ }
1365+
1366+
1367+{-# INLINE withIncreasedDepth #-}
1368+withIncreasedDepth :: forall proxy x m a. CanTrace x m => proxy x -> m a -> m a
1369+withIncreasedDepth _ a = do
1370+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) succ
13331371 result <- a
1334− liftIO $ modifyIORef' (_spiderTimeline_depth (unSTE spiderTimeline)) pred
1372+ liftIO $ modifyIORef' (_spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)) pred
13351373 return result
1336−#else
1337−withIncreasedDepth :: m a -> m a
1338−withIncreasedDepth = id
1339−#endif
1340−
1341−type CanTrace x m = (HasSpiderTimeline x, MonadIO m)
13421374
13431375{-# INLINE tracePropagate #-}
13441376tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1345−tracePropagate p = traceWhen p debugPropagate
1377+tracePropagate p = when debugPropagate . trace p
13461378
13471379{-# INLINE traceInvalidate #-}
13481380traceInvalidate :: String -> IO ()
1349−traceInvalidate = when debugInvalidate . liftIO . putStrLn
1381+traceInvalidate = when debugInvalidate . liftIO . debugStrLn
1382+
1383+{-# INLINE traceInvalidateHeight #-}
1384+traceInvalidateHeight :: String -> IO ()
1385+traceInvalidateHeight = when debugInvalidateHeight . liftIO . debugStrLn
13501386
1351−{-# INLINE traceWhen #-}
1352−traceWhen :: (CanTrace x m) => proxy x -> Bool -> String -> m ()
1353−traceWhen p b message = traceMWhen p b $ return message
1387+{-# INLINE trace #-}
1388+trace :: (CanTrace x m) => proxy x -> String -> m ()
1389+trace p message = traceM p $ return message
13541390
1355−{-# INLINE traceMWhen #-}
1356−traceMWhen :: (CanTrace x m) => proxy x -> Bool -> m String -> m ()
1357−traceMWhen _ b getMessage = when b $ do
1391+{-# INLINE traceM #-}
1392+traceM :: forall x proxy m. (CanTrace x m) => proxy x -> m String -> m ()
1393+traceM _ getMessage = do
13581394 message <- getMessage
1359−#ifdef DEBUG
1360− spiderTimeline <- askSpiderTimelineEnv
1361− d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE spiderTimeline
1395+ d <- liftIO $ readIORef $ _spiderTimeline_depth $ unSTE (spiderTimeline :: SpiderTimelineEnv x)
1396+ liftIO $ debugStrLn $ replicate d ' ' <> message
1397+
13621398#else
1363− let d = 0
1399+
1400+{-# INLINE withIncreasedDepth #-}
1401+withIncreasedDepth :: proxy x -> m a -> m a
1402+withIncreasedDepth _ = id
1403+
1404+{-# INLINE tracePropagate #-}
1405+tracePropagate :: (CanTrace x m) => proxy x -> String -> m ()
1406+tracePropagate _ _ = return ()
1407+
1408+{-# INLINE traceInvalidate #-}
1409+traceInvalidate :: String -> IO ()
1410+traceInvalidate _ = return ()
1411+
1412+{-# INLINE traceInvalidateHeight #-}
1413+traceInvalidateHeight :: String -> IO ()
1414+traceInvalidateHeight _ = return ()
1415+
1416+{-# INLINE debugSubscriber #-}
1417+debugSubscriber :: String -> Subscriber x a -> IO (Subscriber x a)
1418+debugSubscriber _ = return
1419+
1420+{-# INLINE debugSubscriber' #-}
1421+debugSubscriber' :: String -> Subscriber x a -> Subscriber x a
1422+debugSubscriber' _ = id
1423+
1424+
1425+
1426+{-# INLINE trace #-}
1427+trace :: (CanTrace x m) => proxy x -> String -> m ()
1428+trace _ _ = return ()
1429+
1430+{-# INLINE traceM #-}
1431+traceM :: (CanTrace x m) => proxy x -> m String -> m ()
1432+traceM _ _ = return ()
1433+
13641434#endif
1365− liftIO $ putStrLn $ replicate d ' ' <> message
13661435
13671436whoCreatedIORef :: IORef a -> IO [String]
13681437whoCreatedIORef (IORef a) = whoCreated $! a
13691438
1370−#ifdef DEBUG_CYCLES
13711439groupByHead :: Eq a => [NonEmpty a] -> [(a, NonEmpty [a])]
13721440groupByHead = \case
13731441 [] -> []
@@ -1378,20 +1446,54 @@ groupByHead = \case
13781446 | otherwise -> (x, xs :| []) : l
13791447
13801448listsToForest :: Eq a => [[a]] -> Forest a
1381−listsToForest l = fmap (\(a, l') -> Node a $ listsToForest $ toList l') $ groupByHead $ catMaybes $ fmap nonEmpty l
1449+listsToForest lists = buildForest <$> groupByHead (mapMaybe nonEmpty lists)
1450+ where buildForest (a, lists') = Node a $ listsToForest $ toList lists'
1451+
1452+showStacks :: [[String]] -> String
1453+showStacks = drawForest . listsToForest . fmap (filterStack "Reflex.Spider.Internal")
1454+
1455+filterStack :: String -> [String] -> [String]
1456+#ifdef DEBUG_HIDE_INTERNALS
1457+filterStack prefix = filter (not . (prefix `isPrefixOf`))
1458+#else
1459+filterStack prefix = id
13821460#endif
13831461
1462+#ifdef DEBUG_CYCLES
1463+
1464+data EventLoopException = EventLoopException [[String]]
1465+instance Exception EventLoopException
1466+
1467+instance Show EventLoopException where
1468+ show (EventLoopException stacks) = "causality loop detected:\n" <> if null stacks
1469+ then "no location information, compile with profiling enabled for stack tree"
1470+ else showStacks stacks
1471+
1472+#else
1473+
1474+data EventLoopException = EventLoopException
1475+instance Exception EventLoopException
1476+
1477+instance Show EventLoopException where
1478+ show EventLoopException = "causality loop detected: \n" <>
1479+ "compile reflex with flag 'debug-cycles' and compile with profiling enabled for stack tree"
1480+
1481+#endif
1482+
1483+
13841484{-# INLINE propagateSubscriberHold #-}
13851485propagateSubscriberHold :: forall x p. (HasSpiderTimeline x, Patch p) => Hold x p -> p -> EventM x ()
13861486propagateSubscriberHold h a = do
1387− {-# SCC "trace" #-} traceMWhen (Proxy :: Proxy x) debugPropagate $ liftIO $ do
1487+ {-# SCC "trace" #-} when debugPropagate $ traceM (Proxy :: Proxy x) $ liftIO $ do
13881488 invalidators <- liftIO $ readIORef $ holdInvalidators h
13891489 return $ "SubscriberHold" <> showNodeId h <> ": " ++ show (length invalidators)
1490+
13901491 v <- {-# SCC "read" #-} liftIO $ readIORef $ holdValue h
13911492 case {-# SCC "apply" #-} apply a v of
13921493 Nothing -> return ()
13931494 Just v' -> do
1394− {-# SCC "trace2" #-} withIncreasedDepth $ tracePropagate (Proxy :: Proxy x) $ "propagateSubscriberHold: assigning Hold" <> showNodeId h
1495+ {-# SCC "trace2" #-} withIncreasedDepth (Proxy :: Proxy x) $
1496+ tracePropagate (Proxy :: Proxy x) ("propagateSubscriberHold: assigning Hold" <> showNodeId h)
13951497 vRef <- {-# SCC "vRef" #-} liftIO $ evaluate $ holdValue h
13961498 iRef <- {-# SCC "iRef" #-} liftIO $ evaluate $ holdInvalidators h
13971499 defer $ {-# SCC "assignment" #-} SomeAssignment vRef iRef v'
@@ -1445,7 +1547,7 @@ getDynHold d = do
14451547zeroRef :: IORef Height
14461548zeroRef = unsafePerformIO $ newIORef zeroHeight
14471549
1448−getRootSubscribed :: GCompare k => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
1550+getRootSubscribed :: forall k x a. (GCompare k, HasSpiderTimeline x) => k a -> Root x k -> Subscriber x a -> IO (WeakBagTicket, RootSubscribed x a, Maybe a)
14491551getRootSubscribed k r sub = do
14501552 mSubscribed <- readIORef $ rootSubscribed r
14511553 let getOcc = fmap (coerce . DMap.lookup k) $ readIORef $ rootOccurrence r
@@ -1459,7 +1561,9 @@ getRootSubscribed k r sub = do
14591561 let !cached = rootSubscribed r
14601562 uninitRef <- newIORef $ error "getRootsubscribed: uninitRef not initialized"
14611563 (subs, sln) <- WeakBag.singleton sub weakSelf cleanupRootSubscribed
1462− when debugPropagate $ putStrLn $ "getRootSubscribed: calling rootInit"
1564+
1565+ tracePropagate (Proxy::Proxy x) $ "getRootSubscribed: calling rootInit"
1566+
14631567 uninit <- rootInit r k $ RootTrigger (subs, rootOccurrence r, k)
14641568 writeIORef uninitRef $! uninit
14651569#ifdef DEBUG_NODEIDS
@@ -1509,6 +1613,9 @@ data FanInt x a = FanInt
15091613 { _fanInt_subscribers :: {-# UNPACK #-} !(FastMutableIntMap (FastWeakBag (Subscriber x a))) --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
15101614 , _fanInt_subscriptionRef :: {-# UNPACK #-} !(IORef (EventSubscription x)) -- This should have a valid subscription iff subscribers is non-empty
15111615 , _fanInt_occRef :: {-# UNPACK #-} !(IORef (IntMap a))
1616+#ifdef DEBUG_NODEIDS
1617+ , _fanInt_nodeId :: {-# UNPACK #-} !Int
1618+#endif
15121619 }
15131620
15141621newFanInt :: IO (FanInt x a)
@@ -1516,10 +1623,16 @@ newFanInt = do
15161623 subscribers <- FastMutableIntMap.newEmpty --TODO: Clean up the keys in here when their child weak bags get empty --TODO: Remove our own subscription when the subscribers list is completely empty
15171624 subscriptionRef <- newIORef $ error "fanInt: no subscription"
15181625 occRef <- newIORef $ error "fanInt: no occurrence"
1626+#ifdef DEBUG_NODEIDS
1627+ nodeId <- newNodeId
1628+#endif
15191629 return $ FanInt
15201630 { _fanInt_subscribers = subscribers
15211631 , _fanInt_subscriptionRef = subscriptionRef
15221632 , _fanInt_occRef = occRef
1633+#ifdef DEBUG_NODEIDS
1634+ , _fanInt_nodeId = nodeId
1635+#endif
15231636 }
15241637
15251638fanInt :: HasSpiderTimeline x => Event x (IntMap a) -> EventSelectorInt x a
@@ -1528,20 +1641,21 @@ fanInt p = unsafePerformIO $ do
15281641 pure $ EventSelectorInt $ \k -> Event $ \sub -> do
15291642 isEmpty <- liftIO $ FastMutableIntMap.isEmpty (_fanInt_subscribers self)
15301643 when isEmpty $ do -- This is the first subscriber, so we need to subscribe to our input
1531− (subscription, parentOcc) <- subscribeAndRead p $ Subscriber
1644+ let desc = "fanInt" <> showNodeId self <> ", k = " <> show k
1645+ (subscription, parentOcc) <- subscribeAndRead p $ debugSubscriber' desc $ Subscriber
15321646 { subscriberPropagate = \m -> do
15331647 liftIO $ writeIORef (_fanInt_occRef self) m
15341648 scheduleIntClear $ _fanInt_occRef self
1535− FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> do --TODO: Do we need to know that no subscribers are being added as we traverse?
1536− FastWeakBag.traverse_ b $ \s -> do
1649+ FastMutableIntMap.forIntersectionWithImmutable_ (_fanInt_subscribers self) m $ \b v -> --TODO: Do we need to know that no subscribers are being added as we traverse?
1650+ FastWeakBag.traverse_ b $ \s ->
15371651 subscriberPropagate s v
1538− , subscriberInvalidateHeight = \old -> do
1539− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1540− FastWeakBag.traverse_ b $ \s -> do
1652+ , subscriberInvalidateHeight = \old ->
1653+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1654+ FastWeakBag.traverse_ b $ \s ->
15411655 subscriberInvalidateHeight s old
1542− , subscriberRecalculateHeight = \new -> do
1543− FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b -> do
1544− FastWeakBag.traverse_ b $ \s -> do
1656+ , subscriberRecalculateHeight = \new ->
1657+ FastMutableIntMap.for_ (_fanInt_subscribers self) $ \b ->
1658+ FastWeakBag.traverse_ b $ \s ->
15451659 subscriberRecalculateHeight s new
15461660 }
15471661 liftIO $ do
@@ -1555,10 +1669,25 @@ fanInt p = unsafePerformIO $ do
15551669 FastMutableIntMap.insert (_fanInt_subscribers self) k b
15561670 return b
15571671 Just b -> return b
1558− t <- liftIO $ FastWeakBag.insert sub b
1672+ ticket <- liftIO $ FastWeakBag.insert sub b
15591673 currentOcc <- readIORef (_fanInt_occRef self)
1560− (EventSubscription _ (EventSubscribed !heightRef _)) <- readIORef (_fanInt_subscriptionRef self)
1561− return (EventSubscription (FastWeakBag.remove t) $! EventSubscribed heightRef $! toAny (_fanInt_subscriptionRef self, t), IntMap.lookup k currentOcc)
1674+
1675+ subscribed <- fanIntSubscribed ticket self
1676+ return (EventSubscription (FastWeakBag.remove ticket) subscribed, IntMap.lookup k currentOcc)
1677+
1678+fanIntSubscribed :: FastWeakBagTicket k -> FanInt x a -> IO (EventSubscribed x)
1679+fanIntSubscribed ticket self = do
1680+ subscribedParent <- _eventSubscription_subscribed <$> readIORef (_fanInt_subscriptionRef self)
1681+ return $ EventSubscribed
1682+ { eventSubscribedHeightRef = eventSubscribedHeightRef subscribedParent
1683+ , eventSubscribedRetained = toAny (_fanInt_subscriptionRef self, ticket)
1684+#ifdef DEBUG_CYCLES
1685+ , eventSubscribedGetParents = return [subscribedParent]
1686+ , eventSubscribedHasOwnHeightRef = False
1687+ , eventSubscribedWhoCreated = whoCreatedIORef $ _fanInt_subscriptionRef self
1688+#endif
1689+ }
1690+
15621691
15631692{-# INLINABLE getFanSubscribed #-}
15641693getFanSubscribed :: (HasSpiderTimeline x, GCompare k) => k a -> Fan x k v -> Subscriber x (v a) -> EventM x (WeakBagTicket, FanSubscribed x k v, Maybe (v a))
@@ -1756,7 +1885,7 @@ mergeCheap
17561885 => (forall a. q a -> Event x (v a))
17571886 -> DynamicS x (PatchDMap k q)
17581887 -> Event x (DMap k v)
1759−mergeCheap nt = mergeGCheap' getInitialSubscribers updateMe destroy
1888+mergeCheap nt = mergeGCheap' unMergeSubscribedParent getInitialSubscribers updateMe destroy
17601889 where
17611890 updateMe :: MergeUpdateFunc k v x (PatchDMap k q) (MergeSubscribedParent x)
17621891 updateMe subscriber heightBagRef oldParents (PatchDMap p) = do
@@ -1771,7 +1900,9 @@ mergeCheap nt = mergeGCheap' getInitialSubscribers updateMe destroy
17711900 liftIO $ modifyIORef' heightBagRef $ heightBagAdd newParentHeight
17721901 return $ DMap.insertLookupWithKey' (\_ new _ -> new) k newParent ps
17731902 forM_ mOldSubd $ \oldSubd -> do
1774− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1903+ oldHeight <- liftIO $ getEventSubscribedHeight $
1904+ _eventSubscription_subscribed $ unMergeSubscribedParent oldSubd
1905+
17751906 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
17761907 return (maybeToList (unMergeSubscribedParent <$> mOldSubd) ++ subscriptionsToKill, newPs)
17771908 foldM f ([], oldParents) $ DMap.toList p
@@ -1796,7 +1927,7 @@ mergeCheapWithMove :: forall k x v q. (HasSpiderTimeline x, GCompare k)
17961927 => (forall a. q a -> Event x (v a))
17971928 -> DynamicS x (PatchDMapWithMove k q)
17981929 -> Event x (DMap k v)
1799−mergeCheapWithMove nt = mergeGCheap' getInitialSubscribers updateMe destroy
1930+mergeCheapWithMove nt = mergeGCheap' _mergeSubscribedParentWithMove_subscription getInitialSubscribers updateMe destroy
18001931 where
18011932 updateMe :: MergeUpdateFunc k v x (PatchDMapWithMove k q) (MergeSubscribedParentWithMove x k)
18021933 updateMe subscriber heightBagRef oldParents p = do
@@ -1815,13 +1946,17 @@ mergeCheapWithMove nt = mergeGCheap' getInitialSubscribers updateMe destroy
18151946 let moveOrDelete :: forall a. k a -> PatchDMapWithMove.NodeInfo k q a -> MergeSubscribedParentWithMove x k a -> Constant (EventM x (Maybe (EventSubscription x))) a
18161947 moveOrDelete _ ni parent = Constant $ case getComposeMaybe $ PatchDMapWithMove._nodeInfo_to ni of
18171948 Nothing -> do
1818− oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $ _mergeSubscribedParentWithMove_subscription parent
1949+ oldHeight <- liftIO $ getEventSubscribedHeight $ _eventSubscription_subscribed $
1950+ _mergeSubscribedParentWithMove_subscription parent
1951+
18191952 liftIO $ modifyIORef heightBagRef $ heightBagRemove oldHeight
18201953 return $ Just $ _mergeSubscribedParentWithMove_subscription parent
18211954 Just toKey -> do
18221955 liftIO $ writeIORef (_mergeSubscribedParentWithMove_key parent) $! toKey
18231956 return Nothing
1824− toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1957+ toDelete <- fmap catMaybes $ mapM (\(_ :=> v) -> getConstant v) $ DMap.toList $
1958+ DMap.intersectionWithKey moveOrDelete (unPatchDMapWithMove p) oldParents
1959+
18251960 return (toDelete, applyAlways p' oldParents)
18261961 getInitialSubscribers :: MergeInitFunc k v q x (MergeSubscribedParentWithMove x k)
18271962 getInitialSubscribers initialParents subscriber = do
@@ -1846,6 +1981,8 @@ type MergeUpdateFunc k v x p s
18461981 -> p
18471982 -> EventM x ([EventSubscription x], DMap k s)
18481983
1984+type MergeGetSubscription x s = forall a. s a -> EventSubscription x
1985+
18491986type MergeInitFunc k v q x s
18501987 = DMap k q
18511988 -> (forall a. EventM x (k a) -> Subscriber x (v a))
@@ -1869,14 +2006,17 @@ invalidateMergeHeight m = invalidateMergeHeight' (_merge_heightRef m) (_merge_su
18692006invalidateMergeHeight' :: IORef Height -> Subscriber x a -> IO ()
18702007invalidateMergeHeight' heightRef sub = do
18712008 oldHeight <- readIORef heightRef
1872− when (oldHeight /= invalidHeight) $ do -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
2009+ -- If the height used to be valid, it must be invalid now; we should never have *more* heights than we have parents
2010+ when (oldHeight /= invalidHeight) $ do
18732011 writeIORef heightRef $! invalidHeight
18742012 subscriberInvalidateHeight sub oldHeight
18752013
18762014revalidateMergeHeight :: Merge x k v s -> IO ()
18772015revalidateMergeHeight m = do
18782016 currentHeight <- readIORef $ _merge_heightRef m
1879− when (currentHeight == invalidHeight) $ do -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2017+
2018+ -- revalidateMergeHeight may be called multiple times; perhaps the's a way to finesse it to avoid this check
2019+ when (currentHeight == invalidHeight) $ do
18802020 heights <- readIORef $ _merge_heightBagRef m
18812021 parents <- readIORef $ _merge_parentsRef m
18822022 -- When the number of heights in the bag reaches the number of parents, we should have a valid height
@@ -1884,7 +2024,7 @@ revalidateMergeHeight m = do
18842024 LT -> return ()
18852025 EQ -> do
18862026 let height = succHeight $ heightBagMax heights
1887− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2027+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
18882028 writeIORef (_merge_heightRef m) $! height
18892029 subscriberRecalculateHeight (_merge_sub m) height
18902030 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show (DMap.size parents) <> ") for Merge"
@@ -1892,36 +2032,45 @@ revalidateMergeHeight m = do
18922032scheduleMergeSelf :: HasSpiderTimeline x => Merge x k v s -> Height -> EventM x ()
18932033scheduleMergeSelf m height = scheduleMerge' height (_merge_heightRef m) $ do
18942034 vals <- liftIO $ readIORef $ _merge_accumRef m
1895− liftIO $ writeIORef (_merge_accumRef m) $! DMap.empty -- Once we're done with this, we can clear it immediately, because if there's a cacheEvent in front of us, it'll handle subsequent subscribers, and if not, we won't get subsequent subscribers
2035+ -- Once we're done with this, we can clear it immediately, because if there's a cacheEvent in front of us,
2036+ -- it'll handle subsequent subscribers, and if not, we won't get subsequent subscribers
2037+ liftIO $ writeIORef (_merge_accumRef m) $! DMap.empty
18962038 --TODO: Assert that m is not empty
18972039 subscriberPropagate (_merge_sub m) vals
18982040
1899−mergeSubscriber :: forall x k v s a. (HasSpiderTimeline x, GCompare k) => Merge x k v s -> EventM x (k a) -> Subscriber x (v a)
1900−mergeSubscriber m getKey = Subscriber
2041+checkCycle :: HasSpiderTimeline x => EventSubscribed x -> EventM x ()
2042+checkCycle subscribed = liftIO $ do
2043+ height <- readIORef (eventSubscribedHeightRef subscribed)
2044+
2045+ -- currentHeight <- getCurrentHeight
2046+ -- when (height <= currentHeight) $ if height /= invalidHeight
2047+ -- then do
2048+ -- myStack <- liftIO $ whoCreatedIORef undefined --TODO
2049+ -- error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
2050+ -- else liftIO $
2051+ when (height == invalidHeight) $
2052+#ifdef DEBUG_CYCLES
2053+ do
2054+ nodesInvolvedInCycle <- walkInvalidHeightParents subscribed
2055+ stacks <- forM nodesInvolvedInCycle whoCreatedEventSubscribed
2056+ throwIO (EventLoopException stacks)
2057+#else
2058+ throwIO EventLoopException
2059+#endif
2060+
2061+
2062+mergeSubscriber :: forall x k v s a. (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> EventM x (k a) -> Subscriber x (v a)
2063+mergeSubscriber subscribed m getKey = Subscriber
19012064 { subscriberPropagate = \a -> do
19022065 oldM <- liftIO $ readIORef $ _merge_accumRef m
19032066 k <- getKey
1904− let newM = DMap.insertWith (error $ "Same key fired multiple times for Merge") k a oldM
2067+ let newM = DMap.insertWith (error "Same key fired multiple times for Merge") k a oldM
19052068 tracePropagate (Proxy :: Proxy x) $ " DMap.size oldM = " <> show (DMap.size oldM) <> "; DMap.size newM = " <> show (DMap.size newM)
19062069 liftIO $ writeIORef (_merge_accumRef m) $! newM
19072070 when (DMap.null oldM) $ do -- Only schedule the firing once
19082071 height <- liftIO $ readIORef $ _merge_heightRef m
1909− --TODO: assertions about height
1910− currentHeight <- getCurrentHeight
1911− when (height <= currentHeight) $ do
1912− if height /= invalidHeight
1913− then do
1914− myStack <- liftIO $ whoCreatedIORef undefined --TODO
1915− error $ "Height (" ++ show height ++ ") is not greater than current height (" ++ show currentHeight ++ ")\n" ++ unlines (reverse myStack)
1916− else liftIO $ do
1917−#ifdef DEBUG_CYCLES
1918− nodesInvolvedInCycle <- walkInvalidHeightParents $ eventSubscribedMerge subscribed
1919− stacks <- forM nodesInvolvedInCycle $ \(Some es) -> whoCreatedEventSubscribed es
1920− let cycleInfo = ":\n" <> drawForest (listsToForest stacks)
1921−#else
1922− let cycleInfo = ""
1923−#endif
1924− error $ "Causality loop found" <> cycleInfo
2072+ checkCycle subscribed
2073+
19252074 scheduleMergeSelf m height
19262075 , subscriberInvalidateHeight = \old -> do --TODO: When removing a parent doesn't actually change the height, maybe we can avoid invalidating
19272076 modifyIORef' (_merge_heightBagRef m) $ heightBagRemove old
@@ -1932,31 +2081,45 @@ mergeSubscriber m getKey = Subscriber
19322081 }
19332082
19342083--TODO: Be able to run as much of this as possible promptly
1935−updateMerge :: (HasSpiderTimeline x, GCompare k) => Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
1936−updateMerge m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
2084+updateMerge :: (HasSpiderTimeline x, GCompare k) => EventSubscribed x -> Merge x k v s -> MergeUpdateFunc k v x p s -> p -> SomeMergeUpdate x
2085+updateMerge subscribed m updateFunc p = SomeMergeUpdate updateMe (invalidateMergeHeight m) (revalidateMergeHeight m)
19372086 where updateMe = do
19382087 oldParents <- liftIO $ readIORef $ _merge_parentsRef m
1939− (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber m) (_merge_heightBagRef m) oldParents p
2088+ (subscriptionsToKill, newParents) <- updateFunc (mergeSubscriber subscribed m) (_merge_heightBagRef m) oldParents p
19402089 liftIO $ writeIORef (_merge_parentsRef m) $! newParents
19412090 return subscriptionsToKill
19422091
19432092{-# INLINE mergeGCheap' #-}
19442093mergeGCheap' :: forall k v x p s q. (HasSpiderTimeline x, GCompare k, PatchTarget p ~ DMap k q)
1945− => MergeInitFunc k v q x s -> MergeUpdateFunc k v x p s -> MergeDestroyFunc k s -> DynamicS x p -> Event x (DMap k v)
1946−mergeGCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
2094+ => MergeGetSubscription x s -> MergeInitFunc k v q x s -> MergeUpdateFunc k v x p s -> MergeDestroyFunc k s -> DynamicS x p -> Event x (DMap k v)
2095+mergeGCheap' getParent getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
19472096 initialParents <- readBehaviorUntracked $ dynamicCurrent d
19482097 accumRef <- liftIO $ newIORef $ error "merge: accumRef not yet initialized"
19492098 heightRef <- liftIO $ newIORef $ error "merge: heightRef not yet initialized"
19502099 heightBagRef <- liftIO $ newIORef $ error "merge: heightBagRef not yet initialized"
19512100 parentsRef :: IORef (DMap k s) <- liftIO $ newIORef $ error "merge: parentsRef not yet initialized"
1952− let m = Merge
2101+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2102+
2103+ let subscribed = EventSubscribed
2104+ { eventSubscribedHeightRef = heightRef
2105+ , eventSubscribedRetained = toAny (parentsRef, changeSubdRef)
2106+#ifdef DEBUG_CYCLES
2107+ , eventSubscribedGetParents = do
2108+ let getParent' (_ :=> v) = _eventSubscription_subscribed (getParent v)
2109+ fmap getParent' . DMap.toList <$> readIORef parentsRef
2110+ , eventSubscribedHasOwnHeightRef = False
2111+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2112+#endif
2113+ }
2114+
2115+ m = Merge
19532116 { _merge_parentsRef = parentsRef
19542117 , _merge_heightBagRef = heightBagRef
19552118 , _merge_heightRef = heightRef
19562119 , _merge_sub = sub
19572120 , _merge_accumRef = accumRef
19582121 }
1959− (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber m
2122+ (dm, heights, initialParentState) <- getInitialSubscribers initialParents $ mergeSubscriber subscribed m
19602123 let myHeightBag = heightBagFromList $ filter (/= invalidHeight) heights
19612124 myHeight = if invalidHeight `elem` heights
19622125 then invalidHeight
@@ -1965,31 +2128,29 @@ mergeGCheap' getInitialSubscribers updateFunc destroy d = Event $ \sub -> do
19652128 let (occ, accum) = if currentHeight >= myHeight -- If we should have fired by now
19662129 then (if DMap.null dm then Nothing else Just dm, DMap.empty)
19672130 else (Nothing, dm)
1968− unless (DMap.null accum) $ do
1969− scheduleMergeSelf m myHeight
2131+ unless (DMap.null accum) $ scheduleMergeSelf m myHeight
19702132 liftIO $ writeIORef accumRef $! accum
19712133 liftIO $ writeIORef heightRef $! myHeight
19722134 liftIO $ writeIORef heightBagRef $! myHeightBag
1973− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
19742135 liftIO $ writeIORef parentsRef $! initialParentState
19752136 defer $ SomeMergeInit $ do
1976− let s = Subscriber
2137+ let changeSubscriber = Subscriber
19772138 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
1978− tracePropagate (Proxy :: Proxy x) $ "SubscriberMerge/Change"
1979− defer $ updateMerge m updateFunc a
2139+ tracePropagate (Proxy :: Proxy x) "SubscriberMerge/Change"
2140+ defer $ updateMerge subscribed m updateFunc a
19802141 , subscriberInvalidateHeight = \_ -> return ()
19812142 , subscriberRecalculateHeight = \_ -> return ()
19822143 }
1983− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
1984− forM_ change $ \c -> defer $ updateMerge m updateFunc c
2144+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
2145+ forM_ change $ \c -> defer $ updateMerge subscribed m updateFunc c
19852146 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
19862147 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
19872148 -- its subscription.
1988− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2149+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
19892150 let unsubscribeAll = destroy =<< readIORef parentsRef
1990− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parentsRef, changeSubdRef)
1991− , occ
1992− )
2151+
2152+ return (EventSubscription unsubscribeAll subscribed, occ)
2153+
19932154
19942155mergeInt :: forall x a. (HasSpiderTimeline x) => DynamicS x (PatchIntMap (Event x a)) -> Event x (IntMap a)
19952156mergeInt = cacheEvent . mergeIntCheap
@@ -2002,13 +2163,22 @@ mergeIntCheap d = Event $ \sub -> do
20022163 heightRef <- liftIO $ newIORef zeroHeight
20032164 heightBagRef <- liftIO $ newIORef heightBagEmpty
20042165 parents <- liftIO $ FastMutableIntMap.newEmpty
2166+ changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
2167+ let subscribed = EventSubscribed
2168+ { eventSubscribedHeightRef = heightRef
2169+ , eventSubscribedRetained = toAny (parents, changeSubdRef)
2170+#ifdef DEBUG_CYCLES
2171+ , eventSubscribedGetParents = fmap (_eventSubscription_subscribed . snd) <$> FastMutableIntMap.toList parents
2172+ , eventSubscribedHasOwnHeightRef = False
2173+ , eventSubscribedWhoCreated = whoCreatedIORef heightRef
2174+#endif
2175+ }
20052176 let scheduleSelf = do
20062177 height <- liftIO $ readIORef $ heightRef
20072178 scheduleMerge' height heightRef $ do
20082179 vals <- liftIO $ FastMutableIntMap.getFrozenAndClear accum
20092180 subscriberPropagate sub vals
2010− invalidateMyHeight = do
2011− invalidateMergeHeight' heightRef sub
2181+ invalidateMyHeight = invalidateMergeHeight' heightRef sub
20122182 recalculateMyHeight = do
20132183 currentHeight <- readIORef heightRef
20142184 when (currentHeight == invalidHeight) $ do --TODO: This will almost always be true; can we get rid of this check and just proceed to the next one always?
@@ -2018,12 +2188,14 @@ mergeIntCheap d = Event $ \sub -> do
20182188 LT -> return ()
20192189 EQ -> do
20202190 let height = succHeight $ heightBagMax heights
2021− when debugInvalidateHeight $ putStrLn $ "recalculateSubscriberHeight: height: " <> show height
2191+ traceInvalidateHeight $ "recalculateSubscriberHeight: height: " <> show height
20222192 writeIORef heightRef $! height
20232193 subscriberRecalculateHeight sub height
20242194 GT -> error $ "revalidateMergeHeight: more heights (" <> show (heightBagSize heights) <> ") than parents (" <> show numParents <> ") for Merge"
20252195 mySubscriber k = Subscriber
20262196 { subscriberPropagate = \a -> do
2197+ checkCycle subscribed
2198+
20272199 wasEmpty <- liftIO $ FastMutableIntMap.isEmpty accum
20282200 liftIO $ FastMutableIntMap.insert accum k a
20292201 when wasEmpty scheduleSelf
@@ -2057,7 +2229,6 @@ mergeIntCheap d = Event $ \sub -> do
20572229 else liftIO $ Just <$> FastMutableIntMap.getFrozenAndClear accum
20582230 else do when (not isEmpty) scheduleSelf -- We have things accumulated, but we shouldn't have fired them yet
20592231 return Nothing
2060− changeSubdRef <- liftIO $ newIORef $ error "getMergeSubscribed: changeSubdRef not yet initialized"
20612232 defer $ SomeMergeInit $ do
20622233 let updateMe a = SomeMergeUpdate u invalidateMyHeight recalculateMyHeight
20632234 where
@@ -2071,25 +2242,27 @@ mergeIntCheap d = Event $ \sub -> do
20712242 oldParents <- liftIO $ FastMutableIntMap.applyPatch parents newSubscriptions
20722243 liftIO $ for_ oldParents $ \oldParent -> do
20732244 oldParentHeight <- getEventSubscribedHeight $ _eventSubscription_subscribed oldParent
2245+
2246+ print ("updateMe", oldParentHeight)
20742247 modifyIORef' heightBagRef $ heightBagRemove oldParentHeight
20752248 return $ IntMap.elems oldParents
2076− let s = Subscriber
2249+ let changeSubscriber = Subscriber
20772250 { subscriberPropagate = \a -> {-# SCC "traverseMergeChange" #-} do
20782251 tracePropagate (Proxy :: Proxy x) $ "SubscriberMergeInt/Change"
20792252 defer $ updateMe a
20802253 , subscriberInvalidateHeight = \_ -> return ()
20812254 , subscriberRecalculateHeight = \_ -> return ()
20822255 }
2083− (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) s
2256+ (changeSubscription, change) <- subscribeAndRead (dynamicUpdated d) changeSubscriber
20842257 forM_ change $ \c -> defer $ updateMe c
20852258 -- We explicitly hold on to the unsubscribe function from subscribing to the update event.
20862259 -- If we don't do this, there are certain cases where mergeCheap will fail to properly retain
20872260 -- its subscription.
2088− liftIO $ writeIORef changeSubdRef (s, changeSubscription)
2261+ liftIO $ writeIORef changeSubdRef (changeSubscriber, changeSubscription)
20892262 let unsubscribeAll = traverse_ unsubscribe =<< FastMutableIntMap.getFrozenAndClear parents
2090− return ( EventSubscription unsubscribeAll $ EventSubscribed heightRef $ toAny (parents, changeSubdRef)
2091− , occ
2092− )
2263+
2264+
2265+ return (EventSubscription unsubscribeAll subscribed, occ)
20932266
20942267newtype EventSelector x k = EventSelector { select :: forall a. k a -> Event x a }
20952268newtype EventSelectorG x k v = EventSelectorG { selectG :: forall a. k a -> Event x (v a) }
@@ -2172,19 +2345,19 @@ runFrame a = SpiderHost $ do
21722345 coincidenceInfos <- readIORef $ eventEnvResetCoincidences env
21732346 forM_ toAssign $ \(SomeAssignment vRef iRef v) -> {-# SCC "assignment" #-} do
21742347 writeIORef vRef v
2175− when debugInvalidate $ putStrLn $ "Invalidating Hold"
2348+ traceInvalidate $ "Invalidating Hold"
21762349 writeIORef iRef =<< evaluate =<< invalidate toReconnectRef =<< readIORef iRef
21772350 mergeUpdates <- readIORef $ eventEnvMergeUpdates env
21782351 writeIORef (eventEnvMergeUpdates env) []
2179− when debugPropagate $ putStrLn "Updating merges"
2352+ tracePropagate (Proxy::Proxy x) $ "Updating merges"
21802353 mergeSubscriptionsToKill <- runEventM $ concat <$> mapM _someMergeUpdate_update mergeUpdates
2181− when debugPropagate $ putStrLn "Updating merges done"
2354+ tracePropagate (Proxy::Proxy x) $ "Updating merges done"
21822355 toReconnect <- readIORef toReconnectRef
21832356 clearEventEnv env
21842357 switchSubscriptionsToKill <- forM toReconnect $ \(SomeSwitchSubscribed subscribed) -> {-# SCC "switchSubscribed" #-} do
21852358 oldSubscription <- readIORef $ switchSubscribedCurrentParent subscribed
21862359 wi <- readIORef $ switchSubscribedOwnWeakInvalidator subscribed
2187− when debugInvalidate $ putStrLn $ "Finalizing invalidator for Switch" <> showNodeId subscribed
2360+ traceInvalidate $ "Finalizing invalidator for Switch" <> showNodeId subscribed
21882361 finalize wi
21892362 i <- evaluate $ switchSubscribedOwnInvalidator subscribed
21902363 wi' <- mkWeakPtrWithDebug i "wi'"
@@ -2198,7 +2371,7 @@ runFrame a = SpiderHost $ do
21982371 subscription <- unSpiderHost $ runFrame $ {-# SCC "subscribeSwitch" #-} subscribe e sub --TODO: Assert that the event isn't firing --TODO: This should not loop because none of the events should be firing, but still, it is inefficient
21992372 {-
22002373 stackTrace <- liftIO $ fmap renderStack $ ccsToStrings =<< (getCCSOf $! switchSubscribedParent subscribed)
2201− liftIO $ putStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
2374+ liftIO $ debugStrLn $ (++stackTrace) $ "subd' subscribed to " ++ case e of
22022375 EventRoot _ -> "EventRoot"
22032376 EventNever -> "EventNever"
22042377 _ -> "something else"
@@ -2490,13 +2663,13 @@ instance HasSpiderTimeline x => Reflex.Host.Class.MonadReadEvent (SpiderTimeline
24902663 touch h
24912664 return result
24922665
2493−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
2666+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHost x) where
24942667 newEventWithTrigger = SpiderHost . fmap SpiderEvent . newEventWithTriggerIO
24952668 newFanEventWithTrigger f = SpiderHost $ do
24962669 es <- newFanEventWithTriggerIO f
24972670 return $ Reflex.Class.EventSelector $ SpiderEvent . Reflex.Spider.Internal.select es
24982671
2499−instance Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
2672+instance HasSpiderTimeline x => Reflex.Host.Class.MonadReflexCreateTrigger (SpiderTimeline x) (SpiderHostFrame x) where
25002673 newEventWithTrigger = SpiderHostFrame . EventM . liftIO . fmap SpiderEvent . newEventWithTriggerIO
25012674 newFanEventWithTrigger f = SpiderHostFrame $ EventM $ liftIO $ do
25022675 es <- newFanEventWithTriggerIO f
@@ -2682,12 +2855,12 @@ instance NotReady (SpiderTimeline x) (SpiderHostFrame x) where
26822855 notReadyUntil _ = pure ()
26832856 notReady = pure ()
26842857
2685−newEventWithTriggerIO :: (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
2858+newEventWithTriggerIO :: forall x a. HasSpiderTimeline x => (RootTrigger x a -> IO (IO ())) -> IO (Event x a)
26862859newEventWithTriggerIO f = do
26872860 es <- newFanEventWithTriggerIO $ \Refl -> f
26882861 return $ select es Refl
26892862
2690−newFanEventWithTriggerIO :: GCompare k => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
2863+newFanEventWithTriggerIO :: (HasSpiderTimeline x, GCompare k) => (forall a. k a -> RootTrigger x a -> IO (IO ())) -> IO (EventSelector x k)
26912864newFanEventWithTriggerIO f = do
26922865 occRef <- newIORef DMap.empty
26932866 subscribedRef <- newIORef DMap.empty
@@ -2728,4 +2901,4 @@ instance NotReady (SpiderTimeline x) (SpiderHost x) where
27282901
27292902instance HasSpiderTimeline x => NotReady (SpiderTimeline x) (PerformEventT (SpiderTimeline x) (SpiderHost x)) where
27302903 notReadyUntil _ = return ()
2731− notReady = return ()
2904+ notReady = return ()
test/DebugCycles.hsnew file+171
@@ -0,0 +1,171 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE GADTs #-}
5+{-# LANGUAGE RecursiveDo #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE PatternSynonyms #-}
8+{-# LANGUAGE RankNTypes #-}
9+
10+module Main where
11+
12+import Data.Foldable
13+import Control.Lens
14+import Control.Applicative
15+import Control.Monad
16+import Control.Monad.Fix
17+import Control.Exception
18+import System.Timeout
19+import Data.Maybe (isJust)
20+import Data.Functor.Misc
21+import qualified Data.Map as Map
22+import Data.Map (Map)
23+import qualified Data.IntMap as IntMap
24+import Data.IntMap (IntMap)
25+import Data.These
26+import Data.Align
27+import Reflex
28+import Reflex.EventWriter.Base
29+import Test.Run
30+import Test.Hspec
31+import Reflex.Spider.Internal (EventLoopException)
32+import Data.Witherable (Filterable)
33+
34+#if defined(MIN_VERSION_these_lens) || (MIN_VERSION_these(0,8,0) && !MIN_VERSION_these(0,9,0))
35+import Data.These.Lens
36+#endif
37+
38+type Widget t m = (MonadHold t m, Reflex t, MonadFix m)
39+
40+connectDyn :: Widget t m => Event t () -> (Dynamic t a, Dynamic t a) -> m (Dynamic t a)
41+connectDyn e (d, d') = do
42+ dd <- holdDyn d (d' <$ e)
43+ return $ join dd
44+
45+dynLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
46+dynLoop (e1, e2) = do
47+ -- "heightBagRemove: Height 2 not present in bag HeightBag {_heightBag_size = 2, _heightBag_contents = fromList [(0,1)]}"
48+ rec
49+ d <- count e1
50+ d' <- connectDyn e2 (d, liftA2 (+) d d')
51+ return $ updated d'
52+
53+connectOnCoincidence :: Widget t m => Event t () -> Event t a -> m (Event t a)
54+connectOnCoincidence click e = do
55+ d <- holdDyn never (e <$ click)
56+ return $ coincidence (updated d)
57+
58+coincidenceLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
59+coincidenceLoop (e1, e2) = do
60+-- "heightBagRemove: Height 1 not present in bag HeightBag {_heightBag_size = 1, _heightBag_contents = fromList [(0,0)]}"
61+-- (simpler version of dynLoop)
62+ rec
63+ e' <- connectOnCoincidence e2 (updated d)
64+ d <- count (align e' e1)
65+ return $ updated d
66+
67+addHeight :: Reflex t => Event t a -> Event t a
68+addHeight e = leftmost [e4, e4] where
69+ e1 = leftmost [e, e]
70+ e2 = leftmost [e1, e1]
71+ e3 = leftmost [e2, e2]
72+ e4 = leftmost [e3, e3]
73+
74+-- Take an existing test and build it inside a
75+buildLoop :: Widget t m => (forall t m. Widget t m => (Event t Int, Event t ()) -> m (Event t Int)) -> (Event t Int, Event t ()) -> m (Event t Int)
76+buildLoop test (e1, e2) = switchHold never buildLoop
77+ where buildLoop = pushAlways (const $ test (e1, e2)) e2
78+
79+connectButtonPromptly :: Widget t m => Event t () -> Event t a -> m (Event t a)
80+connectButtonPromptly click e = do
81+ d <- holdDyn never (e <$ click)
82+ return (switchDyn d)
83+
84+connectButton :: Widget t m => Event t () -> Event t a -> m (Event t a)
85+connectButton click e = do
86+ d <- hold never (e <$ click)
87+ return (switch d)
88+
89+switchLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
90+switchLoop01 (e1, e2) = do
91+ rec
92+ e' <- connectButton e2 (updated d)
93+ d <- count (align e' e1)
94+ return $ updated d
95+
96+mergeLoop :: forall t m. (Adjustable t m, Widget t m) => (Event t Int, Event t ()) -> m (Event t Int)
97+mergeLoop (e1, e2) = do
98+ rec
99+ (_, e) <- runEventWriterT $
100+ runWithReplace w (leftmost [w <$ e1])
101+ return (sum <$> e)
102+ where
103+ w = do
104+ c <- count e1
105+ tellEvent (updated ((pure <$> c) :: Dynamic t [Int]))
106+
107+switchLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
108+switchLoop02 (e1, e2) = do
109+ rec
110+ e' <- connectButton e2 (updated d)
111+ d <- count (leftmost [e', e1])
112+ return $ updated d
113+
114+switchLoop03 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
115+switchLoop03 (e1, e2) = do
116+ rec
117+ e' <- connectButton e2 (addHeight $ updated d)
118+ d <- count (align e' e1)
119+ return $ updated d
120+
121+staticLoop01 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
122+staticLoop01 (e1, e2) = do
123+ rec
124+ d <- foldDyn (+) (0 :: Int) (1 <$ align e1 (updated d))
125+ return $ updated d
126+
127+staticLoop02 :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
128+staticLoop02 (e1, e2) = do
129+ rec
130+ d <- foldDyn (+) (0 :: Int) (leftmost [e1, updated d])
131+ return $ updated d
132+
133+buildStaticLoop :: Widget t m => (Event t Int, Event t ()) -> m (Event t Int)
134+buildStaticLoop (e1, e2) = switchHold never buildLoop
135+ where buildLoop = pushAlways (const $ staticLoop01 (e1, e2)) e2
136+
137+splitThese :: Filterable f => f (These a b) -> (f a, f b)
138+splitThese f = (mapMaybe (preview here) f, mapMaybe (preview there) f)
139+
140+main :: IO ()
141+main = hspec $ do
142+ describe "DebugCycles" $ do
143+ it "throws EventLoopException on switchLoop01" $ do
144+ check switchLoop01
145+ it "throws EventLoopException on switchLoop02" $ do
146+ check switchLoop02
147+ it "throws EventLoopException on switchLoop03" $ do
148+ check switchLoop03
149+ it "throws EventLoopException on buildSwitchLoop" $ do
150+ check $ buildLoop switchLoop01
151+ xit "throws EventLoopException on mergeLoop" $ do
152+ check mergeLoop
153+ xit "throws EventLoopException on staticLoop01" $ do
154+ check staticLoop01
155+ xit "throws EventLoopException on staticLoop02" $ do
156+ check staticLoop02
157+ xit "throws EventLoopException on buildStaticLoop" $ do
158+ check buildStaticLoop
159+ xit "throws EventLoopException on coincidenceLoop" $ do
160+ check coincidenceLoop
161+ xit "throws EventLoopException on dynLoop" $ do
162+ check dynLoop
163+ xit "throws EventLoopException on buildCoincidenceLoop" $ do
164+ check $ buildLoop coincidenceLoop
165+ where
166+ milliseconds = (*1000)
167+ occs = [ This 1, This 2, That (), This 3, That (), This 1 ]
168+ check test = do
169+ let action = timeout (milliseconds 50) $ do
170+ runApp' (test . splitThese) (Just <$> occs)
171+ action `shouldThrow` (const True :: Selector EventLoopException)
test/GC.hs−1
@@ -83,7 +83,6 @@ hostPerf ref = S.runSpiderHost $ do
8383 Nothing -> []
8484 Host.fireEventsAndRead followupEventTriggers $ return ()
8585 return ()
86− return ()
8786
8887data Tell a where
8988 Action :: Tell ()