Merge pull request #1206 from golemfactory/scx1332/custom-constraints

Add possibility of adding custom constraint to workload demand

Author: SewerynKras

src/market/demand/directors/workload-demand-director-config.ts

@@ -1,4 +1,4 @@
-import { WorkloadDemandDirectorConfigOptions } from "../options";
+import { CustomConstraint, WorkloadDemandDirectorConfigOptions } from "../options";
 import { GolemConfigError } from "../../../shared/error/golem-error";
 import { BaseConfig } from "./base-config";
 
@@ -35,11 +35,15 @@ export class WorkloadDemandDirectorConfig extends BaseConfig {
   readonly imageTag?: string;
   readonly imageUrl?: string;
 
+  readonly customConstraints: CustomConstraint[];
+
   constructor(options: Partial<WorkloadDemandDirectorConfigOptions> & RequiredWorkloadDemandConfigOptions) {
     super();
 
     Object.assign(this, options);
 
+    this.customConstraints = options.customConstraints ?? [];
+
     if (!options.runtime?.name) {
       this.runtime.name = this.engine;
     }

src/market/demand/directors/workload-demand-director.test.ts

@@ -1,4 +1,4 @@
-import { DemandBodyBuilder } from "../demand-body-builder";
+import { ComparisonOperator, DemandBodyBuilder } from "../demand-body-builder";
 import { WorkloadDemandDirector } from "./workload-demand-director";
 import { WorkloadDemandDirectorConfig } from "./workload-demand-director-config";
 
@@ -142,4 +142,26 @@ describe("ActivityDemandDirector", () => {
 
     expect(decorations.constraints).toEqual(expect.arrayContaining(["(golem.runtime.name=vm-test)"]));
   });
+
+  test("should add custom constraints", async () => {
+    const builder = new DemandBodyBuilder();
+
+    const director = new WorkloadDemandDirector(
+      new WorkloadDemandDirectorConfig({
+        expirationSec: 600,
+        imageHash: "529f7fdaf1cf46ce3126eb6bbcd3b213c314fe8fe884914f5d1106d4",
+        customConstraints: [
+          { name: "golem.custom.constraint1", value: "value1", comparator: ComparisonOperator.Eq },
+          { name: "golem.custom.constraint2", value: 10, comparator: ComparisonOperator.GtEq },
+        ],
+      }),
+    );
+    await director.apply(builder);
+
+    const decorations = builder.getProduct();
+
+    expect(decorations.constraints).toEqual(
+      expect.arrayContaining(["(golem.custom.constraint1=value1)", "(golem.custom.constraint2>=10)"]),
+    );
+  });
 });

src/market/demand/directors/workload-demand-director.ts

@@ -36,6 +36,10 @@ export class WorkloadDemandDirector implements IDemandDirector {
     }
 
     this.addManifestDecorations(builder);
+
+    for (const constr of this.config.customConstraints) {
+      builder.addConstraint(constr.name, constr.value, constr.comparator);
+    }
   }
 
   private async resolveTaskPackageFromCustomUrl(): Promise<string> {

src/market/demand/options.ts

@@ -1,4 +1,5 @@
 import { RequireAtLeastOne } from "../../shared/utils/types";
+import { ComparisonOperator } from "./demand-body-builder";
 
 /**
  * Specifies a set of options related to computation resources that will be used to form the demand
@@ -14,6 +15,18 @@ export type ResourceDemandOptions = {
   minCpuCores: number;
 };
 
+/**
+ * User defined constraints for demand
+ */
+export type CustomConstraint = {
+  /** Name of the constraint */
+  name: string;
+  /** Value of the constraint */
+  value: string | number;
+  /** Type of comparison */
+  comparator: ComparisonOperator;
+};
+
 /**
  * Specifies a set of options related to runtime configuration that will be used to form the demand
  */
@@ -38,6 +51,9 @@ export type RuntimeDemandOptions = {
 
   /** Required providers capabilities to run application: example: ["vpn"] */
   capabilities: string[];
+
+  /** Specify additional, custom constraints added to demand */
+  customConstraints: CustomConstraint[];
 };
 
 /**

src/market/index.ts

@@ -13,3 +13,4 @@ export { PaymentDemandDirector } from "./demand/directors/payment-demand-directo
 export { WorkloadDemandDirector } from "./demand/directors/workload-demand-director";
 export * from "./proposal/market-proposal-event";
 export * from "./scan";
+export { ComparisonOperator } from "./demand/demand-body-builder";