axmol/tests/cpp-tests/Source/NetworkTest/WebSocketTest/WebSocketTest.cpp

598 lines
19 KiB
C++

/****************************************************************************
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).
https://axmolengine.github.io/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#include "WebSocketTest.h"
#include "../NetworkTest.h"
#include "testResource.h"
#include "WebSocketTest.h"
#include "fmt/format.h"
#include "fmt/compile.h"
/* "ws://echo.websocket.org no longer avaiable: https://www.lob.com/blog/websocket-org-is-down-here-is-an-alternative
list of public test servers:
- wss://echo.websocket.events/.ws
- wss://ws.postman-echo.com/raw
- wss://ws.postman-echo.com/socketio handshake path: random, handling
- wss://socketsbay.com/wss/v2/1/demo/
- https://blog.postman.com/introducing-postman-websocket-echo-service/
*/
#define ECHO_SERVER_URL "wss://echo.websocket.events/.ws" //"wss://ws.postman-echo.com/raw"
#define SOCKETIO_SERVICE "wss://ws.postman-echo.com/socketio"
USING_NS_AX;
using namespace ax::network;
// USING_NS_AX_EXT;
WebSocketTests::WebSocketTests()
{
ADD_TEST_CASE(WebSocketTest);
ADD_TEST_CASE(WebSocketCloseTest);
ADD_TEST_CASE(WebSocketDelayTest);
}
WebSocketTest::WebSocketTest()
: _wsiSendText(nullptr)
, _wsiSendBinary(nullptr)
, _wsiError(nullptr)
, _sendTextStatus(nullptr)
, _sendBinaryStatus(nullptr)
, _errorStatus(nullptr)
, _sendTextTimes(0)
, _sendBinaryTimes(0)
{
auto winSize = Director::getInstance()->getWinSize();
const int MARGIN = 40;
const int SPACE = 35;
auto menuRequest = Menu::create();
menuRequest->setPosition(Vec2::ZERO);
addChild(menuRequest);
// Send Text
auto labelSendText = Label::createWithTTF("Send Text", "fonts/arial.ttf", 20);
auto itemSendText = MenuItemLabel::create(labelSendText, AX_CALLBACK_1(WebSocketTest::onMenuSendTextClicked, this));
itemSendText->setPosition(Vec2(winSize.width / 2, winSize.height - MARGIN - SPACE));
menuRequest->addChild(itemSendText);
labelSendText = Label::createWithTTF("Send Multiple Text", "fonts/arial.ttf", 20);
itemSendText =
MenuItemLabel::create(labelSendText, AX_CALLBACK_1(WebSocketTest::onMenuSendMultipleTextClicked, this));
itemSendText->setPosition(Vec2(winSize.width / 2, winSize.height - MARGIN - 2 * SPACE));
menuRequest->addChild(itemSendText);
// Send Binary
auto labelSendBinary = Label::createWithTTF("Send Binary", "fonts/arial.ttf", 20);
auto itemSendBinary =
MenuItemLabel::create(labelSendBinary, AX_CALLBACK_1(WebSocketTest::onMenuSendBinaryClicked, this));
itemSendBinary->setPosition(Vec2(winSize.width / 2, winSize.height - MARGIN - 3 * SPACE));
menuRequest->addChild(itemSendBinary);
// Send Text Status Label
_sendTextStatus = Label::createWithTTF("Send Text WS is waiting...", "fonts/arial.ttf", 16, Size(160, 100),
TextHAlignment::CENTER, TextVAlignment::TOP);
_sendTextStatus->setAnchorPoint(Vec2(0, 0));
_sendTextStatus->setPosition(Vec2(VisibleRect::left().x, VisibleRect::rightBottom().y + 25));
this->addChild(_sendTextStatus);
// Send Binary Status Label
_sendBinaryStatus = Label::createWithTTF("Send Binary WS is waiting...", "fonts/arial.ttf", 16, Size(160, 100),
TextHAlignment::CENTER, TextVAlignment::TOP);
_sendBinaryStatus->setAnchorPoint(Vec2(0, 0));
_sendBinaryStatus->setPosition(Vec2(VisibleRect::left().x + 160, VisibleRect::rightBottom().y + 25));
this->addChild(_sendBinaryStatus);
// Error Label
_errorStatus = Label::createWithTTF("Error WS is waiting...", "fonts/arial.ttf", 16, Size(160, 100),
TextHAlignment::CENTER, TextVAlignment::TOP);
_errorStatus->setAnchorPoint(Vec2(0, 0));
_errorStatus->setPosition(Vec2(VisibleRect::left().x + 320, VisibleRect::rightBottom().y + 25));
this->addChild(_errorStatus);
auto startTestLabel = Label::createWithTTF("Start Test WebSocket", "fonts/arial.ttf", 16);
auto startTestItem = MenuItemLabel::create(startTestLabel, AX_CALLBACK_1(WebSocketTest::startTestCallback, this));
startTestItem->setPosition(Vec2(VisibleRect::center().x - 150, VisibleRect::bottom().y + 150));
_startTestMenu = Menu::create(startTestItem, nullptr);
_startTestMenu->setPosition(Vec2::ZERO);
this->addChild(_startTestMenu, 1);
}
WebSocketTest::~WebSocketTest() {}
void WebSocketTest::onExit()
{
if (_wsiSendText)
{
_wsiSendText->closeAsync();
AX_SAFE_DELETE(_wsiSendText);
}
if (_wsiSendBinary)
{
_wsiSendBinary->closeAsync();
AX_SAFE_DELETE(_wsiSendBinary);
}
if (_wsiError)
{
_wsiError->closeAsync();
AX_SAFE_DELETE(_wsiError);
}
Node::onExit();
}
void WebSocketTest::startTestCallback(Ref* sender)
{
removeChild(_startTestMenu);
_startTestMenu = nullptr;
_wsiSendText = new network::WebSocket();
_wsiSendBinary = new network::WebSocket();
_wsiError = new network::WebSocket();
if (!_wsiSendText->open(this, ECHO_SERVER_URL))
{
AX_SAFE_DELETE(_wsiSendText);
}
else
{
retain(); // Retain self to avoid WebSocketTest instance be deleted immediately, it will be released in
// WebSocketTest::onClose.
}
if (!_wsiSendBinary->open(this, ECHO_SERVER_URL))
{
AX_SAFE_DELETE(_wsiSendBinary);
}
else
{
retain(); // Retain self to avoid WebSocketTest instance be deleted immediately, it will be released in
// WebSocketTest::onClose.
}
if (!_wsiError->open(this, "ws://invalid.urlxxxxxxxx.com"))
{
AX_SAFE_DELETE(_wsiError);
}
else
{
retain(); // Retain self to avoid WebSocketTest instance be deleted immediately, it will be released in
// WebSocketTest::onClose.
}
}
// Delegate methods
void WebSocketTest::onOpen(network::WebSocket* ws)
{
char status[256] = {0};
sprintf(status, "Opened, url: %s, protocol: %s", ws->getUrl().data(), ws->getProtocol().data());
ax::print("Websocket (%p) was opened, url: %s, protocol: %s", ws, ws->getUrl().data(), ws->getProtocol().data());
if (ws == _wsiSendText)
{
_sendTextStatus->setString(status);
}
else if (ws == _wsiSendBinary)
{
_sendBinaryStatus->setString(status);
}
else if (ws == _wsiError)
{
AXASSERT(0, "error test will never go here.");
}
}
void WebSocketTest::onMessage(network::WebSocket* ws, const network::WebSocket::Data& data)
{
if (!data.isBinary)
{
_sendTextTimes++;
std::string textStr = fmt::format(FMT_COMPILE("#{} response text msg: {}"), _sendTextTimes,
std::string_view{data.bytes, static_cast<size_t>(data.len)});
ax::print("%s", textStr.c_str());
_sendTextStatus->setString(textStr.c_str());
}
else
{
_sendBinaryTimes++;
char times[100] = {0};
sprintf(times, "%d", _sendBinaryTimes);
std::string binaryStr = "response bin msg: ";
for (int i = 0; i < data.len; ++i)
{
if (data.bytes[i] != '\0')
{
binaryStr += data.bytes[i];
}
else
{
binaryStr += "\'\\0\'";
}
}
binaryStr += std::string(", ") + times;
ax::print("%s", binaryStr.c_str());
_sendBinaryStatus->setString(binaryStr.c_str());
}
}
void WebSocketTest::onClose(network::WebSocket* ws)
{
ax::print("onClose: websocket instance (%p) closed.", ws);
if (ws == _wsiSendText)
{
// _wsiSendText = nullptr;
_sendTextStatus->setString("Send Text WS was closed");
}
else if (ws == _wsiSendBinary)
{
// _wsiSendBinary = nullptr;
_sendBinaryStatus->setString("Send Binary WS was closed");
}
else if (ws == _wsiError)
{
// _wsiError = nullptr;
_errorStatus->setString("Test invalid URL WS was closed");
}
// Delete websocket instance.
// AX_SAFE_DELETE(ws);
ax::print("WebSocketTest ref: %u", _referenceCount);
release();
}
void WebSocketTest::onError(network::WebSocket* ws, const network::WebSocket::ErrorCode& error)
{
ax::print("Error was fired, error code: %d", static_cast<int>(error));
char buf[100] = {0};
sprintf(buf, "An error was fired, code: %d", static_cast<int>(error));
if (ws == _wsiSendText)
{
_sendTextStatus->setString(buf);
}
else if (ws == _wsiSendBinary)
{
_sendBinaryStatus->setString(buf);
}
else if (ws == _wsiError)
{
_errorStatus->setString(buf);
}
}
// Menu Callbacks
void WebSocketTest::onMenuSendTextClicked(ax::Ref* sender)
{
if (!_wsiSendText)
{
return;
}
if (_wsiSendText->getReadyState() == network::WebSocket::State::OPEN)
{
_sendTextStatus->setString("Send Text WS is waiting...");
_wsiSendText->send("Hello WebSocket, I'm a text message from axmol-" AX_VERSION_STR_FULL " game engine.");
}
else
{
std::string warningStr = "send text websocket instance wasn't ready...";
ax::print("%s", warningStr.c_str());
_sendTextStatus->setString(warningStr.c_str());
}
}
void WebSocketTest::onMenuSendMultipleTextClicked(ax::Ref* sender)
{
if (!_wsiSendText)
{
return;
}
if (_wsiSendText->getReadyState() == network::WebSocket::State::OPEN)
{
_sendTextStatus->setString("Send Multiple Text WS is waiting...");
for (int index = 0; index < 15; ++index)
{
_wsiSendText->send(StringUtils::format("Hello WebSocket, text message index:%d", index));
}
}
else
{
std::string warningStr = "send text websocket instance wasn't ready...";
ax::print("%s", warningStr.c_str());
_sendTextStatus->setString(warningStr.c_str());
}
}
void WebSocketTest::onMenuSendBinaryClicked(ax::Ref* sender)
{
if (!_wsiSendBinary)
{
return;
}
if (_wsiSendBinary->getReadyState() == network::WebSocket::State::OPEN)
{
_sendBinaryStatus->setString("Send Binary WS is waiting...");
char buf[] = "Hello WebSocket,\0 I'm\0 a\0 binary\0 message\0.";
_wsiSendBinary->send(buf, sizeof(buf));
}
else
{
std::string warningStr = "send binary websocket instance wasn't ready...";
ax::print("%s", warningStr.c_str());
_sendBinaryStatus->setString(warningStr.c_str());
}
}
WebSocketCloseTest::WebSocketCloseTest() : _wsiTest(nullptr)
{
auto winSize = Director::getInstance()->getWinSize();
_wsiTest = new network::WebSocket();
if (!_wsiTest->open(this, ECHO_SERVER_URL))
{
delete _wsiTest;
_wsiTest = nullptr;
}
auto closeItem =
MenuItemImage::create(s_pathClose, s_pathClose, [](Ref* sender) { Director::getInstance()->end(); });
closeItem->setPosition(VisibleRect::right().x / 2, VisibleRect::top().y * 2 / 3);
auto menu = Menu::create(closeItem, nullptr);
menu->setPosition(Vec2::ZERO);
addChild(menu, 1);
auto notifyLabel = Label::createWithTTF(
"See log window, when enter there's should have\n'Websocket opened' log,\nwhen close there's should "
"have'websocket closed' log",
"fonts/arial.ttf", 20);
notifyLabel->setPosition(VisibleRect::right().x / 2, VisibleRect::top().y / 3);
notifyLabel->setAlignment(TextHAlignment::CENTER);
addChild(notifyLabel, 1);
}
WebSocketCloseTest::~WebSocketCloseTest()
{
if (_wsiTest != nullptr)
{
_wsiTest->close();
delete _wsiTest;
_wsiTest = nullptr;
}
}
// Delegate methods
void WebSocketCloseTest::onOpen(network::WebSocket* ws)
{
ax::print("Websocket (%p) opened", ws);
}
void WebSocketCloseTest::onMessage(network::WebSocket* ws, const network::WebSocket::Data& data)
{
ax::print("Websocket get message from %p", ws);
}
void WebSocketCloseTest::onClose(network::WebSocket* ws)
{
ax::print("websocket (%p) closed.", ws);
// if (ws == _wsiTest) {
// _wsiTest = nullptr;
// }
// AX_SAFE_DELETE(ws);
}
void WebSocketCloseTest::onError(network::WebSocket* ws, const network::WebSocket::ErrorCode& error)
{
ax::print("Error was fired, error code: %d", static_cast<int>(error));
}
#define SEND_TEXT_TIMES 100
WebSocketDelayTest::WebSocketDelayTest()
: _wsiSendText(nullptr), _sendTextStatus(nullptr), _progressStatus(nullptr), _sendTextTimes(0)
{
auto winSize = Director::getInstance()->getWinSize();
const int MARGIN = 40;
const int SPACE = 35;
auto menuRequest = Menu::create();
menuRequest->setPosition(Vec2::ZERO);
addChild(menuRequest);
// Send Text
char cmdLabel[60] = {0};
snprintf(cmdLabel, 60, "Send %d Text", SEND_TEXT_TIMES);
auto labelSendText = Label::createWithTTF(cmdLabel, "fonts/arial.ttf", 20);
auto itemSendText =
MenuItemLabel::create(labelSendText, AX_CALLBACK_1(WebSocketDelayTest::onMenuSendTextClicked, this));
itemSendText->setPosition(Vec2(winSize.width / 2, winSize.height - MARGIN - SPACE));
menuRequest->addChild(itemSendText);
// Send Text Status Label
_sendTextStatus = Label::createWithTTF("Waiting connection...", "fonts/arial.ttf", 16, Size(160, 100),
TextHAlignment::CENTER, TextVAlignment::TOP);
_sendTextStatus->setAnchorPoint(Vec2(0, 0));
_sendTextStatus->setPosition(Vec2(VisibleRect::left().x, VisibleRect::rightBottom().y + 25));
this->addChild(_sendTextStatus);
// Error Label
_progressStatus =
Label::createWithTTF(".", "fonts/arial.ttf", 16, Size(160, 100), TextHAlignment::CENTER, TextVAlignment::TOP);
_progressStatus->setAnchorPoint(Vec2(0, 0));
_progressStatus->setPosition(Vec2(VisibleRect::left().x + 320, VisibleRect::rightBottom().y + 25));
this->addChild(_progressStatus);
auto startTestLabel = Label::createWithTTF("DO Connect!", "fonts/arial.ttf", 16);
auto startTestItem =
MenuItemLabel::create(startTestLabel, AX_CALLBACK_1(WebSocketDelayTest::startTestCallback, this));
startTestItem->setPosition(Vec2(VisibleRect::center().x - 150, VisibleRect::bottom().y + 150));
_startTestMenu = Menu::create(startTestItem, nullptr);
_startTestMenu->setPosition(Vec2::ZERO);
this->addChild(_startTestMenu, 1);
}
WebSocketDelayTest::~WebSocketDelayTest() {}
void WebSocketDelayTest::onExit()
{
if (_wsiSendText)
{
_wsiSendText->close();
delete _wsiSendText;
_wsiSendText = nullptr;
}
Node::onExit();
}
void WebSocketDelayTest::startTestCallback(Ref* sender)
{
removeChild(_startTestMenu);
_startTestMenu = nullptr;
_wsiSendText = new network::WebSocket();
if (!_wsiSendText->open(this, ECHO_SERVER_URL))
{
AX_SAFE_DELETE(_wsiSendText);
}
else
{
retain(); // Retain self to avoid WebSocketDelayTest instance be deleted immediately, it will be released in
// WebSocketDelayTest::onClose.
}
}
void WebSocketDelayTest::doSendText()
{
_sendTextTimes += 1;
if (_sendTextTimes > SEND_TEXT_TIMES)
{
_sendTextStatus->setString("Test Done!");
return;
}
char statueBuffer[80] = {0};
snprintf(statueBuffer, 80, "Sending #%d/%d text", _sendTextTimes, SEND_TEXT_TIMES);
_sendTextStatus->setString(statueBuffer);
_sendTimeMircoSec = getNowMircroSeconds();
_wsiSendText->send("Hello WebSocket, I'm a text message.");
}
void WebSocketDelayTest::doReceiveText()
{
_receiveTimeMircoSec = getNowMircroSeconds();
if (_sendTimeMircoSec > 0)
_totalDelayMircoSec += (_receiveTimeMircoSec - _sendTimeMircoSec);
doSendText(); // send next
}
// Delegate methods
void WebSocketDelayTest::onOpen(network::WebSocket* ws)
{
char status[256] = {0};
sprintf(status, "Opened, url: %s, protocol: %s", ws->getUrl().data(), ws->getProtocol().data());
ax::print("Websocket (%p) was opened, url: %s, protocol: %s", ws, ws->getUrl().data(), ws->getProtocol().data());
if (ws == _wsiSendText)
{
_sendTextStatus->setString(status);
}
}
void WebSocketDelayTest::onMessage(network::WebSocket* ws, const network::WebSocket::Data& data)
{
if (!data.isBinary)
{
_receiveTextTimes++;
char times[100] = {0};
sprintf(times, "%d", _receiveTextTimes);
std::string textStr = std::string("response text msg: ") + data.bytes + ", " + times;
ax::print("%s", textStr.c_str());
doReceiveText();
memset(times, 0, 100);
snprintf(times, 100, "total delay %f seconds", (float)(_totalDelayMircoSec / 1000000.0));
_progressStatus->setString(times);
}
}
void WebSocketDelayTest::onClose(network::WebSocket* ws)
{
ax::print("onClose: websocket instance (%p) closed.", ws);
if (ws == _wsiSendText)
{
// delete _wsiSendText;
// _wsiSendText = nullptr;
_sendTextStatus->setString("Send Text WS was closed");
}
ax::print("WebSocketDelayTest ref: %u", _referenceCount);
release();
}
void WebSocketDelayTest::onError(network::WebSocket* ws, const network::WebSocket::ErrorCode& error)
{
ax::print("Error was fired, error code: %d", static_cast<int>(error));
char buf[100] = {0};
sprintf(buf, "An error was fired, code: %d", static_cast<int>(error));
if (ws == _wsiSendText)
{
_sendTextStatus->setString(buf);
}
_sendTimeMircoSec = 0;
}
// Menu Callbacks
void WebSocketDelayTest::onMenuSendTextClicked(ax::Ref* sender)
{
if (!_wsiSendText)
{
return;
}
if (_wsiSendText->getReadyState() == network::WebSocket::State::OPEN)
{
_sendTextTimes = 0;
_receiveTextTimes = 0;
doSendText();
}
else
{
std::string warningStr = "send text websocket instance wasn't ready...";
ax::print("%s", warningStr.c_str());
_sendTextStatus->setString(warningStr.c_str());
}
}