Optional request timeout

[aarsilv]

🎟️ Ticket: FF-1256 - Optionally pass and use, if present, the Sample Size Calculator Run ID in traffic count data tasks

Currently, our client has a hard-coded default timeout of five seconds (5000 milliseconds) to request the configuration from the CDN. If it fails, it will throw a timeout error.

However, some clients may want to specify the timeout. This pull request adds a new optional client configuration option, requestTimeoutMs, to allow upstream callers of init() to specify a desired timeout. If it's not specified, we continue to use our default.

This pull request also adds a helpful warning message explaining the impact of a failed initialization.

Lastly, some cleanup around package version compatibility and auto-generated docs have been done as well.

For example, the below results in an error when simulating six-second latency, but the error message shows the overridden three-second timeout is at play:

opts = {apiKey: '<API KEY>', requestTimeoutMs: 3000};
window.eppo.init(opts).then(function() {
  console.log('Client initialized');
});

And a timeout of ten seconds is sufficient for success even with six-second latency.

opts = {apiKey: '<API KEY>', requestTimeoutMs: 10000};
window.eppo.init(opts).then(function() {
  console.log('Client initialized');
});

[aarsilv]

Changed to be executable so it can run as a commit hook

[aarsilv]

The latest auto-generated docs use ** for bolding and _ for italic. (which I prefer in GitHub markdown anyways 📈 )

[aarsilv]

Autogenerated docs for newly added client configuration

[aarsilv]

npm was not happy installing an older version of ts-jest with a newer version of jest. Bumping appeased it.

[aarsilv]

Did a yarn install using node 16.20, as that is the min version in our common client (source)

[sameerank]

Maybe I missed it in the PR description: why was this needed for the sample size calculator? Were the counts looking wrong due to SDK timeouts?

[sameerank]

👍