/
storage.ts
260 lines (220 loc) · 7.36 KB
/
storage.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
import chalk from 'next/dist/compiled/chalk'
import Conf from 'next/dist/compiled/conf'
import { BinaryLike, createHash, randomBytes } from 'crypto'
import isDockerFunction from 'next/dist/compiled/is-docker'
import path from 'path'
import { getAnonymousMeta } from './anonymous-meta'
import * as ciEnvironment from './ci-info'
import { _postPayload } from './post-payload'
import { getRawProjectId } from './project-id'
// This is the key that stores whether or not telemetry is enabled or disabled.
const TELEMETRY_KEY_ENABLED = 'telemetry.enabled'
// This is the key that specifies when the user was informed about anonymous
// telemetry collection.
const TELEMETRY_KEY_NOTIFY_DATE = 'telemetry.notifiedAt'
// This is a quasi-persistent identifier used to dedupe recurring events. It's
// generated from random data and completely anonymous.
const TELEMETRY_KEY_ID = `telemetry.anonymousId`
// This is the cryptographic salt that is included within every hashed value.
// This salt value is never sent to us, ensuring privacy and the one-way nature
// of the hash (prevents dictionary lookups of pre-computed hashes).
// See the `oneWayHash` function.
const TELEMETRY_KEY_SALT = `telemetry.salt`
type TelemetryEvent = { eventName: string; payload: object }
type EventContext = {
anonymousId: string
projectId: string
sessionId: string
}
type EventMeta = { [key: string]: unknown }
type EventBatchShape = {
eventName: string
fields: object
}
type RecordObject = {
isFulfilled: boolean
isRejected: boolean
value?: any
reason?: any
}
function getStorageDirectory(distDir: string): string | undefined {
const isLikelyEphemeral = ciEnvironment.isCI || isDockerFunction()
if (isLikelyEphemeral) {
return path.join(distDir, 'cache')
}
return undefined
}
export class Telemetry {
private conf: Conf<any> | null
private sessionId: string
private rawProjectId: string
private NEXT_TELEMETRY_DISABLED: any
private NEXT_TELEMETRY_DEBUG: any
private queue: Set<Promise<RecordObject>>
constructor({ distDir }: { distDir: string }) {
// Read in the constructor so that .env can be loaded before reading
const { NEXT_TELEMETRY_DISABLED, NEXT_TELEMETRY_DEBUG } = process.env
this.NEXT_TELEMETRY_DISABLED = NEXT_TELEMETRY_DISABLED
this.NEXT_TELEMETRY_DEBUG = NEXT_TELEMETRY_DEBUG
const storageDirectory = getStorageDirectory(distDir)
try {
// `conf` incorrectly throws a permission error during initialization
// instead of waiting for first use. We need to handle it, otherwise the
// process may crash.
this.conf = new Conf({ projectName: 'nextjs', cwd: storageDirectory })
} catch (_) {
this.conf = null
}
this.sessionId = randomBytes(32).toString('hex')
this.rawProjectId = getRawProjectId()
this.queue = new Set()
this.notify()
}
private notify = () => {
if (this.isDisabled || !this.conf) {
return
}
// The end-user has already been notified about our telemetry integration. We
// don't need to constantly annoy them about it.
// We will re-inform users about the telemetry if significant changes are
// ever made.
if (this.conf.get(TELEMETRY_KEY_NOTIFY_DATE, '')) {
return
}
this.conf.set(TELEMETRY_KEY_NOTIFY_DATE, Date.now().toString())
console.log(
`${chalk.magenta.bold(
'Attention'
)}: Next.js now collects completely anonymous telemetry regarding usage.`
)
console.log(
`This information is used to shape Next.js' roadmap and prioritize features.`
)
console.log(
`You can learn more, including how to opt-out if you'd not like to participate in this anonymous program, by visiting the following URL:`
)
console.log(chalk.cyan('https://nextjs.org/telemetry'))
console.log()
}
get anonymousId(): string {
const val = this.conf && this.conf.get(TELEMETRY_KEY_ID)
if (val) {
return val
}
const generated = randomBytes(32).toString('hex')
this.conf && this.conf.set(TELEMETRY_KEY_ID, generated)
return generated
}
get salt(): string {
const val = this.conf && this.conf.get(TELEMETRY_KEY_SALT)
if (val) {
return val
}
const generated = randomBytes(16).toString('hex')
this.conf && this.conf.set(TELEMETRY_KEY_SALT, generated)
return generated
}
private get isDisabled(): boolean {
if (!!this.NEXT_TELEMETRY_DISABLED || !this.conf) {
return true
}
return this.conf.get(TELEMETRY_KEY_ENABLED, true) === false
}
setEnabled = (_enabled: boolean) => {
const enabled = !!_enabled
this.conf && this.conf.set(TELEMETRY_KEY_ENABLED, enabled)
return this.conf && this.conf.path
}
get isEnabled(): boolean {
return (
!this.NEXT_TELEMETRY_DISABLED &&
!!this.conf &&
this.conf.get(TELEMETRY_KEY_ENABLED, true) !== false
)
}
oneWayHash = (payload: BinaryLike): string => {
const hash = createHash('sha256')
// Always prepend the payload value with salt. This ensures the hash is truly
// one-way.
hash.update(this.salt)
// Update is an append operation, not a replacement. The salt from the prior
// update is still present!
hash.update(payload)
return hash.digest('hex')
}
private get projectId(): string {
return this.oneWayHash(this.rawProjectId)
}
record = (
_events: TelemetryEvent | TelemetryEvent[]
): Promise<RecordObject> => {
const _this = this
// pseudo try-catch
async function wrapper() {
return await _this.submitRecord(_events)
}
const prom = wrapper()
.then((value) => ({
isFulfilled: true,
isRejected: false,
value,
}))
.catch((reason) => ({
isFulfilled: false,
isRejected: true,
reason,
}))
// Acts as `Promise#finally` because `catch` transforms the error
.then((res) => {
// Clean up the event to prevent unbounded `Set` growth
this.queue.delete(prom)
return res
})
// Track this `Promise` so we can flush pending events
this.queue.add(prom)
return prom
}
flush = async () => Promise.all(this.queue).catch(() => null)
private submitRecord = (
_events: TelemetryEvent | TelemetryEvent[]
): Promise<any> => {
let events: TelemetryEvent[]
if (Array.isArray(_events)) {
events = _events
} else {
events = [_events]
}
if (events.length < 1) {
return Promise.resolve()
}
if (this.NEXT_TELEMETRY_DEBUG) {
// Print to standard error to simplify selecting the output
events.forEach(({ eventName, payload }) =>
console.error(
`[telemetry] ` + JSON.stringify({ eventName, payload }, null, 2)
)
)
// Do not send the telemetry data if debugging. Users may use this feature
// to preview what data would be sent.
return Promise.resolve()
}
// Skip recording telemetry if the feature is disabled
if (this.isDisabled) {
return Promise.resolve()
}
const context: EventContext = {
anonymousId: this.anonymousId,
projectId: this.projectId,
sessionId: this.sessionId,
}
const meta: EventMeta = getAnonymousMeta()
return _postPayload(`https://telemetry.nextjs.org/api/v1/record`, {
context,
meta,
events: events.map(({ eventName, payload }) => ({
eventName,
fields: payload,
})) as Array<EventBatchShape>,
})
}
}