persist.test.ts 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. import { beforeAll, beforeEach, describe, expect, mock, test } from "bun:test"
  2. type PersistTestingType = typeof import("./persist").PersistTesting
  3. type PersistType = typeof import("./persist").Persist
  4. type RemovePersistedType = typeof import("./persist").removePersisted
  5. class MemoryStorage implements Storage {
  6. private values = new Map<string, string>()
  7. readonly events: string[] = []
  8. readonly calls = { get: 0, set: 0, remove: 0 }
  9. clear() {
  10. this.values.clear()
  11. }
  12. get length() {
  13. return this.values.size
  14. }
  15. key(index: number) {
  16. return Array.from(this.values.keys())[index] ?? null
  17. }
  18. getItem(key: string) {
  19. this.calls.get += 1
  20. this.events.push(`get:${key}`)
  21. if (key.startsWith("opencode.throw")) throw new Error("storage get failed")
  22. return this.values.get(key) ?? null
  23. }
  24. setItem(key: string, value: string) {
  25. this.calls.set += 1
  26. this.events.push(`set:${key}`)
  27. if (key.startsWith("opencode.quota")) throw new DOMException("quota", "QuotaExceededError")
  28. if (key.startsWith("opencode.throw")) throw new Error("storage set failed")
  29. this.values.set(key, value)
  30. }
  31. removeItem(key: string) {
  32. this.calls.remove += 1
  33. this.events.push(`remove:${key}`)
  34. if (key.startsWith("opencode.throw")) throw new Error("storage remove failed")
  35. this.values.delete(key)
  36. }
  37. }
  38. const storage = new MemoryStorage()
  39. let persistTesting: PersistTestingType
  40. let Persist: PersistType
  41. let removePersisted: RemovePersistedType
  42. beforeAll(async () => {
  43. mock.module("@/context/platform", () => ({
  44. usePlatform: () => ({ platform: "web" }),
  45. }))
  46. const mod = await import("./persist")
  47. persistTesting = mod.PersistTesting
  48. Persist = mod.Persist
  49. removePersisted = mod.removePersisted
  50. })
  51. beforeEach(() => {
  52. storage.clear()
  53. storage.events.length = 0
  54. storage.calls.get = 0
  55. storage.calls.set = 0
  56. storage.calls.remove = 0
  57. Object.defineProperty(globalThis, "localStorage", {
  58. value: storage,
  59. configurable: true,
  60. })
  61. })
  62. describe("persist localStorage resilience", () => {
  63. test("does not cache values as persisted when quota write and eviction fail", () => {
  64. const storageApi = persistTesting.localStorageWithPrefix("opencode.quota.scope")
  65. storageApi.setItem("value", '{"value":1}')
  66. expect(storage.getItem("opencode.quota.scope:value")).toBeNull()
  67. expect(storageApi.getItem("value")).toBeNull()
  68. })
  69. test("disables only the failing scope when storage throws", () => {
  70. const bad = persistTesting.localStorageWithPrefix("opencode.throw.scope")
  71. bad.setItem("value", '{"value":1}')
  72. const before = storage.calls.set
  73. bad.setItem("value", '{"value":2}')
  74. expect(storage.calls.set).toBe(before)
  75. expect(bad.getItem("value")).toBeNull()
  76. const healthy = persistTesting.localStorageWithPrefix("opencode.safe.scope")
  77. healthy.setItem("value", '{"value":3}')
  78. expect(storage.getItem("opencode.safe.scope:value")).toBe('{"value":3}')
  79. })
  80. test("failing fallback scope does not poison direct storage scope", () => {
  81. const broken = persistTesting.localStorageWithPrefix("opencode.throw.scope2")
  82. broken.setItem("value", '{"value":1}')
  83. const direct = persistTesting.localStorageDirect()
  84. direct.setItem("direct-value", '{"value":5}')
  85. expect(storage.getItem("direct-value")).toBe('{"value":5}')
  86. })
  87. test("normalizer rejects malformed JSON payloads", () => {
  88. const result = persistTesting.normalize({ value: "ok" }, '{"value":"\\x"}')
  89. expect(result).toBeUndefined()
  90. })
  91. test("workspace storage sanitizes Windows filename characters", () => {
  92. const result = persistTesting.workspaceStorage("C:\\Users\\foo")
  93. expect(result).toStartWith("opencode.workspace.")
  94. expect(result.endsWith(".dat")).toBeTrue()
  95. expect(/[:\\/]/.test(result)).toBeFalse()
  96. })
  97. test("workspace target keeps raw path storage as legacy fallback", () => {
  98. const target = Persist.workspace("C:\\Users\\foo", "vcs")
  99. expect(target.storage).toBe(persistTesting.workspaceStorage("C:/Users/foo"))
  100. expect(target.legacyStorageNames).toEqual([persistTesting.workspaceStorage("C:\\Users\\foo")])
  101. })
  102. test("workspace target keeps backslash storage as fallback for normalized Windows paths", () => {
  103. const target = Persist.workspace("C:/Users/foo", "vcs")
  104. expect(target.storage).toBe(persistTesting.workspaceStorage("C:/Users/foo"))
  105. expect(target.legacyStorageNames).toEqual([persistTesting.workspaceStorage("C:\\Users\\foo")])
  106. })
  107. test("migrates direct legacy keys into scoped storage", () => {
  108. storage.setItem("legacy.workspace", '{"value":2}')
  109. const target = Persist.workspace("C:/Users/foo", "demo", ["legacy.workspace"])
  110. const current = persistTesting.localStorageWithPrefix(target.storage!)
  111. const legacyStore = persistTesting.localStorageDirect()
  112. const result = persistTesting.migrateLegacy({
  113. current,
  114. legacyStore,
  115. stores: [],
  116. keys: target.legacy!,
  117. key: target.key,
  118. defaults: { value: 1 },
  119. })
  120. expect(result).toBe('{"value":2}')
  121. expect(storage.getItem(`${target.storage}:${target.key}`)).toBe('{"value":2}')
  122. expect(legacyStore.getItem("legacy.workspace")).toBeNull()
  123. expect(storage.getItem("legacy.workspace")).toBeNull()
  124. })
  125. test("removes legacy workspace storage when removing persisted target", () => {
  126. const target = Persist.workspace("C:\\Users\\foo", "terminal")
  127. storage.setItem(`${target.storage}:${target.key}`, '{"value":1}')
  128. storage.setItem(`${target.legacyStorageNames![0]}:${target.key}`, '{"value":2}')
  129. removePersisted(target)
  130. expect(storage.getItem(`${target.storage}:${target.key}`)).toBeNull()
  131. expect(storage.getItem(`${target.legacyStorageNames![0]}:${target.key}`)).toBeNull()
  132. })
  133. })