♻️[RUMF-471] rename version

.gitlab-ci.yml

@@ -152,9 +152,9 @@ deploy-staging:
   image: $CI_IMAGE
   script:
     - yarn
-    - TARGET_DATACENTER=eu TARGET_ENV=staging VERSION=staging yarn build:bundle
+    - TARGET_DATACENTER=eu TARGET_ENV=staging BUILD_MODE=staging yarn build:bundle
     - ./scripts/deploy.sh staging eu
-    - TARGET_DATACENTER=us TARGET_ENV=staging VERSION=staging yarn build:bundle
+    - TARGET_DATACENTER=us TARGET_ENV=staging BUILD_MODE=staging yarn build:bundle
     - ./scripts/deploy.sh staging us
 
 deploy-release:
@@ -168,9 +168,9 @@ deploy-release:
   image: $CI_IMAGE
   script:
     - yarn
-    - TARGET_DATACENTER=us TARGET_ENV=production VERSION=release yarn build:bundle
+    - TARGET_DATACENTER=us TARGET_ENV=production BUILD_MODE=release yarn build:bundle
     - ./scripts/deploy.sh prod us
-    - TARGET_DATACENTER=eu TARGET_ENV=production VERSION=release yarn build:bundle
+    - TARGET_DATACENTER=eu TARGET_ENV=production BUILD_MODE=release yarn build:bundle
     - ./scripts/deploy.sh prod eu
 
 ########################################################################################################################

package.json

@@ -14,16 +14,16 @@
     "dev": "ENV=development node test/server/server.js",
     "release": "lerna version --exact",
     "version": "node ./scripts/generate-changelog.js",
-    "publish:npm": "TARGET_DATACENTER=us TARGET_ENV=production VERSION=release yarn build && lerna publish from-package",
+    "publish:npm": "TARGET_DATACENTER=us TARGET_ENV=production BUILD_MODE=release yarn build && lerna publish from-package",
     "fail": "./scripts/fail.sh",
     "test": "yarn test:unit",
     "test:unit": "karma start ./test/unit/karma.local.conf.js",
     "test:unit:bs": "node ./scripts/bs-wrapper.js karma start test/unit/karma.bs.conf.js",
     "test:e2e": "yarn run test:e2e:bundle",
-    "test:e2e:bundle": "TARGET_ENV=e2e-test yarn build && E2E_MODE=bundle wdio test/e2e/wdio.local.conf.js",
-    "test:e2e:npm": "TARGET_ENV=e2e-test yarn build && (cd test/app && rm -rf node_modules && yarn && yarn build) && E2E_MODE=npm wdio test/e2e/wdio.local.conf.js",
-    "test:e2e:async": "TARGET_ENV=e2e-test yarn build && E2E_MODE=async wdio test/e2e/wdio.local.conf.js",
-    "test:e2e:bs": "TARGET_ENV=e2e-test yarn build && node ./scripts/bs-wrapper.js wdio test/e2e/wdio.bs.conf.js",
+    "test:e2e:bundle": "BUILD_MODE=e2e-test yarn build && E2E_MODE=bundle wdio test/e2e/wdio.local.conf.js",
+    "test:e2e:npm": "BUILD_MODE=e2e-test yarn build && (cd test/app && rm -rf node_modules && yarn && yarn build) && E2E_MODE=npm wdio test/e2e/wdio.local.conf.js",
+    "test:e2e:async": "BUILD_MODE=e2e-test yarn build && E2E_MODE=async wdio test/e2e/wdio.local.conf.js",
+    "test:e2e:bs": "BUILD_MODE=e2e-test yarn build && node ./scripts/bs-wrapper.js wdio test/e2e/wdio.bs.conf.js",
     "test:compat:tsc": "yarn build && (cd test/app && rm -rf node_modules && yarn && yarn compat:tsc) || yarn fail 'typescript 3.0 compatibility broken'",
     "test:compat:ssr": "yarn build && (cd test/app && rm -rf node_modules && yarn && yarn compat:ssr) || yarn fail 'server side rendering compatibility broken'"
   },

packages/core/src/configuration.ts

@@ -1,4 +1,4 @@
-import { BuildEnv, Datacenter, Environment } from './init'
+import { BuildEnv, BuildMode, Datacenter, Environment } from './init'
 import { includes, ONE_KILO_BYTE, ONE_SECOND } from './utils'
 
 export const DEFAULT_CONFIGURATION = {
@@ -45,7 +45,7 @@ export interface UserConfiguration {
   silentMultipleInit?: boolean
   proxyHost?: string
 
-  // Below is only taken into account for e2e-test bundle.
+  // Below is only taken into account for e2e-test build mode.
   internalMonitoringEndpoint?: string
   logsEndpoint?: string
   rumEndpoint?: string
@@ -64,17 +64,19 @@ interface TransportConfiguration {
   clientToken: string
   datacenter: Datacenter
   env: Environment
-  version: string
+  buildMode: BuildMode
+  sdkVersion: string
   proxyHost?: string
 }
 
 export function buildConfiguration(userConfiguration: UserConfiguration, buildEnv: BuildEnv): Configuration {
   const transportConfiguration: TransportConfiguration = {
+    buildMode: buildEnv.buildMode,
     clientToken: userConfiguration.clientToken,
     datacenter: userConfiguration.datacenter || buildEnv.datacenter,
     env: buildEnv.env,
     proxyHost: userConfiguration.proxyHost,
-    version: buildEnv.version,
+    sdkVersion: buildEnv.sdkVersion,
   }
 
   const enableExperimentalFeatures = Array.isArray(userConfiguration.enableExperimentalFeatures)
@@ -110,7 +112,7 @@ export function buildConfiguration(userConfiguration: UserConfiguration, buildEn
     configuration.resourceSampleRate = userConfiguration.resourceSampleRate!
   }
 
-  if (transportConfiguration.env === 'e2e-test') {
+  if (transportConfiguration.buildMode === 'e2e-test') {
     if (userConfiguration.internalMonitoringEndpoint !== undefined) {
       configuration.internalMonitoringEndpoint = userConfiguration.internalMonitoringEndpoint
     }
@@ -128,7 +130,7 @@ export function buildConfiguration(userConfiguration: UserConfiguration, buildEn
 function getEndpoint(type: string, conf: TransportConfiguration, source?: string) {
   const tld = conf.datacenter === 'us' ? 'com' : 'eu'
   const domain = conf.env === 'production' ? `datadoghq.${tld}` : `datad0g.${tld}`
-  const tags = `version:${conf.version}`
+  const tags = `sdk_version:${conf.sdkVersion}`
   const datadogHost = `${type}-http-intake.logs.${domain}`
   const host = conf.proxyHost ? conf.proxyHost : datadogHost
   const proxyParameter = conf.proxyHost ? `ddhost=${datadogHost}&` : ''

packages/core/src/init.ts

@@ -23,12 +23,14 @@ export function makeGlobal<T>(stub: T): T {
 }
 
 export type Datacenter = 'eu' | 'us'
-export type Environment = 'production' | 'staging' | 'e2e-test'
+export type Environment = 'production' | 'staging'
+export type BuildMode = 'release' | 'staging' | 'e2e-test'
 
 export interface BuildEnv {
   datacenter: Datacenter
   env: Environment
-  version: string
+  buildMode: BuildMode
+  sdkVersion: string
 }
 
 export function commonInit(userConfiguration: UserConfiguration, buildEnv: BuildEnv) {

packages/core/test/configuration.spec.ts

@@ -3,9 +3,10 @@ import { buildConfiguration } from '../src/configuration'
 describe('configuration', () => {
   const clientToken = 'some_client_token'
   const prodEnv = {
+    buildMode: 'release' as 'release',
     datacenter: 'us' as 'us',
     env: 'production' as 'production',
-    version: 'some_version',
+    sdkVersion: 'some_version',
   }
 
   describe('internal monitoring endpoint', () => {
@@ -30,12 +31,13 @@ describe('configuration', () => {
       expect(configuration.internalMonitoringEndpoint).not.toEqual(endpoint)
     })
 
-    it('should be available for e2e-test env', () => {
+    it('should be available for e2e-test build mode', () => {
       const endpoint = 'bbbbbbbbbbbbbbb'
       const e2eEnv = {
+        buildMode: 'e2e-test' as 'e2e-test',
         datacenter: 'us' as 'us',
-        env: 'e2e-test' as 'e2e-test',
-        version: 'some_version',
+        env: 'staging' as 'staging',
+        sdkVersion: 'some_version',
       }
       const configuration = buildConfiguration(
         { clientToken, rumEndpoint: endpoint, logsEndpoint: endpoint, internalMonitoringEndpoint: endpoint },

packages/logs/src/buildEnv.ts

@@ -1,7 +1,8 @@
 import { BuildEnv, Datacenter, Environment } from '@datadog/browser-core'
 
 export const buildEnv: BuildEnv = {
+  buildMode: '<<< BUILD_MODE >>>' as BuildEnv['buildMode'],
   datacenter: '<<< TARGET_DATACENTER >>>' as Datacenter,
   env: '<<< TARGET_ENV >>>' as Environment,
-  version: '<<< VERSION >>>',
+  sdkVersion: '<<< SDK_VERSION >>>',
 }

packages/rum/src/buildEnv.ts

@@ -1,7 +1,8 @@
 import { BuildEnv } from '@datadog/browser-core'
 
 export const buildEnv: BuildEnv = {
+  buildMode: '<<< BUILD_MODE >>>' as BuildEnv['buildMode'],
   datacenter: '<<< TARGET_DATACENTER >>>' as BuildEnv['datacenter'],
   env: '<<< TARGET_ENV >>>' as BuildEnv['env'],
-  version: '<<< VERSION >>>',
+  sdkVersion: '<<< SDK_VERSION >>>',
 }

scripts/build-env.js

@@ -1,24 +1,25 @@
 const execSync = require('child_process').execSync
 const lernaJson = require('../lerna.json')
 
-let version
-switch (process.env.VERSION) {
+let sdkVersion
+switch (process.env.BUILD_MODE) {
   case 'release':
-    version = lernaJson.version
+    sdkVersion = lernaJson.version
     break
   case 'staging':
     const commitSha1 = execSync('git rev-parse HEAD')
       .toString()
       .trim()
-    version = `${lernaJson.version}+${commitSha1}`
+    sdkVersion = `${lernaJson.version}+${commitSha1}`
     break
   default:
-    version = 'dev'
+    sdkVersion = 'dev'
     break
 }
 
 module.exports = {
   TARGET_DATACENTER: process.env.TARGET_DATACENTER || 'us',
   TARGET_ENV: process.env.TARGET_ENV || 'staging',
-  VERSION: version,
+  BUILD_MODE: process.env.BUILD_MODE,
+  SDK_VERSION: sdkVersion,
 }

scripts/replace-build-env.js

@@ -4,7 +4,7 @@ const buildEnv = require('./build-env')
 /**
  * Replace BuildEnv in build files
  * Usage:
- * TARGET_DATACENTER=xxx TARGET_ENV=yyy VERSION=zzz node replace-build-env.js /path/to/build/directory
+ * TARGET_DATACENTER=xxx TARGET_ENV=yyy BUILD_MODE=zzz node replace-build-env.js /path/to/build/directory
  */
 
 const buildDirectory = process.argv[2]