[FIXUP] more fixes re config compat

Author: mcheshkov

packages/cubejs-clickhouse-driver/src/ClickHouseDriver.ts

@@ -28,7 +28,7 @@ import {
 import * as process from "node:process";
 import { Readable } from 'node:stream';
 import { ClickHouseClient, createClient } from '@clickhouse/client';
-import type { ResponseJSON } from '@clickhouse/client';
+import type { ClickHouseSettings, ResponseJSON } from '@clickhouse/client';
 import genericPool from 'generic-pool';
 import type { Factory, Pool } from 'generic-pool';
 import { v4 as uuidv4 } from 'uuid';
@@ -64,12 +64,11 @@ const ClickhouseTypeToGeneric: Record<string, string> = {
 export interface ClickHouseDriverOptions {
   host?: string,
   port?: string,
-  auth?: string,
+  username?: string,
+  password?: string,
   protocol?: string,
   database?: string,
   readOnly?: boolean,
-  // TODO how to treat this in a BC way?
-  // queryOptions?: object,
 
   /**
    * Data source name.
@@ -107,11 +106,9 @@ type ClickHouseDriverConfig = {
   username: string,
   password: string,
   readOnly: boolean,
-  // TODO why separate object?
-  queryOptions: {
-    database: string,
-  },
+  database: string,
   exportBucket: ClickhouseDriverExportAWS | null,
+  clickhouseSettings: ClickHouseSettings,
 };
 
 export class ClickHouseDriver extends BaseDriver implements DriverInterface {
@@ -140,75 +137,44 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
       testConnectionTimeout: config.testConnectionTimeout,
     });
 
-    const dataSource =
-      config.dataSource ||
-      assertDataSource('default');
-
-    // TODO recheck everything in config for new driver
+    const dataSource = config.dataSource ?? assertDataSource('default');
     const host = config.host ?? getEnv('dbHost', { dataSource });
     const port = config.port ?? getEnv('dbPort', { dataSource }) ?? 8123;
     const protocol = config.protocol ?? getEnv('dbSsl', { dataSource }) ? 'https:' : 'http:';
-    // TODO proper value here, with proper back compat, and treating protocol
     const url = `${protocol}//${host}:${port}`;
     // TODO drop this
     console.log('ClickHouseDriver will use url', url);
 
-    // TODO parse username and apssword from config.auth, from a string like this:
-    // `${getEnv('dbUser', { dataSource })}:${getEnv('dbPass', { dataSource })}`
-
     const username = getEnv('dbUser', { dataSource });
     const password = getEnv('dbPass', { dataSource });
-    const database = (getEnv('dbName', { dataSource }) as string) ||
-      config && config.database ||
-      'default';
+    const database = config.database ?? (getEnv('dbName', { dataSource }) as string) ?? 'default';
+
+    // TODO this is a bit inconsistent with readOnly
+    this.readOnlyMode =
+      getEnv('clickhouseReadOnly', { dataSource }) === 'true';
+
     this.config = {
-      // host: getEnv('dbHost', { dataSource }),
-      // port: getEnv('dbPort', { dataSource }),
       url,
-      // auth:
-      //   getEnv('dbUser', { dataSource }) ||
-      //   getEnv('dbPass', { dataSource })
-      //     ? `${
-      //       getEnv('dbUser', { dataSource })
-      //     }:${
-      //       getEnv('dbPass', { dataSource })
-      //     }`
-      //     : '',
       username,
       password,
-      // protocol: getEnv('dbSsl', { dataSource }) ? 'https:' : 'http:',
-      queryOptions: {
-        database,
-      },
+      database,
       exportBucket: this.getExportBucket(dataSource),
       readOnly: !!config.readOnly,
-      ...config
+      clickhouseSettings: {
+        // If ClickHouse user's permissions are restricted with "readonly = 1",
+        // change settings queries are not allowed. Thus, "join_use_nulls" setting
+        // can not be changed
+        ...(this.readOnlyMode ? {} : { join_use_nulls: 1 }),
+      },
     };
 
-    this.readOnlyMode =
-      getEnv('clickhouseReadOnly', { dataSource }) === 'true';
-
     this.connectionFactory = {
       create: async () => createClient({
-        // ...this.config,
-
         url: this.config.url,
         username: this.config.username,
         password: this.config.password,
-
-        database: this.config.queryOptions.database,
-        session_id: uuidv4(),
-        clickhouse_settings: {
-          //
-          //
-          // If ClickHouse user's permissions are restricted with "readonly = 1",
-          // change settings queries are not allowed. Thus, "join_use_nulls" setting
-          // can not be changed
-          //
-          //
-          ...(this.readOnlyMode ? {} : { join_use_nulls: 1 }),
-        },
-
+        database: this.config.database,
+        clickhouse_settings: this.config.clickhouseSettings,
         // TODO max_open_connections vs generic pool
         max_open_connections: 1,
       }),
@@ -320,17 +286,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
         await connection.command({
           query: formattedQuery,
           query_id: queryId,
-          clickhouse_settings: {
-            //
-            //
-            // If ClickHouse user's permissions are restricted with "readonly = 1",
-            // change settings queries are not allowed. Thus, "join_use_nulls" setting
-            // can not be changed
-            //
-            //
-            // TODO extract join_use_nulls preparation to function
-            ...(this.readOnlyMode ? {} : { join_use_nulls: 1 }),
-          },
+          clickhouse_settings: this.config.clickhouseSettings,
         });
 
         return {
@@ -342,16 +298,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
         query: formattedQuery,
         query_id: queryId,
         format: 'JSON',
-        clickhouse_settings: {
-          //
-          //
-          // If ClickHouse user's permissions are restricted with "readonly = 1",
-          // change settings queries are not allowed. Thus, "join_use_nulls" setting
-          // can not be changed
-          //
-          //
-          ...(this.readOnlyMode ? {} : { join_use_nulls: 1 }),
-        },
+        clickhouse_settings: this.config.clickhouseSettings,
       });
       console.log("queryResponse resultSet", query, resultSet.query_id, resultSet.response_headers);
 
@@ -407,7 +354,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
              database as table_schema,
              type as data_type
         FROM system.columns
-       WHERE database = '${this.config.queryOptions.database}'
+       WHERE database = '${this.config.database}'
     `;
   }
 
@@ -442,7 +389,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
   }
 
   public override async getSchemas(): Promise<QuerySchemasResult[]> {
-    return [{ schema_name: this.config.queryOptions.database }];
+    return [{ schema_name: this.config.database }];
   }
 
   public async stream(
@@ -464,16 +411,7 @@ export class ClickHouseDriver extends BaseDriver implements DriverInterface {
         query: formattedQuery,
         query_id: uuidv4(),
         format: 'JSONCompactEachRowWithNamesAndTypes',
-        clickhouse_settings: {
-          //
-          //
-          // If ClickHouse user's permissions are restricted with "readonly = 1",
-          // change settings queries are not allowed. Thus, "join_use_nulls" setting
-          // can not be changed
-          //
-          //
-          ...(this.readOnlyMode ? {} : { join_use_nulls: 1 }),
-        }
+        clickhouse_settings: this.config.clickhouseSettings,
       });
       // Array<unknown> is okay, because we use fixed JSONCompactEachRowWithNamesAndTypes format
       // And each row after first two will look like this: [42, "hello", [0,1]]