⚗️ Modular SDK - Split by feature using plugins

[amortemousque]

Motivation

• Extend the plugin system to be used for internal SDK feature
• Add lazy loading plugin capability

Changes

Extends the plugin

browser-sdk/packages/rum-core/src/domain/plugins.ts

Lines 9 to 19 in 1e8ce41

	export interface RumPlugin {
	name: string
	getApi?(): { [key: string]: any }
	getConfigurationTelemetry?(): Record<string, unknown>
	getInternalContext?(options: { startTime: RelativeTime }): Context
	onInit?(options: { initConfiguration: RumInitConfiguration; publicApi: RumPublicApi }): void
	onStart?(...args: any[]): void
	onEvent?(options: { startTime: RelativeTime; rumEvent: RumEvent & Context }): void
	onTelemetryEvent?(options: { telemetryEvent: TelemetryEvent }): void
	}

Ex: action plugin

Wait for the plugins to be loaded before starting (Ìn preStartRum):

browser-sdk/packages/rum-core/src/boot/preStartRum.ts

Lines 127 to 130 in 1e8ce41

	const lazyLoadedPlugins = await loadLazyPlugins(['action']) // look at how to pass the required plugins from the init config
	if (!lazyLoadedPlugins) {
	return
	}

Call plugins hooks during the SDK lifecycle

• At init to access the conf:
  

  browser-sdk/packages/rum-core/src/boot/preStartRum.ts

  Lines 133 to 134 in 1e8ce41

  	callPluginsMethod(plugins, 'onInit', { initConfiguration, publicApi })

• In the assembly to enrich the event:
  

  browser-sdk/packages/rum-core/src/domain/assembly.ts

  Lines 180 to 181 in 1e8ce41

  	callPluginsMethod(configuration.plugins, 'onEvent', { startTime, rumEvent: serverRumEvent })

• etc...

Testing

• Local
• Staging
• Unit
• End to end

---

I have gone over the contributing documentation.