Allow disabling agent telemetry dynamically

roblourens · roblourens · commit 5c538569e67e · 2019-04-12T23:07:27.000Z
diff --git a/src/vs/editor/standalone/browser/simpleServices.ts b/src/vs/editor/standalone/browser/simpleServices.ts
@@ -496,6 +496,9 @@ export class StandaloneTelemetryService implements ITelemetryService {
 
 	public isOptedIn = false;
 
+	public setEnabled(value: boolean): void {
+	}
+
 	public publicLog(eventName: string, data?: any): Promise<void> {
 		return Promise.resolve(undefined);
 	}
diff --git a/src/vs/platform/telemetry/common/telemetry.ts b/src/vs/platform/telemetry/common/telemetry.ts
@@ -29,6 +29,8 @@ export interface ITelemetryService {
 	 */
 	publicLog(eventName: string, data?: ITelemetryData, anonymizeFilePaths?: boolean): Promise<void>;
 
+	setEnabled(value: boolean): void;
+
 	getTelemetryInfo(): Promise<ITelemetryInfo>;
 
 	isOptedIn: boolean;
diff --git a/src/vs/platform/telemetry/common/telemetryService.ts b/src/vs/platform/telemetry/common/telemetryService.ts
@@ -31,6 +31,7 @@ export class TelemetryService implements ITelemetryService {
 	private _commonProperties: Promise<{ [name: string]: any; }>;
 	private _piiPaths: string[];
 	private _userOptIn: boolean;
+	private _enabled: boolean;
 
 	private _disposables: IDisposable[] = [];
 	private _cleanupPatterns: RegExp[] = [];
@@ -43,6 +44,7 @@ export class TelemetryService implements ITelemetryService {
 		this._commonProperties = config.commonProperties || Promise.resolve({});
 		this._piiPaths = config.piiPaths || [];
 		this._userOptIn = true;
+		this._enabled = true;
 
 		// static cleanup pattern for: `file:///DANGEROUS/PATH/resources/app/Useful/Information`
 		this._cleanupPatterns = [/file:\/\/\/.*?\/resources\/app\//gi];
@@ -74,13 +76,17 @@ export class TelemetryService implements ITelemetryService {
 		}
 	}
 
+	setEnabled(value: boolean): void {
+		this._enabled = value;
+	}
+
 	private _updateUserOptIn(): void {
 		const config = this._configurationService.getValue<any>(TELEMETRY_SECTION_ID);
 		this._userOptIn = config ? config.enableTelemetry : this._userOptIn;
 	}
 
 	get isOptedIn(): boolean {
-		return this._userOptIn;
+		return this._userOptIn && this._enabled;
 	}
 
 	getTelemetryInfo(): Promise<ITelemetryInfo> {
@@ -100,7 +106,7 @@ export class TelemetryService implements ITelemetryService {
 
 	publicLog(eventName: string, data?: ITelemetryData, anonymizeFilePaths?: boolean): Promise<any> {
 		// don't send events when the user is optout
-		if (!this._userOptIn) {
+		if (!this.isOptedIn) {
 			return Promise.resolve(undefined);
 		}
 
diff --git a/src/vs/platform/telemetry/common/telemetryUtils.ts b/src/vs/platform/telemetry/common/telemetryUtils.ts
@@ -14,6 +14,7 @@ export const NullTelemetryService = new class implements ITelemetryService {
 	publicLog(eventName: string, data?: ITelemetryData) {
 		return Promise.resolve(undefined);
 	}
+	setEnabled() { }
 	isOptedIn: true;
 	getTelemetryInfo(): Promise<ITelemetryInfo> {
 		return Promise.resolve({
diff --git a/src/vs/workbench/browser/nodeless.simpleservices.ts b/src/vs/workbench/browser/nodeless.simpleservices.ts
@@ -821,6 +821,9 @@ export class SimpleTelemetryService implements ITelemetryService {
 		return Promise.resolve(undefined);
 	}
 
+	setEnabled(value: boolean): void {
+	}
+
 	getTelemetryInfo(): Promise<ITelemetryInfo> {
 		return Promise.resolve({
 			instanceId: 'someValue.instanceId',
diff --git a/src/vs/workbench/services/remote/common/abstractRemoteAgentService.ts b/src/vs/workbench/services/remote/common/abstractRemoteAgentService.ts
@@ -56,6 +56,16 @@ export abstract class AbstractRemoteAgentService extends Disposable implements I
 
 		return Promise.resolve(undefined);
 	}
+
+	disableTelemetry(): Promise<void> {
+		const connection = this.getConnection();
+		if (connection) {
+			const client = new RemoteExtensionEnvironmentChannelClient(connection.getChannel('remoteextensionsenvironment'));
+			return client.disableTelemetry();
+		}
+
+		return Promise.resolve(undefined);
+	}
 }
 
 export class RemoteAgentConnection extends Disposable implements IRemoteAgentConnection {
diff --git a/src/vs/workbench/services/remote/common/remoteAgentEnvironmentChannel.ts b/src/vs/workbench/services/remote/common/remoteAgentEnvironmentChannel.ts
@@ -61,4 +61,8 @@ export class RemoteExtensionEnvironmentChannelClient {
 	getDiagnosticInfo(options: IDiagnosticInfoOptions): Promise<IDiagnosticInfo> {
 		return this.channel.call<IDiagnosticInfo>('getDiagnosticInfo', options);
 	}
+
+	disableTelemetry(): Promise<void> {
+		return this.channel.call<void>('disableTelemetry');
+	}
 }
diff --git a/src/vs/workbench/services/remote/common/remoteAgentService.ts b/src/vs/workbench/services/remote/common/remoteAgentService.ts
@@ -19,6 +19,7 @@ export interface IRemoteAgentService {
 	getConnection(): IRemoteAgentConnection | null;
 	getEnvironment(bail?: boolean): Promise<IRemoteAgentEnvironment | null>;
 	getDiagnosticInfo(options: IDiagnosticInfoOptions): Promise<IDiagnosticInfo | undefined>;
+	disableTelemetry(): Promise<void>;
 }
 
 export interface IRemoteAgentConnection {
diff --git a/src/vs/workbench/services/telemetry/electron-browser/telemetryService.ts b/src/vs/workbench/services/telemetry/electron-browser/telemetryService.ts
@@ -47,6 +47,10 @@ export class TelemetryService extends Disposable implements ITelemetryService {
 		}
 	}
 
+	setEnabled(value: boolean): void {
+		return this.impl.setEnabled(value);
+	}
+
 	get isOptedIn(): boolean {
 		return this.impl.isOptedIn;
 	}
diff --git a/src/vs/workbench/test/electron-browser/quickopen.perf.integrationTest.ts b/src/vs/workbench/test/electron-browser/quickopen.perf.integrationTest.ts
@@ -164,6 +164,9 @@ class TestTelemetryService implements ITelemetryService {
 
 	public events: any[] = [];
 
+	public setEnabled(value: boolean): void {
+	}
+
 	public publicLog(eventName: string, data?: any): Promise<void> {
 		this.events.push({ name: eventName, data: data });
 		return Promise.resolve(undefined);
diff --git a/src/vs/workbench/test/electron-browser/textsearch.perf.integrationTest.ts b/src/vs/workbench/test/electron-browser/textsearch.perf.integrationTest.ts
@@ -155,6 +155,9 @@ class TestTelemetryService implements ITelemetryService {
 		return this.emitter.event;
 	}
 
+	public setEnabled(value: boolean): void {
+	}
+
 	public publicLog(eventName: string, data?: any): Promise<void> {
 		const event = { name: eventName, data: data };
 		this.events.push(event);

Original file line number	Diff line number	Diff line change
`@@ -496,6 +496,9 @@ export class StandaloneTelemetryService implements ITelemetryService {`
`496`	`496`
`497`	`497`	`public isOptedIn = false;`
`498`	`498`
	`499`	`+ public setEnabled(value: boolean): void {`
	`500`	`+ }`
	`501`	`+`
`499`	`502`	`public publicLog(eventName: string, data?: any): Promise<void> {`
`500`	`503`	`return Promise.resolve(undefined);`
`501`	`504`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ export const NullTelemetryService = new class implements ITelemetryService {`
`14`	`14`	`publicLog(eventName: string, data?: ITelemetryData) {`
`15`	`15`	`return Promise.resolve(undefined);`
`16`	`16`	`}`
	`17`	`+ setEnabled() { }`
`17`	`18`	`isOptedIn: true;`
`18`	`19`	`getTelemetryInfo(): Promise<ITelemetryInfo> {`
`19`	`20`	`return Promise.resolve({`
Original file line number	Diff line number	Diff line change
`@@ -821,6 +821,9 @@ export class SimpleTelemetryService implements ITelemetryService {`
`821`	`821`	`return Promise.resolve(undefined);`
`822`	`822`	`}`
`823`	`823`
	`824`	`+ setEnabled(value: boolean): void {`
	`825`	`+ }`
	`826`	`+`
`824`	`827`	`getTelemetryInfo(): Promise<ITelemetryInfo> {`
`825`	`828`	`return Promise.resolve({`
`826`	`829`	`instanceId: 'someValue.instanceId',`
Original file line number	Diff line number	Diff line change
`@@ -61,4 +61,8 @@ export class RemoteExtensionEnvironmentChannelClient {`
`61`	`61`	`getDiagnosticInfo(options: IDiagnosticInfoOptions): Promise<IDiagnosticInfo> {`
`62`	`62`	`return this.channel.call<IDiagnosticInfo>('getDiagnosticInfo', options);`
`63`	`63`	`}`
	`64`	`+`
	`65`	`+ disableTelemetry(): Promise<void> {`
	`66`	`+ return this.channel.call<void>('disableTelemetry');`
	`67`	`+ }`
`64`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ export interface IRemoteAgentService {`
`19`	`19`	`getConnection(): IRemoteAgentConnection \| null;`
`20`	`20`	`getEnvironment(bail?: boolean): Promise<IRemoteAgentEnvironment \| null>;`
`21`	`21`	`getDiagnosticInfo(options: IDiagnosticInfoOptions): Promise<IDiagnosticInfo \| undefined>;`
	`22`	`+ disableTelemetry(): Promise<void>;`
`22`	`23`	`}`
`23`	`24`
`24`	`25`	`export interface IRemoteAgentConnection {`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,10 @@ export class TelemetryService extends Disposable implements ITelemetryService {`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
	`50`	`+ setEnabled(value: boolean): void {`
	`51`	`+ return this.impl.setEnabled(value);`
	`52`	`+ }`
	`53`	`+`
`50`	`54`	`get isOptedIn(): boolean {`
`51`	`55`	`return this.impl.isOptedIn;`
`52`	`56`	`}`