26

When learning more about the standard event model in .NET, I found that before introducing generics in C#, the method that will handle an event is represented by this delegate type:

//
// Summary:
//     Represents the method that will handle an event that has no event data.
//
// Parameters:
//   sender:
//     The source of the event.
//
//   e:
//     An object that contains no event data.
public delegate void EventHandler(object sender, EventArgs e);

But after generics were introduced in C# 2, I think this delegate type was rewritten using genericity:

//
// Summary:
//     Represents the method that will handle an event when the event provides data.
//
// Parameters:
//   sender:
//     The source of the event.
//
//   e:
//     An object that contains the event data.
//
// Type parameters:
//   TEventArgs:
//     The type of the event data generated by the event.
public delegate void EventHandler<TEventArgs>(object sender, TEventArgs e);

I have two questions here:

First, why wasn't the TEventArgs type parameter made contravariant ?

If I'm not mistaken it is recommended to make the type parameters that appear as formal parameters in a delegate's signature contravariant and the type parameter that will be the return type in the delegate signature covariant.

In Joseph Albahari's book, C# in a Nutshell, I quote:

If you’re defining a generic delegate type, it’s good practice to:

  • Mark a type parameter used only on the return value as covariant (out).
  • Mark any type parameters used only on parameters as contravariant (in).

Doing so allows conversions to work naturally by respecting inheritance relationships between types.

Second question: Why was there no generic constraint to enforce that the TEventArgs derive from System.EventArgs?

As follows:

public delegate void EventHandler<TEventArgs>  (object source, TEventArgs e) where TEventArgs : EventArgs; 

Thanks in advance.

Edited to clarify the second question:

It seems like the generic constraint on TEventArgs (where TEventArgs : EventArgs) was there before and it was removed by Microsoft, so seemingly the design team realized that it didn’t make much practical sense.

I edited my answer to include some of the screenshots from

.NET reference source

enter image description here

Boann
  • 48,794
  • 16
  • 117
  • 146
Zack ISSOIR
  • 964
  • 11
  • 24
  • 1
    Generics were added in C#2, variance modifiers in C#4. – Lee Feb 27 '19 at 14:14
  • So why this was not corrected in .net core ? Because I found the same thing in .net core and .NET core came to life a long time after generics were supported. – Zack ISSOIR Feb 27 '19 at 14:17
  • It was not "corrected" (if there actually *is* something to be corrected) in .NET Core because .NET Framework and .NET Core follow the .NET Standard and that implementation was already done – Camilo Terevinto Feb 27 '19 at 14:18
  • EventArgs class literally has nothing, but a single static field. Why would it be obligatory to derive from that class for TEventArgs? – iSpain17 Feb 27 '19 at 14:23
  • 6
    I don't think it's fair to close this question. I presented all the elements that make my question legal and verifiable. There must be a very strong reason to vote for closing it ... – Zack ISSOIR Feb 27 '19 at 14:24
  • I told you the reason. We are not Microsoft and only them can tell you why they decided for that. And waiting for someone from Microsoft to answer makes this off-topic. – Camilo Terevinto Feb 27 '19 at 14:30
  • 15
    @CamiloTerevinto, I've not encountered that specific rule before. If that was the case then this answer, to the question *Is there a reason for C#'s reuse of the variable in a foreach?*, written by Eric Lippert (who worked on the C# compiler at Microsoft) https://stackoverflow.com/a/8899347/7872 would've been missed out on. "Not everyone has the knowledge to answer this question" is a quite awful reason to close it. – Rob Feb 27 '19 at 14:37
  • 3
    @CamiloTerevinto Look I understand your point of view even if I disagree with it. I already asked a question like this befoe and I had an answer , have a look at this So question https://stackoverflow.com/questions/47728857/why-the-interface-iorderedenumerablet-isnt-covariant-in-t – Zack ISSOIR Feb 27 '19 at 14:39
  • 1
    Please don't ask two questions in one question. What usually happens is that only one of them gets answered. – Eric Lippert Feb 27 '19 at 15:32
  • 4
    Minor correction to your timeline: generics were introduced in C# 2. Supporting variance on generics was introduced in that version of the CLR, but C# did not take advantage of it until C# 4. – Eric Lippert Feb 27 '19 at 15:34
  • 2
    @EricLippert, the question was primarily about event delegates invariance, the Second question is less important than the first. But I think it would be great if we have your opinion about the second question too if you think that it deserves to make an exception for it too :D ? – Zack ISSOIR Feb 27 '19 at 16:09
  • 1
    The second question I would push back on. Try answering it yourself by answering the corresponding positive question. Give me a convincing argument that the proposed feature benefits real users. If you can't, then why should the feature be implemented? – Eric Lippert Feb 27 '19 at 16:22
  • 5
    I disagree that this question is "primarily opinion based". The question does not solicit an *opinon*; it solicits *the arguments made to justify a design decision*. We can say that the question is vague because "why not" questions are inherently vague, and we can say that likely no one on SO has direct knowledge of those arguments, but I don't think we can say that either of those things are soliciting *opinions*. I've voted to re-open. – Eric Lippert Feb 27 '19 at 16:37
  • 1
    @EricLippert It seems like the generic constraint on TEventArgs (where TEventArgs : EventArgs) was there before and it was removed by Microsoft, so seemingly the design team realized that it didn’t make much practical sense. I edited my question to include some of the screenshots from open-sourced fragments of .NET. – Zack ISSOIR Feb 27 '19 at 19:01
  • 1
    This means that the EventArgs class is now there only for backwards-compatibility if I'm not mistaken. – Zack ISSOIR Feb 27 '19 at 19:02

1 Answers1

41

First off, to address some concerns in the comments to the question: I generally push back hard on "why not" questions because it's hard to find concise reasons why everyone in the world chose to not do this work, and because all work is not done by default. Rather, you have to find a reason to do work, and take away resources from other work that is less important to do it.

Moreover, "why not" questions of this form, which ask about the motivations and choices of people who work at a particular company may only be answerable by the people who made that decision, who are probably not around here.

However, in this case we can make an exception to my general rule of closing "why not" questions because the question illustrates an important point about delegate covariance that I have never written about before.

I did not make the decision to keep event delegates non-variant, but had I been in a position to do so, I would have kept event delegates non-variant, for two reasons.

The first is purely an "encourage good practices" point. Event handlers are usually purpose-built for handling a particular event, and there is no good reason I'm aware of to make it easier than it already is to use delegates that have mismatches in the signature as handlers, even if those mismatches can be dealt with through variance. An event handler that matches exactly in every respect the event it is supposed to be handling gives me more confidence that the developer knows what they're doing when constructing an event-driven workflow.

That's a pretty weak reason. The stronger reason is also the sadder reason.

As we know, generic delegate types can be made covariant in their return types and contravariant in their parameter types; we normally think of variance in the context of assignment compatibility. That is, if we have a Func<Mammal, Mammal> in hand, we can assign it to a variable of type Func<Giraffe, Animal> and know that the underlying function will always take a mammal -- because now it will only get giraffes -- and will always return an animal -- because it returns mammals.

But we also know that delegates may be added together; delegates are immutable, so adding two delegates together produces a third; the sum is the sequential composition of the summands.

Field-like events are implemented using delegate summation; that's why adding a handler to an event is represented as +=. (I am not a big fan of this syntax, but we're stuck with it now.)

Though both these features work well independently of each other, they work poorly in combination. When I implemented delegate variance, our tests discovered in short order that there were a number of bugs in the CLR regarding delegate addition where the underlying delegate types were mismatched due to variance-enabled conversions. These bugs had been there since CLR 2.0, but until C# 4.0, no mainstream language had ever exposed the bugs, no test cases had been written for them, and so on.

Sadly, I do not recall what the reproducers for the bugs were; it was twelve years ago and I do not know if I still have any notes on it tucked away on a disk somewhere.

We worked with the CLR team at the time to try and get these bugs addressed for the next version of the CLR, but they were not considered high enough priority compared to their risk. Lots of types like IEnumerable<T> and IComparable<T> and so on were made variant in those releases, as were the Func and Action types, but it is rare to add together two mismatched Funcs using a variant conversion. But for event delegates, their only purpose in life is to be added together; they would be added together all the time, and had they been variant, there would have been risk of exposing these bugs to a great many users.

I lost track of the issues shortly after C# 4 and I honestly do not know if they were ever addressed. Try adding together some mismatched delegates in various combinations and see if anything bad happens!

So that's a good but unfortunate reason why to not make event delegates variant in the C# 4.0 release timeframe. Whether there is still a good reason, I don't know. You'd have to ask someone on the CLR team.

Wai Ha Lee
  • 8,598
  • 83
  • 57
  • 92
Eric Lippert
  • 647,829
  • 179
  • 1,238
  • 2,067
  • 4
    Thank you very much, Eric, for answering this question. I read your very great and well-explained blog posts on variance and started looking around in the .NET framework until I found the examples of event delegates that this post is about. I think that this great and convincing answer completes those blog posts, as there is no article that discusses the points you mentioned in this answer. – Zack ISSOIR Feb 27 '19 at 15:49
  • 1
    "Event handlers are usually purpose-built for handling a particular event, and there is no good reason I'm aware of to make it easier than it already is to use delegates that have mismatches in the signature as handlers, even if those mismatches can be dealt with through variance" - I feel it's common in WinForms to re-use event-handlers for multiple controls and events to reduce boilerplate when the handler just triggers some common action not specific to the control or event that was invoked. – Dai Feb 27 '19 at 17:26
  • 4
    @Dai: Sure, and to be clear, I am not suggesting that there is any problem with *variant conversions from method group to delegate*. That's pretty common in webforms scenarios and that is well-tested. It's when variance on the delegate type itself is in play that delegate combination had bugs. If I have some free time I'll see if I can recreate my test cases from 12 years ago and see if they still repro or not. – Eric Lippert Feb 27 '19 at 18:12
  • 3
    There is an open issue on the F# GitHub for adding variance support to the language, which explicitly mentions events as a possible enhancement. If anyone is working on this feature, they may know what the current status of the CLR bugs would be. https://github.com/fsharp/fslang-suggestions/issues/162 – Aaron M. Eshbach Feb 27 '19 at 21:20
  • For anyone curious, adding together mismatched delegates, even though respecting the covariance/contravariance, still causes an exception "Delegates must be of the same type". – Laurynas Lazauskas Sep 03 '20 at 17:47
  • @LaurynasLazauskas: Well that is vexing, but unsurprising. Not a whole lot of customer demand to fix those bugs. – Eric Lippert Sep 03 '20 at 18:20