rsnext/packages/next/telemetry/project-id.ts
Joe Haddad de670b3834
Do Not Rely on Module State (#8968)
* Do Not Rely on Module State

* Update storage.ts
2019-10-10 13:18:07 -04:00

32 lines
1 KiB
TypeScript

import { execSync } from 'child_process'
// 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 getRawProjectId(): string {
return _getProjectIdByGit() || process.env.REPOSITORY_URL || process.cwd()
}