pending comment caching in editor comment contribution

src/vs/workbench/parts/comments/electron-browser/commentThreadWidget.ts

@@ -64,6 +64,7 @@ export class ReviewZoneWidget extends ZoneWidget {
 	private _commentThread: modes.CommentThread;
 	private _commentGlyph: CommentGlyphWidget;
 	private _owner: number;
+	private _pendingComment: string;
 	private _localToDispose: IDisposable[];
 	private _globalToDispose: IDisposable[];
 	private _markdownRenderer: MarkdownRenderer;
@@ -89,12 +90,14 @@ export class ReviewZoneWidget extends ZoneWidget {
 		editor: ICodeEditor,
 		owner: number,
 		commentThread: modes.CommentThread,
+		pendingComment: string,
 		options: IOptions = {}
 	) {
 		super(editor, options);
 		this._resizeObserver = null;
 		this._owner = owner;
 		this._commentThread = commentThread;
+		this._pendingComment = pendingComment;
 		this._isCollapsed = commentThread.collapsibleState !== modes.CommentThreadCollapsibleState.Expanded;
 		this._globalToDispose = [];
 		this._localToDispose = [];
@@ -144,6 +147,18 @@ export class ReviewZoneWidget extends ZoneWidget {
 		this.editor.revealRangeInCenter(this._commentThread.range);
 	}
 
+	public getPendingComment(): string {
+		if (this._commentEditor) {
+			let model = this._commentEditor.getModel();
+
+			if (model.getValueLength() > 0) { // checking length is cheap
+				return model.getValue();
+			}
+		}
+
+		return null;
+	}
+
 	protected _fillContainer(container: HTMLElement): void {
 		this.setCssClass('review-widget');
 		this._headElement = <HTMLDivElement>dom.$('.head');
@@ -264,7 +279,7 @@ export class ReviewZoneWidget extends ZoneWidget {
 		this._commentEditor = this.instantiationService.createInstance(SimpleCommentEditor, this._commentForm, SimpleCommentEditor.getEditorOptions());
 		const modeId = hasExistingComments ? this._commentThread.threadId : ++INMEM_MODEL_ID;
 		const resource = URI.parse(`${COMMENT_SCHEME}:commentinput-${modeId}.md`);
-		const model = this.modelService.createModel('', this.modeService.getOrCreateModeByFilepathOrFirstLine(resource.path), resource, true);
+		const model = this.modelService.createModel(this._pendingComment || '', this.modeService.getOrCreateModeByFilepathOrFirstLine(resource.path), resource, true);
 		this._localToDispose.push(model);
 		this._commentEditor.setModel(model);
 		this._localToDispose.push(this._commentEditor);

src/vs/workbench/parts/comments/electron-browser/commentsEditorContribution.ts

@@ -172,6 +172,7 @@ export class ReviewController implements IEditorContribution {
 	private mouseDownInfo: { lineNumber: number } | null = null;
 	private _commentingRangeSpaceReserved = false;
 
+	private _pendingCommentCache: { [key: number]: { [key: string]: string } };
 
 	constructor(
 		editor: ICodeEditor,
@@ -191,6 +192,7 @@ export class ReviewController implements IEditorContribution {
 		this.localToDispose = [];
 		this._commentInfos = [];
 		this._commentWidgets = [];
+		this._pendingCommentCache = {};
 		this._newCommentWidget = null;
 
 		this._reviewPanelVisible = ctxReviewPanelVisible.bindTo(contextKeyService);
@@ -315,10 +317,8 @@ export class ReviewController implements IEditorContribution {
 			this._newCommentWidget = null;
 		}
 
-		this._commentWidgets.forEach(zone => {
-			zone.dispose();
-		});
-		this._commentWidgets = [];
+
+		this.removeCommentWidgetsAndStoreCache();
 
 		this.localToDispose.push(this.editor.onMouseDown(e => this.onEditorMouseDown(e)));
 		this.localToDispose.push(this.editor.onMouseUp(e => this.onEditorMouseUp(e)));
@@ -355,7 +355,7 @@ export class ReviewController implements IEditorContribution {
 				}
 			});
 			added.forEach(thread => {
-				let zoneWidget = new ReviewZoneWidget(this.instantiationService, this.modeService, this.modelService, this.themeService, this.commentService, this.openerService, this.dialogService, this.notificationService, this.editor, e.owner, thread, {});
+				let zoneWidget = new ReviewZoneWidget(this.instantiationService, this.modeService, this.modelService, this.themeService, this.commentService, this.openerService, this.dialogService, this.notificationService, this.editor, e.owner, thread, null, {});
 				zoneWidget.display(thread.range.startLineNumber, this._commentingRangeDecorator.commentsOptions);
 				this._commentWidgets.push(zoneWidget);
 				this._commentInfos.filter(info => info.owner === e.owner)[0].threads.push(thread);
@@ -389,7 +389,7 @@ export class ReviewController implements IEditorContribution {
 			},
 			reply: replyCommand,
 			collapsibleState: CommentThreadCollapsibleState.Expanded,
-		}, {});
+		}, null, {});
 
 		this.localToDispose.push(this._newCommentWidget.onDidClose(e => {
 			this._newCommentWidget = null;
@@ -462,6 +462,7 @@ export class ReviewController implements IEditorContribution {
 	}
 
 	setComments(commentInfos: modes.CommentInfo[]): void {
+		// todo setComments should read from pendingCommentCache
 		this._commentInfos = commentInfos;
 		let lineDecorationsWidth: number = this.editor.getConfiguration().layoutInfo.decorationsWidth;
 
@@ -494,15 +495,16 @@ export class ReviewController implements IEditorContribution {
 		}
 
 		// create viewzones
-		this._commentWidgets.forEach(zone => {
-			zone.dispose();
-		});
-
-		this._commentWidgets = [];
+		this.removeCommentWidgetsAndStoreCache();
 
 		this._commentInfos.forEach(info => {
+			let providerCacheStore = this._pendingCommentCache[info.owner];
 			info.threads.forEach(thread => {
-				let zoneWidget = new ReviewZoneWidget(this.instantiationService, this.modeService, this.modelService, this.themeService, this.commentService, this.openerService, this.dialogService, this.notificationService, this.editor, info.owner, thread, {});
+				let pendingComment: string = null;
+				if (providerCacheStore) {
+					pendingComment = providerCacheStore[thread.threadId];
+				}
+				let zoneWidget = new ReviewZoneWidget(this.instantiationService, this.modeService, this.modelService, this.themeService, this.commentService, this.openerService, this.dialogService, this.notificationService, this.editor, info.owner, thread, pendingComment, {});
 				zoneWidget.display(thread.range.startLineNumber, this._commentingRangeDecorator.commentsOptions);
 				this._commentWidgets.push(zoneWidget);
 			});
@@ -530,6 +532,29 @@ export class ReviewController implements IEditorContribution {
 		this.editor.focus();
 		this.editor.revealRangeInCenter(this.editor.getSelection());
 	}
+
+	removeCommentWidgetsAndStoreCache() {
+		if (this._commentWidgets) {
+			this._commentWidgets.forEach(zone => {
+				let pendingComment = zone.getPendingComment();
+				if (pendingComment) {
+					// cache pendingComment for later recovery
+					let providerCacheStore = this._pendingCommentCache[zone.owner];
+
+					if (!providerCacheStore) {
+						this._pendingCommentCache[zone.owner] = {};
+						providerCacheStore = this._pendingCommentCache[zone.owner];
+					}
+
+					providerCacheStore[zone.commentThread.threadId] = pendingComment;
+				}
+
+				zone.dispose();
+			});
+		}
+
+		this._commentWidgets = [];
+	}
 }
 
 export class NextCommentThreadAction extends EditorAction {