Skip to main content

Appcache manifest file issues/caveats


Application cache (appcache) is a powerful feature in HTML5. However, it does come with baggage. Many (see links below) advocated ferociously against it due to tricky issues it comes with. For someone who is just testing waters, these issues may throw them off grid. Knowing them before hand helps reduce some unpredictable effects.

Most important coding caveats about the manifest file and appcache.

  • The main html file that declares the manifest is ALSO cached in app cache, even if it is not defined in CACHE section. So, if you update the html itself (master),  in the manifest must change (a update-time-stamp) to see the changes (also will require user refresh or swapCache call)
  • If the master is rendered from server and it has varying (seeded or dynamic) parameters, a separate copy of the html is stored in appcache per canonical url (index.php?q=search1, index.php?q=search2 will have separate cached html). This is generally unnecessary, but if you do want to have parameters to pass to javascript, ensure that it is passed via location.hash(e.g: index.php#!q=search1)
  • Manifest file must begin with the line "CACHE MANIFEST" instruction. Empty lines are treated just like comments in some browsers, so ensure it is the first one
  • Manifest file must  be served with a text/cache-manifest MIME type. Chrome seems to be fine otherwise, but you dont write for chrome alone, do you?
  • Manifest file must  be encoded with 8-bit Unicode Transformation Format (UTF-8) character encoding. This is as per W3C stature, may be easy to do, before you find yourself in trouble.
  • The path URLs in CACHE section cannot have wildcards. (qualified - relative, canonical and external urls for each resource must be defined separately). URLs in  NETWORK and FALLBACK sections can have wildcards (/api will apply for api directory tree; /api/1.html and /api/2.html but not /api2 or /api2/1.html) .
  • URLs defined in CACHE are all or nothing. This is probably the biggest issue when you use external URLs, your app is now at the mercy of the availability and correct-ness (at the time of caching) of the external providers.
  • Preferred extension for file is .appcache, however, browsers seem to be fine with anything.
  • more in gotchas in get-offline, and here.

Popular posts from this blog

Powered By

As it goes, We ought to give thanks to people who power us. This page will be updated, like the version page , to show all the tools, and people this site is Powered By! Ubuntu GIMP Firebug Blogger Google [AppEngine, Ajax and other Apis] AddtoAny Project Fondue jQuery

Decorator for Memcache Get/Set in python

I have suggested some time back that you could modularize and stitch together fragments of js and css to spit out in one HTTP connection. That makes the page load faster. I also indicated that there ways to tune them by adding cache-control headers. On the server-side however, you could have a memcache layer on the stitching operation. This saves a lot of Resources (CPU) on your server. I will demonstrate this using a python script I use currently on my site to generate the combined js and css fragments. So My stitching method is like this @memize(region="jscss") def joinAndPut(files, ext): res = files.split("/") o = StringIO.StringIO() for f in res: writeFileTo(o, ext + "/" + f + "." + ext) #writes file out ret = o.getvalue() o.close() return ret; The method joinAndPut is * decorated * by memize. What this means is, all calls to joinAndPut are now wrapped (at runtime) with the logic in memize. All you wa...

Faster webpages with fewer CSS and JS

Its easy, have lesser images, css and js files. I will cover reducing number of images in another post. But If you are like me, You always write js and css in a modular fashion. Grouping functions and classes into smaller files (and Following the DRY rule, Strictly!). But what happens is, when you start writing a page to have these css and js files, you are putting them in muliple link rel=style-sheet or script tags. Your server is being hit by (same) number of HTTP Requests for each page call. At this point, its not the size of files but the number server roundtrips on a page that slows your page down. Yslow shows how many server roundtrips happen for css and js. If you have more than one css call and one js call, You are not using your server well. How do you achieve this? By concatinating them and spitting out the content as one stream. So Lets say I have util.js, blog.js and so.js. If I have a blog template that depends on these three, I would call them in three script tags. Wh...