refactor: fix getDriverVersion and getDriverName and getJDBCMajor/MinorVersion methods #668

jorsol · 2016-10-19T18:11:33Z

The driver name is "PostgreSQL JDBC Driver"
The output of the driver version should not include "PostgreSQL"

vlsi · 2016-10-19T18:23:54Z

The output of the driver version should not include "PostgreSQL"

Any specific reason for doing so?
I'm afraid it might trigger unexpected backward-compatibility issues

codecov-io · 2016-10-19T18:34:35Z

Current coverage is 64.37% (diff: 41.66%)

Merging #668 into master will increase coverage by 0.14%

@@             master       #668   diff @@
==========================================
  Files           163        163          
  Lines         15142      15140     -2   
  Methods           0          0          
  Messages          0          0          
  Branches       2987       2987          
==========================================
+ Hits           9727       9747    +20   
+ Misses         4182       4156    -26   
- Partials       1233       1237     +4

Powered by Codecov. Last update e1a2578...b564f42

jorsol · 2016-10-19T18:57:29Z

@vlsi, prior to maven conversion the version was returned in this format:

42c2e3b#diff-a82520f846ea7ba590d13a466aeafffeL498

The output of postgresql-9.3-1103.jdbc3.jar is "PostgreSQL 9.3 JDBC3g (build 1103)"
and the output of postgresql-9.4-1206-jdbc42.jar is "PostgreSQL 9.4 JDBC4.2 (build 1206)"
so there was already a "potential" backward-compatibility issue since now returns "PostgreSQL 9.4.1211".

I doubt anyone is using that to "parse" the version of the driver, for that there is getDriverMajorVersion() and getDriverMinorVersion() methods. It's a matter of correctness since getDriverVersion() means version.

davecramer · 2016-10-19T19:10:11Z

given that nobody looks at it, I guess this is fine, on the other hand nobody looks at it ;)

panchenko · 2016-10-20T05:11:49Z

pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java

+  /**
+   * Retrieves the name of this JDBC driver.
+   *
+   * @return "PostgreSQL JDBC Driver"


getDriverName() incompatibility has potentially higher impact than getDriverVersion().

Good catch. Please revert this change

@panchenko have you find a project that use getDriverName() to implement logic and cause a potentially higher impact? I don't have found any.

jorsol · 2016-10-20T16:54:52Z

IMO general applications use getDriverVersion() and getDriverName() for printing information not for implement logic.

I did a quick find (nothing deep) on "potential" projects that "probably" use this information which are mostly ORMs, on JOOQ, Sprint-JDBC, Hibernate and found.... nothing.

Since we have entered in a highly speculative area I will close this PR.

jorsol · 2016-11-29T16:38:16Z

Now that we have moving forward with versioning 42 this can be reconsidered.

vlsi · 2016-12-30T19:27:46Z

pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java

+  /**
+   * Retrieves the major JDBC version number for this driver.
+   *
+   * @return JDBC version major number


vlsi

In general looks good, except two things:

I would like to refrain from copy-pasting inherited javadocs. The build process handles that just fine (I mean it is smart enough to copy javadocs from java.sql.* and alike).
string split in getXXXversion look odd.

vlsi · 2016-12-30T19:35:58Z

pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java

+   *
+   * @return JDBC version major number
+   */
+  @Override


Any clue why do you copy javadocs for @Override methods?

AFAIK, javadoc build does handle that just fine.
See http://static.javadoc.io/org.postgresql/postgresql/9.4.1212.jre7/org/postgresql/Driver.html#getParentLogger() as an example.

So I would remove all the inherited copy-pasted javadocs unless they have some postgresql specifics.
For instance, connect method does have some PG specific, so it is LGTM. On the other hand, things like Retrieves the major JDBC version number for this driver add little value and can be inherited.

However, in this particular method adding some pgjdbc-specific example would help a lot. For instance "The method returns the driver major version, not the versions of the backend. This method would return something like 42 ad pgjdbc versions are like 42.x.y."

Good point, I will look at it.

Well, technically speaking, there's non-trivial build step that unzips jdk sources (e.g. https://github.com/pgjdbc/pgjdbc-parent-poms/blob/master/pgjdbc-core-parent/pom.xml#L270-L278) and adds them to javadoc tool, however it does "just work".

vlsi · 2016-12-30T19:35:58Z

pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java

+   */
+  @Override
+  public int getJDBCMajorVersion() {
+    return Integer.parseInt(JDBCVERSION.split("\\.")[0]);


Is mvn.project.property.parsedversion.majorversion better here?

No, the mvn.project.property.parsedversion.majorversion is for the driver version, not for the JDBC specification version, so this should return 4 as the major specification version, this is get from mvn.project.property.jdbc.specification.version and parsed the first number.

vlsi · 2016-12-30T19:35:58Z

pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java

+   */
+  @Override
+  public int getJDBCMinorVersion() {
+    return Integer.parseInt(JDBCVERSION.split("\\.")[1]);


Is mvn.project.property.parsedversion.minorversion better here

No, the mvn.project.property.parsedversion.minorversion is for the driver version, not for the JDBC specification version, so this should return 0 for Java 6, 1 for Java 7 and 2 for Java 8 as the major specification version, this is get from mvn.project.property.jdbc.specification.version and parsed the second number.

jorsol · 2017-01-01T01:46:16Z

@vlsi, requested changes done, removed javadoc that can be inherited, I could not reproduce the behavior using mvn javadoc:javadoc but since the release artifact use a special "unzip jdk" I guess it's ok.

For the second point, the other form to split the version is with a StringTokenizer, but the JavaDocs say:

StringTokenizer is a legacy class that is retained for compatibility reasons although its use is discouraged in new code. It is recommended that anyone seeking this functionality use the split method of String or the java.util.regex package instead.

Happy New Year!

jorsol · 2017-01-05T20:31:12Z

Another comment about this?

jorsol · 2017-01-12T04:12:20Z

@vlsi , is there any other request on this?

panchenko · 2017-01-12T04:58:14Z

pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java

-   *
-   * @exception SQLException if a database access error occurs
+   * @return "PostgreSQL"
+   * @throws SQLException if a database access error occurs


I would rather remove "throws" from code, rather then documenting it.

panchenko · 2017-01-12T04:59:33Z

pgjdbc/src/main/java/org/postgresql/PGProperty.java

@@ -281,7 +282,7 @@
  /**
   * The application name (require server version &gt;= 9.0)
   */
-  APPLICATION_NAME("ApplicationName", null, "name of the application (backend >= 9.0)"),
+  APPLICATION_NAME("ApplicationName", DriverInfo.DRIVER_NAME, "Name of the Application (backend >= 9.0)"),


Is this default absolutely necessary?

And why not?

Theoretically, one might want a connection without this property. I don't have a real world example for that, just being cautious about unnecessary changes :-)

panchenko · 2017-01-12T05:06:09Z

pgjdbc/src/main/java/org/postgresql/util/DriverInfo.java

+
+  public static final String JDBC_VERSION = "/*$mvn.project.property.jdbc.specification.version$*/";
+  public static final int JDBC_MAJOR_VERSION = Integer.parseInt(JDBC_VERSION.split("\\.")[0]);
+  public static final int JDBC_MINOR_VERSION = Integer.parseInt(JDBC_VERSION.split("\\.")[1]);


in poms there is also jdbc.specification.version.nodot - might be use it and int math operations instead?

Maybe, but the problem with the split is?

Less operations during runtime, it will be just a compile time constant.

static final fields are initialized once, so there's no point in discussing "runtime overhead"

My main concern on .split was it is hard to get right ("off by one" errors and so on).

The property is set by default on the pom, so it should be hard to "break" or get the "off by one" errors, I can use the int math if you wish, at least it will allow to catch bad values at compile time.

To be completely safe there must be the properties in the pom.xml and use those values.
jdbc.specification.majorversion
jdbc.specification.minorversion

…ersion methods

jorsol · 2017-01-12T18:41:40Z

Now is using the int math, what do you think?

The method was removed in pgjdbc#668, however certain applications might still depend on it. Mark the method as deprecated.

…#905) The method was removed in #668, however certain applications might still depend on it. See https://www.postgresql.org/message-id/CAJFwRrOkE2HsU8FitvEEb971d6XQRfSQJVi1AEsjBxziFGinvQ%40mail.gmail.com Mark the method as deprecated.

…pgjdbc#905) The method was removed in pgjdbc#668, however certain applications might still depend on it. See https://www.postgresql.org/message-id/CAJFwRrOkE2HsU8FitvEEb971d6XQRfSQJVi1AEsjBxziFGinvQ%40mail.gmail.com Mark the method as deprecated.

hmatt1 · 2018-01-04T15:28:17Z

It turns out ActiveMQ was relying on the original name, so this change broke compatibility. See this issue: https://issues.apache.org/jira/browse/AMQ-6780

davecramer · 2018-01-04T15:29:33Z

@hmatt1 not sure how that is our problem ?

hmatt1 · 2018-01-04T16:45:28Z

@davecramer it's not, no action needed on your part. I figured I share because jorsol commented

IMO general applications use getDriverVersion() and getDriverName() for printing information not for implement logic.

and it turns out ActiveMQ is relying on getDriverName()

jorsol · 2018-01-04T17:04:32Z

Yes, and it's ActiveMQ fault to relying on getDriverName(), for instance if I want to use pgjdbc-ng or a custom fork of PgJDBC, it makes impossible to change it.

panchenko reviewed Oct 20, 2016

View changes

jorsol closed this Oct 20, 2016

jorsol reopened this Nov 29, 2016

jorsol force-pushed the jorsol:change_version_output branch from fb6ea20 to 6a3d427 Dec 6, 2016

jorsol force-pushed the jorsol:change_version_output branch 2 times, most recently from 0cbbb4c to b7e7fec Dec 14, 2016

vlsi reviewed Dec 30, 2016

View changes

pgjdbc/src/main/java/org/postgresql/jdbc/PgDatabaseMetaData.java Outdated

/**

* Retrieves the major JDBC version number for this driver.

*

* @return JDBC version major number

This comment has been minimized.

Sign in to view

vlsi Dec 30, 2016
Member

Any clue

vlsi requested changes Dec 30, 2016

View changes

vlsi added this to the 42.0.0 milestone Dec 30, 2016

jorsol force-pushed the jorsol:change_version_output branch 6 times, most recently from 0e8f448 to 415b3c3 Dec 30, 2016

jorsol changed the title ~~style: fix getDriverVersion() and getDriverName() methods~~ refactor: fix getDriverVersion and getDriverName and getJDBCMajor/MinorVersion methods Jan 1, 2017

jorsol force-pushed the jorsol:change_version_output branch 2 times, most recently from 6f92d48 to 18bedad Jan 2, 2017

panchenko reviewed Jan 12, 2017

View changes

jorsol force-pushed the jorsol:change_version_output branch 3 times, most recently from e5aeb90 to 7501977 Jan 12, 2017

refactor: fix getDriverVersion, getDriverName and getJDBCMajor/MinorV…

Loading status checks…

b564f42

…ersion methods

jorsol force-pushed the jorsol:change_version_output branch from 7501977 to b564f42 Jan 12, 2017

vlsi approved these changes Jan 20, 2017

View changes

vlsi merged commit aa97434 into pgjdbc:master Jan 20, 2017
2 checks passed

2 checks passed

codecov/project 64.37% (+0.14%) compared to e1a2578
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

jorsol deleted the jorsol:change_version_output branch Jan 27, 2017

vlsi mentioned this pull request Aug 4, 2017

fix: reintroduce Driver.getVersion for backward compatibility reasons #905

Merged

pgjdbc / pgjdbc

refactor: fix getDriverVersion and getDriverName and getJDBCMajor/MinorVersion methods #668

refactor: fix getDriverVersion and getDriverName and getJDBCMajor/MinorVersion methods #668

jorsol commented Oct 19, 2016

vlsi commented Oct 19, 2016

codecov-io commented Oct 19, 2016 •

edited

jorsol commented Oct 19, 2016

davecramer commented Oct 19, 2016

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jorsol commented Oct 20, 2016

jorsol commented Nov 29, 2016

This comment has been minimized.

vlsi left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jorsol commented Jan 1, 2017

jorsol commented Jan 5, 2017

jorsol commented Jan 12, 2017

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jorsol commented Jan 12, 2017

hmatt1 commented Jan 4, 2018

davecramer commented Jan 4, 2018

hmatt1 commented Jan 4, 2018

jorsol commented Jan 4, 2018

pgjdbc / pgjdbc

refactor: fix getDriverVersion and getDriverName and getJDBCMajor/MinorVersion methods #668

refactor: fix getDriverVersion and getDriverName and getJDBCMajor/MinorVersion methods #668

Conversation

jorsol commented Oct 19, 2016

vlsi commented Oct 19, 2016

codecov-io commented Oct 19, 2016 • edited

Current coverage is 64.37% (diff: 41.66%)

jorsol commented Oct 19, 2016

davecramer commented Oct 19, 2016

This comment has been minimized.

panchenko Oct 20, 2016

This comment has been minimized.

davecramer Oct 20, 2016 Member

This comment has been minimized.

jorsol Dec 30, 2016 Author Member

jorsol commented Oct 20, 2016

jorsol commented Nov 29, 2016

This comment has been minimized.

vlsi Dec 30, 2016 Member

vlsi left a comment

This comment has been minimized.

vlsi Dec 30, 2016 Member

This comment has been minimized.

jorsol Dec 30, 2016 Author Member

This comment has been minimized.

vlsi Dec 30, 2016 • edited Member

This comment has been minimized.

vlsi Dec 30, 2016 Member

This comment has been minimized.

jorsol Dec 30, 2016 Author Member

This comment has been minimized.

vlsi Dec 30, 2016 Member

This comment has been minimized.

jorsol Dec 30, 2016 Author Member

jorsol commented Jan 1, 2017

jorsol commented Jan 5, 2017

jorsol commented Jan 12, 2017

This comment has been minimized.

panchenko Jan 12, 2017

This comment has been minimized.

panchenko Jan 12, 2017

This comment has been minimized.

jorsol Jan 12, 2017 Author Member

This comment has been minimized.

panchenko Jan 12, 2017

This comment has been minimized.

panchenko Jan 12, 2017

This comment has been minimized.

jorsol Jan 12, 2017 Author Member

This comment has been minimized.

panchenko Jan 12, 2017

This comment has been minimized.

vlsi Jan 12, 2017 Member

This comment has been minimized.

jorsol Jan 12, 2017 Author Member

jorsol commented Jan 12, 2017

hmatt1 commented Jan 4, 2018

davecramer commented Jan 4, 2018

hmatt1 commented Jan 4, 2018

jorsol commented Jan 4, 2018

codecov-io commented Oct 19, 2016 •

edited

davecramer Oct 20, 2016
Member

jorsol Dec 30, 2016
Author Member

vlsi Dec 30, 2016
Member

vlsi Dec 30, 2016
Member

jorsol Dec 30, 2016
Author Member

vlsi Dec 30, 2016 •

edited

Member

vlsi Dec 30, 2016
Member

jorsol Dec 30, 2016
Author Member

vlsi Dec 30, 2016
Member

jorsol Dec 30, 2016
Author Member

jorsol Jan 12, 2017
Author Member

jorsol Jan 12, 2017
Author Member

vlsi Jan 12, 2017
Member

jorsol Jan 12, 2017
Author Member