BSD-3-Clause licensed by Daishi Nakajima
Maintained by
This version can be pinned in stack with:yesod-job-queue-,3681

Module documentation for

  • Yesod
    • Yesod.JobQueue
      • Yesod.JobQueue.GenericConstr
      • Yesod.JobQueue.Routes
      • Yesod.JobQueue.Scheduler
      • Yesod.JobQueue.Types

yesod-job-queue Hackage Stackage LTS Stackage Nightly Build Status

Background jobs library for Yesod.

  • There are API and Web UI for managing the job.
  • Queue backend is Redis.
  • Multithreaded.

Web interface

web interface screenshot


Prepare the JobState to manage the running jobs

import Yesod.JobQueue

data App = App {
    appConnPool :: ConnectionPool
    , appDBConf :: SqliteConf
    , appJobState :: JobState

-- e.g. In makeFoundation
main = do
    jobState <- newJobState -- create JobState
    let app = App pool dbConf jobState

Make the routes for API & Manager UI

mkYesod "App" [parseRoutes|
/ HomeR GET
/job JobQueueR JobQueue getJobQueue -- ^ JobQueue API and Manager

Define the job. And, to the setting of JobQueue

-- Your job type
data MyJobType = AggregationUser
               | PushNotification
               | HelloJob String
               deriving (Show, Read, Generic)

-- JobQueue settings
instance YesodJobQueue App where
    type JobType App = MyJobType
    getJobState = appJobState
    threadNumber _ = 2
    runDBJob action = do -- Required if you use the DB in the job
        app <- ask
        runSqlPool action $ appConnPool app
    -- Your Job code
    runJob _ AggregationUser = do
        us <- runDBJob $ selectList ([] :: [Filter Person]) []
        liftIO $ threadDelay $ 10 * 1000 * 1000
        print us
        putStrLn "complate job!"
    runJob _ PushNotification = do
        putStrLn "sent norification!"
    runJob _ (HelloJob name) = do
        putStrLn . pack $ "Hello " ++ name

Please see example

Configration queue backend (Redis)

The default is to connect to redis localhost:6379.

And, you can change connect info by queueConnectInfo

Build package

stack build

build javascripts (required when app/* was editted)

cd app
npm install
npm run build-js
# need again `stack build`

developping app/*

You can edit app/app.js without re-build package

npm run watch-js ## watch app/*.js for changes, automatically build.
npm run bs ## serving app.bundle.js at `http://localhost:3001/dist/app.bundle.js` for test

in example/Main.hs. to use test version of app.bundle.js.

jobManagerJSUrl _ = "http://localhost:3001/dist/app.bundle.js"

Run example

stack build --flag yesod-job-queue:example && stack exec yesod-job-queue-example

You can access Web UI: http://localhost:3000/job/manager