extension code + tests

Author: Dvir Yitzchaki

.vscode/launch.json

@@ -3,34 +3,39 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "runtimeExecutable": "${execPath}",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ],
-            "outFiles": [
-                "${workspaceFolder}/out/**/*.js"
-            ],
-            "preLaunchTask": "npm: watch"
-        },
-        {
-            "name": "Extension Tests",
-            "type": "extensionHost",
-            "request": "launch",
-            "runtimeExecutable": "${execPath}",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}",
-                "--extensionTestsPath=${workspaceFolder}/out/test"
-            ],
-            "outFiles": [
-                "${workspaceFolder}/out/test/**/*.js"
-            ],
-            "preLaunchTask": "npm: watch"
-        }
-    ]
-}
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "${workspaceFolder}/src/test/workspace/test.code-workspace",
+        "--extensionDevelopmentPath=${workspaceFolder}"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/out/**/*.js"
+      ],
+      "preLaunchTask": "npm: watch",
+      "env": {
+        "PATH": "bla"
+      }
+    },
+    {
+      "name": "Extension Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "runtimeExecutable": "${execPath}",
+      "args": [
+        "${workspaceFolder}/src/test/workspace/test.code-workspace",
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--extensionTestsPath=${workspaceFolder}/out/test"
+      ],
+      "outFiles": [
+        "${workspaceFolder}/out/test/**/*.js"
+      ],
+      "preLaunchTask": "npm: watch"
+    }
+  ]
+}

package.json

@@ -1,38 +1,49 @@
 {
-    "name": "parquet-viewer",
-    "displayName": "parquet-viewer",
-    "description": "View Apache Parquet files as JSON",
-    "version": "0.0.1",
-    "engines": {
-        "vscode": "^1.30.0"
-    },
-    "categories": [
-        "Other"
-    ],
-    "activationEvents": [
-        "onCommand:extension.sayHello"
-    ],
-    "main": "./out/extension",
-    "contributes": {
-        "commands": [
-            {
-                "command": "extension.sayHello",
-                "title": "Hello World"
-            }
+  "name": "parquet-viewer",
+  "displayName": "parquet-viewer",
+  "description": "Views Apache Parquet files as JSON",
+  "publisher": "dvirtz",
+  "version": "0.0.1",
+  "engines": {
+    "vscode": "^1.30.0"
+  },
+  "categories": [
+    "Other"
+  ],
+  "activationEvents": [
+    "onLanguage:parquet",
+    "onFileSystem:file"
+  ],
+  "main": "./out/extension",
+  "contributes": {
+    "languages": [
+      {
+        "id": "parquet",
+        "extensions": [
+          ".parquet"
         ]
-    },
-    "scripts": {
-        "vscode:prepublish": "npm run compile",
-        "compile": "tsc -p ./",
-        "watch": "tsc -watch -p ./",
-        "postinstall": "node ./node_modules/vscode/bin/install",
-        "test": "npm run compile && node ./node_modules/vscode/bin/test"
-    },
-    "devDependencies": {
-        "typescript": "^3.1.4",
-        "vscode": "^1.1.25",
-        "tslint": "^5.8.0",
-        "@types/node": "^8.10.25",
-        "@types/mocha": "^2.2.42"
-    }
-}
+      }
+    ],
+    "commands": [
+      {
+        "command": "extension.viewParquetAsJson",
+        "category": "Parquet",
+        "title": "View as JSON"
+      }
+    ]
+  },
+  "scripts": {
+    "vscode:prepublish": "npm run compile",
+    "compile": "tsc -p ./",
+    "watch": "tsc -watch -p ./",
+    "postinstall": "node ./node_modules/vscode/bin/install",
+    "test": "npm run compile && node ./node_modules/vscode/bin/test"
+  },
+  "devDependencies": {
+    "typescript": "^3.1.4",
+    "vscode": "^1.1.25",
+    "tslint": "^5.8.0",
+    "@types/node": "^8.10.25",
+    "@types/mocha": "^2.2.42"
+  }
+}

src/extension.ts

@@ -2,26 +2,44 @@
 // The module 'vscode' contains the VS Code extensibility API
 // Import the module and reference it with the alias vscode in your code below
 import * as vscode from 'vscode';
+import { ParquetContentProvider } from './parquet_content_provider';
+import { execFile } from 'child_process';
 
 // this method is called when your extension is activated
 // your extension is activated the very first time the command is executed
 export function activate(context: vscode.ExtensionContext) {
+  console.log('parquet-viewer activated');
 
-    // Use the console to output diagnostic information (console.log) and errors (console.error)
-    // This line of code will only be executed once when your extension is activated
-    console.log('Congratulations, your extension "parquet-viewer" is now active!');
+  execFile('parquet-tools', ['-h'], err => {
+      vscode.window.showErrorMessage('parquet-tools not in PATH');
+  });
 
-    // The command has been defined in the package.json file
-    // Now provide the implementation of the command with  registerCommand
-    // The commandId parameter must match the command field in package.json
-    let disposable = vscode.commands.registerCommand('extension.sayHello', () => {
-        // The code you place here will be executed every time your command is executed
+  const scheme = 'parquet';
+  const provider = new ParquetContentProvider();
 
-        // Display a message box to the user
-        vscode.window.showInformationMessage('Hello World!');
-    });
+  context.subscriptions.push(vscode.workspace.registerTextDocumentContentProvider(scheme, provider));
 
-    context.subscriptions.push(disposable);
+  let onFile = function (document: vscode.TextDocument) {
+    if (document.fileName.endsWith('parquet') && document.uri.scheme !== scheme) {
+      let uri = vscode.Uri.parse(scheme + '://' + document.uri.path);
+      vscode.window.showTextDocument(uri, { preview: true, viewColumn: vscode.window.activeTextEditor!.viewColumn });
+    }
+  };
+
+  context.subscriptions.push(vscode.commands.registerTextEditorCommand('extension.viewParquetAsJson', (textEditor) => {
+    let document = textEditor.document;
+    if (!document.fileName.endsWith('parquet')) {
+      vscode.window.showErrorMessage("Please open a parquet file");
+      return; // no editor
+    }
+    onFile(document);
+  }));
+
+  context.subscriptions.push(vscode.workspace.onDidOpenTextDocument(onFile));
+
+  if (vscode.window.activeTextEditor) {
+    onFile(vscode.window.activeTextEditor.document);
+  }
 }
 
 // this method is called when your extension is deactivated

src/parquet_content_provider.ts

@@ -0,0 +1,24 @@
+import { TextDocumentContentProvider, EventEmitter, Uri, window } from "vscode";
+import { exec } from "child_process";
+
+export class ParquetContentProvider implements TextDocumentContentProvider {
+
+  // emitter and its event
+  onDidChangeEmitter = new EventEmitter<Uri>();
+  onDidChange = this.onDidChangeEmitter.event;
+
+  async provideTextDocumentContent(uri: Uri): Promise<string> {
+    // simply invoke cowsay, use uri-path as text
+    return new Promise<string>((resolve, reject) => {
+      exec('parquet-tools cat -j ' + uri.path, (error, stdout, stderr) => {
+        if (error) {
+          const message = `error when running parquet-tools ${error}:\n${stderr}`;
+          window.showErrorMessage(message);
+          reject(message);
+        }
+
+        resolve(stdout);
+      });
+    });
+  }
+}

src/test/extension.test.ts

@@ -8,15 +8,14 @@ import * as assert from 'assert';
 
 // You can import and use all API from the 'vscode' module
 // as well as import your extension to test it
-// import * as vscode from 'vscode';
+import * as vscode from 'vscode';
 // import * as myExtension from '../extension';
 
 // Defines a Mocha test suite to group tests of similar kind together
-suite("Extension Tests", function () {
+suite("Parquet extension tests", function () {
 
-    // Defines a Mocha unit test
-    test("Something 1", function() {
-        assert.equal(-1, [1, 2, 3].indexOf(5));
-        assert.equal(-1, [1, 2, 3].indexOf(0));
-    });
+  test("Should find extension", async () => {
+    const extension = await vscode.extensions.getExtension("dvirtz.parquet-viewer");
+    assert(extension);
+  });
 });

src/test/provider.test.ts

@@ -0,0 +1,31 @@
+
+import * as assert from 'assert';
+
+import { ParquetContentProvider } from "../parquet_content_provider";
+import { getUri, fileRead } from './utils';
+import { Uri } from 'vscode';
+
+suite("Provider tests", () => {
+
+  test("Parquet to JSON", async () => {
+    const provider = new ParquetContentProvider();
+    const json = getUri("small.parquet").then(parquet => {
+      return provider.provideTextDocumentContent(parquet);
+    });
+    const expected = fileRead("small.json");
+
+    return Promise.all([json, expected]).then(values => {
+      assert.strictEqual(values[0], values[1]);
+    });
+  });
+
+  test("Error on not existing file", async () => {
+    const provider = new ParquetContentProvider();
+
+    return provider.provideTextDocumentContent(Uri.parse("file://.")).then(data => {
+        assert(false, "should not get here");
+      }, (error: string) => {
+        assert(error.indexOf('error when running parquet-tools') !== -1);
+      });
+  });
+});

src/test/utils.ts

@@ -0,0 +1,21 @@
+import * as assert from 'assert';
+import { Uri, workspace } from "vscode";
+import { readFile } from 'fs';
+
+export async function getUri(fileName: String): Promise<Uri> {
+
+  const testFiles = await workspace.findFiles(`**/${fileName}`);
+  assert.equal(testFiles.length, 1);
+  return testFiles[0];
+}
+
+export async function fileRead(fileName: string): Promise<string> {
+  return getUri(fileName).then(uri => {
+    return new Promise<string>(resolve => {
+      readFile(uri.path, 'utf8', (err, data) => {
+        assert.ifError(err);
+        resolve(data);
+      });
+    });
+  });
+}

src/test/workspace/small.json

@@ -0,0 +1,2 @@
+{"number":1,"letter":"a"}
+{"number":2,"letter":"b"}

src/test/workspace/small.parquet

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+  ],
+  "settings": {}
+}