@@ -1,9 +1,13 @@
1+{-# OPTIONS_GHC -fno-warn-orphans #-}
12{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE StandaloneDeriving #-}
4+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5+{-# LANGUAGE UndecidableInstances #-}
26{-# LANGUAGE ConstraintKinds #-}
7+{-# LANGUAGE CPP #-}
38{-# LANGUAGE FlexibleContexts #-}
49{-# LANGUAGE FlexibleInstances #-}
510{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
711{-# LANGUAGE LambdaCase #-}
812{-# LANGUAGE MultiParamTypeClasses #-}
913{-# LANGUAGE OverloadedStrings #-}
@@ -11,26 +15,13 @@
1115{-# LANGUAGE RankNTypes #-}
1216{-# LANGUAGE RecursiveDo #-}
1317{-# LANGUAGE ScopedTypeVariables #-}
14−{-# LANGUAGE StandaloneDeriving #-}
1518{-# LANGUAGE TemplateHaskell #-}
1619{-# LANGUAGE TupleSections #-}
1720{-# LANGUAGE TypeApplications #-}
1821{-# 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.
3022
3123import Prelude hiding (fail)
3224import Control.Concurrent
33−import qualified Control.Concurrent.Async as Async
3425import Control.Lens.Operators
3526import Control.Monad hiding (fail)
3627import Control.Monad.Catch
@@ -41,13 +32,12 @@ import Control.Monad.Ref
4132import Data.Constraint.Extras
4233import Data.Constraint.Extras.TH
4334import Data.Dependent.Map (DMap)
44−import Data.Dependent.Sum (DSum(..), (==>))
35+import Data.Dependent.Sum (DSum(..), (==>), EqTag(..), ShowTag(..))
4536import Data.Functor.Identity
4637import Data.Functor.Misc
4738import Data.GADT.Compare.TH
4839import Data.GADT.Show.TH
4940import Data.IORef (IORef)
50−import Data.List (sort)
5141import Data.Maybe
5242import Data.Proxy
5343import Data.Text (Text)
@@ -58,7 +48,6 @@ import Network.Socket
5848import Network.Wai
5949import Network.WebSockets
6050import Reflex.Dom.Core
61−import Reflex.Dom.Widget.Input (dropdown)
6251import Reflex.Patch.DMapWithMove
6352import System.Directory
6453import System.Environment
@@ -67,13 +56,14 @@ import System.IO.Silently
6756import System.IO.Temp
6857import System.Process
6958import System.Which (staticWhich)
70−import qualified Test.HUnit as HUnit
59+import qualified Test.HUnit as HUnit (assertEqual, assertFailure)
7160import qualified Test.Hspec as H
7261import qualified Test.Hspec.Core.Spec as H
7362import Test.Hspec (xit)
7463import Test.Hspec.WebDriver hiding (runWD, click, uploadFile, WD)
7564import qualified Test.Hspec.WebDriver as WD
7665import Test.WebDriver (WD(..))
66+import Test.WebDriver.Exceptions (ServerError(..))
7767
7868import qualified Data.ByteString.Lazy as LBS
7969import qualified Data.Dependent.Map as DMap
@@ -89,9 +79,6 @@ import qualified Test.WebDriver.Capabilities as WD
8979import Test.Util.ChromeFlags
9080import Test.Util.UnshareNetwork
9181
92−-- ORPHAN: https://github.com/kallisti-dev/hs-webdriver/pull/167
93−deriving instance MonadMask WD
94−
9582chromium :: FilePath
9683chromium = $(staticWhich "chromium")
9784
@@ -107,14 +94,11 @@ instance MonadRef WD where
10794 writeRef r = WD . writeRef r
10895
10996assertEqual :: (MonadIO m, Eq a, Show a) => String -> a -> a -> m ()
110−assertEqual msg a b = liftIO $ HUnit.assertEqual msg a b
97+assertEqual a b = liftIO . HUnit.assertEqual a b
11198
11299assertFailure :: MonadIO m => String -> m ()
113100assertFailure = liftIO . HUnit.assertFailure
114101
115−assertBool :: (MonadIO m) => String -> Bool -> m ()
116−assertBool msg bool = liftIO $ HUnit.assertBool msg bool
117−
118102chromeConfig :: Text -> [Text] -> WD.WDConfig
119103chromeConfig fp flags = WD.useBrowser (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags }) WD.defaultConfig
120104
@@ -145,7 +129,7 @@ deriving instance MonadFail WD
145129
146130main :: IO ()
147131main = do
148− unshareNetwork
132+ unshareNetork
149133 isHeadless <- (== Nothing) <$> lookupEnv "NO_HEADLESS"
150134 withSandboxedChromeFlags isHeadless $ \chromeFlags -> do
151135 withSeleniumServer $ \selenium -> do
@@ -154,13 +138,13 @@ main = do
154138 withDebugging <- isNothing <$> lookupEnv "NO_DEBUG"
155139 let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _selenium_portNumber selenium }
156140 chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
157− hspec (tests withDebugging wdConfig [(chromeCaps', "chrome")] selenium) `finally` _selenium_stopServer selenium
141+ hspec (tests withDebugging wdConfig [chromeCaps'] selenium) `finally` _selenium_stopServer selenium
158142
159−tests :: Bool -> WD.WDConfig -> [(Capabilities, String)] -> Selenium -> Spec
143+tests :: Bool -> WD.WDConfig -> [Capabilities] -> Selenium -> Spec
160144tests withDebugging wdConfig caps _selenium = do
161145 let putStrLnDebug :: MonadIO m => Text -> m ()
162146 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
163− session' t = sessionWith wdConfig t . using caps
147+ session' = sessionWith wdConfig "" . using (map (,"") caps)
164148 runWD m = runWDOptions (WdOptions False) $ do
165149 putStrLnDebug "before"
166150 r <- m
@@ -169,10 +153,10 @@ tests withDebugging wdConfig caps _selenium = do
169153 testWidgetStatic :: WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
170154 testWidgetStatic = testWidgetStaticDebug withDebugging
171155 testWidget :: WD () -> WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
172− testWidget = testWidgetDebug True withDebugging
156+ testWidget = testWidgetDebug withDebugging
173157 testWidget' :: WD a -> (a -> WD b) -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
174− testWidget' = testWidgetDebug' True withDebugging
175− session' "text" $ do
158+ testWidget' = testWidgetDebug' withDebugging
159+ describe "text" $ session' $ do
176160 it "works" $ runWD $ do
177161 testWidgetStatic (checkBodyText "hello world") $ do
178162 text "hello world"
@@ -233,7 +217,7 @@ tests withDebugging wdConfig caps _selenium = do
233217 click <- button ""
234218 void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
235219
236− session' "element" $ do
220+ describe "element" $ session' $ do
237221 it "works with domEvent Click" $ runWD $ do
238222 clickedRef <- liftIO $ newRef False
239223 testWidget' (findElemWithRetry $ WD.ByTag "div") WD.click $ do
@@ -297,78 +281,21 @@ tests withDebugging wdConfig caps _selenium = do
297281 let click = domEvent Click e
298282 return ()
299283
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
284+ describe "inputElement" $ do
285+ describe "hydration" $ session' $ do
359286 it "doesn't wipe user input when switching over" $ runWD $ do
360− inputRef <- newRef ("hello " :: Text)
287+ inputRef <- newRef ("" :: Text)
361288 testWidget'
362289 (do
363290 e <- findElemWithRetry $ WD.ByTag "input"
364− WD.sendKeys "world" e
291+ WD.sendKeys "hello world" e
365292 pure e)
366293 (\e -> do
367294 WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
368295 WD.click =<< findElemWithRetry (WD.ByTag "button")
369296 readRef inputRef `shouldBeWithRetryM` "hello world"
370297 ) $ do
371− e <- inputElement $ def & inputElementConfig_initialValue .~ "hello "
298+ e <- inputElement def
372299 click <- button "save"
373300 performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
374301 it "captures user input after switchover" $ runWD $ do
@@ -425,49 +352,24 @@ tests withDebugging wdConfig caps _selenium = do
425352 checkedByUIRef <- newRef False
426353 checkedRef <- newRef False
427354 setCheckedChan <- liftIO newChan
428− let checkStatic = do
429− e <- findElemWithRetry $ WD.ByTag "input"
430− WD.attr e "checked" `shouldBeWithRetryM` Nothing
431− pure e
432− checkValue e = do
355+ let checkValue = do
433356 readRef checkedByUIRef `shouldBeWithRetryM` False
434357 readRef checkedRef `shouldBeWithRetryM` False
435− WD.attr e "checked" `shouldBeWithRetryM` Nothing
358+ e <- findElemWithRetry $ WD.ByTag "input"
436359 WD.moveToCenter e
437360 WD.click e
438361 readRef checkedByUIRef `shouldBeWithRetryM` True
439362 readRef checkedRef `shouldBeWithRetryM` True
440− WD.attr e "checked" `shouldBeWithRetryM` Just "true"
441363 liftIO $ writeChan setCheckedChan False
442364 readRef checkedByUIRef `shouldBeWithRetryM` True
443365 readRef checkedRef `shouldBeWithRetryM` False
444− WD.attr e "checked" `shouldBeWithRetryM` Nothing
445− testWidget' checkStatic checkValue $ do
366+ testWidget (pure ()) checkValue $ do
446367 setChecked <- triggerEventWithChan setCheckedChan
447368 e <- inputElement $ def
448369 & initialAttributes .~ "type" =: "checkbox"
449370 & inputElementConfig_setChecked .~ setChecked
450371 performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
451372 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)
471373 it "captures file uploads" $ runWD $ do
472374 filesRef :: IORef [Text] <- newRef []
473375 let uploadFile = do
@@ -483,117 +385,8 @@ tests withDebugging wdConfig caps _selenium = do
483385 prerender_ (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
484386 names <- liftJSM $ traverse File.getName fs
485387 liftIO $ writeRef filesRef names
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
388+
389+ describe "hydration/immediate" $ session' $ do
597390 it "captures user input after switchover" $ runWD $ do
598391 inputRef :: IORef Text <- newRef ""
599392 let checkValue = do
@@ -673,31 +466,8 @@ tests withDebugging wdConfig caps _selenium = do
673466 names <- liftJSM $ traverse File.getName fs
674467 liftIO $ writeRef filesRef names
675468
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
469+ describe "textAreaElement" $ do
470+ describe "hydration" $ session' $ do
701471 it "doesn't wipe user input when switching over" $ runWD $ do
702472 inputRef <- newRef ("" :: Text)
703473 testWidget'
@@ -763,90 +533,8 @@ tests withDebugging wdConfig caps _selenium = do
763533 e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
764534 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
765535 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
848536
849− describe "hydration/immediate" $ do
537+ describe "hydration/immediate" $ session' $ do
850538 it "captures user input after switchover" $ runWD $ do
851539 inputRef :: IORef Text <- newRef ""
852540 let checkValue = do
@@ -888,13 +576,13 @@ tests withDebugging wdConfig caps _selenium = do
888576 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
889577 performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
890578
891− session' "selectElement" $ do
579+ describe "selectElement" $ do
892580 let options :: DomBuilder t m => m ()
893581 options = do
894582 elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
895583 elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
896584 elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
897− describe "hydration" $ do
585+ describe "hydration" $ session' $ do
898586 it "sets initial value correctly" $ runWD $ do
899587 inputRef <- newRef ("" :: Text)
900588 let setup = do
@@ -968,7 +656,7 @@ tests withDebugging wdConfig caps _selenium = do
968656 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
969657 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
970658
971− describe "hydration/immediate" $ do
659+ describe "hydration/immediate" $ session' $ do
972660 it "captures user input after switchover" $ runWD $ do
973661 inputRef :: IORef Text <- newRef ""
974662 let checkValue = do
@@ -1014,7 +702,7 @@ tests withDebugging wdConfig caps _selenium = do
1014702 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
1015703 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
1016704
1017− session' "prerender" $ do
705+ describe "prerender" $ session' $ do
1018706 it "works in simple case" $ runWD $ do
1019707 testWidget (checkBodyText "One") (checkBodyText "Two") $ do
1020708 prerender_ (text "One") (text "Two")
@@ -1083,7 +771,7 @@ tests withDebugging wdConfig caps _selenium = do
1083771 prerender_ (pure ()) (liftIO $ trigger "Client")
1084772 textNode $ TextNodeConfig "Initial" $ Just e
1085773
1086− session' "namespaces" $ do
774+ describe "namespaces" $ session' $ do
1087775 it "dyn can be nested in namespaced widget" $ runWD $ do
1088776 testWidget (pure ()) (checkTextInTag "svg" "one") $ do
1089777 let svgRootCfg = def
@@ -1092,7 +780,7 @@ tests withDebugging wdConfig caps _selenium = do
1092780 void $ element "svg" svgRootCfg $ do
1093781 dyn_ $ text "one" <$ pure ()
1094782
1095− session' "runWithReplace" $ do
783+ describe "runWithReplace" $ session' $ do
1096784 it "works" $ runWD $ do
1097785 replaceChan :: Chan Text <- liftIO newChan
1098786 let setup = findElemWithRetry $ WD.ByTag "div"
@@ -1236,61 +924,7 @@ tests withDebugging wdConfig caps _selenium = do
1236924 , el "span" . text <$> replace
1237925 ]
1238926
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
927+ describe "traverseDMapWithKeyWithAdjust" $ session' $ do
1294928 let widget :: DomBuilder t m => DKey a -> Identity a -> m (Identity a)
1295929 widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
1296930 elClass "span" "key" $ text $ textKey k
@@ -1393,7 +1027,7 @@ tests withDebugging wdConfig caps _selenium = do
13931027 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
13941028 liftIO $ dmap `H.shouldBe` keyMap
13951029
1396− session' "traverseIntMapWithKeyWithAdjust" $ do
1030+ describe "traverseIntMapWithKeyWithAdjust" $ session' $ do
13971031 let textKeyInt k = "key" <> T.pack (show k)
13981032 intMap = IntMap.fromList
13991033 [ (1, "one")
@@ -1500,7 +1134,7 @@ tests withDebugging wdConfig caps _selenium = do
15001134 (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
15011135 liftIO $ dmap `H.shouldBe` intMap
15021136
1503− session' "traverseDMapWithKeyWithAdjustWithMove" $ do
1137+ describe "traverseDMapWithKeyWithAdjustWithMove" $ session' $ do
15041138 let widget :: DomBuilder t m => Key2 a -> Identity a -> m (Identity a)
15051139 widget k (Identity v) = elAttr "li" ("id" =: textKey2 k) $ do
15061140 elClass "span" "key" $ text $ textKey2 k
@@ -1580,8 +1214,8 @@ tests withDebugging wdConfig caps _selenium = do
15801214 (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
15811215 liftIO $ assertEqual "DMap" initMap dmap
15821216
1583− session' "hydrating invalid HTML" $ do
1584− xit "can hydrate list in paragraph" $ runWD $ do
1217+ describe "hydrating invalid HTML" $ session' $ do
1218+ it "can hydrate list in paragraph" $ runWD $ do
15851219 let preSwitchover = do
15861220 checkBodyText "before\ninner\nafter"
15871221 -- Two <p> tags should be present
@@ -1598,8 +1232,7 @@ tests withDebugging wdConfig caps _selenium = do
15981232 shouldContainText "before\ninner\nafter" p1
15991233 elementShouldBeRemoved ol
16001234 elementShouldBeRemoved p2
1601− -- Don't fail fatally when hydration encounters the invalid DOM
1602− testWidgetDebug' False withDebugging preSwitchover check $ do
1235+ testWidget' preSwitchover check $ do
16031236 -- This is deliberately invalid HTML, the browser will interpret it as
16041237 -- <p>before</p><ol>inner</ol>after<p></p>
16051238 el "p" $ do
@@ -1607,29 +1240,6 @@ tests withDebugging wdConfig caps _selenium = do
16071240 el "ol" $ text "inner"
16081241 text "after"
16091242
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−
16331243data Selenium = Selenium
16341244 { _selenium_portNumber :: PortNumber
16351245 , _selenium_stopServer :: IO ()
@@ -1697,9 +1307,6 @@ checkTextInId i expected = do
16971307findElemWithRetry :: Selector -> WD WD.Element
16981308findElemWithRetry = withRetry . WD.findElem
16991309
1700−findElemsWithRetry :: Selector -> WD [WD.Element]
1701−findElemsWithRetry = withRetry . WD.findElems
1702−
17031310getBody :: WD WD.Element
17041311getBody = WD.findElem $ WD.ByTag "body"
17051312
@@ -1708,8 +1315,8 @@ withRetry a = wait 300
17081315 where wait :: Int -> WD a
17091316 wait 0 = a
17101317 wait n = try a >>= \case
1711− Left (e :: SomeException) -> do
1712− liftIO $ putStrLn ("(retrying due to " <> show e <> ")") *> threadDelay 100000
1318+ Left (_ :: SomeException) -> do
1319+ liftIO $ threadDelay 100000
17131320 wait $ n - 1
17141321 Right v -> return v
17151322
@@ -1725,12 +1332,11 @@ testWidgetStaticDebug
17251332 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
17261333 -- ^ Widget we are testing
17271334 -> WD b
1728−testWidgetStaticDebug withDebugging w = testWidgetDebug True withDebugging (void w) w
1335+testWidgetStaticDebug withDebugging w = testWidgetDebug withDebugging (void w) w
17291336
17301337-- | TODO: do something about JSExceptions not causing tests to fail
17311338testWidgetDebug
17321339 :: Bool
1733− -> Bool
17341340 -> WD ()
17351341 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
17361342 -> WD b
@@ -1738,16 +1344,12 @@ testWidgetDebug
17381344 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
17391345 -- ^ Widget we are testing
17401346 -> WD b
1741−testWidgetDebug hardFailure withDebugging beforeJS afterSwitchover =
1742− testWidgetDebug' hardFailure withDebugging beforeJS (const afterSwitchover)
1743−
1744−data HydrationFailedException = HydrationFailedException deriving Show
1745−instance Exception HydrationFailedException
1347+testWidgetDebug withDebugging beforeJS afterSwitchover =
1348+ testWidgetDebug' withDebugging beforeJS (const afterSwitchover)
17461349
17471350-- | TODO: do something about JSExceptions not causing tests to fail
17481351testWidgetDebug'
17491352 :: Bool
1750− -> Bool
17511353 -> WD a
17521354 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
17531355 -> (a -> WD b)
@@ -1755,7 +1357,7 @@ testWidgetDebug'
17551357 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
17561358 -- ^ Widget we are testing (contents of body)
17571359 -> WD b
1758−testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget = do
1360+testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
17591361 let putStrLnDebug :: MonadIO m => Text -> m ()
17601362 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
17611363 staticApp = do
@@ -1767,7 +1369,6 @@ testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget =
17671369 ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
17681370 putStrLnDebug "rendered static"
17691371 waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
1770− onFailure <- if hardFailure then (`throwTo` HydrationFailedException) <$> liftIO myThreadId else pure $ pure ()
17711372 waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
17721373 let entryPoint = do
17731374 putStrLnDebug "taking waitBeforeJS"
@@ -1779,7 +1380,7 @@ testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget =
17791380 liftIO $ putMVar waitUntilSwitchover ()
17801381 putStrLnDebug "put waitUntilSwitchover"
17811382 putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
1782− mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchOverAction blank bodyWidget
1383+ mainHydrationWidgetWithSwitchoverAction switchOverAction blank bodyWidget
17831384 putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
17841385 syncPoint
17851386 application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
@@ -1797,26 +1398,23 @@ testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget =
17971398 ]
17981399 -- hSilence to get rid of ConnectionClosed logs
17991400 silenceIfDebug = if withDebugging then id else hSilence [stderr]
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)
1401+ jsaddleWarp = forkIO $ silenceIfDebug $ Warp.runSettings settings application
1402+ jsaddleTid <- liftIO jsaddleWarp
1403+ putStrLnDebug "taking waitJSaddle"
1404+ liftIO $ takeMVar waitJSaddle
1405+ putStrLnDebug "opening page"
1406+ WD.openPage $ "http://localhost:" <> show jsaddlePort
1407+ putStrLnDebug "running beforeJS"
1408+ a <- beforeJS
1409+ putStrLnDebug "putting waitBeforeJS"
1410+ liftIO $ putMVar waitBeforeJS ()
1411+ putStrLnDebug "taking waitUntilSwitchover"
1412+ liftIO $ takeMVar waitUntilSwitchover
1413+ putStrLnDebug "running afterSwitchover"
1414+ b <- afterSwitchover a
1415+ putStrLnDebug "killing jsaddle thread"
1416+ liftIO $ killThread jsaddleTid
1417+ return b
18201418
18211419data Key2 a where
18221420 Key2_Int :: Int -> Key2 Int