@segment/analytics-react-native/lib/module/plugins/QueueFlushingPlugin.js

The hassle-free way to add Segment analytics to your React-Native app.

import { createStore } from '@segment/sovran-react-native';
import { defaultConfig } from '../constants';
import { UtilityPlugin } from '../plugin';
import { PluginType } from '../types';
import { createPromise } from '../util';
import { ErrorType, SegmentError } from '../errors';
/**
 * This plugin manages a queue where all events get added to after timeline processing.
 * It takes a onFlush callback to trigger any action particular to your destination sending events.
 * It can autotrigger a flush of the queue when it reaches the config flushAt limit.
 */
export class QueueFlushingPlugin extends UtilityPlugin {
  // Gets executed last to keep the queue after all timeline processing is done
  type = PluginType.after;
  timeoutWarned = false;
  /**
   * @param onFlush callback to execute when the queue is flushed (either by reaching the limit or manually) e.g. code to upload events to your destination
   * @param storeKey key to store the queue in the store. Must be unique per destination instance
   * @param restoreTimeout time in ms to wait for the queue to be restored from the store before uploading events (default: 500ms)
   */
  constructor(onFlush, storeKey = 'events', restoreTimeout = 1000) {
    super();
    this.onFlush = onFlush;
    this.storeKey = storeKey;
    const {
      promise,
      resolve
    } = createPromise(restoreTimeout);
    this.isRestored = promise;
    this.isRestoredResolve = resolve;
  }
  configure(analytics) {
    super.configure(analytics);
    const config = analytics?.getConfig() ?? defaultConfig;

    // Create its own storage per SegmentDestination instance to support multiple instances
    this.queueStore = createStore({
      events: []
    }, {
      persist: {
        storeId: `${config.writeKey}-${this.storeKey}`,
        persistor: config.storePersistor,
        saveDelay: config.storePersistorSaveDelay ?? 0,
        onInitialized: () => {
          this.isRestoredResolve();
        }
      }
    });
  }
  async execute(event) {
    await this.queueStore?.dispatch(state => {
      const stampedEvent = {
        ...event,
        _queuedAt: Date.now()
      };
      const events = [...state.events, stampedEvent];
      return {
        events
      };
    });
    return event;
  }

  /**
   * Calls the onFlush callback with the events in the queue.
   * Ensures only one flush operation runs at a time.
   */
  async flush() {
    if (this.flushPromise) {
      this.analytics?.logger.info('Flush already in progress, waiting for completion');
      await this.flushPromise;
      return;
    }
    this.flushPromise = this._doFlush();
    try {
      await this.flushPromise;
    } finally {
      this.flushPromise = undefined;
    }
  }
  async _doFlush() {
    // Wait for the queue to be restored
    try {
      await this.isRestored;
      if (this.timeoutWarned === true) {
        this.analytics?.logger.info('Flush triggered successfully.');
        this.timeoutWarned = false;
      }
    } catch (e) {
      // If the queue is not restored before the timeout, we will notify but not block flushing events
      if (this.timeoutWarned === false) {
        this.analytics?.reportInternalError(new SegmentError(ErrorType.InitializationError, 'Queue restoration timeout', e));
        this.analytics?.logger.warn('Flush triggered but queue restoration and settings loading not complete. Flush will be retried.', e);
        this.timeoutWarned = true;
      }
    }
    const events = (await this.queueStore?.getState(true))?.events ?? [];
    await this.onFlush(events);
  }
  async dequeueByMessageIds(messageIds) {
    await this.queueStore?.dispatch(state => {
      if (messageIds.length === 0 || state.events.length === 0) {
        return state;
      }
      const idsToRemove = new Set(messageIds);
      const filteredEvents = state.events.filter(e => e.messageId == null || !idsToRemove.has(e.messageId));
      return {
        events: filteredEvents
      };
    });
  }

  /**
   * Clear all events from the queue
   */
  async dequeueEvents() {
    await this.queueStore?.dispatch(() => {
      return {
        events: []
      };
    });
  }

  /**
   * * Returns the count of items in the queue
   */
  async pendingEvents() {
    const events = (await this.queueStore?.getState(true))?.events ?? [];
    return events.length;
  }
}
//# sourceMappingURL=QueueFlushingPlugin.js.map