xref: /foundation/distributeddatamgr/kv_store/frameworks/jskitsimpl/distributedkvstore/src/js_kv_manager.cpp

/*
 * Copyright (c) 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.
 */
#define LOG_TAG "JsKVManager"
#include "js_kv_manager.h"
#include "distributed_kv_data_manager.h"
#include "js_device_kv_store.h"
#include "js_single_kv_store.h"
#include "js_util.h"
#include "log_print.h"
#include "napi_queue.h"
#include "js_error_utils.h"

using namespace OHOS::DistributedKv;

namespace OHOS::DistributedKVStore {
static bool IsStoreTypeSupported(Options options)
{
    return (options.kvStoreType == KvStoreType::DEVICE_COLLABORATION)
        || (options.kvStoreType == KvStoreType::SINGLE_VERSION);
}

JsKVManager::JsKVManager(const std::string &bundleName, napi_env env, ContextParam param)
    : bundleName_(bundleName), uvQueue_(std::make_shared<UvQueue>(env)),
    param_(std::make_shared<ContextParam>(std::move(param)))
{
}

JsKVManager::~JsKVManager()
{
    ZLOGD("no memory leak for JsKVManager");
    std::lock_guard<std::mutex> lck(deathMutex_);
    for (auto& it : deathRecipient_) {
        kvDataManager_.UnRegisterKvStoreServiceDeathRecipient(it);
        it->Clear();
    }
    deathRecipient_.clear();
}

napi_value JsKVManager::CreateKVManager(napi_env env, napi_callback_info info)
{
    size_t argc = 2;
    napi_value argv[2] = { nullptr };
    napi_value result = nullptr;
    napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr);

    if (argc < 1) {
        ThrowNapiError(env, Status::INVALID_ARGUMENT, "Parameter error:Mandatory parameters are left unspecified");
        return result;
    }

    std::string bundleName;
    napi_status status = JSUtil::GetNamedProperty(env, argv[0], "bundleName", bundleName);
    if (status == napi_generic_failure) {
        ThrowNapiError(env, Status::INVALID_ARGUMENT, "Parameter error:Missing bundleName parameter.");
        return result;
    }
    if (bundleName.empty()) {
        ThrowNapiError(env, Status::INVALID_ARGUMENT, "Parameter error:The type of bundleName must be string.");
        return result;
    }

    napi_value jsContext = nullptr;
    status = JSUtil::GetNamedProperty(env, argv[0], "context", jsContext);
    if (status == napi_generic_failure) {
        ThrowNapiError(env, Status::INVALID_ARGUMENT, "Parameter error:Missing context parameter.");
        return result;
    }

    status = napi_new_instance(env, Constructor(env), argc, argv, &result);
    if (result == nullptr || status != napi_ok) {
        ThrowNapiError(env, status, "KVManager::New failed!", false);
        return result;
    }

    return result;
}

struct GetKVStoreContext : public ContextBase {
    std::string storeId;
    Options options;
    JsSingleKVStore* kvStore = nullptr;
    napi_ref ref = nullptr;

    void GetCbInfo(napi_env env, napi_callback_info info)
    {
        auto input = [env, this](size_t argc, napi_value* argv) {
            // required 2 arguments :: <storeId> <options>
            ASSERT_BUSINESS_ERR(this, argc >= 2, Status::INVALID_ARGUMENT,
                "Parameter error:Mandatory parameters are left unspecified");
            status = JSUtil::GetValue(env, argv[0], storeId);
            ASSERT_BUSINESS_ERR(this, ((status == napi_ok) && JSUtil::IsValid(storeId)), Status::INVALID_ARGUMENT,
                "Parameter error:storeId must be string,consist of letters,digits,underscores(_),limit 128 chars");
            status = JSUtil::GetValue(env, argv[1], options);
            ASSERT_BUSINESS_ERR(this, status == napi_ok, Status::INVALID_ARGUMENT,
                "Parameter error:The params type not matching option");
            ASSERT_BUSINESS_ERR(this, options.securityLevel != INVALID_LABEL, Status::INVALID_ARGUMENT,
                "Parameter error:unusable securityLevel");
            ASSERT_BUSINESS_ERR(this, IsStoreTypeSupported(options), Status::INVALID_ARGUMENT,
                "Parameter error:only support DEVICE_COLLABORATION or SINGLE_VERSION");
            ZLOGD("GetKVStore kvStoreType=%{public}d", options.kvStoreType);
            if (options.kvStoreType == KvStoreType::DEVICE_COLLABORATION) {
                ref = JSUtil::NewWithRef(env, argc, argv, reinterpret_cast<void**>(&kvStore),
                                         JsDeviceKVStore::Constructor(env));
            } else if (options.kvStoreType == KvStoreType::SINGLE_VERSION) {
                ref = JSUtil::NewWithRef(env, argc, argv, reinterpret_cast<void**>(&kvStore),
                                         JsSingleKVStore::Constructor(env));
            }
        };
        ContextBase::GetCbInfo(env, info, input);
    }
};

/*
 * [JS API Prototype]
 * [AsyncCallback]
 *      getKVStore<T extends KVStore>(storeId: string, options: Options, callback: AsyncCallback<T>): void;
 * [Promise]
 *      getKVStore<T extends KVStore>(storeId: string, options: Options): Promise<T>;
 */
napi_value JsKVManager::GetKVStore(napi_env env, napi_callback_info info)
{
    auto ctxt = std::make_shared<GetKVStoreContext>();
    ctxt->GetCbInfo(env, info);
    ASSERT_NULL(!ctxt->isThrowError, "GetKVStore exit");

    auto execute = [ctxt]() {
        auto kvm = reinterpret_cast<JsKVManager*>(ctxt->native);
        ASSERT_ARGS(ctxt, kvm != nullptr, "KVManager is null, failed!");
        AppId appId = { kvm->bundleName_ };
        StoreId storeId = { ctxt->storeId };
        ctxt->options.baseDir = kvm->param_->baseDir;
        ctxt->options.area = kvm->param_->area + 1;
        ctxt->options.hapName = kvm->param_->hapName;
        ctxt->options.apiVersion = kvm->param_->apiVersion;
        ZLOGD("Options area:%{public}d dir:%{public}s", ctxt->options.area, ctxt->options.baseDir.c_str());
        std::shared_ptr<DistributedKv::SingleKvStore> kvStore;
        Status status = kvm->kvDataManager_.GetSingleKvStore(ctxt->options, appId, storeId, kvStore);
        if (status == DATA_CORRUPTED) {
            ctxt->options.rebuild = true;
            status = kvm->kvDataManager_.GetSingleKvStore(ctxt->options, appId, storeId, kvStore);
            ZLOGE("Data has corrupted, rebuild db");
        }
        ctxt->status = (GenerateNapiError(status, ctxt->jsCode, ctxt->error) == Status::SUCCESS) ?
            napi_ok : napi_generic_failure;
        ctxt->kvStore->SetKvStorePtr(kvStore);
        ctxt->kvStore->SetSchemaInfo(!ctxt->options.schema.empty());
        ctxt->kvStore->SetContextParam(kvm->param_);
        ctxt->kvStore->SetUvQueue(kvm->uvQueue_);
    };
    auto output = [env, ctxt](napi_value& result) {
        ctxt->status = napi_get_reference_value(env, ctxt->ref, &result);
        napi_delete_reference(env, ctxt->ref);
        ASSERT_STATUS(ctxt, "output KVManager failed");
        ZLOGI("output delete reference success");
    };
    return NapiQueue::AsyncWork(env, ctxt, std::string(__FUNCTION__), execute, output);
}

/*
 * [JS API Prototype]
 * [AsyncCB]  closeKVStore(appId: string, storeId: string, kvStore: KVStore, callback: AsyncCallback<void>):void
 * [Promise]  closeKVStore(appId: string, storeId: string, kvStore: KVStore):Promise<void>
 */
napi_value JsKVManager::CloseKVStore(napi_env env, napi_callback_info info)
{
    struct ContextInfo : public ContextBase {
        std::string appId;
        std::string storeId;
        napi_value kvStore;
    };
    auto ctxt = std::make_shared<ContextInfo>();
    auto input = [env, ctxt](size_t argc, napi_value* argv) {
        // required 3 arguments :: <appId> <storeId> <kvStore>
        ASSERT_BUSINESS_ERR(ctxt, argc >= 2, Status::INVALID_ARGUMENT,
            "Parameter error:Mandatory parameters are left unspecified");
        ctxt->status = JSUtil::GetValue(env, argv[0], ctxt->appId);
        ASSERT_BUSINESS_ERR(ctxt, (ctxt->status == napi_ok) && !ctxt->appId.empty(), Status::INVALID_ARGUMENT,
            "Parameter error:appId empty");
        ctxt->status = JSUtil::GetValue(env, argv[1], ctxt->storeId);
        ASSERT_BUSINESS_ERR(ctxt, (ctxt->status == napi_ok) && JSUtil::IsValid(ctxt->storeId), Status::INVALID_ARGUMENT,
            "Parameter error:storeId must be string,consist of letters, digits, underscores(_), limit 128 characters");
    };
    ctxt->GetCbInfo(env, info, input);
    ASSERT_NULL(!ctxt->isThrowError, "CloseKVStore exits");

    auto execute = [ctxt]() {
        AppId appId { ctxt->appId };
        StoreId storeId { ctxt->storeId };
        Status status = reinterpret_cast<JsKVManager*>(ctxt->native)->kvDataManager_.CloseKvStore(appId, storeId);
        status = GenerateNapiError(status, ctxt->jsCode, ctxt->error);
        ZLOGD("CloseKVStore return status:%{public}d", status);
        ctxt->status
            = (status == Status::SUCCESS) || (status == Status::STORE_NOT_FOUND) || (status == Status::STORE_NOT_OPEN)
            ? napi_ok
            : napi_generic_failure;
    };
    return NapiQueue::AsyncWork(env, ctxt, std::string(__FUNCTION__), execute);
}

/*
 * [JS API Prototype]
 * [AsyncCB]  deleteKVStore(appId: string, storeId: string, callback: AsyncCallback<void>): void
 * [Promise]  deleteKVStore(appId: string, storeId: string):Promise<void>
 */
napi_value JsKVManager::DeleteKVStore(napi_env env, napi_callback_info info)
{
    struct ContextInfo : public ContextBase {
        std::string appId;
        std::string storeId;
    };
    auto ctxt = std::make_shared<ContextInfo>();
    auto input = [env, ctxt](size_t argc, napi_value* argv) {
        // required 2 arguments :: <appId> <storeId>
        ASSERT_BUSINESS_ERR(ctxt, argc >= 2, Status::INVALID_ARGUMENT,
            "Parameter error:Mandatory parameters are left unspecified");
        size_t index = 0;
        ctxt->status = JSUtil::GetValue(env, argv[index++], ctxt->appId);
        ASSERT_BUSINESS_ERR(ctxt, !ctxt->appId.empty(), Status::INVALID_ARGUMENT,
            "Parameter error:appId empty");
        ctxt->status = JSUtil::GetValue(env, argv[index++], ctxt->storeId);
        ASSERT_BUSINESS_ERR(ctxt, JSUtil::IsValid(ctxt->storeId), Status::INVALID_ARGUMENT,
            "error:storeId must be string; consist of only letters, digits underscores (_),limit 128 characters");
    };
    ctxt->GetCbInfo(env, info, input);
    ASSERT_NULL(!ctxt->isThrowError, "DeleteKVStore exits");

    auto execute = [ctxt]() {
        AppId appId { ctxt->appId };
        StoreId storeId { ctxt->storeId };
        auto kvm = reinterpret_cast<JsKVManager*>(ctxt->native);
        ASSERT_ARGS(ctxt, kvm != nullptr, "KVManager is null, failed!");
        std::string databaseDir = kvm->param_->baseDir;
        ZLOGD("DeleteKVStore databaseDir is: %{public}s", databaseDir.c_str());
        Status status = kvm->kvDataManager_.DeleteKvStore(appId, storeId, databaseDir);
        ZLOGD("DeleteKvStore status:%{public}d", status);
        ctxt->status = (GenerateNapiError(status, ctxt->jsCode, ctxt->error) == Status::SUCCESS) ?
            napi_ok : napi_generic_failure;
    };
    return NapiQueue::AsyncWork(env, ctxt, std::string(__FUNCTION__), execute);
}

/*
 * [JS API Prototype]
 * [AsyncCB]  getAllKVStoreId(appId: string, callback: AsyncCallback<string[]>):void
 * [Promise]  getAllKVStoreId(appId: string):Promise<string[]>
 */
napi_value JsKVManager::GetAllKVStoreId(napi_env env, napi_callback_info info)
{
    struct ContextInfo : public ContextBase {
        std::string appId;
        std::vector<StoreId> storeIdList;
    };

    auto ctxt = std::make_shared<ContextInfo>();
    auto input = [env, ctxt](size_t argc, napi_value* argv) {
        // required 1 arguments :: <appId>
        ASSERT_BUSINESS_ERR(ctxt, argc >= 1, Status::INVALID_ARGUMENT,
            "Parameter error:Mandatory parameters are left unspecified");
        ctxt->status = JSUtil::GetValue(env, argv[0], ctxt->appId);
        ASSERT_BUSINESS_ERR(ctxt, !ctxt->appId.empty(), Status::INVALID_ARGUMENT,
            "Parameter error:appId empty");
        ASSERT_BUSINESS_ERR(ctxt, (ctxt->appId.size() < MAX_APP_ID_LEN), Status::INVALID_ARGUMENT,
            "Parameter error:appId exceed 256 characters");
    };
    ctxt->GetCbInfo(env, info, input);
    ASSERT_NULL(!ctxt->isThrowError, "GetAllKVStoreId exits");

    auto execute = [ctxt]() {
        auto kvm = reinterpret_cast<JsKVManager*>(ctxt->native);
        ASSERT_ARGS(ctxt, kvm != nullptr, "KVManager is null, failed!");
        AppId appId { ctxt->appId };
        Status status = kvm->kvDataManager_.GetAllKvStoreId(appId, ctxt->storeIdList);
        ZLOGD("execute status:%{public}d", status);
        ctxt->status = (GenerateNapiError(status, ctxt->jsCode, ctxt->error) == Status::SUCCESS) ?
            napi_ok : napi_generic_failure;
    };
    auto output = [env, ctxt](napi_value& result) {
        ctxt->status = JSUtil::SetValue(env, ctxt->storeIdList, result);
        ZLOGD("output status:%{public}d", ctxt->status);
    };
    return NapiQueue::AsyncWork(env, ctxt, std::string(__FUNCTION__), execute, output);
}

napi_value JsKVManager::On(napi_env env, napi_callback_info info)
{
    auto ctxt = std::make_shared<ContextBase>();
    auto input = [env, ctxt](size_t argc, napi_value* argv) {
        // required 2 arguments :: <event> <callback>
        ASSERT_BUSINESS_ERR(ctxt, argc >= 2, Status::INVALID_ARGUMENT,
            "Parameter error:Mandatory parameters are left unspecified");
        std::string event;
        ctxt->status = JSUtil::GetValue(env, argv[0], event);
        ZLOGI("subscribe to event:%{public}s", event.c_str());
        ASSERT_BUSINESS_ERR(ctxt, event == "distributedDataServiceDie", Status::INVALID_ARGUMENT,
            "Parameter error:parameter event type not equal distributedDataServiceDie");

        napi_valuetype valueType = napi_undefined;
        ctxt->status = napi_typeof(env, argv[1], &valueType);
        ASSERT_BUSINESS_ERR(ctxt, (ctxt->status == napi_ok) && (valueType == napi_function), Status::INVALID_ARGUMENT,
            "Parameter error:parameter callback must be function type");

        JsKVManager* proxy = reinterpret_cast<JsKVManager*>(ctxt->native);
        ASSERT_BUSINESS_ERR(ctxt, proxy != nullptr, Status::INVALID_ARGUMENT,
            "Parameter error:JsKVManager nullptr");

        std::lock_guard<std::mutex> lck(proxy->deathMutex_);
        for (auto& it : proxy->deathRecipient_) {
            if (JSUtil::Equals(env, argv[1], it->GetCallback())) {
                ZLOGD("KVManager::On callback already register!");
                return;
            }
        }
        auto deathRecipient = std::make_shared<DeathRecipient>(proxy->uvQueue_, argv[1]);
        proxy->kvDataManager_.RegisterKvStoreServiceDeathRecipient(deathRecipient);
        proxy->deathRecipient_.push_back(deathRecipient);
        ZLOGD("on mapsize: %{public}d", static_cast<int>(proxy->deathRecipient_.size()));
    };
    ctxt->GetCbInfoSync(env, info, input);
    if (ctxt->status != napi_ok) {
        ThrowNapiError(env, Status::INVALID_ARGUMENT, "");
    }
    return nullptr;
}

napi_value JsKVManager::Off(napi_env env, napi_callback_info info)
{
    auto ctxt = std::make_shared<ContextBase>();
    auto input = [env, ctxt](size_t argc, napi_value* argv) {
        // required 1 or 2 arguments :: <event> [callback]
        ASSERT_BUSINESS_ERR(ctxt, argc > 0, Status::INVALID_ARGUMENT,
            "Parameter error:Mandatory parameters are left unspecified");
        std::string event;
        ctxt->status = JSUtil::GetValue(env, argv[0], event);
        // required 1 arguments :: <event>
        ZLOGI("unsubscribe to event:%{public}s %{public}s specified", event.c_str(), (argc == 1) ? "without" : "with");
        ASSERT_BUSINESS_ERR(ctxt, event == "distributedDataServiceDie", Status::INVALID_ARGUMENT,
            "Parameter error:parameter event not equal distributedDataServiceDie");
        // have 2 arguments :: have the [callback]
        if (argc == 2) {
            napi_valuetype valueType = napi_undefined;
            ctxt->status = napi_typeof(env, argv[1], &valueType);
            ASSERT_BUSINESS_ERR(ctxt, (ctxt->status == napi_ok) && (valueType == napi_function),
                Status::INVALID_ARGUMENT, "Parameter error:parameter callback type must be function");
        }
        JsKVManager* proxy = reinterpret_cast<JsKVManager*>(ctxt->native);
        std::lock_guard<std::mutex> lck(proxy->deathMutex_);
        auto it = proxy->deathRecipient_.begin();
        while (it != proxy->deathRecipient_.end()) {
            // have 2 arguments :: have the [callback]
            if ((argc == 1) || JSUtil::Equals(env, argv[1], (*it)->GetCallback())) {
                proxy->kvDataManager_.UnRegisterKvStoreServiceDeathRecipient(*it);
                (*it)->Clear();
                it = proxy->deathRecipient_.erase(it);
            } else {
                ++it;
            }
        }
        ZLOGD("off mapsize: %{public}d", static_cast<int>(proxy->deathRecipient_.size()));
    };
    ctxt->GetCbInfoSync(env, info, input);
    if (ctxt->status != napi_ok) {
        ThrowNapiError(env, Status::INVALID_ARGUMENT, "Parameter error:params must be sting or function");
    }
    ZLOGD("KVManager::Off callback is not register or already unregister!");
    return nullptr;
}

napi_value JsKVManager::Constructor(napi_env env)
{
    auto lambda = []() -> std::vector<napi_property_descriptor> {
        std::vector<napi_property_descriptor> properties = {
            DECLARE_NAPI_FUNCTION("getKVStore", JsKVManager::GetKVStore),
            DECLARE_NAPI_FUNCTION("closeKVStore", JsKVManager::CloseKVStore),
            DECLARE_NAPI_FUNCTION("deleteKVStore", JsKVManager::DeleteKVStore),
            DECLARE_NAPI_FUNCTION("getAllKVStoreId", JsKVManager::GetAllKVStoreId),
            DECLARE_NAPI_FUNCTION("on", JsKVManager::On),
            DECLARE_NAPI_FUNCTION("off", JsKVManager::Off),
        };
        return properties;
    };
    return JSUtil::DefineClass(env, "ohos.data.distributedKVStore", "JsKVManager", lambda, JsKVManager::New);
}

napi_value JsKVManager::New(napi_env env, napi_callback_info info)
{
    std::string bundleName;
    ContextParam param;
    auto ctxt = std::make_shared<ContextBase>();
    auto input = [env, ctxt, &bundleName, &param](size_t argc, napi_value* argv) {
        // required 1 arguments :: <bundleName>
        ASSERT_BUSINESS_ERR(ctxt, argc >= 1, Status::INVALID_ARGUMENT,
            "Parameter error:Mandatory parameters are left unspecified");
        ctxt->status = JSUtil::GetNamedProperty(env, argv[0], "bundleName", bundleName);
        ASSERT_BUSINESS_ERR(ctxt, ctxt->status != napi_generic_failure, Status::INVALID_ARGUMENT,
            "Parameter error:The bundleName parameter is missing.");
        ASSERT_BUSINESS_ERR(ctxt, !bundleName.empty(), Status::INVALID_ARGUMENT,
            "Parameter error:The bundleName field cannot be empty.");

        napi_value jsContext = nullptr;
        JSUtil::GetNamedProperty(env, argv[0], "context", jsContext);
        ctxt->status = JSUtil::GetValue(env, jsContext, param);
        ASSERT_BUSINESS_ERR(ctxt, ctxt->status == napi_ok, Status::INVALID_ARGUMENT,
            "Parameter error:get context failed");
    };
    ctxt->GetCbInfoSync(env, info, input);
    ASSERT_NULL(!ctxt->isThrowError, "JsKVManager New exit");

    JsKVManager* kvManager = new (std::nothrow) JsKVManager(bundleName, env, param);
    ASSERT_ERR(env, kvManager != nullptr, Status::INVALID_ARGUMENT, "Parameter error:kvManager is nullptr");

    auto finalize = [](napi_env env, void* data, void* hint) {
        ZLOGD("kvManager finalize.");
        auto* kvManager = reinterpret_cast<JsKVManager*>(data);
        ASSERT_VOID(kvManager != nullptr, "kvManager is null!");
        delete kvManager;
    };
    ASSERT_CALL(env, napi_wrap(env, ctxt->self, kvManager, finalize, nullptr, nullptr), kvManager);
    return ctxt->self;
}

void JsKVManager::DeathRecipient::OnRemoteDied()
{
    AsyncCall();
}
} // namespace OHOS::DistributedKVStore