goutamadwant opened a new pull request, #12936:
URL: https://github.com/apache/seatunnel/pull/12936
<!--
Thank you for contributing to SeaTunnel! Please make sure that your code
changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
## Contribution Checklist
- Make sure that the pull request corresponds to a [GITHUB
issue](https://github.com/apache/seatunnel/issues).
- Name the pull request in the form "[Feature] [component] Title of the
pull request", where *Feature* can be replaced by `Hotfix`, `Bug`, etc.
- Minor fixes should be named following this pattern: `[hotfix] [docs] Fix
typo in README.md doc`.
-->
### Purpose of this pull request
<!-- Describe the purpose of this pull request. For example: This pull
request adds checkstyle plugin.-->
Fix CSV preamble handling in SeaTunnel. Closes #12935.
The file-base reader constructs the header-aware CSV parser before skipping
configured physical lines. Parser construction can consume the preamble as the
header and buffer the remaining input, causing the subsequent skip to fail
despite sufficient lines.
Skip the preamble before constructing the parser, retain stream cleanup on
initialization failure, and leave byte-range skipping unchanged. Add reader
regressions, a LocalFile E2E case, and EN/ZH documentation.
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as
the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes
- provide the console output, description and/or an example to show the
behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to
the released SeaTunnel versions or within the unreleased branches such as dev.
If no, write 'No'.
If you are adding/modifying connector documents, please follow our new
specifications: https://github.com/apache/seatunnel/issues/4544.
-->
Yes. With `enable_file_split=false`, `csv_use_header_line=true`, and
`skip_header_row_number=1`:
```csv
generated report
name,id,age
Alice,1,10
Bob,2,20
```
Before: FILE-02 / “fewer lines than expected to skip.”
After: skip the report line, use `name,id,age` as the header, and produce
`[1, Alice, 10]` and `[2, Bob, 20]` for schema `id INT, name STRING, age INT`.
No API, option, default, or dependency changes. Zero-skip and headerless
behavior remain covered. The separate byte-range enumeration/header policy is
unchanged. Reproduced against current `dev`; released versions were not
separately tested.
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some
test cases that check the changes thoroughly including negative and positive
cases if possible.
If it was tested in a way different from regular unit tests, please clarify
how you tested step by step, ideally copy and paste-able, so that other
reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why
it was difficult to add.
If you are adding E2E test cases, maybe refer to
https://github.com/apache/seatunnel/blob/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/connector-cdc-mysql-e2e/src/test/resources/mysqlcdc_to_mysql.conf,
here is a good example.
-->
Java 11: host Temurin 11.0.19; Zeta container `eclipse-temurin:11-jdk`.
- Added regressions failed before the fix: six errors across 18 reader
invocations. All 18 pass afterward.
- Coverage includes LF/CRLF/CR, BOM, reordered headers, unmatched quotes in
skipped preamble, multiline fields, zero-skip/headerless controls, empty/short
input, input closure, and byte-range skip protection.
- CSV format: 15 tests passed. File-base: 369 tests passed, including the 18
reader invocations. No failures/errors/skips.
- Zeta LocalFile E2E: one invocation passed, running the new preamble
fixture and existing header-only control. Both jobs finished successfully.
- Scoped 65-module package/verify, Spotless, and `git diff --check` passed.
```sh
./mvnw -o -pl
seatunnel-connectors-v2/connector-file/connector-file-base,seatunnel-formats/seatunnel-format-csv
test
RUN_ENGINES=zeta ./mvnw -o -pl
seatunnel-core/seatunnel-starter,seatunnel-connectors-v2/connector-file/connector-file-local,seatunnel-connectors-v2/connector-assert,seatunnel-e2e/seatunnel-connector-v2-e2e/connector-file-local-e2e
-am -DskipUT=true -DskipIT=false
-Dit.test=LocalFileIT#testLocalFileCsvWithPreamble
-Dfailsafe.failIfNoSpecifiedTests=false -DfailIfNoTests=false
-De2e.dependency.skip=false verify
```
Full repository CI, Flink/Spark E2E, and remote file-store validation have
not been run locally for this patch.
### Check list
* [ ] If any new Jar binary package adding in your PR, please add License
Notice according
[New License
Guide](https://github.com/apache/seatunnel/blob/dev/docs/en/developer/new-license.md)
* [x] If necessary, please update the documentation to describe the new
feature. https://github.com/apache/seatunnel/tree/dev/docs
* [ ] If necessary, please update `incompatible-changes.md` to describe the
incompatibility caused by this PR.
* [ ] If you are contributing the connector code, please check that the
following files are updated:
1. Update
[plugin-mapping.properties](https://github.com/apache/seatunnel/blob/dev/plugin-mapping.properties)
and add new connector information in it
2. Update the pom file of
[seatunnel-dist](https://github.com/apache/seatunnel/blob/dev/seatunnel-dist/pom.xml)
3. Add ci label in
[label-scope-conf](https://github.com/apache/seatunnel/blob/dev/.github/workflows/labeler/label-scope-conf.yml)
4. Add e2e testcase in
[seatunnel-e2e](https://github.com/apache/seatunnel/tree/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/)
5. Update connector
[plugin_config](https://github.com/apache/seatunnel/blob/dev/config/plugin_config)
No new JARs, incompatible changes, or connector registrations. EN/ZH docs
and the existing LocalFile E2E suite are updated; distribution/plugin metadata
changes are not applicable.
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
