Merge pull request #657 from golemfactory/feature/JST-526

feat: task executor emits lifecycle events through an EventEmitter

README.md

@@ -85,7 +85,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 (async function main() {
   const executor = await TaskExecutor.create("9a3b5d67b0b27746283cb5f287c13eab1beaa12d92a9f536b747c7ae");
   await executor.run(async (ctx) => console.log(await ctx.run("echo 'Hello World'")).stdout);
-  await executor.end();
+  await executor.shutdown();
 })();
 ```
 

examples/blender/blender.ts

@@ -50,7 +50,7 @@ async function main(subnetTag: string, driver?: string, network?: string, debug?
   const results = await Promise.all(futureResults);
   results.forEach((result) => console.log(result));
 
-  await executor.end();
+  await executor.shutdown();
 }
 
 program

examples/docs-examples/examples/composing-tasks/alert-code.mjs

@@ -19,5 +19,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
     }
   });
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/composing-tasks/batch-end.mjs

@@ -20,5 +20,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   console.log(result);
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/composing-tasks/batch-endstream-chunks.mjs

@@ -17,6 +17,6 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
     res.on("data", (data) => (data.index == 2 ? console.log(data.stdout) : ""));
     res.on("error", (error) => console.error(error));
-    res.on("close", () => executor.end());
+    res.on("close", () => executor.shutdown());
   });
 })();

examples/docs-examples/examples/composing-tasks/batch-endstream-forawait.mjs

@@ -20,5 +20,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
     }
   });
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/composing-tasks/multiple-run-prosaic.mjs

@@ -16,5 +16,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
   console.log(result);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/composing-tasks/single-command.cjs

@@ -7,7 +7,7 @@ const { TaskExecutor } = require("@golem-sdk/golem-js");
   });
 
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/composing-tasks/single-command.mjs

@@ -7,7 +7,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/composing-tasks/single-command.ts

@@ -7,7 +7,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   const result = await executor.run<string | unknown>(async (ctx) => (await ctx.run("node -v")).stdout);
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/executing-tasks/before-each.mjs

@@ -25,5 +25,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
   await Promise.all(futureResults);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/executing-tasks/foreach.mjs

@@ -14,5 +14,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
     });
   }
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/executing-tasks/map.mjs

@@ -17,5 +17,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   const results = await Promise.all(futureResults);
   results.forEach((result) => console.log(result.stdout));
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/executing-tasks/max-parallel-tasks.mjs

@@ -18,5 +18,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   const results = await Promise.all(futureResults);
   results.forEach((result) => console.log(result.stdout));
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/executing-tasks/single-run.mjs

@@ -8,7 +8,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
 
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/selecting-providers/custom-price.mjs

@@ -36,5 +36,5 @@ const myFilter = async (proposal) => {
   await executor.run(async (ctx) =>
     console.log((await ctx.run(`echo "This task is run on ${ctx.provider.id}"`)).stdout, ctx.provider.id),
   );
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/selecting-providers/demand.mjs

@@ -11,5 +11,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   await executor.run(async (ctx) => console.log((await ctx.run("echo 'Hello World'")).stdout));
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/selecting-providers/whitelist.mjs

@@ -20,5 +20,5 @@ for (let i = 0; i < whiteListNames.length; i++) {
   await executor.run(async (ctx) =>
     console.log((await ctx.run(`echo "This task is run on ${ctx.provider.name}"`)).stdout, ctx.provider.name),
   );
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/sending-data/downloading-file.mjs

@@ -19,5 +19,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   console.log(result);
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/sending-data/uploading-file.mjs

@@ -24,5 +24,5 @@ import * as fs from "fs";
   console.log("md5 of the file sent to provider: ", result);
   console.log("Locally computed  md5: ", hash);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/sending-data/uploading-json.mjs

@@ -17,5 +17,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
   console.log(output.stdout);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/switching-to-mainnet/run-on-polygon.mjs

@@ -8,7 +8,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/transferring-data/download-file.mjs

@@ -19,5 +19,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   console.log(result);
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/transferring-data/transfer-data-in-browser.html

@@ -124,7 +124,7 @@ <h3>Logs</h3>
           })
           .catch((e) => logger.error(e));
 
-        await executor.end();
+        await executor.shutdown();
         if (result?.data) setResponse(result.data);
       }
       window.run = run;

examples/docs-examples/examples/transferring-data/upload-file.mjs

@@ -24,5 +24,5 @@ import * as fs from "fs";
   console.log("md5 of the file sent to provider: ", result);
   console.log("Locally computed  md5: ", hash);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/transferring-data/upload-json-in-browser.html

@@ -44,7 +44,7 @@
             appendResults(JSON.stringify(output.data.output, null, "\t"));
           })
           .catch((e) => logger.error(e));
-        await executor.end();
+        await executor.shutdown();
       }
       document.getElementById("echo").onclick = run;
     </script>

examples/docs-examples/examples/transferring-data/upload-json.mjs

@@ -17,5 +17,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
   console.log(output.stdout);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/using-app-keys/index.mjs

@@ -8,7 +8,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/working-with-images/hash.mjs

@@ -8,7 +8,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
 
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/working-with-images/tag.mjs

@@ -8,7 +8,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
 
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/examples/working-with-results/multi-command-end.mjs

@@ -20,5 +20,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   console.log(result);
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/working-with-results/multi-command-endstream.mjs

@@ -17,6 +17,6 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
     res.on("data", (result) => console.log(result));
     res.on("error", (error) => console.error(error));
-    res.on("close", () => executor.end());
+    res.on("close", () => executor.shutdown());
   });
 })();

examples/docs-examples/examples/working-with-results/multi-command-fail.mjs

@@ -19,5 +19,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   });
 
   console.log(result);
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/working-with-results/single-command-fail.mjs

@@ -10,5 +10,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   const result = await executor.run(async (ctx) => await ctx.run("node -w"));
   console.log("Task result:", result);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/examples/working-with-results/single-command.mjs

@@ -9,5 +9,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   const result = await executor.run(async (ctx) => await ctx.run("node -v"));
   console.log("Task result:", result);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/quickstarts/quickstart/requestor.mjs

@@ -5,7 +5,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
     yagnaOptions: { apiKey: "try_golem" },
   });
   const result = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", result);
 })();

examples/docs-examples/quickstarts/web-quickstart/requestor.mjs

@@ -34,7 +34,7 @@ async function run() {
     .run(async (ctx) => appendResults((await ctx.run("echo 'Hello World'")).stdout))
     .catch((e) => logger.error(e));
 
-  await executor.end();
+  await executor.shutdown();
 }
 
 document.getElementById("echo").onclick = run;

examples/docs-examples/tutorials/building-custom-image/index.mjs

@@ -10,5 +10,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
     console.log("/golem/work content: ", (await ctx.run("ls /golem/work")).stdout);
   });
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/docs-examples/tutorials/quickstart/index.mjs

@@ -8,7 +8,7 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 
   const taskResult = await executor.run(async (ctx) => (await ctx.run("node -v")).stdout);
 
-  await executor.end();
+  await executor.shutdown();
 
   console.log("Task result:", taskResult);
 })();

examples/docs-examples/tutorials/running-from-browser/index.html

@@ -71,7 +71,7 @@ <h3>Logs</h3>
         await executor
           .run(async (ctx) => appendResults((await ctx.run("echo 'Hello World'")).stdout))
           .catch((e) => logger.error(e));
-        await executor.end();
+        await executor.shutdown();
       }
       document.getElementById("echo").onclick = run;
     </script>

examples/docs-examples/tutorials/running-parallel-tasks/index.mjs

@@ -46,7 +46,7 @@ async function main(args) {
   } catch (err) {
     console.log(`Password not found`);
   } finally {
-    await executor.end();
+    await executor.shutdown();
   }
 }
 

examples/external-request/request.ts

@@ -23,5 +23,5 @@ const __dirname = fileURLToPath(new URL(".", import.meta.url));
     );
     console.log(result.stdout);
   });
-  await executor.end();
+  await executor.shutdown();
 })();

examples/fibonacci/fibonacci.js

@@ -20,7 +20,7 @@ async function main(fiboN = 1, tasksCount = 1, subnetTag, driver, network, debug
   }
 
   await Promise.all(runningTasks);
-  await executor.end();
+  await executor.shutdown();
 }
 program
   .requiredOption("-n, --fibonacci-number <n>", "fibonacci number", (val) => parseInt(val))

examples/hello-world/hello.mjs

@@ -3,5 +3,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
 (async function main() {
   const executor = await TaskExecutor.create("golem/alpine:latest");
   await executor.run(async (ctx) => console.log((await ctx.run("echo 'Hello World'")).stdout));
-  await executor.end();
+  await executor.shutdown();
 })();

examples/simple-usage/batchPromise.ts

@@ -11,5 +11,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
       .catch((error) => console.log(error));
     res?.map(({ stdout }) => console.log(stdout));
   });
-  await executor.end();
+  await executor.shutdown();
 })();

examples/simple-usage/batchStream.ts

@@ -8,5 +8,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
     results.on("error", (error) => console.error(error.toString()));
     results.on("close", () => console.log("END"));
   });
-  await executor.end();
+  await executor.shutdown();
 })();

examples/simple-usage/fileTransfer.ts

@@ -9,5 +9,5 @@ import { readFileSync } from "fs";
     console.log(`Result=${res.result}`);
     console.log("File new_test.json: ", readFileSync("new_test.json", "utf-8"));
   });
-  await executor.end();
+  await executor.shutdown();
 })();

examples/simple-usage/logger.ts

@@ -30,5 +30,5 @@ function createLogger(options) {
   });
 
   await executor.run(async (ctx) => console.log((await ctx.run("echo 'Hello World'")).stdout));
-  await executor.end();
+  await executor.shutdown();
 })(options);

examples/simple-usage/map.ts

@@ -14,5 +14,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
   const results = await Promise.all(futureResults);
   console.log(results);
 
-  await executor.end();
+  await executor.shutdown();
 })();

examples/simple-usage/run.ts

@@ -8,5 +8,5 @@ import { TaskExecutor } from "@golem-sdk/golem-js";
     return `${res1.stdout}${res2.stdout}`;
   });
   console.log(results);
-  await executor.end();
+  await executor.shutdown();
 })();