WSGI middleware concept in Flask

Introduction

WSGI middleware helps add extra features to web apps without changing their main code. It acts like a helper that sits between the web server and your app.

You want to log every request and response in your web app.

You need to add security checks before your app handles requests.

You want to modify requests or responses, like adding headers.

You want to handle errors globally in one place.

You want to compress responses to make them faster to send.

Syntax

Flask

class Middleware:
    def __init__(self, app):
        self.app = app

    def __call__(self, environ, start_response):
        # Code before calling the app
        response = self.app(environ, start_response)
        # Code after calling the app
        return response

The app parameter is the original WSGI app your middleware wraps.

The __call__ method makes the middleware behave like a WSGI app.

Examples

This middleware prints messages before and after the app runs.

Flask

class SimpleMiddleware:
    def __init__(self, app):
        self.app = app

    def __call__(self, environ, start_response):
        print('Before app')
        response = self.app(environ, start_response)
        print('After app')
        return response

This middleware adds a custom header to every response.

Flask

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

    def __call__(self, environ, start_response):
        def custom_start_response(status, headers, exc_info=None):
            headers.append(('X-Custom-Header', 'Hello'))
            return start_response(status, headers, exc_info)
        return self.app(environ, custom_start_response)

Sample Program

This Flask app uses a simple WSGI middleware that prints messages before and after the app handles a request. When you visit the home page, you see the message from Flask, and the console shows the middleware messages.

Flask

from flask import Flask, Response

class SimpleMiddleware:
    def __init__(self, app):
        self.app = app

    def __call__(self, environ, start_response):
        print('Middleware before app')
        response = self.app(environ, start_response)
        print('Middleware after app')
        return response

app = Flask(__name__)

@app.route('/')
def home():
    return Response('Hello from Flask!')

app.wsgi_app = SimpleMiddleware(app.wsgi_app)

if __name__ == '__main__':
    app.run(debug=False)

Important Notes

Middleware can change requests or responses but should be simple to avoid slowing down your app.

Order matters: middleware wraps the app in the order you assign them.

Use middleware for cross-cutting tasks like logging, security, or compression.

Summary

WSGI middleware sits between the server and your Flask app to add extra features.

It works by wrapping the app and intercepting requests and responses.

Middleware is useful for logging, security, modifying headers, and more.

Practice

1. What is the main role of WSGI middleware in a Flask application?

easy

A. To serve static files directly to the client

B. To replace the Flask app entirely

C. To sit between the server and the Flask app to modify requests or responses

D. To handle database connections automatically

Solution

1. Step 1: Understand WSGI middleware position

   WSGI middleware acts as a layer between the web server and the Flask app, intercepting requests and responses.

2. Step 2: Identify middleware purpose

   It modifies or adds features like logging or security without replacing the app or handling unrelated tasks.

3. Final Answer:

   To sit between the server and the Flask app to modify requests or responses -> Option C

4. Quick Check:

   Middleware = intercepts requests/responses [OK]

Hint: Middleware wraps app to add features between server and app [OK]

Common Mistakes:

• Thinking middleware replaces the app
• Confusing middleware with static file serving
• Assuming middleware manages database connections

2. Which of the following is the correct way to wrap a Flask app with WSGI middleware named MyMiddleware?

easy

A. app = MyMiddleware(app)

B. app = app.MyMiddleware()

C. MyMiddleware(app)

D. app.middleware = MyMiddleware

Solution

1. Step 1: Recall middleware wrapping syntax

   WSGI middleware wraps the Flask app by passing the app instance to the middleware constructor.

2. Step 2: Match correct syntax

   The correct syntax is assigning the wrapped app back to app using app = MyMiddleware(app).

3. Final Answer:

   app = MyMiddleware(app) -> Option A

4. Quick Check:

   Wrap app by passing it to middleware constructor [OK]

Hint: Wrap app by calling middleware with app as argument [OK]

Common Mistakes:

• Calling middleware as a method on app
• Not assigning wrapped app back to a variable
• Assigning middleware class without instantiation

3. Given this WSGI middleware code wrapping a Flask app, what will be printed when a request is made?

class SimpleMiddleware:
    def __init__(self, app):
        self.app = app
    def __call__(self, environ, start_response):
        print('Before app')
        response = self.app(environ, start_response)
        print('After app')
        return response

app = Flask(__name__)
app = SimpleMiddleware(app)

medium

A. No output is printed

B. Only Before app is printed

C. Only After app is printed

D. Before app printed before request, After app printed after request

Solution

1. Step 1: Analyze middleware call flow

   The middleware prints 'Before app' before calling the wrapped app, then prints 'After app' after the app returns.

2. Step 2: Understand request handling

   When a request comes, both print statements execute in order around the app call.

3. Final Answer:

   Before app printed before request, After app printed after request -> Option D

4. Quick Check:

   Middleware prints before and after app call [OK]

Hint: Middleware __call__ runs code before and after app call [OK]

Common Mistakes:

• Assuming only one print runs
• Thinking prints happen asynchronously
• Confusing middleware with Flask route handlers

4. Identify the error in this WSGI middleware implementation:

class BrokenMiddleware:
    def __init__(self, app):
        self.app = app
    def __call__(self, environ, start_response):
        # Forgot to call the wrapped app
        return 'Hello'

medium

A. Middleware must call the wrapped app and return its response

B. Middleware should not have an __init__ method

C. Middleware should return a Flask response object, not a string

D. Middleware must not accept environ and start_response parameters

Solution

1. Step 1: Check middleware call method

   The __call__ method must call the wrapped app with environ and start_response to get the response.

2. Step 2: Identify missing call

   This code returns a string directly and does not call the wrapped app, breaking the WSGI chain.

3. Final Answer:

   Middleware must call the wrapped app and return its response -> Option A

4. Quick Check:

   Middleware must call wrapped app [OK]

Hint: Middleware must call and return wrapped app response [OK]

Common Mistakes:

• Returning a string instead of calling app
• Removing __init__ method unnecessarily
• Misunderstanding WSGI call signature

5. You want to add a WSGI middleware to your Flask app that adds a custom header X-Custom-Header: Hello to every response. Which approach correctly implements this?

hard

A. Wrap the app and modify the start_response to add the header after calling the app

B. Wrap the app and modify the start_response to add the header before calling the app

C. Modify the Flask app routes to add the header manually in each view

D. Add the header in the middleware by modifying the response iterable directly without start_response

Solution

1. Step 1: Understand start_response role

   start_response is a callable that sets HTTP status and headers before the response body is sent.

2. Step 2: Add header by wrapping start_response

   Middleware should wrap start_response to add the custom header before passing it to the app, so when the app calls it, the header is added.

3. Final Answer:

   Wrap the app and modify the start_response to add the header before calling the app -> Option B

4. Quick Check:

   Add headers by wrapping start_response before app call [OK]

Hint: Wrap start_response to add headers before app call [OK]

Common Mistakes:

• Adding headers after calling app (too late, start_response already called by app)
• Modifying response iterable directly (not standard for headers)
• Changing all routes instead of middleware