06 February 2010 AJAX, App_Offline, ASP.NET MVC, HowTo, Update Robert Muehsig

image Um eine ASP.NET Anwendung umzudaten ist es oftmals auch nötig bestimmt dlls auszutauschen. Dazu muss natürlich auch die Anwendung runtergefahren werden. Mit ASP.NET 2.0 kam ein nettes Feature hinzu: Das App_Offline.htm. Mit diesem File kann man neue Requests abfangen und auch für AJAX Calls gibt es einen Workaround.

App_Offline.htm

Legt man ein File namens "App_Offline.htm" in den Web-Root leitet der IIS alle neuen Requests an dieses File weiter. Damit ist es möglich, dass man Usern während des Update Prozesses eine Informationsseite zu präsentieren. Diese Updateseite wird mit dem HTTP Code 404 ausgeliefert.

"IE Problem"

Es soll wohl bei dem IE zu Problemen kommen, wenn die Updateseite zu klein ( kleiner als 512 byte ) ist - dann stellt der IE seine eigene Fehlerseite dar. Hier reicht es einfach das HTML durch Kommentare etc. "aufzublähen".
Hier das Beispiel von ScottGu:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >

<head>

    <title>Site Under Construction</title>

</head>

<body>

    <h1>Under Construction</h1>

 

    <h2>Gone to Florida for the sun...</h2>

   

<!--       

    Adding additional hidden content so that IE Friendly Errors don't prevent

    this message from displaying (note: it will show a "friendly" 404

    error if the content isn't of a certain size).

   

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2> 

    <h2>Gone to Florida for the sun...</h2>     

-->

</body>

</html>

Resultat

Wenn das File nun ins Webroot gelegt wird, wird nur das ausgegeben.

AJAX Problem

Was noch zu Problemen führen könnte wären WebApps in den AJAX eingesetzt wird. Die Webseite ist komplett geladen und der User klick fröhlich rum. Dann geht er einen Kaffee holen und in dieser Zeit aktualisieren wir die Anwendung. Jetzt wäre es natürlich schade wenn der nächste AJAX Call einfach nur ins Leere laufen würde - etwas schöner wäre ja, wenn man den Nutzer wenigstens sagt, dass die Anwendung gerade gewartet wird.

Lösung

Wie hier vorgeschlagen habe ich einfach einen besonderen HTML Kommentar in die Fehlerseite mit eingebaut:

<!--[AJAX_APP_OFFLINE_FLAG]-->   

Jetzt kann ich z.B. über ein globales AJAX Exception Handling schauen ob dieser "Flag" vorkommt und wenn ja eine nettere Fehlermeldung ausgeben:

$(document).ajaxError(function(e, xhr, settings, exception) {
            alert('Error!');

            var responseText = xhr.responseText;
            if (responseText.indexOf("<!--[AJAX_APP_OFFLINE_FLAG]-->") != -1) {
                alert("Site update in progress... keep cool :)");
            }
            else {
                alert('Real error! OMG!');
            }

        });

Resultat für den normalen Aufruf:

image

Resultat für AJAX Aufrufe:

image

image

Hinweis:

Damit der erste Aufruf bei euch funktioniert habe ich die "App_Offline.htm" mal in "xApp_Offline.htm" umbenannt.

Javascript und CSS Datein:

Sobald der IIS die App_Offline.htm entdeckt wird nur dieses File ausgeliefert. Somit kann man in der App_Offline.htm keine CSS Datei einbinden die in dieser Webapplikation liegt!

Frage in die Runde:

Wie ist eure Strategie wenn es um das Updaten von Anwendungen geht?

[ Download Democode ]


Written by Robert Muehsig

Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek.
Other Projects: KnowYourStack.com | ExpensiveMeeting | EinKofferVollerReisen.de

If you like the content and want to support me you could buy me a beer or a coffee via Litecoin or Bitcoin - thanks for reading!