@codingame/monaco-vscode-telemetry-service-override 24.2.0 → 25.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codingame/monaco-vscode-telemetry-service-override",
-  "version": "24.2.0",
+  "version": "25.0.0",
   "private": false,
   "description": "VSCode public API plugged on the monaco editor - telemetry service-override",
   "keywords": [],
@@ -15,7 +15,7 @@
   },
   "type": "module",
   "dependencies": {
-    "@codingame/monaco-vscode-api": "24.2.0",
+    "@codingame/monaco-vscode-api": "25.0.0",
     "@microsoft/1ds-core-js": "3.2.18",
     "@microsoft/1ds-post-js": "3.2.18"
   },

package/vscode/src/vs/platform/telemetry/common/telemetryLogAppender.js

@@ -20,7 +20,7 @@ let TelemetryLogAppender = class TelemetryLogAppender extends Disposable {
             const justLoggingAndNotSending = isLoggingOnly(productService, environmentService);
             const logSuffix = justLoggingAndNotSending ? ' (Not Sent)' : '';
             this.logger = this._register(loggerService.createLogger(id, {
-                name: ( localize(2055, "Telemetry{0}", logSuffix)),
+                name: ( localize(2062, "Telemetry{0}", logSuffix)),
                 group: TelemetryLogGroup,
                 hidden: true
             }));

package/vscode/src/vs/platform/telemetry/common/telemetryService.d.ts

@@ -9,12 +9,19 @@ export interface ITelemetryServiceConfig {
     sendErrorTelemetry?: boolean;
     commonProperties?: ICommonProperties;
     piiPaths?: string[];
+    /**
+     * If true, telemetry events will be buffered until setExperimentProperty is called
+     * (up to 10 seconds) to ensure experiment context is attached to all events.
+     */
+    waitForExperimentProperties?: boolean;
 }
 export declare class TelemetryService implements ITelemetryService {
     private _configurationService;
     private _productService;
     static readonly IDLE_START_EVENT_NAME = "UserIdleStart";
     static readonly IDLE_STOP_EVENT_NAME = "UserIdleStop";
+    private static readonly BUFFER_FLUSH_TIMEOUT;
+    private static readonly MAX_BUFFER_SIZE;
     readonly _serviceBrand: undefined;
     readonly sessionId: string;
     readonly machineId: string;
@@ -28,15 +35,20 @@ export declare class TelemetryService implements ITelemetryService {
     private _piiPaths;
     private _telemetryLevel;
     private _sendErrorTelemetry;
+    private _pendingEvents;
+    private _isExperimentPropertySet;
+    private _flushTimeout;
     private readonly _disposables;
     private _cleanupPatterns;
     constructor(config: ITelemetryServiceConfig, _configurationService: IConfigurationService, _productService: IProductService);
     setExperimentProperty(name: string, value: string): void;
+    private _flushPendingEvents;
     private _updateTelemetryLevel;
     get sendErrorTelemetry(): boolean;
     get telemetryLevel(): TelemetryLevel;
     dispose(): void;
     private _log;
+    private _doLog;
     publicLog(eventName: string, data?: ITelemetryData): void;
     publicLog2<E extends ClassifiedEvent<OmitMetadata<T>> = never, T extends IGDPRProperty = never>(eventName: string, data?: StrictPropertyCheck<T, E>): void;
     publicLogError(errorEventName: string, data?: ITelemetryData): void;

package/vscode/src/vs/platform/telemetry/common/telemetryService.js

@@ -14,13 +14,19 @@ import { Registry } from '@codingame/monaco-vscode-api/vscode/vs/platform/regist
 import { TelemetryLevel, TELEMETRY_SETTING_ID, TELEMETRY_OLD_SETTING_ID, TELEMETRY_CRASH_REPORTER_SETTING_ID, TelemetryConfiguration, TELEMETRY_SECTION_ID } from '@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetry';
 import { getTelemetryLevel, cleanData } from '@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetryUtils';
 
+var TelemetryService_1;
 let TelemetryService = class TelemetryService {
+    static { TelemetryService_1 = this; }
     static { this.IDLE_START_EVENT_NAME = 'UserIdleStart'; }
     static { this.IDLE_STOP_EVENT_NAME = 'UserIdleStop'; }
+    static { this.BUFFER_FLUSH_TIMEOUT = 10000; }
+    static { this.MAX_BUFFER_SIZE = 1000; }
     constructor(config, _configurationService, _productService) {
         this._configurationService = _configurationService;
         this._productService = _productService;
         this._experimentProperties = {};
+        this._pendingEvents = [];
+        this._isExperimentPropertySet = false;
         this._disposables = ( new DisposableStore());
         this._cleanupPatterns = [];
         this._appenders = config.appenders;
@@ -50,9 +56,32 @@ let TelemetryService = class TelemetryService {
                 this._updateTelemetryLevel();
             }
         }));
+        if (config.waitForExperimentProperties) {
+            this._flushTimeout = setTimeout(() => this._flushPendingEvents(), TelemetryService_1.BUFFER_FLUSH_TIMEOUT);
+        }
+        else {
+            this._isExperimentPropertySet = true;
+        }
     }
     setExperimentProperty(name, value) {
         this._experimentProperties[name] = value;
+        if (!this._isExperimentPropertySet) {
+            this._flushPendingEvents();
+        }
+    }
+    _flushPendingEvents() {
+        if (this._isExperimentPropertySet) {
+            return;
+        }
+        this._isExperimentPropertySet = true;
+        if (this._flushTimeout !== undefined) {
+            clearTimeout(this._flushTimeout);
+            this._flushTimeout = undefined;
+        }
+        for (const event of this._pendingEvents) {
+            this._doLog(event.eventName, event.eventLevel, event.data);
+        }
+        this._pendingEvents = [];
     }
     _updateTelemetryLevel() {
         let level = getTelemetryLevel(this._configurationService);
@@ -71,12 +100,22 @@ let TelemetryService = class TelemetryService {
         return this._telemetryLevel;
     }
     dispose() {
+        this._flushPendingEvents();
         this._disposables.dispose();
     }
     _log(eventName, eventLevel, data) {
         if (this._telemetryLevel < eventLevel) {
             return;
         }
+        if (!this._isExperimentPropertySet) {
+            if (this._pendingEvents.length < TelemetryService_1.MAX_BUFFER_SIZE) {
+                this._pendingEvents.push({ eventName, eventLevel, data });
+            }
+            return;
+        }
+        this._doLog(eventName, eventLevel, data);
+    }
+    _doLog(eventName, eventLevel, data) {
         data = mixin(data, this._experimentProperties);
         data = cleanData(data, this._cleanupPatterns);
         data = mixin(data, this._commonProperties);
@@ -98,36 +137,36 @@ let TelemetryService = class TelemetryService {
         this.publicLogError(eventName, data);
     }
 };
-TelemetryService = ( __decorate([
+TelemetryService = TelemetryService_1 = ( __decorate([
     ( __param(1, IConfigurationService)),
     ( __param(2, IProductService))
 ], TelemetryService));
 function getTelemetryLevelSettingDescription() {
     const telemetryText = ( localize(
-        2056,
+        2063,
         "Controls {0} telemetry, first-party extension telemetry, and participating third-party extension telemetry. Some third party extensions might not respect this setting. Consult the specific extension's documentation to be sure. Telemetry helps us better understand how {0} is performing, where improvements need to be made, and how features are being used.",
         product.nameLong
     ));
     const externalLinksStatement = !product.privacyStatementUrl ?
         ( localize(
-        2057,
+        2064,
         "Read more about the [data we collect]({0}).",
         'https://aka.ms/vscode-telemetry'
     )) :
         ( localize(
-        2058,
+        2065,
         "Read more about the [data we collect]({0}) and our [privacy statement]({1}).",
         'https://aka.ms/vscode-telemetry',
         product.privacyStatementUrl
     ));
     const restartString = !isWeb ? ( localize(
-        2059,
+        2066,
         'A full restart of the application is necessary for crash reporting changes to take effect.'
     )) : '';
-    const crashReportsHeader = ( localize(2060, "Crash Reports"));
-    const errorsHeader = ( localize(2061, "Error Telemetry"));
-    const usageHeader = ( localize(2062, "Usage Data"));
-    const telemetryTableDescription = ( localize(2063, "The following table outlines the data sent with each setting:"));
+    const crashReportsHeader = ( localize(2067, "Crash Reports"));
+    const errorsHeader = ( localize(2068, "Error Telemetry"));
+    const usageHeader = ( localize(2069, "Usage Data"));
+    const telemetryTableDescription = ( localize(2070, "The following table outlines the data sent with each setting:"));
     const telemetryTable = `
 |       | ${crashReportsHeader} | ${errorsHeader} | ${usageHeader} |
 |:------|:-------------:|:---------------:|:----------:|
@@ -137,7 +176,7 @@ function getTelemetryLevelSettingDescription() {
 | off   |       -       |        -        |     -      |
 `;
     const deprecatedSettingNote = ( localize(
-        2064,
+        2071,
         "****Note:*** If this setting is 'off', no telemetry will be sent regardless of other telemetry settings. If this setting is set to anything except 'off' and telemetry is disabled with deprecated settings, no telemetry will be sent.*"
     ));
     const telemetryDescription = `
@@ -159,16 +198,16 @@ configurationRegistry.registerConfiguration({
     'id': TELEMETRY_SECTION_ID,
     'order': 1,
     'type': 'object',
-    'title': ( localize(2065, "Telemetry")),
+    'title': ( localize(2072, "Telemetry")),
     'properties': {
         [TELEMETRY_SETTING_ID]: {
             'type': 'string',
             'enum': [TelemetryConfiguration.ON, TelemetryConfiguration.ERROR, TelemetryConfiguration.CRASH, TelemetryConfiguration.OFF],
             'enumDescriptions': [
-                ( localize(2066, "Sends usage data, errors, and crash reports.")),
-                ( localize(2067, "Sends general error telemetry and crash reports.")),
-                ( localize(2068, "Sends OS level crash reports.")),
-                ( localize(2069, "Disables all product telemetry."))
+                ( localize(2073, "Sends usage data, errors, and crash reports.")),
+                ( localize(2074, "Sends general error telemetry and crash reports.")),
+                ( localize(2075, "Sends OS level crash reports.")),
+                ( localize(2076, "Disables all product telemetry."))
             ],
             'markdownDescription': getTelemetryLevelSettingDescription(),
             'default': TelemetryConfiguration.ON,
@@ -182,24 +221,24 @@ configurationRegistry.registerConfiguration({
                 localization: {
                     description: {
                         key: 'telemetry.telemetryLevel.policyDescription',
-                        value: ( localize(2070, "Controls the level of telemetry.")),
+                        value: ( localize(2077, "Controls the level of telemetry.")),
                     },
                     enumDescriptions: [
                         {
                             key: 'telemetry.telemetryLevel.default',
-                            value: ( localize(2066, "Sends usage data, errors, and crash reports.")),
+                            value: ( localize(2073, "Sends usage data, errors, and crash reports.")),
                         },
                         {
                             key: 'telemetry.telemetryLevel.error',
-                            value: ( localize(2067, "Sends general error telemetry and crash reports.")),
+                            value: ( localize(2074, "Sends general error telemetry and crash reports.")),
                         },
                         {
                             key: 'telemetry.telemetryLevel.crash',
-                            value: ( localize(2068, "Sends OS level crash reports.")),
+                            value: ( localize(2075, "Sends OS level crash reports.")),
                         },
                         {
                             key: 'telemetry.telemetryLevel.off',
-                            value: ( localize(2069, "Disables all product telemetry.")),
+                            value: ( localize(2076, "Disables all product telemetry.")),
                         }
                     ]
                 }
@@ -209,7 +248,7 @@ configurationRegistry.registerConfiguration({
             type: 'boolean',
             default: true,
             description: ( localize(
-                2071,
+                2078,
                 "Enable feedback mechanisms such as the issue reporter, surveys, and other feedback options."
             )),
             policy: {
@@ -217,7 +256,7 @@ configurationRegistry.registerConfiguration({
                 category: PolicyCategory.Telemetry,
                 minimumVersion: '1.99',
                 localization: { description: { key: 'telemetry.feedback.enabled', value: ( localize(
-                    2071,
+                    2078,
                     "Enable feedback mechanisms such as the issue reporter, surveys, and other feedback options."
                 )) } },
             }
@@ -226,12 +265,12 @@ configurationRegistry.registerConfiguration({
             'type': 'boolean',
             'markdownDescription': !product.privacyStatementUrl ?
                 ( localize(
-                2072,
+                2079,
                 "Enable diagnostic data to be collected. This helps us to better understand how {0} is performing and where improvements need to be made.",
                 product.nameLong
             )) :
                 ( localize(
-                2073,
+                2080,
                 "Enable diagnostic data to be collected. This helps us to better understand how {0} is performing and where improvements need to be made. [Read more]({1}) about what we collect and our privacy statement.",
                 product.nameLong,
                 product.privacyStatementUrl
@@ -239,7 +278,7 @@ configurationRegistry.registerConfiguration({
             'default': true,
             'restricted': true,
             'markdownDeprecationMessage': ( localize(
-                2074,
+                2081,
                 "If this setting is false, no telemetry will be sent regardless of the new setting's value. Deprecated in favor of the {0} setting.",
                 `\`#${TELEMETRY_SETTING_ID}#\``
             )),

package/vscode/src/vs/workbench/contrib/telemetry/browser/telemetry.contribution.js

@@ -138,7 +138,7 @@ let TelemetryContribution = class TelemetryContribution extends Disposable {
             constructor() {
                 super({
                     id: 'workbench.action.showTelemetry',
-                    title: ( localize2(11459, "Show Telemetry")),
+                    title: ( localize2(11489, "Show Telemetry")),
                     category: Categories.Developer,
                     f1: true
                 });

package/vscode/src/vs/workbench/services/telemetry/browser/telemetryService.js

@@ -15,6 +15,7 @@ import { NullTelemetryService, supportsTelemetry, getTelemetryLevel, isInternalT
 import { IBrowserWorkbenchEnvironmentService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/services/environment/browser/environmentService.service';
 import { IRemoteAgentService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/services/remote/common/remoteAgentService.service';
 import { resolveWorkbenchCommonProperties } from './workbenchCommonProperties.js';
+import { experimentsEnabled } from '../common/workbenchTelemetryUtils.js';
 
 let TelemetryService = class TelemetryService extends Disposable {
     get sessionId() { return this.impl.sessionId; }
@@ -54,8 +55,9 @@ let TelemetryService = class TelemetryService extends Disposable {
             appenders.push(( new TelemetryLogAppender('', false, loggerService, environmentService, productService)));
             const config = {
                 appenders,
-                commonProperties: resolveWorkbenchCommonProperties(storageService, productService.commit, productService.version, isInternal, environmentService.remoteAuthority, productService.embedderIdentifier, productService.removeTelemetryMachineId, environmentService.options && environmentService.options.resolveCommonTelemetryProperties),
+                commonProperties: resolveWorkbenchCommonProperties(storageService, productService, isInternal, environmentService.remoteAuthority, environmentService.options && environmentService.options.resolveCommonTelemetryProperties),
                 sendErrorTelemetry: this.sendErrorTelemetry,
+                waitForExperimentProperties: experimentsEnabled(configurationService, productService, environmentService),
             };
             return this._register(( new TelemetryService$1(config, configurationService, productService)));
         }

package/vscode/src/vs/workbench/services/telemetry/browser/workbenchCommonProperties.d.ts

@@ -1,5 +1,6 @@
 import { IStorageService } from "@codingame/monaco-vscode-api/vscode/vs/platform/storage/common/storage.service";
 import { ICommonProperties } from "@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetry";
-export declare function resolveWorkbenchCommonProperties(storageService: IStorageService, commit: string | undefined, version: string | undefined, isInternalTelemetry: boolean, remoteAuthority?: string, productIdentifier?: string, removeMachineId?: boolean, resolveAdditionalProperties?: () => {
+import { IProductService } from "@codingame/monaco-vscode-api/vscode/vs/platform/product/common/productService.service";
+export declare function resolveWorkbenchCommonProperties(storageService: IStorageService, productService: IProductService, isInternalTelemetry: boolean, remoteAuthority?: string, resolveAdditionalProperties?: () => {
     [key: string]: unknown;
 }): ICommonProperties;

package/vscode/src/vs/workbench/services/telemetry/browser/workbenchCommonProperties.js

@@ -10,7 +10,8 @@ import { Gesture } from '@codingame/monaco-vscode-api/vscode/vs/base/browser/tou
 function cleanUserAgent(userAgent) {
     return userAgent.replace(/(\d+\.\d+)(\.\d+)+/g, '$1');
 }
-function resolveWorkbenchCommonProperties(storageService, commit, version, isInternalTelemetry, remoteAuthority, productIdentifier, removeMachineId, resolveAdditionalProperties) {
+function resolveWorkbenchCommonProperties(storageService, productService, isInternalTelemetry, remoteAuthority, resolveAdditionalProperties) {
+    const { commit, version, embedderIdentifier: productIdentifier, removeTelemetryMachineId: removeMachineId } = productService ?? {};
     const result = Object.create(null);
     const firstSessionDate = storageService.get(firstSessionDateStorageKey, StorageScope.APPLICATION);
     const lastSessionDate = storageService.get(lastSessionDateStorageKey, StorageScope.APPLICATION);
@@ -28,7 +29,7 @@ function resolveWorkbenchCommonProperties(storageService, commit, version, isInt
     result['common.firstSessionDate'] = firstSessionDate;
     result['common.lastSessionDate'] = lastSessionDate || '';
     result['common.isNewSession'] = !lastSessionDate ? '1' : '0';
-    result['common.remoteAuthority'] = cleanRemoteAuthority(remoteAuthority);
+    result['common.remoteAuthority'] = cleanRemoteAuthority(remoteAuthority, productService);
     result['common.machineId'] = machineId;
     result['sessionID'] = generateUuid() + Date.now();
     result['commitHash'] = commit;

package/vscode/src/vs/workbench/services/telemetry/common/workbenchTelemetryUtils.d.ts

@@ -0,0 +1,8 @@
+import { IConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/configuration/common/configuration.service";
+import { IProductService } from "@codingame/monaco-vscode-api/vscode/vs/platform/product/common/productService.service";
+import { IWorkbenchEnvironmentService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/environment/common/environmentService.service";
+/**
+ * Determines if experiment properties will be set on telemetry events.
+ * When true, TelemetryService should buffer events until setExperimentProperty is called.
+ */
+export declare function experimentsEnabled(configurationService: IConfigurationService, productService: IProductService, environmentService: IWorkbenchEnvironmentService): boolean;

package/vscode/src/vs/workbench/services/telemetry/common/workbenchTelemetryUtils.js

@@ -0,0 +1,14 @@
+
+import { TelemetryLevel } from '@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetry';
+import { getTelemetryLevel } from '@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetryUtils';
+
+function experimentsEnabled(configurationService, productService, environmentService) {
+    return getTelemetryLevel(configurationService) === TelemetryLevel.USAGE &&
+        !!productService.tasConfig &&
+        !environmentService.disableExperiments &&
+        !environmentService.extensionTestsLocationURI &&
+        !environmentService.enableSmokeTestDriver &&
+        configurationService.getValue('workbench.enableExperiments') === true;
+}
+
+export { experimentsEnabled };