File size: 10,084 Bytes
fcfabd3 | 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 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | import type { Args } from 'claude-code'
import { describe, expect, mock, test, tier } from 'claude-code/testing'
import Fixtures from './fixtures'
tier('builtin')
describe('register', () => {
test(
'a $.telemetry.log call from a plugin posts one first-party row',
{ plugins: [Fixtures.recording] },
async ($, on) => {
mock.env(on, { USER_TYPE: 'ant' })
const posts = Fixtures.firstPartySession(on)
expect(
await $.command.run(Fixtures.record(Fixtures.surveyAnswer())),
).toEqual({ text: 'sent' })
expect(
posts.map(post => [post.url, post.init?.method, post.init?.auth]),
).toEqual([
[
'https://api.anthropic.com/api/event_logging/v2/batch',
'POST',
'the-handle',
],
])
expect(posts.map(Fixtures.rowOf)).toEqual([
{
event_type: 'ClaudeCodeInternalEvent',
hasTimestamp: true,
event_name: 'tengu_plugin_survey_answered',
session_id: 'the-session',
model: 'the-model',
user_type: 'ant',
metadata: { answer: 2, page: 'ready', seen: true },
},
])
},
)
test(
'a row already named tengu_ is sent under its own name',
{ plugins: [Fixtures.recording] },
async ($, on) => {
mock.env(on, {})
const posts = Fixtures.firstPartySession(on)
await $.command.run(
Fixtures.record({
...Fixtures.surveyAnswer(),
event: 'tengu_repl_diff_panel_shown',
}),
)
expect(posts.map(Fixtures.batchOf)).toMatchObject([
{
events: [
{
event_data: {
event_name: 'tengu_repl_diff_panel_shown',
user_type: 'external',
},
},
],
},
])
},
)
test(
'nothing is sent where any switch has analytics off',
{ plugins: [Fixtures.recording] },
async ($, on) => {
let environment: Readonly<Record<string, string>> = {}
on('env.get', ($, e) => ({ value: environment[e.name] }))
const posts = Fixtures.firstPartySession(on)
const answers: (string | undefined)[] = []
for (const off of Fixtures.ANALYTICS_OFF_ENVIRONMENTS) {
environment = { USER_TYPE: 'ant', ...off }
answers.push(
(await $.command.run(Fixtures.record(Fixtures.surveyAnswer()))).text,
)
}
const withheld = posts.length
environment = { USER_TYPE: 'ant' }
await $.command.run(Fixtures.record(Fixtures.surveyAnswer()))
expect(answers).toEqual(
Fixtures.ANALYTICS_OFF_ENVIRONMENTS.map(() => 'sent'),
)
expect(withheld, 'nothing posted while any switch was off').toBe(0)
expect(posts, 'then one row once every switch is clear').toHaveLength(1)
},
)
test(
'a third-party provider the host manages sends nothing too',
{ plugins: [Fixtures.recording] },
async ($, on) => {
mock.env(on, {
CLAUDE_CODE_USE_BEDROCK: '1',
CLAUDE_CODE_PROVIDER_MANAGED_BY_HOST: '1',
})
const posts = Fixtures.firstPartySession(on)
const { text } = await $.command.run(
Fixtures.record(Fixtures.surveyAnswer()),
)
expect({ text, posts }).toEqual({ text: 'sent', posts: [] })
},
)
test(
'a $.telemetry.mark call posts the feature row by its own name',
{ plugins: [Fixtures.marking] },
async ($, on) => {
mock.env(on, { USER_TYPE: 'ant' })
const posts = Fixtures.firstPartySession(on)
const answers: (string | undefined)[] = []
for (const entry of [
{ feature: 'learn_page', kind: 'ok' },
{ feature: 'learn_page', kind: 'sad', reason: 'blocked' },
{ feature: 'suggest_learning', kind: 'bad', reason: 'api_error' },
]) {
answers.push((await $.command.run(Fixtures.mark(entry))).text)
}
expect(answers).toEqual(['sent', 'sent', 'sent'])
expect(
posts.map(Fixtures.rowOf),
'the feature events by their own names, no plugin prefix',
).toMatchObject([
{
event_name: 'tengu_feature_ok',
metadata: { feature_name: 'learn_page' },
},
{
event_name: 'tengu_feature_sad',
metadata: { feature_name: 'learn_page', error_code: 'blocked' },
},
{
event_name: 'tengu_feature_bad',
metadata: {
feature_name: 'suggest_learning',
error_code: 'api_error',
},
},
])
},
)
test(
'a mark with a bad kind or a wrong reason is refused, nothing sent',
{ plugins: [Fixtures.marking] },
async ($, on) => {
mock.env(on, { USER_TYPE: 'ant' })
const posts = Fixtures.firstPartySession(on)
const refusalFor = async (entry: unknown) =>
(await $.command.run(Fixtures.mark(entry))).text
expect(
await refusalFor({ feature: 'learn_page', kind: 'meh' }),
).toEndWith("$.telemetry.mark: kind: 'ok', 'sad' or 'bad'")
expect(
await refusalFor({ feature: 'learn_page', kind: 'bad' }),
).toEndWith(
'$.telemetry.mark: reason: a bad mark names why, a snake_case token',
)
expect(
await refusalFor({ feature: 'learn_page', kind: 'ok', reason: 'x' }),
).toEndWith('$.telemetry.mark: reason: an ok mark carries none')
expect(await refusalFor({ feature: 'Learn Page', kind: 'ok' })).toEndWith(
'$.telemetry.mark: takes a feature name, a snake_case token',
)
expect(await refusalFor('x')).toEndWith(
'$.telemetry.mark: takes one entry, { feature, kind, reason?, props? }',
)
expect(posts).toEqual([])
},
)
test(
'a session with no first-party credential is refused, nothing sent',
{ plugins: [Fixtures.recording] },
async ($, on) => {
mock.env(on, {})
const posts = Fixtures.firstPartySession(on, null)
const { text } = await $.command.run(
Fixtures.record(Fixtures.surveyAnswer()),
)
expect(text).toEndWith(
'$.telemetry.log: this session has no first-party credential to ' +
'authorize',
)
expect(posts).toEqual([])
},
)
test(
"the ingest's refusal rejects the caller's promise",
{ plugins: [Fixtures.recording] },
async ($, on) => {
mock.env(on, {})
const posts = Fixtures.firstPartySession(
on,
Fixtures.BEARER,
Fixtures.REFUSED,
)
const { text } = await $.command.run(
Fixtures.record(Fixtures.surveyAnswer()),
)
expect(text).toEndWith('$.telemetry.log: the ingest answered 500')
expect(posts).toHaveLength(1)
},
)
test(
'free text and a malformed entry are refused, nothing sent',
{ plugins: [Fixtures.recording] },
async ($, on) => {
mock.env(on, {})
const posts = Fixtures.firstPartySession(on)
const refusalFor = async (entry: unknown) =>
(
await $.command.run({
...Fixtures.record(Fixtures.surveyAnswer()),
args: JSON.stringify(entry),
})
).text
expect(
await refusalFor({ event: 'x', props: { note: 'hello world' } }),
).toEndWith(
'$.telemetry.log: props.note: free text is refused; a string is a ' +
'Choice, { value, of: [...] }',
)
expect(
await refusalFor({
event: 'x',
props: { page: { value: 'elsewhere', of: ['ready', 'later'] } },
}),
).toEndWith(
'$.telemetry.log: props.page.value: one of the members of `of`',
)
expect(await refusalFor({ event: 'Survey' })).toEndWith(
'$.telemetry.log: takes an event name, a snake_case token',
)
expect(
await refusalFor({ event: 'x', props: { 'a path': 1 } }),
).toEndWith('$.telemetry.log: props: every key is a snake_case token')
expect(await refusalFor('x')).toEndWith(
'$.telemetry.log: takes one entry, { event, props? }',
)
expect(posts).toEqual([])
},
)
test(
'a number that is not finite is refused, nothing sent',
{
plugins: [
{
name: 'counting',
register(on) {
on('command.run', { command: 'count' }, $ =>
$.telemetry.log({ event: 'x', props: { n: Number.NaN } }).then(
() => ({ text: 'sent' }),
(error: unknown) => ({ text: String(error) }),
),
)
},
},
],
},
async ($, on) => {
mock.env(on, {})
const posts = Fixtures.firstPartySession(on)
const { text } = await $.command.run({
command: 'count',
args: '',
origin: { kind: 'composer' },
presentation: Fixtures.FULLSCREEN,
})
expect(text).toEndWith('$.telemetry.log: props.n: a number is finite')
expect(posts).toEqual([])
},
)
test(
'a failed authorize is not memoized; a retry sends',
{ plugins: [Fixtures.recording] },
async ($, on) => {
const posts: Args<'http.fetch'>[] = []
let authorizations = 0
mock.env(on, {})
on('session.id', () => ({ value: 'the-session' }))
on('session.model', () => ({ value: 'the-model' }))
on('session.authorize', () => {
authorizations += 1
const isFirstAuthorization = authorizations === 1
return isFirstAuthorization
? { deny: 'transient' }
: { value: Fixtures.BEARER }
})
on('http.fetch', ($, e) => {
posts.push(e)
return { value: Fixtures.ACCEPTED }
})
const first = await $.command.run(Fixtures.record({ event: 'x' }))
const postsAfterFirst = posts.length
const second = await $.command.run(Fixtures.record({ event: 'x' }))
expect(first.text).toContain('transient')
expect(postsAfterFirst).toBe(0)
expect(second.text).toBe('sent')
expect(posts).toHaveLength(1)
},
)
})
|