Silverlight et Log4Net

La thématique de l'outil de traces est ancienne comme le monde des développeurs. Il faut toujours pouvoir tracer son programme et retirer ces traces au moment du déploiement.

Alors parmi tous les outils de traces mon regard se tourne vers Log4Net et puis-je l'utiliser avec Silverlight ?

Un bon tutoriel mais en anglais ici.

La page la plus intéressante sur ce sujet pour moi, se trouve ici. On y apprend que l'on ne pourra pas utiliser directement Log4Net avec Silverlight car aucune des builds n'est réalisée avec ce framework : Log4Net Supported Frameworks.

Qu'il est inutile de tenter de compiler les sources de Log4Net avec Silverlight, étant donné les restrictions de ce dernier, il n'est pas possible d'avoir accès au système de fichiers côté client et donc de créer un fichier de logs.

On y donne également le début d'une solution : Utiliser l'application ASP.NET qui host le .xap de Silverlight pour faire une référence à la DLL log4net. Vous n'avez plus qu'à développer un service web qui permettra à Silverlight d'utiliser Log4Net.

Voici donc le projet :
Une Business application for Silverlight 5.0
Une Asp.net application qui host le .xap et qui aura une référence sur la dll log4net.
Un WCF Service dans l'application asp.net que l'on va rendre utilisable depuis Silverlight.
Le tout pour faire des Logs dans un fichier texte.

Silverlight Business Application for Log4Net

Je créé une application Business pour Silverlight que je nomme BusinessApplicationLog4Net :

Silverlight Business Application BusinessApplicationLog4Net
Je créé une référence à la DLL log4Net que j'ai installée :


Référence à log4net dans mon projet BusinessApplicationLog4Net

ASP.NET Business Application and Log4Net afficher des traces

Installation d'un bouton et d'un TextBox dans l'application asp.net afin de faire des logs.

Dans la Silverlight Business Application, derrière la page BusinessApplicationLog4NetTestPage.aspx il n'y a pas de code behind, je souhaite pourtant faire des logs à partir d'un bouton de cette page. Je une nouevelle page BusinessApplicationLog4NetTestPage.aspx cette fois avec son code behing et je copie le cope nécessaire l'embarquement du .xap. Je peux ainsi ajouter mon bouton et déclencher du code derrière :

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.IO;
using System.Collections;

// Here is the once-per-application setup information
[assembly: log4net.Config.XmlConfigurator(Watch = true)]

namespace BusinessApplicationLog4Net.Web
{
    public partial class BusinessApplicationLog4NetTestPage : System.Web.UI.Page
    {
        // Should be declared for each class
        private static readonly log4net.ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

        protected void Page_Load(object sender, EventArgs e)
        {
            log.Debug("Page Loaded");
        }

        private static int nbLogs = 0;

        protected void ButtonMakeLog_Click(object sender, EventArgs e)
        {
            log.Debug("ButtonMakeLog_Click");
            TextBoxLog.Text = "nbLog " + nbLogs.ToString();
            log.Debug(TextBoxLog.Text);
            nbLogs++;
        }
    }
}

Pour faire des logs il me faut encore trois choses :
le déclenchement d'une fonction d'assembly XmlConfigurator
la déclaration d'une variable log
l'appel à la fonction log que je fais depuis la page Page_Load

ASP.NET and Log4Net web.config

Remarque importante :
Je me suis égaré en lisant le tutoriel dans la création d'un fichier de configuration pour Log4Net à part : Log4Net.config mais cela ne fonctionnait pas.
Il faut avoir à l'esprit les limitations des applications asp.net qui sont sécurisées et mon application ne trouvait jamais le fichier Log4Net.config je pris donc le parti de configurer mon Log4Net dans le fichier Web.config

Pour les logs, je créé un répertoire Log auxquels je donne accès à "Tout le monde".
Et je lance mon application :

Silverlight Business Application for Log4Net
Et maintenant pour afficher mes logs, je tape l'url suivante :

http://localhost:52878/Log/log.txt

Et les logs s'affichent dans mon navigateur :

ASP.NET Business Application afficher les logs

WCF Service for Service references in RIA application

Pour que mon application Silverlight puisse elle aussi faire des logs avec Log4Net, je créé un WCF Service hosté par mon application ASP.NET que je nomme ServiceLogger :

WCF Service Logger
Je ne fais pas le détail du code, vous pourrez télécharger ce code source en bas de cet article.

Pour utiliser ce service dans mon application Siverlight il faut lui ajouter une Service Refrence :
Silverlight Application Add Service Reference
En suite je clique sur "Discover" pour découvrir les Services installés au sein de ma solution :


Pour découvrir les fonctionnalités de mon service, je clique sur ServiceLogger.svc et là je tombe sur l'erreur :

WCF Service Hosted by ASP.NET application - Error while attempting to find services
La solution détaillée de cette erreur se trouve Ici.

Une fois les lignes :

using System.ServiceModel.Activation;

[AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]

Ajoutées dans mon services, et :
Remarque importante : La création de WCF Services comme bien d'autres objets entraîne du code généré afin de le mettre à jour ne pas hésiter à "Cleaner" la solution.

J'obtiens enfin mon ServiceReference que je nomme "ServiceLogger" :

Silverlight WCF Ria Services 

Silverlight make logs using Service References

Je rajoute un bouton et un textbox dans la page home de mon application Silverlight. 
Le code de mon bouton est le suivant :

        private int nbLogs = 0;

        private void buttonMakeLog_Click(object sender, System.Windows.RoutedEventArgs e)
        {
            var log = new ServiceLogger.ServiceLoggerClient();
            log.LogMessageAsync("Click on button will produced log on server" + nbLogs.ToString());

            textBox.Text = "log " + nbLogs.ToString();
            nbLogs++;
        }

Je l'exécute et je joue un peu avec :

Silverlight utilise un Service Reference et Log4Net pour afficher des traces
Et j'affiche mes traces :

Grâce à Log4Net mon application Silverlight fait des traces dans ASP.NET

Conclusion

Oui c'est délicat de mettre en oeuvre l'ensemble de ces technologies surtout avec Silverlight et ASP.NET. Au début du projet, on ne peut pas être certain d'aboutir puis on trouve des astuces des contournements. En développant il faut bien garder à l'esprit les différentes limitations des applications Silverlight et ASP.NET en général c'est cela qui permet de trouver une solution.

Download Source Code

Requirements :
Visual Studio 2010
Silverlight 5.0
Log4Net

Download Source Code





Silverlight - Service References - Error while attempting to find services

Mais qu'elle est donc cette erreur !?

"An error occured while attempting to find services at 'http://localhost/ServiceLogger.svc'"

Contexte de l'erreur

Je cherche à faire des logs avec Log4Net depuis une application Silverlight. J'ai créé une "Business Application Silverlight" hostée par une application ASP.NET. Je développe mon service de Log dans BusinessApplicationLog4Net.Web et par l'intermédiaire d'un "Service Reference", je donnerai accès aux services de Log dans mon application Silverlight (ou du moins je l'espère) :

ASP.NET qui host un WCF Service pour une application Silverlight
Dans l'application Silverlight, je fais "Add Service Reference ..."

Siverlight hosted application - Add Service Reference
Mais au moment de découvrir les Services mis à disposition par l'application ASP.NET, avec Siverlight une erreur survient :

Siverlight - Add Servcice Reference ... - An error occured while attempting to find services
Comme je l'ai déjà indiqué et que lorsque l'on utilise les Services du code est généré il faut donc cleaner rebuilder mais rien n'y fait !

Solution ?

Dans le fichier ASP.NET Web.config :

  <system.serviceModel>
    <behaviors>
      <serviceBehaviors>
        <behavior name="">
          <serviceMetadata httpGetEnabled="true" />
          <serviceDebug includeExceptionDetailInFaults="false" />
        </behavior>
      </serviceBehaviors>
    </behaviors>
    <serviceHostingEnvironment aspNetCompatibilityEnabled="false" 
                               multipleSiteBindingsEnabled="true" />
  </system.serviceModel>

Je propose de mettre aspNetCompatibilityEnabled à false. Pourquoi ? Tout simplement parce que j'ai cherché et trouver cette préconisation, également en regardant le détail de cette erreur :

Silverlight - Service Reference - AspNetCompatibility Error
Cette fois mon Service est enfin découvert :

Siverlight - Add Servcice Reference ... - Mon service est enfin découvert
Tout de même cela me parait curieux, je devrais rendre mon Hosting Services Environment incompatible avec ASP.NET pour l'utiliser dans Siverlight ...

Je lance l'application :

Siverlight - aspNetCompatibilityEnabled à false
Quelle belle erreur ! Toutes ces applications demandent que l'utilisateur soit ou non authentifié et le service d'authentification de Silverlight dans ce cas ne reconnait plus mon utilisateur.

C'est perdu !

Conclusion

Et c'est bien dommage car en câblant un bouton sur la View Home de mon application Silverlight :

\\BusinessApplicationLog4Net\BusinessApplicationLog4Net\Views\Home.xaml.cs :

        private void buttonMakeLog_Click(object sender, System.Windows.RoutedEventArgs e)
        {
            var log = new ServiceLogger.ServiceLoggerClient();
            log.LogMessageAsync("click on button produced log on server");

            textBox.Text = "log " + nbLogs.ToString();
            nbLogs++;
        }

Si je clique sur "Ok" et sur mon mon bouton en ayant pris soin de mettre un point d'arrêt dans l'application ASP.NET :

Point d'arrêt dans l'application ASP.NET qui hoste le Service Logger
Clique sur le bouton Make Logs
Clique sur le bouton pour déclencher la méthode buttonMakeLog_Click() de l'application Silverlight qui déclenche un log à travers le service et dans l'application ASP.NET.

Le point d'arrêt est bien déclenché
Je ne dois pas être si loin, je vais continuer à trouver ...

Et comme je suis un fou furieux, en tous cas un curieux et maintenant que le code de mon service est généré dans Silverlight, je remets aspNetCompatibilityEnabled à true et j'exécute cette fois l'erreur est la suivante :

dans :

\\BusinessApplicationLog4Net\BusinessApplicationLog4Net\Service References\ServiceLogger\Reference.cs

j'obtiens :

Cette fois le Log ne sort plus de Silverlight

Solution

Il faut utiliser l'attribut de la Class :

    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class ServiceLogger : IServiceLogger

Pour que cela fonctionne.



Silverlight et Reporting Services (2/2)

Vous êtes peut-être comme moi, resté sur votre fin lors de l'exploration de l'exemple d'Ernesto Herrera sur les Silverlight et Reporting Services. Alors allons plus loin dans le détail des explications du fonctionnement de cette application.

Rappel sur les applications Silverlight et ASP.NET

C'est l'application Web ASP.NET qui Host l'application Silverlight grâce à la page :
ReportingServicesDemoTestPage.aspx
et la ligne :
<param name="source" value="ClientBin/ReportingServicesDemo.xap"/>

Ainsi lorsque vous exécutez l'application dans un navigateur, l'url qui s'affiche est :
http://localhost:52878/ReportingServicesDemoTestPage.aspx#/Home

Et vous obtenez le résultat d'exécution de l'application Silverlight dans la page web Host,
de la façon suivante :

Exécution de l'application Silverlight et Reporting Services dans Chrome
Nous avons configuré "Reporting Services" dans la page de notre application Web ASP.NET : RpDemoWebForm.aspx, ainsi lorsque l'on clique sur un "Sales Order ID" par exemple le "71774", une fenêtre popup s'affiche pour montrer le détail d'un ordre de vente dans un rapport "Reporting Service". Cette fois il s'agit d'une simple page web qui affiche le rapport et l'on obtient le résultat de l'exécution suivant :

Silverlight et les Reporting Services  - Détails d'une vente

Silverlight WCF RIA Services - RIA Control Navigation Page

Comment tout ceci fonctionne t-il ? Attardons nous sur la navigation page Silverlight qui affiche la Grid et découvrons cette page. Ernesto Herrera dit qu'il a simplement ajouter une DataGrid dans la page Home du projet : ReportingServicesDemo\Views\Home.xaml

En fait il fait bien plus que cela :

Page Home Silverlight qui utilise le DomainDataSource pour afficher les données dans une DataGrid
Il a donc ajouté à la page également un riaControls:DomainDataSource.

Cette page Silverlight possède une petite icône de BD dans la colonne de gauche.

Il y a deux balises remarquables "riaControls:DomainDataSource" et "my:ADWLTDomainContext" ce sont ces deux balises qui donnent le résultat de la petite icône BD dans la colonne gauche.

En sélectionnant la balise "ADWLTDomainContext" j'obtiens le résultat graphique suivant :

ADWLTDomainContext - DomainDataSource du Services RIA WCF
L'icône de BD est sélectionnée.

Ajout de riaControls dans la page Silverlight

A fin d'ajouter le riaControls vers le DomainContext vous devez ajouter dans la page Home.xaml les deux XML Name Space :

  xmlns:riaControls="clr-namespace:System.Windows.Controls;assembly=System.Windows.Controls.DomainServices
  xmlns:domain="clr-namespace:ReportingServicesDemo.Web"

Dans le projet, ajoutez une référence à : System.Windows.Controls.DomainServices

Pour cela vous devez avoir installé le  SDK : RIA Services
Vérification de l'installation du SDK dans :
C:\Program Files\Microsoft SDKs\RIA Services\v1.0\

Et sinon vous pouvez l'installer Ici.

En suite toujours dans la page Home.xaml, on ajoute le code :

                <riaControls:DomainDataSource 
                    AutoLoad="True" 
                    d:DesignData="{d:DesignInstance domain:SalesOrderHeader, CreateList=true}" 
                    Height="0" 
                    LoadedData="salesOrderHeaderDomainDataSource_LoadedData" 
                    Name="salesOrderHeaderDomainDataSource" 
                    QueryName="GetSalesOrderHeaderQuery" 
                    Width="0">
                    <riaControls:DomainDataSource.DomainContext>
                        <domain:ADWLTDomainContext />
                    </riaControls:DomainDataSource.DomainContext>
                </riaControls:DomainDataSource>

A la compilation une erreur :

Error 1
The tag 'ADWLTDomainContext' does not exist in XML namespace 'clr-namespace:ReportingServicesDemo.Web'.

Cette erreur semble nous indiquer que le domain services n'a pas été créé dans ReportingServicesDemo.Web. En effet dans l'application de référence on peut constater l'existence de deux fichiers :

Création du WCF RIA Services

Création de la DataSource du DomainContext

Il s'agit d'une erreur ou bien d'un problème de version mais dans le projet 
d'Ernesto Herrera les deux fichiers :

ADWLTDomainService.cs
ADWLTDomainService.metadata.cs

Sont dans le répertoire racine, tandis que si on les déplace dans le répertoire Services et que l'on fait :

Visual Studio - Show Data Sources
Un répertoire \\ReportingServicesDemo\ReportingServicesDemo\Properties\DataSources est créé il contient le fichier : ReportingServicesDemo.Web.ADWLTDomainContext.datasource généré automatiquement.

Et pourtant mon application ne fonctionne toujours pas !

Silverlight WCF RIA Services Error NotFound !
C'est un piège dans lequel on tombe parfois avec Visual Studio et tout le code généré automatiquement mais les fichiers .datasource ne sont pas le problème. Dans ce cas je préconise de recommencer l'application à zéro.

Je créé une Business Application Silverlight 5.0
J'importe la base AdventureWorksLT2008_Data.mdf dans App_Data
Je recommence mon Modèle Entity, je n'inclus que les tables
Pour changer un peu je vais me passer de la Class Orders.cs et j'attaque directement SalesOrderDetail ma Query Link s'écrit donc :

        public IQueryable<SalesOrderDetail> GetOrderDetails(int OrderID)
        {
            AdventureWorksLT2008_DataEntities adw = new AdventureWorksLT2008_DataEntities();

            var query = from c in adw.SalesOrderDetail.Include("Product")
                        where c.SalesOrderID == OrderID
                        select new SalesOrderDetail
                        {
                            //SalesOrderID = OrderID,
                            //SalesOrderDetailID = c.SalesOrderDetailID,
                            //ProducName = c.Product.Name, // BRY 
                            //OrderQty = c.OrderQty,
                            UnitPrice = c.UnitPrice //,
                            //UnitPriceDiscount = c.UnitPriceDiscount,
                            //LineTotal = c.LineTotal
                        };

            return query;
        }

Et l'application tombe en marche mais lorsque je clique sur le bouton me permettant de voir les détails d'un ordre :

Reporting Services - Error to LINQ Entity

Le DomainContext est généré automatiquement dans :
BusinessApplicationReportingServices\BusinessApplicationReportingServices
\Generated_Code\BusinessApplicationReportingServices.Web.g.cs

Alors je réécris ma query linq, le plus simplement du monde :

        public IQueryable<SalesOrderDetail> GetMyOrderDetails(int OrderID)
        {
            AdventureWorksLT2008_DataEntities adw = new AdventureWorksLT2008_DataEntities();

            var query = from c in adw.SalesOrderDetail//.Include("Product")
                        where c.SalesOrderID == OrderID
                        select c;
            return query;
        }

Et le tout tombe en marche :

Silverlight - Reporting Services

Conclusion

DomaineServices, Reporting Services et Silverlight cela parait tout simple mais les pièges sont nombreux notamment à cause de tout ce code généré il faut souvent rebuilder, mettre à jour les schémas parfois cleaner  pour que la solution fonctionne finalement.

Finalement :
Je réintègre la class Orders.cs pour effectuer la jointure je réécris le Report Services pour obtenir le résultat suivant :

Exécution de l'application Silverlight WCF RIA - Reporting Services

Exécution de l'application Silverlight WCF RIA - Reporting Services - Détails d'un ordre de vente

Download Source Code

Requirements :
Visual Studio 2010 SP1
Reporting Services
WCF Ria Services for Silverlight 5.0
SQL Server EXPRESS 2008








Silverlight et Reporting Services (1/2)

Voilà un sujet qu'il est très intéressant, laissons de côté le choix de Crystal Report ou de Reporting Services avec une page de lecture Ici.

Alors comment réaliser une intégration rapide avec une couche présentation Silverlight, un accès aux données Entity Framework et des Reporting Services aux milieu de tout cela.

Je base mon exploration sur l'exemple du site CodeProject :
http://www.codeproject.com/Articles/97452/Integrate-Reporting-Services-with-Silverlight-and
Integrate Reporting Services with Silverlight and RIA Services

Dans le Projet ReportingServicesDemo.Web le répertoire App_Data est vide !
Mais où est la BD ? C'est toujours le même problème avec SQL Server les .mdf ne sont jamais livrés et vous trouvez cela normal ?

J'ouvre le fichier Web.config pour inspecter la partie "connectionStrings" du projet et là je peux lire :
Data Source=WSCORSIS032\SQLSERVER08;Initial Catalog=AdventureWorksLT2008;

Cela ne risque pas de fonctionner sur votre plateforme de développement.

Trouver la BD AdventureWorksLT2008

Initial Catalog me dit qu'il faut chercher une BD avec un nom du genre AdventureWorksLT2008 ...
On la trouve facilement dans le CodePlex :

SQL Server BD AdventureWorksLT2008
C'est sûr le projet de Ernesto Herrera ne fait que 801 Ko tandis qu'à lui seul le fichier AdventureWorksLT2008_Data.mdf fait 8 512 Ko, CQFD.

J'utilise une version Express de SQL Server 2008 cela va-t-il fonctionner ?

Le projet Reporting Services with Silverlight

En gros, je vais essayer de : 
  • importer la BD AdventureWorksLT2008_Data dans le répertoire App_Data du projet
  • modifier le fichier Web.config pour que la connectionStrings soit correcte
  • effectuer une mise à jour du Modèle d'Entities

Import de AdventureWorksLT2008_Data  dans le projet

Une fois le .zip téléchargé et dézippé. Dans mon projet ReportingServicesDemo.Web, je fais un "Add->Existing Item..." je pointe sur AdventureWorksLT2008_Data.mdf et j'importe dans le répertoire prévu à cet effet : App_Data. Me voilà avec la BD importée dans mon projet :

Import de AdventureWorksLT2008 dans l'App_Data du projet ReportingServicesDemo.Web

Mise à jour de l'ADO.NET Entity Data Model

Dans Visual Studio j'ouvre le fichier ADWLTModel.edmx (Entity Data Model). Je vais tenter une mise à jour du modèle depuis la BD :

ADWLTModel.edmx mise à jour depuis la BD
Donc bouton droit-> Update Model from Database ... :

ADWLTModel Mise à jour depuis la BD AdventureWorksLT2008
Quelle jolie boite de dialogues ! Je peux y voir déjà que Visual Studio aura repéré la BD que j'ai importé sur mon disque dur mais pas encore celle de mon projet.

Visual Studio me propose dans de mettre à jour la ConnexionString de mon fichier Web.config.

Mais soyons fou et modifiions cette chose là !

Je clique sur "New Connection..." :

Entity Data Model - New Connection ...
Avec le bouton "Browse..." je vais pointer sur la BD que je viens d'importer dans mon projet :
\\ReportingServicesDemo\ReportingServicesDemo.Web\App_Data\AdventureWorksLT2008_Data.mdf

Je me retrouve avec une nouvelle chaîne de connexion :

ADWLTModel Mise à jour depuis la BD AdventureWorksLT2008 nouvelle chaîne de connexion
Pour les amateurs d'application Web ASP.NET, vous avouerez que cette nouvelle chaîne de connexion est bien plus souhaitable au passage elle est bien plus portable.

On note le changement de SQL Server de SQL Server 2008 à SQLEXPRESS ...
On note également l'utilisation du |DataDirectory| ce qui est classique pour une application ASP.NET.

Je clique sur "Next..." :

Entity Data Model - Mise à jour depuis la BD importée dans App_Data
Puis sur "Finish" ... 

Grossière erreur, je viens d'ajouter les tables aux tables déjà existantes dans mon Modèle Entities (.edmx). Dans Visual Studio c'est la panique un rebuild du projet ReportingServicesDemo.Web me sort une séries d'erreurs incontrôlables.

Je passe par "Delete" "Refresh" bref ... :


Au bout d'un moment je sélectionne tous les objets du fichier ADWLTModel.edmx puis les supprime, sauvegarde le modèle qui est maintenant vide, je fais à nouveau un Add des Tables des Views et des Procédures stockées depuis ma base de données et le projet fonctionne :

Silverlight et Reporting Services - Exécution du projet après mise à jour du Modèle Entities
Le projet d'Ernesto Herrera : Integrate Reporting Services with Silverlight and RIA Services fonctionne maintenant sur ma plateforme de développement et, de plus il est portable ...

Conclusion

Ce n'est pas si facile lorsque l'on est confronté pour la première fois à ce genre de chose. Par la suite et par la pratique, on prend de bonnes habitudes. On cesse de paniquer devant des erreurs incontrôlables et l'on reprend les choses simplement de façon propre.

L'idée c'est que ce qui est généré automatiquement doit être mise à jour automatiquement. Vous auriez pu par exemple mettre à jour la connexionString dans le Web.config manuellement cela aurait été une erreur de mon point de vu.

Si Ernesto Herrera avait utilisé le répertoire App_Data sont projet aurait été nettement plus portable car il aurait suffit d'importer AdventureWorksLT2008_Data.mdf dans ce répertoire pour que son projet fonctionne.

Download Sample
Requirements :
Visual Studio 2010
Silverlight v5.0
Reporting Services

Pour aller plus loin