on 67addbb help sign in
127 files changed+2475−6877
since splitsnapshots
unifiedsplit
.github/pull_request_template.md−10 .gitignore+3−2 .hlint.yaml−65 CONTRIBUTING.md+3−125 ChangeLog.md−156 FAQ.md+3−105 LICENSE−30 README.md+61−120 acme.nix−430 all-builds.nix−113 all-tests.nix−145 default.nix+212−239 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+6−1 dep/reflex-platform/github.json+3−4 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+20−17 lib/asset/assets.nix+5−28 lib/asset/manifest/obelisk-asset-manifest.cabal+2−5 lib/asset/manifest/src/Obelisk/Asset/Gather.hs+2−5 lib/asset/manifest/src/Obelisk/Asset/Symlink.hs+1−1 lib/asset/serve-snap/obelisk-asset-serve-snap.cabal+2−4 lib/asset/serve-snap/src/Obelisk/Asset/Accept.hs+6−6 lib/asset/serve-snap/src/Obelisk/Asset/Serve/Snap.hs+11−22 lib/backend/obelisk-backend.cabal+2−5 lib/backend/src/Obelisk/Backend.hs+58−181 lib/cliapp/obelisk-cliapp.cabal+3−7 lib/cliapp/src/Obelisk/CliApp.hs+6−18 lib/cliapp/src/Obelisk/CliApp/Demo.hs+52 lib/cliapp/src/Obelisk/CliApp/Logging.hs+12−37 lib/cliapp/src/Obelisk/CliApp/Process.hs+55−143 lib/cliapp/src/Obelisk/CliApp/Spinner.hs+24−18 lib/cliapp/src/Obelisk/CliApp/Theme.hs−29 lib/cliapp/src/Obelisk/CliApp/Types.hs+3−10 lib/command/obelisk-command.cabal+14−17 lib/command/src/Obelisk/App.hs+2−5 lib/command/src/Obelisk/Command.hs+140−222 lib/command/src/Obelisk/Command/Deploy.hs+106−129 lib/command/src/Obelisk/Command/Nix.hs+27−67 lib/command/src/Obelisk/Command/Preprocessor.hs−100 lib/command/src/Obelisk/Command/Project.hs+66−202 lib/command/src/Obelisk/Command/Run.hs+148−497 lib/command/src/Obelisk/Command/Thunk.hs+363−614 lib/command/src/Obelisk/Command/Upgrade/Hash.hs+114 lib/command/src/Obelisk/Command/Utils.hs+20−92 lib/command/src/Obelisk/Command/VmBuilder.hs+10−11 lib/executable-config/default.nix+17−38 lib/executable-config/inject/obelisk-executable-config-inject.cabal+3−3 lib/executable-config/inject/src/Obelisk/ExecutableConfig/Inject.hs+40−14 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+2−9 lib/frontend/src/Obelisk/Frontend.hs+96−182 lib/frontend/src/Obelisk/Frontend/Cookie.hs−103 lib/route/README.md−6 lib/route/obelisk-route.cabal+3−9 lib/route/src/Obelisk/Route.hs+70−471 lib/route/src/Obelisk/Route/Frontend.hs+77−265 lib/route/src/Obelisk/Route/TH.hs+5−4 lib/run/obelisk-run.cabal+4−12 lib/run/src/Obelisk/Run.hs+59−120 lib/selftest/obelisk-selftest.cabal+3−7 lib/selftest/src/Obelisk/SelfTest.hs+196−498 lib/snap-extras/obelisk-snap-extras.cabal+3−2 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+78−8 scripts/ghcid-this-lib+4 skeleton/.gitignore+5−13 skeleton/backend/backend.cabal+1−2 skeleton/backend/src/Backend.hs+6−1 skeleton/cabal.project−1 skeleton/common/common.cabal+1−1 skeleton/common/src/Common/Api.hs+1−1 skeleton/common/src/Common/Route.hs+18−13 skeleton/config/common/example−1 skeleton/default.nix+5−17 skeleton/frontend/frontend.cabal+4−8 skeleton/frontend/src-bin/main.hs+1−1 skeleton/frontend/src/Frontend.hs+3−28 skeleton/static/main.css−3
.github/pull_request_template.mddeleted−10
@@ -1,10 +0,0 @@
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+3−2
@@ -2,13 +2,14 @@
22**/.cabal-sandbox
33**/cabal.sandbox.config
44result
5−result-*
65*.o
76*.hi
7+
88TAGS
99tags
1010ctags
1111dist-newstyle
1212cabal.project.local
1313.ghc.environment.*
14−**/ghcid-output.txt
14+
15+**/ghcid-output.txt
.hlint.yamldeleted−65
@@ -1,65 +0,0 @@
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+3−125
@@ -1,131 +1,9 @@
1−# Contribution Guide
1+## Contributing to Obelisk
22
3−Contributions and issue reports are encouraged and appreciated!
3+Thanks for taking the time to contribute!
44
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)
5+Before submitting a pull request, please run the tests:
126
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:
557```bash
568$(nix-build -A selftest --no-out-link)
579```
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.mddeleted−156
@@ -1,156 +0,0 @@
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.md+3−105
@@ -1,70 +1,11 @@
11# Frequently Asked Questions
22
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−
3+1. [How do I fix invalid entitlements? ](#how-do-i-fix-invalid-entitlements)
644
655### How do I fix invalid entitlements?
666
67−You probably did not set `ios.bundleIdentifier` correctly in `default.nix`. When this happens you'll see an error something like this:
7+You probably did not set `ios.bundleIdentifier` correctly in `default.nix`.
8+When this happens you'll see an error something like this:
689
6910```
70112018-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)
@@ -72,46 +13,3 @@ You probably did not set `ios.bundleIdentifier` correctly in `default.nix`. When
7213
7314Fixing the value of `ios.bundleIdentifier` should fix the error.
7415
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`
LICENSEdeleted−30
@@ -1,30 +0,0 @@
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+61−120
@@ -1,75 +1,60 @@
11# Obelisk
22
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)
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.
54
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)
125- [Installing Obelisk](#installing-obelisk)
136- [Developing an Obelisk project](#developing-an-obelisk-project)
14− - [IDE Support](#ide-support)
157- [Deploying](#deploying)
16− - [Default EC2 Deployment](#default-ec2-deployment)
17− - [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)
18− - [VirtualBox Deployment](#virtualbox-deployment)
198 - [Locally](#locally)
9+ - [EC2](#ec2)
2010 - [From macOS](#from-macos)
2111 - [Deploying an updated version](#deploying-an-updated-version)
2212- [Mobile](#mobile)
2313 - [iOS](#ios)
2414 - [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−
3815
3916## Installing Obelisk
40−
41171. [Install Nix](https://nixos.org/nix/).
4218 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
43191. Set up nix caches
4420 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
45− ```nix
46− nix.binaryCaches = [ "https://nixcache.reflex-frp.org" ];
21+ ```
22+ nix.binaryCaches = [ "https://cache.nixos.org/" "https://nixcache.reflex-frp.org" ];
4723 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
4824 ```
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
25+ 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)):
26+ ```
27+ substituters = https://cache.nixos.org https://nixcache.reflex-frp.org
28+ trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
5529 ```
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
30+ * other Linux: enable sandboxing (see these [issue172](https://github.com/obsidiansystems/obelisk/issues/172#issuecomment-411507818) or [issue6](https://github.com/obsidiansystems/obelisk/issues/6) if you run into build problems)
31+ ```
5832 sandbox = true
5933 ```
60− * If you're on MacOS, disable sandboxing (there are still some impure dependencies for now) by adding the following:
61− ```nix
34+ * MacOS: disable sandboxing (there are still some impure dependencies for now)
35+ ```
6236 sandbox = false
6337 ```
6438 then restart the nix daemon
65− ```bash
39+ ```
6640 sudo launchctl stop org.nixos.nix-daemon
6741 sudo launchctl start org.nixos.nix-daemon
6842 ```
69−1. Install obelisk:
70− ```bash
71− nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command
72− ```
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 obeliskEnvs.obelisk-backend --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 obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"
57+```
7358
7459### Accessing private repositories
7560
@@ -84,44 +69,54 @@ access to:
8469
8570To create a new Obelisk project, go to an empty directory and run:
8671
87−```bash
72+```
8873ob init
8974```
9075
9176Obelisk 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:
9277
93−```bash
78+```
9479ob run
9580```
9681
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.
82+Now go to http://localhost:8000 (or the port specified in `config/common/route`) to access your app.
9983
10084Every 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.
10185
102−### IDE Support
86+## Deploying
10387
104−Obelisk officially supports terminal-based feedback (akin to [`ghcid`](https://github.com/ndmitchell/ghcid)) in `ob run` and `ob watch`.
88+### Locally
10589
106−## Deploying
90+Build everything:
91+
92+```
93+nix-build -A exe -o result-exe
94+```
95+
96+Run the server:
97+
98+```
99+cd result-exe
100+./backend
101+```
107102
108−### Default EC2 Deployment
103+### EC2
109104
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)).
105+In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance.
111106
112107First create a new EC2 instance:
113108
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))
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))
1151101. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1161111. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
117−1. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and HTTPS port 443.
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.
118113
119114At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
120115
121116Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
122117Your 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.
123118
124−```bash
119+```
125120cd ~/code/myapp
126121SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
127122ROUTE=https://myapp.com # Publicly accessible route to your app
@@ -134,13 +129,11 @@ ob deploy init \
134129 ~/code/myapp-deploy
135130```
136131
137−HTTPS is enabled by default; to disable HTTPS pass `--disable-https` to the `ob deploy init` command above.
138−
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.
132+NOTE: HTTPS is enabled by default; to disable https, pass `--disable-https` to the `ob deploy init` command above.
140133
141−Next, go to the deployment directory that you just initialized and deploy!
134+Then go to that created deployment configuration directory, and initiate the deployment:
142135
143−```bash
136+```
144137cd ~/code/myapp-deploy
145138ob deploy push
146139```
@@ -149,45 +142,6 @@ ob deploy push
149142
150143At 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`.
151144
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−
191145### From macOS
192146
193147Deploying from macOS requires some extra setup:
@@ -201,7 +155,7 @@ Running `ob deploy push` will give you additional setup instructions.
201155
202156If 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:
203157
204−```bash
158+```
205159cd ~/code/myapp-deploy
206160ob deploy update
207161ob deploy push
@@ -221,20 +175,20 @@ Your account must also belong to an Apple Developer Team, if you want to access
2211751. Click accept to authorize on both the computer and the iPhone.
222176
223177##### Xcode
224−Install Xcode 11.2 (contains iOS SDK 13.2) and open it so that it runs its post install tool setup.
178+Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
225179
226180These 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`
227181
228182More recent Xcodes should also work, as long as one of the SDKs mentioned above has been used.
229183To 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.
230−```bash
184+```
231185open -W Xcode_9.2.xip
232186sudo 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
233187```
234188
235189
236190You can verify that you have correct versions by running
237−```bash
191+```
238192xcodebuild -showsdks
239193```
240194
@@ -260,7 +214,7 @@ Ensure that `bundleIdentifier` matches the App ID of the development profile, or
2602141. Connect the registered iPhone.
2612151. Find your Apple Team ID in the [developer portal](https://developer.apple.com/account/#/membership).
2622161. Run the deploy command with your Team ID:
263−```bash
217+```
264218result-ios/bin/deploy [TEAM_ID]
265219# or in debug mode via lldb:
266220result-ios/bin/deploy [TEAM_ID] -d
@@ -270,7 +224,7 @@ result-ios/bin/deploy [TEAM_ID] -d
2702241. Go to [developer portal - distribution profiles](https://developer.apple.com/account/ios/profile/production).
271225Create and download a distribution profile.
2722261. Run the package script with your TEAM ID and your distribution profile to create a `.ipa`:
273−```bash
227+```
274228result-ios/bin/package [TEAM_ID] /path/to/output/.ipa /path/to/profile/file
275229```
276230
@@ -283,10 +237,7 @@ It's also possible to inspect iOS WkWebView apps once they are installed in the
283237
284238### Android
285239
286−NOTE: Currently Android builds are only supported on Linux.
287−
2882401. 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.
2902411. Run `nix-build -A android.frontend -o result-android` to build the Android app.
2912421. A debug version of the app should be generated at `result-android/android-app-debug.apk`
292243
@@ -303,9 +254,9 @@ This command will accomplish the following:
3032541. Build a Signed Android apk for your application
3042551. Deploy the Signed apk to your connected Android device
305256
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`.
257+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`
307258
308−Additional documentation on Java key stores can be found [here](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html).
259+Additional documentation on java key stores can be found [here] (https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html)
309260
310261This 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`.
311262
@@ -314,13 +265,3 @@ This should copy over and install the application on your device (if you see a
314265##### Build a release version
315266
316267After having configured signing for your app, you may proceed to build a release version of the app. This is no different to how you build the non-release version, so consult the section [Android](#android) further above for exact instructions on building and deploying to your device.
317−
318−
319−## Frequently Asked Questions (FAQ)
320−
321−Refer to [FAQ](FAQ.md).
322−
323−
324−## Contributing
325−
326−Contributions and issue reports are encouraged and appreciated! Refer to the [Contributing](CONTRIBUTING.md) guide for information about getting started.
acme.nixdeleted−430
@@ -1,430 +0,0 @@
1−# Copied from https://github.com/NixOS/nixpkgs-channels/blob/70717a337f7ae4e486ba71a500367cad697e5f09/nixos/modules/security/acme.nix # MODIFIED
2−# Lines marked '# MODIFIED' have been added or modified from the original. # MODIFIED
3−{ config, lib, pkgs, ... }:
4−with lib;
5−let
6−
7− cfg = config.security.acme;
8−
9− certOpts = { name, ... }: {
10− options = {
11− webroot = mkOption {
12− type = types.nullOr types.str;
13− default = null;
14− example = "/var/lib/acme/acme-challenges";
15− description = ''
16− Where the webroot of the HTTP vhost is located.
17− <filename>.well-known/acme-challenge/</filename> directory
18− will be created below the webroot if it doesn't exist.
19− <literal>http://example.org/.well-known/acme-challenge/</literal> must also
20− be available (notice unencrypted HTTP).
21− '';
22− };
23−
24− server = mkOption {
25− type = types.nullOr types.str;
26− default = null;
27− description = ''
28− ACME Directory Resource URI. Defaults to let's encrypt
29− production endpoint,
30− https://acme-v02.api.letsencrypt.org/directory, if unset.
31− '';
32− };
33−
34− domain = mkOption {
35− type = types.str;
36− default = name;
37− description = "Domain to fetch certificate for (defaults to the entry name)";
38− };
39−
40− email = mkOption {
41− type = types.nullOr types.str;
42− default = cfg.email;
43− description = "Contact email address for the CA to be able to reach you.";
44− };
45−
46− user = mkOption {
47− type = types.str;
48− default = "root";
49− description = "User running the ACME client.";
50− };
51−
52− group = mkOption {
53− type = types.str;
54− default = "root";
55− description = "Group running the ACME client.";
56− };
57−
58− allowKeysForGroup = mkOption {
59− type = types.bool;
60− default = false;
61− description = ''
62− Give read permissions to the specified group
63− (<option>security.acme.cert.&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.nixdeleted−113
@@ -1,113 +0,0 @@
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.nixdeleted−145
@@ -1,145 +0,0 @@
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+212−239
@@ -1,34 +1,121 @@
11{ system ? builtins.currentSystem
22, profiling ? 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
3+, iosSdkVersion ? "10.2"
4+, __useLegacyCompilers ? false
95}:
106let
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;
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+ nix-prefetch-git
16+ openssh
17+ ];
18+
19+ getReflexPlatform = getReflexPlatform' __useLegacyCompilers;
20+ getReflexPlatform' = __useLegacyCompilers: sys: import ./dep/reflex-platform {
21+ inherit iosSdkVersion __useLegacyCompilers;
22+ system = sys;
23+ enableLibraryProfiling = profiling;
1924
2025 nixpkgsOverlays = [
21− (import ./nixpkgs-overlays)
26+ (self: super: {
27+ obeliskExecutableConfig = import ./lib/executable-config { nixpkgs = pkgs; filterGitSource = cleanSource; };
28+ })
2229 ];
2330
2431 haskellOverlays = [
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)
32+
33+ # Fix misc upstream packages
34+ (self: super: let
35+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
36+ in {
37+ hnix = pkgs.haskell.lib.dontCheck (self.callCabal2nix "hnix" (pkgs.fetchFromGitHub {
38+ owner = "haskell-nix";
39+ repo = "hnix";
40+ rev = "42afdc21da5d9e076eab57eaa42bfdde938192b8";
41+ sha256 = "0psw384dx9bw2dp93xrzw8rd9amvcwgzn64jzzwby7sfspj6k349";
42+ }) {});
43+ # Need 8.0.2 build support
44+ # PR: https://github.com/dmwit/universe/pull/33
45+ universe-template = self.callCabal2nix "universe-template" (pkgs.fetchFromGitHub {
46+ owner = "obsidiansystems";
47+ repo = "universe";
48+ rev = "6a71119bfa5db2b9990a2491c941469ff8ef5d13";
49+ sha256 = "0z8smyainnlzcglv3dlx6x1n9j6d2jv48aa8f2421iayfkxg3js5";
50+ } + /template) {};
51+ })
52+
53+ # Add obelisk packages
54+ (self: super: let
55+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
56+ in {
57+ obelisk-executable-config = pkgs.obeliskExecutableConfig.haskellPackage self;
58+ obelisk-executable-config-inject = pkgs.obeliskExecutableConfig.platforms.web.inject self;
59+
60+ obelisk-asset-manifest = self.callCabal2nix "obelisk-asset-manifest" (hackGet ./lib/asset + "/manifest") {};
61+ obelisk-asset-serve-snap = self.callCabal2nix "obelisk-asset-serve-snap" (hackGet ./lib/asset + "/serve-snap") {};
62+ obelisk-backend = self.callCabal2nix "obelisk-backend" (cleanSource ./lib/backend) {};
63+ obelisk-cliapp = self.callCabal2nix "obelisk-cliapp" (cleanSource ./lib/cliapp) {};
64+ obelisk-command = self.callCabal2nix "obelisk-command" (cleanSource ./lib/command) {};
65+ obelisk-frontend = self.callCabal2nix "obelisk-frontend" (cleanSource ./lib/frontend) {};
66+ obelisk-run = self.callCabal2nix "obelisk-run" (cleanSource ./lib/run) {};
67+ obelisk-route = self.callCabal2nix "obelisk-route" (cleanSource ./lib/route) {};
68+ obelisk-selftest = self.callCabal2nix "obelisk-selftest" (cleanSource ./lib/selftest) {};
69+ obelisk-snap-extras = self.callCabal2nix "obelisk-snap-extras" (cleanSource ./lib/snap-extras) {};
70+ })
71+
72+ (self: super: let
73+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
74+ haskellLib = pkgs.haskell.lib;
75+ #TODO: Upstream
76+ # Modify a Haskell package to add completion scripts for the given
77+ # executable produced by it. These completion scripts will be picked up
78+ # automatically if the resulting derivation is installed, e.g. by
79+ # `nix-env -i`.
80+ addOptparseApplicativeCompletionScripts = exeName: pkg: haskellLib.overrideCabal pkg (drv: {
81+ postInstall = (drv.postInstall or "") + ''
82+ BASH_COMP_DIR="$out/share/bash-completion/completions"
83+ mkdir -p "$BASH_COMP_DIR"
84+ "$out/bin/${exeName}" --bash-completion-script "$out/bin/${exeName}" >"$BASH_COMP_DIR/ob"
85+
86+ ZSH_COMP_DIR="$out/share/zsh/vendor-completions"
87+ mkdir -p "$ZSH_COMP_DIR"
88+ "$out/bin/${exeName}" --zsh-completion-script "$out/bin/${exeName}" >"$ZSH_COMP_DIR/_ob"
89+
90+ FISH_COMP_DIR="$out/share/fish/vendor_completions.d"
91+ mkdir -p "$FISH_COMP_DIR"
92+ "$out/bin/${exeName}" --fish-completion-script "$out/bin/${exeName}" >"$FISH_COMP_DIR/ob.fish"
93+ '';
94+ });
95+ in {
96+ # Dynamic linking with split objects dramatically increases startup time (about
97+ # 0.5 seconds on a decent machine with SSD), so we do `justStaticExecutables`.
98+ obelisk-command = haskellLib.overrideCabal
99+ (addOptparseApplicativeCompletionScripts "ob"
100+ (haskellLib.justStaticExecutables super.obelisk-command))
101+ (drv: {
102+ buildTools = (drv.buildTools or []) ++ [ pkgs.buildPackages.makeWrapper ];
103+ postFixup = ''
104+ ${drv.postFixup or ""}
105+ # Make `ob` reference its runtime dependencies.
106+ wrapProgram "$out"/bin/ob --prefix PATH : ${pkgs.lib.makeBinPath (commandRuntimeDeps pkgs)}
107+ '';
108+ });
109+ obelisk-selftest = haskellLib.justStaticExecutables super.obelisk-selftest;
110+ })
111+
29112 ];
30113 };
31114
115+ reflex-platform = getReflexPlatform' false system;
116+ inherit (reflex-platform) hackGet nixpkgs;
117+ pkgs = nixpkgs;
118+
32119 # The haskell environment used to build Obelisk itself, e.g. the 'ob' command
33120 ghcObelisk = reflex-platform.ghc;
34121
@@ -46,18 +133,19 @@ in rec {
46133 pathGit = ./.; # Used in CI by the migration graph hash algorithm to correctly ignore files.
47134 path = reflex-platform.filterGit ./.;
48135 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
136+ obeliskEnvs = ghcObeliskEnvs;
50137 command = ghcObelisk.obelisk-command;
51− shell = pinBuildInputs "obelisk-shell" ([command] ++ command.commandRuntimeDeps);
138+ shell = pinBuildInputs "obelisk-shell" ([command] ++ commandRuntimeDeps pkgs) [];
52139
53140 selftest = pkgs.writeScript "selftest" ''
54− #!${pkgs.runtimeShell}
141+ #!/usr/bin/env bash
55142 set -euo pipefail
56143
57144 PATH="${command}/bin:$PATH"
58− cd ${./.}
145+ export OBELISK_IMPL="${hackGet ./.}"
59146 "${ghcObelisk.obelisk-selftest}/bin/obelisk-selftest" +RTS -N -RTS "$@"
60147 '';
148+ #TODO: Why can't I build ./skeleton directly as a derivation? `nix-build -E ./.` doesn't work
61149 skeleton = pkgs.runCommand "skeleton" {
62150 dir = builtins.filterSource (path: type: builtins.trace path (baseNameOf path != ".obelisk")) ./skeleton;
63151 } ''
@@ -77,47 +165,30 @@ in rec {
77165 '';
78166
79167 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
168+ mkdir $out
169+ cd $out
170+ ln -s "${haskellLib.justStaticExecutables frontend}/bin/frontend.jsexe/all.js" all.unminified.js
171+ ${if optimizationLevel == null then ''
172+ ln -s all.unminified.js all.js
173+ '' else ''
174+ ${pkgs.closurecompiler}/bin/closure-compiler --externs "${reflex-platform.ghcjsExternsJs}" -O ${optimizationLevel} --jscomp_warning=checkVars --create_source_map="all.js.map" --source_map_format=V3 --js_output_file="all.js" all.unminified.js
175+ echo "//# sourceMappingURL=all.js.map" >> all.js
176+ ''}
94177 '';
95178
96179 serverModules = {
97− mkBaseEc2 = { nixosPkgs, ... }: {...}: {
180+ mkBaseEc2 = { hostName, routeHost, enableHttps, adminEmail, ... }: {...}: {
98181 imports = [
99− (nixosPkgs.path + /nixos/modules/virtualisation/amazon-image.nix)
182+ (pkgs.path + /nixos/modules/virtualisation/amazon-image.nix)
100183 ];
101− ec2.hvm = true;
102− };
103−
104− mkDefaultNetworking = { adminEmail, enableHttps, hostName, routeHost, ... }: {...}: {
105184 networking = {
106185 inherit hostName;
107186 firewall.allowedTCPPorts = if enableHttps then [ 80 443 ] else [ 80 ];
108187 };
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−
116188 security.acme.certs = if enableHttps then {
117189 "${routeHost}".email = adminEmail;
118190 } else {};
119−
120− security.acme.${if enableHttps && (terms.security.acme.acceptTerms or false) then "acceptTerms" else null} = true;
191+ ec2.hvm = true;
121192 };
122193
123194 mkObeliskApp =
@@ -134,16 +205,11 @@ in rec {
134205 }: {...}: {
135206 services.nginx = {
136207 enable = true;
137− recommendedProxySettings = true;
138208 virtualHosts."${routeHost}" = {
139209 enableACME = enableHttps;
140210 forceSSL = enableHttps;
141211 locations.${baseUrl} = {
142− proxyPass = "http://127.0.0.1:" + toString internalPort;
143− proxyWebsockets = true;
144− extraConfig = ''
145− access_log off;
146− '';
212+ proxyPass = "http://localhost:" + toString internalPort;
147213 };
148214 };
149215 };
@@ -151,11 +217,10 @@ in rec {
151217 wantedBy = [ "multi-user.target" ];
152218 after = [ "network.target" ];
153219 restartIfChanged = true;
154− path = [ pkgs.gnutar ];
155220 script = ''
156221 ln -sft . '${exe}'/*
157222 mkdir -p log
158− exec ./backend ${backendArgs} </dev/null
223+ exec ./backend ${backendArgs} >>backend.out 2>>backend.err </dev/null
159224 '';
160225 serviceConfig = {
161226 User = user;
@@ -178,213 +243,121 @@ in rec {
178243 };
179244 };
180245
181− inherit mkAssets;
182−
183246 serverExe = backend: frontend: assets: optimizationLevel: version:
184247 pkgs.runCommand "serverExe" {} ''
185248 mkdir $out
186249 set -eux
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
250+ ln -s "${haskellLib.justStaticExecutables backend}"/bin/* $out/
251+ ln -s "${mkAssets assets}" $out/static.assets
252+ ln -s ${mkAssets (compressedJs frontend optimizationLevel)} $out/frontend.jsexe.assets
192253 echo ${version} > $out/version
193254 '';
194255
195− server = { exe, hostName, adminEmail, routeHost, enableHttps, version, module ? serverModules.mkBaseEc2 }@args:
256+ server = { exe, hostName, adminEmail, routeHost, enableHttps, version }@args:
196257 let
197258 nixos = import (pkgs.path + /nixos);
198259 in nixos {
199260 system = "x86_64-linux";
200261 configuration = {
201262 imports = [
202− (module { inherit exe hostName adminEmail routeHost enableHttps version; nixosPkgs = pkgs; })
203− (serverModules.mkDefaultNetworking args)
263+ (serverModules.mkBaseEc2 args)
204264 (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− })
219265 ];
220266 };
221267 };
222268
223− # An Obelisk project is a reflex-platform project with a predefined layout and role for each component
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");
260− };
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} = {
274− executableName = "frontend";
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;
280− };
281− __iosWithConfig = configPath: {
282− ${if self.userSettings.ios == null then null else self.frontendName} = {
283− executableName = "frontend";
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− ];
302269
303− shellToolOverrides = lib.composeExtensions
304− self.userSettings.shellToolOverrides
305− (if self.userSettings.__withGhcide
306− then (import ./haskell-overlays/ghcide.nix)
307− else (_: _: {})
270+ # An Obelisk project is a reflex-platform project with a predefined layout and role for each component
271+ project = base: projectDefinition:
272+ let projectOut = sys: (getReflexPlatform sys).project (args@{ nixpkgs, ... }:
273+ let mkProject = { android ? null #TODO: Better error when missing
274+ , ios ? null #TODO: Better error when missing
275+ , packages ? {}
276+ , overrides ? _: _: {}
277+ , staticFiles ? base + /static
278+ , tools ? _: []
279+ , shellToolOverrides ? _: _: {}
280+ , withHoogle ? false # Setting this to `true` makes shell reloading far slower
281+ , __closureCompilerOptimizationLevel ? "ADVANCED" # Set this to `null` to skip the closure-compiler step
282+ }:
283+ let frontendName = "frontend";
284+ backendName = "backend";
285+ commonName = "common";
286+ staticName = "obelisk-generated-static";
287+ staticFilesImpure = if lib.isDerivation staticFiles then staticFiles else toString staticFiles;
288+ processedStatic = processAssets { src = staticFiles; };
289+ # The packages whose names and roles are defined by this package
290+ predefinedPackages = lib.filterAttrs (_: x: x != null) {
291+ ${frontendName} = nullIfAbsent (base + "/frontend");
292+ ${commonName} = nullIfAbsent (base + "/common");
293+ ${backendName} = nullIfAbsent (base + "/backend");
294+ };
295+ combinedPackages = predefinedPackages // packages;
296+ projectOverrides = self: super: {
297+ ${staticName} = haskellLib.dontHaddock (self.callCabal2nix staticName processedStatic.haskellManifest {});
298+ ${backendName} = haskellLib.addBuildDepend super.${backendName} self.obelisk-run;
299+ };
300+ totalOverrides = lib.composeExtensions projectOverrides overrides;
301+ inherit (lib.strings) hasPrefix;
302+ privateConfigDirs = ["config/backend"];
303+ injectableConfig = builtins.filterSource (path: _:
304+ !(lib.lists.any (x: hasPrefix (toString base + "/" + toString x) (toString path)) privateConfigDirs)
308305 );
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;
306+ __android = configPath: {
307+ ${if android == null then null else frontendName} = {
308+ executableName = "frontend";
309+ ${if builtins.pathExists staticFiles then "assets" else null} =
310+ (if configPath == null then lib.id else nixpkgs.obeliskExecutableConfig.platforms.android.inject (injectableConfig configPath))
311+ processedStatic.symlinked;
312+ } // android;
321313 };
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− ;
314+ __ios = configPath: {
315+ ${if ios == null then null else frontendName} = {
316+ executableName = "frontend";
317+ ${if builtins.pathExists staticFiles then "staticSrc" else null} =
318+ (if configPath == null then lib.id else nixpkgs.obeliskExecutableConfig.platforms.ios.inject (injectableConfig configPath))
319+ processedStatic.symlinked;
320+ } // ios;
335321 };
322+ in {
323+ inherit shellToolOverrides tools withHoogle;
324+ overrides = totalOverrides;
325+ packages = combinedPackages;
326+ shells = {
327+ ${if android == null && ios == null then null else "ghcSavedSplices"} = (lib.filter (x: lib.hasAttr x combinedPackages) [
328+ commonName
329+ frontendName
330+ ]);
331+ ghc = (lib.filter (x: lib.hasAttr x combinedPackages) [
332+ backendName
333+ commonName
334+ frontendName
335+ ]);
336+ ghcjs = lib.filter (x: lib.hasAttr x combinedPackages) [
337+ frontendName
338+ commonName
339+ ];
336340 };
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
341+ android = __android null;
342+ ios = __ios null;
343+ passthru = { inherit android ios packages overrides tools shellToolOverrides withHoogle staticFiles staticFilesImpure __closureCompilerOptimizationLevel processedStatic __ios __android; };
344+ };
345+ in mkProject (projectDefinition args));
346+ serverOn = sys: version: serverExe
347+ (projectOut sys).ghc.backend
348+ (projectOut system).ghcjs.frontend
349+ (projectOut sys).passthru.staticFiles
350+ (projectOut sys).passthru.__closureCompilerOptimizationLevel
346351 version;
347− linuxExe = serverOn (projectOut { system = "x86_64-linux"; });
352+ linuxExe = serverOn "x86_64-linux";
348353 dummyVersion = "Version number is only available for deployments";
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−
354+ in projectOut system // {
382355 linuxExeConfigurable = linuxExe;
383356 linuxExe = linuxExe dummyVersion;
384− exe = serverOn mainProjectOut dummyVersion;
385− server = args@{ hostName, adminEmail, routeHost, enableHttps, version, module ? serverModules.mkBaseEc2 }:
357+ exe = serverOn system dummyVersion;
358+ server = args@{ hostName, adminEmail, routeHost, enableHttps, version }:
386359 server (args // { exe = linuxExe version; });
387− obelisk = import (base' + "/.obelisk/impl") {};
360+ obelisk = import (base + "/.obelisk/impl") {};
388361 };
389362 haskellPackageSets = {
390363 inherit (reflex-platform) ghc ghcjs;
dep/.gitignorenew file+4
@@ -0,0 +1,4 @@
1+*
2+!.gitignore
3+!*/*.json
4+!*/default.nix
dep/ghcid/default.nixdeleted−7
@@ -1,7 +0,0 @@
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.jsondeleted−7
@@ -1,7 +0,0 @@
1−{
2− "owner": "ndmitchell",
3− "repo": "ghcid",
4− "branch": "master",
5− "rev": "f572318f32b1617f6054248e5888af68222f8e50",
6− "sha256": "1icg3r70lg2kmd9gdc024ih1n9nrja98yav74z9nvykqygvv5w0n"
7−}
dep/gitignore.nix/default.nixdeleted−8
@@ -1,8 +0,0 @@
1−# DO NOT HAND-EDIT THIS FILE
2−let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3− if !fetchSubmodules && !private then builtins.fetchTarball {
4− url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5− } else (import <nixpkgs> {}).fetchFromGitHub {
6− inherit owner repo rev sha256 fetchSubmodules private;
7− };
8−in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))
dep/gitignore.nix/github.jsondeleted−8
@@ -1,8 +0,0 @@
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.nixdeleted−7
@@ -1,7 +0,0 @@
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.jsondeleted−7
@@ -1,7 +0,0 @@
1−{
2− "owner": "haskell-nix",
3− "repo": "hnix",
4− "branch": "master",
5− "rev": "6c9c7c310c54372b3db0fdf5a0137b395cde1bdb",
6− "sha256": "1i5903b7lxqn2s3jarb14h6wdq8bxiik1hp0xy43w5w1hgvvq0g5"
7−}
dep/reflex-platform/default.nix+6−1
@@ -1,2 +1,7 @@
11# DO NOT HAND-EDIT THIS FILE
2−import (import ./thunk.nix)
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/reflex-platform/github.json+3−4
@@ -1,8 +1,7 @@
11{
22 "owner": "reflex-frp",
33 "repo": "reflex-platform",
4− "branch": "release/0.7.0.0",
5− "private": false,
6− "rev": "27a7851a780ff21472d85f9a02fb84635ef9027a",
7− "sha256": "1m4zlw91dpjlbdchjyxhvhv3k7lilm0qa17dhhww868xxc27sann"
4+ "branch": "develop",
5+ "rev": "a7cd9a23e7faa9c2545a4c111229e28208e42351",
6+ "sha256": "0y52rfrhk4zszgprpyni51l0pgq18dg695k5bmpd62c3zxar5mvm"
87}
dep/reflex-platform/thunk.nixdeleted−9
@@ -1,9 +0,0 @@
1−# DO NOT HAND-EDIT THIS FILE
2−let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3− if !fetchSubmodules && !private then builtins.fetchTarball {
4− url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5− } else (import <nixpkgs> {}).fetchFromGitHub {
6− inherit owner repo rev sha256 fetchSubmodules private;
7− };
8− json = builtins.fromJSON (builtins.readFile ./github.json);
9−in fetch json
dep/snap-core/default.nixdeleted−8
@@ -1,8 +0,0 @@
1−# DO NOT HAND-EDIT THIS FILE
2−let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3− if !fetchSubmodules && !private then builtins.fetchTarball {
4− url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5− } else (import <nixpkgs> {}).fetchFromGitHub {
6− inherit owner repo rev sha256 fetchSubmodules private;
7− };
8−in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))
dep/snap-core/github.jsondeleted−8
@@ -1,8 +0,0 @@
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.pngdeleted

Binary file not shown.

guides/app-deploy/README.mddeleted−324
@@ -1,324 +0,0 @@
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.jpgdeleted

Binary file not shown.

guides/app-deploy/assets/android-confirm-usb-debugging.jpgdeleted

Binary file not shown.

guides/app-deploy/assets/app-deploy-2.pngdeleted

Binary file not shown.

guides/app-deploy/assets/app-deploy.pngdeleted

Binary file not shown.

guides/app-deploy/assets/ios-deploy-example.pngdeleted

Binary file not shown.

guides/app-deploy/assets/ios-deploy-keychain.pngdeleted

Binary file not shown.

guides/app-deploy/assets/ios-obelisk-app-icon.jpgdeleted

Binary file not shown.

guides/app-deploy/assets/ios-obelisk-app-open.jpgdeleted

Binary file not shown.

guides/app-deploy/assets/nano-edit-nixos-configuration.pngdeleted

Binary file not shown.

guides/app-deploy/assets/virtualbox-appliance-import-loading.pngdeleted

Binary file not shown.

guides/app-deploy/assets/virtualbox-appliance-import.pngdeleted

Binary file not shown.

guides/app-deploy/assets/virtualbox-dashboard-nixos.pngdeleted

Binary file not shown.

guides/app-deploy/assets/virtualbox-image-settings-network.pngdeleted

Binary file not shown.

guides/app-deploy/assets/virtualbox-nioxs-after-boot.pngdeleted

Binary file not shown.

guides/app-deploy/assets/xcode-devices.pngdeleted

Binary file not shown.

haskell-overlays/ghcide.nixdeleted−40
@@ -1,40 +0,0 @@
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.nixdeleted−26
@@ -1,26 +0,0 @@
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.nixdeleted−48
@@ -1,48 +0,0 @@
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.nixdeleted−32
@@ -1,32 +0,0 @@
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.nixnew file+66
@@ -0,0 +1,66 @@
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+20−17
@@ -1,26 +1,29 @@
1−# obelisk-asset
1+## obelisk-asset
22
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−**Efficiently served, aggressively cached static web resources.**
7−
8−The `assets.nix` file contains nix expressions that are a mutually recursive set of attributes used to create static asset directories with hashable file encodings. This file should be incorporated within your project's `default.nix` file. (See `example/default.nix`, line 2)
9−
10−```nix
11−{ assets ? import ./../assets.nix { inherit nixpkgs; } }:
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+}:
1210```
1311
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)
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.
1715
18−```nix
19−myAssets = assets.mkAssets ./static;
16+In this example, 'mkAssets' is used on a directory that has a .png
17+file inside of it. (See ./example/default.nix, line 11)
18+```
19+myAssets = assets.mkAssets ./static;
2020```
2121
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−
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.
2427```bash
2528nix-build -o static.assets -A myAssets
2629```
lib/asset/assets.nix+5−28
@@ -20,7 +20,7 @@ zopfliEncodings = file:
2020 nixpkgs.stdenv.mkDerivation {
2121 name = "encodings";
2222
23− input = mkPath file;
23+ input = 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 = mkPath file;
49+ input = 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 = mkPath file;
73+ input = 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− path = mkPath path;
206+ inherit path;
207207 } ''
208208 nix-hash --flat --base32 --type sha256 "$path" | tr -d '\n' >"$out"
209209 '');
@@ -224,30 +224,7 @@ symlink = path: {
224224 inherit path;
225225};
226226
227−# Tests if a given character (string of length 1) is valid for a derivation path name.
228−# Passing a string of length other than 1 is undefined.
229−# :: Char -> Bool
230−isValidDrvNameChar = c: "a" <= c && c <= "z" || "A" <= c && c <= "Z" || "0" <= c && c <= "9" || c == "+" || c == "-" || c == "_" || c == "?" || c == "=" || c == ".";
231−
232−# Convert a string into a string that could be used in a derivation name.
233−# replacement lets you choose how to replace invalid characters. It may be any length.
234−# If it contains invalid characters then the result will also be invalid.
235−# :: { str :: String, replacement :: String } -> String
236−mkValidDrvName = { str, replacement ? "?" }:
237− let
238− newName = stringAsChars (c: if isValidDrvNameChar c then c else replacement) str;
239− in if builtins.substring 0 1 newName == "." then "_" + newName else newName;
240−
241−# Like builtins.path but always ensures the name is valid.
242−mkPath = path:
243− if builtins.typeOf path == "path" # Don't mess with non-paths
244− then builtins.path {
245− inherit path;
246− name = mkValidDrvName { str = builtins.baseNameOf path; };
247− }
248− else path;
249−
250−# Given an encoding generation function and a file entry resulting from readDirRecursive in the form { name :: String, value: { path :: String } },
227+# Given a encoding generation function and a file entry resulting from readDirRecursive in the form { name :: String, value: { path :: String } },
251228# build a DirEntry for dirToPath with the various encodings of the asset for dirToPath to build into a final directory tree.
252229mkAsset = encodings: {name, value}:
253230 let nameWithHash = "${hashFile value.path}-${name}";
lib/asset/manifest/obelisk-asset-manifest.cabal+2−5
@@ -17,14 +17,13 @@ library
1717 base
1818 , bytestring
1919 , containers
20− , deepseq
2120 , directory
2221 , SHA
2322 , filepath
2423 , template-haskell
2524 , text
2625 , transformers
27− , unix-compat
26+ , unix
2827 , vector
2928 exposed-modules:
3029 Obelisk.Asset.Gather
@@ -33,9 +32,7 @@ library
3332 Obelisk.Asset.TH
3433
3534 other-extensions: TemplateHaskell
36− ghc-options:
37− -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O2
38− -fno-warn-unused-do-bind -funbox-strict-fields -fprof-auto-calls
35+ ghc-options: -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs -funbox-strict-fields -O2 -fprof-auto-calls
3936
4037executable obelisk-asset-manifest-generate
4138 hs-source-dirs: src-bin
lib/asset/manifest/src/Obelisk/Asset/Gather.hs+2−5
@@ -1,12 +1,10 @@
11{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE BangPatterns #-}
32-- | Functions for collecting up files to be processed by the asset pipeline
43module Obelisk.Asset.Gather
54 ( gatherHashedPaths
65 , toHashedPath
76 ) where
87
9−import Control.DeepSeq
108import Control.Monad (forM)
119import Data.Bits
1210import qualified Data.ByteString.Lazy as LBS
@@ -35,7 +33,7 @@ gatherHashedPaths root = go ""
3533 let relativePath = subdir </> sub
3634 isFile <- doesFileExist $ root </> relativePath
3735 if isFile
38− then do !hashedRelativePath <- force <$> toHashedPath root relativePath
36+ then do hashedRelativePath <- toHashedPath root relativePath
3937 return $ Map.singleton relativePath hashedRelativePath
4038 else go relativePath
4139
@@ -49,8 +47,7 @@ toHashedPath root relativePath = do
4947 contents <- LBS.readFile path
5048 let hashPrefix = T.unpack $ decodeUtf8 $ LBS.toStrict $ toNixBase32 $ bytestringDigest $ sha256 contents
5149 (dir, filename) = splitFileName relativePath
52− !hashedRelativePath = force $ normalise $ dir </> (hashPrefix <> "-" <> filename)
53− return hashedRelativePath
50+ return $ normalise $ dir </> (hashPrefix <> "-" <> filename)
5451
5552-- | Convert a ByteString to base 32 in the way that Nix does
5653toNixBase32 :: LBS.ByteString -> LBS.ByteString
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.PosixCompat.Files
10+import System.Posix.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+2−4
@@ -23,12 +23,10 @@ library
2323 , obelisk-snap-extras
2424 , text
2525 , transformers
26− , unix-compat
26+ , unix
2727 exposed-modules:
2828 Obelisk.Asset.Accept
2929 Obelisk.Asset.Serve.Snap
3030
3131 other-extensions: TemplateHaskell
32− ghc-options:
33− -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O2
34− -fno-warn-unused-do-bind -funbox-strict-fields -fprof-auto-calls
32+ ghc-options: -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs -funbox-strict-fields -O2 -fprof-auto-calls
lib/asset/serve-snap/src/Obelisk/Asset/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+11−22
@@ -12,15 +12,13 @@ import Obelisk.Asset.Accept (Encoding (..), acceptEncodingBody, chooseEncoding,
1212import Obelisk.Snap.Extras
1313
1414import Snap
15− (MonadSnap, getHeader, getRequest, getsRequest, modifyResponse, pass, redirect, sendFile, setContentLength, setContentType, setHeader, setResponseCode)
15+ (MonadSnap, getHeader, getsRequest, modifyResponse, pass, redirect, sendFile, setContentLength, setContentType, setHeader, setResponseCode)
1616import Snap.Util.FileServe (defaultMimeTypes, fileType, getSafePath, serveFile)
17−import Snap.Internal.Util.FileServe (checkRangeReq)
1817
1918import Control.Applicative ((<|>))
2019import Control.Exception (handleJust, try, throwIO)
21−import Control.Monad (forM, liftM, unless)
20+import Control.Monad (forM, liftM)
2221import Control.Monad.IO.Class (liftIO)
23−import Control.Monad.Fail (MonadFail)
2422import Data.Attoparsec.ByteString (parseOnly, endOfInput)
2523import Data.ByteString (ByteString)
2624import qualified Data.ByteString as BS
@@ -31,7 +29,7 @@ import Data.Text.Encoding (decodeUtf8, encodeUtf8)
3129import System.Directory (getDirectoryContents)
3230import System.FilePath ((</>), splitFileName, takeDirectory)
3331import System.IO.Error (isDoesNotExistError)
34−import System.PosixCompat.Files (getFileStatus, fileSize)
32+import System.Posix (getFileStatus, fileSize)
3533
3634-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
3735--
@@ -40,7 +38,7 @@ import System.PosixCompat.Files (getFileStatus, fileSize)
4038-- current version of the asset
4139-- (e.g. @0rx5yvkkgkig2pcqf4ngi1l7vh89qqajdzc6aiayaibyhvj0d853-test.png@). Hashed
4240-- asset names will be sent with permanent caching headers.
43−serveAssets :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> m ()
41+serveAssets :: MonadSnap m => FilePath -> FilePath -> m ()
4442serveAssets = serveAssets' True
4543
4644-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
@@ -49,15 +47,15 @@ serveAssets = serveAssets' True
4947-- browser for the logical asset name (e.g. @test.png@) but instead the current
5048-- version of the asset with to point the browser at the unique filename for the
5149-- current version of the asset.
52−serveAssetsInPlace :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> m ()
50+serveAssetsInPlace :: MonadSnap m => FilePath -> FilePath -> m ()
5351serveAssetsInPlace = serveAssets' False
5452
5553-- | Like 'serveAssets', but only serves a single specified asset
56−serveAsset :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> FilePath -> m ()
54+serveAsset :: MonadSnap m => FilePath -> FilePath -> FilePath -> m ()
5755serveAsset = serveAsset' True
5856
5957-- | Like 'serveAssetsInPlace', but only serves a single specified asset
60−serveAssetInPlace :: (MonadSnap m, MonadFail m) => FilePath -> FilePath -> FilePath -> m ()
58+serveAssetInPlace :: MonadSnap m => FilePath -> FilePath -> FilePath -> m ()
6159serveAssetInPlace = serveAsset' False
6260
6361-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
@@ -65,13 +63,13 @@ serveAssetInPlace = serveAsset' False
6563-- 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
6664-- 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
6765-- asset doesn't change often. Conversely for @False@, the asset will be served "in place" but made uncacheable.
68−serveAssets' :: (MonadSnap m, MonadFail m) => Bool -> FilePath -> FilePath -> m ()
66+serveAssets' :: MonadSnap m => Bool -> FilePath -> FilePath -> m ()
6967serveAssets' doRedirect base fallback = do
7068 pRaw <- getSafePath
7169 serveAsset' doRedirect base fallback $ if "/" `isSuffixOf` pRaw || pRaw == "" then pRaw <> "index.html" else pRaw
7270
7371-- | Serve a single static asset from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
74−serveAsset' :: (MonadFail m, MonadSnap m) => Bool -> FilePath -> FilePath -> FilePath -> m ()
72+serveAsset' :: MonadSnap m => Bool -> FilePath -> FilePath -> FilePath -> m ()
7573serveAsset' doRedirect base fallback p = do
7674 assetType <- liftIO $ try $ BS.readFile $ base </> p </> "type"
7775 case assetType of
@@ -95,17 +93,8 @@ serveAsset' doRedirect base fallback p = do
9593 let finalFilename = base </> p </> "encodings" </> T.unpack (decodeUtf8 e)
9694 stat <- liftIO $ getFileStatus finalFilename
9795 modifyResponse $ setHeader "Last-Modified" "Thu, 1 Jan 1970 00:00:00 GMT"
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
96+ modifyResponse $ setResponseCode 200 . setContentLength (fromIntegral $ fileSize stat) . setContentType (fileType defaultMimeTypes p)
97+ sendFile finalFilename
10998 Just _ -> cachePermanently >> modifyResponse (setResponseCode 304)
11099 Right "redirect" -> do
111100 mtarget <- liftIO $ getAssetTarget $ base </> p
lib/backend/obelisk-backend.cabal+2−5
@@ -8,8 +8,6 @@ library
88 build-depends: base,
99 bytestring,
1010 categories,
11− containers,
12− cookie,
1311 data-default,
1412 dependent-sum,
1513 dependent-sum-template,
@@ -17,14 +15,13 @@ library
1715 mtl,
1816 obelisk-asset-serve-snap,
1917 obelisk-executable-config-inject,
20− obelisk-executable-config-lookup,
2118 obelisk-frontend,
2219 obelisk-route,
2320 obelisk-snap-extras,
24− reflex-dom-core,
21+ reflex-dom,
2522 snap,
2623 snap-server,
2724 text,
2825 universe
2926 exposed-modules: Obelisk.Backend
30− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
27+ ghc-options: -Wall
lib/backend/src/Obelisk/Backend.hs+58−181
@@ -1,5 +1,3 @@
1−{-# LANGUAGE DeriveFunctor #-}
2−{-# LANGUAGE DeriveGeneric #-}
31{-# LANGUAGE FlexibleContexts #-}
42{-# LANGUAGE FlexibleInstances #-}
53{-# LANGUAGE GADTs #-}
@@ -8,112 +6,62 @@
86{-# LANGUAGE MultiParamTypeClasses #-}
97{-# LANGUAGE OverloadedStrings #-}
108{-# LANGUAGE ScopedTypeVariables #-}
11−{-# OPTIONS_GHC -fno-warn-orphans #-}
9+{-# LANGUAGE TemplateHaskell #-}
1210module Obelisk.Backend
1311 ( 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
3012 -- * Re-exports
3113 , Default (def)
3214 , getPageName
3315 , getRouteWith
3416 , runSnapWithCommandLineArgs
35− , runSnapWithConfig
3617 , serveDefaultObeliskApp
3718 , prettifyOutput
19+ , runBackend
3820 , staticRenderContentType
39− , getPublicConfigs
21+ , mkRouteToUrl
4022 ) where
4123
24+import Prelude hiding (id, (.))
25+import Control.Category
4226import Control.Monad
4327import Control.Monad.Except
44−import Control.Monad.Fail (MonadFail)
28+import Control.Categorical.Bifunctor
4529import Data.ByteString (ByteString)
4630import qualified Data.ByteString.Char8 as BSC8
4731import Data.Default (Default (..))
4832import Data.Dependent.Sum
33+import Data.Functor.Sum
4934import Data.Functor.Identity
50−import Data.Map (Map)
51−import qualified Data.Map as Map
5235import Data.Monoid ((<>))
5336import Data.Text (Text)
5437import qualified Data.Text as T
55−import GHC.Generics (Generic)
38+import Data.Text.Encoding
5639import Obelisk.Asset.Serve.Snap (serveAsset)
57−import qualified Obelisk.ExecutableConfig.Lookup as Lookup
40+import Obelisk.ExecutableConfig.Inject (injectExecutableConfigs)
5841import Obelisk.Frontend
5942import Obelisk.Route
6043import Obelisk.Snap.Extras (doNotCache, serveFileIfExistsAs)
61−import Reflex.Dom.Core
44+import Reflex.Dom
6245import Snap (MonadSnap, Snap, commandLineConfig, defaultConfig, getsRequest, httpServe, modifyResponse
63− , rqPathInfo, rqQueryString, setContentType, writeBS, writeText
64− , rqCookies, Cookie(..) , setHeader)
46+ , rqPathInfo, rqQueryString, setContentType, writeBS, writeText)
6547import Snap.Internal.Http.Server.Config (Config (accessLog, errorLog), ConfigLog (ConfigIoLog))
6648import System.IO (BufferMode (..), hSetBuffering, stderr, stdout)
6749
6850data Backend backendRoute frontendRoute = Backend
69− { _backend_routeEncoder :: Encoder (Either Text) Identity (R (FullRoute backendRoute frontendRoute)) PageName
51+ { _backend_routeEncoder :: Encoder (Either Text) Identity (R (Sum backendRoute (ObeliskRoute frontendRoute))) PageName
7052 , _backend_run :: ((R backendRoute -> Snap ()) -> IO ()) -> IO ()
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)
53+ }
8054
8155-- | The static assets provided must contain a compiled GHCJS app that corresponds exactly to the Frontend provided
8256data GhcjsApp route = GhcjsApp
8357 { _ghcjsApp_compiled :: !StaticAssets
8458 , _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
10259 }
10360
10461-- | Serve a frontend, which must be the same frontend that Obelisk has built and placed in the default location
10562--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
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
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
11765 where frontendApp = GhcjsApp
11866 { _ghcjsApp_compiled = defaultFrontendGhcjsAssets
11967 , _ghcjsApp_value = frontend
@@ -138,56 +86,45 @@ defaultFrontendGhcjsAssets = StaticAssets
13886 , _staticAssets_unprocessed = "frontend.jsexe"
13987 }
14088
141−runSnapWithConfig :: MonadIO m => Config Snap a -> Snap () -> m ()
142−runSnapWithConfig conf a = do
143− let httpConf = conf
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
14494 { accessLog = Just $ ConfigIoLog BSC8.putStrLn
14595 , errorLog = Just $ ConfigIoLog BSC8.putStrLn
14696 }
14797 -- Start the web server
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
98+ httpServe httpConf a
15499
155100getPageName :: (MonadSnap m) => m PageName
156101getPageName = do
157102 p <- getsRequest rqPathInfo
158103 q <- getsRequest rqQueryString
159− return $ byteStringsToPageName p q
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))
160109
161110getRouteWith :: (MonadSnap m) => Encoder Identity parse route PageName -> m (parse route)
162111getRouteWith e = do
163112 pageName <- getPageName
164113 return $ tryDecode e pageName
165114
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
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
181118 ObeliskRoute_Resource resComponent :=> Identity resRest -> case resComponent :=> Identity resRest of
182119 ResourceRoute_Static :=> Identity pathSegments -> serveStaticAsset pathSegments
183− ResourceRoute_Ghcjs :=> Identity pathSegments -> serveGhcjsApp urlEnc ghcjsWidgets frontendApp config $ GhcjsAppRoute_Resource :/ pathSegments
120+ ResourceRoute_Ghcjs :=> Identity pathSegments -> serveGhcjsApp urlEnc frontendApp $ GhcjsAppRoute_Resource :/ pathSegments
184121 ResourceRoute_JSaddleWarp :=> Identity _ -> do
185122 let msg = "Error: Obelisk.Backend received jsaddle request"
186123 liftIO $ putStrLn $ T.unpack msg
187124 writeText msg
188125 ResourceRoute_Version :=> Identity () -> doNotCache >> serveFileIfExistsAs "text/plain" "version"
189126
190−serveStaticAssets :: (MonadSnap m, MonadFail m) => StaticAssets -> [Text] -> m ()
127+serveStaticAssets :: MonadSnap m => StaticAssets -> [Text] -> m ()
191128serveStaticAssets assets pathSegments = serveAsset (_staticAssets_processed assets) (_staticAssets_unprocessed assets) $ T.unpack $ T.intercalate "/" pathSegments
192129
193130data StaticAssets = StaticAssets
@@ -204,95 +141,35 @@ staticRenderContentType :: ByteString
204141staticRenderContentType = "text/html; charset=utf-8"
205142
206143--TODO: Don't assume we're being served at "/"
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
144+serveGhcjsApp :: MonadSnap m => (R appRouteComponent -> Text) -> GhcjsApp (R appRouteComponent) -> R (GhcjsAppRoute appRouteComponent) -> m ()
145+serveGhcjsApp urlEnc app = \case
216146 GhcjsAppRoute_App appRouteComponent :=> Identity appRouteRest -> do
217147 modifyResponse $ setContentType staticRenderContentType
218− modifyResponse $ setHeader "Cache-Control" "no-store private"
219− writeBS <=< renderGhcjsFrontend urlEnc ghcjsWidgets (appRouteComponent :/ appRouteRest) config $ _ghcjsApp_value app
148+ writeBS <=< liftIO $ renderGhcjsFrontend urlEnc (appRouteComponent :/ appRouteRest) $ _ghcjsApp_value app
220149 GhcjsAppRoute_Resource :=> Identity pathSegments -> serveStaticAssets (_ghcjsApp_compiled app) pathSegments
221150
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
151+runBackend :: Backend fullRoute frontendRoute -> Frontend (R frontendRoute) -> IO ()
152+runBackend backend frontend = case checkEncoder $ _backend_routeEncoder backend of
237153 Left e -> fail $ "backend error:\n" <> T.unpack e
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)
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)
lib/cliapp/obelisk-cliapp.cabal+3−7
@@ -7,11 +7,9 @@ cabal-version: >=1.2
77library
88 hs-source-dirs: src
99 build-depends:
10− aeson
11− , ansi-terminal
10+ ansi-terminal
1211 , base
1312 , bytestring
14− , containers
1513 , exceptions
1614 , io-streams
1715 , lens
@@ -19,19 +17,17 @@ library
1917 , monad-loops
2018 , mtl
2119 , process
22− , shell-escape
2320 , terminal-size
2421 , text
2522 , time
2623 , transformers
27− , utf8-string
2824 exposed-modules:
2925 Obelisk.CliApp
26+ Obelisk.CliApp.Demo
3027 other-modules:
3128 Obelisk.CliApp.Logging
3229 Obelisk.CliApp.Process
3330 Obelisk.CliApp.Spinner
3431 Obelisk.CliApp.TerminalString
35− Obelisk.CliApp.Theme
3632 Obelisk.CliApp.Types
37− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
33+ ghc-options: -Wall -fobject-code
lib/cliapp/src/Obelisk/CliApp.hs+6−18
@@ -33,28 +33,16 @@ module Obelisk.CliApp
3333 , Severity (..)
3434
3535 -- .Process
36− , AsProcessFailure (..)
3736 , ProcessFailure (..)
38− , ProcessSpec (..)
39− , callCommand
40− , callProcess
37+ , AsProcessFailure (..)
38+ , readProcessAndLogStderr
39+ , readProcessAndLogOutput
40+ , readCreateProcessWithExitCode
4141 , callProcessAndLogOutput
42− , createProcess
4342 , createProcess_
44− , exitCodeToException
45− , overCreateProcess
46− , proc
47− , readCreateProcessWithExitCode
48− , readProcessAndLogOutput
49− , readProcessAndLogStderr
50− , readProcessJSONAndLogStderr
43+ , callProcess
44+ , callCommand
5145 , reconstructCommand
52− , runProcess_
53− , setCwd
54− , setDelegateCtlc
55− , setEnvOverride
56− , shell
57− , waitForProcess
5846 ) where
5947
6048import Control.Monad.Log (Severity (..))
lib/cliapp/src/Obelisk/CliApp/Demo.hsnew file+52
@@ -0,0 +1,52 @@
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+12−37
@@ -43,15 +43,13 @@ 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
4746import System.Console.ANSI (Color (Red, Yellow), ColorIntensity (Vivid),
4847 ConsoleIntensity (FaintIntensity), ConsoleLayer (Foreground),
4948 SGR (SetColor, SetConsoleIntensity), clearLine)
5049import System.Exit (ExitCode (..))
51−import System.IO
50+import System.IO (BufferMode (NoBuffering), hFlush, hReady, hSetBuffering, stderr, stdin, stdout)
5251
5352import qualified Obelisk.CliApp.TerminalString as TS
54−import Obelisk.CliApp.Theme
5553import Obelisk.CliApp.Types
5654
5755newCliConfig
@@ -65,11 +63,7 @@ newCliConfig sev noColor noSpinner errorLogExitCode = do
6563 lock <- newMVar False
6664 tipDisplayed <- newIORef False
6765 stack <- newIORef ([], [])
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
66+ return $ CliConfig level noColor noSpinner lock tipDisplayed stack errorLogExitCode
7367
7468runCli :: MonadIO m => CliConfig e -> CliT e m a -> m a
7569runCli c =
@@ -132,7 +126,7 @@ handleLog' noColor output = do
132126 hFlush stdout
133127 Output_Overwrite ts -> liftIO $ do
134128 width <- TS.getTerminalWidth
135− T.putStr $ "\r" <> TS.render (not noColor) width ts
129+ T.putStr $ "\r" <> (TS.render (not noColor) width ts)
136130 hFlush stdout
137131 Output_ClearLine -> liftIO $ do
138132 -- Go to the first column and clear the whole line
@@ -160,7 +154,7 @@ failWith :: (CliThrow e m, AsUnstructuredError e) => Text -> m a
160154failWith = throwError . review asUnstructuredError
161155
162156errorToWarning
163− :: (HasCliConfig e m, CliLog m)
157+ :: (HasCliConfig e m, CliThrow e m, CliLog m)
164158 => e -> m ()
165159errorToWarning e = do
166160 c <- getCliConfig
@@ -177,17 +171,15 @@ withExitFailMessage msg f = f `catch` \(e :: ExitCode) -> do
177171 throwM e
178172
179173-- | Write log to stdout, with colors (unless `noColor`)
180−writeLog :: (MonadIO m) => Bool -> Bool -> WithSeverity Text -> m ()
181−writeLog withNewLine noColor (WithSeverity severity s) = if T.null s then pure () else write
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
182181 where
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
182+ putFn = if withNewLine then (T.hPutStrLn h) else (T.hPutStr h)
191183 h = if severity <= Error then stderr else stdout
192184 errorColors = [SetColor Foreground Vivid Red]
193185 warningColors = [SetColor Foreground Vivid Yellow]
@@ -234,20 +226,3 @@ fork :: (HasCliConfig e m, MonadIO m) => CliT e IO () -> m ThreadId
234226fork f = do
235227 c <- getCliConfig
236228 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+55−143
@@ -1,6 +1,7 @@
11{-# LANGUAGE FlexibleContexts #-}
22{-# LANGUAGE LambdaCase #-}
33{-# LANGUAGE MultiParamTypeClasses #-}
4+{-# LANGUAGE MultiWayIf #-}
45{-# LANGUAGE OverloadedStrings #-}
56{-# LANGUAGE ScopedTypeVariables #-}
67{-# LANGUAGE TupleSections #-}
@@ -8,86 +9,43 @@
89-- | An extension of `System.Process` that integrates with logging (`Obelisk.CLI.Logging`)
910-- and is thus spinner friendly.
1011module Obelisk.CliApp.Process
11− ( AsProcessFailure (..)
12− , ProcessFailure (..)
13− , ProcessSpec (..)
14− , callCommand
15− , callProcess
12+ ( ProcessFailure (..)
13+ , AsProcessFailure (..)
14+ , readProcessAndLogStderr
15+ , readProcessAndLogOutput
16+ , readCreateProcessWithExitCode
1617 , callProcessAndLogOutput
1718 , createProcess
1819 , createProcess_
19− , exitCodeToException
20− , overCreateProcess
21− , proc
22− , readCreateProcessWithExitCode
23− , readProcessAndLogOutput
24− , readProcessAndLogStderr
25− , readProcessJSONAndLogStderr
20+ , callProcess
21+ , callCommand
2622 , reconstructCommand
27− , runProcess_
28− , setCwd
29− , setDelegateCtlc
30− , setEnvOverride
31− , shell
32− , waitForProcess
3323 ) where
3424
3525import Control.Monad ((<=<), join, void)
36−import Control.Monad.Catch (MonadMask, bracketOnError)
3726import Control.Monad.Except (throwError)
38−import Control.Monad.Fail
3927import Control.Monad.IO.Class (MonadIO, liftIO)
4028import Control.Lens (Prism', review)
4129import qualified Data.ByteString as BS
4230import qualified Data.ByteString.Char8 as BSC
43−import qualified Data.ByteString.UTF8 as BSU
4431import Data.Function (fix)
45−import Data.Map (Map)
46−import qualified Data.Map as Map
4732import Data.Monoid ((<>))
4833import Data.Text (Text)
4934import qualified Data.Text as T
5035import qualified Data.Text.Encoding as T
51−import Data.Text.Encoding.Error (lenientDecode)
52−import System.Environment (getEnvironment)
5336import System.Exit (ExitCode (..))
5437import System.IO (Handle)
5538import System.IO.Streams (InputStream, handleToInputStream)
5639import qualified System.IO.Streams as Streams
5740import System.IO.Streams.Concurrent (concurrentMerge)
58−import System.Process (CreateProcess, ProcessHandle, StdStream (CreatePipe), std_err, std_out)
41+import System.Process (CreateProcess, ProcessHandle, StdStream (CreatePipe), cmdspec, std_err, std_out,
42+ waitForProcess)
5943import qualified System.Process as Process
60−import Text.ShellEscape (bash, bytes)
61−import qualified Data.Aeson as Aeson
6244
6345import Control.Monad.Log (Severity (..))
6446import Obelisk.CliApp.Logging (putLog, putLogRaw)
6547import Obelisk.CliApp.Types (CliLog, CliThrow)
6648
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−
9149-- TODO put back in `Obelisk.CliApp.Process` and use prisms for extensible exceptions
9250data ProcessFailure = ProcessFailure Process.CmdSpec Int -- exit code
9351 deriving Show
@@ -101,56 +59,44 @@ instance AsProcessFailure ProcessFailure where
10159 asProcessFailure = id
10260
10361readProcessAndLogStderr
104− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
105− => Severity -> ProcessSpec -> m Text
62+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
63+ => Severity -> CreateProcess -> m Text
10664readProcessAndLogStderr sev process = do
10765 (out, _err) <- withProcess process $ \_out err -> do
10866 streamToLog =<< liftIO (streamHandle sev err)
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
67+ liftIO $ T.decodeUtf8 <$> BS.hGetContents out
12368
12469readCreateProcessWithExitCode
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
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)
13074 liftIO $ Process.readCreateProcessWithExitCode process ""
13175
13276-- | Like `System.Process.readProcess` but logs the combined output (stdout and stderr)
13377-- with the corresponding severity.
13478--
135−-- Usually this function is called as `readProcessAndLogOutput (Debug, Error)`. However
79+-- Usually this function is called as `callProcessAndLogOutput (Debug, Error)`. However
13680-- some processes are known to spit out diagnostic or informative messages in stderr, in
13781-- which case it is advisable to call it with a non-Error severity for stderr, like
138−-- `readProcessAndLogOutput (Debug, Debug)`.
82+-- `callProcessAndLogOutput (Debug, Debug)`.
13983readProcessAndLogOutput
140− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)
141− => (Severity, Severity) -> ProcessSpec -> m Text
84+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
85+ => (Severity, Severity) -> CreateProcess -> m Text
14286readProcessAndLogOutput (sev_out, sev_err) process = do
143− (_, Just out, Just err, p) <- createProcess $ overCreateProcess
144− (\p -> p { std_out = CreatePipe , std_err = CreatePipe }) process
87+ (_, Just out, Just err, p) <- createProcess $ process
88+ { std_out = CreatePipe , std_err = CreatePipe }
14589
14690 -- TODO interleave stdout and stderr in log correctly
14791 streamToLog =<< liftIO (streamHandle sev_err err)
148− outText <- liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out
92+ outText <- liftIO $ T.decodeUtf8 <$> BS.hGetContents out
14993 putLogRaw sev_out outText
15094
151− outText <$ (exitCodeToException process =<< waitForProcess p)
95+ liftIO (waitForProcess p) >>= \case
96+ ExitSuccess -> pure outText
97+ ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (cmdspec process) code
15298
153−-- | Like 'System.Process.callProcess' but logs the combined output (stdout and stderr)
99+-- | Like `System.Process.callProcess` but logs the combined output (stdout and stderr)
154100-- with the corresponding severity.
155101--
156102-- Usually this function is called as `callProcessAndLogOutput (Debug, Error)`. However
@@ -158,8 +104,9 @@ readProcessAndLogOutput (sev_out, sev_err) process = do
158104-- which case it is advisable to call it with a non-Error severity for stderr, like
159105-- `callProcessAndLogOutput (Debug, Debug)`.
160106callProcessAndLogOutput
161− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
162− => (Severity, Severity) -> ProcessSpec -> m ()
107+
108+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
109+ => (Severity, Severity) -> CreateProcess -> m ()
163110callProcessAndLogOutput (sev_out, sev_err) process =
164111 void $ withProcess process $ \out err -> do
165112 stream <- liftIO $ join $ combineStream
@@ -169,30 +116,21 @@ callProcessAndLogOutput (sev_out, sev_err) process =
169116 where
170117 combineStream s1 s2 = concurrentMerge [s1, s2]
171118
172−-- | Like 'System.Process.createProcess' but also logs (debug) the process being run
119+-- | Like `System.Process.createProcess` but also logs (debug) the process being run
173120createProcess
174121 :: (MonadIO m, CliLog m)
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
122+ => CreateProcess -> m (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)
123+createProcess p = do
124+ putLog Debug $ "Creating process: " <> reconstructCommand (cmdspec p)
179125 liftIO $ Process.createProcess p
180126
181127-- | Like `System.Process.createProcess_` but also logs (debug) the process being run
182128createProcess_
183129 :: (MonadIO m, CliLog m)
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) }
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
196134
197135-- | Like `System.Process.callProcess` but also logs (debug) the process being run
198136callProcess
@@ -211,30 +149,18 @@ callCommand cmd = do
211149 liftIO $ Process.callCommand cmd
212150
213151withProcess
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− )
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
228160
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)
161+ liftIO (waitForProcess p) >>= \case
162+ ExitSuccess -> return (out, err)
163+ ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (cmdspec process) code
238164
239165-- Create an input stream from the file handle, associating each item with the given severity.
240166streamHandle :: Severity -> Handle -> IO (InputStream (Severity, BSC.ByteString))
@@ -247,26 +173,12 @@ streamToLog
247173streamToLog stream = fix $ \loop -> do
248174 liftIO (Streams.read stream) >>= \case
249175 Nothing -> return ()
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
176+ Just (sev, line) -> putLogRaw sev (T.decodeUtf8 line) >> loop
261177
262178-- | Pretty print a 'CmdSpec'
263179reconstructCommand :: Process.CmdSpec -> Text
264−reconstructCommand p = case p of
265− Process.ShellCommand str -> T.pack str
266− Process.RawCommand c as -> processToShellString c as
180+reconstructCommand (Process.ShellCommand str) = T.pack str
181+reconstructCommand (Process.RawCommand c as) = processToShellString c as
267182 where
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
183+ processToShellString cmd args = T.unwords $ map quoteAndEscape (cmd : args)
184+ quoteAndEscape x = "'" <> T.replace "'" "'\''" (T.pack x) <> "'"
lib/cliapp/src/Obelisk/CliApp/Spinner.hs+24−18
@@ -3,6 +3,7 @@
33{-# LANGUAGE MultiParamTypeClasses #-}
44{-# LANGUAGE OverloadedStrings #-}
55{-# LANGUAGE ScopedTypeVariables #-}
6+{-# LANGUAGE TupleSections #-}
67-- | Provides a simple CLI spinner that interoperates cleanly with the rest of the logging output.
78module Obelisk.CliApp.Spinner
89 ( withSpinner
@@ -23,7 +24,6 @@ import System.Console.ANSI (Color (Blue, Cyan, Green, Red))
2324
2425import Obelisk.CliApp.Logging (allowUserToMakeLoggingVerbose, fork, putLog)
2526import 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,8 +51,7 @@ withSpinner'
5151 -> m a
5252 -> m a
5353withSpinner' msg mkTrail action = do
54− cliConf <- getCliConfig
55− let noSpinner = _cliConfig_noSpinner cliConf
54+ noSpinner <- _cliConfig_noSpinner <$> getCliConfig
5655 if noSpinner
5756 then putLog Notice msg >> action
5857 else bracket' run cleanup $ const action
@@ -62,11 +61,8 @@ withSpinner' msg mkTrail action = do
6261 modifyStack pushSpinner >>= \case
6362 True -> do -- Top-level spinner; fork a thread to manage output of anything on the stack
6463 ctrleThread <- fork $ allowUserToMakeLoggingVerbose enquiryCode
65− cliConf <- getCliConfig
66− let theme = _cliConfig_theme cliConf
67− spinner = coloredSpinner $ _cliTheme_spinner theme
6864 spinnerThread <- fork $ runSpinner spinner $ \c -> do
69− logs <- renderSpinnerStack theme c . snd <$> readStack
65+ logs <- renderSpinnerStack c . snd <$> readStack
7066 logMessage $ Output_Overwrite logs
7167 pure [ctrleThread, spinnerThread]
7268 False -> -- Sub-spinner; nothing to do.
@@ -74,15 +70,13 @@ withSpinner' msg mkTrail action = do
7470 cleanup tids resultM = do
7571 liftIO $ mapM_ killThread tids
7672 logMessage Output_ClearLine
77− cliConf <- getCliConfig
78− let theme = _cliConfig_theme cliConf
79− logsM <- modifyStack $ (popSpinner theme) $ case resultM of
73+ logsM <- modifyStack $ popSpinner $ case resultM of
8074 Nothing ->
81− ( TerminalString_Colorized Red $ _cliTheme_failed $ _cliConfig_theme cliConf
75+ ( TerminalString_Colorized Red "✖"
8276 , Just msg -- Always display final message if there was an exception.
8377 )
8478 Just result ->
85− ( TerminalString_Colorized Green $ _cliTheme_done $ _cliConfig_theme cliConf
79+ ( TerminalString_Colorized Green "✔"
8680 , mkTrail <*> pure result
8781 )
8882 -- Last message, finish off with newline.
@@ -93,10 +87,10 @@ withSpinner' msg mkTrail action = do
9387 )
9488 where
9589 isTemporary = isNothing mkTrail
96− popSpinner theme (mark, trailMsgM) (flag, old) =
90+ popSpinner (mark, trailMsgM) (flag, old) =
9791 ( (newFlag, new)
9892 -- With final trail spinner message to render
99− , renderSpinnerStack theme mark . (: new) . TerminalString_Normal <$> (
93+ , renderSpinnerStack mark . (: new) . TerminalString_Normal <$> (
10094 if inTemporarySpinner then Nothing else trailMsgM
10195 )
10296 )
@@ -108,19 +102,19 @@ withSpinner' msg mkTrail action = do
108102 =<< fmap _cliConfig_spinnerStack getCliConfig
109103 modifyStack f = liftIO . flip atomicModifyIORef' f
110104 =<< fmap _cliConfig_spinnerStack getCliConfig
105+ spinner = coloredSpinner defaultSpinnerTheme
111106
112107-- | How nested spinner logs should be displayed
113108renderSpinnerStack
114− :: CliTheme
115− -> TerminalString -- ^ That which comes before the final element in stack
109+ :: TerminalString -- ^ That which comes before the final element in stack
116110 -> [TerminalString] -- ^ Spinner elements in reverse order
117111 -> [TerminalString]
118−renderSpinnerStack theme mark = L.intersperse space . go . L.reverse
112+renderSpinnerStack mark = L.intersperse space . go . L.reverse
119113 where
120114 go [] = []
121115 go (x:[]) = mark : [x]
122116 go (x:xs) = arrow : x : go xs
123− arrow = TerminalString_Colorized Blue $ _cliTheme_arrow theme
117+ arrow = TerminalString_Colorized Blue "⇾"
124118 space = TerminalString_Normal " "
125119
126120-- | A spinner is simply an infinite list of strings that supplant each other in a delayed loop, creating the
@@ -136,6 +130,18 @@ runSpinner spinner f = forM_ spinner $ f >=> const delay
136130 where
137131 delay = liftIO $ threadDelay 100000 -- A shorter delay ensures that we update promptly.
138132
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+
139145-- | Like `bracket` but the `release` function can know whether an exception was raised
140146bracket' :: MonadMask m => m a -> (a -> Maybe c -> m b) -> (a -> m c) -> m c
141147bracket' acquire release use = mask $ \unmasked -> do
lib/cliapp/src/Obelisk/CliApp/Theme.hsdeleted−29
@@ -1,29 +0,0 @@
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+3−10
@@ -6,14 +6,12 @@
66{-# LANGUAGE GeneralizedNewtypeDeriving #-}
77{-# LANGUAGE MultiParamTypeClasses #-}
88{-# LANGUAGE OverloadedStrings #-}
9−{-# LANGUAGE StandaloneDeriving #-}
109{-# LANGUAGE UndecidableInstances #-}
1110module Obelisk.CliApp.Types where
1211
1312import Control.Concurrent.MVar (MVar)
1413import Control.Monad.Catch (MonadCatch, MonadMask, MonadThrow)
15−import Control.Monad.Fail (MonadFail)
16−import Control.Monad.Log (LoggingT(..), MonadLog, Severity (..), WithSeverity (..), logMessage)
14+import Control.Monad.Log (LoggingT, MonadLog, Severity (..), WithSeverity (..), logMessage)
1715import Control.Monad.Reader (MonadIO, ReaderT (..), MonadReader (..), ask, mapReaderT)
1816import Control.Monad.Writer (WriterT)
1917import Control.Monad.State (StateT)
@@ -25,7 +23,6 @@ import Data.Text (Text)
2523import System.Exit (ExitCode (..), exitWith)
2624
2725import Obelisk.CliApp.TerminalString (TerminalString)
28−import Obelisk.CliApp.Theme (CliTheme)
2926
3027--------------------------------------------------------------------------------
3128
@@ -47,11 +44,9 @@ type CliThrow e m = MonadError e m
4744putLog :: CliLog m => Severity -> Text -> m ()
4845putLog sev = logMessage . Output_Log . WithSeverity sev
4946
50−deriving instance MonadFail m => MonadFail (LoggingT Output m)
51−
5247newtype DieT e m a = DieT { unDieT :: ReaderT (e -> (Text, Int)) (LoggingT Output m) a }
5348 deriving
54− ( Functor, Applicative, Monad, MonadIO, MonadFail
49+ ( Functor, Applicative, Monad, MonadIO
5550 , MonadThrow, MonadCatch, MonadMask
5651 , MonadLog Output
5752 )
@@ -93,8 +88,6 @@ data CliConfig e = CliConfig
9388 _cliConfig_spinnerStack :: IORef ([Bool], [TerminalString])
9489 , -- | Failure handler. How to log error and what exit status to use.
9590 _cliConfig_errorLogExitCode :: e -> (Text, Int)
96− , -- | Theme strings for spinners
97− _cliConfig_theme :: CliTheme
9891 }
9992
10093class Monad m => HasCliConfig e m | m -> e where
@@ -118,7 +111,7 @@ newtype CliT e m a = CliT
118111 { unCliT :: ReaderT (CliConfig e) (DieT e m) a
119112 }
120113 deriving
121− ( Functor, Applicative, Monad, MonadIO, MonadFail
114+ ( Functor, Applicative, Monad, MonadIO
122115 , MonadThrow, MonadCatch, MonadMask
123116 , MonadLog Output -- CliLog
124117 , MonadError e -- CliThrow
lib/command/obelisk-command.cabal+14−17
@@ -1,5 +1,5 @@
11name: obelisk-command
2−version: 0.9.0.1
2+version: 0.1
33cabal-version: >= 1.8
44build-type: Simple
55
@@ -7,48 +7,45 @@ library
77 hs-source-dirs: src
88 build-depends:
99 aeson
10− , aeson-pretty
1110 , ansi-terminal
11+ , Cabal
12+ , aeson-pretty
1213 , base
14+ , base16-bytestring
15+ , binary
1316 , bytestring
14− , Cabal
17+ , obelisk-cliapp
1518 , containers
1619 , data-default
1720 , directory
1821 , either
1922 , errors
20− , exceptions
21− , extra
2223 , filepath
23− , git
2424 , github
2525 , here
26+ , hit
2627 , hnix
2728 , hpack
2829 , io-streams
29− , lens
30+ , exceptions
3031 , logging-effect
31− , megaparsec
32+ , lens
3233 , modern-uri
3334 , monad-loops
34− , monoidal-containers
3535 , mtl
36+ , megaparsec
3637 , network
3738 , network-uri
38− , obelisk-cliapp
3939 , optparse-applicative
4040 , placeholders
4141 , process
42− , shell-escape
4342 , temporary
4443 , terminal-size
4544 , text
4645 , time
4746 , transformers
48− , unix-compat
47+ , unix
4948 , unordered-containers
50− , utf8-string
51− , which
5249 , yaml
5350 exposed-modules:
5451 Obelisk.App
@@ -60,10 +57,10 @@ library
6057 Obelisk.Command.Thunk
6158 Obelisk.Command.Utils
6259 Obelisk.Command.VmBuilder
63− Obelisk.Command.Preprocessor
64− ghc-options: -Wall
60+ -- -fobject-code is so that the StaticPointers extension can work in ghci
61+ ghc-options: -Wall -fobject-code
6562
6663executable ob
6764 main-is: src-bin/ob.hs
6865 build-depends: base, obelisk-command
69− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -threaded
66+ ghc-options: -Wall -O2 -threaded
lib/command/src/Obelisk/App.hs+2−5
@@ -12,7 +12,6 @@ module Obelisk.App where
1212
1313import Control.Lens
1414import Control.Monad.Catch (MonadCatch, MonadMask, MonadThrow)
15−import Control.Monad.Fail (MonadFail)
1615import Control.Monad.Reader (MonadIO, ReaderT (..), ask, runReaderT)
1716import Control.Monad.Writer (WriterT)
1817import Control.Monad.State (StateT)
@@ -62,11 +61,10 @@ newtype ObeliskT m a = ObeliskT
6261 { unObeliskT :: ReaderT Obelisk (CliT ObeliskError m) a
6362 }
6463 deriving
65− ( Functor, Applicative, Monad, MonadIO, MonadThrow, MonadCatch, MonadMask, MonadFail
64+ ( Functor, Applicative, Monad, MonadIO, MonadThrow, MonadCatch, MonadMask
6665 , MonadLog Output -- CliLog
6766 , MonadError ObeliskError -- CliThrow ObeliskError
68− , HasCliConfig ObeliskError
69− )
67+ , HasCliConfig ObeliskError)
7068
7169instance MonadTrans ObeliskT where
7270 lift = ObeliskT . lift . lift
@@ -106,7 +104,6 @@ type MonadInfallibleObelisk m =
106104type MonadObelisk m =
107105 ( MonadInfallibleObelisk m
108106 , CliThrow ObeliskError m
109− , MonadFail m
110107 )
111108
112109getObeliskUserStateDir :: IO FilePath
lib/command/src/Obelisk/Command.hs+140−222
@@ -3,35 +3,38 @@
33{-# LANGUAGE MultiParamTypeClasses #-}
44{-# LANGUAGE OverloadedStrings #-}
55{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE TupleSections #-}
6+{-# LANGUAGE StaticPointers #-}
7+{-# LANGUAGE TypeApplications #-}
78module Obelisk.Command where
89
9−import Control.Monad.IO.Class (MonadIO, liftIO)
10+import Control.Monad
11+import Control.Monad.IO.Class (liftIO)
12+import qualified Data.Binary as Binary
1013import Data.Bool (bool)
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
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)
1618import qualified Data.Text as T
17−import Data.Traversable (for)
19+import Data.Text.Encoding
20+import GHC.StaticPtr
1821import Options.Applicative
19−import Options.Applicative.Help.Pretty (text, (<$$>))
2022import System.Directory
2123import System.Environment
2224import System.FilePath
2325import qualified System.Info
2426import System.IO (hIsTerminalDevice, stdout)
25−import System.Process (rawSystem)
27+import System.Posix.Process (executeFile)
2628
2729import Obelisk.App
2830import Obelisk.CliApp
31+import Obelisk.CliApp.Demo (cliDemo)
2932import Obelisk.Command.Deploy
3033import Obelisk.Command.Project
3134import Obelisk.Command.Run
3235import Obelisk.Command.Thunk
36+import Obelisk.Command.Utils
3337import qualified Obelisk.Command.VmBuilder as VmBuilder
34−import qualified Obelisk.Command.Preprocessor as Preprocessor
3538
3639
3740data Args = Args
@@ -74,8 +77,8 @@ argsInfo cfg = info (args cfg <**> helper) $ mconcat
7477initSource :: Parser InitSource
7578initSource = foldl1 (<|>)
7679 [ pure InitSource_Default
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")
80+ , InitSource_Branch <$> strOption (long "branch" <> metavar "BRANCH")
81+ , InitSource_Symlink <$> strOption (long "symlink" <> action "directory" <> metavar "PATH")
7982 ]
8083
8184initForce :: Parser Bool
@@ -84,56 +87,51 @@ initForce = switch (long "force" <> help "Allow ob init to overwrite files")
8487data ObCommand
8588 = ObCommand_Init InitSource Bool
8689 | ObCommand_Deploy DeployCommand
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
90+ | ObCommand_Run
91+ | ObCommand_Thunk ThunkCommand
92+ | ObCommand_Repl
93+ | ObCommand_Watch
9594 | ObCommand_Internal ObInternal
9695 deriving Show
9796
9897data ObInternal
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
98+ = ObInternal_RunStaticIO StaticKey
99+ | ObInternal_CLIDemo
105100 deriving Show
106101
107−obCommand :: ArgsConfig -> Parser ObCommand
108−obCommand cfg = hsubparser
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− ]
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
132106 where
133− useRelativePathsFlag = switch (long "use-relative-paths" <> help "Use relative paths")
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+ ]
134119
135−packageNames :: Parser [String]
136−packageNames = some (strArgument (metavar "PACKAGE-NAME..."))
120+obCommand :: ArgsConfig -> Parser ObCommand
121+obCommand 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+ ])
137135
138136deployCommand :: ArgsConfig -> Parser DeployCommand
139137deployCommand cfg = hsubparser $ mconcat
@@ -145,7 +143,7 @@ deployCommand cfg = hsubparser $ mconcat
145143 where
146144 platformP = hsubparser $ mconcat
147145 [ 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
146+ , command "ios" $ info ((,) <$> pure IOS <*> (fmap pure $ strArgument (metavar "TEAMID" <> help "Your Team ID - found in the Apple developer portal"))) mempty
149147 ]
150148
151149 remoteBuilderParser :: Parser (Maybe RemoteBuilder)
@@ -167,8 +165,8 @@ deployCommand cfg = hsubparser $ mconcat
167165
168166deployInitOpts :: Parser DeployInitOpts
169167deployInitOpts = DeployInitOpts
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")
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")
172170 <*> some (strOption (long "hostname" <> metavar "HOSTNAME" <> help "hostname of the deployment target"))
173171 <*> strOption (long "route" <> metavar "PUBLICROUTE" <> help "Publicly accessible URL of your app")
174172 <*> strOption (long "admin-email" <> metavar "ADMINEMAIL" <> help "Email address where administrative alerts will be sent")
@@ -185,126 +183,57 @@ data DeployCommand
185183 | DeployCommand_Update
186184 deriving Show
187185
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
186+data DeployInitOpts = DeployInitOpts
187+ { _deployInitOpts_outputDir :: FilePath
188+ , _deployInitOpts_sshKey :: FilePath
189+ , _deployInitOpts_hostname :: [String]
190+ , _deployInitOpts_route :: String
191+ , _deployInitOpts_adminEmail :: String
192+ , _deployInitOpts_enableHttps :: Bool
193+ }
233194 deriving Show
234195
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"
196+internalCommand :: Parser ObInternal
197+internalCommand = subparser $ mconcat
198+ [ command "run-static-io" $ info (ObInternal_RunStaticIO <$> argument (eitherReader decodeStaticKey) (action "static-key")) mempty
199+ , command "clidemo" $ info (pure ObInternal_CLIDemo) mempty
240200 ]
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
257201
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"
202+--TODO: Result should provide normalised path and also original user input for error reporting.
203+thunkDirectoryParser :: Parser FilePath
204+thunkDirectoryParser = fmap (dropTrailingPathSeparator . normalise) . strArgument $ mconcat
205+ [ action "directory"
206+ , metavar "THUNKDIR"
207+ , help "Path to directory containing thunk data"
208+ ]
283209
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")))
210+data ThunkCommand
211+ = ThunkCommand_Update [FilePath] (Maybe String)
212+ | ThunkCommand_Unpack [FilePath]
213+ | ThunkCommand_Pack [FilePath]
214+ deriving Show
292215
293−portOpt :: Int -> Parser Int
294−portOpt dfault = option auto (long "port" <> short 'p' <> help "Port number for server" <> showDefault <> value dfault <> metavar "INT")
216+thunkCommand :: Parser ThunkCommand
217+thunkCommand = hsubparser $ mconcat
218+ [ command "update" $ info (ThunkCommand_Update <$> some thunkDirectoryParser <*> optional (strOption (long "branch" <> metavar "BRANCH"))) $ progDesc "Update thunk to latest revision available"
219+ , command "unpack" $ info (ThunkCommand_Unpack <$> some thunkDirectoryParser) $ progDesc "Unpack thunk into git checkout of revision it points to"
220+ , command "pack" $ info (ThunkCommand_Pack <$> some thunkDirectoryParser) $ progDesc "Pack git checkout into thunk that points at the current branch's upstream"
221+ ]
295222
296223parserPrefs :: ParserPrefs
297224parserPrefs = defaultPrefs
298225 { prefShowHelpOnEmpty = True
299226 }
300227
228+parseCLIArgs :: ArgsConfig -> [String] -> IO Args
229+parseCLIArgs cfg as = pure as >>= handleParseResult . execParserPure parserPrefs (argsInfo cfg)
230+
301231-- | Create an Obelisk config for the current process.
302232mkObeliskConfig :: IO Obelisk
303233mkObeliskConfig = do
304234 cliArgs <- getArgs
305235 -- This function should not use argument parser (full argument parsing happens post handoff)
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
236+ let logLevel = toLogLevel $ "-v" `elem` cliArgs
308237 notInteractive <- not <$> isInteractiveTerm
309238 cliConf <- newCliConfig logLevel notInteractive notInteractive $ \case
310239 ObeliskError_ProcessError (ProcessFailure p code) ann ->
@@ -366,13 +295,9 @@ main' argsCfg = do
366295 Just impl -> do
367296 -- Invoke the real implementation, using --no-handoff to prevent infinite recursion
368297 putLog Debug $ "Handing off to " <> T.pack impl
369− _ <- liftIO $ rawSystem impl ("--no-handoff" : myArgs)
370− return ()
298+ liftIO $ executeFile impl False ("--no-handoff" : myArgs) Nothing
371299 case myArgs of
372300 "--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
376301 a:as -- Otherwise bash completion would always hand-off even if the user isn't trying to
377302 | "--bash-completion" `isPrefixOf` a
378303 && "--no-handoff" `elem` as -> go (a:as)
@@ -383,7 +308,30 @@ ob :: MonadObelisk m => ObCommand -> m ()
383308ob = \case
384309 ObCommand_Init source force -> initProject source force
385310 ObCommand_Deploy dc -> case dc of
386− DeployCommand_Init deployOpts -> withProjectRoot "." $ \root -> deployInit deployOpts root
311+ DeployCommand_Init deployOpts -> withProjectRoot "." $ \root -> do
312+ let deployDir = _deployInitOpts_outputDir deployOpts
313+ r <- liftIO $ canonicalizePath root
314+ rootEqualsTarget <- liftIO $ equalFilePath r <$> canonicalizePath deployDir
315+ when rootEqualsTarget $
316+ failWith $ "Deploy directory " <> T.pack deployDir <> " should not be the same as project root."
317+ thunkPtr <- readThunk root >>= \case
318+ Left err -> failWith $ case err of
319+ ReadThunkError_AmbiguousFiles ->
320+ "Project root " <> T.pack r <> " is not a git repository or valid thunk"
321+ ReadThunkError_UnrecognizedFiles ->
322+ "Project root " <> T.pack r <> " is not a git repository or valid thunk"
323+ _ -> "thunk read: " <> T.pack (show err)
324+ Right (ThunkData_Packed ptr) -> return ptr
325+ Right (ThunkData_Checkout (Just ptr)) -> return ptr
326+ Right (ThunkData_Checkout Nothing) ->
327+ getThunkPtr' False root
328+ let sshKeyPath = _deployInitOpts_sshKey deployOpts
329+ hostname = _deployInitOpts_hostname deployOpts
330+ route = _deployInitOpts_route deployOpts
331+ adminEmail = _deployInitOpts_adminEmail deployOpts
332+ enableHttps = _deployInitOpts_enableHttps deployOpts
333+ deployInit thunkPtr (root </> "config") deployDir
334+ sshKeyPath hostname route adminEmail enableHttps
387335 DeployCommand_Push remoteBuilder -> do
388336 deployPath <- liftIO $ canonicalizePath "."
389337 deployPush deployPath $ case remoteBuilder of
@@ -391,65 +339,35 @@ ob = \case
391339 Just RemoteBuilder_ObeliskVM -> (:[]) <$> VmBuilder.getNixBuildersArg
392340 DeployCommand_Update -> deployUpdate "."
393341 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"
342+ ObCommand_Run -> inNixShell' $ static run
343+ -- inNixShell ($(mkClosure 'ghcidAction) ())
344+ ObCommand_Thunk tc -> case tc of
345+ ThunkCommand_Update thunks mBranch -> mapM_ ((flip updateThunkToLatest) mBranch) thunks
346+ ThunkCommand_Unpack thunks -> mapM_ unpackThunk thunks
347+ ThunkCommand_Pack thunks -> forM_ thunks packThunk
348+ ObCommand_Repl -> runRepl
349+ ObCommand_Watch -> inNixShell' $ static runWatch
410350 ObCommand_Internal icmd -> case icmd of
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)"
351+ ObInternal_RunStaticIO k -> liftIO (unsafeLookupStaticPtr @(ObeliskT IO ()) k) >>= \case
352+ Nothing -> failWith $ "ObInternal_RunStaticIO: no such StaticKey: " <> T.pack (show k)
353+ Just p -> do
354+ c <- getObelisk
355+ liftIO $ runObelisk c $ deRefStaticPtr p
356+ ObInternal_CLIDemo -> cliDemo
432357
433358--TODO: Clean up all the magic strings throughout this codebase
434359
435360getArgsConfig :: IO ArgsConfig
436361getArgsConfig = pure $ ArgsConfig { _argsConfig_enableVmBuilderByDefault = System.Info.os == "darwin" }
437362
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
363+encodeStaticKey :: StaticKey -> String
364+encodeStaticKey = T.unpack . decodeUtf8 . Base16.encode . LBS.toStrict . Binary.encode
365+
366+-- TODO: Use failWith in place of fail to be consistent.
367+decodeStaticKey :: String -> Either String StaticKey
368+decodeStaticKey s = case Base16.decode $ encodeUtf8 $ T.pack s of
369+ (b, "") -> case Binary.decodeOrFail $ LBS.fromStrict b of
370+ Right ("", _, a) -> pure a
371+ Right _ -> fail "decodeStaticKey: Binary.decodeOrFail didn't consume all input"
372+ Left (_, _, e) -> fail $ "decodeStaticKey: Binary.decodeOrFail failed: " <> show e
373+ _ -> fail $ "decodeStaticKey: could not decode hex string: " <> show s
lib/command/src/Obelisk/Command/Deploy.hs+106−129
@@ -1,120 +1,95 @@
1−{-# LANGUAGE DeriveGeneric #-}
21{-# LANGUAGE FlexibleContexts #-}
32{-# LANGUAGE LambdaCase #-}
43{-# LANGUAGE OverloadedStrings #-}
5−{-# LANGUAGE QuasiQuotes #-}
64{-# LANGUAGE ScopedTypeVariables #-}
75{-# LANGUAGE ViewPatterns #-}
6+{-# LANGUAGE DeriveGeneric #-}
7+{-# LANGUAGE TypeApplications #-}
88module Obelisk.Command.Deploy where
99
10−import Control.Applicative (liftA2)
1110import Control.Lens
1211import Control.Monad
13−import Control.Monad.Catch (Exception (displayException), MonadThrow, bracket, throwM, try)
14−import Control.Monad.IO.Class (MonadIO, liftIO)
12+import Control.Monad.Catch (Exception (displayException), MonadThrow, throwM, try, bracket_)
13+import Control.Monad.IO.Class (liftIO)
1514import Data.Aeson (FromJSON, ToJSON, encode, eitherDecode)
1615import Data.Bits
1716import qualified Data.ByteString.Lazy as BSL
1817import Data.Default
18+import qualified Data.HashMap.Strict as HM
1919import qualified Data.Map as Map
20+import Data.Text (Text)
2021import qualified Data.Set as Set
21−import Data.String.Here.Interpolated (i)
2222import qualified Data.Text as T
2323import qualified Data.Text.IO as T
2424import GHC.Generics
25+import Nix.Convert
26+import Nix.Pretty
27+import Nix.Value
2528import System.Directory
29+import System.Environment (getEnvironment)
2630import System.FilePath
2731import System.IO
28−import System.PosixCompat.Files
32+import System.Posix.Files
33+import System.Process (delegate_ctlc, env, proc, cwd)
2934import Text.URI (URI)
3035import qualified Text.URI as URI
3136import Text.URI.Lens
3237
3338import Obelisk.App (MonadObelisk)
34−import Obelisk.CliApp (
35− Severity (..), callProcessAndLogOutput, failWith, proc, putLog,
36− setCwd, setDelegateCtlc, setEnvOverride, withSpinner)
39+import Obelisk.CliApp (Severity (..), callProcessAndLogOutput, failWith, putLog, withSpinner)
3740import Obelisk.Command.Nix
3841import Obelisk.Command.Project
3942import Obelisk.Command.Thunk
4043import Obelisk.Command.Utils
4144
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'
45+deployInit
6346 :: MonadObelisk m
6447 => ThunkPtr
65− -> DeployInitOpts
48+ -> FilePath
49+ -> FilePath
50+ -> FilePath
51+ -> [String] -- ^ hostnames
52+ -> String -- ^ route
53+ -> String -- ^ admin email
54+ -> Bool -- ^ enable https
6655 -> m ()
67−deployInit' thunkPtr (DeployInitOpts deployDir sshKeyPath hostnames route adminEmail enableHttps) = do
68− liftIO $ createDirectoryIfMissing True deployDir
69− localKey <- withSpinner ("Preparing " <> T.pack deployDir) $ do
56+deployInit thunkPtr configDir deployDir sshKeyPath hostnames route adminEmail enableHttps = do
57+ (hasConfigDir, localKey) <- withSpinner ("Preparing " <> T.pack deployDir) $ do
58+ hasConfigDir <- liftIO $ do
59+ createDirectoryIfMissing True deployDir
60+ doesDirectoryExist configDir
7061 localKey <- liftIO (doesFileExist sshKeyPath) >>= \case
7162 False -> failWith $ T.pack $ "ob deploy init: file does not exist: " <> sshKeyPath
7263 True -> pure $ deployDir </> "ssh_key"
7364 callProcessAndLogOutput (Notice, Error) $
74− proc cp [sshKeyPath, localKey]
65+ proc "cp" [sshKeyPath, localKey]
7566 liftIO $ setFileMode localKey $ ownerReadMode .|. ownerWriteMode
76− return localKey
67+ return $ (hasConfigDir, localKey)
7768 withSpinner "Validating configuration" $ do
7869 void $ getHostFromRoute enableHttps route -- make sure that hostname is present
7970 forM_ hostnames $ \hostname -> do
8071 putLog Notice $ "Verifying host keys (" <> T.pack hostname <> ")"
8172 -- Note: we can't use a spinner here as this function will prompt the user.
8273 verifyHostKey (deployDir </> "backend_known_hosts") localKey hostname
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−
74+ when hasConfigDir $ withSpinner "Importing project configuration" $ do
75+ callProcessAndLogOutput (Notice, Error) $
76+ proc "cp" [ "-r" , "-T" , configDir , deployDir </> "config"]
10077 withSpinner "Writing deployment configuration" $ do
10178 writeDeployConfig deployDir "backend_hosts" $ unlines hostnames
10279 writeDeployConfig deployDir "enable_https" $ show enableHttps
10380 writeDeployConfig deployDir "admin_email" adminEmail
104− writeDeployConfig deployDir ("config" </> "common" </> "route") route
105− writeDeployConfig deployDir "module.nix" $
106− "(import " <> toNixPath (makeRelative deployDir srcDir) <> " {}).obelisk.serverModules.mkBaseEc2"
107−
81+ writeDeployConfig deployDir ("config" </> "common" </> "route") $ route
82+ withSpinner "Creating source thunk (./src)" $ liftIO $ do
83+ createThunk (deployDir </> "src") thunkPtr
84+ setupObeliskImpl deployDir
10885 withSpinner ("Initializing git repository (" <> T.pack deployDir <> ")") $
10986 initGit deployDir
11087
111−setupObeliskImpl :: MonadIO m => FilePath -> m ()
112−setupObeliskImpl deployDir = liftIO $ do
113− let
114− implDir = toImplDir deployDir
115− goBackUp = foldr (</>) "" $ (".." <$) $ splitPath $ makeRelative deployDir implDir
88+setupObeliskImpl :: FilePath -> IO ()
89+setupObeliskImpl deployDir = do
90+ let implDir = toImplDir deployDir
11691 createDirectoryIfMissing True implDir
117− writeFile (implDir </> "default.nix") $ "(import " <> toNixPath (goBackUp </> "src") <> " {}).obelisk"
92+ writeFile (implDir </> "default.nix") "(import ../../src {}).obelisk"
11893
11994deployPush :: MonadObelisk m => FilePath -> m [String] -> m ()
12095deployPush deployPath getNixBuilders = do
@@ -125,16 +100,14 @@ deployPush deployPath getNixBuilders = do
125100 routeHost <- getHostFromRoute enableHttps route
126101 let srcPath = deployPath </> "src"
127102 thunkPtr <- readThunk srcPath >>= \case
128− Right (ThunkData_Packed _ ptr) -> return ptr
129− Right ThunkData_Checkout -> do
103+ Right (ThunkData_Packed ptr) -> return ptr
104+ Right (ThunkData_Checkout _) -> do
130105 checkGitCleanStatus srcPath True >>= \case
131− True -> packThunk (ThunkPackConfig False (ThunkConfig Nothing)) srcPath
106+ True -> packThunk srcPath
132107 False -> failWith $ T.pack $ "ob deploy push: ensure " <> srcPath <> " has no pending changes and latest is pushed upstream."
133108 Left err -> failWith $ "ob deploy push: couldn't read src thunk: " <> T.pack (show err)
134109 let version = show . _thunkRev_commit $ _thunkPtr_rev thunkPtr
135110 builders <- getNixBuilders
136− let moduleFile = deployPath </> "module.nix"
137− moduleFileExists <- liftIO $ doesFileExist moduleFile
138111 buildOutputByHost <- ifor (Map.fromSet (const ()) hosts) $ \host () -> do
139112 --TODO: What does it mean if this returns more or less than 1 line of output?
140113 [result] <- fmap lines $ nixCmd $ NixCmd_Build $ def
@@ -144,13 +117,13 @@ deployPush deployPath getNixBuilders = do
144117 , _target_expr = Nothing
145118 }
146119 & nixBuildConfig_outLink .~ OutLink_None
147− & nixCmdConfig_args .~ (
120+ & nixCmdConfig_args .~
148121 [ strArg "hostName" host
149122 , strArg "adminEmail" adminEmail
150123 , strArg "routeHost" routeHost
151124 , strArg "version" version
152125 , boolArg "enableHttps" enableHttps
153− ] <> [rawArg "module" ("import " <> toNixPath moduleFile) | moduleFileExists ])
126+ ]
154127 & nixCmdConfig_builders .~ builders
155128 pure result
156129 let knownHostsPath = deployPath </> "backend_known_hosts"
@@ -158,11 +131,11 @@ deployPush deployPath getNixBuilders = do
158131 withSpinner "Uploading closures" $ ifor_ buildOutputByHost $ \host outputPath -> do
159132 callProcess'
160133 (Map.fromList [("NIX_SSHOPTS", unwords sshOpts)])
161− "nix-copy-closure" ["-v", "--to", "--use-substitutes", "root@" <> host, "--gzip", outputPath]
134+ "nix-copy-closure" ["-v", "--to", "root@" <> host, "--gzip", outputPath]
162135 withSpinner "Uploading config" $ ifor_ buildOutputByHost $ \host _ -> do
163136 callProcessAndLogOutput (Notice, Warning) $
164− proc rsyncPath
165− [ "-e " <> sshPath <> " " <> unwords sshOpts
137+ proc "rsync"
138+ [ "-e ssh " <> unwords sshOpts
166139 , "-qarvz"
167140 , deployPath </> "config"
168141 , "root@" <> host <> ":/var/lib/backend"
@@ -170,10 +143,9 @@ deployPush deployPath getNixBuilders = do
170143 --TODO: Create GC root so we're sure our closure won't go away during this time period
171144 withSpinner "Switching to new configuration" $ ifor_ buildOutputByHost $ \host outputPath -> do
172145 callProcessAndLogOutput (Notice, Warning) $
173− proc sshPath $ sshOpts <>
146+ proc "ssh" $ sshOpts <>
174147 [ "root@" <> host
175148 , unwords
176− -- Note that we don't want to $(staticWhich "nix-env") here, because this is executing on a remote machine
177149 [ "nix-env -p /nix/var/nix/profiles/system --set " <> outputPath
178150 , "&&"
179151 , "/nix/var/nix/profiles/system/bin/switch-to-configuration switch"
@@ -181,19 +153,33 @@ deployPush deployPath getNixBuilders = do
181153 ]
182154 isClean <- checkGitCleanStatus deployPath True
183155 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"]
156+ withSpinner "Commiting changes to Git" $ do
157+ callProcessAndLogOutput (Debug, Error) $ proc "git"
158+ ["-C", deployPath, "add", "."]
159+ callProcessAndLogOutput (Debug, Error) $ proc "git"
160+ ["-C", deployPath, "commit", "-m", "New deployment"]
189161 putLog Notice $ "Deployed => " <> T.pack route
190162 where
191163 callProcess' envMap cmd args = do
192− let p = setEnvOverride (envMap <>) $ setDelegateCtlc True $ proc cmd args
164+ processEnv <- Map.toList . (envMap <>) . Map.fromList <$> liftIO getEnvironment
165+ let p = (proc cmd args) { delegate_ctlc = True, env = Just processEnv }
193166 callProcessAndLogOutput (Notice, Notice) p
194167
195168deployUpdate :: MonadObelisk m => FilePath -> m ()
196−deployUpdate deployPath = updateThunkToLatest (ThunkUpdateConfig Nothing (ThunkConfig Nothing)) (deployPath </> "src")
169+deployUpdate deployPath = updateThunkToLatest (deployPath </> "src") Nothing
170+
171+keytoolToAndroidConfig :: KeytoolConfig -> HM.HashMap Text (NValueNF Identity)
172+keytoolToAndroidConfig conf = runIdentity $ do
173+ path <- toValue $ Path $ _keytoolConfig_keystore conf
174+ storepass <- toValue $ T.pack $ _keytoolConfig_storepass conf
175+ alias <- toValue $ T.pack $ _keytoolConfig_alias conf
176+ keypass <- toValue $ T.pack $ _keytoolConfig_keypass conf
177+ return $ HM.fromList
178+ [ ("storeFile", path)
179+ , ("storePassword", storepass)
180+ , ("keyAlias", alias)
181+ , ("keyPassword", keypass)
182+ ]
197183
198184data PlatformDeployment = Android | IOS
199185 deriving (Show, Eq)
@@ -203,13 +189,13 @@ renderPlatformDeployment = \case
203189 Android -> "android"
204190 IOS -> "ios"
205191
206−deployMobile :: forall m. MonadObelisk m => PlatformDeployment -> [String] -> m ()
192+deployMobile :: MonadObelisk m => PlatformDeployment -> [String] -> m ()
207193deployMobile platform mobileArgs = withProjectRoot "." $ \root -> do
208194 let srcDir = root </> "src"
209195 configDir = root </> "config"
210196 exists <- liftIO $ doesDirectoryExist srcDir
211197 unless exists $ failWith "ob test should be run inside of a deploy directory"
212− (nixBuildTarget, extraArgs) <- case platform of
198+ nixBuildTarget <- case platform of
213199 Android -> do
214200 let keystorePath = root </> "android_keystore.jks"
215201 keytoolConfPath = root </> "android_keytool_config.json"
@@ -228,60 +214,48 @@ deployMobile platform mobileArgs = withProjectRoot "." $ \root -> do
228214 , _keytoolConfig_storepass = keyStorePassword
229215 , _keytoolConfig_keypass = keyStorePassword
230216 }
231− createKeystore root keyToolConf
217+ createKeystore root $ keyToolConf
232218 liftIO $ BSL.writeFile keytoolConfPath $ encode keyToolConf
233219 checkKeytoolConfExist <- liftIO $ doesFileExist keytoolConfPath
234220 unless checkKeytoolConfExist $ failWith "Missing android KeytoolConfig"
235221 keytoolConfContents <- liftIO $ BSL.readFile keytoolConfPath
236− keyArgs <- case eitherDecode keytoolConfContents :: Either String KeytoolConfig of
222+ liftIO $ putStrLn $ show keytoolConfContents
223+ releaseKey <- case eitherDecode keytoolConfContents of
237224 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− ]
225+ Right conf -> do
226+ let nvset = toValue @(HM.HashMap Text (NValueNF Identity)) @Identity @(NValueNF Identity) $ keytoolToAndroidConfig conf
227+ return $ printNix $ runIdentity nvset
245228 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;"
229+ [ "with (import ", srcDir, " {});"
230+ , "android.frontend.override (drv: { "
231+ , "releaseKey = (if builtins.isNull drv.releaseKey then {} else drv.releaseKey) // " <> releaseKey <> "; "
232+ , "staticSrc = (passthru.__android ", configDir, ").frontend.staticSrc;"
251233 , "})"
252234 ]
253− return (Target
235+ return $ Target
254236 { _target_path = Nothing
255237 , _target_attr = Nothing
256238 , _target_expr = Just expr
257− }, keyArgs)
239+ }
258240 IOS -> do
259241 let expr = mconcat
260− [ "with (import ", toNixPath srcDir, " {});"
261− , "ios.frontend.override (_: { staticSrc = (passthru.__iosWithConfig ", toNixPath configDir, ").frontend.staticSrc; })"
242+ [ "with (import ", srcDir, " {});"
243+ , "ios.frontend.override (_: { staticSrc = (passthru.__ios ", configDir, ").frontend.staticSrc; })"
262244 ]
263− return (Target
245+ return $ Target
264246 { _target_path = Nothing
265247 , _target_attr = Nothing
266248 , _target_expr = Just expr
267− }, [])
249+ }
268250 result <- nixCmd $ NixCmd_Build $ def
269251 & nixBuildConfig_outLink .~ OutLink_None
270252 & 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)
253+ putLog Notice $ T.pack $ "Your recently built android apk can be found at the following path: " <> (show result)
254+ callProcessAndLogOutput (Notice, Error) $ proc (result </> "bin" </> "deploy") mobileArgs
276255 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)
256+ withEcho showEcho f = do
257+ prevEcho <- hGetEcho stdin
258+ bracket_ (hSetEcho stdin showEcho) (hSetEcho stdin prevEcho) f
285259
286260data KeytoolConfig = KeytoolConfig
287261 { _keytoolConfig_keystore :: FilePath
@@ -294,16 +268,19 @@ instance FromJSON KeytoolConfig
294268instance ToJSON KeytoolConfig
295269
296270createKeystore :: 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− ]
271+createKeystore root config = do
272+ let expr = "with (import " <> toImplDir root <> ").reflex-platform.nixpkgs; pkgs.mkShell { buildInputs = [ pkgs.jdk ]; }"
273+ callProcessAndLogOutput (Notice,Notice) $ (proc "nix-shell" ["-E" , expr, "--run" , keytoolCmd]) { cwd = Just root }
274+ where
275+ keytoolCmd = processToShellString "keytool"
276+ [ "-genkeypair", "-noprompt"
277+ , "-keystore", _keytoolConfig_keystore config
278+ , "-keyalg", "RSA", "-keysize", "2048"
279+ , "-validity", "1000000000"
280+ , "-storepass", _keytoolConfig_storepass config
281+ , "-alias", _keytoolConfig_alias config
282+ , "-keypass", _keytoolConfig_keypass config
283+ ]
307284
308285-- | Simplified deployment configuration mechanism. At one point we may revisit this.
309286writeDeployConfig :: MonadObelisk m => FilePath -> FilePath -> String -> m ()
@@ -315,7 +292,7 @@ readDeployConfig deployDir fname = liftIO $ do
315292
316293verifyHostKey :: MonadObelisk m => FilePath -> FilePath -> String -> m ()
317294verifyHostKey knownHostsPath keyPath hostName =
318− callProcessAndLogOutput (Notice, Warning) $ proc sshPath $
295+ callProcessAndLogOutput (Notice, Warning) $ proc "ssh" $
319296 sshArgs knownHostsPath keyPath True <>
320297 [ "root@" <> hostName
321298 , "-o", "NumberOfPasswordPrompts=0"
lib/command/src/Obelisk/Command/Nix.hs+27−67
@@ -9,33 +9,22 @@
99{-# LANGUAGE TemplateHaskell #-}
1010{-# LANGUAGE TypeApplications #-}
1111module Obelisk.Command.Nix
12− ( Arg (..)
13− , NixBuildConfig (..)
14− , nixBuildConfig_common
15− , nixBuildConfig_outLink
12+ ( nixCmd
1613 , NixCmd (..)
14+ , nixCmdConfig_target
1715 , nixCmdConfig_args
1816 , nixCmdConfig_builders
19− , nixCmdConfig_target
20− , NixCommonConfig (..)
17+ , NixBuildConfig (..)
18+ , nixBuildConfig_common
19+ , nixBuildConfig_outLink
2120 , NixInstantiateConfig (..)
2221 , nixInstantiateConfig_eval
23− , NixShellConfig (..)
24− , nixShellConfig_common
25− , nixShellConfig_pure
26− , nixShellConfig_run
27− , OutLink (..)
22+ , NixCommonConfig (..)
2823 , Target (..)
29− , target_attr
30− , target_expr
31− , target_path
32−
24+ , OutLink (..)
25+ , Arg (..)
3326 , boolArg
34− , nixCmd
35− , nixCmdProc
36− , nixCmdProc'
3727 , rawArg
38− , runNixShellConfig
3928 , strArg
4029 ) where
4130
@@ -48,6 +37,7 @@ import Data.List (intercalate)
4837import Data.Maybe
4938import Data.Monoid ((<>))
5039import qualified Data.Text as T
40+import System.Process (proc)
5141
5242import Obelisk.App (MonadObelisk)
5343import Obelisk.CliApp
@@ -73,10 +63,10 @@ data Arg
7363 deriving (Eq, Show)
7464
7565strArg :: String -> String -> Arg
76−strArg = Arg_Str
66+strArg k = Arg_Str k
7767
7868rawArg :: String -> String -> Arg
79−rawArg = Arg_Expr
69+rawArg k = Arg_Expr k
8070
8171boolArg :: String -> Bool -> Arg
8272boolArg k = Arg_Expr k . bool "false" "true"
@@ -96,7 +86,7 @@ makeClassy ''NixCommonConfig
9686instance Default NixCommonConfig where
9787 def = NixCommonConfig def mempty mempty
9888
99−runNixCommonConfig :: NixCommonConfig -> [String]
89+runNixCommonConfig :: NixCommonConfig -> [FilePath]
10090runNixCommonConfig cfg = mconcat [maybeToList path, attrArg, exprArg, args, buildersArg]
10191 where
10292 path = _target_path $ _nixCmdConfig_target cfg
@@ -134,7 +124,7 @@ instance HasNixCommonConfig NixBuildConfig where
134124instance Default NixBuildConfig where
135125 def = NixBuildConfig def def
136126
137−runNixBuildConfig :: NixBuildConfig -> [String]
127+runNixBuildConfig :: NixBuildConfig -> [FilePath]
138128runNixBuildConfig cfg = mconcat
139129 [ runNixCommonConfig $ cfg ^. nixCommonConfig
140130 , case _nixBuildConfig_outLink cfg of
@@ -155,26 +145,12 @@ instance HasNixCommonConfig NixInstantiateConfig where
155145instance Default NixInstantiateConfig where
156146 def = NixInstantiateConfig def False
157147
158−runNixInstantiateConfig :: NixInstantiateConfig -> [String]
148+runNixInstantiateConfig :: NixInstantiateConfig -> [FilePath]
159149runNixInstantiateConfig cfg = mconcat
160150 [ runNixCommonConfig $ cfg ^. nixCommonConfig
161151 , "--eval" <$ guard (_nixInstantiateConfig_eval cfg)
162152 ]
163153
164−data NixShellConfig = NixShellConfig
165− { _nixShellConfig_common :: NixCommonConfig
166− , _nixShellConfig_pure :: Bool
167− , _nixShellConfig_run :: Maybe String
168− }
169−
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−
178154data NixCmd
179155 = NixCmd_Build NixBuildConfig
180156 | NixCmd_Instantiate NixInstantiateConfig
@@ -182,43 +158,27 @@ data NixCmd
182158instance Default NixCmd where
183159 def = NixCmd_Build def
184160
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)
161+nixCmd :: MonadObelisk m => NixCmd -> m FilePath
162+nixCmd cmdCfg = withSpinner' ("Running " <> cmd <> desc) (Just $ const $ "Built " <> desc) $ do
163+ output <- readProcessAndLogStderr Debug $ proc (T.unpack cmd) $ options
164+ -- Remove final newline that Nix appends
165+ Just (outPath, '\n') <- pure $ T.unsnoc output
166+ pure $ T.unpack outPath
198167 where
199− (cmd, options) = case cmdCfg of
168+ (cmd, options, commonCfg) = case cmdCfg of
200169 NixCmd_Build cfg' ->
201170 ( "nix-build"
202171 , runNixBuildConfig cfg'
172+ , cfg' ^. nixCommonConfig
203173 )
204174 NixCmd_Instantiate cfg' ->
205175 ( "nix-instantiate"
206176 , runNixInstantiateConfig cfg'
177+ , cfg' ^. nixCommonConfig
207178 )
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
220179 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)
180+ desc = T.pack $ mconcat $ catMaybes
181+ [ (" on " <>) <$> path
182+ , (\a -> " [" <> a <> "]") <$> (commonCfg ^. nixCmdConfig_target . target_attr)
224183 ]
184+
lib/command/src/Obelisk/Command/Preprocessor.hsdeleted−100
@@ -1,100 +0,0 @@
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+66−202
@@ -3,56 +3,37 @@
33{-# LANGUAGE OverloadedStrings #-}
44module Obelisk.Command.Project
55 ( InitSource (..)
6+ , initProject
67 , findProjectObeliskCommand
78 , findProjectRoot
8− , findProjectAssets
9− , initProject
10− , nixShellRunConfig
11− , nixShellRunProc
12− , nixShellWithHoogle
13− , nixShellWithoutPkgs
14− , obeliskDirName
15− , toImplDir
16− , toObeliskDir
179 , withProjectRoot
18− , bashEscape
10+ , inProjectShell
11+ , inImpureProjectShell
12+ , projectShell
13+
14+ , toObeliskDir
15+ , toImplDir
1916 ) where
2017
21−import Control.Concurrent.MVar (MVar, newMVar, withMVarMasked)
22−import Control.Lens ((.~), (?~), (<&>))
2318import Control.Monad
2419import Control.Monad.IO.Class (liftIO)
2520import Control.Monad.State
26−import qualified Data.Aeson as Json
27−import qualified Data.ByteString.UTF8 as BSU
2821import Data.Bits
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)
22+import Data.Function (on)
3423import qualified Data.Text as T
35−import Data.Text.Encoding (decodeUtf8, encodeUtf8)
36−import Data.Traversable (for)
3724import System.Directory
38−import System.Environment (lookupEnv)
3925import System.FilePath
4026import System.IO.Temp
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)
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, delegate_ctlc)
4630
4731import GitHub.Data.GitData (Branch)
4832import GitHub.Data.Name (Name)
4933
5034import Obelisk.App (MonadObelisk)
5135import Obelisk.CliApp
52−import Obelisk.Command.Nix
5336import Obelisk.Command.Thunk
54−import Obelisk.Command.Utils (nixBuildExePath, nixExePath, toNixPath, cp, nixShellPath)
55−
5637--TODO: Make this module resilient to random exceptions
5738
5839--TODO: Don't hardcode this
@@ -66,21 +47,17 @@ obeliskSourceWithBranch branch = ThunkSource_GitHub $ GitHubSource
6647 { _gitHubSource_owner = "obsidiansystems"
6748 , _gitHubSource_repo = "obelisk"
6849 , _gitHubSource_branch = Just branch
69− , _gitHubSource_private = False
7050 }
7151
7252data InitSource
73− = InitSource_Default
74− | InitSource_Branch (Name Branch)
75− | InitSource_Symlink FilePath
76− deriving Show
77−
78−obeliskDirName :: FilePath
79−obeliskDirName = ".obelisk"
53+ = InitSource_Default
54+ | InitSource_Branch (Name Branch)
55+ | InitSource_Symlink FilePath
56+ deriving Show
8057
8158-- | Path to obelisk directory in given path
8259toObeliskDir :: FilePath -> FilePath
83−toObeliskDir p = p </> obeliskDirName
60+toObeliskDir p = p </> ".obelisk"
8461
8562-- | Path to impl file in given path
8663toImplDir :: FilePath -> FilePath
@@ -97,26 +74,20 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
9774 | otherwise -> failWith "ob init requires an empty directory. Use the flag --force to init anyway, potentially overwriting files."
9875 skeleton <- withSpinner "Setting up obelisk" $ do
9976 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]
10777 case source of
108− InitSource_Default -> cloneAndRepack obeliskSource
109− InitSource_Branch branch -> cloneAndRepack $ obeliskSourceWithBranch branch
78+ InitSource_Default -> createThunkWithLatest implDir obeliskSource
79+ InitSource_Branch branch -> createThunkWithLatest implDir $ obeliskSourceWithBranch branch
11080 InitSource_Symlink path -> do
11181 let symlinkPath = if isAbsolute path
11282 then path
11383 else ".." </> path
11484 liftIO $ createSymbolicLink symlinkPath implDir
11585 _ <- nixBuildAttrWithCache implDir "command"
86+ --TODO: We should probably handoff to the impl here
11687 skel <- nixBuildAttrWithCache implDir "skeleton" --TODO: I don't think there's actually any reason to cache this
11788
11889 callProcessAndLogOutput (Notice, Error) $
119− proc cp
90+ proc "cp"
12091 [ "-r"
12192 , "--preserve=links"
12293 , obDir
@@ -126,7 +97,7 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
12697
12798 withSpinner "Copying project skeleton" $ do
12899 callProcessAndLogOutput (Notice, Error) $
129− proc cp
100+ proc "cp"
130101 [ "-r"
131102 , "--no-preserve=mode"
132103 , "-T"
@@ -137,46 +108,21 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
137108 let configDir = "config"
138109 createDirectoryIfMissing False configDir
139110 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))
164111
165112--TODO: Allow the user to ignore our security concerns
166113-- | Find the Obelisk implementation for the project at the given path
167114findProjectObeliskCommand :: MonadObelisk m => FilePath -> m (Maybe FilePath)
168115findProjectObeliskCommand target = do
169116 myUid <- liftIO getRealUserID
170− processUmask <- liftIO getUmask
171117 targetStat <- liftIO $ getFileStatus target
172− (result, insecurePaths) <- flip runStateT [] $ walkToProjectRoot target targetStat processUmask myUid >>= \case
118+ (result, insecurePaths) <- flip runStateT [] $ walkToProjectRoot target targetStat myUid >>= \case
173119 Nothing -> pure Nothing
174120 Just projectRoot -> liftIO (doesDirectoryExist $ toImplDir projectRoot) >>= \case
175121 False -> do
176122 putLog Warning $ "Found obelisk directory in " <> T.pack projectRoot <> " but the implementation (impl) file is missing"
177123 pure Nothing
178124 True -> do
179− walkToImplDir projectRoot myUid processUmask -- For security check
125+ walkToImplDir projectRoot myUid -- For security check
180126 return $ Just projectRoot
181127 case (result, insecurePaths) of
182128 (Just projDir, []) -> do
@@ -187,37 +133,17 @@ findProjectObeliskCommand target = do
187133 putLog Error $ T.unlines
188134 [ "Error: Found a project at " <> T.pack (normalise projDir) <> ", but had to traverse one or more insecure directories to get there:"
189135 , T.unlines $ fmap (T.pack . normalise) insecurePaths
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."
136+ , "Please ensure that all of these directories are owned by you and are not writable by anyone else."
191137 ]
192138 return Nothing
193139
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−
213140-- | Get the FilePath to the containing project directory, if there is one
214141findProjectRoot :: MonadObelisk m => FilePath -> m (Maybe FilePath)
215142findProjectRoot target = do
216143 myUid <- liftIO getRealUserID
217144 targetStat <- liftIO $ getFileStatus target
218− umask <- liftIO getUmask
219− (result, _) <- liftIO $ runStateT (walkToProjectRoot target targetStat umask myUid) []
220− return $ makeRelative "." <$> result
145+ (result, _) <- liftIO $ runStateT (walkToProjectRoot target targetStat myUid) []
146+ return result
221147
222148withProjectRoot :: MonadObelisk m => FilePath -> (FilePath -> m a) -> m a
223149withProjectRoot target f = findProjectRoot target >>= \case
@@ -229,15 +155,15 @@ withProjectRoot target f = findProjectRoot target >>= \case
229155-- traversed in the process. Return the project root directory, if found.
230156walkToProjectRoot
231157 :: (MonadState [FilePath] m, MonadIO m)
232− => FilePath -> FileStatus -> FileMode -> UserID -> m (Maybe FilePath)
233−walkToProjectRoot this thisStat desiredUmask myUid = liftIO (doesDirectoryExist this) >>= \case
158+ => FilePath -> FileStatus -> UserID -> m (Maybe FilePath)
159+walkToProjectRoot this thisStat myUid = liftIO (doesDirectoryExist this) >>= \case
234160 -- It's not a directory, so it can't be a project
235161 False -> do
236162 let dir = takeDirectory this
237163 dirStat <- liftIO $ getFileStatus dir
238− walkToProjectRoot dir dirStat desiredUmask myUid
164+ walkToProjectRoot dir dirStat myUid
239165 True -> do
240− when (not $ isWellOwnedAndWellPermissioned thisStat myUid desiredUmask) $ modify (this:)
166+ when (not $ isWritableOnlyBy thisStat myUid) $ modify (this:)
241167 liftIO (doesDirectoryExist $ toObeliskDir this) >>= \case
242168 True -> return $ Just this
243169 False -> do
@@ -247,109 +173,47 @@ walkToProjectRoot this thisStat desiredUmask myUid = liftIO (doesDirectoryExist
247173 isSameFileAs = (==) `on` fileIdentity
248174 if thisStat `isSameFileAs` nextStat
249175 then return Nothing -- Found a cycle; probably hit root directory
250− else walkToProjectRoot next nextStat desiredUmask myUid
176+ else walkToProjectRoot next nextStat myUid
251177
252178-- | Walk from the given project root directory to its Obelisk implementation
253179-- directory, accumulating potentially insecure directories that were traversed
254180-- in the process.
255−walkToImplDir :: (MonadState [FilePath] m, MonadIO m) => FilePath -> UserID -> FileMode -> m ()
256−walkToImplDir projectRoot myUid umask = do
181+walkToImplDir :: (MonadState [FilePath] m, MonadIO m) => FilePath -> UserID -> m ()
182+walkToImplDir projectRoot myUid = do
257183 let obDir = toObeliskDir projectRoot
258184 obDirStat <- liftIO $ getFileStatus obDir
259− when (not $ isWellOwnedAndWellPermissioned obDirStat myUid umask) $ modify (obDir:)
185+ when (not $ isWritableOnlyBy obDirStat myUid) $ modify (obDir:)
260186 let implThunk = obDir </> "impl"
261187 implThunkStat <- liftIO $ getFileStatus implThunk
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"]
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" $ setCtlc $ 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+setCtlc :: CreateProcess -> CreateProcess
216+setCtlc cfg = cfg { delegate_ctlc = True }
217+
218+setCwd :: Maybe FilePath -> CreateProcess -> CreateProcess
219+setCwd fp cfg = cfg { cwd = fp }
lib/command/src/Obelisk/Command/Run.hs+148−497
@@ -1,554 +1,205 @@
1−{-# LANGUAGE DeriveFoldable #-}
2−{-# LANGUAGE DeriveFunctor #-}
3−{-# LANGUAGE DeriveTraversable #-}
41{-# LANGUAGE FlexibleContexts #-}
52{-# LANGUAGE LambdaCase #-}
63{-# LANGUAGE MultiParamTypeClasses #-}
74{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE QuasiQuotes #-}
95{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TupleSections #-}
11−{-# LANGUAGE ViewPatterns #-}
126module Obelisk.Command.Run where
137
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)
8+import Control.Exception (bracket)
9+import Control.Monad
1910import Control.Monad.IO.Class (liftIO)
2011import Control.Monad.Reader (MonadIO)
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)
12+import Data.Either
13+import Data.List
14+import Data.List.NonEmpty as NE
15+import Data.Maybe
4016import 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(..))
4617import Distribution.PackageDescription.Parsec (parseGenericPackageDescription)
4718import Distribution.Parsec.ParseResult (runParseResult)
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
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 hiding (Debug)
6030import System.Directory
61−import System.Environment (getExecutablePath)
6231import System.FilePath
63−import qualified System.Info
32+import System.Process (proc)
6433import System.IO.Temp (withSystemTempDirectory)
34+import Data.ByteString (ByteString)
6535
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)
36+import Obelisk.App (MonadObelisk, ObeliskT)
37+import Obelisk.CliApp
38+ ( CliT (..), HasCliConfig, Severity (..)
39+ , callCommand, failWith, getCliConfig, putLog
40+ , readProcessAndLogStderr, runCli)
41+import Obelisk.Command.Project (inProjectShell, withProjectRoot)
8342
8443data CabalPackageInfo = CabalPackageInfo
85− { _cabalPackageInfo_packageFile :: FilePath
86− , _cabalPackageInfo_packageName :: T.Text
87− , _cabalPackageInfo_packageRoot :: FilePath
88− , _cabalPackageInfo_buildable :: Bool
44+ { _cabalPackageInfo_packageRoot :: FilePath
8945 , _cabalPackageInfo_sourceDirs :: NE.NonEmpty FilePath
9046 -- ^ List of hs src dirs of the library component
9147 , _cabalPackageInfo_defaultExtensions :: [Extension]
9248 -- ^ 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)
9949 }
10050
101−-- | 'Bool' with a better name for its purpose.
102−data Interpret = Interpret_Interpret | Interpret_NoInterpret deriving (Eq, Ord, Show)
103−
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"
51+-- NOTE: `run` is not polymorphic like the rest because we use StaticPtr to invoke it.
52+run :: ObeliskT IO ()
53+run = do
54+ pkgs <- getLocalPkgs
55+ withGhciScript pkgs $ \dotGhciPath -> do
56+ freePort <- getFreePort
57+ assets <- withProjectRoot "." $ \root ->
58+ -- `--raw` is not available with old nix-instantiate. It drops quotation
59+ -- marks and trailing newline, so is very convenient for shelling out.
60+ readProcessAndLogStderr Debug $
61+ proc "nix" ["eval", "-f", root, "passthru.staticFilesImpure", "--raw"]
62+ putLog Debug $ "Assets impurely loaded from: " <> assets
63+ runGhcid dotGhciPath $ Just $ unwords
64+ [ "run"
17365 , show freePort
174− , "(Obelisk.Run.runServeAsset " ++ show assets ++ ")"
66+ , "(runServeAsset " ++ show assets ++ ")"
17567 , "Backend.backend"
17668 , "Frontend.frontend"
17769 ]
17870
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
71+runRepl :: MonadObelisk m => m ()
72+runRepl = do
73+ pkgs <- getLocalPkgs
74+ withGhciScript pkgs $ \dotGhciPath -> do
75+ runGhciRepl dotGhciPath
20276
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
77+runWatch :: MonadObelisk m => m ()
78+runWatch = do
79+ pkgs <- getLocalPkgs
80+ withGhciScript pkgs $ \dotGhciPath -> runGhcid dotGhciPath Nothing
20681
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"]
82+-- | Relative paths to local packages of an obelisk project
83+-- TODO a way to query this
84+getLocalPkgs :: Applicative f => f [FilePath]
85+getLocalPkgs = pure ["backend", "common", "frontend"]
21686
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.
30187parseCabalPackage
302− :: MonadObelisk m
303− => FilePath -- ^ Package directory
88+ :: (MonadObelisk m)
89+ => FilePath -- ^ package directory
30490 -> m (Maybe CabalPackageInfo)
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− ]
91+parseCabalPackage dir = do
92+ let cabalFp = dir </> (takeBaseName dir <> ".cabal")
93+ hpackFp = dir </> "package.yaml"
94+ hasCabal <- liftIO $ doesFileExist cabalFp
95+ hasHpack <- liftIO $ doesFileExist hpackFp
96+
97+ mCabalContents <- if hasCabal
98+ then Just <$> liftIO (readUTF8File cabalFp)
99+ else if hasHpack
100+ then do
101+ let decodeOptions = DecodeOptions hpackFp Nothing decodeYaml
102+ liftIO (readPackageConfig decodeOptions) >>= \case
103+ Left err -> do
104+ putLog Error $ T.pack $ "Failed to parse " <> hpackFp <> ": " <> err
105+ return Nothing
106+ Right (DecodeResult hpackPackage _ _) -> do
107+ return $ Just $ renderPackage [] hpackPackage
108+ else return Nothing
109+
110+ fmap join $ forM mCabalContents $ \cabalContents -> do
111+ let (warnings, result) = runParseResult $ parseGenericPackageDescription $
112+ toUTF8BS $ cabalContents
113+ mapM_ (putLog Warning) $ fmap (T.pack . show) warnings
114+ case result of
115+ Right gpkg -> do
116+ return $ do
117+ (_, lib) <- simplifyCondTree (const $ pure True) <$> condLibrary gpkg
118+ pure $ CabalPackageInfo
119+ { _cabalPackageInfo_packageRoot = takeDirectory cabalFp
120+ , _cabalPackageInfo_sourceDirs =
121+ fromMaybe (pure ".") $ NE.nonEmpty $ hsSourceDirs $ libBuildInfo lib
122+ , _cabalPackageInfo_defaultExtensions =
123+ defaultExtensions $ libBuildInfo lib
124+ }
125+ Left (_, errors) -> do
126+ putLog Error $ T.pack $ "Failed to parse " <> cabalFp <> ":"
127+ mapM_ (putLog Error) $ fmap (T.pack . show) errors
128+ return Nothing
129+
130+withUTF8FileContentsM :: (MonadIO m, HasCliConfig e m) => FilePath -> (ByteString -> CliT e IO a) -> m a
131+withUTF8FileContentsM fp f = do
132+ c <- getCliConfig
133+ liftIO $ withUTF8FileContents fp $ runCli c . f . toUTF8BS
411134
412135-- | Create ghci configuration to load the given packages
413136withGhciScript
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
137+ :: MonadObelisk m
138+ => [FilePath] -- ^ List of packages to load into ghci
139+ -> (FilePath -> m ()) -- ^ Action to run with the path to generated temporory .ghci
418140 -> m ()
419−withGhciScript preCommands (toList -> packageInfos) f =
141+withGhciScript pkgs f = do
142+ (pkgDirErrs, packageInfos) <- fmap partitionEithers $ forM pkgs $ \pkg -> do
143+ flip fmap (parseCabalPackage pkg) $ \case
144+ Nothing -> Left pkg
145+ Just packageInfo -> Right packageInfo
146+
147+ when (null packageInfos) $
148+ failWith $ T.pack $ "No valid pkgs found in " <> intercalate ", " pkgs
149+ unless (null pkgDirErrs) $
150+ putLog Warning $ T.pack $ "Failed to find pkgs in " <> intercalate ", " pkgDirErrs
151+
152+ let extensions = packageInfos >>= _cabalPackageInfo_defaultExtensions
153+ extensionsLine = if extensions == mempty
154+ then ""
155+ else ":set " <> intercalate " " ((("-X" <>) . prettyShow) <$> extensions)
156+ dotGhci = unlines $
157+ [ ":set -i" <> intercalate ":" (packageInfos >>= rootedSourceDirs)
158+ , extensionsLine
159+ , ":load Backend Frontend"
160+ , "import Obelisk.Run"
161+ , "import qualified Frontend"
162+ , "import qualified Backend"
163+ ]
420164 withSystemTempDirectory "ob-ghci" $ \fp -> do
421165 let dotGhciPath = fp </> ".ghci"
422166 liftIO $ writeFile dotGhciPath dotGhci
423167 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
453168
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)
458−
459− pure
460− $ baseGhciOptions
461− <> ["-F", "-pgmF", selfExe, "-optF", preprocessorIdentifier]
462− <> concatMap (\p -> ["-optF", p]) pkgFiles
463− <> [ "-i" <> intercalate ":" (concatMap toList pkgSrcPaths) ]
464169 where
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− ]
170+ rootedSourceDirs pkg = NE.toList $
171+ (_cabalPackageInfo_packageRoot pkg </>) <$> _cabalPackageInfo_sourceDirs pkg
473172
474173-- | Run ghci repl
475174runGhciRepl
476− :: (MonadObelisk m, Foldable f)
477− => FilePath -- ^ Path to project root
478− -> f CabalPackageInfo -- ^ Packages to keep unbuilt
479− -> [String] -- ^ GHCi arguments
175+ :: MonadObelisk m
176+ => FilePath -- ^ Path to .ghci
480177 -> m ()
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
178+runGhciRepl dotGhci = inProjectShell "ghc" $ unwords $ "ghci" : ["-no-user-package-db", "-ghci-script", dotGhci]
486179
487180-- | Run ghcid
488181runGhcid
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
182+ :: MonadObelisk m
183+ => FilePath -- ^ Path to .ghci
494184 -> Maybe String -- ^ Optional command to run at every reload
495185 -> m ()
496−runGhcid root chdirToRoot ghciArgs (toList -> packages) mcmd =
497− nixShellWithoutPkgs root True chdirToRoot (packageInfoToNamePathMap packages) "ghc" $
498− Just $ unwords $ fmap bashEscape $ ghcidExePath : opts
186+runGhcid dotGhci mcmd = callCommand $ unwords $ "ghcid" : opts
499187 where
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
188+ opts =
189+ [ "-W"
190+ --TODO: The decision of whether to use -fwarn-redundant-constraints should probably be made by the user
191+ , "--command='ghci -Wall -ignore-dot-ghci -fwarn-redundant-constraints -no-user-package-db -ghci-script " <> dotGhci <> "' "
192+ , "--reload=config"
193+ , "--outputfile=ghcid-output.txt"
194+ ] <> testCmd
195+ testCmd = maybeToList (flip fmap mcmd $ \cmd -> "--test='" <> cmd <> "'")
196+
197+getFreePort :: MonadIO m => m PortNumber
198+getFreePort = liftIO $ withSocketsDo $ do
199+ addr:_ <- getAddrInfo (Just defaultHints) (Just "127.0.0.1") (Just "0")
200+ bracket (open addr) close socketPort
516201 where
517202 open addr = do
518− sock <- Socket.socket (Socket.addrFamily addr) (Socket.addrSocketType addr) (Socket.addrProtocol addr)
519− Socket.bind sock (Socket.addrAddress addr)
203+ sock <- socket (addrFamily addr) (addrSocketType addr) (addrProtocol addr)
204+ bind sock (addrAddress addr)
520205 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+363−614
@@ -5,59 +5,72 @@
55{-# LANGUAGE MultiWayIf #-}
66{-# LANGUAGE OverloadedStrings #-}
77{-# LANGUAGE PatternGuards #-}
8−{-# LANGUAGE QuasiQuotes #-}
98{-# LANGUAGE ScopedTypeVariables #-}
109{-# LANGUAGE TypeApplications #-}
11−module Obelisk.Command.Thunk where
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
1233
1334import Control.Applicative
1435import Control.Exception (displayException, try)
15−import Control.Lens (ifor, ifor_, (.~))
36+import qualified Control.Lens as Lens
37+import Control.Lens.Indexed hiding ((<.>))
1638import Control.Monad
17−import Control.Monad.Extra (findM)
18−import Control.Monad.Catch (MonadCatch, handle)
39+import Control.Monad.Catch (handle)
1940import Control.Monad.Except
2041import Data.Aeson ((.=))
2142import qualified Data.Aeson as Aeson
2243import Data.Aeson.Encode.Pretty
2344import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
2545import qualified Data.ByteString.Lazy as LBS
26−import Data.Containers.ListUtils (nubOrd)
2746import Data.Default
2847import Data.Either.Combinators (fromRight', rightToMaybe)
29−import Data.Foldable (toList)
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
3248import Data.Git.Ref (Ref)
3349import qualified Data.Git.Ref as Ref
3450import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
51+import Data.List.NonEmpty (NonEmpty (..))
3652import qualified Data.List.NonEmpty as NonEmpty
3753import Data.Map (Map)
3854import qualified Data.Map as Map
3955import Data.Maybe
4056import Data.Set (Set)
4157import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
4458import Data.Text (Text)
4559import qualified Data.Text as T
4660import Data.Text.Encoding
4761import qualified Data.Text.IO as T
4862import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
5063import Data.Yaml (parseMaybe)
5164import GitHub
5265import GitHub.Data.Name
5366import Obelisk.Command.Nix
5467import System.Directory
55−import System.Exit
5668import System.FilePath
5769import System.IO.Error
5870import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
60−import qualified Text.URI as URI
71+import System.Posix (getSymbolicLinkStatus, modificationTime)
72+import System.Process (proc)
73+import Text.URI
6174
6275import Obelisk.App (MonadObelisk)
6376import Obelisk.CliApp
@@ -65,10 +78,11 @@ import Obelisk.Command.Utils
6578
6679--TODO: Support symlinked thunk data
6780data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
81+ = ThunkData_Packed ThunkPtr
6982 -- ^ Packed thunk
70− | ThunkData_Checkout
83+ | ThunkData_Checkout (Maybe ThunkPtr)
7184 -- ^ Checked out thunk that was unpacked from this pointer
85+ deriving (Show, Eq, Ord)
7286
7387-- | A reference to the exact data that a thunk should translate into
7488data ThunkPtr = ThunkPtr
@@ -81,7 +95,7 @@ type NixSha256 = Text --TODO: Use a smart constructor and make this actually ver
8195
8296-- | A specific revision of data; it may be available from multiple sources
8397data ThunkRev = ThunkRev
84− { _thunkRev_commit :: Ref Ref.SHA1
98+ { _thunkRev_commit :: Ref
8599 , _thunkRev_nixSha256 :: NixSha256
86100 }
87101 deriving (Show, Eq, Ord)
@@ -94,72 +108,41 @@ data ThunkSource
94108 | ThunkSource_Git GitSource
95109 deriving (Show, Eq, Ord)
96110
97−thunkSourceToGitSource :: ThunkSource -> GitSource
98−thunkSourceToGitSource = \case
99− ThunkSource_GitHub s -> forgetGithub False s
100− ThunkSource_Git s -> s
101−
102111data GitHubSource = GitHubSource
103112 { _gitHubSource_owner :: Name Owner
104113 , _gitHubSource_repo :: Name Repo
105114 , _gitHubSource_branch :: Maybe (Name Branch)
106− , _gitHubSource_private :: Bool
107115 }
108116 deriving (Show, Eq, Ord)
109117
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−
119118data GitSource = GitSource
120− { _gitSource_url :: GitUri
119+ { _gitSource_url :: URI
121120 , _gitSource_branch :: Maybe (Name Branch)
122121 , _gitSource_fetchSubmodules :: Bool
123− , _gitSource_private :: Bool
124122 }
125123 deriving (Show, Eq, Ord)
126124
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−
141125-- | Convert a GitHub source to a regular Git source. Assumes no submodules.
142126forgetGithub :: Bool -> GitHubSource -> GitSource
143127forgetGithub useSsh s = GitSource
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
128+ { _gitSource_url = URI
129+ { uriScheme = Just $ fromRight' $ mkScheme $ if useSsh then "ssh" else "https"
130+ , uriAuthority = Right $ Authority
131+ { authUserInfo = UserInfo (fromRight' $ mkUsername "git") Nothing
148132 <$ guard useSsh
149− , URI.authHost = fromRight' $ URI.mkHost "github.com"
150− , URI.authPort = Nothing
133+ , authHost = fromRight' $ mkHost "github.com"
134+ , authPort = Nothing
151135 }
152− , URI.uriPath = Just ( False
153− , fromRight' . URI.mkPathPiece <$>
136+ , uriPath = Just ( False
137+ , fromRight' . mkPathPiece <$>
154138 untagName (_gitHubSource_owner s)
155139 :| [ untagName (_gitHubSource_repo s) <> ".git" ]
156140 )
157− , URI.uriQuery = []
158− , URI.uriFragment = Nothing
141+ , uriQuery = []
142+ , uriFragment = Nothing
159143 }
160144 , _gitSource_branch = _gitHubSource_branch s
161145 , _gitSource_fetchSubmodules = False
162− , _gitSource_private = _gitHubSource_private s
163146 }
164147
165148getThunkGitBranch :: ThunkPtr -> Maybe Text
@@ -167,26 +150,26 @@ getThunkGitBranch (ThunkPtr _ src) = fmap untagName $ case src of
167150 ThunkSource_GitHub s -> _gitHubSource_branch s
168151 ThunkSource_Git s -> _gitSource_branch s
169152
170−commitNameToRef :: Name Commit -> Ref Ref.SHA1
153+commitNameToRef :: Name Commit -> Ref
171154commitNameToRef (N c) = Ref.fromHex $ encodeUtf8 c
172155
173156-- TODO: Use spinner here.
174157getNixSha256ForUriUnpacked
175158 :: MonadObelisk m
176− => GitUri
159+ => URI
177160 -> m NixSha256
178161getNixSha256ForUriUnpacked uri =
179− withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
162+ withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> render uri) $ do
180163 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
164+ proc "nix-prefetch-url" ["--unpack" , "--type" , "sha256" , T.unpack $ render uri]
182165 pure hash
183166
184−nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
167+nixPrefetchGit :: MonadObelisk m => URI -> Text -> Bool -> m NixSha256
185168nixPrefetchGit uri rev fetchSubmodules =
186− withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
169+ withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> render uri <> " at " <> rev) $ do
187170 out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
189− [ "--url", T.unpack $ gitUriToText uri
171+ proc "nix-prefetch-git" $ filter (/="")
172+ [ "--url", T.unpack $ render uri
190173 , "--rev", T.unpack rev
191174 , if fetchSubmodules then "--fetch-submodules" else ""
192175 , "--quiet"
@@ -198,117 +181,93 @@ nixPrefetchGit uri rev fetchSubmodules =
198181
199182--TODO: Pretty print these
200183data ReadThunkError
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)
184+ = ReadThunkError_UnrecognizedFiles
185+ | ReadThunkError_AmbiguousFiles
186+ | ReadThunkError_UnrecognizedLoader Text
187+ | ReadThunkError_UnparseablePtr LBS.ByteString
188+ deriving (Show)
189+
190+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
191+-- If the thunk is packed and additional data is present, fail.
192+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
193+readThunk thunkDir = do
194+ files <- liftIO $ listDirectory thunkDir
195+ case ".git" `elem` files of
196+ True -> fmap ThunkData_Checkout <$> do
197+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
198+ liftIO $ doesDirectoryExist origThunkPath >>= \case
199+ True -> fmap Just <$> readPackedThunk origThunkPath
200+ False -> return $ return Nothing
201+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
202+
203+data ThunkType = ThunkType
204+ { _thunkType_loader :: FilePath
205+ , _thunkType_json :: FilePath
206+ , _thunkType_optional :: Set FilePath
207+ , _thunkType_loaderVersions :: NonEmpty Text
208+ , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
228209 }
229210
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}|]
211+gitHubThunkType :: ThunkType
212+gitHubThunkType = ThunkType
213+ { _thunkType_loader = "default.nix"
214+ , _thunkType_json = "github.json"
215+ , _thunkType_optional = Set.fromList [".attr-cache"]
216+ , _thunkType_loaderVersions = gitHubStandaloneLoaders
217+ , _thunkType_parser = parseThunkPtr $ \v ->
218+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
219+ }
220+
221+gitThunkType :: ThunkType
222+gitThunkType = ThunkType
223+ { _thunkType_loader = "default.nix"
224+ , _thunkType_json = "git.json"
225+ , _thunkType_optional = Set.fromList [".attr-cache"]
226+ , _thunkType_loaderVersions = plainGitStandaloneLoaders
227+ , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
228+ }
229+
230+thunkTypes :: [ThunkType]
231+thunkTypes = [gitThunkType, gitHubThunkType]
232+
233+findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
234+findThunkType types thunkDir = do
235+ matches <- fmap catMaybes $ forM types $ \thunkType -> do
236+ let
237+ expectedContents = Set.fromList $ (thunkDir </>) <$>
238+ [ _thunkType_loader thunkType
239+ , _thunkType_json thunkType
240+ ]
241+ optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
242+
243+ -- Ensure that there aren't any other files in the thunk
244+ -- NB: System.Directory.listDirectory returns the contents without the directory path
245+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
246+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
247+ missingContents = expectedContents `Set.difference` files
248+ pure $ if Set.null unexpectedContents && Set.null missingContents
249+ then Just thunkType
250+ else Nothing
251+
252+ pure $ case matches of
253+ [singleMatch] -> Right singleMatch
254+ [] -> Left ReadThunkError_UnrecognizedFiles
255+ _ -> Left ReadThunkError_AmbiguousFiles
307256
308257-- | Read a thunk and validate that it is exactly a packed thunk.
309258-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311−readThunk = readThunkWith thunkSpecTypes
259+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
260+readPackedThunk thunkDir = runExceptT $ do
261+ thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
262+ -- Ensure that we recognize the thunk loader
263+ loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
264+ unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
265+ throwError $ ReadThunkError_UnrecognizedLoader loader
266+
267+ txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
268+ case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
269+ Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
270+ Just ptr -> return ptr
312271
313272parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314273parseThunkPtr parseSrc v = do
@@ -328,12 +287,10 @@ parseGitHubSource v = do
328287 owner <- v Aeson..: "owner"
329288 repo <- v Aeson..: "repo"
330289 branch <- v Aeson..:! "branch"
331− private <- v Aeson..:? "private"
332290 pure $ GitHubSource
333291 { _gitHubSource_owner = owner
334292 , _gitHubSource_repo = repo
335293 , _gitHubSource_branch = branch
336− , _gitHubSource_private = fromMaybe False private
337294 }
338295
339296parseGitSource :: Aeson.Object -> Aeson.Parser GitSource
@@ -341,29 +298,25 @@ parseGitSource v = do
341298 Just url <- parseGitUri <$> v Aeson..: "url"
342299 branch <- v Aeson..:! "branch"
343300 fetchSubmodules <- v Aeson..:! "fetchSubmodules"
344− private <- v Aeson..:? "private"
345301 pure $ GitSource
346302 { _gitSource_url = url
347303 , _gitSource_branch = branch
348304 , _gitSource_fetchSubmodules = fromMaybe False fetchSubmodules
349− , _gitSource_private = fromMaybe False private
350305 }
351306
352307overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353308overwriteThunk target thunk = do
354309 -- Ensure that this directory is a valid thunk (i.e. so we aren't losing any data)
355− readThunk target >>= \case
356− Left e -> failWith [i|Invalid thunk at ${target}: ${e}|]
357− Right _ -> pure ()
310+ Right _ <- readThunk target
358311
359312 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
361− createThunk target $ Right thunk
313+ liftIO $ removeDirectoryRecursive target
314+ liftIO $ createThunk target thunk
362315
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
316+thunkPtrLoader :: ThunkPtr -> Text
317+thunkPtrLoader thunk = case _thunkPtr_source thunk of
318+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
319+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
367320
368321-- It's important that formatting be very consistent here, because
369322-- otherwise when people update thunks, their patches will be messy
@@ -375,15 +328,13 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
375328 , ("branch" .=) <$> _gitHubSource_branch s
376329 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
377330 , Just $ "sha256" .= _thunkRev_nixSha256 rev
378− , Just $ "private" .= _gitHubSource_private s
379331 ]
380332 ThunkSource_Git s -> encodePretty' plainGitCfg $ Aeson.object $ catMaybes
381− [ Just $ "url" .= gitUriToText (_gitSource_url s)
333+ [ Just $ "url" .= render (_gitSource_url s)
382334 , Just $ "rev" .= Ref.toHexString (_thunkRev_commit rev)
383335 , ("branch" .=) <$> _gitSource_branch s
384336 , Just $ "sha256" .= _thunkRev_nixSha256 rev
385337 , Just $ "fetchSubmodules" .= _gitSource_fetchSubmodules s
386− , Just $ "private" .= _gitSource_private s
387338 ]
388339 where
389340 githubCfg = defConfig
@@ -404,84 +355,78 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
404355 [ "url"
405356 , "rev"
406357 , "sha256"
407− , "private"
408358 , "fetchSubmodules"
409359 ] <> compare
410360 , confTrailingNewline = True
411361 }
412362
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
363+createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
364+createThunk target thunk = liftIO $ do
365+ createDirectoryIfMissing True (target </> ".attr-cache")
366+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
367+ let
368+ jsonFileName = case _thunkPtr_source thunk of
369+ ThunkSource_GitHub _ -> "github"
370+ ThunkSource_Git _ -> "git"
371+ LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
428372
429373createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
430374createThunkWithLatest target s = do
431375 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
376+ createThunk target $ ThunkPtr
433377 { _thunkPtr_source = s
434378 , _thunkPtr_rev = rev
435379 }
436380
437−updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439− checkThunkDirectory target
381+updateThunkToLatest :: MonadObelisk m => FilePath -> Maybe String -> m ()
382+updateThunkToLatest target mBranch = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
383+ checkThunkDirectory "ob thunk update directory cannot be '.'" target
440384 -- check to see if thunk should be updated to a specific branch or just update it's current branch
441385 case mBranch of
442386 Nothing -> do
443387 (overwrite, ptr) <- readThunk target >>= \case
444− Left err -> failWith [i|Thunk update: ${err}|]
388+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
445389 Right c -> case c of
446− ThunkData_Packed _ t -> return (target, t)
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
390+ ThunkData_Packed t -> return (target, t)
391+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
448392 let src = _thunkPtr_source ptr
449393 rev <- getLatestRev src
450− overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
394+ overwriteThunk overwrite $ ThunkPtr
451395 { _thunkPtr_source = src
452396 , _thunkPtr_rev = rev
453397 }
454398 Just branch -> readThunk target >>= \case
455− Left err -> failWith [i|Thunk update: ${err}|]
399+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
456400 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
401+ ThunkData_Packed t -> case _thunkPtr_source t of
402+ ThunkSource_Git tsg -> setThunk target tsg branch
403+ ThunkSource_GitHub tsgh -> do
404+ let tsg = forgetGithub False tsgh
405+ setThunk target tsg branch
406+ ThunkData_Checkout _ -> failWith $ T.pack $ "thunk located at " <> (show target) <> " is unpacked. Use ob thunk pack on the desired directory and then try ob thunk update again."
407+
408+setThunk :: MonadObelisk m => FilePath -> GitSource -> String -> m ()
409+setThunk target gs branch = do
410+ newThunkPtr <- uriThunkPtr (_gitSource_url gs) (Just $ T.pack branch) Nothing
465411 overwriteThunk target newThunkPtr
466− updateThunkToLatest (ThunkUpdateConfig Nothing thunkConfig) target
412+ updateThunkToLatest target Nothing
467413
468414-- | All recognized github standalone loaders, ordered from newest to oldest.
469415-- This tool will only ever produce the newest one when it writes a thunk.
470−gitHubThunkSpecs :: NonEmpty ThunkSpec
471−gitHubThunkSpecs =
472− gitHubThunkSpecV5 :|
473− [ gitHubThunkSpecV4
474− , gitHubThunkSpecV3
475− , gitHubThunkSpecV2
476− , gitHubThunkSpecV1
416+gitHubStandaloneLoaders :: NonEmpty Text
417+gitHubStandaloneLoaders =
418+ gitHubStandaloneLoaderV2 :|
419+ [ gitHubStandaloneLoaderV3
420+ , gitHubStandaloneLoaderV1
477421 ]
478422
479−gitHubThunkSpecV1 :: ThunkSpec
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
423+gitHubStandaloneLoaderV1 :: Text
424+gitHubStandaloneLoaderV1 = T.unlines
425+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
426+ ]
482427
483−gitHubThunkSpecV2 :: ThunkSpec
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
428+gitHubStandaloneLoaderV2 :: Text
429+gitHubStandaloneLoaderV2 = T.unlines
485430 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486431 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487432 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,8 +436,8 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
491436 , "))"
492437 ]
493438
494−gitHubThunkSpecV3 :: ThunkSpec
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
439+gitHubStandaloneLoaderV3 :: Text
440+gitHubStandaloneLoaderV3 = T.unlines
496441 [ "# DO NOT HAND-EDIT THIS FILE"
497442 , "let"
498443 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -511,62 +456,22 @@ gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
511456 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
512457 ]
513458
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
459+plainGitStandaloneLoaders :: NonEmpty Text
460+plainGitStandaloneLoaders =
461+ plainGitStandaloneLoaderV1 :|
462+ [ plainGitStandaloneLoaderV2
558463 ]
559464
560−gitThunkSpecV1 :: ThunkSpec
561−gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
465+plainGitStandaloneLoaderV1 :: Text
466+plainGitStandaloneLoaderV1 = T.unlines
562467 [ "# DO NOT HAND-EDIT THIS FILE"
563468 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564469 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565470 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
566471 ]
567472
568−gitThunkSpecV2 :: ThunkSpec
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
473+plainGitStandaloneLoaderV2 :: Text
474+plainGitStandaloneLoaderV2 = T.unlines
570475 [ "# DO NOT HAND-EDIT THIS FILE"
571476 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572477 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -575,87 +480,10 @@ gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
575480 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
576481 ]
577482
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− ]
620−
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−
483+thunkFileNames :: [FilePath]
484+thunkFileNames = ["default.nix", "github.json", "git.json"]
656485
657−parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658−parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
486+--TODO: when checking something out, make a shallow clone
659487
660488-- | Checks a cache directory to see if there is a fresh symlink
661489-- to the result of building an attribute of a thunk.
@@ -663,49 +491,44 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663491-- and the result is symlinked into the cache.
664492nixBuildThunkAttrWithCache
665493 :: MonadObelisk m
666− => ThunkSpec
667− -> FilePath
494+ => FilePath
668495 -- ^ Path to directory containing Thunk
669496 -> String
670497 -- ^ Attribute to build
671− -> m (Maybe FilePath)
498+ -> m FilePath
672499 -- ^ Symlink to cached or built nix output
673500-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674501-- the caching mechanism will fail as it merely measures the modification
675502-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
503+nixBuildThunkAttrWithCache thunkDir attr = do
504+ --NB: Expects thunkDir to be normalised with no trailing path separator.
505+ --This should be guaranteed by the command argument parser.
506+ let cacheErrHandler e
507+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
508+ | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
509+ cacheDir = thunkDir </> ".attr-cache"
510+ cachePath = cacheDir </> attr <.> "out"
677511 latestChange <- liftIO $ do
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− }
512+ createDirectoryIfMissing False cacheDir
513+ let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
514+ maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
515+ cacheHit <- handle cacheErrHandler $ do
516+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
517+ return $ if latestChange <= cacheTime
518+ then Just cachePath
519+ else Nothing
520+ case cacheHit of
521+ Just c -> return c
522+ Nothing -> do
523+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
524+ _ <- nixCmd $ NixCmd_Build$ def
525+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
526+ Lens.& nixCmdConfig_target Lens..~ Target
527+ { _target_path = Just thunkDir
528+ , _target_attr = Just attr
529+ , _target_expr = Nothing
530+ }
531+ return cachePath
709532
710533-- | Build a nix attribute, and cache the result if possible
711534nixBuildAttrWithCache
@@ -716,15 +539,13 @@ nixBuildAttrWithCache
716539 -- ^ Attribute to build
717540 -> m FilePath
718541 -- ^ Symlink to cached or built nix output
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
542+nixBuildAttrWithCache exprPath attr = do
543+ readThunk exprPath >>= \case
544+ -- Only packed thunks are cached. in particular, checkouts are not
545+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
546+ _ -> nixCmd $ NixCmd_Build $ def
547+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
548+ Lens.& nixCmdConfig_target Lens..~ Target
728549 { _target_path = Just exprPath
729550 , _target_attr = Just attr
730551 , _target_expr = Nothing
@@ -745,144 +566,107 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
745566 where
746567 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
747568 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
748− Right ThunkData_Packed{} -> do
569+ Right (ThunkData_Packed _) -> do
749570 let tmpThunk = tmpDir </> "thunk"
750571 callProcessAndLogOutput (Notice, Error) $
751− proc cp ["-r", "-T", thunkDir, tmpThunk]
572+ proc "cp" ["-r", "-T", thunkDir, tmpThunk]
752573 return tmpThunk
753− Right _ -> failWith "Thunk is not packed"
574+ Right _ -> failWith $ "Thunk is not packed"
754575 updateThunkFromTmp p' = do
755− _ <- packThunk' True (ThunkPackConfig False (ThunkConfig Nothing)) p'
576+ _ <- packThunk' True p'
756577 callProcessAndLogOutput (Notice, Error) $
757− proc cp ["-r", "-T", p', p]
578+ proc "cp" ["-r", "-T", p', p]
758579
759580finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760581finalMsg noTrail s = if noTrail then Nothing else Just s
761582
583+unpackThunk :: MonadObelisk m => FilePath -> m ()
584+unpackThunk = unpackThunk' False
585+
762586-- | Check that we are not somewhere inside the thunk directory
763−checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764−checkThunkDirectory thunkDir = do
587+checkThunkDirectory :: MonadObelisk m => Text -> FilePath -> m ()
588+checkThunkDirectory msg thunkDir = do
765589 currentDir <- liftIO getCurrentDirectory
766590 thunkDir' <- liftIO $ canonicalizePath thunkDir
767− when (thunkDir' `L.isInfixOf` currentDir) $
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
591+ when (thunkDir' `L.isInfixOf` currentDir) $ failWith msg
778592
779593unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781− Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
594+unpackThunk' noTrail thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
595+ Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
782596 --TODO: Overwrite option that rechecks out thunk; force option to do so even if working directory is dirty
783− Right ThunkData_Checkout -> failWith [i|Thunk at ${thunkDir} is already unpacked|]
784− Right (ThunkData_Packed _ tptr) -> do
597+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
598+ Right (ThunkData_Packed tptr) -> do
785599 let (thunkParent, thunkName) = splitFileName thunkDir
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
600+ withTempDirectory thunkParent thunkName $ \tmpRepo -> do
601+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
602+ s = case _thunkPtr_source tptr of
603+ ThunkSource_GitHub s' -> forgetGithub False s'
604+ ThunkSource_Git s' -> s'
792605 withSpinner' ("Fetching thunk " <> T.pack thunkName)
793606 (finalMsg noTrail $ const $ "Fetched thunk " <> T.pack thunkName) $ do
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"]
607+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
608+ git $ [ "clone" ]
609+ ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
610+ ++ [ T.unpack $ render $ _gitSource_url s ]
611+ ++ do branch <- maybeToList $ _gitSource_branch s
612+ [ "--branch", T.unpack $ untagName branch ]
613+ git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
614+ when (_gitSource_fetchSubmodules s) $
615+ git ["submodule", "update", "--recursive", "--init"]
616+
617+ liftIO $ createDirectory obGitDir
618+ callProcessAndLogOutput (Notice, Error) $
619+ proc "cp" ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
620+ callProcessAndLogOutput (Notice, Error) $
621+ proc "rm" ["-r", thunkDir]
622+ callProcessAndLogOutput (Notice, Error) $
623+ proc "mv" ["-T", tmpRepo, thunkDir]
821624
625+--TODO: add force mode to pack even if changes are present
822626--TODO: add a rollback mode to pack to the original thunk
823−packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
627+packThunk :: MonadObelisk m => FilePath -> m ThunkPtr
824628packThunk = packThunk' False
825629
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
630+packThunk' :: MonadObelisk m => Bool -> FilePath -> m ThunkPtr
631+packThunk' noTrail thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
632+ Left err -> failWith $ T.pack $ "thunk pack: " <> show err
633+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
634+ Right (ThunkData_Checkout _) -> do
635+ withSpinner' ("Packing thunk " <> T.pack thunkDir)
636+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
637+ thunkPtr <- getThunkPtr thunkDir
638+ callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
639+ liftIO $ createThunk thunkDir thunkPtr
837640 pure thunkPtr
838641
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− }
642+getThunkPtr :: MonadObelisk m => FilePath -> m ThunkPtr
643+getThunkPtr = getThunkPtr' True
846644
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
645+getThunkPtr' :: forall m. MonadObelisk m => Bool -> FilePath -> m ThunkPtr
646+getThunkPtr' checkClean thunkDir = do
647+ when checkClean $ ensureCleanGitRepo thunkDir True $
869648 "thunk pack: thunk checkout contains unsaved modifications"
870649
871650 -- Check whether there are any stashes
872− when checkClean $ do
873− stashOutput <- readGitProcess thunkDir ["stash", "list"]
874− unless (T.null stashOutput) $
651+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
652+ when checkClean $ case T.null stashOutput of
653+ False -> do
875654 failWith $ T.unlines $
876655 [ "thunk pack: thunk checkout has stashes"
877656 , "git stash list:"
878657 ] ++ T.lines stashOutput
658+ True -> return ()
879659
880− -- Get current branch
660+ -- Get current branch ``
881661 (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"]
662+ b <- listToMaybe
663+ <$> T.lines
664+ <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
665+ c <- listToMaybe
666+ <$> T.lines
667+ <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884668 case b of
885− (Just "HEAD") -> failWith $ T.unlines
669+ (Just "HEAD") -> failWith $ T.unlines $
886670 [ "thunk pack: You are in 'detached HEAD' state."
887671 , "If you want to pack at the current ref \
888672 \then please create a new branch with 'git checkout -b <new-branch-name>' and push this upstream."
@@ -891,7 +675,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
891675
892676 -- Get information on all branches and their (optional) designated upstream
893677 -- correspondents
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
678+ (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
895679 [ "for-each-ref"
896680 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897681 , "refs/heads/"
@@ -937,7 +721,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
937721 ]
938722
939723 -- loosely by https://stackoverflow.com/questions/7773939/show-git-ahead-and-behind-info-for-all-branches-including-remotes
940− stats <- ifor headUpstream $ \branch (upstream, _remote) -> do
724+ stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
941725 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942726 [ "rev-list", "--left-right"
943727 , T.unpack branch <> "..." <> T.unpack upstream
@@ -954,16 +738,15 @@ getThunkPtr gitCheckClean dir mPrivate = do
954738 [ "thunk pack: Certain branches in the thunk have commits not yet pushed upstream:"
955739 , ""
956740 ] ++
957− flip map (Map.toList nonGood) (\(branch, (upstream, (ahead, behind))) -> mconcat
741+ (flip map (Map.toList nonGood) $ \(branch, (upstream, (ahead, behind))) -> mconcat
958742 [" ", branch, " ahead: ", T.pack (show ahead), " behind: ", T.pack (show behind), " remote branch ", upstream]) ++
959743 [ ""
960744 , "Please push these upstream and try again. (Or just fetch, if they are somehow \
961745 \pushed but this repo's remote tracking branches don't know it.)"
962746 ]
963747
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."
748+ -- We assume it's safe to pack the thunk at this point
749+ putLog Informational $ "All changes safe in git remotes. OK to pack thunk."
967750
968751 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
969752
@@ -976,12 +759,14 @@ getThunkPtr gitCheckClean dir mPrivate = do
976759 remoteUri <- case parseGitUri remoteUri' of
977760 Nothing -> failWith $ "Could not identify git remote: " <> remoteUri'
978761 Just uri -> pure uri
979− uriThunkPtr remoteUri mPrivate mCurrentBranch mCurrentCommit
762+ uriThunkPtr remoteUri mCurrentBranch mCurrentCommit
980763
981764-- | Get the latest revision available from the given source
982765getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983766getLatestRev os = do
984− let gitS = thunkSourceToGitSource os
767+ let gitS = case os of
768+ ThunkSource_GitHub s -> forgetGithub False s
769+ ThunkSource_Git s -> s
985770 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986771 case os of
987772 ThunkSource_GitHub s -> githubThunkRev s commit
@@ -993,18 +778,18 @@ getLatestRev os = do
993778-- performance. If that doesn't work (e.g. authentication issue), we fall back
994779-- on just doing things the normal way for git repos in general, and save it as
995780-- a regular git thunk.
996−uriThunkPtr :: MonadObelisk m => GitUri -> Maybe Bool -> Maybe Text -> Maybe Text -> m ThunkPtr
997−uriThunkPtr uri mPrivate mbranch mcommit = do
781+uriThunkPtr :: MonadObelisk m => URI -> Maybe Text -> Maybe Text -> m ThunkPtr
782+uriThunkPtr uri mbranch mcommit = do
998783 commit <- case mcommit of
999784 Nothing -> gitGetCommitBranch uri mbranch >>= return . snd
1000785 (Just c) -> return c
1001− (src, rev) <- uriToThunkSource uri mPrivate mbranch >>= \case
786+ (src, rev) <- case uriToThunkSource uri mbranch of
1002787 ThunkSource_GitHub s -> do
1003788 rev <- runExceptT $ githubThunkRev s commit
1004789 case rev of
1005790 Right r -> pure (ThunkSource_GitHub s, r)
1006791 Left e -> do
1007− putLog Warning "\
792+ putLog Warning $ "\
1008793\Failed to fetch archive from GitHub. This is probably a private repo. \
1009794\Falling back on normal fetchgit. Original failure:"
1010795 errorToWarning e
@@ -1021,66 +806,34 @@ uriThunkPtr uri mPrivate mbranch mcommit = do
1021806-- If the thunk is a GitHub thunk and fails, we do *not* fall back like with
1022807-- `uriThunkPtr`. Unlike a plain URL, a thunk src explicitly states which method
1023808-- should be employed, and so we respect that.
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
809+uriToThunkSource :: URI -> Maybe Text -> ThunkSource
810+uriToThunkSource u
811+ | Right uriAuth <- uriAuthority u
812+ , Just scheme <- unRText <$> uriScheme u
1028813 , case scheme of
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
814+ "ssh" -> uriAuth == Authority
815+ { authUserInfo = Just $ UserInfo (fromRight' $ mkUsername "git") Nothing
816+ , authHost = fromRight' $ mkHost "github.com"
817+ , authPort = Nothing
1033818 }
1034819 s -> s `L.elem` [ "git", "https", "http" ] -- "http:" just redirects to "https:"
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− }
820+ && unRText (authHost uriAuth) == "github.com"
821+ , Just (_, owner :| [repoish]) <- uriPath u
822+ = \mbranch -> ThunkSource_GitHub $ GitHubSource
823+ { _gitHubSource_owner = N $ unRText owner
824+ , _gitHubSource_repo = N $ let
825+ repoish' = unRText repoish
826+ in case T.stripSuffix ".git" repoish' of
827+ Just repo -> repo
828+ Nothing -> repoish'
829+ , _gitHubSource_branch = N <$> mbranch
830+ }
1047831
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− }
832+ | otherwise = \mbranch -> ThunkSource_Git $ GitSource
833+ { _gitSource_url = u
834+ , _gitSource_branch = N <$> mbranch
835+ , _gitSource_fetchSubmodules = False -- TODO: How do we determine if this should be true?
836+ }
1084837
1085838-- Funny signature indicates no effects depend on the optional branch name.
1086839githubThunkRev
@@ -1092,19 +845,19 @@ githubThunkRev
1092845githubThunkRev s commit = do
1093846 owner <- forcePP $ _gitHubSource_owner s
1094847 repo <- forcePP $ _gitHubSource_repo s
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
848+ revTarball <- mkPathPiece $ commit <> ".tar.gz"
849+ let archiveUri = URI
850+ { uriScheme = Just $ fromRight' $ mkScheme "https"
851+ , uriAuthority = Right $ Authority
852+ { authUserInfo = Nothing
853+ , authHost = fromRight' $ mkHost "github.com"
854+ , authPort = Nothing
1102855 }
1103− , URI.uriPath = Just ( False
1104− , owner :| [ repo, fromRight' $ URI.mkPathPiece "archive", revTarball ]
856+ , uriPath = Just ( False
857+ , owner :| [ repo, fromRight' $ mkPathPiece "archive", revTarball ]
1105858 )
1106− , URI.uriQuery = []
1107− , URI.uriFragment = Nothing
859+ , uriQuery = []
860+ , uriFragment = Nothing
1108861 }
1109862 hash <- getNixSha256ForUriUnpacked archiveUri
1110863 putLog Debug $ "Nix sha256 is " <> hash
@@ -1113,8 +866,8 @@ githubThunkRev s commit = do
1113866 , _thunkRev_nixSha256 = hash
1114867 }
1115868 where
1116− forcePP :: Name entity -> m (URI.RText 'URI.PathPiece)
1117− forcePP = URI.mkPathPiece . untagName
869+ forcePP :: Name entity -> m (RText 'PathPiece)
870+ forcePP = mkPathPiece . untagName
1118871
1119872gitThunkRev
1120873 :: MonadObelisk m
@@ -1123,11 +876,11 @@ gitThunkRev
1123876 -> m ThunkRev
1124877gitThunkRev s commit = do
1125878 let u = _gitSource_url s
1126− protocols = ["file", "https", "ssh", "git"]
1127− scheme = maybe "file" URI.unRText $ URI.uriScheme $ (\(GitUri x) -> x) u
879+ protocols = ["https", "ssh", "git"]
880+ Just scheme <- pure $ unRText <$> uriScheme u
1128881 unless (T.toLower scheme `elem` protocols) $
1129882 failWith $ "obelisk currently only supports "
1130− <> T.intercalate ", " protocols <> " protocols for plain Git remotes"
883+ <> T.intercalate ", " protocols <> " protocols for non-GitHub remotes"
1131884 hash <- nixPrefetchGit u commit $ _gitSource_fetchSubmodules s
1132885 putLog Informational $ "Nix sha256 is " <> hash
1133886 pure $ ThunkRev
@@ -1140,12 +893,11 @@ gitThunkRev s commit = do
1140893--
1141894-- If the branch name is passed in, it is returned exactly as-is. If it is not
1142895-- passed it, the default branch of the repo is used instead.
1143−
1144896gitGetCommitBranch
1145− :: MonadObelisk m => GitUri -> Maybe Text -> m (Text, CommitId)
897+ :: MonadObelisk m => URI -> Maybe Text -> m (Text, CommitId)
1146898gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote " <> uriMsg) $ do
1147899 (_, bothMaps) <- gitLsRemote
1148− (T.unpack $ gitUriToText uri)
900+ (T.unpack $ render uri)
1149901 (GitRef_Branch <$> mbranch)
1150902 Nothing
1151903 branch <- case mbranch of
@@ -1161,21 +913,18 @@ gitGetCommitBranch uri mbranch = withExitFailMessage ("Failure for git remote "
1161913 pure (branch, commit)
1162914 where
1163915 rethrowE = either failWith pure
1164− uriMsg = gitUriToText uri
1165−
1166−parseGitUri :: Text -> Maybe GitUri
1167−parseGitUri x = GitUri <$> (parseFileURI x <|> parseAbsoluteURI x <|> parseSshShorthand x)
916+ uriMsg = render uri
1168917
1169−parseFileURI :: Text -> Maybe URI.URI
1170−parseFileURI uri = if "/" `T.isPrefixOf` uri then parseAbsoluteURI ("file://" <> uri) else Nothing
918+parseGitUri :: Text -> Maybe URI
919+parseGitUri x = parseAbsoluteURI x <|> parseSshShorthand x
1171920
1172−parseAbsoluteURI :: Text -> Maybe URI.URI
921+parseAbsoluteURI :: Text -> Maybe URI
1173922parseAbsoluteURI uri = do
1174− parsedUri <- URI.mkURI uri
1175− guard $ URI.isPathAbsolute parsedUri
1176− pure parsedUri
923+ parsedUri <- mkURI uri
924+ guard $ isPathAbsolute parsedUri
925+ pure $ parsedUri
1177926
1178−parseSshShorthand :: Text -> Maybe URI.URI
927+parseSshShorthand :: Text -> Maybe URI
1179928parseSshShorthand uri = do
1180929 -- This is what git does to check that the remote
1181930 -- is not a local file path when parsing shorthand.
@@ -1188,4 +937,4 @@ parseSshShorthand uri = do
1188937 -- This check is used to disambiguate a filepath containing a colon from shorthand
1189938 guard $ isNothing (T.findIndex (=='/') authAndHostname)
1190939 && not (T.null colonAndPath)
1191− URI.mkURI properUri
940+ mkURI properUri
lib/command/src/Obelisk/Command/Upgrade/Hash.hsnew file+114
@@ -0,0 +1,114 @@
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+20−92
@@ -4,95 +4,34 @@
44{-# LANGUAGE ScopedTypeVariables #-}
55{-# LANGUAGE OverloadedStrings #-}
66{-# LANGUAGE PatternGuards #-}
7−{-# LANGUAGE TemplateHaskell #-}
87module Obelisk.Command.Utils where
98
109import Control.Applicative hiding (many)
1110import Control.Monad.Except
1211import Data.Bool (bool)
12+import qualified Text.Megaparsec.Char.Lexer as ML
1313import Data.Bifunctor
1414import Data.Char
1515import Data.Either
16−import Data.List (isInfixOf)
16+import Data.Semigroup ((<>))
1717import Data.Map (Map)
1818import qualified Data.Map as M
1919import Data.Maybe (maybeToList)
20−import Data.Semigroup ((<>))
2120import Data.Text (Text)
2221import qualified Data.Text as T
2322import Data.Void (Void)
23+import System.Directory (canonicalizePath)
24+import System.Environment (getExecutablePath)
2425import System.Exit (ExitCode)
25−import System.Which (staticWhich)
26−import qualified Text.Megaparsec.Char.Lexer as ML
26+import qualified System.Process as P
2727import Text.Megaparsec as MP
2828import Text.Megaparsec.Char as MP
2929
3030import Obelisk.App (MonadObelisk)
3131import Obelisk.CliApp
3232
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−
33+getObeliskExe :: IO FilePath
34+getObeliskExe = getExecutablePath >>= canonicalizePath
9635
9736-- Check whether the working directory is clean
9837checkGitCleanStatus :: MonadObelisk m => FilePath -> Bool -> m Bool
@@ -122,31 +61,20 @@ initGit repo = do
12261 git ["add", "."]
12362 git ["commit", "-m", "Initial commit."]
12463
125−gitProcNoRepo :: [String] -> ProcessSpec
126−gitProcNoRepo args = setEnvOverride (M.singleton "GIT_TERMINAL_PROMPT" "0" <>) $ proc gitPath args
64+gitProcNoRepo :: [String] -> P.CreateProcess
65+gitProcNoRepo = P.proc "git"
12766
128−gitProc :: FilePath -> [String] -> ProcessSpec
67+gitProc :: FilePath -> [String] -> P.CreateProcess
12968gitProc repo = gitProcNoRepo . runGitInDir
13069 where
13170 runGitInDir args' = case filter (not . null) args' of
13271 args@("clone":_) -> args <> [repo]
13372 args -> ["-C", repo] <> args
13473
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
74+-- | Recursively copy a directory using `cp -a`
75+copyDir :: FilePath -> FilePath -> P.CreateProcess
14876copyDir src dest =
149− setCwd (Just src) $ proc cp ["-a", ".", dest] -- TODO: This will break if dest is relative since we change cwd
77+ (P.proc "cp" ["-a", ".", dest]) { P.cwd = Just src }
15078
15179readGitProcess :: MonadObelisk m => FilePath -> [String] -> m Text
15280readGitProcess repo = readProcessAndLogOutput (Debug, Notice) . gitProc repo
@@ -159,15 +87,15 @@ processToShellString cmd args = unwords $ map quoteAndEscape (cmd : args)
15987 where quoteAndEscape x = T.unpack $ "'" <> T.replace "'" "'\''" (T.pack x) <> "'"
16088
16189-- | A simpler wrapper for CliApp's most used process function with sensible defaults.
162−runProc :: MonadObelisk m => ProcessSpec -> m ()
90+runProc :: MonadObelisk m => P.CreateProcess -> m ()
16391runProc = callProcessAndLogOutput (Notice, Error)
16492
16593-- | Like runProc, but all output goes to Debug logging level
166−runProcSilently :: MonadObelisk m => ProcessSpec -> m ()
94+runProcSilently :: MonadObelisk m => P.CreateProcess -> m ()
16795runProcSilently = callProcessAndLogOutput (Debug, Debug)
16896
16997-- | A simpler wrapper for CliApp's readProcessAndLogStderr with sensible defaults.
170−readProc :: MonadObelisk m => ProcessSpec -> m Text
98+readProc :: MonadObelisk m => P.CreateProcess -> m Text
17199readProc = readProcessAndLogOutput (Debug, Error)
172100
173101tshow :: Show a => a -> Text
@@ -201,13 +129,13 @@ gitLsRemote repository mRef mBranch = do
201129 (exitCode, out, _err) <- case mBranch of
202130 Nothing -> readCreateProcessWithExitCode $ gitProcNoRepo $
203131 ["ls-remote", "--exit-code", "--symref", repository]
204− ++ maybeToList (T.unpack . showGitRef <$> mRef)
205− Just branchName -> readCreateProcessWithExitCode $ gitProcNoRepo
132+ ++ (maybeToList $ T.unpack . showGitRef <$> mRef)
133+ Just branchName -> readCreateProcessWithExitCode $ gitProcNoRepo $
206134 ["ls-remote", "--exit-code", repository, branchName]
207135 let t = T.pack out
208136 maps <- case MP.runParser parseLsRemote "" t of
209− Left err -> failWith $ T.pack $ MP.errorBundlePretty err
210− Right table -> pure $ bimap M.fromList M.fromList $ partitionEithers table
137+ Left err -> failWith $ T.pack $ MP.parseErrorPretty' t err
138+ Right table -> pure $ bimap M.fromList M.fromList $ partitionEithers $ table
211139 putLog Debug $ "git ls-remote maps: " <> T.pack (show maps)
212140 pure (exitCode, maps)
213141
lib/command/src/Obelisk/Command/VmBuilder.hs+10−11
@@ -18,10 +18,10 @@ import System.Directory (createDirectoryIfMissing)
1818import System.Exit (ExitCode(..))
1919import System.FilePath ((<.>), (</>))
2020import qualified System.Info
21+import System.Process (proc)
2122
2223import Obelisk.App (MonadObelisk, getObeliskUserStateDir)
2324import 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 whichPath ["darwin-rebuild"]
38+ (exitCode, _, _) <- readCreateProcessWithExitCode $ proc "which" ["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 dockerPath ["container", "list", "--all", "--format", "{{.Names}}"]
70+ proc "docker" ["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 dockerPath ["start", containerName]
88+ proc "docker" ["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 rmPath ["-f", stateDir </> sshKeyFileName, stateDir </> sshKeyFileName <.> "pub"]
99+ proc "rm" ["-f", stateDir </> sshKeyFileName, stateDir </> sshKeyFileName <.> "pub"]
100100 callProcessAndLogOutput (Debug, Error) $
101− proc sshKeygenPath ["-t", "ed25519", "-f", stateDir </> sshKeyFileName, "-P", ""]
101+ proc "ssh-keygen" ["-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 dockerPath ["build", stateDir, "--quiet"]
106− callProcessAndLogOutput (Debug, Error) $ proc dockerPath
105+ proc "docker" ["build", stateDir, "--quiet"]
106+ callProcessAndLogOutput (Debug, Error) $ proc "docker"
107107 [ "run"
108108 , "--restart", "always"
109109 , "--detach"
@@ -155,9 +155,8 @@ 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 nixBuildExePath
159− [ "--no-out-link"
160− , "-E", "(import <nixpkgs> { system = \"x86_64-linux\"; }).writeText \"test\" builtins.currentTime"
158+ (exitCode, _stdout, stderr) <- readCreateProcessWithExitCode $ proc "nix-build"
159+ [ "-E", "(import <nixpkgs> { system = \"x86_64-linux\"; }).writeText \"test\" builtins.currentTime"
161160 , "--builders", nixBuildersArgString stateDir
162161 ]
163162 unless (exitCode == ExitSuccess) $ do
lib/executable-config/default.nix+17−38
@@ -2,44 +2,23 @@
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−{ lib
6−, runCommand
7−, obeliskCleanSource
5+{ nixpkgs
6+, filterGitSource # TODO define this in obelisk
87}:
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−
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+ '' + nixpkgs.lib.optionalString (!(builtins.isNull config)) ''
14+ if ! mkdir $out/config; then
15+ 2>&1 echo config directory already exists or could not be created
16+ exit 1
17+ fi
18+ cp -a "${config}"/* "$out/config"
19+ '');
20+in with nixpkgs.haskell.lib; {
21+ haskellPackage = self: self.callPackage (filterGitSource ./lookup) {};
4322 platforms = {
4423 android = {
4524 # Inject the given config directory into an android assets folder
@@ -50,7 +29,7 @@ in
5029 inject = injectConfig;
5130 };
5231 web = {
53− inject = self: self.callCabal2nix "obelisk-executable-config-inject" (obeliskCleanSource ./inject) {};
32+ inject = self: self.callCabal2nix "obelisk-executable-config-inject" (filterGitSource ./inject) {};
5433 };
5534 };
5635}
lib/executable-config/inject/obelisk-executable-config-inject.cabal+3−3
@@ -9,10 +9,10 @@ library
99 build-depends:
1010 base,
1111 bytestring,
12− base64-bytestring,
13− containers,
12+ directory,
13+ filepath,
1414 reflex-dom-core,
1515 text
1616
1717 exposed-modules: Obelisk.ExecutableConfig.Inject
18− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
18+ ghc-options: -Wall
lib/executable-config/inject/src/Obelisk/ExecutableConfig/Inject.hs+40−14
@@ -2,24 +2,50 @@
22module Obelisk.ExecutableConfig.Inject where
33
44import Control.Monad (mapM_)
5−import Control.Monad.IO.Class (MonadIO)
6−import Data.ByteString (ByteString)
7−import qualified Data.ByteString.Base64 as B64
8−import Data.Map (Map)
9−import qualified Data.Map as Map
5+import Control.Monad.IO.Class (MonadIO, liftIO)
106import Data.Semigroup ((<>))
7+import Data.ByteString (ByteString)
118import Data.Text (Text)
12−import qualified Data.Text.Encoding as T
9+import qualified Data.Text as T
10+import qualified Data.Text.IO as T
1311import 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
1421
1522-- | Produces a @<script>@ tag with an @id@ attribute containing the key and
16−-- whose value is the provided configuration, encoded in base64.
17−injectPure :: DomBuilder t m => Text -> ByteString -> m ()
23+-- whose value is the provided configuration
24+injectPure :: DomBuilder t m => Text -> Text -> m ()
1825injectPure key value =
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))
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)
2137
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
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 []
lib/executable-config/lookup/default.nixnew file+24
@@ -0,0 +1,24 @@
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.cabaldeleted−48
@@ -1,48 +0,0 @@
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.cabalnew file+30
@@ -0,0 +1,30 @@
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.hsnew file+27
@@ -0,0 +1,27 @@
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.hsdeleted−60
@@ -1,60 +0,0 @@
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.hsnew file+17
@@ -0,0 +1,17 @@
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.hsdeleted−51
@@ -1,51 +0,0 @@
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.hsnew file+22
@@ -0,0 +1,22 @@
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.hsdeleted−17
@@ -1,17 +0,0 @@
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.hsdeleted−11
@@ -1,11 +0,0 @@
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.hsdeleted−148
@@ -1,148 +0,0 @@
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.hsdeleted−24
@@ -1,24 +0,0 @@
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.hsnew file+13
@@ -0,0 +1,13 @@
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+2−9
@@ -7,15 +7,10 @@ library
77 hs-source-dirs: src
88 build-depends: base,
99 bytestring,
10− containers,
11− cookie,
1210 dependent-sum,
1311 ghcjs-dom,
1412 jsaddle,
1513 lens,
16− mtl,
17− obelisk-executable-config-inject,
18− obelisk-executable-config-lookup,
1914 obelisk-route,
2015 primitive,
2116 ref-tf,
@@ -23,7 +18,5 @@ library
2318 reflex-dom-core,
2419 text,
2520 transformers
26− exposed-modules:
27− Obelisk.Frontend
28− Obelisk.Frontend.Cookie
29− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
21+ exposed-modules: Obelisk.Frontend
22+ ghc-options: -Wall
lib/frontend/src/Obelisk/Frontend.hs+96−182
@@ -1,13 +1,10 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE ConstraintKinds #-}
32{-# LANGUAGE FlexibleContexts #-}
43{-# LANGUAGE FlexibleInstances #-}
54{-# LANGUAGE LambdaCase #-}
65{-# LANGUAGE MultiParamTypeClasses #-}
76{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE PackageImports #-}
97{-# LANGUAGE RankNTypes #-}
10−{-# LANGUAGE RecursiveDo #-}
118{-# LANGUAGE ScopedTypeVariables #-}
129{-# LANGUAGE TemplateHaskell #-}
1310{-# LANGUAGE TypeFamilies #-}
@@ -16,55 +13,39 @@ module Obelisk.Frontend
1613 ( ObeliskWidget
1714 , Frontend (..)
1815 , runFrontend
19− , runFrontendWithConfigsAndCurrentRoute
2016 , renderFrontendHtml
21− , removeHTMLConfigs
22− , FrontendMode (..)
23− , FrontendWidgetT
24− , module Obelisk.Frontend.Cookie
2517 ) where
2618
2719import Prelude hiding ((.))
2820
2921import Control.Category
22+import Control.Concurrent
3023import Control.Lens
24+import Control.Monad
3125import Control.Monad.Fix
3226import Control.Monad.IO.Class
3327import Control.Monad.Primitive
34−import Control.Monad.Reader
3528import Control.Monad.Ref
36−import Control.Monad.Trans.Maybe (MaybeT(..), runMaybeT)
29+import Control.Monad.Trans.Class
3730import Data.ByteString (ByteString)
38−import Data.Foldable (for_)
31+import Data.Dependent.Sum (DSum (..))
3932import Data.Functor.Sum
40−import Data.Map (Map)
41−import Data.Maybe (catMaybes)
33+import Data.IORef
4234import Data.Monoid ((<>))
4335import Data.Text (Text)
44−import qualified GHCJS.DOM as DOM
36+import GHCJS.DOM hiding (bracket, catch)
37+import GHCJS.DOM.Document
38+import GHCJS.DOM.Node
4539import qualified GHCJS.DOM.Types as DOM
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
40+import Language.Javascript.JSaddle (JSM)
5541import Obelisk.Route.Frontend
5642import Reflex.Dom.Core
5743import Reflex.Host.Class
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
44+import qualified Reflex.TriggerEvent.Base as TriggerEvent
6445
6546makePrisms ''Sum
6647
67−type ObeliskWidget js t route m =
48+type ObeliskWidget t x route m =
6849 ( DomBuilder t m
6950 , MonadFix m
7051 , MonadHold t m
@@ -72,6 +53,8 @@ type ObeliskWidget js t route m =
7253 , MonadReflexCreateTrigger t m
7354 , PostBuild t m
7455 , PerformEvent t m
56+ , MonadIO m
57+ , MonadIO (Performable m)
7558 , TriggerEvent t m
7659 , HasDocument m
7760 , MonadRef m
@@ -80,175 +63,106 @@ type ObeliskWidget js t route m =
8063 , Ref (Performable m) ~ Ref IO
8164 , MonadFix (Performable m)
8265 , PrimMonad 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
66+ , Prerender x m
67+ , SetRoute t route m
9368 , RouteToUrl route m
94− , MonadFix m
95− , HasConfigs m
96− , HasConfigs (Performable m)
9769 )
9870
9971data Frontend route = Frontend
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 ())
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 ())
10274 }
10375
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)
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+ )
152101 -> 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 ()
153134runFrontend validFullEncoder frontend = do
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))
135+ let ve = validFullEncoder . hoistParse errorLeft (prismEncoder (rPrism $ _InR . _ObeliskRoute_App))
186136 errorLeft = \case
187137 Left _ -> error "runFrontend: Unexpected non-app ObeliskRoute reached the frontend. This shouldn't happen."
188138 Right x -> Identity x
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)
139+ runMyRouteViewT
140+ :: ( TriggerEvent t m
141+ , PerformEvent t m
142+ , MonadHold t m
201143 , DOM.MonadJSM m
202− , MonadFix (Client (HydrationDomBuilderT s DomTimeline m))
203− , MonadFix (Performable m)
144+ , DOM.MonadJSM (Performable m)
204145 , MonadFix m
205− , Prerender js DomTimeline (HydrationDomBuilderT s DomTimeline m)
206− , MonadIO (Performable m)
146+ , MonadFix (Performable m)
207147 )
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))))))))
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
231154
232155renderFrontendHtml
233− :: MonadIO m
234− => Map Text ByteString
235− -> Cookies
236− -> (r -> Text)
156+ :: (t ~ DomTimeline)
157+ => (r' -> Text)
237158 -> r
238− -> Frontend r
239− -> FrontendWidgetT r ()
240− -> FrontendWidgetT r ()
241− -> m ByteString
242−renderFrontendHtml configs cookies urlEnc route frontend headExtra bodyExtra = do
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
243163 --TODO: We should probably have a "NullEventWriterT" or a frozen reflex timeline
244− html <- fmap snd $ liftIO $ renderStatic $ runHydratableT $ fmap fst $ runCookiesT cookies $ runConfigsT configs $ flip runRouteToUrlT urlEnc $ runSetRouteT $ flip runRoutedT (pure route) $
164+ html <- fmap snd $ renderStatic $ fmap fst $ flip runRouteToUrlT urlEnc $ runSetRouteT $ flip runRoutedT (pure route) $
245165 el "html" $ do
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
166+ el "head" headWidget
167+ el "body" bodyWidget
254168 return $ "<!DOCTYPE html>" <> html
lib/frontend/src/Obelisk/Frontend/Cookie.hsdeleted−103
@@ -1,103 +0,0 @@
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.mddeleted−6
@@ -1,6 +0,0 @@
1−# obelisk-route
2−
3−[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)
4−[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)
5−
6−Robust URL management for single-page apps.
lib/route/obelisk-route.cabal+3−9
@@ -6,37 +6,31 @@ build-type: Simple
66library
77 hs-source-dirs: src
88 build-depends: base,
9− aeson,
10− bytestring,
119 categories,
1210 constraints,
13− constraints-extras,
1411 containers,
1512 dependent-map,
1613 dependent-sum,
14+ dependent-sum-universe-orphans,
1715 dependent-sum-template,
1816 either,
1917 ghcjs-dom,
2018 http-types,
2119 jsaddle,
2220 lens,
23− mmorph,
2421 monad-control,
2522 mtl,
2623 network-uri,
27− obelisk-executable-config-lookup,
2824 primitive,
2925 ref-tf,
3026 reflex,
3127 reflex-dom-core,
3228 template-haskell,
33− tabulation,
3429 text,
35− th-extras,
3630 transformers,
3731 universe,
38− universe-dependent-sum
32+ universe-template
3933 exposed-modules: Obelisk.Route
4034 Obelisk.Route.TH
4135 Obelisk.Route.Frontend
42− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
36+ ghc-options: -Wall -fwarn-redundant-constraints
lib/route/src/Obelisk/Route.hs+70−471
@@ -1,4 +1,3 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE ApplicativeDo #-}
32{-# LANGUAGE ConstraintKinds #-}
43{-# LANGUAGE EmptyCase #-}
@@ -6,24 +5,19 @@
65{-# LANGUAGE FlexibleContexts #-}
76{-# LANGUAGE FlexibleInstances #-}
87{-# 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 #-}
1615{-# LANGUAGE TemplateHaskell #-}
17−{-# LANGUAGE TypeApplications #-}
1816{-# LANGUAGE TypeFamilies #-}
1917{-# LANGUAGE TypeOperators #-}
2018{-# LANGUAGE ViewPatterns #-}
2119module Obelisk.Route
2220 ( R
23− , (:.)
24− , (?/)
25− , hoistR
26− , pattern (:.)
2721 , pattern (:/)
2822 , PageName
2923 , PathQuery
@@ -46,11 +40,7 @@ module Obelisk.Route
4640 , checkEnum1EncoderFunc
4741 , unitEncoder
4842 , pathOnlyEncoder
49− , addPathSegmentEncoder
50− , pathParamEncoder
51− , pathLiteralEncoder
5243 , singletonListEncoder
53− , packTextEncoder
5444 , unpackTextEncoder
5545 , prefixTextEncoder
5646 , unsafeTshowEncoder
@@ -61,7 +51,6 @@ module Obelisk.Route
6151 , justEncoder
6252 , nothingEncoder
6353 , isoEncoder
64− , viewEncoder
6554 , wrappedEncoder
6655 , unwrappedEncoder
6756 , listToNonEmptyEncoder
@@ -70,17 +59,11 @@ module Obelisk.Route
7059 , toListMapEncoder
7160 , shadowEncoder
7261 , prismEncoder
73− , reviewEncoder
7462 , rPrism
75− , _R
7663 , obeliskRouteEncoder
7764 , obeliskRouteSegment
7865 , pageNameEncoder
7966 , handleEncoder
80− , FullRoute (..)
81− , _FullRoute_Frontend
82− , _FullRoute_Backend
83− , mkFullRouteEncoder
8467 , ObeliskRoute (..)
8568 , _ObeliskRoute_App
8669 , _ObeliskRoute_Resource
@@ -95,19 +78,6 @@ module Obelisk.Route
9578 , void1Encoder
9679 , pathSegmentsTextEncoder
9780 , 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
11181 ) where
11282
11383import Prelude hiding ((.), id)
@@ -118,41 +88,13 @@ import qualified Control.Categorical.Functor as Cat
11888import Control.Categorical.Bifunctor
11989import Control.Category.Associative
12090import Control.Category.Monoidal
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− )
91+import Control.Lens (Identity (..), Prism', makePrisms, itraverse, imap, prism, (^.), re, matching, (^?), _Just, _Nothing, Iso', from, view, Wrapped (..))
14292import Control.Monad.Except
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
93+import Data.Dependent.Sum (DSum (..))
15094import Data.Dependent.Map (DMap)
15195import qualified Data.Dependent.Map as DMap
152−import Data.Dependent.Sum (DSum (..))
15396import Data.Either.Validation (Validation (..))
15497import Data.Foldable
155−import Data.Functor (($>))
15698import Data.Functor.Sum
15799import Data.GADT.Compare
158100import Data.GADT.Compare.TH
@@ -164,17 +106,14 @@ import Data.Maybe
164106import Data.Monoid ((<>))
165107import Data.Set (Set)
166108import qualified Data.Set as Set
167−import Data.Some (Some(Some))
168−import Data.Tabulation
109+import Data.Some (Some)
110+import qualified Data.Some as Some
111+import Data.Some.Universe.Orphans ()
169112import Data.Text (Text)
170113import qualified Data.Text as T
171−import qualified Data.Text.Encoding as T
172−import Data.Text.Lens (IsText, packed, unpacked)
173−import Data.Type.Equality
114+import Data.Text.Encoding
174115import Data.Universe
175−import Data.Universe.Some
176116import Network.HTTP.Types.URI
177−import qualified Numeric.Lens
178117import Obelisk.Route.TH
179118import Text.Read (readMaybe)
180119
@@ -202,76 +141,13 @@ import Text.Read (readMaybe)
202141
203142type R f = DSum f Identity --TODO: Better name
204143
205−-- | Convenience builder for an 'R' using 'Identity' for the functor.
144+--TODO: COMPLETE pragma
145+infixr 5 :/
206146pattern (:/) :: f a -> a -> R f
207147pattern 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 ?/
215148
216149mapSome :: (forall a. f a -> g a) -> Some f -> Some g
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
150+mapSome f (Some.This a) = Some.This $ f a
275151
276152--------------------------------------------------------------------------------
277153-- Encoder fundamentals
@@ -304,13 +180,13 @@ decode e x = runIdentity (tryDecode e x)
304180-- | Once an 'Encoder' has been checked, so that its check monad has become 'Identity', even if the same is not true of the
305181-- parse monad, we may still attempt to decode with it in its parse monad.
306182tryDecode :: Encoder Identity parse decoded encoded -> encoded -> parse decoded
307−tryDecode (Encoder (Identity impl)) = _encoderImpl_decode impl
183+tryDecode (Encoder (Identity impl)) x = _encoderImpl_decode impl x
308184
309−-- | Similar to 'decode', once an encoder has been checked so that its check monad is Identity, it
185+-- | Similar to 'decode' above, once an encoder has been checked so that its check monad is Identity, it
310186-- can be used to actually encode by using this. Note that while there's no constraint on the parse monad here,
311187-- one should usually be applying decode and encode to the same 'Encoder'
312188encode :: Encoder Identity parse decoded encoded -> decoded -> encoded
313−encode (Encoder (Identity impl)) = _encoderImpl_encode impl
189+encode (Encoder (Identity impl)) x = _encoderImpl_encode impl x
314190
315191-- | This is a primitive used to build encoders which can't fail to check. It should not be used unless one is
316192-- reasonably certain that the law given for 'EncoderImpl' above holds.
@@ -356,10 +232,6 @@ instance Monad parse => Bifunctor (,) (EncoderImpl parse) (EncoderImpl parse) (E
356232 , _encoderImpl_decode = \(a, b) -> liftA2 (,) (_encoderImpl_decode f a) (_encoderImpl_decode g b)
357233 }
358234
359−instance (Monad parse, Applicative check) => Braided (Encoder check parse) (,) where
360− braid = viewEncoder (iso swap swap)
361−
362−
363235instance (Applicative check, Monad parse) => PFunctor (,) (Encoder check parse) (Encoder check parse) where
364236 first f = bimap f id
365237instance (Applicative check, Monad parse) => QFunctor (,) (Encoder check parse) (Encoder check parse) where
@@ -373,34 +245,6 @@ instance (Traversable f, Monad parse) => Cat.Functor f (EncoderImpl parse) (Enco
373245 , _encoderImpl_decode = traverse $ _encoderImpl_decode ve
374246 }
375247
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−
404248instance (Traversable f, Monad check, Monad parse) => Cat.Functor f (Encoder check parse) (Encoder check parse) where
405249 fmap e = Encoder $ do
406250 ve <- unEncoder e
@@ -451,17 +295,17 @@ instance (Applicative check, Monad parse) => Monoidal (Encoder check parse) (,)
451295--------------------------------------------------------------------------------
452296
453297-- | Given a valid 'Iso' from lens, construct an 'Encoder'
454−viewEncoder :: (Applicative check, Applicative parse) => Iso' a b -> Encoder check parse a b
455−viewEncoder f = unsafeMkEncoder $ EncoderImpl
298+isoEncoder :: (Applicative check, Applicative parse) => Iso' a b -> Encoder check parse a b
299+isoEncoder f = unsafeMkEncoder $ EncoderImpl
456300 { _encoderImpl_encode = view f
457301 , _encoderImpl_decode = pure . view (from f)
458302 }
459303
460304wrappedEncoder :: (Wrapped a, Applicative check, Applicative parse) => Encoder check parse (Unwrapped a) a
461−wrappedEncoder = viewEncoder $ from _Wrapped'
305+wrappedEncoder = isoEncoder $ from _Wrapped'
462306
463307unwrappedEncoder :: (Wrapped a, Applicative check, Applicative parse) => Encoder check parse a (Unwrapped a)
464−unwrappedEncoder = viewEncoder $ _Wrapped'
308+unwrappedEncoder = isoEncoder _Wrapped'
465309
466310maybeToEitherEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Maybe a) (Either () a)
467311maybeToEitherEncoder = unsafeMkEncoder $ EncoderImpl
@@ -486,16 +330,16 @@ maybeEncoder f g = shadowEncoder f g . maybeToEitherEncoder
486330
487331-- | Encode a value by simply applying 'Just'
488332justEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse a (Maybe a)
489−justEncoder = reviewEncoder _Just
333+justEncoder = prismEncoder _Just
490334
491−-- | Encode () to 'Nothing'.
335+-- |
492336nothingEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse () (Maybe a)
493−nothingEncoder = reviewEncoder _Nothing
337+nothingEncoder = prismEncoder _Nothing
494338
495339someConstEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Some (Const a)) a
496340someConstEncoder = unsafeMkEncoder $ EncoderImpl
497− { _encoderImpl_encode = \(Some (Const a)) -> a
498− , _encoderImpl_decode = pure . Some . Const
341+ { _encoderImpl_encode = \(Some.This (Const a)) -> a
342+ , _encoderImpl_decode = pure . Some.This . Const
499343 }
500344
501345-- | WARNING: This is only safe if the Show and Read instances for 'a' are
@@ -523,7 +367,7 @@ checkEnum1EncoderFunc
523367 -> check (EncoderFunc check' parse p r)
524368checkEnum1EncoderFunc f = do
525369 (encoderImpls :: DMap p (Flip (EncoderImpl parse) r)) <- DMap.fromList <$>
526− traverse (\(Some p) -> (p :=>) . Flip <$> unEncoder (f p)) universe
370+ traverse (\(Some.This p) -> (p :=>) . Flip <$> unEncoder (f p)) universe
527371 pure $ EncoderFunc $ \p -> unsafeMkEncoder . unFlip $
528372 DMap.findWithDefault (error "checkEnum1EncoderFunc: EncoderImpl not found (should be impossible)") p encoderImpls
529373
@@ -555,11 +399,11 @@ pathComponentEncoder f = Encoder $ do
555399 unEncoder (pathComponentEncoderImpl (enum1Encoder (extractPathSegment . f)) f')
556400
557401pathComponentEncoderImpl :: forall check parse p. (Monad check, Monad parse)
558− => Encoder check parse (Some p) (Maybe Text)
402+ => (Encoder check parse (Some p) (Maybe Text))
559403 -> (forall a. p a -> Encoder Identity parse a PageName)
560404 -> Encoder check parse (R p) PageName
561−pathComponentEncoderImpl =
562− chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder)
405+pathComponentEncoderImpl this rest =
406+ chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder) this rest
563407
564408--NOTE: Naming convention in this module is to always talk about things in the *encoding* direction, never in the *decoding* direction
565409
@@ -578,12 +422,11 @@ chainEncoder cons this rest = Encoder $ do
578422 pure $ EncoderImpl
579423 { _encoderImpl_decode = \v -> do
580424 (here, following) <- _encoderImpl_decode consValid v
581− _encoderImpl_decode thisValid here >>= \case
582− Some r ->
583− (r :/) <$> _encoderImpl_decode (runIdentity . unEncoder $ rest r) following
425+ Some.This r <- _encoderImpl_decode thisValid here
426+ (r :/) <$> _encoderImpl_decode (runIdentity . unEncoder $ rest r) following
584427 , _encoderImpl_encode = \(r :/ s) ->
585428 _encoderImpl_encode consValid
586− ( _encoderImpl_encode thisValid $ Some r
429+ ( _encoderImpl_encode thisValid $ Some.This r
587430 , _encoderImpl_encode (runIdentity . unEncoder $ rest r) s)
588431 }
589432
@@ -650,7 +493,7 @@ enum1Encoder
650493 , Show r
651494 )
652495 => (forall a. p a -> r) -> Encoder check parse (Some p) r
653−enum1Encoder f = enumEncoder $ \(Some p) -> f p
496+enum1Encoder f = enumEncoder $ \(Some.This p) -> f p
654497
655498-- | Encode an enumerable, bounded type. WARNING: Don't use this on types that
656499-- have a large number of values - it will use a lot of memory.
@@ -693,10 +536,13 @@ pathOnlyEncoderIgnoringQuery = unsafeMkEncoder $ EncoderImpl
693536 }
694537
695538pathOnlyEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse [Text] PageName
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
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+ }
700546
701547singletonListEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse a [a]
702548singletonListEncoder = unsafeMkEncoder $ EncoderImpl
@@ -739,10 +585,10 @@ queryParametersTextEncoder = Encoder $ pure $ EncoderImpl
739585 in (urlDecodeText True k, urlDecodeText True <$> mv)
740586
741587urlEncodeText :: Bool -> Text -> Text
742−urlEncodeText q = T.decodeUtf8 . urlEncode q . T.encodeUtf8
588+urlEncodeText q = decodeUtf8 . urlEncode q . encodeUtf8
743589
744590urlDecodeText :: Bool -> Text -> Text
745−urlDecodeText q = T.decodeUtf8 . urlDecode q . T.encodeUtf8
591+urlDecodeText q = decodeUtf8 . urlDecode q . encodeUtf8
746592
747593listToNonEmptyEncoder :: (Applicative check, Applicative parse, Monoid a, Eq a) => Encoder check parse [a] (NonEmpty a)
748594listToNonEmptyEncoder = Encoder $ pure $ EncoderImpl
@@ -775,11 +621,11 @@ prefixNonemptyTextEncoder p = Encoder $ pure $ EncoderImpl
775621 Just stripped -> pure stripped
776622 }
777623
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
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+ }
783629
784630toListMapEncoder :: (Applicative check, Applicative parse, Ord k) => Encoder check parse (Map k v) [(k, v)]
785631toListMapEncoder = Encoder $ pure $ EncoderImpl
@@ -800,63 +646,19 @@ joinPairTextEncoder = Encoder . \case
800646 _ -> return (kt, T.drop (T.length separator) vt)
801647 }
802648
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
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)
844653
845654-- | An encoder that only works on the items available via the prism. An error will be thrown in the parse monad
846655-- if the prism doesn't match.
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
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)
857659 , _encoderImpl_decode = \r -> case r ^? p of
858660 Just a -> pure a
859− Nothing -> throwError "reviewEncoder: value is not present in the prism"
661+ Nothing -> throwError "prismEncoder: value is not present in the prism"
860662 }
861663
862664-- | A URL path and query string, in which trailing slashes don't matter in the path
@@ -891,45 +693,6 @@ handleEncoder recover e = Encoder $ do
891693-- Actual obelisk route info
892694--------------------------------------------------------------------------------
893695
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−
933696-- | A type which can represent Obelisk-specific resource routes, in addition to application specific routes which serve your
934697-- frontend.
935698data ObeliskRoute :: (* -> *) -> * -> * where
@@ -937,11 +700,9 @@ data ObeliskRoute :: (* -> *) -> * -> * where
937700 ObeliskRoute_App :: f a -> ObeliskRoute f a
938701 ObeliskRoute_Resource :: ResourceRoute a -> ObeliskRoute f a
939702
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− ]
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
945706
946707instance GEq f => GEq (ObeliskRoute f) where
947708 geq (ObeliskRoute_App x) (ObeliskRoute_App y) = geq x y
@@ -994,9 +755,9 @@ obeliskRouteSegment r appRouteSegment = case r of
994755-- be combined with other such segment encoders before 'pathComponentEncoder' turns it into a proper 'Encoder'.
995756resourceRouteSegment :: (MonadError Text check, MonadError Text parse) => ResourceRoute a -> SegmentResult check parse a
996757resourceRouteSegment = \case
997− ResourceRoute_Static -> PathSegment "static" pathOnlyEncoderIgnoringQuery
998− ResourceRoute_Ghcjs -> PathSegment "ghcjs" pathOnlyEncoder
999− ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" jsaddleWarpRouteEncoder
758+ ResourceRoute_Static -> PathSegment "static" $ pathOnlyEncoderIgnoringQuery
759+ ResourceRoute_Ghcjs -> PathSegment "ghcjs" $ pathOnlyEncoder
760+ ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" $ jsaddleWarpRouteEncoder
1000761 ResourceRoute_Version -> PathSegment "version" $ unitEncoder mempty
1001762
1002763data JSaddleWarpRoute :: * -> * where
@@ -1008,7 +769,7 @@ jsaddleWarpRouteEncoder :: (MonadError Text check, MonadError Text parse) => Enc
1008769jsaddleWarpRouteEncoder = pathComponentEncoder $ \case
1009770 JSaddleWarpRoute_JavaScript -> PathSegment "jsaddle.js" $ unitEncoder mempty
1010771 JSaddleWarpRoute_WebSocket -> PathEnd $ unitEncoder mempty
1011− JSaddleWarpRoute_Sync -> PathSegment "sync" pathOnlyEncoder
772+ JSaddleWarpRoute_Sync -> PathSegment "sync" $ pathOnlyEncoder
1012773
1013774instance GShow appRoute => GShow (ObeliskRoute appRoute) where
1014775 gshowsPrec prec = \case
@@ -1029,193 +790,29 @@ indexOnlyRouteEncoder = pathComponentEncoder indexOnlyRouteSegment
1029790
1030791someSumEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Some (Sum a b)) (Either (Some a) (Some b))
1031792someSumEncoder = Encoder $ pure $ EncoderImpl
1032− { _encoderImpl_encode = \(Some t) -> case t of
1033− InL l -> Left $ Some l
1034− InR r -> Right $ Some r
793+ { _encoderImpl_encode = \(Some.This t) -> case t of
794+ InL l -> Left $ Some.This l
795+ InR r -> Right $ Some.This r
1035796 , _encoderImpl_decode = pure . \case
1036− Left (Some l) -> Some (InL l)
1037− Right (Some r) -> Some (InR r)
797+ Left (Some.This l) -> Some.This (InL l)
798+ Right (Some.This r) -> Some.This (InR r)
1038799 }
1039800
1040801data Void1 :: * -> * where {}
1041802
1042−instance UniverseSome Void1 where
1043− universeSome = []
803+instance Universe (Some Void1) where
804+ universe = []
1044805
1045806void1Encoder :: (Applicative check, MonadError Text parse) => Encoder check parse (Some Void1) a
1046807void1Encoder = Encoder $ pure $ EncoderImpl
1047808 { _encoderImpl_encode = \case
1048− Some f -> case f of {}
809+ Some.This f -> case f of {}
1049810 , _encoderImpl_decode = \_ -> throwError "void1Encoder: can't decode anything"
1050811 }
1051812
1052813instance GShow Void1 where
1053814 gshowsPrec _ = \case {}
1054815
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−
1219816concat <$> mapM deriveRouteComponent
1220817 [ ''ResourceRoute
1221818 , ''JSaddleWarpRoute
@@ -1223,6 +820,8 @@ concat <$> mapM deriveRouteComponent
1223820 ]
1224821
1225822makePrisms ''ObeliskRoute
1226−makePrisms ''FullRoute
823+
1227824deriveGEq ''Void1
1228825deriveGCompare ''Void1
826+
827+--TODO: decodeURIComponent as appropriate
lib/route/src/Obelisk/Route/Frontend.hs+77−265
@@ -1,24 +1,26 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE ApplicativeDo #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE RecursiveDo #-}
4+{-# LANGUAGE StandaloneDeriving #-}
35{-# LANGUAGE ConstraintKinds #-}
4−{-# LANGUAGE DataKinds #-}
5−{-# LANGUAGE DefaultSignatures #-}
66{-# LANGUAGE FlexibleContexts #-}
77{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE FunctionalDependencies #-}
98{-# LANGUAGE GADTs #-}
10−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9+{-# LANGUAGE KindSignatures #-}
1110{-# LANGUAGE LambdaCase #-}
11+{-# LANGUAGE MultiParamTypeClasses #-}
1212{-# LANGUAGE OverloadedStrings #-}
1313{-# LANGUAGE PatternSynonyms #-}
1414{-# LANGUAGE RankNTypes #-}
15−{-# LANGUAGE RecursiveDo #-}
1615{-# LANGUAGE ScopedTypeVariables #-}
17−{-# LANGUAGE StandaloneDeriving #-}
16+{-# LANGUAGE TemplateHaskell #-}
1817{-# LANGUAGE TypeFamilies #-}
1918{-# LANGUAGE TypeOperators #-}
20−{-# LANGUAGE UndecidableInstances #-}
2119{-# LANGUAGE ViewPatterns #-}
20+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
21+{-# LANGUAGE UndecidableInstances #-}
22+{-# LANGUAGE DataKinds #-}
23+{-# LANGUAGE FunctionalDependencies #-}
2224
2325module Obelisk.Route.Frontend
2426 ( module Obelisk.Route
@@ -31,14 +33,9 @@ module Obelisk.Route.Frontend
3133 , mapRoutedT
3234 , subRoute
3335 , subRoute_
34− , subPairRoute
35− , subPairRoute_
3636 , maybeRoute
3737 , maybeRoute_
3838 , maybeRouted
39− , eitherRoute
40− , eitherRoute_
41− , eitherRouted
4239 , runRouteViewT
4340 , SetRouteT(..)
4441 , SetRoute(..)
@@ -49,50 +46,50 @@ module Obelisk.Route.Frontend
4946 , runRouteToUrlT
5047 , mapRouteToUrlT
5148 , routeLink
52− , routeLinkDynAttr
53− , dynRouteLink
54− , adaptedUriPath
55− , setAdaptedUriPath
5649 ) where
5750
5851import Prelude hiding ((.), id)
5952
53+import Obelisk.Route
54+
6055import Control.Category (Category (..), (.))
61−import Control.Category.Cartesian ((&&&))
56+import Control.Category.Cartesian
6257import Control.Lens hiding (Bifunctor, bimap, universe, element)
63−import Control.Monad ((<=<))
6458import Control.Monad.Fix
65−import Control.Monad.Morph
6659import Control.Monad.Primitive
67−import Control.Monad.Reader
6860import Control.Monad.Ref
61+import Control.Monad.Trans
6962import Control.Monad.Trans.Control
63+import Control.Monad.Trans.Reader
7064import Data.Coerce
65+import Data.Constraint (Dict (..))
7166import Data.Dependent.Sum (DSum (..))
72−import Data.Functor.Compose
73−import Data.Functor.Misc
7467import Data.GADT.Compare
75−import qualified Data.List as L
76−import Data.Map (Map)
77−import Data.Maybe (fromMaybe)
7868import Data.Monoid
7969import Data.Proxy
8070import Data.Text (Text)
8171import qualified Data.Text as T
82−import Data.Type.Coercion
83−import qualified GHCJS.DOM as DOM
84−import 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
87−import Network.URI
72+import Data.Functor.Compose
8873import 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
8981import Reflex.Dom.Builder.Class
82+import Data.Type.Coercion
83+import Language.Javascript.JSaddle --TODO: Get rid of this - other platforms can also be routed
9084import Reflex.Dom.Core
91−import Reflex.Host.Class
92−import Unsafe.Coerce
85+import qualified GHCJS.DOM.Types as DOM
86+import Network.URI
87+#if defined(ios_HOST_OS)
88+import Data.Maybe (fromMaybe)
89+import qualified Data.List as L
90+#endif
9391
94−import Obelisk.Configs
95−import Obelisk.Route
92+import Unsafe.Coerce
9693
9794infixr 5 :~
9895pattern (:~) :: Reflex t => f a -> Dynamic t a -> DSum f (Compose (Dynamic t) Identity)
@@ -100,46 +97,19 @@ pattern a :~ b <- a :=> (coerceDynamic . getCompose -> b)
10097
10198class Routed t r m | m -> t r where
10299 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
105100
106101instance Monad m => Routed t r (RoutedT t r m) where
107102 askRoute = RoutedT ask
108103
109−instance (Monad m, Routed t r m) => Routed t r (ReaderT r' m)
110−
111104newtype RoutedT t r m a = RoutedT { unRoutedT :: ReaderT (Dynamic t r) m a }
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
105+ deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument)
133106
134107instance HasJSContext m => HasJSContext (RoutedT t r m) where
135108 type JSContextPhantom (RoutedT t r m) = JSContextPhantom m
136109 askJSContext = lift askJSContext
137110
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)
111+instance Prerender js m => Prerender js (RoutedT t r m) where
112+ prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
143113
144114instance Requester t m => Requester t (RoutedT t r m) where
145115 type Request (RoutedT t r m) = Request m
@@ -191,24 +161,17 @@ instance (Monad m, MonadQuery t vs m) => MonadQuery t vs (RoutedT t r m) where
191161 askQueryResult = lift askQueryResult
192162 queryIncremental = lift . queryIncremental
193163
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)
164+instance (Monad m, RouteToUrl r m) => RouteToUrl r (QueryT t q m) where
165+ askRouteToUrl = lift askRouteToUrl
205166
206−instance (Monad m, SetRoute t r m) => SetRoute t r (DynamicWriterT t w m)
167+instance (Monad m, SetRoute t r m) => SetRoute t r (QueryT t q m) where
168+ setRoute = lift . setRoute
169+ modifyRoute = lift . modifyRoute
207170
208171runRoutedT :: RoutedT t r m a -> Dynamic t r -> m a
209172runRoutedT = runReaderT . unRoutedT
210173
211−mapRoutedT :: (m a -> n b) -> RoutedT t r m a -> RoutedT t r n b
174+mapRoutedT :: (m a -> n a) -> RoutedT t r m a -> RoutedT t r n a
212175mapRoutedT f = RoutedT . mapReaderT f . unRoutedT
213176
214177withRoutedT :: (Dynamic t r -> Dynamic t r') -> RoutedT t r' m a -> RoutedT t r m a
@@ -218,18 +181,10 @@ subRoute_ :: (MonadFix m, MonadHold t m, GEq r, Adjustable t m) => (forall a. r
218181subRoute_ f = factorRouted $ strictDynWidget_ $ \(c :=> r') -> do
219182 runRoutedT (f c) r'
220183
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−
225184subRoute :: (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)
226185subRoute f = factorRouted $ strictDynWidget $ \(c :=> r') -> do
227186 runRoutedT (f c) r'
228187
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−
233188maybeRoute_ :: (MonadFix m, MonadHold t m, Adjustable t m) => m () -> RoutedT t r m () -> RoutedT t (Maybe r) m ()
234189maybeRoute_ n j = maybeRouted $ strictDynWidget_ $ \case
235190 Nothing -> n
@@ -246,20 +201,6 @@ maybeRoute f = factorRouted $ strictDynWidget $ \(c :=> r') -> do
246201 runRoutedT (f c) r'
247202-}
248203
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−
263204dsumValueCoercion :: Coercion f g -> Coercion (DSum k f) (DSum k g)
264205dsumValueCoercion Coercion = Coercion
265206
@@ -269,16 +210,13 @@ dynamicIdentityCoercion = unsafeCoerce (Coercion :: Coercion (Identity ()) ()) -
269210factorRouted :: (Reflex t, MonadFix m, MonadHold t m, GEq f) => RoutedT t (DSum f (Dynamic t)) m a -> RoutedT t (DSum f Identity) m a
270211factorRouted r = RoutedT $ ReaderT $ \d -> do
271212 d' <- factorDyn d
272− runRoutedT r $ coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d'
213+ runRoutedT r $ (coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d')
273214
274215maybeRouted :: (Reflex t, MonadFix m, MonadHold t m) => RoutedT t (Maybe (Dynamic t a)) m b -> RoutedT t (Maybe a) m b
275216maybeRouted r = RoutedT $ ReaderT $ \d -> do
276217 d' <- maybeDyn d
277218 runRoutedT r d'
278219
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−
282220-- | WARNING: The input 'Dynamic' must be fully constructed when this is run
283221strictDynWidget :: (MonadSample t m, MonadHold t m, Adjustable t m) => (a -> m b) -> RoutedT t a m (Dynamic t b)
284222strictDynWidget f = RoutedT $ ReaderT $ \r -> do
@@ -293,7 +231,7 @@ strictDynWidget_ f = RoutedT $ ReaderT $ \r -> do
293231 pure ()
294232
295233newtype SetRouteT t r m a = SetRouteT { unSetRouteT :: EventWriterT t (Endo r) m a }
296− deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, MonadIO, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadReflexCreateTrigger t, HasDocument, DomRenderHook t)
234+ deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, MonadIO, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadReflexCreateTrigger t, HasDocument)
297235
298236instance (MonadFix m, MonadHold t m, DomBuilder t m) => DomBuilder t (SetRouteT t r m) where
299237 type DomBuilderSpace (SetRouteT t r m) = DomBuilderSpace m
@@ -315,26 +253,16 @@ runSetRouteT = runEventWriterT . unSetRouteT
315253class Reflex t => SetRoute t r m | m -> t r where
316254 setRoute :: Event t r -> m ()
317255 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−
321256 setRoute = modifyRoute . fmap const
322257
323258instance (Reflex t, Monad m) => SetRoute t r (SetRouteT t r m) where
324259 modifyRoute = SetRouteT . tellEvent . fmap Endo
325260
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)
261+instance (Monad m, SetRoute t r m) => SetRoute t r (RoutedT t r' m) where
262+ modifyRoute = lift . modifyRoute
329263
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
264+instance Prerender js m => Prerender js (SetRouteT t r m) where
265+ prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
338266
339267instance Requester t m => Requester t (SetRouteT t r m) where
340268 type Request (SetRouteT t r m) = Request m
@@ -342,8 +270,6 @@ instance Requester t m => Requester t (SetRouteT t r m) where
342270 requesting = SetRouteT . requesting
343271 requesting_ = SetRouteT . requesting_
344272
345−instance (Monad m, SetRoute t r m) => SetRoute t r (RequesterT t req rsp m)
346−
347273#ifndef ghcjs_HOST_OS
348274deriving instance MonadJSM m => MonadJSM (SetRouteT t r m)
349275#endif
@@ -367,8 +293,6 @@ instance PrimMonad m => PrimMonad (SetRouteT t r m ) where
367293 type PrimState (SetRouteT t r m) = PrimState m
368294 primitive = lift . primitive
369295
370−instance HasConfigs m => HasConfigs (SetRouteT t r m)
371−
372296instance (MonadHold t m, Adjustable t m) => Adjustable t (SetRouteT t r m) where
373297 runWithReplace a0 a' = SetRouteT $ runWithReplace (coerce a0) $ coerceEvent a'
374298 traverseIntMapWithKeyWithAdjust f a0 a' = SetRouteT $ traverseIntMapWithKeyWithAdjust (coerce f) (coerce a0) $ coerce a'
@@ -382,11 +306,9 @@ instance (Monad m, MonadQuery t vs m) => MonadQuery t vs (SetRouteT t r m) where
382306
383307class RouteToUrl r m | m -> r where
384308 askRouteToUrl :: m (r -> Text)
385− default askRouteToUrl :: (Monad m', MonadTrans f, RouteToUrl r m', m ~ f m') => m (r -> Text)
386− askRouteToUrl = lift askRouteToUrl
387309
388310newtype RouteToUrlT r m a = RouteToUrlT { unRouteToUrlT :: ReaderT (r -> Text) m a }
389− deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument, DomRenderHook t)
311+ deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument)
390312
391313runRouteToUrlT
392314 :: RouteToUrlT r m a
@@ -401,22 +323,17 @@ instance Monad m => RouteToUrl r (RouteToUrlT r m) where
401323 askRouteToUrl = RouteToUrlT ask
402324
403325instance (Monad m, RouteToUrl r m) => RouteToUrl r (SetRouteT t r' m) where
326+ askRouteToUrl = lift askRouteToUrl
404327
405328instance (Monad m, RouteToUrl r m) => RouteToUrl r (RoutedT t r' m) where
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)
329+ askRouteToUrl = lift askRouteToUrl
410330
411331instance HasJSContext m => HasJSContext (RouteToUrlT r m) where
412332 type JSContextPhantom (RouteToUrlT r m) = JSContextPhantom m
413333 askJSContext = lift askJSContext
414334
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)
335+instance Prerender js m => Prerender js (RouteToUrlT r m) where
336+ prerenderClientDict = fmap (\Dict -> Dict) (prerenderClientDict :: Maybe (Dict (PrerenderClientConstraint js m)))
420337
421338instance Requester t m => Requester t (RouteToUrlT r m) where
422339 type Request (RouteToUrlT r m) = Request m
@@ -466,8 +383,6 @@ instance (Monad m, MonadQuery t vs m) => MonadQuery t vs (RouteToUrlT r m) where
466383 askQueryResult = lift askQueryResult
467384 queryIncremental = lift . queryIncremental
468385
469−instance HasConfigs m => HasConfigs (RouteToUrlT t m)
470−
471386runRouteViewT
472387 :: forall t m r a.
473388 ( TriggerEvent t m
@@ -477,21 +392,17 @@ runRouteViewT
477392 , MonadJSM (Performable m)
478393 , MonadFix m
479394 )
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
395+ => (Encoder Identity Identity r PageName)
485396 -> RoutedT t r (SetRouteT t r (RouteToUrlT r m)) a
486397 -> m a
487−runRouteViewT routeEncoder switchover useHash a = do
488− rec historyState <- manageHistory' switchover $ HistoryCommand_PushState <$> setState
398+runRouteViewT routeEncoder a = do
399+ rec historyState <- manageHistory $ HistoryCommand_PushState <$> setState
489400 let theEncoder = pageNameEncoder . hoistParse (pure . runIdentity) routeEncoder
490401 -- NB: The can only fail if the uriPath doesn't begin with a '/' or if the uriQuery
491402 -- is nonempty, but begins with a character that isn't '?'. Since we don't expect
492403 -- this ever to happen, we'll just handle it by failing completely with 'error'.
493404 route :: Dynamic t r
494− route = fmap (errorLeft . tryDecode theEncoder . (adaptedUriPath useHash &&& uriQuery) . _historyItem_uri) historyState
405+ route = fmap (errorLeft . tryDecode theEncoder . (adaptedUriPath &&& uriQuery) . _historyItem_uri) historyState
495406 where
496407 errorLeft (Left e) = error (T.unpack e)
497408 errorLeft (Right x) = x
@@ -512,7 +423,7 @@ runRouteViewT routeEncoder switchover useHash a = do
512423 -- we can change this function later to accommodate.
513424 -- See: https://github.com/whatwg/html/issues/2174
514425 , _historyStateUpdate_title = ""
515− , _historyStateUpdate_uri = Just $ setAdaptedUriPath useHash newPath $ (_historyItem_uri currentHistoryState)
426+ , _historyStateUpdate_uri = Just $ setAdaptedUriPath newPath $ (_historyItem_uri currentHistoryState)
516427 { uriQuery = newQuery
517428 }
518429 }
@@ -522,141 +433,42 @@ runRouteViewT routeEncoder switchover useHash a = do
522433-- | A link widget that, when clicked, sets the route to the provided route. In non-javascript
523434-- contexts, this widget falls back to using @href@s to control navigation
524435routeLink
525− :: forall t m a route js.
436+ :: forall t m a route.
526437 ( DomBuilder t m
527− , RouteToUrl route m
528− , SetRoute t route m
529− , Prerender js t m
438+ , RouteToUrl (R route) m
439+ , SetRoute t (R route) m
530440 )
531− => route -- ^ Target route
441+ => R route -- ^ Target route
532442 -> m a -- ^ Child widget
533443 -> m a
534444routeLink 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
550445 enc <- askRouteToUrl
551446 let cfg = (def :: ElementConfig EventResult t (DomBuilderSpace m))
552447 & elementConfig_eventSpec %~ addEventSpecFlags (Proxy :: Proxy (DomBuilderSpace m)) Click (\_ -> preventDefault)
553448 & elementConfig_initialAttributes .~ "href" =: enc r
554449 (e, a) <- element "a" cfg w
555450 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
578451 return a
579452
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−
645453-- On ios due to sandboxing when loading the page from a file adapt the
646454-- path to be based on the hash.
647455
648−adaptedUriPath :: Bool -> URI -> String
649−adaptedUriPath = \case
650− True -> hashToPath . uriFragment
651− False -> uriPath
456+adaptedUriPath :: URI -> String
457+#if defined(ios_HOST_OS)
458+adaptedUriPath = hashToPath . uriFragment
652459
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 }
460+hashToPath :: String -> String
461+hashToPath = ('/' :) . fromMaybe "" . L.stripPrefix "#"
462+#else
463+adaptedUriPath = uriPath
464+#endif
465+
466+setAdaptedUriPath :: String -> URI -> URI
467+#if defined(ios_HOST_OS)
468+setAdaptedUriPath s u = u { uriFragment = pathToHash s }
657469
658470pathToHash :: String -> String
659471pathToHash = ('#' :) . fromMaybe "" . L.stripPrefix "/"
660−
661−hashToPath :: String -> String
662−hashToPath = ('/' :) . fromMaybe "" . L.stripPrefix "#"
472+#else
473+setAdaptedUriPath s u = u { uriPath = s }
474+#endif
lib/route/src/Obelisk/Route/TH.hs+5−4
@@ -1,9 +1,8 @@
11module Obelisk.Route.TH (deriveRouteComponent) where
22
3−import Data.Constraint.Extras.TH
43import Data.GADT.Show.TH
54import Data.GADT.Compare.TH
6−import Data.Universe.Some.TH
5+import Data.Universe.TH
76import Language.Haskell.TH
87
98-- | Derive all the typeclasses needed for a RouteComponent type. The argument should be the name of a type of kind @k -> *@
@@ -12,6 +11,8 @@ deriveRouteComponent x = concat <$> traverse ($ x)
1211 [ deriveGShow
1312 , deriveGEq
1413 , deriveGCompare
15− , deriveUniverseSome
16− , deriveArgDict
14+ , deriveShowTagIdentity
15+ , deriveEqTagIdentity
16+ , deriveOrdTagIdentity
17+ , deriveSomeUniverse
1718 ]
lib/run/obelisk-run.cabal+4−12
@@ -10,12 +10,9 @@ library
1010 attoparsec
1111 , base
1212 , bytestring
13− , containers
14− , cookie
1513 , dependent-sum
1614 , dependent-sum-template
1715 , ghcjs-dom
18− , HsOpenSSL
1916 , http-client
2017 , http-reverse-proxy
2118 , http-types
@@ -27,27 +24,22 @@ library
2724 , network
2825 , obelisk-asset-serve-snap
2926 , obelisk-backend
30− , obelisk-executable-config-lookup
27+ , obelisk-executable-config
28+ , obelisk-executable-config-inject
3129 , obelisk-frontend
3230 , obelisk-route
3331 , process
3432 , ref-tf
3533 , reflex
36− , reflex-dom-core
34+ , reflex-dom
3735 , snap-core
3836 , streaming-commons
3937 , text
40− , time
4138 , universe
42− , utf8-string
4339 , wai
4440 , wai-websockets
4541 , warp
46− , warp-tls
4742 , websockets
4843 exposed-modules:
4944 Obelisk.Run
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
45+ ghc-options: -Wall -fwarn-redundant-constraints
lib/run/src/Obelisk/Run.hs+59−120
@@ -1,17 +1,17 @@
1−{-# LANGUAGE CPP #-}
2−#if defined(IPROUTE_SUPPORTED)
3−{-# LANGUAGE TemplateHaskell #-}
4−#endif
5−
61{-# LANGUAGE ConstraintKinds #-}
2+{-# LANGUAGE EmptyCase #-}
3+{-# LANGUAGE EmptyDataDecls #-}
74{-# LANGUAGE FlexibleContexts #-}
85{-# LANGUAGE FlexibleInstances #-}
96{-# LANGUAGE GADTs #-}
7+{-# LANGUAGE KindSignatures #-}
108{-# LANGUAGE LambdaCase #-}
119{-# LANGUAGE MultiParamTypeClasses #-}
1210{-# LANGUAGE OverloadedStrings #-}
1311{-# LANGUAGE Rank2Types #-}
12+{-# LANGUAGE RecursiveDo #-}
1413{-# 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,22 +25,17 @@ 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
2928import qualified Data.ByteString.Char8 as BSC
3029import qualified Data.ByteString.Lazy.Char8 as BSLC
31−import qualified Data.ByteString.UTF8 as BSUTF8
30+import Data.Dependent.Sum (DSum (..))
3231import Data.Functor.Identity
32+import Data.Functor.Sum
3333import Data.List (uncons)
34−import Data.Map (Map)
35−import qualified Data.Map as Map
3634import Data.Maybe
3735import Data.Semigroup ((<>))
3836import Data.Streaming.Network (bindPortTCP)
39−import Data.String (fromString)
4037import Data.Text (Text)
4138import qualified Data.Text as T
42−import qualified Data.Text.Encoding as T
43−import Data.Time.Clock (getCurrentTime, addUTCTime)
4439import Language.Javascript.JSaddle.Run (syncPoint)
4540import Language.Javascript.JSaddle.WebSockets
4641import Network.HTTP.Client (Manager, defaultManagerSettings, newManager)
@@ -50,36 +45,29 @@ import Network.Socket
5045import Network.Wai (Application)
5146import qualified Network.Wai as W
5247import Network.Wai.Handler.Warp
53−import Network.Wai.Handler.WarpTLS
5448import Network.Wai.Handler.Warp.Internal (settingsHost, settingsPort)
5549import Network.WebSockets (ConnectionOptions)
5650import Network.WebSockets.Connection (defaultConnectionOptions)
5751import qualified Obelisk.Asset.Serve.Snap as Snap
58−import Obelisk.Backend
52+import Obelisk.ExecutableConfig (get)
53+import Obelisk.ExecutableConfig.Inject (injectExecutableConfigs)
5954import Obelisk.Frontend
6055import 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
6556import Reflex.Dom.Core
6657import Snap.Core (Snap)
6758import System.Environment
6859import System.IO
6960import System.Process
61+import System.Exit (ExitCode(..))
7062import Text.URI (URI)
7163import qualified Text.URI as URI
7264import Text.URI.Lens
73−import Web.Cookie
74−
75−#if defined(IPROUTE_SUPPORTED)
76−import qualified System.Which
77−#endif
65+import Obelisk.Backend
7866
7967run
8068 :: Int -- ^ Port to run the backend
8169 -> ([Text] -> Snap ()) -- ^ Static asset handler
82− -> Backend backendRoute frontendRoute -- ^ Backend
70+ -> Backend fullRoute frontendRoute -- ^ Backend
8371 -> Frontend (R frontendRoute) -- ^ Frontend
8472 -> IO ()
8573run port serveStaticAsset backend frontend = do
@@ -89,126 +77,82 @@ run port serveStaticAsset backend frontend = do
8977 case checkEncoder $ _backend_routeEncoder backend of
9078 Left e -> hPutStrLn stderr $ "backend error:\n" <> T.unpack e
9179 Right validFullEncoder -> do
92− publicConfigs <- getPublicConfigs
93− backendTid <- forkIO $ handle handleBackendErr $ withArgs ["--quiet", "--port", show port] $
94− _backend_run backend $ \serveRoute ->
95− runSnapWithCommandLineArgs $
80+ backendTid <- forkIO $ handle handleBackendErr $ withArgs ["--quiet", "--port", show port] $ do
81+ _backend_run backend $ \serveRoute -> do
82+ runSnapWithCommandLineArgs $ do
9683 getRouteWith validFullEncoder >>= \case
9784 Identity r -> case r of
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−
85+ InL backendRoute :=> Identity a -> serveRoute $ backendRoute :/ a
86+ InR obeliskRoute :=> Identity a ->
87+ serveDefaultObeliskApp (mkRouteToUrl validFullEncoder) serveStaticAsset frontend $ obeliskRoute :/ a
10588 let conf = defRunConfig { _runConfig_redirectPort = port }
106− runWidget conf publicConfigs frontend validFullEncoder `finally` killThread backendTid
89+ runWidget conf frontend validFullEncoder `finally` killThread backendTid
10790
10891-- Convenience wrapper to handle path segments for 'Snap.serveAsset'
10992runServeAsset :: FilePath -> [Text] -> Snap ()
11093runServeAsset rootPath = Snap.serveAsset "" rootPath . T.unpack . T.intercalate "/"
11194
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
95+getConfigRoute :: IO (Maybe URI)
96+getConfigRoute = get "config/common/route" >>= \case
97+ Just r -> case URI.mkURI $ T.strip r of
98+ Just route -> pure $ Just route
99+ Nothing -> do
100+ putStrLn $ "Route is invalid: " <> show r
101+ pure Nothing
102+ Nothing -> pure Nothing
103+
104+defAppUri :: URI
105+defAppUri = fromMaybe (error "defAppUri") $ URI.mkURI "http://127.0.0.1:8000"
106+
107+runWidget :: RunConfig -> Frontend (R route) -> Encoder Identity Identity (R (Sum backendRoute (ObeliskRoute route))) PageName -> IO ()
108+runWidget conf frontend validFullEncoder = do
109+ uri <- fromMaybe defAppUri <$> getConfigRoute
129110 let port = fromIntegral $ fromMaybe 80 $ uri ^? uriAuthority . _Right . authPort . _Just
130111 redirectHost = _runConfig_redirectHost conf
131112 redirectPort = _runConfig_redirectPort conf
132113 beforeMainLoop = do
133114 putStrLn $ "Frontend running on " <> T.unpack (URI.render uri)
134115 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
158116 bracket
159117 (bindPortTCPRetry settings (logPortBindErr port) (_runConfig_retryTimeout conf))
160118 close
161119 (\skt -> do
162120 man <- newManager defaultManagerSettings
163− app <- obeliskApp configs defaultConnectionOptions frontend validFullEncoder uri $ fallbackProxy redirectHost redirectPort man
164− runner settings skt app)
121+ app <- obeliskApp defaultConnectionOptions frontend validFullEncoder uri $ fallbackProxy redirectHost redirectPort man
122+ runSettingsSocket settings skt app)
165123
166124obeliskApp
167− :: forall frontendRoute backendRoute
168− . Map Text ByteString
169− -> ConnectionOptions
170− -> Frontend (R frontendRoute)
171− -> Encoder Identity Identity (R (FullRoute backendRoute frontendRoute)) PageName
125+ :: forall route backendRoute. ConnectionOptions
126+ -> Frontend (R route)
127+ -> Encoder Identity Identity (R (Sum backendRoute (ObeliskRoute route))) PageName
172128 -> URI
173129 -> Application
174130 -> IO Application
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
131+obeliskApp opts frontend validFullEncoder uri backend = do
132+ let entryPoint = do
133+ runFrontend validFullEncoder frontend
182134 syncPoint
183135 jsaddlePath <- URI.mkPathPiece "jsaddle"
184136 let jsaddleUri = BSLC.fromStrict $ URI.renderBs $ uri & uriPath %~ (<>[jsaddlePath])
185137 Right (jsaddleWarpRouteValidEncoder :: Encoder Identity (Either Text) (R JSaddleWarpRoute) PageName) <- return $ checkEncoder jsaddleWarpRouteEncoder
186138 jsaddle <- jsaddleWithAppOr opts entryPoint $ \_ sendResponse -> sendResponse $ W.responseLBS H.status500 [("Content-Type", "text/plain")] "obeliskApp: jsaddle got a bad URL"
187− return $ \req sendResponse -> case tryDecode validFullEncoder $ byteStringsToPageName (BS.dropWhile (== (fromIntegral $ fromEnum '/')) $ W.rawPathInfo req) (BS.drop 1 $ W.rawQueryString req) of
139+ return $ \req sendResponse -> case tryDecode validFullEncoder (W.pathInfo req, mempty) of --TODO: Query strings
188140 Identity r -> case r of
189− FullRoute_Frontend (ObeliskRoute_Resource ResourceRoute_JSaddleWarp) :/ jsaddleRoute -> case jsaddleRoute of
141+ InR (ObeliskRoute_Resource ResourceRoute_JSaddleWarp) :=> Identity jsaddleRoute -> case jsaddleRoute of
190142 JSaddleWarpRoute_JavaScript :/ () -> sendResponse $ W.responseLBS H.status200 [("Content-Type", "application/javascript")] $ jsaddleJs' (Just jsaddleUri) False
191143 _ -> flip jsaddle sendResponse $ req
192144 { W.pathInfo = fst $ encode jsaddleWarpRouteValidEncoder jsaddleRoute
193145 }
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
146+ InR (ObeliskRoute_App appRouteComponent) :=> Identity appRouteRest -> do
147+ html <- renderJsaddleFrontend (mkRouteToUrl validFullEncoder) (appRouteComponent :/ appRouteRest) frontend
198148 sendResponse $ W.responseLBS H.status200 [("Content-Type", staticRenderContentType)] $ BSLC.fromStrict html
199149 _ -> backend req sendResponse
200150
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 =
151+renderJsaddleFrontend :: (route -> Text) -> route -> Frontend route -> IO ByteString
152+renderJsaddleFrontend urlEnc r f =
209153 let jsaddleScript = elAttr "script" ("src" =: "/jsaddle/jsaddle.js") blank
210154 jsaddlePreload = elAttr "link" ("rel" =: "preload" <> "as" =: "script" <> "href" =: "/jsaddle/jsaddle.js") blank
211− in renderFrontendHtml configs cookies urlEnc r f jsaddlePreload jsaddleScript
155+ in renderFrontendHtml urlEnc r (_frontend_head f >> injectExecutableConfigs >> jsaddlePreload) (_frontend_body f >> jsaddleScript)
212156
213157-- | like 'bindPortTCP' but reconnects on exception
214158bindPortTCPRetry :: Settings
@@ -225,22 +169,17 @@ logPortBindErr p e = getProcessIdForPort p >>= \case
225169 Nothing -> putStrLn $ "runWidget: " <> show e
226170 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."]
227171
228−ssPath :: Maybe String
229−ssPath =
230−#if defined(IPROUTE_SUPPORTED)
231− Just $(System.Which.staticWhich "ss")
232−#else
233− Nothing
234−#endif
235−
236172getProcessIdForPort :: Int -> IO (Maybe Int)
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
173+getProcessIdForPort port = do
174+ -- First check if 'ss' is available
175+ (c, _, _) <- readProcessWithExitCode "which" ["ss"] mempty
176+ case c of
177+ ExitSuccess -> do
178+ xs <- lines <$> readProcess "ss" ["-lptn", "sport = " <> show port] mempty
179+ case uncons xs of
180+ Just (_, x:_) -> return $ A.maybeResult $ A.parse parseSsPid $ BSC.pack x
181+ _ -> return Nothing
182+ _ -> return Nothing
244183
245184parseSsPid :: A.Parser Int
246185parseSsPid = do
lib/selftest/obelisk-selftest.cabal+3−7
@@ -9,21 +9,17 @@ library
99 hs-source-dirs: src
1010 build-depends:
1111 base
12− , bytestring
13− , aeson
1412 , containers
1513 , directory
16− , filepath
1714 , hspec
1815 , http-client
1916 , http-types
2017 , HUnit
21− , network
22− , obelisk-executable-config-lookup
18+ , obelisk-cliapp
2319 , obelisk-run
24− , which
2520 , process
26− , shelly >= 1.9.0
21+ , network
22+ , shelly
2723 , temporary
2824 , text
2925 exposed-modules:
lib/selftest/src/Obelisk/SelfTest.hs+196−498
@@ -1,50 +1,39 @@
1−{-# LANGUAGE DoAndIfThenElse #-}
21{-# LANGUAGE EmptyCase #-}
32{-# LANGUAGE LambdaCase #-}
43{-# LANGUAGE OverloadedStrings #-}
54{-# LANGUAGE PatternGuards #-}
65{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TemplateHaskell #-}
86{-# LANGUAGE TypeApplications #-}
9−{-# LANGUAGE ViewPatterns #-}
107module Obelisk.SelfTest where
118
12−import Control.Concurrent (threadDelay)
13−import Control.Exception (bracket, throw, try)
9+import Control.Exception (bracket, throw)
1410import Control.Monad
1511import Control.Monad.IO.Class
16−import qualified Data.Aeson as Aeson
17−import qualified Data.Aeson.Types as Aeson
1812import Data.Bool (bool)
19−import qualified Data.ByteString.Lazy as LBS
20−import Data.Foldable (for_)
2113import Data.Function (fix)
22−import Data.List (isInfixOf)
23−import qualified Data.Map as Map
24−import Data.Semigroup ((<>))
14+import Data.Semigroup (Semigroup, (<>))
2515import qualified Data.Set as Set
2616import Data.String
2717import Data.Text (Text)
18+import Data.Void
2819import qualified Data.Text as T
29−import qualified Data.Text.Encoding as T
3020import qualified Data.Text.IO as T
3121import qualified Network.HTTP.Client as HTTP
3222import qualified Network.HTTP.Types as HTTP
3323import qualified Network.Socket as Socket
3424import Shelly
35−import System.Directory (getCurrentDirectory, withCurrentDirectory, getDirectoryContents)
25+import System.Directory (withCurrentDirectory, getDirectoryContents)
3626import System.Environment
3727import System.Exit (ExitCode (..))
38−import System.FilePath (addTrailingPathSeparator)
39−import qualified System.Info
40−import System.IO (Handle, hClose, hIsEOF, hGetContents)
28+import System.Info
29+import System.IO (Handle, hClose)
4130import System.IO.Temp
42−import System.Process (readProcessWithExitCode)
43−import System.Which (staticWhich)
31+import System.Process (readProcessWithExitCode, CreateProcess(cwd), readCreateProcessWithExitCode, proc)
4432import Test.Hspec
4533import Test.HUnit.Base
4634
47−import Obelisk.ExecutableConfig.Lookup (getConfigs)
35+import Obelisk.CliApp hiding (runCli, readCreateProcessWithExitCode)
36+import qualified Obelisk.CliApp as CliApp
4837import Obelisk.Run (getConfigRoute)
4938
5039data ObRunState
@@ -53,53 +42,24 @@ data ObRunState
5342 | ObRunState_BackendStarted
5443 deriving (Eq, Show)
5544
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"]
45+doubleQuotes :: (IsString a, Semigroup a) => a -> a
46+doubleQuotes s = "\"" <> s <> "\""
9447
9548commit :: Text -> Sh ()
96−commit msg = void $ run gitPath $ gitUserConfig <> [ "commit"
49+commit msg = void $ run "git"
50+ [ "commit"
9751 , "--no-gpg-sign"
9852 , "--allow-empty"
9953 , "-m"
100− , msg
54+ , doubleQuotes msg
10155 ]
10256
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+
10363tshow :: Show a => a -> Text
10464tshow = T.pack . show
10565
@@ -107,345 +67,208 @@ tshow = T.pack . show
10767shellyOb :: MonadIO m => (Sh a -> Sh a) -> Sh a -> m a
10868shellyOb f obTest = shelly $ f obTest
10969
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−
14670main :: IO ()
14771main = do
14872 -- Note: you can pass hspec arguments as well, eg: `-m <pattern>`
149− isVerbose <- elem "-v" <$> getArgs
73+ isVerbose <- (elem "-v") <$> getArgs
15074 unless isVerbose $
15175 putStrLn "Tests may take longer to run if there are unbuilt derivations: use -v for verbose output"
152−
153− obeliskImplDirtyReadOnly <- getCurrentDirectory
76+ let verbosity = bool silently verbosely isVerbose
77+ obeliskImpl <- fromString <$> getEnv "OBELISK_IMPL"
15478 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)
215+
216+ describe "ob thunk update --branch" $ parallel $ do
217+ it "can change a thunk to the latest version of a desired branch" $ withTmp $ \dir -> do
218+ let branch1 = "master"
219+ branch2 = "develop"
220+ run_ "git" ["clone", "https://github.com/reflex-frp/reflex.git", toTextIgnore dir, "--branch", branch1]
221+ run_ "ob" ["thunk" , "pack", toTextIgnore dir]
222+ run_ "ob" ["thunk", "update", toTextIgnore dir, "--branch", branch2]
223+
224+ it "doesn't create anything when given an invalid branch" $ withTmp $ \dir -> do
225+ let checkDir dir' = liftIO $ getDirectoryContents $ T.unpack $ toTextIgnore dir'
226+ run_ "git" ["clone", "https://github.com/reflex-frp/reflex.git", toTextIgnore dir, "--branch", "master"]
227+ run_ "ob" ["thunk" , "pack", toTextIgnore dir]
228+ startingContents <- checkDir dir
229+ void $ errExit False $ run "ob" ["thunk", "update", toTextIgnore dir, "--branch", "dumble-palooza"]
230+ checkDir dir >>= liftIO . assertEqual "" startingContents
155231
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)
405232
406233-- | Run `ob run` in the given directory (maximum of one level deep)
407−testObRunInDir :: String -> [Text] -> Maybe FilePath -> HTTP.Manager -> Sh ()
408−testObRunInDir executable extraArgs mdir httpManager = maskExitSuccess $ do
409− [p0, p1] <- liftIO $ getFreePorts 2
234+testObRunInDir :: Socket.PortNumber -> Socket.PortNumber -> Maybe Shelly.FilePath -> HTTP.Manager -> Sh ()
235+testObRunInDir p0 p1 mdir httpManager = handle_sh (\case ExitSuccess -> pure (); e -> throw e) $ do
410236 let uri p = "http://localhost:" <> T.pack (show p) <> "/" -- trailing slash required for comparison
411237 writefile "config/common/route" $ uri p0
412− maybe id chdir mdir $ runHandles executable extraArgs [] $ \_stdin stdout stderr -> do
413− firstUri <- handleObRunStdout httpManager stdout stderr
238+ maybe id chdir mdir $ runHandle "ob" ["run"] $ \stdout -> do
239+ firstUri <- handleObRunStdout httpManager stdout
414240 let newUri = uri p1
415241 when (firstUri == newUri) $ errorExit $
416242 "Startup URI (" <> firstUri <> ") is the same as test URI (" <> newUri <> ")"
417243 maybe id (\_ -> chdir "..") mdir $ alterRouteTo newUri stdout
418− runningUri <- handleObRunStdout httpManager stdout stderr
244+ runningUri <- handleObRunStdout httpManager stdout
419245 if runningUri /= newUri
420246 then errorExit $ "Reloading failed: expected " <> newUri <> " but got " <> runningUri
421247 else exit 0
422248
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
249+testThunkPack :: Shelly.FilePath -> Sh ()
250+testThunkPack path' = withTempFile (T.unpack $ toTextIgnore path') "test-file" $ \file handle -> do
251+ let pack' = readProcessWithExitCode "ob" ["thunk", "pack", T.unpack $ toTextIgnore path'] ""
252+ ensureThunkPackFails q = liftIO $ pack' >>= \case
253+ (code, out, err)
254+ | code == ExitSuccess -> fail "ob thunk pack succeeded when it should have failed"
255+ | q `T.isInfixOf` T.pack (out <> err) -> pure ()
256+ | otherwise -> fail $ "ob thunk pack failed for an unexpected reason: " <> show out <> "\nstderr: " <> err
257+ git = chdir path' . run "git"
433258 -- Untracked files
434259 ensureThunkPackFails "Untracked files"
435− git ["add", T.pack file]
260+ void $ git ["add", T.pack file]
436261 -- Uncommitted files (staged)
437262 ensureThunkPackFails "unsaved"
438− chdir repoDir $ commit "test commit"
263+ chdir path' $ commit "test commit"
439264 -- Non-pushed commits in any branch
440265 ensureThunkPackFails "not yet pushed"
441266 -- Uncommitted files (unstaged)
442267 liftIO $ T.hPutStrLn handle "test file" >> hClose handle
443268 ensureThunkPackFails "modified"
444269 -- Existing stashes
445− git $ gitUserConfig <> [ "stash" ]
270+ void $ git ["stash"]
446271 ensureThunkPackFails "has stashes"
447− where
448− repoDir = path' </> unpackedDirName
449272
450273-- | Blocks until a non-empty line is available
451274hGetLineSkipBlanks :: MonadIO m => Handle -> m Text
@@ -465,12 +288,9 @@ alterRouteTo uri stdout = do
465288 "Reloading failed: " <> T.pack (show t)
466289
467290-- | Handle stdout of `ob run`: check that the frontend and backend servers are started correctly
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
291+handleObRunStdout :: HTTP.Manager -> Handle -> Sh Text
292+handleObRunStdout httpManager stdout = flip fix (ObRunState_Init, []) $ \loop (state, msgs) -> do
293+ liftIO (T.hGetLine stdout) >>= \t -> case state of
474294 ObRunState_Init
475295 | "Running test..." `T.isPrefixOf` t -> loop (ObRunState_BackendStarted, msgs)
476296 ObRunState_Startup
@@ -482,12 +302,8 @@ handleObRunStdout httpManager stdout stderr = flip fix (ObRunState_Init, []) $ \
482302 obRunCheck httpManager stdout uri
483303 pure uri
484304 | not (T.null t) -> errorExit $ "Started: " <> t -- If theres any other output here, startup failed
485− _ | "Failed" `T.isPrefixOf` t -> handleObRunError (t : msgs)
305+ _ | "Failed" `T.isPrefixOf` t -> errorExit $ "ob run failed: " <> T.unlines (reverse $ t : msgs)
486306 | 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
491307
492308-- | Make requests to frontend/backend servers to check they are working properly
493309obRunCheck :: HTTP.Manager -> Handle -> Text -> Sh ()
@@ -506,121 +322,3 @@ getFreePorts n = Socket.withSocketsDo $ do
506322 sock <- Socket.socket (Socket.addrFamily addr) (Socket.addrSocketType addr) (Socket.addrProtocol addr)
507323 Socket.bind sock (Socket.addrAddress addr)
508324 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+3−2
@@ -1,6 +1,6 @@
11name: obelisk-snap-extras
22version: 0.1
3−synopsis: Extra functionality for Snap that should be considered for upstreaming
3+synopsys: Extra functionality for Snap that should be considered for upstreaming
44license: BSD3
55build-type: Simple
66cabal-version: >=1.2
@@ -12,9 +12,10 @@ library
1212 , base
1313 , bytestring
1414 , snap-core
15+ , unix
1516 , directory
1617 , filepath
1718 , text
1819 exposed-modules:
1920 Obelisk.Snap.Extras
20− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
21+ ghc-options: -Wall
lib/snap-extras/src/Obelisk/Snap/Extras.hs+2−2
@@ -2,13 +2,13 @@
22module Obelisk.Snap.Extras
33 ( cachePermanently
44 , doNotCache
5− , ensureSecure
65 , serveFileIfExists
76 , serveFileIfExistsAs
87 ) where
98
109import Control.Monad.IO.Class
1110import 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, immutable"
20+ modifyResponse $ setHeader "Cache-Control" "public, max-age=315360000"
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.mddeleted−5
@@ -1,5 +0,0 @@
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/LICENSEdeleted−30
@@ -1,30 +0,0 @@
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.hsdeleted−2
@@ -1,2 +0,0 @@
1−import Distribution.Simple
2−main = defaultMain
lib/tabulation/src/Data/Tabulation.hsdeleted−21
@@ -1,21 +0,0 @@
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.cabaldeleted−26
@@ -1,26 +0,0 @@
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.nixdeleted−15
@@ -1,15 +0,0 @@
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+78−8
@@ -1,10 +1,80 @@
1−{
2− supportedSystems ? [ "x86_64-linux" "x86_64-darwin" ]
1+{ local-self ? import ./. {}
32}:
4−rec {
5− recurseForDerivations = true;
6− build = import ./all-builds.nix { inherit supportedSystems; };
7− test = import ./all-tests.nix { inherit supportedSystems; };
83
9− inherit (build) metaCache;
10−}
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; }
scripts/ghcid-this-libnew file+4
@@ -0,0 +1,4 @@
1+#!/usr/bin/env bash
2+set -euo pipefail
3+
4+nix-shell -E "with (import ../.. {}); reflex-platform.workOn haskellPackageSets.ghc haskellPackageSets.ghc.obelisk-$(basename $PWD)" --run "cabal configure ; ghcid -c'cabal repl'"
skeleton/.gitignore+5−13
@@ -1,15 +1,7 @@
1+dist-newstyle
2+result
3+result-android
4+result-ios
5+result-exe
16.attr-cache
2−.cabal-sandbox
3−*.hi
4−*.o
5−cabal.project.local
6−cabal.sandbox.config
7−ctags
8−dist-newstyle/
9−dist/
107ghcid-output.txt
11−profile/
12−result
13−result-*
14−tags
15−TAGS
skeleton/backend/backend.cabal+1−2
@@ -14,12 +14,11 @@ library
1414 , obelisk-route
1515 exposed-modules:
1616 Backend
17− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits
17+ ghc-options: -Wall
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
2322 if impl(ghcjs)
2423 buildable: False
2524 build-depends: base
skeleton/backend/src/Backend.hs+6−1
@@ -1,3 +1,8 @@
1+{-# LANGUAGE EmptyCase #-}
2+{-# LANGUAGE FlexibleContexts #-}
3+{-# LANGUAGE LambdaCase #-}
4+{-# LANGUAGE RankNTypes #-}
5+{-# LANGUAGE TypeFamilies #-}
16module Backend where
27
38import Common.Route
@@ -6,5 +11,5 @@ import Obelisk.Backend
611backend :: Backend BackendRoute FrontendRoute
712backend = Backend
813 { _backend_run = \serve -> serve $ const $ return ()
9− , _backend_routeEncoder = fullRouteEncoder
14+ , _backend_routeEncoder = backendRouteEncoder
1015 }
skeleton/cabal.project−1
@@ -1,3 +1,2 @@
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+
1213 exposed-modules:
1314 Common.Api
1415 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 Common.Api"
4+commonStuff = "Here is a string defined in code common to the frontend and backend."
skeleton/common/src/Common/Route.hs+18−13
@@ -1,14 +1,15 @@
11{-# LANGUAGE EmptyCase #-}
22{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE FlexibleInstances #-}
43{-# LANGUAGE GADTs #-}
5−{-# LANGUAGE KindSignatures #-}
64{-# LANGUAGE LambdaCase #-}
7−{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE OverloadedStrings #-}
95{-# LANGUAGE RankNTypes #-}
106{-# LANGUAGE TemplateHaskell #-}
11−{-# LANGUAGE TypeFamilies #-}
7+{-# LANGUAGE KindSignatures #-}
8+{-# LANGUAGE EmptyCase #-}
9+{-# LANGUAGE MultiParamTypeClasses #-}
10+{-# LANGUAGE FlexibleInstances #-}
11+{-# LANGUAGE OverloadedStrings #-}
12+
1213module Common.Route where
1314
1415{- -- You will probably want these imports for composing Encoders.
@@ -18,6 +19,7 @@ import Control.Category
1819
1920import Data.Text (Text)
2021import Data.Functor.Identity
22+import Data.Functor.Sum
2123
2224import Obelisk.Route
2325import Obelisk.Route.TH
@@ -32,14 +34,17 @@ data FrontendRoute :: * -> * where
3234 FrontendRoute_Main :: FrontendRoute ()
3335 -- This type is used to define frontend routes, i.e. ones for which the backend will serve the frontend.
3436
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)
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+
4348
4449concat <$> mapM deriveRouteComponent
4550 [ ''BackendRoute
skeleton/config/common/exampledeleted−1
@@ -1 +0,0 @@
1−This string comes from config/common/example
skeleton/default.nix+5−17
@@ -1,23 +1,11 @@
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− }
1+{ system ? builtins.currentSystem # TODO: Get rid of this system cruft
2+, iosSdkVersion ? "10.2"
3+, projectOverrides ? {}
164}:
17−with obelisk;
5+with import ./.obelisk/impl { inherit system iosSdkVersion; };
186project ./. ({ ... }: {
197 android.applicationId = "systems.obsidian.obelisk.examples.minimal";
208 android.displayName = "Obelisk Minimal Example";
219 ios.bundleIdentifier = "systems.obsidian.obelisk.examples.minimal";
2210 ios.bundleName = "Obelisk Minimal Example";
23−})
11+} // projectOverrides)
skeleton/frontend/frontend.cabal+4−8
@@ -9,14 +9,12 @@ library
99 , common
1010 , obelisk-frontend
1111 , obelisk-route
12− , jsaddle
1312 , reflex-dom
14− , obelisk-executable-config-lookup
1513 , obelisk-generated-static
1614 , text
1715 exposed-modules:
1816 Frontend
19− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits
17+ ghc-options: -Wall
2018
2119executable frontend
2220 main-is: main.hs
@@ -28,9 +26,7 @@ executable frontend
2826 , reflex-dom
2927 , obelisk-generated-static
3028 , frontend
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
29+ --TODO: Make these ghc-options optional
30+ ghc-options: -threaded
3531 if os(darwin)
36− ghc-options: -dynamic
32+ 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 fullRouteEncoder
9+ let Right validFullEncoder = checkEncoder backendRouteEncoder
1010 run $ runFrontend validFullEncoder frontend
skeleton/frontend/src/Frontend.hs+3−28
@@ -1,48 +1,23 @@
11{-# LANGUAGE DataKinds #-}
22{-# LANGUAGE OverloadedStrings #-}
33{-# LANGUAGE TypeApplications #-}
4−
54module Frontend where
65
7−import Control.Monad
86import qualified Data.Text as T
9−import qualified Data.Text.Encoding as T
10−import Language.Javascript.JSaddle (eval, liftJSM)
11−
127import Obelisk.Frontend
13−import Obelisk.Configs
148import Obelisk.Route
15−import Obelisk.Generated.Static
16−
179import Reflex.Dom.Core
1810
1911import Common.Api
2012import Common.Route
13+import Obelisk.Generated.Static
2114
2215
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.
2616frontend :: Frontend (R FrontendRoute)
2717frontend = Frontend
28− { _frontend_head = do
29− el "title" $ text "Obelisk Minimal Example"
30− elAttr "link" ("href" =: static @"main.css" <> "type" =: "text/css" <> "rel" =: "stylesheet") blank
18+ { _frontend_head = el "title" $ text "Obelisk Minimal Example"
3119 , _frontend_body = do
32− el "h1" $ text "Welcome to Obelisk!"
20+ text "Welcome to Obelisk!"
3321 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−
4122 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 ()
4823 }
skeleton/static/main.cssdeleted−3
@@ -1,3 +0,0 @@
1−p {
2− color: red;
3−}