@@ -1,12 +1,9 @@
1−{-# OPTIONS_GHC -fno-warn-orphans #-}
21{-# LANGUAGE BangPatterns #-}
3−{-# LANGUAGE StandaloneDeriving #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE UndecidableInstances #-}
62{-# LANGUAGE ConstraintKinds #-}
7−{-# LANGUAGE CPP #-}
83{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
95{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
107{-# LANGUAGE LambdaCase #-}
118{-# LANGUAGE MultiParamTypeClasses #-}
129{-# LANGUAGE OverloadedStrings #-}
@@ -14,27 +11,43 @@
1411{-# LANGUAGE RankNTypes #-}
1512{-# LANGUAGE RecursiveDo #-}
1613{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
1715{-# LANGUAGE TemplateHaskell #-}
1816{-# LANGUAGE TupleSections #-}
1917{-# LANGUAGE TypeApplications #-}
2018{-# LANGUAGE TypeFamilies #-}
19+{-# LANGUAGE UndecidableInstances #-}
2120
21+{-# OPTIONS_GHC -fno-warn-orphans #-}
22+
23+-- Notice to those working on this test suite:
24+-- It doesn't appear to be possible to use --match to run a particular test, in
25+-- this situation the test may hang before reaching our code. This seems to
26+-- happen when the test is not the first test in the block. As a workaround, you
27+-- can just comment out the other tests. Also, using `xit` will cause the same
28+-- issue. `xit` tests must be the last tests in the session, or the session will
29+-- hang in the following test.
30+
31+import Prelude hiding (fail)
2232import Control.Concurrent
23−import Control.Monad
33+import qualified Control.Concurrent.Async as Async
34+import Control.Lens.Operators
35+import Control.Monad hiding (fail)
2436import Control.Monad.Catch
37+import Control.Monad.Fail
2538import Control.Monad.Fix
2639import Control.Monad.IO.Class
2740import Control.Monad.Ref
2841import Data.Constraint.Extras
2942import Data.Constraint.Extras.TH
3043import Data.Dependent.Map (DMap)
31−import Data.Dependent.Sum (DSum(..), (==>), EqTag(..), ShowTag(..))
32−--import Data.Foldable (traverse_)
44+import Data.Dependent.Sum (DSum(..), (==>))
3345import Data.Functor.Identity
3446import Data.Functor.Misc
3547import Data.GADT.Compare.TH
3648import Data.GADT.Show.TH
3749import Data.IORef (IORef)
50+import Data.List (sort)
3851import Data.Maybe
3952import Data.Proxy
4053import Data.Text (Text)
@@ -45,6 +58,7 @@ import Network.Socket
4558import Network.Wai
4659import Network.WebSockets
4760import Reflex.Dom.Core
61+import Reflex.Dom.Widget.Input (dropdown)
4862import Reflex.Patch.DMapWithMove
4963import System.Directory
5064import System.Environment
@@ -52,12 +66,14 @@ import System.IO (stderr)
5266import System.IO.Silently
5367import System.IO.Temp
5468import System.Process
55−import qualified Test.HUnit as HUnit (assertEqual, assertFailure)
69+import System.Which (staticWhich)
70+import qualified Test.HUnit as HUnit
5671import qualified Test.Hspec as H
72+import qualified Test.Hspec.Core.Spec as H
5773import Test.Hspec (xit)
58−import Test.Hspec.WebDriver hiding (runWD, click, uploadFile)
74+import Test.Hspec.WebDriver hiding (runWD, click, uploadFile, WD)
5975import qualified Test.Hspec.WebDriver as WD
60−import Test.WebDriver (WD)
76+import Test.WebDriver (WD(..))
6177
6278import qualified Data.ByteString.Lazy as LBS
6379import qualified Data.Dependent.Map as DMap
@@ -73,19 +89,32 @@ import qualified Test.WebDriver.Capabilities as WD
7389import Test.Util.ChromeFlags
7490import Test.Util.UnshareNetwork
7591
92+-- ORPHAN: https://github.com/kallisti-dev/hs-webdriver/pull/167
93+deriving instance MonadMask WD
94+
95+chromium :: FilePath
96+chromium = $(staticWhich "chromium")
97+
7698seleniumPort, jsaddlePort :: PortNumber
7799seleniumPort = 8000
78100jsaddlePort = 8001
79101
80102-- TODO Remove orphan
81−deriving instance MonadRef WD
103+instance MonadRef WD where
104+ type Ref WD = Ref IO
105+ newRef = WD . newRef
106+ readRef = WD . readRef
107+ writeRef r = WD . writeRef r
82108
83109assertEqual :: (MonadIO m, Eq a, Show a) => String -> a -> a -> m ()
84−assertEqual a b = liftIO . HUnit.assertEqual a b
110+assertEqual msg a b = liftIO $ HUnit.assertEqual msg a b
85111
86112assertFailure :: MonadIO m => String -> m ()
87113assertFailure = liftIO . HUnit.assertFailure
88114
115+assertBool :: (MonadIO m) => String -> Bool -> m ()
116+assertBool msg bool = liftIO $ HUnit.assertBool msg bool
117+
89118chromeConfig :: Text -> [Text] -> WD.WDConfig
90119chromeConfig fp flags = WD.useBrowser (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags }) WD.defaultConfig
91120
@@ -112,35 +141,26 @@ deriveGEq ''DKey
112141deriveGCompare ''DKey
113142deriveGShow ''DKey
114143
115−instance ShowTag DKey Identity where
116− showTaggedPrec = \case
117− Key_Int -> showsPrec
118− Key_Char -> showsPrec
119− Key_Bool -> showsPrec
120−
121−instance EqTag DKey Identity where
122− eqTagged Key_Int Key_Int = (==)
123− eqTagged Key_Char Key_Char = (==)
124− eqTagged Key_Bool Key_Bool = (==)
144+deriving instance MonadFail WD
125145
126146main :: IO ()
127147main = do
128− unshareNetork
148+ unshareNetwork
129149 isHeadless <- (== Nothing) <$> lookupEnv "NO_HEADLESS"
130150 withSandboxedChromeFlags isHeadless $ \chromeFlags -> do
131151 withSeleniumServer $ \selenium -> do
132− browserPath <- liftIO $ T.strip . T.pack <$> readProcess "which" [ "chromium" ] ""
152+ let browserPath = T.strip $ T.pack chromium
133153 when (T.null browserPath) $ fail "No browser found"
134− withDebugging <- isJust <$> lookupEnv "DEBUG"
154+ withDebugging <- isNothing <$> lookupEnv "NO_DEBUG"
135155 let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _selenium_portNumber selenium }
136156 chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
137− hspec (tests withDebugging wdConfig [chromeCaps'] selenium) `finally` _selenium_stopServer selenium
157+ hspec (tests withDebugging wdConfig [(chromeCaps', "chrome")] selenium) `finally` _selenium_stopServer selenium
138158
139−tests :: Bool -> WD.WDConfig -> [Capabilities] -> Selenium -> Spec
159+tests :: Bool -> WD.WDConfig -> [(Capabilities, String)] -> Selenium -> Spec
140160tests withDebugging wdConfig caps _selenium = do
141161 let putStrLnDebug :: MonadIO m => Text -> m ()
142162 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
143− session' = sessionWith wdConfig "" . using (map (,"") caps)
163+ session' t = sessionWith wdConfig t . using caps
144164 runWD m = runWDOptions (WdOptions False) $ do
145165 putStrLnDebug "before"
146166 r <- m
@@ -149,10 +169,10 @@ tests withDebugging wdConfig caps _selenium = do
149169 testWidgetStatic :: WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
150170 testWidgetStatic = testWidgetStaticDebug withDebugging
151171 testWidget :: WD () -> WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
152− testWidget = testWidgetDebug withDebugging
172+ testWidget = testWidgetDebug True withDebugging
153173 testWidget' :: WD a -> (a -> WD b) -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
154− testWidget' = testWidgetDebug' withDebugging
155− describe "text" $ session' $ do
174+ testWidget' = testWidgetDebug' True withDebugging
175+ session' "text" $ do
156176 it "works" $ runWD $ do
157177 testWidgetStatic (checkBodyText "hello world") $ do
158178 text "hello world"
@@ -213,7 +233,7 @@ tests withDebugging wdConfig caps _selenium = do
213233 click <- button ""
214234 void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
215235
216− describe "element" $ session' $ do
236+ session' "element" $ do
217237 it "works with domEvent Click" $ runWD $ do
218238 clickedRef <- liftIO $ newRef False
219239 testWidget' (findElemWithRetry $ WD.ByTag "div") WD.click $ do
@@ -276,36 +296,86 @@ tests withDebugging wdConfig caps _selenium = do
276296 (e, ()) <- element "div" conf $ text "hello world"
277297 let click = domEvent Click e
278298 return ()
279− -- TODO check this is the correct solution
280− it "has ssr attribute, removes ssr attribute" $ runWD $ do
281− let checkSSRAttr = do
282− e <- findElemWithRetry $ WD.ByTag "div"
283− assertAttr e "data-ssr" (Just "")
284− pure e
285− testWidget' checkSSRAttr (\e -> assertAttr e "data-ssr" Nothing) $ el "div" $ text "hello world"
286299
287− describe "inputElement" $ do
288− describe "hydration" $ session' $ do
300+ session' "inputElement" $ do
301+ describe "static renderer" $ do
302+ it "sets value attribute" $ runWD $ do
303+ let checkStatic = do
304+ e <- findElemWithRetry $ WD.ByTag "input"
305+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
306+ pure e
307+ checkHydrated e = do
308+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
309+ testWidget' checkStatic checkHydrated $ void $ inputElement $ def
310+ & inputElementConfig_initialValue .~ "test"
311+ it "updates value attribute at postBuild" $ runWD $ do
312+ let checkStatic = do
313+ e <- findElemWithRetry $ WD.ByTag "input"
314+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
315+ pure e
316+ checkHydrated e = do
317+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
318+ testWidget' checkStatic checkHydrated $ do
319+ pb <- getPostBuild
320+ _ <- inputElement $ def
321+ & inputElementConfig_initialValue .~ "test"
322+ & inputElementConfig_setValue .~ ("test-updated" <$ pb)
323+ pure ()
324+ it "sets checked attr appropriately" $ runWD $ do
325+ setCheckedChan <- liftIO newChan
326+ let checkStatic = do
327+ e <- findElemWithRetry $ WD.ByTag "input"
328+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
329+ pure e
330+ checkValue e = do
331+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
332+ WD.moveToCenter e
333+ WD.click e -- Click to uncheck
334+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
335+ liftIO $ writeChan setCheckedChan True -- Programatically check the checkbox
336+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
337+ testWidget' checkStatic checkValue $ do
338+ setChecked <- triggerEventWithChan setCheckedChan
339+ _ <- inputElement $ def
340+ & initialAttributes .~ "type" =: "checkbox"
341+ & inputElementConfig_initialChecked .~ True
342+ & inputElementConfig_setChecked .~ setChecked
343+ pure ()
344+ it "sets checked attr appropriately at postbuild" $ runWD $ do
345+ let checkStatic = do
346+ e <- findElemWithRetry $ WD.ByTag "input"
347+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
348+ pure e
349+ checkValue e = do
350+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
351+ testWidget' checkStatic checkValue $ do
352+ pb <- getPostBuild
353+ _ <- inputElement $ def
354+ & initialAttributes .~ "type" =: "checkbox"
355+ & inputElementConfig_initialChecked .~ False
356+ & inputElementConfig_setChecked .~ (True <$ pb)
357+ pure ()
358+ describe "hydration" $ do
289359 it "doesn't wipe user input when switching over" $ runWD $ do
290− inputRef <- newRef ("" :: Text)
360+ inputRef <- newRef ("hello " :: Text)
291361 testWidget'
292362 (do
293363 e <- findElemWithRetry $ WD.ByTag "input"
294− WD.sendKeys "hello world" e
364+ WD.sendKeys "world" e
295365 pure e)
296366 (\e -> do
297367 WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
298− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
368+ WD.click =<< findElemWithRetry (WD.ByTag "button")
299369 readRef inputRef `shouldBeWithRetryM` "hello world"
300370 ) $ do
301− e <- inputElement def
371+ e <- inputElement $ def & inputElementConfig_initialValue .~ "hello "
302372 click <- button "save"
303373 performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
304374 it "captures user input after switchover" $ runWD $ do
305375 inputRef <- newRef ("" :: Text)
306376 let checkValue = do
307− WD.sendKeys "hello world" =<< (findElemWithRetry $ WD.ByTag "input")
308− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
377+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
378+ WD.click =<< findElemWithRetry (WD.ByTag "button")
309379 readRef inputRef `shouldBeWithRetryM` "hello world"
310380 testWidget (pure ()) checkValue $ do
311381 e <- inputElement def
@@ -355,31 +425,56 @@ tests withDebugging wdConfig caps _selenium = do
355425 checkedByUIRef <- newRef False
356426 checkedRef <- newRef False
357427 setCheckedChan <- liftIO newChan
358− let checkValue = do
428+ let checkStatic = do
429+ e <- findElemWithRetry $ WD.ByTag "input"
430+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
431+ pure e
432+ checkValue e = do
359433 readRef checkedByUIRef `shouldBeWithRetryM` False
360434 readRef checkedRef `shouldBeWithRetryM` False
361− e <- findElemWithRetry $ WD.ByTag "input"
435+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
362436 WD.moveToCenter e
363437 WD.click e
364438 readRef checkedByUIRef `shouldBeWithRetryM` True
365439 readRef checkedRef `shouldBeWithRetryM` True
440+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
366441 liftIO $ writeChan setCheckedChan False
367442 readRef checkedByUIRef `shouldBeWithRetryM` True
368443 readRef checkedRef `shouldBeWithRetryM` False
369− testWidget (pure ()) checkValue $ do
444+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
445+ testWidget' checkStatic checkValue $ do
370446 setChecked <- triggerEventWithChan setCheckedChan
371447 e <- inputElement $ def
372448 & initialAttributes .~ "type" =: "checkbox"
373449 & inputElementConfig_setChecked .~ setChecked
374450 performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
375451 performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
452+ it "respects user updates to checked which happen before hydration" $ runWD $ do
453+ checkedByUIRef <- newRef False
454+ checkedRef <- newRef False
455+ let checkStatic = do
456+ e <- findElemWithRetry $ WD.ByTag "input"
457+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
458+ WD.moveToCenter e
459+ WD.click e
460+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
461+ pure e
462+ checkValue e = do
463+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
464+ readRef checkedByUIRef `shouldBeWithRetryM` True
465+ readRef checkedRef `shouldBeWithRetryM` True
466+ testWidget' checkStatic checkValue $ do
467+ e <- inputElement $ def
468+ & initialAttributes .~ "type" =: "checkbox"
469+ performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
470+ performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
376471 it "captures file uploads" $ runWD $ do
377472 filesRef :: IORef [Text] <- newRef []
378473 let uploadFile = do
379474 e <- findElemWithRetry $ WD.ByTag "input"
380475 path <- liftIO $ writeSystemTempFile "testFile" "file contents"
381476 WD.sendKeys (T.pack path) e
382− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
477+ WD.click =<< findElemWithRetry (WD.ByTag "button")
383478 liftIO $ removeFile path
384479 readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
385480 testWidget (pure ()) uploadFile $ do
@@ -388,13 +483,122 @@ tests withDebugging wdConfig caps _selenium = do
388483 prerender_ (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
389484 names <- liftJSM $ traverse File.getName fs
390485 liftIO $ writeRef filesRef names
391−
392− describe "hydration/immediate" $ session' $ do
486+ it "fires _input event if the user altered the value before hydration" $ runWD $ do
487+ input <- newRef ("" :: Text)
488+ update <- newRef ("" :: Text)
489+ let checkStatic = do
490+ e <- findElemWithRetry $ WD.ByTag "input"
491+ WD.attr e "value" `shouldBeWithRetryM` Just ""
492+ WD.sendKeys "test" e
493+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
494+ pure e
495+ checkHydrated e = do
496+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
497+ readRef input `shouldBeWithRetryM` "test"
498+ readRef update `shouldBeWithRetryM` "test"
499+ testWidget' checkStatic checkHydrated $ do
500+ e <- inputElement def
501+ performEvent_ $ liftIO . writeRef input <$> _inputElement_input e
502+ performEvent_ $ liftIO . writeRef update <$> updated (_inputElement_value e)
503+ it "does not fire _input event when the value is updated at postBuild" $ runWD $ do
504+ input <- newRef (Nothing :: Maybe Text)
505+ let checkStatic = do
506+ e <- findElemWithRetry $ WD.ByTag "input"
507+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
508+ pure e
509+ checkHydrated e = do
510+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
511+ readRef input `shouldBeWithRetryM` Nothing
512+ testWidget' checkStatic checkHydrated $ do
513+ pb <- getPostBuild
514+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
515+ performEvent_ $ liftIO . writeRef input . Just <$> _inputElement_input e
516+ it "SSR produces correct DOM based on inputElement values when setValue happens at postBuild" $ runWD $ do
517+ let checkBoth = do
518+ input <- findElemWithRetry $ WD.ByTag "input"
519+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
520+ p <- findElemWithRetry (WD.ByTag "p")
521+ shouldContainText "pb" p
522+ testWidget checkBoth checkBoth $ do
523+ pb <- getPostBuild
524+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
525+ el "p" $ dynText $ _inputElement_value e
526+ it "does not fail when both setValue AND user updated value happen before switchover" $ runWD $ do
527+ let checkStatic = do
528+ input <- findElemWithRetry $ WD.ByTag "input"
529+ h2_value <- findElemWithRetry (WD.ByTag "h2")
530+ h3_input <- findElemWithRetry (WD.ByTag "h3")
531+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
532+ shouldContainText "pb" h2_value
533+ shouldContainText "" h3_input
534+ WD.sendKeys "abc" input
535+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
536+ shouldContainText "pb" h2_value
537+ shouldContainText "" h3_input
538+ pure (input, h2_value, h3_input)
539+ checkHydrated (input, h2_value, h3_input) = do
540+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
541+ shouldContainText "pbabc" h3_input
542+ shouldContainText "pbabc pb" h2_value
543+ pure ()
544+ testWidget' checkStatic checkHydrated $ do
545+ pb <- getPostBuild
546+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
547+ el "h1" $ dynText $ _inputElement_value e
548+ el "h2" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ updated $ _inputElement_value e
549+ el "h3" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ _inputElement_input e
550+ it "value is correct when both setValue AND user updated value happen before switchover" $ runWD $ do
551+ let checkStatic = do
552+ input <- findElemWithRetry $ WD.ByTag "input"
553+ p <- findElemWithRetry (WD.ByTag "p")
554+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
555+ shouldContainText "pb" p
556+ WD.sendKeys "abc" input
557+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
558+ shouldContainText "pb" p -- It won't be updated yet
559+ pure (input, p)
560+ checkHydrated (input, p) = do
561+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
562+ shouldContainText "pbabc" p
563+ pure ()
564+ testWidget' checkStatic checkHydrated $ do
565+ pb <- getPostBuild
566+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
567+ el "p" $ dynText $ _inputElement_value e
568+ it "input event and (updated value) fire correctly when both setValue AND user updated value happen before switchover" $ runWD $ do
569+ valRef <- newRef ([] :: [Text])
570+ inputRef <- newRef ([] :: [Text])
571+ let consRef ref a = liftIO $ atomicModifyRef ref $ \as -> (a:as, ())
572+ checkStatic = do
573+ input <- findElemWithRetry $ WD.ByTag "input"
574+ p <- findElemWithRetry (WD.ByTag "p")
575+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
576+ shouldContainText "pb" p
577+ WD.sendKeys "abc" input
578+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
579+ shouldContainText "pb" p -- It won't be updated yet
580+ readRef inputRef `shouldBeWithRetryM` [] -- Should never fire input ref during SSR
581+ readRef valRef `shouldBeWithRetryM` ["pb"]
582+ pure (input, p)
583+ checkHydrated (input, p) = do
584+ readRef inputRef `shouldBeWithRetryM` ["pbabc"]
585+ readRef valRef `shouldBeWithRetryM` ["pbabc", "pb"]
586+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
587+ shouldContainText "pbabc" p
588+ pure ()
589+ testWidget' checkStatic checkHydrated $ do
590+ liftIO $ writeRef valRef []
591+ pb <- getPostBuild
592+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
593+ el "p" $ dynText $ _inputElement_value e
594+ performEvent_ $ consRef valRef <$> updated (_inputElement_value e)
595+ performEvent_ $ consRef inputRef <$> _inputElement_input e
596+ describe "hydration/immediate" $ do
393597 it "captures user input after switchover" $ runWD $ do
394598 inputRef :: IORef Text <- newRef ""
395599 let checkValue = do
396− WD.sendKeys "hello world" =<< (findElemWithRetry $ WD.ByTag "input")
397− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
600+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
601+ WD.click =<< findElemWithRetry (WD.ByTag "button")
398602 readRef inputRef `shouldBeWithRetryM` "hello world"
399603 testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
400604 e <- inputElement def
@@ -411,7 +615,6 @@ tests withDebugging wdConfig caps _selenium = do
411615 e <- inputElement def
412616 performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
413617 it "sets value appropriately" $ runWD $ do
414− putStrLnDebug "sets value appropriately"
415618 valueByUIRef :: IORef Text <- newRef ""
416619 valueRef :: IORef Text <- newRef ""
417620 setValueChan :: Chan Text <- liftIO newChan
@@ -432,77 +635,69 @@ tests withDebugging wdConfig caps _selenium = do
432635 performEvent_ $ liftIO . writeRef valueByUIRef <$> _inputElement_input e
433636 performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
434637 it "sets checked appropriately" $ runWD $ do
435− putStrLnDebug "sets checked appropriately"
436638 checkedByUIRef <- newRef False
437639 checkedRef <- newRef False
438640 setCheckedChan <- liftIO newChan
439641 let checkValue = do
440− putStrLnDebug "1"
441642 readRef checkedByUIRef `shouldBeWithRetryM` False
442− putStrLnDebug "2"
443643 readRef checkedRef `shouldBeWithRetryM` False
444− putStrLnDebug "3"
445644 e <- findElemWithRetry $ WD.ByTag "input"
446− putStrLnDebug "4"
447645 WD.moveToCenter e
448− putStrLnDebug "5"
449646 WD.click e
450− putStrLnDebug "6"
451647 readRef checkedByUIRef `shouldBeWithRetryM` True
452− putStrLnDebug "7"
453648 readRef checkedRef `shouldBeWithRetryM` True
454− putStrLnDebug "8"
455649 liftIO $ writeChan setCheckedChan False
456− putStrLnDebug "9"
457650 readRef checkedByUIRef `shouldBeWithRetryM` True
458− putStrLnDebug "10"
459651 readRef checkedRef `shouldBeWithRetryM` False
460− putStrLnDebug "11"
461652 testWidget (pure ()) checkValue $ do
462− putStrLnDebug "12"
463653 setChecked <- triggerEventWithChan setCheckedChan
464− putStrLnDebug "13"
465654 prerender_ (pure ()) $ do
466− putStrLnDebug "14"
467655 e <- inputElement $ def
468656 & initialAttributes .~ "type" =: "checkbox"
469657 & inputElementConfig_setChecked .~ setChecked
470− putStrLnDebug "15"
471658 performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
472− putStrLnDebug "16"
473659 performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
474− putStrLnDebug "17"
475660 it "captures file uploads" $ runWD $ do
476661 filesRef :: IORef [Text] <- newRef []
477662 let uploadFile = do
478− putStrLnDebug "1"
479663 e <- findElemWithRetry $ WD.ByTag "input"
480− putStrLnDebug "2"
481664 path <- liftIO $ writeSystemTempFile "testFile" "file contents"
482− putStrLnDebug "3"
483665 WD.sendKeys (T.pack path) e
484− putStrLnDebug "4"
485− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
486− putStrLnDebug "5"
666+ WD.click =<< findElemWithRetry (WD.ByTag "button")
487667 liftIO $ removeFile path
488− putStrLnDebug "6"
489668 readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
490− putStrLnDebug "7"
491669 testWidget (pure ()) uploadFile $ prerender_ (pure ()) $ do
492− putStrLnDebug "8"
493670 e <- inputElement $ def & initialAttributes .~ "type" =: "file"
494− putStrLnDebug "9"
495671 click <- button "save"
496− putStrLnDebug "10"
497672 performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
498− putStrLnDebug "11"
499673 names <- liftJSM $ traverse File.getName fs
500− putStrLnDebug "12"
501674 liftIO $ writeRef filesRef names
502− putStrLnDebug "13"
503675
504− describe "textAreaElement" $ do
505− describe "hydration" $ session' $ do
676+ session' "textAreaElement" $ do
677+ describe "static renderer" $ do
678+ it "sets value attribute" $ runWD $ do
679+ let checkStatic = do
680+ e <- findElemWithRetry $ WD.ByTag "textarea"
681+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
682+ pure e
683+ checkHydrated e = do
684+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
685+ testWidget' checkStatic checkHydrated $ void $ textAreaElement $ def
686+ & textAreaElementConfig_initialValue .~ "test"
687+ it "updates value attribute at postBuild" $ runWD $ do
688+ let checkStatic = do
689+ e <- findElemWithRetry $ WD.ByTag "textarea"
690+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
691+ pure e
692+ checkHydrated e = do
693+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
694+ testWidget' checkStatic checkHydrated $ do
695+ pb <- getPostBuild
696+ _ <- textAreaElement $ def
697+ & textAreaElementConfig_initialValue .~ "test"
698+ & textAreaElementConfig_setValue .~ ("test-updated" <$ pb)
699+ pure ()
700+ describe "hydration" $ do
506701 it "doesn't wipe user input when switching over" $ runWD $ do
507702 inputRef <- newRef ("" :: Text)
508703 testWidget'
@@ -521,8 +716,8 @@ tests withDebugging wdConfig caps _selenium = do
521716 it "captures user input after switchover" $ runWD $ do
522717 inputRef <- newRef ("" :: Text)
523718 let checkValue = do
524− WD.sendKeys "hello world" =<< (findElemWithRetry $ WD.ByTag "textarea")
525− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
719+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "textarea")
720+ WD.click =<< findElemWithRetry (WD.ByTag "button")
526721 readRef inputRef `shouldBeWithRetryM` "hello world"
527722 testWidget (pure ()) checkValue $ do
528723 e <- textAreaElement def
@@ -568,8 +763,90 @@ tests withDebugging wdConfig caps _selenium = do
568763 e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
569764 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
570765 performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
766+ it "fires _input event if the user altered the value before hydration" $ runWD $ do
767+ textarea <- newRef ("" :: Text)
768+ update <- newRef ("" :: Text)
769+ let checkStatic = do
770+ e <- findElemWithRetry $ WD.ByTag "textarea"
771+ WD.attr e "value" `shouldBeWithRetryM` Just ""
772+ WD.sendKeys "test" e
773+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
774+ pure e
775+ checkHydrated e = do
776+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
777+ readRef textarea `shouldBeWithRetryM` "test"
778+ readRef update `shouldBeWithRetryM` "test"
779+ testWidget' checkStatic checkHydrated $ do
780+ e <- textAreaElement def
781+ performEvent_ $ liftIO . writeRef textarea <$> _textAreaElement_input e
782+ performEvent_ $ liftIO . writeRef update <$> updated (_textAreaElement_value e)
783+ it "does not fire _input event when the value is updated at postBuild" $ runWD $ do
784+ textarea <- newRef (Nothing :: Maybe Text)
785+ let checkStatic = do
786+ e <- findElemWithRetry $ WD.ByTag "textarea"
787+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
788+ pure e
789+ checkHydrated e = do
790+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
791+ readRef textarea `shouldBeWithRetryM` Nothing
792+ testWidget' checkStatic checkHydrated $ do
793+ pb <- getPostBuild
794+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
795+ performEvent_ $ liftIO . writeRef textarea . Just <$> _textAreaElement_input e
796+ it "SSR produces correct DOM based on textAreaElement values when setValue happens at postBuild" $ runWD $ do
797+ let checkBoth = do
798+ textarea <- findElemWithRetry $ WD.ByTag "textarea"
799+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pb"
800+ p <- findElemWithRetry (WD.ByTag "p")
801+ shouldContainText "pb" p
802+ testWidget checkBoth checkBoth $ do
803+ pb <- getPostBuild
804+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
805+ el "p" $ dynText $ _textAreaElement_value e
806+ it "does not fail when both setValue AND user updated value happen before switchover" $ runWD $ do
807+ let checkStatic = do
808+ textarea <- findElemWithRetry $ WD.ByTag "textarea"
809+ h2_value <- findElemWithRetry (WD.ByTag "h2")
810+ h3_input <- findElemWithRetry (WD.ByTag "h3")
811+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pb"
812+ shouldContainText "pb" h2_value
813+ shouldContainText "" h3_input
814+ WD.sendKeys "abc" textarea
815+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
816+ shouldContainText "pb" h2_value
817+ shouldContainText "" h3_input
818+ pure (textarea, h2_value, h3_input)
819+ checkHydrated (textarea, h2_value, h3_input) = do
820+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
821+ shouldContainText "pbabc" h3_input
822+ shouldContainText "pbabc pb" h2_value
823+ pure ()
824+ testWidget' checkStatic checkHydrated $ do
825+ pb <- getPostBuild
826+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
827+ el "h1" $ dynText $ _textAreaElement_value e
828+ el "h2" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ updated $ _textAreaElement_value e
829+ el "h3" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ _textAreaElement_input e
830+ it "value is correct when both setValue AND user updated value happen before switchover" $ runWD $ do
831+ let checkStatic = do
832+ textarea <- findElemWithRetry $ WD.ByTag "textarea"
833+ p <- findElemWithRetry (WD.ByTag "p")
834+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pb"
835+ shouldContainText "pb" p
836+ WD.sendKeys "abc" textarea
837+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
838+ shouldContainText "pb" p -- It won't be updated yet
839+ pure (textarea, p)
840+ checkHydrated (textarea, p) = do
841+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
842+ shouldContainText "pbabc" p
843+ pure ()
844+ testWidget' checkStatic checkHydrated $ do
845+ pb <- getPostBuild
846+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
847+ el "p" $ dynText $ _textAreaElement_value e
571848
572− describe "hydration/immediate" $ session' $ do
849+ describe "hydration/immediate" $ do
573850 it "captures user input after switchover" $ runWD $ do
574851 inputRef :: IORef Text <- newRef ""
575852 let checkValue = do
@@ -611,24 +888,24 @@ tests withDebugging wdConfig caps _selenium = do
611888 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
612889 performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
613890
614− describe "selectElement" $ do
891+ session' "selectElement" $ do
615892 let options :: DomBuilder t m => m ()
616893 options = do
617894 elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
618895 elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
619896 elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
620− describe "hydration" $ session' $ do
897+ describe "hydration" $ do
621898 it "sets initial value correctly" $ runWD $ do
622899 inputRef <- newRef ("" :: Text)
623900 let setup = do
624901 e <- findElemWithRetry $ WD.ByTag "select"
625902 assertAttr e "value" (Just "three")
626− WD.click =<< (findElemWithRetry $ WD.ById "two")
903+ WD.click =<< findElemWithRetry (WD.ById "two")
627904 pure e
628905 check e = do
629906 assertAttr e "value" (Just "two")
630907 readRef inputRef `shouldBeWithRetryM` "three"
631− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
908+ WD.click =<< findElemWithRetry (WD.ByTag "button")
632909 assertAttr e "value" (Just "two")
633910 readRef inputRef `shouldBeWithRetryM` "two"
634911 testWidget' setup check $ do
@@ -641,9 +918,9 @@ tests withDebugging wdConfig caps _selenium = do
641918 let checkValue = do
642919 e <- findElemWithRetry $ WD.ByTag "select"
643920 assertAttr e "value" (Just "one")
644− WD.click =<< (findElemWithRetry $ WD.ById "two")
921+ WD.click =<< findElemWithRetry (WD.ById "two")
645922 assertAttr e "value" (Just "two")
646− WD.click =<< (findElemWithRetry $ WD.ByTag "button")
923+ WD.click =<< findElemWithRetry (WD.ByTag "button")
647924 readRef inputRef `shouldBeWithRetryM` "two"
648925 testWidget (pure ()) checkValue $ do
649926 (e, ()) <- selectElement def options
@@ -691,7 +968,7 @@ tests withDebugging wdConfig caps _selenium = do
691968 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
692969 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
693970
694− describe "hydration/immediate" $ session' $ do
971+ describe "hydration/immediate" $ do
695972 it "captures user input after switchover" $ runWD $ do
696973 inputRef :: IORef Text <- newRef ""
697974 let checkValue = do
@@ -737,7 +1014,7 @@ tests withDebugging wdConfig caps _selenium = do
7371014 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
7381015 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
7391016
740− describe "prerender" $ session' $ do
1017+ session' "prerender" $ do
7411018 it "works in simple case" $ runWD $ do
7421019 testWidget (checkBodyText "One") (checkBodyText "Two") $ do
7431020 prerender_ (text "One") (text "Two")
@@ -782,9 +1059,9 @@ tests withDebugging wdConfig caps _selenium = do
7821059 pb <- getPostBuild
7831060 performEvent_ $ liftIO (putMVar lock ()) <$ pb
7841061 it "result Dynamic is updated *after* switchover" $ runWD $ do
785− let static = checkBodyText "PostBuild"
1062+ let preSwitchover = checkBodyText "PostBuild"
7861063 check = checkBodyText "Client"
787− testWidget static check $ void $ do
1064+ testWidget preSwitchover check $ void $ do
7881065 d <- prerender (pure "Initial") (pure "Client")
7891066 pb <- getPostBuild
7901067 initial <- sample $ current d
@@ -792,21 +1069,30 @@ tests withDebugging wdConfig caps _selenium = do
7921069 -- This essentially checks that the client IO runs *after* switchover/postBuild,
7931070 -- thus can't create conflicting DOM
7941071 it "can't exploit IO to break hydration" $ runWD $ do
795− let static = checkBodyText "Initial"
796− testWidgetStatic static $ void $ do
1072+ let preSwitchover = checkBodyText "Initial"
1073+ testWidgetStatic preSwitchover $ void $ do
7971074 ref <- liftIO $ newRef "Initial"
7981075 prerender_ (pure ()) (liftIO $ writeRef ref "Client")
7991076 text <=< liftIO $ readRef ref
8001077 -- As above, so below
8011078 it "can't exploit triggerEvent to break hydration" $ runWD $ do
802− let static = checkBodyText "Initial"
1079+ let preSwitchover = checkBodyText "Initial"
8031080 check = checkBodyText "Client"
804− testWidget static check $ void $ do
1081+ testWidget preSwitchover check $ void $ do
8051082 (e, trigger) <- newTriggerEvent
8061083 prerender_ (pure ()) (liftIO $ trigger "Client")
8071084 textNode $ TextNodeConfig "Initial" $ Just e
8081085
809− describe "runWithReplace" $ session' $ do
1086+ session' "namespaces" $ do
1087+ it "dyn can be nested in namespaced widget" $ runWD $ do
1088+ testWidget (pure ()) (checkTextInTag "svg" "one") $ do
1089+ let svgRootCfg = def
1090+ & (elementConfig_namespace ?~ "http://www.w3.org/2000/svg")
1091+ & (elementConfig_initialAttributes .~ ("width" =: "100%" <> "height" =: "100%" <> "viewBox" =: "0 0 1536 2048"))
1092+ void $ element "svg" svgRootCfg $ do
1093+ dyn_ $ text "one" <$ pure ()
1094+
1095+ session' "runWithReplace" $ do
8101096 it "works" $ runWD $ do
8111097 replaceChan :: Chan Text <- liftIO newChan
8121098 let setup = findElemWithRetry $ WD.ByTag "div"
@@ -840,7 +1126,7 @@ tests withDebugging wdConfig caps _selenium = do
8401126 , el "span" . text <$> replace
8411127 ]
8421128 it "can be nested in postBuild widget" $ runWD $ do
843− replaceChan <- liftIO newChan
1129+ replaceChan :: Chan Text <- liftIO newChan
8441130 let setup = findElemWithRetry $ WD.ByTag "div"
8451131 check ssr = do
8461132 -- Check that the original element still exists and has the correct text
@@ -873,7 +1159,7 @@ tests withDebugging wdConfig caps _selenium = do
8731159 replaceChan2 :: Chan Text <- liftIO newChan
8741160 lock :: MVar () <- liftIO newEmptyMVar
8751161 let check = do
876− shouldContainText "" =<< (findElemWithRetry (WD.ByTag "body"))
1162+ shouldContainText "" =<< findElemWithRetry (WD.ByTag "body")
8771163 liftIO $ do
8781164 writeChan replaceChan1 "one"
8791165 takeMVar lock
@@ -950,7 +1236,61 @@ tests withDebugging wdConfig caps _selenium = do
9501236 , el "span" . text <$> replace
9511237 ]
9521238
953− describe "traverseDMapWithKeyWithAdjust" $ session' $ do
1239+ let checkInnerHtml t x = findElemWithRetry (WD.ByTag t) >>= (`attr` "innerHTML") >>= (`shouldBe` Just x)
1240+ it "removes bracketing comments" $ runWD $ do
1241+ replaceChan :: Chan () <- liftIO newChan
1242+ let
1243+ preSwitchover = checkInnerHtml "div" "before|<!--replace-start-0-->inner1<!--replace-end-0-->|after"
1244+ check () = do
1245+ liftIO $ writeChan replaceChan () -- trigger creation of p tag
1246+ _ <- findElemWithRetry $ WD.ByTag "p" -- wait till p tag is created
1247+ checkInnerHtml "div" "before|<p>inner2</p>|after"
1248+ testWidget' preSwitchover check $ do
1249+ replace <- triggerEventWithChan replaceChan
1250+ el "div" $ do
1251+ text "before|"
1252+ _ <- runWithReplace (text "inner1") $ el "p" (text "inner2") <$ replace
1253+ text "|after"
1254+ it "ignores extra ending bracketing comment" $ runWD $ do
1255+ replaceChan :: Chan () <- liftIO newChan
1256+ let
1257+ preSwitchover = checkInnerHtml "div" "before|<!--replace-start-0-->inner1<!--replace-end-0--><!--replace-end-0-->|after"
1258+ check () = do
1259+ liftIO $ writeChan replaceChan () -- trigger creation of p tag
1260+ _ <- findElemWithRetry $ WD.ByTag "p" -- wait till p tag is created
1261+ checkInnerHtml "div" "before|inner2|after"
1262+ testWidget' preSwitchover check $ do
1263+ replace <- triggerEventWithChan replaceChan
1264+ el "div" $ do
1265+ text "before|"
1266+ _ <- runWithReplace (text "inner1" *> comment "replace-end-0") $ text "inner2" <$ replace
1267+ text "|after"
1268+ void $ runWithReplace blank $ el "p" blank <$ replace -- Signal tag for end of test
1269+ -- TODO This test actually causes a hydration failure, but it wasn't
1270+ -- previously detected, so I've marked it pending
1271+ xit "ignores missing ending bracketing comments" $ runWD $ do
1272+ replaceChan :: Chan () <- liftIO newChan
1273+ let
1274+ preSwitchover = do
1275+ checkInnerHtml "div" "before|<!--replace-start-0-->inner1<!--replace-end-0-->|after"
1276+ divEl <- findElemWithRetry (WD.ByTag "div")
1277+ let wrongHtml = "<!--replace-start-0-->inner1"
1278+ actualHtml :: String <- WD.executeJS
1279+ [WD.JSArg divEl, WD.JSArg wrongHtml]
1280+ "arguments[0].innerHTML = arguments[1]; return arguments[0].innerHTML"
1281+ actualHtml `shouldBe` wrongHtml
1282+ check () = do
1283+ liftIO $ writeChan replaceChan () -- trigger creation of p tag
1284+ _ <- findElemWithRetry $ WD.ByTag "p" -- wait till p tag is created
1285+ checkInnerHtml "div" "before|<p>inner2</p>|after"
1286+ testWidget' preSwitchover check $ do
1287+ replace <- triggerEventWithChan replaceChan
1288+ el "div" $ do
1289+ text "before|"
1290+ _ <- runWithReplace (text "inner1") $ el "p" (text "inner2") <$ replace
1291+ text "|after"
1292+
1293+ session' "traverseDMapWithKeyWithAdjust" $ do
9541294 let widget :: DomBuilder t m => DKey a -> Identity a -> m (Identity a)
9551295 widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
9561296 elClass "span" "key" $ text $ textKey k
@@ -959,8 +1299,8 @@ tests withDebugging wdConfig caps _selenium = do
9591299 checkItem :: WD.Element -> Text -> Text -> WD ()
9601300 checkItem li k v = do
9611301 putStrLnDebug "checkItem"
962− shouldContainTextNoRetry k =<< (WD.findElemFrom li (WD.ByClass "key"))
963− shouldContainTextNoRetry v =<< (WD.findElemFrom li (WD.ByClass "value"))
1302+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1303+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
9641304 checkInitialItems dm xs = do
9651305 putStrLnDebug "checkInitialItems"
9661306 liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
@@ -990,26 +1330,26 @@ tests withDebugging wdConfig caps _selenium = do
9901330 postBuildPatch = PatchDMap $ DMap.fromList [Key_Char :=> ComposeMaybe Nothing, Key_Bool :=> ComposeMaybe (Just $ Identity True)]
9911331 it "doesn't replace elements at switchover, can delete/update/insert" $ runWD $ do
9921332 chan <- liftIO newChan
993− let static :: WD [WD.Element]
994− static = getAndCheckInitialItems keyMap
1333+ let preSwitchover :: WD [WD.Element]
1334+ preSwitchover = getAndCheckInitialItems keyMap
9951335 check :: [WD.Element] -> WD ()
9961336 check xs = do
9971337 checkInitialItems keyMap xs
9981338 checkRemoval chan Key_Int
9991339 checkReplace chan Key_Char 'B'
10001340 checkInsert chan Key_Bool True
1001− testWidget' static check $ do
1341+ testWidget' preSwitchover check $ do
10021342 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
10031343 liftIO $ dmap `H.shouldBe` keyMap
10041344 it "handles postBuild correctly" $ runWD $ do
10051345 chan <- liftIO newChan
1006− let static = getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
1346+ let preSwitchover = getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
10071347 check xs = do
10081348 withRetry $ checkInitialItems (applyAlways postBuildPatch keyMap) xs
10091349 checkRemoval chan Key_Int
10101350 checkInsert chan Key_Char 'B'
10111351 checkReplace chan Key_Bool True
1012− testWidget' static check $ void $ do
1352+ testWidget' preSwitchover check $ void $ do
10131353 pb <- getPostBuild
10141354 replace <- triggerEventWithChan chan
10151355 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
@@ -1053,7 +1393,7 @@ tests withDebugging wdConfig caps _selenium = do
10531393 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
10541394 liftIO $ dmap `H.shouldBe` keyMap
10551395
1056− describe "traverseIntMapWithKeyWithAdjust" $ session' $ do
1396+ session' "traverseIntMapWithKeyWithAdjust" $ do
10571397 let textKeyInt k = "key" <> T.pack (show k)
10581398 intMap = IntMap.fromList
10591399 [ (1, "one")
@@ -1099,24 +1439,24 @@ tests withDebugging wdConfig caps _selenium = do
10991439 postBuildPatch = PatchIntMap $ IntMap.fromList [(2, Nothing), (3, Just "trois"), (4, Just "four")]
11001440 xit "doesn't replace elements at switchover, can delete/update/insert" $ runWD $ do
11011441 chan <- liftIO newChan
1102− let static = getAndCheckInitialItems intMap
1442+ let preSwitchover = getAndCheckInitialItems intMap
11031443 check xs = do
11041444 checkInitialItems intMap xs
11051445 checkRemoval chan 1
11061446 checkReplace chan 2 "deux"
11071447 checkInsert chan 4 "four"
1108− testWidget' static check $ void $ do
1448+ testWidget' preSwitchover check $ void $ do
11091449 (im, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap =<< triggerEventWithChan chan
11101450 liftIO $ im `H.shouldBe` intMap
11111451 xit "handles postBuild correctly" $ runWD $ do
11121452 chan <- liftIO newChan
1113− let static = getAndCheckInitialItems $ applyAlways postBuildPatch intMap
1453+ let preSwitchover = getAndCheckInitialItems $ applyAlways postBuildPatch intMap
11141454 check xs = do
11151455 withRetry $ checkInitialItems (applyAlways postBuildPatch intMap) xs
11161456 checkRemoval chan 1
11171457 checkInsert chan 2 "deux"
11181458 checkReplace chan 3 "trois"
1119− testWidget' static check $ void $ do
1459+ testWidget' preSwitchover check $ void $ do
11201460 pb <- getPostBuild
11211461 replace <- triggerEventWithChan chan
11221462 (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
@@ -1160,7 +1500,7 @@ tests withDebugging wdConfig caps _selenium = do
11601500 (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
11611501 liftIO $ dmap `H.shouldBe` intMap
11621502
1163− describe "traverseDMapWithKeyWithAdjustWithMove" $ session' $ do
1503+ session' "traverseDMapWithKeyWithAdjustWithMove" $ do
11641504 let widget :: DomBuilder t m => Key2 a -> Identity a -> m (Identity a)
11651505 widget k (Identity v) = elAttr "li" ("id" =: textKey2 k) $ do
11661506 elClass "span" "key" $ text $ textKey2 k
@@ -1172,8 +1512,8 @@ tests withDebugging wdConfig caps _selenium = do
11721512 Key2_Char c -> "c" <> T.pack [c]
11731513 checkItem :: WD.Element -> Text -> Text -> WD ()
11741514 checkItem li k v = do
1175− shouldContainTextNoRetry k =<< (WD.findElemFrom li (WD.ByClass "key"))
1176− shouldContainTextNoRetry v =<< (WD.findElemFrom li (WD.ByClass "value"))
1515+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1516+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
11771517 checkInitialItems dm xs = do
11781518 liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
11791519 forM_ (zip xs (DMap.toList dm)) $ \(e, k :=> Identity v) -> checkItem e (textKey2 k) (T.pack $ has @Show k $ show v)
@@ -1181,6 +1521,9 @@ tests withDebugging wdConfig caps _selenium = do
11811521 xs <- WD.findElems (WD.ByTag "li")
11821522 checkInitialItems dm xs
11831523 pure xs
1524+ moveSpec
1525+ :: (DMap Key2 Identity -> (WD.Element -> Chan (PatchDMapWithMove Key2 Identity) -> WD ()) -> WD ())
1526+ -> H.SpecM (WdTestSession ()) ()
11841527 moveSpec testMove = do
11851528 it "can insert an item" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 3 ==> 3]) $ \body chan -> do
11861529 shouldContainText (T.strip $ T.unlines ["i11","i33"]) body
@@ -1208,19 +1551,19 @@ tests withDebugging wdConfig caps _selenium = do
12081551
12091552 describe "hydration" $ moveSpec $ \initMap test -> do
12101553 chan <- liftIO newChan
1211− let static = getAndCheckInitialItems initMap
1554+ let preSwitchover = getAndCheckInitialItems initMap
12121555 check xs = do
12131556 checkInitialItems initMap xs
12141557 body <- getBody
12151558 test body chan
1216− testWidget' static check $ void $ do
1559+ testWidget' preSwitchover check $ void $ do
12171560 (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
12181561 liftIO $ assertEqual "DMap" initMap dmap
12191562
12201563 describe "hydration/immediate" $ moveSpec $ \initMap test -> do
12211564 chan <- liftIO newChan
12221565 replace <- liftIO newChan
1223− lock <- liftIO newEmptyMVar
1566+ lock :: MVar () <- liftIO newEmptyMVar
12241567 let check = do
12251568 liftIO $ do
12261569 writeChan replace ()
@@ -1237,12 +1580,14 @@ tests withDebugging wdConfig caps _selenium = do
12371580 (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
12381581 liftIO $ assertEqual "DMap" initMap dmap
12391582
1240− describe "hydrating invalid HTML" $ session' $ do
1241− it "can hydrate list in paragraph" $ runWD $ do
1242− let static = do
1583+ session' "hydrating invalid HTML" $ do
1584+ xit "can hydrate list in paragraph" $ runWD $ do
1585+ let preSwitchover = do
12431586 checkBodyText "before\ninner\nafter"
12441587 -- Two <p> tags should be present
1245− [p1, p2] <- WD.findElems (WD.ByTag "p")
1588+ (p1, p2) <- WD.findElems (WD.ByTag "p") >>= \case
1589+ [p1, p2] -> pure (p1, p2)
1590+ _ -> error "Unexpected number of `p` tags (expected 2)"
12461591 ol <- findElemWithRetry (WD.ByTag "ol")
12471592 shouldContainText "before" p1
12481593 shouldContainText "inner" ol
@@ -1253,7 +1598,8 @@ tests withDebugging wdConfig caps _selenium = do
12531598 shouldContainText "before\ninner\nafter" p1
12541599 elementShouldBeRemoved ol
12551600 elementShouldBeRemoved p2
1256− testWidget' static check $ do
1601+ -- Don't fail fatally when hydration encounters the invalid DOM
1602+ testWidgetDebug' False withDebugging preSwitchover check $ do
12571603 -- This is deliberately invalid HTML, the browser will interpret it as
12581604 -- <p>before</p><ol>inner</ol>after<p></p>
12591605 el "p" $ do
@@ -1261,6 +1607,29 @@ tests withDebugging wdConfig caps _selenium = do
12611607 el "ol" $ text "inner"
12621608 text "after"
12631609
1610+ -- TODO: This test presupposes the exact set of labels that "dropdown" places in the "value" fields to distinguish options.
1611+ -- This dependence on internal implementation details is undesirable in a test case, but seems fairly tricky to avoid.
1612+ -- It seems expedient for the time being to expect this test case to be updated, should those implementation details ever change.
1613+ session' "dropdown" $ do
1614+ let doTest expectedOpts (initialValue :: Text) = do
1615+ let doCheck = do
1616+ es <- findElemsWithRetry $ WD.ByTag "option"
1617+ opts <- mapM fetchElement es
1618+ assertEqual "missing/extra/incorrect option element(s)" expectedOpts (sort opts)
1619+ testWidget doCheck doCheck $ do
1620+ void $ dropdown initialValue (constDyn (("aa" :: Text) =: "aaa" <> "bb" =: "bbb")) def
1621+ fetchElement e = do
1622+ val <- WD.attr e "value"
1623+ sel <- WD.attr e "selected"
1624+ return (fromMaybe "" val, isJust sel)
1625+ -- The "aa" test case is important, but a good test implementation probably needs to avoid selenium, because HTML parsers will insert a "selected" attribute on the first "option" tag if no selected attributes are present; thus as written, this erroneously succeeds on the old implementation (but properly implemented, should fail)
1626+ -- Thus, it would appear that we do actually need a HTML5 or maybe XML parser for this test suite.
1627+ xit "statically renders initial values (on aa)" $ runWD $ do
1628+ doTest [("0",True),("1",False)] "aa"
1629+ -- These tests are currently marked "pending" (by using "xit" instead of "it") because this test has a high chance of non-deterministically failing, which is a problem elsewhere in this test suite as well
1630+ xit "statically renders initial values (on bb)" $ runWD $ do
1631+ doTest [("0",False),("1",True)] "bb"
1632+
12641633data Selenium = Selenium
12651634 { _selenium_portNumber :: PortNumber
12661635 , _selenium_stopServer :: IO ()
@@ -1328,6 +1697,9 @@ checkTextInId i expected = do
13281697findElemWithRetry :: Selector -> WD WD.Element
13291698findElemWithRetry = withRetry . WD.findElem
13301699
1700+findElemsWithRetry :: Selector -> WD [WD.Element]
1701+findElemsWithRetry = withRetry . WD.findElems
1702+
13311703getBody :: WD WD.Element
13321704getBody = WD.findElem $ WD.ByTag "body"
13331705
@@ -1336,8 +1708,8 @@ withRetry a = wait 300
13361708 where wait :: Int -> WD a
13371709 wait 0 = a
13381710 wait n = try a >>= \case
1339− Left (_ :: SomeException) -> do
1340− liftIO $ threadDelay 100000
1711+ Left (e :: SomeException) -> do
1712+ liftIO $ putStrLn ("(retrying due to " <> show e <> ")") *> threadDelay 100000
13411713 wait $ n - 1
13421714 Right v -> return v
13431715
@@ -1353,11 +1725,12 @@ testWidgetStaticDebug
13531725 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
13541726 -- ^ Widget we are testing
13551727 -> WD b
1356−testWidgetStaticDebug withDebugging w = testWidgetDebug withDebugging (void w) w
1728+testWidgetStaticDebug withDebugging w = testWidgetDebug True withDebugging (void w) w
13571729
13581730-- | TODO: do something about JSExceptions not causing tests to fail
13591731testWidgetDebug
13601732 :: Bool
1733+ -> Bool
13611734 -> WD ()
13621735 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
13631736 -> WD b
@@ -1365,12 +1738,16 @@ testWidgetDebug
13651738 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
13661739 -- ^ Widget we are testing
13671740 -> WD b
1368−testWidgetDebug withDebugging beforeJS afterSwitchover =
1369− testWidgetDebug' withDebugging beforeJS (const afterSwitchover)
1741+testWidgetDebug hardFailure withDebugging beforeJS afterSwitchover =
1742+ testWidgetDebug' hardFailure withDebugging beforeJS (const afterSwitchover)
1743+
1744+data HydrationFailedException = HydrationFailedException deriving Show
1745+instance Exception HydrationFailedException
13701746
13711747-- | TODO: do something about JSExceptions not causing tests to fail
13721748testWidgetDebug'
13731749 :: Bool
1750+ -> Bool
13741751 -> WD a
13751752 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
13761753 -> (a -> WD b)
@@ -1378,7 +1755,7 @@ testWidgetDebug'
13781755 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
13791756 -- ^ Widget we are testing (contents of body)
13801757 -> WD b
1381−testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
1758+testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget = do
13821759 let putStrLnDebug :: MonadIO m => Text -> m ()
13831760 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
13841761 staticApp = do
@@ -1387,9 +1764,10 @@ testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
13871764 bodyWidget
13881765 el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
13891766 putStrLnDebug "rendering static"
1390− ((), html) <- liftIO $ renderStatic staticApp
1767+ ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
13911768 putStrLnDebug "rendered static"
13921769 waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
1770+ onFailure <- if hardFailure then (`throwTo` HydrationFailedException) <$> liftIO myThreadId else pure $ pure ()
13931771 waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
13941772 let entryPoint = do
13951773 putStrLnDebug "taking waitBeforeJS"
@@ -1401,7 +1779,7 @@ testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
14011779 liftIO $ putMVar waitUntilSwitchover ()
14021780 putStrLnDebug "put waitUntilSwitchover"
14031781 putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
1404− mainHydrationWidgetWithSwitchoverAction switchOverAction blank bodyWidget
1782+ mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchOverAction blank bodyWidget
14051783 putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
14061784 syncPoint
14071785 application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
@@ -1419,23 +1797,26 @@ testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
14191797 ]
14201798 -- hSilence to get rid of ConnectionClosed logs
14211799 silenceIfDebug = if withDebugging then id else hSilence [stderr]
1422− jsaddleWarp = forkIO $ silenceIfDebug $ Warp.runSettings settings application
1423− jsaddleTid <- liftIO jsaddleWarp
1424− putStrLnDebug "taking waitJSaddle"
1425− liftIO $ takeMVar waitJSaddle
1426− putStrLnDebug "opening page"
1427− WD.openPage $ "http://localhost:" <> show jsaddlePort
1428− putStrLnDebug "running beforeJS"
1429− a <- beforeJS
1430− putStrLnDebug "putting waitBeforeJS"
1431− liftIO $ putMVar waitBeforeJS ()
1432− putStrLnDebug "taking waitUntilSwitchover"
1433− liftIO $ takeMVar waitUntilSwitchover
1434− putStrLnDebug "running afterSwitchover"
1435− b <- afterSwitchover a
1436− putStrLnDebug "killing jsaddle thread"
1437− liftIO $ killThread jsaddleTid
1438− return b
1800+ jsaddleWarp = silenceIfDebug $ Warp.runSettings settings application
1801+ withAsync' jsaddleWarp $ do
1802+ putStrLnDebug "taking waitJSaddle"
1803+ liftIO $ takeMVar waitJSaddle
1804+ putStrLnDebug "opening page"
1805+ WD.openPage $ "http://localhost:" <> show jsaddlePort
1806+ putStrLnDebug "running beforeJS"
1807+ a <- beforeJS
1808+ putStrLnDebug "putting waitBeforeJS"
1809+ liftIO $ putMVar waitBeforeJS ()
1810+ putStrLnDebug "taking waitUntilSwitchover"
1811+ liftIO $ takeMVar waitUntilSwitchover
1812+ putStrLnDebug "running afterSwitchover"
1813+ afterSwitchover a
1814+
1815+withAsync' :: (MonadIO m, MonadMask m) => IO a -> m b -> m b
1816+withAsync' f g = bracket
1817+ (liftIO $ Async.async f)
1818+ (liftIO . Async.uninterruptibleCancel)
1819+ (const g)
14391820
14401821data Key2 a where
14411822 Key2_Int :: Int -> Key2 Int
@@ -1445,12 +1826,3 @@ deriveGEq ''Key2
14451826deriveGCompare ''Key2
14461827deriveGShow ''Key2
14471828deriveArgDict ''Key2
1448−
1449−instance ShowTag Key2 Identity where
1450− showTaggedPrec = \case
1451− Key2_Int _ -> showsPrec
1452− Key2_Char _ -> showsPrec
1453−
1454−instance EqTag Key2 Identity where
1455− eqTagged (Key2_Int _) (Key2_Int _) = (==)
1456− eqTagged (Key2_Char _) (Key2_Char _) = (==)