Skip to content

refactor: migrate telemetry tests to typescript #16358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ematipico merged 9 commits into from
Apr 16, 2026
+38 −21
Merged

refactor: migrate telemetry tests to typescript #16358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3fae5f1
refactor: migrate telemetry tests to typescript
ocavue Apr 16, 2026
25d4659
format
ocavue Apr 16, 2026
74b12ee
remove types
ocavue Apr 16, 2026
9168884
format
ocavue Apr 16, 2026
0131c8f
just use any
ocavue Apr 16, 2026
8d07abb
format
ocavue Apr 16, 2026
5b8d093
fix typecheck
ocavue Apr 16, 2026
7713858
Merge remote-tracking branch 'withastro/main' into ocavue-ts-test-tel…
ocavue Apr 16, 2026
db6cb18
chore: trigger ci
ocavue Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/telemetry/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
"build": "astro-scripts build \"src/**/*.ts\" && tsc",
"build:ci": "astro-scripts build \"src/**/*.ts\"",
"dev": "astro-scripts dev \"src/**/*.ts\"",
"test": "astro-scripts test \"test/**/*.test.js\""
"test": "astro-scripts test \"test/**/*.test.ts\"",
"typecheck:tests": "tsc --build tsconfig.test.json"
},
"files": [
"dist"
Expand Down
0 packages/telemetry/test/config.test.js → packages/telemetry/test/config.test.ts
View file
Open in desktop
File renamed without changes.
43 changes: 23 additions & 20 deletions packages/telemetry/test/index.test.js → packages/telemetry/test/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,22 @@ import { after, before, describe, it } from 'node:test';
import { AstroTelemetry } from '../dist/index.js';

function setup() {
const config = new Map();
const telemetry = new AstroTelemetry({ astroVersion: '0.0.0-test.1', viteVersion: '0.0.0' });
const logs = [];
const config = new Map<string, unknown>();
const telemetry = new AstroTelemetry({
astroVersion: '0.0.0-test.1',
viteVersion: '0.0.0',
});
const logs: unknown[][] = [];
// Stub isCI to false so we can test user-facing behavior
telemetry.isCI = false;
telemetry['isCI'] = false;
// Stub process.env to properly test in Astro's own CI
telemetry.env = {};
telemetry['env'] = {};
// Override config so we can inspect it
telemetry.config = config;
telemetry['config'] = config;

// Mock the global debug function to capture logs
const originalDebug = globalThis._astroGlobalDebug;
globalThis._astroGlobalDebug = (type, ...args) => {
const originalDebug = (globalThis as any)._astroGlobalDebug;
(globalThis as any)._astroGlobalDebug = (type: string, ...args: unknown[]) => {
if (type === 'telemetry') {
logs.push(args);
}
Expand All @@ -34,13 +37,13 @@ function setup() {
config,
logs,
cleanup: () => {
globalThis._astroGlobalDebug = originalDebug;
(globalThis as any)._astroGlobalDebug = originalDebug;
process.env.DEBUG = oldDebug;
},
};
}
describe('AstroTelemetry', () => {
let oldCI;
let oldCI: string | undefined;
before(() => {
oldCI = process.env.CI;
// Stub process.env.CI to `false`
Expand All @@ -60,9 +63,9 @@ describe('AstroTelemetry', () => {
const [key] = Array.from(config.keys());
assert.notEqual(key, undefined);
assert.equal(config.get(key), false);
assert.equal(telemetry.enabled, false);
Copy link
Copy Markdown
Member

@ematipico ematipico Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use telemetry?.enabled instead?

Copy link
Copy Markdown
Contributor Author

@ocavue ocavue Apr 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. enabled is a TypeScript private property. The string index notation object['privateProperty'] is an escape hatch to access a private member outside the class. See the playground link below:

https://www.typescriptlang.org/play/?#code/MYGwhgzhAECyCeBhcVoG8BQ1oFt4AUBXAIxAEtgAxMgUxABMAuaCAFwCcyA7Ac2i2gAHTgDcwrGrgKjxNanSYsO3HhgHAA9lzbtCwVhvYAKAJToB2VgAsyEAHR4ipCvIbQAvNABEXi9Gu2DtJkYhKu9B7evtgAvhhxGJrarFIA8sQAVjT6kVw0AO5wSCgQpolabGmZ2ayp7AByhCAgkbDiVnbsYFz0Gjim0AB80AAMdgCs0AD8VVk5zFxNIGoA9CvQqQDWNPAYeOlzrEFO5FS0DKvrWzt78Ac1ANoA5I4kp+FPALqXG9u7+9V9HVGs0psc3i5zvQftd-ndAbUGkswc9Xs4zgovmoMGtoABRdjsQzQABMAGYACwARmY+CJgho7FY8GgL2CoTkUKe0FsQhkEmg3QiWhALLAwGANCgZFIknyZACXGgoEgMCeCGQqqedlu930x35nIUML+uoRqPZsg+3xx6wJRPYpMpNOgdI0DKZLLZdJCVq5PJgwl9AqF0BFYolUogMpAcoVNiVKtQ6uKWp1AMOwORBuDRoutt+NwzNSzoLsFp9HOtQA

assert.equal(telemetry.isDisabled, true);
const result = await telemetry.record(['TEST']);
assert.equal(telemetry['enabled'], false);
assert.equal(telemetry['isDisabled'], true);
const result = await telemetry.record([{ eventName: 'TEST', payload: {} }]);
assert.equal(result, undefined);
const [log] = logs;
assert.notEqual(log, undefined);
Expand All @@ -75,9 +78,9 @@ describe('AstroTelemetry', () => {
const [key] = Array.from(config.keys());
assert.notEqual(key, undefined);
assert.equal(config.get(key), true);
assert.equal(telemetry.enabled, true);
assert.equal(telemetry.isDisabled, false);
await telemetry.record(['TEST']);
assert.equal(telemetry['enabled'], true);
assert.equal(telemetry['isDisabled'], false);
await telemetry.record([{ eventName: 'TEST', payload: {} }]);
assert.equal(logs.length, 2);
cleanup();
});
Expand All @@ -87,8 +90,8 @@ describe('AstroTelemetry', () => {
const [key] = Array.from(config.keys());
assert.notEqual(key, undefined);
assert.equal(config.get(key), false);
assert.equal(telemetry.enabled, false);
assert.equal(telemetry.isDisabled, true);
assert.equal(telemetry['enabled'], false);
assert.equal(telemetry['isDisabled'], true);
const [log] = logs;
assert.notEqual(log, undefined);
assert.match(logs.join(''), /disabled/);
Expand All @@ -100,8 +103,8 @@ describe('AstroTelemetry', () => {
const [key] = Array.from(config.keys());
assert.notEqual(key, undefined);
assert.equal(config.get(key), true);
assert.equal(telemetry.enabled, true);
assert.equal(telemetry.isDisabled, false);
assert.equal(telemetry['enabled'], true);
assert.equal(telemetry['isDisabled'], false);
const [log] = logs;
assert.notEqual(log, undefined);
assert.match(logs.join(''), /enabled/);
Expand Down
13 changes: 13 additions & 0 deletions packages/telemetry/tsconfig.test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"extends": "../../tsconfig.base.json",
"include": ["test/**/*.ts"],
"exclude": ["test/fixtures/**"],
"compilerOptions": {
"noEmit": true,
"allowJs": true,
"noUnusedLocals": false,
"noUnusedParameters": false,
"rewriteRelativeImportExtensions": true
},
"references": [{ "path": "../astro/tsconfig.test.json" }]
}
Loading