string message for known errors (microsoft#259614)

Author: amunger

src/vs/workbench/api/common/extHostNotebook.ts

@@ -14,6 +14,7 @@ import { MarshalledId } from '../../../base/common/marshallingIds.js';
 import { isFalsyOrWhitespace } from '../../../base/common/strings.js';
 import { assertReturnsDefined } from '../../../base/common/types.js';
 import { URI, UriComponents } from '../../../base/common/uri.js';
+import { CancellationError } from '../../../base/common/errors.js';
 import { IExtensionDescription } from '../../../platform/extensions/common/extensions.js';
 import * as files from '../../../platform/files/common/files.js';
 import { Cache } from './cache.js';
@@ -318,16 +319,16 @@ export class ExtHostNotebookController implements ExtHostNotebookShape {
 		this.trace(`enter saveNotebook(versionId: ${versionId}, ${uri.toString()})`);
 
 		if (!serializer) {
-			throw new Error('NO serializer found');
+			throw new NotebookSaveError('NO serializer found');
 		}
 
 		const document = this._documents.get(uri);
 		if (!document) {
-			throw new Error('Document NOT found');
+			throw new NotebookSaveError('Document NOT found');
 		}
 
 		if (document.versionId !== versionId) {
-			throw new Error('Document version mismatch, expected: ' + versionId + ', actual: ' + document.versionId);
+			throw new NotebookSaveError('Document version mismatch, expected: ' + versionId + ', actual: ' + document.versionId);
 		}
 
 		if (!this._extHostFileSystem.value.isWritableFileSystem(uri.scheme)) {
@@ -359,11 +360,11 @@ export class ExtHostNotebookController implements ExtHostNotebookShape {
 		await this._validateWriteFile(uri, options);
 
 		if (token.isCancellationRequested) {
-			throw new Error('canceled');
+			throw new CancellationError();
 		}
 		const bytes = await serializer.serializer.serializeNotebook(data, token);
 		if (token.isCancellationRequested) {
-			throw new Error('canceled');
+			throw new CancellationError();
 		}
 
 		// Don't accept any cancellation beyond this point, we need to report the result of the file write
@@ -737,3 +738,10 @@ export class ExtHostNotebookController implements ExtHostNotebookShape {
 		this._logService.trace(`[Extension Host Notebook] ${msg}`);
 	}
 }
+
+export class NotebookSaveError extends Error {
+	constructor(message: string) {
+		super(message);
+		this.name = 'NotebookSaveError';
+	}
+}

src/vs/workbench/contrib/notebook/common/notebookEditorModel.ts

@@ -233,7 +233,7 @@ export class NotebookFileWorkingCopyModel extends Disposable implements IStoredF
 
 		// Override save behavior to avoid transferring the buffer across the wire 3 times
 		if (saveWithReducedCommunication) {
-			this.setSaveDelegate().catch(console.error);
+			this.setSaveDelegate().catch(error => this._notebookLogService.error('WorkingCopyModel', `Failed to set save delegate: ${error}`));
 		}
 	}
 
@@ -247,7 +247,12 @@ export class NotebookFileWorkingCopyModel extends Disposable implements IStoredF
 
 				if (!serializer) {
 					this._notebookLogService.info('WorkingCopyModel', 'No serializer found for notebook model, checking if provider still needs to be resolved');
-					serializer = await this.getNotebookSerializer();
+					serializer = await this.getNotebookSerializer().catch(error => {
+						this._notebookLogService.error('WorkingCopyModel', `Failed to get notebook serializer: ${error}`);
+						// The serializer was set initially but somehow is no longer available
+						this.save = undefined;
+						throw new NotebookSaveError('Failed to get notebook serializer');
+					});
 				}
 
 				if (token.isCancellationRequested) {
@@ -257,11 +262,11 @@ export class NotebookFileWorkingCopyModel extends Disposable implements IStoredF
 				const stat = await serializer.save(this._notebookModel.uri, this._notebookModel.versionId, options, token);
 				return stat;
 			} catch (error) {
-				if (!token.isCancellationRequested) {
+				if (!token.isCancellationRequested && error.name !== 'Canceled') {
 					type notebookSaveErrorData = {
 						isRemote: boolean;
 						isIPyNbWorkerSerializer: boolean;
-						error: Error;
+						error: string;
 					};
 					type notebookSaveErrorClassification = {
 						owner: 'amunger';
@@ -271,10 +276,11 @@ export class NotebookFileWorkingCopyModel extends Disposable implements IStoredF
 						error: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; comment: 'Info about the error that occurred' };
 					};
 					const isIPynb = this._notebookModel.viewType === 'jupyter-notebook' || this._notebookModel.viewType === 'interactive';
+					const errorMessage = error.name === 'NotebookSaveError' ? error.message : 'Unknown error';
 					this._telemetryService.publicLogError2<notebookSaveErrorData, notebookSaveErrorClassification>('notebook/SaveError', {
 						isRemote: this._notebookModel.uri.scheme === Schemas.vscodeRemote,
 						isIPyNbWorkerSerializer: isIPynb && this._configurationService.getValue<boolean>('ipynb.experimental.serialization'),
-						error: error
+						error: errorMessage
 					});
 				}
 
@@ -313,7 +319,8 @@ export class NotebookFileWorkingCopyModel extends Disposable implements IStoredF
 	async getNotebookSerializer(): Promise<INotebookSerializer> {
 		const info = await this._notebookService.withNotebookDataProvider(this.notebookModel.viewType);
 		if (!(info instanceof SimpleNotebookProviderInfo)) {
-			throw new Error('CANNOT open file notebook with this provider');
+			const message = 'CANNOT open notebook with this provider';
+			throw new NotebookSaveError(message);
 		}
 
 		return info.serializer;
@@ -348,3 +355,10 @@ export class NotebookFileWorkingCopyModelFactory implements IStoredFileWorkingCo
 }
 
 //#endregion
+
+class NotebookSaveError extends Error {
+	constructor(message: string) {
+		super(message);
+		this.name = 'NotebookSaveError';
+	}
+}