return 503 for API if maintanence_mode is set to ture

Author: mkovalua

api/base/middleware.py

@@ -5,6 +5,7 @@
 from importlib import import_module
 
 from django.conf import settings
+from django.http import JsonResponse
 from django.contrib.sessions.middleware import SessionMiddleware
 from django.utils.deprecation import MiddlewareMixin
 from sentry_sdk import init
@@ -24,6 +25,7 @@
 from .api_globals import api_globals
 from api.base import settings as api_settings
 from api.base.authentication.drf import drf_get_session_from_cookie
+from osf.models import MaintenanceMode
 
 SessionStore = import_module(settings.SESSION_ENGINE).SessionStore
 
@@ -132,3 +134,22 @@ def process_request(self, request):
             request.session = drf_get_session_from_cookie(cookie)
         else:
             request.session = SessionStore()
+
+
+class MaintenanceModeMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        if request.path.endswith(('/v2', '/v2/')):
+            return self.get_response(request)
+        if MaintenanceMode.is_under_maintenance():
+            return JsonResponse(
+                {
+                    'meta': {
+                        'maintenance_mode': True,
+                        'status_page': 'status',
+                    },
+                }, status=503,
+            )
+        return self.get_response(request)

api/base/settings/defaults.py

@@ -232,6 +232,7 @@
     'django.middleware.common.CommonMiddleware',
     'django.middleware.csrf.CsrfViewMiddleware',
     'api.base.middleware.UnsignCookieSessionMiddleware',
+    'api.base.middleware.MaintenanceModeMiddleware',
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',

osf/migrations/0039_maintenancemode.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.2.26 on 2026-04-23 14:25
+
+from django.db import migrations, models
+
+
+def create_initial_record(apps, schema_editor):
+    MaintenanceMode = apps.get_model('osf', 'MaintenanceMode')
+    MaintenanceMode.objects.get_or_create(
+        pk=1,
+        defaults={'maintenance_mode': False}
+    )
+
+
+def reverse_initial_record(apps, schema_editor):
+    # the reverse 'reverse_initial_record' does nothing
+    # because the table will be removed
+    pass
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('osf', '0038_abstractnode_date_last_indexed_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='MaintenanceMode',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('maintenance_mode', models.BooleanField(default=False)),
+            ],
+        ),
+        migrations.RunPython(
+            create_initial_record,
+            reverse_code=reverse_initial_record
+        ),
+    ]

osf/models/__init__.py

@@ -52,7 +52,7 @@
 from .institution_affiliation import InstitutionAffiliation
 from .institution_storage_region import InstitutionStorageRegion
 from .licenses import NodeLicense, NodeLicenseRecord
-from .maintenance_state import MaintenanceState
+from .maintenance_state import MaintenanceState, MaintenanceMode
 from .metadata import GuidMetadataRecord
 from .metaschema import (
     FileMetadataSchema,

osf/models/maintenance_state.py

@@ -14,3 +14,16 @@ class MaintenanceState(models.Model):
     start = NonNaiveDateTimeField()
     end = NonNaiveDateTimeField()
     message = models.TextField(blank=True)
+
+
+class MaintenanceMode(models.Model):
+    maintenance_mode = models.BooleanField(default=False)
+
+    def save(self, *args, **kwargs):
+        self.pk = 1
+        super().save(*args, **kwargs)
+
+    @classmethod
+    def is_under_maintenance(cls):
+        obj, _ = cls.objects.get_or_create(pk=1)
+        return obj.maintenance_mode