uitest/napi/uitest_napi.cpp

/*
 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include <future>
#include <napi/native_api.h>
#include <napi/native_node_api.h>
#include <queue>
#include <set>
#include <string>
#include <unistd.h>
#include "json.hpp"
#include "pasteboard_client.h"
#include "common_utilities_hpp.h"
#include "frontend_api_defines.h"
#include "ipc_transactor.h"
#include "ui_event_observer_napi.h"

namespace OHOS::uitest {
    using namespace nlohmann;
    using namespace std;

    static constexpr size_t NAPI_MAX_BUF_LEN = 1024;
    static constexpr size_t NAPI_MAX_ARG_COUNT = 8;
    static constexpr size_t BACKEND_OBJ_GC_BATCH = 100;
    // type of unexpected or napi-internal error
    static constexpr napi_status NAPI_ERR = napi_status::napi_generic_failure;
    // the name of property that represents the objectRef of the backend object
    static constexpr char PROP_BACKEND_OBJ_REF[] = "backendObjRef";
    /**For dfx usage, records the uncalled js apis. */
    static set<string> g_unCalledJsFuncNames;
    /**For gc usage, records the backend objRefs about to delete. */
    static queue<string> g_backendObjsAboutToDelete;
    static mutex g_gcQueueMutex;
    /**IPC client. */
    static ApiTransactor g_apiTransactClient(false);
    static future<void> g_establishConnectionFuture;

    /** Convert js string to cpp string.*/
    static string JsStrToCppStr(napi_env env, napi_value jsStr)
    {
        if (jsStr == nullptr) {
            return "";
        }
        napi_valuetype type;
        NAPI_CALL_BASE(env, napi_typeof(env, jsStr, &type), "");
        if (type == napi_undefined || type == napi_null) {
            return "";
        }
        size_t bufSize = 0;
        char buf[NAPI_MAX_BUF_LEN] = {0};
        NAPI_CALL_BASE(env, napi_get_value_string_utf8(env, jsStr, buf, NAPI_MAX_BUF_LEN, &bufSize), "");
        return string(buf, bufSize);
    }

    /**Lifecycle function, establish connection async, called externally.*/
    static napi_value ScheduleEstablishConnection(napi_env env, napi_callback_info info)
    {
        size_t argc = 1;
        napi_value value = nullptr;
        napi_value argv[1] = {0};
        NAPI_CALL(env, napi_get_cb_info(env, info, &argc, argv, &value, nullptr));
        NAPI_ASSERT(env, argc > 0, "Need session token argument!");
        auto token = JsStrToCppStr(env, argv[0]);
        g_establishConnectionFuture = async(launch::async, [env, token]() {
            auto &instance = UiEventObserverNapi::Get();
            using namespace std::placeholders;
            auto callbackHandler = std::bind(&UiEventObserverNapi::HandleEventCallback, &instance, env, _1, _2);
            auto result = g_apiTransactClient.InitAndConnectPeer(token, callbackHandler);
            LOG_I("End setup transaction connection, result=%{public}d", result);
        });
        return nullptr;
    }

    /**Wait connection result sync if need.*/
    static void WaitForConnectionIfNeed()
    {
        if (g_establishConnectionFuture.valid()) {
            LOG_I("Begin WaitForConnection");
            g_establishConnectionFuture.get();
        }
    }

    /**Encapsulates the data objects needed in once api transaction.*/
    struct TransactionContext {
        napi_value jsThis_ = nullptr;
        napi_value *jsArgs_ = nullptr;
        ApiCallInfo callInfo_;
    };

    static napi_value CreateJsException(napi_env env, uint32_t code, string_view msg)
    {
        napi_value codeValue, msgValue, errorValue;
        napi_create_uint32(env, code, &codeValue);
        napi_create_string_utf8(env, msg.data(), NAPI_AUTO_LENGTH, &msgValue);
        napi_create_error(env, nullptr, msgValue, &errorValue);
        napi_set_named_property(env, errorValue, "code", codeValue);
        return errorValue;
    }

    /**Set object constructor function to global as attribute.*/
    static napi_status MountJsConstructorToGlobal(napi_env env, string_view typeName, napi_value function)
    {
        NAPI_ASSERT_BASE(env, function != nullptr, "Null constructor function", napi_invalid_arg);
        const string name = "constructor_" + string(typeName);
        napi_value global = nullptr;
        NAPI_CALL_BASE(env, napi_get_global(env, &global), NAPI_ERR);
        NAPI_CALL_BASE(env, napi_set_named_property(env, global, name.c_str(), function), NAPI_ERR);
        return napi_ok;
    }

    /**Get object constructor function from global as attribute.*/
    static napi_status GetJsConstructorFromGlobal(napi_env env, string_view typeName, napi_value *pFunction)
    {
        NAPI_ASSERT_BASE(env, pFunction != nullptr, "Null constructor receiver", napi_invalid_arg);
        const string name = "constructor_" + string(typeName);
        napi_value global = nullptr;
        NAPI_CALL_BASE(env, napi_get_global(env, &global), NAPI_ERR);
        NAPI_CALL_BASE(env, napi_get_named_property(env, global, name.c_str(), pFunction), NAPI_ERR);
        return napi_ok;
    }

    /**Conversion between value and string, using the builtin JSON methods.*/
    static napi_status ValueStringConvert(napi_env env, napi_value in, napi_value *out, bool stringify)
    {
        if (in == nullptr || out == nullptr) {
            return napi_invalid_arg;
        }
        napi_value global = nullptr;
        napi_value jsonProp = nullptr;
        napi_value jsonFunc = nullptr;
        NAPI_CALL_BASE(env, napi_get_global(env, &global), NAPI_ERR);
        NAPI_CALL_BASE(env, napi_get_named_property(env, global, "JSON", &jsonProp), NAPI_ERR);
        if (stringify) {
            NAPI_CALL_BASE(env, napi_get_named_property(env, jsonProp, "stringify", &jsonFunc), NAPI_ERR);
        } else {
            NAPI_CALL_BASE(env, napi_get_named_property(env, jsonProp, "parse", &jsonFunc), NAPI_ERR);
        }
        napi_value argv[1] = {in};
        NAPI_CALL_BASE(env, napi_call_function(env, jsonProp, jsonFunc, 1, argv, out), NAPI_ERR);
        return napi_ok;
    }

    /**Unmarshal object from json, throw error and return false if the object cannot be deserialized.*/
    static napi_status UnmarshalObject(napi_env env, const json &in, napi_value *pOut, napi_value jsThis)
    {
        NAPI_ASSERT_BASE(env, pOut != nullptr, "Illegal arguments", napi_invalid_arg);
        const auto type = in.type();
        if (type == nlohmann::detail::value_t::null) { // return null
            NAPI_CALL_BASE(env, napi_get_null(env, pOut), NAPI_ERR);
            return napi_ok;
        }
        if (type != nlohmann::detail::value_t::string) { // non-string value, convert and return object
            NAPI_CALL_BASE(env, napi_create_string_utf8(env, in.dump().c_str(), NAPI_AUTO_LENGTH, pOut), NAPI_ERR);
            NAPI_CALL_BASE(env, ValueStringConvert(env, *pOut, pOut, false), NAPI_ERR);
            return napi_ok;
        }
        const auto cppString = in.get<string>();
        string frontendTypeName;
        bool bindJsThis = false;
        for (const auto &classDef : FRONTEND_CLASS_DEFS) {
            const auto objRefFormat = string(classDef->name_) + "#";
            if (cppString.find(objRefFormat) == 0) {
                frontendTypeName = string(classDef->name_);
                bindJsThis = classDef->bindUiDriver_;
                break;
            }
        }
        NAPI_CALL_BASE(env, napi_create_string_utf8(env, cppString.c_str(), NAPI_AUTO_LENGTH, pOut), NAPI_ERR);
        if (frontendTypeName.empty()) { // plain string, return it
            return napi_ok;
        }
        LOG_D("Convert to frontend object: '%{public}s'", frontendTypeName.c_str());
        // covert to wrapper object and bind the backend objectRef
        napi_value refValue = *pOut;
        napi_value constructor = nullptr;
        NAPI_CALL_BASE(env, GetJsConstructorFromGlobal(env, frontendTypeName, &constructor), NAPI_ERR);
        NAPI_CALL_BASE(env, napi_new_instance(env, constructor, 1, &refValue, pOut), NAPI_ERR);
        NAPI_CALL_BASE(env, napi_set_named_property(env, *pOut, PROP_BACKEND_OBJ_REF, refValue), NAPI_ERR);
        if (bindJsThis) { // bind the jsThis object
            LOG_D("Bind jsThis");
            NAPI_ASSERT_BASE(env, jsThis != nullptr, "null jsThis", NAPI_ERR);
            NAPI_CALL_BASE(env, napi_set_named_property(env, *pOut, "boundObject", jsThis), NAPI_ERR);
        }
        return napi_ok;
    }

    /**Evaluate and convert transaction reply to object. Return the exception raised during the
     * transaction if any, else return the result object. */
    static napi_value UnmarshalReply(napi_env env, const TransactionContext &ctx, const ApiReplyInfo &reply)
    {
        if (ctx.callInfo_.fdParamIndex_ >= 0) {
            auto fd = ctx.callInfo_.paramList_.at(INDEX_ZERO).get<int>();
            (void) close(fd);
        }
        LOG_D("Start to Unmarshal transaction result");
        const auto &message = reply.exception_.message_;
        ErrCode code = reply.exception_.code_;
        if (code == INTERNAL_ERROR || code == ERR_INTERNAL) {
            LOG_E("ErrorInfo: code='%{public}u', message='%{public}s'", code, message.c_str());
        } else if (reply.exception_.code_ != NO_ERROR) {
            LOG_I("ErrorInfo: code='%{public}u', message='%{public}s'", code, message.c_str());
            return CreateJsException(env, code, message);
        }
        LOG_D("Start to Unmarshal return value: %{public}s", reply.resultValue_.dump().c_str());
        const auto resultType = reply.resultValue_.type();
        napi_value result = nullptr;
        if (resultType == nlohmann::detail::value_t::null) { // return null
            NAPI_CALL(env, napi_get_null(env, &result));
        } else if (resultType == nlohmann::detail::value_t::array) { // return array
            NAPI_CALL(env, napi_create_array_with_length(env, reply.resultValue_.size(), &result));
            for (size_t idx = 0; idx < reply.resultValue_.size(); idx++) {
                napi_value item = nullptr;
                NAPI_CALL(env, UnmarshalObject(env, reply.resultValue_.at(idx), &item, ctx.jsThis_));
                NAPI_CALL(env, napi_set_element(env, result, idx, item));
            }
        } else { // return single value
            NAPI_CALL(env, UnmarshalObject(env, reply.resultValue_, &result, ctx.jsThis_));
        }
        return result;
    }

    /**Call api with parameters out, wait for and return result value or throw raised exception.*/
    napi_value TransactSync(napi_env env, TransactionContext &ctx)
    {
        WaitForConnectionIfNeed();
        LOG_D("TargetApi=%{public}s", ctx.callInfo_.apiId_.data());
        auto reply = ApiReplyInfo();
        g_apiTransactClient.Transact(ctx.callInfo_, reply);
        auto resultValue = UnmarshalReply(env, ctx, reply);
        auto isError = false;
        NAPI_CALL(env, napi_is_error(env, resultValue, &isError));
        if (isError) {
            NAPI_CALL(env, napi_throw(env, resultValue));
            NAPI_CALL(env, napi_get_undefined(env, &resultValue)); // return undefined it's error
        }
        // notify backend objects deleting
        if (g_backendObjsAboutToDelete.size() >= BACKEND_OBJ_GC_BATCH) {
            auto gcCall = ApiCallInfo {.apiId_ = "BackendObjectsCleaner"};
            unique_lock<mutex> lock(g_gcQueueMutex);
            for (size_t count = 0; count < BACKEND_OBJ_GC_BATCH; count++) {
                gcCall.paramList_.emplace_back(g_backendObjsAboutToDelete.front());
                g_backendObjsAboutToDelete.pop();
            }
            lock.unlock();
            auto gcReply = ApiReplyInfo();
            g_apiTransactClient.Transact(gcCall, gcReply);
        }
        return resultValue;
    }

    /**Encapsulates the data objects needed for async transaction.*/
    struct AsyncTransactionCtx {
        TransactionContext ctx_;
        ApiReplyInfo reply_;
        napi_async_work asyncWork_ = nullptr;
        napi_deferred deferred_ = nullptr;
        napi_ref jsThisRef_ = nullptr;
    };

    /**Call api with parameters out, return a promise.*/
    static napi_value TransactAsync(napi_env env, TransactionContext &ctx)
    {
        constexpr uint32_t refCount = 1;
        LOG_D("TargetApi=%{public}s", ctx.callInfo_.apiId_.data());
        napi_value resName;
        NAPI_CALL(env, napi_create_string_latin1(env, __FUNCTION__, NAPI_AUTO_LENGTH, &resName));
        auto aCtx = new AsyncTransactionCtx();
        aCtx->ctx_ = ctx;
        napi_value promise;
        NAPI_CALL(env, napi_create_promise(env, &(aCtx->deferred_), &promise));
        NAPI_CALL(env, napi_create_reference(env, ctx.jsThis_, refCount, &(aCtx->jsThisRef_)));
        napi_create_async_work(
            env, nullptr, resName,
            [](napi_env env, void *data) {
                auto aCtx = reinterpret_cast<AsyncTransactionCtx *>(data);
                // NOT:: use 'auto&' rather than 'auto', or the result will be set to copy-constructed temp-object
                auto &ctx = aCtx->ctx_;
                g_apiTransactClient.Transact(ctx.callInfo_, aCtx->reply_);
            },
            [](napi_env env, napi_status status, void *data) {
                auto aCtx = reinterpret_cast<AsyncTransactionCtx *>(data);
                napi_handle_scope scope = nullptr;
                napi_open_handle_scope(env, &scope);
                if (scope == nullptr) {
                    return;
                }
                napi_get_reference_value(env, aCtx->jsThisRef_, &(aCtx->ctx_.jsThis_));
                auto resultValue = UnmarshalReply(env, aCtx->ctx_, aCtx->reply_);
                napi_delete_reference(env, aCtx->jsThisRef_);
                auto isError = false;
                napi_is_error(env, resultValue, &isError);
                if (isError) {
                    napi_reject_deferred(env, aCtx->deferred_, resultValue);
                } else {
                    napi_resolve_deferred(env, aCtx->deferred_, resultValue);
                }
                napi_delete_async_work(env, aCtx->asyncWork_);
                napi_close_handle_scope(env, scope);
                delete aCtx;
            },
            (void *)aCtx, &(aCtx->asyncWork_));
        napi_queue_async_work(env, aCtx->asyncWork_);
        return promise;
    }

    static napi_status GetBackendObjRefProp(napi_env env, napi_value value, napi_value* pOut)
    {
        napi_valuetype type = napi_undefined;
        NAPI_CALL_BASE(env, napi_typeof(env, value, &type), NAPI_ERR);
        if (type != napi_object) {
            *pOut = nullptr;
            return napi_ok;
        }
        bool hasRef = false;
        NAPI_CALL_BASE(env, napi_has_named_property(env, value, PROP_BACKEND_OBJ_REF, &hasRef), NAPI_ERR);
        if (!hasRef) {
            *pOut = nullptr;
        } else {
            NAPI_CALL_BASE(env, napi_get_named_property(env, value, PROP_BACKEND_OBJ_REF, pOut), NAPI_ERR);
        }
        return napi_ok;
    }

    static void SetPasteBoardData(string_view text)
    {
        auto pasteBoardMgr = MiscServices::PasteboardClient::GetInstance();
        pasteBoardMgr->Clear();
        auto pasteData = MiscServices::PasteboardClient::GetInstance()->CreatePlainTextData(string(text));
        pasteBoardMgr->SetPasteData(*pasteData);
    }

    static void PreprocessTransaction(napi_env env, TransactionContext &ctx, napi_value &error)
    {
        auto &paramList = ctx.callInfo_.paramList_;
        const auto &id = ctx.callInfo_.apiId_;
        if (id  == "Component.inputText" && paramList.size() > 0) {
            auto text = paramList.at(INDEX_ZERO).get<string>();
            SetPasteBoardData(text);
        } else if (id  == "Driver.screenCap" || id  == "UiDriver.screenCap" || id  == "Driver.screenCapture") {
            if (paramList.size() < 1 || paramList.at(0).type() != nlohmann::detail::value_t::string) {
                LOG_E("Missing file path argument");
                error = CreateJsException(env, ERR_INVALID_INPUT, "Missing file path argument");
                return;
            }
            auto path = paramList.at(INDEX_ZERO).get<string>();
            auto fd = open(path.c_str(), O_RDWR | O_CREAT, 0666);
            if (fd == -1) {
                LOG_E("Invalid file path: %{public}s", path.data());
                error = CreateJsException(env, ERR_INVALID_INPUT, "Invalid file path:" + path);
                return;
            }
            paramList[INDEX_ZERO] = fd;
            ctx.callInfo_.fdParamIndex_ = INDEX_ZERO;
        } else if (id  == "UIEventObserver.once") {
            auto err = ApiCallErr(NO_ERROR);
            UiEventObserverNapi::Get().PreprocessCallOnce(env, ctx.callInfo_, ctx.jsThis_, ctx.jsArgs_, err);
            if (err.code_ != NO_ERROR) {
                error = CreateJsException(env, err.code_, err.message_);
            }
        }
    }

    /**Generic js-api callback.*/
    static napi_value GenericCallback(napi_env env, napi_callback_info info)
    {
        // extract callback data
        TransactionContext ctx;
        napi_value argv[NAPI_MAX_ARG_COUNT] = {nullptr};
        auto count = NAPI_MAX_ARG_COUNT;
        void *pData = nullptr;
        NAPI_CALL(env, napi_get_cb_info(env, info, &count, argv, &(ctx.jsThis_), &pData));
        NAPI_ASSERT(env, pData != nullptr, "Null methodDef");
        ctx.jsArgs_ = argv;
        auto methodDef = reinterpret_cast<const FrontendMethodDef *>(pData);
        g_unCalledJsFuncNames.erase(string(methodDef->name_)); // api used
        // 1. marshal parameters into json-array
        napi_value paramArray = nullptr;
        NAPI_CALL(env, napi_create_array_with_length(env, count, &paramArray));
        if (count > NAPI_MAX_ARG_COUNT) {
            count = NAPI_MAX_ARG_COUNT;
        }
        for (size_t idx = 0; idx < count; idx++) {
            napi_value item = nullptr; // convert to backendObjRef if any
            NAPI_CALL(env, GetBackendObjRefProp(env, argv[idx], &item));
            if (item == nullptr) {
                item = argv[idx];
            }
            NAPI_CALL(env, napi_set_element(env, paramArray, idx, item));
        }
        napi_value jsTempObj = nullptr;
        NAPI_CALL(env, ValueStringConvert(env, paramArray, &jsTempObj, true));
        ctx.callInfo_.paramList_ = nlohmann::json::parse(JsStrToCppStr(env, jsTempObj));
        // 2. marshal jsThis into json (backendObjRef)
        if (!methodDef->static_) {
            NAPI_CALL(env, GetBackendObjRefProp(env, ctx.jsThis_, &jsTempObj));
            ctx.callInfo_.callerObjRef_ = JsStrToCppStr(env, jsTempObj);
        }
        // 3. fill-in apiId
        ctx.callInfo_.apiId_ = methodDef->name_;
        napi_value error = nullptr;
        PreprocessTransaction(env, ctx, error);
        if (error != nullptr) {
            NAPI_CALL(env, napi_throw(env, error));
            NAPI_CALL(env, napi_get_undefined(env, &error));
            return error;
        }
        // 4. call out, sync or async
        if (methodDef->fast_) {
            return TransactSync(env, ctx);
        } else {
            return TransactAsync(env, ctx);
        }
    }

    /**Exports uitest js wrapper-classes and its global constructor.*/
    static napi_status ExportClass(napi_env env, napi_value exports, const FrontEndClassDef &classDef)
    {
        NAPI_ASSERT_BASE(env, exports != nullptr, "Illegal export params", NAPI_ERR);
        const auto name = classDef.name_.data();
        const auto methodNeatNameOffset = classDef.name_.length() + 1;
        auto descs = make_unique<napi_property_descriptor[]>(classDef.methodCount_);
        for (size_t idx = 0; idx < classDef.methodCount_; idx++) {
            const auto &methodDef = classDef.methods_[idx];
            g_unCalledJsFuncNames.insert(string(methodDef.name_));
            const auto neatName = methodDef.name_.substr(methodNeatNameOffset);
            napi_property_descriptor desc = DECLARE_NAPI_FUNCTION(neatName.data(), GenericCallback);
            if (methodDef.static_) {
                desc.attributes = napi_static;
            }
            desc.data = (void *)(&methodDef);
            descs[idx] = desc;
        }
        constexpr auto initializer = [](napi_env env, napi_callback_info info) {
            auto argc = NAPI_MAX_ARG_COUNT;
            napi_value argv[NAPI_MAX_ARG_COUNT] = { nullptr };
            napi_value jsThis = nullptr;
            NAPI_CALL_BASE(env, napi_get_cb_info(env, info, &argc, argv, &jsThis, nullptr), jsThis);
            auto ref = make_unique<string>(argc <= 0 ? "" : JsStrToCppStr(env, argv[0]));
            auto finalizer = [](napi_env env, void *data, void *hint) {
                auto ref = reinterpret_cast<string *>(data);
                if (ref->length() > 0) {
                    LOG_D("Finalizing object: %{public}s", ref->c_str());
                    unique_lock<mutex> lock(g_gcQueueMutex);
                    g_backendObjsAboutToDelete.push(*ref);
                }
                delete ref;
            };
            NAPI_CALL_BASE(env, napi_wrap(env, jsThis, ref.release(), finalizer, nullptr, nullptr), jsThis);
            return jsThis;
        };
        // define class, provide the js-class members(property) and initializer.
        napi_value ctor = nullptr;
        NAPI_CALL_BASE(env, napi_define_class(env, name, NAPI_AUTO_LENGTH, initializer, nullptr,
                                              classDef.methodCount_, descs.get(), &ctor), NAPI_ERR);
        NAPI_CALL_BASE(env, napi_set_named_property(env, exports, name, ctor), NAPI_ERR);
        NAPI_CALL_BASE(env, MountJsConstructorToGlobal(env, name, ctor), NAPI_ERR);
        if (string_view(name) == "On" || string_view(name) == "By") {
            // create seed-On/By with special objectRef and mount to exporter
            auto seedName = string_view(name) == "On" ? "ON" : "BY";
            auto seedRef = string_view(name) == "On" ? REF_SEED_ON.data() : REF_SEED_BY.data();
            napi_value seed = nullptr;
            NAPI_CALL_BASE(env, napi_new_instance(env, ctor, 0, nullptr, &seed), NAPI_ERR);
            napi_value prop = nullptr;
            NAPI_CALL_BASE(env, napi_create_string_utf8(env, seedRef, NAPI_AUTO_LENGTH, &prop), NAPI_ERR);
            NAPI_CALL_BASE(env, napi_set_named_property(env, seed, PROP_BACKEND_OBJ_REF, prop), NAPI_ERR);
            NAPI_CALL_BASE(env, napi_set_named_property(env, exports, seedName, seed), NAPI_ERR);
        }
        return napi_ok;
    }

    /**Exports enumerator class.*/
    static napi_status ExportEnumerator(napi_env env, napi_value exports, const FrontendEnumeratorDef &enumDef)
    {
        NAPI_ASSERT_BASE(env, exports != nullptr, "Illegal export params", NAPI_ERR);
        napi_value enumerator;
        NAPI_CALL_BASE(env, napi_create_object(env, &enumerator), NAPI_ERR);
        for (size_t idx = 0; idx < enumDef.valueCount_; idx++) {
            const auto &def = enumDef.values_[idx];
            napi_value prop = nullptr;
            NAPI_CALL_BASE(env, napi_create_string_utf8(env, def.valueJson_.data(), NAPI_AUTO_LENGTH, &prop), NAPI_ERR);
            NAPI_CALL_BASE(env, ValueStringConvert(env, prop, &prop, false), NAPI_ERR);
            NAPI_CALL_BASE(env, napi_set_named_property(env, enumerator, def.name_.data(), prop), NAPI_ERR);
        }
        NAPI_CALL_BASE(env, napi_set_named_property(env, exports, enumDef.name_.data(), enumerator), NAPI_ERR);
        return napi_ok;
    }

    /**Function used for statistics, return an array of uncalled js-api names.*/
    static napi_value GetUnCalledJsApis(napi_env env, napi_callback_info info)
    {
        napi_value nameArray;
        NAPI_CALL(env, napi_create_array_with_length(env, g_unCalledJsFuncNames.size(), &nameArray));
        size_t idx = 0;
        for (auto &name : g_unCalledJsFuncNames) {
            napi_value nameItem = nullptr;
            NAPI_CALL(env, napi_create_string_utf8(env, name.c_str(), NAPI_AUTO_LENGTH, &nameItem));
            NAPI_CALL(env, napi_set_element(env, nameArray, idx, nameItem));
            idx++;
        }
        return nameArray;
    }

    napi_value Export(napi_env env, napi_value exports)
    {
        LOG_I("Begin export uitest apis");
        // export transaction-environment-lifecycle callbacks and dfx functions
        napi_property_descriptor props[] = {
            DECLARE_NAPI_STATIC_FUNCTION("scheduleEstablishConnection", ScheduleEstablishConnection),
            DECLARE_NAPI_STATIC_FUNCTION("getUnCalledJsApis", GetUnCalledJsApis),
        };
        NAPI_CALL(env, napi_define_properties(env, exports, sizeof(props) / sizeof(props[0]), props));
        NAPI_CALL(env, ExportClass(env, exports, BY_DEF));
        NAPI_CALL(env, ExportClass(env, exports, UI_DRIVER_DEF));
        NAPI_CALL(env, ExportClass(env, exports, UI_COMPONENT_DEF));
        NAPI_CALL(env, ExportClass(env, exports, ON_DEF));
        NAPI_CALL(env, ExportClass(env, exports, DRIVER_DEF));
        NAPI_CALL(env, ExportClass(env, exports, COMPONENT_DEF));
        NAPI_CALL(env, ExportClass(env, exports, UI_WINDOW_DEF));
        NAPI_CALL(env, ExportClass(env, exports, POINTER_MATRIX_DEF));
        NAPI_CALL(env, ExportClass(env, exports, UI_EVENT_OBSERVER_DEF));
        NAPI_CALL(env, ExportEnumerator(env, exports, MATCH_PATTERN_DEF));
        NAPI_CALL(env, ExportEnumerator(env, exports, RESIZE_DIRECTION_DEF));
        NAPI_CALL(env, ExportEnumerator(env, exports, WINDOW_MODE_DEF));
        NAPI_CALL(env, ExportEnumerator(env, exports, DISPLAY_ROTATION_DEF));
        NAPI_CALL(env, ExportEnumerator(env, exports, MOUSE_BUTTON_DEF));
        NAPI_CALL(env, ExportEnumerator(env, exports, UI_DIRECTION_DEF));
        LOG_I("End export uitest apis");
        return exports;
    }

    static napi_module module = {
        .nm_version = 1,
        .nm_flags = 0,
        .nm_filename = nullptr,
        .nm_register_func = Export,
        .nm_modname = "UiTest",
        .nm_priv = ((void *)0),
        .reserved = {0},
    };

    extern "C" __attribute__((constructor)) void RegisterModule(void)
    {
        napi_module_register(&module);
    }
} // namespace OHOS::uitest

// put register functions out of namespace to ensure C-linkage
extern const char _binary_uitest_exporter_js_start[];
extern const char _binary_uitest_exporter_js_end[];
extern const char _binary_uitest_exporter_abc_start[];
extern const char _binary_uitest_exporter_abc_end[];

extern "C" __attribute__((visibility("default"))) void NAPI_UiTest_GetJSCode(const char **buf, int *bufLen)
{
    if (buf != nullptr) {
        *buf = _binary_uitest_exporter_js_start;
    }
    if (bufLen != nullptr) {
        *bufLen = _binary_uitest_exporter_js_end - _binary_uitest_exporter_js_start;
    }
}

extern "C" __attribute__((visibility("default"))) void NAPI_UiTest_GetABCCode(const char **buf, int *bufLen)
{
    if (buf != nullptr) {
        *buf = _binary_uitest_exporter_abc_start;
    }
    if (bufLen != nullptr) {
        *bufLen = _binary_uitest_exporter_abc_end - _binary_uitest_exporter_abc_start;
    }
}