Take the 2-minute tour ×
Salesforce Stack Exchange is a question and answer site for Salesforce administrators, implementation experts, developers and anybody in-between. It's 100% free, no registration required.

I haven't been able to find any official documentation or community discussion of the compelling reasons to upgrade the API version on Apex classes, triggers, and pages. I know there is the general answers of "it's just a good idea" and "they might deprecate support for it eventually", but for some of our clients those answers are good enough to justify the cost of having a developer invest the time to upgrade the API version and regression test all the code to make sure nothing broke after the upgrade. Are there any more specific reasons in the areas of performance, security, or reliablity that I could use as leverage to convince developers and stakeholders that it should be upgraded on a regular basis?

share|improve this question
    
I found this old discussion on the DFC forums: API Version of Apex/VF code and what features you get, what about limits but I would like to see more recent discussion about these topics from Salesforce.com product managers/developers and/or developer evangelists –  apexsutherland Jun 9 at 16:49
add comment

5 Answers 5

up vote 10 down vote accepted

Contrariwise, I will provide an argument for upgrading, although the other answers state that complacency is acceptable.

There are two factors at play when you speak of API versions: features and consistency. Both of these issues introduce two distinct needs, namely stability and flexibility.

First, let's address consistency.

You should keep all your classes, pages, and triggers at the same API version. This is important to avoid bugs like this one. Note that this bug only occurs when some classes are lower than v28 and others are higher than v28. Each class appears to run in an emulated model that is compiled in a way that different versions are binary compatible, but having different features. Every once in a while, a newer feature can bleed into an older class, resulting in an error. You need consistency for stability. While the language is very good at what it does, it is not perfect, and you would do well to keep all your code within the same version.

Next, let's address features.

Inevitably, some CEO/CFO/VP/etc will want to implement a feature. You tell them that it's no big deal, it can be done in a week. Now, at this point, you're going to be at one of two places.

If you're in a habit of not upgrading, you'll write a new class with a new version, and try to tie it in to everything else, and everything will break. Not necessarily in big ways, but big enough to be noticeable. You've ignored the first aspect, consistency. So, you start upgrading all your other classes in the second week. By the third week, they've all been upgraded, but now your hunting down bugs that are really obscure, and you have no idea why. A month as gone by, and nobody's happy, but you swear you're almost there. Conversely, if you're regularly upgrading, you'll simply spend the week writing the new feature, and presto, it'll be ready.

In other words, by not upgrading, you are not saving time. You are kicking the can down the street, and when you need to upgrade, you'll be between a rock and a hard place.

I'm not advocating that you jump from v18 to v30 overnight. There are so many changes, so many small nuances you have to consider, that it would be a risky move. I tried something similar to that on a project, and we ultimately got set back months by way of troubleshooting, hunting bugs, etc. But, I'm also not saying that you should kick the can too far down the street. You need to address version upgrades in a controlled manner. There's nothing wrong with going from v18 to v20, then doing other things and going on to v22, for example.

There are a few versions that will be tricky to upgrade to, because they were significant upgrades. When they introduced "SeeAllData" for example, it required most test methods to be completely re-written or at least modified to use the new attribute. Then, they forced the split between test methods and live code. Who knows what other gamebreaking changes will happen in the future? You want to avoid the last-minute upgrade, because it will put you in a position you don't want to be in.

So, if you don't have the resources to be bleeding edge (and many organizations don't), at least avoid being left in the dust, because you will eventually have to invest the time sooner or later, and the longer you wait, the more time you will have to commit to at once.

share|improve this answer
    
The split between test methods and live code only applied to new classes. Existing classes were grandfathered in so to speak. It did not require orgs to create test classes for old code that had internal test classes. –  crmprogdev Jun 11 at 19:33
2  
@crmprogdev The separation of test and live code is version dependent. Nothing was grandfathered in. You can today create a new class that doesn't have this restriction, and existing classes will not require this separation until you try to upgrade to a version that requires this separation. –  sfdcfox Jun 11 at 19:40
    
Thanks for the clarification. I just knew there was a lot of old code in an org I'd worked in at the time of the change as an outside contractor on a project that we didn't "have" to update in order to comply with it. Apologies for not recalling all the dots in i's and crosses on the t's of the API revision. ;) –  crmprogdev Jun 11 at 19:45
add comment

Honestly, it's hard to find a compelling reason to upgrade it on a regular basis. Salesforce is set up so that you can leave code/versions alone and even when they upgrade the system it won't effect your code that uses old versions.

In my opinion (I could be against the general consensus here), the only reason to update versions is to allow you to take advantage of new features. If you have a section of code that has been working for years, why take the risk that upgrading the version could effect how it works and potentially break it?

That said, when I am making improvements to existing code, one of the things I try doing is bumping up the version and ensuring it works to the new version. If I am already working on it, it usually isn't a huge issue to do but why go out of my way just to make me feel better that all of the code is in the newest version when it doesn't bring anything to the table?

share|improve this answer
add comment

Unless there's a particular feature you now need to implement which existing code doesn't support, there's no compelling reason to update the code and save it under a new API.

Now if there's an update that breaks old code or exposes a security conflict with, then you have no choice. Some of last year's HTML related updates would be good examples that may have affected some orgs. That's why you're given advance notice before implementing those types of updates. You then have a chance to check code for potential issues.

So IMO, the only compelling reason to update is when an update to the API no longer supports existing code or perhaps when you're working on a new application that interacts with existing code. In those situations, its always wise to look at that code to see if there's maintenance that needs done to it for other reasons anyway.

As the old saying goes "If it's not broken, don't fix it!"

share|improve this answer
1  
"Unless there's a particular feature you now need to implement which existing code doesn't support" - In other words, wait until you need a new feature and then upgrade all affected classes? That doesn't scale. Remember another old saying: A stitch in time saves nine. Because it may be easy to fix an enterprise project today, but in nine months, it may be too large to fix. –  DavidSchach Jun 11 at 17:39
add comment

The team I work on upgrades the API version of all components each time we cut a new release. This being a product with a pretty well-staffed team means we have rounds of QA testing, including a full set of regression tests to catch any issues that arise.

Without that kind of team supporting you I certainly wouldn't try to upgrade your entire codebase every release - you're bound to break more things than you help by doing so without solid testing. Especially as visualforce testing can't be (natively) automated.

As a very general suggestion that warrants being tailored to your environment I'd try and do a yearly or every other year run-through of API version upgrades and testing. Being on an older release is generally fine, but being on a really old release means

  • Salesforce support will be less helpful due to the legacy API version
  • It gets stupidly hard to keep track of what feature was introduced when. Did they allow creation of List<SObject> in API....18? 22? Who really remembers these things?
  • There are somewhat regularly upgrades you get for "free". In a semi-recent visualforce revision pages were changed to respect the same default values for fields that standard pages do. This kind of thing is very nice for keeping a consistent user experience.
share|improve this answer
add comment

Here is what I've gathered so far in venues other than StackExchange:

  • Salesforce cannot possibly support all previous API versions forever, and at some point the oldest APIs may start to break down or be deprecated altogether
  • At some point in the future, Salesforce will begin preventing creates and saves of code that uses API versions that are too old (i.e. > 10 API versions old or something to that effect)
  • There are some API features that have a big impact on code reliability, such as:
  • Mis-matched API versions can cause all sorts of weird issues, best to have your entire codebase on the same version (whenever possible):
  • You don't want to be wrestling with version change issues when you're trying to fix an urgent bug in old code. Keeping the code in a recent API version window will reduce the chance that you'll have to fight those two battles simultaneously
share|improve this answer
1  
The unit testing piece alone makes it worth the time to upgrade. Sure, I haven't done it on a managed package I made in API 22, but I also haven't edited that code since it was released. The minute I opened that project to add some new features (to be released- safe harbor), I pulled test code into its own class and updated all API versions and did full testing. –  DavidSchach Jun 11 at 17:41
add comment

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.