We just pushed PostSharp 3.0.13 online, and this is just to inform you of the awful update procedure from previous builds.

Why is the upgrade procedure cumbersome?

PostSharp 3.0.12 included NuGet 2.1 in its payload. Unfortunately, because of limitations of the Visual Studio Extension Installer (VsixInstaller), it was not possible to install PostSharp when NuGet 2.2 was already installed. We had other problems with the way that VsixInstaller handled dependencies (I’m quite confident to say that it is a broken feature), so we decided to handle dependencies manually, without relying on VsixInstaller.

Because of the dependency to NuGet, PostSharp needed to be installed for All Users, requiring elevation during installation. But since we don’t have the dependency to NuGet anymore, PostSharp does not need to be installed with elevated privileges anymore. This is one more situation that VsixInstaller does not handle properly.

What is the proper procedure?

Since Visual Studio Extension Installer is not able to upgrade PostSharp 3.0.12 to 3.0.13, you will have to uninstall PostSharp manually.

1. Start Visual Studio with elevated privileges.
2. Go to Tools / Extensions and Updates, click on PostSharp, then click Uninstall
3. Install the new PostSharp

That’s it. Perhaps that was not so awful.

Remember that this procedure updates only the Visual Studio Extension for PostSharp. You can upgrade the compiler itself using NuGet.

Happy PostSharping!

-gael

I am happy to announce the release of PostSharp 2.0 CTP 3, available for download today.

This is principally a bug fixing release, since more than 40 issues have been solved. The most significant improvement is the Customer Experience Improvement Program (CEIP): the feature, fully opt-in, is able to automatically report unhandled exceptions in PostSharp, and collects some anonymous usage statistics. The CEIP has been included in an intermediate build between CTP 2 and CTP 3, and most issues solved in CTP have actually been reported by the CEIP. For uploading, our implementation uses Microsoft BITS, a background installed with Windows, so the process never interupts your work and does not consume the bandwidth when you're using it (and it very scalable on our server ;).

Except that, sadly enough, there has been no progress in features. We have been fully busy preparing the launch of the new company and the new web site. I'm glad to say that, although we are a couple of weeks late on the technical point, we made good progress with commercial stuff. You'll hear more about that in a couple of weeks.

Just as in CTP 2, the following features are not included in CTP 3 but are planned for a future preview of 2.0:

• Conceptual Documentation;
• Reference Documentation and Conceptual Documentation of PostSharp SDK (previously PostSharp Core);
• Support for Silverlight and Compact Framework.

This release is hardcoded to expire on March 1st, 2010, and in the mean time there will be a new release.

Happy PostSharping!

-gael

Tracing has long been the "Hello, world" sample of Aspect-Oriented Programming. PostSharp does not make exception: tracing is still the first aspect visible on the home page, and most of early PostSharp bloggers did demonstrate AOP on a tracing aspect.

Yet, as tracing is a fundamental part of any non-trivial application, some advanced tools are available to .NET developers. Two of them deserve a special attention since their vendor provides aspects that can be directly used with PostSharp: Gibraltar and SmartInspect.

Don't ask me to compare these toolkits: they are actually sharp competitors. Both have good web sites and a free trial, so I can only recommend you give them both a try! And both have identified PostSharp as a natural complement to their product (Gibraltar being the first).

Gibraltar

I have a special moral debt to Jay Cincotta, one of the guys behind Gibraltar, since he recorded an amazing webcast of using PostSharp and Gibraltar together. Jay, thank you very much for this video, I know how hard it is to produce!

With these aspects you can declaratively add Gibraltar logging to your programs by simply tagging whatever methods, classes or namespaces you wish. This lets you add powerful logging to your applications without the effort, complexity or clutter of writing procedural logging code.

• [GTrace] logs entry and exit from tagged methods including appropriate message indentation.
• [GTraceField] logs every change in value of a tagged field.
• [GException] logs exceptions at the point they are raised. This is a handy safe guard to ensure that both handled and unhandled exceptions are logged by Gibraltar.
• [GTimer] lets you graph method execution time in Gibraltar providing invaluable information to identify bottlenecks and optimize performance.

These aspects (not the toolkit itself) are open-source and are hosted on Google Code at http://code.google.com/p/postsharp-user-plugins/.

For more information, see Using PostSharp with Gibraltar on their web site.

SmartInspect

Following Gibraltar, SmartInspect provides similar aspects:

• [SiTrace] automatically generates two log messages for each method call: one for entering a method and one when a method exits. You can also log the passed method arguments (when entering a method) and the method result (when exiting a method), respectively.
• [SiException] records all exceptions occurring in methods enhanced by the aspect.
• [SiField] lets you automatically record any changes to values of object or class fields.

The aspects can be downloaded from SmartInspect Resources & Extras (look for SmartInspect PostSharp Adapter).

For more information, see Aspect-oriented logging for .NET with PostSharp and SmartInspect on their web site.

Support for Other Logging Frameworks

If you're interested in using PostSharp with Log4Net, remember to check out Log4PostSharp, a project of Michal Dabrowski and Mark Kharitonov. Note that, contrarily to what's now offered by Gibraltar and SmartInspect, Log4PostSharp directly emits optimal instructions, resulting in much better runtime performance. This is not a feature of the logging framework but of the aspect implementation.

Interestingly, there is also some aging project from Eclipse, Build to Manage for .NET, providing PostSharp aspects for the IBM Tivoli platform.

PostSharp Emerged as the De-Facto Standard

What's happening there is that PostSharp is emerging as the de-facto standard for aspect-oriented programming on Microsoft .NET, just like AspectJ is for Java.

PostSharp 2.0 has been designed for the multi-vendor scenario, so that multiple aspects shall merge robustly when applied on the same element of code, even if these aspects come from different vendors who don't know about each other.

This means that ISVs can confidently rely on PostSharp to deliver aspects to their own customers. Good to know: the upcoming price structure shall make it very affordable for small ISVs to redistribute PostSharp free of royalties -- while enabling their own customers to use all professional features of PostSharp 2.0, including the IDE extension, in conjunction with their software.

Happy PostSharping!

-gael

I am pleased to announce PostSharp 2.0 CTP 2, available for download today.

Additionally to uncountable bug fixes, this new CTP brings the following features:

• Support for .NET 4.0;
• Support for Microsoft Visual Studio 2010 (including the IDE extension);
• Support for Mono 2.4.

This release is hardcoded to expire on February 1st, 2010. It is not possible to purchase a license yet.

The following features are not included in CTP 2 but are planned for a future preview of 2.0:

• Conceptual Documentation;
• Reference Documentation and Conceptual Documentation of PostSharp SDK (previously PostSharp Core);
• Support for Silverlight and Compact Framework.

Continue good work submitting feedback on PostSharp forum and issue tracker.

Happy PostSharping!

-gael

I'll present PostSharp and Aspect-Oriented Programming at MS Fest 2009, taking place in Prague, Czech Republic, this week-end (November 28th and 29th), and organized by students of the Math-Phys Institute of the Charles University.

My presentation will be in Czech -- I'm getting used to be the only one not to make the show in his mother tongue (mine is French)...

There will be a lot of fun! I gave the same presentation in Munich, Germany last month, and it was considered an homage to Mr Bean! No, seriously guys, AOP is serious stuff!

-gael

We have refreshed PostSharp 2.0 CTP with a bunch of bug fixes and, most importantly, support for Visual Studio 2010 Beta 2 and .NET 4.0 Beta 2.

The PostSharp Add-In for Visual Studio currently don't work with Visual Studio 2010, but you should be able to build projects targetting all versions of the .NET Framework.

Note that the pipe server currently does not work with .NET 4.0.

Happy PostSharping!

-gael

PostSharp 2.0 CTP1 it out! You can download it today.

As you understood from my previous posts, PostSharp 2.0 is no disguised minor upgrade. PostSharp 2.0 brings major innovations not only to the .NET community, but also to the aspect-oriented programming (AOP) community in general.

The design objective of PostSharp 2.0 is to provide a powerful, robust and supportable platform for build-time aspect-oriented programming for the next 5 years, with high focus on extensibility and well-definedness; PostSharp 2.0 is explicitely designed to support multiple vendors of aspects so that ISVs can confidently distribute aspects to their customers.

The principal new features of PostSharp 2.0 are the following:

• Brand new aspect framework with support for advices (formerly named handlers), putting PostSharp on the level of leading aspect frameworks in other programming communities.
• Amazing Runtime Performance Enhancements thanks to Adaptive Code Generation: you don't pay any more for features you don't use.
• A Robust Aspect Dependencies Framework ensuring that multiple aspects behave in a predictive and consistent way when applied on the same code element.
• A Visual Studio Add-In enhancing developers' productivity by answering graphically to two questions: to which code elements is my aspect applied, and which aspects are applied to my code element.
• Improved Packaging and Start-Up Process acheiving higher performance, better reliability of the assembly search algorithm, and better supportability through extensive logging and support for Gibraltar (you can download their evaluation version if you want to have the same support experience than we have when you'll send us support details -- just start Gibraltar Analyst).

That was for the hype.

Now, frankly. Put your expectations inline with this fact that it is the first CTP. The objective of an early CTP is to deliver all risky features and see if it works. Sure, we have hundreds of unit tests, and it works for us. But there is a huge varierty of deployment conditions and source code structure in the field, and it's something we'll never be able to fully reproduce in a lab.

What's Not There?

This is maybe as important as what's there. The following features are not in the first preview but they will be there in a future preview.

• Conceptual documentation has not been updated. Class reference has been. Please refer to the blog (links given above) for introduction.
• PostSharp SDK (PostSharp Core) is not a part of the release and is not documented. Please do not use PostSharp Sdk with this CTP since next previews will probably break your code.
• .NET 4.0 is not yet supported. Sorry for that. I know many of you are looking forward for it. It'll be in next preview.
• Support for Compact Framework and Silverlight is not shipped with this release. It will be enabled back in a future preview, and newer versions of the platform will be supported.

When Will It Be Commercially Available?

Not before december; probably later.

Lenka, Jirka and others are working hard to deliver a brand new website. Attorneys are at work to deliver license texts. And PostSharp 2.0 is far from a release candidate anyway.

So please be patient and contact me for any commercial question.

So What's Now?

Remember what I wrote when I gave the first indications about PostSharp 2.0:

You know how communication is like: people will blog about it, say it's great (it is), and so on. I will do the same because I need to sell. But don't forget we are first engineers and not marketers. I want you to break the product. Find flaws. Find the weak element. Where will the design break, when it will break? Compare the features to your cases. Is there a case we could solve with a small design modification? We will maybe not solve your use case in this release, but make sure the design allows us to address the case in a future release. Nobody else than you, knowledgeable of your particular business, can provide this feedback.

So download PostSharp 2.0 CTP1 and put it on the test bench. Discuss issues on the forum and report bugs. You did a great job with PostSharp 1.0. Together, we'll PostSharp 2.0 still better!

Happy PostSharping!

-gael

Let me finally discuss some changes in product packaging; they will are important for performance and reliability.

Understanding the Build Performance Issue

Many people complained about PostSharp performance and wondered if the new release would bring some improvement. The short answer is: yes.

The computing cost of PostSharp can be broken down into the following items:

1. Initialization Time. It takes time to start a CLR process, load assemblies in the AppDomain, JIT-compile code, and so on. For long-running applications, you usually don't see the difference (we are talking of tenths of seconds), but PostSharp is a process that is typically triggered every couple of seconds, so this is really important.
2. Processing Time. It's the time PostSharp takes to analyze and process your code and dependencies. Here, I want to be very clear: the code is extremely fast and very difficult to further optimize. PostSharp is designed from ground to be fast. For instance, some say that PostSharp parses the output of ILDASM. This is a myth; it is plainly false. PostSharp has a super-fast binary module reader written in unsafe C# code and doing a lot of pointer arithmetic (something I learned 15+ years ago on Turbo C 2.0).
3. ILASM Time. Oh, yes. PostSharp relies on ILASM. This is true. There are excellent reasons for that: it was much cheaper to implement than a binary writer, has decent performance on Windows, makes it easier to debug code generators, and provides an extra layer verifying generated code. This was an excellent choice.

Therefore, there are 3 things we could do to improve build performance:

1. Improve initialization time. That's what we did in PostSharp 2.0. I'll explain how below.
2. Parallelize PostSharp processing. Ough. That's maybe the more difficult since all threads would access the same object model concurrently.
3. Writing an binary module writer instead of MSIL. This is doable at a much lower cost than parallelizing. But even if we write a binary writer some time, we will never scrap the ILASM back-end.

Improvement in PostSharp 2.0: Initialization Time

With PostSharp 1.5, you had to install PostSharp and generate native images (ngen) to get decent initialization time. Otherwise, PostSharp was continuously JIT-compiled and your build time suffered. The problem is we can't just tell people to install PostSharp globally: in many teams, all build tools are checked in source control.

PostSharp 2.0 addresses this problem efficiently. First, it runs as a pipe server. When a project needs to be built, the pipe server is started, and it is stopped only after a long period of inactivity. So we don't have to continuously load and unload PostSharp.

But we only won the half of the battle. Since PostSharp loads your executable code and executes it (aspects are instantiated at build time), we need to create a new application domain for each assembly being processed. So anyway assemblies need to be loaded and JIT-compiled over and over again, unless... unless we host the CLR and tell it that PostSharp assemblies, and all GAC assemblies, are domain neutral. From this moment, they are loaded only once, and compiled only once. Technically, hosting CLR means writing a half a dozen of COM classes in C++ and somewhat tweaking an API that has been designed on-purpose for SQL Server 2005, not for PostSharp.

The results: I have a test suite of 135 micro-projects I run in MSBuild (that's part of the way you do unit testing of a build tool). The average execution time of PostSharp is the following (release build, no ngen):

• Without Pipe Server: 1.21 s per project
• With Pipe Server: 0.94 s per project
• Difference: 0.22 s per project

So, theoretically, you should see some significant improvement if you have a lot of small projects (to give you an idea, PostSharp still takes 10x more time than the compiler itself).

In order to disable the Pipe Server, use the MSBuild property PostSharpUsePipeServer=False.

Multi-Platform

PostSharp 2.0 finally solves the multi-platform problem. PostSharp 1.5 worked fine with platform-neutral assemblies, but you had to tweak to support x86 or x64 specific platforms. This is now addressed in PostSharp 2.0. The platform is detected automatically, and the proper PostSharp process is started accordingly.

The same mechanism will allow a single distribution of PostSharp to target both the CLR 2.0 and 4.0. Unfortunately -- and I will disappoint more than one -- .NET 4.0 will not be supported in the first CTP. There are sometimes hard choices to be done, and we preferred to deliver higher quality than more features. Be patient! It's the next feature on the list. (I do confirm here that .NET 4.0 will be supported in PostSharp 2.0 -- but not in its first CTP).

Diagnostic Mode

Another area of improvement: PostSharp 2.0 is more supportable than previous versions. The installer (now a single package for both x86 and x64 platforms) will contain two builds: release and diagnostic. Release is fast, but is not able to trace and has no precondition checking. It's the version you use when everything is right. When something goes wrong, build your project in diagnostic mode: detailed logging will be available.

You can use the MSBuild property PostSharpBuild=Diag, or launch the PostSharp Diagnostic Console:

We are working close with guys of Gibraltar Software to make the support experience compelling. If you can't solve your problem yourself (or if you think it's a PostSharp's bug), you can send us support details, which we can then open using Gibraltar Analyst. Actually, PostSharp integrates with Gibraltar, and Gibraltar integrates with PostSharp. I have a long due post about that on my to-do list.

Summary

The way PostSharp 2.0 is started is significantly different than previously and has several advantages:

• Build time improvement
• Reliability of the assembly search algorithm
• Multi-platform
• Diagnostic mode with comprehensive logging and support for Gibraltar.

Happy PostSharping!

-gael

So you are sold. You started using aspects in your new project. After many months of development, the project gets larger and larger. You started with rather simple aspects like tracing, but now your code is fully aspect oriented. You have Resharped or DevExpress tool to help you navigate your code. But, still, something is missing: you can't answer the following questions:

• How do I know to which code elements my aspect has been applied?
• How do I know which aspects have been applied to my code element?

That's why we developed the PostSharp Add-In for Visual Studio.

The first sign is a subtle difference on the splash screen of your favorite IDE:

Then a new item in the View menu:

Click on Aspect Browser and you'l have the answer to your first question. On the top of the new tool window, a list of all aspects used in the current solution; in the bottom pane, a list of code elements to which it has been applied. (Note that this works by reading a file written by PostSharp build components, so you have to build the project to see something).

You can double-click on any code element in the tree and Visual Studio will open the corresponding source code file and position the cursor at the proper location.

Now what with the second question? How do you know that a code element has been enhanced by an aspect? Very simply: it is lightly underlined. Move your mouse cursor to that area and a tooltip will show you which aspects exactly have been applied to this element.

Look at class Customer. The aspect EntityAspect is inherited from class Entity. How would you know this without the plug-in, just by looking at the code?

And, yes, tooltips are clickable!

Happy PostSharping,

-gael

We in the Microsoft .NET community are lucky: at critical moments, we are a few steps behind the Java community. So we got C# and .NET after them, but we learned from their mistakes, and got better language and platform. The same with AOP. AspectJ is widely used over there, there is plently of feedback, and PostSharp has been designed accordingly.

One of the questions engineers face when applying aspects to large software is: how do you ensure aspects don't collide? This was a key design concern for PostSharp 2.0; here I'll show how it's addressed.  Be confident that this feature puts PostSharp at the peek of all industrial aspect weavers, without distinction of language.

Ordering Aspects

Let assume the following. We have two aspects: caching and authorization. Obviously, we want authorization to be performed before caching.

I skip the code of the aspects. It's not the point here. But let see how we define dependencies between aspects:

[Serializable]
[ProvideAspectRole(StandardRoles.Caching)]
public class CacheAttribute : OnMethodBoundaryAspect
{
   // Implementation omitted.
}

 [Serializable]
[ProvideAspectRole(StandardRoles.Security)]
[AspectRoleDependency(AspectDependencyAction.Order, AspectDependencyPosition.Before, StandardRoles.Caching)]
public class AuthorizationAttribute : OnMethodBoundaryAspect
{
   // Implementation omitted.
}

It's fairly simple. There are only two concepts:

1. Aspects can provide a role. A role describes the function of the aspect; represented as a unique string. The class StandardRoles is a list of the most common aspect roles you would find in business applications. To name a few of them: caching, security, persistence, validation, observabiltity, exception handling, transaction handling, and so on. We specify this using the custom attribute ProvideAspectRole.
2. Aspects can define relationships to other aspects. Here, the custom attribute AspectRoleDependency specify a depedency to other aspects that provide a given role. The custom attribute on AuthorizationAspect just means: this aspect should be before any aspect providing caching.

Now, if you apply two aspects on the same method, they will be ordered as you expect:

 [Authorization("SalesManager")]
[Cache]
public string GetQuoteDetailsHtml()
{
  // Pretend we retrieve something large and confidential
  // from database.
}

There are other ways than roles to match dependent aspects. For instance, AspectTypeDependency allows you to specify an aspect type explicitely. All dependency attributes are in namespace PostSharp.Aspects.Dependencies.

Expressing Aspect Conflicts

Let's take another scenario. I have a method, say ISecurable.IsUserInRole, and I want to avoid at any price that this method gets cached.

Easy: we create an aspect NotCacheableAttribute with no logic at all (the aspect does strictly nothing), and add a dependency:

[AspectRoleDependency(AspectDependencyAction.Conflict, StandardRoles.Caching)]
class NotCacheableAttribute : MethodLevelAspect
{
}

Now apply it to our interface method. We use aspect inheritance to ensure than the aspect dependency applies to all methods implementing this interface method:

public interface ISecurable
{
    [NotCacheable(AttributeInheritance = MulticastInheritance.Strict)]
    bool IsUserInRole( IPrincipal principal, string role );
}

Try to put a caching aspect on an implementation of this interface method:

 class Organization : ISecurable
{
     // Details omitted.

     [Cache]
     public bool IsUserInRole( IPrincipal principal, string role )
     {
         return accessList.IsUserInRole(principal, role);
     }
}

Build the project; you'll get this error message:

Conflicting aspects on "Dependencies.Entities.Organization/IsUserInRole([mscorlib]System.Security.Principal.IPrincipal principal, string role) : bool": 'Dependencies.Aspects.NotCacheableAttribute' cannot be used together with 'Before Dependencies.Aspects.CacheAttribute (3)' because the second provides the role 'Caching'. 

And this is exactly what we wanted!

Aspect Commutativity

You maybe remember commutativity from school. Multiplication is commutative because 5*4 = 4*5; division is not. And you maybe even remember function composition, which combines two functions in one: (f o g)(x) = f(g(x)). Functions f and g are mutually commutative if f o g = g o f. If you have done a little more maths, you know that commutativity applies to differential operators, so we have (in good cases): d/dx o d/dy = d/dy o d/dx. And if you have done much more maths, you are even maybe an ace in Lie algrebra, which I never understood.

Just as with functions and differential operators, if makes sense to talk of commutativity with aspects.

Say we have two aspects on the same method: tracing and exception handling. Does it matter if one aspect executes after the other? If you don't care, then these aspects are said to commute (in other words, they are mutually commutative). If not, you have to specify their ordering specifically.

If two aspects are not commutative but are not strongly ordered (because you did not specify an ordering dependency), you will get a nice warning at buid time:

Conflicting aspects on "Dependencies.Entities.Quote/GetQuoteDetailsHtml() : string": transformations "Dependencies.Aspects.TraceAttribute" and "Dependencies.Aspects.AuthorizationAttribute" are not commutative, but they are not strongly ordered. Their order of execution is undeterministic.

You have two ways to get rid of this warning: either your order them strongly by aspecifying an order dependency (see above), either you specify that both aspects commute:

[AspectTypeDependency(AspectDependencyAction.Commute, typeof(CacheAttribute))]
class TraceAttribute : OnMethodBoundaryAspect
{
   // Details omitted.
}

You may ask -- why to bother, anyway? Well, because every professional knows how hard it is to troubleshoot non-deterministic issues, PostSharp 2.0 carefully detects these situations and warns about them. You can specify that your aspect has no effect at all (therefore you would lie, since it does not make sense to write an aspect that has no effect) and, therefore, it's like the function f(x)=x, it commutes with any other aspect. But then you are supposed to have made an educated choice (use the custom attribute WaiveAspectEffectAttribute for this purpose).

Some Theory Behind

The theory behind shows that, while PostSharp Laos became popular quite accidentally (PostSharp Core was well designed, but PostSharp Laos started as an experiment), PostSharp 2.0 is really engineered to scale well in complexity and to assume the burden of this popularity (be certain it is something we carry both with pleasure and honor).

Before starting to execute transformations on a code element (say a method), PostSharp gathers all transformations upfront. At this point, they form an unstructured set of nodes. When this is done, PostSharp evaluates dependencies between all transformations in the set. Ordering dependencies become edges in a directed graph/a> and form a partially ordered set. Then, it performs a topological sorting on the graph to find out in which order transformations should be executed. A part of this algorithm is to detect cycles, so you will get a build-time error if two aspects have contradictory ordering requirements. Then, PostSharp checks if it finds clusters of elements that are not strongly ordered. If it finds some, it checks that all nodes in the cluster commute with all other nodes. Finally, it checks if other dependency constraints (conflicts and requirements) are fulfilled.

This complex algorithm is executed for every method, type, field, property, or event that is the target of more than one aspect. Fortunately, the number of aspects on a code element is typically small, so the performance cost is not daunting in practice. Good news is that it scales in complexity.

Old Good Aspect Priority

"Where is my old AspectPriority property?" It's still there. You can still specify a priority manually. The priority will be translated into a dependency and will be merged with dependencies.

While using an aspect, you can always refind the dependencies provided by the aspect developer. But you cannot break them. If you intend to do so, you will introduce a circular reference in dependencies:

 [Authorization("SalesManager", AspectPriority = 2)]
[Cache(AspectPriority = 1)]   

Conficting aspects on "Dependencies.Entities.Quote/GetQuoteDetailsHtml() : string": according to aspect dependencies, transformation "Before Dependencies.Aspects.AuthorizationAttribute (4)" should be located both before and after transformation "Before Dependencies.Aspects.CacheAttribute (3)".

Thanks to the topological sort algorithm, PostSharp is able to detect longer dependency cycles and to enforce ordering even in complex situations.

Summary

I have shown how PostSharp 2.0 copes with mutliple aspects when they are applied to the same code element. One word qualifies the approach: robustness. Now you can safely use aspects in larger teams and projects. PostSharp is engineered for.

Happy PostSharping!

-gael