@theia/telemetry 1.74.0-next.68

package/src/common/telemetry-topic.spec.ts

@@ -0,0 +1,78 @@
+// *****************************************************************************
+// Copyright (C) 2026 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { expect } from 'chai';
+import {
+    isValidTelemetrySinkId,
+    isValidTelemetryTopic,
+    isValidTelemetryTopicPattern,
+    matchesTelemetryTopic
+} from './telemetry-topic';
+
+describe('telemetry topic contract', () => {
+    const validNames = ['company/metric', 'Company/Metric', 'company/product/metric', 'company-1/metric_2', 'company.name/metric'];
+    const invalidNames = ['', 'company', '/company/metric', 'company/metric/', 'company//metric', 'company/*', '*/metric', 'company/**', 'company/metric!', ' company/metric'];
+
+    for (const name of validNames) {
+        it(`accepts topic and sink ID '${name}'`, () => {
+            expect(isValidTelemetryTopic(name)).to.be.true;
+            expect(isValidTelemetrySinkId(name)).to.be.true;
+        });
+    }
+
+    for (const name of invalidNames) {
+        it(`rejects topic and sink ID '${name}'`, () => {
+            expect(isValidTelemetryTopic(name)).to.be.false;
+            expect(isValidTelemetrySinkId(name)).to.be.false;
+        });
+    }
+
+    it('accepts only exact, terminal prefix, and global patterns', () => {
+        for (const pattern of ['company/metric', 'company/product/metric', 'company/*', 'company/product/*', '*']) {
+            expect(isValidTelemetryTopicPattern(pattern), pattern).to.be.true;
+        }
+        const invalidPatterns = [
+            '', 'company', '/company/*', 'company/*/', 'company//metric', '*/metric',
+            'company/*/metric', 'company/**', '**', '!company/metric', 'company/(metric)'
+        ];
+        for (const pattern of invalidPatterns) {
+            expect(isValidTelemetryTopicPattern(pattern), pattern).to.be.false;
+        }
+    });
+
+    it('matches exact topics case-sensitively', () => {
+        expect(matchesTelemetryTopic('company/metric', 'company/metric')).to.be.true;
+        expect(matchesTelemetryTopic('company/metric', 'company/other')).to.be.false;
+        expect(matchesTelemetryTopic('company/metric', 'Company/metric')).to.be.false;
+    });
+
+    it('matches descendants of a terminal prefix only', () => {
+        expect(matchesTelemetryTopic('company/*', 'company/metric')).to.be.true;
+        expect(matchesTelemetryTopic('company/*', 'company/product/metric')).to.be.true;
+        expect(matchesTelemetryTopic('company/*', 'company')).to.be.false;
+        expect(matchesTelemetryTopic('company/*', 'companyElse/metric')).to.be.false;
+    });
+
+    it('matches every valid topic with the global pattern', () => {
+        expect(matchesTelemetryTopic('*', 'company/metric')).to.be.true;
+        expect(matchesTelemetryTopic('*', 'company/product/metric')).to.be.true;
+    });
+
+    it('does not match invalid patterns or topics', () => {
+        expect(matchesTelemetryTopic('company/**', 'company/metric')).to.be.false;
+        expect(matchesTelemetryTopic('*', 'company')).to.be.false;
+    });
+});

package/src/common/telemetry-topic.ts

@@ -0,0 +1,60 @@
+// *****************************************************************************
+// Copyright (C) 2026 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+const SEGMENT_PATTERN = /^[A-Za-z0-9][A-Za-z0-9._-]*$/;
+
+function hasValidSegments(value: string, minimumSegments: number): boolean {
+    const segments = value.split('/');
+    return segments.length >= minimumSegments && segments.every(segment => SEGMENT_PATTERN.test(segment));
+}
+
+/** @experimental */
+export function isValidTelemetryTopic(topic: unknown): topic is string {
+    return typeof topic === 'string' && hasValidSegments(topic, 2);
+}
+
+/** @experimental */
+export function isValidTelemetrySinkId(id: unknown): id is string {
+    return typeof id === 'string' && hasValidSegments(id, 2);
+}
+
+/** @experimental */
+export function isValidTelemetryTopicPattern(pattern: unknown): pattern is string {
+    if (typeof pattern !== 'string') {
+        return false;
+    }
+    if (pattern === '*') {
+        return true;
+    }
+    if (pattern.endsWith('/*')) {
+        return hasValidSegments(pattern.slice(0, -2), 1);
+    }
+    return isValidTelemetryTopic(pattern);
+}
+
+/** @experimental */
+export function matchesTelemetryTopic(pattern: string, topic: string): boolean {
+    if (!isValidTelemetryTopicPattern(pattern) || !isValidTelemetryTopic(topic)) {
+        return false;
+    }
+    if (pattern === '*') {
+        return true;
+    }
+    if (pattern.endsWith('/*')) {
+        return topic.startsWith(`${pattern.slice(0, -2)}/`);
+    }
+    return pattern === topic;
+}

package/src/common/telemetry-types.ts

@@ -0,0 +1,21 @@
+// *****************************************************************************
+// Copyright (C) 2026 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/** @experimental */
+export type TelemetryLevel = 'off' | 'crash' | 'error' | 'all';
+
+/** @experimental */
+export const BACKEND_TELEMETRY_SESSION = 'backend';

package/src/common/test/recording-logger.ts

@@ -0,0 +1,33 @@
+// *****************************************************************************
+// Copyright (C) 2026 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { Loggable } from '@theia/core/lib/common';
+import { MockLogger } from '@theia/core/lib/common/test/mock-logger';
+
+export class RecordingLogger extends MockLogger {
+    readonly warnings: string[] = [];
+    readonly errors: string[] = [];
+
+    override warn(arg: string | Loggable, ...params: unknown[]): Promise<void> {
+        this.warnings.push(String(arg), ...params.map(String));
+        return Promise.resolve();
+    }
+
+    override error(arg: string | Loggable | Error, ...params: unknown[]): Promise<void> {
+        this.errors.push(String(arg), ...params.map(String));
+        return Promise.resolve();
+    }
+}

package/src/node/index.ts

@@ -0,0 +1,18 @@
+// *****************************************************************************
+// Copyright (C) 2026 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export * from './telemetry-service-impl';
+export * from './telemetry-sink';

package/src/node/telemetry-backend-module.ts

@@ -0,0 +1,40 @@
+// *****************************************************************************
+// Copyright (C) 2026 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { bindRootContributionProvider, ConnectionHandler, RpcConnectionHandler } from '@theia/core/lib/common';
+import { BackendApplicationContribution } from '@theia/core/lib/node/backend-application';
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { PreferenceTelemetryConsentProvider, TelemetryConsentProvider } from '../common/telemetry-consent-provider';
+import { bindTelemetryPreferences } from '../common/telemetry-preferences';
+import { telemetryServicePath, TelemetryRpc } from '../common/telemetry-protocol';
+import { TelemetryService } from '../common/telemetry-service';
+import { TelemetryServiceImpl } from './telemetry-service-impl';
+import { TelemetrySink } from './telemetry-sink';
+
+export default new ContainerModule(bind => {
+    bindTelemetryPreferences(bind);
+    bind(TelemetryConsentProvider).to(PreferenceTelemetryConsentProvider).inSingletonScope();
+    bindRootContributionProvider(bind, TelemetrySink);
+
+    bind(TelemetryServiceImpl).toSelf().inSingletonScope();
+    bind(TelemetryService).toService(TelemetryServiceImpl);
+    bind(TelemetryRpc).toService(TelemetryServiceImpl);
+    bind(BackendApplicationContribution).toService(TelemetryServiceImpl);
+
+    bind(ConnectionHandler).toDynamicValue(ctx =>
+        new RpcConnectionHandler(telemetryServicePath, () => ctx.container.get<TelemetryRpc>(TelemetryRpc))
+    ).inSingletonScope();
+});