Enable to set personal config file and multiple connection (#24)

* write specification on README.md

* implement personal config file

* implement switchDatabaseConnection via workspace/executeCommand

* Update README.md

Co-authored-by: Hirokazu Hata <[email protected]>

* add * at top of connection name which is connected

* fix typo

* write README how to swtich database connection

Co-authored-by: Hirokazu Hata <[email protected]>

Author: joe-re

README.md

@@ -52,42 +52,67 @@ $ sql-language-server up --method stdio
 
 ### Connect to database
 
-#### Create .sqllsrc.json on your project root
+#### Using Configuration Files
+
+There are two ways to use configuration files.
+
+- Set personal configuration file(~/.config/sql-language-server/sqllsrc.json)
+- Set project configuration file on your project root(\${YOUR_PROJECT/.sqllsrc.json})
+
+#### Example for personal configuration file
 
 - Examples
 
 ```json
 {
-  "adapter": "mysql",
-  "host": "localhost",
-  "port": 3307,
-  "user": "username",
-  "password": "password",
-  "database": "mysql-development",
-  "ssh": {
-    "user": "ubuntu",
-    "remoteHost": "ec2-xxx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
-    "dbHost": "127.0.0.1",
-    "port": 3306,
-    "identityFile": "~/.ssh/id_rsa",
-    "passphrase": "123456"
-  }
+  "connections": [
+    {
+      "name": "sql-language-server",
+      "adapter": "mysql",
+      "host": "localhost",
+      "port": 3307,
+      "user": "username",
+      "password": "password",
+      "database": "mysql-development",
+      "projectPaths": ["/Users/joe-re/src/sql-language-server"],
+      "ssh": {
+        "user": "ubuntu",
+        "remoteHost": "ec2-xxx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+        "dbHost": "127.0.0.1",
+        "port": 3306,
+        "identityFile": "~/.ssh/id_rsa",
+        "passphrase": "123456"
+      }
+    },
+    {
+      "name": "postgres-project",
+      "adapter": "prostgres",
+      "host": "localhost",
+      "port": 5432,
+      "user": "postgres",
+      "password": "pg_pass",
+      "database": "pg_test",
+      "projectPaths": ["/Users/joe-re/src/postgres_ptoject"]
+    }
+  ]
 }
 ```
 
 Please restart sql-language-server process after create .sqlrc.json.
 
 #### Parameters
 
-| Key      | Description                 | value                   | required | default                           |
-| -------- | --------------------------- | ----------------------- | -------- | --------------------------------- |
-| adapter  | Database type               | `"mysql" | "postgres"`  | true     |                                   |
-| host     | Database host               | string                  | true     |                                   |
-| port     | Database port               | string                  | false    | mysql:3306, postgres:5432         |
-| user     | Database user               | string                  | true     | mysql:"root", postgres:"postgres" |
-| password | Database password           | string                  | false    |                                   |
-| database | Database name               | string                  | false    |                                   |
-| ssh      | Settings for port fowarding | \*see below SSH section | false    |                                   |
+| Key          | Description                                                                                                               | value                   | required | default                           |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -------- | --------------------------------- |
+| name         | Connection name(free-form text)                                                                                           |                         | true     |                                   |
+| adapter      | Database type                                                                                                             | "mysql" #124; "postgres"  | true     |                                   |
+| host         | Database host                                                                                                             | string                  | true     |                                   |
+| port         | Database port                                                                                                             | string                  | false    | mysql:3306, postgres:5432         |
+| user         | Database user                                                                                                             | string                  | true     | mysql:"root", postgres:"postgres" |
+| password     | Database password                                                                                                         | string                  | false    |                                   |
+| database     | Database name                                                                                                             | string                  | false    |                                   |
+| projectPaths | Project path that you want to apply(if you don't set it configuration will not apply automatically when lsp's started up) | string[]                | false    | []                                |
+| ssh          | Settings for port fowarding                                                                                               | \*see below SSH section | false    |                                   |
 
 ##### SSH
 
@@ -101,10 +126,79 @@ Please restart sql-language-server process after create .sqlrc.json.
 | identitiFile | Identity file for ssh                    | string | false    | ~/.ssh/config/id_rsa      |
 | passphrase   | Passphrase to allow to use identity file | string | false    |                           |
 
+#### Personal confuguration file
+
+Personal configuration file is located on `~/.config/sql-language-server/.sqllsrc.json`.
+sql-language-server will try to read when it's started.
+
+#### Project confuguration file
+
+Project configuration file is located on `${YOUR_PROJECT_ROOT}/.sqllsrc.json`.
+
+All setting items are similarly to personal configuration file, with some exceptions:
+
+- Specify under `connection` property element directly(you don't need to set array)
+- You don't need to set project path.(if you set it it will be ignored)
+- It's merged to personal configuration if you have it.
+
+Example:
+```json
+{
+  "name": "postgres-project",
+  "adapter": "prostgres",
+  "host": "localhost",
+  "port": 5432,
+  "user": "postgres",
+  "database": "pg_test"
+}
+```
+
+And also if you have set personal configuration and both of them's names are matched, it's merged automatically.
+
+Personal configuration example:
+```json
+{
+  connections: [{
+    "name": "postgres-project",
+    "password": "password",
+    "ssh": {
+      "user": "ubuntu",
+      "remoteHost": "ec2-xxx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+      "dbHost": "127.0.0.1",
+      "port": 5432,
+      "identityFile": "~/.ssh/id_rsa",
+      "passphrase": "123456"
+    }
+  }]
+}
+```
+
+It will merge them as following:
+
+```json
+{
+  "name": "postgres-project",
+  "adapter": "prostgres",
+  "host": "localhost",
+  "port": 5432,
+  "user": "postgres",
+  "database": "pg_test",
+  "password": "password",
+  "ssh": {
+    "user": "ubuntu",
+    "remoteHost": "ec2-xxx-xxx-xxx-xxx.ap-southeast-1.compute.amazonaws.com",
+    "dbHost": "127.0.0.1",
+    "port": 5432,
+    "identityFile": "~/.ssh/id_rsa",
+    "passphrase": "123456"
+  }
+}
+```
+
 #### Inject envitonment variables
 
-${ssm:VARIABLE_NAME} syntax allows you to replace configuration value with environt variable.
-This is useful when you don't write actual file on configuration file.
+${env:VARIABLE_NAME} syntax allows you to replace configuration value with enviroment variable.
+This is useful when you don't write actual value on configuration file.
 
 ##### example
 
@@ -127,6 +221,22 @@ This is useful when you don't write actual file on configuration file.
 }
 ```
 
+#### Switch database connection
+
+If you have multiple connection information on personal config file, you can swtich database connection.
+
+![2020-05-25_15-23-01](https://user-images.githubusercontent.com/4954534/82788937-02f63c80-9e9c-11ea-948d-e27ee0090463.gif)
+
+
+[VSC extension](https://marketplace.visualstudio.com/items?itemName=joe-re.sql-language-server) provides `Switch database connection` command.
+
+Raw RPC param is:
+```
+method: workspace/executeCommand
+command: switchDataBaseConnection
+arguments: string(project name)
+```
+
 ### TODO
 
 - [x] SELECT

package.json

@@ -27,8 +27,17 @@
     "vscode": "^1.45.1"
   },
   "activationEvents": [
-    "onLanguage:sql"
+    "onLanguage:sql",
+    "extension.switchDatabaseConnection"
   ],
+  "contributes": {
+    "commands": [
+      {
+          "command": "extension.switchDatabaseConnection",
+          "title": "SQLLanguageServer: Switch database connection"
+      }
+    ]
+  },
   "private": true,
   "workspaces": [
     "packages/*"

packages/client/extension.ts

@@ -1,11 +1,19 @@
 import * as path from 'path'
-import { workspace, ExtensionContext } from 'vscode'
-import { LanguageClient, LanguageClientOptions, ServerOptions, TransportKind } from 'vscode-languageclient'
+import { workspace, ExtensionContext, commands, window as Window } from 'vscode'
+import {
+  LanguageClient,
+  LanguageClientOptions,
+  ServerOptions,
+  TransportKind,
+} from 'vscode-languageclient'
+import { ExecuteCommandParams } from 'vscode-languageserver-protocol'
 
 export function activate(context: ExtensionContext) {
   let serverModule = context.asAbsolutePath(path.join('packages', 'server', 'dist', 'cli.js'))
   let execArgs = ['up', '--method', 'node-ipc']
   let debugOptions = { execArgv: ["--nolazy", "--inspect=6009"] };
+  let connectionNames = []
+  let connectedConnectionName = ''
 
   let serverOptions: ServerOptions = {
     run : { module: serverModule, transport: TransportKind.ipc, args: execArgs },
@@ -14,13 +22,50 @@ export function activate(context: ExtensionContext) {
 
   let clientOptions: LanguageClientOptions = {
     documentSelector: [{scheme: 'file', language: 'sql', pattern: '**/*.sql'}],
+    diagnosticCollectionName: 'sqlLanguageServer',
     synchronize: {
       configurationSection: 'sqlLanguageServer',
       fileEvents: workspace.createFileSystemWatcher('**/.sqllsrc.json')
     }
   }
 
-  let disposable = new LanguageClient('sqlLanguageServer', 'SQL Language Server', serverOptions, clientOptions).start()
+  let client = new LanguageClient('sqlLanguageServer', 'SQL Language Server', serverOptions, clientOptions)
+  client.registerProposedFeatures()
+  const disposable = client.start()
 
+  const switchConnection = commands.registerCommand('extension.switchDatabaseConnection', async () => {
+    if (connectionNames.length === 0) {
+      Window.showWarningMessage("Need to set personal config file at first.")
+      return
+    }
+    const items = connectionNames.map(v => {
+      if (connectedConnectionName === v) {
+        return { label: `* ${v}`, value: v }
+      }
+      return { label: `  ${v}`, value: v}
+    })
+    const selected = await Window.showQuickPick(items)
+    if (!selected) {
+      return
+    }
+    const params: ExecuteCommandParams = {
+      command: 'switchDatabaseConnection',
+      arguments: [selected.value]
+    }
+    client.sendRequest('workspace/executeCommand', params)
+  })
+  context.subscriptions.push(switchConnection)
   context.subscriptions.push(disposable)
+  client.onReady().then(() => {
+    client.onNotification('sqlLanguageServer.finishSetup', (params) => {
+      connectionNames =
+        params.personalConfig?.connections?.
+          map((v: { name: string}) => v.name).
+          filter((v: string) => !!v)
+      connectedConnectionName = params.config?.name || ''
+    })
+    client.onNotification('sqlLanguageServer.error', (params) => {
+      Window.showErrorMessage(params.message)
+    })
+  })
 }