[TypeScript] Add types to loot-core app #4155
Conversation
actual-github-bot
bot
changed the title
✅ Deploy Preview for actualbudget ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
joel-jeremy
changed the title
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 No files were changed View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were 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 No files were changed View detailed bundle breakdownAdded No assets were added Removed No assets were removed Bigger No assets were bigger Smaller No assets were smaller Unchanged
|
WalkthroughThe pull request introduces type improvements for the Possibly related PRs
Suggested labels
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/server/app.ts (3)
17-18: LGTM! Consider adding JSDoc comments.The type definitions are clear and well-structured. Consider adding JSDoc comments to document the purpose of these types.
+/** Function that cleans up a service by removing listeners, clearing timeouts, etc. */ type UnlistenService = () => void; +/** Function that sets up a service and returns a cleanup function */ type Service = () => UnlistenService;
45-47: Add return type and improve parameter name.While the Service type is correctly used, consider these improvements:
- service(func: Service) { + service(serviceSetup: Service): void { - this.services.push(func); + this.services.push(serviceSetup); }
Line range hint
89-91: Improve generic type parameter naming.The generic type parameter
Tcould be more descriptive. Consider renaming it toHandlerssince that's how it's used.-export function createApp<T>() { - return new App<T>(); +export function createApp<Handlers>() { + return new App<Handlers>(); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
upcoming-release-notes/4155.mdis excluded by!**/*.md
📒 Files selected for processing (1)
packages/loot-core/src/server/app.ts(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: build (macos-latest)
- GitHub Check: build (windows-latest)
- GitHub Check: build (ubuntu-latest)
- GitHub Check: web
- GitHub Check: Wait for Netlify build to finish
- GitHub Check: test
- GitHub Check: api
- GitHub Check: compare
- GitHub Check: Analyze
🔇 Additional comments (2)
packages/loot-core/src/server/app.ts (2)
23-24: LGTM! Type definitions improve safety.The array type annotations for services and their cleanup functions enhance type safety and make the code's intent clearer.
Line range hint
1-1: Consider removing @ts-strict-ignore.With the addition of these type improvements, we might be able to remove this directive. Let's verify if it's still needed.
|
|
||
| constructor() { | ||
| this.handlers = {} as Handlers; | ||
| this.services = []; | ||
| this.events = mitt(); | ||
| this.events = mitt<Events>(); |
There was a problem hiding this comment.
💡 Codebase verification
Type safety gap in Events interface
The Events type doesn't include the 'change' event emitted in spreadsheet.ts, which bypasses TypeScript's type checking. Additionally, Events only covers a subset of available server events.
- Add the 'change' event type to Events interface:
type Events = {
sync: ServerEvents['sync-event'];
'load-budget': { id: string };
'change': { names: string[] }; // Add this
};🔗 Analysis chain
Verify event type coverage.
The generic type parameter properly constrains event types. However, let's verify that all possible events are covered in the Events type.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for event emissions to ensure all are typed
rg -t typescript "this\.events\.emit\(" packages/loot-core/src/
Length of output: 100
Script:
#!/bin/bash
# Search for event emissions without file type restriction
rg "this\.events\.emit\(" packages/loot-core/src/
# Find Events type definition
ast-grep --pattern 'type Events = {
$$$
}'
# Backup pattern search for Events interface/type
rg -A 10 "^(type|interface)\s+Events\s*=" packages/loot-core/src/
Length of output: 1176
Script:
#!/bin/bash
# Find ServerEvents type definition
rg -A 10 "^(type|interface)\s+ServerEvents\s*=" packages/loot-core/src/
# Find any event listeners for 'change' event
rg "this\.events\.on\('change'" packages/loot-core/src/
# Find any imports of ServerEvents
rg "ServerEvents" packages/loot-core/src/
Length of output: 1077
Script:
#!/bin/bash
# View ServerEvents definition
cat packages/loot-core/src/types/server-events.d.ts
Length of output: 2081
|
Thank for the rebase @matt-fidd! |
No description provided.