@@ -1,13 +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 #-}
94{-# LANGUAGE FlexibleInstances #-}
105{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
117{-# LANGUAGE LambdaCase #-}
128{-# LANGUAGE MultiParamTypeClasses #-}
139{-# LANGUAGE OverloadedStrings #-}
@@ -15,13 +11,27 @@
1511{-# LANGUAGE RankNTypes #-}
1612{-# LANGUAGE RecursiveDo #-}
1713{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
1815{-# LANGUAGE TemplateHaskell #-}
1916{-# LANGUAGE TupleSections #-}
2017{-# LANGUAGE TypeApplications #-}
2118{-# LANGUAGE TypeFamilies #-}
19+{-# LANGUAGE UndecidableInstances #-}
20+
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.
2230
2331import Prelude hiding (fail)
2432import Control.Concurrent
33+import qualified Control.Concurrent.Async as Async
34+import Control.Lens.Operators
2535import Control.Monad hiding (fail)
2636import Control.Monad.Catch
2737import Control.Monad.Fail
@@ -31,12 +41,13 @@ import Control.Monad.Ref
3141import Data.Constraint.Extras
3242import Data.Constraint.Extras.TH
3343import Data.Dependent.Map (DMap)
34−import Data.Dependent.Sum (DSum(..), (==>), EqTag(..), ShowTag(..))
44+import Data.Dependent.Sum (DSum(..), (==>))
3545import Data.Functor.Identity
3646import Data.Functor.Misc
3747import Data.GADT.Compare.TH
3848import Data.GADT.Show.TH
3949import Data.IORef (IORef)
50+import Data.List (sort)
4051import Data.Maybe
4152import Data.Proxy
4253import Data.Text (Text)
@@ -47,6 +58,7 @@ import Network.Socket
4758import Network.Wai
4859import Network.WebSockets
4960import Reflex.Dom.Core
61+import Reflex.Dom.Widget.Input (dropdown)
5062import Reflex.Patch.DMapWithMove
5163import System.Directory
5264import System.Environment
@@ -55,14 +67,13 @@ import System.IO.Silently
5567import System.IO.Temp
5668import System.Process
5769import System.Which (staticWhich)
58−import qualified Test.HUnit as HUnit (assertEqual, assertFailure)
70+import qualified Test.HUnit as HUnit
5971import qualified Test.Hspec as H
6072import qualified Test.Hspec.Core.Spec as H
6173import Test.Hspec (xit)
6274import Test.Hspec.WebDriver hiding (runWD, click, uploadFile, WD)
6375import qualified Test.Hspec.WebDriver as WD
6476import Test.WebDriver (WD(..))
65−import Test.WebDriver.Exceptions (ServerError(..))
6677
6778import qualified Data.ByteString.Lazy as LBS
6879import qualified Data.Dependent.Map as DMap
@@ -78,6 +89,9 @@ import qualified Test.WebDriver.Capabilities as WD
7889import Test.Util.ChromeFlags
7990import Test.Util.UnshareNetwork
8091
92+-- ORPHAN: https://github.com/kallisti-dev/hs-webdriver/pull/167
93+deriving instance MonadMask WD
94+
8195chromium :: FilePath
8296chromium = $(staticWhich "chromium")
8397
@@ -93,11 +107,14 @@ instance MonadRef WD where
93107 writeRef r = WD . writeRef r
94108
95109assertEqual :: (MonadIO m, Eq a, Show a) => String -> a -> a -> m ()
96−assertEqual a b = liftIO . HUnit.assertEqual a b
110+assertEqual msg a b = liftIO $ HUnit.assertEqual msg a b
97111
98112assertFailure :: MonadIO m => String -> m ()
99113assertFailure = liftIO . HUnit.assertFailure
100114
115+assertBool :: (MonadIO m) => String -> Bool -> m ()
116+assertBool msg bool = liftIO $ HUnit.assertBool msg bool
117+
101118chromeConfig :: Text -> [Text] -> WD.WDConfig
102119chromeConfig fp flags = WD.useBrowser (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags }) WD.defaultConfig
103120
@@ -128,7 +145,7 @@ deriving instance MonadFail WD
128145
129146main :: IO ()
130147main = do
131− unshareNetork
148+ unshareNetwork
132149 isHeadless <- (== Nothing) <$> lookupEnv "NO_HEADLESS"
133150 withSandboxedChromeFlags isHeadless $ \chromeFlags -> do
134151 withSeleniumServer $ \selenium -> do
@@ -137,13 +154,13 @@ main = do
137154 withDebugging <- isNothing <$> lookupEnv "NO_DEBUG"
138155 let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _selenium_portNumber selenium }
139156 chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
140− hspec (tests withDebugging wdConfig [chromeCaps'] selenium) `finally` _selenium_stopServer selenium
157+ hspec (tests withDebugging wdConfig [(chromeCaps', "chrome")] selenium) `finally` _selenium_stopServer selenium
141158
142−tests :: Bool -> WD.WDConfig -> [Capabilities] -> Selenium -> Spec
159+tests :: Bool -> WD.WDConfig -> [(Capabilities, String)] -> Selenium -> Spec
143160tests withDebugging wdConfig caps _selenium = do
144161 let putStrLnDebug :: MonadIO m => Text -> m ()
145162 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
146− session' = sessionWith wdConfig "" . using (map (,"") caps)
163+ session' t = sessionWith wdConfig t . using caps
147164 runWD m = runWDOptions (WdOptions False) $ do
148165 putStrLnDebug "before"
149166 r <- m
@@ -152,10 +169,10 @@ tests withDebugging wdConfig caps _selenium = do
152169 testWidgetStatic :: WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
153170 testWidgetStatic = testWidgetStaticDebug withDebugging
154171 testWidget :: WD () -> WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
155− testWidget = testWidgetDebug withDebugging
172+ testWidget = testWidgetDebug True withDebugging
156173 testWidget' :: WD a -> (a -> WD b) -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
157− testWidget' = testWidgetDebug' withDebugging
158− describe "text" $ session' $ do
174+ testWidget' = testWidgetDebug' True withDebugging
175+ session' "text" $ do
159176 it "works" $ runWD $ do
160177 testWidgetStatic (checkBodyText "hello world") $ do
161178 text "hello world"
@@ -216,7 +233,7 @@ tests withDebugging wdConfig caps _selenium = do
216233 click <- button ""
217234 void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
218235
219− describe "element" $ session' $ do
236+ session' "element" $ do
220237 it "works with domEvent Click" $ runWD $ do
221238 clickedRef <- liftIO $ newRef False
222239 testWidget' (findElemWithRetry $ WD.ByTag "div") WD.click $ do
@@ -280,21 +297,78 @@ tests withDebugging wdConfig caps _selenium = do
280297 let click = domEvent Click e
281298 return ()
282299
283− describe "inputElement" $ do
284− 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
285359 it "doesn't wipe user input when switching over" $ runWD $ do
286− inputRef <- newRef ("" :: Text)
360+ inputRef <- newRef ("hello " :: Text)
287361 testWidget'
288362 (do
289363 e <- findElemWithRetry $ WD.ByTag "input"
290− WD.sendKeys "hello world" e
364+ WD.sendKeys "world" e
291365 pure e)
292366 (\e -> do
293367 WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
294368 WD.click =<< findElemWithRetry (WD.ByTag "button")
295369 readRef inputRef `shouldBeWithRetryM` "hello world"
296370 ) $ do
297− e <- inputElement def
371+ e <- inputElement $ def & inputElementConfig_initialValue .~ "hello "
298372 click <- button "save"
299373 performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
300374 it "captures user input after switchover" $ runWD $ do
@@ -351,24 +425,49 @@ tests withDebugging wdConfig caps _selenium = do
351425 checkedByUIRef <- newRef False
352426 checkedRef <- newRef False
353427 setCheckedChan <- liftIO newChan
354− 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
355433 readRef checkedByUIRef `shouldBeWithRetryM` False
356434 readRef checkedRef `shouldBeWithRetryM` False
357− e <- findElemWithRetry $ WD.ByTag "input"
435+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
358436 WD.moveToCenter e
359437 WD.click e
360438 readRef checkedByUIRef `shouldBeWithRetryM` True
361439 readRef checkedRef `shouldBeWithRetryM` True
440+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
362441 liftIO $ writeChan setCheckedChan False
363442 readRef checkedByUIRef `shouldBeWithRetryM` True
364443 readRef checkedRef `shouldBeWithRetryM` False
365− testWidget (pure ()) checkValue $ do
444+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
445+ testWidget' checkStatic checkValue $ do
366446 setChecked <- triggerEventWithChan setCheckedChan
367447 e <- inputElement $ def
368448 & initialAttributes .~ "type" =: "checkbox"
369449 & inputElementConfig_setChecked .~ setChecked
370450 performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
371451 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)
372471 it "captures file uploads" $ runWD $ do
373472 filesRef :: IORef [Text] <- newRef []
374473 let uploadFile = do
@@ -384,8 +483,117 @@ tests withDebugging wdConfig caps _selenium = do
384483 prerender_ (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
385484 names <- liftJSM $ traverse File.getName fs
386485 liftIO $ writeRef filesRef names
387−
388− 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
389597 it "captures user input after switchover" $ runWD $ do
390598 inputRef :: IORef Text <- newRef ""
391599 let checkValue = do
@@ -465,8 +673,31 @@ tests withDebugging wdConfig caps _selenium = do
465673 names <- liftJSM $ traverse File.getName fs
466674 liftIO $ writeRef filesRef names
467675
468− describe "textAreaElement" $ do
469− 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
470701 it "doesn't wipe user input when switching over" $ runWD $ do
471702 inputRef <- newRef ("" :: Text)
472703 testWidget'
@@ -532,8 +763,90 @@ tests withDebugging wdConfig caps _selenium = do
532763 e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
533764 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
534765 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
535848
536− describe "hydration/immediate" $ session' $ do
849+ describe "hydration/immediate" $ do
537850 it "captures user input after switchover" $ runWD $ do
538851 inputRef :: IORef Text <- newRef ""
539852 let checkValue = do
@@ -575,13 +888,13 @@ tests withDebugging wdConfig caps _selenium = do
575888 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
576889 performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
577890
578− describe "selectElement" $ do
891+ session' "selectElement" $ do
579892 let options :: DomBuilder t m => m ()
580893 options = do
581894 elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
582895 elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
583896 elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
584− describe "hydration" $ session' $ do
897+ describe "hydration" $ do
585898 it "sets initial value correctly" $ runWD $ do
586899 inputRef <- newRef ("" :: Text)
587900 let setup = do
@@ -655,7 +968,7 @@ tests withDebugging wdConfig caps _selenium = do
655968 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
656969 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
657970
658− describe "hydration/immediate" $ session' $ do
971+ describe "hydration/immediate" $ do
659972 it "captures user input after switchover" $ runWD $ do
660973 inputRef :: IORef Text <- newRef ""
661974 let checkValue = do
@@ -701,7 +1014,7 @@ tests withDebugging wdConfig caps _selenium = do
7011014 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
7021015 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
7031016
704− describe "prerender" $ session' $ do
1017+ session' "prerender" $ do
7051018 it "works in simple case" $ runWD $ do
7061019 testWidget (checkBodyText "One") (checkBodyText "Two") $ do
7071020 prerender_ (text "One") (text "Two")
@@ -770,7 +1083,16 @@ tests withDebugging wdConfig caps _selenium = do
7701083 prerender_ (pure ()) (liftIO $ trigger "Client")
7711084 textNode $ TextNodeConfig "Initial" $ Just e
7721085
773− 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
7741096 it "works" $ runWD $ do
7751097 replaceChan :: Chan Text <- liftIO newChan
7761098 let setup = findElemWithRetry $ WD.ByTag "div"
@@ -914,7 +1236,61 @@ tests withDebugging wdConfig caps _selenium = do
9141236 , el "span" . text <$> replace
9151237 ]
9161238
917− 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
9181294 let widget :: DomBuilder t m => DKey a -> Identity a -> m (Identity a)
9191295 widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
9201296 elClass "span" "key" $ text $ textKey k
@@ -1017,7 +1393,7 @@ tests withDebugging wdConfig caps _selenium = do
10171393 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
10181394 liftIO $ dmap `H.shouldBe` keyMap
10191395
1020− describe "traverseIntMapWithKeyWithAdjust" $ session' $ do
1396+ session' "traverseIntMapWithKeyWithAdjust" $ do
10211397 let textKeyInt k = "key" <> T.pack (show k)
10221398 intMap = IntMap.fromList
10231399 [ (1, "one")
@@ -1124,7 +1500,7 @@ tests withDebugging wdConfig caps _selenium = do
11241500 (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
11251501 liftIO $ dmap `H.shouldBe` intMap
11261502
1127− describe "traverseDMapWithKeyWithAdjustWithMove" $ session' $ do
1503+ session' "traverseDMapWithKeyWithAdjustWithMove" $ do
11281504 let widget :: DomBuilder t m => Key2 a -> Identity a -> m (Identity a)
11291505 widget k (Identity v) = elAttr "li" ("id" =: textKey2 k) $ do
11301506 elClass "span" "key" $ text $ textKey2 k
@@ -1204,8 +1580,8 @@ tests withDebugging wdConfig caps _selenium = do
12041580 (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
12051581 liftIO $ assertEqual "DMap" initMap dmap
12061582
1207− describe "hydrating invalid HTML" $ session' $ do
1208− it "can hydrate list in paragraph" $ runWD $ do
1583+ session' "hydrating invalid HTML" $ do
1584+ xit "can hydrate list in paragraph" $ runWD $ do
12091585 let preSwitchover = do
12101586 checkBodyText "before\ninner\nafter"
12111587 -- Two <p> tags should be present
@@ -1222,7 +1598,8 @@ tests withDebugging wdConfig caps _selenium = do
12221598 shouldContainText "before\ninner\nafter" p1
12231599 elementShouldBeRemoved ol
12241600 elementShouldBeRemoved p2
1225− testWidget' preSwitchover check $ do
1601+ -- Don't fail fatally when hydration encounters the invalid DOM
1602+ testWidgetDebug' False withDebugging preSwitchover check $ do
12261603 -- This is deliberately invalid HTML, the browser will interpret it as
12271604 -- <p>before</p><ol>inner</ol>after<p></p>
12281605 el "p" $ do
@@ -1230,6 +1607,29 @@ tests withDebugging wdConfig caps _selenium = do
12301607 el "ol" $ text "inner"
12311608 text "after"
12321609
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+
12331633data Selenium = Selenium
12341634 { _selenium_portNumber :: PortNumber
12351635 , _selenium_stopServer :: IO ()
@@ -1297,6 +1697,9 @@ checkTextInId i expected = do
12971697findElemWithRetry :: Selector -> WD WD.Element
12981698findElemWithRetry = withRetry . WD.findElem
12991699
1700+findElemsWithRetry :: Selector -> WD [WD.Element]
1701+findElemsWithRetry = withRetry . WD.findElems
1702+
13001703getBody :: WD WD.Element
13011704getBody = WD.findElem $ WD.ByTag "body"
13021705
@@ -1305,8 +1708,8 @@ withRetry a = wait 300
13051708 where wait :: Int -> WD a
13061709 wait 0 = a
13071710 wait n = try a >>= \case
1308− Left (_ :: SomeException) -> do
1309− liftIO $ threadDelay 100000
1711+ Left (e :: SomeException) -> do
1712+ liftIO $ putStrLn ("(retrying due to " <> show e <> ")") *> threadDelay 100000
13101713 wait $ n - 1
13111714 Right v -> return v
13121715
@@ -1322,11 +1725,12 @@ testWidgetStaticDebug
13221725 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
13231726 -- ^ Widget we are testing
13241727 -> WD b
1325−testWidgetStaticDebug withDebugging w = testWidgetDebug withDebugging (void w) w
1728+testWidgetStaticDebug withDebugging w = testWidgetDebug True withDebugging (void w) w
13261729
13271730-- | TODO: do something about JSExceptions not causing tests to fail
13281731testWidgetDebug
13291732 :: Bool
1733+ -> Bool
13301734 -> WD ()
13311735 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
13321736 -> WD b
@@ -1334,12 +1738,16 @@ testWidgetDebug
13341738 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
13351739 -- ^ Widget we are testing
13361740 -> WD b
1337−testWidgetDebug withDebugging beforeJS afterSwitchover =
1338− 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
13391746
13401747-- | TODO: do something about JSExceptions not causing tests to fail
13411748testWidgetDebug'
13421749 :: Bool
1750+ -> Bool
13431751 -> WD a
13441752 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
13451753 -> (a -> WD b)
@@ -1347,7 +1755,7 @@ testWidgetDebug'
13471755 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
13481756 -- ^ Widget we are testing (contents of body)
13491757 -> WD b
1350−testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
1758+testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget = do
13511759 let putStrLnDebug :: MonadIO m => Text -> m ()
13521760 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
13531761 staticApp = do
@@ -1359,6 +1767,7 @@ testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
13591767 ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
13601768 putStrLnDebug "rendered static"
13611769 waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
1770+ onFailure <- if hardFailure then (`throwTo` HydrationFailedException) <$> liftIO myThreadId else pure $ pure ()
13621771 waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
13631772 let entryPoint = do
13641773 putStrLnDebug "taking waitBeforeJS"
@@ -1370,7 +1779,7 @@ testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
13701779 liftIO $ putMVar waitUntilSwitchover ()
13711780 putStrLnDebug "put waitUntilSwitchover"
13721781 putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
1373− mainHydrationWidgetWithSwitchoverAction switchOverAction blank bodyWidget
1782+ mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchOverAction blank bodyWidget
13741783 putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
13751784 syncPoint
13761785 application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
@@ -1388,23 +1797,26 @@ testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
13881797 ]
13891798 -- hSilence to get rid of ConnectionClosed logs
13901799 silenceIfDebug = if withDebugging then id else hSilence [stderr]
1391− jsaddleWarp = forkIO $ silenceIfDebug $ Warp.runSettings settings application
1392− jsaddleTid <- liftIO jsaddleWarp
1393− putStrLnDebug "taking waitJSaddle"
1394− liftIO $ takeMVar waitJSaddle
1395− putStrLnDebug "opening page"
1396− WD.openPage $ "http://localhost:" <> show jsaddlePort
1397− putStrLnDebug "running beforeJS"
1398− a <- beforeJS
1399− putStrLnDebug "putting waitBeforeJS"
1400− liftIO $ putMVar waitBeforeJS ()
1401− putStrLnDebug "taking waitUntilSwitchover"
1402− liftIO $ takeMVar waitUntilSwitchover
1403− putStrLnDebug "running afterSwitchover"
1404− b <- afterSwitchover a
1405− putStrLnDebug "killing jsaddle thread"
1406− liftIO $ killThread jsaddleTid
1407− 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)
14081820
14091821data Key2 a where
14101822 Key2_Int :: Int -> Key2 Int