davidzollo opened a new issue, #10541:
URL: https://github.com/apache/seatunnel/issues/10541

   Sub-issue of #10533
   
   ## Scope
   
   `SourceFlowLifeCycle` is the runtime bridge between the Zeta engine and a 
connector's `SourceReader`. It handles checkpoint barriers, split requests, 
schema-evolution signals, and the checkpoint lock — all without any 
method-level Javadoc.
   
   ## File
   
   
`seatunnel-engine/seatunnel-engine-server/src/main/java/org/apache/seatunnel/engine/server/task/flow/SourceFlowLifeCycle.java`
   
   ## Methods to document
   
   | Method | Line | What to explain |
   |--------|------|-----------------|
   | `init()` | 115 | Creates `SourceReader` from `SourceAction`; initializes 
split serializer |
   | `open()` | 129 | Calls `reader.open()` then registers with the remote 
enumerator via `register()` |
   | `collect()` | 150 | Core read loop: calls `reader.pollNext(collector)`; 
idle yield via `Thread.yield()` when no records; schema-change phase detection; 
checkpoint-lock interaction note |
   | `triggerBarrier(Barrier)` | 267 | Acquires `checkpointLock` before 
injecting barrier into the record stream; `prepareClose` flag propagation; 
schema-change checkpoint type branching |
   | `signalNoMoreElement()` | 198 | Sets `prepareClose = true`; sends 
`ReaderCloseOperation` to enumerator to deregister this reader |
   | `register()` | 215 | Resolves enumerator address lazily; sends 
`RegisterReaderOperation` |
   | `requestSplit()` | 230 | Sends `RequestSplitOperation` to the remote 
enumerator |
   | `receivedSplits(List<SplitT>)` | 259 | Deserializes split bytes and 
forwards to `reader.addSplits` |
   | `notifyCheckpointComplete(long)` | 330 | Delegates to 
`reader.notifyCheckpointComplete`; connector hook for post-commit cleanup |
   | `notifyCheckpointAborted(long)` | 335 | Clears schema-change phase state 
if the aborted checkpoint matches the in-progress DDL checkpoint |
   
   ## How to contribute
   
   1. Fork the repo and create a branch
   2. Add Javadoc to the methods above
   3. Run `./mvnw spotless:apply` and `./mvnw -q -DskipTests verify`
   4. Open a PR with title: `[Docs][Core] Add Javadoc to SourceFlowLifeCycle`


-- 
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]

Reply via email to