rsnext/packages/next/telemetry/project-id.ts
Joe Haddad 1f4e34ca00
Anonymous Telemetry (#8529)
* Add anonymous telemetry

* Fix types

* Remove semver package

* Rename build time variable

* Track CSS-in-JS solutions

* Single retry and 5s timeout
2019-08-29 12:43:06 -04:00

40 lines
1.3 KiB
TypeScript

import { execSync } from 'child_process'
import { computeHash } from './storage'
// Q: Why does Next.js need a project ID? Why is it looking at my git remote?
// A:
// Next.js' telemetry is and always will be completely anonymous. Because of
// this, we need a way to differentiate different projects to track feature
// usage accurately. For example, to prevent a feature from appearing to be
// constantly `used` and then `unused` when switching between local projects.
// To reiterate,
// we **never** can read your actual git remote. The value is hashed one-way
// with random salt data, making it impossible for us to reverse or try to
// guess the remote by re-computing hashes.
function _getProjectIdByGit() {
try {
const originBuffer = execSync(
`git config --local --get remote.origin.url`,
{
timeout: 1000,
stdio: `pipe`,
}
)
return String(originBuffer).trim()
} catch (_) {
return null
}
}
export function getProjectId(): string {
const projectId =
_getProjectIdByGit() || process.env.REPOSITORY_URL || process.cwd()
// Compute a one-way, salted hash of the project ID. This value cannot be
// reversed.
// See the top of the file for a more detailed reason why we ask for this
// data.
return computeHash(projectId.trim().toLowerCase()) || ''
}