[ENHANCEMENT] Pass the maxRetry option to the createBatchEventProcessor

[lorenzo-lungo]

Description

Implement a way to pass the maxRetry option to the createBatchEventProcessor method (like it is passed internally to getBatchEventProcessor) and add a default to it (maybe again the same as the getBatchEventProcessor)

Benefits

Having a number of maximum retries means that we avoid infinite retries in the case where they keep failing (in our case due to an adblocker)

Risks/Downsides

No real downsides imho

[raju-opti]

Edit: In this comment, I was thinking of the polling config manager. This issue is about retries in the event processor. Please ignore this.

Hello. We have create internal ticket FSSDK-12004 which is planned for the next sprint.

In the meantime, one way to deal with the infinite retries is using onReady() with a timeout and closing the instance when onReady() promise rejects.

optimizely.onReady({ timeout: 10_000 }).catch((err) => {
  optimizely.close();
});

[raju-opti]

Hello @lorenzo-lungo , the batch event processor already had default maxRetries set to 5. The root cause of the infinite retries you saw is different. Actually, there are two kinds of retries in the batch event processor. When an event is queued for processing, the eventProcessor stores the event in a persistent store (for browser, it's localStorage) in addition to the in memory queue. When a batch is dispatched, the dispatch request is retried maxRetries number of times, and the events are removed from the store on success. If the event dispatch fails after maxRetries, the event stays in the persistent store. The events in the persistent store (which could be failed events from the current page, or events that were not dispatched from a previous visit of the page) are retried separately with a fixed period (not configurable by the user, currently 20 seconds). The infinite retry you saw is coming from that.

We have just released v6.3.0, with it, you can control how long the events stay in the persistent store, by passing the storeTtl option to createBatchEventProcessor.

const eventProcessor = createBatchEventProcessor({ 
  storeTtl: 50_000, // in milliseconds
})

With the above configuration, the failed events in the store will expire after 50 seconds, thereby solving the infinite retry.

[lorenzo-lungo]

Hi Raju, my issue is with the optimizely-sdk/browser version of Optimizely and there I do not see the option for storeTtl

[raju-opti]

Hi @lorenzo-lungo , the option is on createBatchEventProcessor factory, not on createInstance.

Here is an example:

import {
  createInstance,
  createPollingProjectConfigManager,
  createBatchEventProcessor,
} from '@optimizely/optimizely-sdk';

const optimizely = createInstance({
  projectConfigManager: createPollingProjectConfigManager({
    sdkKey: '<YOUR_SDK_KEY>',
  }),
  eventProcessor: createBatchEventProcessor({
    storeTtl: 50_000,
  }),
});

[lorenzo-lungo]

Yes that is what I was doing but I get
Object literal may only specify known properties, and 'storeTtl' does not exist in type 'BatchEventProcessorOptions
And in fact if I check BatchEventProcessorOptions I do not see storeTtl

[raju-opti]

@lorenzo-lungo
Here is an example project: https://github.com/raju-opti/issue_1101
storeTtl used here: https://github.com/raju-opti/issue_1101/blob/aa43447c46d7670f9e8a627dcee2a42463f6929a/src/counter.ts#L13