add playground command #1270

m90 · 2017-10-07T18:14:13Z

Enables the user to upload the current file or selection to the go playground using package goplay.

This would solve #1211

msftclas · 2017-10-07T18:14:21Z

All CLA requirements met.

enables the user to upload the current file or selection to the go playground using package goplay - solves #1211

ramya-rao-a

@m90 This is so cool :)

I have left a few comments, please take a look

ramya-rao-a · 2017-10-18T22:48:19Z

src/goPlayground.ts

+	outputChannel.show();
+	outputChannel.appendLine('Upload to the Go Playground in progress...\n');
+
+	return uploader.upload(code, config)


why not make the call to goplay directly from here instead of going through the GoplayUploader ?

Seeing that it's a common pattern in this extension to make multiple tools available (although maybe not necessarily in that case) for the same task, I thought it'd be a good idea to separate the editor part of the command from the actual uploading. Also, it makes writing tests a lot easier. I think I'd like to keep it that way if possible.

ramya-rao-a · 2017-10-18T22:48:55Z

src/goPlayground.ts

+// it to the given `uploader`, together with the current editor selection
+// (or the full content of the editor window if the selection is empty)
+export const createCommandWith = (uploader: IPlaygroundUploader) => (): Promise<any> => {
+	const editor = vscode.window.activeTextEditor;


Show an error message if there is no active editor

ramya-rao-a · 2017-10-18T22:55:45Z

src/goPlayground.ts

+			if ((<any>err).missingTool) {
+				promptForMissingTool(err.missingTool);
+			} else {
+				vscode.window.showErrorMessage(err.message);


In the absence of the goplay tool, we end up in the else block here with the error message write EPIPE. This is because we are passing the code via stdin and the connection gets closed due to ENOENT error

There are 2 ways to fix this

Check BINARY_LOCATION is a valid absolute path. If not then dont run goplay, exit early. OR

Call goplay directly from the createCommandWith function.

Even after installing goplay, user will have to reload VSCode for the change to take affect because the location of the binary gets calculated once in the beginning and isnt updated.

Feel free to use getBinPath for every call

ramya-rao-a · 2017-10-18T23:11:30Z

src/goPlayground.ts

+		? editor.document.getText()
+		: editor.document.getText(selection);
+
+	outputChannel.show();


Clear the output channel before sending any output

m90 · 2017-10-19T07:30:41Z

@ramya-rao-a Thanks for your review. I think I should have adressed all the open issues, so feel free to take another look when it fits.

…ility by stat-ing binary location

ramya-rao-a · 2017-10-23T06:11:34Z

it's a common pattern in this extension to make multiple tools available (although maybe not necessarily in that case) for the same task

But the playground doesn't fall into this category. There is only 1 tool that can be used.

Features in the Go extension fall into 2 categories

Those that register providers and talk to VS Code apis exposed to extensions. Eg: Formatting, Completion, Definition, SignatureHelp, Hover Info, Rename etc. These follow the "implement class -> instantiate class -> use the instantiated class to register the provider" pattern
Almost all other features are registering a command and providing a callback to call when the command is executed. These follow the "define a function -> export it" pattern

In the interest of keeping similar pattern in the second category here, I'd very much appreciate it if we do not use the OOP like approach for the playground feature.

Of course, I am open to consider a refactoring on a bigger scale where we move all the other features (falling in the second category) to a OOP approach. But until then, I'd prefer to keep things similar.

m90 · 2017-10-23T07:22:58Z

I see your point re: consistency, yet this would mean that this turns into one untestable monolithic function (correct me if my thinking that capturing channel output in a test is not possible is wrong). I personally would feel a lot more confident shipping such a feature with unit tests, yet this is not my extension. I just wanted to raise awareness for that fact. I'll ping you once I've done the changes.

m90 · 2017-10-23T18:38:44Z

@ramya-rao-a As requested I merged all the code into one function for the sake of consistency.

ramya-rao-a · 2017-11-07T00:41:44Z

@m90 Thanks for your work on this.
I have refactored the code a bit to enable having the unit tests you earlier had.
In case you are interested: eb8bfdb

m90 added 4 commits October 8, 2017 12:45

add playground command

cfef8d0

enables the user to upload the current file or selection to the go playground using package goplay - solves #1211

separate tool execution from command logic, add test

49a9c9f

add tests for error case

1510598

ensure better separation between tool calling and extension logic

c22c7b7

ramya-rao-a suggested changes Oct 18, 2017

View reviewed changes

m90 added 2 commits October 19, 2017 09:34

handle no active editor, clear output channel, check for tool availab…

e7951a6

…ility by stat-ing binary location

Merge branch 'master' into playground

caaedef

move all logic into function body

9559b2c

ramya-rao-a force-pushed the master branch 3 times, most recently from 89e20b7 to 3d8a1f0 Compare November 4, 2017 19:44

Add tests back

eb8bfdb

ramya-rao-a approved these changes Nov 6, 2017

View reviewed changes

Fixing linting error

c2851f8

ramya-rao-a merged commit f71af13 into microsoft:master Nov 7, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add playground command #1270

add playground command #1270

m90 commented Oct 7, 2017 •

edited

Loading

msftclas commented Oct 7, 2017 •

edited

Loading

ramya-rao-a left a comment

ramya-rao-a Oct 18, 2017

m90 Oct 19, 2017 •

edited

Loading

ramya-rao-a Oct 18, 2017

ramya-rao-a Oct 18, 2017

ramya-rao-a Oct 18, 2017

ramya-rao-a Oct 18, 2017

m90 commented Oct 19, 2017

ramya-rao-a commented Oct 23, 2017

m90 commented Oct 23, 2017 •

edited

Loading

m90 commented Oct 23, 2017

ramya-rao-a commented Nov 7, 2017 •

edited

Loading

add playground command #1270

add playground command #1270

Conversation

m90 commented Oct 7, 2017 • edited Loading

msftclas commented Oct 7, 2017 • edited Loading

ramya-rao-a left a comment

Choose a reason for hiding this comment

ramya-rao-a Oct 18, 2017

Choose a reason for hiding this comment

m90 Oct 19, 2017 • edited Loading

Choose a reason for hiding this comment

ramya-rao-a Oct 18, 2017

Choose a reason for hiding this comment

ramya-rao-a Oct 18, 2017

Choose a reason for hiding this comment

ramya-rao-a Oct 18, 2017

Choose a reason for hiding this comment

ramya-rao-a Oct 18, 2017

Choose a reason for hiding this comment

m90 commented Oct 19, 2017

ramya-rao-a commented Oct 23, 2017

m90 commented Oct 23, 2017 • edited Loading

m90 commented Oct 23, 2017

ramya-rao-a commented Nov 7, 2017 • edited Loading

m90 commented Oct 7, 2017 •

edited

Loading

msftclas commented Oct 7, 2017 •

edited

Loading

m90 Oct 19, 2017 •

edited

Loading

m90 commented Oct 23, 2017 •

edited

Loading

ramya-rao-a commented Nov 7, 2017 •

edited

Loading