m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
Code

Simplify handling of Segment keys (#9781)

Browse Source 
It was getting rather complicated to keep track of which Segment keys
were set where, and under which name.

The build script now injects a key even in test environments, but it is
unused if `IN_TEST` is truthy. This should be functionally equivalent
to the old logic. I find this simpler mainly for two reasons: there is
one less intermediate variable to keep track of now, and the `IN_TEST`
check is now directly in the module where we're constructing the
`segment` instance, rather than being referenced at a distance in a
comment.

The old setup made it difficult to turn on metrics for specific e2e
tests as well, which will be done in a subsequent PR.
This commit is contained in:
Mark Stacey 2020-11-03 17:11:24 -03:30 committed by GitHub
parent 5f828b4f41
commit ba6509c7a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
development/build/scripts.js
View File

@ -356,24 +356,6 @@ function createScriptTasks({ browserPlatforms, livereload }) {
throw new Error('Missing SENTRY_DSN environment variable') throw new Error('Missing SENTRY_DSN environment variable')
} }
// When we're in the 'production' environment we will use a specific key only set in CI
// Otherwise we'll use the key from .metamaskrc or from the environment variable. If
// the value of SEGMENT_WRITE_KEY that we envify is undefined then no events will be tracked
// in the build. This is intentional so that developers can contribute to MetaMask without
// inflating event volume.
const SEGMENT_PROD_WRITE_KEY = opts.testing
? undefined
: process.env.SEGMENT_PROD_WRITE_KEY
const SEGMENT_DEV_WRITE_KEY = opts.testing
? undefined
: conf.SEGMENT_WRITE_KEY
const SEGMENT_PROD_LEGACY_WRITE_KEY = opts.testing
? undefined
: process.env.SEGMENT_PROD_LEGACY_WRITE_KEY
const SEGMENT_DEV_LEGACY_WRITE_KEY = opts.testing
? undefined
: conf.SEGMENT_LEGACY_WRITE_KEY
// Inject variables into bundle // Inject variables into bundle
bundler.transform( bundler.transform(
envify({ envify({
@ -390,14 +372,19 @@ function createScriptTasks({ browserPlatforms, livereload }) {
INFURA_PROJECT_ID: opts.testing INFURA_PROJECT_ID: opts.testing
? '00000000000000000000000000000000' ? '00000000000000000000000000000000'
: conf.INFURA_PROJECT_ID, : conf.INFURA_PROJECT_ID,
// When we're in the 'production' environment we will use a specific key only set in CI
// Otherwise we'll use the key from .metamaskrc or from the environment variable. If
// the value of SEGMENT_WRITE_KEY that we envify is undefined then no events will be tracked
// in the build. This is intentional so that developers can contribute to MetaMask without
// inflating event volume.
SEGMENT_WRITE_KEY: SEGMENT_WRITE_KEY:
environment === 'production' environment === 'production'
? SEGMENT_PROD_WRITE_KEY ? process.env.SEGMENT_PROD_WRITE_KEY
: SEGMENT_DEV_WRITE_KEY, : conf.SEGMENT_WRITE_KEY,
SEGMENT_LEGACY_WRITE_KEY: SEGMENT_LEGACY_WRITE_KEY:
environment === 'production' environment === 'production'
? SEGMENT_PROD_LEGACY_WRITE_KEY ? process.env.SEGMENT_PROD_LEGACY_WRITE_KEY
: SEGMENT_DEV_LEGACY_WRITE_KEY, : conf.SEGMENT_LEGACY_WRITE_KEY,
}), }),
{ {
global: true, global: true,

20
shared/modules/metametrics.js
View File

@ -63,16 +63,18 @@ export function sendCountIsTrackable(sendCount) {
// provided a SEGMENT_WRITE_KEY. This also holds true for test environments and // provided a SEGMENT_WRITE_KEY. This also holds true for test environments and
// E2E, which is handled in the build process by never providing the SEGMENT_WRITE_KEY // E2E, which is handled in the build process by never providing the SEGMENT_WRITE_KEY
// when process.env.IN_TEST is truthy // when process.env.IN_TEST is truthy
export const segment = process.env.SEGMENT_WRITE_KEY export const segment =
? new Analytics(process.env.SEGMENT_WRITE_KEY, { flushAt, flushInterval }) process.env.IN_TEST || !process.env.SEGMENT_WRITE_KEY
: segmentNoop ? segmentNoop
: new Analytics(process.env.SEGMENT_WRITE_KEY, { flushAt, flushInterval })
export const segmentLegacy = process.env.SEGMENT_LEGACY_WRITE_KEY export const segmentLegacy =
? new Analytics(process.env.SEGMENT_LEGACY_WRITE_KEY, { process.env.IN_TEST || !process.env.SEGMENT_LEGACY_WRITE_KEY
flushAt, ? segmentNoop
flushInterval, : new Analytics(process.env.SEGMENT_LEGACY_WRITE_KEY, {
}) flushAt,
: segmentNoop flushInterval,
})
/** /**
* We attach context to every meta metrics event that help to qualify our analytics. * We attach context to every meta metrics event that help to qualify our analytics.