Fix CI, examples, bump CH to 25.8 (#456)

slvrtrn · web-flow · commit bd8f1830cd46 · 2025-09-02T20:16:50.000+02:00
diff --git a/.docker/clickhouse/single_node_tls/Dockerfile b/.docker/clickhouse/single_node_tls/Dockerfile
@@ -1,4 +1,4 @@
-FROM clickhouse/clickhouse-server:25.7-alpine
+FROM clickhouse/clickhouse-server:25.8-alpine
 COPY .docker/clickhouse/single_node_tls/certificates /etc/clickhouse-server/certs
 RUN chown clickhouse:clickhouse -R /etc/clickhouse-server/certs \
     && chmod 600 /etc/clickhouse-server/certs/* \
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -193,7 +193,7 @@ jobs:
         run: |
           npm run test:web:integration:local_cluster
 
-  node-integration-tests-cloud-smt:
+  node-integration-tests-cloud:
     needs: node-unit-tests
     runs-on: ubuntu-latest
     strategy:
@@ -219,9 +219,9 @@ jobs:
           CLICKHOUSE_CLOUD_PASSWORD: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_PASSWORD_SMT }}
           CLICKHOUSE_CLOUD_JWT_ACCESS_TOKEN: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_JWT_DESERT_VM_43 }}
         run: |
-          npm run test:node:integration:cloud_smt
+          npm run test:node:integration:cloud
 
-  web-integration-tests-cloud-smt:
+  web-integration-tests-cloud:
     needs: node-unit-tests
     runs-on: ubuntu-latest
     steps:
@@ -241,15 +241,15 @@ jobs:
           CLICKHOUSE_CLOUD_HOST: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_HOST_SMT }}
           CLICKHOUSE_CLOUD_PASSWORD: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_PASSWORD_SMT }}
         run: |
-          npm run test:web:integration:cloud_smt
+          npm run test:web:integration:cloud
 
       - name: Run JWT auth integration tests
         env:
           CLICKHOUSE_CLOUD_HOST: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_HOST_SMT }}
           CLICKHOUSE_CLOUD_PASSWORD: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_PASSWORD_SMT }}
           CLICKHOUSE_CLOUD_JWT_ACCESS_TOKEN: ${{ secrets.INTEGRATIONS_TEAM_TESTS_CLOUD_JWT_DESERT_VM_43 }}
         run: |
-          npm run test:web:integration:cloud_smt:jwt
+          npm run test:web:integration:cloud:jwt
 
   # With unit + integration + TLS tests + coverage + Codecov.io upload, after the rest of the tests.
   # Needs all integration tests on all environments to pass.
@@ -259,10 +259,10 @@ jobs:
       [
         'node-integration-tests-local-single-node',
         'node-integration-tests-local-cluster',
-        'node-integration-tests-cloud-smt',
+        'node-integration-tests-cloud',
         'web-all-tests-local-single-node',
         'web-integration-tests-local-cluster',
-        'web-integration-tests-cloud-smt',
+        'web-integration-tests-cloud',
       ]
     runs-on: ubuntu-latest
 
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+22
diff --git a/.scripts/generate_cloud_jwt.ts b/.scripts/generate_cloud_jwt.ts
@@ -1,7 +1,7 @@
 import { makeJWT } from '../packages/client-node/__tests__/utils/jwt'
 
 /** Used to generate a JWT token for web testing (can't use `jsonwebtoken` library directly there)
- *  See `package.json` -> `scripts` -> `test:web:integration:cloud_smt:jwt` */
+ *  See `package.json` -> `scripts` -> `test:web:integration:cloud:jwt` */
 ;(() => {
   console.log(makeJWT())
 })()
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -35,6 +35,14 @@ See [tls.test.ts](packages/client-node/__tests__/tls/tls.test.ts) for more detai
 sudo -- sh -c "echo 127.0.0.1 server.clickhouseconnect.test >> /etc/hosts"
 ```
 
+### IDE setup
+
+#### WebStorm
+
+- Open settings
+- Navigate to "Languages & Frameworks" -> "Typescript"
+- Copy and paste `--project tsconfig.dev.json` into the options field to enable proper path resolution in tests
+
 ## Style Guide
 
 We use an automatic code formatting with `prettier` and `eslint`, both should be installed after running `npm i`.
diff --git a/docker-compose.cluster.yml b/docker-compose.cluster.yml
@@ -2,7 +2,7 @@ version: '2.3'
 
 services:
   clickhouse1:
-    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-25.7-alpine}'
+    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-25.8-alpine}'
     ulimits:
       nofile:
         soft: 262144
@@ -21,7 +21,7 @@ services:
       - './.docker/clickhouse/users.xml:/etc/clickhouse-server/users.xml'
 
   clickhouse2:
-    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-25.7-alpine}'
+    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-25.8-alpine}'
     ulimits:
       nofile:
         soft: 262144
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,7 +1,7 @@
 #version: '3.8'
 services:
   clickhouse:
-    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-25.7-alpine}'
+    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-25.8-alpine}'
     container_name: 'clickhouse-js-clickhouse-server'
     environment:
       CLICKHOUSE_SKIP_USER_SETUP: 1
diff --git a/examples/clickhouse_settings.ts b/examples/clickhouse_settings.ts
@@ -22,7 +22,8 @@ void (async () => {
      * {@link ClickHouseClient.command},
      * or {@link ClickHouseClient.exec} operation.*/
     clickhouse_settings: {
-      output_format_json_quote_64bit_integers: 0,
+      // default is 0 since 25.8
+      output_format_json_quote_64bit_integers: 1,
     },
   })
   console.info(await rows.json())
diff --git a/examples/dynamic_variant_json.ts b/examples/dynamic_variant_json.ts
@@ -3,12 +3,18 @@ import { createClient } from '@clickhouse/client' // or '@clickhouse/client-web'
 void (async () => {
   const tableName = `chjs_dynamic_variant_json`
   const client = createClient({
+    // Since 25.3, all these types are no longer experimental and are enabled by default
+    // However, if you are using an older version of ClickHouse, you might need these settings
+    // to be able to create tables with such columns.
     clickhouse_settings: {
-      // Since ClickHouse 24.1
+      // Variant was introduced in ClickHouse 24.1
+      // https://clickhouse.com/docs/sql-reference/data-types/variant
       allow_experimental_variant_type: 1,
-      // Since ClickHouse 24.5
+      // Dynamic was introduced in ClickHouse 24.5
+      // https://clickhouse.com/docs/sql-reference/data-types/dynamic
       allow_experimental_dynamic_type: 1,
-      // Since ClickHouse 24.8
+      // (New) JSON was introduced in ClickHouse 24.8
+      // https://clickhouse.com/docs/sql-reference/data-types/newjson
       allow_experimental_json_type: 1,
     },
   })
@@ -38,9 +44,9 @@ void (async () => {
     {
       id: 2,
       var: 'str',
-      // defaults to Int64; will be represented as a string in JSON* family formats
-      // this behavior can be changed with `output_format_json_quote_64bit_integers` setting (default is 1).
-      // see https://clickhouse.com/docs/en/operations/settings/formats#output_format_json_quote_64bit_integers
+      // A number will default to Int64; it could be also represented as a string in JSON* family formats
+      // using `output_format_json_quote_64bit_integers` setting (default is 0 since CH 25.8).
+      // See https://clickhouse.com/docs/en/operations/settings/formats#output_format_json_quote_64bit_integers
       dynamic: 144,
       json: {
         bar: 10,
diff --git a/examples/session_level_commands.ts b/examples/session_level_commands.ts
@@ -1,6 +1,10 @@
 import { createClient } from '@clickhouse/client' // or '@clickhouse/client-web'
 import * as crypto from 'crypto' // required for Node.js only
 
+// Note that session will work as expected ONLY if you are accessing the Node directly.
+// If there is a load-balancer in front of ClickHouse nodes, the requests might end up on different nodes,
+// and the session will not be preserved. As a workaround for ClickHouse Cloud, you could try replica-aware routing.
+// See https://clickhouse.com/docs/manage/replica-aware-routing.
 void (async () => {
   const client = createClient({
     // with session_id defined, SET and other session commands
diff --git a/package.json b/package.json
@@ -34,13 +34,11 @@
     "test:node:integration": ".scripts/jasmine.sh jasmine.node.integration.json",
     "test:node:integration:local_cluster": "CLICKHOUSE_TEST_ENVIRONMENT=local_cluster npm run test:node:integration",
     "test:node:integration:cloud": "CLICKHOUSE_TEST_ENVIRONMENT=cloud npm run test:node:integration",
-    "test:node:integration:cloud_smt": "CLICKHOUSE_TEST_ENVIRONMENT=cloud_smt npm run test:node:integration",
     "test:node:coverage": "nyc npm run test",
     "test:web": "karma start karma.config.cjs",
     "test:web:integration:local_cluster": "CLICKHOUSE_TEST_ENVIRONMENT=local_cluster npm run test:web",
     "test:web:integration:cloud": "CLICKHOUSE_TEST_ENVIRONMENT=cloud npm run test:web",
-    "test:web:integration:cloud_smt": "CLICKHOUSE_TEST_ENVIRONMENT=cloud_smt npm run test:web",
-    "test:web:integration:cloud_smt:jwt": "karma start karma.config.jwt.cjs",
+    "test:web:integration:cloud:jwt": "karma start karma.config.jwt.cjs",
     "prepare": "husky"
   },
   "devDependencies": {
diff --git a/packages/client-common/__tests__/fixtures/read_only_user.ts b/packages/client-common/__tests__/fixtures/read_only_user.ts
@@ -15,7 +15,7 @@ export async function createReadOnlyUser(client: ClickHouseClient) {
   let grant: string
   switch (env) {
     // requires select_sequential_consistency = 1 for immediate selects after inserts
-    case TestEnv.CloudSMT:
+    case TestEnv.Cloud:
       createUser = `
           CREATE USER ${username}
           IDENTIFIED WITH sha256_password BY '${password}'
@@ -28,8 +28,6 @@ export async function createReadOnlyUser(client: ClickHouseClient) {
           TO ${username}
         `
       break
-    // we do not need 'ON CLUSTER' in the cloud, so it's the same as a local docker
-    case TestEnv.Cloud:
     case TestEnv.LocalSingleNode:
       createUser = `
           CREATE USER ${username}
diff --git a/packages/client-common/__tests__/fixtures/simple_table.ts b/packages/client-common/__tests__/fixtures/simple_table.ts
@@ -24,7 +24,6 @@ export function createSimpleTable<Stream = unknown>(
       // ENGINE can be omitted in the cloud statements:
       // it will use ReplicatedMergeTree and will add ON CLUSTER as well
       case TestEnv.Cloud:
-      case TestEnv.CloudSMT:
         return `
           CREATE TABLE ${tableName}
           (id UInt64, name String, sku Array(UInt8))
@@ -54,7 +53,6 @@ export function createSimpleTable<Stream = unknown>(
 function filterSettingsBasedOnEnv(settings: MergeTreeSettings, env: TestEnv) {
   switch (env) {
     case TestEnv.Cloud:
-    case TestEnv.CloudSMT:
       // ClickHouse Cloud does not like this particular one
       // Local cluster, however, does.
       if ('non_replicated_deduplication_window' in settings) {
diff --git a/packages/client-common/__tests__/fixtures/table_with_fields.ts b/packages/client-common/__tests__/fixtures/table_with_fields.ts
@@ -18,7 +18,6 @@ export async function createTableWithFields(
         // ENGINE can be omitted in the cloud statements:
         // it will use ReplicatedMergeTree and will add ON CLUSTER as well
         case TestEnv.Cloud:
-        case TestEnv.CloudSMT:
           return `
             CREATE TABLE ${tableName}
             (id UInt32, ${fields})
diff --git a/packages/client-common/__tests__/integration/exec_and_command.test.ts b/packages/client-common/__tests__/integration/exec_and_command.test.ts
@@ -149,21 +149,13 @@ function getDDL(): {
   switch (env) {
     // ENGINE and ON CLUSTER can be omitted in the cloud statements.
     // It will use Shared (CloudSMT)/Replicated (Cloud) MergeTree by default.
-    case TestEnv.CloudSMT: {
-      const ddl = `
-        CREATE TABLE ${tableName}
-        (id UInt64, name String, sku Array(UInt8), timestamp DateTime)
-        ORDER BY (id)
-      `
-      return { ddl, tableName, engine: 'SharedMergeTree' }
-    }
     case TestEnv.Cloud: {
       const ddl = `
         CREATE TABLE ${tableName}
         (id UInt64, name String, sku Array(UInt8), timestamp DateTime)
         ORDER BY (id)
       `
-      return { ddl, tableName, engine: 'ReplicatedMergeTree' }
+      return { ddl, tableName, engine: 'SharedMergeTree' }
     }
     case TestEnv.LocalSingleNode: {
       const ddl = `
diff --git a/packages/client-common/__tests__/integration/read_only_user.test.ts b/packages/client-common/__tests__/integration/read_only_user.test.ts
@@ -35,6 +35,7 @@ describe('read only user', () => {
         // might be fixed by https://github.com/ClickHouse/ClickHouse/issues/40244
         insert_quorum: undefined,
         database_replicated_enforce_synchronous_settings: undefined,
+        output_format_json_quote_64bit_integers: undefined,
       },
     })
   })
@@ -52,10 +53,10 @@ describe('read only user', () => {
   it('should select some data without issues', async () => {
     const result = await client
       .query({
-        query: `SELECT * FROM ${tableName}`,
+        query: `SELECT name, sku FROM ${tableName}`,
       })
       .then((r) => r.json())
-    expect(result.data).toEqual([{ id: '42', name: 'hello', sku: [0, 1] }])
+    expect(result.data).toEqual([{ name: 'hello', sku: [0, 1] }])
   })
 
   it('should fail to create a table', async () => {
diff --git a/packages/client-common/__tests__/utils/client.ts b/packages/client-common/__tests__/utils/client.ts
@@ -36,13 +36,13 @@ export function createTestClient<Stream = unknown>(
   config: BaseClickHouseClientConfigOptions = {},
 ): ClickHouseClient<Stream> {
   const env = getClickHouseTestEnvironment()
-  const clickHouseSettings: ClickHouseSettings = {}
+  const clickHouseSettings: ClickHouseSettings = {
+    // (U)Int64 are not quoted by default since 25.8
+    output_format_json_quote_64bit_integers: 1,
+  }
   if (env === TestEnv.LocalCluster) {
     clickHouseSettings.insert_quorum = '2'
   } else if (env === TestEnv.Cloud) {
-    clickHouseSettings.insert_quorum = '3'
-    clickHouseSettings.database_replicated_enforce_synchronous_settings = 1
-  } else if (env === TestEnv.CloudSMT) {
     clickHouseSettings.select_sequential_consistency = '1'
   }
   // Allow to override `insert_quorum` if necessary
diff --git a/packages/client-common/__tests__/utils/test_env.ts b/packages/client-common/__tests__/utils/test_env.ts
@@ -1,6 +1,5 @@
 export enum TestEnv {
   Cloud = 'cloud',
-  CloudSMT = 'cloud_smt',
   LocalSingleNode = 'local_single_node',
   LocalCluster = 'local_cluster',
 }
@@ -12,9 +11,6 @@ export function getClickHouseTestEnvironment(): TestEnv {
     case 'cloud':
       env = TestEnv.Cloud
       break
-    case 'cloud_smt':
-      env = TestEnv.CloudSMT
-      break
     case 'local_cluster':
       env = TestEnv.LocalCluster
       break
@@ -26,7 +22,7 @@ export function getClickHouseTestEnvironment(): TestEnv {
     default:
       throw new Error(
         `Unexpected CLICKHOUSE_TEST_ENVIRONMENT value: ${value}. ` +
-          'Possible options: `local_single_node`, `local_cluster`, `cloud`, `cloud_smt`. ' +
+          'Possible options: `local_single_node`, `local_cluster`, `cloud`. ' +
           'You can keep it unset to fall back to `local_single_node`',
       )
   }
@@ -35,5 +31,5 @@ export function getClickHouseTestEnvironment(): TestEnv {
 
 export function isCloudTestEnv(): boolean {
   const env = getClickHouseTestEnvironment()
-  return env === TestEnv.Cloud || env === TestEnv.CloudSMT
+  return env === TestEnv.Cloud
 }
diff --git a/packages/client-node/__tests__/integration/node_jwt_auth.test.ts b/packages/client-node/__tests__/integration/node_jwt_auth.test.ts
@@ -3,7 +3,7 @@ import { EnvKeys, getFromEnv } from '@test/utils/env'
 import { createClient } from '../../src'
 import type { NodeClickHouseClient } from '../../src/client'
 
-whenOnEnv(TestEnv.CloudSMT).describe('[Node.js] JWT auth', () => {
+whenOnEnv(TestEnv.Cloud).describe('[Node.js] JWT auth', () => {
   let jwtClient: NodeClickHouseClient
   let url: string
   let jwt: string
diff --git a/packages/client-node/__tests__/integration/node_summary.test.ts b/packages/client-node/__tests__/integration/node_summary.test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM clickhouse/clickhouse-server:25.7-alpine`
	`1`	`+FROM clickhouse/clickhouse-server:25.8-alpine`
`2`	`2`	`COPY .docker/clickhouse/single_node_tls/certificates /etc/clickhouse-server/certs`
`3`	`3`	`RUN chown clickhouse:clickhouse -R /etc/clickhouse-server/certs \`
`4`	`4`	`&& chmod 600 /etc/clickhouse-server/certs/* \`