on master help sign in
129 files changed+7154−2455
since splitsnapshots
unifiedsplit
.github/pull_request_template.md+10 .gitignore+2−3 .hlint.yaml+65 CONTRIBUTING.md+125−3 ChangeLog.md+156 FAQ.md+117 LICENSE+30 README.md+125−84 acme.nix+430 all-builds.nix+113 all-tests.nix+145 default.nix+245−204 dep/.gitignore−4 dep/ghcid/default.nix+7 dep/ghcid/github.json+7 dep/gitignore.nix/default.nix+8 dep/gitignore.nix/github.json+8 dep/hnix/default.nix+7 dep/hnix/github.json+7 dep/reflex-platform/default.nix+1−6 dep/reflex-platform/github.json+4−3 dep/reflex-platform/thunk.nix+9 dep/snap-core/default.nix+8 dep/snap-core/github.json+8 docs/obelisk-logo-640.png guides/app-deploy/README.md+324 guides/app-deploy/assets/android-app.jpg guides/app-deploy/assets/android-confirm-usb-debugging.jpg guides/app-deploy/assets/app-deploy-2.png guides/app-deploy/assets/app-deploy.png guides/app-deploy/assets/ios-deploy-example.png guides/app-deploy/assets/ios-deploy-keychain.png guides/app-deploy/assets/ios-obelisk-app-icon.jpg guides/app-deploy/assets/ios-obelisk-app-open.jpg guides/app-deploy/assets/nano-edit-nixos-configuration.png guides/app-deploy/assets/virtualbox-appliance-import-loading.png guides/app-deploy/assets/virtualbox-appliance-import.png guides/app-deploy/assets/virtualbox-dashboard-nixos.png guides/app-deploy/assets/virtualbox-image-settings-network.png guides/app-deploy/assets/virtualbox-nioxs-after-boot.png guides/app-deploy/assets/xcode-devices.png haskell-overlays/ghcide.nix+40 haskell-overlays/misc-deps.nix+26 haskell-overlays/obelisk.nix+48 haskell-overlays/tighten-ob-exes.nix+32 jobsets.nix−66 lib/asset/README.md+17−20 lib/asset/assets.nix+28−5 lib/asset/manifest/obelisk-asset-manifest.cabal+5−2 lib/asset/manifest/src-bin/generate.hs−1 lib/asset/manifest/src/Obelisk/Asset/Gather.hs+5−2 lib/asset/manifest/src/Obelisk/Asset/Promoted.hs+1−9 lib/asset/manifest/src/Obelisk/Asset/Symlink.hs+1−1 lib/asset/serve-snap/obelisk-asset-serve-snap.cabal+4−2 lib/asset/serve-snap/src/Obelisk/Asset/Accept.hs+6−6 lib/asset/serve-snap/src/Obelisk/Asset/Serve/Snap.hs+22−11 lib/backend/obelisk-backend.cabal+5−2 lib/backend/src/Obelisk/Backend.hs+181−58 lib/cliapp/obelisk-cliapp.cabal+7−3 lib/cliapp/src/Obelisk/CliApp.hs+18−6 lib/cliapp/src/Obelisk/CliApp/Demo.hs−52 lib/cliapp/src/Obelisk/CliApp/Logging.hs+37−12 lib/cliapp/src/Obelisk/CliApp/Process.hs+143−55 lib/cliapp/src/Obelisk/CliApp/Spinner.hs+18−24 lib/cliapp/src/Obelisk/CliApp/Theme.hs+29 lib/cliapp/src/Obelisk/CliApp/Types.hs+10−3 lib/command/obelisk-command.cabal+20−14 lib/command/src/Obelisk/App.hs+5−2 lib/command/src/Obelisk/Command.hs+225−147 lib/command/src/Obelisk/Command/Deploy.hs+235−89 lib/command/src/Obelisk/Command/Nix.hs+160−39 lib/command/src/Obelisk/Command/Preprocessor.hs+100 lib/command/src/Obelisk/Command/Project.hs+203−64 lib/command/src/Obelisk/Command/Run.hs+504−140 lib/command/src/Obelisk/Command/Thunk.hs+639−355 lib/command/src/Obelisk/Command/Upgrade/Hash.hs−114 lib/command/src/Obelisk/Command/Utils.hs+105−24 lib/command/src/Obelisk/Command/VmBuilder.hs+11−10 lib/executable-config/default.nix+38−16 lib/executable-config/inject/obelisk-executable-config-inject.cabal+3−3 lib/executable-config/inject/src/Obelisk/ExecutableConfig/Inject.hs+14−40 lib/executable-config/lookup/default.nix−24 lib/executable-config/lookup/obelisk-executable-config-lookup.cabal+48 lib/executable-config/lookup/obelisk-executable-config.cabal−30 lib/executable-config/lookup/src-android/Obelisk/ExecutableConfig.hs−27 lib/executable-config/lookup/src-android/Obelisk/ExecutableConfig/Lookup.hs+60 lib/executable-config/lookup/src-ghcjs/Obelisk/ExecutableConfig.hs−17 lib/executable-config/lookup/src-ghcjs/Obelisk/ExecutableConfig/Lookup.hs+51 lib/executable-config/lookup/src-ios/Obelisk/ExecutableConfig.hs−22 lib/executable-config/lookup/src-ios/Obelisk/ExecutableConfig/Lookup.hs+17 lib/executable-config/lookup/src-other/Obelisk/ExecutableConfig/Lookup.hs+11 lib/executable-config/lookup/src/Obelisk/Configs.hs+148 lib/executable-config/lookup/src/Obelisk/Configs/Internal/Directory.hs+24 lib/executable-config/lookup/src/Obelisk/ExecutableConfig.hs−13 lib/frontend/obelisk-frontend.cabal+9−2 lib/frontend/src/Obelisk/Frontend.hs+182−96 lib/frontend/src/Obelisk/Frontend/Cookie.hs+103 lib/route/README.md+6 lib/route/obelisk-route.cabal+9−3 lib/route/src/Obelisk/Route.hs+471−70 lib/route/src/Obelisk/Route/Frontend.hs+267−72 lib/route/src/Obelisk/Route/TH.hs+4−5 lib/run/obelisk-run.cabal+12−4 lib/run/src/Obelisk/Run.hs+120−53 lib/selftest/obelisk-selftest.cabal+7−3 lib/selftest/src/Obelisk/SelfTest.hs+499−180 lib/snap-extras/obelisk-snap-extras.cabal+2−3 lib/snap-extras/src/Obelisk/Snap/Extras.hs+2−2 lib/tabulation/CHANGELOG.md+5 lib/tabulation/LICENSE+30 lib/tabulation/Setup.hs+2 lib/tabulation/src/Data/Tabulation.hs+21 lib/tabulation/tabulation.cabal+26 nixpkgs-overlays/default.nix+15 release.nix+8−78 scripts/ghcid-this-lib−4 skeleton/.gitignore+13−5 skeleton/backend/backend.cabal+2−1 skeleton/backend/src/Backend.hs+1−6 skeleton/cabal.project+1 skeleton/common/common.cabal+1−1 skeleton/common/src/Common/Api.hs+1−1 skeleton/common/src/Common/Route.hs+13−18 skeleton/config/common/example+1 skeleton/default.nix+16−3 skeleton/frontend/frontend.cabal+8−4 skeleton/frontend/src-bin/main.hs+1−1 skeleton/frontend/src/Frontend.hs+28−3 skeleton/static/main.css+3
.github/pull_request_template.mdnew file+10
@@ -0,0 +1,10 @@
1+<!-- Provide a clear overview of your changes. -->
2+
3+I 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)
8+ - [ ] 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)
.gitignore+2−3
@@ -2,14 +2,13 @@
22**/.cabal-sandbox
33**/cabal.sandbox.config
44result
5+result-*
56*.o
67*.hi
7−
88TAGS
99tags
1010ctags
1111dist-newstyle
1212cabal.project.local
1313.ghc.environment.*
14−
15−**/ghcid-output.txt
14+**/ghcid-output.txt
.hlint.yamlnew file+65
@@ -0,0 +1,65 @@
1+# HLint configuration file
2+# https://github.com/ndmitchell/hlint
3+##########################
4+
5+# This file contains a template configuration file, which is typically
6+# placed as .hlint.yaml in the root of your project
7+
8+
9+# Specify additional command line arguments
10+#
11+# - arguments: [--color, --cpp-simple, -XQuasiQuotes]
12+
13+
14+# Control which extensions/flags/modules/functions can be used
15+#
16+# - extensions:
17+# - default: false # all extension are banned by default
18+# - name: [PatternGuards, ViewPatterns] # only these listed extensions can be used
19+# - {name: CPP, within: CrossPlatform} # CPP can only be used in a given module
20+#
21+# - flags:
22+# - {name: -w, within: []} # -w is allowed nowhere
23+#
24+# - modules:
25+# - {name: [Data.Set, Data.HashSet], as: Set} # if you import Data.Set qualified, it must be as 'Set'
26+# - {name: Control.Arrow, within: []} # Certain modules are banned entirely
27+#
28+# - functions:
29+# - {name: unsafePerformIO, within: []} # unsafePerformIO can only appear in no modules
30+
31+
32+# Add custom hints for this project
33+#
34+# Will suggest replacing "wibbleMany [myvar]" with "wibbleOne myvar"
35+# - error: {lhs: "wibbleMany [x]", rhs: wibbleOne x}
36+
37+
38+# Turn on hints that are off by default
39+#
40+# Ban "module X(module X) where", to require a real export list
41+# - warn: {name: Use explicit module export list}
42+#
43+# Replace a $ b $ c with a . b $ c
44+# - group: {name: dollar, enabled: true}
45+#
46+# Generalise map to fmap, ++ to <>
47+# - group: {name: generalise, enabled: true}
48+
49+
50+# Ignore some builtin hints
51+- ignore: {name: Redundant do}
52+- ignore: {name: Redundant flip}
53+- ignore: {name: Use <$>}
54+- ignore: {name: Use camelCase}
55+- ignore: {name: Use if}
56+- ignore: {name: Use unless}
57+# - ignore: {name: Use const, within: SpecialModule} # Only within certain modules
58+
59+
60+# Define some custom infix operators
61+# - fixity: infixr 3 ~^#^~
62+
63+
64+# To generate a suitable file for HLint do:
65+# $ hlint --default > .hlint.yaml
CONTRIBUTING.md+125−3
@@ -1,9 +1,131 @@
1−## Contributing to Obelisk
1+# Contribution Guide
22
3−Thanks for taking the time to contribute!
3+Contributions and issue reports are encouraged and appreciated!
44
5−Before submitting a pull request, please run the tests:
5+- [Opening Issues](#opening-issues)
6+- [Submitting Changes](#submitting-changes)
7+ - [Guidelines for Commit Messages](#guidelines-for-commit-messages)
8+ - [Guidelines for Pull Requests](#guidelines-for-pull-requests)
9+ - [Code Quality](#code-quality)
10+ - [Documentation](#documentation)
11+- [Development Environment](#development-environment)
612
13+## Opening Issues
14+
15+Before opening an issue, please check whether your issue has already been reported. Assuming it has not:
16+
17+* Describe the issue you're encountering or the suggestion you're making
18+* Include any relevant steps to reproduce or code samples you can. It's always easier for us to debug if we have something that demonstrates the error.
19+* Let us know what version of this project you were using. If you're using a github checkout, provide the git hash.
20+
21+## Submitting Changes
22+
23+Most pull requests should target the `develop` branch. `master` is the release branch. `develop` is periodically merged into master after a period of testing.
24+
25+### Guidelines for Commit Messages
26+
27+#### Summary Line
28+The summary line of your commit message should summarize the changes being made. Commit messages should be written in the imperative mood and should describe what happens when the commit is applied. If your commit modifies one of the in-tree haskell packages (found in `./lib`), please prefix your commit summary with the name of the package being modified.
29+
30+One way to think about it is that your commit message should be able to complete the sentence:
31+"When applied, this commit will..."
32+
33+##### Note on bumping dependencies
34+Commits that update a dependency should include some information about why the dependency was updated in the commit message.
35+
36+#### Body
37+For breaking changes, new features, refactors, or other major changes, the body of the commit message should describe the motivation behind the change in greater detail and may include references to the issue tracker. The body shouldn't repeat code/comments from the diff.
38+
39+### Guidelines for Pull Requests
40+
41+Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.
42+
43+
44+### Code Quality
45+
46+#### Warnings
47+
48+Your pull request should add no new warnings to the project. It should also generally not disable any warnings.
49+
50+#### Build and Test
51+
52+Make sure the project builds and that the tests pass! This will generally also be checked by CI before merge, but trying it yourself first means you'll catch problems earlier and your contribution can be merged that much sooner!
53+
54+You can run the tests like this:
755```bash
856$(nix-build -A selftest --no-out-link)
957```
58+
59+To test that your changes build across platforms, you can also try to build release.nix, like this:
60+```bash
61+nix-build release.nix
62+```
63+
64+Note, however, that to build release.nix you must accept the android license agreement and your machine must be configured to build both ios and android executables (usually via remote builders).
65+
66+
67+### Documentation
68+
69+#### In the code
70+We're always striving to improve documentation. Please include [haddock](https://haskell-haddock.readthedocs.io/en/latest/index.html) documentation for any added code, and update the documentation for any code you modify.
71+
72+#### In the [Changelog](ChangeLog.md)
73+Add an entry to the changelog when your PR:
74+* Adds a feature
75+* Deprecates something
76+* Includes a breaking change
77+* Makes any other change that will impact users
78+
79+#### In the [Readme](README.md)
80+The readme is the first place a lot of people look for information about the repository. Update any parts of the readme that are affected by your PR.
81+
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.mdnew file+156
@@ -0,0 +1,156 @@
1+# Revision history for obelisk
2+
3+This 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
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`.
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+
35+## v0.8.0.0
36+
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.
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.
39+
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.
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.
42+* ([#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.
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`.
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`.
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.
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.
48+* ([#714](https://github.com/obsidiansystems/obelisk/pull/714)) Miscellaneous improvements to CLI help and logging.
49+
50+## v0.7.0.1
51+
52+* Fix the version number for `ob` the command-line tool. ([#679](https://github.com/obsidiansystems/obelisk/pull/679))
53+
54+## v0.7.0.0
55+
56+* Fully support HTTP [Range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range) requests on static assets to support Safari. ([#664](https://github.com/obsidiansystems/obelisk/pull/664))
57+* Support non-EC2 deployments. ([#658](https://github.com/obsidiansystems/obelisk/pull/658))
58+* Fix `ob deploy test android` to work. ([#645](https://github.com/obsidiansystems/obelisk/pull/645))
59+* Fix vulnerability where Android deployments would leave signing keys in the nix store which is world readable. ([#645](https://github.com/obsidiansystems/obelisk/pull/645)) (Thanks to [kmicklas](https://github.com/kmicklas) for the report.)
60+* Add `Obelisk.Backend.runBackendWith` to allow several customizations. ([#668](https://github.com/obsidiansystems/obelisk/pull/668), [#644](https://github.com/obsidiansystems/obelisk/pull/644))
61+* Add `ob profile` command to run Obelisk projects with profiling. `ob profile` works like `ob run`, but instead of using `ghci`, it builds an executable that is built with profiling enabled. ([#654](https://github.com/obsidiansystems/obelisk/pull/654))
62+* Obelisk's `default.nix` now exposes `mkAssets` function which is used to construct the assets served by an Obelisk application. ([#651](https://github.com/obsidiansystems/obelisk/pull/651))
63+* Bump reflex-platform to v0.5.2.0. ([#671](https://github.com/obsidiansystems/obelisk/pull/671))
64+
65+## v0.6.0.0 - 2020-02-21
66+
67+* Fix a bug in `Obelisk.Route.Frontend` where `routeLink`, `routeLinkDynAttr`, and `dynRouteLink` would not behave exactly like `<a href="...">` when run by JavaScript. These functions now scroll to the top of the page when the link is clicked. ([#540](https://github.com/obsidiansystems/obelisk/pull/540))
68+* Fix a bug in `ob run`/`ob watch`/`ob repl` where nested Obelisk projects would also be loaded into the session. These are now ignored. ([#652](https://github.com/obsidiansystems/obelisk/pull/652))
69+* Improve behavior of `ob run`/`ob watch`/`ob repl` when multiple packages with the same name are encountered. Obelisk now issues a warning and tells you which one it will use. ([#653](https://github.com/obsidiansystems/obelisk/pull/653))
70+* Removed `Obelisk.Backend.mkRouteToUrl` since it is easily written in terms of `Obelisk.Route.renderObeliskRoute`:
71+
72+ mkRouteToUrl validFullEncoder (k :/ v) = renderObeliskRoute validFullEncoder (FullRoute_Frontend (ObeliskRoute_App k) :/ v)
73+
74+* Add `Obelisk.Backend.renderAllJsPath` to expose URL path to `ghcjs/all.js`. ([#545](https://github.com/obsidiansystems/obelisk/pull/545))
75+* Add argument to `serveDefaultObeliskApp`, `serveObeliskApp`, and `serveGhcjsApp` to take the path to `all.js` instead of hard-coding it. ([#545](https://github.com/obsidiansystems/obelisk/pull/545))
76+
77+## v0.5.0.0 - 2020-02-07
78+
79+* Add `Obelisk.Route.(?/)`, a convenience function for constructing routes nested in `Maybe`. ([#457](https://github.com/obsidiansystems/obelisk/pull/457))
80+* Add local unpacked packages to the `ob run`, `ob watch`, and `ob repl` sessions. Any `.cabal` or hpack package inside the current obelisk project will be loaded into the session. For `ob run`/`ob watch` this means the session will automatically reload when you save a source file in any of those packages. For `ob repl` it means that `:r` will reload changes to any of those packages. There are some edge cases where this integration is still rough. Report any issues you encounter. ([#489](https://github.com/obsidiansystems/obelisk/pull/489))
81+* Add `ob hoogle` command to start a local [Hoogle](https://hoogle.haskell.org/) server for the project. ([#628](https://github.com/obsidiansystems/obelisk/pull/628))
82+* `ob thunk pack` will now attempt to automatically detect if the thunk is a private or public repo. To avoid this detection, specify `--private` or `--public` manually. ([#607](https://github.com/obsidiansystems/obelisk/pull/607))
83+* Fix a bug in the plain git thunk loader for thunks marked as 'private' when the revision is not in the default branch. ([#648](https://github.com/obsidiansystems/obelisk/pull/648))
84+* Improve handling of runtime nix dependencies. This may fix some issues encountered particularly by users on systems other than NixOS.
85+
86+## v0.4.0.0 - 2020-01-10
87+
88+* Bump reflex-platform which, notably, bumps nixpkgs to 19.09. ([#585](https://github.com/obsidiansystems/obelisk/pull/585))
89+* Add new thunk loader for Git repositories that supports `file://` Git remotes and supports private repositories via `builtins.fetchGit` for private repositories (when the `git.json` file specifies `"private": true`). ([#594](https://github.com/obsidiansystems/obelisk/pull/594))
90+* Add a new thunk loader for GitHub repositories that uses `builtins.fetchTarball` for public repositories to increase loader performance and uses `fetchFromGitHub` for private repositories (when the `github.json` file specifies `"private": true`). Note that `fetchFromGitHub` requires some Nix configuration for the Nix builder to access the repository. If `ob thunk pack` fails in this case, use `-v` to see Nix's helpful message. ([#594](https://github.com/obsidiansystems/obelisk/pull/594))
91+* Add `--public`/`--private` options to `ob thunk pack` to specify if a repository should be treated as a public or private. ([#594](https://github.com/obsidiansystems/obelisk/pull/594))
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))
93+* 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))
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))
96+
97+## v0.3.0.0 - 2019-12-20
98+
99+* Change the structure of Obelisk routes to use a designated
100+ `FullRoute` type. This combines frontend and backend routes into one
101+ structure. This is a **breaking** change which requires Obelisk apps
102+ to take specific migrations. They are:
103+ * Rewrite the implementation of `_backend_routeEncoder` in
104+ `Backend` to use `mkFullRouteEncoder` instead of
105+ `handleEncoder`. Specifically, the backend and frontend cases of
106+ the top-level `pathComponentEncoder` become the second and third
107+ arguments of `mkFullRouteEncoder` respectively, while the
108+ missing route becomes the first argument. An example of how to
109+ do this is available in [a reflex-examples
110+ commit](https://github.com/reflex-frp/reflex-examples/commits/28f566c3e7dc615578dc74297b7c620c1f13683e).
111+ * Replace type constructions of `InL` with `FullRoute_Backend` and
112+ `InR` with `FullRoute_Frontend`.
113+* Generalised `pathSegmentEncoder`, added `pathFieldEncoder`.
114+* Added some `Prism`s to the encoder library for manipulating `DSum`s.
115+* Add `ob doc` command, which lists paths to haddock documentation for specified packages.
116+* Bump reflex-platform so that obelisk now uses GHC 8.6.5 and the nixos-19.03 nixpkgs set.
117+* Add support in `obelisk-route` for single parameters in URL paths.
118+* Bump reflex-platform so that obelisk now uses reflex-dom 0.5.2.0.
119+* Use a `--pure` nix shell in `ob run` for parity with `ob repl` and more resilience against "works on my machine".
120+* Pin usages of `<nixpkgs>` in obelisk thunks, etc. to the nixpkgs used by the project's obelisk impl.
121+* Backport ACMEv2 support in obelisk server to regain LetsEncrypt account creation.
122+* Enable HTTPS in `ob run`.
123+* `ob run` now handles `ghci` errors better, and includes a custom `ghcid`
124+ version. As a result, you no longer need to have ghcid installed to
125+ use `ob run`, as we provide one for you.
126+* `ob` commands now complain less on systems with umasks other than `0022`.
127+* Ignore package environment files in `ob run` and `ob repl`.
128+* Add `Obelisk.Route.Frontend.routeLinkDynAttr`.
129+
130+## v0.2.0.0 - 2019-8-17
131+
132+* Configs become ByteStrings.
133+* FrontendConfigsT has been changed into ConfigsT and configs are made available via getConfig/getConfigs
134+ * The frontend will still only have access to configs that are placed in config/frontend and config/common, while the backend has access to the entire contents of the config directory via `Obelisk.ExecutableConfig.Lookup.getConfigs`.
135+* The backend no longer runs in BackendConfigsT.
136+* Add tabulation package. See Data.Tabulation for details.
137+* Add encoders for `DMap`, `HasFields` (cf. Data.Tabulation), and JSON.
138+* Use IP address for nginx proxy pass instead of localhost
139+
140+## v0.1.1.0 - 2019-05-17
141+
142+* Fix crashes of Android apps on 32-bit ARM devices.
143+* Provide a way to indicate acceptance of the Android SDK license by passing `config.android_sdk.accept_license = true;` in the arguments to the import of `.obelisk/impl` in the project's `default.nix`.
144+* Add `COMPLETE` pragma to `(:/)`. Using this pattern synonym should no longer generate spurious warnings about non-exhaustive pattern matching.
145+* Make asset path hashing strict (see `Obelisk.Asset.Gather`)
146+* Add the `ob shell` command to enter a nix shell for an obelisk project
147+* Allow skeleton's obelisk to be overridden. This changes the skeleton's default.nix interface: the arguments that it used to take are now part of the new "obelisk" argument.
148+* Removed `MonadIO` from `ObeliskWidget` to prevent accidental IO during prerendering. If you need to do IO in a widget it should be on the right hand side of a `prerender`.
149+* Significantly changed the interface to the "executable config" packages. `obelisk-executable-config-lookup` is a new internal package which looks up all configs in a platform-specific way. `obelisk-executable-frontend` and `obelisk-executable-backend` provide MTL-style monad classes (`HasFrontendConfigs` and `HasBackendConfigs`) which the frontend and backend, respectively, can use to look up configs. This replaces the old `get` function which ran in `IO`.
150+* Add a flag to force thunk packing even if there are unpushed changes in the unpacked thunk.
151+
152+
153+## v0.1.0.0 - 2019-03-29
154+
155+* Use reflex-dom's `HydrationDomBuilder` to "hydrate" statically rendered DOM served by the Obelisk backend (rather than re-creating DOM and replacing it all).
156+* Add `HasCookies` and `CookiesT` to allow `ObeliskWidget`s to access cookies during static and "hydrated" DOM rendering.
FAQ.mdnew file+117
@@ -0,0 +1,117 @@
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)
8+1. [`ob thunk update` or `ob deploy update` fails](#ob-thunk-update-or-ob-deploy-update-fails)
9+1. [How do I fix `Ambiguous module name` errors?](#how-do-i-fix-ambiguous-module-name-errors)
10+
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+
65+### How do I fix invalid entitlements?
66+
67+You probably did not set `ios.bundleIdentifier` correctly in `default.nix`. When this happens you'll see an error something like this:
68+
69+```
70+2018-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)
71+```
72+
73+Fixing the value of `ios.bundleIdentifier` should fix the error.
74+
75+### `ob thunk update` or `ob deploy update` fails
76+Whenever an `ob` command fails, try re-running it with `-v`.
77+
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:
79+
80+```
81+Starting Obelisk </nix/store/j8wls8a89xr6s1a47lg6g83gnbdrfd0l-obelisk-command-0.1/bin/.ob-wrapped> args=["deploy","update","-v"] logging-level=Debug
82+Creating process: 'nix-build' './.obelisk/impl' '-A' 'command' '--no-out-link'
83+✔ Built on ./.obelisk/impl [command]
84+Handing off to /nix/store/j8wls8a89xr6s1a47lg6g83gnbdrfd0l-obelisk-command-0.1/bin/ob
85+Starting Obelisk </nix/store/j8wls8a89xr6s1a47lg6g83gnbdrfd0l-obelisk-command-0.1/bin/.ob-wrapped> args=["--no-handoff","deploy","update","-v"] logging-level=Debug
86+Creating process: 'git' 'ls-remote' '--exit-code' '--symref' 'https://github.com/obsidiansystems/some-private-repo.git' 'refs/heads/master'
87+git ls-remote maps: (fromList [],fromList [(GitRef_Branch "master","8546dfc8be9653f20bb26214e0991dbb957cb290")])
88+Latest commit in branch master from remote repo https://github.com/obsidiansystems/some-private-repo.git is 8546dfc8be9653f20bb26214e0991dbb957cb290
89+Creating process: 'nix-prefetch-url' '--unpack' '--type' 'sha256' 'https://github.com/obsidiansystems/some-private-repo/archive/8546dfc8be9653f20bb26214e0991dbb957cb290.tar.gz'
90+error: unable to download 'https://github.com/obsidiansystems/some-private-repo/archive/8546dfc8be9653f20bb26214e0991dbb957cb290.tar.gz': HTTP error 404
91+Process exited with code 1; 'nix-prefetch-url' '--unpack' '--type' 'sha256' 'https://github.com/obsidiansystems/some-private-repo/archive/8546dfc8be9653f20bb26214e0991dbb957cb290.tar.gz'
92+nix-prefetch-url: Failed to determine sha256 hash of URL https://github.com/obsidiansystems/some-private-repo/archive/8546dfc8be9653f20bb26214e0991dbb957cb290.tar.gz
93+✖ Updating thunk ./src to latest
94+```
95+
96+And here's how you can fix it:
97+
98+```bash
99+ob thunk unpack $SOME_THUNK
100+ob thunk pack $SOME_THUNK
101+```
102+Substitute the directory of your thunk for `$SOME_THUNK`. In the case of `ob deploy update`, `$SOME_THUNK` will be `src` in the deployment directory.
103+
104+(Based on issue #351).
105+
106+### How do I fix `Ambiguous module name` errors?
107+Since obelisk places the common/backend/frontend modules packages into the same ghci, and ghci doesn't "sandbox" them, it is possible to have conflicting module errors inside `ob repl/watch/run` that do not appear when doing a cabal build.
108+
109+You can disambiguate this via [PackageImports](https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/glasgow_exts.html#package-qualified-imports). For instance, if you see
110+```
111+error:
112+ Ambiguous module name ‘Crypto.Hash’:
113+ it was found in multiple packages:
114+ cryptohash-0.11.9 cryptonite-0.25
115+```
116+then specify the package you want in the import, e.g:
117+`import "cryptonite" Crypto.Hash`
LICENSEnew file+30
@@ -0,0 +1,30 @@
1+Copyright (c) 2020 Obsidian Systems
2+
3+All rights reserved.
4+
5+Redistribution and use in source and binary forms, with or without
6+modification, are permitted provided that the following conditions are met:
7+
8+ * Redistributions of source code must retain the above copyright
9+ notice, this list of conditions and the following disclaimer.
10+
11+ * Redistributions in binary form must reproduce the above
12+ copyright notice, this list of conditions and the following
13+ disclaimer in the documentation and/or other materials provided
14+ with the distribution.
15+
16+ * Neither the name of Elliot Cameron nor the names of other
17+ contributors may be used to endorse or promote products derived
18+ from this software without specific prior written permission.
19+
20+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
README.md+125−84
@@ -1,60 +1,75 @@
11# Obelisk
22
3−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.
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)
45
6+<p align="center"><img src="docs/obelisk-logo-640.png" width="50%" alt="Obelisk Logo"></p>
7+
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.
9+
10+- [Overview](#overview)
11+ - [Who should consider using it?](#who-should-consider-using-it)
512- [Installing Obelisk](#installing-obelisk)
613- [Developing an Obelisk project](#developing-an-obelisk-project)
14+ - [IDE Support](#ide-support)
715- [Deploying](#deploying)
16+ - [Default EC2 Deployment](#default-ec2-deployment)
17+ - [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)
18+ - [VirtualBox Deployment](#virtualbox-deployment)
819 - [Locally](#locally)
9− - [EC2](#ec2)
1020 - [From macOS](#from-macos)
1121 - [Deploying an updated version](#deploying-an-updated-version)
1222- [Mobile](#mobile)
1323 - [iOS](#ios)
1424 - [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+
1538
1639## Installing Obelisk
40+
17411. [Install Nix](https://nixos.org/nix/).
1842 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
19431. Set up nix caches
2044 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
21− ```
22− nix.binaryCaches = [ "https://cache.nixos.org/" "https://nixcache.reflex-frp.org" ];
45+ ```nix
46+ nix.binaryCaches = [ "https://nixcache.reflex-frp.org" ];
2347 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
2448 ```
25− 1. If you are using another operating system or linux distribution, ensure that these lines are present in `/etc/nix/nix.conf`:
49+ 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)):
51+ ```nix
52+ 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=
54+ binary-caches-parallel-connections = 40
2655 ```
27− substituters = https://cache.nixos.org https://nixcache.reflex-frp.org
28− trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
29− ```
30− * other Linux: enable sandboxing (see https://github.com/obsidiansystems/obelisk/issues/6)
31− ```
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:
57+ ```nix
3258 sandbox = true
3359 ```
34− * MacOS: disable sandboxing (there are still some impure dependencies for now)
35− ```
60+ * If you're on MacOS, disable sandboxing (there are still some impure dependencies for now) by adding the following:
61+ ```nix
3662 sandbox = false
3763 ```
3864 then restart the nix daemon
39− ```
65+ ```bash
4066 sudo launchctl stop org.nixos.nix-daemon
4167 sudo launchctl start org.nixos.nix-daemon
4268 ```
43−1. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
44−
45−### Contributing to Obelisk
46−
47−When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
48−
49−```
50−nix-shell -A obelisk.obelisk-backend.env --run "cd lib/backend && ghcid -c 'cabal new-repl'"
51−```
52−
53−Or to launch ghcid for `lib/command` project:
54−
55−```
56−nix-shell -A obelisk.obelisk-command.env --run "cd lib/command && ghcid -c 'cabal new-repl'"
57−```
69+1. Install obelisk:
70+ ```bash
71+ nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command
72+ ```
5873
5974### Accessing private repositories
6075
@@ -69,54 +84,44 @@ access to:
6984
7085To create a new Obelisk project, go to an empty directory and run:
7186
72−```
87+```bash
7388ob init
7489```
7590
7691Obelisk leverages ghcid to provide a live-reloading server that handles both frontend and backend. To run your Obelisk app and monitor the source for changes:
7792
78−```
93+```bash
7994ob run
8095```
8196
82−Now go to http://localhost:8000 (or the port specified in `config/common/route`) to access your app.
97+Now, with an appropriate browser, go to http://localhost:8000 (or the address/port specified in `config/common/route`) to access your app.
98+Firefox will not be able to properly run the development website due to [issue 460](https://github.com/obsidiansystems/obelisk/issues/460). Fortunately, this problem does not occur on a fully built website.
8399
84100Every 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.
85101
86−## Deploying
87−
88−### Locally
102+### IDE Support
89103
90−Build everything:
104+Obelisk officially supports terminal-based feedback (akin to [`ghcid`](https://github.com/ndmitchell/ghcid)) in `ob run` and `ob watch`.
91105
92−```
93−nix-build -A exe -o result-exe
94−```
95−
96−Run the server:
97−
98−```
99−cd result-exe
100−./backend
101−```
106+## Deploying
102107
103−### EC2
108+### Default EC2 Deployment
104109
105−In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
110+In 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)).
106111
107112First create a new EC2 instance:
108113
109−1. Launch a NixOS 17.09 EC2 instance (we recommend [this AMI](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#LaunchInstanceWizard:ami=ami-40bee63a))
114+1. 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))
1101151. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1111161. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
112−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.
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.
113118
114119At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
115120
116121Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
117122Your 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.
118123
119−```
124+```bash
120125cd ~/code/myapp
121126SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
122127ROUTE=https://myapp.com # Publicly accessible route to your app
@@ -129,11 +134,13 @@ ob deploy init \
129134 ~/code/myapp-deploy
130135```
131136
132−NOTE: HTTPS is enabled by default; to disable https, pass `--disable-https` to the `ob deploy init` command above.
137+HTTPS is enabled by default; to disable HTTPS pass `--disable-https` to the `ob deploy init` command above.
133138
134−Then go to that created deployment configuration directory, and initiate the deployment:
139+This step will also require that you manually verify the authenticity of the host `$SERVER`. Obelisk will save the fingerprint in a deployment-specific configuration. **Obelisk deployments do *not* rely on the `known_hosts` of your local machine.** This is because, in the event that you need to switch from one deploy machine / bastion host to another, you want to be absolutely sure that you're still connecting to the machines you think you are, even if that deploy machine / bastion host has never connected to them before. Obelisk explicitly avoids a workflow that encourages people to accept host keys without checking them, since that could result in leaking production secrets to anyone who manages to MITM you, e.g. via DNS spoofing or cache poisoning. (Note that an active attack is a circumstance where you may need to quickly switch bastion hosts, e.g. because the attacker has taken one down or you have taken it down in case it was compromised. In this circumstance you might need to deploy to production to fix an exploit or rotate keys, etc.) When you run `ob deploy` later it will rely on the saved verification in this step.
135140
136−```
141+Next, go to the deployment directory that you just initialized and deploy!
142+
143+```bash
137144cd ~/code/myapp-deploy
138145ob deploy push
139146```
@@ -142,6 +149,45 @@ ob deploy push
142149
143150At this point you are done. Your app will be accessible at `${ROUTE}`. The currently deployed version - the git commit hash of the source repo - can be found at `${ROUTE}/version`.
144151
152+### Custom Non-EC2 Deployment
153+
154+By default Obelisk deployments are configured for NixOS machines running on AWS EC2. To provide your own configuration, you need to write a custom `module.nix` in the deployment repository. This still requires that your server is running NixOS.
155+
156+`module.nix` must contain a Nix *function* that produces a [NixOS module function](https://nixos.org/nixos/manual/index.html#sec-writing-modules). The top-level function takes deployment configuration as arguments: `hostName`, `adminEmail`, `routeHost`, `enableHttps`, `version`, `exe`, `nixosPkgs`. Most of these are the values you specified during `ob deploy init` and are stored in the deployment repository. `version` is a `git` hash for the app that you're deploying. `exe` is the Linux build of the app (as seen in [Deploying Locally](#locally)). `nixosPkgs` is the package set used to construct the NixOS VM.
157+
158+The [VirtualBox Deployment](#virtualbox-deployment) section provides an example.
159+
160+#### VirtualBox Deployment
161+
162+Here's a `module.nix` that is configured for deployment to a VirtualBox VM (running NixOS):
163+
164+```nix
165+{ nixosPkgs, ... }: {...}: {
166+ imports = [ (nixosPkgs.path + /nixos/modules/virtualisation/virtualbox-image.nix) ];
167+}
168+```
169+
170+The `{...}:` and following is the [NixOS module](https://nixos.org/nixos/manual/index.html#sec-writing-modules) definition.
171+
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+
145191### From macOS
146192
147193Deploying from macOS requires some extra setup:
@@ -155,7 +201,7 @@ Running `ob deploy push` will give you additional setup instructions.
155201
156202If you'd like to deploy an updated version (with new commits) of your Obelisk app: simply go to the configuration directory, update the source thunk and push:
157203
158−```
204+```bash
159205cd ~/code/myapp-deploy
160206ob deploy update
161207ob deploy push
@@ -175,20 +221,20 @@ Your account must also belong to an Apple Developer Team, if you want to access
1752211. Click accept to authorize on both the computer and the iPhone.
176222
177223##### Xcode
178−Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
224+Install Xcode 11.2 (contains iOS SDK 13.2) and open it so that it runs its post install tool setup.
179225
180226These 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`
181227
182228More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
183229To add another SDK to your current Xcode, [download](https://developer.apple.com/download/more/) the corresponding Xcode, extract it and copy its SDK folder next to the installed one, e.g.
184−```
230+```bash
185231open -W Xcode_9.2.xip
186232sudo cp -R Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS11.2.sdk
187233```
188234
189235
190236You can verify that you have correct versions by running
191−```
237+```bash
192238xcodebuild -showsdks
193239```
194240
@@ -214,7 +260,7 @@ Ensure that `bundleIdentifier` matches the App ID of the development profile, or
2142601. Connect the registered iPhone.
2152611. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
2162621. Run the deploy command with your Team ID:
217−```
263+```bash
218264result-ios/bin/deploy [TEAM_ID]
219265# or in debug mode via lldb:
220266result-ios/bin/deploy [TEAM_ID] -d
@@ -224,7 +270,7 @@ result-ios/bin/deploy [TEAM_ID] -d
2242701. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
225271Create and download a distribution profile.
2262721. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
227−```
273+```bash
228274result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
229275```
230276
@@ -237,7 +283,10 @@ It's also possible to inspect iOS WkWebView apps once they are installed in the
237283
238284### Android
239285
286+NOTE: Currently Android builds are only supported on Linux.
287+
2402881. In your project's `default.nix` set a suitable value for `android.applicationId` and `android.displayName`.
289+1. In your project's `default.nix` pass `config.android_sdk.accept_license = true;` in the arguments to the import of of `.obelisk/impl` to indicate your acceptance of the [Android Software Development Kit License Agreement](https://developer.android.com/studio/terms), which is required to build Android apps.
2412901. Run `nix-build -A android.frontend -o result-android` to build the Android app.
2422911. A debug version of the app should be generated at `result-android/android-app-debug.apk`
243292
@@ -247,39 +296,31 @@ Now deploy the built apk file to your Android device:
2472961. Connect the device using USB (be sure to confirm any security prompts on the device)
2482971. Run the deploy script: `result-android/bin/deploy`
249298
250−This should copy over and install the application on your device (if you see a "*signatures do not match*" error, simply uninstall the previous app from the device before retrying the deploy). The name of the installed application will be what you have specified for `android.displayName` in the `default.nix`.
299+Alternatively, you can deploy from an obelisk deployment directory (a directory generated post `ob deploy init ...` command) using the `ob deploy test android` command.
300+This command will accomplish the following:
251301
252−#### Releasing to Play Store
302+1. Create a key store and apk signing key (`android_keystore.jks`)
303+1. Build a Signed Android apk for your application
304+1. Deploy the Signed apk to your connected Android device
253305
254−##### Configure signing
306+In the event that you change your key or keystore password, you will have to update your credentials within the JSON object found in `android_keytool_config.json`.
255307
256−The previous section would have generated a debug version of the app. In order to build a release version you will need to sign your app. Obelisk can automatically sign the app during build if you provide it with your keystore file in `default.nix`.
308+Additional documentation on Java key stores can be found [here](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html).
257309
258−First, if you do not already have a keystore, create it as follows (for more information, see the [Android documentation](https://developer.android.com/studio/publish/app-signing#signing-manually)):
310+This should copy over and install the application on your device (if you see a "*signatures do not match*" error, simply uninstall the previous app from the device before retrying the deploy). The name of the installed application will be what you have specified for `android.displayName` in the `default.nix`.
259311
260−```
261−nix-shell -p androidenv.platformTools --run "keytool -genkey -v -keystore myandroidkey.jks -keyalg RSA -keysize 2048 -validity 10000 -alias myandroidalias"
262−```
312+#### Releasing to Play Store
263313
264−(Be sure to give an appropriate keystore filename and key alias string above.)
314+##### Build a release version
265315
266−The `keytool` command will ask you for some details, including a keystore password and a key password (we will use these passwords further below). It will now have created a `myandroidkey.jks` file under the current directory. Move that to somewhere safe, and note down its full path.
316+After 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.
267317
268−Now edit your project's `default.nix` and tell Obelisk of your app's keystore file. Your `default.nix` should look like this after the edit:
269318
270−```nix
271− ...
272− android.applicationId = "com.example.myapp";
273− android.displayName = "My App";
274− android.releaseKey =
275− { storeFile = /path/to/myandroidkey.jks;
276− storePassword = "abcd1234";
277− keyAlias = "myandroidalias";
278− keyPassword = "abcd1234";
279− };
280− ...
281−```
319+## Frequently Asked Questions (FAQ)
282320
283−##### Build a release version
321+Refer to [FAQ](FAQ.md).
284322
285−After 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.
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.nixnew file+430
@@ -0,0 +1,430 @@
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.&lt;name&gt;.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.nixnew file+113
@@ -0,0 +1,113 @@
1+{ self-args ? {
2+ config.android_sdk.accept_license = true;
3+ iosSdkVersion = "13.2";
4+ }
5+, local-self ? import ./. self-args
6+, supportedSystems ? [ builtins.currentSystem ]
7+}:
8+
9+let
10+ inherit (local-self.nixpkgs) lib runCommand nix;
11+ cacheBuildSystems = supportedSystems;
12+
13+ obeliskPackagesCommon = [
14+ "obelisk-frontend"
15+ "obelisk-route"
16+ "obelisk-executable-config-lookup"
17+ ];
18+
19+ obeliskPackagesBackend = obeliskPackagesCommon ++ [
20+ "obelisk-asset-manifest"
21+ "obelisk-asset-serve-snap"
22+ "obelisk-backend"
23+ "obelisk-cliapp"
24+ "obelisk-command"
25+ "obelisk-executable-config-inject"
26+ "obelisk-frontend"
27+ "obelisk-run"
28+ "obelisk-route"
29+ "obelisk-selftest"
30+ "obelisk-snap-extras"
31+ ];
32+
33+ pnameToAttrs = pkgsSet: pnames:
34+ lib.listToAttrs (map
35+ (name: { inherit name; value = pkgsSet.${name}; })
36+ pnames);
37+
38+ collect = v:
39+ if lib.isDerivation v then [v]
40+ else if lib.isAttrs v then lib.concatMap collect (builtins.attrValues v)
41+ else if lib.isList v then lib.concatMap collect v
42+ else [];
43+
44+ perPlatform = lib.genAttrs cacheBuildSystems (system: let
45+ reflex-platform = import ./dep/reflex-platform { inherit system; };
46+
47+ mkPerProfiling = profiling: let
48+ obelisk = import ./. (self-args // { inherit system profiling; });
49+ ghc = pnameToAttrs
50+ obelisk.haskellPackageSets.ghc
51+ obeliskPackagesBackend;
52+ ghcjs = pnameToAttrs
53+ obelisk.haskellPackageSets.ghcjs
54+ obeliskPackagesCommon;
55+ command = obelisk.command;
56+
57+ withSkeletonOptions = skel: options: (skel.passthru.__unstable__.self.extend (self: super: {
58+ userSettings = super.userSettings // options;
59+ })).project;
60+ rawSkeleton = import ./skeleton { inherit obelisk; };
61+ skeleton = withSkeletonOptions rawSkeleton {
62+ withHoogle = true; # cache the Hoogle database for the skeleton
63+ __withGhcide = true; # cache the ghcide build for the skeleton
64+ };
65+
66+ serverSkeletonExe = rawSkeleton.exe;
67+ # TODO fix nixpkgs so it doesn't try to run the result of haskell shells as setup hooks.
68+ serverSkeletonShell = local-self.nixpkgs.runCommand "shell-safe-for-dep" {} ''
69+ touch "$out"
70+ echo "return" >> "$out"
71+ cat "${skeleton.shells.ghc}" >> "$out"
72+ '';
73+ androidSkeleton = skeleton.android.frontend;
74+ iosSkeleton = skeleton.ios.frontend;
75+ nameSuffix = if profiling then "profiled" else "unprofiled";
76+ packages = {
77+ skeletonProfiledObRun = rawSkeleton.__unstable__.profiledObRun;
78+ inherit
79+ command
80+ serverSkeletonShell
81+ ghc
82+ ;
83+ } // lib.optionalAttrs (!profiling) {
84+ inherit
85+ ghcjs
86+ serverSkeletonExe
87+ ;
88+ } // lib.optionalAttrs reflex-platform.androidSupport {
89+ inherit androidSkeleton;
90+ } // lib.optionalAttrs reflex-platform.iosSupport {
91+ inherit iosSkeleton;
92+ };
93+ in packages // {
94+ cache = reflex-platform.pinBuildInputs
95+ "obelisk-${system}-${nameSuffix}"
96+ (collect packages);
97+ };
98+
99+ perProfiling = {
100+ profiled = mkPerProfiling true;
101+ unprofiled = mkPerProfiling false;
102+ };
103+ in perProfiling // {
104+ cache = reflex-platform.pinBuildInputs
105+ "obelisk-${system}"
106+ (map (p: p.cache) (builtins.attrValues perProfiling));
107+ });
108+
109+ metaCache = local-self.reflex-platform.pinBuildInputs
110+ "obelisk-everywhere"
111+ (map (a: a.cache) (builtins.attrValues perPlatform));
112+
113+in perPlatform // { inherit metaCache; }
all-tests.nixnew file+145
@@ -0,0 +1,145 @@
1+{
2+ supportedSystems ? [ builtins.currentSystem ]
3+}:
4+let
5+ nginxRoot = "/run/nginx";
6+ obelisk = import ./default.nix {};
7+ # Get NixOS a pre-release 20.03 that contains the python based tests and recursive nix
8+ pkgs = import (builtins.fetchTarball https://github.com/nixos/nixpkgs/archive/3de5266.tar.gz) {};
9+ sshKeys = import (pkgs.path + /nixos/tests/ssh-keys.nix) pkgs;
10+ make-test = import (pkgs.path + /nixos/tests/make-test-python.nix);
11+ obelisk-everywhere = (import ./all-builds.nix { inherit supportedSystems; }).x86_64-linux.cache;
12+ snakeOilPrivateKey = sshKeys.snakeOilPrivateKey.text;
13+ snakeOilPublicKey = sshKeys.snakeOilPublicKey;
14+in
15+ make-test ({...}: {
16+ name = "obelisk";
17+ nodes = {
18+ githost = {
19+ networking.firewall.allowedTCPPorts = [ 22 80 ];
20+ services.openssh = {
21+ enable = true;
22+ };
23+ environment.systemPackages = [
24+ pkgs.git
25+ ];
26+ users.users.root.openssh.authorizedKeys.keys = [
27+ snakeOilPublicKey
28+ ];
29+ };
30+
31+ client = {
32+ imports = [
33+ (pkgs.path + /nixos/modules/installer/cd-dvd/channel.nix)
34+ ];
35+ nix.useSandbox = false;
36+ nix.binaryCaches = [];
37+ environment.systemPackages = [
38+ obelisk.command
39+ obelisk.shell
40+ obelisk-everywhere
41+ pkgs.git
42+ ];
43+ };
44+ };
45+
46+ testScript =
47+ let
48+ privateKeyFile = pkgs.writeText "id_rsa" ''${snakeOilPrivateKey}'';
49+ thunkableSample = pkgs.writeText "default.nix" ''
50+ let pkgs = import <nixpkgs> {}; in pkgs.git
51+ '';
52+ invalidThunkableSample = pkgs.writeText "default.nix" ''
53+ let pkgs = import <nixpkgs> {}; in pkgtypo.git
54+ '';
55+ sshConfigFile = pkgs.writeText "ssh_config" ''
56+ Host *
57+ StrictHostKeyChecking no
58+ UserKnownHostsFile=/dev/null
59+ ConnectionAttempts=1
60+ ConnectTimeout=1
61+ IdentityFile=~/.ssh/id_rsa
62+ User=root
63+ '';
64+ in ''
65+ start_all()
66+
67+ with subtest("obelisk is installed and git is configured"):
68+ client.succeed("ob --help")
69+ client.succeed('git config --global user.email "you@example.com"')
70+ client.succeed('git config --global user.name "Your Name"')
71+
72+ githost.wait_for_open_port("22")
73+
74+ with subtest("the client can access the server via ssh"):
75+ client.succeed("mkdir -p ~/.ssh/")
76+ client.succeed(
77+ "cp ${privateKeyFile} ~/.ssh/id_rsa"
78+ )
79+ client.succeed("chmod 600 ~/.ssh/id_rsa")
80+ client.wait_until_succeeds(
81+ "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no -i ~/.ssh/id_rsa githost true"
82+ )
83+ client.succeed(
84+ "cp ${sshConfigFile} ~/.ssh/config"
85+ )
86+ client.wait_until_succeeds("ssh githost true")
87+
88+ with subtest("a remote bare repo can be started"):
89+ githost.succeed("mkdir -p ~/myorg/myapp.git")
90+ githost.succeed("cd ~/myorg/myapp.git && git init --bare")
91+
92+ with subtest("a git project can be configured with a remote using ssh"):
93+ client.succeed("mkdir -p ~/code/myapp")
94+ client.succeed("cd ~/code/myapp && git init")
95+ client.succeed(
96+ "cp ${thunkableSample} ~/code/myapp/default.nix"
97+ )
98+ client.succeed("cd ~/code/myapp && git add .")
99+
100+ client.succeed('cd ~/code/myapp && git commit -m "Initial"')
101+ client.succeed(
102+ "cd ~/code/myapp && git remote add origin root@githost:/root/myorg/myapp.git"
103+ )
104+
105+
106+ with subtest("pushing code to the remote"):
107+ client.succeed("cd ~/code/myapp && git push -u origin master")
108+ client.succeed("cd ~/code/myapp && git status")
109+
110+ with subtest("obelisk can pack"):
111+ client.succeed("ob -v thunk pack ~/code/myapp")
112+ client.succeed("grep -qF 'git.json' ~/code/myapp/thunk.nix")
113+ client.succeed("grep -qF 'myorg' ~/code/myapp/git.json")
114+ client.succeed("ob -v thunk unpack ~/code/myapp")
115+
116+ with subtest("obelisk can set the public / private flag"):
117+ client.succeed("ob -v thunk pack ~/code/myapp --private")
118+ client.fail("""grep -qF '"private": practice' ~/code/myapp/git.json""")
119+ client.succeed("""grep -qF '"private": true' ~/code/myapp/git.json""")
120+ client.succeed("nix-build ~/code/myapp")
121+ client.succeed("ob -v thunk unpack ~/code/myapp")
122+ client.succeed("ob -v thunk pack ~/code/myapp --public")
123+ client.succeed("""grep -qF '"private": false' ~/code/myapp/git.json""")
124+ client.succeed("nix-build ~/code/myapp")
125+ client.succeed("ob -v thunk unpack ~/code/myapp")
126+
127+ with subtest("building an invalid thunk fails"):
128+ client.succeed("cd ~/code/myapp && git checkout -b bad")
129+ client.succeed(
130+ "cp ${invalidThunkableSample} ~/code/myapp/default.nix"
131+ )
132+ client.succeed("cd ~/code/myapp && git add .")
133+ client.succeed('cd ~/code/myapp && git commit -m "Bad commit"')
134+ client.succeed("cd ~/code/myapp && git push -u origin bad")
135+ client.succeed("ob -v thunk pack ~/code/myapp --public")
136+ client.fail("nix-build ~/code/myapp")
137+ client.succeed("ob -v thunk unpack ~/code/myapp")
138+ client.succeed("cd ~/code/myapp && git checkout master")
139+
140+ with subtest("obelisk can detect private repos"):
141+ client.succeed("ob -v thunk pack ~/code/myapp")
142+ client.succeed("""grep -qF '"private": true' ~/code/myapp/git.json""")
143+ client.succeed("ob -v thunk unpack ~/code/myapp")
144+ '';
145+ }) {}
default.nix+245−204
@@ -1,119 +1,40 @@
11{ system ? builtins.currentSystem
22, profiling ? false
3−, iosSdkVersion ? "10.2"
4−, __useLegacyCompilers ? false
3+, iosSdkVersion ? "13.2"
4+, config ? {}
5+, terms ? { # Accepted terms, conditions, and licenses
6+ security.acme.acceptTerms = false;
7+ }
8+, reflex-platform-func ? import ./dep/reflex-platform
59}:
610let
7− cleanSource = builtins.filterSource (name: _: let baseName = builtins.baseNameOf name; in !(
8− builtins.match "^\\.ghc\\.environment.*" baseName != null ||
9− baseName == "cabal.project.local"
10− ));
11−
12− commandRuntimeDeps = pkgs: with pkgs; [
13− coreutils
14− git
15− gitAndTools.hub
16− nix-prefetch-git
17− openssh
18− ];
19−
20− getReflexPlatform = getReflexPlatform' __useLegacyCompilers;
21− getReflexPlatform' = __useLegacyCompilers: sys: import ./dep/reflex-platform {
22− inherit iosSdkVersion __useLegacyCompilers;
23− system = sys;
24− enableLibraryProfiling = profiling;
11+ reflex-platform = getReflexPlatform { inherit system; };
12+ inherit (reflex-platform) hackGet nixpkgs;
13+ pkgs = nixpkgs;
14+
15+ inherit (import dep/gitignore.nix { inherit (nixpkgs) lib; }) gitignoreSource;
16+
17+ getReflexPlatform = { system, enableLibraryProfiling ? profiling }: reflex-platform-func {
18+ inherit iosSdkVersion config system enableLibraryProfiling;
2519
2620 nixpkgsOverlays = [
27− (self: super: {
28− obeliskExecutableConfig = import ./lib/executable-config { nixpkgs = pkgs; filterGitSource = cleanSource; };
29− })
21+ (import ./nixpkgs-overlays)
3022 ];
3123
3224 haskellOverlays = [
33−
34− # Fix misc upstream packages
35− (self: super: let
36− pkgs = self.callPackage ({ pkgs }: pkgs) {};
37− in {
38− # Need 8.0.2 build support
39− # PR: https://github.com/dmwit/universe/pull/33
40− universe-template = self.callCabal2nix "universe-template" (pkgs.fetchFromGitHub {
41− owner = "obsidiansystems";
42− repo = "universe";
43− rev = "6a71119bfa5db2b9990a2491c941469ff8ef5d13";
44− sha256 = "0z8smyainnlzcglv3dlx6x1n9j6d2jv48aa8f2421iayfkxg3js5";
45− } + /template) {};
46− })
47−
48− # Add obelisk packages
49− (self: super: let
50− pkgs = self.callPackage ({ pkgs }: pkgs) {};
51− in {
52− obelisk-executable-config = pkgs.obeliskExecutableConfig.haskellPackage self;
53− obelisk-executable-config-inject = pkgs.obeliskExecutableConfig.platforms.web.inject self;
54−
55− obelisk-asset-manifest = self.callCabal2nix "obelisk-asset-manifest" (hackGet ./lib/asset + "/manifest") {};
56− obelisk-asset-serve-snap = self.callCabal2nix "obelisk-asset-serve-snap" (hackGet ./lib/asset + "/serve-snap") {};
57− obelisk-backend = self.callCabal2nix "obelisk-backend" (cleanSource ./lib/backend) {};
58− obelisk-cliapp = self.callCabal2nix "obelisk-cliapp" (cleanSource ./lib/cliapp) {};
59− obelisk-command = self.callCabal2nix "obelisk-command" (cleanSource ./lib/command) {};
60− obelisk-frontend = self.callCabal2nix "obelisk-frontend" (cleanSource ./lib/frontend) {};
61− obelisk-run = self.callCabal2nix "obelisk-run" (cleanSource ./lib/run) {};
62− obelisk-route = self.callCabal2nix "obelisk-route" (cleanSource ./lib/route) {};
63− obelisk-selftest = self.callCabal2nix "obelisk-selftest" (cleanSource ./lib/selftest) {};
64− obelisk-snap-extras = self.callCabal2nix "obelisk-snap-extras" (cleanSource ./lib/snap-extras) {};
65− })
66−
67− (self: super: let
68− pkgs = self.callPackage ({ pkgs }: pkgs) {};
69− haskellLib = pkgs.haskell.lib;
70− #TODO: Upstream
71− # Modify a Haskell package to add completion scripts for the given
72− # executable produced by it. These completion scripts will be picked up
73− # automatically if the resulting derivation is installed, e.g. by
74− # `nix-env -i`.
75− addOptparseApplicativeCompletionScripts = exeName: pkg: haskellLib.overrideCabal pkg (drv: {
76− postInstall = (drv.postInstall or "") + ''
77− BASH_COMP_DIR="$out/share/bash-completion/completions"
78− mkdir -p "$BASH_COMP_DIR"
79− "$out/bin/${exeName}" --bash-completion-script "$out/bin/${exeName}" >"$BASH_COMP_DIR/ob"
80−
81− ZSH_COMP_DIR="$out/share/zsh/vendor-completions"
82− mkdir -p "$ZSH_COMP_DIR"
83− "$out/bin/${exeName}" --zsh-completion-script "$out/bin/${exeName}" >"$ZSH_COMP_DIR/_ob"
84−
85− FISH_COMP_DIR="$out/share/fish/vendor_completions.d"
86− mkdir -p "$FISH_COMP_DIR"
87− "$out/bin/${exeName}" --fish-completion-script "$out/bin/${exeName}" >"$FISH_COMP_DIR/ob.fish"
88− '';
89− });
90− in {
91− # Dynamic linking with split objects dramatically increases startup time (about
92− # 0.5 seconds on a decent machine with SSD), so we do `justStaticExecutables`.
93− obelisk-command = haskellLib.overrideCabal
94− (addOptparseApplicativeCompletionScripts "ob"
95− (haskellLib.justStaticExecutables super.obelisk-command))
96− (drv: {
97− buildTools = (drv.buildTools or []) ++ [ pkgs.buildPackages.makeWrapper ];
98− postFixup = ''
99− ${drv.postFixup or ""}
100− # Make `ob` reference its runtime dependencies.
101− wrapProgram "$out"/bin/ob --prefix PATH : ${pkgs.lib.makeBinPath (commandRuntimeDeps pkgs)}
102− '';
103− });
104− obelisk-selftest = haskellLib.justStaticExecutables super.obelisk-selftest;
105− })
106−
25+ (import ./haskell-overlays/misc-deps.nix { inherit hackGet; })
26+ pkgs.obeliskExecutableConfig.haskellOverlay
27+ (import ./haskell-overlays/obelisk.nix)
28+ (import ./haskell-overlays/tighten-ob-exes.nix)
10729 ];
10830 };
10931
110− reflex-platform = getReflexPlatform' false system;
111− inherit (reflex-platform) hackGet nixpkgs;
112− pkgs = nixpkgs;
113−
11432 # The haskell environment used to build Obelisk itself, e.g. the 'ob' command
11533 ghcObelisk = reflex-platform.ghc;
11634
35+ # Development environments for obelisk packages.
36+ ghcObeliskEnvs = pkgs.lib.mapAttrs (n: v: reflex-platform.workOn ghcObelisk v) ghcObelisk;
37+
11738 inherit (import ./lib/asset/assets.nix { inherit nixpkgs; }) mkAssets;
11839
11940 haskellLib = pkgs.haskell.lib;
@@ -125,18 +46,18 @@ in rec {
12546 pathGit = ./.; # Used in CI by the migration graph hash algorithm to correctly ignore files.
12647 path = reflex-platform.filterGit ./.;
12748 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
12850 command = ghcObelisk.obelisk-command;
129− shell = pinBuildInputs "obelisk-shell" ([command] ++ commandRuntimeDeps pkgs) [];
51+ shell = pinBuildInputs "obelisk-shell" ([command] ++ command.commandRuntimeDeps);
13052
13153 selftest = pkgs.writeScript "selftest" ''
132− #!/usr/bin/env bash
54+ #!${pkgs.runtimeShell}
13355 set -euo pipefail
13456
13557 PATH="${command}/bin:$PATH"
136− export OBELISK_IMPL="${hackGet ./.}"
58+ cd ${./.}
13759 "${ghcObelisk.obelisk-selftest}/bin/obelisk-selftest" +RTS -N -RTS "$@"
13860 '';
139− #TODO: Why can't I build ./skeleton directly as a derivation? `nix-build -E ./.` doesn't work
14061 skeleton = pkgs.runCommand "skeleton" {
14162 dir = builtins.filterSource (path: type: builtins.trace path (baseNameOf path != ".obelisk")) ./skeleton;
14263 } ''
@@ -155,27 +76,48 @@ in rec {
15576 obelisk-asset-manifest-generate "$src" "$haskellManifest" ${packageName} ${moduleName} "$symlinked"
15677 '';
15778
158− compressedJs = frontend: optimizationLevel: pkgs.runCommand "compressedJs" { buildInputs = [ pkgs.closurecompiler ]; } ''
159− mkdir $out
160− cd $out
161− ln -s "${haskellLib.justStaticExecutables frontend}/bin/frontend.jsexe/all.js" all.unminified.js
162− 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
163− echo "//# sourceMappingURL=all.js.map" >> all.js
79+ compressedJs = frontend: optimizationLevel: pkgs.runCommand "compressedJs" {} ''
80+ set -euo pipefail
81+ cd '${haskellLib.justStaticExecutables frontend}'
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 ''
88+ ln -s "$dir/all.unminified.js" "$dir/all.js"
89+ '' 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"
91+ echo '//# sourceMappingURL=all.js.map' >> "$dir/all.js"
92+ ''}
93+ done
16494 '';
16595
16696 serverModules = {
167− mkBaseEc2 = { hostName, routeHost, enableHttps, adminEmail, ... }: {...}: {
97+ mkBaseEc2 = { nixosPkgs, ... }: {...}: {
16898 imports = [
169− (pkgs.path + /nixos/modules/virtualisation/amazon-image.nix)
99+ (nixosPkgs.path + /nixos/modules/virtualisation/amazon-image.nix)
170100 ];
101+ ec2.hvm = true;
102+ };
103+
104+ mkDefaultNetworking = { adminEmail, enableHttps, hostName, routeHost, ... }: {...}: {
171105 networking = {
172106 inherit hostName;
173107 firewall.allowedTCPPorts = if enableHttps then [ 80 443 ] else [ 80 ];
174108 };
109+
110+ # `amazon-image.nix` already sets these but if the user provides their own module then
111+ # forgetting these can cause them to lose access to the server!
112+ # https://github.com/NixOS/nixpkgs/blob/fab05f17d15e4e125def4fd4e708d205b41d8d74/nixos/modules/virtualisation/amazon-image.nix#L133-L136
113+ services.openssh.enable = true;
114+ services.openssh.permitRootLogin = "prohibit-password";
115+
175116 security.acme.certs = if enableHttps then {
176117 "${routeHost}".email = adminEmail;
177118 } else {};
178− ec2.hvm = true;
119+
120+ security.acme.${if enableHttps && (terms.security.acme.acceptTerms or false) then "acceptTerms" else null} = true;
179121 };
180122
181123 mkObeliskApp =
@@ -192,11 +134,16 @@ in rec {
192134 }: {...}: {
193135 services.nginx = {
194136 enable = true;
137+ recommendedProxySettings = true;
195138 virtualHosts."${routeHost}" = {
196139 enableACME = enableHttps;
197140 forceSSL = enableHttps;
198141 locations.${baseUrl} = {
199− proxyPass = "http://localhost:" + toString internalPort;
142+ proxyPass = "http://127.0.0.1:" + toString internalPort;
143+ proxyWebsockets = true;
144+ extraConfig = ''
145+ access_log off;
146+ '';
200147 };
201148 };
202149 };
@@ -204,10 +151,11 @@ in rec {
204151 wantedBy = [ "multi-user.target" ];
205152 after = [ "network.target" ];
206153 restartIfChanged = true;
154+ path = [ pkgs.gnutar ];
207155 script = ''
208156 ln -sft . '${exe}'/*
209157 mkdir -p log
210− exec ./backend ${backendArgs} >>backend.out 2>>backend.err </dev/null
158+ exec ./backend ${backendArgs} </dev/null
211159 '';
212160 serviceConfig = {
213161 User = user;
@@ -230,120 +178,213 @@ in rec {
230178 };
231179 };
232180
233− serverExe = backend: frontend: assets: config: optimizationLevel: version:
181+ inherit mkAssets;
182+
183+ serverExe = backend: frontend: assets: optimizationLevel: version:
234184 pkgs.runCommand "serverExe" {} ''
235185 mkdir $out
236186 set -eux
237− ln -s "${haskellLib.justStaticExecutables backend}"/bin/* $out/
238− ln -s "${mkAssets assets}" $out/static.assets
239− cp -r ${config} $out/config
240− ln -s ${mkAssets (compressedJs frontend optimizationLevel)} $out/frontend.jsexe.assets
187+ ln -s '${if profiling then backend else haskellLib.justStaticExecutables backend}'/bin/* $out/
188+ ln -s '${mkAssets assets}' $out/static.assets
189+ for d in '${mkAssets (compressedJs frontend optimizationLevel)}'/*/; do
190+ ln -s "$d" "$out"/"$(basename "$d").assets"
191+ done
241192 echo ${version} > $out/version
242193 '';
243194
244− server = { exe, hostName, adminEmail, routeHost, enableHttps, config, version }@args:
195+ server = { exe, hostName, adminEmail, routeHost, enableHttps, version, module ? serverModules.mkBaseEc2 }@args:
245196 let
246197 nixos = import (pkgs.path + /nixos);
247198 in nixos {
248199 system = "x86_64-linux";
249200 configuration = {
250201 imports = [
251− (serverModules.mkBaseEc2 args)
202+ (module { inherit exe hostName adminEmail routeHost enableHttps version; nixosPkgs = pkgs; })
203+ (serverModules.mkDefaultNetworking args)
252204 (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+ })
253219 ];
254220 };
255221 };
256222
257−
258223 # An Obelisk project is a reflex-platform project with a predefined layout and role for each component
259− project = base: projectDefinition:
260− let configPath = base + "/config";
261− projectOut = sys: (getReflexPlatform sys).project (args@{ nixpkgs, ... }:
262− let mkProject = { android ? null #TODO: Better error when missing
263− , ios ? null #TODO: Better error when missing
264− , packages ? {}
265− , overrides ? _: _: {}
266− , staticFiles ? base + /static
267− , tools ? _: []
268− , shellToolOverrides ? _: _: {}
269− , withHoogle ? false # Setting this to `true` makes shell reloading far slower
270− , __closureCompilerOptimizationLevel ? "ADVANCED"
271− }:
272− let frontendName = "frontend";
273− backendName = "backend";
274− commonName = "common";
275− staticName = "obelisk-generated-static";
276− processedStatic = processAssets { src = staticFiles; };
277− # The packages whose names and roles are defined by this package
278− predefinedPackages = lib.filterAttrs (_: x: x != null) {
279− ${frontendName} = nullIfAbsent (base + "/frontend");
280− ${commonName} = nullIfAbsent (base + "/common");
281− ${backendName} = nullIfAbsent (base + "/backend");
282− };
283− combinedPackages = predefinedPackages // packages;
284− projectOverrides = self: super: {
285− ${staticName} = haskellLib.dontHaddock (self.callCabal2nix staticName processedStatic.haskellManifest {});
286− ${backendName} = haskellLib.addBuildDepend super.${backendName} self.obelisk-run;
287− };
288− totalOverrides = lib.composeExtensions projectOverrides overrides;
289− inherit (lib.strings) hasPrefix;
290− privateConfigDirs = ["config/backend"];
291− injectableConfig = builtins.filterSource (path: _:
292− !(lib.lists.any (x: hasPrefix (toString base + "/" + toString x) (toString path)) privateConfigDirs)
293− ) configPath;
294− in {
295− inherit shellToolOverrides tools withHoogle;
296− overrides = totalOverrides;
297− packages = combinedPackages;
298− shells = {
299− ${if android == null && ios == null then null else "ghcSavedSplices"} = (lib.filter (x: lib.hasAttr x combinedPackages) [
300− commonName
301− frontendName
302− ]);
303− ghc = (lib.filter (x: lib.hasAttr x combinedPackages) [
304− backendName
305− commonName
306− frontendName
307− ]);
308− ghcjs = lib.filter (x: lib.hasAttr x combinedPackages) [
309− frontendName
310− commonName
311− ];
224+ project = base': projectDefinition:
225+ let
226+ projectOut = { system, enableLibraryProfiling ? profiling }: let reflexPlatformProject = (getReflexPlatform { inherit system enableLibraryProfiling; }).project; in reflexPlatformProject (args@{ nixpkgs, ... }:
227+ let
228+ inherit (lib.strings) hasPrefix;
229+ mkProject =
230+ { android ? null #TODO: Better error when missing
231+ , ios ? null #TODO: Better error when missing
232+ , packages ? {}
233+ , overrides ? _: _: {}
234+ , staticFiles ? null
235+ , tools ? _: []
236+ , shellToolOverrides ? _: _: {}
237+ , withHoogle ? false # Setting this to `true` makes shell reloading far slower
238+ , __closureCompilerOptimizationLevel ? "ADVANCED" # Set this to `null` to skip the closure-compiler step
239+ , __withGhcide ? false
240+ }:
241+ let
242+ allConfig = nixpkgs.lib.makeExtensible (self: {
243+ base = base';
244+ inherit args;
245+ userSettings = {
246+ inherit android ios packages overrides tools shellToolOverrides withHoogle __closureCompilerOptimizationLevel __withGhcide;
247+ staticFiles = if staticFiles == null then self.base + /static else staticFiles;
248+ };
249+ frontendName = "frontend";
250+ backendName = "backend";
251+ commonName = "common";
252+ staticName = "obelisk-generated-static";
253+ staticFilesImpure = let fs = self.userSettings.staticFiles; in if lib.isDerivation fs then fs else toString fs;
254+ processedStatic = processAssets { src = self.userSettings.staticFiles; };
255+ # The packages whose names and roles are defined by this package
256+ predefinedPackages = lib.filterAttrs (_: x: x != null) {
257+ ${self.frontendName} = nullIfAbsent (self.base + "/frontend");
258+ ${self.commonName} = nullIfAbsent (self.base + "/common");
259+ ${self.backendName} = nullIfAbsent (self.base + "/backend");
312260 };
313− android = {
314− ${if android == null then null else frontendName} = {
261+ shellPackages = {};
262+ combinedPackages = self.predefinedPackages // self.userSettings.packages // self.shellPackages;
263+ projectOverrides = self': super': {
264+ ${self.staticName} = haskellLib.dontHaddock (self'.callCabal2nix self.staticName self.processedStatic.haskellManifest {});
265+ ${self.backendName} = haskellLib.addBuildDepend super'.${self.backendName} self'.obelisk-run;
266+ };
267+ totalOverrides = lib.composeExtensions self.projectOverrides self.userSettings.overrides;
268+ privateConfigDirs = ["config/backend"];
269+ injectableConfig = builtins.filterSource (path: _:
270+ !(lib.lists.any (x: hasPrefix (toString self.base + "/" + toString x) (toString path)) self.privateConfigDirs)
271+ );
272+ __androidWithConfig = configPath: {
273+ ${if self.userSettings.android == null then null else self.frontendName} = {
315274 executableName = "frontend";
316− ${if builtins.pathExists staticFiles then "assets" else null} =
317− nixpkgs.obeliskExecutableConfig.platforms.android.inject injectableConfig processedStatic.symlinked;
318− } // android;
275+ ${if builtins.pathExists self.userSettings.staticFiles then "assets" else null} =
276+ nixpkgs.obeliskExecutableConfig.platforms.android.inject
277+ (self.injectableConfig configPath)
278+ self.processedStatic.symlinked;
279+ } // self.userSettings.android;
319280 };
320− ios = {
321− ${if ios == null then null else frontendName} = {
281+ __iosWithConfig = configPath: {
282+ ${if self.userSettings.ios == null then null else self.frontendName} = {
322283 executableName = "frontend";
323− ${if builtins.pathExists staticFiles then "staticSrc" else null} =
324− nixpkgs.obeliskExecutableConfig.platforms.ios.inject injectableConfig processedStatic.symlinked;
325− } // ios;
284+ ${if builtins.pathExists self.userSettings.staticFiles then "staticSrc" else null} =
285+ nixpkgs.obeliskExecutableConfig.platforms.ios.inject
286+ (self.injectableConfig configPath)
287+ self.processedStatic.symlinked;
288+ } // self.userSettings.ios;
289+ };
290+
291+ shells-ghc = builtins.attrNames (self.predefinedPackages // self.shellPackages);
292+
293+ shells-ghcjs = [
294+ self.frontendName
295+ self.commonName
296+ ];
297+
298+ shells-ghcSavedSplices = [
299+ self.commonName
300+ self.frontendName
301+ ];
302+
303+ shellToolOverrides = lib.composeExtensions
304+ self.userSettings.shellToolOverrides
305+ (if self.userSettings.__withGhcide
306+ then (import ./haskell-overlays/ghcide.nix)
307+ else (_: _: {})
308+ );
309+
310+ project = reflexPlatformProject ({...}: self.projectConfig);
311+ projectConfig = {
312+ inherit (self) shellToolOverrides;
313+ inherit (self.userSettings) tools withHoogle;
314+ overrides = self.totalOverrides;
315+ packages = self.combinedPackages;
316+ shells = {
317+ ${if self.userSettings.android == null && self.userSettings.ios == null then null else "ghcSavedSplices"} =
318+ lib.filter (x: lib.hasAttr x self.combinedPackages) self.shells-ghcSavedSplices;
319+ ghc = lib.filter (x: lib.hasAttr x self.combinedPackages) self.shells-ghc;
320+ ghcjs = lib.filter (x: lib.hasAttr x self.combinedPackages) self.shells-ghcjs;
321+ };
322+ android = self.__androidWithConfig (self.base + "/config");
323+ ios = self.__iosWithConfig (self.base + "/config");
324+
325+ passthru = {
326+ __unstable__.self = allConfig;
327+ inherit (self)
328+ staticFilesImpure processedStatic
329+ __iosWithConfig __androidWithConfig
330+ ;
331+ inherit (self.userSettings)
332+ android ios overrides packages shellToolOverrides staticFiles tools withHoogle
333+ __closureCompilerOptimizationLevel
334+ ;
335+ };
326336 };
327− passthru = { inherit android ios packages overrides tools shellToolOverrides withHoogle staticFiles __closureCompilerOptimizationLevel; };
328− };
329− in mkProject (projectDefinition args));
330− serverOn = sys: config: version: serverExe
331− (projectOut sys).ghc.backend
332− (projectOut system).ghcjs.frontend
333− (projectOut sys).passthru.staticFiles
334− config
335− (projectOut sys).passthru.__closureCompilerOptimizationLevel
337+ });
338+ in allConfig;
339+ in (mkProject (projectDefinition args)).projectConfig);
340+ mainProjectOut = projectOut { inherit system; };
341+ serverOn = projectInst: version: serverExe
342+ projectInst.ghc.backend
343+ mainProjectOut.ghcjs.frontend
344+ projectInst.passthru.staticFiles
345+ projectInst.passthru.__closureCompilerOptimizationLevel
336346 version;
337− linuxExe = serverOn "x86_64-linux";
347+ linuxExe = serverOn (projectOut { system = "x86_64-linux"; });
338348 dummyVersion = "Version number is only available for deployments";
339− in projectOut system // {
349+ in mainProjectOut // {
350+ __unstable__.profiledObRun = let
351+ profiled = projectOut { inherit system; enableLibraryProfiling = true; };
352+ exeSource = builtins.toFile "ob-run.hs" ''
353+ {-# LANGUAGE NoImplicitPrelude #-}
354+ {-# LANGUAGE PackageImports #-}
355+ module Main where
356+
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)
361+ import "reflex" Reflex.Profiled (writeProfilingData)
362+ import "base" System.Environment (getArgs)
363+
364+ import qualified "obelisk-run" Obelisk.Run
365+ import qualified Frontend
366+ import qualified Backend
367+
368+ main :: IO ()
369+ main = do
370+ [portStr, assets, profFileName] <- getArgs
371+ Obelisk.Run.run (read portStr) (Obelisk.Run.runServeAsset assets) Backend.backend Frontend.frontend
372+ `finally` writeProfilingData (profFileName ++ ".rprof")
373+ '';
374+ in nixpkgs.runCommand "ob-run" {
375+ buildInputs = [ (profiled.ghc.ghcWithPackages (p: [p.backend p.frontend])) ];
376+ } ''
377+ cp ${exeSource} ob-run.hs
378+ mkdir -p $out/bin
379+ ghc -x hs -prof -fno-prof-auto -threaded ob-run.hs -o $out/bin/ob-run
380+ '';
381+
340382 linuxExeConfigurable = linuxExe;
341− linuxExe = linuxExe (base + "/config") dummyVersion;
342− exe = serverOn system (base + "/config") dummyVersion;
343− server = args@{ hostName, adminEmail, routeHost, enableHttps, config, version }: let
344− injectableConfig = builtins.filterSource (path: _: !(lib.hasPrefix (toString config + "/backend") (toString path))) config;
345− in server (args // { exe = linuxExe injectableConfig version; });
346− obelisk = import (base + "/.obelisk/impl") {};
383+ linuxExe = linuxExe dummyVersion;
384+ exe = serverOn mainProjectOut dummyVersion;
385+ server = args@{ hostName, adminEmail, routeHost, enableHttps, version, module ? serverModules.mkBaseEc2 }:
386+ server (args // { exe = linuxExe version; });
387+ obelisk = import (base' + "/.obelisk/impl") {};
347388 };
348389 haskellPackageSets = {
349390 inherit (reflex-platform) ghc ghcjs;
dep/.gitignoredeleted−4
@@ -1,4 +0,0 @@
1−*
2−!.gitignore
3−!*/*.json
4−!*/default.nix
dep/ghcid/default.nixnew file+7
@@ -0,0 +1,7 @@
1+# DO NOT HAND-EDIT THIS FILE
2+import ((import <nixpkgs> {}).fetchFromGitHub (
3+ let json = builtins.fromJSON (builtins.readFile ./github.json);
4+ in { inherit (json) owner repo rev sha256;
5+ private = json.private or false;
6+ }
7+))
dep/ghcid/github.jsonnew file+7
@@ -0,0 +1,7 @@
1+{
2+ "owner": "ndmitchell",
3+ "repo": "ghcid",
4+ "branch": "master",
5+ "rev": "f572318f32b1617f6054248e5888af68222f8e50",
6+ "sha256": "1icg3r70lg2kmd9gdc024ih1n9nrja98yav74z9nvykqygvv5w0n"
7+}
dep/gitignore.nix/default.nixnew file+8
@@ -0,0 +1,8 @@
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+in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))
dep/gitignore.nix/github.jsonnew file+8
@@ -0,0 +1,8 @@
1+{
2+ "owner": "hercules-ci",
3+ "repo": "gitignore.nix",
4+ "branch": "master",
5+ "private": false,
6+ "rev": "7415c4feb127845553943a3856cbc5cb967ee5e0",
7+ "sha256": "1zd1ylgkndbb5szji32ivfhwh04mr1sbgrnvbrqpmfb67g2g3r9i"
8+}
dep/hnix/default.nixnew file+7
@@ -0,0 +1,7 @@
1+# DO NOT HAND-EDIT THIS FILE
2+import ((import <nixpkgs> {}).fetchFromGitHub (
3+ let json = builtins.fromJSON (builtins.readFile ./github.json);
4+ in { inherit (json) owner repo rev sha256;
5+ private = json.private or false;
6+ }
7+))
dep/hnix/github.jsonnew file+7
@@ -0,0 +1,7 @@
1+{
2+ "owner": "haskell-nix",
3+ "repo": "hnix",
4+ "branch": "master",
5+ "rev": "6c9c7c310c54372b3db0fdf5a0137b395cde1bdb",
6+ "sha256": "1i5903b7lxqn2s3jarb14h6wdq8bxiik1hp0xy43w5w1hgvvq0g5"
7+}
dep/reflex-platform/default.nix+1−6
@@ -1,7 +1,2 @@
11# DO NOT HAND-EDIT THIS FILE
2−import ((import <nixpkgs> {}).fetchFromGitHub (
3− let json = builtins.fromJSON (builtins.readFile ./github.json);
4− in { inherit (json) owner repo rev sha256;
5− private = json.private or false;
6− }
7−))
2+import (import ./thunk.nix)
dep/reflex-platform/github.json+4−3
@@ -1,7 +1,8 @@
11{
22 "owner": "reflex-frp",
33 "repo": "reflex-platform",
4− "branch": "develop",
5− "rev": "018576456043fe8372a0332c93245a4a620c1fb7",
6− "sha256": "0qhnyyf96iajz97pbqfsw2l1kkbr1yq3bvw3qhjk031vdrkv7b7y"
4+ "branch": "release/0.7.0.0",
5+ "private": false,
6+ "rev": "27a7851a780ff21472d85f9a02fb84635ef9027a",
7+ "sha256": "1m4zlw91dpjlbdchjyxhvhv3k7lilm0qa17dhhww868xxc27sann"
78}
dep/reflex-platform/thunk.nixnew file+9
@@ -0,0 +1,9 @@
1+# DO NOT HAND-EDIT THIS FILE
2+let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3+ if !fetchSubmodules && !private then builtins.fetchTarball {
4+ url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5+ } else (import <nixpkgs> {}).fetchFromGitHub {
6+ inherit owner repo rev sha256 fetchSubmodules private;
7+ };
8+ json = builtins.fromJSON (builtins.readFile ./github.json);
9+in fetch json
dep/snap-core/default.nixnew file+8
@@ -0,0 +1,8 @@
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+in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))
dep/snap-core/github.jsonnew file+8
@@ -0,0 +1,8 @@
1+{
2+ "owner": "obsidiansystems",
3+ "repo": "snap-core",
4+ "branch": "ts-expose-fileserve-internals",
5+ "private": false,
6+ "rev": "e015fc484e38dd9389c58b277b1884395e553bdf",
7+ "sha256": "1793x1h4lw9vnrii5akhfxx1x9yrgxf3052jf6bs8f1mhaic6mxx"
8+}
docs/obelisk-logo-640.pngnew file

Binary file not shown.

guides/app-deploy/README.mdnew file+324
@@ -0,0 +1,324 @@
1+# Obelisk Application Deployment Guide
2+
3+This 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+
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.
6+>
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.
8+
9+## a) Get Obelisk (Linux, Mac)
10+
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.
12+
13+Open a terminal and run the following:
14+
15+```bash
16+export WORKDIR=~/obelisk-guide
17+mkdir -p "$WORKDIR"
18+```
19+
20+Then let's get Obelisk from GitHub using a specific branch:
21+
22+```bash
23+export OBELISK_BRANCH=develop
24+git clone https://github.com/obsidiansystems/obelisk.git -b "$OBELISK_BRANCH" "$WORKDIR/obelisk"
25+```
26+
27+Once you have an Obelisk check out, you can build it using Nix and make a shortcut (alias) for the rest of the terminal session. With this you will be able to type `ob` anywhere as long as you do not close the terminal.
28+
29+```bash
30+alias ob=$(nix-build "$WORKDIR/obelisk" -A command --no-out-link)/bin/ob
31+```
32+
33+In order to start an Obelisk project, we need initialize it in a new directory. Let's call it `myapp`:
34+
35+```bash
36+mkdir -p "$WORKDIR/myapp"
37+cd "$WORKDIR/myapp"
38+ob init --branch "$OBELISK_BRANCH"
39+```
40+
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.
42+
43+## b) Run the Obelisk app on localhost (Linux, Mac)
44+
45+Let's test that we can run a server on localhost. This is quite easy:
46+
47+```bash
48+cd "$WORKDIR/myapp"
49+ob run
50+```
51+
52+Now open a browser and point it to http://localhost:8000 (or just click on this link). You should see the following:
53+
54+![](assets/app-deploy.png)
55+
56+## c) Prepare a VirtualBox deploy target (Linux, Mac)
57+
58+### Import the NixOS VirtualBox appliance
59+
60+Install [VirtualBox](https://www.virtualbox.org/) on your machine.
61+
62+On NixOS, do this by adding the following line to your `/etc/nixos/configuration.nix` before the last line containing `}`:
63+
64+```nix
65+ virtualisation.virtualbox.host.enable = true;
66+```
67+
68+then `sudo nixos-rebuild switch`.
69+
70+The NixOS [download page](https://nixos.org/nixos/download.html) has a section called "VirtualBox appliances". Download that as the target system. The author used the 19.09 `.ova` file.
71+
72+With the downloaded file, open VirtualBox and import the `.ova` file:
73+
74+![](assets/virtualbox-appliance-import.png)
75+
76+Leave the default settings and finish the import. That will take a few minutes:
77+
78+![](assets/virtualbox-appliance-import-loading.png)
79+
80+You should now see a NixOS machine in the dashboard:
81+
82+![](assets/virtualbox-dashboard-nixos.png)
83+
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".
85+
86+![](assets/virtualbox-image-settings-network.png)
87+
88+Finally, double-click on the "NixOS" machine and wait for it boot up. If it asks for a password, use `demo`.
89+
90+![](assets/virtualbox-nioxs-after-boot.png)
91+
92+### Configure the virtual machine for SSH
93+
94+Inside the virtual machine open up "Konsole" by clicking on the start menu in the bottom left corner and typing in "Konsole" until you see it as an option in the menu. Then click on it to open it.
95+
96+Change the system configuration using `sudo` to enable SSH access:
97+
98+```bash
99+sudo nano /etc/nixos/configuration.nix
100+```
101+
102+This will ask you to enter your password. Enter `demo`.
103+
104+![](assets/nano-edit-nixos-configuration.png)
105+
106+You need to add the following snippet right before the final line containing `}`.
107+
108+```nix
109+ services.openssh.enable = true;
110+ services.openssh.permitRootLogin = "yes";
111+```
112+
113+Save and close the editor by typing <kbd>Ctrl</kbd>+<kbd>O</kbd>, <kbd>Enter</kbd>, and then <kbd>Ctrl</kbd>+<kbd>X</kbd>.
114+
115+Now run `sudo nixos-rebuild switch` (if it asks for a password, again use `demo`) and then set the root password using `sudo passwd root`. Pick a simple password like `root`. You'll need to use it again.
116+
117+To get the virtual machine's IP address go back to the terminal on your *host* machine (not the virtual machine) and run:
118+
119+```bash
120+export VM_ID=$(VBoxManage list runningvms | grep "NixOS" | awk -F'[{}]' '{print $2}')
121+echo "$VM_ID"
122+```
123+
124+You should see a single identifier that looks like `388bbbe5-e0a2-4b20-9c76-bbaa5746682e`. If you see anything else then you likely you have multiple NixOS machines running. Stop any other machines and run this command again. (Of course, if you're a power user, just change the `grep` to pick out right VM.)
125+
126+Now get the IP address for that machine:
127+
128+```bash
129+export VM_IP=$(VBoxManage guestproperty enumerate "$VM_ID" | grep /V4/IP | awk '{print $4}' | sed 's/,//')
130+echo "$VM_IP"
131+```
132+
133+You should see an IP like `192.168.7.86`.
134+
135+With that you will be able to SSH into that machine from a terminal, using the username `root`.
136+
137+```bash
138+ssh root@$VM_IP echo "Access granted"
139+```
140+
141+This may ask if you want to trust the fingerprint for this server. Answer `yes`. It will ask you for a password. Enter the one you specified above. You should see `Access granted` printed after you type your password and hit <kbd>Enter</kbd>.
142+
143+> **Note:** If instead you see an error like this
144+>
145+> ```
146+> @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
147+> @ WARNING: REMOTE HOST IDENTIFICATION HAS CHANGED! @
148+> @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
149+> IT IS POSSIBLE THAT SOMEONE IS DOING SOMETHING NASTY!
150+> Someone could be eavesdropping on you right now (man-in-the-middle attack)!
151+> It is also possible that a host key has just been changed.
152+> ```
153+>
154+> you need to remove the old fingerprint for this IP. Run the following:
155+>
156+> ```bash
157+> sed -i "/^$VM_IP /d" ~/.ssh/known_hosts
158+> ```
159+>
160+> and then try the previous `ssh` command again.
161+
162+Now we'll allow access with an SSH key instead of a password. Create a new SSH key with `ssh-keygen`:
163+
164+```bash
165+ssh-keygen -t ed25519 -f "$WORKDIR/obkey" -P ""
166+```
167+
168+Now copy your local SSH key to the server:
169+
170+```bash
171+ssh-copy-id -i "$WORKDIR/obkey.pub" root@$VM_IP
172+```
173+
174+This will ask you for your password again.
175+
176+Now test login with your key instead:
177+
178+```bash
179+ssh -i "$WORKDIR/obkey" root@$VM_IP echo "Access granted"
180+```
181+
182+This should print `Access granted` *without* asking for a password.
183+
184+### Configure the git remote
185+
186+Before the project can be deployed, it needs to be a valid `git` repository.
187+
188+> **Note:** You need `git` installed and configured. You can do that with:
189+>
190+> ```bash
191+> nix-env -i git
192+> git config --global user.name "John Doe"
193+> git config --global user.email johndoe@example.com
194+> ```
195+
196+```bash
197+git init --bare "$WORKDIR/myapp-git-remote"
198+cd "$WORKDIR/myapp"
199+git init
200+git add --all
201+git commit -m "initial commit"
202+git remote add origin "$WORKDIR/myapp-git-remote"
203+git push -u origin master
204+```
205+
206+### Initialize deployment directory
207+
208+With that, we can come back to the Obelisk app and initialize the deployment:
209+
210+```bash
211+cd "$WORKDIR/myapp"
212+ob deploy init --ssh-key "$WORKDIR/obkey" --admin-email a@a.a --hostname $VM_IP --route https://$VM_IP "$WORKDIR/myappdeploy" --disable-https
213+```
214+
215+Then configure the deployment for VirtualBox:
216+
217+```bash
218+echo '{nixosPkgs, ...}: {...}: { imports = [ (nixosPkgs.path + /nixos/modules/virtualisation/virtualbox-image.nix) ]; }' > "$WORKDIR/myappdeploy/module.nix"
219+```
220+
221+## d) Deploy to VirtualBox target (Linux only)
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+
227+```bash
228+cd "$WORKDIR/myappdeploy"
229+ob deploy push -v
230+```
231+
232+Once that is complete, open the webpage with
233+
234+```bash
235+xdg-open http://$VM_IP
236+```
237+
238+If that fails, just get the URL by running
239+
240+```bash
241+echo http://$VM_IP
242+```
243+
244+and copy/paste that URL into your browser navigation input.
245+
246+It should look like this:
247+
248+![](assets/app-deploy-2.png)
249+
250+Congratulations! You have deployed an Obelisk application to a remote server via SSH.
251+
252+## e) Deploy an Android app (Linux only)
253+
254+> **Note:** This section requires that you be running a Linux *host*.
255+
256+Modify `$WORKDIR/myapp/default.nix` to set `config.android_sdk.accept_license = true;` and then update your app.
257+
258+```bash
259+cd "$WORKDIR/myapp"
260+sed -i 's/# config.android_sdk.accept_license = false;/config.android_sdk.accept_license = true;/g' default.nix
261+git add default.nix
262+git commit -m"Accept license"
263+git push
264+```
265+
266+Make sure *USB debugging* is enabled in your Android device ([instructions here](https://developer.android.com/studio/debug/dev-options)) and connect the device using USB. Be sure to confirm any security prompts on the device.
267+
268+Now update your deployment and deploy to Android:
269+
270+```bash
271+cd "$WORKDIR/myappdeploy"
272+ob deploy update
273+ob deploy test android -v
274+```
275+
276+This deployment will ask you to create a password (at least 6 characters long) and then ask you a series of questions. You can pick arbitrary answers. When you are presented with prompt like:
277+
278+```
279+Is CN=a, OU=b, O=c, L=d, ST=e, C=f correct?
280+ [no]:
281+```
282+
283+You can enter `yes` to continue. If the deployment fails, try using different USB ports on your computer and running `ob deploy test android -v` again. The USB cable you use can also make a difference.
284+
285+When connecting your Android device you may be asked to "Allow USB debugging". You need to allow it.
286+![](assets/android-confirm-usb-debugging.jpg)
287+
288+
289+When the deployment is complete opening the app should look something like
290+
291+![](assets/android-app.jpg)
292+
293+Congratulations! You have deployed an Obelisk Android app via USB.
294+
295+## f) Deploy an iOS app (Mac only)
296+
297+> **Note:** This section requires that you be running a macOS *host*.
298+
299+Verify that you can see the device from XCode and you have installed a Provisioning profile that links your Apple Developer Id and the Device identifier. The workflow depends on whether or not you are an independent developer or part of an organization and is out of scope for this manual.
300+
301+![](assets/xcode-devices.png)
302+
303+Find your `Team ID` at the following URL (Apple Developer Membership details): https://developer.apple.com/account/#/membership/
304+
305+It will be something like `5B445B3WY1`. With that, you can start the deployment workflow after plugging in an iPhone or iPad via USB and setting it to trust the computer:
306+
307+```bash
308+cd "$WORKDIR/myappdeploy"
309+ob deploy test ios <TEAM-ID> # Use your Team ID here
310+```
311+
312+![](assets/ios-deploy-keychain.png)
313+
314+![](assets/ios-deploy-example.png)
315+
316+If there are no errors and the last line says `100% Installed Package` you can open the device and look for the Obelisk app:
317+
318+![](assets/ios-obelisk-app-icon.jpg)
319+
320+![](assets/ios-obelisk-app-open.jpg)
321+
322+Congratulations, you have deployed an Obelisk app on an iOS device.
323+
324+You are now ready to create your own multi-platform application using Obelisk!
guides/app-deploy/assets/android-app.jpgnew file

Binary file not shown.

guides/app-deploy/assets/android-confirm-usb-debugging.jpgnew file

Binary file not shown.

guides/app-deploy/assets/app-deploy-2.pngnew file

Binary file not shown.

guides/app-deploy/assets/app-deploy.pngnew file

Binary file not shown.

guides/app-deploy/assets/ios-deploy-example.pngnew file

Binary file not shown.

guides/app-deploy/assets/ios-deploy-keychain.pngnew file

Binary file not shown.

guides/app-deploy/assets/ios-obelisk-app-icon.jpgnew file

Binary file not shown.

guides/app-deploy/assets/ios-obelisk-app-open.jpgnew file

Binary file not shown.

guides/app-deploy/assets/nano-edit-nixos-configuration.pngnew file

Binary file not shown.

guides/app-deploy/assets/virtualbox-appliance-import-loading.pngnew file

Binary file not shown.

guides/app-deploy/assets/virtualbox-appliance-import.pngnew file

Binary file not shown.

guides/app-deploy/assets/virtualbox-dashboard-nixos.pngnew file

Binary file not shown.

guides/app-deploy/assets/virtualbox-image-settings-network.pngnew file

Binary file not shown.

guides/app-deploy/assets/virtualbox-nioxs-after-boot.pngnew file

Binary file not shown.

guides/app-deploy/assets/xcode-devices.pngnew file

Binary file not shown.

haskell-overlays/ghcide.nixnew file+40
@@ -0,0 +1,40 @@
1+self: super:
2+let
3+ pkgs = self.callPackage ({ pkgs }: pkgs) { };
4+ inherit (pkgs.haskell.lib) dontCheck justStaticExecutables;
5+ inherit (pkgs.haskellPackages) callHackageDirect callHackage;
6+
7+in {
8+ ghcide = justStaticExecutables (dontCheck (callHackageDirect {
9+ pkg = "ghcide";
10+ ver = "0.2.0";
11+ sha256 = "199l4qzrghhz6wbfkgqdl4gll4wvgpr190kinzhv88idnn9pxm96";
12+ } rec {
13+ ghc-check = callHackageDirect {
14+ pkg = "ghc-check";
15+ ver = "0.3.0.1";
16+ sha256 = "1dj909m09m24315x51vxvcl28936ahsw4mavbc53danif3wy09ns";
17+ } { };
18+ lsp-test = dontCheck (callHackage "lsp-test" "0.6.1.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" { });
32+ });
33+ shake = dontCheck (callHackage "shake" "0.18.4" { });
34+ hie-bios = dontCheck (callHackageDirect {
35+ pkg = "hie-bios";
36+ ver = "0.5.0";
37+ sha256 = "116nmpva5jmlgc2dgy8cm5wv6cinhzmga1l0432p305074w720r2";
38+ } { });
39+ }));
40+}
haskell-overlays/misc-deps.nixnew file+26
@@ -0,0 +1,26 @@
1+{ hackGet }:
2+
3+# Fix misc upstream packages
4+self: super:
5+
6+let
7+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
8+ haskellLib = pkgs.haskell.lib;
9+in
10+
11+{
12+ regex-base = self.callHackage "regex-base" "0.94.0.0" {};
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" {};
18+
19+ aeson-gadt-th = self.callHackage "aeson-gadt-th" "0.2.4" {};
20+
21+ ghcid = self.callCabal2nix "ghcid" (hackGet ../dep/ghcid) {};
22+ # Exports more internals
23+ snap-core = haskellLib.dontCheck (self.callCabal2nix "snap-core" (hackGet ../dep/snap-core) {});
24+
25+ shelly = self.callHackage "shelly" "1.9.0" {};
26+}
haskell-overlays/obelisk.nixnew file+48
@@ -0,0 +1,48 @@
1+# Add obelisk packages
2+
3+self: super:
4+
5+let
6+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
7+ inherit (pkgs) obeliskCleanSource;
8+ haskellLib = pkgs.haskell.lib;
9+ onLinux = pkg: f: if pkgs.stdenv.isLinux then f pkg else pkg;
10+in
11+
12+{
13+ obelisk-executable-config-inject = pkgs.obeliskExecutableConfig.platforms.web.inject self;
14+
15+ obelisk-asset-manifest = self.callCabal2nix "obelisk-asset-manifest" (obeliskCleanSource ../lib/asset/manifest) {};
16+ obelisk-asset-serve-snap = self.callCabal2nix "obelisk-asset-serve-snap" (obeliskCleanSource ../lib/asset/serve-snap) {};
17+ obelisk-backend = self.callCabal2nix "obelisk-backend" (obeliskCleanSource ../lib/backend) {};
18+ obelisk-cliapp = self.callCabal2nix "obelisk-cliapp" (obeliskCleanSource ../lib/cliapp) {};
19+ obelisk-command = haskellLib.overrideCabal (self.callCabal2nix "obelisk-command" (obeliskCleanSource ../lib/command) {}) {
20+ librarySystemDepends = [
21+ pkgs.jre
22+ pkgs.git
23+ pkgs.nix
24+ pkgs.nix-prefetch-git
25+ pkgs.openssh
26+ pkgs.rsync
27+ pkgs.which
28+ (haskellLib.justStaticExecutables self.ghcid)
29+ ];
30+ };
31+ obelisk-frontend = self.callCabal2nix "obelisk-frontend" (obeliskCleanSource ../lib/frontend) {};
32+ obelisk-run = onLinux (self.callCabal2nix "obelisk-run" (obeliskCleanSource ../lib/run) {}) (pkg:
33+ haskellLib.overrideCabal pkg (drv: { librarySystemDepends = [ pkgs.iproute ]; })
34+ );
35+ obelisk-route = self.callCabal2nix "obelisk-route" (obeliskCleanSource ../lib/route) {};
36+ obelisk-selftest = haskellLib.overrideCabal (self.callCabal2nix "obelisk-selftest" (obeliskCleanSource ../lib/selftest) {}) {
37+ librarySystemDepends = [
38+ pkgs.cabal-install
39+ pkgs.coreutils
40+ pkgs.git
41+ pkgs.nix
42+ pkgs.nix-prefetch-git
43+ pkgs.rsync
44+ ];
45+ };
46+ obelisk-snap-extras = self.callCabal2nix "obelisk-snap-extras" (obeliskCleanSource ../lib/snap-extras) {};
47+ tabulation = self.callCabal2nix "tabulation" (obeliskCleanSource ../lib/tabulation) {};
48+}
haskell-overlays/tighten-ob-exes.nixnew file+32
@@ -0,0 +1,32 @@
1+self: super:
2+
3+let
4+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
5+ haskellLib = pkgs.haskell.lib;
6+
7+ commandRuntimeDeps = with pkgs; [
8+ coreutils
9+ git
10+ nix-prefetch-git
11+ openssh
12+ ];
13+in
14+
15+{
16+ # Dynamic linking with split objects dramatically increases startup time (about
17+ # 0.5 seconds on a decent machine with SSD), so we do `justStaticExecutables`.
18+ obelisk-command = haskellLib.overrideCabal
19+ (haskellLib.generateOptparseApplicativeCompletion "ob"
20+ (haskellLib.justStaticExecutables super.obelisk-command))
21+ (drv: {
22+ buildTools = (drv.buildTools or []) ++ [ pkgs.buildPackages.makeWrapper ];
23+ postFixup = ''
24+ ${drv.postFixup or ""}
25+ # Make `ob` reference its runtime dependencies.
26+ wrapProgram "$out"/bin/ob --prefix PATH : ${pkgs.lib.makeBinPath commandRuntimeDeps}
27+ '';
28+ passthru = { inherit commandRuntimeDeps; };
29+ });
30+
31+ obelisk-selftest = haskellLib.justStaticExecutables super.obelisk-selftest;
32+}
jobsets.nixdeleted−66
@@ -1,66 +0,0 @@
1−{ prs }:
2−
3−let
4− self = import ./. {};
5− pkgs = self.nixpkgs;
6− mkFetchGithub = value: {
7− inherit value;
8− type = "git";
9− emailresponsible = false;
10− };
11−in
12−with pkgs.lib;
13−let
14− defaults = jobs: {
15− inherit (jobs) description;
16− enabled = 1;
17− hidden = false;
18− keepnr = 10;
19− schedulingshares = 100;
20− checkinterval = 120;
21− enableemail = false;
22− emailoverride = "";
23− nixexprinput = "obelisk";
24− nixexprpath = "release.nix";
25− inputs = jobs.inputs // {
26− nixpkgs = {
27− type = "git";
28− value = "https://github.com/NixOS/nixpkgs-channels nixos-unstable";
29− emailresponsible = false;
30− };
31− };
32− };
33− branchJobset = branch: defaults {
34− description = "obelisk-${branch}";
35− inputs = {
36− obelisk = {
37− value = "https://github.com/obsidiansystems/obelisk ${branch}";
38− type = "git";
39− emailresponsible = false;
40− };
41− };
42− };
43− makePr = num: info: {
44− name = "obelisk-pr-${num}";
45− value = defaults {
46− description = "#${num}: ${info.title}";
47− inputs = {
48− obelisk = {
49− #NOTE: This should really use "pull/${num}/merge"; however, GitHub's
50− #status checks only operate on PR heads. This creates a race
51− #condition, which can currently only be solved by requiring PRs to be
52− #up to date before they're merged. See
53− #https://github.com/isaacs/github/issues/1002
54− value = "https://github.com/obsidiansystems/obelisk pull/${num}/head";
55− type = "git";
56− emailresponsible = false;
57− };
58− };
59− };
60− };
61− processedPrs = mapAttrs' makePr (builtins.fromJSON (builtins.readFile prs));
62− jobsetsAttrs = processedPrs //
63− genAttrs ["master"] branchJobset;
64−in {
65− jobsets = pkgs.writeText "spec.json" (builtins.toJSON jobsetsAttrs);
66−}
lib/asset/README.md+17−20
@@ -1,29 +1,26 @@
1−## obelisk-asset
1+# obelisk-asset
22
3−The 'assets.nix' file contains nix expressions that are a mutually
4−recursive set of attributes used to create static asset directories
5−with hashable file encodings. This file should be incorporated within
6−your project's 'default.nix' file. (See ./example/default.nix , line 2)
7−```
8−{assets ? import ./../assets.nix { inherit nixpkgs; }
9−}:
10−```
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)
115
12−The 'mkAssets' and 'mkAssetsWith' functions within 'assets.nix' only
13−need to be passed an encoding('zopfliEncodings', 'gzipEncodings',
14−'noEncodings') and a static directory of your choice as arguments.
6+**Efficiently served, aggressively cached static web resources.**
157
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)
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)
9+
10+```nix
11+{ assets ? import ./../assets.nix { inherit nixpkgs; } }:
1812```
19−myAssets = assets.mkAssets ./static;
13+
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.
15+
16+In this example, `mkAssets` is used on a directory that has a `.png` file inside of it. (See `example/default.nix`, line 11)
17+
18+```nix
19+myAssets = assets.mkAssets ./static;
2020```
2121
22−Once you have successfully incorporated 'assets.nix' into your
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.
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.
23+
2724```bash
2825nix-build -o static.assets -A myAssets
2926```
lib/asset/assets.nix+28−5
@@ -20,7 +20,7 @@ zopfliEncodings = file:
2020 nixpkgs.stdenv.mkDerivation {
2121 name = "encodings";
2222
23− input = file;
23+ input = mkPath file;
2424
2525 builder = builtins.toFile "builder.sh" ''
2626 source "$stdenv/setup"
@@ -46,7 +46,7 @@ gzipEncodings = file:
4646 nixpkgs.stdenv.mkDerivation {
4747 name = "encodings";
4848
49− input = file;
49+ input = mkPath file;
5050
5151 builder = builtins.toFile "builder.sh" ''
5252 source "$stdenv/setup"
@@ -70,7 +70,7 @@ noEncodings = file:
7070 nixpkgs.stdenv.mkDerivation {
7171 name = "encodings";
7272
73− input = file;
73+ input = mkPath file;
7474
7575 builder = builtins.toFile "builder.sh" ''
7676 source "$stdenv/setup"
@@ -203,7 +203,7 @@ hashFile = path:
203203 nixpkgs.nix
204204 ];
205205 preferLocalBuild = true;
206− inherit path;
206+ path = mkPath path;
207207 } ''
208208 nix-hash --flat --base32 --type sha256 "$path" | tr -d '\n' >"$out"
209209 '');
@@ -224,7 +224,30 @@ symlink = path: {
224224 inherit path;
225225};
226226
227−# Given a encoding generation function and a file entry resulting from readDirRecursive in the form { name :: String, value: { path :: String } },
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 } },
228251# build a DirEntry for dirToPath with the various encodings of the asset for dirToPath to build into a final directory tree.
229252mkAsset = encodings: {name, value}:
230253 let nameWithHash = "${hashFile value.path}-${name}";
lib/asset/manifest/obelisk-asset-manifest.cabal+5−2
@@ -17,13 +17,14 @@ library
1717 base
1818 , bytestring
1919 , containers
20+ , deepseq
2021 , directory
2122 , SHA
2223 , filepath
2324 , template-haskell
2425 , text
2526 , transformers
26− , unix
27+ , unix-compat
2728 , vector
2829 exposed-modules:
2930 Obelisk.Asset.Gather
@@ -32,7 +33,9 @@ library
3233 Obelisk.Asset.TH
3334
3435 other-extensions: TemplateHaskell
35− ghc-options: -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs -funbox-strict-fields -O2 -fprof-auto-calls
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
3639
3740executable obelisk-asset-manifest-generate
3841 hs-source-dirs: src-bin
lib/asset/manifest/src-bin/generate.hs−1
@@ -12,6 +12,5 @@ main = do
1212 writeStaticProject paths haskellTarget $ StaticConfig
1313 { _staticConfig_packageName = T.pack packageName
1414 , _staticConfig_moduleName = T.pack moduleName
15− , _staticConfig_rootPath = root
1615 }
1716 copyAndSymlink paths root fileTarget
lib/asset/manifest/src/Obelisk/Asset/Gather.hs+5−2
@@ -1,10 +1,12 @@
11{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE BangPatterns #-}
23-- | Functions for collecting up files to be processed by the asset pipeline
34module Obelisk.Asset.Gather
45 ( gatherHashedPaths
56 , toHashedPath
67 ) where
78
9+import Control.DeepSeq
810import Control.Monad (forM)
911import Data.Bits
1012import qualified Data.ByteString.Lazy as LBS
@@ -33,7 +35,7 @@ gatherHashedPaths root = go ""
3335 let relativePath = subdir </> sub
3436 isFile <- doesFileExist $ root </> relativePath
3537 if isFile
36− then do hashedRelativePath <- toHashedPath root relativePath
38+ then do !hashedRelativePath <- force <$> toHashedPath root relativePath
3739 return $ Map.singleton relativePath hashedRelativePath
3840 else go relativePath
3941
@@ -47,7 +49,8 @@ toHashedPath root relativePath = do
4749 contents <- LBS.readFile path
4850 let hashPrefix = T.unpack $ decodeUtf8 $ LBS.toStrict $ toNixBase32 $ bytestringDigest $ sha256 contents
4951 (dir, filename) = splitFileName relativePath
50− return $ normalise $ dir </> (hashPrefix <> "-" <> filename)
52+ !hashedRelativePath = force $ normalise $ dir </> (hashPrefix <> "-" <> filename)
53+ return hashedRelativePath
5154
5255-- | Convert a ByteString to base 32 in the way that Nix does
5356toNixBase32 :: LBS.ByteString -> LBS.ByteString
lib/asset/manifest/src/Obelisk/Asset/Promoted.hs+1−9
@@ -28,7 +28,6 @@ import qualified Data.Map as Map
2828data StaticConfig = StaticConfig
2929 { _staticConfig_packageName :: Text --TODO: Better type
3030 , _staticConfig_moduleName :: Text --TODO: Better type
31− , _staticConfig_rootPath :: FilePath
3231 }
3332
3433writeStaticProject :: Map FilePath FilePath -> FilePath -> StaticConfig -> IO ()
@@ -41,14 +40,7 @@ writeStaticProject paths target cfg = do
4140 Just (name, parents) -> (name, target </> "src" </> T.unpack (T.intercalate "/" $ reverse parents))
4241 createDirectoryIfMissing True moduleDirPath
4342 modContents <- staticModuleFile modName paths
44− T.writeFile (moduleDirPath </> T.unpack modName' <.> "hs") $ appendRootPath (_staticConfig_rootPath cfg) modContents
45−
46−appendRootPath :: FilePath -> Text -> Text
47−appendRootPath fp txt = T.unlines
48− [ txt
49− , "staticRootPath :: FilePath"
50− , "staticRootPath = \"" <> T.pack fp <> "\""
51− ]
43+ T.writeFile (moduleDirPath </> T.unpack modName' <.> "hs") modContents
5244
5345staticCabalFile :: StaticConfig -> Text
5446staticCabalFile cfg = T.unlines
lib/asset/manifest/src/Obelisk/Asset/Symlink.hs+1−1
@@ -7,7 +7,7 @@ import Data.Map (Map)
77import qualified Data.Map as Map
88import System.Directory
99import System.FilePath.Posix
10−import System.Posix.Files
10+import System.PosixCompat.Files
1111
1212-- | Copy the given hashed files from one location to hashed paths in another
1313-- location, and symlink the unhashed paths to the hashed ones
lib/asset/serve-snap/obelisk-asset-serve-snap.cabal+4−2
@@ -23,10 +23,12 @@ library
2323 , obelisk-snap-extras
2424 , text
2525 , transformers
26− , unix
26+ , unix-compat
2727 exposed-modules:
2828 Obelisk.Asset.Accept
2929 Obelisk.Asset.Serve.Snap
3030
3131 other-extensions: TemplateHaskell
32− ghc-options: -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs -funbox-strict-fields -O2 -fprof-auto-calls
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
lib/asset/serve-snap/src/Obelisk/Asset/Accept.hs+6−6
@@ -136,16 +136,16 @@ qvalue = do
136136 skipMany lws
137137 q0 <|> q1
138138 where q0 = do
139− char '0'
139+ _ <- char '0'
140140 decimals <- option [] $ do
141− char '.'
141+ _ <- char '.'
142142 starRule (Just 0) (Just numAllowedDigits) digit
143143 return $ QValue $ MkFixed $ fromIntegral $ (read ('0' : decimals) :: Int) * 10 ^ (numAllowedDigits - length decimals)
144144 q1 = do
145− char '1'
145+ _ <- char '1'
146146 option () $ do
147− char '.'
148− starRule (Just 0) (Just numAllowedDigits) $ char '0'
147+ _ <- char '.'
148+ _ <- starRule (Just 0) (Just numAllowedDigits) $ char '0'
149149 return ()
150150 return $ QValue 1
151151 numAllowedDigits :: Int
@@ -232,7 +232,7 @@ hashRule minNum maxNum element = do
232232lws :: Parser ()
233233lws = do
234234 option () $ cr >> lf
235− starRule (Just 1) Nothing $ sp <|> ht
235+ _ <- starRule (Just 1) Nothing $ sp <|> ht
236236 return ()
237237
238238-- | See http://www.w3.org/Protocols/rfc2616/rfc2616-sec2.html#sec2.2
lib/asset/serve-snap/src/Obelisk/Asset/Serve/Snap.hs+22−11
@@ -12,13 +12,15 @@ import Obelisk.Asset.Accept (Encoding (..), acceptEncodingBody, chooseEncoding,
1212import Obelisk.Snap.Extras
1313
1414import Snap
15− (MonadSnap, getHeader, getsRequest, modifyResponse, pass, redirect, sendFile, setContentLength, setContentType, setHeader, setResponseCode)
15+ (MonadSnap, getHeader, getRequest, getsRequest, modifyResponse, pass, redirect, sendFile, setContentLength, setContentType, setHeader, setResponseCode)
1616import Snap.Util.FileServe (defaultMimeTypes, fileType, getSafePath, serveFile)
17+import Snap.Internal.Util.FileServe (checkRangeReq)
1718
1819import Control.Applicative ((<|>))
1920import Control.Exception (handleJust, try, throwIO)
20−import Control.Monad (forM, liftM)
21+import Control.Monad (forM, liftM, unless)
2122import Control.Monad.IO.Class (liftIO)
23+import Control.Monad.Fail (MonadFail)
2224import Data.Attoparsec.ByteString (parseOnly, endOfInput)
2325import Data.ByteString (ByteString)
2426import qualified Data.ByteString as BS
@@ -29,7 +31,7 @@ import Data.Text.Encoding (decodeUtf8, encodeUtf8)
2931import System.Directory (getDirectoryContents)
3032import System.FilePath ((</>), splitFileName, takeDirectory)
3133import System.IO.Error (isDoesNotExistError)
32−import System.Posix (getFileStatus, fileSize)
34+import System.PosixCompat.Files (getFileStatus, fileSize)
3335
3436-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
3537--
@@ -38,7 +40,7 @@ import System.Posix (getFileStatus, fileSize)
3840-- current version of the asset
3941-- (e.g. @0rx5yvkkgkig2pcqf4ngi1l7vh89qqajdzc6aiayaibyhvj0d853-test.png@). Hashed
4042-- asset names will be sent with permanent caching headers.
41−serveAssets :: MonadSnap m => FilePath -> FilePath -> m ()
43+serveAssets :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> m ()
4244serveAssets = serveAssets' True
4345
4446-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
@@ -47,15 +49,15 @@ serveAssets = serveAssets' True
4749-- browser for the logical asset name (e.g. @test.png@) but instead the current
4850-- version of the asset with to point the browser at the unique filename for the
4951-- current version of the asset.
50−serveAssetsInPlace :: MonadSnap m => FilePath -> FilePath -> m ()
52+serveAssetsInPlace :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> m ()
5153serveAssetsInPlace = serveAssets' False
5254
5355-- | Like 'serveAssets', but only serves a single specified asset
54−serveAsset :: MonadSnap m => FilePath -> FilePath -> FilePath -> m ()
56+serveAsset :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> FilePath -> m ()
5557serveAsset = serveAsset' True
5658
5759-- | Like 'serveAssetsInPlace', but only serves a single specified asset
58−serveAssetInPlace :: MonadSnap m => FilePath -> FilePath -> FilePath -> m ()
60+serveAssetInPlace :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> FilePath -> m ()
5961serveAssetInPlace = serveAsset' False
6062
6163-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
@@ -63,13 +65,13 @@ serveAssetInPlace = serveAsset' False
6365-- For assets generated from @assets.nix@, the @Bool@ argument @doRedirect@ controls whether redirects will be sent to the browser if a request is made for
6466-- an unhashed asset name, e.g. @test.png@. For @True@, a redirect will be sent, yielding more round trips to the server but better caching behavior if the
6567-- asset doesn't change often. Conversely for @False@, the asset will be served "in place" but made uncacheable.
66−serveAssets' :: MonadSnap m => Bool -> FilePath -> FilePath -> m ()
68+serveAssets' :: (MonadSnap m, MonadFail m) => Bool -> FilePath -> FilePath -> m ()
6769serveAssets' doRedirect base fallback = do
6870 pRaw <- getSafePath
6971 serveAsset' doRedirect base fallback $ if "/" `isSuffixOf` pRaw || pRaw == "" then pRaw <> "index.html" else pRaw
7072
7173-- | Serve a single static asset from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
72−serveAsset' :: MonadSnap m => Bool -> FilePath -> FilePath -> FilePath -> m ()
74+serveAsset' :: (MonadFail m, MonadSnap m) => Bool -> FilePath -> FilePath -> FilePath -> m ()
7375serveAsset' doRedirect base fallback p = do
7476 assetType <- liftIO $ try $ BS.readFile $ base </> p </> "type"
7577 case assetType of
@@ -93,8 +95,17 @@ serveAsset' doRedirect base fallback p = do
9395 let finalFilename = base </> p </> "encodings" </> T.unpack (decodeUtf8 e)
9496 stat <- liftIO $ getFileStatus finalFilename
9597 modifyResponse $ setHeader "Last-Modified" "Thu, 1 Jan 1970 00:00:00 GMT"
96− modifyResponse $ setResponseCode 200 . setContentLength (fromIntegral $ fileSize stat) . setContentType (fileType defaultMimeTypes p)
97− sendFile finalFilename
98+ . setHeader "Accept-Ranges" "bytes"
99+ . setContentType (fileType defaultMimeTypes p)
100+ let size = fromIntegral $ fileSize stat
101+ req <- getRequest
102+ -- Despite the name, this function actually does all of the work for
103+ -- responding to range requests. We only need to handle *none* range
104+ -- requests ourselves.
105+ wasRange <- checkRangeReq req finalFilename size
106+ unless wasRange $ do
107+ modifyResponse $ setResponseCode 200 . setContentLength size
108+ sendFile finalFilename
98109 Just _ -> cachePermanently >> modifyResponse (setResponseCode 304)
99110 Right "redirect" -> do
100111 mtarget <- liftIO $ getAssetTarget $ base </> p
lib/backend/obelisk-backend.cabal+5−2
@@ -8,6 +8,8 @@ library
88 build-depends: base,
99 bytestring,
1010 categories,
11+ containers,
12+ cookie,
1113 data-default,
1214 dependent-sum,
1315 dependent-sum-template,
@@ -15,13 +17,14 @@ library
1517 mtl,
1618 obelisk-asset-serve-snap,
1719 obelisk-executable-config-inject,
20+ obelisk-executable-config-lookup,
1821 obelisk-frontend,
1922 obelisk-route,
2023 obelisk-snap-extras,
21− reflex-dom,
24+ reflex-dom-core,
2225 snap,
2326 snap-server,
2427 text,
2528 universe
2629 exposed-modules: Obelisk.Backend
27− ghc-options: -Wall
30+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
lib/backend/src/Obelisk/Backend.hs+181−58
@@ -1,3 +1,5 @@
1+{-# LANGUAGE DeriveFunctor #-}
2+{-# LANGUAGE DeriveGeneric #-}
13{-# LANGUAGE FlexibleContexts #-}
24{-# LANGUAGE FlexibleInstances #-}
35{-# LANGUAGE GADTs #-}
@@ -6,62 +8,112 @@
68{-# LANGUAGE MultiParamTypeClasses #-}
79{-# LANGUAGE OverloadedStrings #-}
810{-# LANGUAGE ScopedTypeVariables #-}
9−{-# LANGUAGE TemplateHaskell #-}
11+{-# OPTIONS_GHC -fno-warn-orphans #-}
1012module Obelisk.Backend
1113 ( Backend (..)
14+ , BackendConfig (..)
15+ , defaultBackendConfig
16+ , StaticAssets (..)
17+ , defaultStaticAssets
18+ -- * Running a backend
19+ , runBackend
20+ , runBackendWith
21+ -- * Configuration of backend
22+ , GhcjsWidgets(..)
23+ , defaultGhcjsWidgets
24+ -- * all.js script loading functions
25+ , deferredGhcjsScript
26+ , delayedGhcjsScript
27+ -- * all.js preload functions
28+ , preloadGhcjs
29+ , renderAllJsPath
1230 -- * Re-exports
1331 , Default (def)
1432 , getPageName
1533 , getRouteWith
1634 , runSnapWithCommandLineArgs
35+ , runSnapWithConfig
1736 , serveDefaultObeliskApp
1837 , prettifyOutput
19− , runBackend
2038 , staticRenderContentType
21− , mkRouteToUrl
39+ , getPublicConfigs
2240 ) where
2341
24−import Prelude hiding (id, (.))
25−import Control.Category
2642import Control.Monad
2743import Control.Monad.Except
28−import Control.Categorical.Bifunctor
44+import Control.Monad.Fail (MonadFail)
2945import Data.ByteString (ByteString)
3046import qualified Data.ByteString.Char8 as BSC8
3147import Data.Default (Default (..))
3248import Data.Dependent.Sum
33−import Data.Functor.Sum
3449import Data.Functor.Identity
50+import Data.Map (Map)
51+import qualified Data.Map as Map
3552import Data.Monoid ((<>))
3653import Data.Text (Text)
3754import qualified Data.Text as T
38−import Data.Text.Encoding
55+import GHC.Generics (Generic)
3956import Obelisk.Asset.Serve.Snap (serveAsset)
40−import Obelisk.ExecutableConfig.Inject (injectExecutableConfigs)
57+import qualified Obelisk.ExecutableConfig.Lookup as Lookup
4158import Obelisk.Frontend
4259import Obelisk.Route
4360import Obelisk.Snap.Extras (doNotCache, serveFileIfExistsAs)
44−import Reflex.Dom
61+import Reflex.Dom.Core
4562import Snap (MonadSnap, Snap, commandLineConfig, defaultConfig, getsRequest, httpServe, modifyResponse
46− , rqPathInfo, rqQueryString, setContentType, writeBS, writeText)
63+ , rqPathInfo, rqQueryString, setContentType, writeBS, writeText
64+ , rqCookies, Cookie(..) , setHeader)
4765import Snap.Internal.Http.Server.Config (Config (accessLog, errorLog), ConfigLog (ConfigIoLog))
4866import System.IO (BufferMode (..), hSetBuffering, stderr, stdout)
4967
5068data Backend backendRoute frontendRoute = Backend
51− { _backend_routeEncoder :: Encoder (Either Text) Identity (R (Sum backendRoute (ObeliskRoute frontendRoute))) PageName
69+ { _backend_routeEncoder :: Encoder (Either Text) Identity (R (FullRoute backendRoute frontendRoute)) PageName
5270 , _backend_run :: ((R backendRoute -> Snap ()) -> IO ()) -> IO ()
53− }
71+ } deriving (Generic)
72+
73+data BackendConfig frontendRoute = BackendConfig
74+ { _backendConfig_runSnap :: !(Snap () -> IO ()) -- ^ Function to run the snap server
75+ , _backendConfig_staticAssets :: !StaticAssets -- ^ Static assets
76+ , _backendConfig_ghcjsWidgets :: !(GhcjsWidgets (Text -> FrontendWidgetT (R frontendRoute) ()))
77+ -- ^ Given the URL of all.js, return the widgets which are responsible for
78+ -- loading the script.
79+ } deriving (Generic)
5480
5581-- | The static assets provided must contain a compiled GHCJS app that corresponds exactly to the Frontend provided
5682data GhcjsApp route = GhcjsApp
5783 { _ghcjsApp_compiled :: !StaticAssets
5884 , _ghcjsApp_value :: !(Frontend route)
85+ } deriving (Generic)
86+
87+-- | Widgets used to load all.js on the frontend
88+data GhcjsWidgets a = GhcjsWidgets
89+ { _ghcjsWidgets_preload :: a
90+ -- ^ A preload widget, placed in the document head
91+ , _ghcjsWidgets_script :: a
92+ -- ^ A script widget, placed in the document body
93+ } deriving (Functor, Generic)
94+
95+
96+-- | Given the URL of all.js, return the widgets which are responsible for
97+-- loading the script. Defaults to 'preloadGhcjs' and 'deferredGhcjsScript'.
98+defaultGhcjsWidgets :: GhcjsWidgets (Text -> FrontendWidgetT r ())
99+defaultGhcjsWidgets = GhcjsWidgets
100+ { _ghcjsWidgets_preload = preloadGhcjs
101+ , _ghcjsWidgets_script = deferredGhcjsScript
59102 }
60103
61104-- | Serve a frontend, which must be the same frontend that Obelisk has built and placed in the default location
62105--TODO: The frontend should be provided together with the asset paths so that this isn't so easily breakable; that will probably make this function obsolete
63−serveDefaultObeliskApp :: MonadSnap m => (R appRoute -> Text) -> ([Text] -> m ()) -> Frontend (R appRoute) -> R (ObeliskRoute appRoute) -> m ()
64−serveDefaultObeliskApp urlEnc serveStaticAsset frontend = serveObeliskApp urlEnc serveStaticAsset frontendApp
106+serveDefaultObeliskApp
107+ :: (MonadSnap m, HasCookies m, MonadFail m)
108+ => (R appRoute -> Text)
109+ -> GhcjsWidgets (FrontendWidgetT (R appRoute) ())
110+ -> ([Text] -> m ())
111+ -> Frontend (R appRoute)
112+ -> Map Text ByteString
113+ -> R (ObeliskRoute appRoute)
114+ -> m ()
115+serveDefaultObeliskApp urlEnc ghcjsWidgets serveStaticAsset frontend =
116+ serveObeliskApp urlEnc ghcjsWidgets serveStaticAsset frontendApp
65117 where frontendApp = GhcjsApp
66118 { _ghcjsApp_compiled = defaultFrontendGhcjsAssets
67119 , _ghcjsApp_value = frontend
@@ -86,45 +138,56 @@ defaultFrontendGhcjsAssets = StaticAssets
86138 , _staticAssets_unprocessed = "frontend.jsexe"
87139 }
88140
89−runSnapWithCommandLineArgs :: Snap () -> IO ()
90−runSnapWithCommandLineArgs a = do
91− -- Get the web server configuration from the command line
92− cmdLineConf <- commandLineConfig defaultConfig
93− let httpConf = cmdLineConf
141+runSnapWithConfig :: MonadIO m => Config Snap a -> Snap () -> m ()
142+runSnapWithConfig conf a = do
143+ let httpConf = conf
94144 { accessLog = Just $ ConfigIoLog BSC8.putStrLn
95145 , errorLog = Just $ ConfigIoLog BSC8.putStrLn
96146 }
97147 -- Start the web server
98− httpServe httpConf a
148+ liftIO $ httpServe httpConf a
149+
150+-- Get the web server configuration from the command line
151+runSnapWithCommandLineArgs :: MonadIO m => Snap () -> m ()
152+runSnapWithCommandLineArgs s = liftIO (commandLineConfig defaultConfig) >>= \c ->
153+ runSnapWithConfig c s
99154
100155getPageName :: (MonadSnap m) => m PageName
101156getPageName = do
102157 p <- getsRequest rqPathInfo
103158 q <- getsRequest rqQueryString
104− let pageNameEncoder' :: Encoder Identity Identity PageName (String, String)
105− pageNameEncoder' = bimap
106− (unpackTextEncoder . pathSegmentsTextEncoder . listToNonEmptyEncoder)
107− (unpackTextEncoder . queryParametersTextEncoder . toListMapEncoder)
108− return $ decode pageNameEncoder' (T.unpack (decodeUtf8 p), T.unpack (decodeUtf8 q))
159+ return $ byteStringsToPageName p q
109160
110161getRouteWith :: (MonadSnap m) => Encoder Identity parse route PageName -> m (parse route)
111162getRouteWith e = do
112163 pageName <- getPageName
113164 return $ tryDecode e pageName
114165
115−serveObeliskApp :: MonadSnap m => (R appRoute -> Text) -> ([Text] -> m ()) -> GhcjsApp (R appRoute) -> R (ObeliskRoute appRoute) -> m ()
116−serveObeliskApp urlEnc serveStaticAsset frontendApp = \case
117− ObeliskRoute_App appRouteComponent :=> Identity appRouteRest -> serveGhcjsApp urlEnc frontendApp $ GhcjsAppRoute_App appRouteComponent :/ appRouteRest
166+renderAllJsPath :: Encoder Identity Identity (R (FullRoute a b)) PageName -> Text
167+renderAllJsPath validFullEncoder =
168+ renderObeliskRoute validFullEncoder $ FullRoute_Frontend (ObeliskRoute_Resource ResourceRoute_Ghcjs) :/ ["all.js"]
169+
170+serveObeliskApp
171+ :: (MonadSnap m, HasCookies m, MonadFail m)
172+ => (R appRoute -> Text)
173+ -> GhcjsWidgets (FrontendWidgetT (R appRoute) ())
174+ -> ([Text] -> m ())
175+ -> GhcjsApp (R appRoute)
176+ -> Map Text ByteString
177+ -> R (ObeliskRoute appRoute)
178+ -> m ()
179+serveObeliskApp urlEnc ghcjsWidgets serveStaticAsset frontendApp config = \case
180+ ObeliskRoute_App appRouteComponent :=> Identity appRouteRest -> serveGhcjsApp urlEnc ghcjsWidgets frontendApp config $ GhcjsAppRoute_App appRouteComponent :/ appRouteRest
118181 ObeliskRoute_Resource resComponent :=> Identity resRest -> case resComponent :=> Identity resRest of
119182 ResourceRoute_Static :=> Identity pathSegments -> serveStaticAsset pathSegments
120− ResourceRoute_Ghcjs :=> Identity pathSegments -> serveGhcjsApp urlEnc frontendApp $ GhcjsAppRoute_Resource :/ pathSegments
183+ ResourceRoute_Ghcjs :=> Identity pathSegments -> serveGhcjsApp urlEnc ghcjsWidgets frontendApp config $ GhcjsAppRoute_Resource :/ pathSegments
121184 ResourceRoute_JSaddleWarp :=> Identity _ -> do
122185 let msg = "Error: Obelisk.Backend received jsaddle request"
123186 liftIO $ putStrLn $ T.unpack msg
124187 writeText msg
125188 ResourceRoute_Version :=> Identity () -> doNotCache >> serveFileIfExistsAs "text/plain" "version"
126189
127−serveStaticAssets :: MonadSnap m => StaticAssets -> [Text] -> m ()
190+serveStaticAssets :: (MonadSnap m, MonadFail m) => StaticAssets -> [Text] -> m ()
128191serveStaticAssets assets pathSegments = serveAsset (_staticAssets_processed assets) (_staticAssets_unprocessed assets) $ T.unpack $ T.intercalate "/" pathSegments
129192
130193data StaticAssets = StaticAssets
@@ -141,35 +204,95 @@ staticRenderContentType :: ByteString
141204staticRenderContentType = "text/html; charset=utf-8"
142205
143206--TODO: Don't assume we're being served at "/"
144−serveGhcjsApp :: MonadSnap m => (R appRouteComponent -> Text) -> GhcjsApp (R appRouteComponent) -> R (GhcjsAppRoute appRouteComponent) -> m ()
145−serveGhcjsApp urlEnc app = \case
207+serveGhcjsApp
208+ :: (MonadSnap m, HasCookies m, MonadFail m)
209+ => (R appRouteComponent -> Text)
210+ -> GhcjsWidgets (FrontendWidgetT (R appRouteComponent) ())
211+ -> GhcjsApp (R appRouteComponent)
212+ -> Map Text ByteString
213+ -> R (GhcjsAppRoute appRouteComponent)
214+ -> m ()
215+serveGhcjsApp urlEnc ghcjsWidgets app config = \case
146216 GhcjsAppRoute_App appRouteComponent :=> Identity appRouteRest -> do
147217 modifyResponse $ setContentType staticRenderContentType
148− writeBS <=< liftIO $ renderGhcjsFrontend urlEnc (appRouteComponent :/ appRouteRest) $ _ghcjsApp_value app
218+ modifyResponse $ setHeader "Cache-Control" "no-store private"
219+ writeBS <=< renderGhcjsFrontend urlEnc ghcjsWidgets (appRouteComponent :/ appRouteRest) config $ _ghcjsApp_value app
149220 GhcjsAppRoute_Resource :=> Identity pathSegments -> serveStaticAssets (_ghcjsApp_compiled app) pathSegments
150221
151−runBackend :: Backend fullRoute frontendRoute -> Frontend (R frontendRoute) -> IO ()
152−runBackend backend frontend = case checkEncoder $ _backend_routeEncoder backend of
222+-- | Default obelisk backend configuration.
223+defaultBackendConfig :: BackendConfig frontendRoute
224+defaultBackendConfig = BackendConfig runSnapWithCommandLineArgs defaultStaticAssets defaultGhcjsWidgets
225+
226+-- | Run an obelisk backend with the default configuration.
227+runBackend :: Backend backendRoute frontendRoute -> Frontend (R frontendRoute) -> IO ()
228+runBackend = runBackendWith defaultBackendConfig
229+
230+-- | Run an obelisk backend with the given configuration.
231+runBackendWith
232+ :: BackendConfig frontendRoute
233+ -> Backend backendRoute frontendRoute
234+ -> Frontend (R frontendRoute)
235+ -> IO ()
236+runBackendWith (BackendConfig runSnap staticAssets ghcjsWidgets) backend frontend = case checkEncoder $ _backend_routeEncoder backend of
153237 Left e -> fail $ "backend error:\n" <> T.unpack e
154− Right validFullEncoder -> _backend_run backend $ \serveRoute -> do
155− runSnapWithCommandLineArgs $ do
156− getRouteWith validFullEncoder >>= \case
157− Identity r -> case r of
158− InL backendRoute :=> Identity a -> serveRoute $ backendRoute :/ a
159− InR obeliskRoute :=> Identity a ->
160− serveDefaultObeliskApp (mkRouteToUrl validFullEncoder) (serveStaticAssets defaultStaticAssets) frontend $ obeliskRoute :/ a
161−
162−mkRouteToUrl :: Encoder Identity parse (R (Sum f (ObeliskRoute r))) PageName -> R r -> Text
163−mkRouteToUrl validFullEncoder =
164− let pageNameEncoder' :: Encoder Identity (Either Text) PageName PathQuery = pageNameEncoder
165− in \(k :/ v) -> T.pack . uncurry (<>) . encode pageNameEncoder' . encode validFullEncoder $ (InR $ ObeliskRoute_App k) :/ v
166−
167−
168−renderGhcjsFrontend :: MonadIO m => (route -> Text) -> route -> Frontend route -> m ByteString
169−renderGhcjsFrontend urlEnc route f = do
170− let baseTag = elAttr "base" ("href" =: "/") blank --TODO: Figure out the base URL from the routes
171− ghcjsPreload = elAttr "link" ("rel" =: "preload" <> "as" =: "script" <> "href" =: "ghcjs/all.js") blank
172− ghcjsScript = elAttr "script" ("language" =: "javascript" <> "src" =: "ghcjs/all.js" <> "defer" =: "defer") blank
173− liftIO $ renderFrontendHtml urlEnc route
174− (_frontend_head f >> injectExecutableConfigs >> baseTag >> ghcjsPreload)
175− (_frontend_body f >> ghcjsScript)
238+ Right validFullEncoder -> do
239+ publicConfigs <- getPublicConfigs
240+ _backend_run backend $ \serveRoute ->
241+ runSnap $
242+ getRouteWith validFullEncoder >>= \case
243+ Identity r -> case r of
244+ FullRoute_Backend backendRoute :/ a -> serveRoute $ backendRoute :/ a
245+ FullRoute_Frontend obeliskRoute :/ a ->
246+ serveDefaultObeliskApp routeToUrl (($ allJsUrl) <$> ghcjsWidgets) (serveStaticAssets staticAssets) frontend publicConfigs $
247+ obeliskRoute :/ a
248+ where
249+ routeToUrl (k :/ v) = renderObeliskRoute validFullEncoder $ FullRoute_Frontend (ObeliskRoute_App k) :/ v
250+ allJsUrl = renderAllJsPath validFullEncoder
251+
252+renderGhcjsFrontend
253+ :: (MonadSnap m, HasCookies m)
254+ => (route -> Text)
255+ -> GhcjsWidgets (FrontendWidgetT route ())
256+ -> route
257+ -> Map Text ByteString
258+ -> Frontend route
259+ -> m ByteString
260+renderGhcjsFrontend urlEnc ghcjsWidgets route configs f = do
261+ cookies <- askCookies
262+ renderFrontendHtml configs cookies urlEnc route f (_ghcjsWidgets_preload ghcjsWidgets) (_ghcjsWidgets_script ghcjsWidgets)
263+
264+-- | Preload all.js in a link tag.
265+-- This is the default preload method.
266+preloadGhcjs :: Text -> FrontendWidgetT r ()
267+preloadGhcjs allJsUrl = elAttr "link" ("rel" =: "preload" <> "as" =: "script" <> "href" =: allJsUrl) blank
268+
269+-- | Load the script from the given URL in a deferred script tag.
270+-- This is the default method.
271+deferredGhcjsScript :: Text -> FrontendWidgetT r ()
272+deferredGhcjsScript allJsUrl = elAttr "script" ("type" =: "text/javascript" <> "src" =: allJsUrl <> "defer" =: "defer") blank
273+
274+-- | An all.js script which is loaded after waiting for some time to pass. This
275+-- is useful to ensure any CSS animations on the page can play smoothly before
276+-- blocking the UI thread by running all.js.
277+delayedGhcjsScript
278+ :: Int -- ^ The number of milliseconds to delay loading by
279+ -> Text -- ^ URL to GHCJS app JavaScript
280+ -> FrontendWidgetT r ()
281+delayedGhcjsScript n allJsUrl = elAttr "script" ("type" =: "text/javascript") $ text $ T.unlines
282+ [ "setTimeout(function() {"
283+ , " var all_js_script = document.createElement('script');"
284+ , " all_js_script.type = 'text/javascript';"
285+ , " all_js_script.src = '" <> allJsUrl <> "';"
286+ , " document.body.appendChild(all_js_script);"
287+ , "}, " <> T.pack (show n) <> ");"
288+ ]
289+
290+instance HasCookies Snap where
291+ askCookies = map (\c -> (cookieName c, cookieValue c)) <$> getsRequest rqCookies
292+
293+-- | Get configs from the canonical "public" locations (i.e., locations that obelisk expects to make available
294+-- to frontend applications, and hence visible to end users).
295+getPublicConfigs :: IO (Map Text ByteString)
296+getPublicConfigs = Map.filterWithKey (\k _ -> isMemberOf k ["common", "frontend"]) <$> Lookup.getConfigs
297+ where
298+ isMemberOf k = any (`T.isPrefixOf` k)
lib/cliapp/obelisk-cliapp.cabal+7−3
@@ -7,9 +7,11 @@ cabal-version: >=1.2
77library
88 hs-source-dirs: src
99 build-depends:
10− ansi-terminal
10+ aeson
11+ , ansi-terminal
1112 , base
1213 , bytestring
14+ , containers
1315 , exceptions
1416 , io-streams
1517 , lens
@@ -17,17 +19,19 @@ library
1719 , monad-loops
1820 , mtl
1921 , process
22+ , shell-escape
2023 , terminal-size
2124 , text
2225 , time
2326 , transformers
27+ , utf8-string
2428 exposed-modules:
2529 Obelisk.CliApp
26− Obelisk.CliApp.Demo
2730 other-modules:
2831 Obelisk.CliApp.Logging
2932 Obelisk.CliApp.Process
3033 Obelisk.CliApp.Spinner
3134 Obelisk.CliApp.TerminalString
35+ Obelisk.CliApp.Theme
3236 Obelisk.CliApp.Types
33− ghc-options: -Wall -fobject-code
37+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
lib/cliapp/src/Obelisk/CliApp.hs+18−6
@@ -33,16 +33,28 @@ module Obelisk.CliApp
3333 , Severity (..)
3434
3535 -- .Process
36− , ProcessFailure (..)
3736 , AsProcessFailure (..)
38− , readProcessAndLogStderr
39− , readProcessAndLogOutput
40− , readCreateProcessWithExitCode
37+ , ProcessFailure (..)
38+ , ProcessSpec (..)
39+ , callCommand
40+ , callProcess
4141 , callProcessAndLogOutput
42+ , createProcess
4243 , createProcess_
43− , callProcess
44− , callCommand
44+ , exitCodeToException
45+ , overCreateProcess
46+ , proc
47+ , readCreateProcessWithExitCode
48+ , readProcessAndLogOutput
49+ , readProcessAndLogStderr
50+ , readProcessJSONAndLogStderr
4551 , reconstructCommand
52+ , runProcess_
53+ , setCwd
54+ , setDelegateCtlc
55+ , setEnvOverride
56+ , shell
57+ , waitForProcess
4658 ) where
4759
4860import Control.Monad.Log (Severity (..))
lib/cliapp/src/Obelisk/CliApp/Demo.hsdeleted−52
@@ -1,52 +0,0 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−{-# LANGUAGE ScopedTypeVariables #-}
4−module Obelisk.CliApp.Demo where
5−
6−import Control.Concurrent (threadDelay)
7−import Control.Monad.IO.Class
8−import Data.Semigroup ((<>))
9−import qualified Data.Text as T
10−import System.Process (proc)
11−
12−import Control.Monad.Catch (MonadMask)
13−
14−import Obelisk.CliApp
15−
16−cliDemo
17− :: ( MonadIO m, MonadMask m
18− , CliLog m, HasCliConfig e m, CliThrow e m, AsProcessFailure e, AsUnstructuredError e)
19− => m ()
20−cliDemo = withSpinner "CLI Demo" $ do
21− putLog Notice "This demo will showcase the CLI library functionality"
22− _ <- withSpinner' "Searching long for something" (Just $ \c -> "Discovered " <> T.pack (show c) <> " objects") $ do
23− delay
24− withSpinner "Nested task" $ do
25− delay
26− putLog Notice "In nested task"
27− -- This is a 'no trail' spinner that won't leave a trail (even its sub spinners)
28− withSpinnerNoTrail "In between, doing something temporary" $ do
29− withSpinner "Runnning something deep inside" $ do
30− delay
31− putLog Notice "You can still log from inside no-trail spinners"
32− delay
33− delay
34− putLog Error "Top nested task finished"
35− delay
36− putLog Error "Some user error while spinning"
37− delay
38− putLog Notice "This is some info mesage"
39− putLog Warning "And now a warning as well"
40− delay
41− return (42 :: Integer)
42− putLog Notice "Now we start a 2nd spinner, run a couple of process, the last of which fails:"
43− withSpinner "Looking around" $ do
44− delay
45− output <- readProcessAndLogStderr Notice $ proc "ls" ["-l", "/"]
46− putLog Notice $ "Output was: " <> output
47− delay
48− callProcessAndLogOutput (Notice, Error) $ proc "ls" ["-l", "/does-not-exist"]
49− delay
50− failWith "Something dangerous happened"
51− where
52− delay = liftIO $ threadDelay 1000000
lib/cliapp/src/Obelisk/CliApp/Logging.hs+37−12
@@ -43,13 +43,15 @@ import Data.Semigroup ((<>))
4343import Data.Text (Text)
4444import qualified Data.Text as T
4545import qualified Data.Text.IO as T
46+import GHC.IO.Encoding.Types
4647import System.Console.ANSI (Color (Red, Yellow), ColorIntensity (Vivid),
4748 ConsoleIntensity (FaintIntensity), ConsoleLayer (Foreground),
4849 SGR (SetColor, SetConsoleIntensity), clearLine)
4950import System.Exit (ExitCode (..))
50−import System.IO (BufferMode (NoBuffering), hFlush, hReady, hSetBuffering, stderr, stdin, stdout)
51+import System.IO
5152
5253import qualified Obelisk.CliApp.TerminalString as TS
54+import Obelisk.CliApp.Theme
5355import Obelisk.CliApp.Types
5456
5557newCliConfig
@@ -63,7 +65,11 @@ newCliConfig sev noColor noSpinner errorLogExitCode = do
6365 lock <- newMVar False
6466 tipDisplayed <- newIORef False
6567 stack <- newIORef ([], [])
66− return $ CliConfig level noColor noSpinner lock tipDisplayed stack errorLogExitCode
68+ textEncoding <- hGetEncoding stdout
69+ let theme = if maybe False supportsUnicode textEncoding
70+ then unicodeTheme
71+ else noUnicodeTheme
72+ return $ CliConfig level noColor noSpinner lock tipDisplayed stack errorLogExitCode theme
6773
6874runCli :: MonadIO m => CliConfig e -> CliT e m a -> m a
6975runCli c =
@@ -126,7 +132,7 @@ handleLog' noColor output = do
126132 hFlush stdout
127133 Output_Overwrite ts -> liftIO $ do
128134 width <- TS.getTerminalWidth
129− T.putStr $ "\r" <> (TS.render (not noColor) width ts)
135+ T.putStr $ "\r" <> TS.render (not noColor) width ts
130136 hFlush stdout
131137 Output_ClearLine -> liftIO $ do
132138 -- Go to the first column and clear the whole line
@@ -154,7 +160,7 @@ failWith :: (CliThrow e m, AsUnstructuredError e) => Text -> m a
154160failWith = throwError . review asUnstructuredError
155161
156162errorToWarning
157− :: (HasCliConfig e m, CliThrow e m, CliLog m)
163+ :: (HasCliConfig e m, CliLog m)
158164 => e -> m ()
159165errorToWarning e = do
160166 c <- getCliConfig
@@ -171,15 +177,17 @@ withExitFailMessage msg f = f `catch` \(e :: ExitCode) -> do
171177 throwM e
172178
173179-- | Write log to stdout, with colors (unless `noColor`)
174−writeLog :: (MonadIO m, MonadMask m) => Bool -> Bool -> WithSeverity Text -> m ()
175−writeLog withNewLine noColor (WithSeverity severity s)
176− | noColor && severity <= Warning = liftIO $ putFn $ T.pack (show severity) <> ": " <> s
177− | not noColor && severity <= Error = TS.putStrWithSGR errorColors h withNewLine s
178− | not noColor && severity <= Warning = TS.putStrWithSGR warningColors h withNewLine s
179− | not noColor && severity >= Debug = TS.putStrWithSGR debugColors h withNewLine s
180− | otherwise = liftIO $ putFn s
180+writeLog :: (MonadIO m) => Bool -> Bool -> WithSeverity Text -> m ()
181+writeLog withNewLine noColor (WithSeverity severity s) = if T.null s then pure () else write
181182 where
182− putFn = if withNewLine then (T.hPutStrLn h) else (T.hPutStr h)
183+ write
184+ | noColor && severity <= Warning = liftIO $ putFn $ T.pack (show severity) <> ": " <> s
185+ | not noColor && severity <= Error = TS.putStrWithSGR errorColors h withNewLine s
186+ | not noColor && severity <= Warning = TS.putStrWithSGR warningColors h withNewLine s
187+ | not noColor && severity >= Debug = TS.putStrWithSGR debugColors h withNewLine s
188+ | otherwise = liftIO $ putFn s
189+
190+ putFn = if withNewLine then T.hPutStrLn h else T.hPutStr h
183191 h = if severity <= Error then stderr else stdout
184192 errorColors = [SetColor Foreground Vivid Red]
185193 warningColors = [SetColor Foreground Vivid Yellow]
@@ -226,3 +234,20 @@ fork :: (HasCliConfig e m, MonadIO m) => CliT e IO () -> m ThreadId
226234fork f = do
227235 c <- getCliConfig
228236 liftIO $ forkIO $ runCli c f
237+
238+-- | Conservatively determines whether the encoding supports Unicode.
239+--
240+-- Currently this uses a whitelist of known-to-work encodings. In principle it
241+-- could test dynamically by opening a file with this encoding, but it doesn't
242+-- look like base exposes any way to determine this in a pure fashion.
243+supportsUnicode :: TextEncoding -> Bool
244+supportsUnicode enc = any ((textEncodingName enc ==) . textEncodingName)
245+ [ utf8
246+ , utf8_bom
247+ , utf16
248+ , utf16be
249+ , utf16le
250+ , utf32
251+ , utf32be
252+ , utf32le
253+ ]
lib/cliapp/src/Obelisk/CliApp/Process.hs+143−55
@@ -1,7 +1,6 @@
11{-# LANGUAGE FlexibleContexts #-}
22{-# LANGUAGE LambdaCase #-}
33{-# LANGUAGE MultiParamTypeClasses #-}
4−{-# LANGUAGE MultiWayIf #-}
54{-# LANGUAGE OverloadedStrings #-}
65{-# LANGUAGE ScopedTypeVariables #-}
76{-# LANGUAGE TupleSections #-}
@@ -9,43 +8,86 @@
98-- | An extension of `System.Process` that integrates with logging (`Obelisk.CLI.Logging`)
109-- and is thus spinner friendly.
1110module Obelisk.CliApp.Process
12− ( ProcessFailure (..)
13− , AsProcessFailure (..)
14− , readProcessAndLogStderr
15− , readProcessAndLogOutput
16− , readCreateProcessWithExitCode
11+ ( AsProcessFailure (..)
12+ , ProcessFailure (..)
13+ , ProcessSpec (..)
14+ , callCommand
15+ , callProcess
1716 , callProcessAndLogOutput
1817 , createProcess
1918 , createProcess_
20− , callProcess
21− , callCommand
19+ , exitCodeToException
20+ , overCreateProcess
21+ , proc
22+ , readCreateProcessWithExitCode
23+ , readProcessAndLogOutput
24+ , readProcessAndLogStderr
25+ , readProcessJSONAndLogStderr
2226 , reconstructCommand
27+ , runProcess_
28+ , setCwd
29+ , setDelegateCtlc
30+ , setEnvOverride
31+ , shell
32+ , waitForProcess
2333 ) where
2434
2535import Control.Monad ((<=<), join, void)
36+import Control.Monad.Catch (MonadMask, bracketOnError)
2637import Control.Monad.Except (throwError)
38+import Control.Monad.Fail
2739import Control.Monad.IO.Class (MonadIO, liftIO)
2840import Control.Lens (Prism', review)
2941import qualified Data.ByteString as BS
3042import qualified Data.ByteString.Char8 as BSC
43+import qualified Data.ByteString.UTF8 as BSU
3144import Data.Function (fix)
45+import Data.Map (Map)
46+import qualified Data.Map as Map
3247import Data.Monoid ((<>))
3348import Data.Text (Text)
3449import qualified Data.Text as T
3550import qualified Data.Text.Encoding as T
51+import Data.Text.Encoding.Error (lenientDecode)
52+import System.Environment (getEnvironment)
3653import System.Exit (ExitCode (..))
3754import System.IO (Handle)
3855import System.IO.Streams (InputStream, handleToInputStream)
3956import qualified System.IO.Streams as Streams
4057import System.IO.Streams.Concurrent (concurrentMerge)
41−import System.Process (CreateProcess, ProcessHandle, StdStream (CreatePipe), cmdspec, std_err, std_out,
42− waitForProcess)
58+import System.Process (CreateProcess, ProcessHandle, StdStream (CreatePipe), std_err, std_out)
4359import qualified System.Process as Process
60+import Text.ShellEscape (bash, bytes)
61+import qualified Data.Aeson as Aeson
4462
4563import Control.Monad.Log (Severity (..))
4664import Obelisk.CliApp.Logging (putLog, putLogRaw)
4765import Obelisk.CliApp.Types (CliLog, CliThrow)
4866
67+data ProcessSpec = ProcessSpec
68+ { _processSpec_createProcess :: !CreateProcess
69+ , _processSpec_overrideEnv :: !(Maybe (Map String String -> Map String String))
70+ }
71+
72+proc :: FilePath -> [String] -> ProcessSpec
73+proc cmd args = ProcessSpec (Process.proc cmd args) Nothing
74+
75+shell :: String -> ProcessSpec
76+shell cmd = ProcessSpec (Process.shell cmd) Nothing
77+
78+setEnvOverride :: (Map String String -> Map String String) -> ProcessSpec -> ProcessSpec
79+setEnvOverride f p = p { _processSpec_overrideEnv = Just f }
80+
81+overCreateProcess :: (CreateProcess -> CreateProcess) -> ProcessSpec -> ProcessSpec
82+overCreateProcess f (ProcessSpec p x) = ProcessSpec (f p) x
83+
84+setDelegateCtlc :: Bool -> ProcessSpec -> ProcessSpec
85+setDelegateCtlc b = overCreateProcess (\p -> p { Process.delegate_ctlc = b })
86+
87+setCwd :: Maybe FilePath -> ProcessSpec -> ProcessSpec
88+setCwd fp = overCreateProcess (\p -> p { Process.cwd = fp })
89+
90+
4991-- TODO put back in `Obelisk.CliApp.Process` and use prisms for extensible exceptions
5092data ProcessFailure = ProcessFailure Process.CmdSpec Int -- exit code
5193 deriving Show
@@ -59,44 +101,56 @@ instance AsProcessFailure ProcessFailure where
59101 asProcessFailure = id
60102
61103readProcessAndLogStderr
62− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
63− => Severity -> CreateProcess -> m Text
104+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
105+ => Severity -> ProcessSpec -> m Text
64106readProcessAndLogStderr sev process = do
65107 (out, _err) <- withProcess process $ \_out err -> do
66108 streamToLog =<< liftIO (streamHandle sev err)
67− liftIO $ T.decodeUtf8 <$> BS.hGetContents out
109+ liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out
110+
111+readProcessJSONAndLogStderr
112+ :: (Aeson.FromJSON a, MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
113+ => Severity -> ProcessSpec -> m a
114+readProcessJSONAndLogStderr sev process = do
115+ (out, _err) <- withProcess process $ \_out err -> do
116+ streamToLog =<< liftIO (streamHandle sev err)
117+ json <- liftIO $ BS.hGetContents out
118+ case Aeson.eitherDecodeStrict json of
119+ Right a -> pure a
120+ Left err -> do
121+ putLog Error $ "Could not decode process output as JSON: " <> T.pack err
122+ throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) 0
68123
69124readCreateProcessWithExitCode
70− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
71− => CreateProcess -> m (ExitCode, String, String)
72−readCreateProcessWithExitCode process = do
73− putLog Debug $ "Creating process: " <> reconstructCommand (cmdspec process)
125+ :: (MonadIO m, CliLog m)
126+ => ProcessSpec -> m (ExitCode, String, String)
127+readCreateProcessWithExitCode procSpec = do
128+ process <- mkCreateProcess procSpec
129+ putLog Debug $ "Creating process: " <> reconstructProcSpec procSpec
74130 liftIO $ Process.readCreateProcessWithExitCode process ""
75131
76132-- | Like `System.Process.readProcess` but logs the combined output (stdout and stderr)
77133-- with the corresponding severity.
78134--
79−-- Usually this function is called as `callProcessAndLogOutput (Debug, Error)`. However
135+-- Usually this function is called as `readProcessAndLogOutput (Debug, Error)`. However
80136-- some processes are known to spit out diagnostic or informative messages in stderr, in
81137-- which case it is advisable to call it with a non-Error severity for stderr, like
82−-- `callProcessAndLogOutput (Debug, Debug)`.
138+-- `readProcessAndLogOutput (Debug, Debug)`.
83139readProcessAndLogOutput
84− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
85− => (Severity, Severity) -> CreateProcess -> m Text
140+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)
141+ => (Severity, Severity) -> ProcessSpec -> m Text
86142readProcessAndLogOutput (sev_out, sev_err) process = do
87− (_, Just out, Just err, p) <- createProcess $ process
88− { std_out = CreatePipe , std_err = CreatePipe }
143+ (_, Just out, Just err, p) <- createProcess $ overCreateProcess
144+ (\p -> p { std_out = CreatePipe , std_err = CreatePipe }) process
89145
90146 -- TODO interleave stdout and stderr in log correctly
91147 streamToLog =<< liftIO (streamHandle sev_err err)
92− outText <- liftIO $ T.decodeUtf8 <$> BS.hGetContents out
148+ outText <- liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out
93149 putLogRaw sev_out outText
94150
95− liftIO (waitForProcess p) >>= \case
96− ExitSuccess -> pure outText
97− ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (cmdspec process) code
151+ outText <$ (exitCodeToException process =<< waitForProcess p)
98152
99−-- | Like `System.Process.callProcess` but logs the combined output (stdout and stderr)
153+-- | Like 'System.Process.callProcess' but logs the combined output (stdout and stderr)
100154-- with the corresponding severity.
101155--
102156-- Usually this function is called as `callProcessAndLogOutput (Debug, Error)`. However
@@ -104,9 +158,8 @@ readProcessAndLogOutput (sev_out, sev_err) process = do
104158-- which case it is advisable to call it with a non-Error severity for stderr, like
105159-- `callProcessAndLogOutput (Debug, Debug)`.
106160callProcessAndLogOutput
107−
108− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
109− => (Severity, Severity) -> CreateProcess -> m ()
161+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
162+ => (Severity, Severity) -> ProcessSpec -> m ()
110163callProcessAndLogOutput (sev_out, sev_err) process =
111164 void $ withProcess process $ \out err -> do
112165 stream <- liftIO $ join $ combineStream
@@ -116,21 +169,30 @@ callProcessAndLogOutput (sev_out, sev_err) process =
116169 where
117170 combineStream s1 s2 = concurrentMerge [s1, s2]
118171
119−-- | Like `System.Process.createProcess` but also logs (debug) the process being run
172+-- | Like 'System.Process.createProcess' but also logs (debug) the process being run
120173createProcess
121174 :: (MonadIO m, CliLog m)
122− => CreateProcess -> m (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)
123−createProcess p = do
124− putLog Debug $ "Creating process: " <> reconstructCommand (cmdspec p)
175+ => ProcessSpec -> m (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)
176+createProcess procSpec = do
177+ p <- mkCreateProcess procSpec
178+ putLog Debug $ "Creating process: " <> reconstructProcSpec procSpec
125179 liftIO $ Process.createProcess p
126180
127181-- | Like `System.Process.createProcess_` but also logs (debug) the process being run
128182createProcess_
129183 :: (MonadIO m, CliLog m)
130− => String -> CreateProcess -> m (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)
131−createProcess_ name p = do
132− putLog Debug $ "Creating process " <> T.pack name <> ": " <> reconstructCommand (cmdspec p)
133− liftIO $ Process.createProcess p
184+ => String -> ProcessSpec -> m (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)
185+createProcess_ name procSpec = do
186+ p <- mkCreateProcess procSpec
187+ putLog Debug $ "Creating process " <> T.pack name <> ": " <> reconstructProcSpec procSpec
188+ liftIO $ Process.createProcess_ name p
189+
190+mkCreateProcess :: MonadIO m => ProcessSpec -> m Process.CreateProcess
191+mkCreateProcess (ProcessSpec p override') = case override' of
192+ Nothing -> pure p
193+ Just override -> do
194+ procEnv <- Map.fromList <$> maybe (liftIO getEnvironment) pure (Process.env p)
195+ pure $ p { Process.env = Just $ Map.toAscList (override procEnv) }
134196
135197-- | Like `System.Process.callProcess` but also logs (debug) the process being run
136198callProcess
@@ -149,18 +211,30 @@ callCommand cmd = do
149211 liftIO $ Process.callCommand cmd
150212
151213withProcess
152− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
153− => CreateProcess -> (Handle -> Handle -> m ()) -> m (Handle, Handle)
154−withProcess process f = do -- TODO: Use bracket.
155− -- FIXME: Using `withCreateProcess` here leads to something operating illegally on closed handles.
156− (_, Just out, Just err, p) <- createProcess $ process
157− { std_out = CreatePipe , std_err = CreatePipe }
158−
159− f out err -- Pass the handles to the passed function
214+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
215+ => ProcessSpec -> (Handle -> Handle -> m ()) -> m (Handle, Handle)
216+withProcess process f =
217+ bracketOnError
218+ (createProcess $ overCreateProcess
219+ (\x -> x { std_out = CreatePipe , std_err = CreatePipe }) process
220+ )
221+ (liftIO . Process.cleanupProcess)
222+ (\case
223+ (_, Just out, Just err, p) -> do
224+ f out err
225+ (out, err) <$ (exitCodeToException process =<< waitForProcess p)
226+ _ -> error "withProcess: createProcess did not provide handles for CreatePipe as expected"
227+ )
160228
161− liftIO (waitForProcess p) >>= \case
162− ExitSuccess -> return (out, err)
163− ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (cmdspec process) code
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)
164238
165239-- Create an input stream from the file handle, associating each item with the given severity.
166240streamHandle :: Severity -> Handle -> IO (InputStream (Severity, BSC.ByteString))
@@ -173,12 +247,26 @@ streamToLog
173247streamToLog stream = fix $ \loop -> do
174248 liftIO (Streams.read stream) >>= \case
175249 Nothing -> return ()
176− Just (sev, line) -> putLogRaw sev (T.decodeUtf8 line) >> loop
250+ Just (sev, line) -> putLogRaw sev (T.decodeUtf8With lenientDecode line) >> loop
251+
252+-- | Wrapper around `System.Process.waitForProcess`
253+waitForProcess :: MonadIO m => ProcessHandle -> m ExitCode
254+waitForProcess = liftIO . Process.waitForProcess
255+
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
177261
178262-- | Pretty print a 'CmdSpec'
179263reconstructCommand :: Process.CmdSpec -> Text
180−reconstructCommand (Process.ShellCommand str) = T.pack str
181−reconstructCommand (Process.RawCommand c as) = processToShellString c as
264+reconstructCommand p = case p of
265+ Process.ShellCommand str -> T.pack str
266+ Process.RawCommand c as -> processToShellString c as
182267 where
183− processToShellString cmd args = T.unwords $ map quoteAndEscape (cmd : args)
184− quoteAndEscape x = "'" <> T.replace "'" "'\''" (T.pack x) <> "'"
268+ processToShellString cmd args = T.pack $ unwords $
269+ map (BSU.toString . bytes . bash . BSU.fromString) (cmd : args)
270+
271+reconstructProcSpec :: ProcessSpec -> Text
272+reconstructProcSpec = reconstructCommand . Process.cmdspec . _processSpec_createProcess
lib/cliapp/src/Obelisk/CliApp/Spinner.hs+18−24
@@ -3,7 +3,6 @@
33{-# LANGUAGE MultiParamTypeClasses #-}
44{-# LANGUAGE OverloadedStrings #-}
55{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE TupleSections #-}
76-- | Provides a simple CLI spinner that interoperates cleanly with the rest of the logging output.
87module Obelisk.CliApp.Spinner
98 ( withSpinner
@@ -24,6 +23,7 @@ import System.Console.ANSI (Color (Blue, Cyan, Green, Red))
2423
2524import Obelisk.CliApp.Logging (allowUserToMakeLoggingVerbose, fork, putLog)
2625import Obelisk.CliApp.TerminalString (TerminalString (..), enquiryCode)
26+import Obelisk.CliApp.Theme
2727import Obelisk.CliApp.Types (CliLog, CliConfig (..), HasCliConfig, Output (..), getCliConfig)
2828
2929-- | Run an action with a CLI spinner.
@@ -51,7 +51,8 @@ withSpinner'
5151 -> m a
5252 -> m a
5353withSpinner' msg mkTrail action = do
54− noSpinner <- _cliConfig_noSpinner <$> getCliConfig
54+ cliConf <- getCliConfig
55+ let noSpinner = _cliConfig_noSpinner cliConf
5556 if noSpinner
5657 then putLog Notice msg >> action
5758 else bracket' run cleanup $ const action
@@ -61,8 +62,11 @@ withSpinner' msg mkTrail action = do
6162 modifyStack pushSpinner >>= \case
6263 True -> do -- Top-level spinner; fork a thread to manage output of anything on the stack
6364 ctrleThread <- fork $ allowUserToMakeLoggingVerbose enquiryCode
65+ cliConf <- getCliConfig
66+ let theme = _cliConfig_theme cliConf
67+ spinner = coloredSpinner $ _cliTheme_spinner theme
6468 spinnerThread <- fork $ runSpinner spinner $ \c -> do
65− logs <- renderSpinnerStack c . snd <$> readStack
69+ logs <- renderSpinnerStack theme c . snd <$> readStack
6670 logMessage $ Output_Overwrite logs
6771 pure [ctrleThread, spinnerThread]
6872 False -> -- Sub-spinner; nothing to do.
@@ -70,13 +74,15 @@ withSpinner' msg mkTrail action = do
7074 cleanup tids resultM = do
7175 liftIO $ mapM_ killThread tids
7276 logMessage Output_ClearLine
73− logsM <- modifyStack $ popSpinner $ case resultM of
77+ cliConf <- getCliConfig
78+ let theme = _cliConfig_theme cliConf
79+ logsM <- modifyStack $ (popSpinner theme) $ case resultM of
7480 Nothing ->
75− ( TerminalString_Colorized Red "✖"
81+ ( TerminalString_Colorized Red $ _cliTheme_failed $ _cliConfig_theme cliConf
7682 , Just msg -- Always display final message if there was an exception.
7783 )
7884 Just result ->
79− ( TerminalString_Colorized Green "✔"
85+ ( TerminalString_Colorized Green $ _cliTheme_done $ _cliConfig_theme cliConf
8086 , mkTrail <*> pure result
8187 )
8288 -- Last message, finish off with newline.
@@ -87,10 +93,10 @@ withSpinner' msg mkTrail action = do
8793 )
8894 where
8995 isTemporary = isNothing mkTrail
90− popSpinner (mark, trailMsgM) (flag, old) =
96+ popSpinner theme (mark, trailMsgM) (flag, old) =
9197 ( (newFlag, new)
9298 -- With final trail spinner message to render
93− , renderSpinnerStack mark . (: new) . TerminalString_Normal <$> (
99+ , renderSpinnerStack theme mark . (: new) . TerminalString_Normal <$> (
94100 if inTemporarySpinner then Nothing else trailMsgM
95101 )
96102 )
@@ -102,19 +108,19 @@ withSpinner' msg mkTrail action = do
102108 =<< fmap _cliConfig_spinnerStack getCliConfig
103109 modifyStack f = liftIO . flip atomicModifyIORef' f
104110 =<< fmap _cliConfig_spinnerStack getCliConfig
105− spinner = coloredSpinner defaultSpinnerTheme
106111
107112-- | How nested spinner logs should be displayed
108113renderSpinnerStack
109− :: TerminalString -- ^ That which comes before the final element in stack
114+ :: CliTheme
115+ -> TerminalString -- ^ That which comes before the final element in stack
110116 -> [TerminalString] -- ^ Spinner elements in reverse order
111117 -> [TerminalString]
112−renderSpinnerStack mark = L.intersperse space . go . L.reverse
118+renderSpinnerStack theme mark = L.intersperse space . go . L.reverse
113119 where
114120 go [] = []
115121 go (x:[]) = mark : [x]
116122 go (x:xs) = arrow : x : go xs
117− arrow = TerminalString_Colorized Blue "⇾"
123+ arrow = TerminalString_Colorized Blue $ _cliTheme_arrow theme
118124 space = TerminalString_Normal " "
119125
120126-- | A spinner is simply an infinite list of strings that supplant each other in a delayed loop, creating the
@@ -130,18 +136,6 @@ runSpinner spinner f = forM_ spinner $ f >=> const delay
130136 where
131137 delay = liftIO $ threadDelay 100000 -- A shorter delay ensures that we update promptly.
132138
133−type SpinnerTheme = [Text]
134−
135−-- Find more spinners at https://github.com/sindresorhus/cli-spinners/blob/master/spinners.json
136−_spinnerCircleHalves :: SpinnerTheme
137−_spinnerCircleHalves = ["◐", "◓", "◑", "◒"]
138−
139−spinnerMoon :: SpinnerTheme
140−spinnerMoon = ["🌑", "🌒", "🌓", "🌔", "🌕", "🌖", "🌗", "🌘"]
141−
142−defaultSpinnerTheme :: SpinnerTheme
143−defaultSpinnerTheme = spinnerMoon
144−
145139-- | Like `bracket` but the `release` function can know whether an exception was raised
146140bracket' :: MonadMask m => m a -> (a -> Maybe c -> m b) -> (a -> m c) -> m c
147141bracket' acquire release use = mask $ \unmasked -> do
lib/cliapp/src/Obelisk/CliApp/Theme.hsnew file+29
@@ -0,0 +1,29 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Obelisk.CliApp.Theme where
3+
4+import Data.Text (Text)
5+
6+data CliTheme = CliTheme
7+ { _cliTheme_done :: Text
8+ , _cliTheme_failed :: Text
9+ , _cliTheme_arrow :: Text
10+ , _cliTheme_spinner :: SpinnerTheme
11+ }
12+
13+type SpinnerTheme = [Text]
14+
15+unicodeTheme :: CliTheme
16+unicodeTheme = CliTheme
17+ { _cliTheme_done = "✔"
18+ , _cliTheme_failed = "✖"
19+ , _cliTheme_arrow = "⇾"
20+ , _cliTheme_spinner = ["◐", "◓", "◑", "◒"]
21+ }
22+
23+noUnicodeTheme :: CliTheme
24+noUnicodeTheme = CliTheme
25+ { _cliTheme_done = "DONE"
26+ , _cliTheme_failed = "FAILED"
27+ , _cliTheme_arrow = "->"
28+ , _cliTheme_spinner = ["|", "/", "-", "\\"]
29+ }
lib/cliapp/src/Obelisk/CliApp/Types.hs+10−3
@@ -6,12 +6,14 @@
66{-# LANGUAGE GeneralizedNewtypeDeriving #-}
77{-# LANGUAGE MultiParamTypeClasses #-}
88{-# LANGUAGE OverloadedStrings #-}
9+{-# LANGUAGE StandaloneDeriving #-}
910{-# LANGUAGE UndecidableInstances #-}
1011module Obelisk.CliApp.Types where
1112
1213import Control.Concurrent.MVar (MVar)
1314import Control.Monad.Catch (MonadCatch, MonadMask, MonadThrow)
14−import Control.Monad.Log (LoggingT, MonadLog, Severity (..), WithSeverity (..), logMessage)
15+import Control.Monad.Fail (MonadFail)
16+import Control.Monad.Log (LoggingT(..), MonadLog, Severity (..), WithSeverity (..), logMessage)
1517import Control.Monad.Reader (MonadIO, ReaderT (..), MonadReader (..), ask, mapReaderT)
1618import Control.Monad.Writer (WriterT)
1719import Control.Monad.State (StateT)
@@ -23,6 +25,7 @@ import Data.Text (Text)
2325import System.Exit (ExitCode (..), exitWith)
2426
2527import Obelisk.CliApp.TerminalString (TerminalString)
28+import Obelisk.CliApp.Theme (CliTheme)
2629
2730--------------------------------------------------------------------------------
2831
@@ -44,9 +47,11 @@ type CliThrow e m = MonadError e m
4447putLog :: CliLog m => Severity -> Text -> m ()
4548putLog sev = logMessage . Output_Log . WithSeverity sev
4649
50+deriving instance MonadFail m => MonadFail (LoggingT Output m)
51+
4752newtype DieT e m a = DieT { unDieT :: ReaderT (e -> (Text, Int)) (LoggingT Output m) a }
4853 deriving
49− ( Functor, Applicative, Monad, MonadIO
54+ ( Functor, Applicative, Monad, MonadIO, MonadFail
5055 , MonadThrow, MonadCatch, MonadMask
5156 , MonadLog Output
5257 )
@@ -88,6 +93,8 @@ data CliConfig e = CliConfig
8893 _cliConfig_spinnerStack :: IORef ([Bool], [TerminalString])
8994 , -- | Failure handler. How to log error and what exit status to use.
9095 _cliConfig_errorLogExitCode :: e -> (Text, Int)
96+ , -- | Theme strings for spinners
97+ _cliConfig_theme :: CliTheme
9198 }
9299
93100class Monad m => HasCliConfig e m | m -> e where
@@ -111,7 +118,7 @@ newtype CliT e m a = CliT
111118 { unCliT :: ReaderT (CliConfig e) (DieT e m) a
112119 }
113120 deriving
114− ( Functor, Applicative, Monad, MonadIO
121+ ( Functor, Applicative, Monad, MonadIO, MonadFail
115122 , MonadThrow, MonadCatch, MonadMask
116123 , MonadLog Output -- CliLog
117124 , MonadError e -- CliThrow
lib/command/obelisk-command.cabal+20−14
@@ -1,5 +1,5 @@
11name: obelisk-command
2−version: 0.1
2+version: 0.9.0.1
33cabal-version: >= 1.8
44build-type: Simple
55
@@ -7,42 +7,48 @@ library
77 hs-source-dirs: src
88 build-depends:
99 aeson
10− , ansi-terminal
11− , Cabal
1210 , aeson-pretty
11+ , ansi-terminal
1312 , base
14− , base16-bytestring
15− , binary
1613 , bytestring
17− , obelisk-cliapp
14+ , Cabal
1815 , containers
1916 , data-default
2017 , directory
2118 , either
19+ , errors
20+ , exceptions
21+ , extra
2222 , filepath
23+ , git
2324 , github
2425 , here
25− , hit
26+ , hnix
2627 , hpack
2728 , io-streams
28− , exceptions
29− , logging-effect
3029 , lens
30+ , logging-effect
31+ , megaparsec
3132 , modern-uri
3233 , monad-loops
34+ , monoidal-containers
3335 , mtl
34− , megaparsec
3536 , network
3637 , network-uri
38+ , obelisk-cliapp
3739 , optparse-applicative
3840 , placeholders
3941 , process
42+ , shell-escape
4043 , temporary
4144 , terminal-size
4245 , text
4346 , time
4447 , transformers
45− , unix
48+ , unix-compat
49+ , unordered-containers
50+ , utf8-string
51+ , which
4652 , yaml
4753 exposed-modules:
4854 Obelisk.App
@@ -54,10 +60,10 @@ library
5460 Obelisk.Command.Thunk
5561 Obelisk.Command.Utils
5662 Obelisk.Command.VmBuilder
57− -- -fobject-code is so that the StaticPointers extension can work in ghci
58− ghc-options: -Wall -fobject-code
63+ Obelisk.Command.Preprocessor
64+ ghc-options: -Wall
5965
6066executable ob
6167 main-is: src-bin/ob.hs
6268 build-depends: base, obelisk-command
63− ghc-options: -Wall -O2 -threaded
69+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -threaded
lib/command/src/Obelisk/App.hs+5−2
@@ -12,6 +12,7 @@ module Obelisk.App where
1212
1313import Control.Lens
1414import Control.Monad.Catch (MonadCatch, MonadMask, MonadThrow)
15+import Control.Monad.Fail (MonadFail)
1516import Control.Monad.Reader (MonadIO, ReaderT (..), ask, runReaderT)
1617import Control.Monad.Writer (WriterT)
1718import Control.Monad.State (StateT)
@@ -61,10 +62,11 @@ newtype ObeliskT m a = ObeliskT
6162 { unObeliskT :: ReaderT Obelisk (CliT ObeliskError m) a
6263 }
6364 deriving
64− ( Functor, Applicative, Monad, MonadIO, MonadThrow, MonadCatch, MonadMask
65+ ( Functor, Applicative, Monad, MonadIO, MonadThrow, MonadCatch, MonadMask, MonadFail
6566 , MonadLog Output -- CliLog
6667 , MonadError ObeliskError -- CliThrow ObeliskError
67− , HasCliConfig ObeliskError)
68+ , HasCliConfig ObeliskError
69+ )
6870
6971instance MonadTrans ObeliskT where
7072 lift = ObeliskT . lift . lift
@@ -104,6 +106,7 @@ type MonadInfallibleObelisk m =
104106type MonadObelisk m =
105107 ( MonadInfallibleObelisk m
106108 , CliThrow ObeliskError m
109+ , MonadFail m
107110 )
108111
109112getObeliskUserStateDir :: IO FilePath
lib/command/src/Obelisk/Command.hs+225−147
@@ -3,38 +3,35 @@
33{-# LANGUAGE MultiParamTypeClasses #-}
44{-# LANGUAGE OverloadedStrings #-}
55{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE StaticPointers #-}
7−{-# LANGUAGE TypeApplications #-}
6+{-# LANGUAGE TupleSections #-}
87module Obelisk.Command where
98
10−import Control.Monad
11−import Control.Monad.IO.Class (liftIO)
12−import qualified Data.Binary as Binary
9+import Control.Monad.IO.Class (MonadIO, liftIO)
1310import Data.Bool (bool)
14−import qualified Data.ByteString.Base16 as Base16
15−import qualified Data.ByteString.Lazy as LBS
16−import Data.List
17−import Data.Maybe (catMaybes)
11+import Data.Foldable (for_)
12+import Data.List (isInfixOf, isPrefixOf)
13+import Data.List.NonEmpty (NonEmpty, nonEmpty)
14+import qualified Data.List.NonEmpty as NonEmpty
15+import qualified Data.Map as Map
1816import qualified Data.Text as T
19−import Data.Text.Encoding
20−import GHC.StaticPtr
17+import Data.Traversable (for)
2118import Options.Applicative
19+import Options.Applicative.Help.Pretty (text, (<$$>))
2220import System.Directory
2321import System.Environment
2422import System.FilePath
2523import qualified System.Info
2624import System.IO (hIsTerminalDevice, stdout)
27−import System.Posix.Process (executeFile)
25+import System.Process (rawSystem)
2826
2927import Obelisk.App
3028import Obelisk.CliApp
31−import Obelisk.CliApp.Demo (cliDemo)
3229import Obelisk.Command.Deploy
3330import Obelisk.Command.Project
3431import Obelisk.Command.Run
3532import Obelisk.Command.Thunk
36−import Obelisk.Command.Utils
3733import qualified Obelisk.Command.VmBuilder as VmBuilder
34+import qualified Obelisk.Command.Preprocessor as Preprocessor
3835
3936
4037data Args = Args
@@ -77,8 +74,8 @@ argsInfo cfg = info (args cfg <**> helper) $ mconcat
7774initSource :: Parser InitSource
7875initSource = foldl1 (<|>)
7976 [ pure InitSource_Default
80− , InitSource_Branch <$> strOption (long "branch" <> metavar "BRANCH")
81− , InitSource_Symlink <$> strOption (long "symlink" <> action "directory" <> metavar "PATH")
77+ , InitSource_Branch <$> strOption (long "branch" <> metavar "BRANCH" <> help "Initialize the project using the given BRANCH of Obelisk's official repository")
78+ , InitSource_Symlink <$> strOption (long "symlink" <> action "directory" <> metavar "PATH" <> help "(Use with caution) Initialize the project using the copy of Obelisk found at the given PATH")
8279 ]
8380
8481initForce :: Parser Bool
@@ -87,51 +84,56 @@ initForce = switch (long "force" <> help "Allow ob init to overwrite files")
8784data ObCommand
8885 = ObCommand_Init InitSource Bool
8986 | ObCommand_Deploy DeployCommand
90− | ObCommand_Run
91− | ObCommand_Thunk ThunkCommand
92− | ObCommand_Repl
93− | ObCommand_Watch
87+ | ObCommand_Run [(FilePath, Interpret)]
88+ | ObCommand_Profile String [String]
89+ | ObCommand_Thunk ThunkOption
90+ | ObCommand_Repl [(FilePath, Interpret)]
91+ | ObCommand_Watch [(FilePath, Interpret)]
92+ | ObCommand_Shell ShellOpts
93+ | ObCommand_Doc String [String] -- shell and list of packages
94+ | ObCommand_Hoogle String Int -- shell and port
9495 | ObCommand_Internal ObInternal
9596 deriving Show
9697
9798data ObInternal
98− = ObInternal_RunStaticIO StaticKey
99− | ObInternal_CLIDemo
99+ -- the preprocessor argument syntax is also handled outside
100+ -- optparse-applicative, but it shouldn't ever conflict with another syntax
101+ = ObInternal_ApplyPackages String String String [String]
102+ | ObInternal_ExportGhciConfig
103+ [(FilePath, Interpret)]
104+ Bool -- ^ Use relative paths
100105 deriving Show
101106
102−inNixShell' :: MonadObelisk m => StaticPtr (ObeliskT IO ()) -> m ()
103−inNixShell' p = withProjectRoot "." $ \root -> do
104− cmd <- liftIO $ unwords <$> mkCmd -- TODO: shell escape instead of unwords
105− projectShell root False "ghc" cmd
106− where
107− mkCmd = do
108− argsCfg <- getArgsConfig
109− myArgs <- getArgs
110− obArgs <- parseCLIArgs argsCfg myArgs
111− progName <- getObeliskExe
112− return $ progName : catMaybes
113− [ Just "--no-handoff"
114− , bool Nothing (Just "--verbose") $ _args_verbose obArgs
115− , Just "internal"
116− , Just "run-static-io"
117− , Just $ encodeStaticKey $ staticKey p
118− ]
119−
120107obCommand :: ArgsConfig -> Parser ObCommand
121108obCommand cfg = hsubparser
122− (mconcat
123− [ command "init" $ info (ObCommand_Init <$> initSource <*> initForce) $ progDesc "Initialize an Obelisk project"
124− , command "deploy" $ info (ObCommand_Deploy <$> deployCommand cfg) $ progDesc "Prepare a deployment for an Obelisk project"
125− , command "run" $ info (pure ObCommand_Run) $ progDesc "Run current project in development mode"
126− , command "thunk" $ info (ObCommand_Thunk <$> thunkCommand) $ progDesc "Manipulate thunk directories"
127− , command "repl" $ info (pure ObCommand_Repl) $ progDesc "Open an interactive interpreter"
128− , command "watch" $ info (pure ObCommand_Watch) $ progDesc "Watch current project for errors and warnings"
129− ])
130− <|> subparser
131− (mconcat
132− [ internal
133− , command "internal" (info (ObCommand_Internal <$> internalCommand) mempty)
134− ])
109+ (mconcat
110+ [ command "init" $ info (ObCommand_Init <$> initSource <*> initForce) $ progDesc "Initialize an Obelisk project"
111+ , command "deploy" $ info (ObCommand_Deploy <$> deployCommand cfg) $ progDesc "Prepare a deployment for an Obelisk project"
112+ , command "run" $ info (ObCommand_Run <$> interpretOpts) $ progDesc "Run current project in development mode"
113+ , command "profile" $ info (uncurry ObCommand_Profile <$> profileCommand) $ progDesc "Run current project with profiling enabled"
114+ , command "thunk" $ info (ObCommand_Thunk <$> thunkOption) $ progDesc "Manipulate thunk directories"
115+ , 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"
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"
118+ , command "doc" $ info (ObCommand_Doc <$> shellFlags <*> packageNames) $
119+ progDesc "List paths to haddock documentation for specified packages"
120+ <> footerDoc (Just $
121+ text "Hint: To open the documentation you can pipe the output of this command like"
122+ <$$> text "ob doc reflex reflex-dom-core | xargs -n1 xdg-open")
123+ , command "hoogle" $ info (ObCommand_Hoogle <$> shellFlags <*> portOpt 8080) $ progDesc "Run a hoogle server locally for your project's dependency tree"
124+ , command "internal" $ info (ObCommand_Internal <$> internalCommand) $ progDesc "Internal Obelisk commands with unstable APIs"
125+ ])
126+
127+internalCommand :: Parser ObInternal
128+internalCommand = hsubparser $ mconcat
129+ [ command "export-ghci-configuration" $ info (ObInternal_ExportGhciConfig <$> interpretOpts <*> useRelativePathsFlag)
130+ $ progDesc "Export the GHCi configuration used by ob run, etc.; useful for IDE integration"
131+ ]
132+ where
133+ useRelativePathsFlag = switch (long "use-relative-paths" <> help "Use relative paths")
134+
135+packageNames :: Parser [String]
136+packageNames = some (strArgument (metavar "PACKAGE-NAME..."))
135137
136138deployCommand :: ArgsConfig -> Parser DeployCommand
137139deployCommand cfg = hsubparser $ mconcat
@@ -142,8 +144,8 @@ deployCommand cfg = hsubparser $ mconcat
142144 ]
143145 where
144146 platformP = hsubparser $ mconcat
145− [ command "android" $ info (pure Android) mempty
146− , command "ios" $ info (pure IOS <*> strArgument (metavar "TEAMID" <> help "Your Team ID - found in the Apple developer portal")) mempty
147+ [ command "android" $ info (pure (Android, [])) mempty
148+ , command "ios" $ info ((,) <$> pure IOS <*> fmap pure (strArgument (metavar "TEAMID" <> help "Your Team ID - found in the Apple developer portal"))) mempty
147149 ]
148150
149151 remoteBuilderParser :: Parser (Maybe RemoteBuilder)
@@ -165,78 +167,144 @@ deployCommand cfg = hsubparser $ mconcat
165167
166168deployInitOpts :: Parser DeployInitOpts
167169deployInitOpts = DeployInitOpts
168− <$> strArgument (action "directory" <> metavar "DEPLOYDIR" <> help "Path to a directory that it will create")
169− <*> strOption (long "ssh-key" <> action "file" <> metavar "SSHKEY" <> help "Path to an ssh key that it will symlink to")
170+ <$> strArgument (action "directory" <> metavar "DEPLOYDIR" <> help "Path to a directory where the deployment repository will be initialized")
171+ <*> strOption (long "ssh-key" <> action "file" <> metavar "SSHKEY" <> help "Path to an SSH key that will be *copied* to the deployment repository")
170172 <*> some (strOption (long "hostname" <> metavar "HOSTNAME" <> help "hostname of the deployment target"))
171173 <*> strOption (long "route" <> metavar "PUBLICROUTE" <> help "Publicly accessible URL of your app")
172174 <*> strOption (long "admin-email" <> metavar "ADMINEMAIL" <> help "Email address where administrative alerts will be sent")
173175 <*> flag True False (long "disable-https" <> help "Disable automatic https configuration for the backend")
174176
175177type TeamID = String
176−data PlatformDeployment = Android | IOS TeamID
177− deriving (Show)
178−
179178data RemoteBuilder = RemoteBuilder_ObeliskVM
180179 deriving (Eq, Show)
181180
182181data DeployCommand
183182 = DeployCommand_Init DeployInitOpts
184183 | DeployCommand_Push (Maybe RemoteBuilder)
185− | DeployCommand_Test PlatformDeployment
184+ | DeployCommand_Test (PlatformDeployment, [String])
186185 | DeployCommand_Update
187186 deriving Show
188187
189−data DeployInitOpts = DeployInitOpts
190− { _deployInitOpts_outputDir :: FilePath
191− , _deployInitOpts_sshKey :: FilePath
192− , _deployInitOpts_hostname :: [String]
193− , _deployInitOpts_route :: String
194− , _deployInitOpts_adminEmail :: String
195− , _deployInitOpts_enableHttps :: Bool
196− }
188+profileCommand :: Parser (String, [String])
189+profileCommand = (,)
190+ <$> strOption
191+ ( long "output"
192+ <> short 'o'
193+ <> help "Base output to use for profiling output. Suffixes are added to this based on the profiling type. Defaults to a timestamped path in the profile/ directory in the project's root."
194+ <> metavar "PATH"
195+ <> value "profile/%Y-%m-%dT%H:%M:%S"
196+ <> showDefault
197+ )
198+ <*> (words <$> strOption
199+ ( long "rts-flags"
200+ <> help "RTS Flags to pass to the executable."
201+ <> value "-p -hc"
202+ <> metavar "FLAGS"
203+ <> showDefault
204+ ))
205+
206+thunkConfig :: Parser ThunkConfig
207+thunkConfig = ThunkConfig
208+ <$>
209+ ( flag' (Just True) (long "private" <> help "Mark thunks as pointing to a private repository")
210+ <|> flag' (Just False) (long "public" <> help "Mark thunks as pointing to a public repository")
211+ <|> pure Nothing
212+ )
213+
214+thunkUpdateConfig :: Parser ThunkUpdateConfig
215+thunkUpdateConfig = ThunkUpdateConfig
216+ <$> optional (strOption (long "branch" <> metavar "BRANCH" <> help "Use the given branch when looking for the latest revision"))
217+ <*> thunkConfig
218+
219+thunkPackConfig :: Parser ThunkPackConfig
220+thunkPackConfig = ThunkPackConfig
221+ <$> switch (long "force" <> short 'f' <> help "Force packing thunks even if there are branches not pushed upstream, uncommitted changes, stashes. This will cause changes that have not been pushed upstream to be lost; use with care.")
222+ <*> thunkConfig
223+
224+data ThunkOption = ThunkOption
225+ { _thunkOption_thunks :: NonEmpty FilePath
226+ , _thunkOption_command :: ThunkCommand
227+ } deriving Show
228+
229+data ThunkCommand
230+ = ThunkCommand_Update ThunkUpdateConfig
231+ | ThunkCommand_Unpack
232+ | ThunkCommand_Pack ThunkPackConfig
197233 deriving Show
198234
199−internalCommand :: Parser ObInternal
200−internalCommand = subparser $ mconcat
201− [ command "run-static-io" $ info (ObInternal_RunStaticIO <$> argument (eitherReader decodeStaticKey) (action "static-key")) mempty
202− , command "clidemo" $ info (pure ObInternal_CLIDemo) mempty
235+thunkOption :: Parser ThunkOption
236+thunkOption = hsubparser $ mconcat
237+ [ command "update" $ info (thunkOptionWith $ ThunkCommand_Update <$> thunkUpdateConfig) $ progDesc "Update packed thunk to latest revision available on the tracked branch"
238+ , command "unpack" $ info (thunkOptionWith $ pure ThunkCommand_Unpack) $ progDesc "Unpack thunk into git checkout of revision it points to"
239+ , command "pack" $ info (thunkOptionWith $ ThunkCommand_Pack <$> thunkPackConfig) $ progDesc "Pack git checkout or unpacked thunk into thunk that points at the current branch's upstream"
203240 ]
241+ where
242+ thunkOptionWith f = ThunkOption
243+ <$> ((NonEmpty.:|)
244+ <$> thunkDirArg (metavar "THUNKDIRS..." <> help "Paths to directories containing thunk data")
245+ <*> many (thunkDirArg mempty)
246+ )
247+ <*> f
248+ thunkDirArg opts = fmap (dropTrailingPathSeparator . normalise) $ strArgument $ action "directory" <> opts
249+
250+data ShellOpts
251+ = ShellOpts
252+ { _shellOpts_shell :: String
253+ , _shellOpts_interpretPaths :: [(FilePath, Interpret)]
254+ , _shellOpts_command :: Maybe String
255+ }
256+ deriving Show
204257
205−--TODO: Result should provide normalised path and also original user input for error reporting.
206−thunkDirectoryParser :: Parser FilePath
207−thunkDirectoryParser = fmap (dropTrailingPathSeparator . normalise) . strArgument $ mconcat
208− [ action "directory"
209− , metavar "THUNKDIR"
210− , help "Path to directory containing thunk data"
211− ]
258+shellFlags :: Parser String
259+shellFlags =
260+ flag' "ghc" (long "ghc" <> help "Enter a shell environment having ghc (default)")
261+ <|> flag "ghc" "ghcjs" (long "ghcjs" <> help "Enter a shell having ghcjs rather than ghc")
262+ <|> strOption (short 'A' <> long "argument" <> metavar "NIXARG" <> help "Use the environment specified by the given nix argument of `shells'")
263+
264+interpretOpts :: Parser [(FilePath, Interpret)]
265+interpretOpts = many
266+ ( (, Interpret_Interpret) <$>
267+ strOption (common <> long "interpret" <> help
268+ "Don't pre-build packages found in DIR when constructing the package database. The default behavior is \
269+ \'--interpret <project-root>', which will load everything which is unpacked into GHCi. \
270+ \ Use --interpret and --no-interpret multiple times to add or remove multiple trees \
271+ \ from the environment. Settings for right-most directories will \
272+ \ override settings for any identical directories given earlier."
273+ )
274+ <|> (, Interpret_NoInterpret) <$>
275+ strOption (common <> long "no-interpret" <> help
276+ "Make packages found in DIR available in the package database (but only when they are used dependencies). \
277+ \ This will build the packages in DIR before loading GHCi. \
278+ \See help for --interpret for how the two options are related."
279+ )
280+ )
281+ where
282+ common = action "directory" <> metavar "DIR"
212283
213−data ThunkCommand
214− = ThunkCommand_Update [FilePath]
215− | ThunkCommand_Unpack [FilePath]
216− | ThunkCommand_Pack [FilePath]
217− deriving Show
284+shellOpts :: Parser ShellOpts
285+shellOpts = ShellOpts
286+ <$> shellFlags
287+ <*> 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")))
218292
219−thunkCommand :: Parser ThunkCommand
220−thunkCommand = hsubparser $ mconcat
221− [ command "update" $ info (ThunkCommand_Update <$> some thunkDirectoryParser) $ progDesc "Update thunk to latest revision available"
222− , command "unpack" $ info (ThunkCommand_Unpack <$> some thunkDirectoryParser) $ progDesc "Unpack thunk into git checkout of revision it points to"
223− , command "pack" $ info (ThunkCommand_Pack <$> some thunkDirectoryParser) $ progDesc "Pack git checkout into thunk that points at the current branch's upstream"
224− ]
293+portOpt :: Int -> Parser Int
294+portOpt dfault = option auto (long "port" <> short 'p' <> help "Port number for server" <> showDefault <> value dfault <> metavar "INT")
225295
226296parserPrefs :: ParserPrefs
227297parserPrefs = defaultPrefs
228298 { prefShowHelpOnEmpty = True
229299 }
230300
231−parseCLIArgs :: ArgsConfig -> [String] -> IO Args
232−parseCLIArgs cfg as = pure as >>= handleParseResult . execParserPure parserPrefs (argsInfo cfg)
233−
234301-- | Create an Obelisk config for the current process.
235302mkObeliskConfig :: IO Obelisk
236303mkObeliskConfig = do
237304 cliArgs <- getArgs
238305 -- This function should not use argument parser (full argument parsing happens post handoff)
239− let logLevel = toLogLevel $ "-v" `elem` cliArgs
306+ -- TODO: See if we can use the argument parser with a subset of the parsers to get logging level out.
307+ let logLevel = toLogLevel $ any (`elem` ["-v", "--verbose"]) cliArgs
240308 notInteractive <- not <$> isInteractiveTerm
241309 cliConf <- newCliConfig logLevel notInteractive notInteractive $ \case
242310 ObeliskError_ProcessError (ProcessFailure p code) ann ->
@@ -298,9 +366,13 @@ main' argsCfg = do
298366 Just impl -> do
299367 -- Invoke the real implementation, using --no-handoff to prevent infinite recursion
300368 putLog Debug $ "Handing off to " <> T.pack impl
301− liftIO $ executeFile impl False ("--no-handoff" : myArgs) Nothing
369+ _ <- liftIO $ rawSystem impl ("--no-handoff" : myArgs)
370+ return ()
302371 case myArgs of
303372 "--no-handoff" : as -> go as -- If we've been told not to hand off, don't hand off
373+ origPath:inPath:outPath:preprocessorName:packagePaths
374+ | preprocessorName == preprocessorIdentifier && any (\c -> c == '.' || c == pathSeparator) origPath ->
375+ ob $ ObCommand_Internal $ ObInternal_ApplyPackages origPath inPath outPath packagePaths
304376 a:as -- Otherwise bash completion would always hand-off even if the user isn't trying to
305377 | "--bash-completion" `isPrefixOf` a
306378 && "--no-handoff" `elem` as -> go (a:as)
@@ -311,67 +383,73 @@ ob :: MonadObelisk m => ObCommand -> m ()
311383ob = \case
312384 ObCommand_Init source force -> initProject source force
313385 ObCommand_Deploy dc -> case dc of
314− DeployCommand_Init deployOpts -> withProjectRoot "." $ \root -> do
315− let deployDir = _deployInitOpts_outputDir deployOpts
316− r <- liftIO $ canonicalizePath root
317− rootEqualsTarget <- liftIO $ equalFilePath r <$> canonicalizePath deployDir
318− when rootEqualsTarget $
319− failWith $ "Deploy directory " <> T.pack deployDir <> " should not be the same as project root."
320− thunkPtr <- readThunk root >>= \case
321− Left err -> failWith $ case err of
322− ReadThunkError_AmbiguousFiles ->
323− "Project root " <> T.pack r <> " is not a git repository or valid thunk"
324− ReadThunkError_UnrecognizedFiles ->
325− "Project root " <> T.pack r <> " is not a git repository or valid thunk"
326− _ -> "thunk read: " <> T.pack (show err)
327− Right (ThunkData_Packed ptr) -> return ptr
328− Right (ThunkData_Checkout (Just ptr)) -> return ptr
329− Right (ThunkData_Checkout Nothing) ->
330− getThunkPtr' False root
331− let sshKeyPath = _deployInitOpts_sshKey deployOpts
332− hostname = _deployInitOpts_hostname deployOpts
333− route = _deployInitOpts_route deployOpts
334− adminEmail = _deployInitOpts_adminEmail deployOpts
335− enableHttps = _deployInitOpts_enableHttps deployOpts
336− deployInit thunkPtr (root </> "config") deployDir
337− sshKeyPath hostname route adminEmail enableHttps
386+ DeployCommand_Init deployOpts -> withProjectRoot "." $ \root -> deployInit deployOpts root
338387 DeployCommand_Push remoteBuilder -> do
339388 deployPath <- liftIO $ canonicalizePath "."
340389 deployPush deployPath $ case remoteBuilder of
341390 Nothing -> pure []
342391 Just RemoteBuilder_ObeliskVM -> (:[]) <$> VmBuilder.getNixBuildersArg
343392 DeployCommand_Update -> deployUpdate "."
344− DeployCommand_Test Android -> deployMobile "android" []
345− DeployCommand_Test (IOS teamID) -> deployMobile "ios" [teamID]
346− ObCommand_Run -> inNixShell' $ static run
347− -- inNixShell ($(mkClosure 'ghcidAction) ())
348− ObCommand_Thunk tc -> case tc of
349− ThunkCommand_Update thunks -> mapM_ updateThunkToLatest thunks
350− ThunkCommand_Unpack thunks -> mapM_ unpackThunk thunks
351− ThunkCommand_Pack thunks -> forM_ thunks packThunk
352− ObCommand_Repl -> runRepl
353− ObCommand_Watch -> inNixShell' $ static runWatch
393+ DeployCommand_Test (platform, extraArgs) -> deployMobile platform extraArgs
394+ ObCommand_Run interpretPathsList -> withInterpretPaths interpretPathsList run
395+ ObCommand_Profile basePath rtsFlags -> profile basePath rtsFlags
396+ ObCommand_Thunk to -> case _thunkOption_command to of
397+ ThunkCommand_Update config -> for_ thunks (updateThunkToLatest config)
398+ ThunkCommand_Unpack -> for_ thunks unpackThunk
399+ ThunkCommand_Pack config -> for_ thunks (packThunk config)
400+ where
401+ thunks = _thunkOption_thunks to
402+ ObCommand_Repl interpretPathsList -> withInterpretPaths interpretPathsList runRepl
403+ ObCommand_Watch interpretPathsList -> withInterpretPaths interpretPathsList runWatch
404+ 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
406+ ObCommand_Doc shellAttr pkgs -> withInterpretPaths [] $ \root interpretPaths ->
407+ nixShellForInterpretPaths True shellAttr root interpretPaths $ Just $ haddockCommand pkgs
408+ ObCommand_Hoogle shell' port -> withProjectRoot "." $ \root -> do
409+ nixShellWithHoogle root True shell' $ Just $ "hoogle server -p" <> show port <> " --local"
354410 ObCommand_Internal icmd -> case icmd of
355− ObInternal_RunStaticIO k -> liftIO (unsafeLookupStaticPtr @(ObeliskT IO ()) k) >>= \case
356− Nothing -> failWith $ "ObInternal_RunStaticIO: no such StaticKey: " <> T.pack (show k)
357− Just p -> do
358− c <- getObelisk
359− liftIO $ runObelisk c $ deRefStaticPtr p
360− ObInternal_CLIDemo -> cliDemo
411+ ObInternal_ApplyPackages origPath inPath outPath packagePaths -> do
412+ liftIO $ Preprocessor.applyPackages origPath inPath outPath packagePaths
413+ ObInternal_ExportGhciConfig interpretPathsList useRelativePaths ->
414+ liftIO . putStrLn . unlines =<< withInterpretPaths interpretPathsList (exportGhciConfig useRelativePaths)
415+
416+-- | A helper for the common case that the command you want to run needs the project root and a resolved
417+-- set of interpret paths.
418+withInterpretPaths :: MonadObelisk m => [(FilePath, Interpret)] -> (FilePath -> PathTree Interpret -> m a) -> m a
419+withInterpretPaths interpretPathsList f = withProjectRoot "." $ \root -> do
420+ interpretPaths' <- resolveInterpretPaths $ (root, Interpret_Interpret) : interpretPathsList
421+ case interpretPaths' of
422+ Nothing -> failWith "No paths provided for finding packages"
423+ Just interpretPaths -> f root interpretPaths
424+
425+haddockCommand :: [String] -> String
426+haddockCommand pkgs = unwords
427+ [ "for p in"
428+ , unwords [getHaddockPath p ++ "/index.html" | p <- pkgs]
429+ , "; do echo $p; done"
430+ ]
431+ where getHaddockPath p = "$(ghc-pkg field " ++ p ++ " haddock-html --simple-output)"
361432
362433--TODO: Clean up all the magic strings throughout this codebase
363434
364435getArgsConfig :: IO ArgsConfig
365436getArgsConfig = pure $ ArgsConfig { _argsConfig_enableVmBuilderByDefault = System.Info.os == "darwin" }
366437
367−encodeStaticKey :: StaticKey -> String
368−encodeStaticKey = T.unpack . decodeUtf8 . Base16.encode . LBS.toStrict . Binary.encode
369−
370−-- TODO: Use failWith in place of fail to be consistent.
371−decodeStaticKey :: String -> Either String StaticKey
372−decodeStaticKey s = case Base16.decode $ encodeUtf8 $ T.pack s of
373− (b, "") -> case Binary.decodeOrFail $ LBS.fromStrict b of
374− Right ("", _, a) -> pure a
375− Right _ -> fail "decodeStaticKey: Binary.decodeOrFail didn't consume all input"
376− Left (_, _, e) -> fail $ "decodeStaticKey: Binary.decodeOrFail failed: " <> show e
377− _ -> fail $ "decodeStaticKey: could not decode hex string: " <> show s
438+-- | Resolves an ordered list of paths for use with @--interpret@/@--no-interpret@ by coalescing
439+-- paths into a non-ambiguous set of paths. Ambiguity is resolved by choosing right-most paths
440+-- over any preceeding identical paths.
441+--
442+-- For example: @a/b=ON a/b/c=OFF@ and @a/b/c=OFF a/b=ON@ are the same.
443+-- @a/b=ON a/b=OFF@ is reduced to @a/b=OFF@. We prefer right-biased choice to increase
444+-- scriptability.
445+--
446+-- N.B. All the paths in the result will be canonicalized. It's impossible to determine path
447+-- overlap otherwise.
448+resolveInterpretPaths :: MonadIO m => [(FilePath, a)] -> m (Maybe (PathTree a))
449+resolveInterpretPaths ps = do
450+ trees <- liftIO $ for ps $ \(p, a) -> pathToTree a <$> canonicalizePath p
451+ pure $ foldr1 mergeTrees <$> nonEmpty trees
452+ where
453+ -- | Merge two 'PathTree's preferring leaves on the right in as much as they overlap with paths on the left.
454+ mergeTrees :: PathTree a -> PathTree a -> PathTree a
455+ mergeTrees (PathTree_Node ax x) (PathTree_Node ay y) = PathTree_Node (ay <|> ax) $ Map.unionWith mergeTrees x y
lib/command/src/Obelisk/Command/Deploy.hs+235−89
@@ -1,163 +1,309 @@
1+{-# LANGUAGE DeriveGeneric #-}
12{-# LANGUAGE FlexibleContexts #-}
23{-# LANGUAGE LambdaCase #-}
34{-# LANGUAGE OverloadedStrings #-}
5+{-# LANGUAGE QuasiQuotes #-}
46{-# LANGUAGE ScopedTypeVariables #-}
57{-# LANGUAGE ViewPatterns #-}
68module Obelisk.Command.Deploy where
79
10+import Control.Applicative (liftA2)
811import Control.Lens
912import Control.Monad
10−import Control.Monad.Catch (Exception (displayException), MonadThrow, throwM, try)
11−import Control.Monad.IO.Class (liftIO)
13+import Control.Monad.Catch (Exception (displayException), MonadThrow, bracket, throwM, try)
14+import Control.Monad.IO.Class (MonadIO, liftIO)
15+import Data.Aeson (FromJSON, ToJSON, encode, eitherDecode)
1216import Data.Bits
17+import qualified Data.ByteString.Lazy as BSL
1318import Data.Default
1419import qualified Data.Map as Map
15−import Data.Maybe
20+import qualified Data.Set as Set
21+import Data.String.Here.Interpolated (i)
1622import qualified Data.Text as T
1723import qualified Data.Text.IO as T
24+import GHC.Generics
1825import System.Directory
19−import System.Environment (getEnvironment)
2026import System.FilePath
21−import System.Posix.Files
22−import System.Process (delegate_ctlc, env, proc)
27+import System.IO
28+import System.PosixCompat.Files
2329import Text.URI (URI)
2430import qualified Text.URI as URI
2531import Text.URI.Lens
2632
2733import Obelisk.App (MonadObelisk)
28−import Obelisk.CliApp (Severity (..), callProcessAndLogOutput, failWith, putLog, withSpinner)
34+import Obelisk.CliApp (
35+ Severity (..), callProcessAndLogOutput, failWith, proc, putLog,
36+ setCwd, setDelegateCtlc, setEnvOverride, withSpinner)
2937import Obelisk.Command.Nix
3038import Obelisk.Command.Project
3139import Obelisk.Command.Thunk
3240import Obelisk.Command.Utils
3341
34−deployInit
42+data DeployInitOpts = DeployInitOpts
43+ { _deployInitOpts_outputDir :: FilePath
44+ , _deployInitOpts_sshKey :: FilePath
45+ , _deployInitOpts_hostname :: [String]
46+ , _deployInitOpts_route :: String
47+ , _deployInitOpts_adminEmail :: String
48+ , _deployInitOpts_enableHttps :: Bool
49+ } deriving Show
50+
51+deployInit :: MonadObelisk m => DeployInitOpts -> FilePath -> m ()
52+deployInit deployOpts root = do
53+ let deployDir = _deployInitOpts_outputDir deployOpts
54+ rootEqualsTarget <- liftIO $ liftA2 equalFilePath (canonicalizePath root) (canonicalizePath deployDir)
55+ when rootEqualsTarget $
56+ failWith [i|Deploy directory ${deployDir} should not be the same as project root.|]
57+ thunkPtr <- readThunk root >>= \case
58+ Right (ThunkData_Packed _ ptr) -> return ptr
59+ _ -> getThunkPtr CheckClean_NotIgnored root Nothing
60+ deployInit' thunkPtr deployOpts
61+
62+deployInit'
3563 :: MonadObelisk m
3664 => ThunkPtr
37− -> FilePath
38− -> FilePath
39− -> FilePath
40− -> [String] -- ^ hostnames
41− -> String -- ^ route
42− -> String -- ^ admin email
43− -> Bool -- ^ enable https
65+ -> DeployInitOpts
4466 -> m ()
45−deployInit thunkPtr configDir deployDir sshKeyPath hostnames route adminEmail enableHttps = do
46− (hasConfigDir, localKey) <- withSpinner ("Preparing " <> T.pack deployDir) $ do
47− hasConfigDir <- liftIO $ do
48− createDirectoryIfMissing True deployDir
49− doesDirectoryExist configDir
67+deployInit' thunkPtr (DeployInitOpts deployDir sshKeyPath hostnames route adminEmail enableHttps) = do
68+ liftIO $ createDirectoryIfMissing True deployDir
69+ localKey <- withSpinner ("Preparing " <> T.pack deployDir) $ do
5070 localKey <- liftIO (doesFileExist sshKeyPath) >>= \case
5171 False -> failWith $ T.pack $ "ob deploy init: file does not exist: " <> sshKeyPath
5272 True -> pure $ deployDir </> "ssh_key"
5373 callProcessAndLogOutput (Notice, Error) $
54− proc "cp" [sshKeyPath, localKey]
74+ proc cp [sshKeyPath, localKey]
5575 liftIO $ setFileMode localKey $ ownerReadMode .|. ownerWriteMode
56− return $ (hasConfigDir, localKey)
76+ return localKey
5777 withSpinner "Validating configuration" $ do
5878 void $ getHostFromRoute enableHttps route -- make sure that hostname is present
5979 forM_ hostnames $ \hostname -> do
6080 putLog Notice $ "Verifying host keys (" <> T.pack hostname <> ")"
6181 -- Note: we can't use a spinner here as this function will prompt the user.
6282 verifyHostKey (deployDir </> "backend_known_hosts") localKey hostname
63− when hasConfigDir $ withSpinner "Importing project configuration" $ do
64− callProcessAndLogOutput (Notice, Error) $
65− proc "cp" [ "-r" , "-T" , configDir , deployDir </> "config"]
83+ --IMPORTANT: We cannot copy config directory from the development project to
84+ --the deployment directory. If we do, it's very likely someone will
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
89+ mapM_ (createDirectoryIfMissing True)
90+ [ deployDir </> "config" </> "backend"
91+ , deployDir </> "config" </> "common"
92+ , deployDir </> "config" </> "frontend"
93+ ]
94+
95+ let srcDir = deployDir </> "src"
96+ withSpinner ("Creating source thunk (" <> T.pack (makeRelative deployDir srcDir) <> ")") $ do
97+ createThunk srcDir $ Right thunkPtr
98+ setupObeliskImpl deployDir
99+
66100 withSpinner "Writing deployment configuration" $ do
67101 writeDeployConfig deployDir "backend_hosts" $ unlines hostnames
68102 writeDeployConfig deployDir "enable_https" $ show enableHttps
69103 writeDeployConfig deployDir "admin_email" adminEmail
70− writeDeployConfig deployDir ("config" </> "common" </> "route") $ route
71− withSpinner "Creating source thunk (./src)" $ liftIO $ do
72− createThunk (deployDir </> "src") thunkPtr
73− setupObeliskImpl deployDir
104+ writeDeployConfig deployDir ("config" </> "common" </> "route") route
105+ writeDeployConfig deployDir "module.nix" $
106+ "(import " <> toNixPath (makeRelative deployDir srcDir) <> " {}).obelisk.serverModules.mkBaseEc2"
107+
74108 withSpinner ("Initializing git repository (" <> T.pack deployDir <> ")") $
75109 initGit deployDir
76110
77−setupObeliskImpl :: FilePath -> IO ()
78−setupObeliskImpl deployDir = do
79− let implDir = toImplDir deployDir
111+setupObeliskImpl :: MonadIO m => FilePath -> m ()
112+setupObeliskImpl deployDir = liftIO $ do
113+ let
114+ implDir = toImplDir deployDir
115+ goBackUp = foldr (</>) "" $ (".." <$) $ splitPath $ makeRelative deployDir implDir
80116 createDirectoryIfMissing True implDir
81− writeFile (implDir </> "default.nix") "(import ../../src {}).obelisk"
117+ writeFile (implDir </> "default.nix") $ "(import " <> toNixPath (goBackUp </> "src") <> " {}).obelisk"
82118
83119deployPush :: MonadObelisk m => FilePath -> m [String] -> m ()
84120deployPush deployPath getNixBuilders = do
85− host <- readDeployConfig deployPath "backend_hosts"
121+ hosts <- Set.fromList . filter (/= mempty) . lines <$> readDeployConfig deployPath "backend_hosts"
86122 adminEmail <- readDeployConfig deployPath "admin_email"
87123 enableHttps <- read <$> readDeployConfig deployPath "enable_https"
88124 route <- readDeployConfig deployPath $ "config" </> "common" </> "route"
89125 routeHost <- getHostFromRoute enableHttps route
90126 let srcPath = deployPath </> "src"
91127 thunkPtr <- readThunk srcPath >>= \case
92− Right (ThunkData_Packed ptr) -> return ptr
93− Right (ThunkData_Checkout _) -> do
128+ Right (ThunkData_Packed _ ptr) -> return ptr
129+ Right ThunkData_Checkout -> do
94130 checkGitCleanStatus srcPath True >>= \case
95− True -> packThunk srcPath
131+ True -> packThunk (ThunkPackConfig False (ThunkConfig Nothing)) srcPath
96132 False -> failWith $ T.pack $ "ob deploy push: ensure " <> srcPath <> " has no pending changes and latest is pushed upstream."
97133 Left err -> failWith $ "ob deploy push: couldn't read src thunk: " <> T.pack (show err)
98134 let version = show . _thunkRev_commit $ _thunkPtr_rev thunkPtr
99135 builders <- getNixBuilders
100− buildOutput <- nixBuild $ def
101− { _nixBuildConfig_target = Target
102− { _target_path = srcPath
103− , _target_attr = Just "server.system"
104− }
105− , _nixBuildConfig_outLink = OutLink_None
106− , _nixBuildConfig_args =
107− [ strArg "hostName" host
108− , strArg "adminEmail" adminEmail
109− , strArg "routeHost" routeHost
110− , strArg "version" version
111− , boolArg "enableHttps" enableHttps
112− , rawArg "config" $ deployPath </> "config"
113− ]
114− , _nixBuildConfig_builders = builders
115− }
116− let result = listToMaybe $ lines buildOutput
117− forM_ result $ \res -> do
118− let knownHostsPath = deployPath </> "backend_known_hosts"
119− sshOpts = sshArgs knownHostsPath (deployPath </> "ssh_key") False
120− deployAndSwitch outputPath = do
121− withSpinner "Uploading closure" $ do
122− callProcess'
123− (Map.fromList [("NIX_SSHOPTS", unwords sshOpts)])
124− "nix-copy-closure" ["-v", "--to", "root@" <> host, "--gzip", outputPath]
125−
126− withSpinner "Switching to new configuration" $ do
127− callProcessAndLogOutput (Notice, Warning) $
128− proc "ssh" $ sshOpts <>
129− [ "root@" <> host
130− , unwords
131− [ "nix-env -p /nix/var/nix/profiles/system --set " <> outputPath
132− , "&&"
133− , "/nix/var/nix/profiles/system/bin/switch-to-configuration switch"
134− ]
135− ]
136− deployAndSwitch res
137− isClean <- checkGitCleanStatus deployPath True
138− when (not isClean) $ do
139− withSpinner "Commiting changes to Git" $ do
140− callProcessAndLogOutput (Debug, Error) $ proc "git"
141− ["-C", deployPath, "add", "."]
142− callProcessAndLogOutput (Debug, Error) $ proc "git"
143− ["-C", deployPath, "commit", "-m", "New deployment"]
144− putLog Notice $ "Deployed => " <> T.pack route
136+ let moduleFile = deployPath </> "module.nix"
137+ moduleFileExists <- liftIO $ doesFileExist moduleFile
138+ buildOutputByHost <- ifor (Map.fromSet (const ()) hosts) $ \host () -> do
139+ --TODO: What does it mean if this returns more or less than 1 line of output?
140+ [result] <- fmap lines $ nixCmd $ NixCmd_Build $ def
141+ & nixCmdConfig_target .~ Target
142+ { _target_path = Just srcPath
143+ , _target_attr = Just "server.system"
144+ , _target_expr = Nothing
145+ }
146+ & nixBuildConfig_outLink .~ OutLink_None
147+ & nixCmdConfig_args .~ (
148+ [ strArg "hostName" host
149+ , strArg "adminEmail" adminEmail
150+ , strArg "routeHost" routeHost
151+ , strArg "version" version
152+ , boolArg "enableHttps" enableHttps
153+ ] <> [rawArg "module" ("import " <> toNixPath moduleFile) | moduleFileExists ])
154+ & nixCmdConfig_builders .~ builders
155+ pure result
156+ let knownHostsPath = deployPath </> "backend_known_hosts"
157+ sshOpts = sshArgs knownHostsPath (deployPath </> "ssh_key") False
158+ withSpinner "Uploading closures" $ ifor_ buildOutputByHost $ \host outputPath -> do
159+ callProcess'
160+ (Map.fromList [("NIX_SSHOPTS", unwords sshOpts)])
161+ "nix-copy-closure" ["-v", "--to", "--use-substitutes", "root@" <> host, "--gzip", outputPath]
162+ withSpinner "Uploading config" $ ifor_ buildOutputByHost $ \host _ -> do
163+ callProcessAndLogOutput (Notice, Warning) $
164+ proc rsyncPath
165+ [ "-e " <> sshPath <> " " <> unwords sshOpts
166+ , "-qarvz"
167+ , deployPath </> "config"
168+ , "root@" <> host <> ":/var/lib/backend"
169+ ]
170+ --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+ callProcessAndLogOutput (Notice, Warning) $
173+ proc sshPath $ sshOpts <>
174+ [ "root@" <> host
175+ , 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"
180+ ]
181+ ]
182+ isClean <- checkGitCleanStatus deployPath True
183+ when (not isClean) $ do
184+ withSpinner "Committing changes to Git" $ do
185+ callProcessAndLogOutput (Debug, Error) $
186+ gitProc deployPath ["add", "."]
187+ callProcessAndLogOutput (Debug, Error) $
188+ gitProc deployPath ["commit", "-m", "New deployment"]
189+ putLog Notice $ "Deployed => " <> T.pack route
145190 where
146191 callProcess' envMap cmd args = do
147− processEnv <- Map.toList . (envMap <>) . Map.fromList <$> liftIO getEnvironment
148− let p = (proc cmd args) { delegate_ctlc = True, env = Just processEnv }
192+ let p = setEnvOverride (envMap <>) $ setDelegateCtlc True $ proc cmd args
149193 callProcessAndLogOutput (Notice, Notice) p
150194
151195deployUpdate :: MonadObelisk m => FilePath -> m ()
152−deployUpdate deployPath = updateThunkToLatest $ deployPath </> "src"
196+deployUpdate deployPath = updateThunkToLatest (ThunkUpdateConfig Nothing (ThunkConfig Nothing)) (deployPath </> "src")
197+
198+data PlatformDeployment = Android | IOS
199+ deriving (Show, Eq)
200+
201+renderPlatformDeployment :: PlatformDeployment -> String
202+renderPlatformDeployment = \case
203+ Android -> "android"
204+ IOS -> "ios"
153205
154−deployMobile :: MonadObelisk m => String -> [String] -> m ()
206+deployMobile :: forall m. MonadObelisk m => PlatformDeployment -> [String] -> m ()
155207deployMobile platform mobileArgs = withProjectRoot "." $ \root -> do
156208 let srcDir = root </> "src"
209+ configDir = root </> "config"
157210 exists <- liftIO $ doesDirectoryExist srcDir
158211 unless exists $ failWith "ob test should be run inside of a deploy directory"
159− result <- nixBuildAttrWithCache srcDir $ platform <> ".frontend"
160− callProcessAndLogOutput (Notice, Error) $ proc (result </> "bin" </> "deploy") mobileArgs
212+ (nixBuildTarget, extraArgs) <- case platform of
213+ Android -> do
214+ let keystorePath = root </> "android_keystore.jks"
215+ keytoolConfPath = root </> "android_keytool_config.json"
216+ hasKeystore <- liftIO $ doesFileExist keystorePath
217+ when (not hasKeystore) $ do
218+ -- TODO log instructions for how to modify the keystore
219+ putLog Notice $ "Creating keystore: " <> T.pack keystorePath
220+ putLog Notice "Enter a keystore password: "
221+ keyStorePassword <- liftIO $ withEcho False getLine
222+ putLog Notice "Re-enter the keystore password: "
223+ keyStorePassword' <- liftIO $ withEcho False getLine
224+ unless (keyStorePassword' == keyStorePassword) $ failWith "passwords do not match"
225+ let keyToolConf = KeytoolConfig
226+ { _keytoolConfig_keystore = keystorePath
227+ , _keytoolConfig_alias = "obelisk"
228+ , _keytoolConfig_storepass = keyStorePassword
229+ , _keytoolConfig_keypass = keyStorePassword
230+ }
231+ createKeystore root keyToolConf
232+ liftIO $ BSL.writeFile keytoolConfPath $ encode keyToolConf
233+ checkKeytoolConfExist <- liftIO $ doesFileExist keytoolConfPath
234+ unless checkKeytoolConfExist $ failWith "Missing android KeytoolConfig"
235+ keytoolConfContents <- liftIO $ BSL.readFile keytoolConfPath
236+ keyArgs <- case eitherDecode keytoolConfContents :: Either String KeytoolConfig of
237+ Left err -> failWith $ T.pack err
238+ Right conf -> pure
239+ [ "--sign"
240+ , "--store-file", _keytoolConfig_keystore conf
241+ , "--store-password", _keytoolConfig_storepass conf
242+ , "--key-alias", _keytoolConfig_alias conf
243+ , "--key-password", _keytoolConfig_keypass conf
244+ ]
245+ let expr = mconcat
246+ [ "with (import ", toNixPath srcDir, " {});"
247+ , "android.frontend.override (drv: {"
248+ , "isRelease = true;"
249+ , "staticSrc = (passthru.__androidWithConfig ", configDir, ").frontend.staticSrc;"
250+ , "assets = (passthru.__androidWithConfig ", configDir, ").frontend.assets;"
251+ , "})"
252+ ]
253+ return (Target
254+ { _target_path = Nothing
255+ , _target_attr = Nothing
256+ , _target_expr = Just expr
257+ }, keyArgs)
258+ IOS -> do
259+ let expr = mconcat
260+ [ "with (import ", toNixPath srcDir, " {});"
261+ , "ios.frontend.override (_: { staticSrc = (passthru.__iosWithConfig ", toNixPath configDir, ").frontend.staticSrc; })"
262+ ]
263+ return (Target
264+ { _target_path = Nothing
265+ , _target_attr = Nothing
266+ , _target_expr = Just expr
267+ }, [])
268+ result <- nixCmd $ NixCmd_Build $ def
269+ & nixBuildConfig_outLink .~ OutLink_None
270+ & nixCmdConfig_target .~ nixBuildTarget
271+ let mobileArtifact = case platform of
272+ IOS -> "iOS App"
273+ Android -> "Android APK"
274+ putLog Notice $ T.pack $ unwords ["Your recently built", mobileArtifact, "can be found at the following path:", show result]
275+ callProcessAndLogOutput (Notice, Error) $ proc (result </> "bin" </> "deploy") (mobileArgs ++ extraArgs)
276+ where
277+ withEcho showEcho f = bracket
278+ (do
279+ prevEcho <- hGetEcho stdin
280+ hSetEcho stdin showEcho
281+ pure prevEcho
282+ )
283+ (hSetEcho stdin)
284+ (const f)
285+
286+data KeytoolConfig = KeytoolConfig
287+ { _keytoolConfig_keystore :: FilePath
288+ , _keytoolConfig_alias :: String
289+ , _keytoolConfig_storepass :: String
290+ , _keytoolConfig_keypass :: String
291+ } deriving (Show, Generic)
292+
293+instance FromJSON KeytoolConfig
294+instance ToJSON KeytoolConfig
295+
296+createKeystore :: MonadObelisk m => FilePath -> KeytoolConfig -> m ()
297+createKeystore root config =
298+ callProcessAndLogOutput (Notice, Notice) $ setCwd (Just root) $ proc jreKeyToolPath
299+ [ "-genkeypair", "-noprompt"
300+ , "-keystore", _keytoolConfig_keystore config
301+ , "-keyalg", "RSA", "-keysize", "2048"
302+ , "-validity", "1000000"
303+ , "-storepass", _keytoolConfig_storepass config
304+ , "-alias", _keytoolConfig_alias config
305+ , "-keypass", _keytoolConfig_keypass config
306+ ]
161307
162308-- | Simplified deployment configuration mechanism. At one point we may revisit this.
163309writeDeployConfig :: MonadObelisk m => FilePath -> FilePath -> String -> m ()
@@ -169,7 +315,7 @@ readDeployConfig deployDir fname = liftIO $ do
169315
170316verifyHostKey :: MonadObelisk m => FilePath -> FilePath -> String -> m ()
171317verifyHostKey knownHostsPath keyPath hostName =
172− callProcessAndLogOutput (Notice, Warning) $ proc "ssh" $
318+ callProcessAndLogOutput (Notice, Warning) $ proc sshPath $
173319 sshArgs knownHostsPath keyPath True <>
174320 [ "root@" <> hostName
175321 , "-o", "NumberOfPasswordPrompts=0"
lib/command/src/Obelisk/Command/Nix.hs+160−39
@@ -6,47 +6,65 @@
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE Rank2Types #-}
88{-# LANGUAGE ScopedTypeVariables #-}
9+{-# LANGUAGE TemplateHaskell #-}
910{-# LANGUAGE TypeApplications #-}
1011module Obelisk.Command.Nix
11− ( nixBuild
12+ ( Arg (..)
1213 , NixBuildConfig (..)
13− , Target (..)
14+ , nixBuildConfig_common
15+ , nixBuildConfig_outLink
16+ , NixCmd (..)
17+ , nixCmdConfig_args
18+ , nixCmdConfig_builders
19+ , nixCmdConfig_target
20+ , NixCommonConfig (..)
21+ , NixInstantiateConfig (..)
22+ , nixInstantiateConfig_eval
23+ , NixShellConfig (..)
24+ , nixShellConfig_common
25+ , nixShellConfig_pure
26+ , nixShellConfig_run
1427 , OutLink (..)
15− , Arg (..)
28+ , Target (..)
29+ , target_attr
30+ , target_expr
31+ , target_path
32+
1633 , boolArg
34+ , nixCmd
35+ , nixCmdProc
36+ , nixCmdProc'
1737 , rawArg
38+ , runNixShellConfig
1839 , strArg
1940 ) where
2041
42+import Control.Monad (guard)
43+import Control.Lens
44+
2145import Data.Bool (bool)
2246import Data.Default
2347import Data.List (intercalate)
48+import Data.Maybe
2449import Data.Monoid ((<>))
2550import qualified Data.Text as T
26−import System.Process (proc)
2751
2852import Obelisk.App (MonadObelisk)
2953import Obelisk.CliApp
3054
31−-- | Where to put nix-build output
32−data OutLink
33− = OutLink_Default
34− | OutLink_None
35− | OutLink_IndirectRoot FilePath
36−
37−instance Default OutLink where
38− def = OutLink_Default
39−
4055-- | What to build
4156data Target = Target
42− { _target_path :: FilePath
57+ { _target_path :: Maybe FilePath
4358 , _target_attr :: Maybe String
59+ , _target_expr :: Maybe String
4460 }
61+makeClassy ''Target
4562
4663instance Default Target where
4764 def = Target
48− { _target_path = "."
65+ { _target_path = Just "."
4966 , _target_attr = Nothing
67+ , _target_expr = Nothing
5068 }
5169
5270data Arg
@@ -55,10 +73,10 @@ data Arg
5573 deriving (Eq, Show)
5674
5775strArg :: String -> String -> Arg
58−strArg k = Arg_Str k
76+strArg = Arg_Str
5977
6078rawArg :: String -> String -> Arg
61−rawArg k = Arg_Expr k
79+rawArg = Arg_Expr
6280
6381boolArg :: String -> Bool -> Arg
6482boolArg k = Arg_Expr k . bool "false" "true"
@@ -68,36 +86,139 @@ cliFromArgs = concatMap $ \case
6886 Arg_Str k v -> ["--argstr", k, v]
6987 Arg_Expr k v -> ["--arg", k, v]
7088
71−data NixBuildConfig = NixBuildConfig
72− { _nixBuildConfig_target :: Target
73− , _nixBuildConfig_outLink :: OutLink
74− , _nixBuildConfig_args :: [Arg]
75− , _nixBuildConfig_builders :: [String]
89+data NixCommonConfig = NixCommonConfig
90+ { _nixCmdConfig_target :: Target
91+ , _nixCmdConfig_args :: [Arg]
92+ , _nixCmdConfig_builders :: [String]
7693 }
94+makeClassy ''NixCommonConfig
7795
78−instance Default NixBuildConfig where
79− def = NixBuildConfig def def mempty mempty
96+instance Default NixCommonConfig where
97+ def = NixCommonConfig def mempty mempty
8098
81−nixBuild :: MonadObelisk m => NixBuildConfig -> m FilePath
82−nixBuild cfg = withSpinner' ("Running nix-build on " <> desc) (Just $ const $ "Built " <> desc) $ do
83− output <- readProcessAndLogStderr Debug $ proc "nix-build" $ mconcat
84− [[path], attrArg, args, outLink, buildersArg]
85− -- Remove final newline that Nix appends
86− Just (outPath, '\n') <- pure $ T.unsnoc output
87− pure $ T.unpack outPath
99+runNixCommonConfig :: NixCommonConfig -> [String]
100+runNixCommonConfig cfg = mconcat [maybeToList path, attrArg, exprArg, args, buildersArg]
88101 where
89− path = _target_path $ _nixBuildConfig_target cfg
90− attr = _target_attr $ _nixBuildConfig_target cfg
102+ path = _target_path $ _nixCmdConfig_target cfg
103+ attr = _target_attr $ _nixCmdConfig_target cfg
104+ expr = _target_expr $ _nixCmdConfig_target cfg
91105 attrArg = case attr of
92106 Nothing -> []
93107 Just a -> ["-A", a]
94− args = cliFromArgs $ _nixBuildConfig_args cfg
95− outLink = case _nixBuildConfig_outLink cfg of
108+ exprArg = case expr of
109+ Nothing -> []
110+ Just a -> ["-E", a]
111+ args = cliFromArgs $ _nixCmdConfig_args cfg
112+ buildersArg = case _nixCmdConfig_builders cfg of
113+ [] -> []
114+ builders -> ["--builders", intercalate ";" builders]
115+
116+-- | Where to put nix-build output
117+data OutLink
118+ = OutLink_Default
119+ | OutLink_None
120+ | OutLink_IndirectRoot FilePath
121+
122+instance Default OutLink where
123+ def = OutLink_Default
124+
125+data NixBuildConfig = NixBuildConfig
126+ { _nixBuildConfig_common :: NixCommonConfig
127+ , _nixBuildConfig_outLink :: OutLink
128+ }
129+makeLenses ''NixBuildConfig
130+
131+instance HasNixCommonConfig NixBuildConfig where
132+ nixCommonConfig = nixBuildConfig_common
133+
134+instance Default NixBuildConfig where
135+ def = NixBuildConfig def def
136+
137+runNixBuildConfig :: NixBuildConfig -> [String]
138+runNixBuildConfig cfg = mconcat
139+ [ runNixCommonConfig $ cfg ^. nixCommonConfig
140+ , case _nixBuildConfig_outLink cfg of
96141 OutLink_Default -> []
97142 OutLink_None -> ["--no-out-link"]
98143 OutLink_IndirectRoot l -> ["--out-link", l]
99− desc = T.pack $ path <> maybe "" (\a -> " [" <> a <> "]") attr
100− buildersArg = case _nixBuildConfig_builders cfg of
101− [] -> []
102− builders -> ["--builders", intercalate ";" builders]
144+ ]
145+
146+data NixInstantiateConfig = NixInstantiateConfig
147+ { _nixInstantiateConfig_common :: NixCommonConfig
148+ , _nixInstantiateConfig_eval :: Bool
149+ }
150+makeLenses ''NixInstantiateConfig
151+
152+instance HasNixCommonConfig NixInstantiateConfig where
153+ nixCommonConfig = nixInstantiateConfig_common
154+
155+instance Default NixInstantiateConfig where
156+ def = NixInstantiateConfig def False
157+
158+runNixInstantiateConfig :: NixInstantiateConfig -> [String]
159+runNixInstantiateConfig cfg = mconcat
160+ [ runNixCommonConfig $ cfg ^. nixCommonConfig
161+ , "--eval" <$ guard (_nixInstantiateConfig_eval cfg)
162+ ]
163+
164+data NixShellConfig = NixShellConfig
165+ { _nixShellConfig_common :: NixCommonConfig
166+ , _nixShellConfig_pure :: Bool
167+ , _nixShellConfig_run :: Maybe String
168+ }
103169
170+makeLenses ''NixShellConfig
171+
172+instance HasNixCommonConfig NixShellConfig where
173+ nixCommonConfig = nixShellConfig_common
174+
175+instance Default NixShellConfig where
176+ def = NixShellConfig def False Nothing
177+
178+data NixCmd
179+ = NixCmd_Build NixBuildConfig
180+ | NixCmd_Instantiate NixInstantiateConfig
181+
182+instance Default NixCmd where
183+ def = NixCmd_Build def
184+
185+runNixShellConfig :: NixShellConfig -> [String]
186+runNixShellConfig cfg = mconcat
187+ [ runNixCommonConfig $ cfg ^. nixCommonConfig
188+ , [ "--pure" | cfg ^. nixShellConfig_pure ]
189+ ] ++ mconcat [
190+ ["--run", run] | run <- maybeToList $ cfg ^. nixShellConfig_run
191+ ]
192+
193+nixCmdProc :: NixCmd -> ProcessSpec
194+nixCmdProc = fst . nixCmdProc'
195+
196+nixCmdProc' :: NixCmd -> (ProcessSpec, T.Text)
197+nixCmdProc' cmdCfg = (proc (T.unpack cmd) options, cmd)
198+ where
199+ (cmd, options) = case cmdCfg of
200+ NixCmd_Build cfg' ->
201+ ( "nix-build"
202+ , runNixBuildConfig cfg'
203+ )
204+ NixCmd_Instantiate cfg' ->
205+ ( "nix-instantiate"
206+ , runNixInstantiateConfig cfg'
207+ )
208+
209+nixCmd :: MonadObelisk m => NixCmd -> m FilePath
210+nixCmd cmdCfg = withSpinner' (T.unwords $ "Running" : cmd : desc) (Just $ const $ T.unwords $ "Built" : desc) $ do
211+ output <- readProcessAndLogStderr Debug cmdProc
212+ -- Remove final newline that Nix appends
213+ Just (outPath, '\n') <- pure $ T.unsnoc output
214+ pure $ T.unpack outPath
215+ where
216+ (cmdProc, cmd) = nixCmdProc' cmdCfg
217+ commonCfg = case cmdCfg of
218+ NixCmd_Build cfg' -> cfg' ^. nixCommonConfig
219+ NixCmd_Instantiate cfg' -> cfg' ^. nixCommonConfig
220+ path = commonCfg ^. nixCmdConfig_target . target_path
221+ desc = concat $ catMaybes
222+ [ (\x -> ["on", T.pack x]) <$> path
223+ , (\a -> ["[" <> T.pack a <> "]"]) <$> (commonCfg ^. nixCmdConfig_target . target_attr)
224+ ]
lib/command/src/Obelisk/Command/Preprocessor.hsnew file+100
@@ -0,0 +1,100 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+
4+module Obelisk.Command.Preprocessor where
5+
6+import qualified Data.ByteString.Lazy as BL
7+import qualified Data.ByteString.Lazy.Builder as BU
8+import Data.Foldable (for_)
9+import Data.List (intersperse, isPrefixOf, sortOn)
10+import Data.Maybe (fromMaybe)
11+import qualified Data.Text.Lazy.Builder as TL
12+import qualified Data.Text.Lazy.Encoding as TL
13+import Distribution.Compiler (CompilerFlavor (..))
14+import Language.Haskell.Extension (Extension (..), Language(..))
15+import System.Directory (canonicalizePath)
16+import System.IO (IOMode (..), hPutStrLn, stderr, withFile)
17+import System.FilePath (hasTrailingPathSeparator, joinPath, splitPath)
18+
19+import Obelisk.Command.Run (CabalPackageInfo (..), parseCabalPackage')
20+
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.
29+applyPackages :: FilePath -> FilePath -> FilePath -> [FilePath] -> IO ()
30+applyPackages origPath inPath outPath packagePaths' = do
31+ origPathCanonical <- canonicalizePath origPath
32+ packagePaths <- traverse canonicalizePath packagePaths'
33+
34+ let
35+ takeDirs = takeWhile hasTrailingPathSeparator
36+ packageDirs = sortOn (negate . length . takeDirs) $ map splitPath packagePaths
37+ origDir = splitPath origPathCanonical
38+ matches = [ joinPath d | d <- packageDirs, takeDirs d `isPrefixOf` origDir ]
39+
40+ -- The first element of matches is going to be the deepest path to a package spec that contains
41+ -- our file as a subdirectory.
42+ packageInfo' <- case matches of
43+ [] -> do
44+ hPutStrLn stderr $ "Error: Unable to find cabal information for " <> origPath <> "; Skipping preprocessor."
45+ pure Nothing
46+ packagePath:_ -> parseCabalPackage' packagePath >>= \case
47+ Left err -> do
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
51+ Right Nothing -> pure Nothing
52+
53+ writeOutput packageInfo' inPath outPath
54+
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
60+ hPutTextBuilder h = BU.hPutBuilder h . TL.encodeUtf8Builder . TL.toLazyText
61+
62+generateHeader :: FilePath -> CabalPackageInfo -> TL.Builder
63+generateHeader origPath packageInfo =
64+ hsExtensions <> ghcOptions <> lineNumberPragma origPath
65+ where
66+ hsExtensions =
67+ if null extList
68+ then mempty
69+ else pragma $ TL.fromText "LANGUAGE " <> mconcat (intersperse (TL.fromText ", ") extList)
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 :)
76+ ext -> (TL.fromString (show ext) :)
77+ showExt = \case
78+ EnableExtension ext -> [TL.fromString (show ext)]
79+ DisableExtension ext -> ["No" <> TL.fromString (show ext)]
80+ UnknownExtension ext -> [TL.fromString ext]
81+
82+ ghcOptions =
83+ if null optList
84+ then mempty
85+ else pragma $
86+ TL.fromText "OPTIONS_GHC " <> mconcat (intersperse (TL.fromText " ") (map TL.fromString optList))
87+ ghcOptList
88+ = filter (not . isPrefixOf "-O")
89+ $ fromMaybe []
90+ $ lookup GHC (_cabalPackageInfo_compilerOptions packageInfo)
91+ optList = _cabalPackageInfo_cppOptions packageInfo <> ghcOptList
92+
93+lineNumberPragma :: FilePath -> TL.Builder
94+lineNumberPragma origPath = pragma $ TL.fromText "LINE 1 " <> quoted '"' (TL.fromString origPath)
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+203−64
@@ -3,37 +3,56 @@
33{-# LANGUAGE OverloadedStrings #-}
44module Obelisk.Command.Project
55 ( InitSource (..)
6− , initProject
76 , findProjectObeliskCommand
87 , findProjectRoot
9− , withProjectRoot
10− , inProjectShell
11− , inImpureProjectShell
12− , projectShell
13−
14− , toObeliskDir
8+ , findProjectAssets
9+ , initProject
10+ , nixShellRunConfig
11+ , nixShellRunProc
12+ , nixShellWithHoogle
13+ , nixShellWithoutPkgs
14+ , obeliskDirName
1515 , toImplDir
16+ , toObeliskDir
17+ , withProjectRoot
18+ , bashEscape
1619 ) where
1720
21+import Control.Concurrent.MVar (MVar, newMVar, withMVarMasked)
22+import Control.Lens ((.~), (?~), (<&>))
1823import Control.Monad
1924import Control.Monad.IO.Class (liftIO)
2025import Control.Monad.State
26+import qualified Data.Aeson as Json
27+import qualified Data.ByteString.UTF8 as BSU
2128import Data.Bits
22−import Data.Function (on)
29+import qualified Data.ByteString.Lazy as BSL
30+import Data.Default (def)
31+import Data.Function ((&), on)
32+import Data.Map (Map)
33+import Data.Text (Text)
2334import qualified Data.Text as T
35+import Data.Text.Encoding (decodeUtf8, encodeUtf8)
36+import Data.Traversable (for)
2437import System.Directory
38+import System.Environment (lookupEnv)
2539import System.FilePath
2640import System.IO.Temp
27−import System.Posix (FileStatus, UserID, deviceID, fileID, fileMode, fileOwner, getFileStatus, getRealUserID)
28−import System.Posix.Files
29−import System.Process (CreateProcess, cwd, proc, waitForProcess)
41+import System.IO.Unsafe (unsafePerformIO)
42+import System.PosixCompat.Files
43+import System.PosixCompat.Types
44+import System.PosixCompat.User
45+import Text.ShellEscape (bash, bytes)
3046
3147import GitHub.Data.GitData (Branch)
3248import GitHub.Data.Name (Name)
3349
3450import Obelisk.App (MonadObelisk)
3551import Obelisk.CliApp
52+import Obelisk.Command.Nix
3653import Obelisk.Command.Thunk
54+import Obelisk.Command.Utils (nixBuildExePath, nixExePath, toNixPath, cp, nixShellPath)
55+
3756--TODO: Make this module resilient to random exceptions
3857
3958--TODO: Don't hardcode this
@@ -47,17 +66,21 @@ obeliskSourceWithBranch branch = ThunkSource_GitHub $ GitHubSource
4766 { _gitHubSource_owner = "obsidiansystems"
4867 , _gitHubSource_repo = "obelisk"
4968 , _gitHubSource_branch = Just branch
69+ , _gitHubSource_private = False
5070 }
5171
5272data InitSource
53− = InitSource_Default
54− | InitSource_Branch (Name Branch)
55− | InitSource_Symlink FilePath
56− deriving Show
73+ = InitSource_Default
74+ | InitSource_Branch (Name Branch)
75+ | InitSource_Symlink FilePath
76+ deriving Show
77+
78+obeliskDirName :: FilePath
79+obeliskDirName = ".obelisk"
5780
5881-- | Path to obelisk directory in given path
5982toObeliskDir :: FilePath -> FilePath
60−toObeliskDir p = p </> ".obelisk"
83+toObeliskDir p = p </> obeliskDirName
6184
6285-- | Path to impl file in given path
6386toImplDir :: FilePath -> FilePath
@@ -74,20 +97,26 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
7497 | otherwise -> failWith "ob init requires an empty directory. Use the flag --force to init anyway, potentially overwriting files."
7598 skeleton <- withSpinner "Setting up obelisk" $ do
7699 liftIO $ createDirectory obDir
100+ -- Clone the git source and repack it with the init source obelisk
101+ -- The purpose of this is to ensure we use the correct thunk spec.
102+ let cloneAndRepack src = do
103+ putLog Debug $ "Cloning obelisk into " <> T.pack implDir <> " and repacking using itself"
104+ commit <- getLatestRev src
105+ gitCloneForThunkUnpack (thunkSourceToGitSource src) (_thunkRev_commit commit) implDir
106+ callHandoffOb implDir ["thunk", "pack", implDir]
77107 case source of
78− InitSource_Default -> createThunkWithLatest implDir obeliskSource
79− InitSource_Branch branch -> createThunkWithLatest implDir $ obeliskSourceWithBranch branch
108+ InitSource_Default -> cloneAndRepack obeliskSource
109+ InitSource_Branch branch -> cloneAndRepack $ obeliskSourceWithBranch branch
80110 InitSource_Symlink path -> do
81111 let symlinkPath = if isAbsolute path
82112 then path
83113 else ".." </> path
84114 liftIO $ createSymbolicLink symlinkPath implDir
85115 _ <- nixBuildAttrWithCache implDir "command"
86− --TODO: We should probably handoff to the impl here
87116 skel <- nixBuildAttrWithCache implDir "skeleton" --TODO: I don't think there's actually any reason to cache this
88117
89118 callProcessAndLogOutput (Notice, Error) $
90− proc "cp"
119+ proc cp
91120 [ "-r"
92121 , "--preserve=links"
93122 , obDir
@@ -97,7 +126,7 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
97126
98127 withSpinner "Copying project skeleton" $ do
99128 callProcessAndLogOutput (Notice, Error) $
100− proc "cp"
129+ proc cp
101130 [ "-r"
102131 , "--no-preserve=mode"
103132 , "-T"
@@ -108,21 +137,46 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
108137 let configDir = "config"
109138 createDirectoryIfMissing False configDir
110139 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+
147+callHandoffOb
148+ :: MonadObelisk m
149+ => FilePath -- ^ Directory of the obelisk we want to handoff to
150+ -> [String] -- ^ Arguments to pass to ob
151+ -> m ()
152+callHandoffOb dir args = do
153+ obeliskCommandPkg <- nixCmd $ NixCmd_Build $ def
154+ & nixBuildConfig_outLink .~ OutLink_None
155+ & nixCmdConfig_target .~ Target
156+ { _target_path = Just dir
157+ , _target_attr = Just "command"
158+ , _target_expr = Nothing
159+ }
160+ let impl = obeliskCommandPkg </> "bin" </> "ob"
161+ -- Invoke the real implementation, using --no-handoff to prevent infinite recursion
162+ putLog Debug $ "Running '" <> T.pack (unwords args) <> "' with " <> T.pack impl
163+ callProcessAndLogOutput (Debug, Warning) (proc impl ("--no-handoff" : args))
111164
112165--TODO: Allow the user to ignore our security concerns
113166-- | Find the Obelisk implementation for the project at the given path
114167findProjectObeliskCommand :: MonadObelisk m => FilePath -> m (Maybe FilePath)
115168findProjectObeliskCommand target = do
116169 myUid <- liftIO getRealUserID
170+ processUmask <- liftIO getUmask
117171 targetStat <- liftIO $ getFileStatus target
118− (result, insecurePaths) <- flip runStateT [] $ walkToProjectRoot target targetStat myUid >>= \case
172+ (result, insecurePaths) <- flip runStateT [] $ walkToProjectRoot target targetStat processUmask myUid >>= \case
119173 Nothing -> pure Nothing
120174 Just projectRoot -> liftIO (doesDirectoryExist $ toImplDir projectRoot) >>= \case
121175 False -> do
122176 putLog Warning $ "Found obelisk directory in " <> T.pack projectRoot <> " but the implementation (impl) file is missing"
123177 pure Nothing
124178 True -> do
125− walkToImplDir projectRoot myUid -- For security check
179+ walkToImplDir projectRoot myUid processUmask -- For security check
126180 return $ Just projectRoot
127181 case (result, insecurePaths) of
128182 (Just projDir, []) -> do
@@ -133,19 +187,39 @@ findProjectObeliskCommand target = do
133187 putLog Error $ T.unlines
134188 [ "Error: Found a project at " <> T.pack (normalise projDir) <> ", but had to traverse one or more insecure directories to get there:"
135189 , T.unlines $ fmap (T.pack . normalise) insecurePaths
136− , "Please ensure that all of these directories are owned by you and are not writable by anyone else."
190+ , "Please ensure that all of these directories are owned by you, not world-writable, and no more group-writable than permitted by your umask."
137191 ]
138192 return Nothing
139193
194+-- | Get the umask for the Obelisk process.
195+--
196+-- Because of
197+-- http://man7.org/linux/man-pages/man2/umask.2.html#NOTES we have to set the
198+-- umask to read it. We are using 'withMVarMasked' to guarantee that setting and
199+-- reading isn't interrupted by any exception or interleaved with another thread.
200+getUmask :: IO FileMode
201+getUmask = withMVarMasked globalUmaskLock $ \() -> do
202+ initialMask <- setFileCreationMask safeUmask
203+ void (setFileCreationMask initialMask)
204+ pure initialMask
205+ where
206+ safeUmask :: FileMode
207+ safeUmask = CMode 0o22
208+
209+{-# NOINLINE globalUmaskLock #-}
210+globalUmaskLock :: MVar ()
211+globalUmaskLock = unsafePerformIO (newMVar ())
212+
140213-- | Get the FilePath to the containing project directory, if there is one
141214findProjectRoot :: MonadObelisk m => FilePath -> m (Maybe FilePath)
142215findProjectRoot target = do
143216 myUid <- liftIO getRealUserID
144217 targetStat <- liftIO $ getFileStatus target
145− (result, _) <- liftIO $ runStateT (walkToProjectRoot target targetStat myUid) []
146− return result
218+ umask <- liftIO getUmask
219+ (result, _) <- liftIO $ runStateT (walkToProjectRoot target targetStat umask myUid) []
220+ return $ makeRelative "." <$> result
147221
148−withProjectRoot :: MonadObelisk m => FilePath -> (FilePath -> m ()) -> m ()
222+withProjectRoot :: MonadObelisk m => FilePath -> (FilePath -> m a) -> m a
149223withProjectRoot target f = findProjectRoot target >>= \case
150224 Nothing -> failWith "Must be used inside of an Obelisk project"
151225 Just root -> f root
@@ -155,15 +229,15 @@ withProjectRoot target f = findProjectRoot target >>= \case
155229-- traversed in the process. Return the project root directory, if found.
156230walkToProjectRoot
157231 :: (MonadState [FilePath] m, MonadIO m)
158− => FilePath -> FileStatus -> UserID -> m (Maybe FilePath)
159−walkToProjectRoot this thisStat myUid = liftIO (doesDirectoryExist this) >>= \case
232+ => FilePath -> FileStatus -> FileMode -> UserID -> m (Maybe FilePath)
233+walkToProjectRoot this thisStat desiredUmask myUid = liftIO (doesDirectoryExist this) >>= \case
160234 -- It's not a directory, so it can't be a project
161235 False -> do
162236 let dir = takeDirectory this
163237 dirStat <- liftIO $ getFileStatus dir
164− walkToProjectRoot dir dirStat myUid
238+ walkToProjectRoot dir dirStat desiredUmask myUid
165239 True -> do
166− when (not $ isWritableOnlyBy thisStat myUid) $ modify (this:)
240+ when (not $ isWellOwnedAndWellPermissioned thisStat myUid desiredUmask) $ modify (this:)
167241 liftIO (doesDirectoryExist $ toObeliskDir this) >>= \case
168242 True -> return $ Just this
169243 False -> do
@@ -173,44 +247,109 @@ walkToProjectRoot this thisStat myUid = liftIO (doesDirectoryExist this) >>= \ca
173247 isSameFileAs = (==) `on` fileIdentity
174248 if thisStat `isSameFileAs` nextStat
175249 then return Nothing -- Found a cycle; probably hit root directory
176− else walkToProjectRoot next nextStat myUid
250+ else walkToProjectRoot next nextStat desiredUmask myUid
177251
178252-- | Walk from the given project root directory to its Obelisk implementation
179253-- directory, accumulating potentially insecure directories that were traversed
180254-- in the process.
181−walkToImplDir :: (MonadState [FilePath] m, MonadIO m) => FilePath -> UserID -> m ()
182−walkToImplDir projectRoot myUid = do
255+walkToImplDir :: (MonadState [FilePath] m, MonadIO m) => FilePath -> UserID -> FileMode -> m ()
256+walkToImplDir projectRoot myUid umask = do
183257 let obDir = toObeliskDir projectRoot
184258 obDirStat <- liftIO $ getFileStatus obDir
185− when (not $ isWritableOnlyBy obDirStat myUid) $ modify (obDir:)
259+ when (not $ isWellOwnedAndWellPermissioned obDirStat myUid umask) $ modify (obDir:)
186260 let implThunk = obDir </> "impl"
187261 implThunkStat <- liftIO $ getFileStatus implThunk
188− when (not $ isWritableOnlyBy implThunkStat myUid) $ modify (implThunk:)
189−
190−--TODO: Is there a better way to ask if anyone else can write things?
191−--E.g. what about ACLs?
192−-- | Check to see if directory is only writable by a user whose User ID matches the second argument provided
193−isWritableOnlyBy :: FileStatus -> UserID -> Bool
194−isWritableOnlyBy s uid = fileOwner s == uid && fileMode s .&. 0o22 == 0
195−
196−-- | Run a command in the given shell for the current project
197−inProjectShell :: MonadObelisk m => String -> String -> m ()
198−inProjectShell shellName command = withProjectRoot "." $ \root ->
199− projectShell root True shellName command
200−
201−inImpureProjectShell :: MonadObelisk m => String -> String -> m ()
202−inImpureProjectShell shellName command = withProjectRoot "." $ \root ->
203− projectShell root False shellName command
204−
205−projectShell :: MonadObelisk m => FilePath -> Bool -> String -> String -> m ()
206−projectShell root isPure shellName command = do
207− (_, _, _, ph) <- createProcess_ "runNixShellAttr" $ setCwd (Just root) $ proc "nix-shell" $
208− [ "--pure" | isPure ] <>
209− [ "-A"
210− , "shells." <> shellName
211− , "--run", command
212− ]
213− void $ liftIO $ waitForProcess ph
214−
215−setCwd :: Maybe FilePath -> CreateProcess -> CreateProcess
216−setCwd fp cfg = cfg { cwd = fp }
262+ when (not $ isWellOwnedAndWellPermissioned implThunkStat myUid umask) $ modify (implThunk:)
263+
264+-- | Check to see if directory is writable by a user whose User ID matches the
265+-- second argument provided, and if the fact that other people can write to that
266+-- directory is in accordance with the umask of the system, passed as the third
267+-- argument.
268+isWellOwnedAndWellPermissioned :: FileStatus -> UserID -> FileMode -> Bool
269+isWellOwnedAndWellPermissioned s uid umask = isOwnedBy s uid && filePermissionIsSafe s umask
270+
271+isOwnedBy :: FileStatus -> UserID -> Bool
272+isOwnedBy s uid = fileOwner s == uid
273+
274+-- | Check to see if a directory respect the umask, but check explicitly that
275+-- it's not world writable in any case.
276+filePermissionIsSafe :: FileStatus -> FileMode -> Bool
277+filePermissionIsSafe s umask = not fileWorldWritable && fileGroupWritable <= umaskGroupWritable
278+ where
279+ fileWorldWritable = fileMode s .&. 0o002 == 0o002
280+ fileGroupWritable = fileMode s .&. 0o020 == 0o020
281+ umaskGroupWritable = umask .&. 0o020 == 0
282+
283+nixShellRunConfig :: MonadObelisk m => FilePath -> Bool -> Maybe String -> m NixShellConfig
284+nixShellRunConfig root isPure command = do
285+ nixpkgsPath <- fmap T.strip $ readProcessAndLogStderr Debug $ setCwd (Just root) $
286+ proc nixExePath ["eval", "(import .obelisk/impl {}).nixpkgs.path"]
287+ nixRemote <- liftIO $ lookupEnv "NIX_REMOTE"
288+ pure $ def
289+ & nixShellConfig_pure .~ isPure
290+ & nixShellConfig_common . nixCmdConfig_target .~ (def & target_path .~ Nothing)
291+ & nixShellConfig_run .~ (command <&> \cs -> unwords $ concat
292+ [ ["export", BSU.toString . bytes . bash $ "NIX_PATH=nixpkgs=" <> encodeUtf8 nixpkgsPath, ";"]
293+ , maybe [] (\v -> ["export", BSU.toString . bytes . bash $ "NIX_REMOTE=" <> encodeUtf8 (T.pack v), ";"]) nixRemote
294+ , [cs]
295+ ])
296+
297+bashEscape :: String -> String
298+bashEscape = BSU.toString . bytes . bash . BSU.fromString
299+
300+nixShellRunProc :: NixShellConfig -> ProcessSpec
301+nixShellRunProc cfg = setDelegateCtlc True $ proc nixShellPath $ runNixShellConfig cfg
302+
303+nixShellWithoutPkgs
304+ :: MonadObelisk m
305+ => FilePath -- ^ Path to project root
306+ -> Bool -- ^ Should this be a pure shell?
307+ -> Bool -- ^ Should we chdir to the package root in the shell?
308+ -> Map Text FilePath -- ^ Package names mapped to their paths
309+ -> String -- ^ Shell attribute to use (e.g. @"ghc"@, @"ghcjs"@, etc.)
310+ -> Maybe String -- ^ If 'Just' run the given command; otherwise just open the interactive shell
311+ -> m ()
312+nixShellWithoutPkgs root isPure chdirToRoot packageNamesAndPaths shellAttr command = do
313+ packageNamesAndAbsPaths <- liftIO $ for packageNamesAndPaths makeAbsolute
314+ defShellConfig <- nixShellRunConfig root isPure command
315+ let setCwd_ = if chdirToRoot then setCwd (Just root) else id
316+ runProcess_ $ setCwd_ $ nixShellRunProc $ defShellConfig
317+ & nixShellConfig_common . nixCmdConfig_target . target_expr ?~
318+ "{root, pkgs, shell}: ((import root {}).passthru.__unstable__.self.extend (_: _: {\
319+ \shellPackages = builtins.fromJSON pkgs;\
320+ \})).project.shells.${shell}"
321+ & nixShellConfig_common . nixCmdConfig_args .~
322+ [ rawArg "root" $ toNixPath $ if chdirToRoot then "." else root
323+ , strArg "pkgs" (T.unpack $ decodeUtf8 $ BSL.toStrict $ Json.encode packageNamesAndAbsPaths)
324+ , strArg "shell" shellAttr
325+ ]
326+
327+nixShellWithHoogle :: MonadObelisk m => FilePath -> Bool -> String -> Maybe String -> m ()
328+nixShellWithHoogle root isPure shell' command = do
329+ defShellConfig <- nixShellRunConfig root isPure command
330+ runProcess_ $ setCwd (Just root) $ nixShellRunProc $ defShellConfig
331+ & nixShellConfig_common . nixCmdConfig_target . target_expr ?~
332+ "{shell}: ((import ./. {}).passthru.__unstable__.self.extend (_: super: {\
333+ \userSettings = super.userSettings // { withHoogle = true; };\
334+ \})).project.shells.${shell}"
335+ & nixShellConfig_common . nixCmdConfig_args .~ [ strArg "shell" shell' ]
336+
337+findProjectAssets :: MonadObelisk m => FilePath -> m Text
338+findProjectAssets root = do
339+ isDerivation <- readProcessAndLogStderr Debug $ setCwd (Just root) $
340+ proc nixExePath
341+ [ "eval"
342+ , "(let a = import ./. {}; in toString (a.reflex.nixpkgs.lib.isDerivation a.passthru.staticFilesImpure))"
343+ , "--raw"
344+ -- `--raw` is not available with old nix-instantiate. It drops quotation
345+ -- marks and trailing newline, so is very convenient for shelling out.
346+ ]
347+ -- Check whether the impure static files are a derivation (and so must be built)
348+ if isDerivation == "1"
349+ then fmap T.strip $ readProcessAndLogStderr Debug $ setCwd (Just root) $ -- Strip whitespace here because nix-build has no --raw option
350+ proc nixBuildExePath
351+ [ "--no-out-link"
352+ , "-E", "(import ./. {}).passthru.staticFilesImpure"
353+ ]
354+ else readProcessAndLogStderr Debug $ setCwd (Just root) $
355+ proc nixExePath ["eval", "-f", ".", "passthru.staticFilesImpure", "--raw"]
lib/command/src/Obelisk/Command/Run.hs+504−140
@@ -1,190 +1,554 @@
1+{-# LANGUAGE DeriveFoldable #-}
2+{-# LANGUAGE DeriveFunctor #-}
3+{-# LANGUAGE DeriveTraversable #-}
14{-# LANGUAGE FlexibleContexts #-}
25{-# LANGUAGE LambdaCase #-}
36{-# LANGUAGE MultiParamTypeClasses #-}
47{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE QuasiQuotes #-}
59{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TupleSections #-}
11+{-# LANGUAGE ViewPatterns #-}
612module Obelisk.Command.Run where
713
8−import Control.Exception (bracket)
9−import Control.Monad
14+import Control.Arrow ((&&&))
15+import Control.Exception (Exception, bracket)
16+import Control.Lens (ifor, (.~), (&))
17+import Control.Monad (filterM)
18+import Control.Monad.Except (runExceptT, throwError)
1019import Control.Monad.IO.Class (liftIO)
1120import Control.Monad.Reader (MonadIO)
12−import Data.Either
13−import Data.List
14−import Data.List.NonEmpty as NE
15−import Data.Maybe
21+import Data.Bifoldable (bifoldr1)
22+import Data.Bifunctor (bimap)
23+import Data.Coerce (coerce)
24+import Data.Default (def)
25+import Data.Either (partitionEithers)
26+import Data.Foldable (fold, for_, toList)
27+import Data.Functor.Identity (runIdentity)
28+import Data.List (intercalate)
29+import Data.List.NonEmpty (NonEmpty)
30+import qualified Data.List.NonEmpty as NE
31+import Data.Map (Map)
32+import qualified Data.Map as Map
33+import qualified Data.Map.Monoidal as MMap
34+import Data.Maybe (catMaybes, fromMaybe, mapMaybe)
35+import Data.Ord (comparing)
36+import Data.Set (Set)
37+import qualified Data.Set as Set
38+import Data.String.Here.Interpolated (i)
39+import Data.Text (Text)
1640import qualified Data.Text as T
41+import Data.Time.Clock (getCurrentTime)
42+import Data.Time.Format (formatTime, defaultTimeLocale)
43+import Data.Traversable (for)
44+import Debug.Trace (trace)
45+import Distribution.Compiler (CompilerFlavor(..))
1746import Distribution.PackageDescription.Parsec (parseGenericPackageDescription)
1847import Distribution.Parsec.ParseResult (runParseResult)
19−import Distribution.Pretty
20−import Distribution.Types.BuildInfo
21−import Distribution.Types.CondTree
22−import Distribution.Types.GenericPackageDescription
23−import Distribution.Types.Library
24−import Distribution.Utils.Generic
25−import Hpack.Config
26−import Hpack.Render
27−import Hpack.Yaml
28−import Language.Haskell.Extension
29−import Network.Socket
48+import qualified Distribution.System as Dist
49+import Distribution.Types.BuildInfo (buildable, cppOptions, defaultExtensions, defaultLanguage, hsSourceDirs, options)
50+import Distribution.Types.CondTree (simplifyCondTree)
51+import Distribution.Types.GenericPackageDescription (ConfVar (Arch, Impl, OS), condLibrary)
52+import Distribution.Types.Library (libBuildInfo)
53+import Distribution.Utils.Generic (toUTF8BS, readUTF8File)
54+import qualified Distribution.Parsec.Common as Dist
55+import qualified Hpack.Config as Hpack
56+import qualified Hpack.Render as Hpack
57+import qualified Hpack.Yaml as Hpack
58+import Language.Haskell.Extension (Extension, Language)
59+import qualified Network.Socket as Socket
3060import System.Directory
61+import System.Environment (getExecutablePath)
3162import System.FilePath
63+import qualified System.Info
3264import System.IO.Temp (withSystemTempDirectory)
33−import Data.ByteString (ByteString)
3465
35−import Obelisk.App (MonadObelisk, ObeliskT)
36−import Obelisk.CliApp (CliT (..), HasCliConfig, Severity (..), callCommand, failWith, getCliConfig, putLog,
37− runCli)
38−import Obelisk.Command.Project (inProjectShell)
66+import Obelisk.App (MonadObelisk)
67+import Obelisk.CliApp (
68+ Severity (..),
69+ failWith,
70+ proc,
71+ putLog,
72+ readCreateProcessWithExitCode,
73+ readProcessAndLogStderr,
74+ runProcess_,
75+ setCwd,
76+ setDelegateCtlc,
77+ withSpinner,
78+ )
79+import Obelisk.Command.Nix
80+import Obelisk.Command.Project (nixShellWithoutPkgs, withProjectRoot, findProjectAssets, bashEscape)
81+import Obelisk.Command.Thunk (attrCacheFileName)
82+import Obelisk.Command.Utils (findExePath, ghcidExePath)
3983
4084data CabalPackageInfo = CabalPackageInfo
41− { _cabalPackageInfo_packageRoot :: FilePath
85+ { _cabalPackageInfo_packageFile :: FilePath
86+ , _cabalPackageInfo_packageName :: T.Text
87+ , _cabalPackageInfo_packageRoot :: FilePath
88+ , _cabalPackageInfo_buildable :: Bool
4289 , _cabalPackageInfo_sourceDirs :: NE.NonEmpty FilePath
4390 -- ^ List of hs src dirs of the library component
4491 , _cabalPackageInfo_defaultExtensions :: [Extension]
4592 -- ^ List of globally enable extensions of the library component
93+ , _cabalPackageInfo_defaultLanguage :: Maybe Language
94+ -- ^ List of globally set languages of the library component
95+ , _cabalPackageInfo_compilerOptions :: [(CompilerFlavor, [String])]
96+ -- ^ 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)
4699 }
47100
48−-- NOTE: `run` is not polymorphic like the rest because we use StaticPtr to invoke it.
49−run :: ObeliskT IO ()
50−run = do
51− pkgs <- getLocalPkgs
52− withGhciScript pkgs $ \dotGhciPath -> do
53− freePort <- getFreePort
54− runGhcid dotGhciPath $ Just $ unwords ["run", show freePort, "(runServeAsset Obelisk.Generated.Static.staticRootPath)", "Backend.backend", "Frontend.frontend"]
55−
56−runRepl :: MonadObelisk m => m ()
57−runRepl = do
58− pkgs <- getLocalPkgs
59− withGhciScript pkgs $ \dotGhciPath -> do
60− runGhciRepl dotGhciPath
61−
62−runWatch :: MonadObelisk m => m ()
63−runWatch = do
64− pkgs <- getLocalPkgs
65− withGhciScript pkgs $ \dotGhciPath -> runGhcid dotGhciPath Nothing
66−
67−-- | Relative paths to local packages of an obelisk project
68−-- TODO a way to query this
69−getLocalPkgs :: Applicative f => f [FilePath]
70−getLocalPkgs = pure ["backend", "common", "frontend"]
101+-- | 'Bool' with a better name for its purpose.
102+data Interpret = Interpret_Interpret | Interpret_NoInterpret deriving (Eq, Ord, Show)
71103
104+textInterpret :: Interpret -> Text
105+textInterpret = \case
106+ Interpret_Interpret -> "Interpret"
107+ Interpret_NoInterpret -> "NoInterpret"
108+
109+-- | Describe a set of 'FilePath's as a tree to facilitate merging them in a convenient way.
110+data PathTree a = PathTree_Node
111+ (Maybe a) -- An optional leaf at this point in the tree
112+ (Map FilePath (PathTree a)) -- Branches to deeper leaves
113+ deriving (Eq, Ord, Show, Functor, Foldable, Traversable)
114+
115+-- | 2D ASCII drawing of a 'PathTree'. Adapted from Data.Tree.draw.
116+drawPathTree :: (a -> Text) -> PathTree a -> Text
117+drawPathTree showA (PathTree_Node _ ts0) = T.intercalate "\n" $ goForest (Map.toList ts0)
118+ where
119+ annotated ma = maybe id (\a b -> b <> " [" <> showA a <> "]") ma . T.pack
120+ goTree (fp, PathTree_Node ma forest) = annotated ma fp : goForest (Map.toList forest)
121+ goForest [] = []
122+ goForest [tree] = shift "└─ " " " (goTree tree)
123+ goForest (tree:forest) = shift "├─ " "│ " (goTree tree) <> goForest forest
124+ shift first other = zipWith (<>) (first : repeat other)
125+
126+-- | Used to signal to obelisk that it's being invoked as a preprocessor
127+preprocessorIdentifier :: String
128+preprocessorIdentifier = "__preprocessor-apply-packages"
129+
130+profile
131+ :: MonadObelisk m
132+ => String
133+ -> [String]
134+ -> m ()
135+profile profileBasePattern rtsFlags = withProjectRoot "." $ \root -> do
136+ putLog Debug "Using profiled build of project."
137+
138+ outPath <- withSpinner "Building profiled executable" $
139+ fmap (T.unpack . T.strip) $ readProcessAndLogStderr Debug $ setCwd (Just root) $ nixCmdProc $
140+ NixCmd_Build $ def
141+ & nixBuildConfig_outLink .~ OutLink_None
142+ & nixCmdConfig_target .~ Target
143+ { _target_path = Just "."
144+ , _target_attr = Just "__unstable__.profiledObRun"
145+ , _target_expr = Nothing
146+ }
147+ assets <- findProjectAssets root
148+ putLog Debug $ "Assets impurely loaded from: " <> assets
149+ time <- liftIO getCurrentTime
150+ let profileBaseName = formatTime defaultTimeLocale profileBasePattern time
151+ liftIO $ createDirectoryIfMissing True $ takeDirectory $ root </> profileBaseName
152+ putLog Debug $ "Storing profiled data under base name of " <> T.pack (root </> profileBaseName)
153+ freePort <- getFreePort
154+ runProcess_ $ setCwd (Just root) $ setDelegateCtlc True $ proc (outPath </> "bin" </> "ob-run") $
155+ [ show freePort
156+ , T.unpack assets
157+ , profileBaseName
158+ , "+RTS"
159+ , "-po" <> profileBaseName
160+ ] <> rtsFlags
161+ <> [ "-RTS" ]
162+
163+run :: MonadObelisk m => FilePath -> PathTree Interpret -> m ()
164+run root interpretPaths = do
165+ pkgs <- getParsedLocalPkgs root interpretPaths
166+ assets <- findProjectAssets root
167+ putLog Debug $ "Assets impurely loaded from: " <> assets
168+ ghciArgs <- getGhciSessionSettings pkgs root True
169+ freePort <- getFreePort
170+ withGhciScriptArgs pkgs $ \dotGhciArgs -> do
171+ runGhcid root True (ghciArgs <> dotGhciArgs) pkgs $ Just $ unwords
172+ [ "Obelisk.Run.run"
173+ , show freePort
174+ , "(Obelisk.Run.runServeAsset " ++ show assets ++ ")"
175+ , "Backend.backend"
176+ , "Frontend.frontend"
177+ ]
178+
179+runRepl :: MonadObelisk m => FilePath -> PathTree Interpret -> m ()
180+runRepl root interpretPaths = do
181+ pkgs <- getParsedLocalPkgs root interpretPaths
182+ ghciArgs <- getGhciSessionSettings pkgs "." True
183+ withGhciScriptArgs pkgs $ \dotGhciArgs ->
184+ runGhciRepl root pkgs (ghciArgs <> dotGhciArgs)
185+
186+runWatch :: MonadObelisk m => FilePath -> PathTree Interpret -> m ()
187+runWatch root interpretPaths = do
188+ pkgs <- getParsedLocalPkgs root interpretPaths
189+ ghciArgs <- getGhciSessionSettings pkgs root True
190+ withGhciScriptArgs pkgs $ \dotGhciArgs ->
191+ runGhcid root True (ghciArgs <> dotGhciArgs) pkgs Nothing
192+
193+exportGhciConfig :: MonadObelisk m => Bool -> FilePath -> PathTree Interpret -> m [String]
194+exportGhciConfig useRelativePaths root interpretPaths = do
195+ pkgs <- getParsedLocalPkgs root interpretPaths
196+ getGhciSessionSettings pkgs "." useRelativePaths
197+
198+nixShellForInterpretPaths :: MonadObelisk m => Bool -> String -> FilePath -> PathTree Interpret -> Maybe String -> m ()
199+nixShellForInterpretPaths isPure shell root interpretPaths cmd = do
200+ pkgs <- getParsedLocalPkgs root interpretPaths
201+ nixShellWithoutPkgs root isPure False (packageInfoToNamePathMap pkgs) shell cmd
202+
203+-- | Like 'getLocalPkgs' but also parses them and fails if any of them can't be parsed.
204+getParsedLocalPkgs :: MonadObelisk m => FilePath -> PathTree Interpret -> m (NonEmpty CabalPackageInfo)
205+getParsedLocalPkgs root interpretPaths = parsePackagesOrFail =<< getLocalPkgs root interpretPaths
206+
207+-- | Relative paths to local packages of an obelisk project.
208+--
209+-- These are a combination of the obelisk predefined local packages,
210+-- and any packages that the user has set with the @packages@ argument
211+-- to the Nix @project@ function.
212+getLocalPkgs :: forall m. MonadObelisk m => FilePath -> PathTree Interpret -> m (Set FilePath)
213+getLocalPkgs root interpretPaths = do
214+ putLog Debug $ [i|Finding packages with root ${root} and interpret paths:|] <> "\n" <> drawPathTree textInterpret interpretPaths
215+ obeliskPackagePaths <- runFind ["-L", root, "-name", ".obelisk", "-type", "d"]
216+
217+ -- We do not want to find packages that are embedded inside other obelisk projects, unless that
218+ -- obelisk project is our own.
219+ obeliskPackageExclusions <- liftIO $ fmap Set.fromList $ traverse canonicalizePath $
220+ filter (/= root) $ map takeDirectory obeliskPackagePaths
221+ putLog Debug [i|Excluding obelisk packages: ${T.pack $ unwords $ Set.toList obeliskPackageExclusions}|]
222+ let rootsAndExclusions = calcIntepretFinds "" interpretPaths
223+
224+ fmap fold $ for (MMap.toAscList rootsAndExclusions) $ \(interpretPathRoot, exclusions) ->
225+ let allExclusions = obeliskPackageExclusions <> exclusions <> Set.singleton ("*" </> attrCacheFileName)
226+ in fmap (Set.fromList . map normalise) $ runFind $
227+ ["-L", interpretPathRoot, "(", "-name", "*.cabal", "-o", "-name", Hpack.packageConfig, ")", "-a", "-type", "f"]
228+ <> concat [["-not", "-path", p </> "*"] | p <- toList allExclusions]
229+ where
230+ runFind args = do
231+ (_exitCode, out, err) <- readCreateProcessWithExitCode $ proc findExePath args
232+ putLog Debug $ T.strip $ T.pack err
233+ pure $ map T.unpack $ T.lines $ T.strip $ T.pack out
234+
235+-- | Calculates a set of root 'FilePath's along with each one's corresponding set of exclusions.
236+-- This is used when constructing a set of @find@ commands to run to produce a set of packages
237+-- that matches the user's @--interpret@/@--no-interpret@ settings.
238+calcIntepretFinds :: FilePath -> PathTree Interpret -> MMap.MonoidalMap FilePath (Set FilePath)
239+calcIntepretFinds treeRoot0 tree0 = runIdentity $ go treeRoot0 tree0
240+ where
241+ go treeRoot tree = foldPathTreeFor (== Interpret_Interpret) treeRoot tree $ \parent children -> do
242+ exclusions <- foldPathTreeFor (== Interpret_NoInterpret) parent children $ \parent' children' ->
243+ pure $ Map.singleton parent' children'
244+ deeperFinds <- Map.traverseWithKey go exclusions
245+ pure $ MMap.singleton parent (Map.keysSet exclusions) <> fold (MMap.MonoidalMap deeperFinds)
246+
247+-- | Traverses a 'PathTree' and folds all leaves matching a given predicate.
248+foldPathTreeFor
249+ :: forall m a b. (Applicative m, Monoid b)
250+ => (a -> Bool)
251+ -> FilePath
252+ -> PathTree a
253+ -> (FilePath -> PathTree a -> m b)
254+ -> m b
255+foldPathTreeFor predicate parent children f = case children of
256+ PathTree_Node (Just x) children' | predicate x -> f parent (PathTree_Node Nothing children')
257+ PathTree_Node _ children' -> fmap fold $ flip Map.traverseWithKey children' $ \k children'' ->
258+ foldPathTreeFor predicate (parent </> k) children'' f
259+
260+data GuessPackageFileError = GuessPackageFileError_Ambiguous [FilePath] | GuessPackageFileError_NotFound
261+ deriving (Eq, Ord, Show)
262+instance Exception GuessPackageFileError
263+
264+newtype HPackFilePath = HPackFilePath { unHPackFilePath :: FilePath } deriving (Eq, Ord, Show)
265+newtype CabalFilePath = CabalFilePath { unCabalFilePath :: FilePath } deriving (Eq, Ord, Show)
266+
267+-- | Given a directory, try to guess what the appropriate @.cabal@ or @package.yaml@ file is for the package.
268+guessCabalPackageFile
269+ :: (MonadIO m)
270+ => FilePath -- ^ Directory or path to search for cabal package
271+ -> m (Either GuessPackageFileError (Either CabalFilePath HPackFilePath))
272+guessCabalPackageFile pkg = do
273+ liftIO (doesDirectoryExist pkg) >>= \case
274+ False -> case cabalOrHpackFile pkg of
275+ (Just hpack@(Right _)) -> pure $ Right hpack
276+ (Just cabal@(Left (CabalFilePath cabalFilePath))) -> do
277+ -- If the cabal file has a sibling hpack file, we use that instead
278+ -- since running hpack often generates a sibling cabal file
279+ let possibleHpackSibling = takeDirectory cabalFilePath </> Hpack.packageConfig
280+ hasHpackSibling <- liftIO $ doesFileExist possibleHpackSibling
281+ pure $ Right $ if hasHpackSibling then Right (HPackFilePath possibleHpackSibling) else cabal
282+ Nothing -> pure $ Left GuessPackageFileError_NotFound
283+ True -> do
284+ candidates <- liftIO $
285+ filterM (doesFileExist . either unCabalFilePath unHPackFilePath)
286+ =<< mapMaybe (cabalOrHpackFile . (pkg </>)) <$> listDirectory pkg
287+ pure $ case partitionEithers candidates of
288+ ([hpack], _) -> Right $ Left hpack
289+ ([], [cabal]) -> Right $ Right cabal
290+ ([], []) -> Left GuessPackageFileError_NotFound
291+ (hpacks, cabals) -> Left $ GuessPackageFileError_Ambiguous $ coerce hpacks <> coerce cabals
292+
293+cabalOrHpackFile :: FilePath -> Maybe (Either CabalFilePath HPackFilePath)
294+cabalOrHpackFile = \case
295+ x | takeExtension x == ".cabal" -> Just (Left $ CabalFilePath x)
296+ | takeFileName x == Hpack.packageConfig -> Just (Right $ HPackFilePath x)
297+ | otherwise -> Nothing
298+
299+-- | Parses the cabal package in a given directory.
300+-- This automatically figures out which .cabal file or package.yaml (hpack) file to use in the given directory.
72301parseCabalPackage
73− :: (MonadObelisk m)
74− => FilePath -- ^ package directory
302+ :: MonadObelisk m
303+ => FilePath -- ^ Package directory
75304 -> m (Maybe CabalPackageInfo)
76−parseCabalPackage dir = do
77− let cabalFp = dir </> (takeBaseName dir <> ".cabal")
78− hpackFp = dir </> "package.yaml"
79− hasCabal <- liftIO $ doesFileExist cabalFp
80− hasHpack <- liftIO $ doesFileExist hpackFp
81−
82− mCabalContents <- if hasCabal
83− then Just <$> liftIO (readUTF8File cabalFp)
84− else if hasHpack
85− then do
86− let decodeOptions = DecodeOptions hpackFp Nothing decodeYaml
87− liftIO (readPackageConfig decodeOptions) >>= \case
88− Left err -> do
89− putLog Error $ T.pack $ "Failed to parse " <> hpackFp <> ": " <> err
90− return Nothing
91− Right (DecodeResult hpackPackage _ _) -> do
92− return $ Just $ renderPackage [] hpackPackage
93− else return Nothing
94−
95− fmap join $ forM mCabalContents $ \cabalContents -> do
96− let (warnings, result) = runParseResult $ parseGenericPackageDescription $
97− toUTF8BS $ cabalContents
98− mapM_ (putLog Warning) $ fmap (T.pack . show) warnings
99− case result of
100− Right gpkg -> do
101− return $ do
102− (_, lib) <- simplifyCondTree (const $ pure True) <$> condLibrary gpkg
103− pure $ CabalPackageInfo
104− { _cabalPackageInfo_packageRoot = takeDirectory cabalFp
105− , _cabalPackageInfo_sourceDirs =
106− fromMaybe (pure ".") $ NE.nonEmpty $ hsSourceDirs $ libBuildInfo lib
107− , _cabalPackageInfo_defaultExtensions =
108− defaultExtensions $ libBuildInfo lib
109− }
110− Left (_, errors) -> do
111− putLog Error $ T.pack $ "Failed to parse " <> cabalFp <> ":"
112− mapM_ (putLog Error) $ fmap (T.pack . show) errors
113− return Nothing
114−
115−withUTF8FileContentsM :: (MonadIO m, HasCliConfig e m) => FilePath -> (ByteString -> CliT e IO a) -> m a
116−withUTF8FileContentsM fp f = do
117− c <- getCliConfig
118− liftIO $ withUTF8FileContents fp $ runCli c . f . toUTF8BS
305+parseCabalPackage dir = parseCabalPackage' dir >>= \case
306+ Left err -> Nothing <$ putLog Error err
307+ Right (Just (warnings, pkgInfo)) -> do
308+ for_ warnings $ putLog Warning . T.pack . show
309+ pure $ Just pkgInfo
310+ Right Nothing -> pure Nothing
311+
312+-- | Like 'parseCabalPackage' but returns errors and warnings directly so as to avoid 'MonadObelisk'.
313+parseCabalPackage'
314+ :: (MonadIO m)
315+ => FilePath -- ^ Package directory
316+ -> m (Either T.Text (Maybe ([Dist.PWarning], CabalPackageInfo)))
317+parseCabalPackage' pkg = runExceptT $ do
318+ (cabalContents, packageFile, packageName) <- guessCabalPackageFile pkg >>= \case
319+ Left GuessPackageFileError_NotFound -> throwError $ "No .cabal or package.yaml file found in " <> T.pack pkg
320+ Left (GuessPackageFileError_Ambiguous _) -> throwError $ "Unable to determine which .cabal file to use in " <> T.pack pkg
321+ Right (Left (CabalFilePath file)) -> (, file, takeBaseName file) <$> liftIO (readUTF8File file)
322+ Right (Right (HPackFilePath file)) -> do
323+ let
324+ decodeOptions = Hpack.DecodeOptions (Hpack.ProgramName "ob") file Nothing Hpack.decodeYaml
325+ liftIO (Hpack.readPackageConfig decodeOptions) >>= \case
326+ Left err -> throwError $ T.pack $ "Failed to parse " <> file <> ": " <> err
327+ Right (Hpack.DecodeResult hpackPackage _ _ _) -> pure (Hpack.renderPackage [] hpackPackage, file, Hpack.packageName hpackPackage)
328+
329+ let
330+ (warnings, result) = runParseResult $ parseGenericPackageDescription $ toUTF8BS cabalContents
331+ osConfVar = case System.Info.os of
332+ "linux" -> Just Dist.Linux
333+ "darwin" -> Just Dist.OSX
334+ _ -> trace "Unrecgonized System.Info.os" Nothing
335+ archConfVar = Just Dist.X86_64 -- TODO: Actually infer this
336+ evalConfVar v = Right $ case v of
337+ OS osVar -> Just osVar == osConfVar
338+ Arch archVar -> Just archVar == archConfVar
339+ Impl GHC _ -> True -- TODO: Actually check version range
340+ _ -> False
341+ case condLibrary <$> result of
342+ Right (Just condLib) -> do
343+ let (_, lib) = simplifyCondTree evalConfVar condLib
344+ pure $ Just $ (warnings,) $ CabalPackageInfo
345+ { _cabalPackageInfo_packageName = T.pack packageName
346+ , _cabalPackageInfo_packageFile = packageFile
347+ , _cabalPackageInfo_packageRoot = takeDirectory packageFile
348+ , _cabalPackageInfo_buildable = buildable $ libBuildInfo lib
349+ , _cabalPackageInfo_sourceDirs =
350+ fromMaybe (pure ".") $ NE.nonEmpty $ hsSourceDirs $ libBuildInfo lib
351+ , _cabalPackageInfo_defaultExtensions =
352+ defaultExtensions $ libBuildInfo lib
353+ , _cabalPackageInfo_defaultLanguage =
354+ defaultLanguage $ libBuildInfo lib
355+ , _cabalPackageInfo_compilerOptions = options $ libBuildInfo lib
356+ , _cabalPackageInfo_cppOptions = cppOptions $ libBuildInfo lib
357+ }
358+ Right Nothing -> pure Nothing
359+ Left (_, errors) ->
360+ throwError $ T.pack $ "Failed to parse " <> packageFile <> ":\n" <> unlines (map show errors)
361+
362+parsePackagesOrFail :: (MonadObelisk m, Foldable f) => f FilePath -> m (NE.NonEmpty CabalPackageInfo)
363+parsePackagesOrFail dirs' = do
364+ packageInfos' <- fmap catMaybes $ for dirs $ \dir -> do
365+ flip fmap (parseCabalPackage dir) $ \case
366+ Just packageInfo
367+ | _cabalPackageInfo_buildable packageInfo -> Just packageInfo
368+ _ -> Nothing
369+
370+ -- 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))
372+ $ Map.fromListWith (<>) [(_cabalPackageInfo_packageName p, p NE.:| []) | p <- packageInfos']
373+ unambiguous <- ifor packagesByName $ \packageName ps -> case ps of
374+ p NE.:| [] -> pure p -- No ambiguity here
375+ p NE.:| _ -> do
376+ let chosenText = " [Chosen] "
377+ prefix p'
378+ | _cabalPackageInfo_packageFile p' == _cabalPackageInfo_packageFile p = chosenText
379+ | otherwise = T.map (const ' ') chosenText
380+ putLog Warning $ T.unlines $
381+ "Packages named '" <> packageName <> "' appear in " <> T.pack (show $ length ps) <> " different locations: "
382+ : map (\p' -> prefix p' <> T.pack (_cabalPackageInfo_packageFile p')) (toList ps)
383+ pure p
384+
385+ packageInfos <- case NE.nonEmpty $ toList unambiguous of
386+ Nothing -> failWith $ T.pack $
387+ "No valid, buildable packages found" <> (if null dirs then "" else " in " <> intercalate ", " dirs)
388+ Just xs -> pure xs
389+
390+ pure packageInfos
391+ where
392+ dirs = toList dirs'
393+
394+packageInfoToNamePathMap :: Foldable f => f CabalPackageInfo -> Map Text FilePath
395+packageInfoToNamePathMap = Map.fromList . map (_cabalPackageInfo_packageName &&& _cabalPackageInfo_packageRoot) . toList
396+
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+ ]
119411
120412-- | Create ghci configuration to load the given packages
121413withGhciScript
122− :: MonadObelisk m
123− => [FilePath] -- ^ List of packages to load into ghci
124− -> (FilePath -> m ()) -- ^ Action to run with the path to generated temporory .ghci
414+ :: (MonadObelisk m, Foldable f)
415+ => [String] -- ^ Commands to prefix to file
416+ -> f CabalPackageInfo -- ^ List of packages to load into ghci
417+ -> (FilePath -> m ()) -- ^ Action to run with the path to generated temporary .ghci
125418 -> m ()
126−withGhciScript pkgs f = do
127− (pkgDirErrs, packageInfos) <- fmap partitionEithers $ forM pkgs $ \pkg -> do
128− flip fmap (parseCabalPackage pkg) $ \case
129− Nothing -> Left pkg
130− Just packageInfo -> Right packageInfo
131−
132− when (null packageInfos) $
133− failWith $ T.pack $ "No valid pkgs found in " <> intercalate ", " pkgs
134− unless (null pkgDirErrs) $
135− putLog Warning $ T.pack $ "Failed to find pkgs in " <> intercalate ", " pkgDirErrs
136−
137− let extensions = packageInfos >>= _cabalPackageInfo_defaultExtensions
138− extensionsLine = if extensions == mempty
139− then ""
140− else ":set " <> intercalate " " ((("-X" <>) . prettyShow) <$> extensions)
141− dotGhci = unlines $
142− [ ":set -i" <> intercalate ":" (packageInfos >>= rootedSourceDirs)
143− , extensionsLine
144− , ":load Backend Frontend"
145− , "import Obelisk.Run"
146− , "import qualified Frontend"
147− , "import qualified Backend"
148− ]
419+withGhciScript preCommands (toList -> packageInfos) f =
149420 withSystemTempDirectory "ob-ghci" $ \fp -> do
150421 let dotGhciPath = fp </> ".ghci"
151422 liftIO $ writeFile dotGhciPath dotGhci
152423 f dotGhciPath
424+ where
425+ packageNames = Set.fromList $ map _cabalPackageInfo_packageName packageInfos
426+ modulesToLoad = mconcat
427+ [ [ "Obelisk.Run" | "obelisk-run" `Set.member` packageNames ]
428+ , [ "Backend" | "backend" `Set.member` packageNames ]
429+ , [ "Frontend" | "frontend" `Set.member` packageNames ]
430+ ]
431+ dotGhci = unlines $
432+ preCommands <>
433+ [ if null modulesToLoad then "" else ":load " <> unwords modulesToLoad
434+ , "import qualified Obelisk.Run"
435+ , "import qualified Frontend"
436+ , "import qualified Backend"
437+ ]
438+
439+-- | Builds a list of options to pass to ghci or set in .ghci file that configures
440+-- the preprocessor and source includes.
441+getGhciSessionSettings
442+ :: (MonadObelisk m, Foldable f)
443+ => f CabalPackageInfo -- ^ List of packages to load into ghci
444+ -> FilePath -- ^ All paths will be relative to this path
445+ -> Bool -- ^ Use relative paths
446+ -> m [String]
447+getGhciSessionSettings (toList -> packageInfos) pathBase useRelativePaths = do
448+ -- N.B. ghci settings do NOT support escaping in any way. To minimize the likelihood that
449+ -- paths-with-spaces ruin our day, we first canonicalize everything, and then relativize
450+ -- all paths to 'pathBase'.
451+ selfExe <- liftIO $ canonicalizePath =<< getExecutablePath
452+ canonicalPathBase <- liftIO $ canonicalizePath pathBase
453+
454+ (pkgFiles, pkgSrcPaths :: [NonEmpty FilePath]) <- fmap unzip $ liftIO $ for packageInfos $ \pkg -> do
455+ canonicalSrcDirs <- traverse canonicalizePath $ (_cabalPackageInfo_packageRoot pkg </>) <$> _cabalPackageInfo_sourceDirs pkg
456+ canonicalPkgFile <- canonicalizePath $ _cabalPackageInfo_packageFile pkg
457+ pure (canonicalPkgFile `relativeTo'` canonicalPathBase, (`relativeTo'` canonicalPathBase) <$> canonicalSrcDirs)
153458
459+ pure
460+ $ baseGhciOptions
461+ <> ["-F", "-pgmF", selfExe, "-optF", preprocessorIdentifier]
462+ <> concatMap (\p -> ["-optF", p]) pkgFiles
463+ <> [ "-i" <> intercalate ":" (concatMap toList pkgSrcPaths) ]
154464 where
155− rootedSourceDirs pkg = NE.toList $
156− (_cabalPackageInfo_packageRoot pkg </>) <$> _cabalPackageInfo_sourceDirs pkg
465+ relativeTo' = if useRelativePaths then relativeTo else const
466+
467+baseGhciOptions :: [String]
468+baseGhciOptions =
469+ [ "-ignore-dot-ghci"
470+ , "-no-user-package-db"
471+ , "-package-env", "-"
472+ ]
157473
158474-- | Run ghci repl
159475runGhciRepl
160− :: MonadObelisk m
161− => FilePath -- ^ Path to .ghci
476+ :: (MonadObelisk m, Foldable f)
477+ => FilePath -- ^ Path to project root
478+ -> f CabalPackageInfo -- ^ Packages to keep unbuilt
479+ -> [String] -- ^ GHCi arguments
162480 -> m ()
163−runGhciRepl dotGhci = inProjectShell "ghc" $ unwords $ "ghci" : ["-ghci-script", dotGhci]
481+runGhciRepl root (toList -> packages) ghciArgs =
482+ -- 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.
484+ nixShellWithoutPkgs root True False (packageInfoToNamePathMap packages) "ghc" $
485+ Just $ unwords $ fmap bashEscape $ "ghci" : ghciArgs
164486
165487-- | Run ghcid
166488runGhcid
167− :: MonadObelisk m
168− => FilePath -- ^ Path to .ghci
489+ :: (MonadObelisk m, Foldable f)
490+ => FilePath -- ^ Path to project root
491+ -> Bool -- ^ Should we chdir to root when running this process?
492+ -> [String] -- ^ GHCi arguments
493+ -> f CabalPackageInfo -- ^ Packages to keep unbuilt
169494 -> Maybe String -- ^ Optional command to run at every reload
170495 -> m ()
171−runGhcid dotGhci mcmd = callCommand $ unwords $ "ghcid" : opts
496+runGhcid root chdirToRoot ghciArgs (toList -> packages) mcmd =
497+ nixShellWithoutPkgs root True chdirToRoot (packageInfoToNamePathMap packages) "ghc" $
498+ Just $ unwords $ fmap bashEscape $ ghcidExePath : opts
172499 where
173− opts =
174− [ "-W"
175− --TODO: The decision of whether to use -fwarn-redundant-constraints should probably be made by the user
176− , "--command='ghci -Wall -ignore-dot-ghci -fwarn-redundant-constraints -ghci-script " <> dotGhci <> "' "
177− , "--reload=config"
178− , "--outputfile=ghcid-output.txt"
179− ] <> testCmd
180− testCmd = maybeToList (flip fmap mcmd $ \cmd -> "--test='" <> cmd <> "'")
181−
182−getFreePort :: MonadIO m => m PortNumber
183−getFreePort = liftIO $ withSocketsDo $ do
184− addr:_ <- getAddrInfo (Just defaultHints) (Just "127.0.0.1") (Just "0")
185− bracket (open addr) close socketPort
500+ opts = concat
501+ [ ["-W"]
502+ , ["--outputfile=ghcid-output.txt"]
503+ , map (\x -> "--reload=" <> x) reloadFiles
504+ , map (\x -> "--restart=" <> x) restartFiles
505+ , maybe [] (\cmd -> ["--test=" <> cmd]) mcmd
506+ , ["--command=" <> unwords ("ghci" : ghciArgs)]
507+ ]
508+ adjustRoot x = if chdirToRoot then makeRelative root x else x
509+ reloadFiles = map adjustRoot [root </> "config"]
510+ restartFiles = map (adjustRoot . _cabalPackageInfo_packageFile) packages
511+
512+getFreePort :: MonadIO m => m Socket.PortNumber
513+getFreePort = liftIO $ Socket.withSocketsDo $ do
514+ addr:_ <- Socket.getAddrInfo (Just Socket.defaultHints) (Just "127.0.0.1") (Just "0")
515+ bracket (open addr) Socket.close Socket.socketPort
186516 where
187517 open addr = do
188− sock <- socket (addrFamily addr) (addrSocketType addr) (addrProtocol addr)
189− bind sock (addrAddress addr)
518+ sock <- Socket.socket (Socket.addrFamily addr) (Socket.addrSocketType addr) (Socket.addrProtocol addr)
519+ Socket.bind sock (Socket.addrAddress addr)
190520 return sock
521+
522+
523+-- | Convert a 'FilePath' into a 'PathTree'.
524+pathToTree :: a -> FilePath -> PathTree a
525+pathToTree a p = go $ splitDirectories p
526+ where
527+ go [] = PathTree_Node (Just a) mempty
528+ go (x : xs) = PathTree_Node Nothing $ Map.singleton x $ go xs
529+
530+-- | Like 'zipWith' but pads with a padding value instead of stopping on the shortest list.
531+zipDefaultWith :: a -> b -> (a -> b -> c) -> [a] -> [b] -> [c]
532+zipDefaultWith _da _db _f [] [] = []
533+zipDefaultWith da db f (a:as) [] = f a db : zipDefaultWith da db f as []
534+zipDefaultWith da db f [] (b:bs) = f da b : zipDefaultWith da db f [] bs
535+zipDefaultWith da db f (a:as) (b:bs) = f a b : zipDefaultWith da db f as bs
536+
537+-- | Makes the first absolute path relative to the second absolute path.
538+--
539+-- Both input paths MUST be absolute.
540+--
541+-- Unlike 'makeRelative' this does not merely strip prefixes. It will introduce
542+-- enough @..@ paths to make the resulting path truly relative in virtually every
543+-- case. The only exception is on Windows when the two paths are on different
544+-- drives. In this case the resulting path may be absolute.
545+relativeTo :: FilePath -> FilePath -> FilePath
546+relativeTo dir base
547+ = bifoldr1 (</>)
548+ $ bimap (collapse . (".." <$) . catMaybes) (collapse . catMaybes)
549+ $ unzip
550+ $ dropWhile (\(a,b) -> a == b)
551+ $ zipDefaultWith Nothing Nothing (,)
552+ (map Just $ splitDirectories base)
553+ (map Just $ splitDirectories dir)
554+ where collapse = foldr (</>) ""
lib/command/src/Obelisk/Command/Thunk.hs+639−355
@@ -5,71 +5,59 @@
55{-# LANGUAGE MultiWayIf #-}
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE PatternGuards #-}
8+{-# LANGUAGE QuasiQuotes #-}
89{-# LANGUAGE ScopedTypeVariables #-}
910{-# LANGUAGE TypeApplications #-}
10−module Obelisk.Command.Thunk
11− ( ThunkPtr (..)
12− , ThunkRev (..)
13− , ThunkSource (..)
14− , ThunkData (..)
15− , ReadThunkError (..)
16− , GitHubSource (..)
17− , getThunkGitBranch
18− , getLatestRev
19− , updateThunkToLatest
20− , createThunk
21− , createThunkWithLatest
22− , nixBuildAttrWithCache
23− , nixBuildThunkAttrWithCache
24− , unpackThunk
25− , packThunk
26− , readThunk
27− , updateThunk
28− , getThunkPtr
29− , getThunkPtr'
30− , parseGitUri
31− , uriThunkPtr
32− ) where
11+module Obelisk.Command.Thunk where
3312
3413import Control.Applicative
3514import Control.Exception (displayException, try)
36−import Control.Lens.Indexed hiding ((<.>))
15+import Control.Lens (ifor, ifor_, (.~))
3716import Control.Monad
38−import Control.Monad.Catch (handle)
17+import Control.Monad.Extra (findM)
18+import Control.Monad.Catch (MonadCatch, handle)
3919import Control.Monad.Except
4020import Data.Aeson ((.=))
4121import qualified Data.Aeson as Aeson
4222import Data.Aeson.Encode.Pretty
4323import qualified Data.Aeson.Types as Aeson
24+import Data.Bifunctor (first)
4425import qualified Data.ByteString.Lazy as LBS
26+import Data.Containers.ListUtils (nubOrd)
4527import Data.Default
4628import Data.Either.Combinators (fromRight', rightToMaybe)
29+import Data.Foldable (toList)
30+import Data.Function ((&))
31+import Data.Functor ((<&>))
4732import Data.Git.Ref (Ref)
4833import qualified Data.Git.Ref as Ref
4934import qualified Data.List as L
50−import Data.List.NonEmpty (NonEmpty (..))
35+import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
5136import qualified Data.List.NonEmpty as NonEmpty
5237import Data.Map (Map)
5338import qualified Data.Map as Map
5439import Data.Maybe
5540import Data.Set (Set)
5641import qualified Data.Set as Set
42+import Data.String.Here.Interpolated (i)
43+import Data.String.Here.Uninterpolated (here)
5744import Data.Text (Text)
5845import qualified Data.Text as T
5946import Data.Text.Encoding
6047import qualified Data.Text.IO as T
6148import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49+import Data.Traversable (for)
6250import Data.Yaml (parseMaybe)
6351import GitHub
6452import GitHub.Data.Name
6553import Obelisk.Command.Nix
6654import System.Directory
55+import System.Exit
6756import System.FilePath
6857import System.IO.Error
6958import System.IO.Temp
70−import System.Posix (getSymbolicLinkStatus, modificationTime)
71−import System.Process (proc)
72−import Text.URI
59+import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
60+import qualified Text.URI as URI
7361
7462import Obelisk.App (MonadObelisk)
7563import Obelisk.CliApp
@@ -77,11 +65,10 @@ import Obelisk.Command.Utils
7765
7866--TODO: Support symlinked thunk data
7967data ThunkData
80− = ThunkData_Packed ThunkPtr
68+ = ThunkData_Packed ThunkSpec ThunkPtr
8169 -- ^ Packed thunk
82− | ThunkData_Checkout (Maybe ThunkPtr)
70+ | ThunkData_Checkout
8371 -- ^ Checked out thunk that was unpacked from this pointer
84− deriving (Show, Eq, Ord)
8572
8673-- | A reference to the exact data that a thunk should translate into
8774data ThunkPtr = ThunkPtr
@@ -94,7 +81,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
9481
9582-- | A specific revision of data; it may be available from multiple sources
9683data ThunkRev = ThunkRev
97− { _thunkRev_commit :: Ref
84+ { _thunkRev_commit :: Ref Ref.SHA1
9885 , _thunkRev_nixSha256 :: NixSha256
9986 }
10087 deriving (Show, Eq, Ord)
@@ -107,41 +94,72 @@ data ThunkSource
10794 | ThunkSource_Git GitSource
10895 deriving (Show, Eq, Ord)
10996
97+thunkSourceToGitSource :: ThunkSource -> GitSource
98+thunkSourceToGitSource = \case
99+ ThunkSource_GitHub s -> forgetGithub False s
100+ ThunkSource_Git s -> s
101+
110102data GitHubSource = GitHubSource
111103 { _gitHubSource_owner :: Name Owner
112104 , _gitHubSource_repo :: Name Repo
113105 , _gitHubSource_branch :: Maybe (Name Branch)
106+ , _gitHubSource_private :: Bool
114107 }
115108 deriving (Show, Eq, Ord)
116109
110+newtype GitUri = GitUri { unGitUri :: URI.URI } deriving (Eq, Ord, Show)
111+
112+gitUriToText :: GitUri -> Text
113+gitUriToText (GitUri uri)
114+ | (T.toLower . URI.unRText <$> URI.uriScheme uri) == Just "file"
115+ , Just (_, path) <- URI.uriPath uri
116+ = "/" <> T.intercalate "/" (map URI.unRText $ NonEmpty.toList path)
117+ | otherwise = URI.render uri
118+
117119data GitSource = GitSource
118− { _gitSource_url :: URI
120+ { _gitSource_url :: GitUri
119121 , _gitSource_branch :: Maybe (Name Branch)
120122 , _gitSource_fetchSubmodules :: Bool
123+ , _gitSource_private :: Bool
121124 }
122125 deriving (Show, Eq, Ord)
123126
127+newtype ThunkConfig = ThunkConfig
128+ { _thunkConfig_private :: Maybe Bool
129+ } deriving Show
130+
131+data ThunkUpdateConfig = ThunkUpdateConfig
132+ { _thunkUpdateConfig_branch :: Maybe String
133+ , _thunkUpdateConfig_config :: ThunkConfig
134+ } deriving Show
135+
136+data ThunkPackConfig = ThunkPackConfig
137+ { _thunkPackConfig_force :: Bool
138+ , _thunkPackConfig_config :: ThunkConfig
139+ } deriving Show
140+
124141-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
125142forgetGithub :: Bool -> GitHubSource -> GitSource
126143forgetGithub useSsh s = GitSource
127− { _gitSource_url = URI
128− { uriScheme = Just $ fromRight' $ mkScheme $ if useSsh then "ssh" else "https"
129− , uriAuthority = Right $ Authority
130− { authUserInfo = UserInfo (fromRight' $ mkUsername "git") Nothing
144+ { _gitSource_url = GitUri $ URI.URI
145+ { URI.uriScheme = Just $ fromRight' $ URI.mkScheme $ if useSsh then "ssh" else "https"
146+ , URI.uriAuthority = Right $ URI.Authority
147+ { URI.authUserInfo = URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
131148 <$ guard useSsh
132− , authHost = fromRight' $ mkHost "github.com"
133− , authPort = Nothing
149+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
150+ , URI.authPort = Nothing
134151 }
135− , uriPath = Just ( False
136− , fromRight' . mkPathPiece <$>
152+ , URI.uriPath = Just ( False
153+ , fromRight' . URI.mkPathPiece <$>
137154 untagName (_gitHubSource_owner s)
138155 :| [ untagName (_gitHubSource_repo s) <> ".git" ]
139156 )
140− , uriQuery = []
141− , uriFragment = Nothing
157+ , URI.uriQuery = []
158+ , URI.uriFragment = Nothing
142159 }
143160 , _gitSource_branch = _gitHubSource_branch s
144161 , _gitSource_fetchSubmodules = False
162+ , _gitSource_private = _gitHubSource_private s
145163 }
146164
147165getThunkGitBranch :: ThunkPtr -> Maybe Text
@@ -149,26 +167,26 @@ getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
149167 ThunkSource_GitHub s -> _gitHubSource_branch s
150168 ThunkSource_Git s -> _gitSource_branch s
151169
152−commitNameToRef :: Name Commit -> Ref
170+commitNameToRef :: Name Commit -> Ref Ref.SHA1
153171commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
154172
155173-- TODO: Use spinner here.
156174getNixSha256ForUriUnpacked
157175 :: MonadObelisk m
158− => URI
176+ => GitUri
159177 -> m NixSha256
160178getNixSha256ForUriUnpacked uri =
161− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> render uri) $ do
179+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
162180 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
163− proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , T.unpack $ render uri]
181+ proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
164182 pure hash
165183
166−nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
184+nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
167185nixPrefetchGit uri rev fetchSubmodules =
168− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> render uri <> " at " <> rev) $ do
186+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
169187 out <- readProcessAndLogStderr Debug $
170− proc "nix-prefetch-git" $ filter (/="")
171− [ "--url", T.unpack $ render uri
188+ proc nixPrefetchGitPath $ filter (/="")
189+ [ "--url", T.unpack $ gitUriToText uri
172190 , "--rev", T.unpack rev
173191 , if fetchSubmodules then "--fetch-submodules" else ""
174192 , "--quiet"
@@ -180,93 +198,117 @@ nixPrefetchGit uri rev fetchSubmodules =
180198
181199--TODO: Pretty print these
182200data ReadThunkError
183− = ReadThunkError_UnrecognizedFiles
184− | ReadThunkError_AmbiguousFiles
185− | ReadThunkError_UnrecognizedLoader Text
186− | ReadThunkError_UnparseablePtr LBS.ByteString
187− deriving (Show)
188−
189−-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
190−-- If the thunk is packed and additional data is present, fail.
191−readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
192−readThunk thunkDir = do
193− files <- liftIO $ listDirectory thunkDir
194− case ".git" `elem` files of
195− True -> fmap ThunkData_Checkout <$> do
196− let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
197− liftIO $ doesDirectoryExist origThunkPath >>= \case
198− True -> fmap Just <$> readPackedThunk origThunkPath
199− False -> return $ return Nothing
200− False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
201−
202−data ThunkType = ThunkType
203− { _thunkType_loader :: FilePath
204− , _thunkType_json :: FilePath
205− , _thunkType_optional :: Set FilePath
206− , _thunkType_loaderVersions :: NonEmpty Text
207− , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
208− }
209−
210−gitHubThunkType :: ThunkType
211−gitHubThunkType = ThunkType
212− { _thunkType_loader = "default.nix"
213− , _thunkType_json = "github.json"
214− , _thunkType_optional = Set.fromList [".attr-cache"]
215− , _thunkType_loaderVersions = gitHubStandaloneLoaders
216− , _thunkType_parser = parseThunkPtr $ \v ->
217− ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
218− }
219−
220−gitThunkType :: ThunkType
221−gitThunkType = ThunkType
222− { _thunkType_loader = "default.nix"
223− , _thunkType_json = "git.json"
224− , _thunkType_optional = Set.fromList [".attr-cache"]
225− , _thunkType_loaderVersions = plainGitStandaloneLoaders
226− , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
201+ = ReadThunkError_UnrecognizedThunk
202+ | ReadThunkError_UnrecognizedPaths (NonEmpty FilePath)
203+ | ReadThunkError_MissingPaths (NonEmpty FilePath)
204+ | ReadThunkError_UnparseablePtr FilePath String
205+ | ReadThunkError_FileError IOError
206+ | ReadThunkError_FileDoesNotMatch FilePath Text
207+ | ReadThunkError_UnrecognizedState String
208+ | ReadThunkError_AmbiguousPackedState ThunkPtr ThunkPtr
209+ deriving (Show)
210+
211+unpackedDirName :: FilePath
212+unpackedDirName = "."
213+
214+attrCacheFileName :: FilePath
215+attrCacheFileName = ".attr-cache"
216+
217+-- | Specification for how a file in a thunk version works.
218+data ThunkFileSpec
219+ = ThunkFileSpec_Ptr (LBS.ByteString -> Either String ThunkPtr) -- ^ This file specifies 'ThunkPtr' data
220+ | ThunkFileSpec_FileMatches Text -- ^ This file must match the given content exactly
221+ | ThunkFileSpec_CheckoutIndicator -- ^ Existence of this directory indicates that the thunk is unpacked
222+ | ThunkFileSpec_AttrCache -- ^ This directory is an attribute cache
223+
224+-- | Specification for how a set of files in a thunk version work.
225+data ThunkSpec = ThunkSpec
226+ { _thunkSpec_name :: !Text
227+ , _thunkSpec_files :: !(Map FilePath ThunkFileSpec)
227228 }
228229
229−thunkTypes :: [ThunkType]
230−thunkTypes = [gitThunkType, gitHubThunkType]
231−
232−findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
233−findThunkType types thunkDir = do
234− matches <- fmap catMaybes $ forM types $ \thunkType -> do
235− let
236− expectedContents = Set.fromList $ (thunkDir </>) <$>
237− [ _thunkType_loader thunkType
238− , _thunkType_json thunkType
239− ]
240− optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
241−
242− -- Ensure that there aren't any other files in the thunk
243− -- NB: System.Directory.listDirectory returns the contents without the directory path
244− files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
245− let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
246− missingContents = expectedContents `Set.difference` files
247− pure $ if Set.null unexpectedContents && Set.null missingContents
248− then Just thunkType
249− else Nothing
250−
251− pure $ case matches of
252− [singleMatch] -> Right singleMatch
253− [] -> Left ReadThunkError_UnrecognizedFiles
254− _ -> Left ReadThunkError_AmbiguousFiles
230+thunkSpecTypes :: NonEmpty (NonEmpty ThunkSpec)
231+thunkSpecTypes = gitThunkSpecs :| [gitHubThunkSpecs]
232+
233+-- | Attempts to match a 'ThunkSpec' to a given directory.
234+matchThunkSpecToDir
235+ :: (MonadError ReadThunkError m, MonadIO m, MonadCatch m)
236+ => ThunkSpec -- ^ 'ThunkSpec' to match against the given files/directory
237+ -> FilePath -- ^ Path to directory
238+ -> Set FilePath -- ^ Set of file paths relative to the given directory
239+ -> m ThunkData
240+matchThunkSpecToDir thunkSpec dir dirFiles = do
241+ case nonEmpty (toList $ dirFiles `Set.difference` expectedPaths) of
242+ Just fs -> throwError $ ReadThunkError_UnrecognizedPaths $ (dir </>) <$> fs
243+ Nothing -> pure ()
244+ case nonEmpty (toList $ requiredPaths `Set.difference` dirFiles) of
245+ Just fs -> throwError $ ReadThunkError_MissingPaths $ (dir </>) <$> fs
246+ Nothing -> pure ()
247+ datas <- fmap toList $ flip Map.traverseMaybeWithKey (_thunkSpec_files thunkSpec) $ \expectedPath -> \case
248+ ThunkFileSpec_AttrCache -> Nothing <$ dirMayExist expectedPath
249+ ThunkFileSpec_CheckoutIndicator -> liftIO (doesDirectoryExist (dir </> expectedPath)) <&> \case
250+ False -> Nothing
251+ True -> Just ThunkData_Checkout
252+ ThunkFileSpec_FileMatches expectedContents -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
253+ actualContents <- liftIO (T.readFile $ dir </> expectedPath)
254+ case T.strip expectedContents == T.strip actualContents of
255+ True -> pure Nothing
256+ False -> throwError $ ReadThunkError_FileDoesNotMatch (dir </> expectedPath) expectedContents
257+ ThunkFileSpec_Ptr parser -> handle (\(e :: IOError) -> throwError $ ReadThunkError_FileError e) $ do
258+ let path = dir </> expectedPath
259+ liftIO (doesFileExist path) >>= \case
260+ False -> pure Nothing
261+ True -> do
262+ actualContents <- liftIO $ LBS.readFile path
263+ case parser actualContents of
264+ Right v -> pure $ Just (ThunkData_Packed thunkSpec v)
265+ Left e -> throwError $ ReadThunkError_UnparseablePtr (dir </> expectedPath) e
266+
267+ case nonEmpty datas of
268+ Nothing -> throwError ReadThunkError_UnrecognizedThunk
269+ Just xs -> fold1WithM xs $ \a b -> either throwError pure (mergeThunkData a b)
270+ where
271+ rootPathsOnly = Set.fromList . mapMaybe takeRootDir . Map.keys
272+ takeRootDir = fmap NonEmpty.head . nonEmpty . splitPath
273+
274+ expectedPaths = rootPathsOnly $ _thunkSpec_files thunkSpec
275+
276+ requiredPaths = rootPathsOnly $ Map.filter isRequiredFileSpec $ _thunkSpec_files thunkSpec
277+ isRequiredFileSpec = \case
278+ ThunkFileSpec_FileMatches _ -> True
279+ _ -> False
280+
281+ dirMayExist expectedPath = liftIO (doesFileExist (dir </> expectedPath)) >>= \case
282+ True -> throwError $ ReadThunkError_UnrecognizedPaths $ expectedPath :| []
283+ False -> pure ()
284+
285+ -- Combine 'ThunkData' from different files, preferring "Checkout" over "Packed"
286+ mergeThunkData ThunkData_Checkout ThunkData_Checkout = Right ThunkData_Checkout
287+ mergeThunkData ThunkData_Checkout ThunkData_Packed{} = Left bothPackedAndUnpacked
288+ mergeThunkData ThunkData_Packed{} ThunkData_Checkout = Left bothPackedAndUnpacked
289+ mergeThunkData a@(ThunkData_Packed _ ptrA) (ThunkData_Packed _ ptrB) =
290+ if ptrA == ptrB then Right a else Left $ ReadThunkError_AmbiguousPackedState ptrA ptrB
291+
292+ bothPackedAndUnpacked = ReadThunkError_UnrecognizedState "Both packed data and checkout present"
293+
294+ fold1WithM (x :| xs) f = foldM f x xs
295+
296+readThunkWith
297+ :: (MonadObelisk m)
298+ => NonEmpty (NonEmpty ThunkSpec) -> FilePath -> m (Either ReadThunkError ThunkData)
299+readThunkWith specTypes dir = do
300+ dirFiles <- Set.fromList <$> liftIO (listDirectory dir)
301+ let specs = concatMap toList $ toList $ NonEmpty.transpose specTypes -- Interleave spec types so we try each one in a "fair" ordering
302+ flip fix specs $ \loop -> \case
303+ [] -> pure $ Left ReadThunkError_UnrecognizedThunk
304+ spec:rest -> runExceptT (matchThunkSpecToDir spec dir dirFiles) >>= \case
305+ Left e -> putLog Debug [i|Thunk specification ${_thunkSpec_name spec} did not match ${dir}: ${e}|] *> loop rest
306+ x@(Right _) -> x <$ putLog Debug [i|Thunk specification ${_thunkSpec_name spec} matched ${dir}|]
255307
256308-- | Read a thunk and validate that it is exactly a packed thunk.
257309-- If additional data is present, fail.
258−readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
259−readPackedThunk thunkDir = runExceptT $ do
260− thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
261− -- Ensure that we recognize the thunk loader
262− loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
263− unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
264− throwError $ ReadThunkError_UnrecognizedLoader loader
265−
266− txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
267− case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
268− Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
269− Just ptr -> return ptr
310+readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311+readThunk = readThunkWith thunkSpecTypes
270312
271313parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
272314parseThunkPtr parseSrc v = do
@@ -286,10 +328,12 @@ parseGitHubSource v = do
286328 owner <- v Aeson..: "owner"
287329 repo <- v Aeson..: "repo"
288330 branch <- v Aeson..:! "branch"
331+ private <- v Aeson..:? "private"
289332 pure $ GitHubSource
290333 { _gitHubSource_owner = owner
291334 , _gitHubSource_repo = repo
292335 , _gitHubSource_branch = branch
336+ , _gitHubSource_private = fromMaybe False private
293337 }
294338
295339parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
@@ -297,25 +341,29 @@ parseGitSource v = do
297341 Just url <- parseGitUri <$> v Aeson..: "url"
298342 branch <- v Aeson..:! "branch"
299343 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344+ private <- v Aeson..:? "private"
300345 pure $ GitSource
301346 { _gitSource_url = url
302347 , _gitSource_branch = branch
303348 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349+ , _gitSource_private = fromMaybe False private
304350 }
305351
306352overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
307353overwriteThunk target thunk = do
308354 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
309− Right _ <- readThunk target
355+ readThunk target >>= \case
356+ Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357+ Right _ -> pure ()
310358
311359 --TODO: Is there a safer way to do this overwriting?
312− liftIO $ removeDirectoryRecursive target
313− liftIO $ createThunk target thunk
360+ liftIO $ removePathForcibly target
361+ createThunk target $ Right thunk
314362
315−thunkPtrLoader :: ThunkPtr -> Text
316−thunkPtrLoader thunk = case _thunkPtr_source thunk of
317− ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
318− ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
363+thunkPtrToSpec :: ThunkPtr -> ThunkSpec
364+thunkPtrToSpec thunk = case _thunkPtr_source thunk of
365+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
366+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
319367
320368-- It's important that formatting be very consistent here, because
321369-- otherwise when people update thunks, their patches will be messy
@@ -327,13 +375,15 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
327375 , ("branch" .=) <$> _gitHubSource_branch s
328376 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
329377 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378+ , Just $ "private" .= _gitHubSource_private s
330379 ]
331380 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
332− [ Just $ "url" .= render (_gitSource_url s)
381+ [ Just $ "url" .= gitUriToText (_gitSource_url s)
333382 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
334383 , ("branch" .=) <$> _gitSource_branch s
335384 , Just $ "sha256" .= _thunkRev_nixSha256 rev
336385 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386+ , Just $ "private" .= _gitSource_private s
337387 ]
338388 where
339389 githubCfg = defConfig
@@ -354,59 +404,84 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
354404 [ "url"
355405 , "rev"
356406 , "sha256"
407+ , "private"
357408 , "fetchSubmodules"
358409 ] <> compare
359410 , confTrailingNewline = True
360411 }
361412
362−createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
363−createThunk target thunk = liftIO $ do
364− createDirectoryIfMissing True (target </> ".attr-cache")
365− T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
366− let
367− jsonFileName = case _thunkPtr_source thunk of
368− ThunkSource_GitHub _ -> "github"
369− ThunkSource_Git _ -> "git"
370− LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
413+createThunk :: MonadObelisk m => FilePath -> Either ThunkSpec ThunkPtr -> m ()
414+createThunk target ptrInfo =
415+ ifor_ (_thunkSpec_files spec) $ \path -> \case
416+ ThunkFileSpec_FileMatches content -> withReadyPath path $ \p -> liftIO $ T.writeFile p content
417+ ThunkFileSpec_Ptr _ -> case ptrInfo of
418+ Left _ -> pure () -- We can't write the ptr without it
419+ Right ptr -> withReadyPath path $ \p -> liftIO $ LBS.writeFile p (encodeThunkPtrData ptr)
420+ _ -> pure ()
421+ where
422+ spec = either id thunkPtrToSpec ptrInfo
423+ withReadyPath path f = do
424+ let fullPath = target </> path
425+ putLog Debug $ "Writing thunk file " <> T.pack fullPath
426+ liftIO $ createDirectoryIfMissing True $ takeDirectory fullPath
427+ f fullPath
371428
372429createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
373430createThunkWithLatest target s = do
374431 rev <- getLatestRev s
375− createThunk target $ ThunkPtr
432+ createThunk target $ Right $ ThunkPtr
376433 { _thunkPtr_source = s
377434 , _thunkPtr_rev = rev
378435 }
379436
380−updateThunkToLatest :: MonadObelisk m => FilePath -> m ()
381−updateThunkToLatest target = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
382− (overwrite, ptr) <- readThunk target >>= \case
383− Left err -> failWith $ T.pack $ "thunk update: " <> show err
384− Right c -> case c of
385− ThunkData_Packed t -> return (target, t)
386− ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
387− let src = _thunkPtr_source ptr
388− rev <- getLatestRev src
389− overwriteThunk overwrite $ ThunkPtr
390− { _thunkPtr_source = src
391− , _thunkPtr_rev = rev
392− }
437+updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439+ checkThunkDirectory target
440+ -- check to see if thunk should be updated to a specific branch or just update it's current branch
441+ case mBranch of
442+ Nothing -> do
443+ (overwrite, ptr) <- readThunk target >>= \case
444+ Left err -> failWith [i|Thunk update: ${err}|]
445+ Right c -> case c of
446+ ThunkData_Packed _ t -> return (target, t)
447+ ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
448+ let src = _thunkPtr_source ptr
449+ rev <- getLatestRev src
450+ overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
451+ { _thunkPtr_source = src
452+ , _thunkPtr_rev = rev
453+ }
454+ Just branch -> readThunk target >>= \case
455+ Left err -> failWith [i|Thunk update: ${err}|]
456+ Right c -> case c of
457+ ThunkData_Packed _ t -> setThunk thunkConfig target (thunkSourceToGitSource $ _thunkPtr_source t) branch
458+ ThunkData_Checkout -> failWith [i|Thunk located at ${target} is unpacked. Use 'ob thunk pack' on the desired directory and then try 'ob thunk update' again.|]
459+ where
460+ spinner = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest")
461+
462+setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463+setThunk thunkConfig target gs branch = do
464+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (_thunkConfig_private thunkConfig) (Just $ T.pack branch) Nothing
465+ overwriteThunk target newThunkPtr
466+ updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
393467
394468-- | All recognized github standalone loaders, ordered from newest to oldest.
395469-- This tool will only ever produce the newest one when it writes a thunk.
396−gitHubStandaloneLoaders :: NonEmpty Text
397−gitHubStandaloneLoaders =
398− gitHubStandaloneLoaderV2 :|
399− [ gitHubStandaloneLoaderV3
400− , gitHubStandaloneLoaderV1
470+gitHubThunkSpecs :: NonEmpty ThunkSpec
471+gitHubThunkSpecs =
472+ gitHubThunkSpecV5 :|
473+ [ gitHubThunkSpecV4
474+ , gitHubThunkSpecV3
475+ , gitHubThunkSpecV2
476+ , gitHubThunkSpecV1
401477 ]
402478
403−gitHubStandaloneLoaderV1 :: Text
404−gitHubStandaloneLoaderV1 = T.unlines
405− [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
406− ]
479+gitHubThunkSpecV1 :: ThunkSpec
480+gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481+ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
407482
408−gitHubStandaloneLoaderV2 :: Text
409−gitHubStandaloneLoaderV2 = T.unlines
483+gitHubThunkSpecV2 :: ThunkSpec
484+gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
410485 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
411486 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
412487 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -416,8 +491,8 @@ gitHubStandaloneLoaderV2 = T.unlines
416491 , "))"
417492 ]
418493
419−gitHubStandaloneLoaderV3 :: Text
420−gitHubStandaloneLoaderV3 = T.unlines
494+gitHubThunkSpecV3 :: ThunkSpec
495+gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
421496 [ "# DO NOT HAND-EDIT THIS FILE"
422497 , "let"
423498 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -436,22 +511,62 @@ gitHubStandaloneLoaderV3 = T.unlines
436511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
437512 ]
438513
439−plainGitStandaloneLoaders :: NonEmpty Text
440−plainGitStandaloneLoaders =
441− plainGitStandaloneLoaderV1 :|
442− [ plainGitStandaloneLoaderV2
514+gitHubThunkSpecV4 :: ThunkSpec
515+gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
516+ [ "# DO NOT HAND-EDIT THIS FILE"
517+ , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518+ , " if !fetchSubmodules && !private then builtins.fetchTarball {"
519+ , " url = \"https://github.com/${owner}/${repo}/archive/${rev}.tar.gz\"; inherit sha256;"
520+ , " } else (import <nixpkgs> {}).fetchFromGitHub {"
521+ , " inherit owner repo rev sha256 fetchSubmodules private;"
522+ , " };"
523+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
524+ ]
525+
526+legacyGitHubThunkSpec :: Text -> Text -> ThunkSpec
527+legacyGitHubThunkSpec name loader = ThunkSpec name $ Map.fromList
528+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
529+ , ("github.json" , ThunkFileSpec_Ptr parseGitHubJsonBytes)
530+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
531+ , (".git", ThunkFileSpec_CheckoutIndicator)
532+ ]
533+
534+gitHubThunkSpecV5 :: ThunkSpec
535+gitHubThunkSpecV5 = mkThunkSpec "github-v5" "github.json" parseGitHubJsonBytes [here|
536+# DO NOT HAND-EDIT THIS FILE
537+let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
538+ if !fetchSubmodules && !private then builtins.fetchTarball {
539+ url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
540+ } else (import <nixpkgs> {}).fetchFromGitHub {
541+ inherit owner repo rev sha256 fetchSubmodules private;
542+ };
543+ json = builtins.fromJSON (builtins.readFile ./github.json);
544+in fetch json
545+|]
546+
547+parseGitHubJsonBytes :: LBS.ByteString -> Either String ThunkPtr
548+parseGitHubJsonBytes = parseJsonObject $ parseThunkPtr $ \v ->
549+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
550+
551+gitThunkSpecs :: NonEmpty ThunkSpec
552+gitThunkSpecs =
553+ gitThunkSpecV5 :|
554+ [ gitThunkSpecV4
555+ , gitThunkSpecV3
556+ , gitThunkSpecV2
557+ , gitThunkSpecV1
443558 ]
444559
445−plainGitStandaloneLoaderV1 :: Text
446−plainGitStandaloneLoaderV1 = T.unlines
560+gitThunkSpecV1 :: ThunkSpec
561+gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
447562 [ "# DO NOT HAND-EDIT THIS FILE"
448563 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
449564 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
450565 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
451566 ]
452567
453−plainGitStandaloneLoaderV2 :: Text
454−plainGitStandaloneLoaderV2 = T.unlines
568+gitThunkSpecV2 :: ThunkSpec
569+gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
455570 [ "# DO NOT HAND-EDIT THIS FILE"
456571 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
457572 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -460,10 +575,87 @@ plainGitStandaloneLoaderV2 = T.unlines
460575 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
461576 ]
462577
463−thunkFileNames :: [FilePath]
464−thunkFileNames = ["default.nix", "github.json", "git.json"]
578+-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
579+-- and will fail to find commits without this because it does shallow clones.
580+gitThunkSpecV3 :: ThunkSpec
581+gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
582+ [ "# DO NOT HAND-EDIT THIS FILE"
583+ , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
585+ , " if firstChar == \"/\" then /. + url"
586+ , " else if firstChar == \".\" then ./. + url"
587+ , " else url;"
588+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
589+ , " url = realUrl; inherit rev;"
590+ , " } else (import <nixpkgs> {}).fetchgit {"
591+ , " url = realUrl; inherit rev sha256;"
592+ , " };"
593+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
594+ ]
595+
596+gitThunkSpecV4 :: ThunkSpec
597+gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
598+ [ "# DO NOT HAND-EDIT THIS FILE"
599+ , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
600+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
601+ , " if firstChar == \"/\" then /. + url"
602+ , " else if firstChar == \".\" then ./. + url"
603+ , " else url;"
604+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
605+ , " url = realUrl; inherit rev;"
606+ , " ${if branch == null then null else \"ref\"} = branch;"
607+ , " } else (import <nixpkgs> {}).fetchgit {"
608+ , " url = realUrl; inherit rev sha256;"
609+ , " };"
610+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
611+ ]
612+
613+legacyGitThunkSpec :: Text -> Text -> ThunkSpec
614+legacyGitThunkSpec name loader = ThunkSpec name $ Map.fromList
615+ [ ("default.nix", ThunkFileSpec_FileMatches $ T.strip loader)
616+ , ("git.json" , ThunkFileSpec_Ptr parseGitJsonBytes)
617+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
618+ , (".git", ThunkFileSpec_CheckoutIndicator)
619+ ]
465620
466−--TODO: when checking something out, make a shallow clone
621+gitThunkSpecV5 :: ThunkSpec
622+gitThunkSpecV5 = mkThunkSpec "git-v5" "git.json" parseGitJsonBytes [here|
623+# DO NOT HAND-EDIT THIS FILE
624+let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:
625+ let realUrl = let firstChar = builtins.substring 0 1 url; in
626+ if firstChar == "/" then /. + url
627+ else if firstChar == "." then ./. + url
628+ else url;
629+ in if !fetchSubmodules && private then builtins.fetchGit {
630+ url = realUrl; inherit rev;
631+ ${if branch == null then null else "ref"} = branch;
632+ } else (import <nixpkgs> {}).fetchgit {
633+ url = realUrl; inherit rev sha256;
634+ };
635+ json = builtins.fromJSON (builtins.readFile ./git.json);
636+in fetch json
637+|]
638+
639+parseGitJsonBytes :: LBS.ByteString -> Either String ThunkPtr
640+parseGitJsonBytes = parseJsonObject $ parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
641+
642+mkThunkSpec :: Text -> FilePath -> (LBS.ByteString -> Either String ThunkPtr) -> Text -> ThunkSpec
643+mkThunkSpec name jsonFileName parser srcNix = ThunkSpec name $ Map.fromList
644+ [ ("default.nix", ThunkFileSpec_FileMatches defaultNixViaSrc)
645+ , ("thunk.nix", ThunkFileSpec_FileMatches srcNix)
646+ , (jsonFileName, ThunkFileSpec_Ptr parser)
647+ , (attrCacheFileName, ThunkFileSpec_AttrCache)
648+ , (normalise $ unpackedDirName </> ".git", ThunkFileSpec_CheckoutIndicator)
649+ ]
650+ where
651+ defaultNixViaSrc = [here|
652+# DO NOT HAND-EDIT THIS FILE
653+import (import ./thunk.nix)
654+|]
655+
656+
657+parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658+parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
467659
468660-- | Checks a cache directory to see if there is a fresh symlink
469661-- to the result of building an attribute of a thunk.
@@ -471,44 +663,49 @@ thunkFileNames = ["default.nix", "github.json", "git.json"]
471663-- and the result is symlinked into the cache.
472664nixBuildThunkAttrWithCache
473665 :: MonadObelisk m
474− => FilePath
666+ => ThunkSpec
667+ -> FilePath
475668 -- ^ Path to directory containing Thunk
476669 -> String
477670 -- ^ Attribute to build
478− -> m FilePath
671+ -> m (Maybe FilePath)
479672 -- ^ Symlink to cached or built nix output
480673-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
481674-- the caching mechanism will fail as it merely measures the modification
482675-- time of the cache link and the expression to build.
483−nixBuildThunkAttrWithCache thunkDir attr = do
484− --NB: Expects thunkDir to be normalised with no trailing path separator.
485− --This should be guaranteed by the command argument parser.
486− let cacheErrHandler e
487− | isDoesNotExistError e = return Nothing -- expected from a cache miss
488− | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
489− cacheDir = thunkDir </> ".attr-cache"
490− cachePath = cacheDir </> attr <.> "out"
676+nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
491677 latestChange <- liftIO $ do
492− createDirectoryIfMissing False cacheDir
493− let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
494− maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
495− cacheHit <- handle cacheErrHandler $ do
496− cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
497− return $ if latestChange <= cacheTime
498− then Just cachePath
499− else Nothing
500− case cacheHit of
501− Just c -> return c
502− Nothing -> do
503− putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
504− _ <- nixBuild $ def
505− { _nixBuildConfig_target = Target
506− { _target_path = thunkDir
507− , _target_attr = Just attr
508− }
509− , _nixBuildConfig_outLink = OutLink_IndirectRoot cachePath
510− }
511− return cachePath
678+ let
679+ getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
680+ thunkFileNames = Map.keys $ _thunkSpec_files thunkSpec
681+ maximum . catMaybes <$> traverse (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
682+
683+ let cachePaths' = nonEmpty $ Map.keys $ Map.filter (\case ThunkFileSpec_AttrCache -> True; _ -> False) $
684+ _thunkSpec_files thunkSpec
685+ for cachePaths' $ \cachePaths ->
686+ fmap NonEmpty.head $ for cachePaths $ \cacheDir -> do
687+ let
688+ cachePath = thunkDir </> cacheDir </> attr <.> "out"
689+ cacheErrHandler e
690+ | isDoesNotExistError e = pure Nothing -- expected from a cache miss
691+ | otherwise = Nothing <$ putLog Error (T.pack $ displayException e)
692+ cacheHit <- handle cacheErrHandler $ do
693+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
694+ pure $ if latestChange <= cacheTime
695+ then Just cachePath
696+ else Nothing
697+ case cacheHit of
698+ Just c -> pure c
699+ Nothing -> do
700+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
701+ liftIO $ createDirectoryIfMissing True (takeDirectory cachePath)
702+ (cachePath <$) $ nixCmd $ NixCmd_Build $ def
703+ & nixBuildConfig_outLink .~ OutLink_IndirectRoot cachePath
704+ & nixCmdConfig_target .~ Target
705+ { _target_path = Just thunkDir
706+ , _target_attr = Just attr
707+ , _target_expr = Nothing
708+ }
512709
513710-- | Build a nix attribute, and cache the result if possible
514711nixBuildAttrWithCache
@@ -519,17 +716,19 @@ nixBuildAttrWithCache
519716 -- ^ Attribute to build
520717 -> m FilePath
521718 -- ^ Symlink to cached or built nix output
522−nixBuildAttrWithCache exprPath attr = do
523− readThunk exprPath >>= \case
524− -- Only packed thunks are cached. in particular, checkouts are not
525− Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
526− _ -> nixBuild $ def
527− { _nixBuildConfig_target = Target
528− { _target_path = exprPath
719+nixBuildAttrWithCache exprPath attr = readThunk exprPath >>= \case
720+ -- Only packed thunks are cached. In particular, checkouts are not.
721+ Right (ThunkData_Packed spec _) ->
722+ maybe build pure =<< nixBuildThunkAttrWithCache spec exprPath attr
723+ _ -> build
724+ where
725+ build = nixCmd $ NixCmd_Build $ def
726+ & nixBuildConfig_outLink .~ OutLink_None
727+ & nixCmdConfig_target .~ Target
728+ { _target_path = Just exprPath
529729 , _target_attr = Just attr
730+ , _target_expr = Nothing
530731 }
531− , _nixBuildConfig_outLink = OutLink_None
532− }
533732
534733-- | Safely update thunk using a custom action
535734--
@@ -546,101 +745,153 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
546745 where
547746 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
548747 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
549− Right (ThunkData_Packed _) -> do
748+ Right ThunkData_Packed{} -> do
550749 let tmpThunk = tmpDir </> "thunk"
551750 callProcessAndLogOutput (Notice, Error) $
552− proc "cp" ["-r", "-T", thunkDir, tmpThunk]
751+ proc cp ["-r", "-T", thunkDir, tmpThunk]
553752 return tmpThunk
554− Right _ -> failWith $ "Thunk is not packed"
753+ Right _ -> failWith "Thunk is not packed"
555754 updateThunkFromTmp p' = do
556− _ <- packThunk' True p'
755+ _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
557756 callProcessAndLogOutput (Notice, Error) $
558− proc "cp" ["-r", "-T", p', p]
757+ proc cp ["-r", "-T", p', p]
559758
560759finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
561760finalMsg noTrail s = if noTrail then Nothing else Just s
562761
563−unpackThunk :: MonadObelisk m => FilePath -> m ()
564−unpackThunk = unpackThunk' False
565−
566762-- | Check that we are not somewhere inside the thunk directory
567763checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
568764checkThunkDirectory thunkDir = do
569765 currentDir <- liftIO getCurrentDirectory
570766 thunkDir' <- liftIO $ canonicalizePath thunkDir
571767 when (thunkDir' `L.isInfixOf` currentDir) $
572− failWith "Can't pack/unpack from within the thunk directory"
768+ failWith [i|Can't perform thunk operations from within the thunk directory: ${thunkDir}|]
769+
770+ -- Don't let thunk commands work when directly given an unpacked repo
771+ when (takeFileName thunkDir == unpackedDirName) $
772+ readThunk (takeDirectory thunkDir) >>= \case
773+ Right _ -> failWith [i|Refusing to perform thunk operation on ${thunkDir} because it is a thunk's unpacked source|]
774+ Left _ -> pure ()
775+
776+unpackThunk :: MonadObelisk m => FilePath -> m ()
777+unpackThunk = unpackThunk' False
573778
574779unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
575−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir >> readThunk thunkDir >>= \case
576− Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
780+unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781+ Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
577782 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
578− Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
579− Right (ThunkData_Packed tptr) -> do
783+ Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
784+ Right (ThunkData_Packed _ tptr) -> do
580785 let (thunkParent, thunkName) = splitFileName thunkDir
581− withTempDirectory thunkParent thunkName $ \tmpRepo -> do
582− let obGitDir = tmpRepo </> ".git" </> "obelisk"
583− s = case _thunkPtr_source tptr of
584− ThunkSource_GitHub s' -> forgetGithub False s'
585− ThunkSource_Git s' -> s'
786+ withTempDirectory thunkParent thunkName $ \tmpThunk -> do
787+ let
788+ gitSrc = thunkSourceToGitSource $ _thunkPtr_source tptr
789+ newSpec = case _thunkPtr_source tptr of
790+ ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
791+ ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
586792 withSpinner' ("Fetching thunk " <> T.pack thunkName)
587793 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
588− let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
589− git $ [ "clone" ]
590− ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
591− ++ [ T.unpack $ render $ _gitSource_url s ]
592− ++ do branch <- maybeToList $ _gitSource_branch s
593− [ "--branch", T.unpack $ untagName branch ]
594− git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
595− when (_gitSource_fetchSubmodules s) $
596− git ["submodule", "update", "--recursive", "--init"]
597−
598− liftIO $ createDirectory obGitDir
599− callProcessAndLogOutput (Notice, Error) $
600− proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
601− callProcessAndLogOutput (Notice, Error) $
602− proc "rm" ["-r", thunkDir]
603− callProcessAndLogOutput (Notice, Error) $
604− proc "mv" ["-T", tmpRepo, thunkDir]
794+ let unpackedPath = tmpThunk </> unpackedDirName
795+ gitCloneForThunkUnpack gitSrc (_thunkRev_commit $ _thunkPtr_rev tptr) unpackedPath
796+
797+ let normalizeMore = dropTrailingPathSeparator . normalise
798+ when (normalizeMore unpackedPath /= normalizeMore tmpThunk) $ -- Only write meta data if the checkout is not inplace
799+ createThunk tmpThunk $ Left newSpec
800+
801+ liftIO $ do
802+ removePathForcibly thunkDir
803+ renameDirectory tmpThunk thunkDir
804+
805+gitCloneForThunkUnpack
806+ :: MonadObelisk m
807+ => GitSource -- ^ Git source to use
808+ -> Ref hash -- ^ Commit hash to reset to
809+ -> FilePath -- ^ Directory to clone into
810+ -> m ()
811+gitCloneForThunkUnpack gitSrc commit dir = do
812+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc dir
813+ git $ [ "clone" ]
814+ ++ ["--recursive" | _gitSource_fetchSubmodules gitSrc]
815+ ++ [ T.unpack $ gitUriToText $ _gitSource_url gitSrc ]
816+ ++ do branch <- maybeToList $ _gitSource_branch gitSrc
817+ [ "--branch", T.unpack $ untagName branch ]
818+ git ["reset", "--hard", Ref.toHexString commit]
819+ when (_gitSource_fetchSubmodules gitSrc) $
820+ git ["submodule", "update", "--recursive", "--init"]
605821
606−--TODO: add force mode to pack even if changes are present
607822--TODO: add a rollback mode to pack to the original thunk
608−packThunk :: MonadObelisk m => FilePath -> m ThunkPtr
823+packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
609824packThunk = packThunk' False
610825
611−packThunk' :: MonadObelisk m => Bool -> FilePath -> m ThunkPtr
612−packThunk' noTrail thunkDir = checkThunkDirectory thunkDir >> readThunk thunkDir >>= \case
613− Left err -> failWith $ T.pack $ "thunk pack: " <> show err
614− Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
615− Right (ThunkData_Checkout _) -> do
616− withSpinner' ("Packing thunk " <> T.pack thunkDir)
617− (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
618− thunkPtr <- getThunkPtr thunkDir
619− callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
620− liftIO $ createThunk thunkDir thunkPtr
826+packThunk' :: MonadObelisk m => Bool -> ThunkPackConfig -> FilePath -> m ThunkPtr
827+packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
828+ Right ThunkData_Packed{} -> failWith [i|Thunk at ${thunkDir} is is already packed|]
829+ _ -> withSpinner'
830+ ("Packing thunk " <> T.pack thunkDir)
831+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $
832+ do
833+ let checkClean = if force then CheckClean_NoCheck else CheckClean_FullCheck
834+ thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr checkClean thunkDir (_thunkConfig_private thunkConfig)
835+ liftIO $ removePathForcibly thunkDir
836+ createThunk thunkDir $ Right thunkPtr
621837 pure thunkPtr
622838
623−getThunkPtr :: MonadObelisk m => FilePath -> m ThunkPtr
624−getThunkPtr = getThunkPtr' True
839+modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
840+modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
841+ Nothing -> ptr
842+ Just markPrivate -> ptr { _thunkPtr_source = case _thunkPtr_source ptr of
843+ ThunkSource_Git s -> ThunkSource_Git $ s { _gitSource_private = markPrivate }
844+ ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
845+ }
625846
626−getThunkPtr' :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
627−getThunkPtr' checkClean thunkDir = do
628− when checkClean $ ensureCleanGitRepo thunkDir True $
847+data CheckClean
848+ = CheckClean_FullCheck
849+ -- ^ Check that the repo is clean, including .gitignored files
850+ | CheckClean_NotIgnored
851+ -- ^ Check that the repo is clean, not including .gitignored files
852+ | CheckClean_NoCheck
853+ -- ^ Don't check that the repo is clean
854+
855+getThunkPtr :: forall m. MonadObelisk m => CheckClean -> FilePath -> Maybe Bool -> m ThunkPtr
856+getThunkPtr gitCheckClean dir mPrivate = do
857+ let repoLocations = nubOrd $ map (first normalise)
858+ [(".git", "."), (unpackedDirName </> ".git", unpackedDirName)]
859+ repoLocation' <- liftIO $ flip findM repoLocations $ doesDirectoryExist . (dir </>) . fst
860+ thunkDir <- case repoLocation' of
861+ Nothing -> failWith [i|Can't find an unpacked thunk in ${dir}|]
862+ Just (_, path) -> pure $ normalise $ dir </> path
863+
864+ let (checkClean, checkIgnored) = case gitCheckClean of
865+ CheckClean_FullCheck -> (True, True)
866+ CheckClean_NotIgnored -> (True, False)
867+ CheckClean_NoCheck -> (False, False)
868+ when checkClean $ ensureCleanGitRepo thunkDir checkIgnored
629869 "thunk pack: thunk checkout contains unsaved modifications"
630870
631871 -- Check whether there are any stashes
632− stashOutput <- readGitProcess thunkDir ["stash", "list"]
633− when checkClean $ case T.null stashOutput of
634− False -> do
872+ when checkClean $ do
873+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
874+ unless (T.null stashOutput) $
635875 failWith $ T.unlines $
636876 [ "thunk pack: thunk checkout has stashes"
637877 , "git stash list:"
638878 ] ++ T.lines stashOutput
639− True -> return ()
879+
880+ -- Get current branch
881+ (mCurrentBranch, mCurrentCommit) <- do
882+ b <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
883+ c <- listToMaybe . T.lines <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884+ case b of
885+ (Just "HEAD") -> failWith $ T.unlines
886+ [ "thunk pack: You are in 'detached HEAD' state."
887+ , "If you want to pack at the current ref \
888+ \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
889+ ]
890+ _ -> return (b, c)
640891
641892 -- Get information on all branches and their (optional) designated upstream
642893 -- correspondents
643− (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
894+ headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
644895 [ "for-each-ref"
645896 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
646897 , "refs/heads/"
@@ -686,7 +937,7 @@ getThunkPtr' checkClean thunkDir = do
686937 ]
687938
688939 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
689− stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
940+ stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
690941 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
691942 [ "rev-list", "--left-right"
692943 , T.unpack branch <> "..." <> T.unpack upstream
@@ -703,20 +954,16 @@ getThunkPtr' checkClean thunkDir = do
703954 [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
704955 , ""
705956 ] ++
706− (flip map (Map.toList nonGood) $ \(branch, (upstream, (ahead, behind))) -> mconcat
957+ flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
707958 [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
708959 [ ""
709960 , "Please push these upstream and try again. (Or just fetch, if they are somehow \
710961 \pushed but this repo's remote tracking branches don't know it.)"
711962 ]
712963
713− -- We assume it's safe to pack the thunk at this point
714− putLog Informational $ "All changes safe in git remotes. OK to pack thunk."
715−
716− -- Get current branch ``
717− mCurrentBranch <- listToMaybe
718− <$> T.lines
719− <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
964+ when checkClean $ do
965+ -- We assume it's safe to pack the thunk at this point
966+ putLog Informational "All changes safe in git remotes. OK to pack thunk."
720967
721968 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
722969
@@ -729,14 +976,12 @@ getThunkPtr' checkClean thunkDir = do
729976 remoteUri <- case parseGitUri remoteUri' of
730977 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
731978 Just uri -> pure uri
732− uriThunkPtr remoteUri mCurrentBranch
979+ uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
733980
734981-- | Get the latest revision available from the given source
735982getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
736983getLatestRev os = do
737− let gitS = case os of
738− ThunkSource_GitHub s -> forgetGithub False s
739− ThunkSource_Git s -> s
984+ let gitS = thunkSourceToGitSource os
740985 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
741986 case os of
742987 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -748,16 +993,18 @@ getLatestRev os = do
748993-- performance. If that doesn't work (e.g. authentication issue), we fall back
749994-- on just doing things the normal way for git repos in general, and save it as
750995-- a regular git thunk.
751−uriThunkPtr :: MonadObelisk m => URI -> Maybe Text -> m ThunkPtr
752−uriThunkPtr uri mbranch = do
753− (_, commit) <- gitGetCommitBranch uri mbranch
754− (src, rev) <- case uriToThunkSource uri mbranch of
996+uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997+uriThunkPtr uri mPrivate mbranch mcommit = do
998+ commit <- case mcommit of
999+ Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
1000+ (Just c) -> return c
1001+ (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
7551002 ThunkSource_GitHub s -> do
7561003 rev <- runExceptT $ githubThunkRev s commit
7571004 case rev of
7581005 Right r -> pure (ThunkSource_GitHub s, r)
7591006 Left e -> do
760− putLog Warning $ "\
1007+ putLog Warning "\
7611008\Failed to fetch archive from GitHub. This is probably a private repo. \
7621009\Falling back on normal fetchgit. Original failure:"
7631010 errorToWarning e
@@ -774,34 +1021,66 @@ uriThunkPtr uri mbranch = do
7741021-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
7751022-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
7761023-- should be employed, and so we respect that.
777−uriToThunkSource :: URI -> Maybe Text -> ThunkSource
778−uriToThunkSource u
779− | Right uriAuth <- uriAuthority u
780− , Just scheme <- unRText <$> uriScheme u
1024+uriToThunkSource :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> m ThunkSource
1025+uriToThunkSource (GitUri u) mPrivate
1026+ | Right uriAuth <- URI.uriAuthority u
1027+ , Just scheme <- URI.unRText <$> URI.uriScheme u
7811028 , case scheme of
782− "ssh" -> uriAuth == Authority
783− { authUserInfo = Just $ UserInfo (fromRight' $ mkUsername "git") Nothing
784− , authHost = fromRight' $ mkHost "github.com"
785− , authPort = Nothing
1029+ "ssh" -> uriAuth == URI.Authority
1030+ { URI.authUserInfo = Just $ URI.UserInfo (fromRight' $ URI.mkUsername "git") Nothing
1031+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
1032+ , URI.authPort = Nothing
7861033 }
7871034 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
788− && unRText (authHost uriAuth) == "github.com"
789− , Just (_, owner :| [repoish]) <- uriPath u
790− = \mbranch -> ThunkSource_GitHub $ GitHubSource
791− { _gitHubSource_owner = N $ unRText owner
792− , _gitHubSource_repo = N $ let
793− repoish' = unRText repoish
794− in case T.stripSuffix ".git" repoish' of
795− Just repo -> repo
796− Nothing -> repoish'
797− , _gitHubSource_branch = N <$> mbranch
798− }
1035+ && URI.unRText (URI.authHost uriAuth) == "github.com"
1036+ , Just (_, owner :| [repoish]) <- URI.uriPath u
1037+ = \mbranch -> do
1038+ isPrivate <- getIsPrivate
1039+ pure $ ThunkSource_GitHub $ GitHubSource
1040+ { _gitHubSource_owner = N $ URI.unRText owner
1041+ , _gitHubSource_repo = N $ let
1042+ repoish' = URI.unRText repoish
1043+ in fromMaybe repoish' $ T.stripSuffix ".git" repoish'
1044+ , _gitHubSource_branch = N <$> mbranch
1045+ , _gitHubSource_private = isPrivate
1046+ }
7991047
800− | otherwise = \mbranch -> ThunkSource_Git $ GitSource
801− { _gitSource_url = u
802− , _gitSource_branch = N <$> mbranch
803− , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
804− }
1048+ | otherwise = \mbranch -> do
1049+ isPrivate <- getIsPrivate
1050+ pure $ ThunkSource_Git $ GitSource
1051+ { _gitSource_url = GitUri u
1052+ , _gitSource_branch = N <$> mbranch
1053+ , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
1054+ , _gitSource_private = isPrivate
1055+ }
1056+ where
1057+ getIsPrivate = maybe (guessGitRepoIsPrivate $ GitUri u) pure mPrivate
1058+
1059+guessGitRepoIsPrivate :: MonadObelisk m => GitUri -> m Bool
1060+guessGitRepoIsPrivate uri = flip fix urisToTry $ \loop -> \case
1061+ [] -> pure True
1062+ uriAttempt:xs -> do
1063+ result <- readCreateProcessWithExitCode $
1064+ isolateGitProc $
1065+ gitProcNoRepo
1066+ [ "ls-remote"
1067+ , "--quiet"
1068+ , "--exit-code"
1069+ , "--symref"
1070+ , T.unpack $ gitUriToText uriAttempt
1071+ ]
1072+ case result of
1073+ (ExitSuccess, _, _) -> pure False -- Must be a public repo
1074+ _ -> loop xs
1075+ where
1076+ urisToTry = nubOrd $
1077+ -- Include the original URI if it isn't using SSH because SSH will certainly fail.
1078+ [uri | fmap URI.unRText (URI.uriScheme (unGitUri uri)) /= Just "ssh"] <>
1079+ [changeScheme "https" uri, changeScheme "http" uri]
1080+ changeScheme scheme (GitUri u) = GitUri $ u
1081+ { URI.uriScheme = URI.mkScheme scheme
1082+ , URI.uriAuthority = (\x -> x { URI.authUserInfo = Nothing }) <$> URI.uriAuthority u
1083+ }
8051084
8061085-- Funny signature indicates no effects depend on the optional branch name.
8071086githubThunkRev
@@ -813,19 +1092,19 @@ githubThunkRev
8131092githubThunkRev s commit = do
8141093 owner <- forcePP $ _gitHubSource_owner s
8151094 repo <- forcePP $ _gitHubSource_repo s
816− revTarball <- mkPathPiece $ commit <> ".tar.gz"
817− let archiveUri = URI
818− { uriScheme = Just $ fromRight' $ mkScheme "https"
819− , uriAuthority = Right $ Authority
820− { authUserInfo = Nothing
821− , authHost = fromRight' $ mkHost "github.com"
822− , authPort = Nothing
1095+ revTarball <- URI.mkPathPiece $ commit <> ".tar.gz"
1096+ let archiveUri = GitUri $ URI.URI
1097+ { URI.uriScheme = Just $ fromRight' $ URI.mkScheme "https"
1098+ , URI.uriAuthority = Right $ URI.Authority
1099+ { URI.authUserInfo = Nothing
1100+ , URI.authHost = fromRight' $ URI.mkHost "github.com"
1101+ , URI.authPort = Nothing
8231102 }
824− , uriPath = Just ( False
825− , owner :| [ repo, fromRight' $ mkPathPiece "archive", revTarball ]
1103+ , URI.uriPath = Just ( False
1104+ , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
8261105 )
827− , uriQuery = []
828− , uriFragment = Nothing
1106+ , URI.uriQuery = []
1107+ , URI.uriFragment = Nothing
8291108 }
8301109 hash <- getNixSha256ForUriUnpacked archiveUri
8311110 putLog Debug $ "Nix sha256 is " <> hash
@@ -834,8 +1113,8 @@ githubThunkRev s commit = do
8341113 , _thunkRev_nixSha256 = hash
8351114 }
8361115 where
837− forcePP :: Name entity -> m (RText 'PathPiece)
838− forcePP = mkPathPiece . untagName
1116+ forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117+ forcePP = URI.mkPathPiece . untagName
8391118
8401119gitThunkRev
8411120 :: MonadObelisk m
@@ -844,11 +1123,11 @@ gitThunkRev
8441123 -> m ThunkRev
8451124gitThunkRev s commit = do
8461125 let u = _gitSource_url s
847− protocols = ["https", "ssh", "git"]
848− Just scheme <- pure $ unRText <$> uriScheme u
1126+ protocols = ["file", "https", "ssh", "git"]
1127+ scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
8491128 unless (T.toLower scheme `elem` protocols) $
8501129 failWith $ "obelisk currently only supports "
851− <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
1130+ <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
8521131 hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
8531132 putLog Informational $ "Nix sha256 is " <> hash
8541133 pure $ ThunkRev
@@ -861,12 +1140,14 @@ gitThunkRev s commit = do
8611140--
8621141-- If the branch name is passed in, it is returned exactly as-is. If it is not
8631142-- passed it, the default branch of the repo is used instead.
1143+
8641144gitGetCommitBranch
865− :: MonadObelisk m => URI -> Maybe Text -> m (Text, CommitId)
1145+ :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
8661146gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
867− bothMaps <- gitLsRemote
868− (T.unpack $ render uri)
1147+ (_, bothMaps) <- gitLsRemote
1148+ (T.unpack $ gitUriToText uri)
8691149 (GitRef_Branch <$> mbranch)
1150+ Nothing
8701151 branch <- case mbranch of
8711152 Nothing -> withExitFailMessage "Failed to find default branch" $ do
8721153 b <- rethrowE $ gitLookupDefaultBranch bothMaps
@@ -880,18 +1161,21 @@ gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote "
8801161 pure (branch, commit)
8811162 where
8821163 rethrowE = either failWith pure
883− uriMsg = render uri
1164+ uriMsg = gitUriToText uri
1165+
1166+parseGitUri :: Text -> Maybe GitUri
1167+parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
8841168
885−parseGitUri :: Text -> Maybe URI
886−parseGitUri x = parseAbsoluteURI x <|> parseSshShorthand x
1169+parseFileURI :: Text -> Maybe URI.URI
1170+parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
8871171
888−parseAbsoluteURI :: Text -> Maybe URI
1172+parseAbsoluteURI :: Text -> Maybe URI.URI
8891173parseAbsoluteURI uri = do
890− parsedUri <- mkURI uri
891− guard $ isPathAbsolute parsedUri
892− pure $ parsedUri
1174+ parsedUri <- URI.mkURI uri
1175+ guard $ URI.isPathAbsolute parsedUri
1176+ pure parsedUri
8931177
894−parseSshShorthand :: Text -> Maybe URI
1178+parseSshShorthand :: Text -> Maybe URI.URI
8951179parseSshShorthand uri = do
8961180 -- This is what git does to check that the remote
8971181 -- is not a local file path when parsing shorthand.
@@ -904,4 +1188,4 @@ parseSshShorthand uri = do
9041188 -- This check is used to disambiguate a filepath containing a colon from shorthand
9051189 guard $ isNothing (T.findIndex (=='/') authAndHostname)
9061190 && not (T.null colonAndPath)
907− mkURI properUri
1191+ URI.mkURI properUri
lib/command/src/Obelisk/Command/Upgrade/Hash.hsdeleted−114
@@ -1,114 +0,0 @@
1−{-# LANGUAGE FlexibleContexts #-}
2−{-# LANGUAGE LambdaCase #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE TupleSections #-}
6−-- | Hash a git repo or arbitrary directory using nix-hash.
7−module Obelisk.Command.Upgrade.Hash
8− ( getDirectoryHash
9− , getHashAtGitRevision
10− ) where
11−
12−import Control.Monad (forM, forM_)
13−import Control.Monad.IO.Class (liftIO)
14−import Data.Bool (bool)
15−import Data.Maybe (catMaybes)
16−import Data.Semigroup ((<>))
17−import Data.Text (Text)
18−import qualified Data.Text as T
19−import System.Directory
20−import System.FilePath
21−import System.IO.Temp
22−import System.Process (cwd, proc)
23−
24−import Obelisk.App (MonadObelisk)
25−import Obelisk.CliApp
26−import Obelisk.Command.Utils
27−
28−import Obelisk.Migration
29−
30−-- | Get the unique hash of the given directory
31−--
32−-- Excludes the following before computing the hash:
33−-- * the specified top-level files/ directories.
34−-- * .git directory
35−-- * untracked Git files
36−-- * ignored Git files
37−-- * empty directories
38−--
39−-- Uses the same predictive algorithm as that of Nix (`nix-hash`).
40−--
41−-- This function will do a full copy of the directory to a temporary location before
42−-- computing the hash. Because it will be deleting the files in exclude list, and
43−-- other files if the directory is a git repo, which needs to be done as `nix-hash`
44−-- doesn't support taking an excludes list.
45−getDirectoryHash :: MonadObelisk m => [FilePath] -> FilePath -> m Hash
46−getDirectoryHash excludes dir = withSystemTempDirectory "obelisk-hash-" $ \tmpDir -> do
47− withSpinnerNoTrail (T.pack $ "Copying " <> dir <> " to " <> tmpDir) $ do
48− runProc $ copyDir dir tmpDir
49− getDirectoryHashDestructive excludes tmpDir
50−
51−getDirectoryHashDestructive :: MonadObelisk m => [FilePath] -> FilePath -> m Hash
52−getDirectoryHashDestructive excludes dir = do
53− liftIO (doesDirectoryExist $ dir </> ".git") >>= \case
54− True -> do
55− tidyUpGitWorkingCopy dir
56− withSpinnerNoTrail "Removing .git directory" $
57− liftIO $ removePathForcibly $ dir </> ".git"
58− False -> pure ()
59− withSpinnerNoTrail "Removing excluded paths" $ do
60− forM_ (fmap (dir </>) excludes) $
61− liftIO . removePathForcibly
62− nixHash dir
63−
64−getHashAtGitRevision :: MonadObelisk m => [Text] -> [FilePath] -> FilePath -> m [Hash]
65−getHashAtGitRevision revs excludes dir = withSystemTempDirectory "obelisk-hashrev-" $ \tmpDir -> do
66− withSpinnerNoTrail (T.pack $ "Copying " <> dir <> " to " <> tmpDir) $ do
67− runProc $ copyDir dir tmpDir
68− tidyUpGitWorkingCopy tmpDir
69− -- Discard changes to tracked files
70− runProcSilently $ gitProc tmpDir ["reset", "--hard"]
71− forM revs $ \rev -> do
72− runProcSilently $ gitProc tmpDir ["checkout", T.unpack rev]
73− -- Checking out an arbitrary revision can leave untracked files (from
74− -- previous revison) around, so tidy them up.
75− tidyUpGitWorkingCopy tmpDir
76− withFilesStashed tmpDir (excludes <> [".git"]) $
77− nixHash tmpDir
78− where
79− withFilesStashed base fs m = withSystemTempDirectory "obelisk-hashrev-stash-" $ \stashDir -> do
80− existingPaths <- fmap catMaybes $ forM fs $ \p -> do
81− liftIO (doesPathExist $ base </> p) >>= pure . bool Nothing (Just p)
82− forM_ existingPaths $ \p ->
83− liftIO $ renamePath (base </> p) (stashDir </> p)
84− result <- m
85− forM_ existingPaths $ \p ->
86− liftIO $ renamePath (stashDir </> p) (base </> p)
87− return result
88−
89−nixHash :: MonadObelisk m => FilePath -> m Hash
90−nixHash dir = withSpinnerNoTrail "Running `nix-hash`" $
91− readProc $ proc "nix-hash" [dir]
92−
93−-- | Clean up the following files in the git working copy
94−--
95−-- * Paths ignored by .gitignore, and still present
96−-- * Untracked files (not added to git index)
97−-- * Any empty directories (these are not tracked by git)
98−--
99−-- Note that this leaves modified (staged or unstaged) files as they are.
100−tidyUpGitWorkingCopy :: MonadObelisk m => FilePath -> m ()
101−tidyUpGitWorkingCopy dir = withSpinnerNoTrail "Tidying up git working copy" $ do
102− ignored <- gitLsFiles dir ["--ignored", "--exclude-standard", "--others"]
103− untracked <- gitLsFiles dir ["--exclude-standard", "--others"]
104− putLog Debug $ "Ignored: " <> T.pack (show $ length ignored) <> " files."
105− putLog Debug $ "Untracked files:\n" <> T.unlines untracked
106− withSpinnerNoTrail "Removing untracked and ignored files" $ do
107− forM_ (fmap ((dir </>) . T.unpack) $ ignored <> untracked) $
108− liftIO . removePathForcibly
109− -- Empty directories won't be included in these lists. Git doesn't track them
110− -- So we must delete these separately.
111− runProc $ proc "find" [dir, "-depth", "-empty", "-type", "d", "-delete"]
112− where
113− gitLsFiles pwd opts = fmap T.lines $ readProc $
114− (proc "git" $ ["ls-files", "."] <> opts) { cwd = Just pwd }
lib/command/src/Obelisk/Command/Utils.hs+105−24
@@ -4,33 +4,95 @@
44{-# LANGUAGE ScopedTypeVariables #-}
55{-# LANGUAGE OverloadedStrings #-}
66{-# LANGUAGE PatternGuards #-}
7+{-# LANGUAGE TemplateHaskell #-}
78module Obelisk.Command.Utils where
89
910import Control.Applicative hiding (many)
1011import Control.Monad.Except
1112import Data.Bool (bool)
12−import qualified Text.Megaparsec.Char.Lexer as ML
1313import Data.Bifunctor
1414import Data.Char
1515import Data.Either
16−import Data.Semigroup ((<>))
16+import Data.List (isInfixOf)
1717import Data.Map (Map)
1818import qualified Data.Map as M
1919import Data.Maybe (maybeToList)
20+import Data.Semigroup ((<>))
2021import Data.Text (Text)
2122import qualified Data.Text as T
2223import Data.Void (Void)
23−import System.Directory (canonicalizePath)
24−import System.Environment (getExecutablePath)
25−import qualified System.Process as P
24+import System.Exit (ExitCode)
25+import System.Which (staticWhich)
26+import qualified Text.Megaparsec.Char.Lexer as ML
2627import Text.Megaparsec as MP
2728import Text.Megaparsec.Char as MP
2829
2930import Obelisk.App (MonadObelisk)
3031import Obelisk.CliApp
3132
32−getObeliskExe :: IO FilePath
33−getObeliskExe = getExecutablePath >>= canonicalizePath
33+cp :: FilePath
34+cp = $(staticWhich "cp")
35+
36+mvPath :: FilePath
37+mvPath = $(staticWhich "mv")
38+
39+rmPath :: FilePath
40+rmPath = $(staticWhich "rm")
41+
42+ghcidExePath :: FilePath
43+ghcidExePath = $(staticWhich "ghcid")
44+
45+findExePath :: FilePath
46+findExePath = $(staticWhich "find")
47+
48+nixExePath :: FilePath
49+nixExePath = $(staticWhich "nix")
50+
51+nixBuildExePath :: FilePath
52+nixBuildExePath = $(staticWhich "nix-build")
53+
54+jreKeyToolPath :: FilePath
55+jreKeyToolPath = $(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
90+-- @../@. This will make a 'FilePath' that can be embedded in a Nix
91+-- expression.
92+toNixPath :: FilePath -> FilePath
93+toNixPath root | "/" `isInfixOf` root = root
94+ | otherwise = "./" <> root
95+
3496
3597-- Check whether the working directory is clean
3698checkGitCleanStatus :: MonadObelisk m => FilePath -> Bool -> m Bool
@@ -60,38 +122,52 @@ initGit repo = do
60122 git ["add", "."]
61123 git ["commit", "-m", "Initial commit."]
62124
63−gitProcNoRepo :: [String] -> P.CreateProcess
64−gitProcNoRepo = P.proc "git"
125+gitProcNoRepo :: [String] -> ProcessSpec
126+gitProcNoRepo args = setEnvOverride (M.singleton "GIT_TERMINAL_PROMPT" "0" <>) $ proc gitPath args
65127
66−gitProc :: FilePath -> [String] -> P.CreateProcess
128+gitProc :: FilePath -> [String] -> ProcessSpec
67129gitProc repo = gitProcNoRepo . runGitInDir
68130 where
69131 runGitInDir args' = case filter (not . null) args' of
70132 args@("clone":_) -> args <> [repo]
71133 args -> ["-C", repo] <> args
72134
73−-- | Recursively copy a directory using `cp -a`
74−copyDir :: FilePath -> FilePath -> P.CreateProcess
135+isolateGitProc :: ProcessSpec -> ProcessSpec
136+isolateGitProc = setEnvOverride (overrides <>)
137+ where
138+ overrides = M.fromList
139+ [ ("HOME", "/dev/null")
140+ , ("GIT_CONFIG_NOSYSTEM", "1")
141+ , ("GIT_TERMINAL_PROMPT", "0") -- git 2.3+
142+ , ("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")
144+ ]
145+
146+-- | Recursively copy a directory using `cp -a` -- TODO: Should use -rT instead of -a
147+copyDir :: FilePath -> FilePath -> ProcessSpec
75148copyDir src dest =
76− (P.proc "cp" ["-a", ".", dest]) { P.cwd = Just src }
149+ setCwd (Just src) $ proc cp ["-a", ".", dest] -- TODO: This will break if dest is relative since we change cwd
77150
78151readGitProcess :: MonadObelisk m => FilePath -> [String] -> m Text
79152readGitProcess repo = readProcessAndLogOutput (Debug, Notice) . gitProc repo
80153
154+readGitProcessNoRepo :: MonadObelisk m => [String] -> m Text
155+readGitProcessNoRepo = readProcessAndLogOutput (Debug, Notice) . gitProcNoRepo
156+
81157processToShellString :: FilePath -> [String] -> String
82158processToShellString cmd args = unwords $ map quoteAndEscape (cmd : args)
83159 where quoteAndEscape x = T.unpack $ "'" <> T.replace "'" "'\''" (T.pack x) <> "'"
84160
85161-- | A simpler wrapper for CliApp's most used process function with sensible defaults.
86−runProc :: MonadObelisk m => P.CreateProcess -> m ()
162+runProc :: MonadObelisk m => ProcessSpec -> m ()
87163runProc = callProcessAndLogOutput (Notice, Error)
88164
89165-- | Like runProc, but all output goes to Debug logging level
90−runProcSilently :: MonadObelisk m => P.CreateProcess -> m ()
166+runProcSilently :: MonadObelisk m => ProcessSpec -> m ()
91167runProcSilently = callProcessAndLogOutput (Debug, Debug)
92168
93169-- | A simpler wrapper for CliApp's readProcessAndLogStderr with sensible defaults.
94−readProc :: MonadObelisk m => P.CreateProcess -> m Text
170+readProc :: MonadObelisk m => ProcessSpec -> m Text
95171readProc = readProcessAndLogOutput (Debug, Error)
96172
97173tshow :: Show a => a -> Text
@@ -119,16 +195,21 @@ gitLsRemote
119195 :: MonadObelisk m
120196 => String
121197 -> Maybe GitRef
122− -> m GitLsRemoteMaps
123−gitLsRemote repository mRef = do
124− t <- readProc $ gitProcNoRepo $
125− ["ls-remote", "--symref", repository]
126− ++ (maybeToList $ T.unpack . showGitRef <$> mRef)
198+ -> Maybe String
199+ -> m (ExitCode, GitLsRemoteMaps)
200+gitLsRemote repository mRef mBranch = do
201+ (exitCode, out, _err) <- case mBranch of
202+ Nothing -> readCreateProcessWithExitCode $ gitProcNoRepo $
203+ ["ls-remote", "--exit-code", "--symref", repository]
204+ ++ maybeToList (T.unpack . showGitRef <$> mRef)
205+ Just branchName -> readCreateProcessWithExitCode $ gitProcNoRepo
206+ ["ls-remote", "--exit-code", repository, branchName]
207+ let t = T.pack out
127208 maps <- case MP.runParser parseLsRemote "" t of
128− Left err -> failWith $ T.pack $ MP.parseErrorPretty' t err
129− Right table -> pure $ bimap M.fromList M.fromList $ partitionEithers $ table
209+ Left err -> failWith $ T.pack $ MP.errorBundlePretty err
210+ Right table -> pure $ bimap M.fromList M.fromList $ partitionEithers table
130211 putLog Debug $ "git ls-remote maps: " <> T.pack (show maps)
131− pure maps
212+ pure (exitCode, maps)
132213
133214lexeme :: Parsec Void Text a -> Parsec Void Text a
134215lexeme = ML.lexeme $ void $ MP.takeWhileP (Just "within-line white space") $
lib/command/src/Obelisk/Command/VmBuilder.hs+11−10
@@ -18,10 +18,10 @@ import System.Directory (createDirectoryIfMissing)
1818import System.Exit (ExitCode(..))
1919import System.FilePath ((<.>), (</>))
2020import qualified System.Info
21−import System.Process (proc)
2221
2322import Obelisk.App (MonadObelisk, getObeliskUserStateDir)
2423import Obelisk.CliApp
24+import Obelisk.Command.Utils (rmPath, whichPath, sshKeygenPath, nixBuildExePath, dockerPath)
2525
2626-- | Generate the `--builders` argument string to enable the VM builder after ensuring it is available.
2727getNixBuildersArg :: MonadObelisk m => m String
@@ -35,7 +35,7 @@ getNixBuildersArg = do
3535
3636checkForNixDarwin :: MonadObelisk m => String -> m ()
3737checkForNixDarwin sshIdFile = do
38− (exitCode, _, _) <- readCreateProcessWithExitCode $ proc "which" ["darwin-rebuild"]
38+ (exitCode, _, _) <- readCreateProcessWithExitCode $ proc whichPath ["darwin-rebuild"]
3939 unless (exitCode == ExitSuccess) $ failWith $ T.intercalate "\n"
4040 [ "Deployments from macOS require nix-darwin to be installed."
4141 , "Follow the installation instructions here: https://github.com/LnL7/nix-darwin"
@@ -67,7 +67,7 @@ containerExists :: MonadObelisk m => FilePath -> m Bool
6767containerExists stateDir = handle (\(_ :: IOError) -> failWith needDockerMsg) $ do
6868 containerNames <- fmap (map T.strip . T.lines) $
6969 readProcessAndLogStderr Error $
70− proc "docker" ["container", "list", "--all", "--format", "{{.Names}}"]
70+ proc dockerPath ["container", "list", "--all", "--format", "{{.Names}}"]
7171 let exists = containerName `elem` containerNames
7272 when exists $ testLinuxBuild stateDir
7373 pure exists
@@ -85,7 +85,7 @@ containerSshPort = 2222
8585startContainer :: MonadObelisk m => m ()
8686startContainer = withSpinner "Starting VM builder" $
8787 callProcessAndLogOutput (Debug, Debug) $
88− proc "docker" ["start", containerName]
88+ proc dockerPath ["start", containerName]
8989
9090-- | Creates the Docker container; assumes it does not exist.
9191setupNixDocker :: MonadObelisk m => FilePath -> m ()
@@ -96,14 +96,14 @@ setupNixDocker stateDir = withSpinner ("Creating Docker container named " <> con
9696
9797 -- Create new SSH keys for this container
9898 callProcessAndLogOutput (Debug, Error) $
99− proc "rm" ["-f", stateDir </> sshKeyFileName, stateDir </> sshKeyFileName <.> "pub"]
99+ proc rmPath ["-f", stateDir </> sshKeyFileName, stateDir </> sshKeyFileName <.> "pub"]
100100 callProcessAndLogOutput (Debug, Error) $
101− proc "ssh-keygen" ["-t", "ed25519", "-f", stateDir </> sshKeyFileName, "-P", ""]
101+ proc sshKeygenPath ["-t", "ed25519", "-f", stateDir </> sshKeyFileName, "-P", ""]
102102
103103 -- Build the docker container (which uses the SSH keys in the 'ssh' folder)
104104 containerId <- fmap T.strip $ readProcessAndLogStderr Error $
105− proc "docker" ["build", stateDir, "--quiet"]
106− callProcessAndLogOutput (Debug, Error) $ proc "docker"
105+ proc dockerPath ["build", stateDir, "--quiet"]
106+ callProcessAndLogOutput (Debug, Error) $ proc dockerPath
107107 [ "run"
108108 , "--restart", "always"
109109 , "--detach"
@@ -155,8 +155,9 @@ testLinuxBuild :: MonadObelisk m => FilePath -> m ()
155155testLinuxBuild stateDir
156156 | System.Info.os == "linux" = failWith "Using the docker builder is not necessary on linux."
157157 | otherwise = do
158− (exitCode, _stdout, stderr) <- readCreateProcessWithExitCode $ proc "nix-build"
159− [ "-E", "(import <nixpkgs> { system = \"x86_64-linux\"; }).writeText \"test\" builtins.currentTime"
158+ (exitCode, _stdout, stderr) <- readCreateProcessWithExitCode $ proc nixBuildExePath
159+ [ "--no-out-link"
160+ , "-E", "(import <nixpkgs> { system = \"x86_64-linux\"; }).writeText \"test\" builtins.currentTime"
160161 , "--builders", nixBuildersArgString stateDir
161162 ]
162163 unless (exitCode == ExitSuccess) $ do
lib/executable-config/default.nix+38−16
@@ -2,22 +2,44 @@
22# configuration information into a canonical location. It also provides a haskell
33# package that can be used to retrieve the injected configuration on each supported
44# platform.
5−{ nixpkgs
6−, filterGitSource # TODO define this in obelisk
5+{ lib
6+, runCommand
7+, obeliskCleanSource
78}:
8−let injectConfig = config: assets: nixpkgs.runCommand "inject-config" {} ''
9− set -x
10− mkdir -p $out
11− cp --no-preserve=mode -Lr "${assets}" $out/static
12− chmod +w "$out"
13− if ! mkdir $out/config; then
14− 2>&1 echo config directory already exists or could not be created
15− exit 1
16− fi
17− cp -a "${config}"/* "$out/config"
18− '';
19−in with nixpkgs.haskell.lib; {
20− haskellPackage = self: self.callPackage (filterGitSource ./lookup) {};
9+
10+let
11+ injectConfig = config: assets: runCommand "inject-config" {} (''
12+ set -x
13+ mkdir -p $out
14+ cp --no-preserve=mode -Lr "${assets}" $out/static
15+ chmod +w "$out"
16+ '' + lib.optionalString (!(builtins.isNull config)) ''
17+ if ! mkdir $out/config; then
18+ 2>&1 echo config directory already exists or could not be created
19+ exit 1
20+ fi
21+ cp -a "${config}"/* "$out/config"
22+ # Needed for android deployments
23+ find "$out/config" -type f -printf '%P\0' > "$out/config.files"
24+ '');
25+in
26+
27+{
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) {})
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+ };
42+
2143 platforms = {
2244 android = {
2345 # Inject the given config directory into an android assets folder
@@ -28,7 +50,7 @@ in with nixpkgs.haskell.lib; {
2850 inject = injectConfig;
2951 };
3052 web = {
31− inject = self: self.callCabal2nix "obelisk-executable-config-inject" (filterGitSource ./inject) {};
53+ inject = self: self.callCabal2nix "obelisk-executable-config-inject" (obeliskCleanSource ./inject) {};
3254 };
3355 };
3456}
lib/executable-config/inject/obelisk-executable-config-inject.cabal+3−3
@@ -9,10 +9,10 @@ library
99 build-depends:
1010 base,
1111 bytestring,
12− directory,
13− filepath,
12+ base64-bytestring,
13+ containers,
1414 reflex-dom-core,
1515 text
1616
1717 exposed-modules: Obelisk.ExecutableConfig.Inject
18− ghc-options: -Wall
18+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
lib/executable-config/inject/src/Obelisk/ExecutableConfig/Inject.hs+14−40
@@ -2,50 +2,24 @@
22module Obelisk.ExecutableConfig.Inject where
33
44import Control.Monad (mapM_)
5−import Control.Monad.IO.Class (MonadIO, liftIO)
6−import Data.Semigroup ((<>))
5+import Control.Monad.IO.Class (MonadIO)
76import Data.ByteString (ByteString)
7+import qualified Data.ByteString.Base64 as B64
8+import Data.Map (Map)
9+import qualified Data.Map as Map
10+import Data.Semigroup ((<>))
811import Data.Text (Text)
9−import qualified Data.Text as T
10−import qualified Data.Text.IO as T
12+import qualified Data.Text.Encoding as T
1113import Reflex.Dom.Core hiding (value)
12−import System.Directory
13−import System.FilePath ((</>))
14−
15−-- | Produces a @<script>@ tag containing the contents of the config item,
16−-- rendered as a 'ByteString'.
17−inject :: FilePath -> IO ByteString
18−inject key = do
19− value <- T.readFile key
20− fmap snd $ renderStatic $ injectPure (T.pack key) value
2114
2215-- | Produces a @<script>@ tag with an @id@ attribute containing the key and
23−-- whose value is the provided configuration
24−injectPure :: DomBuilder t m => Text -> Text -> m ()
16+-- whose value is the provided configuration, encoded in base64.
17+injectPure :: DomBuilder t m => Text -> ByteString -> m ()
2518injectPure key value =
26− let attrs = ("type" =: "text/plain" <> "id" =: ("config-" <> key))
27− in elAttr "script" attrs $ text value
28−
29−-- | Scans the "common" and "frontend" configuration folders and produces
30−-- injectable @<script>@ tags containing the configuration keys (filepaths) and
31−-- values.
32−injectExecutableConfigs :: (MonadIO m, DomBuilder t m) => m ()
33−injectExecutableConfigs = do
34− cfgC <- getConfigs "config/common"
35− cfgF <- getConfigs "config/frontend"
36− mapM_ (uncurry injectPure) (cfgC <> cfgF)
19+ let attrs = ("type" =: "text/plain" <> "data-obelisk-executable-config-inject-key" =: key <> "data-hydration-skip" =: "")
20+ in elAttr "script" attrs $ text (T.decodeUtf8 (B64.encode value))
3721
38−getConfigs :: MonadIO m => FilePath -> m [(Text, Text)]
39−getConfigs fp = liftIO $ do
40− dir <- doesDirectoryExist fp
41− if dir
42− then do
43− ps <- listDirectory fp
44− fmap concat $ mapM (\p -> getConfigs $ fp </> p) ps
45− else do
46− file <- doesFileExist fp
47− if file
48− then do
49− f <- T.readFile fp
50− return [(T.pack fp, f)]
51− else return []
22+-- | Produces injectable @<script>@ tags containing the configuration keys
23+-- (filepaths) and values.
24+injectExecutableConfigs :: (MonadIO m, DomBuilder t m) => Map Text ByteString -> m ()
25+injectExecutableConfigs = mapM_ (uncurry injectPure) . Map.toList
lib/executable-config/lookup/default.nixdeleted−24
@@ -1,24 +0,0 @@
1−{ hostPlatform, ghc
2−, mkDerivation, base, bytestring, filepath, stdenv, text, transformers
3−, android-activity ? null, jsaddle-wkwebview ? null, ghcjs-dom ? null
4−}:
5−let isAndroid = hostPlatform.libc == "bionic";
6− isIOS = hostPlatform.isDarwin && hostPlatform.isAarch64;
7− isGhcjs = ghc.isGhcjs or false;
8−in mkDerivation {
9− pname = "obelisk-executable-config";
10− version = "0.1";
11− src = ./.;
12− libraryHaskellDepends = [
13− base bytestring filepath text transformers
14− ] ++ (if isAndroid then [
15− android-activity
16− ] else if isIOS then [
17− jsaddle-wkwebview
18− ] else if isGhcjs then [
19− ghcjs-dom
20− ] else [
21− ]);
22− license = stdenv.lib.licenses.bsd3;
23−}
24−
lib/executable-config/lookup/obelisk-executable-config-lookup.cabalnew file+48
@@ -0,0 +1,48 @@
1+name: obelisk-executable-config-lookup
2+version: 0.1.1
3+cabal-version: >= 1.2
4+build-type: Simple
5+
6+library
7+ exposed-modules: Obelisk.ExecutableConfig.Lookup, Obelisk.Configs
8+ if os(ios)
9+ hs-source-dirs: src-ios, src
10+ other-modules: Obelisk.Configs.Internal.Directory
11+ build-depends: jsaddle-wkwebview
12+ build-depends: directory
13+ else
14+ if os(linux-android)
15+ hs-source-dirs: src-android, src
16+ c-sources: cbits/ExecutableConfig.c
17+ other-modules: Obelisk.ExecutableConfig.Internal.AssetManager
18+ build-depends: android-activity
19+ ld-options: -landroid
20+ else
21+ if impl(ghcjs)
22+ hs-source-dirs: src-ghcjs, src
23+ build-depends: ghcjs-dom
24+ else
25+ hs-source-dirs: src-other, src
26+ other-modules: Obelisk.Configs.Internal.Directory
27+ build-depends: directory
28+
29+ build-depends:
30+ base,
31+ base64-bytestring,
32+ bytestring,
33+ containers,
34+ exceptions,
35+ filepath,
36+ jsaddle,
37+ mmorph,
38+ monad-control,
39+ mtl,
40+ primitive,
41+ ref-tf,
42+ reflex-dom-core,
43+ reflex,
44+ text,
45+ transformers-base,
46+ transformers
47+
48+ ghc-options: -Wall
lib/executable-config/lookup/obelisk-executable-config.cabaldeleted−30
@@ -1,30 +0,0 @@
1−name: obelisk-executable-config
2−version: 0.1.1
3−cabal-version: >= 1.2
4−build-type: Simple
5−
6−library
7− exposed-modules: Obelisk.ExecutableConfig
8− if os(ios)
9− hs-source-dirs: src-ios
10− build-depends: jsaddle-wkwebview
11− else
12− if os(linux-android)
13− hs-source-dirs: src-android
14− c-sources: cbits/ExecutableConfig.c
15− other-modules: Obelisk.ExecutableConfig.Internal.AssetManager
16− build-depends: android-activity
17− ld-options: -landroid
18− else
19− if impl(ghcjs)
20− hs-source-dirs: src-ghcjs
21− build-depends: ghcjs-dom
22− else
23− hs-source-dirs: src
24−
25− build-depends:
26− base,
27− bytestring,
28− filepath,
29− text,
30− transformers
lib/executable-config/lookup/src-android/Obelisk/ExecutableConfig.hsdeleted−27
@@ -1,27 +0,0 @@
1−module Obelisk.ExecutableConfig (get) where
2−
3−import Control.Exception (bracket)
4−import qualified Data.ByteString as BS
5−import Data.Text (Text)
6−import qualified Data.Text as T
7−import qualified Data.Text.Encoding as T
8−import Foreign.C.String (withCString)
9−import Foreign.Ptr (nullPtr)
10−import System.FilePath.Posix ((</>))
11−
12−import Obelisk.ExecutableConfig.Internal.AssetManager
13−
14−get :: Text -> IO (Maybe Text)
15−get name = bracket getAssets freeAssetManager $ \mgrObj -> do
16− mgr <- assetManagerFromJava mgrObj
17− let open = do
18− a <- withCString (T.unpack name) $ \fn ->
19− assetManager_open mgr fn 3
20− return $ if unAAsset a == nullPtr
21− then Nothing
22− else Just a
23− close = mapM_ asset_close
24− bracket open close $ mapM $ \asset -> do
25− b <- asset_getBuffer asset
26− l <- asset_getLength asset
27− fmap T.decodeUtf8 $ BS.packCStringLen (b, fromIntegral l)
lib/executable-config/lookup/src-android/Obelisk/ExecutableConfig/Lookup.hsnew file+60
@@ -0,0 +1,60 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+module Obelisk.ExecutableConfig.Lookup where
4+
5+import Control.Exception (bracket)
6+import Control.Monad (forM)
7+import Data.ByteString (ByteString)
8+import qualified Data.ByteString as BS
9+import Data.Map (Map)
10+import qualified Data.Map as Map
11+import Data.Text (Text)
12+import qualified Data.Text.Encoding as T
13+import Foreign.C.String (withCString)
14+import Foreign.Ptr (nullPtr)
15+
16+import Obelisk.ExecutableConfig.Internal.AssetManager
17+
18+getFromMgr :: AAssetManager -> BS.ByteString -> IO (Maybe ByteString)
19+getFromMgr mgr name = do
20+ let open = do
21+ a <- BS.useAsCString name $ \fn ->
22+ assetManager_open mgr fn 3
23+ return $ if unAAsset a == nullPtr
24+ then Nothing
25+ else Just a
26+ close = mapM_ asset_close
27+ bracket open close $ mapM $ \asset -> do
28+ b <- asset_getBuffer asset
29+ l <- asset_getLength asset
30+ BS.packCStringLen (b, fromIntegral l)
31+
32+getConfigs :: IO (Map Text ByteString)
33+getConfigs = fmap (Map.mapKeys T.decodeUtf8) $ bracket getAssets freeAssetManager $ \mgrObj -> do
34+ mgr <- assetManagerFromJava mgrObj
35+ let openDir = do
36+ d <- withCString "config.files" $ \fn ->
37+ assetManager_open mgr fn 3
38+ return $ if unAAsset d == nullPtr
39+ then Nothing
40+ else Just d
41+ closeDir = mapM_ asset_close
42+ configPaths <- bracket openDir closeDir $ \case
43+ Just asset -> do
44+ b <- asset_getBuffer asset
45+ l <- asset_getLength asset
46+ lines0 <$> BS.packCStringLen (b, fromIntegral l)
47+ Nothing -> error "could not open configuration manifest 'config.files'"
48+ result <- fmap Map.fromList $ forM configPaths $ \fp ->
49+ getFromMgr mgr ("config/" <> fp) >>= \case
50+ Just v -> return (fp, v)
51+ Nothing -> error $ "Config present in config.files but not in assets: " <> show fp
52+ putStrLn $ "getConfigs: found " <> show result
53+ pure result
54+
55+lines0 :: BS.ByteString -> [BS.ByteString]
56+lines0 ps
57+ | BS.null ps = []
58+ | otherwise = case BS.elemIndex 0 ps of
59+ Nothing -> [ps]
60+ Just n -> BS.take n ps : lines0 (BS.drop (n+1) ps)
lib/executable-config/lookup/src-ghcjs/Obelisk/ExecutableConfig.hsdeleted−17
@@ -1,17 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Obelisk.ExecutableConfig where
3−
4−import Control.Monad.Trans.Maybe
5−import Data.Semigroup ((<>))
6−import Data.Text (Text)
7−import GHCJS.DOM
8−import GHCJS.DOM.Document
9−import GHCJS.DOM.Element
10−import GHCJS.DOM.NonElementParentNode
11−
12−get :: Text -> IO (Maybe Text)
13−get item = runMaybeT $ do
14− doc <- MaybeT currentDocument
15− e <- MaybeT $ getElementById doc $ "config-" <> item
16− getInnerHTML e
17−
lib/executable-config/lookup/src-ghcjs/Obelisk/ExecutableConfig/Lookup.hsnew file+51
@@ -0,0 +1,51 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+module Obelisk.ExecutableConfig.Lookup where
4+
5+import Data.ByteString (ByteString)
6+import qualified Data.ByteString.Base64 as B64
7+import Data.Map (Map)
8+import qualified Data.Map as Map
9+import Data.Maybe (catMaybes)
10+import Data.Text (Text)
11+import qualified Data.Text.Encoding as T
12+import Data.Traversable (for)
13+import GHCJS.DOM
14+import GHCJS.DOM.Document (getHead)
15+import GHCJS.DOM.DOMStringMap (get)
16+import GHCJS.DOM.Element (getInnerHTML)
17+import GHCJS.DOM.HTMLElement (HTMLElement(HTMLElement), getDataset)
18+import GHCJS.DOM.NodeList (IsNodeList, item, getLength)
19+import GHCJS.DOM.ParentNode (querySelectorAll)
20+import GHCJS.DOM.Types (MonadJSM, Node(Node), castTo)
21+
22+getConfigs :: IO (Map Text ByteString)
23+getConfigs = do
24+ Just doc <- currentDocument
25+ Just hd <- getHead doc
26+ nodes <- nodeListNodes =<< querySelectorAll hd ("[data-obelisk-executable-config-inject-key]" :: Text)
27+ fmap Map.fromList $ for nodes $ \node -> do
28+ e <- castTo HTMLElement node >>= \case
29+ Nothing -> error "Found node with data attribute obelisk-executable-config-inject-key that is not an HTMLElement."
30+ Just htmlE -> return htmlE
31+ dataset <- getDataset e
32+ (,)
33+ -- the key is camelCased: https://html.spec.whatwg.org/multipage/dom.html#dom-dataset
34+ <$> get dataset ("obeliskExecutableConfigInjectKey" :: Text)
35+ <*> (fmap decodeOrFail (getInnerHTML e))
36+ where
37+ decodeOrFail x = case B64.decode (T.encodeUtf8 x) of
38+ Left e -> error ("Obelisk.ExecutableConfig.Lookup.getConfigs: error when decoding base64: " ++ e)
39+ Right x' -> x'
40+
41+-- | Collect all nodes in the node list.
42+--
43+-- TODO: this and the version in obelisk-frontend should be
44+-- upstreamed to jsaddle.
45+nodeListNodes :: (IsNodeList l, MonadJSM m) => l -> m [Node]
46+nodeListNodes es = do
47+ len <- getLength es
48+ -- Warning! len is unsigned. If the NodeList is empty, we must avoid
49+ -- accidentally traversing over [0..maxBound::Word]
50+ nodes <- traverse (item es) $ if len == 0 then [] else [0..len-1]
51+ pure $ catMaybes nodes
lib/executable-config/lookup/src-ios/Obelisk/ExecutableConfig.hsdeleted−22
@@ -1,22 +0,0 @@
1−module Obelisk.ExecutableConfig (get) where
2−
3−import Control.Exception
4−import Control.Monad
5−import Control.Monad.Trans.Maybe
6−import Data.ByteString as BS
7−import Data.Text (Text)
8−import qualified Data.Text as T
9−import qualified Data.Text.IO as T
10−import qualified Data.Text.Encoding as T
11−import Language.Javascript.JSaddle.WKWebView
12−import System.FilePath.Posix ((</>))
13−import System.IO.Error
14−
15−get :: Text -> IO (Maybe Text)
16−get name = fmap join $ mainBundleResourcePath >>= \mp -> forM mp $ \p ->
17− catchDoesNotExist $ T.readFile $ T.unpack (T.decodeUtf8 p) </> T.unpack name
18−
19−catchDoesNotExist :: IO a -> IO (Maybe a)
20−catchDoesNotExist f = catchJust doesNotExist (Just <$> f) $ const $ return Nothing
21− where
22− doesNotExist e = if isDoesNotExistError e then Just () else Nothing
lib/executable-config/lookup/src-ios/Obelisk/ExecutableConfig/Lookup.hsnew file+17
@@ -0,0 +1,17 @@
1+{-# LANGUAGE LambdaCase #-}
2+module Obelisk.ExecutableConfig.Lookup where
3+
4+import Data.ByteString (ByteString)
5+import Data.Map (Map)
6+import Data.Text (Text)
7+import qualified Data.Text as T
8+import qualified Data.Text.Encoding as T
9+import Language.Javascript.JSaddle.WKWebView
10+import System.FilePath.Posix
11+
12+import Obelisk.Configs.Internal.Directory
13+
14+getConfigs :: IO (Map Text ByteString)
15+getConfigs = mainBundleResourcePath >>= \case
16+ Nothing -> error "Could not get bundle resource path."
17+ Just p -> getConfigsFromDirectory $ T.unpack (T.decodeUtf8 p) </> "config"
lib/executable-config/lookup/src-other/Obelisk/ExecutableConfig/Lookup.hsnew file+11
@@ -0,0 +1,11 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Obelisk.ExecutableConfig.Lookup where
3+
4+import Data.Map (Map)
5+import Data.Text (Text)
6+import Data.ByteString (ByteString)
7+
8+import Obelisk.Configs.Internal.Directory (getConfigsFromDirectory)
9+
10+getConfigs :: IO (Map Text ByteString)
11+getConfigs = getConfigsFromDirectory "config"
lib/executable-config/lookup/src/Obelisk/Configs.hsnew file+148
@@ -0,0 +1,148 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DefaultSignatures #-}
4+{-# LANGUAGE DeriveFunctor #-}
5+{-# LANGUAGE FlexibleContexts #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
9+{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE RankNTypes #-}
11+{-# LANGUAGE TypeFamilies #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+module Obelisk.Configs
14+ ( HasConfigs(..)
15+ , ConfigsT
16+ , runConfigsT
17+ , mapConfigsT
18+ , getTextConfig
19+ ) where
20+
21+import Control.Applicative (Alternative)
22+import Control.Monad (MonadPlus)
23+import Control.Monad.Base (MonadBase)
24+import Control.Monad.Catch (MonadThrow)
25+import Control.Monad.Fail (MonadFail)
26+import Control.Monad.Fix (MonadFix)
27+import Control.Monad.IO.Class (MonadIO)
28+import Control.Monad.Morph (MFunctor)
29+import Control.Monad.Primitive (PrimMonad, PrimState, primitive)
30+import Control.Monad.Ref (MonadRef)
31+import Control.Monad.Trans (MonadTrans, lift)
32+import Control.Monad.Trans.Control (MonadBaseControl)
33+import Control.Monad.Trans.Reader (ReaderT (..), ask, mapReaderT)
34+import Control.Monad.Trans.State (StateT)
35+import qualified Control.Monad.Trans.State.Strict as Strict
36+import Data.ByteString (ByteString)
37+import Data.Map (Map)
38+import qualified Data.Map as Map
39+import Data.Text (Text)
40+import qualified Data.Text.Encoding as T
41+import Reflex
42+import Reflex.Host.Class (MonadReflexCreateTrigger)
43+import Reflex.Dom.Core
44+ ( DomBuilder
45+ , DomRenderHook
46+ , HasDocument
47+ , HasJS
48+ , HasJSContext
49+ , Prerender (Client)
50+ , StaticDomBuilderT
51+ , prerender
52+ )
53+#ifndef ghcjs_HOST_OS
54+import Language.Javascript.JSaddle (MonadJSM)
55+#endif
56+
57+class Monad m => HasConfigs m where
58+ getConfigs :: m (Map Text ByteString)
59+ default getConfigs :: (HasConfigs m', m ~ t m', MonadTrans t) => m (Map Text ByteString)
60+ getConfigs = lift getConfigs
61+ getConfig :: Text -> m (Maybe ByteString)
62+ getConfig k = do
63+ configs <- getConfigs
64+ return $ Map.lookup k configs
65+
66+instance Monad m => HasConfigs (ConfigsT m) where
67+ getConfigs = ConfigsT ask
68+
69+getTextConfig :: HasConfigs m => Text -> m (Maybe Text)
70+getTextConfig k = fmap T.decodeUtf8 <$> getConfig k
71+
72+instance HasConfigs m => HasConfigs (BehaviorWriterT t w m)
73+instance HasConfigs m => HasConfigs (DynamicWriterT t w m)
74+instance HasConfigs m => HasConfigs (EventWriterT t w m)
75+instance HasConfigs m => HasConfigs (PostBuildT t m)
76+instance HasConfigs m => HasConfigs (QueryT t q m)
77+instance HasConfigs m => HasConfigs (ReaderT r m)
78+instance 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)
81+instance HasConfigs m => HasConfigs (StaticDomBuilderT t m)
82+instance HasConfigs m => HasConfigs (TriggerEventT t m)
83+
84+newtype ConfigsT m a = ConfigsT { unConfigsT :: ReaderT (Map Text ByteString) m a }
85+ deriving
86+ ( Functor
87+ , Applicative
88+ , Monad
89+ , MonadPlus
90+ , Alternative
91+ , MonadFail
92+ , MonadFix
93+ , MonadThrow
94+ , MonadIO
95+ , MonadBase m'
96+ , MonadBaseControl m'
97+ , MonadRef
98+ , MonadTrans
99+ , MFunctor
100+ , DomBuilder t
101+ , MonadHold t
102+ , MonadReflexCreateTrigger t
103+ , MonadSample t
104+ , NotReady t
105+ , PostBuild t
106+ , TriggerEvent t
107+ , HasDocument
108+ , DomRenderHook t
109+ , HasJSContext
110+ , HasJS js
111+#ifndef ghcjs_HOST_OS
112+ , MonadJSM
113+#endif
114+ )
115+
116+instance PerformEvent t m => PerformEvent t (ConfigsT m) where
117+ type Performable (ConfigsT m) = ConfigsT (Performable m)
118+ performEvent e = ConfigsT $ ReaderT $ \configs ->
119+ performEvent $ runConfigsT configs <$> e
120+ performEvent_ e = ConfigsT $ ReaderT $ \configs ->
121+ performEvent_ $ runConfigsT configs <$> e
122+
123+instance Adjustable t m => Adjustable t (ConfigsT m) where
124+ runWithReplace a e = ConfigsT $ runWithReplace (unConfigsT a) (unConfigsT <$> e)
125+ traverseDMapWithKeyWithAdjust f m e = ConfigsT $ traverseDMapWithKeyWithAdjust (\k v -> unConfigsT $ f k v) m e
126+ traverseIntMapWithKeyWithAdjust f m e = ConfigsT $ traverseIntMapWithKeyWithAdjust (\k v -> unConfigsT $ f k v) m e
127+ traverseDMapWithKeyWithAdjustWithMove f m e = ConfigsT $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unConfigsT $ f k v) m e
128+
129+instance Prerender js t m => Prerender js t (ConfigsT m) where
130+ type Client (ConfigsT m) = ConfigsT (Client m)
131+ prerender server client = ConfigsT $ ReaderT $ \configs ->
132+ prerender (runConfigsT configs server) (runConfigsT configs client)
133+
134+instance PrimMonad m => PrimMonad (ConfigsT m) where
135+ type PrimState (ConfigsT m) = PrimState m
136+ primitive = lift . primitive
137+
138+runConfigsT
139+ :: Map Text ByteString
140+ -> ConfigsT m a
141+ -> m a
142+runConfigsT cs child = runReaderT (unConfigsT child) cs
143+
144+mapConfigsT
145+ :: (forall x. m x -> n x)
146+ -> ConfigsT m a
147+ -> ConfigsT n a
148+mapConfigsT f (ConfigsT x) = ConfigsT $ mapReaderT f x
lib/executable-config/lookup/src/Obelisk/Configs/Internal/Directory.hsnew file+24
@@ -0,0 +1,24 @@
1+{-# LANGUAGE LambdaCase #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+module Obelisk.Configs.Internal.Directory where
4+
5+import Control.Monad
6+import Data.ByteString (ByteString)
7+import qualified Data.ByteString as BS
8+import Data.Map (Map)
9+import qualified Data.Map as Map
10+import Data.Text (Text)
11+import qualified Data.Text as T
12+import System.Directory
13+import System.FilePath.Posix
14+
15+getConfigsFromDirectory :: FilePath -> IO (Map Text ByteString)
16+getConfigsFromDirectory base = doesDirectoryExist base >>= \case
17+ True -> do
18+ ps <- listDirectory base
19+ fmap mconcat $ forM ps $ \p -> do
20+ subdirConfigs <- getConfigsFromDirectory $ base </> p
21+ pure $ Map.mapKeys (T.pack . (p </>) . T.unpack) subdirConfigs
22+ False -> doesFileExist base >>= \case
23+ True -> Map.singleton "" <$> BS.readFile base
24+ False -> pure mempty
lib/executable-config/lookup/src/Obelisk/ExecutableConfig.hsdeleted−13
@@ -1,13 +0,0 @@
1−module Obelisk.ExecutableConfig (get) where
2−
3−import Control.Exception
4−import Data.Text (Text)
5−import Data.Text as T
6−import Data.Text.IO as T
7−import System.FilePath.Posix ((</>))
8−import System.IO.Error
9−
10−get :: Text -> IO (Maybe Text)
11−get path = do
12− let doesNotExist = \e -> if isDoesNotExistError e then Just () else Nothing
13− catchJust doesNotExist (fmap Just $ T.readFile $ T.unpack path) (\_ -> pure Nothing)
lib/frontend/obelisk-frontend.cabal+9−2
@@ -7,10 +7,15 @@ library
77 hs-source-dirs: src
88 build-depends: base,
99 bytestring,
10+ containers,
11+ cookie,
1012 dependent-sum,
1113 ghcjs-dom,
1214 jsaddle,
1315 lens,
16+ mtl,
17+ obelisk-executable-config-inject,
18+ obelisk-executable-config-lookup,
1419 obelisk-route,
1520 primitive,
1621 ref-tf,
@@ -18,5 +23,7 @@ library
1823 reflex-dom-core,
1924 text,
2025 transformers
21− exposed-modules: Obelisk.Frontend
22− ghc-options: -Wall
26+ exposed-modules:
27+ Obelisk.Frontend
28+ Obelisk.Frontend.Cookie
29+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
lib/frontend/src/Obelisk/Frontend.hs+182−96
@@ -1,10 +1,13 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE ConstraintKinds #-}
23{-# LANGUAGE FlexibleContexts #-}
34{-# LANGUAGE FlexibleInstances #-}
45{-# LANGUAGE LambdaCase #-}
56{-# LANGUAGE MultiParamTypeClasses #-}
67{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE PackageImports #-}
79{-# LANGUAGE RankNTypes #-}
10+{-# LANGUAGE RecursiveDo #-}
811{-# LANGUAGE ScopedTypeVariables #-}
912{-# LANGUAGE TemplateHaskell #-}
1013{-# LANGUAGE TypeFamilies #-}
@@ -13,39 +16,55 @@ module Obelisk.Frontend
1316 ( ObeliskWidget
1417 , Frontend (..)
1518 , runFrontend
19+ , runFrontendWithConfigsAndCurrentRoute
1620 , renderFrontendHtml
21+ , removeHTMLConfigs
22+ , FrontendMode (..)
23+ , FrontendWidgetT
24+ , module Obelisk.Frontend.Cookie
1725 ) where
1826
1927import Prelude hiding ((.))
2028
2129import Control.Category
22−import Control.Concurrent
2330import Control.Lens
24−import Control.Monad
2531import Control.Monad.Fix
2632import Control.Monad.IO.Class
2733import Control.Monad.Primitive
34+import Control.Monad.Reader
2835import Control.Monad.Ref
29−import Control.Monad.Trans.Class
36+import Control.Monad.Trans.Maybe (MaybeT(..), runMaybeT)
3037import Data.ByteString (ByteString)
31−import Data.Dependent.Sum (DSum (..))
38+import Data.Foldable (for_)
3239import Data.Functor.Sum
33−import Data.IORef
40+import Data.Map (Map)
41+import Data.Maybe (catMaybes)
3442import Data.Monoid ((<>))
3543import Data.Text (Text)
36−import GHCJS.DOM hiding (bracket, catch)
37−import GHCJS.DOM.Document
38−import GHCJS.DOM.Node
44+import qualified GHCJS.DOM as DOM
3945import qualified GHCJS.DOM.Types as DOM
40−import Language.Javascript.JSaddle (JSM)
46+import qualified GHCJS.DOM.History as DOM
47+import qualified GHCJS.DOM.Window as DOM
48+import Language.Javascript.JSaddle (MonadJSM, JSM, jsNull)
49+import GHCJS.DOM (currentDocument)
50+import "ghcjs-dom" GHCJS.DOM.Document (getHead)
51+import GHCJS.DOM.Node (Node, removeChild_)
52+import GHCJS.DOM.NodeList (IsNodeList, item, getLength)
53+import GHCJS.DOM.ParentNode (querySelectorAll)
54+import Obelisk.Frontend.Cookie
4155import Obelisk.Route.Frontend
4256import Reflex.Dom.Core
4357import Reflex.Host.Class
44−import qualified Reflex.TriggerEvent.Base as TriggerEvent
58+import Obelisk.Configs
59+import Obelisk.ExecutableConfig.Inject (injectExecutableConfigs)
60+import qualified Obelisk.ExecutableConfig.Lookup as Lookup
61+import Web.Cookie
62+
63+import Debug.Trace
4564
4665makePrisms ''Sum
4766
48−type ObeliskWidget t x route m =
67+type ObeliskWidget js t route m =
4968 ( DomBuilder t m
5069 , MonadFix m
5170 , MonadHold t m
@@ -53,8 +72,6 @@ type ObeliskWidget t x route m =
5372 , MonadReflexCreateTrigger t m
5473 , PostBuild t m
5574 , PerformEvent t m
56− , MonadIO m
57− , MonadIO (Performable m)
5875 , TriggerEvent t m
5976 , HasDocument m
6077 , MonadRef m
@@ -63,106 +80,175 @@ type ObeliskWidget t x route m =
6380 , Ref (Performable m) ~ Ref IO
6481 , MonadFix (Performable m)
6582 , PrimMonad m
66− , Prerender x m
67− , SetRoute t route m
83+ , Prerender js t m
84+ , PrebuildAgnostic t route m
85+ , PrebuildAgnostic t route (Client m)
86+ , HasConfigs m
87+ , HasCookies m
88+ , MonadIO (Performable m)
89+ )
90+
91+type PrebuildAgnostic t route m =
92+ ( SetRoute t route m
6893 , RouteToUrl route m
94+ , MonadFix m
95+ , HasConfigs m
96+ , HasConfigs (Performable m)
6997 )
7098
7199data Frontend route = Frontend
72− { _frontend_head :: !(forall t m x. ObeliskWidget t x route m => RoutedT t route m ())
73− , _frontend_body :: !(forall t m x. ObeliskWidget t x route m => RoutedT t route m ())
100+ { _frontend_head :: !(forall js t m. ObeliskWidget js t route m => RoutedT t route m ())
101+ , _frontend_body :: !(forall js t m. ObeliskWidget js t route m => RoutedT t route m ())
74102 }
75103
76−type Widget' x = ImmediateDomBuilderT DomTimeline (DomCoreWidget x)
77−
78−-- | A widget that isn't attached to any particular part of the DOM hierarchy
79−type FloatingWidget x = TriggerEventT DomTimeline (DomCoreWidget x)
80−
81−type DomCoreWidget x = PostBuildT DomTimeline (WithJSContextSingleton x (PerformEventT DomTimeline DomHost))
82−
83−--TODO: Rename
84−{-# INLINABLE attachWidget''' #-}
85−attachWidget'''
86− :: (EventChannel -> PerformEventT DomTimeline DomHost (IORef (Maybe (EventTrigger DomTimeline ()))))
87− -> IO ()
88−attachWidget''' w = runDomHost $ do
89− events <- liftIO newChan
90− (postBuildTriggerRef, fc@(FireCommand fire)) <- hostPerformEventT $ w events
91− mPostBuildTrigger <- readRef postBuildTriggerRef
92− forM_ mPostBuildTrigger $ \postBuildTrigger -> fire [postBuildTrigger :=> Identity ()] $ return ()
93− liftIO $ processAsyncEvents events fc
94−
95−--TODO: This is a collection of random stuff; we should make it make some more sense and then upstream to reflex-dom-core
96−runWithHeadAndBody
97− :: ( (forall c. Widget' () c -> FloatingWidget () c) -- "Append to head"
98− -> (forall c. Widget' () c -> FloatingWidget () c) -- "Append to body"
99− -> FloatingWidget () ()
100− )
104+baseTag :: forall route js t m. ObeliskWidget js t route m => RoutedT t route m ()
105+baseTag = elAttr "base" ("href" =: "/") blank --TODO: Figure out the base URL from the routes
106+
107+removeHTMLConfigs :: JSM ()
108+removeHTMLConfigs = void $ runMaybeT $ do
109+ doc <- MaybeT currentDocument
110+ hd <- MaybeT $ getHead doc
111+ es <- nodeListNodes =<< querySelectorAll hd ("[data-obelisk-executable-config-inject-key]" :: Text)
112+ for_ es $ removeChild_ hd
113+
114+-- | Collect all nodes in the node list.
115+--
116+-- TODO: this and the version in exe-config/ghcjs/lookup should be
117+-- upstreamed to jsaddle.
118+nodeListNodes :: (IsNodeList l, MonadJSM m) => l -> m [Node]
119+nodeListNodes es = do
120+ len <- getLength es
121+ -- Warning! len is unsigned. If the NodeList is empty, we must avoid
122+ -- accidentally traversing over [0..maxBound::Word]
123+ nodes <- traverse (item es) $ if len == 0 then [] else [0..len-1]
124+ pure $ catMaybes nodes
125+
126+setInitialRoute :: Bool -> JSM ()
127+setInitialRoute useHash = do
128+ traceM "setInitialRoute"
129+ window <- DOM.currentWindowUnchecked
130+ initialLocation <- DOM.getLocation window
131+ initialUri <- getLocationUri initialLocation
132+ history <- DOM.getHistory window
133+ DOM.replaceState history jsNull ("" :: Text) $ Just $
134+ show $ setAdaptedUriPath useHash "/" initialUri
135+
136+data FrontendMode = FrontendMode
137+ { _frontendMode_hydrate :: Bool
138+ -- ^ There is already a rendering of the DOM in place; hydrate it rather
139+ -- than building new DOM
140+ , _frontendMode_adjustRoute :: Bool
141+ -- ^ The page can't use regular routes, so encode routes into the hash
142+ -- instead
143+ }
144+
145+-- | Run the frontend, setting the initial route to "/" on platforms where no
146+-- route exists ambiently in the context (e.g. anything but web).
147+-- Selects FrontendMode based on platform; this doesn't work for jsaddle-warp
148+runFrontend
149+ :: forall backendRoute route
150+ . Encoder Identity Identity (R (FullRoute backendRoute route)) PageName
151+ -> Frontend (R route)
101152 -> JSM ()
102−runWithHeadAndBody app = withJSContextSingletonMono $ \jsSing -> do
103− globalDoc <- currentDocumentUnchecked
104− headFragment <- createDocumentFragment globalDoc
105− bodyFragment <- createDocumentFragment globalDoc
106− unreadyChildren <- liftIO $ newIORef 0
107− let commit = do
108− headElement <- getHeadUnchecked globalDoc
109− bodyElement <- getBodyUnchecked globalDoc
110− void $ inAnimationFrame' $ \_ -> do
111− replaceElementContents headElement headFragment
112− replaceElementContents bodyElement bodyFragment
113− liftIO $ attachWidget''' $ \events -> flip runWithJSContextSingleton jsSing $ do
114− (postBuild, postBuildTriggerRef) <- newEventWithTriggerRef
115− let appendImmediateDom :: DOM.DocumentFragment -> Widget' () c -> FloatingWidget () c
116− appendImmediateDom df w = do
117− events' <- TriggerEvent.askEvents
118− lift $ do
119− doc <- getOwnerDocumentUnchecked df
120− let builderEnv = ImmediateDomBuilderEnv
121− { _immediateDomBuilderEnv_document = doc
122− , _immediateDomBuilderEnv_parent = toNode df
123− , _immediateDomBuilderEnv_unreadyChildren = unreadyChildren
124− , _immediateDomBuilderEnv_commitAction = commit
125− }
126− runImmediateDomBuilderT w builderEnv events'
127− flip runPostBuildT postBuild $ flip runTriggerEventT events $ app (appendImmediateDom headFragment) (appendImmediateDom bodyFragment)
128− liftIO (readIORef unreadyChildren) >>= \case
129− 0 -> DOM.liftJSM commit
130− _ -> return ()
131− return postBuildTriggerRef
132−
133−runFrontend :: forall backendRoute route. Encoder Identity Identity (R (Sum backendRoute (ObeliskRoute route))) PageName -> Frontend (R route) -> JSM ()
134153runFrontend validFullEncoder frontend = do
135− let ve = validFullEncoder . hoistParse errorLeft (prismEncoder (rPrism $ _InR . _ObeliskRoute_App))
154+ let mode = FrontendMode
155+ { _frontendMode_hydrate =
156+#ifdef ghcjs_HOST_OS
157+ True
158+#else
159+ False
160+#endif
161+ , _frontendMode_adjustRoute =
162+#ifdef ghcjs_HOST_OS
163+ False
164+#else
165+ True
166+#endif
167+ }
168+ configs <- liftIO Lookup.getConfigs
169+ when (_frontendMode_hydrate mode) removeHTMLConfigs
170+ -- There's no fundamental reason that adjustRoute needs to control setting the
171+ -- initial route and *also* the useHash parameter; that's why these are
172+ -- separate here. However, currently, they are always the same.
173+ when (_frontendMode_adjustRoute mode) $ do
174+ setInitialRoute $ _frontendMode_adjustRoute mode
175+ runFrontendWithConfigsAndCurrentRoute mode configs validFullEncoder frontend
176+
177+runFrontendWithConfigsAndCurrentRoute
178+ :: forall backendRoute frontendRoute
179+ . FrontendMode
180+ -> Map Text ByteString
181+ -> Encoder Identity Identity (R (FullRoute backendRoute frontendRoute)) PageName
182+ -> Frontend (R frontendRoute)
183+ -> JSM ()
184+runFrontendWithConfigsAndCurrentRoute mode configs validFullEncoder frontend = do
185+ let ve = validFullEncoder . hoistParse errorLeft (reviewEncoder (rPrism $ _FullRoute_Frontend . _ObeliskRoute_App))
136186 errorLeft = \case
137187 Left _ -> error "runFrontend: Unexpected non-app ObeliskRoute reached the frontend. This shouldn't happen."
138188 Right x -> Identity x
139− runMyRouteViewT
140− :: ( TriggerEvent t m
141− , PerformEvent t m
142− , MonadHold t m
189+ w :: ( RawDocument (DomBuilderSpace (HydrationDomBuilderT s DomTimeline m)) ~ DOM.Document
190+ , Ref (Performable m) ~ Ref IO
191+ , Ref m ~ Ref IO
192+ , DomBuilder DomTimeline (HydrationDomBuilderT s DomTimeline m)
193+ , MonadHold DomTimeline m
194+ , MonadRef m
195+ , MonadRef (Performable m)
196+ , MonadReflexCreateTrigger DomTimeline m
197+ , PerformEvent DomTimeline m
198+ , PostBuild DomTimeline m
199+ , PrimMonad m
200+ , MonadSample DomTimeline (Performable m)
143201 , DOM.MonadJSM m
144− , DOM.MonadJSM (Performable m)
145− , MonadFix m
202+ , MonadFix (Client (HydrationDomBuilderT s DomTimeline m))
146203 , MonadFix (Performable m)
204+ , MonadFix m
205+ , Prerender js DomTimeline (HydrationDomBuilderT s DomTimeline m)
206+ , MonadIO (Performable m)
147207 )
148− => RoutedT t (R route) (SetRouteT t (R route) (RouteToUrlT (R route) m)) a
149− -> m a
150− runMyRouteViewT = runRouteViewT ve
151− runWithHeadAndBody $ \appendHead appendBody -> runMyRouteViewT $ do
152− mapRoutedT (mapSetRouteT (mapRouteToUrlT appendHead)) $ _frontend_head frontend
153− mapRoutedT (mapSetRouteT (mapRouteToUrlT appendBody)) $ _frontend_body frontend
208+ => (forall c. HydrationDomBuilderT s DomTimeline m c -> FloatingWidget () c)
209+ -> (forall c. HydrationDomBuilderT s DomTimeline m c -> FloatingWidget () c)
210+ -> FloatingWidget () ()
211+ w appendHead appendBody = do
212+ rec switchover <- runRouteViewT ve switchover (_frontendMode_adjustRoute mode) $ do
213+ (switchover'', fire) <- newTriggerEvent
214+ mapRoutedT (mapSetRouteT (mapRouteToUrlT (appendHead . runConfigsT configs))) $ do
215+ -- The order here is important - baseTag has to be before headWidget!
216+ baseTag
217+ _frontend_head frontend
218+ mapRoutedT (mapSetRouteT (mapRouteToUrlT (appendBody . runConfigsT configs))) $ do
219+ _frontend_body frontend
220+ switchover' <- case _frontendMode_hydrate mode of
221+ True -> lift $ lift $ lift $ lift $ HydrationDomBuilderT $ asks _hydrationDomBuilderEnv_switchover
222+ False -> getPostBuild
223+ performEvent_ $ liftIO (fire ()) <$ switchover'
224+ pure switchover''
225+ pure ()
226+ if _frontendMode_hydrate mode
227+ then runHydrationWidgetWithHeadAndBody (pure ()) w
228+ else runImmediateWidgetWithHeadAndBody w
229+
230+type FrontendWidgetT r = RoutedT DomTimeline r (SetRouteT DomTimeline r (RouteToUrlT r (ConfigsT (CookiesT (HydratableT (PostBuildT DomTimeline (StaticDomBuilderT DomTimeline (PerformEventT DomTimeline DomHost))))))))
154231
155232renderFrontendHtml
156− :: (t ~ DomTimeline)
157− => (r' -> Text)
233+ :: MonadIO m
234+ => Map Text ByteString
235+ -> Cookies
236+ -> (r -> Text)
158237 -> r
159− -> RoutedT t r (SetRouteT t r' (RouteToUrlT r' (PostBuildT DomTimeline (StaticDomBuilderT DomTimeline (PerformEventT DomTimeline DomHost))))) ()
160− -> RoutedT t r (SetRouteT t r' (RouteToUrlT r' (PostBuildT DomTimeline (StaticDomBuilderT DomTimeline (PerformEventT DomTimeline DomHost))))) ()
161− -> IO ByteString
162−renderFrontendHtml urlEnc route headWidget bodyWidget = do
238+ -> Frontend r
239+ -> FrontendWidgetT r ()
240+ -> FrontendWidgetT r ()
241+ -> m ByteString
242+renderFrontendHtml configs cookies urlEnc route frontend headExtra bodyExtra = do
163243 --TODO: We should probably have a "NullEventWriterT" or a frozen reflex timeline
164− html <- fmap snd $ renderStatic $ fmap fst $ flip runRouteToUrlT urlEnc $ runSetRouteT $ flip runRoutedT (pure route) $
244+ html <- fmap snd $ liftIO $ renderStatic $ runHydratableT $ fmap fst $ runCookiesT cookies $ runConfigsT configs $ flip runRouteToUrlT urlEnc $ runSetRouteT $ flip runRoutedT (pure route) $
165245 el "html" $ do
166− el "head" headWidget
167− el "body" bodyWidget
246+ el "head" $ do
247+ baseTag
248+ injectExecutableConfigs configs
249+ _frontend_head frontend
250+ headExtra
251+ el "body" $ do
252+ _frontend_body frontend
253+ bodyExtra
168254 return $ "<!DOCTYPE html>" <> html
lib/frontend/src/Obelisk/Frontend/Cookie.hsnew file+103
@@ -0,0 +1,103 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DefaultSignatures #-}
4+{-# LANGUAGE DeriveFunctor #-}
5+{-# LANGUAGE FlexibleContexts #-}
6+{-# LANGUAGE FlexibleInstances #-}
7+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
9+{-# LANGUAGE PackageImports #-}
10+{-# LANGUAGE RankNTypes #-}
11+{-# LANGUAGE TypeFamilies #-}
12+{-# LANGUAGE UndecidableInstances #-}
13+
14+module Obelisk.Frontend.Cookie where
15+
16+import Control.Monad.Fix
17+import Control.Monad.Primitive
18+import Control.Monad.Ref
19+import Control.Monad.IO.Class
20+import Control.Monad.Trans.Class
21+import Control.Monad.Trans.Reader
22+import Data.Text.Encoding (encodeUtf8)
23+import Reflex
24+import Reflex.Host.Class
25+import Reflex.Dom.Core
26+import "ghcjs-dom" GHCJS.DOM.Document (getCookie, Document)
27+import GHCJS.DOM.Types (MonadJSM)
28+import Web.Cookie
29+
30+import Obelisk.Configs
31+import Obelisk.Route.Frontend
32+
33+class Monad m => HasCookies m where
34+ askCookies :: m Cookies
35+ default askCookies :: (HasCookies m', m ~ t m', MonadTrans t) => m Cookies
36+ askCookies = lift askCookies
37+
38+instance HasCookies m => HasCookies (BehaviorWriterT t w m)
39+instance HasCookies m => HasCookies (DynamicWriterT t w m)
40+instance HasCookies m => HasCookies (EventWriterT t w m)
41+instance HasCookies m => HasCookies (PostBuildT t m)
42+instance HasCookies m => HasCookies (QueryT t q m)
43+instance HasCookies m => HasCookies (ReaderT r m)
44+instance HasCookies m => HasCookies (RequesterT t request response m)
45+instance HasCookies m => HasCookies (RouteToUrlT t m)
46+instance HasCookies m => HasCookies (SetRouteT t r m)
47+instance HasCookies m => HasCookies (StaticDomBuilderT t m)
48+instance HasCookies m => HasCookies (TriggerEventT t m)
49+instance HasCookies m => HasCookies (RoutedT t r m)
50+instance HasCookies m => HasCookies (ConfigsT m)
51+instance HasConfigs m => HasConfigs (CookiesT m)
52+
53+newtype CookiesT m a = CookiesT { unCookiesT :: ReaderT Cookies m a }
54+ deriving
55+ ( Functor
56+ , Applicative
57+ , DomBuilder t
58+ , Monad
59+ , MonadFix
60+ , MonadHold t
61+ , MonadIO
62+#ifndef ghcjs_HOST_OS
63+ , MonadJSM
64+#endif
65+ , MonadRef
66+ , MonadReflexCreateTrigger t
67+ , MonadSample t
68+ , MonadTrans
69+ , NotReady t
70+ , PerformEvent t
71+ , PostBuild t
72+ , Prerender js t
73+ , TriggerEvent t
74+ , HasDocument
75+ )
76+
77+instance Adjustable t m => Adjustable t (CookiesT m) where
78+ runWithReplace a e = CookiesT $ runWithReplace (unCookiesT a) (unCookiesT <$> e)
79+ traverseDMapWithKeyWithAdjust f m e = CookiesT $ traverseDMapWithKeyWithAdjust (\k v -> unCookiesT $ f k v) m e
80+ traverseIntMapWithKeyWithAdjust f m e = CookiesT $ traverseIntMapWithKeyWithAdjust (\k v -> unCookiesT $ f k v) m e
81+ traverseDMapWithKeyWithAdjustWithMove f m e = CookiesT $ traverseDMapWithKeyWithAdjustWithMove (\k v -> unCookiesT $ f k v) m e
82+
83+instance PrimMonad m => PrimMonad (CookiesT m) where
84+ type PrimState (CookiesT m) = PrimState m
85+ primitive = lift . primitive
86+
87+runCookiesT
88+ :: Cookies
89+ -> CookiesT m a
90+ -> m a
91+runCookiesT cs child = runReaderT (unCookiesT child) cs
92+
93+instance Monad m => HasCookies (CookiesT m) where
94+ askCookies = CookiesT ask
95+
96+mapCookiesT
97+ :: (forall x. m x -> n x)
98+ -> CookiesT m a
99+ -> CookiesT n a
100+mapCookiesT f (CookiesT x) = CookiesT $ mapReaderT f x
101+
102+instance (MonadJSM m, RawDocument (DomBuilderSpace (HydrationDomBuilderT s t m)) ~ Document) => HasCookies (HydrationDomBuilderT s t m) where
103+ askCookies = fmap (parseCookies . encodeUtf8) $ getCookie =<< askDocument
lib/route/README.mdnew file+6
@@ -0,0 +1,6 @@
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+9−3
@@ -6,31 +6,37 @@ build-type: Simple
66library
77 hs-source-dirs: src
88 build-depends: base,
9+ aeson,
10+ bytestring,
911 categories,
1012 constraints,
13+ constraints-extras,
1114 containers,
1215 dependent-map,
1316 dependent-sum,
14− dependent-sum-universe-orphans,
1517 dependent-sum-template,
1618 either,
1719 ghcjs-dom,
1820 http-types,
1921 jsaddle,
2022 lens,
23+ mmorph,
2124 monad-control,
2225 mtl,
2326 network-uri,
27+ obelisk-executable-config-lookup,
2428 primitive,
2529 ref-tf,
2630 reflex,
2731 reflex-dom-core,
2832 template-haskell,
33+ tabulation,
2934 text,
35+ th-extras,
3036 transformers,
3137 universe,
32− universe-template
38+ universe-dependent-sum
3339 exposed-modules: Obelisk.Route
3440 Obelisk.Route.TH
3541 Obelisk.Route.Frontend
36− ghc-options: -Wall -fwarn-redundant-constraints
42+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
lib/route/src/Obelisk/Route.hs+471−70
@@ -1,3 +1,4 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE ApplicativeDo #-}
23{-# LANGUAGE ConstraintKinds #-}
34{-# LANGUAGE EmptyCase #-}
@@ -5,19 +6,24 @@
56{-# LANGUAGE FlexibleContexts #-}
67{-# LANGUAGE FlexibleInstances #-}
78{-# LANGUAGE GADTs #-}
8−{-# LANGUAGE KindSignatures #-}
99{-# LANGUAGE LambdaCase #-}
1010{-# LANGUAGE MultiParamTypeClasses #-}
1111{-# LANGUAGE OverloadedStrings #-}
1212{-# LANGUAGE PatternSynonyms #-}
1313{-# LANGUAGE RankNTypes #-}
1414{-# LANGUAGE ScopedTypeVariables #-}
15+{-# LANGUAGE StandaloneDeriving #-}
1516{-# LANGUAGE TemplateHaskell #-}
17+{-# LANGUAGE TypeApplications #-}
1618{-# LANGUAGE TypeFamilies #-}
1719{-# LANGUAGE TypeOperators #-}
1820{-# LANGUAGE ViewPatterns #-}
1921module Obelisk.Route
2022 ( R
23+ , (:.)
24+ , (?/)
25+ , hoistR
26+ , pattern (:.)
2127 , pattern (:/)
2228 , PageName
2329 , PathQuery
@@ -40,7 +46,11 @@ module Obelisk.Route
4046 , checkEnum1EncoderFunc
4147 , unitEncoder
4248 , pathOnlyEncoder
49+ , addPathSegmentEncoder
50+ , pathParamEncoder
51+ , pathLiteralEncoder
4352 , singletonListEncoder
53+ , packTextEncoder
4454 , unpackTextEncoder
4555 , prefixTextEncoder
4656 , unsafeTshowEncoder
@@ -51,6 +61,7 @@ module Obelisk.Route
5161 , justEncoder
5262 , nothingEncoder
5363 , isoEncoder
64+ , viewEncoder
5465 , wrappedEncoder
5566 , unwrappedEncoder
5667 , listToNonEmptyEncoder
@@ -59,11 +70,17 @@ module Obelisk.Route
5970 , toListMapEncoder
6071 , shadowEncoder
6172 , prismEncoder
73+ , reviewEncoder
6274 , rPrism
75+ , _R
6376 , obeliskRouteEncoder
6477 , obeliskRouteSegment
6578 , pageNameEncoder
6679 , handleEncoder
80+ , FullRoute (..)
81+ , _FullRoute_Frontend
82+ , _FullRoute_Backend
83+ , mkFullRouteEncoder
6784 , ObeliskRoute (..)
6885 , _ObeliskRoute_App
6986 , _ObeliskRoute_Resource
@@ -78,6 +95,19 @@ module Obelisk.Route
7895 , void1Encoder
7996 , pathSegmentsTextEncoder
8097 , queryParametersTextEncoder
98+ , renderObeliskRoute
99+ , renderBackendRoute
100+ , renderFrontendRoute
101+ , readShowEncoder
102+ , integralEncoder
103+ , pathSegmentEncoder
104+ , queryOnlyEncoder
105+ , Decoder(..)
106+ , dmapEncoder
107+ , fieldMapEncoder
108+ , pathFieldEncoder
109+ , jsonEncoder
110+ , byteStringsToPageName
81111 ) where
82112
83113import Prelude hiding ((.), id)
@@ -88,13 +118,41 @@ import qualified Control.Categorical.Functor as Cat
88118import Control.Categorical.Bifunctor
89119import Control.Category.Associative
90120import Control.Category.Monoidal
91−import Control.Lens (Identity (..), Prism', makePrisms, itraverse, imap, prism, (^.), re, matching, (^?), _Just, _Nothing, Iso', from, view, Wrapped (..))
121+import Control.Category.Braided
122+import Control.Lens
123+ ( Identity (..)
124+ , (^.)
125+ , (^?)
126+ , _Just
127+ , _Nothing
128+ , Cons(..)
129+ , from
130+ , imap
131+ , iso
132+ , Iso'
133+ , itraverse
134+ , makePrisms
135+ , Prism'
136+ , prism'
137+ , re
138+ , review
139+ , view
140+ , Wrapped (..)
141+ )
92142import Control.Monad.Except
93−import Data.Dependent.Sum (DSum (..))
143+import qualified Control.Monad.State.Strict as State
144+import Control.Monad.Trans (lift)
145+import Control.Monad.Writer (execWriter, tell)
146+import Data.Aeson (FromJSON, ToJSON)
147+import qualified Data.Aeson as Aeson
148+import qualified Data.ByteString as BS
149+import qualified Data.ByteString.Lazy as BSL
94150import Data.Dependent.Map (DMap)
95151import qualified Data.Dependent.Map as DMap
152+import Data.Dependent.Sum (DSum (..))
96153import Data.Either.Validation (Validation (..))
97154import Data.Foldable
155+import Data.Functor (($>))
98156import Data.Functor.Sum
99157import Data.GADT.Compare
100158import Data.GADT.Compare.TH
@@ -106,14 +164,17 @@ import Data.Maybe
106164import Data.Monoid ((<>))
107165import Data.Set (Set)
108166import qualified Data.Set as Set
109−import Data.Some (Some)
110−import qualified Data.Some as Some
111−import Data.Some.Universe.Orphans ()
167+import Data.Some (Some(Some))
168+import Data.Tabulation
112169import Data.Text (Text)
113170import qualified Data.Text as T
114−import Data.Text.Encoding
171+import qualified Data.Text.Encoding as T
172+import Data.Text.Lens (IsText, packed, unpacked)
173+import Data.Type.Equality
115174import Data.Universe
175+import Data.Universe.Some
116176import Network.HTTP.Types.URI
177+import qualified Numeric.Lens
117178import Obelisk.Route.TH
118179import Text.Read (readMaybe)
119180
@@ -141,13 +202,76 @@ import Text.Read (readMaybe)
141202
142203type R f = DSum f Identity --TODO: Better name
143204
144−--TODO: COMPLETE pragma
145−infixr 5 :/
205+-- | Convenience builder for an 'R' using 'Identity' for the functor.
146206pattern (:/) :: f a -> a -> R f
147207pattern a :/ b = a :=> Identity b
208+{-# COMPLETE (:/) #-}
209+infixr 5 :/
210+
211+-- | Like '(:/)' but adds a 'Just' wrapper around the right-hand side.
212+(?/) :: f (Maybe a) -> a -> R f
213+r ?/ a = r :/ Just a
214+infixr 5 ?/
148215
149216mapSome :: (forall a. f a -> g a) -> Some f -> Some g
150−mapSome f (Some.This a) = Some.This $ f a
217+mapSome f (Some a) = Some $ f a
218+
219+hoistR :: (forall x. f x -> g x) -> R f -> R g
220+hoistR f (x :=> Identity y) = f x :/ y
221+
222+--------------------------------------------------------------------------------
223+-- Dealing with pairs (i.e. non-dependently-typed subroutes/paths)
224+--------------------------------------------------------------------------------
225+
226+infixr 5 :.
227+type (:.) = (,)
228+
229+#ifdef __GLASGOW_HASKELL__
230+#if __GLASGOW_HASKELL__ >= 810
231+{-# 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
242+pattern (:.) :: a -> b -> a :. b
243+pattern a :. b = (a, b)
244+
245+addPathSegmentEncoder
246+ :: ( Applicative check
247+ , MonadError Text parse
248+ )
249+ => Encoder check parse (Text, PageName) PageName
250+addPathSegmentEncoder = unsafeMkEncoder $ EncoderImpl
251+ { _encoderImpl_encode = \(ph, (pt, q)) -> (ph : pt, q)
252+ , _encoderImpl_decode = \(p, q) -> case p of
253+ [] -> throwError "Expected a path segment"
254+ ph : pt -> pure (ph, (pt, q))
255+ }
256+
257+pathParamEncoder
258+ :: forall check parse item rest.
259+ ( Applicative check
260+ , MonadError Text parse
261+ )
262+ => Encoder check parse item Text
263+ -> Encoder check parse rest PageName
264+ -> Encoder check parse (item :. rest) PageName
265+pathParamEncoder itemUnchecked restUnchecked = addPathSegmentEncoder . bimap itemUnchecked restUnchecked
266+
267+pathLiteralEncoder
268+ :: ( Applicative check
269+ , MonadError Text parse
270+ )
271+ => Text
272+ -> Encoder check parse a PageName
273+ -> Encoder check parse a PageName
274+pathLiteralEncoder t e = addPathSegmentEncoder . bimap (unitEncoder t) e . coidl
151275
152276--------------------------------------------------------------------------------
153277-- Encoder fundamentals
@@ -180,13 +304,13 @@ decode e x = runIdentity (tryDecode e x)
180304-- | Once an 'Encoder' has been checked, so that its check monad has become 'Identity', even if the same is not true of the
181305-- parse monad, we may still attempt to decode with it in its parse monad.
182306tryDecode :: Encoder Identity parse decoded encoded -> encoded -> parse decoded
183−tryDecode (Encoder (Identity impl)) x = _encoderImpl_decode impl x
307+tryDecode (Encoder (Identity impl)) = _encoderImpl_decode impl
184308
185−-- | Similar to 'decode' above, once an encoder has been checked so that its check monad is Identity, it
309+-- | Similar to 'decode', once an encoder has been checked so that its check monad is Identity, it
186310-- can be used to actually encode by using this. Note that while there's no constraint on the parse monad here,
187311-- one should usually be applying decode and encode to the same 'Encoder'
188312encode :: Encoder Identity parse decoded encoded -> decoded -> encoded
189−encode (Encoder (Identity impl)) x = _encoderImpl_encode impl x
313+encode (Encoder (Identity impl)) = _encoderImpl_encode impl
190314
191315-- | This is a primitive used to build encoders which can't fail to check. It should not be used unless one is
192316-- reasonably certain that the law given for 'EncoderImpl' above holds.
@@ -232,6 +356,10 @@ instance Monad parse => Bifunctor (,) (EncoderImpl parse) (EncoderImpl parse) (E
232356 , _encoderImpl_decode = \(a, b) -> liftA2 (,) (_encoderImpl_decode f a) (_encoderImpl_decode g b)
233357 }
234358
359+instance (Monad parse, Applicative check) => Braided (Encoder check parse) (,) where
360+ braid = viewEncoder (iso swap swap)
361+
362+
235363instance (Applicative check, Monad parse) => PFunctor (,) (Encoder check parse) (Encoder check parse) where
236364 first f = bimap f id
237365instance (Applicative check, Monad parse) => QFunctor (,) (Encoder check parse) (Encoder check parse) where
@@ -245,6 +373,34 @@ instance (Traversable f, Monad parse) => Cat.Functor f (EncoderImpl parse) (Enco
245373 , _encoderImpl_decode = traverse $ _encoderImpl_decode ve
246374 }
247375
376+instance Monad parse => PFunctor Either (EncoderImpl parse) (EncoderImpl parse) where
377+ first f = bimap f id
378+instance Monad parse => QFunctor Either (EncoderImpl parse) (EncoderImpl parse) where
379+ second g = bimap id g
380+instance Monad parse => Bifunctor Either (EncoderImpl parse) (EncoderImpl parse) (EncoderImpl parse) where
381+ bimap f g = EncoderImpl
382+ { _encoderImpl_encode = bimap (_encoderImpl_encode f) (_encoderImpl_encode g)
383+ , _encoderImpl_decode = \case
384+ Left a -> Left <$> _encoderImpl_decode f a
385+ Right b -> Right <$> _encoderImpl_decode g b
386+ }
387+
388+instance (Monad parse, Applicative check) => QFunctor Either (Encoder check parse) (Encoder check parse) where
389+ second g = bimap id g
390+instance (Monad parse, Applicative check) => PFunctor Either (Encoder check parse) (Encoder check parse) where
391+ first f = bimap f id
392+instance (Monad parse, Applicative check) => Bifunctor Either (Encoder check parse) (Encoder check parse) (Encoder check parse) where
393+ bimap f g = Encoder $ liftA2 bimap (unEncoder f) (unEncoder g)
394+
395+instance (Applicative check, Monad parse) => Associative (Encoder check parse) Either where
396+ associate = viewEncoder (iso (associate @(->) @Either) disassociate)
397+ disassociate = viewEncoder (iso disassociate associate)
398+
399+instance (Monad parse, Applicative check) => Braided (Encoder check parse) Either where
400+ braid = viewEncoder (iso swap swap)
401+
402+
403+
248404instance (Traversable f, Monad check, Monad parse) => Cat.Functor f (Encoder check parse) (Encoder check parse) where
249405 fmap e = Encoder $ do
250406 ve <- unEncoder e
@@ -295,17 +451,17 @@ instance (Applicative check, Monad parse) => Monoidal (Encoder check parse) (,)
295451--------------------------------------------------------------------------------
296452
297453-- | Given a valid 'Iso' from lens, construct an 'Encoder'
298−isoEncoder :: (Applicative check, Applicative parse) => Iso' a b -> Encoder check parse a b
299−isoEncoder f = unsafeMkEncoder $ EncoderImpl
454+viewEncoder :: (Applicative check, Applicative parse) => Iso' a b -> Encoder check parse a b
455+viewEncoder f = unsafeMkEncoder $ EncoderImpl
300456 { _encoderImpl_encode = view f
301457 , _encoderImpl_decode = pure . view (from f)
302458 }
303459
304460wrappedEncoder :: (Wrapped a, Applicative check, Applicative parse) => Encoder check parse (Unwrapped a) a
305−wrappedEncoder = isoEncoder $ from _Wrapped'
461+wrappedEncoder = viewEncoder $ from _Wrapped'
306462
307463unwrappedEncoder :: (Wrapped a, Applicative check, Applicative parse) => Encoder check parse a (Unwrapped a)
308−unwrappedEncoder = isoEncoder _Wrapped'
464+unwrappedEncoder = viewEncoder $ _Wrapped'
309465
310466maybeToEitherEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Maybe a) (Either () a)
311467maybeToEitherEncoder = unsafeMkEncoder $ EncoderImpl
@@ -330,16 +486,16 @@ maybeEncoder f g = shadowEncoder f g . maybeToEitherEncoder
330486
331487-- | Encode a value by simply applying 'Just'
332488justEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse a (Maybe a)
333−justEncoder = prismEncoder _Just
489+justEncoder = reviewEncoder _Just
334490
335−-- |
491+-- | Encode () to 'Nothing'.
336492nothingEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse () (Maybe a)
337−nothingEncoder = prismEncoder _Nothing
493+nothingEncoder = reviewEncoder _Nothing
338494
339495someConstEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Some (Const a)) a
340496someConstEncoder = unsafeMkEncoder $ EncoderImpl
341− { _encoderImpl_encode = \(Some.This (Const a)) -> a
342− , _encoderImpl_decode = pure . Some.This . Const
497+ { _encoderImpl_encode = \(Some (Const a)) -> a
498+ , _encoderImpl_decode = pure . Some . Const
343499 }
344500
345501-- | WARNING: This is only safe if the Show and Read instances for 'a' are
@@ -367,7 +523,7 @@ checkEnum1EncoderFunc
367523 -> check (EncoderFunc check' parse p r)
368524checkEnum1EncoderFunc f = do
369525 (encoderImpls :: DMap p (Flip (EncoderImpl parse) r)) <- DMap.fromList <$>
370− traverse (\(Some.This p) -> (p :=>) . Flip <$> unEncoder (f p)) universe
526+ traverse (\(Some p) -> (p :=>) . Flip <$> unEncoder (f p)) universe
371527 pure $ EncoderFunc $ \p -> unsafeMkEncoder . unFlip $
372528 DMap.findWithDefault (error "checkEnum1EncoderFunc: EncoderImpl not found (should be impossible)") p encoderImpls
373529
@@ -399,11 +555,11 @@ pathComponentEncoder f = Encoder $ do
399555 unEncoder (pathComponentEncoderImpl (enum1Encoder (extractPathSegment . f)) f')
400556
401557pathComponentEncoderImpl :: forall check parse p. (Monad check, Monad parse)
402− => (Encoder check parse (Some p) (Maybe Text))
558+ => Encoder check parse (Some p) (Maybe Text)
403559 -> (forall a. p a -> Encoder Identity parse a PageName)
404560 -> Encoder check parse (R p) PageName
405−pathComponentEncoderImpl this rest =
406− chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder) this rest
561+pathComponentEncoderImpl =
562+ chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder)
407563
408564--NOTE: Naming convention in this module is to always talk about things in the *encoding* direction, never in the *decoding* direction
409565
@@ -422,11 +578,12 @@ chainEncoder cons this rest = Encoder $ do
422578 pure $ EncoderImpl
423579 { _encoderImpl_decode = \v -> do
424580 (here, following) <- _encoderImpl_decode consValid v
425− Some.This r <- _encoderImpl_decode thisValid here
426− (r :/) <$> _encoderImpl_decode (runIdentity . unEncoder $ rest r) following
581+ _encoderImpl_decode thisValid here >>= \case
582+ Some r ->
583+ (r :/) <$> _encoderImpl_decode (runIdentity . unEncoder $ rest r) following
427584 , _encoderImpl_encode = \(r :/ s) ->
428585 _encoderImpl_encode consValid
429− ( _encoderImpl_encode thisValid $ Some.This r
586+ ( _encoderImpl_encode thisValid $ Some r
430587 , _encoderImpl_encode (runIdentity . unEncoder $ rest r) s)
431588 }
432589
@@ -493,7 +650,7 @@ enum1Encoder
493650 , Show r
494651 )
495652 => (forall a. p a -> r) -> Encoder check parse (Some p) r
496−enum1Encoder f = enumEncoder $ \(Some.This p) -> f p
653+enum1Encoder f = enumEncoder $ \(Some p) -> f p
497654
498655-- | Encode an enumerable, bounded type. WARNING: Don't use this on types that
499656-- have a large number of values - it will use a lot of memory.
@@ -536,13 +693,10 @@ pathOnlyEncoderIgnoringQuery = unsafeMkEncoder $ EncoderImpl
536693 }
537694
538695pathOnlyEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse [Text] PageName
539−pathOnlyEncoder = unsafeMkEncoder $ EncoderImpl
540− { _encoderImpl_decode = \(path, query) ->
541− if query == mempty
542− then pure path
543− else throwError "pathOnlyEncoderImpl: query was provided"
544− , _encoderImpl_encode = \path -> (path, mempty)
545− }
696+pathOnlyEncoder = second (unitEncoder mempty) . coidr
697+
698+queryOnlyEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse (Map Text (Maybe Text)) PageName
699+queryOnlyEncoder = first (unitEncoder []) . coidl
546700
547701singletonListEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse a [a]
548702singletonListEncoder = unsafeMkEncoder $ EncoderImpl
@@ -585,10 +739,10 @@ queryParametersTextEncoder = Encoder $ pure $ EncoderImpl
585739 in (urlDecodeText True k, urlDecodeText True <$> mv)
586740
587741urlEncodeText :: Bool -> Text -> Text
588−urlEncodeText q = decodeUtf8 . urlEncode q . encodeUtf8
742+urlEncodeText q = T.decodeUtf8 . urlEncode q . T.encodeUtf8
589743
590744urlDecodeText :: Bool -> Text -> Text
591−urlDecodeText q = decodeUtf8 . urlDecode q . encodeUtf8
745+urlDecodeText q = T.decodeUtf8 . urlDecode q . T.encodeUtf8
592746
593747listToNonEmptyEncoder :: (Applicative check, Applicative parse, Monoid a, Eq a) => Encoder check parse [a] (NonEmpty a)
594748listToNonEmptyEncoder = Encoder $ pure $ EncoderImpl
@@ -621,11 +775,11 @@ prefixNonemptyTextEncoder p = Encoder $ pure $ EncoderImpl
621775 Just stripped -> pure stripped
622776 }
623777
624−unpackTextEncoder :: (Applicative check, Applicative parse) => Encoder check parse Text String
625−unpackTextEncoder = Encoder $ pure $ EncoderImpl
626− { _encoderImpl_encode = T.unpack
627− , _encoderImpl_decode = pure . T.pack
628− }
778+packTextEncoder :: (Applicative check, Applicative parse, IsText text) => Encoder check parse String text
779+packTextEncoder = isoEncoder packed
780+
781+unpackTextEncoder :: (Applicative check, Applicative parse, IsText text) => Encoder check parse text String
782+unpackTextEncoder = isoEncoder unpacked
629783
630784toListMapEncoder :: (Applicative check, Applicative parse, Ord k) => Encoder check parse (Map k v) [(k, v)]
631785toListMapEncoder = Encoder $ pure $ EncoderImpl
@@ -646,19 +800,63 @@ joinPairTextEncoder = Encoder . \case
646800 _ -> return (kt, T.drop (T.length separator) vt)
647801 }
648802
649−--TODO: Rewrite this by composing the given prism with a lens on the first element of the DSum
650−-- Or, more likely, the user can compose it themselves
651−rPrism :: forall f g. (forall a. Prism' (f a) (g a)) -> Prism' (R f) (R g)
652−rPrism p = prism (\(g :/ x) -> g ^. re p :/ x) (\(f :/ x) -> bimap (:/ x) (:/ x) $ matching p f)
803+-- This slight generalization of 'rPrism' happens to be enough to write all our
804+-- prism combinators so far.
805+dSumPrism
806+ :: forall f f' g
807+ . (forall a. Prism' (f a) (f' a))
808+ -> Prism' (DSum f g) (DSum f' g)
809+dSumPrism p = prism'
810+ (\(f' :=> x) -> f' ^. re p :=> x)
811+ (\(f :=> x) -> (:=> x) <$> (f ^? p))
812+
813+-- already in obelisk
814+rPrism
815+ :: forall f f'
816+ . (forall a. Prism' (f a) (f' a))
817+ -> Prism' (R f) (R f')
818+rPrism = dSumPrism
819+
820+dSumPrism'
821+ :: forall f g a
822+ . (forall b. Prism' (f b) (a :~: b))
823+ -> Prism' (DSum f g) (g a)
824+dSumPrism' p = dSumPrism p . iso (\(Refl :=> b) -> b) (Refl :=>)
825+
826+dSumGEqPrism
827+ :: GEq f
828+ => f a
829+ -> Prism' (DSum f g) (g a)
830+dSumGEqPrism variant = dSumPrism' $ prism' (\Refl -> variant) (geq variant)
831+
832+-- | 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'
834+-- generalized a usual sum type.
835+--
836+-- [This is given the '_R' name of the "cannonical" prism not because it is the
837+-- most general, but because it seems the most useful for routes, and 'R' itself
838+-- trades generality for route-specificity.]
839+_R
840+ :: GEq f
841+ => f a
842+ -> Prism' (R f) a
843+_R variant = dSumGEqPrism variant . iso runIdentity Identity
653844
654845-- | An encoder that only works on the items available via the prism. An error will be thrown in the parse monad
655846-- if the prism doesn't match.
656−prismEncoder :: (Applicative check, MonadError Text parse) => Prism' b a -> Encoder check parse a b
657−prismEncoder p = unsafeMkEncoder $ EncoderImpl
658− { _encoderImpl_encode = (^. re p)
847+--
848+-- Note that a 'Prism' from @a@ to @b@ will produce an 'Encoder' from @b@ to @a@
849+-- (i.e. 'reviewEncoder' is a contravariant functor from the category of prisms to the category of encoders),
850+-- just like 'review' produces a function @b -> a@. This is because 'Prism's extract values, in a way that might
851+-- fail, in their forward direction and inject values, in a way that cannot fail, in their reverse direction;
852+-- whereas 'Encoder's encode, which cannot fail, in their forward direction, and decode, which can fail, in their
853+-- reverse direction. In short @reviewEncoder (f . g) = reviewEncoder g . reviewEncoder f@.
854+reviewEncoder :: (Applicative check, MonadError Text parse) => Prism' b a -> Encoder check parse a b
855+reviewEncoder p = unsafeMkEncoder $ EncoderImpl
856+ { _encoderImpl_encode = review p
659857 , _encoderImpl_decode = \r -> case r ^? p of
660858 Just a -> pure a
661− Nothing -> throwError "prismEncoder: value is not present in the prism"
859+ Nothing -> throwError "reviewEncoder: value is not present in the prism"
662860 }
663861
664862-- | A URL path and query string, in which trailing slashes don't matter in the path
@@ -693,6 +891,45 @@ handleEncoder recover e = Encoder $ do
693891-- Actual obelisk route info
694892--------------------------------------------------------------------------------
695893
894+-- | The typical full route type comprising all of an Obelisk application's routes.
895+-- Parameterised by the top level GADTs that define backend and frontend routes, respectively.
896+data FullRoute :: (* -> *) -> (* -> *) -> * -> * where
897+ FullRoute_Backend :: br a -> FullRoute br fr a
898+ FullRoute_Frontend :: ObeliskRoute fr a -> FullRoute br fr a
899+
900+instance (GShow br, GShow fr) => GShow (FullRoute br fr) where
901+ gshowsPrec p = \case
902+ FullRoute_Backend x -> showParen (p > 10) (showString "FullRoute_Backend " . gshowsPrec 11 x)
903+ FullRoute_Frontend x -> showParen (p > 10) (showString "FullRoute_Frontend " . gshowsPrec 11 x)
904+
905+instance (GEq br, GEq fr) => GEq (FullRoute br fr) where
906+ geq (FullRoute_Backend x) (FullRoute_Backend y) = geq x y
907+ geq (FullRoute_Frontend x) (FullRoute_Frontend y) = geq x y
908+ geq _ _ = Nothing
909+
910+instance (GCompare br, GCompare fr) => GCompare (FullRoute br fr) where
911+ gcompare (FullRoute_Backend _) (FullRoute_Frontend _) = GLT
912+ gcompare (FullRoute_Frontend _) (FullRoute_Backend _) = GGT
913+ gcompare (FullRoute_Backend x) (FullRoute_Backend y) = gcompare x y
914+ gcompare (FullRoute_Frontend x) (FullRoute_Frontend y) = gcompare x y
915+
916+instance (UniverseSome br, UniverseSome fr) => UniverseSome (FullRoute br fr) where
917+ universeSome = [Some (FullRoute_Backend x) | Some x <- universeSome]
918+ ++ [Some (FullRoute_Frontend x) | Some x <- universeSome]
919+
920+-- | Build the typical top level application route encoder from a route for handling 404's,
921+-- and segment encoders for backend and frontend routes.
922+mkFullRouteEncoder
923+ :: (GCompare br, GCompare fr, GShow br, GShow fr, UniverseSome br, UniverseSome fr)
924+ => R (FullRoute br fr) -- ^ 404 handler
925+ -> (forall a. br a -> SegmentResult (Either Text) (Either Text) a) -- ^ How to encode a single backend route segment
926+ -> (forall a. fr a -> SegmentResult (Either Text) (Either Text) a) -- ^ How to encode a single frontend route segment
927+ -> Encoder (Either Text) Identity (R (FullRoute br fr)) PageName
928+mkFullRouteEncoder missing backendSegment frontendSegment = handleEncoder (const missing) $
929+ pathComponentEncoder $ \case
930+ FullRoute_Backend backendRoute -> backendSegment backendRoute
931+ FullRoute_Frontend obeliskRoute -> obeliskRouteSegment obeliskRoute frontendSegment
932+
696933-- | A type which can represent Obelisk-specific resource routes, in addition to application specific routes which serve your
697934-- frontend.
698935data ObeliskRoute :: (* -> *) -> * -> * where
@@ -700,9 +937,11 @@ data ObeliskRoute :: (* -> *) -> * -> * where
700937 ObeliskRoute_App :: f a -> ObeliskRoute f a
701938 ObeliskRoute_Resource :: ResourceRoute a -> ObeliskRoute f a
702939
703−instance Universe (Some f) => Universe (Some (ObeliskRoute f)) where
704− universe = fmap (\(Some.This x) -> Some.This (ObeliskRoute_App x)) universe
705− ++ fmap (\(Some.This x) -> Some.This (ObeliskRoute_Resource x)) universe
940+instance UniverseSome f => UniverseSome (ObeliskRoute f) where
941+ universeSome = concat
942+ [ (\(Some x) -> Some (ObeliskRoute_App x)) <$> universe
943+ , (\(Some x) -> Some (ObeliskRoute_Resource x)) <$> universe
944+ ]
706945
707946instance GEq f => GEq (ObeliskRoute f) where
708947 geq (ObeliskRoute_App x) (ObeliskRoute_App y) = geq x y
@@ -755,9 +994,9 @@ obeliskRouteSegment r appRouteSegment = case r of
755994-- be combined with other such segment encoders before 'pathComponentEncoder' turns it into a proper 'Encoder'.
756995resourceRouteSegment :: (MonadError Text check, MonadError Text parse) => ResourceRoute a -> SegmentResult check parse a
757996resourceRouteSegment = \case
758− ResourceRoute_Static -> PathSegment "static" $ pathOnlyEncoderIgnoringQuery
759− ResourceRoute_Ghcjs -> PathSegment "ghcjs" $ pathOnlyEncoder
760− ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" $ jsaddleWarpRouteEncoder
997+ ResourceRoute_Static -> PathSegment "static" pathOnlyEncoderIgnoringQuery
998+ ResourceRoute_Ghcjs -> PathSegment "ghcjs" pathOnlyEncoder
999+ ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" jsaddleWarpRouteEncoder
7611000 ResourceRoute_Version -> PathSegment "version" $ unitEncoder mempty
7621001
7631002data JSaddleWarpRoute :: * -> * where
@@ -769,7 +1008,7 @@ jsaddleWarpRouteEncoder :: (MonadError Text check, MonadError Text parse) => Enc
7691008jsaddleWarpRouteEncoder = pathComponentEncoder $ \case
7701009 JSaddleWarpRoute_JavaScript -> PathSegment "jsaddle.js" $ unitEncoder mempty
7711010 JSaddleWarpRoute_WebSocket -> PathEnd $ unitEncoder mempty
772− JSaddleWarpRoute_Sync -> PathSegment "sync" $ pathOnlyEncoder
1011+ JSaddleWarpRoute_Sync -> PathSegment "sync" pathOnlyEncoder
7731012
7741013instance GShow appRoute => GShow (ObeliskRoute appRoute) where
7751014 gshowsPrec prec = \case
@@ -790,29 +1029,193 @@ indexOnlyRouteEncoder = pathComponentEncoder indexOnlyRouteSegment
7901029
7911030someSumEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Some (Sum a b)) (Either (Some a) (Some b))
7921031someSumEncoder = Encoder $ pure $ EncoderImpl
793− { _encoderImpl_encode = \(Some.This t) -> case t of
794− InL l -> Left $ Some.This l
795− InR r -> Right $ Some.This r
1032+ { _encoderImpl_encode = \(Some t) -> case t of
1033+ InL l -> Left $ Some l
1034+ InR r -> Right $ Some r
7961035 , _encoderImpl_decode = pure . \case
797− Left (Some.This l) -> Some.This (InL l)
798− Right (Some.This r) -> Some.This (InR r)
1036+ Left (Some l) -> Some (InL l)
1037+ Right (Some r) -> Some (InR r)
7991038 }
8001039
8011040data Void1 :: * -> * where {}
8021041
803−instance Universe (Some Void1) where
804− universe = []
1042+instance UniverseSome Void1 where
1043+ universeSome = []
8051044
8061045void1Encoder :: (Applicative check, MonadError Text parse) => Encoder check parse (Some Void1) a
8071046void1Encoder = Encoder $ pure $ EncoderImpl
8081047 { _encoderImpl_encode = \case
809− Some.This f -> case f of {}
1048+ Some f -> case f of {}
8101049 , _encoderImpl_decode = \_ -> throwError "void1Encoder: can't decode anything"
8111050 }
8121051
8131052instance GShow Void1 where
8141053 gshowsPrec _ = \case {}
8151054
1055+-- | Given a backend route and a checked route encoder, render the route (path
1056+-- and query string). See 'checkEncoder' for how to produce a checked encoder.
1057+renderBackendRoute
1058+ :: forall br a.
1059+ Encoder Identity Identity (R (FullRoute br a)) PageName
1060+ -> R br
1061+ -> Text
1062+renderBackendRoute enc = renderObeliskRoute enc . hoistR FullRoute_Backend
1063+
1064+-- | Renders a frontend route with the supplied checked encoder
1065+renderFrontendRoute
1066+ :: forall a fr.
1067+ Encoder Identity Identity (R (FullRoute a fr)) PageName
1068+ -> R fr
1069+ -> Text
1070+renderFrontendRoute enc = renderObeliskRoute enc . hoistR (FullRoute_Frontend . ObeliskRoute_App)
1071+
1072+-- | Renders a route of the form typically found in an Obelisk project
1073+renderObeliskRoute
1074+ :: forall a b.
1075+ Encoder Identity Identity (R (FullRoute a b)) PageName
1076+ -> R (FullRoute a b)
1077+ -> Text
1078+renderObeliskRoute e r =
1079+ let enc :: Encoder Identity (Either Text) (R (FullRoute a b)) PathQuery
1080+ enc = (pageNameEncoder . hoistParse (pure . runIdentity) e)
1081+ in (T.pack . uncurry (<>)) $ encode enc r
1082+
1083+readShowEncoder :: (MonadError Text parse, Read a, Show a, Applicative check) => Encoder check parse a PageName
1084+readShowEncoder = singlePathSegmentEncoder . unsafeTshowEncoder
1085+
1086+integralEncoder :: (MonadError Text parse, Applicative check, Integral a) => Encoder check parse a Integer
1087+integralEncoder = reviewEncoder Numeric.Lens.integral
1088+
1089+pathSegmentEncoder :: (MonadError Text parse, Applicative check, Cons as as a a) =>
1090+ Encoder check parse (a, (as, b)) (as, b)
1091+pathSegmentEncoder = first (reviewEncoder _Cons) . disassociate
1092+
1093+newtype Decoder check parse b a = Decoder { toEncoder :: Encoder check parse a b }
1094+
1095+dmapEncoder :: forall check parse k k' v.
1096+ ( Monad check
1097+ , MonadError Text parse
1098+ , Universe (Some k')
1099+ , Ord k
1100+ , GCompare k'
1101+ , GShow k'
1102+ )
1103+ => Encoder check parse (Some k') k
1104+ -> (forall v'. k' v' -> Encoder check parse v' v)
1105+ -> Encoder check parse (DMap k' Identity) (Map k v)
1106+dmapEncoder keyEncoder' valueEncoderFor = unsafeEncoder $ do
1107+ keyEncoder :: Encoder Identity parse (Some k') k <- checkEncoder keyEncoder'
1108+ valueDecoders :: DMap k' (Decoder Identity parse v) <- fmap DMap.fromList . forM universe $ \(Some (k' :: k' t)) -> do
1109+ ve :: Encoder Identity parse t v <- checkEncoder (valueEncoderFor k')
1110+ return $ (k' :: k' t) :=> (Decoder ve :: Decoder Identity parse v t)
1111+ let keyError k = "dmapEncoder: key `" <> k <> "' was missing from the Universe instance for its type."
1112+ return $ EncoderImpl
1113+ { _encoderImpl_encode = \dm -> Map.fromList $ do
1114+ ((k' :: k' t) :=> Identity v') <- DMap.toList dm
1115+ return ( encode keyEncoder (Some k')
1116+ , encode (toEncoder (DMap.findWithDefault (error . keyError $ gshow k') k' valueDecoders)) v'
1117+ )
1118+ , _encoderImpl_decode = \m -> fmap DMap.fromList . forM (Map.toList m) $ \(k,v) -> do
1119+ tryDecode keyEncoder k >>= \case
1120+ Some (k' :: k' t) -> case DMap.lookup k' valueDecoders of
1121+ Nothing -> throwError . T.pack . keyError $ gshow k'
1122+ Just (Decoder e) -> do
1123+ v' <- tryDecode e v
1124+ return (k' :=> Identity v')
1125+ }
1126+
1127+fieldMapEncoder :: forall check parse r.
1128+ ( Applicative check
1129+ , MonadError Text parse
1130+ , HasFields r
1131+ , Universe (Some (Field r))
1132+ , GShow (Field r)
1133+ , GCompare (Field r)
1134+ )
1135+ => Encoder check parse r (DMap (Field r) Identity)
1136+fieldMapEncoder = unsafeEncoder $ do
1137+ pure $ EncoderImpl
1138+ { _encoderImpl_encode = \r -> DMap.fromList [ f :=> Identity (indexField r f) | Some f <- universe ]
1139+ , _encoderImpl_decode = \dm -> tabulateFieldsA $ \f -> do
1140+ case DMap.lookup f dm of
1141+ Nothing -> throwError $ "fieldMapEncoder: Couldn't find key for `" <> T.pack (gshow f) <> "' in DMap."
1142+ Just (Identity v) -> return v
1143+ }
1144+
1145+-- this is in base 4.12 (GHC 8.6);
1146+newtype Ap f a = Ap {getAp :: f a}
1147+
1148+instance (Applicative f, Semigroup a) => Semigroup (Ap f a) where
1149+ Ap x <> Ap y = Ap (liftA2 (<>) x y)
1150+
1151+instance (Applicative f, Monoid a) => Monoid (Ap f a) where
1152+ mappend = (<>)
1153+ mempty = Ap (pure mempty)
1154+
1155+pathFieldEncoder :: forall a p check parse . (HasFields a, Monad check, MonadError Text parse, GCompare (Field a)) => (forall x. Field a x -> Encoder check parse x p) -> Encoder check parse (a, [p]) [p]
1156+pathFieldEncoder fieldEncoder = unsafeEncoder $ do
1157+ fieldEncoderPureMap :: DMap.DMap (Field a) (Decoder Identity parse p) <- getAp $ getConst $ tabulateFieldsA @a $ \f -> Const (Ap $ fmap (DMap.singleton f . Decoder) $ (checkEncoder @Identity) $ fieldEncoder f)
1158+ let fieldEncoderPure :: forall x. Field a x -> Encoder Identity parse x p
1159+ fieldEncoderPure f = toEncoder (DMap.findWithDefault (error "bad") f fieldEncoderPureMap)
1160+ pure $ EncoderImpl
1161+ { _encoderImpl_encode = \(x, rest) -> execWriter $ do
1162+ _ <- traverseWithField (\f x_i -> tell (pure $ encode (fieldEncoderPure f) x_i) $> x_i) x
1163+ tell rest
1164+ , _encoderImpl_decode = State.runStateT $ tabulateFieldsA $ \f -> State.get >>= \case
1165+ [] -> throwError $ T.pack "not enough path components"
1166+ p:ps -> do
1167+ State.put ps
1168+ lift $ tryDecode (fieldEncoderPure f) p
1169+ }
1170+
1171+-- | Use ToJSON/FromJSON to encode to Text. The correctness of this encoder is dependent on the encoding being injective and round-tripping correctly.
1172+jsonEncoder :: forall check parse r.
1173+ ( ToJSON r
1174+ , FromJSON r
1175+ , Applicative check
1176+ , MonadError Text parse
1177+ )
1178+ => Encoder check parse r Text
1179+jsonEncoder = unsafeEncoder $ do
1180+ pure $ EncoderImpl
1181+ { _encoderImpl_encode = \r -> T.decodeUtf8 . BSL.toStrict $ Aeson.encode r
1182+ , _encoderImpl_decode = \t -> case Aeson.eitherDecodeStrict $ T.encodeUtf8 t of
1183+ Left err -> throwError ("jsonEncoder: " <> T.pack err)
1184+ Right x -> return x
1185+ }
1186+
1187+-- Useful for app server integration.
1188+-- p must not start with slashes
1189+byteStringsToPageName :: BS.ByteString -> BS.ByteString -> PageName
1190+byteStringsToPageName p q =
1191+ let pageNameEncoder' :: Encoder Identity Identity PageName (String, String)
1192+ pageNameEncoder' = bimap
1193+ (unpackTextEncoder . pathSegmentsTextEncoder . listToNonEmptyEncoder)
1194+ (unpackTextEncoder . queryParametersTextEncoder . toListMapEncoder)
1195+ in decode pageNameEncoder' (T.unpack (T.decodeUtf8 p), T.unpack (T.decodeUtf8 q))
1196+
1197+--TODO: decodeURIComponent as appropriate
1198+
1199+
1200+{-# DEPRECATED isoEncoder "Instead of 'isoEncoder f', use 'viewEncoder f'" #-}
1201+-- | Given a valid 'Iso' from lens, construct an 'Encoder'
1202+isoEncoder :: (Applicative check, Applicative parse) => Iso' a b -> Encoder check parse a b
1203+isoEncoder = viewEncoder
1204+
1205+{-# DEPRECATED prismEncoder "Instead of 'prismEncoder f', use 'reviewEncoder f'" #-}
1206+-- | An encoder that only works on the items available via the prism. An error will be thrown in the parse monad
1207+-- if the prism doesn't match.
1208+--
1209+-- Note that a 'Prism' from @a@ to @b@ will produce an 'Encoder' from @b@ to @a@
1210+-- (i.e. 'prismEncoder' is a contravariant functor from the category of prisms to the category of encoders),
1211+-- just like 'review' produces a function @b -> a@. This is because 'Prism's extract values, in a way that might
1212+-- fail, in their forward direction and inject values, in a way that cannot fail, in their reverse direction;
1213+-- whereas 'Encoder's encode, which cannot fail, in their forward direction, and decode, which can fail, in their
1214+-- reverse direction. In short @prismEncoder (f . g) = prismEncoder g . prismEncoder f@.
1215+prismEncoder :: (Applicative check, MonadError Text parse) => Prism' b a -> Encoder check parse a b
1216+prismEncoder = reviewEncoder
1217+
1218+
8161219concat <$> mapM deriveRouteComponent
8171220 [ ''ResourceRoute
8181221 , ''JSaddleWarpRoute
@@ -820,8 +1223,6 @@ concat <$> mapM deriveRouteComponent
8201223 ]
8211224
8221225makePrisms ''ObeliskRoute
823−
1226+makePrisms ''FullRoute
8241227deriveGEq ''Void1
8251228deriveGCompare ''Void1
826−
827−--TODO: decodeURIComponent as appropriate
lib/route/src/Obelisk/Route/Frontend.hs+267−72
@@ -1,26 +1,24 @@
1−{-# LANGUAGE ApplicativeDo #-}
21{-# LANGUAGE CPP #-}
3−{-# LANGUAGE RecursiveDo #-}
4−{-# LANGUAGE StandaloneDeriving #-}
2+{-# LANGUAGE ApplicativeDo #-}
53{-# LANGUAGE ConstraintKinds #-}
4+{-# LANGUAGE DataKinds #-}
5+{-# LANGUAGE DefaultSignatures #-}
66{-# LANGUAGE FlexibleContexts #-}
77{-# LANGUAGE FlexibleInstances #-}
8+{-# LANGUAGE FunctionalDependencies #-}
89{-# LANGUAGE GADTs #-}
9−{-# LANGUAGE KindSignatures #-}
10+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1011{-# LANGUAGE LambdaCase #-}
11−{-# LANGUAGE MultiParamTypeClasses #-}
1212{-# LANGUAGE OverloadedStrings #-}
1313{-# LANGUAGE PatternSynonyms #-}
1414{-# LANGUAGE RankNTypes #-}
15+{-# LANGUAGE RecursiveDo #-}
1516{-# LANGUAGE ScopedTypeVariables #-}
16−{-# LANGUAGE TemplateHaskell #-}
17+{-# LANGUAGE StandaloneDeriving #-}
1718{-# LANGUAGE TypeFamilies #-}
1819{-# LANGUAGE TypeOperators #-}
19−{-# LANGUAGE ViewPatterns #-}
20−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
2120{-# LANGUAGE UndecidableInstances #-}
22−{-# LANGUAGE DataKinds #-}
23−{-# LANGUAGE FunctionalDependencies #-}
21+{-# LANGUAGE ViewPatterns #-}
2422
2523module Obelisk.Route.Frontend
2624 ( module Obelisk.Route
@@ -33,9 +31,14 @@ module Obelisk.Route.Frontend
3331 , mapRoutedT
3432 , subRoute
3533 , subRoute_
34+ , subPairRoute
35+ , subPairRoute_
3636 , maybeRoute
3737 , maybeRoute_
3838 , maybeRouted
39+ , eitherRoute
40+ , eitherRoute_
41+ , eitherRouted
3942 , runRouteViewT
4043 , SetRouteT(..)
4144 , SetRoute(..)
@@ -46,70 +49,97 @@ module Obelisk.Route.Frontend
4649 , runRouteToUrlT
4750 , mapRouteToUrlT
4851 , routeLink
52+ , routeLinkDynAttr
53+ , dynRouteLink
54+ , adaptedUriPath
55+ , setAdaptedUriPath
4956 ) where
5057
5158import Prelude hiding ((.), id)
5259
53−import Obelisk.Route
54−
5560import Control.Category (Category (..), (.))
56−import Control.Category.Cartesian
61+import Control.Category.Cartesian ((&&&))
5762import Control.Lens hiding (Bifunctor, bimap, universe, element)
63+import Control.Monad ((<=<))
5864import Control.Monad.Fix
65+import Control.Monad.Morph
5966import Control.Monad.Primitive
67+import Control.Monad.Reader
6068import Control.Monad.Ref
61−import Control.Monad.Trans
6269import Control.Monad.Trans.Control
63−import Control.Monad.Trans.Reader
6470import Data.Coerce
65−import Data.Constraint (Dict (..))
6671import Data.Dependent.Sum (DSum (..))
72+import Data.Functor.Compose
73+import Data.Functor.Misc
6774import Data.GADT.Compare
75+import qualified Data.List as L
76+import Data.Map (Map)
77+import Data.Maybe (fromMaybe)
6878import Data.Monoid
6979import Data.Proxy
7080import Data.Text (Text)
7181import qualified Data.Text as T
72−import Data.Functor.Compose
73−import Reflex.Class
74−import Reflex.Host.Class
75−import Reflex.PostBuild.Class
76−import Reflex.TriggerEvent.Class
77−import Reflex.PerformEvent.Class
78−import Reflex.EventWriter.Class
79−import Reflex.EventWriter.Base
80−import Reflex.Dynamic
81−import Reflex.Dom.Builder.Class
8282import Data.Type.Coercion
83−import Language.Javascript.JSaddle --TODO: Get rid of this - other platforms can also be routed
84−import Reflex.Dom.Core
83+import qualified GHCJS.DOM as DOM
8584import qualified GHCJS.DOM.Types as DOM
85+import 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
8687import Network.URI
87−#if defined(ios_HOST_OS)
88−import Data.Maybe (fromMaybe)
89−import qualified Data.List as L
90−#endif
91−
88+import Reflex.Class
89+import Reflex.Dom.Builder.Class
90+import Reflex.Dom.Core
91+import Reflex.Host.Class
9292import Unsafe.Coerce
9393
94+import Obelisk.Configs
95+import Obelisk.Route
96+
9497infixr 5 :~
9598pattern (:~) :: Reflex t => f a -> Dynamic t a -> DSum f (Compose (Dynamic t) Identity)
9699pattern a :~ b <- a :=> (coerceDynamic . getCompose -> b)
97100
98101class Routed t r m | m -> t r where
99102 askRoute :: m (Dynamic t r)
103+ default askRoute :: (Monad m', MonadTrans f, Routed t r m', m ~ f m') => m (Dynamic t r)
104+ askRoute = lift askRoute
100105
101106instance Monad m => Routed t r (RoutedT t r m) where
102107 askRoute = RoutedT ask
103108
109+instance (Monad m, Routed t r m) => Routed t r (ReaderT r' m)
110+
104111newtype RoutedT t r m a = RoutedT { unRoutedT :: ReaderT (Dynamic t r) m a }
105− deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument)
112+ deriving
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+
130+instance MonadReader r' m => MonadReader r' (RoutedT t r m) where
131+ ask = lift ask
132+ local = mapRoutedT . local
106133
107134instance HasJSContext m => HasJSContext (RoutedT t r m) where
108135 type JSContextPhantom (RoutedT t r m) = JSContextPhantom m
109136 askJSContext = lift askJSContext
110137
111−instance Prerender js m => Prerender js (RoutedT t r m) where
112− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
138+instance (Prerender js t m, Monad m) => Prerender js t (RoutedT t r m) where
139+ type Client (RoutedT t r m) = RoutedT t r (Client m)
140+ prerender server client = RoutedT $ do
141+ r <- ask
142+ lift $ prerender (runRoutedT server r) (runRoutedT client r)
113143
114144instance Requester t m => Requester t (RoutedT t r m) where
115145 type Request (RoutedT t r m) = Request m
@@ -161,10 +191,24 @@ instance (Monad m, MonadQuery t vs m) => MonadQuery t vs (RoutedT t r m) where
161191 askQueryResult = lift askQueryResult
162192 queryIncremental = lift . queryIncremental
163193
194+instance HasConfigs m => HasConfigs (RoutedT t r m)
195+
196+instance (Monad m, RouteToUrl r m) => RouteToUrl r (QueryT t q m)
197+
198+instance (Monad m, SetRoute t r m) => SetRoute t r (QueryT t q m)
199+
200+instance (Monad m, RouteToUrl r m) => RouteToUrl r (EventWriterT t w m)
201+
202+instance (Monad m, SetRoute t r m) => SetRoute t r (EventWriterT t w m)
203+
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+
164208runRoutedT :: RoutedT t r m a -> Dynamic t r -> m a
165209runRoutedT = runReaderT . unRoutedT
166210
167−mapRoutedT :: (m a -> n a) -> RoutedT t r m a -> RoutedT t r n a
211+mapRoutedT :: (m a -> n b) -> RoutedT t r m a -> RoutedT t r n b
168212mapRoutedT f = RoutedT . mapReaderT f . unRoutedT
169213
170214withRoutedT :: (Dynamic t r -> Dynamic t r') -> RoutedT t r' m a -> RoutedT t r m a
@@ -174,10 +218,18 @@ subRoute_ :: (MonadFix m, MonadHold t m, GEq r, Adjustable t m) => (forall a. r
174218subRoute_ f = factorRouted $ strictDynWidget_ $ \(c :=> r') -> do
175219 runRoutedT (f c) r'
176220
221+-- | Like 'subRoute_', but with a pair rather than an R
222+subPairRoute_ :: (MonadFix m, MonadHold t m, Eq a, Adjustable t m) => (a -> RoutedT t b m ()) -> RoutedT t (a, b) m ()
223+subPairRoute_ f = withRoutedT (fmap (\(a, b) -> Const2 a :/ b)) $ subRoute_ (\(Const2 a) -> f a)
224+
177225subRoute :: (MonadFix m, MonadHold t m, GEq r, Adjustable t m) => (forall a. r a -> RoutedT t a m b) -> RoutedT t (R r) m (Dynamic t b)
178226subRoute f = factorRouted $ strictDynWidget $ \(c :=> r') -> do
179227 runRoutedT (f c) r'
180228
229+-- | Like 'subRoute_', but with a pair rather than an R
230+subPairRoute :: (MonadFix m, MonadHold t m, Eq a, Adjustable t m) => (a -> RoutedT t b m c) -> RoutedT t (a, b) m (Dynamic t c)
231+subPairRoute f = withRoutedT (fmap (\(a, b) -> Const2 a :/ b)) $ subRoute (\(Const2 a) -> f a)
232+
181233maybeRoute_ :: (MonadFix m, MonadHold t m, Adjustable t m) => m () -> RoutedT t r m () -> RoutedT t (Maybe r) m ()
182234maybeRoute_ n j = maybeRouted $ strictDynWidget_ $ \case
183235 Nothing -> n
@@ -194,6 +246,20 @@ maybeRoute f = factorRouted $ strictDynWidget $ \(c :=> r') -> do
194246 runRoutedT (f c) r'
195247-}
196248
249+eitherRoute_
250+ :: (MonadFix m, MonadHold t m, Adjustable t m)
251+ => RoutedT t l m ()
252+ -> RoutedT t r m ()
253+ -> RoutedT t (Either l r) m ()
254+eitherRoute_ l r = eitherRouted $ strictDynWidget_ $ either (runRoutedT l) (runRoutedT r)
255+
256+eitherRoute
257+ :: (MonadFix m, MonadHold t m, Adjustable t m)
258+ => RoutedT t l m a
259+ -> RoutedT t r m a
260+ -> RoutedT t (Either l r) m (Dynamic t a)
261+eitherRoute l r = eitherRouted $ strictDynWidget $ either (runRoutedT l) (runRoutedT r)
262+
197263dsumValueCoercion :: Coercion f g -> Coercion (DSum k f) (DSum k g)
198264dsumValueCoercion Coercion = Coercion
199265
@@ -203,13 +269,16 @@ dynamicIdentityCoercion = unsafeCoerce (Coercion :: Coercion (Identity ()) ()) -
203269factorRouted :: (Reflex t, MonadFix m, MonadHold t m, GEq f) => RoutedT t (DSum f (Dynamic t)) m a -> RoutedT t (DSum f Identity) m a
204270factorRouted r = RoutedT $ ReaderT $ \d -> do
205271 d' <- factorDyn d
206− runRoutedT r $ (coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d')
272+ runRoutedT r $ coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d'
207273
208274maybeRouted :: (Reflex t, MonadFix m, MonadHold t m) => RoutedT t (Maybe (Dynamic t a)) m b -> RoutedT t (Maybe a) m b
209275maybeRouted r = RoutedT $ ReaderT $ \d -> do
210276 d' <- maybeDyn d
211277 runRoutedT r d'
212278
279+eitherRouted :: (Reflex t, MonadFix m, MonadHold t m) => RoutedT t (Either (Dynamic t a) (Dynamic t b)) m c -> RoutedT t (Either a b) m c
280+eitherRouted r = RoutedT $ ReaderT $ runRoutedT r <=< eitherDyn
281+
213282-- | WARNING: The input 'Dynamic' must be fully constructed when this is run
214283strictDynWidget :: (MonadSample t m, MonadHold t m, Adjustable t m) => (a -> m b) -> RoutedT t a m (Dynamic t b)
215284strictDynWidget f = RoutedT $ ReaderT $ \r -> do
@@ -224,7 +293,7 @@ strictDynWidget_ f = RoutedT $ ReaderT $ \r -> do
224293 pure ()
225294
226295newtype SetRouteT t r m a = SetRouteT { unSetRouteT :: EventWriterT t (Endo r) m a }
227− deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, MonadIO, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadReflexCreateTrigger t, HasDocument)
296+ deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, MonadIO, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadReflexCreateTrigger t, HasDocument, DomRenderHook t)
228297
229298instance (MonadFix m, MonadHold t m, DomBuilder t m) => DomBuilder t (SetRouteT t r m) where
230299 type DomBuilderSpace (SetRouteT t r m) = DomBuilderSpace m
@@ -246,16 +315,26 @@ runSetRouteT = runEventWriterT . unSetRouteT
246315class Reflex t => SetRoute t r m | m -> t r where
247316 setRoute :: Event t r -> m ()
248317 modifyRoute :: Event t (r -> r) -> m ()
318+ default modifyRoute :: (Monad m', MonadTrans f, SetRoute t r m', m ~ f m') => Event t (r -> r) -> m ()
319+ modifyRoute = lift . modifyRoute
320+
249321 setRoute = modifyRoute . fmap const
250322
251323instance (Reflex t, Monad m) => SetRoute t r (SetRouteT t r m) where
252324 modifyRoute = SetRouteT . tellEvent . fmap Endo
253325
254−instance (Monad m, SetRoute t r m) => SetRoute t r (RoutedT t r' m) where
255− modifyRoute = lift . modifyRoute
326+instance (Monad m, SetRoute t r m) => SetRoute t r (RoutedT t r' m)
327+
328+instance (Monad m, SetRoute t r m) => SetRoute t r (ReaderT r' m)
256329
257−instance Prerender js m => Prerender js (SetRouteT t r m) where
258− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
330+instance (PerformEvent t m, Prerender js t m, Monad m, Reflex t) => Prerender js t (SetRouteT t r m) where
331+ type Client (SetRouteT t r m) = SetRouteT t r (Client m)
332+ prerender server client = do
333+ d <- lift $ prerender (runSetRouteT server) (runSetRouteT client)
334+ let (a, r) = splitDynPure d
335+ -- Must be prompt here
336+ SetRouteT . tellEvent $ switchPromptlyDyn r
337+ pure a
259338
260339instance Requester t m => Requester t (SetRouteT t r m) where
261340 type Request (SetRouteT t r m) = Request m
@@ -263,6 +342,8 @@ instance Requester t m => Requester t (SetRouteT t r m) where
263342 requesting = SetRouteT . requesting
264343 requesting_ = SetRouteT . requesting_
265344
345+instance (Monad m, SetRoute t r m) => SetRoute t r (RequesterT t req rsp m)
346+
266347#ifndef ghcjs_HOST_OS
267348deriving instance MonadJSM m => MonadJSM (SetRouteT t r m)
268349#endif
@@ -286,6 +367,8 @@ instance PrimMonad m => PrimMonad (SetRouteT t r m ) where
286367 type PrimState (SetRouteT t r m) = PrimState m
287368 primitive = lift . primitive
288369
370+instance HasConfigs m => HasConfigs (SetRouteT t r m)
371+
289372instance (MonadHold t m, Adjustable t m) => Adjustable t (SetRouteT t r m) where
290373 runWithReplace a0 a' = SetRouteT $ runWithReplace (coerce a0) $ coerceEvent a'
291374 traverseIntMapWithKeyWithAdjust f a0 a' = SetRouteT $ traverseIntMapWithKeyWithAdjust (coerce f) (coerce a0) $ coerce a'
@@ -299,9 +382,11 @@ instance (Monad m, MonadQuery t vs m) => MonadQuery t vs (SetRouteT t r m) where
299382
300383class RouteToUrl r m | m -> r where
301384 askRouteToUrl :: m (r -> Text)
385+ default askRouteToUrl :: (Monad m', MonadTrans f, RouteToUrl r m', m ~ f m') => m (r -> Text)
386+ askRouteToUrl = lift askRouteToUrl
302387
303388newtype RouteToUrlT r m a = RouteToUrlT { unRouteToUrlT :: ReaderT (r -> Text) m a }
304− deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument)
389+ deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument, DomRenderHook t)
305390
306391runRouteToUrlT
307392 :: RouteToUrlT r m a
@@ -316,17 +401,22 @@ instance Monad m => RouteToUrl r (RouteToUrlT r m) where
316401 askRouteToUrl = RouteToUrlT ask
317402
318403instance (Monad m, RouteToUrl r m) => RouteToUrl r (SetRouteT t r' m) where
319− askRouteToUrl = lift askRouteToUrl
320404
321405instance (Monad m, RouteToUrl r m) => RouteToUrl r (RoutedT t r' m) where
322− askRouteToUrl = lift askRouteToUrl
406+
407+instance (Monad m, RouteToUrl r m) => RouteToUrl r (ReaderT r' m) where
408+
409+instance (Monad m, RouteToUrl r m) => RouteToUrl r (RequesterT t req rsp m)
323410
324411instance HasJSContext m => HasJSContext (RouteToUrlT r m) where
325412 type JSContextPhantom (RouteToUrlT r m) = JSContextPhantom m
326413 askJSContext = lift askJSContext
327414
328−instance Prerender js m => Prerender js (RouteToUrlT r m) where
329− prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
415+instance (Prerender js t m, Monad m) => Prerender js t (RouteToUrlT r m) where
416+ type Client (RouteToUrlT r m) = RouteToUrlT r (Client m)
417+ prerender server client = do
418+ r <- RouteToUrlT ask
419+ lift $ prerender (runRouteToUrlT server r) (runRouteToUrlT client r)
330420
331421instance Requester t m => Requester t (RouteToUrlT r m) where
332422 type Request (RouteToUrlT r m) = Request m
@@ -376,6 +466,8 @@ instance (Monad m, MonadQuery t vs m) => MonadQuery t vs (RouteToUrlT r m) where
376466 askQueryResult = lift askQueryResult
377467 queryIncremental = lift . queryIncremental
378468
469+instance HasConfigs m => HasConfigs (RouteToUrlT t m)
470+
379471runRouteViewT
380472 :: forall t m r a.
381473 ( TriggerEvent t m
@@ -385,17 +477,21 @@ runRouteViewT
385477 , MonadJSM (Performable m)
386478 , MonadFix m
387479 )
388− => (Encoder Identity Identity r PageName)
480+ => Encoder Identity Identity r PageName
481+ --TODO: Get rid of the switchover and useHash arguments
482+ -- 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
484+ -> Bool
389485 -> RoutedT t r (SetRouteT t r (RouteToUrlT r m)) a
390486 -> m a
391−runRouteViewT routeEncoder a = do
392− rec historyState <- manageHistory $ HistoryCommand_PushState <$> setState
487+runRouteViewT routeEncoder switchover useHash a = do
488+ rec historyState <- manageHistory' switchover $ HistoryCommand_PushState <$> setState
393489 let theEncoder = pageNameEncoder . hoistParse (pure . runIdentity) routeEncoder
394490 -- NB: The can only fail if the uriPath doesn't begin with a '/' or if the uriQuery
395491 -- is nonempty, but begins with a character that isn't '?'. Since we don't expect
396492 -- this ever to happen, we'll just handle it by failing completely with 'error'.
397493 route :: Dynamic t r
398− route = fmap (errorLeft . tryDecode theEncoder . (adaptedUriPath &&& uriQuery) . _historyItem_uri) historyState
494+ route = fmap (errorLeft . tryDecode theEncoder . (adaptedUriPath useHash &&& uriQuery) . _historyItem_uri) historyState
399495 where
400496 errorLeft (Left e) = error (T.unpack e)
401497 errorLeft (Right x) = x
@@ -416,7 +512,7 @@ runRouteViewT routeEncoder a = do
416512 -- we can change this function later to accommodate.
417513 -- See: https://github.com/whatwg/html/issues/2174
418514 , _historyStateUpdate_title = ""
419− , _historyStateUpdate_uri = Just $ setAdaptedUriPath newPath $ (_historyItem_uri currentHistoryState)
515+ , _historyStateUpdate_uri = Just $ setAdaptedUriPath useHash newPath $ (_historyItem_uri currentHistoryState)
420516 { uriQuery = newQuery
421517 }
422518 }
@@ -426,42 +522,141 @@ runRouteViewT routeEncoder a = do
426522-- | A link widget that, when clicked, sets the route to the provided route. In non-javascript
427523-- contexts, this widget falls back to using @href@s to control navigation
428524routeLink
429− :: forall t m a route.
525+ :: forall t m a route js.
430526 ( DomBuilder t m
431− , RouteToUrl (R route) m
432− , SetRoute t (R route) m
527+ , RouteToUrl route m
528+ , SetRoute t route m
529+ , Prerender js t m
433530 )
434− => R route -- ^ Target route
531+ => route -- ^ Target route
435532 -> m a -- ^ Child widget
436533 -> m a
437534routeLink r w = do
535+ (e, a) <- routeLinkImpl r w
536+ scrollToTop e
537+ return a
538+
539+-- | Raw implementation of 'routeLink'. Does not scroll to the top of the page on clicks.
540+routeLinkImpl
541+ :: forall t m a route.
542+ ( DomBuilder t m
543+ , RouteToUrl route m
544+ , SetRoute t route m
545+ )
546+ => route -- ^ Target route
547+ -> m a -- ^ Child widget
548+ -> m (Event t (), a)
549+routeLinkImpl r w = do
438550 enc <- askRouteToUrl
439551 let cfg = (def :: ElementConfig EventResult t (DomBuilderSpace m))
440552 & elementConfig_eventSpec %~ addEventSpecFlags (Proxy :: Proxy (DomBuilderSpace m)) Click (\_ -> preventDefault)
441553 & elementConfig_initialAttributes .~ "href" =: enc r
442554 (e, a) <- element "a" cfg w
443555 setRoute $ r <$ domEvent Click e
556+ return (domEvent Click e, a)
557+
558+scrollToTop :: forall m t js. (Prerender js t m, Monad m) => Event t () -> m ()
559+scrollToTop e = prerender_ blank $ performEvent_ $ ffor e $ \_ -> liftJSM $ DOM.currentWindow >>= \case
560+ Nothing -> pure ()
561+ Just win -> Window.scrollTo win 0 0
562+
563+-- | Like 'routeLinkDynAttr' but without custom attributes.
564+dynRouteLink
565+ :: forall t m a route js.
566+ ( DomBuilder t m
567+ , PostBuild t m
568+ , RouteToUrl route m
569+ , SetRoute t route m
570+ , Prerender js t m
571+ )
572+ => Dynamic t route -- ^ Target route
573+ -> m a -- ^ Child widget
574+ -> m a
575+dynRouteLink r w = do
576+ (e, a) <- dynRouteLinkImpl r w
577+ scrollToTop e
444578 return a
445579
580+-- | Raw implementation of 'dynRouteLink'. Does not scroll to the top of the page on clicks.
581+dynRouteLinkImpl
582+ :: forall t m a route.
583+ ( DomBuilder t m
584+ , PostBuild t m
585+ , RouteToUrl route m
586+ , SetRoute t route m
587+ )
588+ => Dynamic t route -- ^ Target route
589+ -> m a -- ^ Child widget
590+ -> m (Event t (), a)
591+dynRouteLinkImpl dr w = do
592+ enc <- askRouteToUrl
593+ er <- dynamicAttributesToModifyAttributes $ ("href" =:) . enc <$> dr
594+ let cfg = (def :: ElementConfig EventResult t (DomBuilderSpace m))
595+ & elementConfig_eventSpec %~ addEventSpecFlags (Proxy :: Proxy (DomBuilderSpace m)) Click (\_ -> preventDefault)
596+ & elementConfig_modifyAttributes .~ er
597+ (e, a) <- element "a" cfg w
598+ let clk = domEvent Click e
599+ setRoute $ tag (current dr) clk
600+ return (clk, a)
601+
602+-- | An @a@-tag link widget that, when clicked, sets the route to current value of the
603+-- provided dynamic route. In non-JavaScript contexts the value of the dynamic post
604+-- build is used so the link still works like 'routeLink'.
605+routeLinkDynAttr
606+ :: forall t m a route js.
607+ ( DomBuilder t m
608+ , PostBuild t m
609+ , RouteToUrl (R route) m
610+ , SetRoute t (R route) m
611+ , Prerender js t m
612+ )
613+ => Dynamic t (Map AttributeName Text) -- ^ Attributes for @a@ element. Note that if @href@ is present it will be ignored
614+ -> Dynamic t (R route) -- ^ Target route
615+ -> m a -- ^ Child widget of the @a@ element
616+ -> m a
617+routeLinkDynAttr dAttr dr w = do
618+ (e, a) <- routeLinkDynAttrImpl dAttr dr w
619+ scrollToTop e
620+ return a
621+
622+-- | Raw implementation of 'routeLinkDynAttr'. Does not scroll to the top of the page on clicks.
623+routeLinkDynAttrImpl
624+ :: forall t m a route.
625+ ( DomBuilder t m
626+ , PostBuild t m
627+ , RouteToUrl (R route) m
628+ , SetRoute t (R route) m
629+ )
630+ => Dynamic t (Map AttributeName Text) -- ^ Attributes for @a@ element. Note that if @href@ is present it will be ignored
631+ -> Dynamic t (R route) -- ^ Target route
632+ -> m a -- ^ Child widget of the @a@ element
633+ -> m (Event t (), a)
634+routeLinkDynAttrImpl dAttr dr w = do
635+ enc <- askRouteToUrl
636+ er <- dynamicAttributesToModifyAttributes $ zipDynWith (<>) (("href" =:) . enc <$> dr) dAttr
637+ let cfg = (def :: ElementConfig EventResult t (DomBuilderSpace m))
638+ & elementConfig_eventSpec %~ addEventSpecFlags (Proxy :: Proxy (DomBuilderSpace m)) Click (\_ -> preventDefault)
639+ & elementConfig_modifyAttributes .~ er
640+ (e, a) <- element "a" cfg w
641+ let clk = domEvent Click e
642+ setRoute $ tag (current dr) clk
643+ return (clk, a)
644+
446645-- On ios due to sandboxing when loading the page from a file adapt the
447646-- path to be based on the hash.
448647
449−adaptedUriPath :: URI -> String
450−#if defined(ios_HOST_OS)
451−adaptedUriPath = hashToPath . uriFragment
648+adaptedUriPath :: Bool -> URI -> String
649+adaptedUriPath = \case
650+ True -> hashToPath . uriFragment
651+ False -> uriPath
452652
453−hashToPath :: String -> String
454−hashToPath = ('/' :) . fromMaybe "" . L.stripPrefix "#"
455−#else
456−adaptedUriPath = uriPath
457−#endif
458−
459−setAdaptedUriPath :: String -> URI -> URI
460−#if defined(ios_HOST_OS)
461−setAdaptedUriPath s u = u { uriFragment = pathToHash s }
653+setAdaptedUriPath :: Bool -> String -> URI -> URI
654+setAdaptedUriPath useHash s u = case useHash of
655+ True -> u { uriFragment = pathToHash s }
656+ False -> u { uriPath = s }
462657
463658pathToHash :: String -> String
464659pathToHash = ('#' :) . fromMaybe "" . L.stripPrefix "/"
465−#else
466−setAdaptedUriPath s u = u { uriPath = s }
467−#endif
660+
661+hashToPath :: String -> String
662+hashToPath = ('/' :) . fromMaybe "" . L.stripPrefix "#"
lib/route/src/Obelisk/Route/TH.hs+4−5
@@ -1,8 +1,9 @@
11module Obelisk.Route.TH (deriveRouteComponent) where
22
3+import Data.Constraint.Extras.TH
34import Data.GADT.Show.TH
45import Data.GADT.Compare.TH
5−import Data.Universe.TH
6+import Data.Universe.Some.TH
67import Language.Haskell.TH
78
89-- | Derive all the typeclasses needed for a RouteComponent type. The argument should be the name of a type of kind @k -> *@
@@ -11,8 +12,6 @@ deriveRouteComponent x = concat <$> traverse ($ x)
1112 [ deriveGShow
1213 , deriveGEq
1314 , deriveGCompare
14− , deriveShowTagIdentity
15− , deriveEqTagIdentity
16− , deriveOrdTagIdentity
17− , deriveSomeUniverse
15+ , deriveUniverseSome
16+ , deriveArgDict
1817 ]
lib/run/obelisk-run.cabal+12−4
@@ -10,9 +10,12 @@ library
1010 attoparsec
1111 , base
1212 , bytestring
13+ , containers
14+ , cookie
1315 , dependent-sum
1416 , dependent-sum-template
1517 , ghcjs-dom
18+ , HsOpenSSL
1619 , http-client
1720 , http-reverse-proxy
1821 , http-types
@@ -24,22 +27,27 @@ library
2427 , network
2528 , obelisk-asset-serve-snap
2629 , obelisk-backend
27− , obelisk-executable-config
28− , obelisk-executable-config-inject
30+ , obelisk-executable-config-lookup
2931 , obelisk-frontend
3032 , obelisk-route
3133 , process
3234 , ref-tf
3335 , reflex
34− , reflex-dom
36+ , reflex-dom-core
3537 , snap-core
3638 , streaming-commons
3739 , text
40+ , time
3841 , universe
42+ , utf8-string
3943 , wai
4044 , wai-websockets
4145 , warp
46+ , warp-tls
4247 , websockets
4348 exposed-modules:
4449 Obelisk.Run
45− ghc-options: -Wall -fwarn-redundant-constraints
50+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
51+ if os(linux)
52+ cpp-options: -DIPROUTE_SUPPORTED
53+ build-depends: which
lib/run/src/Obelisk/Run.hs+120−53
@@ -1,17 +1,17 @@
1+{-# LANGUAGE CPP #-}
2+#if defined(IPROUTE_SUPPORTED)
3+{-# LANGUAGE TemplateHaskell #-}
4+#endif
5+
16{-# LANGUAGE ConstraintKinds #-}
2−{-# LANGUAGE EmptyCase #-}
3−{-# LANGUAGE EmptyDataDecls #-}
47{-# LANGUAGE FlexibleContexts #-}
58{-# LANGUAGE FlexibleInstances #-}
69{-# LANGUAGE GADTs #-}
7−{-# LANGUAGE KindSignatures #-}
810{-# LANGUAGE LambdaCase #-}
911{-# LANGUAGE MultiParamTypeClasses #-}
1012{-# LANGUAGE OverloadedStrings #-}
1113{-# LANGUAGE Rank2Types #-}
12−{-# LANGUAGE RecursiveDo #-}
1314{-# LANGUAGE ScopedTypeVariables #-}
14−{-# LANGUAGE TemplateHaskell #-}
1515{-# LANGUAGE TypeFamilies #-}
1616{-# LANGUAGE UndecidableInstances #-}
1717{-# OPTIONS_GHC -fno-warn-orphans #-} -- Due to instance HasJS x (EventWriterT t w m)
@@ -25,17 +25,22 @@ import Control.Exception
2525import Control.Lens ((%~), (^?), _Just, _Right)
2626import qualified Data.Attoparsec.ByteString.Char8 as A
2727import Data.ByteString (ByteString)
28+import qualified Data.ByteString as BS
2829import qualified Data.ByteString.Char8 as BSC
2930import qualified Data.ByteString.Lazy.Char8 as BSLC
30−import Data.Dependent.Sum (DSum (..))
31+import qualified Data.ByteString.UTF8 as BSUTF8
3132import Data.Functor.Identity
32−import Data.Functor.Sum
3333import Data.List (uncons)
34+import Data.Map (Map)
35+import qualified Data.Map as Map
3436import Data.Maybe
3537import Data.Semigroup ((<>))
3638import Data.Streaming.Network (bindPortTCP)
39+import Data.String (fromString)
3740import Data.Text (Text)
3841import qualified Data.Text as T
42+import qualified Data.Text.Encoding as T
43+import Data.Time.Clock (getCurrentTime, addUTCTime)
3944import Language.Javascript.JSaddle.Run (syncPoint)
4045import Language.Javascript.JSaddle.WebSockets
4146import Network.HTTP.Client (Manager, defaultManagerSettings, newManager)
@@ -45,14 +50,18 @@ import Network.Socket
4550import Network.Wai (Application)
4651import qualified Network.Wai as W
4752import Network.Wai.Handler.Warp
53+import Network.Wai.Handler.WarpTLS
4854import Network.Wai.Handler.Warp.Internal (settingsHost, settingsPort)
4955import Network.WebSockets (ConnectionOptions)
5056import Network.WebSockets.Connection (defaultConnectionOptions)
5157import qualified Obelisk.Asset.Serve.Snap as Snap
52−import Obelisk.ExecutableConfig (get)
53−import Obelisk.ExecutableConfig.Inject (injectExecutableConfigs)
58+import Obelisk.Backend
5459import Obelisk.Frontend
5560import Obelisk.Route.Frontend
61+import qualified OpenSSL.PEM as PEM
62+import qualified OpenSSL.RSA as RSA
63+import qualified OpenSSL.X509 as X509
64+import qualified OpenSSL.X509.Request as X509Request
5665import Reflex.Dom.Core
5766import Snap.Core (Snap)
5867import System.Environment
@@ -61,12 +70,16 @@ import System.Process
6170import Text.URI (URI)
6271import qualified Text.URI as URI
6372import Text.URI.Lens
64−import Obelisk.Backend
73+import Web.Cookie
74+
75+#if defined(IPROUTE_SUPPORTED)
76+import qualified System.Which
77+#endif
6578
6679run
6780 :: Int -- ^ Port to run the backend
6881 -> ([Text] -> Snap ()) -- ^ Static asset handler
69− -> Backend fullRoute frontendRoute -- ^ Backend
82+ -> Backend backendRoute frontendRoute -- ^ Backend
7083 -> Frontend (R frontendRoute) -- ^ Frontend
7184 -> IO ()
7285run port serveStaticAsset backend frontend = do
@@ -76,82 +89,126 @@ run port serveStaticAsset backend frontend = do
7689 case checkEncoder $ _backend_routeEncoder backend of
7790 Left e -> hPutStrLn stderr $ "backend error:\n" <> T.unpack e
7891 Right validFullEncoder -> do
79− backendTid <- forkIO $ handle handleBackendErr $ withArgs ["--quiet", "--port", show port] $ do
80− _backend_run backend $ \serveRoute -> do
81− runSnapWithCommandLineArgs $ do
92+ publicConfigs <- getPublicConfigs
93+ backendTid <- forkIO $ handle handleBackendErr $ withArgs ["--quiet", "--port", show port] $
94+ _backend_run backend $ \serveRoute ->
95+ runSnapWithCommandLineArgs $
8296 getRouteWith validFullEncoder >>= \case
8397 Identity r -> case r of
84− InL backendRoute :=> Identity a -> serveRoute $ backendRoute :/ a
85− InR obeliskRoute :=> Identity a ->
86− serveDefaultObeliskApp (mkRouteToUrl validFullEncoder) serveStaticAsset frontend $ obeliskRoute :/ a
98+ FullRoute_Backend backendRoute :/ a -> serveRoute $ backendRoute :/ a
99+ FullRoute_Frontend obeliskRoute :/ a ->
100+ serveDefaultObeliskApp appRouteToUrl (($ allJsUrl) <$> defaultGhcjsWidgets) serveStaticAsset frontend publicConfigs $ obeliskRoute :/ a
101+ where
102+ appRouteToUrl (k :/ v) = renderObeliskRoute validFullEncoder (FullRoute_Frontend (ObeliskRoute_App k) :/ v)
103+ allJsUrl = renderAllJsPath validFullEncoder
104+
87105 let conf = defRunConfig { _runConfig_redirectPort = port }
88− runWidget conf frontend validFullEncoder `finally` killThread backendTid
106+ runWidget conf publicConfigs frontend validFullEncoder `finally` killThread backendTid
89107
90108-- Convenience wrapper to handle path segments for 'Snap.serveAsset'
91109runServeAsset :: FilePath -> [Text] -> Snap ()
92110runServeAsset rootPath = Snap.serveAsset "" rootPath . T.unpack . T.intercalate "/"
93111
94−getConfigRoute :: IO (Maybe URI)
95−getConfigRoute = get "config/common/route" >>= \case
96− Just r -> case URI.mkURI $ T.strip r of
97− Just route -> pure $ Just route
98− Nothing -> do
99− putStrLn $ "Route is invalid: " <> show r
100− pure Nothing
101− Nothing -> pure Nothing
102−
103−defAppUri :: URI
104−defAppUri = fromMaybe (error "defAppUri") $ URI.mkURI "http://127.0.0.1:8000"
105−
106−runWidget :: RunConfig -> Frontend (R route) -> Encoder Identity Identity (R (Sum backendRoute (ObeliskRoute route))) PageName -> IO ()
107−runWidget conf frontend validFullEncoder = do
108− uri <- fromMaybe defAppUri <$> getConfigRoute
112+getConfigRoute :: Map Text ByteString -> Either Text URI
113+getConfigRoute configs = case Map.lookup "common/route" configs of
114+ Just r ->
115+ let stripped = T.strip (T.decodeUtf8 r)
116+ in case URI.mkURI stripped of
117+ Just route -> Right route
118+ Nothing -> Left $ "Couldn't parse route as URI; value read was: " <> T.pack (show stripped)
119+ Nothing -> Left $ "Couldn't find config file common/route; it should contain the site's canonical root URI" <> T.pack (show $ Map.keys configs)
120+
121+runWidget
122+ :: RunConfig
123+ -> Map Text ByteString
124+ -> Frontend (R frontendRoute)
125+ -> Encoder Identity Identity (R (FullRoute backendRoute frontendRoute)) PageName
126+ -> IO ()
127+runWidget conf configs frontend validFullEncoder = do
128+ uri <- either (fail . T.unpack) pure $ getConfigRoute configs
109129 let port = fromIntegral $ fromMaybe 80 $ uri ^? uriAuthority . _Right . authPort . _Just
110130 redirectHost = _runConfig_redirectHost conf
111131 redirectPort = _runConfig_redirectPort conf
112132 beforeMainLoop = do
113133 putStrLn $ "Frontend running on " <> T.unpack (URI.render uri)
114134 settings = setBeforeMainLoop beforeMainLoop (setPort port (setTimeout 3600 defaultSettings))
135+ -- Providing TLS here will also incidentally provide it to proxied requests to the backend.
136+ prepareRunner = case uri ^? uriScheme . _Just . unRText of
137+ Just "https" -> do
138+ -- Generate a private key and self-signed certificate for TLS
139+ privateKey <- RSA.generateRSAKey' 2048 3
140+
141+ certRequest <- X509Request.newX509Req
142+ _ <- X509Request.setPublicKey certRequest privateKey
143+ _ <- X509Request.signX509Req certRequest privateKey Nothing
144+
145+ cert <- X509.newX509 >>= X509Request.makeX509FromReq certRequest
146+ _ <- X509.setPublicKey cert privateKey
147+ timenow <- getCurrentTime
148+ _ <- X509.setNotBefore cert $ addUTCTime (-1) timenow
149+ _ <- X509.setNotAfter cert $ addUTCTime (365 * 24 * 60 * 60) timenow
150+ _ <- X509.signX509 cert privateKey Nothing
151+
152+ certByteString <- BSUTF8.fromString <$> PEM.writeX509 cert
153+ privateKeyByteString <- BSUTF8.fromString <$> PEM.writePKCS8PrivateKey privateKey Nothing
154+
155+ return $ runTLSSocket (tlsSettingsMemory certByteString privateKeyByteString)
156+ _ -> return runSettingsSocket
157+ runner <- prepareRunner
115158 bracket
116159 (bindPortTCPRetry settings (logPortBindErr port) (_runConfig_retryTimeout conf))
117160 close
118161 (\skt -> do
119162 man <- newManager defaultManagerSettings
120− app <- obeliskApp defaultConnectionOptions frontend validFullEncoder uri $ fallbackProxy redirectHost redirectPort man
121− runSettingsSocket settings skt app)
163+ app <- obeliskApp configs defaultConnectionOptions frontend validFullEncoder uri $ fallbackProxy redirectHost redirectPort man
164+ runner settings skt app)
122165
123166obeliskApp
124− :: forall route backendRoute. ConnectionOptions
125− -> Frontend (R route)
126− -> Encoder Identity Identity (R (Sum backendRoute (ObeliskRoute route))) PageName
167+ :: forall frontendRoute backendRoute
168+ . Map Text ByteString
169+ -> ConnectionOptions
170+ -> Frontend (R frontendRoute)
171+ -> Encoder Identity Identity (R (FullRoute backendRoute frontendRoute)) PageName
127172 -> URI
128173 -> Application
129174 -> IO Application
130−obeliskApp opts frontend validFullEncoder uri backend = do
131− let entryPoint = do
132− runFrontend validFullEncoder frontend
175+obeliskApp configs opts frontend validFullEncoder uri backend = do
176+ let mode = FrontendMode
177+ { _frontendMode_hydrate = True
178+ , _frontendMode_adjustRoute = False
179+ }
180+ entryPoint = do
181+ runFrontendWithConfigsAndCurrentRoute mode configs validFullEncoder frontend
133182 syncPoint
134183 jsaddlePath <- URI.mkPathPiece "jsaddle"
135184 let jsaddleUri = BSLC.fromStrict $ URI.renderBs $ uri & uriPath %~ (<>[jsaddlePath])
136185 Right (jsaddleWarpRouteValidEncoder :: Encoder Identity (Either Text) (R JSaddleWarpRoute) PageName) <- return $ checkEncoder jsaddleWarpRouteEncoder
137186 jsaddle <- jsaddleWithAppOr opts entryPoint $ \_ sendResponse -> sendResponse $ W.responseLBS H.status500 [("Content-Type", "text/plain")] "obeliskApp: jsaddle got a bad URL"
138− return $ \req sendResponse -> case tryDecode validFullEncoder (W.pathInfo req, mempty) of --TODO: Query strings
187+ return $ \req sendResponse -> case tryDecode validFullEncoder $ byteStringsToPageName (BS.dropWhile (== (fromIntegral $ fromEnum '/')) $ W.rawPathInfo req) (BS.drop 1 $ W.rawQueryString req) of
139188 Identity r -> case r of
140− InR (ObeliskRoute_Resource ResourceRoute_JSaddleWarp) :=> Identity jsaddleRoute -> case jsaddleRoute of
189+ FullRoute_Frontend (ObeliskRoute_Resource ResourceRoute_JSaddleWarp) :/ jsaddleRoute -> case jsaddleRoute of
141190 JSaddleWarpRoute_JavaScript :/ () -> sendResponse $ W.responseLBS H.status200 [("Content-Type", "application/javascript")] $ jsaddleJs' (Just jsaddleUri) False
142191 _ -> flip jsaddle sendResponse $ req
143192 { W.pathInfo = fst $ encode jsaddleWarpRouteValidEncoder jsaddleRoute
144193 }
145− InR (ObeliskRoute_App appRouteComponent) :=> Identity appRouteRest -> do
146− html <- renderJsaddleFrontend (mkRouteToUrl validFullEncoder) (appRouteComponent :/ appRouteRest) frontend
194+ FullRoute_Frontend (ObeliskRoute_App appRouteComponent) :/ appRouteRest -> do
195+ let cookies = maybe [] parseCookies $ lookup (fromString "Cookie") (W.requestHeaders req)
196+ routeToUrl (k :/ v) = renderObeliskRoute validFullEncoder $ FullRoute_Frontend (ObeliskRoute_App k) :/ v
197+ html <- renderJsaddleFrontend configs cookies routeToUrl (appRouteComponent :/ appRouteRest) frontend
147198 sendResponse $ W.responseLBS H.status200 [("Content-Type", staticRenderContentType)] $ BSLC.fromStrict html
148199 _ -> backend req sendResponse
149200
150−renderJsaddleFrontend :: (route -> Text) -> route -> Frontend route -> IO ByteString
151−renderJsaddleFrontend urlEnc r f =
201+renderJsaddleFrontend
202+ :: Map Text ByteString
203+ -> Cookies
204+ -> (route -> Text)
205+ -> route
206+ -> Frontend route
207+ -> IO ByteString
208+renderJsaddleFrontend configs cookies urlEnc r f =
152209 let jsaddleScript = elAttr "script" ("src" =: "/jsaddle/jsaddle.js") blank
153210 jsaddlePreload = elAttr "link" ("rel" =: "preload" <> "as" =: "script" <> "href" =: "/jsaddle/jsaddle.js") blank
154− in renderFrontendHtml urlEnc r (_frontend_head f >> injectExecutableConfigs >> jsaddlePreload) (_frontend_body f >> jsaddleScript)
211+ in renderFrontendHtml configs cookies urlEnc r f jsaddlePreload jsaddleScript
155212
156213-- | like 'bindPortTCP' but reconnects on exception
157214bindPortTCPRetry :: Settings
@@ -168,12 +225,22 @@ logPortBindErr p e = getProcessIdForPort p >>= \case
168225 Nothing -> putStrLn $ "runWidget: " <> show e
169226 Just pid -> putStrLn $ unwords [ "Port", show p, "is being used by process ID", show pid <> ".", "Please kill that process or change the port in config/common/route."]
170227
228+ssPath :: Maybe String
229+ssPath =
230+#if defined(IPROUTE_SUPPORTED)
231+ Just $(System.Which.staticWhich "ss")
232+#else
233+ Nothing
234+#endif
235+
171236getProcessIdForPort :: Int -> IO (Maybe Int)
172−getProcessIdForPort port = do
173− xs <- lines <$> readProcess "ss" ["-lptn", "sport = " <> show port] mempty
174− case uncons xs of
175− Just (_, x:_) -> return $ A.maybeResult $ A.parse parseSsPid $ BSC.pack x
176− _ -> return Nothing
237+getProcessIdForPort port = case ssPath of
238+ Just ss -> do
239+ xs <- lines <$> readProcess ss ["-lptn", "sport = " <> show port] mempty
240+ case uncons xs of
241+ Just (_, x:_) -> return $ A.maybeResult $ A.parse parseSsPid $ BSC.pack x
242+ _ -> return Nothing
243+ _ -> return Nothing
177244
178245parseSsPid :: A.Parser Int
179246parseSsPid = do
lib/selftest/obelisk-selftest.cabal+7−3
@@ -9,17 +9,21 @@ library
99 hs-source-dirs: src
1010 build-depends:
1111 base
12+ , bytestring
13+ , aeson
1214 , containers
1315 , directory
16+ , filepath
1417 , hspec
1518 , http-client
1619 , http-types
1720 , HUnit
18− , obelisk-cliapp
21+ , network
22+ , obelisk-executable-config-lookup
1923 , obelisk-run
24+ , which
2025 , process
21− , network
22− , shelly
26+ , shelly >= 1.9.0
2327 , temporary
2428 , text
2529 exposed-modules:
lib/selftest/src/Obelisk/SelfTest.hs+499−180
@@ -1,39 +1,50 @@
1+{-# LANGUAGE DoAndIfThenElse #-}
12{-# LANGUAGE EmptyCase #-}
23{-# LANGUAGE LambdaCase #-}
34{-# LANGUAGE OverloadedStrings #-}
45{-# LANGUAGE PatternGuards #-}
56{-# LANGUAGE ScopedTypeVariables #-}
7+{-# LANGUAGE TemplateHaskell #-}
68{-# LANGUAGE TypeApplications #-}
9+{-# LANGUAGE ViewPatterns #-}
710module Obelisk.SelfTest where
811
9−import Control.Exception (bracket, throw)
12+import Control.Concurrent (threadDelay)
13+import Control.Exception (bracket, throw, try)
1014import Control.Monad
1115import Control.Monad.IO.Class
16+import qualified Data.Aeson as Aeson
17+import qualified Data.Aeson.Types as Aeson
1218import Data.Bool (bool)
19+import qualified Data.ByteString.Lazy as LBS
20+import Data.Foldable (for_)
1321import Data.Function (fix)
14−import Data.Semigroup (Semigroup, (<>))
22+import Data.List (isInfixOf)
23+import qualified Data.Map as Map
24+import Data.Semigroup ((<>))
1525import qualified Data.Set as Set
1626import Data.String
1727import Data.Text (Text)
18−import Data.Void
1928import qualified Data.Text as T
29+import qualified Data.Text.Encoding as T
2030import qualified Data.Text.IO as T
2131import qualified Network.HTTP.Client as HTTP
2232import qualified Network.HTTP.Types as HTTP
2333import qualified Network.Socket as Socket
2434import Shelly
25−import System.Directory (withCurrentDirectory)
35+import System.Directory (getCurrentDirectory, withCurrentDirectory, getDirectoryContents)
2636import System.Environment
2737import System.Exit (ExitCode (..))
28−import System.Info
29−import System.IO (Handle, hClose)
38+import System.FilePath (addTrailingPathSeparator)
39+import qualified System.Info
40+import System.IO (Handle, hClose, hIsEOF, hGetContents)
3041import System.IO.Temp
31−import System.Process (readProcessWithExitCode, CreateProcess(cwd), readCreateProcessWithExitCode, proc)
42+import System.Process (readProcessWithExitCode)
43+import System.Which (staticWhich)
3244import Test.Hspec
3345import Test.HUnit.Base
3446
35−import Obelisk.CliApp hiding (runCli, readCreateProcessWithExitCode)
36−import qualified Obelisk.CliApp as CliApp
47+import Obelisk.ExecutableConfig.Lookup (getConfigs)
3748import Obelisk.Run (getConfigRoute)
3849
3950data ObRunState
@@ -42,24 +53,53 @@ data ObRunState
4253 | ObRunState_BackendStarted
4354 deriving (Eq, Show)
4455
45−doubleQuotes :: (IsString a, Semigroup a) => a -> a
46−doubleQuotes s = "\"" <> s <> "\""
56+cpPath :: FilePath
57+cpPath = $(staticWhich "cp")
58+
59+cabalPath :: FilePath
60+cabalPath = $(staticWhich "cabal")
61+
62+gitPath :: FilePath
63+gitPath = $(staticWhich "git")
64+
65+chownPath :: FilePath
66+chownPath = $(staticWhich "chown")
67+
68+chmodPath :: FilePath
69+chmodPath = $(staticWhich "chmod")
70+
71+whoamiPath :: FilePath
72+whoamiPath = $(staticWhich "whoami")
73+
74+nixInstantiatePath :: FilePath
75+nixInstantiatePath = $(staticWhich "nix-instantiate")
76+
77+nixBuildPath :: FilePath
78+nixBuildPath = $(staticWhich "nix-build")
79+
80+nixPrefetchGitPath :: FilePath
81+nixPrefetchGitPath = $(staticWhich "nix-prefetch-git")
82+
83+lnPath :: FilePath
84+lnPath = $(staticWhich "ln")
85+
86+rmPath :: FilePath
87+rmPath = $(staticWhich "rm")
88+
89+rsyncPath :: FilePath
90+rsyncPath = $(staticWhich "rsync")
91+
92+gitUserConfig :: [Text]
93+gitUserConfig = ["-c", "user.name=Obelisk Selftest", "-c", "user.email=noreply@example.com"]
4794
4895commit :: Text -> Sh ()
49−commit msg = void $ run "git"
50− [ "commit"
96+commit msg = void $ run gitPath $ gitUserConfig <> [ "commit"
5197 , "--no-gpg-sign"
5298 , "--allow-empty"
5399 , "-m"
54− , doubleQuotes msg
100+ , msg
55101 ]
56102
57−-- TODO replace Void and stop using loosely typed synchronous exceptions
58−runCli :: MonadIO m => CliT Void IO a -> m a
59−runCli f = liftIO $ do
60− c <- newCliConfig Notice False False (\case {})
61− CliApp.runCli c f
62−
63103tshow :: Show a => a -> Text
64104tshow = T.pack . show
65105
@@ -67,191 +107,345 @@ tshow = T.pack . show
67107shellyOb :: MonadIO m => (Sh a -> Sh a) -> Sh a -> m a
68108shellyOb f obTest = shelly $ f obTest
69109
110+-- Set "ob" in a single place so it can be replaced with a
111+-- link to obelisk in the nix store in the future,
112+-- and avoid PATH hacking before calling this script.
113+ob :: FilePath
114+ob = "ob"
115+
116+augmentWithVerbosity :: (String -> [Text] -> a) -> String -> Bool -> [Text] -> a
117+augmentWithVerbosity runner executable isVerbose args = runner executable $ (if isVerbose then ("-v" :) else id) args
118+
119+isolatedGitShell :: Bool -> FilePath -> (([Text] -> Sh Text) -> Sh a) -> IO a
120+isolatedGitShell isVerbose dir f = shelly $ bool silently verbosely isVerbose $ do
121+ setenv "HOME" "/dev/null"
122+ setenv "GIT_CONFIG_NOSYSTEM" "1"
123+ _ <- git ["init"]
124+ _ <- git ["config", "user.name", "SelfTest"]
125+ _ <- git ["config", "user.email", "self@test"]
126+ f git
127+ where
128+ git args = run gitPath $ ["-C", toTextIgnore dir] <> args
129+
130+-- | Copies a git repo to a new location and "resets" the git history to include
131+-- exactly one commit with all files added. It then restricts writing and reading
132+-- for group and user to make the repo ideal for being a valid git remote for thunks.
133+--
134+-- Using this allows dirty repos to be used as git remotes during the test since 'git clone'ing
135+-- a dirty repo will not include the uncommitted changes.
136+copyForGitRemote :: Bool -> FilePath -> FilePath -> IO ()
137+copyForGitRemote isVerbose origDir copyDir = isolatedGitShell isVerbose copyDir $ \git -> do
138+ run_ rsyncPath
139+ [ "-r", "--no-perms", "--no-owner", "--no-group", "--exclude", ".git"
140+ , toTextIgnore (addTrailingPathSeparator origDir), toTextIgnore copyDir
141+ ]
142+ _ <- git ["add", "--all"]
143+ _ <- git ["commit", "-m", "Copy repo"]
144+ run_ chmodPath ["-R", "u-w,g-rw,o-rw", toTextIgnore copyDir] -- Freeze this state
145+
70146main :: IO ()
71147main = do
72148 -- Note: you can pass hspec arguments as well, eg: `-m <pattern>`
73− isVerbose <- (elem "-v") <$> getArgs
149+ isVerbose <- elem "-v" <$> getArgs
74150 unless isVerbose $
75151 putStrLn "Tests may take longer to run if there are unbuilt derivations: use -v for verbose output"
76− let verbosity = bool silently verbosely isVerbose
77− obeliskImpl <- fromString <$> getEnv "OBELISK_IMPL"
152+
153+ obeliskImplDirtyReadOnly <- getCurrentDirectory
78154 httpManager <- HTTP.newManager HTTP.defaultManagerSettings
79− [p0, p1, p2, p3] <- liftIO $ getFreePorts 4
80− withSystemTempDirectory "initCache" $ \initCache -> do
81− -- Setup the ob init cache
82− void . shellyOb verbosity $ chdir (fromString initCache) $ do
83− run_ "ob" ["init"]
84− run_ "git" ["init"]
85− hspec $ parallel $ do
86− let shelly_ = void . shellyOb verbosity
87−
88− inTmp :: (Shelly.FilePath -> Sh a) -> IO ()
89− inTmp f = withTmp (chdir <*> f)
90−
91− withTmp f = shelly_ . withSystemTempDirectory "test" $ f . fromString
92−
93− inTmpObInit f = inTmp $ \dir -> do
94− run_ "cp" ["-a", fromString $ initCache <> "/.", toTextIgnore dir]
95− f dir
96−
97− assertRevEQ a b = liftIO . assertEqual "" "" =<< diff a b
98− assertRevNE a b = liftIO . assertBool "" . (/= "") =<< diff a b
99−
100− revParseHead = T.strip <$> run "git" ["rev-parse", "HEAD"]
101−
102− commitAll = do
103− run_ "git" ["add", "."]
104− commit "checkpoint"
105− revParseHead
106−
107− thunk = ".obelisk/impl"
108− update = run "ob" ["thunk", "update", thunk] >> commitAll
109− pack = run "ob" ["thunk", "pack", thunk] >> commitAll
110− unpack = run "ob" ["thunk", "unpack", thunk] >> commitAll
111−
112− diff a b = run "git" ["diff", a, b]
113−
114− describe "ob init" $ parallel $ do
115− it "works with default impl" $ inTmp $ \_ -> run "ob" ["init"]
116− it "works with master branch impl" $ inTmp $ \_ -> run "ob" ["init", "--branch", "master"]
117− it "works with symlink" $ inTmp $ \_ -> run "ob" ["init", "--symlink", obeliskImpl]
118− it "doesn't silently overwrite existing files" $ withSystemTempDirectory "ob-init" $ \dir -> do
119− let p force = (proc "ob" $ "--no-handoff" : "init" : if force then ["--force"] else []) { cwd = Just dir }
120− (ExitSuccess, _, _) <- readCreateProcessWithExitCode (p False) ""
121− (ExitFailure _, _, _) <- readCreateProcessWithExitCode (p False) ""
122− (ExitSuccess, _, _) <- readCreateProcessWithExitCode (p True) ""
123− pure ()
124−
125− it "doesn't create anything when given an invalid impl" $ inTmp $ \tmp -> do
126− void $ errExit False $ run "ob" ["init", "--symlink", "/dev/null"]
127− ls tmp >>= liftIO . assertEqual "" []
128−
129− it "produces a valid route config" $ inTmpObInit $ \tmp -> do
130− liftIO $ withCurrentDirectory (T.unpack $ toTextIgnore tmp) $ getConfigRoute `shouldNotReturn` Nothing
131−
132− -- These tests fail with "Could not find module 'Obelisk.Generated.Static'"
133− -- when not run by 'nix-build --attr selftest'
134− describe "ob run" $ parallel $ do
135− it "works in root directory" $ inTmpObInit $ \_ -> do
136− testObRunInDir p0 p1 Nothing httpManager
137− it "works in sub directory" $ inTmpObInit $ \_ -> do
138− testObRunInDir p2 p3 (Just "frontend") httpManager
139−
140− describe "obelisk project" $ parallel $ do
141− it "can build obelisk command" $ inTmpObInit $ \_ -> run "nix-build" ["-A", "command" , obeliskImpl]
142− it "can build obelisk skeleton" $ inTmpObInit $ \_ -> run "nix-build" ["-A", "skeleton", obeliskImpl]
143− it "can build obelisk shell" $ inTmpObInit $ \_ -> run "nix-build" ["-A", "shell", obeliskImpl]
144− -- See https://github.com/obsidiansystems/obelisk/issues/101
145− -- it "can build everything" $ shelly_ $ run "nix-build" [obeliskImpl]
146−
147− describe "blank initialized project" $ parallel $ do
148−
149− it "can build ghc.backend" $ inTmpObInit $ \_ -> do
150− run "nix-build" ["--no-out-link", "-A", "ghc.backend"]
151− it "can build ghcjs.frontend" $ inTmpObInit $ \_ -> do
152− run "nix-build" ["--no-out-link", "-A", "ghcjs.frontend"]
153−
154− if os == "darwin"
155− then it "can build ios" $ inTmpObInit $ \_ -> run "nix-build" ["--no-out-link", "-A", "ios.frontend" ]
156− else it "can build android" $ inTmpObInit $ \_ -> run "nix-build" ["--no-out-link", "-A", "android.frontend"]
157−
158− forM_ ["ghc", "ghcjs"] $ \compiler -> do
159− let
160− shell = "shells." <> compiler
161− inShell cmd' = run "nix-shell" ["-A", fromString shell, "--run", cmd']
162− it ("can enter " <> shell) $ inTmpObInit $ \_ -> inShell "exit"
163− it ("can build in " <> shell) $ inTmpObInit $ \_ -> inShell $ "cabal new-build --" <> fromString compiler <> " all"
164−
165− it "can build reflex project" $ inTmpObInit $ \_ -> do
166− run "nix-build" []
167−
168− it "has idempotent thunk update" $ inTmpObInit $ \_ -> do
169− u <- update
170− uu <- update
171− assertRevEQ u uu
172−
173− describe "ob thunk pack/unpack" $ parallel $ do
174− it "has thunk pack and unpack inverses" $ inTmpObInit $ \_ -> do
175−
176− e <- commitAll
177− eu <- unpack
178− eup <- pack
179− eupu <- unpack
180− _ <- pack
181−
182− assertRevEQ e eup
183− assertRevEQ eu eupu
184− assertRevNE e eu
185−
186− it "unpacks the correct branch" $ withTmp $ \dir -> do
187− let branch = "master"
188− run_ "git" ["clone", "https://github.com/reflex-frp/reflex.git", toTextIgnore dir, "--branch", branch]
189− run_ "ob" ["thunk", "pack", toTextIgnore dir]
190− run_ "ob" ["thunk", "unpack", toTextIgnore dir]
191− branch' <- chdir dir $ run "git" ["rev-parse", "--abbrev-ref", "HEAD"]
192− liftIO $ assertEqual "" branch (T.strip branch')
193−
194− it "can pack and unpack plain git repos" $ do
195− shelly_ $ withSystemTempDirectory "git-repo" $ \dir -> do
196− let repo = toTextIgnore $ dir </> ("repo" :: String)
197− run_ "git" ["clone", "https://github.com/haskell/process.git", repo]
198− origHash <- chdir (fromText repo) revParseHead
199−
200− run_ "ob" ["thunk", "pack", repo]
201− packedFiles <- Set.fromList <$> ls (fromText repo)
202− liftIO $ assertEqual "" packedFiles $ Set.fromList $ (repo </>) <$>
203− ["default.nix", "github.json", ".attr-cache" :: String]
204−
205− run_ "ob" ["thunk", "unpack", repo]
206− chdir (fromText repo) $ do
207− unpackHash <- revParseHead
208− assertRevEQ origHash unpackHash
209−
210− testThunkPack $ fromText repo
211−
212− it "aborts thunk pack when there are uncommitted files" $ inTmpObInit $ \dir -> do
213− void $ unpack
214− testThunkPack (dir </> thunk)
155+
156+ withSystemTempDirectory "obelisk-repo-git-remote" $ \copyDir -> do
157+ copyForGitRemote isVerbose obeliskImplDirtyReadOnly copyDir
158+ main' isVerbose httpManager copyDir
159+
160+main' :: Bool -> HTTP.Manager -> FilePath -> IO ()
161+main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache -> hspec $ parallel $ do
162+ let
163+ inTmpObInit' dirname f = inTmp' dirname $ \dir -> do
164+ run_ cpPath ["-rT", fromString initCache, toTextIgnore dir]
165+ f dir
166+ inTmpObInit = inTmpObInit' defaultTmpDirName
167+
168+ -- To be used in tests that change the obelisk impl directory
169+ inTmpObInitWithImplCopy f = inTmpObInit $ \dir ->
170+ withObeliskImplClean $ \(fromString -> implClean) -> do
171+ run_ rmPath [thunk]
172+ run_ lnPath ["-s", implClean, thunk]
173+ f dir
174+
175+ describe "ob init" $ parallel $ do
176+ it "works with default impl" $ inTmp $ \_ -> runOb ["init"]
177+ it "works with master branch impl" $ inTmp $ \_ -> runOb ["init", "--branch", "master"]
178+ it "works with symlink" $ inTmp $ \_ -> runOb ["init", "--symlink", toTextIgnore obeliskRepoReadOnly]
179+ it "doesn't silently overwrite existing files" $ inTmp $ \_ -> do
180+ let p force = errExit False $ do
181+ run_ ob $ "--no-handoff" : "-v" : "init" : ["--force"|force]
182+ (== 0) <$> lastExitCode
183+
184+ True <- p False
185+ False <- p False
186+ True <- p True
187+ pure ()
188+
189+ it "doesn't create anything when given an invalid impl" $ inTmp $ \tmp -> do
190+ void $ errExit False $ runOb ["init", "--symlink", "/dev/null"]
191+ ls tmp >>= liftIO . assertEqual "" []
192+
193+ it "produces a valid route config" $ inTmpObInit $ \tmp -> liftIO $
194+ withCurrentDirectory (T.unpack $ toTextIgnore tmp) $ do
195+ configs <- getConfigs
196+ return (either (const Nothing) Just $ getConfigRoute configs) `shouldNotReturn` Nothing
197+
198+ it "can unpack and repack .obelisk/impl after init with master branch impl" $ inTmp $ \_ -> do
199+ runOb_ ["init", "--branch", "master"]
200+ runOb_ ["thunk", "unpack", ".obelisk/impl"]
201+ runOb_ ["thunk", "pack", ".obelisk/impl"]
202+
203+ -- These tests fail with "Could not find module 'Obelisk.Generated.Static'"
204+ -- when not run by 'nix-build --attr selftest'
205+ describe "ob run" $ {- NOT parallel $ -} do
206+ it "works in root directory" $ inTmpObInit $ \_ -> testObRunInDir' Nothing httpManager
207+ it "works in sub directory" $ inTmpObInit $ \_ -> testObRunInDir' (Just "frontend") httpManager
208+
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
226+ it "can build obelisk command" $ inTmpObInit $ \_ -> nixBuild ["-A", "command" , toTextIgnore obeliskRepoReadOnly]
227+ it "can build obelisk skeleton" $ inTmpObInit $ \_ -> nixBuild ["-A", "skeleton", toTextIgnore obeliskRepoReadOnly]
228+ it "can build obelisk shell" $ inTmpObInit $ \_ -> nixBuild ["-A", "shell", toTextIgnore obeliskRepoReadOnly]
229+ it "can build everything" $ inTmpObInit $ \_ -> nixBuild [toTextIgnore obeliskRepoReadOnly]
230+
231+ describe "blank initialized project" $ parallel $ do
232+
233+ it "can build ghc.backend" $ inTmpObInit $ \_ -> nixBuild ["-A", "ghc.backend"]
234+ it "can build ghcjs.frontend" $ inTmpObInit $ \_ -> nixBuild ["-A", "ghcjs.frontend"]
235+
236+ if System.Info.os == "darwin"
237+ then it "can build ios" $ inTmpObInit $ \_ -> nixBuild ["-A", "ios.frontend"]
238+ else it "can build android after accepting license" $ inTmpObInit $ \dir -> do
239+ let defaultNixPath = dir </> ("default.nix" :: FilePath)
240+ writefile defaultNixPath
241+ =<< T.replace
242+ "# config.android_sdk.accept_license = false;"
243+ "config.android_sdk.accept_license = true;"
244+ <$> readfile defaultNixPath
245+ nixBuild ["-A", "android.frontend"]
246+
247+ forM_ ["ghc", "ghcjs"] $ \compiler -> do
248+ let
249+ shellName = "shells." <> compiler
250+ inShell cmd' = run_ "nix-shell" ["default.nix", "-A", fromString shellName, "--run", cmd']
251+ it ("can enter " <> shellName) $ inTmpObInit $ \_ -> inShell "exit"
252+ -- NOTE: We override the temporary directory name because cabal has a bug preventing new-build from working
253+ -- in a path that has unicode characters.
254+ it ("can build in " <> shellName) $ inTmpObInit' "test" $ \_ -> inShell $
255+ T.pack cabalPath <> " --version; " <> T.pack cabalPath <> " new-build --" <> T.pack compiler <> " all"
256+
257+ it "has idempotent thunk update" $ inTmpObInitWithImplCopy $ \_ -> do
258+ _ <- pack
259+ u <- update
260+ uu <- update
261+ assertRevEQ u uu
262+
263+ it "can run 'ob doc'" $ inTmpObInit $ \_ -> runOb_ ["doc", "reflex"]
264+
265+ describe "ob thunk pack/unpack" $ parallel $ do
266+ it "has thunk pack and unpack inverses" $ inTmpObInitWithImplCopy $ \_ -> do
267+
268+ _ <- pack
269+ e <- commitAll
270+ eu <- unpack
271+ eup <- pack
272+ eupu <- unpack
273+ _ <- pack
274+
275+ assertRevEQ e eup
276+ assertRevEQ eu eupu
277+ assertRevNE e eu
278+
279+ it "unpacks the correct branch" $ withTmp $ \dir -> do
280+ let branch = "master"
281+ run_ gitPath ["clone", "https://github.com/reflex-frp/reflex.git", toTextIgnore dir, "--branch", branch]
282+ runOb_ ["thunk", "pack", toTextIgnore dir]
283+ runOb_ ["thunk", "unpack", toTextIgnore dir]
284+ branch' <- run gitPath ["-C", toTextIgnore $ dir </> unpackedDirName, "rev-parse", "--abbrev-ref", "HEAD"]
285+ liftIO $ assertEqual "" branch (T.strip branch')
286+
287+ it "can pack and unpack plain git repos" $
288+ shelly_ $ withSystemTempDirectory "git-repo" $ \dir -> do
289+ let repo = toTextIgnore $ dir </> ("repo" :: FilePath)
290+ run_ gitPath ["clone", "https://github.com/haskell/process.git", repo]
291+ origHash <- chdir (fromText repo) revParseHead
292+
293+ runOb_ ["thunk", "pack", repo]
294+ packedFiles <- Set.fromList <$> ls (fromText repo)
295+ liftIO $ assertEqual "" packedFiles $ Set.fromList $ (repo </>) <$>
296+ ["default.nix", "thunk.nix", "github.json" :: FilePath]
297+
298+ runOb_ ["thunk", "unpack", repo]
299+ chdir (fromText repo </> unpackedDirName) $ do
300+ unpackHash <- revParseHead
301+ assertRevEQ origHash unpackHash
302+
303+ testThunkPack' $ fromText repo
304+
305+ it "aborts thunk pack when there are uncommitted files" $ inTmpObInitWithImplCopy $ \dir -> do
306+ testThunkPack' (dir </> thunk)
307+
308+ it "works on legacy git thunks" $ testLegacyGitThunks isVerbose
309+
310+ describe "ob thunk update --branch" $ parallel $ do
311+ it "can change a thunk to the latest version of a desired branch" $ withTmp $ \dir -> do
312+ let branch1 = "master"
313+ branch2 = "develop"
314+ run_ gitPath ["clone", "https://github.com/reflex-frp/reflex.git", toTextIgnore dir, "--branch", branch1]
315+ runOb_ ["thunk" , "pack", toTextIgnore dir]
316+ runOb_ ["thunk", "update", toTextIgnore dir, "--branch", branch2]
317+
318+ it "doesn't create anything when given an invalid branch" $ withTmp $ \dir -> do
319+ let checkDir dir' = liftIO $ getDirectoryContents $ T.unpack $ toTextIgnore dir'
320+ run_ gitPath ["clone", "https://github.com/reflex-frp/reflex.git", toTextIgnore dir, "--branch", "master"]
321+ runOb_ ["thunk" , "pack", toTextIgnore dir]
322+ startingContents <- checkDir dir
323+ void $ errExit False $ runOb ["thunk", "update", toTextIgnore dir, "--branch", "dumble-palooza"]
324+ checkDir dir >>= liftIO . assertEqual "" startingContents
325+
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
332+ it "starts a hoogle server on the given port" $ inTmpObInit $ \_ -> do
333+ [p0] <- liftIO $ getFreePorts 1
334+ maskExitSuccess $ runHandle "ob" ["hoogle", "--port", T.pack (show p0)] $ \stdout -> flip fix Nothing $ \loop -> \case
335+ Nothing -> do -- Still waiting for initial signal that the server has started
336+ ln <- liftIO $ T.hGetLine stdout
337+ let search = "Server starting on port " <> T.pack (show p0)
338+ case search `T.isInfixOf` ln of
339+ False -> loop Nothing -- keep waiting
340+ True -> loop $ Just 10
341+ Just (n :: Int) -> do -- Server has started and we have n attempts left
342+ let req uri = liftIO $ try @HTTP.HttpException $ HTTP.parseRequest uri >>= flip HTTP.httpLbs httpManager
343+ req ("http://127.0.0.1:" <> show p0) >>= \case
344+ Right r | HTTP.responseStatus r == HTTP.ok200 -> exit 0
345+ e -> if n <= 0
346+ then errorExit $ "Request to hoogle server failed: " <> T.pack (show e)
347+ else liftIO (threadDelay (1*10^(6 :: Int))) *> loop (Just $ n - 1)
348+ where
349+ verbosity = bool silently verbosely isVerbose
350+ nixBuild args = run nixBuildPath ("--no-out-link" : args)
351+
352+ runOb_ = augmentWithVerbosity run_ ob isVerbose
353+ runOb = augmentWithVerbosity run ob isVerbose
354+ testObRunInDir' = augmentWithVerbosity testObRunInDir ob isVerbose ["run"]
355+ testThunkPack' = augmentWithVerbosity testThunkPack ob isVerbose []
356+
357+ withObeliskImplClean f =
358+ withSystemTempDirectory "obelisk-impl-clean" $ \obeliskImpl -> do
359+ void . shellyOb verbosity $ do
360+ dirtyFiles <- T.strip <$> run gitPath ["-C", toTextIgnore obeliskRepoReadOnly, "diff", "--stat"]
361+ () <- when (dirtyFiles /= "") $ error "SelfTest does not work correctly with dirty obelisk repos as remote"
362+ run_ gitPath ["clone", "file://" <> toTextIgnore obeliskRepoReadOnly, toTextIgnore obeliskImpl]
363+ f obeliskImpl
364+
365+ withInitCache f =
366+ withSystemTempDirectory "init Cache λ" $ \initCache -> do
367+ -- Setup the ob init cache
368+ void . shellyOb verbosity $ chdir initCache $ do
369+ runOb_ ["init", "--symlink", toTextIgnore obeliskRepoReadOnly]
370+ run_ gitPath ["init"]
371+
372+ f initCache
373+
374+ shelly_ = void . shellyOb verbosity
375+
376+ defaultTmpDirName = "test λ"
377+
378+ inTmp' :: FilePath -> (FilePath -> Sh a) -> IO ()
379+ inTmp' dirname f = withTmp' dirname (chdir <*> f)
380+ inTmp = inTmp' defaultTmpDirName
381+
382+ withTmp' dirname f = shelly_ . withSystemTempDirectory dirname $ f . fromString
383+ withTmp = withTmp' defaultTmpDirName
384+
385+ assertRevEQ a b = liftIO . assertEqual "" "" =<< diff a b
386+ assertRevNE a b = liftIO . assertBool "" . (/= "") =<< diff a b
387+
388+ revParseHead = T.strip <$> run gitPath ["rev-parse", "HEAD"]
389+
390+ commitAll = do
391+ run_ gitPath ["add", "."]
392+ commit "checkpoint"
393+ revParseHead
394+
395+ thunk = ".obelisk/impl"
396+ update = runOb ["thunk", "update", thunk] *> commitAll
397+ pack = runOb ["thunk", "pack", thunk] *> commitAll
398+ unpack = runOb ["thunk", "unpack", thunk] *> commitAll
399+
400+ diff a b = run gitPath ["diff", a, b]
401+
402+
403+maskExitSuccess :: Sh () -> Sh ()
404+maskExitSuccess = handle_sh (\case ExitSuccess -> pure (); e -> throw e)
215405
216406-- | Run `ob run` in the given directory (maximum of one level deep)
217−testObRunInDir :: Socket.PortNumber -> Socket.PortNumber -> Maybe Shelly.FilePath -> HTTP.Manager -> Sh ()
218−testObRunInDir p0 p1 mdir httpManager = handle_sh (\case ExitSuccess -> pure (); e -> throw e) $ do
407+testObRunInDir :: String -> [Text] -> Maybe FilePath -> HTTP.Manager -> Sh ()
408+testObRunInDir executable extraArgs mdir httpManager = maskExitSuccess $ do
409+ [p0, p1] <- liftIO $ getFreePorts 2
219410 let uri p = "http://localhost:" <> T.pack (show p) <> "/" -- trailing slash required for comparison
220411 writefile "config/common/route" $ uri p0
221− maybe id chdir mdir $ runHandle "ob" ["run"] $ \stdout -> do
222− firstUri <- handleObRunStdout httpManager stdout
412+ maybe id chdir mdir $ runHandles executable extraArgs [] $ \_stdin stdout stderr -> do
413+ firstUri <- handleObRunStdout httpManager stdout stderr
223414 let newUri = uri p1
224415 when (firstUri == newUri) $ errorExit $
225416 "Startup URI (" <> firstUri <> ") is the same as test URI (" <> newUri <> ")"
226417 maybe id (\_ -> chdir "..") mdir $ alterRouteTo newUri stdout
227− runningUri <- handleObRunStdout httpManager stdout
418+ runningUri <- handleObRunStdout httpManager stdout stderr
228419 if runningUri /= newUri
229420 then errorExit $ "Reloading failed: expected " <> newUri <> " but got " <> runningUri
230421 else exit 0
231422
232−testThunkPack :: Shelly.FilePath -> Sh ()
233−testThunkPack path' = withTempFile (T.unpack $ toTextIgnore path') "test-file" $ \file handle -> do
234− let pack' = readProcessWithExitCode "ob" ["thunk", "pack", T.unpack $ toTextIgnore path'] ""
235− ensureThunkPackFails q = liftIO $ pack' >>= \case
236− (code, out, err)
237− | code == ExitSuccess -> fail "ob thunk pack succeeded when it should have failed"
238− | q `T.isInfixOf` T.pack (out <> err) -> pure ()
239− | otherwise -> fail $ "ob thunk pack failed for an unexpected reason: " <> show out <> "\nstderr: " <> err
240− git = chdir path' . run "git"
423+testThunkPack :: String -> [Text] -> FilePath -> Sh ()
424+testThunkPack executable args path' = withTempFile repoDir "test-file" $ \file handle -> do
425+ let
426+ pack' = readProcessWithExitCode executable (["thunk", "pack", path'] ++ map T.unpack args) ""
427+ ensureThunkPackFails q = liftIO $ pack' >>= \case
428+ (code, out, err)
429+ | code == ExitSuccess -> fail $ "ob thunk pack succeeded when it should have failed with error '" <> show q <> "'"
430+ | q `T.isInfixOf` T.pack (out <> err) -> pure ()
431+ | otherwise -> fail $ "ob thunk pack failed for an unexpected reason, expecting '" <> show q <> "', received: " <> show out <> "\nstderr: " <> err
432+ git = chdir repoDir . run_ gitPath
241433 -- Untracked files
242434 ensureThunkPackFails "Untracked files"
243− void $ git ["add", T.pack file]
435+ git ["add", T.pack file]
244436 -- Uncommitted files (staged)
245437 ensureThunkPackFails "unsaved"
246− chdir path' $ commit "test commit"
438+ chdir repoDir $ commit "test commit"
247439 -- Non-pushed commits in any branch
248440 ensureThunkPackFails "not yet pushed"
249441 -- Uncommitted files (unstaged)
250442 liftIO $ T.hPutStrLn handle "test file" >> hClose handle
251443 ensureThunkPackFails "modified"
252444 -- Existing stashes
253− void $ git ["stash"]
445+ git $ gitUserConfig <> [ "stash" ]
254446 ensureThunkPackFails "has stashes"
447+ where
448+ repoDir = path' </> unpackedDirName
255449
256450-- | Blocks until a non-empty line is available
257451hGetLineSkipBlanks :: MonadIO m => Handle -> m Text
@@ -271,9 +465,12 @@ alterRouteTo uri stdout = do
271465 "Reloading failed: " <> T.pack (show t)
272466
273467-- | Handle stdout of `ob run`: check that the frontend and backend servers are started correctly
274−handleObRunStdout :: HTTP.Manager -> Handle -> Sh Text
275−handleObRunStdout httpManager stdout = flip fix (ObRunState_Init, []) $ \loop (state, msgs) -> do
276− liftIO (T.hGetLine stdout) >>= \t -> case state of
468+handleObRunStdout :: HTTP.Manager -> Handle -> Handle -> Sh Text
469+handleObRunStdout httpManager stdout stderr = flip fix (ObRunState_Init, []) $ \loop (state, msgs) -> do
470+ isEOF <- liftIO $ hIsEOF stdout
471+ if isEOF
472+ then handleObRunError msgs
473+ else liftIO (T.hGetLine stdout) >>= \t -> case state of
277474 ObRunState_Init
278475 | "Running test..." `T.isPrefixOf` t -> loop (ObRunState_BackendStarted, msgs)
279476 ObRunState_Startup
@@ -285,8 +482,12 @@ handleObRunStdout httpManager stdout = flip fix (ObRunState_Init, []) $ \loop (s
285482 obRunCheck httpManager stdout uri
286483 pure uri
287484 | not (T.null t) -> errorExit $ "Started: " <> t -- If theres any other output here, startup failed
288− _ | "Failed" `T.isPrefixOf` t -> errorExit $ "ob run failed: " <> T.unlines (reverse $ t : msgs)
485+ _ | "Failed" `T.isPrefixOf` t -> handleObRunError (t : msgs)
289486 | otherwise -> loop (state, t : msgs)
487+ where
488+ handleObRunError msgs = do
489+ stderrContent <- liftIO $ hGetContents stderr
490+ errorExit $ "ob run failed: " <> T.unlines (reverse msgs) <> " stderr: " <> T.pack stderrContent
290491
291492-- | Make requests to frontend/backend servers to check they are working properly
292493obRunCheck :: HTTP.Manager -> Handle -> Text -> Sh ()
@@ -305,3 +506,121 @@ getFreePorts n = Socket.withSocketsDo $ do
305506 sock <- Socket.socket (Socket.addrFamily addr) (Socket.addrSocketType addr) (Socket.addrProtocol addr)
306507 Socket.bind sock (Socket.addrAddress addr)
307508 pure sock
509+
510+testLegacyGitThunks :: Bool -> IO ()
511+testLegacyGitThunks isVerbose = withSystemTempDirectory "test-git-repo" $ \gitDir -> do
512+ isolatedGitShell isVerbose gitDir $ \git -> do
513+ writefile (gitDir </> ("default.nix" :: FilePath)) "{}: \"hello\""
514+ _ <- git ["add", "--all"]
515+ _ <- git ["commit", "-m", "Initial commit"]
516+ rev <- T.strip <$> git ["rev-parse", "HEAD"]
517+ sha256 :: Text
518+ <- either error pure
519+ =<< (Aeson.parseEither (Aeson..: "sha256") <=< Aeson.eitherDecodeStrict . T.encodeUtf8)
520+ <$> run nixPrefetchGitPath [toTextIgnore gitDir]
521+
522+ for_ (legacyGitThunks (GitThunkParams gitDir rev sha256)) $ \mkFiles ->
523+ withSystemTempDirectory "test-thunks" $ \thunkDir -> do
524+ liftIO $ mkFiles thunkDir
525+ run_ "ob" ["thunk", "unpack", toTextIgnore thunkDir]
526+ run_ "ob" ["thunk", "pack", toTextIgnore thunkDir]
527+
528+data GitThunkParams = GitThunkParams
529+ { _gitThunkParams_repo :: !FilePath
530+ , _gitThunkParams_rev :: !Text
531+ , _gitThunkParams_sha256 :: !Text
532+ } deriving Show
533+
534+legacyGitThunks :: GitThunkParams -> [FilePath -> IO ()]
535+legacyGitThunks (GitThunkParams repo' rev sha256) =
536+ [ mkLegacyIO
537+ (T.unlines
538+ [ "# DO NOT HAND-EDIT THIS FILE"
539+ , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
540+ , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
541+ , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
542+ ]
543+ )
544+ (Map.fromList
545+ [ ("url", repo)
546+ , ("rev", rev)
547+ , ("branch", "master")
548+ , ("sha256", sha256)
549+ ]
550+ )
551+ , mkLegacyIO
552+ (T.unlines
553+ [ "# DO NOT HAND-EDIT THIS FILE"
554+ , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
555+ , " if builtins.hasAttr \"fetchGit\" builtins"
556+ , " then builtins.fetchGit ({ inherit url rev; } // (if branch == null then {} else { ref = branch; }))"
557+ , " else abort \"Plain Git repositories are only supported on nix 2.0 or higher.\";"
558+ , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
559+ ]
560+ )
561+ (Map.fromList
562+ [ ("url", repo)
563+ , ("rev", rev)
564+ , ("branch", "master")
565+ , ("sha256", sha256)
566+ ]
567+ )
568+ , mkLegacyIO
569+ (T.unlines
570+ [ "# DO NOT HAND-EDIT THIS FILE"
571+ , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
572+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
573+ , " if firstChar == \"/\" then /. + url"
574+ , " else if firstChar == \".\" then ./. + url"
575+ , " else url;"
576+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
577+ , " url = realUrl; inherit rev;"
578+ , " } else (import <nixpkgs> {}).fetchgit {"
579+ , " url = realUrl; inherit rev sha256;"
580+ , " };"
581+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
582+ ]
583+ )
584+ (Map.fromList
585+ [ ("url", Aeson.String repo)
586+ , ("rev", Aeson.String rev)
587+ , ("branch", Aeson.String "master")
588+ , ("sha256", Aeson.String sha256)
589+ , ("private", Aeson.Bool False)
590+ ]
591+ )
592+ , mkLegacyIO
593+ (T.unlines
594+ [ "# DO NOT HAND-EDIT THIS FILE"
595+ , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
596+ , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
597+ , " if firstChar == \"/\" then /. + url"
598+ , " else if firstChar == \".\" then ./. + url"
599+ , " else url;"
600+ , " in if !fetchSubmodules && private then builtins.fetchGit {"
601+ , " url = realUrl; inherit rev;"
602+ , " ${if branch == null then null else \"ref\"} = branch;"
603+ , " } else (import <nixpkgs> {}).fetchgit {"
604+ , " url = realUrl; inherit rev sha256;"
605+ , " };"
606+ , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
607+ ]
608+ )
609+ (Map.fromList
610+ [ ("url", Aeson.String repo)
611+ , ("rev", Aeson.String rev)
612+ , ("branch", Aeson.String "master")
613+ , ("sha256", Aeson.String sha256)
614+ , ("private", Aeson.Bool False)
615+ ]
616+ )
617+ ]
618+ where
619+ repo = T.pack repo'
620+ mkLegacyIO :: Aeson.ToJSON v => Text -> Map.Map Text v -> FilePath -> IO ()
621+ mkLegacyIO defaultNix gitJson dir = do
622+ T.writeFile (dir </> ("default.nix" :: FilePath)) defaultNix
623+ LBS.writeFile (dir </> ("git.json" :: FilePath)) (Aeson.encode gitJson)
624+
625+unpackedDirName :: FilePath
626+unpackedDirName = "."
lib/snap-extras/obelisk-snap-extras.cabal+2−3
@@ -1,6 +1,6 @@
11name: obelisk-snap-extras
22version: 0.1
3−synopsys: Extra functionality for Snap that should be considered for upstreaming
3+synopsis: Extra functionality for Snap that should be considered for upstreaming
44license: BSD3
55build-type: Simple
66cabal-version: >=1.2
@@ -12,10 +12,9 @@ library
1212 , base
1313 , bytestring
1414 , snap-core
15− , unix
1615 , directory
1716 , filepath
1817 , text
1918 exposed-modules:
2019 Obelisk.Snap.Extras
21− ghc-options: -Wall
20+ ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
lib/snap-extras/src/Obelisk/Snap/Extras.hs+2−2
@@ -2,13 +2,13 @@
22module Obelisk.Snap.Extras
33 ( cachePermanently
44 , doNotCache
5+ , ensureSecure
56 , serveFileIfExists
67 , serveFileIfExistsAs
78 ) where
89
910import Control.Monad.IO.Class
1011import Data.ByteString (ByteString)
11−import Data.Monoid
1212import Data.String
1313import Snap.Core
1414import Snap.Util.FileServe
@@ -17,7 +17,7 @@ import System.Directory
1717-- | Set response header for "permanent" caching
1818cachePermanently :: MonadSnap m => m ()
1919cachePermanently = do
20− modifyResponse $ setHeader "Cache-Control" "public, max-age=315360000"
20+ modifyResponse $ setHeader "Cache-Control" "public, max-age=315360000, immutable"
2121 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"
2222
2323-- | Set response header to not cache
lib/tabulation/CHANGELOG.mdnew file+5
@@ -0,0 +1,5 @@
1+# Revision history for tabulation
2+
3+## 0.1.0.0 -- 2019-05-24
4+
5+* First version. Basically carve out this library as a place for the HasFields class.
lib/tabulation/LICENSEnew file+30
@@ -0,0 +1,30 @@
1+Copyright (c) 2019, Cale Gibbard
2+
3+All rights reserved.
4+
5+Redistribution and use in source and binary forms, with or without
6+modification, are permitted provided that the following conditions are met:
7+
8+ * Redistributions of source code must retain the above copyright
9+ notice, this list of conditions and the following disclaimer.
10+
11+ * Redistributions in binary form must reproduce the above
12+ copyright notice, this list of conditions and the following
13+ disclaimer in the documentation and/or other materials provided
14+ with the distribution.
15+
16+ * Neither the name of Cale Gibbard nor the names of other
17+ contributors may be used to endorse or promote products derived
18+ from this software without specific prior written permission.
19+
20+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
lib/tabulation/Setup.hsnew file+2
@@ -0,0 +1,2 @@
1+import Distribution.Simple
2+main = defaultMain
lib/tabulation/src/Data/Tabulation.hsnew file+21
@@ -0,0 +1,21 @@
1+{-# LANGUAGE TypeFamilies #-}
2+{-# LANGUAGE RankNTypes #-}
3+
4+module Data.Tabulation where
5+
6+import Control.Lens
7+
8+-- | This is a class for record types whose fields can be enumerated by an associated GADT. It's closely related to the concept of a representable functor, except without the functor part, and the fields are not all the same type.
9+class HasFields a where
10+ type Field a :: * -> *
11+
12+ fieldLens :: Field a x -> Lens' a x
13+ tabulateFieldsA :: Applicative f => (forall x. Field a x -> f x) -> f a
14+
15+ tabulateFields :: (forall x. Field a x -> x) -> a
16+ tabulateFields f = runIdentity (tabulateFieldsA (Identity . f))
17+ traverseWithField :: Applicative m => (forall x. Field a x -> x -> m x) -> a -> m a
18+ traverseWithField t r = tabulateFieldsA (\f -> t f (indexField r f))
19+ indexField :: a -> Field a x -> x
20+ indexField a f = a ^. fieldLens f
21+ {-# MINIMAL fieldLens, tabulateFieldsA #-}
lib/tabulation/tabulation.cabalnew file+26
@@ -0,0 +1,26 @@
1+cabal-version: >=1.10
2+-- Initial package description 'tabulation.cabal' generated by 'cabal
3+-- init'. For further documentation, see
4+-- http://haskell.org/cabal/users-guide/
5+
6+name: tabulation
7+version: 0.1.0.0
8+synopsis: A library for types that can be completely reconstructed by fields as specified by a GADT.
9+-- description:
10+-- bug-reports:
11+license: BSD3
12+license-file: LICENSE
13+author: Cale Gibbard
14+maintainer: cale.gibbard@obsidian.systems
15+-- copyright:
16+category: Data
17+build-type: Simple
18+extra-source-files: CHANGELOG.md
19+
20+library
21+ exposed-modules: Data.Tabulation
22+ -- other-modules:
23+ -- other-extensions:
24+ build-depends: base, lens
25+ hs-source-dirs: src
26+ default-language: Haskell2010
nixpkgs-overlays/default.nixnew file+15
@@ -0,0 +1,15 @@
1+self: super:
2+
3+let
4+ inherit (self) lib;
5+ inherit (import ../dep/gitignore.nix { inherit lib; }) gitignoreSource;
6+in {
7+ obeliskCleanSource = src:
8+ # WARNING: The order of application here seems to matter a great deal to
9+ # how quickly `ghcid` is able to reload changes. As a rule of thumb,
10+ # always apply `gitignoreSource` first.
11+ # See https://github.com/obsidiansystems/obelisk/pull/666 and related.
12+ lib.cleanSource (gitignoreSource src);
13+
14+ obeliskExecutableConfig = self.callPackage ../lib/executable-config {};
15+}
release.nix+8−78
@@ -1,80 +1,10 @@
1−{ local-self ? import ./. {}
1+{
2+ supportedSystems ? [ "x86_64-linux" "x86_64-darwin" ]
23}:
4+rec {
5+ recurseForDerivations = true;
6+ build = import ./all-builds.nix { inherit supportedSystems; };
7+ test = import ./all-tests.nix { inherit supportedSystems; };
38
4−let
5− inherit (local-self.nixpkgs) lib runCommand nix;
6−
7− cacheBuildSystems = [ "x86_64-linux" "x86_64-darwin" ];
8−
9− obeliskPackagesCommon = [
10− "obelisk-frontend"
11− "obelisk-route"
12− "obelisk-executable-config"
13− ];
14−
15− obeliskPackagesBackend = obeliskPackagesCommon ++ [
16− "obelisk-asset-manifest"
17− "obelisk-asset-serve-snap"
18− "obelisk-backend"
19− "obelisk-cliapp"
20− "obelisk-command"
21− "obelisk-executable-config-inject"
22− "obelisk-frontend"
23− "obelisk-run"
24− "obelisk-route"
25− "obelisk-selftest"
26− "obelisk-snap-extras"
27− ];
28−
29− pnameToAttrs = pkgsSet: pnames:
30− lib.listToAttrs (map
31− (name: { inherit name; value = pkgsSet.${name}; })
32− pnames);
33−
34− concatDepends = let
35− extractDeps = x: (x.override {
36− mkDerivation = drv: {
37− out = builtins.concatLists [
38− (drv.buildDepends or [])
39− (drv.libraryHaskellDepends or [])
40− (drv.executableHaskellDepends or [])
41− ];
42− };
43− }).out;
44− in pkgAttrs: builtins.concatLists (map extractDeps (builtins.attrValues pkgAttrs));
45−
46− perPlatform = lib.genAttrs cacheBuildSystems (system: let
47− obelisk = import ./. { inherit system; };
48− reflex-platform = obelisk.reflex-platform;
49− ghc = pnameToAttrs
50− obelisk.haskellPackageSets.ghc
51− obeliskPackagesBackend;
52− ghcjs = pnameToAttrs
53− obelisk.haskellPackageSets.ghcjs
54− obeliskPackagesCommon;
55− cachePackages = builtins.concatLists [
56− (builtins.attrValues ghc)
57− (builtins.attrValues ghcjs)
58− (concatDepends ghc)
59− (concatDepends ghcjs)
60− ];
61− command = local-self.command;
62− serverExeSkeleton = (import ./skeleton {}).exe;
63− builtSkeleton = (import ./skeleton {}).all;
64− in {
65− inherit
66− command
67− ghc ghcjs
68− serverExeSkeleton builtSkeleton;
69− cache = reflex-platform.pinBuildInputs
70− "obelisk-${system}"
71− cachePackages
72− [command serverExeSkeleton builtSkeleton];
73− });
74−
75− metaCache = local-self.pinBuildInputs
76− "obelisk-everywhere"
77− (map (a: a.cache) (builtins.attrValues perPlatform))
78− [];
79−
80−in perPlatform // { inherit metaCache; }
9+ inherit (build) metaCache;
10+}
scripts/ghcid-this-libdeleted−4
@@ -1,4 +0,0 @@
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 "cabal configure ; ghcid -c'cabal repl'"
skeleton/.gitignore+13−5
@@ -1,7 +1,15 @@
1−dist-newstyle
2−result
3−result-android
4−result-ios
5−result-exe
61.attr-cache
2+.cabal-sandbox
3+*.hi
4+*.o
5+cabal.project.local
6+cabal.sandbox.config
7+ctags
8+dist-newstyle/
9+dist/
710ghcid-output.txt
11+profile/
12+result
13+result-*
14+tags
15+TAGS
skeleton/backend/backend.cabal+2−1
@@ -14,11 +14,12 @@ library
1414 , obelisk-route
1515 exposed-modules:
1616 Backend
17− ghc-options: -Wall
17+ ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits
1818
1919executable backend
2020 main-is: main.hs
2121 hs-source-dirs: src-bin
22+ ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -threaded -fno-show-valid-hole-fits
2223 if impl(ghcjs)
2324 buildable: False
2425 build-depends: base
skeleton/backend/src/Backend.hs+1−6
@@ -1,8 +1,3 @@
1−{-# LANGUAGE EmptyCase #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE LambdaCase #-}
4−{-# LANGUAGE RankNTypes #-}
5−{-# LANGUAGE TypeFamilies #-}
61module Backend where
72
83import Common.Route
@@ -11,5 +6,5 @@ import Obelisk.Backend
116backend :: Backend BackendRoute FrontendRoute
127backend = Backend
138 { _backend_run = \serve -> serve $ const $ return ()
14− , _backend_routeEncoder = backendRouteEncoder
9+ , _backend_routeEncoder = fullRouteEncoder
1510 }
skeleton/cabal.project+1
@@ -1,2 +1,3 @@
11optional-packages:
22 *
3+write-ghc-environment-files: never
skeleton/common/common.cabal+1−1
@@ -9,7 +9,7 @@ library
99 , obelisk-route
1010 , mtl
1111 , text
12−
1312 exposed-modules:
1413 Common.Api
1514 Common.Route
15+ ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits
skeleton/common/src/Common/Api.hs+1−1
@@ -1,4 +1,4 @@
11module Common.Api where
22
33commonStuff :: String
4−commonStuff = "Here is a string defined in code common to the frontend and backend."
4+commonStuff = "Here is a string defined in Common.Api"
skeleton/common/src/Common/Route.hs+13−18
@@ -1,15 +1,14 @@
11{-# LANGUAGE EmptyCase #-}
22{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE FlexibleInstances #-}
34{-# LANGUAGE GADTs #-}
4−{-# LANGUAGE LambdaCase #-}
5−{-# LANGUAGE RankNTypes #-}
6−{-# LANGUAGE TemplateHaskell #-}
75{-# LANGUAGE KindSignatures #-}
8−{-# LANGUAGE EmptyCase #-}
6+{-# LANGUAGE LambdaCase #-}
97{-# LANGUAGE MultiParamTypeClasses #-}
10−{-# LANGUAGE FlexibleInstances #-}
118{-# LANGUAGE OverloadedStrings #-}
12−
9+{-# LANGUAGE RankNTypes #-}
10+{-# LANGUAGE TemplateHaskell #-}
11+{-# LANGUAGE TypeFamilies #-}
1312module Common.Route where
1413
1514{- -- You will probably want these imports for composing Encoders.
@@ -19,7 +18,6 @@ import Control.Category
1918
2019import Data.Text (Text)
2120import Data.Functor.Identity
22−import Data.Functor.Sum
2321
2422import Obelisk.Route
2523import Obelisk.Route.TH
@@ -34,17 +32,14 @@ data FrontendRoute :: * -> * where
3432 FrontendRoute_Main :: FrontendRoute ()
3533 -- This type is used to define frontend routes, i.e. ones for which the backend will serve the frontend.
3634
37−backendRouteEncoder
38− :: Encoder (Either Text) Identity (R (Sum BackendRoute (ObeliskRoute FrontendRoute))) PageName
39−backendRouteEncoder = handleEncoder (const (InL BackendRoute_Missing :/ ())) $
40− pathComponentEncoder $ \case
41− InL backendRoute -> case backendRoute of
42− BackendRoute_Missing -> PathSegment "missing" $ unitEncoder mempty
43− InR obeliskRoute -> obeliskRouteSegment obeliskRoute $ \case
44− -- The encoder given to PathEnd determines how to parse query parameters,
45− -- in this example, we have none, so we insist on it.
46− FrontendRoute_Main -> PathEnd $ unitEncoder mempty
47−
35+fullRouteEncoder
36+ :: Encoder (Either Text) Identity (R (FullRoute BackendRoute FrontendRoute)) PageName
37+fullRouteEncoder = mkFullRouteEncoder
38+ (FullRoute_Backend BackendRoute_Missing :/ ())
39+ (\case
40+ BackendRoute_Missing -> PathSegment "missing" $ unitEncoder mempty)
41+ (\case
42+ FrontendRoute_Main -> PathEnd $ unitEncoder mempty)
4843
4944concat <$> mapM deriveRouteComponent
5045 [ ''BackendRoute
skeleton/config/common/examplenew file+1
@@ -0,0 +1 @@
1+This string comes from config/common/example
skeleton/default.nix+16−3
@@ -1,7 +1,20 @@
1−{ system ? builtins.currentSystem # TODO: Get rid of this system cruft
2−, iosSdkVersion ? "10.2"
1+{ system ? builtins.currentSystem
2+, obelisk ? import ./.obelisk/impl {
3+ inherit system;
4+ iosSdkVersion = "13.2";
5+
6+ # You must accept the Android Software Development Kit License Agreement at
7+ # https://developer.android.com/studio/terms in order to build Android apps.
8+ # Uncomment and set this to `true` to indicate your acceptance:
9+ # 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+ }
316}:
4−with import ./.obelisk/impl { inherit system iosSdkVersion; };
17+with obelisk;
518project ./. ({ ... }: {
619 android.applicationId = "systems.obsidian.obelisk.examples.minimal";
720 android.displayName = "Obelisk Minimal Example";
skeleton/frontend/frontend.cabal+8−4
@@ -9,12 +9,14 @@ library
99 , common
1010 , obelisk-frontend
1111 , obelisk-route
12+ , jsaddle
1213 , reflex-dom
14+ , obelisk-executable-config-lookup
1315 , obelisk-generated-static
1416 , text
1517 exposed-modules:
1618 Frontend
17− ghc-options: -Wall
19+ ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits
1820
1921executable frontend
2022 main-is: main.hs
@@ -26,7 +28,9 @@ executable frontend
2628 , reflex-dom
2729 , obelisk-generated-static
2830 , frontend
29− --TODO: Make these ghc-options optional
30− ghc-options: -threaded
31+ ghc-options: -threaded -O -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -fno-show-valid-hole-fits
32+ if impl(ghcjs)
33+ ghc-options: -dedupe
34+ cpp-options: -DGHCJS_BROWSER
3135 if os(darwin)
32− ghc-options: -dynamic
36+ ghc-options: -dynamic
skeleton/frontend/src-bin/main.hs+1−1
@@ -6,5 +6,5 @@ import Reflex.Dom
66
77main :: IO ()
88main = do
9− let Right validFullEncoder = checkEncoder backendRouteEncoder
9+ let Right validFullEncoder = checkEncoder fullRouteEncoder
1010 run $ runFrontend validFullEncoder frontend
skeleton/frontend/src/Frontend.hs+28−3
@@ -1,23 +1,48 @@
11{-# LANGUAGE DataKinds #-}
22{-# LANGUAGE OverloadedStrings #-}
33{-# LANGUAGE TypeApplications #-}
4+
45module Frontend where
56
7+import Control.Monad
68import qualified Data.Text as T
9+import qualified Data.Text.Encoding as T
10+import Language.Javascript.JSaddle (eval, liftJSM)
11+
712import Obelisk.Frontend
13+import Obelisk.Configs
814import Obelisk.Route
15+import Obelisk.Generated.Static
16+
917import Reflex.Dom.Core
1018
1119import Common.Api
1220import Common.Route
13−import Obelisk.Generated.Static
1421
1522
23+-- This runs in a monad that can be run on the client or the server.
24+-- To run code in a pure client or pure server context, use one of the
25+-- `prerender` functions.
1626frontend :: Frontend (R FrontendRoute)
1727frontend = Frontend
18− { _frontend_head = el "title" $ text "Obelisk Minimal Example"
28+ { _frontend_head = do
29+ el "title" $ text "Obelisk Minimal Example"
30+ elAttr "link" ("href" =: static @"main.css" <> "type" =: "text/css" <> "rel" =: "stylesheet") blank
1931 , _frontend_body = do
20− text "Welcome to Obelisk!"
32+ el "h1" $ text "Welcome to Obelisk!"
2133 el "p" $ text $ T.pack commonStuff
34+
35+ -- `prerender` and `prerender_` let you choose a widget to run on the server
36+ -- during prerendering and a different widget to run on the client with
37+ -- JavaScript. The following will generate a `blank` widget on the server and
38+ -- print "Hello, World!" on the client.
39+ prerender_ blank $ liftJSM $ void $ eval ("console.log('Hello, World!')" :: T.Text)
40+
2241 elAttr "img" ("src" =: static @"obelisk.jpg") blank
42+ el "div" $ do
43+ exampleConfig <- getConfig "common/example"
44+ case exampleConfig of
45+ Nothing -> text "No config file found in config/common/example"
46+ Just s -> text $ T.decodeUtf8 s
47+ return ()
2348 }
skeleton/static/main.cssnew file+3
@@ -0,0 +1,3 @@
1+p {
2+ color: red;
3+}