👷 Typescript: Improving typing of asyncStorage (global-store.json) #4369
Conversation
✅ Deploy Preview for actualbudget ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Bundle Stats — desktop-clientHey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle. As this PR is updated, I'll keep you updated on how the bundle size is impacted. Total
Changeset
View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger
Smaller
Unchanged
|
Bundle Stats — loot-coreHey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle. As this PR is updated, I'll keep you updated on how the bundle size is impacted. Total
Changeset
View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger
Smaller No assets were smaller Unchanged No assets were unchanged |
MikesGlitch
changed the title
MikesGlitch
changed the title
WalkthroughThe pull request updates the asynchronous storage functions across various modules to improve type safety through the use of TypeScript generics based on the Suggested labels
Suggested reviewers
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
packages/loot-core/src/types/prefs.d.ts (1)
89-107: Consider using string literal types for boolean values.For properties that represent boolean values as strings, consider using string literal types to prevent invalid values.
Apply this diff to improve type safety:
- 'floating-sidebar'?: string; // "true" or "false" + 'floating-sidebar'?: 'true' | 'false'; - 'did-bootstrap'?: boolean; + 'did-bootstrap'?: 'true' | 'false';packages/loot-core/src/platform/server/asyncStorage/index.electron.ts (1)
14-26: Consider adding error type information.The error handling in
initcould benefit from type information for better error handling.Apply this diff to improve error handling:
export const init: T.Init = function ({ persist = true } = {}) { if (persist) { try { store = JSON.parse(fs.readFileSync(getStorePath(), 'utf8')); - } catch (e) { + } catch (e: unknown) { + if (e instanceof Error) { + console.warn(`Failed to load global store: ${e.message}`); + } store = {}; } } else { store = {}; }packages/loot-core/src/platform/server/asyncStorage/index.web.ts (1)
57-77: LGTM! Consider adding an explicit return type.The function signature change improves type safety by constraining the keys to be valid keys from
GlobalPrefsJson. However, consider adding an explicit return type for better type safety and documentation.-export async function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>( - keys: K, -) { +export async function multiGet<K extends readonly (keyof GlobalPrefsJson)[]>( + keys: K, +): Promise<[K[number], GlobalPrefsJson[K[number]]][]> {
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
upcoming-release-notes/4369.mdis excluded by!**/*.md
📒 Files selected for processing (6)
packages/loot-core/src/platform/server/asyncStorage/index.d.ts(1 hunks)packages/loot-core/src/platform/server/asyncStorage/index.electron.ts(2 hunks)packages/loot-core/src/platform/server/asyncStorage/index.testing.ts(2 hunks)packages/loot-core/src/platform/server/asyncStorage/index.web.ts(3 hunks)packages/loot-core/src/server/main.ts(2 hunks)packages/loot-core/src/types/prefs.d.ts(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
packages/loot-core/src/types/prefs.d.ts (1)
Learnt from: MatissJanis
PR: actualbudget/actual#3458
File: packages/loot-core/src/client/state-types/prefs.d.ts:5-5
Timestamp: 2024-11-10T16:45:25.627Z
Learning: In future reviews, ensure that changes related to `PrefsState` in `prefs.d.ts` do not incorrectly assume necessary updates in other parts of the codebase. Verify the impact thoroughly before making suggestions.
🪛 Biome (1.9.4)
packages/loot-core/src/platform/server/asyncStorage/index.d.ts
[error] 22-22: 'async' modifier cannot be used in an ambient context.
(parse)
🔇 Additional comments (6)
packages/loot-core/src/types/prefs.d.ts (1)
77-87: LGTM! Well-structured type definition for parsed global preferences.The
GlobalPrefstype accurately represents the parsed values with appropriate types for each property.packages/loot-core/src/platform/server/asyncStorage/index.d.ts (1)
6-6: LGTM! Well-designed type definitions with proper generic constraints.The type definitions ensure type safety by:
- Using generics to maintain type relationships
- Properly constraining keys to
GlobalPrefsJson- Ensuring value types match their corresponding keys
Also applies to: 8-34
packages/loot-core/src/platform/server/asyncStorage/index.testing.ts (1)
1-46: LGTM! Clean and type-safe testing implementation.The testing implementation provides a simple in-memory store with proper type safety.
packages/loot-core/src/platform/server/asyncStorage/index.web.ts (1)
2-2: LGTM!The import of
GlobalPrefsJsontype is correctly added to support the type-safe implementation of themultiGetfunction.packages/loot-core/src/server/main.ts (2)
1096-1099: LGTM!The
as consttype assertion correctly ensures that the array of keys is treated as a readonly tuple of literal types, which is required for the type-safe implementation ofmultiGet.
1374-1393: LGTM!The
as consttype assertion correctly ensures that the array of keys is treated as a readonly tuple of literal types, which is required for the type-safe implementation ofmultiGet.
Problem:
Every setting from global-store.json was being treated like a string and then parsed. There are values in the global-store.json that aren't strings. E.g.
did-bootstrapI've added a new type to represent the global-store.json file as it currently stands. The existing GlobalStore represents the values after they have been parsed.
This makes it a lot easier to add more complex types/types that aren't just strings. It also gives us intellisense/type safety on the prefs functions (e.g. multiGet).
This should help me out in #4357 where I want to add a global-store setting like:
#1483