Adjust XAException return codes for better compatibility with XA specification #782

ochaloup · Mar 15, 2017

This commit fixes error codes which are thrown from PostgreSQL
XAResource jdbc driver to comply better with xa specification.

There are three main adjustments

XAException.XAER_RMFAIL is used when some connection error happens
and it is expected that reconnection of RM could occur
XAException.XAER_NOTA is used when RM does not know anything about the
provided Xid
XAException.XAER_PROTO is used when some wrong sequence of method
calls is invoked

This addresses issues
#236
#510
#683

codecov-io · Mar 15, 2017

Codecov Report

Merging #782 into master will increase coverage by 0.08%.
The diff coverage is 43.07%.

@@             Coverage Diff              @@
##             master     #782      +/-   ##
============================================
+ Coverage     67.38%   67.47%   +0.08%     
- Complexity     3687     3710      +23     
============================================
  Files           170      170              
  Lines         15638    15681      +43     
  Branches       2531     2552      +21     
============================================
+ Hits          10538    10581      +43     
+ Misses         3917     3914       -3     
- Partials       1183     1186       +3

ochaloup · Mar 21, 2017

fixed forgotten checkstyle failures

davecramer · Mar 22, 2017

So short of any way to really test this I'm inclined to +1

ochaloup · Mar 28, 2017

@davecramer thanks for looking at this!
I will try to run our tests with these changes this week. I will keep you updated.

ochaloup · Jan 6, 2018

hi @davecramer , I've got back to this. I re-based the changes and the CI tests seem to pass. Then I built the driver with this changes and run WildFly Narayana integration testsuite with the driver and PostgreSQL 9.3 and 9.4 and all passed.

Would that be ok to merge this PR or is there something more to do/check?

ochaloup · Jan 8, 2018

cc to @vlsi and @whitingjr as we were discussing the issue #510 which this PR covers

davecramer · Jan 8, 2018

@ochaloup long week :)

If nobody else has objections I'm fine with it

whitingjr · Jan 16, 2018

@davecramer I've looked over the changes. They look ok.

vlsi · Jan 23, 2018

vlsi reviewed Jan 23, 2018

View changes

vlsi · Jan 23, 2018

pgjdbc/src/main/java/org/postgresql/xa/PGXAConnection.java

+      if (PSQLState.isConnectionError(ex.getSQLState())) {
+        errorCode = XAException.XAER_RMFAIL;
+      }
+      throw new PGXAException(GT.tr("Error rolling back prepared transaction"), ex, errorCode);


@ochaloup , I might be a bit late to the party, however what do you think of printing things like xid, preparedXid, committedOrRolledBack in the error message?

I'm sure, that would be crucial information if somebody receives ""Error rolling back prepared transaction".

@vlsi : I agree. Just I was not sure if I can change the format as those information was not part of the messages previously. I'm going to add the proposed info to the messages, push it to the PR and please check that then again.

vlsi · Jan 23, 2018

vlsi reviewed Jan 23, 2018

View changes

vlsi · Jan 23, 2018

pgjdbc/src/main/java/org/postgresql/xa/PGXAConnection.java

@@ -442,18 +464,22 @@ private void commitOnePhase(Xid xid) throws XAException {
                "Not implemented: one-phase commit must be issued using the same connection that was used to start it"),
            XAException.XAER_RMERR);
      }
+      if (!xid.equals(currentXid) || committedOrRolledBack) {
+        throw new PGXAException(GT.tr("One-phase commit with unknown xid "), XAException.XAER_NOTA);


space at the end of string

vlsi · Jan 23, 2018

@ochaloup , the changes look ok, however, I think it makes sense to add xids (and other relevant state information) to the error messages. Otherwise the error messages are cryptic and it would be hard to analyze.

ochaloup · Jan 25, 2018

@vlsi can you please review the current form. I changed some of the error messages, added few debug information printing. Would be fine this way? Does have no harm for translation?

ochaloup · Jan 27, 2018

I haven't recognized that I need to run manually mvn checkstyle:check. Seems the issue is in the forgotten import. I hope that will be fine this time.

vlsi · Jan 27, 2018

vlsi reviewed Jan 27, 2018

View changes

vlsi · Jan 27, 2018

pgjdbc/src/main/java/org/postgresql/xa/PGXAConnection.java

-        // In fact, we don't know if xid is bogus, or if it just wasn't associated with this
-        // connection.
+      if (xid.equals(preparedXid)) {
+        throw new PGXAException(GT.tr("One-phase commit called for xid {0} but connection was prepared with xid {1}",


@ochaloup , Did you really mean xid.equals(preparedXid) above?
I think the negation is missing. Can you please clarify the logic here?

vlsi · Jan 28, 2018

vlsi reviewed Jan 28, 2018

View changes

vlsi · Jan 28, 2018

pgjdbc/src/main/java/org/postgresql/xa/PGXAConnection.java

@@ -195,12 +197,12 @@ public void start(Xid xid, int flags) throws XAException {
    // It's ok to join an ended transaction. WebLogic does that.
    if (flags == TMJOIN) {
      if (state != State.ENDED) {
-        throw new PGXAException(GT.tr("Transaction interleaving not implemented"),
+        throw new PGXAException(GT.tr("Transaction interleaving not implemented. xid={0}, currentXid={1}", xid, currentXid),


Just a note: exception message does not reflect the cause. Something like "invalid state" should be used.

@vlsi thank you for your fixes. I haven't managed to understand how the call should be compound correctly (eating humble pie).

In the case of the message - do you expect me to change the message? I can only guess what is the purpose. Do you want to change the message to something like Start called with transaction join flag while transaction is still active. Transaction interleaving not implemented..., or...?

@vlsi Does the exception message still need changing to "invalid state" ? Or something similar ?

"Invalid protocol state requested. Attempted Transaction interleaving is not supported. xid={0}, currentXid={1}"

@whitingjr thank you. I changed the PR to the text you suggested. I only wonder if that's right to say that the protocol state is invalid.

ochaloup referenced this pull request Mar 15, 2017
Closed
Incorrect return code for error of commit call during 1PC #510

vlsi added this to the 42.2.1 milestone Jan 18, 2018

vlsi referenced this pull request Jan 23, 2018
Merged
docs: prepare release notes for 42.2.1 #1093

vlsi modified the milestones: 42.2.1, 42.2.2 Jan 25, 2018

vlsi changed the title from Adjusting XAException return codes for PG XAResource to Adjust XAException return codes for better compatibility with XA specification Mar 11, 2018

doc: update changelog

Unverified

The key that signed this is expired.

GPG key ID: 38F47D3E410C47B1 Learn about signing commits

1ca93b4

vlsi merged commit e5aab1c into pgjdbc:master Mar 11, 2018
1 check was pending

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

pgjdbc/pgjdbc

Join GitHub today

Adjust XAException return codes for better compatibility with XA specification #782

Conversation

ochaloup commented Mar 15, 2017

ochaloup referenced this pull request Mar 15, 2017

This comment has been minimized.

codecov-io commented Mar 15, 2017 • edited

Codecov Report

This comment has been minimized.

ochaloup commented Mar 21, 2017

This comment has been minimized.

davecramer commented Mar 22, 2017

This comment has been minimized.

ochaloup commented Mar 28, 2017

This comment has been minimized.

ochaloup commented Jan 6, 2018

This comment has been minimized.

ochaloup commented Jan 8, 2018

This comment has been minimized.

davecramer commented Jan 8, 2018

This comment has been minimized.

whitingjr commented Jan 16, 2018

vlsi added this to the 42.2.1 milestone Jan 18, 2018

vlsi reviewed Jan 23, 2018 View changes

This comment has been minimized.

This comment has been minimized.

vlsi reviewed Jan 23, 2018 View changes

This comment has been minimized.

This comment has been minimized.

vlsi commented Jan 23, 2018

vlsi referenced this pull request Jan 23, 2018

This comment has been minimized.

ochaloup commented Jan 25, 2018

vlsi modified the milestones: 42.2.1, 42.2.2 Jan 25, 2018

This comment has been minimized.

ochaloup commented Jan 27, 2018

vlsi reviewed Jan 27, 2018 View changes

This comment has been minimized.

vlsi reviewed Jan 28, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

whitingjr Feb 19, 2018 • edited

This comment has been minimized.

This comment has been minimized.

ochaloup and others added some commits Mar 15, 2017

vlsi changed the title from Adjusting XAException return codes for PG XAResource to Adjust XAException return codes for better compatibility with XA specification Mar 11, 2018

Hide details View details vlsi merged commit e5aab1c into pgjdbc:master Mar 11, 2018 1 check was pending

1 check was pending

rhavermans added a commit to bolcom/pgjdbc that referenced this pull request Jul 13, 2018

rhavermans added a commit to bolcom/pgjdbc that referenced this pull request Jul 13, 2018

codecov-io commented Mar 15, 2017 •

edited

vlsi reviewed Jan 23, 2018

View changes

vlsi reviewed Jan 23, 2018

View changes

vlsi reviewed Jan 27, 2018

View changes

vlsi reviewed Jan 28, 2018

View changes

whitingjr Feb 19, 2018 •

edited

vlsi merged commit `e5aab1c` into pgjdbc:master Mar 11, 2018
1 check was pending