[improve][txn] Add getState in transaction for client API #17423

congbobo184 · 2022-09-02T06:05:55Z

Motivation

now org.apache.pulsar.client.api.transaction.Transaction dont have a interface for user to get the transaction state.

user can get the transaction state to do user's own op.

Modifications

add the interface in org.apache.pulsar.client.api.transaction.Transaction getState
TransactionImpl implement the interface

     * Get transaction state.
     *
     * @return {@link State} the state of the transaction.
     */
    State getState();

Verifying this change

add the test

Does this pull request potentially affect one of the following parts:

If yes was chosen, please highlight the changes

Dependencies (does it add or upgrade a dependency): (no)
The public API: (no)
The schema: (no)
The default values of configurations: (no)
The wire protocol: (no)
The rest endpoints: (no)
The admin cli options: (no)
Anything that affects deployment: (no)

Documentation

Does this pull request introduce a new feature? (yes)
If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
If a feature is not applicable for documentation, explain why?
If a feature is not documented yet in this PR, please create a followup issue for adding the documentation
doc-not-needed

pulsar-client/src/main/java/org/apache/pulsar/client/impl/transaction/TransactionImpl.java

pulsar-client-api/src/main/java/org/apache/pulsar/client/api/transaction/Transaction.java

codelipenghui · 2022-09-02T06:29:20Z

I hope it can be cherry-picked to release branches from branch-2.9.
So that users can use the new method to check the transaction state.
And the change will not introduce risk to release branches.

codelipenghui · 2022-09-05T05:56:11Z

@Anonymitaet Please help review the Java Doc

Anonymitaet

Feel free to correct me if my understanding is inaccurate, thanks!

pulsar-client-api/src/main/java/org/apache/pulsar/client/api/transaction/Transaction.java

…ransaction/Transaction.java Co-authored-by: Anonymitaet <[email protected]>

…state_interface' into congbobo184_txn_add_transaction_state_interface

congbobo184 · 2022-09-05T13:29:55Z

@Anonymitaet @codelipenghui I have fixed the comments, please review again. Thanks! :)

Anonymitaet

Thanks for your contribution! Approved from a technical writing perspective. 😊

nicoloboschi

@congbobo184 would you mind to explain a case where the user needs to know the state of the transaction object? could you explain what are the actions they can take based on the state?

I'm ok with the pull itself but since we're adding it to the public API (and maintain it forever even if the internal transaction mechanism changes) we need a strong reason

codelipenghui · 2022-09-08T13:01:09Z

@nicoloboschi I see a transaction production user. They are using TransactionImpl.checkIfOpen() to do some checks when they using transactions. Otherwise, they can only do it by catching exceptions, but it's a bad experience. The ideal case is users don't need to care about the transaction state, just commit it or abort it. Always under some complex use cases, users depend on the state check (same as client.isConnected(); consumer.isConnected();)

…_transaction_state_interface

@return

### Motivation now `org.apache.pulsar.client.api.transaction.Transaction` dont have a interface for user to get the transaction state. user can get the transaction state to do user's own op. ### Modifications 1. add the interface in `org.apache.pulsar.client.api.transaction.Transaction` `getState` 2. TransactionImpl implement the interface ``` * Get transaction state. * * @return {@link State} the state of the transaction. */ State getState(); ``` ### Verifying this change add the test (cherry picked from commit a9531db)

@return

### Motivation now `org.apache.pulsar.client.api.transaction.Transaction` dont have a interface for user to get the transaction state. user can get the transaction state to do user's own op. ### Modifications 1. add the interface in `org.apache.pulsar.client.api.transaction.Transaction` `getState` 2. TransactionImpl implement the interface ``` * Get transaction state. * * @return {@link State} the state of the transaction. */ State getState(); ``` ### Verifying this change add the test (cherry picked from commit a9531db)

@return

### Motivation now `org.apache.pulsar.client.api.transaction.Transaction` dont have a interface for user to get the transaction state. user can get the transaction state to do user's own op. ### Modifications 1. add the interface in `org.apache.pulsar.client.api.transaction.Transaction` `getState` 2. TransactionImpl implement the interface ``` * Get transaction state. * * @return {@link State} the state of the transaction. */ State getState(); ``` ### Verifying this change add the test (cherry picked from commit a9531db)

@return

### Motivation now `org.apache.pulsar.client.api.transaction.Transaction` dont have a interface for user to get the transaction state. user can get the transaction state to do user's own op. ### Modifications 1. add the interface in `org.apache.pulsar.client.api.transaction.Transaction` `getState` 2. TransactionImpl implement the interface ``` * Get transaction state. * * @return {@link State} the state of the transaction. */ State getState(); ``` ### Verifying this change add the test (cherry picked from commit a9531db) (cherry picked from commit db4fbfb)

@return

now `org.apache.pulsar.client.api.transaction.Transaction` dont have a interface for user to get the transaction state. user can get the transaction state to do user's own op. 1. add the interface in `org.apache.pulsar.client.api.transaction.Transaction` `getState` 2. TransactionImpl implement the interface ``` * Get transaction state. * * @return {@link State} the state of the transaction. */ State getState(); ``` add the test (cherry picked from commit a9531db)

Technoboy- · 2023-03-16T11:48:53Z

Cherry-picked by #19834

#17423) (#19834) Co-authored-by: congbo <[email protected]>

[feat][txn] Add getState in transaction for client API

471d4aa

congbobo184 added area/transaction doc-not-needed Your PR changes do not impact docs labels Sep 2, 2022

congbobo184 added this to the 2.12.0 milestone Sep 2, 2022

congbobo184 requested review from eolivelli, codelipenghui, gaoran10 and liangyepianzhou September 2, 2022 06:05

congbobo184 self-assigned this Sep 2, 2022

codelipenghui added the type/enhancement The enhancements for the existing features or docs. e.g. reduce memory usage of the delayed messages label Sep 2, 2022

codelipenghui changed the title ~~[feat][txn] Add getState in transaction for client API~~ [improve][txn] Add getState in transaction for client API Sep 2, 2022

codelipenghui added release/2.9.4 release/2.11.1 release/2.10.3 labels Sep 2, 2022

codelipenghui reviewed Sep 2, 2022

View reviewed changes

fix some comments

e2b9c16

codelipenghui requested a review from Anonymitaet September 5, 2022 05:55

Anonymitaet reviewed Sep 5, 2022

View reviewed changes

Anonymitaet added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. and removed doc-not-needed Your PR changes do not impact docs labels Sep 5, 2022

congbobo184 and others added 3 commits September 5, 2022 21:08

Update pulsar-client-api/src/main/java/org/apache/pulsar/client/api/t…

07cea27

…ransaction/Transaction.java Co-authored-by: Anonymitaet <[email protected]>

fix some doc comment

d4594e7

Merge remote-tracking branch 'origin/congbobo184_txn_add_transaction_…

e281453

…state_interface' into congbobo184_txn_add_transaction_state_interface

Anonymitaet approved these changes Sep 6, 2022

View reviewed changes

codelipenghui approved these changes Sep 6, 2022

View reviewed changes

nicoloboschi reviewed Sep 6, 2022

View reviewed changes

liangyepianzhou approved these changes Sep 8, 2022

View reviewed changes

Merge remote-tracking branch 'apache/master' into congbobo184_txn_add…

5687c55

…_transaction_state_interface

congbobo184 closed this Sep 21, 2022

congbobo184 reopened this Sep 21, 2022

congbobo184 merged commit a9531db into apache:master Sep 22, 2022

congbobo184 added the cherry-picked/branch-2.9 Archived: 2.9 is end of life label Nov 8, 2022

liangyepianzhou added the cherry-picked/branch-2.10 label Dec 5, 2022

liangyepianzhou mentioned this pull request Mar 16, 2023

[cherry-pick][branch-2.11]Cherry-pick three PR to branch-2.11 #19833

Closed

15 tasks

liangyepianzhou mentioned this pull request Mar 16, 2023

[improve][txn][branch-2.11] Add getState in transaction for client API (#17423) #19834

Merged

15 tasks

Technoboy- added the cherry-picked/branch-2.11 label Mar 16, 2023

liangyepianzhou added a commit that referenced this pull request Mar 16, 2023

[improve][txn][branch-2.11] Add getState in transaction for client API (

1614e36

#17423) (#19834) Co-authored-by: congbo <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[improve][txn] Add getState in transaction for client API #17423

[improve][txn] Add getState in transaction for client API #17423

congbobo184 commented Sep 2, 2022 •

edited

Loading

codelipenghui commented Sep 2, 2022

codelipenghui commented Sep 5, 2022

Anonymitaet left a comment

congbobo184 commented Sep 5, 2022

Anonymitaet left a comment

nicoloboschi left a comment •

edited

Loading

codelipenghui commented Sep 8, 2022

Technoboy- commented Mar 16, 2023

[improve][txn] Add getState in transaction for client API #17423

[improve][txn] Add getState in transaction for client API #17423

Conversation

congbobo184 commented Sep 2, 2022 • edited Loading

Motivation

Modifications

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

codelipenghui commented Sep 2, 2022

codelipenghui commented Sep 5, 2022

Anonymitaet left a comment

Choose a reason for hiding this comment

congbobo184 commented Sep 5, 2022

Anonymitaet left a comment

Choose a reason for hiding this comment

nicoloboschi left a comment • edited Loading

Choose a reason for hiding this comment

codelipenghui commented Sep 8, 2022

Technoboy- commented Mar 16, 2023

congbobo184 commented Sep 2, 2022 •

edited

Loading

nicoloboschi left a comment •

edited

Loading