API and JavaDoc changes for Spatial Datatypes by peterbae · Pull Request #752 · microsoft/mssql-jdbc

peterbae · 2018-07-19T16:10:12Z

Changes needed after fuzz testing.

codecov-io · 2018-07-19T16:35:34Z

Codecov Report

Merging #752 into dev will decrease coverage by 0.13%.
The diff coverage is 70.64%.

@@             Coverage Diff              @@
##                dev     #752      +/-   ##
============================================
- Coverage     48.32%   48.19%   -0.14%     
+ Complexity     2773     2765       -8     
============================================
  Files           116      116              
  Lines         27871    27831      -40     
  Branches       4631     4624       -7     
============================================
- Hits          13469    13412      -57     
- Misses        12218    12229      +11     
- Partials       2184     2190       +6

Flag	Coverage Δ	Complexity Δ
#JDBC42	`47.73% <70.64%> (+0.01%)`	`2724 <65> (+2)`	⬆️
#JDBC43	`48.05% <70.64%> (-0.21%)`	`2756 <65> (-15)`

Impacted Files	Coverage Δ	Complexity Δ
...rosoft/sqlserver/jdbc/InternalSpatialDatatype.java	`91.3% <ø> (ø)`	`6 <0> (ø)`	⬇️
...oft/sqlserver/jdbc/SQLServerPreparedStatement.java	`54.11% <0%> (ø)`	`211 <0> (ø)`	⬇️
...in/java/com/microsoft/sqlserver/jdbc/Geometry.java	`50.79% <53.33%> (-21.65%)`	`14 <3> (-19)`
...n/java/com/microsoft/sqlserver/jdbc/Geography.java	`50.79% <56.25%> (-19.29%)`	`14 <4> (-19)`
...osoft/sqlserver/jdbc/SQLServerSpatialDatatype.java	`85.38% <74.4%> (-0.88%)`	`290 <58> (+33)`
...rc/main/java/com/microsoft/sqlserver/jdbc/DDC.java	`43.1% <0%> (-2.19%)`	`105% <0%> (-2%)`
...m/microsoft/sqlserver/jdbc/SQLServerException.java	`75.75% <0%> (-1.52%)`	`30% <0%> (-1%)`
...rc/main/java/com/microsoft/sqlserver/jdbc/dtv.java	`62.2% <0%> (-0.35%)`	`0% <0%> (ø)`
...om/microsoft/sqlserver/jdbc/SQLServerBulkCopy.java	`52.54% <0%> (-0.18%)`	`262% <0%> (-2%)`
... and 5 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2d0f906...2f886a0. Read the comment docs.

lilgreenbird · 2018-07-19T17:17:46Z

    }

+    /**
+     * Returns the figuresAttribute value.


I am changing everything to be consistent. For getters, can you please say "Gets blah blah"?

lilgreenbird · 2018-07-19T17:17:57Z

+import java.text.MessageFormat;


 public class Geography extends SQLServerSpatialDatatype {


needs class description

lilgreenbird · 2018-07-19T19:45:44Z


    /**
-     * Returns the X coordinate value.
+     * Gets the X coordinate value.


I am sorry I made you change.....we're now going with "Returns the something of this thing." as per new guideline. You can leave it if you want I'm changing all the other files to be consistent I can change this after you merge.

cheenamalhotra · 2018-07-20T23:27:11Z

    protected void constructWKT(SQLServerSpatialDatatype sd, InternalSpatialDatatype isd, int pointIndexEnd,
            int figureIndexEnd, int segmentIndexEnd, int shapeIndexEnd) throws SQLServerException {
-        if (null == points || numberOfPoints == 0) {
+        if (null == xpoints || numberOfPoints == 0) {


null=xpoints check is not needed. numberOfPoints is enough to be checked.

cheenamalhotra · 2018-07-20T23:27:52Z

-        int firstPointIndex = pointIndex * 2;
-        int secondPointIndex = firstPointIndex + 1;
        int zValueIndex = pointIndex;
        int mValueIndex = pointIndex;


Please remove these unwanted mValueIndex and zValueIndex too.

cheenamalhotra · 2018-07-20T23:30:24Z

+    protected double xpoints[];
+    protected double ypoints[];
    protected double zValues[];
    protected double mValues[];


All these 4 arrays form contain point coordinates, naming should be consistent.

cheenamalhotra · 2018-07-20T23:38:44Z


    /**
-     * Constructs a Geography instance that represents a Point instance from its X and Y values and an SRID.
+     * Constructor for a Geography instance that represents a Point instance from its X and Y values and an SRID.


SRID = Spatial Reference System Identifier
Also add to the param tags in all functions

cheenamalhotra · 2018-07-20T23:58:52Z

@@ -203,8 +216,8 @@ public boolean hasZ() {
     * @return double value that represents the X coordinate.
     */
    public Double getX() {


Please rename getX() and getY() to getLatitude() and getLongitude() for Geography.
A Geographic Point should always reference them as Latitude and Longitude. There should be no API neither documentation for these co-ordinates as X or Y in context of Geography Point.

cheenamalhotra · 2018-07-23T17:01:48Z

     *        y coordinate
     * @param srid
-     *        SRID
+     *        Spatial Reference Identifier Spatial Reference Identifier value


cheenamalhotra · 2018-07-23T17:02:11Z

@@ -215,9 +216,9 @@ public boolean hasZ() {
     * 
     * @return double value that represents the X coordinate.


Please fix Javadocs too. Also for getY() function

cheenamalhotra · 2018-07-23T17:02:44Z

     * @param x
     *        x coordinate
     * @param y
     *        y coordinate


Also fix params + javadocs for the constructor

ulvii · 2018-07-23T19:54:20Z

@@ -403,10 +417,11 @@ protected void parseWkb() {
    }

    private void readPoints() {


Looks like a few methods are duplicated in both Geometry/Geography classes and they should be moved to SQLServerSpatialDatatype.

parseWkb(), exact duplicate.

readPoints(), serializeToWkb() - The only difference is you have to read yValues before xValues. Can you add some kind of a check and move these methods to SQLServerSpatialDatatype too?

There is a lot of duplication in other methods too, please take a look and move to SQLServerSpatialDatatype when possible.

ulvii · 2018-07-23T21:25:16Z

            throw new BatchUpdateException(e.getMessage(), null, 0, null);
-        } catch (IllegalArgumentException e) {
+        }
+        catch (IllegalArgumentException | StringIndexOutOfBoundsException e) {


I guess this change is not related to Spatial types? You probably need to update the comment below too.

Please move this change out of this PR as we already have another active PR to track useBulkCopyWithBatchInsert API changes. It will be easier to track changes there.

ulvii · 2018-07-23T23:14:28Z

+
+    private void checkNegSize(int num) throws SQLServerException {
+        if (num < 0) {
+            MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_ParsingError"));


why don't you call throwIllegalWKB() instead here?

ulvii · 2018-07-23T23:20:03Z

Approved, assuming we will improve the way we handle exceptions.

cheenamalhotra · 2018-07-24T04:27:56Z

+     *        Spatial Reference Identifier value
     * @return Geography Geography instance
     * @throws SQLServerException
     *         if an exception occurs


I guess you missed out on the method params: x and y should be changed to latitude/longitude respectively.
Refer: MS Docs

cheenamalhotra · 2018-07-24T04:31:33Z

@@ -22,17 +27,20 @@ public class Geometry extends SQLServerSpatialDatatype {
     *         if an exception occurs
     */
    private Geometry(String WellKnownText, int srid) throws SQLServerException {


First character in param name must not be capitalized. Please change to 'wellKnownText'

cheenamalhotra · 2018-07-24T04:33:17Z

+     * Constructor for a Geometry instance from an Open Geospatial Consortium (OGC) Well-Known Text (WKT)
+     * representation. Spatial Reference Identifier is defaulted to 0.
     * 
     * @param wkt


This method has param name as wkt, the other method has wellKnownText, can we generalize and use same name for all similar parameters?

cheenamalhotra · 2018-07-24T04:37:48Z

            throw new BatchUpdateException(e.getMessage(), null, 0, null);
-        } catch (IllegalArgumentException e) {
+        }
+        catch (IllegalArgumentException | StringIndexOutOfBoundsException e) {


Please move this change out of this PR as we already have another active PR to track useBulkCopyWithBatchInsert API changes. It will be easier to track changes there.

cheenamalhotra · 2018-07-24T04:40:27Z

+            wkb = buf.array();
+
+        }
+        return;


Do we need this return statement here? Also a blank line in the else block above looks unnecessary.

…sql-jdbc into Fuzz_And_Javadoc_fix

ulvii · 2018-07-26T21:11:02Z


 package com.microsoft.sqlserver.jdbc;

+import java.nio.BufferUnderflowException;


Do we still need to import this?

ulvii · 2018-07-26T21:49:57Z

+                    coords[numOfCoordinates] = Double.NaN;
+                    currentWktPos = currentWktPos + 4;
+                } else {
+                    MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_illegalWKTposition"));


Please create a method throwIllegalWKTposition. There are at least 5 places where you construct the Exception.

* Update Snapshot for upcoming RTW release v7.0.0 * Change order of logic for checking the condition for using Bulk Copy API (#736) Fix | Change order of logic for checking the condition for using Bulk Copy API (#736) * Update CHANGELOG.md * Merge pull request #732 from cheenamalhotra/module (Export driver in automatic module) Introduce Automatic Module Name in POM. * Update CHANGELOG.md * Change Sha1HashKey to CityHash128Key for generating PreparedStatement handle and metadata cache keys (#717) * Change Sha1HashKey to CityHash128Key * Formatted code * Prepared statement performance fixes 1) Further speedups to prepared statement hashing 2) Caching of '?' chararacter positiobs in prepared statements to speed parameter substitution * String compare for hash keys added missing line for bulkcopy tests. * comment change * Move CityHash class to a separate file * spacings fixes cleaner code & logic * Add | Adding useBulkCopyForBatchInsert property to Request Boundary methods (#739) * Apply the collation name change to UTF8SupportTest * Package changes for CityHash with license information (#740) * Reformatted Code + Updated formatter (#742) * Reformatted Code + Updated formatter * Fix policheck issue with 'Country' keyword (#745) * Adding a new test for beginRequest()/endRequest() (#746) * Add | Adding a new test to notify the developers to consider beginRequest()/endRequest() when adding a new Connection API * Fix | Fixes for issues reported by static analysis tools (SonarQube + Fortify) (#747) * handle buffer reading for invalid buffer input by user * Revert "handle buffer reading" This reverts commit 11e2bf4. * updated javadocs (#754) * fixed some typos in javadocs (#760) * API and JavaDoc changes for Spatial Datatypes (#752) Add | API and JavaDoc changes for Spatial Datatypes (#752) * Disallow non-parameterized queries for Bulk Copy API for batch insert (#756) fix | Disallow non-parameterized queries for Bulk Copy API for batch insert (#756) * Formatting | Change scope of unwanted Public APIs + Code Format (#757) * Fix unwanted Public APIs. * Updated formatter to add new line to EOF + formatted project * Release | Release 7.0 changelog and version update (#748) * Updated Changelog + release version changes * Changelog entry updated as per review. * Updated changelog for new changes * Terminology update: request boundary declaration APIs * Trigger Appveyor * Update Samples and add new samples for new features (#761) * Update Samples and add new Samples for new features * Update samples from Peter * Updated JavaDocs * Switch to block comment * Update License copyright (#767)

peterbae added 3 commits July 18, 2018 12:41

Added more exceptions for fuzz testing, and added some more javadocs

73edf05

fixing merge break

a09c247

removing log files

3f694ff

lilgreenbird reviewed Jul 19, 2018

View reviewed changes

javadoc changes

243f294

peterbae requested review from cheenamalhotra, rene-ye and ulvii July 19, 2018 18:34

lilgreenbird reviewed Jul 19, 2018

View reviewed changes

peterbae added 5 commits July 19, 2018 13:23

gets -> returns

537959f

add test

862d71d

split points into two

d86b237

move error message around

eac074f

check neg size for all number of sizes

79c7e59

cheenamalhotra reviewed Jul 20, 2018

View reviewed changes

reflect comments + make internal spatial datatype file protected

81a065f

cheenamalhotra requested changes Jul 23, 2018

View reviewed changes

peterbae added 2 commits July 23, 2018 10:16

more javadoc changes

7ec6fcc

switch lat/long

272a729

rene-ye previously approved these changes Jul 23, 2018

View reviewed changes

ulvii reviewed Jul 23, 2018

View reviewed changes

refactor out duplicate code

54c5297

peterbae dismissed rene-ye’s stale review via 54c5297 July 23, 2018 20:42

ulvii reviewed Jul 23, 2018

View reviewed changes

add null checking + change int to long

a3eb552

ulvii reviewed Jul 23, 2018

View reviewed changes

handle m and z value being null case and add test

0de6184

reuse function

b4fca56

cheenamalhotra reviewed Jul 24, 2018

View reviewed changes

cheenamalhotra added this to the 7.0.0 milestone Jul 24, 2018

peterbae added 3 commits July 24, 2018 09:48

move this part to other PR

3135521

reflect comment

2dfb95b

bit more javadoc

6f4af3d

rene-ye previously approved these changes Jul 24, 2018

View reviewed changes

remove StringIndexOutOfBoundsException

8aba9e6

peterbae dismissed rene-ye’s stale review via 8aba9e6 July 25, 2018 00:32

peterbae added 2 commits July 25, 2018 09:45

check wkt length

589c1c0

Merge branch 'dev' into Fuzz_And_Javadoc_fix

a61a58b

cheenamalhotra previously approved these changes Jul 26, 2018

View reviewed changes

peterbae added 2 commits July 26, 2018 12:58

remove catching runtime exception

1d7800d

Merge branch 'Fuzz_And_Javadoc_fix' of https://github.com/peterbae/ms…

1f3e437

…sql-jdbc into Fuzz_And_Javadoc_fix

peterbae dismissed cheenamalhotra’s stale review via 1f3e437 July 26, 2018 19:58

peterbae changed the title ~~Fuzz and javadoc fix~~ Fuzz testing for spatial datatypes Jul 26, 2018

ulvii reviewed Jul 26, 2018

View reviewed changes

dont need those imports

35d99a8

peterbae changed the title ~~Fuzz testing for spatial datatypes~~ API and JavaDoc changes for Spatial Datatypes Jul 26, 2018

ulvii reviewed Jul 26, 2018

View reviewed changes

peterbae added 3 commits July 26, 2018 14:50

use try blocks they're the best

e156263

refactor throwing illegal WKT position into a method

5ca2a83

apparently 0 and null are different, so fix that

2f886a0

ulvii approved these changes Jul 26, 2018

View reviewed changes

cheenamalhotra approved these changes Jul 27, 2018

View reviewed changes

rene-ye approved these changes Jul 27, 2018

View reviewed changes

peterbae merged commit aa0f653 into microsoft:dev Jul 27, 2018

		import java.text.MessageFormat;


		public class Geography extends SQLServerSpatialDatatype {

		@@ -215,9 +216,9 @@ public boolean hasZ() {
		*
		* @return double value that represents the X coordinate.

		@@ -403,10 +417,11 @@ protected void parseWkb() {
		}

		private void readPoints() {


		package com.microsoft.sqlserver.jdbc;

		import java.nio.BufferUnderflowException;

Conversation

peterbae commented Jul 19, 2018

Uh oh!

codecov-io commented Jul 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cheenamalhotra Jul 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cheenamalhotra Jul 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ulvii commented Jul 23, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ulvii Jul 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

codecov-io commented Jul 19, 2018 •

edited

Loading

cheenamalhotra Jul 20, 2018 •

edited

Loading

cheenamalhotra Jul 20, 2018 •

edited

Loading

ulvii Jul 26, 2018 •

edited

Loading