Record and playback - Types

[HarshaNalluru]

Provide proper types for the recorder module -

[sadasant]

Here are some of the things that I've spotted. Before going through this, please bring others to the conversation:

1. Most of the methods are missing a decent tsdocs cleanup and review.
2. async function blobToString(blob: Blob): Promise<string> uses fileReader.onloadend = (ev: any) => { which can be fileReader.onloadend = (ev: ProgressEvent<FileReader>) => {.
3. String.prototype.padStart() is an anti-pattern. We shouldn't change the prototype of the default types.
4. In utils.ts, move isBrowser to the top of the file (so that it is declared before it's used).
5. In recorder.ts, (runtime === "node" && !isBrowser()) || should probably be moved to a local variable named onlyInNode, same with onlyInBrowser. It will help with the readability.
6. In recorder.ts, skip should show a warning if TEST_MODE is not set.
7. In recorder.ts, references to known, statically named properties shouldn't be in strings. uniqueTestInfo["uniqueName"][label] should probably be uniqueTestInfo.uniqueName.[label].
8. customConsoleLog should probably be called differently. Something like improveBrowserLogs(), and probably only run if isBrowser.
9. replaceableVariables should probably be called hideEnvironmentVariables.
10. setReplacements should be called customizeRecordingWith.
11. skipQueryParams should probably be called hideQueryParameters and behave similarly to hideEnvironmentVariables.
12. setEnvironmentOnLoad needs a more expressive name.
13. I kind of want to extract the logic into a more modular pattern: extract methods that do the basic operations and have the main methods invoke those more specific ones. It will help improve the specifics without having to think on the whole picture.

We should probably invite others to take a look and think about this, so we can have a better perspective on how to improve this.

[HarshaNalluru]

Agree with many of the points raised.

In recorder.ts, skip should show a warning if TEST_MODE is not set.

what? why?

[HarshaNalluru]

V2 is nicer :)