Skip to content

checks

django_spire.history.activity.checks

ACTIVITY_MIDDLEWARE_PATH = 'django_spire.history.activity.middleware.ActivityUserMiddleware' module-attribute

AUTHENTICATION_MIDDLEWARE_PATH = 'django.contrib.auth.middleware.AuthenticationMiddleware' module-attribute

check_activity_bulk_managers

Source code in django_spire/history/activity/checks.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@checks.register(checks.Tags.models)
def check_activity_bulk_managers(
    app_configs: list[AppConfig] | None,
    **kwargs
) -> list[checks.CheckMessage]:
    _ = kwargs

    if app_configs is None:
        model_list = apps.get_models()
    else:
        model_list = [
            model
            for app_config in app_configs
            for model in app_config.get_models()
        ]

    warnings = []

    for model in model_list:
        if not issubclass(model, ActivityMixin):
            continue

        queryset_class = getattr(model._default_manager, '_queryset_class', None)

        if queryset_class is not None and issubclass(queryset_class, HistoryQuerySet):
            continue

        warnings.append(_bulk_manager_warning(model))

    return warnings

check_activity_middleware

Source code in django_spire/history/activity/checks.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
@checks.register(checks.Tags.compatibility)
def check_activity_middleware(
    app_configs: list[AppConfig] | None,
    **kwargs
) -> list[checks.CheckMessage]:
    _ = app_configs
    _ = kwargs

    middleware = list(getattr(settings, 'MIDDLEWARE', None) or [])

    if ACTIVITY_MIDDLEWARE_PATH not in middleware:
        warning = checks.Warning(
            'ActivityUserMiddleware is not in MIDDLEWARE, so no activity records '
            'will be created for requests.',
            hint=(
                f"Add '{ACTIVITY_MIDDLEWARE_PATH}' to MIDDLEWARE "
                f"after '{AUTHENTICATION_MIDDLEWARE_PATH}'."
            ),
            id='django_spire_history_activity.W001',
        )

        return [warning]

    if AUTHENTICATION_MIDDLEWARE_PATH not in middleware:
        return []

    activity_index = middleware.index(ACTIVITY_MIDDLEWARE_PATH)
    authentication_index = middleware.index(AUTHENTICATION_MIDDLEWARE_PATH)

    if activity_index < authentication_index:
        warning = checks.Warning(
            'ActivityUserMiddleware is listed before AuthenticationMiddleware, so '
            'request.user is not populated when the activity user is captured.',
            hint=(
                f"Move '{ACTIVITY_MIDDLEWARE_PATH}' after "
                f"'{AUTHENTICATION_MIDDLEWARE_PATH}' in MIDDLEWARE."
            ),
            id='django_spire_history_activity.W002',
        )

        return [warning]

    return []