feat: added vm events

Author: ZhiXiao-Lin

README.md

@@ -28,6 +28,10 @@ vm.on(events.IMAGE_PULL_END, (data) => {
   console.log(data);
 });
 
+vm.on(events.CONTAINER_RUN_OUTPUT, (data) => {
+  console.log(data);
+});
+
 await vm.pullImage(IMAGE);
 
 const images = await vm.getImages();

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nerdctl",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "description": "Node wrapper for nerdctl",

src/constants/events.ts

@@ -5,3 +5,5 @@ export const VM_INIT_END = Symbol("VM_INIT_END");
 export const IMAGE_PULL_START = Symbol("IMAGE_PULL_START");
 export const IMAGE_PULL_OUTPUT = Symbol("IMAGE_PULL_OUTPUT");
 export const IMAGE_PULL_END = Symbol("IMAGE_PULL_END");
+
+export const CONTAINER_RUN_OUTPUT = Symbol("CONTAINER_RUN_OUTPUT");

src/vms/lima.ts

@@ -113,6 +113,9 @@ export default class LimaBackend extends BaseBackend {
         if ("pull" === command) {
           this.emit(events.IMAGE_PULL_OUTPUT, dataString);
         }
+        if ("run" === command) {
+          this.emit(events.CONTAINER_RUN_OUTPUT, dataString);
+        }
       });
       child.stderr?.on("data", (data: Buffer) => {
         let dataString = data.toString();
@@ -121,6 +124,9 @@ export default class LimaBackend extends BaseBackend {
         if ("pull" === command) {
           this.emit(events.IMAGE_PULL_OUTPUT, dataString);
         }
+        if ("run" === command) {
+          this.emit(events.CONTAINER_RUN_OUTPUT, dataString);
+        }
       });
       child.on("exit", (code, signal) => {
         if (result.stderr) {
@@ -242,6 +248,11 @@ export default class LimaBackend extends BaseBackend {
     const limaDir = path.join(resourcesDir, "lima");
     const tarPath = path.join(resourcesDir, `lima-${LIMA_VERSION}.tgz`);
 
+    this.emit(
+      events.VM_INIT_OUTPUT,
+      `Downloading virtual machine from: ${url}`
+    );
+
     await download(url, tarPath);
     await fs.promises.mkdir(limaDir, { recursive: true });
 
@@ -250,6 +261,8 @@ export default class LimaBackend extends BaseBackend {
       stdio: "inherit",
     });
 
+    this.emit(events.VM_INIT_OUTPUT, "Extracting virtual machine files");
+
     await new Promise((resolve, reject) => {
       child.on("exit", (code, signal) => {
         if (code === 0) {
@@ -260,6 +273,8 @@ export default class LimaBackend extends BaseBackend {
       });
     });
 
+    this.emit(events.VM_INIT_OUTPUT, "Starting virtual machine");
+
     await this.lima("start", "--tty=false", this.instance);
 
     this.emit(events.VM_INIT_END);