Home > Articles > Programming > Windows Programming

Building and Maintaining Frameworks: Video Podcast Transcript

In this transcription of an OnMicrosoft session, .NET Team Program Manager Krzysztof Cwalina talks with interviewer Ted Neward about building frameworks that can survive the changes that come with time.
Like this article? We recommend

Building and Maintaining Frameworks (video transcription)

Welcome to OnMicrosoft—conversations with thought leaders in Microsoft technologies. In this session, .NET Team Program Manager Krzysztof Cwalina discusses his work building frameworks and offers valuable insights for developers building framework libraries.

Ted Neward: Krzysztof, why don't you give us a little bit of background about who you are, what you do, and what makes you famous?

Krzysztof Cwalina: Well, I'm not sure I'm famous.

Ted: To a select portion of the population, you're moderately famous.

Krzysztof: Yes, yes. I'm a program manager on the .NET Framework team. We have a subteam inside the .NET Framework called Application Frameworks Core, and the team is responsible for two separate charters. One is developing features for the .NET Framework—crosscutting, general-purpose APIs for application models. A second part of the charter is to ensure design quality of the .NET Framework. So we work on things like API design guidelines [and] architectural guidelines. We do reviews of APIs in the .NET Framework, reviews of architecture; also work on layering; componentization; and crosscutting, long-term design activities.

Ted: And you were part of the group that built the FCL [Framework Class Library] over time, correct? So you've seen [it] through this a couple of iterations?

Krzysztof: Yes, I've been on the .NET Framework basically since the group started. So when I joined Microsoft, I started on the VB team and then three months after I joined Microsoft, the team was reorganized and we created the .NET Framework team. I started to work on basic APIs, roughly associated with the BCL [Base Class Library]. Later, in .NET Framework 2.0, I worked on collections, basically on the BCL team. And now, as I said, I work on the application frameworks.

Ted: So you've had a lot of time, in terms of building frameworks that people use that have been around for a while, right? One question that frequently comes up (I'm sure you get it, but I've seen it as well) is, "I want to build something that will be useful beyond just the next six months." What sort of things have you learned, what sort of general tips can you give us about trying to build a framework, or a component, or some reusable entity? What are some things that you've learned the hard way?

Krzysztof: I've spent a lot of time building frameworks and also getting involved with other groups who develop frameworks, helping them get their APIs to be well integrated with the rest of the framework—usable. I work a lot with usability engineers, and I do have a lot of experience in terms of knowing how framework APIs start their lifecycle and what happens over time. At the Tech Ed in Orlando, I gave a talk about evolution of framework libraries, and the talk was specifically about what happens with a framework over time. How you avoid a situation we're all familiar with: When you look at new code, it's usually better than average, correct? When you look at old code, you think, like, "Who the heck created it?"

Ted: Question is, the old code was generally not written by me.

Krzysztof: Exactly.

Ted: New code is written by me. Old code was written by "that guy" that we fired, or the contractor, right? We always blame the contractor.

Krzysztof: Exactly. The natural tendency is to say that the person who created it in the past just did not do a very good job. I looked at what happens with frameworks designed by people who are just great framework designers—and they also, after 10 years, start to show flaws, right? You look at the flaws, and you say, "Why did they happen?" I think the main reason is that the environment around the framework changes. So, initially, you design your library, and you say, "These are the scenarios, this is what my customers want today," and so on, and so on. Over time, the scenarios change, the customers' expectations change, and so on, and so on. Unfortunately, framework APIs are not something that can be easily changed over time. So the ecosystem around [it] changes, but the APIs don't, and the reason is backwards compatibility, right? The moment you release the framework outside your immediate organization, you're pretty much bound with a lot of backwards-compatibility restrictions.

Ted: Yes. Don Box used to call this the "two-cubicle rule." If your code—in whatever fashion—got more than two cubicles away from where you were sitting, you couldn't just stand up and say, "Hey, I changed this interface, all of you need to get it from source control and recompile." So, once it's outside of that radius, people can't hear you when you say that stuff was refactored and changed and so forth.

Krzysztof: Definitely. There has been a lot of research done about managing code change, correct? Like this whole object-oriented design community research. A lot of the research focuses on how we separate parts of the system, so if one changes, the other one is not affected.

Ted: Right. Decoupling.

Krzysztof: Exactly. For internal implementation, what you need to do is just enough decoupling so you don't have to change the other system every time something changes in the other subsystem, correct? But the goal is to minimize change. It's not to eliminate change. Now, for APIs, you cannot actually do any change. If one part of the subsystem changes, you cannot change APIs in other parts, even if they are affected, correct? What happens is it limits the changes in subsystems that have dependencies between each other. So, on a high level, or to summarize, I would say that, in general, software is very difficult to modify after it's been shipped. This is past the second cubicle. But for API design and for framework APIs, the problem is even bigger.

Ted: Right. You know, one of the things that the Agile movement, the Agile community really rests on in terms of bedrock is this notion of being able to refactor. If I release something and I discover that it's not quite what we want, that the API was flawed, that our needs have changed, I can go back and refactor this code so that I don't end up with these large collections of deprecated classes and deprecated methods that never go away. Is it possible—because it almost seems like you're saying it's not—is it possible to refactor APIs? Or are we basically stuck with the BCL as it is until the end of time?

Krzysztof: I think there are some changes that you, of course, can make in APIs. For example, you can add new members to existing types. You can imagine a situation where that would be a breaking change, but it's extremely corner case, and for all practical purposes we say that additions to existing types are not breaking, correct? And there is some number of other additional changes that are also not breaking. For example, changing a member from non-virtual to virtual is probably not breaking.

Ted: Right.

Krzysztof: Unless you take dependency through...

Ted: You can see the scenario where it might create a problem, but for the most part you assume that that's not a breaking change.

Krzysztof: Exactly. So there are some means of evolving frameworks in place. One is making those changes that are not breaking. There are some others, some features in the CLR that we tried to add, to allow us to modify the framework. For example, .NET Framework 2.0 or CLR 2.0 has a feature called type forwarders, and the feature basically allows you to move types from one assembly to another without causing breaking changes for clients that compiled against the older version of the framework.

Ted: When you say "move types"—like the CLR, physically, even though it was defined in assembly A, it appears to be part of assembly B?

Krzysztof: Well, actually, you take type from assembly A and you actually physically move it to assembly B.

Ted: Wow.

Krzysztof: In assembly A, you leave a marker that says, "Hey, runtime, when you try to load this type, you're not gonna find it here—it's in the other assembly."

Ted: Oh, I see. Sort of a source code move. You physically wanted that type to come out of assembly B instead of assembly A.

Krzysztof: Yeah, yeah. So this is just an example of a feature. We are thinking about more features that allow you more malleability in the framework without causing breaking changes. You can see extension methods to be such a feature. Of course, this is not only for binary compatibility, but for source compatibility. You can move a member from one type to another without causing source breaks, correct? Let's say you had a method, you know, "Do something on type Foo." If the method is non-virtual, you can create an extension method on a different type, extension method for the type Foo. And then source, at least C# source and VB source that support extension methods, wouldn't be broken. So, as I said, there are some changes in the framework that are just naturally allowed. There are some that we added features to the runtime—and will be adding more, probably, in the future—to allow us to modify the framework to basically ensure that, as you said, some of the flaws that we do have in the Base Class Library, over time, get fixed.

For more information, visit onpodcastweekly.com and subscribe to all our podcasts. Brought to you by the publishing imprints and information portal of Pearson Education.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020