chore(telemetry): Add various surface detection to determineSurface for logging. (#6074)

Co-authored-by: christine betts <chrstn@uw.edu>
Co-authored-by: Jacob Richman <jacob314@gmail.com>
Co-authored-by: matt korwel <matt.korwel@gmail.com>
This commit is contained in:
Richie Foreman
2025-08-13 17:45:53 -04:00
committed by GitHub
parent 501b78f303
commit d6f74ea2f0
4 changed files with 168 additions and 10 deletions

View File

@@ -0,0 +1,68 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, afterEach, vi } from 'vitest';
import { detectIde, DetectedIde } from './detect-ide.js';
describe('detectIde', () => {
afterEach(() => {
vi.unstubAllEnvs();
});
it.each([
{
env: {},
expected: DetectedIde.VSCode,
},
{
env: { __COG_BASHRC_SOURCED: '1' },
expected: DetectedIde.Devin,
},
{
env: { REPLIT_USER: 'test' },
expected: DetectedIde.Replit,
},
{
env: { CURSOR_TRACE_ID: 'test' },
expected: DetectedIde.Cursor,
},
{
env: { CODESPACES: 'true' },
expected: DetectedIde.Codespaces,
},
{
env: { EDITOR_IN_CLOUD_SHELL: 'true' },
expected: DetectedIde.CloudShell,
},
{
env: { CLOUD_SHELL: 'true' },
expected: DetectedIde.CloudShell,
},
{
env: { TERM_PRODUCT: 'Trae' },
expected: DetectedIde.Trae,
},
{
env: { FIREBASE_DEPLOY_AGENT: 'true' },
expected: DetectedIde.FirebaseStudio,
},
{
env: { MONOSPACE_ENV: 'true' },
expected: DetectedIde.FirebaseStudio,
},
])('detects the IDE for $expected', ({ env, expected }) => {
vi.stubEnv('TERM_PROGRAM', 'vscode');
for (const [key, value] of Object.entries(env)) {
vi.stubEnv(key, value);
}
expect(detectIde()).toBe(expected);
});
it('returns undefined for non-vscode', () => {
vi.stubEnv('TERM_PROGRAM', 'definitely-not-vscode');
expect(detectIde()).toBeUndefined();
});
});

View File

@@ -5,6 +5,8 @@
*/
export enum DetectedIde {
Devin = 'devin',
Replit = 'replit',
VSCode = 'vscode',
Cursor = 'cursor',
CloudShell = 'cloudshell',
@@ -19,6 +21,14 @@ export interface IdeInfo {
export function getIdeInfo(ide: DetectedIde): IdeInfo {
switch (ide) {
case DetectedIde.Devin:
return {
displayName: 'Devin',
};
case DetectedIde.Replit:
return {
displayName: 'Replit',
};
case DetectedIde.VSCode:
return {
displayName: 'VS Code',
@@ -56,19 +66,25 @@ export function detectIde(): DetectedIde | undefined {
if (process.env.TERM_PROGRAM !== 'vscode') {
return undefined;
}
if (process.env.__COG_BASHRC_SOURCED) {
return DetectedIde.Devin;
}
if (process.env.REPLIT_USER) {
return DetectedIde.Replit;
}
if (process.env.CURSOR_TRACE_ID) {
return DetectedIde.Cursor;
}
if (process.env.CODESPACES) {
return DetectedIde.Codespaces;
}
if (process.env.EDITOR_IN_CLOUD_SHELL) {
if (process.env.EDITOR_IN_CLOUD_SHELL || process.env.CLOUD_SHELL) {
return DetectedIde.CloudShell;
}
if (process.env.TERM_PRODUCT === 'Trae') {
return DetectedIde.Trae;
}
if (process.env.FIREBASE_DEPLOY_AGENT) {
if (process.env.FIREBASE_DEPLOY_AGENT || process.env.MONOSPACE_ENV) {
return DetectedIde.FirebaseStudio;
}
return DetectedIde.VSCode;