-
Notifications
You must be signed in to change notification settings - Fork 2
/
Jonk.pm
420 lines (302 loc) · 9.19 KB
/
Jonk.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
package Jonk;
use strict;
use warnings;
use Jonk::Job;
use Try::Tiny;
use Carp ();
our $VERSION = '0.06';
sub new {
my ($class, $dbh, $opts) = @_;
unless ($dbh) {
Carp::croak('missing job queue database handle.');
}
my $default_grab_for = $opts->{default_grab_for}|| 60*60;
my $funcs = +{};
my $functions = $opts->{functions}||[];
for (my $i = 0; $i < @$functions; $i++) {
my $func = $functions->[$i];
my $value;
if (not defined $functions->[$i+1]) {$i++ }
elsif (ref $functions->[$i+1]) {$value = $functions->[++$i]}
$value ||= +{grab_for => $default_grab_for};
$funcs->{$func} = $value;
}
bless {
dbh => $dbh,
table_name => $opts->{table_name} || 'job',
functions => $funcs,
find_funcs => join(', ', map { "'$_'" } keys %{$funcs}),
job_find_size => $opts->{job_find_size} || 50,
_errstr => undef,
insert_time_callback => ($opts->{insert_time_callback}||sub{
my ( $sec, $min, $hour, $mday, $mon, $year, undef, undef, undef ) = localtime(time);
return sprintf('%04d-%02d-%02d %02d:%02d:%02d', $year + 1900, $mon + 1, $mday, $hour, $min, $sec);
}),
}, $class;
}
sub errstr {$_[0]->{_errstr}}
sub insert {
my ($self, $func, $arg, $opt) = @_;
my $job_id;
try {
$self->{_errstr} = undef;
local $self->{dbh}->{RaiseError} = 1;
local $self->{dbh}->{PrintError} = 0;
my $sth = $self->{dbh}->prepare_cached(
sprintf(
'INSERT INTO %s (func, arg, enqueue_time, grabbed_until, run_after, retry_cnt, priority) VALUES (?,?,?,0,?,0,?)'
,$self->{table_name}
)
);
$sth->bind_param(1, $func);
$sth->bind_param(2, $arg, _bind_param_attr($self->{dbh}));
$sth->bind_param(3, $self->{insert_time_callback}->());
$sth->bind_param(4, $opt->{run_after}||0);
$sth->bind_param(5, $opt->{priority}||0);
$sth->execute();
$job_id = $self->{dbh}->last_insert_id("","",$self->{table_name},"");
$sth->finish;
} catch {
$self->{_errstr} = "can't insert for job queue database: $_"
};
$job_id;
}
sub _bind_param_attr {
my $dbh = shift;
my $driver = $dbh->{Driver}{Name};
if ( $driver eq 'Pg' ) {
return { pg_type => DBD::Pg::PG_BYTEA() };
} elsif ( $driver eq 'SQLite' ) {
return DBI::SQL_BLOB();
}
return;
}
sub _server_unixitime {
my $dbh = shift;
my $driver = $dbh->{Driver}{Name};
return time if $driver eq 'SQLite';
my $q;
if ( $driver eq 'Pg' ) {
$q = "TRUNC(EXTRACT('epoch' from NOW()))";
} else {
$q = 'UNIX_TIMESTAMP()';
}
return $dbh->selectrow_array("SELECT $q");
}
sub _grab_job {
my ($self, $callback, $opt) = @_;
my $job;
try {
$self->{_errstr} = undef;
local $self->{dbh}->{RaiseError} = 1;
local $self->{dbh}->{PrintError} = 0;
my $time = _server_unixitime($self->{dbh});
my $sth = $callback->($time);
while (my $row = $sth->fetchrow_hashref) {
$job = $self->_grab_a_job($row, $time, $opt);
last if $job;
}
$sth->finish;
} catch {
$self->{_errstr} = "can't grab job from job queue database: $_";
};
$job;
}
sub _grab_a_job {
my ($self, $row, $time) = @_;
my $sth = $self->{dbh}->prepare_cached(
sprintf('UPDATE %s SET grabbed_until = ? WHERE id = ? AND grabbed_until = ?', $self->{table_name}),
);
$sth->execute(
($time + ($self->{functions}->{$row->{func}}->{grab_for})),
$row->{id},
$row->{grabbed_until}
);
my $grabbed = $sth->rows;
$sth->finish;
$grabbed ? Jonk::Job->new($self => $row) : undef;
}
sub lookup_job {
my ($self, $job_id) = @_;
$self->_grab_job(
sub {
my $time = shift;
my $sth = $self->{dbh}->prepare_cached(
sprintf('SELECT * FROM %s WHERE id = ? AND grabbed_until <= ? AND run_after <= ?', $self->{table_name})
);
$sth->execute($job_id, $time, $time);
$sth;
}
);
}
sub find_job {
my ($self, $opts) = @_;
unless ($self->{find_funcs}) {
Carp::croak('missin find_job functions.');
}
$self->_grab_job(
sub {
my $time = shift;
my $sth = $self->{dbh}->prepare_cached(
sprintf('SELECT * FROM %s WHERE func IN (%s) AND grabbed_until <= ? AND run_after <= ? ORDER BY priority DESC LIMIT %s',
$self->{table_name},
$self->{find_funcs},
($opts->{job_find_size}||50),
),
);
$sth->execute($time, $time);
$sth;
}
);
}
sub _delete {
my ($self, $job_id) = @_;
try {
my $sth = $self->{dbh}->prepare_cached(
sprintf('DELETE FROM %s WHERE id = ?', $self->{table_name})
);
$sth->execute($job_id);
$sth->finish;
return $sth->rows;
} catch {
$self->{_errstr} = "can't dequeue job from job queue database: $_";
return;
};
}
sub _failed {
my ($self, $job_id, $opt) = @_;
my $retry_delay = _server_unixitime($self->{dbh}) + ($opt->{retry_delay} || 60);
try {
my $sth = $self->{dbh}->prepare_cached(
sprintf('UPDATE %s SET retry_cnt = retry_cnt + 1, run_after = ?, grabbed_until = 0 WHERE id = ?', $self->{table_name})
);
$sth->execute($retry_delay, $job_id);
$sth->finish;
return $sth->rows;
} catch {
$self->{_errstr} = "can't update job from job queue database: $_";
return;
};
}
1;
__END__
=head1 NAME
Jonk - simple job tank manager.
=head1 SYNOPSIS
use DBI;
use Jonk;
my $dbh = DBI->connect(...);
my $jonk = Jonk->new($dbh, {functions => [qw/MyWorker/]});
# insert job
{
$jonk->insert('MyWorker', 'arg');
}
# execute job
{
my $job = $jonk->find_job;
print $job->func; # MyWorker
print $job->arg; # arg
$job->completed;
}
=head1 DESCRIPTION
Jonk is simple job queue manager system
Job is saved and taken out. Besides, nothing is done.
You may use Jonk to make original Job Queuing System.
=head1 METHODS
=head2 my $jonk = Jonk::Worker->new($dbh, [\%options]);
Creates a new Jonk object, and returns the object.
$options is an optional settings.
=over 4
=item * $dbh
$dbh is database handle.
=item * $options->{functions}
Key word of job which this Jonk instance looks for.
=item * $options->{table_name}
specific job table name.
Default job table name is `job`.
=item * $options->{job_find_size}
specific lookup job record size.
Default 50.
=back
=head2 my $job_id = $jonk->insert($func, $arg);
enqueue a job to a database.
returns job.id.
=over 4
=item * $func
specific your worker funcname.
=item * $arg
job argument data.
serialize is not done in Jonk.
Please pass data that does serialize if it is necessary.
=back
=head2 my $job = $jonk->lookup_job($job_id);
lookup a job from a database.
returns Jonk::Job object.
=over 4
=item * $job_id
lookup specific $job_id's job.
=back
=head2 my $job = $jonk->find_job(\%opts);
=over 4
=item * $opts->{job_find_size}
find job limit size.
=back
=head2 $jonk->errstr;
get most recent error infomation.
=head1 ERROR HANDLING
my $job = $jonk->lookup;
if ($jonk->errstr) {
die $jonk->errstr;
}
=head1 SCHEMA
=head2 MySQL
CREATE TABLE job (
id int(10) UNSIGNED NOT NULL auto_increment,
func varchar(255) NOT NULL,
arg MEDIUMBLOB,
enqueue_time DATETIME NOT NULL,
grabbed_until int(10) UNSIGNED NOT NULL,
run_after int(10) UNSIGNED NOT NULL DEFAULT 0,
retry_cnt int(10) UNSIGNED NOT NULL DEFAULT 0,
priority int(10) UNSIGNED NOT NULL DEFAULT 0,
primary key ( id )
) ENGINE=InnoDB
=head2 SQLite
CREATE TABLE job (
id INTEGER PRIMARY KEY ,
func text,
arg text,
enqueue_time text,
grabbed_until INTEGER UNSIGNED NOT NULL,
run_after INTEGER UNSIGNED NOT NULL DEFAULT 0,
retry_cnt INTEGER UNSIGNED NOT NULL DEFAULT 0,
priority INTEGER UNSIGNED NOT NULL DEFAULT 0
)
=head2 PostgreSQL
CREATE TABLE job (
id SERIAL PRIMARY KEY,
func TEXT NOT NULL,
arg BYTEA,
enqueue_time TIMESTAMP NOT NULL,
grabbed_until INTEGER NOT NULL,
run_after INTEGER NOT NULL DEFAULT 0,
retry_cnt INTEGER NOT NULL DEFAULT 0,
priority INTEGER NOT NULL DEFAULT 0
)
=head1 SEE ALSO
L<Qudo>
L<TheSchwartz>
=head1 SUPPORT
irc: #jonk@irc.perl.org
=head1 REPOSITORY
git clone git://github.com/nekokak/p5-Jonk.git
=head1 CONTRIBUTORS
tokuhirom
kan_fushihara
fujiwara
=head1 AUTHOR
Atsushi Kobayashi E<lt>nekokak _at_ gmail _dot_ comE<gt>
=head1 LICENSE
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut