Add Celery task for cleantokens

[Natureshadow]

Description of the Change

This adds a Celery task to clean expired tokens. It can be used to schedule token cleanup in the background, for applications using Celery and Celery beat.

The tasks module is autodiscovered in projects that use Celery, and should not be loaded in other projects, so this does not introduce any new dependency,

Checklist

• PR only contains one change (considered splitting up PR)
• unit-test added
• documentation updated
• CHANGELOG.md updated (only for user relevant changes)
• author name in AUTHORS

[codecov]

Codecov Report

Merging #1070 (2d96223) into master (ac20152) will decrease coverage by 0.27%.
The diff coverage is 0.00%.

❗ Current head 2d96223 differs from pull request most recent head af39ed1. Consider uploading reports for the commit af39ed1 to get more accurate results

@@            Coverage Diff             @@
##           master    #1070      +/-   ##
==========================================
- Coverage   96.87%   96.59%   -0.28%     
==========================================
  Files          31       32       +1     
  Lines        1759     1764       +5     
==========================================
  Hits         1704     1704              
- Misses         55       60       +5     

Impacted Files	Coverage Δ
oauth2_provider/tasks.py	0.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac20152...af39ed1. Read the comment docs.

[n2ygk]

Hey, this is cool. Is there a way to provide some test coverage of this?

[Natureshadow]

Hey, this is cool. Is there a way to provide some test coverage of this?

Sure there is. But it requires to run Celery alongside the test suite. I don't think it is worth adding that complexity to the test suite, given that the test would ensure nothing more that a simple function call calls a function, and Celery can run Python code (which is hopefully tested in Celery itself).

[n2ygk]

Can this functionality be accommodated external to DOT such as in your Django app? I'm not sure we should be adding code that's not core DOT functionality here.
@MattBlack85 what do you think?

[Natureshadow]

Can this functionality be accommodated external to DOT such as in your Django app? I'm not sure we should be adding code that's not core DOT functionality here.

Sure it can. As can the management command – that is just the same thing, only that it is called from the command line. It's nice to have things that make sense to be run periodically pop up in django-admin automatically. Tasks are reusable by design.

[n2ygk]

@Natureshadow I'm trying to understand what to expect with Celery. Is the defined task supposed to show up in Django Admin? What additional configuration is needed to make this happen in, for example, https://github.com/n2ygk/dot-tutorial?

I made a few changes but am missing something fundamental I think. Do some templates need to be added oauth2_provider?

[Natureshadow]

I'm trying to understand what to expect with Celery. Is the defined task supposed to show up in Django Admin?

Depends on how the project orchestrates tasks. Most will probably resort to using django-celery-beat.

What additional configuration is needed to make this happen in, for example, https://github.com/n2ygk/dot-tutorial? I made a few changes but am missing something fundamental I think. Do some templates need to be added oauth2_provider?

I will look into that tomorrow.

[auvipy]

if the defined scheduled task's to be shown in admin might need to use django-celery-beat & django-celery-results to be used/configured to specific project. [I actively maintain both but more work need to be done before deciding to add celery as dependency]

[n2ygk]

if the defined scheduled task's to be shown in admin might need to use django-celery-beat & django-celery-results to be used/configured to specific project. [I actively maintain both but more work need to be done before deciding to add celery as dependency]

I'm looking for specific configuration changes to my test DOT app so that I can see the celery tasks in the admin console.

[n2ygk]

I will look into that tomorrow.

Hi @Natureshadow, just checking in to see if you've had time to look at this.

[Natureshadow]

I checked what we did in AlekSIS for this, and it seems the steps laid out in the Celery documentation are sufficient.

[n2ygk]

@Natureshadow I finally had time to try this out. I basically followed the instructions at:

• https://docs.celeryproject.org/en/stable/django/first-steps-with-django.html, and,
• https://docs.celeryproject.org/en/latest/userguide/periodic-tasks.html#using-custom-scheduler-classes (the link you provided)

And see the admin interface and was able to autodiscover the task. I didn't get it completely working (econnrefused) but close enough to understand what I needed to.

Please rebase this PR and I'll merge it.

Thanks.

[Natureshadow]

Please rebase this PR and I'll merge it.

Thanks.

Done!