feat(wallet/wallet-dashboard/explorer): Build env for growthbook, amplitude & sentry (#5216)

marc2332 · begonaalvarezd · web-flow · commit b5854b8d76f6 · 2025-02-05T18:50:28.000+01:00
* feat(wallet/wallet-dashboard/explorer): Staging env for growthbook

* fmt

* rename WALLET_RC to IS_RC

* add BUILD_ENV to turbo.json

* feat: enable account finder in production

* fix: Use `BUILD_ENV` instead of `NODE_ENV`

* fix(explorer): Use `BUILD_ENV` instead of `import.meta.env.PROD`

* fmt, ignore

* `VITE_BUILD_ENV`

* Use `NEXT_PUBLIC_BUILD_ENV` in dashboard amplitude and sentry

* update env example

* hook NEXT_PUBLIC_BUILD_ENV

* revert enabling account finder in prod features

* use staging build env in rc builds of the wallet

* chore: disable production feature flags

* fmt

---------

Co-authored-by: Begoña Alvarez &lt;balvarez@boxfish.studio&gt;
diff --git a/apps/apps-backend/src/features/features.controller.ts b/apps/apps-backend/src/features/features.controller.ts
@@ -7,8 +7,8 @@ import { Network } from '@iota/iota-sdk/client';
 
 @Controller('/api/features')
 export class FeaturesController {
-    @Get('/development')
-    getDevelopmentFeatures() {
+    @Get('/staging')
+    getStagingFeatures() {
         return {
             status: 200,
             features: {
@@ -153,10 +153,10 @@ export class FeaturesController {
                     defaultValue: false,
                 },
                 [Feature.StardustMigration]: {
-                    defaultValue: true,
+                    defaultValue: false,
                 },
                 [Feature.SupplyIncreaseVesting]: {
-                    defaultValue: true,
+                    defaultValue: false,
                 },
                 [Feature.BurntAndMintedTokensInEndedEpochs]: {
                     defaultValue: {
diff --git a/apps/explorer/.env.example b/apps/explorer/.env.example
@@ -1 +1,2 @@
 VITE_SENTRY_SAMPLE_RATE=xxxxxxx
+VITE_BUILD_ENV='development'
diff --git a/apps/explorer/src/lib/utils/analytics/amplitude.ts b/apps/explorer/src/lib/utils/analytics/amplitude.ts
@@ -8,7 +8,7 @@ import { PersistableStorage } from '@iota/core';
 
 import { ampli } from './ampli';
 
-const IS_PROD_ENV = import.meta.env.PROD;
+const IS_PROD_ENV = import.meta.env.VITE_BUILD_ENV === 'production';
 
 export const persistableStorage = new PersistableStorage<UserSession>();
 
diff --git a/apps/explorer/src/lib/utils/growthbook.ts b/apps/explorer/src/lib/utils/growthbook.ts
@@ -5,9 +5,26 @@
 import { GrowthBook } from '@growthbook/growthbook';
 import { getAppsBackend } from '@iota/iota-sdk/client';
 
+const GROWTHBOOK_ENVIRONMENTS = {
+    production: {
+        clientKey: 'production',
+        enableDevMode: false,
+    },
+    staging: {
+        clientKey: 'staging',
+        enableDevMode: false,
+    },
+    development: {
+        clientKey: 'staging',
+        enableDevMode: true,
+    },
+};
+
+const environment =
+    (import.meta.env.VITE_BUILD_ENV as keyof typeof GROWTHBOOK_ENVIRONMENTS) || 'development';
+
 export const growthbook = new GrowthBook({
     // If you want to develop locally, you can set the API host to this:
     apiHost: getAppsBackend(),
-    clientKey: import.meta.env.PROD ? 'production' : 'development',
-    enableDevMode: import.meta.env.DEV,
+    ...GROWTHBOOK_ENVIRONMENTS[environment],
 });
diff --git a/apps/explorer/src/lib/utils/sentry.ts b/apps/explorer/src/lib/utils/sentry.ts
@@ -11,15 +11,15 @@ import {
     useNavigationType,
 } from 'react-router-dom';
 
-const SENTRY_ENABLED = import.meta.env.PROD;
+const SENTRY_ENABLED = import.meta.env.VITE_BUILD_ENV === 'production';
 const SENTRY_SAMPLE_RATE = import.meta.env.VITE_SENTRY_SAMPLE_RATE
     ? parseFloat(import.meta.env.VITE_SENTRY_SAMPLE_RATE)
     : 0;
 
 export function initSentry() {
     Sentry.init({
         enabled: SENTRY_ENABLED,
-        dsn: import.meta.env.PROD
+        dsn: SENTRY_ENABLED
             ? 'https://ce107602e4d122f0639332c7c43fdc08@o4508279186718720.ingest.de.sentry.io/4508279962140752'
             : 'https://c8085701fa2650fb2a090ed6aba6bc62@o4508279186718720.ingest.de.sentry.io/4508279963320400',
         environment: import.meta.env.VITE_VERCEL_ENV,
diff --git a/apps/explorer/vite.config.ts b/apps/explorer/vite.config.ts
@@ -10,6 +10,7 @@ import svgr from 'vite-plugin-svgr';
 import { configDefaults } from 'vitest/config';
 
 process.env.VITE_VERCEL_ENV = process.env.VERCEL_ENV || 'development';
+process.env.VITE_BUILD_ENV = process.env.BUILD_ENV || 'development';
 const EXPLORER_REV = execSync('git rev-parse HEAD').toString().trim().toString();
 
 // https://vitejs.dev/config/
diff --git a/apps/wallet-dashboard/.env.defaults b/apps/wallet-dashboard/.env.defaults
@@ -1 +1,2 @@
 NEXT_PUBLIC_APPS_BACKEND_URL=
+NEXT_PUBLIC_BUILD_ENV='development'
diff --git a/apps/wallet-dashboard/lib/utils/analytics/amplitude.ts b/apps/wallet-dashboard/lib/utils/analytics/amplitude.ts
@@ -8,7 +8,7 @@ import { PersistableStorage } from '@iota/core';
 
 import { ampli } from './ampli';
 
-const IS_PROD_ENV = process.env.NODE_ENV == 'production';
+const IS_PROD_ENV = process.env.NEXT_PUBLIC_BUILD_ENV == 'production';
 
 export const persistableStorage = new PersistableStorage<UserSession>();
 
diff --git a/apps/wallet-dashboard/lib/utils/growthbook.ts b/apps/wallet-dashboard/lib/utils/growthbook.ts
@@ -4,8 +4,25 @@
 import { GrowthBook } from '@growthbook/growthbook';
 import { getAppsBackend } from '@iota/iota-sdk/client';
 
+const GROWTHBOOK_ENVIRONMENTS = {
+    production: {
+        clientKey: 'production',
+        enableDevMode: false,
+    },
+    staging: {
+        clientKey: 'staging',
+        enableDevMode: false,
+    },
+    development: {
+        clientKey: 'staging',
+        enableDevMode: true,
+    },
+};
+
+const environment =
+    (process.env.NEXT_PUBLIC_BUILD_ENV as keyof typeof GROWTHBOOK_ENVIRONMENTS) || 'development';
+
 export const growthbook = new GrowthBook({
     apiHost: getAppsBackend(),
-    clientKey: process.env.NODE_ENV === 'production' ? 'production' : 'development',
-    enableDevMode: process.env.NODE_ENV === 'development',
+    ...GROWTHBOOK_ENVIRONMENTS[environment],
 });
diff --git a/apps/wallet-dashboard/next.config.mjs b/apps/wallet-dashboard/next.config.mjs
@@ -5,6 +5,7 @@ import { SENTRY_ORG_NAME, SENTRY_PROJECT_NAME } from './sentry.common.config.mjs
 import { withSentryConfig } from '@sentry/nextjs';
 import { execSync } from 'child_process';
 const NEXT_PUBLIC_DASHBOARD_REV = execSync('git rev-parse HEAD').toString().trim().toString();
+const NEXT_PUBLIC_BUILD_ENV = process.env.BUILD_ENV;
 
 /** @type {import('next').NextConfig} */
 const nextConfig = {
@@ -23,6 +24,7 @@ const nextConfig = {
     },
     env: {
         NEXT_PUBLIC_DASHBOARD_REV,
+        NEXT_PUBLIC_BUILD_ENV,
     },
 };
 
diff --git a/apps/wallet-dashboard/sentry.common.config.mjs b/apps/wallet-dashboard/sentry.common.config.mjs
@@ -1,7 +1,7 @@
 // Copyright (c) 2024 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-export const IS_PROD = process.env.NODE_ENV === 'production';
+export const IS_PROD = process.env.NEXT_PUBLIC_BUILD_ENV === 'production';
 
 export const SENTRY_DSN = IS_PROD
     ? 'https://cb83626ca07d6cf66ca2f901cf53c051@o4508279186718720.ingest.de.sentry.io/4508647247249488'
diff --git a/apps/wallet/configs/webpack/webpack.config.common.ts b/apps/wallet/configs/webpack/webpack.config.common.ts
@@ -16,20 +16,21 @@ import type { Configuration } from 'webpack';
 
 import packageJson from '../../package.json';
 
-const WALLET_RC = process.env.WALLET_RC === 'true';
-const RC_VERSION = WALLET_RC ? Number(process.env.RC_VERSION) || 0 : undefined;
-
 const SDK_ROOT = resolve(__dirname, '..', '..', '..', '..', 'sdk');
 const PROJECT_ROOT = resolve(__dirname, '..', '..');
 const CONFIGS_ROOT = resolve(PROJECT_ROOT, 'configs');
 const SRC_ROOT = resolve(PROJECT_ROOT, 'src');
 const OUTPUT_ROOT = resolve(PROJECT_ROOT, 'dist');
 const TS_CONFIGS_ROOT = resolve(CONFIGS_ROOT, 'ts');
-const IS_NIGHTLY = process.env.NODE_ENV === 'nightly';
-const IS_DEV = process.env.NODE_ENV === 'development';
-const IS_PROD = process.env.NODE_ENV === 'production';
+const BUILD_ENV = process.env.BUILD_ENV as 'production' | 'development' | 'nightly' | 'rc';
+const IS_NIGHTLY = BUILD_ENV === 'nightly';
+const IS_DEV = BUILD_ENV === 'development';
+const IS_PROD = BUILD_ENV === 'production';
+const IS_RC = BUILD_ENV === 'rc';
+const RC_VERSION = IS_RC ? Number(process.env.RC_VERSION) || 0 : undefined;
+
 const TS_CONFIG_FILE = resolve(TS_CONFIGS_ROOT, `tsconfig.${IS_DEV ? 'dev' : 'prod'}.json`);
-const APP_NAME = WALLET_RC
+const APP_NAME = IS_RC
     ? 'IOTA Wallet (RC)'
     : IS_DEV
       ? 'IOTA Wallet (DEV)'
@@ -209,10 +210,10 @@ const commonConfig: () => Promise<Configuration> = async () => {
                                       }
                                     : undefined),
                                 icons: {
-                                    16: `manifest/icons/iota-icon-16${WALLET_RC ? '-rc' : ''}.png`,
-                                    32: `manifest/icons/iota-icon-32${WALLET_RC ? '-rc' : ''}.png`,
-                                    48: `manifest/icons/iota-icon-48${WALLET_RC ? '-rc' : ''}.png`,
-                                    128: `manifest/icons/iota-icon-128${WALLET_RC ? '-rc' : ''}.png`,
+                                    16: `manifest/icons/iota-icon-16${IS_RC ? '-rc' : ''}.png`,
+                                    32: `manifest/icons/iota-icon-32${IS_RC ? '-rc' : ''}.png`,
+                                    48: `manifest/icons/iota-icon-48${IS_RC ? '-rc' : ''}.png`,
+                                    128: `manifest/icons/iota-icon-128${IS_RC ? '-rc' : ''}.png`,
                                 },
                             };
                             return JSON.stringify(manifestJson, null, 4);
@@ -229,12 +230,13 @@ const commonConfig: () => Promise<Configuration> = async () => {
                 'process.env.WALLET_KEYRING_PASSWORD': JSON.stringify(
                     IS_DEV ? 'DEV_PASS' : Buffer.from(randomBytes(64)).toString('hex'),
                 ),
-                'process.env.WALLET_RC': WALLET_RC,
+                'process.env.IS_RC': IS_RC,
                 'process.env.APP_NAME': JSON.stringify(APP_NAME),
                 'process.env.DEFAULT_NETWORK': JSON.stringify(process.env.DEFAULT_NETWORK),
                 'process.env.IOTA_NETWORKS': JSON.stringify(process.env.IOTA_NETWORKS),
                 'process.env.APPS_BACKEND': JSON.stringify(process.env.APPS_BACKEND),
                 'process.env.SENTRY_AUTH_TOKEN': JSON.stringify(process.env.SENTRY_AUTH_TOKEN),
+                'process.env.BUILD_ENV': JSON.stringify(BUILD_ENV),
             }),
             new ProvidePlugin({
                 Buffer: ['buffer', 'Buffer'],
diff --git a/apps/wallet/package.json b/apps/wallet/package.json
@@ -6,10 +6,10 @@
     "main": "./dist/ui.js",
     "scripts": {
         "build": "pnpm build:prod",
-        "build:prod": "cross-env NODE_ENV=\"production\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
-        "build:dev": "cross-env NODE_ENV=\"development\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
-        "build:rc": "cross-env WALLET_RC=true NODE_ENV=\"production\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
-        "build:nightly": "cross-env NODE_ENV=\"nightly\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
+        "build:prod": "cross-env BUILD_ENV=\"production\" NODE_ENV=\"production\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
+        "build:dev": "cross-env BUILD_ENV=\"development\" NODE_ENV=\"development\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
+        "build:rc": "cross-env BUILD_ENV=\"rc\" NODE_ENV=\"production\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
+        "build:nightly": "cross-env BUILD_ENV=\"nightly\" NODE_ENV=\"production\" TS_NODE_PROJECT=\"./configs/ts/tsconfig.webpack.json\" webpack --progress",
         "prettier:check": "prettier -c --ignore-unknown --ignore-path=../../.prettierignore --ignore-path=.prettierignore .",
         "prettier:fix": "prettier -w --ignore-unknown --ignore-path=../../.prettierignore --ignore-path=.prettierignore .",
         "prettier:fix:watch": "onchange '**' -i -f add -f change -j 5 -- prettier -w --ignore-unknown --ignore-path=../../.prettierignore --ignore-path=.prettierignore {{file}}",
diff --git a/apps/wallet/src/shared/analytics/amplitude.ts b/apps/wallet/src/shared/analytics/amplitude.ts
@@ -8,7 +8,7 @@ import { PersistableStorage } from '@iota/core';
 
 import { ampli } from './ampli';
 
-const IS_PROD_ENV = process.env.NODE_ENV === 'production';
+const IS_PROD_ENV = process.env.BUILD_ENV === 'production';
 
 export const persistableStorage = new PersistableStorage<UserSession>();
 
diff --git a/apps/wallet/src/shared/experimentation/features.ts b/apps/wallet/src/shared/experimentation/features.ts
@@ -6,31 +6,31 @@ import { GrowthBook } from '@growthbook/growthbook';
 import { Network, getAppsBackend } from '@iota/iota-sdk/client';
 import Browser from 'webextension-polyfill';
 
-function getGrowthbookConfig(env: string) {
-    if (env === 'development') {
-        return {
-            clientKey: 'development',
-            enableDevMode: true,
-        };
-    }
-    if (env === 'production') {
-        return {
-            clientKey: 'production',
-            enableDevMode: false,
-        };
-    }
-
-    // return for local by default
-    return {
-        clientKey: 'development',
+const GROWTHBOOK_ENVIRONMENTS = {
+    production: {
+        clientKey: 'production',
+        enableDevMode: false,
+    },
+    rc: {
+        clientKey: 'staging',
+        enableDevMode: false,
+    },
+    nightly: {
+        clientKey: 'staging',
+        enableDevMode: false,
+    },
+    development: {
+        clientKey: 'staging',
         enableDevMode: true,
-    };
-}
+    },
+};
+
+const environment =
+    (process.env.BUILD_ENV as keyof typeof GROWTHBOOK_ENVIRONMENTS) || 'development';
 
 export const growthbook = new GrowthBook({
     apiHost: getAppsBackend(),
-    clientKey: getGrowthbookConfig(process.env.NODE_ENV as string).clientKey,
-    enableDevMode: getGrowthbookConfig(process.env.NODE_ENV as string).enableDevMode,
+    ...GROWTHBOOK_ENVIRONMENTS[environment],
 });
 
 export function setAttributes(network?: { network: Network; customRpc?: string | null }) {
@@ -43,7 +43,7 @@ export function setAttributes(network?: { network: Network; customRpc?: string |
     growthbook.setAttributes({
         network: activeNetwork,
         version: Browser.runtime.getManifest().version,
-        rc: process.env.WALLET_RC || false,
+        rc: process.env.IS_RC || false,
     });
 }
 
diff --git a/apps/wallet/src/shared/sentryConfig.ts b/apps/wallet/src/shared/sentryConfig.ts
@@ -6,7 +6,7 @@ import { type BrowserOptions } from '@sentry/browser';
 import Browser from 'webextension-polyfill';
 
 const WALLET_VERSION = Browser.runtime.getManifest().version;
-const IS_PROD = process.env.NODE_ENV === 'production';
+const IS_PROD = process.env.BUILD_ENV === 'production';
 
 // Sentry dev hint: If you want to enable sentry in dev, you can tweak this value:
 const ENABLE_SENTRY = IS_PROD;
diff --git a/turbo.json b/turbo.json
@@ -64,7 +64,8 @@
 		"IOTA_NETWORKS",
 		"RC_VERSION",
 		"APPS_BACKEND",
-		"SENTRY_AUTH_TOKEN"
+		"SENTRY_AUTH_TOKEN",
+		"BUILD_ENV"
 	],
 	"globalDependencies": [
 		".eslintrc.js",

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`VITE_SENTRY_SAMPLE_RATE=xxxxxxx`
	`2`	`+VITE_BUILD_ENV='development'`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`NEXT_PUBLIC_APPS_BACKEND_URL=`
	`2`	`+NEXT_PUBLIC_BUILD_ENV='development'`