AI-native knowledge base & Evernote/Obsidian alternative with instant sync & native MCP. Free on Cloudflare or self-hosted via Docker.
HTML ai-agentcloudflarecloudflare-d1cloudflare-r2cloudflare-workersdockerelectronevernoteevernote-alternativeknowledge-basemcpnote-takingobsidian-alternativeoffline-firstpersonal-knowledge-basepwaself-hostedsqlitetiptapweb-clipper
fix(web): save every plugin setting when it changes
tianma-if37ac4be5ec87
diff --git a/apps/web/src/components/plugins/PluginSettingsSection.tsx b/apps/web/src/components/plugins/PluginSettingsSection.tsxindex 5aba1184..3f8204e5 100644--- a/apps/web/src/components/plugins/PluginSettingsSection.tsx+++ b/apps/web/src/components/plugins/PluginSettingsSection.tsx@@ -5,8 +5,8 @@ import type { PluginManifest, PluginSettingField, PluginSettingValue } from "@edimport type { EdgeEverPluginHost } from "@/lib/plugins/plugin-host";import {createPluginSettingWriteQueue,+ planPluginSettingWrite,pluginSettingLoadSignature,- revertBooleanSettingAfterFailedWrite,} from "./plugin-settings-commit";import { Button } from "@/components/ui/button";import { Card } from "@/components/ui/card";@@ -73,6 +73,7 @@ const PluginSettingFieldRow = ({disabled,field,inputId,+ onBlur,onChange,value,}: {@@ -81,6 +82,7 @@ const PluginSettingFieldRow = ({disabled: boolean;field: PluginSettingField;inputId: string;+ onBlur?: () => void;onChange: (value: PluginSettingValue | "") => void;value: PluginSettingValue | "";}) => {@@ -141,6 +143,7 @@ const PluginSettingFieldRow = ({min={field.type === "number" ? field.min : undefined}max={field.type === "number" ? field.max : undefined}step={field.type === "number" ? field.step ?? "any" : undefined}+ onBlur={onBlur}onChange={(event) => onChange(field.type === "number" && event.target.value !== "" ? Number(event.target.value) : event.target.value,)}@@ -172,20 +175,24 @@ export const PluginSettingsSection = ({ host, manifest }: { host: EdgeEverPluginconst fieldsRef = useRef(fields);fieldsRef.current = fields;const settingWrites = useRef(createPluginSettingWriteQueue()).current;+ const valuesRef = useRef<Record<string, PluginSettingValue | "">>({});+ const committedRef = useRef<Record<string, PluginSettingValue | "">>({});+ const revisionRef = useRef<Record<string, number>>({});+ const loadedRef = useRef(false);const [values, setValues] = useState<Record<string, PluginSettingValue | "">>({});const [configuredSecrets, setConfiguredSecrets] = useState<Record<string, boolean>>({});const [loading, setLoading] = useState(fields.length > 0);- const [saving, setSaving] = useState(false);- const [message, setMessage] = useState<string | null>(null);const [error, setError] = useState<string | null>(null);const [loadError, setLoadError] = useState<string | null>(null);const [loadAttempt, setLoadAttempt] = useState(0);+ valuesRef.current = values;useEffect(() => {let active = true;const currentFields = fieldsRef.current;+ const started = { ...revisionRef.current };+ loadedRef.current = false;setLoading(currentFields.length > 0);- setMessage(null);setError(null);setLoadError(null);void Promise.all(currentFields.map(async (field) => {@@ -193,8 +200,17 @@ export const PluginSettingsSection = ({ host, manifest }: { host: EdgeEverPluginreturn { key: field.key, value: await host.getSettingValue(manifest.id, field.key) ?? "", configured: false };})).then((loaded) => {if (!active) return;- setValues(Object.fromEntries(loaded.map((item) => [item.key, item.value])));+ setValues((current) => {+ const next = { ...current };+ for (const item of loaded) {+ if ((revisionRef.current[item.key] ?? 0) !== (started[item.key] ?? 0)) continue;+ next[item.key] = item.value;+ committedRef.current[item.key] = item.value;+ }+ return next;+ });setConfiguredSecrets(Object.fromEntries(loaded.map((item) => [item.key, item.configured])));+ loadedRef.current = true;setLoading(false);}).catch((error) => {if (!active) return;@@ -204,64 +220,84 @@ export const PluginSettingsSection = ({ host, manifest }: { host: EdgeEverPluginreturn () => { active = false; };}, [host, manifest.id, manifest.version, fieldLoadSignature, loadAttempt]);+ const flushSettings = () => {+ if (!loadedRef.current) return;+ for (const field of fieldsRef.current) {+ if ((revisionRef.current[field.key] ?? 0) === 0) continue;+ const plan = planPluginSettingWrite(field, valuesRef.current[field.key] ?? "");+ if (plan.action === "set") void host.setSettingValue(manifest.id, field.key, plan.value);+ else if (plan.action === "remove") void host.removeSettingValue(manifest.id, field.key);+ }+ };+ const flushRef = useRef(flushSettings);+ flushRef.current = flushSettings;++ useEffect(() => {+ const flush = () => flushRef.current();+ window.addEventListener("pagehide", flush);+ const stopHibernatePrepare = window.edgeeverDesktop?.onHibernatePrepare?.(flush);+ return () => {+ window.removeEventListener("pagehide", flush);+ stopHibernatePrepare?.();+ flush();+ };+ }, [host, manifest.id]);+if (fields.length === 0) return null;- const clearFeedback = () => {- setMessage(null);- setError(null);- };+ const settingError = (field: PluginSettingField, reason: "required" | "invalid") =>+ reason === "required"+ ? t("plugins.settings.required", { name: field.label })+ : t("plugins.settings.invalid", { name: field.label });- const persistBooleanSetting = (key: string, value: boolean) => {- void settingWrites.enqueue(key, async () => {+ const persistSetting = (field: PluginSettingField, value: PluginSettingValue | "") => {+ const plan = planPluginSettingWrite(field, value);+ if (plan.action === "keep") {+ if (plan.error) setError(settingError(field, plan.error));+ return;+ }+ const seen = revisionRef.current[field.key] ?? 0;+ void settingWrites.enqueue(field.key, async () => {try {- await host.setSettingValue(manifest.id, key, value);+ if (plan.action === "set") await host.setSettingValue(manifest.id, field.key, plan.value);+ else await host.removeSettingValue(manifest.id, field.key);+ if ((revisionRef.current[field.key] ?? 0) !== seen) return;+ committedRef.current[field.key] = plan.action === "set" ? plan.value : "";+ if (field.type === "secret") setConfiguredSecrets((current) => ({ ...current, [field.key]: true }));} catch (writeError) {- setValues((current) => ({- ...current,- [key]: revertBooleanSettingAfterFailedWrite(current[key] ?? "", value),- }));+ if ((revisionRef.current[field.key] ?? 0) !== seen) return;+ if (field.type === "boolean" || field.type === "select") {+ setValues((current) => current[field.key] === value+ ? { ...current, [field.key]: committedRef.current[field.key] ?? "" }+ : current);+ }setError(writeError instanceof Error ? writeError.message : String(writeError));}});};- const save = async () => {- setSaving(true);- setMessage(null);+ const changeSetting = (field: PluginSettingField, value: PluginSettingValue | "") => {+ revisionRef.current[field.key] = (revisionRef.current[field.key] ?? 0) + 1;+ valuesRef.current = { ...valuesRef.current, [field.key]: value };setError(null);- try {- // Check every required field before writing any values.- for (const field of fields) {- const value = values[field.key];- if (field.type === "secret" && value === "" && configuredSecrets[field.key]) continue;- if (field.required && (value == null || (typeof value === "string" && !value.trim()))) {- throw new Error(t("plugins.settings.required", { name: field.label }));- }- }- for (const field of fields) {- const value = values[field.key];- if (field.type === "secret" && value === "") {- continue;- }- if (value === "") {- await host.removeSettingValue(manifest.id, field.key);- continue;- }- if (typeof value === "boolean") {- await settingWrites.enqueue(field.key, () => host.setSettingValue(manifest.id, field.key, value));- continue;- }- await host.setSettingValue(manifest.id, field.key, value);- if (field.type === "secret") {- setConfiguredSecrets((current) => ({ ...current, [field.key]: true }));- setValues((current) => ({ ...current, [field.key]: "" }));- }- }- setMessage(t("plugins.settings.saved"));- } catch (error) {- setError(error instanceof Error ? error.message : String(error));- } finally {- setSaving(false);+ setValues((current) => ({ ...current, [field.key]: value }));+ persistSetting(field, value);+ };++ const settleSetting = (field: PluginSettingField) => {+ const value = valuesRef.current[field.key] ?? "";+ const plan = planPluginSettingWrite(field, value);+ if (field.type === "secret") {+ if (plan.action !== "set") return;+ valuesRef.current = { ...valuesRef.current, [field.key]: "" };+ setValues((current) => current[field.key] === value ? { ...current, [field.key]: "" } : current);+ return;+ }+ if (plan.action === "keep") {+ const restored = committedRef.current[field.key] ?? "";+ valuesRef.current = { ...valuesRef.current, [field.key]: restored };+ setValues((current) => ({ ...current, [field.key]: restored }));+ setError(null);}};@@ -276,55 +312,44 @@ export const PluginSettingsSection = ({ host, manifest }: { host: EdgeEverPlugin<Button size="sm" variant="outline" onClick={() => setLoadAttempt((attempt) => attempt + 1)}>{t("plugins.settings.retry")}</Button></div>) : (- <form onChange={clearFeedback} onSubmit={(event) => { event.preventDefault(); void save(); }}>- <fieldset disabled={saving} className="min-w-0">- <div className="py-5">- {fieldGroups.map((group, groupIndex) => {- const rows = group.fields.map((field) => {- const value = values[field.key] ?? "";- const inputId = `${formId}-${field.key}`;- return (- <PluginSettingFieldRow- key={field.key}- compact={group.compact}- configuredSecret={Boolean(configuredSecrets[field.key])}- disabled={saving}- field={field}- inputId={inputId}- value={value}- onChange={(nextValue) => {- clearFeedback();- setValues((current) => ({ ...current, [field.key]: nextValue }));- if (field.type === "boolean" && typeof nextValue === "boolean") {- persistBooleanSetting(field.key, nextValue);- }- }}- />- );- });- return group.compact ? (- <div- key={group.id}- className={`grid gap-3 sm:grid-cols-2 xl:grid-cols-3 2xl:grid-cols-4${groupIndex > 0 ? " mt-5" : ""}`}- >- {rows}- </div>- ) : (- <Card- key={group.id}- className={`${groupIndex > 0 ? "mt-5 " : ""}divide-y divide-slate-100 overflow-hidden shadow-none`}- >- {rows}- </Card>+ <form onSubmit={(event) => event.preventDefault()}>+ <div className="py-5">+ {fieldGroups.map((group, groupIndex) => {+ const rows = group.fields.map((field) => {+ const value = values[field.key] ?? "";+ const inputId = `${formId}-${field.key}`;+ return (+ <PluginSettingFieldRow+ key={field.key}+ compact={group.compact}+ configuredSecret={Boolean(configuredSecrets[field.key])}+ disabled={false}+ field={field}+ inputId={inputId}+ value={value}+ onBlur={field.type === "boolean" || field.type === "select" ? undefined : () => settleSetting(field)}+ onChange={(nextValue) => changeSetting(field, nextValue)}+ />);- })}- </div>- <div className="flex min-h-14 flex-wrap items-center justify-end gap-3 border-t border-slate-200 pt-4">- {message ? <span className="mr-auto text-sm text-emerald-700" role="status">{message}</span> : null}- {error ? <p className="mr-auto text-sm text-rose-700" role="alert">{t("plugins.settings.saveFailed", { message: error })}</p> : null}- <Button type="submit" size="sm" disabled={saving}>{saving ? t("common.saving") : t("common.save")}</Button>- </div>- </fieldset>+ });+ return group.compact ? (+ <div+ key={group.id}+ className={`grid gap-3 sm:grid-cols-2 xl:grid-cols-3 2xl:grid-cols-4${groupIndex > 0 ? " mt-5" : ""}`}+ >+ {rows}+ </div>+ ) : (+ <Card+ key={group.id}+ className={`${groupIndex > 0 ? "mt-5 " : ""}divide-y divide-slate-100 overflow-hidden shadow-none`}+ >+ {rows}+ </Card>+ );+ })}+ </div>+ {error ? <p className="border-t border-slate-200 pt-4 text-sm text-rose-700" role="alert">{t("plugins.settings.saveFailed", { message: error })}</p> : null}</form>)}</section>diff --git a/apps/web/src/components/plugins/plugin-settings-commit.test.mjs b/apps/web/src/components/plugins/plugin-settings-commit.test.mjsindex 23f0220e..bfbcf7b0 100644--- a/apps/web/src/components/plugins/plugin-settings-commit.test.mjs+++ b/apps/web/src/components/plugins/plugin-settings-commit.test.mjs@@ -1,6 +1,7 @@import { describe, expect, test } from "bun:test";import {createPluginSettingWriteQueue,+ planPluginSettingWrite,pluginSettingLoadSignature,revertBooleanSettingAfterFailedWrite,} from "./plugin-settings-commit.ts";@@ -56,6 +57,29 @@ describe("plugin setting commits", () => {expect(revertBooleanSettingAfterFailedWrite(true, false)).toBe(true);});+ test("stores every finished plugin setting and holds incomplete values", () => {+ const expectPlan = (field, value) => planPluginSettingWrite(field, value);+ expect(expectPlan({ type: "boolean", key: "digest.auto-enabled", label: "Digest" }, true)).toEqual({ action: "set", value: true });+ expect(expectPlan({ type: "boolean", key: "digest.auto-enabled", label: "Digest" }, false)).toEqual({ action: "set", value: false });+ expect(expectPlan({+ type: "select", key: "digest.generation-time", label: "Time", required: true, options: [{ value: "09:00", label: "09:00" }],+ }, "09:00")).toEqual({ action: "set", value: "09:00" });+ expect(expectPlan({+ type: "select", key: "digest.generation-time", label: "Time", required: true, options: [{ value: "09:00", label: "09:00" }],+ }, "")).toEqual({ action: "keep", error: "required" });+ expect(expectPlan({+ type: "select", key: "optional", label: "Optional", options: [{ value: "a", label: "A" }],+ }, "")).toEqual({ action: "remove" });+ expect(expectPlan({ type: "number", key: "digest.window-hours", label: "Hours", min: 1, max: 168 }, 12)).toEqual({ action: "set", value: 12 });+ expect(expectPlan({ type: "number", key: "digest.window-hours", label: "Hours", min: 1, max: 168 }, "")).toEqual({ action: "keep", error: null });+ expect(expectPlan({ type: "number", key: "digest.window-hours", label: "Hours", min: 1, max: 168 }, 200)).toEqual({ action: "keep", error: "invalid" });+ expect(expectPlan({ type: "text", key: "note", label: "Note" }, "hello")).toEqual({ action: "set", value: "hello" });+ expect(expectPlan({ type: "text", key: "note", label: "Note" }, "")).toEqual({ action: "remove" });+ expect(expectPlan({ type: "text", key: "note", label: "Note", required: true }, " ")).toEqual({ action: "keep", error: "required" });+ expect(expectPlan({ type: "secret", key: "token", label: "Token" }, "")).toEqual({ action: "keep", error: null });+ expect(expectPlan({ type: "secret", key: "token", label: "Token" }, "secret")).toEqual({ action: "set", value: "secret" });+ });+test("reloads stored values when fields change, not when the manifest object is copied", () => {const fields = [{ key: "digest.auto-enabled", type: "boolean", default: false },diff --git a/apps/web/src/components/plugins/plugin-settings-commit.ts b/apps/web/src/components/plugins/plugin-settings-commit.tsindex 1dfe2989..149c9977 100644--- a/apps/web/src/components/plugins/plugin-settings-commit.ts+++ b/apps/web/src/components/plugins/plugin-settings-commit.ts@@ -1,8 +1,43 @@-import type { PluginSettingValue } from "@edgeever/plugin-api";+import type { PluginSettingField, PluginSettingValue } from "@edgeever/plugin-api";export const pluginSettingLoadSignature = (fields: readonly { key: string; type: string; default?: unknown }[]) =>fields.map((field) => `${field.key}\0${field.type}\0${JSON.stringify(field.default ?? null)}`).join("\n");+export type PluginSettingWritePlan =+ | { action: "set"; value: PluginSettingValue }+ | { action: "remove" }+ | { action: "keep"; error: "required" | "invalid" | null };++/** Decide what must be stored for the value currently shown in one setting control. */+export const planPluginSettingWrite = (+ field: PluginSettingField,+ value: PluginSettingValue | "",+): PluginSettingWritePlan => {+ if (field.type === "secret") {+ return typeof value === "string" && value !== "" ? { action: "set", value } : { action: "keep", error: null };+ }+ if (field.type === "boolean") {+ return typeof value === "boolean" ? { action: "set", value } : { action: "keep", error: "invalid" };+ }+ if (field.type === "number") {+ if (value === "") return { action: "keep", error: null };+ if (typeof value !== "number" || !Number.isFinite(value)) return { action: "keep", error: "invalid" };+ if (field.min !== undefined && value < field.min) return { action: "keep", error: "invalid" };+ if (field.max !== undefined && value > field.max) return { action: "keep", error: "invalid" };+ return { action: "set", value };+ }+ if (field.type === "select") {+ if (value === "") return field.required ? { action: "keep", error: "required" } : { action: "remove" };+ if (typeof value !== "string" || !field.options.some((option) => option.value === value)) {+ return { action: "keep", error: "invalid" };+ }+ return { action: "set", value };+ }+ if (typeof value !== "string") return { action: "keep", error: "invalid" };+ if (!value.trim()) return field.required ? { action: "keep", error: "required" } : { action: "remove" };+ return { action: "set", value };+};+export const revertBooleanSettingAfterFailedWrite = (current: PluginSettingValue | "",attempted: boolean,diff --git a/packages/shared/src/i18n/en-US.ts b/packages/shared/src/i18n/en-US.tsindex 277cff0a..5f49254b 100644--- a/packages/shared/src/i18n/en-US.ts+++ b/packages/shared/src/i18n/en-US.ts@@ -902,6 +902,7 @@ export const enUS = {saveFailed: "Saving did not complete. Check your settings and try again: {{message}}",saved: "Settings saved on this device.",required: "{{name}} is required.",+ invalid: "{{name}} cannot be saved yet.",secretConfigured: "Configured — leave blank to keep unchanged",none: "None",viewList: "View list",diff --git a/packages/shared/src/i18n/ja.ts b/packages/shared/src/i18n/ja.tsindex fc4de57b..b447ecd3 100644--- a/packages/shared/src/i18n/ja.ts+++ b/packages/shared/src/i18n/ja.ts@@ -902,6 +902,7 @@ export const ja = {saveFailed: "保存が完了しませんでした。設定を確認して再試行してください:{{message}}",saved: "設定をこの端末に保存しました。",required: "{{name}} は必須です。",+ invalid: "{{name}} はまだ保存できません。",secretConfigured: "設定済み — 空欄のままなら変更しません",none: "なし",viewList: "一覧を見る",diff --git a/packages/shared/src/i18n/zh-CN.ts b/packages/shared/src/i18n/zh-CN.tsindex 7da60b32..b07b505f 100644--- a/packages/shared/src/i18n/zh-CN.ts+++ b/packages/shared/src/i18n/zh-CN.ts@@ -902,6 +902,7 @@ export const zhCN = {saveFailed: "保存未完成,请检查并重试:{{message}}",saved: "设置已保存到当前设备。",required: "{{name}} 为必填项。",+ invalid: "{{name}} 的当前值还不能保存。",secretConfigured: "已配置,留空表示保持不变",none: "无",viewList: "查看列表",