Wheb

The frictionless WAI Framework https://github.com/hansonkd/Wheb-Framework

Latest on Hackage:0.3.1.0

This package is not currently in any snapshots. If you're interested in using it, we recommend adding it to Stackage Nightly. Doing so will make builds more reliable, and allow stackage.org to host generated Haddocks.

BSD3 licensed by Kyle Hanson
Maintained by me@khanson.io

Wheb's a framework for building robust, high-concurrency web applications simply and effectively.

  • The core datatype will let you build anything from a read-only server to a fully interactive web application with basic Haskell.

  • Minimal boilerplate to start your application.

  • Session, Auth and Cache interfaces are built in. Just drop in a backend.

  • Typesafe web-routes or named routes and URL generation.

  • Easy to use for REST APIs

  • CSRF Protection

  • WebSockets

  • Fully database and template agnostic

  • Easy handler debugging.

  • Middleware

  • Fast. It deploys on warp.

Plugins:

Wheb makes it easy to write plugins. Plugins can add routes, middlware, settings and even handle resource cleanup on server shutdown. Named routes allow plugins to dynamically generate their routes at runtime based on settings.

Examples of plugins:

Wheb in action:

Use with language extensions OverloadedStrings

import           Web.Wheb

main :: IO ()
main = do
  opts <- genMinOpts $ do
     addGET "home" rootPat $ text "Hi!"
     addGET "about" ("about" </> "something") $ html "<html><body><h1>About!</h1></body></html>"
  runWhebServer opts

Bigger example (Stateful.hs):

Wheb makes it easy to share a global context and handle requests statefully. The Wheb monad is both a Reader and a State Monad allowing you to seperate thread-safe resources.

Below is an example of site that naively counts the non-unique hits across all pages. MyApp is our Reader's type and MyHandlerData is our State's type. MyApp is shared across requests while MyHandlerData is thread specific with a starting state given in options. We have a middleware that intercepts the request, safely increments the shared resource TVar and sets our MyHandlerData to the correct count before it reaches our handler. We use a TVar in the Global context because any state changes to the handler state will not affect other requests.

 import           Control.Concurrent.STM
 import           Control.Monad.IO.Class
 import           Data.Monoid
 import           Data.Text.Lazy (Text)
 import           Web.Wheb

 data MyApp = MyApp Text (TVar Int)
 data MyHandlerData = MyHandlerData Int

 counterMw :: MonadIO m => WhebMiddleware MyApp MyHandlerData m
 counterMw = do
   (MyApp _ ctr) <- getApp
   number <- liftIO $ atomically $ do
           num <- readTVar ctr
           writeTVar ctr (succ num)
           return num
   putHandlerState (MyHandlerData number)
   return Nothing

 homePage :: WhebHandler MyApp MyHandlerData
 homePage = do
   (MyApp appName _)   <- getApp
   (MyHandlerData num) <- getHandlerState
   html $ ("<h1>Welcome to" <> appName <>
           "</h1><h2>You are visitor #" <> (spack num) <> "</h2>")

 main :: IO ()
 main = do
   opts <- generateOptions $ do
             startingCounter <- liftIO $ newTVarIO 0
             addWhebMiddleware counterMw
             addGET "." rootPat $ homePage
             return $ (MyApp "AwesomeApp" startingCounter, MyHandlerData 0)
   runWhebServer opts
comments powered byDisqus