Update connection schema (#634)

* remove useHTTPS option

* update port setting

* remove obsolete version string

* fix connection schems, use uri format for server

* update ovsx

* remove todo

* remove limit

* empty pass by default

* update changelog

Author: ultram4rine

.devcontainer/docker-compose.yml

@@ -1,5 +1,3 @@
-version: "3.8"
-
 services:
   app:
     build:

CHANGELOG.md

@@ -13,6 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Updated connection schema, `Server` now in `uri` format. That's mean you need
+  to specify protocol (#634).
+- Removed `useHTTPS` option. If you need a `HTTPS` connection,
+  specify it in server, e.g. `https://node01.clickhouse.cloud`.
 - Updated dependencies.
 
 ## [0.6.0] - 2024-08-03

README.md

@@ -28,5 +28,3 @@ For more details see SQLTools [documentation](https://vscode-sqltools.mteixeira.
   and statistics.
 - Don't send multiple queries, this is not supported
   by SQLTools (yet).
-- Use `LIMIT` when selecting a large amount of data, otherwise the results may
-  take a long time to load.

connection.schema.json

@@ -34,7 +34,8 @@
     "server": {
       "title": "Server",
       "type": "string",
-      "default": "localhost",
+      "format": "uri",
+      "default": "http://localhost",
       "minLength": 1
     },
     "port": {
@@ -61,18 +62,13 @@
         "Use empty password",
         "Save as plaintext in settings"
       ],
-      "default": "SQLTools Driver Credentials"
+      "default": "Use empty password"
     },
     "requestTimeout": {
       "title": "Request timeout in milliseconds",
       "type": "integer",
       "default": 30000
     },
-    "useHTTPS": {
-      "title": "Use HTTPS",
-      "type": "boolean",
-      "default": false
-    },
     "enableTls": {
       "type": "boolean",
       "title": "Enable TLS",

package-lock.json

@@ -100,7 +100,7 @@
     "concurrently": "^9.0.1",
     "cross-env": "^7.0.3",
     "esbuild": "^0.24.0",
-    "ovsx": "^0.9.4",
+    "ovsx": "^0.9.5",
     "rimraf": "^6.0.1",
     "typescript": "^5.6.2"
   }

package.json

@@ -62,6 +62,13 @@ export async function activate(
     parseBeforeSaveConnection: ({ connInfo }) => {
       const propsToRemove = ["passwordMode"];
 
+      if (
+        !connInfo.server.startsWith("http://") &&
+        !connInfo.server.startsWith("https://")
+      ) {
+        connInfo.server = "http://" + connInfo.server;
+      }
+
       if (connInfo.passwordMode) {
         if (connInfo.passwordMode.toString().toLowerCase().includes("ask")) {
           connInfo.askForPassword = true;
@@ -92,6 +99,13 @@ export async function activate(
         ...connInfo,
       };
 
+      if (
+        !connInfo.server.startsWith("http://") &&
+        !connInfo.server.startsWith("https://")
+      ) {
+        formData.server = "http://" + connInfo.server;
+      }
+
       if (connInfo.askForPassword) {
         formData.passwordMode = "Ask on connect";
         delete formData.password;

src/extension.ts

@@ -50,17 +50,22 @@ export default class ClickHouseDriver
           }
         : undefined;
 
+    let server = this.credentials.server;
+    if (!server.startsWith("http://") && !server.startsWith("https://")) {
+      server = "http://" + server;
+    }
+
+    const url = new URL(server);
+    url.port = this.credentials.port.toString();
+
     const opts = {
-      url: `${this.credentials.useHTTPS ? "https" : "http"}://${
-        this.credentials.server
-      }:${this.credentials.port}`,
+      url: url,
       username: this.credentials.username,
       password: this.credentials.password,
       request_timeout: this.credentials.requestTimeout,
       application: "sqltools-clickhouse-driver",
       database: this.credentials.database,
       tls: tlsConfig,
-      // TODO: check clickhouse_settings.default_format: "JSON"
     } as ClickHouseClientConfigOptions;
 
     this.connection = Promise.resolve(createClient(opts));

src/ls/driver.ts

@@ -7,7 +7,6 @@
     "passwordMode",
     "password",
     "requestTimeout",
-    "useHTTPS",
     "enableTls",
     "tls"
   ],