master..9e69a03 · obelisk

.github/pull_request_template.md−2

since splitsnapshots

unifiedsplit

@@ -3,8 +3,6 @@

3I have:

4

5 - [ ] Based work on latest `develop` branch

6− - [ ] Followed the [contribution guide](https://github.com/obsidiansystems/obelisk/blob/develop/CONTRIBUTING.md#submitting-changes)

7 - [ ] Looked for lint in my changes with `hlint .` (lint found code you did not write can be left alone)

6 - [ ] Looked for lint in my changes with `hlint .` (lint found code you did not write can be left alone)

8 - [ ] Run the test suite: `$(nix-build -A selftest --no-out-link)`

7 - [ ] Run the test suite: `$(nix-build -A selftest --no-out-link)`

9− - [ ] [Updated the changelog](https://github.com/obsidiansystems/obelisk/blob/develop/CONTRIBUTING.md#in-the-changelog)

10 - [ ] (Optional) Run CI tests locally: `nix-build release.nix -A build.x86_64-linux --no-out-link` (or `x86_64-darwin` on macOS)

8 - [ ] (Optional) Run CI tests locally: `nix-build release.nix -A build.x86_64-linux --no-out-link` (or `x86_64-darwin` on macOS)

CONTRIBUTING.md−52

@@ -8,7 +8,6 @@ Contributions and issue reports are encouraged and appreciated!

8 - [Guidelines for Pull Requests](#guidelines-for-pull-requests)

9 - [Code Quality](#code-quality)

10 - [Documentation](#documentation)

11−- [Development Environment](#development-environment)

12

11

13## Opening Issues

12## Opening Issues

14

13

@@ -40,7 +39,6 @@ For breaking changes, new features, refactors, or other major changes, the body

40

39

41Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.

40Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.

42

41

43−

44### Code Quality

42### Code Quality

45

43

46#### Warnings

44#### Warnings

@@ -79,53 +77,3 @@ Add an entry to the changelog when your PR:

79#### In the [Readme](README.md)

77#### In the [Readme](README.md)

80The 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.

78The 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.

81

79

82−

83−## Development Environment

84−

85−There are two ways to get live compiler feedback while developing Obelisk libraries. For libraries that are dependencies of the `skeleton` application, the easiest way to get feedback is to

86−

87−```bash

88−cd skeleton

89−ob run

90−```

91−

92−This `ob run` session only loads modules that are dependencies of the skeleton and `obelisk-run`. For example, `obelisk-asset` and `obelisk-route` are used by the skeleton.

93−

94−For other libraries like `obelisk-command` you can use `ghcid`. To launch `ghcid` for `lib/command` you can run

95−

96−```bash

97−nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid"

98−```

99−

100−### Building `ob` for testing

101−

102−To re-install `ob` from source globally you can do

103−

104−```bash

105−nix-env -f /path/to/obelisk -iA command

106−```

107−

108−You can also open a shell with the local version of `ob` available on your `$PATH`:

109−

110−```bash

111−nix run -f /path/to/obelisk command

112−```

113−

114−### Hacking on Obelisk from within an Obelisk project

115−

116−`ob` will defer to the version found in your project's `.obelisk/impl` directory. To work on that version specifically:

117−

118−```bash

119−ob thunk unpack ./.obelisk/impl

120−cd ./.obelisk/impl

121−# apply your changes

122−```

123−

124−If you want to commit your changes, first push them to your fork of obelisk and then

125−

126−```bash

127−cd /your/project/root

128−ob thunk pack .obelisk/impl

129−git add .obelisk/impl

130−git commit -m "Bump obelisk"

131−```

ChangeLog.md+4−30

@@ -2,46 +2,20 @@

2

3This project's release branch is `master`. This log is written from the perspective of the release branch: when changes hit `master`, they are considered released.

4

5−## v0.9.1.0

5+## Unreleased

6

7−* [#801](https://github.com/obsidiansystems/obelisk/pull/801): Remove errors and warning for local packages without a library component

8−* [#812](https://github.com/obsidiansystems/obelisk/pull/812): Add support for `NoImplicitPrelude` and other extensions disabled via `No`

9−* Pinned version bumps:

10− * reflex-platform [0.7.0.0](https://github.com/reflex-frp/reflex-platform/releases/tag/v0.7.0.0)

11− * hnix 0.8.0

12−* [#787](https://github.com/obsidiansystems/obelisk/pull/787): Set `immutable` cache control directive when serving content-addressed static assets

13−* Use iOS SDK 13.2

14−

15−

16−## v0.9.0.1

17−

18−* ([#810](https://github.com/obsidiansystems/obelisk/pull/810)) Fix loading of `all.js` in fully compiled web apps.

19−

20−## v0.9.0.0

21−

22−* **(Breaking change)** Backport nixpkgs upgrades to ACME/Let's Encrypt handling so that HTTPS deployments continue to work flawlessly. If your deployment is having trouble renewing [Let's Encrypt](https://letsencrypt.org/) certificates, upgrade to this version.

23− * **IMPORTANT:** In order to use [Let's Encrypt](https://letsencrypt.org/) you must now accept their [terms of service](https://letsencrypt.org/repository/). To do that, add `terms.security.acme.acceptTerms = true;` to the `import ./.obelisk/impl {` section in your `default.nix`. The new skeleton application may serve as an [example](https://github.com/obsidiansystems/obelisk/blob/4759342ab3570888c027d4c58cb5694cb832d624/skeleton/default.nix#L13).

24−* Update reflex-platform dependency to v0.6.0.0

25* ([#715](https://github.com/obsidiansystems/obelisk/pull/715)) In `Obelisk.Route` deprecate `isoEncoder` and `prismEncoder` in favor of more precisely named `viewEncoder` and `reviewEncoder` (respectively) and improve documentation regarding contravariance of `reviewEncoder`.

7* ([#715](https://github.com/obsidiansystems/obelisk/pull/715)) In `Obelisk.Route` deprecate `isoEncoder` and `prismEncoder` in favor of more precisely named `viewEncoder` and `reviewEncoder` (respectively) and improve documentation regarding contravariance of `reviewEncoder`.

26−* ([#739](https://github.com/obsidiansystems/obelisk/pull/739)) Improve `ob shell` by allowing commands to be passed verbatim after a `--` argument. For example, `ob shell 'run command'` can now be written `ob shell -- run command`.

27−* ([#735](https://github.com/obsidiansystems/obelisk/pull/735)) Fix regression causing custom `Prelude`s to break `ob run`/`ob watch`/`ob repl`.

28−* ([#737](https://github.com/obsidiansystems/obelisk/pull/737)) Fix bug causing custom `Prelude`s to break `ob profile`.

29−* ([#752](https://github.com/obsidiansystems/obelisk/pull/752)) Fix the `ob` command-line tool to return non-zero exit code when underlying processes fail.

30−* ([#742](https://github.com/obsidiansystems/obelisk/pull/742), [#57](https://github.com/obsidiansystems/obelisk/pull/57), [#406](https://github.com/obsidiansystems/obelisk/pull/406)) Enable `-dedupe` and `-DGHCJS_BROWSER` in GHCJS builds to make JavaScript output considerably smaller leading to faster load/parse times and faster build times.

31− * **Migration:** New Obelisk projects will automatically benefit from this change, but existing projects need to apply a change similar to [this one](https://github.com/obsidiansystems/obelisk/blob/371cb3302085601c5ec73e9574d51c8b95e3e493/skeleton/frontend/frontend.cabal#L32-L34).

32−* ([#742](https://github.com/obsidiansystems/obelisk/pull/742)) Update `reflex-platform` which includes:

33− * A new version of GHCJS where `-dedupe` is fixed.

34

8

35## v0.8.0.0

9## v0.8.0.0

36

10

37−* ([#674](https://github.com/obsidiansystems/obelisk/pull/674), [#711](https://github.com/obsidiansystems/obelisk/pull/711)) Introduce a new thunk format to support accessing the thunk's source directly when packed. When packed, thunks have an additional file called `thunk.nix` and `default.nix` is now a thin wrapper around that.

11+* ([#674](https://github.com/obsidiansystems/obelisk/pull/674), [#711](https://github.com/obsidiansystems/obelisk/pull/711)) Introduce a new thunk format to support accessing the thunk's source directly when packed. When packed, thunks have an additional file called `thunk.nix` and `default.nix` is now a think wrapper around that.

38* ([#665](https://github.com/obsidiansystems/obelisk/pull/665)) Add `--interpret` and `--no-interpret` options to `ob run`/`ob watch`/`ob repl`/`ob shell`. These options allow you to pick which paths will be pre-compiled by `nix` when entering the shell/session and which won't. For example `ob run --no-interpret dep` will ensure that any dependencies found in `./dep` will be built by `nix` before loading the rest of the project into the `ghci` session. The same configuration for `ob shell` will ensure that those packages are built and available in the `ghc` package database inside the shell.

12* ([#665](https://github.com/obsidiansystems/obelisk/pull/665)) Add `--interpret` and `--no-interpret` options to `ob run`/`ob watch`/`ob repl`/`ob shell`. These options allow you to pick which paths will be pre-compiled by `nix` when entering the shell/session and which won't. For example `ob run --no-interpret dep` will ensure that any dependencies found in `./dep` will be built by `nix` before loading the rest of the project into the `ghci` session. The same configuration for `ob shell` will ensure that those packages are built and available in the `ghc` package database inside the shell.

39

13

40 **NOTE:** `ob shell`'s default behavior is now different. By default it now behaves like `ob run`/`ob watch`/`ob repl` in that it does *not* pre-build any packages whose `.cabal` or `package.yaml` files are found in the project. To regain the previous behavior, use `ob shell --no-interpret . --interpret backend --interpret common --interpret frontend` from the project root.

14 **NOTE:** `ob shell`'s default behavior is now different. By default it now behaves like `ob run`/`ob watch`/`ob repl` in that it does *not* pre-build any packages whose `.cabal` or `package.yaml` files are found in the project. To regain the previous behavior, use `ob shell --no-interpret . --interpret backend --interpret common --interpret frontend` from the project root.

41* ([#695](https://github.com/obsidiansystems/obelisk/pull/695)) `ob deploy init` now requires that your obelisk project be a clean `git` checkout with pushed changes. It has always required that your obelisk project be a `git` repository, but it did not require that your local changes be committed and pushed. This new requirement is added to ensure users don't accidentally create a deployment pointing to an old version of the project.

15* ([#695](https://github.com/obsidiansystems/obelisk/pull/695)) `ob deploy init` now requires that your obelisk project be a clean `git` checkout with pushed changes. It has always required that your obelisk project be a `git` repository, but it did not require that your local changes be committed and pushed. This new requirement is added to ensure users don't accidentally create a deployment pointing to an old version of the project.

42* ([#705](https://github.com/obsidiansystems/obelisk/pull/705)) Add `Obelisk.Route.packTextEncoder` and generalize `Obelisk.Route.unpackTextEncoder` over any `Data.Text.Lens.IsText`.

16* ([#705](https://github.com/obsidiansystems/obelisk/pull/705)) Add `Obelisk.Route.packTextEncoder` and generalize `Obelisk.Route.unpackTextEncoder` over any `Data.Text.Lens.IsText`.

43* ([#712](https://github.com/obsidiansystems/obelisk/pull/712)) Update [`reflex-platform`](https://github.com/reflex-frp/reflex-platform) to version 0.5.3.0.

17* ([#712](https://github.com/obsidiansystems/obelisk/pull/712)) Update [`reflex-platform`](https://github.com/reflex-frp/reflex-platform) to version 0.5.3.0.

44−* ([#700](https://github.com/obsidiansystems/obelisk/pull/700)) Ensure `ob init` uses the thunk format of the target obelisk rather than the one currently running the init command. If a user had installed a version of obelisk with a new thunk format, a newly initialized skeleton of an older version would not be able to unpack its own `.obelisk/impl`.

18+* ([#700](https://github.com/obsidiansystems/obelisk/pull/700)) Ensure `ob init` uses the thunk format of the target obelisk rather than the one currently running the init command. If a user had installed a version of obelisk with a new thunk format, a newly initialized skeleton of an older version would not be able to unpack it's own `.obelisk/impl`.

45* ([#693](https://github.com/obsidiansystems/obelisk/pull/693)) Fix a bug where some packages in `.attr-cache` directories would be incorrectly picked up and used instead of the correct ones when using `ob run`/`ob watch`/`ob repl`.

19* ([#693](https://github.com/obsidiansystems/obelisk/pull/693)) Fix a bug where some packages in `.attr-cache` directories would be incorrectly picked up and used instead of the correct ones when using `ob run`/`ob watch`/`ob repl`.

46* ([#709](https://github.com/obsidiansystems/obelisk/pull/709)) Fix a bug in obelisk's preprocessor causing it to incorrectly skip files in some circumstances.

20* ([#709](https://github.com/obsidiansystems/obelisk/pull/709)) Fix a bug in obelisk's preprocessor causing it to incorrectly skip files in some circumstances.

47* ([#663](https://github.com/obsidiansystems/obelisk/pull/663)) Add **experimental** support for [`ghcide`](https://github.com/digital-asset/ghcide). See the README for more information.

21* ([#663](https://github.com/obsidiansystems/obelisk/pull/663)) Add **experimental** support for [`ghcide`](https://github.com/digital-asset/ghcide). See the README for more information.

@@ -92,7 +66,7 @@ This project's release branch is `master`. This log is written from the perspect

92* Improve error messaging when a dependency doesn't have the expected `.cabal` or `package.yaml` file. ([#597](https://github.com/obsidiansystems/obelisk/pull/597))

66* Improve error messaging when a dependency doesn't have the expected `.cabal` or `package.yaml` file. ([#597](https://github.com/obsidiansystems/obelisk/pull/597))

93* Improve the skeleton in small ways. ([#593](https://github.com/obsidiansystems/obelisk/pull/593), [#589](https://github.com/obsidiansystems/obelisk/pull/589))

67* Improve the skeleton in small ways. ([#593](https://github.com/obsidiansystems/obelisk/pull/593), [#589](https://github.com/obsidiansystems/obelisk/pull/589))

94* Fix `ob` commands to again support running from any subdirectory of an obelisk project ([#591](https://github.com/obsidiansystems/obelisk/pull/591))

68* Fix `ob` commands to again support running from any subdirectory of an obelisk project ([#591](https://github.com/obsidiansystems/obelisk/pull/591))

95−* Add `reflex-platform-func` argument to Obelisk's `default.nix`. It defaults to its prior behavior of using the reflex-platform in in `dep`. ([#612](https://github.com/obsidiansystems/obelisk/pull/612))

69+* Add `reflex-platform-func` argument to Obelisk's `default.nix`. It defaults to it's prior behavior of using the reflex-platform in in `dep`. ([#612](https://github.com/obsidiansystems/obelisk/pull/612))

96

70

97## v0.3.0.0 - 2019-12-20

71## v0.3.0.0 - 2019-12-20

98

72

FAQ.md+67−62

@@ -1,70 +1,14 @@

1# Frequently Asked Questions

2

3−1. [How do I declare a new Haskell dependency?](#how-do-i-declare-a-new-haskell-dependency)

4−1. [How do I add or override Haskell dependencies in the package set?](#how-do-i-add-or-override-haskell-dependencies-in-the-package-set)

5−1. [How do I extend my Obelisk application with more local packages?](#how-do-i-extend-my-obelisk-application-with-more-local-packages)

6−1. [How do I use `ob run` over HTTPS?](#how-do-i-use-ob-run-over-https)

7−1. [How do I fix invalid entitlements?](#how-do-i-fix-invalid-entitlements)

3+1. [How do I fix invalid entitlements? ](#how-do-i-fix-invalid-entitlements)

81. [`ob thunk update` or `ob deploy update` fails](#ob-thunk-update-or-ob-deploy-update-fails)

41. [`ob thunk update` or `ob deploy update` fails](#ob-thunk-update-or-ob-deploy-update-fails)

91. [How do I fix `Ambiguous module name` errors?](#how-do-i-fix-ambiguous-module-name-errors)

51. [How do I fix `Ambiguous module name` errors?](#how-do-i-fix-ambiguous-module-name-errors)

10−

6+1. [What does `ob run` actually do?](#what-does-ob-run-actually-do)

11−### How do I declare a new Haskell dependency?

12−

13−Every component of your Obelisk application is a standard [cabal](https://www.haskell.org/cabal/) package. That means declaring new Haskell dependencies simply involves updating the `build-depends` field in the appropriate cabal file (`backend.cabal` for example). By default, Obelisk will use its curated package set to choose which version of each package you get. It's possible that the package you need is not already in the curated set or the curated version isn't the one you want. See [How do I add or override Haskell dependencies in the package set?](#how-do-i-add-or-override-haskell-dependencies-in-the-package-set) for a solution to this.

14−

15−### How do I add or override Haskell dependencies in the package set?

16−

17−To add a Haskell package that doesn't exist in Obelisk's package set or to override the version of a package, use the `overrides` attribute in your project's `default.nix`. For example, to use a specific version of the `aeson` package fetched from GitHub and a specific version of the `waargonaut` package fetched from Hackage, your `default.nix` will look like:

18−

19−```nix

20−# ...

21−project ./. ({ pkgs, ... }: {

22−# ...

23− overrides = self: super: let

24− aesonSrc = pkgs.fetchFromGitHub {

25− owner = "obsidiansystems";

26− repo = "aeson-gadt-th";

27− rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";

28− sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";

29− };

30− in

31− {

32− aeson = self.callCabal2nix "aeson" aesonSrc {};

33− waargonaut = self.callHackageDirect {

34− pkg = "waargonaut";

35− ver = "0.8.0.1";

36− sha256 = "1zv28np3k3hg378vqm89v802xr0g8cwk7gy3mr77xrzy5jbgpa39";

37− } {};

38− };

39−# ...

40−```

41−

42−For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs "Contributors Guide".

43−

44−### How do I extend my Obelisk application with more local packages?

45−

46−If the standard packages (`frontend`, `backend`, and `common`) are not enough, you may add more local packages by defining them with the `packages` attribute in your `default.nix`. The sources of these packages will be automatically loaded by `ob run`/`ob repl`/etc.

47−

48−```nix

49−# ...

50−project ./. ({ pkgs, ... }: {

51−# ...

52− packages = {

53− another = ./dep/another;

54− };

55−# ...

56−```

57−

58−### How do I use `ob run` over HTTPS?

59−

60−To run your app locally over HTTPS, update the protocol in `config/common/route` to `https`, and then use `ob run` as normal.

61−

62−Obelisk generates a self-signed certificate for running HTTPS so the browser will issue a warning about using an invalid certificate. On Chrome, you can go to `chrome://flags/#allow-insecure-localhost` to enable invalid certificates for localhost.

63−

64

7

65### How do I fix invalid entitlements?

8### How do I fix invalid entitlements?

66

9

67−You probably did not set `ios.bundleIdentifier` correctly in `default.nix`. When this happens you'll see an error something like this:

10+You probably did not set `ios.bundleIdentifier` correctly in `default.nix`.

11+When this happens you'll see an error something like this:

68

12

69```

13```

702018-11-25 09:34:22.438 ios-deploy[58106:8521046] [ !! ] Error 0xe8008016: The executable was signed with invalid entitlements. AMDeviceSecureInstallApplication(0, device, url, options, install_callback, 0)

142018-11-25 09:34:22.438 ios-deploy[58106:8521046] [ !! ] Error 0xe8008016: The executable was signed with invalid entitlements. AMDeviceSecureInstallApplication(0, device, url, options, install_callback, 0)

@@ -75,7 +19,7 @@ Fixing the value of `ios.bundleIdentifier` should fix the error.

75### `ob thunk update` or `ob deploy update` fails

19### `ob thunk update` or `ob deploy update` fails

76Whenever an `ob` command fails, try re-running it with `-v`.

20Whenever an `ob` command fails, try re-running it with `-v`.

77

21

78−If you're using a private repo, and you get a failure in `nix-prefetch-url`, you may need to unpack and repack the thunk. Here's some example output that shows this issue:

22+If you're using a private repo, and you get a failure in nix-prefetch-url, you may need to unpack and repack the thunk. Here's some example output that shows this issue:

79

23

80```

24```

81Starting Obelisk </nix/store/j8wls8a89xr6s1a47lg6g83gnbdrfd0l-obelisk-command-0.1/bin/.ob-wrapped> args=["deploy","update","-v"] logging-level=Debug

25Starting Obelisk </nix/store/j8wls8a89xr6s1a47lg6g83gnbdrfd0l-obelisk-command-0.1/bin/.ob-wrapped> args=["deploy","update","-v"] logging-level=Debug

@@ -95,7 +39,7 @@ nix-prefetch-url: Failed to determine sha256 hash of URL https://github.com/obsi

95

39

96And here's how you can fix it:

40And here's how you can fix it:

97

41

98−```bash

42+```

99ob thunk unpack $SOME_THUNK

43ob thunk unpack $SOME_THUNK

100ob thunk pack $SOME_THUNK

44ob thunk pack $SOME_THUNK

101```

45```

@@ -115,3 +59,64 @@ error:

115```

59```

116then specify the package you want in the import, e.g:

60then specify the package you want in the import, e.g:

117`import "cryptonite" Crypto.Hash`

61`import "cryptonite" Crypto.Hash`

62+

63+

64+### What does `ob run` actually do?

65+

66+

67+#### Short version:

68+

69+`ob run` starts a [`ghcid`](https://github.com/ndmitchell/ghcid) process which

70+tries to build your project within a carefully crafted `nix-shell` with all the

71+project's dependencies and,

72+

73+* either displays compilation errors/warnings,

74+* or starts the Obelisk server, which serves:

75+ * your backend's route handlers,

76+ * the static assets,

77+ * the [JSaddle](https://github.com/ghcjs/jsaddle) frontend code (while opening its websocket).

78+

79+#### Longer version:

80+

81+Assuming we are in a project created with `ob init`, `ob run` calls (see

82+`lib/command/src/Obelisk/Command.hs`):

83+

84+ nix-shell --pure -A shells.ghc --run 'ob --no-handoff internal run-static-io <real-run-function>'

85+

86+where

87+

88+* `shells.ghc` is defined in `./default.nix` by importing `./.obelisk/impl/default.nix` which

89+ is `default.nix` in the present (Obelisk) repository,

90+* `run-static-io` is a logging-enabled command wrapper

91+ (cf. `runObelisk` in `lib/command/src/Obelisk/App.hs`).

92+

93+In this case, it runs the function `Obelisk.Command.Command.run` (defined in

94+`lib/command/src/Obelisk/Command/Run.hs`).

95+

96+* It creates a GHCi config from a Nix expression which:

97+ * loads three packages: `backend`, `common`, `frontend`,

98+ * obtains a free port number.

99+* Then runs `ghcid`

100+ * with a command that reruns `Obelisk.Run.run` at each restart (option

101+ `--test`).

102+

103+It is defined in `lib/run/src/Obelisk/Run.hs`:

104+

105+* It creates a thread which starts the main backend.

106+ This runs `runSnapWithCommandLineArgs` and passes routes:

107+ * to the backend (result of the `_backend_run` field of your

108+ implementation of the `Backend fullRoute frontendRoute` record),

109+ * or to `serveDefaultObeliskApp` (`lib/backend/src/Obelisk/Backend.hs`) to

110+ serve static assets.

111+* Starts `runWidget`

112+ which itself runs

113+ [runSettingsSocket](https://hackage.haskell.org/package/warp-3.2.26/docs/Network-Wai-Handler-Warp.html#v:runSettingsSocket)

114+ (the *“TCP listen loop”*):

115+ * it binds to TCP socket, and

116+ * creates the HTTP connection manager

117+ ( [`newManager`](https://hackage.haskell.org/package/http-client-0.6.3/docs/Network-HTTP-Client.html#v:newManager))

118+ * calls `obeliskApp` which

119+ * has a route to serve the [JSaddle](https://github.com/ghcjs/jsaddle) frontend,

120+ * runs the frontend (*on* the server), to produce pre-rendered pages,

121+ * starts the JSaddle web-socket,

122+ * “falls back” to proxying the backend (`fallbackProxy`).

README.md+167−68

@@ -1,75 +1,96 @@

1# Obelisk

2

3[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)

4−[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)

4+[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://tldrlegal.com/license/bsd-3-clause-license-%28revised%29)

5

6−<p align="center"><img src="docs/obelisk-logo-640.png" width="50%" alt="Obelisk Logo"></p>

7

6

8−Functional reactive web and mobile applications, with batteries included. Obelisk's goal is to represent a cohesive, highly-curated set of choices that [Obsidian Systems](https://obsidian.systems/) has made for building these types of applications in a way that is extremely fast but does not compromise on production readiness.

7+Obelisk provides an easy way to develop and deploy your [Reflex](https://github.com/reflex-frp/reflex) project as web apps and as mobile apps.

9

8

10−- [Overview](#overview)

11− - [Who should consider using it?](#who-should-consider-using-it)

12- [Installing Obelisk](#installing-obelisk)

9- [Installing Obelisk](#installing-obelisk)

13- [Developing an Obelisk project](#developing-an-obelisk-project)

10- [Developing an Obelisk project](#developing-an-obelisk-project)

11+ - [Adding Packages](#adding-packages)

12+ - [Adding Package Overrides](#adding-package-overrides)

13+ - [Running over HTTPS](#running-over-https)

14 - [IDE Support](#ide-support)

15+ - [Terminal-based feedback](#terminal-based-feedback)

16+ - [Experimental `ghcide` support](#experimental-ghcide-support)

15- [Deploying](#deploying)

17- [Deploying](#deploying)

18+ - [Locally](#locally)

16 - [Default EC2 Deployment](#default-ec2-deployment)

19 - [Default EC2 Deployment](#default-ec2-deployment)

17 - [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)

20 - [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)

18 - [VirtualBox Deployment](#virtualbox-deployment)

21 - [VirtualBox Deployment](#virtualbox-deployment)

19− - [Locally](#locally)

20 - [From macOS](#from-macos)

22 - [From macOS](#from-macos)

21 - [Deploying an updated version](#deploying-an-updated-version)

23 - [Deploying an updated version](#deploying-an-updated-version)

22- [Mobile](#mobile)

24- [Mobile](#mobile)

23 - [iOS](#ios)

25 - [iOS](#ios)

24 - [Android](#android)

26 - [Android](#android)

25−- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)

26−- [Contributing](#contributing)

27−

28−## Overview

29−

30−Obelisk allows you to build high-quality web and mobile applications very quickly using [Reflex](https://reflex-frp.org/). In minutes you can go from an empty directory to an interactive application that works on web, iOS, and Android, all sharing the same Haskell codebase! Obelisk's development environment also enables extremely rapid development and feedback. You can take advantage of Haskell's type system across the frontend and backend boundary. This means changes to your backend that would break your frontend are immediately detected during development and vice versa. Obelisk uses Haskell's compiler to give you a complete "TODO list" of what needs to be updated.

31−

32−Obelisk is targeted primarily at Haskell developers who want to build high-quality web and/or mobile applications in Haskell, without the distractions of manually choosing and integrating technology for every piece of the system.

33−

34−### Who should consider using it?

35−

36−Obelisk assumes basic knowledge of [Haskell](https://www.haskell.org/) and [Reflex/Reflex-DOM](https://reflex-frp.org/), web technologies like [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) and [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), and a terminal shell like [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)). Knowledge of [Nix](https://nixos.org/) helps but is not strictly necessary.

37−

38

27

39## Installing Obelisk

28## Installing Obelisk

40−

411. [Install Nix](https://nixos.org/nix/).

291. [Install Nix](https://nixos.org/nix/).

42 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.

30 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.

431. Set up nix caches

311. Set up nix caches

44 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:

32 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:

45− ```nix

33+ ```

46 nix.binaryCaches = [ "https://nixcache.reflex-frp.org" ];

34 nix.binaryCaches = [ "https://nixcache.reflex-frp.org" ];

47 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];

35 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];

48 ```

36 ```

49 and rebuild your NixOS configuration (e.g. `sudo nixos-rebuild switch`).

37 and rebuild your NixOS configuration (e.g. `sudo nixos-rebuild switch`).

50− 1. If you are using another operating system or Linux distribution, ensure that these lines are present in your Nix configuration file (`/etc/nix/nix.conf` on most systems; [see full list](https://nixos.org/nix/manual/#sec-conf-file)):

38+ 1. If you are using another operating system or linux distribution, ensure that these lines are present in your Nix configuration file (`/etc/nix/nix.conf` on most systems; [see full list](https://nixos.org/nix/manual/#sec-conf-file)):

51− ```nix

39+ ```

52− binary-caches = https://cache.nixos.org https://nixcache.reflex-frp.org

40+ binary-caches = https://cache.nixos.org https://nixcache.reflex-frp.org

53− binary-cache-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=

41+ binary-cache-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=

54− binary-caches-parallel-connections = 40

42+ binary-caches-parallel-connections = 40

55 ```

43 ```

56− * If you're on a Linux distribution other than NixOS, enable sandboxing (see these [issue 172](https://github.com/obsidiansystems/obelisk/issues/172#issuecomment-411507818) or [issue 6](https://github.com/obsidiansystems/obelisk/issues/6) if you run into build problems) by adding the following:

44+ * other Linux: enable sandboxing (see these [issue172](https://github.com/obsidiansystems/obelisk/issues/172#issuecomment-411507818) or [issue6](https://github.com/obsidiansystems/obelisk/issues/6) if you run into build problems)

57− ```nix

45+ ```

58 sandbox = true

46 sandbox = true

59 ```

47 ```

60− * If you're on MacOS, disable sandboxing (there are still some impure dependencies for now) by adding the following:

48+ * MacOS: disable sandboxing (there are still some impure dependencies for now)

61− ```nix

49+ ```

62 sandbox = false

50 sandbox = false

63 ```

51 ```

64 then restart the nix daemon

52 then restart the nix daemon

65− ```bash

53+ ```

66 sudo launchctl stop org.nixos.nix-daemon

54 sudo launchctl stop org.nixos.nix-daemon

67 sudo launchctl start org.nixos.nix-daemon

55 sudo launchctl start org.nixos.nix-daemon

68 ```

56 ```

69−1. Install obelisk:

70− ```bash

71− nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command

57+1. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`

58+

59+### Contributing to Obelisk

60+

61+When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:

62+

63+```bash

64+nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid -c 'cabal new-repl'"

65+```

66+

67+Or to launch ghcid for `lib/command` project:

68+

69+```bash

70+nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"

71+```

72+

73+To re-install `ob` from source do

74+```bash

75+nix-env -f /path/to/obelisk -iA command

76+```

77+

78+Note that `ob` will defer to the version found in your project's `.obelisk/impl` directory. To update that version specifically:

79+

80+```bash

81+ob thunk unpack ./.obelisk/impl

82+cd ./.obelisk/impl

83+# apply your changes

84+```

85+

86+If you want to commit your changes, first push them to your fork of obelisk and then

87+

88+```bash

89+cd /your/project/root

90+ob thunk pack .obelisk/impl

91+git add .obelisk/impl

92+git commit -m "Bump obelisk"

72− ```

93+```

73

94

74### Accessing private repositories

95### Accessing private repositories

75

96

@@ -99,12 +120,119 @@ Firefox will not be able to properly run the development website due to [issue 4

99

120

100Every time you change the Haskell source files in frontend, common or backend, `ob run` will automatically recompile the modified files and reload the server. Furthermore, it will display on screen compilation errors and warnings if any.

121Every time you change the Haskell source files in frontend, common or backend, `ob run` will automatically recompile the modified files and reload the server. Furthermore, it will display on screen compilation errors and warnings if any.

101

122

123+### Adding packages

124+

125+In order to add package dependencies, declare them under the build-depends field in the appropriate cabal files (backend, common, and frontend each have their own). The corresponding Nix packages will automatically be selected when building.

126+

127+### Adding package overrides

128+

129+To add a version override to any Haskell package, or to add a Haskell package that doesn't exist in the nixpkgs used by Obelisk, use the `overrides` attribute in your project's `default.nix`. For example, to use a specific version of the `aeson` package fetched from GitHub and a specific version of the `waargonaut` package fetched from Hackage, your `default.nix` will look like:

130+

131+```nix

132+# ...

133+project ./. ({ pkgs, ... }: {

134+# ...

135+ overrides = self: super: let

136+ aesonSrc = pkgs.fetchFromGitHub {

137+ owner = "obsidiansystems";

138+ repo = "aeson-gadt-th";

139+ rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";

140+ sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";

141+ };

142+ in

143+ {

144+ aeson = self.callCabal2nix "aeson" aesonSrc {};

145+ waargonaut = self.callHackageDirect {

146+ pkg = "waargonaut";

147+ ver = "0.8.0.1";

148+ sha256 = "1zv28np3k3hg378vqm89v802xr0g8cwk7gy3mr77xrzy5jbgpa39";

149+ } {};

150+ };

151+# ...

152+```

153+

154+For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.

155+

156+### Adding extra local packages

157+

158+If the standard packages (`frontend`, `backend`, and `common`) are not

159+enough, to add more local Haskell packages, define them with the

160+`packages` parameter. The sources of these packages will be

161+automatically reloaded by `ob run`.

162+

163+```nix

164+# ...

165+project ./. ({ pkgs, ... }: {

166+# ...

167+ packages = {

168+ another = ./another;

169+ };

170+# ...

171+```

172+

173+### Running over HTTPS

174+

175+To run your app locally over HTTPS, update the protocol in `config/common/route` to `https`, and then use `ob run` as normal.

176+

177+Since Obelisk generates a self-signed certificate for running HTTPS, the browser will issue a warning about using an invalid certificate. On Chrome, you can go to `chrome://flags/#allow-insecure-localhost` to enable invalid certificates for localhost.

178+

102### IDE Support

179### IDE Support

103

180

181+#### Terminal-based feedback

182+

104Obelisk officially supports terminal-based feedback (akin to [`ghcid`](https://github.com/ndmitchell/ghcid)) in `ob run` and `ob watch`.

183Obelisk officially supports terminal-based feedback (akin to [`ghcid`](https://github.com/ndmitchell/ghcid)) in `ob run` and `ob watch`.

105

184

185+#### **Experimental** `ghcide` support

186+

187+> **NOTE:** `ghcide` support is strictly **experimental** and **not officially supported**. There is no guarantee that it will work for you or that this support will be maintained over time.

188+

189+To try out the **experimental** [`ghcide`](https://github.com/digital-asset/ghcide) support:

190+

191+ * Install a `ghcide` plugin for your editor.

192+ * Add `__withGhcide = true;` to your Obelisk project's `default.nix` (inside the call to `project`). With this setting, `ob shell` will provide `ghcide` as well.

193+ * Add `hie-bios.sh` to the root of your project:

194+ ```shell

195+ cat > hie-bios.sh <<'EOF'

196+ #!/usr/bin/env bash

197+ source "$HOME/.bash_profile"; # NOTE: Some editors need help finding 'ob' and this assumes that `ob` is made available on your `$PATH` in `.bash_profile`

198+ ob internal export-ghci-configuration > "$HIE_BIOS_OUTPUT"

199+ EOF

200+ chmod +x hie-bios.sh

201+ ```

202+ * **Note:** In some projects you need to use `ob internal export-ghci-configuration --use-relative-paths` in this script instead. This is known to happen when your project contains symlinks to other packages.

203+ * Add `hie.yaml` to the root of your project:

204+ ```shell

205+ echo 'cradle: { bios: { program: hie-bios.sh } }' > hie.yaml

206+ ```

207+ * Test the configuration with `ob shell ghcide`. Assuming your project compiles and works with `ghcide` otherwise, this should succeed.

208+ * Start your editor in a way that it can access the appropriate `ghcide`:

209+ * This can sometimes be achieved with `ob shell 'start my editor'`.

210+ * If you can't easily start your editor in a way that it inherits your shell, you may need to customize how your `ghcide` plugin finds `ghcide` or create a custom `ghcide` replacement script that you install globally. For example, for Visual Studio Code on macOS adding a script called `ghcide` to your `PATH` like the one below will cause `ghcide` from each project's `ob shell` to be used:

211+ ```shell

212+ #!/usr/bin/env bash

213+ source "$HOME/.bash_profile" # NOTE: This assumes that `ob` is made available on your `$PATH` in `.bash_profile`

214+ ob shell "ghcide $@"

215+ ```

216+

106## Deploying

217## Deploying

107

218

219+### Locally

220+

221+Build everything:

222+

223+```bash

224+nix-build -A exe --no-out-link

225+```

226+

227+Copy the result to a new directory, add configuration, and run!

228+

229+```bash

230+mkdir test-app

231+ln -s $(nix-build -A exe --no-out-link)/* test-app/

232+cp -r config test-app

233+(cd test-app && ./backend)

234+```

235+

108### Default EC2 Deployment

236### Default EC2 Deployment

109

237

110In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance. Obelisk deployments are configured for EC2 by default (see [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)).

238In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance. Obelisk deployments are configured for EC2 by default (see [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)).

@@ -114,14 +242,14 @@ First create a new EC2 instance:

1141. Launch a NixOS 19.09 EC2 instance (we recommend [this AMI](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#LaunchInstanceWizard:ami=ami-00a8eeaf232a74f84))

2421. Launch a NixOS 19.09 EC2 instance (we recommend [this AMI](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#LaunchInstanceWizard:ami=ami-00a8eeaf232a74f84))

1151. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.

2431. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.

1161. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.

2441. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.

117−1. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and HTTPS port 443.

245+1. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and 443.

118

246

119At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.

247At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.

120

248

121Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):

249Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):

122Your project directory must be "thunkable", i.e. something on which `ob thunk pack` can be called. Usually it will be a git repository whose current revision has been pushed upstream.

250Your project directory must be "thunkable", i.e. something on which `ob thunk pack` can be called. Usually it will be a git repository whose current revision has been pushed upstream.

123

251

124−```bash

252+```

125cd ~/code/myapp

253cd ~/code/myapp

126SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com

254SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com

127ROUTE=https://myapp.com # Publicly accessible route to your app

255ROUTE=https://myapp.com # Publicly accessible route to your app

@@ -140,7 +268,7 @@ This step will also require that you manually verify the authenticity of the hos

140

268

141Next, go to the deployment directory that you just initialized and deploy!

269Next, go to the deployment directory that you just initialized and deploy!

142

270

143−```bash

271+```

144cd ~/code/myapp-deploy

272cd ~/code/myapp-deploy

145ob deploy push

273ob deploy push

146```

274```

@@ -169,25 +297,6 @@ Here's a `module.nix` that is configured for deployment to a VirtualBox VM (runn

169

297

170The `{...}:` and following is the [NixOS module](https://nixos.org/nixos/manual/index.html#sec-writing-modules) definition.

298The `{...}:` and following is the [NixOS module](https://nixos.org/nixos/manual/index.html#sec-writing-modules) definition.

171

299

172−### Locally

173−

174−If you want deploy your application locally or test a production-oriented build you can build and deploy the app as described below.

175−

176−Build the application:

177−

178−```bash

179−nix-build -A exe --no-out-link

180−```

181−

182−Copy the result to a new directory, add configuration, and run!

183−

184−```bash

185−mkdir test-app

186−ln -s $(nix-build -A exe --no-out-link)/* test-app/

187−cp -r config test-app

188−(cd test-app && ./backend)

189−```

190−

191### From macOS

300### From macOS

192

301

193Deploying from macOS requires some extra setup:

302Deploying from macOS requires some extra setup:

@@ -221,7 +330,7 @@ Your account must also belong to an Apple Developer Team, if you want to access

2211. Click accept to authorize on both the computer and the iPhone.

3301. Click accept to authorize on both the computer and the iPhone.

222

331

223##### Xcode

332##### Xcode

224−Install Xcode 11.2 (contains iOS SDK 13.2) and open it so that it runs its post install tool setup.

333+Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.

225

334

226These versions will work out of the box but iOS SDKs prior to 11.3 should also work. You can choose another installed version in `default.nix`

335These versions will work out of the box but iOS SDKs prior to 11.3 should also work. You can choose another installed version in `default.nix`

227

336

@@ -314,13 +423,3 @@ This should copy over and install the application on your device (if you see a

314##### Build a release version

423##### Build a release version

315

424

316After having configured signing for your app, you may proceed to build a release version of the app. This is no different to how you build the non-release version, so consult the section [Android](#android) further above for exact instructions on building and deploying to your device.

425After having configured signing for your app, you may proceed to build a release version of the app. This is no different to how you build the non-release version, so consult the section [Android](#android) further above for exact instructions on building and deploying to your device.

317−

318−

319−## Frequently Asked Questions (FAQ)

320−

321−Refer to [FAQ](FAQ.md).

322−

323−

324−## Contributing

325−

326−Contributions and issue reports are encouraged and appreciated! Refer to the [Contributing](CONTRIBUTING.md) guide for information about getting started.

acme.nixdeleted−430

@@ -1,430 +0,0 @@

1−# Copied from https://github.com/NixOS/nixpkgs-channels/blob/70717a337f7ae4e486ba71a500367cad697e5f09/nixos/modules/security/acme.nix # MODIFIED

2−# Lines marked '# MODIFIED' have been added or modified from the original. # MODIFIED

3−{ config, lib, pkgs, ... }:

4−with lib;

5−let

6−

7− cfg = config.security.acme;

8−

9− certOpts = { name, ... }: {

10− options = {

11− webroot = mkOption {

12− type = types.nullOr types.str;

13− default = null;

14− example = "/var/lib/acme/acme-challenges";

15− description = ''

16− Where the webroot of the HTTP vhost is located.

17− <filename>.well-known/acme-challenge/</filename> directory

18− will be created below the webroot if it doesn't exist.

19− <literal>http://example.org/.well-known/acme-challenge/</literal> must also

20− be available (notice unencrypted HTTP).

21− '';

22− };

23−

24− server = mkOption {

25− type = types.nullOr types.str;

26− default = null;

27− description = ''

28− ACME Directory Resource URI. Defaults to let's encrypt

29− production endpoint,

30− https://acme-v02.api.letsencrypt.org/directory, if unset.

31− '';

32− };

33−

34− domain = mkOption {

35− type = types.str;

36− default = name;

37− description = "Domain to fetch certificate for (defaults to the entry name)";

38− };

39−

40− email = mkOption {

41− type = types.nullOr types.str;

42− default = cfg.email;

43− description = "Contact email address for the CA to be able to reach you.";

44− };

45−

46− user = mkOption {

47− type = types.str;

48− default = "root";

49− description = "User running the ACME client.";

50− };

51−

52− group = mkOption {

53− type = types.str;

54− default = "root";

55− description = "Group running the ACME client.";

56− };

57−

58− allowKeysForGroup = mkOption {

59− type = types.bool;

60− default = false;

61− description = ''

62− Give read permissions to the specified group

63− (<option>security.acme.cert.<name>.group</option>) to read SSL private certificates.

64− '';

65− };

66−

67− postRun = mkOption {

68− type = types.lines;

69− default = "";

70− example = "systemctl reload nginx.service";

71− description = ''

72− Commands to run after new certificates go live. Typically

73− the web server and other servers using certificates need to

74− be reloaded.

75− Executed in the same directory with the new certificate.

76− '';

77− };

78−

79− directory = mkOption {

80− type = types.str;

81− readOnly = true;

82− default = "/var/lib/acme/${name}";

83− description = "Directory where certificate and other state is stored.";

84− };

85−

86− extraDomains = mkOption {

87− type = types.attrsOf (types.nullOr types.str);

88− default = {};

89− example = literalExample ''

90− {

91− "example.org" = null;

92− "mydomain.org" = null;

93− }

94− '';

95− description = ''

96− A list of extra domain names, which are included in the one certificate to be issued.

97− Setting a distinct server root is deprecated and not functional in 20.03+

98− '';

99− };

100−

101− keyType = mkOption {

102− type = types.str;

103− default = "ec256";

104− description = ''

105− Key type to use for private keys.

106− For an up to date list of supported values check the --key-type option

107− at https://go-acme.github.io/lego/usage/cli/#usage.

108− '';

109− };

110−

111− dnsProvider = mkOption {

112− type = types.nullOr types.str;

113− default = null;

114− example = "route53";

115− description = ''

116− DNS Challenge provider. For a list of supported providers, see the "code"

117− field of the DNS providers listed at https://go-acme.github.io/lego/dns/.

118− '';

119− };

120−

121− credentialsFile = mkOption {

122− type = types.path;

123− description = ''

124− Path to an EnvironmentFile for the cert's service containing any required and

125− optional environment variables for your selected dnsProvider.

126− To find out what values you need to set, consult the documentation at

127− https://go-acme.github.io/lego/dns/ for the corresponding dnsProvider.

128− '';

129− example = "/var/src/secrets/example.org-route53-api-token";

130− };

131−

132− dnsPropagationCheck = mkOption {

133− type = types.bool;

134− default = true;

135− description = ''

136− Toggles lego DNS propagation check, which is used alongside DNS-01

137− challenge to ensure the DNS entries required are available.

138− '';

139− };

140− };

141− };

142−

143−in

144−

145−{

146−

147− ###### interface

148− imports = [

149− (mkRemovedOptionModule [ "security" "acme" "production" ] ''

150− Use security.acme.server to define your staging ACME server URL instead.

151− To use the let's encrypt staging server, use security.acme.server =

152− "https://acme-staging-v02.api.letsencrypt.org/directory".

153− ''

154− )

155− # (mkRemovedOptionModule [ "security" "acme" "directory"] "ACME Directory is now hardcoded to /var/lib/acme and its permisisons are managed by systemd. See https://github.com/NixOS/nixpkgs/issues/53852 for more info.") # MODIFIED

156− # (mkRemovedOptionModule [ "security" "acme" "preDelay"] "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service to the service you want to execute before the cert renewal") # MODIFIED

157− # (mkRemovedOptionModule [ "security" "acme" "activationDelay"] "This option has been removed. If you want to make sure that something executes before certificates are provisioned, add a RequiredBy=acme-\${cert}.service to the service you want to execute before the cert renewal") # MODIFIED

158− (mkChangedOptionModule [ "security" "acme" "validMin"] [ "security" "acme" "validMinDays"] (config: config.security.acme.validMin / (24 * 3600)))

159− ];

160− options = {

161− security.acme = {

162−

163− validMinDays = mkOption {

164− type = types.int;

165− default = 30;

166− description = "Minimum remaining validity before renewal in days.";

167− };

168−

169− email = mkOption {

170− type = types.nullOr types.str;

171− default = null;

172− description = "Contact email address for the CA to be able to reach you.";

173− };

174−

175− renewInterval = mkOption {

176− type = types.str;

177− default = "daily";

178− description = ''

179− Systemd calendar expression when to check for renewal. See

180− <citerefentry><refentrytitle>systemd.time</refentrytitle>

181− <manvolnum>7</manvolnum></citerefentry>.

182− '';

183− };

184−

185− server = mkOption {

186− type = types.nullOr types.str;

187− default = null;

188− description = ''

189− ACME Directory Resource URI. Defaults to let's encrypt

190− production endpoint,

191− <literal>https://acme-v02.api.letsencrypt.org/directory</literal>, if unset.

192− '';

193− };

194−

195− preliminarySelfsigned = mkOption {

196− type = types.bool;

197− default = true;

198− description = ''

199− Whether a preliminary self-signed certificate should be generated before

200− doing ACME requests. This can be useful when certificates are required in

201− a webserver, but ACME needs the webserver to make its requests.

202− With preliminary self-signed certificate the webserver can be started and

203− can later reload the correct ACME certificates.

204− '';

205− };

206−

207− acceptTerms = mkOption {

208− type = types.bool;

209− default = false;

210− description = ''

211− Accept the CA's terms of service. The default provier is Let's Encrypt,

212− you can find their ToS at https://letsencrypt.org/repository/

213− '';

214− };

215−

216− certs = mkOption {

217− default = { };

218− type = with types; attrsOf (submodule certOpts);

219− description = ''

220− Attribute set of certificates to get signed and renewed. Creates

221− <literal>acme-''${cert}.{service,timer}</literal> systemd units for

222− each certificate defined here. Other services can add dependencies

223− to those units if they rely on the certificates being present,

224− or trigger restarts of the service if certificates get renewed.

225− '';

226− example = literalExample ''

227− {

228− "example.com" = {

229− webroot = "/var/www/challenges/";

230− email = "foo@example.com";

231− extraDomains = { "www.example.com" = null; "foo.example.com" = null; };

232− };

233− "bar.example.com" = {

234− webroot = "/var/www/challenges/";

235− email = "bar@example.com";

236− };

237− }

238− '';

239− };

240− };

241− };

242−

243− ###### implementation

244− config = mkMerge [

245− (mkIf (cfg.certs != { }) {

246−

247− assertions = let

248− certs = (mapAttrsToList (k: v: v) cfg.certs);

249− in [

250− {

251− assertion = all (certOpts: certOpts.dnsProvider == null || certOpts.webroot == null) certs;

252− message = ''

253− Options `security.acme.certs.<name>.dnsProvider` and

254− `security.acme.certs.<name>.webroot` are mutually exclusive.

255− '';

256− }

257− {

258− assertion = cfg.email != null || all (certOpts: certOpts.email != null) certs;

259− message = ''

260− You must define `security.acme.certs.<name>.email` or

261− `security.acme.email` to register with the CA.

262− '';

263− }

264− {

265− assertion = cfg.acceptTerms;

266− message = ''

267− You must accept the CA's terms of service before using

268− the ACME module by setting `security.acme.acceptTerms`

269− to `true`. For Let's Encrypt's ToS see https://letsencrypt.org/repository/

270− '';

271− }

272− ];

273−

274− systemd.services = let

275− services = concatLists servicesLists;

276− servicesLists = mapAttrsToList certToServices cfg.certs;

277− certToServices = cert: data:

278− let

279− # StateDirectory must be relative, and will be created under /var/lib by systemd

280− lpath = "acme/${cert}";

281− apath = "/var/lib/${lpath}";

282− spath = "/var/lib/acme/.lego/${cert}";

283− fileMode = if data.allowKeysForGroup then "640" else "600";

284− globalOpts = [ "-d" data.domain "--email" data.email "--path" "." "--key-type" data.keyType ]

285− ++ optionals (cfg.acceptTerms) [ "--accept-tos" ]

286− ++ optionals (data.dnsProvider != null && !data.dnsPropagationCheck) [ "--dns.disable-cp" ]

287− ++ concatLists (mapAttrsToList (name: root: [ "-d" name ]) data.extraDomains)

288− ++ (if data.dnsProvider != null then [ "--dns" data.dnsProvider ] else [ "--http" "--http.webroot" data.webroot ])

289− ++ optionals (cfg.server != null || data.server != null) ["--server" (if data.server == null then cfg.server else data.server)];

290− runOpts = escapeShellArgs (globalOpts ++ [ "run" ]);

291− renewOpts = escapeShellArgs (globalOpts ++ [ "renew" "--days" (toString cfg.validMinDays) ]);

292− acmeService = {

293− description = "Renew ACME Certificate for ${cert}";

294− after = [ "network.target" "network-online.target" ];

295− wants = [ "network-online.target" ];

296− wantedBy = mkIf (!config.boot.isContainer) [ "multi-user.target" ];

297− serviceConfig = {

298− Type = "oneshot";

299− User = data.user;

300− Group = data.group;

301− PrivateTmp = true;

302− StateDirectory = "acme/.lego/${cert} acme/.lego/accounts ${lpath}";

303− StateDirectoryMode = if data.allowKeysForGroup then "750" else "700";

304− WorkingDirectory = spath;

305− # Only try loading the credentialsFile if the dns challenge is enabled

306− EnvironmentFile = if data.dnsProvider != null then data.credentialsFile else null;

307− ExecStart = pkgs.writeScript "acme-start" ''

308− #!${pkgs.runtimeShell} -e

309− test -L ${spath}/accounts -o -d ${spath}/accounts || ln -s ../accounts ${spath}/accounts

310− ${pkgs.lego}/bin/lego ${renewOpts} || ${pkgs.lego}/bin/lego ${runOpts}

311− '';

312− ExecStartPost =

313− let

314− keyName = builtins.replaceStrings ["*"] ["_"] data.domain;

315− script = pkgs.writeScript "acme-post-start" ''

316− #!${pkgs.runtimeShell} -e

317− cd ${apath}

318− # Test that existing cert is older than new cert

319− KEY=${spath}/certificates/${keyName}.key

320− KEY_CHANGED=no

321− if [ -e $KEY -a $KEY -nt key.pem ]; then

322− KEY_CHANGED=yes

323− cp -p ${spath}/certificates/${keyName}.key key.pem

324− cp -p ${spath}/certificates/${keyName}.crt fullchain.pem

325− cp -p ${spath}/certificates/${keyName}.issuer.crt chain.pem

326− ln -sf fullchain.pem cert.pem

327− cat key.pem fullchain.pem > full.pem

328− fi

329− chmod ${fileMode} *.pem

330− chown '${data.user}:${data.group}' *.pem

331− if [ "$KEY_CHANGED" = "yes" ]; then

332− : # noop in case postRun is empty

333− ${data.postRun}

334− fi

335− '';

336− in

337− "+${script}";

338− };

339−

340− };

341− selfsignedService = {

342− description = "Create preliminary self-signed certificate for ${cert}";

343− path = [ pkgs.openssl ];

344− script =

345− ''

346− workdir="$(mktemp -d)"

347− # Create CA

348− openssl genrsa -des3 -passout pass:xxxx -out $workdir/ca.pass.key 2048

349− openssl rsa -passin pass:xxxx -in $workdir/ca.pass.key -out $workdir/ca.key

350− openssl req -new -key $workdir/ca.key -out $workdir/ca.csr \

351− -subj "/C=UK/ST=Warwickshire/L=Leamington/O=OrgName/OU=Security Department/CN=example.com"

352− openssl x509 -req -days 1 -in $workdir/ca.csr -signkey $workdir/ca.key -out $workdir/ca.crt

353− # Create key

354− openssl genrsa -des3 -passout pass:xxxx -out $workdir/server.pass.key 2048

355− openssl rsa -passin pass:xxxx -in $workdir/server.pass.key -out $workdir/server.key

356− openssl req -new -key $workdir/server.key -out $workdir/server.csr \

357− -subj "/C=UK/ST=Warwickshire/L=Leamington/O=OrgName/OU=IT Department/CN=example.com"

358− openssl x509 -req -days 1 -in $workdir/server.csr -CA $workdir/ca.crt \

359− -CAkey $workdir/ca.key -CAserial $workdir/ca.srl -CAcreateserial \

360− -out $workdir/server.crt

361− # Copy key to destination

362− cp $workdir/server.key ${apath}/key.pem

363− # Create fullchain.pem (same format as "simp_le ... -f fullchain.pem" creates)

364− cat $workdir/{server.crt,ca.crt} > "${apath}/fullchain.pem"

365− # Create full.pem for e.g. lighttpd

366− cat $workdir/{server.key,server.crt,ca.crt} > "${apath}/full.pem"

367− # Give key acme permissions

368− chown '${data.user}:${data.group}' "${apath}/"{key,fullchain,full}.pem

369− chmod ${fileMode} "${apath}/"{key,fullchain,full}.pem

370− '';

371− serviceConfig = {

372− Type = "oneshot";

373− PrivateTmp = true;

374− StateDirectory = lpath;

375− User = data.user;

376− Group = data.group;

377− };

378− unitConfig = {

379− # Do not create self-signed key when key already exists

380− ConditionPathExists = "!${apath}/key.pem";

381− };

382− };

383− in (

384− [ { name = "acme-${cert}"; value = acmeService; } ]

385− ++ optional cfg.preliminarySelfsigned { name = "acme-selfsigned-${cert}"; value = selfsignedService; }

386− );

387− servicesAttr = listToAttrs services;

388− in

389− servicesAttr;

390−

391− systemd.tmpfiles.rules =

392− map (data: "d ${data.webroot}/.well-known/acme-challenge - ${data.user} ${data.group}") (filter (data: data.webroot != null) (attrValues cfg.certs));

393−

394− systemd.timers = let

395− # Allow systemd to pick a convenient time within the day

396− # to run the check.

397− # This allows the coalescing of multiple timer jobs.

398− # We divide by the number of certificates so that if you

399− # have many certificates, the renewals are distributed over

400− # the course of the day to avoid rate limits.

401− numCerts = length (attrNames cfg.certs);

402− _24hSecs = 60 * 60 * 24;

403− AccuracySec = "${toString (_24hSecs / numCerts)}s";

404− in flip mapAttrs' cfg.certs (cert: data: nameValuePair

405− ("acme-${cert}")

406− ({

407− description = "Renew ACME Certificate for ${cert}";

408− wantedBy = [ "timers.target" ];

409− timerConfig = {

410− OnCalendar = cfg.renewInterval;

411− Unit = "acme-${cert}.service";

412− Persistent = "yes";

413− inherit AccuracySec;

414− # Skew randomly within the day, per https://letsencrypt.org/docs/integration-guide/.

415− RandomizedDelaySec = "24h";

416− };

417− })

418− );

419−

420− systemd.targets.acme-selfsigned-certificates = mkIf cfg.preliminarySelfsigned {};

421− systemd.targets.acme-certificates = {};

422− })

423−

424− ];

425−

426− meta = {

427− maintainers = with lib.maintainers; [ abbradar fpletz globin m1cr0man ];

428− # doc = ./acme.xml; # MODIFIED

429− };

430−}

all-builds.nix+1−1

@@ -1,6 +1,6 @@

1{ self-args ? {

2 config.android_sdk.accept_license = true;

3− iosSdkVersion = "13.2";

3+ iosSdkVersion = "10.2";

4 }

5, local-self ? import ./. self-args

6, supportedSystems ? [ builtins.currentSystem ]

default.nix+27−60

@@ -1,10 +1,7 @@

1{ system ? builtins.currentSystem

2, profiling ? false

3−, iosSdkVersion ? "13.2"

3+, iosSdkVersion ? "10.2"

4, config ? {}

5−, terms ? { # Accepted terms, conditions, and licenses

6− security.acme.acceptTerms = false;

7− }

8, reflex-platform-func ? import ./dep/reflex-platform

5, reflex-platform-func ? import ./dep/reflex-platform

9}:

6}:

10let

7let

@@ -46,7 +43,7 @@ in rec {

46 pathGit = ./.; # Used in CI by the migration graph hash algorithm to correctly ignore files.

43 pathGit = ./.; # Used in CI by the migration graph hash algorithm to correctly ignore files.

47 path = reflex-platform.filterGit ./.;

44 path = reflex-platform.filterGit ./.;

48 obelisk = ghcObelisk;

45 obelisk = ghcObelisk;

49− obeliskEnvs = pkgs.lib.filterAttrs (k: _: k == "tabulation" || pkgs.lib.strings.hasPrefix "obelisk-" k) ghcObeliskEnvs; #TODO: use thunkSet https://github.com/reflex-frp/reflex-platform/pull/671

46+ obeliskEnvs = pkgs.lib.filterAttrs (k: _: pkgs.lib.strings.hasPrefix "obelisk-" k) ghcObeliskEnvs;

50 command = ghcObelisk.obelisk-command;

47 command = ghcObelisk.obelisk-command;

51 shell = pinBuildInputs "obelisk-shell" ([command] ++ command.commandRuntimeDeps);

48 shell = pinBuildInputs "obelisk-shell" ([command] ++ command.commandRuntimeDeps);

52

49

@@ -77,20 +74,16 @@ in rec {

77 '';

74 '';

78

75

79 compressedJs = frontend: optimizationLevel: pkgs.runCommand "compressedJs" {} ''

76 compressedJs = frontend: optimizationLevel: pkgs.runCommand "compressedJs" {} ''

80− set -euo pipefail

77+ mkdir $out

78+ cd $out

79+ # TODO profiling + static shouldn't break and need an ad-hoc workaround like that

81− cd '${haskellLib.justStaticExecutables frontend}'

80+ ln -s "${haskellLib.justStaticExecutables frontend}/bin/frontend.jsexe/all.js" all.unminified.js

82− shopt -s globstar

83− for f in **/all.js; do

84− dir="$out/$(basename "$(dirname "$f")")"

85− mkdir -p "$dir"

86− ln -s "$(realpath "$f")" "$dir/all.unminified.js"

87− ${if optimizationLevel == null then ''

81+ ${if optimizationLevel == null then ''

88− ln -s "$dir/all.unminified.js" "$dir/all.js"

82+ ln -s all.unminified.js all.js

89− '' else ''

83+ '' else ''

90− '${pkgs.closurecompiler}/bin/closure-compiler' --externs '${reflex-platform.ghcjsExternsJs}' -O '${optimizationLevel}' --jscomp_warning=checkVars --create_source_map="$dir/all.js.map" --source_map_format=V3 --js_output_file="$dir/all.js" "$dir/all.unminified.js"

84+ ${pkgs.closurecompiler}/bin/closure-compiler --externs "${reflex-platform.ghcjsExternsJs}" -O ${optimizationLevel} --jscomp_warning=checkVars --create_source_map="all.js.map" --source_map_format=V3 --js_output_file="all.js" all.unminified.js

91− echo '//# sourceMappingURL=all.js.map' >> "$dir/all.js"

85+ echo "//# sourceMappingURL=all.js.map" >> all.js

92− ''}

86+ ''}

93− done

94 '';

87 '';

95

88

96 serverModules = {

89 serverModules = {

@@ -116,8 +109,6 @@ in rec {

116 security.acme.certs = if enableHttps then {

109 security.acme.certs = if enableHttps then {

117 "${routeHost}".email = adminEmail;

110 "${routeHost}".email = adminEmail;

118 } else {};

111 } else {};

119−

120− security.acme.${if enableHttps && (terms.security.acme.acceptTerms or false) then "acceptTerms" else null} = true;

121 };

112 };

122

113

123 mkObeliskApp =

114 mkObeliskApp =

@@ -134,16 +125,12 @@ in rec {

134 }: {...}: {

125 }: {...}: {

135 services.nginx = {

126 services.nginx = {

136 enable = true;

127 enable = true;

137− recommendedProxySettings = true;

138 virtualHosts."${routeHost}" = {

128 virtualHosts."${routeHost}" = {

139 enableACME = enableHttps;

129 enableACME = enableHttps;

140 forceSSL = enableHttps;

130 forceSSL = enableHttps;

141 locations.${baseUrl} = {

131 locations.${baseUrl} = {

142 proxyPass = "http://127.0.0.1:" + toString internalPort;

132 proxyPass = "http://127.0.0.1:" + toString internalPort;

143 proxyWebsockets = true;

133 proxyWebsockets = true;

144− extraConfig = ''

145− access_log off;

146− '';

147 };

134 };

148 };

135 };

149 };

136 };

@@ -184,11 +171,9 @@ in rec {

184 pkgs.runCommand "serverExe" {} ''

171 pkgs.runCommand "serverExe" {} ''

185 mkdir $out

172 mkdir $out

186 set -eux

173 set -eux

187− ln -s '${if profiling then backend else haskellLib.justStaticExecutables backend}'/bin/* $out/

174+ ln -s "${if profiling then backend else haskellLib.justStaticExecutables backend}"/bin/* $out/

188− ln -s '${mkAssets assets}' $out/static.assets

175+ ln -s "${mkAssets assets}" $out/static.assets

189− for d in '${mkAssets (compressedJs frontend optimizationLevel)}'/*/; do

176+ ln -s ${mkAssets (compressedJs frontend optimizationLevel)} $out/frontend.jsexe.assets

190− ln -s "$d" "$out"/"$(basename "$d").assets"

191− done

192 echo ${version} > $out/version

177 echo ${version} > $out/version

193 '';

178 '';

194

179

@@ -202,20 +187,6 @@ in rec {

202 (module { inherit exe hostName adminEmail routeHost enableHttps version; nixosPkgs = pkgs; })

187 (module { inherit exe hostName adminEmail routeHost enableHttps version; nixosPkgs = pkgs; })

203 (serverModules.mkDefaultNetworking args)

188 (serverModules.mkDefaultNetworking args)

204 (serverModules.mkObeliskApp args)

189 (serverModules.mkObeliskApp args)

205− ./acme.nix # Backport of ACME upgrades from 20.03

206− ];

207−

208− # Backport of ACME upgrades from 20.03

209− disabledModules = [

210− (pkgs.path + /nixos/modules/security/acme.nix)

211− ];

212− nixpkgs.overlays = [

213− (self: super: {

214− lego = (import (builtins.fetchTarball {

215− url = https://github.com/NixOS/nixpkgs-channels/archive/70717a337f7ae4e486ba71a500367cad697e5f09.tar.gz;

216− sha256 = "1sbmqn7yc5iilqnvy9nvhsa9bx6spfq1kndvvis9031723iyymd1";

217− }) {}).lego;

218− })

219 ];

190 ];

220 };

191 };

221 };

192 };

@@ -350,33 +321,29 @@ in rec {

350 __unstable__.profiledObRun = let

321 __unstable__.profiledObRun = let

351 profiled = projectOut { inherit system; enableLibraryProfiling = true; };

322 profiled = projectOut { inherit system; enableLibraryProfiling = true; };

352 exeSource = builtins.toFile "ob-run.hs" ''

323 exeSource = builtins.toFile "ob-run.hs" ''

353− {-# LANGUAGE NoImplicitPrelude #-}

354− {-# LANGUAGE PackageImports #-}

355 module Main where

324 module Main where

356

325

357− -- Explicitly import Prelude from base lest there be multiple modules called Prelude

358− import "base" Prelude (IO, (++), read)

359−

360− import "base" Control.Exception (finally)

326+ import Control.Exception

361− import "reflex" Reflex.Profiled (writeProfilingData)

327+ import Reflex.Profiled

362− import "base" System.Environment (getArgs)

328+ import System.Environment

363

329

364− import qualified "obelisk-run" Obelisk.Run

330+ import qualified Obelisk.Run

365 import qualified Frontend

331 import qualified Frontend

366 import qualified Backend

332 import qualified Backend

367

333

368 main :: IO ()

334 main :: IO ()

369 main = do

335 main = do

370− [portStr, assets, profFileName] <- getArgs

336+ args <- getArgs

337+ let port = read $ args !! 0

338+ assets = args !! 1

339+ profileFile = (args !! 2) <> ".rprof"

371− Obelisk.Run.run (read portStr) (Obelisk.Run.runServeAsset assets) Backend.backend Frontend.frontend

340+ Obelisk.Run.run port (Obelisk.Run.runServeAsset assets) Backend.backend Frontend.frontend `finally` writeProfilingData profileFile

372− `finally` writeProfilingData (profFileName ++ ".rprof")

373 '';

341 '';

374 in nixpkgs.runCommand "ob-run" {

342 in nixpkgs.runCommand "ob-run" {

375− buildInputs = [ (profiled.ghc.ghcWithPackages (p: [p.backend p.frontend])) ];

343+ buildInputs = [ (profiled.ghc.ghcWithPackages (p: [ p.backend p.frontend])) ];

376 } ''

344 } ''

377− cp ${exeSource} ob-run.hs

378− mkdir -p $out/bin

345+ mkdir -p $out/bin/

379− ghc -x hs -prof -fno-prof-auto -threaded ob-run.hs -o $out/bin/ob-run

346+ ghc -x hs -prof -fno-prof-auto -threaded ${exeSource} -o $out/bin/ob-run

380 '';

347 '';

381

348

382 linuxExeConfigurable = linuxExe;

349 linuxExeConfigurable = linuxExe;

dep/reflex-platform/default.nix+7−1

@@ -1,2 +1,8 @@

1# DO NOT HAND-EDIT THIS FILE

2−import (import ./thunk.nix)

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+in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))

dep/reflex-platform/github.json+3−3

@@ -1,8 +1,8 @@

1{

2 "owner": "reflex-frp",

3 "repo": "reflex-platform",

4− "branch": "release/0.7.0.0",

4+ "branch": "release/0.5.3.0",

5 "private": false,

6− "rev": "27a7851a780ff21472d85f9a02fb84635ef9027a",

6+ "rev": "9779ea3b4c87fdc971057c561262696d5e9b1847",

7− "sha256": "1m4zlw91dpjlbdchjyxhvhv3k7lilm0qa17dhhww868xxc27sann"

7+ "sha256": "0v87ilal9355xwz8y9m0zh14pm9c0f7pqch0854kkj92ybc5l62q"

8}

dep/reflex-platform/thunk.nixdeleted−9

@@ -1,9 +0,0 @@

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

docs/obelisk-logo-640.pngdeleted

Binary file not shown.

guides/app-deploy/README.md+10−16

@@ -1,14 +1,13 @@

1# Obelisk Application Deployment Guide

2−

3This document serves two purposes, the first one is to guide new users that want to deploy Obelisk/Reflex apps and the second one to provide a walk-through for test driving Obelisk releases.

2This document serves two purposes, the first one is to guide new users that want to deploy Obelisk/Reflex apps and the second one to provide a walk-through for test driving Obelisk releases.

4

3

5−> **Note:** This guide can be completed on a Linux host with Nix installed or a macOS host with Nix installed. Each section is labeled regarding which operating system hosts it supports. When going through the guide, start at the beginning and go through all sections that are supported on your host and merely skip sections that are not supported. The sections for iOS deployments require an iPhone or iPad device and the sections for Android deployments require an Android device. This guide assumes that you have Nix correctly set up and that your system is configured to fetch from binary caches instead of building everything on your machine. If you notice any of the commands below takes more than 5 minutes, then caches are not likely enabled.

4+> **Note:** To complete this *entire* guide you need access to a macOS machine running the latest OSX release, a Linux machine (can be a VM on that mac) with Nix installed, an iPhone or iPad, and a recent Android device. It also assumes that you have Nix correctly set up and that your system is set up to fetch from binary caches instead of building everything on your machine. If you notice any of the commands below takes more than 5 minutes, then caches are not likely enabled.

6>

5>

7> Refer to the [Obelisk Installation Documentation](https://github.com/obsidiansystems/obelisk#installing-obelisk) for instructions on configuring the binary caches for any Nix-compatible setup.

6> Refer to the [Obelisk Installation Documentation](https://github.com/obsidiansystems/obelisk#installing-obelisk) for instructions on configuring the binary caches for any Nix-compatible setup.

8

7

9−## a) Get Obelisk (Linux, Mac)

8+## a) Get Obelisk

10

9

11−There are several ways to install Obelisk, but the one we are going to use here allows us to test a single version of Obelisk in different ways. The approach is to clone Obelisk from its GitHub repository and start a project that uses that local check out.

10+There are several ways to install Obelisk, but the one we are going to use here allows us to test a single version of Obelisk in different ways. The approach is to clone Obelisk from it's GitHub repository and start a project that uses that local check out.

12

11

13Open a terminal and run the following:

12Open a terminal and run the following:

14

13

@@ -40,7 +39,7 @@ ob init --branch "$OBELISK_BRANCH"

40

39

41> **Note:** If the `--branch` parameter is not used, then Obelisk sets your project up to look at the `master` branch from GitHub. This is quite handy for real life projects but distracting for our test drive since we want to make sure any changes we do to the Obelisk codebase (like testing a pull request) are immediately picked up.

40> **Note:** If the `--branch` parameter is not used, then Obelisk sets your project up to look at the `master` branch from GitHub. This is quite handy for real life projects but distracting for our test drive since we want to make sure any changes we do to the Obelisk codebase (like testing a pull request) are immediately picked up.

42

41

43−## b) Run the Obelisk app on localhost (Linux, Mac)

42+## b) Run the Obelisk app on localhost

44

43

45Let's test that we can run a server on localhost. This is quite easy:

44Let's test that we can run a server on localhost. This is quite easy:

46

45

@@ -53,10 +52,9 @@ Now open a browser and point it to http://localhost:8000 (or just click on this

53

52

54![](assets/app-deploy.png)

53![](assets/app-deploy.png)

55

54

56−## c) Prepare a VirtualBox deploy target (Linux, Mac)

55+## c) Deploy the web app on a remote machine

57

56

58### Import the NixOS VirtualBox appliance

57### Import the NixOS VirtualBox appliance

59−

60Install [VirtualBox](https://www.virtualbox.org/) on your machine.

58Install [VirtualBox](https://www.virtualbox.org/) on your machine.

61

59

62On NixOS, do this by adding the following line to your `/etc/nixos/configuration.nix` before the last line containing `}`:

60On NixOS, do this by adding the following line to your `/etc/nixos/configuration.nix` before the last line containing `}`:

@@ -81,7 +79,7 @@ You should now see a NixOS machine in the dashboard:

81

79

82![](assets/virtualbox-dashboard-nixos.png)

80![](assets/virtualbox-dashboard-nixos.png)

83

81

84−If you are on a network with DHCP on your wireless or network card then right-click on the "NixOS" image and click "Settings". Go to the "Network" section and make "Attached to:" set to "Bridged Adapter".

82+If you are on a network with DHCP on your wireless or network card then select right-click on the "NixOS" image and click "Settings". Go to the "Network" section and make "Attached to:" set to "Bridged Adapter".

85

83

86![](assets/virtualbox-image-settings-network.png)

84![](assets/virtualbox-image-settings-network.png)

87

85

@@ -203,7 +201,7 @@ git remote add origin "$WORKDIR/myapp-git-remote"

203git push -u origin master

201git push -u origin master

204```

202```

205

203

206−### Initialize deployment directory

204+### Deploy

207

205

208With that, we can come back to the Obelisk app and initialize the deployment:

206With that, we can come back to the Obelisk app and initialize the deployment:

209

207

@@ -218,11 +216,7 @@ Then configure the deployment for VirtualBox:

218echo '{nixosPkgs, ...}: {...}: { imports = [ (nixosPkgs.path + /nixos/modules/virtualisation/virtualbox-image.nix) ]; }' > "$WORKDIR/myappdeploy/module.nix"

216echo '{nixosPkgs, ...}: {...}: { imports = [ (nixosPkgs.path + /nixos/modules/virtualisation/virtualbox-image.nix) ]; }' > "$WORKDIR/myappdeploy/module.nix"

219```

217```

220

218

221−## d) Deploy to VirtualBox target (Linux only)

219+And deploy:

222−

223−> Deploying requires a Linux host in order to build the Linux binaries.

224−

225−Now we can deploy to the VirtualBox VM.

226

220

227```bash

221```bash

228cd "$WORKDIR/myappdeploy"

222cd "$WORKDIR/myappdeploy"

@@ -249,7 +243,7 @@ It should look like this:

249

243

250Congratulations! You have deployed an Obelisk application to a remote server via SSH.

244Congratulations! You have deployed an Obelisk application to a remote server via SSH.

251

245

252−## e) Deploy an Android app (Linux only)

246+## d) Deploy an Android app (Linux host only)

253

247

254> **Note:** This section requires that you be running a Linux *host*.

248> **Note:** This section requires that you be running a Linux *host*.

255

249

@@ -292,7 +286,7 @@ When the deployment is complete opening the app should look something like

292

286

293Congratulations! You have deployed an Obelisk Android app via USB.

287Congratulations! You have deployed an Obelisk Android app via USB.

294

288

295−## f) Deploy an iOS app (Mac only)

289+## e) Deploy an iOS app (macOS host only)

296

290

297> **Note:** This section requires that you be running a macOS *host*.

291> **Note:** This section requires that you be running a macOS *host*.

298

292

haskell-overlays/ghcide.nix+32−38

@@ -1,40 +1,34 @@

1self: super:

2−let

2+ let

3− pkgs = self.callPackage ({ pkgs }: pkgs) { };

3+ pkgs = self.callPackage ({ pkgs }: pkgs) {};

4− inherit (pkgs.haskell.lib) dontCheck justStaticExecutables;

4+ inherit (pkgs.haskell.lib) dontCheck;

5− inherit (pkgs.haskellPackages) callHackageDirect callHackage;

6−

7−in {

5+ in {

8− ghcide = justStaticExecutables (dontCheck (callHackageDirect {

6+ ghcide = pkgs.haskell.lib.justStaticExecutables (dontCheck ((self.override {

9− pkg = "ghcide";

7+ overrides = self: super: {

8+ ghc-check = self.callHackageDirect {

9+ pkg = "ghc-check";

10− ver = "0.2.0";

10+ ver = "0.1.0.3";

11− sha256 = "199l4qzrghhz6wbfkgqdl4gll4wvgpr190kinzhv88idnn9pxm96";

11+ sha256 = "038llbvryk5y27jbdpbshp0zw5lw1j6m7qk7vx1n96ykqdzkh649";

12− } rec {

12+ } {};

13− ghc-check = callHackageDirect {

13+ lsp-test = dontCheck (self.callHackage "lsp-test" "0.6.1.0" {});

14− pkg = "ghc-check";

14+ haddock-library = dontCheck (self.callHackage "haddock-library" "1.8.0" {});

15− ver = "0.3.0.1";

15+ haskell-lsp = dontCheck (self.callHackage "haskell-lsp" "0.19.0.0" {});

16− sha256 = "1dj909m09m24315x51vxvcl28936ahsw4mavbc53danif3wy09ns";

16+ haskell-lsp-types = dontCheck (self.callHackage "haskell-lsp-types" "0.19.0.0" {});

17− } { };

17+ regex-posix = dontCheck (self.callHackage "regex-posix" "0.96.0.0" {});

18− lsp-test = dontCheck (callHackage "lsp-test" "0.6.1.0" { });

18+ test-framework = dontCheck (self.callHackage "test-framework" "0.8.2.0" {});

19− haddock-library = dontCheck (callHackage "haddock-library" "1.8.0" { });

20− haskell-lsp = dontCheck (callHackageDirect {

21− pkg = "haskell-lsp";

22− ver = "0.22.0.0";

23− sha256 = "1q3w46qcvzraxgmw75s7bl0qvb2fvff242r5vfx95sqska566b4m";

24− } { inherit haskell-lsp-types; });

25− haskell-lsp-types = dontCheck (callHackageDirect {

26− pkg = "haskell-lsp-types";

27− ver = "0.22.0.0";

28− sha256 = "1apjclphi2v6ggrdnbc0azxbb1gkfj3x1vkwpc8qd6lsrbyaf0n8";

29− } { });

30− regex-tdfa = dontCheck (callHackage "regex-tdfa" "1.3.1.0" {

31− regex-base = dontCheck (callHackage "regex-base" "0.94.0.0" { });

19+ regex-base = dontCheck (self.callHackage "regex-base" "0.94.0.0" {});

32− });

20+ regex-tdfa = dontCheck (self.callHackage "regex-tdfa" "1.3.1.0" {});

33− shake = dontCheck (callHackage "shake" "0.18.4" { });

21+ shake = dontCheck (self.callHackage "shake" "0.18.4" {});

34− hie-bios = dontCheck (callHackageDirect {

22+ hie-bios = dontCheck (self.callHackageDirect {

35− pkg = "hie-bios";

23+ pkg = "hie-bios";

36− ver = "0.5.0";

24+ ver = "0.4.0";

37− sha256 = "116nmpva5jmlgc2dgy8cm5wv6cinhzmga1l0432p305074w720r2";

25+ sha256 = "19lpg9ymd9656cy17vna8wr1hvzfal94gpm2d3xpnw1d5qr37z7x";

38− } { });

26+ } {});

39− }));

27+ };

28+ }).callCabal2nix "ghcide" (pkgs.fetchFromGitHub {

29+ owner = "digital-asset";

30+ repo = "ghcide";

31+ rev = "v0.1.0";

32+ sha256 = "1kf71iix46hvyxviimrcv7kvsj67hcnnqlpdsmazmlmybf7wbqbb";

33+ }) {}));

40}

34}

haskell-overlays/misc-deps.nix+2−8

@@ -9,14 +9,8 @@ let

9in

10

11{

12− regex-base = self.callHackage "regex-base" "0.94.0.0" {};

12+ hnix = haskellLib.dontCheck (haskellLib.doJailbreak (self.callCabal2nix "hnix" (hackGet ../dep/hnix) {}));

13− regex-posix = self.callHackage "regex-posix" "0.96.0.0" {};

14− regex-tdfa = self.callHackage "regex-tdfa" "1.3.1.0" {};

15− test-framework = haskellLib.dontCheck (self.callHackage "test-framework" "0.8.2.0" {});

16− hnix = haskellLib.dontCheck (self.callHackage "hnix" "0.8.0" {});

17− hnix-store-core = self.callHackage "hnix-store-core" "0.2.0.0" {};

13+ hnix-store-core = self.callHackage "hnix-store-core" "0.1.0.0" {};

18−

19− aeson-gadt-th = self.callHackage "aeson-gadt-th" "0.2.4" {};

20

14

21 ghcid = self.callCabal2nix "ghcid" (hackGet ../dep/ghcid) {};

15 ghcid = self.callCabal2nix "ghcid" (hackGet ../dep/ghcid) {};

22 # Exports more internals

16 # Exports more internals

haskell-overlays/obelisk.nix−5

@@ -19,12 +19,7 @@ in

19 obelisk-command = haskellLib.overrideCabal (self.callCabal2nix "obelisk-command" (obeliskCleanSource ../lib/command) {}) {

20 librarySystemDepends = [

21 pkgs.jre

22− pkgs.git

23 pkgs.nix

22 pkgs.nix

24− pkgs.nix-prefetch-git

25− pkgs.openssh

26− pkgs.rsync

27− pkgs.which

28 (haskellLib.justStaticExecutables self.ghcid)

23 (haskellLib.justStaticExecutables self.ghcid)

29 ];

24 ];

30 };

25 };

lib/asset/README.md+19−16

@@ -1,26 +1,29 @@

1−# obelisk-asset

1+## obelisk-asset

2

3−[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)

3+The 'assets.nix' file contains nix expressions that are a mutually

4−[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)

5−

6−**Efficiently served, aggressively cached static web resources.**

7−

8−The `assets.nix` file contains nix expressions that are a mutually recursive set of attributes used to create static asset directories with hashable file encodings. This file should be incorporated within your project's `default.nix` file. (See `example/default.nix`, line 2)

4+recursive set of attributes used to create static asset directories

9−

5+with hashable file encodings. This file should be incorporated within

6+your project's 'default.nix' file. (See ./example/default.nix , line 2)

10−```nix

7+```

11−{ assets ? import ./../assets.nix { inherit nixpkgs; } }:

8+{assets ? import ./../assets.nix { inherit nixpkgs; }

9+}:

12```

10```

13

11

14−The `mkAssets` and `mkAssetsWith` functions within `assets.nix` only need to be passed an `encoding("zopfliEncodings", "gzipEncodings", "noEncodings")` and a static directory of your choice as arguments.

12+The 'mkAssets' and 'mkAssetsWith' functions within 'assets.nix' only

15−

13+need to be passed an encoding('zopfliEncodings', 'gzipEncodings',

16−In this example, `mkAssets` is used on a directory that has a `.png` file inside of it. (See `example/default.nix`, line 11)

14+'noEncodings') and a static directory of your choice as arguments.

17

15

18−```nix

16+In this example, 'mkAssets' is used on a directory that has a .png

17+file inside of it. (See ./example/default.nix, line 11)

18+```

19myAssets = assets.mkAssets ./static;

20```

21

22−Once you have successfully incorporated `assets.nix` into your project's nix file(s), use `nix-build` to generate a symlink of your `mkAssets` expression. The following command from `example/run-example` (line 3) will generate an immutable symlink that holds hashed static assets.

22+Once you have successfully incorporated 'assets.nix' into your

23−

23+project's nix file(s), use nix-build to generate a symlink of

24+your 'mkAssets' expression. The following command from

25+example/run-example (line 3) will generate an immutable symlink

26+that holds hashed static assets.

24```bash

27```bash

25nix-build -o static.assets -A myAssets

28nix-build -o static.assets -A myAssets

26```

29```

lib/asset/assets.nix+5−28

@@ -20,7 +20,7 @@ zopfliEncodings = file:

20 nixpkgs.stdenv.mkDerivation {

21 name = "encodings";

22

23− input = mkPath file;

23+ input = file;

24

25 builder = builtins.toFile "builder.sh" ''

26 source "$stdenv/setup"

@@ -46,7 +46,7 @@ gzipEncodings = file:

46 nixpkgs.stdenv.mkDerivation {

47 name = "encodings";

48

49− input = mkPath file;

49+ input = file;

50

51 builder = builtins.toFile "builder.sh" ''

52 source "$stdenv/setup"

@@ -70,7 +70,7 @@ noEncodings = file:

70 nixpkgs.stdenv.mkDerivation {

71 name = "encodings";

72

73− input = mkPath file;

73+ input = file;

74

75 builder = builtins.toFile "builder.sh" ''

76 source "$stdenv/setup"

@@ -203,7 +203,7 @@ hashFile = path:

203 nixpkgs.nix

204 ];

205 preferLocalBuild = true;

206− path = mkPath path;

206+ inherit path;

207 } ''

208 nix-hash --flat --base32 --type sha256 "$path" | tr -d '\n' >"$out"

209 '');

@@ -224,30 +224,7 @@ symlink = path: {

224 inherit path;

225};

226

227−# Tests if a given character (string of length 1) is valid for a derivation path name.

228−# Passing a string of length other than 1 is undefined.

229−# :: Char -> Bool

230−isValidDrvNameChar = c: "a" <= c && c <= "z" || "A" <= c && c <= "Z" || "0" <= c && c <= "9" || c == "+" || c == "-" || c == "_" || c == "?" || c == "=" || c == ".";

231−

232−# Convert a string into a string that could be used in a derivation name.

233−# replacement lets you choose how to replace invalid characters. It may be any length.

234−# If it contains invalid characters then the result will also be invalid.

235−# :: { str :: String, replacement :: String } -> String

236−mkValidDrvName = { str, replacement ? "?" }:

237− let

238− newName = stringAsChars (c: if isValidDrvNameChar c then c else replacement) str;

239− in if builtins.substring 0 1 newName == "." then "_" + newName else newName;

240−

241−# Like builtins.path but always ensures the name is valid.

242−mkPath = path:

243− if builtins.typeOf path == "path" # Don't mess with non-paths

244− then builtins.path {

245− inherit path;

246− name = mkValidDrvName { str = builtins.baseNameOf path; };

247− }

248− else path;

249−

250−# Given an encoding generation function and a file entry resulting from readDirRecursive in the form { name :: String, value: { path :: String } },

227+# Given a encoding generation function and a file entry resulting from readDirRecursive in the form { name :: String, value: { path :: String } },

251# build a DirEntry for dirToPath with the various encodings of the asset for dirToPath to build into a final directory tree.

228# build a DirEntry for dirToPath with the various encodings of the asset for dirToPath to build into a final directory tree.

252mkAsset = encodings: {name, value}:

229mkAsset = encodings: {name, value}:

253 let nameWithHash = "${hashFile value.path}-${name}";

230 let nameWithHash = "${hashFile value.path}-${name}";

lib/asset/manifest/obelisk-asset-manifest.cabal+2−4

@@ -24,7 +24,7 @@ library

24 , template-haskell

25 , text

26 , transformers

27− , unix-compat

27+ , unix

28 , vector

29 exposed-modules:

30 Obelisk.Asset.Gather

@@ -33,9 +33,7 @@ library

33 Obelisk.Asset.TH

34

35 other-extensions: TemplateHaskell

36− ghc-options:

37− -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O2

38− -fno-warn-unused-do-bind -funbox-strict-fields -fprof-auto-calls

36+ ghc-options: -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs -funbox-strict-fields -O2 -fprof-auto-calls

39

37

40executable obelisk-asset-manifest-generate

38executable obelisk-asset-manifest-generate

41 hs-source-dirs: src-bin

39 hs-source-dirs: src-bin

lib/asset/manifest/src/Obelisk/Asset/Symlink.hs+1−1

@@ -7,7 +7,7 @@ import Data.Map (Map)

7import qualified Data.Map as Map

8import System.Directory

9import System.FilePath.Posix

10−import System.PosixCompat.Files

10+import System.Posix.Files

11

12-- | Copy the given hashed files from one location to hashed paths in another

13-- location, and symlink the unhashed paths to the hashed ones

lib/asset/serve-snap/obelisk-asset-serve-snap.cabal+2−4

@@ -23,12 +23,10 @@ library

23 , obelisk-snap-extras

24 , text

25 , transformers

26− , unix-compat

26+ , unix

27 exposed-modules:

28 Obelisk.Asset.Accept

29 Obelisk.Asset.Serve.Snap

30

31 other-extensions: TemplateHaskell

32− ghc-options:

33− -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O2

34− -fno-warn-unused-do-bind -funbox-strict-fields -fprof-auto-calls

32+ ghc-options: -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs -funbox-strict-fields -O2 -fprof-auto-calls

lib/asset/serve-snap/src/Obelisk/Asset/Serve/Snap.hs+1−1

@@ -31,7 +31,7 @@ import Data.Text.Encoding (decodeUtf8, encodeUtf8)

31import System.Directory (getDirectoryContents)

32import System.FilePath ((</>), splitFileName, takeDirectory)

33import System.IO.Error (isDoesNotExistError)

34−import System.PosixCompat.Files (getFileStatus, fileSize)

34+import System.Posix (getFileStatus, fileSize)

35

36-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.

37--

lib/backend/obelisk-backend.cabal+2−2

@@ -21,10 +21,10 @@ library

21 obelisk-frontend,

22 obelisk-route,

23 obelisk-snap-extras,

24− reflex-dom-core,

24+ reflex-dom,

25 snap,

26 snap-server,

27 text,

28 universe

29 exposed-modules: Obelisk.Backend

30− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O

30+ ghc-options: -Wall

lib/backend/src/Obelisk/Backend.hs+1−1

@@ -58,7 +58,7 @@ import qualified Obelisk.ExecutableConfig.Lookup as Lookup

58import Obelisk.Frontend

59import Obelisk.Route

60import Obelisk.Snap.Extras (doNotCache, serveFileIfExistsAs)

61−import Reflex.Dom.Core

61+import Reflex.Dom

62import Snap (MonadSnap, Snap, commandLineConfig, defaultConfig, getsRequest, httpServe, modifyResponse

63 , rqPathInfo, rqQueryString, setContentType, writeBS, writeText

64 , rqCookies, Cookie(..) , setHeader)

lib/cliapp/obelisk-cliapp.cabal+2−1

@@ -18,6 +18,7 @@ library

18 , logging-effect

19 , monad-loops

20 , mtl

21+ , posix-escape

21 , process

22 , process

22 , shell-escape

23 , shell-escape

23 , terminal-size

24 , terminal-size

@@ -34,4 +35,4 @@ library

34 Obelisk.CliApp.TerminalString

35 Obelisk.CliApp.TerminalString

35 Obelisk.CliApp.Theme

36 Obelisk.CliApp.Theme

36 Obelisk.CliApp.Types

37 Obelisk.CliApp.Types

37− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O

38+ ghc-options: -Wall -fobject-code

lib/cliapp/src/Obelisk/CliApp.hs−3

@@ -39,9 +39,7 @@ module Obelisk.CliApp

39 , callCommand

40 , callProcess

41 , callProcessAndLogOutput

42− , createProcess

43 , createProcess_

42 , createProcess_

44− , exitCodeToException

45 , overCreateProcess

43 , overCreateProcess

46 , proc

44 , proc

47 , readCreateProcessWithExitCode

45 , readCreateProcessWithExitCode

@@ -49,7 +47,6 @@ module Obelisk.CliApp

49 , readProcessAndLogStderr

47 , readProcessAndLogStderr

50 , readProcessJSONAndLogStderr

48 , readProcessJSONAndLogStderr

51 , reconstructCommand

49 , reconstructCommand

52− , runProcess_

53 , setCwd

50 , setCwd

54 , setDelegateCtlc

51 , setDelegateCtlc

55 , setEnvOverride

52 , setEnvOverride

lib/cliapp/src/Obelisk/CliApp/Logging.hs+2−2

@@ -160,7 +160,7 @@ failWith :: (CliThrow e m, AsUnstructuredError e) => Text -> m a

160failWith = throwError . review asUnstructuredError

161

162errorToWarning

163− :: (HasCliConfig e m, CliLog m)

163+ :: (HasCliConfig e m, CliThrow e m, CliLog m)

164 => e -> m ()

165errorToWarning e = do

166 c <- getCliConfig

@@ -177,7 +177,7 @@ withExitFailMessage msg f = f `catch` \(e :: ExitCode) -> do

177 throwM e

178

179-- | Write log to stdout, with colors (unless `noColor`)

180−writeLog :: (MonadIO m) => Bool -> Bool -> WithSeverity Text -> m ()

180+writeLog :: (MonadIO m, MonadMask m) => Bool -> Bool -> WithSeverity Text -> m ()

181writeLog withNewLine noColor (WithSeverity severity s) = if T.null s then pure () else write

182 where

183 write

lib/cliapp/src/Obelisk/CliApp/Process.hs+27−44

@@ -1,6 +1,7 @@

1{-# LANGUAGE FlexibleContexts #-}

2{-# LANGUAGE LambdaCase #-}

3{-# LANGUAGE MultiParamTypeClasses #-}

4+{-# LANGUAGE MultiWayIf #-}

4{-# LANGUAGE OverloadedStrings #-}

5{-# LANGUAGE OverloadedStrings #-}

5{-# LANGUAGE ScopedTypeVariables #-}

6{-# LANGUAGE ScopedTypeVariables #-}

6{-# LANGUAGE TupleSections #-}

7{-# LANGUAGE TupleSections #-}

@@ -16,7 +17,6 @@ module Obelisk.CliApp.Process

16 , callProcessAndLogOutput

17 , callProcessAndLogOutput

17 , createProcess

18 , createProcess

18 , createProcess_

19 , createProcess_

19− , exitCodeToException

20 , overCreateProcess

21 , proc

22 , readCreateProcessWithExitCode

@@ -24,7 +24,6 @@ module Obelisk.CliApp.Process

24 , readProcessAndLogStderr

25 , readProcessJSONAndLogStderr

26 , reconstructCommand

27− , runProcess_

28 , setCwd

27 , setCwd

29 , setDelegateCtlc

28 , setDelegateCtlc

30 , setEnvOverride

29 , setEnvOverride

@@ -33,7 +32,6 @@ module Obelisk.CliApp.Process

33 ) where

32 ) where

34

33

35import Control.Monad ((<=<), join, void)

34import Control.Monad ((<=<), join, void)

36−import Control.Monad.Catch (MonadMask, bracketOnError)

37import Control.Monad.Except (throwError)

35import Control.Monad.Except (throwError)

38import Control.Monad.Fail

36import Control.Monad.Fail

39import Control.Monad.IO.Class (MonadIO, liftIO)

37import Control.Monad.IO.Class (MonadIO, liftIO)

@@ -101,7 +99,7 @@ instance AsProcessFailure ProcessFailure where

101 asProcessFailure = id

99 asProcessFailure = id

102

100

103readProcessAndLogStderr

101readProcessAndLogStderr

104− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)

102+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)

105 => Severity -> ProcessSpec -> m Text

103 => Severity -> ProcessSpec -> m Text

106readProcessAndLogStderr sev process = do

104readProcessAndLogStderr sev process = do

107 (out, _err) <- withProcess process $ \_out err -> do

105 (out, _err) <- withProcess process $ \_out err -> do

@@ -109,7 +107,7 @@ readProcessAndLogStderr sev process = do

109 liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out

107 liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out

110

108

111readProcessJSONAndLogStderr

109readProcessJSONAndLogStderr

112− :: (Aeson.FromJSON a, MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)

110+ :: (Aeson.FromJSON a, MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)

113 => Severity -> ProcessSpec -> m a

111 => Severity -> ProcessSpec -> m a

114readProcessJSONAndLogStderr sev process = do

112readProcessJSONAndLogStderr sev process = do

115 (out, _err) <- withProcess process $ \_out err -> do

113 (out, _err) <- withProcess process $ \_out err -> do

@@ -122,7 +120,7 @@ readProcessJSONAndLogStderr sev process = do

122 throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) 0

120 throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) 0

123

121

124readCreateProcessWithExitCode

122readCreateProcessWithExitCode

125− :: (MonadIO m, CliLog m)

123+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)

126 => ProcessSpec -> m (ExitCode, String, String)

124 => ProcessSpec -> m (ExitCode, String, String)

127readCreateProcessWithExitCode procSpec = do

125readCreateProcessWithExitCode procSpec = do

128 process <- mkCreateProcess procSpec

126 process <- mkCreateProcess procSpec

@@ -132,10 +130,10 @@ readCreateProcessWithExitCode procSpec = do

132-- | Like `System.Process.readProcess` but logs the combined output (stdout and stderr)

130-- | Like `System.Process.readProcess` but logs the combined output (stdout and stderr)

133-- with the corresponding severity.

131-- with the corresponding severity.

134--

132--

135−-- Usually this function is called as `readProcessAndLogOutput (Debug, Error)`. However

133+-- Usually this function is called as `callProcessAndLogOutput (Debug, Error)`. However

136-- some processes are known to spit out diagnostic or informative messages in stderr, in

134-- some processes are known to spit out diagnostic or informative messages in stderr, in

137-- which case it is advisable to call it with a non-Error severity for stderr, like

135-- which case it is advisable to call it with a non-Error severity for stderr, like

138−-- `readProcessAndLogOutput (Debug, Debug)`.

136+-- `callProcessAndLogOutput (Debug, Debug)`.

139readProcessAndLogOutput

137readProcessAndLogOutput

140 :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)

138 :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)

141 => (Severity, Severity) -> ProcessSpec -> m Text

139 => (Severity, Severity) -> ProcessSpec -> m Text

@@ -148,7 +146,9 @@ readProcessAndLogOutput (sev_out, sev_err) process = do

148 outText <- liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out

146 outText <- liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out

149 putLogRaw sev_out outText

147 putLogRaw sev_out outText

150

148

151− outText <$ (exitCodeToException process =<< waitForProcess p)

149+ waitForProcess p >>= \case

150+ ExitSuccess -> pure outText

151+ ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) code

152

153-- | Like 'System.Process.callProcess' but logs the combined output (stdout and stderr)

154-- with the corresponding severity.

@@ -158,7 +158,7 @@ readProcessAndLogOutput (sev_out, sev_err) process = do

158-- which case it is advisable to call it with a non-Error severity for stderr, like

159-- `callProcessAndLogOutput (Debug, Debug)`.

160callProcessAndLogOutput

161− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)

161+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)

162 => (Severity, Severity) -> ProcessSpec -> m ()

163callProcessAndLogOutput (sev_out, sev_err) process =

164 void $ withProcess process $ \out err -> do

@@ -188,11 +188,12 @@ createProcess_ name procSpec = do

188 liftIO $ Process.createProcess_ name p

189

190mkCreateProcess :: MonadIO m => ProcessSpec -> m Process.CreateProcess

191−mkCreateProcess (ProcessSpec p override') = case override' of

191+mkCreateProcess (ProcessSpec p override') = do

192+ case override' of

192− Nothing -> pure p

193+ Nothing -> pure p

193− Just override -> do

194+ Just override -> do

194− procEnv <- Map.fromList <$> maybe (liftIO getEnvironment) pure (Process.env p)

195+ procEnv <- Map.fromList <$> maybe (liftIO getEnvironment) pure (Process.env p)

195− pure $ p { Process.env = Just $ Map.toAscList (override procEnv) }

196+ pure $ p { Process.env = Just $ Map.toAscList (override procEnv) }

196

197

197-- | Like `System.Process.callProcess` but also logs (debug) the process being run

198-- | Like `System.Process.callProcess` but also logs (debug) the process being run

198callProcess

199callProcess

@@ -211,30 +212,18 @@ callCommand cmd = do

211 liftIO $ Process.callCommand cmd

212 liftIO $ Process.callCommand cmd

212

213

213withProcess

214withProcess

214− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)

215+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)

215 => ProcessSpec -> (Handle -> Handle -> m ()) -> m (Handle, Handle)

216 => ProcessSpec -> (Handle -> Handle -> m ()) -> m (Handle, Handle)

216−withProcess process f =

217+withProcess process f = do -- TODO: Use bracket.

217− bracketOnError

218+ -- FIXME: Using `withCreateProcess` here leads to something operating illegally on closed handles.

218− (createProcess $ overCreateProcess

219+ (_, Just out, Just err, p) <- createProcess $ overCreateProcess

219− (\x -> x { std_out = CreatePipe , std_err = CreatePipe }) process

220+ (\x -> x { std_out = CreatePipe , std_err = CreatePipe }) process

220− )

221+

221− (liftIO . Process.cleanupProcess)

222+ f out err -- Pass the handles to the passed function

222− (\case

223+

223− (_, Just out, Just err, p) -> do

224+ waitForProcess p >>= \case

224− f out err

225+ ExitSuccess -> return (out, err)

225− (out, err) <$ (exitCodeToException process =<< waitForProcess p)

226+ ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) code

226− _ -> error "withProcess: createProcess did not provide handles for CreatePipe as expected"

227− )

228−

229−-- | Runs a process to completion failing if it does not exit cleanly.

230−runProcess_

231− :: (MonadIO m, CliLog m, CliThrow e m, MonadMask m, AsProcessFailure e)

232− => ProcessSpec -> m ()

233−runProcess_ process =

234− bracketOnError

235− (createProcess process)

236− (liftIO . Process.cleanupProcess)

237− (\(_, _, _, ph) -> exitCodeToException process =<< waitForProcess ph)

238

227

239-- Create an input stream from the file handle, associating each item with the given severity.

228-- Create an input stream from the file handle, associating each item with the given severity.

240streamHandle :: Severity -> Handle -> IO (InputStream (Severity, BSC.ByteString))

229streamHandle :: Severity -> Handle -> IO (InputStream (Severity, BSC.ByteString))

@@ -253,12 +242,6 @@ streamToLog stream = fix $ \loop -> do

253waitForProcess :: MonadIO m => ProcessHandle -> m ExitCode

242waitForProcess :: MonadIO m => ProcessHandle -> m ExitCode

254waitForProcess = liftIO . Process.waitForProcess

243waitForProcess = liftIO . Process.waitForProcess

255

244

256−-- | Converts an 'ExitCode' to an exception when it's non-zero.

257−exitCodeToException :: (CliThrow e m, AsProcessFailure e) => ProcessSpec -> ExitCode -> m ()

258−exitCodeToException spec = \case

259− ExitSuccess -> pure ()

260− ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess spec) code

261−

262-- | Pretty print a 'CmdSpec'

245-- | Pretty print a 'CmdSpec'

263reconstructCommand :: Process.CmdSpec -> Text

246reconstructCommand :: Process.CmdSpec -> Text

264reconstructCommand p = case p of

247reconstructCommand p = case p of

lib/command/obelisk-command.cabal+3−3

@@ -1,5 +1,5 @@

1name: obelisk-command

2−version: 0.9.0.1

2+version: 0.8.0.0

3cabal-version: >= 1.8

4build-type: Simple

5

@@ -45,7 +45,7 @@ library

45 , text

46 , time

47 , transformers

48− , unix-compat

48+ , unix

49 , unordered-containers

50 , utf8-string

51 , which

@@ -66,4 +66,4 @@ library

66executable ob

67 main-is: src-bin/ob.hs

68 build-depends: base, obelisk-command

69− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -threaded

69+ ghc-options: -Wall -O2 -threaded

lib/command/src/Obelisk/Command.hs+7−9

@@ -8,6 +8,7 @@ module Obelisk.Command where

8

9import Control.Monad.IO.Class (MonadIO, liftIO)

10import Data.Bool (bool)

11+import qualified Data.ByteString.UTF8 as BSU

11import Data.Foldable (for_)

12import Data.Foldable (for_)

12import Data.List (isInfixOf, isPrefixOf)

13import Data.List (isInfixOf, isPrefixOf)

13import Data.List.NonEmpty (NonEmpty, nonEmpty)

14import Data.List.NonEmpty (NonEmpty, nonEmpty)

@@ -22,7 +23,8 @@ import System.Environment

22import System.FilePath

23import System.FilePath

23import qualified System.Info

24import qualified System.Info

24import System.IO (hIsTerminalDevice, stdout)

25import System.IO (hIsTerminalDevice, stdout)

26+import Text.ShellEscape (bash, bytes)

25−import System.Process (rawSystem)

27+import System.Posix.Process (executeFile)

26

28

27import Obelisk.App

29import Obelisk.App

28import Obelisk.CliApp

30import Obelisk.CliApp

@@ -114,7 +116,7 @@ obCommand cfg = hsubparser

114 , command "thunk" $ info (ObCommand_Thunk <$> thunkOption) $ progDesc "Manipulate thunk directories"

116 , command "thunk" $ info (ObCommand_Thunk <$> thunkOption) $ progDesc "Manipulate thunk directories"

115 , command "repl" $ info (ObCommand_Repl <$> interpretOpts) $ progDesc "Open an interactive interpreter"

117 , command "repl" $ info (ObCommand_Repl <$> interpretOpts) $ progDesc "Open an interactive interpreter"

116 , command "watch" $ info (ObCommand_Watch <$> interpretOpts) $ progDesc "Watch current project for errors and warnings"

118 , command "watch" $ info (ObCommand_Watch <$> interpretOpts) $ progDesc "Watch current project for errors and warnings"

117− , command "shell" $ info (ObCommand_Shell <$> shellOpts) $ progDesc "Enter a shell with project dependencies or run a command in such a shell. E.g. ob shell -- ghc-pkg list"

119+ , command "shell" $ info (ObCommand_Shell <$> shellOpts) $ progDesc "Enter a shell with project dependencies"

118 , command "doc" $ info (ObCommand_Doc <$> shellFlags <*> packageNames) $

120 , command "doc" $ info (ObCommand_Doc <$> shellFlags <*> packageNames) $

119 progDesc "List paths to haddock documentation for specified packages"

121 progDesc "List paths to haddock documentation for specified packages"

120 <> footerDoc (Just $

122 <> footerDoc (Just $

@@ -285,10 +287,7 @@ shellOpts :: Parser ShellOpts

285shellOpts = ShellOpts

287shellOpts = ShellOpts

286 <$> shellFlags

288 <$> shellFlags

287 <*> interpretOpts

289 <*> interpretOpts

288− -- This funny construction is used to support optparse-applicative's @--@ parsing.

289− -- All arguments after @--@ are left unparsed and instead provided to the last positional parser

290− -- which must therefore be 'many' in order to consume the rest of the input.

291− <*> ((\xs -> if null xs then Nothing else Just $ unwords xs) <$> many (strArgument (metavar "COMMAND")))

290+ <*> optional (strArgument (metavar "COMMAND"))

292

291

293portOpt :: Int -> Parser Int

292portOpt :: Int -> Parser Int

294portOpt dfault = option auto (long "port" <> short 'p' <> help "Port number for server" <> showDefault <> value dfault <> metavar "INT")

293portOpt dfault = option auto (long "port" <> short 'p' <> help "Port number for server" <> showDefault <> value dfault <> metavar "INT")

@@ -366,8 +365,7 @@ main' argsCfg = do

366 Just impl -> do

365 Just impl -> do

367 -- Invoke the real implementation, using --no-handoff to prevent infinite recursion

366 -- Invoke the real implementation, using --no-handoff to prevent infinite recursion

368 putLog Debug $ "Handing off to " <> T.pack impl

367 putLog Debug $ "Handing off to " <> T.pack impl

369− _ <- liftIO $ rawSystem impl ("--no-handoff" : myArgs)

368+ liftIO $ executeFile impl False ("--no-handoff" : myArgs) Nothing

370− return ()

371 case myArgs of

369 case myArgs of

372 "--no-handoff" : as -> go as -- If we've been told not to hand off, don't hand off

370 "--no-handoff" : as -> go as -- If we've been told not to hand off, don't hand off

373 origPath:inPath:outPath:preprocessorName:packagePaths

371 origPath:inPath:outPath:preprocessorName:packagePaths

@@ -402,7 +400,7 @@ ob = \case

402 ObCommand_Repl interpretPathsList -> withInterpretPaths interpretPathsList runRepl

400 ObCommand_Repl interpretPathsList -> withInterpretPaths interpretPathsList runRepl

403 ObCommand_Watch interpretPathsList -> withInterpretPaths interpretPathsList runWatch

401 ObCommand_Watch interpretPathsList -> withInterpretPaths interpretPathsList runWatch

404 ObCommand_Shell (ShellOpts shellAttr interpretPathsList cmd) -> withInterpretPaths interpretPathsList $ \root interpretPaths ->

402 ObCommand_Shell (ShellOpts shellAttr interpretPathsList cmd) -> withInterpretPaths interpretPathsList $ \root interpretPaths ->

405− nixShellForInterpretPaths False shellAttr root interpretPaths cmd -- N.B. We do NOT bash escape here; we want to run the command as-is

403+ nixShellForInterpretPaths False shellAttr root interpretPaths (BSU.toString . bytes . bash . BSU.fromString <$> cmd)

406 ObCommand_Doc shellAttr pkgs -> withInterpretPaths [] $ \root interpretPaths ->

404 ObCommand_Doc shellAttr pkgs -> withInterpretPaths [] $ \root interpretPaths ->

407 nixShellForInterpretPaths True shellAttr root interpretPaths $ Just $ haddockCommand pkgs

405 nixShellForInterpretPaths True shellAttr root interpretPaths $ Just $ haddockCommand pkgs

408 ObCommand_Hoogle shell' port -> withProjectRoot "." $ \root -> do

406 ObCommand_Hoogle shell' port -> withProjectRoot "." $ \root -> do

lib/command/src/Obelisk/Command/Deploy.hs+16−16

@@ -25,7 +25,7 @@ import GHC.Generics

25import System.Directory

26import System.FilePath

27import System.IO

28−import System.PosixCompat.Files

28+import System.Posix.Files

29import Text.URI (URI)

30import qualified Text.URI as URI

31import Text.URI.Lens

@@ -85,12 +85,13 @@ deployInit' thunkPtr (DeployInitOpts deployDir sshKeyPath hostnames route adminE

85 --accidentally create a production deployment that uses development

86 --credentials to connect to some resources. This could result in, e.g.,

87 --production data backed up to a dev environment.

88− withSpinner "Creating project configuration directories" $ liftIO $ do

88+ withSpinner "Creating project configuration directories" $ do

89− mapM_ (createDirectoryIfMissing True)

89+ callProcessAndLogOutput (Notice, Error) $

90+ proc "mkdir" [ "-p"

90− [ deployDir </> "config" </> "backend"

91+ , deployDir </> "config" </> "backend"

91− , deployDir </> "config" </> "common"

92+ , deployDir </> "config" </> "common"

92− , deployDir </> "config" </> "frontend"

93+ , deployDir </> "config" </> "frontend"

93− ]

94+ ]

94

95

95 let srcDir = deployDir </> "src"

96 let srcDir = deployDir </> "src"

96 withSpinner ("Creating source thunk (" <> T.pack (makeRelative deployDir srcDir) <> ")") $ do

97 withSpinner ("Creating source thunk (" <> T.pack (makeRelative deployDir srcDir) <> ")") $ do

@@ -161,8 +162,8 @@ deployPush deployPath getNixBuilders = do

161 "nix-copy-closure" ["-v", "--to", "--use-substitutes", "root@" <> host, "--gzip", outputPath]

162 "nix-copy-closure" ["-v", "--to", "--use-substitutes", "root@" <> host, "--gzip", outputPath]

162 withSpinner "Uploading config" $ ifor_ buildOutputByHost $ \host _ -> do

163 withSpinner "Uploading config" $ ifor_ buildOutputByHost $ \host _ -> do

163 callProcessAndLogOutput (Notice, Warning) $

164 callProcessAndLogOutput (Notice, Warning) $

164− proc rsyncPath

165+ proc "rsync"

165− [ "-e " <> sshPath <> " " <> unwords sshOpts

166+ [ "-e ssh " <> unwords sshOpts

166 , "-qarvz"

167 , "-qarvz"

167 , deployPath </> "config"

168 , deployPath </> "config"

168 , "root@" <> host <> ":/var/lib/backend"

169 , "root@" <> host <> ":/var/lib/backend"

@@ -170,10 +171,9 @@ deployPush deployPath getNixBuilders = do

170 --TODO: Create GC root so we're sure our closure won't go away during this time period

171 --TODO: Create GC root so we're sure our closure won't go away during this time period

171 withSpinner "Switching to new configuration" $ ifor_ buildOutputByHost $ \host outputPath -> do

172 withSpinner "Switching to new configuration" $ ifor_ buildOutputByHost $ \host outputPath -> do

172 callProcessAndLogOutput (Notice, Warning) $

173 callProcessAndLogOutput (Notice, Warning) $

173− proc sshPath $ sshOpts <>

174+ proc "ssh" $ sshOpts <>

174 [ "root@" <> host

175 [ "root@" <> host

175 , unwords

176 , unwords

176− -- Note that we don't want to $(staticWhich "nix-env") here, because this is executing on a remote machine

177 [ "nix-env -p /nix/var/nix/profiles/system --set " <> outputPath

178 , "&&"

179 , "/nix/var/nix/profiles/system/bin/switch-to-configuration switch"

@@ -182,10 +182,10 @@ deployPush deployPath getNixBuilders = do

182 isClean <- checkGitCleanStatus deployPath True

183 when (not isClean) $ do

184 withSpinner "Committing changes to Git" $ do

185− callProcessAndLogOutput (Debug, Error) $

185+ callProcessAndLogOutput (Debug, Error) $ proc "git"

186− gitProc deployPath ["add", "."]

186+ ["-C", deployPath, "add", "."]

187− callProcessAndLogOutput (Debug, Error) $

187+ callProcessAndLogOutput (Debug, Error) $ proc "git"

188− gitProc deployPath ["commit", "-m", "New deployment"]

188+ ["-C", deployPath, "commit", "-m", "New deployment"]

189 putLog Notice $ "Deployed => " <> T.pack route

190 where

191 callProcess' envMap cmd args = do

@@ -315,7 +315,7 @@ readDeployConfig deployDir fname = liftIO $ do

315

316verifyHostKey :: MonadObelisk m => FilePath -> FilePath -> String -> m ()

317verifyHostKey knownHostsPath keyPath hostName =

318− callProcessAndLogOutput (Notice, Warning) $ proc sshPath $

318+ callProcessAndLogOutput (Notice, Warning) $ proc "ssh" $

319 sshArgs knownHostsPath keyPath True <>

320 [ "root@" <> hostName

321 , "-o", "NumberOfPasswordPrompts=0"

lib/command/src/Obelisk/Command/Preprocessor.hs+47−52

@@ -5,7 +5,6 @@ module Obelisk.Command.Preprocessor where

5

6import qualified Data.ByteString.Lazy as BL

7import qualified Data.ByteString.Lazy.Builder as BU

8−import Data.Foldable (for_)

9import Data.List (intersperse, isPrefixOf, sortOn)

8import Data.List (intersperse, isPrefixOf, sortOn)

10import Data.Maybe (fromMaybe)

9import Data.Maybe (fromMaybe)

11import qualified Data.Text.Lazy.Builder as TL

10import qualified Data.Text.Lazy.Builder as TL

@@ -18,83 +17,79 @@ import System.FilePath (hasTrailingPathSeparator, joinPath, splitPath)

18

17

19import Obelisk.Command.Run (CabalPackageInfo (..), parseCabalPackage')

18import Obelisk.Command.Run (CabalPackageInfo (..), parseCabalPackage')

20

19

21−-- | This code is intended to be executed via ghci's -pgmF preprocessor option.

22−-- The command line arguments are passed in via ghc, which dictates the first three options and meanings

23−-- In order for this code to execute, origPath must contain either a '.' character or a '/' character.

24−-- (This is to avoid the possibility of the command line syntax conflicting with another ob command)

25−-- We do have control over the remaining arguments, but they must be the same for all files.

26−-- Thus, the fourth command line argument must be "apply-packages", which has already been handled.

27−-- We assume all the remaining arguments passed in are paths to cabal or hpack package specifications.

28−-- Thus we must select among the packagePaths for the file we are going to parse.

29applyPackages :: FilePath -> FilePath -> FilePath -> [FilePath] -> IO ()

20applyPackages :: FilePath -> FilePath -> FilePath -> [FilePath] -> IO ()

30−applyPackages origPath inPath outPath packagePaths' = do

21+applyPackages origPath inPath outPath packagePaths' = withFile outPath WriteMode $ \outFile -> do

22+ -- This code is intended to be executed via ghci's -pgmF preprocessor option

23+ -- The command line arguments are passed in via ghc, which dictates the first three options and meanings

24+ -- In order for this code to execute, origPath must contain either a '.' character or a '/' character.

25+ -- (This is to avoid the possibility of the command line syntax conflicting with another ob command)

26+ -- We do have control over the remaining arguments, but they must be the same for all files.

27+ -- Thus, the fourth command line argument must be "apply-packages", which has already been handled.

28+ -- We assume all the remaining arguments passed in are paths to cabal or hpack package specifications.

29+ -- Thus we must select among the packagePaths for the file we are going to parse.

30+

31 origPathCanonical <- canonicalizePath origPath

32 packagePaths <- traverse canonicalizePath packagePaths'

33

34− let

35− takeDirs = takeWhile hasTrailingPathSeparator

34+ let takeDirs = takeWhile hasTrailingPathSeparator

36− packageDirs = sortOn (negate . length . takeDirs) $ map splitPath packagePaths

35+ packageDirs = sortOn (negate . length . takeDirs) $ map splitPath packagePaths

37− origDir = splitPath origPathCanonical

36+ origDir = splitPath origPathCanonical

38− matches = [ joinPath d | d <- packageDirs, takeDirs d `isPrefixOf` origDir ]

37+ matches = [ joinPath d | d <- packageDirs, takeDirs d `isPrefixOf` origDir ]

39

38

40− -- The first element of matches is going to be the deepest path to a package spec that contains

39+ -- So the first element of matches is going to be the deepest path to a package spec that contains

41 -- our file as a subdirectory.

40 -- our file as a subdirectory.

41+

42− packageInfo' <- case matches of

42+ case matches of

43− [] -> do

43+ [] ->

44 hPutStrLn stderr $ "Error: Unable to find cabal information for " <> origPath <> "; Skipping preprocessor."

45− pure Nothing

45+ packagePath:_ -> do

46− packagePath:_ -> parseCabalPackage' packagePath >>= \case

46+ parseCabalPackage' packagePath >>= \case

47− Left err -> do

47+ Left err ->

48− hPutStrLn stderr $ "Error: Unable to parse cabal package " <> packagePath <> "; Skipping preprocessor on " <> origPath <> ". Error: " <> show err

48+ hPutStrLn stderr $ "Error: Unable to parse cabal package " <> packagePath <> "; Skipping preprocessor on " <> origPath <> ". Error: " <> show err

49− pure Nothing

50− Right (Just (_, packageInfo)) -> pure $ Just packageInfo

49+ Right (_warnings, packageInfo) ->

51− Right Nothing -> pure Nothing

50+ hPutTextBuilder outFile (generateHeader origPath packageInfo)

52

51

53− writeOutput packageInfo' inPath outPath

52+ BL.readFile inPath >>= BL.hPut outFile

54

53

55−writeOutput :: Maybe CabalPackageInfo -> FilePath -> FilePath -> IO ()

56−writeOutput packageInfo' origPath outPath = withFile outPath WriteMode $ \hOut -> do

57− for_ packageInfo' $ \packageInfo -> hPutTextBuilder hOut (generateHeader origPath packageInfo)

58− BL.readFile origPath >>= BL.hPut hOut

59 where

54 where

60 hPutTextBuilder h = BU.hPutBuilder h . TL.encodeUtf8Builder . TL.toLazyText

55 hPutTextBuilder h = BU.hPutBuilder h . TL.encodeUtf8Builder . TL.toLazyText

61

56

57+

58+ -- I'm pretty sure there's a certain amount of oversimplification in CabalPackageInfo, so I doubt this is fully robust.

59+

62generateHeader :: FilePath -> CabalPackageInfo -> TL.Builder

60generateHeader :: FilePath -> CabalPackageInfo -> TL.Builder

63generateHeader origPath packageInfo =

61generateHeader origPath packageInfo =

64 hsExtensions <> ghcOptions <> lineNumberPragma origPath

62 hsExtensions <> ghcOptions <> lineNumberPragma origPath

65 where

63 where

66 hsExtensions =

64 hsExtensions =

67− if null extList

65+ if not (null extList)

68− then mempty

66+ then TL.fromText "{-# LANGUAGE "

69− else pragma $ TL.fromText "LANGUAGE " <> mconcat (intersperse (TL.fromText ", ") extList)

67+ <> mconcat (intersperse (TL.fromText ", ") extList)

68+ <> TL.fromText " #-}\n"

69+ else mempty

70 extList = addDefaultLanguage $ concatMap showExt $ _cabalPackageInfo_defaultExtensions packageInfo

71 addDefaultLanguage =

72 case _cabalPackageInfo_defaultLanguage packageInfo of

73 Nothing -> id

74 Just x -> case x of

75− UnknownLanguage ext -> (TL.fromString ext :)

75+ UnknownLanguage ext -> ( TL.fromString ext :)

76− ext -> (TL.fromString (show ext) :)

76+ ext -> ( TL.fromString (show ext) :)

77 showExt = \case

78 EnableExtension ext -> [TL.fromString (show ext)]

79− DisableExtension ext -> ["No" <> TL.fromString (show ext)]

79+ DisableExtension _ -> []

80 UnknownExtension ext -> [TL.fromString ext]

81

82 ghcOptions =

83− if null optList

83+ if not (null optList)

84− then mempty

84+ then TL.fromText "{-# OPTIONS_GHC "

85− else pragma $

86− TL.fromText "OPTIONS_GHC " <> mconcat (intersperse (TL.fromText " ") (map TL.fromString optList))

85+ <> mconcat (intersperse (TL.fromText " ") optList)

87− ghcOptList

86+ <> TL.fromText " #-}\n"

87+ else mempty

88+ optList = map TL.fromString

88− = filter (not . isPrefixOf "-O")

89+ $ filter (not . isPrefixOf "-O")

89− $ fromMaybe []

90+ $ fromMaybe []

90− $ lookup GHC (_cabalPackageInfo_compilerOptions packageInfo)

91+ $ lookup GHC (_cabalPackageInfo_compilerOptions packageInfo)

91− optList = _cabalPackageInfo_cppOptions packageInfo <> ghcOptList

92

93lineNumberPragma :: FilePath -> TL.Builder

94+lineNumberPragma origPath =

94−lineNumberPragma origPath = pragma $ TL.fromText "LINE 1 " <> quoted '"' (TL.fromString origPath)

95+ TL.fromText "{-# LINE 1 \"" <> TL.fromString origPath <> TL.fromText "\" #-}\n"

95−

96−pragma :: TL.Builder -> TL.Builder

97−pragma x = TL.fromText "{-# " <> x <> TL.fromText " #-}\n"

98−

99−quoted :: Char -> TL.Builder -> TL.Builder

100−quoted char x = TL.singleton char <> x <> TL.singleton char

lib/command/src/Obelisk/Command/Project.hs+10−19

@@ -15,7 +15,6 @@ module Obelisk.Command.Project

15 , toImplDir

16 , toObeliskDir

17 , withProjectRoot

18− , bashEscape

19 ) where

18 ) where

20

19

21import Control.Concurrent.MVar (MVar, newMVar, withMVarMasked)

20import Control.Concurrent.MVar (MVar, newMVar, withMVarMasked)

@@ -39,9 +38,8 @@ import System.Environment (lookupEnv)

39import System.FilePath

38import System.FilePath

40import System.IO.Temp

39import System.IO.Temp

41import System.IO.Unsafe (unsafePerformIO)

40import System.IO.Unsafe (unsafePerformIO)

42−import System.PosixCompat.Files

41+import System.Posix (FileStatus, FileMode, CMode (..), UserID, deviceID, fileID, fileMode, fileOwner, getFileStatus, getRealUserID)

43−import System.PosixCompat.Types

42+import System.Posix.Files

44−import System.PosixCompat.User

45import Text.ShellEscape (bash, bytes)

43import Text.ShellEscape (bash, bytes)

46

44

47import GitHub.Data.GitData (Branch)

45import GitHub.Data.GitData (Branch)

@@ -51,7 +49,7 @@ import Obelisk.App (MonadObelisk)

51import Obelisk.CliApp

49import Obelisk.CliApp

52import Obelisk.Command.Nix

50import Obelisk.Command.Nix

53import Obelisk.Command.Thunk

51import Obelisk.Command.Thunk

54−import Obelisk.Command.Utils (nixBuildExePath, nixExePath, toNixPath, cp, nixShellPath)

52+import Obelisk.Command.Utils (nixBuildExePath, nixExePath, toNixPath)

55

53

56--TODO: Make this module resilient to random exceptions

54--TODO: Make this module resilient to random exceptions

57

55

@@ -116,7 +114,7 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do

116 skel <- nixBuildAttrWithCache implDir "skeleton" --TODO: I don't think there's actually any reason to cache this

114 skel <- nixBuildAttrWithCache implDir "skeleton" --TODO: I don't think there's actually any reason to cache this

117

115

118 callProcessAndLogOutput (Notice, Error) $

116 callProcessAndLogOutput (Notice, Error) $

119− proc cp

117+ proc "cp"

120 [ "-r"

118 [ "-r"

121 , "--preserve=links"

119 , "--preserve=links"

122 , obDir

120 , obDir

@@ -126,7 +124,7 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do

126

124

127 withSpinner "Copying project skeleton" $ do

125 withSpinner "Copying project skeleton" $ do

128 callProcessAndLogOutput (Notice, Error) $

126 callProcessAndLogOutput (Notice, Error) $

129− proc cp

127+ proc "cp"

130 [ "-r"

128 [ "-r"

131 , "--no-preserve=mode"

129 , "--no-preserve=mode"

132 , "-T"

130 , "-T"

@@ -137,12 +135,6 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do

137 let configDir = "config"

135 let configDir = "config"

138 createDirectoryIfMissing False configDir

136 createDirectoryIfMissing False configDir

139 mapM_ (createDirectoryIfMissing False . (configDir </>)) ["backend", "common", "frontend"]

137 mapM_ (createDirectoryIfMissing False . (configDir </>)) ["backend", "common", "frontend"]

140− putLog Notice $ T.intercalate "\n"

141− [ "An obelisk project has been successfully initialized. Next steps:"

142− , " 'ob run': Start a development server"

143− , " 'ob watch': Watch for changes without starting a server"

144− , " 'ob repl': Load your project into GHCi"

145− ]

146

138

147callHandoffOb

139callHandoffOb

148 :: MonadObelisk m

140 :: MonadObelisk m

@@ -294,11 +286,8 @@ nixShellRunConfig root isPure command = do

294 , [cs]

286 , [cs]

295 ])

287 ])

296

288

297−bashEscape :: String -> String

298−bashEscape = BSU.toString . bytes . bash . BSU.fromString

299−

300nixShellRunProc :: NixShellConfig -> ProcessSpec

289nixShellRunProc :: NixShellConfig -> ProcessSpec

301−nixShellRunProc cfg = setDelegateCtlc True $ proc nixShellPath $ runNixShellConfig cfg

290+nixShellRunProc cfg = setDelegateCtlc True $ proc "nix-shell" $ runNixShellConfig cfg

302

291

303nixShellWithoutPkgs

292nixShellWithoutPkgs

304 :: MonadObelisk m

293 :: MonadObelisk m

@@ -313,7 +302,7 @@ nixShellWithoutPkgs root isPure chdirToRoot packageNamesAndPaths shellAttr comma

313 packageNamesAndAbsPaths <- liftIO $ for packageNamesAndPaths makeAbsolute

302 packageNamesAndAbsPaths <- liftIO $ for packageNamesAndPaths makeAbsolute

314 defShellConfig <- nixShellRunConfig root isPure command

303 defShellConfig <- nixShellRunConfig root isPure command

315 let setCwd_ = if chdirToRoot then setCwd (Just root) else id

304 let setCwd_ = if chdirToRoot then setCwd (Just root) else id

316− runProcess_ $ setCwd_ $ nixShellRunProc $ defShellConfig

305+ (_, _, _, ph) <- createProcess_ "nixShellWithoutPkgs" $ setCwd_ $ nixShellRunProc $ defShellConfig

317 & nixShellConfig_common . nixCmdConfig_target . target_expr ?~

306 & nixShellConfig_common . nixCmdConfig_target . target_expr ?~

318 "{root, pkgs, shell}: ((import root {}).passthru.__unstable__.self.extend (_: _: {\

307 "{root, pkgs, shell}: ((import root {}).passthru.__unstable__.self.extend (_: _: {\

319 \shellPackages = builtins.fromJSON pkgs;\

308 \shellPackages = builtins.fromJSON pkgs;\

@@ -323,16 +312,18 @@ nixShellWithoutPkgs root isPure chdirToRoot packageNamesAndPaths shellAttr comma

323 , strArg "pkgs" (T.unpack $ decodeUtf8 $ BSL.toStrict $ Json.encode packageNamesAndAbsPaths)

312 , strArg "pkgs" (T.unpack $ decodeUtf8 $ BSL.toStrict $ Json.encode packageNamesAndAbsPaths)

324 , strArg "shell" shellAttr

313 , strArg "shell" shellAttr

325 ]

314 ]

315+ void $ waitForProcess ph

326

316

327nixShellWithHoogle :: MonadObelisk m => FilePath -> Bool -> String -> Maybe String -> m ()

317nixShellWithHoogle :: MonadObelisk m => FilePath -> Bool -> String -> Maybe String -> m ()

328nixShellWithHoogle root isPure shell' command = do

318nixShellWithHoogle root isPure shell' command = do

329 defShellConfig <- nixShellRunConfig root isPure command

319 defShellConfig <- nixShellRunConfig root isPure command

330− runProcess_ $ setCwd (Just root) $ nixShellRunProc $ defShellConfig

320+ (_, _, _, ph) <- createProcess_ "nixShellWithHoogle" $ setCwd (Just root) $ nixShellRunProc $ defShellConfig

331 & nixShellConfig_common . nixCmdConfig_target . target_expr ?~

321 & nixShellConfig_common . nixCmdConfig_target . target_expr ?~

332 "{shell}: ((import ./. {}).passthru.__unstable__.self.extend (_: super: {\

322 "{shell}: ((import ./. {}).passthru.__unstable__.self.extend (_: super: {\

333 \userSettings = super.userSettings // { withHoogle = true; };\

323 \userSettings = super.userSettings // { withHoogle = true; };\

334 \})).project.shells.${shell}"

324 \})).project.shells.${shell}"

335 & nixShellConfig_common . nixCmdConfig_args .~ [ strArg "shell" shell' ]

325 & nixShellConfig_common . nixCmdConfig_args .~ [ strArg "shell" shell' ]

326+ void $ waitForProcess ph

336

327

337findProjectAssets :: MonadObelisk m => FilePath -> m Text

328findProjectAssets :: MonadObelisk m => FilePath -> m Text

338findProjectAssets root = do

329findProjectAssets root = do

lib/command/src/Obelisk/Command/Run.hs+51−64

@@ -14,25 +14,24 @@ module Obelisk.Command.Run where

14import Control.Arrow ((&&&))

15import Control.Exception (Exception, bracket)

16import Control.Lens (ifor, (.~), (&))

17−import Control.Monad (filterM)

17+import Control.Monad (filterM, unless, void)

18import Control.Monad.Except (runExceptT, throwError)

19import Control.Monad.IO.Class (liftIO)

20import Control.Monad.Reader (MonadIO)

21import Data.Bifoldable (bifoldr1)

22import Data.Bifunctor (bimap)

23+import qualified Data.ByteString.UTF8 as BSU

23import Data.Coerce (coerce)

24import Data.Coerce (coerce)

24import Data.Default (def)

25import Data.Default (def)

25import Data.Either (partitionEithers)

26import Data.Either (partitionEithers)

26import Data.Foldable (fold, for_, toList)

27import Data.Foldable (fold, for_, toList)

27import Data.Functor.Identity (runIdentity)

28import Data.Functor.Identity (runIdentity)

28−import Data.List (intercalate)

29import Data.List.NonEmpty (NonEmpty)

30import qualified Data.List.NonEmpty as NE

31import Data.Map (Map)

32import qualified Data.Map as Map

33import qualified Data.Map.Monoidal as MMap

34−import Data.Maybe (catMaybes, fromMaybe, mapMaybe)

34+import Data.Maybe

35−import Data.Ord (comparing)

36import Data.Set (Set)

35import Data.Set (Set)

37import qualified Data.Set as Set

36import qualified Data.Set as Set

38import Data.String.Here.Interpolated (i)

37import Data.String.Here.Interpolated (i)

@@ -46,38 +45,40 @@ import Distribution.Compiler (CompilerFlavor(..))

46import Distribution.PackageDescription.Parsec (parseGenericPackageDescription)

45import Distribution.PackageDescription.Parsec (parseGenericPackageDescription)

47import Distribution.Parsec.ParseResult (runParseResult)

46import Distribution.Parsec.ParseResult (runParseResult)

48import qualified Distribution.System as Dist

47import qualified Distribution.System as Dist

49−import Distribution.Types.BuildInfo (buildable, cppOptions, defaultExtensions, defaultLanguage, hsSourceDirs, options)

48+import Distribution.Types.BuildInfo

50−import Distribution.Types.CondTree (simplifyCondTree)

49+import Distribution.Types.CondTree

51−import Distribution.Types.GenericPackageDescription (ConfVar (Arch, Impl, OS), condLibrary)

50+import Distribution.Types.GenericPackageDescription

52−import Distribution.Types.Library (libBuildInfo)

51+import Distribution.Types.Library

53−import Distribution.Utils.Generic (toUTF8BS, readUTF8File)

52+import Distribution.Utils.Generic

54import qualified Distribution.Parsec.Common as Dist

53import qualified Distribution.Parsec.Common as Dist

55import qualified Hpack.Config as Hpack

54import qualified Hpack.Config as Hpack

56import qualified Hpack.Render as Hpack

55import qualified Hpack.Render as Hpack

57import qualified Hpack.Yaml as Hpack

56import qualified Hpack.Yaml as Hpack

58−import Language.Haskell.Extension (Extension, Language)

57+import Language.Haskell.Extension

59−import qualified Network.Socket as Socket

58+import Network.Socket hiding (Debug)

60import System.Directory

59import System.Directory

61import System.Environment (getExecutablePath)

60import System.Environment (getExecutablePath)

62import System.FilePath

61import System.FilePath

63import qualified System.Info

62import qualified System.Info

64import System.IO.Temp (withSystemTempDirectory)

63import System.IO.Temp (withSystemTempDirectory)

64+import Text.ShellEscape (bash, bytes)

65

66import Obelisk.App (MonadObelisk)

67import Obelisk.CliApp (

68 Severity (..),

69+ createProcess_,

69 failWith,

70 failWith,

70 proc,

71 proc,

71 putLog,

72 putLog,

72 readCreateProcessWithExitCode,

73 readCreateProcessWithExitCode,

73 readProcessAndLogStderr,

74 readProcessAndLogStderr,

74− runProcess_,

75 setCwd,

76 setDelegateCtlc,

77+ waitForProcess,

77 withSpinner,

78 withSpinner,

78 )

79 )

79import Obelisk.Command.Nix

80import Obelisk.Command.Nix

80−import Obelisk.Command.Project (nixShellWithoutPkgs, withProjectRoot, findProjectAssets, bashEscape)

81+import Obelisk.Command.Project (nixShellWithoutPkgs, withProjectRoot, findProjectAssets)

81import Obelisk.Command.Thunk (attrCacheFileName)

82import Obelisk.Command.Thunk (attrCacheFileName)

82import Obelisk.Command.Utils (findExePath, ghcidExePath)

83import Obelisk.Command.Utils (findExePath, ghcidExePath)

83

84

@@ -94,11 +95,9 @@ data CabalPackageInfo = CabalPackageInfo

94 -- ^ List of globally set languages of the library component

95 -- ^ List of globally set languages of the library component

95 , _cabalPackageInfo_compilerOptions :: [(CompilerFlavor, [String])]

96 , _cabalPackageInfo_compilerOptions :: [(CompilerFlavor, [String])]

96 -- ^ List of compiler-specific options (e.g., the "ghc-options" field of the cabal file)

97 -- ^ List of compiler-specific options (e.g., the "ghc-options" field of the cabal file)

97− , _cabalPackageInfo_cppOptions :: [String]

98− -- ^ List of CPP (C Preprocessor) options (e.g. the "cpp-options" field of the cabal file)

99 }

98 }

100

99

101−-- | 'Bool' with a better name for its purpose.

100+-- | 'Bool' with a better name for it's purpose.

102data Interpret = Interpret_Interpret | Interpret_NoInterpret deriving (Eq, Ord, Show)

101data Interpret = Interpret_Interpret | Interpret_NoInterpret deriving (Eq, Ord, Show)

103

102

104textInterpret :: Interpret -> Text

103textInterpret :: Interpret -> Text

@@ -151,7 +150,7 @@ profile profileBasePattern rtsFlags = withProjectRoot "." $ \root -> do

151 liftIO $ createDirectoryIfMissing True $ takeDirectory $ root </> profileBaseName

150 liftIO $ createDirectoryIfMissing True $ takeDirectory $ root </> profileBaseName

152 putLog Debug $ "Storing profiled data under base name of " <> T.pack (root </> profileBaseName)

151 putLog Debug $ "Storing profiled data under base name of " <> T.pack (root </> profileBaseName)

153 freePort <- getFreePort

152 freePort <- getFreePort

154− runProcess_ $ setCwd (Just root) $ setDelegateCtlc True $ proc (outPath </> "bin" </> "ob-run") $

153+ (_, _, _, ph) <- createProcess_ "runProfExe" $ setCwd (Just root) $ setDelegateCtlc True $ proc (outPath </> "bin" </> "ob-run") $

155 [ show freePort

154 [ show freePort

156 , T.unpack assets

155 , T.unpack assets

157 , profileBaseName

156 , profileBaseName

@@ -159,16 +158,17 @@ profile profileBasePattern rtsFlags = withProjectRoot "." $ \root -> do

159 , "-po" <> profileBaseName

158 , "-po" <> profileBaseName

160 ] <> rtsFlags

159 ] <> rtsFlags

161 <> [ "-RTS" ]

160 <> [ "-RTS" ]

161+ void $ waitForProcess ph

162

163run :: MonadObelisk m => FilePath -> PathTree Interpret -> m ()

164run root interpretPaths = do

165 pkgs <- getParsedLocalPkgs root interpretPaths

166+ withGhciScript pkgs $ \dotGhciPath -> do

166− assets <- findProjectAssets root

167+ assets <- findProjectAssets root

167− putLog Debug $ "Assets impurely loaded from: " <> assets

168+ putLog Debug $ "Assets impurely loaded from: " <> assets

168− ghciArgs <- getGhciSessionSettings pkgs root True

169+ ghciArgs <- getGhciSessionSettings pkgs root True

169− freePort <- getFreePort

170+ freePort <- getFreePort

170− withGhciScriptArgs pkgs $ \dotGhciArgs -> do

171− runGhcid root True (ghciArgs <> dotGhciArgs) pkgs $ Just $ unwords

171+ runGhcid root True (ghciArgs <> mkGhciScriptArg dotGhciPath) pkgs $ Just $ unwords

172 [ "Obelisk.Run.run"

173 , show freePort

174 , "(Obelisk.Run.runServeAsset " ++ show assets ++ ")"

@@ -180,15 +180,15 @@ runRepl :: MonadObelisk m => FilePath -> PathTree Interpret -> m ()

180runRepl root interpretPaths = do

181 pkgs <- getParsedLocalPkgs root interpretPaths

182 ghciArgs <- getGhciSessionSettings pkgs "." True

183− withGhciScriptArgs pkgs $ \dotGhciArgs ->

183+ withGhciScript pkgs $ \dotGhciPath ->

184− runGhciRepl root pkgs (ghciArgs <> dotGhciArgs)

184+ runGhciRepl root pkgs (ghciArgs <> mkGhciScriptArg dotGhciPath)

185

186runWatch :: MonadObelisk m => FilePath -> PathTree Interpret -> m ()

187runWatch root interpretPaths = do

188 pkgs <- getParsedLocalPkgs root interpretPaths

189 ghciArgs <- getGhciSessionSettings pkgs root True

190− withGhciScriptArgs pkgs $ \dotGhciArgs ->

190+ withGhciScript pkgs $ \dotGhciPath ->

191− runGhcid root True (ghciArgs <> dotGhciArgs) pkgs Nothing

191+ runGhcid root True (ghciArgs <> mkGhciScriptArg dotGhciPath) pkgs Nothing

192

193exportGhciConfig :: MonadObelisk m => Bool -> FilePath -> PathTree Interpret -> m [String]

194exportGhciConfig useRelativePaths root interpretPaths = do

@@ -304,16 +304,15 @@ parseCabalPackage

304 -> m (Maybe CabalPackageInfo)

305parseCabalPackage dir = parseCabalPackage' dir >>= \case

306 Left err -> Nothing <$ putLog Error err

307− Right (Just (warnings, pkgInfo)) -> do

307+ Right (warnings, pkgInfo) -> do

308 for_ warnings $ putLog Warning . T.pack . show

309 pure $ Just pkgInfo

310− Right Nothing -> pure Nothing

311

310

312-- | Like 'parseCabalPackage' but returns errors and warnings directly so as to avoid 'MonadObelisk'.

311-- | Like 'parseCabalPackage' but returns errors and warnings directly so as to avoid 'MonadObelisk'.

313parseCabalPackage'

312parseCabalPackage'

314 :: (MonadIO m)

313 :: (MonadIO m)

315 => FilePath -- ^ Package directory

314 => FilePath -- ^ Package directory

316− -> m (Either T.Text (Maybe ([Dist.PWarning], CabalPackageInfo)))

315+ -> m (Either T.Text ([Dist.PWarning], CabalPackageInfo))

317parseCabalPackage' pkg = runExceptT $ do

316parseCabalPackage' pkg = runExceptT $ do

318 (cabalContents, packageFile, packageName) <- guessCabalPackageFile pkg >>= \case

317 (cabalContents, packageFile, packageName) <- guessCabalPackageFile pkg >>= \case

319 Left GuessPackageFileError_NotFound -> throwError $ "No .cabal or package.yaml file found in " <> T.pack pkg

318 Left GuessPackageFileError_NotFound -> throwError $ "No .cabal or package.yaml file found in " <> T.pack pkg

@@ -341,7 +340,7 @@ parseCabalPackage' pkg = runExceptT $ do

341 case condLibrary <$> result of

340 case condLibrary <$> result of

342 Right (Just condLib) -> do

341 Right (Just condLib) -> do

343 let (_, lib) = simplifyCondTree evalConfVar condLib

342 let (_, lib) = simplifyCondTree evalConfVar condLib

344− pure $ Just $ (warnings,) $ CabalPackageInfo

343+ pure $ (warnings,) $ CabalPackageInfo

345 { _cabalPackageInfo_packageName = T.pack packageName

344 { _cabalPackageInfo_packageName = T.pack packageName

346 , _cabalPackageInfo_packageFile = packageFile

345 , _cabalPackageInfo_packageFile = packageFile

347 , _cabalPackageInfo_packageRoot = takeDirectory packageFile

346 , _cabalPackageInfo_packageRoot = takeDirectory packageFile

@@ -353,19 +352,18 @@ parseCabalPackage' pkg = runExceptT $ do

353 , _cabalPackageInfo_defaultLanguage =

352 , _cabalPackageInfo_defaultLanguage =

354 defaultLanguage $ libBuildInfo lib

353 defaultLanguage $ libBuildInfo lib

355 , _cabalPackageInfo_compilerOptions = options $ libBuildInfo lib

354 , _cabalPackageInfo_compilerOptions = options $ libBuildInfo lib

356− , _cabalPackageInfo_cppOptions = cppOptions $ libBuildInfo lib

357 }

355 }

358− Right Nothing -> pure Nothing

356+ Right Nothing -> throwError "Haskell package has no library component"

359 Left (_, errors) ->

357 Left (_, errors) ->

360 throwError $ T.pack $ "Failed to parse " <> packageFile <> ":\n" <> unlines (map show errors)

358 throwError $ T.pack $ "Failed to parse " <> packageFile <> ":\n" <> unlines (map show errors)

361

359

362parsePackagesOrFail :: (MonadObelisk m, Foldable f) => f FilePath -> m (NE.NonEmpty CabalPackageInfo)

360parsePackagesOrFail :: (MonadObelisk m, Foldable f) => f FilePath -> m (NE.NonEmpty CabalPackageInfo)

363parsePackagesOrFail dirs' = do

361parsePackagesOrFail dirs' = do

364− packageInfos' <- fmap catMaybes $ for dirs $ \dir -> do

362+ (pkgDirErrs, packageInfos') <- fmap partitionEithers $ for dirs $ \dir -> do

365 flip fmap (parseCabalPackage dir) $ \case

363 flip fmap (parseCabalPackage dir) $ \case

366 Just packageInfo

364 Just packageInfo

367− | _cabalPackageInfo_buildable packageInfo -> Just packageInfo

365+ | _cabalPackageInfo_buildable packageInfo -> Right packageInfo

368− _ -> Nothing

366+ _ -> Left dir

369

367

370 -- Sort duplicate packages such that we prefer shorter paths, but fall back to alphabetical ordering.

368 -- Sort duplicate packages such that we prefer shorter paths, but fall back to alphabetical ordering.

371 let packagesByName = Map.map (NE.sortBy $ comparing $ \p -> let n = _cabalPackageInfo_packageFile p in (length n, n))

369 let packagesByName = Map.map (NE.sortBy $ comparing $ \p -> let n = _cabalPackageInfo_packageFile p in (length n, n))

@@ -387,6 +385,9 @@ parsePackagesOrFail dirs' = do

387 "No valid, buildable packages found" <> (if null dirs then "" else " in " <> intercalate ", " dirs)

385 "No valid, buildable packages found" <> (if null dirs then "" else " in " <> intercalate ", " dirs)

388 Just xs -> pure xs

386 Just xs -> pure xs

389

387

388+ unless (null pkgDirErrs) $

389+ putLog Warning $ T.pack $ "Failed to find buildable packages in " <> intercalate ", " pkgDirErrs

390+

390 pure packageInfos

391 pure packageInfos

391 where

392 where

392 dirs = toList dirs'

393 dirs = toList dirs'

@@ -394,29 +395,13 @@ parsePackagesOrFail dirs' = do

394packageInfoToNamePathMap :: Foldable f => f CabalPackageInfo -> Map Text FilePath

395packageInfoToNamePathMap :: Foldable f => f CabalPackageInfo -> Map Text FilePath

395packageInfoToNamePathMap = Map.fromList . map (_cabalPackageInfo_packageName &&& _cabalPackageInfo_packageRoot) . toList

396packageInfoToNamePathMap = Map.fromList . map (_cabalPackageInfo_packageName &&& _cabalPackageInfo_packageRoot) . toList

396

397

397−-- Like 'withGhciScript' but provides the precise ghci arguments to add to a ghci session

398−withGhciScriptArgs

399− :: (MonadObelisk m, Foldable f)

400− => f CabalPackageInfo -- ^ List of packages to load into ghci

401− -> ([String] -> m ()) -- ^ Action to run with the extra ghci arguments

402− -> m ()

403−withGhciScriptArgs packageInfos f = withGhciScript loadPreludeManually packageInfos $ \fp -> f ["-XNoImplicitPrelude", "-ghci-script", fp]

404− where

405− -- These lines must be first and allow the session to support a custom Prelude when @-XNoImplicitPrelude@

406− -- is passed to the ghci session.

407− loadPreludeManually =

408− [ ":add Prelude" -- @:add@ is used because it's less noisy when there is no custom Prelude

409− , ":set -XImplicitPrelude" -- Turn the default setting on

410− ]

411−

412-- | Create ghci configuration to load the given packages

398-- | Create ghci configuration to load the given packages

413withGhciScript

399withGhciScript

414 :: (MonadObelisk m, Foldable f)

400 :: (MonadObelisk m, Foldable f)

415− => [String] -- ^ Commands to prefix to file

416− -> f CabalPackageInfo -- ^ List of packages to load into ghci

401+ => f CabalPackageInfo -- ^ List of packages to load into ghci

417 -> (FilePath -> m ()) -- ^ Action to run with the path to generated temporary .ghci

402 -> (FilePath -> m ()) -- ^ Action to run with the path to generated temporary .ghci

418 -> m ()

403 -> m ()

419−withGhciScript preCommands (toList -> packageInfos) f =

404+withGhciScript (toList -> packageInfos) f =

420 withSystemTempDirectory "ob-ghci" $ \fp -> do

405 withSystemTempDirectory "ob-ghci" $ \fp -> do

421 let dotGhciPath = fp </> ".ghci"

406 let dotGhciPath = fp </> ".ghci"

422 liftIO $ writeFile dotGhciPath dotGhci

407 liftIO $ writeFile dotGhciPath dotGhci

@@ -428,8 +413,7 @@ withGhciScript preCommands (toList -> packageInfos) f =

428 , [ "Backend" | "backend" `Set.member` packageNames ]

413 , [ "Backend" | "backend" `Set.member` packageNames ]

429 , [ "Frontend" | "frontend" `Set.member` packageNames ]

414 , [ "Frontend" | "frontend" `Set.member` packageNames ]

430 ]

415 ]

431− dotGhci = unlines $

416+ dotGhci = unlines

432− preCommands <>

433 [ if null modulesToLoad then "" else ":load " <> unwords modulesToLoad

417 [ if null modulesToLoad then "" else ":load " <> unwords modulesToLoad

434 , "import qualified Obelisk.Run"

418 , "import qualified Obelisk.Run"

435 , "import qualified Frontend"

419 , "import qualified Frontend"

@@ -482,7 +466,7 @@ runGhciRepl root (toList -> packages) ghciArgs =

482 -- NOTE: We do *not* want to use $(staticWhich "ghci") here because we need the

466 -- NOTE: We do *not* want to use $(staticWhich "ghci") here because we need the

483 -- ghc that is provided by the shell in the user's project.

467 -- ghc that is provided by the shell in the user's project.

484 nixShellWithoutPkgs root True False (packageInfoToNamePathMap packages) "ghc" $

468 nixShellWithoutPkgs root True False (packageInfoToNamePathMap packages) "ghc" $

485− Just $ unwords $ fmap bashEscape $ "ghci" : ghciArgs

469+ Just $ unwords $ fmap (BSU.toString . bytes . bash . BSU.fromString) $ "ghci" : ghciArgs

486

470

487-- | Run ghcid

471-- | Run ghcid

488runGhcid

472runGhcid

@@ -495,7 +479,7 @@ runGhcid

495 -> m ()

479 -> m ()

496runGhcid root chdirToRoot ghciArgs (toList -> packages) mcmd =

480runGhcid root chdirToRoot ghciArgs (toList -> packages) mcmd =

497 nixShellWithoutPkgs root True chdirToRoot (packageInfoToNamePathMap packages) "ghc" $

481 nixShellWithoutPkgs root True chdirToRoot (packageInfoToNamePathMap packages) "ghc" $

498− Just $ unwords $ fmap bashEscape $ ghcidExePath : opts

482+ Just $ unwords $ fmap (BSU.toString . bytes . bash . BSU.fromString) $ ghcidExePath : opts

499 where

483 where

500 opts = concat

484 opts = concat

501 [ ["-W"]

485 [ ["-W"]

@@ -509,14 +493,17 @@ runGhcid root chdirToRoot ghciArgs (toList -> packages) mcmd =

509 reloadFiles = map adjustRoot [root </> "config"]

493 reloadFiles = map adjustRoot [root </> "config"]

510 restartFiles = map (adjustRoot . _cabalPackageInfo_packageFile) packages

494 restartFiles = map (adjustRoot . _cabalPackageInfo_packageFile) packages

511

495

496+mkGhciScriptArg :: FilePath -> [String]

497+mkGhciScriptArg dotGhci = ["-ghci-script", dotGhci]

498+

512−getFreePort :: MonadIO m => m Socket.PortNumber

499+getFreePort :: MonadIO m => m PortNumber

513−getFreePort = liftIO $ Socket.withSocketsDo $ do

500+getFreePort = liftIO $ withSocketsDo $ do

514− addr:_ <- Socket.getAddrInfo (Just Socket.defaultHints) (Just "127.0.0.1") (Just "0")

501+ addr:_ <- getAddrInfo (Just defaultHints) (Just "127.0.0.1") (Just "0")

515− bracket (open addr) Socket.close Socket.socketPort

502+ bracket (open addr) close socketPort

516 where

503 where

517 open addr = do

504 open addr = do

518− sock <- Socket.socket (Socket.addrFamily addr) (Socket.addrSocketType addr) (Socket.addrProtocol addr)

505+ sock <- socket (addrFamily addr) (addrSocketType addr) (addrProtocol addr)

519− Socket.bind sock (Socket.addrAddress addr)

506+ bind sock (addrAddress addr)

520 return sock

507 return sock

521

508

522

509

lib/command/src/Obelisk/Command/Thunk.hs+3−3

@@ -56,7 +56,7 @@ import System.Exit

56import System.FilePath

57import System.IO.Error

58import System.IO.Temp

59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)

59+import System.Posix (getSymbolicLinkStatus, modificationTime)

60import qualified Text.URI as URI

61

62import Obelisk.App (MonadObelisk)

@@ -178,14 +178,14 @@ getNixSha256ForUriUnpacked

178getNixSha256ForUriUnpacked uri =

179 withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do

180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $

181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]

181+ proc "nix-prefetch-url" ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]

182 pure hash

183

184nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256

185nixPrefetchGit uri rev fetchSubmodules =

186 withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do

187 out <- readProcessAndLogStderr Debug $

188− proc nixPrefetchGitPath $ filter (/="")

188+ proc "nix-prefetch-git" $ filter (/="")

189 [ "--url", T.unpack $ gitUriToText uri

190 , "--rev", T.unpack rev

191 , if fetchSubmodules then "--fetch-submodules" else ""

lib/command/src/Obelisk/Command/Utils.hs+2−34

@@ -54,38 +54,6 @@ nixBuildExePath = $(staticWhich "nix-build")

54jreKeyToolPath :: FilePath

55jreKeyToolPath = $(staticWhich "keytool")

56

57−nixPrefetchGitPath :: FilePath

58−nixPrefetchGitPath = $(staticWhich "nix-prefetch-git")

59−

60−nixPrefetchUrlPath :: FilePath

61−nixPrefetchUrlPath = $(staticWhich "nix-prefetch-url")

62−

63−nixShellPath :: FilePath

64−nixShellPath = $(staticWhich "nix-shell")

65−

66−rsyncPath :: FilePath

67−rsyncPath = $(staticWhich "rsync")

68−

69−sshPath :: FilePath

70−sshPath = $(staticWhich "ssh")

71−

72−gitPath :: FilePath

73−gitPath = $(staticWhich "git")

74−

75−whichPath :: FilePath

76−whichPath = $(staticWhich "which")

77−

78−sshKeygenPath :: FilePath

79−sshKeygenPath = $(staticWhich "ssh-keygen")

80−

81−-- $(staticWhich "docker") was intentionally omitted, at least for now

82−-- One concern is that I don't know how particular docker is about having the

83−-- CLI exe match the version of the docker daemon, which is largely outside of

84−-- the control of obelisk-command.

85−-- TODO: Investigate the tradeoffs associated with this choice

86−dockerPath :: FilePath

87−dockerPath = "docker"

88−

89-- | Nix syntax requires relative paths to be prefixed by @./@ or

57-- | Nix syntax requires relative paths to be prefixed by @./@ or

90-- @../@. This will make a 'FilePath' that can be embedded in a Nix

58-- @../@. This will make a 'FilePath' that can be embedded in a Nix

91-- expression.

59-- expression.

@@ -123,7 +91,7 @@ initGit repo = do

123 git ["commit", "-m", "Initial commit."]

91 git ["commit", "-m", "Initial commit."]

124

92

125gitProcNoRepo :: [String] -> ProcessSpec

93gitProcNoRepo :: [String] -> ProcessSpec

126−gitProcNoRepo args = setEnvOverride (M.singleton "GIT_TERMINAL_PROMPT" "0" <>) $ proc gitPath args

94+gitProcNoRepo args = setEnvOverride (M.singleton "GIT_TERMINAL_PROMPT" "0" <>) $ proc "git" args

127

95

128gitProc :: FilePath -> [String] -> ProcessSpec

96gitProc :: FilePath -> [String] -> ProcessSpec

129gitProc repo = gitProcNoRepo . runGitInDir

97gitProc repo = gitProcNoRepo . runGitInDir

@@ -140,7 +108,7 @@ isolateGitProc = setEnvOverride (overrides <>)

140 , ("GIT_CONFIG_NOSYSTEM", "1")

108 , ("GIT_CONFIG_NOSYSTEM", "1")

141 , ("GIT_TERMINAL_PROMPT", "0") -- git 2.3+

109 , ("GIT_TERMINAL_PROMPT", "0") -- git 2.3+

142 , ("GIT_ASKPASS", "echo") -- pre git 2.3 to just use empty password

110 , ("GIT_ASKPASS", "echo") -- pre git 2.3 to just use empty password

143− , ("GIT_SSH_COMMAND", "ssh -o PreferredAuthentications=password -o PubkeyAuthentication=no -o GSSAPIAuthentication=no")

111+ , ("GIT_SSH_COMMAND", "ssh -o PreferredAuthentications password -o PubkeyAuthentication no -o GSSAPIAuthentication no")

144 ]

112 ]

145

113

146-- | Recursively copy a directory using `cp -a` -- TODO: Should use -rT instead of -a

114-- | Recursively copy a directory using `cp -a` -- TODO: Should use -rT instead of -a

lib/command/src/Obelisk/Command/VmBuilder.hs+8−8

@@ -21,7 +21,7 @@ import qualified System.Info

21

22import Obelisk.App (MonadObelisk, getObeliskUserStateDir)

23import Obelisk.CliApp

24−import Obelisk.Command.Utils (rmPath, whichPath, sshKeygenPath, nixBuildExePath, dockerPath)

24+import Obelisk.Command.Utils (rmPath)

25

26-- | Generate the `--builders` argument string to enable the VM builder after ensuring it is available.

27getNixBuildersArg :: MonadObelisk m => m String

@@ -35,7 +35,7 @@ getNixBuildersArg = do

35

36checkForNixDarwin :: MonadObelisk m => String -> m ()

37checkForNixDarwin sshIdFile = do

38− (exitCode, _, _) <- readCreateProcessWithExitCode $ proc whichPath ["darwin-rebuild"]

38+ (exitCode, _, _) <- readCreateProcessWithExitCode $ proc "which" ["darwin-rebuild"]

39 unless (exitCode == ExitSuccess) $ failWith $ T.intercalate "\n"

40 [ "Deployments from macOS require nix-darwin to be installed."

41 , "Follow the installation instructions here: https://github.com/LnL7/nix-darwin"

@@ -67,7 +67,7 @@ containerExists :: MonadObelisk m => FilePath -> m Bool

67containerExists stateDir = handle (\(_ :: IOError) -> failWith needDockerMsg) $ do

68 containerNames <- fmap (map T.strip . T.lines) $

69 readProcessAndLogStderr Error $

70− proc dockerPath ["container", "list", "--all", "--format", "{{.Names}}"]

70+ proc "docker" ["container", "list", "--all", "--format", "{{.Names}}"]

71 let exists = containerName `elem` containerNames

72 when exists $ testLinuxBuild stateDir

73 pure exists

@@ -85,7 +85,7 @@ containerSshPort = 2222

85startContainer :: MonadObelisk m => m ()

86startContainer = withSpinner "Starting VM builder" $

87 callProcessAndLogOutput (Debug, Debug) $

88− proc dockerPath ["start", containerName]

88+ proc "docker" ["start", containerName]

89

90-- | Creates the Docker container; assumes it does not exist.

91setupNixDocker :: MonadObelisk m => FilePath -> m ()

@@ -98,12 +98,12 @@ setupNixDocker stateDir = withSpinner ("Creating Docker container named " <> con

98 callProcessAndLogOutput (Debug, Error) $

99 proc rmPath ["-f", stateDir </> sshKeyFileName, stateDir </> sshKeyFileName <.> "pub"]

100 callProcessAndLogOutput (Debug, Error) $

101− proc sshKeygenPath ["-t", "ed25519", "-f", stateDir </> sshKeyFileName, "-P", ""]

101+ proc "ssh-keygen" ["-t", "ed25519", "-f", stateDir </> sshKeyFileName, "-P", ""]

102

103 -- Build the docker container (which uses the SSH keys in the 'ssh' folder)

104 containerId <- fmap T.strip $ readProcessAndLogStderr Error $

105− proc dockerPath ["build", stateDir, "--quiet"]

105+ proc "docker" ["build", stateDir, "--quiet"]

106− callProcessAndLogOutput (Debug, Error) $ proc dockerPath

106+ callProcessAndLogOutput (Debug, Error) $ proc "docker"

107 [ "run"

108 , "--restart", "always"

109 , "--detach"

@@ -155,7 +155,7 @@ testLinuxBuild :: MonadObelisk m => FilePath -> m ()

155testLinuxBuild stateDir

156 | System.Info.os == "linux" = failWith "Using the docker builder is not necessary on linux."

157 | otherwise = do

158− (exitCode, _stdout, stderr) <- readCreateProcessWithExitCode $ proc nixBuildExePath

158+ (exitCode, _stdout, stderr) <- readCreateProcessWithExitCode $ proc "nix-build"

159 [ "--no-out-link"

160 , "-E", "(import <nixpkgs> { system = \"x86_64-linux\"; }).writeText \"test\" builtins.currentTime"

161 , "--builders", nixBuildersArgString stateDir

lib/executable-config/default.nix+2−13

@@ -25,19 +25,8 @@ let

25in

26

27{

28− haskellOverlay = self: super:

28+ haskellOverlay = self: super: {

29− let

30− pkgs = self.callPackage ({pkgs}: pkgs) {};

31− in {

32− obelisk-executable-config-lookup = pkgs.haskell.lib.overrideCabal

33− (self.callCabal2nix "obelisk-executable-config-lookup" (obeliskCleanSource ./lookup) {})

29+ obelisk-executable-config-lookup = self.callCabal2nix "obelisk-executable-config-lookup" (obeliskCleanSource ./lookup) {};

34− (drv: {

35− # Hack until https://github.com/NixOS/cabal2nix/pull/432 lands

36− libraryHaskellDepends = (drv.libraryHaskellDepends or [])

37− ++ pkgs.stdenv.lib.optionals (with pkgs.stdenv.hostPlatform; isAndroid && is32bit) [

38− self.android-activity

39− ];

40− });

41 };

30 };

42

31

43 platforms = {

32 platforms = {

lib/executable-config/inject/obelisk-executable-config-inject.cabal+1−1

@@ -15,4 +15,4 @@ library

15 text

16

17 exposed-modules: Obelisk.ExecutableConfig.Inject

18− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O

18+ ghc-options: -Wall

lib/executable-config/lookup/obelisk-executable-config-lookup.cabal+7−10

@@ -31,18 +31,15 @@ library

31 base64-bytestring,

32 bytestring,

33 containers,

34− exceptions,

35 filepath,

34 filepath,

36− jsaddle,

37− mmorph,

38− monad-control,

39− mtl,

40− primitive,

41− ref-tf,

42− reflex-dom-core,

43− reflex,

44 text,

35 text,

36+ transformers,

45 transformers-base,

37 transformers-base,

46− transformers

38+ ref-tf,

39+ primitive,

40+ monad-control,

41+ reflex,

42+ reflex-dom,

43+ jsaddle

47

44

48 ghc-options: -Wall

45 ghc-options: -Wall

lib/executable-config/lookup/src/Obelisk/Configs.hs+12−31

@@ -18,38 +18,24 @@ module Obelisk.Configs

18 , getTextConfig

19 ) where

20

21−import Control.Applicative (Alternative)

21+import Control.Applicative

22−import Control.Monad (MonadPlus)

22+import Control.Monad

23−import Control.Monad.Base (MonadBase)

23+import Control.Monad.Base

24−import Control.Monad.Catch (MonadThrow)

25−import Control.Monad.Fail (MonadFail)

26−import Control.Monad.Fix (MonadFix)

24+import Control.Monad.Fix

27−import Control.Monad.IO.Class (MonadIO)

28−import Control.Monad.Morph (MFunctor)

29−import Control.Monad.Primitive (PrimMonad, PrimState, primitive)

25+import Control.Monad.Primitive

30−import Control.Monad.Ref (MonadRef)

26+import Control.Monad.Ref

27+import Control.Monad.IO.Class

31−import Control.Monad.Trans (MonadTrans, lift)

28+import Control.Monad.Trans.Class

32−import Control.Monad.Trans.Control (MonadBaseControl)

29+import Control.Monad.Trans.Control

33−import Control.Monad.Trans.Reader (ReaderT (..), ask, mapReaderT)

30+import Control.Monad.Trans.Reader

34−import Control.Monad.Trans.State (StateT)

35−import qualified Control.Monad.Trans.State.Strict as Strict

36import Data.ByteString (ByteString)

31import Data.ByteString (ByteString)

37import Data.Map (Map)

32import Data.Map (Map)

38import qualified Data.Map as Map

33import qualified Data.Map as Map

39import Data.Text (Text)

34import Data.Text (Text)

40import qualified Data.Text.Encoding as T

35import qualified Data.Text.Encoding as T

41import Reflex

36import Reflex

42−import Reflex.Host.Class (MonadReflexCreateTrigger)

37+import Reflex.Host.Class

43−import Reflex.Dom.Core

38+import Reflex.Dom

44− ( DomBuilder

45− , DomRenderHook

46− , HasDocument

47− , HasJS

48− , HasJSContext

49− , Prerender (Client)

50− , StaticDomBuilderT

51− , prerender

52− )

53#ifndef ghcjs_HOST_OS

39#ifndef ghcjs_HOST_OS

54import Language.Javascript.JSaddle (MonadJSM)

40import Language.Javascript.JSaddle (MonadJSM)

55#endif

41#endif

@@ -76,8 +62,6 @@ instance HasConfigs m => HasConfigs (PostBuildT t m)

76instance HasConfigs m => HasConfigs (QueryT t q m)

62instance HasConfigs m => HasConfigs (QueryT t q m)

77instance HasConfigs m => HasConfigs (ReaderT r m)

63instance HasConfigs m => HasConfigs (ReaderT r m)

78instance HasConfigs m => HasConfigs (RequesterT t request response m)

64instance HasConfigs m => HasConfigs (RequesterT t request response m)

79−instance HasConfigs m => HasConfigs (StateT w m)

80−instance HasConfigs m => HasConfigs (Strict.StateT w m)

81instance HasConfigs m => HasConfigs (StaticDomBuilderT t m)

65instance HasConfigs m => HasConfigs (StaticDomBuilderT t m)

82instance HasConfigs m => HasConfigs (TriggerEventT t m)

66instance HasConfigs m => HasConfigs (TriggerEventT t m)

83

67

@@ -88,15 +72,12 @@ newtype ConfigsT m a = ConfigsT { unConfigsT :: ReaderT (Map Text ByteString) m

88 , Monad

72 , Monad

89 , MonadPlus

73 , MonadPlus

90 , Alternative

74 , Alternative

91− , MonadFail

92 , MonadFix

75 , MonadFix

93− , MonadThrow

94 , MonadIO

76 , MonadIO

95 , MonadBase m'

77 , MonadBase m'

96 , MonadBaseControl m'

78 , MonadBaseControl m'

97 , MonadRef

79 , MonadRef

98 , MonadTrans

80 , MonadTrans

99− , MFunctor

100 , DomBuilder t

81 , DomBuilder t

101 , MonadHold t

82 , MonadHold t

102 , MonadReflexCreateTrigger t

83 , MonadReflexCreateTrigger t

lib/frontend/obelisk-frontend.cabal+1−1

@@ -26,4 +26,4 @@ library

26 exposed-modules:

27 Obelisk.Frontend

28 Obelisk.Frontend.Cookie

29− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O

29+ ghc-options: -Wall

lib/route/README.mddeleted−6

@@ -1,6 +0,0 @@

1−# obelisk-route

2−

3−[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)

4−[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)

5−

6−Robust URL management for single-page apps.

lib/route/obelisk-route.cabal+1−2

@@ -20,7 +20,6 @@ library

20 http-types,

21 jsaddle,

22 lens,

23− mmorph,

24 monad-control,

23 monad-control,

25 mtl,

24 mtl,

26 network-uri,

25 network-uri,

@@ -39,4 +38,4 @@ library

39 exposed-modules: Obelisk.Route

38 exposed-modules: Obelisk.Route

40 Obelisk.Route.TH

39 Obelisk.Route.TH

41 Obelisk.Route.Frontend

40 Obelisk.Route.Frontend

42− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O

41+ ghc-options: -Wall -fwarn-redundant-constraints

lib/route/src/Obelisk/Route.hs+22−36

@@ -1,4 +1,3 @@

1−{-# LANGUAGE CPP #-}

2{-# LANGUAGE ApplicativeDo #-}

1{-# LANGUAGE ApplicativeDo #-}

3{-# LANGUAGE ConstraintKinds #-}

2{-# LANGUAGE ConstraintKinds #-}

4{-# LANGUAGE EmptyCase #-}

3{-# LANGUAGE EmptyCase #-}

@@ -6,6 +5,7 @@

6{-# LANGUAGE FlexibleContexts #-}

5{-# LANGUAGE FlexibleContexts #-}

7{-# LANGUAGE FlexibleInstances #-}

6{-# LANGUAGE FlexibleInstances #-}

8{-# LANGUAGE GADTs #-}

7{-# LANGUAGE GADTs #-}

8+{-# LANGUAGE KindSignatures #-}

9{-# LANGUAGE LambdaCase #-}

10{-# LANGUAGE MultiParamTypeClasses #-}

11{-# LANGUAGE OverloadedStrings #-}

@@ -140,19 +140,16 @@ import Control.Lens

140 , Wrapped (..)

141 )

142import Control.Monad.Except

143+import Control.Monad.Writer (execWriter, tell)

143import qualified Control.Monad.State.Strict as State

144import qualified Control.Monad.State.Strict as State

144import Control.Monad.Trans (lift)

145import Control.Monad.Trans (lift)

145−import Control.Monad.Writer (execWriter, tell)

146−import Data.Aeson (FromJSON, ToJSON)

147−import qualified Data.Aeson as Aeson

148import qualified Data.ByteString as BS

146import qualified Data.ByteString as BS

149import qualified Data.ByteString.Lazy as BSL

147import qualified Data.ByteString.Lazy as BSL

148+import Data.Dependent.Sum (DSum (..))

150import Data.Dependent.Map (DMap)

149import Data.Dependent.Map (DMap)

151import qualified Data.Dependent.Map as DMap

150import qualified Data.Dependent.Map as DMap

152−import Data.Dependent.Sum (DSum (..))

153import Data.Either.Validation (Validation (..))

151import Data.Either.Validation (Validation (..))

154import Data.Foldable

152import Data.Foldable

155−import Data.Functor (($>))

156import Data.Functor.Sum

153import Data.Functor.Sum

157import Data.GADT.Compare

154import Data.GADT.Compare

158import Data.GADT.Compare.TH

155import Data.GADT.Compare.TH

@@ -165,18 +162,19 @@ import Data.Monoid ((<>))

165import Data.Set (Set)

162import Data.Set (Set)

166import qualified Data.Set as Set

163import qualified Data.Set as Set

167import Data.Some (Some(Some))

164import Data.Some (Some(Some))

168−import Data.Tabulation

169import Data.Text (Text)

165import Data.Text (Text)

166+import Data.Text.Lens (IsText, packed, unpacked)

170import qualified Data.Text as T

167import qualified Data.Text as T

171import qualified Data.Text.Encoding as T

168import qualified Data.Text.Encoding as T

172−import Data.Text.Lens (IsText, packed, unpacked)

173−import Data.Type.Equality

174import Data.Universe

169import Data.Universe

175import Data.Universe.Some

170import Data.Universe.Some

176import Network.HTTP.Types.URI

171import Network.HTTP.Types.URI

177import qualified Numeric.Lens

172import qualified Numeric.Lens

178import Obelisk.Route.TH

173import Obelisk.Route.TH

179import Text.Read (readMaybe)

174import Text.Read (readMaybe)

175+import Data.Tabulation

176+import qualified Data.Aeson as Aeson

177+import Data.Aeson (FromJSON, ToJSON)

180

178

181-- Design goals:

179-- Design goals:

182-- No start-up time on the frontend (not yet met)

180-- No start-up time on the frontend (not yet met)

@@ -226,19 +224,7 @@ hoistR f (x :=> Identity y) = f x :/ y

226infixr 5 :.

224infixr 5 :.

227type (:.) = (,)

225type (:.) = (,)

228

226

229−#ifdef __GLASGOW_HASKELL__

230−#if __GLASGOW_HASKELL__ >= 810

231{-# COMPLETE (:.) #-}

227{-# COMPLETE (:.) #-}

232−#else

233−{-# WARNING (:.)

234− [ "Use of this pattern in GHC < 8.10 will result in spurious non-exhaustive warnings at every use site."

235− , "We cannot provide a COMPLETE pragma to silence these due to a GHC bug: https://gitlab.haskell.org/ghc/ghc/issues/17729."

236− , "The bug hides incompleteness warnings for all two tuples when the COMPLETE pattern is in scope."

237− , "Instead, you should use (,) directly until you can switch to GHC >= 8.10, where the COMPLETE pragma is reinstated."

238− ]

239− #-}

240−#endif

241−#endif

242pattern (:.) :: a -> b -> a :. b

228pattern (:.) :: a -> b -> a :. b

243pattern a :. b = (a, b)

229pattern a :. b = (a, b)

244

230

@@ -304,13 +290,13 @@ decode e x = runIdentity (tryDecode e x)

304-- | Once an 'Encoder' has been checked, so that its check monad has become 'Identity', even if the same is not true of the

290-- | Once an 'Encoder' has been checked, so that its check monad has become 'Identity', even if the same is not true of the

305-- parse monad, we may still attempt to decode with it in its parse monad.

291-- parse monad, we may still attempt to decode with it in its parse monad.

306tryDecode :: Encoder Identity parse decoded encoded -> encoded -> parse decoded

292tryDecode :: Encoder Identity parse decoded encoded -> encoded -> parse decoded

307−tryDecode (Encoder (Identity impl)) = _encoderImpl_decode impl

293+tryDecode (Encoder (Identity impl)) x = _encoderImpl_decode impl x

308

294

309-- | Similar to 'decode', once an encoder has been checked so that its check monad is Identity, it

295-- | Similar to 'decode', once an encoder has been checked so that its check monad is Identity, it

310-- can be used to actually encode by using this. Note that while there's no constraint on the parse monad here,

296-- can be used to actually encode by using this. Note that while there's no constraint on the parse monad here,

311-- one should usually be applying decode and encode to the same 'Encoder'

297-- one should usually be applying decode and encode to the same 'Encoder'

312encode :: Encoder Identity parse decoded encoded -> decoded -> encoded

298encode :: Encoder Identity parse decoded encoded -> decoded -> encoded

313−encode (Encoder (Identity impl)) = _encoderImpl_encode impl

299+encode (Encoder (Identity impl)) x = _encoderImpl_encode impl x

314

300

315-- | This is a primitive used to build encoders which can't fail to check. It should not be used unless one is

301-- | This is a primitive used to build encoders which can't fail to check. It should not be used unless one is

316-- reasonably certain that the law given for 'EncoderImpl' above holds.

302-- reasonably certain that the law given for 'EncoderImpl' above holds.

@@ -555,11 +541,11 @@ pathComponentEncoder f = Encoder $ do

555 unEncoder (pathComponentEncoderImpl (enum1Encoder (extractPathSegment . f)) f')

541 unEncoder (pathComponentEncoderImpl (enum1Encoder (extractPathSegment . f)) f')

556

542

557pathComponentEncoderImpl :: forall check parse p. (Monad check, Monad parse)

543pathComponentEncoderImpl :: forall check parse p. (Monad check, Monad parse)

558− => Encoder check parse (Some p) (Maybe Text)

544+ => (Encoder check parse (Some p) (Maybe Text))

559 -> (forall a. p a -> Encoder Identity parse a PageName)

545 -> (forall a. p a -> Encoder Identity parse a PageName)

560 -> Encoder check parse (R p) PageName

546 -> Encoder check parse (R p) PageName

561−pathComponentEncoderImpl =

547+pathComponentEncoderImpl this rest =

562− chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder)

548+ chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder) this rest

563

549

564--NOTE: Naming convention in this module is to always talk about things in the *encoding* direction, never in the *decoding* direction

550--NOTE: Naming convention in this module is to always talk about things in the *encoding* direction, never in the *decoding* direction

565

551

@@ -815,7 +801,7 @@ rPrism

815 :: forall f f'

801 :: forall f f'

816 . (forall a. Prism' (f a) (f' a))

802 . (forall a. Prism' (f a) (f' a))

817 -> Prism' (R f) (R f')

803 -> Prism' (R f) (R f')

818−rPrism = dSumPrism

804+rPrism p = dSumPrism p

819

805

820dSumPrism'

806dSumPrism'

821 :: forall f g a

807 :: forall f g a

@@ -827,7 +813,7 @@ dSumGEqPrism

827 :: GEq f

813 :: GEq f

828 => f a

814 => f a

829 -> Prism' (DSum f g) (g a)

815 -> Prism' (DSum f g) (g a)

830−dSumGEqPrism variant = dSumPrism' $ prism' (\Refl -> variant) (geq variant)

816+dSumGEqPrism variant = dSumPrism' $ prism' (\Refl -> variant) (\x -> geq variant x)

831

817

832-- | Given a 'tag :: f a', make a prism for 'R f'. This generalizes the usual

818-- | Given a 'tag :: f a', make a prism for 'R f'. This generalizes the usual

833-- prisms for a sum type (the ones that 'mkPrisms' would make), just as 'R'

819-- prisms for a sum type (the ones that 'mkPrisms' would make), just as 'R'

@@ -994,9 +980,9 @@ obeliskRouteSegment r appRouteSegment = case r of

994-- be combined with other such segment encoders before 'pathComponentEncoder' turns it into a proper 'Encoder'.

980-- be combined with other such segment encoders before 'pathComponentEncoder' turns it into a proper 'Encoder'.

995resourceRouteSegment :: (MonadError Text check, MonadError Text parse) => ResourceRoute a -> SegmentResult check parse a

981resourceRouteSegment :: (MonadError Text check, MonadError Text parse) => ResourceRoute a -> SegmentResult check parse a

996resourceRouteSegment = \case

982resourceRouteSegment = \case

997− ResourceRoute_Static -> PathSegment "static" pathOnlyEncoderIgnoringQuery

983+ ResourceRoute_Static -> PathSegment "static" $ pathOnlyEncoderIgnoringQuery

998− ResourceRoute_Ghcjs -> PathSegment "ghcjs" pathOnlyEncoder

984+ ResourceRoute_Ghcjs -> PathSegment "ghcjs" $ pathOnlyEncoder

999− ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" jsaddleWarpRouteEncoder

985+ ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" $ jsaddleWarpRouteEncoder

1000 ResourceRoute_Version -> PathSegment "version" $ unitEncoder mempty

986 ResourceRoute_Version -> PathSegment "version" $ unitEncoder mempty

1001

987

1002data JSaddleWarpRoute :: * -> * where

988data JSaddleWarpRoute :: * -> * where

@@ -1008,7 +994,7 @@ jsaddleWarpRouteEncoder :: (MonadError Text check, MonadError Text parse) => Enc

1008jsaddleWarpRouteEncoder = pathComponentEncoder $ \case

994jsaddleWarpRouteEncoder = pathComponentEncoder $ \case

1009 JSaddleWarpRoute_JavaScript -> PathSegment "jsaddle.js" $ unitEncoder mempty

995 JSaddleWarpRoute_JavaScript -> PathSegment "jsaddle.js" $ unitEncoder mempty

1010 JSaddleWarpRoute_WebSocket -> PathEnd $ unitEncoder mempty

996 JSaddleWarpRoute_WebSocket -> PathEnd $ unitEncoder mempty

1011− JSaddleWarpRoute_Sync -> PathSegment "sync" pathOnlyEncoder

997+ JSaddleWarpRoute_Sync -> PathSegment "sync" $ pathOnlyEncoder

1012

998

1013instance GShow appRoute => GShow (ObeliskRoute appRoute) where

999instance GShow appRoute => GShow (ObeliskRoute appRoute) where

1014 gshowsPrec prec = \case

1000 gshowsPrec prec = \case

@@ -1039,8 +1025,8 @@ someSumEncoder = Encoder $ pure $ EncoderImpl

1039

1025

1040data Void1 :: * -> * where {}

1026data Void1 :: * -> * where {}

1041

1027

1042−instance UniverseSome Void1 where

1028+instance Universe (Some Void1) where

1043− universeSome = []

1029+ universe = []

1044

1030

1045void1Encoder :: (Applicative check, MonadError Text parse) => Encoder check parse (Some Void1) a

1031void1Encoder :: (Applicative check, MonadError Text parse) => Encoder check parse (Some Void1) a

1046void1Encoder = Encoder $ pure $ EncoderImpl

1032void1Encoder = Encoder $ pure $ EncoderImpl

@@ -1084,7 +1070,7 @@ readShowEncoder :: (MonadError Text parse, Read a, Show a, Applicative check) =>

1084readShowEncoder = singlePathSegmentEncoder . unsafeTshowEncoder

1070readShowEncoder = singlePathSegmentEncoder . unsafeTshowEncoder

1085

1071

1086integralEncoder :: (MonadError Text parse, Applicative check, Integral a) => Encoder check parse a Integer

1072integralEncoder :: (MonadError Text parse, Applicative check, Integral a) => Encoder check parse a Integer

1087−integralEncoder = reviewEncoder Numeric.Lens.integral

1073+integralEncoder = reviewEncoder (Numeric.Lens.integral)

1088

1074

1089pathSegmentEncoder :: (MonadError Text parse, Applicative check, Cons as as a a) =>

1075pathSegmentEncoder :: (MonadError Text parse, Applicative check, Cons as as a a) =>

1090 Encoder check parse (a, (as, b)) (as, b)

1076 Encoder check parse (a, (as, b)) (as, b)

@@ -1159,7 +1145,7 @@ pathFieldEncoder fieldEncoder = unsafeEncoder $ do

1159 fieldEncoderPure f = toEncoder (DMap.findWithDefault (error "bad") f fieldEncoderPureMap)

1145 fieldEncoderPure f = toEncoder (DMap.findWithDefault (error "bad") f fieldEncoderPureMap)

1160 pure $ EncoderImpl

1146 pure $ EncoderImpl

1161 { _encoderImpl_encode = \(x, rest) -> execWriter $ do

1147 { _encoderImpl_encode = \(x, rest) -> execWriter $ do

1162− _ <- traverseWithField (\f x_i -> tell (pure $ encode (fieldEncoderPure f) x_i) $> x_i) x

1148+ _ <- traverseWithField (\f x_i -> tell (pure $ encode (fieldEncoderPure f) x_i) *> pure x_i) x

1163 tell rest

1149 tell rest

1164 , _encoderImpl_decode = State.runStateT $ tabulateFieldsA $ \f -> State.get >>= \case

1150 , _encoderImpl_decode = State.runStateT $ tabulateFieldsA $ \f -> State.get >>= \case

1165 [] -> throwError $ T.pack "not enough path components"

1151 [] -> throwError $ T.pack "not enough path components"

lib/route/src/Obelisk/Route/Frontend.hs+28−41

@@ -1,24 +1,24 @@

1−{-# LANGUAGE CPP #-}

2{-# LANGUAGE ApplicativeDo #-}

1{-# LANGUAGE ApplicativeDo #-}

2+{-# LANGUAGE CPP #-}

3+{-# LANGUAGE RecursiveDo #-}

4+{-# LANGUAGE StandaloneDeriving #-}

3{-# LANGUAGE ConstraintKinds #-}

5{-# LANGUAGE ConstraintKinds #-}

4−{-# LANGUAGE DataKinds #-}

5{-# LANGUAGE DefaultSignatures #-}

6{-# LANGUAGE DefaultSignatures #-}

6{-# LANGUAGE FlexibleContexts #-}

7{-# LANGUAGE FlexibleContexts #-}

7{-# LANGUAGE FlexibleInstances #-}

8{-# LANGUAGE FlexibleInstances #-}

8−{-# LANGUAGE FunctionalDependencies #-}

9{-# LANGUAGE GADTs #-}

10−{-# LANGUAGE GeneralizedNewtypeDeriving #-}

11{-# LANGUAGE LambdaCase #-}

10{-# LANGUAGE LambdaCase #-}

12{-# LANGUAGE OverloadedStrings #-}

11{-# LANGUAGE OverloadedStrings #-}

13{-# LANGUAGE PatternSynonyms #-}

12{-# LANGUAGE PatternSynonyms #-}

14{-# LANGUAGE RankNTypes #-}

13{-# LANGUAGE RankNTypes #-}

15−{-# LANGUAGE RecursiveDo #-}

16{-# LANGUAGE ScopedTypeVariables #-}

14{-# LANGUAGE ScopedTypeVariables #-}

17−{-# LANGUAGE StandaloneDeriving #-}

18{-# LANGUAGE TypeFamilies #-}

15{-# LANGUAGE TypeFamilies #-}

19{-# LANGUAGE TypeOperators #-}

16{-# LANGUAGE TypeOperators #-}

20−{-# LANGUAGE UndecidableInstances #-}

21{-# LANGUAGE ViewPatterns #-}

17{-# LANGUAGE ViewPatterns #-}

18+{-# LANGUAGE GeneralizedNewtypeDeriving #-}

19+{-# LANGUAGE UndecidableInstances #-}

20+{-# LANGUAGE DataKinds #-}

21+{-# LANGUAGE FunctionalDependencies #-}

22

23module Obelisk.Route.Frontend

24 ( module Obelisk.Route

@@ -57,42 +57,49 @@ module Obelisk.Route.Frontend

57

58import Prelude hiding ((.), id)

59

60+import Obelisk.Route

61+

60import Control.Category (Category (..), (.))

62import Control.Category (Category (..), (.))

61import Control.Category.Cartesian ((&&&))

63import Control.Category.Cartesian ((&&&))

62import Control.Lens hiding (Bifunctor, bimap, universe, element)

64import Control.Lens hiding (Bifunctor, bimap, universe, element)

63import Control.Monad ((<=<))

65import Control.Monad ((<=<))

64import Control.Monad.Fix

66import Control.Monad.Fix

65−import Control.Monad.Morph

66import Control.Monad.Primitive

67import Control.Monad.Primitive

67import Control.Monad.Reader

68import Control.Monad.Reader

68import Control.Monad.Ref

69import Control.Monad.Ref

69import Control.Monad.Trans.Control

70import Control.Monad.Trans.Control

70import Data.Coerce

71import Data.Coerce

71import Data.Dependent.Sum (DSum (..))

72import Data.Dependent.Sum (DSum (..))

72−import Data.Functor.Compose

73−import Data.Functor.Misc

74import Data.GADT.Compare

73import Data.GADT.Compare

75−import qualified Data.List as L

76import Data.Map (Map)

74import Data.Map (Map)

77−import Data.Maybe (fromMaybe)

78import Data.Monoid

75import Data.Monoid

79import Data.Proxy

76import Data.Proxy

80import Data.Text (Text)

77import Data.Text (Text)

81import qualified Data.Text as T

78import qualified Data.Text as T

79+import Data.Functor.Compose

80+import Data.Functor.Misc

81+import Reflex.Class

82+import Reflex.Host.Class

83+import Reflex.PostBuild.Class

84+import Reflex.TriggerEvent.Class

85+import Reflex.PerformEvent.Class

86+import Reflex.EventWriter.Class

87+import Reflex.EventWriter.Base

88+import Reflex.Dynamic

89+import Reflex.Dom.Builder.Class

82import Data.Type.Coercion

90import Data.Type.Coercion

91+import Language.Javascript.JSaddle --TODO: Get rid of this - other platforms can also be routed

92+import Reflex.Dom.Core

83import qualified GHCJS.DOM as DOM

93import qualified GHCJS.DOM as DOM

84import qualified GHCJS.DOM.Types as DOM

94import qualified GHCJS.DOM.Types as DOM

85import qualified GHCJS.DOM.Window as Window

95import qualified GHCJS.DOM.Window as Window

86−import Language.Javascript.JSaddle (MonadJSM, jsNull, liftJSM) --TODO: Get rid of this - other platforms can also be routed

87import Network.URI

96import Network.URI

88−import Reflex.Class

97+import Data.Maybe (fromMaybe)

89−import Reflex.Dom.Builder.Class

98+import qualified Data.List as L

90−import Reflex.Dom.Core

99+

91−import Reflex.Host.Class

92import Unsafe.Coerce

100import Unsafe.Coerce

93

101

94import Obelisk.Configs

102import Obelisk.Configs

95−import Obelisk.Route

96

103

97infixr 5 :~

104infixr 5 :~

98pattern (:~) :: Reflex t => f a -> Dynamic t a -> DSum f (Compose (Dynamic t) Identity)

105pattern (:~) :: Reflex t => f a -> Dynamic t a -> DSum f (Compose (Dynamic t) Identity)

@@ -109,23 +116,7 @@ instance Monad m => Routed t r (RoutedT t r m) where

109instance (Monad m, Routed t r m) => Routed t r (ReaderT r' m)

116instance (Monad m, Routed t r m) => Routed t r (ReaderT r' m)

110

117

111newtype RoutedT t r m a = RoutedT { unRoutedT :: ReaderT (Dynamic t r) m a }

118newtype RoutedT t r m a = RoutedT { unRoutedT :: ReaderT (Dynamic t r) m a }

112− deriving

119+ deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument, DomRenderHook t)

113− ( Functor

114− , Applicative

115− , Monad

116− , MonadFix

117− , MonadTrans

118− , MFunctor

119− , NotReady t

120− , MonadHold t

121− , MonadSample t

122− , PostBuild t

123− , TriggerEvent t

124− , MonadIO

125− , MonadReflexCreateTrigger t

126− , HasDocument

127− , DomRenderHook t

128− )

129

120

130instance MonadReader r' m => MonadReader r' (RoutedT t r m) where

121instance MonadReader r' m => MonadReader r' (RoutedT t r m) where

131 ask = lift ask

122 ask = lift ask

@@ -201,10 +192,6 @@ instance (Monad m, RouteToUrl r m) => RouteToUrl r (EventWriterT t w m)

201

192

202instance (Monad m, SetRoute t r m) => SetRoute t r (EventWriterT t w m)

193instance (Monad m, SetRoute t r m) => SetRoute t r (EventWriterT t w m)

203

194

204−instance (Monad m, RouteToUrl r m) => RouteToUrl r (DynamicWriterT t w m)

205−

206−instance (Monad m, SetRoute t r m) => SetRoute t r (DynamicWriterT t w m)

207−

208runRoutedT :: RoutedT t r m a -> Dynamic t r -> m a

195runRoutedT :: RoutedT t r m a -> Dynamic t r -> m a

209runRoutedT = runReaderT . unRoutedT

196runRoutedT = runReaderT . unRoutedT

210

197

@@ -269,7 +256,7 @@ dynamicIdentityCoercion = unsafeCoerce (Coercion :: Coercion (Identity ()) ()) -

269factorRouted :: (Reflex t, MonadFix m, MonadHold t m, GEq f) => RoutedT t (DSum f (Dynamic t)) m a -> RoutedT t (DSum f Identity) m a

256factorRouted :: (Reflex t, MonadFix m, MonadHold t m, GEq f) => RoutedT t (DSum f (Dynamic t)) m a -> RoutedT t (DSum f Identity) m a

270factorRouted r = RoutedT $ ReaderT $ \d -> do

257factorRouted r = RoutedT $ ReaderT $ \d -> do

271 d' <- factorDyn d

258 d' <- factorDyn d

272− runRoutedT r $ coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d'

259+ runRoutedT r $ (coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d')

273

260

274maybeRouted :: (Reflex t, MonadFix m, MonadHold t m) => RoutedT t (Maybe (Dynamic t a)) m b -> RoutedT t (Maybe a) m b

261maybeRouted :: (Reflex t, MonadFix m, MonadHold t m) => RoutedT t (Maybe (Dynamic t a)) m b -> RoutedT t (Maybe a) m b

275maybeRouted r = RoutedT $ ReaderT $ \d -> do

262maybeRouted r = RoutedT $ ReaderT $ \d -> do

@@ -477,7 +464,7 @@ runRouteViewT

477 , MonadJSM (Performable m)

464 , MonadJSM (Performable m)

478 , MonadFix m

465 , MonadFix m

479 )

466 )

480− => Encoder Identity Identity r PageName

467+ => (Encoder Identity Identity r PageName)

481 --TODO: Get rid of the switchover and useHash arguments

468 --TODO: Get rid of the switchover and useHash arguments

482 -- useHash can probably be baked into the encoder

469 -- useHash can probably be baked into the encoder

483 -> Event t () -- ^ Switchover event, nothing is done until this event fires. Used to prevent incorrect DOM expectations at hydration switchover time

470 -> Event t () -- ^ Switchover event, nothing is done until this event fires. Used to prevent incorrect DOM expectations at hydration switchover time

lib/run/obelisk-run.cabal+2−2

@@ -33,7 +33,7 @@ library

33 , process

34 , ref-tf

35 , reflex

36− , reflex-dom-core

36+ , reflex-dom

37 , snap-core

38 , streaming-commons

39 , text

@@ -47,7 +47,7 @@ library

47 , websockets

48 exposed-modules:

49 Obelisk.Run

50− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O

50+ ghc-options: -Wall -fwarn-redundant-constraints

51 if os(linux)

52 cpp-options: -DIPROUTE_SUPPORTED

53 build-depends: which

lib/run/src/Obelisk/Run.hs+3−3

@@ -144,9 +144,9 @@ runWidget conf configs frontend validFullEncoder = do

144

145 cert <- X509.newX509 >>= X509Request.makeX509FromReq certRequest

146 _ <- X509.setPublicKey cert privateKey

147− timenow <- getCurrentTime

147+ now <- getCurrentTime

148− _ <- X509.setNotBefore cert $ addUTCTime (-1) timenow

148+ _ <- X509.setNotBefore cert $ addUTCTime (-1) now

149− _ <- X509.setNotAfter cert $ addUTCTime (365 * 24 * 60 * 60) timenow

149+ _ <- X509.setNotAfter cert $ addUTCTime (365 * 24 * 60 * 60) now

150 _ <- X509.signX509 cert privateKey Nothing

151

152 certByteString <- BSUTF8.fromString <$> PEM.writeX509 cert

lib/selftest/src/Obelisk/SelfTest.hs+1−23

@@ -19,7 +19,6 @@ import Data.Bool (bool)

19import qualified Data.ByteString.Lazy as LBS

20import Data.Foldable (for_)

21import Data.Function (fix)

22−import Data.List (isInfixOf)

23import qualified Data.Map as Map

22import qualified Data.Map as Map

24import Data.Semigroup ((<>))

23import Data.Semigroup ((<>))

25import qualified Data.Set as Set

24import qualified Data.Set as Set

@@ -206,22 +205,6 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->

206 it "works in root directory" $ inTmpObInit $ \_ -> testObRunInDir' Nothing httpManager

205 it "works in root directory" $ inTmpObInit $ \_ -> testObRunInDir' Nothing httpManager

207 it "works in sub directory" $ inTmpObInit $ \_ -> testObRunInDir' (Just "frontend") httpManager

206 it "works in sub directory" $ inTmpObInit $ \_ -> testObRunInDir' (Just "frontend") httpManager

208

207

209− describe "ob repl" $ do

210− it "accepts stdin commands" $ inTmpObInit $ \_ -> do

211− setStdin "print 3\n:q"

212− output <- runOb ["repl"]

213− liftIO $ assertBool "" $

214− [ "*Obelisk.Run Obelisk.Run Frontend Backend> 3"

215− , "*Obelisk.Run Obelisk.Run Frontend Backend> Leaving GHCi."

216− ] `isInfixOf` T.lines (T.strip output)

217− it "works with custom Prelude" $ inTmpObInit $ \_ -> do

218− writefile "common/src/Prelude.hs"

219− "{-# LANGUAGE PackageImports #-} module Prelude (module X) where import \"base\" Prelude as X"

220− setStdin ":q"

221− output <- runOb ["repl"]

222− liftIO $ assertBool "" $

223− "*Obelisk.Run Obelisk.Run Frontend Backend> Leaving GHCi." `T.isInfixOf` output

224−

225 describe "obelisk project" $ parallel $ do

208 describe "obelisk project" $ parallel $ do

226 it "can build obelisk command" $ inTmpObInit $ \_ -> nixBuild ["-A", "command" , toTextIgnore obeliskRepoReadOnly]

209 it "can build obelisk command" $ inTmpObInit $ \_ -> nixBuild ["-A", "command" , toTextIgnore obeliskRepoReadOnly]

227 it "can build obelisk skeleton" $ inTmpObInit $ \_ -> nixBuild ["-A", "skeleton", toTextIgnore obeliskRepoReadOnly]

210 it "can build obelisk skeleton" $ inTmpObInit $ \_ -> nixBuild ["-A", "skeleton", toTextIgnore obeliskRepoReadOnly]

@@ -260,7 +243,7 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->

260 uu <- update

243 uu <- update

261 assertRevEQ u uu

244 assertRevEQ u uu

262

245

263− it "can run 'ob doc'" $ inTmpObInit $ \_ -> runOb_ ["doc", "reflex"]

246+ it "can run 'ob doc'" $ inTmpObInit $ \_ -> runOb ["doc", "reflex"]

264

247

265 describe "ob thunk pack/unpack" $ parallel $ do

248 describe "ob thunk pack/unpack" $ parallel $ do

266 it "has thunk pack and unpack inverses" $ inTmpObInitWithImplCopy $ \_ -> do

249 it "has thunk pack and unpack inverses" $ inTmpObInitWithImplCopy $ \_ -> do

@@ -323,11 +306,6 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->

323 void $ errExit False $ runOb ["thunk", "update", toTextIgnore dir, "--branch", "dumble-palooza"]

306 void $ errExit False $ runOb ["thunk", "update", toTextIgnore dir, "--branch", "dumble-palooza"]

324 checkDir dir >>= liftIO . assertEqual "" startingContents

307 checkDir dir >>= liftIO . assertEqual "" startingContents

325

308

326− describe "ob shell" $ parallel $ do

327− it "works with --" $ inTmpObInit $ \_ -> do

328− output <- runOb ["shell", "--", "ghc-pkg", "list"]

329− liftIO $ assertBool "Unexpected output from ob shell" $ ("Cabal-" `T.isInfixOf` output) && ("ghc-" `T.isInfixOf` output)

330−

331 describe "ob hoogle" $ {- NOT parallel -} do

309 describe "ob hoogle" $ {- NOT parallel -} do

332 it "starts a hoogle server on the given port" $ inTmpObInit $ \_ -> do

310 it "starts a hoogle server on the given port" $ inTmpObInit $ \_ -> do

333 [p0] <- liftIO $ getFreePorts 1

311 [p0] <- liftIO $ getFreePorts 1

lib/snap-extras/obelisk-snap-extras.cabal+2−1

@@ -12,9 +12,10 @@ library

12 , base

13 , bytestring

14 , snap-core

15+ , unix

15 , directory

16 , directory

16 , filepath

17 , filepath

17 , text

18 , text

18 exposed-modules:

19 exposed-modules:

19 Obelisk.Snap.Extras

20 Obelisk.Snap.Extras

20− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O

21+ ghc-options: -Wall

lib/snap-extras/src/Obelisk/Snap/Extras.hs+1−1

@@ -17,7 +17,7 @@ import System.Directory

17-- | Set response header for "permanent" caching

18cachePermanently :: MonadSnap m => m ()

19cachePermanently = do

20− modifyResponse $ setHeader "Cache-Control" "public, max-age=315360000, immutable"

20+ modifyResponse $ setHeader "Cache-Control" "public, max-age=315360000"

21 modifyResponse $ setHeader "Expires" "Tue, 01 Feb 2050 00:00:00 GMT" --TODO: This should be set to "approximately one year from the time the response is sent"

22

23-- | Set response header to not cache

scripts/ghcid-this-libnew file+4

@@ -0,0 +1,4 @@

1+#!/usr/bin/env bash

2+set -euo pipefail

3+

4+nix-shell -E "with (import ../.. {}); reflex-platform.workOn haskellPackageSets.ghc haskellPackageSets.ghc.obelisk-$(basename $PWD)" --run "ghcid -c 'cabal new-repl'"

skeleton/.gitignore+6−12

@@ -1,15 +1,9 @@

1+dist-newstyle

2+result

3+result-*

4+result-android

5+result-ios

6+result-exe

1.attr-cache

7.attr-cache

2−.cabal-sandbox

3−*.hi

4−*.o

5−cabal.project.local

6−cabal.sandbox.config

7−ctags

8−dist-newstyle/

9−dist/

10ghcid-output.txt

8ghcid-output.txt

11profile/

9profile/

12−result

13−result-*

14−tags

15−TAGS

skeleton/backend/backend.cabal+1−2

@@ -14,12 +14,11 @@ library

14 , obelisk-route

15 exposed-modules:

16 Backend

17− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits

17+ ghc-options: -Wall

18

19executable backend

20 main-is: main.hs

21 hs-source-dirs: src-bin

22− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -threaded -fno-show-valid-hole-fits

23 if impl(ghcjs)

22 if impl(ghcjs)

24 buildable: False

23 buildable: False

25 build-depends: base

24 build-depends: base

skeleton/cabal.project−1

@@ -1,3 +1,2 @@

1optional-packages:

2 *

3−write-ghc-environment-files: never

skeleton/common/common.cabal−1

@@ -12,4 +12,3 @@ library

12 exposed-modules:

13 Common.Api

14 Common.Route

15− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits

skeleton/default.nix+3−10

@@ -1,17 +1,10 @@

1−{ system ? builtins.currentSystem

2−, obelisk ? import ./.obelisk/impl {

1+{ obelisk ? import ./.obelisk/impl {

3− inherit system;

2+ system = builtins.currentSystem;

4− iosSdkVersion = "13.2";

3+ iosSdkVersion = "10.2";

5−

6 # You must accept the Android Software Development Kit License Agreement at

4 # You must accept the Android Software Development Kit License Agreement at

7 # https://developer.android.com/studio/terms in order to build Android apps.

5 # https://developer.android.com/studio/terms in order to build Android apps.

8 # Uncomment and set this to `true` to indicate your acceptance:

6 # Uncomment and set this to `true` to indicate your acceptance:

9 # config.android_sdk.accept_license = false;

7 # config.android_sdk.accept_license = false;

10−

11− # In order to use Let's Encrypt for HTTPS deployments you must accept

12− # their terms of service at https://letsencrypt.org/repository/.

13− # Uncomment and set this to `true` to indicate your acceptance:

14− # terms.security.acme.acceptTerms = false;

15 }

8 }

16}:

9}:

17with obelisk;

10with obelisk;

skeleton/frontend/frontend.cabal+4−6

@@ -16,7 +16,7 @@ library

16 , text

17 exposed-modules:

18 Frontend

19− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits

19+ ghc-options: -Wall

20

21executable frontend

22 main-is: main.hs

@@ -28,9 +28,7 @@ executable frontend

28 , reflex-dom

29 , obelisk-generated-static

30 , frontend

31− ghc-options: -threaded -O -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -fno-show-valid-hole-fits

31+ --TODO: Make these ghc-options optional

32− if impl(ghcjs)

32+ ghc-options: -threaded

33− ghc-options: -dedupe

34− cpp-options: -DGHCJS_BROWSER

35 if os(darwin)

33 if os(darwin)

36− ghc-options: -dynamic

34+ ghc-options: -dynamic

skeleton/shell.nixnew file+1

@@ -0,0 +1 @@

1+(import ./. {}).shells.ghc