@@ -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,27 +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
34−import Control.Lens.Operators
3525import Control.Monad hiding (fail)
3626import Control.Monad.Catch
3727import Control.Monad.Fail
@@ -41,13 +31,12 @@ import Control.Monad.Ref
4131import Data.Constraint.Extras
4232import Data.Constraint.Extras.TH
4333import Data.Dependent.Map (DMap)
44−import Data.Dependent.Sum (DSum(..), (==>))
34+import Data.Dependent.Sum (DSum(..), (==>), EqTag(..), ShowTag(..))
4535import Data.Functor.Identity
4636import Data.Functor.Misc
4737import Data.GADT.Compare.TH
4838import Data.GADT.Show.TH
4939import Data.IORef (IORef)
50−import Data.List (sort)
5140import Data.Maybe
5241import Data.Proxy
5342import Data.Text (Text)
@@ -58,7 +47,6 @@ import Network.Socket
5847import Network.Wai
5948import Network.WebSockets
6049import Reflex.Dom.Core
61−import Reflex.Dom.Widget.Input (dropdown)
6250import Reflex.Patch.DMapWithMove
6351import System.Directory
6452import System.Environment
@@ -66,14 +54,14 @@ import System.IO (stderr)
6654import System.IO.Silently
6755import System.IO.Temp
6856import System.Process
69−import System.Which (staticWhich)
70−import qualified Test.HUnit as HUnit
57+import qualified Test.HUnit as HUnit (assertEqual, assertFailure)
7158import qualified Test.Hspec as H
7259import qualified Test.Hspec.Core.Spec as H
7360import Test.Hspec (xit)
7461import Test.Hspec.WebDriver hiding (runWD, click, uploadFile, WD)
7562import qualified Test.Hspec.WebDriver as WD
7663import Test.WebDriver (WD(..))
64+import Test.WebDriver.Exceptions (ServerError(..))
7765
7866import qualified Data.ByteString.Lazy as LBS
7967import qualified Data.Dependent.Map as DMap
@@ -89,12 +77,6 @@ import qualified Test.WebDriver.Capabilities as WD
8977import Test.Util.ChromeFlags
9078import Test.Util.UnshareNetwork
9179
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−
9880seleniumPort, jsaddlePort :: PortNumber
9981seleniumPort = 8000
10082jsaddlePort = 8001
@@ -107,14 +89,11 @@ instance MonadRef WD where
10789 writeRef r = WD . writeRef r
10890
10991assertEqual :: (MonadIO m, Eq a, Show a) => String -> a -> a -> m ()
110−assertEqual msg a b = liftIO $ HUnit.assertEqual msg a b
92+assertEqual a b = liftIO . HUnit.assertEqual a b
11193
11294assertFailure :: MonadIO m => String -> m ()
11395assertFailure = liftIO . HUnit.assertFailure
11496
115−assertBool :: (MonadIO m) => String -> Bool -> m ()
116−assertBool msg bool = liftIO $ HUnit.assertBool msg bool
117−
11897chromeConfig :: Text -> [Text] -> WD.WDConfig
11998chromeConfig fp flags = WD.useBrowser (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags }) WD.defaultConfig
12099
@@ -145,22 +124,22 @@ deriving instance MonadFail WD
145124
146125main :: IO ()
147126main = do
148− unshareNetwork
127+ unshareNetork
149128 isHeadless <- (== Nothing) <$> lookupEnv "NO_HEADLESS"
150129 withSandboxedChromeFlags isHeadless $ \chromeFlags -> do
151130 withSeleniumServer $ \selenium -> do
152− let browserPath = T.strip $ T.pack chromium
131+ browserPath <- liftIO $ T.strip . T.pack <$> readProcess "which" [ "chromium" ] ""
153132 when (T.null browserPath) $ fail "No browser found"
154133 withDebugging <- isNothing <$> lookupEnv "NO_DEBUG"
155134 let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _selenium_portNumber selenium }
156135 chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
157− hspec (tests withDebugging wdConfig [(chromeCaps', "chrome")] selenium) `finally` _selenium_stopServer selenium
136+ hspec (tests withDebugging wdConfig [chromeCaps'] selenium) `finally` _selenium_stopServer selenium
158137
159−tests :: Bool -> WD.WDConfig -> [(Capabilities, String)] -> Selenium -> Spec
138+tests :: Bool -> WD.WDConfig -> [Capabilities] -> Selenium -> Spec
160139tests withDebugging wdConfig caps _selenium = do
161140 let putStrLnDebug :: MonadIO m => Text -> m ()
162141 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
163− session' t = sessionWith wdConfig t . using caps
142+ session' = sessionWith wdConfig "" . using (map (,"") caps)
164143 runWD m = runWDOptions (WdOptions False) $ do
165144 putStrLnDebug "before"
166145 r <- m
@@ -169,10 +148,10 @@ tests withDebugging wdConfig caps _selenium = do
169148 testWidgetStatic :: WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
170149 testWidgetStatic = testWidgetStaticDebug withDebugging
171150 testWidget :: WD () -> WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
172− testWidget = testWidgetDebug True withDebugging
151+ testWidget = testWidgetDebug withDebugging
173152 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
153+ testWidget' = testWidgetDebug' withDebugging
154+ describe "text" $ session' $ do
176155 it "works" $ runWD $ do
177156 testWidgetStatic (checkBodyText "hello world") $ do
178157 text "hello world"
@@ -233,7 +212,7 @@ tests withDebugging wdConfig caps _selenium = do
233212 click <- button ""
234213 void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
235214
236− session' "element" $ do
215+ describe "element" $ session' $ do
237216 it "works with domEvent Click" $ runWD $ do
238217 clickedRef <- liftIO $ newRef False
239218 testWidget' (findElemWithRetry $ WD.ByTag "div") WD.click $ do
@@ -297,78 +276,21 @@ tests withDebugging wdConfig caps _selenium = do
297276 let click = domEvent Click e
298277 return ()
299278
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
279+ describe "inputElement" $ do
280+ describe "hydration" $ session' $ do
359281 it "doesn't wipe user input when switching over" $ runWD $ do
360− inputRef <- newRef ("hello " :: Text)
282+ inputRef <- newRef ("" :: Text)
361283 testWidget'
362284 (do
363285 e <- findElemWithRetry $ WD.ByTag "input"
364− WD.sendKeys "world" e
286+ WD.sendKeys "hello world" e
365287 pure e)
366288 (\e -> do
367289 WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
368290 WD.click =<< findElemWithRetry (WD.ByTag "button")
369291 readRef inputRef `shouldBeWithRetryM` "hello world"
370292 ) $ do
371− e <- inputElement $ def & inputElementConfig_initialValue .~ "hello "
293+ e <- inputElement def
372294 click <- button "save"
373295 performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
374296 it "captures user input after switchover" $ runWD $ do
@@ -425,49 +347,24 @@ tests withDebugging wdConfig caps _selenium = do
425347 checkedByUIRef <- newRef False
426348 checkedRef <- newRef False
427349 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
350+ let checkValue = do
433351 readRef checkedByUIRef `shouldBeWithRetryM` False
434352 readRef checkedRef `shouldBeWithRetryM` False
435− WD.attr e "checked" `shouldBeWithRetryM` Nothing
353+ e <- findElemWithRetry $ WD.ByTag "input"
436354 WD.moveToCenter e
437355 WD.click e
438356 readRef checkedByUIRef `shouldBeWithRetryM` True
439357 readRef checkedRef `shouldBeWithRetryM` True
440− WD.attr e "checked" `shouldBeWithRetryM` Just "true"
441358 liftIO $ writeChan setCheckedChan False
442359 readRef checkedByUIRef `shouldBeWithRetryM` True
443360 readRef checkedRef `shouldBeWithRetryM` False
444− WD.attr e "checked" `shouldBeWithRetryM` Nothing
445− testWidget' checkStatic checkValue $ do
361+ testWidget (pure ()) checkValue $ do
446362 setChecked <- triggerEventWithChan setCheckedChan
447363 e <- inputElement $ def
448364 & initialAttributes .~ "type" =: "checkbox"
449365 & inputElementConfig_setChecked .~ setChecked
450366 performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
451367 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)
471368 it "captures file uploads" $ runWD $ do
472369 filesRef :: IORef [Text] <- newRef []
473370 let uploadFile = do
@@ -483,117 +380,8 @@ tests withDebugging wdConfig caps _selenium = do
483380 prerender_ (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
484381 names <- liftJSM $ traverse File.getName fs
485382 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
383+
384+ describe "hydration/immediate" $ session' $ do
597385 it "captures user input after switchover" $ runWD $ do
598386 inputRef :: IORef Text <- newRef ""
599387 let checkValue = do
@@ -673,31 +461,8 @@ tests withDebugging wdConfig caps _selenium = do
673461 names <- liftJSM $ traverse File.getName fs
674462 liftIO $ writeRef filesRef names
675463
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
464+ describe "textAreaElement" $ do
465+ describe "hydration" $ session' $ do
701466 it "doesn't wipe user input when switching over" $ runWD $ do
702467 inputRef <- newRef ("" :: Text)
703468 testWidget'
@@ -763,90 +528,8 @@ tests withDebugging wdConfig caps _selenium = do
763528 e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
764529 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
765530 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
848531
849− describe "hydration/immediate" $ do
532+ describe "hydration/immediate" $ session' $ do
850533 it "captures user input after switchover" $ runWD $ do
851534 inputRef :: IORef Text <- newRef ""
852535 let checkValue = do
@@ -888,13 +571,13 @@ tests withDebugging wdConfig caps _selenium = do
888571 performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
889572 performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
890573
891− session' "selectElement" $ do
574+ describe "selectElement" $ do
892575 let options :: DomBuilder t m => m ()
893576 options = do
894577 elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
895578 elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
896579 elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
897− describe "hydration" $ do
580+ describe "hydration" $ session' $ do
898581 it "sets initial value correctly" $ runWD $ do
899582 inputRef <- newRef ("" :: Text)
900583 let setup = do
@@ -968,7 +651,7 @@ tests withDebugging wdConfig caps _selenium = do
968651 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
969652 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
970653
971− describe "hydration/immediate" $ do
654+ describe "hydration/immediate" $ session' $ do
972655 it "captures user input after switchover" $ runWD $ do
973656 inputRef :: IORef Text <- newRef ""
974657 let checkValue = do
@@ -1014,7 +697,7 @@ tests withDebugging wdConfig caps _selenium = do
1014697 performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
1015698 performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
1016699
1017− session' "prerender" $ do
700+ describe "prerender" $ session' $ do
1018701 it "works in simple case" $ runWD $ do
1019702 testWidget (checkBodyText "One") (checkBodyText "Two") $ do
1020703 prerender_ (text "One") (text "Two")
@@ -1083,16 +766,7 @@ tests withDebugging wdConfig caps _selenium = do
1083766 prerender_ (pure ()) (liftIO $ trigger "Client")
1084767 textNode $ TextNodeConfig "Initial" $ Just e
1085768
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
769+ describe "runWithReplace" $ session' $ do
1096770 it "works" $ runWD $ do
1097771 replaceChan :: Chan Text <- liftIO newChan
1098772 let setup = findElemWithRetry $ WD.ByTag "div"
@@ -1236,61 +910,7 @@ tests withDebugging wdConfig caps _selenium = do
1236910 , el "span" . text <$> replace
1237911 ]
1238912
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
913+ describe "traverseDMapWithKeyWithAdjust" $ session' $ do
1294914 let widget :: DomBuilder t m => DKey a -> Identity a -> m (Identity a)
1295915 widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
1296916 elClass "span" "key" $ text $ textKey k
@@ -1393,7 +1013,7 @@ tests withDebugging wdConfig caps _selenium = do
13931013 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
13941014 liftIO $ dmap `H.shouldBe` keyMap
13951015
1396− session' "traverseIntMapWithKeyWithAdjust" $ do
1016+ describe "traverseIntMapWithKeyWithAdjust" $ session' $ do
13971017 let textKeyInt k = "key" <> T.pack (show k)
13981018 intMap = IntMap.fromList
13991019 [ (1, "one")
@@ -1500,7 +1120,7 @@ tests withDebugging wdConfig caps _selenium = do
15001120 (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
15011121 liftIO $ dmap `H.shouldBe` intMap
15021122
1503− session' "traverseDMapWithKeyWithAdjustWithMove" $ do
1123+ describe "traverseDMapWithKeyWithAdjustWithMove" $ session' $ do
15041124 let widget :: DomBuilder t m => Key2 a -> Identity a -> m (Identity a)
15051125 widget k (Identity v) = elAttr "li" ("id" =: textKey2 k) $ do
15061126 elClass "span" "key" $ text $ textKey2 k
@@ -1580,14 +1200,12 @@ tests withDebugging wdConfig caps _selenium = do
15801200 (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
15811201 liftIO $ assertEqual "DMap" initMap dmap
15821202
1583− session' "hydrating invalid HTML" $ do
1584− xit "can hydrate list in paragraph" $ runWD $ do
1203+ describe "hydrating invalid HTML" $ session' $ do
1204+ it "can hydrate list in paragraph" $ runWD $ do
15851205 let preSwitchover = do
15861206 checkBodyText "before\ninner\nafter"
15871207 -- Two <p> tags should be present
1588− (p1, p2) <- WD.findElems (WD.ByTag "p") >>= \case
1589− [p1, p2] -> pure (p1, p2)
1590− _ -> error "Unexpected number of `p` tags (expected 2)"
1208+ [p1, p2] <- WD.findElems (WD.ByTag "p")
15911209 ol <- findElemWithRetry (WD.ByTag "ol")
15921210 shouldContainText "before" p1
15931211 shouldContainText "inner" ol
@@ -1598,8 +1216,7 @@ tests withDebugging wdConfig caps _selenium = do
15981216 shouldContainText "before\ninner\nafter" p1
15991217 elementShouldBeRemoved ol
16001218 elementShouldBeRemoved p2
1601− -- Don't fail fatally when hydration encounters the invalid DOM
1602− testWidgetDebug' False withDebugging preSwitchover check $ do
1219+ testWidget' preSwitchover check $ do
16031220 -- This is deliberately invalid HTML, the browser will interpret it as
16041221 -- <p>before</p><ol>inner</ol>after<p></p>
16051222 el "p" $ do
@@ -1607,29 +1224,6 @@ tests withDebugging wdConfig caps _selenium = do
16071224 el "ol" $ text "inner"
16081225 text "after"
16091226
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−
16331227data Selenium = Selenium
16341228 { _selenium_portNumber :: PortNumber
16351229 , _selenium_stopServer :: IO ()
@@ -1697,9 +1291,6 @@ checkTextInId i expected = do
16971291findElemWithRetry :: Selector -> WD WD.Element
16981292findElemWithRetry = withRetry . WD.findElem
16991293
1700−findElemsWithRetry :: Selector -> WD [WD.Element]
1701−findElemsWithRetry = withRetry . WD.findElems
1702−
17031294getBody :: WD WD.Element
17041295getBody = WD.findElem $ WD.ByTag "body"
17051296
@@ -1708,8 +1299,8 @@ withRetry a = wait 300
17081299 where wait :: Int -> WD a
17091300 wait 0 = a
17101301 wait n = try a >>= \case
1711− Left (e :: SomeException) -> do
1712− liftIO $ putStrLn ("(retrying due to " <> show e <> ")") *> threadDelay 100000
1302+ Left (_ :: SomeException) -> do
1303+ liftIO $ threadDelay 100000
17131304 wait $ n - 1
17141305 Right v -> return v
17151306
@@ -1725,12 +1316,11 @@ testWidgetStaticDebug
17251316 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
17261317 -- ^ Widget we are testing
17271318 -> WD b
1728−testWidgetStaticDebug withDebugging w = testWidgetDebug True withDebugging (void w) w
1319+testWidgetStaticDebug withDebugging w = testWidgetDebug withDebugging (void w) w
17291320
17301321-- | TODO: do something about JSExceptions not causing tests to fail
17311322testWidgetDebug
17321323 :: Bool
1733− -> Bool
17341324 -> WD ()
17351325 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
17361326 -> WD b
@@ -1738,16 +1328,12 @@ testWidgetDebug
17381328 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
17391329 -- ^ Widget we are testing
17401330 -> 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
1331+testWidgetDebug withDebugging beforeJS afterSwitchover =
1332+ testWidgetDebug' withDebugging beforeJS (const afterSwitchover)
17461333
17471334-- | TODO: do something about JSExceptions not causing tests to fail
17481335testWidgetDebug'
17491336 :: Bool
1750− -> Bool
17511337 -> WD a
17521338 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
17531339 -> (a -> WD b)
@@ -1755,7 +1341,7 @@ testWidgetDebug'
17551341 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
17561342 -- ^ Widget we are testing (contents of body)
17571343 -> WD b
1758−testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget = do
1344+testWidgetDebug' withDebugging beforeJS afterSwitchover bodyWidget = do
17591345 let putStrLnDebug :: MonadIO m => Text -> m ()
17601346 putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
17611347 staticApp = do
@@ -1763,11 +1349,10 @@ testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget =
17631349 el "body" $ do
17641350 bodyWidget
17651351 el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
1766− putStrLnDebug "rendering static"
1767− ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
1768− putStrLnDebug "rendered static"
1352+ putStrLnDebug "rendering preSwitchover"
1353+ ((), html) <- liftIO $ renderStatic staticApp
1354+ putStrLnDebug "rendered preSwitchover"
17691355 waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
1770− onFailure <- if hardFailure then (`throwTo` HydrationFailedException) <$> liftIO myThreadId else pure $ pure ()
17711356 waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
17721357 let entryPoint = do
17731358 putStrLnDebug "taking waitBeforeJS"
@@ -1779,7 +1364,7 @@ testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget =
17791364 liftIO $ putMVar waitUntilSwitchover ()
17801365 putStrLnDebug "put waitUntilSwitchover"
17811366 putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
1782− mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchOverAction blank bodyWidget
1367+ mainHydrationWidgetWithSwitchoverAction switchOverAction blank bodyWidget
17831368 putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
17841369 syncPoint
17851370 application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
@@ -1797,26 +1382,23 @@ testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget =
17971382 ]
17981383 -- hSilence to get rid of ConnectionClosed logs
17991384 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)
1385+ jsaddleWarp = forkIO $ silenceIfDebug $ Warp.runSettings settings application
1386+ jsaddleTid <- liftIO jsaddleWarp
1387+ putStrLnDebug "taking waitJSaddle"
1388+ liftIO $ takeMVar waitJSaddle
1389+ putStrLnDebug "opening page"
1390+ WD.openPage $ "http://localhost:" <> show jsaddlePort
1391+ putStrLnDebug "running beforeJS"
1392+ a <- beforeJS
1393+ putStrLnDebug "putting waitBeforeJS"
1394+ liftIO $ putMVar waitBeforeJS ()
1395+ putStrLnDebug "taking waitUntilSwitchover"
1396+ liftIO $ takeMVar waitUntilSwitchover
1397+ putStrLnDebug "running afterSwitchover"
1398+ b <- afterSwitchover a
1399+ putStrLnDebug "killing jsaddle thread"
1400+ liftIO $ killThread jsaddleTid
1401+ return b
18201402
18211403data Key2 a where
18221404 Key2_Int :: Int -> Key2 Int