Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: avoid using regex match, possibly containing alternation, as a key condition. #54696

Merged
merged 2 commits into from Sep 18, 2023

Conversation

yakov-olkhovskiy
Copy link
Member

@yakov-olkhovskiy yakov-olkhovskiy commented Sep 15, 2023

Changelog category (leave one):

  • Bug Fix (user-visible misbehavior in an official stable release)

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Fixed bug of match() function (regex) with pattern containing alternation produces incorrect key condition.

closes #53222

@robot-ch-test-poll3 robot-ch-test-poll3 added pr-bugfix Pull request with bugfix, not backported by default pr-status-⏳ PR with some pending statuses labels Sep 15, 2023
@robot-ch-test-poll3
Copy link
Contributor

robot-ch-test-poll3 commented Sep 15, 2023

This is an automated comment for commit f52e87f with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
Bugfix validate checkChecks that either a new test (functional or integration) or there some changed tests that fail with the binary built on master branch✅ success
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR✅ success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker image for serversThe check to build and optionally push the mentioned image to docker hub✅ success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here✅ success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc✅ success
Install packagesChecks that the built packages are installable in a clear environment✅ success
Mergeable CheckChecks if all other necessary checks are successful✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub✅ success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool✅ success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors✅ success
Style CheckRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success
Check nameDescriptionStatus
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts❌ failure

@robot-clickhouse robot-clickhouse added pr-status-❌ PR with some error/faliure statuses and removed pr-status-⏳ PR with some pending statuses labels Sep 15, 2023
@yakov-olkhovskiy yakov-olkhovskiy changed the title Fix: bypass using regex match possibly containing alternation as a key condition. Fix: avoid using regex match, possibly containing alternation, as a key condition. Sep 15, 2023
@rschu1ze rschu1ze self-assigned this Sep 17, 2023
@@ -421,7 +421,12 @@ const KeyCondition::AtomMap KeyCondition::atom_map
if (value.getType() != Field::Types::String)
return false;

String prefix = extractFixedPrefixFromRegularExpression(value.get<const String &>());
const String & expression = value.get<const String &>();
// This optimization can't process alternation - this would require a comprehensive parsing of regular expression.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought a bit

  • whether the check should rather be moved into extractFixedPrefixFromRegularExpression() but I think it is okay to not do so
  • whether extractFixedPrefixFromRegularExpression() could be replaced by the more sophisticated regex parsing in OptimizedRegularExpression::analyze(), but again no. ::analyze() searches the longest substring and that's not necessarily the prefix.

Therefore, we can merge the fix. Thanks.

@yakov-olkhovskiy yakov-olkhovskiy merged commit 711876d into master Sep 18, 2023
275 of 279 checks passed
@yakov-olkhovskiy yakov-olkhovskiy deleted the fix-match-keycondition branch September 18, 2023 02:45
@den-crane
Copy link
Contributor

den-crane commented Oct 27, 2023

Strange that it's not backported into LTS releases but the issue was marked as major

@rschu1ze rschu1ze added the pr-backport Changes, backported to release branch. Do not use manually - automated use only! label Nov 2, 2023
@rschu1ze
Copy link
Member

rschu1ze commented Nov 2, 2023

True. Let's backport it.

@rschu1ze rschu1ze added pr-must-backport Pull request should be backported intentionally. Use this label with great care! and removed pr-backport Changes, backported to release branch. Do not use manually - automated use only! labels Nov 2, 2023
robot-clickhouse added a commit that referenced this pull request Nov 2, 2023
…c2cf48099eff68c494067ff5bcbc0

Cherry pick #54696 to 23.3: Fix: avoid using regex match, possibly containing alternation, as a key condition.
robot-clickhouse added a commit that referenced this pull request Nov 2, 2023
robot-clickhouse added a commit that referenced this pull request Nov 2, 2023
…c2cf48099eff68c494067ff5bcbc0

Cherry pick #54696 to 23.7: Fix: avoid using regex match, possibly containing alternation, as a key condition.
robot-clickhouse added a commit that referenced this pull request Nov 2, 2023
robot-clickhouse added a commit that referenced this pull request Nov 2, 2023
…c2cf48099eff68c494067ff5bcbc0

Cherry pick #54696 to 23.8: Fix: avoid using regex match, possibly containing alternation, as a key condition.
robot-clickhouse added a commit that referenced this pull request Nov 2, 2023
@robot-clickhouse robot-clickhouse added the pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore label Nov 2, 2023
rschu1ze added a commit that referenced this pull request Nov 2, 2023
Backport #54696 to 23.8: Fix: avoid using regex match, possibly containing alternation, as a key condition.
rschu1ze added a commit that referenced this pull request Nov 2, 2023
Backport #54696 to 23.7: Fix: avoid using regex match, possibly containing alternation, as a key condition.
rschu1ze added a commit that referenced this pull request Nov 2, 2023
Backport #54696 to 23.3: Fix: avoid using regex match, possibly containing alternation, as a key condition.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-backports-created Backport PRs are successfully created, it won't be processed by CI script anymore pr-bugfix Pull request with bugfix, not backported by default pr-must-backport Pull request should be backported intentionally. Use this label with great care! pr-status-❌ PR with some error/faliure statuses
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Using match with ^$ as anchors on a primary key column returns incorrect results
5 participants