👷 [FFL-23] Create datadog-flagging package (DataDog#3553)

leoromanovsky · web-flow · commit 5afe451aa7de · 2025-05-23T10:53:29.000-07:00
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,7 +1,8 @@
 # Order is important, the last matching pattern takes the most precedence.
 
 # Global
-*             @Datadog/rum-browser
+packages/flagging  @Datadog/feature-flagging-experimentation
+*                  @Datadog/rum-browser
 
 # Docs
 *README.md    @Datadog/rum-browser @DataDog/documentation
diff --git a/.github/codeql-config.yml b/.github/codeql-config.yml
@@ -3,6 +3,7 @@ name: 'CodeQL config'
 paths:
   - packages/core/src
   - packages/logs/src
+  - packages/flagging/src
   - packages/rum/src
   - packages/rum-core/src
   - packages/rum-slim/src
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,4 @@ package.tgz
 /playwright-report/
 /blob-report/
 /playwright/.cache/
+.vscode
diff --git a/eslint-local-rules/disallowSideEffects.js b/eslint-local-rules/disallowSideEffects.js
@@ -27,6 +27,7 @@ const packagesRoot = path.resolve(__dirname, '..', 'packages')
 // Those modules are known to have side effects when evaluated
 const pathsWithSideEffect = new Set([
   `${packagesRoot}/logs/src/entries/main.ts`,
+  `${packagesRoot}/flagging/src/entries/main.ts`,
   `${packagesRoot}/rum/src/entries/main.ts`,
   `${packagesRoot}/rum-slim/src/entries/main.ts`,
 ])
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -341,7 +341,7 @@ export default tseslint.config(
   },
 
   {
-    files: ['packages/{rum,logs,rum-slim}/src/entries/*.ts'],
+    files: ['packages/{rum,logs,flagging,rum-slim}/src/entries/*.ts'],
     rules: {
       'local-rules/disallow-enum-exports': 'error',
     },
diff --git a/packages/flagging/.npmignore b/packages/flagging/.npmignore
@@ -0,0 +1,7 @@
+*
+!/bundle/**/*.js
+!/cjs/**/*
+!/esm/**/*
+!/src/**/*
+/src/**/*.spec.ts
+/src/**/*.specHelper.ts
diff --git a/packages/flagging/.yarnrc b/packages/flagging/.yarnrc
@@ -0,0 +1 @@
+save-exact true
diff --git a/packages/flagging/README.md b/packages/flagging/README.md
@@ -0,0 +1,3 @@
+# Flagging SDK (Prerelease)
+
+This package supports flagging and experimentation by performing evaluation in the browser.
diff --git a/packages/flagging/package.json b/packages/flagging/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "@datadog/browser-flagging",
+  "version": "6.7.0",
+  "license": "Apache-2.0",
+  "private": true,
+  "main": "cjs/entries/main.js",
+  "module": "esm/entries/main.js",
+  "types": "cjs/entries/main.d.ts",
+  "scripts": {
+    "pack": "yarn pack",
+    "build": "run-p build:cjs build:esm build:bundle",
+    "build:bundle": "rm -rf bundle && SDK_SETUP=cdn webpack --mode=production",
+    "build:cjs": "rm -rf cjs && tsc -p tsconfig.cjs.json && yarn replace-build-env cjs",
+    "build:esm": "rm -rf esm && tsc -p tsconfig.esm.json && yarn replace-build-env esm",
+    "replace-build-env": "node ../../scripts/build/replace-build-env.js"
+  },
+  "dependencies": {
+    "@datadog/browser-core": "6.7.0"
+  },
+  "peerDependencies": {
+    "@datadog/browser-rum": "6.7.0"
+  },
+  "peerDependenciesMeta": {
+    "@datadog/browser-rum": {
+      "optional": true
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DataDog/browser-sdk.git",
+    "directory": "packages/flagging"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/packages/flagging/src/entries/main.ts b/packages/flagging/src/entries/main.ts
@@ -0,0 +1,9 @@
+import { defineGlobal, getGlobalObject } from '@datadog/browser-core'
+import { flagging as importedFlagging } from '../hello'
+
+export const datadogFlagging = importedFlagging
+
+interface BrowserWindow extends Window {
+  DD_FLAGGING?: typeof datadogFlagging
+}
+defineGlobal(getGlobalObject<BrowserWindow>(), 'DD_FLAGGING', datadogFlagging)
diff --git a/packages/flagging/src/hello.ts b/packages/flagging/src/hello.ts
@@ -0,0 +1,7 @@
+export const flagging = {
+  init: () => {
+    // TODO: Implement initialization logic
+    /* eslint-disable-next-line no-console */
+    console.log('Flagging initialized!')
+  },
+}
diff --git a/packages/flagging/tsconfig.cjs.json b/packages/flagging/tsconfig.cjs.json
@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "declaration": true,
+    "module": "commonjs",
+    "rootDir": "./src/",
+    "outDir": "./cjs/"
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["./src/**/*.spec.ts", "./src/**/*.specHelper.ts"]
+}
diff --git a/packages/flagging/tsconfig.esm.json b/packages/flagging/tsconfig.esm.json
@@ -0,0 +1,12 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "declaration": true,
+    "module": "es6",
+    "rootDir": "./src/",
+    "outDir": "./esm/"
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["./src/**/*.spec.ts", "./src/**/*.specHelper.ts"]
+}
diff --git a/packages/flagging/webpack.config.js b/packages/flagging/webpack.config.js
@@ -0,0 +1,10 @@
+const path = require('path')
+
+const webpackBase = require('../../webpack.base')
+
+module.exports = (_env, argv) =>
+  webpackBase({
+    mode: argv.mode,
+    entry: path.resolve(__dirname, 'src/entries/main.ts'),
+    filename: 'datadog-flagging.js',
+  })
diff --git a/sandbox/index.html b/sandbox/index.html
@@ -5,6 +5,7 @@
     <title>Sandbox</title>
     <script src="http://localhost:8080/datadog-rum.js"></script>
     <script src="http://localhost:8080/datadog-logs.js"></script>
+    <script src="http://localhost:8080/datadog-flagging.js"></script>
     <script>
       DD_RUM.init({
         clientToken: 'xxx',
@@ -24,7 +25,9 @@
         telemetryUsageSampleRate: 100,
         enableExperimentalFeatures: [],
       })
+      DD_FLAGGING.init()
     </script>
   </head>
+
   <body></body>
 </html>
diff --git a/sandbox/react-app/main.tsx b/sandbox/react-app/main.tsx
@@ -4,13 +4,16 @@ import ReactDOM from 'react-dom/client'
 import { datadogRum } from '@datadog/browser-rum'
 import { createBrowserRouter } from '@datadog/browser-rum-react/react-router-v7'
 import { reactPlugin, ErrorBoundary, UNSTABLE_ReactComponentTracker } from '@datadog/browser-rum-react'
+import { datadogFlagging } from '@datadog/browser-flagging'
 
 datadogRum.init({
   applicationId: 'xxx',
   clientToken: 'xxx',
   plugins: [reactPlugin({ router: true })],
 })
 
+datadogFlagging.init()
+
 const router = createBrowserRouter(
   [
     {
diff --git a/scripts/dev-server.js b/scripts/dev-server.js
@@ -8,6 +8,7 @@ const cors = require('cors')
 const logsConfig = require('../packages/logs/webpack.config')
 const rumSlimConfig = require('../packages/rum-slim/webpack.config')
 const rumConfig = require('../packages/rum/webpack.config')
+const flaggingConfig = require('../packages/flagging/webpack.config')
 const workerConfig = require('../packages/worker/webpack.config')
 const webpackBase = require('../webpack.base')
 const { printLog, runMain } = require('./lib/executionUtils')
@@ -26,7 +27,7 @@ function createStaticSandboxApp() {
   const app = express()
   app.use(cors())
   app.use(express.static(sandboxPath))
-  for (const config of [rumConfig, logsConfig, rumSlimConfig, workerConfig]) {
+  for (const config of [rumConfig, logsConfig, rumSlimConfig, workerConfig, flaggingConfig]) {
     app.use(middleware(webpack(config(null, { mode: 'development' }))))
   }
 
diff --git a/scripts/lib/computeBundleSize.js b/scripts/lib/computeBundleSize.js
@@ -3,7 +3,7 @@ const fs = require('fs')
 const zlib = require('zlib')
 const { glob } = require('glob')
 
-const packages = ['rum', 'logs', 'rum-slim', 'worker']
+const packages = ['rum', 'logs', 'flagging', 'rum-slim', 'worker']
 
 function getPackageName(file) {
   if (file.includes('chunk')) {
diff --git a/yarn.lock b/yarn.lock
@@ -224,6 +224,19 @@ __metadata:
   languageName: unknown
   linkType: soft
 
+"@datadog/browser-flagging@workspace:packages/flagging":
+  version: 0.0.0-use.local
+  resolution: "@datadog/browser-flagging@workspace:packages/flagging"
+  dependencies:
+    "@datadog/browser-core": "npm:6.7.0"
+  peerDependencies:
+    "@datadog/browser-rum": 6.7.0
+  peerDependenciesMeta:
+    "@datadog/browser-rum":
+      optional: true
+  languageName: unknown
+  linkType: soft
+
 "@datadog/browser-logs@workspace:*, @datadog/browser-logs@workspace:packages/logs":
   version: 0.0.0-use.local
   resolution: "@datadog/browser-logs@workspace:packages/logs"

Original file line number	Diff line number	Diff line change
`@@ -341,7 +341,7 @@ export default tseslint.config(`
`341`	`341`	`},`
`342`	`342`
`343`	`343`	`{`
`344`		`- files: ['packages/{rum,logs,rum-slim}/src/entries/*.ts'],`
	`344`	`+ files: ['packages/{rum,logs,flagging,rum-slim}/src/entries/*.ts'],`
`345`	`345`	`rules: {`
`346`	`346`	`'local-rules/disallow-enum-exports': 'error',`
`347`	`347`	`},`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Flagging SDK (Prerelease)`
	`2`	`+`
	`3`	`+This package supports flagging and experimentation by performing evaluation in the browser.`