Skip to main content

Why does the JavaScript SDK return Not Ready status in slow networks?

Issue​

When using JavaScript SDK in Browser, the SDK status will mostly return Not Ready when users are on a slow Network (for example 3G).

Root Cause​

It takes a long time for the SDK to fetch the feature flags and Segments Information data from Harness FME servers due to slow network, which might cause control treatments.

Solution​

You need to Increase the startup.readyTimeout value to ensure it covers the FME definition fetching time.

As explained in https://docs.split.io/docs/javascript-sdk-overview under Configuration section, the default value for startup.requestTimeoutBeforeReady is 1.5 seconds.

Follow the steps below to implement the solution:

  1. Find out how long it takes the browser to fetch the FME definition under slow Network, Chrome Dev tools can be used to simulate 3G Network.
  2. Make sure to enable the Java SDK console debug logging by running the following command in the browser JavaScript console:
localStorage.splitio_debug = 'on'
  1. Load your page and check the debug logging, look for the following line:
[TIME TRACKER]: [Fetching - Splits] took xxxx ms to finish

Where xxxx is the total time in milliseconds.

  1. Set the requestTimeoutBeforeReady and readyTimeout parameters to a higher value than the total fetching time. Example:
var sdk = SplitFactory({
startup: {
requestTimeoutBeforeReady: 5, 
readyTimeout: 5
},
  1. In addition to the above, enable using the browser cache to store the FME definition, to avoid using the network each time the FME definition data is needed. You only need to specify the the structure below when initializing your SDK object:
storage: {
type: 'LOCALSTORAGE',
prefix: 'MYPREFIX'
},