Repository navigation
perf(mobile): halve the native storage calls behind each preference save #28791
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.
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
Closed
+214
−16
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
bc48fe7
perf(mobile): skip the storage reload before each preference save
only21mil 2225784
test(mobile): give each storage test case a fresh preferences store
only21mil cad372c
fix(mobile): keep preference writes serialized through cancellation
only21mil 2705d18
Merge remote-tracking branch 'github/main' into fix/audit-m201
maria-rcks d263211
fix(mobile): use Effect.succeedNone in preference store test
maria-rcks eff4935
Merge branch 'main' into fix/audit-m201
only21mil File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| import { describe, expect, it } from "@effect/vitest"; | ||
| import * as Effect from "effect/Effect"; | ||
| import * as Fiber from "effect/Fiber"; | ||
| import * as Layer from "effect/Layer"; | ||
| import * as Option from "effect/Option"; | ||
| import { vi } from "vite-plus/test"; | ||
|
|
||
| vi.mock("expo-secure-store", () => ({})); | ||
|
|
||
| import * as MobileDatabase from "./mobile-database"; | ||
| import * as MobilePreferences from "./mobile-preferences"; | ||
| import * as MobileSecureStorage from "./mobile-secure-storage"; | ||
|
|
||
| const FALLBACK_KEY = "t3code.preferences.fallback"; | ||
|
|
||
| function makeStorage() { | ||
| let databaseLoads = 0; | ||
| let failDatabaseLoad = false; | ||
| let pendingSave: | ||
| | { started: PromiseWithResolvers<void>; finish: PromiseWithResolvers<void> } | ||
| | undefined; | ||
| let stored: Option.Option<MobileDatabase.StoredPreferencesJson> = Option.none(); | ||
| const secure = new Map<string, string>(); | ||
|
|
||
| const database = MobileDatabase.MobileDatabase.of({ | ||
| loadCache: () => Effect.succeedNone, | ||
| listCache: () => Effect.succeed([]), | ||
| saveCache: () => Effect.void, | ||
| removeCache: () => Effect.void, | ||
| clearCacheKind: () => Effect.void, | ||
| clearEnvironmentCache: () => Effect.void, | ||
| clearAllCaches: Effect.void, | ||
| inspectCaches: Effect.succeed([]), | ||
| loadPreferencesJson: Effect.suspend(() => { | ||
| databaseLoads++; | ||
| return failDatabaseLoad | ||
| ? Effect.fail( | ||
| new MobileDatabase.MobileDatabaseError({ operation: "load-preferences", cause: null }), | ||
| ) | ||
| : Effect.succeed(stored); | ||
| }), | ||
| savePreferencesJson: (payload, updatedAt) => | ||
| Effect.promise(async () => { | ||
| const pending = pendingSave; | ||
| pendingSave = undefined; | ||
| if (pending) { | ||
| pending.started.resolve(); | ||
| await pending.finish.promise; | ||
| } | ||
| stored = Option.some({ payload, updatedAt }); | ||
| }), | ||
| }); | ||
| const secureStorage = MobileSecureStorage.MobileSecureStorage.of({ | ||
| getItem: (key) => Effect.sync(() => secure.get(key) ?? null), | ||
| setItem: (key, value) => Effect.sync(() => void secure.set(key, value)), | ||
| removeItem: (key) => Effect.sync(() => void secure.delete(key)), | ||
| }); | ||
|
|
||
| const layer = MobilePreferences.layer.pipe( | ||
| Layer.provide( | ||
| Layer.merge( | ||
| Layer.succeed(MobileDatabase.MobileDatabase, database), | ||
| Layer.succeed(MobileSecureStorage.MobileSecureStorage, secureStorage), | ||
| ), | ||
| ), | ||
| ); | ||
| return { | ||
| secure, | ||
| layer, | ||
| databaseLoads: () => databaseLoads, | ||
| failDatabaseLoad: (fail: boolean) => { | ||
| failDatabaseLoad = fail; | ||
| }, | ||
| delayNextSave: () => { | ||
| const started = Promise.withResolvers<void>(); | ||
| const finish = Promise.withResolvers<void>(); | ||
| pendingSave = { started, finish }; | ||
| return { started: Effect.promise(() => started.promise), finish: () => finish.resolve() }; | ||
| }, | ||
| stored: () => Option.map(stored, ({ payload }) => JSON.parse(payload) as unknown), | ||
| setStored: (preferences: MobilePreferences.Preferences, updatedAt: number) => { | ||
| stored = Option.some({ payload: JSON.stringify(preferences), updatedAt }); | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| describe("MobilePreferencesStore", () => { | ||
| it.effect("reads storage once across serialized updates", () => { | ||
| const storage = makeStorage(); | ||
| return Effect.gen(function* () { | ||
| const store = yield* MobilePreferences.MobilePreferencesStore; | ||
| yield* Effect.all( | ||
| [ | ||
| store.savePatch({ mathRenderingEnabled: true }), | ||
| store.update((current) => ({ | ||
| collapsedProjectGroups: [...(current.collapsedProjectGroups ?? []), "a"], | ||
| })), | ||
| store.update((current) => ({ | ||
| collapsedProjectGroups: [...(current.collapsedProjectGroups ?? []), "b"], | ||
| })), | ||
| ], | ||
| { concurrency: "unbounded" }, | ||
| ); | ||
|
|
||
| expect(storage.stored()).toEqual( | ||
| Option.some({ mathRenderingEnabled: true, collapsedProjectGroups: ["a", "b"] }), | ||
| ); | ||
| expect(storage.databaseLoads()).toBe(1); | ||
| }).pipe(Effect.provide(storage.layer)); | ||
| }); | ||
|
|
||
| it.effect.each(["update", "fallback", "legacy"] as const)( | ||
| "waits for an interrupted %s write before the next update", | ||
| (path) => { | ||
| const storage = makeStorage(); | ||
| return Effect.gen(function* () { | ||
| const store = yield* MobilePreferences.MobilePreferencesStore; | ||
| const preferences = { mathRenderingEnabled: true, workingShelfEnabled: true }; | ||
| if (path === "update") { | ||
| yield* store.savePatch({ mathRenderingEnabled: true }); | ||
| } else if (path === "fallback") { | ||
| storage.secure.set( | ||
| FALLBACK_KEY, | ||
| JSON.stringify({ payload: JSON.stringify(preferences), updatedAt: 100 }), | ||
| ); | ||
| } else { | ||
| storage.secure.set("t3code.preferences", JSON.stringify(preferences)); | ||
| } | ||
|
|
||
| const pending = storage.delayNextSave(); | ||
| const order: string[] = []; | ||
| const write: Effect.Effect< | ||
| MobilePreferences.Preferences, | ||
| | MobilePreferences.MobilePreferencesSaveError | ||
| | MobilePreferences.MobilePreferencesLoadError | ||
| > = path === "update" ? store.savePatch({ workingShelfEnabled: true }) : store.load; | ||
| const interrupted = yield* Effect.forkChild( | ||
| write.pipe(Effect.onExit(() => Effect.sync(() => void order.push("write exited")))), | ||
| ); | ||
| yield* pending.started; | ||
| const interruption = yield* Effect.forkChild(Fiber.interrupt(interrupted), { | ||
| startImmediately: true, | ||
| }); | ||
| const next = yield* Effect.forkChild( | ||
| store | ||
| .savePatch({ codeWordBreak: true }) | ||
| .pipe(Effect.onExit(() => Effect.sync(() => void order.push("next exited")))), | ||
| { startImmediately: true }, | ||
| ); | ||
| order.push("native write released"); | ||
| pending.finish(); | ||
| yield* Fiber.join(interruption); | ||
| yield* Fiber.join(next); | ||
| yield* store.savePatch({ collapsedProjectGroups: ["a"] }); | ||
|
|
||
| expect(storage.stored()).toEqual( | ||
| Option.some({ ...preferences, codeWordBreak: true, collapsedProjectGroups: ["a"] }), | ||
| ); | ||
| expect(order).toEqual(["native write released", "write exited", "next exited"]); | ||
| }).pipe(Effect.provide(storage.layer)); | ||
| }, | ||
| ); | ||
|
|
||
| it.effect("does not reuse a load that could not read the database", () => { | ||
| const storage = makeStorage(); | ||
| storage.setStored({ mathRenderingEnabled: true }, 100); | ||
| storage.secure.set( | ||
| FALLBACK_KEY, | ||
| JSON.stringify({ payload: JSON.stringify({ mathRenderingEnabled: false }), updatedAt: 50 }), | ||
| ); | ||
| return Effect.gen(function* () { | ||
| const store = yield* MobilePreferences.MobilePreferencesStore; | ||
| storage.failDatabaseLoad(true); | ||
| expect(yield* store.load).toEqual({ mathRenderingEnabled: false }); | ||
|
|
||
| storage.failDatabaseLoad(false); | ||
| yield* store.savePatch({ codeWordBreak: true }); | ||
| expect(storage.stored()).toEqual( | ||
| Option.some({ mathRenderingEnabled: true, codeWordBreak: true }), | ||
| ); | ||
| }).pipe(Effect.provide(storage.layer)); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.