Add setting for better rendering of multiline string for pretty format by yariks5s · Pull Request #63479 · ClickHouse/ClickHouse

yariks5s · 2024-05-07T14:51:28Z

Changelog category (leave one):

Not for changelog (changelog entry is not required)

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

Provides setting output_format_pretty_preserve_border_for_multiline_string which allows to render multiline strings in pretty format better. The default value for this setting is true.

Documentation entry for user-facing changes

Documentation is written (mandatory for new features)

Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/

Modify your CI run

NOTE: If your merge the PR with modified CI you MUST KNOW what you are doing
NOTE: Checked options will be applied if set before CI RunConfig/PrepareRunConfig step

Include tests (required builds will be added automatically):

Exclude tests:

Extra options:

do not test (only style check)
disable merge-commit (no merge from master before tests)
disable CI cache (job reuse)

Only specified batches in multi-batch jobs:

1
2
3
4

Details

robot-ch-test-poll4 · 2024-05-07T14:55:09Z

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

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

Check name	Description	Status
CI running	A meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR	⏳ pending
Stateless tests	Runs stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	❌ failure
Stress test	Runs stateless functional tests concurrently from several clients to detect concurrency-related errors	❌ failure

Successful checks

Check name	Description	Status
A Sync	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
AST fuzzer	Runs randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help	✅ success
ClickBench	Runs [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table	✅ success
ClickHouse build check	Builds 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 check	Checks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help	✅ success
Docker keeper image	The check to build and optionally push the mentioned image to docker hub	✅ success
Docker server image	The check to build and optionally push the mentioned image to docker hub	✅ success
Docs check	Builds and tests the documentation	✅ success
Fast test	Normally 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 tests	Checks 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 packages	Checks that the built packages are installable in a clear environment	✅ success
Integration tests	The integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests	✅ success
Mergeable Check	Checks if all other necessary checks are successful	✅ success
PR Check	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
Performance Comparison	Measure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests	✅ success
Stateful tests	Runs stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	✅ success
Style check	Runs a set of checks to keep the code style clean. If some of tests failed, see the related log from the report	✅ success
Unit tests	Runs the unit tests for different release types	✅ success
Upgrade check	Runs 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	✅ success

alexey-milovidov · 2024-05-07T14:56:52Z

Ok and also SettingsChangesHistory.

src/Processors/Formats/Impl/PrettyBlockOutputFormat.cpp

src/Processors/Formats/Impl/PrettyCompactBlockOutputFormat.cpp

src/Processors/Formats/Impl/PrettySpaceBlockOutputFormat.cpp

Avogar · 2024-05-10T08:15:57Z

src/Core/SettingsChangesHistory.h

              {"cross_join_min_bytes_to_compress", 0, 1_GiB, "A new setting."},
              {"prefer_external_sort_block_bytes", 0, DEFAULT_BLOCK_SIZE * 256, "Prefer maximum block bytes for external sort, reduce the memory usage during merging."},
              {"input_format_force_null_for_omitted_fields", false, false, "Disable type-defaults for omitted fields when needed"},
+              {"output_format_pretty_preserve_border_for_multiline_string", 1, 1, "Applies better rendering for multiline strings."},


Shouldn't previous value be 0 not 1? If I understand correctly, to achieve previous behaviour we should disable this setting, so previpusly ClickHouse behaived like this setting is disabled?
P.S. SettingsChangesHistory is used to set settings to the state they were in some previous version.

I thought that if we created a new setting, it doesn't matter what value we put as a previous value for this setting, because this setting simply did not exist before. Should I fix this in follow-up pr?

I thought that if we created a new setting, it doesn't matter what value we put as a previous value for this setting, because this setting simply did not exist before

Yes, it's a new setting, but this setting enables new behaviour by default. And when we set compatibility setting to some old version, we want the server to behave like this new setting wasn't added (so, in our case we should disable this new setting):

ClickHouse/src/Core/SettingsChangesHistory.h

Lines 83 to 84 in 6c0450f

/// For newly added setting choose the most appropriate previous_value (for example, if new setting

/// controls new feature and it's 'true' by default, use 'false' as previous_value).

Should I fix this in follow-up pr?

Yes, please.

Got it, thanks, will fix it🙂

done in #63783

…_from_multiline_strings" This reverts commit 962d5e5, reversing changes made to 8c4a5d3.

…_setting_from_multiline_strings"" This reverts commit 7e42948.

init

5117422

robot-ch-test-poll4 added the pr-not-for-changelog This PR should not be mentioned in the changelog label May 7, 2024

yariks5s added 2 commits May 7, 2024 17:11

add setting to SettingsChangesHistory

ac485b6

Newline at the end of .reference

8e072f6