Update the Web service to reduce compilation time #67

LeZhang2016 · 2017-06-22T09:04:39Z

The previous version involved http server and backend business logic (such as wpan and mDNS) into the same module, which is not suitable for code maintenance and migration, in addition, it cost lots of resource during compilation.

This PR implements the following features:

Divide the web service into HTTP server, WPAN service and mDNS service.
Support configurable HTTP server port (default 80).
Show services status on Web page.
Support google-chrome display the Web page normally.
Fix the issue web service, alternate port number? #26, Display status of services on web ui #48, mDNS averts do not start when network is restored #49, connection is NULL #55

bukepo · 2017-06-22T09:22:11Z

src/web/web-service/mdns_service.cpp

+    Json::Value        root;
+    Json::FastWriter   jsonWriter;
+    Json::Reader       reader;
+    static std::string response;


Is there any special consideration to make response static?

if we don't add static, there will be a warning message like warning: reference to local variable ‘response’ returned during compilation.

Yes, this is caused by returning reference. I think the prototype should be changed to return value instead of reference.

Setting as static variable is not thread safe.

Thanks a lot for your comments, I have updated this part.

bukepo · 2017-06-22T09:24:07Z

src/web/web-service/mdns_service.cpp

+            });
+
+    mdnsPublisherThread.detach();
+    (void) aNetworkName;


aNetworkName is actually used, same for aExtPanid.

bukepo · 2017-06-22T09:24:20Z

src/web/web-service/mdns_service.cpp

+    ot::Mdns::Publisher::GetInstance().SetNetworkNameTxt(networkNameTxt.c_str());
+    ot::Mdns::Publisher::GetInstance().SetExtPanIdTxt(extPanIdTxt.c_str());
+    ot::Mdns::Publisher::GetInstance().UpdateService();
+    (void) aNetworkName;


bukepo · 2017-06-22T09:24:25Z

src/web/web-service/mdns_service.cpp

+    ot::Mdns::Publisher::GetInstance().SetExtPanIdTxt(extPanIdTxt.c_str());
+    ot::Mdns::Publisher::GetInstance().UpdateService();
+    (void) aNetworkName;
+    (void) aExtPanId;


bukepo · 2017-06-22T09:26:30Z

src/web/web-service/web_server.cpp

+
+WebServer::~WebServer(void)
+{
+    delete &mServer;


I think it should be

delete mServer;

bukepo · 2017-06-22T09:29:43Z

src/web/web-service/web_server.cpp

+void DefaultResourceSend(const HttpServer &aServer, const std::shared_ptr<HttpServer::Response> &aResponse,
+                         const std::shared_ptr<std::ifstream> &aIfStream)
+{
+    static std::vector<char> buffer(131072); // Safe when server is running on one thread


magic number, and can this be smaller?

bukepo · 2017-06-22T09:33:43Z

src/web/web-service/frontend/res/js/app.js

@@ -241,13 +255,18 @@
                    data: data,
                });

+                data = {


var data at function begining?

done thanks.

bukepo · 2017-06-22T10:27:49Z

src/web/web-service/frontend/res/js/app.js

@@ -219,12 +233,12 @@
                .targetEvent(ev)
                .ok('Okay')
                .cancel('Cancel');
-
+            


nit: line only space.

bukepo · 2017-06-22T10:29:13Z

src/web/web-service/wpan_service.cpp

+        otbrLog(OTBR_LOG_ERR, "wpan service error: %d", ret);
+        root["result"] = "failed";
+    }
+    root["result"] = "successful";


Is it better to define "successful" and "fail" as macro or const string?

bukepo · 2017-06-22T10:32:28Z

src/web/web-service/wpan_service.cpp

+        otbrLog(OTBR_LOG_ERR, "wpan service error: %d", ret);
+        root["result"] = "failed";
+    }
+    root["result"] = "successful";


It seems line 198 has no effect with this line.

bukepo · 2017-06-22T10:32:48Z

src/web/web-service/wpan_service.cpp

+        otbrLog(OTBR_LOG_ERR, "wpan service error: %d", ret);
+        root["result"] = "failed";
+    }
+    root["result"] = "successful";


same as above.

bukepo · 2017-06-22T10:35:20Z

src/web/web-service/wpan_service.hpp

+    ot::Dbus::WpanNetworkInfo mNetworks[DBUS_MAXIMUM_NAME_LENGTH];
+    int                       mNetworksCount;
+    char                      mIfName[IFNAMSIZ];
+    std::string               mNetworkName, mExtPanId;


Although not listed in the code style, it seems OpenThread defines member variables one by one.

bukepo · 2017-06-22T10:35:59Z

src/web/wpan-controller/dbus_base.cpp

@@ -68,7 +68,7 @@ DBusMessage *DBusBase::GetMessage(void)
 {
    int ret = kWpantundStatus_Ok;

-    VerifyOrExit(mDestination != NULL, ret = kWpantundStatus_InvalidArgument);
+    VerifyOrExit(strlen(mDestination) != 0, ret = kWpantundStatus_InvalidArgument);


strnlen() preferred.

bukepo · 2017-06-22T17:59:46Z

src/web/web-service/mdns_service.cpp

+    }
+    root["result"] = mResponseSuccess;
+exit:
+    (void)aMdnsRequest;


bukepo · 2017-06-23T02:09:02Z

src/web/mdns-publisher/mdns_publisher.hpp

@@ -127,6 +147,15 @@ class Publisher
        return publisherInstance;
    }

+    /**
+     * This method returns the boolean result of mDNS publisher.


Does this line exactly describe the functionality?

bukepo · 2017-06-23T02:09:51Z

src/web/web-service/mdns_service.cpp

+    {
+        ret = StartMdnsService(networkName, extPanId);
+    }
+    root["result"] = mResponseSuccess;


Does this line take effect?

bukepo · 2017-06-23T02:11:11Z

src/web/web-service/mdns_service.cpp

+
+int MdnsService::UpdateMdnsService(const std::string &aNetworkName, const std::string &aExtPanId)
+{
+    int ret = kMndsServiceStatus_OK;


It seems this method will always success?

Done, Thanks.

bukepo · 2017-06-23T02:11:49Z

src/web/web-service/wpan_service.cpp

+                 ret = ot::Dbus::kWpantundStatus_SetGatewayFailed);
+
+    ot::Utils::Long2Hex(mNetworks[index].mExtPanId, extPanId);
+    root["result"] = mResponseSuccess;


does this line take effect?

bukepo · 2017-06-23T02:12:31Z

src/web/web-service/wpan_service.cpp

+    wpanController.SetInterfaceName(mIfName);
+    VerifyOrExit(wpanController.AddGateway(prefix.c_str(), defaultRoute) == ot::Dbus::kWpantundStatus_Ok,
+                 ret = ot::Dbus::kWpantundStatus_SetGatewayFailed);
+    root["result"] = mResponseSuccess;


Does this take effect?

bukepo · 2017-06-23T02:12:40Z

src/web/web-service/wpan_service.cpp

+    wpanController.SetInterfaceName(mIfName);
+    VerifyOrExit(wpanController.RemoveGateway(prefix.c_str()) == ot::Dbus::kWpantundStatus_Ok,
+                 ret = ot::Dbus::kWpantundStatus_SetGatewayFailed);
+    root["result"] = mResponseSuccess;


same as above.

bukepo · 2017-06-23T02:14:31Z

src/web/web-service/wpan_service.cpp

+    Json::FastWriter         jsonWriter;
+    ot::Dbus::WPANController wpanController;
+    std::string              response, networkName, extPanId;
+    int                      ret = ot::Dbus::kWpantundStatus_Ok;


it seems this variable will not be changed at all.

bukepo · 2017-06-23T02:16:16Z

src/web/web-service/wpan_service.cpp

+        status = kWpanStatus_Down;
+        ExitNow();
+    }
+    if (wpantundState == "associated")


Is it better to list all possible states and define them as cons string or macros?

bukepo · 2017-06-23T02:17:57Z

src/web/web-service/wpan_service.hpp

+ * WPAN parameter constants
+ *
+ */
+#define OT_BORDER_ROUTER_PORT 49191


This port is defined twice, is it possible to define it only once?

bukepo · 2017-06-23T05:42:11Z

src/web/web-service/wpan_service.hpp

+     * This method gets status of wpan service.
+     *
+     * @param[in]  aNetworkName  The pointer to the network name.
+     * @param[in]  aIfName  The pointer to the extended PAN ID.


bukepo · 2017-06-23T05:42:55Z

src/web/web-service/wpan_service.hpp

+     * @param[in]  aIfName  The pointer to the extended PAN ID.
+     *
+     * @retval kWpanStatus_OK        Started the wpan service.
+     * @retval kWpanStatus_OffLine   Not started the wpan service.


kWpanStatus_Offline Offline is a single word.

bukepo · 2017-06-23T05:46:41Z

src/web/web-service/wpan_service.hpp

+#define OT_EXTENDED_PANID_LENGTH 8
+#define OT_HARDWARE_ADDRESS_LENGTH 8
+#define OT_NETWORK_NAME_LENGTH 16
+#define OT_PANID_LENGTH 4


This is confusing, OT_PANID_LENGTH means the hex length of PANID, while other *_LENGTH means the bytes length.
Shall we keep consistent?

bukepo · 2017-06-23T05:47:07Z

src/web/web-service/wpan_service.hpp

+    enum
+    {
+        kPropertyType_String = 0,
+        kPropertyType_Data


kPropertyType_Data => kPropertyType_Data,?

bukepo · 2017-06-23T05:50:46Z

src/web/web-service/wpan_service.cpp

+    {
+        aNetworkName = wpanController.Get(kWPANTUNDProperty_NetworkName);
+        aExtPanId = wpanController.Get(kWPANTUNDProperty_NetworkXPANID);
+        aExtPanId = aExtPanId.substr(2, aExtPanId.length() - 1);


It seems this line should be

aExtPanId = aExtPanId.substr(2, aExtPanId.length() - 2);

or simply

aExtPanId = aExtPanId.substr(2);

bukepo · 2017-06-23T05:51:40Z

src/web/web-service/wpan_service.cpp

+    else if (wpantundState.find(kWPANTUNDStateAssociating) != std::string::npos)
+    {
+        status = kWpanStatus_Associating;
+    }


missing else?

Done, Thanks.

bukepo · 2017-06-23T05:52:18Z

src/web/web-service/wpan_service.cpp

+        break;
+
+    default:
+        break;


What happens in this case?

bukepo · 2017-06-23T06:34:38Z

src/web/web-service/web_server.hpp

+    WebServer(void);
+
+    /**
+     * This method is disconstructor to free the WebServer.


jwhui · 2017-06-23T11:58:42Z

src/web/mdns-publisher/mdns_publisher.hpp

+ */
+enum
+{
+    kMdnsPublisher_OK = 0,


Add doxygen for each enum.

jwhui · 2017-06-23T11:59:32Z

src/web/mdns-publisher/mdns_publisher.hpp

@@ -127,6 +147,15 @@ class Publisher
        return publisherInstance;
    }

+    /**
+     * This method returns the boolean result of mDNS service status.


Change to: "This method indicates whether or not the mDNS service is running."

jwhui · 2017-06-23T11:59:49Z

src/web/mdns-publisher/mdns_publisher.hpp

+     * @retval false  Not started the mdns service.
+     *
+     */
+    bool IsStarted() const { return mIsStarted; }


Prefer: IsRunning().

jwhui · 2017-06-23T12:02:00Z

src/web/web-service/mdns_service.hpp

+     *
+     * @param[in]  aNetworkName  The reference to the network name.
+     * @param[in]  aExtPanId     The reference to the extend PAN ID.
+     *


Document return value(s).

jwhui · 2017-06-23T12:02:15Z

src/web/web-service/mdns_service.hpp

+     *
+     * @param[in]  aNetworkName  The reference to the network name.
+     * @param[in]  aExtPanId     The reference to the extend PAN ID.
+     *


Document return value(s).

jwhui · 2017-06-23T12:11:23Z

src/web/web-service/wpan_service.hpp

+
+    /**
+     * This method handles the http request to add on-mesh prefix.
+     *


Document parameters.

jwhui · 2017-06-23T12:11:28Z

src/web/web-service/wpan_service.hpp

+
+    /**
+     * This method handles the http request to delete on-mesh prefix http request.
+     *


Document parameters.

jwhui · 2017-06-23T12:11:51Z

src/web/web-service/wpan_service.hpp

+     * This method gets status of wpan service.
+     *
+     * @param[inout]  aNetworkName  The pointer to the network name.
+     * @param[inout]  aIfName  The pointer to the extended PAN ID.


Fix alignment.

jwhui · 2017-06-23T12:12:28Z

src/web/web-service/mdns_service.hpp

+
+    /**
+     * This method handles http request to advertise service.
+     *


Document parameters.

jwhui · 2017-06-23T12:13:41Z

src/web/web-service/mdns_service.hpp

+     * @retval false   Not started the mdns service.
+     *
+     */
+    bool IsStartedService() { return ot::Mdns::Publisher::GetInstance().IsStarted(); };


All void functions or methods shall explicitly declare and specify the void type keyword.

- Divide the web service into HTTP server, WPAN service and mDNS service. - Support configurable HTTP server port (default 80). - Show services status on Web page. - Support google-chrome display the Web page normally.

LeZhang2016 requested review from bukepo and jwhui June 22, 2017 09:04

LeZhang2016 added enhancement P2 labels Jun 22, 2017

LeZhang2016 changed the title ~~Update the Web service~~ Update the Web service to reduce compilation time Jun 22, 2017

LeZhang2016 force-pushed the feature-web-update branch from 03c8328 to 0137873 Compare June 22, 2017 09:32

bukepo reviewed Jun 22, 2017

View reviewed changes

LeZhang2016 force-pushed the feature-web-update branch from 0137873 to 249e2f6 Compare June 22, 2017 10:10

bukepo reviewed Jun 22, 2017

View reviewed changes

LeZhang2016 force-pushed the feature-web-update branch 2 times, most recently from 9105e04 to 4e793ef Compare June 22, 2017 15:25

bukepo reviewed Jun 23, 2017

View reviewed changes

LeZhang2016 force-pushed the feature-web-update branch 2 times, most recently from e1ca276 to 781799d Compare June 23, 2017 03:26

bukepo reviewed Jun 23, 2017

View reviewed changes

LeZhang2016 force-pushed the feature-web-update branch 3 times, most recently from 6b52dec to 705be5e Compare June 23, 2017 06:28

bukepo reviewed Jun 23, 2017

View reviewed changes

src/web/web-service/web_server.hpp Outdated

WebServer(void);

/**

* This method is disconstructor to free the WebServer.

Copy link

Member

bukepo Jun 23, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

LeZhang2016 force-pushed the feature-web-update branch from 705be5e to 0ddf407 Compare June 23, 2017 06:38

jwhui requested a review from bukepo June 23, 2017 11:56

bukepo approved these changes Jun 23, 2017

View reviewed changes

jwhui reviewed Jun 23, 2017

View reviewed changes

LeZhang2016 force-pushed the feature-web-update branch from 0ddf407 to 318ddb9 Compare June 26, 2017 02:13

Update the Web service

cd37163

- Divide the web service into HTTP server, WPAN service and mDNS service. - Support configurable HTTP server port (default 80). - Show services status on Web page. - Support google-chrome display the Web page normally.

LeZhang2016 force-pushed the feature-web-update branch from 318ddb9 to cd37163 Compare June 26, 2017 08:09

jwhui approved these changes Jun 26, 2017

View reviewed changes

jwhui merged commit 851789d into openthread:master Jun 26, 2017

This was referenced Jun 26, 2017

web service, alternate port number? #26

Closed

Display status of services on web ui #48

Closed

mDNS averts do not start when network is restored #49

Closed

connection is NULL #55

Closed

Update the Web service to reduce compilation time #67

Update the Web service to reduce compilation time #67

Conversation

LeZhang2016 commented Jun 22, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LeZhang2016 commented Jun 22, 2017 •

edited