Merge pull request #2 from jonathan-spruce/pull-image

Pull language server image from DockerHub

Author: tobespc

.gitignore

@@ -3,3 +3,4 @@ node_modules
 client/server
 .vscode-test
 **/.DS_Store
+*.vsix

README.md

@@ -1,18 +1,24 @@
 # Codewind Java Profiler
 
-Annotates your Java code with code highlighting for your hottest methods in your Codewind projects.
+Annotates your Java code with code highlighting for your hottest methods in your Eclipse Codewind projects.
 
 ![platforms](https://img.shields.io/badge/runtime-Java-yellow.svg)
 [![Eclipse License](https://img.shields.io/badge/license-Eclipse-brightgreen.svg)](https://github.com/eclipse/codewind-java-profiler/blob/master/LICENSE)
 
-This extension provides code highlighting showing relative time spent in Java methods based on profiling data gathered through Codewind Load Testing.
+This extension provides code highlighting showing relative time spent in Java methods based on profiling data gathered through Codewind's load testing feature.
 
 ## Usage
 
+### Prerequisites
+
+- The Eclipse Codewind extension (available [here](https://marketplace.visualstudio.com/items?itemName=IBM.codewind)) installed in Visual Studio Code.
+- A Java Liberty project bound to Codewind.
+
 With Visual Studio Code:
 
-- Open .
-- This will create profiling data in a `load-test/[timestamp]/xxxx.hcd` file in your Codewind project.
+- Open your Java Liberty Project's Performance Dashboard by right-clicking on the project in the Codewind section of Visual Studio Code and selecting `Open Performance Dashboard`.
+- Once the Performance Dashboard opens, click `Run Load Test`.
+- Once the test has completed, it will create profiling data in a `load-test/[timestamp]/xxxx.hcd` file in your Codewind project.
 - In Visual Studio Code open a Java file in your project.
 - The extension will highlight any methods which were found in the profiling data and annotate them to show the percentage of time they were running on the CPU during profiling.
 

client/src/extension.ts

@@ -18,7 +18,9 @@ import * as ip from 'ip';
 
 const docker = new Docker();
 const clientPort: number = 3333;
-const dockerImage: string = 'java-ls';
+const dockerRepo: string = 'ibmcom';
+const dockerImage: string = 'codewind-java-profiler-language-server';
+const dockerTag: string = 'latest';
 let clientServer: net.Server;
 let client: LanguageClient;
 let serverConnected = false;
@@ -60,45 +62,18 @@ export async function activate(context: ExtensionContext) {
 }
 
 async function startServerDockerContainer(dockerBinds: string[]) {
-	if(!process.env.REMOTE_SERVER) {
-		let originalContainer: Docker.Container;
-		try {
-			originalContainer = await docker.getContainer(dockerImage);
-			try {
-				await originalContainer.stop();
-			} catch (error) {
-				// don't care if already stopped
-			}
-			await originalContainer.remove();
-		} catch (error) {
-			// if it doesn't exist then try to build it
-			// TODO: host image and try to pull instead
-			const pack = tarfs.pack(path.join(__dirname, '../..', 'server'));
-
-			const stream = await docker.buildImage(pack, {t: dockerImage});
-			// wait for the build to finish
-			await new Promise((resolve, reject) => {
-				docker.modem.followProgress(stream, (err: any, res: {} | PromiseLike<{}>) => err ? reject(err) : resolve(res), (event) => {
-					// console.log(event.stream);
-				});
-			});
-		}
-
-		const container = await docker.createContainer({
-			Image: dockerImage,
-			name: dockerImage,
-			Env: [`CLIENT_PORT=${clientPort}`, `CLIENT_HOST=${ip.address()}`, `BINDS="${dockerBinds}"`],
-			HostConfig: {
-				Binds: dockerBinds
-			}
-		});
-
-		container.start();
+	try {
+		await pullDockerImage();
+		console.log('Pull completed!');
+	} catch (error) {
+		console.log('Pull failed, building from local Dockerfile');
+		await buildLocalDockerImage();
 	}
+	await startContainer(dockerBinds);
 
 	setupConnectionListeners();
-
 	const serverSocket = await waitForServerConnection();
+
 	// Connect to language server via socket
 	let result: StreamInfo = {
 			writer: serverSocket,
@@ -128,6 +103,52 @@ function waitForServerConnection() {
 	});
 }
 
+async function pullDockerImage() {
+	await removeExistingContainer();
+	await docker.pull(`${dockerRepo}/${dockerImage}:${dockerTag}`, {});
+}
+
+async function buildLocalDockerImage() {
+	try {
+		await removeExistingContainer();
+	} catch (error) {
+		// if it doesn't exist then try to build it
+		// TODO: host image and try to pull instead
+		const pack = tarfs.pack(path.join(__dirname, '../..', 'server'));
+
+		const stream = await docker.buildImage(pack, {t: dockerImage});
+		// wait for the build to finish
+		await new Promise((resolve, reject) => {
+			docker.modem.followProgress(stream, (err: any, res: {} | PromiseLike<{}>) => err ? reject(err) : resolve(res), (event) => {
+				// console.log(event.stream);
+			});
+		});
+	}
+}
+
+async function removeExistingContainer() {
+	let originalContainer: Docker.Container;
+	originalContainer = await docker.getContainer(dockerImage);
+	try {
+		await originalContainer.stop();
+	} catch (error) {
+		// don't care if already stopped
+	}
+	await originalContainer.remove();
+}
+
+async function startContainer(dockerBinds: string[]) {
+	const container = await docker.createContainer({
+		Image: dockerImage,
+		name: dockerImage,
+		Env: [`CLIENT_PORT=${clientPort}`, `CLIENT_HOST=${ip.address()}`, `BINDS="${dockerBinds}"`],
+		HostConfig: {
+			Binds: dockerBinds
+		}
+	});
+
+	container.start();
+}
 function setupConnectionListeners() {
 	// wait for the language server to connect
 	clientServer.setMaxListeners(1);

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "codewind-java-profiler",
 	"displayName": "Codewind Java Profiler",
-	"description": "Code Highlighting for Codewind's Java Load Testing",
+	"description": "Code Highlighting for Eclipse Codewind's Java Load Testing",
 	"version": "19.6.0",
 	"author": "IBM",
 	"publisher": "IBM",
@@ -16,7 +16,7 @@
 		"Profiling",
 		"Java",
 		"Load",
-		"IBM"
+		"Eclipse"
 	],
 	"icon": "res/img/codewind-logo.png",
 	"homepage": "https://www.eclipse.org/codewind/",