Hackathon: sdk plugins

[bcaudan]

Motivation

More flexibility for prototyping, integration with third parties

Changes

Rum plugin interface (similar for logs):

interface RumPlugin {
  name: string
  version: string
  onRegistered?: (datadogRum: RumPublicApi) => void
  beforeSend?: RumInitConfiguration['beforeSend']
}

Registering API:

DD_RUM.registerPlugins: (...RumPlugin[]) => void

Dummy example:

class CurrentViewUpdateLogger {
  name: 'dummy_plugin'
  version: '0.0.0'
  datadogRum

  onRegistered(datadogRum) {
    this.datadogRum = datadogRum
  }

  beforeSend(event) {
    if (event.type === "view" && event.view.id === this.datadogRum?.getInternalContext()?.view?.id) {
      console.log("current view updated", event)
    }
  }
}

DD_RUM.registerPlugins(new CurrentViewUpdateLogger());

Features:

• beforeSend hook for plugins
• pass the global to plugins to allow them to call public APIs
• monitor individual plugin call to allow plugin failure without bothering the SDK execution
• add plugin name and version to plugin telemetry errors
• LaunchDarkly integration example without using the addFeatureFlagEvaluation API

Ideas:

• dedicated plugins context in event schema to allow external plugins to provide data
• provide monitor function for plugins to use on their own functions
• monitor plugins usage (with monitoring for all SDK APIs)
• rework sdk internals to also use plugins internally (product VS platform)
• provide more specific hooks to allow precise tweaks on SDK behaviour (new frustration type, change session storage)

Testing

• Local
• Staging
• Unit
• End to end

---

I have gone over the contributing documentation.