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−43
@@ -1,43 +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, ghcjs-dom, hlint, jsaddle, keycode, lens
5−, monad-control, mtl, primitive, ref-tf, reflex, semigroups, stdenv
6−, stm, template-haskell, temporary, text, these, transformers
7−, unix, zenc, hashable, chromium, process, jsaddle-warp
8−, linux-namespaces, iproute, network-uri
9−}:
10−let addGcTestDepends = drv: if stdenv.system != "x86_64-linux" then drv else drv // {
11− testHaskellDepends = (drv.testHaskellDepends or []) ++ [ temporary jsaddle-warp process linux-namespaces ];
12− testSystemDepends = (drv.testSystemDepends or []) ++ [ chromium iproute ];
13− };
14−in mkDerivation (addGcTestDepends {
15− pname = "reflex-dom-core";
16− version = "0.4";
17− src = ./.;
18− libraryHaskellDepends = [
19− aeson base bifunctors bimap blaze-builder bytestring constraints
20− containers contravariant data-default dependent-map dependent-sum
21− dependent-sum-template directory exception-transformers ghcjs-dom
22− jsaddle keycode lens monad-control mtl primitive ref-tf
23− reflex semigroups stm template-haskell text these transformers
24− unix zenc network-uri
25− ] ++ (if ghc.isGhcjs or false then [
26− hashable
27− ] else []);
28−
29− #TODO: Get hlint working for cross-compilation
30− doCheck = stdenv.hostPlatform == stdenv.buildPlatform && !(ghc.isGhcjs or false);
31−
32− # The headless browser run as part of the tests will exit without this
33− preBuild = ''
34− export HOME="$PWD"
35− '';
36−
37− # Show some output while running tests, so we might notice what's wrong
38− testTarget = "--show-details=streaming";
39−
40− testHaskellDepends = [ base hlint ];
41− description = "Functional Reactive Web Apps with Reflex";
42− license = stdenv.lib.licenses.bsd3;
43−})
reflex-dom-core/reflex-dom-core.cabal+121−35
@@ -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,38 +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.3,
70+ aeson >= 0.8 && < 1.6,
45− base >= 4.7 && < 4.11,
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.*,
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,
94+ random >= 1.1 && < 1.2,
67 ref-tf == 0.4.*,
95 ref-tf == 0.4.*,
68− reflex == 0.5.*,
96+ reflex >= 0.8 && < 0.9,
69− semigroups >= 0.16 && < 0.19,
97+ semigroups >= 0.16 && < 0.20,
70− stm == 2.4.*,
98+ stm >= 2.4 && < 2.6,
71 text == 1.2.*,
99 text == 1.2.*,
72− these >= 0.4 && < 0.8,
73 transformers >= 0.3 && < 0.6,
100 transformers >= 0.3 && < 0.6,
74 network-uri >= 2.6.1 && < 2.7,
101 network-uri >= 2.6.1 && < 2.7,
75 zenc == 0.1.*
102 zenc == 0.1.*
@@ -78,12 +105,20 @@ library
78 hs-source-dirs: src-ghcjs
105 hs-source-dirs: src-ghcjs
79 build-depends:
106 build-depends:
80 ghcjs-base,
107 ghcjs-base,
81− hashable == 1.2.*
108+ hashable >= 1.2 && < 1.4
82 else
109 else
83 hs-source-dirs: src-ghc
110 hs-source-dirs: src-ghc
84 if !os(windows)
111 if !os(windows)
85 build-depends: unix == 2.7.*
112 build-depends: unix == 2.7.*
86
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+
87 exposed-modules:
122 exposed-modules:
88 Foreign.JavaScript.TH
123 Foreign.JavaScript.TH
89 Foreign.JavaScript.Orphans
124 Foreign.JavaScript.Orphans
@@ -92,16 +127,15 @@ library
92 Reflex.Dom.Builder.Class.Events
127 Reflex.Dom.Builder.Class.Events
93 Reflex.Dom.Builder.Immediate
128 Reflex.Dom.Builder.Immediate
94 Reflex.Dom.Builder.InputDisabled
129 Reflex.Dom.Builder.InputDisabled
130+ Reflex.Dom.Builder.Hydratable
95 Reflex.Dom.Builder.Static
131 Reflex.Dom.Builder.Static
96 Reflex.Dom.Class
132 Reflex.Dom.Class
97 Reflex.Dom.Core
133 Reflex.Dom.Core
98 Reflex.Dom.Location
134 Reflex.Dom.Location
99 Reflex.Dom.Main
135 Reflex.Dom.Main
100− Reflex.Dom.Modals.Base
101 Reflex.Dom.Modals.Class
136 Reflex.Dom.Modals.Class
102 Reflex.Dom.Old
137 Reflex.Dom.Old
103 Reflex.Dom.Prerender
138 Reflex.Dom.Prerender
104− Reflex.Dom.Specializations
105 Reflex.Dom.Time
139 Reflex.Dom.Time
106 Reflex.Dom.WebSocket
140 Reflex.Dom.WebSocket
107 Reflex.Dom.WebSocket.Query
141 Reflex.Dom.WebSocket.Query
@@ -111,6 +145,7 @@ library
111 Reflex.Dom.Widget.Lazy
145 Reflex.Dom.Widget.Lazy
112 Reflex.Dom.Widget.Resize
146 Reflex.Dom.Widget.Resize
113 Reflex.Dom.Xhr
147 Reflex.Dom.Xhr
148+ Reflex.Dom.Xhr.FormData
114 other-modules:
149 other-modules:
115 Foreign.JavaScript.Internal.Utils
150 Foreign.JavaScript.Internal.Utils
116 Reflex.Dom.WebSocket.Foreign
151 Reflex.Dom.WebSocket.Foreign
@@ -118,7 +153,8 @@ library
118 Reflex.Dom.Xhr.ResponseType
153 Reflex.Dom.Xhr.ResponseType
119 Reflex.Dom.Xhr.Exception
154 Reflex.Dom.Xhr.Exception
120
155
156+ default-language: Haskell98
121− ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively -ddump-simpl -ddump-to-file -dsuppress-coercions -dsuppress-idinfo
157+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
122 ghc-prof-options: -fprof-auto
158 ghc-prof-options: -fprof-auto
123
159
124 if flag(expose-all-unfoldings)
160 if flag(expose-all-unfoldings)
@@ -132,39 +168,89 @@ library
132
168
133 if flag(use-template-haskell)
169 if flag(use-template-haskell)
134 build-depends:
170 build-depends:
135− dependent-sum >= 0.3 && < 0.5,
171+ dependent-sum-template >= 0.1 && < 0.2,
136− dependent-sum-template >= 0.0.0.5 && < 0.1,
137− template-haskell
172+ template-haskell >= 2.12.0 && < 2.17
138 other-extensions: TemplateHaskell
173 other-extensions: TemplateHaskell
139 cpp-options: -DUSE_TEMPLATE_HASKELL
174 cpp-options: -DUSE_TEMPLATE_HASKELL
140 other-modules:
175 other-modules:
141 Reflex.Dom.Builder.Class.TH
176 Reflex.Dom.Builder.Class.TH
142− else
143− build-depends:
144− dependent-sum == 0.4.*
145
177
146test-suite hlint
178test-suite hlint
147− build-depends: base, hlint
179+ build-depends:
180+ base,
181+ hlint >= 2.0 && < 4.0
148 hs-source-dirs: test
182 hs-source-dirs: test
149 main-is: hlint.hs
183 main-is: hlint.hs
150 type: exitcode-stdio-1.0
184 type: exitcode-stdio-1.0
185+ default-language: Haskell98
151
186
152−test-suite gc
187+test-suite hydration
153 build-depends: base
188 build-depends: base
189+ , aeson
190+ , async
191+ , bytestring
192+ , chrome-test-utils
193+ , constraints
194+ , constraints-extras
195+ , containers
196+ , dependent-map
197+ , dependent-sum
198+ , dependent-sum-template
199+ , directory
200+ , exceptions
201+ , filepath
202+ , ghcjs-dom
203+ , hspec
204+ , hspec-core
205+ , hspec-webdriver
206+ , http-types
207+ , HUnit
208+ , jsaddle
209+ , jsaddle-warp
210+ , lens
211+ , lifted-base
212+ , network
213+ , random
214+ , ref-tf
154 , reflex
215 , reflex
155 , reflex-dom-core
216 , reflex-dom-core
217+ , process
218+ , silently
219+ , temporary
220+ , text
221+ , wai
222+ , wai-websockets
223+ , warp
224+ , webdriver
225+ , websockets
226+ , which
227+ hs-source-dirs: test
228+ ghc-options: -rtsopts -with-rtsopts=-T -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans
229+ ghc-prof-options: -fprof-auto -optP-DPROFILING
230+ main-is: hydration.hs
231+ type: exitcode-stdio-1.0
232+ default-language: Haskell98
233+ if !os(linux) || !arch(x86_64) || flag(profile-reflex) || !flag(hydration-tests)
234+ buildable: False
235+
236+-- broken test on base 4.11 & ghc 8.4.3
237+-- needs to be updated for changes in GHC.Stats
238+test-suite gc
239+ build-depends: base
240+ , chrome-test-utils
156 , jsaddle
241 , jsaddle
157 , jsaddle-warp
242 , jsaddle-warp
158− , linux-namespaces
159 , process
243 , process
160− , temporary
244+ , reflex
161− , unix
245+ , reflex-dom-core
246+ , text
162 hs-source-dirs: test
247 hs-source-dirs: test
163 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
164 ghc-prof-options: -fprof-auto -optP-DPROFILING
249 ghc-prof-options: -fprof-auto -optP-DPROFILING
165 main-is: gc.hs
250 main-is: gc.hs
166 type: exitcode-stdio-1.0
251 type: exitcode-stdio-1.0
252+ default-language: Haskell98
167− if !os(linux) || !arch(x86_64)
253+ if !os(linux) || !arch(x86_64) || !flag(gc-tests)
168 buildable: False
254 buildable: False
169
255
170source-repository head
256source-repository head
reflex-dom-core/src/Foreign/JavaScript/Orphans.hs+6−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
@@ -7,8 +10,8 @@ module Foreign.JavaScript.Orphans where
7
10
8import Control.Monad.Trans.Class (lift)
11import Control.Monad.Trans.Class (lift)
9import GHCJS.DOM.Types (MonadJSM (..))
12import GHCJS.DOM.Types (MonadJSM (..))
10−import Reflex.DynamicWriter (DynamicWriterT)
13+import Reflex.DynamicWriter.Base (DynamicWriterT)
11−import Reflex.EventWriter (EventWriterT)
14+import Reflex.EventWriter.Base (EventWriterT)
12import Reflex.Host.Class (HostFrame, ReflexHost)
15import Reflex.Host.Class (HostFrame, ReflexHost)
13import Reflex.PerformEvent.Base (PerformEventT (..))
16import Reflex.PerformEvent.Base (PerformEventT (..))
14import Reflex.PostBuild.Base (PostBuildT)
17import Reflex.PostBuild.Base (PostBuildT)
@@ -16,7 +19,7 @@ import Reflex.Requester.Base (RequesterT)
16import Reflex.TriggerEvent.Base
19import Reflex.TriggerEvent.Base
17import Reflex.Query.Base (QueryT)
20import Reflex.Query.Base (QueryT)
18
21
19−instance (MonadJSM m, ReflexHost t) => MonadJSM (PostBuildT t m) where
22+instance MonadJSM m => MonadJSM (PostBuildT t m) where
20 liftJSM' = lift . liftJSM'
23 liftJSM' = lift . liftJSM'
21instance (MonadJSM (HostFrame t), ReflexHost t) => MonadJSM (PerformEventT t m) where
24instance (MonadJSM (HostFrame t), ReflexHost t) => MonadJSM (PerformEventT t m) where
22 liftJSM' = PerformEventT . lift . liftJSM'
25 liftJSM' = PerformEventT . lift . liftJSM'
reflex-dom-core/src/Foreign/JavaScript/TH.hs+10−7
@@ -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 #-}
@@ -28,8 +26,9 @@ module Foreign.JavaScript.TH ( module Foreign.JavaScript.TH
28import Foreign.JavaScript.Orphans ()
26import Foreign.JavaScript.Orphans ()
29import Prelude hiding ((!!))
27import Prelude hiding ((!!))
30import Reflex.Class
28import Reflex.Class
29+import Reflex.Adjustable.Class
31−import Reflex.DynamicWriter
30+import Reflex.DynamicWriter.Base
32−import Reflex.EventWriter
31+import Reflex.EventWriter.Base
33import Reflex.Host.Class
32import Reflex.Host.Class
34import Reflex.PerformEvent.Base
33import Reflex.PerformEvent.Base
35import Reflex.PerformEvent.Class
34import Reflex.PerformEvent.Class
@@ -242,7 +241,7 @@ instance HasJS x m => HasJS x (ReaderT r m) where
242 type JSX (ReaderT r m) = JSX m
241 type JSX (ReaderT r m) = JSX m
243 liftJS = lift . liftJS
242 liftJS = lift . liftJS
244
243
245−instance (HasJS x m, ReflexHost t) => HasJS x (PostBuildT t m) where
244+instance HasJS x m => HasJS x (PostBuildT t m) where
246 type JSX (PostBuildT t m) = JSX m
245 type JSX (PostBuildT t m) = JSX m
247 liftJS = lift . liftJS
246 liftJS = lift . liftJS
248
247
@@ -254,6 +253,10 @@ instance HasJS x m => HasJS x (DynamicWriterT t w m) where
254 type JSX (DynamicWriterT t w m) = JSX m
253 type JSX (DynamicWriterT t w m) = JSX m
255 liftJS = lift . liftJS
254 liftJS = lift . liftJS
256
255
256+instance HasJS x m => HasJS x (EventWriterT t w m) where
257+ type JSX (EventWriterT t w m) = JSX m
258+ liftJS = lift . liftJS
259+
257instance HasJS x m => HasJS x (RequesterT t request response m) where
260instance HasJS x m => HasJS x (RequesterT t request response m) where
258 type JSX (RequesterT t request response m) = JSX m
261 type JSX (RequesterT t request response m) = JSX m
259 liftJS = lift . liftJS
262 liftJS = lift . liftJS
@@ -289,7 +292,7 @@ class Monad m => MonadJS x m | m -> x where
289#ifdef ghcjs_HOST_OS
292#ifdef ghcjs_HOST_OS
290
293
291data JSCtx_IO
294data JSCtx_IO
292−type HasJS' = HasJS JSCtx_IO
295+type JS' = JSCtx_IO
293
296
294instance MonadIO m => HasJS JSCtx_IO (WithJSContextSingleton x m) where
297instance MonadIO m => HasJS JSCtx_IO (WithJSContextSingleton x m) where
295 type JSX (WithJSContextSingleton x m) = IO
298 type JSX (WithJSContextSingleton x m) = IO
@@ -340,7 +343,7 @@ foreign import javascript unsafe "function(){ return $1(arguments); }" funWithAr
340#else
343#else
341
344
342data JSCtx_JavaScriptCore x
345data JSCtx_JavaScriptCore x
343−type HasJS' = HasJS (JSCtx_JavaScriptCore ())
346+type JS' = JSCtx_JavaScriptCore ()
344
347
345instance IsJSContext (JSCtx_JavaScriptCore x) where
348instance IsJSContext (JSCtx_JavaScriptCore x) where
346 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+100−15
@@ -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 #-}
@@ -29,13 +29,15 @@ module Reflex.Dom.Builder.Class
29 , module Reflex.NotReady.Class
29 , module Reflex.NotReady.Class
30 ) where
30 ) where
31
31
32+import Reflex.Adjustable.Class
32import Reflex.Class as Reflex
33import Reflex.Class as Reflex
33import Reflex.Dom.Builder.Class.Events
34import Reflex.Dom.Builder.Class.Events
34#ifdef USE_TEMPLATE_HASKELL
35#ifdef USE_TEMPLATE_HASKELL
35import Reflex.Dom.Builder.Class.TH
36import Reflex.Dom.Builder.Class.TH
36#endif
37#endif
38+import Reflex.BehaviorWriter.Base
37−import Reflex.DynamicWriter
39+import Reflex.DynamicWriter.Base
38−import Reflex.EventWriter
40+import Reflex.EventWriter.Base
39import Reflex.NotReady.Class
41import Reflex.NotReady.Class
40import Reflex.PerformEvent.Class
42import Reflex.PerformEvent.Class
41import Reflex.PostBuild.Base
43import Reflex.PostBuild.Base
@@ -46,6 +48,7 @@ import Reflex.Requester.Base
46import qualified Control.Category
48import qualified Control.Category
47import Control.Lens hiding (element)
49import Control.Lens hiding (element)
48import Control.Monad.Reader
50import Control.Monad.Reader
51+import qualified Control.Monad.State as Lazy
49import Control.Monad.State.Strict
52import Control.Monad.State.Strict
50import Control.Monad.Trans.Control
53import Control.Monad.Trans.Control
51import Data.Default
54import Data.Default
@@ -59,12 +62,14 @@ import Data.String
59import Data.Text (Text)
62import Data.Text (Text)
60import Data.Type.Coercion
63import Data.Type.Coercion
61import GHCJS.DOM.Types (JSM)
64import GHCJS.DOM.Types (JSM)
65+import qualified GHCJS.DOM.Types as DOM
62
66
63class Default (EventSpec d EventResult) => DomSpace d where
67class Default (EventSpec d EventResult) => DomSpace d where
64 type EventSpec d :: (EventTag -> *) -> *
68 type EventSpec d :: (EventTag -> *) -> *
69+ type RawDocument d :: *
65 type RawTextNode d :: *
70 type RawTextNode d :: *
71+ type RawCommentNode d :: *
66 type RawElement d :: *
72 type RawElement d :: *
67− type RawFile d :: *
68 type RawInputElement d :: *
73 type RawInputElement d :: *
69 type RawTextAreaElement d :: *
74 type RawTextAreaElement d :: *
70 type RawSelectElement d :: *
75 type RawSelectElement d :: *
@@ -83,6 +88,15 @@ class (Monad m, Reflex t, DomSpace (DomBuilderSpace m), NotReady t m, Adjustable
83 => TextNodeConfig t -> m (TextNode (DomBuilderSpace m) t)
88 => TextNodeConfig t -> m (TextNode (DomBuilderSpace m) t)
84 textNode = lift . textNode
89 textNode = lift . textNode
85 {-# INLINABLE textNode #-}
90 {-# INLINABLE textNode #-}
91+ commentNode :: CommentNodeConfig t -> m (CommentNode (DomBuilderSpace m) t)
92+ default commentNode :: ( MonadTrans f
93+ , m ~ f m'
94+ , DomBuilderSpace m' ~ DomBuilderSpace m
95+ , DomBuilder t m'
96+ )
97+ => CommentNodeConfig t -> m (CommentNode (DomBuilderSpace m) t)
98+ commentNode = lift . commentNode
99+ {-# INLINABLE commentNode #-}
86 element :: Text -> ElementConfig er t (DomBuilderSpace m) -> m a -> m (Element er (DomBuilderSpace m) t, a)
100 element :: Text -> ElementConfig er t (DomBuilderSpace m) -> m a -> m (Element er (DomBuilderSpace m) t, a)
87 default element :: ( MonadTransControl f
101 default element :: ( MonadTransControl f
88 , StT f a ~ a
102 , StT f a ~ a
@@ -172,6 +186,28 @@ newtype TextNode d t = TextNode
172 { _textNode_raw :: RawTextNode d
186 { _textNode_raw :: RawTextNode d
173 }
187 }
174
188
189+data CommentNodeConfig t
190+ = CommentNodeConfig { _commentNodeConfig_initialContents :: {-# UNPACK #-} !Text
191+ , _commentNodeConfig_setContents :: !(Maybe (Event t Text))
192+ }
193+
194+#ifndef USE_TEMPLATE_HASKELL
195+commentNodeConfig_initialContents :: Lens' (CommentNodeConfig t) Text
196+commentNodeConfig_initialContents f (CommentNodeConfig a b) = (\a' -> CommentNodeConfig a' b) <$> f a
197+{-# INLINE commentNodeConfig_initialContents #-}
198+#endif
199+
200+instance (Reflex t) => Default (CommentNodeConfig t) where
201+ {-# INLINABLE def #-}
202+ def = CommentNodeConfig
203+ { _commentNodeConfig_initialContents = mempty
204+ , _commentNodeConfig_setContents = Nothing
205+ }
206+
207+newtype CommentNode d t = CommentNode
208+ { _commentNode_raw :: RawCommentNode d
209+ }
210+
175data AttributeName = AttributeName !(Maybe Namespace) !Text deriving (Show, Read, Eq, Ord)
211data AttributeName = AttributeName !(Maybe Namespace) !Text deriving (Show, Read, Eq, Ord)
176
212
177mapKeysToAttributeName :: Map Text v -> Map AttributeName v
213mapKeysToAttributeName :: Map Text v -> Map AttributeName v
@@ -288,7 +324,7 @@ data InputElement er d t
288 , _inputElement_hasFocus :: Dynamic t Bool
324 , _inputElement_hasFocus :: Dynamic t Bool
289 , _inputElement_element :: Element er d t
325 , _inputElement_element :: Element er d t
290 , _inputElement_raw :: RawInputElement d
326 , _inputElement_raw :: RawInputElement d
291− , _inputElement_files :: Dynamic t [RawFile d]
327+ , _inputElement_files :: Dynamic t [DOM.File]
292 }
328 }
293
329
294data TextAreaElementConfig er t m
330data TextAreaElementConfig er t m
@@ -390,6 +426,7 @@ data SelectElement er d t = SelectElement
390#ifdef USE_TEMPLATE_HASKELL
426#ifdef USE_TEMPLATE_HASKELL
391concat <$> mapM (uncurry makeLensesWithoutField)
427concat <$> mapM (uncurry makeLensesWithoutField)
392 [ (["_textNodeConfig_setContents"], ''TextNodeConfig)
428 [ (["_textNodeConfig_setContents"], ''TextNodeConfig)
429+ , (["_commentNodeConfig_setContents"], ''CommentNodeConfig)
393 , ([ "_inputElementConfig_setValue"
430 , ([ "_inputElementConfig_setValue"
394 , "_inputElementConfig_setChecked" ], ''InputElementConfig)
431 , "_inputElementConfig_setChecked" ], ''InputElementConfig)
395 , (["_rawElementConfig_modifyAttributes"], ''RawElementConfig)
432 , (["_rawElementConfig_modifyAttributes"], ''RawElementConfig)
@@ -400,49 +437,56 @@ concat <$> mapM (uncurry makeLensesWithoutField)
400#endif
437#endif
401
438
402-- | 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'.
403−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)
404textNodeConfig_setContents =
441textNodeConfig_setContents =
405 let getter = fromMaybe never . _textNodeConfig_setContents
442 let getter = fromMaybe never . _textNodeConfig_setContents
406 setter t e = t { _textNodeConfig_setContents = Just e }
443 setter t e = t { _textNodeConfig_setContents = Just e }
407 in lens getter setter
444 in lens getter setter
408
445
446+-- | This lens is technically illegal. The implementation of 'CommentNodeConfig' uses a 'Maybe' under the hood for efficiency reasons. However, always interacting with 'CommentNodeConfig' via lenses will always behave correctly, and if you pattern match on it, you should always treat 'Nothing' as 'never'.
447+commentNodeConfig_setContents :: Reflex t => Lens (CommentNodeConfig t) (CommentNodeConfig t) (Event t Text) (Event t Text)
448+commentNodeConfig_setContents =
449+ let getter = fromMaybe never . _commentNodeConfig_setContents
450+ setter t e = t { _commentNodeConfig_setContents = Just e }
451+ in lens getter setter
452+
409-- | 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'.
410−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)
411inputElementConfig_setValue =
455inputElementConfig_setValue =
412 let getter = fromMaybe never . _inputElementConfig_setValue
456 let getter = fromMaybe never . _inputElementConfig_setValue
413 setter t e = t { _inputElementConfig_setValue = Just e }
457 setter t e = t { _inputElementConfig_setValue = Just e }
414 in lens getter setter
458 in lens getter setter
415
459
416-- | 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'.
417−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)
418inputElementConfig_setChecked =
462inputElementConfig_setChecked =
419 let getter = fromMaybe never . _inputElementConfig_setChecked
463 let getter = fromMaybe never . _inputElementConfig_setChecked
420 setter t e = t { _inputElementConfig_setChecked = Just e }
464 setter t e = t { _inputElementConfig_setChecked = Just e }
421 in lens getter setter
465 in lens getter setter
422
466
423-- | 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'.
424−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)))
425rawElementConfig_modifyAttributes =
469rawElementConfig_modifyAttributes =
426 let getter = fromMaybe never . _rawElementConfig_modifyAttributes
470 let getter = fromMaybe never . _rawElementConfig_modifyAttributes
427 setter t e = t { _rawElementConfig_modifyAttributes = Just e }
471 setter t e = t { _rawElementConfig_modifyAttributes = Just e }
428 in lens getter setter
472 in lens getter setter
429
473
430-- | 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'.
431−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)))
432elementConfig_modifyAttributes =
476elementConfig_modifyAttributes =
433 let getter = fromMaybe never . _elementConfig_modifyAttributes
477 let getter = fromMaybe never . _elementConfig_modifyAttributes
434 setter t e = t { _elementConfig_modifyAttributes = Just e }
478 setter t e = t { _elementConfig_modifyAttributes = Just e }
435 in lens getter setter
479 in lens getter setter
436
480
437-- | 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'.
438−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)
439textAreaElementConfig_setValue =
483textAreaElementConfig_setValue =
440 let getter = fromMaybe never . _textAreaElementConfig_setValue
484 let getter = fromMaybe never . _textAreaElementConfig_setValue
441 setter t e = t { _textAreaElementConfig_setValue = Just e }
485 setter t e = t { _textAreaElementConfig_setValue = Just e }
442 in lens getter setter
486 in lens getter setter
443
487
444-- | 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'.
445−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)
446selectElementConfig_setValue =
490selectElementConfig_setValue =
447 let getter = fromMaybe never . _selectElementConfig_setValue
491 let getter = fromMaybe never . _selectElementConfig_setValue
448 setter t e = t { _selectElementConfig_setValue = Just e }
492 setter t e = t { _selectElementConfig_setValue = Just e }
@@ -518,6 +562,7 @@ instance (MountableDomBuilder t m, PerformEvent t m, MonadFix m, MonadHold t m)
518instance (DomBuilder t m, Monoid w, MonadHold t m, MonadFix m) => DomBuilder t (DynamicWriterT t w m) where
562instance (DomBuilder t m, Monoid w, MonadHold t m, MonadFix m) => DomBuilder t (DynamicWriterT t w m) where
519 type DomBuilderSpace (DynamicWriterT t w m) = DomBuilderSpace m
563 type DomBuilderSpace (DynamicWriterT t w m) = DomBuilderSpace m
520 textNode = liftTextNode
564 textNode = liftTextNode
565+ commentNode = liftCommentNode
521 element elementTag cfg (DynamicWriterT child) = DynamicWriterT $ do
566 element elementTag cfg (DynamicWriterT child) = DynamicWriterT $ do
522 s <- get
567 s <- get
523 (el, (a, newS)) <- lift $ element elementTag cfg $ runStateT child s
568 (el, (a, newS)) <- lift $ element elementTag cfg $ runStateT child s
@@ -536,6 +581,7 @@ instance (DomBuilder t m, Monoid w, MonadHold t m, MonadFix m) => DomBuilder t (
536instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RequesterT t request response m) where
581instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RequesterT t request response m) where
537 type DomBuilderSpace (RequesterT t request response m) = DomBuilderSpace m
582 type DomBuilderSpace (RequesterT t request response m) = DomBuilderSpace m
538 textNode = liftTextNode
583 textNode = liftTextNode
584+ commentNode = liftCommentNode
539 element elementTag cfg (RequesterT child) = RequesterT $ do
585 element elementTag cfg (RequesterT child) = RequesterT $ do
540 r <- ask
586 r <- ask
541 old <- get
587 old <- get
@@ -556,6 +602,7 @@ instance (DomBuilder t m, MonadHold t m, MonadFix m) => DomBuilder t (RequesterT
556instance (DomBuilder t m, MonadHold t m, MonadFix m, Semigroup w) => DomBuilder t (EventWriterT t w m) where
602instance (DomBuilder t m, MonadHold t m, MonadFix m, Semigroup w) => DomBuilder t (EventWriterT t w m) where
557 type DomBuilderSpace (EventWriterT t w m) = DomBuilderSpace m
603 type DomBuilderSpace (EventWriterT t w m) = DomBuilderSpace m
558 textNode = liftTextNode
604 textNode = liftTextNode
605+ commentNode = liftCommentNode
559 element elementTag cfg (EventWriterT child) = EventWriterT $ do
606 element elementTag cfg (EventWriterT child) = EventWriterT $ do
560 old <- get
607 old <- get
561 (el, (a, new)) <- lift $ element elementTag cfg $ runStateT child old
608 (el, (a, new)) <- lift $ element elementTag cfg $ runStateT child old
@@ -571,9 +618,10 @@ instance (DomBuilder t m, MonadHold t m, MonadFix m, Semigroup w) => DomBuilder
571 placeRawElement = lift . placeRawElement
618 placeRawElement = lift . placeRawElement
572 wrapRawElement e = lift . wrapRawElement e
619 wrapRawElement e = lift . wrapRawElement e
573
620
574−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
575 type DomBuilderSpace (QueryT t q m) = DomBuilderSpace m
622 type DomBuilderSpace (QueryT t q m) = DomBuilderSpace m
576 textNode = liftTextNode
623 textNode = liftTextNode
624+ commentNode = liftCommentNode
577 element elementTag cfg (QueryT child) = QueryT $ do
625 element elementTag cfg (QueryT child) = QueryT $ do
578 s <- get
626 s <- get
579 (e, (a, newS)) <- lift $ element elementTag cfg $ runStateT child s
627 (e, (a, newS)) <- lift $ element elementTag cfg $ runStateT child s
@@ -591,7 +639,7 @@ instance (DomBuilder t m, MonadFix m, MonadHold t m, Group q, Query q, Additive
591
639
592-- * Convenience functions
640-- * Convenience functions
593
641
594−class HasDomEvent t target eventName where
642+class HasDomEvent t target eventName | target -> t where
595 type DomEventType target eventName :: *
643 type DomEventType target eventName :: *
596 domEvent :: EventName eventName -> target -> Event t (DomEventType target eventName)
644 domEvent :: EventName eventName -> target -> Event t (DomEventType target eventName)
597
645
@@ -642,6 +690,9 @@ liftWithStateless a = liftWith $ \run -> a $ fmap (fromStT (Proxy :: Proxy t)) .
642liftTextNode :: (MonadTrans f, DomBuilder t m) => TextNodeConfig t -> f m (TextNode (DomBuilderSpace m) t)
690liftTextNode :: (MonadTrans f, DomBuilder t m) => TextNodeConfig t -> f m (TextNode (DomBuilderSpace m) t)
643liftTextNode = lift . textNode
691liftTextNode = lift . textNode
644
692
693+liftCommentNode :: (MonadTrans f, DomBuilder t m) => CommentNodeConfig t -> f m (CommentNode (DomBuilderSpace m) t)
694+liftCommentNode = lift . commentNode
695+
645liftElement :: LiftDomBuilder t f m => Text -> ElementConfig er t (DomBuilderSpace m) -> f m a -> f m (Element er (DomBuilderSpace m) t, a)
696liftElement :: LiftDomBuilder t f m => Text -> ElementConfig er t (DomBuilderSpace m) -> f m a -> f m (Element er (DomBuilderSpace m) t, a)
646liftElement elementTag cfg child = liftWithStateless $ \run -> element elementTag cfg $ run child
697liftElement elementTag cfg child = liftWithStateless $ \run -> element elementTag cfg $ run child
647
698
@@ -660,7 +711,14 @@ instance DomRenderHook t m => DomRenderHook t (StateT e m) where
660 requestDomAction = lift . requestDomAction
711 requestDomAction = lift . requestDomAction
661 requestDomAction_ = lift . requestDomAction_
712 requestDomAction_ = lift . requestDomAction_
662
713
714+instance DomRenderHook t m => DomRenderHook t (Lazy.StateT e m) where
715+ withRenderHook hook (Lazy.StateT a) = Lazy.StateT $ \s -> withRenderHook hook $ a s
716+ requestDomAction = lift . requestDomAction
717+ requestDomAction_ = lift . requestDomAction_
718+
719+deriving instance DomRenderHook t m => DomRenderHook t (BehaviorWriterT t w m)
663deriving 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)
664deriving instance DomRenderHook t m => DomRenderHook t (RequesterT t req rsp m)
722deriving instance DomRenderHook t m => DomRenderHook t (RequesterT t req rsp m)
665deriving instance DomRenderHook t m => DomRenderHook t (PostBuildT t m)
723deriving instance DomRenderHook t m => DomRenderHook t (PostBuildT t m)
666deriving instance DomRenderHook t m => DomRenderHook t (QueryT t q m)
724deriving instance DomRenderHook t m => DomRenderHook t (QueryT t q m)
@@ -668,3 +726,30 @@ deriving instance DomRenderHook t m => DomRenderHook t (QueryT t q m)
668{-# DEPRECATED liftElementConfig "Use 'id' instead; this function is no longer necessary" #-}
726{-# DEPRECATED liftElementConfig "Use 'id' instead; this function is no longer necessary" #-}
669liftElementConfig :: ElementConfig er t s -> ElementConfig er t s
727liftElementConfig :: ElementConfig er t s -> ElementConfig er t s
670liftElementConfig = id
728liftElementConfig = id
729+
730+class Monad m => HasDocument m where
731+ askDocument :: m (RawDocument (DomBuilderSpace m))
732+ default askDocument
733+ :: ( m ~ f m'
734+ , RawDocument (DomBuilderSpace m) ~ RawDocument (DomBuilderSpace m')
735+ , MonadTrans f
736+ , Monad m'
737+ , HasDocument m'
738+ )
739+ => m (RawDocument (DomBuilderSpace m))
740+ askDocument = lift askDocument
741+
742+instance HasDocument m => HasDocument (ReaderT r m)
743+instance HasDocument m => HasDocument (EventWriterT t w m)
744+instance HasDocument m => HasDocument (DynamicWriterT t w m)
745+instance HasDocument m => HasDocument (PostBuildT t m)
746+instance HasDocument m => HasDocument (RequesterT t request response m)
747+instance HasDocument m => HasDocument (QueryT t q m)
748+
749+class HasSetValue a where
750+ type SetValue a :: *
751+ setValue :: Lens' a (SetValue a)
752+
753+instance Reflex t => HasSetValue (TextAreaElementConfig er t m) where
754+ type SetValue (TextAreaElementConfig er t m) = Event t Text
755+ setValue = textAreaElementConfig_setValue
reflex-dom-core/src/Reflex/Dom/Builder/Class/Events.hs+13−3
@@ -1,7 +1,6 @@
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/Immediate.hs+1742−587
@@ -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,191 +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.Class as Reflex
94−import Reflex.Dom.Builder.Class
95−import Reflex.Dynamic
96−import Reflex.DynamicWriter (DynamicWriterT)
97−import Reflex.EventWriter (EventWriterT)
98−import Reflex.Host.Class
99−import qualified Reflex.Patch.DMap as PatchDMap
100−import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
101−import Reflex.PerformEvent.Class
102−import Reflex.PostBuild.Base
103−import Reflex.PostBuild.Class
104−import Reflex.TriggerEvent.Base hiding (askEvents)
105−import qualified Reflex.TriggerEvent.Base as TriggerEventT (askEvents)
106−import Reflex.TriggerEvent.Class
107−import Reflex.Query.Base (QueryT)
108
119
109import Control.Concurrent
120import Control.Concurrent
110−import Control.Lens hiding (element, ix)
121+import Control.Exception (bracketOnError)
122+import Control.Lens (Identity(..), imapM_, iforM_, (^.), makeLenses)
111import Control.Monad.Exception
123import Control.Monad.Exception
112import Control.Monad.Primitive
124import Control.Monad.Primitive
113import Control.Monad.Reader
125import Control.Monad.Reader
114import Control.Monad.Ref
126import Control.Monad.Ref
115−import Control.Monad.State.Strict (StateT)
127+import Control.Monad.State.Strict (StateT, mapStateT, get, modify', gets, runStateT)
116−import qualified Control.Monad.State as Lazy (StateT)
117−#ifndef USE_TEMPLATE_HASKELL
118−import Data.Functor.Contravariant (phantom)
119−#endif
120import Data.Bitraversable
128import Data.Bitraversable
121import Data.Default
129import Data.Default
122import Data.Dependent.Map (DMap)
130import Data.Dependent.Map (DMap)
123−import qualified Data.Dependent.Map as DMap
124import Data.Dependent.Sum
131import Data.Dependent.Sum
132+import Data.FastMutableIntMap (PatchIntMap (..))
133+import Data.Foldable (for_, traverse_)
125import Data.Functor.Compose
134import Data.Functor.Compose
126import Data.Functor.Constant
135import Data.Functor.Constant
127import Data.Functor.Misc
136import Data.Functor.Misc
128import Data.Functor.Product
137import Data.Functor.Product
138+import Data.GADT.Compare (GCompare)
129import Data.IORef
139import Data.IORef
130−import qualified Data.Map as Map
140+import Data.IntMap.Strict (IntMap)
131import Data.Maybe
141import Data.Maybe
132−import Data.Monoid hiding (Product)
142+import Data.Monoid ((<>))
133−import Data.Some (Some)
143+import Data.Some (Some(..))
134−import qualified Data.Some as Some
144+import Data.GADT.Compare (GCompare)
145+import Data.String (IsString)
135import Data.Text (Text)
146import Data.Text (Text)
147+import Foreign.JavaScript.Internal.Utils
148+import Foreign.JavaScript.TH
149+import GHCJS.DOM.ClipboardEvent as ClipboardEvent
150+import GHCJS.DOM.Document (Document, createDocumentFragment, createElement, createElementNS, createTextNode, createComment)
151+import GHCJS.DOM.Element (getScrollTop, removeAttribute, removeAttributeNS, setAttribute, setAttributeNS, hasAttribute)
152+import GHCJS.DOM.EventM (EventM, event, on)
153+import GHCJS.DOM.KeyboardEvent as KeyboardEvent
154+import GHCJS.DOM.MouseEvent
155+import GHCJS.DOM.Node (appendChild_, getOwnerDocumentUnchecked, getParentNodeUnchecked, setNodeValue, toNode)
156+import GHCJS.DOM.Types (liftJSM, askJSM, runJSM, JSM, MonadJSM, FocusEvent, IsElement, IsEvent, IsNode, KeyboardEvent, Node, TouchEvent, WheelEvent, uncheckedCastTo, ClipboardEvent)
157+import GHCJS.DOM.UIEvent
158+import Language.Javascript.JSaddle (call, eval)
159+import Reflex.Adjustable.Class
160+import Reflex.Class as Reflex
161+import Reflex.Dom.Builder.Class
162+import Reflex.Dynamic
163+import Reflex.Host.Class
164+import Reflex.Patch.DMapWithMove (PatchDMapWithMove(..))
165+import Reflex.Patch.MapWithMove (PatchMapWithMove(..))
166+import Reflex.PerformEvent.Base (PerformEventT)
167+import Reflex.PerformEvent.Class
168+import Reflex.PostBuild.Base (PostBuildT)
169+import Reflex.PostBuild.Class
170+#ifdef PROFILE_REFLEX
171+import Reflex.Profiled
172+#endif
173+import Reflex.Requester.Base
174+import Reflex.Requester.Class
175+import Reflex.Spider (Spider, SpiderHost, Global)
176+import Reflex.TriggerEvent.Base hiding (askEvents)
177+import Reflex.TriggerEvent.Class
178+
179+import qualified Data.Dependent.Map as DMap
180+import qualified Data.FastMutableIntMap as FastMutableIntMap
181+import qualified Data.IntMap.Strict as IntMap
182+import qualified Data.Map as Map
136import qualified Data.Text as T
183import qualified Data.Text as T
137import qualified GHCJS.DOM as DOM
184import qualified GHCJS.DOM as DOM
138−import GHCJS.DOM.RequestAnimationFrameCallback
185+import qualified GHCJS.DOM.DataTransfer as DataTransfer
139−import GHCJS.DOM.Document (Document, createDocumentFragment, createElement, createElementNS, createTextNode)
186+import qualified GHCJS.DOM.DocumentAndElementEventHandlers as Events
140−import GHCJS.DOM.Element (getScrollTop, removeAttribute, removeAttributeNS, setAttribute, setAttributeNS)
187+import qualified GHCJS.DOM.DocumentOrShadowRoot as Document
141import qualified GHCJS.DOM.Element as Element
188import qualified GHCJS.DOM.Element as Element
142import qualified GHCJS.DOM.Event as Event
189import qualified GHCJS.DOM.Event as Event
143−import qualified GHCJS.DOM.GlobalEventHandlers as Events
144−import qualified GHCJS.DOM.DocumentAndElementEventHandlers as Events
145−import GHCJS.DOM.EventM (EventM, event, on)
146import qualified GHCJS.DOM.EventM as DOM
190import qualified GHCJS.DOM.EventM as DOM
147import qualified GHCJS.DOM.FileList as FileList
191import qualified GHCJS.DOM.FileList as FileList
192+import qualified GHCJS.DOM.GlobalEventHandlers as Events
148import qualified GHCJS.DOM.HTMLInputElement as Input
193import qualified GHCJS.DOM.HTMLInputElement as Input
149import qualified GHCJS.DOM.HTMLSelectElement as Select
194import qualified GHCJS.DOM.HTMLSelectElement as Select
150import qualified GHCJS.DOM.HTMLTextAreaElement as TextArea
195import qualified GHCJS.DOM.HTMLTextAreaElement as TextArea
151−import GHCJS.DOM.MouseEvent
196+import qualified GHCJS.DOM.Node as Node
197+import qualified GHCJS.DOM.Text as DOM
152import qualified GHCJS.DOM.Touch as Touch
198import qualified GHCJS.DOM.Touch as Touch
153import qualified GHCJS.DOM.TouchEvent as TouchEvent
199import qualified GHCJS.DOM.TouchEvent as TouchEvent
154import qualified GHCJS.DOM.TouchList as TouchList
200import qualified GHCJS.DOM.TouchList as TouchList
155−import GHCJS.DOM.Node (appendChild_, getOwnerDocumentUnchecked, getParentNodeUnchecked, setNodeValue, toNode)
156−import qualified GHCJS.DOM.Node as DOM (insertBefore_)
157−import GHCJS.DOM.Types
158− (liftJSM, askJSM, runJSM, JSM, MonadJSM,
159− FocusEvent, IsElement, IsEvent, IsNode, KeyboardEvent, Node,
160− ToDOMString, TouchEvent, WheelEvent, uncheckedCastTo, ClipboardEvent)
161import qualified GHCJS.DOM.Types as DOM
201import qualified GHCJS.DOM.Types as DOM
162−import GHCJS.DOM.UIEvent
163−import GHCJS.DOM.KeyboardEvent as KeyboardEvent
164import qualified GHCJS.DOM.Window as Window
202import qualified GHCJS.DOM.Window as Window
165−import Language.Javascript.JSaddle (call, eval)
203+import qualified GHCJS.DOM.WheelEvent as WheelEvent
166−import Data.IntMap.Strict (IntMap)
204+import qualified Reflex.Patch.DMap as PatchDMap
167−import qualified Data.IntMap.Strict as IntMap
205+import qualified Reflex.Patch.DMapWithMove as PatchDMapWithMove
168−import Data.FastMutableIntMap (PatchIntMap (..))
206+import qualified Reflex.Patch.MapWithMove as PatchMapWithMove
169−import qualified Data.FastMutableIntMap as FastMutableIntMap
207+import qualified Reflex.TriggerEvent.Base as TriggerEventT (askEvents)
170
208
171−import Reflex.Requester.Base
209+#ifndef USE_TEMPLATE_HASKELL
172−import Reflex.Requester.Class
210+import Data.Functor.Contravariant (phantom)
173−import Foreign.JavaScript.Internal.Utils
211+import Control.Lens (Lens', Getter)
212+#endif
174
213
175#ifndef ghcjs_HOST_OS
214#ifndef ghcjs_HOST_OS
176import GHCJS.DOM.Types (MonadJSM (..))
215import GHCJS.DOM.Types (MonadJSM (..))
177
216
178−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' #-}
179− liftJSM' = ImmediateDomBuilderT . liftJSM'
227+ liftJSM' = lift . liftJSM'
180#endif
228#endif
181
229
182−data ImmediateDomBuilderEnv t
230+data HydrationDomBuilderEnv t m = HydrationDomBuilderEnv
183− = ImmediateDomBuilderEnv { _immediateDomBuilderEnv_document :: {-# UNPACK #-} !Document
231+ { _hydrationDomBuilderEnv_document :: {-# UNPACK #-} !Document
184− , _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)
185− , _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 ())
186− , _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 ()))
187− }
244+ }
188
245
189−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 }
190 deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
252 deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
191#if MIN_VERSION_base(4,9,1)
253#if MIN_VERSION_base(4,9,1)
192 , MonadAsyncException
254 , MonadAsyncException
193#endif
255#endif
194 )
256 )
195
257
196−instance PrimMonad m => PrimMonad (ImmediateDomBuilderT x m) where
258+instance PrimMonad m => PrimMonad (HydrationDomBuilderT s t m) where
197− type PrimState (ImmediateDomBuilderT x m) = PrimState m
259+ type PrimState (HydrationDomBuilderT s t m) = PrimState m
198 primitive = lift . primitive
260 primitive = lift . primitive
199
261
200−instance MonadTrans (ImmediateDomBuilderT t) where
262+instance MonadTrans (HydrationDomBuilderT s t) where
201− lift = ImmediateDomBuilderT . lift . lift . lift
263+ lift = HydrationDomBuilderT . lift . lift
202
264
203−instance (Reflex t, MonadFix m) => DomRenderHook t (ImmediateDomBuilderT t m) where
265+instance (Reflex t, MonadFix m) => DomRenderHook t (HydrationDomBuilderT s t m) where
204− withRenderHook hook (ImmediateDomBuilderT a) = do
266+ withRenderHook hook = HydrationDomBuilderT . mapReaderT (withRenderHook hook) . unHydrationDomBuilderT
205− e <- ImmediateDomBuilderT ask
267+ requestDomAction = HydrationDomBuilderT . lift . requestDomAction
206− ImmediateDomBuilderT $ lift $ withRequesting $ \rsp -> do
268+ requestDomAction_ = HydrationDomBuilderT . lift . requestDomAction_
207− (x, req) <- lift $ runRequesterT (runReaderT a e) $ runIdentity <$> rsp
208− return (ffor req $ \rm -> hook $ traverseRequesterData (\r -> Identity <$> r) rm, x)
209− requestDomAction = ImmediateDomBuilderT . lift . requestingIdentity
210− requestDomAction_ = ImmediateDomBuilderT . lift . requesting_
211
269
212−{-# INLINABLE runImmediateDomBuilderT #-}
270+-- | The monad which performs the delayed actions to reuse prerendered nodes and set up events.
213−runImmediateDomBuilderT
271+-- State contains reference to the previous node sibling, if any, and the reader contains reference to the parent node.
272+newtype HydrationRunnerT t m a = HydrationRunnerT { unHydrationRunnerT :: StateT HydrationState (ReaderT Node (DomRenderHookT t m)) a }
273+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
274+#if MIN_VERSION_base(4,9,1)
275+ , MonadAsyncException
276+#endif
277+ )
278+
279+data HydrationState = HydrationState
280+ { _hydrationState_previousNode :: !(Maybe Node)
281+ , _hydrationState_failed :: !Bool
282+ }
283+
284+{-# INLINABLE localRunner #-}
285+localRunner :: (MonadJSM m, Monad m) => HydrationRunnerT t m a -> Maybe Node -> Node -> HydrationRunnerT t m a
286+localRunner (HydrationRunnerT m) s parent = do
287+ s0 <- HydrationRunnerT get
288+ (a, s') <- HydrationRunnerT $ lift $ local (\_ -> parent) $ runStateT m (s0 { _hydrationState_previousNode = s })
289+ traverse_ removeSubsequentNodes $ _hydrationState_previousNode s'
290+ HydrationRunnerT $ modify' $ \hs -> hs { _hydrationState_failed = _hydrationState_failed s' }
291+ pure a
292+
293+{-# INLINABLE runHydrationRunnerT #-}
294+runHydrationRunnerT
295+ :: (MonadRef m, Ref m ~ IORef, Monad m, PerformEvent t m, MonadFix m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m))
296+ => HydrationRunnerT t m a -> Maybe Node -> Node -> Chan [DSum (EventTriggerRef t) TriggerInvocation] -> m a
297+runHydrationRunnerT m = runHydrationRunnerTWithFailure m (pure ())
298+
299+{-# INLINABLE runHydrationRunnerTWithFailure #-}
300+runHydrationRunnerTWithFailure
301+ :: (MonadRef m, Ref m ~ IORef, Monad m, PerformEvent t m, MonadFix m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m))
302+ => HydrationRunnerT t m a -> IO () -> Maybe Node -> Node -> Chan [DSum (EventTriggerRef t) TriggerInvocation] -> m a
303+runHydrationRunnerTWithFailure (HydrationRunnerT m) onFailure s parent events = flip runDomRenderHookT events $ flip runReaderT parent $ do
304+ (a, s') <- runStateT m (HydrationState s False)
305+ traverse_ removeSubsequentNodes $ _hydrationState_previousNode s'
306+ when (_hydrationState_failed s') $ liftIO $ putStrLn "reflex-dom warning: hydration failed: the DOM was not as expected at switchover time. This may be due to invalid HTML which the browser has altered upon parsing, some external JS altering the DOM, or the page being served from an outdated cache."
307+ when (_hydrationState_failed s') $ liftIO onFailure
308+ pure a
309+
310+
311+
312+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydrationRunnerT t m) where
313+ {-# INLINABLE newEventWithTrigger #-}
314+ newEventWithTrigger = lift . newEventWithTrigger
315+ {-# INLINABLE newFanEventWithTrigger #-}
316+ newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
317+
318+instance MonadTrans (HydrationRunnerT t) where
319+ {-# INLINABLE lift #-}
320+ lift = HydrationRunnerT . lift . lift . lift
321+
322+instance MonadSample t m => MonadSample t (HydrationRunnerT t m) where
323+ {-# INLINABLE sample #-}
324+ sample = lift . sample
325+
326+instance (Reflex t, MonadFix m) => DomRenderHook t (HydrationRunnerT t m) where
327+ withRenderHook hook = HydrationRunnerT . mapStateT (mapReaderT (withRenderHook hook)) . unHydrationRunnerT
328+ requestDomAction = HydrationRunnerT . lift . lift . requestDomAction
329+ requestDomAction_ = HydrationRunnerT . lift . lift . requestDomAction_
330+
331+-- | Add a hydration step which depends on some computation that should only be
332+-- done *before* the switchover to immediate mode - this is most likely some
333+-- form of 'hold' which we want to remove after hydration is done
334+{-# INLINABLE addHydrationStepWithSetup #-}
335+addHydrationStepWithSetup :: MonadIO m => m a -> (a -> HydrationRunnerT t m ()) -> HydrationDomBuilderT s t m ()
336+addHydrationStepWithSetup setup f = getHydrationMode >>= \case
337+ HydrationMode_Immediate -> pure ()
338+ HydrationMode_Hydrating -> do
339+ s <- lift setup
340+ addHydrationStep (f s)
341+
342+-- | Add a hydration step
343+{-# INLINABLE addHydrationStep #-}
344+addHydrationStep :: MonadIO m => HydrationRunnerT t m () -> HydrationDomBuilderT s t m ()
345+addHydrationStep m = do
346+ delayedRef <- HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_delayed
347+ liftIO $ modifyIORef' delayedRef (>> m)
348+
349+-- | Shared behavior for HydrationDomBuilderT and HydrationRunnerT
350+newtype DomRenderHookT t m a = DomRenderHookT { unDomRenderHookT :: RequesterT t JSM Identity (TriggerEventT t m) a }
351+ deriving (Functor, Applicative, Monad, MonadFix, MonadIO, MonadException
352+#if MIN_VERSION_base(4,9,1)
353+ , MonadAsyncException
354+#endif
355+ )
356+
357+{-# INLINABLE runDomRenderHookT #-}
358+runDomRenderHookT
359+ :: (MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadJSM m, MonadJSM (Performable m), MonadRef m, Ref m ~ IORef)
360+ => DomRenderHookT t m a
361+ -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
362+ -> m a
363+runDomRenderHookT (DomRenderHookT a) events = do
364+ flip runTriggerEventT events $ do
365+ rec (result, req) <- runRequesterT a rsp
366+ rsp <- performEventAsync $ ffor req $ \rm f -> liftJSM $ runInAnimationFrame f $
367+ traverseRequesterData (fmap Identity) rm
368+ return result
369+ where
370+ runInAnimationFrame f x = void . DOM.inAnimationFrame' $ \_ -> do
371+ v <- synchronously x
372+ void . liftIO $ f v
373+
374+instance MonadTrans (DomRenderHookT t) where
375+ {-# INLINABLE lift #-}
376+ lift = DomRenderHookT . lift . lift
377+
378+instance (Reflex t, MonadFix m) => DomRenderHook t (DomRenderHookT t m) where
379+ withRenderHook hook (DomRenderHookT a) = do
380+ DomRenderHookT $ withRequesting $ \rsp -> do
381+ (x, req) <- lift $ runRequesterT a $ runIdentity <$> rsp
382+ return (ffor req $ \rm -> hook $ traverseRequesterData (fmap Identity) rm, x)
383+ requestDomAction = DomRenderHookT . requestingIdentity
384+ requestDomAction_ = DomRenderHookT . requesting_
385+
386+{-# INLINABLE runHydrationDomBuilderT #-}
387+runHydrationDomBuilderT
214 :: ( MonadFix m
388 :: ( MonadFix m
215 , PerformEvent t m
389 , PerformEvent t m
216 , MonadReflexCreateTrigger t m
390 , MonadReflexCreateTrigger t m
@@ -219,64 +393,76 @@ runImmediateDomBuilderT
219 , MonadRef m
393 , MonadRef m
220 , Ref m ~ IORef
394 , Ref m ~ IORef
221 )
395 )
222− => ImmediateDomBuilderT t m a
396+ => HydrationDomBuilderT s t m a
223− -> ImmediateDomBuilderEnv t
397+ -> HydrationDomBuilderEnv t m
224 -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
398 -> Chan [DSum (EventTriggerRef t) TriggerInvocation]
225 -> m a
399 -> m a
226−runImmediateDomBuilderT (ImmediateDomBuilderT a) env eventChan =
400+runHydrationDomBuilderT (HydrationDomBuilderT a) env = runDomRenderHookT (runReaderT a env)
227− flip runTriggerEventT eventChan $ do
228− rec (x, req) <- runRequesterT (runReaderT a env) rsp
229− rsp <- performEventAsync $ ffor req $ \rm f -> liftJSM $ runInAnimationFrame f $
230− traverseRequesterData (\r -> Identity <$> r) rm
231− return x
232− where
233− runInAnimationFrame f x = void . DOM.inAnimationFrame' $ \_ -> do
234− v <- synchronously x
235− void . liftIO $ f v
236
401
237−class Monad m => HasDocument m where
402+instance (RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document, Monad m) => HasDocument (HydrationDomBuilderT s t m) where
238− askDocument :: m Document
239− default askDocument :: (m ~ f m', MonadTrans f, Monad m', HasDocument m') => m Document
240− askDocument = lift askDocument
241−
242−instance HasDocument m => HasDocument (ReaderT r m)
243−instance HasDocument m => HasDocument (StateT s m)
244−instance HasDocument m => HasDocument (Lazy.StateT s m)
245−instance HasDocument m => HasDocument (EventWriterT t w m)
246−instance HasDocument m => HasDocument (DynamicWriterT t w m)
247−instance HasDocument m => HasDocument (PostBuildT t m)
248−instance HasDocument m => HasDocument (RequesterT t request response m)
249−instance HasDocument m => HasDocument (QueryT t q m)
250−
251−instance Monad m => HasDocument (ImmediateDomBuilderT t m) where
252 {-# INLINABLE askDocument #-}
403 {-# INLINABLE askDocument #-}
253− askDocument = ImmediateDomBuilderT $ asks _immediateDomBuilderEnv_document
404+ askDocument = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_document
254
405
255{-# INLINABLE askParent #-}
406{-# INLINABLE askParent #-}
256−askParent :: Monad m => ImmediateDomBuilderT t m Node
407+askParent :: Monad m => HydrationRunnerT t m DOM.Node
257−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)
258
413
259{-# INLINABLE askEvents #-}
414{-# INLINABLE askEvents #-}
260−askEvents :: Monad m => ImmediateDomBuilderT t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
415+askEvents :: Monad m => HydrationDomBuilderT s t m (Chan [DSum (EventTriggerRef t) TriggerInvocation])
261−askEvents = ImmediateDomBuilderT . lift . lift $ TriggerEventT.askEvents
416+askEvents = HydrationDomBuilderT . lift . DomRenderHookT . lift $ TriggerEventT.askEvents
262
417
263−localEnv :: Monad m => (ImmediateDomBuilderEnv t -> ImmediateDomBuilderEnv t) -> ImmediateDomBuilderT t m a -> ImmediateDomBuilderT t m a
418+{-# INLINABLE localEnv #-}
264−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
265
421
266{-# INLINABLE append #-}
422{-# INLINABLE append #-}
267−append :: MonadJSM m => DOM.Node -> ImmediateDomBuilderT t m ()
423+append :: MonadJSM m => DOM.Node -> HydrationDomBuilderT s t m ()
268append n = do
424append n = do
269− p <- askParent
425+ p <- getParent
270 liftJSM $ appendChild_ p n
426 liftJSM $ appendChild_ p n
271 return ()
427 return ()
272
428
273−{-# INLINABLE textNodeInternal #-}
429+{-# SPECIALIZE append
274−textNodeInternal :: (MonadJSM m, ToDOMString contents) => contents -> ImmediateDomBuilderT t m DOM.Text
430+ :: DOM.Node
275−textNodeInternal !t = do
431+ -> HydrationDomBuilderT s Spider HydrationM ()
276− doc <- askDocument
432+ #-}
277− n <- liftJSM $ createTextNode doc t
433+
278− append $ toNode n
434+data HydrationMode
279− return n
435+ = HydrationMode_Hydrating
436+ -- ^ The time from initial load to parity with static builder
437+ | HydrationMode_Immediate
438+ -- ^ After hydration
439+ deriving (Eq, Ord, Show)
440+
441+{-# INLINABLE getPreviousNode #-}
442+getPreviousNode :: Monad m => HydrationRunnerT t m (Maybe DOM.Node)
443+getPreviousNode = HydrationRunnerT $ gets _hydrationState_previousNode
444+
445+{-# INLINABLE setPreviousNode #-}
446+setPreviousNode :: Monad m => Maybe DOM.Node -> HydrationRunnerT t m ()
447+setPreviousNode n = HydrationRunnerT $ modify' (\hs -> hs { _hydrationState_previousNode = n })
448+
449+{-# INLINABLE askUnreadyChildren #-}
450+askUnreadyChildren :: Monad m => HydrationDomBuilderT s t m (IORef Word)
451+askUnreadyChildren = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_unreadyChildren
452+
453+{-# INLINABLE askCommitAction #-}
454+askCommitAction :: Monad m => HydrationDomBuilderT s t m (JSM ())
455+askCommitAction = HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_commitAction
456+
457+{-# INLINABLE getHydrationMode #-}
458+getHydrationMode :: MonadIO m => HydrationDomBuilderT s t m HydrationMode
459+getHydrationMode = liftIO . readIORef =<< HydrationDomBuilderT (asks _hydrationDomBuilderEnv_hydrationMode)
460+
461+-- | Remove all nodes after given node
462+removeSubsequentNodes :: (MonadJSM m, IsNode n) => n -> m ()
463+removeSubsequentNodes n = liftJSM $ do
464+ f <- eval ("(function(n) { while (n.nextSibling) { (n.parentNode).removeChild(n.nextSibling); }; })" :: Text)
465+ void $ call f f [n]
280
466
281-- | 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;
282-- 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
@@ -314,7 +500,7 @@ extractUpTo df s e = liftJSM $ do
314 void $ call f f (df, s, e)
500 void $ call f f (df, s, e)
315#endif
501#endif
316
502
317−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))
318
504
319{-# INLINABLE collectUpTo #-}
505{-# INLINABLE collectUpTo #-}
320collectUpTo :: (MonadJSM m, IsNode start, IsNode end) => start -> end -> m DOM.DocumentFragment
506collectUpTo :: (MonadJSM m, IsNode start, IsNode end) => start -> end -> m DOM.DocumentFragment
@@ -332,10 +518,15 @@ collectUpToGivenParent currentParent s e = do
332
518
333newtype 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))))
334
520
335−{-# INLINABLE wrap #-}
521+-- | This 'wrap' is only partial: it doesn't create the 'EventSelector' itself
522+{-# INLINE wrap #-}
523+wrap
336−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))
337−wrap e cfg = do
529+wrap events e cfg = do
338− events <- askEvents
339 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
340 Nothing -> maybe (removeAttribute e n) (setAttribute e n) mv
531 Nothing -> maybe (removeAttribute e n) (setAttribute e n) mv
341 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
@@ -352,46 +543,74 @@ wrap e cfg = do
352 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
353 liftIO $ forM_ mv $ \v -> writeChan events [EventTriggerRef triggerRef :=> TriggerInvocation v (return ())]
544 liftIO $ forM_ mv $ \v -> writeChan events [EventTriggerRef triggerRef :=> TriggerInvocation v (return ())]
354 return $ en :=> EventFilterTriggerRef triggerRef
545 return $ en :=> EventFilterTriggerRef triggerRef
355− es <- do
546+ return eventTriggerRefs
356− let h :: GhcjsEventHandler er
547+
357− !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
358− ctx <- askJSM
549+ :: Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
359− 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 ())
360− case DMap.lookup en eventTriggerRefs of
573+triggerBody ctx cfg events eventTriggerRefs e (WrapArg en) t = case DMap.lookup en eventTriggerRefs of
361− Just (EventFilterTriggerRef r) -> do
574+ Just (EventFilterTriggerRef r) -> do
362− writeIORef r $ Just t
575+ writeIORef r $ Just t
363− return $ do
576+ return $ do
364− writeIORef r Nothing
577+ writeIORef r Nothing
365− Nothing -> (`runJSM` ctx) <$> (`runJSM` ctx) (elementOnEventName en e $ do
578+ Nothing -> (`runJSM` ctx) <$> (`runJSM` ctx) (elementOnEventName en e $ do
366− evt <- DOM.event
579+ evt <- DOM.event
367− mv <- lift $ unGhcjsEventHandler h (en, GhcjsDomEvent evt)
580+ mv <- lift $ unGhcjsEventHandler handler (en, GhcjsDomEvent evt)
368− case mv of
581+ case mv of
369− Nothing -> return ()
582+ Nothing -> return ()
370− Just v -> liftIO $ do
583+ Just v -> liftIO $ do
371− --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
372− ref <- newIORef $ Just t
585+ ref <- newIORef $ Just t
373− writeChan events [EventTriggerRef ref :=> TriggerInvocation v (return ())])
586+ writeChan events [EventTriggerRef ref :=> TriggerInvocation v (return ())])
374− return $ Element
587+ where
375− { _element_events = es
588+ -- Note: this needs to be done strictly and outside of the newFanEventWithTrigger, so that the newFanEventWithTrigger doesn't
376− , _element_raw = e
589+ -- retain the entire cfg, which can cause a cyclic dependency that the GC won't be able to clean up
377− }
590+ handler :: GhcjsEventHandler er
378−
591+ !handler = _ghcjsEventSpec_handler $ _rawElementConfig_eventSpec cfg
379−{-# INLINABLE makeElement #-}
592+
380−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
381−makeElement elementTag cfg child = do
594+ :: DOM.JSContextRef
382− doc <- askDocument
595+ -> RawElementConfig er DomTimeline HydrationDomSpace
383− e <- liftJSM $ uncheckedCastTo DOM.Element <$> case cfg ^. namespace of
596+ -> Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
384− Nothing -> createElement doc elementTag
597+ -> DMap EventName (EventFilterTriggerRef DomTimeline er)
385− Just ens -> createElementNS doc (Just ens) elementTag
598+ -> DOM.Element
386− ImmediateDomBuilderT $ iforM_ (cfg ^. initialAttributes) $ \(AttributeName mAttrNamespace n) v -> case mAttrNamespace of
599+ -> WrapArg er EventName x
387− Nothing -> lift $ setAttribute e n v
600+ -> EventTrigger DomTimeline x
388− Just ans -> lift $ setAttributeNS e (Just ans) n v
601+ -> IO (IO ())
389− result <- flip localEnv child $ \env -> env
602+ #-}
390− { _immediateDomBuilderEnv_parent = toNode e
603+
391− }
604+{-# SPECIALIZE triggerBody
392− append $ toNode e
605+ :: DOM.JSContextRef
393− wrapped <- wrap e $ extractRawElementConfig cfg
606+ -> RawElementConfig er DomTimeline GhcjsDomSpace
394− 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+ #-}
395
614
396newtype GhcjsDomHandler a b = GhcjsDomHandler { unGhcjsDomHandler :: a -> JSM b }
615newtype GhcjsDomHandler a b = GhcjsDomHandler { unGhcjsDomHandler :: a -> JSM b }
397
616
@@ -403,9 +622,10 @@ data GhcjsDomSpace
403
622
404instance DomSpace GhcjsDomSpace where
623instance DomSpace GhcjsDomSpace where
405 type EventSpec GhcjsDomSpace = GhcjsEventSpec
624 type EventSpec GhcjsDomSpace = GhcjsEventSpec
625+ type RawDocument GhcjsDomSpace = DOM.Document
406 type RawTextNode GhcjsDomSpace = DOM.Text
626 type RawTextNode GhcjsDomSpace = DOM.Text
627+ type RawCommentNode GhcjsDomSpace = DOM.Comment
407 type RawElement GhcjsDomSpace = DOM.Element
628 type RawElement GhcjsDomSpace = DOM.Element
408− type RawFile GhcjsDomSpace = DOM.File
409 type RawInputElement GhcjsDomSpace = DOM.HTMLInputElement
629 type RawInputElement GhcjsDomSpace = DOM.HTMLInputElement
410 type RawTextAreaElement GhcjsDomSpace = DOM.HTMLTextAreaElement
630 type RawTextAreaElement GhcjsDomSpace = DOM.HTMLTextAreaElement
411 type RawSelectElement GhcjsDomSpace = DOM.HTMLSelectElement
631 type RawSelectElement GhcjsDomSpace = DOM.HTMLSelectElement
@@ -437,15 +657,11 @@ data GhcjsEventSpec er = GhcjsEventSpec
437newtype 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)) }
438
658
439#ifndef USE_TEMPLATE_HASKELL
659#ifndef USE_TEMPLATE_HASKELL
440−phantom2 :: (Functor f, Contravariant f) => f a -> f b
441−phantom2 = phantom
442−{-# INLINE phantom2 #-}
443−
444ghcjsEventSpec_filters :: forall er . Lens' (GhcjsEventSpec er) (DMap EventName (GhcjsEventFilter er))
660ghcjsEventSpec_filters :: forall er . Lens' (GhcjsEventSpec er) (DMap EventName (GhcjsEventFilter er))
445ghcjsEventSpec_filters f (GhcjsEventSpec a b) = (\a' -> GhcjsEventSpec a' b) <$> f a
661ghcjsEventSpec_filters f (GhcjsEventSpec a b) = (\a' -> GhcjsEventSpec a' b) <$> f a
446{-# INLINE ghcjsEventSpec_filters #-}
662{-# INLINE ghcjsEventSpec_filters #-}
447ghcjsEventSpec_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)))
448−ghcjsEventSpec_handler f (GhcjsEventSpec _ (GhcjsEventHandler b)) = phantom2 (f b)
664+ghcjsEventSpec_handler f (GhcjsEventSpec _ (GhcjsEventHandler b)) = phantom (f b)
449{-# INLINE ghcjsEventSpec_handler #-}
665{-# INLINE ghcjsEventSpec_handler #-}
450#endif
666#endif
451
667
@@ -458,137 +674,794 @@ instance er ~ EventResult => Default (GhcjsEventSpec er) where
458 runReaderT (defaultDomEventHandler e en) evt
674 runReaderT (defaultDomEventHandler e en) evt
459 }
675 }
460
676
461−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
462 notReadyUntil e = do
1387 notReadyUntil e = do
463 eOnce <- headE e
1388 eOnce <- headE e
464− env <- ImmediateDomBuilderT ask
1389+ unreadyChildren <- askUnreadyChildren
465− let unreadyChildren = _immediateDomBuilderEnv_unreadyChildren env
1390+ commitAction <- askCommitAction
466 liftIO $ modifyIORef' unreadyChildren succ
1391 liftIO $ modifyIORef' unreadyChildren succ
467 let ready = do
1392 let ready = do
468 old <- liftIO $ readIORef unreadyChildren
1393 old <- liftIO $ readIORef unreadyChildren
469 let new = pred old
1394 let new = pred old
470 liftIO $ writeIORef unreadyChildren $! new
1395 liftIO $ writeIORef unreadyChildren $! new
471− when (new == 0) $ _immediateDomBuilderEnv_commitAction env
1396+ when (new == 0) commitAction
472 requestDomAction_ $ ready <$ eOnce
1397 requestDomAction_ $ ready <$ eOnce
473 notReady = do
1398 notReady = do
474− env <- ImmediateDomBuilderT ask
1399+ unreadyChildren <- askUnreadyChildren
475− let unreadyChildren = _immediateDomBuilderEnv_unreadyChildren env
476 liftIO $ modifyIORef' unreadyChildren succ
1400 liftIO $ modifyIORef' unreadyChildren succ
477
1401
478−instance SupportsImmediateDomBuilder t m => DomBuilder t (ImmediateDomBuilderT t m) where
1402+data HydrationDomSpace
479− 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
480 {-# INLINABLE textNode #-}
1431 {-# INLINABLE textNode #-}
481− textNode (TextNodeConfig initialContents mSetContents) = do
1432+ textNode = textNodeInternal
482− n <- textNodeInternal initialContents
1433+ {-# INLINABLE commentNode #-}
483− mapM_ (requestDomAction_ . fmap (setNodeValue n . Just)) mSetContents
1434+ commentNode = commentNodeInternal
484− return $ TextNode n
1435+ {-# INLINABLE inputElement #-}
1436+ inputElement = inputElementInternal
1437+ {-# INLINABLE textAreaElement #-}
1438+ textAreaElement = textAreaElementInternal
1439+ {-# INLINABLE selectElement #-}
1440+ selectElement = selectElementInternal
1441+ placeRawElement () = pure ()
1442+ wrapRawElement () _cfg = pure $ Element (EventSelector $ const never) ()
1443+
1444+instance SupportsHydrationDomBuilder t m => DomBuilder t (HydrationDomBuilderT GhcjsDomSpace t m) where
1445+ type DomBuilderSpace (HydrationDomBuilderT GhcjsDomSpace t m) = GhcjsDomSpace
485 {-# INLINABLE element #-}
1446 {-# INLINABLE element #-}
486− 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
487 {-# INLINABLE inputElement #-}
1452 {-# INLINABLE inputElement #-}
488− inputElement cfg = do
1453+ inputElement = inputElementImmediate
489− ((e, _), domElement) <- makeElement "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
490− let domInputElement = uncheckedCastTo DOM.HTMLInputElement domElement
491− Input.setValue domInputElement $ cfg ^. inputElementConfig_initialValue
492− v0 <- Input.getValue domInputElement
493− let getMyValue = Input.getValue domInputElement
494− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Input)
495− valueChangedBySetValue <- case _inputElementConfig_setValue cfg of
496− Nothing -> return never
497− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
498− Input.setValue domInputElement v'
499− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
500− v <- holdDyn v0 $ leftmost
501− [ valueChangedBySetValue
502− , valueChangedByUI
503− ]
504− Input.setChecked domInputElement $ _inputElementConfig_initialChecked cfg
505− checkedChangedByUI <- wrapDomEvent domInputElement (`on` Events.click) $ do
506− Input.getChecked domInputElement
507− checkedChangedBySetChecked <- case _inputElementConfig_setChecked cfg of
508− Nothing -> return never
509− Just eNewchecked -> requestDomAction $ ffor eNewchecked $ \newChecked -> do
510− oldChecked <- Input.getChecked domInputElement
511− Input.setChecked domInputElement newChecked
512− return $ if newChecked /= oldChecked
513− then Just newChecked
514− else Nothing
515− c <- holdDyn (_inputElementConfig_initialChecked cfg) $ leftmost
516− [ fmapMaybe id checkedChangedBySetChecked
517− , checkedChangedByUI
518− ]
519− let initialFocus = False --TODO: Is this correct?
520− hasFocus <- holdDyn initialFocus $ leftmost
521− [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
522− , True <$ Reflex.select (_element_events e) (WrapArg Focus)
523− ]
524− files <- holdDyn mempty <=< wrapDomEvent domInputElement (`on` Events.change) $ do
525− mfiles <- Input.getFiles domInputElement
526− let getMyFiles xs = fmap catMaybes . mapM (FileList.item xs) . flip take [0..] . fromIntegral =<< FileList.getLength xs
527− maybe (return []) getMyFiles mfiles
528− checked <- holdUniqDyn c
529− return $ InputElement
530− { _inputElement_value = v
531− , _inputElement_checked = checked
532− , _inputElement_checkedChange = checkedChangedByUI
533− , _inputElement_input = valueChangedByUI
534− , _inputElement_hasFocus = hasFocus
535− , _inputElement_element = e
536− , _inputElement_raw = domInputElement
537− , _inputElement_files = files
538− }
539 {-# INLINABLE textAreaElement #-}
1454 {-# INLINABLE textAreaElement #-}
540− textAreaElement cfg = do --TODO
1455+ textAreaElement = textAreaElementImmediate
541− ((e, _), domElement) <- makeElement "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
542− let domTextAreaElement = uncheckedCastTo DOM.HTMLTextAreaElement domElement
543− TextArea.setValue domTextAreaElement $ cfg ^. textAreaElementConfig_initialValue
544− v0 <- TextArea.getValue domTextAreaElement
545− let getMyValue = TextArea.getValue domTextAreaElement
546− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Input)
547− valueChangedBySetValue <- case _textAreaElementConfig_setValue cfg of
548− Nothing -> return never
549− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
550− TextArea.setValue domTextAreaElement v'
551− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
552− v <- holdDyn v0 $ leftmost
553− [ valueChangedBySetValue
554− , valueChangedByUI
555− ]
556− hasFocus <- mkHasFocus e
557− return $ TextAreaElement
558− { _textAreaElement_value = v
559− , _textAreaElement_input = valueChangedByUI
560− , _textAreaElement_hasFocus = hasFocus
561− , _textAreaElement_element = e
562− , _textAreaElement_raw = domTextAreaElement
563− }
564 {-# INLINABLE selectElement #-}
1456 {-# INLINABLE selectElement #-}
565− selectElement cfg child = do
1457+ selectElement = selectElementImmediate
566− ((e, result), domElement) <- makeElement "select" (cfg ^. selectElementConfig_elementConfig) child
567− let domSelectElement = uncheckedCastTo DOM.HTMLSelectElement domElement
568− Select.setValue domSelectElement $ cfg ^. selectElementConfig_initialValue
569− v0 <- Select.getValue domSelectElement
570− let getMyValue = Select.getValue domSelectElement
571− valueChangedByUI <- requestDomAction $ liftJSM getMyValue <$ Reflex.select (_element_events e) (WrapArg Change)
572− valueChangedBySetValue <- case _selectElementConfig_setValue cfg of
573− Nothing -> return never
574− Just eSetValue -> requestDomAction $ ffor eSetValue $ \v' -> do
575− Select.setValue domSelectElement v'
576− getMyValue -- We get the value after setting it in case the browser has mucked with it somehow
577− v <- holdDyn v0 $ leftmost
578− [ valueChangedBySetValue
579− , valueChangedByUI
580− ]
581− hasFocus <- mkHasFocus e
582− let wrapped = SelectElement
583− { _selectElement_value = v
584− , _selectElement_change = valueChangedByUI
585− , _selectElement_hasFocus = hasFocus
586− , _selectElement_element = e
587− , _selectElement_raw = domSelectElement
588− }
589− return (wrapped, result)
590 placeRawElement = append . toNode
1458 placeRawElement = append . toNode
591− 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
592
1465
593data FragmentState
1466data FragmentState
594 = FragmentState_Unmounted
1467 = FragmentState_Unmounted
@@ -608,21 +1481,21 @@ extractFragment fragment = do
608 extractBetweenExclusive (_immediateDomFragment_document fragment) before after
1481 extractBetweenExclusive (_immediateDomFragment_document fragment) before after
609 liftIO $ writeIORef (_immediateDomFragment_state fragment) FragmentState_Unmounted
1482 liftIO $ writeIORef (_immediateDomFragment_state fragment) FragmentState_Unmounted
610
1483
611−instance SupportsImmediateDomBuilder t m => MountableDomBuilder t (ImmediateDomBuilderT t m) where
1484+instance SupportsHydrationDomBuilder t m => MountableDomBuilder t (HydrationDomBuilderT GhcjsDomSpace t m) where
612− type DomFragment (ImmediateDomBuilderT t m) = ImmediateDomFragment
1485+ type DomFragment (HydrationDomBuilderT GhcjsDomSpace t m) = ImmediateDomFragment
613 buildDomFragment w = do
1486 buildDomFragment w = do
614 df <- createDocumentFragment =<< askDocument
1487 df <- createDocumentFragment =<< askDocument
615 result <- flip localEnv w $ \env -> env
1488 result <- flip localEnv w $ \env -> env
616− { _immediateDomBuilderEnv_parent = toNode df
1489+ { _hydrationDomBuilderEnv_parent = Left $ toNode df
617 }
1490 }
618 state <- liftIO $ newIORef FragmentState_Unmounted
1491 state <- liftIO $ newIORef FragmentState_Unmounted
619 return (ImmediateDomFragment df state, result)
1492 return (ImmediateDomFragment df state, result)
620 mountDomFragment fragment setFragment = do
1493 mountDomFragment fragment setFragment = do
621− parent <- askParent
1494+ parent <- getParent
622 extractFragment fragment
1495 extractFragment fragment
623− before <- textNodeInternal ("" :: Text)
1496+ before <- textNodeImmediate $ TextNodeConfig ("" :: Text) Nothing
624 appendChild_ parent $ _immediateDomFragment_document fragment
1497 appendChild_ parent $ _immediateDomFragment_document fragment
625− after <- textNodeInternal ("" :: Text)
1498+ after <- textNodeImmediate $ TextNodeConfig ("" :: Text) Nothing
626 xs <- foldDyn (\new (previous, _) -> (new, Just previous)) (fragment, Nothing) setFragment
1499 xs <- foldDyn (\new (previous, _) -> (new, Just previous)) (fragment, Nothing) setFragment
627 requestDomAction_ $ ffor (updated xs) $ \(childFragment, Just previousFragment) -> do
1500 requestDomAction_ $ ffor (updated xs) $ \(childFragment, Just previousFragment) -> do
628 extractFragment previousFragment
1501 extractFragment previousFragment
@@ -631,12 +1504,19 @@ instance SupportsImmediateDomBuilder t m => MountableDomBuilder t (ImmediateDomB
631 liftIO $ writeIORef (_immediateDomFragment_state childFragment) $ FragmentState_Mounted (before, after)
1504 liftIO $ writeIORef (_immediateDomFragment_state childFragment) $ FragmentState_Mounted (before, after)
632 liftIO $ writeIORef (_immediateDomFragment_state fragment) $ FragmentState_Mounted (before, after)
1505 liftIO $ writeIORef (_immediateDomFragment_state fragment) $ FragmentState_Mounted (before, after)
633
1506
634−instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimMonad m) => Adjustable t (ImmediateDomBuilderT t m) where
1507+instance (Reflex t, Monad m, Adjustable t m, MonadHold t m, MonadFix m) => Adjustable t (DomRenderHookT t m) where
1508+ runWithReplace a0 a' = DomRenderHookT $ runWithReplace (unDomRenderHookT a0) (fmapCheap unDomRenderHookT a')
1509+ traverseIntMapWithKeyWithAdjust f m = DomRenderHookT . traverseIntMapWithKeyWithAdjust (\k -> unDomRenderHookT . f k) m
1510+ traverseDMapWithKeyWithAdjust f m = DomRenderHookT . traverseDMapWithKeyWithAdjust (\k -> unDomRenderHookT . f k) m
1511+ traverseDMapWithKeyWithAdjustWithMove f m = DomRenderHookT . traverseDMapWithKeyWithAdjustWithMove (\k -> unDomRenderHookT . f k) m
1512+
1513+instance (Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimMonad m, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document) => Adjustable t (HydrationDomBuilderT s t m) where
635 {-# INLINABLE runWithReplace #-}
1514 {-# INLINABLE runWithReplace #-}
636 runWithReplace a0 a' = do
1515 runWithReplace a0 a' = do
637− initialEnv <- ImmediateDomBuilderT ask
1516+ initialEnv <- HydrationDomBuilderT ask
638− before <- textNodeInternal ("" :: Text)
1517+ let hydrating = _hydrationDomBuilderEnv_hydrationMode initialEnv
639− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
1518+ (hydrateStart, before, beforeKey) <- skipToReplaceStart
1519+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
640 haveEverBeenReady <- liftIO $ newIORef False
1520 haveEverBeenReady <- liftIO $ newIORef False
641 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
642 let myCommitAction = do
1522 let myCommitAction = do
@@ -647,79 +1527,117 @@ instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimM
647 old <- liftIO $ readIORef parentUnreadyChildren
1527 old <- liftIO $ readIORef parentUnreadyChildren
648 let new = pred old
1528 let new = pred old
649 liftIO $ writeIORef parentUnreadyChildren $! new
1529 liftIO $ writeIORef parentUnreadyChildren $! new
650− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
1530+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
651 -- We draw 'after' in this roundabout way to avoid using MonadFix
1531 -- We draw 'after' in this roundabout way to avoid using MonadFix
652 doc <- askDocument
1532 doc <- askDocument
653− after <- createTextNode doc ("" :: Text)
1533+ parent <- getParent
1534+ (hydrateEnd, after) <- skipToReplaceEnd beforeKey
654 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
655 unreadyChildren <- liftIO $ newIORef 0
1540 unreadyChildren <- liftIO $ newIORef 0
656− let f = do
1541+ let a0' = case h of
657− result <- a0
1542+ HydrationMode_Hydrating -> a0
658− append $ toNode after
1543+ HydrationMode_Immediate -> do
659− return result
1544+ a <- a0
660− result <- runReaderT (unImmediateDomBuilderT f) $ initialEnv
1545+ insertBefore p' =<< liftIO (readIORef after)
661− { _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
1546+ pure a
662− , _immediateDomBuilderEnv_commitAction = myCommitAction
1547+ delayed <- case h of
1548+ HydrationMode_Hydrating -> liftIO $ newIORef $ pure ()
1549+ HydrationMode_Immediate -> pure $ _hydrationDomBuilderEnv_delayed initialEnv
1550+ result <- runReaderT (unHydrationDomBuilderT a0') initialEnv
1551+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1552+ , _hydrationDomBuilderEnv_commitAction = myCommitAction
1553+ , _hydrationDomBuilderEnv_parent = Left p'
1554+ , _hydrationDomBuilderEnv_delayed = delayed
663 }
1555 }
1556+ dom <- case h of
1557+ HydrationMode_Hydrating -> liftIO $ readIORef delayed
1558+ HydrationMode_Immediate -> pure $ pure ()
664 liftIO $ readIORef unreadyChildren >>= \case
1559 liftIO $ readIORef unreadyChildren >>= \case
665 0 -> writeIORef haveEverBeenReady True
1560 0 -> writeIORef haveEverBeenReady True
666 _ -> modifyIORef' parentUnreadyChildren succ
1561 _ -> modifyIORef' parentUnreadyChildren succ
667− return result
1562+ return (dom, result)
668 a'' <- numberOccurrences a'
1563 a'' <- numberOccurrences a'
669− (result0, child') <- ImmediateDomBuilderT $ lift $ runWithReplace drawInitialChild $ ffor a'' $ \(cohortId, child) -> do
1564+ ((hydrate0, result0), child') <- HydrationDomBuilderT $ lift $ runWithReplace drawInitialChild $ ffor a'' $ \(cohortId, child) -> do
670− df <- createDocumentFragment doc
1565+ h <- liftIO $ readIORef hydrating
1566+ p' <- case h of
1567+ HydrationMode_Hydrating -> pure parent
1568+ HydrationMode_Immediate -> toNode <$> createDocumentFragment doc
671 unreadyChildren <- liftIO $ newIORef 0
1569 unreadyChildren <- liftIO $ newIORef 0
672 let commitAction = do
1570 let commitAction = do
673 c <- liftIO $ readIORef currentCohort
1571 c <- liftIO $ readIORef currentCohort
674 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
675− deleteBetweenExclusive before after
1573+ !before' <- liftIO $ readIORef before
676− insertBefore df after
1574+ !after' <- liftIO $ readIORef after
1575+ deleteBetweenExclusive before' after'
1576+ insertBefore p' after'
677 liftIO $ writeIORef currentCohort cohortId
1577 liftIO $ writeIORef currentCohort cohortId
678 myCommitAction
1578 myCommitAction
679− result <- runReaderT (unImmediateDomBuilderT child) $ initialEnv
1579+ delayed <- case h of
680− { _immediateDomBuilderEnv_parent = toNode df
1580+ HydrationMode_Hydrating -> liftIO $ newIORef $ pure ()
681− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
1581+ HydrationMode_Immediate -> pure $ _hydrationDomBuilderEnv_delayed initialEnv
682− , _immediateDomBuilderEnv_commitAction = commitAction
1582+ result <- runReaderT (unHydrationDomBuilderT child) $ initialEnv
683− }
1583+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1584+ , _hydrationDomBuilderEnv_commitAction = case h of
1585+ HydrationMode_Hydrating -> myCommitAction
1586+ HydrationMode_Immediate -> commitAction
1587+ , _hydrationDomBuilderEnv_parent = Left p'
1588+ , _hydrationDomBuilderEnv_delayed = delayed
1589+ }
1590+ dom <- case h of
1591+ HydrationMode_Hydrating -> liftIO $ readIORef delayed
1592+ HydrationMode_Immediate -> pure $ pure ()
684 uc <- liftIO $ readIORef unreadyChildren
1593 uc <- liftIO $ readIORef unreadyChildren
685 let commitActionToRunNow = if uc == 0
1594 let commitActionToRunNow = if uc == 0
686− then Just commitAction
1595+ then Just $ commitAction
687 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
688− return (commitActionToRunNow, result)
1597+ actions = case h of
689− requestDomAction_ $ fmapMaybe fst child'
1598+ HydrationMode_Hydrating -> Left dom
1599+ HydrationMode_Immediate -> Right commitActionToRunNow
1600+ return (actions, result)
1601+ let (hydrate', commitAction) = fanEither $ fmap fst child'
1602+ addHydrationStepWithSetup (hold hydrate0 hydrate') $ \contents -> do
1603+ hydrateStart
1604+ join $ sample contents
1605+ hydrateEnd
1606+ requestDomAction_ $ fmapMaybe id commitAction
690 return (result0, snd <$> child')
1607 return (result0, snd <$> child')
1608+
691 {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
1609 {-# INLINABLE traverseIntMapWithKeyWithAdjust #-}
692 traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjust'
1610 traverseIntMapWithKeyWithAdjust = traverseIntMapWithKeyWithAdjust'
693 {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
1611 {-# INLINABLE traverseDMapWithKeyWithAdjust #-}
694 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjust'
1612 traverseDMapWithKeyWithAdjust = traverseDMapWithKeyWithAdjust'
695 {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
1613 {-# INLINABLE traverseDMapWithKeyWithAdjustWithMove #-}
696 traverseDMapWithKeyWithAdjustWithMove = do
1614 traverseDMapWithKeyWithAdjustWithMove = do
697− 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
698− 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)
699 new k = PatchDMapWithMove.nodeInfoMapFromM $ \case
1617 new k = PatchDMapWithMove.nodeInfoMapFromM $ \case
700− PatchDMapWithMove.From_Insert (Compose (_, _, sRef, _)) -> do
1618+ PatchDMapWithMove.From_Insert (Compose (TraverseChild (Left _hydration) _)) -> return PatchDMapWithMove.From_Delete
701− readIORef sRef >>= \case
1619+ PatchDMapWithMove.From_Insert (Compose (TraverseChild (Right immediate) _)) -> do
1620+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
702 ChildReadyState_Ready -> return PatchDMapWithMove.From_Delete
1621 ChildReadyState_Ready -> return PatchDMapWithMove.From_Delete
703 ChildReadyState_Unready _ -> do
1622 ChildReadyState_Unready _ -> do
704− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
1623+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
705− return $ PatchDMapWithMove.From_Insert $ Constant sRef
1624+ return $ PatchDMapWithMove.From_Insert $ Constant (_traverseChildImmediate_childReadyState immediate)
706 PatchDMapWithMove.From_Delete -> return PatchDMapWithMove.From_Delete
1625 PatchDMapWithMove.From_Delete -> return PatchDMapWithMove.From_Delete
707 PatchDMapWithMove.From_Move fromKey -> return $ PatchDMapWithMove.From_Move fromKey
1626 PatchDMapWithMove.From_Move fromKey -> return $ PatchDMapWithMove.From_Move fromKey
708− 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)
709 deleteOrMove _ (Pair (Constant sRef) (ComposeMaybe mToKey)) = do
1628 deleteOrMove _ (Pair (Constant sRef) (ComposeMaybe mToKey)) = do
710− 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
711 return $ Constant ()
1630 return $ Constant ()
712 p' <- fmap unsafePatchDMapWithMove $ DMap.traverseWithKey new $ unPatchDMapWithMove p
1631 p' <- fmap unsafePatchDMapWithMove $ DMap.traverseWithKey new $ unPatchDMapWithMove p
713 _ <- DMap.traverseWithKey deleteOrMove $ PatchDMapWithMove.getDeletionsAndMoves p old
1632 _ <- DMap.traverseWithKey deleteOrMove $ PatchDMapWithMove.getDeletionsAndMoves p old
714 return $ applyAlways p' old
1633 return $ applyAlways p' old
715− 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
716 let p = unPatchDMapWithMove p_
1635 let p = unPatchDMapWithMove p_
717 phsBefore <- liftIO $ readIORef placeholders
1636 phsBefore <- liftIO $ readIORef placeholders
718− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
1637+ let collectIfMoved :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseChild t m (Some k)) v') a -> JSM (Constant (Maybe DOM.DocumentFragment) a)
719− 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)
720 collectIfMoved k e = do
1638 collectIfMoved k e = do
721− 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
722− nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsBefore
1640+ nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phsBefore
723 case isJust $ getComposeMaybe $ PatchDMapWithMove._nodeInfo_to e of
1641 case isJust $ getComposeMaybe $ PatchDMapWithMove._nodeInfo_to e of
724 False -> do
1642 False -> do
725 mapM_ (`deleteUpTo` nextPlaceholder) mThisPlaceholder
1643 mapM_ (`deleteUpTo` nextPlaceholder) mThisPlaceholder
@@ -727,13 +1645,22 @@ instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimM
727 True -> do
1645 True -> do
728 Constant <$> mapM (`collectUpTo` nextPlaceholder) mThisPlaceholder
1646 Constant <$> mapM (`collectUpTo` nextPlaceholder) mThisPlaceholder
729 collected <- DMap.traverseWithKey collectIfMoved p
1647 collected <- DMap.traverseWithKey collectIfMoved p
730− let !phsAfter = fromMaybe phsBefore $ apply (weakenPatchDMapWithMoveWith (\(Compose (_, ph, _, _)) -> ph) p_) phsBefore --TODO: Don't recompute this
1648+ let !phsAfter = fromMaybe phsBefore $ apply filtered phsBefore
731− let placeFragment :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v') a -> JSM (Constant () a)
1649+ weakened :: PatchMapWithMove (Some k) (Either (TraverseChildHydration t m) (TraverseChildImmediate (Some k)))
1650+ weakened = weakenPatchDMapWithMoveWith (_traverseChild_mode . getCompose) p_
1651+ filtered :: PatchMapWithMove (Some k) DOM.Text
1652+ filtered = PatchMapWithMove $ flip Map.mapMaybe (unPatchMapWithMove weakened) $ \(PatchMapWithMove.NodeInfo from to) -> flip PatchMapWithMove.NodeInfo to <$> case from of
1653+ PatchMapWithMove.From_Insert (Left _hydration) -> Nothing
1654+ PatchMapWithMove.From_Insert (Right immediate) -> Just $ PatchMapWithMove.From_Insert $ _traverseChildImmediate_placeholder immediate
1655+ PatchMapWithMove.From_Delete -> Just $ PatchMapWithMove.From_Delete
1656+ PatchMapWithMove.From_Move k -> Just $ PatchMapWithMove.From_Move k
1657+ let placeFragment :: forall a. k a -> PatchDMapWithMove.NodeInfo k (Compose (TraverseChild t m (Some k)) v') a -> JSM (Constant () a)
732 placeFragment k e = do
1658 placeFragment k e = do
733− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phsAfter
1659+ let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phsAfter
734 case PatchDMapWithMove._nodeInfo_from e of
1660 case PatchDMapWithMove._nodeInfo_from e of
735− PatchDMapWithMove.From_Insert (Compose (df, _, _, _)) -> do
1661+ PatchDMapWithMove.From_Insert (Compose (TraverseChild x _)) -> case x of
736− df `insertBefore` nextPlaceholder
1662+ Left _ -> pure ()
1663+ Right immediate -> _traverseChildImmediate_fragment immediate `insertBefore` nextPlaceholder
737 PatchDMapWithMove.From_Delete -> do
1664 PatchDMapWithMove.From_Delete -> do
738 return ()
1665 return ()
739 PatchDMapWithMove.From_Move fromKey -> do
1666 PatchDMapWithMove.From_Move fromKey -> do
@@ -744,105 +1671,166 @@ instance (Reflex t, Adjustable t m, MonadJSM m, MonadHold t m, MonadFix m, PrimM
744 liftIO $ writeIORef placeholders $! phsAfter
1671 liftIO $ writeIORef placeholders $! phsAfter
745
1672
746{-# INLINABLE traverseDMapWithKeyWithAdjust' #-}
1673{-# INLINABLE traverseDMapWithKeyWithAdjust' #-}
747−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'))
1674+traverseDMapWithKeyWithAdjust'
1675+ :: forall s t m (k :: * -> *) v v'. (Adjustable t m, MonadHold t m, MonadFix m, MonadJSM m, PrimMonad m, GCompare k, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document)
1676+ => (forall a. k a -> v a -> HydrationDomBuilderT s t m (v' a))
1677+ -> DMap k v
1678+ -> Event t (PatchDMap k v)
1679+ -> HydrationDomBuilderT s t m (DMap k v', Event t (PatchDMap k v'))
748traverseDMapWithKeyWithAdjust' = do
1680traverseDMapWithKeyWithAdjust' = do
749− 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
750− 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)
751 new k (ComposeMaybe m) = ComposeMaybe <$> case m of
1683 new k (ComposeMaybe m) = ComposeMaybe <$> case m of
752 Nothing -> return Nothing
1684 Nothing -> return Nothing
753− Just (Compose (_, _, sRef, _)) -> do
1685+ Just (Compose (TraverseChild (Left _hydration) _)) -> pure Nothing
754− readIORef sRef >>= \case
1686+ Just (Compose (TraverseChild (Right immediate) _)) -> do
1687+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
755 ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
1688 ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
756 ChildReadyState_Unready _ -> do
1689 ChildReadyState_Unready _ -> do
757− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
1690+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
758− return $ Just $ Constant sRef
1691+ return $ Just $ Constant (_traverseChildImmediate_childReadyState immediate)
759 delete _ (Constant sRef) = do
1692 delete _ (Constant sRef) = do
760 writeIORef sRef $ ChildReadyState_Unready Nothing
1693 writeIORef sRef $ ChildReadyState_Unready Nothing
761 return $ Constant ()
1694 return $ Constant ()
762 p' <- fmap PatchDMap $ DMap.traverseWithKey new $ unPatchDMap p
1695 p' <- fmap PatchDMap $ DMap.traverseWithKey new $ unPatchDMap p
763 _ <- DMap.traverseWithKey delete $ PatchDMap.getDeletions p old
1696 _ <- DMap.traverseWithKey delete $ PatchDMap.getDeletions p old
764 return $ applyAlways p' old
1697 return $ applyAlways p' old
765− hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap updateChildUnreadiness $ \placeholders lastPlaceholderRef (PatchDMap p) -> do
1698+ hoistTraverseWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap updateChildUnreadiness $ \placeholders lastPlaceholder (PatchDMap patch) -> do
766 phs <- liftIO $ readIORef placeholders
1699 phs <- liftIO $ readIORef placeholders
767− forM_ (DMap.toList p) $ \(k :=> ComposeMaybe mv) -> do
1700+ forM_ (DMap.toList patch) $ \(k :=> ComposeMaybe mv) -> do
768− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
1701+ let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some k) phs
769− let nextPlaceholder = maybe lastPlaceholder snd $ Map.lookupGT (Some.This k) phs
1702+ -- Delete old node
770− forM_ (Map.lookup (Some.This k) phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
1703+ forM_ (Map.lookup (Some k) phs) $ \thisPlaceholder -> do
771− forM_ mv $ \(Compose (df, _, _, _)) -> df `insertBefore` nextPlaceholder
1704+ thisPlaceholder `deleteUpTo` nextPlaceholder
772− liftIO $ writeIORef placeholders $! fromMaybe phs $ apply (weakenPatchDMapWith (\(Compose (_, ph, _, _)) -> ph) $ PatchDMap p) phs
1705+ -- Insert new node
1706+ forM_ mv $ \(Compose (TraverseChild e _)) -> case e of
1707+ Left _hydration -> pure ()
1708+ Right immediate -> do
1709+ _traverseChildImmediate_fragment immediate `insertBefore` nextPlaceholder
1710+ let weakened :: PatchMap (Some k) (Either (TraverseChildHydration t m) (TraverseChildImmediate (Some k)))
1711+ weakened = weakenPatchDMapWith (_traverseChild_mode . getCompose) $ PatchDMap patch
1712+ filtered :: PatchMap (Some k) DOM.Text
1713+ filtered = PatchMap $ flip Map.mapMaybe (unPatchMap weakened) $ \case
1714+ Nothing -> Just Nothing -- deletion
1715+ Just (Left _) -> Nothing
1716+ Just (Right immediate) -> Just $ Just $ _traverseChildImmediate_placeholder immediate
1717+ liftIO $ writeIORef placeholders $! fromMaybe phs $ apply filtered phs
773
1718
774{-# INLINABLE traverseIntMapWithKeyWithAdjust' #-}
1719{-# INLINABLE traverseIntMapWithKeyWithAdjust' #-}
775−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'))
776traverseIntMapWithKeyWithAdjust' = do
1726traverseIntMapWithKeyWithAdjust' = do
777− 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
778− 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)))
779 new k m = case m of
1729 new k m = case m of
780 Nothing -> return Nothing
1730 Nothing -> return Nothing
781− Just (_, _, sRef, _) -> do
1731+ Just (TraverseChild (Left _hydration) _) -> pure Nothing
1732+ Just (TraverseChild (Right immediate) _) -> do
1733+ let sRef = _traverseChildImmediate_childReadyState immediate
782 readIORef sRef >>= \case
1734 readIORef sRef >>= \case
783− ChildReadyStateInt_Ready -> return Nothing -- Delete this child, since it's ready
1735+ ChildReadyState_Ready -> return Nothing -- Delete this child, since it's ready
784− ChildReadyStateInt_Unready _ -> do
1736+ ChildReadyState_Unready _ -> do
785− writeIORef sRef $ ChildReadyStateInt_Unready $ Just k
1737+ writeIORef sRef $ ChildReadyState_Unready $ Just k
786 return $ Just sRef
1738 return $ Just sRef
787 delete _ sRef = do
1739 delete _ sRef = do
788− writeIORef sRef $ ChildReadyStateInt_Unready Nothing
1740+ writeIORef sRef $ ChildReadyState_Unready Nothing
789 return ()
1741 return ()
790 p' <- PatchIntMap <$> IntMap.traverseWithKey new pInner
1742 p' <- PatchIntMap <$> IntMap.traverseWithKey new pInner
791 _ <- IntMap.traverseWithKey delete $ FastMutableIntMap.getDeletions p old
1743 _ <- IntMap.traverseWithKey delete $ FastMutableIntMap.getDeletions p old
792 return $ applyAlways p' old
1744 return $ applyAlways p' old
793− hoistTraverseIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust updateChildUnreadiness $ \placeholders lastPlaceholderRef (PatchIntMap p) -> do
1745+ hoistTraverseIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust updateChildUnreadiness $ \placeholders lastPlaceholder (PatchIntMap p) -> do
794 phs <- liftIO $ readIORef placeholders
1746 phs <- liftIO $ readIORef placeholders
795 forM_ (IntMap.toList p) $ \(k, mv) -> do
1747 forM_ (IntMap.toList p) $ \(k, mv) -> do
796− lastPlaceholder <- liftIO $ readIORef lastPlaceholderRef
797 let nextPlaceholder = maybe lastPlaceholder snd $ IntMap.lookupGT k phs
1748 let nextPlaceholder = maybe lastPlaceholder snd $ IntMap.lookupGT k phs
1749+ -- Delete old node
798 forM_ (IntMap.lookup k phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
1750 forM_ (IntMap.lookup k phs) $ \thisPlaceholder -> thisPlaceholder `deleteUpTo` nextPlaceholder
799− forM_ mv $ \(df, _, _, _) -> df `insertBefore` nextPlaceholder
1751+ -- Insert new node
800− liftIO $ writeIORef placeholders $! fromMaybe phs $ apply ((\(_, ph, _, _) -> ph) <$> PatchIntMap p) phs
1752+ forM_ mv $ \(TraverseChild e _) -> case e of
1753+ Left _hydration -> pure ()
1754+ Right immediate -> do
1755+ _traverseChildImmediate_fragment immediate `insertBefore` nextPlaceholder
1756+ let filtered :: PatchIntMap DOM.Text
1757+ filtered = PatchIntMap $ flip IntMap.mapMaybe p $ \case
1758+ Nothing -> Just Nothing -- deletion
1759+ Just tc
1760+ | Right immediate <- _traverseChild_mode tc -> Just $ Just $ _traverseChildImmediate_placeholder immediate
1761+ | otherwise -> Nothing
1762+ liftIO $ writeIORef placeholders $! fromMaybe phs $ apply filtered phs
1763+
1764+{-# SPECIALIZE traverseIntMapWithKeyWithAdjust'
1765+ :: (IntMap.Key -> v -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM v')
1766+ -> IntMap v
1767+ -> Event DomTimeline (PatchIntMap v)
1768+ -> HydrationDomBuilderT GhcjsDomSpace DomTimeline HydrationM (IntMap v', Event DomTimeline (PatchIntMap v'))
1769+ #-}
801
1770
802−#if MIN_VERSION_base(4,9,0)
1771+{-# SPECIALIZE traverseIntMapWithKeyWithAdjust'
803−data ChildReadyState k
1772+ :: (IntMap.Key -> v -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM v')
804−#else
1773+ -> IntMap v
805−data ChildReadyState (k :: * -> *)
1774+ -> Event DomTimeline (PatchIntMap v)
806−#endif
1775+ -> HydrationDomBuilderT HydrationDomSpace DomTimeline HydrationM (IntMap v', Event DomTimeline (PatchIntMap v'))
1776+ #-}
1777+
1778+data ChildReadyState a
807 = ChildReadyState_Ready
1779 = ChildReadyState_Ready
808− | ChildReadyState_Unready !(Maybe (Some k))
1780+ | ChildReadyState_Unready !(Maybe a)
809 deriving (Show, Read, Eq, Ord)
1781 deriving (Show, Read, Eq, Ord)
810
1782
811−data ChildReadyStateInt
1783+insertAfterPreviousNode :: (Monad m, MonadJSM m) => DOM.IsNode node => node -> HydrationRunnerT t m ()
812− = ChildReadyStateInt_Ready
1784+insertAfterPreviousNode node = do
813− | ChildReadyStateInt_Unready !(Maybe Int)
1785+ parent <- askParent
814− 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
815
1789
816−{-# INLINE hoistTraverseIntMapWithKeyWithAdjust #-}
1790+{-# INLINABLE hoistTraverseWithKeyWithAdjust #-}
817−hoistTraverseIntMapWithKeyWithAdjust :: forall v v' t m p.
1791+hoistTraverseWithKeyWithAdjust
1792+ ::
818 ( Adjustable t m
1793 ( Adjustable t m
1794+ , MonadHold t m
1795+ , GCompare k
819 , MonadIO m
1796 , MonadIO m
820 , MonadJSM m
1797 , MonadJSM m
821− , MonadFix m
822 , PrimMonad m
1798 , PrimMonad m
823− , Monoid (p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
1799+ , MonadFix m
824− , 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
825 )
1807 )
826− => ( (IntMap.Key -> v -> RequesterT t JSM Identity (TriggerEventT t m) (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
1808+ => (forall vv vv'.
827− -> IntMap v
1809+ (forall a. k a -> vv a -> DomRenderHookT t m (vv' a))
828− -> Event t (p v)
1810+ -> DMap k vv
829− -> 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')))
1811+ -> Event t (p k vv)
830− ) -- ^ The base monad's traversal
1812+ -> DomRenderHookT t m (DMap k vv', Event t (p k vv')))
831− -> (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
1813+ -- ^ The base monad's traversal
832− -> (IORef (IntMap DOM.Text) -> IORef DOM.Text -> p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> JSM ()) -- ^ Apply a patch to the DOM
1814+ -> (forall vv vv'. (forall a. vv a -> vv' a) -> p k vv -> p k vv')
833− -> (IntMap.Key -> v -> ImmediateDomBuilderT t m v')
1815+ -- ^ A way of mapping over the patch type
834− -> IntMap v
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))))))
835− -> Event t (p v)
1817+ -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
836− -> ImmediateDomBuilderT t m (IntMap v', Event t (p v'))
1818+ -> (IORef (Map.Map (Some k) DOM.Text) -> DOM.Text -> p k (Compose (TraverseChild t m (Some k)) v') -> JSM ())
837−hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
1819+ -- ^ Apply a patch to the DOM
838− initialEnv <- ImmediateDomBuilderT ask
1820+ -> (forall a. k a -> v a -> HydrationDomBuilderT s t m (v' a))
839− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
1821+ -> DMap k v
840− pendingChange :: IORef (IntMap (IORef ChildReadyStateInt), p (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')) <- liftIO $ newIORef mempty
1822+ -> Event t (p k v)
1823+ -> HydrationDomBuilderT s t m (DMap k v', Event t (p k v'))
1824+hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
1825+ doc <- askDocument
1826+ initialEnv <- HydrationDomBuilderT ask
1827+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
1828+ pendingChange :: IORef (DMap k (Constant (IORef (ChildReadyState (Some k)))), p k (Compose (TraverseChild t m (Some k)) v')) <- liftIO $ newIORef mempty
841 haveEverBeenReady <- liftIO $ newIORef False
1829 haveEverBeenReady <- liftIO $ newIORef False
842− placeholders <- liftIO $ newIORef $ error "placeholders not yet initialized"
1830+ placeholders <- liftIO $ newIORef Map.empty
843− lastPlaceholderRef <- liftIO $ newIORef $ error "lastPlaceholderRef not yet initialized"
1831+ lastPlaceholder <- createTextNode doc ("" :: Text)
844 let applyDomUpdate p = do
1832 let applyDomUpdate p = do
845− applyDomUpdate_ placeholders lastPlaceholderRef p
1833+ applyDomUpdate_ placeholders lastPlaceholder p
846 markSelfReady
1834 markSelfReady
847 liftIO $ writeIORef pendingChange $! mempty
1835 liftIO $ writeIORef pendingChange $! mempty
848 markSelfReady = do
1836 markSelfReady = do
@@ -853,86 +1841,105 @@ hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_
853 old <- liftIO $ readIORef parentUnreadyChildren
1841 old <- liftIO $ readIORef parentUnreadyChildren
854 let new = pred old
1842 let new = pred old
855 liftIO $ writeIORef parentUnreadyChildren $! new
1843 liftIO $ writeIORef parentUnreadyChildren $! new
856− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
1844+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
857− markChildReady :: IORef ChildReadyStateInt -> JSM ()
1845+ markChildReady :: IORef (ChildReadyState (Some k)) -> JSM ()
858 markChildReady childReadyState = do
1846 markChildReady childReadyState = do
859 liftIO (readIORef childReadyState) >>= \case
1847 liftIO (readIORef childReadyState) >>= \case
860− ChildReadyStateInt_Ready -> return ()
1848+ ChildReadyState_Ready -> return ()
861− ChildReadyStateInt_Unready countedAt -> do
1849+ ChildReadyState_Unready countedAt -> do
862− liftIO $ writeIORef childReadyState ChildReadyStateInt_Ready
1850+ liftIO $ writeIORef childReadyState ChildReadyState_Ready
863 case countedAt of
1851 case countedAt of
864 Nothing -> return ()
1852 Nothing -> return ()
865− 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
866 (oldUnready, p) <- liftIO $ readIORef pendingChange
1854 (oldUnready, p) <- liftIO $ readIORef pendingChange
867− 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
868− let newUnready = IntMap.delete k oldUnready
1856+ let newUnready = DMap.delete k oldUnready
869 liftIO $ writeIORef pendingChange (newUnready, p)
1857 liftIO $ writeIORef pendingChange (newUnready, p)
870− when (IntMap.null newUnready) $ do
1858+ when (DMap.null newUnready) $ do
871 applyDomUpdate p
1859 applyDomUpdate p
872− (children0, children') <- ImmediateDomBuilderT $ lift $ base (\k v -> drawChildUpdateInt initialEnv markChildReady $ f k v) dm0 dm'
1860+ (children0 :: DMap k (Compose (TraverseChild t m (Some k)) v'), children' :: Event t (p k (Compose (TraverseChild t m (Some k)) v')))
873− let processChild k (_, _, sRef, _) = do
1861+ <- HydrationDomBuilderT $ lift $ base (\k v -> drawChildUpdate initialEnv markChildReady $ f k v) dm0 dm'
874− readIORef sRef >>= \case
1862+ let processChild k (Compose (TraverseChild e _)) = case e of
875− ChildReadyStateInt_Ready -> return Nothing
1863+ Left _ -> pure $ ComposeMaybe Nothing
876− ChildReadyStateInt_Unready _ -> do
1864+ Right immediate -> ComposeMaybe <$> do
877− writeIORef sRef $ ChildReadyStateInt_Unready $ Just k
1865+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
878− return $ Just sRef
1866+ ChildReadyState_Ready -> return Nothing
879− initialUnready <- liftIO $ IntMap.mapMaybe id <$> IntMap.traverseWithKey processChild children0
1867+ ChildReadyState_Unready _ -> do
880− liftIO $ if IntMap.null initialUnready
1868+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just $ Some k
1869+ return $ Just $ Constant (_traverseChildImmediate_childReadyState immediate)
1870+ initialUnready <- liftIO $ DMap.mapMaybeWithKey (\_ -> getComposeMaybe) <$> DMap.traverseWithKey processChild children0
1871+ liftIO $ if DMap.null initialUnready
881 then writeIORef haveEverBeenReady True
1872 then writeIORef haveEverBeenReady True
882 else do
1873 else do
883 modifyIORef' parentUnreadyChildren succ
1874 modifyIORef' parentUnreadyChildren succ
884 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
885− let result0 = IntMap.map (\(_, _, _, v) -> v) children0
1876+ getHydrationMode >>= \case
886− placeholders0 = fmap (\(_, ph, _, _) -> ph) children0
1877+ HydrationMode_Hydrating -> addHydrationStepWithSetup (holdIncremental children0 children') $ \children -> do
887− result' = ffor children' $ fmap $ \(_, _, _, r) -> r
1878+ dm :: DMap k (Compose (TraverseChild t m (Some k)) v') <- sample $ currentIncremental children
888− liftIO $ writeIORef placeholders $! placeholders0
1879+ phs <- sequenceA $ weakenDMapWith (either _traverseChildHydration_delayed (pure . _traverseChildImmediate_placeholder) . _traverseChild_mode . getCompose) dm
889− _ <- IntMap.traverseWithKey (\_ (df, _, _, _) -> void $ append $ toNode df) children0
1880+ liftIO $ writeIORef placeholders $! phs
890− 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
891 requestDomAction_ $ ffor children' $ \p -> do
1889 requestDomAction_ $ ffor children' $ \p -> do
892 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
1890 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
893 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
1891 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
894 let !newP = p <> oldP
1892 let !newP = p <> oldP
895 liftIO $ writeIORef pendingChange (newUnready, newP)
1893 liftIO $ writeIORef pendingChange (newUnready, newP)
896− when (IntMap.null newUnready) $ do
1894+ when (DMap.null newUnready) $ do
897 applyDomUpdate newP
1895 applyDomUpdate newP
1896+ let result0 = DMap.map (_traverseChild_result . getCompose) children0
1897+ result' = ffor children' $ mapPatch $ _traverseChild_result . getCompose
898 return (result0, result')
1898 return (result0, result')
899
1899
900−{-# INLINABLE hoistTraverseWithKeyWithAdjust #-}
1900+{-# INLINE hoistTraverseIntMapWithKeyWithAdjust #-}
901−hoistTraverseWithKeyWithAdjust :: forall (k :: * -> *) v v' t m p.
1901+hoistTraverseIntMapWithKeyWithAdjust ::
902 ( Adjustable t m
1902 ( Adjustable t m
903 , MonadHold t m
1903 , MonadHold t m
904− , DMap.GCompare k
905− , MonadIO m
906 , MonadJSM m
1904 , MonadJSM m
907− , PrimMonad m
908 , MonadFix m
1905 , MonadFix m
909− , Patch (p k v)
1906+ , PrimMonad m
910− , PatchTarget (p k (Constant Int)) ~ DMap k (Constant Int)
1907+ , Monoid (p (TraverseChild t m Int v'))
911− , Monoid (p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v'))
1908+ , Functor p
912− , 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
913 )
1914 )
914− => (forall vv vv'.
1915+ => ((IntMap.Key -> v -> DomRenderHookT t m (TraverseChild t m Int v'))
915− (forall a. k a -> vv a -> RequesterT t JSM Identity (TriggerEventT t m) (vv' a))
1916+ -> IntMap v
916− -> DMap k vv
1917+ -> Event t (p v)
917− -> Event t (p k vv)
1918+ -> DomRenderHookT t m (IntMap (TraverseChild t m Int v'), Event t (p (TraverseChild t m Int v'))))
918− -> RequesterT t JSM Identity (TriggerEventT t m) (DMap k vv', Event t (p k vv'))
1919+ -- ^ The base monad's traversal
919− ) -- ^ The base monad's traversal
1920+ -> (p (TraverseChild t m Int v')
920− -> (forall vv vv'. (forall a. vv a -> vv' a) -> p k vv -> p k vv') -- ^ A way of mapping over the patch type
1921+ -> IntMap (IORef (ChildReadyState Int))
921− -> (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
1922+ -> IO (IntMap (IORef (ChildReadyState Int))))
922− -> (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
1923+ -- ^ Given a patch for the children DOM elements, produce a patch for the childrens' unreadiness state
923− -> (forall a. k a -> v a -> ImmediateDomBuilderT t m (v' a))
1924+ -> (IORef (IntMap DOM.Text)
924− -> DMap k v
1925+ -> DOM.Text
925− -> Event t (p k v)
1926+ -> p (TraverseChild t m Int v')
926− -> ImmediateDomBuilderT t m (DMap k v', Event t (p k v'))
1927+ -> JSM ())
927−hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpdate_ (f :: forall a. k a -> v a -> ImmediateDomBuilderT t m (v' a)) (dm0 :: DMap k v) dm' = do
1928+ -- ^ Apply a patch to the DOM
928− initialEnv <- ImmediateDomBuilderT ask
1929+ -> (IntMap.Key -> v -> HydrationDomBuilderT s t m v')
929− let parentUnreadyChildren = _immediateDomBuilderEnv_unreadyChildren initialEnv
1930+ -> IntMap v
930− pendingChange :: IORef (DMap k (Constant (IORef (ChildReadyState k))), p k (Compose ((,,,) DOM.DocumentFragment DOM.Text (IORef (ChildReadyState k))) v')) <- liftIO $ newIORef mempty
1931+ -> Event t (p v)
1932+ -> HydrationDomBuilderT s t m (IntMap v', Event t (p v'))
1933+hoistTraverseIntMapWithKeyWithAdjust base updateChildUnreadiness applyDomUpdate_ f dm0 dm' = do
1934+ doc <- askDocument
1935+ initialEnv <- HydrationDomBuilderT ask
1936+ let parentUnreadyChildren = _hydrationDomBuilderEnv_unreadyChildren initialEnv
1937+ pendingChange :: IORef (IntMap (IORef (ChildReadyState Int)), p (TraverseChild t m Int v')) <- liftIO $ newIORef mempty
931 haveEverBeenReady <- liftIO $ newIORef False
1938 haveEverBeenReady <- liftIO $ newIORef False
932− placeholders <- liftIO $ newIORef $ error "placeholders not yet initialized"
1939+ placeholders <- liftIO $ newIORef IntMap.empty
933− lastPlaceholderRef <- liftIO $ newIORef $ error "lastPlaceholderRef not yet initialized"
1940+ lastPlaceholder <- createTextNode doc ("" :: Text)
934 let applyDomUpdate p = do
1941 let applyDomUpdate p = do
935− applyDomUpdate_ placeholders lastPlaceholderRef p
1942+ applyDomUpdate_ placeholders lastPlaceholder p
936 markSelfReady
1943 markSelfReady
937 liftIO $ writeIORef pendingChange $! mempty
1944 liftIO $ writeIORef pendingChange $! mempty
938 markSelfReady = do
1945 markSelfReady = do
@@ -943,8 +1950,8 @@ hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpda
943 old <- liftIO $ readIORef parentUnreadyChildren
1950 old <- liftIO $ readIORef parentUnreadyChildren
944 let new = pred old
1951 let new = pred old
945 liftIO $ writeIORef parentUnreadyChildren $! new
1952 liftIO $ writeIORef parentUnreadyChildren $! new
946− when (new == 0) $ _immediateDomBuilderEnv_commitAction initialEnv
1953+ when (new == 0) $ _hydrationDomBuilderEnv_commitAction initialEnv
947− markChildReady :: IORef (ChildReadyState k) -> JSM ()
1954+ markChildReady :: IORef (ChildReadyState Int) -> JSM ()
948 markChildReady childReadyState = do
1955 markChildReady childReadyState = do
949 liftIO (readIORef childReadyState) >>= \case
1956 liftIO (readIORef childReadyState) >>= \case
950 ChildReadyState_Ready -> return ()
1957 ChildReadyState_Ready -> return ()
@@ -952,82 +1959,191 @@ hoistTraverseWithKeyWithAdjust base mapPatch updateChildUnreadiness applyDomUpda
952 liftIO $ writeIORef childReadyState ChildReadyState_Ready
1959 liftIO $ writeIORef childReadyState ChildReadyState_Ready
953 case countedAt of
1960 case countedAt of
954 Nothing -> return ()
1961 Nothing -> return ()
955− 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
956 (oldUnready, p) <- liftIO $ readIORef pendingChange
1963 (oldUnready, p) <- liftIO $ readIORef pendingChange
957− 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
958− let newUnready = DMap.delete k oldUnready
1965+ let newUnready = IntMap.delete k oldUnready
959 liftIO $ writeIORef pendingChange (newUnready, p)
1966 liftIO $ writeIORef pendingChange (newUnready, p)
960− when (DMap.null newUnready) $ do
1967+ when (IntMap.null newUnready) $ do
961 applyDomUpdate p
1968 applyDomUpdate p
962− (children0, children') <- ImmediateDomBuilderT $ lift $ base (\k v -> drawChildUpdate initialEnv markChildReady $ f k v) dm0 dm'
1969+ (children0 :: IntMap (TraverseChild t m Int v'), children' :: Event t (p (TraverseChild t m Int v')))
963− let processChild k (Compose (_, _, sRef, _)) = ComposeMaybe <$> do
1970+ <- HydrationDomBuilderT $ lift $ base (\k v -> drawChildUpdateInt initialEnv markChildReady $ f k v) dm0 dm'
964− readIORef sRef >>= \case
1971+ let processChild k (TraverseChild e _) = case e of
965− ChildReadyState_Ready -> return Nothing
1972+ Left _ -> pure Nothing
966− ChildReadyState_Unready _ -> do
1973+ Right immediate -> do
967− writeIORef sRef $ ChildReadyState_Unready $ Just $ Some.This k
1974+ readIORef (_traverseChildImmediate_childReadyState immediate) >>= \case
968− return $ Just $ Constant sRef
1975+ ChildReadyState_Ready -> return Nothing
969− initialUnready <- liftIO $ DMap.mapMaybeWithKey (\_ -> getComposeMaybe) <$> DMap.traverseWithKey processChild children0
1976+ ChildReadyState_Unready _ -> do
970− liftIO $ if DMap.null initialUnready
1977+ writeIORef (_traverseChildImmediate_childReadyState immediate) $ ChildReadyState_Unready $ Just k
1978+ return $ Just (_traverseChildImmediate_childReadyState immediate)
1979+ initialUnready <- liftIO $ IntMap.mapMaybe id <$> IntMap.traverseWithKey processChild children0
1980+ liftIO $ if IntMap.null initialUnready
971 then writeIORef haveEverBeenReady True
1981 then writeIORef haveEverBeenReady True
972 else do
1982 else do
973 modifyIORef' parentUnreadyChildren succ
1983 modifyIORef' parentUnreadyChildren succ
974 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
975− let result0 = DMap.map (\(Compose (_, _, _, v)) -> v) children0
1985+ getHydrationMode >>= \case
976− placeholders0 = weakenDMapWith (\(Compose (_, ph, _, _)) -> ph) children0
1986+ HydrationMode_Hydrating -> addHydrationStepWithSetup (holdIncremental children0 children') $ \children -> do
977− result' = ffor children' $ mapPatch $ \(Compose (_, _, _, r)) -> r
1987+ dm :: IntMap (TraverseChild t m Int v') <- sample $ currentIncremental children
978− liftIO $ writeIORef placeholders $! placeholders0
1988+ phs <- traverse (either _traverseChildHydration_delayed (pure . _traverseChildImmediate_placeholder) . _traverseChild_mode) dm
979− _ <- DMap.traverseWithKey (\_ (Compose (df, _, _, _)) -> Constant () <$ append (toNode df)) children0
1989+ liftIO $ writeIORef placeholders $! phs
980− 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
981 requestDomAction_ $ ffor children' $ \p -> do
1998 requestDomAction_ $ ffor children' $ \p -> do
982 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
1999 (oldUnready, oldP) <- liftIO $ readIORef pendingChange
983 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
2000 newUnready <- liftIO $ updateChildUnreadiness p oldUnready
984 let !newP = p <> oldP
2001 let !newP = p <> oldP
985 liftIO $ writeIORef pendingChange (newUnready, newP)
2002 liftIO $ writeIORef pendingChange (newUnready, newP)
986− when (DMap.null newUnready) $ do
2003+ when (IntMap.null newUnready) $ do
987 applyDomUpdate newP
2004 applyDomUpdate newP
2005+ let result0 = IntMap.map _traverseChild_result children0
2006+ result' = ffor children' $ fmap $ _traverseChild_result
988 return (result0, result')
2007 return (result0, result')
989
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+
990{-# INLINABLE drawChildUpdate #-}
2063{-# INLINABLE drawChildUpdate #-}
991−drawChildUpdate :: (MonadIO m, MonadJSM m)
2064+drawChildUpdate :: (MonadJSM m, Reflex t)
992− => ImmediateDomBuilderEnv t
2065+ => HydrationDomBuilderEnv t m
993 -> (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
994− -> ImmediateDomBuilderT t m (v' a)
2067+ -> HydrationDomBuilderT s t m (f a)
995− -> 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)
996drawChildUpdate initialEnv markReady child = do
2069drawChildUpdate initialEnv markReady child = do
997− childReadyState <- liftIO $ newIORef $ ChildReadyState_Unready Nothing
2070+ let doc = _hydrationDomBuilderEnv_document initialEnv
998 unreadyChildren <- liftIO $ newIORef 0
2071 unreadyChildren <- liftIO $ newIORef 0
999− df <- createDocumentFragment $ _immediateDomBuilderEnv_document initialEnv
2072+ liftIO (readIORef $ _hydrationDomBuilderEnv_hydrationMode initialEnv) >>= \case
1000− (placeholder, result) <- runReaderT (unImmediateDomBuilderT $ (,) <$> textNodeInternal ("" :: Text) <*> child) $ initialEnv
2073+ HydrationMode_Hydrating -> do
1001− { _immediateDomBuilderEnv_parent = toNode df
2074+ childDelayedRef <- liftIO $ newIORef $ pure ()
1002− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
2075+ result <- runReaderT (unHydrationDomBuilderT child) initialEnv
1003− , _immediateDomBuilderEnv_commitAction = markReady childReadyState
2076+ { _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
1004− }
2077+ , _hydrationDomBuilderEnv_delayed = childDelayedRef
1005− u <- liftIO $ readIORef unreadyChildren
2078+ }
1006− when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyState_Ready
2079+ childDelayed <- liftIO $ readIORef childDelayedRef
1007− return $ Compose (df, placeholder, childReadyState, result)
2080+ return $ Compose $ TraverseChild
2081+ { _traverseChild_result = result
2082+ , _traverseChild_mode = Left TraverseChildHydration
2083+ { _traverseChildHydration_delayed = do
2084+ placeholder <- createTextNode doc ("" :: Text)
2085+ insertAfterPreviousNode placeholder
2086+ childDelayed
2087+ pure placeholder
2088+ }
2089+ }
2090+ HydrationMode_Immediate -> do
2091+ childReadyState <- liftIO $ newIORef $ ChildReadyState_Unready Nothing
2092+ df <- createDocumentFragment doc
2093+ placeholder <- createTextNode doc ("" :: Text)
2094+ Node.appendChild_ df placeholder
2095+ result <- runReaderT (unHydrationDomBuilderT child) initialEnv
2096+ { _hydrationDomBuilderEnv_parent = Left $ toNode df
2097+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
2098+ , _hydrationDomBuilderEnv_commitAction = markReady childReadyState
2099+ }
2100+ u <- liftIO $ readIORef unreadyChildren
2101+ when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyState_Ready
2102+ return $ Compose $ TraverseChild
2103+ { _traverseChild_result = result
2104+ , _traverseChild_mode = Right TraverseChildImmediate
2105+ { _traverseChildImmediate_fragment = df
2106+ , _traverseChildImmediate_placeholder = placeholder
2107+ , _traverseChildImmediate_childReadyState = childReadyState
2108+ }
2109+ }
1008
2110
1009−{-# INLINABLE drawChildUpdateInt #-}
2111+{-# SPECIALIZE drawChildUpdate
1010−drawChildUpdateInt :: (MonadIO m, MonadJSM m)
2112+ :: HydrationDomBuilderEnv DomTimeline HydrationM
1011− => ImmediateDomBuilderEnv t
2113+ -> (IORef (ChildReadyState Int) -> JSM ())
1012− -> (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)
1013− -> ImmediateDomBuilderT t m v'
2115+ -> DomRenderHookT DomTimeline HydrationM (Compose (TraverseChild DomTimeline HydrationM Int) Identity a)
1014− -> RequesterT t JSM Identity (TriggerEventT t m) (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v')
2116+ #-}
1015−drawChildUpdateInt initialEnv markReady child = do
2117+
1016− childReadyState <- liftIO $ newIORef $ ChildReadyStateInt_Unready Nothing
2118+{-# SPECIALIZE drawChildUpdate
1017− unreadyChildren <- liftIO $ newIORef 0
2119+ :: HydrationDomBuilderEnv DomTimeline HydrationM
1018− df <- createDocumentFragment $ _immediateDomBuilderEnv_document initialEnv
2120+ -> (IORef (ChildReadyState (Some k)) -> JSM ())
1019− (placeholder, result) <- runReaderT (unImmediateDomBuilderT $ (,) <$> textNodeInternal ("" :: Text) <*> child) $ initialEnv
2121+ -> HydrationDomBuilderT s DomTimeline HydrationM (f a)
1020− { _immediateDomBuilderEnv_parent = toNode df
2122+ -> DomRenderHookT DomTimeline HydrationM (Compose (TraverseChild DomTimeline HydrationM (Some k)) f a)
1021− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
2123+ #-}
1022− , _immediateDomBuilderEnv_commitAction = markReady childReadyState
1023− }
1024− u <- liftIO $ readIORef unreadyChildren
1025− when (u == 0) $ liftIO $ writeIORef childReadyState ChildReadyStateInt_Ready
1026− return (df, placeholder, childReadyState, result)
1027
2124
1028−mkHasFocus :: (MonadHold t m, Reflex t) => Element er d t -> m (Dynamic t Bool)
2125+{-# INLINABLE drawChildUpdateInt #-}
2126+drawChildUpdateInt :: (MonadIO m, MonadJSM m, Reflex t)
2127+ => HydrationDomBuilderEnv t m
2128+ -> (IORef (ChildReadyState k) -> JSM ())
2129+ -> HydrationDomBuilderT s t m v
2130+ -> DomRenderHookT t m (TraverseChild t m k v)
2131+drawChildUpdateInt env mark m = fmap runIdentity . getCompose <$> drawChildUpdate env mark (Identity <$> m)
2132+
2133+{-# SPECIALIZE drawChildUpdateInt
2134+ :: HydrationDomBuilderEnv DomTimeline HydrationM
2135+ -> (IORef (ChildReadyState k) -> JSM ())
2136+ -> HydrationDomBuilderT s DomTimeline HydrationM v
2137+ -> DomRenderHookT DomTimeline HydrationM (TraverseChild DomTimeline HydrationM k v)
2138+ #-}
2139+
2140+{-# INLINE mkHasFocus #-}
2141+mkHasFocus
2142+ :: (HasDocument m, MonadJSM m, IsNode (RawElement d), MonadHold t m, Reflex t, DOM.IsDocumentOrShadowRoot (RawDocument (DomBuilderSpace m)))
2143+ => Element er d t -> m (Dynamic t Bool)
1029mkHasFocus e = do
2144mkHasFocus e = do
1030− 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
1031 holdDyn initialFocus $ leftmost
2147 holdDyn initialFocus $ leftmost
1032 [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
2148 [ False <$ Reflex.select (_element_events e) (WrapArg Blur)
1033 , True <$ Reflex.select (_element_events e) (WrapArg Focus)
2149 , True <$ Reflex.select (_element_events e) (WrapArg Focus)
@@ -1036,39 +2152,49 @@ mkHasFocus e = do
1036insertBefore :: (MonadJSM m, IsNode new, IsNode existing) => new -> existing -> m ()
2152insertBefore :: (MonadJSM m, IsNode new, IsNode existing) => new -> existing -> m ()
1037insertBefore new existing = do
2153insertBefore new existing = do
1038 p <- getParentNodeUnchecked existing
2154 p <- getParentNodeUnchecked existing
1039− 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
1040
2156
1041−instance PerformEvent t m => PerformEvent t (ImmediateDomBuilderT t m) where
2157+type ImmediateDomBuilderT = HydrationDomBuilderT GhcjsDomSpace
1042− type Performable (ImmediateDomBuilderT t m) = Performable m
2158+
2159+instance PerformEvent t m => PerformEvent t (HydrationDomBuilderT s t m) where
2160+ type Performable (HydrationDomBuilderT s t m) = Performable m
1043 {-# INLINABLE performEvent_ #-}
2161 {-# INLINABLE performEvent_ #-}
1044 performEvent_ e = lift $ performEvent_ e
2162 performEvent_ e = lift $ performEvent_ e
1045 {-# INLINABLE performEvent #-}
2163 {-# INLINABLE performEvent #-}
1046 performEvent e = lift $ performEvent e
2164 performEvent e = lift $ performEvent e
1047
2165
1048−instance PostBuild t m => PostBuild t (ImmediateDomBuilderT t m) where
2166+instance PostBuild t m => PostBuild t (HydrationDomBuilderT s t m) where
1049 {-# INLINABLE getPostBuild #-}
2167 {-# INLINABLE getPostBuild #-}
1050 getPostBuild = lift getPostBuild
2168 getPostBuild = lift getPostBuild
1051
2169
1052−instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (ImmediateDomBuilderT t m) where
2170+instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (HydrationDomBuilderT s t m) where
1053 {-# INLINABLE newEventWithTrigger #-}
2171 {-# INLINABLE newEventWithTrigger #-}
1054 newEventWithTrigger = lift . newEventWithTrigger
2172 newEventWithTrigger = lift . newEventWithTrigger
1055 {-# INLINABLE newFanEventWithTrigger #-}
2173 {-# INLINABLE newFanEventWithTrigger #-}
1056 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
2174 newFanEventWithTrigger f = lift $ newFanEventWithTrigger f
1057
2175
1058−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
1059 {-# INLINABLE newTriggerEvent #-}
2185 {-# INLINABLE newTriggerEvent #-}
1060− newTriggerEvent = ImmediateDomBuilderT . lift . lift $ newTriggerEvent
2186+ newTriggerEvent = DomRenderHookT . lift $ newTriggerEvent
1061 {-# INLINABLE newTriggerEventWithOnComplete #-}
2187 {-# INLINABLE newTriggerEventWithOnComplete #-}
1062− newTriggerEventWithOnComplete = ImmediateDomBuilderT . lift . lift $ newTriggerEventWithOnComplete
2188+ newTriggerEventWithOnComplete = DomRenderHookT . lift $ newTriggerEventWithOnComplete
1063 {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
2189 {-# INLINABLE newEventWithLazyTriggerWithOnComplete #-}
1064− newEventWithLazyTriggerWithOnComplete f = ImmediateDomBuilderT . lift . lift $ newEventWithLazyTriggerWithOnComplete f
2190+ newEventWithLazyTriggerWithOnComplete f = DomRenderHookT . lift $ newEventWithLazyTriggerWithOnComplete f
1065
2191
1066−instance HasJSContext m => HasJSContext (ImmediateDomBuilderT t m) where
2192+instance HasJSContext m => HasJSContext (HydrationDomBuilderT s t m) where
1067− type JSContextPhantom (ImmediateDomBuilderT t m) = JSContextPhantom m
2193+ type JSContextPhantom (HydrationDomBuilderT s t m) = JSContextPhantom m
1068 askJSContext = lift askJSContext
2194 askJSContext = lift askJSContext
1069
2195
1070−instance MonadRef m => MonadRef (ImmediateDomBuilderT t m) where
2196+instance MonadRef m => MonadRef (HydrationDomBuilderT s t m) where
1071− type Ref (ImmediateDomBuilderT t m) = Ref m
2197+ type Ref (HydrationDomBuilderT s t m) = Ref m
1072 {-# INLINABLE newRef #-}
2198 {-# INLINABLE newRef #-}
1073 newRef = lift . newRef
2199 newRef = lift . newRef
1074 {-# INLINABLE readRef #-}
2200 {-# INLINABLE readRef #-}
@@ -1076,12 +2202,12 @@ instance MonadRef m => MonadRef (ImmediateDomBuilderT t m) where
1076 {-# INLINABLE writeRef #-}
2202 {-# INLINABLE writeRef #-}
1077 writeRef r = lift . writeRef r
2203 writeRef r = lift . writeRef r
1078
2204
1079−instance MonadAtomicRef m => MonadAtomicRef (ImmediateDomBuilderT t m) where
2205+instance MonadAtomicRef m => MonadAtomicRef (HydrationDomBuilderT s t m) where
1080 {-# INLINABLE atomicModifyRef #-}
2206 {-# INLINABLE atomicModifyRef #-}
1081 atomicModifyRef r = lift . atomicModifyRef r
2207 atomicModifyRef r = lift . atomicModifyRef r
1082
2208
1083−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
1084− type JSX (ImmediateDomBuilderT t m) = JSX m
2210+ type JSX (HydrationDomBuilderT s t m) = JSX m
1085 liftJS = lift . liftJS
2211 liftJS = lift . liftJS
1086
2212
1087type family EventType en where
2213type family EventType en where
@@ -1171,7 +2297,7 @@ defaultDomEventHandler e evt = fmap (Just . EventResult) $ case evt of
1171 Beforecopy -> return ()
2297 Beforecopy -> return ()
1172 Copy -> return ()
2298 Copy -> return ()
1173 Beforepaste -> return ()
2299 Beforepaste -> return ()
1174− Paste -> return ()
2300+ Paste -> getPasteData
1175 Reset -> return ()
2301 Reset -> return ()
1176 Search -> return ()
2302 Search -> return ()
1177 Selectstart -> return ()
2303 Selectstart -> return ()
@@ -1180,7 +2306,7 @@ defaultDomEventHandler e evt = fmap (Just . EventResult) $ case evt of
1180 Touchend -> getTouchEvent
2306 Touchend -> getTouchEvent
1181 Touchcancel -> getTouchEvent
2307 Touchcancel -> getTouchEvent
1182 Mousewheel -> return ()
2308 Mousewheel -> return ()
1183− Wheel -> return ()
2309+ Wheel -> getWheelEvent
1184
2310
1185{-# INLINABLE defaultDomWindowEventHandler #-}
2311{-# INLINABLE defaultDomWindowEventHandler #-}
1186defaultDomWindowEventHandler :: 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))
@@ -1221,7 +2347,7 @@ defaultDomWindowEventHandler w evt = fmap (Just . EventResult) $ case evt of
1221 Beforecopy -> return ()
2347 Beforecopy -> return ()
1222 Copy -> return ()
2348 Copy -> return ()
1223 Beforepaste -> return ()
2349 Beforepaste -> return ()
1224− Paste -> return ()
2350+ Paste -> getPasteData
1225 Reset -> return ()
2351 Reset -> return ()
1226 Search -> return ()
2352 Search -> return ()
1227 Selectstart -> return ()
2353 Selectstart -> return ()
@@ -1230,7 +2356,7 @@ defaultDomWindowEventHandler w evt = fmap (Just . EventResult) $ case evt of
1230 Touchend -> getTouchEvent
2356 Touchend -> getTouchEvent
1231 Touchcancel -> getTouchEvent
2357 Touchcancel -> getTouchEvent
1232 Mousewheel -> return ()
2358 Mousewheel -> return ()
1233− Wheel -> return ()
2359+ Wheel -> getWheelEvent
1234
2360
1235{-# INLINABLE withIsEvent #-}
2361{-# INLINABLE withIsEvent #-}
1236withIsEvent :: EventName en -> (IsEvent (EventType en) => r) -> r
2362withIsEvent :: EventName en -> (IsEvent (EventType en) => r) -> r
@@ -1498,6 +2624,15 @@ getMouseEventCoords = do
1498 e <- event
2624 e <- event
1499 bisequence (getClientX e, getClientY e)
2625 bisequence (getClientX e, getClientY e)
1500
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+
1501{-# INLINABLE getTouchEvent #-}
2636{-# INLINABLE getTouchEvent #-}
1502getTouchEvent :: EventM e TouchEvent TouchEventResult
2637getTouchEvent :: EventM e TouchEvent TouchEventResult
1503getTouchEvent = do
2638getTouchEvent = do
@@ -1539,11 +2674,31 @@ getTouchEvent = do
1539 , _touchEventResult_touches = touches
2674 , _touchEventResult_touches = touches
1540 }
2675 }
1541
2676
1542−instance MonadSample t m => MonadSample t (ImmediateDomBuilderT t m) where
2677+{-# INLINABLE getWheelEvent #-}
2678+getWheelEvent :: EventM e WheelEvent WheelEventResult
2679+getWheelEvent = do
2680+ e <- event
2681+ dx :: Double <- WheelEvent.getDeltaX e
2682+ dy :: Double <- WheelEvent.getDeltaY e
2683+ dz :: Double <- WheelEvent.getDeltaZ e
2684+ deltaMode :: Word <- WheelEvent.getDeltaMode e
2685+ return $ WheelEventResult
2686+ { _wheelEventResult_deltaX = dx
2687+ , _wheelEventResult_deltaY = dy
2688+ , _wheelEventResult_deltaZ = dz
2689+ , _wheelEventResult_deltaMode = case deltaMode of
2690+ 0 -> DeltaPixel
2691+ 1 -> DeltaLine
2692+ 2 -> DeltaPage
2693+ -- See https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/deltaMode
2694+ _ -> error "getWheelEvent: impossible encoding"
2695+ }
2696+
2697+instance MonadSample t m => MonadSample t (HydrationDomBuilderT s t m) where
1543 {-# INLINABLE sample #-}
2698 {-# INLINABLE sample #-}
1544 sample = lift . sample
2699 sample = lift . sample
1545
2700
1546−instance MonadHold t m => MonadHold t (ImmediateDomBuilderT t m) where
2701+instance MonadHold t m => MonadHold t (HydrationDomBuilderT s t m) where
1547 {-# INLINABLE hold #-}
2702 {-# INLINABLE hold #-}
1548 hold v0 v' = lift $ hold v0 v'
2703 hold v0 v' = lift $ hold v0 v'
1549 {-# INLINABLE holdDyn #-}
2704 {-# INLINABLE holdDyn #-}
@@ -1565,7 +2720,7 @@ data Window t = Window
1565 , _window_raw :: DOM.Window
2720 , _window_raw :: DOM.Window
1566 }
2721 }
1567
2722
1568−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)
1569wrapWindow wv _ = do
2724wrapWindow wv _ = do
1570 events <- wrapDomEventsMaybe wv (defaultDomWindowEventHandler wv) windowOnEventName
2725 events <- wrapDomEventsMaybe wv (defaultDomWindowEventHandler wv) windowOnEventName
1571 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+119−18
@@ -15,6 +15,7 @@
15{-# LANGUAGE UndecidableInstances #-}
15{-# LANGUAGE UndecidableInstances #-}
16module Reflex.Dom.Builder.Static where
16module Reflex.Dom.Builder.Static where
17
17
18+import Data.IORef (IORef)
18import Blaze.ByteString.Builder.Html.Utf8
19import Blaze.ByteString.Builder.Html.Utf8
19import Control.Lens hiding (element)
20import Control.Lens hiding (element)
20import Control.Monad.Exception
21import Control.Monad.Exception
@@ -32,22 +33,28 @@ import qualified Data.Dependent.Map as DMap
32import Data.Dependent.Sum (DSum (..))
33import Data.Dependent.Sum (DSum (..))
33import Data.Functor.Compose
34import Data.Functor.Compose
34import Data.Functor.Constant
35import Data.Functor.Constant
36+import Data.IntMap (IntMap)
37+import qualified Data.IntMap as IntMap
35import qualified Data.Map as Map
38import qualified Data.Map as Map
36import Data.Map.Misc (applyMap)
39import Data.Map.Misc (applyMap)
37−import Data.Monoid
40+import Data.Maybe (fromMaybe)
41+import Data.Monoid ((<>))
38import qualified Data.Set as Set
42import qualified Data.Set as Set
39import Data.Text (Text)
43import Data.Text (Text)
44+import qualified Data.Text as T
40import Data.Text.Encoding
45import Data.Text.Encoding
41import Data.Tuple
46import Data.Tuple
42import GHC.Generics
47import GHC.Generics
48+import Reflex.Adjustable.Class
43import Reflex.Class
49import Reflex.Class
50+import Reflex.Dom.Main (DomHost, DomTimeline, runDomHost)
44import Reflex.Dom.Builder.Class
51import Reflex.Dom.Builder.Class
45import Reflex.Dynamic
52import Reflex.Dynamic
46import Reflex.Host.Class
53import Reflex.Host.Class
47import Reflex.PerformEvent.Base
54import Reflex.PerformEvent.Base
48import Reflex.PerformEvent.Class
55import Reflex.PerformEvent.Class
49import Reflex.PostBuild.Base
56import Reflex.PostBuild.Base
50−import Reflex.Spider
57+import Reflex.PostBuild.Class
51import Reflex.TriggerEvent.Class
58import Reflex.TriggerEvent.Class
52
59
53data StaticDomBuilderEnv t = StaticDomBuilderEnv
60data StaticDomBuilderEnv t = StaticDomBuilderEnv
@@ -57,6 +64,7 @@ data StaticDomBuilderEnv t = StaticDomBuilderEnv
57 -- 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.
58 -- 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.
59 -- 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
60 }
68 }
61
69
62newtype StaticDomBuilderT t m a = StaticDomBuilderT
70newtype StaticDomBuilderT t m a = StaticDomBuilderT
@@ -76,6 +84,10 @@ runStaticDomBuilderT (StaticDomBuilderT a) e = do
76 (result, a') <- runStateT (runReaderT a e) []
84 (result, a') <- runStateT (runReaderT a e) []
77 return (result, mconcat $ reverse a')
85 return (result, mconcat $ reverse a')
78
86
87+instance PostBuild t m => PostBuild t (StaticDomBuilderT t m) where
88+ {-# INLINABLE getPostBuild #-}
89+ getPostBuild = lift getPostBuild
90+
79instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StaticDomBuilderT t m) where
91instance MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (StaticDomBuilderT t m) where
80 {-# INLINABLE newEventWithTrigger #-}
92 {-# INLINABLE newEventWithTrigger #-}
81 newEventWithTrigger = lift . newEventWithTrigger
93 newEventWithTrigger = lift . newEventWithTrigger
@@ -138,29 +150,81 @@ instance Default (StaticEventSpec er)
138
150
139instance DomSpace StaticDomSpace where
151instance DomSpace StaticDomSpace where
140 type EventSpec StaticDomSpace = StaticEventSpec
152 type EventSpec StaticDomSpace = StaticEventSpec
153+ type RawDocument StaticDomSpace = ()
141 type RawTextNode StaticDomSpace = ()
154 type RawTextNode StaticDomSpace = ()
155+ type RawCommentNode StaticDomSpace = ()
142 type RawElement StaticDomSpace = ()
156 type RawElement StaticDomSpace = ()
143− type RawFile StaticDomSpace = ()
144 type RawInputElement StaticDomSpace = ()
157 type RawInputElement StaticDomSpace = ()
145 type RawTextAreaElement StaticDomSpace = ()
158 type RawTextAreaElement StaticDomSpace = ()
146 type RawSelectElement StaticDomSpace = ()
159 type RawSelectElement StaticDomSpace = ()
147 addEventSpecFlags _ _ _ _ = StaticEventSpec
160 addEventSpecFlags _ _ _ _ = StaticEventSpec
148
161
149−instance (Reflex t, Adjustable t m, MonadHold t m) => Adjustable t (StaticDomBuilderT t m) where
162+instance (SupportsStaticDomBuilder t m, Monad m) => HasDocument (StaticDomBuilderT t m) where
163+ askDocument = pure ()
164+
165+instance (Reflex t, Adjustable t m, MonadHold t m, SupportsStaticDomBuilder t m) => Adjustable t (StaticDomBuilderT t m) where
150 runWithReplace a0 a' = do
166 runWithReplace a0 a' = do
151 e <- StaticDomBuilderT ask
167 e <- StaticDomBuilderT ask
168+ key <- replaceStart e
152 (result0, result') <- lift $ runWithReplace (runStaticDomBuilderT a0 e) (flip runStaticDomBuilderT e <$> a')
169 (result0, result') <- lift $ runWithReplace (runStaticDomBuilderT a0 e) (flip runStaticDomBuilderT e <$> a')
153 o <- hold (snd result0) $ fmapCheap snd result'
170 o <- hold (snd result0) $ fmapCheap snd result'
154 StaticDomBuilderT $ modify $ (:) $ join o
171 StaticDomBuilderT $ modify $ (:) $ join o
172+ replaceEnd key
155 return (fst result0, fmapCheap fst result')
173 return (fst result0, fmapCheap fst result')
174+ traverseIntMapWithKeyWithAdjust = hoistIntMapWithKeyWithAdjust traverseIntMapWithKeyWithAdjust
156 traverseDMapWithKeyWithAdjust = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap
175 traverseDMapWithKeyWithAdjust = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjust mapPatchDMap
157 traverseDMapWithKeyWithAdjustWithMove = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove
176 traverseDMapWithKeyWithAdjustWithMove = hoistDMapWithKeyWithAdjust traverseDMapWithKeyWithAdjustWithMove mapPatchDMapWithMove
158
177
178+replaceStart :: (DomBuilder t m, MonadIO m) => StaticDomBuilderEnv t -> m Text
179+replaceStart env = do
180+ str <- show <$> liftIO (atomicModifyRef (_staticDomBuilderEnv_nextRunWithReplaceKey env) $ \k -> (succ k, k))
181+ let key = "-" <> T.pack str
182+ _ <- commentNode $ def { _commentNodeConfig_initialContents = "replace-start" <> key }
183+ pure key
184+
185+replaceEnd :: DomBuilder t m => Text -> m ()
186+replaceEnd key = void $ commentNode $ def { _commentNodeConfig_initialContents = "replace-end" <> key }
187+
188+hoistIntMapWithKeyWithAdjust :: forall t m p a b.
189+ ( Adjustable t m
190+ , MonadHold t m
191+ , Patch (p a)
192+ , Functor p
193+ , Patch (p (Behavior t Builder))
194+ , PatchTarget (p (Behavior t Builder)) ~ IntMap (Behavior t Builder)
195+ , Ref m ~ IORef, MonadIO m, MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadRef m -- TODO remove
196+ )
197+ => (forall x. (IntMap.Key -> a -> m x)
198+ -> IntMap a
199+ -> Event t (p a)
200+ -> m (IntMap x, Event t (p x))
201+ ) -- ^ The base monad's traversal
202+ -> (IntMap.Key -> a -> StaticDomBuilderT t m b)
203+ -> IntMap a
204+ -> Event t (p a)
205+ -> StaticDomBuilderT t m (IntMap b, Event t (p b))
206+hoistIntMapWithKeyWithAdjust base f im0 im' = do
207+ e <- StaticDomBuilderT ask
208+ (children0, children') <- lift $ base (\k v -> runStaticDomBuilderT (f k v) e) im0 im'
209+ let result0 = IntMap.map fst children0
210+ result' = (fmap . fmap) fst children'
211+ outputs0 :: IntMap (Behavior t Builder)
212+ outputs0 = IntMap.map snd children0
213+ outputs' :: Event t (p (Behavior t Builder))
214+ outputs' = (fmap . fmap) snd children'
215+ outputs <- holdIncremental outputs0 outputs'
216+ StaticDomBuilderT $ modify $ (:) $ pull $ do
217+ os <- sample $ currentIncremental outputs
218+ fmap mconcat $ forM (IntMap.toList os) $ \(_, o) -> do
219+ sample o
220+ return (result0, result')
221+
159hoistDMapWithKeyWithAdjust :: forall (k :: * -> *) v v' t m p.
222hoistDMapWithKeyWithAdjust :: forall (k :: * -> *) v v' t m p.
160 ( Adjustable t m
223 ( Adjustable t m
161 , MonadHold t m
224 , MonadHold t m
162 , PatchTarget (p k (Constant (Behavior t Builder))) ~ DMap k (Constant (Behavior t Builder))
225 , PatchTarget (p k (Constant (Behavior t Builder))) ~ DMap k (Constant (Behavior t Builder))
163 , Patch (p k (Constant (Behavior t Builder)))
226 , Patch (p k (Constant (Behavior t Builder)))
227+ , Ref m ~ IORef, MonadIO m, MonadFix m, PerformEvent t m, MonadReflexCreateTrigger t m, MonadRef m -- TODO remove
164 )
228 )
165 => (forall vv vv'.
229 => (forall vv vv'.
166 (forall a. k a -> vv a -> m (vv' a))
230 (forall a. k a -> vv a -> m (vv' a))
@@ -205,6 +269,15 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
205 Nothing -> return (pure (escape initialContents))
269 Nothing -> return (pure (escape initialContents))
206 Just setContents -> hold (escape initialContents) $ fmapCheap escape setContents --Only because it doesn't get optimized when profiling is on
270 Just setContents -> hold (escape initialContents) $ fmapCheap escape setContents --Only because it doesn't get optimized when profiling is on
207 return $ TextNode ()
271 return $ TextNode ()
272+ {-# INLINABLE commentNode #-}
273+ commentNode (CommentNodeConfig initialContents mSetContents) = StaticDomBuilderT $ do
274+ --TODO: Do not escape quotation marks; see https://stackoverflow.com/questions/25612166/what-characters-must-be-escaped-in-html-5
275+ shouldEscape <- asks _staticDomBuilderEnv_shouldEscape
276+ let escape = if shouldEscape then fromHtmlEscapedText else byteString . encodeUtf8
277+ (modify . (:)) . (\c -> "<!--" <> c <> "-->") =<< case mSetContents of
278+ Nothing -> return (pure (escape initialContents))
279+ Just setContents -> hold (escape initialContents) $ fmapCheap escape setContents --Only because it doesn't get optimized when profiling is on
280+ return $ CommentNode ()
208 {-# INLINABLE element #-}
281 {-# INLINABLE element #-}
209 element elementTag cfg child = do
282 element elementTag cfg child = do
210 -- https://www.w3.org/TR/html-markup/syntax.html#syntax-elements
283 -- https://www.w3.org/TR/html-markup/syntax.html#syntax-elements
@@ -214,7 +287,8 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
214 es <- newFanEventWithTrigger $ \_ _ -> return (return ())
287 es <- newFanEventWithTrigger $ \_ _ -> return (return ())
215 StaticDomBuilderT $ do
288 StaticDomBuilderT $ do
216 let shouldEscape = elementTag `Set.notMember` noEscapeElements
289 let shouldEscape = elementTag `Set.notMember` noEscapeElements
217− (result, innerHtml) <- lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv shouldEscape Nothing
290+ nextRunWithReplaceKey <- asks _staticDomBuilderEnv_nextRunWithReplaceKey
291+ (result, innerHtml) <- lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv shouldEscape Nothing nextRunWithReplaceKey
218 attrs0 <- foldDyn applyMap (cfg ^. initialAttributes) (cfg ^. modifyAttributes)
292 attrs0 <- foldDyn applyMap (cfg ^. initialAttributes) (cfg ^. modifyAttributes)
219 selectValue <- asks _staticDomBuilderEnv_selectValue
293 selectValue <- asks _staticDomBuilderEnv_selectValue
220 let addSelectedAttr attrs sel = case Map.lookup "value" attrs of
294 let addSelectedAttr attrs sel = case Map.lookup "value" attrs of
@@ -238,13 +312,32 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
238 return (e, result)
312 return (e, result)
239 {-# INLINABLE inputElement #-}
313 {-# INLINABLE inputElement #-}
240 inputElement cfg = do
314 inputElement cfg = do
241− (e, _result) <- element "input" (cfg ^. inputElementConfig_elementConfig) $ return ()
315+ -- Tweak the config to update the "value" and "checked" attributes appropriately.
242− let v0 = constDyn $ cfg ^. inputElementConfig_initialValue
316+ -- TODO: warn upon overwriting values.
243− let c0 = constDyn $ cfg ^. inputElementConfig_initialChecked
317+ let setInitialValue = Map.insert "value" (_inputElementConfig_initialValue cfg)
318+ setUpdatedValue updatedAttrs = case _inputElementConfig_setValue cfg of
319+ Nothing -> updatedAttrs
320+ Just e -> (Map.singleton "value" . Just <$> e) <> updatedAttrs
321+ setInitialChecked = case _inputElementConfig_initialChecked cfg of
322+ True -> Map.insert "checked" "checked"
323+ False -> id
324+ setUpdatedChecked updatedAttrs = case _inputElementConfig_setChecked cfg of
325+ Nothing -> updatedAttrs
326+ Just e -> (Map.singleton "checked" (Just "checked") <$ e) <> updatedAttrs
327+ adjustedConfig = _inputElementConfig_elementConfig cfg
328+ & elementConfig_initialAttributes %~ setInitialValue . setInitialChecked
329+ & elementConfig_modifyAttributes %~ setUpdatedValue . setUpdatedChecked
330+ (e, _result) <- element "input" adjustedConfig $ return ()
331+ v <- case _inputElementConfig_setValue cfg of
332+ Nothing -> pure $ constDyn (cfg ^. inputElementConfig_initialValue)
333+ Just ev -> holdDyn (cfg ^. inputElementConfig_initialValue) ev
334+ c <- case _inputElementConfig_setChecked cfg of
335+ Nothing -> pure $ constDyn $ _inputElementConfig_initialChecked cfg
336+ Just ev -> holdDyn (_inputElementConfig_initialChecked cfg) ev
244 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
337 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
245 return $ InputElement
338 return $ InputElement
246− { _inputElement_value = v0
339+ { _inputElement_value = v
247− , _inputElement_checked = c0
340+ , _inputElement_checked = c
248 , _inputElement_checkedChange = never
341 , _inputElement_checkedChange = never
249 , _inputElement_input = never
342 , _inputElement_input = never
250 , _inputElement_hasFocus = hasFocus
343 , _inputElement_hasFocus = hasFocus
@@ -254,12 +347,17 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
254 }
347 }
255 {-# INLINABLE textAreaElement #-}
348 {-# INLINABLE textAreaElement #-}
256 textAreaElement cfg = do
349 textAreaElement cfg = do
257− --TODO: Support setValue event
350+ (e, _domElement) <- element "textarea" (_textAreaElementConfig_elementConfig cfg) $ do
258− (e, _domElement) <- element "textarea" (cfg ^. textAreaElementConfig_elementConfig) $ return ()
351+ -- Set the initial value
259− let v0 = constDyn $ cfg ^. textAreaElementConfig_initialValue
352+ void $ textNode $ def
353+ & textNodeConfig_initialContents .~ _textAreaElementConfig_initialValue cfg
354+ & textNodeConfig_setContents .~ fromMaybe never (_textAreaElementConfig_setValue cfg)
355+ v <- case _textAreaElementConfig_setValue cfg of
356+ Nothing -> pure $ constDyn (cfg ^. textAreaElementConfig_initialValue)
357+ Just ev -> holdDyn (cfg ^. textAreaElementConfig_initialValue) ev
260 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
358 let hasFocus = constDyn False -- TODO should this be coming from initialAtttributes
261 return $ TextAreaElement
359 return $ TextAreaElement
262− { _textAreaElement_value = v0
360+ { _textAreaElement_value = v
263 , _textAreaElement_input = never
361 , _textAreaElement_input = never
264 , _textAreaElement_hasFocus = hasFocus
362 , _textAreaElement_hasFocus = hasFocus
265 , _textAreaElement_element = e
363 , _textAreaElement_element = e
@@ -268,7 +366,9 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
268 selectElement cfg child = do
366 selectElement cfg child = do
269 v <- holdDyn (cfg ^. selectElementConfig_initialValue) (cfg ^. selectElementConfig_setValue)
367 v <- holdDyn (cfg ^. selectElementConfig_initialValue) (cfg ^. selectElementConfig_setValue)
270 (e, result) <- element "select" (_selectElementConfig_elementConfig cfg) $ do
368 (e, result) <- element "select" (_selectElementConfig_elementConfig cfg) $ do
271− (a, innerHtml) <- StaticDomBuilderT $ lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv False $ Just (current v)
369+ (a, innerHtml) <- StaticDomBuilderT $ do
370+ nextRunWithReplaceKey <- asks _staticDomBuilderEnv_nextRunWithReplaceKey
371+ lift $ lift $ runStaticDomBuilderT child $ StaticDomBuilderEnv False (Just $ current v) nextRunWithReplaceKey
272 StaticDomBuilderT $ lift $ modify $ (:) innerHtml
372 StaticDomBuilderT $ lift $ modify $ (:) innerHtml
273 return a
373 return a
274 let wrapped = SelectElement
374 let wrapped = SelectElement
@@ -283,14 +383,15 @@ instance SupportsStaticDomBuilder t m => DomBuilder t (StaticDomBuilderT t m) wh
283 wrapRawElement () _ = return $ Element (EventSelector $ const never) ()
383 wrapRawElement () _ = return $ Element (EventSelector $ const never) ()
284
384
285--TODO: Make this more abstract --TODO: Put the WithWebView underneath PerformEventT - I think this would perform better
385--TODO: Make this more abstract --TODO: Put the WithWebView underneath PerformEventT - I think this would perform better
286−type StaticWidget x = PostBuildT Spider (StaticDomBuilderT Spider (PerformEventT Spider (SpiderHost Global)))
386+type StaticWidget x = PostBuildT DomTimeline (StaticDomBuilderT DomTimeline (PerformEventT DomTimeline DomHost))
287
387
288{-# INLINE renderStatic #-}
388{-# INLINE renderStatic #-}
289renderStatic :: StaticWidget x a -> IO (a, ByteString)
389renderStatic :: StaticWidget x a -> IO (a, ByteString)
290renderStatic w = do
390renderStatic w = do
291− runSpiderHost $ do
391+ runDomHost $ do
292 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
392 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
293− let env0 = StaticDomBuilderEnv True Nothing
393+ nextRunWithReplaceKey <- newRef 0
394+ let env0 = StaticDomBuilderEnv True Nothing nextRunWithReplaceKey
294 ((res, bs), FireCommand fire) <- hostPerformEventT $ runStaticDomBuilderT (runPostBuildT w postBuild) env0
395 ((res, bs), FireCommand fire) <- hostPerformEventT $ runStaticDomBuilderT (runPostBuildT w postBuild) env0
295 mPostBuildTrigger <- readRef postBuildTriggerRef
396 mPostBuildTrigger <- readRef postBuildTriggerRef
296 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)
15+-- | Previously an alias for 'Data.Map.singleton', but now generalised to 'At'
17−
16+(=:) :: (At m, Monoid m) => Index m -> IxValue m -> m
18−-- | Alias for Data.Map.singleton
17+k =: a = at k ?~ a $ mempty
19−(=:) :: k -> a -> Map k a
20−(=:) = Map.singleton
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+6−1
@@ -1,17 +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
9+import Reflex.Dom.Builder.Hydratable as X
5import Reflex.Dom.Builder.Immediate as X
10import Reflex.Dom.Builder.Immediate as X
6import Reflex.Dom.Builder.InputDisabled as X
11import Reflex.Dom.Builder.InputDisabled as X
7import Reflex.Dom.Builder.Static as X
12import Reflex.Dom.Builder.Static as X
8import Reflex.Dom.Class as X
13import Reflex.Dom.Class as X
9import Reflex.Dom.Location as X
14import Reflex.Dom.Location as X
10import Reflex.Dom.Main as X
15import Reflex.Dom.Main as X
11−import Reflex.Dom.Modals.Base as X
12import Reflex.Dom.Modals.Class as X
16import Reflex.Dom.Modals.Class as X
13import Reflex.Dom.Old as X
17import Reflex.Dom.Old as X
14import Reflex.Dom.Prerender as X
18import Reflex.Dom.Prerender as X
15import Reflex.Dom.WebSocket as X
19import Reflex.Dom.WebSocket as X
16import Reflex.Dom.Widget as X
20import Reflex.Dom.Widget as X
17import 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+198−37
@@ -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 #-}
@@ -17,6 +16,8 @@ module Reflex.Dom.Main where
17
16
18import Prelude hiding (concat, mapM, mapM_, sequence, sequence_)
17import Prelude hiding (concat, mapM, mapM_, sequence, sequence_)
19
18
19+import Reflex.Adjustable.Class
20+import Reflex.Class
20import Reflex.Dom.Builder.Immediate
21import Reflex.Dom.Builder.Immediate
21import Reflex.Dom.Class
22import Reflex.Dom.Class
22import Reflex.Host.Class
23import Reflex.Host.Class
@@ -24,8 +25,10 @@ import Reflex.PerformEvent.Base
24import Reflex.PostBuild.Base
25import Reflex.PostBuild.Base
25import Reflex.Spider (Global, Spider, SpiderHost, runSpiderHost)
26import Reflex.Spider (Global, Spider, SpiderHost, runSpiderHost)
26import Reflex.TriggerEvent.Base
27import Reflex.TriggerEvent.Base
27−
28+import Reflex.TriggerEvent.Class
28−import Reflex.Dom.Specializations () -- For SPECIALIZATION pragmas, which are always re-exported
29+#ifdef PROFILE_REFLEX
30+import Reflex.Profiled
31+#endif
29
32
30import Control.Concurrent
33import Control.Concurrent
31import Control.Lens
34import Control.Lens
@@ -34,6 +37,7 @@ import Control.Monad.Reader hiding (forM, forM_, mapM, mapM_, sequence, sequence
34import Control.Monad.Ref
37import Control.Monad.Ref
35import Data.ByteString (ByteString)
38import Data.ByteString (ByteString)
36import Data.Dependent.Sum (DSum (..))
39import Data.Dependent.Sum (DSum (..))
40+import Data.Foldable (for_)
37import Data.IORef
41import Data.IORef
38import Data.Maybe
42import Data.Maybe
39import Data.Monoid ((<>))
43import Data.Monoid ((<>))
@@ -52,6 +56,135 @@ import qualified GHCJS.DOM.Types as DOM
52import Reflex.Profiled
56import Reflex.Profiled
53#endif
57#endif
54
58
59+{-# INLINE mainHydrationWidgetWithHead #-}
60+mainHydrationWidgetWithHead :: (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
61+mainHydrationWidgetWithHead = mainHydrationWidgetWithHead'
62+
63+{-# INLINABLE mainHydrationWidgetWithHead' #-}
64+-- | Warning: `mainHydrationWidgetWithHead'` is provided only as performance tweak. It is expected to disappear in future releases.
65+mainHydrationWidgetWithHead' :: HydrationWidget () () -> HydrationWidget () () -> JSM ()
66+mainHydrationWidgetWithHead' = mainHydrationWidgetWithSwitchoverAction' (pure ())
67+
68+{-# INLINE mainHydrationWidgetWithSwitchoverAction #-}
69+mainHydrationWidgetWithSwitchoverAction :: JSM () -> (forall x. HydrationWidget x ()) -> (forall x. HydrationWidget x ()) -> JSM ()
70+mainHydrationWidgetWithSwitchoverAction = mainHydrationWidgetWithSwitchoverAction'
71+
72+{-# INLINABLE mainHydrationWidgetWithSwitchoverAction' #-}
73+-- | Warning: `mainHydrationWidgetWithSwitchoverAction'` is provided only as performance tweak. It is expected to disappear in future releases.
74+mainHydrationWidgetWithSwitchoverAction' :: JSM () -> HydrationWidget () () -> HydrationWidget () () -> JSM ()
75+mainHydrationWidgetWithSwitchoverAction' = mainHydrationWidgetWithSwitchoverActionWithFailure' (pure ())
76+
77+
78+{-# INLINABLE mainHydrationWidgetWithSwitchoverActionWithFailure' #-}
79+-- | Warning: `mainHydrationWidgetWithSwitchoverActionWithFaiilure'` is provided only as performance tweak. It is expected to disappear in future releases.
80+mainHydrationWidgetWithSwitchoverActionWithFailure' :: IO () -> JSM () -> HydrationWidget () () -> HydrationWidget () () -> JSM ()
81+mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchoverAction head' body = do
82+ runHydrationWidgetWithHeadAndBodyWithFailure onFailure switchoverAction $ \appendHead appendBody -> do
83+ appendHead head'
84+ appendBody body
85+
86+{-# INLINABLE attachHydrationWidget #-}
87+attachHydrationWidget
88+ :: JSM ()
89+ -> JSContextSingleton ()
90+ -> ( Event DomTimeline ()
91+ -> IORef HydrationMode
92+ -> Maybe (IORef [(Node, HydrationRunnerT DomTimeline (DomCoreWidget ()) ())])
93+ -> EventChannel
94+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
95+ )
96+ -> IO (a, FireCommand DomTimeline DomHost)
97+attachHydrationWidget = attachHydrationWidgetWithFailure (pure ())
98+
99+{-# INLINABLE attachHydrationWidgetWithFailure #-}
100+attachHydrationWidgetWithFailure
101+ :: IO ()
102+ -> JSM ()
103+ -> JSContextSingleton ()
104+ -> ( Event DomTimeline ()
105+ -> IORef HydrationMode
106+ -> Maybe (IORef [(Node, HydrationRunnerT DomTimeline (DomCoreWidget ()) ())])
107+ -> EventChannel
108+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
109+ )
110+ -> IO (a, FireCommand DomTimeline DomHost)
111+attachHydrationWidgetWithFailure onFailure switchoverAction jsSing w = do
112+ hydrationMode <- liftIO $ newIORef HydrationMode_Hydrating
113+ rootNodesRef <- liftIO $ newIORef []
114+ events <- newChan
115+ runDomHost $ flip runTriggerEventT events $ mdo
116+ (syncEvent, fireSync) <- newTriggerEvent
117+ ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- lift $ hostPerformEventT $ do
118+ a <- w syncEvent hydrationMode (Just rootNodesRef) events
119+ _ <- runWithReplace (return ()) $ delayedAction <$ syncEvent
120+ pure a
121+ mPostBuildTrigger <- readRef postBuildTriggerRef
122+ lift $ forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
123+ liftIO $ fireSync ()
124+ rootNodes <- liftIO $ readIORef rootNodesRef
125+ let delayedAction = do
126+ for_ (reverse rootNodes) $ \(rootNode, runner) -> do
127+ let hydrate = runHydrationRunnerTWithFailure runner onFailure Nothing rootNode events
128+ void $ runWithJSContextSingleton (runPostBuildT hydrate never) jsSing
129+ liftIO $ writeIORef hydrationMode HydrationMode_Immediate
130+ runWithJSContextSingleton (DOM.liftJSM switchoverAction) jsSing
131+ pure (result, fc)
132+
133+type HydrationWidget x a = HydrationDomBuilderT HydrationDomSpace DomTimeline (DomCoreWidget x) a
134+
135+-- | A widget that isn't attached to any particular part of the DOM hierarchy
136+type FloatingWidget x = TriggerEventT DomTimeline (DomCoreWidget x)
137+
138+type DomCoreWidget x = PostBuildT DomTimeline (WithJSContextSingleton x (PerformEventT DomTimeline DomHost))
139+
140+{-# INLINABLE runHydrationWidgetWithHeadAndBody #-}
141+runHydrationWidgetWithHeadAndBody
142+ :: JSM ()
143+ -> ( (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to head" --TODO: test invoking this more than once
144+ -> (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to body" --TODO: test invoking this more than once
145+ -> FloatingWidget () ()
146+ )
147+ -> JSM ()
148+runHydrationWidgetWithHeadAndBody = runHydrationWidgetWithHeadAndBodyWithFailure (pure ())
149+
150+{-# INLINABLE runHydrationWidgetWithHeadAndBodyWithFailure #-}
151+runHydrationWidgetWithHeadAndBodyWithFailure
152+ :: IO ()
153+ -> JSM ()
154+ -> ( (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to head" --TODO: test invoking this more than once
155+ -> (forall c. HydrationWidget () c -> FloatingWidget () c) -- "Append to body" --TODO: test invoking this more than once
156+ -> FloatingWidget () ()
157+ )
158+ -> JSM ()
159+runHydrationWidgetWithHeadAndBodyWithFailure onFailure switchoverAction app = withJSContextSingletonMono $ \jsSing -> do
160+ globalDoc <- currentDocumentUnchecked
161+ headElement <- getHeadUnchecked globalDoc
162+ bodyElement <- getBodyUnchecked globalDoc
163+ (events, fc) <- liftIO . attachHydrationWidgetWithFailure onFailure switchoverAction jsSing $ \switchover hydrationMode hydrationResult events -> do
164+ (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
165+ let hydrateDom :: DOM.Node -> HydrationWidget () c -> FloatingWidget () c
166+ hydrateDom n w = do
167+ delayed <- liftIO $ newIORef $ pure ()
168+ unreadyChildren <- liftIO $ newIORef 0
169+ lift $ do
170+ let builderEnv = HydrationDomBuilderEnv
171+ { _hydrationDomBuilderEnv_document = globalDoc
172+ , _hydrationDomBuilderEnv_parent = Left $ toNode n
173+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
174+ , _hydrationDomBuilderEnv_commitAction = pure ()
175+ , _hydrationDomBuilderEnv_hydrationMode = hydrationMode
176+ , _hydrationDomBuilderEnv_switchover = switchover
177+ , _hydrationDomBuilderEnv_delayed = delayed
178+ }
179+ a <- runHydrationDomBuilderT w builderEnv events
180+ forM_ hydrationResult $ \hr -> do
181+ res <- liftIO $ readIORef delayed
182+ liftIO $ modifyIORef' hr ((n, res) :)
183+ pure a
184+ runWithJSContextSingleton (runPostBuildT (runTriggerEventT (app (hydrateDom $ toNode headElement) (hydrateDom $ toNode bodyElement)) events) postBuild) jsSing
185+ return (events, postBuildTriggerRef)
186+ liftIO $ processAsyncEvents events fc
187+
55{-# INLINE mainWidget #-}
188{-# INLINE mainWidget #-}
56mainWidget :: (forall x. Widget x ()) -> JSM ()
189mainWidget :: (forall x. Widget x ()) -> JSM ()
57mainWidget = mainWidget'
190mainWidget = mainWidget'
@@ -103,40 +236,54 @@ runDomHost = runSpiderHost
103 . runProfiledM
236 . runProfiledM
104#endif
237#endif
105
238
106−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)
107
240
108{-# INLINABLE attachWidget #-}
241{-# INLINABLE attachWidget #-}
109attachWidget :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> JSM a
242attachWidget :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> JSM a
110attachWidget rootElement wv w = fst <$> attachWidget' rootElement wv w
243attachWidget rootElement wv w = fst <$> attachWidget' rootElement wv w
111
244
112−-- | Warning: `mainWidgetWithHead'` is provided only as performance tweak. It is expected to disappear in future releases.
245+{-# INLINABLE runImmediateWidgetWithHeadAndBody #-}
113−mainWidgetWithHead' :: (a -> Widget () b, b -> Widget () a) -> JSM ()
246+runImmediateWidgetWithHeadAndBody
114−mainWidgetWithHead' widgets = withJSContextSingletonMono $ \jsSing -> do
247+ :: ( (forall c. Widget () c -> FloatingWidget () c) -- "Append to head"
115− doc <- currentDocumentUnchecked
248+ -> (forall c. Widget () c -> FloatingWidget () c) -- "Append to body"
116− headElement <- getHeadUnchecked doc
249+ -> FloatingWidget () ()
117− headFragment <- createDocumentFragment doc
250+ )
118− bodyElement <- getBodyUnchecked doc
251+ -> JSM ()
119− bodyFragment <- createDocumentFragment doc
252+runImmediateWidgetWithHeadAndBody app = withJSContextSingletonMono $ \jsSing -> do
120− (events, fc) <- liftIO . attachWidget'' $ \events -> do
253+ globalDoc <- currentDocumentUnchecked
121− let (headWidget, bodyWidget) = widgets
254+ headElement <- getHeadUnchecked globalDoc
255+ bodyElement <- getBodyUnchecked globalDoc
256+ headFragment <- createDocumentFragment globalDoc
257+ bodyFragment <- createDocumentFragment globalDoc
258+ (events, fc) <- liftIO . attachImmediateWidget $ \hydrationMode events -> do
122 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
259 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
123− let go :: forall c. Widget () c -> DOM.DocumentFragment -> PerformEventT DomTimeline DomHost c
260+ let go :: forall c. DOM.DocumentFragment -> Widget () c -> FloatingWidget () c
124− go w df = do
261+ go df w = do
125 unreadyChildren <- liftIO $ newIORef 0
262 unreadyChildren <- liftIO $ newIORef 0
126− let builderEnv = ImmediateDomBuilderEnv
263+ delayed <- liftIO $ newIORef $ pure ()
127− { _immediateDomBuilderEnv_document = toDocument doc
264+ let builderEnv = HydrationDomBuilderEnv
128− , _immediateDomBuilderEnv_parent = toNode df
265+ { _hydrationDomBuilderEnv_document = globalDoc
129− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
266+ , _hydrationDomBuilderEnv_parent = Left $ toNode df
130− , _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
131 }
272 }
132− runWithJSContextSingleton (runImmediateDomBuilderT (runPostBuildT w postBuild) builderEnv events) jsSing
273+ lift $ runHydrationDomBuilderT w builderEnv events
133− rec b <- go (headWidget a) headFragment
274+ runWithJSContextSingleton (runPostBuildT (runTriggerEventT (app (go headFragment) (go bodyFragment)) events) postBuild) jsSing
134− a <- go (bodyWidget b) bodyFragment
135 return (events, postBuildTriggerRef)
275 return (events, postBuildTriggerRef)
136 replaceElementContents headElement headFragment
276 replaceElementContents headElement headFragment
137 replaceElementContents bodyElement bodyFragment
277 replaceElementContents bodyElement bodyFragment
138 liftIO $ processAsyncEvents events fc
278 liftIO $ processAsyncEvents events fc
139
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+
140replaceElementContents :: DOM.IsElement e => e -> DOM.DocumentFragment -> JSM ()
287replaceElementContents :: DOM.IsElement e => e -> DOM.DocumentFragment -> JSM ()
141replaceElementContents e df = do
288replaceElementContents e df = do
142 setInnerHTML e ("" :: String)
289 setInnerHTML e ("" :: String)
@@ -148,16 +295,20 @@ attachWidget' :: DOM.IsElement e => e -> JSContextSingleton x -> Widget x a -> J
148attachWidget' rootElement jsSing w = do
295attachWidget' rootElement jsSing w = do
149 doc <- getOwnerDocumentUnchecked rootElement
296 doc <- getOwnerDocumentUnchecked rootElement
150 df <- createDocumentFragment doc
297 df <- createDocumentFragment doc
151− ((a, events), fc) <- liftIO . attachWidget'' $ \events -> do
298+ ((a, events), fc) <- liftIO . attachImmediateWidget $ \hydrationMode events -> do
152 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
299 (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
153 unreadyChildren <- liftIO $ newIORef 0
300 unreadyChildren <- liftIO $ newIORef 0
154− let builderEnv = ImmediateDomBuilderEnv
301+ delayed <- liftIO $ newIORef $ pure ()
155− { _immediateDomBuilderEnv_document = toDocument doc
302+ let builderEnv = HydrationDomBuilderEnv
156− , _immediateDomBuilderEnv_parent = toNode df
303+ { _hydrationDomBuilderEnv_document = toDocument doc
157− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
304+ , _hydrationDomBuilderEnv_parent = Left $ toNode df
158− , _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
159 }
310 }
160− a <- runWithJSContextSingleton (runImmediateDomBuilderT (runPostBuildT w postBuild) builderEnv events) jsSing
311+ a <- runWithJSContextSingleton (runPostBuildT (runHydrationDomBuilderT w builderEnv events) postBuild) jsSing
161 return ((a, events), postBuildTriggerRef)
312 return ((a, events), postBuildTriggerRef)
162 replaceElementContents rootElement df
313 replaceElementContents rootElement df
163 liftIO $ processAsyncEvents events fc
314 liftIO $ processAsyncEvents events fc
@@ -165,12 +316,18 @@ attachWidget' rootElement jsSing w = do
165
316
166type EventChannel = Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
317type EventChannel = Chan [DSum (EventTriggerRef DomTimeline) TriggerInvocation]
167
318
168−{-# INLINABLE attachWidget'' #-}
319+{-# INLINABLE attachImmediateWidget #-}
169−attachWidget'' :: (EventChannel -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))) -> IO (a, FireCommand DomTimeline DomHost)
320+attachImmediateWidget
170−attachWidget'' w = do
321+ :: ( IORef HydrationMode
322+ -> EventChannel
323+ -> PerformEventT DomTimeline DomHost (a, IORef (Maybe (EventTrigger DomTimeline ())))
324+ )
325+ -> IO (a, FireCommand DomTimeline DomHost)
326+attachImmediateWidget w = do
327+ hydrationMode <- liftIO $ newIORef HydrationMode_Immediate
171 events <- newChan
328 events <- newChan
172 runDomHost $ do
329 runDomHost $ do
173− ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- hostPerformEventT $ w events
330+ ((result, postBuildTriggerRef), fc@(FireCommand fire)) <- hostPerformEventT $ w hydrationMode events
174 mPostBuildTrigger <- readRef postBuildTriggerRef
331 mPostBuildTrigger <- readRef postBuildTriggerRef
175 forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
332 forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
176 return (result, fc)
333 return (result, fc)
@@ -186,7 +343,6 @@ processAsyncEvents events (FireCommand fire) = void $ forkIO $ forever $ do
186 liftIO $ forM_ ers $ \(_ :=> TriggerInvocation _ cb) -> cb
343 liftIO $ forM_ ers $ \(_ :=> TriggerInvocation _ cb) -> cb
187 return ()
344 return ()
188
345
189−
190-- | 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
191mainWidgetInElementById :: Text -> (forall x. Widget x ()) -> JSM ()
347mainWidgetInElementById :: Text -> (forall x. Widget x ()) -> JSM ()
192mainWidgetInElementById eid w = withJSContextSingleton $ \jsSing -> do
348mainWidgetInElementById eid w = withJSContextSingleton $ \jsSing -> do
@@ -208,8 +364,13 @@ runApp' app = withJSContextSingleton $ \jsSing -> do
208 body <- getBodyUnchecked doc
364 body <- getBodyUnchecked doc
209 win <- getDefaultViewUnchecked doc
365 win <- getDefaultViewUnchecked doc
210 rec o <- attachWidget body jsSing $ do
366 rec o <- attachWidget body jsSing $ do
211− w <- lift $ wrapWindow win $ _appOutput_windowConfig o
367+ w <- wrapWindow win $ _appOutput_windowConfig o
212 app $ AppInput
368 app $ AppInput
213 { _appInput_window = w
369 { _appInput_window = w
214 }
370 }
215 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−2
@@ -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 #-}
@@ -103,7 +102,6 @@ elConfig_attributes f (ElConfig a b) = (\b' -> ElConfig a b') <$> f b
103{-# INLINE elConfig_attributes #-}
102{-# INLINE elConfig_attributes #-}
104#endif
103#endif
105
104
106−--TODO: HasDocument is still not accounted for
107type MonadWidgetConstraints t m =
105type MonadWidgetConstraints t m =
108 ( DomBuilder t m
106 ( DomBuilder t m
109 , DomBuilderSpace m ~ GhcjsDomSpace
107 , DomBuilderSpace m ~ GhcjsDomSpace
reflex-dom-core/src/Reflex/Dom/Prerender.hs+293−49
@@ -1,82 +1,326 @@
1{-# LANGUAGE ConstraintKinds #-}
1{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE EmptyDataDecls #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE EmptyCase #-}
3{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FunctionalDependencies #-}
6{-# LANGUAGE FunctionalDependencies #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE LambdaCase #-}
9+{-# LANGUAGE OverloadedStrings #-}
7{-# LANGUAGE Rank2Types #-}
10{-# LANGUAGE Rank2Types #-}
11+{-# LANGUAGE RecursiveDo #-}
8{-# LANGUAGE ScopedTypeVariables #-}
12{-# LANGUAGE ScopedTypeVariables #-}
9{-# LANGUAGE TypeFamilies #-}
13{-# LANGUAGE TypeFamilies #-}
10−{-# LANGUAGE TypeSynonymInstances #-}
11{-# LANGUAGE UndecidableInstances #-}
14{-# LANGUAGE UndecidableInstances #-}
15+{-# LANGUAGE UndecidableSuperClasses #-}
16+
17+-- | Render the first widget on the server, and the second on the client.
12module Reflex.Dom.Prerender
18module Reflex.Dom.Prerender
13 ( Prerender (..)
19 ( Prerender (..)
14− , prerender
20+ , prerender_
21+ , PrerenderClientConstraint
22+ , PrerenderBaseConstraints
15 ) where
23 ) where
16
24
25+import Control.Monad.Primitive (PrimMonad(..))
17import Control.Monad.Reader
26import Control.Monad.Reader
18−import Data.Constraint
27+import Control.Monad.Ref (MonadRef(..), MonadAtomicRef(..))
28+import Data.IORef (IORef, newIORef)
29+import Data.Semigroup (Semigroup)
30+import Data.Text (Text)
31+import Data.Void
19import Foreign.JavaScript.TH
32import Foreign.JavaScript.TH
20import GHCJS.DOM.Types (MonadJSM)
33import GHCJS.DOM.Types (MonadJSM)
21−import Reflex
34+import Reflex hiding (askEvents)
22−import Reflex.Dom.Builder.InputDisabled
35+import Reflex.Dom.Builder.Class
36+import Reflex.Dom.Builder.Hydratable
23import Reflex.Dom.Builder.Immediate
37import Reflex.Dom.Builder.Immediate
38+import Reflex.Dom.Builder.InputDisabled
24import Reflex.Dom.Builder.Static
39import Reflex.Dom.Builder.Static
25import Reflex.Host.Class
40import Reflex.Host.Class
41+import Data.IntMap.Strict (IntMap)
42+import qualified Data.IntMap.Strict as IntMap
26
43
27−type PrerenderClientConstraint js m =
44+import qualified GHCJS.DOM.Document as Document
28− ( HasJS js m
45+import qualified GHCJS.DOM.Node as Node
29− , HasJS js (Performable m)
46+import qualified GHCJS.DOM.Types as DOM
30− , MonadJSM m
47+
31− , MonadJSM (Performable m)
48+type PrerenderClientConstraint js t m =
49+ ( DomBuilder t m
50+ , DomBuilderSpace m ~ GhcjsDomSpace
51+ , DomRenderHook t m
52+ , HasDocument m
53+ , TriggerEvent t m
54+ , PrerenderBaseConstraints js t m
55+ )
56+
57+type PrerenderBaseConstraints js t m =
58+ ( HasJSContext (Performable m)
32 , HasJSContext m
59 , HasJSContext m
33− , HasJSContext (Performable m)
34 , MonadFix m
60 , MonadFix m
35− , MonadFix (Performable m)
61+ , MonadHold t m
62+ , MonadJSM (Performable m)
63+ , MonadJSM m
64+ , MonadRef (Performable m)
65+ , MonadRef m
66+ , MonadReflexCreateTrigger t m
67+ , MonadSample t (Performable m)
68+ , PerformEvent t m
69+ , PostBuild t m
70+ , PrimMonad m
71+ , Ref (Performable m) ~ IORef
72+ , Ref m ~ IORef
73+ , HasJS js m
74+ , HasJS js (Performable m)
36 )
75 )
37
76
38−class Prerender js m | m -> js where
77+-- | Render the first widget on the server, and the second on the client. The
39− prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m))
78+-- hydration builder will run *both* widgets.
79+prerender_
80+ :: (Functor m, Reflex t, Prerender js t m)
81+ => m () -> Client m () -> m ()
82+prerender_ server client = void $ prerender server client
83+
84+class (PrerenderClientConstraint js t (Client m), Client (Client m) ~ Client m, Prerender js t (Client m)) => Prerender js t m | m -> t js where
85+ -- | Monad in which the client widget is built
86+ type Client m :: * -> *
87+ -- | Render the first widget on the server, and the second on the client. The
88+ -- hydration builder will run *both* widgets, updating the result dynamic at
89+ -- switchover time.
90+ prerender :: m a -> Client m a -> m (Dynamic t a)
91+
92+instance (ReflexHost t, Adjustable t m, PrerenderBaseConstraints js t m) => Prerender js t (HydrationDomBuilderT GhcjsDomSpace t m) where
93+ type Client (HydrationDomBuilderT GhcjsDomSpace t m) = HydrationDomBuilderT GhcjsDomSpace t m
94+ prerender _ client = pure <$> client
95+
96+instance (Adjustable t m, PrerenderBaseConstraints js t m, ReflexHost t) => Prerender js t (HydrationDomBuilderT HydrationDomSpace t m) where
97+ -- | PostBuildT is needed here because we delay running the client builder
98+ -- until after switchover, at which point the postBuild of @m@ has already fired
99+ type Client (HydrationDomBuilderT HydrationDomSpace t m) = PostBuildT t (HydrationDomBuilderT GhcjsDomSpace t m)
100+ -- | Runs the server widget up until switchover, then replaces it with the
101+ -- client widget.
102+ prerender server client = do
103+ env <- HydrationDomBuilderT ask
104+ events <- askEvents
105+ doc <- askDocument
106+ serverDf <- Document.createDocumentFragment doc -- server dom should not be mounted in the window's doc in hydration
107+ df <- Document.createDocumentFragment doc
108+ unreadyChildren <- HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_unreadyChildren
109+ immediateMode <- liftIO $ newIORef HydrationMode_Immediate
110+ delayed <- liftIO $ newIORef $ pure ()
111+ let clientEnv = env
112+ { _hydrationDomBuilderEnv_parent = Left $ DOM.toNode df
113+ , _hydrationDomBuilderEnv_hydrationMode = immediateMode
114+ }
115+ serverEnv = HydrationDomBuilderEnv
116+ { _hydrationDomBuilderEnv_document = doc
117+ , _hydrationDomBuilderEnv_parent = Left $ DOM.toNode serverDf
118+ , _hydrationDomBuilderEnv_unreadyChildren = unreadyChildren
119+ , _hydrationDomBuilderEnv_commitAction = pure ()
120+ , _hydrationDomBuilderEnv_delayed = delayed
121+ , _hydrationDomBuilderEnv_hydrationMode = immediateMode
122+ , _hydrationDomBuilderEnv_switchover = never
123+ }
124+ a0 <- lift $ runHydrationDomBuilderT server serverEnv events
125+ (a', trigger) <- newTriggerEvent
126+ getHydrationMode >>= \case
127+ HydrationMode_Immediate -> do
128+ liftIO . trigger <=< lift $ runHydrationDomBuilderT (runPostBuildT client $ void a') clientEnv events
129+ append $ DOM.toNode df
130+ HydrationMode_Hydrating -> addHydrationStep $ do
131+ liftIO . trigger <=< lift $ runHydrationDomBuilderT (runPostBuildT client $ void a') clientEnv events
132+ insertBefore df =<< deleteToPrerenderEnd doc
133+ holdDyn a0 a'
134+
135+newtype UnrunnableT js t m a = UnrunnableT (ReaderT Void m a)
136+ deriving (Functor, Applicative, Monad, MonadTrans)
137+
138+unrunnable :: UnrunnableT js t m a
139+unrunnable = UnrunnableT $ ReaderT $ \case {}
140+
141+instance (Reflex t, Monad m) => DomBuilder t (UnrunnableT js t m) where
142+ type DomBuilderSpace (UnrunnableT js t m) = GhcjsDomSpace
143+ textNode _ = unrunnable
144+ commentNode _ = unrunnable
145+ element _ _ _ = unrunnable
146+ inputElement _ = unrunnable
147+ textAreaElement _ = unrunnable
148+ selectElement _ _ = unrunnable
149+ placeRawElement _ = unrunnable
150+ wrapRawElement _ _ = unrunnable
151+instance (Reflex t, Monad m) => NotReady t (UnrunnableT js t m) where
152+ notReadyUntil _ = unrunnable
153+ notReady = unrunnable
154+instance (Reflex t, Monad m) => Adjustable t (UnrunnableT js t m) where
155+ runWithReplace _ _ = unrunnable
156+ traverseIntMapWithKeyWithAdjust _ _ _ = unrunnable
157+ traverseDMapWithKeyWithAdjust _ _ _ = unrunnable
158+ traverseDMapWithKeyWithAdjustWithMove _ _ _ = unrunnable
159+instance (Reflex t, Monad m) => PerformEvent t (UnrunnableT js t m) where
160+ type Performable (UnrunnableT js t m) = UnrunnableT js t m
161+ performEvent _ = unrunnable
162+ performEvent_ _ = unrunnable
163+instance Monad m => MonadRef (UnrunnableT js t m) where
164+ type Ref (UnrunnableT js t m) = Ref IO
165+ newRef _ = unrunnable
166+ readRef _ = unrunnable
167+ writeRef _ _ = unrunnable
168+instance Monad m => MonadAtomicRef (UnrunnableT js t m) where
169+ atomicModifyRef _ _ = unrunnable
170+instance Monad m => HasDocument (UnrunnableT js t m) where
171+ askDocument = unrunnable
172+instance Monad m => HasJSContext (UnrunnableT js t m) where
173+ type JSContextPhantom (UnrunnableT js t m) = ()
174+ askJSContext = unrunnable
175+instance Monad m => HasJS JS' (UnrunnableT js t m) where
176+ type JSX (UnrunnableT js t m) = UnrunnableT js t m
177+ liftJS _ = unrunnable
178+instance Monad m => MonadJS JS' (UnrunnableT js t m) where
179+ runJS _ _ = unrunnable
180+ forkJS _ = unrunnable
181+ mkJSUndefined = unrunnable
182+ isJSNull _ = unrunnable
183+ isJSUndefined _ = unrunnable
184+ fromJSBool _ = unrunnable
185+ fromJSString _ = unrunnable
186+ fromJSArray _ = unrunnable
187+ fromJSUint8Array _ = unrunnable
188+ fromJSNumber _ = unrunnable
189+ withJSBool _ _ = unrunnable
190+ withJSString _ _ = unrunnable
191+ withJSNumber _ _ = unrunnable
192+ withJSArray _ _ = unrunnable
193+ withJSUint8Array _ _ = unrunnable
194+ mkJSFun _ = unrunnable
195+ freeJSFun _ = unrunnable
196+ setJSProp _ _ _ = unrunnable
197+ getJSProp _ _ = unrunnable
198+ withJSNode _ _ = unrunnable
199+instance Monad m => TriggerEvent t (UnrunnableT js t m) where
200+ newTriggerEvent = unrunnable
201+ newTriggerEventWithOnComplete = unrunnable
202+ newEventWithLazyTriggerWithOnComplete _ = unrunnable
203+instance Monad m => MonadReflexCreateTrigger t (UnrunnableT js t m) where
204+ newEventWithTrigger _ = unrunnable
205+ newFanEventWithTrigger _ = unrunnable
206+instance Monad m => MonadFix (UnrunnableT js t m) where
207+ mfix _ = unrunnable
208+instance (Monad m, MonadHold t m) => MonadHold t (UnrunnableT js t m) where
209+ hold _ _ = unrunnable
210+ holdDyn _ _ = unrunnable
211+ holdIncremental _ _ = unrunnable
212+ buildDynamic _ _ = unrunnable
213+ headE _ = unrunnable
214+ now = unrunnable
215+instance Monad m => MonadSample t (UnrunnableT js t m) where
216+ sample _ = unrunnable
217+instance Monad m => MonadIO (UnrunnableT js t m) where
218+ liftIO _ = unrunnable
219+#ifndef ghcjs_HOST_OS
220+instance Monad m => MonadJSM (UnrunnableT js t m) where
221+ liftJSM' _ = unrunnable
222+#endif
223+instance (Reflex t, Monad m) => PostBuild t (UnrunnableT js t m) where
224+ getPostBuild = unrunnable
225+instance Monad m => PrimMonad (UnrunnableT js t m) where
226+ type PrimState (UnrunnableT js t m) = PrimState IO
227+ primitive _ = unrunnable
228+instance (Reflex t, Monad m) => DomRenderHook t (UnrunnableT js t m) where
229+ withRenderHook _ _ = unrunnable
230+ requestDomAction _ = unrunnable
231+ requestDomAction_ _ = unrunnable
232+instance (Reflex t, Monad m, MonadHold t m) => Prerender JS' t (UnrunnableT js t m) where
233+ type Client (UnrunnableT js t m) = UnrunnableT js t m
234+ prerender _ _ = unrunnable
235+
236+instance (SupportsStaticDomBuilder t m) => Prerender JS' t (StaticDomBuilderT t m) where
237+ type Client (StaticDomBuilderT t m) = UnrunnableT JS' t m
238+ prerender server _ = do
239+ _ <- commentNode $ CommentNodeConfig startMarker Nothing
240+ a <- server
241+ _ <- commentNode $ CommentNodeConfig endMarker Nothing
242+ pure $ pure a
40
243
41−-- | Draw one widget when prerendering (e.g. server-side) and another when the
244+instance (Prerender js t m, Monad m) => Prerender js t (ReaderT r m) where
42−-- widget is fully instantiated. In a given execution of this function, there
245+ type Client (ReaderT r m) = ReaderT r (Client m)
43−-- will be exactly one invocation of exactly one of the arguments.
246+ prerender server client = do
44−prerender :: forall js m a. Prerender js m => m a -> (PrerenderClientConstraint js m => m a) -> m a
247+ r <- ask
45−prerender server client = case prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)) of
248+ lift $ prerender (runReaderT server r) (runReaderT client r)
46− Nothing -> server
47− Just Dict -> client
48
249
49−instance ( HasJS js m
250+instance (Prerender js t m, Monad m, Reflex t, MonadFix m, Monoid w) => Prerender js t (DynamicWriterT t w m) where
50− , HasJS js (Performable m)
251+ type Client (DynamicWriterT t w m) = DynamicWriterT t w (Client m)
51− , HasJSContext m
252+ prerender server client = do
52− , HasJSContext (Performable m)
253+ x <- lift $ prerender (runDynamicWriterT server) (runDynamicWriterT client)
53− , MonadJSM m
254+ let (a, w') = splitDynPure x
54− , MonadJSM (Performable m)
255+ w = join w'
55− , MonadFix m
256+ tellDyn w
56− , MonadFix (Performable m)
257+ pure a
57− , ReflexHost t
58− ) => Prerender js (ImmediateDomBuilderT t m) where
59− prerenderClientDict = Just Dict
60
258
61−data NoJavaScript -- This type should never have a HasJS instance
259+instance (Prerender js t m, Monad m, Reflex t, Semigroup w) => Prerender js t (EventWriterT t w m) where
260+ type Client (EventWriterT t w m) = EventWriterT t w (Client m)
261+ prerender server client = do
262+ x <- lift $ prerender (runEventWriterT server) (runEventWriterT client)
263+ let (a, w') = splitDynPure x
264+ w = switch $ current w'
265+ tellEvent w
266+ pure a
62
267
63−instance js ~ NoJavaScript => Prerender js (StaticDomBuilderT t m) where
268+instance (Prerender js t m, MonadFix m, Reflex t) => Prerender js t (RequesterT t request response m) where
64− prerenderClientDict = Nothing
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
65
279
66−instance (Prerender js m, ReflexHost t) => Prerender js (PostBuildT t m) where
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
67− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
281+ type Client (QueryT t q m) = QueryT t q (Client m)
282+ prerender server client = mdo
283+ result <- queryDyn query
284+ x <- lift $ prerender (runQueryT server result) (runQueryT client result)
285+ let (a, inc) = splitDynPure x
286+ query = incrementalToDynamic =<< inc -- Can we avoid the incrementalToDynamic?
287+ pure a
68
288
69−instance Prerender js m => Prerender js (DynamicWriterT t w m) where
289+instance (Prerender js t m, Monad m) => Prerender js t (InputDisabledT m) where
70− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
290+ type Client (InputDisabledT m) = InputDisabledT (Client m)
291+ prerender (InputDisabledT server) (InputDisabledT client) = InputDisabledT $ prerender server client
71
292
72−instance Prerender js m => Prerender js (ReaderT w m) where
293+instance (Prerender js t m, Monad m) => Prerender js t (HydratableT m) where
73− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
294+ type Client (HydratableT m) = HydratableT (Client m)
295+ prerender (HydratableT server) (HydratableT client) = HydratableT $ prerender server client
74
296
75−instance Prerender js m => Prerender js (RequesterT t request response m) where
297+instance (Prerender js t m, Monad m, ReflexHost t) => Prerender js t (PostBuildT t m) where
76− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
298+ type Client (PostBuildT t m) = PostBuildT t (Client m)
299+ prerender server client = PostBuildT $ do
300+ pb <- ask
301+ lift $ prerender (runPostBuildT server pb) (runPostBuildT client pb)
77
302
78−instance Prerender js m => Prerender js (QueryT t q m) where
303+startMarker, endMarker :: Text
79− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
304+startMarker = "prerender/start"
305+endMarker = "prerender/end"
80
306
81−instance Prerender js m => Prerender js (InputDisabledT m) where
307+deleteToPrerenderEnd :: (MonadIO m, MonadJSM m, Reflex t, MonadFix m) => DOM.Document -> HydrationRunnerT t m DOM.Comment
82− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
308+deleteToPrerenderEnd doc = do
309+ startNode <- hydrateComment doc startMarker Nothing
310+ let go (n :: Int) lastNode = Node.getNextSibling lastNode >>= \case
311+ Nothing -> do
312+ c <- Document.createComment doc endMarker
313+ insertAfterPreviousNode c
314+ pure c
315+ Just node -> DOM.castTo DOM.Comment node >>= \case
316+ Nothing -> go n node
317+ Just c -> Node.getTextContentUnchecked c >>= \case
318+ t | t == startMarker -> go (succ n) node
319+ | t == endMarker -> case n of
320+ 0 -> pure c
321+ _ -> go (pred n) node
322+ | otherwise -> go n node
323+ endNode <- go 0 $ DOM.toNode startNode
324+ deleteBetweenExclusive startNode endNode
325+ setPreviousNode $ Just $ DOM.toNode endNode
326+ pure endNode
reflex-dom-core/src/Reflex/Dom/Specializations.hsdeleted−62
@@ -1,62 +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−import Data.FastMutableIntMap
24−
25−import qualified GHCJS.DOM.Element as DOM
26−import qualified GHCJS.DOM.Types as DOM
27−
28−{-# 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) #-}
29−
30−{-# SPECIALIZE wrap :: forall er. RawElement GhcjsDomSpace -> RawElementConfig er (SpiderTimeline Global) GhcjsDomSpace -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) (Element er GhcjsDomSpace (SpiderTimeline Global)) #-}
31−
32−{-# SPECIALIZE mapIntMapWithAdjustImpl :: forall v v'.
33− ( (IntMap.Key -> (Event (SpiderTimeline Global) (), v) -> (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) v')
34− -> IntMap (Event (SpiderTimeline Global) (), v)
35− -> Event (SpiderTimeline Global) (PatchIntMap (Event (SpiderTimeline Global) (), v))
36− -> (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (IntMap v', Event (SpiderTimeline Global) (PatchIntMap v'))
37− )
38− -> (IntMap.Key -> v -> PostBuildT (SpiderTimeline Global) (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) v')
39− -> IntMap v
40− -> Event (SpiderTimeline Global) (PatchIntMap v)
41− -> PostBuildT (SpiderTimeline Global) (ImmediateDomBuilderT Spider (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (IntMap v', Event (SpiderTimeline Global) (PatchIntMap v'))
42− #-}
43−
44−{-# SPECIALIZE append :: DOM.Node -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) () #-}
45−
46−{-# 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) #-}
47−
48−{-# 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')) #-}
49−
50−{-# SPECIALIZE hoistTraverseIntMapWithKeyWithAdjust :: forall v v'.
51− ( (IntMap.Key -> v -> RequesterT (SpiderTimeline Global) JSM Identity (TriggerEventT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global)))) (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v'))
52− -> IntMap v
53− -> Event (SpiderTimeline Global) (PatchIntMap v)
54− -> 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')))
55− )
56− -> (PatchIntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> IntMap (IORef ChildReadyStateInt) -> IO (IntMap (IORef ChildReadyStateInt)))
57− -> (IORef (IntMap DOM.Text) -> IORef DOM.Text -> PatchIntMap (DOM.DocumentFragment, DOM.Text, IORef ChildReadyStateInt, v') -> JSM ())
58− -> (IntMap.Key -> v -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) v')
59− -> IntMap v
60− -> Event (SpiderTimeline Global) (PatchIntMap v)
61− -> ImmediateDomBuilderT (SpiderTimeline Global) (WithJSContextSingleton () (PerformEventT Spider (SpiderHost Global))) (IntMap v', Event (SpiderTimeline Global) (PatchIntMap v'))
62− #-}
reflex-dom-core/src/Reflex/Dom/WebSocket.hs+24−10
@@ -46,6 +46,7 @@ import Control.Monad.IO.Class
46import Control.Monad.State
46import Control.Monad.State
47import Data.Aeson
47import Data.Aeson
48import Data.ByteString (ByteString)
48import Data.ByteString (ByteString)
49+import Data.ByteString.Lazy (toStrict)
49import Data.Default
50import Data.Default
50import Data.IORef
51import Data.IORef
51import Data.JSString.Text
52import Data.JSString.Text
@@ -54,6 +55,7 @@ import Data.Text
54import Data.Text.Encoding
55import Data.Text.Encoding
55import Foreign.JavaScript.Utils (jsonDecode)
56import Foreign.JavaScript.Utils (jsonDecode)
56import GHCJS.DOM.Types (runJSM, askJSM, MonadJSM, liftJSM, JSM)
57import GHCJS.DOM.Types (runJSM, askJSM, MonadJSM, liftJSM, JSM)
58+import GHCJS.DOM.WebSocket (getReadyState)
57import GHCJS.Marshal
59import GHCJS.Marshal
58import qualified Language.Javascript.JSaddle.Monad as JS (catch)
60import qualified Language.Javascript.JSaddle.Monad as JS (catch)
59
61
@@ -61,10 +63,11 @@ data WebSocketConfig t a
61 = WebSocketConfig { _webSocketConfig_send :: Event t [a]
63 = WebSocketConfig { _webSocketConfig_send :: Event t [a]
62 , _webSocketConfig_close :: Event t (Word, Text)
64 , _webSocketConfig_close :: Event t (Word, Text)
63 , _webSocketConfig_reconnect :: Bool
65 , _webSocketConfig_reconnect :: Bool
66+ , _webSocketConfig_protocols :: [Text]
64 }
67 }
65
68
66instance Reflex t => Default (WebSocketConfig t a) where
69instance Reflex t => Default (WebSocketConfig t a) where
67− def = WebSocketConfig never never True
70+ def = WebSocketConfig never never True []
68
71
69type WebSocket t = RawWebSocket t ByteString
72type WebSocket t = RawWebSocket t ByteString
70
73
@@ -99,11 +102,11 @@ webSocket' url config onRawMessage = do
99 liftIO $ triggerEClose args
102 liftIO $ triggerEClose args
100 _ <- liftIO $ atomically $ tryTakeTMVar isOpen
103 _ <- liftIO $ atomically $ tryTakeTMVar isOpen
101 liftIO $ writeIORef currentSocketRef Nothing
104 liftIO $ writeIORef currentSocketRef Nothing
102− when (_webSocketConfig_reconnect config) $ do
105+ when (_webSocketConfig_reconnect config) $ forkJSM $ do
103 liftIO $ threadDelay 1000000
106 liftIO $ threadDelay 1000000
104 start
107 start
105 start = do
108 start = do
106− ws <- newWebSocket wv url (onRawMessage >=> liftIO . onMessage) (liftIO onOpen) (liftIO onError) onClose
109+ ws <- newWebSocket wv url (_webSocketConfig_protocols config) (onRawMessage >=> liftIO . onMessage) (liftIO onOpen) (liftIO onError) onClose
107 liftIO $ writeIORef currentSocketRef $ Just ws
110 liftIO $ writeIORef currentSocketRef $ Just ws
108 return ()
111 return ()
109 performEvent_ . (liftJSM start <$) =<< getPostBuild
112 performEvent_ . (liftJSM start <$) =<< getPostBuild
@@ -125,9 +128,11 @@ webSocket' url config onRawMessage = do
125 mws <- liftIO $ readIORef currentSocketRef
128 mws <- liftIO $ readIORef currentSocketRef
126 success <- case mws of
129 success <- case mws of
127 Nothing -> return False
130 Nothing -> return False
128− Just ws -> runJSM ((webSocketSend ws payload >> return True)
131+ Just ws -> flip runJSM ctx $ do
129− `JS.catch`
132+ rs <- getReadyState $ unWebSocket ws
130− (\(_ :: SomeException) -> return False)) ctx
133+ if rs == 1
134+ then (webSocketSend ws payload >> return True) `JS.catch` (\(_ :: SomeException) -> return False)
135+ else return False
131 unless success $ atomically $ unGetTQueue payloadQueue payload
136 unless success $ atomically $ unGetTQueue payloadQueue payload
132 return $ RawWebSocket eRecv eOpen eError eClose
137 return $ RawWebSocket eRecv eOpen eError eClose
133
138
@@ -136,26 +141,35 @@ textWebSocket url cfg = webSocket' url cfg (either (return . decodeUtf8) fromJSV
136
141
137jsonWebSocket :: (ToJSON a, FromJSON b, MonadJSM m, MonadJSM (Performable m), HasJSContext m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, Reflex t) => Text -> WebSocketConfig t a -> m (RawWebSocket t (Maybe b))
142jsonWebSocket :: (ToJSON a, FromJSON b, MonadJSM m, MonadJSM (Performable m), HasJSContext m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, Reflex t) => Text -> WebSocketConfig t a -> m (RawWebSocket t (Maybe b))
138jsonWebSocket url cfg = do
143jsonWebSocket url cfg = do
139− ws <- textWebSocket url $ cfg { _webSocketConfig_send = fmap encode <$> _webSocketConfig_send cfg }
144+ ws <- textWebSocket url $ cfg { _webSocketConfig_send = fmap (decodeUtf8 . toStrict . encode) <$> _webSocketConfig_send cfg }
140 return ws { _webSocket_recv = jsonDecode . textToJSString <$> _webSocket_recv ws }
145 return ws { _webSocket_recv = jsonDecode . textToJSString <$> _webSocket_recv ws }
141
146
147+forkJSM :: JSM () -> JSM ()
148+forkJSM a = do
149+ jsm <- askJSM
150+ void $ liftIO $ forkIO $ runJSM a jsm
151+
142#ifdef USE_TEMPLATE_HASKELL
152#ifdef USE_TEMPLATE_HASKELL
143makeLensesWith (lensRules & simpleLenses .~ True) ''WebSocketConfig
153makeLensesWith (lensRules & simpleLenses .~ True) ''WebSocketConfig
144makeLensesWith (lensRules & simpleLenses .~ True) ''RawWebSocket
154makeLensesWith (lensRules & simpleLenses .~ True) ''RawWebSocket
145#else
155#else
146
156
147webSocketConfig_send :: Lens' (WebSocketConfig t a) (Event t [a])
157webSocketConfig_send :: Lens' (WebSocketConfig t a) (Event t [a])
148−webSocketConfig_send f (WebSocketConfig x1 x2 x3) = (\y -> WebSocketConfig y x2 x3) <$> f x1
158+webSocketConfig_send f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig y x2 x3 x4) <$> f x1
149{-# INLINE webSocketConfig_send #-}
159{-# INLINE webSocketConfig_send #-}
150
160
151webSocketConfig_close :: Lens' (WebSocketConfig t a) (Event t (Word, Text))
161webSocketConfig_close :: Lens' (WebSocketConfig t a) (Event t (Word, Text))
152−webSocketConfig_close f (WebSocketConfig x1 x2 x3) = (\y -> WebSocketConfig x1 y x3) <$> f x2
162+webSocketConfig_close f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig x1 y x3 x4) <$> f x2
153{-# INLINE webSocketConfig_close #-}
163{-# INLINE webSocketConfig_close #-}
154
164
155webSocketConfig_reconnect :: Lens' (WebSocketConfig t a) Bool
165webSocketConfig_reconnect :: Lens' (WebSocketConfig t a) Bool
156−webSocketConfig_reconnect f (WebSocketConfig x1 x2 x3) = (\y -> WebSocketConfig x1 x2 y) <$> f x3
166+webSocketConfig_reconnect f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig x1 x2 y x4) <$> f x3
157{-# INLINE webSocketConfig_reconnect #-}
167{-# INLINE webSocketConfig_reconnect #-}
158
168
169+webSocketConfig_protocols :: Lens' (WebSocketConfig t a) [Text]
170+webSocketConfig_protocols f (WebSocketConfig x1 x2 x3 x4) = (\y -> WebSocketConfig x1 x2 x3 y) <$> f x4
171+{-# INLINE webSocketConfig_protocols #-}
172+
159webSocket_recv :: Lens' (RawWebSocket t a) (Event t a)
173webSocket_recv :: Lens' (RawWebSocket t a) (Event t a)
160webSocket_recv f (RawWebSocket x1 x2 x3 x4) = (\y -> RawWebSocket y x2 x3 x4) <$> f x1
174webSocket_recv f (RawWebSocket x1 x2 x3 x4) = (\y -> RawWebSocket y x2 x3 x4) <$> f x1
161{-# INLINE webSocket_recv #-}
175{-# INLINE webSocket_recv #-}
reflex-dom-core/src/Reflex/Dom/WebSocket/Foreign.hs+39−24
@@ -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
@@ -57,31 +55,48 @@ closeWebSocket (JSWebSocket ws) code reason = DOM.close ws (Just code) (Just rea
57newWebSocket
55newWebSocket
58 :: a
56 :: a
59 -> Text -- url
57 -> Text -- url
58+ -> [Text] -- protocols
60 -> (Either ByteString JSVal -> JSM ()) -- onmessage
59 -> (Either ByteString JSVal -> JSM ()) -- onmessage
61 -> JSM () -- onopen
60 -> JSM () -- onopen
62 -> JSM () -- onerror
61 -> JSM () -- onerror
63 -> ((Bool, Word, Text) -> JSM ()) -- onclose
62 -> ((Bool, Word, Text) -> JSM ()) -- onclose
64 -> JSM JSWebSocket
63 -> JSM JSWebSocket
65−newWebSocket _ url onMessage onOpen onError onClose = do
64+newWebSocket _ url protocols onMessage onOpen onError onClose = do
66− ws <- DOM.newWebSocket url ([] :: [Text])
65+ let onOpenWrapped = fun $ \_ _ _ -> onOpen
67− DOM.setBinaryType ws "arraybuffer"
66+ onErrorWrapped = fun $ \_ _ _ -> onError
68− _ <- on ws DOM.open $ liftJSM onOpen
67+ onCloseWrapped = fun $ \_ _ (e:_) -> do
69− _ <- on ws DOM.error $ liftJSM onError
68+ let e' = CloseEvent e
70− _ <- on ws DOM.closeEvent $ do
69+ wasClean <- getWasClean e'
71− e <- ask
70+ code <- getCode e'
72− wasClean <- getWasClean e
71+ reason <- getReason e'
73− code <- getCode e
72+ liftJSM $ onClose (wasClean, code, reason)
74− reason <- getReason e
73+ onMessageWrapped = fun $ \_ _ (e:_) -> do
75− liftJSM $ onClose (wasClean, code, reason)
74+ let e' = MessageEvent e
76− _ <- on ws DOM.message $ do
75+ d <- getData e'
77− e <- ask
76+ liftJSM $ ghcjsPure (jsTypeOf d) >>= \case
78− d <- getData e
77+ String -> onMessage $ Right d
79− liftJSM $ ghcjsPure (jsTypeOf d) >>= \case
78+ _ -> do
80− String -> onMessage $ Right d
79+ ab <- mutableArrayBufferFromJSVal d
81− _ -> do
80+ bsFromMutableArrayBuffer ab >>= onMessage . Left
82− ab <- mutableArrayBufferFromJSVal d
81+ newWS <- eval $ unlines
83− bsFromMutableArrayBuffer ab >>= onMessage . Left
82+ [ "(function(url, protos, open, error, close, message) {"
84− return $ JSWebSocket ws
83+ , " var ws = new window['WebSocket'](url, protos);"
84+ , " ws['binaryType'] = 'arraybuffer';"
85+ , " ws['addEventListener']('open', open);"
86+ , " ws['addEventListener']('error', error);"
87+ , " ws['addEventListener']('close', close);"
88+ , " ws['addEventListener']('message', message);"
89+ , " return ws;"
90+ , "})"
91+ ]
92+ url' <- toJSVal url
93+ protocols' <- toJSVal protocols
94+ onOpen' <- toJSVal onOpenWrapped
95+ onError' <- toJSVal onErrorWrapped
96+ onClose' <- toJSVal onCloseWrapped
97+ onMessage' <- toJSVal onMessageWrapped
98+ ws <- call newWS newWS [url', protocols', onOpen', onError', onClose', onMessage']
99+ return $ JSWebSocket $ WebSocket ws
85
100
86onBSMessage :: Either ByteString JSVal -> JSM ByteString
101onBSMessage :: Either ByteString JSVal -> JSM ByteString
87onBSMessage = either return $ fmap encodeUtf8 . fromJSValUnchecked
102onBSMessage = either return $ fmap encodeUtf8 . fromJSValUnchecked
reflex-dom-core/src/Reflex/Dom/Widget/Basic.hs+48−44
@@ -10,12 +10,12 @@
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
17+ , comment
18+ , dynComment
19 , display
19 , display
20 , button
20 , button
21 , dyn
21 , dyn
@@ -57,15 +57,16 @@ module Reflex.Dom.Widget.Basic
57 , module Data.Map.Misc
57 , module Data.Map.Misc
58 , module Reflex.Collection
58 , module Reflex.Collection
59 , module Reflex.Workflow
59 , module Reflex.Workflow
60+ , partitionMapBySetLT
60 ) where
61 ) where
61
62
63+import Reflex.Adjustable.Class
62import Reflex.Class
64import Reflex.Class
63import Reflex.Collection
65import Reflex.Collection
64import Reflex.Dom.Builder.Class
66import Reflex.Dom.Builder.Class
65import Reflex.Dom.Class
67import Reflex.Dom.Class
66import Reflex.Dynamic
68import Reflex.Dynamic
67import Reflex.Network
69import Reflex.Network
68−import Reflex.NotReady.Class
69import Reflex.PostBuild.Class
70import Reflex.PostBuild.Class
70import Reflex.Workflow
71import Reflex.Workflow
71
72
@@ -94,6 +95,7 @@ import Prelude hiding (mapM, mapM_, sequence, sequence_)
94-- No empty pieces will be included in the output.
95-- No empty pieces will be included in the output.
95
96
96--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." #-}
97partitionMapBySetLT :: 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)
98partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
100partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
99 where go :: [k] -> Map k v -> [(Either k (), Map k v)]
101 where go :: [k] -> Map k v -> [(Either k (), Map k v)]
@@ -106,8 +108,7 @@ partitionMapBySetLT s m0 = Map.fromDistinctAscList $ go (Set.toAscList s) m0
106 then go t geq
108 then go t geq
107 else (Left h, lt) : go t geq
109 else (Left h, lt) : go t geq
108
110
109−newtype ChildResult t k a = ChildResult { unChildResult :: (a, Event t (Map k (Maybe (ChildResult t k a)))) }
111+{-# INLINABLE text #-}
110−
111text :: DomBuilder t m => Text -> m ()
112text :: DomBuilder t m => Text -> m ()
112text t = void $ textNode $ def & textNodeConfig_initialContents .~ t
113text t = void $ textNode $ def & textNodeConfig_initialContents .~ t
113
114
@@ -121,6 +122,19 @@ dynText t = do
121 ]
122 ]
122 notReadyUntil postBuild
123 notReadyUntil postBuild
123
124
125+comment :: DomBuilder t m => Text -> m ()
126+comment t = void $ commentNode $ def & commentNodeConfig_initialContents .~ t
127+
128+{-# INLINABLE dynComment #-}
129+dynComment :: forall t m. (PostBuild t m, DomBuilder t m) => Dynamic t Text -> m ()
130+dynComment t = do
131+ postBuild <- getPostBuild
132+ void $ commentNode $ (def :: CommentNodeConfig t) & commentNodeConfig_setContents .~ leftmost
133+ [ updated t
134+ , tag (current t) postBuild
135+ ]
136+ notReadyUntil postBuild
137+
124display :: (PostBuild t m, DomBuilder t m, Show a) => Dynamic t a -> m ()
138display :: (PostBuild t m, DomBuilder t m, Show a) => Dynamic t a -> m ()
125display = dynText . fmap (T.pack . show)
139display = dynText . fmap (T.pack . show)
126
140
@@ -131,63 +145,73 @@ button t = do
131
145
132--TODO: Should this be renamed to 'widgetView' for consistency with 'widgetHold'?
146--TODO: Should this be renamed to 'widgetView' for consistency with 'widgetHold'?
133-- | 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.
134−-- The returned Event of widget results occurs when the Dynamic does.
148+-- The returned Event occurs whenever the child widget is updated, which is
135−-- 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').
149+-- at post-build in addition to the times at which the input Dynamic is
136−dyn :: (DomBuilder t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
150+-- updated, and its value is the result of running the widget.
151+-- Note: Often, the type @a@ is an 'Event', in which case the return value is an Event-of-Events that would typically be flattened (via 'switchHold').
152+dyn :: (Adjustable t m, NotReady t m, PostBuild t m) => Dynamic t (m a) -> m (Event t a)
137dyn = networkView
153dyn = networkView
138
154
139-- | Like 'dyn' but discards result.
155-- | Like 'dyn' but discards result.
140−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 ()
141dyn_ = void . dyn
157dyn_ = void . dyn
142
158
143-- | 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.
144-- The returned Dynamic of widget results occurs when the Event does.
160-- The returned Dynamic of widget results occurs when the Event does.
145−-- 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').
146−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)
147widgetHold = networkHold
163widgetHold = networkHold
148
164
149-- | Like 'widgetHold' but discards result.
165-- | Like 'widgetHold' but discards result.
150−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 ()
151widgetHold_ z = void . widgetHold z
167widgetHold_ z = void . widgetHold z
152
168
153-- | Create a DOM element
169-- | Create a DOM element
154−-- > el "div" (text "Hello World")
170+--
171+-- >>> el "div" (text "Hello World")
155-- <div>Hello World</div>
172-- <div>Hello World</div>
156{-# INLINABLE el #-}
173{-# INLINABLE el #-}
157el :: 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
158el elementTag child = snd <$> el' elementTag child
175el elementTag child = snd <$> el' elementTag child
159
176
160-- | Create a DOM element with attributes
177-- | Create a DOM element with attributes
161−-- > elAttr "a" ("href" =: "http://google.com") (text "Google!")
178+--
162−-- <a href="http://google.com">Google!</a>
179+-- >>> elAttr "a" ("href" =: "https://reflex-frp.org") (text "Reflex-FRP!")
180+-- <a href="https://reflex-frp.org">Reflex-FRP!</a>
163{-# INLINABLE elAttr #-}
181{-# INLINABLE elAttr #-}
164elAttr :: 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
165elAttr elementTag attrs child = snd <$> elAttr' elementTag attrs child
183elAttr elementTag attrs child = snd <$> elAttr' elementTag attrs child
166
184
167-- | Create a DOM element with classes
185-- | Create a DOM element with classes
168−-- > elClass "div" "row" (return ())
186+--
187+-- >>> elClass "div" "row" (return ())
169-- <div class="row"></div>
188-- <div class="row"></div>
170{-# INLINABLE elClass #-}
189{-# INLINABLE elClass #-}
171elClass :: 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
172elClass elementTag c child = snd <$> elClass' elementTag c child
191elClass elementTag c child = snd <$> elClass' elementTag c child
173
192
174-- | Create a DOM element with Dynamic Attributes
193-- | Create a DOM element with Dynamic Attributes
175−-- > elClass "div" (constDyn ("class" =: "row")) (return ())
194+--
195+-- >>> elClass "div" (constDyn ("class" =: "row")) (return ())
176-- <div class="row"></div>
196-- <div class="row"></div>
177{-# INLINABLE elDynAttr #-}
197{-# INLINABLE elDynAttr #-}
178elDynAttr :: 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
179elDynAttr elementTag attrs child = snd <$> elDynAttr' elementTag attrs child
199elDynAttr elementTag attrs child = snd <$> elDynAttr' elementTag attrs child
180
200
181-- | Create a DOM element with a Dynamic Class
201-- | Create a DOM element with a Dynamic Class
182−-- > elDynClass "div" (constDyn "row") (return ())
202+--
203+-- >>> elDynClass "div" (constDyn "row") (return ())
183-- <div class="row"></div>
204-- <div class="row"></div>
184{-# INLINABLE elDynClass #-}
205{-# INLINABLE elDynClass #-}
185elDynClass :: 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
186elDynClass elementTag c child = snd <$> elDynClass' elementTag c child
207elDynClass elementTag c child = snd <$> elDynClass' elementTag c child
187
208
188-- | Create a DOM element and return the element
209-- | Create a DOM element and return the element
189−-- > do (e, _) <- el' "div" (text "Click")
210+--
190−-- > return $ domEvent Click e
211+-- @
212+-- do (e, _) <- el' "div" (text "Click")
213+-- return $ domEvent Click e
214+-- @
191{-# INLINABLE el' #-}
215{-# INLINABLE el' #-}
192el' :: 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)
193el' elementTag = element elementTag def
217el' elementTag = element elementTag def
@@ -247,28 +271,6 @@ dynamicAttributesToModifyAttributesWithInitial attrs0 d = do
247 return $ if Map.null p then Nothing else Just p
271 return $ if Map.null p then Nothing else Just p
248 return modificationsNeeded
272 return modificationsNeeded
249
273
250−--------------------------------------------------------------------------------
251−-- Copied and pasted from Reflex.Widget.Class
252−--------------------------------------------------------------------------------
253−
254−{-
255−schedulePostBuild x = performEvent_ . (x <$) =<< getPostBuild
256−
257−elDynHtml' :: DomBuilder t m => Text -> Dynamic t Text -> m (El t)
258−elDynHtml' elementTag html = do
259− e <- buildEmptyElement elementTag (Map.empty :: Map Text Text)
260− schedulePostBuild $ setInnerHTML e . Just =<< sample (current html)
261− performEvent_ $ fmap (setInnerHTML e . Just) $ updated html
262− wrapElement defaultDomEventHandler e
263−
264−elDynHtmlAttr' :: DomBuilder t m => Text -> Map Text Text -> Dynamic t Text -> m (El t)
265−elDynHtmlAttr' elementTag attrs html = do
266− e <- buildEmptyElement elementTag attrs
267− schedulePostBuild $ setInnerHTML e . Just =<< sample (current html)
268− performEvent_ $ fmap (setInnerHTML e . Just) $ updated html
269− wrapElement defaultDomEventHandler e
270−-}
271−
272newtype Link t
274newtype Link t
273 = Link { _link_clicked :: Event t ()
275 = Link { _link_clicked :: Event t ()
274 }
276 }
@@ -292,6 +294,7 @@ dtdd h w = do
292blank :: forall m. Monad m => m ()
294blank :: forall m. Monad m => m ()
293blank = return ()
295blank = return ()
294
296
297+-- TODO: Move to an example project.
295-- | 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.
296tableDynAttr :: 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)
297 => Text -- ^ Class applied to <table> element
300 => Text -- ^ Class applied to <table> element
@@ -308,6 +311,7 @@ tableDynAttr klass cols dRows rowAttrs = elAttr "div" (Map.singleton "style" "zo
308 dAttrs <- rowAttrs k
311 dAttrs <- rowAttrs k
309 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)
310
313
314+-- TODO: Move to an example project.
311-- | 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.
312-- 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
313-- 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+4−4
@@ -64,7 +64,7 @@ virtualListWithSelection heightPx rowPx maxIndex i0 setI listTag listAttrs rowTa
64 let indexAndLength = fmap snd window
64 let indexAndLength = fmap snd window
65 return (indexAndLength, sel)
65 return (indexAndLength, sel)
66 where
66 where
67− toStyleAttr m = "style" =: Map.foldWithKey (\k v s -> k <> ":" <> v <> ";" <> s) "" m
67+ toStyleAttr m = "style" =: Map.foldrWithKey (\k v s -> k <> ":" <> v <> ";" <> s) "" m
68 toViewport h = toStyleAttr $ "overflow" =: "auto" <> "position" =: "absolute" <>
68 toViewport h = toStyleAttr $ "overflow" =: "auto" <> "position" =: "absolute" <>
69 "left" =: "0" <> "right" =: "0" <> "height" =: (T.pack (show h) <> "px")
69 "left" =: "0" <> "right" =: "0" <> "height" =: (T.pack (show h) <> "px")
70 toContainer h = toStyleAttr $ "position" =: "relative" <> "height" =: (T.pack (show h) <> "px")
70 toContainer h = toStyleAttr $ "position" =: "relative" <> "height" =: (T.pack (show h) <> "px")
@@ -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−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)
36+--
37+-- This function can cause strange scrollbars to appear in some circumstances.
38+-- These can be hidden with pseudo selectors, for example, in webkit browsers:
39+-- .wrapper *::-webkit-scrollbar { width: 0px; background: transparent; }
40+resizeDetector :: (MonadJSM m, DomBuilder t m, PostBuild t m, TriggerEvent t m, PerformEvent t m, MonadHold t m, DomBuilderSpace m ~ GhcjsDomSpace, MonadJSM (Performable m), MonadFix m) => m a -> m (Event t (Maybe Double, Maybe Double), a)
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+10−8
@@ -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
@@ -378,7 +380,7 @@ decodeText = decode . BL.fromStrict . encodeUtf8
378
380
379-- | Convenience function to decode JSON-encoded responses.
381-- | Convenience function to decode JSON-encoded responses.
380decodeXhrResponse :: FromJSON a => XhrResponse -> Maybe a
382decodeXhrResponse :: FromJSON a => XhrResponse -> Maybe a
381−decodeXhrResponse = join . fmap decodeText . _xhrResponse_responseText
383+decodeXhrResponse = decodeText <=< _xhrResponse_responseText
382
384
383#ifdef USE_TEMPLATE_HASKELL
385#ifdef USE_TEMPLATE_HASKELL
384concat <$> mapM makeLenses
386concat <$> mapM makeLenses
@@ -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
50+ handle (\(_ :: IOError) -> return ()) $ unshareNetwork -- If we run into an exception with sandboxing, just don't bother
42− handle (\(_ :: IOError) -> return ()) $ do -- If we run into an exception with sandboxing, just don't bother
51+ withSandboxedChromeFlags True $ \chromeFlags -> do
43− unshare [User, Network]
52+ mainThread <- myThreadId
44− writeUserMappings Nothing [UserMapping 0 uid 1]
53+ browserProcess <- spawnCommand $ mconcat
45− callCommand "ip link set lo up ; ip addr"
54+ [ "echo 'Starting Chromium' ; chromium "
46− mainThread <- myThreadId
55+ , unpack $ T.unwords chromeFlags
47− withSystemTempDirectory "reflex-dom-core_test_gc" $ \tmp -> do
56+ , " http://localhost:3911 ; echo 'Chromium exited'"
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'"
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.hsnew file+1828
@@ -0,0 +1,1828 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE ConstraintKinds #-}
3+{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE LambdaCase #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
9+{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE PolyKinds #-}
11+{-# LANGUAGE RankNTypes #-}
12+{-# LANGUAGE RecursiveDo #-}
13+{-# LANGUAGE ScopedTypeVariables #-}
14+{-# LANGUAGE StandaloneDeriving #-}
15+{-# LANGUAGE TemplateHaskell #-}
16+{-# LANGUAGE TupleSections #-}
17+{-# LANGUAGE TypeApplications #-}
18+{-# LANGUAGE TypeFamilies #-}
19+{-# LANGUAGE UndecidableInstances #-}
20+
21+{-# OPTIONS_GHC -fno-warn-orphans #-}
22+
23+-- Notice to those working on this test suite:
24+-- It doesn't appear to be possible to use --match to run a particular test, in
25+-- this situation the test may hang before reaching our code. This seems to
26+-- happen when the test is not the first test in the block. As a workaround, you
27+-- can just comment out the other tests. Also, using `xit` will cause the same
28+-- issue. `xit` tests must be the last tests in the session, or the session will
29+-- hang in the following test.
30+
31+import Prelude hiding (fail)
32+import Control.Concurrent
33+import qualified Control.Concurrent.Async as Async
34+import Control.Lens.Operators
35+import Control.Monad hiding (fail)
36+import Control.Monad.Catch
37+import Control.Monad.Fail
38+import Control.Monad.Fix
39+import Control.Monad.IO.Class
40+import Control.Monad.Ref
41+import Data.Constraint.Extras
42+import Data.Constraint.Extras.TH
43+import Data.Dependent.Map (DMap)
44+import Data.Dependent.Sum (DSum(..), (==>))
45+import Data.Functor.Identity
46+import Data.Functor.Misc
47+import Data.GADT.Compare.TH
48+import Data.GADT.Show.TH
49+import Data.IORef (IORef)
50+import Data.List (sort)
51+import Data.Maybe
52+import Data.Proxy
53+import Data.Text (Text)
54+import Language.Javascript.JSaddle (syncPoint, liftJSM)
55+import Language.Javascript.JSaddle.Warp
56+import Network.HTTP.Types (status200)
57+import Network.Socket
58+import Network.Wai
59+import Network.WebSockets
60+import Reflex.Dom.Core
61+import Reflex.Dom.Widget.Input (dropdown)
62+import Reflex.Patch.DMapWithMove
63+import System.Directory
64+import System.Environment
65+import System.IO (stderr)
66+import System.IO.Silently
67+import System.IO.Temp
68+import System.Process
69+import System.Which (staticWhich)
70+import qualified Test.HUnit as HUnit
71+import qualified Test.Hspec as H
72+import qualified Test.Hspec.Core.Spec as H
73+import Test.Hspec (xit)
74+import Test.Hspec.WebDriver hiding (runWD, click, uploadFile, WD)
75+import qualified Test.Hspec.WebDriver as WD
76+import Test.WebDriver (WD(..))
77+
78+import qualified Data.ByteString.Lazy as LBS
79+import qualified Data.Dependent.Map as DMap
80+import qualified Data.IntMap as IntMap
81+import qualified Data.Text as T
82+import qualified Data.Text.Encoding as TE
83+import qualified GHCJS.DOM.File as File
84+import qualified Network.Wai.Handler.Warp as Warp
85+import qualified System.FilePath as FilePath
86+import qualified Test.WebDriver as WD
87+import qualified Test.WebDriver.Capabilities as WD
88+
89+import Test.Util.ChromeFlags
90+import Test.Util.UnshareNetwork
91+
92+-- ORPHAN: https://github.com/kallisti-dev/hs-webdriver/pull/167
93+deriving instance MonadMask WD
94+
95+chromium :: FilePath
96+chromium = $(staticWhich "chromium")
97+
98+seleniumPort, jsaddlePort :: PortNumber
99+seleniumPort = 8000
100+jsaddlePort = 8001
101+
102+-- TODO Remove orphan
103+instance MonadRef WD where
104+ type Ref WD = Ref IO
105+ newRef = WD . newRef
106+ readRef = WD . readRef
107+ writeRef r = WD . writeRef r
108+
109+assertEqual :: (MonadIO m, Eq a, Show a) => String -> a -> a -> m ()
110+assertEqual msg a b = liftIO $ HUnit.assertEqual msg a b
111+
112+assertFailure :: MonadIO m => String -> m ()
113+assertFailure = liftIO . HUnit.assertFailure
114+
115+assertBool :: (MonadIO m) => String -> Bool -> m ()
116+assertBool msg bool = liftIO $ HUnit.assertBool msg bool
117+
118+chromeConfig :: Text -> [Text] -> WD.WDConfig
119+chromeConfig fp flags = WD.useBrowser (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags }) WD.defaultConfig
120+
121+keyMap :: DMap DKey Identity
122+keyMap = DMap.fromList
123+ [ Key_Int ==> 0
124+ , Key_Char ==> 'A'
125+ ]
126+
127+data DKey a where
128+ Key_Int :: DKey Int
129+ Key_Char :: DKey Char
130+ Key_Bool :: DKey Bool
131+
132+
133+textKey :: DKey a -> Text
134+textKey = \case
135+ Key_Int -> "Key_Int"
136+ Key_Char -> "Key_Char"
137+ Key_Bool -> "Key_Bool"
138+
139+deriveArgDict ''DKey
140+deriveGEq ''DKey
141+deriveGCompare ''DKey
142+deriveGShow ''DKey
143+
144+deriving instance MonadFail WD
145+
146+main :: IO ()
147+main = do
148+ unshareNetwork
149+ isHeadless <- (== Nothing) <$> lookupEnv "NO_HEADLESS"
150+ withSandboxedChromeFlags isHeadless $ \chromeFlags -> do
151+ withSeleniumServer $ \selenium -> do
152+ let browserPath = T.strip $ T.pack chromium
153+ when (T.null browserPath) $ fail "No browser found"
154+ withDebugging <- isNothing <$> lookupEnv "NO_DEBUG"
155+ let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _selenium_portNumber selenium }
156+ chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
157+ hspec (tests withDebugging wdConfig [(chromeCaps', "chrome")] selenium) `finally` _selenium_stopServer selenium
158+
159+tests :: Bool -> WD.WDConfig -> [(Capabilities, String)] -> Selenium -> Spec
160+tests withDebugging wdConfig caps _selenium = do
161+ let putStrLnDebug :: MonadIO m => Text -> m ()
162+ putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
163+ session' t = sessionWith wdConfig t . using caps
164+ runWD m = runWDOptions (WdOptions False) $ do
165+ putStrLnDebug "before"
166+ r <- m
167+ putStrLnDebug "after"
168+ return r
169+ testWidgetStatic :: WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
170+ testWidgetStatic = testWidgetStaticDebug withDebugging
171+ testWidget :: WD () -> WD b -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
172+ testWidget = testWidgetDebug True withDebugging
173+ testWidget' :: WD a -> (a -> WD b) -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ()) -> WD b
174+ testWidget' = testWidgetDebug' True withDebugging
175+ session' "text" $ do
176+ it "works" $ runWD $ do
177+ testWidgetStatic (checkBodyText "hello world") $ do
178+ text "hello world"
179+ it "works with postBuild" $ runWD $ do
180+ testWidgetStatic (checkBodyText "pb") $ do
181+ pb <- getPostBuild
182+ void $ textNode $ TextNodeConfig "" $ Just $ "pb" <$ pb
183+ it "works for adjacent text nodes" $ runWD $ do
184+ testWidgetStatic (checkBodyText "hello world") $ do
185+ text "hello "
186+ text "world"
187+ it "works for empty adjacent text nodes" $ runWD $ do
188+ testWidgetStatic (checkBodyText "hello world") $ do
189+ pb <- getPostBuild
190+ text ""
191+ text ""
192+ _ <- textNode $ TextNodeConfig "" $ Just $ "hello " <$ pb
193+ _ <- textNode $ TextNodeConfig "abc" $ Just $ "" <$ pb
194+ _ <- textNode $ TextNodeConfig "" $ Just $ "world" <$ pb
195+ text ""
196+ it "works when empty text nodes are the only children of an element" $ runWD $ do
197+ testWidgetStatic (checkBodyText "hello world") $ do
198+ el "div" $ do
199+ text ""
200+ text ""
201+ text "hello world"
202+ it "works when an empty text node is the first child before text" $ runWD $ do
203+ testWidgetStatic (checkTextInTag "div" "hello world") $ do
204+ el "div" $ do
205+ text ""
206+ text "hello world"
207+ it "works when an empty text node is the first child before element" $ runWD $ do
208+ testWidgetStatic (checkTextInTag "div" "hello world") $ do
209+ el "div" $ do
210+ text ""
211+ el "span" $ text "hello world"
212+ it "works when an empty text node is the last child" $ runWD $ do
213+ testWidgetStatic (checkTextInTag "div" "hello world") $ do
214+ el "div" $ do
215+ el "span" $ text "hello world"
216+ text ""
217+-- TODO I think these two tests are broken
218+-- it "updates after postBuild" $ runWD $ do
219+-- testWidget (checkBodyText "initial") (checkBodyText "after") $ do
220+-- after <- delay 0 =<< getPostBuild
221+-- void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ after
222+-- it "updates immediately after postBuild" $ runWD $ do
223+-- testWidget (checkBodyText "pb") (checkBodyText "after") $ do
224+-- pb <- getPostBuild
225+-- after <- delay 0 pb
226+-- void $ textNode $ TextNodeConfig "initial" $ Just $ leftmost ["pb" <$ pb, "after" <$ after]
227+ it "updates in immediate mode" $ runWD $ do
228+ let checkUpdated = do
229+ checkBodyText "initial"
230+ WD.click =<< findElemWithRetry (WD.ByTag "button")
231+ checkBodyText "after"
232+ testWidget (pure ()) checkUpdated $ prerender_ (pure ()) $ do
233+ click <- button ""
234+ void $ textNode $ TextNodeConfig "initial" $ Just $ "after" <$ click
235+
236+ session' "element" $ do
237+ it "works with domEvent Click" $ runWD $ do
238+ clickedRef <- liftIO $ newRef False
239+ testWidget' (findElemWithRetry $ WD.ByTag "div") WD.click $ do
240+ (e, _) <- el' "div" $ text "hello world"
241+ performEvent_ $ liftIO (writeRef clickedRef True) <$ domEvent Click e
242+ readRef clickedRef `shouldBeWithRetryM` True
243+ it "works with eventFlags stopPropagation" $ runWD $ do
244+ firstClickedRef <- newRef False
245+ secondClickedRef <- newRef False
246+ let clickBoth = do
247+ findElemWithRetry (WD.ById "first") >>= WD.click
248+ findElemWithRetry (WD.ById "second") >>= WD.click
249+ testWidget (pure ()) clickBoth $ do
250+ (firstDivEl, _) <- el' "div" $ prerender_ (pure ()) $ do
251+ void $ elAttr "span" ("id" =: "first") $ text "hello world"
252+ performEvent_ $ liftIO (writeRef firstClickedRef True) <$ domEvent Click firstDivEl
253+ (secondDivEl, _) <- el' "div" $ prerender_ (pure ()) $ do
254+ let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
255+ conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
256+ & initialAttributes .~ "id" =: "second"
257+ & elementConfig_eventSpec .~ addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> stopPropagation) def
258+ void $ element "span" conf $ text "hello world"
259+ performEvent_ $ liftIO (writeRef secondClickedRef True) <$ domEvent Click secondDivEl
260+ firstClicked <- readRef firstClickedRef
261+ secondClicked <- readRef secondClickedRef
262+ assertEqual "Click propagated when it should have stopped" (True, False) (firstClicked, secondClicked)
263+ it "works with eventFlags preventDefault" $ runWD $ do
264+ let click = do
265+ e <- findElemWithRetry $ WD.ByTag "input"
266+ s0 <- WD.isSelected e
267+ WD.click e
268+ s1 <- WD.isSelected e
269+ pure (s0, s1)
270+ clicked <- testWidget (pure ()) click $ prerender_ (pure ()) $ do
271+ let conf :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace
272+ conf = (def :: ElementConfig EventResult (SpiderTimeline Global) GhcjsDomSpace)
273+ & elementConfig_eventSpec .~ addEventSpecFlags (Proxy :: Proxy GhcjsDomSpace) Click (\_ -> preventDefault) def
274+ & initialAttributes .~ "type" =: "checkbox"
275+ void $ element "input" conf $ text "hello world"
276+ assertEqual "Click not prevented" (False, False) clicked
277+ it "can add/update/remove attributes" $ runWD $ do
278+ let checkInitialAttrs = do
279+ e <- findElemWithRetry $ WD.ByTag "div"
280+ assertAttr e "const" (Just "const")
281+ assertAttr e "delete" (Just "delete")
282+ assertAttr e "init" (Just "init")
283+ assertAttr e "click" Nothing
284+ pure e
285+ checkModifyAttrs e = do
286+ WD.click e
287+ withRetry $ do
288+ assertAttr e "const" (Just "const")
289+ assertAttr e "delete" Nothing
290+ assertAttr e "init" (Just "click")
291+ assertAttr e "click" (Just "click")
292+ testWidget' checkInitialAttrs checkModifyAttrs $ mdo
293+ let conf = def
294+ & initialAttributes .~ "const" =: "const" <> "delete" =: "delete" <> "init" =: "init"
295+ & modifyAttributes .~ (("delete" =: Nothing <> "init" =: Just "click" <> "click" =: Just "click") <$ click)
296+ (e, ()) <- element "div" conf $ text "hello world"
297+ let click = domEvent Click e
298+ return ()
299+
300+ session' "inputElement" $ do
301+ describe "static renderer" $ do
302+ it "sets value attribute" $ runWD $ do
303+ let checkStatic = do
304+ e <- findElemWithRetry $ WD.ByTag "input"
305+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
306+ pure e
307+ checkHydrated e = do
308+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
309+ testWidget' checkStatic checkHydrated $ void $ inputElement $ def
310+ & inputElementConfig_initialValue .~ "test"
311+ it "updates value attribute at postBuild" $ runWD $ do
312+ let checkStatic = do
313+ e <- findElemWithRetry $ WD.ByTag "input"
314+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
315+ pure e
316+ checkHydrated e = do
317+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
318+ testWidget' checkStatic checkHydrated $ do
319+ pb <- getPostBuild
320+ _ <- inputElement $ def
321+ & inputElementConfig_initialValue .~ "test"
322+ & inputElementConfig_setValue .~ ("test-updated" <$ pb)
323+ pure ()
324+ it "sets checked attr appropriately" $ runWD $ do
325+ setCheckedChan <- liftIO newChan
326+ let checkStatic = do
327+ e <- findElemWithRetry $ WD.ByTag "input"
328+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
329+ pure e
330+ checkValue e = do
331+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
332+ WD.moveToCenter e
333+ WD.click e -- Click to uncheck
334+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
335+ liftIO $ writeChan setCheckedChan True -- Programatically check the checkbox
336+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
337+ testWidget' checkStatic checkValue $ do
338+ setChecked <- triggerEventWithChan setCheckedChan
339+ _ <- inputElement $ def
340+ & initialAttributes .~ "type" =: "checkbox"
341+ & inputElementConfig_initialChecked .~ True
342+ & inputElementConfig_setChecked .~ setChecked
343+ pure ()
344+ it "sets checked attr appropriately at postbuild" $ runWD $ do
345+ let checkStatic = do
346+ e <- findElemWithRetry $ WD.ByTag "input"
347+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
348+ pure e
349+ checkValue e = do
350+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
351+ testWidget' checkStatic checkValue $ do
352+ pb <- getPostBuild
353+ _ <- inputElement $ def
354+ & initialAttributes .~ "type" =: "checkbox"
355+ & inputElementConfig_initialChecked .~ False
356+ & inputElementConfig_setChecked .~ (True <$ pb)
357+ pure ()
358+ describe "hydration" $ do
359+ it "doesn't wipe user input when switching over" $ runWD $ do
360+ inputRef <- newRef ("hello " :: Text)
361+ testWidget'
362+ (do
363+ e <- findElemWithRetry $ WD.ByTag "input"
364+ WD.sendKeys "world" e
365+ pure e)
366+ (\e -> do
367+ WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
368+ WD.click =<< findElemWithRetry (WD.ByTag "button")
369+ readRef inputRef `shouldBeWithRetryM` "hello world"
370+ ) $ do
371+ e <- inputElement $ def & inputElementConfig_initialValue .~ "hello "
372+ click <- button "save"
373+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
374+ it "captures user input after switchover" $ runWD $ do
375+ inputRef <- newRef ("" :: Text)
376+ let checkValue = do
377+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
378+ WD.click =<< findElemWithRetry (WD.ByTag "button")
379+ readRef inputRef `shouldBeWithRetryM` "hello world"
380+ testWidget (pure ()) checkValue $ do
381+ e <- inputElement def
382+ click <- button "save"
383+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
384+ it "sets focus appropriately" $ runWD $ do
385+ focusRef <- newRef False
386+ let checkValue = do
387+ readRef focusRef `shouldBeWithRetryM` False
388+ e <- findElemWithRetry $ WD.ByTag "input"
389+ WD.click e
390+ readRef focusRef `shouldBeWithRetryM` True
391+ testWidget (pure ()) checkValue $ do
392+ e <- inputElement def
393+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
394+ it "sets focus when focus occurs before hydration" $ runWD $ do
395+ focusRef <- newRef False
396+ let setup = do
397+ e <- findElemWithRetry $ WD.ByTag "input"
398+ WD.click e
399+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
400+ readRef focusRef `shouldBeWithRetryM` False
401+ check = readRef focusRef `shouldBeWithRetryM` True
402+ testWidget setup check $ do
403+ e <- inputElement def
404+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
405+ it "sets value appropriately" $ runWD $ do
406+ valueByUIRef <- newRef ("" :: Text)
407+ valueRef <- newRef ("" :: Text)
408+ setValueChan :: Chan Text <- liftIO newChan
409+ let checkValue = do
410+ readRef valueByUIRef `shouldBeWithRetryM` ""
411+ readRef valueRef `shouldBeWithRetryM` ""
412+ e <- findElemWithRetry $ WD.ByTag "input"
413+ WD.sendKeys "hello" e
414+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
415+ readRef valueRef `shouldBeWithRetryM` "hello"
416+ liftIO $ writeChan setValueChan "world"
417+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
418+ readRef valueRef `shouldBeWithRetryM` "world"
419+ testWidget (pure ()) checkValue $ do
420+ update <- triggerEventWithChan setValueChan
421+ e <- inputElement $ def & inputElementConfig_setValue .~ update
422+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _inputElement_input e
423+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
424+ it "sets checked appropriately" $ runWD $ do
425+ checkedByUIRef <- newRef False
426+ checkedRef <- newRef False
427+ setCheckedChan <- liftIO newChan
428+ let checkStatic = do
429+ e <- findElemWithRetry $ WD.ByTag "input"
430+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
431+ pure e
432+ checkValue e = do
433+ readRef checkedByUIRef `shouldBeWithRetryM` False
434+ readRef checkedRef `shouldBeWithRetryM` False
435+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
436+ WD.moveToCenter e
437+ WD.click e
438+ readRef checkedByUIRef `shouldBeWithRetryM` True
439+ readRef checkedRef `shouldBeWithRetryM` True
440+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
441+ liftIO $ writeChan setCheckedChan False
442+ readRef checkedByUIRef `shouldBeWithRetryM` True
443+ readRef checkedRef `shouldBeWithRetryM` False
444+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
445+ testWidget' checkStatic checkValue $ do
446+ setChecked <- triggerEventWithChan setCheckedChan
447+ e <- inputElement $ def
448+ & initialAttributes .~ "type" =: "checkbox"
449+ & inputElementConfig_setChecked .~ setChecked
450+ performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
451+ performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
452+ it "respects user updates to checked which happen before hydration" $ runWD $ do
453+ checkedByUIRef <- newRef False
454+ checkedRef <- newRef False
455+ let checkStatic = do
456+ e <- findElemWithRetry $ WD.ByTag "input"
457+ WD.attr e "checked" `shouldBeWithRetryM` Nothing
458+ WD.moveToCenter e
459+ WD.click e
460+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
461+ pure e
462+ checkValue e = do
463+ WD.attr e "checked" `shouldBeWithRetryM` Just "true"
464+ readRef checkedByUIRef `shouldBeWithRetryM` True
465+ readRef checkedRef `shouldBeWithRetryM` True
466+ testWidget' checkStatic checkValue $ do
467+ e <- inputElement $ def
468+ & initialAttributes .~ "type" =: "checkbox"
469+ performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
470+ performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
471+ it "captures file uploads" $ runWD $ do
472+ filesRef :: IORef [Text] <- newRef []
473+ let uploadFile = do
474+ e <- findElemWithRetry $ WD.ByTag "input"
475+ path <- liftIO $ writeSystemTempFile "testFile" "file contents"
476+ WD.sendKeys (T.pack path) e
477+ WD.click =<< findElemWithRetry (WD.ByTag "button")
478+ liftIO $ removeFile path
479+ readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
480+ testWidget (pure ()) uploadFile $ do
481+ e <- inputElement $ def & initialAttributes .~ "type" =: "file"
482+ click <- button "save"
483+ prerender_ (pure ()) $ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
484+ names <- liftJSM $ traverse File.getName fs
485+ liftIO $ writeRef filesRef names
486+ it "fires _input event if the user altered the value before hydration" $ runWD $ do
487+ input <- newRef ("" :: Text)
488+ update <- newRef ("" :: Text)
489+ let checkStatic = do
490+ e <- findElemWithRetry $ WD.ByTag "input"
491+ WD.attr e "value" `shouldBeWithRetryM` Just ""
492+ WD.sendKeys "test" e
493+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
494+ pure e
495+ checkHydrated e = do
496+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
497+ readRef input `shouldBeWithRetryM` "test"
498+ readRef update `shouldBeWithRetryM` "test"
499+ testWidget' checkStatic checkHydrated $ do
500+ e <- inputElement def
501+ performEvent_ $ liftIO . writeRef input <$> _inputElement_input e
502+ performEvent_ $ liftIO . writeRef update <$> updated (_inputElement_value e)
503+ it "does not fire _input event when the value is updated at postBuild" $ runWD $ do
504+ input <- newRef (Nothing :: Maybe Text)
505+ let checkStatic = do
506+ e <- findElemWithRetry $ WD.ByTag "input"
507+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
508+ pure e
509+ checkHydrated e = do
510+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
511+ readRef input `shouldBeWithRetryM` Nothing
512+ testWidget' checkStatic checkHydrated $ do
513+ pb <- getPostBuild
514+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
515+ performEvent_ $ liftIO . writeRef input . Just <$> _inputElement_input e
516+ it "SSR produces correct DOM based on inputElement values when setValue happens at postBuild" $ runWD $ do
517+ let checkBoth = do
518+ input <- findElemWithRetry $ WD.ByTag "input"
519+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
520+ p <- findElemWithRetry (WD.ByTag "p")
521+ shouldContainText "pb" p
522+ testWidget checkBoth checkBoth $ do
523+ pb <- getPostBuild
524+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
525+ el "p" $ dynText $ _inputElement_value e
526+ it "does not fail when both setValue AND user updated value happen before switchover" $ runWD $ do
527+ let checkStatic = do
528+ input <- findElemWithRetry $ WD.ByTag "input"
529+ h2_value <- findElemWithRetry (WD.ByTag "h2")
530+ h3_input <- findElemWithRetry (WD.ByTag "h3")
531+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
532+ shouldContainText "pb" h2_value
533+ shouldContainText "" h3_input
534+ WD.sendKeys "abc" input
535+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
536+ shouldContainText "pb" h2_value
537+ shouldContainText "" h3_input
538+ pure (input, h2_value, h3_input)
539+ checkHydrated (input, h2_value, h3_input) = do
540+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
541+ shouldContainText "pbabc" h3_input
542+ shouldContainText "pbabc pb" h2_value
543+ pure ()
544+ testWidget' checkStatic checkHydrated $ do
545+ pb <- getPostBuild
546+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
547+ el "h1" $ dynText $ _inputElement_value e
548+ el "h2" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ updated $ _inputElement_value e
549+ el "h3" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ _inputElement_input e
550+ it "value is correct when both setValue AND user updated value happen before switchover" $ runWD $ do
551+ let checkStatic = do
552+ input <- findElemWithRetry $ WD.ByTag "input"
553+ p <- findElemWithRetry (WD.ByTag "p")
554+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
555+ shouldContainText "pb" p
556+ WD.sendKeys "abc" input
557+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
558+ shouldContainText "pb" p -- It won't be updated yet
559+ pure (input, p)
560+ checkHydrated (input, p) = do
561+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
562+ shouldContainText "pbabc" p
563+ pure ()
564+ testWidget' checkStatic checkHydrated $ do
565+ pb <- getPostBuild
566+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
567+ el "p" $ dynText $ _inputElement_value e
568+ it "input event and (updated value) fire correctly when both setValue AND user updated value happen before switchover" $ runWD $ do
569+ valRef <- newRef ([] :: [Text])
570+ inputRef <- newRef ([] :: [Text])
571+ let consRef ref a = liftIO $ atomicModifyRef ref $ \as -> (a:as, ())
572+ checkStatic = do
573+ input <- findElemWithRetry $ WD.ByTag "input"
574+ p <- findElemWithRetry (WD.ByTag "p")
575+ WD.attr input "value" `shouldBeWithRetryM` Just "pb"
576+ shouldContainText "pb" p
577+ WD.sendKeys "abc" input
578+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
579+ shouldContainText "pb" p -- It won't be updated yet
580+ readRef inputRef `shouldBeWithRetryM` [] -- Should never fire input ref during SSR
581+ readRef valRef `shouldBeWithRetryM` ["pb"]
582+ pure (input, p)
583+ checkHydrated (input, p) = do
584+ readRef inputRef `shouldBeWithRetryM` ["pbabc"]
585+ readRef valRef `shouldBeWithRetryM` ["pbabc", "pb"]
586+ WD.attr input "value" `shouldBeWithRetryM` Just "pbabc"
587+ shouldContainText "pbabc" p
588+ pure ()
589+ testWidget' checkStatic checkHydrated $ do
590+ liftIO $ writeRef valRef []
591+ pb <- getPostBuild
592+ e <- inputElement $ def & inputElementConfig_setValue .~ ("pb" <$ pb)
593+ el "p" $ dynText $ _inputElement_value e
594+ performEvent_ $ consRef valRef <$> updated (_inputElement_value e)
595+ performEvent_ $ consRef inputRef <$> _inputElement_input e
596+ describe "hydration/immediate" $ do
597+ it "captures user input after switchover" $ runWD $ do
598+ inputRef :: IORef Text <- newRef ""
599+ let checkValue = do
600+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "input")
601+ WD.click =<< findElemWithRetry (WD.ByTag "button")
602+ readRef inputRef `shouldBeWithRetryM` "hello world"
603+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
604+ e <- inputElement def
605+ click <- button "save"
606+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
607+ it "sets focus appropriately" $ runWD $ do
608+ focusRef <- newRef False
609+ let checkValue = do
610+ readRef focusRef `shouldBeWithRetryM` False
611+ e <- findElemWithRetry $ WD.ByTag "input"
612+ WD.click e
613+ readRef focusRef `shouldBeWithRetryM` True
614+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
615+ e <- inputElement def
616+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_inputElement_hasFocus e)
617+ it "sets value appropriately" $ runWD $ do
618+ valueByUIRef :: IORef Text <- newRef ""
619+ valueRef :: IORef Text <- newRef ""
620+ setValueChan :: Chan Text <- liftIO newChan
621+ let checkValue = do
622+ readRef valueByUIRef `shouldBeWithRetryM` ""
623+ readRef valueRef `shouldBeWithRetryM` ""
624+ e <- findElemWithRetry $ WD.ByTag "input"
625+ WD.sendKeys "hello" e
626+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
627+ readRef valueRef `shouldBeWithRetryM` "hello"
628+ liftIO $ writeChan setValueChan "world"
629+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
630+ readRef valueRef `shouldBeWithRetryM` "world"
631+ testWidget (pure ()) checkValue $ do
632+ update <- triggerEventWithChan setValueChan
633+ prerender_ (pure ()) $ do
634+ e <- inputElement $ def & inputElementConfig_setValue .~ update
635+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _inputElement_input e
636+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
637+ it "sets checked appropriately" $ runWD $ do
638+ checkedByUIRef <- newRef False
639+ checkedRef <- newRef False
640+ setCheckedChan <- liftIO newChan
641+ let checkValue = do
642+ readRef checkedByUIRef `shouldBeWithRetryM` False
643+ readRef checkedRef `shouldBeWithRetryM` False
644+ e <- findElemWithRetry $ WD.ByTag "input"
645+ WD.moveToCenter e
646+ WD.click e
647+ readRef checkedByUIRef `shouldBeWithRetryM` True
648+ readRef checkedRef `shouldBeWithRetryM` True
649+ liftIO $ writeChan setCheckedChan False
650+ readRef checkedByUIRef `shouldBeWithRetryM` True
651+ readRef checkedRef `shouldBeWithRetryM` False
652+ testWidget (pure ()) checkValue $ do
653+ setChecked <- triggerEventWithChan setCheckedChan
654+ prerender_ (pure ()) $ do
655+ e <- inputElement $ def
656+ & initialAttributes .~ "type" =: "checkbox"
657+ & inputElementConfig_setChecked .~ setChecked
658+ performEvent_ $ liftIO . writeRef checkedByUIRef <$> _inputElement_checkedChange e
659+ performEvent_ $ liftIO . writeRef checkedRef <$> updated (_inputElement_checked e)
660+ it "captures file uploads" $ runWD $ do
661+ filesRef :: IORef [Text] <- newRef []
662+ let uploadFile = do
663+ e <- findElemWithRetry $ WD.ByTag "input"
664+ path <- liftIO $ writeSystemTempFile "testFile" "file contents"
665+ WD.sendKeys (T.pack path) e
666+ WD.click =<< findElemWithRetry (WD.ByTag "button")
667+ liftIO $ removeFile path
668+ readRef filesRef `shouldBeWithRetryM` [T.pack $ FilePath.takeFileName path]
669+ testWidget (pure ()) uploadFile $ prerender_ (pure ()) $ do
670+ e <- inputElement $ def & initialAttributes .~ "type" =: "file"
671+ click <- button "save"
672+ performEvent_ $ ffor (tag (current (_inputElement_files e)) click) $ \fs -> do
673+ names <- liftJSM $ traverse File.getName fs
674+ liftIO $ writeRef filesRef names
675+
676+ session' "textAreaElement" $ do
677+ describe "static renderer" $ do
678+ it "sets value attribute" $ runWD $ do
679+ let checkStatic = do
680+ e <- findElemWithRetry $ WD.ByTag "textarea"
681+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
682+ pure e
683+ checkHydrated e = do
684+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
685+ testWidget' checkStatic checkHydrated $ void $ textAreaElement $ def
686+ & textAreaElementConfig_initialValue .~ "test"
687+ it "updates value attribute at postBuild" $ runWD $ do
688+ let checkStatic = do
689+ e <- findElemWithRetry $ WD.ByTag "textarea"
690+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
691+ pure e
692+ checkHydrated e = do
693+ WD.attr e "value" `shouldBeWithRetryM` Just "test-updated"
694+ testWidget' checkStatic checkHydrated $ do
695+ pb <- getPostBuild
696+ _ <- textAreaElement $ def
697+ & textAreaElementConfig_initialValue .~ "test"
698+ & textAreaElementConfig_setValue .~ ("test-updated" <$ pb)
699+ pure ()
700+ describe "hydration" $ do
701+ it "doesn't wipe user input when switching over" $ runWD $ do
702+ inputRef <- newRef ("" :: Text)
703+ testWidget'
704+ (do
705+ e <- findElemWithRetry $ WD.ByTag "textarea"
706+ WD.sendKeys "hello world" e
707+ pure e)
708+ (\e -> do
709+ WD.attr e "value" `shouldBeWithRetryM` Just "hello world"
710+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
711+ readRef inputRef `shouldBeWithRetryM` "hello world"
712+ ) $ do
713+ e <- textAreaElement def
714+ click <- button "save"
715+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
716+ it "captures user input after switchover" $ runWD $ do
717+ inputRef <- newRef ("" :: Text)
718+ let checkValue = do
719+ WD.sendKeys "hello world" =<< findElemWithRetry (WD.ByTag "textarea")
720+ WD.click =<< findElemWithRetry (WD.ByTag "button")
721+ readRef inputRef `shouldBeWithRetryM` "hello world"
722+ testWidget (pure ()) checkValue $ do
723+ e <- textAreaElement def
724+ click <- button "save"
725+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
726+ it "sets focus appropriately" $ runWD $ do
727+ focusRef <- newRef False
728+ let checkValue = do
729+ readRef focusRef `shouldBeWithRetryM` False
730+ e <- findElemWithRetry $ WD.ByTag "textarea"
731+ WD.click e
732+ readRef focusRef `shouldBeWithRetryM` True
733+ testWidget (pure ()) checkValue $ do
734+ e <- textAreaElement def
735+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
736+ it "sets focus when focus occurs before hydration" $ runWD $ do
737+ focusRef <- newRef False
738+ let setup = do
739+ e <- findElemWithRetry $ WD.ByTag "textarea"
740+ WD.click e
741+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
742+ readRef focusRef `shouldBeWithRetryM` False
743+ check = readRef focusRef `shouldBeWithRetryM` True
744+ testWidget setup check $ do
745+ e <- textAreaElement def
746+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
747+ it "sets value appropriately" $ runWD $ do
748+ valueByUIRef <- newRef ("" :: Text)
749+ valueRef <- newRef ("" :: Text)
750+ setValueChan :: Chan Text <- liftIO newChan
751+ let checkValue = do
752+ readRef valueByUIRef `shouldBeWithRetryM` ""
753+ readRef valueRef `shouldBeWithRetryM` ""
754+ e <- findElemWithRetry $ WD.ByTag "textarea"
755+ WD.sendKeys "hello" e
756+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
757+ readRef valueRef `shouldBeWithRetryM` "hello"
758+ liftIO $ writeChan setValueChan "world"
759+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
760+ readRef valueRef `shouldBeWithRetryM` "world"
761+ testWidget (pure ()) checkValue $ do
762+ setValue' <- triggerEventWithChan setValueChan
763+ e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
764+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
765+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
766+ it "fires _input event if the user altered the value before hydration" $ runWD $ do
767+ textarea <- newRef ("" :: Text)
768+ update <- newRef ("" :: Text)
769+ let checkStatic = do
770+ e <- findElemWithRetry $ WD.ByTag "textarea"
771+ WD.attr e "value" `shouldBeWithRetryM` Just ""
772+ WD.sendKeys "test" e
773+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
774+ pure e
775+ checkHydrated e = do
776+ WD.attr e "value" `shouldBeWithRetryM` Just "test"
777+ readRef textarea `shouldBeWithRetryM` "test"
778+ readRef update `shouldBeWithRetryM` "test"
779+ testWidget' checkStatic checkHydrated $ do
780+ e <- textAreaElement def
781+ performEvent_ $ liftIO . writeRef textarea <$> _textAreaElement_input e
782+ performEvent_ $ liftIO . writeRef update <$> updated (_textAreaElement_value e)
783+ it "does not fire _input event when the value is updated at postBuild" $ runWD $ do
784+ textarea <- newRef (Nothing :: Maybe Text)
785+ let checkStatic = do
786+ e <- findElemWithRetry $ WD.ByTag "textarea"
787+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
788+ pure e
789+ checkHydrated e = do
790+ WD.attr e "value" `shouldBeWithRetryM` Just "pb"
791+ readRef textarea `shouldBeWithRetryM` Nothing
792+ testWidget' checkStatic checkHydrated $ do
793+ pb <- getPostBuild
794+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
795+ performEvent_ $ liftIO . writeRef textarea . Just <$> _textAreaElement_input e
796+ it "SSR produces correct DOM based on textAreaElement values when setValue happens at postBuild" $ runWD $ do
797+ let checkBoth = do
798+ textarea <- findElemWithRetry $ WD.ByTag "textarea"
799+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pb"
800+ p <- findElemWithRetry (WD.ByTag "p")
801+ shouldContainText "pb" p
802+ testWidget checkBoth checkBoth $ do
803+ pb <- getPostBuild
804+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
805+ el "p" $ dynText $ _textAreaElement_value e
806+ it "does not fail when both setValue AND user updated value happen before switchover" $ runWD $ do
807+ let checkStatic = do
808+ textarea <- findElemWithRetry $ WD.ByTag "textarea"
809+ h2_value <- findElemWithRetry (WD.ByTag "h2")
810+ h3_input <- findElemWithRetry (WD.ByTag "h3")
811+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pb"
812+ shouldContainText "pb" h2_value
813+ shouldContainText "" h3_input
814+ WD.sendKeys "abc" textarea
815+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
816+ shouldContainText "pb" h2_value
817+ shouldContainText "" h3_input
818+ pure (textarea, h2_value, h3_input)
819+ checkHydrated (textarea, h2_value, h3_input) = do
820+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
821+ shouldContainText "pbabc" h3_input
822+ shouldContainText "pbabc pb" h2_value
823+ pure ()
824+ testWidget' checkStatic checkHydrated $ do
825+ pb <- getPostBuild
826+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
827+ el "h1" $ dynText $ _textAreaElement_value e
828+ el "h2" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ updated $ _textAreaElement_value e
829+ el "h3" $ dynText . fmap T.unwords <=< foldDyn (:) [] $ _textAreaElement_input e
830+ it "value is correct when both setValue AND user updated value happen before switchover" $ runWD $ do
831+ let checkStatic = do
832+ textarea <- findElemWithRetry $ WD.ByTag "textarea"
833+ p <- findElemWithRetry (WD.ByTag "p")
834+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pb"
835+ shouldContainText "pb" p
836+ WD.sendKeys "abc" textarea
837+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
838+ shouldContainText "pb" p -- It won't be updated yet
839+ pure (textarea, p)
840+ checkHydrated (textarea, p) = do
841+ WD.attr textarea "value" `shouldBeWithRetryM` Just "pbabc"
842+ shouldContainText "pbabc" p
843+ pure ()
844+ testWidget' checkStatic checkHydrated $ do
845+ pb <- getPostBuild
846+ e <- textAreaElement $ def & textAreaElementConfig_setValue .~ ("pb" <$ pb)
847+ el "p" $ dynText $ _textAreaElement_value e
848+
849+ describe "hydration/immediate" $ do
850+ it "captures user input after switchover" $ runWD $ do
851+ inputRef :: IORef Text <- newRef ""
852+ let checkValue = do
853+ WD.sendKeys "hello world" <=< findElemWithRetry $ WD.ByTag "textarea"
854+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
855+ readRef inputRef `shouldBeWithRetryM` "hello world"
856+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
857+ e <- textAreaElement def
858+ click <- button "save"
859+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (value e)) click
860+ it "sets focus appropriately" $ runWD $ do
861+ focusRef <- newRef False
862+ let checkValue = do
863+ readRef focusRef `shouldBeWithRetryM` False
864+ e <- findElemWithRetry $ WD.ByTag "textarea"
865+ WD.click e
866+ readRef focusRef `shouldBeWithRetryM` True
867+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
868+ e <- textAreaElement def
869+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_textAreaElement_hasFocus e)
870+ it "sets value appropriately" $ runWD $ do
871+ valueByUIRef :: IORef Text <- newRef ""
872+ valueRef :: IORef Text <- newRef ""
873+ setValueChan :: Chan Text <- liftIO newChan
874+ let checkValue = do
875+ readRef valueByUIRef `shouldBeWithRetryM` ""
876+ readRef valueRef `shouldBeWithRetryM` ""
877+ e <- findElemWithRetry $ WD.ByTag "textarea"
878+ WD.sendKeys "hello" e
879+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
880+ readRef valueRef `shouldBeWithRetryM` "hello"
881+ liftIO $ writeChan setValueChan "world"
882+ readRef valueByUIRef `shouldBeWithRetryM` "hello"
883+ readRef valueRef `shouldBeWithRetryM` "world"
884+ testWidget (pure ()) checkValue $ do
885+ setValue' <- triggerEventWithChan setValueChan
886+ prerender_ (pure ()) $ do
887+ e <- textAreaElement $ def { _textAreaElementConfig_setValue = Just setValue' }
888+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _textAreaElement_input e
889+ performEvent_ $ liftIO . writeRef valueRef <$> updated (value e)
890+
891+ session' "selectElement" $ do
892+ let options :: DomBuilder t m => m ()
893+ options = do
894+ elAttr "option" ("value" =: "one" <> "id" =: "one") $ text "one"
895+ elAttr "option" ("value" =: "two" <> "id" =: "two") $ text "two"
896+ elAttr "option" ("value" =: "three" <> "id" =: "three") $ text "three"
897+ describe "hydration" $ do
898+ it "sets initial value correctly" $ runWD $ do
899+ inputRef <- newRef ("" :: Text)
900+ let setup = do
901+ e <- findElemWithRetry $ WD.ByTag "select"
902+ assertAttr e "value" (Just "three")
903+ WD.click =<< findElemWithRetry (WD.ById "two")
904+ pure e
905+ check e = do
906+ assertAttr e "value" (Just "two")
907+ readRef inputRef `shouldBeWithRetryM` "three"
908+ WD.click =<< findElemWithRetry (WD.ByTag "button")
909+ assertAttr e "value" (Just "two")
910+ readRef inputRef `shouldBeWithRetryM` "two"
911+ testWidget' setup check $ do
912+ (e, ()) <- selectElement (def { _selectElementConfig_initialValue = "three" }) options
913+ click <- button "save"
914+ liftIO . writeRef inputRef <=< sample $ current $ _selectElement_value e
915+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
916+ it "captures user input after switchover" $ runWD $ do
917+ inputRef <- newRef ("" :: Text)
918+ let checkValue = do
919+ e <- findElemWithRetry $ WD.ByTag "select"
920+ assertAttr e "value" (Just "one")
921+ WD.click =<< findElemWithRetry (WD.ById "two")
922+ assertAttr e "value" (Just "two")
923+ WD.click =<< findElemWithRetry (WD.ByTag "button")
924+ readRef inputRef `shouldBeWithRetryM` "two"
925+ testWidget (pure ()) checkValue $ do
926+ (e, ()) <- selectElement def options
927+ click <- button "save"
928+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
929+ it "sets focus appropriately" $ runWD $ do
930+ focusRef <- newRef False
931+ let checkValue = do
932+ readRef focusRef `shouldBeWithRetryM` False
933+ e <- findElemWithRetry $ WD.ByTag "select"
934+ WD.click e
935+ readRef focusRef `shouldBeWithRetryM` True
936+ testWidget (pure ()) checkValue $ do
937+ (e, ()) <- selectElement def options
938+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
939+ it "sets focus when focus occurs before hydration" $ runWD $ do
940+ focusRef <- newRef False
941+ let setup = do
942+ e <- findElemWithRetry $ WD.ByTag "select"
943+ WD.click e
944+ ((== e) <$> WD.activeElem) `shouldBeWithRetryM` True
945+ readRef focusRef `shouldBeWithRetryM` False
946+ check = readRef focusRef `shouldBeWithRetryM` True
947+ testWidget setup check $ do
948+ (e, ()) <- selectElement def options
949+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
950+ it "sets value appropriately" $ runWD $ do
951+ valueByUIRef <- newRef ("" :: Text)
952+ valueRef <- newRef ("" :: Text)
953+ setValueChan :: Chan Text <- liftIO newChan
954+ let checkValue = do
955+ e <- findElemWithRetry $ WD.ByTag "select"
956+ assertAttr e "value" (Just "one")
957+ readRef valueByUIRef `shouldBeWithRetryM` "one"
958+ readRef valueRef `shouldBeWithRetryM` "one"
959+ WD.click <=< findElemWithRetry $ WD.ById "two"
960+ readRef valueByUIRef `shouldBeWithRetryM` "two"
961+ readRef valueRef `shouldBeWithRetryM` "two"
962+ liftIO $ writeChan setValueChan "three"
963+ readRef valueByUIRef `shouldBeWithRetryM` "two"
964+ readRef valueRef `shouldBeWithRetryM` "three"
965+ testWidget (pure ()) checkValue $ do
966+ setValue' <- triggerEventWithChan setValueChan
967+ (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
968+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
969+ performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
970+
971+ describe "hydration/immediate" $ do
972+ it "captures user input after switchover" $ runWD $ do
973+ inputRef :: IORef Text <- newRef ""
974+ let checkValue = do
975+ WD.click <=< findElemWithRetry $ WD.ById "two"
976+ WD.click <=< findElemWithRetry $ WD.ByTag "button"
977+ readRef inputRef `shouldBeWithRetryM` "two"
978+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
979+ (e, ()) <- selectElement def options
980+ click <- button "save"
981+ performEvent_ $ liftIO . writeRef inputRef <$> tag (current (_selectElement_value e)) click
982+ it "sets focus appropriately" $ runWD $ do
983+ focusRef <- newRef False
984+ let checkValue = do
985+ readRef focusRef `shouldBeWithRetryM` False
986+ e <- findElemWithRetry $ WD.ByTag "select"
987+ WD.click e
988+ readRef focusRef `shouldBeWithRetryM` True
989+ testWidget (pure ()) checkValue $ prerender_ (pure ()) $ do
990+ (e, ()) <- selectElement def options
991+ performEvent_ $ liftIO . writeRef focusRef <$> updated (_selectElement_hasFocus e)
992+ it "has correct initial value" $ runWD $ do
993+ valueRef :: IORef Text <- newRef ""
994+ let checkValue = readRef valueRef `shouldBeWithRetryM` "one"
995+ testWidget (pure ()) checkValue $ do
996+ prerender_ (pure ()) $ do
997+ (e, ()) <- selectElement def { _selectElementConfig_initialValue = "one" } options
998+ liftIO . writeRef valueRef <=< sample $ current $ _selectElement_value e
999+ it "sets value appropriately" $ runWD $ do
1000+ valueByUIRef :: IORef Text <- newRef ""
1001+ valueRef :: IORef Text <- newRef ""
1002+ setValueChan :: Chan Text <- liftIO newChan
1003+ let checkValue = do
1004+ WD.click =<< findElemWithRetry (WD.ById "two")
1005+ readRef valueByUIRef `shouldBeWithRetryM` "two"
1006+ readRef valueRef `shouldBeWithRetryM` "two"
1007+ liftIO $ writeChan setValueChan "three"
1008+ readRef valueByUIRef `shouldBeWithRetryM` "two"
1009+ readRef valueRef `shouldBeWithRetryM` "three"
1010+ testWidget (pure ()) checkValue $ do
1011+ setValue' <- triggerEventWithChan setValueChan
1012+ prerender_ (pure ()) $ do
1013+ (e, ()) <- selectElement def { _selectElementConfig_setValue = Just setValue' } options
1014+ performEvent_ $ liftIO . writeRef valueByUIRef <$> _selectElement_change e
1015+ performEvent_ $ liftIO . writeRef valueRef <$> updated (_selectElement_value e)
1016+
1017+ session' "prerender" $ do
1018+ it "works in simple case" $ runWD $ do
1019+ testWidget (checkBodyText "One") (checkBodyText "Two") $ do
1020+ prerender_ (text "One") (text "Two")
1021+ it "removes element correctly" $ runWD $ do
1022+ testWidget' (findElemWithRetry $ WD.ByTag "span") elementShouldBeRemoved $ do
1023+ prerender_ (el "span" $ text "One") (text "Two")
1024+ it "can be nested in server widget" $ runWD $ do
1025+ testWidget (checkBodyText "One") (checkBodyText "Three") $ do
1026+ prerender_ (prerender_ (text "One") (text "Two")) (text "Three")
1027+ it "can be nested in client widget" $ runWD $ do
1028+ testWidget (checkBodyText "One") (checkBodyText "Three") $ do
1029+ prerender_ (text "One") (prerender_ (text "Two") (text "Three"))
1030+ it "works with prerender_ siblings" $ runWD $ do
1031+ testWidget
1032+ (checkTextInId "a1" "One" >> checkTextInId "b1" "Three" >> checkTextInId "c1" "Five")
1033+ (checkTextInId "a2" "Two" >> checkTextInId "b2" "Four" >> checkTextInId "c2" "Six") $ do
1034+ prerender_ (divId "a1" $ text "One") (divId "a2" $ text "Two")
1035+ prerender_ (divId "b1" $ text "Three") (divId "b2" $ text "Four")
1036+ prerender_ (divId "c1" $ text "Five") (divId "c2" $ text "Six")
1037+ it "works inside other element" $ runWD $ do
1038+ testWidget (checkTextInTag "div" "One") (checkTextInTag "div" "Two") $ do
1039+ el "div" $ prerender_ (text "One") (text "Two")
1040+-- TODO re-enable this
1041+-- it "places fences and removes them" $ runWD $ do
1042+-- testWidget'
1043+-- (do
1044+-- scripts <- WD.findElems $ WD.ByTag "script"
1045+-- filterM (\s -> maybe False (\t -> "prerender" `T.isPrefixOf` t) <$> WD.attr s "type") scripts
1046+-- )
1047+-- (traverse_ elementShouldBeRemoved)
1048+-- (el "span" $ prerender_ (text "One") (text "Two"))
1049+ it "postBuild works on server side" $ runWD $ do
1050+ lock :: MVar () <- liftIO newEmptyMVar
1051+ testWidget (liftIO $ takeMVar lock) (pure ()) $ do
1052+ prerender_ (do
1053+ pb <- getPostBuild
1054+ performEvent_ $ liftIO (putMVar lock ()) <$ pb) blank
1055+ it "postBuild works on client side" $ runWD $ do
1056+ lock :: MVar () <- liftIO newEmptyMVar
1057+ testWidget (pure ()) (liftIO $ takeMVar lock) $ do
1058+ prerender_ blank $ do
1059+ pb <- getPostBuild
1060+ performEvent_ $ liftIO (putMVar lock ()) <$ pb
1061+ it "result Dynamic is updated *after* switchover" $ runWD $ do
1062+ let preSwitchover = checkBodyText "PostBuild"
1063+ check = checkBodyText "Client"
1064+ testWidget preSwitchover check $ void $ do
1065+ d <- prerender (pure "Initial") (pure "Client")
1066+ pb <- getPostBuild
1067+ initial <- sample $ current d
1068+ textNode $ TextNodeConfig initial $ Just $ leftmost [updated d, "PostBuild" <$ pb]
1069+ -- This essentially checks that the client IO runs *after* switchover/postBuild,
1070+ -- thus can't create conflicting DOM
1071+ it "can't exploit IO to break hydration" $ runWD $ do
1072+ let preSwitchover = checkBodyText "Initial"
1073+ testWidgetStatic preSwitchover $ void $ do
1074+ ref <- liftIO $ newRef "Initial"
1075+ prerender_ (pure ()) (liftIO $ writeRef ref "Client")
1076+ text <=< liftIO $ readRef ref
1077+ -- As above, so below
1078+ it "can't exploit triggerEvent to break hydration" $ runWD $ do
1079+ let preSwitchover = checkBodyText "Initial"
1080+ check = checkBodyText "Client"
1081+ testWidget preSwitchover check $ void $ do
1082+ (e, trigger) <- newTriggerEvent
1083+ prerender_ (pure ()) (liftIO $ trigger "Client")
1084+ textNode $ TextNodeConfig "Initial" $ Just e
1085+
1086+ session' "namespaces" $ do
1087+ it "dyn can be nested in namespaced widget" $ runWD $ do
1088+ testWidget (pure ()) (checkTextInTag "svg" "one") $ do
1089+ let svgRootCfg = def
1090+ & (elementConfig_namespace ?~ "http://www.w3.org/2000/svg")
1091+ & (elementConfig_initialAttributes .~ ("width" =: "100%" <> "height" =: "100%" <> "viewBox" =: "0 0 1536 2048"))
1092+ void $ element "svg" svgRootCfg $ do
1093+ dyn_ $ text "one" <$ pure ()
1094+
1095+ session' "runWithReplace" $ do
1096+ it "works" $ runWD $ do
1097+ replaceChan :: Chan Text <- liftIO newChan
1098+ let setup = findElemWithRetry $ WD.ByTag "div"
1099+ check ssr = do
1100+ -- Check that the original element still exists and has the correct text
1101+ shouldContainText "two" ssr
1102+ liftIO $ writeChan replaceChan "three"
1103+ elementShouldBeRemoved ssr
1104+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1105+ testWidget' setup check $ do
1106+ replace <- triggerEventWithChan replaceChan
1107+ pb <- getPostBuild
1108+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1109+ [ el "div" (text "two") <$ pb
1110+ , el "span" . text <$> replace
1111+ ]
1112+ it "can be nested in initial widget" $ runWD $ do
1113+ replaceChan :: Chan Text <- liftIO newChan
1114+ let setup = findElemWithRetry $ WD.ByTag "div"
1115+ check ssr = do
1116+ -- Check that the original element still exists and has the correct text
1117+ shouldContainText "two" ssr
1118+ liftIO $ writeChan replaceChan "three"
1119+ elementShouldBeRemoved ssr
1120+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1121+ testWidget' setup check $ void $ flip runWithReplace never $ do
1122+ replace <- triggerEventWithChan replaceChan
1123+ pb <- getPostBuild
1124+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1125+ [ el "div" (text "two") <$ pb
1126+ , el "span" . text <$> replace
1127+ ]
1128+ it "can be nested in postBuild widget" $ runWD $ do
1129+ replaceChan :: Chan Text <- liftIO newChan
1130+ let setup = findElemWithRetry $ WD.ByTag "div"
1131+ check ssr = do
1132+ -- Check that the original element still exists and has the correct text
1133+ shouldContainText "two" ssr
1134+ liftIO $ writeChan replaceChan "three"
1135+ elementShouldBeRemoved ssr
1136+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1137+ testWidget' setup check $ void $ do
1138+ pb <- getPostBuild
1139+ runWithReplace (pure ()) $ ffor pb $ \() -> do
1140+ replace <- triggerEventWithChan replaceChan
1141+ pb' <- getPostBuild
1142+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1143+ [ el "div" (text "two") <$ pb'
1144+ , el "span" . text <$> replace
1145+ ]
1146+ it "postBuild works in replaced widget" $ runWD $ do
1147+ replaceChan <- liftIO newChan
1148+ pbLock <- liftIO newEmptyMVar
1149+ let check = liftIO $ do
1150+ writeChan replaceChan ()
1151+ takeMVar pbLock
1152+ testWidget (pure ()) check $ void $ do
1153+ replace <- triggerEventWithChan replaceChan
1154+ runWithReplace (pure ()) $ ffor replace $ \() -> do
1155+ pb <- getPostBuild
1156+ performEvent_ $ liftIO (putMVar pbLock ()) <$ pb
1157+ it "can be nested in event widget" $ runWD $ do
1158+ replaceChan1 :: Chan Text <- liftIO newChan
1159+ replaceChan2 :: Chan Text <- liftIO newChan
1160+ lock :: MVar () <- liftIO newEmptyMVar
1161+ let check = do
1162+ shouldContainText "" =<< findElemWithRetry (WD.ByTag "body")
1163+ liftIO $ do
1164+ writeChan replaceChan1 "one"
1165+ takeMVar lock
1166+ one <- findElemWithRetry $ WD.ByTag "div"
1167+ shouldContainText "pb" one
1168+ liftIO $ writeChan replaceChan2 "two"
1169+ elementShouldBeRemoved one
1170+ shouldContainText "two" =<< findElemWithRetry (WD.ByTag "span")
1171+ testWidget (pure ()) check $ void $ do
1172+ replace1 <- triggerEventWithChan replaceChan1
1173+ runWithReplace (pure ()) $ ffor replace1 $ \r1 -> do
1174+ replace2 <- triggerEventWithChan replaceChan2
1175+ pb <- getPostBuild
1176+ performEvent_ $ liftIO (putMVar lock ()) <$ pb
1177+ void $ runWithReplace (el "div" $ text r1) $ leftmost
1178+ [ el "span" . text <$> replace2
1179+ , el "div" (text "pb") <$ pb
1180+ ]
1181+ it "prerender works in replaced widget" $ runWD $ do
1182+ replaceChan <- liftIO newChan
1183+ lock :: MVar () <- liftIO newEmptyMVar
1184+ pbLock :: MVar () <- liftIO newEmptyMVar
1185+ let check = do
1186+ liftIO $ do
1187+ writeChan replaceChan ()
1188+ takeMVar lock
1189+ takeMVar pbLock
1190+ testWidget (pure ()) check $ void $ do
1191+ replace <- triggerEventWithChan replaceChan
1192+ runWithReplace (pure ()) $ ffor replace $ \() -> do
1193+ prerender_ (pure ()) $ do
1194+ liftIO $ putMVar lock ()
1195+ pb <- getPostBuild
1196+ performEvent_ $ liftIO (putMVar pbLock ()) <$ pb
1197+ it "prerender returns in immediate mode" $ runWD $ do
1198+ replaceChan <- liftIO newChan
1199+ pbLock <- liftIO newEmptyMVar
1200+ let check = liftIO $ do
1201+ writeChan replaceChan ()
1202+ takeMVar pbLock
1203+ testWidget (pure ()) check $ void $ do
1204+ replace <- triggerEventWithChan replaceChan
1205+ runWithReplace (pure ()) $ ffor replace $ \() -> do
1206+ prerender_ (pure ()) (pure ())
1207+ liftIO $ putMVar pbLock ()
1208+ it "works in immediate mode (RHS of prerender)" $ runWD $ do
1209+ replaceChan :: Chan Text <- liftIO newChan
1210+ let check = do
1211+ checkBodyText "one"
1212+ one <- findElemWithRetry $ WD.ByTag "div"
1213+ shouldContainText "one" one
1214+ liftIO $ writeChan replaceChan "pb"
1215+ elementShouldBeRemoved one
1216+ shouldContainText "pb" =<< findElemWithRetry (WD.ByTag "span")
1217+ testWidget (pure ()) check $ void $ do
1218+ replace <- triggerEventWithChan replaceChan
1219+ prerender_ blank $ do
1220+ void $ runWithReplace (el "div" $ text "one") $ el "span" . text <$> replace
1221+ it "works with postBuild in immediate mode (RHS of prerender)" $ runWD $ do
1222+ replaceChan :: Chan Text <- liftIO newChan
1223+ let check = do
1224+ checkBodyText "two"
1225+ two <- findElemWithRetry $ WD.ByTag "div"
1226+ shouldContainText "two" two
1227+ liftIO $ writeChan replaceChan "three"
1228+ elementShouldBeRemoved two
1229+ shouldContainText "three" =<< findElemWithRetry (WD.ByTag "span")
1230+ testWidget (pure ()) check $ void $ do
1231+ replace <- triggerEventWithChan replaceChan
1232+ prerender_ blank $ do
1233+ pb <- getPostBuild
1234+ void $ runWithReplace (el "div" $ text "one") $ leftmost
1235+ [ el "div" (text "two") <$ pb
1236+ , el "span" . text <$> replace
1237+ ]
1238+
1239+ let checkInnerHtml t x = findElemWithRetry (WD.ByTag t) >>= (`attr` "innerHTML") >>= (`shouldBe` Just x)
1240+ it "removes bracketing comments" $ runWD $ do
1241+ replaceChan :: Chan () <- liftIO newChan
1242+ let
1243+ preSwitchover = checkInnerHtml "div" "before|<!--replace-start-0-->inner1<!--replace-end-0-->|after"
1244+ check () = do
1245+ liftIO $ writeChan replaceChan () -- trigger creation of p tag
1246+ _ <- findElemWithRetry $ WD.ByTag "p" -- wait till p tag is created
1247+ checkInnerHtml "div" "before|<p>inner2</p>|after"
1248+ testWidget' preSwitchover check $ do
1249+ replace <- triggerEventWithChan replaceChan
1250+ el "div" $ do
1251+ text "before|"
1252+ _ <- runWithReplace (text "inner1") $ el "p" (text "inner2") <$ replace
1253+ text "|after"
1254+ it "ignores extra ending bracketing comment" $ runWD $ do
1255+ replaceChan :: Chan () <- liftIO newChan
1256+ let
1257+ preSwitchover = checkInnerHtml "div" "before|<!--replace-start-0-->inner1<!--replace-end-0--><!--replace-end-0-->|after"
1258+ check () = do
1259+ liftIO $ writeChan replaceChan () -- trigger creation of p tag
1260+ _ <- findElemWithRetry $ WD.ByTag "p" -- wait till p tag is created
1261+ checkInnerHtml "div" "before|inner2|after"
1262+ testWidget' preSwitchover check $ do
1263+ replace <- triggerEventWithChan replaceChan
1264+ el "div" $ do
1265+ text "before|"
1266+ _ <- runWithReplace (text "inner1" *> comment "replace-end-0") $ text "inner2" <$ replace
1267+ text "|after"
1268+ void $ runWithReplace blank $ el "p" blank <$ replace -- Signal tag for end of test
1269+ -- TODO This test actually causes a hydration failure, but it wasn't
1270+ -- previously detected, so I've marked it pending
1271+ xit "ignores missing ending bracketing comments" $ runWD $ do
1272+ replaceChan :: Chan () <- liftIO newChan
1273+ let
1274+ preSwitchover = do
1275+ checkInnerHtml "div" "before|<!--replace-start-0-->inner1<!--replace-end-0-->|after"
1276+ divEl <- findElemWithRetry (WD.ByTag "div")
1277+ let wrongHtml = "<!--replace-start-0-->inner1"
1278+ actualHtml :: String <- WD.executeJS
1279+ [WD.JSArg divEl, WD.JSArg wrongHtml]
1280+ "arguments[0].innerHTML = arguments[1]; return arguments[0].innerHTML"
1281+ actualHtml `shouldBe` wrongHtml
1282+ check () = do
1283+ liftIO $ writeChan replaceChan () -- trigger creation of p tag
1284+ _ <- findElemWithRetry $ WD.ByTag "p" -- wait till p tag is created
1285+ checkInnerHtml "div" "before|<p>inner2</p>|after"
1286+ testWidget' preSwitchover check $ do
1287+ replace <- triggerEventWithChan replaceChan
1288+ el "div" $ do
1289+ text "before|"
1290+ _ <- runWithReplace (text "inner1") $ el "p" (text "inner2") <$ replace
1291+ text "|after"
1292+
1293+ session' "traverseDMapWithKeyWithAdjust" $ do
1294+ let widget :: DomBuilder t m => DKey a -> Identity a -> m (Identity a)
1295+ widget k (Identity v) = elAttr "li" ("id" =: textKey k) $ do
1296+ elClass "span" "key" $ text $ textKey k
1297+ elClass "span" "value" $ text $ T.pack $ has @Show k $ show v
1298+ pure (Identity v)
1299+ checkItem :: WD.Element -> Text -> Text -> WD ()
1300+ checkItem li k v = do
1301+ putStrLnDebug "checkItem"
1302+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1303+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
1304+ checkInitialItems dm xs = do
1305+ putStrLnDebug "checkInitialItems"
1306+ liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
1307+ forM_ (zip xs (DMap.toList dm)) $ \(e, k :=> Identity v) -> checkItem e (textKey k) (T.pack $ has @Show k $ show v)
1308+ getAndCheckInitialItems dm = withRetry $ do
1309+ putStrLnDebug "getAndCheckInitialItems"
1310+ xs <- WD.findElems (WD.ByTag "li")
1311+ checkInitialItems dm xs
1312+ pure xs
1313+ checkRemoval chan k = do
1314+ putStrLnDebug "checkRemoval"
1315+ e <- findElemWithRetry (WD.ById $ textKey k)
1316+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe Nothing)
1317+ elementShouldBeRemoved e
1318+ checkReplace chan k v = do
1319+ putStrLnDebug "checkReplace"
1320+ e <- findElemWithRetry (WD.ById $ textKey k)
1321+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1322+ elementShouldBeRemoved e
1323+ e' <- findElemWithRetry $ WD.ById $ textKey k
1324+ checkItem e' (textKey k) (T.pack $ show v)
1325+ checkInsert chan k v = do
1326+ putStrLnDebug "checkInsert"
1327+ liftIO $ writeChan chan $ PatchDMap $ DMap.singleton k (ComposeMaybe $ Just $ Identity v)
1328+ e <- findElemWithRetry (WD.ById $ textKey k)
1329+ checkItem e (textKey k) (T.pack $ show v)
1330+ postBuildPatch = PatchDMap $ DMap.fromList [Key_Char :=> ComposeMaybe Nothing, Key_Bool :=> ComposeMaybe (Just $ Identity True)]
1331+ it "doesn't replace elements at switchover, can delete/update/insert" $ runWD $ do
1332+ chan <- liftIO newChan
1333+ let preSwitchover :: WD [WD.Element]
1334+ preSwitchover = getAndCheckInitialItems keyMap
1335+ check :: [WD.Element] -> WD ()
1336+ check xs = do
1337+ checkInitialItems keyMap xs
1338+ checkRemoval chan Key_Int
1339+ checkReplace chan Key_Char 'B'
1340+ checkInsert chan Key_Bool True
1341+ testWidget' preSwitchover check $ do
1342+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1343+ liftIO $ dmap `H.shouldBe` keyMap
1344+ it "handles postBuild correctly" $ runWD $ do
1345+ chan <- liftIO newChan
1346+ let preSwitchover = getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
1347+ check xs = do
1348+ withRetry $ checkInitialItems (applyAlways postBuildPatch keyMap) xs
1349+ checkRemoval chan Key_Int
1350+ checkInsert chan Key_Char 'B'
1351+ checkReplace chan Key_Bool True
1352+ testWidget' preSwitchover check $ void $ do
1353+ pb <- getPostBuild
1354+ replace <- triggerEventWithChan chan
1355+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1356+ liftIO $ dmap `H.shouldBe` keyMap
1357+ it "can delete/update/insert when built in prerender" $ runWD $ do
1358+ chan <- liftIO newChan
1359+ let check = do
1360+ _ <- getAndCheckInitialItems keyMap
1361+ checkRemoval chan Key_Int
1362+ checkReplace chan Key_Char 'B'
1363+ checkInsert chan Key_Bool True
1364+ testWidget (pure ()) check $ do
1365+ replace <- triggerEventWithChan chan
1366+ prerender_ (pure ()) $ do
1367+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap replace
1368+ liftIO $ dmap `H.shouldBe` keyMap
1369+ it "can delete/update/insert when built in immediate mode" $ runWD $ do
1370+ chan <- liftIO newChan
1371+ let check = do
1372+ _ <- getAndCheckInitialItems keyMap
1373+ checkRemoval chan Key_Int
1374+ checkReplace chan Key_Char 'B'
1375+ checkInsert chan Key_Bool True
1376+ testWidget (pure ()) check $ void $ do
1377+ pb <- getPostBuild
1378+ runWithReplace (pure ()) $ ffor pb $ \() -> void $ do
1379+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap =<< triggerEventWithChan chan
1380+ liftIO $ dmap `H.shouldBe` keyMap
1381+ -- Should be fixed by prerender changes!
1382+ it "handles postBuild correctly in prerender" $ runWD $ do
1383+ chan <- liftIO newChan
1384+ let check = do
1385+ _ <- getAndCheckInitialItems $ applyAlways postBuildPatch keyMap
1386+ checkRemoval chan Key_Int
1387+ checkInsert chan Key_Char 'B'
1388+ checkReplace chan Key_Bool True
1389+ testWidget (pure ()) check $ do
1390+ replace <- triggerEventWithChan chan
1391+ prerender_ (pure ()) $ void $ do
1392+ pb <- getPostBuild
1393+ (dmap, _evt) <- traverseDMapWithKeyWithAdjust widget keyMap $ leftmost [postBuildPatch <$ pb, replace]
1394+ liftIO $ dmap `H.shouldBe` keyMap
1395+
1396+ session' "traverseIntMapWithKeyWithAdjust" $ do
1397+ let textKeyInt k = "key" <> T.pack (show k)
1398+ intMap = IntMap.fromList
1399+ [ (1, "one")
1400+ , (2, "two")
1401+ , (3, "three")
1402+ ]
1403+ let widget :: DomBuilder t m => IntMap.Key -> Text -> m Text
1404+ widget k v = elAttr "li" ("id" =: textKeyInt k) $ do
1405+ elClass "span" "key" $ text $ textKeyInt k
1406+ elClass "span" "value" $ text v
1407+ pure v
1408+ checkItem :: WD.Element -> Text -> Text -> WD ()
1409+ checkItem li k v = do
1410+ putStrLnDebug "checkItem"
1411+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1412+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
1413+ checkInitialItems dm xs = do
1414+ putStrLnDebug "checkInitialItems"
1415+ liftIO $ assertEqual "Wrong amount of items in DOM" (IntMap.size dm) (length xs)
1416+ forM_ (zip xs (IntMap.toList dm)) $ \(e, (k, v)) -> checkItem e (textKeyInt k) v
1417+ getAndCheckInitialItems dm = withRetry $ do
1418+ putStrLnDebug "getAndCheckInitialItems"
1419+ xs <- WD.findElems (WD.ByTag "li")
1420+ checkInitialItems dm xs
1421+ pure xs
1422+ checkRemoval chan k = do
1423+ putStrLnDebug "checkRemoval"
1424+ e <- findElemWithRetry (WD.ById $ textKeyInt k)
1425+ liftIO $ writeChan chan $ PatchIntMap $ IntMap.singleton k Nothing
1426+ elementShouldBeRemoved e
1427+ checkReplace chan k v = do
1428+ putStrLnDebug "checkReplace"
1429+ e <- findElemWithRetry (WD.ById $ textKeyInt k)
1430+ liftIO $ writeChan chan $ PatchIntMap $ IntMap.singleton k $ Just v
1431+ elementShouldBeRemoved e
1432+ e' <- findElemWithRetry (WD.ById $ textKeyInt k)
1433+ withRetry $ checkItem e' (textKeyInt k) v
1434+ checkInsert chan k v = do
1435+ putStrLnDebug "checkInsert"
1436+ liftIO $ writeChan chan $ PatchIntMap $ IntMap.singleton k $ Just v
1437+ e <- findElemWithRetry (WD.ById $ textKeyInt k)
1438+ checkItem e (textKeyInt k) v
1439+ postBuildPatch = PatchIntMap $ IntMap.fromList [(2, Nothing), (3, Just "trois"), (4, Just "four")]
1440+ xit "doesn't replace elements at switchover, can delete/update/insert" $ runWD $ do
1441+ chan <- liftIO newChan
1442+ let preSwitchover = getAndCheckInitialItems intMap
1443+ check xs = do
1444+ checkInitialItems intMap xs
1445+ checkRemoval chan 1
1446+ checkReplace chan 2 "deux"
1447+ checkInsert chan 4 "four"
1448+ testWidget' preSwitchover check $ void $ do
1449+ (im, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap =<< triggerEventWithChan chan
1450+ liftIO $ im `H.shouldBe` intMap
1451+ xit "handles postBuild correctly" $ runWD $ do
1452+ chan <- liftIO newChan
1453+ let preSwitchover = getAndCheckInitialItems $ applyAlways postBuildPatch intMap
1454+ check xs = do
1455+ withRetry $ checkInitialItems (applyAlways postBuildPatch intMap) xs
1456+ checkRemoval chan 1
1457+ checkInsert chan 2 "deux"
1458+ checkReplace chan 3 "trois"
1459+ testWidget' preSwitchover check $ void $ do
1460+ pb <- getPostBuild
1461+ replace <- triggerEventWithChan chan
1462+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
1463+ liftIO $ dmap `H.shouldBe` intMap
1464+ xit "can delete/update/insert when built in prerender" $ runWD $ do
1465+ chan <- liftIO newChan
1466+ let check = do
1467+ _ <- getAndCheckInitialItems intMap
1468+ checkRemoval chan 1
1469+ checkReplace chan 2 "deux"
1470+ checkInsert chan 4 "quatre"
1471+ testWidget (pure ()) check $ do
1472+ replace <- triggerEventWithChan chan
1473+ prerender_ (pure ()) $ do
1474+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap replace
1475+ liftIO $ dmap `H.shouldBe` intMap
1476+ xit "can delete/update/insert when built in immediate mode" $ runWD $ do
1477+ chan <- liftIO newChan
1478+ let check = do
1479+ _ <- getAndCheckInitialItems intMap
1480+ checkRemoval chan 1
1481+ checkReplace chan 2 "deux"
1482+ checkInsert chan 4 "quatre"
1483+ testWidget (pure ()) check $ void $ do
1484+ pb <- getPostBuild
1485+ runWithReplace (pure ()) $ ffor pb $ \() -> void $ do
1486+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap =<< triggerEventWithChan chan
1487+ liftIO $ dmap `H.shouldBe` intMap
1488+ -- Should be fixed by prerender changes!
1489+ xit "handles postBuild correctly in prerender" $ runWD $ do
1490+ chan <- liftIO newChan
1491+ let check = do
1492+ _ <- getAndCheckInitialItems $ applyAlways postBuildPatch intMap
1493+ checkRemoval chan 1
1494+ checkInsert chan 2 "deux"
1495+ checkReplace chan 3 "trois"
1496+ testWidget (pure ()) check $ do
1497+ replace <- triggerEventWithChan chan
1498+ prerender_ (pure ()) $ void $ do
1499+ pb <- getPostBuild
1500+ (dmap, _evt) <- traverseIntMapWithKeyWithAdjust widget intMap $ leftmost [postBuildPatch <$ pb, replace]
1501+ liftIO $ dmap `H.shouldBe` intMap
1502+
1503+ session' "traverseDMapWithKeyWithAdjustWithMove" $ do
1504+ let widget :: DomBuilder t m => Key2 a -> Identity a -> m (Identity a)
1505+ widget k (Identity v) = elAttr "li" ("id" =: textKey2 k) $ do
1506+ elClass "span" "key" $ text $ textKey2 k
1507+ elClass "span" "value" $ text $ T.pack $ has @Show k $ show v
1508+ pure (Identity v)
1509+ textKey2 :: Key2 a -> Text
1510+ textKey2 = \case
1511+ Key2_Int i -> "i" <> T.pack (show i)
1512+ Key2_Char c -> "c" <> T.pack [c]
1513+ checkItem :: WD.Element -> Text -> Text -> WD ()
1514+ checkItem li k v = do
1515+ shouldContainTextNoRetry k =<< WD.findElemFrom li (WD.ByClass "key")
1516+ shouldContainTextNoRetry v =<< WD.findElemFrom li (WD.ByClass "value")
1517+ checkInitialItems dm xs = do
1518+ liftIO $ assertEqual "Wrong amount of items in DOM" (DMap.size dm) (length xs)
1519+ forM_ (zip xs (DMap.toList dm)) $ \(e, k :=> Identity v) -> checkItem e (textKey2 k) (T.pack $ has @Show k $ show v)
1520+ getAndCheckInitialItems dm = withRetry $ do
1521+ xs <- WD.findElems (WD.ByTag "li")
1522+ checkInitialItems dm xs
1523+ pure xs
1524+ moveSpec
1525+ :: (DMap Key2 Identity -> (WD.Element -> Chan (PatchDMapWithMove Key2 Identity) -> WD ()) -> WD ())
1526+ -> H.SpecM (WdTestSession ()) ()
1527+ moveSpec testMove = do
1528+ it "can insert an item" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 3 ==> 3]) $ \body chan -> do
1529+ shouldContainText (T.strip $ T.unlines ["i11","i33"]) body
1530+ liftIO $ writeChan chan (insertDMapKey (Key2_Int 2) 2)
1531+ shouldContainText (T.strip $ T.unlines ["i11","i22","i33"]) body
1532+ it "can delete an item" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 2 ==> 2, Key2_Int 3 ==> 3]) $ \body chan -> do
1533+ shouldContainText (T.strip $ T.unlines ["i11","i22","i33"]) body
1534+ liftIO $ writeChan chan (deleteDMapKey (Key2_Int 2))
1535+ shouldContainText (T.strip $ T.unlines ["i11","i33"]) body
1536+ it "can swap items" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 2 ==> 2, Key2_Int 3 ==> 3, Key2_Int 4 ==> 4]) $ \body chan -> do
1537+ shouldContainText (T.strip $ T.unlines ["i11","i22","i33","i44"]) body
1538+ liftIO $ writeChan chan (swapDMapKey (Key2_Int 2) (Key2_Int 3))
1539+ shouldContainText (T.strip $ T.unlines ["i11","i33","i22","i44"]) body
1540+-- TODO re-enable this
1541+-- it "can move items" $ runWD $ testMove (DMap.fromList [Key2_Int 1 ==> 1, Key2_Int 2 ==> 2, Key2_Int 3 ==> 3, Key2_Int 4 ==> 4]) $ \body chan -> do
1542+-- shouldContainText (T.strip $ T.unlines ["i11","i22","i33", "i44"]) body
1543+-- liftIO $ writeChan chan (moveDMapKey (Key2_Int 2) (Key2_Int 3))
1544+-- shouldContainText (T.strip $ T.unlines ["i11","i22","i44"]) body
1545+-- liftIO $ writeChan chan (moveDMapKey (Key2_Int 2) (Key2_Int 3)) -- attempt a move to nonexistent key should delete
1546+-- shouldContainText (T.strip $ T.unlines ["i11","i44"]) body
1547+-- liftIO $ writeChan chan (moveDMapKey (Key2_Int 2) (Key2_Int 3)) -- this causes a JSException in immediate builder too
1548+-- shouldContainText (T.strip $ T.unlines ["i11","i44"]) body
1549+-- liftIO $ writeChan chan (insertDMapKey (Key2_Int 2) 2) -- this step will fail if the above caused an exception, thus works as a proxy for detecting the exception given we can't catch it
1550+-- shouldContainText (T.strip $ T.unlines ["i11","i22","i44"]) body
1551+
1552+ describe "hydration" $ moveSpec $ \initMap test -> do
1553+ chan <- liftIO newChan
1554+ let preSwitchover = getAndCheckInitialItems initMap
1555+ check xs = do
1556+ checkInitialItems initMap xs
1557+ body <- getBody
1558+ test body chan
1559+ testWidget' preSwitchover check $ void $ do
1560+ (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
1561+ liftIO $ assertEqual "DMap" initMap dmap
1562+
1563+ describe "hydration/immediate" $ moveSpec $ \initMap test -> do
1564+ chan <- liftIO newChan
1565+ replace <- liftIO newChan
1566+ lock :: MVar () <- liftIO newEmptyMVar
1567+ let check = do
1568+ liftIO $ do
1569+ writeChan replace ()
1570+ takeMVar lock
1571+ xs <- getAndCheckInitialItems initMap
1572+ checkInitialItems initMap xs
1573+ body <- getBody
1574+ test body chan
1575+ testWidget (pure ()) check $ void $ do
1576+ e <- triggerEventWithChan replace
1577+ runWithReplace (pure ()) $ ffor e $ \() -> void $ do
1578+ pb <- getPostBuild
1579+ performEvent_ $ liftIO (putMVar lock ()) <$ pb
1580+ (dmap, _evt) <- traverseDMapWithKeyWithAdjustWithMove widget initMap =<< triggerEventWithChan chan
1581+ liftIO $ assertEqual "DMap" initMap dmap
1582+
1583+ session' "hydrating invalid HTML" $ do
1584+ xit "can hydrate list in paragraph" $ runWD $ do
1585+ let preSwitchover = do
1586+ checkBodyText "before\ninner\nafter"
1587+ -- Two <p> tags should be present
1588+ (p1, p2) <- WD.findElems (WD.ByTag "p") >>= \case
1589+ [p1, p2] -> pure (p1, p2)
1590+ _ -> error "Unexpected number of `p` tags (expected 2)"
1591+ ol <- findElemWithRetry (WD.ByTag "ol")
1592+ shouldContainText "before" p1
1593+ shouldContainText "inner" ol
1594+ shouldContainText "" p2
1595+ pure (p1, ol, p2)
1596+ check (p1, ol, p2) = do
1597+ checkBodyText "before\ninner\nafter"
1598+ shouldContainText "before\ninner\nafter" p1
1599+ elementShouldBeRemoved ol
1600+ elementShouldBeRemoved p2
1601+ -- Don't fail fatally when hydration encounters the invalid DOM
1602+ testWidgetDebug' False withDebugging preSwitchover check $ do
1603+ -- This is deliberately invalid HTML, the browser will interpret it as
1604+ -- <p>before</p><ol>inner</ol>after<p></p>
1605+ el "p" $ do
1606+ text "before"
1607+ el "ol" $ text "inner"
1608+ text "after"
1609+
1610+ -- TODO: This test presupposes the exact set of labels that "dropdown" places in the "value" fields to distinguish options.
1611+ -- This dependence on internal implementation details is undesirable in a test case, but seems fairly tricky to avoid.
1612+ -- It seems expedient for the time being to expect this test case to be updated, should those implementation details ever change.
1613+ session' "dropdown" $ do
1614+ let doTest expectedOpts (initialValue :: Text) = do
1615+ let doCheck = do
1616+ es <- findElemsWithRetry $ WD.ByTag "option"
1617+ opts <- mapM fetchElement es
1618+ assertEqual "missing/extra/incorrect option element(s)" expectedOpts (sort opts)
1619+ testWidget doCheck doCheck $ do
1620+ void $ dropdown initialValue (constDyn (("aa" :: Text) =: "aaa" <> "bb" =: "bbb")) def
1621+ fetchElement e = do
1622+ val <- WD.attr e "value"
1623+ sel <- WD.attr e "selected"
1624+ return (fromMaybe "" val, isJust sel)
1625+ -- The "aa" test case is important, but a good test implementation probably needs to avoid selenium, because HTML parsers will insert a "selected" attribute on the first "option" tag if no selected attributes are present; thus as written, this erroneously succeeds on the old implementation (but properly implemented, should fail)
1626+ -- Thus, it would appear that we do actually need a HTML5 or maybe XML parser for this test suite.
1627+ xit "statically renders initial values (on aa)" $ runWD $ do
1628+ doTest [("0",True),("1",False)] "aa"
1629+ -- These tests are currently marked "pending" (by using "xit" instead of "it") because this test has a high chance of non-deterministically failing, which is a problem elsewhere in this test suite as well
1630+ xit "statically renders initial values (on bb)" $ runWD $ do
1631+ doTest [("0",False),("1",True)] "bb"
1632+
1633+data Selenium = Selenium
1634+ { _selenium_portNumber :: PortNumber
1635+ , _selenium_stopServer :: IO ()
1636+ }
1637+
1638+startSeleniumServer :: PortNumber -> IO (IO ())
1639+startSeleniumServer port = do
1640+ (_,_,_,ph) <- createProcess $ (proc "selenium-server" ["-port", show port])
1641+ { std_in = NoStream
1642+ , std_out = NoStream
1643+ , std_err = NoStream
1644+ }
1645+ return $ terminateProcess ph
1646+
1647+withSeleniumServer :: (Selenium -> IO ()) -> IO ()
1648+withSeleniumServer f = do
1649+ stopServer <- startSeleniumServer seleniumPort
1650+ threadDelay $ 1000 * 1000 * 2 -- TODO poll or wait on a a signal to block on
1651+ f $ Selenium
1652+ { _selenium_portNumber = seleniumPort
1653+ , _selenium_stopServer = stopServer
1654+ }
1655+
1656+triggerEventWithChan :: (Reflex t, TriggerEvent t m, Prerender js t m) => Chan a -> m (Event t a)
1657+triggerEventWithChan chan = do
1658+ (e, trigger) <- newTriggerEvent
1659+ -- In prerender because we only want to do this on the client
1660+ prerender_ (pure ()) $ void $ liftIO $ forkIO $ forever $ trigger =<< readChan chan
1661+ pure e
1662+
1663+shouldBeWithRetryM :: (Eq a, Show a) => WD a -> a -> WD ()
1664+shouldBeWithRetryM m expected = withRetry $ do
1665+ got <- m
1666+ got `shouldBe` expected
1667+
1668+assertAttr :: WD.Element -> Text -> Maybe Text -> WD ()
1669+assertAttr e k v = liftIO . assertEqual "Incorrect attribute value" v =<< WD.attr e k
1670+
1671+elementShouldBeRemoved :: WD.Element -> WD ()
1672+elementShouldBeRemoved e = withRetry $ do
1673+ try (WD.getText e) >>= \case
1674+ Left (WD.FailedCommand WD.StaleElementReference _) -> return ()
1675+ Left err -> throwM err
1676+ Right !_ -> liftIO $ assertFailure "Expected element to be removed, but it still exists"
1677+
1678+shouldContainText :: Text -> WD.Element -> WD ()
1679+shouldContainText t = withRetry . shouldContainTextNoRetry t
1680+
1681+shouldContainTextNoRetry :: Text -> WD.Element -> WD ()
1682+shouldContainTextNoRetry t = flip shouldBe t <=< WD.getText
1683+
1684+checkBodyText :: Text -> WD ()
1685+checkBodyText = checkTextInTag "body"
1686+
1687+checkTextInTag :: Text -> Text -> WD ()
1688+checkTextInTag t expected = do
1689+ e <- findElemWithRetry (WD.ByTag t)
1690+ shouldContainText expected e
1691+
1692+checkTextInId :: Text -> Text -> WD ()
1693+checkTextInId i expected = do
1694+ e <- findElemWithRetry (WD.ById i)
1695+ shouldContainText expected e
1696+
1697+findElemWithRetry :: Selector -> WD WD.Element
1698+findElemWithRetry = withRetry . WD.findElem
1699+
1700+findElemsWithRetry :: Selector -> WD [WD.Element]
1701+findElemsWithRetry = withRetry . WD.findElems
1702+
1703+getBody :: WD WD.Element
1704+getBody = WD.findElem $ WD.ByTag "body"
1705+
1706+withRetry :: forall a. WD a -> WD a
1707+withRetry a = wait 300
1708+ where wait :: Int -> WD a
1709+ wait 0 = a
1710+ wait n = try a >>= \case
1711+ Left (e :: SomeException) -> do
1712+ liftIO $ putStrLn ("(retrying due to " <> show e <> ")") *> threadDelay 100000
1713+ wait $ n - 1
1714+ Right v -> return v
1715+
1716+divId :: DomBuilder t m => Text -> m a -> m a
1717+divId i = elAttr "div" ("id" =: i)
1718+
1719+type TestWidget js t m = (DomBuilder t m, MonadHold t m, PostBuild t m, Prerender js t m, PerformEvent t m, TriggerEvent t m, MonadFix m, MonadIO (Performable m), MonadIO m)
1720+
1721+testWidgetStaticDebug
1722+ :: Bool
1723+ -> WD b
1724+ -- ^ Webdriver commands to run before JS runs and after hydration switchover
1725+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1726+ -- ^ Widget we are testing
1727+ -> WD b
1728+testWidgetStaticDebug withDebugging w = testWidgetDebug True withDebugging (void w) w
1729+
1730+-- | TODO: do something about JSExceptions not causing tests to fail
1731+testWidgetDebug
1732+ :: Bool
1733+ -> Bool
1734+ -> WD ()
1735+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1736+ -> WD b
1737+ -- ^ Webdriver commands to run after hydration switchover
1738+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1739+ -- ^ Widget we are testing
1740+ -> WD b
1741+testWidgetDebug hardFailure withDebugging beforeJS afterSwitchover =
1742+ testWidgetDebug' hardFailure withDebugging beforeJS (const afterSwitchover)
1743+
1744+data HydrationFailedException = HydrationFailedException deriving Show
1745+instance Exception HydrationFailedException
1746+
1747+-- | TODO: do something about JSExceptions not causing tests to fail
1748+testWidgetDebug'
1749+ :: Bool
1750+ -> Bool
1751+ -> WD a
1752+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
1753+ -> (a -> WD b)
1754+ -- ^ Webdriver commands to run after hydration switchover
1755+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
1756+ -- ^ Widget we are testing (contents of body)
1757+ -> WD b
1758+testWidgetDebug' hardFailure withDebugging beforeJS afterSwitchover bodyWidget = do
1759+ let putStrLnDebug :: MonadIO m => Text -> m ()
1760+ putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
1761+ staticApp = do
1762+ el "head" $ pure ()
1763+ el "body" $ do
1764+ bodyWidget
1765+ el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
1766+ putStrLnDebug "rendering static"
1767+ ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
1768+ putStrLnDebug "rendered static"
1769+ waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
1770+ onFailure <- if hardFailure then (`throwTo` HydrationFailedException) <$> liftIO myThreadId else pure $ pure ()
1771+ waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
1772+ let entryPoint = do
1773+ putStrLnDebug "taking waitBeforeJS"
1774+ liftIO $ takeMVar waitBeforeJS
1775+ let switchOverAction = do
1776+ putStrLnDebug "switchover syncPoint"
1777+ syncPoint
1778+ putStrLnDebug "putting waitUntilSwitchover"
1779+ liftIO $ putMVar waitUntilSwitchover ()
1780+ putStrLnDebug "put waitUntilSwitchover"
1781+ putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
1782+ mainHydrationWidgetWithSwitchoverActionWithFailure' onFailure switchOverAction blank bodyWidget
1783+ putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
1784+ syncPoint
1785+ application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
1786+ putStrLnDebug "sending response"
1787+ r <- sendResponse $ responseLBS status200 [] $ "<!doctype html>\n" <> LBS.fromStrict html
1788+ putStrLnDebug "sent response"
1789+ return r
1790+ waitJSaddle <- liftIO newEmptyMVar
1791+ let settings = foldr ($) Warp.defaultSettings
1792+ [ Warp.setPort $ fromIntegral $ toInteger jsaddlePort
1793+ , Warp.setBeforeMainLoop $ do
1794+ putStrLnDebug "putting waitJSaddle"
1795+ putMVar waitJSaddle ()
1796+ putStrLnDebug "put waitJSaddle"
1797+ ]
1798+ -- hSilence to get rid of ConnectionClosed logs
1799+ silenceIfDebug = if withDebugging then id else hSilence [stderr]
1800+ jsaddleWarp = silenceIfDebug $ Warp.runSettings settings application
1801+ withAsync' jsaddleWarp $ do
1802+ putStrLnDebug "taking waitJSaddle"
1803+ liftIO $ takeMVar waitJSaddle
1804+ putStrLnDebug "opening page"
1805+ WD.openPage $ "http://localhost:" <> show jsaddlePort
1806+ putStrLnDebug "running beforeJS"
1807+ a <- beforeJS
1808+ putStrLnDebug "putting waitBeforeJS"
1809+ liftIO $ putMVar waitBeforeJS ()
1810+ putStrLnDebug "taking waitUntilSwitchover"
1811+ liftIO $ takeMVar waitUntilSwitchover
1812+ putStrLnDebug "running afterSwitchover"
1813+ afterSwitchover a
1814+
1815+withAsync' :: (MonadIO m, MonadMask m) => IO a -> m b -> m b
1816+withAsync' f g = bracket
1817+ (liftIO $ Async.async f)
1818+ (liftIO . Async.uninterruptibleCancel)
1819+ (const g)
1820+
1821+data Key2 a where
1822+ Key2_Int :: Int -> Key2 Int
1823+ Key2_Char :: Char -> Key2 Char
1824+
1825+deriveGEq ''Key2
1826+deriveGCompare ''Key2
1827+deriveGShow ''Key2
1828+deriveArgDict ''Key2
reflex-dom-test-selenium/CHANGELOG.mdnew file+5
@@ -0,0 +1,5 @@
1+# Revision history for reflex-dom-core-selenium
2+
3+## 0.1.0.0 -- YYYY-mm-dd
4+
5+* First version. Released on an unsuspecting world.
reflex-dom-test-selenium/LICENSEnew file+12
@@ -0,0 +1,12 @@
1+Copyright (c) 2020, Obsidian Systems LLC
2+All rights reserved.
3+
4+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5+
6+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7+
8+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
9+
10+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
11+
12+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
reflex-dom-test-selenium/Setup.hsnew file+2
@@ -0,0 +1,2 @@
1+import Distribution.Simple
2+main = defaultMain
reflex-dom-test-selenium/add-overrides.nixnew file+20
@@ -0,0 +1,20 @@
1+{ nixpkgs }: testPackage:
2+ nixpkgs.haskell.lib.overrideCabal testPackage
3+ (drv: {
4+
5+ # The headless browser run as part of the tests will exit without this
6+ preBuild = ''
7+ export HOME="$PWD"
8+ '';
9+
10+ testSystemDepends = with nixpkgs; (drv.testSystemDepends or []) ++ [
11+ selenium-server-standalone which
12+ chromium
13+ nixpkgs.iproute
14+ ];
15+
16+ # The headless browser run as part of gc tests would hang/crash without this
17+ preCheck = ''
18+ export FONTCONFIG_PATH=${nixpkgs.fontconfig.out}/etc/fonts
19+ '';
20+ })
reflex-dom-test-selenium/reflex-dom-test-selenium.cabalnew file+41
@@ -0,0 +1,41 @@
1+cabal-version: 1.24
2+Name: reflex-dom-test-selenium
3+Version: 0.0.0.1
4+Synopsis: Testing framework for selenium tests
5+Description:
6+License: BSD3
7+License-file: LICENSE
8+Author: Ryan Trinkle
9+Maintainer: ryan.trinkle@gmail.com
10+Stability: Experimental
11+Category: FRP, Web, GUI, HTML, Javascript, Reactive, Reactivity, User Interfaces, User-interface
12+Build-type: Simple
13+
14+library
15+ hs-source-dirs: src
16+ build-depends:
17+ async,
18+ base >= 4.7 && < 4.15,
19+ bytestring == 0.10.*,
20+ chrome-test-utils,
21+ exceptions,
22+ hspec-core,
23+ hspec-webdriver >= 1.2.1,
24+ http-types,
25+ jsaddle >= 0.9.0.0 && < 0.10,
26+ jsaddle-warp,
27+ network,
28+ process,
29+ reflex-dom-core,
30+ silently,
31+ text == 1.2.*,
32+ wai,
33+ warp,
34+ webdriver,
35+ websockets
36+
37+ exposed-modules:
38+ Reflex.Dom.Test.Selenium
39+
40+ default-language: Haskell98
41+ ghc-options: -Wall -fwarn-tabs -funbox-strict-fields -O2 -ferror-spans -fspecialise-aggressively
reflex-dom-test-selenium/src/Reflex/Dom/Test/Selenium.hsnew file+249
@@ -0,0 +1,249 @@
1+{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
4+{-# LANGUAGE OverloadedStrings #-}
5+{-# LANGUAGE RankNTypes #-}
6+{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE StandaloneDeriving #-}
8+{-# LANGUAGE TemplateHaskell #-}
9+
10+{-# OPTIONS_GHC -fno-warn-orphans #-}
11+
12+-- | Utilities for testing reflex-dom widgets with Selenium.
13+--
14+-- Any uses of the 'testWidget' functions will start a jsaddle warp server and
15+-- serve the given widget in an otherwise empty page. Webdriver commands can run
16+-- on the statically rendered page, and on the hydrated page.
17+module Reflex.Dom.Test.Selenium
18+ ( TestWidget
19+ , TestWidgetConfig (..)
20+ , testWidget, testWidget', testWidgetStatic, testWidgetHydrated
21+ , withSeleniumSpec
22+ , embedSpec
23+ , SeleniumSetupConfig (..)
24+ ) where
25+
26+import Control.Concurrent (threadDelay, newEmptyMVar, takeMVar, putMVar)
27+import Control.Exception (throwIO)
28+import Control.Monad (when)
29+import Control.Monad.Catch (MonadMask, handle)
30+import Control.Monad.Fix (MonadFix)
31+import Control.Monad.IO.Class (MonadIO, liftIO)
32+import Data.Text (Text)
33+import Language.Javascript.JSaddle
34+import Language.Javascript.JSaddle.Warp
35+import Network.HTTP.Types (status200)
36+import Network.Socket (PortNumber)
37+import Network.Wai (responseLBS)
38+import Network.WebSockets (defaultConnectionOptions)
39+import Reflex.Dom.Core
40+import System.IO (stderr)
41+import System.IO.Silently (hSilence)
42+import System.Process (std_in, std_out, std_err, createProcess, proc, StdStream (..), terminateProcess)
43+import Test.Hspec.WebDriver (Spec, SpecWith, WdTestSession, sessionWith, using)
44+import Test.Util.ChromeFlags
45+import Test.Util.UnshareNetwork
46+import Test.WebDriver (WD)
47+
48+import qualified Control.Concurrent.Async as Async
49+import qualified Data.ByteString.Lazy as LBS
50+import qualified Data.Text as T
51+import qualified Data.Text.Encoding as TE
52+import qualified Network.Wai.Handler.Warp as Warp
53+import qualified Test.Hspec.Core.Spec as Hspec
54+import qualified Test.WebDriver as WD
55+import qualified Test.WebDriver.Capabilities as WD
56+
57+deriving instance MonadMask WD
58+
59+data SeleniumSetupConfig = SeleniumSetupConfig
60+ { _seleniumSetupConfig_chromiumPath :: FilePath
61+ -- ^ Path to the chromium executable
62+ , _seleniumSetupConfig_headless :: Bool
63+ -- ^ True means that the browser is invoked in headless mode, False means that
64+ -- the user can see the interaction happening on the browser (useful for debugging).
65+ , _seleniumSetupConfig_seleniumPort :: PortNumber
66+ -- ^ The port number used by selenium
67+ }
68+
69+-- | Setup a selenium server and use it to run some hspec tests.
70+--
71+-- withSeleniumSpec config $ \runSession -> hspec $ do
72+-- describe "tests using webdriver session" $ runSession $ do
73+-- webdriver tests here
74+withSeleniumSpec :: SeleniumSetupConfig -> ((forall multi. SpecWith (WdTestSession multi) -> Spec) -> IO a) -> IO a
75+withSeleniumSpec config runSpec = do
76+ liftIO $ handle (\(_ :: IOError) -> return ()) $ unshareNetork -- If we run into an exception with sandboxing, just don't bother
77+ withSandboxedChromeFlags (_seleniumSetupConfig_headless config) $ \chromeFlags -> do
78+ withSeleniumServer (_seleniumSetupConfig_seleniumPort config) $ do
79+ let browserPath = T.strip $ T.pack $ _seleniumSetupConfig_chromiumPath config
80+ when (T.null browserPath) $ fail "No browser found"
81+ let wdConfig = WD.defaultConfig { WD.wdPort = fromIntegral $ _seleniumSetupConfig_seleniumPort config }
82+ chromeCaps' = WD.getCaps $ chromeConfig browserPath chromeFlags
83+ runSpec $ sessionWith wdConfig "" . using [(chromeCaps', "chrome")]
84+
85+startSeleniumServer :: PortNumber -> IO (IO ())
86+startSeleniumServer port = do
87+ (_,_,_,ph) <- createProcess $ (proc "selenium-server" ["-port", show port])
88+ { std_in = NoStream
89+ , std_out = NoStream
90+ , std_err = NoStream
91+ }
92+ return $ terminateProcess ph
93+
94+withSeleniumServer :: PortNumber -> IO a -> IO a
95+withSeleniumServer port f = bracket (startSeleniumServer port) id $ \_ -> do
96+ threadDelay $ 1000 * 1000 * 2 -- TODO poll or wait on a a signal to block on
97+ f
98+
99+chromeConfig :: Text -> [Text] -> WD.WDConfig
100+chromeConfig fp flags =
101+ WD.useBrowser
102+ (WD.chrome { WD.chromeBinary = Just $ T.unpack fp, WD.chromeOptions = T.unpack <$> flags })
103+ WD.defaultConfig
104+
105+--------------------------------------------------------------------------------
106+-- Function to test widgets
107+--------------------------------------------------------------------------------
108+
109+-- | The environment in which your widgets can be tested
110+type TestWidget js t m =
111+ (DomBuilder t m, MonadHold t m, PostBuild t m
112+ , Prerender js t m, PerformEvent t m, TriggerEvent t m
113+ , MonadFix m, MonadIO (Performable m), MonadIO m)
114+
115+-- | Configuration of individual tests
116+data TestWidgetConfig = TestWidgetConfig
117+ { _testWidgetConfig_debug :: Bool
118+ -- ^ If this flag is set to True, during the test we will emit debug messages
119+ , _testWidgetConfig_headWidget :: (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
120+ -- ^ We can add widgets here that will be included in the head of the page
121+ -- (useful for example to include external js libraries in the tests)
122+ , _testWidgetConfig_jsaddlePort :: PortNumber
123+ -- ^ Port used by the jsaddle server
124+ }
125+
126+-- | Test a widget by running some webdriver commands before and after
127+-- hydration.
128+testWidget
129+ :: TestWidgetConfig
130+ -> WD a
131+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
132+ -> WD b
133+ -- ^ Webdriver commands to run after hydration switchover
134+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
135+ -- ^ Widget we are testing (contents of body)
136+ -> WD b
137+testWidget cfg before after widget = testWidget' cfg before (const after) widget
138+
139+-- | Test a widget by running some webdriver commands before hydration (on the
140+-- statically rendered page).
141+testWidgetStatic
142+ :: TestWidgetConfig
143+ -> WD a
144+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
145+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
146+ -- ^ Widget we are testing (contents of body)
147+ -> WD a
148+testWidgetStatic cfg before widget = testWidget' cfg before pure widget
149+
150+-- | Test a widget by running some webdriver commands after hydration.
151+testWidgetHydrated
152+ :: TestWidgetConfig
153+ -> WD b
154+ -- ^ Webdriver commands to run after hydration switchover
155+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
156+ -- ^ Widget we are testing (contents of body)
157+ -> WD b
158+testWidgetHydrated cfg after widget = testWidget' cfg (pure ()) (const after) widget
159+
160+-- | Test a widget by running some webdriver commands before and after
161+-- hydration. Like 'testWidget', but you can use the result of the webdriver
162+-- commands from before hydration in the post hydration test.
163+testWidget'
164+ :: TestWidgetConfig
165+ -> WD a
166+ -- ^ Webdriver commands to run before the JS runs (i.e. on the statically rendered page)
167+ -> (a -> WD b)
168+ -- ^ Webdriver commands to run after hydration switchover
169+ -> (forall m js. TestWidget js (SpiderTimeline Global) m => m ())
170+ -- ^ Widget we are testing (contents of body)
171+ -> WD b
172+testWidget' (TestWidgetConfig withDebugging headWidget jsaddlePort) beforeJS afterSwitchover bodyWidget = do
173+ let putStrLnDebug :: MonadIO m => Text -> m ()
174+ putStrLnDebug m = when withDebugging $ liftIO $ putStrLn $ T.unpack m
175+ staticApp = do
176+ el "head" $ headWidget
177+ el "body" $ do
178+ bodyWidget
179+ el "script" $ text $ TE.decodeUtf8 $ LBS.toStrict $ jsaddleJs False
180+ putStrLnDebug "rendering static"
181+ ((), html) <- liftIO $ renderStatic $ runHydratableT staticApp
182+ putStrLnDebug "rendered static"
183+ waitBeforeJS <- liftIO newEmptyMVar -- Empty until JS should be run
184+ waitUntilSwitchover <- liftIO newEmptyMVar -- Empty until switchover
185+ let entryPoint = do
186+ putStrLnDebug "taking waitBeforeJS"
187+ liftIO $ takeMVar waitBeforeJS
188+ let switchOverAction = do
189+ putStrLnDebug "switchover syncPoint"
190+ syncPoint
191+ putStrLnDebug "putting waitUntilSwitchover"
192+ liftIO $ putMVar waitUntilSwitchover ()
193+ putStrLnDebug "put waitUntilSwitchover"
194+ putStrLnDebug "running mainHydrationWidgetWithSwitchoverAction"
195+ mainHydrationWidgetWithSwitchoverAction switchOverAction blank bodyWidget
196+ putStrLnDebug "syncPoint after mainHydrationWidgetWithSwitchoverAction"
197+ syncPoint
198+ application <- liftIO $ jsaddleOr defaultConnectionOptions entryPoint $ \_ sendResponse -> do
199+ putStrLnDebug "sending response"
200+ r <- sendResponse $ responseLBS status200 [] $ "<!doctype html>\n" <> LBS.fromStrict html
201+ putStrLnDebug "sent response"
202+ return r
203+ waitJSaddle <- liftIO newEmptyMVar
204+ let settings = foldr ($) Warp.defaultSettings
205+ [ Warp.setPort $ fromIntegral $ toInteger jsaddlePort
206+ , Warp.setBeforeMainLoop $ do
207+ putStrLnDebug "putting waitJSaddle"
208+ putMVar waitJSaddle ()
209+ putStrLnDebug "put waitJSaddle"
210+ ]
211+ -- hSilence to get rid of ConnectionClosed logs
212+ silenceIfNotDebugging = if withDebugging then id else hSilence [stderr]
213+ jsaddleWarp = silenceIfNotDebugging $ Warp.runSettings settings application
214+ withAsync' jsaddleWarp $ do
215+ putStrLnDebug "taking waitJSaddle"
216+ liftIO $ takeMVar waitJSaddle
217+ putStrLnDebug "opening page"
218+ WD.openPage $ "http://localhost:" <> show jsaddlePort
219+ putStrLnDebug "running beforeJS"
220+ a <- beforeJS
221+ putStrLnDebug "putting waitBeforeJS"
222+ liftIO $ putMVar waitBeforeJS ()
223+ putStrLnDebug "taking waitUntilSwitchover"
224+ liftIO $ takeMVar waitUntilSwitchover
225+ putStrLnDebug "running afterSwitchover"
226+ afterSwitchover a
227+
228+--------------------------------------------------------------------------------
229+-- Utilities
230+--------------------------------------------------------------------------------
231+
232+-- | Embed a different spec type by evaluating it directly.
233+embedSpec :: (Hspec.Example a, MonadIO m) => Hspec.Arg a -> a -> m ()
234+embedSpec arg spec = liftIO $ do
235+ Hspec.Result _info status <- Hspec.evaluateExample
236+ spec
237+ Hspec.defaultParams
238+ (\actionWith -> actionWith arg)
239+ (\_ -> pure ())
240+ case status of
241+ Hspec.Success -> pure ()
242+ Hspec.Pending _ _ -> pure () -- should not happen
243+ failure -> throwIO failure
244+
245+withAsync' :: (MonadIO m, MonadMask m) => IO a -> m b -> m b
246+withAsync' f g = bracket
247+ (liftIO $ Async.async f)
248+ (liftIO . Async.uninterruptibleCancel)
249+ (const g)
reflex-dom/ChangeLog.mdnew file+42
@@ -0,0 +1,42 @@
1+# Revision history for reflex-dom
2+
3+## 0.6.1.0-r1
4+
5+* Loosen reflex-dom-core version bounds
6+
7+## 0.6.1.0
8+
9+* Update for new dependent-map and dependent-sum (after the "some" package split)
10+
11+## 0.6.0.0
12+
13+* ([#379](https://github.com/reflex-frp/reflex-dom/pull/379)) Re-export all modules from `reflex-dom-core`. The newly re-exported modules are:
14+ * `Foreign.JavaScript.Utils`
15+ * `Reflex.Dom.Builder.Hydratable`
16+ * `Reflex.Dom.Modals.Class`
17+ * `Reflex.Dom.Prerender`
18+ * `Reflex.Dom.Time`
19+ * `Reflex.Dom.WebSocket.Query`
20+ * `Reflex.Dom.Xhr.FormData`
21+* ([#366](https://github.com/reflex-frp/reflex-dom/pull/366)) Bump bounds for `reflex` to include 0.7.
22+
23+## 0.5.3
24+
25+* On Android, enable prompting the user for geolocation
26+ permissions on demand by default. See
27+ https://developer.android.com/reference/android/webkit/WebChromeClient.html#onGeolocationPermissionsShowPrompt(java.lang.String,%20android.webkit.GeolocationPermissions.Callback)
28+ for details.
29+
30+ * Add `< 0.7` upper bound for reflex
31+
32+## 0.5.2
33+
34+* The default jsaddle backend on macOS when built from nix
35+ is now jsaddle-wkwebview, matching the behaviour of cabal
36+ builds.
37+
38+## 0.5
39+
40+* Re-export new hydration widget "mainWidget" functions.
41+
42+* The use-warp flag now properly takes precedence on macOS.
reflex-dom/LICENSE+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2015, Obsidian Systems LLC
1+Copyright (c) 2020, Obsidian Systems LLC
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−35
@@ -1,35 +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 ? "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.isDarwin then [
19− jsaddle-wkwebview
20− jsaddle-warp
21− ] else if isAndroid then [
22− jsaddle-clib
23− android-activity
24− ] else [
25− ghcBackendPackage
26− ]);
27− configureFlags = if isAndroid then [
28− "-fandroid"
29− ] else if ghcBackend == "warp" then [
30− "-fuse-warp"
31− ] else [
32− ];
33− description = "Functional Reactive Web Apps with Reflex";
34− license = stdenv.lib.licenses.bsd3;
35−}
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) {
51− wv.evaluateJavascript(initialJS, null);
55+ Log.i("reflex", "onPageFinished");
56+ boolean alreadyLoaded = jsaddleLoaded.getAndSet(true);
57+ if(!alreadyLoaded) {
58+ Log.i("reflex", "loading jsaddle");
59+ wv.evaluateJavascript(initialJS, null);
60+ }
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://")) {
82− view.getContext().startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(url)));
91+ try {
92+ view.getContext().startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse(url)));
93+ }
94+ catch(ActivityNotFoundException e) {
95+ Log.e("reflex", "Starting activity for intent '" + url + "' failed!");
96+ }
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
4−Description: Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine
5+Description:
6+ Web applications without callbacks or side-effects.
7+ Reflex-DOM brings the power of functional reactive programming (FRP) to the web.
8+ Build HTML and other Document Object Model (DOM) data with a pure functional interface.
9+ .
10+ Reflex-DOM is a Functional Reactive web framework based on the Reflex FRP engine: <https://reflex-frp.org/>.
11+ .
12+ The @reflex-dom@ package is a small wrapper around the @reflex-dom-core@ package. It pulls in the
13+ correct set of dependencies for each target platform (GHCJS, WebKitGTK, WASM, mobile, etc.).
14+ Libraries should depend on @reflex-dom-core@ and executables will usually depend on @reflex-dom@.
15+ All of @reflex-dom-core@'s modules are re-exported by @reflex-dom@.
16+ .
17+ For Hackage documentation, please see: <https://hackage.haskell.org/package/reflex-dom-core>.
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
25+extra-source-files:
13−-- Deal with https://github.com/haskell/cabal/issues/2544 / https://github.com/haskell/cabal/issues/367
26+ java/org/reflexfrp/reflexdom/MainWidget.java
14−extra-source-files: src/Reflex/Dom/Xhr/Foreign.hs
27+ ChangeLog.md
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
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.11,
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,
83+ jsaddle-warp >= 0.9.6 && < 0.10
74− jsaddle-wkwebview
75 else
84 else
76− if flag(use-warp)
85+ if os(osx) || os(ios)
77 build-depends:
86 build-depends:
78− jsaddle,
87+ data-default == 0.7.*,
79− jsaddle-warp
88+ jsaddle >= 0.9.6 && < 0.10,
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+42−12
@@ -1,21 +1,27 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2+{-# LANGUAGE LambdaCase #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE RankNTypes #-}
4{-# LANGUAGE RankNTypes #-}
4{-# LANGUAGE TypeFamilies #-}
5{-# LANGUAGE TypeFamilies #-}
5module Reflex.Dom.Internal
6module Reflex.Dom.Internal
6− (module Main, run, mainWidget, mainWidgetWithHead, mainWidgetWithCss,
7+ ( module Main
7− mainWidgetWithHead', mainWidgetInElementById, runApp') where
8+ , run
9+ , mainWidget
10+ , mainWidgetWithHead, mainWidgetWithCss, mainWidgetWithHead', mainWidgetInElementById, runApp'
11+ , mainHydrationWidgetWithHead, mainHydrationWidgetWithHead'
12+ ) where
8
13
9import Data.ByteString (ByteString)
14import Data.ByteString (ByteString)
10import Data.Text (Text)
15import Data.Text (Text)
11−import Reflex.Spider (Spider)
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
@@ -33,15 +39,26 @@ run jsm = do
33 putStrLn $ "Running jsaddle-warp server on port " <> show port
39 putStrLn $ "Running jsaddle-warp server on port " <> show port
34 JW.run port jsm
40 JW.run port jsm
35#elif defined(MIN_VERSION_jsaddle_wkwebview)
41#elif defined(MIN_VERSION_jsaddle_wkwebview)
36−import Language.Javascript.JSaddle.WKWebView (runFile)
42+#if defined(ios_HOST_OS)
43+import Data.Default
44+import Data.Monoid ((<>))
37import Language.Javascript.JSaddle (JSM)
45import Language.Javascript.JSaddle (JSM)
38−import Data.Default (def)
46+import Language.Javascript.JSaddle.WKWebView (run', mainBundleResourcePath)
47+import Language.Javascript.JSaddle.WKWebView.Internal (jsaddleMainHTMLWithBaseURL)
39
48
40−--TODO: Eliminate this; it is needed because otherwise the app's base
49+-- TODO: upstream to jsaddle-wkwebview
41−--URL will be set to "about:blank" due to jsaddleMain rather than
42−--jsaddleMainFile being used
43run :: JSM () -> IO ()
50run :: JSM () -> IO ()
44−run = runFile "index.html" "" def
51+run jsm = do
52+ let indexHtml = "<!DOCTYPE html><html><head></head><body></body></html>"
53+ baseUrl <- mainBundleResourcePath >>= \case
54+ Nothing -> do
55+ putStrLn "Reflex.Dom.run: unable to find main bundle resource path. Assets may not load properly."
56+ return ""
57+ Just p -> return $ "file://" <> p <> "/index.html"
58+ run' def $ jsaddleMainHTMLWithBaseURL indexHtml baseUrl jsm
59+#else
60+import Language.Javascript.JSaddle.WKWebView (run)
61+#endif
45#elif defined(ANDROID)
62#elif defined(ANDROID)
46import Android.HaskellActivity
63import Android.HaskellActivity
47import Control.Monad
64import Control.Monad
@@ -63,6 +80,11 @@ run jsm = do
63 startMainWidget a startPage jsm
80 startMainWidget a startPage jsm
64 }
81 }
65 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
66#else
88#else
67import Language.Javascript.JSaddle.WebKitGTK (run)
89import Language.Javascript.JSaddle.WebKitGTK (run)
68#endif
90#endif
@@ -87,6 +109,14 @@ mainWidgetInElementById :: Text -> (forall x. Widget x ()) -> IO ()
87mainWidgetInElementById eid w = run $ Main.mainWidgetInElementById eid w
109mainWidgetInElementById eid w = run $ Main.mainWidgetInElementById eid w
88{-# INLINE mainWidgetInElementById #-}
110{-# INLINE mainWidgetInElementById #-}
89
111
90−runApp' :: (t ~ Spider) => (forall x. AppInput t -> Widget x (AppOutput t)) -> IO ()
112+runApp' :: (forall x. AppInput DomTimeline -> Widget x (AppOutput DomTimeline)) -> IO ()
91runApp' app = run $ Main.runApp' app
113runApp' app = run $ Main.runApp' app
92{-# 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)