chore: using simple objects in rpc api (to avoid snapshots) #1314
Conversation
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
deboer-tim
requested review from
benoitf,
dgolovin,
SoniaSandler and
cdrage
and removed request for
a team
Moving to svelte 5, state objects are proxied. Normally that's an implementation detail, but when you try to pass the proxies through rpc they can't be cloned and result in errors. We could use $state.snapshot(build) every time we pass objects from the UI to the API, but we really shouldn't be passing whole objects to the backend and blindly trusting that the objects (including all properties) match what the backend knows anyway. This changes the three affected API functions to accept ids instead of objects, and the backend looks up the objects before acting. Although it's slightly more work on the backend, this is a better/more robust API, and also avoids the svelte 5 proxy issue. Fixes podman-desktop#1304. Signed-off-by: Tim deBoer <[email protected]>
benoitf
reviewed
Feb 11, 2025
packages/backend/src/api-impl.ts
Outdated
| async checkVMLaunchPrereqs(buildId: string): Promise<string | undefined> { | ||
| const build = this.history.getHistory().find(build => build.id === buildId); | ||
| if (!build) { | ||
| return Promise.reject(new Error(`Could not find build: ${buildId}`)); |
There was a problem hiding this comment.
question : why promise.rejectand not throw new Error ?
There was a problem hiding this comment.
Should be throw error, fixed in new commit.
packages/backend/src/api-impl.ts
Outdated
| @@ -330,6 +344,7 @@ export class BootcApiImpl implements BootcApi { | |||
| // this method is internal and meant to be used by the API implementation | |||
| protected async notify(id: string, body: unknown = {}): Promise<void> { | |||
| // Must pass in an empty body, if it is undefined this fails | |||
| console.log('notify frontend: ' + id); | |||
Signed-off-by: Tim deBoer <[email protected]>
benoitf
reviewed
Feb 11, 2025
packages/backend/src/api-impl.ts
Outdated
Comment on lines
110
to
112
| const builds = buildIds | ||
| .map(id => this.history.getHistory().find(build => build.id === id)) | ||
| .filter(build => build) as BootcBuildInfo[]; |
There was a problem hiding this comment.
issue: since TypeScript 5.5 / microsoft/TypeScript#57465 the inferring is automatic on the filter so no need to add a cast to as BootcBuildInfo[]
but use filter(build => !!build) rather than (build => build)
There was a problem hiding this comment.
Nice! I wasn't aware of that, fixed.
Signed-off-by: Tim deBoer <[email protected]>
cdrage
approved these changes
Feb 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
Moving to svelte 5, state objects are proxied. Normally that's an implementation detail, but when you try to pass the proxies through rpc they can't be cloned and result in errors.
We could use $state.snapshot(build) every time we pass objects from the UI to the API, but we really shouldn't be passing whole objects to the backend and blindly trusting that the objects (including all properties) match what the backend knows anyway.
This changes the three affected API functions to accept ids instead of objects, and the backend looks up the objects before acting. Although it's slightly more work on the backend, this is a better/more robust API, and also avoids the svelte 5 proxy issue.
Screenshot / video of UI
N/A
What issues does this PR fix or reference?
Fixes #1304.
How to test this PR?
PR checks, delete a build, start a VM. Tests added to check we're passing strings.