@theia/telemetry 1.77.0-next.0 → 1.77.0-next.101

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/lib/browser/browser-telemetry-service.d.ts +4 -3
  2. package/lib/browser/browser-telemetry-service.d.ts.map +1 -1
  3. package/lib/browser/browser-telemetry-service.js +26 -33
  4. package/lib/browser/browser-telemetry-service.js.map +1 -1
  5. package/lib/browser/browser-telemetry-service.spec.js +48 -50
  6. package/lib/browser/browser-telemetry-service.spec.js.map +1 -1
  7. package/lib/browser/index.d.ts +1 -1
  8. package/lib/browser/index.d.ts.map +1 -1
  9. package/lib/browser/index.js +1 -4
  10. package/lib/browser/index.js.map +1 -1
  11. package/lib/browser/telemetry-frontend-module.js +15 -17
  12. package/lib/browser/telemetry-frontend-module.js.map +1 -1
  13. package/lib/browser-only/browser-only-telemetry-service.d.ts +2 -1
  14. package/lib/browser-only/browser-only-telemetry-service.d.ts.map +1 -1
  15. package/lib/browser-only/browser-only-telemetry-service.js +5 -8
  16. package/lib/browser-only/browser-only-telemetry-service.js.map +1 -1
  17. package/lib/browser-only/browser-only-telemetry-service.spec.js +16 -18
  18. package/lib/browser-only/browser-only-telemetry-service.spec.js.map +1 -1
  19. package/lib/browser-only/telemetry-frontend-only-module.js +8 -10
  20. package/lib/browser-only/telemetry-frontend-only-module.js.map +1 -1
  21. package/lib/common/index.d.ts +6 -6
  22. package/lib/common/index.d.ts.map +1 -1
  23. package/lib/common/index.js +6 -9
  24. package/lib/common/index.js.map +1 -1
  25. package/lib/common/telemetry-consent-provider.d.ts +2 -2
  26. package/lib/common/telemetry-consent-provider.d.ts.map +1 -1
  27. package/lib/common/telemetry-consent-provider.js +18 -25
  28. package/lib/common/telemetry-consent-provider.js.map +1 -1
  29. package/lib/common/telemetry-consent-provider.spec.js +23 -25
  30. package/lib/common/telemetry-consent-provider.spec.js.map +1 -1
  31. package/lib/common/telemetry-preferences.d.ts +1 -1
  32. package/lib/common/telemetry-preferences.d.ts.map +1 -1
  33. package/lib/common/telemetry-preferences.js +27 -32
  34. package/lib/common/telemetry-preferences.js.map +1 -1
  35. package/lib/common/telemetry-preferences.spec.js +9 -11
  36. package/lib/common/telemetry-preferences.spec.js.map +1 -1
  37. package/lib/common/telemetry-protocol.d.ts +1 -2
  38. package/lib/common/telemetry-protocol.d.ts.map +1 -1
  39. package/lib/common/telemetry-protocol.js +18 -27
  40. package/lib/common/telemetry-protocol.js.map +1 -1
  41. package/lib/common/telemetry-protocol.spec.d.ts +2 -0
  42. package/lib/common/telemetry-protocol.spec.d.ts.map +1 -0
  43. package/lib/common/telemetry-protocol.spec.js +34 -0
  44. package/lib/common/telemetry-protocol.spec.js.map +1 -0
  45. package/lib/common/telemetry-service.d.ts +1 -18
  46. package/lib/common/telemetry-service.d.ts.map +1 -1
  47. package/lib/common/telemetry-service.js +1 -43
  48. package/lib/common/telemetry-service.js.map +1 -1
  49. package/lib/common/telemetry-service.spec.js +2 -92
  50. package/lib/common/telemetry-service.spec.js.map +1 -1
  51. package/lib/common/telemetry-topic.js +4 -10
  52. package/lib/common/telemetry-topic.js.map +1 -1
  53. package/lib/common/telemetry-topic.spec.js +19 -21
  54. package/lib/common/telemetry-topic.spec.js.map +1 -1
  55. package/lib/common/telemetry-types.d.ts +17 -0
  56. package/lib/common/telemetry-types.d.ts.map +1 -1
  57. package/lib/common/telemetry-types.js +40 -8
  58. package/lib/common/telemetry-types.js.map +1 -1
  59. package/lib/common/telemetry-types.spec.js +85 -7
  60. package/lib/common/telemetry-types.spec.js.map +1 -1
  61. package/lib/common/test/recording-logger.js +2 -6
  62. package/lib/common/test/recording-logger.js.map +1 -1
  63. package/lib/node/index.d.ts +2 -2
  64. package/lib/node/index.d.ts.map +1 -1
  65. package/lib/node/index.js +2 -5
  66. package/lib/node/index.js.map +1 -1
  67. package/lib/node/telemetry-backend-module.js +18 -20
  68. package/lib/node/telemetry-backend-module.js.map +1 -1
  69. package/lib/node/telemetry-service-impl.d.ts +6 -5
  70. package/lib/node/telemetry-service-impl.d.ts.map +1 -1
  71. package/lib/node/telemetry-service-impl.js +37 -47
  72. package/lib/node/telemetry-service-impl.js.map +1 -1
  73. package/lib/node/telemetry-service-impl.spec.js +108 -110
  74. package/lib/node/telemetry-service-impl.spec.js.map +1 -1
  75. package/lib/node/telemetry-sink.d.ts +1 -1
  76. package/lib/node/telemetry-sink.d.ts.map +1 -1
  77. package/lib/node/telemetry-sink.js +1 -4
  78. package/lib/node/telemetry-sink.js.map +1 -1
  79. package/package.json +14 -3
  80. package/src/browser/browser-telemetry-service.spec.ts +5 -5
  81. package/src/browser/browser-telemetry-service.ts +5 -5
  82. package/src/browser/index.ts +1 -1
  83. package/src/browser/telemetry-frontend-module.ts +5 -5
  84. package/src/browser-only/browser-only-telemetry-service.spec.ts +3 -3
  85. package/src/browser-only/browser-only-telemetry-service.ts +2 -1
  86. package/src/browser-only/telemetry-frontend-only-module.ts +2 -2
  87. package/src/common/index.ts +6 -6
  88. package/src/common/telemetry-consent-provider.spec.ts +3 -3
  89. package/src/common/telemetry-consent-provider.ts +2 -2
  90. package/src/common/telemetry-preferences.spec.ts +1 -1
  91. package/src/common/telemetry-preferences.ts +1 -1
  92. package/src/common/telemetry-protocol.spec.ts +36 -0
  93. package/src/common/telemetry-protocol.ts +4 -3
  94. package/src/common/telemetry-service.spec.ts +2 -102
  95. package/src/common/telemetry-service.ts +1 -59
  96. package/src/common/telemetry-topic.spec.ts +1 -1
  97. package/src/common/telemetry-types.spec.ts +94 -1
  98. package/src/common/telemetry-types.ts +59 -0
  99. package/src/node/index.ts +2 -2
  100. package/src/node/telemetry-backend-module.ts +6 -6
  101. package/src/node/telemetry-service-impl.spec.ts +7 -7
  102. package/src/node/telemetry-service-impl.ts +7 -7
  103. package/src/node/telemetry-sink.ts +1 -1
@@ -19,11 +19,11 @@ import { FrontendIdProvider } from '@theia/core/lib/browser/messaging/frontend-i
19
19
  import { Emitter, ILogger } from '@theia/core/lib/common';
20
20
  import * as sinon from 'sinon';
21
21
  import { Container } from '@theia/core/shared/inversify';
22
- import { TelemetryConsentProvider } from '../common/telemetry-consent-provider';
23
- import { TelemetryEvent, TelemetryRpc } from '../common/telemetry-protocol';
24
- import { RecordingLogger } from '../common/test/recording-logger';
25
- import { TelemetryLevel } from '../common/telemetry-types';
26
- import { BrowserTelemetryService } from './browser-telemetry-service';
22
+ import { TelemetryConsentProvider } from '../common/telemetry-consent-provider.js';
23
+ import { TelemetryEvent, TelemetryRpc } from '../common/telemetry-protocol.js';
24
+ import { RecordingLogger } from '../common/test/recording-logger.js';
25
+ import { TelemetryLevel } from '../common/telemetry-types.js';
26
+ import { BrowserTelemetryService } from './browser-telemetry-service.js';
27
27
 
28
28
  const FRONTEND_ID = 'test-frontend-id';
29
29
 
@@ -17,13 +17,13 @@
17
17
  import { FrontendIdProvider } from '@theia/core/lib/browser/messaging/frontend-id-provider';
18
18
  import { ILogger } from '@theia/core/lib/common';
19
19
  import { inject, injectable, named } from '@theia/core/shared/inversify';
20
- import { TelemetryConsentProvider } from '../common/telemetry-consent-provider';
20
+ import { TelemetryConsentProvider } from '../common/telemetry-consent-provider.js';
21
21
  import {
22
22
  TelemetryRpc, createTelemetryEvent, describeTelemetryTopic, isValidTelemetryEvent, snapshotTelemetryEvent
23
- } from '../common/telemetry-protocol';
24
- import { TelemetryData, TelemetryReportOptions, TelemetryService } from '../common/telemetry-service';
25
- import { isKindAllowedByLevel } from '../common/telemetry-types';
26
- import { matchesTelemetryTopic } from '../common/telemetry-topic';
23
+ } from '../common/telemetry-protocol.js';
24
+ import { TelemetryService } from '../common/telemetry-service.js';
25
+ import { matchesTelemetryTopic } from '../common/telemetry-topic.js';
26
+ import { TelemetryData, TelemetryReportOptions, isKindAllowedByLevel } from '../common/telemetry-types.js';
27
27
 
28
28
  @injectable()
29
29
  export class BrowserTelemetryService implements TelemetryService {
@@ -14,4 +14,4 @@
14
14
  // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
15
  // *****************************************************************************
16
16
 
17
- export * from './browser-telemetry-service';
17
+ export * from './browser-telemetry-service.js';
@@ -16,11 +16,11 @@
16
16
 
17
17
  import { RemoteConnectionProvider, ServiceConnectionProvider } from '@theia/core/lib/browser';
18
18
  import { ContainerModule } from '@theia/core/shared/inversify';
19
- import { PreferenceTelemetryConsentProvider, TelemetryConsentProvider } from '../common/telemetry-consent-provider';
20
- import { bindTelemetryPreferences } from '../common/telemetry-preferences';
21
- import { telemetryServicePath, TelemetryRpc } from '../common/telemetry-protocol';
22
- import { TelemetryService } from '../common/telemetry-service';
23
- import { BrowserTelemetryService } from './browser-telemetry-service';
19
+ import { PreferenceTelemetryConsentProvider, TelemetryConsentProvider } from '../common/telemetry-consent-provider.js';
20
+ import { bindTelemetryPreferences } from '../common/telemetry-preferences.js';
21
+ import { telemetryServicePath, TelemetryRpc } from '../common/telemetry-protocol.js';
22
+ import { TelemetryService } from '../common/telemetry-service.js';
23
+ import { BrowserTelemetryService } from './browser-telemetry-service.js';
24
24
 
25
25
  export default new ContainerModule(bind => {
26
26
  bindTelemetryPreferences(bind);
@@ -16,9 +16,9 @@
16
16
 
17
17
  import { Container } from '@theia/core/shared/inversify';
18
18
  import { expect } from 'chai';
19
- import { TelemetryService } from '../common/telemetry-service';
20
- import { BrowserOnlyTelemetryService } from './browser-only-telemetry-service';
21
- import telemetryFrontendOnlyModule from './telemetry-frontend-only-module';
19
+ import { TelemetryService } from '../common/telemetry-service.js';
20
+ import { BrowserOnlyTelemetryService } from './browser-only-telemetry-service.js';
21
+ import telemetryFrontendOnlyModule from './telemetry-frontend-only-module.js';
22
22
 
23
23
  describe('browser-only telemetry service', () => {
24
24
  it('binds the no-op service when telemetry is not already bound', () => {
@@ -15,7 +15,8 @@
15
15
  // *****************************************************************************
16
16
 
17
17
  import { injectable } from '@theia/core/shared/inversify';
18
- import { TelemetryData, TelemetryReportOptions, TelemetryService } from '../common/telemetry-service';
18
+ import { TelemetryService } from '../common/telemetry-service.js';
19
+ import { TelemetryData, TelemetryReportOptions } from '../common/telemetry-types.js';
19
20
 
20
21
  @injectable()
21
22
  export class BrowserOnlyTelemetryService implements TelemetryService {
@@ -15,8 +15,8 @@
15
15
  // *****************************************************************************
16
16
 
17
17
  import { ContainerModule } from '@theia/core/shared/inversify';
18
- import { TelemetryService } from '../common/telemetry-service';
19
- import { BrowserOnlyTelemetryService } from './browser-only-telemetry-service';
18
+ import { TelemetryService } from '../common/telemetry-service.js';
19
+ import { BrowserOnlyTelemetryService } from './browser-only-telemetry-service.js';
20
20
 
21
21
  export default new ContainerModule((bind, _unbind, isBound, rebind) => {
22
22
  bind(BrowserOnlyTelemetryService).toSelf().inSingletonScope();
@@ -14,9 +14,9 @@
14
14
  // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
15
  // *****************************************************************************
16
16
 
17
- export * from './telemetry-consent-provider';
18
- export * from './telemetry-preferences';
19
- export * from './telemetry-protocol';
20
- export * from './telemetry-service';
21
- export * from './telemetry-topic';
22
- export * from './telemetry-types';
17
+ export * from './telemetry-consent-provider.js';
18
+ export * from './telemetry-preferences.js';
19
+ export * from './telemetry-protocol.js';
20
+ export * from './telemetry-service.js';
21
+ export * from './telemetry-topic.js';
22
+ export * from './telemetry-types.js';
@@ -17,9 +17,9 @@
17
17
  import { expect } from 'chai';
18
18
  import { Emitter } from '@theia/core/lib/common';
19
19
  import { Container } from '@theia/core/shared/inversify';
20
- import { PreferenceTelemetryConsentProvider, TelemetryConsentProvider } from './telemetry-consent-provider';
21
- import { TELEMETRY_FILTERS, TELEMETRY_LEVEL, TelemetryPreferences } from './telemetry-preferences';
22
- import { TelemetryLevel } from './telemetry-types';
20
+ import { PreferenceTelemetryConsentProvider, TelemetryConsentProvider } from './telemetry-consent-provider.js';
21
+ import { TELEMETRY_FILTERS, TELEMETRY_LEVEL, TelemetryPreferences } from './telemetry-preferences.js';
22
+ import { TelemetryLevel } from './telemetry-types.js';
23
23
 
24
24
  describe('telemetry consent provider', () => {
25
25
 
@@ -17,8 +17,8 @@
17
17
  import { Emitter, Event } from '@theia/core/lib/common';
18
18
  import { Deferred } from '@theia/core/lib/common/promise-util';
19
19
  import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
20
- import { TELEMETRY_LEVEL, TelemetryPreferences } from './telemetry-preferences';
21
- import { TelemetryLevel } from './telemetry-types';
20
+ import { TELEMETRY_LEVEL, TelemetryPreferences } from './telemetry-preferences.js';
21
+ import { TelemetryLevel } from './telemetry-types.js';
22
22
 
23
23
  /** @experimental */
24
24
  export const TelemetryConsentProvider = Symbol('TelemetryConsentProvider');
@@ -20,7 +20,7 @@ import {
20
20
  TELEMETRY_FILTERS,
21
21
  TELEMETRY_LEVEL,
22
22
  TelemetryPreferenceSchema
23
- } from './telemetry-preferences';
23
+ } from './telemetry-preferences.js';
24
24
 
25
25
  describe('telemetry preferences', () => {
26
26
  it('defines only the level and filters preference keys', () => {
@@ -20,7 +20,7 @@ import { createPreferenceProxy, PreferenceProxy } from '@theia/core/lib/common/p
20
20
  import { PreferenceContribution, PreferenceSchema } from '@theia/core/lib/common/preferences/preference-schema';
21
21
  import { PreferenceService } from '@theia/core/lib/common/preferences/preference-service';
22
22
  import { interfaces } from '@theia/core/shared/inversify';
23
- import { TelemetryLevel } from './telemetry-types';
23
+ import { TelemetryLevel } from './telemetry-types.js';
24
24
 
25
25
  /** @experimental */
26
26
  export const TELEMETRY_LEVEL = 'telemetry.telemetryLevel';
@@ -0,0 +1,36 @@
1
+ // *****************************************************************************
2
+ // Copyright (C) 2026 STMicroelectronics and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { expect } from 'chai';
18
+ import { isValidTelemetryEvent } from './telemetry-protocol.js';
19
+
20
+ describe('telemetry protocol', () => {
21
+ it('validates event kind, attributes, and session', () => {
22
+ const event = {
23
+ topic: 'consumer/action',
24
+ kind: 'error' as const,
25
+ data: { action: 'open', duration: 12 },
26
+ attributes: { source: 'consumer' },
27
+ session: 'frontend-session',
28
+ timestamp: 42
29
+ };
30
+
31
+ expect(isValidTelemetryEvent(event)).to.be.true;
32
+ expect(isValidTelemetryEvent({ ...event, kind: 'invalid' })).to.be.false;
33
+ expect(isValidTelemetryEvent({ ...event, session: '' })).to.be.false;
34
+ expect(isValidTelemetryEvent({ ...event, attributes: { nested: {} } })).to.be.false;
35
+ });
36
+ });
@@ -15,9 +15,10 @@
15
15
  // *****************************************************************************
16
16
 
17
17
  import { isObject } from '@theia/core/lib/common/types';
18
- import { TelemetryData, TelemetryReportOptions, TelemetryValue, isTelemetryData, snapshotTelemetryData } from './telemetry-service';
19
- import { isValidTelemetryTopic } from './telemetry-topic';
20
- import { TelemetryEventKind, isTelemetryEventKind } from './telemetry-types';
18
+ import { isValidTelemetryTopic } from './telemetry-topic.js';
19
+ import {
20
+ TelemetryData, TelemetryEventKind, TelemetryReportOptions, TelemetryValue, isTelemetryData, isTelemetryEventKind, snapshotTelemetryData
21
+ } from './telemetry-types.js';
21
22
 
22
23
  /** @experimental */
23
24
  export interface TelemetryEvent<T extends object = Record<string, TelemetryValue>> {
@@ -15,9 +15,8 @@
15
15
  // *****************************************************************************
16
16
 
17
17
  import { expect } from 'chai';
18
- import URI from '@theia/core/lib/common/uri';
19
- import { isValidTelemetryEvent } from './telemetry-protocol';
20
- import { TelemetryData, TelemetryService, isTelemetryData, snapshotTelemetryData } from './telemetry-service';
18
+ import { TelemetryService } from './telemetry-service.js';
19
+ import { TelemetryData } from './telemetry-types.js';
21
20
 
22
21
  interface ConsumerPayload {
23
22
  action: string;
@@ -46,103 +45,4 @@ describe('telemetry service contract', () => {
46
45
  it('supports consumer-defined payload interfaces without an index signature', () => {
47
46
  expect(compileTimeUsage).to.be.a('function');
48
47
  });
49
-
50
- it('validates event kind, attributes, and session', () => {
51
- const event = {
52
- topic: 'consumer/action',
53
- kind: 'error' as const,
54
- data: typedPayload,
55
- attributes: { source: 'consumer' },
56
- session: 'frontend-session',
57
- timestamp: 42
58
- };
59
-
60
- expect(isValidTelemetryEvent(event)).to.be.true;
61
- expect(isValidTelemetryEvent({ ...event, kind: 'invalid' })).to.be.false;
62
- expect(isValidTelemetryEvent({ ...event, session: '' })).to.be.false;
63
- expect(isValidTelemetryEvent({ ...event, attributes: { nested: {} } })).to.be.false;
64
- });
65
-
66
- it('accepts plain flat payloads with primitive telemetry values', () => {
67
- expect(isTelemetryData(typedPayload)).to.be.true;
68
- expect(isTelemetryData({})).to.be.true;
69
- });
70
-
71
- it('accepts homogeneous primitive and empty arrays unchanged', () => {
72
- const strings = ['editor', 'open'];
73
- const numbers = [4, 8];
74
- const booleans = [true, false];
75
- const empty: string[] = [];
76
- const data = { strings, numbers, booleans, empty };
77
-
78
- expect(isTelemetryData(data)).to.be.true;
79
- expect(data.strings).to.equal(strings);
80
- expect(data.numbers).to.equal(numbers);
81
- expect(data.booleans).to.equal(booleans);
82
- expect(data.empty).to.equal(empty);
83
- });
84
-
85
- it('creates immutable snapshots without transforming accepted values', () => {
86
- const strings = ['editor', 'open'];
87
- const data = { action: 'open', duration: 12, successful: true, strings };
88
-
89
- const snapshot = snapshotTelemetryData(data);
90
-
91
- expect(snapshot).to.deep.equal(data);
92
- expect(snapshot).not.to.equal(data);
93
- expect(snapshot?.strings).not.to.equal(strings);
94
- expect(Object.isFrozen(snapshot)).to.be.true;
95
- expect(Object.isFrozen(snapshot?.strings)).to.be.true;
96
- expect(snapshotTelemetryData(undefined)).to.be.undefined;
97
- });
98
-
99
- it('rejects non-object payloads', () => {
100
- for (const value of [undefined, 'value', 1, true]) {
101
- expect(isTelemetryData(value)).to.be.false;
102
- }
103
- // eslint-disable-next-line no-null/no-null
104
- expect(isTelemetryData(null)).to.be.false;
105
- });
106
-
107
- it('rejects top-level arrays and nested objects', () => {
108
- expect(isTelemetryData([])).to.be.false;
109
- expect(isTelemetryData({ value: { nested: true } })).to.be.false;
110
- });
111
-
112
- it('rejects mixed, nested, and sparse arrays', () => {
113
- const sparse = new Array<string>(2);
114
- sparse[1] = 'value';
115
-
116
- expect(isTelemetryData({ value: ['value', 1] })).to.be.false;
117
- expect(isTelemetryData({ value: [['nested']] })).to.be.false;
118
- expect(isTelemetryData({ value: sparse })).to.be.false;
119
- });
120
-
121
- it('rejects unsupported array elements', () => {
122
- expect(isTelemetryData({ value: [{ nested: true }] })).to.be.false;
123
- expect(isTelemetryData({ value: ['value', undefined] })).to.be.false;
124
- expect(isTelemetryData({ value: ['value', () => 'value'] })).to.be.false;
125
- expect(isTelemetryData({ value: ['value', Symbol('value')] })).to.be.false;
126
- expect(isTelemetryData({ value: new Uint8Array([1, 2]) })).to.be.false;
127
- });
128
-
129
- it('rejects special and binary objects', () => {
130
- expect(isTelemetryData(new Error('failure'))).to.be.false;
131
- expect(isTelemetryData(new Date())).to.be.false;
132
- expect(isTelemetryData(new URI('file:///workspace'))).to.be.false;
133
- expect(isTelemetryData(new Uint8Array([1, 2]))).to.be.false;
134
- });
135
-
136
- it('rejects class instances even when their properties are flat', () => {
137
- class Payload {
138
- value = 'value';
139
- }
140
- expect(isTelemetryData(new Payload())).to.be.false;
141
- });
142
-
143
- it('rejects unsupported values in otherwise plain payloads', () => {
144
- expect(isTelemetryData({ value: undefined })).to.be.false;
145
- expect(isTelemetryData({ value: () => 'value' })).to.be.false;
146
- expect(isTelemetryData({ value: Symbol('value') })).to.be.false;
147
- });
148
48
  });
@@ -14,65 +14,7 @@
14
14
  // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
15
  // *****************************************************************************
16
16
 
17
- import { deepClone, deepFreeze } from '@theia/core/lib/common/objects';
18
- import { isObject } from '@theia/core/lib/common/types';
19
- import { TelemetryEventKind } from './telemetry-types';
20
-
21
- /** @experimental */
22
- export type TelemetryPrimitive = string | number | boolean;
23
- /** @experimental */
24
- export type TelemetryValue = TelemetryPrimitive | readonly string[] | readonly number[] | readonly boolean[];
25
-
26
- /** @experimental */
27
- export type TelemetryData<T extends object> = {
28
- [K in keyof T]: T[K] extends TelemetryValue ? T[K] : never;
29
- };
30
-
31
- function isTelemetryPrimitive(value: unknown): value is TelemetryPrimitive {
32
- return typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean';
33
- }
34
-
35
- function isTelemetryArray(value: unknown): value is readonly TelemetryPrimitive[] {
36
- if (!Array.isArray(value)) {
37
- return false;
38
- }
39
- if (value.length === 0) {
40
- return true;
41
- }
42
- if (!Object.prototype.hasOwnProperty.call(value, 0) || !isTelemetryPrimitive(value[0])) {
43
- return false;
44
- }
45
- const elementType = typeof value[0];
46
- for (let index = 1; index < value.length; index++) {
47
- if (!Object.prototype.hasOwnProperty.call(value, index) || !isTelemetryPrimitive(value[index]) || typeof value[index] !== elementType) {
48
- return false;
49
- }
50
- }
51
- return true;
52
- }
53
-
54
- function isTelemetryValue(value: unknown): value is TelemetryValue {
55
- return isTelemetryPrimitive(value) || isTelemetryArray(value);
56
- }
57
-
58
- /** @experimental */
59
- export function isTelemetryData(data: unknown): data is Record<string, TelemetryValue> {
60
- if (!isObject(data) || Array.isArray(data) || Object.getPrototypeOf(data) !== Object.prototype) {
61
- return false;
62
- }
63
- return Object.values(data).every(isTelemetryValue);
64
- }
65
-
66
- /** @experimental */
67
- export function snapshotTelemetryData<T extends object>(data: TelemetryData<T> | undefined): TelemetryData<T> | undefined {
68
- return data === undefined ? undefined : deepFreeze(deepClone(data));
69
- }
70
-
71
- /** @experimental */
72
- export interface TelemetryReportOptions {
73
- readonly kind?: TelemetryEventKind;
74
- readonly attributes?: TelemetryData<Record<string, TelemetryValue>>;
75
- }
17
+ import { TelemetryData, TelemetryReportOptions } from './telemetry-types.js';
76
18
 
77
19
  /** @experimental */
78
20
  export const TelemetryService = Symbol('TelemetryService');
@@ -20,7 +20,7 @@ import {
20
20
  isValidTelemetryTopic,
21
21
  isValidTelemetryTopicPattern,
22
22
  matchesTelemetryTopic
23
- } from './telemetry-topic';
23
+ } from './telemetry-topic.js';
24
24
 
25
25
  describe('telemetry topic contract', () => {
26
26
  const validNames = ['company/metric', 'Company/Metric', 'company/product/metric', 'company-1/metric_2', 'company.name/metric'];
@@ -14,8 +14,18 @@
14
14
  // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
15
  // *****************************************************************************
16
16
 
17
+ import URI from '@theia/core/lib/common/uri';
17
18
  import { expect } from 'chai';
18
- import { TelemetryLevel, isKindAllowedByLevel, isTelemetryEventKind } from './telemetry-types';
19
+ import { TelemetryLevel, isKindAllowedByLevel, isTelemetryData, isTelemetryEventKind, snapshotTelemetryData } from './telemetry-types.js';
20
+
21
+ const typedPayload = {
22
+ action: 'open',
23
+ duration: 12,
24
+ successful: true,
25
+ tags: ['editor', 'open'],
26
+ measurements: [4, 8],
27
+ states: [true, false]
28
+ };
19
29
 
20
30
  describe('telemetry types', () => {
21
31
  it('validates telemetry event kinds', () => {
@@ -23,6 +33,89 @@ describe('telemetry types', () => {
23
33
  expect(isTelemetryEventKind('invalid')).to.be.false;
24
34
  });
25
35
 
36
+ it('accepts plain flat payloads with primitive telemetry values', () => {
37
+ expect(isTelemetryData(typedPayload)).to.be.true;
38
+ expect(isTelemetryData({})).to.be.true;
39
+ });
40
+
41
+ it('accepts homogeneous primitive and empty arrays unchanged', () => {
42
+ const strings = ['editor', 'open'];
43
+ const numbers = [4, 8];
44
+ const booleans = [true, false];
45
+ const empty: string[] = [];
46
+ const data = { strings, numbers, booleans, empty };
47
+
48
+ expect(isTelemetryData(data)).to.be.true;
49
+ expect(data.strings).to.equal(strings);
50
+ expect(data.numbers).to.equal(numbers);
51
+ expect(data.booleans).to.equal(booleans);
52
+ expect(data.empty).to.equal(empty);
53
+ });
54
+
55
+ it('creates immutable snapshots without transforming accepted values', () => {
56
+ const strings = ['editor', 'open'];
57
+ const data = { action: 'open', duration: 12, successful: true, strings };
58
+
59
+ const snapshot = snapshotTelemetryData(data);
60
+
61
+ expect(snapshot).to.deep.equal(data);
62
+ expect(snapshot).not.to.equal(data);
63
+ expect(snapshot?.strings).not.to.equal(strings);
64
+ expect(Object.isFrozen(snapshot)).to.be.true;
65
+ expect(Object.isFrozen(snapshot?.strings)).to.be.true;
66
+ expect(snapshotTelemetryData(undefined)).to.be.undefined;
67
+ });
68
+
69
+ it('rejects non-object payloads', () => {
70
+ for (const value of [undefined, 'value', 1, true]) {
71
+ expect(isTelemetryData(value)).to.be.false;
72
+ }
73
+ // eslint-disable-next-line no-null/no-null
74
+ expect(isTelemetryData(null)).to.be.false;
75
+ });
76
+
77
+ it('rejects top-level arrays and nested objects', () => {
78
+ expect(isTelemetryData([])).to.be.false;
79
+ expect(isTelemetryData({ value: { nested: true } })).to.be.false;
80
+ });
81
+
82
+ it('rejects mixed, nested, and sparse arrays', () => {
83
+ const sparse = new Array<string>(2);
84
+ sparse[1] = 'value';
85
+
86
+ expect(isTelemetryData({ value: ['value', 1] })).to.be.false;
87
+ expect(isTelemetryData({ value: [['nested']] })).to.be.false;
88
+ expect(isTelemetryData({ value: sparse })).to.be.false;
89
+ });
90
+
91
+ it('rejects unsupported array elements', () => {
92
+ expect(isTelemetryData({ value: [{ nested: true }] })).to.be.false;
93
+ expect(isTelemetryData({ value: ['value', undefined] })).to.be.false;
94
+ expect(isTelemetryData({ value: ['value', () => 'value'] })).to.be.false;
95
+ expect(isTelemetryData({ value: ['value', Symbol('value')] })).to.be.false;
96
+ expect(isTelemetryData({ value: new Uint8Array([1, 2]) })).to.be.false;
97
+ });
98
+
99
+ it('rejects special and binary objects', () => {
100
+ expect(isTelemetryData(new Error('failure'))).to.be.false;
101
+ expect(isTelemetryData(new Date())).to.be.false;
102
+ expect(isTelemetryData(new URI('file:///workspace'))).to.be.false;
103
+ expect(isTelemetryData(new Uint8Array([1, 2]))).to.be.false;
104
+ });
105
+
106
+ it('rejects class instances even when their properties are flat', () => {
107
+ class Payload {
108
+ value = 'value';
109
+ }
110
+ expect(isTelemetryData(new Payload())).to.be.false;
111
+ });
112
+
113
+ it('rejects unsupported values in otherwise plain payloads', () => {
114
+ expect(isTelemetryData({ value: undefined })).to.be.false;
115
+ expect(isTelemetryData({ value: () => 'value' })).to.be.false;
116
+ expect(isTelemetryData({ value: Symbol('value') })).to.be.false;
117
+ });
118
+
26
119
  it('maps telemetry levels to event kinds', () => {
27
120
  const kinds = ['usage', 'error', 'crash'] as const;
28
121
  const levels: TelemetryLevel[] = ['off', 'crash', 'error', 'all'];
@@ -14,6 +14,9 @@
14
14
  // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
15
  // *****************************************************************************
16
16
 
17
+ import { deepClone, deepFreeze } from '@theia/core/lib/common/objects';
18
+ import { isObject } from '@theia/core/lib/common/types';
19
+
17
20
  /** @experimental */
18
21
  export type TelemetryEventKind = 'usage' | 'error' | 'crash';
19
22
 
@@ -34,3 +37,59 @@ export function isKindAllowedByLevel(level: TelemetryLevel, kind: TelemetryEvent
34
37
 
35
38
  /** @experimental */
36
39
  export const BACKEND_TELEMETRY_SESSION = 'backend';
40
+
41
+ /** @experimental */
42
+ export type TelemetryPrimitive = string | number | boolean;
43
+ /** @experimental */
44
+ export type TelemetryValue = TelemetryPrimitive | readonly string[] | readonly number[] | readonly boolean[];
45
+
46
+ /** @experimental */
47
+ export type TelemetryData<T extends object> = {
48
+ [K in keyof T]: T[K] extends TelemetryValue ? T[K] : never;
49
+ };
50
+
51
+ function isTelemetryPrimitive(value: unknown): value is TelemetryPrimitive {
52
+ return typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean';
53
+ }
54
+
55
+ function isTelemetryArray(value: unknown): value is readonly TelemetryPrimitive[] {
56
+ if (!Array.isArray(value)) {
57
+ return false;
58
+ }
59
+ if (value.length === 0) {
60
+ return true;
61
+ }
62
+ if (!Object.prototype.hasOwnProperty.call(value, 0) || !isTelemetryPrimitive(value[0])) {
63
+ return false;
64
+ }
65
+ const elementType = typeof value[0];
66
+ for (let index = 1; index < value.length; index++) {
67
+ if (!Object.prototype.hasOwnProperty.call(value, index) || !isTelemetryPrimitive(value[index]) || typeof value[index] !== elementType) {
68
+ return false;
69
+ }
70
+ }
71
+ return true;
72
+ }
73
+
74
+ function isTelemetryValue(value: unknown): value is TelemetryValue {
75
+ return isTelemetryPrimitive(value) || isTelemetryArray(value);
76
+ }
77
+
78
+ /** @experimental */
79
+ export function isTelemetryData(data: unknown): data is Record<string, TelemetryValue> {
80
+ if (!isObject(data) || Array.isArray(data) || Object.getPrototypeOf(data) !== Object.prototype) {
81
+ return false;
82
+ }
83
+ return Object.values(data).every(isTelemetryValue);
84
+ }
85
+
86
+ /** @experimental */
87
+ export function snapshotTelemetryData<T extends object>(data: TelemetryData<T> | undefined): TelemetryData<T> | undefined {
88
+ return data === undefined ? undefined : deepFreeze(deepClone(data));
89
+ }
90
+
91
+ /** @experimental */
92
+ export interface TelemetryReportOptions {
93
+ readonly kind?: TelemetryEventKind;
94
+ readonly attributes?: TelemetryData<Record<string, TelemetryValue>>;
95
+ }
package/src/node/index.ts CHANGED
@@ -14,5 +14,5 @@
14
14
  // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
15
  // *****************************************************************************
16
16
 
17
- export * from './telemetry-service-impl';
18
- export * from './telemetry-sink';
17
+ export * from './telemetry-service-impl.js';
18
+ export * from './telemetry-sink.js';
@@ -17,12 +17,12 @@
17
17
  import { bindRootContributionProvider, ConnectionHandler, RpcConnectionHandler } from '@theia/core/lib/common';
18
18
  import { BackendApplicationContribution } from '@theia/core/lib/node/backend-application';
19
19
  import { ContainerModule } from '@theia/core/shared/inversify';
20
- import { PreferenceTelemetryConsentProvider, TelemetryConsentProvider } from '../common/telemetry-consent-provider';
21
- import { bindTelemetryPreferences } from '../common/telemetry-preferences';
22
- import { telemetryServicePath, TelemetryRpc } from '../common/telemetry-protocol';
23
- import { TelemetryService } from '../common/telemetry-service';
24
- import { TelemetryServiceImpl } from './telemetry-service-impl';
25
- import { TelemetrySink } from './telemetry-sink';
20
+ import { PreferenceTelemetryConsentProvider, TelemetryConsentProvider } from '../common/telemetry-consent-provider.js';
21
+ import { bindTelemetryPreferences } from '../common/telemetry-preferences.js';
22
+ import { telemetryServicePath, TelemetryRpc } from '../common/telemetry-protocol.js';
23
+ import { TelemetryService } from '../common/telemetry-service.js';
24
+ import { TelemetryServiceImpl } from './telemetry-service-impl.js';
25
+ import { TelemetrySink } from './telemetry-sink.js';
26
26
 
27
27
  export default new ContainerModule(bind => {
28
28
  bindTelemetryPreferences(bind);
@@ -18,13 +18,13 @@ import { expect } from 'chai';
18
18
  import { ContributionProvider, Emitter, ILogger } from '@theia/core/lib/common';
19
19
  import * as sinon from 'sinon';
20
20
  import { Container } from '@theia/core/shared/inversify';
21
- import { TelemetryConsentProvider } from '../common/telemetry-consent-provider';
22
- import { TELEMETRY_FILTERS, TELEMETRY_LEVEL, TelemetryPreferences } from '../common/telemetry-preferences';
23
- import { TelemetryEvent } from '../common/telemetry-protocol';
24
- import { RecordingLogger } from '../common/test/recording-logger';
25
- import { TelemetryServiceImpl } from './telemetry-service-impl';
26
- import { BACKEND_TELEMETRY_SESSION, TelemetryLevel } from '../common/telemetry-types';
27
- import { TelemetrySink } from './telemetry-sink';
21
+ import { TelemetryConsentProvider } from '../common/telemetry-consent-provider.js';
22
+ import { TELEMETRY_FILTERS, TELEMETRY_LEVEL, TelemetryPreferences } from '../common/telemetry-preferences.js';
23
+ import { TelemetryEvent } from '../common/telemetry-protocol.js';
24
+ import { RecordingLogger } from '../common/test/recording-logger.js';
25
+ import { TelemetryServiceImpl } from './telemetry-service-impl.js';
26
+ import { BACKEND_TELEMETRY_SESSION, TelemetryLevel } from '../common/telemetry-types.js';
27
+ import { TelemetrySink } from './telemetry-sink.js';
28
28
 
29
29
  interface TestPreferences extends TelemetryPreferences {
30
30
  setFilters(filters: Record<string, string[]>): void;