/ 
Dancer2-Plugin-Minion-1.0.0
River stage zero No dependents
/ Dancer2::Plugin::Minion

NAME

Dancer2::Plugin::Minion - Easy access to Minion job queue in your Dancer2 applications

SYNOPSIS

package MyApp;
use Dancer2;
use Dancer2::Plugin::Minion;
use Plack::Builder;

get '/' => sub {
    add_task( add => sub {
        my ($job, $first, $second) = @_;
        $job->finish($first + $second);
    });
};

get '/start-job' => sub {
    my $id = enqueue( add => [1, 1] );
    return "Started job ID $id";
};

get '/job-results/:job_id' => sub {
    my $id     = route_parameters->get( 'job_id' ) // 0;
    my $result = minion->job( $id )->info->{ result };
};

build {
  mount '/dashboard/' => minion_app->start;
  mount '/' => start;
}

# In config.yml
plugins:
    Minion:
        dsn: sqlite:test.db
        backend: SQLite

DESCRIPTION

Dancer2::Plugin::Minion makes it easy to add a job queue to any of your Dancer2 applications. The queue is powered by Minion and uses a backend of your choosing, such as PostgreSQL or SQLite.

The plugin lazily instantiates a Minion object, which is accessible via the minion keyword. Any method, attribute, or event you need in Minion is available via this keyword. Additionally, add_task and enqueue keywords are available to make it convenient to add and start new queued jobs.

See the Minion documentation for more complete documentation on the methods and functionality available.

ATTRIBUTES

minion

The Minion-based object. See the Minion documentation for a list of additional methods provided.

If no backend is specified, Minion will default to an in-memory temporary database. This is not recommended for any serious use. See the Mojo::SQLite docs for details

METHODS

add_task()

Keyword/shortcut for minion->add_task(). See Minion's add_task() documentation for more information.

enqueue()

Keyword/shortcut for minion->enqueue(). See Minion's enqueue() documentation for more information.

minion_app()

Build a Mojolicious application with the Mojolicious::Plugin::Minion::Admin application running. This application can then be started and mounted inside your own but be sure to leave a trailing slash in your mount path!

You can optionally pass in an absolute URL to act as the "return to" link. The url must be absolute or else it will be made relative to the admin UI, which is probably not what you want. For example: mount '/dashboard/' => minion_app( 'http://localhost:5000/foo' )->start;

RUNNING JOBS

You will need to create a Minion worker if you want to be able to run your queued jobs. Thankfully, you can write a minimal worker with just a few lines of code:

#!/usr/bin/env perl

use Dancer2;
use Dancer2::Plugin::Minion;

minion->add_task( add => sub {
    my ( $job, $first, $second ) = @_;
    $job->finish( $first + $second );
});

my $worker = minion->worker;
$worker->run;

By using Dancer2::Plugin::Minion, your worker will be configured with the settings provided in your config.yml file. See Minion::Worker for more information.

SEE ALSO

AUTHOR

Jason A. Crome cpan AT jason DOT cromedome DOT dev

ACKNOWLEDGEMENTS

I'd like to extend a hearty thanks to my employer, Clearbuilt Technologies, for giving me the necessary time and support for this module to come to life.

The following contributors have sent patches, suggestions, or bug reports that led to the improvement of this plugin:

  • Gabor Szabo

  • Joel Berger

  • Slaven Rezić

  • Julien Fiegehenn

COPYRIGHT AND LICENSE

Copyright (c) 2024, Jason A. Crome

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.