release notes
=============

1.2.0
-----
- `Issue #81: Carrot monitor breaks when the queue from a completed message log gets removed from the config <https://github.com/chris104957/django-carrot/issues/81>`_
- `Issue #79: Add unique task_name field to ScheduledTask object <https://github.com/chris104957/django-carrot/issues/79>`_
- `Issue #78: Carrot service should warn users when process is already running <https://github.com/chris104957/django-carrot/issues/78>`_
- `Issue #77: Update the docs to make it clear tasks must be published from within the Django context <https://github.com/chris104957/django-carrot/issues/77>`_

.. warning::
    This release contains new migrations. In order to upgrade from a previous version of carrot, you must apply them:

.. code-block:: python

    python manage.py migrate carrot

1.1.3
-----
- `Issue #75: Add a link to the docker container sample to the docs <https://github.com/chris104957/django-carrot/issues/75>`_

1.1.2
-----
- Doc updates

1.1.1
-----

Bug fixes
*********
- `Issue #72: Migrations end up inside venv? <https://github.com/chris104957/django-carrot/issues/72>`_


1.1.0
-----

Bug fixes
*********

- `Issue #56: Have Django host VueJS resources instead of CDN <https://github.com/chris104957/django-carrot/issues/56>`_
- `Issue #66: Switching between monitor views quickly shows tasks in the wrong list <https://github.com/chris104957/django-carrot/issues/66>`_
- `Issue #67: Simply the version management <https://github.com/chris104957/django-carrot/issues/67>`_
- `Issue #68: Simplify the readmes <https://github.com/chris104957/django-carrot/issues/68>`_

1.0.0
-----

Monitor material theme
**********************
Added a material theme to the django-carrot monitor:

.. figure:: /images/1.0/monitor.png
    :align: center
    :height: 400px
    :figclass: align-center

    material theme django-carrot monitor


Failure hooks
*************

Implemented failure hooks, which run when a task fails. This can be used to re-queue a failed task a certain number
of times before raising an exception. For example:


``my_project/my_app/consumer.py``

.. code-block:: python

    from carrot.utilities import publish_message

    def failure_callback(log, exception):
        if log.task == 'myapp.tasks.retry_test':
            logger.critical(log.__dict__)
            attempt = log.positionals[0] + 1
            if attempt <= 5:
                log.delete()
                publish_message('myapp.tasks.retry_test', attempt)


    class CustomConsumer(Consumer):
        def __init__(self, host, queue, logger, name, durable=True, queue_arguments=None, exchange_arguments=None):
            super(CustomConsumer, self).__init__(host, queue, logger, name, durable, queue_arguments, exchange_arguments)
            self.add_failure_callback(failure_callback)


``my_project/my_app/tasks.py``

.. code-block:: python

    def retry_test(attempt):
        logger.info('ATTEMPT NUMBER: %i' % attempt)
        do_stuff() # this method fails, because it isn't actually defined in this example

``my_project/my_project/settings.py``

.. code-block:: python

    CARROT = {
        'default_broker': vhost,
        'queues': [
            {
                'name': 'default',
                'host': vhost,
                'consumer_class': 'my_project.consumer.CustomConsumer',
            }
        ]
    }


Bug fixes
#########

- `Issue #43: During high server load periods, messages sometimes get consumed before the associated MessageLog is created <https://github.com/chris104957/django-carrot/issues/43>`_