Skip to main content

Release It - Highlights Part 2

This is the second part of my collection of notes and snippets from Release It!

Caches

  • Low memory conditions are a threat to both stability and capacity.
  • You need to ask whether the possible keys are infinite or finite and would the items ever need to change?
  • The simplest cache clearing mechanism is time based.
  • Improper use of caching is the major cause of memory leaks, which turn into horrors like daily server restarts.
  • Your system should run for at least the typical deployment cycle. If you deploy once every two weeks, it should be able to run for at least two weeks without restart.
  • Limit the amount of memory a cache can use.
  • Caches that do not limit memory will eventually eat all memory.

Testing

  • Every integration point should have a test harness that can be substituted.
  • Make your test harness act like a hacker - try large payloads, invalid characters, injection and so on.
  • Have your test harness log requests so you can see what has caused problems.
  • Run longevity tests - tests that put impulse and stress upon a system over long periods of time.
  • Someone saying "the odds of that happening is millions to one" is actually quite likely to happen. Given a average site, making thousands of requests a day this is an easy target to hit.
  • Sessions are the Achilles heel of every application server.
  • Most testing uses the app in the way it was expected to be use such as load testing a site using the correct workflow. What about load testing without using cookies? Would this spawn a new session each time?

HTML

  • Whitespace costs! In HTML (or the markup generated) remove all whitespace. It costs time to generate and money to send across the wire. You could argue this is for big traffic sites only, but this technique is very simple to apply as part of the build and speeds up client side rendering.
  • Omit needless characters in HTML such as comments. Use server side commenting instead, this will be removed when processed.

Pre-Computation

  • Precompute as much of the page as possible. Use "punch outs" for dynamic content. For example Slashdot generates its page once and serves to thousands of users. All users get the page equally as fast. Caching would mean handfuls of users would get a slow experience.
  • Precomputed content should be deployed as part of the build. For more frequent updates another strategy or "content deploys" would be required.

Logging

  • The human visual system is an excellent pattern matching machine. Make logs readable by using a custom format. Scanning logs is very easy then.
  • Two line log files are difficult. Harder to grep. Keep everything on one line.
  • Each week review the systems tickets. Try to identify and fix problems as you go. Try and predict future problems where possible based on this info.
  • Check the logs daily for stack traces that are suspicious. These could be common errors that are bugs/problems that need fixing.

Comments

Popular posts from this blog

Three Steps to Code Quality via TDD

Common complaints and problems that I've both encountered and hear other developers raise when it comes to the practice of Test Driven Development are: Impossible to refactor without all the tests breakingMinor changes require hours of changes to test codeTest setup is huge, slow to write and difficult to understandThe use of test doubles (mocks, stubs and fakes is confusing)Over the next three posts I will demonstrate three easy steps that can resolve the problems above. In turn this will allow developers to gain one of the benefits that TDD promises - the ability to refactor your code mercifully in order to improve code quality.StepsStop Making Everything PublicLimit the Amount of Dependencies you Use A Unit is Not Always a Method or ClassCode quality is a tricky subject and highly subjective, however if you follow the three guidelines above you should have the ability to radically change implementation details and therefore improve code quality when needed.

DRY vs DAMP in Tests

In the previous post I mentioned that duplication in tests is not always bad. Sometimes duplication becomes a problem. Tests can become large or virtually identically excluding a few lines. Changes to these tests can take a while and increase the maintenance overhead. At this point, DRY violations need to be resolved.SolutionsTest HelpersA common solution is to extract common functionality into setup methods or other helper utilities. While this will remove and reduce duplication this can make tests a bit harder to read as the test is now split amongst unrelated components. There is a limit to how useful such extractions can help as each test may need to do something slightly differently.DAMP - Descriptive and Meaningful PhrasesDescriptive and Meaningful Phrases is the alter ego of DRY. DAMP tests often use the builder pattern to construct the System Under Test. This allows calls to be chained in a fluent API style, similar to the Page Object Pattern. Internally the implementation wil…

Coding In the Real World

As a student when confronted with a problem, I would end up coding it and thinking - how do the professionals do this?For some reason I had the impression that once I entered the industry I would find enlightenment. Discovering the one true way to write high quality, professional code.It turns out that code in industry is not too far removed from the code I was writing back when I knew very little.Code in the real world can be:messy or cleanhard or easy to understandsimple or complexeasy or hard to changeor any combination of the aboveVery rarely will you be confronted with a problem that is difficult. Most challenges typically are formed around individuals and processes, rather than day to day coding. Years later I finally have the answer. Code in the real world is not that much different to code we were all writing when we first started out.If I could offer myself some advice back in those early days it would be to follow KISS, YAGNI and DRY religiously. The rest will fall into plac…

Feature Toggles

I'm a fan of regular releasing. My background and experience leads me to release as regularly as possible. There are numerous benefits to regular releases; limited risk, slicker release processes and the ability to change as requirements evolve.The problem with this concept is how can you release when features are not functionally complete?SolutionIf there is still work in progress, one solution to allow frequent releases is to use feature toggles. Feature toggles are simple conditional statements that are either enabled or disabled based on some condition.This simple example shows a feature toggle for an "Edit User" feature. If the boolean condition is false, then we only show the "New User" feature and the "Admin" feature. This boolean value will be provided by various means, usually a configuration file. This means at certain points we can change this value in order to demonstrate the "Edit User" functionality. Our demo environment could …

Reused Abstraction Principle

This is the second part of my series on abstractions.Part 1 - AbstractionsPart 3 - Dependency Elimination PrincipleThe Reused Abstraction Principle is a simple in concept in practice, but oddly rarely followed in typical enterprise development. I myself have been incredibly guilty of this in the past.Most code bases have a 1:1 mapping of interfaces to implementations. Usually this is the sign of TDD or automated testing being applied badly. The majority of these interfaces are wrong. 1:1 mappings between interfaces and implementations is a code smell.Such situations are usually the result of extracting an interface from an implementation, rather than having the client drive behaviour.These interfaces are also often bad abstractions, known as "leaky abstractions". As I've discussed previously, these abstractions tend to offer nothing more than simple indirection.ExampleApply the "rule of three". If there is only ever one implementation, then you don't need …