Merge pull request #109 from Exabyte-io/feature/SOF-7731

Feature/SOF-7731

Author: timurbazhirov

src/subworkflows/subworkflow.js

@@ -50,9 +50,18 @@ export class Subworkflow extends BaseSubworkflow {
         );
     }
 
-    static generateSubworkflowId(...args) {
-        args[0] = `subworkflow-${args[0]}`;
-        if (this.usePredefinedIds) return Utils.uuid.getUUIDFromNamespace(...args);
+    static generateSubworkflowId(name, application = null, model = null, method = null) {
+        const appName = application ? application.name || application : "";
+        const modelInfo = model
+            ? `${(model.toJSON?.() || model).type}-${(model.toJSON?.() || model).subtype || ""}`
+            : "";
+        const methodInfo = method
+            ? `${(method.toJSON?.() || method).type}-${(method.toJSON?.() || method).subtype || ""}`
+            : "";
+        const seed = [`subworkflow-${name}`, appName, modelInfo, methodInfo]
+            .filter((p) => p)
+            .join("-");
+        if (this.usePredefinedIds) return Utils.uuid.getUUIDFromNamespace(seed);
         return Utils.uuid.getUUID();
     }
 
@@ -96,7 +105,7 @@ export class Subworkflow extends BaseSubworkflow {
 
         return new Cls({
             ...cleanConfig,
-            _id: Cls.generateSubworkflowId(nameForIdGeneration),
+            _id: Cls.generateSubworkflowId(nameForIdGeneration, application, model, method),
             name,
             application: application.toJSON(),
             properties: lodash.sortedUniq(

src/units/execution.js

@@ -249,7 +249,7 @@ export class ExecutionUnit extends BaseUnit {
     }
 
     toJSON() {
-        return this.clean({
+        const json = this.clean({
             ...super.toJSON(),
             executable: this.executable.toJSON(),
             flavor: this.flavor.toJSON(),
@@ -259,5 +259,10 @@ export class ExecutionUnit extends BaseUnit {
             // TODO: figure out the problem with storing context below
             // context: this.storedContext,
         });
+
+        // Remove results from executable
+        if (json.executable?.results) delete json.executable.results;
+
+        return json;
     }
 }

src/workflows/workflow.js

@@ -38,7 +38,14 @@ export class Workflow extends BaseWorkflow {
         _Workflow = Workflow,
         _MapUnit = MapUnit,
     ) {
-        if (!config._id) config._id = Workflow.generateWorkflowId(config.name);
+        if (!config._id) {
+            config._id = Workflow.generateWorkflowId(
+                config.name,
+                config.properties,
+                config.subworkflows,
+                config.applicationName,
+            );
+        }
         super(config);
         this._Subworkflow = _Subworkflow;
         this._UnitFactory = _UnitFactory;
@@ -59,9 +66,20 @@ export class Workflow extends BaseWorkflow {
         return defaultWorkflowConfig;
     }
 
-    static generateWorkflowId(...args) {
-        args[0] = `workflow-${args[0]}`;
-        if (this.usePredefinedIds) return Utils.uuid.getUUIDFromNamespace(...args);
+    static generateWorkflowId(
+        name,
+        properties = null,
+        subworkflows = null,
+        applicationName = null,
+    ) {
+        const propsInfo = properties?.length ? properties.sort().join(",") : "";
+        const swInfo = subworkflows?.length
+            ? subworkflows.map((sw) => sw.name || "unknown").join(",")
+            : "";
+        const seed = [`workflow-${name}`, applicationName, propsInfo, swInfo]
+            .filter((p) => p)
+            .join("-");
+        if (this.usePredefinedIds) return Utils.uuid.getUUIDFromNamespace(seed);
         return Utils.uuid.getUUID();
     }
 
@@ -71,6 +89,7 @@ export class Workflow extends BaseWorkflow {
             subworkflows: [subworkflow.toJSON()],
             units: setNextLinks(setUnitsHead([subworkflow.getAsUnit().toJSON()])),
             properties: subworkflow.properties,
+            applicationName: subworkflow.application.name,
         };
         return new ClsConstructor(config);
     }
@@ -292,7 +311,12 @@ export class Workflow extends BaseWorkflow {
                 const workflowConfig = defaultWorkflowConfig;
                 // eslint-disable-next-line no-case-declarations
                 const mapUnit = new this._MapUnit();
-                workflowConfig._id = this._Workflow.generateWorkflowId(workflowConfig.name);
+                workflowConfig._id = this._Workflow.generateWorkflowId(
+                    workflowConfig.name,
+                    workflowConfig.properties,
+                    workflowConfig.subworkflows,
+                    this.applicationName,
+                );
                 this.prop("workflows").push(workflowConfig);
                 this._workflows = this.prop("workflows").map((x) => new this._Workflow(x));
                 mapUnit.setWorkflowId(workflowConfig._id);
@@ -308,8 +332,14 @@ export class Workflow extends BaseWorkflow {
 
     addMapUnit(mapUnit, mapWorkflow) {
         const mapWorkflowConfig = mapWorkflow.toJSON();
-        if (!mapWorkflowConfig._id)
-            mapWorkflowConfig._id = this._Workflow.generateWorkflowId(mapWorkflowConfig.name);
+        if (!mapWorkflowConfig._id) {
+            mapWorkflowConfig._id = this._Workflow.generateWorkflowId(
+                mapWorkflowConfig.name,
+                mapWorkflowConfig.properties,
+                mapWorkflowConfig.subworkflows,
+                mapWorkflow.applicationName || this.applicationName,
+            );
+        }
         mapUnit.setWorkflowId(mapWorkflowConfig._id);
         this.addUnit(mapUnit);
         this._json.workflows.push(mapWorkflowConfig);

tests/workflow.test.js

@@ -5,8 +5,8 @@ import { builders, createWorkflows, Subworkflow, UnitFactory, Workflow } from ".
 import { createWorkflow } from "../src/workflows/create";
 
 // Expected predefined IDs constants - update these after running test to see actual values
-const EXPECTED_WORKFLOW_ID = "512cb2cc-5cca-52c7-9dd9-1d2b57196188";
-const EXPECTED_SUBWORKFLOW_ID = "82673aa1-c4d7-5b2c-b216-7579760fdfaf";
+const EXPECTED_WORKFLOW_ID = "cd826954-8c96-59f7-b2de-f36ce2d86105";
+const EXPECTED_SUBWORKFLOW_ID = "233bb8cf-3b4a-5378-84d9-a6a95a2ab43d";
 const EXPECTED_UNIT_ID = "9fc7a088-5533-5f70-bb33-f676ec65f565";
 
 describe("workflows", () => {
@@ -100,6 +100,23 @@ describe("workflows", () => {
             UnitFactory.ProcessingUnit.usePredefinedIds = false;
         }
     });
+
+    it("generates non-colliding predefined IDs", () => {
+        Workflow.usePredefinedIds = true;
+        const workflow1 = createWorkflow({
+            appName: "espresso",
+            workflowData: workflowSubforkflowMapByApplication.workflows.espresso.total_energy,
+            workflowSubworkflowMapByApplication: workflowSubforkflowMapByApplication,
+            workflowCls: Workflow,
+        });
+        const workflow2 = createWorkflow({
+            appName: "vasp",
+            workflowData: workflowSubforkflowMapByApplication.workflows.vasp.total_energy,
+            workflowSubworkflowMapByApplication: workflowSubforkflowMapByApplication,
+            workflowCls: Workflow,
+        });
+        expect(workflow1._id).to.not.equal(workflow2._id);
+    });
 });
 
 describe("workflow property", () => {