Make sure unknown search errors and cancellation is logged correctly

roblourens · roblourens · commit 24d1bbe8e898 · 2020-06-09T17:27:54.000-05:00
microsoft#99634
diff --git a/src/vs/workbench/services/search/common/search.ts b/src/vs/workbench/services/search/common/search.ts
@@ -18,6 +18,7 @@ import { Event } from 'vs/base/common/event';
 import { relative } from 'vs/base/common/path';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { ResourceGlobMatcher } from 'vs/workbench/common/resources';
+import { isPromiseCanceledError } from 'vs/base/common/errors';
 
 export const VIEWLET_ID = 'workbench.view.search';
 export const PANEL_ID = 'workbench.panel.search';
@@ -422,7 +423,8 @@ export enum SearchErrorCode {
 	globParseError,
 	invalidLiteral,
 	rgProcessError,
-	other
+	other,
+	canceled
 }
 
 export class SearchError extends Error {
@@ -431,7 +433,13 @@ export class SearchError extends Error {
 	}
 }
 
-export function deserializeSearchError(errorMsg: string): SearchError {
+export function deserializeSearchError(error: Error): SearchError {
+	const errorMsg = error.message;
+
+	if (isPromiseCanceledError(error)) {
+		return new SearchError(errorMsg, SearchErrorCode.canceled);
+	}
+
 	try {
 		const details = JSON.parse(errorMsg);
 		return new SearchError(details.message, details.code);
diff --git a/src/vs/workbench/services/search/common/searchService.ts b/src/vs/workbench/services/search/common/searchService.ts
@@ -260,7 +260,8 @@ export class SearchService extends Disposable implements ISearchService {
 		}, err => {
 			const endToEndTime = e2eSW.elapsed();
 			this.logService.trace(`SearchService#search: ${endToEndTime}ms`);
-			const searchError = deserializeSearchError(err.message);
+			const searchError = deserializeSearchError(err);
+			this.logService.trace(`SearchService#searchError: ${searchError.message}`);
 			this.sendTelemetry(query, endToEndTime, undefined, searchError);
 
 			throw searchError;
@@ -387,7 +388,8 @@ export class SearchService extends Disposable implements ISearchService {
 						err.code === SearchErrorCode.globParseError ? 'glob' :
 							err.code === SearchErrorCode.invalidLiteral ? 'literal' :
 								err.code === SearchErrorCode.other ? 'other' :
-									'unknown';
+									err.code === SearchErrorCode.canceled ? 'canceled' :
+										'unknown';
 			}
 
 			type TextSearchCompleteClassification = {
diff --git a/src/vs/workbench/services/search/test/node/textSearch.integrationTest.ts b/src/vs/workbench/services/search/test/node/textSearch.integrationTest.ts
@@ -370,7 +370,7 @@ suite('TextSearch-integration', function () {
 			return doSearchTest(config, 0).then(() => {
 				throw new Error('expected fail');
 			}, err => {
-				const searchError = deserializeSearchError(err.message);
+				const searchError = deserializeSearchError(err);
 				assert.equal(searchError.message, 'Unknown encoding: invalidEncoding');
 				assert.equal(searchError.code, SearchErrorCode.unknownEncoding);
 			});
@@ -386,7 +386,7 @@ suite('TextSearch-integration', function () {
 			return doSearchTest(config, 0).then(() => {
 				throw new Error('expected fail');
 			}, err => {
-				const searchError = deserializeSearchError(err.message);
+				const searchError = deserializeSearchError(err);
 				let regexParseErrorForUnclosedParenthesis = 'Regex parse error: unmatched closing parenthesis';
 				assert.equal(searchError.message, regexParseErrorForUnclosedParenthesis);
 				assert.equal(searchError.code, SearchErrorCode.regexParseError);
@@ -403,7 +403,7 @@ suite('TextSearch-integration', function () {
 			return doSearchTest(config, 0).then(() => {
 				throw new Error('expected fail');
 			}, err => {
-				const searchError = deserializeSearchError(err.message);
+				const searchError = deserializeSearchError(err);
 				let regexParseErrorForLookAround = 'Regex parse error: lookbehind assertion is not fixed length';
 				assert.equal(searchError.message, regexParseErrorForLookAround);
 				assert.equal(searchError.code, SearchErrorCode.regexParseError);
@@ -424,7 +424,7 @@ suite('TextSearch-integration', function () {
 			return doSearchTest(config, 0).then(() => {
 				throw new Error('expected fail');
 			}, err => {
-				const searchError = deserializeSearchError(err.message);
+				const searchError = deserializeSearchError(err);
 				assert.equal(searchError.message, 'Error parsing glob \'/{{}\': nested alternate groups are not allowed');
 				assert.equal(searchError.code, SearchErrorCode.globParseError);
 			});
