Skip to content

fix: add serial comparison in DConfigCacheImpl::setValue #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deepin-wm wants to merge 1 commit into
base: master
Choose a base branch
from
+112 −5
Open

fix: add serial comparison in DConfigCacheImpl::setValue #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/dconfigfile.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2021 - 2023 UnionTech Software Technology Co., Ltd.
// SPDX-FileCopyrightText: 2021 - 2026 UnionTech Software Technology Co., Ltd.
//
// SPDX-License-Identifier: LGPL-3.0-or-later

Expand Down Expand Up @@ -985,7 +985,7 @@ DConfigMetaImpl::~DConfigMetaImpl()
\a value Configuration name
\a uid User Id at setup time
\a callerAppid Application id at setup time
@return A value of true indicates that the new value has been reset, and false indicates that it has not been set
@return true if the cache was updated (value or serial changed), false if no update was needed
*/

/*!
Expand Down Expand Up @@ -1124,7 +1124,7 @@ class Q_DECL_HIDDEN DConfigCacheImpl : public DConfigCache {
}
bool setValue(const QString &key, const QVariant &value, const int serial, const uint uid, const QString &appid) override
{
if (values.value(key) == value) {
if (values.value(key) == value && DConfigInfo::checkSerial(values.serial(key), serial)) {
return false;
}
values.setValue(key, value);
Expand Down Expand Up @@ -1487,7 +1487,7 @@ QVariant DConfigFile::cacheValue(DConfigCache *userCache, const QString &key) co
\a value The value to set
\a userCache Specific user cache at setup time
\a appid Application id at setup time
@return A value of true indicates that the new value has been reset, and false indicates that it has not been set
@return true if the cache was updated (value or serial changed), false if no update was needed
*/
bool DConfigFile::setValue(const QString &key, const QVariant &value, const QString &callerAppid, DConfigCache *userCache)
{
Expand Down
2 changes: 2 additions & 0 deletions tests/data.qrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
<file>data/LGPLv3.txt</file>
<file>data/example-license.json</file>
<file>data/dconf-example.override.noexistitem.json</file>
<file>data/dconf-serial-test.meta.json</file>
<file>data/dconf-serial-test.override.json</file>
<file>data/dconfig2cpp/basic-types.meta.json</file>
<file>data/dconfig2cpp/numeric-types.meta.json</file>
<file>data/dconfig2cpp/complex-types.meta.json</file>
Expand Down
14 changes: 14 additions & 0 deletions tests/data/dconf-serial-test.meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"magic": "dsg.config.meta",
"version": "1.0",
"contents": {
"testKey": {
"value": "initial",
"serial": 0,
"flags": [],
"name": "test key for serial comparison",
"permissions": "readwrite",
"visibility": "private"
}
}
}
10 changes: 10 additions & 0 deletions tests/data/dconf-serial-test.override.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"magic": "dsg.config.override",
"version": "1.0",
"contents": {
"testKey": {
"value": "initial",
"serial": 1
}
}
}
83 changes: 82 additions & 1 deletion tests/ut_dconfigfile.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// SPDX-FileCopyrightText: 2021 - 2023 UnionTech Software Technology Co., Ltd.
// SPDX-FileCopyrightText: 2021 - 2026 UnionTech Software Technology Co., Ltd.
//
// SPDX-License-Identifier: LGPL-3.0-or-later

Expand Down Expand Up @@ -506,6 +506,87 @@ TEST_F(ut_DConfigFile, userPublic) {
}
}

TEST_F(ut_DConfigFile, setValueWithSerialComparison) {
// 测试 DConfigCacheImpl::setValue 中的 serial 比较逻辑
// 当值相同但 serial 不同时，应该返回 true（更新缓存）

FileCopyGuard guard(":/data/dconf-serial-test.meta.json", QString("%1/%2.json").arg(metaPath, FILE_NAME));

// 场景1: 值和 serial 都相同 → 返回 false
{
DConfigFile config(APP_ID, FILE_NAME);
ASSERT_TRUE(config.load(LocalPrefix));
QScopedPointer<DConfigCache> userCache(config.createUserCache(uid));
ASSERT_TRUE(userCache->load(LocalPrefix));

// 首次设置值，serial=0 从 meta 传入
ASSERT_TRUE(config.setValue("testKey", "test_value", "test", userCache.get()));

// 再次设置相同的值，serial 相同 → 返回 false
ASSERT_FALSE(config.setValue("testKey", "test_value", "test", userCache.get()));
}

// 场景2: 值相同，serial 不同 → 返回 true（新修复的场景）
{
DConfigFile config(APP_ID, FILE_NAME);
ASSERT_TRUE(config.load(LocalPrefix));
QScopedPointer<DConfigCache> userCache(config.createUserCache(uid));
ASSERT_TRUE(userCache->load(LocalPrefix));

// 设置值，缓存中 serial=0
ASSERT_TRUE(config.setValue("testKey", "test_value", "test", userCache.get()));

// 使用 override 文件将 serial 升级到 1
FileCopyGuard guard2(":/data/dconf-serial-test.override.json", QString("%1/%2.json").arg(overridePath, FILE_NAME));

// 重新加载配置，此时 meta serial=1
DConfigFile config2(APP_ID, FILE_NAME);
ASSERT_TRUE(config2.load(LocalPrefix));
QScopedPointer<DConfigCache> userCache2(config2.createUserCache(uid));
ASSERT_TRUE(userCache2->load(LocalPrefix));

// 设置相同的值，但 meta serial=1, cache serial=0 → 应该返回 true
ASSERT_TRUE(config2.setValue("testKey", "test_value", "test", userCache2.get()));
}

// 场景3: 值不同，serial 相同 → 返回 true
{
DConfigFile config(APP_ID, FILE_NAME);
ASSERT_TRUE(config.load(LocalPrefix));
QScopedPointer<DConfigCache> userCache(config.createUserCache(uid));
ASSERT_TRUE(userCache->load(LocalPrefix));

// 设置初始值
ASSERT_TRUE(config.setValue("testKey", "value1", "test", userCache.get()));

// 设置不同的值，serial 相同 → 返回 true
ASSERT_TRUE(config.setValue("testKey", "value2", "test", userCache.get()));
}

// 场景4: 值不同，serial 不同 → 返回 true
{
DConfigFile config(APP_ID, FILE_NAME);
ASSERT_TRUE(config.load(LocalPrefix));
QScopedPointer<DConfigCache> userCache(config.createUserCache(uid));
ASSERT_TRUE(userCache->load(LocalPrefix));

// 设置初始值
ASSERT_TRUE(config.setValue("testKey", "value1", "test", userCache.get()));

// 使用 override 文件将 serial 升级到 1
FileCopyGuard guard2(":/data/dconf-serial-test.override.json", QString("%1/%2.json").arg(overridePath, FILE_NAME));

// 重新加载配置
DConfigFile config2(APP_ID, FILE_NAME);
ASSERT_TRUE(config2.load(LocalPrefix));
QScopedPointer<DConfigCache> userCache2(config2.createUserCache(uid));
ASSERT_TRUE(userCache2->load(LocalPrefix));

// 设置不同的值，serial 也不同 → 返回 true
ASSERT_TRUE(config2.setValue("testKey", "value3", "test", userCache2.get()));
}
}

class ut_DConfigFileCheckName : public ut_DConfigFile, public ::testing::WithParamInterface<std::tuple<QString, bool>>
{

Expand Down
Loading