Array(Nested(...)) columns silently decode as Array(Nothing) and desynchronize the native block stream
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 68/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- clickhouse, cpp
調査の方向性
Start with clickhouse/types/type_parser.cpp, tracing GetTypeMeta(), ValidateAST(), and CreateColumnFromAst for the Array(Nested(...)) reproduction. Then inspect clickhouse/columns/factory.cpp and the ColumnNothing behavior described in columns/nothing.h. Add coverage for the expected nested type or explicit unsupported-type failure, and verify the pure client-side test no longer yields Array(Nothing).
索引モデルが issue の本文から書いたものです。
説明
Description
The type parser has no entry for Nested, so a column whose server-reported type is Array(Nested(key String, value String)) is parsed as Array(<unknown terminal>) with Type::Void, and CreateTerminalColumn() maps Type::Void to ColumnNothing. The result is that CreateColumnByType() returns a perfectly valid-looking ColumnArray(ColumnNothing) — no error, no nullptr — and Client::Select() happily accepts it when reading the block header.
This matters because Nested inside Array(...) is not flattened by the server. Unlike a top-level Nested column (which the server splits into col.key Array(String), col.value Array(String) — the case discussed in #40), Array(Nested(...)) is reported over the native protocol with the literal type name:
$ clickhouse-client -q "SELECT name, type FROM system.columns WHERE table='some_data'"
id UInt64
data Array(Nested(key String, value String))
On the wire Array(Nested(k String, v String)) is serialized as Array(Array(Tuple(String, String))). But the client builds Array(Nothing), and ColumnNothing::LoadBody() (clickhouse/columns/nothing.h:61) just does input->Skip(rows) — 1 byte per element. So after reading the outer offsets the client skips N bytes where the server actually wrote 8*N inner-offset bytes plus all the string data. The input stream is desynchronized from that point on: the remaining block (and every block after it) is decoded as garbage, typically surfacing much later as an unrelated parse failure or a corrupted/empty result rather than a clear "unsupported type" error.
This is the C++ analogue of ClickHouse/clickhouse-java#3178, where the JDBC driver also failed on Array(Nested(...)) because its conversion layer did not account for Nested producing an extra list level.
Related but distinct from #40, which asks for a convenience API over flattened top-level Nested columns (those already work, since the server hands them over as plain Array(T)). Here the client receives a literal Nested(...) type name and silently produces wrong data.
ClickHouse server version
26.9.8.3 — used to confirm the type name the server reports for Array(Nested(...)) (shown above).
Code analysis only; the C++ repro below was written but not executed — binary execution was unavailable in the environment I investigated from. The static trace through TypeParser::Parse → CreateColumnFromAst → CreateTerminalColumn is given in full under "Suggested fix" below, and the first assertion (Array(Nothing)) is a pure parser/factory fact requiring no server.
Reproduction
Pure client-side, no server needed — this already demonstrates the root cause:
#include <clickhouse/columns/factory.h>
#include <gtest/gtest.h>
using namespace clickhouse;
TEST(CreateColumnByType, ArrayOfNested) {
auto col = CreateColumnByType("Array(Nested(key String, value String))");
ASSERT_NE(nullptr, col);
// Expected: Array(Array(Tuple(String, String)))
// Actual: Array(Nothing)
EXPECT_EQ("Array(Array(Tuple(String, String)))", col->Type()->GetName());
}
End-to-end, against a server:
CREATE TABLE some_data (
`id` UInt64,
`data` Array(Nested(`key` String, `value` String))
) ENGINE = Memory;
INSERT INTO some_data VALUES
(1, [[('key1','test'), ('key2','another-test')], [('key1','more-data')]]);
#include <clickhouse/client.h>
#include <iostream>
using namespace clickhouse;
int main() {
Client client(ClientOptions().SetHost("localhost").SetPort(9000));
client.Select("SELECT id, data FROM some_data", [](const Block& block) {
for (size_t c = 0; c < block.GetColumnCount(); ++c) {
std::cout << block.GetColumnName(c) << " -> "
<< block[c]->Type()->GetName() << "\n";
}
});
}
Expected: the data column comes back as Array(Array(Tuple(String, String))) with the two inner arrays intact (or, failing that, a clear UnimplementedError naming the unsupported type).
Actual: data is reported as Array(Nothing) carrying no values, and because ColumnNothing::LoadBody under-consumes the stream by the full size of the inner offsets and strings, decoding of the rest of the response is corrupted.
Suggested fix
Trace of the current behaviour:
clickhouse/types/type_parser.cpp:116—GetTypeMeta()has noNestedbranch, so theNested(...)node falls through toTypeAst::Terminal.clickhouse/types/type_parser.cpp:107—GetTypeCode("Nested")misseskTypeCodeand returnsType::Void.clickhouse/types/type_parser.cpp:152—ValidateAST()does reject unknownTerminal+Voidnodes, but it is only ever called on the root AST node (type_parser.cpp:238). The root here isArray, so the bad child is never validated.clickhouse/columns/factory.cpp:49—CreateTerminalColumn()mapsType::VoidtoColumnNothing, turning the unknown type into a silently-wrong column instead of anullptr.
Two things worth doing, independently useful:
-
Support
Nested.Nested(a T1, b T2)is exactlyArray(Tuple(a T1, b T2)). Adding aNestedmeta that desugars to that inCreateColumnFromAstwould makeArray(Nested(...))decode correctly, and would also let named-tuple element names (already supported viaTypeAst::element_name) carry through. -
Fail loudly on unknown nested types. Apply
ValidateASTrecursively, or haveCreateTerminalColumnreturnnullptrforType::Voidwhenast.nameis not literallyNothing/void. Right now any unrecognized type nested inside a container degrades toColumnNothingand desynchronizes the stream rather than raisingUnimplementedError. (Same silent-desync failure mode as #543.)
Link
Original client issue: https://github.com/ClickHouse/clickhouse-java/issues/3178
- 主要言語
- C
- スター
- 383
- フォーク
- 209
- 平均マージ
- 2日 13時間
- マージ済み PR(30日)
- 7
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ClickHouse/clickhouse-cpp のほかの issue
-
enhancement pg_clickhouse
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
ClickHouse/clickhouse-cpp#478 · コメント 1 件 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 62/100
ClickHouse/clickhouse-cpp#565 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
ClickHouse/clickhouse-cpp#560 · コメント 1 件 ·
-
Native TCP: CompressionMethod::ZSTD is not honored for server -> client blocks (network_compression_method never sent)対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 68/100
ClickHouse/clickhouse-cpp#556 · リアクション 1 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
ClickHouse/clickhouse-cpp#549 ·
ClickHouse/clickhouse-cpp の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
containers/bubblewrap#813 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
tree-sitter/tree-sitter#6005 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
facebookincubator/muse-gadget-sdk#47 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
kubernetes-sigs/security-profiles-operator#3537 ·
メンテナーはふだん 1 日以内に返信