/ 
Dancer2-Plugin-ProgressMeter-0.01
/ Dancer2::Plugin::ProgressStatus

NAME

Dancer2::Plugin::ProgressStatus

DESCRIPTION

Records and fetches progress entries.

This module allows your route to start a progress status meter and update it whilst your long running task is in progress. How you break up the running task is up to you.

Whilst the long running task is in progress, an AJAX GET request can be made to /_progress_status/:name to fetch JSON serialized data representing the progress status that matches :name

This progress module does not depend on an event loop based webserver such as Twiggy as the long running request and the query to fetch the progress can be issued entirely separately.

It does currently depend on the webserver being hosted on one machine and uses local file storage for the progress data and as such is probably not suitable for a production environment at this time.

SYNOPSIS

get '/route' => sub {
  my $progress = start_progress_status({ name => 'progress1', total => 100 });
  while($some_condition) {
      # .. do some slow running stuff
      $progress++; # add's one to the progress
      $progress->add_message('an update message');
  }

  // $progress goes out of scope here and automatically ends the progress meter
};

Then with some javascript on the front end, something like this:

function checkProgress() {
    $.getJSON('/_progress_status/progress1', function(data) {
       if ( !data.in_progress ) {
          console.log("Finished progress1");
          return;
       }
       setTimeout(function() {
          checkProgress,
          3000
       });
    })
}

CONFIG

plugins:
  ProgressStatus:
    dir: "/tmp/dancer_progress"

The only plugin setting currently understood is where to store the progress data. This is required.

SEE ALSO

Dancer2

METHODS

start_progress_status
my $prog = set_progress_status({ name => "MyProgressStatus" });

Registers a new progress status for this session and automatically creates a route for returning data about the progress status.

Returns a progress object that you can use to set the progress. e.g.

$prog++;
$prog->add_message();
$prog->increment(10);

If an existing progress status with this name already exists and is currently in progress for a different pid then this call will die, if the pid is the same the second one will override the first. It is up to the app code to prevent multiple progress statuses with the same name from running at the same time.

The route for querying the progress status is defined as:

GET /_progress_status/:name

It returns a JSON serialized structure something like:

{
  total: 100,
  count: 20,
  messages: [ "array of messages" ],
  in_progress: true
  status: 'some status message'
}

When the progress object goes out of scope in_progress is automatically set to false

set_progress_status takes a name (required), a total (defaults to 100) a count (defaults to 0), and messages an optional arrayref of message strings.