node_summary.test.ts

import type { ClickHouseClient } from '@clickhouse/client-common'
import { createSimpleTable } from '@test/fixtures/simple_table'
import { jsonValues } from '@test/fixtures/test_data'
import { createTestClient, guid, TestEnv, whenOnEnv } from '@test/utils'
import type Stream from 'stream'

// FIXME: figure out if we can get non-flaky assertion with an SMT Cloud instance.
//  It could be that it requires full quorum settings for non-flaky assertions.
//  SharedMergeTree Cloud instance is auto by default (and cannot be modified).
whenOnEnv(
  TestEnv.LocalSingleNode,
  TestEnv.LocalCluster,
  TestEnv.Cloud,
).describe('[Node.js] Summary header parsing', () => {
  let client: ClickHouseClient<Stream.Readable>
  let tableName: string

  beforeAll(async () => {
    client = createTestClient()
    tableName = `summary_test_${guid()}`
    await createSimpleTable(client, tableName)
  })
  afterAll(async () => {
    await client.close()
  })

  it('should provide summary for insert/exec', async () => {
    const { summary: insertSummary } = await client.insert({
      table: tableName,
      values: jsonValues,
      format: 'JSONEachRow',
    })
    expect(insertSummary).toEqual(
      jasmine.objectContaining({
        read_rows: '5',
        read_bytes: jasmine.any(String),
        written_rows: '5',
        written_bytes: jasmine.any(String),
        total_rows_to_read: '0',
        result_rows: '5',
        result_bytes: jasmine.any(String),
        elapsed_ns: jasmine.any(String),
      }),
    )
    assertRealTimeMicroseconds(insertSummary)

    const { summary: execSummary } = await client.exec({
      query: `INSERT INTO ${tableName}
              SELECT *
              FROM ${tableName}`,
    })
    expect(execSummary).toEqual(
      jasmine.objectContaining({
        read_rows: '5',
        read_bytes: jasmine.any(String),
        written_rows: '5',
        written_bytes: jasmine.any(String),
        total_rows_to_read: '5',
        result_rows: '5',
        result_bytes: jasmine.any(String),
        elapsed_ns: jasmine.any(String),
      }),
    )
    assertRealTimeMicroseconds(execSummary)
  })

  it('should provide summary for command', async () => {
    const { summary } = await client.command({
      query: `INSERT INTO ${tableName}
              VALUES (144, 'Hello', [2, 4]),
                     (255, 'World', [3, 5])`,
      clickhouse_settings: {
        wait_end_of_query: 1,
      },
    })
    expect(summary).toEqual(
      jasmine.objectContaining({
        read_rows: '2',
        read_bytes: jasmine.any(String),
        written_rows: '2',
        written_bytes: jasmine.any(String),
        total_rows_to_read: '0',
        result_rows: '2',
        result_bytes: jasmine.any(String),
        elapsed_ns: jasmine.any(String),
      }),
    )
    assertRealTimeMicroseconds(summary)
  })

  function assertRealTimeMicroseconds(summary: any) {
    // FIXME: remove this condition after 24.9 is released
    if (process.env['CLICKHOUSE_VERSION'] === 'head') {
      expect(summary.real_time_microseconds).toBeDefined()
      expect(summary.real_time_microseconds).toMatch(/^\d+$/)
    }
  }
})