6

In my nodeJS app, I'd like to generate ETags for all the content that I return to the client. I need the ETag to be based off the actual content of the file instead of the date, so that the same file across different node processes has the same ETag.

Right now, I am doing the following:

var fs = require('fs'), crypto = require('crypto');
fs.readFile(pathToFile, function(err, buf){
  var eTag = crypto.createHash('md5').update(buf).digest('hex');
  res.writeHead(200, {'ETag': '"' + eTag + '"','Content-Type':contentType});
  res.end(buf);
});

I am not sure what encodings I should be using for the different crypto functions in order to have a proper system in place. Should I be using something other than hex? Should I get the fs.readFile call to return a hex encoded buffer? If so, will doing so impact the content returned to users?

Best, and Thanks,
Sami

gontrollez
  • 6,372
  • 2
  • 28
  • 36
thisissami
  • 15,445
  • 16
  • 47
  • 74

1 Answers1

8

You're doing it fine. There is no reason to encode the file in any special format, and using hex for the output is pretty standard. The requirements, loosely speaking, are:

  • the same document should always return the same ETag
  • any changes in the document causes a change in ETag
  • the ETag data should fit neatly into an HTTP header
slashingweapon
  • 11,007
  • 4
  • 31
  • 50
  • I have no idea how fast the node.js hash implementation is -- you will need to measure it for yourself. If the time to generate the hash is too long, you might think about caching the filename, modification time, and hash somewhere so you don't always have to recompute these things. – slashingweapon Nov 12 '12 at 15:34