[plugin] RUM plugin

.github/CODEOWNERS

@@ -6,3 +6,7 @@
 # Telemetry
 packages/plugins/telemetry                                            @DataDog/frontend-devx @yoannmoinet
 packages/tests/src/plugins/telemetry                                  @DataDog/frontend-devx @yoannmoinet
+
+# Rum
+packages/plugins/rum                                                  @DataDog/rum @yoannmoinet
+packages/tests/src/plugins/rum                                        @DataDog/rum @yoannmoinet

LICENSES-3rdparty.csv

@@ -176,6 +176,7 @@ Component,Origin,Licence,Copyright
 @tsconfig/node12,npm,MIT,(https://www.npmjs.com/package/@tsconfig/node12)
 @tsconfig/node14,npm,MIT,(https://www.npmjs.com/package/@tsconfig/node14)
 @tsconfig/node16,npm,MIT,(https://www.npmjs.com/package/@tsconfig/node16)
+@types/async-retry,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/async-retry)
 @types/babel__core,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/babel__core)
 @types/babel__generator,npm,MIT,(https://www.npmjs.com/package/@types/babel__generator)
 @types/babel__preset-env,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/babel__preset-env)
@@ -200,6 +201,7 @@ Component,Origin,Licence,Copyright
 @types/node,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node)
 @types/parse-json,npm,MIT,(https://www.npmjs.com/package/@types/parse-json)
 @types/resolve,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/resolve)
+@types/retry,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/retry)
 @types/semver,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/semver)
 @types/stack-utils,npm,MIT,(https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stack-utils)
 @types/wrap-ansi,npm,MIT,(https://www.npmjs.com/package/@types/wrap-ansi)
@@ -275,6 +277,7 @@ assert-plus,npm,MIT,Mark Cavage (https://www.npmjs.com/package/assert-plus)
 assign-symbols,npm,MIT,Jon Schlinkert (https://github.com/jonschlinkert/assign-symbols)
 astral-regex,npm,MIT,Kevin Mårtensson (github.com/kevva)
 async-each,npm,MIT,Paul Miller (https://github.com/paulmillr/async-each/)
+async-retry,npm,MIT,(https://www.npmjs.com/package/async-retry)
 asynckit,npm,MIT,Alex Indigo (https://github.com/alexindigo/asynckit#readme)
 atob,npm,(MIT OR Apache-2.0),AJ ONeal (https://git.coolaj86.com/coolaj86/atob.js.git)
 available-typed-arrays,npm,MIT,Jordan Harband (https://github.com/inspect-js/available-typed-arrays#readme)
@@ -437,6 +440,7 @@ esrecurse,npm,BSD-2-Clause,(https://github.com/estools/esrecurse)
 estraverse,npm,BSD-2-Clause,(https://github.com/estools/estraverse)
 estree-walker,npm,MIT,Rich Harris (https://www.npmjs.com/package/estree-walker)
 esutils,npm,BSD-2-Clause,(https://github.com/estools/esutils)
+eventemitter3,npm,MIT,Arnout Kazemier (https://www.npmjs.com/package/eventemitter3)
 events,npm,MIT,Irakli Gozalishvili (http://jeditoolkit.com)
 evp_bytestokey,npm,MIT,Calvin Metcalf (https://github.com/crypto-browserify/EVP_BytesToKey)
 execa,npm,MIT,Sindre Sorhus (sindresorhus.com)
@@ -697,9 +701,12 @@ os-homedir,npm,MIT,Sindre Sorhus (sindresorhus.com)
 os-tmpdir,npm,MIT,Sindre Sorhus (sindresorhus.com)
 osenv,npm,ISC,Isaac Z. Schlueter (http://blog.izs.me/)
 outdent,npm,MIT,Andrew Bradley (https://github.com/cspotcode/outdent#readme)
+p-finally,npm,MIT,Sindre Sorhus (sindresorhus.com)
 p-limit,npm,MIT,Sindre Sorhus (sindresorhus.com)
 p-locate,npm,MIT,Sindre Sorhus (sindresorhus.com)
 p-map,npm,MIT,Sindre Sorhus (https://sindresorhus.com)
+p-queue,npm,MIT,(https://www.npmjs.com/package/p-queue)
+p-timeout,npm,MIT,Sindre Sorhus (sindresorhus.com)
 p-try,npm,MIT,Sindre Sorhus (sindresorhus.com)
 pad,npm,BSD-3-Clause,David Worms (https://github.com/adaltas/node-pad)
 pako,npm,(MIT AND Zlib),(https://github.com/nodeca/pako)
@@ -771,6 +778,7 @@ resolve-url,npm,MIT,Simon Lydell (https://www.npmjs.com/package/resolve-url)
 resolve.exports,npm,MIT,Luke Edwards (https://lukeed.com)
 restore-cursor,npm,MIT,Sindre Sorhus (sindresorhus.com)
 ret,npm,MIT,Roly Fentanes (https://github.com/fent)
+retry,npm,MIT,Tim Koschützki (https://github.com/tim-kos/node-retry)
 reusify,npm,MIT,Matteo Collina (https://github.com/mcollina/reusify#readme)
 rimraf,npm,ISC,Isaac Z. Schlueter (http://blog.izs.me/)
 ripemd160,npm,MIT,(https://www.npmjs.com/package/ripemd160)

README.md

@@ -20,6 +20,7 @@ A set of plugins to interact with Datadog directly from your builds.
 
 <!-- #toc -->
 -   [Plugins](#plugins)
+    -   [`rum` RUM Plugin](#rum-rum-plugin)
     -   [`telemetry` Telemetry Plugin](#telemetry-telemetry-plugin)
 -   [Configuration](#configuration)
     -   [`auth.apiKey`](#authapikey)
@@ -32,6 +33,12 @@ A set of plugins to interact with Datadog directly from your builds.
 ## Plugins
 
 <!-- #list-of-packages -->
+### `rum` RUM Plugin
+
+> Interact with our Real User Monitoring product (RUM) in Datadog directly from your build system.
+
+<kbd>[📝 Full documentation ➡️](./packages/plugins/rum#readme)</kbd>
+
 ### `telemetry` Telemetry Plugin
 
 > Display and send telemetry data as metrics to Datadog.
@@ -52,6 +59,17 @@ A set of plugins to interact with Datadog directly from your builds.
         endPoint?: string;
     };
     logLevel?: 'debug' | 'warn' | 'error' | 'none';
+    rum?: {
+        disabled?: boolean;
+        sourcemaps?: {
+            basePath: string;
+            dryRun?: boolean;
+            maxConcurrency?: number;
+            minifiedPathPrefix?: string;
+            releaseVersion: string;
+            service: string;
+        };
+    };
     telemetry?: {
         disabled?: boolean;
         output?: boolean

packages/core/src/plugins/git/index.ts

@@ -14,8 +14,8 @@ export const getGitPlugin = (options: Options, context: GlobalContext): Unplugin
         enforce: 'pre',
         async buildStart() {
             // Verify that we should get the git information based on the options.
-            // Only get git information if git is not disabled.
-            const shouldGetGitInfo = options.disableGit !== true;
+            // Only get git information if sourcemaps are enabled and git is not disabled.
+            const shouldGetGitInfo = options.rum?.sourcemaps && options.disableGit !== true;
 
             if (!shouldGetGitInfo) {
                 return;

packages/core/src/types.ts

@@ -3,6 +3,8 @@
 // Copyright 2019-Present Datadog, Inc.
 
 // #imports-injection-marker
+import type { RumOptions } from '@dd/rum-plugins/types';
+import type * as rum from '@dd/rum-plugins';
 import type { TelemetryOptions } from '@dd/telemetry-plugins/types';
 import type * as telemetry from '@dd/telemetry-plugins';
 // #imports-injection-marker
@@ -50,6 +52,7 @@ export interface GetPluginsOptions {
 export interface Options extends GetPluginsOptions {
     // Each product should have a unique entry.
     // #types-injection-marker
+    [rum.CONFIG_KEY]?: RumOptions;
     [telemetry.CONFIG_KEY]?: TelemetryOptions;
     // #types-injection-marker
 }

packages/esbuild-plugin/src/index.ts

@@ -21,6 +21,7 @@ export type { Options as EsbuildPluginOptions } from '@dd/core/types';
 
 export type {
     // #types-export-injection-marker
+    RumTypes,
     TelemetryTypes,
     // #types-export-injection-marker
 } from '@dd/factory';

packages/factory/package.json

@@ -17,6 +17,7 @@
     },
     "dependencies": {
         "@dd/core": "workspace:*",
+        "@dd/rum-plugins": "workspace:*",
         "@dd/telemetry-plugins": "workspace:*",
         "unplugin": "1.10.1"
     }

packages/factory/src/index.ts

@@ -12,6 +12,8 @@ import { getInternalPlugins } from '@dd/core/plugins/index';
 import type { Options } from '@dd/core/types';
 
 // #imports-injection-marker
+import type { OptionsWithRum } from '@dd/rum-plugins/types';
+import * as rum from '@dd/rum-plugins';
 import type { OptionsWithTelemetry } from '@dd/telemetry-plugins/types';
 import * as telemetry from '@dd/telemetry-plugins';
 // #imports-injection-marker
@@ -20,12 +22,14 @@ import type { UnpluginContextMeta, UnpluginInstance, UnpluginOptions } from 'unp
 import { createUnplugin } from 'unplugin';
 
 // #types-export-injection-marker
+export type { types as RumTypes } from '@dd/rum-plugins';
 export type { types as TelemetryTypes } from '@dd/telemetry-plugins';
 // #types-export-injection-marker
 
 export const helpers = {
     // Each product should have a unique entry.
     // #helpers-injection-marker
+    [rum.CONFIG_KEY]: rum.helpers,
     [telemetry.CONFIG_KEY]: telemetry.helpers,
     // #helpers-injection-marker
 };
@@ -51,6 +55,9 @@ export const buildPluginFactory = ({
 
         // Based on configuration add corresponding plugin.
         // #configs-injection-marker
+        if (options[rum.CONFIG_KEY] && options[rum.CONFIG_KEY].disabled !== true) {
+            plugins.push(...rum.getPlugins(options as OptionsWithRum, globalContext));
+        }
         if (options[telemetry.CONFIG_KEY] && options[telemetry.CONFIG_KEY].disabled !== true) {
             plugins.push(...telemetry.getPlugins(options as OptionsWithTelemetry, globalContext));
         }

packages/plugins/rum/README.md

@@ -0,0 +1,29 @@
+# RUM Plugin <!-- #omit in toc -->
+
+Interact with our Real User Monitoring product (RUM) in Datadog directly from your build system.
+
+<!-- The title and the following line will both be added to the root README.md  -->
+
+## Table of content <!-- #omit in toc -->
+
+<!-- This is auto generated with yarn cli integrity -->
+
+<!-- #toc -->
+-   [Configuration](#configuration)
+<!-- #toc -->
+
+## Configuration
+
+```ts
+rum?: {
+    disabled?: boolean;
+    sourcemaps?: {
+        basePath: string;
+        dryRun?: boolean;
+        maxConcurrency?: number;
+        minifiedPathPrefix?: string;
+        releaseVersion: string;
+        service: string;
+    };
+}
+```

packages/plugins/rum/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "@dd/rum-plugins",
+    "packageManager": "yarn@4.0.2",
+    "license": "MIT",
+    "private": true,
+    "author": "Datadog",
+    "description": "Interact with our Real User Monitoring product (RUM) in Datadog directly from your build system.",
+    "homepage": "https://github.com/DataDog/build-plugins/tree/main/packages/plugins/rum#readme",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/DataDog/build-plugins",
+        "directory": "packages/plugins/rum"
+    },
+    "exports": {
+        ".": "./src/index.ts",
+        "./sourcemaps/*": "./src/sourcemaps/*.ts",
+        "./*": "./src/*.ts"
+    },
+    "scripts": {
+        "typecheck": "tsc --noEmit"
+    },
+    "dependencies": {
+        "@dd/core": "workspace:*",
+        "async-retry": "1.3.3",
+        "chalk": "2.3.1",
+        "form-data": "4.0.0",
+        "glob": "7.1.6",
+        "outdent": "0.8.0",
+        "p-queue": "6.6.2",
+        "unplugin": "1.10.1"
+    },
+    "devDependencies": {
+        "@types/async-retry": "1.4.8"
+    }
+}

packages/plugins/rum/src/constants.ts

@@ -0,0 +1,8 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import type { PluginName } from '@dd/core/types';
+
+export const CONFIG_KEY = 'rum' as const;
+export const PLUGIN_NAME: PluginName = 'datadog-rum-plugin' as const;

packages/plugins/rum/src/index.ts

@@ -0,0 +1,47 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import { getLogger } from '@dd/core/log';
+import type { GlobalContext, GetPlugins } from '@dd/core/types';
+
+import { PLUGIN_NAME } from './constants';
+import { uploadSourcemaps } from './sourcemaps';
+import type { OptionsWithRum, RumOptions, RumOptionsWithSourcemaps } from './types';
+import { validateOptions } from './validate';
+
+export { CONFIG_KEY, PLUGIN_NAME } from './constants';
+
+export const helpers = {
+    // Add the helpers you'd like to expose here.
+};
+
+export type types = {
+    // Add the types you'd like to expose here.
+    RumOptions: RumOptions;
+    OptionsWithRum: OptionsWithRum;
+};
+
+export const getPlugins: GetPlugins<OptionsWithRum> = (
+    opts: OptionsWithRum,
+    context: GlobalContext,
+) => {
+    // Verify configuration.
+    const rumOptions = validateOptions(opts);
+    return [
+        {
+            name: PLUGIN_NAME,
+            async writeBundle() {
+                if (rumOptions.disabled) {
+                    return;
+                }
+
+                const log = getLogger(opts.logLevel, PLUGIN_NAME);
+                if (rumOptions.sourcemaps) {
+                    // Need the "as" because Typescript doesn't understand that we've already checked for sourcemaps.
+                    await uploadSourcemaps(rumOptions as RumOptionsWithSourcemaps, context, log);
+                }
+            },
+        },
+    ];
+};

packages/plugins/rum/src/sourcemaps/files.ts

@@ -0,0 +1,53 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import chalk from 'chalk';
+import glob from 'glob';
+import path from 'path';
+
+import type { RumSourcemapsOptionsWithDefaults, Sourcemap } from '../types';
+
+type PartialSourcemap = Pick<Sourcemap, 'minifiedFilePath' | 'minifiedUrl' | 'relativePath'>;
+
+const getGlobPattern = (basePath: string) => {
+    // Normalizing the basePath to resolve .. and .
+    // Always using the posix version to avoid \ on Windows.
+    const newPath = path.posix.normalize(basePath);
+    return path.join(newPath, '**/*.@(js|mjs).map');
+};
+
+const decomposePath = (
+    options: RumSourcemapsOptionsWithDefaults,
+    sourcemapFilePath: string,
+): PartialSourcemap => {
+    if (path.extname(sourcemapFilePath) !== '.map') {
+        throw new Error(`The file ${chalk.green.bold(sourcemapFilePath)} is not a sourcemap.`);
+    }
+
+    const minifiedFilePath = sourcemapFilePath.replace(/\.map$/, '');
+    const relativePath = minifiedFilePath.replace(options.basePath, '');
+    const minifiedUrl = options.minifiedPathPrefix
+        ? path.join(options.minifiedPathPrefix, relativePath)
+        : relativePath;
+
+    return {
+        minifiedFilePath,
+        minifiedUrl,
+        relativePath,
+    };
+};
+
+export const getSourcemapsFiles = (options: RumSourcemapsOptionsWithDefaults): Sourcemap[] => {
+    const globPattern = getGlobPattern(options.basePath);
+    const sourcemapFilesList = glob.sync(globPattern);
+    const sourcemapFiles = sourcemapFilesList.map((sourcemapFilePath) => {
+        return {
+            ...decomposePath(options, sourcemapFilePath),
+            sourcemapFilePath,
+            minifiedPathPrefix: options.minifiedPathPrefix,
+        };
+    });
+
+    return sourcemapFiles;
+};

packages/plugins/rum/src/sourcemaps/index.ts

@@ -0,0 +1,37 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the MIT License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2019-Present Datadog, Inc.
+
+import type { Logger } from '@dd/core/log';
+import type { GlobalContext } from '@dd/core/types';
+import chalk from 'chalk';
+import { outdent } from 'outdent';
+
+import type { RumOptionsWithSourcemaps } from '../types';
+
+import { getSourcemapsFiles } from './files';
+import { sendSourcemaps } from './sender';
+
+export const uploadSourcemaps = async (
+    options: RumOptionsWithSourcemaps,
+    context: GlobalContext,
+    log: Logger,
+) => {
+    // Show a pretty summary of the configuration.
+    const green = chalk.green.bold;
+    const configurationString = Object.entries(options.sourcemaps)
+        .map(([key, value]) => `    - ${key}: ${green(value.toString())}`)
+        .join('\n');
+
+    const summary = outdent`
+    Uploading sourcemap with this configuration:
+    ${configurationString}
+    `;
+
+    log(summary);
+
+    // Gather the sourcemaps files.
+    const sourcemaps = getSourcemapsFiles(options.sourcemaps);
+    // Send everything.
+    await sendSourcemaps(sourcemaps, options.sourcemaps, context, log);
+};