Passthrough settings so downgrading Dyad doesn't cause issues (#2183)

 > [!NOTE] > **Behavior change: preserve unknown settings fields** > > - Apply `.passthrough()` to `UserSettingsSchema` so unknown properties are retained instead of stripped > - Update `readSettings.test.ts` to assert extra fields (e.g., `unknownField`, `deprecatedSetting`, nested objects) are preserved while defaults still apply > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit d7bd0311a14cb4b501c698c987706efe069ab975. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>   ## Summary by cubic Preserves unknown settings fields during validation to prevent data loss when downgrading Dyad. Switches the user settings schema to passthrough and updates tests to match. - **Bug Fixes** - UserSettingsSchema now uses Zod .passthrough() to keep unrecognized fields. - Updated readSettings test to assert extra fields are preserved. <sup>Written for commit d7bd0311a14cb4b501c698c987706efe069ab975. Summary will update on new commits.</sup>

Passthrough settings so downgrading Dyad doesn't cause issues (#2183)
0a286015 · Will Chen · GitHub · 25ddf69d · 0a286015 · 0a286015
--- a/src/__tests__/readSettings.test.ts
+++ b/src/__tests__/readSettings.test.ts
@@ -248,7 +248,7 @@ describe("readSettings", () => {
      );
    });
-    it("should strip extra fields not recognized by the schema", () => {
+    it("should preserve extra fields not recognized by the schema", () => {
      const mockFileContent = {
        selectedModel: {
          name: "gpt-4",
@@ -256,8 +256,8 @@ describe("readSettings", () => {
        },
        telemetryConsent: "opted_in",
        hasRunBefore: true,
-        // Extra fields that are not in the schema
+        // Extra fields that are not in the schema (should be preserved)
-        unknownField: "should be removed",
+        unknownField: "should be preserved",
        deprecatedSetting: true,
        extraConfig: {
          someValue: 123,
@@ -281,10 +281,15 @@ describe("readSettings", () => {
      expect(result.telemetryConsent).toBe("opted_in");
      expect(result.hasRunBefore).toBe(true);
-      // Extra fields should be stripped by schema validation
+      // Extra fields should be preserved by passthrough()
-      expect(result).not.toHaveProperty("unknownField");
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      expect(result).not.toHaveProperty("deprecatedSetting");
+      const resultAny = result as any;
-      expect(result).not.toHaveProperty("extraConfig");
+      expect(resultAny.unknownField).toBe("should be preserved");
+      expect(resultAny.deprecatedSetting).toBe(true);
+      expect(resultAny.extraConfig).toEqual({
+        someValue: 123,
+        anotherValue: "test",
+      });
      // Should still have defaults for missing properties
      expect(result.enableAutoUpdate).toBe(true);

--- a/src/lib/schemas.ts
+++ b/src/lib/schemas.ts
@@ -248,7 +248,8 @@ export type AgentToolConsent = z.infer<typeof AgentToolConsentSchema>;
 /**
 * Zod schema for user settings
 */
-export const UserSettingsSchema = z.object({
+export const UserSettingsSchema = z
+  .object({
    ////////////////////////////////
    // E2E TESTING ONLY.
    ////////////////////////////////
@@ -311,7 +312,10 @@ export const UserSettingsSchema = z.object({
      })
      .optional(),
    hideLocalAgentNewChatToast: z.boolean().optional(),
-});
+  })
+  // Allow unknown properties to pass through (e.g. future settings
+  // that should be preserved if user downgrades to an older version)
+  .passthrough();
 /**
 * Type derived from the UserSettingsSchema