Rename WorkContext to ExeUnit

examples/advanced/local-image/serveLocalGvmi.ts

@@ -39,7 +39,7 @@ const getImagePath = (path: string) => new URL(path, import.meta.url).toString()
       },
     };
 
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     // in our Dockerfile we have created a file called hello.txt, let's read it
     const result = await lease
       .getExeUnit()

examples/advanced/override-module.ts

@@ -58,7 +58,7 @@ const order: MarketOrderSpec = {
 
   try {
     await glm.connect();
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     await lease
       .getExeUnit()
       .then((exe) => exe.run("echo Hello, Golem! 👋"))

examples/advanced/payment-filters.ts

@@ -61,7 +61,7 @@ const order: MarketOrderSpec = {
 
   try {
     await glm.connect();
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     await lease
       .getExeUnit()
       .then((exe) => exe.run("echo Hello, Golem! 👋"))

examples/advanced/proposal-filter.ts

@@ -35,7 +35,7 @@ const order: MarketOrderSpec = {
 
   try {
     await glm.connect();
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     await lease
       .getExeUnit()
       .then((exe) => exe.run(`echo [provider:${exe.provider.name}] Hello, Golem! 👋`))

examples/advanced/proposal-predefined-filter.ts

@@ -33,7 +33,7 @@ const order: MarketOrderSpec = {
 
   try {
     await glm.connect();
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     await lease
       .getExeUnit()
       .then((exe) => exe.run(`echo [provider:${exe.provider.name}] Hello, Golem! 👋`))

examples/advanced/proposal-selector.ts

@@ -41,7 +41,7 @@ const order: MarketOrderSpec = {
 
   try {
     await glm.connect();
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     await lease
       .getExeUnit()
       .then((exe) => exe.run(`echo [provider:${exe.provider.name}] Hello, Golem! 👋`))

examples/advanced/reuse-allocation.ts

@@ -52,8 +52,8 @@ import { pinoPrettyLogger } from "@golem-sdk/pino-logger";
       },
     };
 
-    const lease1 = await glm.oneOf(firstOrder);
-    const lease2 = await glm.oneOf(secondOrder);
+    const lease1 = await glm.oneOf({ order: firstOrder });
+    const lease2 = await glm.oneOf({ order: secondOrder });
 
     await lease1
       .getExeUnit()

examples/advanced/setup-and-teardown.ts

@@ -0,0 +1,64 @@
+import { MarketOrderSpec, GolemNetwork, LifecycleFunction } from "@golem-sdk/golem-js";
+import { pinoPrettyLogger } from "@golem-sdk/pino-logger";
+
+const order: MarketOrderSpec = {
+  demand: {
+    workload: { imageTag: "golem/alpine:latest" },
+  },
+  market: {
+    rentHours: 0.5,
+    pricing: {
+      model: "linear",
+      maxStartPrice: 0.5,
+      maxCpuPerHourPrice: 1.0,
+      maxEnvPerHourPrice: 0.5,
+    },
+  },
+};
+
+(async () => {
+  const glm = new GolemNetwork({
+    logger: pinoPrettyLogger({
+      level: "info",
+    }),
+  });
+
+  try {
+    await glm.connect();
+
+    const setup: LifecycleFunction = async (exe) =>
+      exe
+        .run(`echo This code is run on the start of the exe-unit ${exe.provider.name}`)
+        .then((res) => console.log(res.stdout));
+
+    const teardown: LifecycleFunction = async (exe) =>
+      exe
+        .run(`echo This code is run before the exe-unit ${exe.provider.name} is destroyed`)
+        .then((res) => console.log(res.stdout));
+
+    const pool = await glm.manyOf({
+      concurrency: 2,
+      order,
+      setup,
+      teardown,
+    });
+    await Promise.allSettled([
+      pool.withLease(async (lease) =>
+        lease
+          .getExeUnit()
+          .then((exe) => exe.run(`echo Hello, Golem from the first machine! 👋 ${exe.provider.name}`))
+          .then((res) => console.log(res.stdout)),
+      ),
+      pool.withLease(async (lease) =>
+        lease
+          .getExeUnit()
+          .then((exe) => exe.run(`echo Hello, Golem from the second machine! 👋 ${exe.provider.name}`))
+          .then((res) => console.log(res.stdout)),
+      ),
+    ]);
+  } catch (err) {
+    console.error("Failed to run the example", err);
+  } finally {
+    await glm.disconnect();
+  }
+})().catch(console.error);

examples/advanced/step-by-step.ts

@@ -136,11 +136,11 @@ import { filter, map, switchMap, take } from "rxjs";
     // Start the computation
     // First lets start the activity - this will deploy our image on the provider's machine
     const activity = await glm.activity.createActivity(agreement);
-    // Then let's create a WorkContext, which is a set of utilities to interact with the
+    // Then let's create a ExeUnit, which is a set of utilities to interact with the
     // providers machine, like running commands, uploading files, etc.
-    const ctx = await glm.activity.createWorkContext(activity);
+    const exe = await glm.activity.createExeUnit(activity);
     // Now we can run a simple command on the provider's machine
-    const result = await ctx.run("echo Hello, Golem 👋!");
+    const result = await exe.run("echo Hello, Golem 👋!");
     console.log("Result of the command ran on the provider's machine:", result.stdout);
 
     // We're done, let's clean up

examples/basic/events.ts

@@ -36,16 +36,18 @@ import { pinoPrettyLogger } from "@golem-sdk/pino-logger";
     });
 
     const lease = await glm.oneOf({
-      demand: {
-        workload: { imageTag: "golem/alpine:latest" },
-      },
-      market: {
-        rentHours: 0.5,
-        pricing: {
-          model: "linear",
-          maxStartPrice: 0.5,
-          maxCpuPerHourPrice: 1.0,
-          maxEnvPerHourPrice: 0.5,
+      order: {
+        demand: {
+          workload: { imageTag: "golem/alpine:latest" },
+        },
+        market: {
+          rentHours: 0.5,
+          pricing: {
+            model: "linear",
+            maxStartPrice: 0.5,
+            maxCpuPerHourPrice: 1.0,
+            maxEnvPerHourPrice: 0.5,
+          },
         },
       },
     });

examples/basic/one-of.ts

@@ -25,7 +25,7 @@ const order: MarketOrderSpec = {
 
   try {
     await glm.connect();
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     await lease
       .getExeUnit()
       .then((exe) => exe.run("echo Hello, Golem! 👋"))

examples/basic/run-and-stream.ts

@@ -30,7 +30,7 @@ const order: MarketOrderSpec = {
 
   try {
     await glm.connect();
-    const lease = await glm.oneOf(order);
+    const lease = await glm.oneOf({ order });
     const exe = await lease.getExeUnit();
 
     const remoteProcess = await exe.runAndStream(

examples/docs-examples/quickstarts/retrievable-task/task.mjs

@@ -10,8 +10,8 @@ const job = golem.createJob({
     imageTag: "golem/alpine:latest",
   },
 });
-job.startWork(async (ctx) => {
-  const response = await ctx.run("echo 'Hello, Golem!'");
+job.startWork(async (exe) => {
+  const response = await exe.run("echo 'Hello, Golem!'");
   return response.stdout;
 });
 

examples/experimental/express/server.ts

@@ -53,9 +53,9 @@ app.post("/tts", async (req, res) => {
     console.log("Job succeeded", job.results);
   });
 
-  job.startWork(async (ctx) => {
+  job.startWork(async (exe) => {
     const fileName = `${Math.random().toString(36).slice(2)}.wav`;
-    await ctx
+    await exe
       .beginBatch()
       .run(`espeak "${req.body}" -w /golem/output/output.wav`)
       .downloadFile("/golem/output/output.wav", `public/${fileName}`)

examples/experimental/job/cancel.ts

@@ -41,8 +41,8 @@ async function main() {
     console.log("Job ended event emitted");
   });
 
-  job.startWork(async (ctx) => {
-    return String((await ctx.run("echo -n 'Hello Golem!'")).stdout);
+  job.startWork(async (exe) => {
+    return String((await exe.run("echo -n 'Hello Golem!'")).stdout);
   });
 
   console.log("Canceling job...");

examples/experimental/job/getJobById.ts

@@ -37,8 +37,8 @@ function startJob() {
     console.log("Job ended event emitted");
   });
 
-  job.startWork(async (ctx) => {
-    return String((await ctx.run("echo -n 'Hello Golem!'")).stdout);
+  job.startWork(async (exe) => {
+    return String((await exe.run("echo -n 'Hello Golem!'")).stdout);
   });
   return job.id;
 }

examples/experimental/job/waitForResults.ts

@@ -40,8 +40,8 @@ async function main() {
     console.log("Job ended event emitted");
   });
 
-  job.startWork(async (ctx) => {
-    return String((await ctx.run("echo -n 'Hello Golem!'")).stdout);
+  job.startWork(async (exe) => {
+    return String((await exe.run("echo -n 'Hello Golem!'")).stdout);
   });
 
   const result = await job.waitForResult();

examples/web/hello.html

@@ -114,7 +114,7 @@ <h3>Results</h3>
           appendResults("Establishing a connection to the Golem Network");
           await glm.connect();
           appendResults("Request for leasing a provider machine");
-          const lease = await glm.oneOf(order);
+          const lease = await glm.oneOf({ order });
           await lease
             .getExeUnit()
             .then(async (exe) =>

package.json

@@ -38,7 +38,7 @@
     "docs": "typedoc src/ --plugin typedoc-plugin-merge-modules --plugin typedoc-theme-hierarchy",
     "docs:md": "typedoc src/ --plugin typedoc-plugin-markdown --plugin .docs/typedoc-frontmatter-theme.cjs --hideBreadcrumbs true && node .docs/summary-generator.cjs",
     "test": "npm run test:unit && npm run test:e2e",
-    "test:unit": "jest --config tests/unit/jest.config.json",
+    "test:unit": "jest --config tests/jest.config.json",
     "test:e2e": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --config tests/e2e/jest.config.json tests/e2e/**.spec.ts --runInBand --forceExit",
     "test:cypress": "cypress run",
     "test:examples": "tsx tests/examples/examples.test.ts",

src/activity/activity.module.ts

@@ -3,7 +3,7 @@ import { Agreement } from "../market/agreement";
 import { Activity, IActivityApi, ActivityEvents, Result } from "./index";
 import { defaultLogger } from "../shared/utils";
 import { GolemServices } from "../golem-network/golem-network";
-import { WorkContext, WorkOptions } from "./work";
+import { ExeUnit, ExeUnitOptions } from "./exe-unit";
 import { ExeScriptExecutor, ExeScriptRequest, ExecutionOptions } from "./exe-script-executor";
 import { Observable, catchError, tap } from "rxjs";
 import { StreamingBatchEvent } from "./results";
@@ -38,11 +38,11 @@ export interface ActivityModule {
   findActivityById(activityId: string): Promise<Activity>;
 
   /**
-   * Create a work context "within" the activity so that you can perform commands on the rented resources
+   * Create a exe-unit "within" the activity so that you can perform commands on the rented resources
    *
-   * @return An WorkContext that's fully commissioned and the user can execute their commands
+   * @return An ExeUnit that's fully commissioned and the user can execute their commands
    */
-  createWorkContext(activity: Activity, options?: WorkOptions): Promise<WorkContext>;
+  createExeUnit(activity: Activity, options?: ExeUnitOptions): Promise<ExeUnit>;
 
   /**
    * Factory method for creating a script executor for the activity
@@ -274,30 +274,30 @@ export class ActivityModuleImpl implements ActivityModule {
     return await this.activityApi.getActivity(activityId);
   }
 
-  async createWorkContext(activity: Activity, options?: WorkOptions): Promise<WorkContext> {
-    this.logger.info("Creating work context for activity", { activityId: activity.id });
-    const ctx = new WorkContext(activity, this, {
+  async createExeUnit(activity: Activity, options?: ExeUnitOptions): Promise<ExeUnit> {
+    this.logger.info("Creating exe-unit for activity", { activityId: activity.id });
+    const exe = new ExeUnit(activity, this, {
       yagnaOptions: this.services.yagna.yagnaOptions,
-      logger: this.logger.child("work-context"),
+      logger: this.logger.child("exe-unit"),
       ...options,
     });
 
     this.logger.debug("Initializing the exe-unit for activity", { activityId: activity.id });
     try {
-      await ctx.before();
+      await exe.setup();
       this.events.emit(
-        "workContextInitialized",
+        "exeUnitInitialized",
         await this.refreshActivity(activity).catch(() => {
           this.logger.warn("Failed to refresh activity after work context initialization", { activityId: activity.id });
           return activity;
         }),
       );
-      return ctx;
+      return exe;
     } catch (error) {
       this.events.emit(
-        "errorInitializingWorkContext",
+        "errorInitializingExeUnit",
         await this.refreshActivity(activity).catch(() => {
-          this.logger.warn("Failed to refresh activity after work context initialization error", {
+          this.logger.warn("Failed to refresh activity after exe-unit initialization error", {
             activityId: activity.id,
           });
           return activity;

tests/unit/activity.test.ts → src/activity/activity.test.ts

@@ -1,4 +1,4 @@
-import { Activity, ActivityStateEnum, Agreement } from "../../src";
+import { Activity, ActivityStateEnum, Agreement } from "../index";
 import { instance, mock } from "@johanblumenberg/ts-mockito";
 
 const mockAgreement = mock(Agreement);

src/activity/api.ts

@@ -11,8 +11,8 @@ export type ActivityEvents = {
   activityDestroyed: (activity: Activity) => void;
   errorDestroyingActivity: (activity: Activity, error: Error) => void;
 
-  workContextInitialized: (activity: Activity) => void;
-  errorInitializingWorkContext: (activity: Activity, error: Error) => void;
+  exeUnitInitialized: (activity: Activity) => void;
+  errorInitializingExeUnit: (activity: Activity, error: Error) => void;
 
   activityStateChanged: (activity: Activity, previousState: ActivityStateEnum) => void;
   errorRefreshingActivity: (activity: Activity, error: Error) => void;

src/activity/exe-script-executor.test.ts

@@ -1,8 +1,8 @@
 import { Activity } from "./activity";
 import { _, anything, imock, instance, mock, reset, verify, when } from "@johanblumenberg/ts-mockito";
 import { Capture, Deploy, DownloadFile, Run, Script, Start, Terminate, UploadFile } from "./script";
-import { buildExeScriptSuccessResult } from "../../tests/unit/helpers";
-import { GolemWorkError, WorkErrorCode } from "./work";
+import { buildExeScriptSuccessResult } from "../../tests/utils/helpers";
+import { GolemWorkError, WorkErrorCode } from "./exe-unit";
 import { Logger, sleep } from "../shared/utils";
 import { GolemAbortError, GolemError } from "../shared/error/golem-error";
 import { ExeScriptExecutor } from "./exe-script-executor";