Articles de blog

Comment implémenter un mode de maintenance dans une application web Django

Par brat-trebles-0z Publié: 13/08/2023 Évaluations: 4,5/5


L'intégration d'un mode de maintenance dans le processus de développement d'une application web s'apparente à l'installation d'un filet de sécurité sous un acte à fil élevé. Il s'agit d'une approche stratégique qui offre de nombreux avantages, assurant une expérience plus fluide et plus centrée sur l'utilisateur tout au long du cycle de vie de l'application. Le mode de maintenance fournit aux développeurs les moyens d'affiner, de mettre à jour et de dépanner leur création sans soumettre les utilisateurs à des interruptions ou des erreurs inattendues. Cette approche proactive reflète non seulement un engagement envers la qualité, mais améliore également la confiance des utilisateurs, minimise les temps d'arrêt et, en fin de compte, se traduit par une application web plus robuste et plus fiable. Dans ce post, nous visons à sauter dans les raisons impérieuses pour lesquelles avoir un mode de maintenance n'est pas seulement bon, mais primordial, pour le développement d'une application web réussie.

Pour cette démo, nous utiliserons Python (Django). Avant de commencer, nous supposons que vous avez installé Python 3 sur votre environnement. Dans un répertoire de votre choix, exécutez ce qui suit :

                                django-admin startproject maintenance_mode_app
                            

Maintenant, essayez d'aller dans ce répertoire et de configurer un environnement python, dans lequel nous allons installer quelques bibliothèques python, y compris django. Des instructions sur la façon de créer un environnement peuvent être trouvées ici. Dans cette démo, mon environnement s'appelle "venv". Ensuite, exécutez les commandes suivantes pour créer l'application de maintenance dans le projet. Cela créera un répertoire qui contiendra les "views" et les Urls ainsi que tous les autres fichiers python que nous devrons y créer pour mettre en place le mode de maintenance dans le projet.

                                source venv/bin/activate
                                pip3 install django
                                python3 manage.py startapp base_app
                                python3 manage.py startapp maintenance
                            

À ce stade, si vous exécutez une commande "tree" sur l'application maintenance_mode_app, vous devriez voir l'arborescence suivante :

Si nous xécutez la commande suivante à l'intérieur du répertoire maintenance_mode_app, nous devrions voir le projet servi sur une URL localhost. Le mien est servi à l'adresse http://localhost:8000, comme indiqué ci-dessous :

                                python3 manage.py runserver
                            

Vous pouvez suivre la même méthode que celle que nous utilisons pour créer la base_app et les applications de maintenance pour créer autant d'applications que nécessaire, en fonction des besoins de votre entreprise.

Nous avons maintenant créé l'application "maintenance" à l'intérieur de notre application et nous sommes prêts à créer un intergiciel pour elle. Créons un fichier middleware.py à l'intérieur du répertoire de maintenance et ajoutons-y le contenu suivant :

                                from django.shortcuts import reverse, redirect
                                from django.conf import settings


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

                                    def __call__(self, request):
                                        path = request.META.get('PATH_INFO', "")
                                        query = request.META.get('QUERY_STRING', "")

                                        if settings.MAINTENANCE_BYPASS_QUERY in query:
                                            request.session['bypass_maintenance'] = True

                                        if not request.session.get('bypass_maintenance', False):
                                            if settings.MAINTENANCE_MODE and path!= reverse("maintenance:maintenance"):
                                                response = redirect(reverse("maintenance:maintenance"))
                                                return response

                                            if not settings.MAINTENANCE_MODE and path == reverse("maintenance:maintenance"):
                                                response = redirect(reverse("base_app:index"))
                                                return response

                                        response = self.get_response(request)

                                        return response
                            

Ce que ce fichier dit au serveur, c'est de créer un intergiciel dans lequel nous acheminons toute nouvelle demande vers la page de maintenance si le mode de maintenance est activé et que le bypass_password n'est pas défini comme paramètre dans le navigateur. Alors, allons maintenant dans le fichier maintenance_mode_app/settings.py et enregistrons le service middleware. Ajoutez ce qui suit à la section MIDDLEWARE :

                                'maintenance.middleware.MaintenanceModeMiddleware'
                            

De plus, dans INSTALLED_APPS, ajoutons ce qui suit pour enregistrer les applications base_app et maintenance :

                                'base_app',
                                'maintenance'
                            

Ensuite, ce qui suit au bas du fichier settings.py. C'est ici que nous disons au middleware si le mode de maintenance est défini ou non en changeant de 0 à 1 et vice-versa :

                                MAINTENANCE_MODE = int(os.environ.get("MAINTENANCE_MODE", 0))
                                MAINTENANCE_BYPASS_QUERY = os.environ.get("MAINTENANCE_BYPASS_QUERY")
                            

Enfin, nous devrons ajouter une chose de plus à ce fichier, mais avant de le faire, dans le répertoire racine du projet, créons un répertoire appelé "modèles". C'est là que nous stockerons les fichiers HTML dont nous aurons besoin pour servir les pages nécessaires à cette démo. Une fois créé, nous revenons au fichier settings.py et apporterons la modification suivante au DIRS dans la section MODÈLES :

                                'DIRS': [os.path.join(BASE_DIR, 'templates')],
                            

Maintenant, nous sommes tous prêts du point de vue des paramètres du projet. Créons les "views" et les Urls pour les pages nécessaires. Dans le fichier base_app/views.py, ajoutons ce qui suit :

                                from django.shortcuts import render

                                def index(request):
                                    return render(request, 'base_app/index.html')
                            

Dans le fichier maintenance/views.py :

                                from django.shortcuts import render
                                from django.http import HttpResponse

                                def index(request):
                                    return HttpResponse('This is the homepage')

                                def maintenance(request):
                                    return render(request, 'maintenance/maintenance.html')
                            

Dans le fichier base_app/urls.py :

                                from django.urls import path
                                from . import views

                                app_name = 'base_app'

                                urlpatterns = [
                                    path('', views.index, name='index'),
                                ]
                            

Dans le fichier maintenance/urls.py :

                                from django.urls import path
                                from . import views

                                app_name = 'maintenance'

                                urlpatterns = [
                                    path('maintenance', views.maintenance, name='maintenance'),
                                ]
                            

Ensuite, nous enregistrons ces Urls dans l'application en ajoutant ce qui suit au fichier maintenance_mode_app/urls.py avant la fermeture ] :

                                path('', include('base_app.urls')),
                                path('maintenance/', include('maintenance.urls')),
                            

Enfin, nous créons 2 fichiers HMTL templates/base_app/index.html et templates/maintenance/maintenance.html comme suit :

                                <!DOCTYPE html>
                                <html lang="en">
                                    <head>
                                      <meta charset="UTF-8">
                                      <title>Homepage</title>
                                    </head>
                                    <body>
                                      <h1>Welcome</h1>
                                      <p>This is the home page and where the app should be rendered when served.</p>
                                    </body>
                                </html>
                            
                                <!DOCTYPE html>
                                <html lang="en">
                                    <head>
                                        <meta charset="UTF-8">
                                        <title>Maintenance mode</title>
                                    </head>
                                    <body>
                                        <h1>Maintenance mode</h1>
                                        <p>We are currently performing maintenance on this site and it will be available shortly. We apologize for any inconvenience. For urgent needs, please reach out to email@example.com</p>
                                    </body>
                                </html>
                            

Maintenant, si nous changeons le MODE DE MAINTENANCE de 0 à 1 dans le fichier settings.py, exécutez ce qui suit avant de redémarrer le serveur :

                                export MAINTENANCE_BYPASS_QUERY=bypass_password=maintenance
                            

Après avoir redémarré le serveur, si nous revenons à http://127.0.0.1:8000/ ou partout où vos serveurs commencent, vous devriez voir ce qui suit :

Cela montre que tout utilisateur essayant d'arriver à l'application serait dirigé vers la page de maintenance. En revanche, si nous revenons au navigateur et entrons à la place http://127.0.0.1:8000/? Bypass_password=maintenance, nous devrions voir la page d'index (page d'accueil) servie normalement, comme indiqué ci-dessous :

En fin de compte, si l'utilisateur fait partie de votre équipe DevOps ou de développement, il connaîtrait le mot de passe de maintenance, qui ne devrait bien sûr pas être uniquement le mot "maintenance", mais l'idée est que seuls les utilisateurs ayant le bon paramètre bypass_password peuvent accéder à l'application pendant la période de maintenance. Une fois la maintenance terminée, tout ce que vous avez à faire est de revenir au fichier settings.py et de revenir au paramètre à 0.

En conclusion, l'ajout d'un mode de maintenance à un site Web est important car il vous permet de mettre temporairement votre site hors ligne ou de restreindre l'accès aux utilisateurs tout en effectuant des mises à jour, des mises à niveau ou des correctifs. Cela permet d'assurer une expérience utilisateur fluide et d'éviter d'éventuelles erreurs ou interruptions pendant le processus de maintenance. Il communique également la transparence et le professionnalisme aux visiteurs, les informant que le site est en cours d'amélioration plutôt que d'être cassé.

Commentaires du blog

Par brat-trebles-0z · 13/08/2023