fix: 修复双向同步schema数据时状态数据被复位的问题

Author: zhangfisher

packages/core/src/schema/manager.ts

@@ -62,7 +62,7 @@ export class SchemaManager<
 
 		this._descriptors[key] = finalDescriptor;
 
-		if (this.shadow && descriptor.value !== undefined) {
+		if (this.shadow && descriptor.value !== undefined && descriptor.flags !== -1) {
 			this.shadow.update(
 				(state) => {
 					setVal(state, pathKey, descriptor.value);

packages/core/src/schema/types/index.ts

@@ -258,6 +258,11 @@ export type SchemaDescriptor<Value = any, Options = Dict> = {
 	datatype: "string" | "number" | "boolean" | "object" | "array" | "any" | string;
 	value: Value;
 	options: SchemaOptions<Value, Options>;
+	/**
+	 * 用于传递额外的标识
+	 * 比如在进行syncer时，传入falgs==SYNC_INIT_FLAG
+	 */
+	flags?: number;
 };
 
 export interface SchemaDescriptorBuilder<Value = any, State = Dict> {

packages/syncer/src/__tests__/store.sync.test.ts

@@ -5,6 +5,7 @@ import { describe, expect, test } from "vitest";
 import { computed, AutoStore, configurable, ValidateError } from "../../../core/src";
 import "..";
 import { isFunction } from "../../../core/src/utils/isFunction";
+import { AutoStoreSyncer } from "..";
 
 describe("本地Store同步", () => {
 	test("一对一全同步", async () => {
@@ -1046,4 +1047,109 @@ describe("本地Store同步", () => {
 			});
 		});
 	});
+	test("模块配置同步模拟测试", async () => {
+		class SettingManager {
+			_dirtyValues: Record<string, any> = {};
+			store = new AutoStore(
+				{},
+				{
+					id: "settings",
+					resetable: true,
+				},
+			);
+
+			constructor(values: Record<string, any>) {
+				this.load(values);
+				// 侦听配置变化，并且在变化时进行保存
+				this.store.watch(({ path, value, flags }) => {
+					// 当从模块第一次同步更新到store时，flags<0
+					if (flags && flags < 0) return;
+					// 为什么是2? 因为path[0]是模块id，path[1]是配置项路径
+					if (path.length === 2) {
+						if (!this._dirtyValues[path[0]]) this._dirtyValues[path[0]] = {};
+						this._dirtyValues[path[0]][path[1]] = value;
+
+						this.save();
+					}
+				});
+			}
+			load(values: Record<string, any> = {}) {
+				this.store = new AutoStore(values, {
+					id: "settings",
+					resetable: true,
+				});
+			}
+			save() {}
+		}
+		const settingManager = new SettingManager({
+			shop: {
+				"order.price": 1000,
+			},
+		});
+		class ShopModule {
+			store = new AutoStore({
+				order: {
+					price: configurable(100),
+				},
+			});
+			syncer?: AutoStoreSyncer;
+			constructor() {
+				this.loadSettings();
+				this.sync();
+			}
+			sync() {
+				// 如果模块不是observable的，则不需要进行同步，同步是基于AutoStore的sync功能的
+				if (this.store.schemas.size === 0) {
+					return;
+				}
+
+				// 只有使用schema或configurable声明的配置项才会进行同步
+				const filter = (path: string[]) => {
+					return this.store.schemas.has(path.join(".") as any);
+				};
+				const moduleStore = this.store;
+				const syncSettings = {
+					filter,
+					remote: "shop",
+					immediate: true,
+					pathMap: {
+						toLocal: (path: any[], value: any) => {
+							if (typeof value !== "object") {
+								return path.reduce<string[]>((result: any[], cur: string) => {
+									result.push(...cur.split("."));
+									return result;
+								}, []);
+							}
+						},
+						toRemote(path: any[], value: any) {
+							// this.store.schemas.has(path)的作用
+							// 当同步configurable时，如果是数组或对象，也需要同步
+							if (typeof value !== "object" || moduleStore.schemas.has(path)) {
+								return [path.join(".")];
+							}
+						},
+					},
+				};
+				// 将本模块的配置项同步到全局SettingManager中，这样在应用中就可以使用SettingManager管理应用的所有配置了
+				this.syncer = this.store.sync(settingManager.store, syncSettings);
+			}
+			loadSettings() {
+				// @ts-expect-error
+				this.store.state.order.price = settingManager.store.state["shop"]["order.price"];
+			}
+		}
+
+		const order = new ShopModule();
+		expect(order.store.state.order.price).toBe(1000);
+		// @ts-expect-error
+		expect(settingManager.store.state["shop"]["order.price"]).toBe(1000);
+		order.store.state.order.price = 2000;
+		expect(order.store.state.order.price).toBe(2000);
+		// @ts-expect-error
+		expect(settingManager.store.state["shop"]["order.price"]).toBe(2000);
+
+		// @ts-expect-error
+		settingManager.store.state["shop"]["order.price"] = 3000;
+		expect(order.store.state.order.price).toBe(3000);
+	});
 });

packages/syncer/src/syncer.ts

@@ -13,7 +13,6 @@ import {
 	markRaw,
 } from "autostore";
 import type { AutoStoreSyncerOptions, StateRemoteOperate } from "./types";
-import { parseFunc } from "../../core/src/utils/parseFunc";
 import { markFunc } from "./utils/markFunc";
 
 type NormalizeAutoStoreSyncerOptions = Required<
@@ -457,6 +456,7 @@ export class AutoStoreSyncer {
 				datatype: schema.datatype,
 				value: schema.value,
 				options: schema,
+				flags: operate.flags,
 			});
 		});
 		this.store.schemas.build();