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

   Sub-issue of #10533
   
   ## Scope
   
   `SeaTunnelTask` is the abstract base for all Zeta task executions. Its 
`stateProcess()` method implements the complete task state machine 
(`WAITING_RESTORE → RUNNING → PREPARE_CLOSE → CLOSED`), but has no Javadoc at 
all.
   
   ## File
   
   
`seatunnel-engine/seatunnel-engine-server/src/main/java/org/apache/seatunnel/engine/server/task/SeaTunnelTask.java`
   
   ## Methods to document
   
   | Method | Line | What to explain |
   |--------|------|-----------------|
   | `init()` | 123 | Flow-to-lifecycle conversion via 
`convertFlowToActionLifeCycle`; metrics context wiring; `flowFutures` 
registration for close detection |
   | `stateProcess()` | 137 | Full state machine: `WAITING_RESTORE` → waits for 
`restoreComplete` future → calls `open()` → `RUNNING` → calls `collect()` in a 
loop → `PREPARE_CLOSE` → waits for barrier → `close()` |
   | `convertFlowToActionLifeCycle(Flow)` | 197 | Recursive DAG traversal that 
wires output lists between lifecycle objects |
   | `ack(Barrier)` | 312 | Accumulates per-cycle ACKs; detects `prepareClose` 
signal embedded in barrier; triggers checkpoint ACK operation to 
`CheckpointCoordinator` |
   | `addState(Barrier, ActionStateKey, List<byte[]>)` | 352 | Accumulates 
per-action checkpoint states before the ACK is sent |
   | `triggerSchemaChangeBeforeCheckpoint()` | 334 | Propagates 
DDL-before-checkpoint barrier to upstream enumerator |
   | `triggerSchemaChangeAfterCheckpoint()` | 343 | Propagates 
DDL-after-checkpoint barrier signalling DDL is committed |
   | `close()` | 299 | Ordered teardown of all `FlowLifeCycle` objects; error 
aggregation (first exception wins) |
   
   ## 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 SeaTunnelTask`


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