Merge pull request #616 from Crack/nan-skipping

Fix #614: drop NaN and infinity values from fields

Author: majst01

CHANGELOG.md

@@ -5,6 +5,8 @@
 ### Fixes
 
 - Add new annotation called TimeColumn for timestamp field in POJO bean, this can set Point time and precision field correctly, also avoid UnableToParseException when flush Point to influx.
+- Skip fields with NaN and infinity values when writing to InfluxDB
+  [Issue #614](https://github.com/influxdata/influxdb-java/issues/614)
 
 ## 2.15 [2019-02-22]
 

src/main/java/org/influxdb/dto/Point.java

@@ -405,22 +405,31 @@ public String toString() {
   }
 
   /**
-   * calculate the lineprotocol entry for a single Point.
+   * Calculate the lineprotocol entry for a single Point.
+   * <p>
+   * NaN and infinity values are silently dropped as they are unsupported:
+   * https://github.com/influxdata/influxdb/issues/4089
    *
-   * Documentation is WIP : https://github.com/influxdb/influxdb/pull/2997
+   * @see <a href="https://docs.influxdata.com/influxdb/v1.7/write_protocols/line_protocol_reference/">
+   *     InfluxDB line protocol reference</a>
    *
-   * https://github.com/influxdb/influxdb/blob/master/tsdb/README.md
-   *
-   * @return the String without newLine.
+   * @return the String without newLine, empty when there are no fields to write
    */
   public String lineProtocol() {
     return lineProtocol(null);
   }
 
   /**
    * Calculate the lineprotocol entry for a single point, using a specific {@link TimeUnit} for the timestamp.
+   * <p>
+   * NaN and infinity values are silently dropped as they are unsupported:
+   * https://github.com/influxdata/influxdb/issues/4089
+   *
+   * @see <a href="https://docs.influxdata.com/influxdb/v1.7/write_protocols/line_protocol_reference/">
+   *     InfluxDB line protocol reference</a>
+   *
    * @param precision the time precision unit for this point
-   * @return the String without newLine
+   * @return the String without newLine, empty when there are no fields to write
    */
   public String lineProtocol(final TimeUnit precision) {
 
@@ -431,7 +440,10 @@ public String lineProtocol(final TimeUnit precision) {
 
     escapeKey(sb, measurement);
     concatenatedTags(sb);
-    concatenatedFields(sb);
+    int writtenFields = concatenatedFields(sb);
+    if (writtenFields == 0) {
+      return "";
+    }
     formatedTime(sb, precision);
 
     return sb.toString();
@@ -447,10 +459,11 @@ private void concatenatedTags(final StringBuilder sb) {
     sb.append(' ');
   }
 
-  private void concatenatedFields(final StringBuilder sb) {
+  private int concatenatedFields(final StringBuilder sb) {
+    int fieldCount = 0;
     for (Entry<String, Object> field : this.fields.entrySet()) {
       Object value = field.getValue();
-      if (value == null) {
+      if (value == null || isNotFinite(value)) {
         continue;
       }
       escapeKey(sb, field.getKey());
@@ -471,13 +484,17 @@ private void concatenatedFields(final StringBuilder sb) {
       }
 
       sb.append(',');
+
+      fieldCount++;
     }
 
     // efficiently chop off the trailing comma
     int lengthMinusOne = sb.length() - 1;
     if (sb.charAt(lengthMinusOne) == ',') {
       sb.setLength(lengthMinusOne);
     }
+
+    return fieldCount;
   }
 
   static void escapeKey(final StringBuilder sb, final String key) {
@@ -505,6 +522,11 @@ static void escapeField(final StringBuilder sb, final String field) {
     }
   }
 
+  private static boolean isNotFinite(final Object value) {
+    return value instanceof Double && !Double.isFinite((Double) value)
+            || value instanceof Float && !Float.isFinite((Float) value);
+  }
+
   private void formatedTime(final StringBuilder sb, final TimeUnit precision) {
     if (this.time == null) {
       return;

src/test/java/org/influxdb/dto/PointTest.java

@@ -483,6 +483,44 @@ public void testTagKeyIsSortedInLineProtocol() {
       assertThat(tags).isEqualTo(correctOrder);
     }
 
+    @Test
+    public void lineProtocolSkippingOfNanFields() {
+		String lineProtocol;
+
+		lineProtocol = Point
+				.measurement("test")
+				.time(1, TimeUnit.MILLISECONDS)
+				.addField("float-valid", 1f)
+				.addField("float-nan", Float.NaN)
+				.addField("float-inf1", Float.NEGATIVE_INFINITY)
+				.addField("float-inf2", Float.POSITIVE_INFINITY)
+				.tag("host", "serverA")
+				.build()
+				.lineProtocol(TimeUnit.MILLISECONDS);
+		assertThat(lineProtocol).isEqualTo("test,host=serverA float-valid=1.0 1");
+
+		lineProtocol = Point
+				.measurement("test")
+				.time(1, TimeUnit.MILLISECONDS)
+				.addField("double-valid", 1d)
+				.addField("double-nan", Double.NaN)
+				.addField("double-inf1", Double.NEGATIVE_INFINITY)
+				.addField("double-inf2", Double.POSITIVE_INFINITY)
+				.tag("host", "serverA")
+				.build()
+				.lineProtocol(TimeUnit.MILLISECONDS);
+		assertThat(lineProtocol).isEqualTo("test,host=serverA double-valid=1.0 1");
+
+		lineProtocol = Point
+				.measurement("test")
+				.time(1, TimeUnit.MILLISECONDS)
+				.addField("double-nan", Double.NaN)
+				.tag("host", "serverA")
+				.build()
+				.lineProtocol(TimeUnit.MILLISECONDS);
+		assertThat(lineProtocol).isEqualTo("");
+    }
+
 
   @Test
   public void testAddFieldsFromPOJONullCheck() {