Give talkback tapes more descriptive names

[sarayourfriend]

Problem

The talkback tapes are currently all named "response-${number}.json" which makes it difficult and annoying to figure out whether a particular request is being recorded without having to search the files. It also just makes the directory structure mostly meaningless.

Description

Luckily talkback supports custom tape name generation functions: https://github.com/ijpiantanida/talkback#file-name

We could do something similar to the example maybe:

function nameGenerator(tapeNumber: number, tape: Tape) {
  // organize in folders by request method
  // e.g. tapes/GET/v1--images/q=Galah&extension=jpg.json5
  //      tapes/GET/v1--audio/q=Birds&license=cc0.json5
  //      tapes/GET/v1--images/stats.json5
  const parts = [tape.req.method, tape.req.path.replace(/\\/g, '--')]

  if (tape.req.search) parts.push(tape.req.search)

  return path.join(...parts)
}

The method isn't as useful for us (almost all the API requests we make are just GETs) but it would distinguish against the analytics requests pretty well.

Alternatives

We could use any number of alternative naming schemes, we don't have to use the one described above. Experiment a bit and find one that makes sense for the requests we're recording.

Implementation

• 🙋 I would be interested in implementing this feature.