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
|
import type { BinaryLike } from 'node:crypto';
import { createHash, randomBytes } from 'node:crypto';
import { isCI } from 'ci-info';
import debug from 'debug';
import * as KEY from './keys.js';
import { post } from './post.js';
import { getAnonymousMeta } from './anonymous-meta.js';
import { getRawProjectId } from './project-id.js';
import { Config } from './config.js';
export interface AstroTelemetryOptions {
version: string;
}
export type TelemetryEvent = { eventName: string; payload: Record<string, any> };
interface EventContext {
anonymousId: string;
projectId: string;
sessionId: string;
}
export class AstroTelemetry {
private rawProjectId = getRawProjectId();
private sessionId = randomBytes(32).toString('hex');
private config = new Config({
name: 'astro',
// Use getter to defer generation of defaults unless needed
get defaults() {
return new Map<string, any>([
[KEY.TELEMETRY_ENABLED, true],
[KEY.TELEMETRY_SALT, randomBytes(16).toString('hex')],
[KEY.TELEMETRY_ID, randomBytes(32).toString('hex')],
]);
},
});
private debug = debug('astro:telemetry');
private get astroVersion() {
return this.opts.version;
}
private get ASTRO_TELEMETRY_DISABLED() {
return process.env.ASTRO_TELEMETRY_DISABLED;
}
private get TELEMETRY_DISABLED() {
return process.env.TELEMETRY_DISABLED;
}
constructor(private opts: AstroTelemetryOptions) {
// TODO: When the process exits, flush any queued promises
// This line caused a "cannot exist astro" error, needs to be revisited.
// process.on('SIGINT', () => this.flush());
}
// Util to get value from config or set it if missing
private getWithFallback<T>(key: string, value: T): T {
const val = this.config.get(key);
if (val) {
return val;
}
this.config.set(key, value);
return value;
}
private get salt(): string {
return this.getWithFallback(KEY.TELEMETRY_SALT, randomBytes(16).toString('hex'));
}
private get enabled(): boolean {
return this.getWithFallback(KEY.TELEMETRY_ENABLED, true);
}
private get anonymousId(): string {
return this.getWithFallback(KEY.TELEMETRY_ID, randomBytes(32).toString('hex'));
}
private get notifyDate(): string {
return this.getWithFallback(KEY.TELEMETRY_NOTIFY_DATE, '');
}
// Create a ONE-WAY hash so there is no way for Astro to decode the value later.
private oneWayHash(payload: BinaryLike): string {
const hash = createHash('sha256');
// Always prepend the payload value with salt! This ensures the hash is one-way.
hash.update(this.salt);
hash.update(payload);
return hash.digest('hex');
}
// Instead of sending `rawProjectId`, we only ever reference a hashed value *derived*
// from `rawProjectId`. This ensures that `projectId` is ALWAYS anonymous and can't
// be reversed from the hashed value.
private get projectId(): string {
return this.oneWayHash(this.rawProjectId);
}
private get isDisabled(): boolean {
if (Boolean(this.ASTRO_TELEMETRY_DISABLED || this.TELEMETRY_DISABLED)) {
return true;
}
return this.enabled === false;
}
setEnabled(value: boolean) {
this.config.set(KEY.TELEMETRY_ENABLED, value);
}
clear() {
return this.config.clear();
}
private queue: Promise<any>[] = [];
// Wait for any in-flight promises to resolve
private async flush() {
await Promise.all(this.queue);
}
async notify(callback: () => Promise<boolean>) {
if (this.isDisabled || isCI) {
return;
}
// The end-user has already been notified about our telemetry integration!
// Don't bother them about it again.
// In the event of significant changes, we should invalidate old dates.
if (this.notifyDate) {
return;
}
const enabled = await callback();
this.config.set(KEY.TELEMETRY_NOTIFY_DATE, Date.now().toString());
this.config.set(KEY.TELEMETRY_ENABLED, enabled);
}
async record(event: TelemetryEvent | TelemetryEvent[] = []) {
const events: TelemetryEvent[] = Array.isArray(event) ? event : [event];
if (events.length < 1) {
return Promise.resolve();
}
if (this.debug.enabled) {
// Print to standard error to simplify selecting the output
events.forEach(({ eventName, payload }) =>
this.debug(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 = getAnonymousMeta(this.astroVersion);
const req = post({
context,
meta,
events,
}).then(() => {
this.queue = this.queue.filter((r) => r !== req);
});
this.queue.push(req);
return req;
}
}
|
