crystal-task
Crystal Task
Background workers for Crystal. Similar to other background systems. There is a horrible UI that is just there.
Installation
-
Add the dependency to your
shard.yml
:dependencies: crystal_task: github: amedeiros/crystal-task
-
Run
shards install
Usage
require "crystal_task"
Creating a worker is as easy as including CystalTask::Worker and implementing the perform function.
class ExampleWorker
include CrystalTask::Worker
retries 5 # adjust how many times this job can be retried
queue "examples-queue" # change the queue from the default queue 'default' to your own.
def perform(args : Hash(String, JSON::Any))
logger.info { "Hello, Crystal Task!" }
logger.info { args["x"].as(Int64) + args["y"].as(Int64) }
end
end
Queue work for the worker. ExampleWorker.perform_async!(x: 1, y: 1)
There is the concept of periodic workers that can run on interval. They are less percise than the cron style workers see below.
class PeriodicWorker
include CrystalTask::Worker
# 10.minutes, 1.minutes, 1.month etc...
# EX: First run 10:05:36 next run 11:05:36
periodic 1.hour
def perform(args : Hash(String, JSON::Any))
# do some work on an interval
end
class CronWorker
include CrystalTask::Worker
# Every minute on the minute.
# Ex: First run 10:05:00 next run 10:06:00
cron "* * * * *"
def perform(args : Hash(String, JSON::Any))
logger.info { "CronWorker time: #{Time.utc}" }
end
end
Running the worker server.
#!/usr/bin/env crystal
require "crystal_task"
require "crystal_task/server"
CrystalTask::Server.run!
Running the web server.
#!/usr/bin/env crystal
require "crystal_task"
require "crystal_task/web"
CrystalTask::Web.run!
Configuring
TODO: This
Development
Currently on going with the API changing with each commit.
Need help with the UI and anything anyone wants to contribute. Feel free to make pull requests!
Contributing
- Fork it (https://github.com/amedeiros/crystal_task/fork)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Contributors
- Andrew Medeiros - creator and maintainer
crystal-task
- 3
- 0
- 1
- 0
- 3
- 3 months ago
- March 23, 2019
MIT License
Mon, 25 Nov 2024 17:46:55 GMT