Old:	New:

The J is more legible now and not stuck into the top of the suit. The corners on the card are correctly rounded now, and the border is cleaner. Here’s another example:

Old:	New:

Again, the rank (“9″) is much clearer now.

We’ve been playing with these cards ourselves for a few months and have really grown to like the changes. We hope you do too.

So when things suddenly broke today we figured they’d finally made the switch. We’ve spent the last few hours trying to get everything back up and running and, for the most part, it seems to be working.

I am still seeing timeouts all the time though, and so I assume everyone else is too. We’re still trying to clear it up–the cause of this last issue is not entirely clear yet.

If anything else is wonky, let us know.

This fragility annoyed us and so we came up with a solution:

• We replaced all of our <script> tags with calls to a custom “script” function in our HTML template system (we use Template::Toolkit; [% script("sht.js") %] is what the new calls look like).
• The “script” function is a native perl function that does a number of things:
  1. Reads the Javascript file into memory. While reading it understands C style “#include” directives so we can structure the code nicely (though we actually don’t take advantage of that yet)
  2. Uses JavaScript::Minifier::XS to minify the resulting code.
  3. Calculates the SHA hash of the minified code.
  4. Saves the minified code to a cache directory where it is named based on its hash value which makes the name globally unique (it also keeps it’s original name as a prefix so debugging is sane).
  5. Keeps track of the original script name, the minified script’s globally unique name, and the dependencies used to build the image. This is stored in a hash table and also saved to the disk for future runs.
  6. It returns a script tag that refers to the globally unique Javascript file back to the template which ends up going out in the html file. For example, <script src="js/sht-bfe39ec2e457bd091cb6b680873c4a90.js" type="text/javascript"></script>
• There’s actually a step 0 in there too. If the original Javascript file name is found in the hash table then it quickly stats its saved dependencies to see if they are newer than the saved minified file. If the minified file is up to date then steps 1 through 5 are skipped.

The advantages of this approach

It solves the original problem.

When the user refreshes the page they will either get the page from their browser cache or they will get it from our site. No matter where it came from the Javascript files it references are now uniquely named so that it is impossible for the files to be out of date from each other.

That is, if you get the old html file you will reference all the old named Javascript files and everything will be mutually consistent (even though it is out of date). If you get the new html file it guarantees you will have to fetch the latest Javascript files because the new html only references the new hashed names that aren’t going to be in your browser cache.

It’s fast.

Everything is cached so it only does the minification and hash calculations once per file. We’re obviously running FastCGI so the in memory cache goes across http requests. More importantly the js/ dir is statically served by the web server so it’s exactly as fast as it was before we did this (since we served the .js files without any preprocessing). All this technique adds is a couple filesystem stats per page load, which isn’t much.

It’s automatic.

There’s no script to remember to run when we update the site. We just push our changes up to the site using our version control and the script lazily takes care of rebuilding any files that may have gone out of date.

So you might be thinking, isn’t all that dependency stuff hard and error prone? Well, it’s really only one line of perl code:

sub max_timestamp(@) { max map { (stat $_)[9] || 0 } @_ } # Obviously 9 is mtime

It’s stateless.

It doesn’t rely on incrementing numbers (“js/v10/script.js” or even “js/script-v10.js”). We considered this approach but decided it was actually harder to implement and had no advantages over the way we chose to do it. This may have been colored by our chosen version control system (darcs) where monotonically increasing version numbers have no meaning.

It allows aggressive caching.

Since the files are named by their contents’ hash, you can set the cache time up to be practically infinite.

It’s very simple to understand.

It took less than a page of perl code to implement the whole thing and it worked the first time with no bugs. I believe it’s taken me longer to write this blog post than it took to write the code (granted I’d been thinking about it for a long time before I started coding).

No files are deleted.

The old js files are not automatically deleted (why bother, they are tiny) so people with extremely old html files will not have inconsistent pages when they reload. However:

The js/ dir is volatile.

It’s written so we can rm js/* at any point and it will just recreate what it needs to on the next request. This means there’s nothing to do when you unpack the source into a new directory while developing.

You get a bit of history.

Do a quick ls -lrt of the directory and you can see which scripts have been updated recently and in what order they got built.

What it doesn’t solve

While it does solve the problem of Javascript to Javascript API interaction, it does not help with Javascript to server API interaction–it doesn’t even attempt to solve that issue. The only way I know to solve that is to carefully craft the new APIs in parallel with the old ones so that there is a period of time where both old and new can work while the browser caches slowly catch up with your new world.

And… It seems to work

I’ve seen similar schemes discussed but I’ve not seen exactly what we ended up with. It’s been working well for us–I don’t think I’ve seen a single bug from a user in a couple months that is caused by inconsistent caching of Javascript files by the browser.

We’ve already found at least one large bug that slipped past our rigorous (ahem) testing, so be on the lookout for anything weird and make sure you send us a bug report if you do find something wrong.

These changes should ease development for Jim’s and I as well. We’ve been unable to add certain features to the site because of design decisions we made 4 years ago. Even simple things like changing your user name were pretty much impossible because of the way we did things originally. We look forward to being able to add some neat features in the future.

This means for example that in Free Cell and Sea Haven Towers you can now often drag the bottom card in one of the tableaus as the very first move! Give it a try and let us know what you think.

Currently in Klondike you can even move cards that are still turned over if the cards above can easily be moved. This seems a bit like cheating in this case since if you let go without moving, you can get sneak peak at the card without incurring the normal undo penalty. We may disallow this in the future.

As a Flower Garden fan, I think this improves the gameplay a lot when you are towards the end of a game.

It doesn’t seem that new to us because Jim wrote the first rough draft of it in September of 2005. Wow, we move kind of slow sometimes! It’s been 99% done for almost a year and a half but we had a bug where it wouldn’t let you type numbers into your username or password so many of you wouldn’t have been able to log in when the page was up. I finally got that fixed today (in a way that made me happy) and so you will now see Sudoku on the leader board and in the menus.

Have fun!

We’ve been testing them internally for the past 9 months and we haven’t found any bugs in the past 6 months, so today I loaded all the new stuff onto the main site.

It looks like everything is working to me, but if you have any strange problem first try holding down shift while reloading/refreshing the page. If that you still have the problem after that, report it to us so we can fix it.