on f5cf750 help sign in
67 files changed+1234−2599
since splitsnapshots
unifiedsplit
.github/pull_request_template.md−2 CONTRIBUTING.md−52 ChangeLog.md+2−47 FAQ.md+67−62 README.md+129−71 acme.nix−430 all-builds.nix+6−15 all-tests.nix+17−17 default.nix+120−76 dep/.gitignore+5 dep/reflex-platform/default.nix+7−1 dep/reflex-platform/github.json+4−4 dep/reflex-platform/thunk.nix−9 docs/obelisk-logo-640.png guides/app-deploy/README.md+12−25 haskell-overlays/ghcide.nix−40 haskell-overlays/misc-deps.nix−26 haskell-overlays/obelisk.nix−48 haskell-overlays/tighten-ob-exes.nix−32 lib/asset/README.md+19−16 lib/asset/assets.nix+5−28 lib/asset/manifest/obelisk-asset-manifest.cabal+2−4 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/Serve/Snap.hs+1−1 lib/backend/obelisk-backend.cabal+2−2 lib/backend/src/Obelisk/Backend.hs+1−1 lib/cliapp/obelisk-cliapp.cabal+1−3 lib/cliapp/src/Obelisk/CliApp.hs−3 lib/cliapp/src/Obelisk/CliApp/Logging.hs+2−2 lib/cliapp/src/Obelisk/CliApp/Process.hs+29−48 lib/cliapp/src/Obelisk/CliApp/Spinner.hs+1 lib/command/obelisk-command.cabal+3−7 lib/command/src/Obelisk/Command.hs+79−125 lib/command/src/Obelisk/Command/Deploy.hs+32−49 lib/command/src/Obelisk/Command/Nix.hs+4−4 lib/command/src/Obelisk/Command/Preprocessor.hs+58−62 lib/command/src/Obelisk/Command/Project.hs+41−67 lib/command/src/Obelisk/Command/Run.hs+115−278 lib/command/src/Obelisk/Command/Thunk.hs+280−399 lib/command/src/Obelisk/Command/Utils.hs+4−51 lib/command/src/Obelisk/Command/VmBuilder.hs+8−9 lib/executable-config/default.nix+19−37 lib/executable-config/inject/obelisk-executable-config-inject.cabal+1−1 lib/executable-config/lookup/obelisk-executable-config-lookup.cabal+7−10 lib/executable-config/lookup/src/Obelisk/Configs.hs+12−31 lib/frontend/obelisk-frontend.cabal+1−1 lib/frontend/src/Obelisk/Frontend.hs+1−1 lib/route/README.md−6 lib/route/obelisk-route.cabal+1−2 lib/route/src/Obelisk/Route.hs+52−98 lib/route/src/Obelisk/Route/Frontend.hs+28−41 lib/run/obelisk-run.cabal+2−2 lib/run/src/Obelisk/Run.hs+3−3 lib/selftest/obelisk-selftest.cabal−2 lib/selftest/src/Obelisk/SelfTest.hs+26−194 lib/snap-extras/obelisk-snap-extras.cabal+2−1 lib/snap-extras/src/Obelisk/Snap/Extras.hs+1−1 nixpkgs-overlays/default.nix−15 scripts/ghcid-this-lib+4 skeleton/.gitignore+6−12 skeleton/backend/backend.cabal+1−2 skeleton/cabal.project−1 skeleton/common/common.cabal−1 skeleton/default.nix+3−10 skeleton/frontend/frontend.cabal+4−6 skeleton/shell.nix+1
.github/pull_request_template.md−2
@@ -3,8 +3,6 @@
33I have:
44
55 - [ ] Based work on latest `develop` branch
6− - [ ] Followed the [contribution guide](https://github.com/obsidiansystems/obelisk/blob/develop/CONTRIBUTING.md#submitting-changes)
76 - [ ] Looked for lint in my changes with `hlint .` (lint found code you did not write can be left alone)
87 - [ ] 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)
108 - [ ] (Optional) Run CI tests locally: `nix-build release.nix -A build.x86_64-linux --no-out-link` (or `x86_64-darwin` on macOS)
CONTRIBUTING.md−52
@@ -8,7 +8,6 @@ Contributions and issue reports are encouraged and appreciated!
88 - [Guidelines for Pull Requests](#guidelines-for-pull-requests)
99 - [Code Quality](#code-quality)
1010 - [Documentation](#documentation)
11−- [Development Environment](#development-environment)
1211
1312## Opening Issues
1413
@@ -40,7 +39,6 @@ For breaking changes, new features, refactors, or other major changes, the body
4039
4140Wherever possible, pull requests should add a single feature or fix a single bug. Pull requests should not bundle several unrelated changes.
4241
43−
4442### Code Quality
4543
4644#### Warnings
@@ -79,53 +77,3 @@ Add an entry to the changelog when your PR:
7977#### In the [Readme](README.md)
8078The 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.
8179
82−
83−## Development Environment
84−
85−There are two ways to get live compiler feedback while developing Obelisk libraries. For libraries that are dependencies of the `skeleton` application, the easiest way to get feedback is to
86−
87−```bash
88−cd skeleton
89−ob run
90−```
91−
92−This `ob run` session only loads modules that are dependencies of the skeleton and `obelisk-run`. For example, `obelisk-asset` and `obelisk-route` are used by the skeleton.
93−
94−For other libraries like `obelisk-command` you can use `ghcid`. To launch `ghcid` for `lib/command` you can run
95−
96−```bash
97−nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid"
98−```
99−
100−### Building `ob` for testing
101−
102−To re-install `ob` from source globally you can do
103−
104−```bash
105−nix-env -f /path/to/obelisk -iA command
106−```
107−
108−You can also open a shell with the local version of `ob` available on your `$PATH`:
109−
110−```bash
111−nix run -f /path/to/obelisk command
112−```
113−
114−### Hacking on Obelisk from within an Obelisk project
115−
116−`ob` will defer to the version found in your project's `.obelisk/impl` directory. To work on that version specifically:
117−
118−```bash
119−ob thunk unpack ./.obelisk/impl
120−cd ./.obelisk/impl
121−# apply your changes
122−```
123−
124−If you want to commit your changes, first push them to your fork of obelisk and then
125−
126−```bash
127−cd /your/project/root
128−ob thunk pack .obelisk/impl
129−git add .obelisk/impl
130−git commit -m "Bump obelisk"
131−```
ChangeLog.md+2−47
@@ -1,51 +1,6 @@
11# Revision history for obelisk
22
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.
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, and the date should reflect that release.
494
505## v0.7.0.1
516
@@ -92,7 +47,7 @@ This project's release branch is `master`. This log is written from the perspect
9247* Improve error messaging when a dependency doesn't have the expected `.cabal` or `package.yaml` file. ([#597](https://github.com/obsidiansystems/obelisk/pull/597))
9348* Improve the skeleton in small ways. ([#593](https://github.com/obsidiansystems/obelisk/pull/593), [#589](https://github.com/obsidiansystems/obelisk/pull/589))
9449* 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))
50+* Add `reflex-platform-func` argument to Obelisk's `default.nix`. It defaults to it's prior behavior of using the reflex-platform in in `dep`. ([#612](https://github.com/obsidiansystems/obelisk/pull/612))
9651
9752## v0.3.0.0 - 2019-12-20
9853
FAQ.md+67−62
@@ -1,70 +1,14 @@
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)
3+1. [How do I fix invalid entitlements? ](#how-do-i-fix-invalid-entitlements)
841. [`ob thunk update` or `ob deploy update` fails](#ob-thunk-update-or-ob-deploy-update-fails)
951. [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−
6+1. [What does `ob run` actually do?](#what-does-ob-run-actually-do)
647
658### How do I fix invalid entitlements?
669
67−You probably did not set `ios.bundleIdentifier` correctly in `default.nix`. When this happens you'll see an error something like this:
10+You probably did not set `ios.bundleIdentifier` correctly in `default.nix`.
11+When this happens you'll see an error something like this:
6812
6913```
70142018-11-25 09:34:22.438 ios-deploy[58106:8521046] [ !! ] Error 0xe8008016: The executable was signed with invalid entitlements. AMDeviceSecureInstallApplication(0, device, url, options, install_callback, 0)
@@ -75,7 +19,7 @@ Fixing the value of `ios.bundleIdentifier` should fix the error.
7519### `ob thunk update` or `ob deploy update` fails
7620Whenever an `ob` command fails, try re-running it with `-v`.
7721
78−If you're using a private repo, and you get a failure in `nix-prefetch-url`, you may need to unpack and repack the thunk. Here's some example output that shows this issue:
22+If you're using a private repo, and you get a failure in nix-prefetch-url, you may need to unpack and repack the thunk. Here's some example output that shows this issue:
7923
8024```
8125Starting Obelisk </nix/store/j8wls8a89xr6s1a47lg6g83gnbdrfd0l-obelisk-command-0.1/bin/.ob-wrapped> args=["deploy","update","-v"] logging-level=Debug
@@ -95,7 +39,7 @@ nix-prefetch-url: Failed to determine sha256 hash of URL https://github.com/obsi
9539
9640And here's how you can fix it:
9741
98−```bash
42+```
9943ob thunk unpack $SOME_THUNK
10044ob thunk pack $SOME_THUNK
10145```
@@ -115,3 +59,64 @@ error:
11559```
11660then specify the package you want in the import, e.g:
11761`import "cryptonite" Crypto.Hash`
62+
63+
64+### What does `ob run` actually do?
65+
66+
67+#### Short version:
68+
69+`ob run` starts a [`ghcid`](https://github.com/ndmitchell/ghcid) process which
70+tries to build your project within a carefully crafted `nix-shell` with all the
71+project's dependencies and,
72+
73+* either displays compilation errors/warnings,
74+* or starts the Obelisk server, which serves:
75+ * your backend's route handlers,
76+ * the static assets,
77+ * the [JSaddle](https://github.com/ghcjs/jsaddle) frontend code (while opening its websocket).
78+
79+#### Longer version:
80+
81+Assuming we are in a project created with `ob init`, `ob run` calls (see
82+`lib/command/src/Obelisk/Command.hs`):
83+
84+ nix-shell --pure -A shells.ghc --run 'ob --no-handoff internal run-static-io <real-run-function>'
85+
86+where
87+
88+* `shells.ghc` is defined in `./default.nix` by importing `./.obelisk/impl/default.nix` which
89+ is `default.nix` in the present (Obelisk) repository,
90+* `run-static-io` is a logging-enabled command wrapper
91+ (cf. `runObelisk` in `lib/command/src/Obelisk/App.hs`).
92+
93+In this case, it runs the function `Obelisk.Command.Command.run` (defined in
94+`lib/command/src/Obelisk/Command/Run.hs`).
95+
96+* It creates a GHCi config from a Nix expression which:
97+ * loads three packages: `backend`, `common`, `frontend`,
98+ * obtains a free port number.
99+* Then runs `ghcid`
100+ * with a command that reruns `Obelisk.Run.run` at each restart (option
101+ `--test`).
102+
103+It is defined in `lib/run/src/Obelisk/Run.hs`:
104+
105+* It creates a thread which starts the main backend.
106+ This runs `runSnapWithCommandLineArgs` and passes routes:
107+ * to the backend (result of the `_backend_run` field of your
108+ implementation of the `Backend fullRoute frontendRoute` record),
109+ * or to `serveDefaultObeliskApp` (`lib/backend/src/Obelisk/Backend.hs`) to
110+ serve static assets.
111+* Starts `runWidget`
112+ which itself runs
113+ [runSettingsSocket](https://hackage.haskell.org/package/warp-3.2.26/docs/Network-Wai-Handler-Warp.html#v:runSettingsSocket)
114+ (the *“TCP listen loop”*):
115+ * it binds to TCP socket, and
116+ * creates the HTTP connection manager
117+ ( [`newManager`](https://hackage.haskell.org/package/http-client-0.6.3/docs/Network-HTTP-Client.html#v:newManager))
118+ * calls `obeliskApp` which
119+ * has a route to serve the [JSaddle](https://github.com/ghcjs/jsaddle) frontend,
120+ * runs the frontend (*on* the server), to produce pre-rendered pages,
121+ * starts the JSaddle web-socket,
122+ * “falls back” to proxying the backend (`fallbackProxy`).
README.md+129−71
@@ -1,75 +1,93 @@
11# Obelisk
22
33[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)
4−[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)
4+[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://tldrlegal.com/license/bsd-3-clause-license-%28revised%29)
55
6−<p align="center"><img src="docs/obelisk-logo-640.png" width="50%" alt="Obelisk Logo"></p>
76
8−Functional reactive web and mobile applications, with batteries included. Obelisk's goal is to represent a cohesive, highly-curated set of choices that [Obsidian Systems](https://obsidian.systems/) has made for building these types of applications in a way that is extremely fast but does not compromise on production readiness.
7+Obelisk provides an easy way to develop and deploy your [Reflex](https://github.com/reflex-frp/reflex) project as web apps and as mobile apps.
98
10−- [Overview](#overview)
11− - [Who should consider using it?](#who-should-consider-using-it)
129- [Installing Obelisk](#installing-obelisk)
1310- [Developing an Obelisk project](#developing-an-obelisk-project)
14− - [IDE Support](#ide-support)
11+ - [Adding Packages](#adding-packages)
12+ - [Adding Package Overrides](#adding-package-overrides)
13+ - [Running over https](#running-over-https)
1514- [Deploying](#deploying)
15+ - [Locally](#locally)
1616 - [Default EC2 Deployment](#default-ec2-deployment)
1717 - [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)
1818 - [VirtualBox Deployment](#virtualbox-deployment)
19− - [Locally](#locally)
2019 - [From macOS](#from-macos)
2120 - [Deploying an updated version](#deploying-an-updated-version)
2221- [Mobile](#mobile)
2322 - [iOS](#ios)
2423 - [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−
3824
3925## Installing Obelisk
40−
41261. [Install Nix](https://nixos.org/nix/).
4227 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
43281. Set up nix caches
4429 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
45− ```nix
30+ ```
4631 nix.binaryCaches = [ "https://nixcache.reflex-frp.org" ];
4732 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
4833 ```
4934 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
35+ 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)):
36+ ```
37+ binary-caches = https://cache.nixos.org https://nixcache.reflex-frp.org
38+ binary-cache-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
39+ binary-caches-parallel-connections = 40
5540 ```
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
41+ * 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)
42+ ```
5843 sandbox = true
5944 ```
60− * If you're on MacOS, disable sandboxing (there are still some impure dependencies for now) by adding the following:
61− ```nix
45+ * MacOS: disable sandboxing (there are still some impure dependencies for now)
46+ ```
6247 sandbox = false
6348 ```
6449 then restart the nix daemon
65− ```bash
50+ ```
6651 sudo launchctl stop org.nixos.nix-daemon
6752 sudo launchctl start org.nixos.nix-daemon
6853 ```
69−1. Install obelisk:
70− ```bash
71− nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command
72− ```
54+1. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
55+
56+### Contributing to Obelisk
57+
58+When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
59+
60+```bash
61+nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid -c 'cabal new-repl'"
62+```
63+
64+Or to launch ghcid for `lib/command` project:
65+
66+```bash
67+nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"
68+```
69+
70+To re-install `ob` from source do
71+```bash
72+nix-env -f /path/to/obelisk -iA command
73+```
74+
75+Note that `ob` will defer to the version found in your project's `.obelisk/impl` directory. To update that version specifically:
76+
77+```bash
78+ob thunk unpack ./.obelisk/impl
79+cd ./.obelisk/impl
80+# apply your changes
81+```
82+
83+If you want to commit your changes, first push them to your fork of obelisk and then
84+
85+```bash
86+cd /your/project/root
87+ob thunk pack .obelisk/impl
88+git add .obelisk/impl
89+git commit -m "Bump obelisk"
90+```
7391
7492### Accessing private repositories
7593
@@ -99,12 +117,81 @@ Firefox will not be able to properly run the development website due to [issue 4
99117
100118Every 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.
101119
102−### IDE Support
120+### Adding packages
121+
122+In order to add package dependencies, declare them under the build-depends field in the appropriate cabal files (backend, common, and frontend each have their own). The corresponding Nix packages will automatically be selected when building.
123+
124+### Adding package overrides
125+
126+To add a version override to any Haskell package, or to add a Haskell package that doesn't exist in the nixpkgs used by Obelisk, use the `overrides` attribute in your project's `default.nix`. For example, to use a specific version of the `aeson` package fetched from GitHub and a specific version of the `waargonaut` package fetched from Hackage, your `default.nix` will look like:
127+
128+```nix
129+# ...
130+project ./. ({ pkgs, ... }: {
131+# ...
132+ overrides = self: super: let
133+ aesonSrc = pkgs.fetchFromGitHub {
134+ owner = "obsidiansystems";
135+ repo = "aeson-gadt-th";
136+ rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";
137+ sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";
138+ };
139+ in
140+ {
141+ aeson = self.callCabal2nix "aeson" aesonSrc {};
142+ waargonaut = self.callHackageDirect {
143+ pkg = "waargonaut";
144+ ver = "0.8.0.1";
145+ sha256 = "1zv28np3k3hg378vqm89v802xr0g8cwk7gy3mr77xrzy5jbgpa39";
146+ } {};
147+ };
148+# ...
149+```
150+
151+For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.
152+
153+### Adding extra local packages
154+
155+If the standard packages (`frontend`, `backend`, and `common`) are not
156+enough, to add more local Haskell packages, define them with the
157+`packages` parameter. The sources of these packages will be
158+automatically reloaded by `ob run`.
159+
160+```nix
161+# ...
162+project ./. ({ pkgs, ... }: {
163+# ...
164+ packages = {
165+ another = ./another;
166+ };
167+# ...
168+```
103169
104−Obelisk officially supports terminal-based feedback (akin to [`ghcid`](https://github.com/ndmitchell/ghcid)) in `ob run` and `ob watch`.
170+### Running over HTTPS
171+
172+To run your app locally over https, update the protocol in `config/common/route` to `https`, and then use `ob run` as normal.
173+
174+Since Obelisk generates a self-signed certificate for running https, the browser will issue a warning about using an invalid certificate. On Chrome, you can go to `chrome://flags/#allow-insecure-localhost` to enable invalid certificates for localhost.
105175
106176## Deploying
107177
178+### Locally
179+
180+Build everything:
181+
182+```bash
183+nix-build -A exe --no-out-link
184+```
185+
186+Copy the result to a new directory, add configuration, and run!
187+
188+```bash
189+mkdir test-app
190+ln -s $(nix-build -A exe --no-out-link)/* test-app/
191+cp -r config test-app
192+(cd test-app && ./backend)
193+```
194+
108195### Default EC2 Deployment
109196
110197In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance. Obelisk deployments are configured for EC2 by default (see [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)).
@@ -114,14 +201,14 @@ First create a new EC2 instance:
1142011. 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))
1152021. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1162031. 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.
204+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.
118205
119206At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
120207
121208Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
122209Your 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.
123210
124−```bash
211+```
125212cd ~/code/myapp
126213SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
127214ROUTE=https://myapp.com # Publicly accessible route to your app
@@ -140,7 +227,7 @@ This step will also require that you manually verify the authenticity of the hos
140227
141228Next, go to the deployment directory that you just initialized and deploy!
142229
143−```bash
230+```
144231cd ~/code/myapp-deploy
145232ob deploy push
146233```
@@ -169,25 +256,6 @@ Here's a `module.nix` that is configured for deployment to a VirtualBox VM (runn
169256
170257The `{...}:` and following is the [NixOS module](https://nixos.org/nixos/manual/index.html#sec-writing-modules) definition.
171258
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−
191259### From macOS
192260
193261Deploying from macOS requires some extra setup:
@@ -221,7 +289,7 @@ Your account must also belong to an Apple Developer Team, if you want to access
2212891. Click accept to authorize on both the computer and the iPhone.
222290
223291##### Xcode
224−Install Xcode 11.2 (contains iOS SDK 13.2) and open it so that it runs its post install tool setup.
292+Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
225293
226294These 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`
227295
@@ -314,13 +382,3 @@ This should copy over and install the application on your device (if you see a
314382##### Build a release version
315383
316384After 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.nix+6−15
@@ -1,6 +1,6 @@
11{ self-args ? {
22 config.android_sdk.accept_license = true;
3− iosSdkVersion = "13.2";
3+ iosSdkVersion = "10.2";
44 }
55, local-self ? import ./. self-args
66, supportedSystems ? [ builtins.currentSystem ]
@@ -53,28 +53,19 @@ let
5353 obelisk.haskellPackageSets.ghcjs
5454 obeliskPackagesCommon;
5555 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;
56+ skeleton = import ./skeleton { inherit obelisk; };
57+ serverSkeletonExe = skeleton.exe;
6758 # TODO fix nixpkgs so it doesn't try to run the result of haskell shells as setup hooks.
6859 serverSkeletonShell = local-self.nixpkgs.runCommand "shell-safe-for-dep" {} ''
6960 touch "$out"
7061 echo "return" >> "$out"
7162 cat "${skeleton.shells.ghc}" >> "$out"
7263 '';
73− androidSkeleton = skeleton.android.frontend;
74− iosSkeleton = skeleton.ios.frontend;
64+ androidSkeleton = (import ./skeleton { inherit obelisk; }).android.frontend;
65+ iosSkeleton = (import ./skeleton { inherit obelisk; }).ios.frontend;
7566 nameSuffix = if profiling then "profiled" else "unprofiled";
7667 packages = {
77− skeletonProfiledObRun = rawSkeleton.__unstable__.profiledObRun;
68+ skeletonProfiledObRun = skeleton.__unstable__.profiledObRun;
7869 inherit
7970 command
8071 serverSkeletonShell
all-tests.nix+17−17
@@ -63,18 +63,15 @@ in
6363 '';
6464 in ''
6565 start_all()
66+ githost.wait_for_open_port("22")
6667
67− with subtest("obelisk is installed and git is configured"):
68+ with subtest("test obelisk is installed"):
6869 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")
7370
74− with subtest("the client can access the server via ssh"):
71+ with subtest("test the client can access the server via ssh"):
7572 client.succeed("mkdir -p ~/.ssh/")
7673 client.succeed(
77− "cp ${privateKeyFile} ~/.ssh/id_rsa"
74+ "cp ${privateKeyFile} ~/.ssh/id_rsa"
7875 )
7976 client.succeed("chmod 600 ~/.ssh/id_rsa")
8077 client.wait_until_succeeds(
@@ -85,35 +82,36 @@ in
8582 )
8683 client.wait_until_succeeds("ssh githost true")
8784
88− with subtest("a remote bare repo can be started"):
85+ with subtest("test a remote bare repo can be started"):
8986 githost.succeed("mkdir -p ~/myorg/myapp.git")
9087 githost.succeed("cd ~/myorg/myapp.git && git init --bare")
9188
92− with subtest("a git project can be configured with a remote using ssh"):
89+ with subtest("test a git project can be configured with a remote using ssh"):
9390 client.succeed("mkdir -p ~/code/myapp")
9491 client.succeed("cd ~/code/myapp && git init")
9592 client.succeed(
9693 "cp ${thunkableSample} ~/code/myapp/default.nix"
9794 )
9895 client.succeed("cd ~/code/myapp && git add .")
99−
96+ client.succeed('git config --global user.email "you@example.com"')
97+ client.succeed('git config --global user.name "Your Name"')
10098 client.succeed('cd ~/code/myapp && git commit -m "Initial"')
10199 client.succeed(
102100 "cd ~/code/myapp && git remote add origin root@githost:/root/myorg/myapp.git"
103101 )
104102
105103
106− with subtest("pushing code to the remote"):
104+ with subtest("test pushing code to the remote"):
107105 client.succeed("cd ~/code/myapp && git push -u origin master")
108106 client.succeed("cd ~/code/myapp && git status")
109107
110− with subtest("obelisk can pack"):
108+ with subtest("test obelisk can pack"):
111109 client.succeed("ob -v thunk pack ~/code/myapp")
112− client.succeed("grep -qF 'git.json' ~/code/myapp/thunk.nix")
110+ client.succeed("grep -qF 'git' ~/code/myapp/default.nix")
113111 client.succeed("grep -qF 'myorg' ~/code/myapp/git.json")
114112 client.succeed("ob -v thunk unpack ~/code/myapp")
115113
116− with subtest("obelisk can set the public / private flag"):
114+ with subtest("test obelisk can set the public / private flag"):
117115 client.succeed("ob -v thunk pack ~/code/myapp --private")
118116 client.fail("""grep -qF '"private": practice' ~/code/myapp/git.json""")
119117 client.succeed("""grep -qF '"private": true' ~/code/myapp/git.json""")
@@ -124,20 +122,22 @@ in
124122 client.succeed("nix-build ~/code/myapp")
125123 client.succeed("ob -v thunk unpack ~/code/myapp")
126124
127− with subtest("building an invalid thunk fails"):
125+ with subtest("test building an invalid thunk fails"):
128126 client.succeed("cd ~/code/myapp && git checkout -b bad")
129127 client.succeed(
130128 "cp ${invalidThunkableSample} ~/code/myapp/default.nix"
131129 )
132130 client.succeed("cd ~/code/myapp && git add .")
131+ client.succeed('git config --global user.email "you@example.com"')
132+ client.succeed('git config --global user.name "Your Name"')
133133 client.succeed('cd ~/code/myapp && git commit -m "Bad commit"')
134134 client.succeed("cd ~/code/myapp && git push -u origin bad")
135135 client.succeed("ob -v thunk pack ~/code/myapp --public")
136− client.fail("nix-build ~/code/myapp")
136+ client.fail("nix-build ~/code/myapp")
137137 client.succeed("ob -v thunk unpack ~/code/myapp")
138138 client.succeed("cd ~/code/myapp && git checkout master")
139139
140− with subtest("obelisk can detect private repos"):
140+ with subtest("test obelisk can detect private repos"):
141141 client.succeed("ob -v thunk pack ~/code/myapp")
142142 client.succeed("""grep -qF '"private": true' ~/code/myapp/git.json""")
143143 client.succeed("ob -v thunk unpack ~/code/myapp")
default.nix+120−76
@@ -1,10 +1,7 @@
11{ system ? builtins.currentSystem
22, profiling ? false
3−, iosSdkVersion ? "13.2"
3+, iosSdkVersion ? "10.2"
44, config ? {}
5−, terms ? { # Accepted terms, conditions, and licenses
6− security.acme.acceptTerms = false;
7− }
85, reflex-platform-func ? import ./dep/reflex-platform
96}:
107let
@@ -14,18 +11,104 @@ let
1411
1512 inherit (import dep/gitignore.nix { inherit (nixpkgs) lib; }) gitignoreSource;
1613
14+ cleanSource = src:
15+ # WARNING: The order of application here seems to matter a great deal to
16+ # how quickly `ghcid` is able to reload changes. As a rule of thumb,
17+ # always apply `gitignoreSource` first.
18+ # See https://github.com/obsidiansystems/obelisk/pull/666 and related.
19+ pkgs.lib.cleanSource (gitignoreSource src);
20+
21+ commandRuntimeDeps = pkgs: with pkgs; [
22+ coreutils
23+ git
24+ nix-prefetch-git
25+ openssh
26+ ];
27+
1728 getReflexPlatform = { system, enableLibraryProfiling ? profiling }: reflex-platform-func {
1829 inherit iosSdkVersion config system enableLibraryProfiling;
1930
2031 nixpkgsOverlays = [
21− (import ./nixpkgs-overlays)
32+ (self: super: {
33+ obeliskExecutableConfig = import ./lib/executable-config { nixpkgs = pkgs; filterGitSource = cleanSource; };
34+ })
2235 ];
2336
2437 haskellOverlays = [
25− (import ./haskell-overlays/misc-deps.nix { inherit hackGet; })
38+
39+ # Fix misc upstream packages
40+ (self: super: let
41+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
42+ haskellLib = pkgs.haskell.lib;
43+ in {
44+ hnix = haskellLib.dontCheck (haskellLib.doJailbreak (self.callCabal2nix "hnix" (hackGet dep/hnix) {}));
45+ hnix-store-core = self.callHackage "hnix-store-core" "0.1.0.0" {};
46+
47+ ghcid = self.callCabal2nix "ghcid" (hackGet ./dep/ghcid) {};
48+ # Exports more internals
49+ snap-core = haskellLib.dontCheck (self.callCabal2nix "snap-core" (hackGet ./dep/snap-core) {});
50+ })
51+
2652 pkgs.obeliskExecutableConfig.haskellOverlay
27− (import ./haskell-overlays/obelisk.nix)
28− (import ./haskell-overlays/tighten-ob-exes.nix)
53+
54+ # Add obelisk packages
55+ (self: super: let
56+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
57+ onLinux = pkg: f: if pkgs.stdenv.isLinux then f pkg else pkg;
58+ in {
59+ shelly = self.callHackage "shelly" "1.9.0" {};
60+
61+ obelisk-executable-config-inject = pkgs.obeliskExecutableConfig.platforms.web.inject self;
62+
63+ obelisk-asset-manifest = self.callCabal2nix "obelisk-asset-manifest" (cleanSource ./lib/asset/manifest) {};
64+ obelisk-asset-serve-snap = self.callCabal2nix "obelisk-asset-serve-snap" (cleanSource ./lib/asset/serve-snap) {};
65+ obelisk-backend = self.callCabal2nix "obelisk-backend" (cleanSource ./lib/backend) {};
66+ obelisk-cliapp = self.callCabal2nix "obelisk-cliapp" (cleanSource ./lib/cliapp) {};
67+ obelisk-command = haskellLib.overrideCabal (self.callCabal2nix "obelisk-command" (cleanSource ./lib/command) {}) {
68+ librarySystemDepends = [
69+ pkgs.jre
70+ pkgs.nix
71+ (haskellLib.justStaticExecutables self.ghcid)
72+ ];
73+ };
74+ obelisk-frontend = self.callCabal2nix "obelisk-frontend" (cleanSource ./lib/frontend) {};
75+ obelisk-run = onLinux (self.callCabal2nix "obelisk-run" (cleanSource ./lib/run) {}) (pkg:
76+ haskellLib.overrideCabal pkg (drv: { librarySystemDepends = [ pkgs.iproute ]; })
77+ );
78+ obelisk-route = self.callCabal2nix "obelisk-route" (cleanSource ./lib/route) {};
79+ obelisk-selftest = haskellLib.overrideCabal (self.callCabal2nix "obelisk-selftest" (cleanSource ./lib/selftest) {}) {
80+ librarySystemDepends = [
81+ pkgs.cabal-install
82+ pkgs.coreutils
83+ pkgs.git
84+ pkgs.nix
85+ pkgs.rsync
86+ ];
87+ };
88+ obelisk-snap-extras = self.callCabal2nix "obelisk-snap-extras" (cleanSource ./lib/snap-extras) {};
89+ tabulation = self.callCabal2nix "tabulation" (cleanSource ./lib/tabulation) {};
90+ })
91+
92+ (self: super: let
93+ pkgs = self.callPackage ({ pkgs }: pkgs) {};
94+ haskellLib = pkgs.haskell.lib;
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+ (haskellLib.generateOptparseApplicativeCompletion "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
@@ -46,9 +129,9 @@ in rec {
46129 pathGit = ./.; # Used in CI by the migration graph hash algorithm to correctly ignore files.
47130 path = reflex-platform.filterGit ./.;
48131 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
132+ obeliskEnvs = pkgs.lib.filterAttrs (k: _: pkgs.lib.strings.hasPrefix "obelisk-" k) ghcObeliskEnvs;
50133 command = ghcObelisk.obelisk-command;
51− shell = pinBuildInputs "obelisk-shell" ([command] ++ command.commandRuntimeDeps);
134+ shell = pinBuildInputs "obelisk-shell" ([command] ++ commandRuntimeDeps pkgs);
52135
53136 selftest = pkgs.writeScript "selftest" ''
54137 #!${pkgs.runtimeShell}
@@ -77,20 +160,16 @@ in rec {
77160 '';
78161
79162 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
163+ mkdir $out
164+ cd $out
165+ # TODO profiling + static shouldn't break and need an ad-hoc workaround like that
166+ ln -s "${haskellLib.justStaticExecutables frontend}/bin/frontend.jsexe/all.js" all.unminified.js
167+ ${if optimizationLevel == null then ''
168+ ln -s all.unminified.js all.js
169+ '' else ''
170+ ${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
171+ echo "//# sourceMappingURL=all.js.map" >> all.js
172+ ''}
94173 '';
95174
96175 serverModules = {
@@ -116,8 +195,6 @@ in rec {
116195 security.acme.certs = if enableHttps then {
117196 "${routeHost}".email = adminEmail;
118197 } else {};
119−
120− security.acme.${if enableHttps && (terms.security.acme.acceptTerms or false) then "acceptTerms" else null} = true;
121198 };
122199
123200 mkObeliskApp =
@@ -134,16 +211,12 @@ in rec {
134211 }: {...}: {
135212 services.nginx = {
136213 enable = true;
137− recommendedProxySettings = true;
138214 virtualHosts."${routeHost}" = {
139215 enableACME = enableHttps;
140216 forceSSL = enableHttps;
141217 locations.${baseUrl} = {
142218 proxyPass = "http://127.0.0.1:" + toString internalPort;
143219 proxyWebsockets = true;
144− extraConfig = ''
145− access_log off;
146− '';
147220 };
148221 };
149222 };
@@ -184,11 +257,9 @@ in rec {
184257 pkgs.runCommand "serverExe" {} ''
185258 mkdir $out
186259 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
260+ ln -s "${if profiling then backend else haskellLib.justStaticExecutables backend}"/bin/* $out/
261+ ln -s "${mkAssets assets}" $out/static.assets
262+ ln -s ${mkAssets (compressedJs frontend optimizationLevel)} $out/frontend.jsexe.assets
192263 echo ${version} > $out/version
193264 '';
194265
@@ -202,20 +273,6 @@ in rec {
202273 (module { inherit exe hostName adminEmail routeHost enableHttps version; nixosPkgs = pkgs; })
203274 (serverModules.mkDefaultNetworking args)
204275 (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− })
219276 ];
220277 };
221278 };
@@ -236,14 +293,13 @@ in rec {
236293 , shellToolOverrides ? _: _: {}
237294 , withHoogle ? false # Setting this to `true` makes shell reloading far slower
238295 , __closureCompilerOptimizationLevel ? "ADVANCED" # Set this to `null` to skip the closure-compiler step
239− , __withGhcide ? false
240296 }:
241297 let
242298 allConfig = nixpkgs.lib.makeExtensible (self: {
243299 base = base';
244300 inherit args;
245301 userSettings = {
246− inherit android ios packages overrides tools shellToolOverrides withHoogle __closureCompilerOptimizationLevel __withGhcide;
302+ inherit android ios packages overrides tools shellToolOverrides withHoogle __closureCompilerOptimizationLevel;
247303 staticFiles = if staticFiles == null then self.base + /static else staticFiles;
248304 };
249305 frontendName = "frontend";
@@ -300,17 +356,9 @@ in rec {
300356 self.frontendName
301357 ];
302358
303− shellToolOverrides = lib.composeExtensions
304− self.userSettings.shellToolOverrides
305− (if self.userSettings.__withGhcide
306− then (import ./haskell-overlays/ghcide.nix)
307− else (_: _: {})
308− );
309−
310359 project = reflexPlatformProject ({...}: self.projectConfig);
311360 projectConfig = {
312− inherit (self) shellToolOverrides;
313− inherit (self.userSettings) tools withHoogle;
361+ inherit (self.userSettings) shellToolOverrides tools withHoogle;
314362 overrides = self.totalOverrides;
315363 packages = self.combinedPackages;
316364 shells = {
@@ -350,33 +398,29 @@ in rec {
350398 __unstable__.profiledObRun = let
351399 profiled = projectOut { inherit system; enableLibraryProfiling = true; };
352400 exeSource = builtins.toFile "ob-run.hs" ''
353− {-# LANGUAGE NoImplicitPrelude #-}
354− {-# LANGUAGE PackageImports #-}
355401 module Main where
356402
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)
403+ import Control.Exception
404+ import Reflex.Profiled
405+ import System.Environment
363406
364− import qualified "obelisk-run" Obelisk.Run
407+ import qualified Obelisk.Run
365408 import qualified Frontend
366409 import qualified Backend
367410
368411 main :: IO ()
369412 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")
413+ args <- getArgs
414+ let port = read $ args !! 0
415+ assets = args !! 1
416+ profileFile = (args !! 2) <> ".rprof"
417+ Obelisk.Run.run port (Obelisk.Run.runServeAsset assets) Backend.backend Frontend.frontend `finally` writeProfilingData profileFile
373418 '';
374419 in nixpkgs.runCommand "ob-run" {
375− buildInputs = [ (profiled.ghc.ghcWithPackages (p: [p.backend p.frontend])) ];
420+ buildInputs = [ (profiled.ghc.ghcWithPackages (p: [ p.backend p.frontend])) ];
376421 } ''
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
422+ mkdir -p $out/bin/
423+ ghc -x hs -prof -fno-prof-auto -threaded ${exeSource} -o $out/bin/ob-run
380424 '';
381425
382426 linuxExeConfigurable = linuxExe;
dep/.gitignorenew file+5
@@ -0,0 +1,5 @@
1+*
2+!*/
3+!.gitignore
4+!*/*.json
5+!*/default.nix
dep/reflex-platform/default.nix+7−1
@@ -1,2 +1,8 @@
11# DO NOT HAND-EDIT THIS FILE
2−import (import ./thunk.nix)
2+let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3+ if !fetchSubmodules && !private then builtins.fetchTarball {
4+ url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5+ } else (import <nixpkgs> {}).fetchFromGitHub {
6+ inherit owner repo rev sha256 fetchSubmodules private;
7+ };
8+in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))
dep/reflex-platform/github.json+4−4
@@ -1,8 +1,8 @@
11{
22 "owner": "reflex-frp",
33 "repo": "reflex-platform",
4− "branch": "release/0.7.0.0",
4+ "branch": "master",
55 "private": false,
6− "rev": "27a7851a780ff21472d85f9a02fb84635ef9027a",
7− "sha256": "1m4zlw91dpjlbdchjyxhvhv3k7lilm0qa17dhhww868xxc27sann"
8−}
6+ "rev": "41be4d952b75515a037318aa344dd6b13ad29cfe",
7+ "sha256": "132yqzyzd3c5fjy7wwnwa5d6pjxv5ap2xz0swwbv3h5pwi8jwv0a"
8+}
dep/reflex-platform/thunk.nixdeleted−9
@@ -1,9 +0,0 @@
1−# DO NOT HAND-EDIT THIS FILE
2−let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:
3− if !fetchSubmodules && !private then builtins.fetchTarball {
4− url = "https://github.com/${owner}/${repo}/archive/${rev}.tar.gz"; inherit sha256;
5− } else (import <nixpkgs> {}).fetchFromGitHub {
6− inherit owner repo rev sha256 fetchSubmodules private;
7− };
8− json = builtins.fromJSON (builtins.readFile ./github.json);
9−in fetch json
docs/obelisk-logo-640.pngdeleted

Binary file not shown.

guides/app-deploy/README.md+12−25
@@ -1,14 +1,13 @@
11# Obelisk Application Deployment Guide
2−
32This 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.
43
5−> **Note:** This guide can be completed on a Linux host with Nix installed or a macOS host with Nix installed. Each section is labeled regarding which operating system hosts it supports. When going through the guide, start at the beginning and go through all sections that are supported on your host and merely skip sections that are not supported. The sections for iOS deployments require an iPhone or iPad device and the sections for Android deployments require an Android device. This guide assumes that you have Nix correctly set up and that your system is configured to fetch from binary caches instead of building everything on your machine. If you notice any of the commands below takes more than 5 minutes, then caches are not likely enabled.
4+> **Note:** To complete this *entire* guide you need access to a macOS machine running the latest OSX release, a Linux machine (can be a VM on that mac) with Nix installed, an iPhone or iPad, and a recent Android device. It also assumes that you have Nix correctly set up and that your system is set up to fetch from binary caches instead of building everything on your machine. If you notice any of the commands below takes more than 5 minutes, then caches are not likely enabled.
65>
76> 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.
87
9−## a) Get Obelisk (Linux, Mac)
8+## a) Get Obelisk
109
11−There are several ways to install Obelisk, but the one we are going to use here allows us to test a single version of Obelisk in different ways. The approach is to clone Obelisk from its GitHub repository and start a project that uses that local check out.
10+There are several ways to install Obelisk, but the one we are going to use here allows us to test a single version of Obelisk in different ways. The approach is to clone Obelisk from it's GitHub repository and start a project that uses that local check out.
1211
1312Open a terminal and run the following:
1413
@@ -40,7 +39,7 @@ ob init --branch "$OBELISK_BRANCH"
4039
4140> **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.
4241
43−## b) Run the Obelisk app on localhost (Linux, Mac)
42+## b) Run the Obelisk app on localhost
4443
4544Let's test that we can run a server on localhost. This is quite easy:
4645
@@ -53,10 +52,9 @@ Now open a browser and point it to http://localhost:8000 (or just click on this
5352
5453![](assets/app-deploy.png)
5554
56−## c) Prepare a VirtualBox deploy target (Linux, Mac)
55+## c) Deploy the web app on a remote machine
5756
5857### Import the NixOS VirtualBox appliance
59−
6058Install [VirtualBox](https://www.virtualbox.org/) on your machine.
6159
6260On NixOS, do this by adding the following line to your `/etc/nixos/configuration.nix` before the last line containing `}`:
@@ -81,7 +79,7 @@ You should now see a NixOS machine in the dashboard:
8179
8280![](assets/virtualbox-dashboard-nixos.png)
8381
84−If you are on a network with DHCP on your wireless or network card then right-click on the "NixOS" image and click "Settings". Go to the "Network" section and make "Attached to:" set to "Bridged Adapter".
82+If you are on a network with DHCP on your wireless or network card then select right-click on the "NixOS" image and click "Settings". Go to the "Network" section and make "Attached to:" set to "Bridged Adapter".
8583
8684![](assets/virtualbox-image-settings-network.png)
8785
@@ -203,7 +201,7 @@ git remote add origin "$WORKDIR/myapp-git-remote"
203201git push -u origin master
204202```
205203
206−### Initialize deployment directory
204+### Deploy
207205
208206With that, we can come back to the Obelisk app and initialize the deployment:
209207
@@ -218,11 +216,7 @@ Then configure the deployment for VirtualBox:
218216echo '{nixosPkgs, ...}: {...}: { imports = [ (nixosPkgs.path + /nixos/modules/virtualisation/virtualbox-image.nix) ]; }' > "$WORKDIR/myappdeploy/module.nix"
219217```
220218
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.
219+And deploy:
226220
227221```bash
228222cd "$WORKDIR/myappdeploy"
@@ -249,7 +243,7 @@ It should look like this:
249243
250244Congratulations! You have deployed an Obelisk application to a remote server via SSH.
251245
252−## e) Deploy an Android app (Linux only)
246+## d) Deploy an Android app (Linux host only)
253247
254248> **Note:** This section requires that you be running a Linux *host*.
255249
@@ -263,7 +257,7 @@ git commit -m"Accept license"
263257git push
264258```
265259
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.
260+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.
267261
268262Now update your deployment and deploy to Android:
269263
@@ -273,14 +267,7 @@ ob deploy update
273267ob deploy test android -v
274268```
275269
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.
270+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. 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.
284271
285272When connecting your Android device you may be asked to "Allow USB debugging". You need to allow it.
286273![](assets/android-confirm-usb-debugging.jpg)
@@ -292,7 +279,7 @@ When the deployment is complete opening the app should look something like
292279
293280Congratulations! You have deployed an Obelisk Android app via USB.
294281
295−## f) Deploy an iOS app (Mac only)
282+## e) Deploy an iOS app (macOS host only)
296283
297284> **Note:** This section requires that you be running a macOS *host*.
298285
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−}
lib/asset/README.md+19−16
@@ -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
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+```
1919myAssets = 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−4
@@ -24,7 +24,7 @@ library
2424 , template-haskell
2525 , text
2626 , transformers
27− , unix-compat
27+ , unix
2828 , vector
2929 exposed-modules:
3030 Obelisk.Asset.Gather
@@ -33,9 +33,7 @@ library
3333 Obelisk.Asset.TH
3434
3535 other-extensions: TemplateHaskell
36− ghc-options:
37− -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O2
38− -fno-warn-unused-do-bind -funbox-strict-fields -fprof-auto-calls
36+ ghc-options: -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs -funbox-strict-fields -O2 -fprof-auto-calls
3937
4038executable obelisk-asset-manifest-generate
4139 hs-source-dirs: src-bin
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/Serve/Snap.hs+1−1
@@ -31,7 +31,7 @@ import Data.Text.Encoding (decodeUtf8, encodeUtf8)
3131import System.Directory (getDirectoryContents)
3232import System.FilePath ((</>), splitFileName, takeDirectory)
3333import System.IO.Error (isDoesNotExistError)
34−import System.PosixCompat.Files (getFileStatus, fileSize)
34+import System.Posix (getFileStatus, fileSize)
3535
3636-- | Serve static assets from an asset directory generated via @assets.nix@ or, failing that, from a regular directory.
3737--
lib/backend/obelisk-backend.cabal+2−2
@@ -21,10 +21,10 @@ library
2121 obelisk-frontend,
2222 obelisk-route,
2323 obelisk-snap-extras,
24− reflex-dom-core,
24+ reflex-dom,
2525 snap,
2626 snap-server,
2727 text,
2828 universe
2929 exposed-modules: Obelisk.Backend
30− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
30+ ghc-options: -Wall
lib/backend/src/Obelisk/Backend.hs+1−1
@@ -58,7 +58,7 @@ import qualified Obelisk.ExecutableConfig.Lookup as Lookup
5858import Obelisk.Frontend
5959import Obelisk.Route
6060import Obelisk.Snap.Extras (doNotCache, serveFileIfExistsAs)
61−import Reflex.Dom.Core
61+import Reflex.Dom
6262import Snap (MonadSnap, Snap, commandLineConfig, defaultConfig, getsRequest, httpServe, modifyResponse
6363 , rqPathInfo, rqQueryString, setContentType, writeBS, writeText
6464 , rqCookies, Cookie(..) , setHeader)
lib/cliapp/obelisk-cliapp.cabal+1−3
@@ -19,12 +19,10 @@ library
1919 , monad-loops
2020 , mtl
2121 , process
22− , shell-escape
2322 , terminal-size
2423 , text
2524 , time
2625 , transformers
27− , utf8-string
2826 exposed-modules:
2927 Obelisk.CliApp
3028 other-modules:
@@ -34,4 +32,4 @@ library
3432 Obelisk.CliApp.TerminalString
3533 Obelisk.CliApp.Theme
3634 Obelisk.CliApp.Types
37− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
35+ ghc-options: -Wall -fobject-code
lib/cliapp/src/Obelisk/CliApp.hs−3
@@ -39,9 +39,7 @@ module Obelisk.CliApp
3939 , callCommand
4040 , callProcess
4141 , callProcessAndLogOutput
42− , createProcess
4342 , createProcess_
44− , exitCodeToException
4543 , overCreateProcess
4644 , proc
4745 , readCreateProcessWithExitCode
@@ -49,7 +47,6 @@ module Obelisk.CliApp
4947 , readProcessAndLogStderr
5048 , readProcessJSONAndLogStderr
5149 , reconstructCommand
52− , runProcess_
5350 , setCwd
5451 , setDelegateCtlc
5552 , setEnvOverride
lib/cliapp/src/Obelisk/CliApp/Logging.hs+2−2
@@ -160,7 +160,7 @@ failWith :: (CliThrow e m, AsUnstructuredError e) => Text -> m a
160160failWith = throwError . review asUnstructuredError
161161
162162errorToWarning
163− :: (HasCliConfig e m, CliLog m)
163+ :: (HasCliConfig e m, CliThrow e m, CliLog m)
164164 => e -> m ()
165165errorToWarning e = do
166166 c <- getCliConfig
@@ -177,7 +177,7 @@ withExitFailMessage msg f = f `catch` \(e :: ExitCode) -> do
177177 throwM e
178178
179179-- | Write log to stdout, with colors (unless `noColor`)
180−writeLog :: (MonadIO m) => Bool -> Bool -> WithSeverity Text -> m ()
180+writeLog :: (MonadIO m, MonadMask m) => Bool -> Bool -> WithSeverity Text -> m ()
181181writeLog withNewLine noColor (WithSeverity severity s) = if T.null s then pure () else write
182182 where
183183 write
lib/cliapp/src/Obelisk/CliApp/Process.hs+29−48
@@ -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 #-}
@@ -16,7 +17,6 @@ module Obelisk.CliApp.Process
1617 , callProcessAndLogOutput
1718 , createProcess
1819 , createProcess_
19− , exitCodeToException
2020 , overCreateProcess
2121 , proc
2222 , readCreateProcessWithExitCode
@@ -24,7 +24,6 @@ module Obelisk.CliApp.Process
2424 , readProcessAndLogStderr
2525 , readProcessJSONAndLogStderr
2626 , reconstructCommand
27− , runProcess_
2827 , setCwd
2928 , setDelegateCtlc
3029 , setEnvOverride
@@ -33,14 +32,12 @@ module Obelisk.CliApp.Process
3332 ) where
3433
3534import Control.Monad ((<=<), join, void)
36−import Control.Monad.Catch (MonadMask, bracketOnError)
3735import Control.Monad.Except (throwError)
3836import Control.Monad.Fail
3937import Control.Monad.IO.Class (MonadIO, liftIO)
4038import Control.Lens (Prism', review)
4139import qualified Data.ByteString as BS
4240import qualified Data.ByteString.Char8 as BSC
43−import qualified Data.ByteString.UTF8 as BSU
4441import Data.Function (fix)
4542import Data.Map (Map)
4643import qualified Data.Map as Map
@@ -57,7 +54,6 @@ import qualified System.IO.Streams as Streams
5754import System.IO.Streams.Concurrent (concurrentMerge)
5855import System.Process (CreateProcess, ProcessHandle, StdStream (CreatePipe), std_err, std_out)
5956import qualified System.Process as Process
60−import Text.ShellEscape (bash, bytes)
6157import qualified Data.Aeson as Aeson
6258
6359import Control.Monad.Log (Severity (..))
@@ -101,7 +97,7 @@ instance AsProcessFailure ProcessFailure where
10197 asProcessFailure = id
10298
10399readProcessAndLogStderr
104− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
100+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)
105101 => Severity -> ProcessSpec -> m Text
106102readProcessAndLogStderr sev process = do
107103 (out, _err) <- withProcess process $ \_out err -> do
@@ -109,7 +105,7 @@ readProcessAndLogStderr sev process = do
109105 liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out
110106
111107readProcessJSONAndLogStderr
112− :: (Aeson.FromJSON a, MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
108+ :: (Aeson.FromJSON a, MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)
113109 => Severity -> ProcessSpec -> m a
114110readProcessJSONAndLogStderr sev process = do
115111 (out, _err) <- withProcess process $ \_out err -> do
@@ -122,7 +118,7 @@ readProcessJSONAndLogStderr sev process = do
122118 throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) 0
123119
124120readCreateProcessWithExitCode
125− :: (MonadIO m, CliLog m)
121+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e)
126122 => ProcessSpec -> m (ExitCode, String, String)
127123readCreateProcessWithExitCode procSpec = do
128124 process <- mkCreateProcess procSpec
@@ -132,10 +128,10 @@ readCreateProcessWithExitCode procSpec = do
132128-- | Like `System.Process.readProcess` but logs the combined output (stdout and stderr)
133129-- with the corresponding severity.
134130--
135−-- Usually this function is called as `readProcessAndLogOutput (Debug, Error)`. However
131+-- Usually this function is called as `callProcessAndLogOutput (Debug, Error)`. However
136132-- some processes are known to spit out diagnostic or informative messages in stderr, in
137133-- which case it is advisable to call it with a non-Error severity for stderr, like
138−-- `readProcessAndLogOutput (Debug, Debug)`.
134+-- `callProcessAndLogOutput (Debug, Debug)`.
139135readProcessAndLogOutput
140136 :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)
141137 => (Severity, Severity) -> ProcessSpec -> m Text
@@ -148,7 +144,9 @@ readProcessAndLogOutput (sev_out, sev_err) process = do
148144 outText <- liftIO $ T.decodeUtf8With lenientDecode <$> BS.hGetContents out
149145 putLogRaw sev_out outText
150146
151− outText <$ (exitCodeToException process =<< waitForProcess p)
147+ waitForProcess p >>= \case
148+ ExitSuccess -> pure outText
149+ ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) code
152150
153151-- | Like 'System.Process.callProcess' but logs the combined output (stdout and stderr)
154152-- with the corresponding severity.
@@ -158,7 +156,7 @@ readProcessAndLogOutput (sev_out, sev_err) process = do
158156-- which case it is advisable to call it with a non-Error severity for stderr, like
159157-- `callProcessAndLogOutput (Debug, Debug)`.
160158callProcessAndLogOutput
161− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
159+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)
162160 => (Severity, Severity) -> ProcessSpec -> m ()
163161callProcessAndLogOutput (sev_out, sev_err) process =
164162 void $ withProcess process $ \out err -> do
@@ -188,11 +186,12 @@ createProcess_ name procSpec = do
188186 liftIO $ Process.createProcess_ name p
189187
190188mkCreateProcess :: 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) }
189+mkCreateProcess (ProcessSpec p override') = do
190+ case override' of
191+ Nothing -> pure p
192+ Just override -> do
193+ procEnv <- Map.fromList <$> maybe (liftIO getEnvironment) pure (Process.env p)
194+ pure $ p { Process.env = Just $ Map.toAscList (override procEnv) }
196195
197196-- | Like `System.Process.callProcess` but also logs (debug) the process being run
198197callProcess
@@ -211,30 +210,18 @@ callCommand cmd = do
211210 liftIO $ Process.callCommand cmd
212211
213212withProcess
214− :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadMask m)
213+ :: (MonadIO m, CliLog m, CliThrow e m, AsProcessFailure e, MonadFail m)
215214 => 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− )
228−
229−-- | Runs a process to completion failing if it does not exit cleanly.
230−runProcess_
231− :: (MonadIO m, CliLog m, CliThrow e m, MonadMask m, AsProcessFailure e)
232− => ProcessSpec -> m ()
233−runProcess_ process =
234− bracketOnError
235− (createProcess process)
236− (liftIO . Process.cleanupProcess)
237− (\(_, _, _, ph) -> exitCodeToException process =<< waitForProcess ph)
215+withProcess process f = do -- TODO: Use bracket.
216+ -- FIXME: Using `withCreateProcess` here leads to something operating illegally on closed handles.
217+ (_, Just out, Just err, p) <- createProcess $ overCreateProcess
218+ (\x -> x { std_out = CreatePipe , std_err = CreatePipe }) process
219+
220+ f out err -- Pass the handles to the passed function
221+
222+ waitForProcess p >>= \case
223+ ExitSuccess -> return (out, err)
224+ ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess process) code
238225
239226-- Create an input stream from the file handle, associating each item with the given severity.
240227streamHandle :: Severity -> Handle -> IO (InputStream (Severity, BSC.ByteString))
@@ -253,20 +240,14 @@ streamToLog stream = fix $ \loop -> do
253240waitForProcess :: MonadIO m => ProcessHandle -> m ExitCode
254241waitForProcess = liftIO . Process.waitForProcess
255242
256−-- | Converts an 'ExitCode' to an exception when it's non-zero.
257−exitCodeToException :: (CliThrow e m, AsProcessFailure e) => ProcessSpec -> ExitCode -> m ()
258−exitCodeToException spec = \case
259− ExitSuccess -> pure ()
260− ExitFailure code -> throwError $ review asProcessFailure $ ProcessFailure (Process.cmdspec $ _processSpec_createProcess spec) code
261−
262243-- | Pretty print a 'CmdSpec'
263244reconstructCommand :: Process.CmdSpec -> Text
264245reconstructCommand p = case p of
265246 Process.ShellCommand str -> T.pack str
266247 Process.RawCommand c as -> processToShellString c as
267248 where
268− processToShellString cmd args = T.pack $ unwords $
269− map (BSU.toString . bytes . bash . BSU.fromString) (cmd : args)
249+ processToShellString cmd args = T.unwords $ map quoteAndEscape (cmd : args)
250+ quoteAndEscape x = "'" <> T.replace "'" "'\''" (T.pack x) <> "'"
270251
271252reconstructProcSpec :: ProcessSpec -> Text
272253reconstructProcSpec = reconstructCommand . Process.cmdspec . _processSpec_createProcess
lib/cliapp/src/Obelisk/CliApp/Spinner.hs+1
@@ -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
lib/command/obelisk-command.cabal+3−7
@@ -1,5 +1,5 @@
11name: obelisk-command
2−version: 0.9.0.1
2+version: 0.7.0.1
33cabal-version: >= 1.8
44build-type: Simple
55
@@ -18,7 +18,6 @@ library
1818 , either
1919 , errors
2020 , exceptions
21− , extra
2221 , filepath
2322 , git
2423 , github
@@ -31,7 +30,6 @@ library
3130 , megaparsec
3231 , modern-uri
3332 , monad-loops
34− , monoidal-containers
3533 , mtl
3634 , network
3735 , network-uri
@@ -39,15 +37,13 @@ library
3937 , optparse-applicative
4038 , placeholders
4139 , process
42− , shell-escape
4340 , temporary
4441 , terminal-size
4542 , text
4643 , time
4744 , transformers
48− , unix-compat
45+ , unix
4946 , unordered-containers
50− , utf8-string
5147 , which
5248 , yaml
5349 exposed-modules:
@@ -66,4 +62,4 @@ library
6662executable ob
6763 main-is: src-bin/ob.hs
6864 build-depends: base, obelisk-command
69− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -threaded
65+ ghc-options: -Wall -O2 -threaded
lib/command/src/Obelisk/Command.hs+79−125
@@ -3,18 +3,14 @@
33{-# LANGUAGE MultiParamTypeClasses #-}
44{-# LANGUAGE OverloadedStrings #-}
55{-# LANGUAGE ScopedTypeVariables #-}
6−{-# LANGUAGE TupleSections #-}
76module Obelisk.Command where
87
9−import Control.Monad.IO.Class (MonadIO, liftIO)
8+import Control.Monad
9+import Control.Monad.IO.Class (liftIO)
1010import Data.Bool (bool)
1111import 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
12+import Data.List
1613import qualified Data.Text as T
17−import Data.Traversable (for)
1814import Options.Applicative
1915import Options.Applicative.Help.Pretty (text, (<$$>))
2016import System.Directory
@@ -22,7 +18,7 @@ import System.Environment
2218import System.FilePath
2319import qualified System.Info
2420import System.IO (hIsTerminalDevice, stdout)
25−import System.Process (rawSystem)
21+import System.Posix.Process (executeFile)
2622
2723import Obelisk.App
2824import Obelisk.CliApp
@@ -74,8 +70,8 @@ argsInfo cfg = info (args cfg <**> helper) $ mconcat
7470initSource :: Parser InitSource
7571initSource = foldl1 (<|>)
7672 [ 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")
73+ , InitSource_Branch <$> strOption (long "branch" <> metavar "BRANCH")
74+ , InitSource_Symlink <$> strOption (long "symlink" <> action "directory" <> metavar "PATH")
7975 ]
8076
8177initForce :: Parser Bool
@@ -84,11 +80,11 @@ initForce = switch (long "force" <> help "Allow ob init to overwrite files")
8480data ObCommand
8581 = ObCommand_Init InitSource Bool
8682 | ObCommand_Deploy DeployCommand
87− | ObCommand_Run [(FilePath, Interpret)]
83+ | ObCommand_Run
8884 | ObCommand_Profile String [String]
89− | ObCommand_Thunk ThunkOption
90− | ObCommand_Repl [(FilePath, Interpret)]
91− | ObCommand_Watch [(FilePath, Interpret)]
85+ | ObCommand_Thunk ThunkCommand
86+ | ObCommand_Repl
87+ | ObCommand_Watch
9288 | ObCommand_Shell ShellOpts
9389 | ObCommand_Doc String [String] -- shell and list of packages
9490 | ObCommand_Hoogle String Int -- shell and port
@@ -99,9 +95,6 @@ data ObInternal
9995 -- the preprocessor argument syntax is also handled outside
10096 -- optparse-applicative, but it shouldn't ever conflict with another syntax
10197 = ObInternal_ApplyPackages String String String [String]
102− | ObInternal_ExportGhciConfig
103− [(FilePath, Interpret)]
104− Bool -- ^ Use relative paths
10598 deriving Show
10699
107100obCommand :: ArgsConfig -> Parser ObCommand
@@ -109,29 +102,20 @@ obCommand cfg = hsubparser
109102 (mconcat
110103 [ command "init" $ info (ObCommand_Init <$> initSource <*> initForce) $ progDesc "Initialize an Obelisk project"
111104 , 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"
105+ , command "run" $ info (pure ObCommand_Run) $ progDesc "Run current project in development mode"
113106 , 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"
107+ , command "thunk" $ info (ObCommand_Thunk <$> thunkCommand) $ progDesc "Manipulate thunk directories"
108+ , command "repl" $ info (pure ObCommand_Repl) $ progDesc "Open an interactive interpreter"
109+ , command "watch" $ info (pure ObCommand_Watch) $ progDesc "Watch current project for errors and warnings"
110+ , command "shell" $ info (ObCommand_Shell <$> shellOpts) $ progDesc "Enter a shell with project dependencies"
118111 , command "doc" $ info (ObCommand_Doc <$> shellFlags <*> packageNames) $
119112 progDesc "List paths to haddock documentation for specified packages"
120113 <> footerDoc (Just $
121114 text "Hint: To open the documentation you can pipe the output of this command like"
122115 <$$> text "ob doc reflex reflex-dom-core | xargs -n1 xdg-open")
123116 , 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"
125117 ])
126118
127−internalCommand :: Parser ObInternal
128−internalCommand = hsubparser $ mconcat
129− [ command "export-ghci-configuration" $ info (ObInternal_ExportGhciConfig <$> interpretOpts <*> useRelativePathsFlag)
130− $ progDesc "Export the GHCi configuration used by ob run, etc.; useful for IDE integration"
131− ]
132− where
133− useRelativePathsFlag = switch (long "use-relative-paths" <> help "Use relative paths")
134−
135119packageNames :: Parser [String]
136120packageNames = some (strArgument (metavar "PACKAGE-NAME..."))
137121
@@ -185,6 +169,16 @@ data DeployCommand
185169 | DeployCommand_Update
186170 deriving Show
187171
172+data DeployInitOpts = DeployInitOpts
173+ { _deployInitOpts_outputDir :: FilePath
174+ , _deployInitOpts_sshKey :: FilePath
175+ , _deployInitOpts_hostname :: [String]
176+ , _deployInitOpts_route :: String
177+ , _deployInitOpts_adminEmail :: String
178+ , _deployInitOpts_enableHttps :: Bool
179+ }
180+ deriving Show
181+
188182profileCommand :: Parser (String, [String])
189183profileCommand = (,)
190184 <$> strOption
@@ -203,6 +197,15 @@ profileCommand = (,)
203197 <> showDefault
204198 ))
205199
200+
201+--TODO: Result should provide normalised path and also original user input for error reporting.
202+thunkDirectoryParser :: Parser FilePath
203+thunkDirectoryParser = fmap (dropTrailingPathSeparator . normalise) . strArgument $ mconcat
204+ [ action "directory"
205+ , metavar "THUNKDIR"
206+ , help "Path to directory containing thunk data"
207+ ]
208+
206209thunkConfig :: Parser ThunkConfig
207210thunkConfig = ThunkConfig
208211 <$>
@@ -221,36 +224,22 @@ thunkPackConfig = ThunkPackConfig
221224 <$> 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.")
222225 <*> thunkConfig
223226
224−data ThunkOption = ThunkOption
225− { _thunkOption_thunks :: NonEmpty FilePath
226− , _thunkOption_command :: ThunkCommand
227− } deriving Show
228−
229227data ThunkCommand
230− = ThunkCommand_Update ThunkUpdateConfig
231− | ThunkCommand_Unpack
232− | ThunkCommand_Pack ThunkPackConfig
228+ = ThunkCommand_Update [FilePath] ThunkUpdateConfig
229+ | ThunkCommand_Unpack [FilePath]
230+ | ThunkCommand_Pack [FilePath] ThunkPackConfig
233231 deriving Show
234232
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"
233+thunkCommand :: Parser ThunkCommand
234+thunkCommand = hsubparser $ mconcat
235+ [ command "update" $ info (ThunkCommand_Update <$> some thunkDirectoryParser <*> thunkUpdateConfig) $ progDesc "Update thunk to latest revision available"
236+ , command "unpack" $ info (ThunkCommand_Unpack <$> some thunkDirectoryParser) $ progDesc "Unpack thunk into git checkout of revision it points to"
237+ , command "pack" $ info (ThunkCommand_Pack <$> some thunkDirectoryParser <*> thunkPackConfig) $ progDesc "Pack git checkout into thunk that points at the current branch's upstream"
240238 ]
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
249239
250240data ShellOpts
251241 = ShellOpts
252242 { _shellOpts_shell :: String
253− , _shellOpts_interpretPaths :: [(FilePath, Interpret)]
254243 , _shellOpts_command :: Maybe String
255244 }
256245 deriving Show
@@ -261,34 +250,10 @@ shellFlags =
261250 <|> flag "ghc" "ghcjs" (long "ghcjs" <> help "Enter a shell having ghcjs rather than ghc")
262251 <|> strOption (short 'A' <> long "argument" <> metavar "NIXARG" <> help "Use the environment specified by the given nix argument of `shells'")
263252
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"
283−
284253shellOpts :: Parser ShellOpts
285254shellOpts = ShellOpts
286255 <$> 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")))
256+ <*> optional (strArgument (metavar "COMMAND"))
292257
293258portOpt :: Int -> Parser Int
294259portOpt dfault = option auto (long "port" <> short 'p' <> help "Port number for server" <> showDefault <> value dfault <> metavar "INT")
@@ -366,8 +331,7 @@ main' argsCfg = do
366331 Just impl -> do
367332 -- Invoke the real implementation, using --no-handoff to prevent infinite recursion
368333 putLog Debug $ "Handing off to " <> T.pack impl
369− _ <- liftIO $ rawSystem impl ("--no-handoff" : myArgs)
370− return ()
334+ liftIO $ executeFile impl False ("--no-handoff" : myArgs) Nothing
371335 case myArgs of
372336 "--no-handoff" : as -> go as -- If we've been told not to hand off, don't hand off
373337 origPath:inPath:outPath:preprocessorName:packagePaths
@@ -383,7 +347,29 @@ ob :: MonadObelisk m => ObCommand -> m ()
383347ob = \case
384348 ObCommand_Init source force -> initProject source force
385349 ObCommand_Deploy dc -> case dc of
386− DeployCommand_Init deployOpts -> withProjectRoot "." $ \root -> deployInit deployOpts root
350+ DeployCommand_Init deployOpts -> withProjectRoot "." $ \root -> do
351+ let deployDir = _deployInitOpts_outputDir deployOpts
352+ r <- liftIO $ canonicalizePath root
353+ rootEqualsTarget <- liftIO $ equalFilePath r <$> canonicalizePath deployDir
354+ when rootEqualsTarget $
355+ failWith $ "Deploy directory " <> T.pack deployDir <> " should not be the same as project root."
356+ thunkPtr <- readThunk root >>= \case
357+ Left err -> failWith $ case err of
358+ ReadThunkError_AmbiguousFiles ->
359+ "Project root " <> T.pack r <> " is not a git repository or valid thunk"
360+ ReadThunkError_UnrecognizedFiles ->
361+ "Project root " <> T.pack r <> " is not a git repository or valid thunk"
362+ _ -> "thunk read: " <> T.pack (show err)
363+ Right (ThunkData_Packed ptr) -> return ptr
364+ Right (ThunkData_Checkout (Just ptr)) -> return ptr
365+ Right (ThunkData_Checkout Nothing) ->
366+ getThunkPtr False root Nothing
367+ let sshKeyPath = _deployInitOpts_sshKey deployOpts
368+ hostname = _deployInitOpts_hostname deployOpts
369+ route = _deployInitOpts_route deployOpts
370+ adminEmail = _deployInitOpts_adminEmail deployOpts
371+ enableHttps = _deployInitOpts_enableHttps deployOpts
372+ deployInit thunkPtr deployDir sshKeyPath hostname route adminEmail enableHttps
387373 DeployCommand_Push remoteBuilder -> do
388374 deployPath <- liftIO $ canonicalizePath "."
389375 deployPush deployPath $ case remoteBuilder of
@@ -391,36 +377,23 @@ ob = \case
391377 Just RemoteBuilder_ObeliskVM -> (:[]) <$> VmBuilder.getNixBuildersArg
392378 DeployCommand_Update -> deployUpdate "."
393379 DeployCommand_Test (platform, extraArgs) -> deployMobile platform extraArgs
394− ObCommand_Run interpretPathsList -> withInterpretPaths interpretPathsList run
380+ ObCommand_Run -> run
395381 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
382+ ObCommand_Thunk tc -> case tc of
383+ ThunkCommand_Update thunks config -> for_ thunks (updateThunkToLatest config)
384+ ThunkCommand_Unpack thunks -> for_ thunks unpackThunk
385+ ThunkCommand_Pack thunks config -> for_ thunks (packThunk config)
386+ ObCommand_Repl -> runRepl
387+ ObCommand_Watch -> runWatch
388+ ObCommand_Shell so -> withProjectRoot "." $ \root ->
389+ projectShell root False (_shellOpts_shell so) (_shellOpts_command so)
390+ ObCommand_Doc shell' pkgs -> withProjectRoot "." $ \root ->
391+ projectShell root False shell' (Just $ haddockCommand pkgs)
408392 ObCommand_Hoogle shell' port -> withProjectRoot "." $ \root -> do
409− nixShellWithHoogle root True shell' $ Just $ "hoogle server -p" <> show port <> " --local"
393+ nixShellWithHoogle root True shell' $ Just $ "hoogle server -p " <> show port <> " --local"
410394 ObCommand_Internal icmd -> case icmd of
411395 ObInternal_ApplyPackages origPath inPath outPath packagePaths -> do
412396 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
424397
425398haddockCommand :: [String] -> String
426399haddockCommand pkgs = unwords
@@ -434,22 +407,3 @@ haddockCommand pkgs = unwords
434407
435408getArgsConfig :: IO ArgsConfig
436409getArgsConfig = pure $ ArgsConfig { _argsConfig_enableVmBuilderByDefault = System.Info.os == "darwin" }
437−
438−-- | Resolves an ordered list of paths for use with @--interpret@/@--no-interpret@ by coalescing
439−-- paths into a non-ambiguous set of paths. Ambiguity is resolved by choosing right-most paths
440−-- over any preceeding identical paths.
441−--
442−-- For example: @a/b=ON a/b/c=OFF@ and @a/b/c=OFF a/b=ON@ are the same.
443−-- @a/b=ON a/b=OFF@ is reduced to @a/b=OFF@. We prefer right-biased choice to increase
444−-- scriptability.
445−--
446−-- N.B. All the paths in the result will be canonicalized. It's impossible to determine path
447−-- overlap otherwise.
448−resolveInterpretPaths :: MonadIO m => [(FilePath, a)] -> m (Maybe (PathTree a))
449−resolveInterpretPaths ps = do
450− trees <- liftIO $ for ps $ \(p, a) -> pathToTree a <$> canonicalizePath p
451− pure $ foldr1 mergeTrees <$> nonEmpty trees
452− where
453− -- | Merge two 'PathTree's preferring leaves on the right in as much as they overlap with paths on the left.
454− mergeTrees :: PathTree a -> PathTree a -> PathTree a
455− mergeTrees (PathTree_Node ax x) (PathTree_Node ay y) = PathTree_Node (ay <|> ax) $ Map.unionWith mergeTrees x y
lib/command/src/Obelisk/Command/Deploy.hs+32−49
@@ -1,31 +1,28 @@
1−{-# LANGUAGE DeriveGeneric #-}
21{-# LANGUAGE FlexibleContexts #-}
32{-# LANGUAGE LambdaCase #-}
43{-# LANGUAGE OverloadedStrings #-}
5−{-# LANGUAGE QuasiQuotes #-}
64{-# LANGUAGE ScopedTypeVariables #-}
75{-# LANGUAGE ViewPatterns #-}
6+{-# LANGUAGE DeriveGeneric #-}
87module Obelisk.Command.Deploy where
98
10−import Control.Applicative (liftA2)
119import Control.Lens
1210import Control.Monad
1311import Control.Monad.Catch (Exception (displayException), MonadThrow, bracket, throwM, try)
14−import Control.Monad.IO.Class (MonadIO, liftIO)
12+import Control.Monad.IO.Class (liftIO)
1513import Data.Aeson (FromJSON, ToJSON, encode, eitherDecode)
1614import Data.Bits
1715import qualified Data.ByteString.Lazy as BSL
1816import Data.Default
1917import qualified Data.Map as Map
2018import qualified Data.Set as Set
21−import Data.String.Here.Interpolated (i)
2219import qualified Data.Text as T
2320import qualified Data.Text.IO as T
2421import GHC.Generics
2522import System.Directory
2623import System.FilePath
2724import System.IO
28−import System.PosixCompat.Files
25+import System.Posix.Files
2926import Text.URI (URI)
3027import qualified Text.URI as URI
3128import Text.URI.Lens
@@ -39,32 +36,18 @@ import Obelisk.Command.Project
3936import Obelisk.Command.Thunk
4037import Obelisk.Command.Utils
4138
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
6139
62−deployInit'
40+deployInit
6341 :: MonadObelisk m
6442 => ThunkPtr
65− -> DeployInitOpts
43+ -> FilePath
44+ -> FilePath
45+ -> [String] -- ^ hostnames
46+ -> String -- ^ route
47+ -> String -- ^ admin email
48+ -> Bool -- ^ enable https
6649 -> m ()
67−deployInit' thunkPtr (DeployInitOpts deployDir sshKeyPath hostnames route adminEmail enableHttps) = do
50+deployInit thunkPtr deployDir sshKeyPath hostnames route adminEmail enableHttps = do
6851 liftIO $ createDirectoryIfMissing True deployDir
6952 localKey <- withSpinner ("Preparing " <> T.pack deployDir) $ do
7053 localKey <- liftIO (doesFileExist sshKeyPath) >>= \case
@@ -85,16 +68,17 @@ deployInit' thunkPtr (DeployInitOpts deployDir sshKeyPath hostnames route adminE
8568 --accidentally create a production deployment that uses development
8669 --credentials to connect to some resources. This could result in, e.g.,
8770 --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− ]
71+ withSpinner "Creating project configuration directories" $ do
72+ callProcessAndLogOutput (Notice, Error) $
73+ proc "mkdir" [ "-p"
74+ , deployDir </> "config" </> "backend"
75+ , deployDir </> "config" </> "common"
76+ , deployDir </> "config" </> "frontend"
77+ ]
9478
9579 let srcDir = deployDir </> "src"
96− withSpinner ("Creating source thunk (" <> T.pack (makeRelative deployDir srcDir) <> ")") $ do
97− createThunk srcDir $ Right thunkPtr
80+ withSpinner ("Creating source thunk (" <> T.pack (makeRelative deployDir srcDir) <> ")") $ liftIO $ do
81+ createThunk srcDir thunkPtr
9882 setupObeliskImpl deployDir
9983
10084 withSpinner "Writing deployment configuration" $ do
@@ -108,8 +92,8 @@ deployInit' thunkPtr (DeployInitOpts deployDir sshKeyPath hostnames route adminE
10892 withSpinner ("Initializing git repository (" <> T.pack deployDir <> ")") $
10993 initGit deployDir
11094
111−setupObeliskImpl :: MonadIO m => FilePath -> m ()
112−setupObeliskImpl deployDir = liftIO $ do
95+setupObeliskImpl :: FilePath -> IO ()
96+setupObeliskImpl deployDir = do
11397 let
11498 implDir = toImplDir deployDir
11599 goBackUp = foldr (</>) "" $ (".." <$) $ splitPath $ makeRelative deployDir implDir
@@ -125,8 +109,8 @@ deployPush deployPath getNixBuilders = do
125109 routeHost <- getHostFromRoute enableHttps route
126110 let srcPath = deployPath </> "src"
127111 thunkPtr <- readThunk srcPath >>= \case
128− Right (ThunkData_Packed _ ptr) -> return ptr
129− Right ThunkData_Checkout -> do
112+ Right (ThunkData_Packed ptr) -> return ptr
113+ Right (ThunkData_Checkout _) -> do
130114 checkGitCleanStatus srcPath True >>= \case
131115 True -> packThunk (ThunkPackConfig False (ThunkConfig Nothing)) srcPath
132116 False -> failWith $ T.pack $ "ob deploy push: ensure " <> srcPath <> " has no pending changes and latest is pushed upstream."
@@ -161,8 +145,8 @@ deployPush deployPath getNixBuilders = do
161145 "nix-copy-closure" ["-v", "--to", "--use-substitutes", "root@" <> host, "--gzip", outputPath]
162146 withSpinner "Uploading config" $ ifor_ buildOutputByHost $ \host _ -> do
163147 callProcessAndLogOutput (Notice, Warning) $
164− proc rsyncPath
165− [ "-e " <> sshPath <> " " <> unwords sshOpts
148+ proc "rsync"
149+ [ "-e ssh " <> unwords sshOpts
166150 , "-qarvz"
167151 , deployPath </> "config"
168152 , "root@" <> host <> ":/var/lib/backend"
@@ -170,10 +154,9 @@ deployPush deployPath getNixBuilders = do
170154 --TODO: Create GC root so we're sure our closure won't go away during this time period
171155 withSpinner "Switching to new configuration" $ ifor_ buildOutputByHost $ \host outputPath -> do
172156 callProcessAndLogOutput (Notice, Warning) $
173− proc sshPath $ sshOpts <>
157+ proc "ssh" $ sshOpts <>
174158 [ "root@" <> host
175159 , unwords
176− -- Note that we don't want to $(staticWhich "nix-env") here, because this is executing on a remote machine
177160 [ "nix-env -p /nix/var/nix/profiles/system --set " <> outputPath
178161 , "&&"
179162 , "/nix/var/nix/profiles/system/bin/switch-to-configuration switch"
@@ -182,10 +165,10 @@ deployPush deployPath getNixBuilders = do
182165 isClean <- checkGitCleanStatus deployPath True
183166 when (not isClean) $ do
184167 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"]
168+ callProcessAndLogOutput (Debug, Error) $ proc "git"
169+ ["-C", deployPath, "add", "."]
170+ callProcessAndLogOutput (Debug, Error) $ proc "git"
171+ ["-C", deployPath, "commit", "-m", "New deployment"]
189172 putLog Notice $ "Deployed => " <> T.pack route
190173 where
191174 callProcess' envMap cmd args = do
@@ -315,7 +298,7 @@ readDeployConfig deployDir fname = liftIO $ do
315298
316299verifyHostKey :: MonadObelisk m => FilePath -> FilePath -> String -> m ()
317300verifyHostKey knownHostsPath keyPath hostName =
318− callProcessAndLogOutput (Notice, Warning) $ proc sshPath $
301+ callProcessAndLogOutput (Notice, Warning) $ proc "ssh" $
319302 sshArgs knownHostsPath keyPath True <>
320303 [ "root@" <> hostName
321304 , "-o", "NumberOfPasswordPrompts=0"
lib/command/src/Obelisk/Command/Nix.hs+4−4
@@ -207,7 +207,7 @@ nixCmdProc' cmdCfg = (proc (T.unpack cmd) options, cmd)
207207 )
208208
209209nixCmd :: MonadObelisk m => NixCmd -> m FilePath
210−nixCmd cmdCfg = withSpinner' (T.unwords $ "Running" : cmd : desc) (Just $ const $ T.unwords $ "Built" : desc) $ do
210+nixCmd cmdCfg = withSpinner' ("Running " <> cmd <> desc) (Just $ const $ "Built " <> desc) $ do
211211 output <- readProcessAndLogStderr Debug cmdProc
212212 -- Remove final newline that Nix appends
213213 Just (outPath, '\n') <- pure $ T.unsnoc output
@@ -218,7 +218,7 @@ nixCmd cmdCfg = withSpinner' (T.unwords $ "Running" : cmd : desc) (Just $ const
218218 NixCmd_Build cfg' -> cfg' ^. nixCommonConfig
219219 NixCmd_Instantiate cfg' -> cfg' ^. nixCommonConfig
220220 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)
221+ desc = T.pack $ mconcat $ catMaybes
222+ [ ("on " <>) <$> path
223+ , (\a -> " [" <> a <> "]") <$> (commonCfg ^. nixCmdConfig_target . target_attr)
224224 ]
lib/command/src/Obelisk/Command/Preprocessor.hs+58−62
@@ -5,96 +5,92 @@ module Obelisk.Command.Preprocessor where
55
66import qualified Data.ByteString.Lazy as BL
77import qualified Data.ByteString.Lazy.Builder as BU
8−import Data.Foldable (for_)
98import Data.List (intersperse, isPrefixOf, sortOn)
109import Data.Maybe (fromMaybe)
1110import qualified Data.Text.Lazy.Builder as TL
1211import qualified Data.Text.Lazy.Encoding as TL
1312import Distribution.Compiler (CompilerFlavor (..))
1413import 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)
14+import System.IO (IOMode (..), hClose, hPutStrLn, openFile, stderr)
15+import System.FilePath (hasTrailingPathSeparator, joinPath, normalise, splitPath)
1816
1917import Obelisk.Command.Run (CabalPackageInfo (..), parseCabalPackage')
2018
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.
2919applyPackages :: FilePath -> FilePath -> FilePath -> [FilePath] -> IO ()
30−applyPackages origPath inPath outPath packagePaths' = do
31− origPathCanonical <- canonicalizePath origPath
32− packagePaths <- traverse canonicalizePath packagePaths'
20+applyPackages origPath inPath outPath packagePaths = do
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.
3328
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 ]
29+ outFile <- openFile outPath WriteMode
30+ let hPutTextBuilder h = BU.hPutBuilder h . TL.encodeUtf8Builder . TL.toLazyText
3931
40− -- The first element of matches is going to be the deepest path to a package spec that contains
32+ -- putStr "--------------------------------------------------------------------------------\n"
33+ -- print args
34+ -- putStr "--------------------------------------------------------------------------------\n"
35+
36+ -- Thus we must select among the packagePaths for the file we are going to parse.
37+
38+ let takeDirs = takeWhile hasTrailingPathSeparator
39+ packageDirs = sortOn (negate . length . takeDirs) $ map (splitPath . normalise) packagePaths
40+ origDir = splitPath $ normalise origPath
41+ matches = [ joinPath d | d <- packageDirs, takeDirs d `isPrefixOf` origDir ]
42+
43+ -- So the first element of matches is going to be the deepest path to a package spec that contains
4144 -- 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
45+
46+ case matches of
47+ [] -> hPutTextBuilder outFile (lineNumberPragma origPath) -- TODO: probably should produce a warning
48+ (packagePath:_) -> do
49+ parseCabalPackage' packagePath >>= \case
50+ Left err ->
51+ hPutStrLn stderr $ "Error: Unable to parse cabal package " <> packagePath <> "; Skipping preprocessor on " <> origPath <> ". Error was " <> show err
52+ Right (_warnings, packageInfo) ->
53+ hPutTextBuilder outFile (generateHeader origPath packageInfo)
54+
55+ BL.readFile inPath >>= BL.hPut outFile
56+ hClose outFile
57+
58+
59+ -- I'm pretty sure there's a certain amount of oversimplification in CabalPackageInfo, so I doubt this is fully robust.
6160
6261generateHeader :: FilePath -> CabalPackageInfo -> TL.Builder
6362generateHeader origPath packageInfo =
6463 hsExtensions <> ghcOptions <> lineNumberPragma origPath
6564 where
6665 hsExtensions =
67− if null extList
68− then mempty
69− else pragma $ TL.fromText "LANGUAGE " <> mconcat (intersperse (TL.fromText ", ") extList)
66+ if not (null extList)
67+ then TL.fromText "{-# LANGUAGE "
68+ <> mconcat (intersperse (TL.fromText ", ") extList)
69+ <> TL.fromText " #-}\n"
70+ else mempty
7071 extList = addDefaultLanguage $ concatMap showExt $ _cabalPackageInfo_defaultExtensions packageInfo
7172 addDefaultLanguage =
7273 case _cabalPackageInfo_defaultLanguage packageInfo of
7374 Nothing -> id
7475 Just x -> case x of
75− UnknownLanguage ext -> (TL.fromString ext :)
76− ext -> (TL.fromString (show ext) :)
76+ UnknownLanguage ext -> ( TL.fromString ext :)
77+ ext -> ( TL.fromString (show ext) :)
7778 showExt = \case
7879 EnableExtension ext -> [TL.fromString (show ext)]
79− DisableExtension ext -> ["No" <> TL.fromString (show ext)]
80+ DisableExtension _ -> []
8081 UnknownExtension ext -> [TL.fromString ext]
8182
8283 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
84+ if not (null optList)
85+ then TL.fromText "{-# OPTIONS_GHC "
86+ <> mconcat (intersperse (TL.fromText " ") optList)
87+ <> TL.fromText " #-}\n"
88+ else mempty
89+ optList = map TL.fromString
90+ $ filter (\x -> not (isPrefixOf "-O" x))
91+ $ fromMaybe []
92+ $ lookup GHC (_cabalPackageInfo_compilerOptions packageInfo)
9293
9394lineNumberPragma :: 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
95+lineNumberPragma origPath =
96+ TL.fromText "{-# LINE 1 \"" <> TL.fromString origPath <> TL.fromText "\" #-}\n"
lib/command/src/Obelisk/Command/Project.hs+41−67
@@ -10,12 +10,13 @@ module Obelisk.Command.Project
1010 , nixShellRunConfig
1111 , nixShellRunProc
1212 , nixShellWithHoogle
13− , nixShellWithoutPkgs
13+ , nixShellWithPkgs
1414 , obeliskDirName
15+ , projectShell
1516 , toImplDir
17+ , toNixPath
1618 , toObeliskDir
1719 , withProjectRoot
18− , bashEscape
1920 ) where
2021
2122import Control.Concurrent.MVar (MVar, newMVar, withMVarMasked)
@@ -24,25 +25,23 @@ import Control.Monad
2425import Control.Monad.IO.Class (liftIO)
2526import Control.Monad.State
2627import qualified Data.Aeson as Json
27−import qualified Data.ByteString.UTF8 as BSU
2828import Data.Bits
2929import qualified Data.ByteString.Lazy as BSL
3030import Data.Default (def)
3131import Data.Function ((&), on)
32+import Data.List (isInfixOf)
3233import Data.Map (Map)
3334import Data.Text (Text)
3435import qualified Data.Text as T
35−import Data.Text.Encoding (decodeUtf8, encodeUtf8)
36+import Data.Text.Encoding (decodeUtf8)
3637import Data.Traversable (for)
3738import System.Directory
3839import System.Environment (lookupEnv)
3940import System.FilePath
4041import System.IO.Temp
4142import 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)
43+import System.Posix (FileStatus, FileMode, CMode (..), UserID, deviceID, fileID, fileMode, fileOwner, getFileStatus, getRealUserID)
44+import System.Posix.Files
4645
4746import GitHub.Data.GitData (Branch)
4847import GitHub.Data.Name (Name)
@@ -51,7 +50,7 @@ import Obelisk.App (MonadObelisk)
5150import Obelisk.CliApp
5251import Obelisk.Command.Nix
5352import Obelisk.Command.Thunk
54−import Obelisk.Command.Utils (nixBuildExePath, nixExePath, toNixPath, cp, nixShellPath)
53+import Obelisk.Command.Utils (nixExePath, nixBuildExePath)
5554
5655--TODO: Make this module resilient to random exceptions
5756
@@ -97,26 +96,20 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
9796 | otherwise -> failWith "ob init requires an empty directory. Use the flag --force to init anyway, potentially overwriting files."
9897 skeleton <- withSpinner "Setting up obelisk" $ do
9998 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]
10799 case source of
108− InitSource_Default -> cloneAndRepack obeliskSource
109− InitSource_Branch branch -> cloneAndRepack $ obeliskSourceWithBranch branch
100+ InitSource_Default -> createThunkWithLatest implDir obeliskSource
101+ InitSource_Branch branch -> createThunkWithLatest implDir $ obeliskSourceWithBranch branch
110102 InitSource_Symlink path -> do
111103 let symlinkPath = if isAbsolute path
112104 then path
113105 else ".." </> path
114106 liftIO $ createSymbolicLink symlinkPath implDir
115107 _ <- nixBuildAttrWithCache implDir "command"
108+ --TODO: We should probably handoff to the impl here
116109 skel <- nixBuildAttrWithCache implDir "skeleton" --TODO: I don't think there's actually any reason to cache this
117110
118111 callProcessAndLogOutput (Notice, Error) $
119− proc cp
112+ proc "cp"
120113 [ "-r"
121114 , "--preserve=links"
122115 , obDir
@@ -126,7 +119,7 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
126119
127120 withSpinner "Copying project skeleton" $ do
128121 callProcessAndLogOutput (Notice, Error) $
129− proc cp
122+ proc "cp"
130123 [ "-r"
131124 , "--no-preserve=mode"
132125 , "-T"
@@ -137,30 +130,6 @@ initProject source force = withSystemTempDirectory "ob-init" $ \tmpDir -> do
137130 let configDir = "config"
138131 createDirectoryIfMissing False configDir
139132 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))
164133
165134--TODO: Allow the user to ignore our security concerns
166135-- | Find the Obelisk implementation for the project at the given path
@@ -280,6 +249,13 @@ filePermissionIsSafe s umask = not fileWorldWritable && fileGroupWritable <= uma
280249 fileGroupWritable = fileMode s .&. 0o020 == 0o020
281250 umaskGroupWritable = umask .&. 0o020 == 0
282251
252+-- | Nix syntax requires relative paths to be prefixed by @./@ or
253+-- @../@. This will make a 'FilePath' that can be embedded in a Nix
254+-- expression.
255+toNixPath :: FilePath -> FilePath
256+toNixPath root | "/" `isInfixOf` root = root
257+ | otherwise = "./" <> root
258+
283259nixShellRunConfig :: MonadObelisk m => FilePath -> Bool -> Maybe String -> m NixShellConfig
284260nixShellRunConfig root isPure command = do
285261 nixpkgsPath <- fmap T.strip $ readProcessAndLogStderr Debug $ setCwd (Just root) $
@@ -288,51 +264,49 @@ nixShellRunConfig root isPure command = do
288264 pure $ def
289265 & nixShellConfig_pure .~ isPure
290266 & 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]
267+ & nixShellConfig_run .~ (command <&> \c -> mconcat
268+ [ "export NIX_PATH=nixpkgs=", T.unpack nixpkgsPath, "; "
269+ , maybe "" (\v -> "export NIX_REMOTE=" <> v <> "; ") nixRemote
270+ , c
295271 ])
296272
297−bashEscape :: String -> String
298−bashEscape = BSU.toString . bytes . bash . BSU.fromString
299−
300273nixShellRunProc :: NixShellConfig -> ProcessSpec
301−nixShellRunProc cfg = setDelegateCtlc True $ proc nixShellPath $ runNixShellConfig cfg
274+nixShellRunProc cfg = setDelegateCtlc True $ proc "nix-shell" $ runNixShellConfig cfg
302275
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
276+nixShellWithPkgs :: MonadObelisk m => FilePath -> Bool -> Bool -> Map Text FilePath -> Maybe String -> m ()
277+nixShellWithPkgs root isPure chdirToRoot packageNamesAndPaths command = do
313278 packageNamesAndAbsPaths <- liftIO $ for packageNamesAndPaths makeAbsolute
314279 defShellConfig <- nixShellRunConfig root isPure command
315280 let setCwd_ = if chdirToRoot then setCwd (Just root) else id
316− runProcess_ $ setCwd_ $ nixShellRunProc $ defShellConfig
281+ (_, _, _, ph) <- createProcess_ "nixShellWithPkgs" $ setCwd_ $ nixShellRunProc $ defShellConfig
317282 & nixShellConfig_common . nixCmdConfig_target . target_expr ?~
318− "{root, pkgs, shell}: ((import root {}).passthru.__unstable__.self.extend (_: _: {\
283+ "{root, pkgs}: ((import root {}).passthru.__unstable__.self.extend (_: _: {\
319284 \shellPackages = builtins.fromJSON pkgs;\
320− \})).project.shells.${shell}"
285+ \})).project.shells.ghc"
321286 & nixShellConfig_common . nixCmdConfig_args .~
322287 [ rawArg "root" $ toNixPath $ if chdirToRoot then "." else root
323288 , strArg "pkgs" (T.unpack $ decodeUtf8 $ BSL.toStrict $ Json.encode packageNamesAndAbsPaths)
324− , strArg "shell" shellAttr
325289 ]
290+ void $ waitForProcess ph
326291
327292nixShellWithHoogle :: MonadObelisk m => FilePath -> Bool -> String -> Maybe String -> m ()
328293nixShellWithHoogle root isPure shell' command = do
329294 defShellConfig <- nixShellRunConfig root isPure command
330− runProcess_ $ setCwd (Just root) $ nixShellRunProc $ defShellConfig
295+ (_, _, _, ph) <- createProcess_ "nixShellWithHoogle" $ setCwd (Just root) $ nixShellRunProc $ defShellConfig
331296 & nixShellConfig_common . nixCmdConfig_target . target_expr ?~
332297 "{shell}: ((import ./. {}).passthru.__unstable__.self.extend (_: super: {\
333298 \userSettings = super.userSettings // { withHoogle = true; };\
334299 \})).project.shells.${shell}"
335300 & nixShellConfig_common . nixCmdConfig_args .~ [ strArg "shell" shell' ]
301+ void $ waitForProcess ph
302+
303+projectShell :: MonadObelisk m => FilePath -> Bool -> String -> Maybe String -> m ()
304+projectShell root isPure shellName command = do
305+ defShellConfig <- nixShellRunConfig root isPure command
306+ (_, _, _, ph) <- createProcess_ "runNixShellAttr" $ setCwd (Just root) $ nixShellRunProc $ defShellConfig
307+ & nixShellConfig_common . nixCmdConfig_target . target_path ?~ "default.nix"
308+ & nixShellConfig_common . nixCmdConfig_target . target_attr ?~ ("shells." <> shellName)
309+ void $ waitForProcess ph
336310
337311findProjectAssets :: MonadObelisk m => FilePath -> m Text
338312findProjectAssets root = do
lib/command/src/Obelisk/Command/Run.hs+115−278
@@ -1,41 +1,28 @@
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 #-}
106{-# LANGUAGE TupleSections #-}
11−{-# LANGUAGE ViewPatterns #-}
7+{-# LANGUAGE QuasiQuotes #-}
128module Obelisk.Command.Run where
139
1410import Control.Arrow ((&&&))
1511import Control.Exception (Exception, bracket)
1612import Control.Lens (ifor, (.~), (&))
17−import Control.Monad (filterM)
13+import Control.Monad (filterM, unless, void)
1814import Control.Monad.Except (runExceptT, throwError)
1915import Control.Monad.IO.Class (liftIO)
2016import Control.Monad.Reader (MonadIO)
21−import Data.Bifoldable (bifoldr1)
22−import Data.Bifunctor (bimap)
2317import Data.Coerce (coerce)
2418import 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)
19+import Data.Either
20+import Data.Foldable (for_, toList)
3021import qualified Data.List.NonEmpty as NE
3122import Data.Map (Map)
3223import 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)
24+import Data.Maybe
3725import qualified Data.Set as Set
38−import Data.String.Here.Interpolated (i)
3926import Data.Text (Text)
4027import qualified Data.Text as T
4128import Data.Time.Clock (getCurrentTime)
@@ -46,17 +33,17 @@ import Distribution.Compiler (CompilerFlavor(..))
4633import Distribution.PackageDescription.Parsec (parseGenericPackageDescription)
4734import Distribution.Parsec.ParseResult (runParseResult)
4835import 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)
36+import Distribution.Types.BuildInfo
37+import Distribution.Types.CondTree
38+import Distribution.Types.GenericPackageDescription
39+import Distribution.Types.Library
40+import Distribution.Utils.Generic
5441import qualified Distribution.Parsec.Common as Dist
5542import qualified Hpack.Config as Hpack
5643import qualified Hpack.Render as Hpack
5744import qualified Hpack.Yaml as Hpack
58−import Language.Haskell.Extension (Extension, Language)
59−import qualified Network.Socket as Socket
45+import Language.Haskell.Extension
46+import Network.Socket hiding (Debug)
6047import System.Directory
6148import System.Environment (getExecutablePath)
6249import System.FilePath
@@ -66,18 +53,19 @@ import System.IO.Temp (withSystemTempDirectory)
6653import Obelisk.App (MonadObelisk)
6754import Obelisk.CliApp (
6855 Severity (..),
56+ createProcess_,
6957 failWith,
7058 proc,
7159 putLog,
7260 readCreateProcessWithExitCode,
7361 readProcessAndLogStderr,
74− runProcess_,
7562 setCwd,
7663 setDelegateCtlc,
64+ waitForProcess,
7765 withSpinner,
7866 )
7967import Obelisk.Command.Nix
80−import Obelisk.Command.Project (nixShellWithoutPkgs, withProjectRoot, findProjectAssets, bashEscape)
68+import Obelisk.Command.Project (nixShellWithPkgs, toImplDir, withProjectRoot, findProjectAssets)
8169import Obelisk.Command.Thunk (attrCacheFileName)
8270import Obelisk.Command.Utils (findExePath, ghcidExePath)
8371
@@ -94,35 +82,8 @@ data CabalPackageInfo = CabalPackageInfo
9482 -- ^ List of globally set languages of the library component
9583 , _cabalPackageInfo_compilerOptions :: [(CompilerFlavor, [String])]
9684 -- ^ 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)
9985 }
10086
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−
12687-- | Used to signal to obelisk that it's being invoked as a preprocessor
12788preprocessorIdentifier :: String
12889preprocessorIdentifier = "__preprocessor-apply-packages"
@@ -151,7 +112,7 @@ profile profileBasePattern rtsFlags = withProjectRoot "." $ \root -> do
151112 liftIO $ createDirectoryIfMissing True $ takeDirectory $ root </> profileBaseName
152113 putLog Debug $ "Storing profiled data under base name of " <> T.pack (root </> profileBaseName)
153114 freePort <- getFreePort
154− runProcess_ $ setCwd (Just root) $ setDelegateCtlc True $ proc (outPath </> "bin" </> "ob-run") $
115+ (_, _, _, ph) <- createProcess_ "runProfExe" $ setCwd (Just root) $ setDelegateCtlc True $ proc (outPath </> "bin" </> "ob-run") $
155116 [ show freePort
156117 , T.unpack assets
157118 , profileBaseName
@@ -159,16 +120,18 @@ profile profileBasePattern rtsFlags = withProjectRoot "." $ \root -> do
159120 , "-po" <> profileBaseName
160121 ] <> rtsFlags
161122 <> [ "-RTS" ]
123+ void $ waitForProcess ph
162124
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
125+run
126+ :: MonadObelisk m
127+ => m ()
128+run = withProjectRoot "." $ \root -> do
129+ pkgs <- fmap toList . parsePackagesOrFail =<< getLocalPkgs root
130+ withGhciScript pkgs root $ \dotGhciPath -> do
131+ freePort <- getFreePort
132+ assets <- findProjectAssets root
133+ putLog Debug $ "Assets impurely loaded from: " <> assets
134+ runGhcid root True dotGhciPath pkgs $ Just $ unwords
172135 [ "Obelisk.Run.run"
173136 , show freePort
174137 , "(Obelisk.Run.runServeAsset " ++ show assets ++ ")"
@@ -176,87 +139,39 @@ run root interpretPaths = do
176139 , "Frontend.frontend"
177140 ]
178141
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
142+runRepl :: MonadObelisk m => m ()
143+runRepl = withProjectRoot "." $ \root -> do
144+ pkgs <- fmap toList . parsePackagesOrFail =<< getLocalPkgs root
145+ withGhciScript pkgs "." $ \dotGhciPath ->
146+ runGhciRepl root pkgs dotGhciPath
197147
198−nixShellForInterpretPaths :: MonadObelisk m => Bool -> String -> FilePath -> PathTree Interpret -> Maybe String -> m ()
199−nixShellForInterpretPaths isPure shell root interpretPaths cmd = do
200− pkgs <- getParsedLocalPkgs root interpretPaths
201− nixShellWithoutPkgs root isPure False (packageInfoToNamePathMap pkgs) shell cmd
202−
203−-- | Like 'getLocalPkgs' but also parses them and fails if any of them can't be parsed.
204−getParsedLocalPkgs :: MonadObelisk m => FilePath -> PathTree Interpret -> m (NonEmpty CabalPackageInfo)
205−getParsedLocalPkgs root interpretPaths = parsePackagesOrFail =<< getLocalPkgs root interpretPaths
148+runWatch :: MonadObelisk m => m ()
149+runWatch = withProjectRoot "." $ \root -> do
150+ pkgs <- fmap toList . parsePackagesOrFail =<< getLocalPkgs root
151+ withGhciScript pkgs root $ \dotGhciPath ->
152+ runGhcid root True dotGhciPath pkgs Nothing
206153
207154-- | Relative paths to local packages of an obelisk project.
208155--
209156-- These are a combination of the obelisk predefined local packages,
210157-- and any packages that the user has set with the @packages@ argument
211158-- 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"]
159+getLocalPkgs :: MonadObelisk m => FilePath -> m [FilePath]
160+getLocalPkgs root = do
161+ obeliskPaths <- runFind ["-L", root, "-name", ".obelisk", "-type", "d"]
216162
217163 -- We do not want to find packages that are embedded inside other obelisk projects, unless that
218164 -- 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]
165+ let exclusions = filter (/= root) $ map takeDirectory obeliskPaths
166+ fmap (map (makeRelative ".")) $ runFind $
167+ ["-L", root, "(", "-name", "*.cabal", "-o", "-name", Hpack.packageConfig, ")", "-a", "-type", "f"]
168+ <> concat [["-not", "-path", p </> "*"] | p <- (toImplDir "*" </> attrCacheFileName) : exclusions]
229169 where
230170 runFind args = do
231171 (_exitCode, out, err) <- readCreateProcessWithExitCode $ proc findExePath args
232172 putLog Debug $ T.strip $ T.pack err
233173 pure $ map T.unpack $ T.lines $ T.strip $ T.pack out
234174
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−
260175data GuessPackageFileError = GuessPackageFileError_Ambiguous [FilePath] | GuessPackageFileError_NotFound
261176 deriving (Eq, Ord, Show)
262177instance Exception GuessPackageFileError
@@ -304,16 +219,15 @@ parseCabalPackage
304219 -> m (Maybe CabalPackageInfo)
305220parseCabalPackage dir = parseCabalPackage' dir >>= \case
306221 Left err -> Nothing <$ putLog Error err
307− Right (Just (warnings, pkgInfo)) -> do
222+ Right (warnings, pkgInfo) -> do
308223 for_ warnings $ putLog Warning . T.pack . show
309224 pure $ Just pkgInfo
310− Right Nothing -> pure Nothing
311225
312226-- | Like 'parseCabalPackage' but returns errors and warnings directly so as to avoid 'MonadObelisk'.
313227parseCabalPackage'
314228 :: (MonadIO m)
315229 => FilePath -- ^ Package directory
316− -> m (Either T.Text (Maybe ([Dist.PWarning], CabalPackageInfo)))
230+ -> m (Either T.Text ([Dist.PWarning], CabalPackageInfo))
317231parseCabalPackage' pkg = runExceptT $ do
318232 (cabalContents, packageFile, packageName) <- guessCabalPackageFile pkg >>= \case
319233 Left GuessPackageFileError_NotFound -> throwError $ "No .cabal or package.yaml file found in " <> T.pack pkg
@@ -341,7 +255,7 @@ parseCabalPackage' pkg = runExceptT $ do
341255 case condLibrary <$> result of
342256 Right (Just condLib) -> do
343257 let (_, lib) = simplifyCondTree evalConfVar condLib
344− pure $ Just $ (warnings,) $ CabalPackageInfo
258+ pure $ (warnings,) $ CabalPackageInfo
345259 { _cabalPackageInfo_packageName = T.pack packageName
346260 , _cabalPackageInfo_packageFile = packageFile
347261 , _cabalPackageInfo_packageRoot = takeDirectory packageFile
@@ -353,202 +267,125 @@ parseCabalPackage' pkg = runExceptT $ do
353267 , _cabalPackageInfo_defaultLanguage =
354268 defaultLanguage $ libBuildInfo lib
355269 , _cabalPackageInfo_compilerOptions = options $ libBuildInfo lib
356− , _cabalPackageInfo_cppOptions = cppOptions $ libBuildInfo lib
357270 }
358− Right Nothing -> pure Nothing
271+ Right Nothing -> throwError "Haskell package has no library component"
359272 Left (_, errors) ->
360273 throwError $ T.pack $ "Failed to parse " <> packageFile <> ":\n" <> unlines (map show errors)
361274
362−parsePackagesOrFail :: (MonadObelisk m, Foldable f) => f FilePath -> m (NE.NonEmpty CabalPackageInfo)
363−parsePackagesOrFail dirs' = do
364− packageInfos' <- fmap catMaybes $ for dirs $ \dir -> do
275+parsePackagesOrFail :: MonadObelisk m => [FilePath] -> m (NE.NonEmpty CabalPackageInfo)
276+parsePackagesOrFail dirs = do
277+ (pkgDirErrs, packageInfos') <- fmap partitionEithers $ for dirs $ \dir -> do
365278 flip fmap (parseCabalPackage dir) $ \case
366279 Just packageInfo
367− | _cabalPackageInfo_buildable packageInfo -> Just packageInfo
368− _ -> Nothing
280+ | _cabalPackageInfo_buildable packageInfo -> Right packageInfo
281+ _ -> Left dir
369282
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']
283+ let packagesByName = Map.fromListWith (<>) [(_cabalPackageInfo_packageName p, p NE.:| []) | p <- packageInfos']
373284 unambiguous <- ifor packagesByName $ \packageName ps -> case ps of
374285 p NE.:| [] -> pure p -- No ambiguity here
375286 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)
287+ putLog Warning $ T.pack $
288+ "Packages named '" <> T.unpack packageName <> "' appear in " <> show (length ps) <> " different locations: "
289+ <> intercalate ", " (map _cabalPackageInfo_packageFile $ toList ps)
290+ <> "; Picking " <> _cabalPackageInfo_packageFile p
383291 pure p
384292
385293 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)
294+ Nothing -> failWith $ T.pack $ "No valid, buildable packages found in " <> intercalate ", " dirs
388295 Just xs -> pure xs
389296
390− pure packageInfos
391− where
392− dirs = toList dirs'
297+ unless (null pkgDirErrs) $
298+ putLog Warning $ T.pack $ "Failed to find buildable packages in " <> intercalate ", " pkgDirErrs
393299
394−packageInfoToNamePathMap :: Foldable f => f CabalPackageInfo -> Map Text FilePath
395−packageInfoToNamePathMap = Map.fromList . map (_cabalPackageInfo_packageName &&& _cabalPackageInfo_packageRoot) . toList
300+ pure packageInfos
396301
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− ]
302+packageInfoToNamePathMap :: [CabalPackageInfo] -> Map Text FilePath
303+packageInfoToNamePathMap = Map.fromList . map (_cabalPackageInfo_packageName &&& _cabalPackageInfo_packageRoot)
411304
412305-- | Create ghci configuration to load the given packages
413306withGhciScript
414− :: (MonadObelisk m, Foldable f)
415− => [String] -- ^ Commands to prefix to file
416− -> f CabalPackageInfo -- ^ List of packages to load into ghci
307+ :: MonadObelisk m
308+ => [CabalPackageInfo] -- ^ List of packages to load into ghci
309+ -> FilePath -- ^ All paths written to the .ghci file will be relative to this path
417310 -> (FilePath -> m ()) -- ^ Action to run with the path to generated temporary .ghci
418311 -> m ()
419−withGhciScript preCommands (toList -> packageInfos) f =
420− withSystemTempDirectory "ob-ghci" $ \fp -> do
421− let dotGhciPath = fp </> ".ghci"
422− liftIO $ writeFile dotGhciPath dotGhci
423− f dotGhciPath
424− where
312+withGhciScript packageInfos pathBase f = do
313+ selfExe <- liftIO getExecutablePath
314+ let
425315 packageNames = Set.fromList $ map _cabalPackageInfo_packageName packageInfos
426316 modulesToLoad = mconcat
427317 [ [ "Obelisk.Run" | "obelisk-run" `Set.member` packageNames ]
428318 , [ "Backend" | "backend" `Set.member` packageNames ]
429319 , [ "Frontend" | "frontend" `Set.member` packageNames ]
430320 ]
431− dotGhci = unlines $
432− preCommands <>
433− [ if null modulesToLoad then "" else ":load " <> unwords modulesToLoad
321+ dotGhci = unlines
322+ -- TODO: Shell escape
323+ [ ":set -F -pgmF " <> selfExe <> " -optF " <> preprocessorIdentifier <> " " <> unwords (map (("-optF " <>) . makeRelative pathBase . _cabalPackageInfo_packageFile) packageInfos)
324+ , ":set -i" <> intercalate ":" (packageInfos >>= rootedSourceDirs)
325+ , if null modulesToLoad then "" else ":load " <> unwords modulesToLoad
434326 , "import qualified Obelisk.Run"
435327 , "import qualified Frontend"
436− , "import qualified Backend"
437− ]
438−
439−-- | Builds a list of options to pass to ghci or set in .ghci file that configures
440−-- the preprocessor and source includes.
441−getGhciSessionSettings
442− :: (MonadObelisk m, Foldable f)
443− => f CabalPackageInfo -- ^ List of packages to load into ghci
444− -> FilePath -- ^ All paths will be relative to this path
445− -> Bool -- ^ Use relative paths
446− -> m [String]
447−getGhciSessionSettings (toList -> packageInfos) pathBase useRelativePaths = do
448− -- N.B. ghci settings do NOT support escaping in any way. To minimize the likelihood that
449− -- paths-with-spaces ruin our day, we first canonicalize everything, and then relativize
450− -- all paths to 'pathBase'.
451− selfExe <- liftIO $ canonicalizePath =<< getExecutablePath
452− canonicalPathBase <- liftIO $ canonicalizePath pathBase
453−
454− (pkgFiles, pkgSrcPaths :: [NonEmpty FilePath]) <- fmap unzip $ liftIO $ for packageInfos $ \pkg -> do
455− canonicalSrcDirs <- traverse canonicalizePath $ (_cabalPackageInfo_packageRoot pkg </>) <$> _cabalPackageInfo_sourceDirs pkg
456− canonicalPkgFile <- canonicalizePath $ _cabalPackageInfo_packageFile pkg
457− pure (canonicalPkgFile `relativeTo'` canonicalPathBase, (`relativeTo'` canonicalPathBase) <$> canonicalSrcDirs)
328+ , "import qualified Backend" ]
329+ withSystemTempDirectory "ob-ghci" $ \fp -> do
330+ let dotGhciPath = fp </> ".ghci"
331+ liftIO $ writeFile dotGhciPath dotGhci
332+ f dotGhciPath
458333
459− pure
460− $ baseGhciOptions
461− <> ["-F", "-pgmF", selfExe, "-optF", preprocessorIdentifier]
462− <> concatMap (\p -> ["-optF", p]) pkgFiles
463− <> [ "-i" <> intercalate ":" (concatMap toList pkgSrcPaths) ]
464334 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− ]
335+ rootedSourceDirs pkg = NE.toList $
336+ makeRelative pathBase . (_cabalPackageInfo_packageRoot pkg </>) <$> _cabalPackageInfo_sourceDirs pkg
473337
474338-- | Run ghci repl
475339runGhciRepl
476− :: (MonadObelisk m, Foldable f)
340+ :: MonadObelisk m
477341 => FilePath -- ^ Path to project root
478− -> f CabalPackageInfo -- ^ Packages to keep unbuilt
479− -> [String] -- ^ GHCi arguments
342+ -> [CabalPackageInfo]
343+ -> FilePath -- ^ Path to .ghci
480344 -> m ()
481−runGhciRepl root (toList -> packages) ghciArgs =
345+runGhciRepl root packages dotGhci =
482346 -- NOTE: We do *not* want to use $(staticWhich "ghci") here because we need the
483347 -- 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
348+ nixShellWithPkgs root True False (packageInfoToNamePathMap packages) $ Just $ "ghci " <> makeBaseGhciOptions dotGhci -- TODO: Shell escape
486349
487350-- | Run ghcid
488351runGhcid
489− :: (MonadObelisk m, Foldable f)
352+ :: MonadObelisk m
490353 => FilePath -- ^ Path to project root
491354 -> Bool -- ^ Should we chdir to root when running this process?
492− -> [String] -- ^ GHCi arguments
493− -> f CabalPackageInfo -- ^ Packages to keep unbuilt
355+ -> FilePath -- ^ Path to .ghci
356+ -> [CabalPackageInfo]
494357 -> Maybe String -- ^ Optional command to run at every reload
495358 -> m ()
496−runGhcid root chdirToRoot ghciArgs (toList -> packages) mcmd =
497− nixShellWithoutPkgs root True chdirToRoot (packageInfoToNamePathMap packages) "ghc" $
498− Just $ unwords $ fmap bashEscape $ ghcidExePath : opts
359+runGhcid root chdirToRoot dotGhci packages mcmd =
360+ nixShellWithPkgs root True chdirToRoot (packageInfoToNamePathMap packages) (Just $ unwords $ ghcidExePath : opts) -- TODO: Shell escape
499361 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− ]
362+ opts =
363+ [ "-W"
364+ , "--command='ghci -ignore-dot-ghci " <> makeBaseGhciOptions dotGhci <> "' "
365+ , "--outputfile=ghcid-output.txt"
366+ ] <> map (\x -> "--reload='" <> x <> "'") reloadFiles
367+ <> map (\x -> "--restart='" <> x <> "'") restartFiles
368+ <> testCmd
369+ testCmd = maybeToList (flip fmap mcmd $ \cmd -> "--test='" <> cmd <> "'") -- TODO: Shell escape
370+
508371 adjustRoot x = if chdirToRoot then makeRelative root x else x
509372 reloadFiles = map adjustRoot [root </> "config"]
510373 restartFiles = map (adjustRoot . _cabalPackageInfo_packageFile) packages
511374
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
375+makeBaseGhciOptions :: FilePath -> String
376+makeBaseGhciOptions dotGhci =
377+ unwords
378+ [ "-no-user-package-db"
379+ , "-package-env -"
380+ , "-ghci-script " <> dotGhci
381+ ]
382+
383+getFreePort :: MonadIO m => m PortNumber
384+getFreePort = liftIO $ withSocketsDo $ do
385+ addr:_ <- getAddrInfo (Just defaultHints) (Just "127.0.0.1") (Just "0")
386+ bracket (open addr) close socketPort
516387 where
517388 open addr = do
518− sock <- Socket.socket (Socket.addrFamily addr) (Socket.addrSocketType addr) (Socket.addrProtocol addr)
519− Socket.bind sock (Socket.addrAddress addr)
389+ sock <- socket (addrFamily addr) (addrSocketType addr) (addrProtocol addr)
390+ bind sock (addrAddress addr)
520391 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+280−399
@@ -5,48 +5,67 @@
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+ ( GitHubSource (..)
12+ , GitUri (..)
13+ , ReadThunkError (..)
14+ , ThunkConfig (..)
15+ , ThunkData (..)
16+ , ThunkPackConfig (..)
17+ , ThunkPtr (..)
18+ , ThunkRev (..)
19+ , ThunkSource (..)
20+ , ThunkUpdateConfig (..)
21+ , attrCacheFileName
22+ , createThunk
23+ , createThunkWithLatest
24+ , getLatestRev
25+ , getThunkGitBranch
26+ , getThunkPtr
27+ , gitUriToText
28+ , nixBuildAttrWithCache
29+ , nixBuildThunkAttrWithCache
30+ , packThunk
31+ , parseGitUri
32+ , readThunk
33+ , unpackThunk
34+ , updateThunk
35+ , updateThunkToLatest
36+ , uriThunkPtr
37+ ) where
1238
1339import Control.Applicative
1440import Control.Exception (displayException, try)
15−import Control.Lens (ifor, ifor_, (.~))
41+import qualified Control.Lens as Lens
42+import Control.Lens.Indexed hiding ((<.>))
1643import Control.Monad
17−import Control.Monad.Extra (findM)
18−import Control.Monad.Catch (MonadCatch, handle)
44+import Control.Monad.Catch (handle)
1945import Control.Monad.Except
2046import Data.Aeson ((.=))
2147import qualified Data.Aeson as Aeson
2248import Data.Aeson.Encode.Pretty
2349import qualified Data.Aeson.Types as Aeson
24−import Data.Bifunctor (first)
2550import qualified Data.ByteString.Lazy as LBS
2651import Data.Containers.ListUtils (nubOrd)
2752import Data.Default
2853import Data.Either.Combinators (fromRight', rightToMaybe)
29−import Data.Foldable (toList)
30−import Data.Function ((&))
31−import Data.Functor ((<&>))
3254import Data.Git.Ref (Ref)
3355import qualified Data.Git.Ref as Ref
3456import qualified Data.List as L
35−import Data.List.NonEmpty (NonEmpty (..), nonEmpty)
57+import Data.List.NonEmpty (NonEmpty (..))
3658import qualified Data.List.NonEmpty as NonEmpty
3759import Data.Map (Map)
3860import qualified Data.Map as Map
3961import Data.Maybe
4062import Data.Set (Set)
4163import qualified Data.Set as Set
42−import Data.String.Here.Interpolated (i)
43−import Data.String.Here.Uninterpolated (here)
4464import Data.Text (Text)
4565import qualified Data.Text as T
4666import Data.Text.Encoding
4767import qualified Data.Text.IO as T
4868import Data.Time.Clock.POSIX (posixSecondsToUTCTime)
49−import Data.Traversable (for)
5069import Data.Yaml (parseMaybe)
5170import GitHub
5271import GitHub.Data.Name
@@ -56,7 +75,7 @@ import System.Exit
5675import System.FilePath
5776import System.IO.Error
5877import System.IO.Temp
59−import System.PosixCompat.Files (getSymbolicLinkStatus, modificationTime)
78+import System.Posix (getSymbolicLinkStatus, modificationTime)
6079import qualified Text.URI as URI
6180
6281import Obelisk.App (MonadObelisk)
@@ -65,10 +84,11 @@ import Obelisk.Command.Utils
6584
6685--TODO: Support symlinked thunk data
6786data ThunkData
68− = ThunkData_Packed ThunkSpec ThunkPtr
87+ = ThunkData_Packed ThunkPtr
6988 -- ^ Packed thunk
70− | ThunkData_Checkout
89+ | ThunkData_Checkout (Maybe ThunkPtr)
7190 -- ^ Checked out thunk that was unpacked from this pointer
91+ deriving (Show, Eq, Ord)
7292
7393-- | A reference to the exact data that a thunk should translate into
7494data ThunkPtr = ThunkPtr
@@ -94,11 +114,6 @@ data ThunkSource
94114 | ThunkSource_Git GitSource
95115 deriving (Show, Eq, Ord)
96116
97−thunkSourceToGitSource :: ThunkSource -> GitSource
98−thunkSourceToGitSource = \case
99− ThunkSource_GitHub s -> forgetGithub False s
100− ThunkSource_Git s -> s
101−
102117data GitHubSource = GitHubSource
103118 { _gitHubSource_owner :: Name Owner
104119 , _gitHubSource_repo :: Name Repo
@@ -178,14 +193,14 @@ getNixSha256ForUriUnpacked
178193getNixSha256ForUriUnpacked uri =
179194 withExitFailMessage ("nix-prefetch-url: Failed to determine sha256 hash of URL " <> gitUriToText uri) $ do
180195 [hash] <- fmap T.lines $ readProcessAndLogOutput (Debug, Debug) $
181− proc nixPrefetchUrlPath ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
196+ proc "nix-prefetch-url" ["--unpack", "--type", "sha256", T.unpack $ gitUriToText uri]
182197 pure hash
183198
184199nixPrefetchGit :: MonadObelisk m => GitUri -> Text -> Bool -> m NixSha256
185200nixPrefetchGit uri rev fetchSubmodules =
186201 withExitFailMessage ("nix-prefetch-git: Failed to determine sha256 hash of Git repo " <> gitUriToText uri <> " at " <> rev) $ do
187202 out <- readProcessAndLogStderr Debug $
188− proc nixPrefetchGitPath $ filter (/="")
203+ proc "nix-prefetch-git" $ filter (/="")
189204 [ "--url", T.unpack $ gitUriToText uri
190205 , "--rev", T.unpack rev
191206 , if fetchSubmodules then "--fetch-submodules" else ""
@@ -198,117 +213,96 @@ nixPrefetchGit uri rev fetchSubmodules =
198213
199214--TODO: Pretty print these
200215data 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 = "."
216+ = ReadThunkError_UnrecognizedFiles
217+ | ReadThunkError_AmbiguousFiles
218+ | ReadThunkError_UnrecognizedLoader Text
219+ | ReadThunkError_UnparseablePtr LBS.ByteString
220+ deriving (Show)
221+
222+-- | Read a thunk and validate that it is only a thunk, either packed or unpacked.
223+-- If the thunk is packed and additional data is present, fail.
224+readThunk :: MonadObelisk m => FilePath -> m (Either ReadThunkError ThunkData)
225+readThunk thunkDir = do
226+ files <- liftIO $ listDirectory thunkDir
227+ case ".git" `elem` files of
228+ True -> fmap ThunkData_Checkout <$> do
229+ let origThunkPath = thunkDir </> ".git" </> "obelisk" </> "orig-thunk"
230+ liftIO $ doesDirectoryExist origThunkPath >>= \case
231+ True -> fmap Just <$> readPackedThunk origThunkPath
232+ False -> return $ return Nothing
233+ False -> liftIO $ fmap ThunkData_Packed <$> readPackedThunk thunkDir
213234
214235attrCacheFileName :: FilePath
215236attrCacheFileName = ".attr-cache"
216237
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)
238+data ThunkType = ThunkType
239+ { _thunkType_loader :: FilePath
240+ , _thunkType_json :: FilePath
241+ , _thunkType_optional :: Set FilePath
242+ , _thunkType_loaderVersions :: NonEmpty Text
243+ , _thunkType_parser :: Aeson.Object -> Aeson.Parser ThunkPtr
228244 }
229245
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}|]
246+gitHubThunkType :: ThunkType
247+gitHubThunkType = ThunkType
248+ { _thunkType_loader = "default.nix"
249+ , _thunkType_json = "github.json"
250+ , _thunkType_optional = Set.fromList [attrCacheFileName]
251+ , _thunkType_loaderVersions = gitHubStandaloneLoaders
252+ , _thunkType_parser = parseThunkPtr $ \v ->
253+ ThunkSource_GitHub <$> parseGitHubSource v <|> ThunkSource_Git <$> parseGitSource v
254+ }
255+
256+gitThunkType :: ThunkType
257+gitThunkType = ThunkType
258+ { _thunkType_loader = "default.nix"
259+ , _thunkType_json = "git.json"
260+ , _thunkType_optional = Set.fromList [attrCacheFileName]
261+ , _thunkType_loaderVersions = plainGitStandaloneLoaders
262+ , _thunkType_parser = parseThunkPtr $ fmap ThunkSource_Git . parseGitSource
263+ }
264+
265+thunkTypes :: [ThunkType]
266+thunkTypes = [gitThunkType, gitHubThunkType]
267+
268+findThunkType :: [ThunkType] -> FilePath -> IO (Either ReadThunkError ThunkType)
269+findThunkType types thunkDir = do
270+ matches <- fmap catMaybes $ forM types $ \thunkType -> do
271+ let
272+ expectedContents = Set.fromList $ (thunkDir </>) <$>
273+ [ _thunkType_loader thunkType
274+ , _thunkType_json thunkType
275+ ]
276+ optionalContents = Set.map (thunkDir </>) (_thunkType_optional thunkType)
277+
278+ -- Ensure that there aren't any other files in the thunk
279+ -- NB: System.Directory.listDirectory returns the contents without the directory path
280+ files <- liftIO $ Set.fromList . fmap (thunkDir </>) <$> listDirectory thunkDir
281+ let unexpectedContents = files `Set.difference` (expectedContents `Set.union` optionalContents)
282+ missingContents = expectedContents `Set.difference` files
283+ pure $ if Set.null unexpectedContents && Set.null missingContents
284+ then Just thunkType
285+ else Nothing
286+
287+ pure $ case matches of
288+ [singleMatch] -> Right singleMatch
289+ [] -> Left ReadThunkError_UnrecognizedFiles
290+ _ -> Left ReadThunkError_AmbiguousFiles
307291
308292-- | Read a thunk and validate that it is exactly a packed thunk.
309293-- If additional data is present, fail.
310−readThunk :: (MonadObelisk m) => FilePath -> m (Either ReadThunkError ThunkData)
311−readThunk = readThunkWith thunkSpecTypes
294+readPackedThunk :: FilePath -> IO (Either ReadThunkError ThunkPtr)
295+readPackedThunk thunkDir = runExceptT $ do
296+ thunkType <- ExceptT $ findThunkType thunkTypes thunkDir
297+ -- Ensure that we recognize the thunk loader
298+ loader <- liftIO $ T.readFile $ thunkDir </> _thunkType_loader thunkType
299+ unless (loader `elem` _thunkType_loaderVersions thunkType) $ do
300+ throwError $ ReadThunkError_UnrecognizedLoader loader
301+
302+ txt <- liftIO $ LBS.readFile $ thunkDir </> _thunkType_json thunkType
303+ case parseMaybe (_thunkType_parser thunkType) =<< Aeson.decode txt of
304+ Nothing -> throwError $ ReadThunkError_UnparseablePtr txt
305+ Just ptr -> return ptr
312306
313307parseThunkPtr :: (Aeson.Object -> Aeson.Parser ThunkSource) -> Aeson.Object -> Aeson.Parser ThunkPtr
314308parseThunkPtr parseSrc v = do
@@ -352,18 +346,16 @@ parseGitSource v = do
352346overwriteThunk :: MonadObelisk m => FilePath -> ThunkPtr -> m ()
353347overwriteThunk target thunk = do
354348 -- 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 ()
349+ Right _ <- readThunk target
358350
359351 --TODO: Is there a safer way to do this overwriting?
360− liftIO $ removePathForcibly target
361− createThunk target $ Right thunk
352+ liftIO $ removeDirectoryRecursive target
353+ liftIO $ createThunk target thunk
362354
363−thunkPtrToSpec :: ThunkPtr -> ThunkSpec
364−thunkPtrToSpec thunk = case _thunkPtr_source thunk of
365− ThunkSource_GitHub _ -> NonEmpty.head gitHubThunkSpecs
366− ThunkSource_Git _ -> NonEmpty.head gitThunkSpecs
355+thunkPtrLoader :: ThunkPtr -> Text
356+thunkPtrLoader thunk = case _thunkPtr_source thunk of
357+ ThunkSource_GitHub _ -> NonEmpty.head gitHubStandaloneLoaders
358+ ThunkSource_Git _ -> NonEmpty.head plainGitStandaloneLoaders
367359
368360-- It's important that formatting be very consistent here, because
369361-- otherwise when people update thunks, their patches will be messy
@@ -410,41 +402,35 @@ encodeThunkPtrData (ThunkPtr rev src) = case src of
410402 , confTrailingNewline = True
411403 }
412404
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
405+createThunk :: MonadIO m => FilePath -> ThunkPtr -> m ()
406+createThunk target thunk = liftIO $ do
407+ createDirectoryIfMissing True (target </> attrCacheFileName)
408+ T.writeFile (target </> "default.nix") (thunkPtrLoader thunk)
409+ let
410+ jsonFileName = case _thunkPtr_source thunk of
411+ ThunkSource_GitHub _ -> "github"
412+ ThunkSource_Git _ -> "git"
413+ LBS.writeFile (target </> jsonFileName <.> "json") (encodeThunkPtrData thunk)
428414
429415createThunkWithLatest :: MonadObelisk m => FilePath -> ThunkSource -> m ()
430416createThunkWithLatest target s = do
431417 rev <- getLatestRev s
432− createThunk target $ Right $ ThunkPtr
418+ createThunk target $ ThunkPtr
433419 { _thunkPtr_source = s
434420 , _thunkPtr_rev = rev
435421 }
436422
437423updateThunkToLatest :: MonadObelisk m => ThunkUpdateConfig -> FilePath -> m ()
438−updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ do
439− checkThunkDirectory target
424+updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = withSpinner' ("Updating thunk " <> T.pack target <> " to latest") (pure $ const $ "Thunk " <> T.pack target <> " updated to latest") $ do
425+ checkThunkDirectory "ob thunk update directory cannot be '.'" target
440426 -- check to see if thunk should be updated to a specific branch or just update it's current branch
441427 case mBranch of
442428 Nothing -> do
443429 (overwrite, ptr) <- readThunk target >>= \case
444− Left err -> failWith [i|Thunk update: ${err}|]
430+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
445431 Right c -> case c of
446− ThunkData_Packed _ t -> return (target, t)
447− ThunkData_Checkout -> failWith "cannot update an unpacked thunk"
432+ ThunkData_Packed t -> return (target, t)
433+ ThunkData_Checkout _ -> failWith "cannot update an unpacked thunk"
448434 let src = _thunkPtr_source ptr
449435 rev <- getLatestRev src
450436 overwriteThunk overwrite $ modifyThunkPtrByConfig thunkConfig $ ThunkPtr
@@ -452,12 +438,14 @@ updateThunkToLatest (ThunkUpdateConfig mBranch thunkConfig) target = spinner $ d
452438 , _thunkPtr_rev = rev
453439 }
454440 Just branch -> readThunk target >>= \case
455− Left err -> failWith [i|Thunk update: ${err}|]
441+ Left err -> failWith $ T.pack $ "thunk update: " <> show err
456442 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")
443+ ThunkData_Packed t -> case _thunkPtr_source t of
444+ ThunkSource_Git tsg -> setThunk thunkConfig target tsg branch
445+ ThunkSource_GitHub tsgh -> do
446+ let tsg = forgetGithub False tsgh
447+ setThunk thunkConfig target tsg branch
448+ 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."
461449
462450setThunk :: MonadObelisk m => ThunkConfig -> FilePath -> GitSource -> String -> m ()
463451setThunk thunkConfig target gs branch = do
@@ -467,21 +455,21 @@ setThunk thunkConfig target gs branch = do
467455
468456-- | All recognized github standalone loaders, ordered from newest to oldest.
469457-- 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
458+gitHubStandaloneLoaders :: NonEmpty Text
459+gitHubStandaloneLoaders =
460+ gitHubStandaloneLoaderV4 :|
461+ [ gitHubStandaloneLoaderV3
462+ , gitHubStandaloneLoaderV2
463+ , gitHubStandaloneLoaderV1
477464 ]
478465
479−gitHubThunkSpecV1 :: ThunkSpec
480−gitHubThunkSpecV1 = legacyGitHubThunkSpec "github-v1"
481− "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
466+gitHubStandaloneLoaderV1 :: Text
467+gitHubStandaloneLoaderV1 = T.unlines
468+ [ "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))"
469+ ]
482470
483−gitHubThunkSpecV2 :: ThunkSpec
484−gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
471+gitHubStandaloneLoaderV2 :: Text
472+gitHubStandaloneLoaderV2 = T.unlines
485473 [ "# DO NOT HAND-EDIT THIS FILE" --TODO: Add something about how to get more info on Obelisk, etc.
486474 , "import ((import <nixpkgs> {}).fetchFromGitHub ("
487475 , " let json = builtins.fromJSON (builtins.readFile ./github.json);"
@@ -491,8 +479,8 @@ gitHubThunkSpecV2 = legacyGitHubThunkSpec "github-v2" $ T.unlines
491479 , "))"
492480 ]
493481
494−gitHubThunkSpecV3 :: ThunkSpec
495−gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
482+gitHubStandaloneLoaderV3 :: Text
483+gitHubStandaloneLoaderV3 = T.unlines
496484 [ "# DO NOT HAND-EDIT THIS FILE"
497485 , "let"
498486 , " fetch = { private ? false, ... }@args: if private && builtins.hasAttr \"fetchGit\" builtins"
@@ -511,8 +499,8 @@ gitHubThunkSpecV3 = legacyGitHubThunkSpec "github-v3" $ T.unlines
511499 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
512500 ]
513501
514−gitHubThunkSpecV4 :: ThunkSpec
515−gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
502+gitHubStandaloneLoaderV4 :: Text
503+gitHubStandaloneLoaderV4 = T.unlines
516504 [ "# DO NOT HAND-EDIT THIS FILE"
517505 , "let fetch = { private ? false, fetchSubmodules ? false, owner, repo, rev, sha256, ... }:"
518506 , " if !fetchSubmodules && !private then builtins.fetchTarball {"
@@ -523,50 +511,24 @@ gitHubThunkSpecV4 = legacyGitHubThunkSpec "github-v4" $ T.unlines
523511 , "in import (fetch (builtins.fromJSON (builtins.readFile ./github.json)))"
524512 ]
525513
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)
514+plainGitStandaloneLoaders :: NonEmpty Text
515+plainGitStandaloneLoaders =
516+ plainGitStandaloneLoaderV4 :|
517+ [ plainGitStandaloneLoaderV1
518+ , plainGitStandaloneLoaderV2
519+ , plainGitStandaloneLoaderV3
532520 ]
533521
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
558− ]
559−
560−gitThunkSpecV1 :: ThunkSpec
561−gitThunkSpecV1 = legacyGitThunkSpec "git-v1" $ T.unlines
522+plainGitStandaloneLoaderV1 :: Text
523+plainGitStandaloneLoaderV1 = T.unlines
562524 [ "# DO NOT HAND-EDIT THIS FILE"
563525 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
564526 , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
565527 , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
566528 ]
567529
568−gitThunkSpecV2 :: ThunkSpec
569−gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
530+plainGitStandaloneLoaderV2 :: Text
531+plainGitStandaloneLoaderV2 = T.unlines
570532 [ "# DO NOT HAND-EDIT THIS FILE"
571533 , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
572534 , " if builtins.hasAttr \"fetchGit\" builtins"
@@ -577,8 +539,8 @@ gitThunkSpecV2 = legacyGitThunkSpec "git-v2" $ T.unlines
577539
578540-- This loader has a bug because @builtins.fetchGit@ is not given a @ref@
579541-- and will fail to find commits without this because it does shallow clones.
580−gitThunkSpecV3 :: ThunkSpec
581−gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
542+plainGitStandaloneLoaderV3 :: Text
543+plainGitStandaloneLoaderV3 = T.unlines
582544 [ "# DO NOT HAND-EDIT THIS FILE"
583545 , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
584546 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
@@ -593,8 +555,8 @@ gitThunkSpecV3 = legacyGitThunkSpec "git-v3" $ T.unlines
593555 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
594556 ]
595557
596−gitThunkSpecV4 :: ThunkSpec
597−gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
558+plainGitStandaloneLoaderV4 :: Text
559+plainGitStandaloneLoaderV4 = T.unlines
598560 [ "# DO NOT HAND-EDIT THIS FILE"
599561 , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
600562 , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
@@ -610,52 +572,10 @@ gitThunkSpecV4 = legacyGitThunkSpec "git-v4" $ T.unlines
610572 , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
611573 ]
612574
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−|]
575+thunkFileNames :: [FilePath]
576+thunkFileNames = ["default.nix", "github.json", "git.json"]
655577
656−
657−parseJsonObject :: (Aeson.Object -> Aeson.Parser a) -> LBS.ByteString -> Either String a
658−parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
578+--TODO: when checking something out, make a shallow clone
659579
660580-- | Checks a cache directory to see if there is a fresh symlink
661581-- to the result of building an attribute of a thunk.
@@ -663,49 +583,44 @@ parseJsonObject p bytes = Aeson.parseEither p =<< Aeson.eitherDecode bytes
663583-- and the result is symlinked into the cache.
664584nixBuildThunkAttrWithCache
665585 :: MonadObelisk m
666− => ThunkSpec
667− -> FilePath
586+ => FilePath
668587 -- ^ Path to directory containing Thunk
669588 -> String
670589 -- ^ Attribute to build
671− -> m (Maybe FilePath)
590+ -> m FilePath
672591 -- ^ Symlink to cached or built nix output
673592-- WARNING: If the thunk uses an impure reference such as '<nixpkgs>'
674593-- the caching mechanism will fail as it merely measures the modification
675594-- time of the cache link and the expression to build.
676−nixBuildThunkAttrWithCache thunkSpec thunkDir attr = do
595+nixBuildThunkAttrWithCache thunkDir attr = do
596+ --NB: Expects thunkDir to be normalised with no trailing path separator.
597+ --This should be guaranteed by the command argument parser.
598+ let cacheErrHandler e
599+ | isDoesNotExistError e = return Nothing -- expected from a cache miss
600+ | otherwise = putLog Error (T.pack $ displayException e) >> return Nothing
601+ cacheDir = thunkDir </> attrCacheFileName
602+ cachePath = cacheDir </> attr <.> "out"
677603 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− }
604+ createDirectoryIfMissing False cacheDir
605+ let getModificationTimeMaybe = fmap rightToMaybe . try @IOError . getModificationTime
606+ maximum . catMaybes <$> mapM (getModificationTimeMaybe . (thunkDir </>)) thunkFileNames
607+ cacheHit <- handle cacheErrHandler $ do
608+ cacheTime <- liftIO $ posixSecondsToUTCTime . realToFrac . modificationTime <$> getSymbolicLinkStatus cachePath
609+ return $ if latestChange <= cacheTime
610+ then Just cachePath
611+ else Nothing
612+ case cacheHit of
613+ Just c -> return c
614+ Nothing -> do
615+ putLog Warning $ T.pack $ mconcat [thunkDir, ": ", attr, " not cached, building ..."]
616+ _ <- nixCmd $ NixCmd_Build $ def
617+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_IndirectRoot cachePath
618+ Lens.& nixCmdConfig_target Lens..~ Target
619+ { _target_path = Just thunkDir
620+ , _target_attr = Just attr
621+ , _target_expr = Nothing
622+ }
623+ return cachePath
709624
710625-- | Build a nix attribute, and cache the result if possible
711626nixBuildAttrWithCache
@@ -716,15 +631,13 @@ nixBuildAttrWithCache
716631 -- ^ Attribute to build
717632 -> m FilePath
718633 -- ^ 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
634+nixBuildAttrWithCache exprPath attr = do
635+ readThunk exprPath >>= \case
636+ -- Only packed thunks are cached. in particular, checkouts are not
637+ Right (ThunkData_Packed _) -> nixBuildThunkAttrWithCache exprPath attr
638+ _ -> nixCmd $ NixCmd_Build $ def
639+ Lens.& nixBuildConfig_outLink Lens..~ OutLink_None
640+ Lens.& nixCmdConfig_target Lens..~ Target
728641 { _target_path = Just exprPath
729642 , _target_attr = Just attr
730643 , _target_expr = Nothing
@@ -745,7 +658,7 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
745658 where
746659 copyThunkToTmp tmpDir thunkDir = readThunk thunkDir >>= \case
747660 Left err -> failWith $ "withThunkUnpacked: " <> T.pack (show err)
748− Right ThunkData_Packed{} -> do
661+ Right (ThunkData_Packed _) -> do
749662 let tmpThunk = tmpDir </> "thunk"
750663 callProcessAndLogOutput (Notice, Error) $
751664 proc cp ["-r", "-T", thunkDir, tmpThunk]
@@ -759,81 +672,62 @@ updateThunk p f = withSystemTempDirectory "obelisk-thunkptr-" $ \tmpDir -> do
759672finalMsg :: Bool -> (a -> Text) -> Maybe (a -> Text)
760673finalMsg noTrail s = if noTrail then Nothing else Just s
761674
675+unpackThunk :: MonadObelisk m => FilePath -> m ()
676+unpackThunk = unpackThunk' False
677+
762678-- | Check that we are not somewhere inside the thunk directory
763−checkThunkDirectory :: MonadObelisk m => FilePath -> m ()
764−checkThunkDirectory thunkDir = do
679+checkThunkDirectory :: MonadObelisk m => Text -> FilePath -> m ()
680+checkThunkDirectory msg thunkDir = do
765681 currentDir <- liftIO getCurrentDirectory
766682 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
683+ when (thunkDir' `L.isInfixOf` currentDir) $ failWith msg
778684
779685unpackThunk' :: MonadObelisk m => Bool -> FilePath -> m ()
780−unpackThunk' noTrail thunkDir = checkThunkDirectory thunkDir *> readThunk thunkDir >>= \case
781− Left err -> failWith [i|Invalid thunk at ${thunkDir}: ${err}|]
686+unpackThunk' noTrail thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
687+ Left err -> failWith $ "thunk unpack: " <> T.pack (show err)
782688 --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
689+ Right (ThunkData_Checkout _) -> failWith "thunk unpack: thunk is already unpacked"
690+ Right (ThunkData_Packed tptr) -> do
785691 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
692+ withTempDirectory thunkParent thunkName $ \tmpRepo -> do
693+ let obGitDir = tmpRepo </> ".git" </> "obelisk"
694+ s = case _thunkPtr_source tptr of
695+ ThunkSource_GitHub s' -> forgetGithub False s'
696+ ThunkSource_Git s' -> s'
792697 withSpinner' ("Fetching thunk " <> T.pack thunkName)
793698 (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"]
699+ let git = callProcessAndLogOutput (Notice, Notice) . gitProc tmpRepo
700+ git $ [ "clone" ]
701+ ++ ("--recursive" <$ guard (_gitSource_fetchSubmodules s))
702+ ++ [ T.unpack $ gitUriToText $ _gitSource_url s ]
703+ ++ do branch <- maybeToList $ _gitSource_branch s
704+ [ "--branch", T.unpack $ untagName branch ]
705+ git ["reset", "--hard", Ref.toHexString $ _thunkRev_commit $ _thunkPtr_rev tptr]
706+ when (_gitSource_fetchSubmodules s) $
707+ git ["submodule", "update", "--recursive", "--init"]
708+
709+ liftIO $ createDirectory obGitDir
710+ callProcessAndLogOutput (Notice, Error) $
711+ proc cp ["-r", "-T", thunkDir </> ".", obGitDir </> "orig-thunk"]
712+ callProcessAndLogOutput (Notice, Error) $
713+ proc "rm" ["-r", thunkDir]
714+ callProcessAndLogOutput (Notice, Error) $
715+ proc "mv" ["-T", tmpRepo, thunkDir]
821716
822717--TODO: add a rollback mode to pack to the original thunk
823718packThunk :: MonadObelisk m => ThunkPackConfig -> FilePath -> m ThunkPtr
824719packThunk = packThunk' False
825720
826721packThunk' :: 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
722+packThunk' noTrail (ThunkPackConfig force thunkConfig) thunkDir = checkThunkDirectory "Can't pack/unpack from within the thunk directory" thunkDir >> readThunk thunkDir >>= \case
723+ Left err -> failWith $ T.pack $ "thunk pack: " <> show err
724+ Right (ThunkData_Packed _) -> failWith "pack: thunk is already packed"
725+ Right (ThunkData_Checkout _) -> do
726+ withSpinner' ("Packing thunk " <> T.pack thunkDir)
727+ (finalMsg noTrail $ const $ "Packed thunk " <> T.pack thunkDir) $ do
728+ thunkPtr <- modifyThunkPtrByConfig thunkConfig <$> getThunkPtr (not force) thunkDir (_thunkConfig_private thunkConfig)
729+ callProcessAndLogOutput (Debug, Error) $ proc "rm" ["-rf", thunkDir]
730+ liftIO $ createThunk thunkDir thunkPtr
837731 pure thunkPtr
838732
839733modifyThunkPtrByConfig :: ThunkConfig -> ThunkPtr -> ThunkPtr
@@ -844,43 +738,29 @@ modifyThunkPtrByConfig (ThunkConfig markPrivate') ptr = case markPrivate' of
844738 ThunkSource_GitHub s -> ThunkSource_GitHub $ s { _gitHubSource_private = markPrivate }
845739 }
846740
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
741+getThunkPtr :: forall m. MonadObelisk m => Bool -> FilePath -> Maybe Bool -> m ThunkPtr
742+getThunkPtr checkClean thunkDir mPrivate = do
743+ when checkClean $ ensureCleanGitRepo thunkDir True
869744 "thunk pack: thunk checkout contains unsaved modifications"
870745
871746 -- Check whether there are any stashes
872− when checkClean $ do
873− stashOutput <- readGitProcess thunkDir ["stash", "list"]
874− unless (T.null stashOutput) $
747+ stashOutput <- readGitProcess thunkDir ["stash", "list"]
748+ when checkClean $ case T.null stashOutput of
749+ False -> do
875750 failWith $ T.unlines $
876751 [ "thunk pack: thunk checkout has stashes"
877752 , "git stash list:"
878753 ] ++ T.lines stashOutput
754+ True -> return ()
879755
880756 -- Get current branch
881757 (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"]
758+ b <- listToMaybe
759+ <$> T.lines
760+ <$> readGitProcess thunkDir ["rev-parse", "--abbrev-ref", "HEAD"]
761+ c <- listToMaybe
762+ <$> T.lines
763+ <$> readGitProcess thunkDir ["rev-parse", "HEAD"]
884764 case b of
885765 (Just "HEAD") -> failWith $ T.unlines
886766 [ "thunk pack: You are in 'detached HEAD' state."
@@ -891,7 +771,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
891771
892772 -- Get information on all branches and their (optional) designated upstream
893773 -- correspondents
894− headDump :: [Text] <- T.lines <$> readGitProcess thunkDir
774+ (headDump :: [Text]) <- T.lines <$> readGitProcess thunkDir
895775 [ "for-each-ref"
896776 , "--format=%(refname:short) %(upstream:short) %(upstream:remotename)"
897777 , "refs/heads/"
@@ -937,7 +817,7 @@ getThunkPtr gitCheckClean dir mPrivate = do
937817 ]
938818
939819 -- 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
820+ stats <- iforM headUpstream $ \branch (upstream, _remote) -> do
941821 (stat :: [Text]) <- T.lines <$> readGitProcess thunkDir
942822 [ "rev-list", "--left-right"
943823 , T.unpack branch <> "..." <> T.unpack upstream
@@ -961,9 +841,8 @@ getThunkPtr gitCheckClean dir mPrivate = do
961841 \pushed but this repo's remote tracking branches don't know it.)"
962842 ]
963843
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."
844+ -- We assume it's safe to pack the thunk at this point
845+ putLog Informational "All changes safe in git remotes. OK to pack thunk."
967846
968847 let remote = maybe "origin" snd $ flip Map.lookup headUpstream =<< mCurrentBranch
969848
@@ -981,7 +860,9 @@ getThunkPtr gitCheckClean dir mPrivate = do
981860-- | Get the latest revision available from the given source
982861getLatestRev :: MonadObelisk m => ThunkSource -> m ThunkRev
983862getLatestRev os = do
984− let gitS = thunkSourceToGitSource os
863+ let gitS = case os of
864+ ThunkSource_GitHub s -> forgetGithub False s
865+ ThunkSource_Git s -> s
985866 (_, commit) <- gitGetCommitBranch (_gitSource_url gitS) (untagName <$> _gitSource_branch gitS)
986867 case os of
987868 ThunkSource_GitHub s -> githubThunkRev s commit
lib/command/src/Obelisk/Command/Utils.hs+4−51
@@ -10,20 +10,19 @@ module Obelisk.Command.Utils where
1010import Control.Applicative hiding (many)
1111import Control.Monad.Except
1212import Data.Bool (bool)
13+import qualified Text.Megaparsec.Char.Lexer as ML
1314import Data.Bifunctor
1415import Data.Char
1516import Data.Either
16−import Data.List (isInfixOf)
17+import Data.Semigroup ((<>))
1718import Data.Map (Map)
1819import qualified Data.Map as M
1920import Data.Maybe (maybeToList)
20−import Data.Semigroup ((<>))
2121import Data.Text (Text)
2222import qualified Data.Text as T
2323import Data.Void (Void)
2424import System.Exit (ExitCode)
2525import System.Which (staticWhich)
26−import qualified Text.Megaparsec.Char.Lexer as ML
2726import Text.Megaparsec as MP
2827import Text.Megaparsec.Char as MP
2928
@@ -33,12 +32,6 @@ import Obelisk.CliApp
3332cp :: FilePath
3433cp = $(staticWhich "cp")
3534
36−mvPath :: FilePath
37−mvPath = $(staticWhich "mv")
38−
39−rmPath :: FilePath
40−rmPath = $(staticWhich "rm")
41−
4235ghcidExePath :: FilePath
4336ghcidExePath = $(staticWhich "ghcid")
4437
@@ -54,46 +47,6 @@ nixBuildExePath = $(staticWhich "nix-build")
5447jreKeyToolPath :: FilePath
5548jreKeyToolPath = $(staticWhich "keytool")
5649
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−
96−
9750-- Check whether the working directory is clean
9851checkGitCleanStatus :: MonadObelisk m => FilePath -> Bool -> m Bool
9952checkGitCleanStatus repo withIgnored = do
@@ -123,7 +76,7 @@ initGit repo = do
12376 git ["commit", "-m", "Initial commit."]
12477
12578gitProcNoRepo :: [String] -> ProcessSpec
126−gitProcNoRepo args = setEnvOverride (M.singleton "GIT_TERMINAL_PROMPT" "0" <>) $ proc gitPath args
79+gitProcNoRepo args = setEnvOverride (M.singleton "GIT_TERMINAL_PROMPT" "0" <>) $ proc "git" args
12780
12881gitProc :: FilePath -> [String] -> ProcessSpec
12982gitProc repo = gitProcNoRepo . runGitInDir
@@ -140,7 +93,7 @@ isolateGitProc = setEnvOverride (overrides <>)
14093 , ("GIT_CONFIG_NOSYSTEM", "1")
14194 , ("GIT_TERMINAL_PROMPT", "0") -- git 2.3+
14295 , ("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")
96+ , ("GIT_SSH_COMMAND", "ssh -o PreferredAuthentications password -o PubkeyAuthentication no -o GSSAPIAuthentication no")
14497 ]
14598
14699-- | Recursively copy a directory using `cp -a` -- TODO: Should use -rT instead of -a
lib/command/src/Obelisk/Command/VmBuilder.hs+8−9
@@ -21,7 +21,6 @@ import qualified System.Info
2121
2222import Obelisk.App (MonadObelisk, getObeliskUserStateDir)
2323import Obelisk.CliApp
24−import Obelisk.Command.Utils (rmPath, whichPath, sshKeygenPath, nixBuildExePath, dockerPath)
2524
2625-- | Generate the `--builders` argument string to enable the VM builder after ensuring it is available.
2726getNixBuildersArg :: MonadObelisk m => m String
@@ -35,7 +34,7 @@ getNixBuildersArg = do
3534
3635checkForNixDarwin :: MonadObelisk m => String -> m ()
3736checkForNixDarwin sshIdFile = do
38− (exitCode, _, _) <- readCreateProcessWithExitCode $ proc whichPath ["darwin-rebuild"]
37+ (exitCode, _, _) <- readCreateProcessWithExitCode $ proc "which" ["darwin-rebuild"]
3938 unless (exitCode == ExitSuccess) $ failWith $ T.intercalate "\n"
4039 [ "Deployments from macOS require nix-darwin to be installed."
4140 , "Follow the installation instructions here: https://github.com/LnL7/nix-darwin"
@@ -67,7 +66,7 @@ containerExists :: MonadObelisk m => FilePath -> m Bool
6766containerExists stateDir = handle (\(_ :: IOError) -> failWith needDockerMsg) $ do
6867 containerNames <- fmap (map T.strip . T.lines) $
6968 readProcessAndLogStderr Error $
70− proc dockerPath ["container", "list", "--all", "--format", "{{.Names}}"]
69+ proc "docker" ["container", "list", "--all", "--format", "{{.Names}}"]
7170 let exists = containerName `elem` containerNames
7271 when exists $ testLinuxBuild stateDir
7372 pure exists
@@ -85,7 +84,7 @@ containerSshPort = 2222
8584startContainer :: MonadObelisk m => m ()
8685startContainer = withSpinner "Starting VM builder" $
8786 callProcessAndLogOutput (Debug, Debug) $
88− proc dockerPath ["start", containerName]
87+ proc "docker" ["start", containerName]
8988
9089-- | Creates the Docker container; assumes it does not exist.
9190setupNixDocker :: MonadObelisk m => FilePath -> m ()
@@ -96,14 +95,14 @@ setupNixDocker stateDir = withSpinner ("Creating Docker container named " <> con
9695
9796 -- Create new SSH keys for this container
9897 callProcessAndLogOutput (Debug, Error) $
99− proc rmPath ["-f", stateDir </> sshKeyFileName, stateDir </> sshKeyFileName <.> "pub"]
98+ proc "rm" ["-f", stateDir </> sshKeyFileName, stateDir </> sshKeyFileName <.> "pub"]
10099 callProcessAndLogOutput (Debug, Error) $
101− proc sshKeygenPath ["-t", "ed25519", "-f", stateDir </> sshKeyFileName, "-P", ""]
100+ proc "ssh-keygen" ["-t", "ed25519", "-f", stateDir </> sshKeyFileName, "-P", ""]
102101
103102 -- Build the docker container (which uses the SSH keys in the 'ssh' folder)
104103 containerId <- fmap T.strip $ readProcessAndLogStderr Error $
105− proc dockerPath ["build", stateDir, "--quiet"]
106− callProcessAndLogOutput (Debug, Error) $ proc dockerPath
104+ proc "docker" ["build", stateDir, "--quiet"]
105+ callProcessAndLogOutput (Debug, Error) $ proc "docker"
107106 [ "run"
108107 , "--restart", "always"
109108 , "--detach"
@@ -155,7 +154,7 @@ testLinuxBuild :: MonadObelisk m => FilePath -> m ()
155154testLinuxBuild stateDir
156155 | System.Info.os == "linux" = failWith "Using the docker builder is not necessary on linux."
157156 | otherwise = do
158− (exitCode, _stdout, stderr) <- readCreateProcessWithExitCode $ proc nixBuildExePath
157+ (exitCode, _stdout, stderr) <- readCreateProcessWithExitCode $ proc "nix-build"
159158 [ "--no-out-link"
160159 , "-E", "(import <nixpkgs> { system = \"x86_64-linux\"; }).writeText \"test\" builtins.currentTime"
161160 , "--builders", nixBuildersArgString stateDir
lib/executable-config/default.nix+19−37
@@ -2,44 +2,26 @@
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− });
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+ find "$out/config" -type f -printf '%P\0' >"$out/config.files"
20+ '');
21+in with nixpkgs.haskell.lib; {
22+ haskellOverlay = self: super: {
23+ obelisk-executable-config-lookup = self.callCabal2nix "obelisk-executable-config-lookup" (filterGitSource ./lookup) {};
4124 };
42−
4325 platforms = {
4426 android = {
4527 # Inject the given config directory into an android assets folder
@@ -50,7 +32,7 @@ in
5032 inject = injectConfig;
5133 };
5234 web = {
53− inject = self: self.callCabal2nix "obelisk-executable-config-inject" (obeliskCleanSource ./inject) {};
35+ inject = self: self.callCabal2nix "obelisk-executable-config-inject" (filterGitSource ./inject) {};
5436 };
5537 };
5638}
lib/executable-config/inject/obelisk-executable-config-inject.cabal+1−1
@@ -15,4 +15,4 @@ library
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/lookup/obelisk-executable-config-lookup.cabal+7−10
@@ -31,18 +31,15 @@ library
3131 base64-bytestring,
3232 bytestring,
3333 containers,
34− exceptions,
3534 filepath,
36− jsaddle,
37− mmorph,
38− monad-control,
39− mtl,
40− primitive,
41− ref-tf,
42− reflex-dom-core,
43− reflex,
4435 text,
36+ transformers,
4537 transformers-base,
46− transformers
38+ ref-tf,
39+ primitive,
40+ monad-control,
41+ reflex,
42+ reflex-dom,
43+ jsaddle
4744
4845 ghc-options: -Wall
lib/executable-config/lookup/src/Obelisk/Configs.hs+12−31
@@ -18,38 +18,24 @@ module Obelisk.Configs
1818 , getTextConfig
1919 ) where
2020
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
21+import Control.Applicative
22+import Control.Monad
23+import Control.Monad.Base
24+import Control.Monad.Fix
25+import Control.Monad.Primitive
26+import Control.Monad.Ref
27+import Control.Monad.IO.Class
28+import Control.Monad.Trans.Class
29+import Control.Monad.Trans.Control
30+import Control.Monad.Trans.Reader
3631import Data.ByteString (ByteString)
3732import Data.Map (Map)
3833import qualified Data.Map as Map
3934import Data.Text (Text)
4035import qualified Data.Text.Encoding as T
4136import 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− )
37+import Reflex.Host.Class
38+import Reflex.Dom
5339#ifndef ghcjs_HOST_OS
5440import Language.Javascript.JSaddle (MonadJSM)
5541#endif
@@ -76,8 +62,6 @@ instance HasConfigs m => HasConfigs (PostBuildT t m)
7662instance HasConfigs m => HasConfigs (QueryT t q m)
7763instance HasConfigs m => HasConfigs (ReaderT r m)
7864instance 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)
8165instance HasConfigs m => HasConfigs (StaticDomBuilderT t m)
8266instance HasConfigs m => HasConfigs (TriggerEventT t m)
8367
@@ -88,15 +72,12 @@ newtype ConfigsT m a = ConfigsT { unConfigsT :: ReaderT (Map Text ByteString) m
8872 , Monad
8973 , MonadPlus
9074 , Alternative
91− , MonadFail
9275 , MonadFix
93− , MonadThrow
9476 , MonadIO
9577 , MonadBase m'
9678 , MonadBaseControl m'
9779 , MonadRef
9880 , MonadTrans
99− , MFunctor
10081 , DomBuilder t
10182 , MonadHold t
10283 , MonadReflexCreateTrigger t
lib/frontend/obelisk-frontend.cabal+1−1
@@ -26,4 +26,4 @@ library
2626 exposed-modules:
2727 Obelisk.Frontend
2828 Obelisk.Frontend.Cookie
29− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
29+ ghc-options: -Wall
lib/frontend/src/Obelisk/Frontend.hs+1−1
@@ -182,7 +182,7 @@ runFrontendWithConfigsAndCurrentRoute
182182 -> Frontend (R frontendRoute)
183183 -> JSM ()
184184runFrontendWithConfigsAndCurrentRoute mode configs validFullEncoder frontend = do
185− let ve = validFullEncoder . hoistParse errorLeft (reviewEncoder (rPrism $ _FullRoute_Frontend . _ObeliskRoute_App))
185+ let ve = validFullEncoder . hoistParse errorLeft (prismEncoder (rPrism $ _FullRoute_Frontend . _ObeliskRoute_App))
186186 errorLeft = \case
187187 Left _ -> error "runFrontend: Unexpected non-app ObeliskRoute reached the frontend. This shouldn't happen."
188188 Right x -> Identity x
lib/route/README.mddeleted−6
@@ -1,6 +0,0 @@
1−# obelisk-route
2−
3−[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](http://www.haskell.org)
4−[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)
5−
6−Robust URL management for single-page apps.
lib/route/obelisk-route.cabal+1−2
@@ -20,7 +20,6 @@ library
2020 http-types,
2121 jsaddle,
2222 lens,
23− mmorph,
2423 monad-control,
2524 mtl,
2625 network-uri,
@@ -39,4 +38,4 @@ library
3938 exposed-modules: Obelisk.Route
4039 Obelisk.Route.TH
4140 Obelisk.Route.Frontend
42− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
41+ ghc-options: -Wall -fwarn-redundant-constraints
lib/route/src/Obelisk/Route.hs+52−98
@@ -1,4 +1,3 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE ApplicativeDo #-}
32{-# LANGUAGE ConstraintKinds #-}
43{-# LANGUAGE EmptyCase #-}
@@ -6,6 +5,7 @@
65{-# LANGUAGE FlexibleContexts #-}
76{-# LANGUAGE FlexibleInstances #-}
87{-# LANGUAGE GADTs #-}
8+{-# LANGUAGE KindSignatures #-}
99{-# LANGUAGE LambdaCase #-}
1010{-# LANGUAGE MultiParamTypeClasses #-}
1111{-# LANGUAGE OverloadedStrings #-}
@@ -50,7 +50,6 @@ module Obelisk.Route
5050 , pathParamEncoder
5151 , pathLiteralEncoder
5252 , singletonListEncoder
53− , packTextEncoder
5453 , unpackTextEncoder
5554 , prefixTextEncoder
5655 , unsafeTshowEncoder
@@ -61,7 +60,6 @@ module Obelisk.Route
6160 , justEncoder
6261 , nothingEncoder
6362 , isoEncoder
64− , viewEncoder
6563 , wrappedEncoder
6664 , unwrappedEncoder
6765 , listToNonEmptyEncoder
@@ -70,7 +68,6 @@ module Obelisk.Route
7068 , toListMapEncoder
7169 , shadowEncoder
7270 , prismEncoder
73− , reviewEncoder
7471 , rPrism
7572 , _R
7673 , obeliskRouteEncoder
@@ -135,24 +132,20 @@ import Control.Lens
135132 , Prism'
136133 , prism'
137134 , re
138− , review
139135 , view
140136 , Wrapped (..)
141137 )
142138import Control.Monad.Except
139+import Control.Monad.Writer (execWriter, tell)
143140import qualified Control.Monad.State.Strict as State
144141import Control.Monad.Trans (lift)
145−import Control.Monad.Writer (execWriter, tell)
146−import Data.Aeson (FromJSON, ToJSON)
147−import qualified Data.Aeson as Aeson
148142import qualified Data.ByteString as BS
149143import qualified Data.ByteString.Lazy as BSL
144+import Data.Dependent.Sum (DSum (..))
150145import Data.Dependent.Map (DMap)
151146import qualified Data.Dependent.Map as DMap
152−import Data.Dependent.Sum (DSum (..))
153147import Data.Either.Validation (Validation (..))
154148import Data.Foldable
155−import Data.Functor (($>))
156149import Data.Functor.Sum
157150import Data.GADT.Compare
158151import Data.GADT.Compare.TH
@@ -165,18 +158,18 @@ import Data.Monoid ((<>))
165158import Data.Set (Set)
166159import qualified Data.Set as Set
167160import Data.Some (Some(Some))
168−import Data.Tabulation
169161import Data.Text (Text)
170162import qualified Data.Text as T
171163import qualified Data.Text.Encoding as T
172−import Data.Text.Lens (IsText, packed, unpacked)
173−import Data.Type.Equality
174164import Data.Universe
175165import Data.Universe.Some
176166import Network.HTTP.Types.URI
177167import qualified Numeric.Lens
178168import Obelisk.Route.TH
179169import Text.Read (readMaybe)
170+import Data.Tabulation
171+import qualified Data.Aeson as Aeson
172+import Data.Aeson (FromJSON, ToJSON)
180173
181174-- Design goals:
182175-- No start-up time on the frontend (not yet met)
@@ -226,19 +219,7 @@ hoistR f (x :=> Identity y) = f x :/ y
226219infixr 5 :.
227220type (:.) = (,)
228221
229−#ifdef __GLASGOW_HASKELL__
230−#if __GLASGOW_HASKELL__ >= 810
231222{-# 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
242223pattern (:.) :: a -> b -> a :. b
243224pattern a :. b = (a, b)
244225
@@ -304,13 +285,13 @@ decode e x = runIdentity (tryDecode e x)
304285-- | Once an 'Encoder' has been checked, so that its check monad has become 'Identity', even if the same is not true of the
305286-- parse monad, we may still attempt to decode with it in its parse monad.
306287tryDecode :: Encoder Identity parse decoded encoded -> encoded -> parse decoded
307−tryDecode (Encoder (Identity impl)) = _encoderImpl_decode impl
288+tryDecode (Encoder (Identity impl)) x = _encoderImpl_decode impl x
308289
309290-- | Similar to 'decode', once an encoder has been checked so that its check monad is Identity, it
310291-- can be used to actually encode by using this. Note that while there's no constraint on the parse monad here,
311292-- one should usually be applying decode and encode to the same 'Encoder'
312293encode :: Encoder Identity parse decoded encoded -> decoded -> encoded
313−encode (Encoder (Identity impl)) = _encoderImpl_encode impl
294+encode (Encoder (Identity impl)) x = _encoderImpl_encode impl x
314295
315296-- | This is a primitive used to build encoders which can't fail to check. It should not be used unless one is
316297-- reasonably certain that the law given for 'EncoderImpl' above holds.
@@ -357,7 +338,7 @@ instance Monad parse => Bifunctor (,) (EncoderImpl parse) (EncoderImpl parse) (E
357338 }
358339
359340instance (Monad parse, Applicative check) => Braided (Encoder check parse) (,) where
360− braid = viewEncoder (iso swap swap)
341+ braid = isoEncoder (iso swap swap)
361342
362343
363344instance (Applicative check, Monad parse) => PFunctor (,) (Encoder check parse) (Encoder check parse) where
@@ -393,11 +374,11 @@ instance (Monad parse, Applicative check) => Bifunctor Either (Encoder check par
393374 bimap f g = Encoder $ liftA2 bimap (unEncoder f) (unEncoder g)
394375
395376instance (Applicative check, Monad parse) => Associative (Encoder check parse) Either where
396− associate = viewEncoder (iso (associate @(->) @Either) disassociate)
397− disassociate = viewEncoder (iso disassociate associate)
377+ associate = isoEncoder (iso (associate @(->) @Either) disassociate)
378+ disassociate = isoEncoder (iso disassociate associate)
398379
399380instance (Monad parse, Applicative check) => Braided (Encoder check parse) Either where
400− braid = viewEncoder (iso swap swap)
381+ braid = isoEncoder (iso swap swap)
401382
402383
403384
@@ -451,17 +432,17 @@ instance (Applicative check, Monad parse) => Monoidal (Encoder check parse) (,)
451432--------------------------------------------------------------------------------
452433
453434-- | 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
435+isoEncoder :: (Applicative check, Applicative parse) => Iso' a b -> Encoder check parse a b
436+isoEncoder f = unsafeMkEncoder $ EncoderImpl
456437 { _encoderImpl_encode = view f
457438 , _encoderImpl_decode = pure . view (from f)
458439 }
459440
460441wrappedEncoder :: (Wrapped a, Applicative check, Applicative parse) => Encoder check parse (Unwrapped a) a
461−wrappedEncoder = viewEncoder $ from _Wrapped'
442+wrappedEncoder = isoEncoder $ from _Wrapped'
462443
463444unwrappedEncoder :: (Wrapped a, Applicative check, Applicative parse) => Encoder check parse a (Unwrapped a)
464−unwrappedEncoder = viewEncoder $ _Wrapped'
445+unwrappedEncoder = isoEncoder _Wrapped'
465446
466447maybeToEitherEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Maybe a) (Either () a)
467448maybeToEitherEncoder = unsafeMkEncoder $ EncoderImpl
@@ -486,11 +467,11 @@ maybeEncoder f g = shadowEncoder f g . maybeToEitherEncoder
486467
487468-- | Encode a value by simply applying 'Just'
488469justEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse a (Maybe a)
489−justEncoder = reviewEncoder _Just
470+justEncoder = prismEncoder _Just
490471
491472-- | Encode () to 'Nothing'.
492473nothingEncoder :: (Applicative check, MonadError Text parse) => Encoder check parse () (Maybe a)
493−nothingEncoder = reviewEncoder _Nothing
474+nothingEncoder = prismEncoder _Nothing
494475
495476someConstEncoder :: (Applicative check, Applicative parse) => Encoder check parse (Some (Const a)) a
496477someConstEncoder = unsafeMkEncoder $ EncoderImpl
@@ -555,11 +536,11 @@ pathComponentEncoder f = Encoder $ do
555536 unEncoder (pathComponentEncoderImpl (enum1Encoder (extractPathSegment . f)) f')
556537
557538pathComponentEncoderImpl :: forall check parse p. (Monad check, Monad parse)
558− => Encoder check parse (Some p) (Maybe Text)
539+ => (Encoder check parse (Some p) (Maybe Text))
559540 -> (forall a. p a -> Encoder Identity parse a PageName)
560541 -> Encoder check parse (R p) PageName
561−pathComponentEncoderImpl =
562− chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder)
542+pathComponentEncoderImpl this rest =
543+ chainEncoder (lensEncoder (\(_, b) a -> (a, b)) Prelude.fst consEncoder) this rest
563544
564545--NOTE: Naming convention in this module is to always talk about things in the *encoding* direction, never in the *decoding* direction
565546
@@ -775,11 +756,11 @@ prefixNonemptyTextEncoder p = Encoder $ pure $ EncoderImpl
775756 Just stripped -> pure stripped
776757 }
777758
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
759+unpackTextEncoder :: (Applicative check, Applicative parse) => Encoder check parse Text String
760+unpackTextEncoder = Encoder $ pure $ EncoderImpl
761+ { _encoderImpl_encode = T.unpack
762+ , _encoderImpl_decode = pure . T.pack
763+ }
783764
784765toListMapEncoder :: (Applicative check, Applicative parse, Ord k) => Encoder check parse (Map k v) [(k, v)]
785766toListMapEncoder = Encoder $ pure $ EncoderImpl
@@ -815,7 +796,7 @@ rPrism
815796 :: forall f f'
816797 . (forall a. Prism' (f a) (f' a))
817798 -> Prism' (R f) (R f')
818−rPrism = dSumPrism
799+rPrism p = dSumPrism p
819800
820801dSumPrism'
821802 :: forall f g a
@@ -827,7 +808,7 @@ dSumGEqPrism
827808 :: GEq f
828809 => f a
829810 -> Prism' (DSum f g) (g a)
830−dSumGEqPrism variant = dSumPrism' $ prism' (\Refl -> variant) (geq variant)
811+dSumGEqPrism variant = dSumPrism' $ prism' (\Refl -> variant) (\x -> geq variant x)
831812
832813-- | Given a 'tag :: f a', make a prism for 'R f'. This generalizes the usual
833814-- prisms for a sum type (the ones that 'mkPrisms' would make), just as 'R'
@@ -844,19 +825,12 @@ _R variant = dSumGEqPrism variant . iso runIdentity Identity
844825
845826-- | An encoder that only works on the items available via the prism. An error will be thrown in the parse monad
846827-- 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
828+prismEncoder :: (Applicative check, MonadError Text parse) => Prism' b a -> Encoder check parse a b
829+prismEncoder p = unsafeMkEncoder $ EncoderImpl
830+ { _encoderImpl_encode = (^. re p)
857831 , _encoderImpl_decode = \r -> case r ^? p of
858832 Just a -> pure a
859− Nothing -> throwError "reviewEncoder: value is not present in the prism"
833+ Nothing -> throwError "prismEncoder: value is not present in the prism"
860834 }
861835
862836-- | A URL path and query string, in which trailing slashes don't matter in the path
@@ -994,9 +968,9 @@ obeliskRouteSegment r appRouteSegment = case r of
994968-- be combined with other such segment encoders before 'pathComponentEncoder' turns it into a proper 'Encoder'.
995969resourceRouteSegment :: (MonadError Text check, MonadError Text parse) => ResourceRoute a -> SegmentResult check parse a
996970resourceRouteSegment = \case
997− ResourceRoute_Static -> PathSegment "static" pathOnlyEncoderIgnoringQuery
998− ResourceRoute_Ghcjs -> PathSegment "ghcjs" pathOnlyEncoder
999− ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" jsaddleWarpRouteEncoder
971+ ResourceRoute_Static -> PathSegment "static" $ pathOnlyEncoderIgnoringQuery
972+ ResourceRoute_Ghcjs -> PathSegment "ghcjs" $ pathOnlyEncoder
973+ ResourceRoute_JSaddleWarp -> PathSegment "jsaddle" $ jsaddleWarpRouteEncoder
1000974 ResourceRoute_Version -> PathSegment "version" $ unitEncoder mempty
1001975
1002976data JSaddleWarpRoute :: * -> * where
@@ -1008,7 +982,7 @@ jsaddleWarpRouteEncoder :: (MonadError Text check, MonadError Text parse) => Enc
1008982jsaddleWarpRouteEncoder = pathComponentEncoder $ \case
1009983 JSaddleWarpRoute_JavaScript -> PathSegment "jsaddle.js" $ unitEncoder mempty
1010984 JSaddleWarpRoute_WebSocket -> PathEnd $ unitEncoder mempty
1011− JSaddleWarpRoute_Sync -> PathSegment "sync" pathOnlyEncoder
985+ JSaddleWarpRoute_Sync -> PathSegment "sync" $ pathOnlyEncoder
1012986
1013987instance GShow appRoute => GShow (ObeliskRoute appRoute) where
1014988 gshowsPrec prec = \case
@@ -1039,8 +1013,8 @@ someSumEncoder = Encoder $ pure $ EncoderImpl
10391013
10401014data Void1 :: * -> * where {}
10411015
1042−instance UniverseSome Void1 where
1043− universeSome = []
1016+instance Universe (Some Void1) where
1017+ universe = []
10441018
10451019void1Encoder :: (Applicative check, MonadError Text parse) => Encoder check parse (Some Void1) a
10461020void1Encoder = Encoder $ pure $ EncoderImpl
@@ -1052,6 +1026,17 @@ void1Encoder = Encoder $ pure $ EncoderImpl
10521026instance GShow Void1 where
10531027 gshowsPrec _ = \case {}
10541028
1029+concat <$> mapM deriveRouteComponent
1030+ [ ''ResourceRoute
1031+ , ''JSaddleWarpRoute
1032+ , ''IndexOnlyRoute
1033+ ]
1034+
1035+makePrisms ''ObeliskRoute
1036+makePrisms ''FullRoute
1037+deriveGEq ''Void1
1038+deriveGCompare ''Void1
1039+
10551040-- | Given a backend route and a checked route encoder, render the route (path
10561041-- and query string). See 'checkEncoder' for how to produce a checked encoder.
10571042renderBackendRoute
@@ -1084,11 +1069,11 @@ readShowEncoder :: (MonadError Text parse, Read a, Show a, Applicative check) =>
10841069readShowEncoder = singlePathSegmentEncoder . unsafeTshowEncoder
10851070
10861071integralEncoder :: (MonadError Text parse, Applicative check, Integral a) => Encoder check parse a Integer
1087−integralEncoder = reviewEncoder Numeric.Lens.integral
1072+integralEncoder = prismEncoder (Numeric.Lens.integral)
10881073
10891074pathSegmentEncoder :: (MonadError Text parse, Applicative check, Cons as as a a) =>
10901075 Encoder check parse (a, (as, b)) (as, b)
1091−pathSegmentEncoder = first (reviewEncoder _Cons) . disassociate
1076+pathSegmentEncoder = first (prismEncoder _Cons) . disassociate
10921077
10931078newtype Decoder check parse b a = Decoder { toEncoder :: Encoder check parse a b }
10941079
@@ -1159,7 +1144,7 @@ pathFieldEncoder fieldEncoder = unsafeEncoder $ do
11591144 fieldEncoderPure f = toEncoder (DMap.findWithDefault (error "bad") f fieldEncoderPureMap)
11601145 pure $ EncoderImpl
11611146 { _encoderImpl_encode = \(x, rest) -> execWriter $ do
1162− _ <- traverseWithField (\f x_i -> tell (pure $ encode (fieldEncoderPure f) x_i) $> x_i) x
1147+ _ <- traverseWithField (\f x_i -> tell (pure $ encode (fieldEncoderPure f) x_i) *> pure x_i) x
11631148 tell rest
11641149 , _encoderImpl_decode = State.runStateT $ tabulateFieldsA $ \f -> State.get >>= \case
11651150 [] -> throwError $ T.pack "not enough path components"
@@ -1195,34 +1180,3 @@ byteStringsToPageName p q =
11951180 in decode pageNameEncoder' (T.unpack (T.decodeUtf8 p), T.unpack (T.decodeUtf8 q))
11961181
11971182--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−
1219−concat <$> mapM deriveRouteComponent
1220− [ ''ResourceRoute
1221− , ''JSaddleWarpRoute
1222− , ''IndexOnlyRoute
1223− ]
1224−
1225−makePrisms ''ObeliskRoute
1226−makePrisms ''FullRoute
1227−deriveGEq ''Void1
1228−deriveGCompare ''Void1
lib/route/src/Obelisk/Route/Frontend.hs+28−41
@@ -1,24 +1,24 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE ApplicativeDo #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE RecursiveDo #-}
4+{-# LANGUAGE StandaloneDeriving #-}
35{-# LANGUAGE ConstraintKinds #-}
4−{-# LANGUAGE DataKinds #-}
56{-# LANGUAGE DefaultSignatures #-}
67{-# LANGUAGE FlexibleContexts #-}
78{-# LANGUAGE FlexibleInstances #-}
8−{-# LANGUAGE FunctionalDependencies #-}
99{-# LANGUAGE GADTs #-}
10−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
1110{-# LANGUAGE LambdaCase #-}
1211{-# LANGUAGE OverloadedStrings #-}
1312{-# LANGUAGE PatternSynonyms #-}
1413{-# LANGUAGE RankNTypes #-}
15−{-# LANGUAGE RecursiveDo #-}
1614{-# LANGUAGE ScopedTypeVariables #-}
17−{-# LANGUAGE StandaloneDeriving #-}
1815{-# LANGUAGE TypeFamilies #-}
1916{-# LANGUAGE TypeOperators #-}
20−{-# LANGUAGE UndecidableInstances #-}
2117{-# LANGUAGE ViewPatterns #-}
18+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
19+{-# LANGUAGE UndecidableInstances #-}
20+{-# LANGUAGE DataKinds #-}
21+{-# LANGUAGE FunctionalDependencies #-}
2222
2323module Obelisk.Route.Frontend
2424 ( module Obelisk.Route
@@ -57,42 +57,49 @@ module Obelisk.Route.Frontend
5757
5858import Prelude hiding ((.), id)
5959
60+import Obelisk.Route
61+
6062import Control.Category (Category (..), (.))
6163import Control.Category.Cartesian ((&&&))
6264import Control.Lens hiding (Bifunctor, bimap, universe, element)
6365import Control.Monad ((<=<))
6466import Control.Monad.Fix
65−import Control.Monad.Morph
6667import Control.Monad.Primitive
6768import Control.Monad.Reader
6869import Control.Monad.Ref
6970import Control.Monad.Trans.Control
7071import Data.Coerce
7172import Data.Dependent.Sum (DSum (..))
72−import Data.Functor.Compose
73−import Data.Functor.Misc
7473import Data.GADT.Compare
75−import qualified Data.List as L
7674import Data.Map (Map)
77−import Data.Maybe (fromMaybe)
7875import Data.Monoid
7976import Data.Proxy
8077import Data.Text (Text)
8178import qualified Data.Text as T
79+import Data.Functor.Compose
80+import Data.Functor.Misc
81+import Reflex.Class
82+import Reflex.Host.Class
83+import Reflex.PostBuild.Class
84+import Reflex.TriggerEvent.Class
85+import Reflex.PerformEvent.Class
86+import Reflex.EventWriter.Class
87+import Reflex.EventWriter.Base
88+import Reflex.Dynamic
89+import Reflex.Dom.Builder.Class
8290import Data.Type.Coercion
91+import Language.Javascript.JSaddle --TODO: Get rid of this - other platforms can also be routed
92+import Reflex.Dom.Core
8393import qualified GHCJS.DOM as DOM
8494import qualified GHCJS.DOM.Types as DOM
8595import 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
8796import Network.URI
88−import Reflex.Class
89−import Reflex.Dom.Builder.Class
90−import Reflex.Dom.Core
91−import Reflex.Host.Class
97+import Data.Maybe (fromMaybe)
98+import qualified Data.List as L
99+
92100import Unsafe.Coerce
93101
94102import Obelisk.Configs
95−import Obelisk.Route
96103
97104infixr 5 :~
98105pattern (:~) :: Reflex t => f a -> Dynamic t a -> DSum f (Compose (Dynamic t) Identity)
@@ -109,23 +116,7 @@ instance Monad m => Routed t r (RoutedT t r m) where
109116instance (Monad m, Routed t r m) => Routed t r (ReaderT r' m)
110117
111118newtype 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− )
119+ deriving (Functor, Applicative, Monad, MonadFix, MonadTrans, NotReady t, MonadHold t, MonadSample t, PostBuild t, TriggerEvent t, MonadIO, MonadReflexCreateTrigger t, HasDocument, DomRenderHook t)
129120
130121instance MonadReader r' m => MonadReader r' (RoutedT t r m) where
131122 ask = lift ask
@@ -201,10 +192,6 @@ instance (Monad m, RouteToUrl r m) => RouteToUrl r (EventWriterT t w m)
201192
202193instance (Monad m, SetRoute t r m) => SetRoute t r (EventWriterT t w m)
203194
204−instance (Monad m, RouteToUrl r m) => RouteToUrl r (DynamicWriterT t w m)
205−
206−instance (Monad m, SetRoute t r m) => SetRoute t r (DynamicWriterT t w m)
207−
208195runRoutedT :: RoutedT t r m a -> Dynamic t r -> m a
209196runRoutedT = runReaderT . unRoutedT
210197
@@ -269,7 +256,7 @@ dynamicIdentityCoercion = unsafeCoerce (Coercion :: Coercion (Identity ()) ()) -
269256factorRouted :: (Reflex t, MonadFix m, MonadHold t m, GEq f) => RoutedT t (DSum f (Dynamic t)) m a -> RoutedT t (DSum f Identity) m a
270257factorRouted r = RoutedT $ ReaderT $ \d -> do
271258 d' <- factorDyn d
272− runRoutedT r $ coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d'
259+ runRoutedT r $ (coerceWith (dynamicCoercion $ dsumValueCoercion dynamicIdentityCoercion) d')
273260
274261maybeRouted :: (Reflex t, MonadFix m, MonadHold t m) => RoutedT t (Maybe (Dynamic t a)) m b -> RoutedT t (Maybe a) m b
275262maybeRouted r = RoutedT $ ReaderT $ \d -> do
@@ -477,7 +464,7 @@ runRouteViewT
477464 , MonadJSM (Performable m)
478465 , MonadFix m
479466 )
480− => Encoder Identity Identity r PageName
467+ => (Encoder Identity Identity r PageName)
481468 --TODO: Get rid of the switchover and useHash arguments
482469 -- useHash can probably be baked into the encoder
483470 -> Event t () -- ^ Switchover event, nothing is done until this event fires. Used to prevent incorrect DOM expectations at hydration switchover time
lib/run/obelisk-run.cabal+2−2
@@ -33,7 +33,7 @@ library
3333 , process
3434 , ref-tf
3535 , reflex
36− , reflex-dom-core
36+ , reflex-dom
3737 , snap-core
3838 , streaming-commons
3939 , text
@@ -47,7 +47,7 @@ library
4747 , websockets
4848 exposed-modules:
4949 Obelisk.Run
50− ghc-options: -Wall -Werror -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O
50+ ghc-options: -Wall -fwarn-redundant-constraints
5151 if os(linux)
5252 cpp-options: -DIPROUTE_SUPPORTED
5353 build-depends: which
lib/run/src/Obelisk/Run.hs+3−3
@@ -144,9 +144,9 @@ runWidget conf configs frontend validFullEncoder = do
144144
145145 cert <- X509.newX509 >>= X509Request.makeX509FromReq certRequest
146146 _ <- X509.setPublicKey cert privateKey
147− timenow <- getCurrentTime
148− _ <- X509.setNotBefore cert $ addUTCTime (-1) timenow
149− _ <- X509.setNotAfter cert $ addUTCTime (365 * 24 * 60 * 60) timenow
147+ now <- getCurrentTime
148+ _ <- X509.setNotBefore cert $ addUTCTime (-1) now
149+ _ <- X509.setNotAfter cert $ addUTCTime (365 * 24 * 60 * 60) now
150150 _ <- X509.signX509 cert privateKey Nothing
151151
152152 certByteString <- BSUTF8.fromString <$> PEM.writeX509 cert
lib/selftest/obelisk-selftest.cabal−2
@@ -9,8 +9,6 @@ library
99 hs-source-dirs: src
1010 build-depends:
1111 base
12− , bytestring
13− , aeson
1412 , containers
1513 , directory
1614 , filepath
lib/selftest/src/Obelisk/SelfTest.hs+26−194
@@ -4,7 +4,7 @@
44{-# LANGUAGE OverloadedStrings #-}
55{-# LANGUAGE PatternGuards #-}
66{-# LANGUAGE ScopedTypeVariables #-}
7−{-# LANGUAGE TemplateHaskell #-}
7+{-# LANGUAGE TemplateHaskell #-}
88{-# LANGUAGE TypeApplications #-}
99{-# LANGUAGE ViewPatterns #-}
1010module Obelisk.SelfTest where
@@ -13,20 +13,13 @@ import Control.Concurrent (threadDelay)
1313import Control.Exception (bracket, throw, try)
1414import Control.Monad
1515import Control.Monad.IO.Class
16−import qualified Data.Aeson as Aeson
17−import qualified Data.Aeson.Types as Aeson
1816import Data.Bool (bool)
19−import qualified Data.ByteString.Lazy as LBS
20−import Data.Foldable (for_)
2117import Data.Function (fix)
22−import Data.List (isInfixOf)
23−import qualified Data.Map as Map
2418import Data.Semigroup ((<>))
2519import qualified Data.Set as Set
2620import Data.String
2721import Data.Text (Text)
2822import qualified Data.Text as T
29−import qualified Data.Text.Encoding as T
3023import qualified Data.Text.IO as T
3124import qualified Network.HTTP.Client as HTTP
3225import qualified Network.HTTP.Types as HTTP
@@ -71,15 +64,9 @@ chmodPath = $(staticWhich "chmod")
7164whoamiPath :: FilePath
7265whoamiPath = $(staticWhich "whoami")
7366
74−nixInstantiatePath :: FilePath
75−nixInstantiatePath = $(staticWhich "nix-instantiate")
76−
7767nixBuildPath :: FilePath
7868nixBuildPath = $(staticWhich "nix-build")
7969
80−nixPrefetchGitPath :: FilePath
81−nixPrefetchGitPath = $(staticWhich "nix-prefetch-git")
82−
8370lnPath :: FilePath
8471lnPath = $(staticWhich "ln")
8572
@@ -116,17 +103,6 @@ ob = "ob"
116103augmentWithVerbosity :: (String -> [Text] -> a) -> String -> Bool -> [Text] -> a
117104augmentWithVerbosity runner executable isVerbose args = runner executable $ (if isVerbose then ("-v" :) else id) args
118105
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−
130106-- | Copies a git repo to a new location and "resets" the git history to include
131107-- exactly one commit with all files added. It then restricts writing and reading
132108-- for group and user to make the repo ideal for being a valid git remote for thunks.
@@ -134,14 +110,21 @@ isolatedGitShell isVerbose dir f = shelly $ bool silently verbosely isVerbose $
134110-- Using this allows dirty repos to be used as git remotes during the test since 'git clone'ing
135111-- a dirty repo will not include the uncommitted changes.
136112copyForGitRemote :: Bool -> FilePath -> FilePath -> IO ()
137−copyForGitRemote isVerbose origDir copyDir = isolatedGitShell isVerbose copyDir $ \git -> do
113+copyForGitRemote isVerbose origDir copyDir = shelly $ bool silently verbosely isVerbose $ do
114+ setenv "HOME" "/dev/null"
115+ setenv "GIT_CONFIG_NOSYSTEM" "1"
138116 run_ rsyncPath
139117 [ "-r", "--no-perms", "--no-owner", "--no-group", "--exclude", ".git"
140118 , toTextIgnore (addTrailingPathSeparator origDir), toTextIgnore copyDir
141119 ]
142− _ <- git ["add", "--all"]
143− _ <- git ["commit", "-m", "Copy repo"]
120+ git ["init"]
121+ git ["config", "user.name", "SelfTest"]
122+ git ["config", "user.email", "self@test"]
123+ git ["add", "--all"]
124+ git ["commit", "-m", "Copy repo"]
144125 run_ chmodPath ["-R", "u-w,g-rw,o-rw", toTextIgnore copyDir] -- Freeze this state
126+ where
127+ git args = run_ gitPath $ ["-C", toTextIgnore copyDir] <> args
145128
146129main :: IO ()
147130main = do
@@ -195,33 +178,12 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->
195178 configs <- getConfigs
196179 return (either (const Nothing) Just $ getConfigRoute configs) `shouldNotReturn` Nothing
197180
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−
203181 -- These tests fail with "Could not find module 'Obelisk.Generated.Static'"
204182 -- when not run by 'nix-build --attr selftest'
205183 describe "ob run" $ {- NOT parallel $ -} do
206184 it "works in root directory" $ inTmpObInit $ \_ -> testObRunInDir' Nothing httpManager
207185 it "works in sub directory" $ inTmpObInit $ \_ -> testObRunInDir' (Just "frontend") httpManager
208186
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−
225187 describe "obelisk project" $ parallel $ do
226188 it "can build obelisk command" $ inTmpObInit $ \_ -> nixBuild ["-A", "command" , toTextIgnore obeliskRepoReadOnly]
227189 it "can build obelisk skeleton" $ inTmpObInit $ \_ -> nixBuild ["-A", "skeleton", toTextIgnore obeliskRepoReadOnly]
@@ -260,8 +222,6 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->
260222 uu <- update
261223 assertRevEQ u uu
262224
263− it "can run 'ob doc'" $ inTmpObInit $ \_ -> runOb_ ["doc", "reflex"]
264−
265225 describe "ob thunk pack/unpack" $ parallel $ do
266226 it "has thunk pack and unpack inverses" $ inTmpObInitWithImplCopy $ \_ -> do
267227
@@ -281,7 +241,7 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->
281241 run_ gitPath ["clone", "https://github.com/reflex-frp/reflex.git", toTextIgnore dir, "--branch", branch]
282242 runOb_ ["thunk", "pack", toTextIgnore dir]
283243 runOb_ ["thunk", "unpack", toTextIgnore dir]
284− branch' <- run gitPath ["-C", toTextIgnore $ dir </> unpackedDirName, "rev-parse", "--abbrev-ref", "HEAD"]
244+ branch' <- chdir dir $ run gitPath ["rev-parse", "--abbrev-ref", "HEAD"]
285245 liftIO $ assertEqual "" branch (T.strip branch')
286246
287247 it "can pack and unpack plain git repos" $
@@ -293,10 +253,10 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->
293253 runOb_ ["thunk", "pack", repo]
294254 packedFiles <- Set.fromList <$> ls (fromText repo)
295255 liftIO $ assertEqual "" packedFiles $ Set.fromList $ (repo </>) <$>
296− ["default.nix", "thunk.nix", "github.json" :: FilePath]
256+ ["default.nix", "github.json", ".attr-cache" :: FilePath]
297257
298258 runOb_ ["thunk", "unpack", repo]
299− chdir (fromText repo </> unpackedDirName) $ do
259+ chdir (fromText repo) $ do
300260 unpackHash <- revParseHead
301261 assertRevEQ origHash unpackHash
302262
@@ -305,8 +265,6 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->
305265 it "aborts thunk pack when there are uncommitted files" $ inTmpObInitWithImplCopy $ \dir -> do
306266 testThunkPack' (dir </> thunk)
307267
308− it "works on legacy git thunks" $ testLegacyGitThunks isVerbose
309−
310268 describe "ob thunk update --branch" $ parallel $ do
311269 it "can change a thunk to the latest version of a desired branch" $ withTmp $ \dir -> do
312270 let branch1 = "master"
@@ -323,11 +281,6 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->
323281 void $ errExit False $ runOb ["thunk", "update", toTextIgnore dir, "--branch", "dumble-palooza"]
324282 checkDir dir >>= liftIO . assertEqual "" startingContents
325283
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−
331284 describe "ob hoogle" $ {- NOT parallel -} do
332285 it "starts a hoogle server on the given port" $ inTmpObInit $ \_ -> do
333286 [p0] <- liftIO $ getFreePorts 1
@@ -356,7 +309,7 @@ main' isVerbose httpManager obeliskRepoReadOnly = withInitCache $ \initCache ->
356309
357310 withObeliskImplClean f =
358311 withSystemTempDirectory "obelisk-impl-clean" $ \obeliskImpl -> do
359− void . shellyOb verbosity $ do
312+ void . shellyOb verbosity $ chdir obeliskImpl $ do
360313 dirtyFiles <- T.strip <$> run gitPath ["-C", toTextIgnore obeliskRepoReadOnly, "diff", "--stat"]
361314 () <- when (dirtyFiles /= "") $ error "SelfTest does not work correctly with dirty obelisk repos as remote"
362315 run_ gitPath ["clone", "file://" <> toTextIgnore obeliskRepoReadOnly, toTextIgnore obeliskImpl]
@@ -421,31 +374,28 @@ testObRunInDir executable extraArgs mdir httpManager = maskExitSuccess $ do
421374 else exit 0
422375
423376testThunkPack :: 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
377+testThunkPack executable args path' = withTempFile (T.unpack $ toTextIgnore path') "test-file" $ \file handle -> do
378+ let pack' = readProcessWithExitCode executable (T.unpack <$> ["thunk", "pack", toTextIgnore path'] ++ args) ""
379+ ensureThunkPackFails q = liftIO $ pack' >>= \case
380+ (code, out, err)
381+ | code == ExitSuccess -> fail $ "ob thunk pack succeeded when it should have failed with error '" <> show q <> "'"
382+ | q `T.isInfixOf` T.pack (out <> err) -> pure ()
383+ | otherwise -> fail $ "ob thunk pack failed for an unexpected reason, expecting '" <> show q <> "', received: " <> show out <> "\nstderr: " <> err
384+ git = chdir path' . run gitPath
433385 -- Untracked files
434386 ensureThunkPackFails "Untracked files"
435− git ["add", T.pack file]
387+ void $ git ["add", T.pack file]
436388 -- Uncommitted files (staged)
437389 ensureThunkPackFails "unsaved"
438− chdir repoDir $ commit "test commit"
390+ chdir path' $ commit "test commit"
439391 -- Non-pushed commits in any branch
440392 ensureThunkPackFails "not yet pushed"
441393 -- Uncommitted files (unstaged)
442394 liftIO $ T.hPutStrLn handle "test file" >> hClose handle
443395 ensureThunkPackFails "modified"
444396 -- Existing stashes
445− git $ gitUserConfig <> [ "stash" ]
397+ void $ git $ gitUserConfig <> [ "stash" ]
446398 ensureThunkPackFails "has stashes"
447− where
448− repoDir = path' </> unpackedDirName
449399
450400-- | Blocks until a non-empty line is available
451401hGetLineSkipBlanks :: MonadIO m => Handle -> m Text
@@ -506,121 +456,3 @@ getFreePorts n = Socket.withSocketsDo $ do
506456 sock <- Socket.socket (Socket.addrFamily addr) (Socket.addrSocketType addr) (Socket.addrProtocol addr)
507457 Socket.bind sock (Socket.addrAddress addr)
508458 pure sock
509−
510−testLegacyGitThunks :: Bool -> IO ()
511−testLegacyGitThunks isVerbose = withSystemTempDirectory "test-git-repo" $ \gitDir -> do
512− isolatedGitShell isVerbose gitDir $ \git -> do
513− writefile (gitDir </> ("default.nix" :: FilePath)) "{}: \"hello\""
514− _ <- git ["add", "--all"]
515− _ <- git ["commit", "-m", "Initial commit"]
516− rev <- T.strip <$> git ["rev-parse", "HEAD"]
517− sha256 :: Text
518− <- either error pure
519− =<< (Aeson.parseEither (Aeson..: "sha256") <=< Aeson.eitherDecodeStrict . T.encodeUtf8)
520− <$> run nixPrefetchGitPath [toTextIgnore gitDir]
521−
522− for_ (legacyGitThunks (GitThunkParams gitDir rev sha256)) $ \mkFiles ->
523− withSystemTempDirectory "test-thunks" $ \thunkDir -> do
524− liftIO $ mkFiles thunkDir
525− run_ "ob" ["thunk", "unpack", toTextIgnore thunkDir]
526− run_ "ob" ["thunk", "pack", toTextIgnore thunkDir]
527−
528−data GitThunkParams = GitThunkParams
529− { _gitThunkParams_repo :: !FilePath
530− , _gitThunkParams_rev :: !Text
531− , _gitThunkParams_sha256 :: !Text
532− } deriving Show
533−
534−legacyGitThunks :: GitThunkParams -> [FilePath -> IO ()]
535−legacyGitThunks (GitThunkParams repo' rev sha256) =
536− [ mkLegacyIO
537− (T.unlines
538− [ "# DO NOT HAND-EDIT THIS FILE"
539− , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
540− , " assert !fetchSubmodules; (import <nixpkgs> {}).fetchgit { inherit url rev sha256; };"
541− , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
542− ]
543− )
544− (Map.fromList
545− [ ("url", repo)
546− , ("rev", rev)
547− , ("branch", "master")
548− , ("sha256", sha256)
549− ]
550− )
551− , mkLegacyIO
552− (T.unlines
553− [ "# DO NOT HAND-EDIT THIS FILE"
554− , "let fetchGit = {url, rev, ref ? null, branch ? null, sha256 ? null, fetchSubmodules ? null}:"
555− , " if builtins.hasAttr \"fetchGit\" builtins"
556− , " then builtins.fetchGit ({ inherit url rev; } // (if branch == null then {} else { ref = branch; }))"
557− , " else abort \"Plain Git repositories are only supported on nix 2.0 or higher.\";"
558− , "in import (fetchGit (builtins.fromJSON (builtins.readFile ./git.json)))"
559− ]
560− )
561− (Map.fromList
562− [ ("url", repo)
563− , ("rev", rev)
564− , ("branch", "master")
565− , ("sha256", sha256)
566− ]
567− )
568− , mkLegacyIO
569− (T.unlines
570− [ "# DO NOT HAND-EDIT THIS FILE"
571− , "let fetch = {url, rev, ref ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
572− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
573− , " if firstChar == \"/\" then /. + url"
574− , " else if firstChar == \".\" then ./. + url"
575− , " else url;"
576− , " in if !fetchSubmodules && private then builtins.fetchGit {"
577− , " url = realUrl; inherit rev;"
578− , " } else (import <nixpkgs> {}).fetchgit {"
579− , " url = realUrl; inherit rev sha256;"
580− , " };"
581− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
582− ]
583− )
584− (Map.fromList
585− [ ("url", Aeson.String repo)
586− , ("rev", Aeson.String rev)
587− , ("branch", Aeson.String "master")
588− , ("sha256", Aeson.String sha256)
589− , ("private", Aeson.Bool False)
590− ]
591− )
592− , mkLegacyIO
593− (T.unlines
594− [ "# DO NOT HAND-EDIT THIS FILE"
595− , "let fetch = {url, rev, branch ? null, sha256 ? null, fetchSubmodules ? false, private ? false, ...}:"
596− , " let realUrl = let firstChar = builtins.substring 0 1 url; in"
597− , " if firstChar == \"/\" then /. + url"
598− , " else if firstChar == \".\" then ./. + url"
599− , " else url;"
600− , " in if !fetchSubmodules && private then builtins.fetchGit {"
601− , " url = realUrl; inherit rev;"
602− , " ${if branch == null then null else \"ref\"} = branch;"
603− , " } else (import <nixpkgs> {}).fetchgit {"
604− , " url = realUrl; inherit rev sha256;"
605− , " };"
606− , "in import (fetch (builtins.fromJSON (builtins.readFile ./git.json)))"
607− ]
608− )
609− (Map.fromList
610− [ ("url", Aeson.String repo)
611− , ("rev", Aeson.String rev)
612− , ("branch", Aeson.String "master")
613− , ("sha256", Aeson.String sha256)
614− , ("private", Aeson.Bool False)
615− ]
616− )
617− ]
618− where
619− repo = T.pack repo'
620− mkLegacyIO :: Aeson.ToJSON v => Text -> Map.Map Text v -> FilePath -> IO ()
621− mkLegacyIO defaultNix gitJson dir = do
622− T.writeFile (dir </> ("default.nix" :: FilePath)) defaultNix
623− LBS.writeFile (dir </> ("git.json" :: FilePath)) (Aeson.encode gitJson)
624−
625−unpackedDirName :: FilePath
626−unpackedDirName = "."
lib/snap-extras/obelisk-snap-extras.cabal+2−1
@@ -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+1−1
@@ -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
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−}
scripts/ghcid-this-libnew file+4
@@ -0,0 +1,4 @@
1+#!/usr/bin/env bash
2+set -euo pipefail
3+
4+nix-shell -E "with (import ../.. {}); reflex-platform.workOn haskellPackageSets.ghc haskellPackageSets.ghc.obelisk-$(basename $PWD)" --run "ghcid -c 'cabal new-repl'"
skeleton/.gitignore+6−12
@@ -1,15 +1,9 @@
1+dist-newstyle
2+result
3+result-*
4+result-android
5+result-ios
6+result-exe
17.attr-cache
2−.cabal-sandbox
3−*.hi
4−*.o
5−cabal.project.local
6−cabal.sandbox.config
7−ctags
8−dist-newstyle/
9−dist/
108ghcid-output.txt
119profile/
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/cabal.project−1
@@ -1,3 +1,2 @@
11optional-packages:
22 *
3−write-ghc-environment-files: never
skeleton/common/common.cabal−1
@@ -12,4 +12,3 @@ library
1212 exposed-modules:
1313 Common.Api
1414 Common.Route
15− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits
skeleton/default.nix+3−10
@@ -1,17 +1,10 @@
1−{ system ? builtins.currentSystem
2−, obelisk ? import ./.obelisk/impl {
3− inherit system;
4− iosSdkVersion = "13.2";
5−
1+{ obelisk ? import ./.obelisk/impl {
2+ system = builtins.currentSystem;
3+ iosSdkVersion = "10.2";
64 # You must accept the Android Software Development Kit License Agreement at
75 # https://developer.android.com/studio/terms in order to build Android apps.
86 # Uncomment and set this to `true` to indicate your acceptance:
97 # 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;
158 }
169}:
1710with obelisk;
skeleton/frontend/frontend.cabal+4−6
@@ -16,7 +16,7 @@ library
1616 , text
1717 exposed-modules:
1818 Frontend
19− ghc-options: -Wall -Wredundant-constraints -Wincomplete-uni-patterns -Wincomplete-record-updates -O -fno-show-valid-hole-fits
19+ ghc-options: -Wall
2020
2121executable frontend
2222 main-is: main.hs
@@ -28,9 +28,7 @@ executable frontend
2828 , reflex-dom
2929 , obelisk-generated-static
3030 , 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
31+ --TODO: Make these ghc-options optional
32+ ghc-options: -threaded
3533 if os(darwin)
36− ghc-options: -dynamic
34+ ghc-options: -dynamic
skeleton/shell.nixnew file+1
@@ -0,0 +1 @@
1+(import ./. {}).shells.ghc