Merge pull request #35 from bonitoo-io/vh-user-agent

tobiasschuerg · web-flow · commit 38c0c63c1237 · 2020-03-12T19:03:16.000+01:00
Feat: Setting User-Agent header
diff --git a/src/InfluxDbClient.cpp b/src/InfluxDbClient.cpp
@@ -25,6 +25,20 @@
  * SOFTWARE.
 */
 #include "InfluxDbClient.h"
+#include <core_version.h>
+
+#define STRHELPER(x) #x
+#define STR(x) STRHELPER(x) // stringifier
+
+#if defined(ESP8266)
+# define INFLUXDB_CLIENT_PLATFORM "ESP8266"
+# define INFLUXDB_CLIENT_PLATFORM_VERSION  STR(ARDUINO_ESP8266_GIT_DESC)
+#elif defined(ESP32)
+# define INFLUXDB_CLIENT_PLATFORM "ESP32"
+# define INFLUXDB_CLIENT_PLATFORM_VERSION  STR(ARDUINO_ESP32_GIT_DESC)
+#endif
+
+static const char UserAgent[] PROGMEM = "influxdb-client-arduino/" INFLUXDB_CLIENT_VERSION " (" INFLUXDB_CLIENT_PLATFORM " " INFLUXDB_CLIENT_PLATFORM_VERSION ")";
 
 // Uncomment bellow in case of a problem and rebuild sketch
 //#define INFLUXDB_CLIENT_DEBUG
@@ -206,6 +220,8 @@ bool InfluxDBClient::init() {
         _wifiClient = new WiFiClient;
     }
     _httpClient.setReuse(false);
+
+    _httpClient.setUserAgent(UserAgent);
     return true;
 }
 
diff --git a/src/InfluxDbClient.h b/src/InfluxDbClient.h
@@ -27,6 +27,7 @@
 #ifndef _INFLUXDB_CLIENT_H_
 #define _INFLUXDB_CLIENT_H_
 
+#define INFLUXDB_CLIENT_VERSION "3.1.0"
 
 #include "Arduino.h"
 
@@ -105,8 +106,8 @@ class Point {
     void putField(String name, String value);
 };
 /**
- * InfluxDBClient handles connection and basic operations for InfluxDB 2 server
- * It provides write API with ability to write data in batches, retrying failure writes, smart optimization and simple Flux querying
+ * InfluxDBClient handles connection and basic operations for an InfluxDB server.
+ * It provides write API with ability to write data in batches and retrying failed writes.
  * Automaticaly retries failed writes during next write, if server is overloaded.
  */
 class InfluxDBClient {
@@ -141,7 +142,7 @@ class InfluxDBClient {
     //                 Data are written either when number of points in buffer reaches batchSize or time of  
     // preserveConnection - true if HTTP connection should be kept open. Usable for often writes.
     void setWriteOptions(WritePrecision precision, uint16_t batchSize = 1, uint16_t bufferSize = 5, uint16_t flushInterval = 60, bool preserveConnection = true); 
-    // Sets InfluxDBClient connection parameters
+    // Sets connection parameters for InfluxDB 2
     // serverUrl - url of the InfluxDB 2 server (e.g. https//localhost:9999)
     // org - name of the organization, which bucket belongs to 
     // bucket - name of the bucket to write data into
diff --git a/test/server/server.js b/test/server/server.js
@@ -5,6 +5,7 @@ var os = require('os');
 const app = express();
 const port = 999;
 var pointsdb = []; 
+var lastUserAgent = '';
 
 app.use (function(req, res, next) {
     var data='';
@@ -18,11 +19,23 @@ app.use (function(req, res, next) {
         next();
     });
 });
-
+app.get('/test/user-agent', (req,res) => {
+    res.status(200).send(lastUserAgent);
+})
 app.get('/ready', (req,res) => {
+    lastUserAgent = req.get('User-Agent');
     res.status(200).send("<html><body><h1>OK</h1></body></html>");
 })
 
+app.get('/ping', (req,res) => {
+    lastUserAgent = req.get('User-Agent');
+    if(req.query['verbose'] == 'true') {
+        res.status(200).send("<html><body><h1>OK</h1></body></html>");
+    } else {
+        res.status(204).end();
+    }
+})
+
 app.post('/api/v2/write', (req,res) => {
     if(checkWriteParams(req, res) && handleAuthentication(req, res)) {
         var points = req.body;
@@ -76,6 +89,44 @@ app.post('/api/v2/write', (req,res) => {
     }
 })
 
+app.post('/write', (req,res) => {
+    if(checkWriteParamsV1(req, res) ) {
+        var points = req.body;
+        if(Array.isArray(points) && points.length > 0) {
+            var point = points[0];
+            if(point.tags.hasOwnProperty('direction')) {
+                switch(point.tags.direction) {
+                    case 'delete-all':
+                        pointsdb = [];
+                        res.status(204).end(); 
+                        break; 
+                    case '400':
+                        points = [];
+                        res.status(400).send("bad request");
+                        break;
+                    case '500':
+                        points = [];
+                        res.status(500).send("internal server error");
+                        break;
+                }
+                points.shift();
+            }
+            console.log("write " + points.length + ' points');
+            points.forEach((item, index) => {
+                pointsdb.push(item);
+            })
+            if(res.statusCode < 299) {
+                res.status(204).end();  
+            }
+        } else {
+            res.status(204).end();
+        }
+    }
+    if(res.statusCode != 204) {
+        console.log('Responded with ' + res.statusCode);
+    }
+})
+
 app.post('/api/v2/delete', (req,res) => {
     console.log('Deleteting points');
     pointsdb = [];
@@ -194,6 +245,16 @@ function checkWriteParams(req, res) {
     }
 }
 
+function checkWriteParamsV1(req, res) {
+    var db = req.query['db'];
+    if(db != 'my-db') {
+        res.status(404).send(`{"code":"not found","message":"database \"${db}\" not found"}`);
+        return false;
+    } else {
+        return true;
+    }
+}
+
 function checkQueryParams(req, res) {
     var org = req.query['org'];
     if(org != 'my-org') {
diff --git a/test/test.ino b/test/test.ino
@@ -19,9 +19,10 @@ String chipId = String(ESP.getChipId());
 String deviceName = "ESP8266";
 #endif
 
-#define INFLUXDB_CLIENT_TESTING_URL "http://192.168.88.36:999"
+#define INFLUXDB_CLIENT_TESTING_URL "http://192.168.88.142:999"
 #define INFLUXDB_CLIENT_TESTING_ORG "my-org"
 #define INFLUXDB_CLIENT_TESTING_BUC "my-bucket"
+#define INFLUXDB_CLIENT_TESTING_DB "my-db"
 #define INFLUXDB_CLIENT_TESTING_TOK "1234567890"
 #define INFLUXDB_CLIENT_TESTING_SSID "SSID"
 #define INFLUXDB_CLIENT_TESTING_PASS "password"
@@ -30,6 +31,7 @@ String deviceName = "ESP8266";
 int failures = 0;
 
 #include "TestSupport.h"
+#include <core_version.h>
 
 void setup() {
     Serial.begin(115200);
@@ -46,8 +48,10 @@ void setup() {
 
     //tests
     testPoint();
-    testInit();
     testBasicFunction();
+    testInit();
+    testV1();
+    testUserAgent();
     testFailedWrites();
     testTimestamp();
     testRetryOnFailedConnection();
@@ -206,6 +210,34 @@ void testInit() {
     deleteAll(INFLUXDB_CLIENT_TESTING_URL);
 }
 
+#define STRHELPER(x) #x
+#define STR(x) STRHELPER(x) // stringifier
+
+#if defined(ESP8266)
+# define INFLUXDB_CLIENT_PLATFORM "ESP8266"
+# define INFLUXDB_CLIENT_PLATFORM_VERSION  STR(ARDUINO_ESP8266_GIT_DESC)
+#elif defined(ESP32)
+# define INFLUXDB_CLIENT_PLATFORM "ESP32"
+# define INFLUXDB_CLIENT_PLATFORM_VERSION  STR(ARDUINO_ESP32_GIT_DESC)
+#endif
+
+
+void testUserAgent() {
+    TEST_INIT("testUserAgent");
+
+    InfluxDBClient client(INFLUXDB_CLIENT_TESTING_URL, INFLUXDB_CLIENT_TESTING_ORG, INFLUXDB_CLIENT_TESTING_BUC, INFLUXDB_CLIENT_TESTING_TOK);
+    TEST_ASSERT(client.validateConnection());
+    String url = INFLUXDB_CLIENT_TESTING_URL "/test/user-agent";
+    HTTPClient http;
+    TEST_ASSERT(http.begin(url));
+    TEST_ASSERT(http.GET() == 200);
+    String agent = "influxdb-client-arduino/" INFLUXDB_CLIENT_VERSION " (" INFLUXDB_CLIENT_PLATFORM " " INFLUXDB_CLIENT_PLATFORM_VERSION ")";
+    String data = http.getString();
+    TEST_ASSERTM(data == agent, data);
+    http.end();
+    TEST_END();
+}
+
 void testRetryOnFailedConnection() {
     TEST_INIT("testRetryOnFailedConnection");
 
@@ -704,6 +736,41 @@ void testTimestamp() {
     deleteAll(INFLUXDB_CLIENT_TESTING_URL);
 }
 
+void testV1() {
+
+    TEST_INIT("testV1");
+    InfluxDBClient client(INFLUXDB_CLIENT_TESTING_URL, INFLUXDB_CLIENT_TESTING_DB);
+
+    TEST_ASSERT(client.validateConnection());
+    //test with no batching
+    for (int i = 0; i < 20; i++) {
+        Point *p = createPoint("test1");
+        p->addField("index", i);
+        TEST_ASSERTM(client.writePoint(*p), String("i=") + i);
+        delete p;
+    }
+    String query = "select";
+    String q = queryFlux(client.getServerUrl(),INFLUXDB_CLIENT_TESTING_TOK, INFLUXDB_CLIENT_TESTING_ORG, query);
+    int count;
+    String *lines = getLines(q, count);
+    TEST_ASSERT(count == 21);  
+    deleteAll(INFLUXDB_CLIENT_TESTING_URL);
+    
+    //test with w/ batching 5
+    client.setWriteOptions(WritePrecision::NoTime, 5);
+
+    for (int i = 0; i < 15; i++) {
+        Point *p = createPoint("test1");
+        p->addField("index", i);
+        TEST_ASSERTM(client.writePoint(*p), String("i=") + i);
+        delete p;
+    }
+    q = queryFlux(client.getServerUrl(),INFLUXDB_CLIENT_TESTING_TOK, INFLUXDB_CLIENT_TESTING_ORG, query);
+    lines = getLines(q, count);
+    TEST_ASSERT(count == 16);  
+    TEST_END();
+    deleteAll(INFLUXDB_CLIENT_TESTING_URL);
+}
 Point *createPoint(String measurement) {
     Point *point = new Point(measurement);
     point->addTag("SSID", WiFi.SSID());
