feat: implement transparent language server client (#25)

Now that `vscode-sql-notebook` has a UI for connecting to
the database, we can use that information to automatically
configure a language server to provide completion and formatting.

Until further testing shows that this is stable under more conditions,
LSP initialization is gated behind a default `false` configuration option.

Author: cmoog

.github/workflows/build.yml

@@ -11,21 +11,17 @@ on:
 jobs:
   package:
     runs-on: ubuntu-20.04
+    defaults:
+      run:
+        shell: nix develop -c bash {0}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
         with:
-          node-version: '16.x'
-      - uses: actions/cache@v2
-        with:
-          path: '**/node_modules'
-          key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.lock') }}
-      - name: Install dependencies
-        run: npm ci
-      - name: Install vsce
-        run: npm install -g vsce@1.100.0
-      - name: Package extension
-        run: vsce package --out sqlnotebook-${{ github.sha }}.vsix
+          submodules: true
+      - uses: cachix/install-nix-action@v16
+      - run: npm ci
+      - run: ./compile_sqls.fish
+      - run: npx vsce package --out sqlnotebook-${{ github.sha }}.vsix
       - name: Upload vsix as artifact
         uses: actions/upload-artifact@v1
         with:

.github/workflows/publish.yml

@@ -18,26 +18,29 @@ permissions:
 jobs:
   publish:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: nix develop -c bash {0}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
       - name: Parse version
         run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
-      - name: Install dependencies
-        run: npm ci
-      - name: Install vsce
-        run: npm install -g vsce@1.100.0
-      - name: Package extension
-        run: vsce package --out sqlnotebook-${{ env.RELEASE_VERSION }}.vsix
+      - uses: cachix/install-nix-action@v16
+      - run: npm ci
+      - run: ./compile_sqls.fish
+      - run: npx vsce package --out sqlnotebook-${{ env.RELEASE_VERSION }}.vsix
       - name: Upload vsix as artifact
         uses: actions/upload-artifact@v1
         with:
           name: sqlnotebook-${{ env.RELEASE_VERSION }}.vsix
           path: sqlnotebook-${{ env.RELEASE_VERSION }}.vsix
       - name: Publish Extension to Microsoft Marketplace
-        run: vsce publish --packagePath ./sqlnotebook-${{ env.RELEASE_VERSION }}.vsix
+        run: npx vsce publish --packagePath ./sqlnotebook-${{ env.RELEASE_VERSION }}.vsix
+        shell: nix develop -c bash {0}
         env:
           VSCE_PAT: ${{ secrets.VSCE_CREDENTIALS }}
-      - name: Install OpenVSX CLI
-        run: npm install -g ovsx
       - name: Publish to OpenVSX
         run: npx ovsx publish ./sqlnotebook-${{ env.RELEASE_VERSION }}.vsix -p ${{ secrets.OPEN_VSX_CREDENTIALS }}
+        shell: nix develop -c bash {0}

.gitignore

@@ -1,3 +1,5 @@
 out
 node_modules
 *.vsix
+sqls_bin
+sqls

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "sqls"]
+	path = sqls
+	url = https://github.com/cmoog/sqls

.vscodeignore

@@ -9,3 +9,4 @@ vsc-extension-quickstart.md
 **/*.map
 **/*.ts
 **/*.tsbuildinfo
+sqls

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
-## [Unreleased]
+## [Unreleased 0.5.0]
 
-- Initial release
+- Package `sqls` language server into `vscode-sql-notebook`.
+  - When running on a compatible arch/os, notebooks will now
+    benefit from enhacned typed autocomplete and hover information
+    when connected to a valid database connection.

compile_sqls.fish

@@ -0,0 +1,32 @@
+#!/usr/bin/env fish
+
+# This script compiles the ./sqls language server
+# into binaries for the most common ARCH/OS combinations.
+# Then, we use `upx` to compress the binary to save on
+# overall bundle size.
+# 
+# Eventually, these binaries are bundled into the final
+# .vsix asset and shipped with the extension. At runtime,
+# the extension will check if an available binary exists for
+# the given detected ARCH/OS combo. If yes, it will run it as
+# a language server to provide enhanced completion support. 
+
+
+set --local arch { arm64, amd64, 386 }
+set --local os { linux, darwin, windows }
+
+cd sqls
+
+for a in $arch
+	for o in $os
+		if [ "$o" = "darwin" -a "$a" = "386" ]
+			continue
+		end
+		echo "building sqls_"$a"_"$o
+		set --local binpath "../sqls_bin/sqls_"$a"_"$o
+		CGO_ENABLED=0 GOOS=$o GOARCH=$a go build -o $binpath -ldflags="-s -w"; or exit 1
+
+		# disable this for now, it was causing issues on arm64/darwin
+		# upx $binpath
+	end
+end

flake.nix

@@ -12,7 +12,7 @@
       in
       {
         devShell = pkgs.mkShell {
-          packages = with pkgs; [ nodejs-16_x ];
+          packages = with pkgs; [ nodejs-16_x go_1_17 fish upx ];
         };
       }
     );

package-lock.json

@@ -90,6 +90,16 @@
         }
       ]
     },
+    "configuration": {
+      "title": "SQL Notebook",
+      "properties": {
+        "SQLNotebook.useLanguageServer": {
+          "type": "boolean",
+          "default": false,
+          "description": "(Unstable) Use embeded language server for intelligent completion and hover information."
+        }
+      }
+    },
     "views": {
       "sqlnotebook": [
         {
@@ -143,10 +153,12 @@
     "fork-ts-checker-webpack-plugin": "^5.0.14",
     "glob": "^7.1.7",
     "mocha": "^9.2.0",
+    "ovsx": "^0.3.0",
     "prettier": "^2.6.0",
     "style-loader": "^1.2.1",
     "ts-loader": "^9.2.6",
     "typescript": "^4.3.2",
+    "vsce": "1.100.0",
     "vscode-notebook-error-overlay": "^1.0.1",
     "vscode-test": "^1.5.2",
     "webpack": "^5.65.0",
@@ -158,7 +170,8 @@
     "mysql2": "^2.3.0",
     "pg": "^8.7.1",
     "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "react-dom": "^17.0.2",
+    "vscode-languageclient": "^7.0.0"
   },
   "prettier": {
     "semi": true,

package.json

@@ -5,7 +5,8 @@ import {
   SQLNotebookConnections,
 } from './connections';
 import { getPool, PoolConfig } from './driver';
-import { storageKey, globalConnPool } from './extension';
+import { storageKey, globalConnPool, globalLspClient } from './extension';
+import { getCompiledLSPBinaryPath, sqlsDriverFromDriver } from './lsp';
 
 export const deleteConnectionConfiguration =
   (
@@ -72,6 +73,10 @@ export const connectToDatabase =
       const conn = await globalConnPool.pool.getConnection();
       await conn.query('SELECT 1'); // essentially a ping to see if the connection works
       connectionsSidepanel.setActive(match.name);
+      if (shouldUseLanguageServer()) {
+        startLanguageServer(match, password);
+      }
+
       vscode.window.showInformationMessage(
         `Successfully connected to "${match.name}"`
       );
@@ -80,7 +85,43 @@ export const connectToDatabase =
         // @ts-ignore
         `Failed to connect to "${match.name}": ${err.message}`
       );
+      globalLspClient.stop();
       globalConnPool.pool = null;
       connectionsSidepanel.setActive(null);
     }
   };
+
+function startLanguageServer(conn: ConnData, password?: string) {
+  try {
+    const driver = sqlsDriverFromDriver(conn.driver);
+    const binPath = getCompiledLSPBinaryPath();
+    if (!binPath)
+      throw Error('Platform not supported, language server disabled.');
+    if (driver) {
+      globalLspClient.start({
+        binPath,
+        host: conn.host,
+        port: conn.port,
+        password: password,
+        driver,
+        database: conn.database,
+        user: conn.user,
+      });
+    } else {
+      vscode.window.showWarningMessage(
+        `Driver ${conn.driver} not supported by language server. Completion support disabled.`
+      );
+    }
+  } catch (e) {
+    vscode.window.showWarningMessage(
+      `Language server failed to initialize: ${e}`
+    );
+  }
+}
+
+function shouldUseLanguageServer(): boolean {
+  return (
+    vscode.workspace.getConfiguration('SQLNotebook').get('useLanguageServer') ||
+    false
+  );
+}

sqls

@@ -4,6 +4,7 @@ import { SQLNotebookConnections } from './connections';
 import { connectToDatabase, deleteConnectionConfiguration } from './commands';
 import { Pool, ExecutionResult, TabularResult, Row } from './driver';
 import { activateFormProvider } from './form';
+import { SqlLspClient } from './lsp';
 
 const notebookType = 'sql-notebook';
 export const storageKey = 'sqlnotebook-connections';
@@ -12,6 +13,8 @@ export const globalConnPool: { pool: Pool | null } = {
   pool: null,
 };
 
+export const globalLspClient = new SqlLspClient();
+
 export function activate(context: vscode.ExtensionContext) {
   context.subscriptions.push(
     vscode.workspace.registerNotebookSerializer(

src/commands.ts

@@ -0,0 +1,88 @@
+import {
+  LanguageClient,
+  LanguageClientOptions,
+  ServerOptions,
+} from 'vscode-languageclient/node';
+import * as vscode from 'vscode';
+import { DriverKey } from './driver';
+import path = require('path');
+
+export interface LspConfig {
+  binPath: string;
+  host: string;
+  port: number;
+  user: string;
+  password?: string;
+  database?: string;
+  driver: SqlsDriver;
+}
+
+export type SqlsDriver = 'mysql' | 'postgresql' | 'mysql8' | 'sqlight3'; // TODO: complete
+
+export const sqlsDriverFromDriver = (
+  driverKey: DriverKey
+): SqlsDriver | null => {
+  switch (driverKey) {
+    case 'mysql':
+      return 'mysql';
+    case 'postgres':
+      return 'postgresql';
+  }
+  return null;
+};
+
+export function getCompiledLSPBinaryPath(): string | null {
+  const { arch, platform } = process;
+  const goarch = { arm64: 'arm64', x64: 'amd64' }[arch];
+  const goos = { linux: 'linux', darwin: 'darwin', win32: 'windows' }[
+    platform.toString()
+  ];
+  if (!goarch && !goos) return null;
+  return path.join(
+    __filename,
+    '..',
+    '..',
+    '..',
+    'sqls_bin',
+    `sqls_${goarch}_${goos}`
+  );
+}
+
+export class SqlLspClient {
+  private client: LanguageClient | null;
+  constructor() {
+    this.client = null;
+  }
+  start(config: LspConfig) {
+    let serverOptions: ServerOptions = {
+      command: config.binPath,
+      args: [],
+    };
+
+    let clientOptions: LanguageClientOptions = {
+      documentSelector: [{ language: 'sql' }],
+      initializationOptions: {
+        disableCodeAction: true,
+        connectionConfig: {
+          driver: config.driver,
+          user: config.user,
+          passwd: config.password,
+
+          host: config.host,
+          port: config.port,
+
+          dbName: config.database,
+
+          proto: 'tcp',
+        },
+      },
+      outputChannel: vscode.window.createOutputChannel('sqls'),
+    };
+
+    this.client = new LanguageClient('sqls', serverOptions, clientOptions);
+    this.client.start();
+  }
+  async stop() {
+    await this.client?.stop();
+  }
+}