chore: using simple objects in rpc api (to avoid snapshots) (#1314)

* chore: using simple objects in rpc api (to avoid snapshots)

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 #1304.

Signed-off-by: Tim deBoer <[email protected]>

* chore: correct throw error, remove console.log

Signed-off-by: Tim deBoer <[email protected]>

* chore: use !! filter to improve type filtering

Signed-off-by: Tim deBoer <[email protected]>

---------

Signed-off-by: Tim deBoer <[email protected]>

Author: deboer-tim

packages/backend/src/api-impl.ts

@@ -54,7 +54,11 @@ export class BootcApiImpl implements BootcApi {
     return checkPrereqs(await getContainerEngine());
   }
 
-  async checkVMLaunchPrereqs(build: BootcBuildInfo): Promise<string | undefined> {
+  async checkVMLaunchPrereqs(buildId: string): Promise<string | undefined> {
+    const build = this.history.getHistory().find(build => build.id === buildId);
+    if (!build) {
+      throw new Error(`Could not find build: ${buildId}`);
+    }
     return createVMManager(build).checkVMLaunchPrereqs();
   }
 
@@ -66,11 +70,16 @@ export class BootcApiImpl implements BootcApi {
     return buildDiskImage(build, this.history, overwrite);
   }
 
-  async launchVM(build: BootcBuildInfo): Promise<void> {
+  async launchVM(buildId: string): Promise<void> {
     try {
-      await createVMManager(build).launchVM();
-      // Notify it has successfully launched
-      await this.notify(Messages.MSG_VM_LAUNCH_ERROR, { success: 'Launched!', error: '' });
+      const build = this.history.getHistory().find(build => build.id === buildId);
+      if (!build) {
+        await this.notify(Messages.MSG_VM_LAUNCH_ERROR, { success: '', error: 'Could not find build to launch' });
+      } else {
+        await createVMManager(build).launchVM();
+        // Notify it has successfully launched
+        await this.notify(Messages.MSG_VM_LAUNCH_ERROR, { success: 'Launched!', error: '' });
+      }
     } catch (e) {
       // Make sure that we are able to display the "stderr" information if it exists as that actually shows
       // the error when running the command.
@@ -90,13 +99,18 @@ export class BootcApiImpl implements BootcApi {
     return stopCurrentVM();
   }
 
-  async deleteBuilds(builds: BootcBuildInfo[]): Promise<void> {
+  async deleteBuilds(buildIds: string[]): Promise<void> {
     const response = await podmanDesktopApi.window.showWarningMessage(
       `Are you sure you want to remove the selected disk images from the build history? This will remove the history of the build as well as remove any lingering build containers.`,
       'Yes',
       'No',
     );
     if (response === 'Yes') {
+      // create an array of builds. invalid build ids are ignored
+      const builds = buildIds
+        .map(id => this.history.getHistory().find(build => build.id === id))
+        .filter(build => !!build);
+
       // Map each build to a delete operation promise
       const deletePromises = builds.map(build => this.deleteBuildContainer(build));
 

packages/frontend/src/lib/disk-image/DiskImageActions.spec.ts

@@ -73,6 +73,7 @@ test('Test clicking on delete button', async () => {
   deleteButton.click();
 
   expect(spyOnDelete).toHaveBeenCalled();
+  expect(spyOnDelete).toHaveBeenCalledWith(['name1']);
 });
 
 test('Test clicking on logs button', async () => {

packages/frontend/src/lib/disk-image/DiskImageActions.svelte

@@ -16,7 +16,7 @@ let isWindows = $state(false);
 
 // Delete the build
 async function deleteBuild(): Promise<void> {
-  await bootcClient.deleteBuilds([object]);
+  await bootcClient.deleteBuilds([object.id]);
 }
 
 // Navigate to the build

packages/frontend/src/lib/disk-image/DiskImageDetailsVirtualMachine.spec.ts

@@ -69,6 +69,8 @@ test('Render virtual machine terminal window', async () => {
   await waitFor(() => {
     expect(bootcClient.launchVM).toHaveBeenCalled();
   });
+  expect(bootcClient.checkVMLaunchPrereqs).toHaveBeenCalledWith('id1');
+  expect(bootcClient.launchVM).toHaveBeenCalledWith('id1');
 });
 
 test('Show prereqs message if prereq check fails (returns ANY string)', async () => {

packages/frontend/src/lib/disk-image/DiskImageDetailsVirtualMachine.svelte

@@ -185,7 +185,7 @@ async function launchVM(build: BootcBuildInfo): Promise<void> {
 
   // This is launched IN THE BACKGROUND. We do not wait for the VM to boot before showing the terminal.
   // we instead are notified by subscribing to Messages.MSG_VM_LAUNCH_ERROR messages from RPC
-  bootcClient.launchVM(build).catch((e: unknown) => console.error('error launching VM', e));
+  bootcClient.launchVM(build.id).catch((e: unknown) => console.error('error launching VM', e));
 
   // Initialize the terminal so it awaits the websocket connection.
   await initTerminal();
@@ -261,7 +261,7 @@ onMount(async () => {
 
   if (build) {
     // Launch the VM if we pass all the prerequisites, otherwise we will show the empty screen with content / information checks.
-    vmLaunchPrereqs = await bootcClient.checkVMLaunchPrereqs(build);
+    vmLaunchPrereqs = await bootcClient.checkVMLaunchPrereqs(build.id);
 
     if (!vmLaunchPrereqs) {
       await launchVM(build);

packages/frontend/src/lib/disk-image/DiskImagesList.spec.ts

@@ -113,6 +113,7 @@ test('Test clicking on delete button', async () => {
   deleteButton.click();
 
   expect(spyOnDelete).toHaveBeenCalled();
+  expect(spyOnDelete).toHaveBeenCalledWith(['name1']);
 });
 
 test('Test clicking on build button', async () => {

packages/frontend/src/lib/disk-image/DiskImagesList.svelte

@@ -46,7 +46,7 @@ onMount(() => {
 let bulkDeleteInProgress = $state(false);
 
 async function deleteSelectedBuilds(): Promise<void> {
-  const selected = history.filter(history => history.selected);
+  const selected = history.filter(history => history.selected).map(history => history.id);
   if (selected.length === 0) {
     return;
   }

packages/shared/src/BootcAPI.ts

@@ -23,14 +23,14 @@ import type { ExamplesList } from './models/examples';
 export abstract class BootcApi {
   static readonly CHANNEL: string = 'BootcApi';
   abstract checkPrereqs(): Promise<string | undefined>;
-  abstract checkVMLaunchPrereqs(build: BootcBuildInfo): Promise<string | undefined>;
-  abstract launchVM(build: BootcBuildInfo): Promise<void>;
+  abstract checkVMLaunchPrereqs(buildId: string): Promise<string | undefined>;
+  abstract launchVM(buildId: string): Promise<void>;
   abstract buildExists(folder: string, types: BuildType[]): Promise<boolean>;
   abstract buildImage(build: BootcBuildInfo, overwrite?: boolean): Promise<void>;
   abstract pullImage(image: string, arch?: string): Promise<void>;
   abstract inspectImage(image: ImageInfo): Promise<ImageInspectInfo>;
   abstract inspectManifest(image: ImageInfo): Promise<ManifestInspectInfo>;
-  abstract deleteBuilds(builds: BootcBuildInfo[]): Promise<void>;
+  abstract deleteBuilds(buildIds: string[]): Promise<void>;
   abstract selectOutputFolder(): Promise<string>;
   abstract selectBuildConfigFile(): Promise<string>;
   abstract listBootcImages(): Promise<ImageInfo[]>;