Support editing of certain workflow fields on a provisioned workflow

[dbwiddis]

Description

Allows passing the parameter update_fields=true on the REST path when updating a template (PUT). This will update the existing template with only the included fields.

Issues Resolved

Resolves #749

Documentation

Please review:

• Add new update_fields parameter to update workflow API documentation-website#7632

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov]

Codecov Report

Attention: Patch coverage is 81.39535% with 16 lines in your changes missing coverage. Please review.

Project coverage is 74.61%. Comparing base (cf1016f) to head (8685442).
Report is 8 commits behind head on main.

Files	Patch %	Lines
...a/org/opensearch/flowframework/model/Template.java	73.33%	3 Missing and 5 partials ⚠️
...ework/transport/CreateWorkflowTransportAction.java	72.41%	8 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #757      +/-   ##
============================================
+ Coverage     74.37%   74.61%   +0.24%     
- Complexity      745      783      +38     
============================================
  Files            84       84              
  Lines          3825     3873      +48     
  Branches        333      356      +23     
============================================
+ Hits           2845     2890      +45     
  Misses          825      825              
- Partials        155      158       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[dbwiddis]

POST localhost:9200/_plugins/_flow_framework/workflow?provision=true
{
  "name": "test",
  "description": "Flow template",
  "use_case": "TESTING",
  "version": {
    "template": "1.0.0",
    "compatibility": ["2.12.0", "3.0.0"]
  },
  "workflows": {
    "provision": {
      "user_params": {},
      "nodes": [
        {
          "id": "no op",
          "type": "noop"
        }
      ]
    }
  }
}

{
    "workflow_id": "yl5IfJABgzSGdpsYUKJE"
}

GET localhost:9200/_plugins/_flow_framework/workflow/yl5IfJABgzSGdpsYUKJE

{
    "name": "test",
    "description": "Flow template",
    "use_case": "TESTING",
    "version": {
        "template": "1.0.0",
        "compatibility": [
            "2.12.0",
            "3.0.0"
        ]
    },
    "workflows": {
        "provision": {
            "user_params": {},
            "nodes": [
                {
                    "id": "no op",
                    "type": "noop",
                    "previous_node_inputs": {},
                    "user_inputs": {}
                }
            ],
            "edges": []
        }
    },
    "created_time": 1720072032206,
    "last_updated_time": 1720072032206,
    "last_provisioned_time": 1720072032727
}

GET localhost:9200/_plugins/_flow_framework/workflow/yl5IfJABgzSGdpsYUKJE/_status

{
    "workflow_id": "yl5IfJABgzSGdpsYUKJE",
    "state": "COMPLETED"
}

PUT localhost:9200/_plugins/_flow_framework/workflow/yl5IfJABgzSGdpsYUKJE
{
  "name": "a test with no name",
  "description": "Updated flow template",
  "use_case": "TESTING",
  "version": {
    "template": "1.0.0",
    "compatibility": ["2.12.0", "3.0.0"]
  },
  "workflows": {
    "provision": {
      "user_params": {},
      "nodes": [
        {
          "id": "no op",
          "type": "noop"
        }
      ]
    }
  }
}

400 Bad Request
{
    "error": "The template can not be updated unless its provisioning state is NOT_STARTED: yl5IfJABgzSGdpsYUKJE. Deprovision the workflow to reset the state."
}

PUT localhost:9200/_plugins/_flow_framework/workflow/yl5IfJABgzSGdpsYUKJE?update_fields=true
{
  "workflows": {
    "provision": {
      "user_params": {},
      "nodes": [
        {
          "id": "no op",
          "type": "noop"
        }
      ]
    }
  }
}

400 Bad Request
{
    "error": "You can not update the field [workflows] without updating the whole template."
}

PUT localhost:9200/_plugins/_flow_framework/workflow/yl5IfJABgzSGdpsYUKJE?update_fields=true
{
  "name": "a test with no name",
  "description": "Updated flow template"
}

{
    "workflow_id": "yl5IfJABgzSGdpsYUKJE"
}

GET localhost:9200/_plugins/_flow_framework/workflow/yl5IfJABgzSGdpsYUKJE

{
    "name": "a test with no name",
    "description": "Updated flow template",
    "use_case": "TESTING",
    "version": {
        "template": "1.0.0",
        "compatibility": [
            "2.12.0",
            "3.0.0"
        ]
    },
    "workflows": {
        "provision": {
            "user_params": {},
            "nodes": [
                {
                    "id": "no op",
                    "type": "noop",
                    "previous_node_inputs": {},
                    "user_inputs": {}
                }
            ],
            "edges": []
        }
    },
    "created_time": 1720072032206,
    "last_updated_time": 1720077009607,
    "last_provisioned_time": 1720072032727
}

[dbwiddis]

Failing CI tracked in

• [BUG] Security Integ Tests are failing due to Container NodeJS version #759

[ohltyler]

LGTM! Thanks for adding this. The allowlisted fields should be sufficient for the frontend.

[owaiskazi19]

Looks good overall with minor suggestions

[owaiskazi19]

Thanks for addressing the comments. LGTM!

[dbwiddis]

Tests failing on WIndows because clock resolution isn't sufficient to guarantee "instant" increments. :|