Handle import issues for browser vs node batch span processor

[Abinet18]

By default only the node related BatchSpanProcessor is exported . The browser related BatchSpanProcessor is only usable at compile time when the corresponding config (e.g target=web in webpack) is available. But in the code editor it always resolves to the node batch span processor which thus shows code error when adding browser batch processor specific parameters like disableAutoFlushOnDocumentHide. Can this be addressed in a different way (like exporting the node and browser exporters with different names

)

[dyladan]

Hmm interesting. I can see two ways to solve this:

1. Export with different names
2. Use a single config type for both processors and document which types are node/browser specific in the ts docs

[dyladan]

2 is the easiest to implement without deprecating the existing name or duplicating too much

[Abinet18]

Option 2 is easier of course, but not type safe. If that is not a problem for now, we can create an issue and work on the change then.

[dyladan]

2 isn't completely ideal but it can work I think

// given the following types
type NodeConfig = {
	someNodeOption?: boolean
};

type BrowserConfig = {
	someBrowserOption?: boolean
}

// option 1
type NodeOrBrowserConfig = NodeConfig | BrowserConfig;

// option 2
type Config = {
 	/** the following config applies only to node */
	someNodeOption?: boolean;

	/** the following config applies only to browser */
	someBrowserOption?: boolean;
}

It is of course possible in option 1 to use the wrong type or in option 2 to provide browser options to the node class and vice versa. Since all options are optional in the case of the batch span processor it is quite easy to combine them in this way.

[Abinet18]

In this specific case , we find this configs in the existing code

export interface BufferConfig {
  /** The maximum batch size of every export. It must be smaller or equal to
   * maxQueueSize. The default value is 512. */
  maxExportBatchSize?: number;

  /** The delay interval in milliseconds between two consecutive exports.
   *  The default value is 5000ms. */
  scheduledDelayMillis?: number;

  /** How long the export can run before it is cancelled.
   * The default value is 30000ms */
  exportTimeoutMillis?: number;

  /** The maximum queue size. After the size is reached spans are dropped.
   * The default value is 2048. */
  maxQueueSize?: number;
}

export interface BatchSpanProcessorBrowserConfig extends BufferConfig {
  /** Disable flush when a user navigates to a new page, closes the tab or the browser, or,
   * on mobile, switches to a different app. Auto flush is enabled by default. */
  disableAutoFlushOnDocumentHide?: boolean;
}

So what we need for option 2 is just remove the interface BatchSpanProcessorBrowserConfig and add its attribute to the main config type

export interface BufferConfig {
... other attributes as above
 /** Disable flush when a user navigates to a new page, closes the tab or the browser, or,
   * on mobile, switches to a different app. Auto flush is enabled by default. */
  disableAutoFlushOnDocumentHide?: boolean;
}