Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Background workers #86

Merged
merged 54 commits into from
May 29, 2024
Merged

Background workers #86

merged 54 commits into from
May 29, 2024

Commits on Feb 9, 2024

  1. Write a DEP for background workers

    @RealOrangeOne
    RealOrangeOne committed Feb 9, 2024
    Configuration menu
    Copy the full SHA
    3f937bc View commit details
    Browse the repository at this point in the history

  2. Move tasks from contrib to django root

    @RealOrangeOne
    RealOrangeOne committed Feb 9, 2024
    Configuration menu
    Copy the full SHA
    c5d836c View commit details
    Browse the repository at this point in the history

  3. Provide default async implementations

    @RealOrangeOne
    RealOrangeOne committed Feb 9, 2024
    Configuration menu
    Copy the full SHA
    96305e8 View commit details
    Browse the repository at this point in the history

  4. Explicitly mention the potential for future development

    @RealOrangeOne
    RealOrangeOne committed Feb 9, 2024
    Configuration menu
    Copy the full SHA
    c9c76d9 View commit details
    Browse the repository at this point in the history

  5. Link out to example code

    @RealOrangeOne
    RealOrangeOne committed Feb 9, 2024
    Configuration menu
    Copy the full SHA
    815ac49 View commit details
    Browse the repository at this point in the history

  6. Add the ability to get an existing task

    @RealOrangeOne
    RealOrangeOne committed Feb 9, 2024
    Configuration menu
    Copy the full SHA
    bc8170b View commit details
    Browse the repository at this point in the history

Commits on Feb 12, 2024

  1. Fix typos

    @RealOrangeOne
    RealOrangeOne committed Feb 12, 2024
    Configuration menu
    Copy the full SHA
    f0c6b3a View commit details
    Browse the repository at this point in the history

  2. Remove suggestion for how to implement cron-based scheduling 

    This suffered from a bootstrapping problem. Instead, people can use whatever techniques they're using at the moment, and task-ify them as needed.
    @RealOrangeOne
    RealOrangeOne committed Feb 12, 2024
    Configuration menu
    Copy the full SHA
    018af5c View commit details
    Browse the repository at this point in the history

  3. Add thought process behind DatabaseBackend to DEP

    @RealOrangeOne
    RealOrangeOne committed Feb 12, 2024
    Configuration menu
    Copy the full SHA
    d9a10c7 View commit details
    Browse the repository at this point in the history

Commits on Feb 13, 2024

  1. Ensure a task keeps track of the parameters of the task when enqueued.

    @RealOrangeOne
    RealOrangeOne committed Feb 13, 2024
    Configuration menu
    Copy the full SHA
    28b5b84 View commit details
    Browse the repository at this point in the history

  2. Add async stub for get_task

    @RealOrangeOne
    RealOrangeOne committed Feb 13, 2024
    Configuration menu
    Copy the full SHA
    a21d00f View commit details
    Browse the repository at this point in the history

  3. Use a generic exception for tasks not existing

    @RealOrangeOne
    RealOrangeOne committed Feb 13, 2024
    Configuration menu
    Copy the full SHA
    c24c2a3 View commit details
    Browse the repository at this point in the history

  4. Note that task functions must be globally importable

    @RealOrangeOne
    RealOrangeOne committed Feb 13, 2024
    Configuration menu
    Copy the full SHA
    e6ebec7 View commit details
    Browse the repository at this point in the history

  5. Queueing an async task will not execute it immediately

    @RealOrangeOne
    RealOrangeOne committed Feb 13, 2024
    Configuration menu
    Copy the full SHA
    7b89e7b View commit details
    Browse the repository at this point in the history

  6. Add a DummyBackend

    @RealOrangeOne
    RealOrangeOne committed Feb 13, 2024
    Configuration menu
    Copy the full SHA
    fd679ed View commit details
    Browse the repository at this point in the history

Commits on Feb 26, 2024

  1. Correct number of built-in implementations

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    4bb8f23 View commit details
    Browse the repository at this point in the history

  2. Explicitly note that an exception is raised if a task doesn't exist

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    a58f0c2 View commit details
    Browse the repository at this point in the history

  3. Upper-case task statuses so it's clearer they're enum values

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    9fb9e34 View commit details
    Browse the repository at this point in the history

  4. Fix typo

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    1663277 View commit details
    Browse the repository at this point in the history

  5. Note that result may be None if the task hasn't completed

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    df9cf1f View commit details
    Browse the repository at this point in the history

  6. Allow sync APIs to execute coroutines

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    ffefb6c View commit details
    Browse the repository at this point in the history

  7. Add a method for validating a task function

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    961d7c7 View commit details
    Browse the repository at this point in the history

  8. Don't allow different task statuses 

    This makes casting back to the defined enum safer. Raw statuses can be obtained from the `.raw` property
    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    c289041 View commit details
    Browse the repository at this point in the history

  9. Explicitly allow async task functions 

    These can be queued either in a sync or async context
    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    70893bb View commit details
    Browse the repository at this point in the history

  10. Require task functions be marked

    @RealOrangeOne
    RealOrangeOne committed Feb 26, 2024
    Configuration menu
    Copy the full SHA
    39bd0c3 View commit details
    Browse the repository at this point in the history

Commits on Mar 8, 2024

  1. Be explicit that when should be timezone-aware

    @RealOrangeOne
    RealOrangeOne committed Mar 8, 2024
    Configuration menu
    Copy the full SHA
    0ea2502 View commit details
    Browse the repository at this point in the history

  2. Note that the result will raise a value error if the task hasn't comp… 

    …leted.
    @RealOrangeOne
    RealOrangeOne committed Mar 8, 2024
    Configuration menu
    Copy the full SHA
    e9ffd7d View commit details
    Browse the repository at this point in the history

  3. Remove the raw field 

    Nothing is added by documenting this explicitly. People can rely on introspecting the `Task` if they need internal values
    @RealOrangeOne
    RealOrangeOne committed Mar 8, 2024
    Configuration menu
    Copy the full SHA
    7efb22c View commit details
    Browse the repository at this point in the history

Commits on Mar 28, 2024

  1. Simplify exposed API and allow for more customisation 

    A "Task" becomes a defined item, with metadata hanging off it for more customisation.

Also unify the `defer` and `enqueue` APIs so only a single method needs to be used. This also makes naming simpler.
    @RealOrangeOne
    RealOrangeOne committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    3da595f View commit details
    Browse the repository at this point in the history

  2. Support multiple queues 

    This is needed for dedicated capacity
    @RealOrangeOne
    RealOrangeOne committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    3bf55ab View commit details
    Browse the repository at this point in the history

  3. Timeouts and failed hooks are out of scope

    @RealOrangeOne
    RealOrangeOne committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    dc53f2f View commit details
    Browse the repository at this point in the history

  4. The reference implementation will eventually be a backport

    @RealOrangeOne
    RealOrangeOne committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    3d6b866 View commit details
    Browse the repository at this point in the history

  5. Arguments must be JSON serializable.

    @RealOrangeOne
    RealOrangeOne committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    b973804 View commit details
    Browse the repository at this point in the history

  6. Tie a task to a backend

    @RealOrangeOne
    RealOrangeOne committed Mar 28, 2024
    Configuration menu
    Copy the full SHA
    d33aa11 View commit details
    Browse the repository at this point in the history

Commits on Apr 2, 2024

  1. Better document task validation

    @RealOrangeOne
    RealOrangeOne committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    3261190 View commit details
    Browse the repository at this point in the history

  2. Match DATABASES convention for settings

    @RealOrangeOne
    RealOrangeOne committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    1c3daef View commit details
    Browse the repository at this point in the history

  3. Assume the default backend when not defined

    @RealOrangeOne
    RealOrangeOne committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    193a5c9 View commit details
    Browse the repository at this point in the history

  4. Bump last modified date 

    Lots has changed since Feb!
    @RealOrangeOne
    RealOrangeOne committed Apr 2, 2024
    Configuration menu
    Copy the full SHA
    d07a9ab View commit details
    Browse the repository at this point in the history

Commits on Apr 4, 2024

  1. Explicitly note swappable argument serialization is out of scope

    @RealOrangeOne
    RealOrangeOne committed Apr 4, 2024
    Configuration menu
    Copy the full SHA
    310460e View commit details
    Browse the repository at this point in the history

Commits on Apr 5, 2024

  1. Move primary enqueue APIs onto the task 

    This allows them to be statically typed, and avoids the need to import the Django methods all over the place.
    @RealOrangeOne
    RealOrangeOne committed Apr 5, 2024
    Configuration menu
    Copy the full SHA
    be6fa49 View commit details
    Browse the repository at this point in the history

Commits on Apr 19, 2024

  1. Allow passing a timedelta directly to run_after

    @RealOrangeOne
    RealOrangeOne committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    cbe24fe View commit details
    Browse the repository at this point in the history

  2. Avoid explicit count of included backends

    @RealOrangeOne
    RealOrangeOne committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    95b3205 View commit details
    Browse the repository at this point in the history

  3. Fix typo when defining example task backend

    @RealOrangeOne
    RealOrangeOne committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    7f314e8 View commit details
    Browse the repository at this point in the history

  4. Flesh out abstract

    @RealOrangeOne
    RealOrangeOne committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    f05a5f8 View commit details
    Browse the repository at this point in the history

  5. Restore id to task result

    @RealOrangeOne
    RealOrangeOne committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    54b4515 View commit details
    Browse the repository at this point in the history

  6. It's the result which is "got"

    @RealOrangeOne
    RealOrangeOne committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    74d2d7b View commit details
    Browse the repository at this point in the history

Commits on Apr 22, 2024

  1. Rename task validation function 

    This allows it to handle raising the exception itself, which makes errors more descriptive
    @RealOrangeOne
    RealOrangeOne committed Apr 22, 2024
    Configuration menu
    Copy the full SHA
    1c8d2f0 View commit details
    Browse the repository at this point in the history

  2. Give task result getter a more descriptive name

    @RealOrangeOne
    RealOrangeOne committed Apr 22, 2024
    Configuration menu
    Copy the full SHA
    c165ffd View commit details
    Browse the repository at this point in the history

  3. Expose the task's return value

    @RealOrangeOne
    RealOrangeOne committed Apr 22, 2024
    Configuration menu
    Copy the full SHA
    a141ba1 View commit details
    Browse the repository at this point in the history

Commits on Apr 26, 2024

  1. Rename TaskStatus enum 

    It's the `TaskResult` which has the status
    @RealOrangeOne
    RealOrangeOne committed Apr 26, 2024
    Configuration menu
    Copy the full SHA
    2379123 View commit details
    Browse the repository at this point in the history

Commits on May 13, 2024

  1. Number DEP 14 Background Workers.

    @carltongibson
    carltongibson authored May 13, 2024
    Configuration menu
    Copy the full SHA
    46be8f3 View commit details
    Browse the repository at this point in the history

  2. Improve wording for the reference implementation

    @RealOrangeOne
    RealOrangeOne committed May 13, 2024
    Configuration menu
    Copy the full SHA
    cecaf44 View commit details
    Browse the repository at this point in the history

  3. Clarify backwards compatibility with phased support

    @RealOrangeOne
    RealOrangeOne committed May 13, 2024
    Configuration menu
    Copy the full SHA
    a8e08a9 View commit details
    Browse the repository at this point in the history

Commits on May 29, 2024

  1. Mark DEP 0014 as "Accepted"

    @RealOrangeOne
    RealOrangeOne committed May 29, 2024
    Configuration menu
    Copy the full SHA
    d277b9d View commit details
    Browse the repository at this point in the history