Eric's Blog

Information and Events are Stable Parts of Business

ericqu — Fri, 13 Jan 2012 09:32:51 GMT

At IRM we often use this picture to talk about the stable parts of the business. Actually we have used it at least during the eight years I‘ve been working here.

The least stable part is the organisation itself. Many of us have been affected by organisational changes during the last year and just as many of us will be affected by a change this year. Since it changes all the time it would be unwise to base any software architecture on the current organisation.
As a side note: This is one reason to why I often talk about (user) roles as a bad thing to base the security checks on for a system, even though it is often well supported by the platform.

The most stable part of the business is the structure of the information we need. As long as IRM have been a consultancy firm we have provided services to our customers in projects for which we have always tracked the hours (time) each employee have worked. Surely the information changes too, for example we have for many years educated other in both internal and open courses, but this was not part of the business when IRM started back in 1982. The content changes (hopefully) rapidly with new customers and projects all the time, but not what information we need to track.

How we have performed our services and the internal work have changed over time. It is the process we try to improve all the time. Since the process itself is something that we want to change this is also unwise to base the software architecture on. Still this was a very common advise when SOA was hitting the hype curve, but I believe that is a mistake that happened because we so eagerly wanted to align our solutions better to the business process (of course the system need to support the processes very well, but it shouldn’t be the part that we base our architecture on).
If we dig a little bit deeper into processes they are a series of activities, triggered by an event, that are performed to deliver a value for a customer. The activities are more stable than the process itself, but even more stable are the events. Actually there is an event after each activity that triggers the next activity. An event can also be found when studying the state transitions of the information, for example visualized in an UML State Diagram. This have lead me to talk about the events as the line between Process and Information in the stability diagram above.

I would say that information and events are two important artifacts to pay special attention to when designing software. This spans from defining the correct aggregates (in DDD) to defining service boundary (in SOA) or Bounded Context (in DDD) to integration between systems. I haven’t written about business capabilities in this post, but also when using capabilities for example to define services, you need to make sure that information which must be consistent (not eventually consistent) belongs to the same capability and the most important way of communication between services are based on events.

Deploying ClickOnce to Multiple Environments

ericqu — Wed, 14 Sep 2011 13:05:20 GMT

So in my struggling to get a lean and effective way to roll out new versions of an application for two of my clients, I have some more to share with you. I want it to be extremely easy for me to create a new ClickOnce installer for my clients and I have identified three things that I need to solve:

The installations will be run from different installation URL:s.
Getting unique config-files packed with the ClickOnce publish. I have 2 clients, each with a test and a production environment, and I need to handle my own test environment too.
A client machine needs to be able to run installations for both test and production on a single machine. This means that ClickOnce must see my applications as different applications even though it is only one.

I have solved the last two, so lets start with the last one.

Running both test and production environments on the same client

There are more than one way to solve this, but for me the easiest solution was to create two Visual Studio projects. Originally I had a single Windows Forms exe project in Visual Studio, but I changed this to be just a DLL-project (Output type in Application settings). Then I created two new projects with the names Application and Application.Test and for both of them I configured ClickOnce as usual. There is only a single line of code in each of these projects and that’s to call the original entry point in my old exe-project:

Program.Main(args);

With this solved I still needed to handle the differences in configurations.

Different config for each environment

Visual Studio 2010 has support for transforming configuration files when deploying a web project, but only when deploying and that is only supported for web projects. Luckily Sayed Ibrahim Hashimi and Chuck England have created a small VSiX called SlowCheetah XML Transforms that do the same thing, but when you build your project. So naturally the first step is to install the add-in. Next up is to create new project configurations in configuration manager (I created CustomerATest, CustomerAProd, CustomerBTest and CustomerBTest). With this in place you can right-click on the config-file in you project and select Add Transform, which adds a sub-config file for each configuration. In these config files you then apply the transformations for the changes you want to do in the config file.

This is so useful in many more scenarios than just for deploying with ClickOnce.

Unfortunately I haven’t solved the problem of having different installation URL:s for each configuration, but maybe someone has a tip? I have tried to edit the project file and move the installation url element to respective configuration. This works if I remember to reload the project each time I select another configuration (which I of course don’t), but if I don’t reload the settings will be overwritten with the value from the configuration that was used when the project was loaded so that won’t work. The best thing would of course be if Visual Studio could start to support different installation URL for each configuration.

ClickOnce to the Rescue

ericqu — Tue, 23 Aug 2011 13:58:25 GMT

I have two clients who are outsourcing their PCs and servers and one consequence of that is from now on it will take 3 weeks (plus additional costs) to get a MSI delivered to the clients. This way to far from our fast deliveries that we have today, so I recommended them that we should move on to ClickOnce for distributing the application. This will allow us to roll out new versions quickly and keep the cost down to a minimum.

There is a switchboard integrated though and I was a little bit uncertain if we could handle the requirements of the switchboard to start the client with arguments and always with a single instance of the application. It turned out to be really simple. First of all, we did not need to make any changes in our single instance code (which uses named pipes to communicate from second instance to first).

When someone calls to my client, the switchboard makes a lookup by calling a web service. In the answer it retrieves the path to the installed client, including the correct command line arguments that should be used to start the application. When switching to a ClickOnce distribution the service are not able to include a local path anymore, since the server has no idea where the application is installed. After a quick search I found that ClickOnce can also be called with parameters so that was the path I choose to go down and it worked really well. This is what I needed to do:

In the “Manifests” settings (found under “Publish Options”) it is required to check “Allow URL parameters to be passed to application”.
Next I changed the web service so it returned the URL to the ClickOnce installation (not the bootstrapper exe, but the .application file which also needs to be the installation source) followed by regular query string parameters.

In my code, I just added a small function that takes command line parameters (so I continue to support local installs) as in parameters and the returns them or the parameters send through the query string.

private static string[] GetCommandLineArguments(string[] args)
{
    if (ApplicationDeployment.IsNetworkDeployed && ApplicationDeployment.CurrentDeployment != null)
    {
        if (ApplicationDeployment.CurrentDeployment.ActivationUri != null)
        {
            string queryString = ApplicationDeployment.CurrentDeployment.ActivationUri.Query;
            if (!string.IsNullOrEmpty(queryString))
            {
                queryString = queryString.Replace('?', '/').Replace('=', ':');
                return queryString.Split('&');
            }
        }
    }

    return args;
}

The ActivationUri will always be null if the “Allow URL parameters to be passed to application” isn’t set.

Hosting Rhino Service Bus in IIS

ericqu — Sun, 19 Jun 2011 20:08:00 GMT

This is my third post (part 1, part 2) with notes from my exploration of Rhino Service Bus and in this I will focus on how to set everything up for Pub/Sub when having IIS as a host. The first thing that must be done is to choose a strategy for where to do the initialization of the bus and other parts of the service/application. Here is a good blog post covering the choices and for this sample I choose the AppInitialized because it supports other protocols than http and I don’t need to support any other hosts than IIS so I don’t need to cover that.

public static void AppInitialize()
{
    var host = new DefaultHost();
    host.Start<Bootstrapper>();

    var consumerHost = new DefaultHost();
    consumerHost.UseStandaloneCastleConfigurationFileName("Consumer.config");
    consumerHost.Start<Bootstrapper>();
}

In this test I trigger the events from button clicks on a webpage, but except for that everything works as in the previous post.

When deploying it to a server with IIS installed on, I manually created the Rhino Queue folders (in my case Publisher.esent, Publisher_subscriptions.esent, Consumer.esent and Consumer_subscriptions.esent). For each folder I than gave modify permission to the account running the application pool (you will get a access denied exception if you don’t do this and giving Modify permission on the parent folder does not seem like a good idea).

I haven’t been able to get a sample with RemoteAppDomainHost to work. It complains about not being able to find Rhino.ServiceBus assembly and I’m pretty sure it has to do with ASP.NET shadow copying of files. Has anyone got this working? Please leave a comment or link in that case. Thanks, Eric.

Consuming Events in the Same Process as the Publisher with Rhino Service Bus

ericqu — Sun, 19 Jun 2011 13:25:42 GMT

I recently blogged about getting started with Rhino Service Bus for publishing and subscribing to events. If you did not read that post, I recommend you to do that before continuing since I will just outline my modifications in this post.

My scenario is that I want to decouple things that happens when my server is getting a command. I would like to just save the parts that is core to my domain as a direct effect of the command, but other things like calling other external systems and creating a change history I would like to do later on and in its own transactions. For this I wanted to publish events from my domain and then have subscribers handling each and every scenario separately. I thought it wouldn’t be necessary to have a second process though, so in this post I will show you how both the publisher and the subscriber can exist in the same process.

So based on the steps in my previous post, I copied the class that consumes my events (implementing the ConsumerOf<> interface) to the publisher project. Now I need to have a second service bus host in the Publisher project and that second host must have its own configuration file.

I created a new configuration file, but instead of classic app.config, I called it Consumer.config and I also set the “Copy to Output Directory” to “Copy if newer”. The configuration file is a little bit different than the previous, because the host don’t want the surrounding castle element.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <facilities>
    <facility id="rhino.esb">
      <bus threadCount="1" numberOfRetries="5" endpoint="rhino.queues://localhost:31317/RSB_Consumer_In_Publisher" name="Consumer"/>
      <messages>
        <add
          name="RSB.Events"
          endpoint="rhino.queues://localhost:31315/RSB_Publisher"
          />
      </messages>
    </facility>
  </facilities>
</configuration>

After starting the Publisher host, I also added code to start the in-process Consumer host. The big difference here, compared to the consumer described in my last post, is that I tell the host to use another config-file, by calling UseStandaloneCastleConfigurationFileName.

static void Main(string[] args)
{
    var host = new DefaultHost();
    host.Start<Bootstrapper>();
    Console.WriteLine("Started server publisher.");

    var consumerHost = new DefaultHost();
    consumerHost.UseStandaloneCastleConfigurationFileName("Consumer.config");
    consumerHost.Start<Bootstrapper>();
    Console.WriteLine("Started server consumer.");

    IServiceBus bus = host.Container.Resolve<IServiceBus>();
    bus.Notify(new Event1());
    Console.WriteLine("Published Event1.");

    Thread.Sleep(2000);

    bus.Notify(new Event2());
    Console.WriteLine("Published Event2.");

    Console.ReadLine();
}

Another option for hosting in process is to use the RemoteAppDomainHost, which I believe will run in the same process, but in another AppDomain. This would probably add some robustness to the solution. The difference when using that hosting option is that the Consumer.config file will need to be an ordinary config-file with configSection and the facilities element must be contained in a castle element. The code for bringing the host up is similar to the one above.

var consumerHost = new RemoteAppDomainHost(typeof(Bootstrapper));
consumerHost.Configuration("Consumer.config");
consumerHost.Start();
Console.WriteLine("Started server consumer.");

Getting Started with Pub/Sub using Rhino Service Bus

ericqu — Sat, 18 Jun 2011 12:09:01 GMT

I have a project where I want to start publishing events on the server and then have a consumer subscribing to these events and take action. First I took a quick look at nServiceBus, but I also thought that it would be interesting to see what else exists on the .NET platform. I found both Mass Transit and Rhino Service Bus (RSB). I decided that Rhino Service Bus might fit very well with this project since it has built-in support for Rhino Queues (of course) and it is still open source without restrictions. Rhino Queues is interesting because it is a xcopy deployment.

This post is mainly about giving RSB a first run, so it will be very basic and more like a dump of my own progress.

First I created a simple project for defining the events (messages) and it only contains two empty classes Event1 and Event2. It might be worth noting that there is no requirements on the classes, aka it is not necessary to implement any interfaces or mark them with any attributes.

After this I created a Publisher and a Consumer project and in both projects I added a reference to the Events project and I used NuGet to add a reference to Rhino Service Bus. I began with the publisher:

Added an empty classes called BootStrapper which inherit from AbstractBootStrapper.

Added an app.config

<configSections>
  <section name="castle" type="Castle.Windsor.Configuration.AppDomain.CastleSectionHandler, Castle.Windsor"/>
</configSections>
<castle>
  <facilities>
    <facility id="rhino.esb">
      <bus threadCount="1" numberOfRetries="5" endpoint="rhino.queues://localhost:31315/RSB_Publisher" name="Publisher"/>
      <messages/>
    </facility>
  </facilities>
</castle>

The endpoint attribute of the bus element defines the queue this bus is listening to. The “rhino.queues” defines that Rhino Queues should be used, but RSB also supports MSMQ by using the “msmq” moniker instead.

All that is left now is to start the bus and publish the events. The code for this is straight forward and self explained.

static void Main(string[] args)
{
    var host = new DefaultHost();
    host.Start<Bootstrapper>();

    Console.WriteLine("Starting server publisher.");
    Thread.Sleep(1000);

    IServiceBus bus = host.Container.Resolve<IServiceBus>();
    bus.Notify(new Event1());
    Console.WriteLine("Published Event1.");


    Thread.Sleep(2000);

    bus.Notify(new Event2());
    Console.WriteLine("Published Event2.");

    Console.ReadLine();
}

The IServiceBus supports both Notify and Publish for publishing events. The difference is that the later requires at least one listener.

So with the Publisher wrapped up, lets do the same three steps, plus one additional for the Consumer.

Added an empty classes called BootStrapper which inherit from AbstractBootStrapper.
Added an app.config

<configSections>
  <section name="castle" type="Castle.Windsor.Configuration.AppDomain.CastleSectionHandler, Castle.Windsor"/>
</configSections>
<castle>
  <facilities>
    <facility id="rhino.esb">
      <bus threadCount="1" numberOfRetries="5" endpoint="rhino.queues://localhost:31316/RSB_Consumer" name="Consumer"/>
      <messages>
        <add
          name="RSB.Events"
          endpoint="rhino.queues://localhost:31315/RSB_Publisher"
          />
      </messages>
    </facility>
  </facilities>
</castle>

Before starting the bus I also need to create a classes that can handle the events when they get published. This is done by implementing the ConsumerOf<> interface.

public class EventConsumer : ConsumerOf<Event1>, ConsumerOf<Event2>
{
    public void Consume(Event1 message)
    {
        Console.WriteLine("Received Event1");
    }

    public void Consume(Event2 message)
    {
        Console.WriteLine("Received Event2");
    }
}

As for the Publisher the last step is to start the bus and when this is done it will automatically tell the Publisher which events the Consumer want to receive.
```
static void Main(string[] args)
{
    var host = new DefaultHost();
    host.Start<Bootstrapper>();

    Console.ReadLine();
}
```

Learning about CQRS and Event Sourcing

ericqu — Sun, 06 Mar 2011 21:27:00 GMT

In my struggle to use Domain-Driven Design (DDD) in better ways to get more value out of it and not ending up with anemic models, I began reading about Command Query Responsibility Segregation (CQRS) and Event Sourcing. These are two patterns that fit very well with DDD and two of the most influent thinkers in this area is Greg Young and Udi Dahan. In this post I will simply list a couple of resources that I have found to be very useful, but first let’s start with some of the reasons why I believe this is so interesting:

When combining CQRS and Event Sourcing you will have a built-in integration model. For me, this is huge, since when is the last time you build an application/system in isolation? The problem often is that the need for integration is not taken care of until late in the project and then we add something on top of what we created more common than not with an unsatisfied result.
CQRS offers great separation of concerns and removes the need for supporting reporting in the domain model.
The application/system is built with three relatively loose coupled parts (domain model, read model and user interface) that can be developed and evolved independently from each other.
We store all events generated by the system (Event Sourcing). I believe events will get more and more attention over the coming years (if not Event-Driven Architecture and BI has already put a lot of focus on it) and it opens for many interesting business scenarios.
It is bare bone. This can sound strange, but during the last years I have tried many new frameworks (for example different O/R mappers, WCF RIA Services and so on) without getting the “reward” I’ve been hoping for. In my lab project so far I have not used any frameworks, but I don’t believe that I ‘m writing more code. Rather I find my code becoming better in many ways (easier to read and maintain, better separation of concerns, faster and more).
It fits very well with both cloud and SOA.
Offers some really good way to do unit testing (or at least I have learned better ways to do it when learning about CQRS and Event Sourcing).

There are more reasons which is outlined in many of the following resources that I’ve found good to start with:

1 hour introductionary video by Greg Young covering both CQRS and Event Sourcing.
1 2/3 hours video by Udi Dahan focusing on CQRS.
6,5 hours video by Greg Young going into more depth. I recommend you to take the time to watch this even though it is long. It can also be downloaded.
http://cqrs.wordpress.com/
Greg Young’s blog
nCQRS - .NET Open Source framework for CQRS and Event Sourcing
The CQRS forum

Of course Domain-Driven Design by Eric Evans is pre-requisite and Jimmy Nilsson’s Applying Domain-Driven Design and Patterns book is also a good read.

The Small Things: Asynchronous WCF Calls Without Setting Up Service Reference

ericqu — Sat, 29 Jan 2011 12:49:01 GMT

When you are developing both the service and the client it can many times be good to not use the “Add Service Reference” in Visual Studio. Instead the service and data contracts can be defined in a shared class library. There can be many reasons for this, on popping up immediately is that such a solution removes the need to always update the service reference as the service contract evolves. A “showstopper” could be that when using the ChannelFactory to create the proxy there are no asynchronous methods there to call. Lets start with a small example.

[ServiceContract(Name = "ProjectService", Namespace = Constants.Namespace)]
public interface IProjectService
{
    [OperationContract]
    ProjectDetails GetProjectById(Guid id);
}

This simple service interface could be used on the client with the help of ChannelFactory:

factory = new ChannelFactory<IProjectService>(“*”); 
IProjectService proxy = factory.CreateChannel();

The problem now is that we most often should make the calls to services asynchronous so that the client is not blocked. What we need to do to solve this is the create a client interface that exposes the asynchronous methods. In this case it will look like this:

[ServiceContract(Name = "ProjectService", Namespace = Constants.Namespace)]
public interface IProjectServiceClient : IProjectService
{
    [System.ServiceModel.OperationContractAttribute(AsyncPattern = true, 
        Action = Constants.Namespace + "ProjectService/GetProjectById", 
        ReplyAction = Constants.Namespace + "ProjectService/GetProjectByIdResponse")]
    System.IAsyncResult BeginGetProjectById(System.Guid id, System.AsyncCallback callback, object asyncState);

    ProjectDetails EndGetProjectById(System.IAsyncResult result);
}

Now all we need to do is of course switch the IProjectService to IProjectServiceClient in the ChannelFactory code and the asynchronous methods will be available. Oh … and one last thing, don’t forget to also change IProjectService to IProjectServiceClient in you client config file.

Windows Phone 7: First Impressions

ericqu — Tue, 11 Jan 2011 22:43:04 GMT

Disclaimer: I’m still on parental leave so I have not used the phone in my daily work yet. Also worth noting when reading is that I’m a developer on the Microsoft platform, but I‘ve used iPhone 3GS for the last 1,5 year, I have an iPad. Before the iPhone I’ve used Windows Mobile for several years, but I also have owned both Nokia and Ericsson phones. I have no personal experience with any Android phones.

I have now used my LG Optimus 7 (LG-E900) Windows Phone 7 (http://en.wikipedia.org/wiki/Windows_Phone_7) for about three weeks. I did a reset of the phone after one week to start it up with a British Windows Live ID so that I could start using Marketplace since that is not available in Sweden yet. This touches on one of my biggest complains on the phone so far. It is very frustrating to buy a phone that is made available in Sweden, but without support for Marketplace and Xbox Live. Marketplace is crucial to get apps which is a must for a smartphone today and Xbox Live integration is one of the unique selling points of Windows Phone. My second biggest issue with the phone is the lack of support for Swedish, since that makes typing on the keyboard slow and error prone making it very hard to write any text even short messages/emails.

With that put up front, let’s switch to some of the reasons that I have not returned to my iPhone, at least not yet. I spend less time in the phone and I love that because I still fulfill the same tasks as with my iPhone. The first thing that makes me more efficient is the start screen. By just turning the phone on, without unlocking it, I immediately sees my appointments, the number of emails on my different email accounts and the number of messages. Many times this is all I need to know. The Facebook integration (and Windows Live which is connected to LinkedIn) in the people hub also makes it easy, natural and fast to check what is happening. For the persons that I interact with the most, they are pinned to my Start so their status updates are even more available. It also makes it very easy to call my most common contacts, but this is comparable to the favorites in iPhone. The Live Tiles has a lot of potential and another nice use of them are in a Swedish application (TrafikTitt) which shows the traffic situation from one of the cameras covering the traffic situation in Stockholm. When covering the “performance” of the phone it is also worth noting that it feels very fast and smooth, but unfortunately that is not the same for installed apps, but hopefully the January update will address that. When talking about the first update, it is also worth mentioning that the Copy/Paste feature coming in that update is very much needed.

The built in functionality is generally very good and easy to use. I like how the people hub integrated different source of information (Exchange, Hotmail, Facebook). The Exchange and Hotmail integration is way better than on iPhone and the mail functionality has some great features and are easy to use. Messaging is ok (haven’t used MMS though), but I would have liked to be able to delete parts of a conversation and not only an all or nothing. The calendar is ok, but I miss week view and the month view does not provide a good overview. Compared to iPhone, I’m glad that I can set Private-flag directly in the phone again. Internet Explorer have displayed all pages I’ve viewed so far correctly and the maps functionality works ok too. The pictures hub integrates pictures from my camera, computer and Facebook in a nice way, but the camera is poor when used indoors and when it is dark (as on most phones). I haven’t used the Mutlimedia or Office hub so much, but Zune seems to be a decent player and I really like how OneNote sync itself with SkyDrive and how I can pin OneNote notes to Start.

I have only installed free applications from Marketplace so far and I will cover some of them here.

I really like the Facebook application which is way better than on the iPhone. It uses the panorama in a good way and offers more functionality.
For twitter I’ve used both the official Twitter and Seesmic, with the last one being my default one for the moment. It’s ok, but I like TweetDeck on the iPhone better.
Cocktail Flow is a beautiful application and also provides some really nice features. This feels so much more fresh and compelling than the app I used on iPhone.
TED looks good and works very well.
Microsoft Weather app is ok, but way behind Klart.se app that I used on the iPhone.
YouTube is a must install to be able to watch YouTube content. I’ve installed two different where one just adds playing ability, but still uses YouTube mobile webpages to find content and another one with a custom interface for searching, and showing for example “most viewed”, “top rated” and so on. Only one of them integrates in the Multimedia hub though.
Adobe Reader commonly needed for reading attachments.
I have also installed some Swedish apps (for example TrafikTitt, Tågtid and STHML commute) which all seems nice, but I have only used them briefly. I look forward to the application showing results from the Swedish hockey league (Elitserien).

Overall it seems that there are momentum in Marketplace with more and more application becoming available. I have mentioned a couple of the ones I’m using above and I have also seen, but not used, WHS Phone and Kindle app. What I miss most is “TV/radio players” for example for SVT Play and SR, Spotify (hope it integrates in the Mulitmedia hub), and site specific applications for example Hitta.se, Pricerunner, Prisjakt.se, Arla.se and others. In the car I sometimes miss TomTom which has served me well on the iPhone.

The hardware on the different phones available in Sweden are comparable (as most of the phones available world wide) and the LG feels good even though not as designed as the iPhone. It has no extra on the hardware, except that I, just the other day, learned that it has gorilla glass. LG really shines on the software though. They have made a lot of apps available for free (Cocktail Flow is one of them) and that provides a lot of value so I’m very happy with my choice so far.
UPDATE 2011-01-12: I forgot to write that the battery life time seems to be comparable with other smart phones. The headset bundled with LG is way better than the one I got with my iPhone.

To sum this up, I’m happy with the phone, but it has not unleashed its full potential yet. The apps needs to keep coming to Marketplace and core updates needs to be done by Microsoft (also after the January update). I would probably recommend most regular Swedish users to wait until Marketplace and Xbox Live is supported in Sweden and until Swedish language is supported.

Getting Started with Media Center Development in Visual Studio 2010

ericqu — Tue, 07 Dec 2010 22:08:00 GMT

I got an idea for an Windows Media Center (MCE) application (add-in) that I wanted to try out if I could get it working. First step was to learn how to develop something for Media Center. I found this to be harder than I thought it would be, partly because I have chosen to not install Visual Studio 2008 on this machine. This post will be about the steps I needed to take to get a simple sample running in Media Center, including installation on another machine and the sample also working on the Xbox 360.

First step was of course to install the Windows Media Center SDK, which could be found here. Note that the link on MSDN Windows Media Center Software Development Kit does not link to the latest version of the SDK download.
Since I don’t have Visual Studio 2008 installed the SDK does not install any project or file templates. Fortunately I found this blog post by Charlie Owen, which all the way at the bottom has a link to “Windows Media Center SDK for Windows 7 Addendum”. That zip file contains the templates and the Readme has instructions on how to get them running in Visual Studio 2010.
I choose the “Media Center Application” template for a new project and this creates a sample project almost ready to run. The project opens a Readme file with instruction about what is left to be done. I started out by fixing the two first steps; “Create a strong name key file and add to the project assembly” and “Enter the strong name key in the registration file”. In the “Enter the strong name key …” there are steps how to add a call to sn.exe in Visual Studio external tools, but since I only have VS2010 installed I also only have the latest Windows SDK so the path should be with v7.0A instead of v6.0A.
My next step was to get the DevInstall.cmd going and the changes in there are also related to the fact that I only have version 7 of Windows SDK installed, but I also needed to fix it for running on 64-bit OS. What I did was to again replace v6.0A with v7.0A, but I also replaced the gac-variable in the path with the %ProgramFilesPath% since that is set correctly for 64-bit OS.
This allowed me to install the sample on my developing machine so that I could try it out in Media Center.
I also wanted to get a setup up and running immediately so that I could try it out on my main Media Center machine which also has the Xbox 360 connected to itself. The template contains a WiX setup file and the Readme has instructions for you to install WiX 3, but I wanted to use WiX 3.5 since I already had that installed. The changes required to get the setup running was as easy as changing the “WiX 3” part of the path in Build.cmd to “WiX 3.5”. Lastly I also removed the REM of the post build action call to Build.cmd and after building the project I had a setup file ready to test on my Media Center machine and everything worked as expected including running the sample on the Xbox.

Hope this helps if someone else wants to get started with Media Center Development in Visual Studio 2010.

The Small Things: Converting a Existing Web Application to a MVC Web Application

ericqu — Wed, 24 Nov 2010 09:54:00 GMT

I have an existing web application that contains a couple of WCF services, but today I also wanted to add some pages and decided that I wanted to create them with ASP.NET MVC2. This is the steps I took to get the MVC pages to run just fine in my existing application.

First of all I added references to System.Web.Mvc and System.Web.Routing
I created a dummy MVC project so that I could see what was missing in my existing project.
Then I created the convention based folder structure. Except for the minimum required folders of Controllers and Views, I also added Scripts, Content and Model folders.
I copied all the java script files from the dummy project to my Scripts folder.
I added a Global.asax file to my project and copied the content from Global.asax in the dummy project, but of course corrected the default route.
I opened up the dummy project file in Notepad, and the same with my existing project file. In the project files I looked for the <ProjectTypeGuids> and compared them. For ASP.NET MVC2 the {F85E285D-A4E0-4152-9332-AB1D724D3325} GUID was missing so I changed from:

After doing this I also get the MVC file templates in the Add New Item dialog. I could continue without the MVC file templates, but this change removes a couple of manual steps of required changes that I otherwise would have needed to do in each added ASPX file based on the ordinary ASPX file template.

Events and Multi-threaded Applications

ericqu — Wed, 06 Oct 2010 14:01:33 GMT

I had a problem lately where I sometimes got a NullReferenceException when raising an event. When searching for this problem I found plenty of information so this post is more a write up for myself :).

The common way of implementing an event is something like this:

public event PropertyChangedEventHandler PropertyChanged;

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
{
    if (PropertyChanged != null)
        PropertyChanged(this, e);
}

This code works great in a single-threaded application, but when working with multiple threads we can get into problems. We have a risk of getting in a race condition where the subscriber to the event un-subscribes from the event between the null check and the call on the next line and that will cause a NullReferenceException. There are two ways to solve this problem; one is to assign an empty delegate to the event so it will never be null; the other one is to assign the event to a local variable before the null check like this:

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
{
    PropertyChangedEventHandler propertyChanged = PropertyChanged;
    if (propertyChanged != null)
        propertyChanged(this, e);
}

This effectively solves the NullReferenceException, but also raises the requirements for the consuming multi-threaded application because it is required to handle the fact that the subscribing code could be called even after un-subscribing to the event. Here is an example of changes that I would have needed to do in my consuming code to take this into condition. First the before code:

void currentProject_PropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
{
    if (e.PropertyName.StartsWith("Enable", StringComparison.InvariantCultureIgnoreCase)) return;

    if (!modifiedProjects.Contains(CurrentProject))
    { 
        modifiedProjects.Add(CurrentProject);
        if (modifiedProjects.Count == 1)
            OnPropertyChanged(() => IsDirty);
    }
}

CurrentProject is a property in the class. Now to the changed code that would be correct even if receiving the event after un-subscribing to it:

void currentProject_PropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
{
    ProjectViewModel project = (ProjectViewModel)sender;
            
    if (e.PropertyName.StartsWith("Enable", StringComparison.InvariantCultureIgnoreCase)) return;
    

    lock (modifiedProjectsLock)
    {

        if (!modifiedProjects.Contains(project))
        { 
           modifiedProjects.Add(project);
           if (modifiedProjects.Count == 1)
               OnPropertyChanged(() => IsDirty);
        }
    }
}

Notice that I in this code uses the sender variable instead of just using the CurrentProject property. UPDATE 2010-10-09: Jeremy correctly commented that depending on scenario the modified property changed handler still had some synchronization bugs so I added a lock.

In my case, I choose to assign an empty delegate to the event declaration because it solves the NullReferenceException without raising the bar for the consuming code. The drawback of this solution is a small performance hit, but that won’t be a real problem in most applications.

The Small Things: How to Show the Color Categories in Outlook

ericqu — Wed, 11 Aug 2010 15:26:36 GMT

In an add-in for Outlook that I’m developing I wanted to show the built in Color Categories dialog so that the user could choose categories in a familiar way. The categories should be set on an object that is unique for the add-in (aka not for a mail or calendar item). I couldn’t find any way to show the dialog itself and when searching Internet I found nothing useful, but I have found an acceptable workaround. On the AppointmentItem (or one of the others) there is a method called ShowCategoriesDialog which shows the dialog, so what I did was to create a temporary appointment item, setting my categories, showing the dialog, read the Categories property and then finally cleaning up. Here is the code:

private void ShowAllCategories()
{
    Microsoft.Office.Interop.Outlook.Items items = IRM.TimeManager.Outlook.Globals.ThisAddIn.Calendar.Items;
    Microsoft.Office.Interop.Outlook.AppointmentItem item = (Microsoft.Office.Interop.Outlook.AppointmentItem)items.Add();

    try
    {
        item.Categories = MyObject.Categories ?? string.Empty;
        item.ShowCategoriesDialog();
        MyObject.Categories = item.Categories;
    }
    finally
    {
        if (item != null)
        {
            item.Delete();
            System.Runtime.InteropServices.Marshal.FinalReleaseComObject(item);
        }
        if (items != null)
            System.Runtime.InteropServices.Marshal.FinalReleaseComObject(items);
    }
}

Programmatically Update a ClickOnce Distributed Office Add-in

ericqu — Sun, 25 Jul 2010 11:00:52 GMT

When using ClickOnce for distributing an Office Add-in the default configuration is to check for updates every 7 days. In an add-in I built I have situations where the add-in must be up to date (for example when changing the WCF service interface). In this post I will show how I solved it.

To check for existing updates I use the regularly ClickOnce API:s, for example a simple check could look like this:

return ApplicationDeployment.IsNetworkDeployed && ApplicationDeployment.CurrentDeployment.CheckForUpdate();

If there is a new version available the solution is to quit Outlook and start another small updater program which will start the installation and then restart the application (Outlook in my case). I have called the little program OutlookRestarter and is a simple Windows Application which is created as its own project in the solution. The compiled output from that project, I have added to the add-in project as a linked file and the important part is to set the file as Content in the Build Action so that it will be included in the ClickOnce installation.
To start the OutlookRestarter I use a simple Process.Start and the only “hard” part about it is to resolve the folder in which the files are deployed:

Uri updateLocation = ApplicationDeployment.CurrentDeployment.UpdateLocation;
                    
Assembly addinAssembly = Assembly.GetExecutingAssembly();
string cachePath = addinAssembly.CodeBase.Substring(0, addinAssembly.CodeBase.Length -
    System.IO.Path.GetFileName(addinAssembly.CodeBase).Length);
Uri restarterPath = new Uri(cachePath + "OutlookRestarter.exe");

Process.Start(restarterPath.AbsoluteUri, updateLocation.AbsoluteUri.Replace("File.vsto", "Setup.exe"));

Globals.ThisAddIn.Application.Quit();

I pass the Url to the installation as an argument to OutlookRestarter and the only notable thing about it is that I replace vsto, with the bootstrapper exe file, because I get ClickOnce errors if trying to go for the vsto file directly.

The OutlookRestarter application have three tasks; download the setup, run the setup and start Outlook again. I choose to download the file and run it manually to save the user from one click, which would be the effect if just doing a Process.Start on the Uri. For downloading the file I copied the DownloadFile method from http://www.codeguru.com/columns/dotnettips/article.php/c7005, with a small modification. Before creating the file I check if it already exists and in that case deletes it.

//Download setup
string tempFileName = Path.Combine(Path.GetTempPath(), "Setup.exe").ToString();
DownloadFile(args[0], tempFileName);

//Start and wait for setup to finish
System.Diagnostics.Process setupProcess = System.Diagnostics.Process.Start(tempFileName);
setupProcess.WaitForExit();

//Check to see if any existing Word Processes exist
System.Diagnostics.Process[] currentOutlookProcesses =
    System.Diagnostics.Process.GetProcessesByName("OUTLOOK");

//Empty Case gets ignored, lazy but effective enough
foreach (System.Diagnostics.Process p in currentOutlookProcesses) p.WaitForExit();

//Start Outlook
StartOutlook();

Before starting Outlook again I wait for setup to finish and also makes sure that Outlook is closed. To start Outlook I check the registry settings that is created by Office 2010 (14), but for Office 2007 (12) I make an assumption that it is installed under Program Files.

private static void StartOutlook()
{
    //Office 14 has installation path in the registry
    RegistryKey localMachine = Registry.LocalMachine.OpenSubKey(@"SOFTWARE\Microsoft\Office");
    object installationPath = null;
    string installationFolder = null;

    foreach (string s in localMachine.GetSubKeyNames())
    {
        installationPath = Registry.GetValue(string.Format(@"{0}\{1}\{2}", localMachine.ToString(), s, @"Outlook\InstallRoot"), "Path", null);
        if (installationPath != null) break;
    }

    if (installationPath != null)
        installationFolder = installationPath.ToString();

    //Guess that Office is installed under Program Files
    if (installationFolder == null || !File.Exists(Path.Combine(installationFolder, "Outlook.exe"))) //Office 12
    {
        installationFolder = Path.Combine(System.Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles), "Microsoft Office\\Office12");
        if (!File.Exists(Path.Combine(installationFolder, "Outlook.exe")))
            installationFolder = Path.Combine(System.Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86), "Microsoft Office\\Office12");
    }

    string filePath = Path.Combine(installationFolder, "Outlook.exe");
    if (File.Exists(filePath))
    {
        System.Diagnostics.Process.Start(filePath);
    }
}

Frustrating Hours With Report Web Viewer (v10 / VS 2010)

ericqu — Wed, 19 May 2010 19:09:59 GMT

I had some really frustrating hours with the new version of the Reporting Services Report Web Viewer today. We are using local reports, which we actually create dynamically (subject of another post), but we couldn’t get them to be showed by the Report Web Viewer. We started to seek the problem way off, because we of course assumed that the problem had to do with our creating of the report. Finally we took a step back and tried to get some really simple things to work, but with the same problem. The behavior was that the report viewer continuisly kept refreshing/posting for the report but never displaying it. After some searching I found this blog “Reports Never Stop Loading With VS 2010” and it turns out that the behavior of v9/VS2008 and v10/VS2010 is totally changed. The new version doesn’t use frames and HTTP handler anymore, but instead uses the AJAX support in ASP.NET. This means that the request for the report returns to the aspx page hosting the report viewer, but we did not check for IsPostback before initializing the viewer with the report and data which made us restart the process over and over again. Read the blog post above for details.