refs #4565 fixed WebSocket PING/PONG handling

refs #4564 added WebSocketClientDataProvider, FileDataProvider, FtpDataProvider, and FtpPollerDataProvider functionality, fixed tests

Author: davidnich

bin/qdp

@@ -183,13 +183,13 @@ class QdpCmd {
     }
 
     static listEvents(AbstractDataProvider provider) {
-        hash<string, AbstractDataProviderType> events = provider.getEventTypes();
+        hash<string, hash<DataProviderMessageInfo>> events = provider.getEventTypes();
         map printf(" - %s\n", $1), keys events;
     }
 
     static event(AbstractDataProvider provider) {
         string event = QdpCmd::getString("event", True);
-        QdpCmd::showType(provider.getEventType(event));
+        QdpCmd::showType(event, provider.getEventInfo(event));
     }
 
     static errors(AbstractDataProvider provider) {
@@ -343,13 +343,13 @@ class QdpCmd {
     }
 
     static listMessages(AbstractDataProvider provider) {
-        hash<string, AbstractDataProviderType> messages = provider.getMessageTypes();
+        hash<string, hash<DataProviderMessageInfo>> messages = provider.getMessageTypes();
         map printf(" - %s\n", $1), keys messages;
     }
 
     static message(AbstractDataProvider provider) {
         string message = QdpCmd::getString("message", True);
-        QdpCmd::showType(provider.getMessageType(message));
+        QdpCmd::showType(message, provider.getMessageInfo(message));
     }
 
     static listen(AbstractDataProvider provider) {
@@ -523,12 +523,17 @@ class QdpCmd {
         # this method intentionally left empty
     }
 
+    static showType(string msg, hash<DataProviderMessageInfo> info) {
+        printf("%s: %s\n", msg, info.desc);
+        QdpCmd::showType(info.type);
+    }
+
     static showType(AbstractDataProviderType type, *string offset) {
         *hash<string, AbstractDataField> fields = type.getFields();
         if (fields) {
             QdpCmd::showRecord(fields, offset);
         } else {
-            printf("%s%s%s\n", offset, type.getName());
+            printf("%s%s%s (%s)\n", offset, type.getName());
         }
     }
 
@@ -800,7 +805,7 @@ class ConsoleAppender inherits LoggerAppenderWithLayout {
 class InputHelper {
     public {
         # message map
-        hash<string, AbstractDataProviderType> mmap;
+        hash<string, hash<DataProviderMessageInfo>> mmap;
 
         const Prompt = "> ";
         const HistoryFile = ".qdp";

doxygen/lang/900_release_notes.dox.tmpl

@@ -13,14 +13,19 @@
         (<a href="https://github.com/qorelanguage/qore/issues/4557">issue 4557</a>)
     - <a href="../../modules/FileDataProvider/html/index.html">FileDataProvider</a> module
       - new module
+        (<a href="https://github.com/qorelanguage/qore/issues/4564">issue 4564</a>)
     - <a href="../../modules/FtpDataProvider/html/index.html">FtpDataProvider</a> module
       - new module
+        (<a href="https://github.com/qorelanguage/qore/issues/4564">issue 4564</a>)
     - <a href="../../modules/FtpPoller/html/index.html">FtpPoller</a> module
       - added support for the event-based DataProvider API
         (<a href="https://github.com/qorelanguage/qore/issues/4557">issue 4557</a>)
     - <a href="../../modules/FilePoller/html/index.html">FilePoller</a> module
       - added support for the event-based DataProvider API
         (<a href="https://github.com/qorelanguage/qore/issues/4557">issue 4557</a>)
+    - <a href="../../modules/WebSocketClient/html/index.html">WebSocketClient</a> module
+      - added support for the event-based DataProvider API
+        (<a href="https://github.com/qorelanguage/qore/issues/4557">issue 4557</a>)
 
     @subsection qore_1_10_0_bug_fixes Bug Fixes in Qore
     - <a href="../../modules/FsUtil/html/index.html">FsUtil</a> module

examples/test/qlib/FileDataProvider/FileDataProvider.qtest

@@ -26,7 +26,8 @@ public class FileDataProviderTest inherits QUnit::Test {
 
     fileDataProviderTest() {
         # create test file
-        TmpFile tmp("FileDataProviderTest-");
+        TmpDir tmpdir("FileDataProviderTest-");
+        TmpFile tmp("FileDataProviderTest-", NOTHING, tmpdir.path);
         string str = get_random_string();
         tmp.file.write(str);
 
@@ -40,16 +41,17 @@ public class FileDataProviderTest inherits QUnit::Test {
         assertEq("REGULAR", h.type);
 
         prov = fdp.getChildProviderEx("copy");
-        string targ = join_paths(tmp_location(), get_random_string());
+        string targ = join_paths(tmpdir.path, get_random_string());
         h = prov.doRequest({
             "source": tmp.path,
             "target": targ,
         });
         assertEq(targ, h.target);
+        assertTrue(is_file(tmp.path));
         assertTrue(is_file(targ));
 
         prov = fdp.getChildProviderEx("move");
-        string new_targ = join_paths(tmp_location(), get_random_string());
+        string new_targ = join_paths(tmpdir.path, get_random_string());
         assertNeq(new_targ, targ);
         h = prov.doRequest({
             "source": targ,
@@ -66,6 +68,9 @@ public class FileDataProviderTest inherits QUnit::Test {
         assertEq(new_targ, h.path);
         assertFalse(is_file(new_targ));
 
+	# delete original file
+	delete tmp;
+
         prov = fdp.getChildProviderEx("create");
         h = prov.doRequest({
             "path": new_targ,
@@ -84,8 +89,22 @@ public class FileDataProviderTest inherits QUnit::Test {
 
         prov = fdp.getChildProviderEx("list");
         h = prov.doRequest({
-            "path": dirname(tmp.path),
+            "path": tmpdir.path,
         })[0];
         assertEq(basename(new_targ), h.name);
+
+        string dir = get_random_string();
+        prov = fdp.getChildProviderEx("mkdir");
+        h = prov.doRequest({
+            "path": dir,
+        });
+        assertEq(dir, h.path);
+
+        prov = fdp.getChildProviderEx("stat");
+        h = prov.doRequest({
+            "path": dir,
+        });
+        assertEq(dir, h.name);
+        assertEq("DIRECTORY", h.type);
     }
 }

examples/test/qlib/FtpDataProvider/FtpDataProvider.qtest

@@ -68,7 +68,7 @@ public class FtpDataProviderTest inherits QUnit::Test {
             "size": 15,
         }, h - "mtime");
 
-        /* test server doesn't support RNFR yet
+        /* test server doesn't support RNFR / RNTO yet
         string newpath = "/test1.txt";
         prov = root.getChildProviderEx("move");
         h = prov.doRequest({
@@ -89,6 +89,19 @@ public class FtpDataProviderTest inherits QUnit::Test {
         assertThrows("FTP-STAT-ERROR", \prov.doRequest(), {
             "path": path,
         });
+
+        string dir = get_random_string();
+        prov = root.getChildProviderEx("mkdir");
+        h = prov.doRequest({
+            "path": dir,
+        });
+        assertEq("/" + dir, h.path);
+
+        prov = root.getChildProviderEx("stat");
+        h = prov.doRequest({
+            "path": dir,
+        });
+        assertEq("DIRECTORY", h.type);
     }
 
     private softint getPort() {

examples/test/qlib/FtpPoller/FtpPoller.qtest

@@ -100,10 +100,11 @@ class FtpPollerTest inherits QUnit::Test {
 
         # printf("files: %y\n", file_paths);
 
-        MyFtpPoller poller(ftp_client, {"path": dir});
+        MyFtpPoller poller(ftp_client, {"path": tmp_dir.path});
         assertTrue(poller.runOnce());
 
         foreach hash<FtpPollerFileEventInfo> file in (poller.files) {
+            on_error printf("file: %y file_paths: %y\n", file - "data", keys file_paths);
             assertTrue(file.name != NOTHING);
             assertTrue(file_paths.hasKey(file.filepath));
         }

examples/test/qlib/WebSocketClient/WebSocketClient.qtest

@@ -20,6 +20,9 @@
 
 class MyWsConnection inherits WebSocketConnection {
     constructor(WebSocketHandler handler) : WebSocketConnection(handler) {
+    }
+
+    sendData() {
         map send($1), WebSocketClientTest::Data;
     }
 
@@ -34,8 +37,12 @@ class MyWsHandler inherits WebSocketHandler {
         bool debug = False;
     }
 
-    WebSocketConnection getConnectionImpl(hash cx, hash hdr, string cid) {
-        return new MyWsConnection(self);
+    WebSocketConnection getConnectionImpl(hash<auto> cx, hash<auto> hdr, string cid) {
+        MyWsConnection conn(self);
+        if (hdr."send-data") {
+            conn.sendData();
+        }
+        return conn;
     }
 
     logError(string fmt) {
@@ -64,6 +71,8 @@ class WebSocketClientTest inherits QUnit::Test {
         int port;
         int responseSize;
 
+        Logger logger;
+
         const Data = (
             "test1",
             <beeffeed>,
@@ -72,10 +81,11 @@ class WebSocketClientTest inherits QUnit::Test {
     }
 
     constructor() : Test("WebSocketClientTest", "1.0") {
+        addTestCase("data provider test", \dataProviderTest());
         addTestCase("WebSocketClient tests", \webSocketClientTests());
         addTestCase("connection tests", \connectionTests());
 
-        Logger logger("test", LoggerLevel::getLevelInfo());
+        logger = new Logger("test", LoggerLevel::getLevelInfo());
         if (m_options.verbose > 2) {
             logger.addAppender(new TestAppender());
         }
@@ -93,6 +103,21 @@ class WebSocketClientTest inherits QUnit::Test {
         mServer.stop();
     }
 
+    dataProviderTest() {
+        MyObserver observer();
+        WebSocketClientDelayedDataProvider prov({
+            "url": "ws://localhost:" + port,
+        });
+        prov.setLogger(logger);
+        prov.registerObserver(observer);
+        prov.observersReady();
+
+        prov.sendMessage(MESSAGE_WS_PING, "hb");
+
+        observer.wait();
+        assertTrue(True);
+    }
+
     webSocketClientTests() {
         list<auto> l = ();
         Counter c(1);
@@ -118,15 +143,15 @@ class WebSocketClientTest inherits QUnit::Test {
             "debuglog": log("DEBUG"),
         };
         WebSocketClient wsc(cb, opts);
-        wsc.connect();
+        wsc.connect({"hdr": {"Send-Data": 1}});
         c.waitForZero();
         assertEq(Data, l);
         c.inc();
         l = ();
         responseSize = 1;
         # issue #2566: send a unidirectional PONG to make sure that the WebSocketHandler can handle it
         # https://tools.ietf.org/html/rfc6455#section-5.5.3: unsolicited PONG messages must be ignored
-        wsc.pong();
+        wsc.pong("heartbeat");
         wsc.send("REQUEST");
         c.waitForZero();
         assertEq(list("RESPONSE:REQUEST"), l);
@@ -164,3 +189,43 @@ class TestAppender inherits LoggerAppenderWithLayout {
         }
     }
 }
+
+class MyObserver inherits Observer {
+    public {
+        list<hash<auto>> l();
+    }
+
+    private {
+        Mutex m();
+        Condition cond();
+        int waiting;
+    }
+
+    update(string event_id, hash<auto> data_) {
+        m.lock();
+        on_exit m.unlock();
+
+        l += {
+            "id": event_id,
+            "data": data_,
+        };
+
+        if (waiting) {
+            cond.broadcast();
+        }
+    }
+
+    wait() {
+        date start = now_us();
+
+        m.lock();
+        on_exit m.unlock();
+
+        while (!l) {
+            cond.wait(m, 1s);
+            if ((now_us() - start) > 5s) {
+                throw "ERROR", "no data received in timeout";
+            }
+        }
+    }
+}