feat: add telemetry to pull, goto build page

packages/backend/src/api-impl.ts

@@ -24,6 +24,7 @@ import { buildDiskImage } from './build-disk-image';
 import { History } from './history';
 import * as containerUtils from './container-utils';
 import { Messages } from '/@shared/src/messages/Messages';
+import { telemetryLogger } from './extension';
 
 export class BootcApiImpl implements BootcApi {
   private history: History;
@@ -145,6 +146,16 @@ export class BootcApiImpl implements BootcApi {
     }
   }
 
+  // Log an event to telemetry
+  async telemetryLogUsage(eventName: string, data?: Record<string, unknown>): Promise<void> {
+    telemetryLogger.logUsage(eventName, data);
+  }
+
+  // Log an error to telemetry
+  async telemetryLogError(eventName: string, data?: Record<string, unknown>): Promise<void> {
+    telemetryLogger.logError(eventName, data);
+  }
+
   // The API does not allow callbacks through the RPC, so instead
   // we send "notify" messages to the frontend to trigger a refresh
   // this method is internal and meant to be used by the API implementation

packages/backend/src/build-disk-image.ts

@@ -25,8 +25,7 @@ import { bootcImageBuilderContainerName, bootcImageBuilderName } from './constan
 import type { BootcBuildInfo, BuildType } from '/@shared/src/models/bootc';
 import type { History } from './history';
 import * as machineUtils from './machine-utils';
-
-const telemetryLogger = extensionApi.env.createTelemetryLogger();
+import { telemetryLogger } from './extension';
 
 export async function buildDiskImage(build: BootcBuildInfo, history: History): Promise<void> {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -101,9 +100,8 @@ export async function buildDiskImage(build: BootcBuildInfo, history: History): P
   build.status = 'creating';
   await history.addOrUpdateBuildInfo(build);
 
-  // After resolving all the information, adding it to the history, finally telemetry the data.
+  // Store the build information for telemetry
   telemetryData.build = build;
-  telemetryLogger.logUsage('buildDiskImage', telemetryData);
 
   // "Returning" withProgress allows PD to handle the task in the background with building.
   return extensionApi.window

packages/backend/src/container-utils.spec.ts

@@ -28,6 +28,10 @@ import {
   deleteOldImages,
 } from './container-utils';
 
+const mocks = vi.hoisted(() => ({
+  logUsageMock: vi.fn(),
+}));
+
 // Mocks and utilities
 vi.mock('@podman-desktop/api', async () => {
   return {
@@ -48,6 +52,11 @@ vi.mock('@podman-desktop/api', async () => {
         },
       ]),
     },
+    env: {
+      createTelemetryLogger: () => ({
+        logUsage: mocks.logUsageMock,
+      }),
+    },
   };
 });
 
@@ -63,7 +72,9 @@ test('getContainerEngine should return a running podman engine', async () => {
 
 test('pullImage should call pullImage from containerEngine', async () => {
   await pullImage('someImage');
+
   expect(extensionApi.containerEngine.pullImage).toBeCalled();
+  expect(mocks.logUsageMock).toHaveBeenCalled();
 });
 
 // Test createAndStartContainer

packages/backend/src/container-utils.ts

@@ -17,6 +17,7 @@
  ***********************************************************************/
 import type { ContainerCreateOptions } from '@podman-desktop/api';
 import * as extensionApi from '@podman-desktop/api';
+import { telemetryLogger } from './extension';
 
 // Get the running container engine
 export async function getContainerEngine(): Promise<extensionApi.ContainerProviderConnection> {
@@ -46,13 +47,20 @@ export async function getContainerEngine(): Promise<extensionApi.ContainerProvid
 
 // Pull the image
 export async function pullImage(image: string) {
+  const telemetryData: Record<string, unknown> = {};
+  telemetryData.image = image;
+
   console.log('Pulling image: ', image);
   try {
     const containerConnection = await getContainerEngine();
     await extensionApi.containerEngine.pullImage(containerConnection, image, () => {});
+    telemetryData.success = true;
   } catch (e) {
     console.error(e);
+    telemetryData.error = e;
     throw new Error('There was an error pulling the image: ' + e);
+  } finally {
+    telemetryLogger.logUsage('pullImage', telemetryData);
   }
 }
 

packages/backend/src/extension.ts

@@ -27,11 +27,11 @@ import { Messages } from '/@shared/src/messages/Messages';
 import { satisfies, minVersion, coerce } from 'semver';
 import { engines } from '../package.json';
 
+export const telemetryLogger = extensionApi.env.createTelemetryLogger();
+
 export async function activate(extensionContext: ExtensionContext): Promise<void> {
   console.log('starting bootc extension');
 
-  const telemetryLogger = extensionApi.env.createTelemetryLogger();
-
   // Ensure version is above the minimum Podman Desktop version required
   const version = extensionApi.version ?? 'unknown';
   if (!checkVersion(version)) {

packages/frontend/src/Homepage.spec.ts

@@ -49,6 +49,7 @@ vi.mock('./api/client', async () => {
       listHistoryInfo: vi.fn(),
       listBootcImages: vi.fn(),
       deleteBuilds: vi.fn(),
+      telemetryLogUsage: vi.fn(),
     },
     rpcBrowser: {
       subscribe: () => {
@@ -121,3 +122,24 @@ test('Test clicking on delete button', async () => {
 
   expect(spyOnDelete).toHaveBeenCalled();
 });
+
+test('Test clicking on build button', async () => {
+  vi.mocked(bootcClient.listHistoryInfo).mockResolvedValue(mockHistoryInfo);
+
+  await waitRender(Homepage);
+
+  // Wait until header 'Welcome to Bootable Containers' is removed
+  // as that means it's fully loaded
+  while (screen.queryByText('Welcome to Bootable Containers')) {
+    await new Promise(resolve => setTimeout(resolve, 100));
+  }
+
+  // spy on telemetryLogUsage function
+  const spyOnLogUsage = vi.spyOn(bootcClient, 'telemetryLogUsage');
+
+  // Click on build button
+  const buildButton = screen.getAllByRole('button', { name: 'Build' })[0];
+  buildButton.click();
+
+  expect(spyOnLogUsage).toHaveBeenCalled();
+});

packages/frontend/src/Homepage.svelte

@@ -51,6 +51,7 @@ async function deleteSelectedBuilds() {
 }
 
 async function gotoBuild(): Promise<void> {
+  bootcClient.telemetryLogUsage('nav-build');
   router.goto('/build');
 }
 

packages/shared/src/BootcAPI.ts

@@ -29,4 +29,6 @@ export abstract class BootcApi {
   abstract openFolder(folder: string): Promise<boolean>;
   abstract generateUniqueBuildID(name: string): Promise<string>;
   abstract openLink(link: string): Promise<void>;
+  abstract telemetryLogUsage(eventName: string, data?: Record<string, unknown> | undefined): Promise<void>;
+  abstract telemetryLogError(eventName: string, data?: Record<string, unknown> | undefined): Promise<void>;
 }