on develop help sign in
.github/workflows/haskell.ymlnew file+47
since splitsnapshots
unifiedsplit
@@ -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+1−1
@@ -28,7 +28,7 @@ Widgets may return any type (this is 'a' in many of the functions below). Often
28-- This version returns the 'El' as well.
28-- This version returns the 'El' as well.
29[W] el' :: Text -> m a -> m (El, a)
29[W] el' :: Text -> m a -> m (El, a)
30
30
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'
32[W] elAttr :: Text -> Map Text Text -> m a -> m a
32[W] elAttr :: Text -> Map Text Text -> m a -> m a
33[W] elAttr' :: Text -> Map Text Text -> m a -> m (El, a)
33[W] elAttr' :: Text -> Map Text Text -> m a -> m (El, a)
34
34
README.md+15−9
@@ -1,17 +1,23 @@
1−## Reflex-DOM
1+## [Reflex-DOM](https://reflex-frp.org)
2−### A Framework for Functional Reactive Web Apps in Haskell
3
2
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)
5
4
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.
7
6
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/).**
9
10
10### Additional resources
11### Additional resources
11−[Get started with Reflex](https://github.com/reflex-frp/reflex-platform)
12
12
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)
13−[/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
17+* [/r/reflexfrp](https://www.reddit.com/r/reflexfrp)
18+* [irc.freenode.net #reflex-frp](http://webchat.freenode.net?channels=%23reflex-frp&uio=d4)
14
19
15−[hackage](https://hackage.haskell.org/package/reflex)
20+### Hacking
16
21
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) iproute 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
2All rights reserved.
2All rights reserved.
3
3
4Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4Redistribution 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−51
@@ -1,51 +0,0 @@
1−{ mkDerivation, ghc, aeson, base, bifunctors, bimap, blaze-builder
2−, bytestring, constraints, containers, contravariant, data-default
3−, dependent-map, dependent-sum, dependent-sum-template, directory
4−, exception-transformers, exceptions, ghcjs-dom, hlint, hspec
5−, http-types, HUnit, jsaddle, jsaddle-warp, keycode, lens
6−, linux-namespaces, monad-control, mtl, network-uri, primitive
7−, process, random, ref-tf, reflex, semigroups, silently, stdenv
8−, stm, template-haskell, temporary, text, these, transformers, unix
9−, wai, wai-websockets, warp, webdriver, websockets, zenc
10−, iproute, chromium, hashable, selenium-server-standalone
11−}:
12−let addGcTestDepends = drv: if stdenv.system != "x86_64-linux" then drv else drv // {
13− testHaskellDepends = (drv.testHaskellDepends or []) ++ [ temporary jsaddle-warp process linux-namespaces ];
14− testSystemDepends = (drv.testSystemDepends or []) ++ [ chromium iproute ];
15− };
16−in mkDerivation (addGcTestDepends {
17− pname = "reflex-dom-core";
18− version = "0.4";
19− src = ./.;
20− libraryHaskellDepends = [
21− aeson base bifunctors bimap blaze-builder bytestring constraints
22− containers contravariant data-default dependent-map dependent-sum
23− dependent-sum-template directory exception-transformers ghcjs-dom
24− jsaddle keycode lens monad-control mtl network-uri primitive random
25− ref-tf reflex semigroups stm template-haskell text these
26− transformers unix zenc
27− ] ++ (if ghc.isGhcjs or false then [
28− hashable
29− ] else []);
30−
31− #TODO: Get hlint working for cross-compilation
32− doCheck = stdenv.hostPlatform == stdenv.buildPlatform && !(ghc.isGhcjs or false);
33−
34− # The headless browser run as part of the tests will exit without this
35− preBuild = ''
36− export HOME="$PWD"
37− '';
38−
39− # Show some output while running tests, so we might notice what's wrong
40− testTarget = "--show-details=streaming";
41−
42− testSystemDepends = [ selenium-server-standalone ];
43− testHaskellDepends = [
44− aeson base bytestring containers exceptions ghcjs-dom hlint hspec
45− http-types HUnit jsaddle jsaddle-warp linux-namespaces process
46− random reflex silently temporary text unix wai wai-websockets warp
47− webdriver websockets
48− ];
49− description = "Functional Reactive Web Apps with Reflex";
50− license = stdenv.lib.licenses.bsd3;
51−})
reflex-dom-core/reflex-dom-core.cabal+82−40
@@ -1,7 +1,18 @@
1+cabal-version: 1.24
1Name: reflex-dom-core
2Name: reflex-dom-core
2−Version: 0.4
3+Version: 0.6.2.1
3Synopsis: Functional Reactive Web Apps with Reflex
4Synopsis: Functional Reactive Web Apps with Reflex
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+ .
4−Description: Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine
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@.
5License: BSD3
16License: BSD3
6License-file: LICENSE
17License-file: LICENSE
7Author: Ryan Trinkle
18Author: Ryan Trinkle
@@ -9,7 +20,6 @@ Maintainer: ryan.trinkle@gmail.com
9Stability: Experimental
20Stability: Experimental
10Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
21Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
11Build-type: Simple
22Build-type: Simple
12−Cabal-version: >=1.9.2
13-- Deal with https://github.com/haskell/cabal/issues/2544 / https://github.com/haskell/cabal/issues/367
23-- Deal with https://github.com/haskell/cabal/issues/2544 / https://github.com/haskell/cabal/issues/367
14extra-source-files: src-ghc/Foreign/JavaScript/Internal/Utils.hs
24extra-source-files: src-ghc/Foreign/JavaScript/Internal/Utils.hs
15 src-ghcjs/Foreign/JavaScript/Internal/Utils.hs
25 src-ghcjs/Foreign/JavaScript/Internal/Utils.hs
@@ -17,6 +27,7 @@ extra-source-files: src-ghc/Foreign/JavaScript/Internal/Utils.hs
17 src/Reflex/Dom/WebSocket/Foreign.hs
27 src/Reflex/Dom/WebSocket/Foreign.hs
18 src/Reflex/Dom/Xhr/ResponseType.hs
28 src/Reflex/Dom/Xhr/ResponseType.hs
19 src/Reflex/Dom/Xhr/Exception.hs
29 src/Reflex/Dom/Xhr/Exception.hs
30+ ChangeLog.md
20
31
21flag use-template-haskell
32flag use-template-haskell
22 description: Use template haskell to generate lenses
33 description: Use template haskell to generate lenses
@@ -38,39 +49,54 @@ flag profile-reflex
38 default: False
49 default: False
39 manual: True
50 manual: True
40
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+
41library
67library
42 hs-source-dirs: src
68 hs-source-dirs: src
43 build-depends:
69 build-depends:
44− aeson >= 0.8 && < 1.4,
70+ aeson >= 0.8 && < 1.6,
45− base >= 4.7 && < 4.12,
71+ base >= 4.7 && < 4.15,
46 bifunctors >= 4.2 && < 6,
72 bifunctors >= 4.2 && < 6,
47− bimap >= 0.3 && < 0.4,
73+ bimap >= 0.3 && < 0.5,
48− blaze-builder,
74+ blaze-builder >= 0.4.1 && < 0.5,
49 bytestring == 0.10.*,
75 bytestring == 0.10.*,
76+ case-insensitive < 1.3,
50− containers == 0.5.*,
77+ containers >= 0.6 && < 0.7,
51− constraints >= 0.9 && < 0.11,
78+ constraints >= 0.9 && < 0.13,
52− contravariant >= 1.4 && < 1.5,
79+ contravariant >= 1.4 && < 1.6,
53 data-default >= 0.5 && < 0.8,
80 data-default >= 0.5 && < 0.8,
54− dependent-map == 0.2.*,
81+ dependent-map >= 0.3 && < 0.5,
55− dependent-sum >= 0.3 && < 0.5,
56− dependent-sum-template >= 0.0.0.4 && < 0.1,
82+ dependent-sum >= 0.6 && < 0.8,
83+ dependent-sum-template >= 0.1 && < 0.2,
57 directory >= 1.2 && < 1.4,
84 directory >= 1.2 && < 1.4,
58 exception-transformers == 0.4.*,
85 exception-transformers == 0.4.*,
59 ghcjs-dom >= 0.9.1.0 && < 0.10,
86 ghcjs-dom >= 0.9.1.0 && < 0.10,
60− jsaddle >=0.9.0.0 && <0.10,
87+ jsaddle >= 0.9.0.0 && < 0.10,
61 -- keycode-0.2 has a bug on firefox
88 -- keycode-0.2 has a bug on firefox
62 keycode >= 0.2.1 && < 0.3,
89 keycode >= 0.2.1 && < 0.3,
63 lens >= 4.7 && < 5,
90 lens >= 4.7 && < 5,
64 monad-control >= 1.0.1 && < 1.1,
91 monad-control >= 1.0.1 && < 1.1,
65 mtl >= 2.1 && < 2.3,
92 mtl >= 2.1 && < 2.3,
66− primitive >= 0.5 && < 0.7,
93+ primitive >= 0.5 && < 0.8,
67− random,
94+ random >= 1.1 && < 1.2,
68 ref-tf == 0.4.*,
95 ref-tf == 0.4.*,
69− reflex == 0.5.*,
96+ reflex >= 0.8 && < 0.9,
70− semigroups >= 0.16 && < 0.19,
97+ semigroups >= 0.16 && < 0.20,
71− stm == 2.4.*,
98+ stm >= 2.4 && < 2.6,
72 text == 1.2.*,
99 text == 1.2.*,
73− these >= 0.4 && < 0.8,
74 transformers >= 0.3 && < 0.6,
100 transformers >= 0.3 && < 0.6,
75 network-uri >= 2.6.1 && < 2.7,
101 network-uri >= 2.6.1 && < 2.7,
76 zenc == 0.1.*
102 zenc == 0.1.*
@@ -79,31 +105,37 @@ library
79 hs-source-dirs: src-ghcjs
105 hs-source-dirs: src-ghcjs
80 build-depends:
106 build-depends:
81 ghcjs-base,
107 ghcjs-base,
82− hashable == 1.2.*
108+ hashable >= 1.2 && < 1.4
83 else
109 else
84 hs-source-dirs: src-ghc
110 hs-source-dirs: src-ghc
85 if !os(windows)
111 if !os(windows)
86 build-depends: unix == 2.7.*
112 build-depends: unix == 2.7.*
87
113
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+
88 exposed-modules:
122 exposed-modules:
89 Foreign.JavaScript.TH
123 Foreign.JavaScript.TH
90 Foreign.JavaScript.Orphans
124 Foreign.JavaScript.Orphans
91 Foreign.JavaScript.Utils
125 Foreign.JavaScript.Utils
92 Reflex.Dom.Builder.Class
126 Reflex.Dom.Builder.Class
93 Reflex.Dom.Builder.Class.Events
127 Reflex.Dom.Builder.Class.Events
94− Reflex.Dom.Builder.Hydration
95 Reflex.Dom.Builder.Immediate
128 Reflex.Dom.Builder.Immediate
96 Reflex.Dom.Builder.InputDisabled
129 Reflex.Dom.Builder.InputDisabled
130+ Reflex.Dom.Builder.Hydratable
97 Reflex.Dom.Builder.Static
131 Reflex.Dom.Builder.Static
98 Reflex.Dom.Class
132 Reflex.Dom.Class
99 Reflex.Dom.Core
133 Reflex.Dom.Core
100 Reflex.Dom.Location
134 Reflex.Dom.Location
101 Reflex.Dom.Main
135 Reflex.Dom.Main
102− Reflex.Dom.Modals.Base
103 Reflex.Dom.Modals.Class
136 Reflex.Dom.Modals.Class
104 Reflex.Dom.Old
137 Reflex.Dom.Old
105 Reflex.Dom.Prerender
138 Reflex.Dom.Prerender
106− Reflex.Dom.Specializations
107 Reflex.Dom.Time
139 Reflex.Dom.Time
108 Reflex.Dom.WebSocket
140 Reflex.Dom.WebSocket
109 Reflex.Dom.WebSocket.Query
141 Reflex.Dom.WebSocket.Query
@@ -113,6 +145,7 @@ library
113 Reflex.Dom.Widget.Lazy
145 Reflex.Dom.Widget.Lazy
114 Reflex.Dom.Widget.Resize
146 Reflex.Dom.Widget.Resize
115 Reflex.Dom.Xhr
147 Reflex.Dom.Xhr
148+ Reflex.Dom.Xhr.FormData
116 other-modules:
149 other-modules:
117 Foreign.JavaScript.Internal.Utils
150 Foreign.JavaScript.Internal.Utils
118 Reflex.Dom.WebSocket.Foreign
151 Reflex.Dom.WebSocket.Foreign
@@ -120,6 +153,7 @@ library
120 Reflex.Dom.Xhr.ResponseType
153 Reflex.Dom.Xhr.ResponseType
121 Reflex.Dom.Xhr.Exception
154 Reflex.Dom.Xhr.Exception
122
155
156+ default-language: Haskell98
123 ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
157 ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
124 ghc-prof-options: -fprof-auto
158 ghc-prof-options: -fprof-auto
125
159
@@ -134,27 +168,28 @@ library
134
168
135 if flag(use-template-haskell)
169 if flag(use-template-haskell)
136 build-depends:
170 build-depends:
137− dependent-sum >= 0.3 && < 0.5,
171+ dependent-sum-template >= 0.1 && < 0.2,
138− dependent-sum-template >= 0.0.0.5 && < 0.1,
139− template-haskell
172+ template-haskell >= 2.12.0 && < 2.17
140 other-extensions: TemplateHaskell
173 other-extensions: TemplateHaskell
141 cpp-options: -DUSE_TEMPLATE_HASKELL
174 cpp-options: -DUSE_TEMPLATE_HASKELL
142 other-modules:
175 other-modules:
143 Reflex.Dom.Builder.Class.TH
176 Reflex.Dom.Builder.Class.TH
144− else
145− build-depends:
146− dependent-sum == 0.4.*
147
177
148test-suite hlint
178test-suite hlint
149− build-depends: base, hlint
179+ build-depends:
180+ base,
181+ hlint >= 2.0 && < 4.0
150 hs-source-dirs: test
182 hs-source-dirs: test
151 main-is: hlint.hs
183 main-is: hlint.hs
152 type: exitcode-stdio-1.0
184 type: exitcode-stdio-1.0
185+ default-language: Haskell98
153
186
154test-suite hydration
187test-suite hydration
155 build-depends: base
188 build-depends: base
156 , aeson
189 , aeson
190+ , async
157 , bytestring
191 , bytestring
192+ , chrome-test-utils
158 , constraints
193 , constraints
159 , constraints-extras
194 , constraints-extras
160 , containers
195 , containers
@@ -166,13 +201,18 @@ test-suite hydration
166 , filepath
201 , filepath
167 , ghcjs-dom
202 , ghcjs-dom
168 , hspec
203 , hspec
204+ , hspec-core
205+ , hspec-webdriver
169 , http-types
206 , http-types
170 , HUnit
207 , HUnit
171 , jsaddle
208 , jsaddle
172 , jsaddle-warp
209 , jsaddle-warp
173 , lens
210 , lens
211+ , lifted-base
212+ , network
174 , random
213 , random
214+ , ref-tf
175− , reflex == 0.5.*
215+ , reflex
176 , reflex-dom-core
216 , reflex-dom-core
177 , process
217 , process
178 , silently
218 , silently
@@ -183,32 +223,34 @@ test-suite hydration
183 , warp
223 , warp
184 , webdriver
224 , webdriver
185 , websockets
225 , websockets
226+ , which
186 hs-source-dirs: test
227 hs-source-dirs: test
187− ghc-options: -threaded -rtsopts -with-rtsopts=-T -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
228+ ghc-options: -rtsopts -with-rtsopts=-T -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
188 ghc-prof-options: -fprof-auto -optP-DPROFILING
229 ghc-prof-options: -fprof-auto -optP-DPROFILING
189 main-is: hydration.hs
230 main-is: hydration.hs
190 type: exitcode-stdio-1.0
231 type: exitcode-stdio-1.0
232+ default-language: Haskell98
191− if !os(linux) || !arch(x86_64)-- || impl(ghc >= 8.4.0)
233+ if !os(linux) || !arch(x86_64) || flag(profile-reflex) || !flag(hydration-tests)
192 buildable: False
234 buildable: False
193
235
194-- broken test on base 4.11 & ghc 8.4.3
236-- broken test on base 4.11 & ghc 8.4.3
195-- needs to be updated for changes in GHC.Stats
237-- needs to be updated for changes in GHC.Stats
196test-suite gc
238test-suite gc
197 build-depends: base
239 build-depends: base
198− , reflex
240+ , chrome-test-utils
199− , reflex-dom-core
200 , jsaddle
241 , jsaddle
201 , jsaddle-warp
242 , jsaddle-warp
202− , linux-namespaces
203 , process
243 , process
204− , temporary
244+ , reflex
205− , unix
245+ , reflex-dom-core
246+ , text
206 hs-source-dirs: test
247 hs-source-dirs: test
207 ghc-options: -rtsopts -with-rtsopts=-T -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
248 ghc-options: -rtsopts -with-rtsopts=-T -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
208 ghc-prof-options: -fprof-auto -optP-DPROFILING
249 ghc-prof-options: -fprof-auto -optP-DPROFILING
209 main-is: gc.hs
250 main-is: gc.hs
210 type: exitcode-stdio-1.0
251 type: exitcode-stdio-1.0
252+ default-language: Haskell98
211− if !os(linux) || !arch(x86_64) || impl(ghc >= 8.4.0)
253+ if !os(linux) || !arch(x86_64) || !flag(gc-tests)
212 buildable: False
254 buildable: False
213
255
214source-repository head
256source-repository head
reflex-dom-core/src/Foreign/JavaScript/Orphans.hs+3
@@ -1,5 +1,8 @@
1+{-# OPTIONS_HADDOCK hide #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
2{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE UndecidableInstances #-}
5+
3{-# OPTIONS_GHC -fno-warn-orphans #-}
6{-# OPTIONS_GHC -fno-warn-orphans #-}
4module Foreign.JavaScript.Orphans where
7module Foreign.JavaScript.Orphans where
5
8
reflex-dom-core/src/Foreign/JavaScript/TH.hs+2−4
@@ -6,11 +6,9 @@
6{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FlexibleInstances #-}
7{-# LANGUAGE FunctionalDependencies #-}
7{-# LANGUAGE FunctionalDependencies #-}
8{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10{-# LANGUAGE RankNTypes #-}
9{-# LANGUAGE RankNTypes #-}
11{-# LANGUAGE StandaloneDeriving #-}
10{-# LANGUAGE StandaloneDeriving #-}
12{-# LANGUAGE TypeFamilies #-}
11{-# LANGUAGE TypeFamilies #-}
13−{-# LANGUAGE TypeSynonymInstances #-}
14{-# LANGUAGE UndecidableInstances #-}
12{-# LANGUAGE UndecidableInstances #-}
15#ifdef USE_TEMPLATE_HASKELL
13#ifdef USE_TEMPLATE_HASKELL
16{-# LANGUAGE TemplateHaskell #-}
14{-# LANGUAGE TemplateHaskell #-}
@@ -294,7 +292,7 @@ class Monad m => MonadJS x m | m -> x where
294#ifdef ghcjs_HOST_OS
292#ifdef ghcjs_HOST_OS
295
293
296data JSCtx_IO
294data JSCtx_IO
297−type HasJS' = HasJS JSCtx_IO
295+type JS' = JSCtx_IO
298
296
299instance MonadIO m => HasJS JSCtx_IO (WithJSContextSingleton x m) where
297instance MonadIO m => HasJS JSCtx_IO (WithJSContextSingleton x m) where
300 type JSX (WithJSContextSingleton x m) = IO
298 type JSX (WithJSContextSingleton x m) = IO
@@ -345,7 +343,7 @@ foreign import javascript unsafe "function(){ return $1(arguments); }" funWithAr
345#else
343#else
346
344
347data JSCtx_JavaScriptCore x
345data JSCtx_JavaScriptCore x
348−type HasJS' = HasJS (JSCtx_JavaScriptCore ())
346+type JS' = JSCtx_JavaScriptCore ()
349
347
350instance IsJSContext (JSCtx_JavaScriptCore x) where
348instance IsJSContext (JSCtx_JavaScriptCore x) where
351 newtype JSRef (JSCtx_JavaScriptCore x) = JSRef_JavaScriptCore { unJSRef_JavaScriptCore :: JSVal }
349 newtype JSRef (JSCtx_JavaScriptCore x) = JSRef_JavaScriptCore { unJSRef_JavaScriptCore :: JSVal }
reflex-dom-core/src/Reflex/Dom/Builder/Class.hs+24−13
@@ -9,12 +9,12 @@
9{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9{-# LANGUAGE GeneralizedNewtypeDeriving #-}
10#if !MIN_VERSION_base(4,9,0)
10#if !MIN_VERSION_base(4,9,0)
11{-# LANGUAGE ImpredicativeTypes #-}
11{-# LANGUAGE ImpredicativeTypes #-}
12+#else
13+{-# LANGUAGE Rank2Types #-} -- Implied by ImpredicativeTypes
12#endif
14#endif
13{-# LANGUAGE LambdaCase #-}
15{-# LANGUAGE LambdaCase #-}
14−{-# LANGUAGE MultiParamTypeClasses #-}
15{-# LANGUAGE OverloadedStrings #-}
16{-# LANGUAGE OverloadedStrings #-}
16{-# LANGUAGE PolyKinds #-}
17{-# LANGUAGE PolyKinds #-}
17−{-# LANGUAGE RankNTypes #-}
18{-# LANGUAGE RecursiveDo #-}
18{-# LANGUAGE RecursiveDo #-}
19{-# LANGUAGE ScopedTypeVariables #-}
19{-# LANGUAGE ScopedTypeVariables #-}
20{-# LANGUAGE StandaloneDeriving #-}
20{-# LANGUAGE StandaloneDeriving #-}
@@ -35,6 +35,7 @@ import Reflex.Dom.Builder.Class.Events
35#ifdef USE_TEMPLATE_HASKELL
35#ifdef USE_TEMPLATE_HASKELL
36import Reflex.Dom.Builder.Class.TH
36import Reflex.Dom.Builder.Class.TH
37#endif
37#endif
38+import Reflex.BehaviorWriter.Base
38import Reflex.DynamicWriter.Base
39import Reflex.DynamicWriter.Base
39import Reflex.EventWriter.Base
40import Reflex.EventWriter.Base
40import Reflex.NotReady.Class
41import Reflex.NotReady.Class
@@ -191,7 +192,7 @@ data CommentNodeConfig t
191 }
192 }
192
193
193#ifndef USE_TEMPLATE_HASKELL
194#ifndef USE_TEMPLATE_HASKELL
194−commentNodeConfig_initialContents :: Lens' (CommentNodeConfig t) Comment
195+commentNodeConfig_initialContents :: Lens' (CommentNodeConfig t) Text
195commentNodeConfig_initialContents f (CommentNodeConfig a b) = (\a' -> CommentNodeConfig a' b) <$> f a
196commentNodeConfig_initialContents f (CommentNodeConfig a b) = (\a' -> CommentNodeConfig a' b) <$> f a
196{-# INLINE commentNodeConfig_initialContents #-}
197{-# INLINE commentNodeConfig_initialContents #-}
197#endif
198#endif
@@ -436,13 +437,13 @@ concat <$> mapM (uncurry makeLensesWithoutField)
436#endif
437#endif
437
438
438-- | 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'.
439-- | 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'.
439−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)
440textNodeConfig_setContents =
441textNodeConfig_setContents =
441 let getter = fromMaybe never . _textNodeConfig_setContents
442 let getter = fromMaybe never . _textNodeConfig_setContents
442 setter t e = t { _textNodeConfig_setContents = Just e }
443 setter t e = t { _textNodeConfig_setContents = Just e }
443 in lens getter setter
444 in lens getter setter
444
445
445−-- | 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'.
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'.
446commentNodeConfig_setContents :: Reflex t => Lens (CommentNodeConfig t) (CommentNodeConfig t) (Event t Text) (Event t Text)
447commentNodeConfig_setContents :: Reflex t => Lens (CommentNodeConfig t) (CommentNodeConfig t) (Event t Text) (Event t Text)
447commentNodeConfig_setContents =
448commentNodeConfig_setContents =
448 let getter = fromMaybe never . _commentNodeConfig_setContents
449 let getter = fromMaybe never . _commentNodeConfig_setContents
@@ -450,42 +451,42 @@ commentNodeConfig_setContents =
450 in lens getter setter
451 in lens getter setter
451
452
452-- | 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'.
453-- | 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'.
453−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)
454inputElementConfig_setValue =
455inputElementConfig_setValue =
455 let getter = fromMaybe never . _inputElementConfig_setValue
456 let getter = fromMaybe never . _inputElementConfig_setValue
456 setter t e = t { _inputElementConfig_setValue = Just e }
457 setter t e = t { _inputElementConfig_setValue = Just e }
457 in lens getter setter
458 in lens getter setter
458
459
459-- | 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'.
460-- | 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'.
460−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)
461inputElementConfig_setChecked =
462inputElementConfig_setChecked =
462 let getter = fromMaybe never . _inputElementConfig_setChecked
463 let getter = fromMaybe never . _inputElementConfig_setChecked
463 setter t e = t { _inputElementConfig_setChecked = Just e }
464 setter t e = t { _inputElementConfig_setChecked = Just e }
464 in lens getter setter
465 in lens getter setter
465
466
466-- | 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'.
467-- | 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'.
467−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)))
468rawElementConfig_modifyAttributes =
469rawElementConfig_modifyAttributes =
469 let getter = fromMaybe never . _rawElementConfig_modifyAttributes
470 let getter = fromMaybe never . _rawElementConfig_modifyAttributes
470 setter t e = t { _rawElementConfig_modifyAttributes = Just e }
471 setter t e = t { _rawElementConfig_modifyAttributes = Just e }
471 in lens getter setter
472 in lens getter setter
472
473
473-- | 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'.
474-- | 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'.
474−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)))
475elementConfig_modifyAttributes =
476elementConfig_modifyAttributes =
476 let getter = fromMaybe never . _elementConfig_modifyAttributes
477 let getter = fromMaybe never . _elementConfig_modifyAttributes
477 setter t e = t { _elementConfig_modifyAttributes = Just e }
478 setter t e = t { _elementConfig_modifyAttributes = Just e }
478 in lens getter setter
479 in lens getter setter
479
480
480-- | 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'.
481-- | 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'.
481−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)
482textAreaElementConfig_setValue =
483textAreaElementConfig_setValue =
483 let getter = fromMaybe never . _textAreaElementConfig_setValue
484 let getter = fromMaybe never . _textAreaElementConfig_setValue
484 setter t e = t { _textAreaElementConfig_setValue = Just e }
485 setter t e = t { _textAreaElementConfig_setValue = Just e }
485 in lens getter setter
486 in lens getter setter
486
487
487-- | 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'.
488-- | 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'.
488−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)
489selectElementConfig_setValue =
490selectElementConfig_setValue =
490 let getter = fromMaybe never . _selectElementConfig_setValue
491 let getter = fromMaybe never . _selectElementConfig_setValue
491 setter t e = t { _selectElementConfig_setValue = Just e }
492 setter t e = t { _selectElementConfig_setValue = Just e }
@@ -617,7 +618,7 @@ instance (DomBuilder t m, MonadHold t m, MonadFix m, Semigroup w) => DomBuilder
617 placeRawElement = lift . placeRawElement
618 placeRawElement = lift . placeRawElement
618 wrapRawElement e = lift . wrapRawElement e
619 wrapRawElement e = lift . wrapRawElement e
619
620
620−instance (DomBuilder t m, MonadFix m, MonadHold t m, Group q, Query q, Additive q) => DomBuilder t (QueryT t q m) where
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
621 type DomBuilderSpace (QueryT t q m) = DomBuilderSpace m
622 type DomBuilderSpace (QueryT t q m) = DomBuilderSpace m
622 textNode = liftTextNode
623 textNode = liftTextNode
623 commentNode = liftCommentNode
624 commentNode = liftCommentNode
@@ -638,7 +639,7 @@ instance (DomBuilder t m, MonadFix m, MonadHold t m, Group q, Query q, Additive
638
639
639-- * Convenience functions
640-- * Convenience functions
640
641
641−class HasDomEvent t target eventName where
642+class HasDomEvent t target eventName | target -> t where
642 type DomEventType target eventName :: *
643 type DomEventType target eventName :: *
643 domEvent :: EventName eventName -> target -> Event t (DomEventType target eventName)
644 domEvent :: EventName eventName -> target -> Event t (DomEventType target eventName)
644
645
@@ -715,7 +716,9 @@ instance DomRenderHook t m => DomRenderHook t (Lazy.StateT e m) where
715 requestDomAction = lift . requestDomAction
716 requestDomAction = lift . requestDomAction
716 requestDomAction_ = lift . requestDomAction_
717 requestDomAction_ = lift . requestDomAction_
717
718
719+deriving instance DomRenderHook t m => DomRenderHook t (BehaviorWriterT t w m)
718deriving instance DomRenderHook t m => DomRenderHook t (EventWriterT t w m)
720deriving instance DomRenderHook t m => DomRenderHook t (EventWriterT t w m)
721+deriving instance DomRenderHook t m => DomRenderHook t (DynamicWriterT t w m)
719deriving instance DomRenderHook t m => DomRenderHook t (RequesterT t req rsp m)
722deriving instance DomRenderHook t m => DomRenderHook t (RequesterT t req rsp m)
720deriving instance DomRenderHook t m => DomRenderHook t (PostBuildT t m)
723deriving instance DomRenderHook t m => DomRenderHook t (PostBuildT t m)
721deriving instance DomRenderHook t m => DomRenderHook t (QueryT t q m)
724deriving instance DomRenderHook t m => DomRenderHook t (QueryT t q m)
@@ -742,3 +745,11 @@ instance HasDocument m => HasDocument (DynamicWriterT t w m)
742instance HasDocument m => HasDocument (PostBuildT t m)
745instance HasDocument m => HasDocument (PostBuildT t m)
743instance HasDocument m => HasDocument (RequesterT t request response m)
746instance HasDocument m => HasDocument (RequesterT t request response m)
744instance HasDocument m => HasDocument (QueryT t q m)
747instance 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 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE DataKinds #-}
2{-# LANGUAGE DataKinds #-}
3{-# LANGUAGE GADTs #-}
3{-# LANGUAGE GADTs #-}
4−{-# LANGUAGE KindSignatures #-}
5{-# LANGUAGE PolyKinds #-}
4{-# LANGUAGE PolyKinds #-}
6#ifdef USE_TEMPLATE_HASKELL
5#ifdef USE_TEMPLATE_HASKELL
7{-# LANGUAGE TemplateHaskell #-}
6{-# LANGUAGE TemplateHaskell #-}
@@ -15,6 +14,7 @@ import Data.GADT.Compare.TH
15import Data.GADT.Compare
14import Data.GADT.Compare
16 (GOrdering(..), (:~:)(..), GEq(..), GCompare(..))
15 (GOrdering(..), (:~:)(..), GEq(..), GCompare(..))
17#endif
16#endif
17+import Data.Text (Text)
18
18
19data EventTag
19data EventTag
20 = AbortTag
20 = AbortTag
@@ -152,7 +152,7 @@ type family EventResultType (en :: EventTag) :: * where
152 EventResultType 'BeforecopyTag = ()
152 EventResultType 'BeforecopyTag = ()
153 EventResultType 'CopyTag = ()
153 EventResultType 'CopyTag = ()
154 EventResultType 'BeforepasteTag = ()
154 EventResultType 'BeforepasteTag = ()
155− EventResultType 'PasteTag = ()
155+ EventResultType 'PasteTag = Maybe Text
156 EventResultType 'ResetTag = ()
156 EventResultType 'ResetTag = ()
157 EventResultType 'SearchTag = ()
157 EventResultType 'SearchTag = ()
158 EventResultType 'SelectstartTag = ()
158 EventResultType 'SelectstartTag = ()
@@ -160,7 +160,17 @@ type family EventResultType (en :: EventTag) :: * where
160 EventResultType 'TouchmoveTag = TouchEventResult
160 EventResultType 'TouchmoveTag = TouchEventResult
161 EventResultType 'TouchendTag = TouchEventResult
161 EventResultType 'TouchendTag = TouchEventResult
162 EventResultType 'TouchcancelTag = TouchEventResult
162 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)
164
174
165data TouchEventResult = TouchEventResult
175data TouchEventResult = TouchEventResult
166 { _touchEventResult_altKey :: Bool
176 { _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/Hydration.hsdeleted−1527
@@ -1,1527 +0,0 @@
1−{-# LANGUAGE BangPatterns #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE ConstraintKinds #-}
4−{-# LANGUAGE DataKinds #-}
5−{-# LANGUAGE DeriveFunctor #-}
6−{-# LANGUAGE DeriveTraversable #-}
7−{-# LANGUAGE EmptyDataDecls #-}
8−{-# LANGUAGE FlexibleContexts #-}
9−{-# LANGUAGE FlexibleInstances #-}
10−{-# LANGUAGE GADTs #-}
11−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
12−{-# LANGUAGE LambdaCase #-}
13−{-# LANGUAGE MultiParamTypeClasses #-}
14−{-# LANGUAGE OverloadedStrings #-}
15−{-# LANGUAGE PolyKinds #-}
16−{-# LANGUAGE RankNTypes #-}
17−{-# LANGUAGE RecursiveDo #-}
18−{-# LANGUAGE ScopedTypeVariables #-}
19−{-# LANGUAGE TypeFamilies #-}
20−{-# LANGUAGE TypeOperators #-}
21−{-# LANGUAGE UndecidableInstances #-}
22−#ifdef ghcjs_HOST_OS
23−{-# LANGUAGE ForeignFunctionInterface #-}
24−{-# LANGUAGE JavaScriptFFI #-}
25−#endif
26−module Reflex.Dom.Builder.Hydration
27− ( EventTriggerRef (..)
28− , HydrationDomBuilderEnv (..)
29− , HydrationDomBuilderT (..)
30− , HydrationMode (..)
31− , HydrationRunnerT (..)
32− , runHydrationRunnerT
33− , localEnv
34− , addHydrationStepWithSetup
35− , addHydrationStep
36− , getHydrationMode
37− , hydrateNode
38− , getPreviousNode, setPreviousNode
39− , runHydrationDomBuilderT
40− , askParent
41− , askEvents
42− , append
43− , textNodeInternal
44− , SupportsHydrationDomBuilder
45− , wrap
46− , makeElement
47− , drawChildUpdate
48− -- * Internal
49− , traverseDMapWithKeyWithAdjust'
50− , hoistTraverseWithKeyWithAdjust
51− , traverseIntMapWithKeyWithAdjust'
52− , hoistTraverseIntMapWithKeyWithAdjust
53− ) where
54−
55−import Control.Concurrent
56−import Control.Exception (bracketOnError)
57−import Control.Lens hiding (element, ix)
58−import Control.Monad.Exception
59−import Control.Monad.Primitive
60−import Control.Monad.Reader
61−import Control.Monad.Ref
62−import Control.Monad.State.Strict
63−import Data.Dependent.Map (DMap)
64−import Data.Dependent.Sum
65−import Data.FastMutableIntMap (PatchIntMap (..))
66−import Data.Foldable (for_)
67−import Data.Functor.Compose
68−import Data.Functor.Constant
69−import Data.Functor.Misc
70−import Data.Functor.Product
71−import Data.IORef
72−import Data.IntMap.Strict (IntMap)
73−import Data.Maybe
74−import Data.Text (Text)
75−import Data.Typeable (Typeable)
76−import Foreign.JavaScript.Internal.Utils
77−import Foreign.JavaScript.TH
78−import GHCJS.DOM.Document (Document, createDocumentFragment, createElement, createElementNS, createTextNode, createComment)
79−import GHCJS.DOM.Element (removeAttribute, removeAttributeNS, setAttribute, setAttributeNS, hasAttribute, hasAttributeNS)
80−import GHCJS.DOM.EventM (on)
81−import GHCJS.DOM.Node (appendChild_, setNodeValue, toNode)
82−import GHCJS.DOM.Types (liftJSM, askJSM, runJSM, JSM, MonadJSM, IsNode, Node, ToDOMString, uncheckedCastTo)
83−import Reflex.Adjustable.Class
84−import Reflex.Class as Reflex
85−import Reflex.Dom.Builder.Class
86−import Reflex.Dom.Builder.Immediate hiding (askEvents, askParent, append, wrap, makeElement, textNodeInternal, traverseIntMapWithKeyWithAdjust', traverseDMapWithKeyWithAdjust', hoistTraverseWithKeyWithAdjust, hoistTraverseIntMapWithKeyWithAdjust, drawChildUpdate)
87−import Reflex.Dynamic
88−import Reflex.Host.Class
89−import Reflex.PerformEvent.Class
90−import Reflex.PostBuild.Class
91−import Reflex.Requester.Base
92−import Reflex.Requester.Class
93−import Reflex.TriggerEvent.Base hiding (askEvents)
94−import Reflex.TriggerEvent.Class
95−
96−import qualified Data.Dependent.Map as DMap
97−import qualified Data.FastMutableIntMap as FastMutableIntMap
98−import qualified Data.IntMap.Strict as IntMap
99−import qualified Data.Map as Map
100−import qualified Data.Some as Some
101−import qualified Data.Text as T
102−import qualified GHCJS.DOM as DOM
103−import qualified GHCJS.DOM.DocumentOrShadowRoot as Document
104−import qualified GHCJS.DOM.Element as Element
105−import qualified GHCJS.DOM.EventM as DOM
106−import qualified GHCJS.DOM.FileList as FileList
107−import qualified GHCJS.DOM.GlobalEventHandlers as Events
108−import qualified GHCJS.DOM.HTMLInputElement as Input
109−import qualified GHCJS.DOM.HTMLSelectElement as Select
110−import qualified GHCJS.DOM.HTMLTextAreaElement as TextArea
111−import qualified GHCJS.DOM.Node as Node
112−import qualified GHCJS.DOM.Text as DOM
113−import qualified GHCJS.DOM.Types as DOM
114−import qualified Reflex.Patch.DMap as PatchDMap
115−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
116−import qualified Reflex.TriggerEvent.Base as TriggerEventT (askEvents)
117−
118−#ifndef USE_TEMPLATE_HASKELL
119−import Data.Functor.Contravariant (phantom)
120−#endif
121−
122−#ifndef ghcjs_HOST_OS
123−import GHCJS.DOM.Types (MonadJSM (..))
124−
125−instance MonadJSM m => MonadJSM (HydrationRunnerT t m) where
126− liftJSM' = lift . liftJSM'
127−
128−instance MonadJSM m => MonadJSM (HydrationDomBuilderT t m) where
129− liftJSM' = lift . liftJSM'
130−
131−instance MonadJSM m => MonadJSM (DomRenderHookT t m) where
132− liftJSM' = lift . liftJSM'
133−#endif
134−
135−data HydrationDomBuilderEnv t = HydrationDomBuilderEnv
136− { _hydrationDomBuilderEnv_document :: {-# UNPACK #-} !Document
137− -- ^ Reference to the document
138− , _hydrationDomBuilderEnv_parent :: {-# UNPACK #-} !(IORef Node)
139− -- ^ This is in an IORef because in the time up to hydration we can't actually know what the
140− -- parent is - we populate this reference during the DOM traversal at hydration time
141− , _hydrationDomBuilderEnv_unreadyChildren :: {-# UNPACK #-} !(IORef Word)
142− -- ^ Number of children who still aren't fully rendered
143− , _hydrationDomBuilderEnv_commitAction :: !(JSM ())
144− -- ^ Action to take when all children are ready --TODO: we should probably get rid of this once we invoke it
145− , _hydrationDomBuilderEnv_hydrationMode :: {-# UNPACK #-} !(IORef HydrationMode)
146− -- ^ In hydration mode? Should be switched to `HydrationMode_Immediate` after hydration is finished
147− , _hydrationDomBuilderEnv_switchover :: !(Event t ())
148− }
149−
150−-- | The monad which performs the delayed actions to reuse prerendered nodes and set up events
151−-- State contains reference to the previous node sibling, if any.
152−newtype HydrationRunnerT t m a = HydrationRunnerT { unHydrationRunnerT :: StateT (Maybe Node) (ReaderT Node (DomRenderHookT t m)) a }
153− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
154−#if MIN_VERSION_base(4,9,1)
155− , MonadAsyncException
156−#endif
157− )
158−
159−localRunner :: (MonadJSM m, Monad m) => HydrationRunnerT t m a -> Maybe Node -> Node -> HydrationRunnerT t m a
160−localRunner (HydrationRunnerT m) s parent = HydrationRunnerT . lift $ local (\_ -> parent) (evalStateT m s)
161−
162−runHydrationRunnerT
163− :: (MonadRef m, Ref m ~ IORef, Monad m, PerformEvent t m, MonadFix m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m))
164− => HydrationRunnerT t m a -> Maybe Node -> Node -> Chan [DSum (EventTriggerRef t) TriggerInvocation] -> m a
165−runHydrationRunnerT (HydrationRunnerT m) s parent = runDomRenderHookT (runReaderT (evalStateT m s) parent)
166−
167−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydrationRunnerT t m) where
168− {-# INLINABLE newEventWithTrigger #-}
169− newEventWithTrigger = lift . newEventWithTrigger
170− {-# INLINABLE newFanEventWithTrigger #-}
171− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
172−
173−instance MonadTrans (HydrationRunnerT t) where
174− lift = HydrationRunnerT . lift . lift . lift
175−
176−instance MonadSample t m => MonadSample t (HydrationRunnerT t m) where
177− sample = lift . sample
178−
179−-- | Add a hydration step which depends on some computation that should only be
180−-- done *before* the switchover to immediate mode - this is most likely some
181−-- form of 'hold' which we want to remove after hydration is done
182−addHydrationStepWithSetup :: (Adjustable t m, MonadIO m) => m a -> (a -> HydrationRunnerT t m ()) -> HydrationDomBuilderT t m ()
183−addHydrationStepWithSetup setup f = getHydrationMode >>= \case
184− HydrationMode_Immediate -> pure ()
185− HydrationMode_Hydrating -> do
186− switchover <- HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_switchover
187− --s <- lift setup
188− (s, _) <- lift $ runWithReplace setup $ return () <$ switchover -- 4% more memory than above
189− HydrationDomBuilderT $ modify' (>> f s)
190−
191−-- | Add a hydration step
192−addHydrationStep
193− :: (MonadIO m, Ref m ~ IORef, MonadRef m, PerformEvent t m, MonadFix m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m))
194− => HydrationRunnerT t m () -> HydrationDomBuilderT t m ()
195−addHydrationStep m = getHydrationMode >>= \case
196− HydrationMode_Immediate -> lift . runHydrationRunnerT m Nothing undefined =<< askEvents
197− HydrationMode_Hydrating -> HydrationDomBuilderT $ modify' (>> m)
198−
199−-- | A monad for DomBuilder which just gets the results of children and pushes
200−-- work into an action that is delayed until after postBuild (to match the
201−-- static builder). The action runs in 'HydrationRunnerT', which performs the
202−-- DOM takeover and sets up the events, after which point this monad will
203−-- continue in the vein of 'ImmediateDomBuilderT'.
204−newtype HydrationDomBuilderT t m a = HydrationDomBuilderT { unHydrationDomBuilderT :: ReaderT (HydrationDomBuilderEnv t) (StateT (HydrationRunnerT t m ()) (DomRenderHookT t m)) a }
205− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
206−#if MIN_VERSION_base(4,9,1)
207− , MonadAsyncException
208−#endif
209− )
210−
211−instance PrimMonad m => PrimMonad (HydrationDomBuilderT x m) where
212− type PrimState (HydrationDomBuilderT x m) = PrimState m
213− primitive = lift . primitive
214−
215−instance MonadTrans (HydrationDomBuilderT t) where
216− lift = HydrationDomBuilderT . lift . lift . lift
217−
218−-- | Shared behavior for HydrationDomBuilderT and HydrationRunnerT
219−newtype DomRenderHookT t m a = DomRenderHookT { unDomRenderHookT :: RequesterT t JSM Identity (TriggerEventT t m) a }
220− deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
221−#if MIN_VERSION_base(4,9,1)
222− , MonadAsyncException
223−#endif
224− )
225−
226−{-# INLINABLE runDomRenderHookT #-}
227−runDomRenderHookT
228− :: (MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m), MonadRef m, Ref m ~ IORef)
229− => DomRenderHookT t m a
230− -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
231− -> m a
232−runDomRenderHookT (DomRenderHookT a) events = do
233− flip runTriggerEventT events $ do
234− rec (result, req) <- runRequesterT a rsp
235− rsp <- performEventAsync $ ffor req $ \rm f -> liftJSM $ runInAnimationFrame f $
236− traverseRequesterData (\r -> Identity <$> r) rm
237− return result
238− where
239− runInAnimationFrame f x = void . DOM.inAnimationFrame' $ \_ -> do
240− v <- synchronously x
241− void . liftIO $ f v
242−
243−instance MonadTrans (DomRenderHookT t) where
244− lift = DomRenderHookT . lift . lift
245−
246−instance (Reflex t, MonadFix m) => DomRenderHook t (DomRenderHookT t m) where
247− withRenderHook hook (DomRenderHookT a) = do
248− DomRenderHookT $ withRequesting $ \rsp -> do
249− (x, req) <- lift $ runRequesterT a $ runIdentity <$> rsp
250− return (ffor req $ \rm -> hook $ traverseRequesterData (\r -> Identity <$> r) rm, x)
251− requestDomAction = DomRenderHookT . requestingIdentity
252− requestDomAction_ = DomRenderHookT . requesting_
253−
254−instance (Reflex t, MonadFix m) => DomRenderHook t (HydrationDomBuilderT t m) where
255− withRenderHook hook = HydrationDomBuilderT . mapReaderT (mapStateT (withRenderHook hook)) . unHydrationDomBuilderT
256− requestDomAction = HydrationDomBuilderT . lift . lift . requestDomAction
257− requestDomAction_ = HydrationDomBuilderT . lift . lift . requestDomAction_
258−
259−instance (Reflex t, MonadFix m) => DomRenderHook t (HydrationRunnerT t m) where
260− withRenderHook hook = HydrationRunnerT . mapStateT (mapReaderT (withRenderHook hook)) . unHydrationRunnerT
261− requestDomAction = HydrationRunnerT . lift . lift . requestDomAction
262− requestDomAction_ = HydrationRunnerT . lift . lift . requestDomAction_
263−
264−{-# INLINABLE runHydrationDomBuilderT #-}
265−runHydrationDomBuilderT
266− :: ( MonadFix m
267− , PerformEvent t m
268− , MonadReflexCreateTrigger t m
269− , MonadJSM m
270− , MonadJSM (Performable m)
271− , MonadRef m
272− , Ref m ~ IORef
273− )
274− => HydrationDomBuilderT t m a
275− -> HydrationDomBuilderEnv t
276− -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
277− -> m (a, HydrationRunnerT t m ())
278−runHydrationDomBuilderT (HydrationDomBuilderT a) env = runDomRenderHookT (runStateT (runReaderT a env) (pure ()))
279−
280−instance Monad m => HasDocument (HydrationDomBuilderT t m) where
281− {-# INLINABLE askDocument #-}
282− askDocument = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_document
283−
284−{-# INLINABLE localEnv #-}
285−localEnv :: Monad m => (HydrationDomBuilderEnv t -> HydrationDomBuilderEnv t) -> HydrationDomBuilderT t m a -> HydrationDomBuilderT t m a
286−localEnv f = HydrationDomBuilderT . local f . unHydrationDomBuilderT
287−
288−{-# INLINABLE append #-}
289−append :: MonadJSM m => DOM.Node -> HydrationDomBuilderT t m ()
290−append n = do
291− p <- getParent
292− appendChild_ p n
293− return ()
294−
295−data HydrationMode
296− = HydrationMode_Hydrating
297− | HydrationMode_Immediate
298− deriving (Eq, Ord, Show)
299−
300−{-# INLINABLE askParent #-}
301−askParent :: Monad m => HydrationRunnerT t m DOM.Node
302−askParent = HydrationRunnerT ask
303−
304−{-# INLINABLE getPreviousNode #-}
305−getPreviousNode :: Monad m => HydrationRunnerT t m (Maybe DOM.Node)
306−getPreviousNode = HydrationRunnerT get
307−
308−{-# INLINABLE setPreviousNode #-}
309−setPreviousNode :: Monad m => Maybe DOM.Node -> HydrationRunnerT t m ()
310−setPreviousNode = HydrationRunnerT . put
311−
312−{-# INLINABLE getParent #-}
313−getParent :: MonadIO m => HydrationDomBuilderT t m DOM.Node
314−getParent = liftIO . readIORef =<< HydrationDomBuilderT (asks _hydrationDomBuilderEnv_parent)
315−
316−{-# INLINABLE askUnreadyChildren #-}
317−askUnreadyChildren :: Monad m => HydrationDomBuilderT t m (IORef Word)
318−askUnreadyChildren = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_unreadyChildren
319−
320−{-# INLINABLE askCommitAction #-}
321−askCommitAction :: Monad m => HydrationDomBuilderT t m (JSM ())
322−askCommitAction = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_commitAction
323−
324−{-# INLINABLE getHydrationMode #-}
325−getHydrationMode :: MonadIO m => HydrationDomBuilderT t m HydrationMode
326−getHydrationMode = liftIO . readIORef =<< HydrationDomBuilderT (asks _hydrationDomBuilderEnv_hydrationMode)
327−
328−{-# INLINABLE askEvents #-}
329−askEvents :: Monad m => HydrationDomBuilderT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
330−askEvents = HydrationDomBuilderT . lift . lift . DomRenderHookT . lift $ TriggerEventT.askEvents
331−
332−{-# INLINABLE makeNodeInternal #-}
333−makeNodeInternal
334− :: forall node t m. (MonadJSM m, IsNode node, Typeable node)
335− => HydrationDomBuilderT t m node -> HydrationDomBuilderT t m node
336−makeNodeInternal mkNode = do
337− n <- mkNode
338− append $ toNode n
339− return n
340−
341−{-# INLINABLE hydrateNode #-}
342−-- | This function expects the existing DOM at the current hydration node to be
343−-- correct. It skips any nodes that are the wrong type, or that fail the
344−-- @check@. The previous node reference is also updated.
345−hydrateNode
346− :: (MonadJSM m, IsNode node, Typeable node)
347− => (node -> HydrationRunnerT t m Bool) -> (DOM.JSVal -> node) -> HydrationRunnerT t m node
348−hydrateNode check constructor = do
349− parent <- askParent
350− lastHydrationNode <- getPreviousNode
351− let go mLastNode = do
352− node <- maybe (Node.getFirstChildUnchecked parent) Node.getNextSiblingUnchecked mLastNode
353− DOM.castTo constructor node >>= \case
354− Nothing -> go (Just node)
355− Just tn -> check tn >>= \case
356− True -> return tn
357− False -> go (Just node)
358− n <- go lastHydrationNode
359− setPreviousNode $ Just $ toNode n
360− return n
361−
362−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))
363−
364−-- | This 'wrap' is only partial: it doesn't create the 'EventSelector' itself
365−{-# INLINABLE wrap #-}
366−wrap
367− :: forall m er t. (Reflex t, MonadJSM m, MonadReflexCreateTrigger t m, DomRenderHook t m)
368− => Chan [DSum (EventTriggerRef t) TriggerInvocation]
369− -> DOM.Element
370− -> RawElementConfig er t HydrationDomSpace
371− -> m (DMap EventName (EventFilterTriggerRef t er))
372−wrap events e cfg = do
373− forM_ (_rawElementConfig_modifyAttributes cfg) $ \modifyAttrs -> requestDomAction_ $ ffor modifyAttrs $ imapM_ $ \(AttributeName mAttrNamespace n) mv -> case mAttrNamespace of
374− Nothing -> maybe (removeAttribute e n) (setAttribute e n) mv
375− Just ns -> maybe (removeAttributeNS e (Just ns) n) (setAttributeNS e (Just ns) n) mv
376− eventTriggerRefs :: DMap EventName (EventFilterTriggerRef t er) <- liftJSM $ fmap DMap.fromList $ forM (DMap.toList $ _ghcjsEventSpec_filters $ _rawElementConfig_eventSpec cfg) $ \(en :=> GhcjsEventFilter f) -> do
377− triggerRef <- liftIO $ newIORef Nothing
378− _ <- elementOnEventName en e $ do --TODO: Something safer than this cast
379− evt <- DOM.event
380− (flags, k) <- liftJSM $ f $ GhcjsDomEvent evt
381− when (_eventFlags_preventDefault flags) $ withIsEvent en DOM.preventDefault
382− case _eventFlags_propagation flags of
383− Propagation_Continue -> return ()
384− Propagation_Stop -> withIsEvent en DOM.stopPropagation
385− Propagation_StopImmediate -> withIsEvent en DOM.stopImmediatePropagation
386− mv <- liftJSM k --TODO: Only do this when the event is subscribed
387− liftIO $ forM_ mv $ \v -> writeChan events [EventTriggerRef triggerRef :=> TriggerInvocation v (return ())]
388− return $ en :=> EventFilterTriggerRef triggerRef
389− return eventTriggerRefs
390−
391−triggerBody
392− :: forall er t x. DOM.JSContextRef
393− -> ElementConfig er t HydrationDomSpace
394− -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
395− -> DMap EventName (EventFilterTriggerRef t er)
396− -> DOM.Element
397− -> WrapArg er EventName x
398− -> EventTrigger t x
399− -> IO (IO ())
400−triggerBody ctx cfg events eventTriggerRefs e (WrapArg en) t = case DMap.lookup en eventTriggerRefs of
401− Just (EventFilterTriggerRef r) -> do
402− writeIORef r $ Just t
403− return $ do
404− writeIORef r Nothing
405− Nothing -> (`runJSM` ctx) <$> (`runJSM` ctx) (elementOnEventName en e $ do
406− evt <- DOM.event
407− mv <- lift $ unGhcjsEventHandler handler (en, GhcjsDomEvent evt)
408− case mv of
409− Nothing -> return ()
410− Just v -> liftIO $ do
411− --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
412− ref <- newIORef $ Just t
413− writeChan events [EventTriggerRef ref :=> TriggerInvocation v (return ())])
414− where
415− -- Note: this needs to be done strictly and outside of the newFanEventWithTrigger, so that the newFanEventWithTrigger doesn't
416− -- retain the entire cfg, which can cause a cyclic dependency that the GC won't be able to clean up
417− handler :: GhcjsEventHandler er
418− !handler = _ghcjsEventSpec_handler $ _rawElementConfig_eventSpec $ extractRawElementConfig cfg
419−
420−{-# INLINABLE makeElement #-}
421−makeElement
422− :: forall er t m a. (MonadJSM m, MonadHold t m, MonadFix m, MonadReflexCreateTrigger t m, Adjustable t m, Ref m ~ IORef, PerformEvent t m, MonadJSM (Performable m), MonadRef m)
423− => Text
424− -> ElementConfig er t HydrationDomSpace
425− -> HydrationDomBuilderT t m a
426− -> HydrationDomBuilderT t m ((Element er HydrationDomSpace t, a), IORef DOM.Element)
427−makeElement elementTag cfg child = do
428− doc <- askDocument
429− ctx <- askJSM
430− events <- askEvents
431−
432− let buildElement :: MonadJSM n => n DOM.Element
433− buildElement = do
434− e <- uncheckedCastTo DOM.Element <$> case cfg ^. namespace of
435− Nothing -> createElement doc elementTag
436− Just ens -> createElementNS doc (Just ens) elementTag
437− iforM_ (cfg ^. initialAttributes) $ \(AttributeName mAttrNamespace n) v -> case mAttrNamespace of
438− Nothing -> setAttribute e n v
439− Just ans -> setAttributeNS e (Just ans) n v
440− pure e
441− ssrAttr = "ssr" :: DOM.JSString
442− hasSSRAttribute :: DOM.Element -> HydrationRunnerT t m Bool
443− hasSSRAttribute e = case cfg ^. namespace of
444− Nothing -> hasAttribute e ssrAttr -- TODO: disabled for debugging <* removeAttribute e ssrAttr
445− Just ns -> hasAttributeNS e (Just ns) ssrAttr -- TODO: disabled for debugging <* removeAttributeNS e (Just ns) ssrAttr
446− getHydrationMode >>= \case
447− HydrationMode_Immediate -> do
448− e <- makeNodeInternal buildElement
449− p <- liftIO $ newIORef $ toNode e
450− -- Run the child builder with updated parent and previous sibling references
451− result <- localEnv (\env -> env { _hydrationDomBuilderEnv_parent = p }) child
452− eventTriggerRefs <- wrap events e $ extractRawElementConfig cfg
453− es <- newFanEventWithTrigger $ triggerBody ctx cfg events eventTriggerRefs e
454− e' <- liftIO $ newIORef e
455− return ((Element es (), result), e')
456− HydrationMode_Hydrating -> do
457− -- Schedule everything for after postBuild, except for getting the result itself
458− parent <- liftIO $ newIORef $ error "Parent not yet initialized"
459− e' <- liftIO $ newIORef $ error "makeElement: Element not yet initialized"
460− env <- HydrationDomBuilderT ask
461− let env' = env { _hydrationDomBuilderEnv_parent = parent }
462− (result, childDom) <- HydrationDomBuilderT $ lift $ lift $ runStateT (runReaderT (unHydrationDomBuilderT child) env') (pure ())
463− wrapResult <- liftIO newEmptyMVar
464− let activateElement = do
465− e <- hydrateNode hasSSRAttribute DOM.Element
466− -- Update the parent node used by the children
467− liftIO $ writeIORef parent $ toNode e
468− liftIO $ writeIORef e' e
469− -- Setup events, store the result so we can wait on it later
470− refs <- wrap events e $ extractRawElementConfig cfg
471− liftIO $ putMVar wrapResult (e, refs)
472− pure $ toNode e
473− addHydrationStep $ activateElement >>= localRunner childDom Nothing
474−
475− -- We need the EventSelector to switch to the real event handler after activation
476− es <- newFanEventWithTrigger $ \(WrapArg en) t -> do
477− cleanup <- newEmptyMVar
478− threadId <- forkIO $ do
479− -- Wait on the data we need from the delayed action
480− (e, eventTriggerRefs) <- readMVar wrapResult
481− bracketOnError
482− -- Run the setup, acquiring the cleanup action
483− (triggerBody ctx cfg events eventTriggerRefs e (WrapArg en) t)
484− -- Run the cleanup, if we have it - but only when an exception is
485− -- raised (we might get killed between acquiring the cleanup action
486− -- from 'triggerBody' and putting it in the MVar)
487− id
488− -- Try to put this action into the cleanup MVar
489− (putMVar cleanup)
490− pure $ do
491− tryReadMVar cleanup >>= \case
492− Nothing -> killThread threadId
493− Just c -> c
494−
495− let dummyElement = error "makeElement: DOM.Element"
496− return ((Element es dummyElement, result), e')
497−
498−{-# INLINABLE textNodeInternal #-}
499−textNodeInternal :: (Adjustable t m, MonadHold t m, MonadJSM m, MonadFix m, Reflex t) => Text -> Maybe (Event t Text) -> HydrationDomBuilderT t m DOM.Text
500−textNodeInternal !t mSetContents = getHydrationMode >>= \case
501− HydrationMode_Immediate -> do
502− n <- makeNodeInternal (askDocument >>= \doc -> createTextNode doc t)
503− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
504− pure n
505− HydrationMode_Hydrating -> do
506− addHydrationStepWithSetup (maybe (pure $ pure t) (hold t) mSetContents) $ \currentText -> do
507− n <- hydrateTextNode =<< sample currentText
508− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
509− pure $ error "textNodeInternal: DOM.Text"
510−
511−-- | The static builder mashes adjacent text nodes into one node: we check the
512−-- text content of each node we come to, comparing it to the content we
513−-- expect. We also have a special case for empty text nodes - we always create
514−-- the and add them after the previous node reference.
515−{-# INLINABLE hydrateTextNode #-}
516−hydrateTextNode :: MonadJSM m => Text -> HydrationRunnerT t m DOM.Text
517−hydrateTextNode t@"" = do
518− doc <- Node.getOwnerDocumentUnchecked =<< askParent
519− tn <- createTextNode doc t
520− insertAfterPreviousNode tn
521− pure tn
522−hydrateTextNode t = do
523− n <- join $ go <$> askParent <*> getPreviousNode
524− setPreviousNode $ Just $ toNode n
525− return n
526− where
527− go parent mLastNode = do
528− node <- maybe (Node.getFirstChildUnchecked parent) Node.getNextSiblingUnchecked mLastNode
529− DOM.castTo DOM.Text node >>= \case
530− Nothing -> go parent $ Just node
531− Just originalNode -> do
532− originalText <- Node.getTextContentUnchecked originalNode
533− case T.stripPrefix t originalText of
534− Just "" -> return originalNode
535− Just _ -> do
536− -- If we have the right prefix, we split the text node into a node containing the
537− -- required text and a subsequent sibling node containing the rest of the text.
538− DOM.splitText_ originalNode $ fromIntegral $ T.length t
539− return originalNode
540− Nothing -> go parent $ Just $ toNode originalNode
541−
542−
543−{-# INLINABLE commentNodeInternal #-}
544−commentNodeInternal :: (Ref m ~ IORef, MonadRef m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadJSM (Performable m), MonadJSM m, MonadFix m, ToDOMString contents, Reflex t, Adjustable t m) => contents -> Maybe (Event t contents) -> HydrationDomBuilderT t m DOM.Comment
545−commentNodeInternal !t mSetContents = getHydrationMode >>= \case
546− HydrationMode_Immediate -> do
547− n <- makeNodeInternal (askDocument >>= \doc -> createComment doc t)
548− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
549− pure n
550− HydrationMode_Hydrating -> do
551− addHydrationStep $ do
552− n <- hydrateNode (const $ pure True) DOM.Comment
553− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
554− pure $ error "commentNodeInternal: DOM.Comment"
555−
556−-- | We leave markers in the static builder as comments, and rip these comments
557−-- out at hydration time, replacing them with empty text nodes.
558−skipToAndReplaceComment
559− :: (MonadJSM m, Reflex t, MonadFix m, Adjustable t m, MonadHold t m)
560− => Text
561− -> IORef Text
562− -> HydrationDomBuilderT t m (HydrationRunnerT t m (), IORef DOM.Text, IORef Text)
563−skipToAndReplaceComment prefix key0Ref = getHydrationMode >>= \case
564− HydrationMode_Immediate -> do
565− -- If we're in immediate mode, we don't try to replace an existing comment,
566− -- and just return a dummy key
567− t <- textNodeInternal ("" :: Text) Nothing
568− append $ toNode t
569− textNodeRef <- liftIO $ newIORef t
570− keyRef <- liftIO $ newIORef ""
571− pure (pure (), textNodeRef, keyRef)
572− HydrationMode_Hydrating -> do
573− doc <- askDocument
574− textNodeRef <- liftIO $ newIORef $ error "textNodeRef not yet initialized"
575− keyRef <- liftIO $ newIORef $ error "keyRef not yet initialized"
576− let go key0 mLastNode = do
577− parent <- askParent
578− node <- maybe (Node.getFirstChildUnchecked parent) Node.getNextSiblingUnchecked mLastNode
579− DOM.castTo DOM.Comment node >>= \case
580− Just comment -> do
581− commentText <- Node.getTextContentUnchecked comment
582− case T.stripPrefix (prefix <> key0) commentText of
583− Just key -> do
584− -- Replace the comment with an (invisible) text node
585− tn <- createTextNode doc ("" :: Text)
586− Node.replaceChild_ parent tn comment
587− pure (tn, key)
588− Nothing -> do
589− go key0 (Just node)
590− Nothing -> do
591− go key0 (Just node)
592− switchComment = do
593− key0 <- liftIO $ readIORef key0Ref
594− (tn, key) <- go key0 =<< getPreviousNode
595− setPreviousNode $ Just $ toNode tn
596− liftIO $ do
597− writeIORef textNodeRef tn
598− writeIORef keyRef key
599− pure (switchComment, textNodeRef, keyRef)
600−
601−skipToReplaceStart :: (MonadJSM m, Reflex t, MonadFix m, Adjustable t m, MonadHold t m) => HydrationDomBuilderT t m (HydrationRunnerT t m (), IORef DOM.Text, IORef Text)
602−skipToReplaceStart = skipToAndReplaceComment "replace-start" =<< liftIO (newIORef "")
603−
604−skipToReplaceEnd :: (MonadJSM m, Reflex t, MonadFix m, Adjustable t m, MonadHold t m) => IORef Text -> HydrationDomBuilderT t m (HydrationRunnerT t m (), IORef DOM.Text)
605−skipToReplaceEnd key = fmap (\(m,e,_) -> (m,e)) $ skipToAndReplaceComment "replace-end" key
606−
607−instance SupportsHydrationDomBuilder t m => NotReady t (HydrationDomBuilderT t m) where
608− notReadyUntil e = do
609− eOnce <- headE e
610− unreadyChildren <- askUnreadyChildren
611− commitAction <- askCommitAction
612− liftIO $ modifyIORef' unreadyChildren succ
613− let ready = do
614− old <- liftIO $ readIORef unreadyChildren
615− let new = pred old
616− liftIO $ writeIORef unreadyChildren $! new
617− when (new == 0) commitAction
618− requestDomAction_ $ ready <$ eOnce
619− notReady = do
620− unreadyChildren <- askUnreadyChildren
621− liftIO $ modifyIORef' unreadyChildren succ
622−
623−data HydrationDomSpace
624−
625−instance DomSpace HydrationDomSpace where
626− type EventSpec HydrationDomSpace = GhcjsEventSpec
627− type RawDocument HydrationDomSpace = DOM.Document
628− type RawTextNode HydrationDomSpace = ()
629− type RawCommentNode HydrationDomSpace = ()
630− type RawElement HydrationDomSpace = ()
631− type RawInputElement HydrationDomSpace = ()
632− type RawTextAreaElement HydrationDomSpace = ()
633− type RawSelectElement HydrationDomSpace = ()
634− addEventSpecFlags _ en f es = es
635− { _ghcjsEventSpec_filters =
636− let f' = Just . GhcjsEventFilter . \case
637− Nothing -> \evt -> do
638− mEventResult <- unGhcjsEventHandler (_ghcjsEventSpec_handler es) (en, evt)
639− return (f mEventResult, return mEventResult)
640− Just (GhcjsEventFilter oldFilter) -> \evt -> do
641− (oldFlags, oldContinuation) <- oldFilter evt
642− mEventResult <- oldContinuation
643− let newFlags = oldFlags <> f mEventResult
644− return (newFlags, return mEventResult)
645− in DMap.alter f' en $ _ghcjsEventSpec_filters es
646− }
647−
648−instance (SupportsHydrationDomBuilder t m) => DomBuilder t (HydrationDomBuilderT t m) where
649− type DomBuilderSpace (HydrationDomBuilderT t m) = HydrationDomSpace
650− {-# INLINABLE textNode #-}
651− textNode (TextNodeConfig initialContents mSetContents) = do
652− t <- textNodeInternal initialContents mSetContents
653− return $ TextNode ()
654− {-# INLINABLE commentNode #-}
655− commentNode (CommentNodeConfig initialContents mSetContents) = do
656− c <- commentNodeInternal initialContents mSetContents
657− return $ CommentNode ()
658− {-# INLINABLE element #-}
659− element elementTag cfg child = do
660− fst <$> makeElement elementTag cfg child
661− {-# INLINABLE inputElement #-}
662− inputElement cfg = do
663− ((e, _), domElementRef) <- makeElement "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
664−
665− (valueChangedByUI, triggerChangeByUI) <- newTriggerEvent
666− (valueChangedBySetValue, triggerChangeBySetValue) <- newTriggerEvent
667−
668− (focusChange, triggerFocusChange) <- newTriggerEvent
669− (checkedChangedByUI, triggerCheckedChangedByUI) <- newTriggerEvent
670− (checkedChangedBySetChecked, triggerCheckedChangedBySetChecked) <- newTriggerEvent
671−
672− (fileChange, triggerFileChange) <- newTriggerEvent
673−
674− doc <- askDocument
675−
676− -- Expected initial value from config
677− let v0 = _inputElementConfig_initialValue cfg
678−
679− addHydrationStep $ do
680− domElement <- liftIO $ readIORef domElementRef
681− let domInputElement = uncheckedCastTo DOM.HTMLInputElement domElement
682− getValue = Input.getValue domInputElement
683−
684− -- The browser might have messed with the value, or the user could have
685− -- altered it before activation, so we set it if it isn't what we expect
686− liftJSM getValue >>= \v0' -> do
687− when (v0' /= v0) $ liftIO $ triggerChangeByUI v0'
688−
689− -- Watch for user interaction and trigger event accordingly
690− requestDomAction_ $ (liftJSM getValue >>= liftIO . triggerChangeByUI) <$ Reflex.select (_element_events e) (WrapArg Input)
691−
692− for_ (_inputElementConfig_setValue cfg) $ \eSetValue ->
693− requestDomAction_ $ ffor eSetValue $ \v' -> do
694− Input.setValue domInputElement v'
695− v <- getValue -- We get the value after setting it in case the browser has mucked with it somehow
696− liftIO $ triggerChangeBySetValue v
697−
698− let focusChange' = leftmost
699− [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
700− , True <$ Reflex.select (_element_events e) (WrapArg Focus)
701− ]
702− liftIO . triggerFocusChange =<< Node.isSameNode (toNode domElement) . fmap toNode =<< Document.getActiveElement doc
703− requestDomAction_ $ liftIO . triggerFocusChange <$> focusChange'
704−
705− Input.setChecked domInputElement $ _inputElementConfig_initialChecked cfg
706− _ <- liftJSM $ domInputElement `on` Events.click $ do
707− liftIO . triggerCheckedChangedByUI =<< Input.getChecked domInputElement
708−
709− for_ (_inputElementConfig_setChecked cfg) $ \eNewchecked ->
710− requestDomAction $ ffor eNewchecked $ \newChecked -> do
711− oldChecked <- Input.getChecked domInputElement
712− Input.setChecked domInputElement newChecked
713− when (newChecked /= oldChecked) $ liftIO $ triggerCheckedChangedBySetChecked newChecked
714−
715− _ <- liftJSM $ domInputElement `on` Events.change $ do
716− mfiles <- Input.getFiles domInputElement
717− let getMyFiles xs = fmap catMaybes . mapM (FileList.item xs) . flip take [0..] . fromIntegral =<< FileList.getLength xs
718− liftIO . triggerFileChange =<< maybe (return []) getMyFiles mfiles
719−
720− return ()
721−
722− checked' <- holdDyn (_inputElementConfig_initialChecked cfg) $ leftmost
723− [ checkedChangedBySetChecked
724− , checkedChangedByUI
725− ]
726− checked <- holdUniqDyn checked'
727−
728− let initialFocus = False -- Assume it isn't focused, but we update the actual focus state at switchover
729− hasFocus <- holdUniqDyn =<< holdDyn initialFocus focusChange
730−
731− v <- holdDyn v0 $ leftmost
732− [ valueChangedBySetValue
733− , valueChangedByUI
734− ]
735−
736− files <- holdDyn mempty fileChange
737−
738− return $ InputElement
739− { _inputElement_value = v
740− , _inputElement_checked = checked
741− , _inputElement_checkedChange = checkedChangedByUI
742− , _inputElement_input = valueChangedByUI
743− , _inputElement_hasFocus = hasFocus
744− , _inputElement_element = e
745− , _inputElement_raw = undefined -- TODO domInputElement
746− , _inputElement_files = files
747− }
748−
749− {-# INLINABLE textAreaElement #-}
750− textAreaElement cfg = do
751− ((e, _), domElementRef) <- makeElement "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
752−
753− (valueChangedByUI, triggerChangeByUI) <- newTriggerEvent
754− (valueChangedBySetValue, triggerChangeBySetValue) <- newTriggerEvent
755−
756− (focusChange, triggerFocusChange) <- newTriggerEvent
757−
758− doc <- askDocument
759−
760− -- Expected initial value from config
761− let v0 = _textAreaElementConfig_initialValue cfg
762−
763− addHydrationStep $ do
764− domElement <- liftIO $ readIORef domElementRef
765− let domTextAreaElement = uncheckedCastTo DOM.HTMLTextAreaElement domElement
766− getValue = TextArea.getValue domTextAreaElement
767−
768− -- The browser might have messed with the value, or the user could have
769− -- altered it before activation, so we set it if it isn't what we expect
770− liftJSM getValue >>= \v0' -> do
771− when (v0' /= v0) $ liftIO $ triggerChangeByUI v0'
772−
773− -- Watch for user interaction and trigger event accordingly
774− requestDomAction_ $ (liftJSM getValue >>= liftIO . triggerChangeByUI) <$ Reflex.select (_element_events e) (WrapArg Input)
775−
776− for_ (_textAreaElementConfig_setValue cfg) $ \eSetValue ->
777− requestDomAction_ $ ffor eSetValue $ \v' -> do
778− TextArea.setValue domTextAreaElement v'
779− v <- getValue -- We get the value after setting it in case the browser has mucked with it somehow
780− liftIO $ triggerChangeBySetValue v
781−
782− let focusChange' = leftmost
783− [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
784− , True <$ Reflex.select (_element_events e) (WrapArg Focus)
785− ]
786− liftIO . triggerFocusChange =<< Node.isSameNode (toNode domElement) . fmap toNode =<< Document.getActiveElement doc
787− requestDomAction_ $ liftIO . triggerFocusChange <$> focusChange'
788−
789− let initialFocus = False -- Assume it isn't focused, but we update the actual focus state at switchover
790− hasFocus <- holdUniqDyn =<< holdDyn initialFocus focusChange
791−
792− v <- holdDyn v0 $ leftmost
793− [ valueChangedBySetValue
794− , valueChangedByUI
795− ]
796−
797− return $ TextAreaElement
798− { _textAreaElement_value = v
799− , _textAreaElement_input = valueChangedByUI
800− , _textAreaElement_hasFocus = hasFocus
801− , _textAreaElement_element = e
802− , _textAreaElement_raw = undefined -- TODO domTextAreaElement
803− }
804−
805− {-# INLINABLE selectElement #-}
806− selectElement cfg child = do
807− ((e, result), domElementRef) <- makeElement "select" (cfg ^. selectElementConfig_elementConfig) child
808−
809− (valueChangedByUI, triggerChangeByUI) <- newTriggerEvent
810− (valueChangedBySetValue, triggerChangeBySetValue) <- newTriggerEvent
811−
812− (focusChange, triggerFocusChange) <- newTriggerEvent
813−
814− doc <- askDocument
815−
816− -- Expected initial value from config
817− let v0 = _selectElementConfig_initialValue cfg
818−
819− addHydrationStep $ do
820− domElement <- liftIO $ readIORef domElementRef
821− let domSelectElement = uncheckedCastTo DOM.HTMLSelectElement domElement
822− getValue = Select.getValue domSelectElement
823−
824− -- The browser might have messed with the value, or the user could have
825− -- altered it before activation, so we set it if it isn't what we expect
826− liftJSM getValue >>= \v0' -> do
827− when (v0' /= v0) $ liftIO $ triggerChangeByUI v0'
828−
829− -- Watch for user interaction and trigger event accordingly
830− requestDomAction_ $ (liftJSM getValue >>= liftIO . triggerChangeByUI) <$ Reflex.select (_element_events e) (WrapArg Change)
831−
832− for_ (_selectElementConfig_setValue cfg) $ \eSetValue ->
833− requestDomAction_ $ ffor eSetValue $ \v' -> do
834− Select.setValue domSelectElement v'
835− v <- getValue -- We get the value after setting it in case the browser has mucked with it somehow
836− liftIO $ triggerChangeBySetValue v
837−
838− let focusChange' = leftmost
839− [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
840− , True <$ Reflex.select (_element_events e) (WrapArg Focus)
841− ]
842− liftIO . triggerFocusChange =<< Node.isSameNode (toNode domElement) . fmap toNode =<< Document.getActiveElement doc
843− requestDomAction_ $ liftIO . triggerFocusChange <$> focusChange'
844−
845− let initialFocus = False -- Assume it isn't focused, but we update the actual focus state at switchover
846− hasFocus <- holdUniqDyn =<< holdDyn initialFocus focusChange
847−
848− v <- holdDyn v0 $ leftmost
849− [ valueChangedBySetValue
850− , valueChangedByUI
851− ]
852−
853− return $ flip (,) result $ SelectElement
854− { _selectElement_value = v
855− , _selectElement_change = valueChangedByUI
856− , _selectElement_hasFocus = hasFocus
857− , _selectElement_element = e
858− , _selectElement_raw = undefined -- TODO domSelectElement
859− }
860−
861− placeRawElement () = pure () -- TODO
862−-- placeRawElement e = getHydrationMode >>= \case
863−-- HydrationMode_Immediate -> append $ toNode e
864−-- HydrationMode_Hydrating -> addHydrationStep $ insertAfterPreviousNode e
865− wrapRawElement () _cfg = pure $ Element (EventSelector $ const never) () -- TODO
866−-- wrapRawElement e rawCfg = do
867−-- ctx <- askJSM
868−-- events <- askEvents
869−-- let cfg = (def :: ElementConfig EventResult t HydrationDomSpace)
870−-- { _elementConfig_modifyAttributes = _rawElementConfig_modifyAttributes rawCfg
871−-- , _elementConfig_eventSpec = _rawElementConfig_eventSpec rawCfg
872−-- }
873−-- eventTriggerRefs <- wrap events e rawCfg
874−-- es <- newFanEventWithTrigger $ triggerBody ctx cfg events eventTriggerRefs e
875−-- return $ Element es e
876−
877−data FragmentState
878− = FragmentState_Unmounted
879− | FragmentState_Mounted (DOM.Text, DOM.Text)
880−
881−data HydrationDomFragment = HydrationDomFragment
882− { _hydrationDomFragment_document :: DOM.DocumentFragment
883− , _hydrationDomFragment_state :: IORef FragmentState
884− }
885−
886−extractFragment :: MonadJSM m => HydrationDomFragment -> m ()
887−extractFragment fragment = do
888− s <- liftIO $ readIORef $ _hydrationDomFragment_state fragment
889− case s of
890− FragmentState_Unmounted -> return ()
891− FragmentState_Mounted (before, after) -> do
892− extractBetweenExclusive (_hydrationDomFragment_document fragment) before after
893− liftIO $ writeIORef (_hydrationDomFragment_state fragment) FragmentState_Unmounted
894−
895−instance SupportsHydrationDomBuilder t m => MountableDomBuilder t (HydrationDomBuilderT t m) where
896− type DomFragment (HydrationDomBuilderT t m) = HydrationDomFragment
897− buildDomFragment w = do
898− df <- createDocumentFragment =<< askDocument
899− p <- liftIO $ newIORef $ toNode df
900− result <- localEnv (\env -> env { _hydrationDomBuilderEnv_parent = p }) w
901− s <- liftIO $ newIORef FragmentState_Unmounted
902− return (HydrationDomFragment df s, result)
903− mountDomFragment fragment setFragment = do
904− parent <- getParent
905− extractFragment fragment
906− before <- textNodeInternal ("" :: Text) Nothing
907− appendChild_ parent $ _hydrationDomFragment_document fragment
908− after <- textNodeInternal ("" :: Text) Nothing
909− xs <- foldDyn (\new (previous, _) -> (new, Just previous)) (fragment, Nothing) setFragment
910− requestDomAction_ $ ffor (updated xs) $ \(childFragment, Just previousFragment) -> do
911− extractFragment previousFragment
912− extractFragment childFragment
913− insertBefore (_hydrationDomFragment_document childFragment) after
914− liftIO $ writeIORef (_hydrationDomFragment_state childFragment) $ FragmentState_Mounted (before, after)
915− liftIO $ writeIORef (_hydrationDomFragment_state fragment) $ FragmentState_Mounted (before, after)
916−
917−instance (Reflex t, Monad m, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (DomRenderHookT t m) where
918− runWithReplace a0 a' = DomRenderHookT $ runWithReplace (unDomRenderHookT a0) (fmapCheap unDomRenderHookT a')
919− traverseIntMapWithKeyWithAdjust f m = DomRenderHookT . traverseIntMapWithKeyWithAdjust (\k -> unDomRenderHookT . f k) m
920− traverseDMapWithKeyWithAdjust f m = DomRenderHookT . traverseDMapWithKeyWithAdjust (\k -> unDomRenderHookT . f k) m
921− traverseDMapWithKeyWithAdjustWithMove f m = DomRenderHookT . traverseDMapWithKeyWithAdjustWithMove (\k -> unDomRenderHookT . f k) m
922−
923−instance (Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimMonad m) => Adjustable t (HydrationDomBuilderT t m) where
924− {-# INLINABLE runWithReplace #-}
925− runWithReplace a0 a' = do
926− initialEnv <- HydrationDomBuilderT ask
927− let hydrating = _hydrationDomBuilderEnv_hydrationMode initialEnv
928− (hydrateStart, before, beforeKey) <- skipToReplaceStart
929− let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
930− haveEverBeenReady <- liftIO $ newIORef False
931− currentCohort <- liftIO $ newIORef (-1 :: Int) -- Equal to the cohort currently in the DOM
932− let myCommitAction = do
933− liftIO (readIORef haveEverBeenReady) >>= \case
934− True -> return ()
935− False -> do
936− liftIO $ writeIORef haveEverBeenReady True
937− old <- liftIO $ readIORef parentUnreadyChildren
938− let new = pred old
939− liftIO $ writeIORef parentUnreadyChildren $! new
940− when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
941− -- We draw 'after' in this roundabout way to avoid using MonadFix
942− doc <- askDocument
943− parent <- getParent
944− (hydrateEnd, after) <- skipToReplaceEnd beforeKey
945− let drawInitialChild = do
946− h <- liftIO $ readIORef hydrating
947− p' <- case h of
948− HydrationMode_Hydrating -> pure parent
949− HydrationMode_Immediate -> toNode <$> createDocumentFragment doc
950− p <- liftIO $ newIORef p'
951− unreadyChildren <- liftIO $ newIORef 0
952− let a0' = case h of
953− HydrationMode_Hydrating -> a0
954− HydrationMode_Immediate -> do
955− a <- a0
956− insertBefore p' =<< liftIO (readIORef after)
957− pure a
958− (result, dom) <- flip runStateT (pure ()) $ runReaderT (unHydrationDomBuilderT a0') initialEnv
959− { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
960− , _hydrationDomBuilderEnv_commitAction = myCommitAction
961− , _hydrationDomBuilderEnv_parent = p
962− }
963− liftIO $ readIORef unreadyChildren >>= \case
964− 0 -> writeIORef haveEverBeenReady True
965− _ -> modifyIORef' parentUnreadyChildren succ
966− return (dom, result)
967− a'' <- numberOccurrences a'
968− ((hydrate0, result0), child') <- HydrationDomBuilderT $ lift $ lift $ runWithReplace drawInitialChild $ ffor a'' $ \(cohortId, child) -> do
969− h <- liftIO $ readIORef hydrating
970− p' <- case h of
971− HydrationMode_Hydrating -> pure parent
972− HydrationMode_Immediate -> toNode <$> createDocumentFragment doc
973− p <- liftIO $ newIORef p'
974− unreadyChildren <- liftIO $ newIORef 0
975− let commitAction = do
976− c <- liftIO $ readIORef currentCohort
977− when (c <= cohortId) $ do -- If a newer cohort has already been committed, just ignore this
978− !before' <- liftIO $ readIORef before
979− !after' <- liftIO $ readIORef after
980− deleteBetweenExclusive before' after'
981− insertBefore p' after'
982− liftIO $ writeIORef currentCohort cohortId
983− myCommitAction
984− (result, dom) <- flip runStateT (pure ()) $ runReaderT (unHydrationDomBuilderT child) $ initialEnv
985− { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
986− , _hydrationDomBuilderEnv_commitAction = case h of
987− HydrationMode_Hydrating -> myCommitAction
988− HydrationMode_Immediate -> commitAction
989− , _hydrationDomBuilderEnv_parent = p
990− }
991− uc <- liftIO $ readIORef unreadyChildren
992− let commitActionToRunNow = if uc == 0
993− then Just $ commitAction
994− else Nothing -- A child will run it when unreadyChildren is decremented to 0
995− actions = case h of
996− HydrationMode_Hydrating -> Left dom
997− HydrationMode_Immediate -> Right commitActionToRunNow
998− return (actions, result)
999− let (hydrate', commitAction) = fanEither $ fmap fst child'
1000− addHydrationStepWithSetup (hold hydrate0 hydrate') $ \contents -> do
1001− hydrateStart
1002− join $ sample contents
1003− hydrateEnd
1004− requestDomAction_ $ fmapMaybe id commitAction
1005− return (result0, snd <$> child')
1006−
1007− {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
1008− traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjust'
1009− {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
1010− traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjust'
1011− {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
1012− traverseDMapWithKeyWithAdjustWithMove = do
1013− let updateChildUnreadiness (p :: PatchDMapWithMove k (Compose (TraverseDMapChild t m k) v')) old = do
1014− let new :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseDMapChild t m k) v') a -> IO (PatchDMapWithMove.NodeInfo k (Constant (IORef (ChildReadyState k))) a)
1015− new k = PatchDMapWithMove.nodeInfoMapFromM $ \case
1016− PatchDMapWithMove.From_Insert (Compose (TraverseDMapChild (Right myTypeImmediate) _)) -> do
1017− readIORef (_traverseDMapChildImmediate_childReadyState myTypeImmediate) >>= \case
1018− ChildReadyState_Ready -> return PatchDMapWithMove.From_Delete
1019− ChildReadyState_Unready _ -> do
1020− writeIORef (_traverseDMapChildImmediate_childReadyState myTypeImmediate) $ ChildReadyState_Unready $ Just $ Some.This k
1021− return $ PatchDMapWithMove.From_Insert $ Constant (_traverseDMapChildImmediate_childReadyState myTypeImmediate)
1022− PatchDMapWithMove.From_Delete -> return PatchDMapWithMove.From_Delete
1023− PatchDMapWithMove.From_Move fromKey -> return $ PatchDMapWithMove.From_Move fromKey
1024− deleteOrMove :: forall a. k a -> Product (Constant (IORef (ChildReadyState k))) (ComposeMaybe k) a -> IO (Constant () a)
1025− deleteOrMove _ (Pair (Constant sRef) (ComposeMaybe mToKey)) = do
1026− writeIORef sRef $ ChildReadyState_Unready $ Some.This <$> mToKey -- This will be Nothing if deleting, and Just if moving, so it works out in both cases
1027− return $ Constant ()
1028− p' <- fmap unsafePatchDMapWithMove $ DMap.traverseWithKey new $ unPatchDMapWithMove p
1029− _ <- DMap.traverseWithKey deleteOrMove $ PatchDMapWithMove.getDeletionsAndMoves p old
1030− return $ applyAlways p' old
1031− hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove updateChildUnreadiness $ \placeholders lastPlaceholder (p_ :: PatchDMapWithMove k (Compose (TraverseDMapChild t m k) v')) -> do
1032− let p = unPatchDMapWithMove p_
1033− phsBefore <- liftIO $ readIORef placeholders
1034− let collectIfMoved :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseDMapChild t m k) v') a -> JSM (Constant (Maybe DOM.DocumentFragment) a)
1035− collectIfMoved k e = do
1036− let mThisPlaceholder = Map.lookup (Some.This k) phsBefore -- Will be Nothing if this element wasn't present before
1037− nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsBefore
1038− case isJust $ getComposeMaybe $ PatchDMapWithMove._nodeInfo_to e of
1039− False -> do
1040− mapM_ (`deleteUpTo` nextPlaceholder) mThisPlaceholder
1041− return $ Constant Nothing
1042− True -> do
1043− Constant <$> mapM (`collectUpTo` nextPlaceholder) mThisPlaceholder
1044− collected <- DMap.traverseWithKey collectIfMoved p
1045− let !phsAfter = fromMaybe phsBefore $ apply (weakenPatchDMapWithMoveWith (_traverseDMapChildImmediate_placeholder . error "FIXME" . _traverseDMapChild_mode . getCompose) p_) phsBefore --TODO: Don't recompute this
1046− let placeFragment :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseDMapChild t m k) v') a -> JSM (Constant () a)
1047− placeFragment k e = do
1048− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsAfter
1049− case PatchDMapWithMove._nodeInfo_from e of
1050− PatchDMapWithMove.From_Insert (Compose (TraverseDMapChild x _)) -> case x of
1051− Left _ -> pure ()
1052− Right immediate -> _traverseDMapChildImmediate_fragment immediate `insertBefore` nextPlaceholder
1053− PatchDMapWithMove.From_Delete -> do
1054− return ()
1055− PatchDMapWithMove.From_Move fromKey -> do
1056− Just (Constant mdf) <- return $ DMap.lookup fromKey collected
1057− mapM_ (`insertBefore` nextPlaceholder) mdf
1058− return $ Constant ()
1059− 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
1060− liftIO $ writeIORef placeholders $! phsAfter
1061−
1062−{-# INLINABLE traverseDMapWithKeyWithAdjust' #-}
1063−traverseDMapWithKeyWithAdjust'
1064− :: forall t m (k :: * -> *) v v'. (Adjustable t m, MonadHold t m, MonadFix m, MonadJSM m, PrimMonad m, DMap.GCompare k)
1065− => (forall a. k a -> v a -> HydrationDomBuilderT t m (v' a))
1066− -> DMap k v
1067− -> Event t (PatchDMap k v)
1068− -> HydrationDomBuilderT t m (DMap k v', Event t (PatchDMap k v'))
1069−traverseDMapWithKeyWithAdjust' = do
1070− let updateChildUnreadiness (p :: PatchDMap k (Compose (TraverseDMapChild t m k) v')) old = do
1071− let new :: forall a. k a -> ComposeMaybe (Compose (TraverseDMapChild t m k) v') a -> IO (ComposeMaybe (Constant (IORef (ChildReadyState k))) a)
1072− new k (ComposeMaybe m) = ComposeMaybe <$> case m of
1073− Nothing -> return Nothing
1074− Just (Compose (TraverseDMapChild (Left hydration) _)) -> pure Nothing
1075− Just (Compose (TraverseDMapChild (Right immediate) _)) -> do
1076− readIORef (_traverseDMapChildImmediate_childReadyState immediate) >>= \case
1077− ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
1078− ChildReadyState_Unready _ -> do
1079− writeIORef (_traverseDMapChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some.This k
1080− return $ Just $ Constant (_traverseDMapChildImmediate_childReadyState immediate)
1081− delete _ (Constant sRef) = do
1082− writeIORef sRef $ ChildReadyState_Unready Nothing
1083− return $ Constant ()
1084− p' <- fmap PatchDMap $ DMap.traverseWithKey new $ unPatchDMap p
1085− _ <- DMap.traverseWithKey delete $ PatchDMap.getDeletions p old
1086− return $ applyAlways p' old
1087− hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap updateChildUnreadiness $ \placeholders lastPlaceholder (PatchDMap patch) -> do
1088− phs <- liftIO $ readIORef placeholders
1089− forM_ (DMap.toList patch) $ \(k :=> ComposeMaybe mv) -> do
1090− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phs
1091− -- Delete old node
1092− forM_ (Map.lookup (Some.This k) phs) $ \thisPlaceholder -> do
1093− thisPlaceholder `deleteUpTo` nextPlaceholder
1094− -- Insert new node
1095− forM_ mv $ \(Compose (TraverseDMapChild e _)) -> case e of
1096− Left _hydration -> pure ()
1097− Right immediate -> do
1098− _traverseDMapChildImmediate_fragment immediate `insertBefore` nextPlaceholder
1099− let weakened :: PatchMap (Some.Some k) (Either (TraverseDMapChildHydration t m) (TraverseDMapChildImmediate k))
1100− weakened = weakenPatchDMapWith (_traverseDMapChild_mode . getCompose) $ PatchDMap patch
1101− filtered :: PatchMap (Some.Some k) DOM.Text
1102− filtered = PatchMap $ flip Map.mapMaybe (unPatchMap weakened) $ \case
1103− Nothing -> Just Nothing -- deletion
1104− Just (Left _) -> Nothing
1105− Just (Right immediate) -> Just $ Just $ _traverseDMapChildImmediate_placeholder immediate
1106− a = apply filtered phs
1107− liftIO $ writeIORef placeholders $! fromMaybe phs a
1108−
1109−{-# INLINABLE traverseIntMapWithKeyWithAdjust' #-}
1110−traverseIntMapWithKeyWithAdjust'
1111− :: forall t m v v'. (Adjustable t m, MonadJSM m, MonadFix m, PrimMonad m, MonadHold t m)
1112− => (IntMap.Key -> v -> HydrationDomBuilderT t m v')
1113− -> IntMap v
1114− -> Event t (PatchIntMap v)
1115− -> HydrationDomBuilderT t m (IntMap v', Event t (PatchIntMap v'))
1116−traverseIntMapWithKeyWithAdjust' = do
1117− let updateChildUnreadiness (p@(PatchIntMap pInner) :: PatchIntMap (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')) old = do
1118− let new :: IntMap.Key -> Maybe (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> IO (Maybe (IORef ChildReadyStateInt))
1119− new k m = case m of
1120− Nothing -> return Nothing
1121− Just (_, _, _, sRef, _) -> do
1122− readIORef sRef >>= \case
1123− ChildReadyStateInt_Ready -> return Nothing -- Delete this child, since it's ready
1124− ChildReadyStateInt_Unready _ -> do
1125− writeIORef sRef $ ChildReadyStateInt_Unready $ Just k
1126− return $ Just sRef
1127− delete _ sRef = do
1128− writeIORef sRef $ ChildReadyStateInt_Unready Nothing
1129− return ()
1130− p' <- PatchIntMap <$> IntMap.traverseWithKey new pInner
1131− _ <- IntMap.traverseWithKey delete $ FastMutableIntMap.getDeletions p old
1132− return $ applyAlways p' old
1133− hoistTraverseIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust updateChildUnreadiness $ \placeholders lastPlaceholderRef (PatchIntMap p) -> do
1134− phs <- liftIO $ readIORef placeholders
1135− forM_ (IntMap.toList p) $ \(k, mv) -> do
1136− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
1137− let nextPlaceholder = maybe lastPlaceholder snd $ IntMap.lookupGT k phs
1138− forM_ (IntMap.lookup k phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
1139− forM_ mv $ \(_, df, _, _, _) -> df `insertBefore` nextPlaceholder
1140− liftIO $ writeIORef placeholders $! fromMaybe phs $ apply ((\(_, _, ph, _, _) -> ph) <$> PatchIntMap p) phs
1141−
1142−{-# INLINE hoistTraverseIntMapWithKeyWithAdjust #-}
1143−hoistTraverseIntMapWithKeyWithAdjust :: forall v v' t m p.
1144− ( Adjustable t m
1145− , MonadHold t m
1146− , MonadJSM m
1147− , MonadFix m
1148− , PrimMonad m
1149− , Monoid (p (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
1150− , Functor p
1151− , PatchTarget (p (HydrationRunnerT t m ())) ~ IntMap (HydrationRunnerT t m ())
1152− , Patch (p (HydrationRunnerT t m ()))
1153− )
1154− => ( (IntMap.Key -> v -> DomRenderHookT t m (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
1155− -> IntMap v
1156− -> Event t (p v)
1157− -> DomRenderHookT t m (IntMap (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'), Event t (p (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')))
1158− ) -- ^ The base monad's traversal
1159− -> (p (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> IntMap (IORef ChildReadyStateInt) -> IO (IntMap (IORef ChildReadyStateInt))) -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
1160− -> (IORef (IntMap DOM.Text) -> IORef DOM.Text -> p (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> JSM ()) -- ^ Apply a patch to the DOM
1161− -> (IntMap.Key -> v -> HydrationDomBuilderT t m v')
1162− -> IntMap v
1163− -> Event t (p v)
1164− -> HydrationDomBuilderT t m (IntMap v', Event t (p v'))
1165−hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
1166− initialEnv <- HydrationDomBuilderT ask
1167− let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
1168− pendingChange :: IORef (IntMap (IORef ChildReadyStateInt), p (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')) <- liftIO $ newIORef mempty
1169− haveEverBeenReady <- liftIO $ newIORef False
1170− placeholders <- liftIO $ newIORef $ error "placeholders not yet initialized"
1171− lastPlaceholderRef <- liftIO $ newIORef $ error "lastPlaceholderRef not yet initialized"
1172− let applyDomUpdate p = do
1173− applyDomUpdate_ placeholders lastPlaceholderRef p
1174− markSelfReady
1175− liftIO $ writeIORef pendingChange $! mempty
1176− markSelfReady = do
1177− liftIO (readIORef haveEverBeenReady) >>= \case
1178− True -> return ()
1179− False -> do
1180− liftIO $ writeIORef haveEverBeenReady True
1181− old <- liftIO $ readIORef parentUnreadyChildren
1182− let new = pred old
1183− liftIO $ writeIORef parentUnreadyChildren $! new
1184− when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
1185− markChildReady :: IORef ChildReadyStateInt -> JSM ()
1186− markChildReady childReadyState = do
1187− liftIO (readIORef childReadyState) >>= \case
1188− ChildReadyStateInt_Ready -> return ()
1189− ChildReadyStateInt_Unready countedAt -> do
1190− liftIO $ writeIORef childReadyState ChildReadyStateInt_Ready
1191− case countedAt of
1192− Nothing -> return ()
1193− Just k -> do -- This child has been counted as unready, so we need to remove it from the unready set
1194− (oldUnready, p) <- liftIO $ readIORef pendingChange
1195− when (not $ IntMap.null oldUnready) $ do -- This shouldn't actually ever be null
1196− let newUnready = IntMap.delete k oldUnready
1197− liftIO $ writeIORef pendingChange (newUnready, p)
1198− when (IntMap.null newUnready) $ do
1199− applyDomUpdate p
1200− (children0, children') <- HydrationDomBuilderT $ lift $ lift $ base (\k v -> drawChildUpdateInt initialEnv markChildReady $ f k v) dm0 dm'
1201− let processChild k (_, _, _, sRef, _) = do
1202− readIORef sRef >>= \case
1203− ChildReadyStateInt_Ready -> return Nothing
1204− ChildReadyStateInt_Unready _ -> do
1205− writeIORef sRef $ ChildReadyStateInt_Unready $ Just k
1206− return $ Just sRef
1207− initialUnready <- liftIO $ IntMap.mapMaybe id <$> IntMap.traverseWithKey processChild children0
1208− liftIO $ if IntMap.null initialUnready
1209− then writeIORef haveEverBeenReady True
1210− else do
1211− modifyIORef' parentUnreadyChildren succ
1212− writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
1213− let result0 = IntMap.map (\(_, _, _, _, v) -> v) children0
1214− placeholders0 = fmap (\(_, _, ph, _, _) -> ph) children0
1215− delayed0 :: IntMap (HydrationRunnerT t m ())
1216− delayed0 = IntMap.map (\(delayed, _, _, _, _) -> delayed) children0
1217− delayed' :: Event t (p (HydrationRunnerT t m ()))
1218− delayed' = ffor children' $ fmap $ \(delayed, _, _, _, _) -> delayed
1219− result' = ffor children' $ fmap $ \(_, _, _, _, r) -> r
1220− doc <- askDocument
1221− let setFinalPlaceholder = do
1222− ph <- createTextNode doc ("" :: Text)
1223− insertAfterPreviousNode ph
1224− liftIO $ writeIORef lastPlaceholderRef ph
1225− addHydrationStepWithSetup (accumMaybeB (flip apply) delayed0 delayed') $ \delayed -> do
1226− _ <- join $ sample (sequence . IntMap.elems <$> delayed)
1227− setFinalPlaceholder
1228− liftIO $ writeIORef placeholders $! placeholders0
1229− getHydrationMode >>= \case
1230− HydrationMode_Immediate -> void $ IntMap.traverseWithKey (\_ (_, df, _, _, _) -> void $ append $ toNode df) children0
1231− _ -> pure ()
1232− requestDomAction_ $ ffor children' $ \p -> do
1233− (oldUnready, oldP) <- liftIO $ readIORef pendingChange
1234− newUnready <- liftIO $ updateChildUnreadiness p oldUnready
1235− let !newP = p <> oldP
1236− liftIO $ writeIORef pendingChange (newUnready, newP)
1237− when (IntMap.null newUnready) $ do
1238− applyDomUpdate newP
1239− return (result0, result')
1240−
1241−insertAfterPreviousNode :: (Monad m, MonadJSM m) => DOM.IsNode node => node -> HydrationRunnerT t m ()
1242−insertAfterPreviousNode node = do
1243− parent <- askParent
1244− nextNode <- maybe (Node.getFirstChild parent) Node.getNextSibling =<< getPreviousNode
1245− Node.insertBefore_ parent node nextNode
1246− setPreviousNode $ Just $ toNode node
1247−
1248−data TraverseDMapChildImmediate k = TraverseDMapChildImmediate
1249− { _traverseDMapChildImmediate_fragment :: DOM.DocumentFragment
1250− -- ^ Child is appended to this fragment
1251− , _traverseDMapChildImmediate_placeholder :: DOM.Text
1252− -- ^ Placeholder reference
1253− , _traverseDMapChildImmediate_childReadyState :: IORef (ChildReadyState k)
1254− }
1255−
1256−newtype TraverseDMapChildHydration t m = TraverseDMapChildHydration
1257− { _traverseDMapChildHydration_delayed :: HydrationRunnerT t m DOM.Text
1258− -- ^ Action to run at switchover, returns the placeholder
1259− }
1260−
1261−data TraverseDMapChild t m k a = TraverseDMapChild
1262− { _traverseDMapChild_mode :: Either (TraverseDMapChildHydration t m) (TraverseDMapChildImmediate k)
1263− , _traverseDMapChild_result :: a
1264− }
1265−
1266−{-# INLINABLE hoistTraverseWithKeyWithAdjust #-}
1267−hoistTraverseWithKeyWithAdjust :: forall (k :: * -> *) v v' t m p.
1268− ( Adjustable t m
1269− , MonadHold t m
1270− , DMap.GCompare k
1271− , MonadIO m
1272− , MonadJSM m
1273− , PrimMonad m
1274− , MonadFix m
1275− , Patch (p k v)
1276− , Patch (p k (Constant Int))
1277− , PatchTarget (p k (Constant Int)) ~ DMap k (Constant Int)
1278− , Patch (p k (Compose (TraverseDMapChild t m k) v'))
1279− , PatchTarget (p k (Compose (TraverseDMapChild t m k) v')) ~ DMap k (Compose (TraverseDMapChild t m k) v')
1280− , Monoid (p k (Compose (TraverseDMapChild t m k) v'))
1281− )
1282− => (forall vv vv'.
1283− (forall a. k a -> vv a -> DomRenderHookT t m (vv' a))
1284− -> DMap k vv
1285− -> Event t (p k vv)
1286− -> DomRenderHookT t m (DMap k vv', Event t (p k vv'))
1287− )
1288− -- ^ The base monad's traversal
1289− -> (forall vv vv'. (forall a. vv a -> vv' a) -> p k vv -> p k vv')
1290− -- ^ A way of mapping over the patch type
1291− -> (p k (Compose (TraverseDMapChild t m k) v') -> DMap k (Constant (IORef (ChildReadyState k))) -> IO (DMap k (Constant (IORef (ChildReadyState k)))))
1292− -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
1293− -> (IORef (Map.Map (Some.Some k) DOM.Text) -> DOM.Text -> p k (Compose (TraverseDMapChild t m k) v') -> JSM ())
1294− -- ^ Apply a patch to the DOM
1295− -> (forall a. k a -> v a -> HydrationDomBuilderT t m (v' a))
1296− -> DMap k v
1297− -> Event t (p k v)
1298− -> HydrationDomBuilderT t m (DMap k v', Event t (p k v'))
1299−hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpdate_ (f :: forall a. k a -> v a -> HydrationDomBuilderT t m (v' a)) (dm0 :: DMap k v) dm' = do
1300− doc <- askDocument
1301− initialEnv <- HydrationDomBuilderT ask
1302− let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
1303− pendingChange :: IORef (DMap k (Constant (IORef (ChildReadyState k))), p k (Compose (TraverseDMapChild t m k) v')) <- liftIO $ newIORef mempty
1304− haveEverBeenReady <- liftIO $ newIORef False
1305− placeholders <- liftIO $ newIORef Map.empty
1306− lastPlaceholder <- createTextNode doc ("" :: Text)
1307− let applyDomUpdate p = do
1308− applyDomUpdate_ placeholders lastPlaceholder p
1309− markSelfReady
1310− liftIO $ writeIORef pendingChange $! mempty
1311− markSelfReady = do
1312− liftIO (readIORef haveEverBeenReady) >>= \case
1313− True -> return ()
1314− False -> do
1315− liftIO $ writeIORef haveEverBeenReady True
1316− old <- liftIO $ readIORef parentUnreadyChildren
1317− let new = pred old
1318− liftIO $ writeIORef parentUnreadyChildren $! new
1319− when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
1320− markChildReady :: IORef (ChildReadyState k) -> JSM ()
1321− markChildReady childReadyState = do
1322− liftIO (readIORef childReadyState) >>= \case
1323− ChildReadyState_Ready -> return ()
1324− ChildReadyState_Unready countedAt -> do
1325− liftIO $ writeIORef childReadyState ChildReadyState_Ready
1326− case countedAt of
1327− Nothing -> return ()
1328− Just (Some.This k) -> do -- This child has been counted as unready, so we need to remove it from the unready set
1329− (oldUnready, p) <- liftIO $ readIORef pendingChange
1330− when (not $ DMap.null oldUnready) $ do -- This shouldn't actually ever be null
1331− let newUnready = DMap.delete k oldUnready
1332− liftIO $ writeIORef pendingChange (newUnready, p)
1333− when (DMap.null newUnready) $ do
1334− applyDomUpdate p
1335− (children0 :: DMap k (Compose (TraverseDMapChild t m k) v'), children' :: Event t (p k (Compose (TraverseDMapChild t m k) v')))
1336− <- HydrationDomBuilderT $ lift $ lift $ base (\k v -> drawChildUpdate initialEnv markChildReady $ f k v) dm0 dm'
1337− let processChild k (Compose (TraverseDMapChild e _)) = case e of
1338− Left _ -> pure $ ComposeMaybe Nothing
1339− Right immediate -> ComposeMaybe <$> do
1340− readIORef (_traverseDMapChildImmediate_childReadyState immediate) >>= \case
1341− ChildReadyState_Ready -> return Nothing
1342− ChildReadyState_Unready _ -> do
1343− writeIORef (_traverseDMapChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some.This k
1344− return $ Just $ Constant (_traverseDMapChildImmediate_childReadyState immediate)
1345− initialUnready <- liftIO $ DMap.mapMaybeWithKey (\_ -> getComposeMaybe) <$> DMap.traverseWithKey processChild children0
1346− liftIO $ if DMap.null initialUnready
1347− then writeIORef haveEverBeenReady True
1348− else do
1349− modifyIORef' parentUnreadyChildren succ
1350− writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
1351− getHydrationMode >>= \case
1352− HydrationMode_Hydrating -> addHydrationStepWithSetup (holdIncremental children0 children') $ \children -> do
1353− dm :: DMap k (Compose (TraverseDMapChild t m k) v') <- sample $ currentIncremental children
1354− phs <- traverse id $ weakenDMapWith (either _traverseDMapChildHydration_delayed (pure . _traverseDMapChildImmediate_placeholder) . _traverseDMapChild_mode . getCompose) dm
1355− liftIO $ writeIORef placeholders $! phs
1356− insertAfterPreviousNode lastPlaceholder
1357− HydrationMode_Immediate -> do
1358− let activate i = do
1359− append $ toNode $ _traverseDMapChildImmediate_fragment i
1360− pure $ _traverseDMapChildImmediate_placeholder i
1361− phs <- traverse id $ weakenDMapWith ((either (error "delayed") activate) . _traverseDMapChild_mode . getCompose) children0
1362− liftIO $ writeIORef placeholders $! phs
1363− append $ toNode lastPlaceholder
1364−
1365− requestDomAction_ $ ffor children' $ \p -> do
1366− (oldUnready, oldP) <- liftIO $ readIORef pendingChange
1367− newUnready <- liftIO $ updateChildUnreadiness p oldUnready
1368− let !newP = p <> oldP
1369− liftIO $ writeIORef pendingChange (newUnready, newP)
1370− when (DMap.null newUnready) $ do
1371− applyDomUpdate newP
1372− let result0 = DMap.map (_traverseDMapChild_result . getCompose) children0
1373− result' = ffor children' $ mapPatch $ _traverseDMapChild_result . getCompose
1374− return (result0, result')
1375−
1376−{-# INLINABLE drawChildUpdate #-}
1377−drawChildUpdate :: (MonadIO m, MonadJSM m, Reflex t)
1378− => HydrationDomBuilderEnv t
1379− -> (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
1380− -> HydrationDomBuilderT t m (v' a)
1381− -> DomRenderHookT t m (Compose (TraverseDMapChild t m k) v' a)
1382−drawChildUpdate initialEnv markReady child = liftIO (readIORef $ _hydrationDomBuilderEnv_hydrationMode initialEnv) >>= \case
1383− HydrationMode_Hydrating -> do
1384− let doc = _hydrationDomBuilderEnv_document initialEnv
1385− unreadyChildren <- liftIO $ newIORef 0
1386− (result, childDelayed) <- flip runStateT (pure ()) $ runReaderT (unHydrationDomBuilderT child) initialEnv
1387− { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1388− }
1389− let delayed = do
1390− placeholder <- createTextNode doc ("" :: Text)
1391− insertAfterPreviousNode placeholder
1392− pure placeholder
1393− return $ Compose $ TraverseDMapChild
1394− { _traverseDMapChild_result = result
1395− , _traverseDMapChild_mode = Left TraverseDMapChildHydration
1396− { _traverseDMapChildHydration_delayed = delayed <* childDelayed
1397− }
1398− }
1399− HydrationMode_Immediate -> do
1400− childReadyState <- liftIO $ newIORef $ ChildReadyState_Unready Nothing
1401− let doc = _hydrationDomBuilderEnv_document initialEnv
1402− unreadyChildren <- liftIO $ newIORef 0
1403− df <- createDocumentFragment doc
1404− placeholder <- createTextNode doc ("" :: Text)
1405− Node.appendChild_ df placeholder
1406− parentRef <- liftIO . newIORef $ toNode df
1407− (result, _s) <- flip runStateT (pure ()) $ runReaderT (unHydrationDomBuilderT child) initialEnv
1408− { _hydrationDomBuilderEnv_parent = parentRef
1409− , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1410− , _hydrationDomBuilderEnv_commitAction = markReady childReadyState
1411− }
1412− u <- liftIO $ readIORef unreadyChildren
1413− when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyState_Ready
1414− return $ Compose $ TraverseDMapChild
1415− { _traverseDMapChild_result = result
1416− , _traverseDMapChild_mode = Right TraverseDMapChildImmediate
1417− { _traverseDMapChildImmediate_fragment = df
1418− , _traverseDMapChildImmediate_placeholder = placeholder
1419− , _traverseDMapChildImmediate_childReadyState = childReadyState
1420− }
1421− }
1422−
1423−{-# INLINABLE drawChildUpdateInt #-}
1424−drawChildUpdateInt :: (MonadIO m, MonadJSM m, Reflex t)
1425− => HydrationDomBuilderEnv t
1426− -> (IORef ChildReadyStateInt -> JSM ()) -- This will NOT be called if the child is ready at initialization time; instead, the ChildReadyState return value will be ChildReadyState_Ready
1427− -> HydrationDomBuilderT t m v'
1428− -> DomRenderHookT t m (HydrationRunnerT t m (), DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')
1429−drawChildUpdateInt initialEnv markReady child = do
1430− childReadyState <- liftIO $ newIORef $ ChildReadyStateInt_Unready Nothing
1431− let doc = _hydrationDomBuilderEnv_document initialEnv
1432− unreadyChildren <- liftIO $ newIORef 0
1433− hydrationMode <- liftIO $ readIORef $ _hydrationDomBuilderEnv_hydrationMode initialEnv
1434− placeholder <- createTextNode doc ("" :: Text)
1435− (p, delayed) <- case hydrationMode of
1436− HydrationMode_Hydrating -> pure
1437− ( Left $ _hydrationDomBuilderEnv_parent initialEnv
1438− , insertAfterPreviousNode placeholder
1439− )
1440− HydrationMode_Immediate -> do
1441− df <- createDocumentFragment doc
1442− Node.appendChild_ df placeholder
1443− pure (Right df, pure ())
1444− p' <- either pure (liftIO . newIORef . toNode) p
1445− (result, finalState) <- flip runStateT (pure ()) $ runReaderT (unHydrationDomBuilderT child) initialEnv
1446− { _hydrationDomBuilderEnv_parent = p'
1447− , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1448− , _hydrationDomBuilderEnv_commitAction = markReady childReadyState
1449− }
1450− u <- liftIO $ readIORef unreadyChildren
1451− when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyStateInt_Ready
1452− return
1453− ( delayed >> finalState
1454− , either (const $ error "drawChildUpdateInt: Tried to use document fragment in hydration mode") id p
1455− , placeholder, childReadyState, result
1456− )
1457−
1458−instance PerformEvent t m => PerformEvent t (HydrationDomBuilderT t m) where
1459− type Performable (HydrationDomBuilderT t m) = Performable m
1460− {-# INLINABLE performEvent_ #-}
1461− performEvent_ e = lift $ performEvent_ e
1462− {-# INLINABLE performEvent #-}
1463− performEvent e = lift $ performEvent e
1464−
1465−instance PostBuild t m => PostBuild t (HydrationDomBuilderT t m) where
1466− {-# INLINABLE getPostBuild #-}
1467− getPostBuild = lift getPostBuild
1468−
1469−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydrationDomBuilderT t m) where
1470− {-# INLINABLE newEventWithTrigger #-}
1471− newEventWithTrigger = lift . newEventWithTrigger
1472− {-# INLINABLE newFanEventWithTrigger #-}
1473− newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
1474−
1475−instance (Monad m, MonadRef m, Ref m ~ Ref IO, MonadReflexCreateTrigger t m) => TriggerEvent t (HydrationDomBuilderT t m) where
1476− {-# INLINABLE newTriggerEvent #-}
1477− newTriggerEvent = HydrationDomBuilderT . lift . lift $ newTriggerEvent
1478− {-# INLINABLE newTriggerEventWithOnComplete #-}
1479− newTriggerEventWithOnComplete = HydrationDomBuilderT . lift . lift $ newTriggerEventWithOnComplete
1480− {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
1481− newEventWithLazyTriggerWithOnComplete f = HydrationDomBuilderT . lift . lift $ newEventWithLazyTriggerWithOnComplete f
1482−
1483−instance (Monad m, MonadRef m, Ref m ~ Ref IO, MonadReflexCreateTrigger t m) => TriggerEvent t (DomRenderHookT t m) where
1484− {-# INLINABLE newTriggerEvent #-}
1485− newTriggerEvent = DomRenderHookT . lift $ newTriggerEvent
1486− {-# INLINABLE newTriggerEventWithOnComplete #-}
1487− newTriggerEventWithOnComplete = DomRenderHookT . lift $ newTriggerEventWithOnComplete
1488− {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
1489− newEventWithLazyTriggerWithOnComplete f = DomRenderHookT . lift $ newEventWithLazyTriggerWithOnComplete f
1490−
1491−instance HasJSContext m => HasJSContext (HydrationDomBuilderT t m) where
1492− type JSContextPhantom (HydrationDomBuilderT t m) = JSContextPhantom m
1493− askJSContext = lift askJSContext
1494−
1495−instance MonadRef m => MonadRef (HydrationDomBuilderT t m) where
1496− type Ref (HydrationDomBuilderT t m) = Ref m
1497− {-# INLINABLE newRef #-}
1498− newRef = lift . newRef
1499− {-# INLINABLE readRef #-}
1500− readRef = lift . readRef
1501− {-# INLINABLE writeRef #-}
1502− writeRef r = lift . writeRef r
1503−
1504−instance MonadAtomicRef m => MonadAtomicRef (HydrationDomBuilderT t m) where
1505− {-# INLINABLE atomicModifyRef #-}
1506− atomicModifyRef r = lift . atomicModifyRef r
1507−
1508−instance (HasJS x m, ReflexHost t) => HasJS x (HydrationDomBuilderT t m) where
1509− type JSX (HydrationDomBuilderT t m) = JSX m
1510− liftJS = lift . liftJS
1511−
1512−instance MonadSample t m => MonadSample t (HydrationDomBuilderT t m) where
1513− {-# INLINABLE sample #-}
1514− sample = lift . sample
1515−
1516−instance MonadHold t m => MonadHold t (HydrationDomBuilderT t m) where
1517− {-# INLINABLE hold #-}
1518− hold v0 v' = lift $ hold v0 v'
1519− {-# INLINABLE holdDyn #-}
1520− holdDyn v0 v' = lift $ holdDyn v0 v'
1521− {-# INLINABLE holdIncremental #-}
1522− holdIncremental v0 v' = lift $ holdIncremental v0 v'
1523− {-# INLINABLE buildDynamic #-}
1524− buildDynamic a0 = lift . buildDynamic a0
1525− {-# INLINABLE headE #-}
1526− headE = lift . headE
1527−
reflex-dom-core/src/Reflex/Dom/Builder/Immediate.hs+1739−577
@@ -2,7 +2,7 @@
2{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
3{-# LANGUAGE ConstraintKinds #-}
3{-# LANGUAGE ConstraintKinds #-}
4{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DataKinds #-}
5−{-# LANGUAGE DefaultSignatures #-}
5+{-# LANGUAGE DeriveTraversable #-}
6{-# LANGUAGE EmptyDataDecls #-}
6{-# LANGUAGE EmptyDataDecls #-}
7{-# LANGUAGE FlexibleContexts #-}
7{-# LANGUAGE FlexibleContexts #-}
8{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE FlexibleInstances #-}
@@ -11,14 +11,15 @@
11{-# LANGUAGE LambdaCase #-}
11{-# LANGUAGE LambdaCase #-}
12{-# LANGUAGE MultiParamTypeClasses #-}
12{-# LANGUAGE MultiParamTypeClasses #-}
13{-# LANGUAGE OverloadedStrings #-}
13{-# LANGUAGE OverloadedStrings #-}
14+{-# LANGUAGE PatternGuards #-}
14{-# LANGUAGE PolyKinds #-}
15{-# LANGUAGE PolyKinds #-}
15{-# LANGUAGE RankNTypes #-}
16{-# LANGUAGE RankNTypes #-}
16{-# LANGUAGE RecursiveDo #-}
17{-# LANGUAGE RecursiveDo #-}
17{-# LANGUAGE ScopedTypeVariables #-}
18{-# LANGUAGE ScopedTypeVariables #-}
18−{-# LANGUAGE StandaloneDeriving #-}
19#ifdef USE_TEMPLATE_HASKELL
19#ifdef USE_TEMPLATE_HASKELL
20{-# LANGUAGE TemplateHaskell #-}
20{-# LANGUAGE TemplateHaskell #-}
21#endif
21#endif
22+{-# LANGUAGE TupleSections #-}
22{-# LANGUAGE TypeFamilies #-}
23{-# LANGUAGE TypeFamilies #-}
23{-# LANGUAGE TypeOperators #-}
24{-# LANGUAGE TypeOperators #-}
24{-# LANGUAGE UndecidableInstances #-}
25{-# LANGUAGE UndecidableInstances #-}
@@ -26,184 +27,364 @@
26{-# LANGUAGE ForeignFunctionInterface #-}
27{-# LANGUAGE ForeignFunctionInterface #-}
27{-# LANGUAGE JavaScriptFFI #-}
28{-# LANGUAGE JavaScriptFFI #-}
28#endif
29#endif
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.
29module Reflex.Dom.Builder.Immediate
45module Reflex.Dom.Builder.Immediate
30− ( EventTriggerRef (..)
46+ ( HydrationDomBuilderT (..)
31− , ImmediateDomBuilderEnv (..)
47+ , HydrationDomBuilderEnv (..)
48+ , HydrationMode (..)
49+ , HydrationRunnerT (..)
50+ , runHydrationRunnerT
51+ , runHydrationRunnerTWithFailure
32− , ImmediateDomBuilderT (..)
52+ , ImmediateDomBuilderT
33− , runImmediateDomBuilderT
53+ , runHydrationDomBuilderT
54+ , getHydrationMode
55+ , addHydrationStep
56+ , addHydrationStepWithSetup
57+ , setPreviousNode
58+ , insertAfterPreviousNode
59+ , hydrateComment
34− , askParent
60+ , askParent
35− , askEvents
61+ , askEvents
36− , append
62+ , append
37− , textNodeInternal
63+ , textNodeInternal
64+ , removeSubsequentNodes
38− , deleteBetweenExclusive
65+ , deleteBetweenExclusive
39− , extractBetweenExclusive
66+ , extractBetweenExclusive
40− , deleteUpTo
67+ , deleteUpTo
41− , extractUpTo
68+ , extractUpTo
42− , SupportsImmediateDomBuilder
69+ , SupportsHydrationDomBuilder
43− , collectUpTo
70+ , collectUpTo
44− , collectUpToGivenParent
71+ , collectUpToGivenParent
72+ , EventTriggerRef (..)
45− , EventFilterTriggerRef (..)
73+ , EventFilterTriggerRef (..)
46− , wrap
74+ , wrap
47− , makeElement
75+ , elementInternal
76+ , HydrationDomSpace
77+ , GhcjsDomSpace
48− , GhcjsDomHandler (..)
78+ , GhcjsDomHandler (..)
49− , GhcjsDomHandler1 (..)
79+ , GhcjsDomHandler1 (..)
50− , GhcjsDomEvent (..)
80+ , GhcjsDomEvent (..)
51− , GhcjsDomSpace
52− , GhcjsEventFilter (..)
81+ , GhcjsEventFilter (..)
53− , Pair1 (..)
82+ , Pair1 (..)
54− , Maybe1 (..)
83+ , Maybe1 (..)
55− , GhcjsEventSpec (..)
84+ , GhcjsEventSpec (..)
56− , HasDocument (..)
85+ , HasDocument (..)
57− , ghcjsEventSpec_filters
86+ , ghcjsEventSpec_filters
58− , ghcjsEventSpec_handler
87+ , ghcjsEventSpec_handler
59− , GhcjsEventHandler (..)
88+ , GhcjsEventHandler (..)
60−#ifndef USE_TEMPLATE_HASKELL
61− , phantom2
62−#endif
63− , drawChildUpdate
89+ , drawChildUpdate
64− , ChildReadyState (..)
90+ , ChildReadyState (..)
65− , ChildReadyStateInt (..)
66− , mkHasFocus
91+ , mkHasFocus
67− , insertBefore
92+ , insertBefore
68− , EventType
93+ , EventType
69− , defaultDomEventHandler
94+ , defaultDomEventHandler
70− , defaultDomWindowEventHandler
95+ , defaultDomWindowEventHandler
71− , withIsEvent
96+ , withIsEvent
72− , showEventName
97+ , showEventName
73− , elementOnEventName
98+ , elementOnEventName
74− , windowOnEventName
99+ , windowOnEventName
75− , wrapDomEvent
100+ , wrapDomEvent
76− , subscribeDomEvent
101+ , subscribeDomEvent
77− , wrapDomEventMaybe
102+ , wrapDomEventMaybe
78− , wrapDomEventsMaybe
103+ , wrapDomEventsMaybe
79− , getKeyEvent
104+ , getKeyEvent
80− , getMouseEventCoords
105+ , getMouseEventCoords
81− , getTouchEvent
106+ , getTouchEvent
82− , WindowConfig (..)
107+ , WindowConfig (..)
83− , Window (..)
108+ , Window (..)
84− , wrapWindow
109+ , wrapWindow
110+ -- * Attributes for controlling hydration
111+ , hydratableAttribute
112+ , skipHydrationAttribute
85− -- * Internal
113+ -- * Internal
86− , traverseDMapWithKeyWithAdjust'
114+ , traverseDMapWithKeyWithAdjust'
87− , hoistTraverseWithKeyWithAdjust
115+ , hoistTraverseWithKeyWithAdjust
88− , traverseIntMapWithKeyWithAdjust'
116+ , traverseIntMapWithKeyWithAdjust'
89− , hoistTraverseIntMapWithKeyWithAdjust
117+ , hoistTraverseIntMapWithKeyWithAdjust
90− ) where
118+ ) where
91−
92−import Foreign.JavaScript.TH
93−import Reflex.Adjustable.Class
94−import Reflex.Class as Reflex
95−import Reflex.Dom.Builder.Class
96−import Reflex.Dynamic
97−import Reflex.Host.Class
98−import qualified Reflex.Patch.DMap as PatchDMap
99−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
100−import Reflex.PerformEvent.Class
101−import Reflex.PostBuild.Class
102−import Reflex.TriggerEvent.Base hiding (askEvents)
103−import qualified Reflex.TriggerEvent.Base as TriggerEventT (askEvents)
104−import Reflex.TriggerEvent.Class
105
119
106import Control.Concurrent
120import Control.Concurrent
107−import Control.Lens hiding (element, ix)
121+import Control.Exception (bracketOnError)
122+import Control.Lens (Identity(..), imapM_, iforM_, (^.), makeLenses)
108import Control.Monad.Exception
123import Control.Monad.Exception
109import Control.Monad.Primitive
124import Control.Monad.Primitive
110import Control.Monad.Reader
125import Control.Monad.Reader
111import Control.Monad.Ref
126import Control.Monad.Ref
112−#ifndef USE_TEMPLATE_HASKELL
127+import Control.Monad.State.Strict (StateT, mapStateT, get, modify', gets, runStateT)
113−import Data.Functor.Contravariant (phantom)
114−#endif
115import Data.Bitraversable
128import Data.Bitraversable
116import Data.Default
129import Data.Default
117import Data.Dependent.Map (DMap)
130import Data.Dependent.Map (DMap)
118−import qualified Data.Dependent.Map as DMap
119import Data.Dependent.Sum
131import Data.Dependent.Sum
132+import Data.FastMutableIntMap (PatchIntMap (..))
133+import Data.Foldable (for_, traverse_)
120import Data.Functor.Compose
134import Data.Functor.Compose
121import Data.Functor.Constant
135import Data.Functor.Constant
122import Data.Functor.Misc
136import Data.Functor.Misc
123import Data.Functor.Product
137import Data.Functor.Product
138+import Data.GADT.Compare (GCompare)
124import Data.IORef
139import Data.IORef
125−import qualified Data.Map as Map
140+import Data.IntMap.Strict (IntMap)
126import Data.Maybe
141import Data.Maybe
127−import Data.Monoid hiding (Product)
142+import Data.Monoid ((<>))
128−import Data.Some (Some)
143+import Data.Some (Some(..))
129−import qualified Data.Some as Some
144+import Data.GADT.Compare (GCompare)
145+import Data.String (IsString)
130import Data.Text (Text)
146import Data.Text (Text)
131−import qualified GHCJS.DOM as DOM
147+import Foreign.JavaScript.Internal.Utils
148+import Foreign.JavaScript.TH
149+import GHCJS.DOM.ClipboardEvent as ClipboardEvent
132import GHCJS.DOM.Document (Document, createDocumentFragment, createElement, createElementNS, createTextNode, createComment)
150import GHCJS.DOM.Document (Document, createDocumentFragment, createElement, createElementNS, createTextNode, createComment)
133−import GHCJS.DOM.Element (getScrollTop, removeAttribute, removeAttributeNS, setAttribute, setAttributeNS)
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
183+import qualified Data.Text as T
184+import qualified GHCJS.DOM as DOM
185+import qualified GHCJS.DOM.DataTransfer as DataTransfer
186+import qualified GHCJS.DOM.DocumentAndElementEventHandlers as Events
187+import qualified GHCJS.DOM.DocumentOrShadowRoot as Document
134import qualified GHCJS.DOM.Element as Element
188import qualified GHCJS.DOM.Element as Element
135import qualified GHCJS.DOM.Event as Event
189import qualified GHCJS.DOM.Event as Event
136−import qualified GHCJS.DOM.GlobalEventHandlers as Events
137−import qualified GHCJS.DOM.DocumentAndElementEventHandlers as Events
138−import GHCJS.DOM.EventM (EventM, event, on)
139import qualified GHCJS.DOM.EventM as DOM
190import qualified GHCJS.DOM.EventM as DOM
140import qualified GHCJS.DOM.FileList as FileList
191import qualified GHCJS.DOM.FileList as FileList
192+import qualified GHCJS.DOM.GlobalEventHandlers as Events
141import qualified GHCJS.DOM.HTMLInputElement as Input
193import qualified GHCJS.DOM.HTMLInputElement as Input
142import qualified GHCJS.DOM.HTMLSelectElement as Select
194import qualified GHCJS.DOM.HTMLSelectElement as Select
143import qualified GHCJS.DOM.HTMLTextAreaElement as TextArea
195import qualified GHCJS.DOM.HTMLTextAreaElement as TextArea
144−import GHCJS.DOM.MouseEvent
196+import qualified GHCJS.DOM.Node as Node
197+import qualified GHCJS.DOM.Text as DOM
145import qualified GHCJS.DOM.Touch as Touch
198import qualified GHCJS.DOM.Touch as Touch
146import qualified GHCJS.DOM.TouchEvent as TouchEvent
199import qualified GHCJS.DOM.TouchEvent as TouchEvent
147import qualified GHCJS.DOM.TouchList as TouchList
200import qualified GHCJS.DOM.TouchList as TouchList
148−import GHCJS.DOM.Node (appendChild_, getOwnerDocumentUnchecked, getParentNodeUnchecked, setNodeValue, toNode)
149−import qualified GHCJS.DOM.Node as DOM (insertBefore_)
150−import GHCJS.DOM.Types
151− (liftJSM, askJSM, runJSM, JSM, MonadJSM,
152− FocusEvent, IsElement, IsEvent, IsNode, KeyboardEvent, Node,
153− ToDOMString, TouchEvent, WheelEvent, uncheckedCastTo, ClipboardEvent)
154import qualified GHCJS.DOM.Types as DOM
201import qualified GHCJS.DOM.Types as DOM
155−import GHCJS.DOM.UIEvent
156−import GHCJS.DOM.KeyboardEvent as KeyboardEvent
157import qualified GHCJS.DOM.Window as Window
202import qualified GHCJS.DOM.Window as Window
158−import Language.Javascript.JSaddle (call, eval)
203+import qualified GHCJS.DOM.WheelEvent as WheelEvent
159−import Data.IntMap.Strict (IntMap)
204+import qualified Reflex.Patch.DMap as PatchDMap
160−import qualified Data.IntMap.Strict as IntMap
205+import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
161−import Data.FastMutableIntMap (PatchIntMap (..))
206+import qualified Reflex.Patch.MapWithMove as PatchMapWithMove
162−import qualified Data.FastMutableIntMap as FastMutableIntMap
207+import qualified Reflex.TriggerEvent.Base as TriggerEventT (askEvents)
163
208
164−import Reflex.Requester.Base
209+#ifndef USE_TEMPLATE_HASKELL
165−import Reflex.Requester.Class
210+import Data.Functor.Contravariant (phantom)
166−import Foreign.JavaScript.Internal.Utils
211+import Control.Lens (Lens', Getter)
212+#endif
167
213
168#ifndef ghcjs_HOST_OS
214#ifndef ghcjs_HOST_OS
169import GHCJS.DOM.Types (MonadJSM (..))
215import GHCJS.DOM.Types (MonadJSM (..))
170
216
171−instance MonadJSM m => MonadJSM (ImmediateDomBuilderT t m) where
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' #-}
172− liftJSM' = ImmediateDomBuilderT . liftJSM'
227+ liftJSM' = lift . liftJSM'
173#endif
228#endif
174
229
175−data ImmediateDomBuilderEnv t
230+data HydrationDomBuilderEnv t m = HydrationDomBuilderEnv
176− = ImmediateDomBuilderEnv { _immediateDomBuilderEnv_document :: {-# UNPACK #-} !Document
231+ { _hydrationDomBuilderEnv_document :: {-# UNPACK #-} !Document
177− , _immediateDomBuilderEnv_parent :: {-# UNPACK #-} !Node
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)
178− , _immediateDomBuilderEnv_unreadyChildren :: {-# UNPACK #-} !(IORef Word) -- Number of children who still aren't fully rendered
237+ -- ^ Number of children who still aren't fully rendered
238+ , _hydrationDomBuilderEnv_commitAction :: !(JSM ())
179− , _immediateDomBuilderEnv_commitAction :: !(JSM ()) -- Action to take when all children are ready --TODO: we should probably get rid of this once we invoke it
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 ()))
180− }
244+ }
181
245
182−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 }
183 deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
252 deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
184#if MIN_VERSION_base(4,9,1)
253#if MIN_VERSION_base(4,9,1)
185 , MonadAsyncException
254 , MonadAsyncException
186#endif
255#endif
187 )
256 )
188
257
189−instance PrimMonad m => PrimMonad (ImmediateDomBuilderT x m) where
258+instance PrimMonad m => PrimMonad (HydrationDomBuilderT s t m) where
190− type PrimState (ImmediateDomBuilderT x m) = PrimState m
259+ type PrimState (HydrationDomBuilderT s t m) = PrimState m
191 primitive = lift . primitive
260 primitive = lift . primitive
192
261
193−instance MonadTrans (ImmediateDomBuilderT t) where
262+instance MonadTrans (HydrationDomBuilderT s t) where
194− lift = ImmediateDomBuilderT . lift . lift . lift
263+ lift = HydrationDomBuilderT . lift . lift
264+
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_
269+
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+ )
195
356
196−instance (Reflex t, MonadFix m) => DomRenderHook t (ImmediateDomBuilderT t m) where
357+{-# INLINABLE runDomRenderHookT #-}
197− withRenderHook hook (ImmediateDomBuilderT a) = do
358+runDomRenderHookT
198− e <- ImmediateDomBuilderT ask
359+ :: (MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m), MonadRef m, Ref m ~ IORef)
199− ImmediateDomBuilderT $ lift $ withRequesting $ \rsp -> do
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
200− (x, req) <- lift $ runRequesterT (runReaderT a e) $ runIdentity <$> rsp
365+ rec (result, req) <- runRequesterT a rsp
366+ rsp <- performEventAsync $ ffor req $ \rm f -> liftJSM $ runInAnimationFrame f $
201− return (ffor req $ \rm -> hook $ traverseRequesterData (\r -> Identity <$> r) rm, x)
367+ traverseRequesterData (fmap Identity) rm
202− requestDomAction = ImmediateDomBuilderT . lift . requestingIdentity
368+ return result
203− requestDomAction_ = ImmediateDomBuilderT . lift . requesting_
369+ where
370+ runInAnimationFrame f x = void . DOM.inAnimationFrame' $ \_ -> do
371+ v <- synchronously x
372+ void . liftIO $ f v
204
373
374+instance MonadTrans (DomRenderHookT t) where
205−{-# INLINABLE runImmediateDomBuilderT #-}
375+ {-# INLINABLE lift #-}
206−runImmediateDomBuilderT
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
207 :: ( MonadFix m
388 :: ( MonadFix m
208 , PerformEvent t m
389 , PerformEvent t m
209 , MonadReflexCreateTrigger t m
390 , MonadReflexCreateTrigger t m
@@ -212,58 +393,76 @@ runImmediateDomBuilderT
212 , MonadRef m
393 , MonadRef m
213 , Ref m ~ IORef
394 , Ref m ~ IORef
214 )
395 )
215− => ImmediateDomBuilderT t m a
396+ => HydrationDomBuilderT s t m a
216− -> ImmediateDomBuilderEnv t
397+ -> HydrationDomBuilderEnv t m
217 -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
398 -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
218 -> m a
399 -> m a
219−runImmediateDomBuilderT (ImmediateDomBuilderT a) env eventChan =
400+runHydrationDomBuilderT (HydrationDomBuilderT a) env = runDomRenderHookT (runReaderT a env)
220− flip runTriggerEventT eventChan $ do
221− rec (x, req) <- runRequesterT (runReaderT a env) rsp
222− rsp <- performEventAsync $ ffor req $ \rm f -> liftJSM $ runInAnimationFrame f $
223− traverseRequesterData (\r -> Identity <$> r) rm
224− return x
225− where
226− runInAnimationFrame f x = void . DOM.inAnimationFrame' $ \_ -> do
227− v <- synchronously x
228− void . liftIO $ f v
229
401
230−instance Monad m => HasDocument (ImmediateDomBuilderT t m) where
402+instance (RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, Monad m) => HasDocument (HydrationDomBuilderT s t m) where
231 {-# INLINABLE askDocument #-}
403 {-# INLINABLE askDocument #-}
232− askDocument = ImmediateDomBuilderT $ asks _immediateDomBuilderEnv_document
404+ askDocument = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_document
233
405
234{-# INLINABLE askParent #-}
406{-# INLINABLE askParent #-}
235−askParent :: Monad m => ImmediateDomBuilderT t m Node
407+askParent :: Monad m => HydrationRunnerT t m DOM.Node
236−askParent = ImmediateDomBuilderT $ asks _immediateDomBuilderEnv_parent
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)
237
413
238{-# INLINABLE askEvents #-}
414{-# INLINABLE askEvents #-}
239−askEvents :: Monad m => ImmediateDomBuilderT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
415+askEvents :: Monad m => HydrationDomBuilderT s t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
240−askEvents = ImmediateDomBuilderT . lift . lift $ TriggerEventT.askEvents
416+askEvents = HydrationDomBuilderT . lift . DomRenderHookT . lift $ TriggerEventT.askEvents
241
417
242−localEnv :: Monad m => (ImmediateDomBuilderEnv t -> ImmediateDomBuilderEnv t) -> ImmediateDomBuilderT t m a -> ImmediateDomBuilderT t m a
418+{-# INLINABLE localEnv #-}
243−localEnv f = ImmediateDomBuilderT . local f . unImmediateDomBuilderT
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
244
421
245{-# INLINABLE append #-}
422{-# INLINABLE append #-}
246−append :: MonadJSM m => DOM.Node -> ImmediateDomBuilderT t m ()
423+append :: MonadJSM m => DOM.Node -> HydrationDomBuilderT s t m ()
247append n = do
424append n = do
248− p <- askParent
425+ p <- getParent
249 liftJSM $ appendChild_ p n
426 liftJSM $ appendChild_ p n
250 return ()
427 return ()
251
428
252−{-# INLINABLE textNodeInternal #-}
429+{-# SPECIALIZE append
253−textNodeInternal :: (MonadJSM m, ToDOMString contents) => contents -> ImmediateDomBuilderT t m DOM.Text
430+ :: DOM.Node
254−textNodeInternal !t = do
431+ -> HydrationDomBuilderT s Spider HydrationM ()
255− doc <- askDocument
432+ #-}
256− n <- liftJSM $ createTextNode doc t
257− append $ toNode n
258− return n
259
433
260−{-# INLINABLE commentNodeInternal #-}
434+data HydrationMode
261−commentNodeInternal :: (MonadJSM m, ToDOMString contents) => contents -> ImmediateDomBuilderT t m DOM.Comment
435+ = HydrationMode_Hydrating
262−commentNodeInternal !t = do
436+ -- ^ The time from initial load to parity with static builder
263− doc <- askDocument
437+ | HydrationMode_Immediate
264− n <- liftJSM $ createComment doc t
438+ -- ^ After hydration
265− append $ toNode n
439+ deriving (Eq, Ord, Show)
266− return n
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]
267
466
268-- | s and e must both be children of the same node and s must precede e;
467-- | s and e must both be children of the same node and s must precede e;
269-- all nodes between s and e will be removed, but s and e will not be removed
468-- all nodes between s and e will be removed, but s and e will not be removed
@@ -301,7 +500,7 @@ extractUpTo df s e = liftJSM $ do
301 void $ call f f (df, s, e)
500 void $ call f f (df, s, e)
302#endif
501#endif
303
502
304−type SupportsImmediateDomBuilder 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)
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))
305
504
306{-# INLINABLE collectUpTo #-}
505{-# INLINABLE collectUpTo #-}
307collectUpTo :: (MonadJSM m, IsNode start, IsNode end) => start -> end -> m DOM.DocumentFragment
506collectUpTo :: (MonadJSM m, IsNode start, IsNode end) => start -> end -> m DOM.DocumentFragment
@@ -319,10 +518,15 @@ collectUpToGivenParent currentParent s e = do
319
518
320newtype EventFilterTriggerRef t er (en :: EventTag) = EventFilterTriggerRef (IORef (Maybe (EventTrigger t (er en))))
519newtype EventFilterTriggerRef t er (en :: EventTag) = EventFilterTriggerRef (IORef (Maybe (EventTrigger t (er en))))
321
520
322−{-# INLINABLE wrap #-}
521+-- | This 'wrap' is only partial: it doesn't create the 'EventSelector' itself
522+{-# INLINE wrap #-}
523+wrap
323−wrap :: forall m er t. (Reflex t, MonadFix m, MonadJSM m, MonadReflexCreateTrigger t m) => RawElement GhcjsDomSpace -> RawElementConfig er t GhcjsDomSpace -> ImmediateDomBuilderT t m (Element er GhcjsDomSpace t)
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))
324−wrap e cfg = do
529+wrap events e cfg = do
325− events <- askEvents
326 forM_ (_rawElementConfig_modifyAttributes cfg) $ \modifyAttrs -> requestDomAction_ $ ffor modifyAttrs $ imapM_ $ \(AttributeName mAttrNamespace n) mv -> case mAttrNamespace of
530 forM_ (_rawElementConfig_modifyAttributes cfg) $ \modifyAttrs -> requestDomAction_ $ ffor modifyAttrs $ imapM_ $ \(AttributeName mAttrNamespace n) mv -> case mAttrNamespace of
327 Nothing -> maybe (removeAttribute e n) (setAttribute e n) mv
531 Nothing -> maybe (removeAttribute e n) (setAttribute e n) mv
328 Just ns -> maybe (removeAttributeNS e (Just ns) n) (setAttributeNS e (Just ns) n) mv
532 Just ns -> maybe (removeAttributeNS e (Just ns) n) (setAttributeNS e (Just ns) n) mv
@@ -339,46 +543,74 @@ wrap e cfg = do
339 mv <- liftJSM k --TODO: Only do this when the event is subscribed
543 mv <- liftJSM k --TODO: Only do this when the event is subscribed
340 liftIO $ forM_ mv $ \v -> writeChan events [EventTriggerRef triggerRef :=> TriggerInvocation v (return ())]
544 liftIO $ forM_ mv $ \v -> writeChan events [EventTriggerRef triggerRef :=> TriggerInvocation v (return ())]
341 return $ en :=> EventFilterTriggerRef triggerRef
545 return $ en :=> EventFilterTriggerRef triggerRef
342− es <- do
546+ return eventTriggerRefs
343− let h :: GhcjsEventHandler er
547+
344− !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
548+{-# SPECIALIZE wrap
345− ctx <- askJSM
549+ :: Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
346− newFanEventWithTrigger $ \(WrapArg en) t ->
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 ())
347− case DMap.lookup en eventTriggerRefs of
573+triggerBody ctx cfg events eventTriggerRefs e (WrapArg en) t = case DMap.lookup en eventTriggerRefs of
348− Just (EventFilterTriggerRef r) -> do
574+ Just (EventFilterTriggerRef r) -> do
349− writeIORef r $ Just t
575+ writeIORef r $ Just t
350− return $ do
576+ return $ do
351− writeIORef r Nothing
577+ writeIORef r Nothing
352− Nothing -> (`runJSM` ctx) <$> (`runJSM` ctx) (elementOnEventName en e $ do
578+ Nothing -> (`runJSM` ctx) <$> (`runJSM` ctx) (elementOnEventName en e $ do
353− evt <- DOM.event
579+ evt <- DOM.event
354− mv <- lift $ unGhcjsEventHandler h (en, GhcjsDomEvent evt)
580+ mv <- lift $ unGhcjsEventHandler handler (en, GhcjsDomEvent evt)
355− case mv of
581+ case mv of
356− Nothing -> return ()
582+ Nothing -> return ()
357− Just v -> liftIO $ do
583+ Just v -> liftIO $ do
358− --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
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
359− ref <- newIORef $ Just t
585+ ref <- newIORef $ Just t
360− writeChan events [EventTriggerRef ref :=> TriggerInvocation v (return ())])
586+ writeChan events [EventTriggerRef ref :=> TriggerInvocation v (return ())])
361− return $ Element
587+ where
362− { _element_events = es
588+ -- Note: this needs to be done strictly and outside of the newFanEventWithTrigger, so that the newFanEventWithTrigger doesn't
363− , _element_raw = e
589+ -- retain the entire cfg, which can cause a cyclic dependency that the GC won't be able to clean up
364− }
590+ handler :: GhcjsEventHandler er
365−
591+ !handler = _ghcjsEventSpec_handler $ _rawElementConfig_eventSpec cfg
366−{-# INLINABLE makeElement #-}
592+
367−makeElement :: forall er t m a. (MonadJSM m, MonadFix m, MonadReflexCreateTrigger t m, Adjustable t m) => Text -> ElementConfig er t GhcjsDomSpace -> ImmediateDomBuilderT t m a -> ImmediateDomBuilderT t m ((Element er GhcjsDomSpace t, a), DOM.Element)
593+{-# SPECIALIZE triggerBody
368−makeElement elementTag cfg child = do
594+ :: DOM.JSContextRef
369− doc <- askDocument
595+ -> RawElementConfig er DomTimeline HydrationDomSpace
370− e <- liftJSM $ uncheckedCastTo DOM.Element <$> case cfg ^. namespace of
596+ -> Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
371− Nothing -> createElement doc elementTag
597+ -> DMap EventName (EventFilterTriggerRef DomTimeline er)
372− Just ens -> createElementNS doc (Just ens) elementTag
598+ -> DOM.Element
373− ImmediateDomBuilderT $ iforM_ (cfg ^. initialAttributes) $ \(AttributeName mAttrNamespace n) v -> case mAttrNamespace of
599+ -> WrapArg er EventName x
374− Nothing -> lift $ setAttribute e n v
600+ -> EventTrigger DomTimeline x
375− Just ans -> lift $ setAttributeNS e (Just ans) n v
601+ -> IO (IO ())
376− result <- flip localEnv child $ \env -> env
602+ #-}
377− { _immediateDomBuilderEnv_parent = toNode e
603+
378− }
604+{-# SPECIALIZE triggerBody
379− append $ toNode e
605+ :: DOM.JSContextRef
380− wrapped <- wrap e $ extractRawElementConfig cfg
606+ -> RawElementConfig er DomTimeline GhcjsDomSpace
381− return ((wrapped, result), e)
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+ #-}
382
614
383newtype GhcjsDomHandler a b = GhcjsDomHandler { unGhcjsDomHandler :: a -> JSM b }
615newtype GhcjsDomHandler a b = GhcjsDomHandler { unGhcjsDomHandler :: a -> JSM b }
384
616
@@ -425,15 +657,11 @@ data GhcjsEventSpec er = GhcjsEventSpec
425newtype GhcjsEventHandler er = GhcjsEventHandler { unGhcjsEventHandler :: forall en. (EventName en, GhcjsDomEvent en) -> JSM (Maybe (er en)) }
657newtype GhcjsEventHandler er = GhcjsEventHandler { unGhcjsEventHandler :: forall en. (EventName en, GhcjsDomEvent en) -> JSM (Maybe (er en)) }
426
658
427#ifndef USE_TEMPLATE_HASKELL
659#ifndef USE_TEMPLATE_HASKELL
428−phantom2 :: (Functor f, Contravariant f) => f a -> f b
429−phantom2 = phantom
430−{-# INLINE phantom2 #-}
431−
432ghcjsEventSpec_filters :: forall er . Lens' (GhcjsEventSpec er) (DMap EventName (GhcjsEventFilter er))
660ghcjsEventSpec_filters :: forall er . Lens' (GhcjsEventSpec er) (DMap EventName (GhcjsEventFilter er))
433ghcjsEventSpec_filters f (GhcjsEventSpec a b) = (\a' -> GhcjsEventSpec a' b) <$> f a
661ghcjsEventSpec_filters f (GhcjsEventSpec a b) = (\a' -> GhcjsEventSpec a' b) <$> f a
434{-# INLINE ghcjsEventSpec_filters #-}
662{-# INLINE ghcjsEventSpec_filters #-}
435ghcjsEventSpec_handler :: forall er en . Getter (GhcjsEventSpec er) ((EventName en, GhcjsDomEvent en) -> JSM (Maybe (er en)))
663ghcjsEventSpec_handler :: forall er en . Getter (GhcjsEventSpec er) ((EventName en, GhcjsDomEvent en) -> JSM (Maybe (er en)))
436−ghcjsEventSpec_handler f (GhcjsEventSpec _ (GhcjsEventHandler b)) = phantom2 (f b)
664+ghcjsEventSpec_handler f (GhcjsEventSpec _ (GhcjsEventHandler b)) = phantom (f b)
437{-# INLINE ghcjsEventSpec_handler #-}
665{-# INLINE ghcjsEventSpec_handler #-}
438#endif
666#endif
439
667
@@ -446,142 +674,794 @@ instance er ~ EventResult => Default (GhcjsEventSpec er) where
446 runReaderT (defaultDomEventHandler e en) evt
674 runReaderT (defaultDomEventHandler e en) evt
447 }
675 }
448
676
449−instance SupportsImmediateDomBuilder t m => NotReady t (ImmediateDomBuilderT t m) where
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
949+ let domInputElement = uncheckedCastTo DOM.HTMLInputElement domElement
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
988+ oldChecked <- Input.getChecked domInputElement
989+ Input.setChecked domInputElement newChecked
990+ when (newChecked /= oldChecked) $ liftIO $ triggerCheckedChangedBySetChecked newChecked
991+ _ <- liftJSM $ domInputElement `on` Events.change $ do
992+ mfiles <- Input.getFiles domInputElement
993+ let getMyFiles xs = fmap catMaybes . mapM (FileList.item xs) . flip take [0..] . fromIntegral =<< FileList.getLength xs
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
1072+ let domTextAreaElement = uncheckedCastTo DOM.HTMLTextAreaElement domElement
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
1165+ let domSelectElement = uncheckedCastTo DOM.HTMLSelectElement domElement
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
1175+ Select.setValue domSelectElement v'
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
450 notReadyUntil e = do
1387 notReadyUntil e = do
451 eOnce <- headE e
1388 eOnce <- headE e
452− env <- ImmediateDomBuilderT ask
1389+ unreadyChildren <- askUnreadyChildren
453− let unreadyChildren = _immediateDomBuilderEnv_unreadyChildren env
1390+ commitAction <- askCommitAction
454 liftIO $ modifyIORef' unreadyChildren succ
1391 liftIO $ modifyIORef' unreadyChildren succ
455 let ready = do
1392 let ready = do
456 old <- liftIO $ readIORef unreadyChildren
1393 old <- liftIO $ readIORef unreadyChildren
457 let new = pred old
1394 let new = pred old
458 liftIO $ writeIORef unreadyChildren $! new
1395 liftIO $ writeIORef unreadyChildren $! new
459− when (new == 0) $ _immediateDomBuilderEnv_commitAction env
1396+ when (new == 0) commitAction
460 requestDomAction_ $ ready <$ eOnce
1397 requestDomAction_ $ ready <$ eOnce
461 notReady = do
1398 notReady = do
462− env <- ImmediateDomBuilderT ask
1399+ unreadyChildren <- askUnreadyChildren
463− let unreadyChildren = _immediateDomBuilderEnv_unreadyChildren env
464 liftIO $ modifyIORef' unreadyChildren succ
1400 liftIO $ modifyIORef' unreadyChildren succ
465
1401
466−instance SupportsImmediateDomBuilder t m => DomBuilder t (ImmediateDomBuilderT t m) where
1402+data HydrationDomSpace
467− type DomBuilderSpace (ImmediateDomBuilderT t m) = GhcjsDomSpace
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
468 {-# INLINABLE textNode #-}
1431 {-# INLINABLE textNode #-}
469− textNode (TextNodeConfig initialContents mSetContents) = do
470− n <- textNodeInternal initialContents
1432+ textNode = textNodeInternal
471− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
472− return $ TextNode n
473 {-# INLINABLE commentNode #-}
1433 {-# INLINABLE commentNode #-}
474− commentNode (CommentNodeConfig initialContents mSetContents) = do
475− n <- commentNodeInternal initialContents
1434+ commentNode = commentNodeInternal
476− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
1435+ {-# INLINABLE inputElement #-}
477− return $ CommentNode n
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
478 {-# INLINABLE element #-}
1446 {-# INLINABLE element #-}
479− element elementTag cfg child = fst <$> makeElement elementTag cfg child
1447+ element = elementImmediate
1448+ {-# INLINABLE textNode #-}
1449+ textNode = fmap TextNode . textNodeImmediate
1450+ {-# INLINABLE commentNode #-}
1451+ commentNode = fmap CommentNode . commentNodeImmediate
480 {-# INLINABLE inputElement #-}
1452 {-# INLINABLE inputElement #-}
481− inputElement cfg = do
1453+ inputElement = inputElementImmediate
482− ((e, _), domElement) <- makeElement "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
483− let domInputElement = uncheckedCastTo DOM.HTMLInputElement domElement
484− Input.setValue domInputElement $ cfg ^. inputElementConfig_initialValue
485− v0 <- Input.getValue domInputElement
486− let getMyValue = Input.getValue domInputElement
487− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Input)
488− valueChangedBySetValue <- case _inputElementConfig_setValue cfg of
489− Nothing -> return never
490− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
491− Input.setValue domInputElement v'
492− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
493− v <- holdDyn v0 $ leftmost
494− [ valueChangedBySetValue
495− , valueChangedByUI
496− ]
497− Input.setChecked domInputElement $ _inputElementConfig_initialChecked cfg
498− checkedChangedByUI <- wrapDomEvent domInputElement (`on` Events.click) $ do
499− Input.getChecked domInputElement
500− checkedChangedBySetChecked <- case _inputElementConfig_setChecked cfg of
501− Nothing -> return never
502− Just eNewchecked -> requestDomAction $ ffor eNewchecked $ \newChecked -> do
503− oldChecked <- Input.getChecked domInputElement
504− Input.setChecked domInputElement newChecked
505− return $ if newChecked /= oldChecked
506− then Just newChecked
507− else Nothing
508− c <- holdDyn (_inputElementConfig_initialChecked cfg) $ leftmost
509− [ fmapMaybe id checkedChangedBySetChecked
510− , checkedChangedByUI
511− ]
512− let initialFocus = False --TODO: Is this correct?
513− hasFocus <- holdDyn initialFocus $ leftmost
514− [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
515− , True <$ Reflex.select (_element_events e) (WrapArg Focus)
516− ]
517− files <- holdDyn mempty <=< wrapDomEvent domInputElement (`on` Events.change) $ do
518− mfiles <- Input.getFiles domInputElement
519− let getMyFiles xs = fmap catMaybes . mapM (FileList.item xs) . flip take [0..] . fromIntegral =<< FileList.getLength xs
520− maybe (return []) getMyFiles mfiles
521− checked <- holdUniqDyn c
522− return $ InputElement
523− { _inputElement_value = v
524− , _inputElement_checked = checked
525− , _inputElement_checkedChange = checkedChangedByUI
526− , _inputElement_input = valueChangedByUI
527− , _inputElement_hasFocus = hasFocus
528− , _inputElement_element = e
529− , _inputElement_raw = domInputElement
530− , _inputElement_files = files
531− }
532 {-# INLINABLE textAreaElement #-}
1454 {-# INLINABLE textAreaElement #-}
533− textAreaElement cfg = do --TODO
1455+ textAreaElement = textAreaElementImmediate
534− ((e, _), domElement) <- makeElement "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
535− let domTextAreaElement = uncheckedCastTo DOM.HTMLTextAreaElement domElement
536− TextArea.setValue domTextAreaElement $ cfg ^. textAreaElementConfig_initialValue
537− v0 <- TextArea.getValue domTextAreaElement
538− let getMyValue = TextArea.getValue domTextAreaElement
539− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Input)
540− valueChangedBySetValue <- case _textAreaElementConfig_setValue cfg of
541− Nothing -> return never
542− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
543− TextArea.setValue domTextAreaElement v'
544− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
545− v <- holdDyn v0 $ leftmost
546− [ valueChangedBySetValue
547− , valueChangedByUI
548− ]
549− hasFocus <- mkHasFocus e
550− return $ TextAreaElement
551− { _textAreaElement_value = v
552− , _textAreaElement_input = valueChangedByUI
553− , _textAreaElement_hasFocus = hasFocus
554− , _textAreaElement_element = e
555− , _textAreaElement_raw = domTextAreaElement
556− }
557 {-# INLINABLE selectElement #-}
1456 {-# INLINABLE selectElement #-}
558− selectElement cfg child = do
1457+ selectElement = selectElementImmediate
559− ((e, result), domElement) <- makeElement "select" (cfg ^. selectElementConfig_elementConfig) child
560− let domSelectElement = uncheckedCastTo DOM.HTMLSelectElement domElement
561− Select.setValue domSelectElement $ cfg ^. selectElementConfig_initialValue
562− v0 <- Select.getValue domSelectElement
563− let getMyValue = Select.getValue domSelectElement
564− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Change)
565− valueChangedBySetValue <- case _selectElementConfig_setValue cfg of
566− Nothing -> return never
567− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
568− Select.setValue domSelectElement v'
569− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
570− v <- holdDyn v0 $ leftmost
571− [ valueChangedBySetValue
572− , valueChangedByUI
573− ]
574− hasFocus <- mkHasFocus e
575− let wrapped = SelectElement
576− { _selectElement_value = v
577− , _selectElement_change = valueChangedByUI
578− , _selectElement_hasFocus = hasFocus
579− , _selectElement_element = e
580− , _selectElement_raw = domSelectElement
581− }
582− return (wrapped, result)
583 placeRawElement = append . toNode
1458 placeRawElement = append . toNode
584− wrapRawElement = wrap
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
585
1465
586data FragmentState
1466data FragmentState
587 = FragmentState_Unmounted
1467 = FragmentState_Unmounted
@@ -601,21 +1481,21 @@ extractFragment fragment = do
601 extractBetweenExclusive (_immediateDomFragment_document fragment) before after
1481 extractBetweenExclusive (_immediateDomFragment_document fragment) before after
602 liftIO $ writeIORef (_immediateDomFragment_state fragment) FragmentState_Unmounted
1482 liftIO $ writeIORef (_immediateDomFragment_state fragment) FragmentState_Unmounted
603
1483
604−instance SupportsImmediateDomBuilder t m => MountableDomBuilder t (ImmediateDomBuilderT t m) where
1484+instance SupportsHydrationDomBuilder t m => MountableDomBuilder t (HydrationDomBuilderT GhcjsDomSpace t m) where
605− type DomFragment (ImmediateDomBuilderT t m) = ImmediateDomFragment
1485+ type DomFragment (HydrationDomBuilderT GhcjsDomSpace t m) = ImmediateDomFragment
606 buildDomFragment w = do
1486 buildDomFragment w = do
607 df <- createDocumentFragment =<< askDocument
1487 df <- createDocumentFragment =<< askDocument
608 result <- flip localEnv w $ \env -> env
1488 result <- flip localEnv w $ \env -> env
609− { _immediateDomBuilderEnv_parent = toNode df
1489+ { _hydrationDomBuilderEnv_parent = Left $ toNode df
610 }
1490 }
611 state <- liftIO $ newIORef FragmentState_Unmounted
1491 state <- liftIO $ newIORef FragmentState_Unmounted
612 return (ImmediateDomFragment df state, result)
1492 return (ImmediateDomFragment df state, result)
613 mountDomFragment fragment setFragment = do
1493 mountDomFragment fragment setFragment = do
614− parent <- askParent
1494+ parent <- getParent
615 extractFragment fragment
1495 extractFragment fragment
616− before <- textNodeInternal ("" :: Text)
1496+ before <- textNodeImmediate $ TextNodeConfig ("" :: Text) Nothing
617 appendChild_ parent $ _immediateDomFragment_document fragment
1497 appendChild_ parent $ _immediateDomFragment_document fragment
618− after <- textNodeInternal ("" :: Text)
1498+ after <- textNodeImmediate $ TextNodeConfig ("" :: Text) Nothing
619 xs <- foldDyn (\new (previous, _) -> (new, Just previous)) (fragment, Nothing) setFragment
1499 xs <- foldDyn (\new (previous, _) -> (new, Just previous)) (fragment, Nothing) setFragment
620 requestDomAction_ $ ffor (updated xs) $ \(childFragment, Just previousFragment) -> do
1500 requestDomAction_ $ ffor (updated xs) $ \(childFragment, Just previousFragment) -> do
621 extractFragment previousFragment
1501 extractFragment previousFragment
@@ -624,12 +1504,19 @@ instance SupportsImmediateDomBuilder t m => MountableDomBuilder t (ImmediateDomB
624 liftIO $ writeIORef (_immediateDomFragment_state childFragment) $ FragmentState_Mounted (before, after)
1504 liftIO $ writeIORef (_immediateDomFragment_state childFragment) $ FragmentState_Mounted (before, after)
625 liftIO $ writeIORef (_immediateDomFragment_state fragment) $ FragmentState_Mounted (before, after)
1505 liftIO $ writeIORef (_immediateDomFragment_state fragment) $ FragmentState_Mounted (before, after)
626
1506
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+
627−instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimMonad m) => Adjustable t (ImmediateDomBuilderT t m) where
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
628 {-# INLINABLE runWithReplace #-}
1514 {-# INLINABLE runWithReplace #-}
629 runWithReplace a0 a' = do
1515 runWithReplace a0 a' = do
630− initialEnv <- ImmediateDomBuilderT ask
1516+ initialEnv <- HydrationDomBuilderT ask
631− before <- textNodeInternal ("" :: Text)
1517+ let hydrating = _hydrationDomBuilderEnv_hydrationMode initialEnv
1518+ (hydrateStart, before, beforeKey) <- skipToReplaceStart
632− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
1519+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
633 haveEverBeenReady <- liftIO $ newIORef False
1520 haveEverBeenReady <- liftIO $ newIORef False
634 currentCohort <- liftIO $ newIORef (-1 :: Int) -- Equal to the cohort currently in the DOM
1521 currentCohort <- liftIO $ newIORef (-1 :: Int) -- Equal to the cohort currently in the DOM
635 let myCommitAction = do
1522 let myCommitAction = do
@@ -640,79 +1527,117 @@ instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimM
640 old <- liftIO $ readIORef parentUnreadyChildren
1527 old <- liftIO $ readIORef parentUnreadyChildren
641 let new = pred old
1528 let new = pred old
642 liftIO $ writeIORef parentUnreadyChildren $! new
1529 liftIO $ writeIORef parentUnreadyChildren $! new
643− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
1530+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
644 -- We draw 'after' in this roundabout way to avoid using MonadFix
1531 -- We draw 'after' in this roundabout way to avoid using MonadFix
645 doc <- askDocument
1532 doc <- askDocument
646− after <- createTextNode doc ("" :: Text)
1533+ parent <- getParent
1534+ (hydrateEnd, after) <- skipToReplaceEnd beforeKey
647 let drawInitialChild = do
1535 let drawInitialChild = do
1536+ h <- liftIO $ readIORef hydrating
1537+ p' <- case h of
1538+ HydrationMode_Hydrating -> pure parent
1539+ HydrationMode_Immediate -> toNode <$> createDocumentFragment doc
648 unreadyChildren <- liftIO $ newIORef 0
1540 unreadyChildren <- liftIO $ newIORef 0
649− let f = do
1541+ let a0' = case h of
650− result <- a0
1542+ HydrationMode_Hydrating -> a0
651− append $ toNode after
1543+ HydrationMode_Immediate -> do
652− return result
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
653− result <- runReaderT (unImmediateDomBuilderT f) $ initialEnv
1550+ result <- runReaderT (unHydrationDomBuilderT a0') initialEnv
654− { _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
1551+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
655− , _immediateDomBuilderEnv_commitAction = myCommitAction
1552+ , _hydrationDomBuilderEnv_commitAction = myCommitAction
1553+ , _hydrationDomBuilderEnv_parent = Left p'
1554+ , _hydrationDomBuilderEnv_delayed = delayed
656 }
1555 }
1556+ dom <- case h of
1557+ HydrationMode_Hydrating -> liftIO $ readIORef delayed
1558+ HydrationMode_Immediate -> pure $ pure ()
657 liftIO $ readIORef unreadyChildren >>= \case
1559 liftIO $ readIORef unreadyChildren >>= \case
658 0 -> writeIORef haveEverBeenReady True
1560 0 -> writeIORef haveEverBeenReady True
659 _ -> modifyIORef' parentUnreadyChildren succ
1561 _ -> modifyIORef' parentUnreadyChildren succ
660− return result
1562+ return (dom, result)
661 a'' <- numberOccurrences a'
1563 a'' <- numberOccurrences a'
662− (result0, child') <- ImmediateDomBuilderT $ lift $ runWithReplace drawInitialChild $ ffor a'' $ \(cohortId, child) -> do
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
663− df <- createDocumentFragment doc
1568+ HydrationMode_Immediate -> toNode <$> createDocumentFragment doc
664 unreadyChildren <- liftIO $ newIORef 0
1569 unreadyChildren <- liftIO $ newIORef 0
665 let commitAction = do
1570 let commitAction = do
666 c <- liftIO $ readIORef currentCohort
1571 c <- liftIO $ readIORef currentCohort
667 when (c <= cohortId) $ do -- If a newer cohort has already been committed, just ignore this
1572 when (c <= cohortId) $ do -- If a newer cohort has already been committed, just ignore this
1573+ !before' <- liftIO $ readIORef before
1574+ !after' <- liftIO $ readIORef after
668− deleteBetweenExclusive before after
1575+ deleteBetweenExclusive before' after'
669− insertBefore df after
1576+ insertBefore p' after'
670 liftIO $ writeIORef currentCohort cohortId
1577 liftIO $ writeIORef currentCohort cohortId
671 myCommitAction
1578 myCommitAction
1579+ delayed <- case h of
1580+ HydrationMode_Hydrating -> liftIO $ newIORef $ pure ()
1581+ HydrationMode_Immediate -> pure $ _hydrationDomBuilderEnv_delayed initialEnv
672− result <- runReaderT (unImmediateDomBuilderT child) $ initialEnv
1582+ result <- runReaderT (unHydrationDomBuilderT child) $ initialEnv
673− { _immediateDomBuilderEnv_parent = toNode df
1583+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
674− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
1584+ , _hydrationDomBuilderEnv_commitAction = case h of
675− , _immediateDomBuilderEnv_commitAction = commitAction
1585+ HydrationMode_Hydrating -> myCommitAction
1586+ HydrationMode_Immediate -> commitAction
1587+ , _hydrationDomBuilderEnv_parent = Left p'
1588+ , _hydrationDomBuilderEnv_delayed = delayed
676− }
1589+ }
1590+ dom <- case h of
1591+ HydrationMode_Hydrating -> liftIO $ readIORef delayed
1592+ HydrationMode_Immediate -> pure $ pure ()
677 uc <- liftIO $ readIORef unreadyChildren
1593 uc <- liftIO $ readIORef unreadyChildren
678 let commitActionToRunNow = if uc == 0
1594 let commitActionToRunNow = if uc == 0
679− then Just commitAction
1595+ then Just $ commitAction
680 else Nothing -- A child will run it when unreadyChildren is decremented to 0
1596 else Nothing -- A child will run it when unreadyChildren is decremented to 0
1597+ actions = case h of
1598+ HydrationMode_Hydrating -> Left dom
681− return (commitActionToRunNow, result)
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
682− requestDomAction_ $ fmapMaybe fst child'
1606+ requestDomAction_ $ fmapMaybe id commitAction
683 return (result0, snd <$> child')
1607 return (result0, snd <$> child')
1608+
684 {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
1609 {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
685 traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjust'
1610 traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjust'
686 {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
1611 {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
687 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjust'
1612 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjust'
688 {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
1613 {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
689 traverseDMapWithKeyWithAdjustWithMove = do
1614 traverseDMapWithKeyWithAdjustWithMove = do
690− let updateChildUnreadiness (p :: PatchDMapWithMove k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) old = do
1615+ let updateChildUnreadiness (p :: PatchDMapWithMove k (Compose (TraverseChild t m (Some k)) v')) old = do
691− 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)
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)
692 new k = PatchDMapWithMove.nodeInfoMapFromM $ \case
1617 new k = PatchDMapWithMove.nodeInfoMapFromM $ \case
693− PatchDMapWithMove.From_Insert (Compose (_, _, sRef, _)) -> do
1618+ PatchDMapWithMove.From_Insert (Compose (TraverseChild (Left _hydration) _)) -> return PatchDMapWithMove.From_Delete
694− readIORef sRef >>= \case
1619+ PatchDMapWithMove.From_Insert (Compose (TraverseChild (Right immediate) _)) -> do
1620+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
695 ChildReadyState_Ready -> return PatchDMapWithMove.From_Delete
1621 ChildReadyState_Ready -> return PatchDMapWithMove.From_Delete
696 ChildReadyState_Unready _ -> do
1622 ChildReadyState_Unready _ -> do
697− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
1623+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
698− return $ PatchDMapWithMove.From_Insert $ Constant sRef
1624+ return $ PatchDMapWithMove.From_Insert $ Constant (_traverseChildImmediate_childReadyState immediate)
699 PatchDMapWithMove.From_Delete -> return PatchDMapWithMove.From_Delete
1625 PatchDMapWithMove.From_Delete -> return PatchDMapWithMove.From_Delete
700 PatchDMapWithMove.From_Move fromKey -> return $ PatchDMapWithMove.From_Move fromKey
1626 PatchDMapWithMove.From_Move fromKey -> return $ PatchDMapWithMove.From_Move fromKey
701− 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)
702 deleteOrMove _ (Pair (Constant sRef) (ComposeMaybe mToKey)) = do
1628 deleteOrMove _ (Pair (Constant sRef) (ComposeMaybe mToKey)) = do
703− 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
704 return $ Constant ()
1630 return $ Constant ()
705 p' <- fmap unsafePatchDMapWithMove $ DMap.traverseWithKey new $ unPatchDMapWithMove p
1631 p' <- fmap unsafePatchDMapWithMove $ DMap.traverseWithKey new $ unPatchDMapWithMove p
706 _ <- DMap.traverseWithKey deleteOrMove $ PatchDMapWithMove.getDeletionsAndMoves p old
1632 _ <- DMap.traverseWithKey deleteOrMove $ PatchDMapWithMove.getDeletionsAndMoves p old
707 return $ applyAlways p' old
1633 return $ applyAlways p' old
708− 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
709 let p = unPatchDMapWithMove p_
1635 let p = unPatchDMapWithMove p_
710 phsBefore <- liftIO $ readIORef placeholders
1636 phsBefore <- liftIO $ readIORef placeholders
711− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
712− 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)
713 collectIfMoved k e = do
1638 collectIfMoved k e = do
714− let mThisPlaceholder = Map.lookup (Some.This k) phsBefore -- Will be Nothing if this element wasn't present before
1639+ let mThisPlaceholder = Map.lookup (Some k) phsBefore -- Will be Nothing if this element wasn't present before
715− nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsBefore
1640+ nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phsBefore
716 case isJust $ getComposeMaybe $ PatchDMapWithMove._nodeInfo_to e of
1641 case isJust $ getComposeMaybe $ PatchDMapWithMove._nodeInfo_to e of
717 False -> do
1642 False -> do
718 mapM_ (`deleteUpTo` nextPlaceholder) mThisPlaceholder
1643 mapM_ (`deleteUpTo` nextPlaceholder) mThisPlaceholder
@@ -720,13 +1645,22 @@ instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimM
720 True -> do
1645 True -> do
721 Constant <$> mapM (`collectUpTo` nextPlaceholder) mThisPlaceholder
1646 Constant <$> mapM (`collectUpTo` nextPlaceholder) mThisPlaceholder
722 collected <- DMap.traverseWithKey collectIfMoved p
1647 collected <- DMap.traverseWithKey collectIfMoved p
723− let !phsAfter = fromMaybe phsBefore $ apply (weakenPatchDMapWithMoveWith (\(Compose (_, ph, _, _)) -> ph) p_) phsBefore --TODO: Don't recompute this
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
724− let placeFragment :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') a -> JSM (Constant () a)
1657+ let placeFragment :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseChild t m (Some k)) v') a -> JSM (Constant () a)
725 placeFragment k e = do
1658 placeFragment k e = do
726− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsAfter
1659+ let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phsAfter
727 case PatchDMapWithMove._nodeInfo_from e of
1660 case PatchDMapWithMove._nodeInfo_from e of
728− PatchDMapWithMove.From_Insert (Compose (df, _, _, _)) -> do
1661+ PatchDMapWithMove.From_Insert (Compose (TraverseChild x _)) -> case x of
1662+ Left _ -> pure ()
729− df `insertBefore` nextPlaceholder
1663+ Right immediate -> _traverseChildImmediate_fragment immediate `insertBefore` nextPlaceholder
730 PatchDMapWithMove.From_Delete -> do
1664 PatchDMapWithMove.From_Delete -> do
731 return ()
1665 return ()
732 PatchDMapWithMove.From_Move fromKey -> do
1666 PatchDMapWithMove.From_Move fromKey -> do
@@ -737,105 +1671,166 @@ instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimM
737 liftIO $ writeIORef placeholders $! phsAfter
1671 liftIO $ writeIORef placeholders $! phsAfter
738
1672
739{-# INLINABLE traverseDMapWithKeyWithAdjust' #-}
1673{-# INLINABLE traverseDMapWithKeyWithAdjust' #-}
1674+traverseDMapWithKeyWithAdjust'
740−traverseDMapWithKeyWithAdjust' :: forall t m (k :: * -> *) v v'. (Adjustable t m, MonadHold t m, MonadFix m, MonadIO m, MonadJSM m, PrimMonad m, DMap.GCompare k) => (forall a. k a -> v a -> ImmediateDomBuilderT t m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> ImmediateDomBuilderT t m (DMap k v', Event t (PatchDMap k v'))
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'))
741traverseDMapWithKeyWithAdjust' = do
1680traverseDMapWithKeyWithAdjust' = do
742− let updateChildUnreadiness (p :: PatchDMap k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) old = do
1681+ let updateChildUnreadiness (p :: PatchDMap k (Compose (TraverseChild t m (Some k)) v')) old = do
743− let new :: forall a. k a -> ComposeMaybe (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') a -> IO (ComposeMaybe (Constant (IORef (ChildReadyState k))) a)
1682+ let new :: forall a. k a -> ComposeMaybe (Compose (TraverseChild t m (Some k)) v') a -> IO (ComposeMaybe (Constant (IORef (ChildReadyState (Some k)))) a)
744 new k (ComposeMaybe m) = ComposeMaybe <$> case m of
1683 new k (ComposeMaybe m) = ComposeMaybe <$> case m of
745 Nothing -> return Nothing
1684 Nothing -> return Nothing
746− Just (Compose (_, _, sRef, _)) -> do
1685+ Just (Compose (TraverseChild (Left _hydration) _)) -> pure Nothing
747− readIORef sRef >>= \case
1686+ Just (Compose (TraverseChild (Right immediate) _)) -> do
1687+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
748 ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
1688 ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
749 ChildReadyState_Unready _ -> do
1689 ChildReadyState_Unready _ -> do
750− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
1690+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
751− return $ Just $ Constant sRef
1691+ return $ Just $ Constant (_traverseChildImmediate_childReadyState immediate)
752 delete _ (Constant sRef) = do
1692 delete _ (Constant sRef) = do
753 writeIORef sRef $ ChildReadyState_Unready Nothing
1693 writeIORef sRef $ ChildReadyState_Unready Nothing
754 return $ Constant ()
1694 return $ Constant ()
755 p' <- fmap PatchDMap $ DMap.traverseWithKey new $ unPatchDMap p
1695 p' <- fmap PatchDMap $ DMap.traverseWithKey new $ unPatchDMap p
756 _ <- DMap.traverseWithKey delete $ PatchDMap.getDeletions p old
1696 _ <- DMap.traverseWithKey delete $ PatchDMap.getDeletions p old
757 return $ applyAlways p' old
1697 return $ applyAlways p' old
758− hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap updateChildUnreadiness $ \placeholders lastPlaceholderRef (PatchDMap p) -> do
1698+ hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap updateChildUnreadiness $ \placeholders lastPlaceholder (PatchDMap patch) -> do
759 phs <- liftIO $ readIORef placeholders
1699 phs <- liftIO $ readIORef placeholders
760− forM_ (DMap.toList p) $ \(k :=> ComposeMaybe mv) -> do
1700+ forM_ (DMap.toList patch) $ \(k :=> ComposeMaybe mv) -> do
761− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
762− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phs
1701+ let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phs
1702+ -- Delete old node
1703+ forM_ (Map.lookup (Some k) phs) $ \thisPlaceholder -> do
763− forM_ (Map.lookup (Some.This k) phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
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
764− forM_ mv $ \(Compose (df, _, _, _)) -> df `insertBefore` nextPlaceholder
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
765− liftIO $ writeIORef placeholders $! fromMaybe phs $ apply (weakenPatchDMapWith (\(Compose (_, ph, _, _)) -> ph) $ PatchDMap p) phs
1717+ liftIO $ writeIORef placeholders $! fromMaybe phs $ apply filtered phs
766
1718
767{-# INLINABLE traverseIntMapWithKeyWithAdjust' #-}
1719{-# INLINABLE traverseIntMapWithKeyWithAdjust' #-}
768−traverseIntMapWithKeyWithAdjust' :: forall t m v v'. (Adjustable t m, MonadHold t m, MonadFix m, MonadIO m, MonadJSM m, PrimMonad m) => (IntMap.Key -> v -> ImmediateDomBuilderT t m v') -> IntMap v -> Event t (PatchIntMap v) -> ImmediateDomBuilderT t m (IntMap v', Event t (PatchIntMap v'))
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'))
769traverseIntMapWithKeyWithAdjust' = do
1726traverseIntMapWithKeyWithAdjust' = do
770− let updateChildUnreadiness (p@(PatchIntMap pInner) :: PatchIntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')) old = do
1727+ let updateChildUnreadiness (p@(PatchIntMap pInner) :: PatchIntMap (TraverseChild t m Int v')) old = do
771− let new :: IntMap.Key -> Maybe (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> IO (Maybe (IORef ChildReadyStateInt))
1728+ let new :: IntMap.Key -> Maybe (TraverseChild t m Int v') -> IO (Maybe (IORef (ChildReadyState Int)))
772 new k m = case m of
1729 new k m = case m of
773 Nothing -> return Nothing
1730 Nothing -> return Nothing
774− Just (_, _, sRef, _) -> do
1731+ Just (TraverseChild (Left _hydration) _) -> pure Nothing
1732+ Just (TraverseChild (Right immediate) _) -> do
1733+ let sRef = _traverseChildImmediate_childReadyState immediate
775 readIORef sRef >>= \case
1734 readIORef sRef >>= \case
776− ChildReadyStateInt_Ready -> return Nothing -- Delete this child, since it's ready
1735+ ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
777− ChildReadyStateInt_Unready _ -> do
1736+ ChildReadyState_Unready _ -> do
778− writeIORef sRef $ ChildReadyStateInt_Unready $ Just k
1737+ writeIORef sRef $ ChildReadyState_Unready $ Just k
779 return $ Just sRef
1738 return $ Just sRef
780 delete _ sRef = do
1739 delete _ sRef = do
781− writeIORef sRef $ ChildReadyStateInt_Unready Nothing
1740+ writeIORef sRef $ ChildReadyState_Unready Nothing
782 return ()
1741 return ()
783 p' <- PatchIntMap <$> IntMap.traverseWithKey new pInner
1742 p' <- PatchIntMap <$> IntMap.traverseWithKey new pInner
784 _ <- IntMap.traverseWithKey delete $ FastMutableIntMap.getDeletions p old
1743 _ <- IntMap.traverseWithKey delete $ FastMutableIntMap.getDeletions p old
785 return $ applyAlways p' old
1744 return $ applyAlways p' old
786− hoistTraverseIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust updateChildUnreadiness $ \placeholders lastPlaceholderRef (PatchIntMap p) -> do
1745+ hoistTraverseIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust updateChildUnreadiness $ \placeholders lastPlaceholder (PatchIntMap p) -> do
787 phs <- liftIO $ readIORef placeholders
1746 phs <- liftIO $ readIORef placeholders
788 forM_ (IntMap.toList p) $ \(k, mv) -> do
1747 forM_ (IntMap.toList p) $ \(k, mv) -> do
789− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
790 let nextPlaceholder = maybe lastPlaceholder snd $ IntMap.lookupGT k phs
1748 let nextPlaceholder = maybe lastPlaceholder snd $ IntMap.lookupGT k phs
1749+ -- Delete old node
791 forM_ (IntMap.lookup k phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
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
792− forM_ mv $ \(df, _, _, _) -> df `insertBefore` nextPlaceholder
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
793− liftIO $ writeIORef placeholders $! fromMaybe phs $ apply ((\(_, ph, _, _) -> ph) <$> PatchIntMap p) phs
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+ #-}
794
1770
795−#if MIN_VERSION_base(4,9,0)
1771+{-# SPECIALIZE traverseIntMapWithKeyWithAdjust'
796−data ChildReadyState k
1772+ :: (IntMap.Key -> v -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM v')
797−#else
1773+ -> IntMap v
798−data ChildReadyState (k :: * -> *)
1774+ -> Event DomTimeline (PatchIntMap v)
799−#endif
1775+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (IntMap v', Event DomTimeline (PatchIntMap v'))
1776+ #-}
1777+
1778+data ChildReadyState a
800 = ChildReadyState_Ready
1779 = ChildReadyState_Ready
801− | ChildReadyState_Unready !(Maybe (Some k))
1780+ | ChildReadyState_Unready !(Maybe a)
802 deriving (Show, Read, Eq, Ord)
1781 deriving (Show, Read, Eq, Ord)
803
1782
804−data ChildReadyStateInt
1783+insertAfterPreviousNode :: (Monad m, MonadJSM m) => DOM.IsNode node => node -> HydrationRunnerT t m ()
805− = ChildReadyStateInt_Ready
1784+insertAfterPreviousNode node = do
806− | ChildReadyStateInt_Unready !(Maybe Int)
1785+ parent <- askParent
807− deriving (Show, Read, Eq, Ord)
1786+ nextNode <- maybe (Node.getFirstChild parent) Node.getNextSibling =<< getPreviousNode
1787+ Node.insertBefore_ parent node nextNode
1788+ setPreviousNode $ Just $ toNode node
808
1789
809−{-# INLINE hoistTraverseIntMapWithKeyWithAdjust #-}
1790+{-# INLINABLE hoistTraverseWithKeyWithAdjust #-}
810−hoistTraverseIntMapWithKeyWithAdjust :: forall v v' t m p.
1791+hoistTraverseWithKeyWithAdjust
1792+ ::
811 ( Adjustable t m
1793 ( Adjustable t m
1794+ , MonadHold t m
1795+ , GCompare k
812 , MonadIO m
1796 , MonadIO m
813 , MonadJSM m
1797 , MonadJSM m
814− , MonadFix m
815 , PrimMonad m
1798 , PrimMonad m
816− , Monoid (p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
1799+ , MonadFix m
817− , Functor p
1800+ , Patch (p k v)
1801+ , 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
818 )
1807 )
819− => ( (IntMap.Key -> v -> RequesterT t JSM Identity (TriggerEventT t m) (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
1808+ => (forall vv vv'.
820− -> IntMap v
1809+ (forall a. k a -> vv a -> DomRenderHookT t m (vv' a))
1810+ -> DMap k vv
821− -> Event t (p v)
1811+ -> Event t (p k vv)
822− -> RequesterT t JSM Identity (TriggerEventT t m) (IntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'), Event t (p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')))
1812+ -> DomRenderHookT t m (DMap k vv', Event t (p k vv')))
823− ) -- ^ The base monad's traversal
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))))))
824− -> (p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> IntMap (IORef ChildReadyStateInt) -> IO (IntMap (IORef ChildReadyStateInt))) -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
1817+ -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
825− -> (IORef (IntMap DOM.Text) -> IORef DOM.Text -> p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> JSM ()) -- ^ Apply a patch to the DOM
1818+ -> (IORef (Map.Map (Some k) DOM.Text) -> DOM.Text -> p k (Compose (TraverseChild t m (Some k)) v') -> JSM ())
826− -> (IntMap.Key -> v -> ImmediateDomBuilderT t m v')
1819+ -- ^ Apply a patch to the DOM
827− -> IntMap v
1820+ -> (forall a. k a -> v a -> HydrationDomBuilderT s t m (v' a))
1821+ -> DMap k v
828− -> Event t (p v)
1822+ -> Event t (p k v)
829− -> ImmediateDomBuilderT t m (IntMap v', Event t (p v'))
1823+ -> HydrationDomBuilderT s t m (DMap k v', Event t (p k v'))
830−hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
1824+hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
831− initialEnv <- ImmediateDomBuilderT ask
1825+ doc <- askDocument
1826+ initialEnv <- HydrationDomBuilderT ask
832− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
1827+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
833− pendingChange :: IORef (IntMap (IORef ChildReadyStateInt), p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')) <- liftIO $ newIORef mempty
1828+ pendingChange :: IORef (DMap k (Constant (IORef (ChildReadyState (Some k)))), p k (Compose (TraverseChild t m (Some k)) v')) <- liftIO $ newIORef mempty
834 haveEverBeenReady <- liftIO $ newIORef False
1829 haveEverBeenReady <- liftIO $ newIORef False
835− placeholders <- liftIO $ newIORef $ error "placeholders not yet initialized"
1830+ placeholders <- liftIO $ newIORef Map.empty
836− lastPlaceholderRef <- liftIO $ newIORef $ error "lastPlaceholderRef not yet initialized"
1831+ lastPlaceholder <- createTextNode doc ("" :: Text)
837 let applyDomUpdate p = do
1832 let applyDomUpdate p = do
838− applyDomUpdate_ placeholders lastPlaceholderRef p
1833+ applyDomUpdate_ placeholders lastPlaceholder p
839 markSelfReady
1834 markSelfReady
840 liftIO $ writeIORef pendingChange $! mempty
1835 liftIO $ writeIORef pendingChange $! mempty
841 markSelfReady = do
1836 markSelfReady = do
@@ -846,86 +1841,105 @@ hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_
846 old <- liftIO $ readIORef parentUnreadyChildren
1841 old <- liftIO $ readIORef parentUnreadyChildren
847 let new = pred old
1842 let new = pred old
848 liftIO $ writeIORef parentUnreadyChildren $! new
1843 liftIO $ writeIORef parentUnreadyChildren $! new
849− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
1844+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
850− markChildReady :: IORef ChildReadyStateInt -> JSM ()
1845+ markChildReady :: IORef (ChildReadyState (Some k)) -> JSM ()
851 markChildReady childReadyState = do
1846 markChildReady childReadyState = do
852 liftIO (readIORef childReadyState) >>= \case
1847 liftIO (readIORef childReadyState) >>= \case
853− ChildReadyStateInt_Ready -> return ()
1848+ ChildReadyState_Ready -> return ()
854− ChildReadyStateInt_Unready countedAt -> do
1849+ ChildReadyState_Unready countedAt -> do
855− liftIO $ writeIORef childReadyState ChildReadyStateInt_Ready
1850+ liftIO $ writeIORef childReadyState ChildReadyState_Ready
856 case countedAt of
1851 case countedAt of
857 Nothing -> return ()
1852 Nothing -> return ()
858− Just 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
859 (oldUnready, p) <- liftIO $ readIORef pendingChange
1854 (oldUnready, p) <- liftIO $ readIORef pendingChange
860− when (not $ IntMap.null oldUnready) $ do -- This shouldn't actually ever be null
1855+ when (not $ DMap.null oldUnready) $ do -- This shouldn't actually ever be null
861− let newUnready = IntMap.delete k oldUnready
1856+ let newUnready = DMap.delete k oldUnready
862 liftIO $ writeIORef pendingChange (newUnready, p)
1857 liftIO $ writeIORef pendingChange (newUnready, p)
863− when (IntMap.null newUnready) $ do
1858+ when (DMap.null newUnready) $ do
864 applyDomUpdate p
1859 applyDomUpdate p
1860+ (children0 :: DMap k (Compose (TraverseChild t m (Some k)) v'), children' :: Event t (p k (Compose (TraverseChild t m (Some k)) v')))
865− (children0, children') <- ImmediateDomBuilderT $ lift $ base (\k v -> drawChildUpdateInt initialEnv markChildReady $ f k v) dm0 dm'
1861+ <- HydrationDomBuilderT $ lift $ base (\k v -> drawChildUpdate initialEnv markChildReady $ f k v) dm0 dm'
866− let processChild k (_, _, sRef, _) = do
1862+ let processChild k (Compose (TraverseChild e _)) = case e of
867− readIORef sRef >>= \case
1863+ Left _ -> pure $ ComposeMaybe Nothing
868− ChildReadyStateInt_Ready -> return Nothing
1864+ Right immediate -> ComposeMaybe <$> do
869− ChildReadyStateInt_Unready _ -> do
1865+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
870− writeIORef sRef $ ChildReadyStateInt_Unready $ Just k
1866+ ChildReadyState_Ready -> return Nothing
871− return $ Just sRef
1867+ ChildReadyState_Unready _ -> do
1868+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
1869+ return $ Just $ Constant (_traverseChildImmediate_childReadyState immediate)
872− initialUnready <- liftIO $ IntMap.mapMaybe id <$> IntMap.traverseWithKey processChild children0
1870+ initialUnready <- liftIO $ DMap.mapMaybeWithKey (\_ -> getComposeMaybe) <$> DMap.traverseWithKey processChild children0
873− liftIO $ if IntMap.null initialUnready
1871+ liftIO $ if DMap.null initialUnready
874 then writeIORef haveEverBeenReady True
1872 then writeIORef haveEverBeenReady True
875 else do
1873 else do
876 modifyIORef' parentUnreadyChildren succ
1874 modifyIORef' parentUnreadyChildren succ
877 writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
1875 writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
878− let result0 = IntMap.map (\(_, _, _, v) -> v) children0
1876+ getHydrationMode >>= \case
879− placeholders0 = fmap (\(_, ph, _, _) -> ph) children0
1877+ HydrationMode_Hydrating -> addHydrationStepWithSetup (holdIncremental children0 children') $ \children -> do
880− result' = ffor children' $ fmap $ \(_, _, _, r) -> r
1878+ dm :: DMap k (Compose (TraverseChild t m (Some k)) v') <- sample $ currentIncremental children
881− liftIO $ writeIORef placeholders $! placeholders0
1879+ phs <- sequenceA $ weakenDMapWith (either _traverseChildHydration_delayed (pure . _traverseChildImmediate_placeholder) . _traverseChild_mode . getCompose) dm
882− _ <- IntMap.traverseWithKey (\_ (df, _, _, _) -> void $ append $ toNode df) children0
1880+ liftIO $ writeIORef placeholders $! phs
883− liftIO . writeIORef lastPlaceholderRef =<< textNodeInternal ("" :: Text)
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
884 requestDomAction_ $ ffor children' $ \p -> do
1889 requestDomAction_ $ ffor children' $ \p -> do
885 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
1890 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
886 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
1891 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
887 let !newP = p <> oldP
1892 let !newP = p <> oldP
888 liftIO $ writeIORef pendingChange (newUnready, newP)
1893 liftIO $ writeIORef pendingChange (newUnready, newP)
889− when (IntMap.null newUnready) $ do
1894+ when (DMap.null newUnready) $ do
890 applyDomUpdate newP
1895 applyDomUpdate newP
1896+ let result0 = DMap.map (_traverseChild_result . getCompose) children0
1897+ result' = ffor children' $ mapPatch $ _traverseChild_result . getCompose
891 return (result0, result')
1898 return (result0, result')
892
1899
893−{-# INLINABLE hoistTraverseWithKeyWithAdjust #-}
1900+{-# INLINE hoistTraverseIntMapWithKeyWithAdjust #-}
894−hoistTraverseWithKeyWithAdjust :: forall (k :: * -> *) v v' t m p.
1901+hoistTraverseIntMapWithKeyWithAdjust ::
895 ( Adjustable t m
1902 ( Adjustable t m
896 , MonadHold t m
1903 , MonadHold t m
897− , DMap.GCompare k
898− , MonadIO m
899 , MonadJSM m
1904 , MonadJSM m
900− , PrimMonad m
901 , MonadFix m
1905 , MonadFix m
902− , Patch (p k v)
1906+ , PrimMonad m
903− , PatchTarget (p k (Constant Int)) ~ DMap k (Constant Int)
1907+ , Monoid (p (TraverseChild t m Int v'))
904− , Monoid (p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v'))
1908+ , Functor p
905− , Patch (p k (Constant Int))
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
906 )
1914 )
907− => (forall vv vv'.
1915+ => ((IntMap.Key -> v -> DomRenderHookT t m (TraverseChild t m Int v'))
908− (forall a. k a -> vv a -> RequesterT t JSM Identity (TriggerEventT t m) (vv' a))
1916+ -> IntMap v
909− -> DMap k vv
910− -> Event t (p k vv)
1917+ -> Event t (p v)
911− -> RequesterT t JSM Identity (TriggerEventT t m) (DMap k vv', Event t (p k vv'))
1918+ -> DomRenderHookT t m (IntMap (TraverseChild t m Int v'), Event t (p (TraverseChild t m Int v'))))
912− ) -- ^ The base monad's traversal
1919+ -- ^ The base monad's traversal
913− -> (forall vv vv'. (forall a. vv a -> vv' a) -> p k vv -> p k vv') -- ^ A way of mapping over the patch type
1920+ -> (p (TraverseChild t m Int v')
1921+ -> IntMap (IORef (ChildReadyState Int))
1922+ -> IO (IntMap (IORef (ChildReadyState Int))))
914− -> (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
1923+ -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
915− -> (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
1924+ -> (IORef (IntMap DOM.Text)
916− -> (forall a. k a -> v a -> ImmediateDomBuilderT t m (v' a))
1925+ -> DOM.Text
917− -> DMap k v
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
918− -> Event t (p k v)
1931+ -> Event t (p v)
919− -> ImmediateDomBuilderT t m (DMap k v', Event t (p k v'))
1932+ -> HydrationDomBuilderT s t m (IntMap v', Event t (p v'))
920−hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpdate_ (f :: forall a. k a -> v a -> ImmediateDomBuilderT t m (v' a)) (dm0 :: DMap k v) dm' = do
1933+hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
921− initialEnv <- ImmediateDomBuilderT ask
1934+ doc <- askDocument
1935+ initialEnv <- HydrationDomBuilderT ask
922− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
1936+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
923− pendingChange :: IORef (DMap k (Constant (IORef (ChildReadyState k))), p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) <- liftIO $ newIORef mempty
1937+ pendingChange :: IORef (IntMap (IORef (ChildReadyState Int)), p (TraverseChild t m Int v')) <- liftIO $ newIORef mempty
924 haveEverBeenReady <- liftIO $ newIORef False
1938 haveEverBeenReady <- liftIO $ newIORef False
925− placeholders <- liftIO $ newIORef $ error "placeholders not yet initialized"
1939+ placeholders <- liftIO $ newIORef IntMap.empty
926− lastPlaceholderRef <- liftIO $ newIORef $ error "lastPlaceholderRef not yet initialized"
1940+ lastPlaceholder <- createTextNode doc ("" :: Text)
927 let applyDomUpdate p = do
1941 let applyDomUpdate p = do
928− applyDomUpdate_ placeholders lastPlaceholderRef p
1942+ applyDomUpdate_ placeholders lastPlaceholder p
929 markSelfReady
1943 markSelfReady
930 liftIO $ writeIORef pendingChange $! mempty
1944 liftIO $ writeIORef pendingChange $! mempty
931 markSelfReady = do
1945 markSelfReady = do
@@ -936,8 +1950,8 @@ hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpda
936 old <- liftIO $ readIORef parentUnreadyChildren
1950 old <- liftIO $ readIORef parentUnreadyChildren
937 let new = pred old
1951 let new = pred old
938 liftIO $ writeIORef parentUnreadyChildren $! new
1952 liftIO $ writeIORef parentUnreadyChildren $! new
939− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
1953+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
940− markChildReady :: IORef (ChildReadyState k) -> JSM ()
1954+ markChildReady :: IORef (ChildReadyState Int) -> JSM ()
941 markChildReady childReadyState = do
1955 markChildReady childReadyState = do
942 liftIO (readIORef childReadyState) >>= \case
1956 liftIO (readIORef childReadyState) >>= \case
943 ChildReadyState_Ready -> return ()
1957 ChildReadyState_Ready -> return ()
@@ -945,82 +1959,191 @@ hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpda
945 liftIO $ writeIORef childReadyState ChildReadyState_Ready
1959 liftIO $ writeIORef childReadyState ChildReadyState_Ready
946 case countedAt of
1960 case countedAt of
947 Nothing -> return ()
1961 Nothing -> return ()
948− Just (Some.This k) -> do -- This child has been counted as unready, so we need to remove it from the unready set
1962+ Just k -> do -- This child has been counted as unready, so we need to remove it from the unready set
949 (oldUnready, p) <- liftIO $ readIORef pendingChange
1963 (oldUnready, p) <- liftIO $ readIORef pendingChange
950− when (not $ DMap.null oldUnready) $ do -- This shouldn't actually ever be null
1964+ when (not $ IntMap.null oldUnready) $ do -- This shouldn't actually ever be null
951− let newUnready = DMap.delete k oldUnready
1965+ let newUnready = IntMap.delete k oldUnready
952 liftIO $ writeIORef pendingChange (newUnready, p)
1966 liftIO $ writeIORef pendingChange (newUnready, p)
953− when (DMap.null newUnready) $ do
1967+ when (IntMap.null newUnready) $ do
954 applyDomUpdate p
1968 applyDomUpdate p
1969+ (children0 :: IntMap (TraverseChild t m Int v'), children' :: Event t (p (TraverseChild t m Int v')))
955− (children0, children') <- ImmediateDomBuilderT $ lift $ base (\k v -> drawChildUpdate initialEnv markChildReady $ f k v) dm0 dm'
1970+ <- HydrationDomBuilderT $ lift $ base (\k v -> drawChildUpdateInt initialEnv markChildReady $ f k v) dm0 dm'
956− let processChild k (Compose (_, _, sRef, _)) = ComposeMaybe <$> do
1971+ let processChild k (TraverseChild e _) = case e of
957− readIORef sRef >>= \case
1972+ Left _ -> pure Nothing
1973+ Right immediate -> do
1974+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
958− ChildReadyState_Ready -> return Nothing
1975+ ChildReadyState_Ready -> return Nothing
959− ChildReadyState_Unready _ -> do
1976+ ChildReadyState_Unready _ -> do
960− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
1977+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just k
961− return $ Just $ Constant sRef
1978+ return $ Just (_traverseChildImmediate_childReadyState immediate)
962− initialUnready <- liftIO $ DMap.mapMaybeWithKey (\_ -> getComposeMaybe) <$> DMap.traverseWithKey processChild children0
1979+ initialUnready <- liftIO $ IntMap.mapMaybe id <$> IntMap.traverseWithKey processChild children0
963− liftIO $ if DMap.null initialUnready
1980+ liftIO $ if IntMap.null initialUnready
964 then writeIORef haveEverBeenReady True
1981 then writeIORef haveEverBeenReady True
965 else do
1982 else do
966 modifyIORef' parentUnreadyChildren succ
1983 modifyIORef' parentUnreadyChildren succ
967 writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
1984 writeIORef pendingChange (initialUnready, mempty) -- The patch is always empty because it got applied implicitly when we ran the children the first time
968− let result0 = DMap.map (\(Compose (_, _, _, v)) -> v) children0
1985+ getHydrationMode >>= \case
969− placeholders0 = weakenDMapWith (\(Compose (_, ph, _, _)) -> ph) children0
1986+ HydrationMode_Hydrating -> addHydrationStepWithSetup (holdIncremental children0 children') $ \children -> do
970− result' = ffor children' $ mapPatch $ \(Compose (_, _, _, r)) -> r
1987+ dm :: IntMap (TraverseChild t m Int v') <- sample $ currentIncremental children
971− liftIO $ writeIORef placeholders $! placeholders0
1988+ phs <- traverse (either _traverseChildHydration_delayed (pure . _traverseChildImmediate_placeholder) . _traverseChild_mode) dm
972− _ <- DMap.traverseWithKey (\_ (Compose (df, _, _, _)) -> Constant () <$ append (toNode df)) children0
1989+ liftIO $ writeIORef placeholders $! phs
973− liftIO . writeIORef lastPlaceholderRef =<< textNodeInternal ("" :: Text)
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
974 requestDomAction_ $ ffor children' $ \p -> do
1998 requestDomAction_ $ ffor children' $ \p -> do
975 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
1999 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
976 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
2000 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
977 let !newP = p <> oldP
2001 let !newP = p <> oldP
978 liftIO $ writeIORef pendingChange (newUnready, newP)
2002 liftIO $ writeIORef pendingChange (newUnready, newP)
979− when (DMap.null newUnready) $ do
2003+ when (IntMap.null newUnready) $ do
980 applyDomUpdate newP
2004 applyDomUpdate newP
2005+ let result0 = IntMap.map _traverseChild_result children0
2006+ result' = ffor children' $ fmap $ _traverseChild_result
981 return (result0, result')
2007 return (result0, result')
982
2008
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+
983{-# INLINABLE drawChildUpdate #-}
2063{-# INLINABLE drawChildUpdate #-}
984−drawChildUpdate :: (MonadIO m, MonadJSM m)
2064+drawChildUpdate :: (MonadJSM m, Reflex t)
985− => ImmediateDomBuilderEnv t
2065+ => HydrationDomBuilderEnv t m
986 -> (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
2066 -> (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
987− -> ImmediateDomBuilderT t m (v' a)
2067+ -> HydrationDomBuilderT s t m (f a)
988− -> RequesterT t JSM Identity (TriggerEventT t m) (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v' a)
2068+ -> DomRenderHookT t m (Compose (TraverseChild t m k) f a)
989drawChildUpdate initialEnv markReady child = do
2069drawChildUpdate initialEnv markReady child = do
990− childReadyState <- liftIO $ newIORef $ ChildReadyState_Unready Nothing
2070+ let doc = _hydrationDomBuilderEnv_document initialEnv
991 unreadyChildren <- liftIO $ newIORef 0
2071 unreadyChildren <- liftIO $ newIORef 0
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
992− df <- createDocumentFragment $ _immediateDomBuilderEnv_document initialEnv
2092+ df <- createDocumentFragment doc
993− (placeholder, result) <- runReaderT (unImmediateDomBuilderT $ (,) <$> textNodeInternal ("" :: Text) <*> child) $ initialEnv
2093+ placeholder <- createTextNode doc ("" :: Text)
994− { _immediateDomBuilderEnv_parent = toNode df
2094+ Node.appendChild_ df placeholder
995− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
2095+ result <- runReaderT (unHydrationDomBuilderT child) initialEnv
2096+ { _hydrationDomBuilderEnv_parent = Left $ toNode df
2097+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
996− , _immediateDomBuilderEnv_commitAction = markReady childReadyState
2098+ , _hydrationDomBuilderEnv_commitAction = markReady childReadyState
997− }
2099+ }
998− u <- liftIO $ readIORef unreadyChildren
2100+ u <- liftIO $ readIORef unreadyChildren
999− when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyState_Ready
2101+ when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyState_Ready
1000− return $ Compose (df, placeholder, childReadyState, result)
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+ }
1001
2110
1002−{-# INLINABLE drawChildUpdateInt #-}
2111+{-# SPECIALIZE drawChildUpdate
1003−drawChildUpdateInt :: (MonadIO m, MonadJSM m)
2112+ :: HydrationDomBuilderEnv DomTimeline HydrationM
1004− => ImmediateDomBuilderEnv t
2113+ -> (IORef (ChildReadyState Int) -> JSM ())
1005− -> (IORef ChildReadyStateInt -> JSM ()) -- This will NOT be called if the child is ready at initialization time; instead, the ChildReadyState return value will be ChildReadyState_Ready
2114+ -> HydrationDomBuilderT s DomTimeline HydrationM (Identity a)
1006− -> ImmediateDomBuilderT t m v'
2115+ -> DomRenderHookT DomTimeline HydrationM (Compose (TraverseChild DomTimeline HydrationM Int) Identity a)
1007− -> RequesterT t JSM Identity (TriggerEventT t m) (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')
2116+ #-}
1008−drawChildUpdateInt initialEnv markReady child = do
2117+
1009− childReadyState <- liftIO $ newIORef $ ChildReadyStateInt_Unready Nothing
2118+{-# SPECIALIZE drawChildUpdate
1010− unreadyChildren <- liftIO $ newIORef 0
2119+ :: HydrationDomBuilderEnv DomTimeline HydrationM
1011− df <- createDocumentFragment $ _immediateDomBuilderEnv_document initialEnv
2120+ -> (IORef (ChildReadyState (Some k)) -> JSM ())
1012− (placeholder, result) <- runReaderT (unImmediateDomBuilderT $ (,) <$> textNodeInternal ("" :: Text) <*> child) $ initialEnv
2121+ -> HydrationDomBuilderT s DomTimeline HydrationM (f a)
1013− { _immediateDomBuilderEnv_parent = toNode df
2122+ -> DomRenderHookT DomTimeline HydrationM (Compose (TraverseChild DomTimeline HydrationM (Some k)) f a)
1014− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
2123+ #-}
1015− , _immediateDomBuilderEnv_commitAction = markReady childReadyState
1016− }
1017− u <- liftIO $ readIORef unreadyChildren
1018− when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyStateInt_Ready
1019− return (df, placeholder, childReadyState, result)
1020
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)))
1021−mkHasFocus :: (MonadHold t m, Reflex t) => Element er d t -> m (Dynamic t Bool)
2143+ => Element er d t -> m (Dynamic t Bool)
1022mkHasFocus e = do
2144mkHasFocus e = do
1023− 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
1024 holdDyn initialFocus $ leftmost
2147 holdDyn initialFocus $ leftmost
1025 [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
2148 [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
1026 , True <$ Reflex.select (_element_events e) (WrapArg Focus)
2149 , True <$ Reflex.select (_element_events e) (WrapArg Focus)
@@ -1029,39 +2152,49 @@ mkHasFocus e = do
1029insertBefore :: (MonadJSM m, IsNode new, IsNode existing) => new -> existing -> m ()
2152insertBefore :: (MonadJSM m, IsNode new, IsNode existing) => new -> existing -> m ()
1030insertBefore new existing = do
2153insertBefore new existing = do
1031 p <- getParentNodeUnchecked existing
2154 p <- getParentNodeUnchecked existing
1032− 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
1033
2156
2157+type ImmediateDomBuilderT = HydrationDomBuilderT GhcjsDomSpace
2158+
1034−instance PerformEvent t m => PerformEvent t (ImmediateDomBuilderT t m) where
2159+instance PerformEvent t m => PerformEvent t (HydrationDomBuilderT s t m) where
1035− type Performable (ImmediateDomBuilderT t m) = Performable m
2160+ type Performable (HydrationDomBuilderT s t m) = Performable m
1036 {-# INLINABLE performEvent_ #-}
2161 {-# INLINABLE performEvent_ #-}
1037 performEvent_ e = lift $ performEvent_ e
2162 performEvent_ e = lift $ performEvent_ e
1038 {-# INLINABLE performEvent #-}
2163 {-# INLINABLE performEvent #-}
1039 performEvent e = lift $ performEvent e
2164 performEvent e = lift $ performEvent e
1040
2165
1041−instance PostBuild t m => PostBuild t (ImmediateDomBuilderT t m) where
2166+instance PostBuild t m => PostBuild t (HydrationDomBuilderT s t m) where
1042 {-# INLINABLE getPostBuild #-}
2167 {-# INLINABLE getPostBuild #-}
1043 getPostBuild = lift getPostBuild
2168 getPostBuild = lift getPostBuild
1044
2169
1045−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ImmediateDomBuilderT t m) where
2170+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydrationDomBuilderT s t m) where
1046 {-# INLINABLE newEventWithTrigger #-}
2171 {-# INLINABLE newEventWithTrigger #-}
1047 newEventWithTrigger = lift . newEventWithTrigger
2172 newEventWithTrigger = lift . newEventWithTrigger
1048 {-# INLINABLE newFanEventWithTrigger #-}
2173 {-# INLINABLE newFanEventWithTrigger #-}
1049 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
2174 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
1050
2175
1051−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
2177+ {-# INLINABLE newTriggerEvent #-}
2178+ newTriggerEvent = HydrationDomBuilderT . lift $ newTriggerEvent
2179+ {-# INLINABLE newTriggerEventWithOnComplete #-}
2180+ newTriggerEventWithOnComplete = HydrationDomBuilderT . lift $ newTriggerEventWithOnComplete
2181+ {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
2182+ newEventWithLazyTriggerWithOnComplete f = HydrationDomBuilderT . lift $ newEventWithLazyTriggerWithOnComplete f
2183+
2184+instance (Monad m, MonadRef m, Ref m ~ Ref IO, MonadReflexCreateTrigger t m) => TriggerEvent t (DomRenderHookT t m) where
1052 {-# INLINABLE newTriggerEvent #-}
2185 {-# INLINABLE newTriggerEvent #-}
1053− newTriggerEvent = ImmediateDomBuilderT . lift . lift $ newTriggerEvent
2186+ newTriggerEvent = DomRenderHookT . lift $ newTriggerEvent
1054 {-# INLINABLE newTriggerEventWithOnComplete #-}
2187 {-# INLINABLE newTriggerEventWithOnComplete #-}
1055− newTriggerEventWithOnComplete = ImmediateDomBuilderT . lift . lift $ newTriggerEventWithOnComplete
2188+ newTriggerEventWithOnComplete = DomRenderHookT . lift $ newTriggerEventWithOnComplete
1056 {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
2189 {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
1057− newEventWithLazyTriggerWithOnComplete f = ImmediateDomBuilderT . lift . lift $ newEventWithLazyTriggerWithOnComplete f
2190+ newEventWithLazyTriggerWithOnComplete f = DomRenderHookT . lift $ newEventWithLazyTriggerWithOnComplete f
1058
2191
1059−instance HasJSContext m => HasJSContext (ImmediateDomBuilderT t m) where
2192+instance HasJSContext m => HasJSContext (HydrationDomBuilderT s t m) where
1060− type JSContextPhantom (ImmediateDomBuilderT t m) = JSContextPhantom m
2193+ type JSContextPhantom (HydrationDomBuilderT s t m) = JSContextPhantom m
1061 askJSContext = lift askJSContext
2194 askJSContext = lift askJSContext
1062
2195
1063−instance MonadRef m => MonadRef (ImmediateDomBuilderT t m) where
2196+instance MonadRef m => MonadRef (HydrationDomBuilderT s t m) where
1064− type Ref (ImmediateDomBuilderT t m) = Ref m
2197+ type Ref (HydrationDomBuilderT s t m) = Ref m
1065 {-# INLINABLE newRef #-}
2198 {-# INLINABLE newRef #-}
1066 newRef = lift . newRef
2199 newRef = lift . newRef
1067 {-# INLINABLE readRef #-}
2200 {-# INLINABLE readRef #-}
@@ -1069,12 +2202,12 @@ instance MonadRef m => MonadRef (ImmediateDomBuilderT t m) where
1069 {-# INLINABLE writeRef #-}
2202 {-# INLINABLE writeRef #-}
1070 writeRef r = lift . writeRef r
2203 writeRef r = lift . writeRef r
1071
2204
1072−instance MonadAtomicRef m => MonadAtomicRef (ImmediateDomBuilderT t m) where
2205+instance MonadAtomicRef m => MonadAtomicRef (HydrationDomBuilderT s t m) where
1073 {-# INLINABLE atomicModifyRef #-}
2206 {-# INLINABLE atomicModifyRef #-}
1074 atomicModifyRef r = lift . atomicModifyRef r
2207 atomicModifyRef r = lift . atomicModifyRef r
1075
2208
1076−instance (HasJS x m, ReflexHost t) => HasJS x (ImmediateDomBuilderT t m) where
2209+instance (HasJS x m, ReflexHost t) => HasJS x (HydrationDomBuilderT s t m) where
1077− type JSX (ImmediateDomBuilderT t m) = JSX m
2210+ type JSX (HydrationDomBuilderT s t m) = JSX m
1078 liftJS = lift . liftJS
2211 liftJS = lift . liftJS
1079
2212
1080type family EventType en where
2213type family EventType en where
@@ -1164,7 +2297,7 @@ defaultDomEventHandler e evt = fmap (Just . EventResult) $ case evt of
1164 Beforecopy -> return ()
2297 Beforecopy -> return ()
1165 Copy -> return ()
2298 Copy -> return ()
1166 Beforepaste -> return ()
2299 Beforepaste -> return ()
1167− Paste -> return ()
2300+ Paste -> getPasteData
1168 Reset -> return ()
2301 Reset -> return ()
1169 Search -> return ()
2302 Search -> return ()
1170 Selectstart -> return ()
2303 Selectstart -> return ()
@@ -1173,7 +2306,7 @@ defaultDomEventHandler e evt = fmap (Just . EventResult) $ case evt of
1173 Touchend -> getTouchEvent
2306 Touchend -> getTouchEvent
1174 Touchcancel -> getTouchEvent
2307 Touchcancel -> getTouchEvent
1175 Mousewheel -> return ()
2308 Mousewheel -> return ()
1176− Wheel -> return ()
2309+ Wheel -> getWheelEvent
1177
2310
1178{-# INLINABLE defaultDomWindowEventHandler #-}
2311{-# INLINABLE defaultDomWindowEventHandler #-}
1179defaultDomWindowEventHandler :: DOM.Window -> EventName en -> EventM DOM.Window (EventType en) (Maybe (EventResult en))
2312defaultDomWindowEventHandler :: DOM.Window -> EventName en -> EventM DOM.Window (EventType en) (Maybe (EventResult en))
@@ -1214,7 +2347,7 @@ defaultDomWindowEventHandler w evt = fmap (Just . EventResult) $ case evt of
1214 Beforecopy -> return ()
2347 Beforecopy -> return ()
1215 Copy -> return ()
2348 Copy -> return ()
1216 Beforepaste -> return ()
2349 Beforepaste -> return ()
1217− Paste -> return ()
2350+ Paste -> getPasteData
1218 Reset -> return ()
2351 Reset -> return ()
1219 Search -> return ()
2352 Search -> return ()
1220 Selectstart -> return ()
2353 Selectstart -> return ()
@@ -1223,7 +2356,7 @@ defaultDomWindowEventHandler w evt = fmap (Just . EventResult) $ case evt of
1223 Touchend -> getTouchEvent
2356 Touchend -> getTouchEvent
1224 Touchcancel -> getTouchEvent
2357 Touchcancel -> getTouchEvent
1225 Mousewheel -> return ()
2358 Mousewheel -> return ()
1226− Wheel -> return ()
2359+ Wheel -> getWheelEvent
1227
2360
1228{-# INLINABLE withIsEvent #-}
2361{-# INLINABLE withIsEvent #-}
1229withIsEvent :: EventName en -> (IsEvent (EventType en) => r) -> r
2362withIsEvent :: EventName en -> (IsEvent (EventType en) => r) -> r
@@ -1491,6 +2624,15 @@ getMouseEventCoords = do
1491 e <- event
2624 e <- event
1492 bisequence (getClientX e, getClientY e)
2625 bisequence (getClientX e, getClientY e)
1493
2626
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+
1494{-# INLINABLE getTouchEvent #-}
2636{-# INLINABLE getTouchEvent #-}
1495getTouchEvent :: EventM e TouchEvent TouchEventResult
2637getTouchEvent :: EventM e TouchEvent TouchEventResult
1496getTouchEvent = do
2638getTouchEvent = do
@@ -1532,11 +2674,31 @@ getTouchEvent = do
1532 , _touchEventResult_touches = touches
2674 , _touchEventResult_touches = touches
1533 }
2675 }
1534
2676
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+
1535−instance MonadSample t m => MonadSample t (ImmediateDomBuilderT t m) where
2697+instance MonadSample t m => MonadSample t (HydrationDomBuilderT s t m) where
1536 {-# INLINABLE sample #-}
2698 {-# INLINABLE sample #-}
1537 sample = lift . sample
2699 sample = lift . sample
1538
2700
1539−instance MonadHold t m => MonadHold t (ImmediateDomBuilderT t m) where
2701+instance MonadHold t m => MonadHold t (HydrationDomBuilderT s t m) where
1540 {-# INLINABLE hold #-}
2702 {-# INLINABLE hold #-}
1541 hold v0 v' = lift $ hold v0 v'
2703 hold v0 v' = lift $ hold v0 v'
1542 {-# INLINABLE holdDyn #-}
2704 {-# INLINABLE holdDyn #-}
@@ -1558,7 +2720,7 @@ data Window t = Window
1558 , _window_raw :: DOM.Window
2720 , _window_raw :: DOM.Window
1559 }
2721 }
1560
2722
1561−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)
1562wrapWindow wv _ = do
2724wrapWindow wv _ = do
1563 events <- wrapDomEventsMaybe wv (defaultDomWindowEventHandler wv) windowOnEventName
2725 events <- wrapDomEventsMaybe wv (defaultDomWindowEventHandler wv) windowOnEventName
1564 return $ Window
2726 return $ Window
reflex-dom-core/src/Reflex/Dom/Builder/InputDisabled.hs+6
@@ -80,6 +80,7 @@ instance Adjustable t m => Adjustable t (InputDisabledT m) where
80 runWithReplace a0 a' = InputDisabledT $ runWithReplace (coerce a0) (coerceEvent a')
80 runWithReplace a0 a' = InputDisabledT $ runWithReplace (coerce a0) (coerceEvent a')
81 traverseDMapWithKeyWithAdjust f dm0 dm' = InputDisabledT $ traverseDMapWithKeyWithAdjust (\k v -> runInputDisabledT $ f k v) (coerce dm0) (coerceEvent dm')
81 traverseDMapWithKeyWithAdjust f dm0 dm' = InputDisabledT $ traverseDMapWithKeyWithAdjust (\k v -> runInputDisabledT $ f k v) (coerce dm0) (coerceEvent dm')
82 traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = InputDisabledT $ traverseDMapWithKeyWithAdjustWithMove (\k v -> runInputDisabledT $ f k v) (coerce dm0) (coerceEvent dm')
82 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')
83
84
84instance NotReady t m => NotReady t (InputDisabledT m) where
85instance NotReady t m => NotReady t (InputDisabledT m) where
85 notReadyUntil = lift . notReadyUntil
86 notReadyUntil = lift . notReadyUntil
@@ -108,3 +109,8 @@ instance HasJSContext m => HasJSContext (InputDisabledT m) where
108instance HasJS js m => HasJS js (InputDisabledT m) where
109instance HasJS js m => HasJS js (InputDisabledT m) where
109 type JSX (InputDisabledT m) = JSX m
110 type JSX (InputDisabledT m) = JSX m
110 liftJS = lift . liftJS
111 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+49−22
@@ -37,6 +37,8 @@ import Data.IntMap (IntMap)
37import qualified Data.IntMap as IntMap
37import qualified Data.IntMap as IntMap
38import qualified Data.Map as Map
38import qualified Data.Map as Map
39import Data.Map.Misc (applyMap)
39import Data.Map.Misc (applyMap)
40+import Data.Maybe (fromMaybe)
41+import Data.Monoid ((<>))
40import qualified Data.Set as Set
42import qualified Data.Set as Set
41import Data.Text (Text)
43import Data.Text (Text)
42import qualified Data.Text as T
44import qualified Data.Text as T
@@ -54,9 +56,6 @@ import Reflex.PerformEvent.Class
54import Reflex.PostBuild.Base
56import Reflex.PostBuild.Base
55import Reflex.PostBuild.Class
57import Reflex.PostBuild.Class
56import Reflex.TriggerEvent.Class
58import Reflex.TriggerEvent.Class
57−import System.Random (randomRIO)
58−
59−import qualified GHCJS.DOM.Types as DOM
60
59
61data StaticDomBuilderEnv t = StaticDomBuilderEnv
60data StaticDomBuilderEnv t = StaticDomBuilderEnv
62 { _staticDomBuilderEnv_shouldEscape :: Bool
61 { _staticDomBuilderEnv_shouldEscape :: Bool
@@ -65,6 +64,7 @@ data StaticDomBuilderEnv t = StaticDomBuilderEnv
65 -- We use this to add a "selected" attribute to the appropriate "option" child element.
64 -- We use this to add a "selected" attribute to the appropriate "option" child element.
66 -- This is not yet a perfect simulation of what the browser does, but it is much closer than doing nothing.
65 -- This is not yet a perfect simulation of what the browser does, but it is much closer than doing nothing.
67 -- TODO: Handle edge cases, e.g. setting to a value for which there is no option, then adding that option dynamically afterwards.
66 -- 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
68 }
68 }
69
69
70newtype StaticDomBuilderT t m a = StaticDomBuilderT
70newtype StaticDomBuilderT t m a = StaticDomBuilderT
@@ -165,7 +165,7 @@ instance (SupportsStaticDomBuilder t m, Monad m) => HasDocument (StaticDomBuilde
165instance (Reflex t, Adjustable t m, MonadHold t m, SupportsStaticDomBuilder t m) => Adjustable t (StaticDomBuilderT t m) where
165instance (Reflex t, Adjustable t m, MonadHold t m, SupportsStaticDomBuilder t m) => Adjustable t (StaticDomBuilderT t m) where
166 runWithReplace a0 a' = do
166 runWithReplace a0 a' = do
167 e <- StaticDomBuilderT ask
167 e <- StaticDomBuilderT ask
168− key <- replaceStart
168+ key <- replaceStart e
169 (result0, result') <- lift $ runWithReplace (runStaticDomBuilderT a0 e) (flip runStaticDomBuilderT e <$> a')
169 (result0, result') <- lift $ runWithReplace (runStaticDomBuilderT a0 e) (flip runStaticDomBuilderT e <$> a')
170 o <- hold (snd result0) $ fmapCheap snd result'
170 o <- hold (snd result0) $ fmapCheap snd result'
171 StaticDomBuilderT $ modify $ (:) $ join o
171 StaticDomBuilderT $ modify $ (:) $ join o
@@ -175,10 +175,9 @@ instance (Reflex t, Adjustable t m, MonadHold t m, SupportsStaticDomBuilder t m)
175 traverseDMapWithKeyWithAdjust = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap
175 traverseDMapWithKeyWithAdjust = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap
176 traverseDMapWithKeyWithAdjustWithMove = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove
176 traverseDMapWithKeyWithAdjustWithMove = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove
177
177
178−-- TODO remove this?
179−replaceStart :: (DomBuilder t m, MonadIO m) => m Text
178+replaceStart :: (DomBuilder t m, MonadIO m) => StaticDomBuilderEnv t -> m Text
180−replaceStart = do
179+replaceStart env = do
181− str <- liftIO $ replicateM 8 $ randomRIO ('a', 'z')
180+ str <- show <$> liftIO (atomicModifyRef (_staticDomBuilderEnv_nextRunWithReplaceKey env) $ \k -> (succ k, k))
182 let key = "-" <> T.pack str
181 let key = "-" <> T.pack str
183 _ <- commentNode $ def { _commentNodeConfig_initialContents = "replace-start" <> key }
182 _ <- commentNode $ def { _commentNodeConfig_initialContents = "replace-start" <> key }
184 pure key
183 pure key
@@ -275,7 +274,7 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
275 --TODO: Do not escape quotation marks; see https://stackoverflow.com/questions/25612166/what-characters-must-be-escaped-in-html-5
274 --TODO: Do not escape quotation marks; see https://stackoverflow.com/questions/25612166/what-characters-must-be-escaped-in-html-5
276 shouldEscape <- asks _staticDomBuilderEnv_shouldEscape
275 shouldEscape <- asks _staticDomBuilderEnv_shouldEscape
277 let escape = if shouldEscape then fromHtmlEscapedText else byteString . encodeUtf8
276 let escape = if shouldEscape then fromHtmlEscapedText else byteString . encodeUtf8
278− modify . (:) =<< (\c -> "<!--" <> c <> "-->") <$> case mSetContents of
277+ (modify . (:)) . (\c -> "<!--" <> c <> "-->") =<< case mSetContents of
279 Nothing -> return (pure (escape initialContents))
278 Nothing -> return (pure (escape initialContents))
280 Just setContents -> hold (escape initialContents) $ fmapCheap escape setContents --Only because it doesn't get optimized when profiling is on
279 Just setContents -> hold (escape initialContents) $ fmapCheap escape setContents --Only because it doesn't get optimized when profiling is on
281 return $ CommentNode ()
280 return $ CommentNode ()
@@ -288,8 +287,9 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
288 es <- newFanEventWithTrigger $ \_ _ -> return (return ())
287 es <- newFanEventWithTrigger $ \_ _ -> return (return ())
289 StaticDomBuilderT $ do
288 StaticDomBuilderT $ do
290 let shouldEscape = elementTag `Set.notMember` noEscapeElements
289 let shouldEscape = elementTag `Set.notMember` noEscapeElements
290+ nextRunWithReplaceKey <- asks _staticDomBuilderEnv_nextRunWithReplaceKey
291− (result, innerHtml) <- lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv shouldEscape Nothing
291+ (result, innerHtml) <- lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv shouldEscape Nothing nextRunWithReplaceKey
292− attrs0 <- foldDyn applyMap (Map.insert "ssr" "" $ cfg ^. initialAttributes) (cfg ^. modifyAttributes)
292+ attrs0 <- foldDyn applyMap (cfg ^. initialAttributes) (cfg ^. modifyAttributes)
293 selectValue <- asks _staticDomBuilderEnv_selectValue
293 selectValue <- asks _staticDomBuilderEnv_selectValue
294 let addSelectedAttr attrs sel = case Map.lookup "value" attrs of
294 let addSelectedAttr attrs sel = case Map.lookup "value" attrs of
295 Just v | v == sel -> attrs <> Map.singleton "selected" ""
295 Just v | v == sel -> attrs <> Map.singleton "selected" ""
@@ -312,13 +312,32 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
312 return (e, result)
312 return (e, result)
313 {-# INLINABLE inputElement #-}
313 {-# INLINABLE inputElement #-}
314 inputElement cfg = do
314 inputElement cfg = do
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
315− (e, _result) <- element "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
330+ (e, _result) <- element "input" adjustedConfig $ return ()
331+ v <- case _inputElementConfig_setValue cfg of
332+ Nothing -> pure $ constDyn (cfg ^. inputElementConfig_initialValue)
316− let v0 = constDyn $ cfg ^. inputElementConfig_initialValue
333+ Just ev -> holdDyn (cfg ^. inputElementConfig_initialValue) ev
317− let c0 = constDyn $ cfg ^. inputElementConfig_initialChecked
334+ c <- case _inputElementConfig_setChecked cfg of
335+ Nothing -> pure $ constDyn $ _inputElementConfig_initialChecked cfg
336+ Just ev -> holdDyn (_inputElementConfig_initialChecked cfg) ev
318 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
337 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
319 return $ InputElement
338 return $ InputElement
320− { _inputElement_value = v0
339+ { _inputElement_value = v
321− , _inputElement_checked = c0
340+ , _inputElement_checked = c
322 , _inputElement_checkedChange = never
341 , _inputElement_checkedChange = never
323 , _inputElement_input = never
342 , _inputElement_input = never
324 , _inputElement_hasFocus = hasFocus
343 , _inputElement_hasFocus = hasFocus
@@ -328,12 +347,17 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
328 }
347 }
329 {-# INLINABLE textAreaElement #-}
348 {-# INLINABLE textAreaElement #-}
330 textAreaElement cfg = do
349 textAreaElement cfg = do
331− --TODO: Support setValue event
332− (e, _domElement) <- element "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
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)
333− let v0 = constDyn $ cfg ^. textAreaElementConfig_initialValue
357+ Just ev -> holdDyn (cfg ^. textAreaElementConfig_initialValue) ev
334 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
358 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
335 return $ TextAreaElement
359 return $ TextAreaElement
336− { _textAreaElement_value = v0
360+ { _textAreaElement_value = v
337 , _textAreaElement_input = never
361 , _textAreaElement_input = never
338 , _textAreaElement_hasFocus = hasFocus
362 , _textAreaElement_hasFocus = hasFocus
339 , _textAreaElement_element = e
363 , _textAreaElement_element = e
@@ -342,7 +366,9 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
342 selectElement cfg child = do
366 selectElement cfg child = do
343 v <- holdDyn (cfg ^. selectElementConfig_initialValue) (cfg ^. selectElementConfig_setValue)
367 v <- holdDyn (cfg ^. selectElementConfig_initialValue) (cfg ^. selectElementConfig_setValue)
344 (e, result) <- element "select" (_selectElementConfig_elementConfig cfg) $ do
368 (e, result) <- element "select" (_selectElementConfig_elementConfig cfg) $ do
369+ (a, innerHtml) <- StaticDomBuilderT $ do
370+ nextRunWithReplaceKey <- asks _staticDomBuilderEnv_nextRunWithReplaceKey
345− (a, innerHtml) <- StaticDomBuilderT $ lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv False $ Just (current v)
371+ lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv False (Just $ current v) nextRunWithReplaceKey
346 StaticDomBuilderT $ lift $ modify $ (:) innerHtml
372 StaticDomBuilderT $ lift $ modify $ (:) innerHtml
347 return a
373 return a
348 let wrapped = SelectElement
374 let wrapped = SelectElement
@@ -364,7 +390,8 @@ renderStatic :: StaticWidget x a -> IO (a, ByteString)
364renderStatic w = do
390renderStatic w = do
365 runDomHost $ do
391 runDomHost $ do
366 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
392 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
393+ nextRunWithReplaceKey <- newRef 0
367− let env0 = StaticDomBuilderEnv True Nothing
394+ let env0 = StaticDomBuilderEnv True Nothing nextRunWithReplaceKey
368 ((res, bs), FireCommand fire) <- hostPerformEventT $ runStaticDomBuilderT (runPostBuildT w postBuild) env0
395 ((res, bs), FireCommand fire) <- hostPerformEventT $ runStaticDomBuilderT (runPostBuildT w postBuild) env0
369 mPostBuildTrigger <- readRef postBuildTriggerRef
396 mPostBuildTrigger <- readRef postBuildTriggerRef
370 forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
397 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
4 , module Web.KeyCode
4 , module Web.KeyCode
5 ) where
5 ) where
6
6
7−import Data.Map (Map)
7+import Control.Lens
8−import qualified Data.Map as Map
9import Reflex.Class
8import Reflex.Class
10import Web.KeyCode
9import Web.KeyCode
11
10
@@ -13,11 +12,9 @@ import Foreign.JavaScript.TH
13import Reflex.PerformEvent.Class
12import Reflex.PerformEvent.Class
14import Reflex.PostBuild.Class
13import Reflex.PostBuild.Class
15
14
16−import Prelude hiding (concat, mapM, mapM_, sequence)
17−
18−-- | Alias for Data.Map.singleton
15+-- | Previously an alias for 'Data.Map.singleton', but now generalised to 'At'
19−(=:) :: k -> a -> Map k a
16+(=:) :: (At m, Monoid m) => Index m -> IxValue m -> m
20−(=:) = Map.singleton
17+k =: a = at k ?~ a $ mempty
21infixr 7 =: -- Ought to bind tighter than <>, which is infixr 6
18infixr 7 =: -- Ought to bind tighter than <>, which is infixr 6
22
19
23{-# DEPRECATED keycodeEnter "Instead of `x == keycodeEnter`, use `keyCodeLookup x == Enter`" #-}
20{-# DEPRECATED keycodeEnter "Instead of `x == keycodeEnter`, use `keyCodeLookup x == Enter`" #-}
reflex-dom-core/src/Reflex/Dom/Core.hs+7−3
@@ -1,18 +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 #-}
1module Reflex.Dom.Core (module X) where
5module Reflex.Dom.Core (module X) where
2
6
3import Reflex as X hiding (askEvents)
7import Reflex as X hiding (askEvents)
4import Reflex.Dom.Builder.Class as X
8import Reflex.Dom.Builder.Class as X
5−import Reflex.Dom.Builder.Hydration as X
9+import Reflex.Dom.Builder.Hydratable as X
6−--import Reflex.Dom.Builder.Immediate as X
10+import Reflex.Dom.Builder.Immediate as X
7import Reflex.Dom.Builder.InputDisabled as X
11import Reflex.Dom.Builder.InputDisabled as X
8import Reflex.Dom.Builder.Static as X
12import Reflex.Dom.Builder.Static as X
9import Reflex.Dom.Class as X
13import Reflex.Dom.Class as X
10import Reflex.Dom.Location as X
14import Reflex.Dom.Location as X
11import Reflex.Dom.Main as X
15import Reflex.Dom.Main as X
12−import Reflex.Dom.Modals.Base as X
13import Reflex.Dom.Modals.Class as X
16import Reflex.Dom.Modals.Class as X
14import Reflex.Dom.Old as X
17import Reflex.Dom.Old as X
15import Reflex.Dom.Prerender as X
18import Reflex.Dom.Prerender as X
16import Reflex.Dom.WebSocket as X
19import Reflex.Dom.WebSocket as X
17import Reflex.Dom.Widget as X
20import Reflex.Dom.Widget as X
18import Reflex.Dom.Xhr as X
21import Reflex.Dom.Xhr as X
22+import Reflex.Dom.Xhr.FormData as X
reflex-dom-core/src/Reflex/Dom/Location.hs+39
@@ -12,6 +12,7 @@ module Reflex.Dom.Location
12 , getLocationProtocol
12 , getLocationProtocol
13 , getLocationUrl
13 , getLocationUrl
14 , manageHistory
14 , manageHistory
15+ , manageHistory'
15 , HistoryCommand (..)
16 , HistoryCommand (..)
16 , HistoryStateUpdate (..)
17 , HistoryStateUpdate (..)
17 , HistoryItem (..)
18 , HistoryItem (..)
@@ -23,8 +24,11 @@ import Reflex.Dom.Builder.Immediate (wrapDomEvent)
23
24
24import Control.Lens ((^.))
25import Control.Lens ((^.))
25import Control.Monad ((>=>))
26import Control.Monad ((>=>))
27+import Control.Monad.Fix (MonadFix)
28+import Data.Align (align)
26import Data.Monoid
29import Data.Monoid
27import Data.Text (Text)
30import Data.Text (Text)
31+import Data.These (These(..))
28import qualified GHCJS.DOM as DOM
32import qualified GHCJS.DOM as DOM
29import qualified GHCJS.DOM.EventM as DOM
33import qualified GHCJS.DOM.EventM as DOM
30import qualified GHCJS.DOM.Location as Location
34import qualified GHCJS.DOM.Location as Location
@@ -159,3 +163,38 @@ manageHistory runCmd = do
159 <*> getLocationUri location
163 <*> getLocationUri location
160 holdDyn item0 $ leftmost [itemSetInternal, itemSetExternal]
164 holdDyn item0 $ leftmost [itemSetInternal, itemSetExternal]
161--TODO: Handle title setting better
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+140−84
@@ -5,7 +5,6 @@
5{-# LANGUAGE GADTs #-}
5{-# LANGUAGE GADTs #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
7{-# LANGUAGE NoMonomorphismRestriction #-}
7{-# LANGUAGE NoMonomorphismRestriction #-}
8−{-# LANGUAGE PatternSynonyms #-}
9{-# LANGUAGE RankNTypes #-}
8{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE RecursiveDo #-}
9{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
@@ -20,7 +19,6 @@ import Prelude hiding (concat, mapM, mapM_, sequence, sequence_)
20import Reflex.Adjustable.Class
19import Reflex.Adjustable.Class
21import Reflex.Class
20import Reflex.Class
22import Reflex.Dom.Builder.Immediate
21import Reflex.Dom.Builder.Immediate
23−import Reflex.Dom.Builder.Hydration
24import Reflex.Dom.Class
22import Reflex.Dom.Class
25import Reflex.Host.Class
23import Reflex.Host.Class
26import Reflex.PerformEvent.Base
24import Reflex.PerformEvent.Base
@@ -28,9 +26,9 @@ import Reflex.PostBuild.Base
28import Reflex.Spider (Global, Spider, SpiderHost, runSpiderHost)
26import Reflex.Spider (Global, Spider, SpiderHost, runSpiderHost)
29import Reflex.TriggerEvent.Base
27import Reflex.TriggerEvent.Base
30import Reflex.TriggerEvent.Class
28import Reflex.TriggerEvent.Class
31−import qualified Reflex.TriggerEvent.Base as TriggerEvent
29+#ifdef PROFILE_REFLEX
32−
30+import Reflex.Profiled
33−import Reflex.Dom.Specializations () -- For SPECIALIZATION pragmas, which are always re-exported
31+#endif
34
32
35import Control.Concurrent
33import Control.Concurrent
36import Control.Lens
34import Control.Lens
@@ -58,104 +56,134 @@ import qualified GHCJS.DOM.Types as DOM
58import Reflex.Profiled
56import Reflex.Profiled
59#endif
57#endif
60
58
61−{-# INLINE mainHydrationWidget #-}
59+{-# INLINE mainHydrationWidgetWithHead #-}
62−mainHydrationWidget :: (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
60+mainHydrationWidgetWithHead :: (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
63−mainHydrationWidget = mainHydrationWidget'
61+mainHydrationWidgetWithHead = mainHydrationWidgetWithHead'
64
62
65−{-# INLINABLE mainHydrationWidget' #-}
63+{-# INLINABLE mainHydrationWidgetWithHead' #-}
66−-- | Warning: `mainHydrationWidget'` is provided only as performance tweak. It is expected to disappear in future releases.
64+-- | Warning: `mainHydrationWidgetWithHead'` is provided only as performance tweak. It is expected to disappear in future releases.
67−mainHydrationWidget' :: HydrationWidget () () -> HydrationWidget () () -> JSM ()
65+mainHydrationWidgetWithHead' :: HydrationWidget () () -> HydrationWidget () () -> JSM ()
68−mainHydrationWidget' = mainHydrationWidgetWithSwitchoverAction' (pure ())
66+mainHydrationWidgetWithHead' = mainHydrationWidgetWithSwitchoverAction' (pure ())
69
67
70{-# INLINE mainHydrationWidgetWithSwitchoverAction #-}
68{-# INLINE mainHydrationWidgetWithSwitchoverAction #-}
71−mainHydrationWidgetWithSwitchoverAction :: IO () -> (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
69+mainHydrationWidgetWithSwitchoverAction :: JSM () -> (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
72mainHydrationWidgetWithSwitchoverAction = mainHydrationWidgetWithSwitchoverAction'
70mainHydrationWidgetWithSwitchoverAction = mainHydrationWidgetWithSwitchoverAction'
73
71
74{-# INLINABLE mainHydrationWidgetWithSwitchoverAction' #-}
72{-# INLINABLE mainHydrationWidgetWithSwitchoverAction' #-}
75-- | Warning: `mainHydrationWidgetWithSwitchoverAction'` is provided only as performance tweak. It is expected to disappear in future releases.
73-- | Warning: `mainHydrationWidgetWithSwitchoverAction'` is provided only as performance tweak. It is expected to disappear in future releases.
76−mainHydrationWidgetWithSwitchoverAction' :: IO () -> HydrationWidget () () -> HydrationWidget () () -> JSM ()
74+mainHydrationWidgetWithSwitchoverAction' :: JSM () -> HydrationWidget () () -> HydrationWidget () () -> JSM ()
77−mainHydrationWidgetWithSwitchoverAction' switchoverAction head' body = do
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
78− runHydrationWidgetWithHeadAndBody switchoverAction $ \appendHead appendBody -> do
82+ runHydrationWidgetWithHeadAndBodyWithFailure onFailure switchoverAction $ \appendHead appendBody -> do
79 appendHead head'
83 appendHead head'
80 appendBody body
84 appendBody body
81
85
82{-# INLINABLE attachHydrationWidget #-}
86{-# INLINABLE attachHydrationWidget #-}
83attachHydrationWidget
87attachHydrationWidget
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
84 :: IO ()
101 :: IO ()
85− -> IORef HydrationMode
102+ -> JSM ()
86− -> IORef [(Node, HydrationRunnerT DomTimeline (PostBuildT DomTimeline (WithJSContextSingleton () (PerformEventT DomTimeline DomHost))) ())]
87 -> JSContextSingleton ()
103 -> JSContextSingleton ()
104+ -> ( Event DomTimeline ()
105+ -> IORef HydrationMode
106+ -> Maybe (IORef [(Node, HydrationRunnerT DomTimeline (DomCoreWidget ()) ())])
107+ -> EventChannel
88− -> (EventChannel -> Event DomTimeline () -> PerformEventT DomTimeline DomHost (IORef (Maybe (EventTrigger DomTimeline ()))))
108+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
89− -> IO ()
109+ )
90−attachHydrationWidget switchoverAction hydrationMode rootNodesRef jsSing w = do
110+ -> IO (a, FireCommand DomTimeline DomHost)
111+attachHydrationWidgetWithFailure onFailure switchoverAction jsSing w = do
112+ hydrationMode <- liftIO $ newIORef HydrationMode_Hydrating
113+ rootNodesRef <- liftIO $ newIORef []
91 events <- newChan
114 events <- newChan
92 runDomHost $ flip runTriggerEventT events $ mdo
115 runDomHost $ flip runTriggerEventT events $ mdo
93 (syncEvent, fireSync) <- newTriggerEvent
116 (syncEvent, fireSync) <- newTriggerEvent
94− (postBuildTriggerRef, fc@(FireCommand fire)) <- lift $ hostPerformEventT $ do
117+ ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- lift $ hostPerformEventT $ do
95− a <- w events syncEvent
118+ a <- w syncEvent hydrationMode (Just rootNodesRef) events
96 _ <- runWithReplace (return ()) $ delayedAction <$ syncEvent
119 _ <- runWithReplace (return ()) $ delayedAction <$ syncEvent
97 pure a
120 pure a
98 mPostBuildTrigger <- readRef postBuildTriggerRef
121 mPostBuildTrigger <- readRef postBuildTriggerRef
99 lift $ forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
122 lift $ forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
100 liftIO $ fireSync ()
123 liftIO $ fireSync ()
101 rootNodes <- liftIO $ readIORef rootNodesRef
124 rootNodes <- liftIO $ readIORef rootNodesRef
102− -- TODO: DomHost is SpiderHost Global only if we're not in profiling mode
103 let delayedAction = do
125 let delayedAction = do
104 for_ (reverse rootNodes) $ \(rootNode, runner) -> do
126 for_ (reverse rootNodes) $ \(rootNode, runner) -> do
105− void $ runWithJSContextSingleton (runPostBuildT (runHydrationRunnerT runner Nothing rootNode events) never) jsSing
127+ let hydrate = runHydrationRunnerTWithFailure runner onFailure Nothing rootNode events
128+ void $ runWithJSContextSingleton (runPostBuildT hydrate never) jsSing
106 liftIO $ writeIORef hydrationMode HydrationMode_Immediate
129 liftIO $ writeIORef hydrationMode HydrationMode_Immediate
107− liftIO $ switchoverAction
130+ runWithJSContextSingleton (DOM.liftJSM switchoverAction) jsSing
108− liftIO $ processAsyncEvents events fc
131+ pure (result, fc)
109
132
110−type HydrationWidget x a = HydrationDomBuilderT DomTimeline (DomCoreWidget x) a
133+type HydrationWidget x a = HydrationDomBuilderT HydrationDomSpace DomTimeline (DomCoreWidget x) a
111
134
112-- | A widget that isn't attached to any particular part of the DOM hierarchy
135-- | A widget that isn't attached to any particular part of the DOM hierarchy
113type FloatingWidget x = TriggerEventT DomTimeline (DomCoreWidget x)
136type FloatingWidget x = TriggerEventT DomTimeline (DomCoreWidget x)
114
137
115type DomCoreWidget x = PostBuildT DomTimeline (WithJSContextSingleton x (PerformEventT DomTimeline DomHost))
138type DomCoreWidget x = PostBuildT DomTimeline (WithJSContextSingleton x (PerformEventT DomTimeline DomHost))
116
139
140+{-# INLINABLE runHydrationWidgetWithHeadAndBody #-}
117runHydrationWidgetWithHeadAndBody
141runHydrationWidgetWithHeadAndBody
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
118 :: IO ()
152 :: IO ()
153+ -> JSM ()
119− -> ( (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to head"
154+ -> ( (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to head" --TODO: test invoking this more than once
120− -> (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to body"
155+ -> (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to body" --TODO: test invoking this more than once
121 -> FloatingWidget () ()
156 -> FloatingWidget () ()
122 )
157 )
123 -> JSM ()
158 -> JSM ()
124−runHydrationWidgetWithHeadAndBody switchoverAction app = withJSContextSingletonMono $ \jsSing -> do
159+runHydrationWidgetWithHeadAndBodyWithFailure onFailure switchoverAction app = withJSContextSingletonMono $ \jsSing -> do
125 globalDoc <- currentDocumentUnchecked
160 globalDoc <- currentDocumentUnchecked
126 headElement <- getHeadUnchecked globalDoc
161 headElement <- getHeadUnchecked globalDoc
127 bodyElement <- getBodyUnchecked globalDoc
162 bodyElement <- getBodyUnchecked globalDoc
128− unreadyChildren <- liftIO $ newIORef 0
163+ (events, fc) <- liftIO . attachHydrationWidgetWithFailure onFailure switchoverAction jsSing $ \switchover hydrationMode hydrationResult events -> do
129− hydrationMode <- liftIO $ newIORef HydrationMode_Hydrating
130− hydrationResult <- liftIO $ newIORef []
131− liftIO $ attachHydrationWidget switchoverAction hydrationMode hydrationResult jsSing $ \events switchover -> flip runWithJSContextSingleton jsSing $ do
132 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
164 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
133 let hydrateDom :: DOM.Node -> HydrationWidget () c -> FloatingWidget () c
165 let hydrateDom :: DOM.Node -> HydrationWidget () c -> FloatingWidget () c
134 hydrateDom n w = do
166 hydrateDom n w = do
135− events' <- TriggerEvent.askEvents
167+ delayed <- liftIO $ newIORef $ pure ()
136− parent <- liftIO $ newIORef $ toNode n
168+ unreadyChildren <- liftIO $ newIORef 0
137 lift $ do
169 lift $ do
138 let builderEnv = HydrationDomBuilderEnv
170 let builderEnv = HydrationDomBuilderEnv
139 { _hydrationDomBuilderEnv_document = globalDoc
171 { _hydrationDomBuilderEnv_document = globalDoc
140− , _hydrationDomBuilderEnv_parent = parent
172+ , _hydrationDomBuilderEnv_parent = Left $ toNode n
141 , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
173 , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
142 , _hydrationDomBuilderEnv_commitAction = pure ()
174 , _hydrationDomBuilderEnv_commitAction = pure ()
143 , _hydrationDomBuilderEnv_hydrationMode = hydrationMode
175 , _hydrationDomBuilderEnv_hydrationMode = hydrationMode
144 , _hydrationDomBuilderEnv_switchover = switchover
176 , _hydrationDomBuilderEnv_switchover = switchover
177+ , _hydrationDomBuilderEnv_delayed = delayed
145 }
178 }
146− (a, res) <- runHydrationDomBuilderT w builderEnv events'
179+ a <- runHydrationDomBuilderT w builderEnv events
180+ forM_ hydrationResult $ \hr -> do
181+ res <- liftIO $ readIORef delayed
147− liftIO $ modifyIORef' hydrationResult ((n, res) :)
182+ liftIO $ modifyIORef' hr ((n, res) :)
148 pure a
183 pure a
149− flip runPostBuildT postBuild $ flip runTriggerEventT events $ app (hydrateDom $ toNode headElement) (hydrateDom $ toNode bodyElement)
184+ runWithJSContextSingleton (runPostBuildT (runTriggerEventT (app (hydrateDom $ toNode headElement) (hydrateDom $ toNode bodyElement)) events) postBuild) jsSing
150−-- liftIO (readIORef unreadyChildren) >>= \case
151−-- 0 -> DOM.liftJSM commit
152−-- _ -> return ()
153− return postBuildTriggerRef
185+ return (events, postBuildTriggerRef)
154−
186+ liftIO $ processAsyncEvents events fc
155−
156−
157−
158−
159
187
160{-# INLINE mainWidget #-}
188{-# INLINE mainWidget #-}
161mainWidget :: (forall x. Widget x ()) -> JSM ()
189mainWidget :: (forall x. Widget x ()) -> JSM ()
@@ -208,40 +236,54 @@ runDomHost = runSpiderHost
208 . runProfiledM
236 . runProfiledM
209#endif
237#endif
210
238
211−type Widget x = PostBuildT DomTimeline (ImmediateDomBuilderT DomTimeline (WithJSContextSingleton x (PerformEventT DomTimeline DomHost))) --TODO: Make this more abstract --TODO: Put the WithJSContext underneath PerformEventT - I think this would perform better because it could avoid fmapping over every performEvent
239+type Widget x = ImmediateDomBuilderT DomTimeline (DomCoreWidget x)
212
240
213{-# INLINABLE attachWidget #-}
241{-# INLINABLE attachWidget #-}
214attachWidget :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> JSM a
242attachWidget :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> JSM a
215attachWidget rootElement wv w = fst <$> attachWidget' rootElement wv w
243attachWidget rootElement wv w = fst <$> attachWidget' rootElement wv w
216
244
217−-- | Warning: `mainWidgetWithHead'` is provided only as performance tweak. It is expected to disappear in future releases.
245+{-# INLINABLE runImmediateWidgetWithHeadAndBody #-}
218−mainWidgetWithHead' :: (a -> Widget () b, b -> Widget () a) -> JSM ()
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 ()
219−mainWidgetWithHead' widgets = withJSContextSingletonMono $ \jsSing -> do
252+runImmediateWidgetWithHeadAndBody app = withJSContextSingletonMono $ \jsSing -> do
220− doc <- currentDocumentUnchecked
253+ globalDoc <- currentDocumentUnchecked
221− headElement <- getHeadUnchecked doc
254+ headElement <- getHeadUnchecked globalDoc
222− headFragment <- createDocumentFragment doc
223− bodyElement <- getBodyUnchecked doc
255+ bodyElement <- getBodyUnchecked globalDoc
256+ headFragment <- createDocumentFragment globalDoc
224− bodyFragment <- createDocumentFragment doc
257+ bodyFragment <- createDocumentFragment globalDoc
225− (events, fc) <- liftIO . attachWidget'' $ \events -> do
258+ (events, fc) <- liftIO . attachImmediateWidget $ \hydrationMode events -> do
226− let (headWidget, bodyWidget) = widgets
227 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
259 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
228− let go :: forall c. Widget () c -> DOM.DocumentFragment -> PerformEventT DomTimeline DomHost c
260+ let go :: forall c. DOM.DocumentFragment -> Widget () c -> FloatingWidget () c
229− go w df = do
261+ go df w = do
230 unreadyChildren <- liftIO $ newIORef 0
262 unreadyChildren <- liftIO $ newIORef 0
231− let builderEnv = ImmediateDomBuilderEnv
263+ delayed <- liftIO $ newIORef $ pure ()
232− { _immediateDomBuilderEnv_document = toDocument doc
264+ let builderEnv = HydrationDomBuilderEnv
233− , _immediateDomBuilderEnv_parent = toNode df
265+ { _hydrationDomBuilderEnv_document = globalDoc
234− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
266+ , _hydrationDomBuilderEnv_parent = Left $ toNode df
235− , _immediateDomBuilderEnv_commitAction = return () --TODO
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
236 }
272 }
237− runWithJSContextSingleton (runImmediateDomBuilderT (runPostBuildT w postBuild) builderEnv events) jsSing
273+ lift $ runHydrationDomBuilderT w builderEnv events
238− rec b <- go (headWidget a) headFragment
274+ runWithJSContextSingleton (runPostBuildT (runTriggerEventT (app (go headFragment) (go bodyFragment)) events) postBuild) jsSing
239− a <- go (bodyWidget b) bodyFragment
240 return (events, postBuildTriggerRef)
275 return (events, postBuildTriggerRef)
241 replaceElementContents headElement headFragment
276 replaceElementContents headElement headFragment
242 replaceElementContents bodyElement bodyFragment
277 replaceElementContents bodyElement bodyFragment
243 liftIO $ processAsyncEvents events fc
278 liftIO $ processAsyncEvents events fc
244
279
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+
245replaceElementContents :: DOM.IsElement e => e -> DOM.DocumentFragment -> JSM ()
287replaceElementContents :: DOM.IsElement e => e -> DOM.DocumentFragment -> JSM ()
246replaceElementContents e df = do
288replaceElementContents e df = do
247 setInnerHTML e ("" :: String)
289 setInnerHTML e ("" :: String)
@@ -253,16 +295,20 @@ attachWidget' :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> J
253attachWidget' rootElement jsSing w = do
295attachWidget' rootElement jsSing w = do
254 doc <- getOwnerDocumentUnchecked rootElement
296 doc <- getOwnerDocumentUnchecked rootElement
255 df <- createDocumentFragment doc
297 df <- createDocumentFragment doc
256− ((a, events), fc) <- liftIO . attachWidget'' $ \events -> do
298+ ((a, events), fc) <- liftIO . attachImmediateWidget $ \hydrationMode events -> do
257 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
299 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
258 unreadyChildren <- liftIO $ newIORef 0
300 unreadyChildren <- liftIO $ newIORef 0
259− let builderEnv = ImmediateDomBuilderEnv
301+ delayed <- liftIO $ newIORef $ pure ()
260− { _immediateDomBuilderEnv_document = toDocument doc
302+ let builderEnv = HydrationDomBuilderEnv
261− , _immediateDomBuilderEnv_parent = toNode df
303+ { _hydrationDomBuilderEnv_document = toDocument doc
262− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
304+ , _hydrationDomBuilderEnv_parent = Left $ toNode df
263− , _immediateDomBuilderEnv_commitAction = return () --TODO
305+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
306+ , _hydrationDomBuilderEnv_commitAction = return () --TODO
307+ , _hydrationDomBuilderEnv_switchover = never
308+ , _hydrationDomBuilderEnv_delayed = delayed
309+ , _hydrationDomBuilderEnv_hydrationMode = hydrationMode
264 }
310 }
265− a <- runWithJSContextSingleton (runImmediateDomBuilderT (runPostBuildT w postBuild) builderEnv events) jsSing
311+ a <- runWithJSContextSingleton (runPostBuildT (runHydrationDomBuilderT w builderEnv events) postBuild) jsSing
266 return ((a, events), postBuildTriggerRef)
312 return ((a, events), postBuildTriggerRef)
267 replaceElementContents rootElement df
313 replaceElementContents rootElement df
268 liftIO $ processAsyncEvents events fc
314 liftIO $ processAsyncEvents events fc
@@ -270,12 +316,18 @@ attachWidget' rootElement jsSing w = do
270
316
271type EventChannel = Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
317type EventChannel = Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
272
318
273−{-# INLINABLE attachWidget'' #-}
319+{-# INLINABLE attachImmediateWidget #-}
320+attachImmediateWidget
321+ :: ( IORef HydrationMode
322+ -> EventChannel
274−attachWidget'' :: (EventChannel -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))) -> IO (a, FireCommand DomTimeline DomHost)
323+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
275−attachWidget'' w = do
324+ )
325+ -> IO (a, FireCommand DomTimeline DomHost)
326+attachImmediateWidget w = do
327+ hydrationMode <- liftIO $ newIORef HydrationMode_Immediate
276 events <- newChan
328 events <- newChan
277 runDomHost $ do
329 runDomHost $ do
278− ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- hostPerformEventT $ w events
330+ ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- hostPerformEventT $ w hydrationMode events
279 mPostBuildTrigger <- readRef postBuildTriggerRef
331 mPostBuildTrigger <- readRef postBuildTriggerRef
280 forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
332 forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
281 return (result, fc)
333 return (result, fc)
@@ -291,7 +343,6 @@ processAsyncEvents events (FireCommand fire) = void $ forkIO $ forever $ do
291 liftIO $ forM_ ers $ \(_ :=> TriggerInvocation _ cb) -> cb
343 liftIO $ forM_ ers $ \(_ :=> TriggerInvocation _ cb) -> cb
292 return ()
344 return ()
293
345
294−
295-- | Run a reflex-dom application inside of an existing DOM element with the given ID
346-- | Run a reflex-dom application inside of an existing DOM element with the given ID
296mainWidgetInElementById :: Text -> (forall x. Widget x ()) -> JSM ()
347mainWidgetInElementById :: Text -> (forall x. Widget x ()) -> JSM ()
297mainWidgetInElementById eid w = withJSContextSingleton $ \jsSing -> do
348mainWidgetInElementById eid w = withJSContextSingleton $ \jsSing -> do
@@ -313,8 +364,13 @@ runApp' app = withJSContextSingleton $ \jsSing -> do
313 body <- getBodyUnchecked doc
364 body <- getBodyUnchecked doc
314 win <- getDefaultViewUnchecked doc
365 win <- getDefaultViewUnchecked doc
315 rec o <- attachWidget body jsSing $ do
366 rec o <- attachWidget body jsSing $ do
316− w <- lift $ wrapWindow win $ _appOutput_windowConfig o
367+ w <- wrapWindow win $ _appOutput_windowConfig o
317 app $ AppInput
368 app $ AppInput
318 { _appInput_window = w
369 { _appInput_window = w
319 }
370 }
320 return ()
371 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/Base.hsdeleted−199
@@ -1,199 +0,0 @@
1−{-
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE FlexibleInstances #-}
4−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE RecursiveDo #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TypeFamilies #-}
11−{-# LANGUAGE UndecidableInstances #-}
12−-}
13−module Reflex.Dom.Modals.Base
14−where
15−{-
16− ( ModalsT (..)
17− , ModalLayerConfig (..)
18− , withModalLayer
19− )where
20−
21−import Control.Lens hiding (element)
22−import Control.Monad.Fix
23−import Control.Monad.Primitive
24−import Control.Monad.Ref
25−import Control.Monad.Trans
26−import Data.Coerce
27−import Data.Default
28−import Data.Dependent.Map (DMap, DSum (..), GCompare)
29−import qualified Data.Dependent.Map as DMap
30−import Data.Functor.Compose
31−import Data.Proxy
32−import Data.Semigroup
33−import Data.Text (Text)
34−import qualified Data.Text as T
35−import Foreign.JavaScript.TH
36−import Language.Javascript.JSaddle (MonadJSM)
37−
38−import Data.Functor.Misc
39−import Reflex
40−import Reflex.Dom.Builder.Class
41−import Reflex.Dom.Builder.Immediate
42−import Reflex.Dom.Class
43−import Reflex.Dom.Modals.Class
44−import Reflex.Host.Class
45−
46−instance (Reflex t, PrimMonad m) => ModalOpener t (ModalsT t m) where
47− requestingModal = ModalsT . requesting . fmap Compose
48−
49−newtype ModalsT t m a = ModalsT { unModalsT :: RequesterT t (Compose (ModalsT t m) (Event t)) Maybe m a }
50− deriving (Functor, Applicative, Monad, MonadIO, MonadFix)
51−
52−instance Wrapped (ModalsT t m a) where
53− type Unwrapped (ModalsT t m a) = RequesterT t (Compose (ModalsT t m) (Event t)) Maybe m a
54− _Wrapped' = iso coerce coerce
55−
56−instance ModalsT t m a ~ x => Rewrapped (ModalsT t m a) x
57−
58−instance MonadTrans (ModalsT t) where
59− lift = ModalsT . lift
60−
61−instance (Reflex t, PostBuild t m) => PostBuild t (ModalsT t m) where
62− getPostBuild = view _Unwrapped getPostBuild
63−
64−instance MonadSample t m => MonadSample t (ModalsT t m) where
65− {-# INLINABLE sample #-}
66− sample = lift . sample
67−
68−instance MonadHold t m => MonadHold t (ModalsT t m) where
69− {-# INLINABLE hold #-}
70− hold v0 = lift . hold v0
71− {-# INLINABLE holdDyn #-}
72− holdDyn v0 = lift . holdDyn v0
73− {-# INLINABLE holdIncremental #-}
74− holdIncremental v0 = lift . holdIncremental v0
75−
76−instance PerformEvent t m => PerformEvent t (ModalsT t m) where
77− type Performable (ModalsT t m) = Performable m
78− {-# INLINABLE performEvent_ #-}
79− performEvent_ = lift . performEvent_
80− {-# INLINABLE performEvent #-}
81− performEvent = lift . performEvent
82−
83−instance (ReflexHost t, MonadReflexCreateTrigger t m) => MonadReflexCreateTrigger t (ModalsT t m) where
84− {-# INLINABLE newEventWithTrigger #-}
85− newEventWithTrigger = ModalsT . lift . newEventWithTrigger
86− {-# INLINABLE newFanEventWithTrigger #-}
87− newFanEventWithTrigger f = ModalsT $ lift $ newFanEventWithTrigger f
88−
89−instance TriggerEvent t m => TriggerEvent t (ModalsT t m) where
90− {-# INLINABLE newTriggerEvent #-}
91− newTriggerEvent = lift newTriggerEvent
92− {-# INLINABLE newTriggerEventWithOnComplete #-}
93− newTriggerEventWithOnComplete = lift newTriggerEventWithOnComplete
94− newEventWithLazyTriggerWithOnComplete = lift . newEventWithLazyTriggerWithOnComplete
95−
96−instance MonadRef m => MonadRef (ModalsT t m) where
97− type Ref (ModalsT t m) = Ref m
98− {-# INLINABLE newRef #-}
99− newRef = lift . newRef
100− {-# INLINABLE readRef #-}
101− readRef = lift . readRef
102− {-# INLINABLE writeRef #-}
103− writeRef r = lift . writeRef r
104−
105−instance MonadAtomicRef m => MonadAtomicRef (ModalsT t m) where
106− {-# INLINABLE atomicModifyRef #-}
107− atomicModifyRef r = lift . atomicModifyRef r
108−
109−instance (Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (ModalsT t m) where
110− runWithReplace a0 a' = ModalsT $ runWithReplace (unModalsT a0) (fmapCheap unModalsT a')
111− traverseDMapWithKeyWithAdjust f dm0 dm' = ModalsT $ traverseDMapWithKeyWithAdjust (coerce f) dm0 dm'
112− traverseDMapWithKeyWithAdjustWithMove f dm0 dm' = ModalsT $ traverseDMapWithKeyWithAdjustWithMove (coerce f) dm0 dm'
113−
114−instance (DomBuilder t m, PerformEvent t m, MonadFix m, MonadHold t m) => DomBuilder t (ModalsT t m) where
115− type DomBuilderSpace (ModalsT t m) = DomBuilderSpace m
116− element = coerce (element :: Text -> ElementConfig er t (DomBuilderSpace m) -> Unwrapped (ModalsT t m a) -> Unwrapped (ModalsT t m (Element er (DomBuilderSpace m) t, a)))
117− inputElement = coerce (inputElement :: InputElementConfig er t (DomBuilderSpace m) -> Unwrapped (ModalsT t m (InputElement er (DomBuilderSpace m) t)))
118− textAreaElement = coerce (textAreaElement :: TextAreaElementConfig er t (DomBuilderSpace m) -> Unwrapped (ModalsT t m (TextAreaElement er (DomBuilderSpace m) t)))
119− selectElement = coerce (selectElement :: SelectElementConfig er t (DomBuilderSpace m) -> Unwrapped (ModalsT t m a) -> Unwrapped (ModalsT t m (SelectElement er (DomBuilderSpace m) t, a)))
120− wrapRawElement e = (view _Unwrapped :: forall a. Unwrapped (ModalsT t m a) -> ModalsT t m a) . wrapRawElement e
121−
122−instance HasDocument m => HasDocument (ModalsT t m)
123−instance HasJSContext m => HasJSContext (ModalsT t m) where
124− type JSContextPhantom (ModalsT t m) = JSContextPhantom m
125− askJSContext = ModalsT askJSContext
126−#ifndef ghcjs_HOST_OS
127−instance MonadJSM m => MonadJSM (ModalsT t m)
128−#endif
129−
130−data ModalLayerConfig t m = ModalLayerConfig
131− { _modalLayerConfig_backdropElementConfig :: ElementConfig EventResult t (DomBuilderSpace m)
132− , _modalLayerConfig_bodyElementConfig :: ElementConfig EventResult t (DomBuilderSpace m)
133− }
134−
135−instance (DomBuilder t m) => Default (ModalLayerConfig t m) where
136− def = ModalLayerConfig
137− { _modalLayerConfig_backdropElementConfig = (def :: ElementConfig EventResult t (DomBuilderSpace m))
138− & elementConfig_eventSpec %~ addEventSpecFlags (Proxy :: Proxy (DomBuilderSpace m)) Click (const stopPropagation)
139− & initialAttributes .~ ("style" =: T.intercalate ";"
140− [ "position:absolute"
141− , "left:0", "right:0", "top:0", "bottom:0"
142− , "background-color:rgba(0,0,0,0.1)"
143− , "display:flex", "justify-content:center", "align-items:center"
144− ])
145− , _modalLayerConfig_bodyElementConfig = (def :: ElementConfig EventResult t (DomBuilderSpace m))
146− & elementConfig_eventSpec %~ addEventSpecFlags (Proxy :: Proxy (DomBuilderSpace m)) Click (const stopPropagation)
147− & initialAttributes .~ ("style" =: "background-color:white;opacity:1;padding:1em")
148− }
149−
150−instance (MonadQuery t q m, Monad m) => MonadQuery t q (ModalsT t m) where
151− tellQueryIncremental = lift . tellQueryIncremental
152− askQueryResult = lift askQueryResult
153− queryIncremental = lift . queryIncremental
154−
155−withModalLayer :: forall t m a. (Reflex t, MonadFix m, DomBuilder t m, MonadHold t m)
156− => ModalLayerConfig t m
157− -> ModalsT t m a
158− -> m a
159−withModalLayer cfg (ModalsT a) = do
160− rec (result, requests) <- do
161− runRequesterT a modalDone
162− modalDone <- modalInner requests cfg
163− return result
164−
165−modalInner :: forall t m k. (GCompare k, MonadHold t m, MonadFix m, DomBuilder t m)
166− => Event t (DMap k (Compose (ModalsT t m) (Event t)))
167− -> ModalLayerConfig t m
168− -> m (Event t (DMap k Maybe))
169−modalInner rqs' cfg = do
170− rec let rqs = fmap toInsertionsDMap rqs'
171− dones = fmap toDeletionsDMap modalDone
172− (m0, mpatch) <- traverseDMapWithKeyWithAdjust (\_ v -> Compose <$> modalBody cfg v) DMap.empty (rqs <> dones)
173− modal <- fmap (merge . mapKeyValuePairsMonotonic wrapArgs) . incrementalToDynamic <$> holdIncremental m0 mpatch
174− let modalDone = fmap (mapKeyValuePairsMonotonic unwrapArgs) $ switch $ current modal
175− return modalDone
176− where
177− wrapArgs (k :=> v) = WrapArg k :=> getCompose v
178− unwrapArgs :: DSum (WrapArg Maybe k) Identity -> DSum k Maybe
179− unwrapArgs (WrapArg k :=> Identity v) = k :=> v
180− toInsertionsDMap :: DMap k v -> PatchDMap k v
181− toInsertionsDMap = coerce . DMap.map (ComposeMaybe . Just)
182− toDeletionsDMap :: forall k' v v'. DMap k' v -> PatchDMap k' v'
183− toDeletionsDMap = coerce . DMap.map (\(_ :: v a) -> ComposeMaybe (Nothing :: Maybe (v' a)))
184−
185−modalBody :: forall t m a. (MonadHold t m, MonadFix m, DomBuilder t m)
186− => ModalLayerConfig t m
187− -> Compose (ModalsT t m) (Event t) a
188− -> m (Event t (Maybe a))
189−modalBody cfg v = do
190− (overlay, complete) <- element "div" (_modalLayerConfig_backdropElementConfig cfg) $ do
191− fmap snd $ element "div" (_modalLayerConfig_bodyElementConfig cfg) $ do
192− rec (rsps, rqs') <- runRequesterT (unModalsT (getCompose v)) innerDone
193− innerDone <- modalInner rqs' cfg
194− return rsps
195− return $ leftmost
196− [ Just <$> complete
197− , Nothing <$ domEvent Click overlay
198− ]
199−-}
reflex-dom-core/src/Reflex/Dom/Old.hs−1
@@ -1,6 +1,5 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE ConstraintKinds #-}
2{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE ExplicitForAll #-}
4{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleInstances #-}
4{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE MultiParamTypeClasses #-}
5{-# LANGUAGE MultiParamTypeClasses #-}
reflex-dom-core/src/Reflex/Dom/Prerender.hs+253−131
@@ -1,60 +1,60 @@
1{-# LANGUAGE ConstraintKinds #-}
1{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE DefaultSignatures #-}
2+{-# LANGUAGE CPP #-}
3−{-# LANGUAGE EmptyDataDecls #-}
3+{-# LANGUAGE EmptyCase #-}
4{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleContexts #-}
5{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
6{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE FunctionalDependencies #-}
7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7{-# LANGUAGE LambdaCase #-}
8{-# LANGUAGE LambdaCase #-}
8{-# LANGUAGE OverloadedStrings #-}
9{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE MultiParamTypeClasses #-}
10{-# LANGUAGE Rank2Types #-}
10{-# LANGUAGE Rank2Types #-}
11+{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE ScopedTypeVariables #-}
12{-# LANGUAGE ScopedTypeVariables #-}
12−{-# LANGUAGE TypeApplications #-}
13{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeFamilies #-}
14−{-# LANGUAGE TypeSynonymInstances #-}
15{-# LANGUAGE UndecidableInstances #-}
14{-# LANGUAGE UndecidableInstances #-}
15+{-# LANGUAGE UndecidableSuperClasses #-}
16
16
17-- | Render the first widget on the server, and the second on the client.
17-- | Render the first widget on the server, and the second on the client.
18module Reflex.Dom.Prerender
18module Reflex.Dom.Prerender
19 ( Prerender (..)
19 ( Prerender (..)
20− , prerender
21 , prerender_
20 , prerender_
22 , PrerenderClientConstraint
21 , PrerenderClientConstraint
22+ , PrerenderBaseConstraints
23 ) where
23 ) where
24
24
25−import Control.Lens ((&), (.~))
26−import Control.Monad.Primitive (PrimMonad)
25+import Control.Monad.Primitive (PrimMonad(..))
27import Control.Monad.Reader
26import Control.Monad.Reader
28−import Control.Monad.Ref (MonadRef(..))
27+import Control.Monad.Ref (MonadRef(..), MonadAtomicRef(..))
29−import Control.Monad.State.Strict
30−import Data.Default
31−import Data.Foldable (traverse_)
32−import Data.IORef (IORef, modifyIORef', readIORef, newIORef)
28+import Data.IORef (IORef, newIORef)
33−import Data.String (IsString)
29+import Data.Semigroup (Semigroup)
34−import qualified GHCJS.DOM.Element as Element
30+import Data.Text (Text)
35−import qualified GHCJS.DOM.Types as DOM
31+import Data.Void
36−import qualified GHCJS.DOM.Document as Document
37−import qualified Data.Map as Map
38import Foreign.JavaScript.TH
32import Foreign.JavaScript.TH
39import GHCJS.DOM.Types (MonadJSM)
33import GHCJS.DOM.Types (MonadJSM)
40import Reflex hiding (askEvents)
34import Reflex hiding (askEvents)
41import Reflex.Dom.Builder.Class
35import Reflex.Dom.Builder.Class
36+import Reflex.Dom.Builder.Hydratable
37+import Reflex.Dom.Builder.Immediate
42import Reflex.Dom.Builder.InputDisabled
38import Reflex.Dom.Builder.InputDisabled
43−import Reflex.Dom.Builder.Immediate (ImmediateDomBuilderT, SupportsImmediateDomBuilder, insertBefore, deleteBetweenExclusive, runImmediateDomBuilderT, ImmediateDomBuilderEnv(..), GhcjsDomSpace)
44−import Reflex.Dom.Builder.Hydration
45import Reflex.Dom.Builder.Static
39import Reflex.Dom.Builder.Static
46import Reflex.Host.Class
40import 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
47
48−type PrerenderClientConstraint t m =
48+type PrerenderClientConstraint js t m =
49 ( DomBuilder t m
49 ( DomBuilder t m
50 , DomBuilderSpace m ~ GhcjsDomSpace
50 , DomBuilderSpace m ~ GhcjsDomSpace
51+ , DomRenderHook t m
51 , HasDocument m
52 , HasDocument m
52 , TriggerEvent t m
53 , TriggerEvent t m
53− , Prerender t m
54− , PrerenderBaseConstraints t m
54+ , PrerenderBaseConstraints js t m
55 )
55 )
56
56
57−type PrerenderBaseConstraints t m =
57+type PrerenderBaseConstraints js t m =
58 ( HasJSContext (Performable m)
58 ( HasJSContext (Performable m)
59 , HasJSContext m
59 , HasJSContext m
60 , MonadFix m
60 , MonadFix m
@@ -70,135 +70,257 @@ type PrerenderBaseConstraints t m =
70 , PrimMonad m
70 , PrimMonad m
71 , Ref (Performable m) ~ IORef
71 , Ref (Performable m) ~ IORef
72 , Ref m ~ IORef
72 , Ref m ~ IORef
73+ , HasJS js m
74+ , HasJS js (Performable m)
73 )
75 )
74
76
75−-- | Render the first widget on the server, and the second on the client. The
76−-- hydration builder will run *both* widgets, updating the result dynamic at
77−-- switchover time.
78−prerender
79− :: (Functor m, Prerender t m)
80− => m a -> ((PrerenderClientConstraint t (Client m)) => Client m a) -> m (Dynamic t a)
81−prerender server client = snd <$> prerenderImpl ((,) () <$> server) client
82−
83-- | Render the first widget on the server, and the second on the client. The
77-- | Render the first widget on the server, and the second on the client. The
84-- hydration builder will run *both* widgets.
78-- hydration builder will run *both* widgets.
85prerender_
79prerender_
86− :: (Functor m, Reflex t, Prerender t m)
80+ :: (Functor m, Reflex t, Prerender js t m)
87− => m () -> ((PrerenderClientConstraint t (Client m)) => Client m ()) -> m ()
81+ => m () -> Client m () -> m ()
88−prerender_ server client = void $ prerenderImpl ((,) () <$> server) client
82+prerender_ server client = void $ prerender server client
89
83
90−class Prerender t m | m -> t where
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
91 -- | Monad in which the client widget is built
85 -- | Monad in which the client widget is built
92 type Client m :: * -> *
86 type Client m :: * -> *
93− -- | This function should be considered internal: it should only be used where
87+ -- | Render the first widget on the server, and the second on the client. The
94− -- the resultant 'Maybe' isn't used to change what is built in the DOM, or
88+ -- hydration builder will run *both* widgets, updating the result dynamic at
95− -- hydration will fail.
89+ -- switchover time.
96− prerenderImpl :: m (a, b) -> ((PrerenderClientConstraint t (Client m)) => Client m b) -> m (Maybe a, Dynamic t b)
90+ prerender :: m a -> Client m a -> m (Dynamic t a)
97
91
98−instance (Adjustable t m, PrerenderBaseConstraints t m) => Prerender t (ImmediateDomBuilderT t m) where
92+instance (ReflexHost t, Adjustable t m, PrerenderBaseConstraints js t m) => Prerender js t (HydrationDomBuilderT GhcjsDomSpace t m) where
99− type Client (ImmediateDomBuilderT t m) = ImmediateDomBuilderT t m
93+ type Client (HydrationDomBuilderT GhcjsDomSpace t m) = HydrationDomBuilderT GhcjsDomSpace t m
100− prerenderImpl _ client = (,) Nothing . pure <$> client
94+ prerender _ client = pure <$> client
101
95
102−instance (Adjustable t m, PrerenderBaseConstraints t m, ReflexHost t) => Prerender t (HydrationDomBuilderT t m) where
96+instance (Adjustable t m, PrerenderBaseConstraints js t m, ReflexHost t) => Prerender js t (HydrationDomBuilderT HydrationDomSpace t m) where
103− -- | PostBuildT is needed here because we delay running the immediate builder
97+ -- | PostBuildT is needed here because we delay running the client builder
104 -- until after switchover, at which point the postBuild of @m@ has already fired
98 -- until after switchover, at which point the postBuild of @m@ has already fired
105− type Client (HydrationDomBuilderT t m) = PostBuildT t (ImmediateDomBuilderT t m)
99+ type Client (HydrationDomBuilderT HydrationDomSpace t m) = PostBuildT t (HydrationDomBuilderT GhcjsDomSpace t m)
106 -- | Runs the server widget up until switchover, then replaces it with the
100 -- | Runs the server widget up until switchover, then replaces it with the
107 -- client widget.
101 -- client widget.
108− prerenderImpl server client = do
102+ prerender server client = do
109 env <- HydrationDomBuilderT ask
103 env <- HydrationDomBuilderT ask
110 events <- askEvents
104 events <- askEvents
111 doc <- askDocument
105 doc <- askDocument
106+ serverDf <- Document.createDocumentFragment doc -- server dom should not be mounted in the window's doc in hydration
112 df <- Document.createDocumentFragment doc
107 df <- Document.createDocumentFragment doc
113 unreadyChildren <- HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_unreadyChildren
108 unreadyChildren <- HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_unreadyChildren
114− let immediateEnv = ImmediateDomBuilderEnv
109+ immediateMode <- liftIO $ newIORef HydrationMode_Immediate
115− { _immediateDomBuilderEnv_document = doc
110+ delayed <- liftIO $ newIORef $ pure ()
116− , _immediateDomBuilderEnv_parent = DOM.toNode df
111+ let clientEnv = env
117− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
112+ { _hydrationDomBuilderEnv_parent = Left $ DOM.toNode df
118− , _immediateDomBuilderEnv_commitAction = pure ()
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
119 }
123 }
124+ a0 <- lift $ runHydrationDomBuilderT server serverEnv events
120− (b', trigger) <- newTriggerEvent
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
121− addHydrationStep $ do
130+ HydrationMode_Hydrating -> addHydrationStep $ do
122− liftIO . trigger <=< lift $ runImmediateDomBuilderT (runPostBuildT client $ void b') immediateEnv events
131+ liftIO . trigger <=< lift $ runHydrationDomBuilderT (runPostBuildT client $ void a') clientEnv events
123− insertBefore df =<< deleteToPrerenderEnd
132+ insertBefore df =<< deleteToPrerenderEnd doc
124− ((a, b0), _) <- lift $ runHydrationDomBuilderT server env events
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
125− (,) (Just a) <$> holdDyn b0 b'
210+ holdDyn _ _ = unrunnable
126−
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+
127−instance SupportsStaticDomBuilder t m => Prerender t (StaticDomBuilderT t m) where
236+instance (SupportsStaticDomBuilder t m) => Prerender JS' t (StaticDomBuilderT t m) where
128− type Client (StaticDomBuilderT t m) = ImmediateDomBuilderT t m
237+ type Client (StaticDomBuilderT t m) = UnrunnableT JS' t m
129− prerenderImpl server _ = do
238+ prerender server _ = do
130− _ <- element "script" (def & initialAttributes .~ Map.singleton "type" startMarker) $ pure ()
239+ _ <- commentNode $ CommentNodeConfig startMarker Nothing
131− (a, b) <- server
240+ a <- server
132− _ <- element "script" (def & initialAttributes .~ Map.singleton "type" endMarker) $ pure ()
241+ _ <- commentNode $ CommentNodeConfig endMarker Nothing
133− pure (Just a, pure b)
242+ pure $ pure a
134−
243+
135−instance (Prerender t m, Monad m) => Prerender t (ReaderT r m) where
244+instance (Prerender js t m, Monad m) => Prerender js t (ReaderT r m) where
136− type Client (ReaderT r m) = Client m
245+ type Client (ReaderT r m) = ReaderT r (Client m)
137− prerenderImpl server client = do
246+ prerender server client = do
138 r <- ask
247 r <- ask
139− lift $ prerenderImpl (runReaderT server r) client
248+ lift $ prerender (runReaderT server r) (runReaderT client r)
140−
249+
141−instance (Prerender t m, Monad m, Functor (Client m)) => Prerender t (StateT s m) where
250+instance (Prerender js t m, Monad m, Reflex t, MonadFix m, Monoid w) => Prerender js t (DynamicWriterT t w m) where
142− type Client (StateT s m) = Client m
251+ type Client (DynamicWriterT t w m) = DynamicWriterT t w (Client m)
143− prerenderImpl server client = do
252+ prerender server client = do
144− s <- get
253+ x <- lift $ prerender (runDynamicWriterT server) (runDynamicWriterT client)
145− (ma, evt) <- lift $ prerenderImpl
254+ let (a, w') = splitDynPure x
146− (do ((a, b), s') <- runStateT server s; pure ((a, s'), b))
255+ w = join w'
147− client
256+ tellDyn w
148− traverse_ (put . snd) ma
149− pure (fst <$> ma, evt)
257+ pure a
150−
258+
151−instance (Prerender t m, Monad m, Functor (Client m)) => Prerender t (DynamicWriterT t w m) where
259+instance (Prerender js t m, Monad m, Reflex t, Semigroup w) => Prerender js t (EventWriterT t w m) where
152− type Client (DynamicWriterT t w m) = Client m
260+ type Client (EventWriterT t w m) = EventWriterT t w (Client m)
153− prerenderImpl (DynamicWriterT server) client = DynamicWriterT $ prerenderImpl server client
261+ prerender server client = do
154−
262+ x <- lift $ prerender (runEventWriterT server) (runEventWriterT client)
155−instance (Prerender t m, Monad m, Functor (Client m)) => Prerender t (EventWriterT t w m) where
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
156− type Client (EventWriterT t w m) = Client m
281+ type Client (QueryT t q m) = QueryT t q (Client m)
157− prerenderImpl (EventWriterT server) client = EventWriterT $ prerenderImpl server client
282+ prerender server client = mdo
158−
283+ result <- queryDyn query
159−instance (Prerender t m, Monad m, Functor (Client m)) => Prerender t (RequesterT t request response m) where
284+ x <- lift $ prerender (runQueryT server result) (runQueryT client result)
160− type Client (RequesterT t request response m) = Client m
285+ let (a, inc) = splitDynPure x
161− prerenderImpl (RequesterT server) client = RequesterT $ prerenderImpl server client
286+ query = incrementalToDynamic =<< inc -- Can we avoid the incrementalToDynamic?
162−
287+ pure a
288+
163−instance (Prerender t m, Monad m, Functor (Client m)) => Prerender t (QueryT t q m) where
289+instance (Prerender js t m, Monad m) => Prerender js t (InputDisabledT m) where
164− type Client (QueryT t q m) = Client m
290+ type Client (InputDisabledT m) = InputDisabledT (Client m)
165− prerenderImpl (QueryT server) client = QueryT $ prerenderImpl server client
291+ prerender (InputDisabledT server) (InputDisabledT client) = InputDisabledT $ prerender server client
166−
292+
167−instance (Prerender t m, Monad m) => Prerender t (InputDisabledT m) where
293+instance (Prerender js t m, Monad m) => Prerender js t (HydratableT m) where
168− type Client (InputDisabledT m) = Client m
294+ type Client (HydratableT m) = HydratableT (Client m)
169− prerenderImpl (InputDisabledT server) client = InputDisabledT $ prerenderImpl server client
295+ prerender (HydratableT server) (HydratableT client) = HydratableT $ prerender server client
170−
296+
171−instance (Prerender t m, Monad m) => Prerender t (PostBuildT t m) where
297+instance (Prerender js t m, Monad m, ReflexHost t) => Prerender js t (PostBuildT t m) where
172− type Client (PostBuildT t m) = Client m
298+ type Client (PostBuildT t m) = PostBuildT t (Client m)
173− prerenderImpl (PostBuildT server) client = PostBuildT $ prerenderImpl server client
299+ prerender server client = PostBuildT $ do
174−
300+ pb <- ask
301+ lift $ prerender (runPostBuildT server pb) (runPostBuildT client pb)
302+
175−startMarker, endMarker :: IsString s => s
303+startMarker, endMarker :: Text
176startMarker = "prerender/start"
304startMarker = "prerender/start"
177endMarker = "prerender/end"
305endMarker = "prerender/end"
178
306
179−deleteToPrerenderEnd :: (MonadIO m, MonadJSM m) => HydrationRunnerT t m DOM.Element
307+deleteToPrerenderEnd :: (MonadIO m, MonadJSM m, Reflex t, MonadFix m) => DOM.Document -> HydrationRunnerT t m DOM.Comment
180−deleteToPrerenderEnd = do
308+deleteToPrerenderEnd doc = do
181− depth <- liftIO $ newIORef (0 :: Int)
309+ startNode <- hydrateComment doc startMarker Nothing
182− startNode <- hydrateNode (\e -> do
310+ let go (n :: Int) lastNode = Node.getNextSibling lastNode >>= \case
183− n :: DOM.JSString <- Element.getTagName e
311+ Nothing -> do
184− mt :: Maybe DOM.JSString <- Element.getAttribute e ("type" :: DOM.JSString)
312+ c <- Document.createComment doc endMarker
185− pure $ n == "SCRIPT" && mt == Just startMarker) DOM.Element
313+ insertAfterPreviousNode c
186− endNode <- hydrateNode (\e -> do
314+ pure c
187− n :: DOM.JSString <- Element.getTagName e
315+ Just node -> DOM.castTo DOM.Comment node >>= \case
188− attrCheck <- Element.getAttribute e ("type" :: DOM.JSString) >>= \case
316+ Nothing -> go n node
189− Just (t :: DOM.JSString)
317+ Just c -> Node.getTextContentUnchecked c >>= \case
190− | t == startMarker -> do
318+ t | t == startMarker -> go (succ n) node
191− liftIO $ modifyIORef' depth succ
192− pure False
193− | t == endMarker -> do
319+ | t == endMarker -> case n of
194− d <- liftIO $ readIORef depth
195− if d == 0
196− then pure True
320+ 0 -> pure c
197− else do
321+ _ -> go (pred n) node
198− liftIO $ modifyIORef' depth pred
322+ | otherwise -> go n node
199− pure False
323+ endNode <- go 0 $ DOM.toNode startNode
200− _ -> pure False
201− pure $ n == "SCRIPT" && attrCheck) DOM.Element
202 deleteBetweenExclusive startNode endNode
324 deleteBetweenExclusive startNode endNode
203− setPreviousNode $ Just $ DOM.toNode endNode -- TODO probably not necessary
325+ setPreviousNode $ Just $ DOM.toNode endNode
204 pure endNode
326 pure endNode
reflex-dom-core/src/Reflex/Dom/Specializations.hsdeleted−61
@@ -1,61 +0,0 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE GADTs #-}
3−{-# LANGUAGE Rank2Types #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−module Reflex.Dom.Specializations where
6−
7−import Data.Text (Text)
8−import Reflex.Spider
9−import Reflex.Class
10−import Foreign.JavaScript.TH
11−import Reflex.PerformEvent.Base
12−import Reflex.PostBuild.Base
13−import Reflex.Requester.Base
14−import Reflex.TriggerEvent.Base
15−import Reflex.Dom.Builder.Class
16−import Reflex.Dom.Builder.Immediate
17−import Data.Functor.Identity
18−import Data.Functor.Compose
19−import Data.IORef
20−import GHCJS.DOM.Types (JSM)
21−import Data.IntMap.Strict (IntMap)
22−import qualified Data.IntMap.Strict as IntMap
23−
24−import qualified GHCJS.DOM.Element as DOM
25−import qualified GHCJS.DOM.Types as DOM
26−
27−{-# SPECIALIZE makeElement :: forall er a. Text -> ElementConfig er (SpiderTimeline Global) GhcjsDomSpace -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) a -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) ((Element er GhcjsDomSpace (SpiderTimeline Global), a), DOM.Element) #-}
28−
29−{-# SPECIALIZE wrap :: forall er. RawElement GhcjsDomSpace -> RawElementConfig er (SpiderTimeline Global) GhcjsDomSpace -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) (Element er GhcjsDomSpace (SpiderTimeline Global)) #-}
30−
31−{-# SPECIALIZE mapIntMapWithAdjustImpl :: forall v v'.
32− ( (IntMap.Key -> (Event (SpiderTimeline Global) (), v) -> (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) v')
33− -> IntMap (Event (SpiderTimeline Global) (), v)
34− -> Event (SpiderTimeline Global) (PatchIntMap (Event (SpiderTimeline Global) (), v))
35− -> (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (IntMap v', Event (SpiderTimeline Global) (PatchIntMap v'))
36− )
37− -> (IntMap.Key -> v -> PostBuildT (SpiderTimeline Global) (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) v')
38− -> IntMap v
39− -> Event (SpiderTimeline Global) (PatchIntMap v)
40− -> PostBuildT (SpiderTimeline Global) (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (IntMap v', Event (SpiderTimeline Global) (PatchIntMap v'))
41− #-}
42−
43−{-# SPECIALIZE append :: DOM.Node -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) () #-}
44−
45−{-# SPECIALIZE drawChildUpdate :: forall k v' a. ImmediateDomBuilderEnv (SpiderTimeline Global) -> (IORef (ChildReadyState k) -> JSM ()) -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) (v' a) -> RequesterT (SpiderTimeline Global) JSM Identity (TriggerEventT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v' a) #-}
46−
47−{-# SPECIALIZE traverseIntMapWithKeyWithAdjust' :: forall v v'. (IntMap.Key -> v -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) v') -> IntMap v -> Event (SpiderTimeline Global) (PatchIntMap v) -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) (IntMap v', Event (SpiderTimeline Global) (PatchIntMap v')) #-}
48−
49−{-# SPECIALIZE hoistTraverseIntMapWithKeyWithAdjust :: forall v v'.
50− ( (IntMap.Key -> v -> RequesterT (SpiderTimeline Global) JSM Identity (TriggerEventT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
51− -> IntMap v
52− -> Event (SpiderTimeline Global) (PatchIntMap v)
53− -> RequesterT (SpiderTimeline Global) JSM Identity (TriggerEventT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (IntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'), Event (SpiderTimeline Global) (PatchIntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')))
54− )
55− -> (PatchIntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> IntMap (IORef ChildReadyStateInt) -> IO (IntMap (IORef ChildReadyStateInt)))
56− -> (IORef (IntMap DOM.Text) -> IORef DOM.Text -> PatchIntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> JSM ())
57− -> (IntMap.Key -> v -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) v')
58− -> IntMap v
59− -> Event (SpiderTimeline Global) (PatchIntMap v)
60− -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) (IntMap v', Event (SpiderTimeline Global) (PatchIntMap v'))
61− #-}
reflex-dom-core/src/Reflex/Dom/WebSocket.hs+12−4
@@ -55,6 +55,7 @@ import Data.Text
55import Data.Text.Encoding
55import Data.Text.Encoding
56import Foreign.JavaScript.Utils (jsonDecode)
56import Foreign.JavaScript.Utils (jsonDecode)
57import GHCJS.DOM.Types (runJSM, askJSM, MonadJSM, liftJSM, JSM)
57import GHCJS.DOM.Types (runJSM, askJSM, MonadJSM, liftJSM, JSM)
58+import GHCJS.DOM.WebSocket (getReadyState)
58import GHCJS.Marshal
59import GHCJS.Marshal
59import qualified Language.Javascript.JSaddle.Monad as JS (catch)
60import qualified Language.Javascript.JSaddle.Monad as JS (catch)
60
61
@@ -101,7 +102,7 @@ webSocket' url config onRawMessage = do
101 liftIO $ triggerEClose args
102 liftIO $ triggerEClose args
102 _ <- liftIO $ atomically $ tryTakeTMVar isOpen
103 _ <- liftIO $ atomically $ tryTakeTMVar isOpen
103 liftIO $ writeIORef currentSocketRef Nothing
104 liftIO $ writeIORef currentSocketRef Nothing
104− when (_webSocketConfig_reconnect config) $ do
105+ when (_webSocketConfig_reconnect config) $ forkJSM $ do
105 liftIO $ threadDelay 1000000
106 liftIO $ threadDelay 1000000
106 start
107 start
107 start = do
108 start = do
@@ -127,9 +128,11 @@ webSocket' url config onRawMessage = do
127 mws <- liftIO $ readIORef currentSocketRef
128 mws <- liftIO $ readIORef currentSocketRef
128 success <- case mws of
129 success <- case mws of
129 Nothing -> return False
130 Nothing -> return False
131+ Just ws -> flip runJSM ctx $ do
132+ rs <- getReadyState $ unWebSocket ws
133+ if rs == 1
130− Just ws -> runJSM ((webSocketSend ws payload >> return True)
134+ then (webSocketSend ws payload >> return True) `JS.catch` (\(_ :: SomeException) -> return False)
131− `JS.catch`
135+ else return False
132− (\(_ :: SomeException) -> return False)) ctx
133 unless success $ atomically $ unGetTQueue payloadQueue payload
136 unless success $ atomically $ unGetTQueue payloadQueue payload
134 return $ RawWebSocket eRecv eOpen eError eClose
137 return $ RawWebSocket eRecv eOpen eError eClose
135
138
@@ -141,6 +144,11 @@ jsonWebSocket url cfg = do
141 ws <- textWebSocket url $ cfg { _webSocketConfig_send = fmap (decodeUtf8 . toStrict . encode) <$> _webSocketConfig_send cfg }
144 ws <- textWebSocket url $ cfg { _webSocketConfig_send = fmap (decodeUtf8 . toStrict . encode) <$> _webSocketConfig_send cfg }
142 return ws { _webSocket_recv = jsonDecode . textToJSString <$> _webSocket_recv ws }
145 return ws { _webSocket_recv = jsonDecode . textToJSString <$> _webSocket_recv ws }
143
146
147+forkJSM :: JSM () -> JSM ()
148+forkJSM a = do
149+ jsm <- askJSM
150+ void $ liftIO $ forkIO $ runJSM a jsm
151+
144#ifdef USE_TEMPLATE_HASKELL
152#ifdef USE_TEMPLATE_HASKELL
145makeLensesWith (lensRules & simpleLenses .~ True) ''WebSocketConfig
153makeLensesWith (lensRules & simpleLenses .~ True) ''WebSocketConfig
146makeLensesWith (lensRules & simpleLenses .~ True) ''RawWebSocket
154makeLensesWith (lensRules & simpleLenses .~ True) ''RawWebSocket
reflex-dom-core/src/Reflex/Dom/WebSocket/Foreign.hs+37−23
@@ -12,7 +12,6 @@ module Reflex.Dom.WebSocket.Foreign
12
12
13import Prelude hiding (all, concat, concatMap, div, mapM, mapM_, sequence, span)
13import Prelude hiding (all, concat, concatMap, div, mapM, mapM_, sequence, span)
14
14
15−import Control.Monad.Reader
16import Data.Bifoldable
15import Data.Bifoldable
17import Data.ByteString (ByteString)
16import Data.ByteString (ByteString)
18import qualified Data.ByteString.Lazy as LBS
17import qualified Data.ByteString.Lazy as LBS
@@ -20,12 +19,11 @@ import Data.Text (Text)
20import Data.Text.Encoding
19import Data.Text.Encoding
21import Foreign.JavaScript.Utils (bsFromMutableArrayBuffer, bsToArrayBuffer)
20import Foreign.JavaScript.Utils (bsFromMutableArrayBuffer, bsToArrayBuffer)
22import GHCJS.DOM.CloseEvent
21import GHCJS.DOM.CloseEvent
23−import GHCJS.DOM.EventM (on)
24import GHCJS.DOM.MessageEvent
22import GHCJS.DOM.MessageEvent
25−import GHCJS.DOM.Types (JSM, JSVal, liftJSM, fromJSValUnchecked)
23+import GHCJS.DOM.Types (JSM, JSVal, liftJSM, fromJSValUnchecked, WebSocket(..))
26−import GHCJS.DOM.WebSocket (WebSocket)
27import qualified GHCJS.DOM.WebSocket as DOM
24import qualified GHCJS.DOM.WebSocket as DOM
28import GHCJS.Foreign (JSType(..), jsTypeOf)
25import GHCJS.Foreign (JSType(..), jsTypeOf)
26+import Language.Javascript.JSaddle (fun, eval, toJSVal, call)
29import Language.Javascript.JSaddle.Helper (mutableArrayBufferFromJSVal)
27import Language.Javascript.JSaddle.Helper (mutableArrayBufferFromJSVal)
30import Language.Javascript.JSaddle.Types (ghcjsPure)
28import Language.Javascript.JSaddle.Types (ghcjsPure)
31
29
@@ -64,25 +62,41 @@ newWebSocket
64 -> ((Bool, Word, Text) -> JSM ()) -- onclose
62 -> ((Bool, Word, Text) -> JSM ()) -- onclose
65 -> JSM JSWebSocket
63 -> JSM JSWebSocket
66newWebSocket _ url protocols onMessage onOpen onError onClose = do
64newWebSocket _ url protocols onMessage onOpen onError onClose = do
67− ws <- DOM.newWebSocket url protocols
65+ let onOpenWrapped = fun $ \_ _ _ -> onOpen
68− DOM.setBinaryType ws "arraybuffer"
66+ onErrorWrapped = fun $ \_ _ _ -> onError
69− _ <- on ws DOM.open $ liftJSM onOpen
67+ onCloseWrapped = fun $ \_ _ (e:_) -> do
70− _ <- on ws DOM.error $ liftJSM onError
68+ let e' = CloseEvent e
71− _ <- on ws DOM.closeEvent $ do
72− e <- ask
73− wasClean <- getWasClean e
69+ wasClean <- getWasClean e'
74− code <- getCode e
70+ code <- getCode e'
75− reason <- getReason e
71+ reason <- getReason e'
76− liftJSM $ onClose (wasClean, code, reason)
72+ liftJSM $ onClose (wasClean, code, reason)
77− _ <- on ws DOM.message $ do
73+ onMessageWrapped = fun $ \_ _ (e:_) -> do
78− e <- ask
74+ let e' = MessageEvent e
79− d <- getData e
75+ d <- getData e'
80− liftJSM $ ghcjsPure (jsTypeOf d) >>= \case
76+ liftJSM $ ghcjsPure (jsTypeOf d) >>= \case
81− String -> onMessage $ Right d
77+ String -> onMessage $ Right d
82− _ -> do
78+ _ -> do
83− ab <- mutableArrayBufferFromJSVal d
79+ ab <- mutableArrayBufferFromJSVal d
84− bsFromMutableArrayBuffer ab >>= onMessage . Left
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']
85− return $ JSWebSocket ws
99+ return $ JSWebSocket $ WebSocket ws
86
100
87onBSMessage :: Either ByteString JSVal -> JSM ByteString
101onBSMessage :: Either ByteString JSVal -> JSM ByteString
88onBSMessage = either return $ fmap encodeUtf8 . fromJSValUnchecked
102onBSMessage = either return $ fmap encodeUtf8 . fromJSValUnchecked
reflex-dom-core/src/Reflex/Dom/Widget/Basic.hs+33−43
@@ -10,11 +10,9 @@
10{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
11{-# LANGUAGE TypeFamilies #-}
11{-# LANGUAGE TypeFamilies #-}
12module Reflex.Dom.Widget.Basic
12module Reflex.Dom.Widget.Basic
13− ( partitionMapBySetLT
13+ (
14− , ChildResult (..)
15−
16 -- * Displaying Values
14 -- * Displaying Values
17− , text
15+ text
18 , dynText
16 , dynText
19 , comment
17 , comment
20 , dynComment
18 , dynComment
@@ -59,8 +57,10 @@ module Reflex.Dom.Widget.Basic
59 , module Data.Map.Misc
57 , module Data.Map.Misc
60 , module Reflex.Collection
58 , module Reflex.Collection
61 , module Reflex.Workflow
59 , module Reflex.Workflow
60+ , partitionMapBySetLT
62 ) where
61 ) where
63
62
63+import Reflex.Adjustable.Class
64import Reflex.Class
64import Reflex.Class
65import Reflex.Collection
65import Reflex.Collection
66import Reflex.Dom.Builder.Class
66import Reflex.Dom.Builder.Class
@@ -95,6 +95,7 @@ import Prelude hiding (mapM, mapM_, sequence, sequence_)
95-- No empty pieces will be included in the output.
95-- No empty pieces will be included in the output.
96
96
97--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
97--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." #-}
98partitionMapBySetLT :: forall k v. Ord k => Set k -> Map k v -> Map (Either k ()) (Map k v)
99partitionMapBySetLT :: forall k v. Ord k => Set k -> Map k v -> Map (Either k ()) (Map k v)
99partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
100partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
100 where go :: [k] -> Map k v -> [(Either k (), Map k v)]
101 where go :: [k] -> Map k v -> [(Either k (), Map k v)]
@@ -107,8 +108,7 @@ partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
107 then go t geq
108 then go t geq
108 else (Left h, lt) : go t geq
109 else (Left h, lt) : go t geq
109
110
110−newtype ChildResult t k a = ChildResult { unChildResult :: (a, Event t (Map k (Maybe (ChildResult t k a)))) }
111+{-# INLINABLE text #-}
111−
112text :: DomBuilder t m => Text -> m ()
112text :: DomBuilder t m => Text -> m ()
113text t = void $ textNode $ def & textNodeConfig_initialContents .~ t
113text t = void $ textNode $ def & textNodeConfig_initialContents .~ t
114
114
@@ -145,63 +145,73 @@ button t = do
145
145
146--TODO: Should this be renamed to 'widgetView' for consistency with 'widgetHold'?
146--TODO: Should this be renamed to 'widgetView' for consistency with 'widgetHold'?
147-- | Given a Dynamic of widget-creating actions, create a widget that is recreated whenever the Dynamic updates.
147-- | Given a Dynamic of widget-creating actions, create a widget that is recreated whenever the Dynamic updates.
148−-- The returned Event of widget results occurs when the Dynamic does.
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.
149−-- 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').
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').
150−dyn :: (DomBuilder t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
152+dyn :: (Adjustable t m, NotReady t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
151dyn = networkView
153dyn = networkView
152
154
153-- | Like 'dyn' but discards result.
155-- | Like 'dyn' but discards result.
154−dyn_ :: (DomBuilder t m, PostBuild t m) => Dynamic t (m a) -> m ()
156+dyn_ :: (Adjustable t m, NotReady t m, PostBuild t m) => Dynamic t (m a) -> m ()
155dyn_ = void . dyn
157dyn_ = void . dyn
156
158
157-- | Given an initial widget and an Event of widget-creating actions, create a widget that is recreated whenever the Event fires.
159-- | Given an initial widget and an Event of widget-creating actions, create a widget that is recreated whenever the Event fires.
158-- The returned Dynamic of widget results occurs when the Event does.
160-- The returned Dynamic of widget results occurs when the Event does.
159−-- Note: Often, the type 'a' is an Event, in which case the return value is a Dynamic-of-Events that would typically be flattened.
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').
160−widgetHold :: (DomBuilder t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
162+widgetHold :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m (Dynamic t a)
161widgetHold = networkHold
163widgetHold = networkHold
162
164
163-- | Like 'widgetHold' but discards result.
165-- | Like 'widgetHold' but discards result.
164−widgetHold_ :: (DomBuilder t m, MonadHold t m) => m a -> Event t (m a) -> m ()
166+widgetHold_ :: (Adjustable t m, MonadHold t m) => m a -> Event t (m a) -> m ()
165widgetHold_ z = void . widgetHold z
167widgetHold_ z = void . widgetHold z
166
168
167-- | Create a DOM element
169-- | Create a DOM element
170+--
168−-- > el "div" (text "Hello World")
171+-- >>> el "div" (text "Hello World")
169-- <div>Hello World</div>
172-- <div>Hello World</div>
170{-# INLINABLE el #-}
173{-# INLINABLE el #-}
171el :: forall t m a. DomBuilder t m => Text -> m a -> m a
174el :: forall t m a. DomBuilder t m => Text -> m a -> m a
172el elementTag child = snd <$> el' elementTag child
175el elementTag child = snd <$> el' elementTag child
173
176
174-- | Create a DOM element with attributes
177-- | Create a DOM element with attributes
178+--
175−-- > elAttr "a" ("href" =: "http://google.com") (text "Google!")
179+-- >>> elAttr "a" ("href" =: "https://reflex-frp.org") (text "Reflex-FRP!")
176−-- <a href="http://google.com">Google!</a>
180+-- <a href="https://reflex-frp.org">Reflex-FRP!</a>
177{-# INLINABLE elAttr #-}
181{-# INLINABLE elAttr #-}
178elAttr :: forall t m a. DomBuilder t m => Text -> Map Text Text -> m a -> m a
182elAttr :: forall t m a. DomBuilder t m => Text -> Map Text Text -> m a -> m a
179elAttr elementTag attrs child = snd <$> elAttr' elementTag attrs child
183elAttr elementTag attrs child = snd <$> elAttr' elementTag attrs child
180
184
181-- | Create a DOM element with classes
185-- | Create a DOM element with classes
186+--
182−-- > elClass "div" "row" (return ())
187+-- >>> elClass "div" "row" (return ())
183-- <div class="row"></div>
188-- <div class="row"></div>
184{-# INLINABLE elClass #-}
189{-# INLINABLE elClass #-}
185elClass :: forall t m a. DomBuilder t m => Text -> Text -> m a -> m a
190elClass :: forall t m a. DomBuilder t m => Text -> Text -> m a -> m a
186elClass elementTag c child = snd <$> elClass' elementTag c child
191elClass elementTag c child = snd <$> elClass' elementTag c child
187
192
188-- | Create a DOM element with Dynamic Attributes
193-- | Create a DOM element with Dynamic Attributes
194+--
189−-- > elClass "div" (constDyn ("class" =: "row")) (return ())
195+-- >>> elClass "div" (constDyn ("class" =: "row")) (return ())
190-- <div class="row"></div>
196-- <div class="row"></div>
191{-# INLINABLE elDynAttr #-}
197{-# INLINABLE elDynAttr #-}
192elDynAttr :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t (Map Text Text) -> m a -> m a
198elDynAttr :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t (Map Text Text) -> m a -> m a
193elDynAttr elementTag attrs child = snd <$> elDynAttr' elementTag attrs child
199elDynAttr elementTag attrs child = snd <$> elDynAttr' elementTag attrs child
194
200
195-- | Create a DOM element with a Dynamic Class
201-- | Create a DOM element with a Dynamic Class
202+--
196−-- > elDynClass "div" (constDyn "row") (return ())
203+-- >>> elDynClass "div" (constDyn "row") (return ())
197-- <div class="row"></div>
204-- <div class="row"></div>
198{-# INLINABLE elDynClass #-}
205{-# INLINABLE elDynClass #-}
199elDynClass :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t Text -> m a -> m a
206elDynClass :: forall t m a. (DomBuilder t m, PostBuild t m) => Text -> Dynamic t Text -> m a -> m a
200elDynClass elementTag c child = snd <$> elDynClass' elementTag c child
207elDynClass elementTag c child = snd <$> elDynClass' elementTag c child
201
208
202-- | Create a DOM element and return the element
209-- | Create a DOM element and return the element
210+--
211+-- @
203−-- > do (e, _) <- el' "div" (text "Click")
212+-- do (e, _) <- el' "div" (text "Click")
204−-- > return $ domEvent Click e
213+-- return $ domEvent Click e
214+-- @
205{-# INLINABLE el' #-}
215{-# INLINABLE el' #-}
206el' :: forall t m a. DomBuilder t m => Text -> m a -> m (Element EventResult (DomBuilderSpace m) t, a)
216el' :: forall t m a. DomBuilder t m => Text -> m a -> m (Element EventResult (DomBuilderSpace m) t, a)
207el' elementTag = element elementTag def
217el' elementTag = element elementTag def
@@ -261,28 +271,6 @@ dynamicAttributesToModifyAttributesWithInitial attrs0 d = do
261 return $ if Map.null p then Nothing else Just p
271 return $ if Map.null p then Nothing else Just p
262 return modificationsNeeded
272 return modificationsNeeded
263
273
264−--------------------------------------------------------------------------------
265−-- Copied and pasted from Reflex.Widget.Class
266−--------------------------------------------------------------------------------
267−
268−{-
269−schedulePostBuild x = performEvent_ . (x <$) =<< getPostBuild
270−
271−elDynHtml' :: DomBuilder t m => Text -> Dynamic t Text -> m (El t)
272−elDynHtml' elementTag html = do
273− e <- buildEmptyElement elementTag (Map.empty :: Map Text Text)
274− schedulePostBuild $ setInnerHTML e . Just =<< sample (current html)
275− performEvent_ $ fmap (setInnerHTML e . Just) $ updated html
276− wrapElement defaultDomEventHandler e
277−
278−elDynHtmlAttr' :: DomBuilder t m => Text -> Map Text Text -> Dynamic t Text -> m (El t)
279−elDynHtmlAttr' elementTag attrs html = do
280− e <- buildEmptyElement elementTag attrs
281− schedulePostBuild $ setInnerHTML e . Just =<< sample (current html)
282− performEvent_ $ fmap (setInnerHTML e . Just) $ updated html
283− wrapElement defaultDomEventHandler e
284−-}
285−
286newtype Link t
274newtype Link t
287 = Link { _link_clicked :: Event t ()
275 = Link { _link_clicked :: Event t ()
288 }
276 }
@@ -306,6 +294,7 @@ dtdd h w = do
306blank :: forall m. Monad m => m ()
294blank :: forall m. Monad m => m ()
307blank = return ()
295blank = return ()
308
296
297+-- TODO: Move to an example project.
309-- | A widget to display a table with static columns and dynamic rows.
298-- | A widget to display a table with static columns and dynamic rows.
310tableDynAttr :: forall t m r k v. (Ord k, DomBuilder t m, MonadHold t m, PostBuild t m, MonadFix m)
299tableDynAttr :: forall t m r k v. (Ord k, DomBuilder t m, MonadHold t m, PostBuild t m, MonadFix m)
311 => Text -- ^ Class applied to <table> element
300 => Text -- ^ Class applied to <table> element
@@ -322,6 +311,7 @@ tableDynAttr klass cols dRows rowAttrs = elAttr "div" (Map.singleton "style" "zo
322 dAttrs <- rowAttrs k
311 dAttrs <- rowAttrs k
323 elDynAttr' "tr" dAttrs $ mapM (\x -> el "td" $ snd x k r) cols)
312 elDynAttr' "tr" dAttrs $ mapM (\x -> el "td" $ snd x k r) cols)
324
313
314+-- TODO: Move to an example project.
325-- | A widget to construct a tabbed view that shows only one of its child widgets at a time.
315-- | A widget to construct a tabbed view that shows only one of its child widgets at a time.
326-- Creates a header bar containing a <ul> with one <li> per child; clicking a <li> displays
316-- Creates a header bar containing a <ul> with one <li> per child; clicking a <li> displays
327-- the corresponding child and hides all others.
317-- the corresponding child and hides all others.
reflex-dom-core/src/Reflex/Dom/Widget/Input.hs+12−52
@@ -54,6 +54,7 @@ import qualified Text.Read as T
54import qualified GHCJS.DOM.Event as Event
54import qualified GHCJS.DOM.Event as Event
55import qualified GHCJS.DOM.HTMLInputElement as Input
55import qualified GHCJS.DOM.HTMLInputElement as Input
56
56
57+{-# DEPRECATED TextInput, _textInput_element, TextInputConfig, textInput "Use 'inputElement' directly" #-}
57data TextInput t
58data TextInput t
58 = TextInput { _textInput_value :: Dynamic t Text
59 = TextInput { _textInput_value :: Dynamic t Text
59 , _textInput_input :: Event t Text
60 , _textInput_input :: Event t Text
@@ -161,6 +162,7 @@ rangeInput (RangeInputConfig initial eSetValue dAttrs) = do
161 , _rangeInput_element = _inputElement_raw i
162 , _rangeInput_element = _inputElement_raw i
162 }
163 }
163
164
165+{-# DEPRECATED TextAreaConfig, TextArea, textArea "Use 'textAreaElement' directly" #-}
164data TextAreaConfig t
166data TextAreaConfig t
165 = TextAreaConfig { _textAreaConfig_initialValue :: Text
167 = TextAreaConfig { _textAreaConfig_initialValue :: Text
166 , _textAreaConfig_setValue :: Event t Text
168 , _textAreaConfig_setValue :: Event t Text
@@ -198,6 +200,7 @@ textArea (TextAreaConfig initial eSet attrs) = do
198 , _textArea_element = _textAreaElement_raw i
200 , _textArea_element = _textAreaElement_raw i
199 }
201 }
200
202
203+{-# DEPRECATED CheckboxConfig, Checkbox, checkbox, checkboxView, CheckboxViewEventResultType, regularToCheckboxViewEventType, CheckboxViewEventResult "Use 'inputElement' directly" #-}
201data CheckboxConfig t
204data CheckboxConfig t
202 = CheckboxConfig { _checkboxConfig_setValue :: Event t Bool
205 = CheckboxConfig { _checkboxConfig_setValue :: Event t Bool
203 , _checkboxConfig_attributes :: Dynamic t (Map Text Text)
206 , _checkboxConfig_attributes :: Dynamic t (Map Text Text)
@@ -287,7 +290,7 @@ regularToCheckboxViewEventType en r = case en of
287
290
288newtype CheckboxViewEventResult en = CheckboxViewEventResult { unCheckboxViewEventResult :: CheckboxViewEventResultType en }
291newtype CheckboxViewEventResult en = CheckboxViewEventResult { unCheckboxViewEventResult :: CheckboxViewEventResultType en }
289
292
290−--TODO
293+-- | Create a view only checkbox
291{-# INLINABLE checkboxView #-}
294{-# INLINABLE checkboxView #-}
292checkboxView :: 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)
295checkboxView :: 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)
293checkboxView dAttrs dValue = do
296checkboxView dAttrs dValue = do
@@ -321,6 +324,7 @@ checkboxView dAttrs dValue = do
321 i <- inputElement inputElementConfig
324 i <- inputElement inputElementConfig
322 return $ unCheckboxViewEventResult <$> select (_element_events $ _inputElement_element i) (WrapArg Click)
325 return $ unCheckboxViewEventResult <$> select (_element_events $ _inputElement_element i) (WrapArg Click)
323
326
327+{-# DEPRECATED FileInput, FileInputConfig, fileInput "Use 'inputElement' directly" #-}
324data FileInput d t
328data FileInput d t
325 = FileInput { _fileInput_value :: Dynamic t [File]
329 = FileInput { _fileInput_value :: Dynamic t [File]
326 , _fileInput_element :: RawInputElement d
330 , _fileInput_element :: RawInputElement d
@@ -346,16 +350,10 @@ fileInput config = do
346 & modifyAttributes .~ fmap mapKeysToAttributeName modifyAttrs
350 & modifyAttributes .~ fmap mapKeysToAttributeName modifyAttrs
347 & elementConfig_eventSpec . ghcjsEventSpec_filters .~ filters
351 & elementConfig_eventSpec . ghcjsEventSpec_filters .~ filters
348 cfg = (def :: InputElementConfig EventResult t (DomBuilderSpace m)) & inputElementConfig_elementConfig .~ elCfg
352 cfg = (def :: InputElementConfig EventResult t (DomBuilderSpace m)) & inputElementConfig_elementConfig .~ elCfg
349− eRaw <- inputElement cfg
353+ input <- inputElement cfg
350− let e = _inputElement_raw eRaw
351− eChange <- wrapDomEvent e (`on` Events.change) $ do
352− files <- Input.getFilesUnchecked e
353− len <- FileList.getLength files
354− mapM (fmap (fromMaybe (error "fileInput: fileList.item returned null")) . FileList.item files) [0 .. len-1]
355− dValue <- holdDyn [] eChange
356 return $ FileInput
354 return $ FileInput
357− { _fileInput_value = dValue
355+ { _fileInput_value = _inputElement_files input
358− , _fileInput_element = e
356+ , _fileInput_element = _inputElement_raw input
359 }
357 }
360
358
361data Dropdown t k
359data Dropdown t k
@@ -439,9 +437,12 @@ dropdown k0 options (DropdownConfig setK attrs) = do
439 let xs = fmap (\(ix, (k, v)) -> ((ix, k), ((ix, k), v))) $ zip [0::Int ..] $ Map.toList os
437 let xs = fmap (\(ix, (k, v)) -> ((ix, k), ((ix, k), v))) $ zip [0::Int ..] $ Map.toList os
440 in (Map.fromList $ map snd xs, Bimap.fromList $ map fst xs)
438 in (Map.fromList $ map snd xs, Bimap.fromList $ map fst xs)
441 modifyAttrs <- dynamicAttributesToModifyAttributes attrs
439 modifyAttrs <- dynamicAttributesToModifyAttributes attrs
440+ postBuild <- getPostBuild
441+ let setSelection = attachPromptlyDynWithMaybe (flip Bimap.lookupR) ixKeys $
442+ leftmost [setK, k0 <$ postBuild]
442 let cfg = def
443 let cfg = def
443 & selectElementConfig_elementConfig . elementConfig_modifyAttributes .~ fmap mapKeysToAttributeName modifyAttrs
444 & selectElementConfig_elementConfig . elementConfig_modifyAttributes .~ fmap mapKeysToAttributeName modifyAttrs
444− & selectElementConfig_setValue .~ fmap (T.pack . show) (attachPromptlyDynWithMaybe (flip Bimap.lookupR) ixKeys setK)
445+ & selectElementConfig_setValue .~ fmap (T.pack . show) setSelection
445 (eRaw, _) <- selectElement cfg $ listWithKey indexedOptions $ \(ix, k) v -> do
446 (eRaw, _) <- selectElement cfg $ listWithKey indexedOptions $ \(ix, k) v -> do
446 let optionAttrs = fmap (\dk -> "value" =: T.pack (show ix) <> if dk == k then "selected" =: "selected" else mempty) defaultKey
447 let optionAttrs = fmap (\dk -> "value" =: T.pack (show ix) <> if dk == k then "selected" =: "selected" else mempty) defaultKey
447 elDynAttr "option" optionAttrs $ dynText v
448 elDynAttr "option" optionAttrs $ dynText v
@@ -628,9 +629,6 @@ instance HasAttributes (FileInputConfig t) where
628 type Attrs (FileInputConfig t) = Dynamic t (Map Text Text)
629 type Attrs (FileInputConfig t) = Dynamic t (Map Text Text)
629 attributes = fileInputConfig_attributes
630 attributes = fileInputConfig_attributes
630
631
631−class HasSetValue a where
632− type SetValue a :: *
633− setValue :: Lens' a (SetValue a)
634
632
635instance HasSetValue (TextAreaConfig t) where
633instance HasSetValue (TextAreaConfig t) where
636 type SetValue (TextAreaConfig t) = Event t Text
634 type SetValue (TextAreaConfig t) = Event t Text
@@ -687,41 +685,3 @@ instance HasValue (Dropdown t k) where
687instance HasValue (Checkbox t) where
685instance HasValue (Checkbox t) where
688 type Value (Checkbox t) = Dynamic t Bool
686 type Value (Checkbox t) = Dynamic t Bool
689 value = _checkbox_value
687 value = _checkbox_value
690−
691−{-
692−type family Controller sm t a where
693− Controller Edit t a = (a, Event t a) -- Initial value and setter
694− Controller View t a = Dynamic t a -- Value (always)
695−
696−type family Output sm t a where
697− Output Edit t a = Dynamic t a -- Value (always)
698− Output View t a = Event t a -- Requested changes
699−
700−data CheckboxConfig sm t
701− = CheckboxConfig { _checkbox_input :: Controller sm t Bool
702− , _checkbox_attributes :: Attributes
703− }
704−
705−instance Reflex t => Default (CheckboxConfig Edit t) where
706− def = CheckboxConfig (False, never) mempty
707−
708−data Checkbox sm t
709− = Checkbox { _checkbox_output :: Output sm t Bool
710− }
711−
712−data StateMode = Edit | View
713−
714−--TODO: There must be a more generic way to get this witness and allow us to case on the type-level StateMode
715−data StateModeWitness (sm :: StateMode) where
716− EditWitness :: StateModeWitness Edit
717− ViewWitness :: StateModeWitness View
718−
719−class HasStateModeWitness (sm :: StateMode) where
720− stateModeWitness :: StateModeWitness sm
721−
722−instance HasStateModeWitness Edit where
723− stateModeWitness = EditWitness
724−
725−instance HasStateModeWitness View where
726− stateModeWitness = ViewWitness
727−-}
reflex-dom-core/src/Reflex/Dom/Widget/Lazy.hs+3−3
@@ -108,7 +108,7 @@ virtualList heightPx rowPx maxIndex i0 setI keyToIndex items0 itemsUpdate itemBu
108 uniqWindow <- holdUniqDyn window
108 uniqWindow <- holdUniqDyn window
109 return (uniqWindow, result)
109 return (uniqWindow, result)
110 where
110 where
111− 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
112 mkViewport h = toStyleAttr $ "overflow" =: "auto" <> "position" =: "absolute" <>
112 mkViewport h = toStyleAttr $ "overflow" =: "auto" <> "position" =: "absolute" <>
113 "left" =: "0" <> "right" =: "0" <> "height" =: (T.pack (show h) <> "px")
113 "left" =: "0" <> "right" =: "0" <> "height" =: (T.pack (show h) <> "px")
114 mkContainer h = toStyleAttr $ "position" =: "relative" <> "height" =: (T.pack (show h) <> "px")
114 mkContainer h = toStyleAttr $ "position" =: "relative" <> "height" =: (T.pack (show h) <> "px")
@@ -117,7 +117,7 @@ virtualList heightPx rowPx maxIndex i0 setI keyToIndex items0 itemsUpdate itemBu
117 "overflow" =: "hidden" <>
117 "overflow" =: "hidden" <>
118 "position" =: "relative"
118 "position" =: "relative"
119 mkRow k = toStyleAttr $ "height" =: (T.pack (show rowPx) <> "px") <>
119 mkRow k = toStyleAttr $ "height" =: (T.pack (show rowPx) <> "px") <>
120− "top" =: ((<>"px") $ T.pack $ show $ keyToIndex k * rowPx) <>
120+ "top" =: (<> "px") (T.pack $ show $ keyToIndex k * rowPx) <>
121 "position" =: "absolute" <>
121 "position" =: "absolute" <>
122 "width" =: "100%"
122 "width" =: "100%"
123 findWindow sizeIncrement windowSize startingPosition =
123 findWindow sizeIncrement windowSize startingPosition =
@@ -142,7 +142,7 @@ virtualListBuffered buffer heightPx rowPx maxIndex i0 setI keyToIndex items0 ite
142 (win, m) <- virtualList heightPx rowPx maxIndex i0 setI keyToIndex items0 itemsUpdate itemBuilder
142 (win, m) <- virtualList heightPx rowPx maxIndex i0 setI keyToIndex items0 itemsUpdate itemBuilder
143 pb <- getPostBuild
143 pb <- getPostBuild
144 let extendWin o l = (max 0 (o - l * (buffer-1) `div` 2), l * buffer)
144 let extendWin o l = (max 0 (o - l * (buffer-1) `div` 2), l * buffer)
145− rec let winHitEdge = fmapMaybe id $ attachWith (\(oldOffset, oldLimit) (winOffset, winLimit) ->
145+ rec let winHitEdge = attachWithMaybe (\(oldOffset, oldLimit) (winOffset, winLimit) ->
146 if winOffset > oldOffset && winOffset + winLimit < oldOffset + oldLimit
146 if winOffset > oldOffset && winOffset + winLimit < oldOffset + oldLimit
147 then Nothing
147 then Nothing
148 else Just (extendWin winOffset winLimit)) (current winBuffered) (updated win)
148 else Just (extendWin winOffset winLimit)) (current winBuffered) (updated win)
reflex-dom-core/src/Reflex/Dom/Widget/Resize.hs+9−5
@@ -32,20 +32,24 @@ import GHCJS.DOM.HTMLElement (getOffsetWidth, getOffsetHeight)
32import qualified GHCJS.DOM.Types as DOM
32import qualified GHCJS.DOM.Types as DOM
33
33
34-- | A widget that wraps the given widget in a div and fires an event when resized.
34-- | 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
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; }
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)
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)
37resizeDetector = resizeDetectorWithStyle ""
41resizeDetector = resizeDetectorWithStyle ""
38
42
39resizeDetectorWithStyle :: (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)
43resizeDetectorWithStyle :: (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)
40 => Text -- ^ A css style string. Warning: It should not contain the "position" style attribute.
44 => Text -- ^ A css style string. Warning: It should not contain the "position" style attribute.
41 -> m a -- ^ The embedded widget
45 -> 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
43resizeDetectorWithStyle styleString = resizeDetectorWithAttrs ("style" =: styleString)
47resizeDetectorWithStyle styleString = resizeDetectorWithAttrs ("style" =: styleString)
44
48
45resizeDetectorWithAttrs :: (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)
49resizeDetectorWithAttrs :: (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)
46 => Map Text Text -- ^ A map of attributes. Warning: It should not modify the "position" style attribute.
50 => Map Text Text -- ^ A map of attributes. Warning: It should not modify the "position" style attribute.
47 -> m a -- ^ The embedded widget
51 -> 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
49resizeDetectorWithAttrs attrs w = do
53resizeDetectorWithAttrs attrs w = do
50 let childStyle = "position: absolute; left: 0; top: 0;"
54 let childStyle = "position: absolute; left: 0; top: 0;"
51 containerAttrs = "style" =: "position: absolute; left: 0; top: 0; right: 0; bottom: 0; overflow: scroll; z-index: -1; visibility: hidden;"
55 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
87 size0 <- performEvent $ fmap (const $ liftJSM reset) pb
91 size0 <- performEvent $ fmap (const $ liftJSM reset) pb
88 rec resize <- performEventAsync $ fmap (\d cb -> (liftIO . cb) =<< liftJSM (resetIfChanged d)) $ tag (current dimensions) $ leftmost [expandScroll, shrinkScroll]
92 rec resize <- performEventAsync $ fmap (\d cb -> (liftIO . cb) =<< liftJSM (resetIfChanged d)) $ tag (current dimensions) $ leftmost [expandScroll, shrinkScroll]
89 dimensions <- holdDyn (Nothing, Nothing) $ leftmost [ size0, fmapMaybe id resize ]
93 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+9−7
@@ -159,6 +159,8 @@ import Data.Aeson.Text
159import Data.Aeson.Encode
159import Data.Aeson.Encode
160#endif
160#endif
161import qualified Data.ByteString.Lazy as BL
161import qualified Data.ByteString.Lazy as BL
162+import Data.CaseInsensitive (CI)
163+import qualified Data.CaseInsensitive as CI
162import Data.Default
164import Data.Default
163import qualified Data.List as L
165import qualified Data.List as L
164import Data.Map (Map)
166import Data.Map (Map)
@@ -198,12 +200,12 @@ data XhrResponse
198 , _xhrResponse_statusText :: Text
200 , _xhrResponse_statusText :: Text
199 , _xhrResponse_response :: Maybe XhrResponseBody
201 , _xhrResponse_response :: Maybe XhrResponseBody
200 , _xhrResponse_responseText :: Maybe Text
202 , _xhrResponse_responseText :: Maybe Text
201− , _xhrResponse_headers :: Map Text Text
203+ , _xhrResponse_headers :: Map (CI Text) Text
202 }
204 }
203 deriving (Typeable)
205 deriving (Typeable)
204
206
205data XhrResponseHeaders =
207data 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
207 | AllHeaders -- ^ Parse all headers from the XHR Response
209 | AllHeaders -- ^ Parse all headers from the XHR Response
208 deriving (Show, Read, Eq, Ord, Typeable)
210 deriving (Show, Read, Eq, Ord, Typeable)
209
211
@@ -215,7 +217,7 @@ _xhrResponse_body :: XhrResponse -> Maybe Text
215_xhrResponse_body = _xhrResponse_responseText
217_xhrResponse_body = _xhrResponse_responseText
216
218
217{-# DEPRECATED xhrResponse_body "Use xhrResponse_response or xhrResponse_responseText instead." #-}
219{-# 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)
219xhrResponse_body = lens _xhrResponse_responseText (\r t -> r { _xhrResponse_responseText = t })
221xhrResponse_body = lens _xhrResponse_responseText (\r t -> r { _xhrResponse_responseText = t })
220
222
221instance a ~ () => Default (XhrRequestConfig a) where
223instance a ~ () => Default (XhrRequestConfig a) where
@@ -275,7 +277,7 @@ newXMLHttpRequestWithError req cb = do
275 AllHeaders -> parseAllHeadersString <$>
277 AllHeaders -> parseAllHeadersString <$>
276 xmlHttpRequestGetAllResponseHeaders xhr
278 xmlHttpRequestGetAllResponseHeaders xhr
277 OnlyHeaders xs -> traverse (xmlHttpRequestGetResponseHeader xhr)
279 OnlyHeaders xs -> traverse (xmlHttpRequestGetResponseHeader xhr)
278− (Map.fromSet id xs)
280+ (Map.fromSet CI.original xs)
279 _ <- liftJSM $ cb $ Right
281 _ <- liftJSM $ cb $ Right
280 XhrResponse { _xhrResponse_status = status
282 XhrResponse { _xhrResponse_status = status
281 , _xhrResponse_statusText = statusText
283 , _xhrResponse_statusText = statusText
@@ -288,10 +290,10 @@ newXMLHttpRequestWithError req cb = do
288 return ()
290 return ()
289 return xhr
291 return xhr
290
292
291−parseAllHeadersString :: Text -> Map Text Text
293+parseAllHeadersString :: Text -> Map (CI Text) Text
292parseAllHeadersString s = Map.fromList $ fmap (stripBoth . T.span (/=':')) $
294parseAllHeadersString s = Map.fromList $ fmap (stripBoth . T.span (/=':')) $
293 L.dropWhileEnd T.null $ T.splitOn (T.pack "\r\n") s
295 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)
295
297
296newXMLHttpRequest :: (HasJSContext m, MonadJSM m, IsXhrPayload a) => XhrRequest a -> (XhrResponse -> JSM ()) -> m XMLHttpRequest
298newXMLHttpRequest :: (HasJSContext m, MonadJSM m, IsXhrPayload a) => XhrRequest a -> (XhrResponse -> JSM ()) -> m XMLHttpRequest
297newXMLHttpRequest req cb = newXMLHttpRequestWithError req $ mapM_ cb
299newXMLHttpRequest req cb = newXMLHttpRequestWithError req $ mapM_ cb
@@ -444,7 +446,7 @@ xhrResponse_responseText :: Lens' XhrResponse (Maybe Text)
444xhrResponse_responseText f (XhrResponse x1 x2 x3 x4 x5) = (\y -> XhrResponse x1 x2 x3 y x5) <$> f x4
446xhrResponse_responseText f (XhrResponse x1 x2 x3 x4 x5) = (\y -> XhrResponse x1 x2 x3 y x5) <$> f x4
445{-# INLINE xhrResponse_responseText #-}
447{-# INLINE xhrResponse_responseText #-}
446
448
447−xhrResponse_headers :: Lens' XhrResponse (Map Text Text)
449+xhrResponse_headers :: Lens' XhrResponse (Map (CI Text) Text)
448xhrResponse_headers f (XhrResponse x1 x2 x3 x4 x5) = (\y -> XhrResponse x1 x2 x3 x4 y) <$> f x5
450xhrResponse_headers f (XhrResponse x1 x2 x3 x4 x5) = (\y -> XhrResponse x1 x2 x3 x4 y) <$> f x5
449{-# INLINE xhrResponse_headers #-}
451{-# INLINE xhrResponse_headers #-}
450
452
reflex-dom-core/src/Reflex/Dom/Xhr/Foreign.hs+2−3
@@ -1,7 +1,6 @@
1{-# LANGUAGE FlexibleInstances #-}
1{-# LANGUAGE FlexibleInstances #-}
2{-# LANGUAGE JavaScriptFFI #-}
2{-# LANGUAGE JavaScriptFFI #-}
3{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE TypeSynonymInstances #-}
5
4
6module Reflex.Dom.Xhr.Foreign (
5module Reflex.Dom.Xhr.Foreign (
7 XMLHttpRequest
6 XMLHttpRequest
@@ -16,7 +15,7 @@ import Data.Text (Text)
16import Data.ByteString (ByteString)
15import Data.ByteString (ByteString)
17import Foreign.JavaScript.Utils (bsFromMutableArrayBuffer, bsToArrayBuffer)
16import Foreign.JavaScript.Utils (bsFromMutableArrayBuffer, bsToArrayBuffer)
18import GHCJS.DOM.Enums
17import GHCJS.DOM.Enums
19−import GHCJS.DOM.EventM (EventM, on)
18+import GHCJS.DOM.EventM (EventM, on, onSync)
20import GHCJS.DOM.EventTarget (dispatchEvent)
19import GHCJS.DOM.EventTarget (dispatchEvent)
21import GHCJS.DOM.Types (MonadJSM, ToJSString, FormData, Document, Blob (..), ArrayBuffer (..), JSVal, JSM, IsEvent, XMLHttpRequestProgressEvent, ProgressEvent, Event, XMLHttpRequestUpload, FromJSString, ArrayBufferView (..), liftJSM, castTo)
20import GHCJS.DOM.Types (MonadJSM, ToJSString, FormData, Document, Blob (..), ArrayBuffer (..), JSVal, JSM, IsEvent, XMLHttpRequestProgressEvent, ProgressEvent, Event, XMLHttpRequestUpload, FromJSString, ArrayBufferView (..), liftJSM, castTo)
22import GHCJS.DOM.XMLHttpRequest
21import GHCJS.DOM.XMLHttpRequest
@@ -115,7 +114,7 @@ xmlHttpRequestOntimeout :: XMLHttpRequest -> EventM XMLHttpRequest ProgressEvent
115xmlHttpRequestOntimeout = (`on` timeout)
114xmlHttpRequestOntimeout = (`on` timeout)
116
115
117xmlHttpRequestOnreadystatechange :: XMLHttpRequest -> EventM XMLHttpRequest Event () -> JSM (JSM ())
116xmlHttpRequestOnreadystatechange :: XMLHttpRequest -> EventM XMLHttpRequest Event () -> JSM (JSM ())
118−xmlHttpRequestOnreadystatechange = (`on` readyStateChange)
117+xmlHttpRequestOnreadystatechange = (`onSync` readyStateChange)
119
118
120xmlHttpRequestSetTimeout :: MonadJSM m => XMLHttpRequest -> Word -> m ()
119xmlHttpRequestSetTimeout :: MonadJSM m => XMLHttpRequest -> Word -> m ()
121xmlHttpRequestSetTimeout = setTimeout
120xmlHttpRequestSetTimeout = 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+22−13
@@ -8,17 +8,26 @@ import Control.Exception
8import Control.Monad
8import Control.Monad
9import Control.Monad.IO.Class
9import Control.Monad.IO.Class
10import Data.Int
10import Data.Int
11−import GHC.Stats
11+import Data.Text as T
12import Language.Javascript.JSaddle.Warp
12import Language.Javascript.JSaddle.Warp
13import Reflex.Dom.Core
13import Reflex.Dom.Core
14import Reflex.Time
14import Reflex.Time
15import System.Exit
15import System.Exit
16−import System.IO.Temp
17−import System.Linux.Namespaces
18import System.Mem
16import System.Mem
19−import System.Posix
20import System.Process
17import System.Process
21
18
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+
22-- In initial testing, the minimum live bytes count was 233128 and maximum was
31-- In initial testing, the minimum live bytes count was 233128 and maximum was
23-- 363712. Going over the maximum means the test has actually failed - we
32-- 363712. Going over the maximum means the test has actually failed - we
24-- probably have a memory leak; going under the minimum doesn't indicate a
33-- probably have a memory leak; going under the minimum doesn't indicate a
@@ -38,14 +47,14 @@ failureLimit = 0
38
47
39main :: IO ()
48main :: IO ()
40main = do
49main = do
41− uid <- getEffectiveUserID
42− handle (\(_ :: IOError) -> return ()) $ do -- If we run into an exception with sandboxing, just don't bother
50+ handle (\(_ :: IOError) -> return ()) $ unshareNetwork -- If we run into an exception with sandboxing, just don't bother
43− unshare [User, Network]
51+ withSandboxedChromeFlags True $ \chromeFlags -> do
44− writeUserMappings Nothing [UserMapping 0 uid 1]
45− callCommand "ip link set lo up ; ip addr"
46− mainThread <- myThreadId
52+ mainThread <- myThreadId
47− withSystemTempDirectory "reflex-dom-core_test_gc" $ \tmp -> do
53+ browserProcess <- spawnCommand $ mconcat
48− browserProcess <- spawnCommand $ "echo 'Starting Chromium' ; chromium --headless --disable-gpu --no-sandbox --remote-debugging-port=9222 --user-data-dir=" ++ tmp ++ " http://localhost:3911 ; echo 'Chromium exited'"
54+ [ "echo 'Starting Chromium' ; chromium "
55+ , unpack $ T.unwords chromeFlags
56+ , " http://localhost:3911 ; echo 'Chromium exited'"
57+ ]
49 let finishTest result = do
58 let finishTest result = do
50 interruptProcessGroupOf browserProcess
59 interruptProcessGroupOf browserProcess
51 throwTo mainThread result
60 throwTo mainThread result
@@ -63,7 +72,7 @@ main = do
63 let f (!failures, !n) = liftIO $ if n < 3000
72 let f (!failures, !n) = liftIO $ if n < 3000
64 then do performMajorGC
73 then do performMajorGC
65 threadDelay 5000 -- Wait a bit to allow requestAnimationFrame to call its callback sometimes; this value was experimentally determined
74 threadDelay 5000 -- Wait a bit to allow requestAnimationFrame to call its callback sometimes; this value was experimentally determined
66− gcStats <- getGCStats
75+ gcStats <- getRTSStats
67 print $ currentBytesUsed gcStats
76 print $ currentBytesUsed gcStats
68 when (currentBytesUsed gcStats < minBytesAllowed) $ do
77 when (currentBytesUsed gcStats < minBytesAllowed) $ do
69 putStrLn "FAILED: currentBytesUsed < minBytesAllowed"
78 putStrLn "FAILED: currentBytesUsed < minBytesAllowed"
reflex-dom-core/test/hlint.hs+3−1
@@ -1,4 +1,4 @@
1−import Language.Haskell.HLint3 (hlint)
1+import Language.Haskell.HLint (hlint)
2import System.Exit (exitFailure, exitSuccess)
2import System.Exit (exitFailure, exitSuccess)
3
3
4main :: IO ()
4main :: IO ()
@@ -16,9 +16,11 @@ main = do
16 , "--ignore=Use unless"
16 , "--ignore=Use unless"
17 , "--ignore=Use if"
17 , "--ignore=Use if"
18 , "--ignore=Use fewer imports"
18 , "--ignore=Use fewer imports"
19+ , "--ignore=Use list comprehension"
19 , "--ignore=Unnecessary hiding" -- Interferes with cross-version compatibility
20 , "--ignore=Unnecessary hiding" -- Interferes with cross-version compatibility
20 , "--ignore=Use <$>"
21 , "--ignore=Use <$>"
21 , "--ignore=Reduce duplication" --TODO: Re-enable this test
22 , "--ignore=Reduce duplication" --TODO: Re-enable this test
23+ , "--ignore=Use list comprehension"
22 , "--cpp-define=USE_TEMPLATE_HASKELL"
24 , "--cpp-define=USE_TEMPLATE_HASKELL"
23 ]
25 ]
24 if null ideas then exitSuccess else exitFailure
26 if null ideas then exitSuccess else exitFailure
reflex-dom-core/test/hydration.hs+1365−726
@@ -1,75 +1,122 @@
1{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE BangPatterns #-}
2{-# LANGUAGE ConstraintKinds #-}
2{-# LANGUAGE ConstraintKinds #-}
3−{-# LANGUAGE CPP #-}
4{-# LANGUAGE FlexibleContexts #-}
3{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE GADTs #-}
5{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6{-# LANGUAGE LambdaCase #-}
7{-# LANGUAGE LambdaCase #-}
7{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE MultiParamTypeClasses #-}
8{-# LANGUAGE OverloadedStrings #-}
9{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE PolyKinds #-}
9{-# LANGUAGE RankNTypes #-}
11{-# LANGUAGE RankNTypes #-}
10{-# LANGUAGE RecursiveDo #-}
12{-# LANGUAGE RecursiveDo #-}
11{-# LANGUAGE ScopedTypeVariables #-}
13{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
12{-# LANGUAGE TemplateHaskell #-}
15{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TupleSections #-}
13{-# LANGUAGE TypeApplications #-}
17{-# LANGUAGE TypeApplications #-}
14{-# LANGUAGE TypeFamilies #-}
18{-# LANGUAGE TypeFamilies #-}
19+{-# LANGUAGE UndecidableInstances #-}
15
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)
16import Control.Concurrent
32import Control.Concurrent
33+import qualified Control.Concurrent.Async as Async
34+import Control.Lens.Operators
17−import Control.Monad
35+import Control.Monad hiding (fail)
18import Control.Monad.Catch
36import Control.Monad.Catch
37+import Control.Monad.Fail
19import Control.Monad.Fix
38import Control.Monad.Fix
20import Control.Monad.IO.Class
39import Control.Monad.IO.Class
21−import Data.Constraint (Dict(..))
40+import Control.Monad.Ref
22import Data.Constraint.Extras
41import Data.Constraint.Extras
42+import Data.Constraint.Extras.TH
23import Data.Dependent.Map (DMap)
43import Data.Dependent.Map (DMap)
24−import Data.Dependent.Sum (DSum(..), (==>), EqTag(..), ShowTag(..))
44+import Data.Dependent.Sum (DSum(..), (==>))
25−import Data.Foldable (traverse_)
26import Data.Functor.Identity
45import Data.Functor.Identity
27import Data.Functor.Misc
46import Data.Functor.Misc
28import Data.GADT.Compare.TH
47import Data.GADT.Compare.TH
29import Data.GADT.Show.TH
48import Data.GADT.Show.TH
30−import Data.IORef
49+import Data.IORef (IORef)
31−import Data.Map (Map)
50+import Data.List (sort)
32−import Data.Maybe (fromMaybe, fromJust)
51+import Data.Maybe
33import Data.Proxy
52import Data.Proxy
34import Data.Text (Text)
53import Data.Text (Text)
35import Language.Javascript.JSaddle (syncPoint, liftJSM)
54import Language.Javascript.JSaddle (syncPoint, liftJSM)
36import Language.Javascript.JSaddle.Warp
55import Language.Javascript.JSaddle.Warp
37import Network.HTTP.Types (status200)
56import Network.HTTP.Types (status200)
57+import Network.Socket
38import Network.Wai
58import Network.Wai
39import Network.WebSockets
59import Network.WebSockets
40−import Reflex.Dom.Builder.Immediate (GhcjsDomSpace)
41import Reflex.Dom.Core
60import Reflex.Dom.Core
61+import Reflex.Dom.Widget.Input (dropdown)
62+import Reflex.Patch.DMapWithMove
42import System.Directory
63import System.Directory
64+import System.Environment
43import System.IO (stderr)
65import System.IO (stderr)
44import System.IO.Silently
66import System.IO.Silently
45import System.IO.Temp
67import System.IO.Temp
46import System.Process
68import System.Process
47−import System.Timeout
69+import System.Which (staticWhich)
48−import Test.HUnit
70+import qualified Test.HUnit as HUnit
49−import Test.Hspec
71+import qualified Test.Hspec as H
50−import Test.WebDriver (WD)
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(..))
51
77
52import qualified Data.ByteString.Lazy as LBS
78import qualified Data.ByteString.Lazy as LBS
53import qualified Data.Dependent.Map as DMap
79import qualified Data.Dependent.Map as DMap
80+import qualified Data.IntMap as IntMap
54import qualified Data.Text as T
81import qualified Data.Text as T
55import qualified Data.Text.Encoding as TE
82import qualified Data.Text.Encoding as TE
56−import qualified GHCJS.DOM as DOM
57−import qualified GHCJS.DOM.Document as Document
58−import qualified GHCJS.DOM.Element as Element
59−import qualified GHCJS.DOM.EventM as EventM
60import qualified GHCJS.DOM.File as File
83import qualified GHCJS.DOM.File as File
61−import qualified GHCJS.DOM.GlobalEventHandlers as Events
62−import qualified GHCJS.DOM.Node as Node
63−import qualified GHCJS.DOM.Types as DOM
64import qualified Network.Wai.Handler.Warp as Warp
84import qualified Network.Wai.Handler.Warp as Warp
65import qualified System.FilePath as FilePath
85import qualified System.FilePath as FilePath
66import qualified Test.WebDriver as WD
86import 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
67
101
68−testTimeLimit :: Int
102+-- TODO Remove orphan
69−testTimeLimit = 3 * 1000 * 1000
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
70
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+
71−chromeConfig :: WD.WDConfig
118+chromeConfig :: Text -> [Text] -> WD.WDConfig
72−chromeConfig = WD.useBrowser (WD.chrome { WD.chromeBinary = Just "/run/current-system/sw/bin/chromium", WD.chromeOptions = ["--headless"]}) WD.defaultConfig
119+chromeConfig fp flags = WD.useBrowser (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags }) WD.defaultConfig
73
120
74keyMap :: DMap DKey Identity
121keyMap :: DMap DKey Identity
75keyMap = DMap.fromList
122keyMap = DMap.fromList
@@ -82,12 +129,6 @@ data DKey a where
82 Key_Char :: DKey Char
129 Key_Char :: DKey Char
83 Key_Bool :: DKey Bool
130 Key_Bool :: DKey Bool
84
131
85−instance ArgDict DKey where
86− type ConstraintsFor DKey c = (c Int, c Char, c Bool)
87− argDict = \case
88− Key_Int -> Dict
89− Key_Char -> Dict
90− Key_Bool -> Dict
91
132
92textKey :: DKey a -> Text
133textKey :: DKey a -> Text
93textKey = \case
134textKey = \case
@@ -95,37 +136,55 @@ textKey = \case
95 Key_Char -> "Key_Char"
136 Key_Char -> "Key_Char"
96 Key_Bool -> "Key_Bool"
137 Key_Bool -> "Key_Bool"
97
138
139+deriveArgDict ''DKey
98deriveGEq ''DKey
140deriveGEq ''DKey
99deriveGCompare ''DKey
141deriveGCompare ''DKey
100deriveGShow ''DKey
142deriveGShow ''DKey
101
143
102−instance ShowTag DKey Identity where
144+deriving instance MonadFail WD
103− showTaggedPrec = \case
104− Key_Int -> showsPrec
105− Key_Char -> showsPrec
106− Key_Bool -> showsPrec
107−
108−instance EqTag DKey Identity where
109− eqTagged Key_Int Key_Int = (==)
110− eqTagged Key_Char Key_Char = (==)
111− eqTagged Key_Bool Key_Bool = (==)
112
145
113main :: IO ()
146main :: IO ()
114−main = hspec $ beforeAll startSeleniumServer $ do
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
115
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
116− describe "text" $ do
175+ session' "text" $ do
117− it "works" $ do
176+ it "works" $ runWD $ do
118 testWidgetStatic (checkBodyText "hello world") $ do
177 testWidgetStatic (checkBodyText "hello world") $ do
119 text "hello world"
178 text "hello world"
120− it "works with postBuild" $ do
179+ it "works with postBuild" $ runWD $ do
121 testWidgetStatic (checkBodyText "pb") $ do
180 testWidgetStatic (checkBodyText "pb") $ do
122 pb <- getPostBuild
181 pb <- getPostBuild
123 void $ textNode $ TextNodeConfig "" $ Just $ "pb" <$ pb
182 void $ textNode $ TextNodeConfig "" $ Just $ "pb" <$ pb
124− it "works for adjacent text nodes" $ do
183+ it "works for adjacent text nodes" $ runWD $ do
125 testWidgetStatic (checkBodyText "hello world") $ do
184 testWidgetStatic (checkBodyText "hello world") $ do
126 text "hello "
185 text "hello "
127 text "world"
186 text "world"
128− it "works for empty adjacent text nodes" $ do
187+ it "works for empty adjacent text nodes" $ runWD $ do
129 testWidgetStatic (checkBodyText "hello world") $ do
188 testWidgetStatic (checkBodyText "hello world") $ do
130 pb <- getPostBuild
189 pb <- getPostBuild
131 text ""
190 text ""
@@ -134,97 +193,90 @@ main = hspec $ beforeAll startSeleniumServer $ do
134 _ <- textNode $ TextNodeConfig "abc" $ Just $ "" <$ pb
193 _ <- textNode $ TextNodeConfig "abc" $ Just $ "" <$ pb
135 _ <- textNode $ TextNodeConfig "" $ Just $ "world" <$ pb
194 _ <- textNode $ TextNodeConfig "" $ Just $ "world" <$ pb
136 text ""
195 text ""
137− it "works when empty text nodes are the only children of an element" $ do
196+ it "works when empty text nodes are the only children of an element" $ runWD $ do
138 testWidgetStatic (checkBodyText "hello world") $ do
197 testWidgetStatic (checkBodyText "hello world") $ do
139 el "div" $ do
198 el "div" $ do
140 text ""
199 text ""
141 text ""
200 text ""
142 text "hello world"
201 text "hello world"
143− it "works when an empty text node is the first child before text" $ do
202+ it "works when an empty text node is the first child before text" $ runWD $ do
144 testWidgetStatic (checkTextInTag "div" "hello world") $ do
203 testWidgetStatic (checkTextInTag "div" "hello world") $ do
145 el "div" $ do
204 el "div" $ do
146 text ""
205 text ""
147 text "hello world"
206 text "hello world"
148− it "works when an empty text node is the first child before element" $ do
207+ it "works when an empty text node is the first child before element" $ runWD $ do
149 testWidgetStatic (checkTextInTag "div" "hello world") $ do
208 testWidgetStatic (checkTextInTag "div" "hello world") $ do
150 el "div" $ do
209 el "div" $ do
151 text ""
210 text ""
152 el "span" $ text "hello world"
211 el "span" $ text "hello world"
153− it "works when an empty text node is the last child" $ do
212+ it "works when an empty text node is the last child" $ runWD $ do
154 testWidgetStatic (checkTextInTag "div" "hello world") $ do
213 testWidgetStatic (checkTextInTag "div" "hello world") $ do
155 el "div" $ do
214 el "div" $ do
156 el "span" $ text "hello world"
215 el "span" $ text "hello world"
157 text ""
216 text ""
158−
217+-- TODO I think these two tests are broken
159− it "updates after postBuild" $ do
218+-- it "updates after postBuild" $ runWD $ do
160− testWidget (checkBodyText "initial") (checkBodyText "after") $ do
219+-- testWidget (checkBodyText "initial") (checkBodyText "after") $ do
161− after <- delay 0 =<< getPostBuild
220+-- after <- delay 0 =<< getPostBuild
162− void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ after
221+-- void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ after
163− it "updates immediately after postBuild" $ do
222+-- it "updates immediately after postBuild" $ runWD $ do
164− testWidget (checkBodyText "pb") (checkBodyText "after") $ do
223+-- testWidget (checkBodyText "pb") (checkBodyText "after") $ do
165− pb <- getPostBuild
224+-- pb <- getPostBuild
166− after <- delay 0 pb
225+-- after <- delay 0 pb
167− void $ textNode $ TextNodeConfig "initial" $ Just $ leftmost ["pb" <$ pb, "after" <$ after]
226+-- void $ textNode $ TextNodeConfig "initial" $ Just $ leftmost ["pb" <$ pb, "after" <$ after]
168− it "updates in immediate mode" $ do
227+ it "updates in immediate mode" $ runWD $ do
169 let checkUpdated = do
228 let checkUpdated = do
170 checkBodyText "initial"
229 checkBodyText "initial"
171− WD.click =<< WD.findElem (WD.ByTag "button")
230+ WD.click =<< findElemWithRetry (WD.ByTag "button")
172− liftIO $ threadDelay 100000 -- wait for update
173 checkBodyText "after"
231 checkBodyText "after"
174− testWidget (pure ()) checkUpdated $ prerender (pure ()) $ do
232+ testWidget (pure ()) checkUpdated $ prerender_ (pure ()) $ do
175 click <- button ""
233 click <- button ""
176 void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
234 void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
177
235
178− it "works when given differing results of prerender" $ do
179− testWidgetStatic (pure ()) $ do
180− text =<< prerender (pure "One") (pure "Two")
181−
182− describe "element" $ do
236+ session' "element" $ do
183− it "works with domEvent Click" $ do
237+ it "works with domEvent Click" $ runWD $ do
184− clickedRef <- newIORef False
238+ clickedRef <- liftIO $ newRef False
185− testWidget' (WD.findElem $ WD.ByTag "div") WD.click $ do
239+ testWidget' (findElemWithRetry $ WD.ByTag "div") WD.click $ do
186 (e, _) <- el' "div" $ text "hello world"
240 (e, _) <- el' "div" $ text "hello world"
187− performEvent_ $ liftIO (writeIORef clickedRef True) <$ domEvent Click e
241+ performEvent_ $ liftIO (writeRef clickedRef True) <$ domEvent Click e
188− clicked <- readIORef clickedRef
242+ readRef clickedRef `shouldBeWithRetryM` True
189− assertEqual "Not clicked" True clicked
190− it "works with eventFlags stopPropagation" $ do
243+ it "works with eventFlags stopPropagation" $ runWD $ do
191− firstClickedRef <- newIORef False
244+ firstClickedRef <- newRef False
192− secondClickedRef <- newIORef False
245+ secondClickedRef <- newRef False
193 let clickBoth = do
246 let clickBoth = do
194− WD.findElem (WD.ById "first") >>= WD.click
247+ findElemWithRetry (WD.ById "first") >>= WD.click
195− WD.findElem (WD.ById "second") >>= WD.click
248+ findElemWithRetry (WD.ById "second") >>= WD.click
196 testWidget (pure ()) clickBoth $ do
249 testWidget (pure ()) clickBoth $ do
197− (firstDivEl, _) <- el' "div" $ prerender (pure ()) $ do
250+ (firstDivEl, _) <- el' "div" $ prerender_ (pure ()) $ do
198 void $ elAttr "span" ("id" =: "first") $ text "hello world"
251 void $ elAttr "span" ("id" =: "first") $ text "hello world"
199− performEvent_ $ liftIO (writeIORef firstClickedRef True) <$ domEvent Click firstDivEl
252+ performEvent_ $ liftIO (writeRef firstClickedRef True) <$ domEvent Click firstDivEl
200− (secondDivEl, _) <- el' "div" $ prerender (pure ()) $ do
253+ (secondDivEl, _) <- el' "div" $ prerender_ (pure ()) $ do
201 let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
254 let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
202 conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
255 conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
203 & initialAttributes .~ "id" =: "second"
256 & initialAttributes .~ "id" =: "second"
204− & elementConfig_eventSpec .~ (addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> stopPropagation) def)
257+ & elementConfig_eventSpec .~ addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> stopPropagation) def
205 void $ element "span" conf $ text "hello world"
258 void $ element "span" conf $ text "hello world"
206− performEvent_ $ liftIO (writeIORef secondClickedRef True) <$ domEvent Click secondDivEl
259+ performEvent_ $ liftIO (writeRef secondClickedRef True) <$ domEvent Click secondDivEl
207− firstClicked <- readIORef firstClickedRef
260+ firstClicked <- readRef firstClickedRef
208− secondClicked <- readIORef secondClickedRef
261+ secondClicked <- readRef secondClickedRef
209 assertEqual "Click propagated when it should have stopped" (True, False) (firstClicked, secondClicked)
262 assertEqual "Click propagated when it should have stopped" (True, False) (firstClicked, secondClicked)
210− it "works with eventFlags preventDefault" $ do
263+ it "works with eventFlags preventDefault" $ runWD $ do
211 let click = do
264 let click = do
212− e <- WD.findElem $ WD.ByTag "input"
265+ e <- findElemWithRetry $ WD.ByTag "input"
213 s0 <- WD.isSelected e
266 s0 <- WD.isSelected e
214 WD.click e
267 WD.click e
215 s1 <- WD.isSelected e
268 s1 <- WD.isSelected e
216 pure (s0, s1)
269 pure (s0, s1)
217− clicked <- testWidget (pure ()) click $ prerender (pure ()) $ do
270+ clicked <- testWidget (pure ()) click $ prerender_ (pure ()) $ do
218 let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
271 let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
219 conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
272 conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
220− & elementConfig_eventSpec .~ (addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> preventDefault) def)
273+ & elementConfig_eventSpec .~ addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> preventDefault) def
221 & initialAttributes .~ "type" =: "checkbox"
274 & initialAttributes .~ "type" =: "checkbox"
222 void $ element "input" conf $ text "hello world"
275 void $ element "input" conf $ text "hello world"
223 assertEqual "Click not prevented" (False, False) clicked
276 assertEqual "Click not prevented" (False, False) clicked
224−
225− it "can add/update/remove attributes" $ do
277+ it "can add/update/remove attributes" $ runWD $ do
226 let checkInitialAttrs = do
278 let checkInitialAttrs = do
227− e <- WD.findElem $ WD.ByTag "div"
279+ e <- findElemWithRetry $ WD.ByTag "div"
228 assertAttr e "const" (Just "const")
280 assertAttr e "const" (Just "const")
229 assertAttr e "delete" (Just "delete")
281 assertAttr e "delete" (Just "delete")
230 assertAttr e "init" (Just "init")
282 assertAttr e "init" (Just "init")
@@ -232,11 +284,11 @@ main = hspec $ beforeAll startSeleniumServer $ do
232 pure e
284 pure e
233 checkModifyAttrs e = do
285 checkModifyAttrs e = do
234 WD.click e
286 WD.click e
235− liftIO $ threadDelay 100000
287+ withRetry $ do
236− assertAttr e "const" (Just "const")
288+ assertAttr e "const" (Just "const")
237− assertAttr e "delete" Nothing
289+ assertAttr e "delete" Nothing
238− assertAttr e "init" (Just "click")
290+ assertAttr e "init" (Just "click")
239− assertAttr e "click" (Just "click")
291+ assertAttr e "click" (Just "click")
240 testWidget' checkInitialAttrs checkModifyAttrs $ mdo
292 testWidget' checkInitialAttrs checkModifyAttrs $ mdo
241 let conf = def
293 let conf = def
242 & initialAttributes .~ "const" =: "const" <> "delete" =: "delete" <> "init" =: "init"
294 & initialAttributes .~ "const" =: "const" <> "delete" =: "delete" <> "init" =: "init"
@@ -245,813 +297,1079 @@ main = hspec $ beforeAll startSeleniumServer $ do
245 let click = domEvent Click e
297 let click = domEvent Click e
246 return ()
298 return ()
247
299
248− -- TODO check this is the correct solution
300+ session' "inputElement" $ do
249− it "has ssr attribute, removes ssr attribute" $ do
301+ describe "static renderer" $ do
250− let checkSSRAttr = do
302+ it "sets value attribute" $ runWD $ do
251− e <- WD.findElem $ WD.ByTag "div"
303+ let checkStatic = do
252− assertAttr e "ssr" (Just "")
304+ e <- findElemWithRetry $ WD.ByTag "input"
253− pure e
305+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
254− testWidget' checkSSRAttr (\e -> assertAttr e "ssr" Nothing) $ el "div" $ text "hello world"
306+ pure e
255−
307+ checkHydrated e = do
256− it "can't misuse raw elements" $ do
308+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
257− clicked <- newIORef False
309+ testWidget' checkStatic checkHydrated $ void $ inputElement $ def
258− let check = do
310+ & inputElementConfig_initialValue .~ "test"
259− e <- WD.findElem $ WD.ByTag "div"
311+ it "updates value attribute at postBuild" $ runWD $ do
260− liftIO $ readIORef clicked >>= flip shouldBe True
312+ let checkStatic = do
261− WD.click e
313+ e <- findElemWithRetry $ WD.ByTag "input"
262− liftIO $ do
314+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
263− threadDelay 100000
315+ pure e
264− readIORef clicked >>= flip shouldBe False
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"
265− testWidget (pure ()) check $ do
351+ testWidget' checkStatic checkValue $ do
266− (e, _) <- el' "div" $ text "hello"
352+ pb <- getPostBuild
267− prerender (pure ()) $ do
353+ _ <- inputElement $ def
268− let e' = DOM.uncheckedCastTo DOM.HTMLElement (_element_raw e)
354+ & initialAttributes .~ "type" =: "checkbox"
269− liftJSM $ e' `EventM.on` Events.click $ do
355+ & inputElementConfig_initialChecked .~ False
270− liftIO $ writeIORef clicked True
356+ & inputElementConfig_setChecked .~ (True <$ pb)
271 pure ()
357 pure ()
272−
273− describe "inputElement" $ do
274 describe "hydration" $ do
358 describe "hydration" $ do
275− it "doesn't wipe user input when switching over" $ do
359+ it "doesn't wipe user input when switching over" $ runWD $ do
276− inputRef <- newIORef ""
360+ inputRef <- newRef ("hello " :: Text)
277 testWidget'
361 testWidget'
278 (do
362 (do
279− e <- WD.findElem $ WD.ByTag "input"
363+ e <- findElemWithRetry $ WD.ByTag "input"
280− WD.sendKeys "hello world" e
364+ WD.sendKeys "world" e
281 pure e)
365 pure e)
282 (\e -> do
366 (\e -> do
283− t <- WD.attr e "value"
367+ WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
284− liftIO $ t `shouldBe` Just "hello world"
285− WD.click <=< WD.findElem $ WD.ByTag "button"
368+ WD.click =<< findElemWithRetry (WD.ByTag "button")
286− input <- liftIO $ readIORef inputRef
369+ readRef inputRef `shouldBeWithRetryM` "hello world"
287− liftIO $ input `shouldBe` "hello world"
288 ) $ do
370 ) $ do
289− e <- inputElement def
371+ e <- inputElement $ def & inputElementConfig_initialValue .~ "hello "
290 click <- button "save"
372 click <- button "save"
291− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (value e)) click
373+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
292− it "captures user input after switchover" $ do
374+ it "captures user input after switchover" $ runWD $ do
293− inputRef <- newIORef ""
375+ inputRef <- newRef ("" :: Text)
294 let checkValue = do
376 let checkValue = do
295− WD.sendKeys "hello world" <=< WD.findElem $ WD.ByTag "input"
377+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
296− WD.click <=< WD.findElem $ WD.ByTag "button"
378+ WD.click =<< findElemWithRetry (WD.ByTag "button")
297− input <- liftIO $ readIORef inputRef
379+ readRef inputRef `shouldBeWithRetryM` "hello world"
298− liftIO $ input `shouldBe` "hello world"
299 testWidget (pure ()) checkValue $ do
380 testWidget (pure ()) checkValue $ do
300 e <- inputElement def
381 e <- inputElement def
301 click <- button "save"
382 click <- button "save"
302− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (value e)) click
383+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
303− it "sets focus appropriately" $ do
384+ it "sets focus appropriately" $ runWD $ do
304− focusRef <- newIORef False
385+ focusRef <- newRef False
305 let checkValue = do
386 let checkValue = do
306− liftIO $ readIORef focusRef >>= flip shouldBe False
387+ readRef focusRef `shouldBeWithRetryM` False
307− e <- WD.findElem $ WD.ByTag "input"
388+ e <- findElemWithRetry $ WD.ByTag "input"
308 WD.click e
389 WD.click e
309− liftIO $ threadDelay 100000
390+ readRef focusRef `shouldBeWithRetryM` True
310− liftIO $ readIORef focusRef >>= flip shouldBe True
311 testWidget (pure ()) checkValue $ do
391 testWidget (pure ()) checkValue $ do
312 e <- inputElement def
392 e <- inputElement def
313− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_inputElement_hasFocus e)
393+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
314− it "sets focus when focus occurs before hydration" $ do
394+ it "sets focus when focus occurs before hydration" $ runWD $ do
315− focusRef <- newIORef False
395+ focusRef <- newRef False
316 let setup = do
396 let setup = do
317− e <- WD.findElem $ WD.ByTag "input"
397+ e <- findElemWithRetry $ WD.ByTag "input"
318 WD.click e
398 WD.click e
319− hasFocus <- (== e) <$> WD.activeElem
399+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
320− liftIO $ do
400+ readRef focusRef `shouldBeWithRetryM` False
321− hasFocus `shouldBe` True
401+ check = readRef focusRef `shouldBeWithRetryM` True
322− readIORef focusRef >>= flip shouldBe False
323− check = liftIO $ readIORef focusRef >>= flip shouldBe True
324 testWidget setup check $ do
402 testWidget setup check $ do
325 e <- inputElement def
403 e <- inputElement def
326− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_inputElement_hasFocus e)
404+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
327− it "sets value appropriately" $ do
405+ it "sets value appropriately" $ runWD $ do
328− valueByUIRef <- newIORef ""
406+ valueByUIRef <- newRef ("" :: Text)
329− valueRef <- newIORef ""
407+ valueRef <- newRef ("" :: Text)
330− setValueChan :: Chan Text <- newChan
408+ setValueChan :: Chan Text <- liftIO newChan
331 let checkValue = do
409 let checkValue = do
332− liftIO $ readIORef valueByUIRef >>= flip shouldBe ""
410+ readRef valueByUIRef `shouldBeWithRetryM` ""
333− liftIO $ readIORef valueRef >>= flip shouldBe ""
411+ readRef valueRef `shouldBeWithRetryM` ""
334− e <- WD.findElem $ WD.ByTag "input"
412+ e <- findElemWithRetry $ WD.ByTag "input"
335 WD.sendKeys "hello" e
413 WD.sendKeys "hello" e
336− liftIO $ do
414+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
337− threadDelay 100000
415+ readRef valueRef `shouldBeWithRetryM` "hello"
338− readIORef valueByUIRef >>= flip shouldBe "hello"
339− readIORef valueRef >>= flip shouldBe "hello"
340− writeChan setValueChan "world"
416+ liftIO $ writeChan setValueChan "world"
341− threadDelay 100000
342− readIORef valueByUIRef >>= flip shouldBe "hello"
417+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
343− readIORef valueRef >>= flip shouldBe "world"
418+ readRef valueRef `shouldBeWithRetryM` "world"
344 testWidget (pure ()) checkValue $ do
419 testWidget (pure ()) checkValue $ do
345− setValue <- triggerEventWithChan setValueChan
420+ update <- triggerEventWithChan setValueChan
346− e <- inputElement $ def & inputElementConfig_setValue .~ setValue
421+ e <- inputElement $ def & inputElementConfig_setValue .~ update
347− performEvent_ $ liftIO . writeIORef valueByUIRef <$> _inputElement_input e
422+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _inputElement_input e
348− performEvent_ $ liftIO . writeIORef valueRef <$> updated (value e)
423+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
349− it "sets checked appropriately" $ do
424+ it "sets checked appropriately" $ runWD $ do
350− checkedByUIRef <- newIORef False
425+ checkedByUIRef <- newRef False
351− checkedRef <- newIORef False
426+ checkedRef <- newRef False
352− setCheckedChan <- newChan
427+ setCheckedChan <- liftIO newChan
353− let checkValue = do
428+ let checkStatic = do
354− liftIO $ readIORef checkedByUIRef >>= flip shouldBe False
355− liftIO $ readIORef checkedRef >>= flip shouldBe False
356− e <- WD.findElem $ WD.ByTag "input"
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
357 WD.moveToCenter e
436 WD.moveToCenter e
358 WD.click e
437 WD.click e
359− liftIO $ do
438+ readRef checkedByUIRef `shouldBeWithRetryM` True
360− threadDelay 100000
439+ readRef checkedRef `shouldBeWithRetryM` True
361− readIORef checkedByUIRef >>= flip shouldBe True
440+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
362− readIORef checkedRef >>= flip shouldBe True
363− writeChan setCheckedChan False
441+ liftIO $ writeChan setCheckedChan False
364− threadDelay 100000
365− readIORef checkedByUIRef >>= flip shouldBe True
442+ readRef checkedByUIRef `shouldBeWithRetryM` True
366− readIORef checkedRef >>= flip shouldBe False
443+ readRef checkedRef `shouldBeWithRetryM` False
444+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
367− testWidget (pure ()) checkValue $ do
445+ testWidget' checkStatic checkValue $ do
368 setChecked <- triggerEventWithChan setCheckedChan
446 setChecked <- triggerEventWithChan setCheckedChan
369 e <- inputElement $ def
447 e <- inputElement $ def
370 & initialAttributes .~ "type" =: "checkbox"
448 & initialAttributes .~ "type" =: "checkbox"
371 & inputElementConfig_setChecked .~ setChecked
449 & inputElementConfig_setChecked .~ setChecked
372− performEvent_ $ liftIO . writeIORef checkedByUIRef <$> _inputElement_checkedChange e
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
373− performEvent_ $ liftIO . writeIORef checkedRef <$> updated (_inputElement_checked e)
470+ performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
374− it "captures file uploads" $ do
471+ it "captures file uploads" $ runWD $ do
375− filesRef :: IORef [Text] <- newIORef []
472+ filesRef :: IORef [Text] <- newRef []
376 let uploadFile = do
473 let uploadFile = do
377− e <- WD.findElem $ WD.ByTag "input"
474+ e <- findElemWithRetry $ WD.ByTag "input"
378 path <- liftIO $ writeSystemTempFile "testFile" "file contents"
475 path <- liftIO $ writeSystemTempFile "testFile" "file contents"
379 WD.sendKeys (T.pack path) e
476 WD.sendKeys (T.pack path) e
380− WD.click <=< WD.findElem $ WD.ByTag "button"
477+ WD.click =<< findElemWithRetry (WD.ByTag "button")
381 liftIO $ removeFile path
478 liftIO $ removeFile path
382− input <- liftIO $ readIORef filesRef
383− liftIO $ input `shouldBe` [T.pack $ FilePath.takeFileName path]
479+ readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
384 testWidget (pure ()) uploadFile $ do
480 testWidget (pure ()) uploadFile $ do
385 e <- inputElement $ def & initialAttributes .~ "type" =: "file"
481 e <- inputElement $ def & initialAttributes .~ "type" =: "file"
386 click <- button "save"
482 click <- button "save"
387− prerender (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
483+ prerender_ (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
388 names <- liftJSM $ traverse File.getName fs
484 names <- liftJSM $ traverse File.getName fs
389− liftIO $ writeIORef filesRef names
485+ liftIO $ writeRef filesRef names
390−
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
391 describe "hydration/immediate" $ do
596 describe "hydration/immediate" $ do
392− it "captures user input after switchover" $ do
597+ it "captures user input after switchover" $ runWD $ do
393− inputRef :: IORef Text <- newIORef ""
598+ inputRef :: IORef Text <- newRef ""
394 let checkValue = do
599 let checkValue = do
395− WD.sendKeys "hello world" <=< WD.findElem $ WD.ByTag "input"
600+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
396− WD.click <=< WD.findElem $ WD.ByTag "button"
601+ WD.click =<< findElemWithRetry (WD.ByTag "button")
397− input <- liftIO $ readIORef inputRef
602+ readRef inputRef `shouldBeWithRetryM` "hello world"
398− liftIO $ input `shouldBe` "hello world"
399− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
603+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
400 e <- inputElement def
604 e <- inputElement def
401 click <- button "save"
605 click <- button "save"
402− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (value e)) click
606+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
403− it "sets focus appropriately" $ do
607+ it "sets focus appropriately" $ runWD $ do
404− focusRef <- newIORef False
608+ focusRef <- newRef False
405 let checkValue = do
609 let checkValue = do
406− liftIO $ readIORef focusRef >>= flip shouldBe False
610+ readRef focusRef `shouldBeWithRetryM` False
407− e <- WD.findElem $ WD.ByTag "input"
611+ e <- findElemWithRetry $ WD.ByTag "input"
408 WD.click e
612 WD.click e
409− liftIO $ threadDelay 100000
613+ readRef focusRef `shouldBeWithRetryM` True
410− liftIO $ readIORef focusRef >>= flip shouldBe True
411− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
614+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
412 e <- inputElement def
615 e <- inputElement def
413− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_inputElement_hasFocus e)
616+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
414− it "sets value appropriately" $ do
617+ it "sets value appropriately" $ runWD $ do
415− valueByUIRef :: IORef Text <- newIORef ""
618+ valueByUIRef :: IORef Text <- newRef ""
416− valueRef :: IORef Text <- newIORef ""
619+ valueRef :: IORef Text <- newRef ""
417− setValueChan :: Chan Text <- newChan
620+ setValueChan :: Chan Text <- liftIO newChan
418 let checkValue = do
621 let checkValue = do
419− liftIO $ readIORef valueByUIRef >>= flip shouldBe ""
622+ readRef valueByUIRef `shouldBeWithRetryM` ""
420− liftIO $ readIORef valueRef >>= flip shouldBe ""
623+ readRef valueRef `shouldBeWithRetryM` ""
421− e <- WD.findElem $ WD.ByTag "input"
624+ e <- findElemWithRetry $ WD.ByTag "input"
422 WD.sendKeys "hello" e
625 WD.sendKeys "hello" e
423− liftIO $ do
424− threadDelay 100000
425− readIORef valueByUIRef >>= flip shouldBe "hello"
626+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
426− readIORef valueRef >>= flip shouldBe "hello"
627+ readRef valueRef `shouldBeWithRetryM` "hello"
427− writeChan setValueChan "world"
628+ liftIO $ writeChan setValueChan "world"
428− threadDelay 100000
429− readIORef valueByUIRef >>= flip shouldBe "hello"
629+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
430− readIORef valueRef >>= flip shouldBe "world"
630+ readRef valueRef `shouldBeWithRetryM` "world"
431− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
631+ testWidget (pure ()) checkValue $ do
432− setValue <- triggerEventWithChan setValueChan
632+ update <- triggerEventWithChan setValueChan
633+ prerender_ (pure ()) $ do
433− e <- inputElement $ def & inputElementConfig_setValue .~ setValue
634+ e <- inputElement $ def & inputElementConfig_setValue .~ update
434− performEvent_ $ liftIO . writeIORef valueByUIRef <$> _inputElement_input e
635+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _inputElement_input e
435− performEvent_ $ liftIO . writeIORef valueRef <$> updated (value e)
636+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
436− it "sets checked appropriately" $ do
637+ it "sets checked appropriately" $ runWD $ do
437− checkedByUIRef <- newIORef False
638+ checkedByUIRef <- newRef False
438− checkedRef <- newIORef False
639+ checkedRef <- newRef False
439− setCheckedChan <- newChan
640+ setCheckedChan <- liftIO newChan
440 let checkValue = do
641 let checkValue = do
441− liftIO $ readIORef checkedByUIRef >>= flip shouldBe False
642+ readRef checkedByUIRef `shouldBeWithRetryM` False
442− liftIO $ readIORef checkedRef >>= flip shouldBe False
643+ readRef checkedRef `shouldBeWithRetryM` False
443− e <- WD.findElem $ WD.ByTag "input"
644+ e <- findElemWithRetry $ WD.ByTag "input"
444 WD.moveToCenter e
645 WD.moveToCenter e
445 WD.click e
646 WD.click e
446− liftIO $ do
647+ readRef checkedByUIRef `shouldBeWithRetryM` True
447− threadDelay 100000
648+ readRef checkedRef `shouldBeWithRetryM` True
448− readIORef checkedByUIRef >>= flip shouldBe True
449− readIORef checkedRef >>= flip shouldBe True
450− writeChan setCheckedChan False
649+ liftIO $ writeChan setCheckedChan False
451− threadDelay 100000
452− readIORef checkedByUIRef >>= flip shouldBe True
650+ readRef checkedByUIRef `shouldBeWithRetryM` True
453− readIORef checkedRef >>= flip shouldBe False
651+ readRef checkedRef `shouldBeWithRetryM` False
454− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
652+ testWidget (pure ()) checkValue $ do
455 setChecked <- triggerEventWithChan setCheckedChan
653 setChecked <- triggerEventWithChan setCheckedChan
654+ prerender_ (pure ()) $ do
456− e <- inputElement $ def
655+ e <- inputElement $ def
457− & initialAttributes .~ "type" =: "checkbox"
656+ & initialAttributes .~ "type" =: "checkbox"
458− & inputElementConfig_setChecked .~ setChecked
657+ & inputElementConfig_setChecked .~ setChecked
459− performEvent_ $ liftIO . writeIORef checkedByUIRef <$> _inputElement_checkedChange e
658+ performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
460− performEvent_ $ liftIO . writeIORef checkedRef <$> updated (_inputElement_checked e)
659+ performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
461− it "captures file uploads" $ do
660+ it "captures file uploads" $ runWD $ do
462− filesRef :: IORef [Text] <- newIORef []
661+ filesRef :: IORef [Text] <- newRef []
463 let uploadFile = do
662 let uploadFile = do
464− e <- WD.findElem $ WD.ByTag "input"
663+ e <- findElemWithRetry $ WD.ByTag "input"
465 path <- liftIO $ writeSystemTempFile "testFile" "file contents"
664 path <- liftIO $ writeSystemTempFile "testFile" "file contents"
466 WD.sendKeys (T.pack path) e
665 WD.sendKeys (T.pack path) e
467− WD.click <=< WD.findElem $ WD.ByTag "button"
666+ WD.click =<< findElemWithRetry (WD.ByTag "button")
468 liftIO $ removeFile path
667 liftIO $ removeFile path
469− input <- liftIO $ readIORef filesRef
470− liftIO $ input `shouldBe` [T.pack $ FilePath.takeFileName path]
668+ readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
471− testWidget (pure ()) uploadFile $ prerender (pure ()) $ do
669+ testWidget (pure ()) uploadFile $ prerender_ (pure ()) $ do
472 e <- inputElement $ def & initialAttributes .~ "type" =: "file"
670 e <- inputElement $ def & initialAttributes .~ "type" =: "file"
473 click <- button "save"
671 click <- button "save"
474− prerender (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
672+ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
475 names <- liftJSM $ traverse File.getName fs
673 names <- liftJSM $ traverse File.getName fs
476− liftIO $ writeIORef filesRef names
674+ liftIO $ writeRef filesRef names
477
675
478− describe "textAreaElement" $ do
676+ session' "textAreaElement" $ do
677+ describe "static renderer" $ do
678+ it "sets value attribute" $ runWD $ do
679+ let checkStatic = do
680+ e <- findElemWithRetry $ WD.ByTag "textarea"
681+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
682+ pure e
683+ checkHydrated e = do
684+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
685+ testWidget' checkStatic checkHydrated $ void $ textAreaElement $ def
686+ & textAreaElementConfig_initialValue .~ "test"
687+ it "updates value attribute at postBuild" $ runWD $ do
688+ let checkStatic = do
689+ e <- findElemWithRetry $ WD.ByTag "textarea"
690+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
691+ pure e
692+ checkHydrated e = do
693+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
694+ testWidget' checkStatic checkHydrated $ do
695+ pb <- getPostBuild
696+ _ <- textAreaElement $ def
697+ & textAreaElementConfig_initialValue .~ "test"
698+ & textAreaElementConfig_setValue .~ ("test-updated" <$ pb)
699+ pure ()
479 describe "hydration" $ do
700 describe "hydration" $ do
480− it "doesn't wipe user input when switching over" $ do
701+ it "doesn't wipe user input when switching over" $ runWD $ do
481− inputRef <- newIORef ""
702+ inputRef <- newRef ("" :: Text)
482 testWidget'
703 testWidget'
483 (do
704 (do
484− e <- WD.findElem $ WD.ByTag "textarea"
705+ e <- findElemWithRetry $ WD.ByTag "textarea"
485 WD.sendKeys "hello world" e
706 WD.sendKeys "hello world" e
486 pure e)
707 pure e)
487 (\e -> do
708 (\e -> do
488− t <- WD.attr e "value"
709+ WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
489− liftIO $ t `shouldBe` Just "hello world"
490− WD.click <=< WD.findElem $ WD.ByTag "button"
710+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
491− input <- liftIO $ readIORef inputRef
711+ readRef inputRef `shouldBeWithRetryM` "hello world"
492− liftIO $ input `shouldBe` "hello world"
493 ) $ do
712 ) $ do
494 e <- textAreaElement def
713 e <- textAreaElement def
495 click <- button "save"
714 click <- button "save"
496− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (value e)) click
715+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
497− it "captures user input after switchover" $ do
716+ it "captures user input after switchover" $ runWD $ do
498− inputRef <- newIORef ""
717+ inputRef <- newRef ("" :: Text)
499 let checkValue = do
718 let checkValue = do
500− WD.sendKeys "hello world" <=< WD.findElem $ WD.ByTag "textarea"
719+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "textarea")
501− WD.click <=< WD.findElem $ WD.ByTag "button"
720+ WD.click =<< findElemWithRetry (WD.ByTag "button")
502− input <- liftIO $ readIORef inputRef
721+ readRef inputRef `shouldBeWithRetryM` "hello world"
503− liftIO $ input `shouldBe` "hello world"
504 testWidget (pure ()) checkValue $ do
722 testWidget (pure ()) checkValue $ do
505 e <- textAreaElement def
723 e <- textAreaElement def
506 click <- button "save"
724 click <- button "save"
507− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (value e)) click
725+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
508− it "sets focus appropriately" $ do
726+ it "sets focus appropriately" $ runWD $ do
509− focusRef <- newIORef False
727+ focusRef <- newRef False
510 let checkValue = do
728 let checkValue = do
511− liftIO $ readIORef focusRef >>= flip shouldBe False
729+ readRef focusRef `shouldBeWithRetryM` False
512− e <- WD.findElem $ WD.ByTag "textarea"
730+ e <- findElemWithRetry $ WD.ByTag "textarea"
513 WD.click e
731 WD.click e
514− liftIO $ threadDelay 100000
732+ readRef focusRef `shouldBeWithRetryM` True
515− liftIO $ readIORef focusRef >>= flip shouldBe True
516 testWidget (pure ()) checkValue $ do
733 testWidget (pure ()) checkValue $ do
517 e <- textAreaElement def
734 e <- textAreaElement def
518− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_textAreaElement_hasFocus e)
735+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
519− it "sets focus when focus occurs before hydration" $ do
736+ it "sets focus when focus occurs before hydration" $ runWD $ do
520− focusRef <- newIORef False
737+ focusRef <- newRef False
521 let setup = do
738 let setup = do
522− e <- WD.findElem $ WD.ByTag "textarea"
739+ e <- findElemWithRetry $ WD.ByTag "textarea"
523 WD.click e
740 WD.click e
524− hasFocus <- (== e) <$> WD.activeElem
741+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
525− liftIO $ do
742+ readRef focusRef `shouldBeWithRetryM` False
526− hasFocus `shouldBe` True
743+ check = readRef focusRef `shouldBeWithRetryM` True
527− readIORef focusRef >>= flip shouldBe False
528− check = liftIO $ readIORef focusRef >>= flip shouldBe True
529 testWidget setup check $ do
744 testWidget setup check $ do
530 e <- textAreaElement def
745 e <- textAreaElement def
531− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_textAreaElement_hasFocus e)
746+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
532− it "sets value appropriately" $ do
747+ it "sets value appropriately" $ runWD $ do
533− valueByUIRef <- newIORef ("" :: Text)
748+ valueByUIRef <- newRef ("" :: Text)
534− valueRef <- newIORef ("" :: Text)
749+ valueRef <- newRef ("" :: Text)
535− setValueChan :: Chan Text <- newChan
750+ setValueChan :: Chan Text <- liftIO newChan
536 let checkValue = do
751 let checkValue = do
537− liftIO $ readIORef valueByUIRef >>= flip shouldBe ""
752+ readRef valueByUIRef `shouldBeWithRetryM` ""
538− liftIO $ readIORef valueRef >>= flip shouldBe ""
753+ readRef valueRef `shouldBeWithRetryM` ""
539− e <- WD.findElem $ WD.ByTag "textarea"
754+ e <- findElemWithRetry $ WD.ByTag "textarea"
540 WD.sendKeys "hello" e
755 WD.sendKeys "hello" e
541− liftIO $ do
756+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
542− threadDelay 100000
757+ readRef valueRef `shouldBeWithRetryM` "hello"
543− readIORef valueByUIRef >>= flip shouldBe "hello"
544− readIORef valueRef >>= flip shouldBe "hello"
545− writeChan setValueChan "world"
758+ liftIO $ writeChan setValueChan "world"
546− threadDelay 100000
547− readIORef valueByUIRef >>= flip shouldBe "hello"
759+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
548− readIORef valueRef >>= flip shouldBe "world"
760+ readRef valueRef `shouldBeWithRetryM` "world"
549 testWidget (pure ()) checkValue $ do
761 testWidget (pure ()) checkValue $ do
550 setValue' <- triggerEventWithChan setValueChan
762 setValue' <- triggerEventWithChan setValueChan
551 e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
763 e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
552− performEvent_ $ liftIO . writeIORef valueByUIRef <$> _textAreaElement_input e
764+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
553− performEvent_ $ liftIO . writeIORef valueRef <$> updated (value 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
554
848
555 describe "hydration/immediate" $ do
849 describe "hydration/immediate" $ do
556− it "captures user input after switchover" $ do
850+ it "captures user input after switchover" $ runWD $ do
557− inputRef :: IORef Text <- newIORef ""
851+ inputRef :: IORef Text <- newRef ""
558 let checkValue = do
852 let checkValue = do
559− WD.sendKeys "hello world" <=< WD.findElem $ WD.ByTag "textarea"
853+ WD.sendKeys "hello world" <=< findElemWithRetry $ WD.ByTag "textarea"
560− WD.click <=< WD.findElem $ WD.ByTag "button"
854+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
561− input <- liftIO $ readIORef inputRef
855+ readRef inputRef `shouldBeWithRetryM` "hello world"
562− liftIO $ input `shouldBe` "hello world"
563− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
856+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
564 e <- textAreaElement def
857 e <- textAreaElement def
565 click <- button "save"
858 click <- button "save"
566− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (value e)) click
859+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
567− it "sets focus appropriately" $ do
860+ it "sets focus appropriately" $ runWD $ do
568− focusRef <- newIORef False
861+ focusRef <- newRef False
569 let checkValue = do
862 let checkValue = do
570− liftIO $ readIORef focusRef >>= flip shouldBe False
863+ readRef focusRef `shouldBeWithRetryM` False
571− e <- WD.findElem $ WD.ByTag "textarea"
864+ e <- findElemWithRetry $ WD.ByTag "textarea"
572 WD.click e
865 WD.click e
573− liftIO $ threadDelay 100000
866+ readRef focusRef `shouldBeWithRetryM` True
574− liftIO $ readIORef focusRef >>= flip shouldBe True
575− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
867+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
576 e <- textAreaElement def
868 e <- textAreaElement def
577− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_textAreaElement_hasFocus e)
869+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
578− it "sets value appropriately" $ do
870+ it "sets value appropriately" $ runWD $ do
579− valueByUIRef :: IORef Text <- newIORef ""
871+ valueByUIRef :: IORef Text <- newRef ""
580− valueRef :: IORef Text <- newIORef ""
872+ valueRef :: IORef Text <- newRef ""
581− setValueChan :: Chan Text <- newChan
873+ setValueChan :: Chan Text <- liftIO newChan
582 let checkValue = do
874 let checkValue = do
583− liftIO $ readIORef valueByUIRef >>= flip shouldBe ""
875+ readRef valueByUIRef `shouldBeWithRetryM` ""
584− liftIO $ readIORef valueRef >>= flip shouldBe ""
876+ readRef valueRef `shouldBeWithRetryM` ""
585− e <- WD.findElem $ WD.ByTag "textarea"
877+ e <- findElemWithRetry $ WD.ByTag "textarea"
586 WD.sendKeys "hello" e
878 WD.sendKeys "hello" e
587− liftIO $ do
879+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
588− threadDelay 100000
880+ readRef valueRef `shouldBeWithRetryM` "hello"
589− readIORef valueByUIRef >>= flip shouldBe "hello"
590− readIORef valueRef >>= flip shouldBe "hello"
591− writeChan setValueChan "world"
881+ liftIO $ writeChan setValueChan "world"
592− threadDelay 100000
593− readIORef valueByUIRef >>= flip shouldBe "hello"
882+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
594− readIORef valueRef >>= flip shouldBe "world"
883+ readRef valueRef `shouldBeWithRetryM` "world"
595− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
884+ testWidget (pure ()) checkValue $ do
596 setValue' <- triggerEventWithChan setValueChan
885 setValue' <- triggerEventWithChan setValueChan
886+ prerender_ (pure ()) $ do
597− e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
887+ e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
598− performEvent_ $ liftIO . writeIORef valueByUIRef <$> _textAreaElement_input e
888+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
599− performEvent_ $ liftIO . writeIORef valueRef <$> updated (value e)
889+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
600
890
601− describe "selectElement" $ do
891+ session' "selectElement" $ do
602 let options :: DomBuilder t m => m ()
892 let options :: DomBuilder t m => m ()
603 options = do
893 options = do
604 elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
894 elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
605 elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
895 elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
606 elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
896 elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
607 describe "hydration" $ do
897 describe "hydration" $ do
608− it "sets initial value correctly" $ do
898+ it "sets initial value correctly" $ runWD $ do
609− inputRef <- newIORef ""
899+ inputRef <- newRef ("" :: Text)
610 let setup = do
900 let setup = do
611− e <- WD.findElem $ WD.ByTag "select"
901+ e <- findElemWithRetry $ WD.ByTag "select"
612 assertAttr e "value" (Just "three")
902 assertAttr e "value" (Just "three")
613− WD.click <=< WD.findElem $ WD.ById "two"
903+ WD.click =<< findElemWithRetry (WD.ById "two")
614 pure e
904 pure e
615 check e = do
905 check e = do
616 assertAttr e "value" (Just "two")
906 assertAttr e "value" (Just "two")
617− liftIO $ readIORef inputRef >>= (`shouldBe` "three")
907+ readRef inputRef `shouldBeWithRetryM` "three"
618− WD.click <=< WD.findElem $ WD.ByTag "button"
908+ WD.click =<< findElemWithRetry (WD.ByTag "button")
619 assertAttr e "value" (Just "two")
909 assertAttr e "value" (Just "two")
620− liftIO $ readIORef inputRef >>= (`shouldBe` "two")
910+ readRef inputRef `shouldBeWithRetryM` "two"
621 testWidget' setup check $ do
911 testWidget' setup check $ do
622 (e, ()) <- selectElement (def { _selectElementConfig_initialValue = "three" }) options
912 (e, ()) <- selectElement (def { _selectElementConfig_initialValue = "three" }) options
623 click <- button "save"
913 click <- button "save"
624− liftIO . writeIORef inputRef <=< sample $ current $ _selectElement_value e
914+ liftIO . writeRef inputRef <=< sample $ current $ _selectElement_value e
625− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (_selectElement_value e)) click
915+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
626− it "captures user input after switchover" $ do
916+ it "captures user input after switchover" $ runWD $ do
627− inputRef <- newIORef ""
917+ inputRef <- newRef ("" :: Text)
628 let checkValue = do
918 let checkValue = do
629− e <- WD.findElem $ WD.ByTag "select"
919+ e <- findElemWithRetry $ WD.ByTag "select"
630 assertAttr e "value" (Just "one")
920 assertAttr e "value" (Just "one")
631− WD.click <=< WD.findElem $ WD.ById "two"
921+ WD.click =<< findElemWithRetry (WD.ById "two")
632 assertAttr e "value" (Just "two")
922 assertAttr e "value" (Just "two")
633− WD.click <=< WD.findElem $ WD.ByTag "button"
923+ WD.click =<< findElemWithRetry (WD.ByTag "button")
634− liftIO $ readIORef inputRef >>= (`shouldBe` "two")
924+ readRef inputRef `shouldBeWithRetryM` "two"
635 testWidget (pure ()) checkValue $ do
925 testWidget (pure ()) checkValue $ do
636 (e, ()) <- selectElement def options
926 (e, ()) <- selectElement def options
637 click <- button "save"
927 click <- button "save"
638− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (_selectElement_value e)) click
928+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
639− it "sets focus appropriately" $ do
929+ it "sets focus appropriately" $ runWD $ do
640− focusRef <- newIORef False
930+ focusRef <- newRef False
641 let checkValue = do
931 let checkValue = do
642− liftIO $ readIORef focusRef >>= flip shouldBe False
932+ readRef focusRef `shouldBeWithRetryM` False
643− e <- WD.findElem $ WD.ByTag "select"
933+ e <- findElemWithRetry $ WD.ByTag "select"
644 WD.click e
934 WD.click e
645− liftIO $ threadDelay 100000
935+ readRef focusRef `shouldBeWithRetryM` True
646− liftIO $ readIORef focusRef >>= flip shouldBe True
647 testWidget (pure ()) checkValue $ do
936 testWidget (pure ()) checkValue $ do
648 (e, ()) <- selectElement def options
937 (e, ()) <- selectElement def options
649− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_selectElement_hasFocus e)
938+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
650− it "sets focus when focus occurs before hydration" $ do
939+ it "sets focus when focus occurs before hydration" $ runWD $ do
651− focusRef <- newIORef False
940+ focusRef <- newRef False
652 let setup = do
941 let setup = do
653− e <- WD.findElem $ WD.ByTag "select"
942+ e <- findElemWithRetry $ WD.ByTag "select"
654 WD.click e
943 WD.click e
655− hasFocus <- (== e) <$> WD.activeElem
944+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
656− liftIO $ do
945+ readRef focusRef `shouldBeWithRetryM` False
657− hasFocus `shouldBe` True
946+ check = readRef focusRef `shouldBeWithRetryM` True
658− readIORef focusRef >>= flip shouldBe False
659− check = liftIO $ readIORef focusRef >>= flip shouldBe True
660 testWidget setup check $ do
947 testWidget setup check $ do
661 (e, ()) <- selectElement def options
948 (e, ()) <- selectElement def options
662− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_selectElement_hasFocus e)
949+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
663− it "sets value appropriately" $ do
950+ it "sets value appropriately" $ runWD $ do
664− valueByUIRef <- newIORef ("" :: Text)
951+ valueByUIRef <- newRef ("" :: Text)
665− valueRef <- newIORef ("" :: Text)
952+ valueRef <- newRef ("" :: Text)
666− setValueChan :: Chan Text <- newChan
953+ setValueChan :: Chan Text <- liftIO newChan
667 let checkValue = do
954 let checkValue = do
668− e <- WD.findElem $ WD.ByTag "select"
955+ e <- findElemWithRetry $ WD.ByTag "select"
669 assertAttr e "value" (Just "one")
956 assertAttr e "value" (Just "one")
670− liftIO $ readIORef valueByUIRef >>= flip shouldBe "one"
957+ readRef valueByUIRef `shouldBeWithRetryM` "one"
671− liftIO $ readIORef valueRef >>= flip shouldBe "one"
958+ readRef valueRef `shouldBeWithRetryM` "one"
672− WD.click <=< WD.findElem $ WD.ById "two"
959+ WD.click <=< findElemWithRetry $ WD.ById "two"
673− liftIO $ do
960+ readRef valueByUIRef `shouldBeWithRetryM` "two"
674− threadDelay 100000
961+ readRef valueRef `shouldBeWithRetryM` "two"
675− readIORef valueByUIRef >>= flip shouldBe "two"
676− readIORef valueRef >>= flip shouldBe "two"
677− writeChan setValueChan "three"
962+ liftIO $ writeChan setValueChan "three"
678− threadDelay 100000
963+ readRef valueByUIRef `shouldBeWithRetryM` "two"
679− readIORef valueByUIRef >>= flip shouldBe "two"
964+ readRef valueRef `shouldBeWithRetryM` "three"
680− readIORef valueRef >>= flip shouldBe "three"
681 testWidget (pure ()) checkValue $ do
965 testWidget (pure ()) checkValue $ do
682 setValue' <- triggerEventWithChan setValueChan
966 setValue' <- triggerEventWithChan setValueChan
683 (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
967 (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
684− performEvent_ $ liftIO . writeIORef valueByUIRef <$> _selectElement_change e
968+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
685− performEvent_ $ liftIO . writeIORef valueRef <$> updated (_selectElement_value e)
969+ performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
686
970
687 describe "hydration/immediate" $ do
971 describe "hydration/immediate" $ do
688− it "captures user input after switchover" $ do
972+ it "captures user input after switchover" $ runWD $ do
689− inputRef :: IORef Text <- newIORef ""
973+ inputRef :: IORef Text <- newRef ""
690 let checkValue = do
974 let checkValue = do
691− WD.click <=< WD.findElem $ WD.ById "two"
975+ WD.click <=< findElemWithRetry $ WD.ById "two"
692− WD.click <=< WD.findElem $ WD.ByTag "button"
976+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
693− liftIO $ readIORef inputRef >>= flip shouldBe "two"
977+ readRef inputRef `shouldBeWithRetryM` "two"
694− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
978+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
695 (e, ()) <- selectElement def options
979 (e, ()) <- selectElement def options
696 click <- button "save"
980 click <- button "save"
697− performEvent_ $ liftIO . writeIORef inputRef <$> tag (current (_selectElement_value e)) click
981+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
698− it "sets focus appropriately" $ do
982+ it "sets focus appropriately" $ runWD $ do
699− focusRef <- newIORef False
983+ focusRef <- newRef False
700 let checkValue = do
984 let checkValue = do
701− liftIO $ readIORef focusRef >>= flip shouldBe False
985+ readRef focusRef `shouldBeWithRetryM` False
702− e <- WD.findElem $ WD.ByTag "select"
986+ e <- findElemWithRetry $ WD.ByTag "select"
703 WD.click e
987 WD.click e
704− liftIO $ threadDelay 100000
988+ readRef focusRef `shouldBeWithRetryM` True
705− liftIO $ readIORef focusRef >>= flip shouldBe True
706− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
989+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
707 (e, ()) <- selectElement def options
990 (e, ()) <- selectElement def options
708− performEvent_ $ liftIO . writeIORef focusRef <$> updated (_selectElement_hasFocus e)
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
709− it "sets value appropriately" $ do
999+ it "sets value appropriately" $ runWD $ do
710− valueByUIRef :: IORef Text <- newIORef ""
1000+ valueByUIRef :: IORef Text <- newRef ""
711− valueRef :: IORef Text <- newIORef ""
1001+ valueRef :: IORef Text <- newRef ""
712− setValueChan :: Chan Text <- newChan
1002+ setValueChan :: Chan Text <- liftIO newChan
713 let checkValue = do
1003 let checkValue = do
714− liftIO $ readIORef valueByUIRef >>= flip shouldBe "one"
715− liftIO $ readIORef valueRef >>= flip shouldBe "one"
716− WD.click <=< WD.findElem $ WD.ById "two"
1004+ WD.click =<< findElemWithRetry (WD.ById "two")
717− liftIO $ do
1005+ readRef valueByUIRef `shouldBeWithRetryM` "two"
718− threadDelay 100000
1006+ readRef valueRef `shouldBeWithRetryM` "two"
719− readIORef valueByUIRef >>= flip shouldBe "two"
720− readIORef valueRef >>= flip shouldBe "two"
721− writeChan setValueChan "three"
1007+ liftIO $ writeChan setValueChan "three"
722− threadDelay 100000
1008+ readRef valueByUIRef `shouldBeWithRetryM` "two"
723− readIORef valueByUIRef >>= flip shouldBe "two"
1009+ readRef valueRef `shouldBeWithRetryM` "three"
724− readIORef valueRef >>= flip shouldBe "three"
725− testWidget (pure ()) checkValue $ prerender (pure ()) $ do
1010+ testWidget (pure ()) checkValue $ do
726 setValue' <- triggerEventWithChan setValueChan
1011 setValue' <- triggerEventWithChan setValueChan
1012+ prerender_ (pure ()) $ do
727− (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
1013+ (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
728− performEvent_ $ liftIO . writeIORef valueByUIRef <$> _selectElement_change e
1014+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
729− performEvent_ $ liftIO . writeIORef valueRef <$> updated (_selectElement_value e)
1015+ performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
730−
731− let createRawElement :: DOM.MonadJSM m => m DOM.Element
732− createRawElement = do
733− doc <- DOM.currentDocumentUnchecked
734− div <- Document.createElement doc ("div" :: Text)
735− Element.setAttribute div ("id" :: Text) ("raw" :: Text)
736− text <- Document.createTextNode doc ("two" :: Text)
737− Node.appendChild div text
738− pure div
739− describe "placeRawElement" $ do
740− let checkOrder = do
741− shouldContainText "two" <=< WD.findElem $ WD.ByTag "div"
742− shouldContainText "one\ntwo\nthree" <=< WD.findElem $ WD.ByTag "body"
743− it "is placed correctly in the DOM at switchover" $ do
744− testWidget (pure ()) checkOrder $ do
745− text "one"
746− prerender (pure ()) $ placeRawElement =<< createRawElement
747− text "three"
748− it "is placed correctly in the DOM in immediate mode" $ do
749− testWidget (pure ()) checkOrder $ prerender (pure ()) $ do
750− text "one"
751− placeRawElement =<< createRawElement
752− text "three"
753− it "is placed correctly in the DOM in hydration mode" $ do
754− testWidget (pure ()) checkOrder $ do
755− text "one"
756− mElement <- prerender (pure Nothing) $ Just <$> createRawElement
757− traverse_ placeRawElement mElement
758− text "three"
759− it "can be clicked" $ do
760− clickedRef <- newIORef False
761− let check = WD.click <=< WD.findElem $ WD.ByTag "div"
762− testWidget (pure ()) check $ prerender (pure ()) $ do
763− raw <- createRawElement
764− placeRawElement raw
765− let htmlElement = DOM.uncheckedCastTo DOM.HTMLElement raw
766− liftJSM $ htmlElement `EventM.on` Events.click $ do
767− liftIO $ writeIORef clickedRef True
768− return ()
769− clicked <- readIORef clickedRef
770− assertEqual "Not clicked" True clicked
771−
772− describe "wrapRawElement" $ do
773− it "modifies attributes" $ do
774− modifyAttrsChan :: Chan (Map AttributeName (Maybe Text)) <- newChan
775− let check = do
776− div <- WD.findElem $ WD.ByTag "div"
777− assertAttr div "test" Nothing
778− liftIO $ writeChan modifyAttrsChan ("test" =: Just "test")
779− assertAttr div "test" (Just "test")
780− testWidget (pure ()) check $ prerender (pure ()) $ do
781− modifyAttrs <- triggerEventWithChan modifyAttrsChan
782− raw <- createRawElement
783− placeRawElement raw
784− wrapRawElement raw $ RawElementConfig
785− { _rawElementConfig_modifyAttributes = Just modifyAttrs
786− , _rawElementConfig_eventSpec = (def :: EventSpec GhcjsDomSpace EventResult)
787− }
788− return ()
789− it "works with eventFlags" $ do
790− clickedRef <- newIORef False
791− let clickBoth = do
792− liftIO $ readIORef clickedRef >>= flip shouldBe False
793− WD.findElem (WD.ById "normal") >>= WD.click
794− liftIO $ do
795− readIORef clickedRef >>= flip shouldBe True
796− writeIORef clickedRef False
797− WD.findElem (WD.ById "raw") >>= WD.click
798− liftIO $ do
799− threadDelay 100000
800− readIORef clickedRef >>= flip shouldBe False
801− testWidget (pure ()) clickBoth $ prerender (pure ()) $ do
802− (e, _) <- el' "div" $ do
803− raw <- createRawElement
804− placeRawElement raw
805− wrapRawElement raw $ RawElementConfig
806− { _rawElementConfig_modifyAttributes = Nothing
807− , _rawElementConfig_eventSpec = addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> stopPropagation) (def :: EventSpec GhcjsDomSpace EventResult)
808− }
809− elAttr "div" ("id" =: "normal") $ text "normal"
810− performEvent_ $ liftIO (writeIORef clickedRef True) <$ domEvent Click e
811
1016
812− describe "prerender" $ do
1017+ session' "prerender" $ do
813− it "works in simple case" $ do
1018+ it "works in simple case" $ runWD $ do
814 testWidget (checkBodyText "One") (checkBodyText "Two") $ do
1019 testWidget (checkBodyText "One") (checkBodyText "Two") $ do
815− prerender (text "One") (text "Two")
1020+ prerender_ (text "One") (text "Two")
816− it "removes element correctly" $ do
1021+ it "removes element correctly" $ runWD $ do
817− testWidget' (WD.findElem $ WD.ByTag "span") elementShouldBeRemoved $ do
1022+ testWidget' (findElemWithRetry $ WD.ByTag "span") elementShouldBeRemoved $ do
818− prerender (el "span" $ text "One") (text "Two")
1023+ prerender_ (el "span" $ text "One") (text "Two")
819− it "can be nested in server widget" $ do
1024+ it "can be nested in server widget" $ runWD $ do
820 testWidget (checkBodyText "One") (checkBodyText "Three") $ do
1025 testWidget (checkBodyText "One") (checkBodyText "Three") $ do
821− prerender (prerender (text "One") (text "Two")) (text "Three")
1026+ prerender_ (prerender_ (text "One") (text "Two")) (text "Three")
822− it "can be nested in client widget" $ do
1027+ it "can be nested in client widget" $ runWD $ do
823 testWidget (checkBodyText "One") (checkBodyText "Three") $ do
1028 testWidget (checkBodyText "One") (checkBodyText "Three") $ do
824− prerender (text "One") (prerender (text "Two") (text "Three"))
1029+ prerender_ (text "One") (prerender_ (text "Two") (text "Three"))
825− it "works with prerender siblings" $ do
1030+ it "works with prerender_ siblings" $ runWD $ do
826 testWidget
1031 testWidget
827 (checkTextInId "a1" "One" >> checkTextInId "b1" "Three" >> checkTextInId "c1" "Five")
1032 (checkTextInId "a1" "One" >> checkTextInId "b1" "Three" >> checkTextInId "c1" "Five")
828 (checkTextInId "a2" "Two" >> checkTextInId "b2" "Four" >> checkTextInId "c2" "Six") $ do
1033 (checkTextInId "a2" "Two" >> checkTextInId "b2" "Four" >> checkTextInId "c2" "Six") $ do
829− prerender (divId "a1" $ text "One") (divId "a2" $ text "Two")
1034+ prerender_ (divId "a1" $ text "One") (divId "a2" $ text "Two")
830− prerender (divId "b1" $ text "Three") (divId "b2" $ text "Four")
1035+ prerender_ (divId "b1" $ text "Three") (divId "b2" $ text "Four")
831− prerender (divId "c1" $ text "Five") (divId "c2" $ text "Six")
1036+ prerender_ (divId "c1" $ text "Five") (divId "c2" $ text "Six")
832− it "works inside other element" $ do
1037+ it "works inside other element" $ runWD $ do
833 testWidget (checkTextInTag "div" "One") (checkTextInTag "div" "Two") $ do
1038 testWidget (checkTextInTag "div" "One") (checkTextInTag "div" "Two") $ do
834− el "div" $ prerender (text "One") (text "Two")
1039+ el "div" $ prerender_ (text "One") (text "Two")
1040+-- TODO re-enable this
835− it "places fences and removes them" $ do
1041+-- it "places fences and removes them" $ runWD $ do
836− testWidget'
1042+-- testWidget'
837− (do
1043+-- (do
838− scripts <- WD.findElems $ WD.ByTag "script"
1044+-- scripts <- WD.findElems $ WD.ByTag "script"
839− filterM (\s -> maybe False (\t -> "prerender" `T.isPrefixOf` t) <$> WD.attr s "type") scripts
1045+-- filterM (\s -> maybe False (\t -> "prerender" `T.isPrefixOf` t) <$> WD.attr s "type") scripts
840− )
1046+-- )
841− (traverse_ elementShouldBeRemoved)
1047+-- (traverse_ elementShouldBeRemoved)
842− (el "span" $ prerender (text "One") (text "Two"))
1048+-- (el "span" $ prerender_ (text "One") (text "Two"))
843−-- it "postBuild works on server side" $ do
1049+ it "postBuild works on server side" $ runWD $ do
844−-- pbRef <- newIORef False
1050+ lock :: MVar () <- liftIO newEmptyMVar
845−-- testWidgetStatic (pure ()) $ do
1051+ testWidget (liftIO $ takeMVar lock) (pure ()) $ do
846−-- prerender (do
1052+ prerender_ (do
847−-- pb <- getPostBuild
848−-- performEvent_ $ liftIO (writeIORef pbRef True) <$ pb) blank
849−-- readIORef pbRef >>= (`shouldBe` True)
850− it "postBuild works on client side" $ do
851− pbRef <- newIORef False
852− testWidgetStatic (pure ()) $ do
853− prerender blank $ do
854 pb <- getPostBuild
1053 pb <- getPostBuild
855− performEvent_ $ liftIO (writeIORef pbRef True) <$ pb
1054+ performEvent_ $ liftIO (putMVar lock ()) <$ pb) blank
856− readIORef pbRef >>= (`shouldBe` True)
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 ()
857
1094
858− describe "runWithReplace" $ do
1095+ session' "runWithReplace" $ do
859− it "works" $ do
1096+ it "works" $ runWD $ do
860− replaceChan <- newChan
1097+ replaceChan :: Chan Text <- liftIO newChan
861− let setup = WD.findElem $ WD.ByTag "div"
1098+ let setup = findElemWithRetry $ WD.ByTag "div"
862 check ssr = do
1099 check ssr = do
863 -- Check that the original element still exists and has the correct text
1100 -- Check that the original element still exists and has the correct text
864− WD.getText ssr >>= liftIO . flip shouldBe "two"
1101+ shouldContainText "two" ssr
865− liftIO $ do
866− writeChan replaceChan "three"
1102+ liftIO $ writeChan replaceChan "three"
867− threadDelay 100000
868 elementShouldBeRemoved ssr
1103 elementShouldBeRemoved ssr
869− shouldContainText "three" =<< WD.findElem (WD.ByTag "span")
1104+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
870 testWidget' setup check $ do
1105 testWidget' setup check $ do
871 replace <- triggerEventWithChan replaceChan
1106 replace <- triggerEventWithChan replaceChan
872 pb <- getPostBuild
1107 pb <- getPostBuild
873− runWithReplace (el "div" $ text "one") $ leftmost
1108+ void $ runWithReplace (el "div" $ text "one") $ leftmost
874 [ el "div" (text "two") <$ pb
1109 [ el "div" (text "two") <$ pb
875 , el "span" . text <$> replace
1110 , el "span" . text <$> replace
876 ]
1111 ]
877− return ()
878− it "can be nested in initial widget" $ do
1112+ it "can be nested in initial widget" $ runWD $ do
879− replaceChan <- newChan
1113+ replaceChan :: Chan Text <- liftIO newChan
880− let setup = WD.findElem $ WD.ByTag "div"
1114+ let setup = findElemWithRetry $ WD.ByTag "div"
881 check ssr = do
1115 check ssr = do
882 -- Check that the original element still exists and has the correct text
1116 -- Check that the original element still exists and has the correct text
883− WD.getText ssr >>= liftIO . flip shouldBe "two"
1117+ shouldContainText "two" ssr
884− liftIO $ do
885− writeChan replaceChan "three"
1118+ liftIO $ writeChan replaceChan "three"
886− threadDelay 100000
887 elementShouldBeRemoved ssr
1119 elementShouldBeRemoved ssr
888− shouldContainText "three" =<< WD.findElem (WD.ByTag "span")
1120+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
889 testWidget' setup check $ void $ flip runWithReplace never $ do
1121 testWidget' setup check $ void $ flip runWithReplace never $ do
890 replace <- triggerEventWithChan replaceChan
1122 replace <- triggerEventWithChan replaceChan
891 pb <- getPostBuild
1123 pb <- getPostBuild
892− runWithReplace (el "div" $ text "one") $ leftmost
1124+ void $ runWithReplace (el "div" $ text "one") $ leftmost
893 [ el "div" (text "two") <$ pb
1125 [ el "div" (text "two") <$ pb
894 , el "span" . text <$> replace
1126 , el "span" . text <$> replace
895 ]
1127 ]
896− return ()
897− it "can be nested in postBuild widget" $ do
1128+ it "can be nested in postBuild widget" $ runWD $ do
898− replaceChan <- newChan
1129+ replaceChan :: Chan Text <- liftIO newChan
899− let setup = WD.findElem $ WD.ByTag "div"
1130+ let setup = findElemWithRetry $ WD.ByTag "div"
900 check ssr = do
1131 check ssr = do
901 -- Check that the original element still exists and has the correct text
1132 -- Check that the original element still exists and has the correct text
902− WD.getText ssr >>= liftIO . flip shouldBe "two"
1133+ shouldContainText "two" ssr
903− liftIO $ do
904− writeChan replaceChan "three"
1134+ liftIO $ writeChan replaceChan "three"
905− threadDelay 100000
906 elementShouldBeRemoved ssr
1135 elementShouldBeRemoved ssr
907− shouldContainText "three" =<< WD.findElem (WD.ByTag "span")
1136+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
908 testWidget' setup check $ void $ do
1137 testWidget' setup check $ void $ do
909 pb <- getPostBuild
1138 pb <- getPostBuild
910 runWithReplace (pure ()) $ ffor pb $ \() -> do
1139 runWithReplace (pure ()) $ ffor pb $ \() -> do
911 replace <- triggerEventWithChan replaceChan
1140 replace <- triggerEventWithChan replaceChan
912− pb <- getPostBuild
1141+ pb' <- getPostBuild
913− runWithReplace (el "div" $ text "one") $ leftmost
1142+ void $ runWithReplace (el "div" $ text "one") $ leftmost
914− [ el "div" (text "two") <$ pb
1143+ [ el "div" (text "two") <$ pb'
915 , el "span" . text <$> replace
1144 , el "span" . text <$> replace
916 ]
1145 ]
917− return ()
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
918− it "can be nested in event widget" $ do
1157+ it "can be nested in event widget" $ runWD $ do
919− replaceChan1 <- newChan
1158+ replaceChan1 :: Chan Text <- liftIO newChan
920− replaceChan2 <- newChan
1159+ replaceChan2 :: Chan Text <- liftIO newChan
1160+ lock :: MVar () <- liftIO newEmptyMVar
921 let check = do
1161 let check = do
922− shouldContainText "" =<< WD.findElem (WD.ByTag "body")
1162+ shouldContainText "" =<< findElemWithRetry (WD.ByTag "body")
923 liftIO $ do
1163 liftIO $ do
924 writeChan replaceChan1 "one"
1164 writeChan replaceChan1 "one"
925− threadDelay 100000
1165+ takeMVar lock
926− one <- WD.findElem $ WD.ByTag "div"
1166+ one <- findElemWithRetry $ WD.ByTag "div"
927− WD.getText one >>= liftIO . flip shouldBe "pb"
1167+ shouldContainText "pb" one
928− liftIO $ do
929− writeChan replaceChan2 "two"
1168+ liftIO $ writeChan replaceChan2 "two"
930− threadDelay 100000
931 elementShouldBeRemoved one
1169 elementShouldBeRemoved one
932− shouldContainText "two" =<< WD.findElem (WD.ByTag "span")
1170+ shouldContainText "two" =<< findElemWithRetry (WD.ByTag "span")
933 testWidget (pure ()) check $ void $ do
1171 testWidget (pure ()) check $ void $ do
934 replace1 <- triggerEventWithChan replaceChan1
1172 replace1 <- triggerEventWithChan replaceChan1
935 runWithReplace (pure ()) $ ffor replace1 $ \r1 -> do
1173 runWithReplace (pure ()) $ ffor replace1 $ \r1 -> do
936 replace2 <- triggerEventWithChan replaceChan2
1174 replace2 <- triggerEventWithChan replaceChan2
937 pb <- getPostBuild
1175 pb <- getPostBuild
1176+ performEvent_ $ liftIO (putMVar lock ()) <$ pb
938− runWithReplace (el "div" $ text r1) $ leftmost
1177+ void $ runWithReplace (el "div" $ text r1) $ leftmost
939 [ el "span" . text <$> replace2
1178 [ el "span" . text <$> replace2
940 , el "div" (text "pb") <$ pb
1179 , el "div" (text "pb") <$ pb
941 ]
1180 ]
942− return ()
1181+ it "prerender works in replaced widget" $ runWD $ do
943− it "works in immediate mode (RHS of prerender)" $ do
944− replaceChan :: Chan Text <- newChan
1182+ replaceChan <- liftIO newChan
1183+ lock :: MVar () <- liftIO newEmptyMVar
1184+ pbLock :: MVar () <- liftIO newEmptyMVar
945 let check = do
1185 let check = do
946− one <- WD.findElem $ WD.ByTag "div"
947− shouldContainText "one" =<< WD.findElem (WD.ByTag "body")
948− WD.getText one >>= liftIO . flip shouldBe "one"
949 liftIO $ do
1186 liftIO $ do
950− writeChan replaceChan "pb"
1187+ writeChan replaceChan ()
951− threadDelay 100000
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"
952 elementShouldBeRemoved one
1215 elementShouldBeRemoved one
953− shouldContainText "pb" =<< WD.findElem (WD.ByTag "span")
1216+ shouldContainText "pb" =<< findElemWithRetry (WD.ByTag "span")
954 testWidget (pure ()) check $ void $ do
1217 testWidget (pure ()) check $ void $ do
955− prerender blank $ do
956− replace <- triggerEventWithChan replaceChan
1218+ replace <- triggerEventWithChan replaceChan
957− pb <- getPostBuild
1219+ prerender_ blank $ do
958 void $ runWithReplace (el "div" $ text "one") $ el "span" . text <$> replace
1220 void $ runWithReplace (el "div" $ text "one") $ el "span" . text <$> replace
959− it "works with postBuild in immediate mode (RHS of prerender)" $ do
1221+ it "works with postBuild in immediate mode (RHS of prerender)" $ runWD $ do
960− replaceChan :: Chan Text <- newChan
1222+ replaceChan :: Chan Text <- liftIO newChan
961 let check = do
1223 let check = do
1224+ checkBodyText "two"
962− two <- WD.findElem $ WD.ByTag "div"
1225+ two <- findElemWithRetry $ WD.ByTag "div"
963− shouldContainText "two" =<< WD.findElem (WD.ByTag "body")
1226+ shouldContainText "two" two
964− WD.getText two >>= liftIO . flip shouldBe "two"
965− liftIO $ do
966− writeChan replaceChan "three"
1227+ liftIO $ writeChan replaceChan "three"
967− threadDelay 100000
968 elementShouldBeRemoved two
1228 elementShouldBeRemoved two
969− shouldContainText "three" =<< WD.findElem (WD.ByTag "span")
1229+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
970 testWidget (pure ()) check $ void $ do
1230 testWidget (pure ()) check $ void $ do
971− prerender blank $ do
972− replace <- triggerEventWithChan replaceChan
1231+ replace <- triggerEventWithChan replaceChan
1232+ prerender_ blank $ do
973 pb <- getPostBuild
1233 pb <- getPostBuild
974 void $ runWithReplace (el "div" $ text "one") $ leftmost
1234 void $ runWithReplace (el "div" $ text "one") $ leftmost
975 [ el "div" (text "two") <$ pb
1235 [ el "div" (text "two") <$ pb
976 , el "span" . text <$> replace
1236 , el "span" . text <$> replace
977 ]
1237 ]
978
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+
979− describe "traverseDMapWithKeyWithAdjust" $ do
1293+ session' "traverseDMapWithKeyWithAdjust" $ do
980− let widget :: TestWidget js t m => DKey a -> Identity a -> m (Identity a)
1294+ let widget :: DomBuilder t m => DKey a -> Identity a -> m (Identity a)
981 widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
1295 widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
982 elClass "span" "key" $ text $ textKey k
1296 elClass "span" "key" $ text $ textKey k
983 elClass "span" "value" $ text $ T.pack $ has @Show k $ show v
1297 elClass "span" "value" $ text $ T.pack $ has @Show k $ show v
984 pure (Identity v)
1298 pure (Identity v)
985 checkItem :: WD.Element -> Text -> Text -> WD ()
1299 checkItem :: WD.Element -> Text -> Text -> WD ()
986 checkItem li k v = do
1300 checkItem li k v = do
1301+ putStrLnDebug "checkItem"
987− shouldContainText k =<< WD.findElemFrom li (WD.ByClass "key")
1302+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
988− shouldContainText v =<< WD.findElemFrom li (WD.ByClass "value")
1303+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
989 checkInitialItems dm xs = do
1304 checkInitialItems dm xs = do
1305+ putStrLnDebug "checkInitialItems"
990 liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
1306 liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
991 forM_ (zip xs (DMap.toList dm)) $ \(e, k :=> Identity v) -> checkItem e (textKey k) (T.pack $ has @Show k $ show v)
1307 forM_ (zip xs (DMap.toList dm)) $ \(e, k :=> Identity v) -> checkItem e (textKey k) (T.pack $ has @Show k $ show v)
992− getAndCheckInitialItems dm = do
1308+ getAndCheckInitialItems dm = withRetry $ do
1309+ putStrLnDebug "getAndCheckInitialItems"
993 xs <- WD.findElems (WD.ByTag "li")
1310 xs <- WD.findElems (WD.ByTag "li")
994 checkInitialItems dm xs
1311 checkInitialItems dm xs
995 pure xs
1312 pure xs
996 checkRemoval chan k = do
1313 checkRemoval chan k = do
1314+ putStrLnDebug "checkRemoval"
997− e <- WD.findElem (WD.ById $ textKey k)
1315+ e <- findElemWithRetry (WD.ById $ textKey k)
998− liftIO $ do
999− writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe Nothing)
1316+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe Nothing)
1000− threadDelay 100000
1001 elementShouldBeRemoved e
1317 elementShouldBeRemoved e
1002 checkReplace chan k v = do
1318 checkReplace chan k v = do
1319+ putStrLnDebug "checkReplace"
1003− e <- WD.findElem (WD.ById $ textKey k)
1320+ e <- findElemWithRetry (WD.ById $ textKey k)
1004− liftIO $ do
1005− writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1321+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1006− threadDelay 100000
1007 elementShouldBeRemoved e
1322 elementShouldBeRemoved e
1008− e' <- WD.findElem (WD.ById $ textKey k)
1323+ e' <- findElemWithRetry $ WD.ById $ textKey k
1009 checkItem e' (textKey k) (T.pack $ show v)
1324 checkItem e' (textKey k) (T.pack $ show v)
1010 checkInsert chan k v = do
1325 checkInsert chan k v = do
1011− liftIO $ do
1326+ putStrLnDebug "checkInsert"
1012− writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1327+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1013− threadDelay 100000
1014− e <- WD.findElem (WD.ById $ textKey k)
1328+ e <- findElemWithRetry (WD.ById $ textKey k)
1015 checkItem e (textKey k) (T.pack $ show v)
1329 checkItem e (textKey k) (T.pack $ show v)
1016 postBuildPatch = PatchDMap $ DMap.fromList [Key_Char :=> ComposeMaybe Nothing, Key_Bool :=> ComposeMaybe (Just $ Identity True)]
1330 postBuildPatch = PatchDMap $ DMap.fromList [Key_Char :=> ComposeMaybe Nothing, Key_Bool :=> ComposeMaybe (Just $ Identity True)]
1017− it "doesn't replace elements at switchover, can delete/update/insert" $ do
1331+ it "doesn't replace elements at switchover, can delete/update/insert" $ runWD $ do
1018− chan <- newChan
1332+ chan <- liftIO newChan
1333+ let preSwitchover :: WD [WD.Element]
1019− let static = getAndCheckInitialItems keyMap
1334+ preSwitchover = getAndCheckInitialItems keyMap
1335+ check :: [WD.Element] -> WD ()
1020 check xs = do
1336 check xs = do
1021 checkInitialItems keyMap xs
1337 checkInitialItems keyMap xs
1022 checkRemoval chan Key_Int
1338 checkRemoval chan Key_Int
1023 checkReplace chan Key_Char 'B'
1339 checkReplace chan Key_Char 'B'
1024 checkInsert chan Key_Bool True
1340 checkInsert chan Key_Bool True
1025− testWidget' static check $ void $ do
1341+ testWidget' preSwitchover check $ do
1026 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1342 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1027− liftIO $ dmap `shouldBe` keyMap
1343+ liftIO $ dmap `H.shouldBe` keyMap
1028− it "handles postBuild correctly" $ do
1344+ it "handles postBuild correctly" $ runWD $ do
1029− chan <- newChan
1345+ chan <- liftIO newChan
1030− let static = getAndCheckInitialItems (fromJust $ apply postBuildPatch keyMap)
1346+ let preSwitchover = getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
1031 check xs = do
1347 check xs = do
1032− checkInitialItems (fromMaybe undefined $ apply postBuildPatch keyMap) xs
1348+ withRetry $ checkInitialItems (applyAlways postBuildPatch keyMap) xs
1033 checkRemoval chan Key_Int
1349 checkRemoval chan Key_Int
1034 checkInsert chan Key_Char 'B'
1350 checkInsert chan Key_Char 'B'
1035 checkReplace chan Key_Bool True
1351 checkReplace chan Key_Bool True
1036− testWidget' static check $ void $ do
1352+ testWidget' preSwitchover check $ void $ do
1037 pb <- getPostBuild
1353 pb <- getPostBuild
1038 replace <- triggerEventWithChan chan
1354 replace <- triggerEventWithChan chan
1039 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1355 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1040− liftIO $ dmap `shouldBe` keyMap
1356+ liftIO $ dmap `H.shouldBe` keyMap
1041− it "can delete/update/insert when built in prerender" $ do
1357+ it "can delete/update/insert when built in prerender" $ runWD $ do
1042− chan <- newChan
1358+ chan <- liftIO newChan
1043 let check = do
1359 let check = do
1044− getAndCheckInitialItems keyMap
1360+ _ <- getAndCheckInitialItems keyMap
1045 checkRemoval chan Key_Int
1361 checkRemoval chan Key_Int
1046 checkReplace chan Key_Char 'B'
1362 checkReplace chan Key_Char 'B'
1047 checkInsert chan Key_Bool True
1363 checkInsert chan Key_Bool True
1048− testWidget (pure ()) check $ prerender (pure ()) $ void $ do
1364+ testWidget (pure ()) check $ do
1365+ replace <- triggerEventWithChan chan
1366+ prerender_ (pure ()) $ do
1049− (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1367+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap replace
1050− liftIO $ dmap `shouldBe` keyMap
1368+ liftIO $ dmap `H.shouldBe` keyMap
1051− it "can delete/update/insert when built in immediate mode" $ do
1369+ it "can delete/update/insert when built in immediate mode" $ runWD $ do
1052− chan <- newChan
1370+ chan <- liftIO newChan
1053 let check = do
1371 let check = do
1054− getAndCheckInitialItems keyMap
1372+ _ <- getAndCheckInitialItems keyMap
1055 checkRemoval chan Key_Int
1373 checkRemoval chan Key_Int
1056 checkReplace chan Key_Char 'B'
1374 checkReplace chan Key_Char 'B'
1057 checkInsert chan Key_Bool True
1375 checkInsert chan Key_Bool True
@@ -1059,131 +1377,452 @@ main = hspec $ beforeAll startSeleniumServer $ do
1059 pb <- getPostBuild
1377 pb <- getPostBuild
1060 runWithReplace (pure ()) $ ffor pb $ \() -> void $ do
1378 runWithReplace (pure ()) $ ffor pb $ \() -> void $ do
1061 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1379 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1062− liftIO $ dmap `shouldBe` keyMap
1380+ liftIO $ dmap `H.shouldBe` keyMap
1063 -- Should be fixed by prerender changes!
1381 -- Should be fixed by prerender changes!
1064− it "handles postBuild correctly in prerender" $ do
1382+ it "handles postBuild correctly in prerender" $ runWD $ do
1065− chan <- newChan
1383+ chan <- liftIO newChan
1066 let check = do
1384 let check = do
1067− getAndCheckInitialItems (fromJust $ apply postBuildPatch keyMap)
1385+ _ <- getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
1068 checkRemoval chan Key_Int
1386 checkRemoval chan Key_Int
1069 checkInsert chan Key_Char 'B'
1387 checkInsert chan Key_Char 'B'
1070 checkReplace chan Key_Bool True
1388 checkReplace chan Key_Bool True
1071 testWidget (pure ()) check $ do
1389 testWidget (pure ()) check $ do
1072 replace <- triggerEventWithChan chan
1390 replace <- triggerEventWithChan chan
1073− prerender (pure ()) $ void $ do
1391+ prerender_ (pure ()) $ void $ do
1074 pb <- getPostBuild
1392 pb <- getPostBuild
1075 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1393 (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1076− liftIO $ dmap `shouldBe` keyMap
1394+ liftIO $ dmap `H.shouldBe` keyMap
1077
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+
1078−startSeleniumServer :: IO ()
1638+startSeleniumServer :: PortNumber -> IO (IO ())
1079−startSeleniumServer = do
1639+startSeleniumServer port = do
1080− (_,_,_,ph) <- createProcess $ (proc "selenium-server" [])
1640+ (_,_,_,ph) <- createProcess $ (proc "selenium-server" ["-port", show port])
1081 { std_in = NoStream
1641 { std_in = NoStream
1082 , std_out = NoStream
1642 , std_out = NoStream
1083 , std_err = NoStream
1643 , std_err = NoStream
1084 }
1644 }
1085− _ <- forkIO $ print =<< waitForProcess ph
1645+ return $ terminateProcess ph
1646+
1647+withSeleniumServer :: (Selenium -> IO ()) -> IO ()
1648+withSeleniumServer f = do
1649+ stopServer <- startSeleniumServer seleniumPort
1086 threadDelay $ 1000 * 1000 * 2 -- TODO poll or wait on a a signal to block on
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+ }
1087
1655
1088−triggerEventWithChan :: (TriggerEvent t m, Prerender js m) => Chan a -> m (Event t a)
1656+triggerEventWithChan :: (Reflex t, TriggerEvent t m, Prerender js t m) => Chan a -> m (Event t a)
1089triggerEventWithChan chan = do
1657triggerEventWithChan chan = do
1090 (e, trigger) <- newTriggerEvent
1658 (e, trigger) <- newTriggerEvent
1659+ -- In prerender because we only want to do this on the client
1091− prerender (pure ()) $ void $ liftIO $ forkIO $ forever $ trigger =<< readChan chan
1660+ prerender_ (pure ()) $ void $ liftIO $ forkIO $ forever $ trigger =<< readChan chan
1092 pure e
1661 pure e
1093
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+
1094assertAttr :: WD.Element -> Text -> Maybe Text -> WD ()
1668assertAttr :: WD.Element -> Text -> Maybe Text -> WD ()
1095assertAttr e k v = liftIO . assertEqual "Incorrect attribute value" v =<< WD.attr e k
1669assertAttr e k v = liftIO . assertEqual "Incorrect attribute value" v =<< WD.attr e k
1096
1670
1097elementShouldBeRemoved :: WD.Element -> WD ()
1671elementShouldBeRemoved :: WD.Element -> WD ()
1098−elementShouldBeRemoved e = do
1672+elementShouldBeRemoved e = withRetry $ do
1099 try (WD.getText e) >>= \case
1673 try (WD.getText e) >>= \case
1100 Left (WD.FailedCommand WD.StaleElementReference _) -> return ()
1674 Left (WD.FailedCommand WD.StaleElementReference _) -> return ()
1101− Left e -> throwM e
1675+ Left err -> throwM err
1102 Right !_ -> liftIO $ assertFailure "Expected element to be removed, but it still exists"
1676 Right !_ -> liftIO $ assertFailure "Expected element to be removed, but it still exists"
1103
1677
1104shouldContainText :: Text -> WD.Element -> WD ()
1678shouldContainText :: Text -> WD.Element -> WD ()
1679+shouldContainText t = withRetry . shouldContainTextNoRetry t
1680+
1681+shouldContainTextNoRetry :: Text -> WD.Element -> WD ()
1105−shouldContainText t = liftIO . flip shouldBe t <=< WD.getText
1682+shouldContainTextNoRetry t = flip shouldBe t <=< WD.getText
1106
1683
1107checkBodyText :: Text -> WD ()
1684checkBodyText :: Text -> WD ()
1108checkBodyText = checkTextInTag "body"
1685checkBodyText = checkTextInTag "body"
1109
1686
1110checkTextInTag :: Text -> Text -> WD ()
1687checkTextInTag :: Text -> Text -> WD ()
1688+checkTextInTag t expected = do
1689+ e <- findElemWithRetry (WD.ByTag t)
1111−checkTextInTag tag expected = WD.findElem (WD.ByTag tag) >>= shouldContainText expected
1690+ shouldContainText expected e
1112
1691
1113checkTextInId :: Text -> Text -> WD ()
1692checkTextInId :: Text -> Text -> WD ()
1114−checkTextInId i expected = WD.findElem (WD.ById i) >>= shouldContainText expected
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
1115
1715
1116divId :: DomBuilder t m => Text -> m a -> m a
1716divId :: DomBuilder t m => Text -> m a -> m a
1117divId i = elAttr "div" ("id" =: i)
1717divId i = elAttr "div" ("id" =: i)
1118
1718
1119−type TestWidget js t m = (DomBuilder t m, MonadHold t m, PostBuild t m, Prerender js m, PerformEvent t m, TriggerEvent t m, MonadFix m, MonadIO (Performable m), MonadFix m, MonadIO m)
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)
1120
1720
1121−testWidgetStatic
1721+testWidgetStaticDebug
1722+ :: Bool
1122− :: WD b
1723+ -> WD b
1123 -- ^ Webdriver commands to run before JS runs and after hydration switchover
1724 -- ^ Webdriver commands to run before JS runs and after hydration switchover
1124 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1725 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1125 -- ^ Widget we are testing
1726 -- ^ Widget we are testing
1126− -> IO b
1727+ -> WD b
1127−testWidgetStatic w = testWidget (void w) w
1728+testWidgetStaticDebug withDebugging w = testWidgetDebug True withDebugging (void w) w
1128
1729
1129-- | TODO: do something about JSExceptions not causing tests to fail
1730-- | TODO: do something about JSExceptions not causing tests to fail
1130−testWidget
1731+testWidgetDebug
1732+ :: Bool
1733+ -> Bool
1131− :: WD ()
1734+ -> WD ()
1132 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1735 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1133 -> WD b
1736 -> WD b
1134 -- ^ Webdriver commands to run after hydration switchover
1737 -- ^ Webdriver commands to run after hydration switchover
1135 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1738 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1136 -- ^ Widget we are testing
1739 -- ^ Widget we are testing
1137− -> IO b
1740+ -> WD b
1741+testWidgetDebug hardFailure withDebugging beforeJS afterSwitchover =
1138−testWidget beforeJS afterSwitchover = testWidget' beforeJS (const afterSwitchover)
1742+ testWidgetDebug' hardFailure withDebugging beforeJS (const afterSwitchover)
1743+
1744+data HydrationFailedException = HydrationFailedException deriving Show
1745+instance Exception HydrationFailedException
1139
1746
1140-- | TODO: do something about JSExceptions not causing tests to fail
1747-- | TODO: do something about JSExceptions not causing tests to fail
1141−testWidget'
1748+testWidgetDebug'
1749+ :: Bool
1750+ -> Bool
1142− :: WD a
1751+ -> WD a
1143 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1752 -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1144 -> (a -> WD b)
1753 -> (a -> WD b)
1145 -- ^ Webdriver commands to run after hydration switchover
1754 -- ^ Webdriver commands to run after hydration switchover
1146 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1755 -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1147 -- ^ Widget we are testing (contents of body)
1756 -- ^ Widget we are testing (contents of body)
1148− -> IO b
1757+ -> WD b
1149−testWidget' beforeJS afterSwitchover bodyWidget = maybe (error "test timed out") pure <=< timeout testTimeLimit $ do
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
1150− let staticApp = do
1761+ staticApp = do
1151 el "head" $ pure ()
1762 el "head" $ pure ()
1152 el "body" $ do
1763 el "body" $ do
1153 bodyWidget
1764 bodyWidget
1154 el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
1765 el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
1766+ putStrLnDebug "rendering static"
1155− ((), html) <- renderStatic staticApp
1767+ ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
1768+ putStrLnDebug "rendered static"
1156− waitBeforeJS <- newEmptyMVar -- Empty until JS should be run
1769+ waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
1770+ onFailure <- if hardFailure then (`throwTo` HydrationFailedException) <$> liftIO myThreadId else pure $ pure ()
1157− waitUntilSwitchover <- newEmptyMVar -- Empty until switchover
1771+ waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
1158 let entryPoint = do
1772 let entryPoint = do
1773+ putStrLnDebug "taking waitBeforeJS"
1159 liftIO $ takeMVar waitBeforeJS
1774 liftIO $ takeMVar waitBeforeJS
1160− mainHydrationWidgetWithSwitchoverAction (putMVar waitUntilSwitchover ()) (pure ()) $ bodyWidget
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"
1161 syncPoint
1784 syncPoint
1162− application <- jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> sendResponse $ responseLBS status200 [] $ "<!doctype html>\n" <> LBS.fromStrict html
1785+ application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
1163− --port <- randomRIO (3000, 50000)
1786+ putStrLnDebug "sending response"
1164− let port = 3911 -- TODO
1787+ r <- sendResponse $ responseLBS status200 [] $ "<!doctype html>\n" <> LBS.fromStrict html
1788+ putStrLnDebug "sent response"
1789+ return r
1790+ waitJSaddle <- liftIO newEmptyMVar
1165− let settings = Warp.setPort port Warp.defaultSettings
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+ ]
1166 -- hSilence to get rid of ConnectionClosed logs
1798 -- hSilence to get rid of ConnectionClosed logs
1799+ silenceIfDebug = if withDebugging then id else hSilence [stderr]
1167− jsaddleWarp = forkIO $ hSilence [stderr] $ Warp.runSettings settings application
1800+ jsaddleWarp = silenceIfDebug $ Warp.runSettings settings application
1168− bracket jsaddleWarp killThread $ \_ -> do
1801+ withAsync' jsaddleWarp $ do
1169− WD.runSession chromeConfig . WD.finallyClose $ do
1802+ putStrLnDebug "taking waitJSaddle"
1803+ liftIO $ takeMVar waitJSaddle
1804+ putStrLnDebug "opening page"
1170− WD.openPage $ "http://localhost:" <> show port
1805+ WD.openPage $ "http://localhost:" <> show jsaddlePort
1806+ putStrLnDebug "running beforeJS"
1171− a <- beforeJS
1807+ a <- beforeJS
1808+ putStrLnDebug "putting waitBeforeJS"
1172− liftIO $ putMVar waitBeforeJS ()
1809+ liftIO $ putMVar waitBeforeJS ()
1173− liftIO $ takeMVar waitUntilSwitchover
1810+ putStrLnDebug "taking waitUntilSwitchover"
1174− liftIO $ threadDelay 100000 -- wait a bit
1811+ liftIO $ takeMVar waitUntilSwitchover
1812+ putStrLnDebug "running afterSwitchover"
1175− afterSwitchover a
1813+ afterSwitchover a
1176
1814
1177−testWidgetDebug :: (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> IO ()
1815+withAsync' :: (MonadIO m, MonadMask m) => IO a -> m b -> m b
1178−testWidgetDebug bodyWidget = do
1816+withAsync' f g = bracket
1179− let staticApp = do
1817+ (liftIO $ Async.async f)
1180− el "head" $ pure ()
1818+ (liftIO . Async.uninterruptibleCancel)
1181− el "body" $ do
1819+ (const g)
1182− bodyWidget
1820+
1183− el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
1821+data Key2 a where
1184− ((), html) <- renderStatic staticApp
1822+ Key2_Int :: Int -> Key2 Int
1185− let entryPoint = do
1823+ Key2_Char :: Char -> Key2 Char
1186− mainHydrationWidgetWithSwitchoverAction (pure ()) (pure ()) $ bodyWidget
1824+
1187− syncPoint
1825+deriveGEq ''Key2
1188− application <- jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> sendResponse $ responseLBS status200 [] $ "<!doctype html>\n" <> LBS.fromStrict html
1826+deriveGCompare ''Key2
1189− Warp.runSettings (Warp.setPort 3911 Warp.defaultSettings) application
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
2All rights reserved.
2All rights reserved.
3
3
4Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
reflex-dom/benchmark.hs+2−1
@@ -15,8 +15,9 @@ import qualified Data.Text as T
15import Reflex.Dom
15import Reflex.Dom
16import System.Random
16import System.Random
17import qualified Data.Map as Map
17import qualified Data.Map as Map
18−import Data.Dependent.Map (DMap (..), DSum (..))
18+import Data.Dependent.Map (DMap (..))
19import qualified Data.Dependent.Map as DMap
19import qualified Data.Dependent.Map as DMap
20+import Data.Dependent.Sum (DSum (..))
20import Data.Functor.Misc
21import Data.Functor.Misc
21import Data.Functor.Identity
22import Data.Functor.Identity
22import Data.Functor.Compose
23import Data.Functor.Compose
reflex-dom/benchmarks/krausest.hs+7−7
@@ -28,15 +28,15 @@ main = do
28 seed <- randomIO
28 seed <- randomIO
29 mainWidgetWithHead' (\_ -> headW, \_ -> bodyW seed)
29 mainWidgetWithHead' (\_ -> headW, \_ -> bodyW seed)
30
30
31−titleW :: MonadWidget t m => m ()
31+titleW :: DomBuilder t m => m ()
32titleW = text "Reflex-dom keyed"
32titleW = text "Reflex-dom keyed"
33
33
34−headW :: MonadWidget t m => m ()
34+headW :: DomBuilder t m => m ()
35headW = do
35headW = do
36 el "title" titleW
36 el "title" titleW
37 elAttr "link" ("href" =: "/css/currentStyle.css" <> "rel" =: "stylesheet") blank
37 elAttr "link" ("href" =: "/css/currentStyle.css" <> "rel" =: "stylesheet") blank
38
38
39−bodyW :: forall t m. MonadWidget t m => Entropy -> m ()
39+bodyW :: forall t m. (MonadFix m, MonadHold t m, DomBuilder t m) => Entropy -> m ()
40bodyW seed = divClass "main" $ divClass "container" $ mdo
40bodyW seed = divClass "main" $ divClass "container" $ mdo
41 buttonEvents <- divClass "jumbotron" $ divClass "row" $ do
41 buttonEvents <- divClass "jumbotron" $ divClass "row" $ do
42 divClass "col-md-6" $ el "h1" titleW
42 divClass "col-md-6" $ el "h1" titleW
@@ -75,14 +75,14 @@ step (m, t) f = ((m', t'), dt)
75 (m', dt) = f (m, t)
75 (m', dt) = f (m, t)
76 t' = applyAlways dt t
76 t' = applyAlways dt t
77
77
78−buttonW :: MonadWidget t m => Text -> Text -> a -> m (Event t a)
78+buttonW :: DomBuilder t m => Text -> Text -> a -> m (Event t a)
79buttonW id txt val = divClass "col-sm-6 smallpad" $ buttonW' ("class" =: "btn btn-primary btn-block" <> "id" =: id)
79buttonW id txt val = divClass "col-sm-6 smallpad" $ buttonW' ("class" =: "btn btn-primary btn-block" <> "id" =: id)
80 where
80 where
81 buttonW' attrs = do
81 buttonW' attrs = do
82 (b, _) <- elAttr' "button" attrs $ text txt
82 (b, _) <- elAttr' "button" attrs $ text txt
83 pure $ val <$ domEvent Click b
83 pure $ val <$ domEvent Click b
84
84
85−tableW :: MonadWidget t m => Event t TableDiff -> m (Event t (IntMap Step))
85+tableW :: (MonadHold t m, DomBuilder t m) => Event t TableDiff -> m (Event t (IntMap Step))
86tableW diff = do
86tableW diff = do
87 elClass "table" "table table-hover table-striped test-data" $ do
87 elClass "table" "table table-hover table-striped test-data" $ do
88 el "tbody" $ do
88 el "tbody" $ do
@@ -90,7 +90,7 @@ tableW diff = do
90 rowEvents <- holdIncremental v0 v'
90 rowEvents <- holdIncremental v0 v'
91 return $ mergeIntIncremental rowEvents
91 return $ mergeIntIncremental rowEvents
92
92
93−rowW :: MonadWidget t m => Row -> m (Event t Step)
93+rowW :: DomBuilder t m => Row -> m (Event t Step)
94rowW row = elClass "tr" (if selected row then "danger" else "") $
94rowW row = elClass "tr" (if selected row then "danger" else "") $
95 do
95 do
96 elClass "td" "col-md-1" $ do
96 elClass "td" "col-md-1" $ do
@@ -102,7 +102,7 @@ rowW row = elClass "tr" (if selected row then "danger" else "") $
102 where
102 where
103 tagClick f el = f row <$ (domEvent Click el)
103 tagClick f el = f row <$ (domEvent Click el)
104
104
105−deleteW :: MonadWidget t m => m ()
105+deleteW :: DomBuilder t m => m ()
106deleteW = el "a" $ elAttr "span" ("aria-hidden" =: "true" <> "class" =: "glyphicon glyphicon-remove") blank
106deleteW = el "a" $ elAttr "span" ("aria-hidden" =: "true" <> "class" =: "glyphicon glyphicon-remove") blank
107
107
108
108
reflex-dom/default.nixdeleted−37
@@ -1,37 +0,0 @@
1−{ mkDerivation, base, bytestring, jsaddle-webkit2gtk, jsaddle-wkwebview, jsaddle-warp, reflex
2−, reflex-dom-core, stdenv, text, ghc, hostPlatform, jsaddle-clib, android-activity ? null
3−, ghcBackend ? if hostPlatform.isDarwin then "warp" else "webkit2gtk"
4−}:
5−assert (builtins.elem ghcBackend [ "warp" "webkit2gtk" ]);
6−let isAndroid = hostPlatform.libc == "bionic";
7− ghcBackendPackage = {
8− webkit2gtk = jsaddle-webkit2gtk;
9− warp = jsaddle-warp;
10− }.${ghcBackend};
11−in mkDerivation {
12− pname = "reflex-dom";
13− version = "0.4";
14− src = builtins.filterSource (path: type: !(builtins.elem (baseNameOf path) [ ".git" "dist" ])) ./.;
15− libraryHaskellDepends = [
16− base bytestring reflex reflex-dom-core text
17− ] ++ (if ghc.isGhcjs or false then [
18− ] else if hostPlatform.isiOS then [
19− jsaddle-wkwebview
20− ] else if isAndroid then [
21− jsaddle-clib
22− android-activity
23− ] else if hostPlatform.isMacOS then [
24− jsaddle-wkwebview
25− ghcBackendPackage
26− ] else [
27− ghcBackendPackage
28− ]);
29− configureFlags = if isAndroid then [
30− "-fandroid"
31− ] else if ghcBackend == "warp" then [
32− "-fuse-warp"
33− ] else [
34− ];
35− description = "Functional Reactive Web Apps with Reflex";
36− license = stdenv.lib.licenses.bsd3;
37−}
reflex-dom/java/org/reflexfrp/reflexdom/MainWidget.java+21−2
@@ -8,6 +8,7 @@ import android.util.Log;
8import android.view.ViewGroup.LayoutParams;
8import android.view.ViewGroup.LayoutParams;
9import android.view.Window;
9import android.view.Window;
10import android.webkit.CookieManager;
10import android.webkit.CookieManager;
11+import android.webkit.GeolocationPermissions;
11import android.webkit.JavascriptInterface;
12import android.webkit.JavascriptInterface;
12import android.webkit.MimeTypeMap;
13import android.webkit.MimeTypeMap;
13import android.webkit.PermissionRequest;
14import android.webkit.PermissionRequest;
@@ -21,6 +22,8 @@ import android.graphics.Bitmap;
21import java.io.IOException;
22import java.io.IOException;
22import java.io.InputStream;
23import java.io.InputStream;
23import android.content.Intent;
24import android.content.Intent;
25+import android.content.ActivityNotFoundException;
26+import java.util.concurrent.atomic.AtomicBoolean;
24
27
25import java.nio.charset.StandardCharsets;
28import java.nio.charset.StandardCharsets;
26
29
@@ -44,11 +47,17 @@ public class MainWidget {
44 wv.setWebContentsDebuggingEnabled(true);
47 wv.setWebContentsDebuggingEnabled(true);
45 // allow video to play without user interaction
48 // allow video to play without user interaction
46 wv.getSettings().setMediaPlaybackRequiresUserGesture(false);
49 wv.getSettings().setMediaPlaybackRequiresUserGesture(false);
50+ final AtomicBoolean jsaddleLoaded = new AtomicBoolean(false);
47
51
48 wv.setWebViewClient(new WebViewClient() {
52 wv.setWebViewClient(new WebViewClient() {
49 @Override
53 @Override
50 public void onPageFinished(WebView _view, String _url) {
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");
51− wv.evaluateJavascript(initialJS, null);
59+ wv.evaluateJavascript(initialJS, null);
60+ }
52 }
61 }
53
62
54 // Re-route / to /android_asset
63 // Re-route / to /android_asset
@@ -79,7 +88,12 @@ public class MainWidget {
79 @Override
88 @Override
80 public boolean shouldOverrideUrlLoading(WebView view, String url) {
89 public boolean shouldOverrideUrlLoading(WebView view, String url) {
81 if( url != null && !url.startsWith("http://") && !url.startsWith("https://") && !url.startsWith("file://")) {
90 if( url != null && !url.startsWith("http://") && !url.startsWith("https://") && !url.startsWith("file://")) {
91+ try {
82− view.getContext().startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(url)));
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+ }
83 return true;
97 return true;
84 } else {
98 } else {
85 return false;
99 return false;
@@ -109,6 +123,11 @@ public class MainWidget {
109 public Bitmap getDefaultVideoPoster() {
123 public Bitmap getDefaultVideoPoster() {
110 return Bitmap.createBitmap(10, 10, Bitmap.Config.ARGB_8888);
124 return Bitmap.createBitmap(10, 10, Bitmap.Config.ARGB_8888);
111 }
125 }
126+
127+ @Override
128+ public void onGeolocationPermissionsShowPrompt(String origin, GeolocationPermissions.Callback callback) {
129+ callback.invoke(origin, true, false);
130+ }
112 });
131 });
113
132
114 wv.addJavascriptInterface(new JSaddleCallbacks(jsaddleCallbacks), "jsaddle");
133 wv.addJavascriptInterface(new JSaddleCallbacks(jsaddleCallbacks), "jsaddle");
reflex-dom/reflex-dom.cabal+84−35
@@ -1,7 +1,20 @@
1+cabal-version: 1.24
1Name: reflex-dom
2Name: reflex-dom
2−Version: 0.4
3+Version: 0.6.1.0
3Synopsis: Functional Reactive Web Apps with Reflex
4Synopsis: Functional Reactive Web Apps with Reflex
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+ .
4−Description: Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine
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>.
5License: BSD3
18License: BSD3
6License-file: LICENSE
19License-file: LICENSE
7Author: Ryan Trinkle
20Author: Ryan Trinkle
@@ -9,13 +22,9 @@ Maintainer: ryan.trinkle@gmail.com
9Stability: Experimental
22Stability: Experimental
10Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
23Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
11Build-type: Simple
24Build-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
25+extra-source-files:
15− src/Reflex/Dom/WebSocket/Foreign.hs
16− src/Reflex/Dom/Xhr/ResponseType.hs
17− src/Reflex/Dom/Xhr/Exception.hs
18− java/org/reflexfrp/reflexdom/MainWidget.java
26+ java/org/reflexfrp/reflexdom/MainWidget.java
27+ ChangeLog.md
19
28
20flag use-warp
29flag use-warp
21 description: Use jsaddle-warp server
30 description: Use jsaddle-warp server
@@ -41,59 +50,67 @@ flag build-examples
41 default: False
50 default: False
42 manual: True
51 manual: True
43
52
44−flag android
53+flag wasm32
45− description: Build an Android app
54+ description: Build for wasm32 architecture
46 default: False
55 default: False
47 manual: True
56 manual: True
48
57
49library
58library
50 hs-source-dirs: src
59 hs-source-dirs: src
51− if flag(android)
60+ if os(android)
52 hs-source-dirs: src-android
61 hs-source-dirs: src-android
53 other-modules: Reflex.Dom.Android.MainWidget
62 other-modules: Reflex.Dom.Android.MainWidget
54 build-depends:
63 build-depends:
55− aeson,
64+ aeson >= 1.4 && < 1.6,
56 android-activity == 0.1.*,
65 android-activity == 0.1.*,
57 data-default == 0.7.*,
66 data-default == 0.7.*,
58− jsaddle
67+ jsaddle >= 0.9.6 && < 0.10
59 c-sources: cbits/MainWidget.c
68 c-sources: cbits/MainWidget.c
60 include-dirs: cbits/include
69 include-dirs: cbits/include
70+ install-includes: MainWidget.h
61 cpp-options: -DANDROID
71 cpp-options: -DANDROID
62 build-tools: hsc2hs
72 build-tools: hsc2hs
63 build-depends:
73 build-depends:
64− base >= 4.7 && < 4.12,
74+ base >= 4.7 && < 4.15,
65 bytestring == 0.10.*,
75 bytestring == 0.10.*,
66− reflex == 0.5.*,
76+ reflex >= 0.8 && < 0.9,
67− reflex-dom-core >=0.4 && <0.5,
77+ reflex-dom-core >= 0.6.1.0 && <0.7,
68 text == 1.2.*
78 text == 1.2.*
69 if !impl(ghcjs)
79 if !impl(ghcjs)
70− if os(osx) || os(ios)
80+ if flag(use-warp) && (os(linux) || os(osx))
71 build-depends:
81 build-depends:
72− data-default == 0.7.*,
82+ jsaddle >= 0.9.6 && < 0.10,
73− jsaddle,
74− jsaddle-wkwebview
83+ jsaddle-warp >= 0.9.6 && < 0.10
75 else
84 else
76− if flag(use-warp)
85+ if os(osx) || os(ios)
77 build-depends:
86 build-depends:
87+ data-default == 0.7.*,
78− jsaddle,
88+ jsaddle >= 0.9.6 && < 0.10,
79− jsaddle-warp
89+ jsaddle-wkwebview >= 0.9.6 && < 0.10
80 else
90 else
81− if flag(webkit2gtk)
91+ if flag(wasm32)
82 build-depends:
92 build-depends:
83− jsaddle-webkit2gtk
93+ jsaddle >= 0.9.6 && < 0.10,
94+ jsaddle-wasm >= 0.1 && < 0.2
84 else
95 else
85− if !flag(android)
96+ if flag(webkit2gtk)
86 build-depends:
97 build-depends:
87− jsaddle-webkit2gtk
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
88
103
89 exposed-modules:
104 exposed-modules:
90 Reflex.Dom
105 Reflex.Dom
91 Reflex.Dom.Internal
106 Reflex.Dom.Internal
92 reexported-modules:
107 reexported-modules:
93− Foreign.JavaScript.TH
108+ Foreign.JavaScript.Orphans
94− , Foreign.JavaScript.Orphans
109+ , Foreign.JavaScript.TH
110+ , Foreign.JavaScript.Utils
95 , Reflex.Dom.Builder.Class
111 , Reflex.Dom.Builder.Class
96 , Reflex.Dom.Builder.Class.Events
112 , Reflex.Dom.Builder.Class.Events
113+ , Reflex.Dom.Builder.Hydratable
97 , Reflex.Dom.Builder.Immediate
114 , Reflex.Dom.Builder.Immediate
98 , Reflex.Dom.Builder.InputDisabled
115 , Reflex.Dom.Builder.InputDisabled
99 , Reflex.Dom.Builder.Static
116 , Reflex.Dom.Builder.Static
@@ -101,19 +118,25 @@ library
101 , Reflex.Dom.Core
118 , Reflex.Dom.Core
102 , Reflex.Dom.Location
119 , Reflex.Dom.Location
103 , Reflex.Dom.Main
120 , Reflex.Dom.Main
121+ , Reflex.Dom.Modals.Class
104 , Reflex.Dom.Old
122 , Reflex.Dom.Old
123+ , Reflex.Dom.Prerender
124+ , Reflex.Dom.Time
105 , Reflex.Dom.WebSocket
125 , Reflex.Dom.WebSocket
126+ , Reflex.Dom.WebSocket.Query
106 , Reflex.Dom.Widget
127 , Reflex.Dom.Widget
107 , Reflex.Dom.Widget.Basic
128 , Reflex.Dom.Widget.Basic
108 , Reflex.Dom.Widget.Input
129 , Reflex.Dom.Widget.Input
109 , Reflex.Dom.Widget.Lazy
130 , Reflex.Dom.Widget.Lazy
110 , Reflex.Dom.Widget.Resize
131 , Reflex.Dom.Widget.Resize
111 , Reflex.Dom.Xhr
132 , Reflex.Dom.Xhr
133+ , Reflex.Dom.Xhr.FormData
112 ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
134 ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
113 if flag(expose-all-unfoldings)
135 if flag(expose-all-unfoldings)
114 ghc-options: -fexpose-all-unfoldings
136 ghc-options: -fexpose-all-unfoldings
115 if flag(use-reflex-optimizer)
137 if flag(use-reflex-optimizer)
116 ghc-options: -fplugin=Reflex.Optimizer
138 ghc-options: -fplugin=Reflex.Optimizer
139+ default-language: Haskell2010
117
140
118executable sortableList
141executable sortableList
119 build-depends: base
142 build-depends: base
@@ -130,33 +153,59 @@ executable sortableList
130 hs-source-dirs: examples
153 hs-source-dirs: examples
131 main-is: sortableList.hs
154 main-is: sortableList.hs
132 ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
155 ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
133− ghc-prof-options: -fprof-auto
134 if !flag(build-examples)
156 if !flag(build-examples)
135 buildable: False
157 buildable: False
136 if flag(expose-all-unfoldings)
158 if flag(expose-all-unfoldings)
137 ghc-options: -fexpose-all-unfoldings
159 ghc-options: -fexpose-all-unfoldings
138 if flag(use-reflex-optimizer)
160 if flag(use-reflex-optimizer)
139 ghc-options: -fplugin=Reflex.Optimizer
161 ghc-options: -fplugin=Reflex.Optimizer
162+ default-language: Haskell2010
140
163
141executable benchmark
164executable benchmark
142− build-depends: base, reflex, reflex-dom, text, prim-uniq, dependent-map, containers, transformers, mtl, ghcjs-dom, ghc-prim, random, dependent-sum
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
143 hs-source-dirs: .
178 hs-source-dirs: .
144 main-is: benchmark.hs
179 main-is: benchmark.hs
145 ghc-options: -O2 -fspecialise-aggressively
180 ghc-options: -O2 -fspecialise-aggressively
146 if !impl(ghcjs)
181 if !impl(ghcjs)
147 buildable: False
182 buildable: False
183+ default-language: Haskell2010
148
184
149executable krausest
185executable krausest
150− build-depends: base, reflex, reflex-dom, text, prim-uniq, dependent-map, containers, transformers, mtl, ghcjs-dom, ghc-prim, random, dependent-sum, vector
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
151 hs-source-dirs: benchmarks
200 hs-source-dirs: benchmarks
152 main-is: krausest.hs
201 main-is: krausest.hs
153 ghc-options: -O2 -fspecialise-aggressively
202 ghc-options: -O2 -fspecialise-aggressively
154 if impl(ghcjs)
203 if impl(ghcjs)
155− ghc-options: -dedupe
204+ ghcjs-options: -dedupe
156 cpp-options: -DGHCJS_BROWSER -DGHCJS_GC_INTERVAL=60000
205 cpp-options: -DGHCJS_BROWSER -DGHCJS_GC_INTERVAL=60000
157 else
206 else
158 buildable: False
207 buildable: False
159− type: exitcode-stdio-1.0
208+ default-language: Haskell2010
160
209
161source-repository head
210source-repository head
162 type: git
211 type: git
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 #-}
1module Reflex.Dom (module X) where
5module Reflex.Dom (module X) where
2
6
3import Foreign.JavaScript.Orphans ()
7import Foreign.JavaScript.Orphans ()
4import Reflex.Dom.Core as X hiding (mainWidget, mainWidgetInElementById, mainWidgetWithCss,
8import Reflex.Dom.Core as X hiding (mainWidget, mainWidgetInElementById, mainWidgetWithCss,
5− mainWidgetWithHead, mainWidgetWithHead', runApp')
9+ mainWidgetWithHead, mainWidgetWithHead', runApp',
10+ mainHydrationWidgetWithHead, mainHydrationWidgetWithHead')
6import Reflex.Dom.Internal as X
11import Reflex.Dom.Internal as X
reflex-dom/src/Reflex/Dom/Internal.hs+23−4
@@ -4,18 +4,24 @@
4{-# LANGUAGE RankNTypes #-}
4{-# LANGUAGE RankNTypes #-}
5{-# LANGUAGE TypeFamilies #-}
5{-# LANGUAGE TypeFamilies #-}
6module Reflex.Dom.Internal
6module Reflex.Dom.Internal
7− (module Main, run, mainWidget, mainWidgetWithHead, mainWidgetWithCss,
7+ ( module Main
8+ , run
9+ , mainWidget
8− mainWidgetWithHead', mainWidgetInElementById, runApp') where
10+ , mainWidgetWithHead, mainWidgetWithCss, mainWidgetWithHead', mainWidgetInElementById, runApp'
11+ , mainHydrationWidgetWithHead, mainHydrationWidgetWithHead'
12+ ) where
9
13
10import Data.ByteString (ByteString)
14import Data.ByteString (ByteString)
11import Data.Text (Text)
15import Data.Text (Text)
12import Reflex.Dom.Core (Widget)
16import Reflex.Dom.Core (Widget)
13import Reflex.Dom.Main as Main hiding
17import Reflex.Dom.Main as Main hiding
14 (mainWidget, mainWidgetWithHead, mainWidgetWithCss,
18 (mainWidget, mainWidgetWithHead, mainWidgetWithCss,
15− mainWidgetWithHead', mainWidgetInElementById, runApp')
19+ mainWidgetWithHead', mainWidgetInElementById, runApp',
20+ mainHydrationWidgetWithHead, mainHydrationWidgetWithHead')
16import qualified Reflex.Dom.Main as Main
21import qualified Reflex.Dom.Main as Main
17 (mainWidget, mainWidgetWithHead, mainWidgetWithCss,
22 (mainWidget, mainWidgetWithHead, mainWidgetWithCss,
18− mainWidgetWithHead', mainWidgetInElementById, runApp')
23+ mainWidgetWithHead', mainWidgetInElementById, runApp',
24+ mainHydrationWidgetWithHead, mainHydrationWidgetWithHead')
19
25
20#if defined(ghcjs_HOST_OS)
26#if defined(ghcjs_HOST_OS)
21run :: a -> a
27run :: a -> a
@@ -74,6 +80,11 @@ run jsm = do
74 startMainWidget a startPage jsm
80 startMainWidget a startPage jsm
75 }
81 }
76 forever $ threadDelay 1000000000
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
77#else
88#else
78import Language.Javascript.JSaddle.WebKitGTK (run)
89import Language.Javascript.JSaddle.WebKitGTK (run)
79#endif
90#endif
@@ -101,3 +112,11 @@ mainWidgetInElementById eid w = run $ Main.mainWidgetInElementById eid w
101runApp' :: (forall x. AppInput DomTimeline -> Widget x (AppOutput DomTimeline)) -> IO ()
112runApp' :: (forall x. AppInput DomTimeline -> Widget x (AppOutput DomTimeline)) -> IO ()
102runApp' app = run $ Main.runApp' app
113runApp' app = run $ Main.runApp' app
103{-# INLINE runApp' #-}
114{-# 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)