sv3ndk opened a new pull request #16245:
URL: https://github.com/apache/flink/pull/16245
<!--
*Thank you very much for contributing to Apache Flink - we are happy that
you want to help us improve Flink. To help the community review your
contribution in the best possible way, please go through the checklist below,
which will get the contribution into a shape in which it can be best reviewed.*
*Please understand that we do not do this to make contributions to Flink a
hassle. In order to uphold a high standard of quality for code contributions,
while at the same time managing a large number of contributions, we need
contributors to prepare the contributions well, and give reviewers enough
contextual information for the review. Please also understand that
contributions that do not follow this guide will take longer to review and thus
typically be picked up with lower priority by the community.*
## Contribution Checklist
- Make sure that the pull request corresponds to a [JIRA
issue](https://issues.apache.org/jira/projects/FLINK/issues). Exceptions are
made for typos in JavaDoc or documentation files, which need no JIRA issue.
- Name the pull request in the form "[FLINK-XXXX] [component] Title of the
pull request", where *FLINK-XXXX* should be replaced by the actual issue
number. Skip *component* if you are unsure about which is the best component.
Typo fixes that have no associated JIRA issue should be named following
this pattern: `[hotfix] [docs] Fix typo in event time introduction` or
`[hotfix] [javadocs] Expand JavaDoc for PuncuatedWatermarkGenerator`.
- Fill out the template below to describe the changes contributed by the
pull request. That will give reviewers the context they need to do the review.
- Make sure that the change passes the automated tests, i.e., `mvn clean
verify` passes. You can set up Azure Pipelines CI to do that following [this
guide](https://cwiki.apache.org/confluence/display/FLINK/Azure+Pipelines#AzurePipelines-Tutorial:SettingupAzurePipelinesforaforkoftheFlinkrepository).
- Each pull request should address only one issue, not mix up code from
multiple issues.
- Each commit in the pull request has a meaningful commit message
(including the JIRA id)
- Once all items of the checklist are addressed, remove the above text and
this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
## What is the purpose of the change
As a resolution for
[FLINK-22940](https://issues.apache.org/jira/browse/FLINK-22940), this PR aims
at replacing the hard-coded maximum display width currently used by the SQL
client with a configurable one.
In the linked ticked we discussed allowing the user to set the max width as
unlimited, but on second thought I find is hard to implement since the
resulting data may not be materialized => we do not know the maximum width
required by the data. I suggest we do not implement this as part of this ticket.
## Brief change log
* Aligned the column width strategy across all modes
In tableau mode, the column width is computed by
`PrintUtils.columnWidthsByType()` and depends on the column type (e.g. 10 for a
DATE).
In Table and Changelog modes however, all columns defaulted to
`MAX_COLUMN_WIDTH`, as provided by `computeColumnWidth(int idx)`, which lead to
waste of screen space, inconsistent end-user experience and harder code to
maintain.
In order to use the same logic for all modes, I removed the
`computeColumnWidth(int idx)` methods and replaced them
with an initialization of the column widths in the constructor that relies
on the same `PrintUtils.columnWidthsByType()` method as the Tableau mode.
* Added a new option `sql-client.display.max_column_width` to
`SqlClientOptions`
* Added an instance of `ReadableConfig` as a member of `ResultDescriptor`
`ResultDescriptor` already has 2 methods providing access to configuration:
`isTableauMode()` and `isStreamingMode()`, that were previously initialized
explicitly by the caller.
=> in order to simplify the initialization of `ResultDescriptor` and allow
access to all configuration keys, I placed an instance of `ReadableConfig`
directly inside it.
Since this class is read-only, I made it public for simplicity.
* Updated the view result in all modes to use the new parameter
In any call to `PrintUtils.columnWidthsByType()` from within the SQL client,
the logic is now depending on the new config parameter, obtained via the
`ResultDescriptor` instance.
* Updated documentation
I updated the example of display for each mode in the documentation +
re-organized the structure a bit in order to move all configuration-related
aspects in the "Configuration" section.
* Fixes a few deprecation warnings
Some unit tests were using `org.junit.Assert.assertThat`, which is now
deprecated in favour of `org.hamcrest.MatcherAssert.assertThat` => I replaced.
## Verifying this change
See the 2 videos, shoing the old behavior (including inconsistencies of
column width across modes) and the new behavior (including usage of the new
parameter).
https://user-images.githubusercontent.com/1214071/122984133-f8f38580-d39c-11eb-824d-681f68bb1fb5.mp4
https://user-images.githubusercontent.com/1214071/122984144-fb55df80-d39c-11eb-85b7-a8615b8565c0.mp4
I also validated the existing tests and style with:
```sh
mvn spotless:apply install -pl flink-table/flink-sql-client
```
And validated the documentation updates with
```sh
hugo -b "" serve
```
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API, i.e., is any changed class annotated with
`@Public(Evolving)`: no
- The serializers: no
- The runtime per-record code paths (performance sensitive): no
- Anything that affects deployment or recovery: JobManager (and its
components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: no
- The S3 file system connector:no
## Documentation
- Does this pull request introduce a new feature? yes
- If yes, how is the feature documented? docs / JavaDocs
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
