Merge pull request #52 from SAP/refactoring

fix: yeoman-environment version update + code refactor + tests

Author: slavik-lvovsky

backend/.nycrc.json

@@ -8,8 +8,8 @@
     "temp-dir": "./reports/.nyc_output",
     "report-dir": "./reports/coverage",
     "check-coverage": true,
-    "branches": 86.79,
-    "lines": 89,
-    "functions": 94,
-    "statements": 89
+    "branches": 98,
+    "lines": 99,
+    "functions": 97,
+    "statements": 99
   }

backend/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "code-snippet",
-	"version": "0.0.21",
-	"displayName": "Code Snippet",
+	"version": "0.0.22",
+	"displayName": "Code Snippet", 
 	"publisher": "SAPOSS",
 	"author": {
 		"name": "SAP SE"
@@ -117,18 +117,13 @@
 	},
 	"dependencies": {
 		"@sap-devx/webview-rpc": "^0.2.2",
-		"@sap-devx/yeoman-ui-types": "0.0.1",
 		"@vscode-logging/logger": "1.1.0",
-		"chalk": "^4.0.0",
 		"datauri": "^2.0.0",
 		"fs-extra": "^8.1.0",
-		"humanize-string": "^1.0.2",
 		"lodash": "^4.17.15",
-		"object-hash": "^2.0.3",
 		"strip-ansi": "^6.0.0",
-		"titleize": "^1.0.1",
 		"ws": "^7.2.5",
-		"yeoman-environment": "2.8.0"
+		"yeoman-environment": "2.10.3"
 	},
 	"devDependencies": {
 		"@types/chai": "^4.2.9",
@@ -137,49 +132,46 @@
 		"@types/lodash": "^4.14.150",
 		"@types/mocha": "^5.2.7",
 		"@types/node": "^10.17.21",
-		"@types/object-hash": "^1.3.1",
 		"@types/sinon": "^7.5.0",
 		"@types/ws": "^6.0.3",
-		"@types/yeoman-environment": "2.3.3",
+		"@types/yeoman-environment": "2.10.2",
 		"@typescript-eslint/parser": "^2.30.0",
 		"@typescript-eslint/eslint-plugin": "^2.30.0",
 		"eslint": "^6.8.0",
 		"eslint-config-prettier": "^6.11.0",
 		"prettier": "^2.0.5",
 		"typescript": "^3.9.7",
-		"bufferutil": "^4.0.1",
 		"chai": "^4.2.0",
 		"copy-webpack-plugin": "^5.0.5",
 		"mocha": "^6.2.2",
 		"nyc": "^14.1.1",
 		"sinon": "^7.5.0",
 		"ts-loader": "^6.2.1",
 		"ts-node": "^8.9.1",
-		"utf-8-validate": "^5.0.2",
 		"string-replace-loader": "^2.1.1",
 		"vsce": "^1.73.0",
 		"webpack": "^4.43.0",
 		"webpack-cli": "^3.3.11",
 		"lcov-result-merger": "3.1.0",
 		"coveralls": "2.11.16",
-    		"cz-conventional-changelog": "3.3.0",
- 		"@commitlint/cli": "11.0.0",
-  		"@commitlint/config-conventional": "11.0.0",
-  		"husky": "4.3.0"
+		"cz-conventional-changelog": "3.3.0",
+		"@commitlint/cli": "11.0.0",
+		"@commitlint/config-conventional": "11.0.0",
+		"husky": "4.3.0"
 	},
 	"husky": {
-           "hooks": {
-               "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-           }
-        },
-        "config": {
-           "commitizen": {
-               "path": "cz-conventional-changelog"
-           }
-        },
-        "commitlint": {
-           "extends": [
-               "@commitlint/config-conventional"
-           ]
-        }
+		"hooks": {
+			"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+		}
+	},
+	"config": {
+		"commitizen": {
+			"path": "cz-conventional-changelog"
+		}
+	},
+	"commitlint": {
+		"extends": [
+			"@commitlint/config-conventional"
+		]
+	}
 }

backend/src/code-snippet.ts

@@ -6,6 +6,7 @@ import { AppEvents } from "./app-events";
 import { IRpc } from "@sap-devx/webview-rpc/out.ext/rpc-common";
 import Generator = require("yeoman-generator");
 import { IChildLogger } from "@vscode-logging/logger";
+import TerminalAdapter = require("yeoman-environment/lib/adapter");
 
 export class CodeSnippet {
 
@@ -20,7 +21,7 @@ export class CodeSnippet {
   private readonly logger: IChildLogger;
   private gen: Generator | undefined; // eslint-disable-line @typescript-eslint/prefer-readonly
   private promptCount: number;
-  private currentQuestions: Environment.Adapter.Questions<any>;
+  private currentQuestions: TerminalAdapter.Questions<any>;
   private snippetName: string;
   private readonly customQuestionEventHandlers: Map<string, Map<string, Function>>;
   private errorThrown = false;
@@ -131,12 +132,12 @@ export class CodeSnippet {
     return this.outputChannel.showOutput();
   }
 
-  public async showPrompt(questions: Environment.Adapter.Questions<any>): Promise<inquirer.Answers> {
+  public async showPrompt(questions: TerminalAdapter.Questions<any>): Promise<inquirer.Answers> {
     this.promptCount++;
     const promptName = this.getPromptName(questions);
 
     this.currentQuestions = questions;
-    const mappedQuestions: Environment.Adapter.Questions<any> = this.normalizeFunctions(questions);
+    const mappedQuestions: TerminalAdapter.Questions<any> = this.normalizeFunctions(questions);
     if (_.isEmpty(mappedQuestions)) {
       return {};
     }
@@ -152,7 +153,7 @@ export class CodeSnippet {
     }
   }
 
-  private getPromptName(questions: Environment.Adapter.Questions<any>): string {
+  private getPromptName(questions: TerminalAdapter.Questions<any>): string {
     const firstQuestionName = _.get(questions, "[0].name");
     return (firstQuestionName ? _.startCase(firstQuestionName) : `Step ${this.promptCount}`);
   }
@@ -224,12 +225,12 @@ export class CodeSnippet {
    * Functions are lost when being passed to client (using JSON.Stringify)
    * Also functions cannot be evaluated on client)
    */
-  private normalizeFunctions(questions: Environment.Adapter.Questions<any>): Environment.Adapter.Questions<any> {
+  private normalizeFunctions(questions: TerminalAdapter.Questions<any>): TerminalAdapter.Questions<any> {
     this.addCustomQuestionEventHandlers(questions);
     return JSON.parse(JSON.stringify(questions, CodeSnippet.funcReplacer));
   }
 
-  private addCustomQuestionEventHandlers(questions: Environment.Adapter.Questions<any>): void {
+  private addCustomQuestionEventHandlers(questions: TerminalAdapter.Questions<any>): void {
     for (const question of (questions as any[])) {
       const guiType = _.get(question, "guiOptions.type", question.guiType);
       const questionHandlers = this.customQuestionEventHandlers.get(guiType);

backend/src/contributors.ts

@@ -2,56 +2,42 @@ import * as vscode from 'vscode';
 import * as _ from 'lodash';
 
 export class Contributors {
-    private static readonly apiMap = new Map<string, any>();
-
-    public static getSnippet(uiOptions: any) {
-		let snippet  = undefined;
-		const contributorId = _.get(uiOptions, "contributorId");
-		const snippetName = _.get(uiOptions, "snippetName");
-		const snippetContext = _.get(uiOptions, "context");
-		if (contributorId && snippetName) {
-			const api = Contributors.apiMap.get(contributorId);
-			const snippets = api.getCodeSnippets(snippetContext);
-			snippet  = snippets.get(snippetName);
-		}
-		return snippet;
-	}
-
-    public static add(extensionId: string, api: any) {
-        Contributors.apiMap.set(extensionId, api);
-    }
-
-    private static async getApi(extension: vscode.Extension<any>, extensionId: string) {
-        let api: any;
-        if (!extension.isActive) {
+    public static async getSnippet(contributerInfo: any) {
+        const contributorId = _.get(contributerInfo, "contributorId");
+        const extension = Contributors.getContributorExtension(contributorId);
+        if (extension) {
             try {
-                api = await extension.activate();
+                const api = await this.getApiPromise(extension as vscode.Extension<any>);
+                const snippetContext = _.get(contributerInfo, "context");
+                const snippets = api.getCodeSnippets(snippetContext);
+                const snippetName = _.get(contributerInfo, "snippetName");
+                return snippets.get(snippetName);
             } catch (error) {
-                console.error(error);
-                // TODO: Add Logger.error here ("Failed to activate extension", {extensionId: extensionId})
+                const errorMessage = _.get(error, "stack", _.get(error, "message", error));
+                console.error(errorMessage);
+                // TODO: Add Logger.error
             }
-        } else {
-            api = extension.exports;
         }
-        return api;
-}
+    }
 
-    public static async init() {
-        const allExtensions: readonly vscode.Extension<any>[] = vscode.extensions.all;
-        for (const extension of allExtensions) {
-            const currentPackageJSON: any = _.get(extension, "packageJSON");
-            const extensionDependencies: string[] = _.get(currentPackageJSON, "extensionDependencies");
-            if (!_.isEmpty(extensionDependencies)) {
-                const codeSnippetDependancy: boolean = _.includes (extensionDependencies,"saposs.code-snippet");
-                if (codeSnippetDependancy) {
-                    const extensionName: string =  _.get(currentPackageJSON, "name");
-                    const extensionPublisher: string =  _.get(currentPackageJSON, "publisher");
-                    const extensionId: string = extensionPublisher + "." + extensionName;
-                    const api = await Contributors.getApi(extension, extensionId);
-                    Contributors.add(extensionId, api);
+    private static getApiPromise(extension: vscode.Extension<any>) {
+        return (extension.isActive ? extension.exports : extension.activate());
+    }
+
+    private static getContributorExtension(contributorId: string) {
+        return _.find(vscode.extensions.all, (extension: vscode.Extension<any>) => {
+            const extensionDependencies: string[] = _.get(extension, "packageJSON.extensionDependencies");
+            if (_.includes(extensionDependencies, "saposs.code-snippet")) {
+                if (contributorId === Contributors.getExtensionId(extension)) {
+                    return extension;
                 }
             }
-        }
+        });
     }
 
-}
+    private static getExtensionId(extension: vscode.Extension<any>) {
+        const extensionName: string = _.get(extension, "packageJSON.name");
+        const extensionPublisher: string = _.get(extension, "packageJSON.publisher");
+        return `${extensionPublisher}.${extensionName}`;
+    }
+}

backend/src/extension.ts

@@ -1,7 +1,6 @@
 import * as _ from 'lodash';
 import * as vscode from 'vscode';
 import { createExtensionLoggerAndSubscribeToLogSettingsChanges } from "./logger/logger-wrapper";
-import { Contributors } from './contributors';
 import { CodeSnippetPanel } from './panels/CodeSnippetPanel';
 import { AbstractWebviewPanel } from './panels/AbstractWebviewPanel';
 
@@ -18,8 +17,6 @@ export function activate(context: vscode.ExtensionContext) {
 		return;
 	}
 
-	Contributors.init();
-
 	codeSnippetPanel = new CodeSnippetPanel(extContext);
 	registerAndSubscribeCommand("loadCodeSnippet", codeSnippetPanel.loadWebviewPanel.bind(codeSnippetPanel));
 	registerAndSubscribeCommand("codeSnippet.toggleOutput", codeSnippetPanel.toggleOutput.bind(codeSnippetPanel));

backend/src/panels/CodeSnippetPanel.ts

@@ -25,25 +25,27 @@ export class CodeSnippetPanel extends AbstractWebviewPanel {
 	public setWebviewPanel(webViewPanel: vscode.WebviewPanel, uiOptions?: any) {
 		super.setWebviewPanel(webViewPanel, uiOptions);
 
-		this.snippet = Contributors.getSnippet(uiOptions);
-
-		if (_.isNil(this.snippet)) {
-			return vscode.window.showErrorMessage("Can not find snippet.");
-		}
-
-		this.messages = _.assign({}, backendMessages, this.snippet.getMessages());
-		const rpc = new RpcExtension(this.webViewPanel.webview);
-		this.outputChannel = new OutputChannelLog(this.messages.channelName);
-		const vscodeEvents: AppEvents = new VSCodeEvents(rpc, this.webViewPanel);
-		this.codeSnippet = new CodeSnippet(rpc, 
-			vscodeEvents, 
-			this.outputChannel, 
-			this.logger, 
-			{messages: this.messages, snippet: this.snippet});
-		this.codeSnippet.registerCustomQuestionEventHandler("file-browser", "getFilePath", this.showOpenFileDialog.bind(this));
-		this.codeSnippet.registerCustomQuestionEventHandler("folder-browser", "getPath", this.showOpenFolderDialog.bind(this));
-
-		this.initWebviewPanel();
+		const contributerInfo = _.get(uiOptions, "contributerInfo", uiOptions);
+		Contributors.getSnippet(contributerInfo).then(snippet => {
+			if (_.isNil(snippet)) {
+				this.webViewPanel.dispose();
+				return vscode.window.showErrorMessage("Can not find snippet.");
+			}
+
+			this.messages = _.assign({}, backendMessages, snippet.getMessages());
+			const rpc = new RpcExtension(this.webViewPanel.webview);
+			this.outputChannel = new OutputChannelLog(this.messages.channelName);
+			const vscodeEvents: AppEvents = new VSCodeEvents(rpc, this.webViewPanel);
+			this.codeSnippet = new CodeSnippet(rpc,
+				vscodeEvents,
+				this.outputChannel,
+				this.logger,
+				{ messages: this.messages, snippet, contributerInfo});
+			this.codeSnippet.registerCustomQuestionEventHandler("file-browser", "getFilePath", this.showOpenFileDialog.bind(this));
+			this.codeSnippet.registerCustomQuestionEventHandler("folder-browser", "getPath", this.showOpenFolderDialog.bind(this));
+
+			this.initWebviewPanel();
+		});
 	}
 
 	public static getOutputChannel(channelName: string): vscode.OutputChannel {
@@ -55,7 +57,6 @@ export class CodeSnippetPanel extends AbstractWebviewPanel {
 	}
 
 	private codeSnippet: CodeSnippet;
-	private snippet: any;
 	private messages: any;
 	private outputChannel: AppLog;
 

backend/src/webSocketServer/index.ts

@@ -35,7 +35,7 @@ class CodeSnippetWebSocketServer {
       this.rpc = new RpcExtensionWebSockets(ws);
       //TODO: Use RPC to send it to the browser log (as a collapsed pannel in Vue)
       const logger: AppLog = new ServerLog(this.rpc);
-      const childLogger = {debug: () => {}, error: () => {}, fatal: () => {}, warn: () => {}, info: () => {}, trace: () => {}, getChildLogger: () => {return {} as IChildLogger;}};
+      const childLogger = {debug: () => "", error: () => "", fatal: () => "", warn: () => "", info: () => "", trace: () => "", getChildLogger: () => {return {} as IChildLogger;}};
       const appEvents: AppEvents = new ServerEvents(this.rpc);
       const snippet = {
 				getQuestions() {

backend/src/webSocketServer/server-events.ts

@@ -17,6 +17,6 @@ export class ServerEvents implements AppEvents {
     }
 
     public doClose(): void {
-
+        return;
     }
 }

backend/tests/code-snippet.spec.ts

@@ -92,7 +92,7 @@ describe('codeSnippet unit test', () => {
         }  
     }
 
-    const testLogger = {debug: () => {}, error: () => {}, fatal: () => {}, warn: () => {}, info: () => {}, trace: () => {}, getChildLogger: () => ({} as IChildLogger)};
+    const testLogger = { debug: () => "", error: () => "", fatal: () => "", warn: () => "", info: () => "", trace: () => "", getChildLogger: () => ({} as IChildLogger)};
 
     const snippet: any = {
         getMessages() {