Async middleware in Django - Mini Project: Build & Apply

Async Middleware in Django

📖 Scenario: You are building a Django web application that needs to log the time taken to process each request asynchronously. This helps improve performance by not blocking the main thread.

🎯 Goal: Create an async middleware in Django that measures and logs the time taken for each HTTP request.

📋 What You'll Learn

Create an async middleware class named TimingMiddleware

Add an async __call__ method to handle requests

Use time.perf_counter() to measure request duration

Log the duration after the response is generated

Ensure the middleware calls the next middleware or view asynchronously

💡 Why This Matters

🌍 Real World

Async middleware helps improve web app performance by handling tasks like logging or authentication without blocking the main thread.

💼 Career

Understanding async middleware is important for building scalable Django applications that efficiently handle many simultaneous users.

1

Create the async middleware class

Create a class called TimingMiddleware in middleware.py with an __init__ method that accepts get_response and stores it as self.get_response.

Django

class TimingMiddleware:
    def __init__(self, get_response):
        # Your code here

Hint

The __init__ method stores the next callable in the middleware chain.

2

Add the async __call__ method

Add an async __call__ method to TimingMiddleware that accepts request and returns a response by awaiting self.get_response(request).

Django

class TimingMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    async def __call__(self, request):
        # Your code here

Hint

The __call__ method must be async and await the next middleware or view.

3

Measure request processing time

Inside the async __call__ method, import time and use time.perf_counter() to record the start time before awaiting self.get_response(request) and the end time after. Calculate the duration as end - start.

Django

import time

class TimingMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    async def __call__(self, request):
        # Your code here

Hint

Use time.perf_counter() to get precise timing before and after the request.

4

Log the request duration

After calculating duration in the async __call__ method, import logging and use logging.info to log the message f"Request took {duration:.4f} seconds". Then return the response.

Django

import time
import logging

class TimingMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    async def __call__(self, request):
        start = time.perf_counter()
        response = await self.get_response(request)
        end = time.perf_counter()
        duration = end - start
        # Your code here

Hint

Use logging.info to output the duration message.

Practice

1. What is the main benefit of using async middleware in Django?

easy

A. It allows Django to handle requests without waiting, improving speed.

B. It automatically caches all responses for faster loading.

C. It replaces the need for database queries.

D. It disables middleware for static files.

Solution

1. Step 1: Understand async middleware purpose

   Async middleware lets Django process requests without blocking, so it can handle other tasks simultaneously.

2. Step 2: Compare options

   Only It allows Django to handle requests without waiting, improving speed. correctly describes this benefit. Options A, C, and D describe unrelated or incorrect behaviors.

3. Final Answer:

   It allows Django to handle requests without waiting, improving speed. -> Option A

4. Quick Check:

   Async middleware improves speed by non-blocking handling [OK]

Hint: Async means non-blocking, so it improves request handling speed [OK]

Common Mistakes:

• Thinking async middleware caches responses
• Confusing async middleware with database optimization
• Assuming async disables middleware for static files

2. Which of the following is the correct way to define an async middleware __call__ method in Django?

easy

A. async def __call__(self, request): response = await self.get_response(request); return response

B. def __call__(self, request): response = await self.get_response(request); return response

C. def __call__(self, request): return self.get_response(request)

D. async def __call__(self, request): return self.get_response(request)

Solution

1. Step 1: Identify async method syntax

   The method must be declared with async def to use await inside.

2. Step 2: Check usage of await

   Only async def __call__(self, request): response = await self.get_response(request); return response correctly uses await with self.get_response(request) inside an async method.

3. Final Answer:

   async def __call__(self, request): response = await self.get_response(request); return response -> Option A

4. Quick Check:

   Async method with await = async def __call__(self, request): response = await self.get_response(request); return response [OK]

Hint: Async methods need async def and await inside [OK]

Common Mistakes:

• Using await inside a non-async function
• Missing await when calling async get_response
• Defining __call__ without async keyword

3. Given this async middleware snippet, what will be printed when a request is processed?

class LogMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    async def __call__(self, request):
        print('Before response')
        response = await self.get_response(request)
        print('After response')
        return response

medium

A. No output printed due to async

B. Only Before response printed, then returns

C. Only After response printed, then returns

D. Before response printed, then After response printed after response

Solution

1. Step 1: Analyze print statements order

   The middleware prints 'Before response' before awaiting the response, then prints 'After response' after awaiting.

2. Step 2: Understand async call flow

   Await pauses until response is ready, so both prints happen in order around the response.

3. Final Answer:

   Before response printed, then After response printed after response -> Option D

4. Quick Check:

   Print before and after await = Before response printed, then After response printed after response [OK]

Hint: Print before and after await shows both messages in order [OK]

Common Mistakes:

• Thinking async prevents print output
• Assuming only one print runs
• Confusing order of prints around await

4. Identify the error in this async middleware code:

class HeaderMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    async def __call__(self, request):
        response = self.get_response(request)
        response['X-Custom'] = 'Value'
        return response

medium

A. Async __call__ cannot return response

B. Cannot modify response headers in middleware

C. Missing await before self.get_response(request)

D. Missing async keyword in __init__

Solution

1. Step 1: Check async call to get_response

   Since __call__ is async, get_response must be awaited if it returns a coroutine.

2. Step 2: Identify missing await

   The code calls self.get_response(request) without await, causing a coroutine object instead of response.

3. Final Answer:

   Missing await before self.get_response(request) -> Option C

4. Quick Check:

   Async call needs await before get_response [OK]

Hint: Await async calls inside async methods [OK]

Common Mistakes:

• Forgetting await on async get_response
• Thinking response headers can't be changed
• Adding async to __init__ method

5. You want to create async middleware that adds a custom header only if the response status is 200. Which code snippet correctly implements this?

hard

A. async def __call__(self, request):
response = await self.get_response(request)
response['X-Status'] = 'OK'
return response

B. async def __call__(self, request):
response = await self.get_response(request)
if response.status_code == 200:
response['X-Status'] = 'OK'
return response

C. async def __call__(self, request):
response = self.get_response(request)
if response.status_code == 200:
response['X-Status'] = 'OK'
return response

D. def __call__(self, request):
response = self.get_response(request)
if response.status_code == 200:
response['X-Status'] = 'OK'
return response

Solution

1. Step 1: Confirm async __call__ and await usage

   The method must be async and await the get_response call to get the response object.

2. Step 2: Check conditional header addition

   Only async def __call__(self, request): response = await self.get_response(request) if response.status_code == 200: response['X-Status'] = 'OK' return response adds the header conditionally when status_code is 200, matching the requirement.

3. Final Answer:

   async def __call__(self, request): response = await self.get_response(request); if response.status_code == 200: response['X-Status'] = 'OK'; return response -> Option B

4. Quick Check:

   Async call with await and conditional header = async def __call__(self, request): response = await self.get_response(request) if response.status_code == 200: response['X-Status'] = 'OK' return response [OK]

Hint: Use async def with await and check status before adding header [OK]

Common Mistakes:

• Not awaiting get_response in async method
• Adding header unconditionally
• Defining __call__ as sync when async needed