Add in migrations, 'created' DB field, and instructions for moving django_ztask to South

Author: themartorana

README.markdown

@@ -1,3 +1,19 @@
+IMPORTANT: READ ME
+==================
+
+In version 0.1.4, we are introducing two major changes:
+
+1. Tasks now have a "created" datetime field. This was added to make sure `--replayfailed` replayed tasks in the appropriate order
+2. Introduced [South](http://south.aeracode.org/) migrations.
+
+IF YOU HAVE ALREADY INSTALLED django-ztask - you can "fake" the first migration, and then run the second migration:
+
+    ./manage.py migrate django_ztask --fake 0001
+    ./manage.py migrate django_ztask
+    
+If you are not using [South](http://south.aeracode.org/) in your Django project, it is strongly recommended you do. If you
+are not, you will have to add the "created" field to your database manually.
+
 Installing
 ==========
 
@@ -34,25 +50,25 @@ Command-line arguments
 The `ztaskd` command takes a series of command-line arguments:
 
 - `--noreload`
-
+  
   By default, `ztaskd` will use the built-in Django reloader 
   to reload the server whenever a change is made to a python file. Passing
   in `--noreload` will prevent it from listening for changed files.
   (Good to use in production.)
 
 - `-l` or `--loglevel`
-
+  
   Choose from the standard `CRITICAL`, `ERROR`, `WARNING`, 
   `INFO`, `DEBUG`, or `NOTSET`. If this argument isn't passed 
   in, `INFO` is used by default.
 
 - `-f` or `--logfile`
-
+  
   The file to log messages to. By default, all messages are logged
   to `stdout`
 
 - `--replayfailed`
-
+  
   If a command has failed more times than allowed in the 
   `ZTASKD_RETRY_COUNT` (see below for more), the task is
   logged as failed. Passing in `--replayfailed` will cause all 

django_ztask/__init__.py

@@ -1,7 +1,7 @@
 """Django ZTask."""
 import os
 
-VERSION = (0, 1, 3)
+VERSION = (0, 1, 4)
 
 __version__ = ".".join(map(str, VERSION[0:3])) + "".join(VERSION[3:])
 __author__ = "Jason Allum and Dave Martorana"

django_ztask/management/commands/ztaskd.py

@@ -73,9 +73,9 @@ def _queue_handler(socket, *args, **kwargs):
 
         # Reload tasks if necessary
         if replay_failed:
-            replay_tasks = Task.objects.all()
+            replay_tasks = Task.objects.all().order_by('created')
         else:
-            replay_tasks = Task.objects.filter(retry_count__gt=0)
+            replay_tasks = Task.objects.filter(retry_count__gt=0).order_by('created')
         for task in replay_tasks:
             if task.next_attempt < time.time():
                 ioloop.DelayedCallback(lambda: self._call_function(task.pk), 5000, io_loop=self.io_loop).start()

django_ztask/migrations/0001_initial.py

@@ -0,0 +1,45 @@
+# encoding: utf-8
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        
+        # Adding model 'Task'
+        db.create_table('django_ztask_task', (
+            ('uuid', self.gf('django.db.models.fields.CharField')(max_length=36, primary_key=True)),
+            ('function_name', self.gf('django.db.models.fields.CharField')(max_length=255)),
+            ('args', self.gf('django.db.models.fields.TextField')()),
+            ('kwargs', self.gf('django.db.models.fields.TextField')()),
+            ('retry_count', self.gf('django.db.models.fields.IntegerField')(default=0)),
+            ('last_exception', self.gf('django.db.models.fields.TextField')(null=True, blank=True)),
+            ('next_attempt', self.gf('django.db.models.fields.FloatField')(null=True, blank=True)),
+            ('failed', self.gf('django.db.models.fields.DateTimeField')(null=True, blank=True)),
+        ))
+        db.send_create_signal('django_ztask', ['Task'])
+
+
+    def backwards(self, orm):
+        
+        # Deleting model 'Task'
+        db.delete_table('django_ztask_task')
+
+
+    models = {
+        'django_ztask.task': {
+            'Meta': {'object_name': 'Task'},
+            'args': ('django.db.models.fields.TextField', [], {}),
+            'failed': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}),
+            'function_name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'kwargs': ('django.db.models.fields.TextField', [], {}),
+            'last_exception': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'next_attempt': ('django.db.models.fields.FloatField', [], {'null': 'True', 'blank': 'True'}),
+            'retry_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'uuid': ('django.db.models.fields.CharField', [], {'max_length': '36', 'primary_key': 'True'})
+        }
+    }
+
+    complete_apps = ['django_ztask']

django_ztask/migrations/0002_auto__add_field_task_created.py

@@ -0,0 +1,36 @@
+# encoding: utf-8
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        
+        # Adding field 'Task.created'
+        db.add_column('django_ztask_task', 'created', self.gf('django.db.models.fields.DateTimeField')(null=True, blank=True), keep_default=False)
+
+
+    def backwards(self, orm):
+        
+        # Deleting field 'Task.created'
+        db.delete_column('django_ztask_task', 'created')
+
+
+    models = {
+        'django_ztask.task': {
+            'Meta': {'object_name': 'Task'},
+            'args': ('django.db.models.fields.TextField', [], {}),
+            'created': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}),
+            'failed': ('django.db.models.fields.DateTimeField', [], {'null': 'True', 'blank': 'True'}),
+            'function_name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'kwargs': ('django.db.models.fields.TextField', [], {}),
+            'last_exception': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'next_attempt': ('django.db.models.fields.FloatField', [], {'null': 'True', 'blank': 'True'}),
+            'retry_count': ('django.db.models.fields.IntegerField', [], {'default': '0'}),
+            'uuid': ('django.db.models.fields.CharField', [], {'max_length': '36', 'primary_key': 'True'})
+        }
+    }
+
+    complete_apps = ['django_ztask']

django_ztask/migrations/__init__.py

@@ -1,6 +1,7 @@
 from django.db.models import *
 
 import uuid
+import datetime
 
 class QuerySetManager(Manager):
     def __getattr__(self, attr, *args):
@@ -23,10 +24,12 @@ class Task(Model):
     retry_count = IntegerField(default=0)
     last_exception = TextField(blank=True, null=True)
     next_attempt = FloatField(blank=True, null=True)
+    created = DateTimeField(blank=True, null=True)
     failed = DateTimeField(blank=True, null=True)
 
     def save(self, *args, **kwargs):
         if not self.uuid:
+            self.created = datetime.datetime.now()
             self.uuid = uuid.uuid4()
         super(Task, self).save(*args, **kwargs)