fix: automatically adjusting timestamp (#168)

Author: vlastahajek

CHANGELOG.md

@@ -1,4 +1,8 @@
 # Changelog
+## Unreleased
+### Fixes
+- [193](https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino/pull/193) - Automatically adjusting point timestamp  according to the setting of write precision. 
+
 ## 3.12.0 [2022-03-21]
 ### Features
 - [185](https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino/pull/185) - Added diagnostic server connection state getter `bool InfluxDBClient::isConnected()`

src/InfluxDbClient.cpp

@@ -285,17 +285,49 @@ void InfluxDBClient::reserveBuffer(int size) {
     }
 }
 
-bool InfluxDBClient::writePoint(Point & point) {
-    if (point.hasFields()) {
-        if(_writeOptions._writePrecision != WritePrecision::NoTime && !point.hasTime()) {
+void InfluxDBClient::addZerosToTimestamp(Point &point, int zeroes) {
+    char *ts = point._timestamp, *s;
+    point._timestamp = new char[strlen(point._timestamp) + 1 + zeroes];
+    strcpy(point._timestamp, ts);
+    s = point._timestamp+strlen(ts);
+    for(int i=0;i<zeroes;i++) {
+        *s++ = '0';
+    }
+    *s = 0;
+    delete [] ts;
+}
+
+void InfluxDBClient::checkPrecisions(Point & point) {
+    if(_writeOptions._writePrecision != WritePrecision::NoTime) {
+        if(!point.hasTime()) {
             point.setTime(_writeOptions._writePrecision);
+        // Check different write precisions
+        } else if(point._tsWritePrecision != WritePrecision::NoTime && point._tsWritePrecision != _writeOptions._writePrecision) {
+            int diff = int(point._tsWritePrecision) - int(_writeOptions._writePrecision);
+            if(diff > 0) { //point has higher precision, cut 
+                point._timestamp[strlen(point._timestamp)-diff*3] = 0;
+            } else { //point has lower precision, add zeroes
+                addZerosToTimestamp(point, diff*-3);
+            }
         }
+    // check someone set WritePrecision on point and not on client. NS precision is ok, cause it is default on server
+    } else if(point.hasTime() && point._tsWritePrecision != WritePrecision::NoTime && point._tsWritePrecision != WritePrecision::NS) {
+        int diff = int(WritePrecision::NS) - int(point._tsWritePrecision);
+        addZerosToTimestamp(point, diff*3);
+    } 
+}
+
+bool InfluxDBClient::writePoint(Point & point) {
+    if (point.hasFields()) {
+        checkPrecisions(point);
         String line = pointToLineProtocol(point);
         return writeRecord(line);
     }
     return false;
 }
 
+
+
 InfluxDBClient::Batch::Batch(uint16_t size):_size(size) {  
     buffer = new char*[size]; 
     for(int i=0;i< _size; i++) {

src/InfluxDbClient.h

@@ -263,6 +263,10 @@ class InfluxDBClient {
     //  flashOnlyFull - whether to flush only full batches
     // Returns true if successful, false in case of any error 
     bool flushBufferInternal(bool flashOnlyFull);
+    // Checks precision of point and mofifies if needed
+    void checkPrecisions(Point & point);
+    // helper which adds zeroes to timestamo of point to increase precision
+    static void addZerosToTimestamp(Point &point, int zeroes);
 };
 
 

src/Point.cpp

@@ -32,6 +32,7 @@ Point::Point(const String & measurement)
 {
     _measurement = escapeKey(measurement, false);
     _timestamp = nullptr;
+    _tsWritePrecision = WritePrecision::NoTime;
 }
 
 Point::~Point() {
@@ -171,6 +172,7 @@ void  Point::setTime(WritePrecision precision) {
             setTime((char *)nullptr);
             break;
     }
+    _tsWritePrecision = precision;
 }
 
 void  Point::setTime(unsigned long long timestamp) {
@@ -187,7 +189,7 @@ void Point::setTime(const char *timestamp) {
 
 void Point::setTime(char *timestamp) {
     delete [] _timestamp;
-    timestamp = timestamp;
+    _timestamp = timestamp;
 }
 
 void  Point::clearFields() {

src/Point.h

@@ -84,6 +84,7 @@ friend class InfluxDBClient;
     String _tags;
     String _fields;
     char *_timestamp;
+    WritePrecision _tsWritePrecision;
   protected:    
     // method for formating field into line protocol
     void putField(const String &name, const String &value);

src/WritePrecision.h

@@ -27,7 +27,7 @@
 #ifndef _WRITE_PRECISION_H_
 #define _WRITE_PRECISION_H_
 // Enum WritePrecision defines constants for specifying InfluxDB write prcecision
-enum class WritePrecision  {
+enum class WritePrecision:uint8_t  {
   // Specifyies that points has no timestamp (default). Server will assign timestamp. 
   NoTime = 0,
   // Seconds

test/Test.cpp

@@ -71,6 +71,7 @@ void Test::run() {
     testLargeBatch();  
     testFailedWrites();
     testTimestamp();
+    testTimestampAdjustment();
     testRetryOnFailedConnection();
     testRetryOnFailedConnectionWithFlush();
     testNonRetry();
@@ -1217,10 +1218,11 @@ void Test::testTimestamp() {
         delayMicroseconds(100);
     }
 
-
+    
     serverLog(Test::apiUrl, "testTimestamp");
     InfluxDBClient client(Test::apiUrl, Test::orgName, Test::bucketName, Test::token);
     client.setWriteOptions(WritePrecision::S, 1, 5);
+    waitServer(Test::managementUrl, true);
     //test with no batching
     TEST_ASSERT(client.validateConnection());
     uint32_t timestamp;
@@ -1283,6 +1285,44 @@ void Test::testTimestamp() {
     serverLog(Test::apiUrl, "testTimestamp end");
 }
 
+void Test::testTimestampAdjustment() {
+    TEST_INIT("testTimestampAdjustment");
+    InfluxDBClient client;
+    // test no client precision, but on point
+    Point point("a");
+    point.setTime(WritePrecision::S);
+    client.checkPrecisions(point);
+    TEST_ASSERTM(point.getTime().endsWith("000000000"),point.getTime() );
+
+    point.setTime(WritePrecision::MS);
+    client.checkPrecisions(point);
+    TEST_ASSERTM(point.getTime().endsWith("000"),point.getTime() );
+
+    //test not modified ts
+    point.setTime(WritePrecision::NS);
+    String a = point.getTime();
+    client.checkPrecisions(point);
+    TEST_ASSERTM(a == point.getTime(), point.getTime() );
+    
+    // test client precision and not point
+    client.setWriteOptions(WriteOptions().writePrecision(WritePrecision::S));
+    point.setTime(WritePrecision::NoTime);
+    TEST_ASSERTM(!point.hasTime(), point.getTime() );
+    client.checkPrecisions(point);
+    TEST_ASSERTM(point.getTime().length() == 10, point.getTime() );
+    // test cut
+    point.setTime(WritePrecision::US);
+    client.checkPrecisions(point);
+    TEST_ASSERTM(point.getTime().length() == 10, point.getTime() );
+    // test extending
+    client.setWriteOptions(WriteOptions().writePrecision(WritePrecision::US));
+    point.setTime(WritePrecision::S);
+    client.checkPrecisions(point);
+    TEST_ASSERTM(point.getTime().endsWith("000000"),point.getTime() );
+
+    TEST_END();
+}
+
 void Test::testV1() {
     TEST_INIT("testV1");
     InfluxDBClient client;

test/Test.h

@@ -60,6 +60,7 @@ class Test : public  TestBase {
     static void testUserAgent();
     static void testFailedWrites();
     static void testTimestamp();
+    static void testTimestampAdjustment();
     static void testHTTPReadTimeout();
     static void testRetryOnFailedConnection();
     static void testRetryOnFailedConnectionWithFlush();

test/test.ino

@@ -34,11 +34,7 @@
 #include "E2ETest.h"
 
 void setup() {
-#if defined(ESP8266)
-    Serial.begin(74880);
-#else
     Serial.begin(115200);
-#endif    
     delay(2000);
     Serial.println("Initializing tests");
     Serial.println(" Compiled on "  __DATE__ " " __TIME__);