on develop help sign in
73 files changed+7345−1544
since splitsnapshots
unifiedsplit
.github/workflows/haskell.yml+47 CONTRIBUTING.md+65 FAQ.md+31 LICENSE+12 Quickref.md+7−55 README.md+15−9 cabal.project+10 cabal.project-nogtk+14 chrome-test-utils/LICENSE+12 chrome-test-utils/chrome-test-utils.cabal+30 chrome-test-utils/src/Test/Util/ChromeFlags.hs+17 chrome-test-utils/src/Test/Util/UnshareNetwork.hs+12 default.nix−6 dep/reflex-platform/default.nix+2 dep/reflex-platform/github.json+8 dep/reflex-platform/thunk.nix+9 reflex-dom-core/ChangeLog.md+94 reflex-dom-core/LICENSE+1−1 reflex-dom-core/default.nix−31 reflex-dom-core/reflex-dom-core.cabal+137−35 reflex-dom-core/src/Foreign/JavaScript/Orphans.hs+9−8 reflex-dom-core/src/Foreign/JavaScript/TH.hs+26−7 reflex-dom-core/src/Foreign/JavaScript/Utils.hs+32−1 reflex-dom-core/src/Reflex/Dom/Builder/Class.hs+146−47 reflex-dom-core/src/Reflex/Dom/Builder/Class/Events.hs+13−3 reflex-dom-core/src/Reflex/Dom/Builder/Hydratable.hs+116 reflex-dom-core/src/Reflex/Dom/Builder/Immediate.hs+1821−505 reflex-dom-core/src/Reflex/Dom/Builder/InputDisabled.hs+20−1 reflex-dom-core/src/Reflex/Dom/Builder/Static.hs+130−23 reflex-dom-core/src/Reflex/Dom/Class.hs+4−7 reflex-dom-core/src/Reflex/Dom/Core.hs+8−1 reflex-dom-core/src/Reflex/Dom/Location.hs+194−7 reflex-dom-core/src/Reflex/Dom/Main.hs+235−49 reflex-dom-core/src/Reflex/Dom/Modals/Class.hs+7 reflex-dom-core/src/Reflex/Dom/Old.hs+1−3 reflex-dom-core/src/Reflex/Dom/Prerender.hs+326 reflex-dom-core/src/Reflex/Dom/Time.hs+2−217 reflex-dom-core/src/Reflex/Dom/WebSocket.hs+42−11 reflex-dom-core/src/Reflex/Dom/WebSocket/Foreign.hs+45−27 reflex-dom-core/src/Reflex/Dom/WebSocket/Query.hs+37 reflex-dom-core/src/Reflex/Dom/Widget/Basic.hs+73−224 reflex-dom-core/src/Reflex/Dom/Widget/Input.hs+22−53 reflex-dom-core/src/Reflex/Dom/Widget/Lazy.hs+7−5 reflex-dom-core/src/Reflex/Dom/Widget/Resize.hs+10−6 reflex-dom-core/src/Reflex/Dom/Xhr.hs+10−8 reflex-dom-core/src/Reflex/Dom/Xhr/Foreign.hs+2−3 reflex-dom-core/src/Reflex/Dom/Xhr/FormData.hs+47 reflex-dom-core/test/gc.hs+51−13 reflex-dom-core/test/hlint.hs+5−1 reflex-dom-core/test/hydration.hs+1828 reflex-dom-test-selenium/CHANGELOG.md+5 reflex-dom-test-selenium/LICENSE+12 reflex-dom-test-selenium/Setup.hs+2 reflex-dom-test-selenium/add-overrides.nix+20 reflex-dom-test-selenium/reflex-dom-test-selenium.cabal+41 reflex-dom-test-selenium/src/Reflex/Dom/Test/Selenium.hs+249 reflex-dom/ChangeLog.md+42 reflex-dom/LICENSE+1−1 reflex-dom/benchmark.hs+190 reflex-dom/benchmarks/krausest.hs+222 reflex-dom/cbits/MainWidget.c+89 reflex-dom/cbits/include/MainWidget.h+13 reflex-dom/default.nix−18 reflex-dom/examples/sortableList.hs+1−1 reflex-dom/java/org/reflexfrp/reflexdom/MainWidget.java+195 reflex-dom/reflex-dom.cabal+124−22 reflex-dom/src-android/Reflex/Dom/Android/MainWidget.hsc+117 reflex-dom/src/Reflex/Dom.hs+6−1 reflex-dom/src/Reflex/Dom/Internal.hs+79−7 release.nix+63 test/default.nix+10 test/prebuild.hs−127 test/reflex-dom-reexports.hs+72
.github/workflows/haskell.ymlnew file+47
@@ -0,0 +1,47 @@
1+name: github-action
2+
3+on: [push, pull_request]
4+
5+jobs:
6+ build:
7+ strategy:
8+ matrix:
9+ ghc: ['8.4.4', '8.6.5', '8.8.4', '8.10.2']
10+ os: ['ubuntu-latest', 'macos-latest']
11+ exclude:
12+ # There are some linker warnings in 802 on darwin that
13+ # cause compilation to fail
14+ # See https://github.com/NixOS/nixpkgs/issues/25139
15+ - ghc: '8.0.2'
16+ os: 'macos-latest'
17+ runs-on: ${{ matrix.os }}
18+
19+ name: GHC ${{ matrix.ghc }} on ${{ matrix.os }}
20+ steps:
21+ - uses: actions/checkout@v2
22+ - uses: actions/setup-haskell@v1
23+ with:
24+ ghc-version: ${{ matrix.ghc }}
25+ - name: Cache
26+ uses: actions/cache@v1
27+ env:
28+ cache-name: cache-cabal
29+ with:
30+ path: ~/.cabal
31+ key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('**/*.cabal') }}-${{ hashFiles('**/cabal.project') }}
32+ restore-keys: |
33+ ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
34+ ${{ runner.os }}-${{ matrix.ghc }}-build-
35+ ${{ runner.os }}-${{ matrix.ghc }}-
36+ ${{ runner.os }}
37+
38+ - name: Set up cabal project file to avoid webkit2gtk
39+ run: cp cabal.project-nogtk cabal.project
40+ - name: Install dependencies
41+ run: |
42+ cabal update
43+ cabal build --only-dependencies --enable-tests --enable-benchmarks all
44+ - name: Build
45+ run: cabal build --enable-tests --enable-benchmarks all
46+ - name: Run tests
47+ run: cabal test all
CONTRIBUTING.mdnew file+65
@@ -0,0 +1,65 @@
1+# Contribution Guide
2+
3+Contributions and issue reports are encouraged and appreciated!
4+
5+- [Opening Issues](#opening-issues)
6+- [Submitting Changes](#submitting-changes)
7+ - [Guidelines for Commit Messages](#guidelines-for-commit-messages)
8+ - [Guidelines for Pull Requests](#guidelines-for-pull-requests)
9+ - [Code Quality](#code-quality)
10+ - [Documentation](#documentation)
11+
12+## Opening Issues
13+
14+Before opening an issue, please check whether your issue has already been reported. Assuming it has not:
15+
16+* Describe the issue you're encountering or the suggestion you're making
17+* Include any relevant steps to reproduce or code samples you can. It's always easier for us to debug if we have something that demonstrates the error.
18+* Let us know what version of this project you were using. If you're using a github checkout, provide the git hash.
19+* Describe how you're building this project (i.e., via reflex-platform, cabal install, stack, obelisk, etc.). If you're using reflex-platform or obelisk, provide the git hash of your checkout.
20+
21+## Submitting Changes
22+
23+### Guidelines for Commit Messages
24+
25+#### Summary Line
26+The summary line of your commit message should summarize the changes being made. Commit messages should be written in the imperative mood and should describe what happens when the commit is applied.
27+
28+One way to think about it is that your commit message should be able to complete the sentence:
29+"When applied, this commit will..."
30+
31+#### Body
32+For breaking changes, new features, refactors, or other major changes, the body of the commit message should describe the motivation behind the change in greater detail and may include references to the issue tracker. The body shouldn't repeat code/comments from the diff.
33+
34+### Guidelines for Pull Requests
35+
36+Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.
37+
38+### Code Quality
39+
40+#### Warnings
41+
42+Your pull request should add no new warnings to the project. It should also generally not disable any warnings.
43+
44+#### Build and Test
45+
46+Make sure the project builds and that the tests pass! This will generally also be checked by CI before merge, but trying it yourself first means you'll catch problems earlier and your contribution can be merged that much sooner!
47+
48+### Documentation
49+
50+#### In the code
51+We're always striving to improve documentation. Please include [haddock](https://haskell-haddock.readthedocs.io/en/latest/index.html) documentation for any added code, and update the documentation for any code you modify.
52+
53+#### In the Changelog
54+Add an entry to the changelog when your PR:
55+* Adds a feature
56+* Deprecates something
57+* Includes a breaking change
58+* Makes any other change that will impact users
59+
60+You may need to add changelog entries to one or both of the changelogs in this repository:
61+* [reflex-dom-core's changelog](reflex-dom-core/ChangeLog.md)
62+* [reflex-dom's changelog](reflex-dom/ChangeLog.md)
63+
64+#### In the [Readme](README.md)
65+The readme is the first place a lot of people look for information about the repository. Update any parts of the readme that are affected by your PR.
FAQ.mdnew file+31
@@ -0,0 +1,31 @@
1+# Frequently Asked Questions
2+
3+### How do I configure DOM events with flags like `preventDefault` and `stopPropagation`?
4+
5+Using `element`, a low-level DOM builder function. Its second argument, `ElementConfig`, has a `_elementConfig_eventSpec` field that can be modified using `addEventSpecFlags`. It takes a `Proxy` that specifies the `DomSpace`, an event name, and a callback which takes the event result and returns an event flag, which can enable behavior like `preventDefault` and `stopPropagation`.
6+
7+The type signature on `def` is needed because the fields of the `ElementConfig` can change the type of the `ElementConfig`. GHC can probably figure out the type of the resulting `ElementConfig`, but it doesn't know what the type of `def` was before the modifications, since it never gets used with that configuration.
8+
9+For example:
10+
11+```haskell
12+{-# LANGUAGE OverloadedStrings #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
14+
15+import Control.Lens ((&), (%~), (.~))
16+import Data.Proxy
17+import Reflex.Dom
18+
19+main :: IO ()
20+main = mainWidget $ do
21+ (click, ()) <- linkPreventDefault $ text "reflex-frp"
22+ display =<< count click
23+
24+linkPreventDefault :: forall t m a. DomBuilder t m => m a -> m (Event t (), a)
25+linkPreventDefault c = do
26+ let cfg = (def :: ElementConfig EventResult t (DomBuilderSpace m))
27+ & elementConfig_initialAttributes .~ ("href" =: "https://reflex-frp.org")
28+ & elementConfig_eventSpec %~ addEventSpecFlags (Proxy :: Proxy (DomBuilderSpace m)) Click (const preventDefault)
29+ (link, a) <- element "a" cfg c
30+ return (domEvent Click link, a)
31+```
LICENSEnew file+12
@@ -0,0 +1,12 @@
1+Copyright (c) 2020, Obsidian Systems LLC
2+All rights reserved.
3+
4+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
8+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
9+
10+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11+
12+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Quickref.md+7−55
@@ -28,7 +28,7 @@ Widgets may return any type (this is 'a' in many of the functions below). Often
2828-- This version returns the 'El' as well.
2929[W] el' :: Text -> m a -> m (El, a)
3030
31−-- These two additionally apply attributes to the element, such as ("class" =: "blah")
31+-- These two additionally apply attributes to the element, such as ("class" =: "blah"). (=:) is 'Map.singleton'
3232[W] elAttr :: Text -> Map Text Text -> m a -> m a
3333[W] elAttr' :: Text -> Map Text Text -> m a -> m (El, a)
3434
@@ -45,7 +45,7 @@ Widgets may return any type (this is 'a' in many of the functions below). Often
4545-- Even shorter-cut for above when element type is "div". Create a div of given class.
4646[W] divClass :: Text -> m a -> m a
4747
48−-- Create a widget of given type with arbitrary, Dymamic HTML inside.
48+-- Create a widget of given type with arbitrary, Dynamic HTML inside.
4949[W] elDynHtml' :: Text -> Dynamic Text -> m El
5050[W] elDynHtmlAttr' :: Text -> Map Text Text -> Dynamic Text -> m El
5151
@@ -75,32 +75,10 @@ Note the "list" functions do not imply particular HTML tags (ul, li, etc), thoug
7575
7676-- Same as dyn, but takes initial value and an update Event instead of a Dynamic.
7777[W] widgetHold :: m a -> Event (m a) -> m (Dynamic a)
78−
79−-- Turn a Dynamic key/value map into a set of dynamically-changing widgets.
80−[W] listWithKey :: Ord k =>
81− Dynamic (Map k v) -> (k -> Dynamic v -> m a ) -> m (Dynamic (Map k a))
82−
83−-- Same as above where the widget constructor doesn't care about the key.
84−[W] list :: Ord k =>
85− Dynamic (Map k v) -> ( Dynamic v -> m a ) -> m (Dynamic (Map k a))
86−
87−-- Even simpler version where there are no keys and we just use a list.
88−[W] simpleList ::
89− Dynamic [v] -> ( Dynamic v -> m a ) -> m (Dynamic [a])
90−
91−-- Like listWithKey specialized for widgets returning (Event a).
92−[W] listViewWithKey :: Ord k =>
93− Dynamic (Map k v) -> (k -> Dynamic v -> m (Event a)) -> m (Event (Map k a))
94−
95−-- Create a dynamically-changing set of widgets, one of which is selected at any time.
96−[W] selectViewListWithKey_ :: Ord k => Dynamic k ->
97− Dynamic (Map k v) -> (k -> Dynamic v -> Dynamic Bool -> m (Event a)) -> m (Event k)
98−
99−-- Same as listWithKey, but takes initial values and an updates Event instead of a Dynamic.
100−[W] listWithKey' :: Ord k =>
101− Map k v -> Event (Map k (Maybe v)) -> (k -> v -> Event v -> m a) -> m (Dynamic (Map k a))
10278```
10379
80+Also see the "Collection management functions" section in the `reflex` Quick Reference.
81+
10482### Utility widgets
10583
10684These are useful widgets that are implemented (or could be implemented) in terms of the low-level widgets above.
@@ -135,27 +113,12 @@ Some of these widget builders take a configuration record and return a record co
135113
136114## Connecting to the real world (I/O)
137115
138−### Connecting to DOM events
139−
140116```haskell
141117-- Extract the specified Event from an 'El'. See Reflex.Dom.Widget.Basic
142118[ ] domEvent :: EventName en -> El -> Event (EventResultType en)
143119```
144120
145−### Performing arbitrary I/O in response to Events
146−
147−```haskell
148−-- Run side-effecting actions in Event when it occurs; returned Event contains
149−-- results. Side effects run in (WidgetHost m) monad, which includes [S] and [H]
150−-- and can also do I/O via liftIO
151−[W] performEvent :: Event ( WidgetHost m a) -> m (Event a)
152−
153−-- Just run side-effects; no return Event
154−[W] performEvent_ :: Event ( WidgetHost m ()) -> m ()
155−
156−-- Actions run asynchronously; actions are given a callback to send return values
157−[W] performEventAsync :: Event ((a -> IO ()) -> WidgetHost m ()) -> m (Event a)
158−```
121+Also see the "Connection to the real world" and "Time" sections in the `reflex` Quick Reference.
159122
160123### XMLHttpRequest
161124
@@ -178,16 +141,6 @@ Convenience functions for XMLHttpRequest. see Reflex.Dom.Xhr
178141[W] getAndDecode :: FromJSON a => Event Text -> m (Event (Maybe a))
179142```
180143
181−### Time
182−
183−```haskell
184−-- Create Event at given interval with given basis time.
185−[W] tickLossy :: NominalDiffTime -> UTCTime -> m (Event t TickInfo)
186−
187−-- Delay an Event's occurrences by a given amount in seconds.
188−[W] delay :: NominalDiffTime -> Event t a -> m (Event t a)
189−```
190−
191144## Startup
192145
193146```haskell
@@ -201,7 +154,6 @@ Convenience functions for XMLHttpRequest. see Reflex.Dom.Xhr
201154[I] mainWidgetWithCss ::
202155 ByteString ->
203156 Widget Spider (Gui Spider (WithWebView SpiderHost) (HostFrame Spider)) () -> IO ()
204−
205−-- One-shot Event that is triggered once all initial widgets are built
206−[W] getPostBuild :: m (Event ())
207157```
158+
159+Also see the corresponding section in the `reflex` Quick Reference.
README.md+15−9
@@ -1,17 +1,23 @@
1−## Reflex-DOM
2−### A Framework for Functional Reactive Web Apps in Haskell
1+## [Reflex-DOM](https://reflex-frp.org)
32
4−Reflex-DOM is a framework for building web applications in Haskell, based on the [Functional Reactive Programming](https://wiki.haskell.org/Functional_Reactive_Programming) library [Reflex](https://github.com/reflex-frp/reflex).
3+[![Haskell](https://img.shields.io/badge/language-Haskell-orange.svg)](https://haskell.org) [![Hackage](https://img.shields.io/hackage/v/reflex-dom.svg)](https://hackage.haskell.org/package/reflex-dom) [![Hackage CI](https://matrix.hackage.haskell.org/api/v2/packages/reflex-dom/badge)](https://matrix.hackage.haskell.org/#/package/reflex-dom) [![BSD3 License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://github.com/reflex-frp/reflex-dom/blob/master/LICENSE)
54
6−Comprehensive documentation is still a work in progress, but a [demo](https://github.com/reflex-frp/reflex-platform) is available and an introductory talk is available at [Part 1](https://www.youtube.com/watch?v=mYvkcskJbc4) / [Part 2](https://www.youtube.com/watch?v=3qfc9XFVo2c) ([Slides](https://obsidian.systems/reflex-nyhug/)).
5+Web applications without callbacks or side-effects. Reflex-DOM brings the power of [Functional Reactive Programming (FRP)](https://wiki.haskell.org/Functional_Reactive_Programming) to the web. Build [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) and other [Document Object Model (DOM)](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model) data with a pure functional interface.
76
8−A summary of Reflex-DOM functions is available in the [quick reference](Quickref.md).
7+Reflex-DOM is a framework for building web applications in [Haskell](https://www.haskell.org/), based on the [Functional Reactive Programming](https://wiki.haskell.org/Functional_Reactive_Programming) library [Reflex](https://github.com/reflex-frp/reflex).
8+
9+**Visit https://reflex-frp.org/ for more information, tutorials, documentation and [examples](https://examples.reflex-frp.org/).**
910
1011### Additional resources
11−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
1212
13−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
13+* [Official Website](https://reflex-frp.org/)
14+* [Quick Reference](Quickref.md)
15+* [Obelisk](https://github.com/obsidiansystems/obelisk#obelisk): A framework built on Reflex and Reflex-DOM for functional reactive web and mobile applications, with batteries included.
16+* [Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
17+* [/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
18+* [irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
1419
15−[hackage](https://hackage.haskell.org/package/reflex)
20+### Hacking
1621
17−[irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
22+Use the `./scripts/hack-on haskell-overlays/reflex-packages/dep/reflex-dom` script in [Reflex Platform](https://github.com/reflex-frp/reflex-platform) to checkout the source code of `reflex-dom` locally in `./dep/reflex-dom` directory.
23+Then do modifications to the source in place, and use the `./try-reflex` or `./scripts/work-on` scripts to create the shell to test your changes.
cabal.projectnew file+10
@@ -0,0 +1,10 @@
1+packages:
2+ reflex-dom-core/
3+ reflex-dom/
4+ chrome-test-utils/
5+ reflex-dom-test-selenium/
6+
7+source-repository-package
8+ type: git
9+ location: https://github.com/dfordivam/hspec-webdriver-clone
10+ tag: 0d748b7bb7cd74dce0a55a1ec86b01dbb8a71cd8
cabal.project-nogtknew file+14
@@ -0,0 +1,14 @@
1+packages:
2+ reflex-dom-core/
3+ reflex-dom/
4+
5+package reflex-dom-core
6+ flags: -hydration-tests -gc-tests
7+
8+package reflex-dom
9+ flags: +use-warp -webkit2gtk
10+
11+source-repository-package
12+ type: git
13+ location: https://github.com/dfordivam/hspec-webdriver-clone
14+ tag: 0d748b7bb7cd74dce0a55a1ec86b01dbb8a71cd8
chrome-test-utils/LICENSEnew file+12
@@ -0,0 +1,12 @@
1+Copyright (c) 2020, Obsidian Systems LLC
2+All rights reserved.
3+
4+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
8+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
9+
10+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11+
12+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
chrome-test-utils/chrome-test-utils.cabalnew file+30
@@ -0,0 +1,30 @@
1+Name: chrome-test-utils
2+Version: 0.5
3+Synopsis: Utilities to write headless Chromium tests
4+License: BSD3
5+License-file: LICENSE
6+Author: Obsidian Systems LLC
7+Maintainer: maintainer@obsidian.systems
8+Stability: Experimental
9+Build-type: Simple
10+Cabal-version: >=1.9.2
11+
12+library
13+ hs-source-dirs: src
14+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
15+ build-depends: base
16+ , linux-namespaces
17+ , process
18+ , temporary
19+ , text
20+ , unix
21+ exposed-modules:
22+ Test.Util.UnshareNetwork
23+ Test.Util.ChromeFlags
24+ if !os(linux) || !arch(x86_64)
25+ buildable: False
26+
27+source-repository head
28+ type: git
29+ location: https://github.com/reflex-frp/reflex-dom
30+ subdir: chrome-test-utils
chrome-test-utils/src/Test/Util/ChromeFlags.hsnew file+17
@@ -0,0 +1,17 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Test.Util.ChromeFlags where
3+
4+import Data.Semigroup
5+import Data.Text
6+import System.IO.Temp
7+
8+withSandboxedChromeFlags :: Bool -> ([Text] -> IO a) -> IO a
9+withSandboxedChromeFlags headless action =
10+ withSystemTempDirectory "reflex-dom-core_test" $ \tmp ->
11+ action
12+ [ if headless then "--headless" else "--auto-open-devtools-for-tabs"
13+ , "--disable-gpu"
14+ , "--no-sandbox"
15+ , "--remote-debugging-port=9222"
16+ , "--user-data-dir=" <> pack tmp
17+ ]
chrome-test-utils/src/Test/Util/UnshareNetwork.hsnew file+12
@@ -0,0 +1,12 @@
1+module Test.Util.UnshareNetwork where
2+
3+import System.Linux.Namespaces
4+import System.Posix
5+import System.Process
6+
7+unshareNetwork :: IO ()
8+unshareNetwork = do
9+ uid <- getEffectiveUserID
10+ unshare [User, Network]
11+ writeUserMappings Nothing [UserMapping 0 uid 1]
12+ callCommand "ip link set lo up ; ip addr"
default.nixdeleted−6
@@ -1,6 +0,0 @@
1−haskellPackages: nixpkgs: {
2− reflex-dom = haskellPackages.callPackage ./reflex-dom {};
3− reflex-dom-core = haskellPackages.callPackage ./reflex-dom-core {
4− inherit (nixpkgs) xvfb_run chromium;
5− };
6−}
dep/reflex-platform/default.nixnew file+2
@@ -0,0 +1,2 @@
1+# DO NOT HAND-EDIT THIS FILE
2+import (import ./thunk.nix)
dep/reflex-platform/github.jsonnew file+8
@@ -0,0 +1,8 @@
1+{
2+ "owner": "reflex-frp",
3+ "repo": "reflex-platform",
4+ "branch": "aa-bump-some",
5+ "private": false,
6+ "rev": "fd5acecb50474f795734db9fb924cc3b2fd2b508",
7+ "sha256": "0wsdd67g42klsf9n3pxb3pndjdz36nzf8gp7pfm8j6nyyy2qribk"
8+}
dep/reflex-platform/thunk.nixnew file+9
@@ -0,0 +1,9 @@
1+# DO NOT HAND-EDIT THIS FILE
2+let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3+ if !fetchSubmodules && !private then builtins.fetchTarball {
4+ url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5+ } else (import <nixpkgs> {}).fetchFromGitHub {
6+ inherit owner repo rev sha256 fetchSubmodules private;
7+ };
8+ json = builtins.fromJSON (builtins.readFile ./github.json);
9+in fetch json
reflex-dom-core/ChangeLog.mdnew file+94
@@ -0,0 +1,94 @@
1+# Revision history for reflex-dom-core
2+
3+## 0.6.2.1
4+
5+* Fix hlint complaints with newer GHC.
6+
7+## 0.6.2.0
8+
9+* ([#400](https://github.com/reflex-frp/reflex-dom/pull/400/files)) Set value of input elements in static renderer
10+
11+## 0.6.1.0
12+
13+* Bump version bounds
14+* Update for new dependent-map and dependent-sum version (after the "some" package split)
15+* Add `MonadAtomicRef` instance for `UnrunnableT`
16+* Fix ([#467](https://github.com/reflex-frp/reflex-dom/issues/467)): Prevent multiple firings of XHR response event
17+* Updates for GHC 8.10
18+* Move `HasSetValue` from Reflex.Dom.Widget.Input to Reflex.Dom.Builder.Class and add an instance for `TextAreaElementConfig`
19+* Add `now` to the `MonadHold` instance for `UnrunnableT`
20+
21+
22+## 0.6.0.0
23+
24+* ([#375](https://github.com/reflex-frp/reflex-dom/pull/375)) **(Breaking change)** Expose resized dimensions from `resizeDetector`, `resizeDetectorWithStyle`, and `resizeDetectorWithAttrs` from `Reflex.Dom.Widget.Resize`.
25+* ([#374](https://github.com/reflex-frp/reflex-dom/pull/374)) **(Breaking change)** Provide text clipboard data as value of `Paste` event.
26+* ([#348](https://github.com/reflex-frp/reflex-dom/pull/348)) **(Breaking change)** Make XHR response headers case insensitive by changing `_xhrResponse_headers :: Map Text Text` to `_xhrResponse_headers :: Map (CI Text) Text`.
27+* ([#225](https://github.com/reflex-frp/reflex-dom/pull/225)) **(Breaking change)** Add a functional dependency to `HasDomEvent`.
28+* ([#342](https://github.com/reflex-frp/reflex-dom/issues/342)) **(Breaking change)** The mouse wheel event is now a `WheelEventResult` rather than `()`. This provides information about the wheel's motion beyond the fact that it merely moved.
29+* ([#353](https://github.com/reflex-frp/reflex-dom/pull/353)) Support GHC 8.8.
30+* ([#358](https://github.com/reflex-frp/reflex-dom/pull/358)) Fix attribute support for explicitly namespaced elements.
31+* ([#363](https://github.com/reflex-frp/reflex-dom/pull/363)) Remove deprecation warnings for the following widgets in
32+ `Reflex.Dom.Widget.Basic`:
33+ * `Link`
34+ * `button`
35+ * `dtdd`
36+ * `linkClass`
37+ * `link`
38+ * `tabDisplay`
39+ * `tableDynAttr`
40+* ([#361](https://github.com/reflex-frp/reflex-dom/pull/361)) Fix bug in hydration causing the JavaScript to crash when dealing with unexpected HTML.
41+* ([#310](https://github.com/reflex-frp/reflex-dom/issues/310)) Fix the static rendering of which dropdown value is selected.
42+* ([#364](https://github.com/reflex-frp/reflex-dom/pull/364)) Export attributes used for controlling hydration at the element level:
43+ * "data-ssr" is now available as `Reflex.Dom.Builder.Immediate.hydratableAttribute`.
44+ * "data-hydration-skip" is now available as `Reflex.Dom.Builder.Immediate.skipHydrationAttribute`.
45+* ([#366](https://github.com/reflex-frp/reflex-dom/pull/366)) Bump bounds for `reflex` to include 0.7.
46+
47+## 0.5.3
48+
49+* Deprecate a number of old inflexible widget helpers in `Reflex.Dom.Widget.Basic`:
50+ * `Link`
51+ * `button`
52+ * `dtdd`
53+ * `linkClass`
54+ * `link`
55+ * `tabDisplay`
56+ * `tableDynAttr`
57+
58+ And in `Reflex.Dom.Widget.Input`:
59+ * `TextInput`
60+ * `TextAreaConfig`
61+ * `CheckboxConfig`
62+ * `FileInput`
63+* Add `< 0.7` upper bound for `reflex`.
64+
65+## 0.5.2
66+
67+* Update to use new dependent-sum/map packages and drop dependency on `*Tag` classes (e.g., `ShowTag`).
68+
69+* Update version bounds of base, containers, and stm
70+
71+* Update to use the newly split `these`/`semialign` packages. To use the pre-split `these` package, set the `split-these` flag to false.
72+
73+* Reintroduce "data-ssr": elements without this attribute are skipped during
74+ hydration.
75+
76+* Fix an issue in the hydration tests that prevented the test from finding the chromium executable
77+
78+* Relax constraints on `dyn` and `widgetHold` to match the ones in `networkView` and `networkHold` respectively
79+
80+* Fix prerender for RequesterT so that it doesn't accidentally discard a request that is made at the same moment as getPostBuild's Event fires
81+
82+## 0.5.1
83+
84+* Added support for marking elements with a "data-skip-hydration" attribute, which will cause hydration to ignore and skip over them.
85+
86+* Removed "data-ssr" attributes from statically rendered output.
87+
88+## 0.5
89+
90+* Add HydrationDomBuilderT to support hydration of statically rendered DOM nodes. See the note at the top of Reflex.Dom.Builder.Immediate.
91+
92+* As a result of the hydration changes, the Prerender class has changed, the type of `prerender` has changed and it is now a class method.
93+
94+* Add the Reflex.Dom.Xhr.FormData module to make posting formdata over xhr more convenient.
reflex-dom-core/LICENSE+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2015, Obsidian Systems LLC
1+Copyright (c) 2020, Obsidian Systems LLC
22All rights reserved.
33
44Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
reflex-dom-core/default.nixdeleted−31
@@ -1,31 +0,0 @@
1−{ mkDerivation, ghc, aeson, base, bifunctors, bimap, blaze-builder
2−, bytestring, containers, contravariant, data-default
3−, dependent-map, dependent-sum, dependent-sum-template, directory
4−, exception-transformers, ghcjs-dom, hlint, jsaddle, keycode, lens
5−, monad-control, mtl, primitive, random, ref-tf, reflex, semigroups
6−, stdenv, stm, template-haskell, temporary, text, these, time
7−, transformers, unbounded-delays, unix, zenc, hashable, xvfb_run
8−, chromium, process, jsaddle-warp
9−}:
10−let addGcTestDepends = drv: if stdenv.system != "x86_64-linux" then drv else drv // {
11− testHaskellDepends = (drv.testHaskellDepends or []) ++ [ temporary jsaddle-warp process ];
12− testSystemDepends = (drv.testSystemDepends or []) ++ [ xvfb_run chromium ];
13− };
14−in mkDerivation (addGcTestDepends {
15− pname = "reflex-dom-core";
16− version = "0.4";
17− src = ./.;
18− libraryHaskellDepends = [
19− aeson base bifunctors bimap blaze-builder bytestring containers
20− contravariant data-default dependent-map dependent-sum
21− dependent-sum-template directory exception-transformers ghcjs-dom
22− jsaddle keycode lens monad-control mtl primitive random ref-tf
23− reflex semigroups stm template-haskell text these time transformers
24− unbounded-delays unix zenc
25− ] ++ (if ghc.isGhcjs or false then [
26− hashable
27− ] else []);
28− testHaskellDepends = [ base hlint ];
29− description = "Functional Reactive Web Apps with Reflex";
30− license = stdenv.lib.licenses.bsd3;
31−})
reflex-dom-core/reflex-dom-core.cabal+137−35
@@ -1,7 +1,18 @@
1+cabal-version: 1.24
12Name: reflex-dom-core
2−Version: 0.4
3+Version: 0.6.2.1
34Synopsis: Functional Reactive Web Apps with Reflex
4−Description: Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine
5+Description:
6+ Web applications without callbacks or side-effects.
7+ Reflex-DOM brings the power of functional reactive programming (FRP) to the web.
8+ Build HTML and other Document Object Model (DOM) data with a pure functional interface.
9+ .
10+ Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine: <https://reflex-frp.org/>.
11+ .
12+ The @reflex-dom@ package is a small wrapper around the @reflex-dom-core@ package. It pulls in the
13+ correct set of dependencies for each target platform (GHCJS, WebKitGTK, WASM, mobile, etc.).
14+ Libraries should depend on @reflex-dom-core@ and executables will usually depend on @reflex-dom@.
15+ All of @reflex-dom-core@'s modules are re-exported by @reflex-dom@.
516License: BSD3
617License-file: LICENSE
718Author: Ryan Trinkle
@@ -9,7 +20,6 @@ Maintainer: ryan.trinkle@gmail.com
920Stability: Experimental
1021Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
1122Build-type: Simple
12−Cabal-version: >=1.9.2
1323-- Deal with https://github.com/haskell/cabal/issues/2544 / https://github.com/haskell/cabal/issues/367
1424extra-source-files: src-ghc/Foreign/JavaScript/Internal/Utils.hs
1525 src-ghcjs/Foreign/JavaScript/Internal/Utils.hs
@@ -17,6 +27,7 @@ extra-source-files: src-ghc/Foreign/JavaScript/Internal/Utils.hs
1727 src/Reflex/Dom/WebSocket/Foreign.hs
1828 src/Reflex/Dom/Xhr/ResponseType.hs
1929 src/Reflex/Dom/Xhr/Exception.hs
30+ ChangeLog.md
2031
2132flag use-template-haskell
2233 description: Use template haskell to generate lenses
@@ -33,53 +44,81 @@ flag expose-all-unfoldings
3344 default: False
3445 manual: True
3546
47+flag profile-reflex
48+ description: Add a layer of profiling to all Reflex events in the system
49+ default: False
50+ manual: True
51+
52+flag split-these
53+ description: Use split these/semialign packages
54+ manual: False
55+ default: True
56+
57+flag hydration-tests
58+ description: Whether to run the hydration tests (currently only available on linux)
59+ default: True
60+ manual: True
61+
62+flag gc-tests
63+ description: Whether to run the gc tests (currently only available on linux)
64+ default: True
65+ manual: True
66+
3667library
3768 hs-source-dirs: src
3869 build-depends:
39− aeson >= 0.8 && < 1.3,
40− base >= 4.7 && < 4.11,
70+ aeson >= 0.8 && < 1.6,
71+ base >= 4.7 && < 4.15,
4172 bifunctors >= 4.2 && < 6,
42− bimap >= 0.3 && < 0.4,
43− blaze-builder,
73+ bimap >= 0.3 && < 0.5,
74+ blaze-builder >= 0.4.1 && < 0.5,
4475 bytestring == 0.10.*,
45− containers == 0.5.*,
46− contravariant >= 1.4 && < 1.5,
76+ case-insensitive < 1.3,
77+ containers >= 0.6 && < 0.7,
78+ constraints >= 0.9 && < 0.13,
79+ contravariant >= 1.4 && < 1.6,
4780 data-default >= 0.5 && < 0.8,
48− dependent-map == 0.2.*,
49− dependent-sum >= 0.3 && < 0.5,
50− dependent-sum-template >= 0.0.0.4 && < 0.1,
81+ dependent-map >= 0.3 && < 0.5,
82+ dependent-sum >= 0.6 && < 0.8,
83+ dependent-sum-template >= 0.1 && < 0.2,
5184 directory >= 1.2 && < 1.4,
5285 exception-transformers == 0.4.*,
53− ghcjs-dom >= 0.9.0.0 && < 0.10,
54− jsaddle >=0.9.0.0 && <0.10,
86+ ghcjs-dom >= 0.9.1.0 && < 0.10,
87+ jsaddle >= 0.9.0.0 && < 0.10,
5588 -- keycode-0.2 has a bug on firefox
5689 keycode >= 0.2.1 && < 0.3,
5790 lens >= 4.7 && < 5,
5891 monad-control >= 1.0.1 && < 1.1,
5992 mtl >= 2.1 && < 2.3,
60− primitive >= 0.5 && < 0.7,
61− random == 1.1.*,
93+ primitive >= 0.5 && < 0.8,
94+ random >= 1.1 && < 1.2,
6295 ref-tf == 0.4.*,
63− reflex == 0.5.*,
64− semigroups >= 0.16 && < 0.19,
65− stm == 2.4.*,
96+ reflex >= 0.8 && < 0.9,
97+ semigroups >= 0.16 && < 0.20,
98+ stm >= 2.4 && < 2.6,
6699 text == 1.2.*,
67− these >= 0.4 && < 0.8,
68− time >= 1.4 && < 1.8,
69100 transformers >= 0.3 && < 0.6,
70− unbounded-delays >= 0.1.0.9 && < 0.2,
101+ network-uri >= 2.6.1 && < 2.7,
71102 zenc == 0.1.*
72103
73104 if impl(ghcjs)
74105 hs-source-dirs: src-ghcjs
75106 build-depends:
76107 ghcjs-base,
77− hashable == 1.2.*
108+ hashable >= 1.2 && < 1.4
78109 else
79110 hs-source-dirs: src-ghc
80111 if !os(windows)
81112 build-depends: unix == 2.7.*
82113
114+ if flag(split-these)
115+ build-depends:
116+ semialign >= 1 && < 1.2,
117+ these >= 1 && < 1.2
118+ else
119+ build-depends:
120+ these >= 0.4 && < 0.9
121+
83122 exposed-modules:
84123 Foreign.JavaScript.TH
85124 Foreign.JavaScript.Orphans
@@ -88,20 +127,25 @@ library
88127 Reflex.Dom.Builder.Class.Events
89128 Reflex.Dom.Builder.Immediate
90129 Reflex.Dom.Builder.InputDisabled
130+ Reflex.Dom.Builder.Hydratable
91131 Reflex.Dom.Builder.Static
92132 Reflex.Dom.Class
93133 Reflex.Dom.Core
94134 Reflex.Dom.Location
95135 Reflex.Dom.Main
136+ Reflex.Dom.Modals.Class
96137 Reflex.Dom.Old
138+ Reflex.Dom.Prerender
97139 Reflex.Dom.Time
98140 Reflex.Dom.WebSocket
141+ Reflex.Dom.WebSocket.Query
99142 Reflex.Dom.Widget
100143 Reflex.Dom.Widget.Basic
101144 Reflex.Dom.Widget.Input
102145 Reflex.Dom.Widget.Lazy
103146 Reflex.Dom.Widget.Resize
104147 Reflex.Dom.Xhr
148+ Reflex.Dom.Xhr.FormData
105149 other-modules:
106150 Foreign.JavaScript.Internal.Utils
107151 Reflex.Dom.WebSocket.Foreign
@@ -109,7 +153,8 @@ library
109153 Reflex.Dom.Xhr.ResponseType
110154 Reflex.Dom.Xhr.Exception
111155
112− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
156+ default-language: Haskell98
157+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
113158 ghc-prof-options: -fprof-auto
114159
115160 if flag(expose-all-unfoldings)
@@ -118,37 +163,94 @@ library
118163 if flag(use-reflex-optimizer)
119164 ghc-options: -fplugin=Reflex.Optimizer
120165
166+ if flag(profile-reflex)
167+ cpp-options: -DPROFILE_REFLEX
168+
121169 if flag(use-template-haskell)
122170 build-depends:
123− dependent-sum >= 0.3 && < 0.5,
124− dependent-sum-template >= 0.0.0.5 && < 0.1,
125− template-haskell
171+ dependent-sum-template >= 0.1 && < 0.2,
172+ template-haskell >= 2.12.0 && < 2.17
126173 other-extensions: TemplateHaskell
127174 cpp-options: -DUSE_TEMPLATE_HASKELL
128175 other-modules:
129176 Reflex.Dom.Builder.Class.TH
130− else
131− build-depends:
132− dependent-sum == 0.4.*
133177
134178test-suite hlint
135− build-depends: base, hlint == 1.9.*
179+ build-depends:
180+ base,
181+ hlint >= 2.0 && < 4.0
136182 hs-source-dirs: test
137183 main-is: hlint.hs
138184 type: exitcode-stdio-1.0
185+ default-language: Haskell98
139186
140−test-suite gc
187+test-suite hydration
141188 build-depends: base
142− , reflex-dom-core
189+ , aeson
190+ , async
191+ , bytestring
192+ , chrome-test-utils
193+ , constraints
194+ , constraints-extras
195+ , containers
196+ , dependent-map
197+ , dependent-sum
198+ , dependent-sum-template
199+ , directory
200+ , exceptions
201+ , filepath
202+ , ghcjs-dom
203+ , hspec
204+ , hspec-core
205+ , hspec-webdriver
206+ , http-types
207+ , HUnit
208+ , jsaddle
143209 , jsaddle-warp
210+ , lens
211+ , lifted-base
212+ , network
213+ , random
214+ , ref-tf
215+ , reflex
216+ , reflex-dom-core
144217 , process
218+ , silently
145219 , temporary
220+ , text
221+ , wai
222+ , wai-websockets
223+ , warp
224+ , webdriver
225+ , websockets
226+ , which
146227 hs-source-dirs: test
147228 ghc-options: -rtsopts -with-rtsopts=-T -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
148− ghc-prof-options: -fprof-auto
229+ ghc-prof-options: -fprof-auto -optP-DPROFILING
230+ main-is: hydration.hs
231+ type: exitcode-stdio-1.0
232+ default-language: Haskell98
233+ if !os(linux) || !arch(x86_64) || flag(profile-reflex) || !flag(hydration-tests)
234+ buildable: False
235+
236+-- broken test on base 4.11 & ghc 8.4.3
237+-- needs to be updated for changes in GHC.Stats
238+test-suite gc
239+ build-depends: base
240+ , chrome-test-utils
241+ , jsaddle
242+ , jsaddle-warp
243+ , process
244+ , reflex
245+ , reflex-dom-core
246+ , text
247+ hs-source-dirs: test
248+ ghc-options: -rtsopts -with-rtsopts=-T -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
249+ ghc-prof-options: -fprof-auto -optP-DPROFILING
149250 main-is: gc.hs
150251 type: exitcode-stdio-1.0
151− if !os(linux) || !arch(x86_64)
252+ default-language: Haskell98
253+ if !os(linux) || !arch(x86_64) || !flag(gc-tests)
152254 buildable: False
153255
154256source-repository head
reflex-dom-core/src/Foreign/JavaScript/Orphans.hs+9−8
@@ -1,5 +1,8 @@
1+{-# OPTIONS_HADDOCK hide #-}
12{-# LANGUAGE CPP #-}
23{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE UndecidableInstances #-}
5+
36{-# OPTIONS_GHC -fno-warn-orphans #-}
47module Foreign.JavaScript.Orphans where
58
@@ -7,30 +10,28 @@ module Foreign.JavaScript.Orphans where
710
811import Control.Monad.Trans.Class (lift)
912import GHCJS.DOM.Types (MonadJSM (..))
10−import Reflex.DynamicWriter (DynamicWriterT)
11−import Reflex.EventWriter (EventWriterT)
13+import Reflex.DynamicWriter.Base (DynamicWriterT)
14+import Reflex.EventWriter.Base (EventWriterT)
1215import Reflex.Host.Class (HostFrame, ReflexHost)
1316import Reflex.PerformEvent.Base (PerformEventT (..))
1417import Reflex.PostBuild.Base (PostBuildT)
1518import Reflex.Requester.Base (RequesterT)
1619import Reflex.TriggerEvent.Base
20+import Reflex.Query.Base (QueryT)
1721
18−instance (MonadJSM m, ReflexHost t) => MonadJSM (PostBuildT t m) where
22+instance MonadJSM m => MonadJSM (PostBuildT t m) where
1923 liftJSM' = lift . liftJSM'
20−
2124instance (MonadJSM (HostFrame t), ReflexHost t) => MonadJSM (PerformEventT t m) where
2225 liftJSM' = PerformEventT . lift . liftJSM'
23−
2426instance MonadJSM m => MonadJSM (DynamicWriterT t w m) where
2527 liftJSM' = lift . liftJSM'
26−
2728instance MonadJSM m => MonadJSM (EventWriterT t w m) where
2829 liftJSM' = lift . liftJSM'
29−
3030instance MonadJSM m => MonadJSM (RequesterT t request response m) where
3131 liftJSM' = lift . liftJSM'
32−
3332instance MonadJSM m => MonadJSM (TriggerEventT t m) where
3433 liftJSM' = lift . liftJSM'
34+instance MonadJSM m => MonadJSM (QueryT t q m) where
35+ liftJSM' = lift . liftJSM'
3536
3637#endif
reflex-dom-core/src/Foreign/JavaScript/TH.hs+26−7
@@ -6,11 +6,9 @@
66{-# LANGUAGE FlexibleInstances #-}
77{-# LANGUAGE FunctionalDependencies #-}
88{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
109{-# LANGUAGE RankNTypes #-}
1110{-# LANGUAGE StandaloneDeriving #-}
1211{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeSynonymInstances #-}
1412{-# LANGUAGE UndecidableInstances #-}
1513#ifdef USE_TEMPLATE_HASKELL
1614{-# LANGUAGE TemplateHaskell #-}
@@ -28,13 +26,15 @@ module Foreign.JavaScript.TH ( module Foreign.JavaScript.TH
2826import Foreign.JavaScript.Orphans ()
2927import Prelude hiding ((!!))
3028import Reflex.Class
31−import Reflex.DynamicWriter
32−import Reflex.EventWriter
29+import Reflex.Adjustable.Class
30+import Reflex.DynamicWriter.Base
31+import Reflex.EventWriter.Base
3332import Reflex.Host.Class
3433import Reflex.PerformEvent.Base
3534import Reflex.PerformEvent.Class
3635import Reflex.PostBuild.Base
3736import Reflex.Requester.Base
37+import Reflex.Query.Base (QueryT (..))
3838
3939#ifdef USE_TEMPLATE_HASKELL
4040import Language.Haskell.TH
@@ -125,14 +125,19 @@ instance HasJSContext m => HasJSContext (RequesterT t request response m) where
125125 type JSContextPhantom (RequesterT t request response m) = JSContextPhantom m
126126 askJSContext = lift askJSContext
127127
128+instance HasJSContext m => HasJSContext (QueryT t q m) where
129+ type JSContextPhantom (QueryT t q m) = JSContextPhantom m
130+ askJSContext = QueryT askJSContext
131+
128132newtype WithJSContextSingleton x m a = WithJSContextSingleton { unWithJSContextSingleton :: ReaderT (JSContextSingleton x) m a } deriving (Functor, Applicative, Monad, MonadIO, MonadFix, MonadTrans, MonadException, MonadAsyncException)
129133
130134instance PrimMonad m => PrimMonad (WithJSContextSingleton x m) where
131135 type PrimState (WithJSContextSingleton x m) = PrimState m
132136 primitive = lift . primitive
133137
134−instance MonadAdjust t m => MonadAdjust t (WithJSContextSingleton x m) where
138+instance Adjustable t m => Adjustable t (WithJSContextSingleton x m) where
135139 runWithReplace a0 a' = WithJSContextSingleton $ runWithReplace (coerce a0) (coerceEvent a')
140+ traverseIntMapWithKeyWithAdjust f dm0 dm' = WithJSContextSingleton $ traverseIntMapWithKeyWithAdjust (\k v -> unWithJSContextSingleton $ f k v) (coerce dm0) (coerceEvent dm')
136141 traverseDMapWithKeyWithAdjust f dm0 dm' = WithJSContextSingleton $ traverseDMapWithKeyWithAdjust (\k v -> unWithJSContextSingleton $ f k v) (coerce dm0) (coerceEvent dm')
137142 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = WithJSContextSingleton $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unWithJSContextSingleton $ f k v) (coerce dm0) (coerceEvent dm')
138143
@@ -164,6 +169,10 @@ instance MonadHold t m => MonadHold t (WithJSContextSingleton x m) where
164169 holdDyn v0 = lift . holdDyn v0
165170 {-# INLINABLE holdIncremental #-}
166171 holdIncremental v0 = lift . holdIncremental v0
172+ {-# INLINABLE buildDynamic #-}
173+ buildDynamic a0 = lift . buildDynamic a0
174+ {-# INLINABLE headE #-}
175+ headE = lift . headE
167176
168177instance MonadTransControl (WithJSContextSingleton x) where
169178 type StT (WithJSContextSingleton x) a = StT (ReaderT (JSContextSingleton x)) a
@@ -232,7 +241,7 @@ instance HasJS x m => HasJS x (ReaderT r m) where
232241 type JSX (ReaderT r m) = JSX m
233242 liftJS = lift . liftJS
234243
235−instance (HasJS x m, ReflexHost t) => HasJS x (PostBuildT t m) where
244+instance HasJS x m => HasJS x (PostBuildT t m) where
236245 type JSX (PostBuildT t m) = JSX m
237246 liftJS = lift . liftJS
238247
@@ -244,10 +253,18 @@ instance HasJS x m => HasJS x (DynamicWriterT t w m) where
244253 type JSX (DynamicWriterT t w m) = JSX m
245254 liftJS = lift . liftJS
246255
256+instance HasJS x m => HasJS x (EventWriterT t w m) where
257+ type JSX (EventWriterT t w m) = JSX m
258+ liftJS = lift . liftJS
259+
247260instance HasJS x m => HasJS x (RequesterT t request response m) where
248261 type JSX (RequesterT t request response m) = JSX m
249262 liftJS = lift . liftJS
250263
264+instance HasJS x m => HasJS x (QueryT t q m) where
265+ type JSX (QueryT t q m) = JSX m
266+ liftJS = lift . liftJS
267+
251268-- | A Monad that is capable of executing JavaScript
252269class Monad m => MonadJS x m | m -> x where
253270 runJS :: JSFFI -> [JSRef x] -> m (JSRef x)
@@ -275,6 +292,7 @@ class Monad m => MonadJS x m | m -> x where
275292#ifdef ghcjs_HOST_OS
276293
277294data JSCtx_IO
295+type JS' = JSCtx_IO
278296
279297instance MonadIO m => HasJS JSCtx_IO (WithJSContextSingleton x m) where
280298 type JSX (WithJSContextSingleton x m) = IO
@@ -325,6 +343,7 @@ foreign import javascript unsafe "function(){ return $1(arguments); }" funWithAr
325343#else
326344
327345data JSCtx_JavaScriptCore x
346+type JS' = JSCtx_JavaScriptCore ()
328347
329348instance IsJSContext (JSCtx_JavaScriptCore x) where
330349 newtype JSRef (JSCtx_JavaScriptCore x) = JSRef_JavaScriptCore { unJSRef_JavaScriptCore :: JSVal }
@@ -411,7 +430,7 @@ instance MonadJS (JSCtx_JavaScriptCore x) (WithJSContext x IO) where
411430 f $ JSUint8Array payloadRef
412431 fromJSArray (JSRef_JavaScriptCore a) = liftJSM $ do
413432 len <- round <$> (valToNumber =<< (a ^. js "length"))
414− forM [0..len-1] $ \i -> JSRef_JavaScriptCore <$> a !! i
433+ forM [0..len-1] $ fmap JSRef_JavaScriptCore . (a !!)
415434 fromJSUint8Array a = do
416435 vals <- fromJSArray a
417436 doubles <- mapM fromJSNumber vals
reflex-dom-core/src/Foreign/JavaScript/Utils.hs+32−1
@@ -1,15 +1,32 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
13module Foreign.JavaScript.Utils
24 ( bsFromMutableArrayBuffer
35 , bsToArrayBuffer
6+ , jsonDecode
7+ , js_jsonParse
48 ) where
59
10+import Control.Lens
11+import Data.Aeson
612import Data.ByteString (ByteString)
713import qualified Data.ByteString as BS
814import Foreign.JavaScript.Internal.Utils (js_dataView)
915import qualified GHCJS.Buffer as JS
1016import GHCJS.DOM.Types (ArrayBuffer (..))
17+import GHCJS.Marshal ()
18+import Language.Javascript.JSaddle (jsg, js1)
1119import qualified JavaScript.TypedArray.ArrayBuffer as JS
12−import Language.Javascript.JSaddle.Types (MonadJSM, ghcjsPure, jsval, liftJSM)
20+import Language.Javascript.JSaddle.Types (JSString, JSM, JSVal, MonadJSM, ghcjsPure, jsval, liftJSM)
21+#ifdef ghcjs_HOST_OS
22+import Control.Exception (SomeException)
23+import Language.Javascript.JSaddle (fromJSVal, catch)
24+import System.IO.Unsafe
25+#else
26+import qualified Data.ByteString.Lazy as LBS
27+import Data.Text.Encoding
28+import Language.Javascript.JSaddle (textFromJSString)
29+#endif
1330
1431{-# INLINABLE bsFromMutableArrayBuffer #-}
1532bsFromMutableArrayBuffer :: MonadJSM m => JS.MutableArrayBuffer -> m ByteString
@@ -25,3 +42,17 @@ bsToArrayBuffer bs = liftJSM $ do
2542 else do
2643 ref <- ghcjsPure (JS.getArrayBuffer b) >>= ghcjsPure . jsval
2744 js_dataView off len ref
45+
46+jsonDecode :: FromJSON a => JSString -> Maybe a
47+#ifdef ghcjs_HOST_OS
48+jsonDecode t = do
49+ result <- unsafePerformIO $ (fromJSVal =<< js_jsonParse t) `catch` (\(_ :: SomeException) -> pure Nothing)
50+ case fromJSON result of
51+ Success a -> Just a
52+ Error _ -> Nothing
53+#else
54+jsonDecode = decode . LBS.fromStrict . encodeUtf8 . textFromJSString
55+#endif
56+
57+js_jsonParse :: JSString -> JSM JSVal
58+js_jsonParse a = jsg "JSON" ^. js1 "parse" a
reflex-dom-core/src/Reflex/Dom/Builder/Class.hs+146−47
@@ -7,11 +7,14 @@
77{-# LANGUAGE FlexibleInstances #-}
88{-# LANGUAGE FunctionalDependencies #-}
99{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10+#if !MIN_VERSION_base(4,9,0)
11+{-# LANGUAGE ImpredicativeTypes #-}
12+#else
13+{-# LANGUAGE Rank2Types #-} -- Implied by ImpredicativeTypes
14+#endif
1015{-# LANGUAGE LambdaCase #-}
11−{-# LANGUAGE MultiParamTypeClasses #-}
1216{-# LANGUAGE OverloadedStrings #-}
1317{-# LANGUAGE PolyKinds #-}
14−{-# LANGUAGE RankNTypes #-}
1518{-# LANGUAGE RecursiveDo #-}
1619{-# LANGUAGE ScopedTypeVariables #-}
1720{-# LANGUAGE StandaloneDeriving #-}
@@ -23,22 +26,29 @@
2326module Reflex.Dom.Builder.Class
2427 ( module Reflex.Dom.Builder.Class
2528 , module Reflex.Dom.Builder.Class.Events
29+ , module Reflex.NotReady.Class
2630 ) where
2731
32+import Reflex.Adjustable.Class
2833import Reflex.Class as Reflex
2934import Reflex.Dom.Builder.Class.Events
3035#ifdef USE_TEMPLATE_HASKELL
3136import Reflex.Dom.Builder.Class.TH
3237#endif
33−import Reflex.DynamicWriter
34−import Reflex.EventWriter
38+import Reflex.BehaviorWriter.Base
39+import Reflex.DynamicWriter.Base
40+import Reflex.EventWriter.Base
41+import Reflex.NotReady.Class
3542import Reflex.PerformEvent.Class
3643import Reflex.PostBuild.Base
44+import Reflex.Query.Base
45+import Reflex.Query.Class
3746import Reflex.Requester.Base
3847
3948import qualified Control.Category
4049import Control.Lens hiding (element)
4150import Control.Monad.Reader
51+import qualified Control.Monad.State as Lazy
4252import Control.Monad.State.Strict
4353import Control.Monad.Trans.Control
4454import Data.Default
@@ -52,12 +62,14 @@ import Data.String
5262import Data.Text (Text)
5363import Data.Type.Coercion
5464import GHCJS.DOM.Types (JSM)
65+import qualified GHCJS.DOM.Types as DOM
5566
5667class Default (EventSpec d EventResult) => DomSpace d where
5768 type EventSpec d :: (EventTag -> *) -> *
69+ type RawDocument d :: *
5870 type RawTextNode d :: *
71+ type RawCommentNode d :: *
5972 type RawElement d :: *
60− type RawFile d :: *
6173 type RawInputElement d :: *
6274 type RawTextAreaElement d :: *
6375 type RawSelectElement d :: *
@@ -65,7 +77,7 @@ class Default (EventSpec d EventResult) => DomSpace d where
6577
6678-- | @'DomBuilder' t m@ indicates that @m@ is a 'Monad' capable of building
6779-- dynamic DOM in the 'Reflex' timeline @t@
68−class (Monad m, Reflex t, DomSpace (DomBuilderSpace m), MonadAdjust t m) => DomBuilder t m | m -> t where
80+class (Monad m, Reflex t, DomSpace (DomBuilderSpace m), NotReady t m, Adjustable t m) => DomBuilder t m | m -> t where
6981 type DomBuilderSpace m :: *
7082 textNode :: TextNodeConfig t -> m (TextNode (DomBuilderSpace m) t)
7183 default textNode :: ( MonadTrans f
@@ -76,6 +88,15 @@ class (Monad m, Reflex t, DomSpace (DomBuilderSpace m), MonadAdjust t m) => DomB
7688 => TextNodeConfig t -> m (TextNode (DomBuilderSpace m) t)
7789 textNode = lift . textNode
7890 {-# INLINABLE textNode #-}
91+ commentNode :: CommentNodeConfig t -> m (CommentNode (DomBuilderSpace m) t)
92+ default commentNode :: ( MonadTrans f
93+ , m ~ f m'
94+ , DomBuilderSpace m' ~ DomBuilderSpace m
95+ , DomBuilder t m'
96+ )
97+ => CommentNodeConfig t -> m (CommentNode (DomBuilderSpace m) t)
98+ commentNode = lift . commentNode
99+ {-# INLINABLE commentNode #-}
79100 element :: Text -> ElementConfig er t (DomBuilderSpace m) -> m a -> m (Element er (DomBuilderSpace m) t, a)
80101 default element :: ( MonadTransControl f
81102 , StT f a ~ a
@@ -135,20 +156,6 @@ class (Monad m, Reflex t, DomSpace (DomBuilderSpace m), MonadAdjust t m) => DomB
135156 { _rawElementConfig_eventSpec = _rawElementConfig_eventSpec cfg
136157 }
137158 {-# INLINABLE wrapRawElement #-}
138− notReadyUntil :: Event t a -> m ()
139− default notReadyUntil :: ( MonadTrans f
140− , m ~ f m'
141− , DomBuilder t m'
142− )
143− => Event t a -> m ()
144− notReadyUntil = lift . notReadyUntil
145− notReady :: m ()
146− default notReady :: ( MonadTrans f
147− , m ~ f m'
148− , DomBuilder t m'
149− )
150− => m ()
151− notReady = lift notReady
152159
153160class DomBuilder t m => MountableDomBuilder t m where
154161 type DomFragment m :: *
@@ -158,8 +165,8 @@ class DomBuilder t m => MountableDomBuilder t m where
158165type Namespace = Text
159166
160167data TextNodeConfig t
161− = TextNodeConfig { _textNodeConfig_initialContents :: Text
162− , _textNodeConfig_setContents :: Maybe (Event t Text)
168+ = TextNodeConfig { _textNodeConfig_initialContents :: {-# UNPACK #-} !Text
169+ , _textNodeConfig_setContents :: !(Maybe (Event t Text))
163170 }
164171
165172#ifndef USE_TEMPLATE_HASKELL
@@ -179,6 +186,28 @@ newtype TextNode d t = TextNode
179186 { _textNode_raw :: RawTextNode d
180187 }
181188
189+data CommentNodeConfig t
190+ = CommentNodeConfig { _commentNodeConfig_initialContents :: {-# UNPACK #-} !Text
191+ , _commentNodeConfig_setContents :: !(Maybe (Event t Text))
192+ }
193+
194+#ifndef USE_TEMPLATE_HASKELL
195+commentNodeConfig_initialContents :: Lens' (CommentNodeConfig t) Text
196+commentNodeConfig_initialContents f (CommentNodeConfig a b) = (\a' -> CommentNodeConfig a' b) <$> f a
197+{-# INLINE commentNodeConfig_initialContents #-}
198+#endif
199+
200+instance (Reflex t) => Default (CommentNodeConfig t) where
201+ {-# INLINABLE def #-}
202+ def = CommentNodeConfig
203+ { _commentNodeConfig_initialContents = mempty
204+ , _commentNodeConfig_setContents = Nothing
205+ }
206+
207+newtype CommentNode d t = CommentNode
208+ { _commentNode_raw :: RawCommentNode d
209+ }
210+
182211data AttributeName = AttributeName !(Maybe Namespace) !Text deriving (Show, Read, Eq, Ord)
183212
184213mapKeysToAttributeName :: Map Text v -> Map AttributeName v
@@ -295,7 +324,7 @@ data InputElement er d t
295324 , _inputElement_hasFocus :: Dynamic t Bool
296325 , _inputElement_element :: Element er d t
297326 , _inputElement_raw :: RawInputElement d
298− , _inputElement_files :: Dynamic t [RawFile d]
327+ , _inputElement_files :: Dynamic t [DOM.File]
299328 }
300329
301330data TextAreaElementConfig er t m
@@ -397,6 +426,7 @@ data SelectElement er d t = SelectElement
397426#ifdef USE_TEMPLATE_HASKELL
398427concat <$> mapM (uncurry makeLensesWithoutField)
399428 [ (["_textNodeConfig_setContents"], ''TextNodeConfig)
429+ , (["_commentNodeConfig_setContents"], ''CommentNodeConfig)
400430 , ([ "_inputElementConfig_setValue"
401431 , "_inputElementConfig_setChecked" ], ''InputElementConfig)
402432 , (["_rawElementConfig_modifyAttributes"], ''RawElementConfig)
@@ -407,49 +437,56 @@ concat <$> mapM (uncurry makeLensesWithoutField)
407437#endif
408438
409439-- | This lens is technically illegal. The implementation of 'TextNodeConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'TextNodeConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
410−textNodeConfig_setContents :: Reflex t => Lens (TextNodeConfig t) (TextNodeConfig t) (Event t Text) (Event t Text)
440+textNodeConfig_setContents :: Reflex t => Lens' (TextNodeConfig t) (Event t Text)
411441textNodeConfig_setContents =
412442 let getter = fromMaybe never . _textNodeConfig_setContents
413443 setter t e = t { _textNodeConfig_setContents = Just e }
414444 in lens getter setter
415445
446+-- | This lens is technically illegal. The implementation of 'CommentNodeConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'CommentNodeConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
447+commentNodeConfig_setContents :: Reflex t => Lens (CommentNodeConfig t) (CommentNodeConfig t) (Event t Text) (Event t Text)
448+commentNodeConfig_setContents =
449+ let getter = fromMaybe never . _commentNodeConfig_setContents
450+ setter t e = t { _commentNodeConfig_setContents = Just e }
451+ in lens getter setter
452+
416453-- | This lens is technically illegal. The implementation of 'InputElementConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'InputElementConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
417−inputElementConfig_setValue :: Reflex t => Lens (InputElementConfig er t m) (InputElementConfig er t m) (Event t Text) (Event t Text)
454+inputElementConfig_setValue :: Reflex t => Lens' (InputElementConfig er t m) (Event t Text)
418455inputElementConfig_setValue =
419456 let getter = fromMaybe never . _inputElementConfig_setValue
420457 setter t e = t { _inputElementConfig_setValue = Just e }
421458 in lens getter setter
422459
423460-- | This lens is technically illegal. The implementation of 'InputElementConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'InputElementConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
424−inputElementConfig_setChecked :: Reflex t => Lens (InputElementConfig er t m) (InputElementConfig er t m) (Event t Bool) (Event t Bool)
461+inputElementConfig_setChecked :: Reflex t => Lens' (InputElementConfig er t m) (Event t Bool)
425462inputElementConfig_setChecked =
426463 let getter = fromMaybe never . _inputElementConfig_setChecked
427464 setter t e = t { _inputElementConfig_setChecked = Just e }
428465 in lens getter setter
429466
430467-- | This lens is technically illegal. The implementation of 'RawElementConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'RawElementConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
431−rawElementConfig_modifyAttributes :: Reflex t => Lens (RawElementConfig er t m) (RawElementConfig er t m) (Event t (Map AttributeName (Maybe Text))) (Event t (Map AttributeName (Maybe Text)))
468+rawElementConfig_modifyAttributes :: Reflex t => Lens' (RawElementConfig er t m) (Event t (Map AttributeName (Maybe Text)))
432469rawElementConfig_modifyAttributes =
433470 let getter = fromMaybe never . _rawElementConfig_modifyAttributes
434471 setter t e = t { _rawElementConfig_modifyAttributes = Just e }
435472 in lens getter setter
436473
437474-- | This lens is technically illegal. The implementation of 'RawElementConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'RawElementConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
438−elementConfig_modifyAttributes :: Reflex t => Lens (ElementConfig er t m) (ElementConfig er t m) (Event t (Map AttributeName (Maybe Text))) (Event t (Map AttributeName (Maybe Text)))
475+elementConfig_modifyAttributes :: Reflex t => Lens' (ElementConfig er t m) (Event t (Map AttributeName (Maybe Text)))
439476elementConfig_modifyAttributes =
440477 let getter = fromMaybe never . _elementConfig_modifyAttributes
441478 setter t e = t { _elementConfig_modifyAttributes = Just e }
442479 in lens getter setter
443480
444481-- | This lens is technically illegal. The implementation of 'TextAreaElementConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'TextAreaElementConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
445−textAreaElementConfig_setValue :: Reflex t => Lens (TextAreaElementConfig er t m) (TextAreaElementConfig er t m) (Event t Text) (Event t Text)
482+textAreaElementConfig_setValue :: Reflex t => Lens' (TextAreaElementConfig er t m) (Event t Text)
446483textAreaElementConfig_setValue =
447484 let getter = fromMaybe never . _textAreaElementConfig_setValue
448485 setter t e = t { _textAreaElementConfig_setValue = Just e }
449486 in lens getter setter
450487
451488-- | This lens is technically illegal. The implementation of 'SelectElementConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'SelectElementConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
452−selectElementConfig_setValue :: Reflex t => Lens (SelectElementConfig er t m) (SelectElementConfig er t m) (Event t Text) (Event t Text)
489+selectElementConfig_setValue :: Reflex t => Lens' (SelectElementConfig er t m) (Event t Text)
453490selectElementConfig_setValue =
454491 let getter = fromMaybe never . _selectElementConfig_setValue
455492 setter t e = t { _selectElementConfig_setValue = Just e }
@@ -525,6 +562,7 @@ instance (MountableDomBuilder t m, PerformEvent t m, MonadFix m, MonadHold t m)
525562instance (DomBuilder t m, Monoid w, MonadHold t m, MonadFix m) => DomBuilder t (DynamicWriterT t w m) where
526563 type DomBuilderSpace (DynamicWriterT t w m) = DomBuilderSpace m
527564 textNode = liftTextNode
565+ commentNode = liftCommentNode
528566 element elementTag cfg (DynamicWriterT child) = DynamicWriterT $ do
529567 s <- get
530568 (el, (a, newS)) <- lift $ element elementTag cfg $ runStateT child s
@@ -543,47 +581,72 @@ instance (DomBuilder t m, Monoid w, MonadHold t m, MonadFix m) => DomBuilder t (
543581instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RequesterT t request response m) where
544582 type DomBuilderSpace (RequesterT t request response m) = DomBuilderSpace m
545583 textNode = liftTextNode
584+ commentNode = liftCommentNode
546585 element elementTag cfg (RequesterT child) = RequesterT $ do
547586 r <- ask
548− (el, (a, e)) <- lift $ lift $ element elementTag cfg $ runReaderT (runEventWriterT child) r
549− tellEvent e
587+ old <- get
588+ (el, (a, new)) <- lift $ lift $ element elementTag cfg $ runReaderT (runStateT child old) r
589+ put new
550590 return (el, a)
551591 inputElement = lift . inputElement
552592 textAreaElement = lift . textAreaElement
553593 selectElement cfg (RequesterT child) = RequesterT $ do
554594 r <- ask
555− (el, (a, e)) <- lift $ lift $ selectElement cfg $ runReaderT (runEventWriterT child) r
556− tellEvent e
595+ old <- get
596+ (el, (a, new)) <- lift $ lift $ selectElement cfg $ runReaderT (runStateT child old) r
597+ put new
557598 return (el, a)
558599 placeRawElement = lift . placeRawElement
559600 wrapRawElement e = lift . wrapRawElement e
560601
561−instance (DomBuilder t m, MonadHold t m, MonadFix m, Semigroup w, Monoid w) => DomBuilder t (EventWriterT t w m) where
602+instance (DomBuilder t m, MonadHold t m, MonadFix m, Semigroup w) => DomBuilder t (EventWriterT t w m) where
562603 type DomBuilderSpace (EventWriterT t w m) = DomBuilderSpace m
563604 textNode = liftTextNode
564− element elementTag cfg child = do
565− (el, (a, e)) <- lift $ element elementTag cfg $ runEventWriterT child
566− tellEvent e
605+ commentNode = liftCommentNode
606+ element elementTag cfg (EventWriterT child) = EventWriterT $ do
607+ old <- get
608+ (el, (a, new)) <- lift $ element elementTag cfg $ runStateT child old
609+ put new
567610 return (el, a)
568611 inputElement = lift . inputElement
569612 textAreaElement = lift . textAreaElement
570− selectElement cfg child = do
571− (el, (a, e)) <- lift $ selectElement cfg $ runEventWriterT child
572− tellEvent e
613+ selectElement cfg (EventWriterT child) = EventWriterT $ do
614+ old <- get
615+ (el, (a, new)) <- lift $ selectElement cfg $ runStateT child old
616+ put new
573617 return (el, a)
574618 placeRawElement = lift . placeRawElement
575619 wrapRawElement e = lift . wrapRawElement e
576620
621+instance (DomBuilder t m, MonadFix m, MonadHold t m, Group q, Query q, Additive q, Eq q) => DomBuilder t (QueryT t q m) where
622+ type DomBuilderSpace (QueryT t q m) = DomBuilderSpace m
623+ textNode = liftTextNode
624+ commentNode = liftCommentNode
625+ element elementTag cfg (QueryT child) = QueryT $ do
626+ s <- get
627+ (e, (a, newS)) <- lift $ element elementTag cfg $ runStateT child s
628+ put newS
629+ return (e, a)
630+ inputElement = lift . inputElement
631+ textAreaElement = lift . textAreaElement
632+ selectElement cfg (QueryT child) = QueryT $ do
633+ s <- get
634+ (e, (a, newS)) <- lift $ selectElement cfg $ runStateT child s
635+ put newS
636+ return (e, a)
637+ placeRawElement = lift . placeRawElement
638+ wrapRawElement e = lift . wrapRawElement e
639+
577640-- * Convenience functions
578641
579−class HasDomEvent t target eventName where
642+class HasDomEvent t target eventName | target -> t where
580643 type DomEventType target eventName :: *
581644 domEvent :: EventName eventName -> target -> Event t (DomEventType target eventName)
582645
583646instance Reflex t => HasDomEvent t (Element EventResult d t) en where
584647 type DomEventType (Element EventResult d t) en = EventResultType en
585648 {-# INLINABLE domEvent #-}
586− domEvent en e = unEventResult <$> Reflex.select (_element_events e) (WrapArg en)
649+ domEvent en e = coerceEvent $ Reflex.select (_element_events e) (WrapArg en)
587650
588651instance Reflex t => HasDomEvent t (InputElement EventResult d t) en where
589652 type DomEventType (InputElement EventResult d t) en = EventResultType en
@@ -608,7 +671,7 @@ type LiftDomBuilder t f m =
608671
609672class MonadTransControl t => MonadTransControlStateless t where
610673 stTCoercion :: proxy t -> Coercion (StT t a) a
611− default stTCoercion :: proxy t -> Coercion a a
674+ default stTCoercion :: (a ~ StT t a) => proxy t -> Coercion (StT t a) a
612675 stTCoercion _ = Control.Category.id
613676
614677toStT :: MonadTransControlStateless t => proxy t -> a -> StT t a
@@ -622,11 +685,14 @@ instance MonadTransControlStateless (ReaderT r)
622685type RunStateless t = forall n b. Monad n => t n b -> n b
623686
624687liftWithStateless :: forall m t a. (Monad m, MonadTransControlStateless t) => (RunStateless t -> m a) -> t m a
625−liftWithStateless a = liftWith $ \run -> a $ \x -> fromStT (Proxy :: Proxy t) <$> run x
688+liftWithStateless a = liftWith $ \run -> a $ fmap (fromStT (Proxy :: Proxy t)) . run
626689
627690liftTextNode :: (MonadTrans f, DomBuilder t m) => TextNodeConfig t -> f m (TextNode (DomBuilderSpace m) t)
628691liftTextNode = lift . textNode
629692
693+liftCommentNode :: (MonadTrans f, DomBuilder t m) => CommentNodeConfig t -> f m (CommentNode (DomBuilderSpace m) t)
694+liftCommentNode = lift . commentNode
695+
630696liftElement :: LiftDomBuilder t f m => Text -> ElementConfig er t (DomBuilderSpace m) -> f m a -> f m (Element er (DomBuilderSpace m) t, a)
631697liftElement elementTag cfg child = liftWithStateless $ \run -> element elementTag cfg $ run child
632698
@@ -645,12 +711,45 @@ instance DomRenderHook t m => DomRenderHook t (StateT e m) where
645711 requestDomAction = lift . requestDomAction
646712 requestDomAction_ = lift . requestDomAction_
647713
714+instance DomRenderHook t m => DomRenderHook t (Lazy.StateT e m) where
715+ withRenderHook hook (Lazy.StateT a) = Lazy.StateT $ \s -> withRenderHook hook $ a s
716+ requestDomAction = lift . requestDomAction
717+ requestDomAction_ = lift . requestDomAction_
718+
719+deriving instance DomRenderHook t m => DomRenderHook t (BehaviorWriterT t w m)
648720deriving instance DomRenderHook t m => DomRenderHook t (EventWriterT t w m)
649−#if MIN_VERSION_base(4,9,1)
721+deriving instance DomRenderHook t m => DomRenderHook t (DynamicWriterT t w m)
650722deriving instance DomRenderHook t m => DomRenderHook t (RequesterT t req rsp m)
651−#endif
652723deriving instance DomRenderHook t m => DomRenderHook t (PostBuildT t m)
724+deriving instance DomRenderHook t m => DomRenderHook t (QueryT t q m)
653725
654726{-# DEPRECATED liftElementConfig "Use 'id' instead; this function is no longer necessary" #-}
655727liftElementConfig :: ElementConfig er t s -> ElementConfig er t s
656728liftElementConfig = id
729+
730+class Monad m => HasDocument m where
731+ askDocument :: m (RawDocument (DomBuilderSpace m))
732+ default askDocument
733+ :: ( m ~ f m'
734+ , RawDocument (DomBuilderSpace m) ~ RawDocument (DomBuilderSpace m')
735+ , MonadTrans f
736+ , Monad m'
737+ , HasDocument m'
738+ )
739+ => m (RawDocument (DomBuilderSpace m))
740+ askDocument = lift askDocument
741+
742+instance HasDocument m => HasDocument (ReaderT r m)
743+instance HasDocument m => HasDocument (EventWriterT t w m)
744+instance HasDocument m => HasDocument (DynamicWriterT t w m)
745+instance HasDocument m => HasDocument (PostBuildT t m)
746+instance HasDocument m => HasDocument (RequesterT t request response m)
747+instance HasDocument m => HasDocument (QueryT t q m)
748+
749+class HasSetValue a where
750+ type SetValue a :: *
751+ setValue :: Lens' a (SetValue a)
752+
753+instance Reflex t => HasSetValue (TextAreaElementConfig er t m) where
754+ type SetValue (TextAreaElementConfig er t m) = Event t Text
755+ setValue = textAreaElementConfig_setValue
reflex-dom-core/src/Reflex/Dom/Builder/Class/Events.hs+13−3
@@ -1,7 +1,6 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE DataKinds #-}
33{-# LANGUAGE GADTs #-}
4−{-# LANGUAGE KindSignatures #-}
54{-# LANGUAGE PolyKinds #-}
65#ifdef USE_TEMPLATE_HASKELL
76{-# LANGUAGE TemplateHaskell #-}
@@ -15,6 +14,7 @@ import Data.GADT.Compare.TH
1514import Data.GADT.Compare
1615 (GOrdering(..), (:~:)(..), GEq(..), GCompare(..))
1716#endif
17+import Data.Text (Text)
1818
1919data EventTag
2020 = AbortTag
@@ -152,7 +152,7 @@ type family EventResultType (en :: EventTag) :: * where
152152 EventResultType 'BeforecopyTag = ()
153153 EventResultType 'CopyTag = ()
154154 EventResultType 'BeforepasteTag = ()
155− EventResultType 'PasteTag = ()
155+ EventResultType 'PasteTag = Maybe Text
156156 EventResultType 'ResetTag = ()
157157 EventResultType 'SearchTag = ()
158158 EventResultType 'SelectstartTag = ()
@@ -160,7 +160,17 @@ type family EventResultType (en :: EventTag) :: * where
160160 EventResultType 'TouchmoveTag = TouchEventResult
161161 EventResultType 'TouchendTag = TouchEventResult
162162 EventResultType 'TouchcancelTag = TouchEventResult
163− EventResultType 'WheelTag = ()
163+ EventResultType 'WheelTag = WheelEventResult
164+
165+data DeltaMode = DeltaPixel | DeltaLine | DeltaPage
166+ deriving (Show, Read, Eq, Ord, Bounded, Enum)
167+
168+data WheelEventResult = WheelEventResult
169+ { _wheelEventResult_deltaX :: Double
170+ , _wheelEventResult_deltaY :: Double
171+ , _wheelEventResult_deltaZ :: Double
172+ , _wheelEventResult_deltaMode :: DeltaMode
173+ } deriving (Show, Read, Eq, Ord)
164174
165175data TouchEventResult = TouchEventResult
166176 { _touchEventResult_altKey :: Bool
reflex-dom-core/src/Reflex/Dom/Builder/Hydratable.hsnew file+116
@@ -0,0 +1,116 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE FlexibleInstances #-}
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE MultiParamTypeClasses #-}
5+{-# LANGUAGE OverloadedStrings #-}
6+{-# LANGUAGE StandaloneDeriving #-}
7+{-# LANGUAGE TypeFamilies #-}
8+{-# LANGUAGE UndecidableInstances #-}
9+module Reflex.Dom.Builder.Hydratable where
10+
11+import Control.Monad.Fix
12+import Control.Monad.Primitive
13+import Control.Monad.Ref
14+import Control.Monad.Trans
15+import Control.Monad.Trans.Control
16+import Data.Coerce
17+import qualified Data.Map as Map
18+import Foreign.JavaScript.TH
19+#ifndef ghcjs_HOST_OS
20+import GHCJS.DOM.Types (MonadJSM (..))
21+#endif
22+import Reflex
23+import Reflex.Dom.Builder.Class
24+import Reflex.Dom.Builder.Immediate (HasDocument (..), hydratableAttribute)
25+import Reflex.Host.Class
26+
27+-- | A DomBuilder transformer that adds an attribute to all elements such that the
28+-- hydration builder knows which bits of DOM were added by us, and which were
29+-- added by external scripts.
30+newtype HydratableT m a = HydratableT { runHydratableT :: m a } deriving (Functor, Applicative, Monad, MonadAtomicRef, MonadFix, MonadIO)
31+
32+#ifndef ghcjs_HOST_OS
33+instance MonadJSM m => MonadJSM (HydratableT m) where
34+ liftJSM' = HydratableT . liftJSM'
35+#endif
36+
37+deriving instance MonadSample t m => MonadSample t (HydratableT m)
38+deriving instance MonadHold t m => MonadHold t (HydratableT m)
39+
40+instance MonadTrans HydratableT where
41+ lift = HydratableT
42+
43+instance MonadTransControl HydratableT where
44+ type StT HydratableT a = a
45+ liftWith f = HydratableT $ f runHydratableT
46+ restoreT = HydratableT
47+
48+instance MonadRef m => MonadRef (HydratableT m) where
49+ type Ref (HydratableT m) = Ref m
50+ newRef = lift . newRef
51+ readRef = lift . readRef
52+ writeRef ref = lift . writeRef ref
53+
54+instance PerformEvent t m => PerformEvent t (HydratableT m) where
55+ type Performable (HydratableT m) = Performable m
56+ performEvent_ = lift . performEvent_
57+ performEvent = lift . performEvent
58+
59+instance PrimMonad m => PrimMonad (HydratableT m) where
60+ type PrimState (HydratableT m) = PrimState m
61+ primitive = lift . primitive
62+
63+makeHydratable :: Reflex t => ElementConfig er t m -> ElementConfig er t m
64+makeHydratable cfg = cfg
65+ { _elementConfig_initialAttributes = Map.insert hydratableAttribute "" $ _elementConfig_initialAttributes cfg
66+ , _elementConfig_modifyAttributes = fmap (Map.delete hydratableAttribute) <$> _elementConfig_modifyAttributes cfg
67+ }
68+
69+instance PostBuild t m => PostBuild t (HydratableT m) where
70+ getPostBuild = lift getPostBuild
71+
72+deriving instance TriggerEvent t m => TriggerEvent t (HydratableT m)
73+
74+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydratableT m) where
75+ newEventWithTrigger = lift . newEventWithTrigger
76+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
77+
78+instance Adjustable t m => Adjustable t (HydratableT m) where
79+ runWithReplace a0 a' = HydratableT $ runWithReplace (coerce a0) (coerceEvent a')
80+ traverseDMapWithKeyWithAdjust f dm0 dm' = HydratableT $ traverseDMapWithKeyWithAdjust (\k v -> runHydratableT $ f k v) (coerce dm0) (coerceEvent dm')
81+ traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = HydratableT $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runHydratableT $ f k v) (coerce dm0) (coerceEvent dm')
82+ traverseIntMapWithKeyWithAdjust f m0 m' = HydratableT $ traverseIntMapWithKeyWithAdjust (\k v -> runHydratableT $ f k v) (coerce m0) (coerceEvent m')
83+
84+instance NotReady t m => NotReady t (HydratableT m) where
85+ notReadyUntil = lift . notReadyUntil
86+ notReady = lift notReady
87+
88+instance DomBuilder t m => DomBuilder t (HydratableT m) where
89+ type DomBuilderSpace (HydratableT m) = DomBuilderSpace m
90+ element t cfg = lift . element t (makeHydratable cfg) . runHydratableT
91+ inputElement cfg = lift $ inputElement $ cfg
92+ { _inputElementConfig_elementConfig = makeHydratable $ _inputElementConfig_elementConfig cfg
93+ }
94+ textAreaElement cfg = lift $ textAreaElement $ cfg
95+ { _textAreaElementConfig_elementConfig = makeHydratable $ _textAreaElementConfig_elementConfig cfg
96+ }
97+ selectElement cfg child = do
98+ let cfg' = cfg
99+ { _selectElementConfig_elementConfig = makeHydratable $ _selectElementConfig_elementConfig cfg
100+ }
101+ lift $ selectElement cfg' $ runHydratableT child
102+
103+instance HasDocument m => HasDocument (HydratableT m)
104+
105+instance HasJSContext m => HasJSContext (HydratableT m) where
106+ type JSContextPhantom (HydratableT m) = JSContextPhantom m
107+ askJSContext = lift askJSContext
108+
109+instance HasJS js m => HasJS js (HydratableT m) where
110+ type JSX (HydratableT m) = JSX m
111+ liftJS = lift . liftJS
112+
113+instance DomRenderHook t m => DomRenderHook t (HydratableT m) where
114+ withRenderHook f = HydratableT . withRenderHook f . runHydratableT
115+ requestDomAction = HydratableT . requestDomAction
116+ requestDomAction_ = HydratableT . requestDomAction_
reflex-dom-core/src/Reflex/Dom/Builder/Immediate.hs+1821−505
@@ -2,7 +2,7 @@
22{-# LANGUAGE CPP #-}
33{-# LANGUAGE ConstraintKinds #-}
44{-# LANGUAGE DataKinds #-}
5−{-# LANGUAGE DefaultSignatures #-}
5+{-# LANGUAGE DeriveTraversable #-}
66{-# LANGUAGE EmptyDataDecls #-}
77{-# LANGUAGE FlexibleContexts #-}
88{-# LANGUAGE FlexibleInstances #-}
@@ -11,190 +11,380 @@
1111{-# LANGUAGE LambdaCase #-}
1212{-# LANGUAGE MultiParamTypeClasses #-}
1313{-# LANGUAGE OverloadedStrings #-}
14+{-# LANGUAGE PatternGuards #-}
1415{-# LANGUAGE PolyKinds #-}
1516{-# LANGUAGE RankNTypes #-}
1617{-# LANGUAGE RecursiveDo #-}
1718{-# LANGUAGE ScopedTypeVariables #-}
18−{-# LANGUAGE StandaloneDeriving #-}
1919#ifdef USE_TEMPLATE_HASKELL
2020{-# LANGUAGE TemplateHaskell #-}
2121#endif
22+{-# LANGUAGE TupleSections #-}
2223{-# LANGUAGE TypeFamilies #-}
2324{-# LANGUAGE TypeOperators #-}
2425{-# LANGUAGE UndecidableInstances #-}
25−module Reflex.Dom.Builder.Immediate
26− ( EventTriggerRef (..)
27− , ImmediateDomBuilderEnv (..)
28− , ImmediateDomBuilderT (..)
29− , runImmediateDomBuilderT
30− , askParent
31− , askEvents
32− , append
33− , textNodeInternal
34− , deleteBetweenExclusive
35− , extractBetweenExclusive
36− , deleteUpTo
37− , extractUpTo
38− , SupportsImmediateDomBuilder
39− , collectUpTo
40− , collectUpToGivenParent
41− , EventFilterTriggerRef (..)
42− , wrap
43− , makeElement
44− , GhcjsDomHandler (..)
45− , GhcjsDomHandler1 (..)
46− , GhcjsDomEvent (..)
47− , GhcjsDomSpace
48− , GhcjsEventFilter (..)
49− , Pair1 (..)
50− , Maybe1 (..)
51− , GhcjsEventSpec (..)
52− , HasDocument (..)
53− , ghcjsEventSpec_filters
54− , ghcjsEventSpec_handler
55− , GhcjsEventHandler (..)
56−#ifndef USE_TEMPLATE_HASKELL
57− , phantom2
26+#ifdef ghcjs_HOST_OS
27+{-# LANGUAGE ForeignFunctionInterface #-}
28+{-# LANGUAGE JavaScriptFFI #-}
5829#endif
59− , drawChildUpdate
60− , mkHasFocus
61− , insertBefore
62− , EventType
63− , defaultDomEventHandler
64− , defaultDomWindowEventHandler
65− , withIsEvent
66− , showEventName
67− , elementOnEventName
68− , windowOnEventName
69− , wrapDomEvent
70− , subscribeDomEvent
71− , wrapDomEventMaybe
72− , wrapDomEventsMaybe
73− , getKeyEvent
74− , getMouseEventCoords
75− , getTouchEvent
76− , WindowConfig (..)
77− , Window (..)
78− , wrapWindow
79− ) where
80−
81−import Foreign.JavaScript.TH
82−import Reflex.Class as Reflex
83−import Reflex.Dom.Builder.Class
84−import Reflex.Dynamic
85−import Reflex.DynamicWriter (DynamicWriterT)
86−import Reflex.EventWriter (EventWriterT)
87−import Reflex.Host.Class
88−import qualified Reflex.Patch.DMap as PatchDMap
89−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
90−import Reflex.PerformEvent.Class
91−import Reflex.PostBuild.Base
92−import Reflex.PostBuild.Class
93−import Reflex.TriggerEvent.Base hiding (askEvents)
94−import qualified Reflex.TriggerEvent.Base as TriggerEventT (askEvents)
95−import Reflex.TriggerEvent.Class
30+-- | This is a builder to be used on the client side. It can be run in two modes:
31+--
32+-- 1. in "hydration mode", reusing DOM nodes already in the page (as produced
33+-- by 'Reflex.Dom.Builder.Static.renderStatic')
34+-- 2. in "immediate mode", creating and appending DOM nodes as required
35+--
36+-- In "hydration mode", the preexisting DOM __must contain__ what the builder
37+-- will expect at switchover time (the time at which parity with the static
38+-- renderer is reached, and the time after which the page is "live").
39+--
40+-- For example, displaying the current time as text should be done inside
41+-- 'Reflex.Dom.Prerender.prerender' to ensure that we don't attempt to hydrate the incorrect text.
42+-- The server will prerender a text node with time A, and the client will expect
43+-- a text node with time B. Barring a miracle, time A and time B will not match,
44+-- and hydration will fail.
45+module Reflex.Dom.Builder.Immediate
46+ ( HydrationDomBuilderT (..)
47+ , HydrationDomBuilderEnv (..)
48+ , HydrationMode (..)
49+ , HydrationRunnerT (..)
50+ , runHydrationRunnerT
51+ , runHydrationRunnerTWithFailure
52+ , ImmediateDomBuilderT
53+ , runHydrationDomBuilderT
54+ , getHydrationMode
55+ , addHydrationStep
56+ , addHydrationStepWithSetup
57+ , setPreviousNode
58+ , insertAfterPreviousNode
59+ , hydrateComment
60+ , askParent
61+ , askEvents
62+ , append
63+ , textNodeInternal
64+ , removeSubsequentNodes
65+ , deleteBetweenExclusive
66+ , extractBetweenExclusive
67+ , deleteUpTo
68+ , extractUpTo
69+ , SupportsHydrationDomBuilder
70+ , collectUpTo
71+ , collectUpToGivenParent
72+ , EventTriggerRef (..)
73+ , EventFilterTriggerRef (..)
74+ , wrap
75+ , elementInternal
76+ , HydrationDomSpace
77+ , GhcjsDomSpace
78+ , GhcjsDomHandler (..)
79+ , GhcjsDomHandler1 (..)
80+ , GhcjsDomEvent (..)
81+ , GhcjsEventFilter (..)
82+ , Pair1 (..)
83+ , Maybe1 (..)
84+ , GhcjsEventSpec (..)
85+ , HasDocument (..)
86+ , ghcjsEventSpec_filters
87+ , ghcjsEventSpec_handler
88+ , GhcjsEventHandler (..)
89+ , drawChildUpdate
90+ , ChildReadyState (..)
91+ , mkHasFocus
92+ , insertBefore
93+ , EventType
94+ , defaultDomEventHandler
95+ , defaultDomWindowEventHandler
96+ , withIsEvent
97+ , showEventName
98+ , elementOnEventName
99+ , windowOnEventName
100+ , wrapDomEvent
101+ , subscribeDomEvent
102+ , wrapDomEventMaybe
103+ , wrapDomEventsMaybe
104+ , getKeyEvent
105+ , getMouseEventCoords
106+ , getTouchEvent
107+ , WindowConfig (..)
108+ , Window (..)
109+ , wrapWindow
110+ -- * Attributes for controlling hydration
111+ , hydratableAttribute
112+ , skipHydrationAttribute
113+ -- * Internal
114+ , traverseDMapWithKeyWithAdjust'
115+ , hoistTraverseWithKeyWithAdjust
116+ , traverseIntMapWithKeyWithAdjust'
117+ , hoistTraverseIntMapWithKeyWithAdjust
118+ ) where
96119
97120import Control.Concurrent
98−import Control.Lens hiding (element, ix)
121+import Control.Exception (bracketOnError)
122+import Control.Lens (Identity(..), imapM_, iforM_, (^.), makeLenses)
99123import Control.Monad.Exception
100124import Control.Monad.Primitive
101125import Control.Monad.Reader
102126import Control.Monad.Ref
103−import Control.Monad.State.Strict (StateT)
104−import qualified Control.Monad.State as Lazy (StateT)
105−#ifndef USE_TEMPLATE_HASKELL
106−import Data.Functor.Contravariant (phantom)
107−#endif
127+import Control.Monad.State.Strict (StateT, mapStateT, get, modify', gets, runStateT)
108128import Data.Bitraversable
109129import Data.Default
110130import Data.Dependent.Map (DMap)
111−import qualified Data.Dependent.Map as DMap
112131import Data.Dependent.Sum
132+import Data.FastMutableIntMap (PatchIntMap (..))
133+import Data.Foldable (for_, traverse_)
113134import Data.Functor.Compose
114135import Data.Functor.Constant
115136import Data.Functor.Misc
116137import Data.Functor.Product
138+import Data.GADT.Compare (GCompare)
117139import Data.IORef
118−import qualified Data.Map as Map
140+import Data.IntMap.Strict (IntMap)
119141import Data.Maybe
120−import Data.Monoid hiding (Product)
121−import Data.Some (Some)
122−import qualified Data.Some as Some
142+import Data.Monoid ((<>))
143+import Data.Some (Some(..))
144+import Data.GADT.Compare (GCompare)
145+import Data.String (IsString)
123146import Data.Text (Text)
147+import Foreign.JavaScript.Internal.Utils
148+import Foreign.JavaScript.TH
149+import GHCJS.DOM.ClipboardEvent as ClipboardEvent
150+import GHCJS.DOM.Document (Document, createDocumentFragment, createElement, createElementNS, createTextNode, createComment)
151+import GHCJS.DOM.Element (getScrollTop, removeAttribute, removeAttributeNS, setAttribute, setAttributeNS, hasAttribute)
152+import GHCJS.DOM.EventM (EventM, event, on)
153+import GHCJS.DOM.KeyboardEvent as KeyboardEvent
154+import GHCJS.DOM.MouseEvent
155+import GHCJS.DOM.Node (appendChild_, getOwnerDocumentUnchecked, getParentNodeUnchecked, setNodeValue, toNode)
156+import GHCJS.DOM.Types (liftJSM, askJSM, runJSM, JSM, MonadJSM, FocusEvent, IsElement, IsEvent, IsNode, KeyboardEvent, Node, TouchEvent, WheelEvent, uncheckedCastTo, ClipboardEvent)
157+import GHCJS.DOM.UIEvent
158+import Language.Javascript.JSaddle (call, eval)
159+import Reflex.Adjustable.Class
160+import Reflex.Class as Reflex
161+import Reflex.Dom.Builder.Class
162+import Reflex.Dynamic
163+import Reflex.Host.Class
164+import Reflex.Patch.DMapWithMove (PatchDMapWithMove(..))
165+import Reflex.Patch.MapWithMove (PatchMapWithMove(..))
166+import Reflex.PerformEvent.Base (PerformEventT)
167+import Reflex.PerformEvent.Class
168+import Reflex.PostBuild.Base (PostBuildT)
169+import Reflex.PostBuild.Class
170+#ifdef PROFILE_REFLEX
171+import Reflex.Profiled
172+#endif
173+import Reflex.Requester.Base
174+import Reflex.Requester.Class
175+import Reflex.Spider (Spider, SpiderHost, Global)
176+import Reflex.TriggerEvent.Base hiding (askEvents)
177+import Reflex.TriggerEvent.Class
178+
179+import qualified Data.Dependent.Map as DMap
180+import qualified Data.FastMutableIntMap as FastMutableIntMap
181+import qualified Data.IntMap.Strict as IntMap
182+import qualified Data.Map as Map
124183import qualified Data.Text as T
125184import qualified GHCJS.DOM as DOM
126−import GHCJS.DOM.RequestAnimationFrameCallback
127−import GHCJS.DOM.Document (Document, createDocumentFragment, createElement, createElementNS, createTextNode)
128−import GHCJS.DOM.Element (getScrollTop, removeAttribute, removeAttributeNS, setAttribute, setAttributeNS)
185+import qualified GHCJS.DOM.DataTransfer as DataTransfer
186+import qualified GHCJS.DOM.DocumentAndElementEventHandlers as Events
187+import qualified GHCJS.DOM.DocumentOrShadowRoot as Document
129188import qualified GHCJS.DOM.Element as Element
130189import qualified GHCJS.DOM.Event as Event
131−import qualified GHCJS.DOM.GlobalEventHandlers as Events
132−import qualified GHCJS.DOM.DocumentAndElementEventHandlers as Events
133−import GHCJS.DOM.EventM (EventM, event, on)
134190import qualified GHCJS.DOM.EventM as DOM
135191import qualified GHCJS.DOM.FileList as FileList
192+import qualified GHCJS.DOM.GlobalEventHandlers as Events
136193import qualified GHCJS.DOM.HTMLInputElement as Input
137194import qualified GHCJS.DOM.HTMLSelectElement as Select
138195import qualified GHCJS.DOM.HTMLTextAreaElement as TextArea
139−import GHCJS.DOM.MouseEvent
196+import qualified GHCJS.DOM.Node as Node
197+import qualified GHCJS.DOM.Text as DOM
140198import qualified GHCJS.DOM.Touch as Touch
141199import qualified GHCJS.DOM.TouchEvent as TouchEvent
142200import qualified GHCJS.DOM.TouchList as TouchList
143−import GHCJS.DOM.Node (appendChild_, getOwnerDocumentUnchecked, getParentNodeUnchecked, setNodeValue, toNode)
144−import qualified GHCJS.DOM.Node as DOM (insertBefore_)
145−import GHCJS.DOM.Types
146− (liftJSM, askJSM, runJSM, JSM, MonadJSM,
147− FocusEvent, IsElement, IsEvent, IsNode, KeyboardEvent, Node,
148− ToDOMString, TouchEvent, WheelEvent, uncheckedCastTo, ClipboardEvent)
149201import qualified GHCJS.DOM.Types as DOM
150−import GHCJS.DOM.UIEvent
151−import GHCJS.DOM.KeyboardEvent as KeyboardEvent
152202import qualified GHCJS.DOM.Window as Window
153−import Language.Javascript.JSaddle (call, eval)
203+import qualified GHCJS.DOM.WheelEvent as WheelEvent
204+import qualified Reflex.Patch.DMap as PatchDMap
205+import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
206+import qualified Reflex.Patch.MapWithMove as PatchMapWithMove
207+import qualified Reflex.TriggerEvent.Base as TriggerEventT (askEvents)
154208
155−import Reflex.Requester.Base
156−import Reflex.Requester.Class
157−import Foreign.JavaScript.Internal.Utils
209+#ifndef USE_TEMPLATE_HASKELL
210+import Data.Functor.Contravariant (phantom)
211+import Control.Lens (Lens', Getter)
212+#endif
158213
159214#ifndef ghcjs_HOST_OS
160215import GHCJS.DOM.Types (MonadJSM (..))
161216
162−instance MonadJSM m => MonadJSM (ImmediateDomBuilderT t m) where
163− liftJSM' = ImmediateDomBuilderT . liftJSM'
217+instance MonadJSM m => MonadJSM (HydrationRunnerT t m) where
218+ {-# INLINABLE liftJSM' #-}
219+ liftJSM' = lift . liftJSM'
220+
221+instance MonadJSM m => MonadJSM (HydrationDomBuilderT s t m) where
222+ {-# INLINABLE liftJSM' #-}
223+ liftJSM' = lift . liftJSM'
224+
225+instance MonadJSM m => MonadJSM (DomRenderHookT t m) where
226+ {-# INLINABLE liftJSM' #-}
227+ liftJSM' = lift . liftJSM'
164228#endif
165229
166−data ImmediateDomBuilderEnv t
167− = ImmediateDomBuilderEnv { _immediateDomBuilderEnv_document :: Document
168− , _immediateDomBuilderEnv_parent :: Node
169− , _immediateDomBuilderEnv_unreadyChildren :: IORef Word -- Number of children who still aren't fully rendered
170− , _immediateDomBuilderEnv_commitAction :: JSM () -- Action to take when all children are ready --TODO: we should probably get rid of this once we invoke it
171− }
230+data HydrationDomBuilderEnv t m = HydrationDomBuilderEnv
231+ { _hydrationDomBuilderEnv_document :: {-# UNPACK #-} !Document
232+ -- ^ Reference to the document
233+ , _hydrationDomBuilderEnv_parent :: !(Either Node (IORef Node))
234+ -- ^ This is in an IORef because in the time up to hydration we can't actually know what the
235+ -- parent is - we populate this reference during the DOM traversal at hydration time
236+ , _hydrationDomBuilderEnv_unreadyChildren :: {-# UNPACK #-} !(IORef Word)
237+ -- ^ Number of children who still aren't fully rendered
238+ , _hydrationDomBuilderEnv_commitAction :: !(JSM ())
239+ -- ^ Action to take when all children are ready --TODO: we should probably get rid of this once we invoke it
240+ , _hydrationDomBuilderEnv_hydrationMode :: {-# UNPACK #-} !(IORef HydrationMode)
241+ -- ^ In hydration mode? Should be switched to `HydrationMode_Immediate` after hydration is finished
242+ , _hydrationDomBuilderEnv_switchover :: !(Event t ())
243+ , _hydrationDomBuilderEnv_delayed :: {-# UNPACK #-} !(IORef (HydrationRunnerT t m ()))
244+ }
172245
173−newtype ImmediateDomBuilderT t m a = ImmediateDomBuilderT { unImmediateDomBuilderT :: ReaderT (ImmediateDomBuilderEnv t) (RequesterT t JSM Identity (TriggerEventT t m)) a }
246+-- | A monad for DomBuilder which just gets the results of children and pushes
247+-- work into an action that is delayed until after postBuild (to match the
248+-- static builder). The action runs in 'HydrationRunnerT', which performs the
249+-- DOM takeover and sets up the events, after which point this monad will
250+-- continue in the vein of 'ImmediateDomBuilderT'.
251+newtype HydrationDomBuilderT s t m a = HydrationDomBuilderT { unHydrationDomBuilderT :: ReaderT (HydrationDomBuilderEnv t m) (DomRenderHookT t m) a }
174252 deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
175253#if MIN_VERSION_base(4,9,1)
176254 , MonadAsyncException
177255#endif
178256 )
179257
180−instance PrimMonad m => PrimMonad (ImmediateDomBuilderT x m) where
181− type PrimState (ImmediateDomBuilderT x m) = PrimState m
258+instance PrimMonad m => PrimMonad (HydrationDomBuilderT s t m) where
259+ type PrimState (HydrationDomBuilderT s t m) = PrimState m
182260 primitive = lift . primitive
183261
184−instance MonadTrans (ImmediateDomBuilderT t) where
185− lift = ImmediateDomBuilderT . lift . lift . lift
262+instance MonadTrans (HydrationDomBuilderT s t) where
263+ lift = HydrationDomBuilderT . lift . lift
186264
187−instance (Reflex t, PrimMonad m) => DomRenderHook t (ImmediateDomBuilderT t m) where
188− withRenderHook hook (ImmediateDomBuilderT a) = do
189− e <- ImmediateDomBuilderT ask
190− ImmediateDomBuilderT $ lift $ withRequesting $ \rsp -> do
191− (x, req) <- lift $ runRequesterT (runReaderT a e) $ runIdentity <$> rsp
192− return (ffor req $ \rm -> hook $ DMap.traverseWithKey (\_ r -> Identity <$> r) rm, x)
193− requestDomAction = ImmediateDomBuilderT . lift . requestingIdentity
194− requestDomAction_ = ImmediateDomBuilderT . lift . requesting_
265+instance (Reflex t, MonadFix m) => DomRenderHook t (HydrationDomBuilderT s t m) where
266+ withRenderHook hook = HydrationDomBuilderT . mapReaderT (withRenderHook hook) . unHydrationDomBuilderT
267+ requestDomAction = HydrationDomBuilderT . lift . requestDomAction
268+ requestDomAction_ = HydrationDomBuilderT . lift . requestDomAction_
195269
196−{-# INLINABLE runImmediateDomBuilderT #-}
197−runImmediateDomBuilderT
270+-- | The monad which performs the delayed actions to reuse prerendered nodes and set up events.
271+-- State contains reference to the previous node sibling, if any, and the reader contains reference to the parent node.
272+newtype HydrationRunnerT t m a = HydrationRunnerT { unHydrationRunnerT :: StateT HydrationState (ReaderT Node (DomRenderHookT t m)) a }
273+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
274+#if MIN_VERSION_base(4,9,1)
275+ , MonadAsyncException
276+#endif
277+ )
278+
279+data HydrationState = HydrationState
280+ { _hydrationState_previousNode :: !(Maybe Node)
281+ , _hydrationState_failed :: !Bool
282+ }
283+
284+{-# INLINABLE localRunner #-}
285+localRunner :: (MonadJSM m, Monad m) => HydrationRunnerT t m a -> Maybe Node -> Node -> HydrationRunnerT t m a
286+localRunner (HydrationRunnerT m) s parent = do
287+ s0 <- HydrationRunnerT get
288+ (a, s') <- HydrationRunnerT $ lift $ local (\_ -> parent) $ runStateT m (s0 { _hydrationState_previousNode = s })
289+ traverse_ removeSubsequentNodes $ _hydrationState_previousNode s'
290+ HydrationRunnerT $ modify' $ \hs -> hs { _hydrationState_failed = _hydrationState_failed s' }
291+ pure a
292+
293+{-# INLINABLE runHydrationRunnerT #-}
294+runHydrationRunnerT
295+ :: (MonadRef m, Ref m ~ IORef, Monad m, PerformEvent t m, MonadFix m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m))
296+ => HydrationRunnerT t m a -> Maybe Node -> Node -> Chan [DSum (EventTriggerRef t) TriggerInvocation] -> m a
297+runHydrationRunnerT m = runHydrationRunnerTWithFailure m (pure ())
298+
299+{-# INLINABLE runHydrationRunnerTWithFailure #-}
300+runHydrationRunnerTWithFailure
301+ :: (MonadRef m, Ref m ~ IORef, Monad m, PerformEvent t m, MonadFix m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m))
302+ => HydrationRunnerT t m a -> IO () -> Maybe Node -> Node -> Chan [DSum (EventTriggerRef t) TriggerInvocation] -> m a
303+runHydrationRunnerTWithFailure (HydrationRunnerT m) onFailure s parent events = flip runDomRenderHookT events $ flip runReaderT parent $ do
304+ (a, s') <- runStateT m (HydrationState s False)
305+ traverse_ removeSubsequentNodes $ _hydrationState_previousNode s'
306+ when (_hydrationState_failed s') $ liftIO $ putStrLn "reflex-dom warning: hydration failed: the DOM was not as expected at switchover time. This may be due to invalid HTML which the browser has altered upon parsing, some external JS altering the DOM, or the page being served from an outdated cache."
307+ when (_hydrationState_failed s') $ liftIO onFailure
308+ pure a
309+
310+
311+
312+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydrationRunnerT t m) where
313+ {-# INLINABLE newEventWithTrigger #-}
314+ newEventWithTrigger = lift . newEventWithTrigger
315+ {-# INLINABLE newFanEventWithTrigger #-}
316+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
317+
318+instance MonadTrans (HydrationRunnerT t) where
319+ {-# INLINABLE lift #-}
320+ lift = HydrationRunnerT . lift . lift . lift
321+
322+instance MonadSample t m => MonadSample t (HydrationRunnerT t m) where
323+ {-# INLINABLE sample #-}
324+ sample = lift . sample
325+
326+instance (Reflex t, MonadFix m) => DomRenderHook t (HydrationRunnerT t m) where
327+ withRenderHook hook = HydrationRunnerT . mapStateT (mapReaderT (withRenderHook hook)) . unHydrationRunnerT
328+ requestDomAction = HydrationRunnerT . lift . lift . requestDomAction
329+ requestDomAction_ = HydrationRunnerT . lift . lift . requestDomAction_
330+
331+-- | Add a hydration step which depends on some computation that should only be
332+-- done *before* the switchover to immediate mode - this is most likely some
333+-- form of 'hold' which we want to remove after hydration is done
334+{-# INLINABLE addHydrationStepWithSetup #-}
335+addHydrationStepWithSetup :: MonadIO m => m a -> (a -> HydrationRunnerT t m ()) -> HydrationDomBuilderT s t m ()
336+addHydrationStepWithSetup setup f = getHydrationMode >>= \case
337+ HydrationMode_Immediate -> pure ()
338+ HydrationMode_Hydrating -> do
339+ s <- lift setup
340+ addHydrationStep (f s)
341+
342+-- | Add a hydration step
343+{-# INLINABLE addHydrationStep #-}
344+addHydrationStep :: MonadIO m => HydrationRunnerT t m () -> HydrationDomBuilderT s t m ()
345+addHydrationStep m = do
346+ delayedRef <- HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_delayed
347+ liftIO $ modifyIORef' delayedRef (>> m)
348+
349+-- | Shared behavior for HydrationDomBuilderT and HydrationRunnerT
350+newtype DomRenderHookT t m a = DomRenderHookT { unDomRenderHookT :: RequesterT t JSM Identity (TriggerEventT t m) a }
351+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
352+#if MIN_VERSION_base(4,9,1)
353+ , MonadAsyncException
354+#endif
355+ )
356+
357+{-# INLINABLE runDomRenderHookT #-}
358+runDomRenderHookT
359+ :: (MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m), MonadRef m, Ref m ~ IORef)
360+ => DomRenderHookT t m a
361+ -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
362+ -> m a
363+runDomRenderHookT (DomRenderHookT a) events = do
364+ flip runTriggerEventT events $ do
365+ rec (result, req) <- runRequesterT a rsp
366+ rsp <- performEventAsync $ ffor req $ \rm f -> liftJSM $ runInAnimationFrame f $
367+ traverseRequesterData (fmap Identity) rm
368+ return result
369+ where
370+ runInAnimationFrame f x = void . DOM.inAnimationFrame' $ \_ -> do
371+ v <- synchronously x
372+ void . liftIO $ f v
373+
374+instance MonadTrans (DomRenderHookT t) where
375+ {-# INLINABLE lift #-}
376+ lift = DomRenderHookT . lift . lift
377+
378+instance (Reflex t, MonadFix m) => DomRenderHook t (DomRenderHookT t m) where
379+ withRenderHook hook (DomRenderHookT a) = do
380+ DomRenderHookT $ withRequesting $ \rsp -> do
381+ (x, req) <- lift $ runRequesterT a $ runIdentity <$> rsp
382+ return (ffor req $ \rm -> hook $ traverseRequesterData (fmap Identity) rm, x)
383+ requestDomAction = DomRenderHookT . requestingIdentity
384+ requestDomAction_ = DomRenderHookT . requesting_
385+
386+{-# INLINABLE runHydrationDomBuilderT #-}
387+runHydrationDomBuilderT
198388 :: ( MonadFix m
199389 , PerformEvent t m
200390 , MonadReflexCreateTrigger t m
@@ -203,66 +393,76 @@ runImmediateDomBuilderT
203393 , MonadRef m
204394 , Ref m ~ IORef
205395 )
206− => ImmediateDomBuilderT t m a
207− -> ImmediateDomBuilderEnv t
396+ => HydrationDomBuilderT s t m a
397+ -> HydrationDomBuilderEnv t m
208398 -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
209399 -> m a
210−runImmediateDomBuilderT (ImmediateDomBuilderT a) env eventChan = flip runTriggerEventT eventChan $ do
211− win <- DOM.currentWindowUnchecked
212− rec (x, req) <- runRequesterT (runReaderT a env) rsp
213− rsp <- performEventAsync $ ffor req $ \rm f -> liftJSM $ runInAnimationFrame win f $
214− DMap.traverseWithKey (\_ r -> Identity <$> r) rm
215− return x
216− where
217− runInAnimationFrame win f x = do
218− rec cb <- newRequestAnimationFrameCallbackSync $ \_ -> do
219− v <- synchronously x
220− _ <- liftIO $ f v
221− freeRequestAnimationFrameCallback cb
222− _ <- Window.requestAnimationFrame win cb
223− return ()
224−
225−class Monad m => HasDocument m where
226− askDocument :: m Document
227− default askDocument :: (m ~ f m', MonadTrans f, Monad m', HasDocument m') => f m' Document
228− askDocument = lift askDocument
229−
230−instance HasDocument m => HasDocument (ReaderT r m)
231−instance HasDocument m => HasDocument (StateT s m)
232−instance HasDocument m => HasDocument (Lazy.StateT s m)
233−instance HasDocument m => HasDocument (EventWriterT t w m)
234−instance HasDocument m => HasDocument (DynamicWriterT t w m)
235−instance HasDocument m => HasDocument (PostBuildT t m)
236−
237−instance Monad m => HasDocument (ImmediateDomBuilderT t m) where
400+runHydrationDomBuilderT (HydrationDomBuilderT a) env = runDomRenderHookT (runReaderT a env)
401+
402+instance (RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, Monad m) => HasDocument (HydrationDomBuilderT s t m) where
238403 {-# INLINABLE askDocument #-}
239− askDocument = ImmediateDomBuilderT $ asks _immediateDomBuilderEnv_document
404+ askDocument = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_document
240405
241406{-# INLINABLE askParent #-}
242−askParent :: Monad m => ImmediateDomBuilderT t m Node
243−askParent = ImmediateDomBuilderT $ asks _immediateDomBuilderEnv_parent
407+askParent :: Monad m => HydrationRunnerT t m DOM.Node
408+askParent = HydrationRunnerT ask
409+
410+{-# INLINABLE getParent #-}
411+getParent :: MonadIO m => HydrationDomBuilderT s t m DOM.Node
412+getParent = either pure (liftIO . readIORef) =<< HydrationDomBuilderT (asks _hydrationDomBuilderEnv_parent)
244413
245414{-# INLINABLE askEvents #-}
246−askEvents :: Monad m => ImmediateDomBuilderT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
247−askEvents = ImmediateDomBuilderT . lift . lift $ TriggerEventT.askEvents
415+askEvents :: Monad m => HydrationDomBuilderT s t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
416+askEvents = HydrationDomBuilderT . lift . DomRenderHookT . lift $ TriggerEventT.askEvents
248417
249−localEnv :: Monad m => (ImmediateDomBuilderEnv t -> ImmediateDomBuilderEnv t) -> ImmediateDomBuilderT t m a -> ImmediateDomBuilderT t m a
250−localEnv f = ImmediateDomBuilderT . local f . unImmediateDomBuilderT
418+{-# INLINABLE localEnv #-}
419+localEnv :: Monad m => (HydrationDomBuilderEnv t m -> HydrationDomBuilderEnv t m) -> HydrationDomBuilderT s t m a -> HydrationDomBuilderT s t m a
420+localEnv f = HydrationDomBuilderT . local (f $!) . unHydrationDomBuilderT
251421
252422{-# INLINABLE append #-}
253−append :: (IsNode n, MonadJSM m) => n -> ImmediateDomBuilderT t m ()
423+append :: MonadJSM m => DOM.Node -> HydrationDomBuilderT s t m ()
254424append n = do
255− p <- askParent
425+ p <- getParent
256426 liftJSM $ appendChild_ p n
257427 return ()
258428
259−{-# INLINABLE textNodeInternal #-}
260−textNodeInternal :: (MonadJSM m, ToDOMString contents) => contents -> ImmediateDomBuilderT t m DOM.Text
261−textNodeInternal t = do
262− doc <- askDocument
263− n <- liftJSM $ createTextNode doc t
264− append n
265− return n
429+{-# SPECIALIZE append
430+ :: DOM.Node
431+ -> HydrationDomBuilderT s Spider HydrationM ()
432+ #-}
433+
434+data HydrationMode
435+ = HydrationMode_Hydrating
436+ -- ^ The time from initial load to parity with static builder
437+ | HydrationMode_Immediate
438+ -- ^ After hydration
439+ deriving (Eq, Ord, Show)
440+
441+{-# INLINABLE getPreviousNode #-}
442+getPreviousNode :: Monad m => HydrationRunnerT t m (Maybe DOM.Node)
443+getPreviousNode = HydrationRunnerT $ gets _hydrationState_previousNode
444+
445+{-# INLINABLE setPreviousNode #-}
446+setPreviousNode :: Monad m => Maybe DOM.Node -> HydrationRunnerT t m ()
447+setPreviousNode n = HydrationRunnerT $ modify' (\hs -> hs { _hydrationState_previousNode = n })
448+
449+{-# INLINABLE askUnreadyChildren #-}
450+askUnreadyChildren :: Monad m => HydrationDomBuilderT s t m (IORef Word)
451+askUnreadyChildren = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_unreadyChildren
452+
453+{-# INLINABLE askCommitAction #-}
454+askCommitAction :: Monad m => HydrationDomBuilderT s t m (JSM ())
455+askCommitAction = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_commitAction
456+
457+{-# INLINABLE getHydrationMode #-}
458+getHydrationMode :: MonadIO m => HydrationDomBuilderT s t m HydrationMode
459+getHydrationMode = liftIO . readIORef =<< HydrationDomBuilderT (asks _hydrationDomBuilderEnv_hydrationMode)
460+
461+-- | Remove all nodes after given node
462+removeSubsequentNodes :: (MonadJSM m, IsNode n) => n -> m ()
463+removeSubsequentNodes n = liftJSM $ do
464+ f <- eval ("(function(n) { while (n.nextSibling) { (n.parentNode).removeChild(n.nextSibling); }; })" :: Text)
465+ void $ call f f [n]
266466
267467-- | s and e must both be children of the same node and s must precede e;
268468-- all nodes between s and e will be removed, but s and e will not be removed
@@ -276,16 +476,7 @@ deleteBetweenExclusive s e = liftJSM $ do
276476-- and e will not be moved
277477extractBetweenExclusive :: (MonadJSM m, IsNode start, IsNode end) => DOM.DocumentFragment -> start -> end -> m ()
278478extractBetweenExclusive df s e = liftJSM $ do
279− f <- eval $ T.unlines
280− [ "(function(df,s,e){"
281− , " var x;"
282− , " for(;;){"
283− , " x = s.nextSibling;"
284− , " if(e===x) break;"
285− , " df.appendChild(x);"
286− , " }"
287− , "})"
288− ]
479+ f <- eval ("(function(df,s,e) { var x; for(;;) { x = s['nextSibling']; if(e===x) { break; }; df['appendChild'](x); } })" :: Text)
289480 void $ call f f (df, s, e)
290481
291482-- | s and e must both be children of the same node and s must precede e;
@@ -297,22 +488,19 @@ deleteUpTo s e = do
297488 extractUpTo df s e -- In many places in ImmediateDomBuilderT, we assume that things always have a parent; by adding them to this DocumentFragment, we maintain that invariant
298489
299490extractUpTo :: (MonadJSM m, IsNode start, IsNode end) => DOM.DocumentFragment -> start -> end -> m ()
491+#ifdef ghcjs_HOST_OS
492+--NOTE: Although wrapping this javascript in a function seems unnecessary, GHCJS's optimizer will break it if it is entered without that wrapping (as of 2017-09-04)
493+foreign import javascript unsafe
494+ "(function() { var x = $2; while(x !== $3) { var y = x['nextSibling']; $1['appendChild'](x); x = y; } })()"
495+ extractUpTo_ :: DOM.DocumentFragment -> DOM.Node -> DOM.Node -> IO ()
496+extractUpTo df s e = liftJSM $ extractUpTo_ df (toNode s) (toNode e)
497+#else
300498extractUpTo df s e = liftJSM $ do
301− f <- eval $ T.unlines
302− [ "(function(df,s,e){"
303− , " var x = s;"
304− , " var y;"
305− , " for(;;) {"
306− , " y = x.nextSibling;"
307− , " df.appendChild(x);"
308− , " if(e===y) break;"
309− , " x = y;"
310− , " }"
311− , "})"
312− ]
499+ f <- eval ("(function(df,s,e){ var x = s; var y; for(;;) { y = x['nextSibling']; df['appendChild'](x); if(e===y) { break; } x = y; } })" :: Text)
313500 void $ call f f (df, s, e)
501+#endif
314502
315−type SupportsImmediateDomBuilder t m = (Reflex t, MonadJSM m, MonadHold t m, MonadFix m, MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref JSM, MonadAdjust t m, PrimMonad m)
503+type SupportsHydrationDomBuilder t m = (Reflex t, MonadJSM m, MonadHold t m, MonadFix m, MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref JSM, Adjustable t m, PrimMonad m, PerformEvent t m, MonadJSM (Performable m))
316504
317505{-# INLINABLE collectUpTo #-}
318506collectUpTo :: (MonadJSM m, IsNode start, IsNode end) => start -> end -> m DOM.DocumentFragment
@@ -330,9 +518,15 @@ collectUpToGivenParent currentParent s e = do
330518
331519newtype EventFilterTriggerRef t er (en :: EventTag) = EventFilterTriggerRef (IORef (Maybe (EventTrigger t (er en))))
332520
333−wrap :: forall m er t. SupportsImmediateDomBuilder t m => RawElement GhcjsDomSpace -> RawElementConfig er t GhcjsDomSpace -> ImmediateDomBuilderT t m (Element er GhcjsDomSpace t)
334−wrap e cfg = do
335− events <- askEvents
521+-- | This 'wrap' is only partial: it doesn't create the 'EventSelector' itself
522+{-# INLINE wrap #-}
523+wrap
524+ :: forall s m er t. (Reflex t, MonadJSM m, MonadReflexCreateTrigger t m, DomRenderHook t m, EventSpec s ~ GhcjsEventSpec)
525+ => Chan [DSum (EventTriggerRef t) TriggerInvocation]
526+ -> DOM.Element
527+ -> RawElementConfig er t s
528+ -> m (DMap EventName (EventFilterTriggerRef t er))
529+wrap events e cfg = do
336530 forM_ (_rawElementConfig_modifyAttributes cfg) $ \modifyAttrs -> requestDomAction_ $ ffor modifyAttrs $ imapM_ $ \(AttributeName mAttrNamespace n) mv -> case mAttrNamespace of
337531 Nothing -> maybe (removeAttribute e n) (setAttribute e n) mv
338532 Just ns -> maybe (removeAttributeNS e (Just ns) n) (setAttributeNS e (Just ns) n) mv
@@ -349,46 +543,74 @@ wrap e cfg = do
349543 mv <- liftJSM k --TODO: Only do this when the event is subscribed
350544 liftIO $ forM_ mv $ \v -> writeChan events [EventTriggerRef triggerRef :=> TriggerInvocation v (return ())]
351545 return $ en :=> EventFilterTriggerRef triggerRef
352− es <- do
353− let h :: GhcjsEventHandler er
354− !h = _ghcjsEventSpec_handler $ _rawElementConfig_eventSpec cfg -- Note: this needs to be done strictly and outside of the newFanEventWithTrigger, so that the newFanEventWithTrigger doesn't retain the entire cfg, which can cause a cyclic dependency that the GC won't be able to clean up
355− ctx <- askJSM
356− newFanEventWithTrigger $ \(WrapArg en) t ->
357− case DMap.lookup en eventTriggerRefs of
358− Just (EventFilterTriggerRef r) -> do
359− writeIORef r $ Just t
360− return $ do
361− writeIORef r Nothing
362− Nothing -> (`runJSM` ctx) <$> (`runJSM` ctx) (elementOnEventName en e $ do
363− evt <- DOM.event
364− mv <- lift $ unGhcjsEventHandler h (en, GhcjsDomEvent evt)
365− case mv of
366− Nothing -> return ()
367− Just v -> liftIO $ do
368− --TODO: I don't think this is quite right: if a new trigger is created between when this is enqueued and when it fires, this may not work quite right
369− ref <- newIORef $ Just t
370− writeChan events [EventTriggerRef ref :=> TriggerInvocation v (return ())])
371− return $ Element
372− { _element_events = es
373− , _element_raw = e
374− }
375−
376−{-# INLINABLE makeElement #-}
377−makeElement :: forall er t m a. SupportsImmediateDomBuilder t m => Text -> ElementConfig er t GhcjsDomSpace -> ImmediateDomBuilderT t m a -> ImmediateDomBuilderT t m ((Element er GhcjsDomSpace t, a), DOM.Element)
378−makeElement elementTag cfg child = do
379− doc <- askDocument
380− e <- liftJSM $ uncheckedCastTo DOM.Element <$> case cfg ^. namespace of
381− Nothing -> createElement doc elementTag
382− Just ens -> createElementNS doc (Just ens) elementTag
383− ImmediateDomBuilderT $ iforM_ (cfg ^. initialAttributes) $ \(AttributeName mAttrNamespace n) v -> case mAttrNamespace of
384− Nothing -> lift $ setAttribute e n v
385− Just ans -> lift $ setAttributeNS e (Just ans) n v
386− result <- flip localEnv child $ \env -> env
387− { _immediateDomBuilderEnv_parent = toNode e
388− }
389− append e
390− wrapped <- wrap e $ extractRawElementConfig cfg
391− return ((wrapped, result), e)
546+ return eventTriggerRefs
547+
548+{-# SPECIALIZE wrap
549+ :: Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
550+ -> DOM.Element
551+ -> RawElementConfig er DomTimeline HydrationDomSpace
552+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (DMap EventName (EventFilterTriggerRef DomTimeline er))
553+ #-}
554+
555+{-# SPECIALIZE wrap
556+ :: Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
557+ -> DOM.Element
558+ -> RawElementConfig er DomTimeline GhcjsDomSpace
559+ -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM (DMap EventName (EventFilterTriggerRef DomTimeline er))
560+ #-}
561+
562+{-# INLINE triggerBody #-}
563+triggerBody
564+ :: forall s er t x. EventSpec s ~ GhcjsEventSpec
565+ => DOM.JSContextRef
566+ -> RawElementConfig er t s
567+ -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
568+ -> DMap EventName (EventFilterTriggerRef t er)
569+ -> DOM.Element
570+ -> WrapArg er EventName x
571+ -> EventTrigger t x
572+ -> IO (IO ())
573+triggerBody ctx cfg events eventTriggerRefs e (WrapArg en) t = case DMap.lookup en eventTriggerRefs of
574+ Just (EventFilterTriggerRef r) -> do
575+ writeIORef r $ Just t
576+ return $ do
577+ writeIORef r Nothing
578+ Nothing -> (`runJSM` ctx) <$> (`runJSM` ctx) (elementOnEventName en e $ do
579+ evt <- DOM.event
580+ mv <- lift $ unGhcjsEventHandler handler (en, GhcjsDomEvent evt)
581+ case mv of
582+ Nothing -> return ()
583+ Just v -> liftIO $ do
584+ --TODO: I don't think this is quite right: if a new trigger is created between when this is enqueued and when it fires, this may not work quite right
585+ ref <- newIORef $ Just t
586+ writeChan events [EventTriggerRef ref :=> TriggerInvocation v (return ())])
587+ where
588+ -- Note: this needs to be done strictly and outside of the newFanEventWithTrigger, so that the newFanEventWithTrigger doesn't
589+ -- retain the entire cfg, which can cause a cyclic dependency that the GC won't be able to clean up
590+ handler :: GhcjsEventHandler er
591+ !handler = _ghcjsEventSpec_handler $ _rawElementConfig_eventSpec cfg
592+
593+{-# SPECIALIZE triggerBody
594+ :: DOM.JSContextRef
595+ -> RawElementConfig er DomTimeline HydrationDomSpace
596+ -> Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
597+ -> DMap EventName (EventFilterTriggerRef DomTimeline er)
598+ -> DOM.Element
599+ -> WrapArg er EventName x
600+ -> EventTrigger DomTimeline x
601+ -> IO (IO ())
602+ #-}
603+
604+{-# SPECIALIZE triggerBody
605+ :: DOM.JSContextRef
606+ -> RawElementConfig er DomTimeline GhcjsDomSpace
607+ -> Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
608+ -> DMap EventName (EventFilterTriggerRef DomTimeline er)
609+ -> DOM.Element
610+ -> WrapArg er EventName x
611+ -> EventTrigger DomTimeline x
612+ -> IO (IO ())
613+ #-}
392614
393615newtype GhcjsDomHandler a b = GhcjsDomHandler { unGhcjsDomHandler :: a -> JSM b }
394616
@@ -400,9 +622,10 @@ data GhcjsDomSpace
400622
401623instance DomSpace GhcjsDomSpace where
402624 type EventSpec GhcjsDomSpace = GhcjsEventSpec
625+ type RawDocument GhcjsDomSpace = DOM.Document
403626 type RawTextNode GhcjsDomSpace = DOM.Text
627+ type RawCommentNode GhcjsDomSpace = DOM.Comment
404628 type RawElement GhcjsDomSpace = DOM.Element
405− type RawFile GhcjsDomSpace = DOM.File
406629 type RawInputElement GhcjsDomSpace = DOM.HTMLInputElement
407630 type RawTextAreaElement GhcjsDomSpace = DOM.HTMLTextAreaElement
408631 type RawSelectElement GhcjsDomSpace = DOM.HTMLSelectElement
@@ -434,15 +657,11 @@ data GhcjsEventSpec er = GhcjsEventSpec
434657newtype GhcjsEventHandler er = GhcjsEventHandler { unGhcjsEventHandler :: forall en. (EventName en, GhcjsDomEvent en) -> JSM (Maybe (er en)) }
435658
436659#ifndef USE_TEMPLATE_HASKELL
437−phantom2 :: (Functor f, Contravariant f) => f a -> f b
438−phantom2 = phantom
439−{-# INLINE phantom2 #-}
440−
441660ghcjsEventSpec_filters :: forall er . Lens' (GhcjsEventSpec er) (DMap EventName (GhcjsEventFilter er))
442661ghcjsEventSpec_filters f (GhcjsEventSpec a b) = (\a' -> GhcjsEventSpec a' b) <$> f a
443662{-# INLINE ghcjsEventSpec_filters #-}
444663ghcjsEventSpec_handler :: forall er en . Getter (GhcjsEventSpec er) ((EventName en, GhcjsDomEvent en) -> JSM (Maybe (er en)))
445−ghcjsEventSpec_handler f (GhcjsEventSpec _ (GhcjsEventHandler b)) = phantom2 (f b)
664+ghcjsEventSpec_handler f (GhcjsEventSpec _ (GhcjsEventHandler b)) = phantom (f b)
446665{-# INLINE ghcjsEventSpec_handler #-}
447666#endif
448667
@@ -455,135 +674,795 @@ instance er ~ EventResult => Default (GhcjsEventSpec er) where
455674 runReaderT (defaultDomEventHandler e en) evt
456675 }
457676
458−instance SupportsImmediateDomBuilder t m => DomBuilder t (ImmediateDomBuilderT t m) where
459− type DomBuilderSpace (ImmediateDomBuilderT t m) = GhcjsDomSpace
460− {-# INLINABLE textNode #-}
461− textNode (TextNodeConfig initialContents mSetContents) = do
462− n <- textNodeInternal initialContents
463− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
464− return $ TextNode n
465− {-# INLINABLE element #-}
466− element elementTag cfg child = fst <$> makeElement elementTag cfg child
467− {-# INLINABLE inputElement #-}
468− inputElement cfg = do
469− ((e, _), domElement) <- makeElement "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
677+{-# INLINE makeElement #-}
678+makeElement :: MonadJSM m => Document -> Text -> ElementConfig er t s -> m DOM.Element
679+makeElement doc elementTag cfg = do
680+ e <- uncheckedCastTo DOM.Element <$> case cfg ^. namespace of
681+ Nothing -> createElement doc elementTag
682+ Just ens -> createElementNS doc (Just ens) elementTag
683+ iforM_ (cfg ^. initialAttributes) $ \(AttributeName mAttrNamespace n) v -> case mAttrNamespace of
684+ Nothing -> setAttribute e n v
685+ Just ans -> setAttributeNS e (Just ans) n v
686+ pure e
687+
688+{-# INLINE elementImmediate #-}
689+elementImmediate
690+ :: ( RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, EventSpec s ~ GhcjsEventSpec
691+ , MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m )
692+ => Text
693+ -> ElementConfig er t s
694+ -> HydrationDomBuilderT s t m a
695+ -> HydrationDomBuilderT s t m (Element er GhcjsDomSpace t, a)
696+elementImmediate elementTag cfg child = do
697+ doc <- askDocument
698+ ctx <- askJSM
699+ events <- askEvents
700+ parent <- getParent
701+ e <- makeElement doc elementTag cfg
702+ appendChild_ parent e
703+ -- Run the child builder with updated parent and previous sibling references
704+ result <- localEnv (\env -> env { _hydrationDomBuilderEnv_parent = Left $ toNode e }) child
705+ let rawCfg = extractRawElementConfig cfg
706+ eventTriggerRefs <- wrap events e rawCfg
707+ es <- newFanEventWithTrigger $ triggerBody ctx rawCfg events eventTriggerRefs e
708+ return (Element es e, result)
709+
710+{-# SPECIALIZE elementImmediate
711+ :: Text
712+ -> ElementConfig er DomTimeline HydrationDomSpace
713+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM a
714+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (Element er GhcjsDomSpace DomTimeline, a)
715+ #-}
716+
717+{-# SPECIALIZE elementImmediate
718+ :: Text
719+ -> ElementConfig er DomTimeline GhcjsDomSpace
720+ -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM a
721+ -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM (Element er GhcjsDomSpace DomTimeline, a)
722+ #-}
723+
724+-- For specialisation
725+
726+-- | The Reflex timeline for interacting with the DOM
727+type DomTimeline =
728+#ifdef PROFILE_REFLEX
729+ ProfiledTimeline
730+#endif
731+ Spider
732+
733+-- | The ReflexHost the DOM lives in
734+type DomHost =
735+#ifdef PROFILE_REFLEX
736+ ProfiledM
737+#endif
738+ (SpiderHost Global)
739+
740+type DomCoreWidget x = PostBuildT DomTimeline (WithJSContextSingleton x (PerformEventT DomTimeline DomHost))
741+type HydrationM = DomCoreWidget ()
742+
743+{-# INLINE elementInternal #-}
744+elementInternal
745+ :: (MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m)
746+ => Text
747+ -> ElementConfig er t HydrationDomSpace
748+ -> HydrationDomBuilderT HydrationDomSpace t m a
749+ -> HydrationDomBuilderT HydrationDomSpace t m (Element er HydrationDomSpace t, a)
750+elementInternal elementTag cfg child = getHydrationMode >>= \case
751+ HydrationMode_Immediate -> do
752+ (Element es _, result) <- elementImmediate elementTag cfg child
753+ return (Element es (), result)
754+ HydrationMode_Hydrating -> fst <$> hydrateElement elementTag cfg child
755+
756+{-# SPECIALIZE elementInternal
757+ :: Text
758+ -> ElementConfig er DomTimeline HydrationDomSpace
759+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM a
760+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (Element er HydrationDomSpace DomTimeline, a)
761+ #-}
762+
763+-- | An attribute which causes hydration to skip over an element completely.
764+skipHydrationAttribute :: IsString s => s
765+skipHydrationAttribute = "data-hydration-skip"
766+
767+-- | An attribute which signals that an element should be hydrated.
768+hydratableAttribute :: IsString s => s
769+hydratableAttribute = "data-ssr"
770+
771+{-# INLINE hydrateElement #-}
772+hydrateElement
773+ :: forall er t m a. (MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m)
774+ => Text
775+ -> ElementConfig er t HydrationDomSpace
776+ -> HydrationDomBuilderT HydrationDomSpace t m a
777+ -> HydrationDomBuilderT HydrationDomSpace t m ((Element er HydrationDomSpace t, a), IORef DOM.Element)
778+hydrateElement elementTag cfg child = do
779+ ctx <- askJSM
780+ events <- askEvents
781+ -- Schedule everything for after postBuild, except for getting the result itself
782+ parentRef <- liftIO $ newIORef $ error "Parent not yet initialized"
783+ e' <- liftIO $ newIORef $ error "hydrateElement: Element not yet initialized"
784+ env <- HydrationDomBuilderT ask
785+ childDelayedRef <- liftIO $ newIORef $ pure ()
786+ let env' = env
787+ { _hydrationDomBuilderEnv_parent = Right parentRef
788+ , _hydrationDomBuilderEnv_delayed = childDelayedRef
789+ }
790+ result <- HydrationDomBuilderT $ lift $ runReaderT (unHydrationDomBuilderT child) env'
791+ wrapResult <- liftIO newEmptyMVar
792+ let -- Determine if we should skip an element. We currently skip elements for
793+ -- two reasons:
794+ -- 1) it was not produced by a static builder which supports hydration
795+ -- 2) it is explicitly marked to be skipped
796+ shouldSkip :: DOM.Element -> HydrationRunnerT t m Bool
797+ shouldSkip e = do
798+ skip <- hasAttribute e (skipHydrationAttribute :: DOM.JSString)
799+ hydratable <- hasAttribute e (hydratableAttribute :: DOM.JSString)
800+ pure $ skip || not hydratable
801+ childDom <- liftIO $ readIORef childDelayedRef
802+ let rawCfg = extractRawElementConfig cfg
803+ doc <- askDocument
804+ addHydrationStep $ do
805+ parent <- askParent
806+ lastHydrationNode <- getPreviousNode
807+ let go mLastNode = maybe (Node.getFirstChild parent) Node.getNextSibling mLastNode >>= \case
808+ Nothing -> do -- ran out of nodes, create the element
809+ HydrationRunnerT $ modify' $ \s -> s { _hydrationState_failed = True }
810+ e <- makeElement doc elementTag cfg
811+ insertAfterPreviousNode e
812+ pure e
813+ Just node -> DOM.castTo DOM.Element node >>= \case
814+ Nothing -> go (Just node) -- this node is not an element, skip
815+ Just e -> shouldSkip e >>= \case
816+ True -> go (Just node) -- this element should be skipped by hydration
817+ False -> do
818+ t <- Element.getTagName e
819+ -- TODO: check attributes?
820+ if T.toCaseFold elementTag == T.toCaseFold t
821+ then pure e
822+ -- we came to some other statically rendered element, so something has gone wrong
823+ else do
824+ HydrationRunnerT $ modify' $ \s -> s { _hydrationState_failed = True }
825+ n <- makeElement doc elementTag cfg
826+ insertAfterPreviousNode n
827+ pure n
828+ e <- go lastHydrationNode
829+ setPreviousNode $ Just $ toNode e
830+ -- Update the parent node used by the children
831+ liftIO $ writeIORef parentRef $ toNode e
832+ liftIO $ writeIORef e' e
833+ -- Setup events, store the result so we can wait on it later
834+ refs <- wrap events e rawCfg
835+ liftIO $ putMVar wrapResult (e, refs)
836+ localRunner childDom Nothing $ toNode e
837+ -- We need the EventSelector to switch to the real event handler after activation
838+ es <- newFanEventWithTrigger $ \(WrapArg en) t -> do
839+ cleanup <- newEmptyMVar
840+ threadId <- forkIO $ do
841+ -- Wait on the data we need from the delayed action
842+ (e, eventTriggerRefs) <- readMVar wrapResult
843+ bracketOnError
844+ -- Run the setup, acquiring the cleanup action
845+ (triggerBody ctx rawCfg events eventTriggerRefs e (WrapArg en) t)
846+ -- Run the cleanup, if we have it - but only when an exception is
847+ -- raised (we might get killed between acquiring the cleanup action
848+ -- from 'triggerBody' and putting it in the MVar)
849+ id
850+ -- Try to put this action into the cleanup MVar
851+ (putMVar cleanup)
852+ pure $ do
853+ tryReadMVar cleanup >>= \case
854+ Nothing -> killThread threadId
855+ Just c -> c
856+ return ((Element es (), result), e')
857+
858+{-# SPECIALIZE hydrateElement
859+ :: Text
860+ -> ElementConfig er DomTimeline HydrationDomSpace
861+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM a
862+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM ((Element er HydrationDomSpace DomTimeline, a), IORef DOM.Element)
863+ #-}
864+
865+{-# INLINE inputElementImmediate #-}
866+inputElementImmediate
867+ :: ( RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, EventSpec s ~ GhcjsEventSpec
868+ , MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m, MonadHold t m
869+ , MonadRef m, Ref m ~ IORef )
870+ => InputElementConfig er t s -> HydrationDomBuilderT s t m (InputElement er GhcjsDomSpace t)
871+inputElementImmediate cfg = do
872+ (e@(Element eventSelector domElement), ()) <- elementImmediate "input" (_inputElementConfig_elementConfig cfg) $ return ()
873+ let domInputElement = uncheckedCastTo DOM.HTMLInputElement domElement
874+ Input.setValue domInputElement $ cfg ^. inputElementConfig_initialValue
875+ v0 <- Input.getValue domInputElement
876+ let getMyValue = Input.getValue domInputElement
877+ valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select eventSelector (WrapArg Input)
878+ valueChangedBySetValue <- case _inputElementConfig_setValue cfg of
879+ Nothing -> return never
880+ Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
881+ Input.setValue domInputElement v'
882+ getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
883+ v <- holdDyn v0 $ leftmost
884+ [ valueChangedBySetValue
885+ , valueChangedByUI
886+ ]
887+ Input.setChecked domInputElement $ _inputElementConfig_initialChecked cfg
888+ checkedChangedByUI <- wrapDomEvent domInputElement (`on` Events.click) $ do
889+ Input.getChecked domInputElement
890+ checkedChangedBySetChecked <- case _inputElementConfig_setChecked cfg of
891+ Nothing -> return never
892+ Just eNewchecked -> requestDomAction $ ffor eNewchecked $ \newChecked -> do
893+ oldChecked <- Input.getChecked domInputElement
894+ Input.setChecked domInputElement newChecked
895+ return $ if newChecked /= oldChecked
896+ then Just newChecked
897+ else Nothing
898+ c <- holdDyn (_inputElementConfig_initialChecked cfg) $ leftmost
899+ [ fmapMaybe id checkedChangedBySetChecked
900+ , checkedChangedByUI
901+ ]
902+ hasFocus <- mkHasFocus e
903+ files <- holdDyn mempty <=< wrapDomEvent domInputElement (`on` Events.change) $ do
904+ mfiles <- Input.getFiles domInputElement
905+ let getMyFiles xs = fmap catMaybes . mapM (FileList.item xs) . flip take [0..] . fromIntegral =<< FileList.getLength xs
906+ maybe (return []) getMyFiles mfiles
907+ checked <- holdUniqDyn c
908+ return $ InputElement
909+ { _inputElement_value = v
910+ , _inputElement_checked = checked
911+ , _inputElement_checkedChange = checkedChangedByUI
912+ , _inputElement_input = valueChangedByUI
913+ , _inputElement_hasFocus = hasFocus
914+ , _inputElement_element = e
915+ , _inputElement_raw = domInputElement
916+ , _inputElement_files = files
917+ }
918+
919+{-# INLINE inputElementInternal #-}
920+inputElementInternal
921+ :: ( MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m, MonadHold t m
922+ , MonadRef m, Ref m ~ IORef )
923+ => InputElementConfig er t HydrationDomSpace -> HydrationDomBuilderT HydrationDomSpace t m (InputElement er HydrationDomSpace t)
924+inputElementInternal cfg = getHydrationMode >>= \case
925+ HydrationMode_Immediate -> ffor (inputElementImmediate cfg) $ \result -> result
926+ { _inputElement_element = Element (_element_events $ _inputElement_element result) ()
927+ , _inputElement_raw = ()
928+ }
929+ HydrationMode_Hydrating -> do
930+ ((e, _), domElementRef) <- hydrateElement "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
931+ (valueChangedByUI, triggerChangeByUI) <- newTriggerEvent
932+ (valueChangedBySetValue, triggerChangeBySetValue) <- newTriggerEvent
933+ (focusChange, triggerFocusChange) <- newTriggerEvent
934+ (checkedChangedByUI, triggerCheckedChangedByUI) <- newTriggerEvent
935+ (checkedChangedBySetChecked, triggerCheckedChangedBySetChecked) <- newTriggerEvent
936+ (fileChange, triggerFileChange) <- newTriggerEvent
937+ doc <- askDocument
938+ -- Expected initial value from config
939+ let v0 = _inputElementConfig_initialValue cfg
940+ c0 = _inputElementConfig_initialChecked cfg
941+ valuesAtSwitchover = do
942+ v <- maybe (pure $ pure v0) (hold v0) (_inputElementConfig_setValue cfg)
943+ c <- maybe (pure $ pure c0) (hold c0) (_inputElementConfig_setChecked cfg)
944+ pure (v, c)
945+ addHydrationStepWithSetup valuesAtSwitchover $ \(switchoverValue', switchoverChecked') -> do
946+ switchoverValue <- sample switchoverValue'
947+ switchoverChecked <- sample switchoverChecked'
948+ domElement <- liftIO $ readIORef domElementRef
470949 let domInputElement = uncheckedCastTo DOM.HTMLInputElement domElement
471− Input.setValue domInputElement $ Just (cfg ^. inputElementConfig_initialValue)
472− v0 <- Input.getValueUnchecked domInputElement
473− let getMyValue = fromMaybe "" <$> Input.getValue domInputElement
474− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Input)
475− valueChangedBySetValue <- case _inputElementConfig_setValue cfg of
476− Nothing -> return never
477− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
478− Input.setValue domInputElement $ Just v'
479− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
480− v <- holdDyn v0 $ leftmost
481− [ valueChangedBySetValue
482− , valueChangedByUI
483− ]
484− Input.setChecked domInputElement $ _inputElementConfig_initialChecked cfg
485− checkedChangedByUI <- wrapDomEvent domInputElement (`on` Events.click) $ do
486− Input.getChecked domInputElement
487− checkedChangedBySetChecked <- case _inputElementConfig_setChecked cfg of
488− Nothing -> return never
489− Just eNewchecked -> requestDomAction $ ffor eNewchecked $ \newChecked -> do
950+ getValue = Input.getValue domInputElement
951+ -- When the value has been updated by setValue before switchover, we must
952+ -- send an update here to remain in sync. This is because the later
953+ -- requestDomAction based on the setValue event will not capture events
954+ -- happening before postBuild, because this code runs after switchover.
955+ when (v0 /= switchoverValue) $ liftIO $ triggerChangeBySetValue switchoverValue
956+ -- The user could have altered the value before switchover. This must be
957+ -- triggered after the setValue one in order for the events to be in the
958+ -- correct order.
959+ liftJSM getValue >>= \realValue -> when (realValue /= switchoverValue) $ liftIO $ triggerChangeByUI realValue
960+ -- Watch for user interaction and trigger event accordingly
961+ requestDomAction_ $ (liftJSM getValue >>= liftIO . triggerChangeByUI) <$ Reflex.select (_element_events e) (WrapArg Input)
962+ for_ (_inputElementConfig_setValue cfg) $ \eSetValue ->
963+ requestDomAction_ $ ffor eSetValue $ \v' -> do
964+ Input.setValue domInputElement v'
965+ v <- getValue -- We get the value after setting it in case the browser has mucked with it somehow
966+ liftIO $ triggerChangeBySetValue v
967+ let focusChange' = leftmost
968+ [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
969+ , True <$ Reflex.select (_element_events e) (WrapArg Focus)
970+ ]
971+ liftIO . triggerFocusChange =<< Node.isSameNode (toNode domElement) . fmap toNode =<< Document.getActiveElement doc
972+ requestDomAction_ $ liftIO . triggerFocusChange <$> focusChange'
973+ -- When the checked state has been updated by setChecked before
974+ -- switchover, we must send an update here to remain in sync. This is
975+ -- because the later requestDomAction based on the setChecked event will not
976+ -- capture events happening before postBuild, because this code runs after
977+ -- switchover.
978+ when (c0 /= switchoverChecked) $ liftIO $ triggerCheckedChangedBySetChecked switchoverChecked
979+ -- The user could have clicked the checkbox before switchover, we only
980+ -- detect cases where they flipped the state. This must be triggered after
981+ -- the setValue one in order for the events to be in the correct order.
982+ liftJSM (Input.getChecked domInputElement) >>= \realChecked -> when (realChecked /= switchoverChecked) $
983+ liftIO $ triggerCheckedChangedByUI realChecked
984+ _ <- liftJSM $ domInputElement `on` Events.click $ do
985+ liftIO . triggerCheckedChangedByUI =<< Input.getChecked domInputElement
986+ for_ (_inputElementConfig_setChecked cfg) $ \eNewchecked ->
987+ requestDomAction $ ffor eNewchecked $ \newChecked -> do
490988 oldChecked <- Input.getChecked domInputElement
491989 Input.setChecked domInputElement newChecked
492− return $ if newChecked /= oldChecked
493− then Just newChecked
494− else Nothing
495− c <- holdDyn (_inputElementConfig_initialChecked cfg) $ leftmost
496− [ fmapMaybe id checkedChangedBySetChecked
497− , checkedChangedByUI
498− ]
499− let initialFocus = False --TODO: Is this correct?
500− hasFocus <- holdDyn initialFocus $ leftmost
501− [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
502− , True <$ Reflex.select (_element_events e) (WrapArg Focus)
503− ]
504− files <- holdDyn mempty <=< wrapDomEvent domInputElement (`on` Events.change) $ do
990+ when (newChecked /= oldChecked) $ liftIO $ triggerCheckedChangedBySetChecked newChecked
991+ _ <- liftJSM $ domInputElement `on` Events.change $ do
505992 mfiles <- Input.getFiles domInputElement
506993 let getMyFiles xs = fmap catMaybes . mapM (FileList.item xs) . flip take [0..] . fromIntegral =<< FileList.getLength xs
507− maybe (return []) getMyFiles mfiles
508− return $ InputElement
509− { _inputElement_value = v
510− , _inputElement_checked = uniqDyn c
511− , _inputElement_checkedChange = checkedChangedByUI
512− , _inputElement_input = valueChangedByUI
513− , _inputElement_hasFocus = hasFocus
514− , _inputElement_element = e
515− , _inputElement_raw = domInputElement
516− , _inputElement_files = files
517− }
518− {-# INLINABLE textAreaElement #-}
519− textAreaElement cfg = do --TODO
520− ((e, _), domElement) <- makeElement "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
994+ liftIO . triggerFileChange =<< maybe (return []) getMyFiles mfiles
995+ return ()
996+ checked' <- holdDyn c0 $ leftmost
997+ [ checkedChangedBySetChecked
998+ , checkedChangedByUI
999+ ]
1000+ checked <- holdUniqDyn checked'
1001+ let initialFocus = False -- Assume it isn't focused, but we update the actual focus state at switchover
1002+ hasFocus <- holdUniqDyn =<< holdDyn initialFocus focusChange
1003+ v <- holdDyn v0 $ leftmost
1004+ [ valueChangedBySetValue
1005+ , valueChangedByUI
1006+ ]
1007+ files <- holdDyn mempty fileChange
1008+ return $ InputElement
1009+ { _inputElement_value = v
1010+ , _inputElement_checked = checked
1011+ , _inputElement_checkedChange = checkedChangedByUI
1012+ , _inputElement_input = valueChangedByUI
1013+ , _inputElement_hasFocus = hasFocus
1014+ , _inputElement_element = e
1015+ , _inputElement_raw = ()
1016+ , _inputElement_files = files
1017+ }
1018+
1019+{-# INLINE textAreaElementImmediate #-}
1020+textAreaElementImmediate
1021+ :: ( RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, EventSpec s ~ GhcjsEventSpec
1022+ , MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m, MonadHold t m
1023+ , MonadRef m, Ref m ~ IORef )
1024+ => TextAreaElementConfig er t s -> HydrationDomBuilderT s t m (TextAreaElement er GhcjsDomSpace t)
1025+textAreaElementImmediate cfg = do
1026+ (e@(Element eventSelector domElement), _) <- elementImmediate "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
1027+ let domTextAreaElement = uncheckedCastTo DOM.HTMLTextAreaElement domElement
1028+ TextArea.setValue domTextAreaElement $ cfg ^. textAreaElementConfig_initialValue
1029+ v0 <- TextArea.getValue domTextAreaElement
1030+ let getMyValue = TextArea.getValue domTextAreaElement
1031+ valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select eventSelector (WrapArg Input)
1032+ valueChangedBySetValue <- case _textAreaElementConfig_setValue cfg of
1033+ Nothing -> return never
1034+ Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
1035+ TextArea.setValue domTextAreaElement v'
1036+ getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
1037+ v <- holdDyn v0 $ leftmost
1038+ [ valueChangedBySetValue
1039+ , valueChangedByUI
1040+ ]
1041+ hasFocus <- mkHasFocus e
1042+ return $ TextAreaElement
1043+ { _textAreaElement_value = v
1044+ , _textAreaElement_input = valueChangedByUI
1045+ , _textAreaElement_hasFocus = hasFocus
1046+ , _textAreaElement_element = e
1047+ , _textAreaElement_raw = domTextAreaElement
1048+ }
1049+
1050+{-# INLINE textAreaElementInternal #-}
1051+textAreaElementInternal
1052+ :: ( MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m, MonadHold t m
1053+ , MonadRef m, Ref m ~ IORef )
1054+ => TextAreaElementConfig er t HydrationDomSpace -> HydrationDomBuilderT HydrationDomSpace t m (TextAreaElement er HydrationDomSpace t)
1055+textAreaElementInternal cfg = getHydrationMode >>= \case
1056+ HydrationMode_Immediate -> ffor (textAreaElementImmediate cfg) $ \result -> result
1057+ { _textAreaElement_element = Element (_element_events $ _textAreaElement_element result) ()
1058+ , _textAreaElement_raw = ()
1059+ }
1060+ HydrationMode_Hydrating -> do
1061+ ((e, _), domElementRef) <- hydrateElement "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
1062+ (valueChangedByUI, triggerChangeByUI) <- newTriggerEvent
1063+ (valueChangedBySetValue, triggerChangeBySetValue) <- newTriggerEvent
1064+ (focusChange, triggerFocusChange) <- newTriggerEvent
1065+ doc <- askDocument
1066+ -- Expected initial value from config
1067+ let v0 = _textAreaElementConfig_initialValue cfg
1068+ valueAtSwitchover = maybe (pure $ pure v0) (hold v0) (_textAreaElementConfig_setValue cfg)
1069+ addHydrationStepWithSetup valueAtSwitchover $ \switchoverValue' -> do
1070+ switchoverValue <- sample switchoverValue'
1071+ domElement <- liftIO $ readIORef domElementRef
5211072 let domTextAreaElement = uncheckedCastTo DOM.HTMLTextAreaElement domElement
522− TextArea.setValue domTextAreaElement $ Just (cfg ^. textAreaElementConfig_initialValue)
523− v0 <- TextArea.getValueUnchecked domTextAreaElement
524− let getMyValue = fromMaybe "" <$> TextArea.getValue domTextAreaElement
525− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Input)
526− valueChangedBySetValue <- case _textAreaElementConfig_setValue cfg of
527− Nothing -> return never
528− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
529− TextArea.setValue domTextAreaElement $ Just v'
530− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
531− v <- holdDyn v0 $ leftmost
532− [ valueChangedBySetValue
533− , valueChangedByUI
534− ]
535− hasFocus <- mkHasFocus e
536− return $ TextAreaElement
537− { _textAreaElement_value = v
538− , _textAreaElement_input = valueChangedByUI
539− , _textAreaElement_hasFocus = hasFocus
540− , _textAreaElement_element = e
541− , _textAreaElement_raw = domTextAreaElement
542− }
543− {-# INLINABLE selectElement #-}
544− selectElement cfg child = do
545− ((e, result), domElement) <- makeElement "select" (cfg ^. selectElementConfig_elementConfig) child
1073+ getValue = TextArea.getValue domTextAreaElement
1074+ -- When the value has been updated by setValue before switchover, we must
1075+ -- send an update here to remain in sync. This is because the later
1076+ -- requestDomAction based on the setValue event will not capture events
1077+ -- happening before postBuild, because this code runs after switchover.
1078+ when (v0 /= switchoverValue) $ liftIO $ triggerChangeBySetValue switchoverValue
1079+ -- The user could have altered the value before switchover. This must be
1080+ -- triggered after the setValue one in order for the events to be in the
1081+ -- correct order.
1082+ liftJSM getValue >>= \realValue -> when (realValue /= switchoverValue) $ liftIO $ triggerChangeByUI realValue
1083+ -- Watch for user interaction and trigger event accordingly
1084+ requestDomAction_ $ (liftJSM getValue >>= liftIO . triggerChangeByUI) <$ Reflex.select (_element_events e) (WrapArg Input)
1085+ for_ (_textAreaElementConfig_setValue cfg) $ \eSetValue ->
1086+ requestDomAction_ $ ffor eSetValue $ \v' -> do
1087+ TextArea.setValue domTextAreaElement v'
1088+ v <- getValue -- We get the value after setting it in case the browser has mucked with it somehow
1089+ liftIO $ triggerChangeBySetValue v
1090+ let focusChange' = leftmost
1091+ [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
1092+ , True <$ Reflex.select (_element_events e) (WrapArg Focus)
1093+ ]
1094+ liftIO . triggerFocusChange =<< Node.isSameNode (toNode domElement) . fmap toNode =<< Document.getActiveElement doc
1095+ requestDomAction_ $ liftIO . triggerFocusChange <$> focusChange'
1096+ let initialFocus = False -- Assume it isn't focused, but we update the actual focus state at switchover
1097+ hasFocus <- holdUniqDyn =<< holdDyn initialFocus focusChange
1098+ v <- holdDyn v0 $ leftmost
1099+ [ valueChangedBySetValue
1100+ , valueChangedByUI
1101+ ]
1102+ return $ TextAreaElement
1103+ { _textAreaElement_value = v
1104+ , _textAreaElement_input = valueChangedByUI
1105+ , _textAreaElement_hasFocus = hasFocus
1106+ , _textAreaElement_element = e
1107+ , _textAreaElement_raw = ()
1108+ }
1109+
1110+{-# INLINE selectElementImmediate #-}
1111+selectElementImmediate
1112+ :: ( EventSpec s ~ GhcjsEventSpec, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document
1113+ , MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m, MonadHold t m )
1114+ => SelectElementConfig er t s
1115+ -> HydrationDomBuilderT s t m a
1116+ -> HydrationDomBuilderT s t m (SelectElement er GhcjsDomSpace t, a)
1117+selectElementImmediate cfg child = do
1118+ (e@(Element eventSelector domElement), result) <- elementImmediate "select" (cfg ^. selectElementConfig_elementConfig) child
1119+ let domSelectElement = uncheckedCastTo DOM.HTMLSelectElement domElement
1120+ Select.setValue domSelectElement $ cfg ^. selectElementConfig_initialValue
1121+ v0 <- Select.getValue domSelectElement
1122+ let getMyValue = Select.getValue domSelectElement
1123+ valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select eventSelector (WrapArg Change)
1124+ valueChangedBySetValue <- case _selectElementConfig_setValue cfg of
1125+ Nothing -> return never
1126+ Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
1127+ Select.setValue domSelectElement v'
1128+ getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
1129+ v <- holdDyn v0 $ leftmost
1130+ [ valueChangedBySetValue
1131+ , valueChangedByUI
1132+ ]
1133+ hasFocus <- mkHasFocus e
1134+ let wrapped = SelectElement
1135+ { _selectElement_value = v
1136+ , _selectElement_change = valueChangedByUI
1137+ , _selectElement_hasFocus = hasFocus
1138+ , _selectElement_element = e
1139+ , _selectElement_raw = domSelectElement
1140+ }
1141+ return (wrapped, result)
1142+
1143+{-# INLINE selectElementInternal #-}
1144+selectElementInternal
1145+ :: ( MonadJSM m, Reflex t, MonadReflexCreateTrigger t m, MonadFix m, MonadHold t m
1146+ , MonadRef m, Ref m ~ IORef )
1147+ => SelectElementConfig er t HydrationDomSpace
1148+ -> HydrationDomBuilderT HydrationDomSpace t m a
1149+ -> HydrationDomBuilderT HydrationDomSpace t m (SelectElement er HydrationDomSpace t, a)
1150+selectElementInternal cfg child = getHydrationMode >>= \case
1151+ HydrationMode_Immediate -> ffor (selectElementImmediate cfg child) $ \(e, result) -> (e
1152+ { _selectElement_element = Element (_element_events $ _selectElement_element e) ()
1153+ , _selectElement_raw = ()
1154+ }, result)
1155+ HydrationMode_Hydrating -> do
1156+ ((e, result), domElementRef) <- hydrateElement "select" (cfg ^. selectElementConfig_elementConfig) child
1157+ (valueChangedByUI, triggerChangeByUI) <- newTriggerEvent
1158+ (valueChangedBySetValue, triggerChangeBySetValue) <- newTriggerEvent
1159+ (focusChange, triggerFocusChange) <- newTriggerEvent
1160+ doc <- askDocument
1161+ -- Expected initial value from config
1162+ let v0 = _selectElementConfig_initialValue cfg
1163+ addHydrationStep $ do
1164+ domElement <- liftIO $ readIORef domElementRef
5461165 let domSelectElement = uncheckedCastTo DOM.HTMLSelectElement domElement
547− Select.setValue domSelectElement $ cfg ^. selectElementConfig_initialValue
548− v0 <- Select.getValue domSelectElement
549− let getMyValue = Select.getValue domSelectElement
550− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Change)
551− valueChangedBySetValue <- case _selectElementConfig_setValue cfg of
552− Nothing -> return never
553− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
1166+ getValue = Select.getValue domSelectElement
1167+ -- The browser might have messed with the value, or the user could have
1168+ -- altered it before activation, so we set it if it isn't what we expect
1169+ liftJSM getValue >>= \v0' -> do
1170+ when (v0' /= v0) $ liftIO $ triggerChangeByUI v0'
1171+ -- Watch for user interaction and trigger event accordingly
1172+ requestDomAction_ $ (liftJSM getValue >>= liftIO . triggerChangeByUI) <$ Reflex.select (_element_events e) (WrapArg Change)
1173+ for_ (_selectElementConfig_setValue cfg) $ \eSetValue ->
1174+ requestDomAction_ $ ffor eSetValue $ \v' -> do
5541175 Select.setValue domSelectElement v'
555− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
556− v <- holdDyn v0 $ leftmost
557− [ valueChangedBySetValue
558− , valueChangedByUI
559− ]
560− hasFocus <- mkHasFocus e
561− let wrapped = SelectElement
562− { _selectElement_value = v
563− , _selectElement_change = valueChangedByUI
564− , _selectElement_hasFocus = hasFocus
565− , _selectElement_element = e
566− , _selectElement_raw = domSelectElement
567− }
568− return (wrapped, result)
569− placeRawElement = append
570− wrapRawElement = wrap
1176+ v <- getValue -- We get the value after setting it in case the browser has mucked with it somehow
1177+ liftIO $ triggerChangeBySetValue v
1178+ let focusChange' = leftmost
1179+ [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
1180+ , True <$ Reflex.select (_element_events e) (WrapArg Focus)
1181+ ]
1182+ liftIO . triggerFocusChange =<< Node.isSameNode (toNode domElement) . fmap toNode =<< Document.getActiveElement doc
1183+ requestDomAction_ $ liftIO . triggerFocusChange <$> focusChange'
1184+ let initialFocus = False -- Assume it isn't focused, but we update the actual focus state at switchover
1185+ hasFocus <- holdUniqDyn =<< holdDyn initialFocus focusChange
1186+ v <- holdDyn v0 $ leftmost
1187+ [ valueChangedBySetValue
1188+ , valueChangedByUI
1189+ ]
1190+ return $ (,result) $ SelectElement
1191+ { _selectElement_value = v
1192+ , _selectElement_change = valueChangedByUI
1193+ , _selectElement_hasFocus = hasFocus
1194+ , _selectElement_element = e
1195+ , _selectElement_raw = ()
1196+ }
1197+
1198+{-# INLINE textNodeImmediate #-}
1199+textNodeImmediate
1200+ :: (RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, MonadJSM m, Reflex t, MonadFix m)
1201+ => TextNodeConfig t -> HydrationDomBuilderT s t m DOM.Text
1202+textNodeImmediate (TextNodeConfig !t mSetContents) = do
1203+ p <- getParent
1204+ doc <- askDocument
1205+ n <- createTextNode doc t
1206+ appendChild_ p n
1207+ mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
1208+ pure n
1209+
1210+{-# SPECIALIZE textNodeImmediate
1211+ :: TextNodeConfig DomTimeline
1212+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM DOM.Text
1213+ #-}
1214+
1215+{-# SPECIALIZE textNodeImmediate
1216+ :: TextNodeConfig DomTimeline
1217+ -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM DOM.Text
1218+ #-}
1219+
1220+{-# INLINE textNodeInternal #-}
1221+textNodeInternal
1222+ :: (Adjustable t m, MonadHold t m, MonadJSM m, MonadFix m, Reflex t)
1223+ => TextNodeConfig t -> HydrationDomBuilderT HydrationDomSpace t m (TextNode HydrationDomSpace t)
1224+textNodeInternal tc@(TextNodeConfig !t mSetContents) = do
1225+ doc <- askDocument
1226+ getHydrationMode >>= \case
1227+ HydrationMode_Immediate -> void $ textNodeImmediate tc
1228+ HydrationMode_Hydrating -> addHydrationStepWithSetup (maybe (pure $ pure t) (hold t) mSetContents) $ \currentText -> do
1229+ n <- hydrateTextNode doc =<< sample currentText
1230+ mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
1231+ pure $ TextNode ()
1232+
1233+{-# SPECIALIZE textNodeInternal
1234+ :: TextNodeConfig DomTimeline
1235+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (TextNode HydrationDomSpace DomTimeline)
1236+ #-}
1237+
1238+-- | The static builder mashes adjacent text nodes into one node: we check the
1239+-- text content of each node we come to, comparing it to the content we
1240+-- expect. We also have a special case for empty text nodes - we always create
1241+-- the and add them after the previous node reference.
1242+{-# INLINE hydrateTextNode #-}
1243+hydrateTextNode :: MonadJSM m => Document -> Text -> HydrationRunnerT t m DOM.Text
1244+hydrateTextNode doc t@"" = do
1245+ tn <- createTextNode doc t
1246+ insertAfterPreviousNode tn
1247+ pure tn
1248+hydrateTextNode doc t = do
1249+ n <- join $ go <$> askParent <*> getPreviousNode
1250+ setPreviousNode $ Just $ toNode n
1251+ return n
1252+ where
1253+ go parent mLastNode = maybe (Node.getFirstChild parent) Node.getNextSibling mLastNode >>= \case
1254+ Nothing -> do
1255+ HydrationRunnerT $ modify' $ \s -> s { _hydrationState_failed = True }
1256+ n <- createTextNode doc t
1257+ insertAfterPreviousNode n
1258+ pure n
1259+ Just node -> DOM.castTo DOM.Text node >>= \case
1260+ Nothing -> go parent $ Just node
1261+ Just originalNode -> do
1262+ originalText <- Node.getTextContentUnchecked originalNode
1263+ case T.stripPrefix t originalText of
1264+ Just "" -> return originalNode
1265+ Just _ -> do
1266+ -- If we have the right prefix, we split the text node into a node containing the
1267+ -- required text and a subsequent sibling node containing the rest of the text.
1268+ DOM.splitText_ originalNode $ fromIntegral $ T.length t
1269+ return originalNode
1270+ Nothing -> do
1271+ HydrationRunnerT $ modify' $ \s -> s { _hydrationState_failed = True }
1272+ n <- createTextNode doc t
1273+ insertAfterPreviousNode n
1274+ pure n
1275+
1276+{-# INLINE commentNodeImmediate #-}
1277+commentNodeImmediate
1278+ :: (RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, MonadJSM m, Reflex t, MonadFix m)
1279+ => CommentNodeConfig t -> HydrationDomBuilderT s t m DOM.Comment
1280+commentNodeImmediate (CommentNodeConfig !t mSetContents) = do
1281+ p <- getParent
1282+ doc <- askDocument
1283+ n <- createComment doc t
1284+ appendChild_ p n
1285+ mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
1286+ pure n
1287+
1288+{-# INLINE commentNodeInternal #-}
1289+commentNodeInternal
1290+ :: (Ref m ~ IORef, MonadRef m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadJSM (Performable m), MonadJSM m, MonadFix m, Reflex t, Adjustable t m, MonadHold t m, MonadSample t m)
1291+ => CommentNodeConfig t -> HydrationDomBuilderT HydrationDomSpace t m (CommentNode HydrationDomSpace t)
1292+commentNodeInternal tc@(CommentNodeConfig t0 mSetContents) = do
1293+ doc <- askDocument
1294+ getHydrationMode >>= \case
1295+ HydrationMode_Immediate -> void $ commentNodeInternal tc
1296+ HydrationMode_Hydrating -> addHydrationStepWithSetup (maybe (pure $ pure t0) (hold t0) mSetContents) $ \bt -> do
1297+ t <- sample bt
1298+ void $ hydrateComment doc t mSetContents
1299+ pure $ CommentNode ()
1300+
1301+{-# INLINE hydrateComment #-}
1302+hydrateComment :: (MonadJSM m, Reflex t, MonadFix m) => Document -> Text -> Maybe (Event t Text) -> HydrationRunnerT t m DOM.Comment
1303+hydrateComment doc t mSetContents = do
1304+ parent <- askParent
1305+ let go mLastNode = maybe (Node.getFirstChild parent) Node.getNextSibling mLastNode >>= \case
1306+ Nothing -> do
1307+ c <- createComment doc t
1308+ insertAfterPreviousNode c
1309+ pure c
1310+ Just node -> DOM.castTo DOM.Comment node >>= \case
1311+ Nothing -> go (Just node)
1312+ Just c -> do
1313+ t' <- Node.getTextContentUnchecked c
1314+ if t == t'
1315+ then pure c
1316+ else do
1317+ c' <- createComment doc t
1318+ insertAfterPreviousNode c'
1319+ pure c'
1320+ n <- go =<< getPreviousNode
1321+ setPreviousNode $ Just $ toNode n
1322+ mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
1323+ pure n
1324+
1325+-- | We leave markers in the static builder as comments, and rip these comments
1326+-- out at hydration time, replacing them with empty text nodes.
1327+{-# INLINABLE skipToAndReplaceComment #-}
1328+skipToAndReplaceComment
1329+ :: (MonadJSM m, Reflex t, MonadFix m, Adjustable t m, MonadHold t m, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document)
1330+ => Text
1331+ -> IORef (Maybe Text)
1332+ -> HydrationDomBuilderT s t m (HydrationRunnerT t m (), IORef DOM.Text, IORef (Maybe Text))
1333+skipToAndReplaceComment prefix key0Ref = getHydrationMode >>= \case
1334+ HydrationMode_Immediate -> do
1335+ -- If we're in immediate mode, we don't try to replace an existing comment,
1336+ -- and just return a dummy key
1337+ t <- textNodeImmediate $ TextNodeConfig ("" :: Text) Nothing
1338+ append $ toNode t
1339+ textNodeRef <- liftIO $ newIORef t
1340+ keyRef <- liftIO $ newIORef Nothing
1341+ pure (pure (), textNodeRef, keyRef)
1342+ HydrationMode_Hydrating -> do
1343+ doc <- askDocument
1344+ textNodeRef <- liftIO $ newIORef $ error "textNodeRef not yet initialized"
1345+ keyRef <- liftIO $ newIORef $ error "keyRef not yet initialized"
1346+ let
1347+ go Nothing _ = do
1348+ tn <- createTextNode doc ("" :: Text)
1349+ insertAfterPreviousNode tn
1350+ HydrationRunnerT $ modify' $ \s -> s { _hydrationState_failed = True }
1351+ pure (tn, Nothing)
1352+ go (Just key0) mLastNode = do
1353+ parent <- askParent
1354+ maybe (Node.getFirstChild parent) Node.getNextSibling mLastNode >>= \case
1355+ Nothing -> go Nothing Nothing
1356+ Just node -> DOM.castTo DOM.Comment node >>= \case
1357+ Just comment -> do
1358+ commentText <- fromMaybe (error "Cannot get text content of comment node") <$> Node.getTextContent comment
1359+ case T.stripPrefix (prefix <> key0) commentText of -- 'key0' may be @""@ in which case we're just finding the actual key; TODO: Don't be clever.
1360+ Just key -> do
1361+ -- Replace the comment with an (invisible) text node
1362+ tn <- createTextNode doc ("" :: Text)
1363+ Node.replaceChild_ parent tn comment
1364+ pure (tn, Just key)
1365+ Nothing -> do
1366+ go (Just key0) (Just node)
1367+ Nothing -> do
1368+ go (Just key0) (Just node)
1369+ switchComment = do
1370+ key0 <- liftIO $ readIORef key0Ref
1371+ (tn, key) <- go key0 =<< getPreviousNode
1372+ setPreviousNode $ Just $ toNode tn
1373+ liftIO $ do
1374+ writeIORef textNodeRef tn
1375+ writeIORef keyRef key
1376+ pure (switchComment, textNodeRef, keyRef)
1377+
1378+{-# INLINABLE skipToReplaceStart #-}
1379+skipToReplaceStart :: (MonadJSM m, Reflex t, MonadFix m, Adjustable t m, MonadHold t m, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document) => HydrationDomBuilderT s t m (HydrationRunnerT t m (), IORef DOM.Text, IORef (Maybe Text))
1380+skipToReplaceStart = skipToAndReplaceComment "replace-start" =<< liftIO (newIORef $ Just "") -- TODO: Don't rely on clever usage @""@ to make this work.
1381+
1382+{-# INLINABLE skipToReplaceEnd #-}
1383+skipToReplaceEnd :: (MonadJSM m, Reflex t, MonadFix m, Adjustable t m, MonadHold t m, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document) => IORef (Maybe Text) -> HydrationDomBuilderT s t m (HydrationRunnerT t m (), IORef DOM.Text)
1384+skipToReplaceEnd key = fmap (\(m,e,_) -> (m,e)) $ skipToAndReplaceComment "replace-end" key
1385+
1386+instance SupportsHydrationDomBuilder t m => NotReady t (HydrationDomBuilderT s t m) where
5711387 notReadyUntil e = do
5721388 eOnce <- headE e
573− env <- ImmediateDomBuilderT ask
574− let unreadyChildren = _immediateDomBuilderEnv_unreadyChildren env
1389+ unreadyChildren <- askUnreadyChildren
1390+ commitAction <- askCommitAction
5751391 liftIO $ modifyIORef' unreadyChildren succ
5761392 let ready = do
5771393 old <- liftIO $ readIORef unreadyChildren
5781394 let new = pred old
5791395 liftIO $ writeIORef unreadyChildren $! new
580− when (new == 0) $ _immediateDomBuilderEnv_commitAction env
1396+ when (new == 0) commitAction
5811397 requestDomAction_ $ ready <$ eOnce
5821398 notReady = do
583− env <- ImmediateDomBuilderT ask
584− let unreadyChildren = _immediateDomBuilderEnv_unreadyChildren env
1399+ unreadyChildren <- askUnreadyChildren
5851400 liftIO $ modifyIORef' unreadyChildren succ
5861401
1402+data HydrationDomSpace
1403+
1404+instance DomSpace HydrationDomSpace where
1405+ type EventSpec HydrationDomSpace = GhcjsEventSpec
1406+ type RawDocument HydrationDomSpace = DOM.Document
1407+ type RawTextNode HydrationDomSpace = ()
1408+ type RawCommentNode HydrationDomSpace = ()
1409+ type RawElement HydrationDomSpace = ()
1410+ type RawInputElement HydrationDomSpace = ()
1411+ type RawTextAreaElement HydrationDomSpace = ()
1412+ type RawSelectElement HydrationDomSpace = ()
1413+ addEventSpecFlags _ en f es = es
1414+ { _ghcjsEventSpec_filters =
1415+ let f' = Just . GhcjsEventFilter . \case
1416+ Nothing -> \evt -> do
1417+ mEventResult <- unGhcjsEventHandler (_ghcjsEventSpec_handler es) (en, evt)
1418+ return (f mEventResult, return mEventResult)
1419+ Just (GhcjsEventFilter oldFilter) -> \evt -> do
1420+ (oldFlags, oldContinuation) <- oldFilter evt
1421+ mEventResult <- oldContinuation
1422+ let newFlags = oldFlags <> f mEventResult
1423+ return (newFlags, return mEventResult)
1424+ in DMap.alter f' en $ _ghcjsEventSpec_filters es
1425+ }
1426+
1427+instance SupportsHydrationDomBuilder t m => DomBuilder t (HydrationDomBuilderT HydrationDomSpace t m) where
1428+ type DomBuilderSpace (HydrationDomBuilderT HydrationDomSpace t m) = HydrationDomSpace
1429+ {-# INLINABLE element #-}
1430+ element = elementInternal
1431+ {-# INLINABLE textNode #-}
1432+ textNode = textNodeInternal
1433+ {-# INLINABLE commentNode #-}
1434+ commentNode = commentNodeInternal
1435+ {-# INLINABLE inputElement #-}
1436+ inputElement = inputElementInternal
1437+ {-# INLINABLE textAreaElement #-}
1438+ textAreaElement = textAreaElementInternal
1439+ {-# INLINABLE selectElement #-}
1440+ selectElement = selectElementInternal
1441+ placeRawElement () = pure ()
1442+ wrapRawElement () _cfg = pure $ Element (EventSelector $ const never) ()
1443+
1444+instance SupportsHydrationDomBuilder t m => DomBuilder t (HydrationDomBuilderT GhcjsDomSpace t m) where
1445+ type DomBuilderSpace (HydrationDomBuilderT GhcjsDomSpace t m) = GhcjsDomSpace
1446+ {-# INLINABLE element #-}
1447+ element = elementImmediate
1448+ {-# INLINABLE textNode #-}
1449+ textNode = fmap TextNode . textNodeImmediate
1450+ {-# INLINABLE commentNode #-}
1451+ commentNode = fmap CommentNode . commentNodeImmediate
1452+ {-# INLINABLE inputElement #-}
1453+ inputElement = inputElementImmediate
1454+ {-# INLINABLE textAreaElement #-}
1455+ textAreaElement = textAreaElementImmediate
1456+ {-# INLINABLE selectElement #-}
1457+ selectElement = selectElementImmediate
1458+ placeRawElement = append . toNode
1459+ wrapRawElement e rawCfg = do
1460+ events <- askEvents
1461+ ctx <- askJSM
1462+ eventTriggerRefs <- wrap events e rawCfg
1463+ es <- newFanEventWithTrigger $ triggerBody ctx rawCfg events eventTriggerRefs e
1464+ pure $ Element es e
1465+
5871466data FragmentState
5881467 = FragmentState_Unmounted
5891468 | FragmentState_Mounted (DOM.Text, DOM.Text)
@@ -602,21 +1481,21 @@ extractFragment fragment = do
6021481 extractBetweenExclusive (_immediateDomFragment_document fragment) before after
6031482 liftIO $ writeIORef (_immediateDomFragment_state fragment) FragmentState_Unmounted
6041483
605−instance SupportsImmediateDomBuilder t m => MountableDomBuilder t (ImmediateDomBuilderT t m) where
606− type DomFragment (ImmediateDomBuilderT t m) = ImmediateDomFragment
1484+instance SupportsHydrationDomBuilder t m => MountableDomBuilder t (HydrationDomBuilderT GhcjsDomSpace t m) where
1485+ type DomFragment (HydrationDomBuilderT GhcjsDomSpace t m) = ImmediateDomFragment
6071486 buildDomFragment w = do
6081487 df <- createDocumentFragment =<< askDocument
6091488 result <- flip localEnv w $ \env -> env
610− { _immediateDomBuilderEnv_parent = toNode df
1489+ { _hydrationDomBuilderEnv_parent = Left $ toNode df
6111490 }
6121491 state <- liftIO $ newIORef FragmentState_Unmounted
6131492 return (ImmediateDomFragment df state, result)
6141493 mountDomFragment fragment setFragment = do
615− parent <- askParent
1494+ parent <- getParent
6161495 extractFragment fragment
617− before <- textNodeInternal ("" :: Text)
1496+ before <- textNodeImmediate $ TextNodeConfig ("" :: Text) Nothing
6181497 appendChild_ parent $ _immediateDomFragment_document fragment
619− after <- textNodeInternal ("" :: Text)
1498+ after <- textNodeImmediate $ TextNodeConfig ("" :: Text) Nothing
6201499 xs <- foldDyn (\new (previous, _) -> (new, Just previous)) (fragment, Nothing) setFragment
6211500 requestDomAction_ $ ffor (updated xs) $ \(childFragment, Just previousFragment) -> do
6221501 extractFragment previousFragment
@@ -625,11 +1504,19 @@ instance SupportsImmediateDomBuilder t m => MountableDomBuilder t (ImmediateDomB
6251504 liftIO $ writeIORef (_immediateDomFragment_state childFragment) $ FragmentState_Mounted (before, after)
6261505 liftIO $ writeIORef (_immediateDomFragment_state fragment) $ FragmentState_Mounted (before, after)
6271506
628−instance (Reflex t, MonadAdjust t m, MonadJSM m, MonadHold t m, MonadFix m, PrimMonad m) => MonadAdjust t (ImmediateDomBuilderT t m) where
1507+instance (Reflex t, Monad m, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (DomRenderHookT t m) where
1508+ runWithReplace a0 a' = DomRenderHookT $ runWithReplace (unDomRenderHookT a0) (fmapCheap unDomRenderHookT a')
1509+ traverseIntMapWithKeyWithAdjust f m = DomRenderHookT . traverseIntMapWithKeyWithAdjust (\k -> unDomRenderHookT . f k) m
1510+ traverseDMapWithKeyWithAdjust f m = DomRenderHookT . traverseDMapWithKeyWithAdjust (\k -> unDomRenderHookT . f k) m
1511+ traverseDMapWithKeyWithAdjustWithMove f m = DomRenderHookT . traverseDMapWithKeyWithAdjustWithMove (\k -> unDomRenderHookT . f k) m
1512+
1513+instance (Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimMonad m, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document) => Adjustable t (HydrationDomBuilderT s t m) where
1514+ {-# INLINABLE runWithReplace #-}
6291515 runWithReplace a0 a' = do
630− initialEnv <- ImmediateDomBuilderT ask
631− before <- textNodeInternal ("" :: Text)
632− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
1516+ initialEnv <- HydrationDomBuilderT ask
1517+ let hydrating = _hydrationDomBuilderEnv_hydrationMode initialEnv
1518+ (hydrateStart, before, beforeKey) <- skipToReplaceStart
1519+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
6331520 haveEverBeenReady <- liftIO $ newIORef False
6341521 currentCohort <- liftIO $ newIORef (-1 :: Int) -- Equal to the cohort currently in the DOM
6351522 let myCommitAction = do
@@ -640,99 +1527,117 @@ instance (Reflex t, MonadAdjust t m, MonadJSM m, MonadHold t m, MonadFix m, Prim
6401527 old <- liftIO $ readIORef parentUnreadyChildren
6411528 let new = pred old
6421529 liftIO $ writeIORef parentUnreadyChildren $! new
643− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
1530+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
6441531 -- We draw 'after' in this roundabout way to avoid using MonadFix
6451532 doc <- askDocument
646− after <- createTextNode doc ("" :: Text)
1533+ parent <- getParent
1534+ (hydrateEnd, after) <- skipToReplaceEnd beforeKey
6471535 let drawInitialChild = do
1536+ h <- liftIO $ readIORef hydrating
1537+ p' <- case h of
1538+ HydrationMode_Hydrating -> pure parent
1539+ HydrationMode_Immediate -> toNode <$> createDocumentFragment doc
6481540 unreadyChildren <- liftIO $ newIORef 0
649− let f = do
650− result <- a0
651− append after
652− return result
653− result <- runReaderT (unImmediateDomBuilderT f) $ initialEnv
654− { _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
655− , _immediateDomBuilderEnv_commitAction = myCommitAction
1541+ let a0' = case h of
1542+ HydrationMode_Hydrating -> a0
1543+ HydrationMode_Immediate -> do
1544+ a <- a0
1545+ insertBefore p' =<< liftIO (readIORef after)
1546+ pure a
1547+ delayed <- case h of
1548+ HydrationMode_Hydrating -> liftIO $ newIORef $ pure ()
1549+ HydrationMode_Immediate -> pure $ _hydrationDomBuilderEnv_delayed initialEnv
1550+ result <- runReaderT (unHydrationDomBuilderT a0') initialEnv
1551+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1552+ , _hydrationDomBuilderEnv_commitAction = myCommitAction
1553+ , _hydrationDomBuilderEnv_parent = Left p'
1554+ , _hydrationDomBuilderEnv_delayed = delayed
6561555 }
1556+ dom <- case h of
1557+ HydrationMode_Hydrating -> liftIO $ readIORef delayed
1558+ HydrationMode_Immediate -> pure $ pure ()
6571559 liftIO $ readIORef unreadyChildren >>= \case
6581560 0 -> writeIORef haveEverBeenReady True
6591561 _ -> modifyIORef' parentUnreadyChildren succ
660− return result
1562+ return (dom, result)
6611563 a'' <- numberOccurrences a'
662− (result0, child') <- ImmediateDomBuilderT $ lift $ runWithReplace drawInitialChild $ ffor a'' $ \(cohortId, child) -> do
663− df <- createDocumentFragment doc
1564+ ((hydrate0, result0), child') <- HydrationDomBuilderT $ lift $ runWithReplace drawInitialChild $ ffor a'' $ \(cohortId, child) -> do
1565+ h <- liftIO $ readIORef hydrating
1566+ p' <- case h of
1567+ HydrationMode_Hydrating -> pure parent
1568+ HydrationMode_Immediate -> toNode <$> createDocumentFragment doc
6641569 unreadyChildren <- liftIO $ newIORef 0
6651570 let commitAction = do
6661571 c <- liftIO $ readIORef currentCohort
6671572 when (c <= cohortId) $ do -- If a newer cohort has already been committed, just ignore this
668− deleteBetweenExclusive before after
669− insertBefore df after
1573+ !before' <- liftIO $ readIORef before
1574+ !after' <- liftIO $ readIORef after
1575+ deleteBetweenExclusive before' after'
1576+ insertBefore p' after'
6701577 liftIO $ writeIORef currentCohort cohortId
6711578 myCommitAction
672− result <- runReaderT (unImmediateDomBuilderT child) $ initialEnv
673− { _immediateDomBuilderEnv_parent = toNode df
674− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
675− , _immediateDomBuilderEnv_commitAction = commitAction
676− }
1579+ delayed <- case h of
1580+ HydrationMode_Hydrating -> liftIO $ newIORef $ pure ()
1581+ HydrationMode_Immediate -> pure $ _hydrationDomBuilderEnv_delayed initialEnv
1582+ result <- runReaderT (unHydrationDomBuilderT child) $ initialEnv
1583+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1584+ , _hydrationDomBuilderEnv_commitAction = case h of
1585+ HydrationMode_Hydrating -> myCommitAction
1586+ HydrationMode_Immediate -> commitAction
1587+ , _hydrationDomBuilderEnv_parent = Left p'
1588+ , _hydrationDomBuilderEnv_delayed = delayed
1589+ }
1590+ dom <- case h of
1591+ HydrationMode_Hydrating -> liftIO $ readIORef delayed
1592+ HydrationMode_Immediate -> pure $ pure ()
6771593 uc <- liftIO $ readIORef unreadyChildren
6781594 let commitActionToRunNow = if uc == 0
679− then Just commitAction
1595+ then Just $ commitAction
6801596 else Nothing -- A child will run it when unreadyChildren is decremented to 0
681− return (commitActionToRunNow, result)
682− requestDomAction_ $ fmapMaybe fst child'
1597+ actions = case h of
1598+ HydrationMode_Hydrating -> Left dom
1599+ HydrationMode_Immediate -> Right commitActionToRunNow
1600+ return (actions, result)
1601+ let (hydrate', commitAction) = fanEither $ fmap fst child'
1602+ addHydrationStepWithSetup (hold hydrate0 hydrate') $ \contents -> do
1603+ hydrateStart
1604+ join $ sample contents
1605+ hydrateEnd
1606+ requestDomAction_ $ fmapMaybe id commitAction
6831607 return (result0, snd <$> child')
684− traverseDMapWithKeyWithAdjust = do
685− let updateChildUnreadiness (p :: PatchDMap k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) old = do
686− let new :: forall a. k a -> ComposeMaybe (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') a -> IO (ComposeMaybe (Constant (IORef (ChildReadyState k))) a)
687− new k (ComposeMaybe m) = ComposeMaybe <$> case m of
688− Nothing -> return Nothing
689− Just (Compose (_, _, sRef, _)) -> do
690− readIORef sRef >>= \case
691− ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
692− ChildReadyState_Unready _ -> do
693− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
694− return $ Just $ Constant sRef
695− delete _ (Constant sRef) = do
696− writeIORef sRef $ ChildReadyState_Unready Nothing
697− return $ Constant ()
698− p' <- fmap PatchDMap $ DMap.traverseWithKey new $ unPatchDMap p
699− _ <- DMap.traverseWithKey delete $ PatchDMap.getDeletions p old
700− return $ applyAlways p' old
701− hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap updateChildUnreadiness $ \placeholders lastPlaceholderRef (PatchDMap p) -> do
702− phs <- liftIO $ readIORef placeholders
703− forM_ (DMap.toList p) $ \(k :=> ComposeMaybe mv) -> do
704− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
705− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phs
706− forM_ (Map.lookup (Some.This k) phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
707− forM_ mv $ \(Compose (df, _, _, _)) -> df `insertBefore` nextPlaceholder
708− liftIO $ writeIORef placeholders $! fromMaybe phs $ apply (weakenPatchDMapWith (\(Compose (_, ph, _, _)) -> ph) $ PatchDMap p) phs
1608+
1609+ {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
1610+ traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjust'
1611+ {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
1612+ traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjust'
1613+ {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
7091614 traverseDMapWithKeyWithAdjustWithMove = do
710− let updateChildUnreadiness (p :: PatchDMapWithMove k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) old = do
711− let new :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') a -> IO (PatchDMapWithMove.NodeInfo k (Constant (IORef (ChildReadyState k))) a)
1615+ let updateChildUnreadiness (p :: PatchDMapWithMove k (Compose (TraverseChild t m (Some k)) v')) old = do
1616+ let new :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseChild t m (Some k)) v') a -> IO (PatchDMapWithMove.NodeInfo k (Constant (IORef (ChildReadyState (Some k)))) a)
7121617 new k = PatchDMapWithMove.nodeInfoMapFromM $ \case
713− PatchDMapWithMove.From_Insert (Compose (_, _, sRef, _)) -> do
714− readIORef sRef >>= \case
1618+ PatchDMapWithMove.From_Insert (Compose (TraverseChild (Left _hydration) _)) -> return PatchDMapWithMove.From_Delete
1619+ PatchDMapWithMove.From_Insert (Compose (TraverseChild (Right immediate) _)) -> do
1620+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
7151621 ChildReadyState_Ready -> return PatchDMapWithMove.From_Delete
7161622 ChildReadyState_Unready _ -> do
717− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
718− return $ PatchDMapWithMove.From_Insert $ Constant sRef
1623+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
1624+ return $ PatchDMapWithMove.From_Insert $ Constant (_traverseChildImmediate_childReadyState immediate)
7191625 PatchDMapWithMove.From_Delete -> return PatchDMapWithMove.From_Delete
7201626 PatchDMapWithMove.From_Move fromKey -> return $ PatchDMapWithMove.From_Move fromKey
721− deleteOrMove :: forall a. k a -> Product (Constant (IORef (ChildReadyState k))) (ComposeMaybe k) a -> IO (Constant () a)
1627+ deleteOrMove :: forall a. k a -> Product (Constant (IORef (ChildReadyState (Some k)))) (ComposeMaybe k) a -> IO (Constant () a)
7221628 deleteOrMove _ (Pair (Constant sRef) (ComposeMaybe mToKey)) = do
723− writeIORef sRef $ ChildReadyState_Unready $ Some.This <$> mToKey -- This will be Nothing if deleting, and Just if moving, so it works out in both cases
1629+ writeIORef sRef $ ChildReadyState_Unready $ Some <$> mToKey -- This will be Nothing if deleting, and Just if moving, so it works out in both cases
7241630 return $ Constant ()
7251631 p' <- fmap unsafePatchDMapWithMove $ DMap.traverseWithKey new $ unPatchDMapWithMove p
7261632 _ <- DMap.traverseWithKey deleteOrMove $ PatchDMapWithMove.getDeletionsAndMoves p old
7271633 return $ applyAlways p' old
728− hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove updateChildUnreadiness $ \placeholders lastPlaceholderRef (p_ :: PatchDMapWithMove k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) -> do
1634+ hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove updateChildUnreadiness $ \placeholders lastPlaceholder (p_ :: PatchDMapWithMove k (Compose (TraverseChild t m (Some k)) v')) -> do
7291635 let p = unPatchDMapWithMove p_
7301636 phsBefore <- liftIO $ readIORef placeholders
731− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
732− let collectIfMoved :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') a -> JSM (Constant (Maybe DOM.DocumentFragment) a)
1637+ let collectIfMoved :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseChild t m (Some k)) v') a -> JSM (Constant (Maybe DOM.DocumentFragment) a)
7331638 collectIfMoved k e = do
734− let mThisPlaceholder = Map.lookup (Some.This k) phsBefore -- Will be Nothing if this element wasn't present before
735− nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsBefore
1639+ let mThisPlaceholder = Map.lookup (Some k) phsBefore -- Will be Nothing if this element wasn't present before
1640+ nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phsBefore
7361641 case isJust $ getComposeMaybe $ PatchDMapWithMove._nodeInfo_to e of
7371642 False -> do
7381643 mapM_ (`deleteUpTo` nextPlaceholder) mThisPlaceholder
@@ -740,13 +1645,22 @@ instance (Reflex t, MonadAdjust t m, MonadJSM m, MonadHold t m, MonadFix m, Prim
7401645 True -> do
7411646 Constant <$> mapM (`collectUpTo` nextPlaceholder) mThisPlaceholder
7421647 collected <- DMap.traverseWithKey collectIfMoved p
743− let !phsAfter = fromMaybe phsBefore $ apply (weakenPatchDMapWithMoveWith (\(Compose (_, ph, _, _)) -> ph) p_) phsBefore --TODO: Don't recompute this
744− let placeFragment :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') a -> JSM (Constant () a)
1648+ let !phsAfter = fromMaybe phsBefore $ apply filtered phsBefore
1649+ weakened :: PatchMapWithMove (Some k) (Either (TraverseChildHydration t m) (TraverseChildImmediate (Some k)))
1650+ weakened = weakenPatchDMapWithMoveWith (_traverseChild_mode . getCompose) p_
1651+ filtered :: PatchMapWithMove (Some k) DOM.Text
1652+ filtered = PatchMapWithMove $ flip Map.mapMaybe (unPatchMapWithMove weakened) $ \(PatchMapWithMove.NodeInfo from to) -> flip PatchMapWithMove.NodeInfo to <$> case from of
1653+ PatchMapWithMove.From_Insert (Left _hydration) -> Nothing
1654+ PatchMapWithMove.From_Insert (Right immediate) -> Just $ PatchMapWithMove.From_Insert $ _traverseChildImmediate_placeholder immediate
1655+ PatchMapWithMove.From_Delete -> Just $ PatchMapWithMove.From_Delete
1656+ PatchMapWithMove.From_Move k -> Just $ PatchMapWithMove.From_Move k
1657+ let placeFragment :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseChild t m (Some k)) v') a -> JSM (Constant () a)
7451658 placeFragment k e = do
746− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsAfter
1659+ let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phsAfter
7471660 case PatchDMapWithMove._nodeInfo_from e of
748− PatchDMapWithMove.From_Insert (Compose (df, _, _, _)) -> do
749− df `insertBefore` nextPlaceholder
1661+ PatchDMapWithMove.From_Insert (Compose (TraverseChild x _)) -> case x of
1662+ Left _ -> pure ()
1663+ Right immediate -> _traverseChildImmediate_fragment immediate `insertBefore` nextPlaceholder
7501664 PatchDMapWithMove.From_Delete -> do
7511665 return ()
7521666 PatchDMapWithMove.From_Move fromKey -> do
@@ -756,46 +1670,167 @@ instance (Reflex t, MonadAdjust t m, MonadJSM m, MonadHold t m, MonadFix m, Prim
7561670 mapM_ (\(k :=> v) -> void $ placeFragment k v) $ DMap.toDescList p -- We need to go in reverse order here, to make sure the placeholders are in the right spot at the right time
7571671 liftIO $ writeIORef placeholders $! phsAfter
7581672
759−data ChildReadyState k
1673+{-# INLINABLE traverseDMapWithKeyWithAdjust' #-}
1674+traverseDMapWithKeyWithAdjust'
1675+ :: forall s t m (k :: * -> *) v v'. (Adjustable t m, MonadHold t m, MonadFix m, MonadJSM m, PrimMonad m, GCompare k, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document)
1676+ => (forall a. k a -> v a -> HydrationDomBuilderT s t m (v' a))
1677+ -> DMap k v
1678+ -> Event t (PatchDMap k v)
1679+ -> HydrationDomBuilderT s t m (DMap k v', Event t (PatchDMap k v'))
1680+traverseDMapWithKeyWithAdjust' = do
1681+ let updateChildUnreadiness (p :: PatchDMap k (Compose (TraverseChild t m (Some k)) v')) old = do
1682+ let new :: forall a. k a -> ComposeMaybe (Compose (TraverseChild t m (Some k)) v') a -> IO (ComposeMaybe (Constant (IORef (ChildReadyState (Some k)))) a)
1683+ new k (ComposeMaybe m) = ComposeMaybe <$> case m of
1684+ Nothing -> return Nothing
1685+ Just (Compose (TraverseChild (Left _hydration) _)) -> pure Nothing
1686+ Just (Compose (TraverseChild (Right immediate) _)) -> do
1687+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
1688+ ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
1689+ ChildReadyState_Unready _ -> do
1690+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
1691+ return $ Just $ Constant (_traverseChildImmediate_childReadyState immediate)
1692+ delete _ (Constant sRef) = do
1693+ writeIORef sRef $ ChildReadyState_Unready Nothing
1694+ return $ Constant ()
1695+ p' <- fmap PatchDMap $ DMap.traverseWithKey new $ unPatchDMap p
1696+ _ <- DMap.traverseWithKey delete $ PatchDMap.getDeletions p old
1697+ return $ applyAlways p' old
1698+ hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap updateChildUnreadiness $ \placeholders lastPlaceholder (PatchDMap patch) -> do
1699+ phs <- liftIO $ readIORef placeholders
1700+ forM_ (DMap.toList patch) $ \(k :=> ComposeMaybe mv) -> do
1701+ let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phs
1702+ -- Delete old node
1703+ forM_ (Map.lookup (Some k) phs) $ \thisPlaceholder -> do
1704+ thisPlaceholder `deleteUpTo` nextPlaceholder
1705+ -- Insert new node
1706+ forM_ mv $ \(Compose (TraverseChild e _)) -> case e of
1707+ Left _hydration -> pure ()
1708+ Right immediate -> do
1709+ _traverseChildImmediate_fragment immediate `insertBefore` nextPlaceholder
1710+ let weakened :: PatchMap (Some k) (Either (TraverseChildHydration t m) (TraverseChildImmediate (Some k)))
1711+ weakened = weakenPatchDMapWith (_traverseChild_mode . getCompose) $ PatchDMap patch
1712+ filtered :: PatchMap (Some k) DOM.Text
1713+ filtered = PatchMap $ flip Map.mapMaybe (unPatchMap weakened) $ \case
1714+ Nothing -> Just Nothing -- deletion
1715+ Just (Left _) -> Nothing
1716+ Just (Right immediate) -> Just $ Just $ _traverseChildImmediate_placeholder immediate
1717+ liftIO $ writeIORef placeholders $! fromMaybe phs $ apply filtered phs
1718+
1719+{-# INLINABLE traverseIntMapWithKeyWithAdjust' #-}
1720+traverseIntMapWithKeyWithAdjust'
1721+ :: forall s t m v v'. (Adjustable t m, MonadJSM m, MonadFix m, PrimMonad m, MonadHold t m, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document)
1722+ => (IntMap.Key -> v -> HydrationDomBuilderT s t m v')
1723+ -> IntMap v
1724+ -> Event t (PatchIntMap v)
1725+ -> HydrationDomBuilderT s t m (IntMap v', Event t (PatchIntMap v'))
1726+traverseIntMapWithKeyWithAdjust' = do
1727+ let updateChildUnreadiness (p@(PatchIntMap pInner) :: PatchIntMap (TraverseChild t m Int v')) old = do
1728+ let new :: IntMap.Key -> Maybe (TraverseChild t m Int v') -> IO (Maybe (IORef (ChildReadyState Int)))
1729+ new k m = case m of
1730+ Nothing -> return Nothing
1731+ Just (TraverseChild (Left _hydration) _) -> pure Nothing
1732+ Just (TraverseChild (Right immediate) _) -> do
1733+ let sRef = _traverseChildImmediate_childReadyState immediate
1734+ readIORef sRef >>= \case
1735+ ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
1736+ ChildReadyState_Unready _ -> do
1737+ writeIORef sRef $ ChildReadyState_Unready $ Just k
1738+ return $ Just sRef
1739+ delete _ sRef = do
1740+ writeIORef sRef $ ChildReadyState_Unready Nothing
1741+ return ()
1742+ p' <- PatchIntMap <$> IntMap.traverseWithKey new pInner
1743+ _ <- IntMap.traverseWithKey delete $ FastMutableIntMap.getDeletions p old
1744+ return $ applyAlways p' old
1745+ hoistTraverseIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust updateChildUnreadiness $ \placeholders lastPlaceholder (PatchIntMap p) -> do
1746+ phs <- liftIO $ readIORef placeholders
1747+ forM_ (IntMap.toList p) $ \(k, mv) -> do
1748+ let nextPlaceholder = maybe lastPlaceholder snd $ IntMap.lookupGT k phs
1749+ -- Delete old node
1750+ forM_ (IntMap.lookup k phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
1751+ -- Insert new node
1752+ forM_ mv $ \(TraverseChild e _) -> case e of
1753+ Left _hydration -> pure ()
1754+ Right immediate -> do
1755+ _traverseChildImmediate_fragment immediate `insertBefore` nextPlaceholder
1756+ let filtered :: PatchIntMap DOM.Text
1757+ filtered = PatchIntMap $ flip IntMap.mapMaybe p $ \case
1758+ Nothing -> Just Nothing -- deletion
1759+ Just tc
1760+ | Right immediate <- _traverseChild_mode tc -> Just $ Just $ _traverseChildImmediate_placeholder immediate
1761+ | otherwise -> Nothing
1762+ liftIO $ writeIORef placeholders $! fromMaybe phs $ apply filtered phs
1763+
1764+{-# SPECIALIZE traverseIntMapWithKeyWithAdjust'
1765+ :: (IntMap.Key -> v -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM v')
1766+ -> IntMap v
1767+ -> Event DomTimeline (PatchIntMap v)
1768+ -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM (IntMap v', Event DomTimeline (PatchIntMap v'))
1769+ #-}
1770+
1771+{-# SPECIALIZE traverseIntMapWithKeyWithAdjust'
1772+ :: (IntMap.Key -> v -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM v')
1773+ -> IntMap v
1774+ -> Event DomTimeline (PatchIntMap v)
1775+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (IntMap v', Event DomTimeline (PatchIntMap v'))
1776+ #-}
1777+
1778+data ChildReadyState a
7601779 = ChildReadyState_Ready
761− | ChildReadyState_Unready !(Maybe (Some k))
1780+ | ChildReadyState_Unready !(Maybe a)
7621781 deriving (Show, Read, Eq, Ord)
7631782
764−hoistTraverseWithKeyWithAdjust :: forall (k :: * -> *) v v' t m p.
765− ( MonadAdjust t m
1783+insertAfterPreviousNode :: (Monad m, MonadJSM m) => DOM.IsNode node => node -> HydrationRunnerT t m ()
1784+insertAfterPreviousNode node = do
1785+ parent <- askParent
1786+ nextNode <- maybe (Node.getFirstChild parent) Node.getNextSibling =<< getPreviousNode
1787+ Node.insertBefore_ parent node nextNode
1788+ setPreviousNode $ Just $ toNode node
1789+
1790+{-# INLINABLE hoistTraverseWithKeyWithAdjust #-}
1791+hoistTraverseWithKeyWithAdjust
1792+ ::
1793+ ( Adjustable t m
7661794 , MonadHold t m
767− , DMap.GCompare k
1795+ , GCompare k
7681796 , MonadIO m
7691797 , MonadJSM m
7701798 , PrimMonad m
7711799 , MonadFix m
7721800 , Patch (p k v)
773− , PatchTarget (p k (Constant Int)) ~ DMap k (Constant Int)
774− , Monoid (p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v'))
7751801 , Patch (p k (Constant Int))
1802+ , PatchTarget (p k (Constant Int)) ~ DMap k (Constant Int)
1803+ , Patch (p k (Compose (TraverseChild t m (Some k)) v'))
1804+ , PatchTarget (p k (Compose (TraverseChild t m (Some k)) v')) ~ DMap k (Compose (TraverseChild t m (Some k)) v')
1805+ , Monoid (p k (Compose (TraverseChild t m (Some k)) v'))
1806+ , RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document
7761807 )
7771808 => (forall vv vv'.
778− (forall a. k a -> vv a -> RequesterT t JSM Identity (TriggerEventT t m) (vv' a))
1809+ (forall a. k a -> vv a -> DomRenderHookT t m (vv' a))
7791810 -> DMap k vv
7801811 -> Event t (p k vv)
781− -> RequesterT t JSM Identity (TriggerEventT t m) (DMap k vv', Event t (p k vv'))
782− ) -- ^ The base monad's traversal
783− -> (forall vv vv'. (forall a. vv a -> vv' a) -> p k vv -> p k vv') -- ^ A way of mapping over the patch type
784− -> (p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') -> DMap k (Constant (IORef (ChildReadyState k))) -> IO (DMap k (Constant (IORef (ChildReadyState k))))) -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
785− -> (IORef (Map.Map (Some.Some k) DOM.Text) -> IORef DOM.Text -> p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') -> JSM ()) -- ^ Apply a patch to the DOM
786− -> (forall a. k a -> v a -> ImmediateDomBuilderT t m (v' a))
1812+ -> DomRenderHookT t m (DMap k vv', Event t (p k vv')))
1813+ -- ^ The base monad's traversal
1814+ -> (forall vv vv'. (forall a. vv a -> vv' a) -> p k vv -> p k vv')
1815+ -- ^ A way of mapping over the patch type
1816+ -> (p k (Compose (TraverseChild t m (Some k)) v') -> DMap k (Constant (IORef (ChildReadyState (Some k)))) -> IO (DMap k (Constant (IORef (ChildReadyState (Some k))))))
1817+ -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
1818+ -> (IORef (Map.Map (Some k) DOM.Text) -> DOM.Text -> p k (Compose (TraverseChild t m (Some k)) v') -> JSM ())
1819+ -- ^ Apply a patch to the DOM
1820+ -> (forall a. k a -> v a -> HydrationDomBuilderT s t m (v' a))
7871821 -> DMap k v
7881822 -> Event t (p k v)
789− -> ImmediateDomBuilderT t m (DMap k v', Event t (p k v'))
790−hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpdate_ (f :: forall a. k a -> v a -> ImmediateDomBuilderT t m (v' a)) (dm0 :: DMap k v) dm' = do
791− initialEnv <- ImmediateDomBuilderT ask
792− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
793− pendingChange :: IORef (DMap k (Constant (IORef (ChildReadyState k))), p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) <- liftIO $ newIORef mempty
1823+ -> HydrationDomBuilderT s t m (DMap k v', Event t (p k v'))
1824+hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
1825+ doc <- askDocument
1826+ initialEnv <- HydrationDomBuilderT ask
1827+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
1828+ pendingChange :: IORef (DMap k (Constant (IORef (ChildReadyState (Some k)))), p k (Compose (TraverseChild t m (Some k)) v')) <- liftIO $ newIORef mempty
7941829 haveEverBeenReady <- liftIO $ newIORef False
795− placeholders <- liftIO $ newIORef $ error "placeholders not yet initialized"
796− lastPlaceholderRef <- liftIO $ newIORef $ error "lastPlaceholderRef not yet initialized"
1830+ placeholders <- liftIO $ newIORef Map.empty
1831+ lastPlaceholder <- createTextNode doc ("" :: Text)
7971832 let applyDomUpdate p = do
798− applyDomUpdate_ placeholders lastPlaceholderRef p
1833+ applyDomUpdate_ placeholders lastPlaceholder p
7991834 markSelfReady
8001835 liftIO $ writeIORef pendingChange $! mempty
8011836 markSelfReady = do
@@ -806,8 +1841,8 @@ hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpda
8061841 old <- liftIO $ readIORef parentUnreadyChildren
8071842 let new = pred old
8081843 liftIO $ writeIORef parentUnreadyChildren $! new
809− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
810− markChildReady :: IORef (ChildReadyState k) -> JSM ()
1844+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
1845+ markChildReady :: IORef (ChildReadyState (Some k)) -> JSM ()
8111846 markChildReady childReadyState = do
8121847 liftIO (readIORef childReadyState) >>= \case
8131848 ChildReadyState_Ready -> return ()
@@ -815,32 +1850,42 @@ hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpda
8151850 liftIO $ writeIORef childReadyState ChildReadyState_Ready
8161851 case countedAt of
8171852 Nothing -> return ()
818− Just (Some.This k) -> do -- This child has been counted as unready, so we need to remove it from the unready set
1853+ Just (Some k) -> do -- This child has been counted as unready, so we need to remove it from the unready set
8191854 (oldUnready, p) <- liftIO $ readIORef pendingChange
8201855 when (not $ DMap.null oldUnready) $ do -- This shouldn't actually ever be null
8211856 let newUnready = DMap.delete k oldUnready
8221857 liftIO $ writeIORef pendingChange (newUnready, p)
8231858 when (DMap.null newUnready) $ do
8241859 applyDomUpdate p
825− (children0, children') <- ImmediateDomBuilderT $ lift $ base (\k v -> drawChildUpdate initialEnv markChildReady $ f k v) dm0 dm'
826− let processChild k (Compose (_, _, sRef, _)) = ComposeMaybe <$> do
827− readIORef sRef >>= \case
828− ChildReadyState_Ready -> return Nothing
829− ChildReadyState_Unready _ -> do
830− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
831− return $ Just $ Constant sRef
1860+ (children0 :: DMap k (Compose (TraverseChild t m (Some k)) v'), children' :: Event t (p k (Compose (TraverseChild t m (Some k)) v')))
1861+ <- HydrationDomBuilderT $ lift $ base (\k v -> drawChildUpdate initialEnv markChildReady $ f k v) dm0 dm'
1862+ let processChild k (Compose (TraverseChild e _)) = case e of
1863+ Left _ -> pure $ ComposeMaybe Nothing
1864+ Right immediate -> ComposeMaybe <$> do
1865+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
1866+ ChildReadyState_Ready -> return Nothing
1867+ ChildReadyState_Unready _ -> do
1868+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
1869+ return $ Just $ Constant (_traverseChildImmediate_childReadyState immediate)
8321870 initialUnready <- liftIO $ DMap.mapMaybeWithKey (\_ -> getComposeMaybe) <$> DMap.traverseWithKey processChild children0
8331871 liftIO $ if DMap.null initialUnready
8341872 then writeIORef haveEverBeenReady True
8351873 else do
8361874 modifyIORef' parentUnreadyChildren succ
8371875 writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
838− let result0 = DMap.map (\(Compose (_, _, _, v)) -> v) children0
839− placeholders0 = weakenDMapWith (\(Compose (_, ph, _, _)) -> ph) children0
840− result' = ffor children' $ mapPatch $ \(Compose (_, _, _, r)) -> r
841− liftIO $ writeIORef placeholders $! placeholders0
842− _ <- DMap.traverseWithKey (\_ (Compose (df, _, _, _)) -> Constant () <$ append df) children0
843− liftIO . writeIORef lastPlaceholderRef =<< textNodeInternal ("" :: Text)
1876+ getHydrationMode >>= \case
1877+ HydrationMode_Hydrating -> addHydrationStepWithSetup (holdIncremental children0 children') $ \children -> do
1878+ dm :: DMap k (Compose (TraverseChild t m (Some k)) v') <- sample $ currentIncremental children
1879+ phs <- sequenceA $ weakenDMapWith (either _traverseChildHydration_delayed (pure . _traverseChildImmediate_placeholder) . _traverseChild_mode . getCompose) dm
1880+ liftIO $ writeIORef placeholders $! phs
1881+ insertAfterPreviousNode lastPlaceholder
1882+ HydrationMode_Immediate -> do
1883+ let activate i = do
1884+ append $ toNode $ _traverseChildImmediate_fragment i
1885+ pure $ _traverseChildImmediate_placeholder i
1886+ phs <- sequenceA $ weakenDMapWith (either (error "impossible") activate . _traverseChild_mode . getCompose) children0
1887+ liftIO $ writeIORef placeholders $! phs
1888+ append $ toNode lastPlaceholder
8441889 requestDomAction_ $ ffor children' $ \p -> do
8451890 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
8461891 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
@@ -848,29 +1893,257 @@ hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpda
8481893 liftIO $ writeIORef pendingChange (newUnready, newP)
8491894 when (DMap.null newUnready) $ do
8501895 applyDomUpdate newP
1896+ let result0 = DMap.map (_traverseChild_result . getCompose) children0
1897+ result' = ffor children' $ mapPatch $ _traverseChild_result . getCompose
1898+ return (result0, result')
1899+
1900+{-# INLINE hoistTraverseIntMapWithKeyWithAdjust #-}
1901+hoistTraverseIntMapWithKeyWithAdjust ::
1902+ ( Adjustable t m
1903+ , MonadHold t m
1904+ , MonadJSM m
1905+ , MonadFix m
1906+ , PrimMonad m
1907+ , Monoid (p (TraverseChild t m Int v'))
1908+ , Functor p
1909+ , PatchTarget (p (HydrationRunnerT t m ())) ~ IntMap (HydrationRunnerT t m ())
1910+ , PatchTarget (p (TraverseChild t m Int v')) ~ IntMap (TraverseChild t m Int v')
1911+ , Patch (p (HydrationRunnerT t m ()))
1912+ , Patch (p (TraverseChild t m Int v'))
1913+ , RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document
1914+ )
1915+ => ((IntMap.Key -> v -> DomRenderHookT t m (TraverseChild t m Int v'))
1916+ -> IntMap v
1917+ -> Event t (p v)
1918+ -> DomRenderHookT t m (IntMap (TraverseChild t m Int v'), Event t (p (TraverseChild t m Int v'))))
1919+ -- ^ The base monad's traversal
1920+ -> (p (TraverseChild t m Int v')
1921+ -> IntMap (IORef (ChildReadyState Int))
1922+ -> IO (IntMap (IORef (ChildReadyState Int))))
1923+ -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
1924+ -> (IORef (IntMap DOM.Text)
1925+ -> DOM.Text
1926+ -> p (TraverseChild t m Int v')
1927+ -> JSM ())
1928+ -- ^ Apply a patch to the DOM
1929+ -> (IntMap.Key -> v -> HydrationDomBuilderT s t m v')
1930+ -> IntMap v
1931+ -> Event t (p v)
1932+ -> HydrationDomBuilderT s t m (IntMap v', Event t (p v'))
1933+hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
1934+ doc <- askDocument
1935+ initialEnv <- HydrationDomBuilderT ask
1936+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
1937+ pendingChange :: IORef (IntMap (IORef (ChildReadyState Int)), p (TraverseChild t m Int v')) <- liftIO $ newIORef mempty
1938+ haveEverBeenReady <- liftIO $ newIORef False
1939+ placeholders <- liftIO $ newIORef IntMap.empty
1940+ lastPlaceholder <- createTextNode doc ("" :: Text)
1941+ let applyDomUpdate p = do
1942+ applyDomUpdate_ placeholders lastPlaceholder p
1943+ markSelfReady
1944+ liftIO $ writeIORef pendingChange $! mempty
1945+ markSelfReady = do
1946+ liftIO (readIORef haveEverBeenReady) >>= \case
1947+ True -> return ()
1948+ False -> do
1949+ liftIO $ writeIORef haveEverBeenReady True
1950+ old <- liftIO $ readIORef parentUnreadyChildren
1951+ let new = pred old
1952+ liftIO $ writeIORef parentUnreadyChildren $! new
1953+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
1954+ markChildReady :: IORef (ChildReadyState Int) -> JSM ()
1955+ markChildReady childReadyState = do
1956+ liftIO (readIORef childReadyState) >>= \case
1957+ ChildReadyState_Ready -> return ()
1958+ ChildReadyState_Unready countedAt -> do
1959+ liftIO $ writeIORef childReadyState ChildReadyState_Ready
1960+ case countedAt of
1961+ Nothing -> return ()
1962+ Just k -> do -- This child has been counted as unready, so we need to remove it from the unready set
1963+ (oldUnready, p) <- liftIO $ readIORef pendingChange
1964+ when (not $ IntMap.null oldUnready) $ do -- This shouldn't actually ever be null
1965+ let newUnready = IntMap.delete k oldUnready
1966+ liftIO $ writeIORef pendingChange (newUnready, p)
1967+ when (IntMap.null newUnready) $ do
1968+ applyDomUpdate p
1969+ (children0 :: IntMap (TraverseChild t m Int v'), children' :: Event t (p (TraverseChild t m Int v')))
1970+ <- HydrationDomBuilderT $ lift $ base (\k v -> drawChildUpdateInt initialEnv markChildReady $ f k v) dm0 dm'
1971+ let processChild k (TraverseChild e _) = case e of
1972+ Left _ -> pure Nothing
1973+ Right immediate -> do
1974+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
1975+ ChildReadyState_Ready -> return Nothing
1976+ ChildReadyState_Unready _ -> do
1977+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just k
1978+ return $ Just (_traverseChildImmediate_childReadyState immediate)
1979+ initialUnready <- liftIO $ IntMap.mapMaybe id <$> IntMap.traverseWithKey processChild children0
1980+ liftIO $ if IntMap.null initialUnready
1981+ then writeIORef haveEverBeenReady True
1982+ else do
1983+ modifyIORef' parentUnreadyChildren succ
1984+ writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
1985+ getHydrationMode >>= \case
1986+ HydrationMode_Hydrating -> addHydrationStepWithSetup (holdIncremental children0 children') $ \children -> do
1987+ dm :: IntMap (TraverseChild t m Int v') <- sample $ currentIncremental children
1988+ phs <- traverse (either _traverseChildHydration_delayed (pure . _traverseChildImmediate_placeholder) . _traverseChild_mode) dm
1989+ liftIO $ writeIORef placeholders $! phs
1990+ insertAfterPreviousNode lastPlaceholder
1991+ HydrationMode_Immediate -> do
1992+ let activate i = do
1993+ append $ toNode $ _traverseChildImmediate_fragment i
1994+ pure $ _traverseChildImmediate_placeholder i
1995+ phs <- traverse (either (error "impossible") activate . _traverseChild_mode) children0
1996+ liftIO $ writeIORef placeholders $! phs
1997+ append $ toNode lastPlaceholder
1998+ requestDomAction_ $ ffor children' $ \p -> do
1999+ (oldUnready, oldP) <- liftIO $ readIORef pendingChange
2000+ newUnready <- liftIO $ updateChildUnreadiness p oldUnready
2001+ let !newP = p <> oldP
2002+ liftIO $ writeIORef pendingChange (newUnready, newP)
2003+ when (IntMap.null newUnready) $ do
2004+ applyDomUpdate newP
2005+ let result0 = IntMap.map _traverseChild_result children0
2006+ result' = ffor children' $ fmap $ _traverseChild_result
8512007 return (result0, result')
8522008
853−drawChildUpdate :: (MonadIO m, MonadJSM m)
854− => ImmediateDomBuilderEnv t
2009+{-# SPECIALIZE hoistTraverseIntMapWithKeyWithAdjust
2010+ :: ((IntMap.Key -> v -> DomRenderHookT DomTimeline HydrationM (TraverseChild DomTimeline HydrationM Int v'))
2011+ -> IntMap v
2012+ -> Event DomTimeline (PatchIntMap v)
2013+ -> DomRenderHookT DomTimeline HydrationM (IntMap (TraverseChild DomTimeline HydrationM Int v'), Event DomTimeline (PatchIntMap (TraverseChild DomTimeline HydrationM Int v'))))
2014+ -> (PatchIntMap (TraverseChild DomTimeline HydrationM Int v')
2015+ -> IntMap (IORef (ChildReadyState Int))
2016+ -> IO (IntMap (IORef (ChildReadyState Int))))
2017+ -> (IORef (IntMap DOM.Text)
2018+ -> DOM.Text
2019+ -> PatchIntMap (TraverseChild DomTimeline HydrationM Int v')
2020+ -> JSM ())
2021+ -> (IntMap.Key -> v -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM v')
2022+ -> IntMap v
2023+ -> Event DomTimeline (PatchIntMap v)
2024+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (IntMap v', Event DomTimeline (PatchIntMap v'))
2025+ #-}
2026+
2027+{-# SPECIALIZE hoistTraverseIntMapWithKeyWithAdjust
2028+ :: ((IntMap.Key -> v -> DomRenderHookT DomTimeline HydrationM (TraverseChild DomTimeline HydrationM Int v'))
2029+ -> IntMap v
2030+ -> Event DomTimeline (PatchIntMap v)
2031+ -> DomRenderHookT DomTimeline HydrationM (IntMap (TraverseChild DomTimeline HydrationM Int v'), Event DomTimeline (PatchIntMap (TraverseChild DomTimeline HydrationM Int v'))))
2032+ -> (PatchIntMap (TraverseChild DomTimeline HydrationM Int v')
2033+ -> IntMap (IORef (ChildReadyState Int))
2034+ -> IO (IntMap (IORef (ChildReadyState Int))))
2035+ -> (IORef (IntMap DOM.Text)
2036+ -> DOM.Text
2037+ -> PatchIntMap (TraverseChild DomTimeline HydrationM Int v')
2038+ -> JSM ())
2039+ -> (IntMap.Key -> v -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM v')
2040+ -> IntMap v
2041+ -> Event DomTimeline (PatchIntMap v)
2042+ -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM (IntMap v', Event DomTimeline (PatchIntMap v'))
2043+ #-}
2044+
2045+data TraverseChildImmediate k = TraverseChildImmediate
2046+ { _traverseChildImmediate_fragment :: {-# UNPACK #-} !DOM.DocumentFragment
2047+ -- ^ Child is appended to this fragment
2048+ , _traverseChildImmediate_placeholder :: {-# UNPACK #-} !DOM.Text
2049+ -- ^ Placeholder reference
2050+ , _traverseChildImmediate_childReadyState :: {-# UNPACK #-} !(IORef (ChildReadyState k))
2051+ }
2052+
2053+newtype TraverseChildHydration t m = TraverseChildHydration
2054+ { _traverseChildHydration_delayed :: HydrationRunnerT t m DOM.Text
2055+ -- ^ Action to run at switchover, returns the placeholder
2056+ }
2057+
2058+data TraverseChild t m k a = TraverseChild
2059+ { _traverseChild_mode :: !(Either (TraverseChildHydration t m) (TraverseChildImmediate k))
2060+ , _traverseChild_result :: !a
2061+ } deriving Functor
2062+
2063+{-# INLINABLE drawChildUpdate #-}
2064+drawChildUpdate :: (MonadJSM m, Reflex t)
2065+ => HydrationDomBuilderEnv t m
8552066 -> (IORef (ChildReadyState k) -> JSM ()) -- This will NOT be called if the child is ready at initialization time; instead, the ChildReadyState return value will be ChildReadyState_Ready
856− -> ImmediateDomBuilderT t m (v' a)
857− -> RequesterT t JSM Identity (TriggerEventT t m) (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v' a)
2067+ -> HydrationDomBuilderT s t m (f a)
2068+ -> DomRenderHookT t m (Compose (TraverseChild t m k) f a)
8582069drawChildUpdate initialEnv markReady child = do
859− childReadyState <- liftIO $ newIORef $ ChildReadyState_Unready Nothing
2070+ let doc = _hydrationDomBuilderEnv_document initialEnv
8602071 unreadyChildren <- liftIO $ newIORef 0
861− df <- createDocumentFragment $ _immediateDomBuilderEnv_document initialEnv
862− (placeholder, result) <- runReaderT (unImmediateDomBuilderT $ (,) <$> textNodeInternal ("" :: Text) <*> child) $ initialEnv
863− { _immediateDomBuilderEnv_parent = toNode df
864− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
865− , _immediateDomBuilderEnv_commitAction = markReady childReadyState
866− }
867− u <- liftIO $ readIORef unreadyChildren
868− when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyState_Ready
869− return $ Compose (df, placeholder, childReadyState, result)
2072+ liftIO (readIORef $ _hydrationDomBuilderEnv_hydrationMode initialEnv) >>= \case
2073+ HydrationMode_Hydrating -> do
2074+ childDelayedRef <- liftIO $ newIORef $ pure ()
2075+ result <- runReaderT (unHydrationDomBuilderT child) initialEnv
2076+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
2077+ , _hydrationDomBuilderEnv_delayed = childDelayedRef
2078+ }
2079+ childDelayed <- liftIO $ readIORef childDelayedRef
2080+ return $ Compose $ TraverseChild
2081+ { _traverseChild_result = result
2082+ , _traverseChild_mode = Left TraverseChildHydration
2083+ { _traverseChildHydration_delayed = do
2084+ placeholder <- createTextNode doc ("" :: Text)
2085+ insertAfterPreviousNode placeholder
2086+ childDelayed
2087+ pure placeholder
2088+ }
2089+ }
2090+ HydrationMode_Immediate -> do
2091+ childReadyState <- liftIO $ newIORef $ ChildReadyState_Unready Nothing
2092+ df <- createDocumentFragment doc
2093+ placeholder <- createTextNode doc ("" :: Text)
2094+ Node.appendChild_ df placeholder
2095+ result <- runReaderT (unHydrationDomBuilderT child) initialEnv
2096+ { _hydrationDomBuilderEnv_parent = Left $ toNode df
2097+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
2098+ , _hydrationDomBuilderEnv_commitAction = markReady childReadyState
2099+ }
2100+ u <- liftIO $ readIORef unreadyChildren
2101+ when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyState_Ready
2102+ return $ Compose $ TraverseChild
2103+ { _traverseChild_result = result
2104+ , _traverseChild_mode = Right TraverseChildImmediate
2105+ { _traverseChildImmediate_fragment = df
2106+ , _traverseChildImmediate_placeholder = placeholder
2107+ , _traverseChildImmediate_childReadyState = childReadyState
2108+ }
2109+ }
8702110
871−mkHasFocus :: (MonadHold t m, Reflex t) => Element er d t -> m (Dynamic t Bool)
2111+{-# SPECIALIZE drawChildUpdate
2112+ :: HydrationDomBuilderEnv DomTimeline HydrationM
2113+ -> (IORef (ChildReadyState Int) -> JSM ())
2114+ -> HydrationDomBuilderT s DomTimeline HydrationM (Identity a)
2115+ -> DomRenderHookT DomTimeline HydrationM (Compose (TraverseChild DomTimeline HydrationM Int) Identity a)
2116+ #-}
2117+
2118+{-# SPECIALIZE drawChildUpdate
2119+ :: HydrationDomBuilderEnv DomTimeline HydrationM
2120+ -> (IORef (ChildReadyState (Some k)) -> JSM ())
2121+ -> HydrationDomBuilderT s DomTimeline HydrationM (f a)
2122+ -> DomRenderHookT DomTimeline HydrationM (Compose (TraverseChild DomTimeline HydrationM (Some k)) f a)
2123+ #-}
2124+
2125+{-# INLINABLE drawChildUpdateInt #-}
2126+drawChildUpdateInt :: (MonadIO m, MonadJSM m, Reflex t)
2127+ => HydrationDomBuilderEnv t m
2128+ -> (IORef (ChildReadyState k) -> JSM ())
2129+ -> HydrationDomBuilderT s t m v
2130+ -> DomRenderHookT t m (TraverseChild t m k v)
2131+drawChildUpdateInt env mark m = fmap runIdentity . getCompose <$> drawChildUpdate env mark (Identity <$> m)
2132+
2133+{-# SPECIALIZE drawChildUpdateInt
2134+ :: HydrationDomBuilderEnv DomTimeline HydrationM
2135+ -> (IORef (ChildReadyState k) -> JSM ())
2136+ -> HydrationDomBuilderT s DomTimeline HydrationM v
2137+ -> DomRenderHookT DomTimeline HydrationM (TraverseChild DomTimeline HydrationM k v)
2138+ #-}
2139+
2140+{-# INLINE mkHasFocus #-}
2141+mkHasFocus
2142+ :: (HasDocument m, MonadJSM m, IsNode (RawElement d), MonadHold t m, Reflex t, DOM.IsDocumentOrShadowRoot (RawDocument (DomBuilderSpace m)))
2143+ => Element er d t -> m (Dynamic t Bool)
8722144mkHasFocus e = do
873− let initialFocus = False --TODO: Actually get the initial focus of the element
2145+ doc <- askDocument
2146+ initialFocus <- Node.isSameNode (toNode $ _element_raw e) . fmap toNode =<< Document.getActiveElement doc
8742147 holdDyn initialFocus $ leftmost
8752148 [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
8762149 , True <$ Reflex.select (_element_events e) (WrapArg Focus)
@@ -879,39 +2152,49 @@ mkHasFocus e = do
8792152insertBefore :: (MonadJSM m, IsNode new, IsNode existing) => new -> existing -> m ()
8802153insertBefore new existing = do
8812154 p <- getParentNodeUnchecked existing
882− DOM.insertBefore_ p new (Just existing) -- If there's no parent, that means we've been removed from the DOM; this should not happen if the we're removing ourselves from the performEvent properly
2155+ Node.insertBefore_ p new (Just existing) -- If there's no parent, that means we've been removed from the DOM; this should not happen if the we're removing ourselves from the performEvent properly
8832156
884−instance PerformEvent t m => PerformEvent t (ImmediateDomBuilderT t m) where
885− type Performable (ImmediateDomBuilderT t m) = Performable m
2157+type ImmediateDomBuilderT = HydrationDomBuilderT GhcjsDomSpace
2158+
2159+instance PerformEvent t m => PerformEvent t (HydrationDomBuilderT s t m) where
2160+ type Performable (HydrationDomBuilderT s t m) = Performable m
8862161 {-# INLINABLE performEvent_ #-}
8872162 performEvent_ e = lift $ performEvent_ e
8882163 {-# INLINABLE performEvent #-}
8892164 performEvent e = lift $ performEvent e
8902165
891−instance PostBuild t m => PostBuild t (ImmediateDomBuilderT t m) where
2166+instance PostBuild t m => PostBuild t (HydrationDomBuilderT s t m) where
8922167 {-# INLINABLE getPostBuild #-}
8932168 getPostBuild = lift getPostBuild
8942169
895−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ImmediateDomBuilderT t m) where
2170+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydrationDomBuilderT s t m) where
8962171 {-# INLINABLE newEventWithTrigger #-}
8972172 newEventWithTrigger = lift . newEventWithTrigger
8982173 {-# INLINABLE newFanEventWithTrigger #-}
8992174 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
9002175
901−instance (Monad m, MonadRef m, Ref m ~ Ref IO, MonadReflexCreateTrigger t m) => TriggerEvent t (ImmediateDomBuilderT t m) where
2176+instance (Monad m, MonadRef m, Ref m ~ Ref IO, MonadReflexCreateTrigger t m) => TriggerEvent t (HydrationDomBuilderT s t m) where
9022177 {-# INLINABLE newTriggerEvent #-}
903− newTriggerEvent = ImmediateDomBuilderT . lift . lift $ newTriggerEvent
2178+ newTriggerEvent = HydrationDomBuilderT . lift $ newTriggerEvent
9042179 {-# INLINABLE newTriggerEventWithOnComplete #-}
905− newTriggerEventWithOnComplete = ImmediateDomBuilderT . lift . lift $ newTriggerEventWithOnComplete
2180+ newTriggerEventWithOnComplete = HydrationDomBuilderT . lift $ newTriggerEventWithOnComplete
9062181 {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
907− newEventWithLazyTriggerWithOnComplete f = ImmediateDomBuilderT . lift . lift $ newEventWithLazyTriggerWithOnComplete f
2182+ newEventWithLazyTriggerWithOnComplete f = HydrationDomBuilderT . lift $ newEventWithLazyTriggerWithOnComplete f
9082183
909−instance HasJSContext m => HasJSContext (ImmediateDomBuilderT t m) where
910− type JSContextPhantom (ImmediateDomBuilderT t m) = JSContextPhantom m
2184+instance (Monad m, MonadRef m, Ref m ~ Ref IO, MonadReflexCreateTrigger t m) => TriggerEvent t (DomRenderHookT t m) where
2185+ {-# INLINABLE newTriggerEvent #-}
2186+ newTriggerEvent = DomRenderHookT . lift $ newTriggerEvent
2187+ {-# INLINABLE newTriggerEventWithOnComplete #-}
2188+ newTriggerEventWithOnComplete = DomRenderHookT . lift $ newTriggerEventWithOnComplete
2189+ {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
2190+ newEventWithLazyTriggerWithOnComplete f = DomRenderHookT . lift $ newEventWithLazyTriggerWithOnComplete f
2191+
2192+instance HasJSContext m => HasJSContext (HydrationDomBuilderT s t m) where
2193+ type JSContextPhantom (HydrationDomBuilderT s t m) = JSContextPhantom m
9112194 askJSContext = lift askJSContext
9122195
913−instance MonadRef m => MonadRef (ImmediateDomBuilderT t m) where
914− type Ref (ImmediateDomBuilderT t m) = Ref m
2196+instance MonadRef m => MonadRef (HydrationDomBuilderT s t m) where
2197+ type Ref (HydrationDomBuilderT s t m) = Ref m
9152198 {-# INLINABLE newRef #-}
9162199 newRef = lift . newRef
9172200 {-# INLINABLE readRef #-}
@@ -919,12 +2202,12 @@ instance MonadRef m => MonadRef (ImmediateDomBuilderT t m) where
9192202 {-# INLINABLE writeRef #-}
9202203 writeRef r = lift . writeRef r
9212204
922−instance MonadAtomicRef m => MonadAtomicRef (ImmediateDomBuilderT t m) where
2205+instance MonadAtomicRef m => MonadAtomicRef (HydrationDomBuilderT s t m) where
9232206 {-# INLINABLE atomicModifyRef #-}
9242207 atomicModifyRef r = lift . atomicModifyRef r
9252208
926−instance (HasJS x m, ReflexHost t) => HasJS x (ImmediateDomBuilderT t m) where
927− type JSX (ImmediateDomBuilderT t m) = JSX m
2209+instance (HasJS x m, ReflexHost t) => HasJS x (HydrationDomBuilderT s t m) where
2210+ type JSX (HydrationDomBuilderT s t m) = JSX m
9282211 liftJS = lift . liftJS
9292212
9302213type family EventType en where
@@ -1014,7 +2297,7 @@ defaultDomEventHandler e evt = fmap (Just . EventResult) $ case evt of
10142297 Beforecopy -> return ()
10152298 Copy -> return ()
10162299 Beforepaste -> return ()
1017− Paste -> return ()
2300+ Paste -> getPasteData
10182301 Reset -> return ()
10192302 Search -> return ()
10202303 Selectstart -> return ()
@@ -1023,7 +2306,7 @@ defaultDomEventHandler e evt = fmap (Just . EventResult) $ case evt of
10232306 Touchend -> getTouchEvent
10242307 Touchcancel -> getTouchEvent
10252308 Mousewheel -> return ()
1026− Wheel -> return ()
2309+ Wheel -> getWheelEvent
10272310
10282311{-# INLINABLE defaultDomWindowEventHandler #-}
10292312defaultDomWindowEventHandler :: DOM.Window -> EventName en -> EventM DOM.Window (EventType en) (Maybe (EventResult en))
@@ -1064,7 +2347,7 @@ defaultDomWindowEventHandler w evt = fmap (Just . EventResult) $ case evt of
10642347 Beforecopy -> return ()
10652348 Copy -> return ()
10662349 Beforepaste -> return ()
1067− Paste -> return ()
2350+ Paste -> getPasteData
10682351 Reset -> return ()
10692352 Search -> return ()
10702353 Selectstart -> return ()
@@ -1073,7 +2356,7 @@ defaultDomWindowEventHandler w evt = fmap (Just . EventResult) $ case evt of
10732356 Touchend -> getTouchEvent
10742357 Touchcancel -> getTouchEvent
10752358 Mousewheel -> return ()
1076− Wheel -> return ()
2359+ Wheel -> getWheelEvent
10772360
10782361{-# INLINABLE withIsEvent #-}
10792362withIsEvent :: EventName en -> (IsEvent (EventType en) => r) -> r
@@ -1341,6 +2624,15 @@ getMouseEventCoords = do
13412624 e <- event
13422625 bisequence (getClientX e, getClientY e)
13432626
2627+{-# INLINABLE getPasteData #-}
2628+getPasteData :: EventM e ClipboardEvent (Maybe Text)
2629+getPasteData = do
2630+ e <- event
2631+ mdt <- ClipboardEvent.getClipboardData e
2632+ case mdt of
2633+ Nothing -> return Nothing
2634+ Just dt -> Just <$> DataTransfer.getData dt ("text" :: Text)
2635+
13442636{-# INLINABLE getTouchEvent #-}
13452637getTouchEvent :: EventM e TouchEvent TouchEventResult
13462638getTouchEvent = do
@@ -1382,17 +2674,41 @@ getTouchEvent = do
13822674 , _touchEventResult_touches = touches
13832675 }
13842676
1385−instance MonadSample t m => MonadSample t (ImmediateDomBuilderT t m) where
2677+{-# INLINABLE getWheelEvent #-}
2678+getWheelEvent :: EventM e WheelEvent WheelEventResult
2679+getWheelEvent = do
2680+ e <- event
2681+ dx :: Double <- WheelEvent.getDeltaX e
2682+ dy :: Double <- WheelEvent.getDeltaY e
2683+ dz :: Double <- WheelEvent.getDeltaZ e
2684+ deltaMode :: Word <- WheelEvent.getDeltaMode e
2685+ return $ WheelEventResult
2686+ { _wheelEventResult_deltaX = dx
2687+ , _wheelEventResult_deltaY = dy
2688+ , _wheelEventResult_deltaZ = dz
2689+ , _wheelEventResult_deltaMode = case deltaMode of
2690+ 0 -> DeltaPixel
2691+ 1 -> DeltaLine
2692+ 2 -> DeltaPage
2693+ -- See https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode
2694+ _ -> error "getWheelEvent: impossible encoding"
2695+ }
2696+
2697+instance MonadSample t m => MonadSample t (HydrationDomBuilderT s t m) where
13862698 {-# INLINABLE sample #-}
13872699 sample = lift . sample
13882700
1389−instance MonadHold t m => MonadHold t (ImmediateDomBuilderT t m) where
2701+instance MonadHold t m => MonadHold t (HydrationDomBuilderT s t m) where
13902702 {-# INLINABLE hold #-}
13912703 hold v0 v' = lift $ hold v0 v'
13922704 {-# INLINABLE holdDyn #-}
13932705 holdDyn v0 v' = lift $ holdDyn v0 v'
13942706 {-# INLINABLE holdIncremental #-}
13952707 holdIncremental v0 v' = lift $ holdIncremental v0 v'
2708+ {-# INLINABLE buildDynamic #-}
2709+ buildDynamic a0 = lift . buildDynamic a0
2710+ {-# INLINABLE headE #-}
2711+ headE = lift . headE
13962712
13972713data WindowConfig t = WindowConfig -- No config options yet
13982714
@@ -1404,7 +2720,7 @@ data Window t = Window
14042720 , _window_raw :: DOM.Window
14052721 }
14062722
1407−wrapWindow :: (MonadJSM m, MonadReflexCreateTrigger t m) => DOM.Window -> WindowConfig t -> ImmediateDomBuilderT t m (Window t)
2723+wrapWindow :: (MonadJSM m, MonadReflexCreateTrigger t m) => DOM.Window -> WindowConfig t -> HydrationDomBuilderT GhcjsDomSpace t m (Window t)
14082724wrapWindow wv _ = do
14092725 events <- wrapDomEventsMaybe wv (defaultDomWindowEventHandler wv) windowOnEventName
14102726 return $ Window
reflex-dom-core/src/Reflex/Dom/Builder/InputDisabled.hs+20−1
@@ -1,3 +1,4 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE FlexibleInstances #-}
23{-# LANGUAGE GeneralizedNewtypeDeriving #-}
34{-# LANGUAGE MultiParamTypeClasses #-}
@@ -15,6 +16,9 @@ import Control.Monad.Trans.Control
1516import Data.Coerce
1617import qualified Data.Map as Map
1718import Foreign.JavaScript.TH
19+#ifndef ghcjs_HOST_OS
20+import GHCJS.DOM.Types (MonadJSM (..))
21+#endif
1822import Reflex
1923import Reflex.Dom.Builder.Class
2024import Reflex.Dom.Builder.Immediate (HasDocument (..))
@@ -26,6 +30,11 @@ import Reflex.Host.Class
2630-- "select" as their tag will NOT be disabled.
2731newtype InputDisabledT m a = InputDisabledT { runInputDisabledT :: m a } deriving (Functor, Applicative, Monad, MonadAtomicRef, MonadFix, MonadIO)
2832
33+#ifndef ghcjs_HOST_OS
34+instance MonadJSM m => MonadJSM (InputDisabledT m) where
35+ liftJSM' = InputDisabledT . liftJSM'
36+#endif
37+
2938deriving instance MonadSample t m => MonadSample t (InputDisabledT m)
3039deriving instance MonadHold t m => MonadHold t (InputDisabledT m)
3140
@@ -67,10 +76,15 @@ instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (InputDisabl
6776 newEventWithTrigger = lift . newEventWithTrigger
6877 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
6978
70−instance MonadAdjust t m => MonadAdjust t (InputDisabledT m) where
79+instance Adjustable t m => Adjustable t (InputDisabledT m) where
7180 runWithReplace a0 a' = InputDisabledT $ runWithReplace (coerce a0) (coerceEvent a')
7281 traverseDMapWithKeyWithAdjust f dm0 dm' = InputDisabledT $ traverseDMapWithKeyWithAdjust (\k v -> runInputDisabledT $ f k v) (coerce dm0) (coerceEvent dm')
7382 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = InputDisabledT $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runInputDisabledT $ f k v) (coerce dm0) (coerceEvent dm')
83+ traverseIntMapWithKeyWithAdjust f m0 m' = InputDisabledT $ traverseIntMapWithKeyWithAdjust (\k v -> runInputDisabledT $ f k v) (coerce m0) (coerceEvent m')
84+
85+instance NotReady t m => NotReady t (InputDisabledT m) where
86+ notReadyUntil = lift . notReadyUntil
87+ notReady = lift notReady
7488
7589instance DomBuilder t m => DomBuilder t (InputDisabledT m) where
7690 type DomBuilderSpace (InputDisabledT m) = DomBuilderSpace m
@@ -95,3 +109,8 @@ instance HasJSContext m => HasJSContext (InputDisabledT m) where
95109instance HasJS js m => HasJS js (InputDisabledT m) where
96110 type JSX (InputDisabledT m) = JSX m
97111 liftJS = lift . liftJS
112+
113+instance DomRenderHook t m => DomRenderHook t (InputDisabledT m) where
114+ withRenderHook f = InputDisabledT . withRenderHook f . runInputDisabledT
115+ requestDomAction = InputDisabledT . requestDomAction
116+ requestDomAction_ = InputDisabledT . requestDomAction_
reflex-dom-core/src/Reflex/Dom/Builder/Static.hs+130−23
@@ -15,6 +15,7 @@
1515{-# LANGUAGE UndecidableInstances #-}
1616module Reflex.Dom.Builder.Static where
1717
18+import Data.IORef (IORef)
1819import Blaze.ByteString.Builder.Html.Utf8
1920import Control.Lens hiding (element)
2021import Control.Monad.Exception
@@ -32,22 +33,28 @@ import qualified Data.Dependent.Map as DMap
3233import Data.Dependent.Sum (DSum (..))
3334import Data.Functor.Compose
3435import Data.Functor.Constant
36+import Data.IntMap (IntMap)
37+import qualified Data.IntMap as IntMap
3538import qualified Data.Map as Map
36−import Data.Monoid
39+import Data.Map.Misc (applyMap)
40+import Data.Maybe (fromMaybe)
41+import Data.Monoid ((<>))
3742import qualified Data.Set as Set
3843import Data.Text (Text)
44+import qualified Data.Text as T
3945import Data.Text.Encoding
4046import Data.Tuple
4147import GHC.Generics
48+import Reflex.Adjustable.Class
4249import Reflex.Class
50+import Reflex.Dom.Main (DomHost, DomTimeline, runDomHost)
4351import Reflex.Dom.Builder.Class
44−import Reflex.Dom.Widget.Basic (applyMap)
4552import Reflex.Dynamic
4653import Reflex.Host.Class
4754import Reflex.PerformEvent.Base
4855import Reflex.PerformEvent.Class
4956import Reflex.PostBuild.Base
50−import Reflex.Spider
57+import Reflex.PostBuild.Class
5158import Reflex.TriggerEvent.Class
5259
5360data StaticDomBuilderEnv t = StaticDomBuilderEnv
@@ -57,6 +64,7 @@ data StaticDomBuilderEnv t = StaticDomBuilderEnv
5764 -- We use this to add a "selected" attribute to the appropriate "option" child element.
5865 -- This is not yet a perfect simulation of what the browser does, but it is much closer than doing nothing.
5966 -- TODO: Handle edge cases, e.g. setting to a value for which there is no option, then adding that option dynamically afterwards.
67+ , _staticDomBuilderEnv_nextRunWithReplaceKey :: IORef Int
6068 }
6169
6270newtype StaticDomBuilderT t m a = StaticDomBuilderT
@@ -76,6 +84,10 @@ runStaticDomBuilderT (StaticDomBuilderT a) e = do
7684 (result, a') <- runStateT (runReaderT a e) []
7785 return (result, mconcat $ reverse a')
7886
87+instance PostBuild t m => PostBuild t (StaticDomBuilderT t m) where
88+ {-# INLINABLE getPostBuild #-}
89+ getPostBuild = lift getPostBuild
90+
7991instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StaticDomBuilderT t m) where
8092 {-# INLINABLE newEventWithTrigger #-}
8193 newEventWithTrigger = lift . newEventWithTrigger
@@ -100,6 +112,10 @@ instance MonadHold t m => MonadHold t (StaticDomBuilderT t m) where
100112 holdDyn v0 v' = lift $ holdDyn v0 v'
101113 {-# INLINABLE holdIncremental #-}
102114 holdIncremental v0 v' = lift $ holdIncremental v0 v'
115+ {-# INLINABLE buildDynamic #-}
116+ buildDynamic a0 = lift . buildDynamic a0
117+ {-# INLINABLE headE #-}
118+ headE = lift . headE
103119
104120instance (Monad m, Ref m ~ Ref IO, Reflex t) => TriggerEvent t (StaticDomBuilderT t m) where
105121 {-# INLINABLE newTriggerEvent #-}
@@ -118,7 +134,7 @@ instance MonadRef m => MonadRef (StaticDomBuilderT t m) where
118134instance MonadAtomicRef m => MonadAtomicRef (StaticDomBuilderT t m) where
119135 atomicModifyRef r = lift . atomicModifyRef r
120136
121−type SupportsStaticDomBuilder t m = (Reflex t, MonadIO m, MonadHold t m, MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref IO, MonadAdjust t m)
137+type SupportsStaticDomBuilder t m = (Reflex t, MonadIO m, MonadHold t m, MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadRef m, Ref m ~ Ref IO, Adjustable t m)
122138
123139data StaticDomSpace
124140
@@ -134,29 +150,81 @@ instance Default (StaticEventSpec er)
134150
135151instance DomSpace StaticDomSpace where
136152 type EventSpec StaticDomSpace = StaticEventSpec
153+ type RawDocument StaticDomSpace = ()
137154 type RawTextNode StaticDomSpace = ()
155+ type RawCommentNode StaticDomSpace = ()
138156 type RawElement StaticDomSpace = ()
139− type RawFile StaticDomSpace = ()
140157 type RawInputElement StaticDomSpace = ()
141158 type RawTextAreaElement StaticDomSpace = ()
142159 type RawSelectElement StaticDomSpace = ()
143160 addEventSpecFlags _ _ _ _ = StaticEventSpec
144161
145−instance (Reflex t, MonadAdjust t m, MonadHold t m) => MonadAdjust t (StaticDomBuilderT t m) where
162+instance (SupportsStaticDomBuilder t m, Monad m) => HasDocument (StaticDomBuilderT t m) where
163+ askDocument = pure ()
164+
165+instance (Reflex t, Adjustable t m, MonadHold t m, SupportsStaticDomBuilder t m) => Adjustable t (StaticDomBuilderT t m) where
146166 runWithReplace a0 a' = do
147167 e <- StaticDomBuilderT ask
168+ key <- replaceStart e
148169 (result0, result') <- lift $ runWithReplace (runStaticDomBuilderT a0 e) (flip runStaticDomBuilderT e <$> a')
149170 o <- hold (snd result0) $ fmapCheap snd result'
150171 StaticDomBuilderT $ modify $ (:) $ join o
172+ replaceEnd key
151173 return (fst result0, fmapCheap fst result')
174+ traverseIntMapWithKeyWithAdjust = hoistIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust
152175 traverseDMapWithKeyWithAdjust = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap
153176 traverseDMapWithKeyWithAdjustWithMove = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove
154177
178+replaceStart :: (DomBuilder t m, MonadIO m) => StaticDomBuilderEnv t -> m Text
179+replaceStart env = do
180+ str <- show <$> liftIO (atomicModifyRef (_staticDomBuilderEnv_nextRunWithReplaceKey env) $ \k -> (succ k, k))
181+ let key = "-" <> T.pack str
182+ _ <- commentNode $ def { _commentNodeConfig_initialContents = "replace-start" <> key }
183+ pure key
184+
185+replaceEnd :: DomBuilder t m => Text -> m ()
186+replaceEnd key = void $ commentNode $ def { _commentNodeConfig_initialContents = "replace-end" <> key }
187+
188+hoistIntMapWithKeyWithAdjust :: forall t m p a b.
189+ ( Adjustable t m
190+ , MonadHold t m
191+ , Patch (p a)
192+ , Functor p
193+ , Patch (p (Behavior t Builder))
194+ , PatchTarget (p (Behavior t Builder)) ~ IntMap (Behavior t Builder)
195+ , Ref m ~ IORef, MonadIO m, MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadRef m -- TODO remove
196+ )
197+ => (forall x. (IntMap.Key -> a -> m x)
198+ -> IntMap a
199+ -> Event t (p a)
200+ -> m (IntMap x, Event t (p x))
201+ ) -- ^ The base monad's traversal
202+ -> (IntMap.Key -> a -> StaticDomBuilderT t m b)
203+ -> IntMap a
204+ -> Event t (p a)
205+ -> StaticDomBuilderT t m (IntMap b, Event t (p b))
206+hoistIntMapWithKeyWithAdjust base f im0 im' = do
207+ e <- StaticDomBuilderT ask
208+ (children0, children') <- lift $ base (\k v -> runStaticDomBuilderT (f k v) e) im0 im'
209+ let result0 = IntMap.map fst children0
210+ result' = (fmap . fmap) fst children'
211+ outputs0 :: IntMap (Behavior t Builder)
212+ outputs0 = IntMap.map snd children0
213+ outputs' :: Event t (p (Behavior t Builder))
214+ outputs' = (fmap . fmap) snd children'
215+ outputs <- holdIncremental outputs0 outputs'
216+ StaticDomBuilderT $ modify $ (:) $ pull $ do
217+ os <- sample $ currentIncremental outputs
218+ fmap mconcat $ forM (IntMap.toList os) $ \(_, o) -> do
219+ sample o
220+ return (result0, result')
221+
155222hoistDMapWithKeyWithAdjust :: forall (k :: * -> *) v v' t m p.
156− ( MonadAdjust t m
223+ ( Adjustable t m
157224 , MonadHold t m
158225 , PatchTarget (p k (Constant (Behavior t Builder))) ~ DMap k (Constant (Behavior t Builder))
159226 , Patch (p k (Constant (Behavior t Builder)))
227+ , Ref m ~ IORef, MonadIO m, MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadRef m -- TODO remove
160228 )
161229 => (forall vv vv'.
162230 (forall a. k a -> vv a -> m (vv' a))
@@ -185,6 +253,10 @@ hoistDMapWithKeyWithAdjust base mapPatch f dm0 dm' = do
185253 sample o
186254 return (result0, result')
187255
256+instance SupportsStaticDomBuilder t m => NotReady t (StaticDomBuilderT t m) where
257+ notReadyUntil _ = pure ()
258+ notReady = pure ()
259+
188260-- TODO: the uses of illegal lenses in this instance causes it to be somewhat less efficient than it can be. replacing them with explicit cases to get the underlying Maybe Event and working with those is ideal.
189261instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) where
190262 type DomBuilderSpace (StaticDomBuilderT t m) = StaticDomSpace
@@ -197,6 +269,15 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
197269 Nothing -> return (pure (escape initialContents))
198270 Just setContents -> hold (escape initialContents) $ fmapCheap escape setContents --Only because it doesn't get optimized when profiling is on
199271 return $ TextNode ()
272+ {-# INLINABLE commentNode #-}
273+ commentNode (CommentNodeConfig initialContents mSetContents) = StaticDomBuilderT $ do
274+ --TODO: Do not escape quotation marks; see https://stackoverflow.com/questions/25612166/what-characters-must-be-escaped-in-html-5
275+ shouldEscape <- asks _staticDomBuilderEnv_shouldEscape
276+ let escape = if shouldEscape then fromHtmlEscapedText else byteString . encodeUtf8
277+ (modify . (:)) . (\c -> "<!--" <> c <> "-->") =<< case mSetContents of
278+ Nothing -> return (pure (escape initialContents))
279+ Just setContents -> hold (escape initialContents) $ fmapCheap escape setContents --Only because it doesn't get optimized when profiling is on
280+ return $ CommentNode ()
200281 {-# INLINABLE element #-}
201282 element elementTag cfg child = do
202283 -- https://www.w3.org/TR/html-markup/syntax.html#syntax-elements
@@ -206,7 +287,8 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
206287 es <- newFanEventWithTrigger $ \_ _ -> return (return ())
207288 StaticDomBuilderT $ do
208289 let shouldEscape = elementTag `Set.notMember` noEscapeElements
209− (result, innerHtml) <- lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv shouldEscape Nothing
290+ nextRunWithReplaceKey <- asks _staticDomBuilderEnv_nextRunWithReplaceKey
291+ (result, innerHtml) <- lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv shouldEscape Nothing nextRunWithReplaceKey
210292 attrs0 <- foldDyn applyMap (cfg ^. initialAttributes) (cfg ^. modifyAttributes)
211293 selectValue <- asks _staticDomBuilderEnv_selectValue
212294 let addSelectedAttr attrs sel = case Map.lookup "value" attrs of
@@ -230,13 +312,32 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
230312 return (e, result)
231313 {-# INLINABLE inputElement #-}
232314 inputElement cfg = do
233− (e, _result) <- element "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
234− let v0 = constDyn $ cfg ^. inputElementConfig_initialValue
235− let c0 = constDyn $ cfg ^. inputElementConfig_initialChecked
315+ -- Tweak the config to update the "value" and "checked" attributes appropriately.
316+ -- TODO: warn upon overwriting values.
317+ let setInitialValue = Map.insert "value" (_inputElementConfig_initialValue cfg)
318+ setUpdatedValue updatedAttrs = case _inputElementConfig_setValue cfg of
319+ Nothing -> updatedAttrs
320+ Just e -> (Map.singleton "value" . Just <$> e) <> updatedAttrs
321+ setInitialChecked = case _inputElementConfig_initialChecked cfg of
322+ True -> Map.insert "checked" "checked"
323+ False -> id
324+ setUpdatedChecked updatedAttrs = case _inputElementConfig_setChecked cfg of
325+ Nothing -> updatedAttrs
326+ Just e -> (Map.singleton "checked" (Just "checked") <$ e) <> updatedAttrs
327+ adjustedConfig = _inputElementConfig_elementConfig cfg
328+ & elementConfig_initialAttributes %~ setInitialValue . setInitialChecked
329+ & elementConfig_modifyAttributes %~ setUpdatedValue . setUpdatedChecked
330+ (e, _result) <- element "input" adjustedConfig $ return ()
331+ v <- case _inputElementConfig_setValue cfg of
332+ Nothing -> pure $ constDyn (cfg ^. inputElementConfig_initialValue)
333+ Just ev -> holdDyn (cfg ^. inputElementConfig_initialValue) ev
334+ c <- case _inputElementConfig_setChecked cfg of
335+ Nothing -> pure $ constDyn $ _inputElementConfig_initialChecked cfg
336+ Just ev -> holdDyn (_inputElementConfig_initialChecked cfg) ev
236337 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
237338 return $ InputElement
238− { _inputElement_value = v0
239− , _inputElement_checked = c0
339+ { _inputElement_value = v
340+ , _inputElement_checked = c
240341 , _inputElement_checkedChange = never
241342 , _inputElement_input = never
242343 , _inputElement_hasFocus = hasFocus
@@ -246,12 +347,17 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
246347 }
247348 {-# INLINABLE textAreaElement #-}
248349 textAreaElement cfg = do
249− --TODO: Support setValue event
250− (e, _domElement) <- element "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
251− let v0 = constDyn $ cfg ^. textAreaElementConfig_initialValue
350+ (e, _domElement) <- element "textarea" (_textAreaElementConfig_elementConfig cfg) $ do
351+ -- Set the initial value
352+ void $ textNode $ def
353+ & textNodeConfig_initialContents .~ _textAreaElementConfig_initialValue cfg
354+ & textNodeConfig_setContents .~ fromMaybe never (_textAreaElementConfig_setValue cfg)
355+ v <- case _textAreaElementConfig_setValue cfg of
356+ Nothing -> pure $ constDyn (cfg ^. textAreaElementConfig_initialValue)
357+ Just ev -> holdDyn (cfg ^. textAreaElementConfig_initialValue) ev
252358 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
253359 return $ TextAreaElement
254− { _textAreaElement_value = v0
360+ { _textAreaElement_value = v
255361 , _textAreaElement_input = never
256362 , _textAreaElement_hasFocus = hasFocus
257363 , _textAreaElement_element = e
@@ -260,7 +366,9 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
260366 selectElement cfg child = do
261367 v <- holdDyn (cfg ^. selectElementConfig_initialValue) (cfg ^. selectElementConfig_setValue)
262368 (e, result) <- element "select" (_selectElementConfig_elementConfig cfg) $ do
263− (a, innerHtml) <- StaticDomBuilderT $ lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv False $ Just (current v)
369+ (a, innerHtml) <- StaticDomBuilderT $ do
370+ nextRunWithReplaceKey <- asks _staticDomBuilderEnv_nextRunWithReplaceKey
371+ lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv False (Just $ current v) nextRunWithReplaceKey
264372 StaticDomBuilderT $ lift $ modify $ (:) innerHtml
265373 return a
266374 let wrapped = SelectElement
@@ -273,18 +381,17 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
273381 return (wrapped, result)
274382 placeRawElement () = return ()
275383 wrapRawElement () _ = return $ Element (EventSelector $ const never) ()
276− notReadyUntil _ = return () --TODO: Do we need to support this somehow?
277− notReady = return () --TODO: Do we need to support this somehow?
278384
279385--TODO: Make this more abstract --TODO: Put the WithWebView underneath PerformEventT - I think this would perform better
280−type StaticWidget x = PostBuildT Spider (StaticDomBuilderT Spider (PerformEventT Spider (SpiderHost Global)))
386+type StaticWidget x = PostBuildT DomTimeline (StaticDomBuilderT DomTimeline (PerformEventT DomTimeline DomHost))
281387
282388{-# INLINE renderStatic #-}
283389renderStatic :: StaticWidget x a -> IO (a, ByteString)
284390renderStatic w = do
285− runSpiderHost $ do
391+ runDomHost $ do
286392 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
287− let env0 = StaticDomBuilderEnv True Nothing
393+ nextRunWithReplaceKey <- newRef 0
394+ let env0 = StaticDomBuilderEnv True Nothing nextRunWithReplaceKey
288395 ((res, bs), FireCommand fire) <- hostPerformEventT $ runStaticDomBuilderT (runPostBuildT w postBuild) env0
289396 mPostBuildTrigger <- readRef postBuildTriggerRef
290397 forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
reflex-dom-core/src/Reflex/Dom/Class.hs+4−7
@@ -4,8 +4,7 @@ module Reflex.Dom.Class ( module Reflex.Dom.Class
44 , module Web.KeyCode
55 ) where
66
7−import Data.Map (Map)
8−import qualified Data.Map as Map
7+import Control.Lens
98import Reflex.Class
109import Web.KeyCode
1110
@@ -13,11 +12,9 @@ import Foreign.JavaScript.TH
1312import Reflex.PerformEvent.Class
1413import Reflex.PostBuild.Class
1514
16−import Prelude hiding (concat, mapM, mapM_, sequence)
17−
18−-- | Alias for Data.Map.singleton
19−(=:) :: k -> a -> Map k a
20−(=:) = Map.singleton
15+-- | Previously an alias for 'Data.Map.singleton', but now generalised to 'At'
16+(=:) :: (At m, Monoid m) => Index m -> IxValue m -> m
17+k =: a = at k ?~ a $ mempty
2118infixr 7 =: -- Ought to bind tighter than <>, which is infixr 6
2219
2320{-# DEPRECATED keycodeEnter "Instead of `x == keycodeEnter`, use `keyCodeLookup x == Enter`" #-}
reflex-dom-core/src/Reflex/Dom/Core.hs+8−1
@@ -1,15 +1,22 @@
1+-- Disable haddocks on this module due to a bug on haddocks when selectively
2+-- reexporting on ghc > 8.2.
3+-- https://github.com/haskell/haddock/issues/979
4+{-# OPTIONS_HADDOCK hide, prune, ignore-exports #-}
15module Reflex.Dom.Core (module X) where
26
37import Reflex as X hiding (askEvents)
48import Reflex.Dom.Builder.Class as X
9+import Reflex.Dom.Builder.Hydratable as X
510import Reflex.Dom.Builder.Immediate as X
611import Reflex.Dom.Builder.InputDisabled as X
712import Reflex.Dom.Builder.Static as X
813import Reflex.Dom.Class as X
914import Reflex.Dom.Location as X
1015import Reflex.Dom.Main as X
16+import Reflex.Dom.Modals.Class as X
1117import Reflex.Dom.Old as X
12−import Reflex.Dom.Time as X
18+import Reflex.Dom.Prerender as X
1319import Reflex.Dom.WebSocket as X
1420import Reflex.Dom.Widget as X
1521import Reflex.Dom.Xhr as X
22+import Reflex.Dom.Xhr.FormData as X
reflex-dom-core/src/Reflex/Dom/Location.hs+194−7
@@ -1,13 +1,200 @@
1−module Reflex.Dom.Location (getLocationHost, getLocationProtocol) where
1+{-# LANGUAGE FlexibleContexts #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE MultiParamTypeClasses #-}
4+{-# LANGUAGE OverloadedStrings #-}
5+{-# LANGUAGE RankNTypes #-}
6+module Reflex.Dom.Location
7+ ( browserHistoryWith
8+ , getLocationAfterHost
9+ , getLocationFragment
10+ , getLocationHost
11+ , getLocationPath
12+ , getLocationProtocol
13+ , getLocationUrl
14+ , manageHistory
15+ , manageHistory'
16+ , HistoryCommand (..)
17+ , HistoryStateUpdate (..)
18+ , HistoryItem (..)
19+ , getLocationUri
20+ ) where
221
22+import Reflex
23+import Reflex.Dom.Builder.Immediate (wrapDomEvent)
24+
25+import Control.Lens ((^.))
26+import Control.Monad ((>=>))
27+import Control.Monad.Fix (MonadFix)
28+import Data.Align (align)
29+import Data.Monoid
330import Data.Text (Text)
4−import GHCJS.DOM (currentWindowUnchecked)
5−import GHCJS.DOM.Location (getHost, getProtocol)
6−import GHCJS.DOM.Types (MonadJSM)
7−import GHCJS.DOM.Window (getLocation)
31+import Data.These (These(..))
32+import qualified GHCJS.DOM as DOM
33+import qualified GHCJS.DOM.EventM as DOM
34+import qualified GHCJS.DOM.Location as Location
35+import qualified GHCJS.DOM.History as History
36+import qualified GHCJS.DOM.PopStateEvent as PopStateEvent
37+import GHCJS.DOM.Types (Location, History, SerializedScriptValue (..), liftJSM)
38+import qualified GHCJS.DOM.Types as DOM
39+import qualified GHCJS.DOM.Window as Window
40+import qualified GHCJS.DOM.WindowEventHandlers as DOM
41+import Language.Javascript.JSaddle (FromJSString, MonadJSM, ToJSString, fromJSValUnchecked, js1, ToJSVal (..), FromJSVal (..))
42+import Network.URI
43+
44+withLocation :: (MonadJSM m) => (Location -> m a) -> m a
45+withLocation f = DOM.currentWindowUnchecked >>= Window.getLocation >>= f
46+
47+-- | Returns the full URI-decoded URL of the current window location.
48+getLocationUrl :: (MonadJSM m) => m Text
49+getLocationUrl = withLocation (Location.getHref >=> decodeURIText)
850
51+-- | Returns the host of the current window location
952getLocationHost :: (MonadJSM m) => m Text
10−getLocationHost = currentWindowUnchecked >>= getLocation >>= getHost
53+getLocationHost = withLocation Location.getHost
1154
55+-- | Returns the protocol/scheme (e.g. @http:@ or @https:@) of the current window location
1256getLocationProtocol :: (MonadJSM m) => m Text
13−getLocationProtocol = currentWindowUnchecked >>= getLocation >>= getProtocol
57+getLocationProtocol = withLocation Location.getProtocol
58+
59+-- | Returns the URI-decoded location after the host and port; i.e. returns the path, query, and fragment of the location.
60+getLocationAfterHost :: (MonadJSM m) => m Text
61+getLocationAfterHost = withLocation $ \loc -> do
62+ pathname <- Location.getPathname loc
63+ search <- Location.getSearch loc
64+ hash <- Location.getHash loc
65+ decodeURI (mconcat [pathname, search, hash] :: Text)
66+
67+-- | Returns the URI-decoded path of the current window location.
68+getLocationPath :: (MonadJSM m) => m Text
69+getLocationPath = withLocation (Location.getPathname >=> decodeURIText)
70+
71+-- | Returns the URI-decoded fragment/hash of the current window location.
72+getLocationFragment :: (MonadJSM m) => m Text
73+getLocationFragment = withLocation (Location.getHash >=> decodeURIText)
74+
75+
76+-- | Decodes a URI with JavaScript's @decodeURI@ function.
77+--
78+-- FIXME: @decodeURI@ will throw when URI is malformed
79+decodeURI :: (MonadJSM m, ToJSString a, FromJSString b) => a -> m b
80+decodeURI input = do
81+ window <- DOM.currentWindowUnchecked
82+ window' <- DOM.liftJSM $ toJSVal window
83+ DOM.liftJSM $ window' ^. js1 ("decodeURI"::Text) input >>= fromJSValUnchecked
84+
85+decodeURIText :: (MonadJSM m) => Text -> m Text
86+decodeURIText = decodeURI
87+
88+-- | Builds a Dynamic carrying the current window location.
89+browserHistoryWith :: (MonadJSM m, TriggerEvent t m, MonadHold t m)
90+ => (forall jsm. MonadJSM jsm => Location -> jsm a)
91+ -- ^ A function to encode the window location in a more useful form (e.g. @getLocationAfterHost@).
92+ -> m (Dynamic t a)
93+browserHistoryWith f = do
94+ window <- DOM.currentWindowUnchecked
95+ location <- Window.getLocation window
96+ loc0 <- f location
97+ locEv <- wrapDomEvent window (`DOM.on` DOM.popState) $ f location
98+ holdDyn loc0 locEv
99+
100+--TODO: Pending https://github.com/haskell/network-uri/issues/39, ensure that
101+--we're handling escaping of URIs correctly
102+data HistoryItem = HistoryItem
103+ { _historyItem_state :: SerializedScriptValue
104+ , _historyItem_uri :: URI
105+ -- ^ NOTE: All URIs in this module are assumed to be already percent-escaped
106+ }
107+
108+data HistoryStateUpdate = HistoryStateUpdate
109+ { _historyStateUpdate_state :: SerializedScriptValue
110+ , _historyStateUpdate_title :: Text
111+ , _historyStateUpdate_uri :: Maybe URI
112+ -- ^ If Just, update the URI; otherwise leave it unchanged
113+ -- NOTE: All URIs in this module are assumed to be already percent-escaped
114+ }
115+
116+data HistoryCommand
117+ = HistoryCommand_PushState HistoryStateUpdate
118+ | HistoryCommand_ReplaceState HistoryStateUpdate
119+
120+runHistoryCommand :: MonadJSM m => History -> HistoryCommand -> m ()
121+runHistoryCommand history = \case
122+ HistoryCommand_PushState su -> History.pushState history
123+ (_historyStateUpdate_state su)
124+ (_historyStateUpdate_title su)
125+ (show <$> _historyStateUpdate_uri su)
126+ HistoryCommand_ReplaceState su -> History.replaceState history
127+ (_historyStateUpdate_state su)
128+ (_historyStateUpdate_title su)
129+ (show <$> _historyStateUpdate_uri su)
130+
131+getLocationUriAuth :: MonadJSM m => Location -> m URIAuth
132+getLocationUriAuth location = URIAuth "" -- Username and password don't seem to be available in most browsers
133+ <$> Location.getHostname location
134+ <*> (appendColonIfNotEmpty <$> Location.getPort location)
135+ where appendColonIfNotEmpty = \case
136+ "" -> ""
137+ x -> ":" <> x
138+
139+getLocationUri :: MonadJSM m => Location -> m URI
140+getLocationUri location = URI
141+ <$> Location.getProtocol location
142+ <*> (Just <$> getLocationUriAuth location)
143+ <*> Location.getPathname location
144+ <*> Location.getSearch location
145+ <*> Location.getHash location
146+
147+manageHistory :: (MonadJSM m, TriggerEvent t m, MonadHold t m, PerformEvent t m, MonadJSM (Performable m)) => Event t HistoryCommand -> m (Dynamic t HistoryItem)
148+manageHistory runCmd = do
149+ window <- DOM.currentWindowUnchecked
150+ location <- Window.getLocation window
151+ history <- Window.getHistory window
152+ let getCurrentHistoryItem = HistoryItem
153+ <$> History.getState history
154+ <*> getLocationUri location
155+ item0 <- liftJSM getCurrentHistoryItem
156+ itemSetInternal <- performEvent $ ffor runCmd $ \cmd -> liftJSM $ do
157+ runHistoryCommand history cmd
158+ getCurrentHistoryItem
159+ itemSetExternal <- wrapDomEvent window (`DOM.on` DOM.popState) $ do
160+ e <- DOM.event
161+ HistoryItem
162+ <$> (SerializedScriptValue <$> PopStateEvent.getState e)
163+ <*> getLocationUri location
164+ holdDyn item0 $ leftmost [itemSetInternal, itemSetExternal]
165+--TODO: Handle title setting better
166+
167+manageHistory'
168+ :: (MonadFix m, MonadJSM m, TriggerEvent t m, MonadHold t m, PerformEvent t m, MonadJSM (Performable m))
169+ => Event t ()
170+ -- ^ Don't do anything until this event has fired
171+ -> Event t HistoryCommand
172+ -> m (Dynamic t HistoryItem)
173+manageHistory' switchover runCmd = do
174+ window <- DOM.currentWindowUnchecked
175+ location <- Window.getLocation window
176+ history <- Window.getHistory window
177+ let getCurrentHistoryItem = HistoryItem
178+ <$> History.getState history
179+ <*> getLocationUri location
180+ item0 <- liftJSM getCurrentHistoryItem
181+ itemSetExternal' <- wrapDomEvent window (`DOM.on` DOM.popState) $ do
182+ e <- DOM.event
183+ HistoryItem
184+ <$> (SerializedScriptValue <$> PopStateEvent.getState e)
185+ <*> getLocationUri location
186+ let f :: (Bool, Maybe a) -> These a () -> (Maybe (Bool, Maybe a), Maybe a)
187+ f (switched, acc) = \case
188+ This change
189+ | switched -> (Nothing, Just change)
190+ | otherwise -> (Just (switched, Just change), Nothing)
191+ That () -> (Just (True, Nothing), acc)
192+ These change () -> (Just (True, Nothing), Just change)
193+ -- Accumulate the events before switchover
194+ (_, cmd') <- mapAccumMaybeB f (False, Nothing) $ align (leftmost [Left <$> runCmd, Right <$> itemSetExternal']) switchover
195+ let (itemSetInternal', itemSetExternal) = fanEither cmd'
196+ itemSetInternal <- performEvent $ ffor itemSetInternal' $ \cmd -> liftJSM $ do
197+ runHistoryCommand history cmd
198+ getCurrentHistoryItem
199+ holdDyn item0 $ leftmost [itemSetInternal, itemSetExternal]
200+--TODO: Handle title setting better
reflex-dom-core/src/Reflex/Dom/Main.hs+235−49
@@ -1,20 +1,23 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE ConstraintKinds #-}
23{-# LANGUAGE FlexibleContexts #-}
34{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE GADTs #-}
56{-# LANGUAGE MultiParamTypeClasses #-}
67{-# LANGUAGE NoMonomorphismRestriction #-}
7−{-# LANGUAGE PatternSynonyms #-}
88{-# LANGUAGE RankNTypes #-}
99{-# LANGUAGE RecursiveDo #-}
1010{-# LANGUAGE ScopedTypeVariables #-}
1111{-# LANGUAGE TypeFamilies #-}
1212{-# LANGUAGE TypeOperators #-}
1313{-# LANGUAGE UndecidableInstances #-}
14+{-# OPTIONS_GHC -fspecialise-aggressively #-}
1415module Reflex.Dom.Main where
1516
1617import Prelude hiding (concat, mapM, mapM_, sequence, sequence_)
1718
19+import Reflex.Adjustable.Class
20+import Reflex.Class
1821import Reflex.Dom.Builder.Immediate
1922import Reflex.Dom.Class
2023import Reflex.Host.Class
@@ -22,6 +25,10 @@ import Reflex.PerformEvent.Base
2225import Reflex.PostBuild.Base
2326import Reflex.Spider (Global, Spider, SpiderHost, runSpiderHost)
2427import Reflex.TriggerEvent.Base
28+import Reflex.TriggerEvent.Class
29+#ifdef PROFILE_REFLEX
30+import Reflex.Profiled
31+#endif
2532
2633import Control.Concurrent
2734import Control.Lens
@@ -30,6 +37,7 @@ import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence
3037import Control.Monad.Ref
3138import Data.ByteString (ByteString)
3239import Data.Dependent.Sum (DSum (..))
40+import Data.Foldable (for_)
3341import Data.IORef
3442import Data.Maybe
3543import Data.Monoid ((<>))
@@ -44,12 +52,142 @@ import GHCJS.DOM.NonElementParentNode
4452import GHCJS.DOM.Types (JSM)
4553import qualified GHCJS.DOM.Types as DOM
4654
47−{-# INLINABLE mainWidget #-}
55+#ifdef PROFILE_REFLEX
56+import Reflex.Profiled
57+#endif
58+
59+{-# INLINE mainHydrationWidgetWithHead #-}
60+mainHydrationWidgetWithHead :: (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
61+mainHydrationWidgetWithHead = mainHydrationWidgetWithHead'
62+
63+{-# INLINABLE mainHydrationWidgetWithHead' #-}
64+-- | Warning: `mainHydrationWidgetWithHead'` is provided only as performance tweak. It is expected to disappear in future releases.
65+mainHydrationWidgetWithHead' :: HydrationWidget () () -> HydrationWidget () () -> JSM ()
66+mainHydrationWidgetWithHead' = mainHydrationWidgetWithSwitchoverAction' (pure ())
67+
68+{-# INLINE mainHydrationWidgetWithSwitchoverAction #-}
69+mainHydrationWidgetWithSwitchoverAction :: JSM () -> (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
70+mainHydrationWidgetWithSwitchoverAction = mainHydrationWidgetWithSwitchoverAction'
71+
72+{-# INLINABLE mainHydrationWidgetWithSwitchoverAction' #-}
73+-- | Warning: `mainHydrationWidgetWithSwitchoverAction'` is provided only as performance tweak. It is expected to disappear in future releases.
74+mainHydrationWidgetWithSwitchoverAction' :: JSM () -> HydrationWidget () () -> HydrationWidget () () -> JSM ()
75+mainHydrationWidgetWithSwitchoverAction' = mainHydrationWidgetWithSwitchoverActionWithFailure' (pure ())
76+
77+
78+{-# INLINABLE mainHydrationWidgetWithSwitchoverActionWithFailure' #-}
79+-- | Warning: `mainHydrationWidgetWithSwitchoverActionWithFaiilure'` is provided only as performance tweak. It is expected to disappear in future releases.
80+mainHydrationWidgetWithSwitchoverActionWithFailure' :: IO () -> JSM () -> HydrationWidget () () -> HydrationWidget () () -> JSM ()
81+mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchoverAction head' body = do
82+ runHydrationWidgetWithHeadAndBodyWithFailure onFailure switchoverAction $ \appendHead appendBody -> do
83+ appendHead head'
84+ appendBody body
85+
86+{-# INLINABLE attachHydrationWidget #-}
87+attachHydrationWidget
88+ :: JSM ()
89+ -> JSContextSingleton ()
90+ -> ( Event DomTimeline ()
91+ -> IORef HydrationMode
92+ -> Maybe (IORef [(Node, HydrationRunnerT DomTimeline (DomCoreWidget ()) ())])
93+ -> EventChannel
94+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
95+ )
96+ -> IO (a, FireCommand DomTimeline DomHost)
97+attachHydrationWidget = attachHydrationWidgetWithFailure (pure ())
98+
99+{-# INLINABLE attachHydrationWidgetWithFailure #-}
100+attachHydrationWidgetWithFailure
101+ :: IO ()
102+ -> JSM ()
103+ -> JSContextSingleton ()
104+ -> ( Event DomTimeline ()
105+ -> IORef HydrationMode
106+ -> Maybe (IORef [(Node, HydrationRunnerT DomTimeline (DomCoreWidget ()) ())])
107+ -> EventChannel
108+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
109+ )
110+ -> IO (a, FireCommand DomTimeline DomHost)
111+attachHydrationWidgetWithFailure onFailure switchoverAction jsSing w = do
112+ hydrationMode <- liftIO $ newIORef HydrationMode_Hydrating
113+ rootNodesRef <- liftIO $ newIORef []
114+ events <- newChan
115+ runDomHost $ flip runTriggerEventT events $ mdo
116+ (syncEvent, fireSync) <- newTriggerEvent
117+ ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- lift $ hostPerformEventT $ do
118+ a <- w syncEvent hydrationMode (Just rootNodesRef) events
119+ _ <- runWithReplace (return ()) $ delayedAction <$ syncEvent
120+ pure a
121+ mPostBuildTrigger <- readRef postBuildTriggerRef
122+ lift $ forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
123+ liftIO $ fireSync ()
124+ rootNodes <- liftIO $ readIORef rootNodesRef
125+ let delayedAction = do
126+ for_ (reverse rootNodes) $ \(rootNode, runner) -> do
127+ let hydrate = runHydrationRunnerTWithFailure runner onFailure Nothing rootNode events
128+ void $ runWithJSContextSingleton (runPostBuildT hydrate never) jsSing
129+ liftIO $ writeIORef hydrationMode HydrationMode_Immediate
130+ runWithJSContextSingleton (DOM.liftJSM switchoverAction) jsSing
131+ pure (result, fc)
132+
133+type HydrationWidget x a = HydrationDomBuilderT HydrationDomSpace DomTimeline (DomCoreWidget x) a
134+
135+-- | A widget that isn't attached to any particular part of the DOM hierarchy
136+type FloatingWidget x = TriggerEventT DomTimeline (DomCoreWidget x)
137+
138+type DomCoreWidget x = PostBuildT DomTimeline (WithJSContextSingleton x (PerformEventT DomTimeline DomHost))
139+
140+{-# INLINABLE runHydrationWidgetWithHeadAndBody #-}
141+runHydrationWidgetWithHeadAndBody
142+ :: JSM ()
143+ -> ( (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to head" --TODO: test invoking this more than once
144+ -> (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to body" --TODO: test invoking this more than once
145+ -> FloatingWidget () ()
146+ )
147+ -> JSM ()
148+runHydrationWidgetWithHeadAndBody = runHydrationWidgetWithHeadAndBodyWithFailure (pure ())
149+
150+{-# INLINABLE runHydrationWidgetWithHeadAndBodyWithFailure #-}
151+runHydrationWidgetWithHeadAndBodyWithFailure
152+ :: IO ()
153+ -> JSM ()
154+ -> ( (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to head" --TODO: test invoking this more than once
155+ -> (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to body" --TODO: test invoking this more than once
156+ -> FloatingWidget () ()
157+ )
158+ -> JSM ()
159+runHydrationWidgetWithHeadAndBodyWithFailure onFailure switchoverAction app = withJSContextSingletonMono $ \jsSing -> do
160+ globalDoc <- currentDocumentUnchecked
161+ headElement <- getHeadUnchecked globalDoc
162+ bodyElement <- getBodyUnchecked globalDoc
163+ (events, fc) <- liftIO . attachHydrationWidgetWithFailure onFailure switchoverAction jsSing $ \switchover hydrationMode hydrationResult events -> do
164+ (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
165+ let hydrateDom :: DOM.Node -> HydrationWidget () c -> FloatingWidget () c
166+ hydrateDom n w = do
167+ delayed <- liftIO $ newIORef $ pure ()
168+ unreadyChildren <- liftIO $ newIORef 0
169+ lift $ do
170+ let builderEnv = HydrationDomBuilderEnv
171+ { _hydrationDomBuilderEnv_document = globalDoc
172+ , _hydrationDomBuilderEnv_parent = Left $ toNode n
173+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
174+ , _hydrationDomBuilderEnv_commitAction = pure ()
175+ , _hydrationDomBuilderEnv_hydrationMode = hydrationMode
176+ , _hydrationDomBuilderEnv_switchover = switchover
177+ , _hydrationDomBuilderEnv_delayed = delayed
178+ }
179+ a <- runHydrationDomBuilderT w builderEnv events
180+ forM_ hydrationResult $ \hr -> do
181+ res <- liftIO $ readIORef delayed
182+ liftIO $ modifyIORef' hr ((n, res) :)
183+ pure a
184+ runWithJSContextSingleton (runPostBuildT (runTriggerEventT (app (hydrateDom $ toNode headElement) (hydrateDom $ toNode bodyElement)) events) postBuild) jsSing
185+ return (events, postBuildTriggerRef)
186+ liftIO $ processAsyncEvents events fc
187+
188+{-# INLINE mainWidget #-}
48189mainWidget :: (forall x. Widget x ()) -> JSM ()
49−mainWidget w = withJSContextSingleton $ \jsSing -> do
50− doc <- currentDocumentUnchecked
51− body <- getBodyUnchecked doc
52− attachWidget body jsSing w
190+mainWidget = mainWidget'
53191
54192{-# INLINABLE mainWidget' #-}
55193-- | Warning: `mainWidget'` is provided only as performance tweak. It is expected to disappear in future releases.
@@ -62,7 +200,7 @@ mainWidget' w = withJSContextSingletonMono $ \jsSing -> do
62200--TODO: The x's should be unified here
63201{-# INLINABLE mainWidgetWithHead #-}
64202mainWidgetWithHead :: (forall x. Widget x ()) -> (forall x. Widget x ()) -> JSM ()
65−mainWidgetWithHead h b = withJSContextSingleton $ \jsSing -> do
203+mainWidgetWithHead h b = withJSContextSingletonMono $ \jsSing -> do
66204 doc <- currentDocumentUnchecked
67205 headElement <- getHeadUnchecked doc
68206 attachWidget headElement jsSing h
@@ -74,86 +212,130 @@ mainWidgetWithCss :: ByteString -> (forall x. Widget x ()) -> JSM ()
74212mainWidgetWithCss css w = withJSContextSingleton $ \jsSing -> do
75213 doc <- currentDocumentUnchecked
76214 headElement <- getHeadUnchecked doc
77− setInnerHTML headElement . Just $ "<style>" <> T.unpack (decodeUtf8 css) <> "</style>" --TODO: Fix this
215+ setInnerHTML headElement $ "<style>" <> T.unpack (decodeUtf8 css) <> "</style>" --TODO: Fix this
78216 body <- getBodyUnchecked doc
79217 attachWidget body jsSing w
80218
81−type Widget x = PostBuildT Spider (ImmediateDomBuilderT Spider (WithJSContextSingleton x (PerformEventT Spider (SpiderHost Global)))) --TODO: Make this more abstract --TODO: Put the WithJSContext underneath PerformEventT - I think this would perform better
219+-- | The Reflex timeline for interacting with the DOM
220+type DomTimeline =
221+#ifdef PROFILE_REFLEX
222+ ProfiledTimeline
223+#endif
224+ Spider
225+
226+-- | The ReflexHost the DOM lives in
227+type DomHost =
228+#ifdef PROFILE_REFLEX
229+ ProfiledM
230+#endif
231+ (SpiderHost Global)
232+
233+runDomHost :: DomHost a -> IO a
234+runDomHost = runSpiderHost
235+#ifdef PROFILE_REFLEX
236+ . runProfiledM
237+#endif
238+
239+type Widget x = ImmediateDomBuilderT DomTimeline (DomCoreWidget x)
82240
83241{-# INLINABLE attachWidget #-}
84242attachWidget :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> JSM a
85243attachWidget rootElement wv w = fst <$> attachWidget' rootElement wv w
86244
87−-- | Warning: `mainWidgetWithHead'` is provided only as performance tweak. It is expected to disappear in future releases.
88−mainWidgetWithHead' :: (a -> Widget () b, b -> Widget () a) -> JSM ()
89−mainWidgetWithHead' widgets = withJSContextSingletonMono $ \jsSing -> do
90− doc <- currentDocumentUnchecked
91− headElement <- getHeadUnchecked doc
92− headFragment <- createDocumentFragment doc
93− bodyElement <- getBodyUnchecked doc
94− bodyFragment <- createDocumentFragment doc
95− (events, fc) <- liftIO . attachWidget'' $ \events -> do
96− let (headWidget, bodyWidget) = widgets
245+{-# INLINABLE runImmediateWidgetWithHeadAndBody #-}
246+runImmediateWidgetWithHeadAndBody
247+ :: ( (forall c. Widget () c -> FloatingWidget () c) -- "Append to head"
248+ -> (forall c. Widget () c -> FloatingWidget () c) -- "Append to body"
249+ -> FloatingWidget () ()
250+ )
251+ -> JSM ()
252+runImmediateWidgetWithHeadAndBody app = withJSContextSingletonMono $ \jsSing -> do
253+ globalDoc <- currentDocumentUnchecked
254+ headElement <- getHeadUnchecked globalDoc
255+ bodyElement <- getBodyUnchecked globalDoc
256+ headFragment <- createDocumentFragment globalDoc
257+ bodyFragment <- createDocumentFragment globalDoc
258+ (events, fc) <- liftIO . attachImmediateWidget $ \hydrationMode events -> do
97259 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
98− let go :: forall c. Widget () c -> DOM.DocumentFragment -> PerformEventT Spider (SpiderHost Global) c
99− go w df = do
260+ let go :: forall c. DOM.DocumentFragment -> Widget () c -> FloatingWidget () c
261+ go df w = do
100262 unreadyChildren <- liftIO $ newIORef 0
101− let builderEnv = ImmediateDomBuilderEnv
102− { _immediateDomBuilderEnv_document = toDocument doc
103− , _immediateDomBuilderEnv_parent = toNode df
104− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
105− , _immediateDomBuilderEnv_commitAction = return () --TODO
263+ delayed <- liftIO $ newIORef $ pure ()
264+ let builderEnv = HydrationDomBuilderEnv
265+ { _hydrationDomBuilderEnv_document = globalDoc
266+ , _hydrationDomBuilderEnv_parent = Left $ toNode df
267+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
268+ , _hydrationDomBuilderEnv_commitAction = pure () --TODO: possibly `replaceElementContents n f`
269+ , _hydrationDomBuilderEnv_hydrationMode = hydrationMode
270+ , _hydrationDomBuilderEnv_switchover = never
271+ , _hydrationDomBuilderEnv_delayed = delayed
106272 }
107− runWithJSContextSingleton (runImmediateDomBuilderT (runPostBuildT w postBuild) builderEnv events) jsSing
108− rec b <- go (headWidget a) headFragment
109− a <- go (bodyWidget b) bodyFragment
273+ lift $ runHydrationDomBuilderT w builderEnv events
274+ runWithJSContextSingleton (runPostBuildT (runTriggerEventT (app (go headFragment) (go bodyFragment)) events) postBuild) jsSing
110275 return (events, postBuildTriggerRef)
111276 replaceElementContents headElement headFragment
112277 replaceElementContents bodyElement bodyFragment
113278 liftIO $ processAsyncEvents events fc
114279
280+-- | Warning: `mainWidgetWithHead'` is provided only as performance tweak. It is expected to disappear in future releases.
281+mainWidgetWithHead' :: (a -> Widget () b, b -> Widget () a) -> JSM ()
282+mainWidgetWithHead' (h, b) = runImmediateWidgetWithHeadAndBody $ \appendHead appendBody -> do
283+ rec hOut <- appendHead $ h bOut
284+ bOut <- appendBody $ b hOut
285+ pure ()
286+
115287replaceElementContents :: DOM.IsElement e => e -> DOM.DocumentFragment -> JSM ()
116288replaceElementContents e df = do
117− setInnerHTML e $ Just ("" :: String)
289+ setInnerHTML e ("" :: String)
118290 _ <- appendChild e df
119291 return ()
120292
121293{-# INLINABLE attachWidget' #-}
122−attachWidget' :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> JSM (a, FireCommand Spider (SpiderHost Global))
294+attachWidget' :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> JSM (a, FireCommand DomTimeline DomHost)
123295attachWidget' rootElement jsSing w = do
124296 doc <- getOwnerDocumentUnchecked rootElement
125297 df <- createDocumentFragment doc
126− ((a, events), fc) <- liftIO . attachWidget'' $ \events -> do
298+ ((a, events), fc) <- liftIO . attachImmediateWidget $ \hydrationMode events -> do
127299 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
128300 unreadyChildren <- liftIO $ newIORef 0
129− let builderEnv = ImmediateDomBuilderEnv
130− { _immediateDomBuilderEnv_document = toDocument doc
131− , _immediateDomBuilderEnv_parent = toNode df
132− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
133− , _immediateDomBuilderEnv_commitAction = return () --TODO
301+ delayed <- liftIO $ newIORef $ pure ()
302+ let builderEnv = HydrationDomBuilderEnv
303+ { _hydrationDomBuilderEnv_document = toDocument doc
304+ , _hydrationDomBuilderEnv_parent = Left $ toNode df
305+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
306+ , _hydrationDomBuilderEnv_commitAction = return () --TODO
307+ , _hydrationDomBuilderEnv_switchover = never
308+ , _hydrationDomBuilderEnv_delayed = delayed
309+ , _hydrationDomBuilderEnv_hydrationMode = hydrationMode
134310 }
135− a <- runWithJSContextSingleton (runImmediateDomBuilderT (runPostBuildT w postBuild) builderEnv events) jsSing
311+ a <- runWithJSContextSingleton (runPostBuildT (runHydrationDomBuilderT w builderEnv events) postBuild) jsSing
136312 return ((a, events), postBuildTriggerRef)
137313 replaceElementContents rootElement df
138314 liftIO $ processAsyncEvents events fc
139315 return (a, fc)
140316
141−type EventChannel = Chan [DSum (EventTriggerRef Spider) TriggerInvocation]
317+type EventChannel = Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
142318
143−{-# INLINABLE attachWidget'' #-}
144−attachWidget'' :: (EventChannel -> PerformEventT Spider (SpiderHost Global) (a, IORef (Maybe (EventTrigger Spider ())))) -> IO (a, FireCommand Spider (SpiderHost Global))
145−attachWidget'' w = do
319+{-# INLINABLE attachImmediateWidget #-}
320+attachImmediateWidget
321+ :: ( IORef HydrationMode
322+ -> EventChannel
323+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
324+ )
325+ -> IO (a, FireCommand DomTimeline DomHost)
326+attachImmediateWidget w = do
327+ hydrationMode <- liftIO $ newIORef HydrationMode_Immediate
146328 events <- newChan
147− runSpiderHost $ do
148− ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- hostPerformEventT $ w events
329+ runDomHost $ do
330+ ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- hostPerformEventT $ w hydrationMode events
149331 mPostBuildTrigger <- readRef postBuildTriggerRef
150332 forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
151333 return (result, fc)
152334
153−processAsyncEvents :: EventChannel -> FireCommand Spider (SpiderHost Global) -> IO ()
335+processAsyncEvents :: EventChannel -> FireCommand DomTimeline DomHost -> IO ()
154336processAsyncEvents events (FireCommand fire) = void $ forkIO $ forever $ do
155337 ers <- readChan events
156− _ <- runSpiderHost $ do
338+ _ <- runDomHost $ do
157339 mes <- liftIO $ forM ers $ \(EventTriggerRef er :=> TriggerInvocation a _) -> do
158340 me <- readIORef er
159341 return $ fmap (\e -> e :=> Identity a) me
@@ -161,7 +343,6 @@ processAsyncEvents events (FireCommand fire) = void $ forkIO $ forever $ do
161343 liftIO $ forM_ ers $ \(_ :=> TriggerInvocation _ cb) -> cb
162344 return ()
163345
164−
165346-- | Run a reflex-dom application inside of an existing DOM element with the given ID
166347mainWidgetInElementById :: Text -> (forall x. Widget x ()) -> JSM ()
167348mainWidgetInElementById eid w = withJSContextSingleton $ \jsSing -> do
@@ -177,14 +358,19 @@ newtype AppOutput t = AppOutput --TODO: Add quit event
177358 { _appOutput_windowConfig :: WindowConfig t
178359 }
179360
180−runApp' :: (t ~ Spider) => (forall x. AppInput t -> Widget x (AppOutput t)) -> JSM ()
361+runApp' :: (t ~ DomTimeline) => (forall x. AppInput t -> Widget x (AppOutput t)) -> JSM ()
181362runApp' app = withJSContextSingleton $ \jsSing -> do
182363 doc <- currentDocumentUnchecked
183364 body <- getBodyUnchecked doc
184365 win <- getDefaultViewUnchecked doc
185366 rec o <- attachWidget body jsSing $ do
186− w <- lift $ wrapWindow win $ _appOutput_windowConfig o
367+ w <- wrapWindow win $ _appOutput_windowConfig o
187368 app $ AppInput
188369 { _appInput_window = w
189370 }
190371 return ()
372+
373+{-# DEPRECATED attachWidget'' "Use 'attachImmediateWidget . const' instead" #-}
374+{-# INLINABLE attachWidget'' #-}
375+attachWidget'' :: (EventChannel -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))) -> IO (a, FireCommand DomTimeline DomHost)
376+attachWidget'' = attachImmediateWidget . const
reflex-dom-core/src/Reflex/Dom/Modals/Class.hsnew file+7
@@ -0,0 +1,7 @@
1+{-# LANGUAGE MultiParamTypeClasses #-}
2+module Reflex.Dom.Modals.Class where
3+
4+import Reflex
5+
6+class ModalOpener t m where
7+ requestingModal :: Event t (m (Event t a)) -> m (Event t (Maybe a))
reflex-dom-core/src/Reflex/Dom/Old.hs+1−3
@@ -1,6 +1,5 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE ExplicitForAll #-}
43{-# LANGUAGE FlexibleContexts #-}
54{-# LANGUAGE FlexibleInstances #-}
65{-# LANGUAGE MultiParamTypeClasses #-}
@@ -103,7 +102,6 @@ elConfig_attributes f (ElConfig a b) = (\b' -> ElConfig a b') <$> f b
103102{-# INLINE elConfig_attributes #-}
104103#endif
105104
106−--TODO: HasDocument is still not accounted for
107105type MonadWidgetConstraints t m =
108106 ( DomBuilder t m
109107 , DomBuilderSpace m ~ GhcjsDomSpace
@@ -274,7 +272,7 @@ elDynHtmlAttr' elementTag attrs html = do
274272 let cfg = def & initialAttributes .~ Map.mapKeys (AttributeName Nothing) attrs
275273 (e, _) <- element elementTag cfg $ return ()
276274 postBuild <- getPostBuild
277− performEvent_ $ liftJSM . Element.setInnerHTML (_element_raw e) . Just <$> leftmost [updated html, tag (current html) postBuild]
275+ performEvent_ $ liftJSM . Element.setInnerHTML (_element_raw e) <$> leftmost [updated html, tag (current html) postBuild]
278276 return e
279277
280278elDynHtml' :: MonadWidget t m => Text -> Dynamic t Text -> m (Element EventResult GhcjsDomSpace t)
reflex-dom-core/src/Reflex/Dom/Prerender.hsnew file+326
@@ -0,0 +1,326 @@
1+{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE EmptyCase #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE FunctionalDependencies #-}
7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE LambdaCase #-}
9+{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE Rank2Types #-}
11+{-# LANGUAGE RecursiveDo #-}
12+{-# LANGUAGE ScopedTypeVariables #-}
13+{-# LANGUAGE TypeFamilies #-}
14+{-# LANGUAGE UndecidableInstances #-}
15+{-# LANGUAGE UndecidableSuperClasses #-}
16+
17+-- | Render the first widget on the server, and the second on the client.
18+module Reflex.Dom.Prerender
19+ ( Prerender (..)
20+ , prerender_
21+ , PrerenderClientConstraint
22+ , PrerenderBaseConstraints
23+ ) where
24+
25+import Control.Monad.Primitive (PrimMonad(..))
26+import Control.Monad.Reader
27+import Control.Monad.Ref (MonadRef(..), MonadAtomicRef(..))
28+import Data.IORef (IORef, newIORef)
29+import Data.Semigroup (Semigroup)
30+import Data.Text (Text)
31+import Data.Void
32+import Foreign.JavaScript.TH
33+import GHCJS.DOM.Types (MonadJSM)
34+import Reflex hiding (askEvents)
35+import Reflex.Dom.Builder.Class
36+import Reflex.Dom.Builder.Hydratable
37+import Reflex.Dom.Builder.Immediate
38+import Reflex.Dom.Builder.InputDisabled
39+import Reflex.Dom.Builder.Static
40+import Reflex.Host.Class
41+import Data.IntMap.Strict (IntMap)
42+import qualified Data.IntMap.Strict as IntMap
43+
44+import qualified GHCJS.DOM.Document as Document
45+import qualified GHCJS.DOM.Node as Node
46+import qualified GHCJS.DOM.Types as DOM
47+
48+type PrerenderClientConstraint js t m =
49+ ( DomBuilder t m
50+ , DomBuilderSpace m ~ GhcjsDomSpace
51+ , DomRenderHook t m
52+ , HasDocument m
53+ , TriggerEvent t m
54+ , PrerenderBaseConstraints js t m
55+ )
56+
57+type PrerenderBaseConstraints js t m =
58+ ( HasJSContext (Performable m)
59+ , HasJSContext m
60+ , MonadFix m
61+ , MonadHold t m
62+ , MonadJSM (Performable m)
63+ , MonadJSM m
64+ , MonadRef (Performable m)
65+ , MonadRef m
66+ , MonadReflexCreateTrigger t m
67+ , MonadSample t (Performable m)
68+ , PerformEvent t m
69+ , PostBuild t m
70+ , PrimMonad m
71+ , Ref (Performable m) ~ IORef
72+ , Ref m ~ IORef
73+ , HasJS js m
74+ , HasJS js (Performable m)
75+ )
76+
77+-- | Render the first widget on the server, and the second on the client. The
78+-- hydration builder will run *both* widgets.
79+prerender_
80+ :: (Functor m, Reflex t, Prerender js t m)
81+ => m () -> Client m () -> m ()
82+prerender_ server client = void $ prerender server client
83+
84+class (PrerenderClientConstraint js t (Client m), Client (Client m) ~ Client m, Prerender js t (Client m)) => Prerender js t m | m -> t js where
85+ -- | Monad in which the client widget is built
86+ type Client m :: * -> *
87+ -- | Render the first widget on the server, and the second on the client. The
88+ -- hydration builder will run *both* widgets, updating the result dynamic at
89+ -- switchover time.
90+ prerender :: m a -> Client m a -> m (Dynamic t a)
91+
92+instance (ReflexHost t, Adjustable t m, PrerenderBaseConstraints js t m) => Prerender js t (HydrationDomBuilderT GhcjsDomSpace t m) where
93+ type Client (HydrationDomBuilderT GhcjsDomSpace t m) = HydrationDomBuilderT GhcjsDomSpace t m
94+ prerender _ client = pure <$> client
95+
96+instance (Adjustable t m, PrerenderBaseConstraints js t m, ReflexHost t) => Prerender js t (HydrationDomBuilderT HydrationDomSpace t m) where
97+ -- | PostBuildT is needed here because we delay running the client builder
98+ -- until after switchover, at which point the postBuild of @m@ has already fired
99+ type Client (HydrationDomBuilderT HydrationDomSpace t m) = PostBuildT t (HydrationDomBuilderT GhcjsDomSpace t m)
100+ -- | Runs the server widget up until switchover, then replaces it with the
101+ -- client widget.
102+ prerender server client = do
103+ env <- HydrationDomBuilderT ask
104+ events <- askEvents
105+ doc <- askDocument
106+ serverDf <- Document.createDocumentFragment doc -- server dom should not be mounted in the window's doc in hydration
107+ df <- Document.createDocumentFragment doc
108+ unreadyChildren <- HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_unreadyChildren
109+ immediateMode <- liftIO $ newIORef HydrationMode_Immediate
110+ delayed <- liftIO $ newIORef $ pure ()
111+ let clientEnv = env
112+ { _hydrationDomBuilderEnv_parent = Left $ DOM.toNode df
113+ , _hydrationDomBuilderEnv_hydrationMode = immediateMode
114+ }
115+ serverEnv = HydrationDomBuilderEnv
116+ { _hydrationDomBuilderEnv_document = doc
117+ , _hydrationDomBuilderEnv_parent = Left $ DOM.toNode serverDf
118+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
119+ , _hydrationDomBuilderEnv_commitAction = pure ()
120+ , _hydrationDomBuilderEnv_delayed = delayed
121+ , _hydrationDomBuilderEnv_hydrationMode = immediateMode
122+ , _hydrationDomBuilderEnv_switchover = never
123+ }
124+ a0 <- lift $ runHydrationDomBuilderT server serverEnv events
125+ (a', trigger) <- newTriggerEvent
126+ getHydrationMode >>= \case
127+ HydrationMode_Immediate -> do
128+ liftIO . trigger <=< lift $ runHydrationDomBuilderT (runPostBuildT client $ void a') clientEnv events
129+ append $ DOM.toNode df
130+ HydrationMode_Hydrating -> addHydrationStep $ do
131+ liftIO . trigger <=< lift $ runHydrationDomBuilderT (runPostBuildT client $ void a') clientEnv events
132+ insertBefore df =<< deleteToPrerenderEnd doc
133+ holdDyn a0 a'
134+
135+newtype UnrunnableT js t m a = UnrunnableT (ReaderT Void m a)
136+ deriving (Functor, Applicative, Monad, MonadTrans)
137+
138+unrunnable :: UnrunnableT js t m a
139+unrunnable = UnrunnableT $ ReaderT $ \case {}
140+
141+instance (Reflex t, Monad m) => DomBuilder t (UnrunnableT js t m) where
142+ type DomBuilderSpace (UnrunnableT js t m) = GhcjsDomSpace
143+ textNode _ = unrunnable
144+ commentNode _ = unrunnable
145+ element _ _ _ = unrunnable
146+ inputElement _ = unrunnable
147+ textAreaElement _ = unrunnable
148+ selectElement _ _ = unrunnable
149+ placeRawElement _ = unrunnable
150+ wrapRawElement _ _ = unrunnable
151+instance (Reflex t, Monad m) => NotReady t (UnrunnableT js t m) where
152+ notReadyUntil _ = unrunnable
153+ notReady = unrunnable
154+instance (Reflex t, Monad m) => Adjustable t (UnrunnableT js t m) where
155+ runWithReplace _ _ = unrunnable
156+ traverseIntMapWithKeyWithAdjust _ _ _ = unrunnable
157+ traverseDMapWithKeyWithAdjust _ _ _ = unrunnable
158+ traverseDMapWithKeyWithAdjustWithMove _ _ _ = unrunnable
159+instance (Reflex t, Monad m) => PerformEvent t (UnrunnableT js t m) where
160+ type Performable (UnrunnableT js t m) = UnrunnableT js t m
161+ performEvent _ = unrunnable
162+ performEvent_ _ = unrunnable
163+instance Monad m => MonadRef (UnrunnableT js t m) where
164+ type Ref (UnrunnableT js t m) = Ref IO
165+ newRef _ = unrunnable
166+ readRef _ = unrunnable
167+ writeRef _ _ = unrunnable
168+instance Monad m => MonadAtomicRef (UnrunnableT js t m) where
169+ atomicModifyRef _ _ = unrunnable
170+instance Monad m => HasDocument (UnrunnableT js t m) where
171+ askDocument = unrunnable
172+instance Monad m => HasJSContext (UnrunnableT js t m) where
173+ type JSContextPhantom (UnrunnableT js t m) = ()
174+ askJSContext = unrunnable
175+instance Monad m => HasJS JS' (UnrunnableT js t m) where
176+ type JSX (UnrunnableT js t m) = UnrunnableT js t m
177+ liftJS _ = unrunnable
178+instance Monad m => MonadJS JS' (UnrunnableT js t m) where
179+ runJS _ _ = unrunnable
180+ forkJS _ = unrunnable
181+ mkJSUndefined = unrunnable
182+ isJSNull _ = unrunnable
183+ isJSUndefined _ = unrunnable
184+ fromJSBool _ = unrunnable
185+ fromJSString _ = unrunnable
186+ fromJSArray _ = unrunnable
187+ fromJSUint8Array _ = unrunnable
188+ fromJSNumber _ = unrunnable
189+ withJSBool _ _ = unrunnable
190+ withJSString _ _ = unrunnable
191+ withJSNumber _ _ = unrunnable
192+ withJSArray _ _ = unrunnable
193+ withJSUint8Array _ _ = unrunnable
194+ mkJSFun _ = unrunnable
195+ freeJSFun _ = unrunnable
196+ setJSProp _ _ _ = unrunnable
197+ getJSProp _ _ = unrunnable
198+ withJSNode _ _ = unrunnable
199+instance Monad m => TriggerEvent t (UnrunnableT js t m) where
200+ newTriggerEvent = unrunnable
201+ newTriggerEventWithOnComplete = unrunnable
202+ newEventWithLazyTriggerWithOnComplete _ = unrunnable
203+instance Monad m => MonadReflexCreateTrigger t (UnrunnableT js t m) where
204+ newEventWithTrigger _ = unrunnable
205+ newFanEventWithTrigger _ = unrunnable
206+instance Monad m => MonadFix (UnrunnableT js t m) where
207+ mfix _ = unrunnable
208+instance (Monad m, MonadHold t m) => MonadHold t (UnrunnableT js t m) where
209+ hold _ _ = unrunnable
210+ holdDyn _ _ = unrunnable
211+ holdIncremental _ _ = unrunnable
212+ buildDynamic _ _ = unrunnable
213+ headE _ = unrunnable
214+ now = unrunnable
215+instance Monad m => MonadSample t (UnrunnableT js t m) where
216+ sample _ = unrunnable
217+instance Monad m => MonadIO (UnrunnableT js t m) where
218+ liftIO _ = unrunnable
219+#ifndef ghcjs_HOST_OS
220+instance Monad m => MonadJSM (UnrunnableT js t m) where
221+ liftJSM' _ = unrunnable
222+#endif
223+instance (Reflex t, Monad m) => PostBuild t (UnrunnableT js t m) where
224+ getPostBuild = unrunnable
225+instance Monad m => PrimMonad (UnrunnableT js t m) where
226+ type PrimState (UnrunnableT js t m) = PrimState IO
227+ primitive _ = unrunnable
228+instance (Reflex t, Monad m) => DomRenderHook t (UnrunnableT js t m) where
229+ withRenderHook _ _ = unrunnable
230+ requestDomAction _ = unrunnable
231+ requestDomAction_ _ = unrunnable
232+instance (Reflex t, Monad m, MonadHold t m) => Prerender JS' t (UnrunnableT js t m) where
233+ type Client (UnrunnableT js t m) = UnrunnableT js t m
234+ prerender _ _ = unrunnable
235+
236+instance (SupportsStaticDomBuilder t m) => Prerender JS' t (StaticDomBuilderT t m) where
237+ type Client (StaticDomBuilderT t m) = UnrunnableT JS' t m
238+ prerender server _ = do
239+ _ <- commentNode $ CommentNodeConfig startMarker Nothing
240+ a <- server
241+ _ <- commentNode $ CommentNodeConfig endMarker Nothing
242+ pure $ pure a
243+
244+instance (Prerender js t m, Monad m) => Prerender js t (ReaderT r m) where
245+ type Client (ReaderT r m) = ReaderT r (Client m)
246+ prerender server client = do
247+ r <- ask
248+ lift $ prerender (runReaderT server r) (runReaderT client r)
249+
250+instance (Prerender js t m, Monad m, Reflex t, MonadFix m, Monoid w) => Prerender js t (DynamicWriterT t w m) where
251+ type Client (DynamicWriterT t w m) = DynamicWriterT t w (Client m)
252+ prerender server client = do
253+ x <- lift $ prerender (runDynamicWriterT server) (runDynamicWriterT client)
254+ let (a, w') = splitDynPure x
255+ w = join w'
256+ tellDyn w
257+ pure a
258+
259+instance (Prerender js t m, Monad m, Reflex t, Semigroup w) => Prerender js t (EventWriterT t w m) where
260+ type Client (EventWriterT t w m) = EventWriterT t w (Client m)
261+ prerender server client = do
262+ x <- lift $ prerender (runEventWriterT server) (runEventWriterT client)
263+ let (a, w') = splitDynPure x
264+ w = switch $ current w'
265+ tellEvent w
266+ pure a
267+
268+instance (Prerender js t m, MonadFix m, Reflex t) => Prerender js t (RequesterT t request response m) where
269+ type Client (RequesterT t request response m) = RequesterT t request response (Client m)
270+ prerender server client = mdo
271+ let fannedResponses = fanInt responses
272+ withFannedResponses :: forall m' a. Monad m' => RequesterT t request response m' a -> Int -> m' (a, Event t (IntMap (RequesterData request)))
273+ withFannedResponses w selector = do
274+ (x, e) <- runRequesterT w (selectInt fannedResponses selector)
275+ pure (x, fmapCheap (IntMap.singleton selector) e)
276+ (result, requestsDyn) <- fmap splitDynPure $ lift $ prerender (withFannedResponses server 0) (withFannedResponses client 1)
277+ responses <- fmap (fmapCheap unMultiEntry) $ requesting' $ fmapCheap multiEntry $ switchPromptlyDyn requestsDyn
278+ return result
279+
280+instance (Prerender js t m, Monad m, Reflex t, MonadFix m, Group q, Additive q, Query q, Eq q) => Prerender js t (QueryT t q m) where
281+ type Client (QueryT t q m) = QueryT t q (Client m)
282+ prerender server client = mdo
283+ result <- queryDyn query
284+ x <- lift $ prerender (runQueryT server result) (runQueryT client result)
285+ let (a, inc) = splitDynPure x
286+ query = incrementalToDynamic =<< inc -- Can we avoid the incrementalToDynamic?
287+ pure a
288+
289+instance (Prerender js t m, Monad m) => Prerender js t (InputDisabledT m) where
290+ type Client (InputDisabledT m) = InputDisabledT (Client m)
291+ prerender (InputDisabledT server) (InputDisabledT client) = InputDisabledT $ prerender server client
292+
293+instance (Prerender js t m, Monad m) => Prerender js t (HydratableT m) where
294+ type Client (HydratableT m) = HydratableT (Client m)
295+ prerender (HydratableT server) (HydratableT client) = HydratableT $ prerender server client
296+
297+instance (Prerender js t m, Monad m, ReflexHost t) => Prerender js t (PostBuildT t m) where
298+ type Client (PostBuildT t m) = PostBuildT t (Client m)
299+ prerender server client = PostBuildT $ do
300+ pb <- ask
301+ lift $ prerender (runPostBuildT server pb) (runPostBuildT client pb)
302+
303+startMarker, endMarker :: Text
304+startMarker = "prerender/start"
305+endMarker = "prerender/end"
306+
307+deleteToPrerenderEnd :: (MonadIO m, MonadJSM m, Reflex t, MonadFix m) => DOM.Document -> HydrationRunnerT t m DOM.Comment
308+deleteToPrerenderEnd doc = do
309+ startNode <- hydrateComment doc startMarker Nothing
310+ let go (n :: Int) lastNode = Node.getNextSibling lastNode >>= \case
311+ Nothing -> do
312+ c <- Document.createComment doc endMarker
313+ insertAfterPreviousNode c
314+ pure c
315+ Just node -> DOM.castTo DOM.Comment node >>= \case
316+ Nothing -> go n node
317+ Just c -> Node.getTextContentUnchecked c >>= \case
318+ t | t == startMarker -> go (succ n) node
319+ | t == endMarker -> case n of
320+ 0 -> pure c
321+ _ -> go (pred n) node
322+ | otherwise -> go n node
323+ endNode <- go 0 $ DOM.toNode startNode
324+ deleteBetweenExclusive startNode endNode
325+ setPreviousNode $ Just $ DOM.toNode endNode
326+ pure endNode
reflex-dom-core/src/Reflex/Dom/Time.hs+2−217
@@ -1,218 +1,3 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE MultiParamTypeClasses #-}
4−{-# LANGUAGE RecursiveDo #-}
5−{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE TypeFamilies #-}
7−module Reflex.Dom.Time where
1+module Reflex.Dom.Time {-# DEPRECATED "Use Reflex.Time instead" #-} (module Reflex.Time) where
82
9−import Reflex.Class
10−import Reflex.Dynamic
11−import Reflex.PerformEvent.Class
12−import Reflex.PostBuild.Class
13−import Reflex.TriggerEvent.Class
14−
15−import Control.Concurrent
16−import qualified Control.Concurrent.Thread.Delay as Concurrent
17−import Control.Monad
18−import Control.Monad.Fix
19−import Control.Monad.IO.Class
20−import Data.Align
21−import Data.Fixed
22−import Data.Sequence (Seq, (|>))
23−import qualified Data.Sequence as Seq
24−import Data.These
25−import Data.Time.Clock
26−import Data.Typeable
27−import System.Random
28−
29−data TickInfo
30− = TickInfo { _tickInfo_lastUTC :: UTCTime
31− -- ^ UTC time immediately after the last tick.
32− , _tickInfo_n :: Integer
33− -- ^ Number of time periods since t0
34− , _tickInfo_alreadyElapsed :: NominalDiffTime
35− -- ^ Amount of time already elapsed in the current tick period.
36− }
37− deriving (Eq, Ord, Show, Typeable)
38−
39−-- | Special case of tickLossyFrom that uses the post-build event to start the
40−-- tick thread.
41−tickLossy :: (PostBuild t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m) => NominalDiffTime -> UTCTime -> m (Event t TickInfo)
42−tickLossy dt t0 = tickLossyFrom dt t0 =<< getPostBuild
43−
44−-- | Send events over time with the given basis time and interval
45−-- If the system starts running behind, occurrences will be dropped rather than buffered
46−-- Each occurrence of the resulting event will contain the index of the current interval, with 0 representing the basis time
47−tickLossyFrom
48− :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
49− => NominalDiffTime
50− -> UTCTime
51− -> Event t a
52− -- ^ Event that starts a tick generation thread. Usually you want this to
53− -- be something like the result of getPostBuild that only fires once. But
54− -- there could be uses for starting multiple timer threads.
55− -> m (Event t TickInfo)
56−tickLossyFrom dt t0 e = tickLossyFrom' $ (dt, t0) <$ e
57−
58−-- | Generalization of tickLossyFrom that takes dt and t0 in the event.
59−tickLossyFrom'
60− :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), MonadFix m)
61− => Event t (NominalDiffTime, UTCTime)
62− -- ^ Event that starts a tick generation thread. Usually you want this to
63− -- be something like the result of getPostBuild that only fires once. But
64− -- there could be uses for starting multiple timer threads.
65− -> m (Event t TickInfo)
66−tickLossyFrom' e = do
67− rec result <- performEventAsync $ callAtNextInterval <$> leftmost [e, snd <$> result]
68− return $ fst <$> result
69− where callAtNextInterval pair cb = void $ liftIO $ forkIO $ do
70− tick <- uncurry getCurrentTick pair
71− Concurrent.delay $ ceiling $ (fst pair - _tickInfo_alreadyElapsed tick) * 1000000
72− cb (tick, pair)
73−
74−clockLossy :: (MonadIO m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m), PostBuild t m, MonadHold t m, MonadFix m) => NominalDiffTime -> UTCTime -> m (Dynamic t TickInfo)
75−clockLossy dt t0 = do
76− initial <- liftIO $ getCurrentTick dt t0
77− e <- tickLossy dt t0
78− holdDyn initial e
79−
80−getCurrentTick :: NominalDiffTime -> UTCTime -> IO TickInfo
81−getCurrentTick dt t0 = do
82− t <- getCurrentTime
83− let offset = t `diffUTCTime` t0
84− (n, alreadyElapsed) = offset `divMod'` dt
85− return $ TickInfo t n alreadyElapsed
86−
87−-- | Delay an Event's occurrences by a given amount in seconds.
88−delay :: (PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
89−delay dt e = performEventAsync $ ffor e $ \a cb -> liftIO $ void $ forkIO $ do
90− Concurrent.delay $ ceiling $ dt * 1000000
91− cb a
92−
93−-- | Send events with Poisson timing with the given basis and rate
94−-- Each occurence of the resulting event will contain the index of
95−-- the current interval, with 0 representing the basis time
96−poissonLossyFrom
97− :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
98− => g
99− -> Double
100− -- ^ Poisson event rate (Hz)
101− -> UTCTime
102− -- ^ Baseline time for events
103− -> Event t a
104− -- ^ Event that starts a tick generation thread. Usually you want this to
105− -- be something like the result of getPostBuild that only fires once. But
106− -- there could be uses for starting multiple timer threads.
107− -- Start sending events in response to the event parameter.
108− -> m (Event t TickInfo)
109−poissonLossyFrom rnd rate = inhomogeneousPoissonFrom rnd (constant rate) rate
110−
111−
112−-- | Send events with Poisson timing with the given basis and rate
113−-- Each occurence of the resulting event will contain the index of
114−-- the current interval, with 0 representing the basis time.
115−-- Automatically begin sending events when the DOM is built
116−poissonLossy
117− :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, PostBuild t m)
118− => g
119− -> Double
120− -- ^ Poisson event rate (Hz)
121− -> UTCTime
122− -- ^ Baseline time for events
123− -> m (Event t TickInfo)
124−poissonLossy rnd rate t0 = poissonLossyFrom rnd rate t0 =<< getPostBuild
125−
126−-- | Send events with inhomogeneous Poisson timing with the given basis
127−-- and variable rate. Provide a maxRate that you expect to support.
128−inhomogeneousPoissonFrom
129− :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m)
130− => g
131− -> Behavior t Double
132− -> Double
133− -> UTCTime
134− -> Event t a
135− -> m (Event t TickInfo)
136−inhomogeneousPoissonFrom rnd rate maxRate t0 e = do
137−
138− -- Create a thread for producing homogeneous poisson events
139− -- along with random Doubles (usage of Double's explained below)
140− ticksWithRateRand <- performEventAsync $
141− fmap callAtNextInterval e
142−
143− -- Filter homogeneous events according to associated
144− -- random values and the current rate parameter
145− return $ attachWithMaybe filterFun rate ticksWithRateRand
146−
147− where
148−
149− -- Inhomogeneous poisson processes are built from faster
150− -- homogeneous ones by randomly dropping events from the
151− -- fast process. For each fast homogeneous event, choose
152− -- a uniform random sample from (0, rMax). If the
153− -- inhomogeneous rate at this moment is greater than the
154− -- random sample, then keep this event, otherwise drop it
155− filterFun :: Double -> (TickInfo, Double) -> Maybe TickInfo
156− filterFun r (tInfo, p)
157− | r >= p = Just tInfo
158− | otherwise = Nothing
159−
160− callAtNextInterval _ cb = void $ liftIO $ forkIO $ go t0 rnd cb 0
161−
162− go tTargetLast lastGen cb lastN = do
163− t <- getCurrentTime
164−
165− -- Generate random numbers for this poisson interval (u)
166− -- and sample-retention likelihood (p)
167− let (u, nextGen) = randomR (0,1) lastGen
168− (p :: Double, nextGen') = randomR (0,maxRate) nextGen
169−
170− -- Inter-event interval is drawn from exponential
171− -- distribution accourding to u
172− let dt = realToFrac $ (-1) * log u / maxRate :: NominalDiffTime
173− nEvents = lastN + 1
174− alreadyElapsed = diffUTCTime t tTargetLast
175− tTarget = addUTCTime dt tTargetLast
176− thisDelay = realToFrac $ diffUTCTime tTarget t :: Double
177− Concurrent.delay $ ceiling $ thisDelay * 1000000
178− _ <- cb (TickInfo t nEvents alreadyElapsed, p)
179− go tTarget nextGen' cb nEvents
180−
181−-- | Send events with inhomogeneous Poisson timing with the given basis
182−-- and variable rate. Provide a maxRate that you expect to support
183−inhomogeneousPoisson
184− :: (RandomGen g, MonadIO (Performable m), PerformEvent t m, TriggerEvent t m, PostBuild t m)
185− => g
186− -> Behavior t Double
187− -> Double
188− -> UTCTime
189− -> m (Event t TickInfo)
190−inhomogeneousPoisson rnd rate maxRate t0 =
191− inhomogeneousPoissonFrom rnd rate maxRate t0 =<< getPostBuild
192−
193−-- | Block occurrences of an Event until the given number of seconds elapses without
194−-- the Event firing, at which point the last occurrence of the Event will fire.
195−debounce :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t a)
196−debounce dt e = do
197− n :: Dynamic t Integer <- count e
198− let tagged = attachPromptlyDynWith (,) n e
199− delayed <- delay dt tagged
200− return $ attachWithMaybe (\n' (t, v) -> if n' == t then Just v else Nothing) (current n) delayed
201−
202−-- | When the given 'Event' occurs, wait the given amount of time and collect
203−-- all occurrences during that time. Then, fire the output 'Event' with the
204−-- collected output.
205−batchOccurrences :: (MonadFix m, MonadHold t m, PerformEvent t m, TriggerEvent t m, MonadIO (Performable m)) => NominalDiffTime -> Event t a -> m (Event t (Seq a))
206−batchOccurrences t newValues = do
207− let f s x = (Just newState, out)
208− where newState = case x of
209− This a -> s |> a
210− That _ -> mempty
211− These a _ -> Seq.singleton a
212− out = case x of
213− This _ -> if Seq.null s then Just () else Nothing
214− That _ -> Nothing
215− These _ _ -> Just ()
216− rec (buffer, toDelay) <- mapAccumMaybe f mempty $ align newValues delayed
217− delayed <- delay t toDelay
218− return $ tag buffer delayed
3+import Reflex.Time
reflex-dom-core/src/Reflex/Dom/WebSocket.hs+42−11
@@ -9,6 +9,7 @@
99{-# LANGUAGE GADTs #-}
1010{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1111{-# LANGUAGE JavaScriptFFI #-}
12+{-# LANGUAGE LambdaCase #-}
1213{-# LANGUAGE MultiParamTypeClasses #-}
1314{-# LANGUAGE NoMonomorphismRestriction #-}
1415{-# LANGUAGE PolyKinds #-}
@@ -22,7 +23,10 @@
2223{-# LANGUAGE TypeFamilies #-}
2324{-# LANGUAGE UndecidableInstances #-}
2425
25−module Reflex.Dom.WebSocket where
26+module Reflex.Dom.WebSocket
27+ ( module Reflex.Dom.WebSocket
28+ , jsonDecode
29+ ) where
2630
2731import Prelude hiding (all, concat, concatMap, div, mapM, mapM_, sequence, span)
2832
@@ -35,27 +39,35 @@ import Reflex.TriggerEvent.Class
3539
3640import Control.Concurrent
3741import Control.Concurrent.STM
38−import Control.Exception (SomeException)
42+import Control.Exception
3943import Control.Lens
4044import Control.Monad hiding (forM, forM_, mapM, mapM_, sequence)
4145import Control.Monad.IO.Class
4246import Control.Monad.State
47+import Data.Aeson
4348import Data.ByteString (ByteString)
49+import Data.ByteString.Lazy (toStrict)
4450import Data.Default
4551import Data.IORef
52+import Data.JSString.Text
4653import Data.Maybe (isJust)
4754import Data.Text
55+import Data.Text.Encoding
56+import Foreign.JavaScript.Utils (jsonDecode)
4857import GHCJS.DOM.Types (runJSM, askJSM, MonadJSM, liftJSM, JSM)
58+import GHCJS.DOM.WebSocket (getReadyState)
59+import GHCJS.Marshal
4960import qualified Language.Javascript.JSaddle.Monad as JS (catch)
5061
5162data WebSocketConfig t a
5263 = WebSocketConfig { _webSocketConfig_send :: Event t [a]
5364 , _webSocketConfig_close :: Event t (Word, Text)
5465 , _webSocketConfig_reconnect :: Bool
66+ , _webSocketConfig_protocols :: [Text]
5567 }
5668
5769instance Reflex t => Default (WebSocketConfig t a) where
58− def = WebSocketConfig never never True
70+ def = WebSocketConfig never never True []
5971
6072type WebSocket t = RawWebSocket t ByteString
6173
@@ -90,11 +102,11 @@ webSocket' url config onRawMessage = do
90102 liftIO $ triggerEClose args
91103 _ <- liftIO $ atomically $ tryTakeTMVar isOpen
92104 liftIO $ writeIORef currentSocketRef Nothing
93− when (_webSocketConfig_reconnect config) $ do
105+ when (_webSocketConfig_reconnect config) $ forkJSM $ do
94106 liftIO $ threadDelay 1000000
95107 start
96108 start = do
97− ws <- newWebSocket wv url (onRawMessage >=> liftIO . onMessage) (liftIO onOpen) (liftIO onError) onClose
109+ ws <- newWebSocket wv url (_webSocketConfig_protocols config) (onRawMessage >=> liftIO . onMessage) (liftIO onOpen) (liftIO onError) onClose
98110 liftIO $ writeIORef currentSocketRef $ Just ws
99111 return ()
100112 performEvent_ . (liftJSM start <$) =<< getPostBuild
@@ -116,29 +128,48 @@ webSocket' url config onRawMessage = do
116128 mws <- liftIO $ readIORef currentSocketRef
117129 success <- case mws of
118130 Nothing -> return False
119− Just ws -> runJSM ((webSocketSend ws payload >> return True)
120− `JS.catch`
121− (\(_ :: SomeException) -> return False)) ctx
131+ Just ws -> flip runJSM ctx $ do
132+ rs <- getReadyState $ unWebSocket ws
133+ if rs == 1
134+ then (webSocketSend ws payload >> return True) `JS.catch` (\(_ :: SomeException) -> return False)
135+ else return False
122136 unless success $ atomically $ unGetTQueue payloadQueue payload
123137 return $ RawWebSocket eRecv eOpen eError eClose
124138
139+textWebSocket :: (IsWebSocketMessage a, MonadJSM m, MonadJSM (Performable m), HasJSContext m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, Reflex t) => Text -> WebSocketConfig t a -> m (RawWebSocket t Text)
140+textWebSocket url cfg = webSocket' url cfg (either (return . decodeUtf8) fromJSValUnchecked)
141+
142+jsonWebSocket :: (ToJSON a, FromJSON b, MonadJSM m, MonadJSM (Performable m), HasJSContext m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, Reflex t) => Text -> WebSocketConfig t a -> m (RawWebSocket t (Maybe b))
143+jsonWebSocket url cfg = do
144+ ws <- textWebSocket url $ cfg { _webSocketConfig_send = fmap (decodeUtf8 . toStrict . encode) <$> _webSocketConfig_send cfg }
145+ return ws { _webSocket_recv = jsonDecode . textToJSString <$> _webSocket_recv ws }
146+
147+forkJSM :: JSM () -> JSM ()
148+forkJSM a = do
149+ jsm <- askJSM
150+ void $ liftIO $ forkIO $ runJSM a jsm
151+
125152#ifdef USE_TEMPLATE_HASKELL
126153makeLensesWith (lensRules & simpleLenses .~ True) ''WebSocketConfig
127154makeLensesWith (lensRules & simpleLenses .~ True) ''RawWebSocket
128155#else
129156
130157webSocketConfig_send :: Lens' (WebSocketConfig t a) (Event t [a])
131−webSocketConfig_send f (WebSocketConfig x1 x2 x3) = (\y -> WebSocketConfig y x2 x3) <$> f x1
158+webSocketConfig_send f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig y x2 x3 x4) <$> f x1
132159{-# INLINE webSocketConfig_send #-}
133160
134161webSocketConfig_close :: Lens' (WebSocketConfig t a) (Event t (Word, Text))
135−webSocketConfig_close f (WebSocketConfig x1 x2 x3) = (\y -> WebSocketConfig x1 y x3) <$> f x2
162+webSocketConfig_close f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig x1 y x3 x4) <$> f x2
136163{-# INLINE webSocketConfig_close #-}
137164
138165webSocketConfig_reconnect :: Lens' (WebSocketConfig t a) Bool
139−webSocketConfig_reconnect f (WebSocketConfig x1 x2 x3) = (\y -> WebSocketConfig x1 x2 y) <$> f x3
166+webSocketConfig_reconnect f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig x1 x2 y x4) <$> f x3
140167{-# INLINE webSocketConfig_reconnect #-}
141168
169+webSocketConfig_protocols :: Lens' (WebSocketConfig t a) [Text]
170+webSocketConfig_protocols f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig x1 x2 x3 y) <$> f x4
171+{-# INLINE webSocketConfig_protocols #-}
172+
142173webSocket_recv :: Lens' (RawWebSocket t a) (Event t a)
143174webSocket_recv f (RawWebSocket x1 x2 x3 x4) = (\y -> RawWebSocket y x2 x3 x4) <$> f x1
144175{-# INLINE webSocket_recv #-}
reflex-dom-core/src/Reflex/Dom/WebSocket/Foreign.hs+45−27
@@ -12,20 +12,18 @@ module Reflex.Dom.WebSocket.Foreign
1212
1313import Prelude hiding (all, concat, concatMap, div, mapM, mapM_, sequence, span)
1414
15−import Control.Monad.Reader
1615import Data.Bifoldable
1716import Data.ByteString (ByteString)
17+import qualified Data.ByteString.Lazy as LBS
1818import Data.Text (Text)
19−import qualified Data.Text as T (unpack)
2019import Data.Text.Encoding
2120import Foreign.JavaScript.Utils (bsFromMutableArrayBuffer, bsToArrayBuffer)
2221import GHCJS.DOM.CloseEvent
23−import GHCJS.DOM.EventM (on)
2422import GHCJS.DOM.MessageEvent
25−import GHCJS.DOM.Types (JSM, JSVal, liftJSM, fromJSValUnchecked)
26−import GHCJS.DOM.WebSocket (WebSocket)
23+import GHCJS.DOM.Types (JSM, JSVal, liftJSM, fromJSValUnchecked, WebSocket(..))
2724import qualified GHCJS.DOM.WebSocket as DOM
2825import GHCJS.Foreign (JSType(..), jsTypeOf)
26+import Language.Javascript.JSaddle (fun, eval, toJSVal, call)
2927import Language.Javascript.JSaddle.Helper (mutableArrayBufferFromJSVal)
3028import Language.Javascript.JSaddle.Types (ghcjsPure)
3129
@@ -44,9 +42,12 @@ instance IsWebSocketMessage ByteString where
4442 ab <- bsToArrayBuffer bs
4543 DOM.send ws ab
4644
45+instance IsWebSocketMessage LBS.ByteString where
46+ webSocketSend ws = webSocketSend ws . LBS.toStrict
47+
4748-- Use plaintext websocket communication for Text, and String
4849instance IsWebSocketMessage Text where
49− webSocketSend (JSWebSocket ws) = DOM.sendString ws . T.unpack
50+ webSocketSend (JSWebSocket ws) = DOM.sendString ws
5051
5152closeWebSocket :: JSWebSocket -> Word -> Text -> JSM ()
5253closeWebSocket (JSWebSocket ws) code reason = DOM.close ws (Just code) (Just reason)
@@ -54,31 +55,48 @@ closeWebSocket (JSWebSocket ws) code reason = DOM.close ws (Just code) (Just rea
5455newWebSocket
5556 :: a
5657 -> Text -- url
58+ -> [Text] -- protocols
5759 -> (Either ByteString JSVal -> JSM ()) -- onmessage
5860 -> JSM () -- onopen
5961 -> JSM () -- onerror
6062 -> ((Bool, Word, Text) -> JSM ()) -- onclose
6163 -> JSM JSWebSocket
62−newWebSocket _ url onMessage onOpen onError onClose = do
63− ws <- DOM.newWebSocket url ([] :: [Text])
64− DOM.setBinaryType ws "arraybuffer"
65− _ <- on ws DOM.open $ liftJSM onOpen
66− _ <- on ws DOM.error $ liftJSM onError
67− _ <- on ws DOM.closeEvent $ do
68− e <- ask
69− wasClean <- getWasClean e
70− code <- getCode e
71− reason <- getReason e
72− liftJSM $ onClose (wasClean, code, reason)
73− _ <- on ws DOM.message $ do
74− e <- ask
75− d <- getData e
76− liftJSM $ ghcjsPure (jsTypeOf d) >>= \case
77− String -> onMessage $ Right d
78− _ -> do
79− ab <- mutableArrayBufferFromJSVal d
80− bsFromMutableArrayBuffer ab >>= onMessage . Left
81− return $ JSWebSocket ws
64+newWebSocket _ url protocols onMessage onOpen onError onClose = do
65+ let onOpenWrapped = fun $ \_ _ _ -> onOpen
66+ onErrorWrapped = fun $ \_ _ _ -> onError
67+ onCloseWrapped = fun $ \_ _ (e:_) -> do
68+ let e' = CloseEvent e
69+ wasClean <- getWasClean e'
70+ code <- getCode e'
71+ reason <- getReason e'
72+ liftJSM $ onClose (wasClean, code, reason)
73+ onMessageWrapped = fun $ \_ _ (e:_) -> do
74+ let e' = MessageEvent e
75+ d <- getData e'
76+ liftJSM $ ghcjsPure (jsTypeOf d) >>= \case
77+ String -> onMessage $ Right d
78+ _ -> do
79+ ab <- mutableArrayBufferFromJSVal d
80+ bsFromMutableArrayBuffer ab >>= onMessage . Left
81+ newWS <- eval $ unlines
82+ [ "(function(url, protos, open, error, close, message) {"
83+ , " var ws = new window['WebSocket'](url, protos);"
84+ , " ws['binaryType'] = 'arraybuffer';"
85+ , " ws['addEventListener']('open', open);"
86+ , " ws['addEventListener']('error', error);"
87+ , " ws['addEventListener']('close', close);"
88+ , " ws['addEventListener']('message', message);"
89+ , " return ws;"
90+ , "})"
91+ ]
92+ url' <- toJSVal url
93+ protocols' <- toJSVal protocols
94+ onOpen' <- toJSVal onOpenWrapped
95+ onError' <- toJSVal onErrorWrapped
96+ onClose' <- toJSVal onCloseWrapped
97+ onMessage' <- toJSVal onMessageWrapped
98+ ws <- call newWS newWS [url', protocols', onOpen', onError', onClose', onMessage']
99+ return $ JSWebSocket $ WebSocket ws
82100
83101onBSMessage :: Either ByteString JSVal -> JSM ByteString
84−onBSMessage = either return (\v -> encodeUtf8 <$> fromJSValUnchecked v)
102+onBSMessage = either return $ fmap encodeUtf8 . fromJSValUnchecked
reflex-dom-core/src/Reflex/Dom/WebSocket/Query.hsnew file+37
@@ -0,0 +1,37 @@
1+{-# LANGUAGE FlexibleContexts #-}
2+{-# LANGUAGE RecursiveDo #-}
3+module Reflex.Dom.WebSocket.Query (cropQueryT, runWebSocketQuery) where
4+
5+import Data.Default
6+import Control.Monad.Fix
7+import Data.Text (Text)
8+import Data.Aeson
9+import Reflex
10+import Reflex.Dom.WebSocket
11+import Foreign.JavaScript.TH
12+import Data.Maybe
13+import Language.Javascript.JSaddle.Types (MonadJSM)
14+
15+runWebSocketQuery :: (MonadJSM m, MonadJSM (Performable m), HasJSContext m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, Reflex t, ToJSON q, MonadFix m, Query q, FromJSON (QueryResult q), Additive q, Group q, Eq q)
16+ => QueryT t q m a
17+ -> Text -- ^ WebSocket url
18+ -> m a
19+runWebSocketQuery app url = do
20+ postBuild <- getPostBuild
21+ rec ws <- jsonWebSocket url $ def { _webSocketConfig_send = pure <$> updatedRequest }
22+ (a, request) <- cropQueryT app $ fromMaybe mempty <$> _webSocket_recv ws
23+ let updatedRequest = leftmost [updated request, tag (current request) postBuild]
24+ return a
25+
26+cropQueryT :: (Reflex t, MonadHold t m, MonadFix m, Query q, Additive q, Group q, Eq q)
27+ => QueryT t q m a
28+ -> Event t (QueryResult q)
29+ -> m (a, Dynamic t q)
30+cropQueryT app result = do
31+ rec (a, requestPatch) <- runQueryT app croppedResult
32+ requestUniq <- holdUniqDyn $ incrementalToDynamic requestPatch
33+ croppedResult <- cropDyn requestUniq result
34+ return (a, requestUniq)
35+
36+cropDyn :: (Query q, MonadHold t m, Reflex t, MonadFix m) => Dynamic t q -> Event t (QueryResult q) -> m (Dynamic t (QueryResult q))
37+cropDyn q = foldDyn (\(q', qr) v -> crop q' (qr `mappend` v)) mempty . attach (current q)
reflex-dom-core/src/Reflex/Dom/Widget/Basic.hs+73−224
@@ -3,7 +3,6 @@
33{-# LANGUAGE FlexibleContexts #-}
44{-# LANGUAGE FlexibleInstances #-}
55{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE LambdaCase #-}
76{-# LANGUAGE MultiParamTypeClasses #-}
87{-# LANGUAGE OverloadedStrings #-}
98{-# LANGUAGE RankNTypes #-}
@@ -11,33 +10,18 @@
1110{-# LANGUAGE ScopedTypeVariables #-}
1211{-# LANGUAGE TypeFamilies #-}
1312module Reflex.Dom.Widget.Basic
14− ( partitionMapBySetLT
15− , listHoldWithKey
16− , ChildResult (..)
17−
13+ (
1814 -- * Displaying Values
19− , text
15+ text
2016 , dynText
17+ , comment
18+ , dynComment
2119 , display
2220 , button
2321 , dyn
22+ , dyn_
2423 , widgetHold
25− , untilReady
26−
27− -- * Working with Maps
28− , diffMapNoEq
29− , diffMap
30− , applyMap
31− , mapPartitionEithers
32− , applyMapKeysSet
33−
34− -- * Widgets on Collections
35− , listWithKey
36− , listWithKey'
37− , listWithKeyShallowDiff
38− , listViewWithKey
39− , selectViewListWithKey
40− , selectViewListWithKey_
24+ , widgetHold_
4125
4226 -- * Creating DOM Elements
4327 , el
@@ -45,6 +29,7 @@ module Reflex.Dom.Widget.Basic
4529 , elClass
4630 , elDynAttr
4731 , elDynClass
32+ , elDynAttrNS
4833
4934 -- ** With Element Results
5035 , el'
@@ -54,10 +39,7 @@ module Reflex.Dom.Widget.Basic
5439 , elDynClass'
5540 , elDynAttrNS'
5641 , dynamicAttributesToModifyAttributes
57−
58− -- * List Utils
59− , list
60− , simpleList
42+ , dynamicAttributesToModifyAttributesWithInitial
6143
6244 -- * Specific DOM Elements
6345 , Link (..)
@@ -67,25 +49,26 @@ module Reflex.Dom.Widget.Basic
6749 , dtdd
6850 , blank
6951
70− -- * Workflows
71− , Workflow (..)
72− , workflow
73− , workflowView
74− , mapWorkflow
75− , mapWorkflowCheap
76−
7752 -- * Tables and Lists
7853 , tableDynAttr
7954 , tabDisplay
8055
8156 , HasAttributes (..)
57+ , module Data.Map.Misc
58+ , module Reflex.Collection
59+ , module Reflex.Workflow
60+ , partitionMapBySetLT
8261 ) where
8362
63+import Reflex.Adjustable.Class
8464import Reflex.Class
65+import Reflex.Collection
8566import Reflex.Dom.Builder.Class
8667import Reflex.Dom.Class
8768import Reflex.Dynamic
69+import Reflex.Network
8870import Reflex.PostBuild.Class
71+import Reflex.Workflow
8972
9073import Control.Arrow
9174import Control.Lens hiding (children, element)
@@ -94,9 +77,10 @@ import Data.Align
9477import Data.Default
9578import Data.Either
9679import Data.Foldable
97−import Data.Functor.Misc
80+import Data.Functor (void)
9881import Data.Map (Map)
9982import qualified Data.Map as Map
83+import Data.Map.Misc
10084import Data.Maybe
10185import Data.Set (Set)
10286import qualified Data.Set as Set
@@ -106,14 +90,12 @@ import Data.These
10690import Data.Traversable
10791import Prelude hiding (mapM, mapM_, sequence, sequence_)
10892
109−widgetHoldInternal :: forall t m a b. DomBuilder t m => m a -> Event t (m b) -> m (a, Event t b)
110−widgetHoldInternal = runWithReplace
111−
11293-- | Breaks the given Map into pieces based on the given Set. Each piece will contain only keys that are less than the key of the piece, and greater than or equal to the key of the piece with the next-smaller key. There will be one additional piece containing all keys from the original Map that are larger or equal to the largest key in the Set.
11394-- Either k () is used instead of Maybe k so that the resulting map of pieces is sorted so that the additional piece has the largest key.
11495-- No empty pieces will be included in the output.
11596
11697--TODO: This can probably be done more efficiently by dividing and conquering, re-using the structure of the Set instead of going through the Set linearally
98+{-# DEPRECATED partitionMapBySetLT "This will be removed in future releases." #-}
11799partitionMapBySetLT :: forall k v. Ord k => Set k -> Map k v -> Map (Either k ()) (Map k v)
118100partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
119101 where go :: [k] -> Map k v -> [(Either k (), Map k v)]
@@ -126,18 +108,11 @@ partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
126108 then go t geq
127109 else (Left h, lt) : go t geq
128110
129−newtype ChildResult t k a = ChildResult { unChildResult :: (a, Event t (Map k (Maybe (ChildResult t k a)))) }
130−
131−listHoldWithKey :: forall t m k v a. (Ord k, DomBuilder t m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> m a) -> m (Dynamic t (Map k a))
132−listHoldWithKey m0 m' f = do
133− let dm0 = mapWithFunctorToDMap $ Map.mapWithKey f m0
134− dm' = fmap (PatchDMap . mapWithFunctorToDMap . Map.mapWithKey (\k v -> ComposeMaybe $ fmap (f k) v)) m'
135− (a0, a') <- sequenceDMapWithAdjust dm0 dm'
136− fmap dmapToMap . incrementalToDynamic <$> holdIncremental a0 a' --TODO: Move the dmapToMap to the righthand side so it doesn't get fully redone every time
137−
111+{-# INLINABLE text #-}
138112text :: DomBuilder t m => Text -> m ()
139113text t = void $ textNode $ def & textNodeConfig_initialContents .~ t
140114
115+{-# INLINABLE dynText #-}
141116dynText :: forall t m. (PostBuild t m, DomBuilder t m) => Dynamic t Text -> m ()
142117dynText t = do
143118 postBuild <- getPostBuild
@@ -147,6 +122,19 @@ dynText t = do
147122 ]
148123 notReadyUntil postBuild
149124
125+comment :: DomBuilder t m => Text -> m ()
126+comment t = void $ commentNode $ def & commentNodeConfig_initialContents .~ t
127+
128+{-# INLINABLE dynComment #-}
129+dynComment :: forall t m. (PostBuild t m, DomBuilder t m) => Dynamic t Text -> m ()
130+dynComment t = do
131+ postBuild <- getPostBuild
132+ void $ commentNode $ (def :: CommentNodeConfig t) & commentNodeConfig_setContents .~ leftmost
133+ [ updated t
134+ , tag (current t) postBuild
135+ ]
136+ notReadyUntil postBuild
137+
150138display :: (PostBuild t m, DomBuilder t m, Show a) => Dynamic t a -> m ()
151139display = dynText . fmap (T.pack . show)
152140
@@ -157,168 +145,73 @@ button t = do
157145
158146--TODO: Should this be renamed to 'widgetView' for consistency with 'widgetHold'?
159147-- | Given a Dynamic of widget-creating actions, create a widget that is recreated whenever the Dynamic updates.
160−-- The returned Event of widget results occurs when the Dynamic does.
161−-- Note: Often, the type 'a' is an Event, in which case the return value is an Event-of-Events that would typically be flattened (via 'switchPromptly').
162−dyn :: (DomBuilder t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
163−dyn child = do
164− postBuild <- getPostBuild
165− let newChild = leftmost [updated child, tagCheap (current child) postBuild]
166− snd <$> widgetHoldInternal notReady newChild
148+-- The returned Event occurs whenever the child widget is updated, which is
149+-- at post-build in addition to the times at which the input Dynamic is
150+-- updated, and its value is the result of running the widget.
151+-- Note: Often, the type @a@ is an 'Event', in which case the return value is an Event-of-Events that would typically be flattened (via 'switchHold').
152+dyn :: (Adjustable t m, NotReady t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
153+dyn = networkView
154+
155+-- | Like 'dyn' but discards result.
156+dyn_ :: (Adjustable t m, NotReady t m, PostBuild t m) => Dynamic t (m a) -> m ()
157+dyn_ = void . dyn
167158
168159-- | Given an initial widget and an Event of widget-creating actions, create a widget that is recreated whenever the Event fires.
169160-- The returned Dynamic of widget results occurs when the Event does.
170−-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
171−widgetHold :: (DomBuilder t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
172−widgetHold child0 newChild = do
173− (result0, newResult) <- widgetHoldInternal child0 newChild
174− holdDyn result0 newResult
175−
176−-- | Render a placeholder widget to be shown while another widget is not yet
177−-- done rendering
178−untilReady :: (DomBuilder t m, PostBuild t m) => m a -> m b -> m (a, Event t b)
179−untilReady a b = do
180− postBuild <- getPostBuild
181− runWithReplace a $ b <$ postBuild
182−
183−diffMapNoEq :: (Ord k) => Map k v -> Map k v -> Map k (Maybe v)
184−diffMapNoEq olds news = flip Map.mapMaybe (align olds news) $ \case
185− This _ -> Just Nothing
186− These _ new -> Just $ Just new
187− That new -> Just $ Just new
188−
189−diffMap :: (Ord k, Eq v) => Map k v -> Map k v -> Map k (Maybe v)
190−diffMap olds news = flip Map.mapMaybe (align olds news) $ \case
191− This _ -> Just Nothing
192− These old new
193− | old == new -> Nothing
194− | otherwise -> Just $ Just new
195− That new -> Just $ Just new
196−
197−applyMap :: Ord k => Map k (Maybe v) -> Map k v -> Map k v
198−applyMap patch old = insertions `Map.union` (old `Map.difference` deletions)
199− where (deletions, insertions) = mapPartitionEithers $ maybeToEither <$> patch
200− maybeToEither = \case
201− Nothing -> Left ()
202− Just r -> Right r
203−
204−mapPartitionEithers :: Map k (Either a b) -> (Map k a, Map k b)
205−mapPartitionEithers m = (fromLeft <$> ls, fromRight <$> rs)
206− where (ls, rs) = Map.partition isLeft m
207− fromLeft (Left l) = l
208− fromLeft _ = error "mapPartitionEithers: fromLeft received a Right value; this should be impossible"
209− fromRight (Right r) = r
210− fromRight _ = error "mapPartitionEithers: fromRight received a Left value; this should be impossible"
211−
212−-- | Apply a map patch to a set
213−-- > applyMapKeysSet patch (Map.keysSet m) == Map.keysSet (applyMap patch m)
214−applyMapKeysSet :: Ord k => Map k (Maybe v) -> Set k -> Set k
215−applyMapKeysSet patch old = Map.keysSet insertions `Set.union` (old `Set.difference` Map.keysSet deletions)
216− where (insertions, deletions) = Map.partition isJust patch
217−
218−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
219−listWithKey :: forall t k v m a. (Ord k, DomBuilder t m, PostBuild t m, MonadFix m, MonadHold t m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m a) -> m (Dynamic t (Map k a))
220−listWithKey vals mkChild = do
221− postBuild <- getPostBuild
222− let childValChangedSelector = fanMap $ updated vals
223− -- We keep track of changes to children values in the mkChild function we pass to listHoldWithKey
224− -- The other changes we need to keep track of are child insertions and deletions. diffOnlyKeyChanges
225− -- keeps track of insertions and deletions but ignores value changes, since they're already accounted for.
226− diffOnlyKeyChanges olds news = flip Map.mapMaybe (align olds news) $ \case
227− This _ -> Just Nothing
228− These _ _ -> Nothing
229− That new -> Just $ Just new
230− rec sentVals :: Dynamic t (Map k v) <- foldDyn applyMap Map.empty changeVals
231− let changeVals :: Event t (Map k (Maybe v))
232− changeVals = attachWith diffOnlyKeyChanges (current sentVals) $ leftmost
233− [ updated vals
234− , tag (current vals) postBuild --TODO: This should probably be added to the attachWith, not to the updated; if we were using diffMap instead of diffMapNoEq, I think it might not work
235− ]
236− listHoldWithKey Map.empty changeVals $ \k v ->
237− mkChild k =<< holdDyn v (select childValChangedSelector $ Const2 k)
238−
239−{-# DEPRECATED listWithKey' "listWithKey' has been renamed to listWithKeyShallowDiff; also, its behavior has changed to fix a bug where children were always rebuilt (never updated)" #-}
240−listWithKey' :: (Ord k, DomBuilder t m, MonadFix m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> Event t v -> m a) -> m (Dynamic t (Map k a))
241−listWithKey' = listWithKeyShallowDiff
242−
243−-- | Display the given map of items (in key order) using the builder function provided, and update it with the given event. 'Nothing' update entries will delete the corresponding children, and 'Just' entries will create them if they do not exist or send an update event to them if they do.
244−listWithKeyShallowDiff :: (Ord k, DomBuilder t m, MonadFix m, MonadHold t m) => Map k v -> Event t (Map k (Maybe v)) -> (k -> v -> Event t v -> m a) -> m (Dynamic t (Map k a))
245−listWithKeyShallowDiff initialVals valsChanged mkChild = do
246− let childValChangedSelector = fanMap $ fmap (Map.mapMaybe id) valsChanged
247− sentVals <- foldDyn applyMap Map.empty $ fmap (fmap void) valsChanged
248− let relevantPatch patch _ = case patch of
249− Nothing -> Just Nothing -- Even if we let a Nothing through when the element doesn't already exist, this doesn't cause a problem because it is ignored
250− Just _ -> Nothing -- We don't want to let spurious re-creations of items through
251− listHoldWithKey initialVals (attachWith (flip (Map.differenceWith relevantPatch)) (current sentVals) valsChanged) $ \k v ->
252− mkChild k v $ select childValChangedSelector $ Const2 k
253−
254−--TODO: Something better than Dynamic t (Map k v) - we want something where the Events carry diffs, not the whole value
255−-- | Create a dynamically-changing set of Event-valued widgets.
256−-- This is like listWithKey, specialized for widgets returning (Event t a). listWithKey would return 'Dynamic t (Map k (Event t a))' in this scenario, but listViewWithKey flattens this to 'Event t (Map k a)' via 'switch'.
257−listViewWithKey :: (Ord k, DomBuilder t m, PostBuild t m, MonadHold t m, MonadFix m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m (Event t a)) -> m (Event t (Map k a))
258−listViewWithKey vals mkChild = switch . fmap mergeMap <$> listViewWithKey' vals mkChild
259−
260−listViewWithKey' :: (Ord k, DomBuilder t m, PostBuild t m, MonadHold t m, MonadFix m) => Dynamic t (Map k v) -> (k -> Dynamic t v -> m a) -> m (Behavior t (Map k a))
261−listViewWithKey' vals mkChild = current <$> listWithKey vals mkChild
262−
263−-- | Create a dynamically-changing set of widgets, one of which is selected at any time.
264−selectViewListWithKey :: forall t m k v a. (DomBuilder t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
265− => Dynamic t k -- ^ Current selection key
266− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
267− -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a)) -- ^ Function to create a widget for a given key from Dynamic value and Dynamic Bool indicating if this widget is currently selected
268− -> m (Event t (k, a)) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
269−selectViewListWithKey selection vals mkChild = do
270− let selectionDemux = demux selection -- For good performance, this value must be shared across all children
271− selectChild <- listWithKey vals $ \k v -> do
272− let selected = demuxed selectionDemux k
273− selectSelf <- mkChild k v selected
274− return $ fmap ((,) k) selectSelf
275− return $ switchPromptlyDyn $ leftmost . Map.elems <$> selectChild
276−
277−selectViewListWithKey_ :: forall t m k v a. (DomBuilder t m, Ord k, PostBuild t m, MonadHold t m, MonadFix m)
278− => Dynamic t k -- ^ Current selection key
279− -> Dynamic t (Map k v) -- ^ Dynamic key/value map
280− -> (k -> Dynamic t v -> Dynamic t Bool -> m (Event t a)) -- ^ Function to create a widget for a given key from Dynamic value and Dynamic Bool indicating if this widget is currently selected
281− -> m (Event t k) -- ^ Event that fires when any child's return Event fires. Contains key of an arbitrary firing widget.
282−selectViewListWithKey_ selection vals mkChild = fmap fst <$> selectViewListWithKey selection vals mkChild
161+-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened (via 'switchDyn').
162+widgetHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
163+widgetHold = networkHold
164+
165+-- | Like 'widgetHold' but discards result.
166+widgetHold_ :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m ()
167+widgetHold_ z = void . widgetHold z
283168
284169-- | Create a DOM element
285−-- > el "div" (text "Hello World")
170+--
171+-- >>> el "div" (text "Hello World")
286172-- <div>Hello World</div>
287173{-# INLINABLE el #-}
288174el :: forall t m a. DomBuilder t m => Text -> m a -> m a
289175el elementTag child = snd <$> el' elementTag child
290176
291177-- | Create a DOM element with attributes
292−-- > elAttr "a" ("href" =: "http://google.com") (text "Google!")
293−-- <a href="http://google.com">Google!</a>
178+--
179+-- >>> elAttr "a" ("href" =: "https://reflex-frp.org") (text "Reflex-FRP!")
180+-- <a href="https://reflex-frp.org">Reflex-FRP!</a>
294181{-# INLINABLE elAttr #-}
295182elAttr :: forall t m a. DomBuilder t m => Text -> Map Text Text -> m a -> m a
296183elAttr elementTag attrs child = snd <$> elAttr' elementTag attrs child
297184
298185-- | Create a DOM element with classes
299−-- > elClass "div" "row" (return ())
186+--
187+-- >>> elClass "div" "row" (return ())
300188-- <div class="row"></div>
301189{-# INLINABLE elClass #-}
302190elClass :: forall t m a. DomBuilder t m => Text -> Text -> m a -> m a
303191elClass elementTag c child = snd <$> elClass' elementTag c child
304192
305193-- | Create a DOM element with Dynamic Attributes
306−-- > elClass "div" (constDyn ("class" =: "row")) (return ())
194+--
195+-- >>> elClass "div" (constDyn ("class" =: "row")) (return ())
307196-- <div class="row"></div>
308197{-# INLINABLE elDynAttr #-}
309198elDynAttr :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t (Map Text Text) -> m a -> m a
310199elDynAttr elementTag attrs child = snd <$> elDynAttr' elementTag attrs child
311200
312201-- | Create a DOM element with a Dynamic Class
313−-- > elDynClass "div" (constDyn "row") (return ())
202+--
203+-- >>> elDynClass "div" (constDyn "row") (return ())
314204-- <div class="row"></div>
315205{-# INLINABLE elDynClass #-}
316206elDynClass :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t Text -> m a -> m a
317207elDynClass elementTag c child = snd <$> elDynClass' elementTag c child
318208
319209-- | Create a DOM element and return the element
320−-- > do (e, _) <- el' "div" (text "Click")
321−-- > return $ domEvent Click e
210+--
211+-- @
212+-- do (e, _) <- el' "div" (text "Click")
213+-- return $ domEvent Click e
214+-- @
322215{-# INLINABLE el' #-}
323216el' :: forall t m a. DomBuilder t m => Text -> m a -> m (Element EventResult (DomBuilderSpace m) t, a)
324217el' elementTag = element elementTag def
@@ -356,6 +249,10 @@ elDynAttrNS' mns elementTag attrs child = do
356249 notReadyUntil postBuild
357250 return result
358251
252+{-# INLINABLE elDynAttrNS #-}
253+elDynAttrNS :: forall t m a. (DomBuilder t m, PostBuild t m) => Maybe Text -> Text -> Dynamic t (Map Text Text) -> m a -> m a
254+elDynAttrNS mns elementTag attrs child = fmap snd $ elDynAttrNS' mns elementTag attrs child
255+
359256dynamicAttributesToModifyAttributes :: (Ord k, PostBuild t m) => Dynamic t (Map k Text) -> m (Event t (Map k (Maybe Text)))
360257dynamicAttributesToModifyAttributes = dynamicAttributesToModifyAttributesWithInitial mempty
361258
@@ -374,37 +271,6 @@ dynamicAttributesToModifyAttributesWithInitial attrs0 d = do
374271 return $ if Map.null p then Nothing else Just p
375272 return modificationsNeeded
376273
377−--------------------------------------------------------------------------------
378−-- Copied and pasted from Reflex.Widget.Class
379−--------------------------------------------------------------------------------
380−
381−-- | Create a dynamically-changing set of widgets from a Dynamic key/value map.
382−-- Unlike the 'withKey' variants, the child widgets are insensitive to which key they're associated with.
383−list :: (Ord k, DomBuilder t m, MonadHold t m, PostBuild t m, MonadFix m) => Dynamic t (Map k v) -> (Dynamic t v -> m a) -> m (Dynamic t (Map k a))
384−list dm mkChild = listWithKey dm (\_ dv -> mkChild dv)
385−
386−-- | Create a dynamically-changing set of widgets from a Dynamic list.
387−simpleList :: (DomBuilder t m, MonadHold t m, PostBuild t m, MonadFix m) => Dynamic t [v] -> (Dynamic t v -> m a) -> m (Dynamic t [a])
388−simpleList xs mkChild = fmap (fmap (map snd . Map.toList)) $ flip list mkChild $ fmap (Map.fromList . zip [(1::Int)..]) xs
389−
390−{-
391−schedulePostBuild x = performEvent_ . (x <$) =<< getPostBuild
392−
393−elDynHtml' :: DomBuilder t m => Text -> Dynamic t Text -> m (El t)
394−elDynHtml' elementTag html = do
395− e <- buildEmptyElement elementTag (Map.empty :: Map Text Text)
396− schedulePostBuild $ setInnerHTML e . Just =<< sample (current html)
397− performEvent_ $ fmap (setInnerHTML e . Just) $ updated html
398− wrapElement defaultDomEventHandler e
399−
400−elDynHtmlAttr' :: DomBuilder t m => Text -> Map Text Text -> Dynamic t Text -> m (El t)
401−elDynHtmlAttr' elementTag attrs html = do
402− e <- buildEmptyElement elementTag attrs
403− schedulePostBuild $ setInnerHTML e . Just =<< sample (current html)
404− performEvent_ $ fmap (setInnerHTML e . Just) $ updated html
405− wrapElement defaultDomEventHandler e
406−-}
407−
408274newtype Link t
409275 = Link { _link_clicked :: Event t ()
410276 }
@@ -428,25 +294,7 @@ dtdd h w = do
428294blank :: forall m. Monad m => m ()
429295blank = return ()
430296
431−newtype Workflow t m a = Workflow { unWorkflow :: m (a, Event t (Workflow t m a)) }
432−
433−workflow :: forall t m a. (DomBuilder t m, MonadFix m, MonadHold t m) => Workflow t m a -> m (Dynamic t a)
434−workflow w0 = do
435− rec eResult <- widgetHold (unWorkflow w0) $ fmap unWorkflow $ switch $ snd <$> current eResult
436− return $ fmap fst eResult
437−
438−workflowView :: forall t m a. (DomBuilder t m, MonadFix m, MonadHold t m, PostBuild t m) => Workflow t m a -> m (Event t a)
439−workflowView w0 = do
440− rec eResult <- dyn . fmap unWorkflow =<< holdDyn w0 eReplace
441− eReplace <- fmap switch $ hold never $ fmap snd eResult
442− return $ fmap fst eResult
443−
444−mapWorkflow :: (DomBuilder t m) => (a -> b) -> Workflow t m a -> Workflow t m b
445−mapWorkflow f (Workflow x) = Workflow (fmap (f *** fmap (mapWorkflow f)) x)
446−
447−mapWorkflowCheap :: (DomBuilder t m) => (a -> b) -> Workflow t m a -> Workflow t m b
448−mapWorkflowCheap f (Workflow x) = Workflow (fmap (f *** fmapCheap (mapWorkflowCheap f)) x)
449−
297+-- TODO: Move to an example project.
450298-- | A widget to display a table with static columns and dynamic rows.
451299tableDynAttr :: forall t m r k v. (Ord k, DomBuilder t m, MonadHold t m, PostBuild t m, MonadFix m)
452300 => Text -- ^ Class applied to <table> element
@@ -463,6 +311,7 @@ tableDynAttr klass cols dRows rowAttrs = elAttr "div" (Map.singleton "style" "zo
463311 dAttrs <- rowAttrs k
464312 elDynAttr' "tr" dAttrs $ mapM (\x -> el "td" $ snd x k r) cols)
465313
314+-- TODO: Move to an example project.
466315-- | A widget to construct a tabbed view that shows only one of its child widgets at a time.
467316-- Creates a header bar containing a <ul> with one <li> per child; clicking a <li> displays
468317-- the corresponding child and hides all others.
reflex-dom-core/src/Reflex/Dom/Widget/Input.hs+22−53
@@ -41,6 +41,7 @@ import GHCJS.DOM.HTMLTextAreaElement (HTMLTextAreaElement)
4141import GHCJS.DOM.Types (MonadJSM, File, uncheckedCastTo)
4242import qualified GHCJS.DOM.Types as DOM (HTMLElement(..), EventTarget(..))
4343import Reflex.Class
44+import Reflex.Collection
4445import Reflex.Dom.Builder.Class
4546import Reflex.Dom.Builder.Immediate
4647import Reflex.Dom.Class
@@ -53,6 +54,7 @@ import qualified Text.Read as T
5354import qualified GHCJS.DOM.Event as Event
5455import qualified GHCJS.DOM.HTMLInputElement as Input
5556
57+{-# DEPRECATED TextInput, _textInput_element, TextInputConfig, textInput "Use 'inputElement' directly" #-}
5658data TextInput t
5759 = TextInput { _textInput_value :: Dynamic t Text
5860 , _textInput_input :: Event t Text
@@ -111,7 +113,15 @@ textInputGetEnter = keypress Enter
111113
112114{-# INLINABLE keypress #-}
113115keypress :: (Reflex t, HasDomEvent t e 'KeypressTag, DomEventType e 'KeypressTag ~ Word) => Key -> e -> Event t ()
114−keypress key i = fmapMaybe (\n -> if keyCodeLookup (fromIntegral n) == key then Just () else Nothing) $ domEvent Keypress i
116+keypress key = fmapMaybe (\n -> guard $ keyCodeLookup (fromIntegral n) == key) . domEvent Keypress
117+
118+{-# INLINABLE keydown #-}
119+keydown :: (Reflex t, HasDomEvent t e 'KeydownTag, DomEventType e 'KeydownTag ~ Word) => Key -> e -> Event t ()
120+keydown key = fmapMaybe (\n -> guard $ keyCodeLookup (fromIntegral n) == key) . domEvent Keydown
121+
122+{-# INLINABLE keyup #-}
123+keyup :: (Reflex t, HasDomEvent t e 'KeyupTag, DomEventType e 'KeyupTag ~ Word) => Key -> e -> Event t ()
124+keyup key = fmapMaybe (\n -> guard $ keyCodeLookup (fromIntegral n) == key) . domEvent Keyup
115125
116126data RangeInputConfig t
117127 = RangeInputConfig { _rangeInputConfig_initialValue :: Float
@@ -152,6 +162,7 @@ rangeInput (RangeInputConfig initial eSetValue dAttrs) = do
152162 , _rangeInput_element = _inputElement_raw i
153163 }
154164
165+{-# DEPRECATED TextAreaConfig, TextArea, textArea "Use 'textAreaElement' directly" #-}
155166data TextAreaConfig t
156167 = TextAreaConfig { _textAreaConfig_initialValue :: Text
157168 , _textAreaConfig_setValue :: Event t Text
@@ -189,6 +200,7 @@ textArea (TextAreaConfig initial eSet attrs) = do
189200 , _textArea_element = _textAreaElement_raw i
190201 }
191202
203+{-# DEPRECATED CheckboxConfig, Checkbox, checkbox, checkboxView, CheckboxViewEventResultType, regularToCheckboxViewEventType, CheckboxViewEventResult "Use 'inputElement' directly" #-}
192204data CheckboxConfig t
193205 = CheckboxConfig { _checkboxConfig_setValue :: Event t Bool
194206 , _checkboxConfig_attributes :: Dynamic t (Map Text Text)
@@ -278,7 +290,7 @@ regularToCheckboxViewEventType en r = case en of
278290
279291newtype CheckboxViewEventResult en = CheckboxViewEventResult { unCheckboxViewEventResult :: CheckboxViewEventResultType en }
280292
281−--TODO
293+-- | Create a view only checkbox
282294{-# INLINABLE checkboxView #-}
283295checkboxView :: forall t m. (DomBuilder t m, DomBuilderSpace m ~ GhcjsDomSpace, PostBuild t m, MonadHold t m) => Dynamic t (Map Text Text) -> Dynamic t Bool -> m (Event t Bool)
284296checkboxView dAttrs dValue = do
@@ -312,6 +324,7 @@ checkboxView dAttrs dValue = do
312324 i <- inputElement inputElementConfig
313325 return $ unCheckboxViewEventResult <$> select (_element_events $ _inputElement_element i) (WrapArg Click)
314326
327+{-# DEPRECATED FileInput, FileInputConfig, fileInput "Use 'inputElement' directly" #-}
315328data FileInput d t
316329 = FileInput { _fileInput_value :: Dynamic t [File]
317330 , _fileInput_element :: RawInputElement d
@@ -337,16 +350,10 @@ fileInput config = do
337350 & modifyAttributes .~ fmap mapKeysToAttributeName modifyAttrs
338351 & elementConfig_eventSpec . ghcjsEventSpec_filters .~ filters
339352 cfg = (def :: InputElementConfig EventResult t (DomBuilderSpace m)) & inputElementConfig_elementConfig .~ elCfg
340− eRaw <- inputElement cfg
341− let e = _inputElement_raw eRaw
342− eChange <- wrapDomEvent e (`on` Events.change) $ do
343− files <- Input.getFilesUnchecked e
344− len <- FileList.getLength files
345− mapM (fmap (fromMaybe (error "fileInput: fileList.item returned null")) . FileList.item files) [0 .. len-1]
346− dValue <- holdDyn [] eChange
353+ input <- inputElement cfg
347354 return $ FileInput
348− { _fileInput_value = dValue
349− , _fileInput_element = e
355+ { _fileInput_value = _inputElement_files input
356+ , _fileInput_element = _inputElement_raw input
350357 }
351358
352359data Dropdown t k
@@ -430,9 +437,12 @@ dropdown k0 options (DropdownConfig setK attrs) = do
430437 let xs = fmap (\(ix, (k, v)) -> ((ix, k), ((ix, k), v))) $ zip [0::Int ..] $ Map.toList os
431438 in (Map.fromList $ map snd xs, Bimap.fromList $ map fst xs)
432439 modifyAttrs <- dynamicAttributesToModifyAttributes attrs
440+ postBuild <- getPostBuild
441+ let setSelection = attachPromptlyDynWithMaybe (flip Bimap.lookupR) ixKeys $
442+ leftmost [setK, k0 <$ postBuild]
433443 let cfg = def
434444 & selectElementConfig_elementConfig . elementConfig_modifyAttributes .~ fmap mapKeysToAttributeName modifyAttrs
435− & selectElementConfig_setValue .~ fmap (T.pack . show) (attachPromptlyDynWithMaybe (flip Bimap.lookupR) ixKeys setK)
445+ & selectElementConfig_setValue .~ fmap (T.pack . show) setSelection
436446 (eRaw, _) <- selectElement cfg $ listWithKey indexedOptions $ \(ix, k) v -> do
437447 let optionAttrs = fmap (\dk -> "value" =: T.pack (show ix) <> if dk == k then "selected" =: "selected" else mempty) defaultKey
438448 elDynAttr "option" optionAttrs $ dynText v
@@ -619,9 +629,6 @@ instance HasAttributes (FileInputConfig t) where
619629 type Attrs (FileInputConfig t) = Dynamic t (Map Text Text)
620630 attributes = fileInputConfig_attributes
621631
622−class HasSetValue a where
623− type SetValue a :: *
624− setValue :: Lens' a (SetValue a)
625632
626633instance HasSetValue (TextAreaConfig t) where
627634 type SetValue (TextAreaConfig t) = Event t Text
@@ -678,41 +685,3 @@ instance HasValue (Dropdown t k) where
678685instance HasValue (Checkbox t) where
679686 type Value (Checkbox t) = Dynamic t Bool
680687 value = _checkbox_value
681−
682−{-
683−type family Controller sm t a where
684− Controller Edit t a = (a, Event t a) -- Initial value and setter
685− Controller View t a = Dynamic t a -- Value (always)
686−
687−type family Output sm t a where
688− Output Edit t a = Dynamic t a -- Value (always)
689− Output View t a = Event t a -- Requested changes
690−
691−data CheckboxConfig sm t
692− = CheckboxConfig { _checkbox_input :: Controller sm t Bool
693− , _checkbox_attributes :: Attributes
694− }
695−
696−instance Reflex t => Default (CheckboxConfig Edit t) where
697− def = CheckboxConfig (False, never) mempty
698−
699−data Checkbox sm t
700− = Checkbox { _checkbox_output :: Output sm t Bool
701− }
702−
703−data StateMode = Edit | View
704−
705−--TODO: There must be a more generic way to get this witness and allow us to case on the type-level StateMode
706−data StateModeWitness (sm :: StateMode) where
707− EditWitness :: StateModeWitness Edit
708− ViewWitness :: StateModeWitness View
709−
710−class HasStateModeWitness (sm :: StateMode) where
711− stateModeWitness :: StateModeWitness sm
712−
713−instance HasStateModeWitness Edit where
714− stateModeWitness = EditWitness
715−
716−instance HasStateModeWitness View where
717− stateModeWitness = ViewWitness
718−-}
reflex-dom-core/src/Reflex/Dom/Widget/Lazy.hs+7−5
@@ -7,6 +7,7 @@
77module Reflex.Dom.Widget.Lazy where
88
99import Reflex.Class
10+import Reflex.Collection
1011import Reflex.Dom.Builder.Class
1112import Reflex.Dom.Builder.Immediate
1213import Reflex.Dom.Class
@@ -63,7 +64,7 @@ virtualListWithSelection heightPx rowPx maxIndex i0 setI listTag listAttrs rowTa
6364 let indexAndLength = fmap snd window
6465 return (indexAndLength, sel)
6566 where
66− toStyleAttr m = "style" =: Map.foldWithKey (\k v s -> k <> ":" <> v <> ";" <> s) "" m
67+ toStyleAttr m = "style" =: Map.foldrWithKey (\k v s -> k <> ":" <> v <> ";" <> s) "" m
6768 toViewport h = toStyleAttr $ "overflow" =: "auto" <> "position" =: "absolute" <>
6869 "left" =: "0" <> "right" =: "0" <> "height" =: (T.pack (show h) <> "px")
6970 toContainer h = toStyleAttr $ "position" =: "relative" <> "height" =: (T.pack (show h) <> "px")
@@ -104,9 +105,10 @@ virtualList heightPx rowPx maxIndex i0 setI keyToIndex items0 itemsUpdate itemBu
104105 let window = zipDynWith (findWindow rowPx) heightPx scrollPosition
105106 performEvent_ $ ffor (leftmost [setI, i0 <$ pb]) $ \i ->
106107 setScrollTop (_element_raw viewport) (i * rowPx)
107− return (uniqDyn window, result)
108+ uniqWindow <- holdUniqDyn window
109+ return (uniqWindow, result)
108110 where
109− toStyleAttr m = "style" =: Map.foldWithKey (\k v s -> k <> ":" <> v <> ";" <> s) "" m
111+ toStyleAttr m = "style" =: Map.foldrWithKey (\k v s -> k <> ":" <> v <> ";" <> s) "" m
110112 mkViewport h = toStyleAttr $ "overflow" =: "auto" <> "position" =: "absolute" <>
111113 "left" =: "0" <> "right" =: "0" <> "height" =: (T.pack (show h) <> "px")
112114 mkContainer h = toStyleAttr $ "position" =: "relative" <> "height" =: (T.pack (show h) <> "px")
@@ -115,7 +117,7 @@ virtualList heightPx rowPx maxIndex i0 setI keyToIndex items0 itemsUpdate itemBu
115117 "overflow" =: "hidden" <>
116118 "position" =: "relative"
117119 mkRow k = toStyleAttr $ "height" =: (T.pack (show rowPx) <> "px") <>
118− "top" =: ((<>"px") $ T.pack $ show $ keyToIndex k * rowPx) <>
120+ "top" =: (<> "px") (T.pack $ show $ keyToIndex k * rowPx) <>
119121 "position" =: "absolute" <>
120122 "width" =: "100%"
121123 findWindow sizeIncrement windowSize startingPosition =
@@ -140,7 +142,7 @@ virtualListBuffered buffer heightPx rowPx maxIndex i0 setI keyToIndex items0 ite
140142 (win, m) <- virtualList heightPx rowPx maxIndex i0 setI keyToIndex items0 itemsUpdate itemBuilder
141143 pb <- getPostBuild
142144 let extendWin o l = (max 0 (o - l * (buffer-1) `div` 2), l * buffer)
143− rec let winHitEdge = fmapMaybe id $ attachWith (\(oldOffset, oldLimit) (winOffset, winLimit) ->
145+ rec let winHitEdge = attachWithMaybe (\(oldOffset, oldLimit) (winOffset, winLimit) ->
144146 if winOffset > oldOffset && winOffset + winLimit < oldOffset + oldLimit
145147 then Nothing
146148 else Just (extendWin winOffset winLimit)) (current winBuffered) (updated win)
reflex-dom-core/src/Reflex/Dom/Widget/Resize.hs+10−6
@@ -7,10 +7,10 @@
77module Reflex.Dom.Widget.Resize where
88
99import Reflex.Class
10+import Reflex.Time
1011import Reflex.Dom.Builder.Class
1112import Reflex.Dom.Builder.Immediate
1213import Reflex.Dom.Class
13−import Reflex.Dom.Time
1414import Reflex.Dom.Widget.Basic
1515import Reflex.PerformEvent.Class
1616import Reflex.PostBuild.Class
@@ -32,20 +32,24 @@ import GHCJS.DOM.HTMLElement (getOffsetWidth, getOffsetHeight)
3232import qualified GHCJS.DOM.Types as DOM
3333
3434-- | A widget that wraps the given widget in a div and fires an event when resized.
35−-- Adapted from github.com/marcj/css-element-queries
36−resizeDetector :: (MonadJSM m, DomBuilder t m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, DomBuilderSpace m ~ GhcjsDomSpace, MonadJSM (Performable m), MonadFix m) => m a -> m (Event t (), a)
35+-- Adapted from @github.com\/marcj\/css-element-queries@
36+--
37+-- This function can cause strange scrollbars to appear in some circumstances.
38+-- These can be hidden with pseudo selectors, for example, in webkit browsers:
39+-- .wrapper *::-webkit-scrollbar { width: 0px; background: transparent; }
40+resizeDetector :: (MonadJSM m, DomBuilder t m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, DomBuilderSpace m ~ GhcjsDomSpace, MonadJSM (Performable m), MonadFix m) => m a -> m (Event t (Maybe Double, Maybe Double), a)
3741resizeDetector = resizeDetectorWithStyle ""
3842
3943resizeDetectorWithStyle :: (MonadJSM m, DomBuilder t m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, DomBuilderSpace m ~ GhcjsDomSpace, MonadJSM (Performable m), MonadFix m)
4044 => Text -- ^ A css style string. Warning: It should not contain the "position" style attribute.
4145 -> m a -- ^ The embedded widget
42− -> m (Event t (), a) -- ^ An 'Event' that fires on resize, and the result of the embedded widget
46+ -> m (Event t (Maybe Double, Maybe Double), a) -- ^ An 'Event' that fires on resize, and the result of the embedded widget
4347resizeDetectorWithStyle styleString = resizeDetectorWithAttrs ("style" =: styleString)
4448
4549resizeDetectorWithAttrs :: (MonadJSM m, DomBuilder t m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, DomBuilderSpace m ~ GhcjsDomSpace, MonadJSM (Performable m), MonadFix m)
4650 => Map Text Text -- ^ A map of attributes. Warning: It should not modify the "position" style attribute.
4751 -> m a -- ^ The embedded widget
48− -> m (Event t (), a) -- ^ An 'Event' that fires on resize, and the result of the embedded widget
52+ -> m (Event t (Maybe Double, Maybe Double), a) -- ^ An 'Event' that fires on resize, and the result of the embedded widget
4953resizeDetectorWithAttrs attrs w = do
5054 let childStyle = "position: absolute; left: 0; top: 0;"
5155 containerAttrs = "style" =: "position: absolute; left: 0; top: 0; right: 0; bottom: 0; overflow: scroll; z-index: -1; visibility: hidden;"
@@ -87,4 +91,4 @@ resizeDetectorWithAttrs attrs w = do
8791 size0 <- performEvent $ fmap (const $ liftJSM reset) pb
8892 rec resize <- performEventAsync $ fmap (\d cb -> (liftIO . cb) =<< liftJSM (resetIfChanged d)) $ tag (current dimensions) $ leftmost [expandScroll, shrinkScroll]
8993 dimensions <- holdDyn (Nothing, Nothing) $ leftmost [ size0, fmapMaybe id resize ]
90− return (fmapMaybe void resize, w')
94+ return (updated dimensions, w')
reflex-dom-core/src/Reflex/Dom/Xhr.hs+10−8
@@ -159,6 +159,8 @@ import Data.Aeson.Text
159159import Data.Aeson.Encode
160160#endif
161161import qualified Data.ByteString.Lazy as BL
162+import Data.CaseInsensitive (CI)
163+import qualified Data.CaseInsensitive as CI
162164import Data.Default
163165import qualified Data.List as L
164166import Data.Map (Map)
@@ -198,12 +200,12 @@ data XhrResponse
198200 , _xhrResponse_statusText :: Text
199201 , _xhrResponse_response :: Maybe XhrResponseBody
200202 , _xhrResponse_responseText :: Maybe Text
201− , _xhrResponse_headers :: Map Text Text
203+ , _xhrResponse_headers :: Map (CI Text) Text
202204 }
203205 deriving (Typeable)
204206
205207data XhrResponseHeaders =
206− OnlyHeaders (Set.Set Text) -- ^ Parse a subset of headers from the XHR Response
208+ OnlyHeaders (Set.Set (CI Text)) -- ^ Parse a subset of headers from the XHR Response
207209 | AllHeaders -- ^ Parse all headers from the XHR Response
208210 deriving (Show, Read, Eq, Ord, Typeable)
209211
@@ -215,7 +217,7 @@ _xhrResponse_body :: XhrResponse -> Maybe Text
215217_xhrResponse_body = _xhrResponse_responseText
216218
217219{-# DEPRECATED xhrResponse_body "Use xhrResponse_response or xhrResponse_responseText instead." #-}
218−xhrResponse_body :: Lens XhrResponse XhrResponse (Maybe Text) (Maybe Text)
220+xhrResponse_body :: Lens' XhrResponse (Maybe Text)
219221xhrResponse_body = lens _xhrResponse_responseText (\r t -> r { _xhrResponse_responseText = t })
220222
221223instance a ~ () => Default (XhrRequestConfig a) where
@@ -275,7 +277,7 @@ newXMLHttpRequestWithError req cb = do
275277 AllHeaders -> parseAllHeadersString <$>
276278 xmlHttpRequestGetAllResponseHeaders xhr
277279 OnlyHeaders xs -> traverse (xmlHttpRequestGetResponseHeader xhr)
278− (Map.fromSet id xs)
280+ (Map.fromSet CI.original xs)
279281 _ <- liftJSM $ cb $ Right
280282 XhrResponse { _xhrResponse_status = status
281283 , _xhrResponse_statusText = statusText
@@ -288,10 +290,10 @@ newXMLHttpRequestWithError req cb = do
288290 return ()
289291 return xhr
290292
291−parseAllHeadersString :: Text -> Map Text Text
293+parseAllHeadersString :: Text -> Map (CI Text) Text
292294parseAllHeadersString s = Map.fromList $ fmap (stripBoth . T.span (/=':')) $
293295 L.dropWhileEnd T.null $ T.splitOn (T.pack "\r\n") s
294− where stripBoth (txt1, txt2) = (T.strip txt1, T.strip $ T.drop 1 txt2)
296+ where stripBoth (txt1, txt2) = (CI.mk $ T.strip txt1, T.strip $ T.drop 1 txt2)
295297
296298newXMLHttpRequest :: (HasJSContext m, MonadJSM m, IsXhrPayload a) => XhrRequest a -> (XhrResponse -> JSM ()) -> m XMLHttpRequest
297299newXMLHttpRequest req cb = newXMLHttpRequestWithError req $ mapM_ cb
@@ -378,7 +380,7 @@ decodeText = decode . BL.fromStrict . encodeUtf8
378380
379381-- | Convenience function to decode JSON-encoded responses.
380382decodeXhrResponse :: FromJSON a => XhrResponse -> Maybe a
381−decodeXhrResponse = join . fmap decodeText . _xhrResponse_responseText
383+decodeXhrResponse = decodeText <=< _xhrResponse_responseText
382384
383385#ifdef USE_TEMPLATE_HASKELL
384386concat <$> mapM makeLenses
@@ -444,7 +446,7 @@ xhrResponse_responseText :: Lens' XhrResponse (Maybe Text)
444446xhrResponse_responseText f (XhrResponse x1 x2 x3 x4 x5) = (\y -> XhrResponse x1 x2 x3 y x5) <$> f x4
445447{-# INLINE xhrResponse_responseText #-}
446448
447−xhrResponse_headers :: Lens' XhrResponse (Map Text Text)
449+xhrResponse_headers :: Lens' XhrResponse (Map (CI Text) Text)
448450xhrResponse_headers f (XhrResponse x1 x2 x3 x4 x5) = (\y -> XhrResponse x1 x2 x3 x4 y) <$> f x5
449451{-# INLINE xhrResponse_headers #-}
450452
reflex-dom-core/src/Reflex/Dom/Xhr/Foreign.hs+2−3
@@ -1,7 +1,6 @@
11{-# LANGUAGE FlexibleInstances #-}
22{-# LANGUAGE JavaScriptFFI #-}
33{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE TypeSynonymInstances #-}
54
65module Reflex.Dom.Xhr.Foreign (
76 XMLHttpRequest
@@ -16,7 +15,7 @@ import Data.Text (Text)
1615import Data.ByteString (ByteString)
1716import Foreign.JavaScript.Utils (bsFromMutableArrayBuffer, bsToArrayBuffer)
1817import GHCJS.DOM.Enums
19−import GHCJS.DOM.EventM (EventM, on)
18+import GHCJS.DOM.EventM (EventM, on, onSync)
2019import GHCJS.DOM.EventTarget (dispatchEvent)
2120import GHCJS.DOM.Types (MonadJSM, ToJSString, FormData, Document, Blob (..), ArrayBuffer (..), JSVal, JSM, IsEvent, XMLHttpRequestProgressEvent, ProgressEvent, Event, XMLHttpRequestUpload, FromJSString, ArrayBufferView (..), liftJSM, castTo)
2221import GHCJS.DOM.XMLHttpRequest
@@ -115,7 +114,7 @@ xmlHttpRequestOntimeout :: XMLHttpRequest -> EventM XMLHttpRequest ProgressEvent
115114xmlHttpRequestOntimeout = (`on` timeout)
116115
117116xmlHttpRequestOnreadystatechange :: XMLHttpRequest -> EventM XMLHttpRequest Event () -> JSM (JSM ())
118−xmlHttpRequestOnreadystatechange = (`on` readyStateChange)
117+xmlHttpRequestOnreadystatechange = (`onSync` readyStateChange)
119118
120119xmlHttpRequestSetTimeout :: MonadJSM m => XMLHttpRequest -> Word -> m ()
121120xmlHttpRequestSetTimeout = setTimeout
reflex-dom-core/src/Reflex/Dom/Xhr/FormData.hsnew file+47
@@ -0,0 +1,47 @@
1+{-# LANGUAGE FlexibleContexts #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+module Reflex.Dom.Xhr.FormData
4+ ( postForms
5+ , FormValue (..)
6+ , fileToFormValue
7+ )
8+ where
9+
10+import Control.Lens
11+import Data.Default
12+import Data.Map (Map)
13+import Data.Text (Text)
14+import Data.Traversable
15+import qualified GHCJS.DOM.FormData as FD
16+import Foreign.JavaScript.TH
17+import GHCJS.DOM.File (getName)
18+import GHCJS.DOM.Types (File, IsBlob)
19+import Language.Javascript.JSaddle.Monad (MonadJSM, liftJSM)
20+import Reflex
21+import Reflex.Dom.Xhr
22+
23+-- | A FormData value may be a blob/file or a string. The file can optionally be provided with filename.
24+data FormValue blob = FormValue_Text Text
25+ | FormValue_File blob (Maybe Text) -- maybe filename
26+
27+-- | Performs a POST request with the provided FormData payload
28+postForms
29+ :: ( IsBlob blob, HasJSContext (Performable m), MonadJSM (Performable m)
30+ , PerformEvent t m, TriggerEvent t m
31+ , Traversable f)
32+ => Text -- ^ The target url
33+ -> Event t (f (Map Text (FormValue blob))) -- ^ Maps of text keys and values that will be sent as "FormData"
34+ -> m (Event t (f XhrResponse))
35+postForms url payload = do
36+ performMkRequestsAsync $ ffor payload $ \fs -> for fs $ \u -> liftJSM $ do
37+ fd <- FD.newFormData Nothing
38+ iforM_ u $ \k v -> case v of
39+ FormValue_Text t -> FD.append fd k t
40+ FormValue_File b fn -> FD.appendBlob fd k b fn
41+ return $ xhrRequest "POST" url $ def & xhrRequestConfig_sendData .~ fd
42+
43+-- | Converts a File (e.g., the output of a 'FileInput') into a 'FormValue'. The filename will be included if it is available.
44+fileToFormValue :: MonadJSM m => File -> m (FormValue File)
45+fileToFormValue f = do
46+ fn <- getName f
47+ return $ FormValue_File f $ Just fn
reflex-dom-core/test/gc.hs+51−13
@@ -1,33 +1,66 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE CPP #-}
13{-# LANGUAGE OverloadedStrings #-}
24{-# LANGUAGE RecursiveDo #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
36import Control.Concurrent
7+import Control.Exception
48import Control.Monad
59import Control.Monad.IO.Class
610import Data.Int
7−import GHC.Stats
11+import Data.Text as T
812import Language.Javascript.JSaddle.Warp
913import Reflex.Dom.Core
14+import Reflex.Time
1015import System.Exit
11−import System.IO.Temp
1216import System.Mem
1317import System.Process
1418
19+import Test.Util.ChromeFlags
20+import Test.Util.UnshareNetwork
21+
22+#if MIN_VERSION_base(4,11,0)
23+import GHC.Stats (getRTSStatsEnabled, getRTSStats, RTSStats(..), gcdetails_live_bytes, gc)
24+currentBytesUsed :: RTSStats -> Int64
25+currentBytesUsed = fromIntegral . gcdetails_live_bytes . gc
26+#else
27+import GHC.Stats (getGCStats, GCStats(..))
28+getRTSStats = getGCStats
29+#endif
30+
1531-- In initial testing, the minimum live bytes count was 233128 and maximum was
1632-- 363712. Going over the maximum means the test has actually failed - we
1733-- probably have a memory leak; going under the minimum doesn't indicate a
1834-- memory leak, but may mean the test needs to be updated.
19−minBytesAllowed, maxBytesAllowed :: Int64
20−(minBytesAllowed, maxBytesAllowed) = (200000, 400000)
35+minBytesAllowed, resetThreshold, maxBytesAllowed :: Int64
36+(minBytesAllowed, resetThreshold, maxBytesAllowed) = (200000, 400000, 600000)
37+
38+-- Some times the memory usage might flair up and then then return to normal
39+-- this probably indicates an issue, but if you are trying to fix a slow consistent
40+-- leak it can confuse the results by making the tests fail when the slow leak is
41+-- fixed.
42+-- Set this limit to say how many failures (currentBytesUsed > maxBytesAllowed)
43+-- want to ignore. If the memory usage goes back under resetThreshold
44+-- the failure count is reset to 0.
45+failureLimit :: Int
46+failureLimit = 0
2147
2248main :: IO ()
2349main = do
24− mainThread <- myThreadId
25− withSystemTempDirectory "reflex-dom-core_test_gc" $ \tmp -> do
26− browserProcess <- spawnCommand $ "xvfb-run -a chromium --user-data-dir=" ++ tmp ++ " http://localhost:3911"
50+ handle (\(_ :: IOError) -> return ()) $ unshareNetwork -- If we run into an exception with sandboxing, just don't bother
51+ withSandboxedChromeFlags True $ \chromeFlags -> do
52+ mainThread <- myThreadId
53+ browserProcess <- spawnCommand $ mconcat
54+ [ "echo 'Starting Chromium' ; chromium "
55+ , unpack $ T.unwords chromeFlags
56+ , " http://localhost:3911 ; echo 'Chromium exited'"
57+ ]
2758 let finishTest result = do
2859 interruptProcessGroupOf browserProcess
2960 throwTo mainThread result
61+ putStrLn "About to start the server"
3062 run 3911 $ do
63+ -- enableLogging True
3164 liftIO $ putStrLn "Running..."
3265 mainWidget $ do
3366 let w = do
@@ -36,23 +69,28 @@ main = do
3669 d <- holdDyn mempty $ mempty <$ domEvent Click e
3770 return ()
3871 postBuild <- getPostBuild
39− let f n = liftIO $ if n < 3000
72+ let f (!failures, !n) = liftIO $ if n < 3000
4073 then do performMajorGC
41− threadDelay 1000 -- Wait a bit to allow requestAnimationFrame to call its callback sometimes; this value was experimentally determined
42− gcStats <- getGCStats
74+ threadDelay 5000 -- Wait a bit to allow requestAnimationFrame to call its callback sometimes; this value was experimentally determined
75+ gcStats <- getRTSStats
4376 print $ currentBytesUsed gcStats
4477 when (currentBytesUsed gcStats < minBytesAllowed) $ do
4578 putStrLn "FAILED: currentBytesUsed < minBytesAllowed"
4679 finishTest $ ExitFailure 2
47− when (currentBytesUsed gcStats > maxBytesAllowed) $ do
80+ let overMax = currentBytesUsed gcStats > maxBytesAllowed
81+ underReset = currentBytesUsed gcStats < resetThreshold
82+ when (overMax && failures >= failureLimit) $ do
4883 putStrLn "FAILED: currentBytesUsed > maxBytesAllowed"
4984 finishTest $ ExitFailure 1
50− return $ Just $ succ n
85+ return $ Just (
86+ if overMax
87+ then succ failures
88+ else (if underReset then 0 else failures), succ n)
5189 else do putStrLn "SUCCEEDED"
5290 finishTest ExitSuccess
5391 return Nothing
5492 rec redraw <- performEvent <=< delay 0 $ f <$> leftmost
55− [ (0 :: Int) <$ postBuild
93+ [ (0 :: Int, 0 :: Int) <$ postBuild
5694 , fmapMaybe id redraw
5795 ]
5896 _ <- widgetHold w $ w <$ redraw
reflex-dom-core/test/hlint.hs+5−1
@@ -1,4 +1,4 @@
1−import Language.Haskell.HLint3 (hlint)
1+import Language.Haskell.HLint (hlint)
22import System.Exit (exitFailure, exitSuccess)
33
44main :: IO ()
@@ -16,7 +16,11 @@ main = do
1616 , "--ignore=Use unless"
1717 , "--ignore=Use if"
1818 , "--ignore=Use fewer imports"
19+ , "--ignore=Use list comprehension"
20+ , "--ignore=Unnecessary hiding" -- Interferes with cross-version compatibility
21+ , "--ignore=Use <$>"
1922 , "--ignore=Reduce duplication" --TODO: Re-enable this test
23+ , "--ignore=Use list comprehension"
2024 , "--cpp-define=USE_TEMPLATE_HASKELL"
2125 ]
2226 if null ideas then exitSuccess else exitFailure
reflex-dom-core/test/hydration.hsnew file+1828
@@ -0,0 +1,1828 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE LambdaCase #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
9+{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE PolyKinds #-}
11+{-# LANGUAGE RankNTypes #-}
12+{-# LANGUAGE RecursiveDo #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
15+{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TupleSections #-}
17+{-# LANGUAGE TypeApplications #-}
18+{-# 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.
30+
31+import Prelude hiding (fail)
32+import Control.Concurrent
33+import qualified Control.Concurrent.Async as Async
34+import Control.Lens.Operators
35+import Control.Monad hiding (fail)
36+import Control.Monad.Catch
37+import Control.Monad.Fail
38+import Control.Monad.Fix
39+import Control.Monad.IO.Class
40+import Control.Monad.Ref
41+import Data.Constraint.Extras
42+import Data.Constraint.Extras.TH
43+import Data.Dependent.Map (DMap)
44+import Data.Dependent.Sum (DSum(..), (==>))
45+import Data.Functor.Identity
46+import Data.Functor.Misc
47+import Data.GADT.Compare.TH
48+import Data.GADT.Show.TH
49+import Data.IORef (IORef)
50+import Data.List (sort)
51+import Data.Maybe
52+import Data.Proxy
53+import Data.Text (Text)
54+import Language.Javascript.JSaddle (syncPoint, liftJSM)
55+import Language.Javascript.JSaddle.Warp
56+import Network.HTTP.Types (status200)
57+import Network.Socket
58+import Network.Wai
59+import Network.WebSockets
60+import Reflex.Dom.Core
61+import Reflex.Dom.Widget.Input (dropdown)
62+import Reflex.Patch.DMapWithMove
63+import System.Directory
64+import System.Environment
65+import System.IO (stderr)
66+import System.IO.Silently
67+import System.IO.Temp
68+import System.Process
69+import System.Which (staticWhich)
70+import qualified Test.HUnit as HUnit
71+import qualified Test.Hspec as H
72+import qualified Test.Hspec.Core.Spec as H
73+import Test.Hspec (xit)
74+import Test.Hspec.WebDriver hiding (runWD, click, uploadFile, WD)
75+import qualified Test.Hspec.WebDriver as WD
76+import Test.WebDriver (WD(..))
77+
78+import qualified Data.ByteString.Lazy as LBS
79+import qualified Data.Dependent.Map as DMap
80+import qualified Data.IntMap as IntMap
81+import qualified Data.Text as T
82+import qualified Data.Text.Encoding as TE
83+import qualified GHCJS.DOM.File as File
84+import qualified Network.Wai.Handler.Warp as Warp
85+import qualified System.FilePath as FilePath
86+import qualified Test.WebDriver as WD
87+import qualified Test.WebDriver.Capabilities as WD
88+
89+import Test.Util.ChromeFlags
90+import Test.Util.UnshareNetwork
91+
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+
98+seleniumPort, jsaddlePort :: PortNumber
99+seleniumPort = 8000
100+jsaddlePort = 8001
101+
102+-- TODO Remove orphan
103+instance MonadRef WD where
104+ type Ref WD = Ref IO
105+ newRef = WD . newRef
106+ readRef = WD . readRef
107+ writeRef r = WD . writeRef r
108+
109+assertEqual :: (MonadIO m, Eq a, Show a) => String -> a -> a -> m ()
110+assertEqual msg a b = liftIO $ HUnit.assertEqual msg a b
111+
112+assertFailure :: MonadIO m => String -> m ()
113+assertFailure = liftIO . HUnit.assertFailure
114+
115+assertBool :: (MonadIO m) => String -> Bool -> m ()
116+assertBool msg bool = liftIO $ HUnit.assertBool msg bool
117+
118+chromeConfig :: Text -> [Text] -> WD.WDConfig
119+chromeConfig fp flags = WD.useBrowser (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags }) WD.defaultConfig
120+
121+keyMap :: DMap DKey Identity
122+keyMap = DMap.fromList
123+ [ Key_Int ==> 0
124+ , Key_Char ==> 'A'
125+ ]
126+
127+data DKey a where
128+ Key_Int :: DKey Int
129+ Key_Char :: DKey Char
130+ Key_Bool :: DKey Bool
131+
132+
133+textKey :: DKey a -> Text
134+textKey = \case
135+ Key_Int -> "Key_Int"
136+ Key_Char -> "Key_Char"
137+ Key_Bool -> "Key_Bool"
138+
139+deriveArgDict ''DKey
140+deriveGEq ''DKey
141+deriveGCompare ''DKey
142+deriveGShow ''DKey
143+
144+deriving instance MonadFail WD
145+
146+main :: IO ()
147+main = do
148+ unshareNetwork
149+ isHeadless <- (== Nothing) <$> lookupEnv "NO_HEADLESS"
150+ withSandboxedChromeFlags isHeadless $ \chromeFlags -> do
151+ withSeleniumServer $ \selenium -> do
152+ let browserPath = T.strip $ T.pack chromium
153+ when (T.null browserPath) $ fail "No browser found"
154+ withDebugging <- isNothing <$> lookupEnv "NO_DEBUG"
155+ let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _selenium_portNumber selenium }
156+ chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
157+ hspec (tests withDebugging wdConfig [(chromeCaps', "chrome")] selenium) `finally` _selenium_stopServer selenium
158+
159+tests :: Bool -> WD.WDConfig -> [(Capabilities, String)] -> Selenium -> Spec
160+tests withDebugging wdConfig caps _selenium = do
161+ let putStrLnDebug :: MonadIO m => Text -> m ()
162+ putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
163+ session' t = sessionWith wdConfig t . using caps
164+ runWD m = runWDOptions (WdOptions False) $ do
165+ putStrLnDebug "before"
166+ r <- m
167+ putStrLnDebug "after"
168+ return r
169+ testWidgetStatic :: WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
170+ testWidgetStatic = testWidgetStaticDebug withDebugging
171+ testWidget :: WD () -> WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
172+ testWidget = testWidgetDebug True withDebugging
173+ 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
176+ it "works" $ runWD $ do
177+ testWidgetStatic (checkBodyText "hello world") $ do
178+ text "hello world"
179+ it "works with postBuild" $ runWD $ do
180+ testWidgetStatic (checkBodyText "pb") $ do
181+ pb <- getPostBuild
182+ void $ textNode $ TextNodeConfig "" $ Just $ "pb" <$ pb
183+ it "works for adjacent text nodes" $ runWD $ do
184+ testWidgetStatic (checkBodyText "hello world") $ do
185+ text "hello "
186+ text "world"
187+ it "works for empty adjacent text nodes" $ runWD $ do
188+ testWidgetStatic (checkBodyText "hello world") $ do
189+ pb <- getPostBuild
190+ text ""
191+ text ""
192+ _ <- textNode $ TextNodeConfig "" $ Just $ "hello " <$ pb
193+ _ <- textNode $ TextNodeConfig "abc" $ Just $ "" <$ pb
194+ _ <- textNode $ TextNodeConfig "" $ Just $ "world" <$ pb
195+ text ""
196+ it "works when empty text nodes are the only children of an element" $ runWD $ do
197+ testWidgetStatic (checkBodyText "hello world") $ do
198+ el "div" $ do
199+ text ""
200+ text ""
201+ text "hello world"
202+ it "works when an empty text node is the first child before text" $ runWD $ do
203+ testWidgetStatic (checkTextInTag "div" "hello world") $ do
204+ el "div" $ do
205+ text ""
206+ text "hello world"
207+ it "works when an empty text node is the first child before element" $ runWD $ do
208+ testWidgetStatic (checkTextInTag "div" "hello world") $ do
209+ el "div" $ do
210+ text ""
211+ el "span" $ text "hello world"
212+ it "works when an empty text node is the last child" $ runWD $ do
213+ testWidgetStatic (checkTextInTag "div" "hello world") $ do
214+ el "div" $ do
215+ el "span" $ text "hello world"
216+ text ""
217+-- TODO I think these two tests are broken
218+-- it "updates after postBuild" $ runWD $ do
219+-- testWidget (checkBodyText "initial") (checkBodyText "after") $ do
220+-- after <- delay 0 =<< getPostBuild
221+-- void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ after
222+-- it "updates immediately after postBuild" $ runWD $ do
223+-- testWidget (checkBodyText "pb") (checkBodyText "after") $ do
224+-- pb <- getPostBuild
225+-- after <- delay 0 pb
226+-- void $ textNode $ TextNodeConfig "initial" $ Just $ leftmost ["pb" <$ pb, "after" <$ after]
227+ it "updates in immediate mode" $ runWD $ do
228+ let checkUpdated = do
229+ checkBodyText "initial"
230+ WD.click =<< findElemWithRetry (WD.ByTag "button")
231+ checkBodyText "after"
232+ testWidget (pure ()) checkUpdated $ prerender_ (pure ()) $ do
233+ click <- button ""
234+ void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
235+
236+ session' "element" $ do
237+ it "works with domEvent Click" $ runWD $ do
238+ clickedRef <- liftIO $ newRef False
239+ testWidget' (findElemWithRetry $ WD.ByTag "div") WD.click $ do
240+ (e, _) <- el' "div" $ text "hello world"
241+ performEvent_ $ liftIO (writeRef clickedRef True) <$ domEvent Click e
242+ readRef clickedRef `shouldBeWithRetryM` True
243+ it "works with eventFlags stopPropagation" $ runWD $ do
244+ firstClickedRef <- newRef False
245+ secondClickedRef <- newRef False
246+ let clickBoth = do
247+ findElemWithRetry (WD.ById "first") >>= WD.click
248+ findElemWithRetry (WD.ById "second") >>= WD.click
249+ testWidget (pure ()) clickBoth $ do
250+ (firstDivEl, _) <- el' "div" $ prerender_ (pure ()) $ do
251+ void $ elAttr "span" ("id" =: "first") $ text "hello world"
252+ performEvent_ $ liftIO (writeRef firstClickedRef True) <$ domEvent Click firstDivEl
253+ (secondDivEl, _) <- el' "div" $ prerender_ (pure ()) $ do
254+ let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
255+ conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
256+ & initialAttributes .~ "id" =: "second"
257+ & elementConfig_eventSpec .~ addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> stopPropagation) def
258+ void $ element "span" conf $ text "hello world"
259+ performEvent_ $ liftIO (writeRef secondClickedRef True) <$ domEvent Click secondDivEl
260+ firstClicked <- readRef firstClickedRef
261+ secondClicked <- readRef secondClickedRef
262+ assertEqual "Click propagated when it should have stopped" (True, False) (firstClicked, secondClicked)
263+ it "works with eventFlags preventDefault" $ runWD $ do
264+ let click = do
265+ e <- findElemWithRetry $ WD.ByTag "input"
266+ s0 <- WD.isSelected e
267+ WD.click e
268+ s1 <- WD.isSelected e
269+ pure (s0, s1)
270+ clicked <- testWidget (pure ()) click $ prerender_ (pure ()) $ do
271+ let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
272+ conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
273+ & elementConfig_eventSpec .~ addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> preventDefault) def
274+ & initialAttributes .~ "type" =: "checkbox"
275+ void $ element "input" conf $ text "hello world"
276+ assertEqual "Click not prevented" (False, False) clicked
277+ it "can add/update/remove attributes" $ runWD $ do
278+ let checkInitialAttrs = do
279+ e <- findElemWithRetry $ WD.ByTag "div"
280+ assertAttr e "const" (Just "const")
281+ assertAttr e "delete" (Just "delete")
282+ assertAttr e "init" (Just "init")
283+ assertAttr e "click" Nothing
284+ pure e
285+ checkModifyAttrs e = do
286+ WD.click e
287+ withRetry $ do
288+ assertAttr e "const" (Just "const")
289+ assertAttr e "delete" Nothing
290+ assertAttr e "init" (Just "click")
291+ assertAttr e "click" (Just "click")
292+ testWidget' checkInitialAttrs checkModifyAttrs $ mdo
293+ let conf = def
294+ & initialAttributes .~ "const" =: "const" <> "delete" =: "delete" <> "init" =: "init"
295+ & modifyAttributes .~ (("delete" =: Nothing <> "init" =: Just "click" <> "click" =: Just "click") <$ click)
296+ (e, ()) <- element "div" conf $ text "hello world"
297+ let click = domEvent Click e
298+ return ()
299+
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
359+ it "doesn't wipe user input when switching over" $ runWD $ do
360+ inputRef <- newRef ("hello " :: Text)
361+ testWidget'
362+ (do
363+ e <- findElemWithRetry $ WD.ByTag "input"
364+ WD.sendKeys "world" e
365+ pure e)
366+ (\e -> do
367+ WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
368+ WD.click =<< findElemWithRetry (WD.ByTag "button")
369+ readRef inputRef `shouldBeWithRetryM` "hello world"
370+ ) $ do
371+ e <- inputElement $ def & inputElementConfig_initialValue .~ "hello "
372+ click <- button "save"
373+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
374+ it "captures user input after switchover" $ runWD $ do
375+ inputRef <- newRef ("" :: Text)
376+ let checkValue = do
377+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
378+ WD.click =<< findElemWithRetry (WD.ByTag "button")
379+ readRef inputRef `shouldBeWithRetryM` "hello world"
380+ testWidget (pure ()) checkValue $ do
381+ e <- inputElement def
382+ click <- button "save"
383+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
384+ it "sets focus appropriately" $ runWD $ do
385+ focusRef <- newRef False
386+ let checkValue = do
387+ readRef focusRef `shouldBeWithRetryM` False
388+ e <- findElemWithRetry $ WD.ByTag "input"
389+ WD.click e
390+ readRef focusRef `shouldBeWithRetryM` True
391+ testWidget (pure ()) checkValue $ do
392+ e <- inputElement def
393+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
394+ it "sets focus when focus occurs before hydration" $ runWD $ do
395+ focusRef <- newRef False
396+ let setup = do
397+ e <- findElemWithRetry $ WD.ByTag "input"
398+ WD.click e
399+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
400+ readRef focusRef `shouldBeWithRetryM` False
401+ check = readRef focusRef `shouldBeWithRetryM` True
402+ testWidget setup check $ do
403+ e <- inputElement def
404+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
405+ it "sets value appropriately" $ runWD $ do
406+ valueByUIRef <- newRef ("" :: Text)
407+ valueRef <- newRef ("" :: Text)
408+ setValueChan :: Chan Text <- liftIO newChan
409+ let checkValue = do
410+ readRef valueByUIRef `shouldBeWithRetryM` ""
411+ readRef valueRef `shouldBeWithRetryM` ""
412+ e <- findElemWithRetry $ WD.ByTag "input"
413+ WD.sendKeys "hello" e
414+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
415+ readRef valueRef `shouldBeWithRetryM` "hello"
416+ liftIO $ writeChan setValueChan "world"
417+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
418+ readRef valueRef `shouldBeWithRetryM` "world"
419+ testWidget (pure ()) checkValue $ do
420+ update <- triggerEventWithChan setValueChan
421+ e <- inputElement $ def & inputElementConfig_setValue .~ update
422+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _inputElement_input e
423+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
424+ it "sets checked appropriately" $ runWD $ do
425+ checkedByUIRef <- newRef False
426+ checkedRef <- newRef False
427+ 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
433+ readRef checkedByUIRef `shouldBeWithRetryM` False
434+ readRef checkedRef `shouldBeWithRetryM` False
435+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
436+ WD.moveToCenter e
437+ WD.click e
438+ readRef checkedByUIRef `shouldBeWithRetryM` True
439+ readRef checkedRef `shouldBeWithRetryM` True
440+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
441+ liftIO $ writeChan setCheckedChan False
442+ readRef checkedByUIRef `shouldBeWithRetryM` True
443+ readRef checkedRef `shouldBeWithRetryM` False
444+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
445+ testWidget' checkStatic checkValue $ do
446+ setChecked <- triggerEventWithChan setCheckedChan
447+ e <- inputElement $ def
448+ & initialAttributes .~ "type" =: "checkbox"
449+ & inputElementConfig_setChecked .~ setChecked
450+ performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
451+ 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)
471+ it "captures file uploads" $ runWD $ do
472+ filesRef :: IORef [Text] <- newRef []
473+ let uploadFile = do
474+ e <- findElemWithRetry $ WD.ByTag "input"
475+ path <- liftIO $ writeSystemTempFile "testFile" "file contents"
476+ WD.sendKeys (T.pack path) e
477+ WD.click =<< findElemWithRetry (WD.ByTag "button")
478+ liftIO $ removeFile path
479+ readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
480+ testWidget (pure ()) uploadFile $ do
481+ e <- inputElement $ def & initialAttributes .~ "type" =: "file"
482+ click <- button "save"
483+ prerender_ (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
484+ names <- liftJSM $ traverse File.getName fs
485+ 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
597+ it "captures user input after switchover" $ runWD $ do
598+ inputRef :: IORef Text <- newRef ""
599+ let checkValue = do
600+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
601+ WD.click =<< findElemWithRetry (WD.ByTag "button")
602+ readRef inputRef `shouldBeWithRetryM` "hello world"
603+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
604+ e <- inputElement def
605+ click <- button "save"
606+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
607+ it "sets focus appropriately" $ runWD $ do
608+ focusRef <- newRef False
609+ let checkValue = do
610+ readRef focusRef `shouldBeWithRetryM` False
611+ e <- findElemWithRetry $ WD.ByTag "input"
612+ WD.click e
613+ readRef focusRef `shouldBeWithRetryM` True
614+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
615+ e <- inputElement def
616+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
617+ it "sets value appropriately" $ runWD $ do
618+ valueByUIRef :: IORef Text <- newRef ""
619+ valueRef :: IORef Text <- newRef ""
620+ setValueChan :: Chan Text <- liftIO newChan
621+ let checkValue = do
622+ readRef valueByUIRef `shouldBeWithRetryM` ""
623+ readRef valueRef `shouldBeWithRetryM` ""
624+ e <- findElemWithRetry $ WD.ByTag "input"
625+ WD.sendKeys "hello" e
626+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
627+ readRef valueRef `shouldBeWithRetryM` "hello"
628+ liftIO $ writeChan setValueChan "world"
629+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
630+ readRef valueRef `shouldBeWithRetryM` "world"
631+ testWidget (pure ()) checkValue $ do
632+ update <- triggerEventWithChan setValueChan
633+ prerender_ (pure ()) $ do
634+ e <- inputElement $ def & inputElementConfig_setValue .~ update
635+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _inputElement_input e
636+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
637+ it "sets checked appropriately" $ runWD $ do
638+ checkedByUIRef <- newRef False
639+ checkedRef <- newRef False
640+ setCheckedChan <- liftIO newChan
641+ let checkValue = do
642+ readRef checkedByUIRef `shouldBeWithRetryM` False
643+ readRef checkedRef `shouldBeWithRetryM` False
644+ e <- findElemWithRetry $ WD.ByTag "input"
645+ WD.moveToCenter e
646+ WD.click e
647+ readRef checkedByUIRef `shouldBeWithRetryM` True
648+ readRef checkedRef `shouldBeWithRetryM` True
649+ liftIO $ writeChan setCheckedChan False
650+ readRef checkedByUIRef `shouldBeWithRetryM` True
651+ readRef checkedRef `shouldBeWithRetryM` False
652+ testWidget (pure ()) checkValue $ do
653+ setChecked <- triggerEventWithChan setCheckedChan
654+ prerender_ (pure ()) $ do
655+ e <- inputElement $ def
656+ & initialAttributes .~ "type" =: "checkbox"
657+ & inputElementConfig_setChecked .~ setChecked
658+ performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
659+ performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
660+ it "captures file uploads" $ runWD $ do
661+ filesRef :: IORef [Text] <- newRef []
662+ let uploadFile = do
663+ e <- findElemWithRetry $ WD.ByTag "input"
664+ path <- liftIO $ writeSystemTempFile "testFile" "file contents"
665+ WD.sendKeys (T.pack path) e
666+ WD.click =<< findElemWithRetry (WD.ByTag "button")
667+ liftIO $ removeFile path
668+ readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
669+ testWidget (pure ()) uploadFile $ prerender_ (pure ()) $ do
670+ e <- inputElement $ def & initialAttributes .~ "type" =: "file"
671+ click <- button "save"
672+ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
673+ names <- liftJSM $ traverse File.getName fs
674+ liftIO $ writeRef filesRef names
675+
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
701+ it "doesn't wipe user input when switching over" $ runWD $ do
702+ inputRef <- newRef ("" :: Text)
703+ testWidget'
704+ (do
705+ e <- findElemWithRetry $ WD.ByTag "textarea"
706+ WD.sendKeys "hello world" e
707+ pure e)
708+ (\e -> do
709+ WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
710+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
711+ readRef inputRef `shouldBeWithRetryM` "hello world"
712+ ) $ do
713+ e <- textAreaElement def
714+ click <- button "save"
715+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
716+ it "captures user input after switchover" $ runWD $ do
717+ inputRef <- newRef ("" :: Text)
718+ let checkValue = do
719+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "textarea")
720+ WD.click =<< findElemWithRetry (WD.ByTag "button")
721+ readRef inputRef `shouldBeWithRetryM` "hello world"
722+ testWidget (pure ()) checkValue $ do
723+ e <- textAreaElement def
724+ click <- button "save"
725+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
726+ it "sets focus appropriately" $ runWD $ do
727+ focusRef <- newRef False
728+ let checkValue = do
729+ readRef focusRef `shouldBeWithRetryM` False
730+ e <- findElemWithRetry $ WD.ByTag "textarea"
731+ WD.click e
732+ readRef focusRef `shouldBeWithRetryM` True
733+ testWidget (pure ()) checkValue $ do
734+ e <- textAreaElement def
735+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
736+ it "sets focus when focus occurs before hydration" $ runWD $ do
737+ focusRef <- newRef False
738+ let setup = do
739+ e <- findElemWithRetry $ WD.ByTag "textarea"
740+ WD.click e
741+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
742+ readRef focusRef `shouldBeWithRetryM` False
743+ check = readRef focusRef `shouldBeWithRetryM` True
744+ testWidget setup check $ do
745+ e <- textAreaElement def
746+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
747+ it "sets value appropriately" $ runWD $ do
748+ valueByUIRef <- newRef ("" :: Text)
749+ valueRef <- newRef ("" :: Text)
750+ setValueChan :: Chan Text <- liftIO newChan
751+ let checkValue = do
752+ readRef valueByUIRef `shouldBeWithRetryM` ""
753+ readRef valueRef `shouldBeWithRetryM` ""
754+ e <- findElemWithRetry $ WD.ByTag "textarea"
755+ WD.sendKeys "hello" e
756+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
757+ readRef valueRef `shouldBeWithRetryM` "hello"
758+ liftIO $ writeChan setValueChan "world"
759+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
760+ readRef valueRef `shouldBeWithRetryM` "world"
761+ testWidget (pure ()) checkValue $ do
762+ setValue' <- triggerEventWithChan setValueChan
763+ e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
764+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
765+ 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
848+
849+ describe "hydration/immediate" $ do
850+ it "captures user input after switchover" $ runWD $ do
851+ inputRef :: IORef Text <- newRef ""
852+ let checkValue = do
853+ WD.sendKeys "hello world" <=< findElemWithRetry $ WD.ByTag "textarea"
854+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
855+ readRef inputRef `shouldBeWithRetryM` "hello world"
856+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
857+ e <- textAreaElement def
858+ click <- button "save"
859+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
860+ it "sets focus appropriately" $ runWD $ do
861+ focusRef <- newRef False
862+ let checkValue = do
863+ readRef focusRef `shouldBeWithRetryM` False
864+ e <- findElemWithRetry $ WD.ByTag "textarea"
865+ WD.click e
866+ readRef focusRef `shouldBeWithRetryM` True
867+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
868+ e <- textAreaElement def
869+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
870+ it "sets value appropriately" $ runWD $ do
871+ valueByUIRef :: IORef Text <- newRef ""
872+ valueRef :: IORef Text <- newRef ""
873+ setValueChan :: Chan Text <- liftIO newChan
874+ let checkValue = do
875+ readRef valueByUIRef `shouldBeWithRetryM` ""
876+ readRef valueRef `shouldBeWithRetryM` ""
877+ e <- findElemWithRetry $ WD.ByTag "textarea"
878+ WD.sendKeys "hello" e
879+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
880+ readRef valueRef `shouldBeWithRetryM` "hello"
881+ liftIO $ writeChan setValueChan "world"
882+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
883+ readRef valueRef `shouldBeWithRetryM` "world"
884+ testWidget (pure ()) checkValue $ do
885+ setValue' <- triggerEventWithChan setValueChan
886+ prerender_ (pure ()) $ do
887+ e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
888+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
889+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
890+
891+ session' "selectElement" $ do
892+ let options :: DomBuilder t m => m ()
893+ options = do
894+ elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
895+ elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
896+ elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
897+ describe "hydration" $ do
898+ it "sets initial value correctly" $ runWD $ do
899+ inputRef <- newRef ("" :: Text)
900+ let setup = do
901+ e <- findElemWithRetry $ WD.ByTag "select"
902+ assertAttr e "value" (Just "three")
903+ WD.click =<< findElemWithRetry (WD.ById "two")
904+ pure e
905+ check e = do
906+ assertAttr e "value" (Just "two")
907+ readRef inputRef `shouldBeWithRetryM` "three"
908+ WD.click =<< findElemWithRetry (WD.ByTag "button")
909+ assertAttr e "value" (Just "two")
910+ readRef inputRef `shouldBeWithRetryM` "two"
911+ testWidget' setup check $ do
912+ (e, ()) <- selectElement (def { _selectElementConfig_initialValue = "three" }) options
913+ click <- button "save"
914+ liftIO . writeRef inputRef <=< sample $ current $ _selectElement_value e
915+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
916+ it "captures user input after switchover" $ runWD $ do
917+ inputRef <- newRef ("" :: Text)
918+ let checkValue = do
919+ e <- findElemWithRetry $ WD.ByTag "select"
920+ assertAttr e "value" (Just "one")
921+ WD.click =<< findElemWithRetry (WD.ById "two")
922+ assertAttr e "value" (Just "two")
923+ WD.click =<< findElemWithRetry (WD.ByTag "button")
924+ readRef inputRef `shouldBeWithRetryM` "two"
925+ testWidget (pure ()) checkValue $ do
926+ (e, ()) <- selectElement def options
927+ click <- button "save"
928+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
929+ it "sets focus appropriately" $ runWD $ do
930+ focusRef <- newRef False
931+ let checkValue = do
932+ readRef focusRef `shouldBeWithRetryM` False
933+ e <- findElemWithRetry $ WD.ByTag "select"
934+ WD.click e
935+ readRef focusRef `shouldBeWithRetryM` True
936+ testWidget (pure ()) checkValue $ do
937+ (e, ()) <- selectElement def options
938+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
939+ it "sets focus when focus occurs before hydration" $ runWD $ do
940+ focusRef <- newRef False
941+ let setup = do
942+ e <- findElemWithRetry $ WD.ByTag "select"
943+ WD.click e
944+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
945+ readRef focusRef `shouldBeWithRetryM` False
946+ check = readRef focusRef `shouldBeWithRetryM` True
947+ testWidget setup check $ do
948+ (e, ()) <- selectElement def options
949+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
950+ it "sets value appropriately" $ runWD $ do
951+ valueByUIRef <- newRef ("" :: Text)
952+ valueRef <- newRef ("" :: Text)
953+ setValueChan :: Chan Text <- liftIO newChan
954+ let checkValue = do
955+ e <- findElemWithRetry $ WD.ByTag "select"
956+ assertAttr e "value" (Just "one")
957+ readRef valueByUIRef `shouldBeWithRetryM` "one"
958+ readRef valueRef `shouldBeWithRetryM` "one"
959+ WD.click <=< findElemWithRetry $ WD.ById "two"
960+ readRef valueByUIRef `shouldBeWithRetryM` "two"
961+ readRef valueRef `shouldBeWithRetryM` "two"
962+ liftIO $ writeChan setValueChan "three"
963+ readRef valueByUIRef `shouldBeWithRetryM` "two"
964+ readRef valueRef `shouldBeWithRetryM` "three"
965+ testWidget (pure ()) checkValue $ do
966+ setValue' <- triggerEventWithChan setValueChan
967+ (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
968+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
969+ performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
970+
971+ describe "hydration/immediate" $ do
972+ it "captures user input after switchover" $ runWD $ do
973+ inputRef :: IORef Text <- newRef ""
974+ let checkValue = do
975+ WD.click <=< findElemWithRetry $ WD.ById "two"
976+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
977+ readRef inputRef `shouldBeWithRetryM` "two"
978+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
979+ (e, ()) <- selectElement def options
980+ click <- button "save"
981+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
982+ it "sets focus appropriately" $ runWD $ do
983+ focusRef <- newRef False
984+ let checkValue = do
985+ readRef focusRef `shouldBeWithRetryM` False
986+ e <- findElemWithRetry $ WD.ByTag "select"
987+ WD.click e
988+ readRef focusRef `shouldBeWithRetryM` True
989+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
990+ (e, ()) <- selectElement def options
991+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
992+ it "has correct initial value" $ runWD $ do
993+ valueRef :: IORef Text <- newRef ""
994+ let checkValue = readRef valueRef `shouldBeWithRetryM` "one"
995+ testWidget (pure ()) checkValue $ do
996+ prerender_ (pure ()) $ do
997+ (e, ()) <- selectElement def { _selectElementConfig_initialValue = "one" } options
998+ liftIO . writeRef valueRef <=< sample $ current $ _selectElement_value e
999+ it "sets value appropriately" $ runWD $ do
1000+ valueByUIRef :: IORef Text <- newRef ""
1001+ valueRef :: IORef Text <- newRef ""
1002+ setValueChan :: Chan Text <- liftIO newChan
1003+ let checkValue = do
1004+ WD.click =<< findElemWithRetry (WD.ById "two")
1005+ readRef valueByUIRef `shouldBeWithRetryM` "two"
1006+ readRef valueRef `shouldBeWithRetryM` "two"
1007+ liftIO $ writeChan setValueChan "three"
1008+ readRef valueByUIRef `shouldBeWithRetryM` "two"
1009+ readRef valueRef `shouldBeWithRetryM` "three"
1010+ testWidget (pure ()) checkValue $ do
1011+ setValue' <- triggerEventWithChan setValueChan
1012+ prerender_ (pure ()) $ do
1013+ (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
1014+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
1015+ performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
1016+
1017+ session' "prerender" $ do
1018+ it "works in simple case" $ runWD $ do
1019+ testWidget (checkBodyText "One") (checkBodyText "Two") $ do
1020+ prerender_ (text "One") (text "Two")
1021+ it "removes element correctly" $ runWD $ do
1022+ testWidget' (findElemWithRetry $ WD.ByTag "span") elementShouldBeRemoved $ do
1023+ prerender_ (el "span" $ text "One") (text "Two")
1024+ it "can be nested in server widget" $ runWD $ do
1025+ testWidget (checkBodyText "One") (checkBodyText "Three") $ do
1026+ prerender_ (prerender_ (text "One") (text "Two")) (text "Three")
1027+ it "can be nested in client widget" $ runWD $ do
1028+ testWidget (checkBodyText "One") (checkBodyText "Three") $ do
1029+ prerender_ (text "One") (prerender_ (text "Two") (text "Three"))
1030+ it "works with prerender_ siblings" $ runWD $ do
1031+ testWidget
1032+ (checkTextInId "a1" "One" >> checkTextInId "b1" "Three" >> checkTextInId "c1" "Five")
1033+ (checkTextInId "a2" "Two" >> checkTextInId "b2" "Four" >> checkTextInId "c2" "Six") $ do
1034+ prerender_ (divId "a1" $ text "One") (divId "a2" $ text "Two")
1035+ prerender_ (divId "b1" $ text "Three") (divId "b2" $ text "Four")
1036+ prerender_ (divId "c1" $ text "Five") (divId "c2" $ text "Six")
1037+ it "works inside other element" $ runWD $ do
1038+ testWidget (checkTextInTag "div" "One") (checkTextInTag "div" "Two") $ do
1039+ el "div" $ prerender_ (text "One") (text "Two")
1040+-- TODO re-enable this
1041+-- it "places fences and removes them" $ runWD $ do
1042+-- testWidget'
1043+-- (do
1044+-- scripts <- WD.findElems $ WD.ByTag "script"
1045+-- filterM (\s -> maybe False (\t -> "prerender" `T.isPrefixOf` t) <$> WD.attr s "type") scripts
1046+-- )
1047+-- (traverse_ elementShouldBeRemoved)
1048+-- (el "span" $ prerender_ (text "One") (text "Two"))
1049+ it "postBuild works on server side" $ runWD $ do
1050+ lock :: MVar () <- liftIO newEmptyMVar
1051+ testWidget (liftIO $ takeMVar lock) (pure ()) $ do
1052+ prerender_ (do
1053+ pb <- getPostBuild
1054+ performEvent_ $ liftIO (putMVar lock ()) <$ pb) blank
1055+ it "postBuild works on client side" $ runWD $ do
1056+ lock :: MVar () <- liftIO newEmptyMVar
1057+ testWidget (pure ()) (liftIO $ takeMVar lock) $ do
1058+ prerender_ blank $ do
1059+ pb <- getPostBuild
1060+ performEvent_ $ liftIO (putMVar lock ()) <$ pb
1061+ it "result Dynamic is updated *after* switchover" $ runWD $ do
1062+ let preSwitchover = checkBodyText "PostBuild"
1063+ check = checkBodyText "Client"
1064+ testWidget preSwitchover check $ void $ do
1065+ d <- prerender (pure "Initial") (pure "Client")
1066+ pb <- getPostBuild
1067+ initial <- sample $ current d
1068+ textNode $ TextNodeConfig initial $ Just $ leftmost [updated d, "PostBuild" <$ pb]
1069+ -- This essentially checks that the client IO runs *after* switchover/postBuild,
1070+ -- thus can't create conflicting DOM
1071+ it "can't exploit IO to break hydration" $ runWD $ do
1072+ let preSwitchover = checkBodyText "Initial"
1073+ testWidgetStatic preSwitchover $ void $ do
1074+ ref <- liftIO $ newRef "Initial"
1075+ prerender_ (pure ()) (liftIO $ writeRef ref "Client")
1076+ text <=< liftIO $ readRef ref
1077+ -- As above, so below
1078+ it "can't exploit triggerEvent to break hydration" $ runWD $ do
1079+ let preSwitchover = checkBodyText "Initial"
1080+ check = checkBodyText "Client"
1081+ testWidget preSwitchover check $ void $ do
1082+ (e, trigger) <- newTriggerEvent
1083+ prerender_ (pure ()) (liftIO $ trigger "Client")
1084+ textNode $ TextNodeConfig "Initial" $ Just e
1085+
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
1096+ it "works" $ runWD $ do
1097+ replaceChan :: Chan Text <- liftIO newChan
1098+ let setup = findElemWithRetry $ WD.ByTag "div"
1099+ check ssr = do
1100+ -- Check that the original element still exists and has the correct text
1101+ shouldContainText "two" ssr
1102+ liftIO $ writeChan replaceChan "three"
1103+ elementShouldBeRemoved ssr
1104+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1105+ testWidget' setup check $ do
1106+ replace <- triggerEventWithChan replaceChan
1107+ pb <- getPostBuild
1108+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1109+ [ el "div" (text "two") <$ pb
1110+ , el "span" . text <$> replace
1111+ ]
1112+ it "can be nested in initial widget" $ runWD $ do
1113+ replaceChan :: Chan Text <- liftIO newChan
1114+ let setup = findElemWithRetry $ WD.ByTag "div"
1115+ check ssr = do
1116+ -- Check that the original element still exists and has the correct text
1117+ shouldContainText "two" ssr
1118+ liftIO $ writeChan replaceChan "three"
1119+ elementShouldBeRemoved ssr
1120+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1121+ testWidget' setup check $ void $ flip runWithReplace never $ do
1122+ replace <- triggerEventWithChan replaceChan
1123+ pb <- getPostBuild
1124+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1125+ [ el "div" (text "two") <$ pb
1126+ , el "span" . text <$> replace
1127+ ]
1128+ it "can be nested in postBuild widget" $ runWD $ do
1129+ replaceChan :: Chan Text <- liftIO newChan
1130+ let setup = findElemWithRetry $ WD.ByTag "div"
1131+ check ssr = do
1132+ -- Check that the original element still exists and has the correct text
1133+ shouldContainText "two" ssr
1134+ liftIO $ writeChan replaceChan "three"
1135+ elementShouldBeRemoved ssr
1136+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1137+ testWidget' setup check $ void $ do
1138+ pb <- getPostBuild
1139+ runWithReplace (pure ()) $ ffor pb $ \() -> do
1140+ replace <- triggerEventWithChan replaceChan
1141+ pb' <- getPostBuild
1142+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1143+ [ el "div" (text "two") <$ pb'
1144+ , el "span" . text <$> replace
1145+ ]
1146+ it "postBuild works in replaced widget" $ runWD $ do
1147+ replaceChan <- liftIO newChan
1148+ pbLock <- liftIO newEmptyMVar
1149+ let check = liftIO $ do
1150+ writeChan replaceChan ()
1151+ takeMVar pbLock
1152+ testWidget (pure ()) check $ void $ do
1153+ replace <- triggerEventWithChan replaceChan
1154+ runWithReplace (pure ()) $ ffor replace $ \() -> do
1155+ pb <- getPostBuild
1156+ performEvent_ $ liftIO (putMVar pbLock ()) <$ pb
1157+ it "can be nested in event widget" $ runWD $ do
1158+ replaceChan1 :: Chan Text <- liftIO newChan
1159+ replaceChan2 :: Chan Text <- liftIO newChan
1160+ lock :: MVar () <- liftIO newEmptyMVar
1161+ let check = do
1162+ shouldContainText "" =<< findElemWithRetry (WD.ByTag "body")
1163+ liftIO $ do
1164+ writeChan replaceChan1 "one"
1165+ takeMVar lock
1166+ one <- findElemWithRetry $ WD.ByTag "div"
1167+ shouldContainText "pb" one
1168+ liftIO $ writeChan replaceChan2 "two"
1169+ elementShouldBeRemoved one
1170+ shouldContainText "two" =<< findElemWithRetry (WD.ByTag "span")
1171+ testWidget (pure ()) check $ void $ do
1172+ replace1 <- triggerEventWithChan replaceChan1
1173+ runWithReplace (pure ()) $ ffor replace1 $ \r1 -> do
1174+ replace2 <- triggerEventWithChan replaceChan2
1175+ pb <- getPostBuild
1176+ performEvent_ $ liftIO (putMVar lock ()) <$ pb
1177+ void $ runWithReplace (el "div" $ text r1) $ leftmost
1178+ [ el "span" . text <$> replace2
1179+ , el "div" (text "pb") <$ pb
1180+ ]
1181+ it "prerender works in replaced widget" $ runWD $ do
1182+ replaceChan <- liftIO newChan
1183+ lock :: MVar () <- liftIO newEmptyMVar
1184+ pbLock :: MVar () <- liftIO newEmptyMVar
1185+ let check = do
1186+ liftIO $ do
1187+ writeChan replaceChan ()
1188+ takeMVar lock
1189+ takeMVar pbLock
1190+ testWidget (pure ()) check $ void $ do
1191+ replace <- triggerEventWithChan replaceChan
1192+ runWithReplace (pure ()) $ ffor replace $ \() -> do
1193+ prerender_ (pure ()) $ do
1194+ liftIO $ putMVar lock ()
1195+ pb <- getPostBuild
1196+ performEvent_ $ liftIO (putMVar pbLock ()) <$ pb
1197+ it "prerender returns in immediate mode" $ runWD $ do
1198+ replaceChan <- liftIO newChan
1199+ pbLock <- liftIO newEmptyMVar
1200+ let check = liftIO $ do
1201+ writeChan replaceChan ()
1202+ takeMVar pbLock
1203+ testWidget (pure ()) check $ void $ do
1204+ replace <- triggerEventWithChan replaceChan
1205+ runWithReplace (pure ()) $ ffor replace $ \() -> do
1206+ prerender_ (pure ()) (pure ())
1207+ liftIO $ putMVar pbLock ()
1208+ it "works in immediate mode (RHS of prerender)" $ runWD $ do
1209+ replaceChan :: Chan Text <- liftIO newChan
1210+ let check = do
1211+ checkBodyText "one"
1212+ one <- findElemWithRetry $ WD.ByTag "div"
1213+ shouldContainText "one" one
1214+ liftIO $ writeChan replaceChan "pb"
1215+ elementShouldBeRemoved one
1216+ shouldContainText "pb" =<< findElemWithRetry (WD.ByTag "span")
1217+ testWidget (pure ()) check $ void $ do
1218+ replace <- triggerEventWithChan replaceChan
1219+ prerender_ blank $ do
1220+ void $ runWithReplace (el "div" $ text "one") $ el "span" . text <$> replace
1221+ it "works with postBuild in immediate mode (RHS of prerender)" $ runWD $ do
1222+ replaceChan :: Chan Text <- liftIO newChan
1223+ let check = do
1224+ checkBodyText "two"
1225+ two <- findElemWithRetry $ WD.ByTag "div"
1226+ shouldContainText "two" two
1227+ liftIO $ writeChan replaceChan "three"
1228+ elementShouldBeRemoved two
1229+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1230+ testWidget (pure ()) check $ void $ do
1231+ replace <- triggerEventWithChan replaceChan
1232+ prerender_ blank $ do
1233+ pb <- getPostBuild
1234+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1235+ [ el "div" (text "two") <$ pb
1236+ , el "span" . text <$> replace
1237+ ]
1238+
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
1294+ let widget :: DomBuilder t m => DKey a -> Identity a -> m (Identity a)
1295+ widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
1296+ elClass "span" "key" $ text $ textKey k
1297+ elClass "span" "value" $ text $ T.pack $ has @Show k $ show v
1298+ pure (Identity v)
1299+ checkItem :: WD.Element -> Text -> Text -> WD ()
1300+ checkItem li k v = do
1301+ putStrLnDebug "checkItem"
1302+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1303+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
1304+ checkInitialItems dm xs = do
1305+ putStrLnDebug "checkInitialItems"
1306+ liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
1307+ forM_ (zip xs (DMap.toList dm)) $ \(e, k :=> Identity v) -> checkItem e (textKey k) (T.pack $ has @Show k $ show v)
1308+ getAndCheckInitialItems dm = withRetry $ do
1309+ putStrLnDebug "getAndCheckInitialItems"
1310+ xs <- WD.findElems (WD.ByTag "li")
1311+ checkInitialItems dm xs
1312+ pure xs
1313+ checkRemoval chan k = do
1314+ putStrLnDebug "checkRemoval"
1315+ e <- findElemWithRetry (WD.ById $ textKey k)
1316+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe Nothing)
1317+ elementShouldBeRemoved e
1318+ checkReplace chan k v = do
1319+ putStrLnDebug "checkReplace"
1320+ e <- findElemWithRetry (WD.ById $ textKey k)
1321+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1322+ elementShouldBeRemoved e
1323+ e' <- findElemWithRetry $ WD.ById $ textKey k
1324+ checkItem e' (textKey k) (T.pack $ show v)
1325+ checkInsert chan k v = do
1326+ putStrLnDebug "checkInsert"
1327+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1328+ e <- findElemWithRetry (WD.ById $ textKey k)
1329+ checkItem e (textKey k) (T.pack $ show v)
1330+ postBuildPatch = PatchDMap $ DMap.fromList [Key_Char :=> ComposeMaybe Nothing, Key_Bool :=> ComposeMaybe (Just $ Identity True)]
1331+ it "doesn't replace elements at switchover, can delete/update/insert" $ runWD $ do
1332+ chan <- liftIO newChan
1333+ let preSwitchover :: WD [WD.Element]
1334+ preSwitchover = getAndCheckInitialItems keyMap
1335+ check :: [WD.Element] -> WD ()
1336+ check xs = do
1337+ checkInitialItems keyMap xs
1338+ checkRemoval chan Key_Int
1339+ checkReplace chan Key_Char 'B'
1340+ checkInsert chan Key_Bool True
1341+ testWidget' preSwitchover check $ do
1342+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1343+ liftIO $ dmap `H.shouldBe` keyMap
1344+ it "handles postBuild correctly" $ runWD $ do
1345+ chan <- liftIO newChan
1346+ let preSwitchover = getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
1347+ check xs = do
1348+ withRetry $ checkInitialItems (applyAlways postBuildPatch keyMap) xs
1349+ checkRemoval chan Key_Int
1350+ checkInsert chan Key_Char 'B'
1351+ checkReplace chan Key_Bool True
1352+ testWidget' preSwitchover check $ void $ do
1353+ pb <- getPostBuild
1354+ replace <- triggerEventWithChan chan
1355+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1356+ liftIO $ dmap `H.shouldBe` keyMap
1357+ it "can delete/update/insert when built in prerender" $ runWD $ do
1358+ chan <- liftIO newChan
1359+ let check = do
1360+ _ <- getAndCheckInitialItems keyMap
1361+ checkRemoval chan Key_Int
1362+ checkReplace chan Key_Char 'B'
1363+ checkInsert chan Key_Bool True
1364+ testWidget (pure ()) check $ do
1365+ replace <- triggerEventWithChan chan
1366+ prerender_ (pure ()) $ do
1367+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap replace
1368+ liftIO $ dmap `H.shouldBe` keyMap
1369+ it "can delete/update/insert when built in immediate mode" $ runWD $ do
1370+ chan <- liftIO newChan
1371+ let check = do
1372+ _ <- getAndCheckInitialItems keyMap
1373+ checkRemoval chan Key_Int
1374+ checkReplace chan Key_Char 'B'
1375+ checkInsert chan Key_Bool True
1376+ testWidget (pure ()) check $ void $ do
1377+ pb <- getPostBuild
1378+ runWithReplace (pure ()) $ ffor pb $ \() -> void $ do
1379+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1380+ liftIO $ dmap `H.shouldBe` keyMap
1381+ -- Should be fixed by prerender changes!
1382+ it "handles postBuild correctly in prerender" $ runWD $ do
1383+ chan <- liftIO newChan
1384+ let check = do
1385+ _ <- getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
1386+ checkRemoval chan Key_Int
1387+ checkInsert chan Key_Char 'B'
1388+ checkReplace chan Key_Bool True
1389+ testWidget (pure ()) check $ do
1390+ replace <- triggerEventWithChan chan
1391+ prerender_ (pure ()) $ void $ do
1392+ pb <- getPostBuild
1393+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1394+ liftIO $ dmap `H.shouldBe` keyMap
1395+
1396+ session' "traverseIntMapWithKeyWithAdjust" $ do
1397+ let textKeyInt k = "key" <> T.pack (show k)
1398+ intMap = IntMap.fromList
1399+ [ (1, "one")
1400+ , (2, "two")
1401+ , (3, "three")
1402+ ]
1403+ let widget :: DomBuilder t m => IntMap.Key -> Text -> m Text
1404+ widget k v = elAttr "li" ("id" =: textKeyInt k) $ do
1405+ elClass "span" "key" $ text $ textKeyInt k
1406+ elClass "span" "value" $ text v
1407+ pure v
1408+ checkItem :: WD.Element -> Text -> Text -> WD ()
1409+ checkItem li k v = do
1410+ putStrLnDebug "checkItem"
1411+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1412+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
1413+ checkInitialItems dm xs = do
1414+ putStrLnDebug "checkInitialItems"
1415+ liftIO $ assertEqual "Wrong amount of items in DOM" (IntMap.size dm) (length xs)
1416+ forM_ (zip xs (IntMap.toList dm)) $ \(e, (k, v)) -> checkItem e (textKeyInt k) v
1417+ getAndCheckInitialItems dm = withRetry $ do
1418+ putStrLnDebug "getAndCheckInitialItems"
1419+ xs <- WD.findElems (WD.ByTag "li")
1420+ checkInitialItems dm xs
1421+ pure xs
1422+ checkRemoval chan k = do
1423+ putStrLnDebug "checkRemoval"
1424+ e <- findElemWithRetry (WD.ById $ textKeyInt k)
1425+ liftIO $ writeChan chan $ PatchIntMap $ IntMap.singleton k Nothing
1426+ elementShouldBeRemoved e
1427+ checkReplace chan k v = do
1428+ putStrLnDebug "checkReplace"
1429+ e <- findElemWithRetry (WD.ById $ textKeyInt k)
1430+ liftIO $ writeChan chan $ PatchIntMap $ IntMap.singleton k $ Just v
1431+ elementShouldBeRemoved e
1432+ e' <- findElemWithRetry (WD.ById $ textKeyInt k)
1433+ withRetry $ checkItem e' (textKeyInt k) v
1434+ checkInsert chan k v = do
1435+ putStrLnDebug "checkInsert"
1436+ liftIO $ writeChan chan $ PatchIntMap $ IntMap.singleton k $ Just v
1437+ e <- findElemWithRetry (WD.ById $ textKeyInt k)
1438+ checkItem e (textKeyInt k) v
1439+ postBuildPatch = PatchIntMap $ IntMap.fromList [(2, Nothing), (3, Just "trois"), (4, Just "four")]
1440+ xit "doesn't replace elements at switchover, can delete/update/insert" $ runWD $ do
1441+ chan <- liftIO newChan
1442+ let preSwitchover = getAndCheckInitialItems intMap
1443+ check xs = do
1444+ checkInitialItems intMap xs
1445+ checkRemoval chan 1
1446+ checkReplace chan 2 "deux"
1447+ checkInsert chan 4 "four"
1448+ testWidget' preSwitchover check $ void $ do
1449+ (im, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap =<< triggerEventWithChan chan
1450+ liftIO $ im `H.shouldBe` intMap
1451+ xit "handles postBuild correctly" $ runWD $ do
1452+ chan <- liftIO newChan
1453+ let preSwitchover = getAndCheckInitialItems $ applyAlways postBuildPatch intMap
1454+ check xs = do
1455+ withRetry $ checkInitialItems (applyAlways postBuildPatch intMap) xs
1456+ checkRemoval chan 1
1457+ checkInsert chan 2 "deux"
1458+ checkReplace chan 3 "trois"
1459+ testWidget' preSwitchover check $ void $ do
1460+ pb <- getPostBuild
1461+ replace <- triggerEventWithChan chan
1462+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
1463+ liftIO $ dmap `H.shouldBe` intMap
1464+ xit "can delete/update/insert when built in prerender" $ runWD $ do
1465+ chan <- liftIO newChan
1466+ let check = do
1467+ _ <- getAndCheckInitialItems intMap
1468+ checkRemoval chan 1
1469+ checkReplace chan 2 "deux"
1470+ checkInsert chan 4 "quatre"
1471+ testWidget (pure ()) check $ do
1472+ replace <- triggerEventWithChan chan
1473+ prerender_ (pure ()) $ do
1474+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap replace
1475+ liftIO $ dmap `H.shouldBe` intMap
1476+ xit "can delete/update/insert when built in immediate mode" $ runWD $ do
1477+ chan <- liftIO newChan
1478+ let check = do
1479+ _ <- getAndCheckInitialItems intMap
1480+ checkRemoval chan 1
1481+ checkReplace chan 2 "deux"
1482+ checkInsert chan 4 "quatre"
1483+ testWidget (pure ()) check $ void $ do
1484+ pb <- getPostBuild
1485+ runWithReplace (pure ()) $ ffor pb $ \() -> void $ do
1486+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap =<< triggerEventWithChan chan
1487+ liftIO $ dmap `H.shouldBe` intMap
1488+ -- Should be fixed by prerender changes!
1489+ xit "handles postBuild correctly in prerender" $ runWD $ do
1490+ chan <- liftIO newChan
1491+ let check = do
1492+ _ <- getAndCheckInitialItems $ applyAlways postBuildPatch intMap
1493+ checkRemoval chan 1
1494+ checkInsert chan 2 "deux"
1495+ checkReplace chan 3 "trois"
1496+ testWidget (pure ()) check $ do
1497+ replace <- triggerEventWithChan chan
1498+ prerender_ (pure ()) $ void $ do
1499+ pb <- getPostBuild
1500+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
1501+ liftIO $ dmap `H.shouldBe` intMap
1502+
1503+ session' "traverseDMapWithKeyWithAdjustWithMove" $ do
1504+ let widget :: DomBuilder t m => Key2 a -> Identity a -> m (Identity a)
1505+ widget k (Identity v) = elAttr "li" ("id" =: textKey2 k) $ do
1506+ elClass "span" "key" $ text $ textKey2 k
1507+ elClass "span" "value" $ text $ T.pack $ has @Show k $ show v
1508+ pure (Identity v)
1509+ textKey2 :: Key2 a -> Text
1510+ textKey2 = \case
1511+ Key2_Int i -> "i" <> T.pack (show i)
1512+ Key2_Char c -> "c" <> T.pack [c]
1513+ checkItem :: WD.Element -> Text -> Text -> WD ()
1514+ checkItem li k v = do
1515+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1516+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
1517+ checkInitialItems dm xs = do
1518+ liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
1519+ forM_ (zip xs (DMap.toList dm)) $ \(e, k :=> Identity v) -> checkItem e (textKey2 k) (T.pack $ has @Show k $ show v)
1520+ getAndCheckInitialItems dm = withRetry $ do
1521+ xs <- WD.findElems (WD.ByTag "li")
1522+ checkInitialItems dm xs
1523+ pure xs
1524+ moveSpec
1525+ :: (DMap Key2 Identity -> (WD.Element -> Chan (PatchDMapWithMove Key2 Identity) -> WD ()) -> WD ())
1526+ -> H.SpecM (WdTestSession ()) ()
1527+ moveSpec testMove = do
1528+ it "can insert an item" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 3 ==> 3]) $ \body chan -> do
1529+ shouldContainText (T.strip $ T.unlines ["i11","i33"]) body
1530+ liftIO $ writeChan chan (insertDMapKey (Key2_Int 2) 2)
1531+ shouldContainText (T.strip $ T.unlines ["i11","i22","i33"]) body
1532+ it "can delete an item" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 2 ==> 2, Key2_Int 3 ==> 3]) $ \body chan -> do
1533+ shouldContainText (T.strip $ T.unlines ["i11","i22","i33"]) body
1534+ liftIO $ writeChan chan (deleteDMapKey (Key2_Int 2))
1535+ shouldContainText (T.strip $ T.unlines ["i11","i33"]) body
1536+ it "can swap items" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 2 ==> 2, Key2_Int 3 ==> 3, Key2_Int 4 ==> 4]) $ \body chan -> do
1537+ shouldContainText (T.strip $ T.unlines ["i11","i22","i33","i44"]) body
1538+ liftIO $ writeChan chan (swapDMapKey (Key2_Int 2) (Key2_Int 3))
1539+ shouldContainText (T.strip $ T.unlines ["i11","i33","i22","i44"]) body
1540+-- TODO re-enable this
1541+-- it "can move items" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 2 ==> 2, Key2_Int 3 ==> 3, Key2_Int 4 ==> 4]) $ \body chan -> do
1542+-- shouldContainText (T.strip $ T.unlines ["i11","i22","i33", "i44"]) body
1543+-- liftIO $ writeChan chan (moveDMapKey (Key2_Int 2) (Key2_Int 3))
1544+-- shouldContainText (T.strip $ T.unlines ["i11","i22","i44"]) body
1545+-- liftIO $ writeChan chan (moveDMapKey (Key2_Int 2) (Key2_Int 3)) -- attempt a move to nonexistent key should delete
1546+-- shouldContainText (T.strip $ T.unlines ["i11","i44"]) body
1547+-- liftIO $ writeChan chan (moveDMapKey (Key2_Int 2) (Key2_Int 3)) -- this causes a JSException in immediate builder too
1548+-- shouldContainText (T.strip $ T.unlines ["i11","i44"]) body
1549+-- liftIO $ writeChan chan (insertDMapKey (Key2_Int 2) 2) -- this step will fail if the above caused an exception, thus works as a proxy for detecting the exception given we can't catch it
1550+-- shouldContainText (T.strip $ T.unlines ["i11","i22","i44"]) body
1551+
1552+ describe "hydration" $ moveSpec $ \initMap test -> do
1553+ chan <- liftIO newChan
1554+ let preSwitchover = getAndCheckInitialItems initMap
1555+ check xs = do
1556+ checkInitialItems initMap xs
1557+ body <- getBody
1558+ test body chan
1559+ testWidget' preSwitchover check $ void $ do
1560+ (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
1561+ liftIO $ assertEqual "DMap" initMap dmap
1562+
1563+ describe "hydration/immediate" $ moveSpec $ \initMap test -> do
1564+ chan <- liftIO newChan
1565+ replace <- liftIO newChan
1566+ lock :: MVar () <- liftIO newEmptyMVar
1567+ let check = do
1568+ liftIO $ do
1569+ writeChan replace ()
1570+ takeMVar lock
1571+ xs <- getAndCheckInitialItems initMap
1572+ checkInitialItems initMap xs
1573+ body <- getBody
1574+ test body chan
1575+ testWidget (pure ()) check $ void $ do
1576+ e <- triggerEventWithChan replace
1577+ runWithReplace (pure ()) $ ffor e $ \() -> void $ do
1578+ pb <- getPostBuild
1579+ performEvent_ $ liftIO (putMVar lock ()) <$ pb
1580+ (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
1581+ liftIO $ assertEqual "DMap" initMap dmap
1582+
1583+ session' "hydrating invalid HTML" $ do
1584+ xit "can hydrate list in paragraph" $ runWD $ do
1585+ let preSwitchover = do
1586+ checkBodyText "before\ninner\nafter"
1587+ -- 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)"
1591+ ol <- findElemWithRetry (WD.ByTag "ol")
1592+ shouldContainText "before" p1
1593+ shouldContainText "inner" ol
1594+ shouldContainText "" p2
1595+ pure (p1, ol, p2)
1596+ check (p1, ol, p2) = do
1597+ checkBodyText "before\ninner\nafter"
1598+ shouldContainText "before\ninner\nafter" p1
1599+ elementShouldBeRemoved ol
1600+ elementShouldBeRemoved p2
1601+ -- Don't fail fatally when hydration encounters the invalid DOM
1602+ testWidgetDebug' False withDebugging preSwitchover check $ do
1603+ -- This is deliberately invalid HTML, the browser will interpret it as
1604+ -- <p>before</p><ol>inner</ol>after<p></p>
1605+ el "p" $ do
1606+ text "before"
1607+ el "ol" $ text "inner"
1608+ text "after"
1609+
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+
1633+data Selenium = Selenium
1634+ { _selenium_portNumber :: PortNumber
1635+ , _selenium_stopServer :: IO ()
1636+ }
1637+
1638+startSeleniumServer :: PortNumber -> IO (IO ())
1639+startSeleniumServer port = do
1640+ (_,_,_,ph) <- createProcess $ (proc "selenium-server" ["-port", show port])
1641+ { std_in = NoStream
1642+ , std_out = NoStream
1643+ , std_err = NoStream
1644+ }
1645+ return $ terminateProcess ph
1646+
1647+withSeleniumServer :: (Selenium -> IO ()) -> IO ()
1648+withSeleniumServer f = do
1649+ stopServer <- startSeleniumServer seleniumPort
1650+ threadDelay $ 1000 * 1000 * 2 -- TODO poll or wait on a a signal to block on
1651+ f $ Selenium
1652+ { _selenium_portNumber = seleniumPort
1653+ , _selenium_stopServer = stopServer
1654+ }
1655+
1656+triggerEventWithChan :: (Reflex t, TriggerEvent t m, Prerender js t m) => Chan a -> m (Event t a)
1657+triggerEventWithChan chan = do
1658+ (e, trigger) <- newTriggerEvent
1659+ -- In prerender because we only want to do this on the client
1660+ prerender_ (pure ()) $ void $ liftIO $ forkIO $ forever $ trigger =<< readChan chan
1661+ pure e
1662+
1663+shouldBeWithRetryM :: (Eq a, Show a) => WD a -> a -> WD ()
1664+shouldBeWithRetryM m expected = withRetry $ do
1665+ got <- m
1666+ got `shouldBe` expected
1667+
1668+assertAttr :: WD.Element -> Text -> Maybe Text -> WD ()
1669+assertAttr e k v = liftIO . assertEqual "Incorrect attribute value" v =<< WD.attr e k
1670+
1671+elementShouldBeRemoved :: WD.Element -> WD ()
1672+elementShouldBeRemoved e = withRetry $ do
1673+ try (WD.getText e) >>= \case
1674+ Left (WD.FailedCommand WD.StaleElementReference _) -> return ()
1675+ Left err -> throwM err
1676+ Right !_ -> liftIO $ assertFailure "Expected element to be removed, but it still exists"
1677+
1678+shouldContainText :: Text -> WD.Element -> WD ()
1679+shouldContainText t = withRetry . shouldContainTextNoRetry t
1680+
1681+shouldContainTextNoRetry :: Text -> WD.Element -> WD ()
1682+shouldContainTextNoRetry t = flip shouldBe t <=< WD.getText
1683+
1684+checkBodyText :: Text -> WD ()
1685+checkBodyText = checkTextInTag "body"
1686+
1687+checkTextInTag :: Text -> Text -> WD ()
1688+checkTextInTag t expected = do
1689+ e <- findElemWithRetry (WD.ByTag t)
1690+ shouldContainText expected e
1691+
1692+checkTextInId :: Text -> Text -> WD ()
1693+checkTextInId i expected = do
1694+ e <- findElemWithRetry (WD.ById i)
1695+ shouldContainText expected e
1696+
1697+findElemWithRetry :: Selector -> WD WD.Element
1698+findElemWithRetry = withRetry . WD.findElem
1699+
1700+findElemsWithRetry :: Selector -> WD [WD.Element]
1701+findElemsWithRetry = withRetry . WD.findElems
1702+
1703+getBody :: WD WD.Element
1704+getBody = WD.findElem $ WD.ByTag "body"
1705+
1706+withRetry :: forall a. WD a -> WD a
1707+withRetry a = wait 300
1708+ where wait :: Int -> WD a
1709+ wait 0 = a
1710+ wait n = try a >>= \case
1711+ Left (e :: SomeException) -> do
1712+ liftIO $ putStrLn ("(retrying due to " <> show e <> ")") *> threadDelay 100000
1713+ wait $ n - 1
1714+ Right v -> return v
1715+
1716+divId :: DomBuilder t m => Text -> m a -> m a
1717+divId i = elAttr "div" ("id" =: i)
1718+
1719+type TestWidget js t m = (DomBuilder t m, MonadHold t m, PostBuild t m, Prerender js t m, PerformEvent t m, TriggerEvent t m, MonadFix m, MonadIO (Performable m), MonadIO m)
1720+
1721+testWidgetStaticDebug
1722+ :: Bool
1723+ -> WD b
1724+ -- ^ Webdriver commands to run before JS runs and after hydration switchover
1725+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1726+ -- ^ Widget we are testing
1727+ -> WD b
1728+testWidgetStaticDebug withDebugging w = testWidgetDebug True withDebugging (void w) w
1729+
1730+-- | TODO: do something about JSExceptions not causing tests to fail
1731+testWidgetDebug
1732+ :: Bool
1733+ -> Bool
1734+ -> WD ()
1735+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1736+ -> WD b
1737+ -- ^ Webdriver commands to run after hydration switchover
1738+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1739+ -- ^ Widget we are testing
1740+ -> 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
1746+
1747+-- | TODO: do something about JSExceptions not causing tests to fail
1748+testWidgetDebug'
1749+ :: Bool
1750+ -> Bool
1751+ -> WD a
1752+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1753+ -> (a -> WD b)
1754+ -- ^ Webdriver commands to run after hydration switchover
1755+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1756+ -- ^ Widget we are testing (contents of body)
1757+ -> WD b
1758+testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget = do
1759+ let putStrLnDebug :: MonadIO m => Text -> m ()
1760+ putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
1761+ staticApp = do
1762+ el "head" $ pure ()
1763+ el "body" $ do
1764+ bodyWidget
1765+ el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
1766+ putStrLnDebug "rendering static"
1767+ ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
1768+ putStrLnDebug "rendered static"
1769+ waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
1770+ onFailure <- if hardFailure then (`throwTo` HydrationFailedException) <$> liftIO myThreadId else pure $ pure ()
1771+ waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
1772+ let entryPoint = do
1773+ putStrLnDebug "taking waitBeforeJS"
1774+ liftIO $ takeMVar waitBeforeJS
1775+ let switchOverAction = do
1776+ putStrLnDebug "switchover syncPoint"
1777+ syncPoint
1778+ putStrLnDebug "putting waitUntilSwitchover"
1779+ liftIO $ putMVar waitUntilSwitchover ()
1780+ putStrLnDebug "put waitUntilSwitchover"
1781+ putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
1782+ mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchOverAction blank bodyWidget
1783+ putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
1784+ syncPoint
1785+ application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
1786+ putStrLnDebug "sending response"
1787+ r <- sendResponse $ responseLBS status200 [] $ "<!doctype html>\n" <> LBS.fromStrict html
1788+ putStrLnDebug "sent response"
1789+ return r
1790+ waitJSaddle <- liftIO newEmptyMVar
1791+ let settings = foldr ($) Warp.defaultSettings
1792+ [ Warp.setPort $ fromIntegral $ toInteger jsaddlePort
1793+ , Warp.setBeforeMainLoop $ do
1794+ putStrLnDebug "putting waitJSaddle"
1795+ putMVar waitJSaddle ()
1796+ putStrLnDebug "put waitJSaddle"
1797+ ]
1798+ -- hSilence to get rid of ConnectionClosed logs
1799+ 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)
1820+
1821+data Key2 a where
1822+ Key2_Int :: Int -> Key2 Int
1823+ Key2_Char :: Char -> Key2 Char
1824+
1825+deriveGEq ''Key2
1826+deriveGCompare ''Key2
1827+deriveGShow ''Key2
1828+deriveArgDict ''Key2
reflex-dom-test-selenium/CHANGELOG.mdnew file+5
@@ -0,0 +1,5 @@
1+# Revision history for reflex-dom-core-selenium
2+
3+## 0.1.0.0 -- YYYY-mm-dd
4+
5+* First version. Released on an unsuspecting world.
reflex-dom-test-selenium/LICENSEnew file+12
@@ -0,0 +1,12 @@
1+Copyright (c) 2020, Obsidian Systems LLC
2+All rights reserved.
3+
4+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
8+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
9+
10+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11+
12+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
reflex-dom-test-selenium/Setup.hsnew file+2
@@ -0,0 +1,2 @@
1+import Distribution.Simple
2+main = defaultMain
reflex-dom-test-selenium/add-overrides.nixnew file+20
@@ -0,0 +1,20 @@
1+{ nixpkgs }: testPackage:
2+ nixpkgs.haskell.lib.overrideCabal testPackage
3+ (drv: {
4+
5+ # The headless browser run as part of the tests will exit without this
6+ preBuild = ''
7+ export HOME="$PWD"
8+ '';
9+
10+ testSystemDepends = with nixpkgs; (drv.testSystemDepends or []) ++ [
11+ selenium-server-standalone which
12+ chromium
13+ nixpkgs.iproute
14+ ];
15+
16+ # The headless browser run as part of gc tests would hang/crash without this
17+ preCheck = ''
18+ export FONTCONFIG_PATH=${nixpkgs.fontconfig.out}/etc/fonts
19+ '';
20+ })
reflex-dom-test-selenium/reflex-dom-test-selenium.cabalnew file+41
@@ -0,0 +1,41 @@
1+cabal-version: 1.24
2+Name: reflex-dom-test-selenium
3+Version: 0.0.0.1
4+Synopsis: Testing framework for selenium tests
5+Description:
6+License: BSD3
7+License-file: LICENSE
8+Author: Ryan Trinkle
9+Maintainer: ryan.trinkle@gmail.com
10+Stability: Experimental
11+Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
12+Build-type: Simple
13+
14+library
15+ hs-source-dirs: src
16+ build-depends:
17+ async,
18+ base >= 4.7 && < 4.15,
19+ bytestring == 0.10.*,
20+ chrome-test-utils,
21+ exceptions,
22+ hspec-core,
23+ hspec-webdriver >= 1.2.1,
24+ http-types,
25+ jsaddle >= 0.9.0.0 && < 0.10,
26+ jsaddle-warp,
27+ network,
28+ process,
29+ reflex-dom-core,
30+ silently,
31+ text == 1.2.*,
32+ wai,
33+ warp,
34+ webdriver,
35+ websockets
36+
37+ exposed-modules:
38+ Reflex.Dom.Test.Selenium
39+
40+ default-language: Haskell98
41+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
reflex-dom-test-selenium/src/Reflex/Dom/Test/Selenium.hsnew file+249
@@ -0,0 +1,249 @@
1+{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE OverloadedStrings #-}
5+{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TemplateHaskell #-}
9+
10+{-# OPTIONS_GHC -fno-warn-orphans #-}
11+
12+-- | Utilities for testing reflex-dom widgets with Selenium.
13+--
14+-- Any uses of the 'testWidget' functions will start a jsaddle warp server and
15+-- serve the given widget in an otherwise empty page. Webdriver commands can run
16+-- on the statically rendered page, and on the hydrated page.
17+module Reflex.Dom.Test.Selenium
18+ ( TestWidget
19+ , TestWidgetConfig (..)
20+ , testWidget, testWidget', testWidgetStatic, testWidgetHydrated
21+ , withSeleniumSpec
22+ , embedSpec
23+ , SeleniumSetupConfig (..)
24+ ) where
25+
26+import Control.Concurrent (threadDelay, newEmptyMVar, takeMVar, putMVar)
27+import Control.Exception (throwIO)
28+import Control.Monad (when)
29+import Control.Monad.Catch (MonadMask, handle)
30+import Control.Monad.Fix (MonadFix)
31+import Control.Monad.IO.Class (MonadIO, liftIO)
32+import Data.Text (Text)
33+import Language.Javascript.JSaddle
34+import Language.Javascript.JSaddle.Warp
35+import Network.HTTP.Types (status200)
36+import Network.Socket (PortNumber)
37+import Network.Wai (responseLBS)
38+import Network.WebSockets (defaultConnectionOptions)
39+import Reflex.Dom.Core
40+import System.IO (stderr)
41+import System.IO.Silently (hSilence)
42+import System.Process (std_in, std_out, std_err, createProcess, proc, StdStream (..), terminateProcess)
43+import Test.Hspec.WebDriver (Spec, SpecWith, WdTestSession, sessionWith, using)
44+import Test.Util.ChromeFlags
45+import Test.Util.UnshareNetwork
46+import Test.WebDriver (WD)
47+
48+import qualified Control.Concurrent.Async as Async
49+import qualified Data.ByteString.Lazy as LBS
50+import qualified Data.Text as T
51+import qualified Data.Text.Encoding as TE
52+import qualified Network.Wai.Handler.Warp as Warp
53+import qualified Test.Hspec.Core.Spec as Hspec
54+import qualified Test.WebDriver as WD
55+import qualified Test.WebDriver.Capabilities as WD
56+
57+deriving instance MonadMask WD
58+
59+data SeleniumSetupConfig = SeleniumSetupConfig
60+ { _seleniumSetupConfig_chromiumPath :: FilePath
61+ -- ^ Path to the chromium executable
62+ , _seleniumSetupConfig_headless :: Bool
63+ -- ^ True means that the browser is invoked in headless mode, False means that
64+ -- the user can see the interaction happening on the browser (useful for debugging).
65+ , _seleniumSetupConfig_seleniumPort :: PortNumber
66+ -- ^ The port number used by selenium
67+ }
68+
69+-- | Setup a selenium server and use it to run some hspec tests.
70+--
71+-- withSeleniumSpec config $ \runSession -> hspec $ do
72+-- describe "tests using webdriver session" $ runSession $ do
73+-- webdriver tests here
74+withSeleniumSpec :: SeleniumSetupConfig -> ((forall multi. SpecWith (WdTestSession multi) -> Spec) -> IO a) -> IO a
75+withSeleniumSpec config runSpec = do
76+ liftIO $ handle (\(_ :: IOError) -> return ()) $ unshareNetork -- If we run into an exception with sandboxing, just don't bother
77+ withSandboxedChromeFlags (_seleniumSetupConfig_headless config) $ \chromeFlags -> do
78+ withSeleniumServer (_seleniumSetupConfig_seleniumPort config) $ do
79+ let browserPath = T.strip $ T.pack $ _seleniumSetupConfig_chromiumPath config
80+ when (T.null browserPath) $ fail "No browser found"
81+ let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _seleniumSetupConfig_seleniumPort config }
82+ chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
83+ runSpec $ sessionWith wdConfig "" . using [(chromeCaps', "chrome")]
84+
85+startSeleniumServer :: PortNumber -> IO (IO ())
86+startSeleniumServer port = do
87+ (_,_,_,ph) <- createProcess $ (proc "selenium-server" ["-port", show port])
88+ { std_in = NoStream
89+ , std_out = NoStream
90+ , std_err = NoStream
91+ }
92+ return $ terminateProcess ph
93+
94+withSeleniumServer :: PortNumber -> IO a -> IO a
95+withSeleniumServer port f = bracket (startSeleniumServer port) id $ \_ -> do
96+ threadDelay $ 1000 * 1000 * 2 -- TODO poll or wait on a a signal to block on
97+ f
98+
99+chromeConfig :: Text -> [Text] -> WD.WDConfig
100+chromeConfig fp flags =
101+ WD.useBrowser
102+ (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags })
103+ WD.defaultConfig
104+
105+--------------------------------------------------------------------------------
106+-- Function to test widgets
107+--------------------------------------------------------------------------------
108+
109+-- | The environment in which your widgets can be tested
110+type TestWidget js t m =
111+ (DomBuilder t m, MonadHold t m, PostBuild t m
112+ , Prerender js t m, PerformEvent t m, TriggerEvent t m
113+ , MonadFix m, MonadIO (Performable m), MonadIO m)
114+
115+-- | Configuration of individual tests
116+data TestWidgetConfig = TestWidgetConfig
117+ { _testWidgetConfig_debug :: Bool
118+ -- ^ If this flag is set to True, during the test we will emit debug messages
119+ , _testWidgetConfig_headWidget :: (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
120+ -- ^ We can add widgets here that will be included in the head of the page
121+ -- (useful for example to include external js libraries in the tests)
122+ , _testWidgetConfig_jsaddlePort :: PortNumber
123+ -- ^ Port used by the jsaddle server
124+ }
125+
126+-- | Test a widget by running some webdriver commands before and after
127+-- hydration.
128+testWidget
129+ :: TestWidgetConfig
130+ -> WD a
131+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
132+ -> WD b
133+ -- ^ Webdriver commands to run after hydration switchover
134+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
135+ -- ^ Widget we are testing (contents of body)
136+ -> WD b
137+testWidget cfg before after widget = testWidget' cfg before (const after) widget
138+
139+-- | Test a widget by running some webdriver commands before hydration (on the
140+-- statically rendered page).
141+testWidgetStatic
142+ :: TestWidgetConfig
143+ -> WD a
144+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
145+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
146+ -- ^ Widget we are testing (contents of body)
147+ -> WD a
148+testWidgetStatic cfg before widget = testWidget' cfg before pure widget
149+
150+-- | Test a widget by running some webdriver commands after hydration.
151+testWidgetHydrated
152+ :: TestWidgetConfig
153+ -> WD b
154+ -- ^ Webdriver commands to run after hydration switchover
155+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
156+ -- ^ Widget we are testing (contents of body)
157+ -> WD b
158+testWidgetHydrated cfg after widget = testWidget' cfg (pure ()) (const after) widget
159+
160+-- | Test a widget by running some webdriver commands before and after
161+-- hydration. Like 'testWidget', but you can use the result of the webdriver
162+-- commands from before hydration in the post hydration test.
163+testWidget'
164+ :: TestWidgetConfig
165+ -> WD a
166+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
167+ -> (a -> WD b)
168+ -- ^ Webdriver commands to run after hydration switchover
169+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
170+ -- ^ Widget we are testing (contents of body)
171+ -> WD b
172+testWidget' (TestWidgetConfig withDebugging headWidget jsaddlePort) beforeJS afterSwitchover bodyWidget = do
173+ let putStrLnDebug :: MonadIO m => Text -> m ()
174+ putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
175+ staticApp = do
176+ el "head" $ headWidget
177+ el "body" $ do
178+ bodyWidget
179+ el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
180+ putStrLnDebug "rendering static"
181+ ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
182+ putStrLnDebug "rendered static"
183+ waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
184+ waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
185+ let entryPoint = do
186+ putStrLnDebug "taking waitBeforeJS"
187+ liftIO $ takeMVar waitBeforeJS
188+ let switchOverAction = do
189+ putStrLnDebug "switchover syncPoint"
190+ syncPoint
191+ putStrLnDebug "putting waitUntilSwitchover"
192+ liftIO $ putMVar waitUntilSwitchover ()
193+ putStrLnDebug "put waitUntilSwitchover"
194+ putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
195+ mainHydrationWidgetWithSwitchoverAction switchOverAction blank bodyWidget
196+ putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
197+ syncPoint
198+ application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
199+ putStrLnDebug "sending response"
200+ r <- sendResponse $ responseLBS status200 [] $ "<!doctype html>\n" <> LBS.fromStrict html
201+ putStrLnDebug "sent response"
202+ return r
203+ waitJSaddle <- liftIO newEmptyMVar
204+ let settings = foldr ($) Warp.defaultSettings
205+ [ Warp.setPort $ fromIntegral $ toInteger jsaddlePort
206+ , Warp.setBeforeMainLoop $ do
207+ putStrLnDebug "putting waitJSaddle"
208+ putMVar waitJSaddle ()
209+ putStrLnDebug "put waitJSaddle"
210+ ]
211+ -- hSilence to get rid of ConnectionClosed logs
212+ silenceIfNotDebugging = if withDebugging then id else hSilence [stderr]
213+ jsaddleWarp = silenceIfNotDebugging $ Warp.runSettings settings application
214+ withAsync' jsaddleWarp $ do
215+ putStrLnDebug "taking waitJSaddle"
216+ liftIO $ takeMVar waitJSaddle
217+ putStrLnDebug "opening page"
218+ WD.openPage $ "http://localhost:" <> show jsaddlePort
219+ putStrLnDebug "running beforeJS"
220+ a <- beforeJS
221+ putStrLnDebug "putting waitBeforeJS"
222+ liftIO $ putMVar waitBeforeJS ()
223+ putStrLnDebug "taking waitUntilSwitchover"
224+ liftIO $ takeMVar waitUntilSwitchover
225+ putStrLnDebug "running afterSwitchover"
226+ afterSwitchover a
227+
228+--------------------------------------------------------------------------------
229+-- Utilities
230+--------------------------------------------------------------------------------
231+
232+-- | Embed a different spec type by evaluating it directly.
233+embedSpec :: (Hspec.Example a, MonadIO m) => Hspec.Arg a -> a -> m ()
234+embedSpec arg spec = liftIO $ do
235+ Hspec.Result _info status <- Hspec.evaluateExample
236+ spec
237+ Hspec.defaultParams
238+ (\actionWith -> actionWith arg)
239+ (\_ -> pure ())
240+ case status of
241+ Hspec.Success -> pure ()
242+ Hspec.Pending _ _ -> pure () -- should not happen
243+ failure -> throwIO failure
244+
245+withAsync' :: (MonadIO m, MonadMask m) => IO a -> m b -> m b
246+withAsync' f g = bracket
247+ (liftIO $ Async.async f)
248+ (liftIO . Async.uninterruptibleCancel)
249+ (const g)
reflex-dom/ChangeLog.mdnew file+42
@@ -0,0 +1,42 @@
1+# Revision history for reflex-dom
2+
3+## 0.6.1.0-r1
4+
5+* Loosen reflex-dom-core version bounds
6+
7+## 0.6.1.0
8+
9+* Update for new dependent-map and dependent-sum (after the "some" package split)
10+
11+## 0.6.0.0
12+
13+* ([#379](https://github.com/reflex-frp/reflex-dom/pull/379)) Re-export all modules from `reflex-dom-core`. The newly re-exported modules are:
14+ * `Foreign.JavaScript.Utils`
15+ * `Reflex.Dom.Builder.Hydratable`
16+ * `Reflex.Dom.Modals.Class`
17+ * `Reflex.Dom.Prerender`
18+ * `Reflex.Dom.Time`
19+ * `Reflex.Dom.WebSocket.Query`
20+ * `Reflex.Dom.Xhr.FormData`
21+* ([#366](https://github.com/reflex-frp/reflex-dom/pull/366)) Bump bounds for `reflex` to include 0.7.
22+
23+## 0.5.3
24+
25+* On Android, enable prompting the user for geolocation
26+ permissions on demand by default. See
27+ https://developer.android.com/reference/android/webkit/WebChromeClient.html#onGeolocationPermissionsShowPrompt(java.lang.String,%20android.webkit.GeolocationPermissions.Callback)
28+ for details.
29+
30+ * Add `< 0.7` upper bound for reflex
31+
32+## 0.5.2
33+
34+* The default jsaddle backend on macOS when built from nix
35+ is now jsaddle-wkwebview, matching the behaviour of cabal
36+ builds.
37+
38+## 0.5
39+
40+* Re-export new hydration widget "mainWidget" functions.
41+
42+* The use-warp flag now properly takes precedence on macOS.
reflex-dom/LICENSE+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2015, Obsidian Systems LLC
1+Copyright (c) 2020, Obsidian Systems LLC
22All rights reserved.
33
44Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
reflex-dom/benchmark.hsnew file+190
@@ -0,0 +1,190 @@
1+{-# LANGUAGE RecursiveDo #-}
2+{-# LANGUAGE GADTs #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE ScopedTypeVariables #-}
5+{-# LANGUAGE RecordWildCards #-}
6+{-# LANGUAGE FlexibleContexts #-}
7+{-# LANGUAGE Rank2Types #-}
8+{-# OPTIONS_GHC -ddump-simpl -ddump-rules -ddump-spec -ddump-to-file -dsuppress-coercions -dsuppress-idinfo #-}
9+module Main (main) where
10+
11+import Control.Monad.State
12+import Data.Monoid
13+import Data.Text (Text)
14+import qualified Data.Text as T
15+import Reflex.Dom
16+import System.Random
17+import qualified Data.Map as Map
18+import Data.Dependent.Map (DMap (..))
19+import qualified Data.Dependent.Map as DMap
20+import Data.Dependent.Sum (DSum (..))
21+import Data.Functor.Misc
22+import Data.Functor.Identity
23+import Data.Functor.Compose
24+import Data.IORef
25+import GHCJS.DOM.Types (JSM)
26+import qualified Data.Some as Some
27+import Data.Functor.Constant
28+import Data.IntMap.Strict (IntMap)
29+import qualified Data.IntMap.Strict as IntMap
30+import Data.FastMutableIntMap
31+
32+import qualified GHCJS.DOM.Element as DOM
33+import qualified GHCJS.DOM.Types as DOM
34+
35+--{-
36+main :: IO ()
37+main = mainWidget' $ do
38+ create1000 <- button "Create 1,000 rows"
39+ let row k _ = el "li" $ text $ T.pack $ show k
40+ el "ul" $ traverseIntMapWithKeyWithAdjust row IntMap.empty $ PatchIntMap (IntMap.fromDistinctAscList [(x, Just ()) | x <- [1 :: Int .. 1000]]) <$ create1000
41+ return ()
42+--}
43+
44+
45+{-
46+main :: IO ()
47+main = do
48+ mainWidget' $ do
49+ create1000 <- button "Create 1,000 rows"
50+ partialUpdate <- button "Update every 10th row"
51+ elClass "table" "table table-hover table-striped test-data" $ el "tbody" $ do
52+ --runWithReplace blank $ forM_ [1..1000] row <$ create1000
53+ rec let u = leftmost
54+ [ PatchIntMap (IntMap.fromDistinctAscList [(x, Just ()) | x <- [1..1000]]) <$ create1000
55+ , PatchIntMap (IntMap.fromDistinctAscList [(x, Just ()) | x <- [1, 11..1000]]) <$ partialUpdate
56+ , PatchIntMap <$> deletes
57+ ]
58+ (_, deletes) <- runEventWriterT $ traverseIntMapWithKeyWithAdjust (\k _ -> row k) mempty u
59+ return ()
60+
61+row :: MonadWidget t m => Int -> EventWriterT t (IntMap (Maybe ())) m ()
62+row rowNum = el "tr" $ do
63+ elClass "td" "col-md-1" $ text $ T.pack $ show rowNum
64+ (sel, _) <- elClass' "td" "col-md-4" $ el "a" $ text "asdf"
65+ (del, _) <- elClass' "td" "col-md-1" deleteButton
66+ tellEvent $ IntMap.singleton rowNum Nothing <$ domEvent Click del
67+ elClass "td" "col-md-6" blank
68+
69+deleteButton :: MonadWidget t m => m ()
70+deleteButton = el "a" $ elAttr "span" ("aria-hidden" =: "true" <> "class" =: "glyphicon glyphicon-remove") $ text "X"
71+
72+--}
73+
74+--
75+{-
76+type RNG = StdGen
77+type Entropy = Int
78+type RowPosition = Int
79+type RowNumber = Int
80+data Row = Row { pos :: RowPosition, num :: RowNumber , txt :: Text } deriving (Eq, Show)
81+type Table = Map RowPosition Row
82+data Model = Model { rng :: RNG, table :: Table, nextNum :: RowNumber, selected :: Maybe Row } deriving Show
83+
84+{- Widgets -}
85+
86+titleW :: MonadWidget t m => m ()
87+titleW = text "Reflex-Dom"
88+
89+headW :: MonadWidget t m => m ()
90+headW = do
91+ el "title" titleW
92+ elAttr "link" ("href" =: "/css/currentStyle.css" <> "rel" =: "stylesheet") blank
93+
94+bodyW :: MonadWidget t m => Entropy -> m ()
95+bodyW seed = divClass "main" $ divClass "container" $ mdo
96+ let initial = Model { rng = mkStdGen seed, table = empty, nextNum = 1, selected = Nothing }
97+ dynModel <- foldDyn ($) initial $ mergeWith (.) $ rowEvents : buttonEvents
98+
99+ buttonEvents :: [Event t (Model -> Model)] <- divClass "jumbotron" $ divClass "row" $ do
100+ divClass "col-md-6" $ el "h1" titleW
101+ divClass "col-md-6" $ divClass "row" $ sequence [
102+ buttonW "run" "Create 1,000 rows" $ createRows 1000,
103+ buttonW "runlots" "Create 10,000 rows" $ createRows 10000,
104+ buttonW "add" "Append 1,000 rows" $ appendRows 1000,
105+ buttonW "update" "Update every 10th row" $ updateRows (\p -> mod p 10 == 0) (<> " !!!"),
106+ buttonW "clear" "Clear" $ clearRows,
107+ buttonW "swaprows" "Swap Rows" $ swapRows (4, 9)
108+ ]
109+
110+ rowEvents' <- tableW dynModel
111+ let rowEvents = foldl (.) id <$> rowEvents'
112+
113+ blank
114+
115+buttonW :: MonadWidget t m => Text -> Text -> a -> m (Event t a)
116+buttonW id txt val = divClass "col-sm-6 smallpad" $ buttonW' ("class" =: "btn btn-primary btn-block" <> "id" =: id)
117+ where
118+ buttonW' attrs = do
119+ (b, _) <- elAttr' "button" attrs $ text txt
120+ pure $ val <$ domEvent Click b
121+
122+tableW :: MonadWidget t m => Dynamic t Model -> m (Event t (Map RowPosition (Model -> Model)))
123+tableW dynM =
124+ elClass "table" "table table-hover table-striped test-data"
125+ $ el "tbody"
126+ $ listViewWithKey (table <$> dynM) (\_ dynRow -> rowW (selectedIs <$> dynM <*> dynRow) dynRow)
127+ where
128+ selectedIs m r = selected m == Just r
129+
130+rowW :: MonadWidget t m => Dynamic t Bool -> Dynamic t Row -> m (Event t (Model -> Model))
131+rowW dynSelected dynRow = elDynClass "tr" trClass $
132+ do
133+ elClass "td" "col-md-1". dynText $ pack . show . num <$> dynRow
134+ (sel, _) <- elClass' "td" "col-md-4". el "a" . dynText $ txt <$> dynRow
135+ (del, _) <- elClass' "td" "col-md-1" deleteW
136+ elClass "td" "col-md-6" blank
137+ pure $ mergeWith (.) $ zipWith tagClick [selectRow, deleteRow] [sel, del]
138+ where
139+ trClass = (\b -> if b then "danger" else "") <$> dynSelected
140+ tagClick f el = (tag . current) (f <$> dynRow) (domEvent Click el)
141+
142+
143+{- Domain logic -}
144+
145+clearRows :: Model -> Model
146+clearRows (Model {..}) = Model { table = empty, .. }
147+
148+updateRows :: (RowPosition -> Bool) -> (Text -> Text) -> Model -> Model
149+updateRows p f (Model {..}) = Model { table = (update <$> targets) <> table, .. }
150+ where
151+ targets = filterWithKey (const . p) table
152+ update = \(Row{..}) -> Row { txt = f txt, ..}
153+
154+swapRows :: (RowPosition, RowPosition) -> Model -> Model
155+swapRows (a,b) (Model {..}) = Model { table = (a =: val b) <> (b =: val a) <> table, .. }
156+ where val = (table !)
157+
158+selectRow, deleteRow :: Row -> Model -> Model
159+selectRow r m = m { selected = Just r }
160+deleteRow r (Model {..}) = Model { table = shifted table, .. }
161+ where
162+ shifted = fromList . zipWith update [0..] . elems . delete (pos r)
163+ update p (Row{..}) = (p, Row { pos = p, .. })
164+
165+createRows, appendRows :: Int -> Model -> Model
166+createRows = newRows False
167+appendRows = newRows True
168+
169+newRows :: Bool -> Int -> Model -> Model
170+newRows keepOld count (Model {..}) = Model { rng = rng', table = table', nextNum = nextNum', .. }
171+ where
172+ nextPos = if keepOld then length table else 0
173+ rowsST = sequence (rowST <$ [0..count-1])
174+ (rows, (nextPos', nextNum', rng')) = runState rowsST (nextPos, nextNum, rng)
175+ combine = if keepOld then (<>) else \_ new -> new
176+ table' = fromList . zip [0..] $ combine (elems table) rows
177+
178+rowST :: State (RowPosition, RowNumber, RNG) Row
179+rowST = state (\(p,n,g) -> let (e, g') = next g in (Row {pos = p, num = n, txt = randomName e}, (p+1,n+1,g')))
180+
181+randomName :: Entropy -> Text
182+randomName e = intercalate " " $ (!!% e) <$> [adjectives, colours, nouns]
183+ where xs !!% n = xs !! mod n (length xs)
184+
185+adjectives,colours,nouns :: [Text]
186+adjectives = ["pretty", "large", "big", "small", "tall", "short", "long", "handsome", "plain", "quaint", "clean", "elegant", "easy", "angry", "crazy", "helpful", "mushy", "odd", "unsightly", "adorable", "important", "inexpensive", "cheap", "expensive", "fancy"]
187+colours = ["red", "yellow", "blue", "green", "pink", "brown", "purple", "brown", "white", "black", "orange"]
188+nouns = ["table", "chair", "house", "bbq", "desk", "car", "pony", "cookie", "sandwich", "burger", "pizza", "mouse", "keyboard"]
189+
190+-}
reflex-dom/benchmarks/krausest.hsnew file+222
@@ -0,0 +1,222 @@
1+{-# LANGUAGE RecursiveDo #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# OPTIONS_GHC -fmax-simplifier-iterations=5 -ddump-simpl -ddump-to-file -dsuppress-coercions -dsuppress-idinfo #-}
6+import Control.Monad.State
7+import Data.Monoid
8+import Data.IntMap (IntMap, assocs, elems, empty, fromList, size, singleton)
9+import Data.Text (Text)
10+import qualified Data.Text as T
11+import Data.Vector (Vector)
12+import qualified Data.Vector as Vector
13+import Reflex.Dom
14+import Data.FastMutableIntMap
15+import System.Random
16+
17+type RNG = StdGen
18+type Entropy = Int
19+type RowNumber = Int
20+type RowIndex = Int
21+data Row = Row { num :: RowNumber, txt :: Text, selected :: Bool } deriving (Eq, Show)
22+type Table = IntMap Row
23+data Model = Model { rng :: RNG, nextNum :: RowNumber, selection :: Maybe Row } deriving Show
24+type TableDiff = PatchIntMap Row
25+
26+main :: IO ()
27+main = do
28+ seed <- randomIO
29+ mainWidgetWithHead' (\_ -> headW, \_ -> bodyW seed)
30+
31+titleW :: DomBuilder t m => m ()
32+titleW = text "Reflex-dom keyed"
33+
34+headW :: DomBuilder t m => m ()
35+headW = do
36+ el "title" titleW
37+ elAttr "link" ("href" =: "/css/currentStyle.css" <> "rel" =: "stylesheet") blank
38+
39+bodyW :: forall t m. (MonadFix m, MonadHold t m, DomBuilder t m) => Entropy -> m ()
40+bodyW seed = divClass "main" $ divClass "container" $ mdo
41+ buttonEvents <- divClass "jumbotron" $ divClass "row" $ do
42+ divClass "col-md-6" $ el "h1" titleW
43+ divClass "col-md-6" $ divClass "row" $ sequence
44+ [ buttonW "run" "Create 1,000 rows" $ resetRows 1000
45+ , buttonW "runlots" "Create 10,000 rows" $ resetRows 10000
46+ , buttonW "add" "Append 1,000 rows" $ appendRows 1000
47+ , buttonW "update" "Update every 10th row" $ updateRows (\i -> mod i 10 == 0) (<> " !!!")
48+ , buttonW "clear" "Clear" $ clearRows
49+ , buttonW "swaprows" "Swap Rows" $ swapRows (1, 998)
50+ ]
51+
52+ let initial = Model { rng = mkStdGen seed, nextNum = 1, selection = Nothing }
53+ let events = leftmost $ fmap (foldl1 sequenceSteps) rowEvents : buttonEvents
54+
55+ rowEvents <- tableW dynMT
56+
57+ dynMT <- mapAccum_ step (initial, empty) events
58+
59+ elAttr "span" ("class" =: "preloadicon glyphicon glyphicon-remove" <> "aria-hidden" =: "true") blank
60+
61+ blank
62+
63+type Step = (Model, Table) -> (Model, TableDiff)
64+
65+sequenceSteps :: Step -> Step -> Step
66+sequenceSteps a b (m, t) =
67+ let (ma, tda) = a (m, t)
68+ ta = applyAlways tda t
69+ (mb, tdb) = b (ma, ta)
70+ in (mb, tdb <> tda)
71+
72+step :: (Model, Table) -> Step -> ((Model, Table), TableDiff)
73+step (m, t) f = ((m', t'), dt)
74+ where
75+ (m', dt) = f (m, t)
76+ t' = applyAlways dt t
77+
78+buttonW :: DomBuilder t m => Text -> Text -> a -> m (Event t a)
79+buttonW id txt val = divClass "col-sm-6 smallpad" $ buttonW' ("class" =: "btn btn-primary btn-block" <> "id" =: id)
80+ where
81+ buttonW' attrs = do
82+ (b, _) <- elAttr' "button" attrs $ text txt
83+ pure $ val <$ domEvent Click b
84+
85+tableW :: (MonadHold t m, DomBuilder t m) => Event t TableDiff -> m (Event t (IntMap Step))
86+tableW diff = do
87+ elClass "table" "table table-hover table-striped test-data" $ do
88+ el "tbody" $ do
89+ (v0, v') <- traverseIntMapWithKeyWithAdjust (\_ -> rowW) empty diff
90+ rowEvents <- holdIncremental v0 v'
91+ return $ mergeIntIncremental rowEvents
92+
93+rowW :: DomBuilder t m => Row -> m (Event t Step)
94+rowW row = elClass "tr" (if selected row then "danger" else "") $
95+ do
96+ elClass "td" "col-md-1" $ do
97+ text $ T.pack $ show $ num row
98+ (sel, _) <- elClass' "td" "col-md-4". el "a" . text $ txt row
99+ (del, _) <- elClass' "td" "col-md-1" deleteW
100+ elClass "td" "col-md-6" blank
101+ pure . leftmost $ zipWith tagClick [selectRow, deleteRow] [sel, del]
102+ where
103+ tagClick f el = f row <$ (domEvent Click el)
104+
105+deleteW :: DomBuilder t m => m ()
106+deleteW = el "a" $ elAttr "span" ("aria-hidden" =: "true" <> "class" =: "glyphicon glyphicon-remove") blank
107+
108+
109+{- Domain logic -}
110+clearRows :: (Model, Table) -> (Model, TableDiff)
111+clearRows (m, t) = (m { selection = Nothing }, PatchIntMap $ Nothing <$ t)
112+
113+updateRows :: (RowIndex -> Bool) -> (Text -> Text) -> (Model, Table) -> (Model, TableDiff)
114+updateRows p f (m, t) = (m, PatchIntMap $ Just . update <$> targets)
115+ where
116+ targets = fromList . filterByIndex p . assocs $ t
117+ update = \r -> r { txt = f $ txt r }
118+
119+filterByIndex :: (Int -> Bool) -> [a] -> [a]
120+filterByIndex p = map snd . filter (\(i, _) -> p i) . zip [0..]
121+
122+swapRows :: (RowIndex, RowIndex) -> (Model, Table) -> (Model, TableDiff)
123+swapRows (a, b) (m, t) = (m, PatchIntMap $ if max a b < length t then swap else empty)
124+ where
125+ swap = point a b <> point b a
126+ point x y = singleton (fst (val x)) $ Just $ snd $ val y
127+ val = (assocs t !!)
128+
129+selectRow :: Row -> (Model, Table) -> (Model, TableDiff)
130+selectRow r (m, t) = (m { selection = Just r}, PatchIntMap $ dr <> ds)
131+ where
132+ dr = sel True r
133+ ds = maybe empty (sel False) $ selection m
134+ sel b r' = singleton (num r') $ Just r' { selected = b }
135+
136+deleteRow :: Row -> (Model, Table) -> (Model, TableDiff)
137+deleteRow r (m, t) = (m { selection = mfilter (/= r) (selection m) }, PatchIntMap $ singleton (num r) Nothing)
138+
139+resetRows :: Int -> (Model, Table) -> (Model, TableDiff)
140+resetRows n (m, t) = (m'', dt <> dt')
141+ where
142+ (m', dt ) = addRows n (m, t)
143+ (m'', dt') = clearRows (m', t)
144+
145+appendRows :: Int -> (Model, Table) -> (Model, TableDiff)
146+appendRows n (m, t) = addRows n (m, t)
147+
148+addRows :: Int -> (Model, Table) -> (Model, TableDiff)
149+addRows count (m, t) = (m { rng = rng', nextNum = nextNum' }, PatchIntMap diff)
150+ where
151+ rowsST = sequence (rowST <$ [0..count-1])
152+ (rows, (nextNum', rng')) = runState rowsST (nextNum m, rng m)
153+ diff = fromList . fmap (\r -> (num r, Just r)) $ rows
154+
155+rowST :: State (RowNumber, RNG) Row
156+rowST = state (\(n, g) -> let (e, g') = next g in (Row {num = n, txt = randomName e, selected = False}, (n+1, g')))
157+
158+randomName :: Entropy -> Text
159+randomName e = T.intercalate " " $ (`modIndex` e) <$> [adjectives, colours, nouns]
160+
161+-- | Index into a Vector, modulo its length
162+--
163+-- WARNING: The vector must have length >= 1, and the index must be >= 0.
164+modIndex :: Vector a -> Int -> a
165+modIndex v n = Vector.unsafeIndex v $ n `mod` Vector.length v
166+
167+adjectives, colours, nouns :: Vector Text
168+adjectives = Vector.fromList
169+ [ "pretty"
170+ , "large"
171+ , "big"
172+ , "small"
173+ , "tall"
174+ , "short"
175+ , "long"
176+ , "handsome"
177+ , "plain"
178+ , "quaint"
179+ , "clean"
180+ , "elegant"
181+ , "easy"
182+ , "angry"
183+ , "crazy"
184+ , "helpful"
185+ , "mushy"
186+ , "odd"
187+ , "unsightly"
188+ , "adorable"
189+ , "important"
190+ , "inexpensive"
191+ , "cheap"
192+ , "expensive"
193+ , "fancy"
194+ ]
195+colours = Vector.fromList
196+ [ "red"
197+ , "yellow"
198+ , "blue"
199+ , "green"
200+ , "pink"
201+ , "brown"
202+ , "purple"
203+ , "brown"
204+ , "white"
205+ , "black"
206+ , "orange"
207+ ]
208+nouns = Vector.fromList
209+ [ "table"
210+ , "chair"
211+ , "house"
212+ , "bbq"
213+ , "desk"
214+ , "car"
215+ , "pony"
216+ , "cookie"
217+ , "sandwich"
218+ , "burger"
219+ , "pizza"
220+ , "mouse"
221+ , "keyboard"
222+ ]
reflex-dom/cbits/MainWidget.cnew file+89
@@ -0,0 +1,89 @@
1+#include <jni.h>
2+#include <assert.h>
3+#include <stdlib.h>
4+#include <android/log.h>
5+#include <HaskellActivity.h>
6+#include "MainWidget.h"
7+
8+jobject Reflex_Dom_Android_MainWidget_start(jobject activity, const char *url, const JSaddleCallbacks *jsaddleCallbacks) {
9+ assert(activity);
10+ assert(url);
11+
12+ JNIEnv *env;
13+ jint attachResult = (*HaskellActivity_jvm)->AttachCurrentThread(HaskellActivity_jvm, &env, NULL);
14+ assert(attachResult == JNI_OK);
15+
16+ jclass cls = (*env)->FindClass(env, "org/reflexfrp/reflexdom/MainWidget");
17+ assert(cls);
18+ jmethodID startMainWidget = (*env)->GetStaticMethodID(env, cls, "startMainWidget", "(Lsystems/obsidian/HaskellActivity;Ljava/lang/String;JLjava/lang/String;)Ljava/lang/Object;");
19+ assert(startMainWidget);
20+
21+ jstring jurl = (*env)->NewStringUTF(env, url);
22+ assert(jurl);
23+ jstring initialJS = (*env)->NewStringUTF(env, jsaddleCallbacks->jsaddleJsData);
24+ jobject result = (*env)->CallStaticObjectMethod(env, cls, startMainWidget, activity, jurl, (jlong)jsaddleCallbacks, initialJS);
25+ (*env)->DeleteLocalRef(env, initialJS);
26+ if((*env)->ExceptionOccurred(env)) {
27+ __android_log_write(ANDROID_LOG_DEBUG, "MainWidget", "startMainWidget exception");
28+ (*env)->ExceptionDescribe(env);
29+ }
30+ return (*env)->NewGlobalRef(env, result);
31+}
32+
33+void Reflex_Dom_Android_MainWidget_runJS(jobject jsExecutor, const char* js, size_t js_len) {
34+ JNIEnv *env;
35+ jint attachResult = (*HaskellActivity_jvm)->AttachCurrentThread(HaskellActivity_jvm, &env, NULL);
36+ assert (attachResult == JNI_OK);
37+
38+ (*env)->PushLocalFrame(env, 5);
39+
40+ //TODO: Don't search for this method every time
41+ jclass cls = (*env)->GetObjectClass(env, jsExecutor);
42+ assert(cls);
43+ jmethodID evaluateJavascript = (*env)->GetMethodID(env, cls, "evaluateJavascript", "([B)V");
44+ assert(evaluateJavascript);
45+ jbyteArray js_str = (*env)->NewByteArray(env, js_len);
46+ (*env)->SetByteArrayRegion(env, js_str, 0, js_len, (const jbyte*)js);
47+ (*env)->CallVoidMethod(env, jsExecutor, evaluateJavascript, js_str, 0);
48+ if((*env)->ExceptionOccurred(env)) {
49+ __android_log_write(ANDROID_LOG_DEBUG, "MainWidget", "runJS exception");
50+ (*env)->ExceptionDescribe(env);
51+ }
52+
53+ (*env)->PopLocalFrame(env, 0);
54+}
55+
56+JNIEXPORT void JNICALL Java_org_reflexfrp_reflexdom_MainWidget_00024JSaddleCallbacks_startProcessing (JNIEnv *env, jobject thisObj, jlong callbacksLong) {
57+ const JSaddleCallbacks *callbacks = (const JSaddleCallbacks *)callbacksLong;
58+ (*(callbacks->jsaddleStart))();
59+ return;
60+}
61+
62+JNIEXPORT void JNICALL Java_org_reflexfrp_reflexdom_MainWidget_00024JSaddleCallbacks_processMessage (JNIEnv *env, jobject thisObj, jlong callbacksLong, jbyteArray msg) {
63+ const JSaddleCallbacks *callbacks = (const JSaddleCallbacks *)callbacksLong;
64+
65+ jbyte *msg_str = (*env)->GetByteArrayElements(env, msg, NULL);
66+ jsize msg_str_len = (*env)->GetArrayLength(env, msg);
67+ (*(callbacks->jsaddleResult))(msg_str, msg_str_len);
68+ (*env)->ReleaseByteArrayElements(env, msg, msg_str, JNI_ABORT);
69+ return;
70+}
71+
72+JNIEXPORT jbyteArray JNICALL Java_org_reflexfrp_reflexdom_MainWidget_00024JSaddleCallbacks_processSyncMessage (JNIEnv *env, jobject thisObj, jlong callbacksLong, jbyteArray msg) {
73+ const JSaddleCallbacks *callbacks = (const JSaddleCallbacks *)callbacksLong;
74+
75+ char const *next_str;
76+ size_t next_str_len;
77+
78+ jbyte *msg_str = (*env)->GetByteArrayElements(env, msg, NULL);
79+ jsize msg_str_len = (*env)->GetArrayLength(env, msg);
80+ (*(callbacks->jsaddleSyncResult))(msg_str, msg_str_len, &next_str, &next_str_len);
81+ (*env)->ReleaseByteArrayElements(env, msg, msg_str, JNI_ABORT);
82+
83+ jbyteArray next_jstr = (*env)->NewByteArray(env, next_str_len);
84+ (*env)->SetByteArrayRegion(env, next_jstr, 0, next_str_len, next_str);
85+
86+ free(next_str);
87+
88+ return next_jstr;
89+}
reflex-dom/cbits/include/MainWidget.hnew file+13
@@ -0,0 +1,13 @@
1+#ifndef MAINWIDGET_H_INCLUDED
2+#define MAINWIDGET_H_INCLUDED
3+
4+#include <stddef.h>
5+
6+typedef struct JSaddleCallbacks {
7+ void (* jsaddleStart) ();
8+ void (* jsaddleResult) (const char *, size_t);
9+ void (* jsaddleSyncResult) (const char *, size_t, const char**, size_t*);
10+ char * jsaddleJsData;
11+} JSaddleCallbacks;
12+
13+#endif
reflex-dom/default.nixdeleted−18
@@ -1,18 +0,0 @@
1−{ mkDerivation, base, bytestring, jsaddle-webkit2gtk, jsaddle-wkwebview, reflex
2−, reflex-dom-core, stdenv, text, ghc
3−}:
4−mkDerivation {
5− pname = "reflex-dom";
6− version = "0.4";
7− src = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [ ".git" "dist" ])) ./.;
8− libraryHaskellDepends = [
9− base bytestring reflex reflex-dom-core text
10− ] ++ (if ghc.isGhcjs or false then [
11− ] else if stdenv.isDarwin then [
12− jsaddle-wkwebview
13− ] else [
14− jsaddle-webkit2gtk
15− ]);
16− description = "Functional Reactive Web Apps with Reflex";
17− license = stdenv.lib.licenses.bsd3;
18−}
reflex-dom/examples/sortableList.hs+1−1
@@ -67,7 +67,7 @@ displayRedrawTime e = do
6767 text "Time: "
6868 dynText =<< holdDyn "not yet run" (T.pack . show <$> diff)
6969
70−simpleSortableList :: forall t m k v. (MonadHold t m, MonadFix m, MonadAdjust t m, Ord k) => (k -> v -> m ()) -> Map k v -> Event t (v -> v -> Ordering) -> Event t (v -> v -> Ordering) -> m ()
70+simpleSortableList :: forall t m k v. (MonadHold t m, MonadFix m, Adjustable t m, Ord k) => (k -> v -> m ()) -> Map k v -> Event t (v -> v -> Ordering) -> Event t (v -> v -> Ordering) -> m ()
7171simpleSortableList f m0 resortFunc resortSlowFunc = do
7272 rec let resortPatchFast = attachWith (flip patchThatSortsMapWith) (currentIncremental m) resortFunc
7373 redrawPatch :: Map k v -> (v -> v -> Ordering) -> PatchMapWithMove k v
reflex-dom/java/org/reflexfrp/reflexdom/MainWidget.javanew file+195
@@ -0,0 +1,195 @@
1+package org.reflexfrp.reflexdom;
2+
3+import android.annotation.TargetApi;
4+import android.net.Uri;
5+import android.os.Build;
6+import android.os.Handler;
7+import android.util.Log;
8+import android.view.ViewGroup.LayoutParams;
9+import android.view.Window;
10+import android.webkit.CookieManager;
11+import android.webkit.GeolocationPermissions;
12+import android.webkit.JavascriptInterface;
13+import android.webkit.MimeTypeMap;
14+import android.webkit.PermissionRequest;
15+import android.webkit.WebChromeClient;
16+import android.webkit.WebResourceRequest;
17+import android.webkit.WebResourceResponse;
18+import android.webkit.WebSettings;
19+import android.webkit.WebView;
20+import android.webkit.WebViewClient;
21+import android.graphics.Bitmap;
22+import java.io.IOException;
23+import java.io.InputStream;
24+import android.content.Intent;
25+import android.content.ActivityNotFoundException;
26+import java.util.concurrent.atomic.AtomicBoolean;
27+
28+import java.nio.charset.StandardCharsets;
29+
30+import systems.obsidian.HaskellActivity;
31+
32+public class MainWidget {
33+ private static Object startMainWidget(final HaskellActivity a, String url, long jsaddleCallbacks, final String initialJS) {
34+ CookieManager.setAcceptFileSchemeCookies(true); //TODO: Can we do this just for our own WebView?
35+
36+ // Remove title and notification bars
37+ a.requestWindowFeature(Window.FEATURE_NO_TITLE);
38+
39+ final WebView wv = new WebView(a);
40+ wv.setLayoutParams(new LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT));
41+ a.setContentView(wv);
42+ final WebSettings ws = wv.getSettings();
43+ ws.setJavaScriptEnabled(true);
44+ ws.setAllowFileAccessFromFileURLs(true);
45+ ws.setAllowUniversalAccessFromFileURLs(true);
46+ ws.setDomStorageEnabled(true);
47+ wv.setWebContentsDebuggingEnabled(true);
48+ // allow video to play without user interaction
49+ wv.getSettings().setMediaPlaybackRequiresUserGesture(false);
50+ final AtomicBoolean jsaddleLoaded = new AtomicBoolean(false);
51+
52+ wv.setWebViewClient(new WebViewClient() {
53+ @Override
54+ public void onPageFinished(WebView _view, String _url) {
55+ Log.i("reflex", "onPageFinished");
56+ boolean alreadyLoaded = jsaddleLoaded.getAndSet(true);
57+ if(!alreadyLoaded) {
58+ Log.i("reflex", "loading jsaddle");
59+ wv.evaluateJavascript(initialJS, null);
60+ }
61+ }
62+
63+ // Re-route / to /android_asset
64+ @Override
65+ public WebResourceResponse shouldInterceptRequest (WebView view, WebResourceRequest request) {
66+ Uri uri = request.getUrl();
67+ if(!uri.getScheme().equals("file"))
68+ return null;
69+
70+ String path = uri.getPath();
71+ path = getAssetPath(path);
72+
73+ String mimeType = getMimeType(uri.toString());
74+ String encoding = "";
75+
76+ try {
77+ InputStream data = a.getApplicationContext().getAssets().open(path);
78+ return new WebResourceResponse(mimeType, encoding, data);
79+ }
80+ catch (IOException e) {
81+ Log.i("reflex", "Opening resource failed, Webview will handle the request ..");
82+ e.printStackTrace();
83+ }
84+
85+ return null;
86+ }
87+
88+ @Override
89+ public boolean shouldOverrideUrlLoading(WebView view, String url) {
90+ if( url != null && !url.startsWith("http://") && !url.startsWith("https://") && !url.startsWith("file://")) {
91+ try {
92+ view.getContext().startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(url)));
93+ }
94+ catch(ActivityNotFoundException e) {
95+ Log.e("reflex", "Starting activity for intent '" + url + "' failed!");
96+ }
97+ return true;
98+ } else {
99+ return false;
100+ }
101+ }
102+ });
103+
104+ wv.setWebChromeClient(new WebChromeClient() {
105+ // Need to accept permissions to use the camera and audio
106+ @Override
107+ public void onPermissionRequest(final PermissionRequest request) {
108+ if(request.getOrigin().toString().startsWith("file://")) {
109+ a.requestWebViewPermissions(request);
110+ }
111+ else {
112+ a.runOnUiThread(new Runnable() {
113+ @TargetApi(Build.VERSION_CODES.LOLLIPOP)
114+ @Override
115+ public void run() {
116+ request.deny();
117+ }
118+ });
119+ }
120+ }
121+
122+ @Override
123+ public Bitmap getDefaultVideoPoster() {
124+ return Bitmap.createBitmap(10, 10, Bitmap.Config.ARGB_8888);
125+ }
126+
127+ @Override
128+ public void onGeolocationPermissionsShowPrompt(String origin, GeolocationPermissions.Callback callback) {
129+ callback.invoke(origin, true, false);
130+ }
131+ });
132+
133+ wv.addJavascriptInterface(new JSaddleCallbacks(jsaddleCallbacks), "jsaddle");
134+
135+ wv.loadUrl(url);
136+
137+ final Handler hnd = new Handler();
138+ return new Object() {
139+ public final void evaluateJavascript(final byte[] js) {
140+ final String jsStr = new String(js, StandardCharsets.UTF_8);
141+ hnd.post(new Runnable() {
142+ @Override
143+ public void run() {
144+ wv.evaluateJavascript(jsStr, null);
145+ }
146+ });
147+ }
148+ };
149+ }
150+
151+ private static String getMimeType(String url) {
152+ String type = "";
153+ String extension = MimeTypeMap.getFileExtensionFromUrl(url);
154+ if (extension != null) {
155+ type = MimeTypeMap.getSingleton().getMimeTypeFromExtension(extension);
156+ }
157+ return type;
158+ }
159+
160+ /** Get the path of an asset. Strips leading / and leading /android_asset/ */
161+ private static String getAssetPath(String path) {
162+ path = path.startsWith("/android_asset") ? path.substring("/android_asset".length()) : path;
163+ path = path.startsWith("/") ? path.substring(1) : path;
164+ return path;
165+ }
166+
167+ private static class JSaddleCallbacks {
168+ private final long callbacks;
169+ private native void startProcessing(long callbacks);
170+ private native void processMessage(long callbacks, byte[] msg);
171+ private native byte[] processSyncMessage(long callbacks, byte[] msg);
172+
173+ public JSaddleCallbacks(long _callbacks) {
174+ callbacks = _callbacks;
175+ }
176+
177+ @JavascriptInterface
178+ public boolean postReady() {
179+ startProcessing(callbacks);
180+ return true;
181+ }
182+
183+ @JavascriptInterface
184+ public boolean postMessage(final String msg) {
185+ processMessage(callbacks, msg.getBytes(StandardCharsets.UTF_8));
186+ return true;
187+ }
188+
189+ @JavascriptInterface
190+ public String syncMessage(final String msg) {
191+ return new String(processSyncMessage(callbacks, msg.getBytes(StandardCharsets.UTF_8)),
192+ StandardCharsets.UTF_8);
193+ }
194+ }
195+}
reflex-dom/reflex-dom.cabal+124−22
@@ -1,7 +1,20 @@
1+cabal-version: 1.24
12Name: reflex-dom
2−Version: 0.4
3+Version: 0.6.1.0
34Synopsis: Functional Reactive Web Apps with Reflex
4−Description: Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine
5+Description:
6+ Web applications without callbacks or side-effects.
7+ Reflex-DOM brings the power of functional reactive programming (FRP) to the web.
8+ Build HTML and other Document Object Model (DOM) data with a pure functional interface.
9+ .
10+ Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine: <https://reflex-frp.org/>.
11+ .
12+ The @reflex-dom@ package is a small wrapper around the @reflex-dom-core@ package. It pulls in the
13+ correct set of dependencies for each target platform (GHCJS, WebKitGTK, WASM, mobile, etc.).
14+ Libraries should depend on @reflex-dom-core@ and executables will usually depend on @reflex-dom@.
15+ All of @reflex-dom-core@'s modules are re-exported by @reflex-dom@.
16+ .
17+ For Hackage documentation, please see: <https://hackage.haskell.org/package/reflex-dom-core>.
518License: BSD3
619License-file: LICENSE
720Author: Ryan Trinkle
@@ -9,12 +22,14 @@ Maintainer: ryan.trinkle@gmail.com
922Stability: Experimental
1023Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
1124Build-type: Simple
12−cabal-version: >=1.24
13−-- Deal with https://github.com/haskell/cabal/issues/2544 / https://github.com/haskell/cabal/issues/367
14−extra-source-files: src/Reflex/Dom/Xhr/Foreign.hs
15− src/Reflex/Dom/WebSocket/Foreign.hs
16− src/Reflex/Dom/Xhr/ResponseType.hs
17− src/Reflex/Dom/Xhr/Exception.hs
25+extra-source-files:
26+ java/org/reflexfrp/reflexdom/MainWidget.java
27+ ChangeLog.md
28+
29+flag use-warp
30+ description: Use jsaddle-warp server
31+ default: False
32+ manual: True
1833
1934flag webkit2gtk
2035 description: Use WebKit2 version of WebKitGTK.
@@ -35,34 +50,67 @@ flag build-examples
3550 default: False
3651 manual: True
3752
53+flag wasm32
54+ description: Build for wasm32 architecture
55+ default: False
56+ manual: True
57+
3858library
3959 hs-source-dirs: src
60+ if os(android)
61+ hs-source-dirs: src-android
62+ other-modules: Reflex.Dom.Android.MainWidget
63+ build-depends:
64+ aeson >= 1.4 && < 1.6,
65+ android-activity == 0.1.*,
66+ data-default == 0.7.*,
67+ jsaddle >= 0.9.6 && < 0.10
68+ c-sources: cbits/MainWidget.c
69+ include-dirs: cbits/include
70+ install-includes: MainWidget.h
71+ cpp-options: -DANDROID
72+ build-tools: hsc2hs
4073 build-depends:
41− base >= 4.7 && < 4.11,
74+ base >= 4.7 && < 4.15,
4275 bytestring == 0.10.*,
43− reflex == 0.5.*,
44− reflex-dom-core >=0.4 && <0.5,
76+ reflex >= 0.8 && < 0.9,
77+ reflex-dom-core >= 0.6.1.0 && <0.7,
4578 text == 1.2.*
4679 if !impl(ghcjs)
47− if os(osx) || os(ios)
80+ if flag(use-warp) && (os(linux) || os(osx))
4881 build-depends:
49− jsaddle-wkwebview
82+ jsaddle >= 0.9.6 && < 0.10,
83+ jsaddle-warp >= 0.9.6 && < 0.10
5084 else
51− if flag(webkit2gtk)
85+ if os(osx) || os(ios)
5286 build-depends:
53− jsaddle-webkit2gtk
87+ data-default == 0.7.*,
88+ jsaddle >= 0.9.6 && < 0.10,
89+ jsaddle-wkwebview >= 0.9.6 && < 0.10
5490 else
55− build-depends:
56− jsaddle-webkitgtk
91+ if flag(wasm32)
92+ build-depends:
93+ jsaddle >= 0.9.6 && < 0.10,
94+ jsaddle-wasm >= 0.1 && < 0.2
95+ else
96+ if flag(webkit2gtk)
97+ build-depends:
98+ jsaddle-webkit2gtk >= 0.9.6 && < 0.10
99+ else
100+ if !os(android)
101+ build-depends:
102+ jsaddle-webkit2gtk >= 0.9.6 && < 0.10
57103
58104 exposed-modules:
59105 Reflex.Dom
60106 Reflex.Dom.Internal
61107 reexported-modules:
62− Foreign.JavaScript.TH
63− , Foreign.JavaScript.Orphans
108+ Foreign.JavaScript.Orphans
109+ , Foreign.JavaScript.TH
110+ , Foreign.JavaScript.Utils
64111 , Reflex.Dom.Builder.Class
65112 , Reflex.Dom.Builder.Class.Events
113+ , Reflex.Dom.Builder.Hydratable
66114 , Reflex.Dom.Builder.Immediate
67115 , Reflex.Dom.Builder.InputDisabled
68116 , Reflex.Dom.Builder.Static
@@ -70,17 +118,25 @@ library
70118 , Reflex.Dom.Core
71119 , Reflex.Dom.Location
72120 , Reflex.Dom.Main
121+ , Reflex.Dom.Modals.Class
73122 , Reflex.Dom.Old
123+ , Reflex.Dom.Prerender
74124 , Reflex.Dom.Time
75125 , Reflex.Dom.WebSocket
126+ , Reflex.Dom.WebSocket.Query
76127 , Reflex.Dom.Widget
77128 , Reflex.Dom.Widget.Basic
78129 , Reflex.Dom.Widget.Input
79130 , Reflex.Dom.Widget.Lazy
80131 , Reflex.Dom.Widget.Resize
81132 , Reflex.Dom.Xhr
82−
133+ , Reflex.Dom.Xhr.FormData
83134 ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
135+ if flag(expose-all-unfoldings)
136+ ghc-options: -fexpose-all-unfoldings
137+ if flag(use-reflex-optimizer)
138+ ghc-options: -fplugin=Reflex.Optimizer
139+ default-language: Haskell2010
84140
85141executable sortableList
86142 build-depends: base
@@ -96,14 +152,60 @@ executable sortableList
96152 , transformers
97153 hs-source-dirs: examples
98154 main-is: sortableList.hs
99− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
100− ghc-prof-options: -fprof-auto
155+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
101156 if !flag(build-examples)
102157 buildable: False
103158 if flag(expose-all-unfoldings)
104159 ghc-options: -fexpose-all-unfoldings
105160 if flag(use-reflex-optimizer)
106161 ghc-options: -fplugin=Reflex.Optimizer
162+ default-language: Haskell2010
163+
164+executable benchmark
165+ build-depends: base
166+ , containers
167+ , dependent-map
168+ , dependent-sum
169+ , ghc-prim
170+ , ghcjs-dom
171+ , mtl
172+ , prim-uniq
173+ , random
174+ , reflex
175+ , reflex-dom
176+ , text
177+ , transformers
178+ hs-source-dirs: .
179+ main-is: benchmark.hs
180+ ghc-options: -O2 -fspecialise-aggressively
181+ if !impl(ghcjs)
182+ buildable: False
183+ default-language: Haskell2010
184+
185+executable krausest
186+ build-depends: base
187+ , containers
188+ , dependent-map
189+ , dependent-sum
190+ , ghc-prim
191+ , ghcjs-dom
192+ , mtl
193+ , prim-uniq
194+ , random
195+ , reflex
196+ , reflex-dom
197+ , text
198+ , transformers
199+ , vector
200+ hs-source-dirs: benchmarks
201+ main-is: krausest.hs
202+ ghc-options: -O2 -fspecialise-aggressively
203+ if impl(ghcjs)
204+ ghcjs-options: -dedupe
205+ cpp-options: -DGHCJS_BROWSER -DGHCJS_GC_INTERVAL=60000
206+ else
207+ buildable: False
208+ default-language: Haskell2010
107209
108210source-repository head
109211 type: git
reflex-dom/src-android/Reflex/Dom/Android/MainWidget.hscnew file+117
@@ -0,0 +1,117 @@
1+{-# LANGUAGE ForeignFunctionInterface #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+module Reflex.Dom.Android.MainWidget
4+ ( startMainWidget
5+ ) where
6+
7+import Android.HaskellActivity
8+import Control.Concurrent
9+import Control.Monad
10+import Data.Aeson
11+import Data.ByteString (ByteString)
12+import qualified Data.ByteString as BS
13+import qualified Data.ByteString.Lazy as LBS
14+import qualified Data.ByteString.Unsafe as BSU
15+import Data.IORef
16+import Data.Monoid
17+import Foreign.C.String
18+import Foreign.C.Types
19+import Foreign.Marshal.Utils
20+import Foreign.Marshal.Array
21+import Foreign.Ptr
22+import Foreign.Storable
23+import Language.Javascript.JSaddle (JSM)
24+import Language.Javascript.JSaddle.Run (runJavaScript)
25+import Language.Javascript.JSaddle.Run.Files (initState, runBatch, ghcjsHelpers)
26+
27+#include "MainWidget.h"
28+
29+
30+startMainWidget :: HaskellActivity -> ByteString -> JSM () -> IO ()
31+startMainWidget a url jsm = do
32+ --TODO: Find a way to eventually release this
33+ executorRef <- newIORef $ error "startMainWidget: executor not created yet"
34+ let go batch = do
35+ executor <- readIORef executorRef
36+ BSU.unsafeUseAsCStringLen (LBS.toStrict $ "runJSaddleBatch(" <> encode batch <> ");") $ \(cstr, len) -> do
37+ runJS executor cstr (fromIntegral len)
38+ (processResult, processSyncResult, start) <- runJavaScript go jsm
39+ callbacks <- new <=< jsaddleCallbacksToPtrs $ JSaddleCallbacks
40+ { _jsaddleCallbacks_jsaddleStart = void $ forkIO start
41+ , _jsaddleCallbacks_jsaddleResult = \s -> do
42+ case decode $ LBS.fromStrict s of
43+ Nothing -> error $ "jsaddle message decode failed: " <> show s
44+ Just r -> processResult r
45+ , _jsaddleCallbacks_jsaddleSyncResult = \s -> do
46+ case decode $ LBS.fromStrict s of
47+ Nothing -> error $ "jsaddle message decode failed: " <> show s
48+ Just r -> LBS.toStrict . encode <$> processSyncResult r
49+ , _jsaddleCallbacks_jsaddleJsData = LBS.toStrict $ ghcjsHelpers <> "\
50+ \runJSaddleBatch = (function() {\n\
51+ \ " <> initState <> "\n\
52+ \ return function(batch) {\n\
53+ \ " <> runBatch (\a -> "jsaddle.postMessage(JSON.stringify(" <> a <> "));")
54+ (Just (\a -> "JSON.parse(jsaddle.syncMessage(JSON.stringify(" <> a <> ")))")) <> "\
55+ \ };\n\
56+ \})();\n\
57+ \jsaddle.postReady();\n"
58+ }
59+ BS.useAsCString url $ \curl -> do
60+ writeIORef executorRef =<< startMainWidget_ a curl callbacks
61+
62+newtype JSExecutor = JSExecutor { unJSExecutor :: Ptr JSExecutor }
63+
64+foreign import ccall safe "Reflex_Dom_Android_MainWidget_start" startMainWidget_ :: HaskellActivity -> CString -> Ptr JSaddleCallbacksPtrs -> IO JSExecutor
65+
66+foreign import ccall safe "Reflex_Dom_Android_MainWidget_runJS" runJS :: JSExecutor -> CString -> CSize -> IO ()
67+
68+data JSaddleCallbacks = JSaddleCallbacks
69+ { _jsaddleCallbacks_jsaddleStart :: IO ()
70+ , _jsaddleCallbacks_jsaddleResult :: ByteString -> IO ()
71+ , _jsaddleCallbacks_jsaddleSyncResult :: ByteString -> IO ByteString
72+ , _jsaddleCallbacks_jsaddleJsData :: ByteString
73+ }
74+
75+data JSaddleCallbacksPtrs = JSaddleCallbacksPtrs
76+ { _jsaddleCallbacksPtrs_jsaddleStart :: !(FunPtr (IO ()))
77+ , _jsaddleCallbacksPtrs_jsaddleResult :: !(FunPtr (CString -> CSize -> IO ()))
78+ , _jsaddleCallbacksPtrs_jsaddleSyncResult :: !(FunPtr (CString -> CSize -> Ptr CString -> Ptr CSize -> IO ()))
79+ , _jsaddleCallbacksPtrs_jsaddleJsData :: !CString
80+ }
81+
82+foreign import ccall "wrapper" wrapIO :: IO () -> IO (FunPtr (IO ()))
83+foreign import ccall "wrapper" wrapCStringCSizeIO :: (CString -> CSize -> IO ()) -> IO (FunPtr (CString -> CSize -> IO ()))
84+foreign import ccall "wrapper" wrapCStringCSizeCStringCSizeIO :: (CString -> CSize -> Ptr CString -> Ptr CSize -> IO ()) -> IO (FunPtr (CString -> CSize -> Ptr CString -> Ptr CSize -> IO ()))
85+
86+newCStringFromByteString :: ByteString -> IO (CString, CSize)
87+newCStringFromByteString bs = BSU.unsafeUseAsCStringLen bs $ \(src, len) -> do
88+ dest <- mallocArray0 len
89+ copyArray dest src len
90+ poke (advancePtr dest len) 0
91+ return (dest, fromIntegral len)
92+
93+jsaddleCallbacksToPtrs :: JSaddleCallbacks -> IO JSaddleCallbacksPtrs
94+jsaddleCallbacksToPtrs jc = JSaddleCallbacksPtrs
95+ <$> wrapIO (_jsaddleCallbacks_jsaddleStart jc)
96+ <*> wrapCStringCSizeIO (\cstr len -> _jsaddleCallbacks_jsaddleResult jc =<< BS.packCStringLen (cstr, fromIntegral len))
97+ <*> wrapCStringCSizeCStringCSizeIO (\cstr len result resultLen -> do
98+ inStr <- BS.packCStringLen (cstr, fromIntegral len)
99+ outStr <- _jsaddleCallbacks_jsaddleSyncResult jc inStr
100+ (outStrBytes, outStrLen) <- newCStringFromByteString outStr
101+ poke result outStrBytes
102+ poke resultLen outStrLen)
103+ <*> (fst <$> newCStringFromByteString (_jsaddleCallbacks_jsaddleJsData jc))
104+
105+instance Storable JSaddleCallbacksPtrs where
106+ sizeOf _ = #{size JSaddleCallbacks}
107+ alignment _ = #{alignment JSaddleCallbacks}
108+ poke p jc = do
109+ #{poke JSaddleCallbacks, jsaddleStart} p $ _jsaddleCallbacksPtrs_jsaddleStart jc
110+ #{poke JSaddleCallbacks, jsaddleResult} p $ _jsaddleCallbacksPtrs_jsaddleResult jc
111+ #{poke JSaddleCallbacks, jsaddleSyncResult} p $ _jsaddleCallbacksPtrs_jsaddleSyncResult jc
112+ #{poke JSaddleCallbacks, jsaddleJsData} p $ _jsaddleCallbacksPtrs_jsaddleJsData jc
113+ peek p = JSaddleCallbacksPtrs
114+ <$> #{peek JSaddleCallbacks, jsaddleStart} p
115+ <*> #{peek JSaddleCallbacks, jsaddleResult} p
116+ <*> #{peek JSaddleCallbacks, jsaddleSyncResult} p
117+ <*> #{peek JSaddleCallbacks, jsaddleJsData} p
reflex-dom/src/Reflex/Dom.hs+6−1
@@ -1,6 +1,11 @@
1+-- Disable haddocks on this module due to a bug on haddocks when selectively
2+-- reexporting on ghc > 8.2.
3+-- https://github.com/haskell/haddock/issues/979
4+{-# OPTIONS_HADDOCK hide, prune, ignore-exports #-}
15module Reflex.Dom (module X) where
26
37import Foreign.JavaScript.Orphans ()
48import Reflex.Dom.Core as X hiding (mainWidget, mainWidgetInElementById, mainWidgetWithCss,
5− mainWidgetWithHead, mainWidgetWithHead', runApp')
9+ mainWidgetWithHead, mainWidgetWithHead', runApp',
10+ mainHydrationWidgetWithHead, mainHydrationWidgetWithHead')
611import Reflex.Dom.Internal as X
reflex-dom/src/Reflex/Dom/Internal.hs+79−7
@@ -1,26 +1,90 @@
11{-# LANGUAGE CPP #-}
2+{-# LANGUAGE LambdaCase #-}
3+{-# LANGUAGE OverloadedStrings #-}
24{-# LANGUAGE RankNTypes #-}
35{-# LANGUAGE TypeFamilies #-}
46module Reflex.Dom.Internal
5− (module Main, run, mainWidget, mainWidgetWithHead, mainWidgetWithCss,
6− mainWidgetWithHead', mainWidgetInElementById, runApp') where
7+ ( module Main
8+ , run
9+ , mainWidget
10+ , mainWidgetWithHead, mainWidgetWithCss, mainWidgetWithHead', mainWidgetInElementById, runApp'
11+ , mainHydrationWidgetWithHead, mainHydrationWidgetWithHead'
12+ ) where
713
814import Data.ByteString (ByteString)
915import Data.Text (Text)
10−import Reflex.Spider (Spider)
1116import Reflex.Dom.Core (Widget)
1217import Reflex.Dom.Main as Main hiding
1318 (mainWidget, mainWidgetWithHead, mainWidgetWithCss,
14− mainWidgetWithHead', mainWidgetInElementById, runApp')
19+ mainWidgetWithHead', mainWidgetInElementById, runApp',
20+ mainHydrationWidgetWithHead, mainHydrationWidgetWithHead')
1521import qualified Reflex.Dom.Main as Main
1622 (mainWidget, mainWidgetWithHead, mainWidgetWithCss,
17− mainWidgetWithHead', mainWidgetInElementById, runApp')
23+ mainWidgetWithHead', mainWidgetInElementById, runApp',
24+ mainHydrationWidgetWithHead, mainHydrationWidgetWithHead')
1825
1926#if defined(ghcjs_HOST_OS)
2027run :: a -> a
2128run = id
29+#elif defined(MIN_VERSION_jsaddle_warp)
30+import Data.Maybe (maybe)
31+import Data.Monoid ((<>))
32+import Language.Javascript.JSaddle (JSM)
33+import qualified Language.Javascript.JSaddle.Warp as JW
34+import System.Environment (lookupEnv)
35+
36+run :: JSM () -> IO()
37+run jsm = do
38+ port <- maybe 3003 read <$> lookupEnv "JSADDLE_WARP_PORT"
39+ putStrLn $ "Running jsaddle-warp server on port " <> show port
40+ JW.run port jsm
2241#elif defined(MIN_VERSION_jsaddle_wkwebview)
42+#if defined(ios_HOST_OS)
43+import Data.Default
44+import Data.Monoid ((<>))
45+import Language.Javascript.JSaddle (JSM)
46+import Language.Javascript.JSaddle.WKWebView (run', mainBundleResourcePath)
47+import Language.Javascript.JSaddle.WKWebView.Internal (jsaddleMainHTMLWithBaseURL)
48+
49+-- TODO: upstream to jsaddle-wkwebview
50+run :: JSM () -> IO ()
51+run jsm = do
52+ let indexHtml = "<!DOCTYPE html><html><head></head><body></body></html>"
53+ baseUrl <- mainBundleResourcePath >>= \case
54+ Nothing -> do
55+ putStrLn "Reflex.Dom.run: unable to find main bundle resource path. Assets may not load properly."
56+ return ""
57+ Just p -> return $ "file://" <> p <> "/index.html"
58+ run' def $ jsaddleMainHTMLWithBaseURL indexHtml baseUrl jsm
59+#else
2360import Language.Javascript.JSaddle.WKWebView (run)
61+#endif
62+#elif defined(ANDROID)
63+import Android.HaskellActivity
64+import Control.Monad
65+import Control.Concurrent
66+import Data.Default
67+import Data.String
68+import Reflex.Dom.Android.MainWidget
69+import System.IO
70+import Language.Javascript.JSaddle (JSM)
71+
72+run :: JSM () -> IO ()
73+run jsm = do
74+ hSetBuffering stdout LineBuffering
75+ hSetBuffering stderr LineBuffering
76+ continueWithCallbacks $ def
77+ { _activityCallbacks_onCreate = \_ -> do
78+ a <- getHaskellActivity
79+ let startPage = fromString "file:///android_asset/index.html"
80+ startMainWidget a startPage jsm
81+ }
82+ forever $ threadDelay 1000000000
83+#elif defined(wasm32_HOST_ARCH)
84+import qualified Language.Javascript.JSaddle.Wasm as Wasm (run)
85+import Language.Javascript.JSaddle (JSM)
86+run :: JSM () -> IO ()
87+run = Wasm.run 0
2488#else
2589import Language.Javascript.JSaddle.WebKitGTK (run)
2690#endif
@@ -37,7 +101,7 @@ mainWidgetWithCss :: ByteString -> (forall x. Widget x ()) -> IO ()
37101mainWidgetWithCss css w = run $ Main.mainWidgetWithCss css w
38102{-# INLINE mainWidgetWithCss #-}
39103
40−mainWidgetWithHead' :: (forall x. (a -> Widget x b, b -> Widget x a)) -> IO ()
104+mainWidgetWithHead' :: (a -> Widget () b, b -> Widget () a) -> IO ()
41105mainWidgetWithHead' w = run $ Main.mainWidgetWithHead' w
42106{-# INLINE mainWidgetWithHead' #-}
43107
@@ -45,6 +109,14 @@ mainWidgetInElementById :: Text -> (forall x. Widget x ()) -> IO ()
45109mainWidgetInElementById eid w = run $ Main.mainWidgetInElementById eid w
46110{-# INLINE mainWidgetInElementById #-}
47111
48−runApp' :: (t ~ Spider) => (forall x. AppInput t -> Widget x (AppOutput t)) -> IO ()
112+runApp' :: (forall x. AppInput DomTimeline -> Widget x (AppOutput DomTimeline)) -> IO ()
49113runApp' app = run $ Main.runApp' app
50114{-# INLINE runApp' #-}
115+
116+mainHydrationWidgetWithHead :: (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> IO ()
117+mainHydrationWidgetWithHead h b = run $ Main.mainHydrationWidgetWithHead h b
118+{-# INLINE mainHydrationWidgetWithHead #-}
119+
120+mainHydrationWidgetWithHead' :: HydrationWidget () () -> HydrationWidget () () -> IO ()
121+mainHydrationWidgetWithHead' h b = run $ Main.mainHydrationWidgetWithHead' h b
122+{-# INLINE mainHydrationWidgetWithHead' #-}
release.nixnew file+63
@@ -0,0 +1,63 @@
1+{ reflex-platform-fun ? import ./dep/reflex-platform
2+, supportedSystems ? ["x86_64-linux" "x86_64-darwin"]
3+}:
4+
5+let
6+ native-reflex-platform = reflex-platform-fun {};
7+ inherit (native-reflex-platform.nixpkgs) lib;
8+
9+ tests = system: import ./test { pkgs = (reflex-platform-fun { inherit system; }).nixpkgs; };
10+
11+ perPlatform = lib.genAttrs supportedSystems (system: let
12+ reflex-platform = reflex-platform-fun { inherit system; };
13+ compilers = [
14+ "ghc"
15+ "ghcjs"
16+ ] ++ lib.optionals (reflex-platform.androidSupport) [
17+ "ghcAndroidAarch64"
18+ "ghcAndroidAarch32"
19+ ] ++ lib.optionals (reflex-platform.iosSupport) [
20+ "ghcIosAarch64"
21+ ];
22+ compilerPkgs = lib.genAttrs compilers (ghc: let
23+ reflex-platform = reflex-platform-fun {
24+ inherit system;
25+ haskellOverlays = [
26+ # Use this package's source for reflex
27+ (self: super: {
28+ _dep = super._dep // {
29+ reflex-dom = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [
30+ ".git"
31+ "dist"
32+ "dist-newstyle"
33+ ]) && !(builtins.elem path [
34+ ./CONTRIBUTING.md
35+ ./FAQ.md
36+ ./Quickref.md
37+ ./README.md
38+ ./release.nix
39+ ./test
40+ ])) ./.;
41+ };
42+ })
43+ ];
44+ };
45+ all = tests system // {
46+ inherit (reflex-platform.${ghc})
47+ reflex-dom-core
48+ reflex-dom
49+ ;
50+ };
51+ in all // {
52+ cache = reflex-platform.pinBuildInputs "reflex-${system}-${ghc}"
53+ (builtins.attrValues all);
54+ });
55+ in compilerPkgs // {
56+ cache = reflex-platform.pinBuildInputs "reflex-${system}"
57+ (map (a: a.cache) (builtins.attrValues compilerPkgs));
58+ });
59+
60+ metaCache = native-reflex-platform.pinBuildInputs "reflex-dom-everywhere"
61+ (map (a: a.cache) (builtins.attrValues perPlatform));
62+
63+in perPlatform // { inherit metaCache; }
test/default.nixnew file+10
@@ -0,0 +1,10 @@
1+{ pkgs ? (import ../dep/reflex-platform {}).nixpkgs }:
2+{
3+ test-reflex-dom-reexports = pkgs.runCommand "test-reflex-dom-reexports" {} (
4+ let
5+ ghc = pkgs.haskellPackages.ghcWithPackages (p: [p.Cabal]);
6+ in ''
7+ ${ghc}/bin/runhaskell ${./reflex-dom-reexports.hs} ${../reflex-dom/reflex-dom.cabal} ${../reflex-dom-core/reflex-dom-core.cabal}
8+ touch "$out"
9+ '');
10+}
test/prebuild.hsdeleted−127
@@ -1,127 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE ScopedTypeVariables #-}
4−{-# LANGUAGE TypeFamilies #-}
5−{-# LANGUAGE LambdaCase #-}
6−{-# LANGUAGE FlexibleInstances #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−import Control.Monad
9−import Control.Monad.Identity
10−import Control.Monad.Trans
11−import Reflex.Dom
12−import qualified Data.Text as T
13−import Control.Concurrent
14−
15−import Control.Monad.State.Strict
16−import Data.Functor.Misc
17−import Data.Monoid
18−import Data.Word
19−import qualified Data.Map as Map
20−import qualified Data.Dependent.Map as DMap
21−import Data.Dependent.Sum
22−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
23−
24−main :: IO ()
25−main = mainWidget w
26−
27−w :: forall t m. (MonadWidget t m, DomRenderHook t m, MountableDomBuilder t m) => m ()
28−w = do
29− let slow :: forall m'. (MonadWidget t m', DomRenderHook t m') => m' ()
30− {-
31− performEventChain = do
32− postBuild <- delay 0 =<< getPostBuild
33− rec let maxN = 10000
34− n = leftmost [0 <$ postBuild, ffilter (<=maxN) $ succ <$> n']
35− n' <- performEvent $ return <$> n
36− pausedUntil $ ffilter (==maxN) n'
37− _ <- widgetHold (text "Starting") $ text . T.pack . show <$> n
38− return ()
39− -}
40−-- {- Many dyns
41− slow = elAttr "div" ("style" =: "position:relative;width:256px;height:256px") $ go maxDepth
42− where maxDepth = 6 :: Int
43− go 0 = blank
44− go n = void $ dyn $ pure $ do
45− let bgcolor = "rgba(0,0,0," <> T.pack (show (1 - (fromIntegral n / fromIntegral maxDepth) :: Double)) <> ")"
46− s pos = pos <> ";position:absolute;border:1px solid white;background-color:" <> bgcolor
47− elAttr "div" ("style" =: s "left:0;right:50%;top:0;bottom:50%") $ go $ pred n
48− elAttr "div" ("style" =: s "left:50%;right:0;top:0;bottom:50%") $ go $ pred n
49− elAttr "div" ("style" =: s "left:50%;right:0;top:50%;bottom:0") $ go $ pred n
50− elAttr "div" ("style" =: s "left:0;right:50%;top:50%;bottom:0") $ go $ pred n
51−-- -}
52− {- Many elDynAttrs
53− slow = do
54− let size = 64
55− replicateM_ size $ elAttr "div" ("style" =: ("height:4px;width:" <> T.pack (show (size*4)) <> "px;line-height:0;background-color:gray")) $ do
56− replicateM_ size $ elDynAttr "div" (pure $ "style" =: "display:inline-block;width:4px;height:4px;background-color:black") blank
57− -}
58− {- Many dynTexts
59− slow = el "table" $ do
60− let size = 64
61− replicateM_ size $ el "tr" $ do
62− replicateM_ size $ el "td" $ do
63− dynText $ pure "."
64− -}
65− {- Many simultaneous performEvents
66− slow = do
67− postBuild <- getPostBuild
68− replicateM_ ((2 :: Int) ^ (14 :: Int)) $ performEvent_ $ return () <$ postBuild
69− done <- performEvent $ return () <$ postBuild
70− _ <- widgetHold (text "Doing performEvent") $ text "Done" <$ done
71− return ()
72− -}
73− {-
74− slow = do
75− postBuild <- getPostBuild
76− postBuild' <- performEvent . (return () <$) =<< performEvent . (return () <$) =<< getPostBuild
77− let f x = Map.fromList [(n, x) | n <- [1 :: Int .. 4096]]
78− listHoldWithKey (f False) (f (Just True) <$ postBuild') $ \k -> \case
79− False -> do
80− text "X "
81− notReadyUntil =<< getPostBuild
82− True -> do
83− text ". "
84− return ()
85− -}
86− {-
87− slow = do
88− let f :: forall a. EitherTag () () a -> Const2 () () a -> m' (Const2 () () a)
89− f _ (Const2 ()) = do
90− notReadyUntil =<< delay 0.5 =<< getPostBuild
91− text "Done"
92− return $ Const2 ()
93− postBuild <- getPostBuild
94− traverseDMapWithKeyWithAdjustWithMove f (DMap.singleton LeftTag $ Const2 ()) $ (PatchDMapWithMove.moveDMapKey LeftTag RightTag) <$ postBuild
95− return ()
96− -}
97− {-
98− slow = do
99− let h x = do
100− liftIO $ putStrLn "render hook"
101− result <- x
102− liftIO $ putStrLn "render hook done"
103− return result
104− f :: forall a. Const2 () () a -> Identity a -> m' (Identity a)
105− f (Const2 ()) (Identity ()) = do
106− liftIO $ putStrLn "f"
107− widgetHold notReady . (blank <$) =<< delay 0.1 =<< getPostBuild
108− liftIO $ putStrLn "f done"
109− return $ Identity ()
110− withRenderHook h $ do
111− postBuild <- getPostBuild
112− _ <- traverseDMapWithKeyWithAdjust f mempty $ PatchDMap (DMap.singleton (Const2 () :: Const2 () () ()) (ComposeMaybe $ Just $ Identity ())) <$ postBuild
113− return ()
114− -}
115− el "div" $ do
116− draw <- button "Draw"
117− widgetHold blank $ ffor draw $ \_ -> do
118− _ <- untilReady (text "Loading...") slow
119− return ()
120− return ()
121−
122−#ifdef EXPERIMENTAL_DEPENDENT_SUM_INSTANCES
123−instance {-# INCOHERENT #-} (Show (f a), Show (f b)) => ShowTag (EitherTag a b) f where
124− showTagToShow e _ = case e of
125− LeftTag -> id
126− RightTag -> id
127−#endif
test/reflex-dom-reexports.hsnew file+72
@@ -0,0 +1,72 @@
1+-- This tests that reflex-dom re-exports all of reflex-dom-core's modules.
2+-- Without this test they easily drift.
3+module Main where
4+
5+import Control.Monad (when)
6+import Data.List (intercalate)
7+import Data.Maybe (fromMaybe, isNothing, mapMaybe)
8+import qualified Data.Set as Set
9+import Distribution.Types.PackageName (mkPackageName)
10+import Distribution.Compiler (CompilerFlavor (GHC))
11+import Distribution.ModuleName (ModuleName, components)
12+import Distribution.PackageDescription.Parsec (parseGenericPackageDescription)
13+import qualified Distribution.Parsec.Common as Dist
14+import Distribution.Parsec.ParseResult (runParseResult)
15+import qualified Distribution.System as Dist
16+import Distribution.Types.BuildInfo (buildable, defaultExtensions, defaultLanguage, hsSourceDirs, options)
17+import Distribution.Types.CondTree (simplifyCondTree)
18+import Distribution.Types.GenericPackageDescription (ConfVar (Arch, Impl, OS), condLibrary)
19+import Distribution.Types.Library (exposedModules, libBuildInfo, reexportedModules)
20+import Distribution.Types.ModuleReexport (ModuleReexport, moduleReexportOriginalName, moduleReexportOriginalPackage)
21+import Distribution.Utils.Generic (toUTF8BS, readUTF8File)
22+import System.Environment (getArgs)
23+import qualified System.Info
24+
25+main :: IO ()
26+main = do
27+ [reflexDomFile, reflexDomCoreFile] <- getArgs
28+ (_, reflexDomReexports) <- parseCabalExports reflexDomFile
29+ (reflexDomCoreExports', _) <- parseCabalExports reflexDomCoreFile
30+
31+ let
32+ reflexDomCoreExports = Set.fromList reflexDomCoreExports'
33+ reflexDomCorePackageName = mkPackageName "reflex-dom-core"
34+ reflexDomReexportsFromCore
35+ = Set.fromList
36+ $ mapMaybe (\x -> if let origPackage = moduleReexportOriginalPackage x
37+ in isNothing origPackage || origPackage == Just reflexDomCorePackageName
38+ then Just $ moduleReexportOriginalName x
39+ else Nothing
40+ )
41+ reflexDomReexports
42+
43+ when (reflexDomCoreExports /= reflexDomReexportsFromCore) $ do
44+ error $ intercalate "\n\t"
45+ $ "reflex-dom does not re-export the following modules from reflex-dom-core:"
46+ : map
47+ (intercalate "." . components)
48+ (Set.toAscList $ reflexDomCoreExports `Set.difference` reflexDomReexportsFromCore)
49+
50+ putStrLn "Test passed."
51+
52+parseCabalExports :: FilePath -> IO ([ModuleName], [ModuleReexport])
53+parseCabalExports file = do
54+ contents <- readUTF8File file
55+ let
56+ (warnings, result) = runParseResult $ parseGenericPackageDescription $ toUTF8BS contents
57+ osConfVar = case System.Info.os of
58+ "linux" -> Just Dist.Linux
59+ "darwin" -> Just Dist.OSX
60+ _ -> error "Unrecognized System.Info.os"
61+ archConfVar = Just Dist.X86_64
62+ evalConfVar v = Right $ case v of
63+ OS osVar -> Just osVar == osConfVar
64+ Arch archVar -> Just archVar == archConfVar
65+ Impl GHC _ -> True
66+ _ -> False
67+ pure $ case condLibrary <$> result of
68+ Right (Just condLib) ->
69+ let (_, lib) = simplifyCondTree evalConfVar condLib
70+ in (exposedModules lib, reexportedModules lib)
71+ Right Nothing -> error $ "Haskell package has no library component: " <> file
72+ Left (_, errors) -> error $ "Failed to parse " <> file <> ":\n" <> unlines (map show errors)