Code Monkey home page Code Monkey logo

cronex's Introduction

Cronex

Travis Build

A cron like system, built in Elixir, that you can mount in your supervision tree.

Cronex's DSL for adding cron jobs is inspired by whenever Ruby gem.

Installation

Add cronex to your list of dependencies in mix.exs:

def deps do
  [{:cronex, "~> 0.4.0"}]
end

Then run mix deps.get to get the package.

Getting started

Cronex makes it really easy and intuitive to schedule cron like jobs.

You use the Cronex.Scheduler module to define a scheduler and add jobs to it.

Cronex will gather jobs from the scheduler you defined and will run them at the expected time.

# Somewhere in your application define your scheduler
defmodule MyApp.Scheduler do
  use Cronex.Scheduler

  every :hour do
    IO.puts "Every hour job"
  end

  every :day, at: "10:00" do
    IO.puts "Every day job at 10:00"
  end
end

# Start scheduler with start_link
MyApp.Scheduler.start_link

# Or add it to your supervision tree
defmodule MyApp.Supervisor do
  use Supervisor

  # ...

  def init(_opts) do
    children = [
      # ...
      supervisor(MyApp.Scheduler, [])
      # ...
    ]

    supervise(children, ...)
  end

  # ...
end

You can define as much schedulers as you want.

Testing

Cronex comes with Cronex.Test module which provides helpers to test your cron jobs.

defmodule MyApp.SchedulerTest do
  use ExUnit.Case
  use Cronex.Test

  test "every hour job is defined in MyApp.Scheduler" do
    assert_job_every :hour, in: MyApp.Scheduler 
  end

  test "every day job at 10:00 is defined in MyApp.Scheduler" do
    assert_job_every :day, at: "10:00", in: MyApp.Scheduler 
  end
end

Documentation

The project documentation can be found here.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jbernardo95/cronex.

License

Cronex source code is licensed under the MIT License.

cronex's People

Contributors

jbernardo95 avatar tbk145 avatar torifukukaiou avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

cronex's Issues

In Elixir 1.6.4 timing is not correct

In elixir 1.6.4 with Erlang 20.3 on windows;

Run every minute task runs every 30 seconds i.e. twice per minute.

A run every 5 minutes task runs twice in the first minute, then doesn't run until 5 minutes later but then runs twice within the same minute again etc

defmodule Core.Scheduler do
use Cronex.Scheduler
require Logger

every 5, :minute do
Logger.debug "Run every 5 minute task"
end

every :minute do
Logger.debug "Run every minute task"
end
end

Ability to manually start the scheduler

Right now we have rolled our own and we have an env-level config value that we set as a boolean, which we pass as an init option.

In order to use Cronex, right now I'll have to do something more verbose and basically only add it to the supervision tree if the value is true.

Improve multi node support and control

Currently if cronex is started in multiple nodes, cron jobs will run several times in different nodes.

The desired behaviour is to have multiple cronex instances that coordinate between them which one should run the cron jobs.

Code depends on `Mix.env` being present, which it won't be in production

    ** (EXIT) shutdown: failed to start child: Cronex.Table
        ** (EXIT) an exception was raised:
            ** (UndefinedFunctionError) function Mix.env/0 is undefined (module Mix is not available)
                Mix.env()
                (cronex) lib/cronex/table.ex:108: Cronex.Table.ping_interval/0
                (cronex) lib/cronex/table.ex:104: Cronex.Table.new_ping_timer/0
                (cronex) lib/cronex/table.ex:48: Cronex.Table.init/1
                (stdlib) gen_server.erl:328: :gen_server.init_it/6
                (stdlib) proc_lib.erl:247: :proc_lib.init_p_do_apply/3

Just deployed Cronex in prod and killed my server because of this error.

Seems to be this line of code:

https://github.com/jbernardo95/cronex/blob/master/lib/cronex/table.ex#L104

So obviously your library is unusable right now, unfortunately. I'd make this an env-level variable if I were you, configurable by the user, with a sane default.

Add logging

Log when a job is not run because the process from the last run is still running.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.