Reloaded components à la carte
Clojure Shell
Latest commit 246bc21 Feb 16, 2017 @danielsz identation fix
Permalink
Failed to load latest commit information.
examples 0.4.0 Jan 29, 2017
script postgres test instructions Aug 15, 2015
src/system Docstring core async pubsub Feb 17, 2017
test/system identation fix Feb 17, 2017
.gitignore refinements Mar 28, 2016
.gitmodules System-websockets May 14, 2016
CHANGELOG.org Core.async Pubsub Feb 17, 2017
README.org Core.async Pubsub Feb 17, 2017
project.clj Docstring core async pubsub Feb 17, 2017

README.org

system

What is it?

system owes to component both in spirit and in name. The component library helps implement the reloaded pattern as championed by Stuart Sierra. system is built on top of it, offering a set of readymade components. The idea is to expand the set over time with contributions from the community. It currently includes:

Motivation

A good REPL experience is a prerogative of Lisp languages. Reloaded components enable this goodness in Clojureland. Since they require an amount of setup, the first steps when starting a new project are generally devoted to infrastructure. My first attempt to tackle the boilerplate was a Leiningen template. The problem is that Leiningen templates are hard to maintain and difficult to retrofit on existing projects. I was finding myself repeatedly updating the template for future use. Then it dawned on me that a library would better fit the bill. And so system came to light. It’s now the first dependency I add to any project, allowing me to focus from the get-go on the substance of my application.

Is it good?

Yes.

Installation

Add the following to your project’s dependencies.

http://clojars.org/org.danielsz/system/latest-version.svg

ProTip: Snapshot versions may be available.

Attention: 0.3.0-SNAPSHOT is a breaking release. reloaded.repl is now system.repl. Please refer to the changelog to see all changes.

Examples

Example projects are available under the examples folder.

Get-started projects

Two minimal projects that will help you get started. Both the Leiningen and Boot toolchain are covered.

Real-world web service

A web service written multiple times using different styles.

Websockets

A web application with client-side UI. Demonstrates login procedure with Sente (a realtime web comms library).

Usage

First, assemble your system(s) in a namespace of your choosing. Here we define two systems, development and production.

(ns my-app.systems
  (:require
   [com.stuartsierra.component :as component]
   (system.components
    [jetty :refer [new-web-server]]
    [repl-server :refer [new-repl-server]]
    [datomic :refer [new-datomic-db]]
    [mongo :refer [new-mongo-db]])
   [my-app.webapp :refer [handler]]
   [environ.core :refer [env]]))

(defn dev-system []
  (component/system-map
   :datomic-db (new-datomic-db (env :db-url))
   :mongo-db (new-mongo-db)
   :web (new-web-server (env :http-port) handler)))

(defn prod-system []
  "Assembles and returns components for an application in production"
  []
    (component/system-map
     :datomic-db (new-datomic-db (env :db-url))
     :mongo-db (new-mongo-db (env :mongo-url))
     :web (new-web-server (env :http-port) handler)
     :repl-server (new-repl-server (env :repl-port))))

Then, in user.clj:

(ns user
  (:require [system.repl :refer [system set-init! start stop reset]]
            [my-app.systems :refer [dev-system]]))

(set-init! #'dev-system)

You can now manipulate the system in the REPL: (start), (reset) or (stop). The system map is accessible at any time, it resides in a var named, as you can guess, #'system.

In production, in core.clj:

(ns my-app.core
  (:gen-class)
  (:require [my-app.systems :refer [prod-system]]))

(defn -main
  "Start the application"
  []
  (alter-var-root #'prod-system component/start)

Or, if you want to keep a handler on your system in production:

(ns my-app.core
  (:gen-class)
  (:require [system.repl :refer [set-init! start]]
            [my-app.systems :refer [prod-system]]))

(defn -main
  "Start the application"
  []
  (set-init! #'prod-system)
  (start))

defsystem

A convenience macro, defsystem, allows you to declare systems succinctly:

(ns my-app.systems
  (:require
   [system.core :refer [defsystem]]
   (system.components
    [jetty :refer [new-web-server]]
    [repl-server :refer [new-repl-server]]
    [datomic :refer [new-datomic-db]]
    [mongo :refer [new-mongo-db]])
   [my-app.webapp :refer [handler]]
   [environ.core :refer [env]]))

(defsystem dev-system
  [:datomic-db (new-datomic-db (env :db-url))
   :mongo-db (new-mongo-db)
   :web (new-web-server (env :http-port) handler)])

(defsystem prod-system
  [:datomic-db (new-datomic-db (env :db-url))
   :mongo-db (new-mongo-db (env :mongo-url))
   :web (new-web-server (env :http-port) handler)
   :repl-server (new-repl-server (env :repl-port))])

Note: Component allows you to define dependency relationships within systems. Please don’t use said macro for those cases. Be sure to consult component’s API to see the range of options available to you.

At runtime: global system map vs dependency injection

At runtime, the system var can be used anywhere after requiring it from the system.repl namespace:

(ns front-end.webapp.handler
 (:require [system.repl :refer [system]]))

(code-using system ...)

Note this pattern of directly accessing the global system var is in contrast with the pattern of dependency injection integral to Stuart Sierra’s vision of Component. In this perspective, components are defined in terms of the components on which they depend. system, as a repository of readymade, reusable components, cannot and does not anticipate all the possible ways in which users will want to assemble components together. What it can and does, however, is anticipate common scenarii. Like your typical Ring application, for example, where you may want to inject the database in the routes, so that it is readily available when serving http requests.

Starting with version 0.3.0, system provides components inspired from the Duct framework: the endpoint, middleware and handler components. The endpoint component returns routes that are closed over by the component passed to it, so that its constituents are accessible via standard map destructuring. The rationale for this is explained here. If the previous sentence didn’t sound agreeable, I suggest you check out the examples where we demonstrate usage with a single endpoint as well as multiple endpoints.

The ability to decompose a web application in mulitple endpoints offers flexibility and opportunies of reuse. For example, you can isolate functionality in library projects, and join the endpoints in the target application’s unified handler. The possibilities are numerous.

Documentation for the Duct namepaces is available.

As with many patterns, DI can be abused. It is easy to get carried away with dependency injection and build a towering dependency graph that is unnecessary and even counter-productive. — Ben Morris in How not to use dependency injection: service locators and injection mania.

Whatever you do, use your best judgment.

Boot-system

System and Boot are a match made in heaven. Some of the properties that boot-system brings to your workflow are:

  • Manual and automatic mode, ie. either you manipulate the system in the REPL, or you configure it to react to editing changes.
  • Restartable system. What warrants a system restart is user-configurable. File-based granularity.
  • Changes that do not require a restart are available in the running system instantly (via namespace reloading).
  • Full Lisp-style interactive programming via the REPL and hot-reloading in the browser.

The system task is invoked like any boot task.

$ boot system -h

Which outputs, for example:

-h, --help         Print this help info.
-s, --sys SYS      Set the system var to SYS.
-a, --auto         Manages the lifecycle of the application automatically.
-f, --files FILES  Will reset the system if a filename in the supplied vector changes.
-r, --regexes      Treat --files as regexes, not file names. Only one of regexes|paths is allowed.
-p, --paths        Treat --files as classpath paths, not file names. Only one of regexes|paths is allowed.

When auto is set to true, reloading of namespaces and restarts are being managed automatically.

If you set auto to false, you indicate that you want to handle restarts manually at the REPL, with (system.repl/reset). Please note that SYS will be initialized and started for you at first run.

If you don’t supply a SYS argument, the system task will act as a tools.namespace wrapper. Each time you save your file, affected namespaces are reloaded in dependency order (after being unloaded in reverse order). This is handy for projects that do not use Component, like this example project.

Code reload vs system restart

In traditional Lisp systems, users can redefine arbitrary, discrete units of code. Clojure, as a Lisp, is no exception. However, as a hosted language with many advanced dynamic features, code reloading has many pitfalls. tools.namespace fixes many of them, but ultimately, reloaded code will not agree with runtime state, and the system will need a full restart. This is where component fits in. (Note that both libraries were authored by Stuart Sierra).

It is important to understand that code reloading and system restarts are orthogonal—both are desirable properties in a programming environment. A full restart is a blunt tool. No need to restart the database just because a helper function was modified.

We don’t want to restart the system with every code change. Ideally, we want to only reload the code that has changed, and occasionally restart (when necessary).

boot-system gives you finegrained tuning over system restarts vs code reload. Each time you change a file, boot-system will reload your code. Conversely, filenames that have been designated in the files option will trigger a full restart. Typically, the files vector will be small, as most modifications do not warrant a full restart. An example of when you would want a full restart is when you modify a Var that is used in a thread (that of a web server, for example). This is explained in detail in the Ghosts in the machine blog post. Check the options with boot system -h.

In summary, when you instruct boot-system to manage your application lifecycle (with the auto option), either one of those two things will happen after you change a source file:

  • refresh will first unload all affected namespaces (to remove old definitions) before reloading them in dependency order.
  • reset will restart the system if that file was defined in the files vector.

The Holy Grail

With system, you can enjoy a true Lisp environment where code is always live (live coding). A tutorial is available in a separate repository.

Leiningen

If you are using Leiningen, we recommend Figwheel to address browser-side hot-reloading concerns.

Monitoring

A monitoring protocol is available to query the status of components. Two methods are available, started? and stopped?, whose concrete implementations depend on the native APIs of the service behind the component.

The Reloaded pattern

Here are a couple of links that are sure to shed more light on the motivations of the reloaded workflow.

The canonical reference:

My Clojure Workflow, Reloaded

Interactive programming

I gave a talk at several Clojure user groups (Belgium, Spain, Israel). BeClojure did a great job at recording it and making it available on Youtube. Mattias Buelens also produced a very nice interactive UI for the BeClojure talk.

Interactive programming

Additional references

And more references touching on the topic.

Compatibility

There is a host of components libraries in the Clojure ecosystem, each with its own take, its own philosophy. For example:

Navigating this space can be difficult or overwhelming. Due to the nature of Open Source Software, it is unlikely to see any kind of standardization taking place. Let’s embrace the diversity instead, and emphasize the compatibility of components. As long as a component adheres to Stuart Sierra’s Lifecycle protocol, you can import it in your systems namespace and refer to it as any other native system component.

Choosing

To help choose if system is right for you, here are a couple of tips. Take a component for an often used dependency (a web server, for example, or a database), and compare their source code. The system library puts an emphasis on two properties:

  • minimalism: system provides a way to instantiate components that fulfill the Licecycle protocol (start and stop). Nothing more, nothing less.
  • Interactive programming: system is best used in a Lispy, interactive workflow, hence its deep integration with boot.

Contributing

Please fork and issue a pull request to add more components. Please don’t forget to include tests. You can refer to the existing ones to get started.

Calling lein test will tests that have no external dependencies. Tests that do require external services being installed on your system (such as Mongo, Postgres or Elasticsearch) can be run with lein test :dependency. Use lein test :all to run the full test suite.

Credits

I wish to thank Stuart Sierra for the pioneering and guidance. Special thanks to James Reeves for the reloaded.repl library and general inspiration. Thanks to Peter Taoussanis, the friendly OSS contributor, who helped to ‘componentize’ sente, an amazing library on its own right.

License

Distributed under the Eclipse Public License, the same as Clojure.