Merge pull request #1359 from 0xProject/feature/instant/prod-env-switches-cdn

[instant] CDN-approach to identifying environments

10 files changed, 52 insertions, 40 deletions

diff --git a/packages/instant/.dogfood.discharge.json b/packages/instant/.dogfood.discharge.json
index 85a48044b..b0e4edaff 100644
--- a/packages/instant/.dogfood.discharge.json
+++ b/packages/instant/.dogfood.discharge.json
@@ -1,12 +1,12 @@
 {
     "domain": "0x-instant-dogfood",
-    "build_command": "WEBPACK_OUTPUT_PATH=public yarn build",
+    "build_command": "WEBPACK_OUTPUT_PATH=public yarn build --env.discharge_target=dogfood",
     "upload_directory": "public",
     "index_key": "index.html",
     "error_key": "index.html",
     "trailing_slashes": true,
     "cache": 3600,
-    "aws_profile": "default",
+    "aws_profile": "0xproject",
     "aws_region": "us-east-1",
     "cdn": false,
     "dns_configured": true
diff --git a/packages/instant/.production.discharge.json b/packages/instant/.production.discharge.json
index 447fa1756..4aa5337ba 100644
--- a/packages/instant/.production.discharge.json
+++ b/packages/instant/.production.discharge.json
@@ -1,12 +1,12 @@
 {
     "domain": "instant.0xproject.com",
-    "build_command": "yarn build",
+    "build_command": "yarn build --env.discharge_target=production",
     "upload_directory": "umd",
     "index_key": "instant.js",
     "error_key": "404.html",
     "trailing_slashes": true,
     "cache": 3600,
-    "aws_profile": "default",
+    "aws_profile": "0xproject",
     "aws_region": "us-east-1",
     "cdn": true,
     "dns_configured": true
diff --git a/packages/instant/.staging.discharge.json b/packages/instant/.staging.discharge.json
index 93fd94f40..56ffee4e9 100644
--- a/packages/instant/.staging.discharge.json
+++ b/packages/instant/.staging.discharge.json
@@ -1,12 +1,12 @@
 {
     "domain": "0x-instant-staging",
-    "build_command": "WEBPACK_OUTPUT_PATH=public yarn build",
+    "build_command": "WEBPACK_OUTPUT_PATH=public yarn build --env.discharge_target=staging",
     "upload_directory": "public",
     "index_key": "index.html",
     "error_key": "index.html",
     "trailing_slashes": true,
     "cache": 3600,
-    "aws_profile": "default",
+    "aws_profile": "0xproject",
     "aws_region": "us-east-1",
     "cdn": false,
     "dns_configured": true
diff --git a/packages/instant/package.json b/packages/instant/package.json
index 4f6e6d5a4..62904949b 100644
--- a/packages/instant/package.json
+++ b/packages/instant/package.json
@@ -25,10 +25,7 @@
     },
     "config": {
         "postpublish": {
-            "assets": [
-                "packages/instant/umd/instant.js",
-                "packages/instant/umd/instant.js.map"
-            ]
+            "assets": ["packages/instant/umd/instant.js", "packages/instant/umd/instant.js.map"]
         }
     },
     "repository": {
diff --git a/packages/instant/src/components/standard_sliding_panel.tsx b/packages/instant/src/components/standard_sliding_panel.tsx
index f587ff79a..9f517d273 100644
--- a/packages/instant/src/components/standard_sliding_panel.tsx
+++ b/packages/instant/src/components/standard_sliding_panel.tsx
@@ -1,6 +1,6 @@
 import * as React from 'react';
 
-import { SlideAnimationState, StandardSlidingPanelContent, StandardSlidingPanelSettings } from '../types';
+import { StandardSlidingPanelContent, StandardSlidingPanelSettings } from '../types';
 
 import { InstallWalletPanelContent } from './install_wallet_panel_content';
 import { SlidingPanel } from './sliding_panel';
diff --git a/packages/instant/src/constants.ts b/packages/instant/src/constants.ts
index 163be40b3..0dd770ec6 100644
--- a/packages/instant/src/constants.ts
+++ b/packages/instant/src/constants.ts
@@ -22,6 +22,11 @@ export const HEAP_ANALYTICS_ID = process.env.HEAP_ANALYTICS_ID;
 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;
+export const INSTANT_DISCHARGE_TARGET = process.env.INSTANT_DISCHARGE_TARGET as
+    | 'production'
+    | 'dogfood'
+    | 'staging'
+    | undefined;
 export const COINBASE_WALLET_IOS_APP_STORE_URL = 'https://itunes.apple.com/us/app/coinbase-wallet/id1278383455?mt=8';
 export const COINBASE_WALLET_ANDROID_APP_STORE_URL = 'https://play.google.com/store/apps/details?id=org.toshi&hl=en';
 export const COINBASE_WALLET_SITE_URL = 'https://wallet.coinbase.com/';
diff --git a/packages/instant/src/redux/analytics_middleware.ts b/packages/instant/src/redux/analytics_middleware.ts
index 3dc5fe924..47876ca2d 100644
--- a/packages/instant/src/redux/analytics_middleware.ts
+++ b/packages/instant/src/redux/analytics_middleware.ts
@@ -3,7 +3,7 @@ import * as _ from 'lodash';
 import { Middleware } from 'redux';
 
 import { ETH_DECIMALS } from '../constants';
-import { Account, AccountState, StandardSlidingPanelContent } from '../types';
+import { AccountState, StandardSlidingPanelContent } from '../types';
 import { analytics } from '../util/analytics';
 
 import { Action, ActionTypes } from './actions';
diff --git a/packages/instant/src/util/analytics.ts b/packages/instant/src/util/analytics.ts
index 714ff8bcd..e625824ef 100644
--- a/packages/instant/src/util/analytics.ts
+++ b/packages/instant/src/util/analytics.ts
@@ -2,6 +2,7 @@ import { BuyQuote } from '@0x/asset-buyer';
 import { BigNumber } from '@0x/utils';
 import * as _ from 'lodash';
 
+import { INSTANT_DISCHARGE_TARGET } from '../constants';
 import {
     AffiliateInfo,
     Asset,
@@ -103,6 +104,7 @@ export interface AnalyticsEventOptions {
     providerName?: string;
     gitSha?: string;
     npmVersion?: string;
+    instantEnvironment?: string;
     orderSource?: string;
     affiliateAddress?: string;
     affiliateFeePercent?: number;
@@ -148,6 +150,7 @@ export const analytics = {
             affiliateFeePercent,
             selectedAssetName: selectedAsset ? selectedAsset.metaData.name : 'none',
             selectedAssetData: selectedAsset ? selectedAsset.assetData : 'none',
+            instantEnvironment: INSTANT_DISCHARGE_TARGET || `Local ${process.env.NODE_ENV}`,
         };
         return eventOptions;
     },
diff --git a/packages/instant/webpack.config.js b/packages/instant/webpack.config.js
index 2a517bb59..803240e76 100644
--- a/packages/instant/webpack.config.js
+++ b/packages/instant/webpack.config.js
@@ -3,27 +3,43 @@ const ip = require('ip');
 const path = require('path');
 const webpack = require('webpack');
 
+const DISCHARGE_TARGETS_THAT_REQUIRED_HEAP = ['production', 'staging', 'dogfood'];
+const getConfigForDischargeTarget = dischargeTarget => {
+    return {
+        heapAnalyticsIdEnvName:
+            dischargeTarget === 'production'
+                ? 'INSTANT_HEAP_ANALYTICS_ID_PRODUCTION'
+                : 'INSTANT_HEAP_ANALYTICS_ID_DEVELOPMENT',
+        heapAnalyticsIdRequired: DISCHARGE_TARGETS_THAT_REQUIRED_HEAP.includes(dischargeTarget),
+    };
+};
+
 const GIT_SHA = childProcess
     .execSync('git rev-parse HEAD')
     .toString()
     .trim();
+const generateConfig = (dischargeTarget, configOptions) => {
+    const outputPath = process.env.WEBPACK_OUTPUT_PATH || 'umd';
 
-const HEAP_PRODUCTION_ENV_VAR_NAME = 'INSTANT_HEAP_ANALYTICS_ID_PRODUCTION';
-const HEAP_DEVELOPMENT_ENV_VAR_NAME = 'INSTANT_HEAP_ANALYTICS_ID_DEVELOPMENT';
-const getHeapAnalyticsId = modeName => {
-    if (modeName === 'production') {
-        return process.env[HEAP_PRODUCTION_ENV_VAR_NAME];
+    const { heapAnalyticsIdEnvName, heapAnalyticsIdRequired } = configOptions;
+    const heapAnalyticsId = process.env[heapAnalyticsIdEnvName];
+    if (heapAnalyticsIdRequired && !heapAnalyticsId) {
+        throw new Error(
+            `Must define heap analytics id in ENV var ${heapAnalyticsIdEnvName} when building for ${dischargeTarget}`,
+        );
     }
 
-    if (modeName === 'development') {
-        return process.env[HEAP_DEVELOPMENT_ENV_VAR_NAME];
+    const envVars = {
+        GIT_SHA: JSON.stringify(GIT_SHA),
+        NPM_PACKAGE_VERSION: JSON.stringify(process.env.npm_package_version),
+    };
+    if (dischargeTarget) {
+        envVars.INSTANT_DISCHARGE_TARGET = JSON.stringify(dischargeTarget);
+    }
+    if (heapAnalyticsId) {
+        envVars.HEAP_ANALYTICS_ID = JSON.stringify(heapAnalyticsId);
     }
 
-    return undefined;
-};
-
-module.exports = (env, argv) => {
-    const outputPath = process.env.WEBPACK_OUTPUT_PATH || 'umd';
     const config = {
         entry: {
             instant: './src/index.umd.ts',
@@ -36,11 +52,7 @@ module.exports = (env, argv) => {
         },
         plugins: [
             new webpack.DefinePlugin({
-                'process.env': {
-                    GIT_SHA: JSON.stringify(GIT_SHA),
-                    HEAP_ANALYTICS_ID: getHeapAnalyticsId(argv.mode),
-                    NPM_PACKAGE_VERSION: JSON.stringify(process.env.npm_package_version),
-                },
+                'process.env': envVars,
             }),
         ],
         devtool: 'source-map',
@@ -76,3 +88,9 @@ module.exports = (env, argv) => {
     };
     return config;
 };
+
+module.exports = (env, _argv) => {
+    const dischargeTarget = env ? env.discharge_target : undefined;
+    const configOptions = getConfigForDischargeTarget(dischargeTarget);
+    return generateConfig(dischargeTarget, configOptions);
+};
diff --git a/packages/monorepo-scripts/src/prepublish_checks.ts b/packages/monorepo-scripts/src/prepublish_checks.ts
index 60cdccf1d..36e61714b 100644
--- a/packages/monorepo-scripts/src/prepublish_checks.ts
+++ b/packages/monorepo-scripts/src/prepublish_checks.ts
@@ -17,7 +17,6 @@ async function prepublishChecksAsync(): Promise<void> {
     await checkChangelogFormatAsync(updatedPublicPackages);
     await checkGitTagsForNextVersionAndDeleteIfExistAsync(updatedPublicPackages);
     await checkPublishRequiredSetupAsync();
-    checkRequiredEnvVariables();
 }
 
 async function checkGitTagsForNextVersionAndDeleteIfExistAsync(updatedPublicPackages: Package[]): Promise<void> {
@@ -184,16 +183,6 @@ async function checkPublishRequiredSetupAsync(): Promise<void> {
     }
 }
 
-const checkRequiredEnvVariables = () => {
-    utils.log('Checking required environment variables...');
-    const requiredEnvVars = ['INSTANT_HEAP_ANALYTICS_ID_PRODUCTION'];
-    requiredEnvVars.forEach(requiredEnvVarName => {
-        if (_.isUndefined(process.env[requiredEnvVarName])) {
-            throw new Error(`Must have ${requiredEnvVarName} set`);
-        }
-    });
-};
-
 prepublishChecksAsync().catch(err => {
     utils.log(err);
     process.exit(1);