Move SQL 2019 extension's notebook code into Azure Data Studio (#4090)

extensions/notebook/src/prompts/adapter.ts

@@ -0,0 +1,173 @@
+'use strict';
+
+// This code is originally from https://github.com/DonJayamanne/bowerVSCode
+// License: https://github.com/DonJayamanne/bowerVSCode/blob/master/LICENSE
+
+import { window, OutputChannel } from 'vscode';
+import * as Constants from '../common/constants';
+import * as nodeUtil from 'util';
+import PromptFactory from './factory';
+import EscapeException from './escapeException';
+import { IQuestion, IPrompter, IPromptCallback } from './question';
+
+// Supports simple pattern for prompting for user input and acting on this
+export default class CodeAdapter implements IPrompter {
+
+	private outChannel: OutputChannel;
+	private outBuffer: string = '';
+	private messageLevelFormatters = {};
+	constructor() {
+		// TODO Decide whether output channel logging should be saved here?
+		this.outChannel = window.createOutputChannel(Constants.outputChannelName);
+		// this.outChannel.clear();
+	}
+
+	public logError(message: any): void {
+		let line = `error: ${message.message}\n    Code - ${message.code}`;
+
+		this.outBuffer += `${line}\n`;
+		this.outChannel.appendLine(line);
+	}
+
+	// private formatInfo(message: any) {
+	//     const prefix = `${message.level}: (${message.id}) `;
+	//     if (message.id === "json") {
+	//         let jsonString = JSON.stringify(message.data, undefined, 4);
+	//         return `${prefix}${message.message}\n${jsonString}`;
+	//     }
+	//     else {
+	//         return `${prefix}${message.message}`;
+	//     }
+	// }
+
+	// private formatAction(message: any) {
+	//     const prefix = `info: ${message.level}: (${message.id}) `;
+	//     return `${prefix}${message.message}`;
+	// }
+
+	private formatMessage(message: any): string {
+		const prefix = `${message.level}: (${message.id}) `;
+		return `${prefix}${message.message}`;
+	}
+
+	// private formatConflict(message: any) {
+	//     var msg = message.message + ':\n';
+	//     var picks = (<any[]>message.data.picks);
+	//     var pickCount = 1;
+	//     picks.forEach((pick) => {
+	//         let pickMessage = (pickCount++).toString() + "). " + pick.endpoint.name + "#" + pick.endpoint.target;
+	//         if (pick.pkgMeta._resolution && pick.pkgMeta._resolution.tag) {
+	//             pickMessage += " which resolved to " + pick.pkgMeta._resolution.tag
+	//         }
+	//         if (Array.isArray(pick.dependants) && pick.dependants.length > 0) {
+	//             pickMessage += " and is required by ";
+	//             pick.dependants.forEach((dep) => {
+	//                 pickMessage += " " + dep.endpoint.name + "#" + dep.endpoint.target;
+	//             });
+	//         }
+	//         msg += "    " + pickMessage + "\n";
+	//     });
+
+	//     var prefix = (message.id === "solved"? "info" : "warn") + `: ${message.level}: (${message.id}) `;
+	//     return prefix + msg;
+	// }
+
+	public log(message: any): void {
+		let line: string = '';
+		if (message && typeof (message.level) === 'string') {
+			let formatter: (a: any) => string = this.formatMessage;
+			if (this.messageLevelFormatters[message.level]) {
+				formatter = this.messageLevelFormatters[message.level];
+			}
+			line = formatter(message);
+		} else {
+			line = nodeUtil.format(arguments);
+		}
+
+		this.outBuffer += `${line}\n`;
+		this.outChannel.appendLine(line);
+	}
+
+	public clearLog(): void {
+		this.outChannel.clear();
+	}
+
+	public showLog(): void {
+		this.outChannel.show();
+	}
+
+	// TODO define question interface
+	private fixQuestion(question: any): any {
+		if (question.type === 'checkbox' && Array.isArray(question.choices)) {
+			// For some reason when there's a choice of checkboxes, they aren't formatted properly
+			// Not sure where the issue is
+			question.choices = question.choices.map(item => {
+				if (typeof (item) === 'string') {
+					return { checked: false, name: item, value: item };
+				} else {
+					return item;
+				}
+			});
+		}
+	}
+
+	public promptSingle<T>(question: IQuestion, ignoreFocusOut?: boolean): Promise<T> {
+		let questions: IQuestion[] = [question];
+		return this.prompt(questions, ignoreFocusOut).then((answers: { [key: string]: T }) => {
+			if (answers) {
+				let response: T = answers[question.name];
+				return response || undefined;
+			}
+		});
+	}
+
+	public prompt<T>(questions: IQuestion[], ignoreFocusOut?: boolean): Promise<{ [key: string]: T }> {
+		let answers: { [key: string]: T } = {};
+
+		// Collapse multiple questions into a set of prompt steps
+		let promptResult: Promise<{ [key: string]: T }> = questions.reduce((promise: Promise<{ [key: string]: T }>, question: IQuestion) => {
+			this.fixQuestion(question);
+
+			return promise.then(() => {
+				return PromptFactory.createPrompt(question, ignoreFocusOut);
+			}).then(prompt => {
+				// Original Code: uses jQuery patterns. Keeping for reference
+				// if (!question.when || question.when(answers) === true) {
+				//     return prompt.render().then(result => {
+				//         answers[question.name] = question.filter ? question.filter(result) : result;
+				//     });
+				// }
+
+				if (!question.shouldPrompt || question.shouldPrompt(answers) === true) {
+					return prompt.render().then(result => {
+						answers[question.name] = result;
+
+						if (question.onAnswered) {
+							question.onAnswered(result);
+						}
+						return answers;
+					});
+				}
+				return answers;
+			});
+		}, Promise.resolve());
+
+		return promptResult.catch(err => {
+			if (err instanceof EscapeException || err instanceof TypeError) {
+				return undefined;
+			}
+
+			window.showErrorMessage(err.message);
+		});
+	}
+
+	// Helper to make it possible to prompt using callback pattern. Generally Promise is a preferred flow
+	public promptCallback(questions: IQuestion[], callback: IPromptCallback): void {
+		// Collapse multiple questions into a set of prompt steps
+		this.prompt(questions).then(answers => {
+			if (callback) {
+				callback(answers);
+			}
+		});
+	}
+}