aboutsummaryrefslogtreecommitdiffstats
path: root/packages/instant
diff options
context:
space:
mode:
authorSteve Klebanoff <steve@0xproject.com>2018-12-04 08:52:06 +0800
committerGitHub <noreply@github.com>2018-12-04 08:52:06 +0800
commit703cea6173f72ceb6969bc17bda0735b86477522 (patch)
treef73fb94c3de9e2718bcec5f5d0e0c736c1d11b28 /packages/instant
parent2601d16efbb1e85eadca459e5dc64e78099e738a (diff)
parent1107b84949ea74467393edc1496c153f5ce7f64d (diff)
downloaddexon-sol-tools-703cea6173f72ceb6969bc17bda0735b86477522.tar
dexon-sol-tools-703cea6173f72ceb6969bc17bda0735b86477522.tar.gz
dexon-sol-tools-703cea6173f72ceb6969bc17bda0735b86477522.tar.bz2
dexon-sol-tools-703cea6173f72ceb6969bc17bda0735b86477522.tar.lz
dexon-sol-tools-703cea6173f72ceb6969bc17bda0735b86477522.tar.xz
dexon-sol-tools-703cea6173f72ceb6969bc17bda0735b86477522.tar.zst
dexon-sol-tools-703cea6173f72ceb6969bc17bda0735b86477522.zip
Merge pull request #1370 from 0xProject/feature/instant/explicitly-enable-heap-dev
[instant] Must explicitly specify when want to send to heap when developing
Diffstat (limited to 'packages/instant')
-rw-r--r--packages/instant/.env_example5
-rw-r--r--packages/instant/src/constants.ts1
-rw-r--r--packages/instant/src/util/analytics.ts12
-rw-r--r--packages/instant/webpack.config.js2
4 files changed, 14 insertions, 6 deletions
diff --git a/packages/instant/.env_example b/packages/instant/.env_example
index ebbbebc06..234e64bbe 100644
--- a/packages/instant/.env_example
+++ b/packages/instant/.env_example
@@ -1,4 +1,7 @@
INSTANT_ROLLBAR_PUBLISH_TOKEN=
INSTANT_ROLLBAR_CLIENT_TOKEN=
INSTANT_HEAP_ANALYTICS_ID_PRODUCTION=
-INSTANT_HEAP_ANALYTICS_ID_DEVELOPMENT= \ No newline at end of file
+INSTANT_HEAP_ANALYTICS_ID_DEVELOPMENT=
+# if you want to report to heap or rollbar when building in development mode, you can use the following:
+# INSTANT_HEAP_FORCE_DEVELOPMENT=true
+# INSTANT_ROLLBAR_FORCE_DEVELOPMENT=true \ No newline at end of file
diff --git a/packages/instant/src/constants.ts b/packages/instant/src/constants.ts
index 1194cf881..2439c7349 100644
--- a/packages/instant/src/constants.ts
+++ b/packages/instant/src/constants.ts
@@ -19,6 +19,7 @@ export const DEFAULT_GAS_PRICE = GWEI_IN_WEI.mul(6);
export const DEFAULT_ESTIMATED_TRANSACTION_TIME_MS = ONE_MINUTE_MS * 2;
export const ETH_GAS_STATION_API_BASE_URL = 'https://ethgasstation.info';
export const HEAP_ANALYTICS_ID = process.env.HEAP_ANALYTICS_ID;
+export const HEAP_ENABLED = process.env.HEAP_ENABLED;
export const COINBASE_API_BASE_URL = 'https://api.coinbase.com/v2';
export const PROGRESS_STALL_AT_WIDTH = '95%';
export const PROGRESS_FINISH_ANIMATION_TIME_MS = 200;
diff --git a/packages/instant/src/util/analytics.ts b/packages/instant/src/util/analytics.ts
index e625824ef..760ec8b5c 100644
--- a/packages/instant/src/util/analytics.ts
+++ b/packages/instant/src/util/analytics.ts
@@ -2,7 +2,7 @@ import { BuyQuote } from '@0x/asset-buyer';
import { BigNumber } from '@0x/utils';
import * as _ from 'lodash';
-import { INSTANT_DISCHARGE_TARGET } from '../constants';
+import { HEAP_ENABLED, INSTANT_DISCHARGE_TARGET } from '../constants';
import {
AffiliateInfo,
Asset,
@@ -16,15 +16,17 @@ import {
import { EventProperties, heapUtil } from './heap';
-let isDisabled = false;
+let isDisabledViaConfig = false;
export const disableAnalytics = (shouldDisableAnalytics: boolean) => {
- isDisabled = shouldDisableAnalytics;
+ isDisabledViaConfig = shouldDisableAnalytics;
};
export const evaluateIfEnabled = (fnCall: () => void) => {
- if (isDisabled) {
+ if (isDisabledViaConfig) {
return;
}
- fnCall();
+ if (HEAP_ENABLED) {
+ fnCall();
+ }
};
enum EventNames {
diff --git a/packages/instant/webpack.config.js b/packages/instant/webpack.config.js
index a1db01db9..e74cf36d9 100644
--- a/packages/instant/webpack.config.js
+++ b/packages/instant/webpack.config.js
@@ -71,6 +71,7 @@ const generateConfig = (dischargeTarget, heapConfigOptions, rollbarConfigOptions
`Must define heap analytics id in ENV var ${heapAnalyticsIdEnvName} when building for ${dischargeTarget}`,
);
}
+ const heapEnabled = heapAnalyticsId && (nodeEnv !== 'development' || process.env.INSTANT_HEAP_FORCE_DEVELOPMENT);
const rollbarTokens = getRollbarTokens(dischargeTarget, rollbarConfigOptions.rollbarRequired);
const rollbarEnabled =
@@ -92,6 +93,7 @@ const generateConfig = (dischargeTarget, heapConfigOptions, rollbarConfigOptions
GIT_SHA: JSON.stringify(GIT_SHA),
NPM_PACKAGE_VERSION: JSON.stringify(process.env.npm_package_version),
ROLLBAR_ENABLED: rollbarEnabled,
+ HEAP_ENABLED: heapEnabled
};
if (dischargeTarget) {
envVars.INSTANT_DISCHARGE_TARGET = JSON.stringify(dischargeTarget);